2005-10-19 Andreas Krebbel <krebbel1@de.ibm.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob8bbbb04dfb3a996b896ffa297d336b21fd1c5736
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
111 @c man end
113 @xref{Option Index}, for an index to GCC's options.
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -ffriend-injection  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstack-protector @gol
242 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
243 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
244 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
245 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
246 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
247 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
248 -Wwrite-strings}
250 @item C-only Warning Options
251 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
252 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
253 -Wstrict-prototypes  -Wtraditional @gol
254 -Wdeclaration-after-statement -Wno-pointer-sign}
256 @item Debugging Options
257 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
258 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
259 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
260 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
261 -fdump-ipa-all -fdump-ipa-cgraph @gol
262 -fdump-tree-all @gol
263 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
264 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
267 -fdump-tree-ch @gol
268 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-nrv -fdump-tree-vect @gol
277 -fdump-tree-sink @gol
278 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-salias @gol
280 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
282 -ftree-vectorizer-verbose=@var{n} @gol
283 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
284 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
285 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
286 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
287 -ftest-coverage  -ftime-report -fvar-tracking @gol
288 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
289 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
290 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
291 -print-multi-directory  -print-multi-lib @gol
292 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
293 -save-temps  -time}
295 @item Optimization Options
296 @xref{Optimize Options,,Options that Control Optimization}.
297 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
298 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
299 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
300 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
301 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
302 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
303 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
304 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
305 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
306 -fforce-addr  -ffunction-sections @gol
307 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
308 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
309 -finline-functions  -finline-functions-called-once @gol
310 -finline-limit=@var{n}  -fkeep-inline-functions @gol
311 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
312 -fmodulo-sched -fno-branch-count-reg @gol
313 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
314 -fno-function-cse  -fno-guess-branch-probability @gol
315 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
316 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
317 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
318 -fomit-frame-pointer  -foptimize-register-move @gol
319 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
320 -fprofile-generate -fprofile-use @gol
321 -fregmove  -frename-registers @gol
322 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
323 -frerun-cse-after-loop  -frerun-loop-opt @gol
324 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
325 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
326 -fsched-spec-load-dangerous  @gol
327 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
328 -fsched2-use-superblocks @gol
329 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
330 -fsignaling-nans -fsingle-precision-constant  @gol
331 -fstack-protector  -fstack-protector-all @gol
332 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
333 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
334 -fsplit-ivs-in-unroller -funswitch-loops @gol
335 -fvariable-expansion-in-unroller @gol
336 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
337 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
338 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
339 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
340 -ftree-vect-loop-version -ftree-salias -fweb @gol
341 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
342 --param @var{name}=@var{value}
343 -O  -O0  -O1  -O2  -O3  -Os}
345 @item Preprocessor Options
346 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
347 @gccoptlist{-A@var{question}=@var{answer} @gol
348 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
349 -C  -dD  -dI  -dM  -dN @gol
350 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
351 -idirafter @var{dir} @gol
352 -include @var{file}  -imacros @var{file} @gol
353 -iprefix @var{file}  -iwithprefix @var{dir} @gol
354 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
355 -isysroot @var{dir} @gol
356 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
357 -P  -fworking-directory  -remap @gol
358 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
359 -Xpreprocessor @var{option}}
361 @item Assembler Option
362 @xref{Assembler Options,,Passing Options to the Assembler}.
363 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
365 @item Linker Options
366 @xref{Link Options,,Options for Linking}.
367 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
368 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
369 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
370 -Wl,@var{option}  -Xlinker @var{option} @gol
371 -u @var{symbol}}
373 @item Directory Options
374 @xref{Directory Options,,Options for Directory Search}.
375 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
376 -specs=@var{file}  -I- --sysroot=@var{dir}}
378 @item Target Options
379 @c I wrote this xref this way to avoid overfull hbox. -- rms
380 @xref{Target Options}.
381 @gccoptlist{-V @var{version}  -b @var{machine}}
383 @item Machine Dependent Options
384 @xref{Submodel Options,,Hardware Models and Configurations}.
385 @c This list is ordered alphanumerically by subsection name.
386 @c Try and put the significant identifier (CPU or system) first,
387 @c so users have a clue at guessing where the ones they want will be.
389 @emph{ARC Options}
390 @gccoptlist{-EB  -EL @gol
391 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
392 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
394 @emph{ARM Options}
395 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
396 -mabi=@var{name} @gol
397 -mapcs-stack-check  -mno-apcs-stack-check @gol
398 -mapcs-float  -mno-apcs-float @gol
399 -mapcs-reentrant  -mno-apcs-reentrant @gol
400 -msched-prolog  -mno-sched-prolog @gol
401 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
402 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
403 -mthumb-interwork  -mno-thumb-interwork @gol
404 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
405 -mstructure-size-boundary=@var{n} @gol
406 -mabort-on-noreturn @gol
407 -mlong-calls  -mno-long-calls @gol
408 -msingle-pic-base  -mno-single-pic-base @gol
409 -mpic-register=@var{reg} @gol
410 -mnop-fun-dllimport @gol
411 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
412 -mpoke-function-name @gol
413 -mthumb  -marm @gol
414 -mtpcs-frame  -mtpcs-leaf-frame @gol
415 -mcaller-super-interworking  -mcallee-super-interworking}
417 @emph{AVR Options}
418 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
419 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
421 @emph{Blackfin Options}
422 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
423 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
424 -mlow-64k -mno-low64k -mid-shared-library @gol
425 -mno-id-shared-library -mshared-library-id=@var{n} @gol
426 -mlong-calls  -mno-long-calls}
428 @emph{CRIS Options}
429 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
430 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
431 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
432 -mstack-align  -mdata-align  -mconst-align @gol
433 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
434 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
435 -mmul-bug-workaround  -mno-mul-bug-workaround}
437 @emph{CRX Options}
438 @gccoptlist{-mmac -mpush-args}
440 @emph{Darwin Options}
441 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
442 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
443 -client_name  -compatibility_version  -current_version @gol
444 -dead_strip @gol
445 -dependency-file  -dylib_file  -dylinker_install_name @gol
446 -dynamic  -dynamiclib  -exported_symbols_list @gol
447 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
448 -force_flat_namespace  -headerpad_max_install_names @gol
449 -image_base  -init  -install_name  -keep_private_externs @gol
450 -multi_module  -multiply_defined  -multiply_defined_unused @gol
451 -noall_load   -no_dead_strip_inits_and_terms @gol
452 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
453 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
454 -private_bundle  -read_only_relocs  -sectalign @gol
455 -sectobjectsymbols  -whyload  -seg1addr @gol
456 -sectcreate  -sectobjectsymbols  -sectorder @gol
457 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
458 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
459 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
460 -single_module  -static  -sub_library  -sub_umbrella @gol
461 -twolevel_namespace  -umbrella  -undefined @gol
462 -unexported_symbols_list  -weak_reference_mismatches @gol
463 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
464 -mone-byte-bool}
466 @emph{DEC Alpha Options}
467 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
468 -mieee  -mieee-with-inexact  -mieee-conformant @gol
469 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
470 -mtrap-precision=@var{mode}  -mbuild-constants @gol
471 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
472 -mbwx  -mmax  -mfix  -mcix @gol
473 -mfloat-vax  -mfloat-ieee @gol
474 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
475 -msmall-text  -mlarge-text @gol
476 -mmemory-latency=@var{time}}
478 @emph{DEC Alpha/VMS Options}
479 @gccoptlist{-mvms-return-codes}
481 @emph{FRV Options}
482 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
483 -mhard-float  -msoft-float @gol
484 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
485 -mdouble  -mno-double @gol
486 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
487 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
488 -mlinked-fp  -mlong-calls  -malign-labels @gol
489 -mlibrary-pic  -macc-4  -macc-8 @gol
490 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
491 -moptimize-membar -mno-optimize-membar @gol
492 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
493 -mvliw-branch  -mno-vliw-branch @gol
494 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
495 -mno-nested-cond-exec  -mtomcat-stats @gol
496 -mTLS -mtls @gol
497 -mcpu=@var{cpu}}
499 @emph{H8/300 Options}
500 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
502 @emph{HPPA Options}
503 @gccoptlist{-march=@var{architecture-type} @gol
504 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
505 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
506 -mfixed-range=@var{register-range} @gol
507 -mjump-in-delay -mlinker-opt -mlong-calls @gol
508 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
509 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
510 -mno-jump-in-delay  -mno-long-load-store @gol
511 -mno-portable-runtime  -mno-soft-float @gol
512 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
513 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
514 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
515 -munix=@var{unix-std}  -nolibdld  -static  -threads}
517 @emph{i386 and x86-64 Options}
518 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
519 -mfpmath=@var{unit} @gol
520 -masm=@var{dialect}  -mno-fancy-math-387 @gol
521 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
522 -mno-wide-multiply  -mrtd  -malign-double @gol
523 -mpreferred-stack-boundary=@var{num} @gol
524 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
525 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
526 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
527 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
528 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
529 -mcmodel=@var{code-model} @gol
530 -m32  -m64 -mlarge-data-threshold=@var{num}}
532 @emph{IA-64 Options}
533 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
534 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
535 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
536 -minline-float-divide-max-throughput @gol
537 -minline-int-divide-min-latency @gol
538 -minline-int-divide-max-throughput  @gol
539 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
540 -mno-dwarf2-asm -mearly-stop-bits @gol
541 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
542 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
544 @emph{M32R/D Options}
545 @gccoptlist{-m32r2 -m32rx -m32r @gol
546 -mdebug @gol
547 -malign-loops -mno-align-loops @gol
548 -missue-rate=@var{number} @gol
549 -mbranch-cost=@var{number} @gol
550 -mmodel=@var{code-size-model-type} @gol
551 -msdata=@var{sdata-type} @gol
552 -mno-flush-func -mflush-func=@var{name} @gol
553 -mno-flush-trap -mflush-trap=@var{number} @gol
554 -G @var{num}}
556 @emph{M32C Options}
557 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
559 @emph{M680x0 Options}
560 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
561 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
562 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
563 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
564 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
566 @emph{M68hc1x Options}
567 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
568 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
569 -msoft-reg-count=@var{count}}
571 @emph{MCore Options}
572 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
573 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
574 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
575 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
576 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
578 @emph{MIPS Options}
579 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
580 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
581 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
582 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
583 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
584 -mdsp  -mpaired-single  -mips3d @gol
585 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
586 -G@var{num}  -membedded-data  -mno-embedded-data @gol
587 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
588 -msplit-addresses  -mno-split-addresses  @gol
589 -mexplicit-relocs  -mno-explicit-relocs  @gol
590 -mcheck-zero-division  -mno-check-zero-division @gol
591 -mdivide-traps  -mdivide-breaks @gol
592 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
593 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
594 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
595 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
596 -mfix-sb1  -mno-fix-sb1 @gol
597 -mflush-func=@var{func}  -mno-flush-func @gol
598 -mbranch-likely  -mno-branch-likely @gol
599 -mfp-exceptions -mno-fp-exceptions @gol
600 -mvr4130-align -mno-vr4130-align}
602 @emph{MMIX Options}
603 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
604 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
605 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
606 -mno-base-addresses  -msingle-exit  -mno-single-exit}
608 @emph{MN10300 Options}
609 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
610 -mam33  -mno-am33 @gol
611 -mam33-2  -mno-am33-2 @gol
612 -mreturn-pointer-on-d0 @gol
613 -mno-crt0  -mrelax}
615 @emph{MS1 Options}
616 @gccoptlist{-mno-crt0 -mmul -mbacc -msim @gol
617 -march=@var{cpu-type} }
619 @emph{PDP-11 Options}
620 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
621 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
622 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
623 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
624 -mbranch-expensive  -mbranch-cheap @gol
625 -msplit  -mno-split  -munix-asm  -mdec-asm}
627 @emph{PowerPC Options}
628 See RS/6000 and PowerPC Options.
630 @emph{RS/6000 and PowerPC Options}
631 @gccoptlist{-mcpu=@var{cpu-type} @gol
632 -mtune=@var{cpu-type} @gol
633 -mpower  -mno-power  -mpower2  -mno-power2 @gol
634 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
635 -maltivec  -mno-altivec @gol
636 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
637 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
638 -mnew-mnemonics  -mold-mnemonics @gol
639 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
640 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
641 -malign-power  -malign-natural @gol
642 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
643 -mstring  -mno-string  -mupdate  -mno-update @gol
644 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
645 -mstrict-align  -mno-strict-align  -mrelocatable @gol
646 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
647 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
648 -mdynamic-no-pic  -maltivec  -mswdiv @gol
649 -mprioritize-restricted-insns=@var{priority} @gol
650 -msched-costly-dep=@var{dependence_type} @gol
651 -minsert-sched-nops=@var{scheme} @gol
652 -mcall-sysv  -mcall-netbsd @gol
653 -maix-struct-return  -msvr4-struct-return @gol
654 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
655 -misel -mno-isel @gol
656 -misel=yes  -misel=no @gol
657 -mspe -mno-spe @gol
658 -mspe=yes  -mspe=no @gol
659 -mvrsave -mno-vrsave @gol
660 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
661 -mprototype  -mno-prototype @gol
662 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
663 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
665 @emph{S/390 and zSeries Options}
666 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
667 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
668 -mpacked-stack  -mno-packed-stack @gol
669 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
670 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
671 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
672 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
674 @emph{SH Options}
675 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
676 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
677 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
678 -m5-64media  -m5-64media-nofpu @gol
679 -m5-32media  -m5-32media-nofpu @gol
680 -m5-compact  -m5-compact-nofpu @gol
681 -mb  -ml  -mdalign  -mrelax @gol
682 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
683 -mieee  -misize  -mpadstruct  -mspace @gol
684 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
685 -mdivsi3_libfunc=@var{name}  @gol
686 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
687  -minvalid-symbols}
689 @emph{SPARC Options}
690 @gccoptlist{-mcpu=@var{cpu-type} @gol
691 -mtune=@var{cpu-type} @gol
692 -mcmodel=@var{code-model} @gol
693 -m32  -m64  -mapp-regs  -mno-app-regs @gol
694 -mfaster-structs  -mno-faster-structs @gol
695 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
696 -mhard-quad-float  -msoft-quad-float @gol
697 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
698 -mstack-bias  -mno-stack-bias @gol
699 -munaligned-doubles  -mno-unaligned-doubles @gol
700 -mv8plus  -mno-v8plus  -mvis  -mno-vis
701 -threads -pthreads}
703 @emph{System V Options}
704 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
706 @emph{TMS320C3x/C4x Options}
707 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
708 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
709 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
710 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
712 @emph{V850 Options}
713 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
714 -mprolog-function  -mno-prolog-function  -mspace @gol
715 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
716 -mapp-regs  -mno-app-regs @gol
717 -mdisable-callt  -mno-disable-callt @gol
718 -mv850e1 @gol
719 -mv850e @gol
720 -mv850  -mbig-switch}
722 @emph{VAX Options}
723 @gccoptlist{-mg  -mgnu  -munix}
725 @emph{x86-64 Options}
726 See i386 and x86-64 Options.
728 @emph{Xstormy16 Options}
729 @gccoptlist{-msim}
731 @emph{Xtensa Options}
732 @gccoptlist{-mconst16 -mno-const16 @gol
733 -mfused-madd  -mno-fused-madd @gol
734 -mtext-section-literals  -mno-text-section-literals @gol
735 -mtarget-align  -mno-target-align @gol
736 -mlongcalls  -mno-longcalls}
738 @emph{zSeries Options}
739 See S/390 and zSeries Options.
741 @item Code Generation Options
742 @xref{Code Gen Options,,Options for Code Generation Conventions}.
743 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
744 -ffixed-@var{reg}  -fexceptions @gol
745 -fnon-call-exceptions  -funwind-tables @gol
746 -fasynchronous-unwind-tables @gol
747 -finhibit-size-directive  -finstrument-functions @gol
748 -fno-common  -fno-ident @gol
749 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
750 -fno-jump-tables @gol
751 -freg-struct-return  -fshared-data  -fshort-enums @gol
752 -fshort-double  -fshort-wchar @gol
753 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
754 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
755 -fargument-alias  -fargument-noalias @gol
756 -fargument-noalias-global  -fleading-underscore @gol
757 -ftls-model=@var{model} @gol
758 -ftrapv  -fwrapv  -fbounds-check @gol
759 -fvisibility}
760 @end table
762 @menu
763 * Overall Options::     Controlling the kind of output:
764                         an executable, object files, assembler files,
765                         or preprocessed source.
766 * C Dialect Options::   Controlling the variant of C language compiled.
767 * C++ Dialect Options:: Variations on C++.
768 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
769                         and Objective-C++.
770 * Language Independent Options:: Controlling how diagnostics should be
771                         formatted.
772 * Warning Options::     How picky should the compiler be?
773 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
774 * Optimize Options::    How much optimization?
775 * Preprocessor Options:: Controlling header files and macro definitions.
776                          Also, getting dependency information for Make.
777 * Assembler Options::   Passing options to the assembler.
778 * Link Options::        Specifying libraries and so on.
779 * Directory Options::   Where to find header files and libraries.
780                         Where to find the compiler executable files.
781 * Spec Files::          How to pass switches to sub-processes.
782 * Target Options::      Running a cross-compiler, or an old version of GCC.
783 @end menu
785 @node Overall Options
786 @section Options Controlling the Kind of Output
788 Compilation can involve up to four stages: preprocessing, compilation
789 proper, assembly and linking, always in that order.  GCC is capable of
790 preprocessing and compiling several files either into several
791 assembler input files, or into one assembler input file; then each
792 assembler input file produces an object file, and linking combines all
793 the object files (those newly compiled, and those specified as input)
794 into an executable file.
796 @cindex file name suffix
797 For any given input file, the file name suffix determines what kind of
798 compilation is done:
800 @table @gcctabopt
801 @item @var{file}.c
802 C source code which must be preprocessed.
804 @item @var{file}.i
805 C source code which should not be preprocessed.
807 @item @var{file}.ii
808 C++ source code which should not be preprocessed.
810 @item @var{file}.m
811 Objective-C source code.  Note that you must link with the @file{libobjc}
812 library to make an Objective-C program work.
814 @item @var{file}.mi
815 Objective-C source code which should not be preprocessed.
817 @item @var{file}.mm
818 @itemx @var{file}.M
819 Objective-C++ source code.  Note that you must link with the @file{libobjc}
820 library to make an Objective-C++ program work.  Note that @samp{.M} refers
821 to a literal capital M@.
823 @item @var{file}.mii
824 Objective-C++ source code which should not be preprocessed.
826 @item @var{file}.h
827 C, C++, Objective-C or Objective-C++ header file to be turned into a
828 precompiled header.
830 @item @var{file}.cc
831 @itemx @var{file}.cp
832 @itemx @var{file}.cxx
833 @itemx @var{file}.cpp
834 @itemx @var{file}.CPP
835 @itemx @var{file}.c++
836 @itemx @var{file}.C
837 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
838 the last two letters must both be literally @samp{x}.  Likewise,
839 @samp{.C} refers to a literal capital C@.
841 @item @var{file}.mm
842 @itemx @var{file}.M
843 Objective-C++ source code which must be preprocessed.
845 @item @var{file}.mii
846 Objective-C++ source code which should not be preprocessed.
848 @item @var{file}.hh
849 @itemx @var{file}.H
850 C++ header file to be turned into a precompiled header.
852 @item @var{file}.f
853 @itemx @var{file}.for
854 @itemx @var{file}.FOR
855 Fortran source code which should not be preprocessed.
857 @item @var{file}.F
858 @itemx @var{file}.fpp
859 @itemx @var{file}.FPP
860 Fortran source code which must be preprocessed (with the traditional
861 preprocessor).
863 @item @var{file}.r
864 Fortran source code which must be preprocessed with a RATFOR
865 preprocessor (not included with GCC)@.
867 @item @var{file}.f90
868 @itemx @var{file}.f95
869 Fortran 90/95 source code which should not be preprocessed.
871 @item @var{file}.F90
872 @itemx @var{file}.F95
873 Fortran 90/95 source code which must be preprocessed (with the
874 traditional preprocessor).
876 @c FIXME: Descriptions of Java file types.
877 @c @var{file}.java
878 @c @var{file}.class
879 @c @var{file}.zip
880 @c @var{file}.jar
882 @item @var{file}.ads
883 Ada source code file which contains a library unit declaration (a
884 declaration of a package, subprogram, or generic, or a generic
885 instantiation), or a library unit renaming declaration (a package,
886 generic, or subprogram renaming declaration).  Such files are also
887 called @dfn{specs}.
889 @itemx @var{file}.adb
890 Ada source code file containing a library unit body (a subprogram or
891 package body).  Such files are also called @dfn{bodies}.
893 @c GCC also knows about some suffixes for languages not yet included:
894 @c Pascal:
895 @c @var{file}.p
896 @c @var{file}.pas
898 @item @var{file}.s
899 Assembler code.
901 @item @var{file}.S
902 Assembler code which must be preprocessed.
904 @item @var{other}
905 An object file to be fed straight into linking.
906 Any file name with no recognized suffix is treated this way.
907 @end table
909 @opindex x
910 You can specify the input language explicitly with the @option{-x} option:
912 @table @gcctabopt
913 @item -x @var{language}
914 Specify explicitly the @var{language} for the following input files
915 (rather than letting the compiler choose a default based on the file
916 name suffix).  This option applies to all following input files until
917 the next @option{-x} option.  Possible values for @var{language} are:
918 @smallexample
919 c  c-header  c-cpp-output
920 c++  c++-header  c++-cpp-output
921 objective-c  objective-c-header  objective-c-cpp-output
922 objective-c++ objective-c++-header objective-c++-cpp-output
923 assembler  assembler-with-cpp
925 f77  f77-cpp-input  ratfor
926 f95  f95-cpp-input
927 java
928 treelang
929 @end smallexample
931 @item -x none
932 Turn off any specification of a language, so that subsequent files are
933 handled according to their file name suffixes (as they are if @option{-x}
934 has not been used at all).
936 @item -pass-exit-codes
937 @opindex pass-exit-codes
938 Normally the @command{gcc} program will exit with the code of 1 if any
939 phase of the compiler returns a non-success return code.  If you specify
940 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
941 numerically highest error produced by any phase that returned an error
942 indication.
943 @end table
945 If you only want some of the stages of compilation, you can use
946 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
947 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
948 @command{gcc} is to stop.  Note that some combinations (for example,
949 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
951 @table @gcctabopt
952 @item -c
953 @opindex c
954 Compile or assemble the source files, but do not link.  The linking
955 stage simply is not done.  The ultimate output is in the form of an
956 object file for each source file.
958 By default, the object file name for a source file is made by replacing
959 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
961 Unrecognized input files, not requiring compilation or assembly, are
962 ignored.
964 @item -S
965 @opindex S
966 Stop after the stage of compilation proper; do not assemble.  The output
967 is in the form of an assembler code file for each non-assembler input
968 file specified.
970 By default, the assembler file name for a source file is made by
971 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
973 Input files that don't require compilation are ignored.
975 @item -E
976 @opindex E
977 Stop after the preprocessing stage; do not run the compiler proper.  The
978 output is in the form of preprocessed source code, which is sent to the
979 standard output.
981 Input files which don't require preprocessing are ignored.
983 @cindex output file option
984 @item -o @var{file}
985 @opindex o
986 Place output in file @var{file}.  This applies regardless to whatever
987 sort of output is being produced, whether it be an executable file,
988 an object file, an assembler file or preprocessed C code.
990 If @option{-o} is not specified, the default is to put an executable
991 file in @file{a.out}, the object file for
992 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
993 assembler file in @file{@var{source}.s}, a precompiled header file in
994 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
995 standard output.
997 @item -v
998 @opindex v
999 Print (on standard error output) the commands executed to run the stages
1000 of compilation.  Also print the version number of the compiler driver
1001 program and of the preprocessor and the compiler proper.
1003 @item -###
1004 @opindex ###
1005 Like @option{-v} except the commands are not executed and all command
1006 arguments are quoted.  This is useful for shell scripts to capture the
1007 driver-generated command lines.
1009 @item -pipe
1010 @opindex pipe
1011 Use pipes rather than temporary files for communication between the
1012 various stages of compilation.  This fails to work on some systems where
1013 the assembler is unable to read from a pipe; but the GNU assembler has
1014 no trouble.
1016 @item -combine
1017 @opindex combine
1018 If you are compiling multiple source files, this option tells the driver
1019 to pass all the source files to the compiler at once (for those
1020 languages for which the compiler can handle this).  This will allow
1021 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1022 language for which this is supported is C@.  If you pass source files for
1023 multiple languages to the driver, using this option, the driver will invoke
1024 the compiler(s) that support IMA once each, passing each compiler all the
1025 source files appropriate for it.  For those languages that do not support
1026 IMA this option will be ignored, and the compiler will be invoked once for
1027 each source file in that language.  If you use this option in conjunction
1028 with @option{-save-temps}, the compiler will generate multiple
1029 pre-processed files
1030 (one for each source file), but only one (combined) @file{.o} or
1031 @file{.s} file.
1033 @item --help
1034 @opindex help
1035 Print (on the standard output) a description of the command line options
1036 understood by @command{gcc}.  If the @option{-v} option is also specified
1037 then @option{--help} will also be passed on to the various processes
1038 invoked by @command{gcc}, so that they can display the command line options
1039 they accept.  If the @option{-Wextra} option is also specified then command
1040 line options which have no documentation associated with them will also
1041 be displayed.
1043 @item --target-help
1044 @opindex target-help
1045 Print (on the standard output) a description of target specific command
1046 line options for each tool.
1048 @item --version
1049 @opindex version
1050 Display the version number and copyrights of the invoked GCC@.
1051 @end table
1053 @node Invoking G++
1054 @section Compiling C++ Programs
1056 @cindex suffixes for C++ source
1057 @cindex C++ source file suffixes
1058 C++ source files conventionally use one of the suffixes @samp{.C},
1059 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1060 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1061 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1062 files with these names and compiles them as C++ programs even if you
1063 call the compiler the same way as for compiling C programs (usually
1064 with the name @command{gcc}).
1066 @findex g++
1067 @findex c++
1068 However, C++ programs often require class libraries as well as a
1069 compiler that understands the C++ language---and under some
1070 circumstances, you might want to compile programs or header files from
1071 standard input, or otherwise without a suffix that flags them as C++
1072 programs.  You might also like to precompile a C header file with a
1073 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1074 program that calls GCC with the default language set to C++, and
1075 automatically specifies linking against the C++ library.  On many
1076 systems, @command{g++} is also installed with the name @command{c++}.
1078 @cindex invoking @command{g++}
1079 When you compile C++ programs, you may specify many of the same
1080 command-line options that you use for compiling programs in any
1081 language; or command-line options meaningful for C and related
1082 languages; or options that are meaningful only for C++ programs.
1083 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1084 explanations of options for languages related to C@.
1085 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1086 explanations of options that are meaningful only for C++ programs.
1088 @node C Dialect Options
1089 @section Options Controlling C Dialect
1090 @cindex dialect options
1091 @cindex language dialect options
1092 @cindex options, dialect
1094 The following options control the dialect of C (or languages derived
1095 from C, such as C++, Objective-C and Objective-C++) that the compiler
1096 accepts:
1098 @table @gcctabopt
1099 @cindex ANSI support
1100 @cindex ISO support
1101 @item -ansi
1102 @opindex ansi
1103 In C mode, support all ISO C90 programs.  In C++ mode,
1104 remove GNU extensions that conflict with ISO C++.
1106 This turns off certain features of GCC that are incompatible with ISO
1107 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1108 such as the @code{asm} and @code{typeof} keywords, and
1109 predefined macros such as @code{unix} and @code{vax} that identify the
1110 type of system you are using.  It also enables the undesirable and
1111 rarely used ISO trigraph feature.  For the C compiler,
1112 it disables recognition of C++ style @samp{//} comments as well as
1113 the @code{inline} keyword.
1115 The alternate keywords @code{__asm__}, @code{__extension__},
1116 @code{__inline__} and @code{__typeof__} continue to work despite
1117 @option{-ansi}.  You would not want to use them in an ISO C program, of
1118 course, but it is useful to put them in header files that might be included
1119 in compilations done with @option{-ansi}.  Alternate predefined macros
1120 such as @code{__unix__} and @code{__vax__} are also available, with or
1121 without @option{-ansi}.
1123 The @option{-ansi} option does not cause non-ISO programs to be
1124 rejected gratuitously.  For that, @option{-pedantic} is required in
1125 addition to @option{-ansi}.  @xref{Warning Options}.
1127 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1128 option is used.  Some header files may notice this macro and refrain
1129 from declaring certain functions or defining certain macros that the
1130 ISO standard doesn't call for; this is to avoid interfering with any
1131 programs that might use these names for other things.
1133 Functions which would normally be built in but do not have semantics
1134 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1135 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1136 built-in functions provided by GCC}, for details of the functions
1137 affected.
1139 @item -std=
1140 @opindex std
1141 Determine the language standard.  This option is currently only
1142 supported when compiling C or C++.  A value for this option must be
1143 provided; possible values are
1145 @table @samp
1146 @item c89
1147 @itemx iso9899:1990
1148 ISO C90 (same as @option{-ansi}).
1150 @item iso9899:199409
1151 ISO C90 as modified in amendment 1.
1153 @item c99
1154 @itemx c9x
1155 @itemx iso9899:1999
1156 @itemx iso9899:199x
1157 ISO C99.  Note that this standard is not yet fully supported; see
1158 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1159 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1161 @item gnu89
1162 Default, ISO C90 plus GNU extensions (including some C99 features).
1164 @item gnu99
1165 @itemx gnu9x
1166 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1167 this will become the default.  The name @samp{gnu9x} is deprecated.
1169 @item c++98
1170 The 1998 ISO C++ standard plus amendments.
1172 @item gnu++98
1173 The same as @option{-std=c++98} plus GNU extensions.  This is the
1174 default for C++ code.
1175 @end table
1177 Even when this option is not specified, you can still use some of the
1178 features of newer standards in so far as they do not conflict with
1179 previous C standards.  For example, you may use @code{__restrict__} even
1180 when @option{-std=c99} is not specified.
1182 The @option{-std} options specifying some version of ISO C have the same
1183 effects as @option{-ansi}, except that features that were not in ISO C90
1184 but are in the specified version (for example, @samp{//} comments and
1185 the @code{inline} keyword in ISO C99) are not disabled.
1187 @xref{Standards,,Language Standards Supported by GCC}, for details of
1188 these standard versions.
1190 @item -aux-info @var{filename}
1191 @opindex aux-info
1192 Output to the given filename prototyped declarations for all functions
1193 declared and/or defined in a translation unit, including those in header
1194 files.  This option is silently ignored in any language other than C@.
1196 Besides declarations, the file indicates, in comments, the origin of
1197 each declaration (source file and line), whether the declaration was
1198 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1199 @samp{O} for old, respectively, in the first character after the line
1200 number and the colon), and whether it came from a declaration or a
1201 definition (@samp{C} or @samp{F}, respectively, in the following
1202 character).  In the case of function definitions, a K&R-style list of
1203 arguments followed by their declarations is also provided, inside
1204 comments, after the declaration.
1206 @item -fno-asm
1207 @opindex fno-asm
1208 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1209 keyword, so that code can use these words as identifiers.  You can use
1210 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1211 instead.  @option{-ansi} implies @option{-fno-asm}.
1213 In C++, this switch only affects the @code{typeof} keyword, since
1214 @code{asm} and @code{inline} are standard keywords.  You may want to
1215 use the @option{-fno-gnu-keywords} flag instead, which has the same
1216 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1217 switch only affects the @code{asm} and @code{typeof} keywords, since
1218 @code{inline} is a standard keyword in ISO C99.
1220 @item -fno-builtin
1221 @itemx -fno-builtin-@var{function}
1222 @opindex fno-builtin
1223 @cindex built-in functions
1224 Don't recognize built-in functions that do not begin with
1225 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1226 functions provided by GCC}, for details of the functions affected,
1227 including those which are not built-in functions when @option{-ansi} or
1228 @option{-std} options for strict ISO C conformance are used because they
1229 do not have an ISO standard meaning.
1231 GCC normally generates special code to handle certain built-in functions
1232 more efficiently; for instance, calls to @code{alloca} may become single
1233 instructions that adjust the stack directly, and calls to @code{memcpy}
1234 may become inline copy loops.  The resulting code is often both smaller
1235 and faster, but since the function calls no longer appear as such, you
1236 cannot set a breakpoint on those calls, nor can you change the behavior
1237 of the functions by linking with a different library.  In addition,
1238 when a function is recognized as a built-in function, GCC may use
1239 information about that function to warn about problems with calls to
1240 that function, or to generate more efficient code, even if the
1241 resulting code still contains calls to that function.  For example,
1242 warnings are given with @option{-Wformat} for bad calls to
1243 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1244 known not to modify global memory.
1246 With the @option{-fno-builtin-@var{function}} option
1247 only the built-in function @var{function} is
1248 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1249 function is named this is not built-in in this version of GCC, this
1250 option is ignored.  There is no corresponding
1251 @option{-fbuiltin-@var{function}} option; if you wish to enable
1252 built-in functions selectively when using @option{-fno-builtin} or
1253 @option{-ffreestanding}, you may define macros such as:
1255 @smallexample
1256 #define abs(n)          __builtin_abs ((n))
1257 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1258 @end smallexample
1260 @item -fhosted
1261 @opindex fhosted
1262 @cindex hosted environment
1264 Assert that compilation takes place in a hosted environment.  This implies
1265 @option{-fbuiltin}.  A hosted environment is one in which the
1266 entire standard library is available, and in which @code{main} has a return
1267 type of @code{int}.  Examples are nearly everything except a kernel.
1268 This is equivalent to @option{-fno-freestanding}.
1270 @item -ffreestanding
1271 @opindex ffreestanding
1272 @cindex hosted environment
1274 Assert that compilation takes place in a freestanding environment.  This
1275 implies @option{-fno-builtin}.  A freestanding environment
1276 is one in which the standard library may not exist, and program startup may
1277 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1278 This is equivalent to @option{-fno-hosted}.
1280 @xref{Standards,,Language Standards Supported by GCC}, for details of
1281 freestanding and hosted environments.
1283 @item -fms-extensions
1284 @opindex fms-extensions
1285 Accept some non-standard constructs used in Microsoft header files.
1287 Some cases of unnamed fields in structures and unions are only
1288 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1289 fields within structs/unions}, for details.
1291 @item -trigraphs
1292 @opindex trigraphs
1293 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1294 options for strict ISO C conformance) implies @option{-trigraphs}.
1296 @item -no-integrated-cpp
1297 @opindex no-integrated-cpp
1298 Performs a compilation in two passes: preprocessing and compiling.  This
1299 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1300 @option{-B} option.  The user supplied compilation step can then add in
1301 an additional preprocessing step after normal preprocessing but before
1302 compiling.  The default is to use the integrated cpp (internal cpp)
1304 The semantics of this option will change if "cc1", "cc1plus", and
1305 "cc1obj" are merged.
1307 @cindex traditional C language
1308 @cindex C language, traditional
1309 @item -traditional
1310 @itemx -traditional-cpp
1311 @opindex traditional-cpp
1312 @opindex traditional
1313 Formerly, these options caused GCC to attempt to emulate a pre-standard
1314 C compiler.  They are now only supported with the @option{-E} switch.
1315 The preprocessor continues to support a pre-standard mode.  See the GNU
1316 CPP manual for details.
1318 @item -fcond-mismatch
1319 @opindex fcond-mismatch
1320 Allow conditional expressions with mismatched types in the second and
1321 third arguments.  The value of such an expression is void.  This option
1322 is not supported for C++.
1324 @item -funsigned-char
1325 @opindex funsigned-char
1326 Let the type @code{char} be unsigned, like @code{unsigned char}.
1328 Each kind of machine has a default for what @code{char} should
1329 be.  It is either like @code{unsigned char} by default or like
1330 @code{signed char} by default.
1332 Ideally, a portable program should always use @code{signed char} or
1333 @code{unsigned char} when it depends on the signedness of an object.
1334 But many programs have been written to use plain @code{char} and
1335 expect it to be signed, or expect it to be unsigned, depending on the
1336 machines they were written for.  This option, and its inverse, let you
1337 make such a program work with the opposite default.
1339 The type @code{char} is always a distinct type from each of
1340 @code{signed char} or @code{unsigned char}, even though its behavior
1341 is always just like one of those two.
1343 @item -fsigned-char
1344 @opindex fsigned-char
1345 Let the type @code{char} be signed, like @code{signed char}.
1347 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1348 the negative form of @option{-funsigned-char}.  Likewise, the option
1349 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1351 @item -fsigned-bitfields
1352 @itemx -funsigned-bitfields
1353 @itemx -fno-signed-bitfields
1354 @itemx -fno-unsigned-bitfields
1355 @opindex fsigned-bitfields
1356 @opindex funsigned-bitfields
1357 @opindex fno-signed-bitfields
1358 @opindex fno-unsigned-bitfields
1359 These options control whether a bit-field is signed or unsigned, when the
1360 declaration does not use either @code{signed} or @code{unsigned}.  By
1361 default, such a bit-field is signed, because this is consistent: the
1362 basic integer types such as @code{int} are signed types.
1363 @end table
1365 @node C++ Dialect Options
1366 @section Options Controlling C++ Dialect
1368 @cindex compiler options, C++
1369 @cindex C++ options, command line
1370 @cindex options, C++
1371 This section describes the command-line options that are only meaningful
1372 for C++ programs; but you can also use most of the GNU compiler options
1373 regardless of what language your program is in.  For example, you
1374 might compile a file @code{firstClass.C} like this:
1376 @smallexample
1377 g++ -g -frepo -O -c firstClass.C
1378 @end smallexample
1380 @noindent
1381 In this example, only @option{-frepo} is an option meant
1382 only for C++ programs; you can use the other options with any
1383 language supported by GCC@.
1385 Here is a list of options that are @emph{only} for compiling C++ programs:
1387 @table @gcctabopt
1389 @item -fabi-version=@var{n}
1390 @opindex fabi-version
1391 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1392 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1393 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1394 the version that conforms most closely to the C++ ABI specification.
1395 Therefore, the ABI obtained using version 0 will change as ABI bugs
1396 are fixed.
1398 The default is version 2.
1400 @item -fno-access-control
1401 @opindex fno-access-control
1402 Turn off all access checking.  This switch is mainly useful for working
1403 around bugs in the access control code.
1405 @item -fcheck-new
1406 @opindex fcheck-new
1407 Check that the pointer returned by @code{operator new} is non-null
1408 before attempting to modify the storage allocated.  This check is
1409 normally unnecessary because the C++ standard specifies that
1410 @code{operator new} will only return @code{0} if it is declared
1411 @samp{throw()}, in which case the compiler will always check the
1412 return value even without this option.  In all other cases, when
1413 @code{operator new} has a non-empty exception specification, memory
1414 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1415 @samp{new (nothrow)}.
1417 @item -fconserve-space
1418 @opindex fconserve-space
1419 Put uninitialized or runtime-initialized global variables into the
1420 common segment, as C does.  This saves space in the executable at the
1421 cost of not diagnosing duplicate definitions.  If you compile with this
1422 flag and your program mysteriously crashes after @code{main()} has
1423 completed, you may have an object that is being destroyed twice because
1424 two definitions were merged.
1426 This option is no longer useful on most targets, now that support has
1427 been added for putting variables into BSS without making them common.
1429 @item -ffriend-injection
1430 @opindex ffriend-injection
1431 Inject friend functions into the enclosing namespace, so that they are
1432 visible outside the scope of the class in which they are declared.
1433 Friend functions were documented to work this way in the old Annotated
1434 C++ Reference Manual, and versions of G++ before 4.1 always worked
1435 that way.  However, in ISO C++ a friend function which is not declared
1436 in an enclosing scope can only be found using argument dependent
1437 lookup.  This option causes friends to be injected as they were in
1438 earlier releases.
1440 This option is for compatibility, and may be removed in a future
1441 release of G++.
1443 @item -fno-const-strings
1444 @opindex fno-const-strings
1445 Give string constants type @code{char *} instead of type @code{const
1446 char *}.  By default, G++ uses type @code{const char *} as required by
1447 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1448 actually modify the value of a string constant.
1450 This option might be removed in a future release of G++.  For maximum
1451 portability, you should structure your code so that it works with
1452 string constants that have type @code{const char *}.
1454 @item -fno-elide-constructors
1455 @opindex fno-elide-constructors
1456 The C++ standard allows an implementation to omit creating a temporary
1457 which is only used to initialize another object of the same type.
1458 Specifying this option disables that optimization, and forces G++ to
1459 call the copy constructor in all cases.
1461 @item -fno-enforce-eh-specs
1462 @opindex fno-enforce-eh-specs
1463 Don't generate code to check for violation of exception specifications
1464 at runtime.  This option violates the C++ standard, but may be useful
1465 for reducing code size in production builds, much like defining
1466 @samp{NDEBUG}.  This does not give user code permission to throw
1467 exceptions in violation of the exception specifications; the compiler
1468 will still optimize based on the specifications, so throwing an
1469 unexpected exception will result in undefined behavior.
1471 @item -ffor-scope
1472 @itemx -fno-for-scope
1473 @opindex ffor-scope
1474 @opindex fno-for-scope
1475 If @option{-ffor-scope} is specified, the scope of variables declared in
1476 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1477 as specified by the C++ standard.
1478 If @option{-fno-for-scope} is specified, the scope of variables declared in
1479 a @i{for-init-statement} extends to the end of the enclosing scope,
1480 as was the case in old versions of G++, and other (traditional)
1481 implementations of C++.
1483 The default if neither flag is given to follow the standard,
1484 but to allow and give a warning for old-style code that would
1485 otherwise be invalid, or have different behavior.
1487 @item -fno-gnu-keywords
1488 @opindex fno-gnu-keywords
1489 Do not recognize @code{typeof} as a keyword, so that code can use this
1490 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1491 @option{-ansi} implies @option{-fno-gnu-keywords}.
1493 @item -fno-implicit-templates
1494 @opindex fno-implicit-templates
1495 Never emit code for non-inline templates which are instantiated
1496 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1497 @xref{Template Instantiation}, for more information.
1499 @item -fno-implicit-inline-templates
1500 @opindex fno-implicit-inline-templates
1501 Don't emit code for implicit instantiations of inline templates, either.
1502 The default is to handle inlines differently so that compiles with and
1503 without optimization will need the same set of explicit instantiations.
1505 @item -fno-implement-inlines
1506 @opindex fno-implement-inlines
1507 To save space, do not emit out-of-line copies of inline functions
1508 controlled by @samp{#pragma implementation}.  This will cause linker
1509 errors if these functions are not inlined everywhere they are called.
1511 @item -fms-extensions
1512 @opindex fms-extensions
1513 Disable pedantic warnings about constructs used in MFC, such as implicit
1514 int and getting a pointer to member function via non-standard syntax.
1516 @item -fno-nonansi-builtins
1517 @opindex fno-nonansi-builtins
1518 Disable built-in declarations of functions that are not mandated by
1519 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1520 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1522 @item -fno-operator-names
1523 @opindex fno-operator-names
1524 Do not treat the operator name keywords @code{and}, @code{bitand},
1525 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1526 synonyms as keywords.
1528 @item -fno-optional-diags
1529 @opindex fno-optional-diags
1530 Disable diagnostics that the standard says a compiler does not need to
1531 issue.  Currently, the only such diagnostic issued by G++ is the one for
1532 a name having multiple meanings within a class.
1534 @item -fpermissive
1535 @opindex fpermissive
1536 Downgrade some diagnostics about nonconformant code from errors to
1537 warnings.  Thus, using @option{-fpermissive} will allow some
1538 nonconforming code to compile.
1540 @item -frepo
1541 @opindex frepo
1542 Enable automatic template instantiation at link time.  This option also
1543 implies @option{-fno-implicit-templates}.  @xref{Template
1544 Instantiation}, for more information.
1546 @item -fno-rtti
1547 @opindex fno-rtti
1548 Disable generation of information about every class with virtual
1549 functions for use by the C++ runtime type identification features
1550 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1551 of the language, you can save some space by using this flag.  Note that
1552 exception handling uses the same information, but it will generate it as
1553 needed.
1555 @item -fstats
1556 @opindex fstats
1557 Emit statistics about front-end processing at the end of the compilation.
1558 This information is generally only useful to the G++ development team.
1560 @item -ftemplate-depth-@var{n}
1561 @opindex ftemplate-depth
1562 Set the maximum instantiation depth for template classes to @var{n}.
1563 A limit on the template instantiation depth is needed to detect
1564 endless recursions during template class instantiation.  ANSI/ISO C++
1565 conforming programs must not rely on a maximum depth greater than 17.
1567 @item -fno-threadsafe-statics
1568 @opindex fno-threadsafe-statics
1569 Do not emit the extra code to use the routines specified in the C++
1570 ABI for thread-safe initialization of local statics.  You can use this
1571 option to reduce code size slightly in code that doesn't need to be
1572 thread-safe.
1574 @item -fuse-cxa-atexit
1575 @opindex fuse-cxa-atexit
1576 Register destructors for objects with static storage duration with the
1577 @code{__cxa_atexit} function rather than the @code{atexit} function.
1578 This option is required for fully standards-compliant handling of static
1579 destructors, but will only work if your C library supports
1580 @code{__cxa_atexit}.
1582 @item -fvisibility-inlines-hidden
1583 @opindex fvisibility-inlines-hidden
1584 Causes all inlined methods to be marked with
1585 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1586 appear in the export table of a DSO and do not require a PLT indirection
1587 when used within the DSO@.  Enabling this option can have a dramatic effect
1588 on load and link times of a DSO as it massively reduces the size of the
1589 dynamic export table when the library makes heavy use of templates.  While
1590 it can cause bloating through duplication of code within each DSO where
1591 it is used, often the wastage is less than the considerable space occupied
1592 by a long symbol name in the export table which is typical when using
1593 templates and namespaces.  For even more savings, combine with the
1594 @option{-fvisibility=hidden} switch.
1596 @item -fno-weak
1597 @opindex fno-weak
1598 Do not use weak symbol support, even if it is provided by the linker.
1599 By default, G++ will use weak symbols if they are available.  This
1600 option exists only for testing, and should not be used by end-users;
1601 it will result in inferior code and has no benefits.  This option may
1602 be removed in a future release of G++.
1604 @item -nostdinc++
1605 @opindex nostdinc++
1606 Do not search for header files in the standard directories specific to
1607 C++, but do still search the other standard directories.  (This option
1608 is used when building the C++ library.)
1609 @end table
1611 In addition, these optimization, warning, and code generation options
1612 have meanings only for C++ programs:
1614 @table @gcctabopt
1615 @item -fno-default-inline
1616 @opindex fno-default-inline
1617 Do not assume @samp{inline} for functions defined inside a class scope.
1618 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1619 functions will have linkage like inline functions; they just won't be
1620 inlined by default.
1622 @item -Wabi @r{(C++ only)}
1623 @opindex Wabi
1624 Warn when G++ generates code that is probably not compatible with the
1625 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1626 all such cases, there are probably some cases that are not warned about,
1627 even though G++ is generating incompatible code.  There may also be
1628 cases where warnings are emitted even though the code that is generated
1629 will be compatible.
1631 You should rewrite your code to avoid these warnings if you are
1632 concerned about the fact that code generated by G++ may not be binary
1633 compatible with code generated by other compilers.
1635 The known incompatibilities at this point include:
1637 @itemize @bullet
1639 @item
1640 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1641 pack data into the same byte as a base class.  For example:
1643 @smallexample
1644 struct A @{ virtual void f(); int f1 : 1; @};
1645 struct B : public A @{ int f2 : 1; @};
1646 @end smallexample
1648 @noindent
1649 In this case, G++ will place @code{B::f2} into the same byte
1650 as@code{A::f1}; other compilers will not.  You can avoid this problem
1651 by explicitly padding @code{A} so that its size is a multiple of the
1652 byte size on your platform; that will cause G++ and other compilers to
1653 layout @code{B} identically.
1655 @item
1656 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1657 tail padding when laying out virtual bases.  For example:
1659 @smallexample
1660 struct A @{ virtual void f(); char c1; @};
1661 struct B @{ B(); char c2; @};
1662 struct C : public A, public virtual B @{@};
1663 @end smallexample
1665 @noindent
1666 In this case, G++ will not place @code{B} into the tail-padding for
1667 @code{A}; other compilers will.  You can avoid this problem by
1668 explicitly padding @code{A} so that its size is a multiple of its
1669 alignment (ignoring virtual base classes); that will cause G++ and other
1670 compilers to layout @code{C} identically.
1672 @item
1673 Incorrect handling of bit-fields with declared widths greater than that
1674 of their underlying types, when the bit-fields appear in a union.  For
1675 example:
1677 @smallexample
1678 union U @{ int i : 4096; @};
1679 @end smallexample
1681 @noindent
1682 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1683 union too small by the number of bits in an @code{int}.
1685 @item
1686 Empty classes can be placed at incorrect offsets.  For example:
1688 @smallexample
1689 struct A @{@};
1691 struct B @{
1692   A a;
1693   virtual void f ();
1696 struct C : public B, public A @{@};
1697 @end smallexample
1699 @noindent
1700 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1701 it should be placed at offset zero.  G++ mistakenly believes that the
1702 @code{A} data member of @code{B} is already at offset zero.
1704 @item
1705 Names of template functions whose types involve @code{typename} or
1706 template template parameters can be mangled incorrectly.
1708 @smallexample
1709 template <typename Q>
1710 void f(typename Q::X) @{@}
1712 template <template <typename> class Q>
1713 void f(typename Q<int>::X) @{@}
1714 @end smallexample
1716 @noindent
1717 Instantiations of these templates may be mangled incorrectly.
1719 @end itemize
1721 @item -Wctor-dtor-privacy @r{(C++ only)}
1722 @opindex Wctor-dtor-privacy
1723 Warn when a class seems unusable because all the constructors or
1724 destructors in that class are private, and it has neither friends nor
1725 public static member functions.
1727 @item -Wnon-virtual-dtor @r{(C++ only)}
1728 @opindex Wnon-virtual-dtor
1729 Warn when a class appears to be polymorphic, thereby requiring a virtual
1730 destructor, yet it declares a non-virtual one.
1731 This warning is enabled by @option{-Wall}.
1733 @item -Wreorder @r{(C++ only)}
1734 @opindex Wreorder
1735 @cindex reordering, warning
1736 @cindex warning for reordering of member initializers
1737 Warn when the order of member initializers given in the code does not
1738 match the order in which they must be executed.  For instance:
1740 @smallexample
1741 struct A @{
1742   int i;
1743   int j;
1744   A(): j (0), i (1) @{ @}
1746 @end smallexample
1748 The compiler will rearrange the member initializers for @samp{i}
1749 and @samp{j} to match the declaration order of the members, emitting
1750 a warning to that effect.  This warning is enabled by @option{-Wall}.
1751 @end table
1753 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1755 @table @gcctabopt
1756 @item -Weffc++ @r{(C++ only)}
1757 @opindex Weffc++
1758 Warn about violations of the following style guidelines from Scott Meyers'
1759 @cite{Effective C++} book:
1761 @itemize @bullet
1762 @item
1763 Item 11:  Define a copy constructor and an assignment operator for classes
1764 with dynamically allocated memory.
1766 @item
1767 Item 12:  Prefer initialization to assignment in constructors.
1769 @item
1770 Item 14:  Make destructors virtual in base classes.
1772 @item
1773 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1775 @item
1776 Item 23:  Don't try to return a reference when you must return an object.
1778 @end itemize
1780 Also warn about violations of the following style guidelines from
1781 Scott Meyers' @cite{More Effective C++} book:
1783 @itemize @bullet
1784 @item
1785 Item 6:  Distinguish between prefix and postfix forms of increment and
1786 decrement operators.
1788 @item
1789 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1791 @end itemize
1793 When selecting this option, be aware that the standard library
1794 headers do not obey all of these guidelines; use @samp{grep -v}
1795 to filter out those warnings.
1797 @item -Wno-deprecated @r{(C++ only)}
1798 @opindex Wno-deprecated
1799 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1801 @item -Wstrict-null-sentinel @r{(C++ only)}
1802 @opindex Wstrict-null-sentinel
1803 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1804 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1805 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1806 it is guaranteed to of the same size as a pointer.  But this use is
1807 not portable across different compilers.
1809 @item -Wno-non-template-friend @r{(C++ only)}
1810 @opindex Wno-non-template-friend
1811 Disable warnings when non-templatized friend functions are declared
1812 within a template.  Since the advent of explicit template specification
1813 support in G++, if the name of the friend is an unqualified-id (i.e.,
1814 @samp{friend foo(int)}), the C++ language specification demands that the
1815 friend declare or define an ordinary, nontemplate function.  (Section
1816 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1817 could be interpreted as a particular specialization of a templatized
1818 function.  Because this non-conforming behavior is no longer the default
1819 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1820 check existing code for potential trouble spots and is on by default.
1821 This new compiler behavior can be turned off with
1822 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1823 but disables the helpful warning.
1825 @item -Wold-style-cast @r{(C++ only)}
1826 @opindex Wold-style-cast
1827 Warn if an old-style (C-style) cast to a non-void type is used within
1828 a C++ program.  The new-style casts (@samp{dynamic_cast},
1829 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1830 less vulnerable to unintended effects and much easier to search for.
1832 @item -Woverloaded-virtual @r{(C++ only)}
1833 @opindex Woverloaded-virtual
1834 @cindex overloaded virtual fn, warning
1835 @cindex warning for overloaded virtual fn
1836 Warn when a function declaration hides virtual functions from a
1837 base class.  For example, in:
1839 @smallexample
1840 struct A @{
1841   virtual void f();
1844 struct B: public A @{
1845   void f(int);
1847 @end smallexample
1849 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1850 like:
1852 @smallexample
1853 B* b;
1854 b->f();
1855 @end smallexample
1857 will fail to compile.
1859 @item -Wno-pmf-conversions @r{(C++ only)}
1860 @opindex Wno-pmf-conversions
1861 Disable the diagnostic for converting a bound pointer to member function
1862 to a plain pointer.
1864 @item -Wsign-promo @r{(C++ only)}
1865 @opindex Wsign-promo
1866 Warn when overload resolution chooses a promotion from unsigned or
1867 enumerated type to a signed type, over a conversion to an unsigned type of
1868 the same size.  Previous versions of G++ would try to preserve
1869 unsignedness, but the standard mandates the current behavior.
1871 @smallexample
1872 struct A @{
1873   operator int ();
1874   A& operator = (int);
1877 main ()
1879   A a,b;
1880   a = b;
1882 @end smallexample
1884 In this example, G++ will synthesize a default @samp{A& operator =
1885 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1886 @end table
1888 @node Objective-C and Objective-C++ Dialect Options
1889 @section Options Controlling Objective-C and Objective-C++ Dialects
1891 @cindex compiler options, Objective-C and Objective-C++
1892 @cindex Objective-C and Objective-C++ options, command line
1893 @cindex options, Objective-C and Objective-C++
1894 (NOTE: This manual does not describe the Objective-C and Objective-C++
1895 languages themselves.  See @xref{Standards,,Language Standards
1896 Supported by GCC}, for references.)
1898 This section describes the command-line options that are only meaningful
1899 for Objective-C and Objective-C++ programs, but you can also use most of
1900 the language-independent GNU compiler options.
1901 For example, you might compile a file @code{some_class.m} like this:
1903 @smallexample
1904 gcc -g -fgnu-runtime -O -c some_class.m
1905 @end smallexample
1907 @noindent
1908 In this example, @option{-fgnu-runtime} is an option meant only for
1909 Objective-C and Objective-C++ programs; you can use the other options with
1910 any language supported by GCC@.
1912 Note that since Objective-C is an extension of the C language, Objective-C
1913 compilations may also use options specific to the C front-end (e.g.,
1914 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1915 C++-specific options (e.g., @option{-Wabi}).
1917 Here is a list of options that are @emph{only} for compiling Objective-C
1918 and Objective-C++ programs:
1920 @table @gcctabopt
1921 @item -fconstant-string-class=@var{class-name}
1922 @opindex fconstant-string-class
1923 Use @var{class-name} as the name of the class to instantiate for each
1924 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1925 class name is @code{NXConstantString} if the GNU runtime is being used, and
1926 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1927 @option{-fconstant-cfstrings} option, if also present, will override the
1928 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1929 to be laid out as constant CoreFoundation strings.
1931 @item -fgnu-runtime
1932 @opindex fgnu-runtime
1933 Generate object code compatible with the standard GNU Objective-C
1934 runtime.  This is the default for most types of systems.
1936 @item -fnext-runtime
1937 @opindex fnext-runtime
1938 Generate output compatible with the NeXT runtime.  This is the default
1939 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1940 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1941 used.
1943 @item -fno-nil-receivers
1944 @opindex fno-nil-receivers
1945 Assume that all Objective-C message dispatches (e.g.,
1946 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1947 is not @code{nil}.  This allows for more efficient entry points in the runtime
1948 to be used.  Currently, this option is only available in conjunction with
1949 the NeXT runtime on Mac OS X 10.3 and later.
1951 @item -fobjc-call-cxx-cdtors
1952 @opindex fobjc-call-cxx-cdtors
1953 For each Objective-C class, check if any of its instance variables is a
1954 C++ object with a non-trivial default constructor.  If so, synthesize a
1955 special @code{- (id) .cxx_construct} instance method that will run
1956 non-trivial default constructors on any such instance variables, in order,
1957 and then return @code{self}.  Similarly, check if any instance variable
1958 is a C++ object with a non-trivial destructor, and if so, synthesize a
1959 special @code{- (void) .cxx_destruct} method that will run
1960 all such default destructors, in reverse order.
1962 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1963 thusly generated will only operate on instance variables declared in the
1964 current Objective-C class, and not those inherited from superclasses.  It
1965 is the responsibility of the Objective-C runtime to invoke all such methods
1966 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1967 will be invoked by the runtime immediately after a new object
1968 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1969 be invoked immediately before the runtime deallocates an object instance.
1971 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1972 support for invoking the @code{- (id) .cxx_construct} and
1973 @code{- (void) .cxx_destruct} methods.
1975 @item -fobjc-direct-dispatch
1976 @opindex fobjc-direct-dispatch
1977 Allow fast jumps to the message dispatcher.  On Darwin this is
1978 accomplished via the comm page.
1980 @item -fobjc-exceptions
1981 @opindex fobjc-exceptions
1982 Enable syntactic support for structured exception handling in Objective-C,
1983 similar to what is offered by C++ and Java.  Currently, this option is only
1984 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
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 standard.
2520 The C standard defines the order in which expressions in a C program are
2521 evaluated in terms of @dfn{sequence points}, which represent a partial
2522 ordering between the execution of parts of the program: those executed
2523 before the sequence point, and those executed after it.  These occur
2524 after the evaluation of a full expression (one which is not part of a
2525 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 standard specifies that ``Between the
2540 previous and next sequence point an object shall have its stored value
2541 modified at most once by the evaluation of an expression.  Furthermore,
2542 the prior value shall be read only to determine the value to be
2543 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 present implementation of this option only works for C programs.  A
2553 future implementation may also work for C++ programs.
2555 The C standard is worded confusingly, therefore there is some debate
2556 over the precise meaning of the sequence point rules in subtle cases.
2557 Links to discussions of the problem, including proposed formal
2558 definitions, may be found on the GCC readings page, at
2559 @w{@uref{http://gcc.gnu.org/readings.html}}.
2561 This warning is enabled by @option{-Wall}.
2563 @item -Wreturn-type
2564 @opindex Wreturn-type
2565 Warn whenever a function is defined with a return-type that defaults to
2566 @code{int}.  Also warn about any @code{return} statement with no
2567 return-value in a function whose return-type is not @code{void}.
2569 For C, also warn if the return type of a function has a type qualifier
2570 such as @code{const}.  Such a type qualifier has no effect, since the
2571 value returned by a function is not an lvalue.  ISO C prohibits
2572 qualified @code{void} return types on function definitions, so such
2573 return types always receive a warning even without this option.
2575 For C++, a function without return type always produces a diagnostic
2576 message, even when @option{-Wno-return-type} is specified.  The only
2577 exceptions are @samp{main} and functions defined in system headers.
2579 This warning is enabled by @option{-Wall}.
2581 @item -Wswitch
2582 @opindex Wswitch
2583 Warn whenever a @code{switch} statement has an index of enumerated type
2584 and lacks a @code{case} for one or more of the named codes of that
2585 enumeration.  (The presence of a @code{default} label prevents this
2586 warning.)  @code{case} labels outside the enumeration range also
2587 provoke warnings when this option is used.
2588 This warning is enabled by @option{-Wall}.
2590 @item -Wswitch-default
2591 @opindex Wswitch-switch
2592 Warn whenever a @code{switch} statement does not have a @code{default}
2593 case.
2595 @item -Wswitch-enum
2596 @opindex Wswitch-enum
2597 Warn whenever a @code{switch} statement has an index of enumerated type
2598 and lacks a @code{case} for one or more of the named codes of that
2599 enumeration.  @code{case} labels outside the enumeration range also
2600 provoke warnings when this option is used.
2602 @item -Wtrigraphs
2603 @opindex Wtrigraphs
2604 Warn if any trigraphs are encountered that might change the meaning of
2605 the program (trigraphs within comments are not warned about).
2606 This warning is enabled by @option{-Wall}.
2608 @item -Wunused-function
2609 @opindex Wunused-function
2610 Warn whenever a static function is declared but not defined or a
2611 non-inline static function is unused.
2612 This warning is enabled by @option{-Wall}.
2614 @item -Wunused-label
2615 @opindex Wunused-label
2616 Warn whenever a label is declared but not used.
2617 This warning is enabled by @option{-Wall}.
2619 To suppress this warning use the @samp{unused} attribute
2620 (@pxref{Variable Attributes}).
2622 @item -Wunused-parameter
2623 @opindex Wunused-parameter
2624 Warn whenever a function parameter is unused aside from its declaration.
2626 To suppress this warning use the @samp{unused} attribute
2627 (@pxref{Variable Attributes}).
2629 @item -Wunused-variable
2630 @opindex Wunused-variable
2631 Warn whenever a local variable or non-constant static variable is unused
2632 aside from its declaration
2633 This warning is enabled by @option{-Wall}.
2635 To suppress this warning use the @samp{unused} attribute
2636 (@pxref{Variable Attributes}).
2638 @item -Wunused-value
2639 @opindex Wunused-value
2640 Warn whenever a statement computes a result that is explicitly not used.
2641 This warning is enabled by @option{-Wall}.
2643 To suppress this warning cast the expression to @samp{void}.
2645 @item -Wunused
2646 @opindex Wunused
2647 All the above @option{-Wunused} options combined.
2649 In order to get a warning about an unused function parameter, you must
2650 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2651 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2653 @item -Wuninitialized
2654 @opindex Wuninitialized
2655 Warn if an automatic variable is used without first being initialized or
2656 if a variable may be clobbered by a @code{setjmp} call.
2658 These warnings are possible only in optimizing compilation,
2659 because they require data flow information that is computed only
2660 when optimizing.  If you don't specify @option{-O}, you simply won't
2661 get these warnings.
2663 If you want to warn about code which uses the uninitialized value of the
2664 variable in its own initializer, use the @option{-Winit-self} option.
2666 These warnings occur for individual uninitialized or clobbered
2667 elements of structure, union or array variables as well as for
2668 variables which are uninitialized or clobbered as a whole.  They do
2669 not occur for variables or elements declared @code{volatile}.  Because
2670 these warnings depend on optimization, the exact variables or elements
2671 for which there are warnings will depend on the precise optimization
2672 options and version of GCC used.
2674 Note that there may be no warning about a variable that is used only
2675 to compute a value that itself is never used, because such
2676 computations may be deleted by data flow analysis before the warnings
2677 are printed.
2679 These warnings are made optional because GCC is not smart
2680 enough to see all the reasons why the code might be correct
2681 despite appearing to have an error.  Here is one example of how
2682 this can happen:
2684 @smallexample
2685 @group
2687   int x;
2688   switch (y)
2689     @{
2690     case 1: x = 1;
2691       break;
2692     case 2: x = 4;
2693       break;
2694     case 3: x = 5;
2695     @}
2696   foo (x);
2698 @end group
2699 @end smallexample
2701 @noindent
2702 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2703 always initialized, but GCC doesn't know this.  Here is
2704 another common case:
2706 @smallexample
2708   int save_y;
2709   if (change_y) save_y = y, y = new_y;
2710   @dots{}
2711   if (change_y) y = save_y;
2713 @end smallexample
2715 @noindent
2716 This has no bug because @code{save_y} is used only if it is set.
2718 @cindex @code{longjmp} warnings
2719 This option also warns when a non-volatile automatic variable might be
2720 changed by a call to @code{longjmp}.  These warnings as well are possible
2721 only in optimizing compilation.
2723 The compiler sees only the calls to @code{setjmp}.  It cannot know
2724 where @code{longjmp} will be called; in fact, a signal handler could
2725 call it at any point in the code.  As a result, you may get a warning
2726 even when there is in fact no problem because @code{longjmp} cannot
2727 in fact be called at the place which would cause a problem.
2729 Some spurious warnings can be avoided if you declare all the functions
2730 you use that never return as @code{noreturn}.  @xref{Function
2731 Attributes}.
2733 This warning is enabled by @option{-Wall}.
2735 @item -Wunknown-pragmas
2736 @opindex Wunknown-pragmas
2737 @cindex warning for unknown pragmas
2738 @cindex unknown pragmas, warning
2739 @cindex pragmas, warning of unknown
2740 Warn when a #pragma directive is encountered which is not understood by
2741 GCC@.  If this command line option is used, warnings will even be issued
2742 for unknown pragmas in system header files.  This is not the case if
2743 the warnings were only enabled by the @option{-Wall} command line option.
2745 @item -Wno-pragmas
2746 @opindex Wno-pragmas
2747 @opindex Wpragmas
2748 Do not warn about misuses of pragmas, such as incorrect parameters,
2749 invalid syntax, or conflicts between pragmas.  See also
2750 @samp{-Wunknown-pragmas}.
2752 @item -Wstrict-aliasing
2753 @opindex Wstrict-aliasing
2754 This option is only active when @option{-fstrict-aliasing} is active.
2755 It warns about code which might break the strict aliasing rules that the
2756 compiler is using for optimization.  The warning does not catch all
2757 cases, but does attempt to catch the more common pitfalls.  It is
2758 included in @option{-Wall}.
2760 @item -Wstrict-aliasing=2
2761 @opindex Wstrict-aliasing=2
2762 This option is only active when @option{-fstrict-aliasing} is active.
2763 It warns about code which might break the strict aliasing rules that the
2764 compiler is using for optimization.  This warning catches more cases than
2765 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2766 cases that are safe.
2768 @item -Wall
2769 @opindex Wall
2770 All of the above @samp{-W} options combined.  This enables all the
2771 warnings about constructions that some users consider questionable, and
2772 that are easy to avoid (or modify to prevent the warning), even in
2773 conjunction with macros.  This also enables some language-specific
2774 warnings described in @ref{C++ Dialect Options} and
2775 @ref{Objective-C and Objective-C++ Dialect Options}.
2776 @end table
2778 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2779 Some of them warn about constructions that users generally do not
2780 consider questionable, but which occasionally you might wish to check
2781 for; others warn about constructions that are necessary or hard to avoid
2782 in some cases, and there is no simple way to modify the code to suppress
2783 the warning.
2785 @table @gcctabopt
2786 @item -Wextra
2787 @opindex W
2788 @opindex Wextra
2789 (This option used to be called @option{-W}.  The older name is still
2790 supported, but the newer name is more descriptive.)  Print extra warning
2791 messages for these events:
2793 @itemize @bullet
2794 @item
2795 A function can return either with or without a value.  (Falling
2796 off the end of the function body is considered returning without
2797 a value.)  For example, this function would evoke such a
2798 warning:
2800 @smallexample
2801 @group
2802 foo (a)
2804   if (a > 0)
2805     return a;
2807 @end group
2808 @end smallexample
2810 @item
2811 An expression-statement or the left-hand side of a comma expression
2812 contains no side effects.
2813 To suppress the warning, cast the unused expression to void.
2814 For example, an expression such as @samp{x[i,j]} will cause a warning,
2815 but @samp{x[(void)i,j]} will not.
2817 @item
2818 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2820 @item
2821 Storage-class specifiers like @code{static} are not the first things in
2822 a declaration.  According to the C Standard, this usage is obsolescent.
2824 @item
2825 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2826 arguments.
2828 @item
2829 A comparison between signed and unsigned values could produce an
2830 incorrect result when the signed value is converted to unsigned.
2831 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2833 @item
2834 An aggregate has an initializer which does not initialize all members.
2835 This warning can be independently controlled by
2836 @option{-Wmissing-field-initializers}.
2838 @item
2839 A function parameter is declared without a type specifier in K&R-style
2840 functions:
2842 @smallexample
2843 void foo(bar) @{ @}
2844 @end smallexample
2846 @item
2847 An empty body occurs in an @samp{if} or @samp{else} statement.
2849 @item
2850 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2851 @samp{>}, or @samp{>=}.
2853 @item
2854 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2856 @item
2857 Any of several floating-point events that often indicate errors, such as
2858 overflow, underflow, loss of precision, etc.
2860 @item @r{(C++ only)}
2861 An enumerator and a non-enumerator both appear in a conditional expression.
2863 @item @r{(C++ only)}
2864 A non-static reference or non-static @samp{const} member appears in a
2865 class without constructors.
2867 @item @r{(C++ only)}
2868 Ambiguous virtual bases.
2870 @item @r{(C++ only)}
2871 Subscripting an array which has been declared @samp{register}.
2873 @item @r{(C++ only)}
2874 Taking the address of a variable which has been declared @samp{register}.
2876 @item @r{(C++ only)}
2877 A base class is not initialized in a derived class' copy constructor.
2878 @end itemize
2880 @item -Wno-div-by-zero
2881 @opindex Wno-div-by-zero
2882 @opindex Wdiv-by-zero
2883 Do not warn about compile-time integer division by zero.  Floating point
2884 division by zero is not warned about, as it can be a legitimate way of
2885 obtaining infinities and NaNs.
2887 @item -Wsystem-headers
2888 @opindex Wsystem-headers
2889 @cindex warnings from system headers
2890 @cindex system headers, warnings from
2891 Print warning messages for constructs found in system header files.
2892 Warnings from system headers are normally suppressed, on the assumption
2893 that they usually do not indicate real problems and would only make the
2894 compiler output harder to read.  Using this command line option tells
2895 GCC to emit warnings from system headers as if they occurred in user
2896 code.  However, note that using @option{-Wall} in conjunction with this
2897 option will @emph{not} warn about unknown pragmas in system
2898 headers---for that, @option{-Wunknown-pragmas} must also be used.
2900 @item -Wfloat-equal
2901 @opindex Wfloat-equal
2902 Warn if floating point values are used in equality comparisons.
2904 The idea behind this is that sometimes it is convenient (for the
2905 programmer) to consider floating-point values as approximations to
2906 infinitely precise real numbers.  If you are doing this, then you need
2907 to compute (by analyzing the code, or in some other way) the maximum or
2908 likely maximum error that the computation introduces, and allow for it
2909 when performing comparisons (and when producing output, but that's a
2910 different problem).  In particular, instead of testing for equality, you
2911 would check to see whether the two values have ranges that overlap; and
2912 this is done with the relational operators, so equality comparisons are
2913 probably mistaken.
2915 @item -Wtraditional @r{(C only)}
2916 @opindex Wtraditional
2917 Warn about certain constructs that behave differently in traditional and
2918 ISO C@.  Also warn about ISO C constructs that have no traditional C
2919 equivalent, and/or problematic constructs which should be avoided.
2921 @itemize @bullet
2922 @item
2923 Macro parameters that appear within string literals in the macro body.
2924 In traditional C macro replacement takes place within string literals,
2925 but does not in ISO C@.
2927 @item
2928 In traditional C, some preprocessor directives did not exist.
2929 Traditional preprocessors would only consider a line to be a directive
2930 if the @samp{#} appeared in column 1 on the line.  Therefore
2931 @option{-Wtraditional} warns about directives that traditional C
2932 understands but would ignore because the @samp{#} does not appear as the
2933 first character on the line.  It also suggests you hide directives like
2934 @samp{#pragma} not understood by traditional C by indenting them.  Some
2935 traditional implementations would not recognize @samp{#elif}, so it
2936 suggests avoiding it altogether.
2938 @item
2939 A function-like macro that appears without arguments.
2941 @item
2942 The unary plus operator.
2944 @item
2945 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2946 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2947 constants.)  Note, these suffixes appear in macros defined in the system
2948 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2949 Use of these macros in user code might normally lead to spurious
2950 warnings, however GCC's integrated preprocessor has enough context to
2951 avoid warning in these cases.
2953 @item
2954 A function declared external in one block and then used after the end of
2955 the block.
2957 @item
2958 A @code{switch} statement has an operand of type @code{long}.
2960 @item
2961 A non-@code{static} function declaration follows a @code{static} one.
2962 This construct is not accepted by some traditional C compilers.
2964 @item
2965 The ISO type of an integer constant has a different width or
2966 signedness from its traditional type.  This warning is only issued if
2967 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2968 typically represent bit patterns, are not warned about.
2970 @item
2971 Usage of ISO string concatenation is detected.
2973 @item
2974 Initialization of automatic aggregates.
2976 @item
2977 Identifier conflicts with labels.  Traditional C lacks a separate
2978 namespace for labels.
2980 @item
2981 Initialization of unions.  If the initializer is zero, the warning is
2982 omitted.  This is done under the assumption that the zero initializer in
2983 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2984 initializer warnings and relies on default initialization to zero in the
2985 traditional C case.
2987 @item
2988 Conversions by prototypes between fixed/floating point values and vice
2989 versa.  The absence of these prototypes when compiling with traditional
2990 C would cause serious problems.  This is a subset of the possible
2991 conversion warnings, for the full set use @option{-Wconversion}.
2993 @item
2994 Use of ISO C style function definitions.  This warning intentionally is
2995 @emph{not} issued for prototype declarations or variadic functions
2996 because these ISO C features will appear in your code when using
2997 libiberty's traditional C compatibility macros, @code{PARAMS} and
2998 @code{VPARAMS}.  This warning is also bypassed for nested functions
2999 because that feature is already a GCC extension and thus not relevant to
3000 traditional C compatibility.
3001 @end itemize
3003 @item -Wdeclaration-after-statement @r{(C only)}
3004 @opindex Wdeclaration-after-statement
3005 Warn when a declaration is found after a statement in a block.  This
3006 construct, known from C++, was introduced with ISO C99 and is by default
3007 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3008 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3010 @item -Wundef
3011 @opindex Wundef
3012 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3014 @item -Wno-endif-labels
3015 @opindex Wno-endif-labels
3016 @opindex Wendif-labels
3017 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3019 @item -Wshadow
3020 @opindex Wshadow
3021 Warn whenever a local variable shadows another local variable, parameter or
3022 global variable or whenever a built-in function is shadowed.
3024 @item -Wlarger-than-@var{len}
3025 @opindex Wlarger-than
3026 Warn whenever an object of larger than @var{len} bytes is defined.
3028 @item -Wunsafe-loop-optimizations
3029 @opindex Wunsafe-loop-optimizations
3030 Warn if the loop cannot be optimized because the compiler could not
3031 assume anything on the bounds of the loop indices.  With
3032 @option{-funsafe-loop-optimizations} warn if the compiler made
3033 such assumptions.
3035 @item -Wpointer-arith
3036 @opindex Wpointer-arith
3037 Warn about anything that depends on the ``size of'' a function type or
3038 of @code{void}.  GNU C assigns these types a size of 1, for
3039 convenience in calculations with @code{void *} pointers and pointers
3040 to functions.
3042 @item -Wbad-function-cast @r{(C only)}
3043 @opindex Wbad-function-cast
3044 Warn whenever a function call is cast to a non-matching type.
3045 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3047 @item -Wc++-compat
3048 Warn about ISO C constructs that are outside of the common subset of
3049 ISO C and ISO C++, e.g.@: request for implicit conversion from
3050 @code{void *} to a pointer to non-@code{void} type.
3052 @item -Wcast-qual
3053 @opindex Wcast-qual
3054 Warn whenever a pointer is cast so as to remove a type qualifier from
3055 the target type.  For example, warn if a @code{const char *} is cast
3056 to an ordinary @code{char *}.
3058 @item -Wcast-align
3059 @opindex Wcast-align
3060 Warn whenever a pointer is cast such that the required alignment of the
3061 target is increased.  For example, warn if a @code{char *} is cast to
3062 an @code{int *} on machines where integers can only be accessed at
3063 two- or four-byte boundaries.
3065 @item -Wwrite-strings
3066 @opindex Wwrite-strings
3067 When compiling C, give string constants the type @code{const
3068 char[@var{length}]} so that
3069 copying the address of one into a non-@code{const} @code{char *}
3070 pointer will get a warning; when compiling C++, warn about the
3071 deprecated conversion from string constants to @code{char *}.
3072 These warnings will help you find at
3073 compile time code that can try to write into a string constant, but
3074 only if you have been very careful about using @code{const} in
3075 declarations and prototypes.  Otherwise, it will just be a nuisance;
3076 this is why we did not make @option{-Wall} request these warnings.
3078 @item -Wconversion
3079 @opindex Wconversion
3080 Warn if a prototype causes a type conversion that is different from what
3081 would happen to the same argument in the absence of a prototype.  This
3082 includes conversions of fixed point to floating and vice versa, and
3083 conversions changing the width or signedness of a fixed point argument
3084 except when the same as the default promotion.
3086 Also, warn if a negative integer constant expression is implicitly
3087 converted to an unsigned type.  For example, warn about the assignment
3088 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3089 casts like @code{(unsigned) -1}.
3091 @item -Wsign-compare
3092 @opindex Wsign-compare
3093 @cindex warning for comparison of signed and unsigned values
3094 @cindex comparison of signed and unsigned values, warning
3095 @cindex signed and unsigned values, comparison warning
3096 Warn when a comparison between signed and unsigned values could produce
3097 an incorrect result when the signed value is converted to unsigned.
3098 This warning is also enabled by @option{-Wextra}; to get the other warnings
3099 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3101 @item -Waggregate-return
3102 @opindex Waggregate-return
3103 Warn if any functions that return structures or unions are defined or
3104 called.  (In languages where you can return an array, this also elicits
3105 a warning.)
3107 @item -Wno-attributes
3108 @opindex Wno-attributes
3109 @opindex Wattributes
3110 Do not warn if an unexpected @code{__attribute__} is used, such as
3111 unrecognized attributes, function attributes applied to variables,
3112 etc.  This will not stop errors for incorrect use of supported
3113 attributes.
3115 @item -Wstrict-prototypes @r{(C only)}
3116 @opindex Wstrict-prototypes
3117 Warn if a function is declared or defined without specifying the
3118 argument types.  (An old-style function definition is permitted without
3119 a warning if preceded by a declaration which specifies the argument
3120 types.)
3122 @item -Wold-style-definition @r{(C only)}
3123 @opindex Wold-style-definition
3124 Warn if an old-style function definition is used.  A warning is given
3125 even if there is a previous prototype.
3127 @item -Wmissing-prototypes @r{(C only)}
3128 @opindex Wmissing-prototypes
3129 Warn if a global function is defined without a previous prototype
3130 declaration.  This warning is issued even if the definition itself
3131 provides a prototype.  The aim is to detect global functions that fail
3132 to be declared in header files.
3134 @item -Wmissing-declarations @r{(C only)}
3135 @opindex Wmissing-declarations
3136 Warn if a global function is defined without a previous declaration.
3137 Do so even if the definition itself provides a prototype.
3138 Use this option to detect global functions that are not declared in
3139 header files.
3141 @item -Wmissing-field-initializers
3142 @opindex Wmissing-field-initializers
3143 @opindex W
3144 @opindex Wextra
3145 Warn if a structure's initializer has some fields missing.  For
3146 example, the following code would cause such a warning, because
3147 @code{x.h} is implicitly zero:
3149 @smallexample
3150 struct s @{ int f, g, h; @};
3151 struct s x = @{ 3, 4 @};
3152 @end smallexample
3154 This option does not warn about designated initializers, so the following
3155 modification would not trigger a warning:
3157 @smallexample
3158 struct s @{ int f, g, h; @};
3159 struct s x = @{ .f = 3, .g = 4 @};
3160 @end smallexample
3162 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3163 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3165 @item -Wmissing-noreturn
3166 @opindex Wmissing-noreturn
3167 Warn about functions which might be candidates for attribute @code{noreturn}.
3168 Note these are only possible candidates, not absolute ones.  Care should
3169 be taken to manually verify functions actually do not ever return before
3170 adding the @code{noreturn} attribute, otherwise subtle code generation
3171 bugs could be introduced.  You will not get a warning for @code{main} in
3172 hosted C environments.
3174 @item -Wmissing-format-attribute
3175 @opindex Wmissing-format-attribute
3176 @opindex Wformat
3177 Warn about function pointers which might be candidates for @code{format}
3178 attributes.  Note these are only possible candidates, not absolute ones.
3179 GCC will guess that function pointers with @code{format} attributes that
3180 are used in assignment, initialization, parameter passing or return
3181 statements should have a corresponding @code{format} attribute in the
3182 resulting type.  I.e.@: the left-hand side of the assignment or
3183 initialization, the type of the parameter variable, or the return type
3184 of the containing function respectively should also have a @code{format}
3185 attribute to avoid the warning.
3187 GCC will also warn about function definitions which might be
3188 candidates for @code{format} attributes.  Again, these are only
3189 possible candidates.  GCC will guess that @code{format} attributes
3190 might be appropriate for any function that calls a function like
3191 @code{vprintf} or @code{vscanf}, but this might not always be the
3192 case, and some functions for which @code{format} attributes are
3193 appropriate may not be detected.
3195 @item -Wno-multichar
3196 @opindex Wno-multichar
3197 @opindex Wmultichar
3198 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3199 Usually they indicate a typo in the user's code, as they have
3200 implementation-defined values, and should not be used in portable code.
3202 @item -Wnormalized=<none|id|nfc|nfkc>
3203 @opindex Wnormalized
3204 @cindex NFC
3205 @cindex NFKC
3206 @cindex character set, input normalization
3207 In ISO C and ISO C++, two identifiers are different if they are
3208 different sequences of characters.  However, sometimes when characters
3209 outside the basic ASCII character set are used, you can have two
3210 different character sequences that look the same.  To avoid confusion,
3211 the ISO 10646 standard sets out some @dfn{normalization rules} which
3212 when applied ensure that two sequences that look the same are turned into
3213 the same sequence.  GCC can warn you if you are using identifiers which
3214 have not been normalized; this option controls that warning.
3216 There are four levels of warning that GCC supports.  The default is
3217 @option{-Wnormalized=nfc}, which warns about any identifier which is
3218 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3219 recommended form for most uses.
3221 Unfortunately, there are some characters which ISO C and ISO C++ allow
3222 in identifiers that when turned into NFC aren't allowable as
3223 identifiers.  That is, there's no way to use these symbols in portable
3224 ISO C or C++ and have all your identifiers in NFC.
3225 @option{-Wnormalized=id} suppresses the warning for these characters.
3226 It is hoped that future versions of the standards involved will correct
3227 this, which is why this option is not the default.
3229 You can switch the warning off for all characters by writing
3230 @option{-Wnormalized=none}.  You would only want to do this if you
3231 were using some other normalization scheme (like ``D''), because
3232 otherwise you can easily create bugs that are literally impossible to see.
3234 Some characters in ISO 10646 have distinct meanings but look identical
3235 in some fonts or display methodologies, especially once formatting has
3236 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3237 LETTER N'', will display just like a regular @code{n} which has been
3238 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3239 normalisation scheme to convert all these into a standard form as
3240 well, and GCC will warn if your code is not in NFKC if you use
3241 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3242 about every identifier that contains the letter O because it might be
3243 confused with the digit 0, and so is not the default, but may be
3244 useful as a local coding convention if the programming environment is
3245 unable to be fixed to display these characters distinctly.
3247 @item -Wno-deprecated-declarations
3248 @opindex Wno-deprecated-declarations
3249 Do not warn about uses of functions, variables, and types marked as
3250 deprecated by using the @code{deprecated} attribute.
3251 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3252 @pxref{Type Attributes}.)
3254 @item -Wpacked
3255 @opindex Wpacked
3256 Warn if a structure is given the packed attribute, but the packed
3257 attribute has no effect on the layout or size of the structure.
3258 Such structures may be mis-aligned for little benefit.  For
3259 instance, in this code, the variable @code{f.x} in @code{struct bar}
3260 will be misaligned even though @code{struct bar} does not itself
3261 have the packed attribute:
3263 @smallexample
3264 @group
3265 struct foo @{
3266   int x;
3267   char a, b, c, d;
3268 @} __attribute__((packed));
3269 struct bar @{
3270   char z;
3271   struct foo f;
3273 @end group
3274 @end smallexample
3276 @item -Wpadded
3277 @opindex Wpadded
3278 Warn if padding is included in a structure, either to align an element
3279 of the structure or to align the whole structure.  Sometimes when this
3280 happens it is possible to rearrange the fields of the structure to
3281 reduce the padding and so make the structure smaller.
3283 @item -Wredundant-decls
3284 @opindex Wredundant-decls
3285 Warn if anything is declared more than once in the same scope, even in
3286 cases where multiple declaration is valid and changes nothing.
3288 @item -Wnested-externs @r{(C only)}
3289 @opindex Wnested-externs
3290 Warn if an @code{extern} declaration is encountered within a function.
3292 @item -Wunreachable-code
3293 @opindex Wunreachable-code
3294 Warn if the compiler detects that code will never be executed.
3296 This option is intended to warn when the compiler detects that at
3297 least a whole line of source code will never be executed, because
3298 some condition is never satisfied or because it is after a
3299 procedure that never returns.
3301 It is possible for this option to produce a warning even though there
3302 are circumstances under which part of the affected line can be executed,
3303 so care should be taken when removing apparently-unreachable code.
3305 For instance, when a function is inlined, a warning may mean that the
3306 line is unreachable in only one inlined copy of the function.
3308 This option is not made part of @option{-Wall} because in a debugging
3309 version of a program there is often substantial code which checks
3310 correct functioning of the program and is, hopefully, unreachable
3311 because the program does work.  Another common use of unreachable
3312 code is to provide behavior which is selectable at compile-time.
3314 @item -Winline
3315 @opindex Winline
3316 Warn if a function can not be inlined and it was declared as inline.
3317 Even with this option, the compiler will not warn about failures to
3318 inline functions declared in system headers.
3320 The compiler uses a variety of heuristics to determine whether or not
3321 to inline a function.  For example, the compiler takes into account
3322 the size of the function being inlined and the amount of inlining
3323 that has already been done in the current function.  Therefore,
3324 seemingly insignificant changes in the source program can cause the
3325 warnings produced by @option{-Winline} to appear or disappear.
3327 @item -Wno-invalid-offsetof @r{(C++ only)}
3328 @opindex Wno-invalid-offsetof
3329 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3330 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3331 to a non-POD type is undefined.  In existing C++ implementations,
3332 however, @samp{offsetof} typically gives meaningful results even when
3333 applied to certain kinds of non-POD types. (Such as a simple
3334 @samp{struct} that fails to be a POD type only by virtue of having a
3335 constructor.)  This flag is for users who are aware that they are
3336 writing nonportable code and who have deliberately chosen to ignore the
3337 warning about it.
3339 The restrictions on @samp{offsetof} may be relaxed in a future version
3340 of the C++ standard.
3342 @item -Wno-int-to-pointer-cast @r{(C only)}
3343 @opindex Wno-int-to-pointer-cast
3344 Suppress warnings from casts to pointer type of an integer of a
3345 different size.
3347 @item -Wno-pointer-to-int-cast @r{(C only)}
3348 @opindex Wno-pointer-to-int-cast
3349 Suppress warnings from casts from a pointer to an integer type of a
3350 different size.
3352 @item -Winvalid-pch
3353 @opindex Winvalid-pch
3354 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3355 the search path but can't be used.
3357 @item -Wlong-long
3358 @opindex Wlong-long
3359 @opindex Wno-long-long
3360 Warn if @samp{long long} type is used.  This is default.  To inhibit
3361 the warning messages, use @option{-Wno-long-long}.  Flags
3362 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3363 only when @option{-pedantic} flag is used.
3365 @item -Wvariadic-macros
3366 @opindex Wvariadic-macros
3367 @opindex Wno-variadic-macros
3368 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3369 alternate syntax when in pedantic ISO C99 mode.  This is default.
3370 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3372 @item -Wdisabled-optimization
3373 @opindex Wdisabled-optimization
3374 Warn if a requested optimization pass is disabled.  This warning does
3375 not generally indicate that there is anything wrong with your code; it
3376 merely indicates that GCC's optimizers were unable to handle the code
3377 effectively.  Often, the problem is that your code is too big or too
3378 complex; GCC will refuse to optimize programs when the optimization
3379 itself is likely to take inordinate amounts of time.
3381 @item -Wno-pointer-sign
3382 @opindex Wno-pointer-sign
3383 Don't warn for pointer argument passing or assignment with different signedness.
3384 Only useful in the negative form since this warning is enabled by default.
3385 This option is only supported for C and Objective-C@.
3387 @item -Werror
3388 @opindex Werror
3389 Make all warnings into errors.
3391 @item -Wstack-protector
3392 This option is only active when @option{-fstack-protector} is active.  It
3393 warns about functions that will not be protected against stack smashing.
3395 @end table
3397 @node Debugging Options
3398 @section Options for Debugging Your Program or GCC
3399 @cindex options, debugging
3400 @cindex debugging information options
3402 GCC has various special options that are used for debugging
3403 either your program or GCC:
3405 @table @gcctabopt
3406 @item -g
3407 @opindex g
3408 Produce debugging information in the operating system's native format
3409 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3410 information.
3412 On most systems that use stabs format, @option{-g} enables use of extra
3413 debugging information that only GDB can use; this extra information
3414 makes debugging work better in GDB but will probably make other debuggers
3415 crash or
3416 refuse to read the program.  If you want to control for certain whether
3417 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3418 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3420 GCC allows you to use @option{-g} with
3421 @option{-O}.  The shortcuts taken by optimized code may occasionally
3422 produce surprising results: some variables you declared may not exist
3423 at all; flow of control may briefly move where you did not expect it;
3424 some statements may not be executed because they compute constant
3425 results or their values were already at hand; some statements may
3426 execute in different places because they were moved out of loops.
3428 Nevertheless it proves possible to debug optimized output.  This makes
3429 it reasonable to use the optimizer for programs that might have bugs.
3431 The following options are useful when GCC is generated with the
3432 capability for more than one debugging format.
3434 @item -ggdb
3435 @opindex ggdb
3436 Produce debugging information for use by GDB@.  This means to use the
3437 most expressive format available (DWARF 2, stabs, or the native format
3438 if neither of those are supported), including GDB extensions if at all
3439 possible.
3441 @item -gstabs
3442 @opindex gstabs
3443 Produce debugging information in stabs format (if that is supported),
3444 without GDB extensions.  This is the format used by DBX on most BSD
3445 systems.  On MIPS, Alpha and System V Release 4 systems this option
3446 produces stabs debugging output which is not understood by DBX or SDB@.
3447 On System V Release 4 systems this option requires the GNU assembler.
3449 @item -feliminate-unused-debug-symbols
3450 @opindex feliminate-unused-debug-symbols
3451 Produce debugging information in stabs format (if that is supported),
3452 for only symbols that are actually used.
3454 @item -gstabs+
3455 @opindex gstabs+
3456 Produce debugging information in stabs format (if that is supported),
3457 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3458 use of these extensions is likely to make other debuggers crash or
3459 refuse to read the program.
3461 @item -gcoff
3462 @opindex gcoff
3463 Produce debugging information in COFF format (if that is supported).
3464 This is the format used by SDB on most System V systems prior to
3465 System V Release 4.
3467 @item -gxcoff
3468 @opindex gxcoff
3469 Produce debugging information in XCOFF format (if that is supported).
3470 This is the format used by the DBX debugger on IBM RS/6000 systems.
3472 @item -gxcoff+
3473 @opindex gxcoff+
3474 Produce debugging information in XCOFF format (if that is supported),
3475 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3476 use of these extensions is likely to make other debuggers crash or
3477 refuse to read the program, and may cause assemblers other than the GNU
3478 assembler (GAS) to fail with an error.
3480 @item -gdwarf-2
3481 @opindex gdwarf-2
3482 Produce debugging information in DWARF version 2 format (if that is
3483 supported).  This is the format used by DBX on IRIX 6.  With this
3484 option, GCC uses features of DWARF version 3 when they are useful;
3485 version 3 is upward compatible with version 2, but may still cause
3486 problems for older debuggers.
3488 @item -gvms
3489 @opindex gvms
3490 Produce debugging information in VMS debug format (if that is
3491 supported).  This is the format used by DEBUG on VMS systems.
3493 @item -g@var{level}
3494 @itemx -ggdb@var{level}
3495 @itemx -gstabs@var{level}
3496 @itemx -gcoff@var{level}
3497 @itemx -gxcoff@var{level}
3498 @itemx -gvms@var{level}
3499 Request debugging information and also use @var{level} to specify how
3500 much information.  The default level is 2.
3502 Level 1 produces minimal information, enough for making backtraces in
3503 parts of the program that you don't plan to debug.  This includes
3504 descriptions of functions and external variables, but no information
3505 about local variables and no line numbers.
3507 Level 3 includes extra information, such as all the macro definitions
3508 present in the program.  Some debuggers support macro expansion when
3509 you use @option{-g3}.
3511 @option{-gdwarf-2} does not accept a concatenated debug level, because
3512 GCC used to support an option @option{-gdwarf} that meant to generate
3513 debug information in version 1 of the DWARF format (which is very
3514 different from version 2), and it would have been too confusing.  That
3515 debug format is long obsolete, but the option cannot be changed now.
3516 Instead use an additional @option{-g@var{level}} option to change the
3517 debug level for DWARF2.
3519 @item -feliminate-dwarf2-dups
3520 @opindex feliminate-dwarf2-dups
3521 Compress DWARF2 debugging information by eliminating duplicated
3522 information about each symbol.  This option only makes sense when
3523 generating DWARF2 debugging information with @option{-gdwarf-2}.
3525 @cindex @command{prof}
3526 @item -p
3527 @opindex p
3528 Generate extra code to write profile information suitable for the
3529 analysis program @command{prof}.  You must use this option when compiling
3530 the source files you want data about, and you must also use it when
3531 linking.
3533 @cindex @command{gprof}
3534 @item -pg
3535 @opindex pg
3536 Generate extra code to write profile information suitable for the
3537 analysis program @command{gprof}.  You must use this option when compiling
3538 the source files you want data about, and you must also use it when
3539 linking.
3541 @item -Q
3542 @opindex Q
3543 Makes the compiler print out each function name as it is compiled, and
3544 print some statistics about each pass when it finishes.
3546 @item -ftime-report
3547 @opindex ftime-report
3548 Makes the compiler print some statistics about the time consumed by each
3549 pass when it finishes.
3551 @item -fmem-report
3552 @opindex fmem-report
3553 Makes the compiler print some statistics about permanent memory
3554 allocation when it finishes.
3556 @item -fprofile-arcs
3557 @opindex fprofile-arcs
3558 Add code so that program flow @dfn{arcs} are instrumented.  During
3559 execution the program records how many times each branch and call is
3560 executed and how many times it is taken or returns.  When the compiled
3561 program exits it saves this data to a file called
3562 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3563 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3564 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3565 @var{auxname} is generated from the name of the output file, if
3566 explicitly specified and it is not the final executable, otherwise it is
3567 the basename of the source file.  In both cases any suffix is removed
3568 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3569 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3570 @xref{Cross-profiling}.
3572 @cindex @command{gcov}
3573 @item --coverage
3574 @opindex coverage
3576 This option is used to compile and link code instrumented for coverage
3577 analysis.  The option is a synonym for @option{-fprofile-arcs}
3578 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3579 linking).  See the documentation for those options for more details.
3581 @itemize
3583 @item
3584 Compile the source files with @option{-fprofile-arcs} plus optimization
3585 and code generation options.  For test coverage analysis, use the
3586 additional @option{-ftest-coverage} option.  You do not need to profile
3587 every source file in a program.
3589 @item
3590 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3591 (the latter implies the former).
3593 @item
3594 Run the program on a representative workload to generate the arc profile
3595 information.  This may be repeated any number of times.  You can run
3596 concurrent instances of your program, and provided that the file system
3597 supports locking, the data files will be correctly updated.  Also
3598 @code{fork} calls are detected and correctly handled (double counting
3599 will not happen).
3601 @item
3602 For profile-directed optimizations, compile the source files again with
3603 the same optimization and code generation options plus
3604 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3605 Control Optimization}).
3607 @item
3608 For test coverage analysis, use @command{gcov} to produce human readable
3609 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3610 @command{gcov} documentation for further information.
3612 @end itemize
3614 With @option{-fprofile-arcs}, for each function of your program GCC
3615 creates a program flow graph, then finds a spanning tree for the graph.
3616 Only arcs that are not on the spanning tree have to be instrumented: the
3617 compiler adds code to count the number of times that these arcs are
3618 executed.  When an arc is the only exit or only entrance to a block, the
3619 instrumentation code can be added to the block; otherwise, a new basic
3620 block must be created to hold the instrumentation code.
3622 @need 2000
3623 @item -ftest-coverage
3624 @opindex ftest-coverage
3625 Produce a notes file that the @command{gcov} code-coverage utility
3626 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3627 show program coverage.  Each source file's note file is called
3628 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3629 above for a description of @var{auxname} and instructions on how to
3630 generate test coverage data.  Coverage data will match the source files
3631 more closely, if you do not optimize.
3633 @item -d@var{letters}
3634 @item -fdump-rtl-@var{pass}
3635 @opindex d
3636 Says to make debugging dumps during compilation at times specified by
3637 @var{letters}.    This is used for debugging the RTL-based passes of the
3638 compiler.  The file names for most of the dumps are made by appending a
3639 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3640 from the name of the output file, if explicitly specified and it is not
3641 an executable, otherwise it is the basename of the source file.
3643 Most debug dumps can be enabled either passing a letter to the @option{-d}
3644 option, or with a long @option{-fdump-rtl} switch; here are the possible
3645 letters for use in @var{letters} and @var{pass}, and their meanings:
3647 @table @gcctabopt
3648 @item -dA
3649 @opindex dA
3650 Annotate the assembler output with miscellaneous debugging information.
3652 @item -db
3653 @itemx -fdump-rtl-bp
3654 @opindex db
3655 @opindex fdump-rtl-bp
3656 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3658 @item -dB
3659 @itemx -fdump-rtl-bbro
3660 @opindex dB
3661 @opindex fdump-rtl-bbro
3662 Dump after block reordering, to @file{@var{file}.30.bbro}.
3664 @item -dc
3665 @itemx -fdump-rtl-combine
3666 @opindex dc
3667 @opindex fdump-rtl-combine
3668 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3670 @item -dC
3671 @itemx -fdump-rtl-ce1
3672 @itemx -fdump-rtl-ce2
3673 @opindex dC
3674 @opindex fdump-rtl-ce1
3675 @opindex fdump-rtl-ce2
3676 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3677 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3678 and @option{-fdump-rtl-ce2} enable dumping after the second if
3679 conversion, to the file @file{@var{file}.18.ce2}.
3681 @item -dd
3682 @itemx -fdump-rtl-btl
3683 @itemx -fdump-rtl-dbr
3684 @opindex dd
3685 @opindex fdump-rtl-btl
3686 @opindex fdump-rtl-dbr
3687 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3688 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3689 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3690 scheduling, to @file{@var{file}.36.dbr}.
3692 @item -dD
3693 @opindex dD
3694 Dump all macro definitions, at the end of preprocessing, in addition to
3695 normal output.
3697 @item -dE
3698 @itemx -fdump-rtl-ce3
3699 @opindex dE
3700 @opindex fdump-rtl-ce3
3701 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3703 @item -df
3704 @itemx -fdump-rtl-cfg
3705 @itemx -fdump-rtl-life
3706 @opindex df
3707 @opindex fdump-rtl-cfg
3708 @opindex fdump-rtl-life
3709 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3710 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3711 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3712 to @file{@var{file}.16.life}.
3714 @item -dg
3715 @itemx -fdump-rtl-greg
3716 @opindex dg
3717 @opindex fdump-rtl-greg
3718 Dump after global register allocation, to @file{@var{file}.23.greg}.
3720 @item -dG
3721 @itemx -fdump-rtl-gcse
3722 @itemx -fdump-rtl-bypass
3723 @opindex dG
3724 @opindex fdump-rtl-gcse
3725 @opindex fdump-rtl-bypass
3726 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3727 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3728 enable dumping after jump bypassing and control flow optimizations, to
3729 @file{@var{file}.07.bypass}.
3731 @item -dh
3732 @itemx -fdump-rtl-eh
3733 @opindex dh
3734 @opindex fdump-rtl-eh
3735 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3737 @item -di
3738 @itemx -fdump-rtl-sibling
3739 @opindex di
3740 @opindex fdump-rtl-sibling
3741 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3743 @item -dj
3744 @itemx -fdump-rtl-jump
3745 @opindex dj
3746 @opindex fdump-rtl-jump
3747 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3749 @item -dk
3750 @itemx -fdump-rtl-stack
3751 @opindex dk
3752 @opindex fdump-rtl-stack
3753 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3755 @item -dl
3756 @itemx -fdump-rtl-lreg
3757 @opindex dl
3758 @opindex fdump-rtl-lreg
3759 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3761 @item -dL
3762 @itemx -fdump-rtl-loop
3763 @itemx -fdump-rtl-loop2
3764 @opindex dL
3765 @opindex fdump-rtl-loop
3766 @opindex fdump-rtl-loop2
3767 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3768 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3769 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3770 @file{@var{file}.13.loop2}.
3772 @item -dm
3773 @itemx -fdump-rtl-sms
3774 @opindex dm
3775 @opindex fdump-rtl-sms
3776 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3778 @item -dM
3779 @itemx -fdump-rtl-mach
3780 @opindex dM
3781 @opindex fdump-rtl-mach
3782 Dump after performing the machine dependent reorganization pass, to
3783 @file{@var{file}.35.mach}.
3785 @item -dn
3786 @itemx -fdump-rtl-rnreg
3787 @opindex dn
3788 @opindex fdump-rtl-rnreg
3789 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3791 @item -dN
3792 @itemx -fdump-rtl-regmove
3793 @opindex dN
3794 @opindex fdump-rtl-regmove
3795 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3797 @item -do
3798 @itemx -fdump-rtl-postreload
3799 @opindex do
3800 @opindex fdump-rtl-postreload
3801 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3803 @item -dr
3804 @itemx -fdump-rtl-expand
3805 @opindex dr
3806 @opindex fdump-rtl-expand
3807 Dump after RTL generation, to @file{@var{file}.00.expand}.
3809 @item -dR
3810 @itemx -fdump-rtl-sched2
3811 @opindex dR
3812 @opindex fdump-rtl-sched2
3813 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3815 @item -ds
3816 @itemx -fdump-rtl-cse
3817 @opindex ds
3818 @opindex fdump-rtl-cse
3819 Dump after CSE (including the jump optimization that sometimes follows
3820 CSE), to @file{@var{file}.04.cse}.
3822 @item -dS
3823 @itemx -fdump-rtl-sched
3824 @opindex dS
3825 @opindex fdump-rtl-sched
3826 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3828 @item -dt
3829 @itemx -fdump-rtl-cse2
3830 @opindex dt
3831 @opindex fdump-rtl-cse2
3832 Dump after the second CSE pass (including the jump optimization that
3833 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3835 @item -dT
3836 @itemx -fdump-rtl-tracer
3837 @opindex dT
3838 @opindex fdump-rtl-tracer
3839 Dump after running tracer, to @file{@var{file}.12.tracer}.
3841 @item -dV
3842 @itemx -fdump-rtl-vpt
3843 @itemx -fdump-rtl-vartrack
3844 @opindex dV
3845 @opindex fdump-rtl-vpt
3846 @opindex fdump-rtl-vartrack
3847 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3848 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3849 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3850 to @file{@var{file}.34.vartrack}.
3852 @item -dw
3853 @itemx -fdump-rtl-flow2
3854 @opindex dw
3855 @opindex fdump-rtl-flow2
3856 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3858 @item -dz
3859 @itemx -fdump-rtl-peephole2
3860 @opindex dz
3861 @opindex fdump-rtl-peephole2
3862 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3864 @item -dZ
3865 @itemx -fdump-rtl-web
3866 @opindex dZ
3867 @opindex fdump-rtl-web
3868 Dump after live range splitting, to @file{@var{file}.14.web}.
3870 @item -da
3871 @itemx -fdump-rtl-all
3872 @opindex da
3873 @opindex fdump-rtl-all
3874 Produce all the dumps listed above.
3876 @item -dH
3877 @opindex dH
3878 Produce a core dump whenever an error occurs.
3880 @item -dm
3881 @opindex dm
3882 Print statistics on memory usage, at the end of the run, to
3883 standard error.
3885 @item -dp
3886 @opindex dp
3887 Annotate the assembler output with a comment indicating which
3888 pattern and alternative was used.  The length of each instruction is
3889 also printed.
3891 @item -dP
3892 @opindex dP
3893 Dump the RTL in the assembler output as a comment before each instruction.
3894 Also turns on @option{-dp} annotation.
3896 @item -dv
3897 @opindex dv
3898 For each of the other indicated dump files (either with @option{-d} or
3899 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3900 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3902 @item -dx
3903 @opindex dx
3904 Just generate RTL for a function instead of compiling it.  Usually used
3905 with @samp{r} (@option{-fdump-rtl-expand}).
3907 @item -dy
3908 @opindex dy
3909 Dump debugging information during parsing, to standard error.
3910 @end table
3912 @item -fdump-unnumbered
3913 @opindex fdump-unnumbered
3914 When doing debugging dumps (see @option{-d} option above), suppress instruction
3915 numbers and line number note output.  This makes it more feasible to
3916 use diff on debugging dumps for compiler invocations with different
3917 options, in particular with and without @option{-g}.
3919 @item -fdump-translation-unit @r{(C++ only)}
3920 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3921 @opindex fdump-translation-unit
3922 Dump a representation of the tree structure for the entire translation
3923 unit to a file.  The file name is made by appending @file{.tu} to the
3924 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3925 controls the details of the dump as described for the
3926 @option{-fdump-tree} options.
3928 @item -fdump-class-hierarchy @r{(C++ only)}
3929 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3930 @opindex fdump-class-hierarchy
3931 Dump a representation of each class's hierarchy and virtual function
3932 table layout to a file.  The file name is made by appending @file{.class}
3933 to the source file name.  If the @samp{-@var{options}} form is used,
3934 @var{options} controls the details of the dump as described for the
3935 @option{-fdump-tree} options.
3937 @item -fdump-ipa-@var{switch}
3938 @opindex fdump-ipa
3939 Control the dumping at various stages of inter-procedural analysis
3940 language tree to a file.  The file name is generated by appending a switch
3941 specific suffix to the source file name.  The following dumps are possible:
3943 @table @samp
3944 @item all
3945 Enables all inter-procedural analysis dumps; currently the only produced
3946 dump is the @samp{cgraph} dump.
3948 @item cgraph
3949 Dumps information about call-graph optimization, unused function removal,
3950 and inlining decisions.
3951 @end table
3953 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3954 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3955 @opindex fdump-tree
3956 Control the dumping at various stages of processing the intermediate
3957 language tree to a file.  The file name is generated by appending a switch
3958 specific suffix to the source file name.  If the @samp{-@var{options}}
3959 form is used, @var{options} is a list of @samp{-} separated options that
3960 control the details of the dump.  Not all options are applicable to all
3961 dumps, those which are not meaningful will be ignored.  The following
3962 options are available
3964 @table @samp
3965 @item address
3966 Print the address of each node.  Usually this is not meaningful as it
3967 changes according to the environment and source file.  Its primary use
3968 is for tying up a dump file with a debug environment.
3969 @item slim
3970 Inhibit dumping of members of a scope or body of a function merely
3971 because that scope has been reached.  Only dump such items when they
3972 are directly reachable by some other path.  When dumping pretty-printed
3973 trees, this option inhibits dumping the bodies of control structures.
3974 @item raw
3975 Print a raw representation of the tree.  By default, trees are
3976 pretty-printed into a C-like representation.
3977 @item details
3978 Enable more detailed dumps (not honored by every dump option).
3979 @item stats
3980 Enable dumping various statistics about the pass (not honored by every dump
3981 option).
3982 @item blocks
3983 Enable showing basic block boundaries (disabled in raw dumps).
3984 @item vops
3985 Enable showing virtual operands for every statement.
3986 @item lineno
3987 Enable showing line numbers for statements.
3988 @item uid
3989 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3990 @item all
3991 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3992 @end table
3994 The following tree dumps are possible:
3995 @table @samp
3997 @item original
3998 Dump before any tree based optimization, to @file{@var{file}.original}.
4000 @item optimized
4001 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4003 @item inlined
4004 Dump after function inlining, to @file{@var{file}.inlined}.
4006 @item gimple
4007 @opindex fdump-tree-gimple
4008 Dump each function before and after the gimplification pass to a file.  The
4009 file name is made by appending @file{.gimple} to the source file name.
4011 @item cfg
4012 @opindex fdump-tree-cfg
4013 Dump the control flow graph of each function to a file.  The file name is
4014 made by appending @file{.cfg} to the source file name.
4016 @item vcg
4017 @opindex fdump-tree-vcg
4018 Dump the control flow graph of each function to a file in VCG format.  The
4019 file name is made by appending @file{.vcg} to the source file name.  Note
4020 that if the file contains more than one function, the generated file cannot
4021 be used directly by VCG@.  You will need to cut and paste each function's
4022 graph into its own separate file first.
4024 @item ch
4025 @opindex fdump-tree-ch
4026 Dump each function after copying loop headers.  The file name is made by
4027 appending @file{.ch} to the source file name.
4029 @item ssa
4030 @opindex fdump-tree-ssa
4031 Dump SSA related information to a file.  The file name is made by appending
4032 @file{.ssa} to the source file name.
4034 @item salias
4035 @opindex fdump-tree-salias
4036 Dump structure aliasing variable information to a file.  This file name
4037 is made by appending @file{.salias} to the source file name.
4039 @item alias
4040 @opindex fdump-tree-alias
4041 Dump aliasing information for each function.  The file name is made by
4042 appending @file{.alias} to the source file name.
4044 @item ccp
4045 @opindex fdump-tree-ccp
4046 Dump each function after CCP@.  The file name is made by appending
4047 @file{.ccp} to the source file name.
4049 @item storeccp
4050 @opindex fdump-tree-storeccp
4051 Dump each function after STORE-CCP.  The file name is made by appending
4052 @file{.storeccp} to the source file name.
4054 @item pre
4055 @opindex fdump-tree-pre
4056 Dump trees after partial redundancy elimination.  The file name is made
4057 by appending @file{.pre} to the source file name.
4059 @item fre
4060 @opindex fdump-tree-fre
4061 Dump trees after full redundancy elimination.  The file name is made
4062 by appending @file{.fre} to the source file name.
4064 @item copyprop
4065 @opindex fdump-tree-copyprop
4066 Dump trees after copy propagation.  The file name is made
4067 by appending @file{.copyprop} to the source file name.
4069 @item store_copyprop
4070 @opindex fdump-tree-store_copyprop
4071 Dump trees after store copy-propagation.  The file name is made
4072 by appending @file{.store_copyprop} to the source file name.
4074 @item dce
4075 @opindex fdump-tree-dce
4076 Dump each function after dead code elimination.  The file name is made by
4077 appending @file{.dce} to the source file name.
4079 @item mudflap
4080 @opindex fdump-tree-mudflap
4081 Dump each function after adding mudflap instrumentation.  The file name is
4082 made by appending @file{.mudflap} to the source file name.
4084 @item sra
4085 @opindex fdump-tree-sra
4086 Dump each function after performing scalar replacement of aggregates.  The
4087 file name is made by appending @file{.sra} to the source file name.
4089 @item sink
4090 @opindex fdump-tree-sink
4091 Dump each function after performing code sinking.  The file name is made
4092 by appending @file{.sink} to the source file name. 
4094 @item dom
4095 @opindex fdump-tree-dom
4096 Dump each function after applying dominator tree optimizations.  The file
4097 name is made by appending @file{.dom} to the source file name.
4099 @item dse
4100 @opindex fdump-tree-dse
4101 Dump each function after applying dead store elimination.  The file
4102 name is made by appending @file{.dse} to the source file name.
4104 @item phiopt
4105 @opindex fdump-tree-phiopt
4106 Dump each function after optimizing PHI nodes into straightline code.  The file
4107 name is made by appending @file{.phiopt} to the source file name.
4109 @item forwprop
4110 @opindex fdump-tree-forwprop
4111 Dump each function after forward propagating single use variables.  The file
4112 name is made by appending @file{.forwprop} to the source file name.
4114 @item copyrename
4115 @opindex fdump-tree-copyrename
4116 Dump each function after applying the copy rename optimization.  The file
4117 name is made by appending @file{.copyrename} to the source file name.
4119 @item nrv
4120 @opindex fdump-tree-nrv
4121 Dump each function after applying the named return value optimization on
4122 generic trees.  The file name is made by appending @file{.nrv} to the source
4123 file name.
4125 @item vect
4126 @opindex fdump-tree-vect
4127 Dump each function after applying vectorization of loops.  The file name is
4128 made by appending @file{.vect} to the source file name.
4130 @item vrp
4131 @opindex fdump-tree-vrp
4132 Dump each function after Value Range Propagation (VRP).  The file name
4133 is made by appending @file{.vrp} to the source file name.
4135 @item all
4136 @opindex fdump-tree-all
4137 Enable all the available tree dumps with the flags provided in this option.
4138 @end table
4140 @item -ftree-vectorizer-verbose=@var{n}
4141 @opindex ftree-vectorizer-verbose
4142 This option controls the amount of debugging output the vectorizer prints.
4143 This information is written to standard error, unless @option{-fdump-tree-all}
4144 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4145 usual dump listing file, @file{.vect}.
4147 @item -frandom-seed=@var{string}
4148 @opindex frandom-string
4149 This option provides a seed that GCC uses when it would otherwise use
4150 random numbers.  It is used to generate certain symbol names
4151 that have to be different in every compiled file.  It is also used to
4152 place unique stamps in coverage data files and the object files that
4153 produce them.  You can use the @option{-frandom-seed} option to produce
4154 reproducibly identical object files.
4156 The @var{string} should be different for every file you compile.
4158 @item -fsched-verbose=@var{n}
4159 @opindex fsched-verbose
4160 On targets that use instruction scheduling, this option controls the
4161 amount of debugging output the scheduler prints.  This information is
4162 written to standard error, unless @option{-dS} or @option{-dR} is
4163 specified, in which case it is output to the usual dump
4164 listing file, @file{.sched} or @file{.sched2} respectively.  However
4165 for @var{n} greater than nine, the output is always printed to standard
4166 error.
4168 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4169 same information as @option{-dRS}.  For @var{n} greater than one, it
4170 also output basic block probabilities, detailed ready list information
4171 and unit/insn info.  For @var{n} greater than two, it includes RTL
4172 at abort point, control-flow and regions info.  And for @var{n} over
4173 four, @option{-fsched-verbose} also includes dependence info.
4175 @item -save-temps
4176 @opindex save-temps
4177 Store the usual ``temporary'' intermediate files permanently; place them
4178 in the current directory and name them based on the source file.  Thus,
4179 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4180 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4181 preprocessed @file{foo.i} output file even though the compiler now
4182 normally uses an integrated preprocessor.
4184 When used in combination with the @option{-x} command line option,
4185 @option{-save-temps} is sensible enough to avoid over writing an
4186 input source file with the same extension as an intermediate file.
4187 The corresponding intermediate file may be obtained by renaming the
4188 source file before using @option{-save-temps}.
4190 @item -time
4191 @opindex time
4192 Report the CPU time taken by each subprocess in the compilation
4193 sequence.  For C source files, this is the compiler proper and assembler
4194 (plus the linker if linking is done).  The output looks like this:
4196 @smallexample
4197 # cc1 0.12 0.01
4198 # as 0.00 0.01
4199 @end smallexample
4201 The first number on each line is the ``user time'', that is time spent
4202 executing the program itself.  The second number is ``system time'',
4203 time spent executing operating system routines on behalf of the program.
4204 Both numbers are in seconds.
4206 @item -fvar-tracking
4207 @opindex fvar-tracking
4208 Run variable tracking pass.  It computes where variables are stored at each
4209 position in code.  Better debugging information is then generated
4210 (if the debugging information format supports this information).
4212 It is enabled by default when compiling with optimization (@option{-Os},
4213 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4214 the debug info format supports it.
4216 @item -print-file-name=@var{library}
4217 @opindex print-file-name
4218 Print the full absolute name of the library file @var{library} that
4219 would be used when linking---and don't do anything else.  With this
4220 option, GCC does not compile or link anything; it just prints the
4221 file name.
4223 @item -print-multi-directory
4224 @opindex print-multi-directory
4225 Print the directory name corresponding to the multilib selected by any
4226 other switches present in the command line.  This directory is supposed
4227 to exist in @env{GCC_EXEC_PREFIX}.
4229 @item -print-multi-lib
4230 @opindex print-multi-lib
4231 Print the mapping from multilib directory names to compiler switches
4232 that enable them.  The directory name is separated from the switches by
4233 @samp{;}, and each switch starts with an @samp{@@} instead of the
4234 @samp{-}, without spaces between multiple switches.  This is supposed to
4235 ease shell-processing.
4237 @item -print-prog-name=@var{program}
4238 @opindex print-prog-name
4239 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4241 @item -print-libgcc-file-name
4242 @opindex print-libgcc-file-name
4243 Same as @option{-print-file-name=libgcc.a}.
4245 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4246 but you do want to link with @file{libgcc.a}.  You can do
4248 @smallexample
4249 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4250 @end smallexample
4252 @item -print-search-dirs
4253 @opindex print-search-dirs
4254 Print the name of the configured installation directory and a list of
4255 program and library directories @command{gcc} will search---and don't do anything else.
4257 This is useful when @command{gcc} prints the error message
4258 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4259 To resolve this you either need to put @file{cpp0} and the other compiler
4260 components where @command{gcc} expects to find them, or you can set the environment
4261 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4262 Don't forget the trailing @samp{/}.
4263 @xref{Environment Variables}.
4265 @item -dumpmachine
4266 @opindex dumpmachine
4267 Print the compiler's target machine (for example,
4268 @samp{i686-pc-linux-gnu})---and don't do anything else.
4270 @item -dumpversion
4271 @opindex dumpversion
4272 Print the compiler version (for example, @samp{3.0})---and don't do
4273 anything else.
4275 @item -dumpspecs
4276 @opindex dumpspecs
4277 Print the compiler's built-in specs---and don't do anything else.  (This
4278 is used when GCC itself is being built.)  @xref{Spec Files}.
4280 @item -feliminate-unused-debug-types
4281 @opindex feliminate-unused-debug-types
4282 Normally, when producing DWARF2 output, GCC will emit debugging
4283 information for all types declared in a compilation
4284 unit, regardless of whether or not they are actually used
4285 in that compilation unit.  Sometimes this is useful, such as
4286 if, in the debugger, you want to cast a value to a type that is
4287 not actually used in your program (but is declared).  More often,
4288 however, this results in a significant amount of wasted space.
4289 With this option, GCC will avoid producing debug symbol output
4290 for types that are nowhere used in the source file being compiled.
4291 @end table
4293 @node Optimize Options
4294 @section Options That Control Optimization
4295 @cindex optimize options
4296 @cindex options, optimization
4298 These options control various sorts of optimizations.
4300 Without any optimization option, the compiler's goal is to reduce the
4301 cost of compilation and to make debugging produce the expected
4302 results.  Statements are independent: if you stop the program with a
4303 breakpoint between statements, you can then assign a new value to any
4304 variable or change the program counter to any other statement in the
4305 function and get exactly the results you would expect from the source
4306 code.
4308 Turning on optimization flags makes the compiler attempt to improve
4309 the performance and/or code size at the expense of compilation time
4310 and possibly the ability to debug the program.
4312 The compiler performs optimization based on the knowledge it has of
4313 the program.  Optimization levels @option{-O2} and above, in
4314 particular, enable @emph{unit-at-a-time} mode, which allows the
4315 compiler to consider information gained from later functions in
4316 the file when compiling a function.  Compiling multiple files at
4317 once to a single output file in @emph{unit-at-a-time} mode allows
4318 the compiler to use information gained from all of the files when
4319 compiling each of them.
4321 Not all optimizations are controlled directly by a flag.  Only
4322 optimizations that have a flag are listed.
4324 @table @gcctabopt
4325 @item -O
4326 @itemx -O1
4327 @opindex O
4328 @opindex O1
4329 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4330 more memory for a large function.
4332 With @option{-O}, the compiler tries to reduce code size and execution
4333 time, without performing any optimizations that take a great deal of
4334 compilation time.
4336 @option{-O} turns on the following optimization flags:
4337 @gccoptlist{-fdefer-pop @gol
4338 -fdelayed-branch @gol
4339 -fguess-branch-probability @gol
4340 -fcprop-registers @gol
4341 -floop-optimize @gol
4342 -fif-conversion @gol
4343 -fif-conversion2 @gol
4344 -ftree-ccp @gol
4345 -ftree-dce @gol
4346 -ftree-dominator-opts @gol
4347 -ftree-dse @gol
4348 -ftree-ter @gol
4349 -ftree-lrs @gol
4350 -ftree-sra @gol
4351 -ftree-copyrename @gol
4352 -ftree-fre @gol
4353 -ftree-ch @gol
4354 -fmerge-constants}
4356 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4357 where doing so does not interfere with debugging.
4359 @item -O2
4360 @opindex O2
4361 Optimize even more.  GCC performs nearly all supported optimizations
4362 that do not involve a space-speed tradeoff.  The compiler does not
4363 perform loop unrolling or function inlining when you specify @option{-O2}.
4364 As compared to @option{-O}, this option increases both compilation time
4365 and the performance of the generated code.
4367 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4368 also turns on the following optimization flags:
4369 @gccoptlist{-fthread-jumps @gol
4370 -fcrossjumping @gol
4371 -foptimize-sibling-calls @gol
4372 -fcse-follow-jumps  -fcse-skip-blocks @gol
4373 -fgcse  -fgcse-lm  @gol
4374 -fexpensive-optimizations @gol
4375 -fstrength-reduce @gol
4376 -frerun-cse-after-loop  -frerun-loop-opt @gol
4377 -fcaller-saves @gol
4378 -fpeephole2 @gol
4379 -fschedule-insns  -fschedule-insns2 @gol
4380 -fsched-interblock  -fsched-spec @gol
4381 -fregmove @gol
4382 -fstrict-aliasing @gol
4383 -fdelete-null-pointer-checks @gol
4384 -freorder-blocks  -freorder-functions @gol
4385 -funit-at-a-time @gol
4386 -falign-functions  -falign-jumps @gol
4387 -falign-loops  -falign-labels @gol
4388 -ftree-vrp @gol
4389 -ftree-pre}
4391 Please note the warning under @option{-fgcse} about
4392 invoking @option{-O2} on programs that use computed gotos.
4394 @item -O3
4395 @opindex O3
4396 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4397 @option{-O2} and also turns on the @option{-finline-functions},
4398 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4400 @item -O0
4401 @opindex O0
4402 Do not optimize.  This is the default.
4404 @item -Os
4405 @opindex Os
4406 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4407 do not typically increase code size.  It also performs further
4408 optimizations designed to reduce code size.
4410 @option{-Os} disables the following optimization flags:
4411 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4412 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4413 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4415 If you use multiple @option{-O} options, with or without level numbers,
4416 the last such option is the one that is effective.
4417 @end table
4419 Options of the form @option{-f@var{flag}} specify machine-independent
4420 flags.  Most flags have both positive and negative forms; the negative
4421 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4422 below, only one of the forms is listed---the one you typically will
4423 use.  You can figure out the other form by either removing @samp{no-}
4424 or adding it.
4426 The following options control specific optimizations.  They are either
4427 activated by @option{-O} options or are related to ones that are.  You
4428 can use the following flags in the rare cases when ``fine-tuning'' of
4429 optimizations to be performed is desired.
4431 @table @gcctabopt
4432 @item -fno-default-inline
4433 @opindex fno-default-inline
4434 Do not make member functions inline by default merely because they are
4435 defined inside the class scope (C++ only).  Otherwise, when you specify
4436 @w{@option{-O}}, member functions defined inside class scope are compiled
4437 inline by default; i.e., you don't need to add @samp{inline} in front of
4438 the member function name.
4440 @item -fno-defer-pop
4441 @opindex fno-defer-pop
4442 Always pop the arguments to each function call as soon as that function
4443 returns.  For machines which must pop arguments after a function call,
4444 the compiler normally lets arguments accumulate on the stack for several
4445 function calls and pops them all at once.
4447 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4449 @item -fforce-mem
4450 @opindex fforce-mem
4451 Force memory operands to be copied into registers before doing
4452 arithmetic on them.  This produces better code by making all memory
4453 references potential common subexpressions.  When they are not common
4454 subexpressions, instruction combination should eliminate the separate
4455 register-load. This option is now a nop and will be removed in 4.2.
4457 @item -fforce-addr
4458 @opindex fforce-addr
4459 Force memory address constants to be copied into registers before
4460 doing arithmetic on them.
4462 @item -fomit-frame-pointer
4463 @opindex fomit-frame-pointer
4464 Don't keep the frame pointer in a register for functions that
4465 don't need one.  This avoids the instructions to save, set up and
4466 restore frame pointers; it also makes an extra register available
4467 in many functions.  @strong{It also makes debugging impossible on
4468 some machines.}
4470 On some machines, such as the VAX, this flag has no effect, because
4471 the standard calling sequence automatically handles the frame pointer
4472 and nothing is saved by pretending it doesn't exist.  The
4473 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4474 whether a target machine supports this flag.  @xref{Registers,,Register
4475 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4477 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4479 @item -foptimize-sibling-calls
4480 @opindex foptimize-sibling-calls
4481 Optimize sibling and tail recursive calls.
4483 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4485 @item -fno-inline
4486 @opindex fno-inline
4487 Don't pay attention to the @code{inline} keyword.  Normally this option
4488 is used to keep the compiler from expanding any functions inline.
4489 Note that if you are not optimizing, no functions can be expanded inline.
4491 @item -finline-functions
4492 @opindex finline-functions
4493 Integrate all simple functions into their callers.  The compiler
4494 heuristically decides which functions are simple enough to be worth
4495 integrating in this way.
4497 If all calls to a given function are integrated, and the function is
4498 declared @code{static}, then the function is normally not output as
4499 assembler code in its own right.
4501 Enabled at level @option{-O3}.
4503 @item -finline-functions-called-once
4504 @opindex finline-functions-called-once
4505 Consider all @code{static} functions called once for inlining into their
4506 caller even if they are not marked @code{inline}.  If a call to a given
4507 function is integrated, then the function is not output as assembler code
4508 in its own right.
4510 Enabled if @option{-funit-at-a-time} is enabled.
4512 @item -fearly-inlining
4513 @opindex fearly-inlining
4514 Inline functions marked by @code{always_inline} and functions whose body seems
4515 smaller than the function call overhead early before doing
4516 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4517 makes profiling significantly cheaper and usually inlining faster on programs
4518 having large chains of nested wrapper functions.
4520 Enabled by default.
4522 @item -finline-limit=@var{n}
4523 @opindex finline-limit
4524 By default, GCC limits the size of functions that can be inlined.  This flag
4525 allows the control of this limit for functions that are explicitly marked as
4526 inline (i.e., marked with the inline keyword or defined within the class
4527 definition in c++).  @var{n} is the size of functions that can be inlined in
4528 number of pseudo instructions (not counting parameter handling).  The default
4529 value of @var{n} is 600.
4530 Increasing this value can result in more inlined code at
4531 the cost of compilation time and memory consumption.  Decreasing usually makes
4532 the compilation faster and less code will be inlined (which presumably
4533 means slower programs).  This option is particularly useful for programs that
4534 use inlining heavily such as those based on recursive templates with C++.
4536 Inlining is actually controlled by a number of parameters, which may be
4537 specified individually by using @option{--param @var{name}=@var{value}}.
4538 The @option{-finline-limit=@var{n}} option sets some of these parameters
4539 as follows:
4541 @table @gcctabopt
4542  @item max-inline-insns-single
4543   is set to @var{n}/2.
4544  @item max-inline-insns-auto
4545   is set to @var{n}/2.
4546  @item min-inline-insns
4547   is set to 130 or @var{n}/4, whichever is smaller.
4548  @item max-inline-insns-rtl
4549   is set to @var{n}.
4550 @end table
4552 See below for a documentation of the individual
4553 parameters controlling inlining.
4555 @emph{Note:} pseudo instruction represents, in this particular context, an
4556 abstract measurement of function's size.  In no way does it represent a count
4557 of assembly instructions and as such its exact meaning might change from one
4558 release to an another.
4560 @item -fkeep-inline-functions
4561 @opindex fkeep-inline-functions
4562 In C, emit @code{static} functions that are declared @code{inline}
4563 into the object file, even if the function has been inlined into all
4564 of its callers.  This switch does not affect functions using the
4565 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4566 inline functions into the object file.
4568 @item -fkeep-static-consts
4569 @opindex fkeep-static-consts
4570 Emit variables declared @code{static const} when optimization isn't turned
4571 on, even if the variables aren't referenced.
4573 GCC enables this option by default.  If you want to force the compiler to
4574 check if the variable was referenced, regardless of whether or not
4575 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4577 @item -fmerge-constants
4578 Attempt to merge identical constants (string constants and floating point
4579 constants) across compilation units.
4581 This option is the default for optimized compilation if the assembler and
4582 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4583 behavior.
4585 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4587 @item -fmerge-all-constants
4588 Attempt to merge identical constants and identical variables.
4590 This option implies @option{-fmerge-constants}.  In addition to
4591 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4592 arrays or initialized constant variables with integral or floating point
4593 types.  Languages like C or C++ require each non-automatic variable to
4594 have distinct location, so using this option will result in non-conforming
4595 behavior.
4597 @item -fmodulo-sched
4598 @opindex fmodulo-sched
4599 Perform swing modulo scheduling immediately before the first scheduling
4600 pass.  This pass looks at innermost loops and reorders their
4601 instructions by overlapping different iterations.
4603 @item -fno-branch-count-reg
4604 @opindex fno-branch-count-reg
4605 Do not use ``decrement and branch'' instructions on a count register,
4606 but instead generate a sequence of instructions that decrement a
4607 register, compare it against zero, then branch based upon the result.
4608 This option is only meaningful on architectures that support such
4609 instructions, which include x86, PowerPC, IA-64 and S/390.
4611 The default is @option{-fbranch-count-reg}, enabled when
4612 @option{-fstrength-reduce} is enabled.
4614 @item -fno-function-cse
4615 @opindex fno-function-cse
4616 Do not put function addresses in registers; make each instruction that
4617 calls a constant function contain the function's address explicitly.
4619 This option results in less efficient code, but some strange hacks
4620 that alter the assembler output may be confused by the optimizations
4621 performed when this option is not used.
4623 The default is @option{-ffunction-cse}
4625 @item -fno-zero-initialized-in-bss
4626 @opindex fno-zero-initialized-in-bss
4627 If the target supports a BSS section, GCC by default puts variables that
4628 are initialized to zero into BSS@.  This can save space in the resulting
4629 code.
4631 This option turns off this behavior because some programs explicitly
4632 rely on variables going to the data section.  E.g., so that the
4633 resulting executable can find the beginning of that section and/or make
4634 assumptions based on that.
4636 The default is @option{-fzero-initialized-in-bss}.
4638 @item -fbounds-check
4639 @opindex fbounds-check
4640 For front-ends that support it, generate additional code to check that
4641 indices used to access arrays are within the declared range.  This is
4642 currently only supported by the Java and Fortran front-ends, where
4643 this option defaults to true and false respectively.
4645 @item -fmudflap -fmudflapth -fmudflapir
4646 @opindex fmudflap
4647 @opindex fmudflapth
4648 @opindex fmudflapir
4649 @cindex bounds checking
4650 @cindex mudflap
4651 For front-ends that support it (C and C++), instrument all risky
4652 pointer/array dereferencing operations, some standard library
4653 string/heap functions, and some other associated constructs with
4654 range/validity tests.  Modules so instrumented should be immune to
4655 buffer overflows, invalid heap use, and some other classes of C/C++
4656 programming errors.  The instrumentation relies on a separate runtime
4657 library (@file{libmudflap}), which will be linked into a program if
4658 @option{-fmudflap} is given at link time.  Run-time behavior of the
4659 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4660 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4661 for its options.
4663 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4664 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4665 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4666 instrumentation should ignore pointer reads.  This produces less
4667 instrumentation (and therefore faster execution) and still provides
4668 some protection against outright memory corrupting writes, but allows
4669 erroneously read data to propagate within a program.
4671 @item -fstrength-reduce
4672 @opindex fstrength-reduce
4673 Perform the optimizations of loop strength reduction and
4674 elimination of iteration variables.
4676 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4678 @item -fthread-jumps
4679 @opindex fthread-jumps
4680 Perform optimizations where we check to see if a jump branches to a
4681 location where another comparison subsumed by the first is found.  If
4682 so, the first branch is redirected to either the destination of the
4683 second branch or a point immediately following it, depending on whether
4684 the condition is known to be true or false.
4686 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4688 @item -fcse-follow-jumps
4689 @opindex fcse-follow-jumps
4690 In common subexpression elimination, scan through jump instructions
4691 when the target of the jump is not reached by any other path.  For
4692 example, when CSE encounters an @code{if} statement with an
4693 @code{else} clause, CSE will follow the jump when the condition
4694 tested is false.
4696 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4698 @item -fcse-skip-blocks
4699 @opindex fcse-skip-blocks
4700 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4701 follow jumps which conditionally skip over blocks.  When CSE
4702 encounters a simple @code{if} statement with no else clause,
4703 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4704 body of the @code{if}.
4706 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4708 @item -frerun-cse-after-loop
4709 @opindex frerun-cse-after-loop
4710 Re-run common subexpression elimination after loop optimizations has been
4711 performed.
4713 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4715 @item -frerun-loop-opt
4716 @opindex frerun-loop-opt
4717 Run the loop optimizer twice.
4719 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4721 @item -fgcse
4722 @opindex fgcse
4723 Perform a global common subexpression elimination pass.
4724 This pass also performs global constant and copy propagation.
4726 @emph{Note:} When compiling a program using computed gotos, a GCC
4727 extension, you may get better runtime performance if you disable
4728 the global common subexpression elimination pass by adding
4729 @option{-fno-gcse} to the command line.
4731 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4733 @item -fgcse-lm
4734 @opindex fgcse-lm
4735 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4736 attempt to move loads which are only killed by stores into themselves.  This
4737 allows a loop containing a load/store sequence to be changed to a load outside
4738 the loop, and a copy/store within the loop.
4740 Enabled by default when gcse is enabled.
4742 @item -fgcse-sm
4743 @opindex fgcse-sm
4744 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4745 global common subexpression elimination.  This pass will attempt to move
4746 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4747 loops containing a load/store sequence can be changed to a load before
4748 the loop and a store after the loop.
4750 Not enabled at any optimization level.
4752 @item -fgcse-las
4753 @opindex fgcse-las
4754 When @option{-fgcse-las} is enabled, the global common subexpression
4755 elimination pass eliminates redundant loads that come after stores to the
4756 same memory location (both partial and full redundancies).
4758 Not enabled at any optimization level.
4760 @item -fgcse-after-reload
4761 @opindex fgcse-after-reload
4762 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4763 pass is performed after reload.  The purpose of this pass is to cleanup
4764 redundant spilling.
4766 @item -floop-optimize
4767 @opindex floop-optimize
4768 Perform loop optimizations: move constant expressions out of loops, simplify
4769 exit test conditions and optionally do strength-reduction as well.
4771 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4773 @item -floop-optimize2
4774 @opindex floop-optimize2
4775 Perform loop optimizations using the new loop optimizer.  The optimizations
4776 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4777 by separate flags.
4779 @item -funsafe-loop-optimizations
4780 @opindex funsafe-loop-optimizations
4781 If given, the loop optimizer will assume that loop indices do not
4782 overflow, and that the loops with nontrivial exit condition are not
4783 infinite.  This enables a wider range of loop optimizations even if
4784 the loop optimizer itself cannot prove that these assumptions are valid.
4785 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4786 if it finds this kind of loop.
4788 @item -fcrossjumping
4789 @opindex crossjumping
4790 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4791 resulting code may or may not perform better than without cross-jumping.
4793 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4795 @item -fif-conversion
4796 @opindex if-conversion
4797 Attempt to transform conditional jumps into branch-less equivalents.  This
4798 include use of conditional moves, min, max, set flags and abs instructions, and
4799 some tricks doable by standard arithmetics.  The use of conditional execution
4800 on chips where it is available is controlled by @code{if-conversion2}.
4802 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4804 @item -fif-conversion2
4805 @opindex if-conversion2
4806 Use conditional execution (where available) to transform conditional jumps into
4807 branch-less equivalents.
4809 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4811 @item -fdelete-null-pointer-checks
4812 @opindex fdelete-null-pointer-checks
4813 Use global dataflow analysis to identify and eliminate useless checks
4814 for null pointers.  The compiler assumes that dereferencing a null
4815 pointer would have halted the program.  If a pointer is checked after
4816 it has already been dereferenced, it cannot be null.
4818 In some environments, this assumption is not true, and programs can
4819 safely dereference null pointers.  Use
4820 @option{-fno-delete-null-pointer-checks} to disable this optimization
4821 for programs which depend on that behavior.
4823 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4825 @item -fexpensive-optimizations
4826 @opindex fexpensive-optimizations
4827 Perform a number of minor optimizations that are relatively expensive.
4829 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4831 @item -foptimize-register-move
4832 @itemx -fregmove
4833 @opindex foptimize-register-move
4834 @opindex fregmove
4835 Attempt to reassign register numbers in move instructions and as
4836 operands of other simple instructions in order to maximize the amount of
4837 register tying.  This is especially helpful on machines with two-operand
4838 instructions.
4840 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4841 optimization.
4843 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4845 @item -fdelayed-branch
4846 @opindex fdelayed-branch
4847 If supported for the target machine, attempt to reorder instructions
4848 to exploit instruction slots available after delayed branch
4849 instructions.
4851 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4853 @item -fschedule-insns
4854 @opindex fschedule-insns
4855 If supported for the target machine, attempt to reorder instructions to
4856 eliminate execution stalls due to required data being unavailable.  This
4857 helps machines that have slow floating point or memory load instructions
4858 by allowing other instructions to be issued until the result of the load
4859 or floating point instruction is required.
4861 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4863 @item -fschedule-insns2
4864 @opindex fschedule-insns2
4865 Similar to @option{-fschedule-insns}, but requests an additional pass of
4866 instruction scheduling after register allocation has been done.  This is
4867 especially useful on machines with a relatively small number of
4868 registers and where memory load instructions take more than one cycle.
4870 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4872 @item -fno-sched-interblock
4873 @opindex fno-sched-interblock
4874 Don't schedule instructions across basic blocks.  This is normally
4875 enabled by default when scheduling before register allocation, i.e.@:
4876 with @option{-fschedule-insns} or at @option{-O2} or higher.
4878 @item -fno-sched-spec
4879 @opindex fno-sched-spec
4880 Don't allow speculative motion of non-load instructions.  This is normally
4881 enabled by default when scheduling before register allocation, i.e.@:
4882 with @option{-fschedule-insns} or at @option{-O2} or higher.
4884 @item -fsched-spec-load
4885 @opindex fsched-spec-load
4886 Allow speculative motion of some load instructions.  This only makes
4887 sense when scheduling before register allocation, i.e.@: with
4888 @option{-fschedule-insns} or at @option{-O2} or higher.
4890 @item -fsched-spec-load-dangerous
4891 @opindex fsched-spec-load-dangerous
4892 Allow speculative motion of more load instructions.  This only makes
4893 sense when scheduling before register allocation, i.e.@: with
4894 @option{-fschedule-insns} or at @option{-O2} or higher.
4896 @item -fsched-stalled-insns=@var{n}
4897 @opindex fsched-stalled-insns
4898 Define how many insns (if any) can be moved prematurely from the queue
4899 of stalled insns into the ready list, during the second scheduling pass.
4901 @item -fsched-stalled-insns-dep=@var{n}
4902 @opindex fsched-stalled-insns-dep
4903 Define how many insn groups (cycles) will be examined for a dependency
4904 on a stalled insn that is candidate for premature removal from the queue
4905 of stalled insns.  Has an effect only during the second scheduling pass,
4906 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4908 @item -fsched2-use-superblocks
4909 @opindex fsched2-use-superblocks
4910 When scheduling after register allocation, do use superblock scheduling
4911 algorithm.  Superblock scheduling allows motion across basic block boundaries
4912 resulting on faster schedules.  This option is experimental, as not all machine
4913 descriptions used by GCC model the CPU closely enough to avoid unreliable
4914 results from the algorithm.
4916 This only makes sense when scheduling after register allocation, i.e.@: with
4917 @option{-fschedule-insns2} or at @option{-O2} or higher.
4919 @item -fsched2-use-traces
4920 @opindex fsched2-use-traces
4921 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4922 allocation and additionally perform code duplication in order to increase the
4923 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4924 trace formation.
4926 This mode should produce faster but significantly longer programs.  Also
4927 without @option{-fbranch-probabilities} the traces constructed may not
4928 match the reality and hurt the performance.  This only makes
4929 sense when scheduling after register allocation, i.e.@: with
4930 @option{-fschedule-insns2} or at @option{-O2} or higher.
4932 @item -freschedule-modulo-scheduled-loops
4933 @opindex fscheduling-in-modulo-scheduled-loops
4934 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4935 we may want to prevent the later scheduling passes from changing its schedule, we use this
4936 option to control that.
4938 @item -fcaller-saves
4939 @opindex fcaller-saves
4940 Enable values to be allocated in registers that will be clobbered by
4941 function calls, by emitting extra instructions to save and restore the
4942 registers around such calls.  Such allocation is done only when it
4943 seems to result in better code than would otherwise be produced.
4945 This option is always enabled by default on certain machines, usually
4946 those which have no call-preserved registers to use instead.
4948 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4950 @item -ftree-pre
4951 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4952 enabled by default at @option{-O2} and @option{-O3}.
4954 @item -ftree-fre
4955 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4956 between FRE and PRE is that FRE only considers expressions
4957 that are computed on all paths leading to the redundant computation.
4958 This analysis faster than PRE, though it exposes fewer redundancies.
4959 This flag is enabled by default at @option{-O} and higher.
4961 @item -ftree-copy-prop
4962 Perform copy propagation on trees.  This pass eliminates unnecessary
4963 copy operations.  This flag is enabled by default at @option{-O} and
4964 higher.
4966 @item -ftree-store-copy-prop
4967 Perform copy propagation of memory loads and stores.  This pass
4968 eliminates unnecessary copy operations in memory references
4969 (structures, global variables, arrays, etc).  This flag is enabled by
4970 default at @option{-O2} and higher.
4972 @item -ftree-salias
4973 Perform structural alias analysis on trees.  This flag
4974 is enabled by default at @option{-O} and higher.
4976 @item -ftree-sink
4977 Perform forward store motion  on trees.  This flag is
4978 enabled by default at @option{-O} and higher.
4980 @item -ftree-ccp
4981 Perform sparse conditional constant propagation (CCP) on trees.  This
4982 pass only operates on local scalar variables and is enabled by default
4983 at @option{-O} and higher.
4985 @item -ftree-store-ccp
4986 Perform sparse conditional constant propagation (CCP) on trees.  This
4987 pass operates on both local scalar variables and memory stores and
4988 loads (global variables, structures, arrays, etc).  This flag is
4989 enabled by default at @option{-O2} and higher.
4991 @item -ftree-dce
4992 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4993 default at @option{-O} and higher.
4995 @item -ftree-dominator-opts
4996 Perform a variety of simple scalar cleanups (constant/copy
4997 propagation, redundancy elimination, range propagation and expression
4998 simplification) based on a dominator tree traversal.  This also
4999 performs jump threading (to reduce jumps to jumps). This flag is
5000 enabled by default at @option{-O} and higher.
5002 @item -ftree-ch
5003 Perform loop header copying on trees.  This is beneficial since it increases
5004 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5005 is enabled by default at @option{-O} and higher.  It is not enabled
5006 for @option{-Os}, since it usually increases code size.
5008 @item -ftree-loop-optimize
5009 Perform loop optimizations on trees.  This flag is enabled by default
5010 at @option{-O} and higher.
5012 @item -ftree-loop-linear
5013 Perform linear loop transformations on tree.  This flag can improve cache
5014 performance and allow further loop optimizations to take place.
5016 @item -ftree-loop-im
5017 Perform loop invariant motion on trees.  This pass moves only invariants that
5018 would be hard to handle at RTL level (function calls, operations that expand to
5019 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5020 operands of conditions that are invariant out of the loop, so that we can use
5021 just trivial invariantness analysis in loop unswitching.  The pass also includes
5022 store motion.
5024 @item -ftree-loop-ivcanon
5025 Create a canonical counter for number of iterations in the loop for that
5026 determining number of iterations requires complicated analysis.  Later
5027 optimizations then may determine the number easily.  Useful especially
5028 in connection with unrolling.
5030 @item -fivopts
5031 Perform induction variable optimizations (strength reduction, induction
5032 variable merging and induction variable elimination) on trees.
5034 @item -ftree-sra
5035 Perform scalar replacement of aggregates.  This pass replaces structure
5036 references with scalars to prevent committing structures to memory too
5037 early.  This flag is enabled by default at @option{-O} and higher.
5039 @item -ftree-copyrename
5040 Perform copy renaming on trees.  This pass attempts to rename compiler
5041 temporaries to other variables at copy locations, usually resulting in
5042 variable names which more closely resemble the original variables.  This flag
5043 is enabled by default at @option{-O} and higher.
5045 @item -ftree-ter
5046 Perform temporary expression replacement during the SSA->normal phase.  Single
5047 use/single def temporaries are replaced at their use location with their
5048 defining expression.  This results in non-GIMPLE code, but gives the expanders
5049 much more complex trees to work on resulting in better RTL generation.  This is
5050 enabled by default at @option{-O} and higher.
5052 @item -ftree-lrs
5053 Perform live range splitting during the SSA->normal phase.  Distinct live
5054 ranges of a variable are split into unique variables, allowing for better
5055 optimization later.  This is enabled by default at @option{-O} and higher.
5057 @item -ftree-vectorize
5058 Perform loop vectorization on trees.
5060 @item -ftree-vect-loop-version
5061 @opindex ftree-vect-loop-version
5062 Perform loop versioning when doing loop vectorization on trees.  When a loop
5063 appears to be vectorizable except that data alignment or data dependence cannot
5064 be determined at compile time then vectorized and non-vectorized versions of
5065 the loop are generated along with runtime checks for alignment or dependence
5066 to control which version is executed.  This option is enabled by default
5067 except at level @option{-Os} where it is disabled.
5069 @item -ftree-vrp
5070 Perform Value Range Propagation on trees.  This is similar to the
5071 constant propagation pass, but instead of values, ranges of values are
5072 propagated.  This allows the optimizers to remove unnecessary range
5073 checks like array bound checks and null pointer checks.  This is
5074 enabled by default at @option{-O2} and higher.  Null pointer check
5075 elimination is only done if @option{-fdelete-null-pointer-checks} is
5076 enabled.
5078 @item -ftracer
5079 @opindex ftracer
5080 Perform tail duplication to enlarge superblock size.  This transformation
5081 simplifies the control flow of the function allowing other optimizations to do
5082 better job.
5084 @item -funroll-loops
5085 @opindex funroll-loops
5086 Unroll loops whose number of iterations can be determined at compile
5087 time or upon entry to the loop.  @option{-funroll-loops} implies both
5088 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5089 option makes code larger, and may or may not make it run faster.
5091 @item -funroll-all-loops
5092 @opindex funroll-all-loops
5093 Unroll all loops, even if their number of iterations is uncertain when
5094 the loop is entered.  This usually makes programs run more slowly.
5095 @option{-funroll-all-loops} implies the same options as
5096 @option{-funroll-loops},
5098 @item -fsplit-ivs-in-unroller
5099 @opindex -fsplit-ivs-in-unroller
5100 Enables expressing of values of induction variables in later iterations
5101 of the unrolled loop using the value in the first iteration.  This breaks
5102 long dependency chains, thus improving efficiency of the scheduling passes.
5104 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5105 same effect.  However in cases the loop body is more complicated than
5106 a single basic block, this is not reliable.  It also does not work at all
5107 on some of the architectures due to restrictions in the CSE pass.
5109 This optimization is enabled by default.
5111 @item -fvariable-expansion-in-unroller
5112 @opindex -fvariable-expansion-in-unroller
5113 With this option, the compiler will create multiple copies of some
5114 local variables when unrolling a loop which can result in superior code.
5116 @item -fprefetch-loop-arrays
5117 @opindex fprefetch-loop-arrays
5118 If supported by the target machine, generate instructions to prefetch
5119 memory to improve the performance of loops that access large arrays.
5121 These options may generate better or worse code; results are highly
5122 dependent on the structure of loops within the source code.
5124 @item -fno-peephole
5125 @itemx -fno-peephole2
5126 @opindex fno-peephole
5127 @opindex fno-peephole2
5128 Disable any machine-specific peephole optimizations.  The difference
5129 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5130 are implemented in the compiler; some targets use one, some use the
5131 other, a few use both.
5133 @option{-fpeephole} is enabled by default.
5134 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5136 @item -fno-guess-branch-probability
5137 @opindex fno-guess-branch-probability
5138 Do not guess branch probabilities using heuristics.
5140 GCC will use heuristics to guess branch probabilities if they are
5141 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5142 heuristics are based on the control flow graph.  If some branch probabilities
5143 are specified by @samp{__builtin_expect}, then the heuristics will be
5144 used to guess branch probabilities for the rest of the control flow graph,
5145 taking the @samp{__builtin_expect} info into account.  The interactions
5146 between the heuristics and @samp{__builtin_expect} can be complex, and in
5147 some cases, it may be useful to disable the heuristics so that the effects
5148 of @samp{__builtin_expect} are easier to understand.
5150 The default is @option{-fguess-branch-probability} at levels
5151 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5153 @item -freorder-blocks
5154 @opindex freorder-blocks
5155 Reorder basic blocks in the compiled function in order to reduce number of
5156 taken branches and improve code locality.
5158 Enabled at levels @option{-O2}, @option{-O3}.
5160 @item -freorder-blocks-and-partition
5161 @opindex freorder-blocks-and-partition
5162 In addition to reordering basic blocks in the compiled function, in order
5163 to reduce number of taken branches, partitions hot and cold basic blocks
5164 into separate sections of the assembly and .o files, to improve
5165 paging and cache locality performance.
5167 This optimization is automatically turned off in the presence of
5168 exception handling, for linkonce sections, for functions with a user-defined
5169 section attribute and on any architecture that does not support named
5170 sections.
5172 @item -freorder-functions
5173 @opindex freorder-functions
5174 Reorder functions in the object file in order to
5175 improve code locality.  This is implemented by using special
5176 subsections @code{.text.hot} for most frequently executed functions and
5177 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5178 the linker so object file format must support named sections and linker must
5179 place them in a reasonable way.
5181 Also profile feedback must be available in to make this option effective.  See
5182 @option{-fprofile-arcs} for details.
5184 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5186 @item -fstrict-aliasing
5187 @opindex fstrict-aliasing
5188 Allows the compiler to assume the strictest aliasing rules applicable to
5189 the language being compiled.  For C (and C++), this activates
5190 optimizations based on the type of expressions.  In particular, an
5191 object of one type is assumed never to reside at the same address as an
5192 object of a different type, unless the types are almost the same.  For
5193 example, an @code{unsigned int} can alias an @code{int}, but not a
5194 @code{void*} or a @code{double}.  A character type may alias any other
5195 type.
5197 Pay special attention to code like this:
5198 @smallexample
5199 union a_union @{
5200   int i;
5201   double d;
5204 int f() @{
5205   a_union t;
5206   t.d = 3.0;
5207   return t.i;
5209 @end smallexample
5210 The practice of reading from a different union member than the one most
5211 recently written to (called ``type-punning'') is common.  Even with
5212 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5213 is accessed through the union type.  So, the code above will work as
5214 expected.  However, this code might not:
5215 @smallexample
5216 int f() @{
5217   a_union t;
5218   int* ip;
5219   t.d = 3.0;
5220   ip = &t.i;
5221   return *ip;
5223 @end smallexample
5225 Every language that wishes to perform language-specific alias analysis
5226 should define a function that computes, given an @code{tree}
5227 node, an alias set for the node.  Nodes in different alias sets are not
5228 allowed to alias.  For an example, see the C front-end function
5229 @code{c_get_alias_set}.
5231 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5233 @item -falign-functions
5234 @itemx -falign-functions=@var{n}
5235 @opindex falign-functions
5236 Align the start of functions to the next power-of-two greater than
5237 @var{n}, skipping up to @var{n} bytes.  For instance,
5238 @option{-falign-functions=32} aligns functions to the next 32-byte
5239 boundary, but @option{-falign-functions=24} would align to the next
5240 32-byte boundary only if this can be done by skipping 23 bytes or less.
5242 @option{-fno-align-functions} and @option{-falign-functions=1} are
5243 equivalent and mean that functions will not be aligned.
5245 Some assemblers only support this flag when @var{n} is a power of two;
5246 in that case, it is rounded up.
5248 If @var{n} is not specified or is zero, use a machine-dependent default.
5250 Enabled at levels @option{-O2}, @option{-O3}.
5252 @item -falign-labels
5253 @itemx -falign-labels=@var{n}
5254 @opindex falign-labels
5255 Align all branch targets to a power-of-two boundary, skipping up to
5256 @var{n} bytes like @option{-falign-functions}.  This option can easily
5257 make code slower, because it must insert dummy operations for when the
5258 branch target is reached in the usual flow of the code.
5260 @option{-fno-align-labels} and @option{-falign-labels=1} are
5261 equivalent and mean that labels will not be aligned.
5263 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5264 are greater than this value, then their values are used instead.
5266 If @var{n} is not specified or is zero, use a machine-dependent default
5267 which is very likely to be @samp{1}, meaning no alignment.
5269 Enabled at levels @option{-O2}, @option{-O3}.
5271 @item -falign-loops
5272 @itemx -falign-loops=@var{n}
5273 @opindex falign-loops
5274 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5275 like @option{-falign-functions}.  The hope is that the loop will be
5276 executed many times, which will make up for any execution of the dummy
5277 operations.
5279 @option{-fno-align-loops} and @option{-falign-loops=1} are
5280 equivalent and mean that loops will not be aligned.
5282 If @var{n} is not specified or is zero, use a machine-dependent default.
5284 Enabled at levels @option{-O2}, @option{-O3}.
5286 @item -falign-jumps
5287 @itemx -falign-jumps=@var{n}
5288 @opindex falign-jumps
5289 Align branch targets to a power-of-two boundary, for branch targets
5290 where the targets can only be reached by jumping, skipping up to @var{n}
5291 bytes like @option{-falign-functions}.  In this case, no dummy operations
5292 need be executed.
5294 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5295 equivalent and mean that loops will not be aligned.
5297 If @var{n} is not specified or is zero, use a machine-dependent default.
5299 Enabled at levels @option{-O2}, @option{-O3}.
5301 @item -funit-at-a-time
5302 @opindex funit-at-a-time
5303 Parse the whole compilation unit before starting to produce code.
5304 This allows some extra optimizations to take place but consumes
5305 more memory (in general).  There are some compatibility issues
5306 with @emph{unit-at-at-time} mode:
5307 @itemize @bullet
5308 @item
5309 enabling @emph{unit-at-a-time} mode may change the order
5310 in which functions, variables, and top-level @code{asm} statements
5311 are emitted, and will likely break code relying on some particular
5312 ordering.  The majority of such top-level @code{asm} statements,
5313 though, can be replaced by @code{section} attributes.
5315 @item
5316 @emph{unit-at-a-time} mode removes unreferenced static variables
5317 and functions.  This may result in undefined references
5318 when an @code{asm} statement refers directly to variables or functions
5319 that are otherwise unused.  In that case either the variable/function
5320 shall be listed as an operand of the @code{asm} statement operand or,
5321 in the case of top-level @code{asm} statements the attribute @code{used}
5322 shall be used on the declaration.
5324 @item
5325 Static functions now can use non-standard passing conventions that
5326 may break @code{asm} statements calling functions directly.  Again,
5327 attribute @code{used} will prevent this behavior.
5328 @end itemize
5330 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5331 but this scheme may not be supported by future releases of GCC@.
5333 Enabled at levels @option{-O2}, @option{-O3}.
5335 @item -fweb
5336 @opindex fweb
5337 Constructs webs as commonly used for register allocation purposes and assign
5338 each web individual pseudo register.  This allows the register allocation pass
5339 to operate on pseudos directly, but also strengthens several other optimization
5340 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5341 however, make debugging impossible, since variables will no longer stay in a
5342 ``home register''.
5344 Enabled by default with @option{-funroll-loops}.
5346 @item -fwhole-program
5347 @opindex fwhole-program
5348 Assume that the current compilation unit represents whole program being
5349 compiled.  All public functions and variables with the exception of @code{main}
5350 and those merged by attribute @code{externally_visible} become static functions
5351 and in a affect gets more aggressively optimized by interprocedural optimizers.
5352 While this option is equivalent to proper use of @code{static} keyword for
5353 programs consisting of single file, in combination with option
5354 @option{--combine} this flag can be used to compile most of smaller scale C
5355 programs since the functions and variables become local for the whole combined
5356 compilation unit, not for the single source file itself.
5359 @item -fno-cprop-registers
5360 @opindex fno-cprop-registers
5361 After register allocation and post-register allocation instruction splitting,
5362 we perform a copy-propagation pass to try to reduce scheduling dependencies
5363 and occasionally eliminate the copy.
5365 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5367 @item -fprofile-generate
5368 @opindex fprofile-generate
5370 Enable options usually used for instrumenting application to produce
5371 profile useful for later recompilation with profile feedback based
5372 optimization.  You must use @option{-fprofile-generate} both when
5373 compiling and when linking your program.
5375 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5377 @item -fprofile-use
5378 @opindex fprofile-use
5379 Enable profile feedback directed optimizations, and optimizations
5380 generally profitable only with profile feedback available.
5382 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5383 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5384 @code{-fno-loop-optimize}.
5386 @end table
5388 The following options control compiler behavior regarding floating
5389 point arithmetic.  These options trade off between speed and
5390 correctness.  All must be specifically enabled.
5392 @table @gcctabopt
5393 @item -ffloat-store
5394 @opindex ffloat-store
5395 Do not store floating point variables in registers, and inhibit other
5396 options that might change whether a floating point value is taken from a
5397 register or memory.
5399 @cindex floating point precision
5400 This option prevents undesirable excess precision on machines such as
5401 the 68000 where the floating registers (of the 68881) keep more
5402 precision than a @code{double} is supposed to have.  Similarly for the
5403 x86 architecture.  For most programs, the excess precision does only
5404 good, but a few programs rely on the precise definition of IEEE floating
5405 point.  Use @option{-ffloat-store} for such programs, after modifying
5406 them to store all pertinent intermediate computations into variables.
5408 @item -ffast-math
5409 @opindex ffast-math
5410 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5411 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5412 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5413 and @option{fcx-limited-range}.
5415 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5417 This option should never be turned on by any @option{-O} option since
5418 it can result in incorrect output for programs which depend on
5419 an exact implementation of IEEE or ISO rules/specifications for
5420 math functions.
5422 @item -fno-math-errno
5423 @opindex fno-math-errno
5424 Do not set ERRNO after calling math functions that are executed
5425 with a single instruction, e.g., sqrt.  A program that relies on
5426 IEEE exceptions for math error handling may want to use this flag
5427 for speed while maintaining IEEE arithmetic compatibility.
5429 This option should never be turned on by any @option{-O} option since
5430 it can result in incorrect output for programs which depend on
5431 an exact implementation of IEEE or ISO rules/specifications for
5432 math functions.
5434 The default is @option{-fmath-errno}.
5436 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5437 no reason for the compiler to consider the possibility that it might,
5438 and @option{-fno-math-errno} is the default.
5440 @item -funsafe-math-optimizations
5441 @opindex funsafe-math-optimizations
5442 Allow optimizations for floating-point arithmetic that (a) assume
5443 that arguments and results are valid and (b) may violate IEEE or
5444 ANSI standards.  When used at link-time, it may include libraries
5445 or startup files that change the default FPU control word or other
5446 similar optimizations.
5448 This option should never be turned on by any @option{-O} option since
5449 it can result in incorrect output for programs which depend on
5450 an exact implementation of IEEE or ISO rules/specifications for
5451 math functions.
5453 The default is @option{-fno-unsafe-math-optimizations}.
5455 @item -ffinite-math-only
5456 @opindex ffinite-math-only
5457 Allow optimizations for floating-point arithmetic that assume
5458 that arguments and results are not NaNs or +-Infs.
5460 This option should never be turned on by any @option{-O} option since
5461 it can result in incorrect output for programs which depend on
5462 an exact implementation of IEEE or ISO rules/specifications.
5464 The default is @option{-fno-finite-math-only}.
5466 @item -fno-trapping-math
5467 @opindex fno-trapping-math
5468 Compile code assuming that floating-point operations cannot generate
5469 user-visible traps.  These traps include division by zero, overflow,
5470 underflow, inexact result and invalid operation.  This option implies
5471 @option{-fno-signaling-nans}.  Setting this option may allow faster
5472 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5474 This option should never be turned on by any @option{-O} option since
5475 it can result in incorrect output for programs which depend on
5476 an exact implementation of IEEE or ISO rules/specifications for
5477 math functions.
5479 The default is @option{-ftrapping-math}.
5481 @item -frounding-math
5482 @opindex frounding-math
5483 Disable transformations and optimizations that assume default floating
5484 point rounding behavior.  This is round-to-zero for all floating point
5485 to integer conversions, and round-to-nearest for all other arithmetic
5486 truncations.  This option should be specified for programs that change
5487 the FP rounding mode dynamically, or that may be executed with a
5488 non-default rounding mode.  This option disables constant folding of
5489 floating point expressions at compile-time (which may be affected by
5490 rounding mode) and arithmetic transformations that are unsafe in the
5491 presence of sign-dependent rounding modes.
5493 The default is @option{-fno-rounding-math}.
5495 This option is experimental and does not currently guarantee to
5496 disable all GCC optimizations that are affected by rounding mode.
5497 Future versions of GCC may provide finer control of this setting
5498 using C99's @code{FENV_ACCESS} pragma.  This command line option
5499 will be used to specify the default state for @code{FENV_ACCESS}.
5501 @item -fsignaling-nans
5502 @opindex fsignaling-nans
5503 Compile code assuming that IEEE signaling NaNs may generate user-visible
5504 traps during floating-point operations.  Setting this option disables
5505 optimizations that may change the number of exceptions visible with
5506 signaling NaNs.  This option implies @option{-ftrapping-math}.
5508 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5509 be defined.
5511 The default is @option{-fno-signaling-nans}.
5513 This option is experimental and does not currently guarantee to
5514 disable all GCC optimizations that affect signaling NaN behavior.
5516 @item -fsingle-precision-constant
5517 @opindex fsingle-precision-constant
5518 Treat floating point constant as single precision constant instead of
5519 implicitly converting it to double precision constant.
5521 @item -fcx-limited-range
5522 @itemx -fno-cx-limited-range
5523 @opindex fcx-limited-range
5524 @opindex fno-cx-limited-range
5525 When enabled, this option states that a range reduction step is not
5526 needed when performing complex division.  The default is
5527 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5529 This option controls the default setting of the ISO C99 
5530 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5531 all languages.
5533 @end table
5535 The following options control optimizations that may improve
5536 performance, but are not enabled by any @option{-O} options.  This
5537 section includes experimental options that may produce broken code.
5539 @table @gcctabopt
5540 @item -fbranch-probabilities
5541 @opindex fbranch-probabilities
5542 After running a program compiled with @option{-fprofile-arcs}
5543 (@pxref{Debugging Options,, Options for Debugging Your Program or
5544 @command{gcc}}), you can compile it a second time using
5545 @option{-fbranch-probabilities}, to improve optimizations based on
5546 the number of times each branch was taken.  When the program
5547 compiled with @option{-fprofile-arcs} exits it saves arc execution
5548 counts to a file called @file{@var{sourcename}.gcda} for each source
5549 file  The information in this data file is very dependent on the
5550 structure of the generated code, so you must use the same source code
5551 and the same optimization options for both compilations.
5553 With @option{-fbranch-probabilities}, GCC puts a
5554 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5555 These can be used to improve optimization.  Currently, they are only
5556 used in one place: in @file{reorg.c}, instead of guessing which path a
5557 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5558 exactly determine which path is taken more often.
5560 @item -fprofile-values
5561 @opindex fprofile-values
5562 If combined with @option{-fprofile-arcs}, it adds code so that some
5563 data about values of expressions in the program is gathered.
5565 With @option{-fbranch-probabilities}, it reads back the data gathered
5566 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5567 notes to instructions for their later usage in optimizations.
5569 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5571 @item -fvpt
5572 @opindex fvpt
5573 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5574 a code to gather information about values of expressions.
5576 With @option{-fbranch-probabilities}, it reads back the data gathered
5577 and actually performs the optimizations based on them.
5578 Currently the optimizations include specialization of division operation
5579 using the knowledge about the value of the denominator.
5581 @item -frename-registers
5582 @opindex frename-registers
5583 Attempt to avoid false dependencies in scheduled code by making use
5584 of registers left over after register allocation.  This optimization
5585 will most benefit processors with lots of registers.  Depending on the
5586 debug information format adopted by the target, however, it can
5587 make debugging impossible, since variables will no longer stay in
5588 a ``home register''.
5590 Enabled by default with @option{-funroll-loops}.
5592 @item -ftracer
5593 @opindex ftracer
5594 Perform tail duplication to enlarge superblock size.  This transformation
5595 simplifies the control flow of the function allowing other optimizations to do
5596 better job.
5598 Enabled with @option{-fprofile-use}.
5600 @item -funroll-loops
5601 @opindex funroll-loops
5602 Unroll loops whose number of iterations can be determined at compile time or
5603 upon entry to the loop.  @option{-funroll-loops} implies
5604 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5605 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5606 small constant number of iterations).  This option makes code larger, and may
5607 or may not make it run faster.
5609 Enabled with @option{-fprofile-use}.
5611 @item -funroll-all-loops
5612 @opindex funroll-all-loops
5613 Unroll all loops, even if their number of iterations is uncertain when
5614 the loop is entered.  This usually makes programs run more slowly.
5615 @option{-funroll-all-loops} implies the same options as
5616 @option{-funroll-loops}.
5618 @item -fpeel-loops
5619 @opindex fpeel-loops
5620 Peels the loops for that there is enough information that they do not
5621 roll much (from profile feedback).  It also turns on complete loop peeling
5622 (i.e.@: complete removal of loops with small constant number of iterations).
5624 Enabled with @option{-fprofile-use}.
5626 @item -fmove-loop-invariants
5627 @opindex fmove-loop-invariants
5628 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5629 at level @option{-O1}
5631 @item -funswitch-loops
5632 @opindex funswitch-loops
5633 Move branches with loop invariant conditions out of the loop, with duplicates
5634 of the loop on both branches (modified according to result of the condition).
5636 @item -fprefetch-loop-arrays
5637 @opindex fprefetch-loop-arrays
5638 If supported by the target machine, generate instructions to prefetch
5639 memory to improve the performance of loops that access large arrays.
5641 Disabled at level @option{-Os}.
5643 @item -ffunction-sections
5644 @itemx -fdata-sections
5645 @opindex ffunction-sections
5646 @opindex fdata-sections
5647 Place each function or data item into its own section in the output
5648 file if the target supports arbitrary sections.  The name of the
5649 function or the name of the data item determines the section's name
5650 in the output file.
5652 Use these options on systems where the linker can perform optimizations
5653 to improve locality of reference in the instruction space.  Most systems
5654 using the ELF object format and SPARC processors running Solaris 2 have
5655 linkers with such optimizations.  AIX may have these optimizations in
5656 the future.
5658 Only use these options when there are significant benefits from doing
5659 so.  When you specify these options, the assembler and linker will
5660 create larger object and executable files and will also be slower.
5661 You will not be able to use @code{gprof} on all systems if you
5662 specify this option and you may have problems with debugging if
5663 you specify both this option and @option{-g}.
5665 @item -fbranch-target-load-optimize
5666 @opindex fbranch-target-load-optimize
5667 Perform branch target register load optimization before prologue / epilogue
5668 threading.
5669 The use of target registers can typically be exposed only during reload,
5670 thus hoisting loads out of loops and doing inter-block scheduling needs
5671 a separate optimization pass.
5673 @item -fbranch-target-load-optimize2
5674 @opindex fbranch-target-load-optimize2
5675 Perform branch target register load optimization after prologue / epilogue
5676 threading.
5678 @item -fbtr-bb-exclusive
5679 @opindex fbtr-bb-exclusive
5680 When performing branch target register load optimization, don't reuse
5681 branch target registers in within any basic block.
5683 @item -fstack-protector
5684 Emit extra code to check for buffer overflows, such as stack smashing
5685 attacks.  This is done by adding a guard variable to functions with
5686 vulnerable objects.  This includes functions that call alloca, and
5687 functions with buffers larger than 8 bytes.  The guards are initialized
5688 when a function is entered and then checked when the function exits.
5689 If a guard check fails, an error message is printed and the program exits.
5691 @item -fstack-protector-all
5692 Like @option{-fstack-protector} except that all functions are protected.
5694 @item --param @var{name}=@var{value}
5695 @opindex param
5696 In some places, GCC uses various constants to control the amount of
5697 optimization that is done.  For example, GCC will not inline functions
5698 that contain more that a certain number of instructions.  You can
5699 control some of these constants on the command-line using the
5700 @option{--param} option.
5702 The names of specific parameters, and the meaning of the values, are
5703 tied to the internals of the compiler, and are subject to change
5704 without notice in future releases.
5706 In each case, the @var{value} is an integer.  The allowable choices for
5707 @var{name} are given in the following table:
5709 @table @gcctabopt
5710 @item salias-max-implicit-fields
5711 The maximum number of fields in a variable without direct
5712 structure accesses for which structure aliasing will consider trying 
5713 to track each field.  The default is 5
5715 @item sra-max-structure-size
5716 The maximum structure size, in bytes, at which the scalar replacement
5717 of aggregates (SRA) optimization will perform block copies.  The
5718 default value, 0, implies that GCC will select the most appropriate
5719 size itself.
5721 @item sra-field-structure-ratio
5722 The threshold ratio (as a percentage) between instantiated fields and
5723 the complete structure size.  We say that if the ratio of the number
5724 of bytes in instantiated fields to the number of bytes in the complete
5725 structure exceeds this parameter, then block copies are not used.  The
5726 default is 75.
5728 @item max-crossjump-edges
5729 The maximum number of incoming edges to consider for crossjumping.
5730 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5731 the number of edges incoming to each block.  Increasing values mean
5732 more aggressive optimization, making the compile time increase with
5733 probably small improvement in executable size.
5735 @item min-crossjump-insns
5736 The minimum number of instructions which must be matched at the end
5737 of two blocks before crossjumping will be performed on them.  This
5738 value is ignored in the case where all instructions in the block being
5739 crossjumped from are matched.  The default value is 5.
5741 @item max-grow-copy-bb-insns
5742 The maximum code size expansion factor when copying basic blocks
5743 instead of jumping.  The expansion is relative to a jump instruction.
5744 The default value is 8.
5746 @item max-goto-duplication-insns
5747 The maximum number of instructions to duplicate to a block that jumps
5748 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5749 passes, GCC factors computed gotos early in the compilation process,
5750 and unfactors them as late as possible.  Only computed jumps at the
5751 end of a basic blocks with no more than max-goto-duplication-insns are
5752 unfactored.  The default value is 8.
5754 @item max-delay-slot-insn-search
5755 The maximum number of instructions to consider when looking for an
5756 instruction to fill a delay slot.  If more than this arbitrary number of
5757 instructions is searched, the time savings from filling the delay slot
5758 will be minimal so stop searching.  Increasing values mean more
5759 aggressive optimization, making the compile time increase with probably
5760 small improvement in executable run time.
5762 @item max-delay-slot-live-search
5763 When trying to fill delay slots, the maximum number of instructions to
5764 consider when searching for a block with valid live register
5765 information.  Increasing this arbitrarily chosen value means more
5766 aggressive optimization, increasing the compile time.  This parameter
5767 should be removed when the delay slot code is rewritten to maintain the
5768 control-flow graph.
5770 @item max-gcse-memory
5771 The approximate maximum amount of memory that will be allocated in
5772 order to perform the global common subexpression elimination
5773 optimization.  If more memory than specified is required, the
5774 optimization will not be done.
5776 @item max-gcse-passes
5777 The maximum number of passes of GCSE to run.  The default is 1.
5779 @item max-pending-list-length
5780 The maximum number of pending dependencies scheduling will allow
5781 before flushing the current state and starting over.  Large functions
5782 with few branches or calls can create excessively large lists which
5783 needlessly consume memory and resources.
5785 @item max-inline-insns-single
5786 Several parameters control the tree inliner used in gcc.
5787 This number sets the maximum number of instructions (counted in GCC's
5788 internal representation) in a single function that the tree inliner
5789 will consider for inlining.  This only affects functions declared
5790 inline and methods implemented in a class declaration (C++).
5791 The default value is 450.
5793 @item max-inline-insns-auto
5794 When you use @option{-finline-functions} (included in @option{-O3}),
5795 a lot of functions that would otherwise not be considered for inlining
5796 by the compiler will be investigated.  To those functions, a different
5797 (more restrictive) limit compared to functions declared inline can
5798 be applied.
5799 The default value is 90.
5801 @item large-function-insns
5802 The limit specifying really large functions.  For functions larger than this
5803 limit after inlining inlining is constrained by
5804 @option{--param large-function-growth}.  This parameter is useful primarily
5805 to avoid extreme compilation time caused by non-linear algorithms used by the
5806 backend.
5807 This parameter is ignored when @option{-funit-at-a-time} is not used.
5808 The default value is 2700.
5810 @item large-function-growth
5811 Specifies maximal growth of large function caused by inlining in percents.
5812 This parameter is ignored when @option{-funit-at-a-time} is not used.
5813 The default value is 100 which limits large function growth to 2.0 times
5814 the original size.
5816 @item inline-unit-growth
5817 Specifies maximal overall growth of the compilation unit caused by inlining.
5818 This parameter is ignored when @option{-funit-at-a-time} is not used.
5819 The default value is 50 which limits unit growth to 1.5 times the original
5820 size.
5822 @item max-inline-insns-recursive
5823 @itemx max-inline-insns-recursive-auto
5824 Specifies maximum number of instructions out-of-line copy of self recursive inline
5825 function can grow into by performing recursive inlining.
5827 For functions declared inline @option{--param max-inline-insns-recursive} is
5828 taken into acount.  For function not declared inline, recursive inlining
5829 happens only when @option{-finline-functions} (included in @option{-O3}) is
5830 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5831 default value is 450.
5833 @item max-inline-recursive-depth
5834 @itemx max-inline-recursive-depth-auto
5835 Specifies maximum recursion depth used by the recursive inlining.
5837 For functions declared inline @option{--param max-inline-recursive-depth} is
5838 taken into acount.  For function not declared inline, recursive inlining
5839 happens only when @option{-finline-functions} (included in @option{-O3}) is
5840 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5841 default value is 450.
5843 @item min-inline-recursive-probability
5844 Recursive inlining is profitable only for function having deep recursion
5845 in average and can hurt for function having little recursion depth by
5846 increasing the prologue size or complexity of function body to other
5847 optimizers.
5849 When profile feedback is available (see @option{-fprofile-generate}) the actual
5850 recursion depth can be guessed from probability that function will recurse via
5851 given call expression.  This parameter limits inlining only to call expression
5852 whose probability exceeds given threshold (in percents).  The default value is
5855 @item inline-call-cost
5856 Specify cost of call instruction relative to simple arithmetics operations
5857 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5858 functions and at the same time increases size of leaf function that is believed to
5859 reduce function size by being inlined.  In effect it increases amount of
5860 inlining for code having large abstraction penalty (many functions that just
5861 pass the arguments to other functions) and decrease inlining for code with low
5862 abstraction penalty.  The default value is 16.
5864 @item max-unrolled-insns
5865 The maximum number of instructions that a loop should have if that loop
5866 is unrolled, and if the loop is unrolled, it determines how many times
5867 the loop code is unrolled.
5869 @item max-average-unrolled-insns
5870 The maximum number of instructions biased by probabilities of their execution
5871 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5872 it determines how many times the loop code is unrolled.
5874 @item max-unroll-times
5875 The maximum number of unrollings of a single loop.
5877 @item max-peeled-insns
5878 The maximum number of instructions that a loop should have if that loop
5879 is peeled, and if the loop is peeled, it determines how many times
5880 the loop code is peeled.
5882 @item max-peel-times
5883 The maximum number of peelings of a single loop.
5885 @item max-completely-peeled-insns
5886 The maximum number of insns of a completely peeled loop.
5888 @item max-completely-peel-times
5889 The maximum number of iterations of a loop to be suitable for complete peeling.
5891 @item max-unswitch-insns
5892 The maximum number of insns of an unswitched loop.
5894 @item max-unswitch-level
5895 The maximum number of branches unswitched in a single loop.
5897 @item lim-expensive
5898 The minimum cost of an expensive expression in the loop invariant motion.
5900 @item iv-consider-all-candidates-bound
5901 Bound on number of candidates for induction variables below that
5902 all candidates are considered for each use in induction variable
5903 optimizations.  Only the most relevant candidates are considered
5904 if there are more candidates, to avoid quadratic time complexity.
5906 @item iv-max-considered-uses
5907 The induction variable optimizations give up on loops that contain more
5908 induction variable uses.
5910 @item iv-always-prune-cand-set-bound
5911 If number of candidates in the set is smaller than this value,
5912 we always try to remove unnecessary ivs from the set during its
5913 optimization when a new iv is added to the set.
5915 @item scev-max-expr-size
5916 Bound on size of expressions used in the scalar evolutions analyzer.
5917 Large expressions slow the analyzer.
5919 @item vect-max-version-checks
5920 The maximum number of runtime checks that can be performed when doing
5921 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5922 for more information.
5924 @item max-iterations-to-track
5926 The maximum number of iterations of a loop the brute force algorithm
5927 for analysis of # of iterations of the loop tries to evaluate.
5929 @item hot-bb-count-fraction
5930 Select fraction of the maximal count of repetitions of basic block in program
5931 given basic block needs to have to be considered hot.
5933 @item hot-bb-frequency-fraction
5934 Select fraction of the maximal frequency of executions of basic block in
5935 function given basic block needs to have to be considered hot
5937 @item tracer-dynamic-coverage
5938 @itemx tracer-dynamic-coverage-feedback
5940 This value is used to limit superblock formation once the given percentage of
5941 executed instructions is covered.  This limits unnecessary code size
5942 expansion.
5944 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5945 feedback is available.  The real profiles (as opposed to statically estimated
5946 ones) are much less balanced allowing the threshold to be larger value.
5948 @item tracer-max-code-growth
5949 Stop tail duplication once code growth has reached given percentage.  This is
5950 rather hokey argument, as most of the duplicates will be eliminated later in
5951 cross jumping, so it may be set to much higher values than is the desired code
5952 growth.
5954 @item tracer-min-branch-ratio
5956 Stop reverse growth when the reverse probability of best edge is less than this
5957 threshold (in percent).
5959 @item tracer-min-branch-ratio
5960 @itemx tracer-min-branch-ratio-feedback
5962 Stop forward growth if the best edge do have probability lower than this
5963 threshold.
5965 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5966 compilation for profile feedback and one for compilation without.  The value
5967 for compilation with profile feedback needs to be more conservative (higher) in
5968 order to make tracer effective.
5970 @item max-cse-path-length
5972 Maximum number of basic blocks on path that cse considers.  The default is 10.
5974 @item global-var-threshold
5976 Counts the number of function calls (@var{n}) and the number of
5977 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5978 single artificial variable will be created to represent all the
5979 call-clobbered variables at function call sites.  This artificial
5980 variable will then be made to alias every call-clobbered variable.
5981 (done as @code{int * size_t} on the host machine; beware overflow).
5983 @item max-aliased-vops
5985 Maximum number of virtual operands allowed to represent aliases
5986 before triggering the alias grouping heuristic.  Alias grouping
5987 reduces compile times and memory consumption needed for aliasing at
5988 the expense of precision loss in alias information.
5990 @item ggc-min-expand
5992 GCC uses a garbage collector to manage its own memory allocation.  This
5993 parameter specifies the minimum percentage by which the garbage
5994 collector's heap should be allowed to expand between collections.
5995 Tuning this may improve compilation speed; it has no effect on code
5996 generation.
5998 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5999 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6000 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6001 GCC is not able to calculate RAM on a particular platform, the lower
6002 bound of 30% is used.  Setting this parameter and
6003 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6004 every opportunity.  This is extremely slow, but can be useful for
6005 debugging.
6007 @item ggc-min-heapsize
6009 Minimum size of the garbage collector's heap before it begins bothering
6010 to collect garbage.  The first collection occurs after the heap expands
6011 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6012 tuning this may improve compilation speed, and has no effect on code
6013 generation.
6015 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6016 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6017 with a lower bound of 4096 (four megabytes) and an upper bound of
6018 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6019 particular platform, the lower bound is used.  Setting this parameter
6020 very large effectively disables garbage collection.  Setting this
6021 parameter and @option{ggc-min-expand} to zero causes a full collection
6022 to occur at every opportunity.
6024 @item max-reload-search-insns
6025 The maximum number of instruction reload should look backward for equivalent
6026 register.  Increasing values mean more aggressive optimization, making the
6027 compile time increase with probably slightly better performance.  The default
6028 value is 100.
6030 @item max-cselib-memory-location
6031 The maximum number of memory locations cselib should take into acount.
6032 Increasing values mean more aggressive optimization, making the compile time
6033 increase with probably slightly better performance.  The default value is 500.
6035 @item reorder-blocks-duplicate
6036 @itemx reorder-blocks-duplicate-feedback
6038 Used by basic block reordering pass to decide whether to use unconditional
6039 branch or duplicate the code on its destination.  Code is duplicated when its
6040 estimated size is smaller than this value multiplied by the estimated size of
6041 unconditional jump in the hot spots of the program.
6043 The @option{reorder-block-duplicate-feedback} is used only when profile
6044 feedback is available and may be set to higher values than
6045 @option{reorder-block-duplicate} since information about the hot spots is more
6046 accurate.
6048 @item max-sched-region-blocks
6049 The maximum number of blocks in a region to be considered for
6050 interblock scheduling.  The default value is 10.
6052 @item max-sched-region-insns
6053 The maximum number of insns in a region to be considered for
6054 interblock scheduling.  The default value is 100.
6056 @item min-sched-prob
6057 The minimum probability of reaching a source block for interblock
6058 speculative scheduling.  The default value is 40.
6060 @item max-last-value-rtl
6062 The maximum size measured as number of RTLs that can be recorded in an expression
6063 in combiner for a pseudo register as last known value of that register.  The default
6064 is 10000.
6066 @item integer-share-limit
6067 Small integer constants can use a shared data structure, reducing the
6068 compiler's memory usage and increasing its speed.  This sets the maximum
6069 value of a shared integer constant's.  The default value is 256.
6071 @item min-virtual-mappings
6072 Specifies the minimum number of virtual mappings in the incremental
6073 SSA updater that should be registered to trigger the virtual mappings
6074 heuristic defined by virtual-mappings-ratio.  The default value is
6075 100.
6077 @item virtual-mappings-ratio
6078 If the number of virtual mappings is virtual-mappings-ratio bigger
6079 than the number of virtual symbols to be updated, then the incremental
6080 SSA updater switches to a full update for those symbols.  The default
6081 ratio is 3.
6083 @item ssp-buffer-size
6084 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6085 protection when @option{-fstack-protection} is used.
6087 @end table
6088 @end table
6090 @node Preprocessor Options
6091 @section Options Controlling the Preprocessor
6092 @cindex preprocessor options
6093 @cindex options, preprocessor
6095 These options control the C preprocessor, which is run on each C source
6096 file before actual compilation.
6098 If you use the @option{-E} option, nothing is done except preprocessing.
6099 Some of these options make sense only together with @option{-E} because
6100 they cause the preprocessor output to be unsuitable for actual
6101 compilation.
6103 @table @gcctabopt
6104 @opindex Wp
6105 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6106 and pass @var{option} directly through to the preprocessor.  If
6107 @var{option} contains commas, it is split into multiple options at the
6108 commas.  However, many options are modified, translated or interpreted
6109 by the compiler driver before being passed to the preprocessor, and
6110 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6111 interface is undocumented and subject to change, so whenever possible
6112 you should avoid using @option{-Wp} and let the driver handle the
6113 options instead.
6115 @item -Xpreprocessor @var{option}
6116 @opindex preprocessor
6117 Pass @var{option} as an option to the preprocessor.  You can use this to
6118 supply system-specific preprocessor options which GCC does not know how to
6119 recognize.
6121 If you want to pass an option that takes an argument, you must use
6122 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6123 @end table
6125 @include cppopts.texi
6127 @node Assembler Options
6128 @section Passing Options to the Assembler
6130 @c prevent bad page break with this line
6131 You can pass options to the assembler.
6133 @table @gcctabopt
6134 @item -Wa,@var{option}
6135 @opindex Wa
6136 Pass @var{option} as an option to the assembler.  If @var{option}
6137 contains commas, it is split into multiple options at the commas.
6139 @item -Xassembler @var{option}
6140 @opindex Xassembler
6141 Pass @var{option} as an option to the assembler.  You can use this to
6142 supply system-specific assembler options which GCC does not know how to
6143 recognize.
6145 If you want to pass an option that takes an argument, you must use
6146 @option{-Xassembler} twice, once for the option and once for the argument.
6148 @end table
6150 @node Link Options
6151 @section Options for Linking
6152 @cindex link options
6153 @cindex options, linking
6155 These options come into play when the compiler links object files into
6156 an executable output file.  They are meaningless if the compiler is
6157 not doing a link step.
6159 @table @gcctabopt
6160 @cindex file names
6161 @item @var{object-file-name}
6162 A file name that does not end in a special recognized suffix is
6163 considered to name an object file or library.  (Object files are
6164 distinguished from libraries by the linker according to the file
6165 contents.)  If linking is done, these object files are used as input
6166 to the linker.
6168 @item -c
6169 @itemx -S
6170 @itemx -E
6171 @opindex c
6172 @opindex S
6173 @opindex E
6174 If any of these options is used, then the linker is not run, and
6175 object file names should not be used as arguments.  @xref{Overall
6176 Options}.
6178 @cindex Libraries
6179 @item -l@var{library}
6180 @itemx -l @var{library}
6181 @opindex l
6182 Search the library named @var{library} when linking.  (The second
6183 alternative with the library as a separate argument is only for
6184 POSIX compliance and is not recommended.)
6186 It makes a difference where in the command you write this option; the
6187 linker searches and processes libraries and object files in the order they
6188 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6189 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6190 to functions in @samp{z}, those functions may not be loaded.
6192 The linker searches a standard list of directories for the library,
6193 which is actually a file named @file{lib@var{library}.a}.  The linker
6194 then uses this file as if it had been specified precisely by name.
6196 The directories searched include several standard system directories
6197 plus any that you specify with @option{-L}.
6199 Normally the files found this way are library files---archive files
6200 whose members are object files.  The linker handles an archive file by
6201 scanning through it for members which define symbols that have so far
6202 been referenced but not defined.  But if the file that is found is an
6203 ordinary object file, it is linked in the usual fashion.  The only
6204 difference between using an @option{-l} option and specifying a file name
6205 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6206 and searches several directories.
6208 @item -lobjc
6209 @opindex lobjc
6210 You need this special case of the @option{-l} option in order to
6211 link an Objective-C or Objective-C++ program.
6213 @item -nostartfiles
6214 @opindex nostartfiles
6215 Do not use the standard system startup files when linking.
6216 The standard system libraries are used normally, unless @option{-nostdlib}
6217 or @option{-nodefaultlibs} is used.
6219 @item -nodefaultlibs
6220 @opindex nodefaultlibs
6221 Do not use the standard system libraries when linking.
6222 Only the libraries you specify will be passed to the linker.
6223 The standard startup files are used normally, unless @option{-nostartfiles}
6224 is used.  The compiler may generate calls to @code{memcmp},
6225 @code{memset}, @code{memcpy} and @code{memmove}.
6226 These entries are usually resolved by entries in
6227 libc.  These entry points should be supplied through some other
6228 mechanism when this option is specified.
6230 @item -nostdlib
6231 @opindex nostdlib
6232 Do not use the standard system startup files or libraries when linking.
6233 No startup files and only the libraries you specify will be passed to
6234 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6235 @code{memcpy} and @code{memmove}.
6236 These entries are usually resolved by entries in
6237 libc.  These entry points should be supplied through some other
6238 mechanism when this option is specified.
6240 @cindex @option{-lgcc}, use with @option{-nostdlib}
6241 @cindex @option{-nostdlib} and unresolved references
6242 @cindex unresolved references and @option{-nostdlib}
6243 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6244 @cindex @option{-nodefaultlibs} and unresolved references
6245 @cindex unresolved references and @option{-nodefaultlibs}
6246 One of the standard libraries bypassed by @option{-nostdlib} and
6247 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6248 that GCC uses to overcome shortcomings of particular machines, or special
6249 needs for some languages.
6250 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6251 Collection (GCC) Internals},
6252 for more discussion of @file{libgcc.a}.)
6253 In most cases, you need @file{libgcc.a} even when you want to avoid
6254 other standard libraries.  In other words, when you specify @option{-nostdlib}
6255 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6256 This ensures that you have no unresolved references to internal GCC
6257 library subroutines.  (For example, @samp{__main}, used to ensure C++
6258 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6259 GNU Compiler Collection (GCC) Internals}.)
6261 @item -pie
6262 @opindex pie
6263 Produce a position independent executable on targets which support it.
6264 For predictable results, you must also specify the same set of options
6265 that were used to generate code (@option{-fpie}, @option{-fPIE},
6266 or model suboptions) when you specify this option.
6268 @item -rdynamic
6269 @opindex rdynamic
6270 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6271 that support it. This instructs the linker to add all symbols, not
6272 only used ones, to the dynamic symbol table. This option is needed
6273 for some uses of @code{dlopen} or to allow obtaining backtraces
6274 from within a program.
6276 @item -s
6277 @opindex s
6278 Remove all symbol table and relocation information from the executable.
6280 @item -static
6281 @opindex static
6282 On systems that support dynamic linking, this prevents linking with the shared
6283 libraries.  On other systems, this option has no effect.
6285 @item -shared
6286 @opindex shared
6287 Produce a shared object which can then be linked with other objects to
6288 form an executable.  Not all systems support this option.  For predictable
6289 results, you must also specify the same set of options that were used to
6290 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6291 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6292 needs to build supplementary stub code for constructors to work.  On
6293 multi-libbed systems, @samp{gcc -shared} must select the correct support
6294 libraries to link against.  Failing to supply the correct flags may lead
6295 to subtle defects.  Supplying them in cases where they are not necessary
6296 is innocuous.}
6298 @item -shared-libgcc
6299 @itemx -static-libgcc
6300 @opindex shared-libgcc
6301 @opindex static-libgcc
6302 On systems that provide @file{libgcc} as a shared library, these options
6303 force the use of either the shared or static version respectively.
6304 If no shared version of @file{libgcc} was built when the compiler was
6305 configured, these options have no effect.
6307 There are several situations in which an application should use the
6308 shared @file{libgcc} instead of the static version.  The most common
6309 of these is when the application wishes to throw and catch exceptions
6310 across different shared libraries.  In that case, each of the libraries
6311 as well as the application itself should use the shared @file{libgcc}.
6313 Therefore, the G++ and GCJ drivers automatically add
6314 @option{-shared-libgcc} whenever you build a shared library or a main
6315 executable, because C++ and Java programs typically use exceptions, so
6316 this is the right thing to do.
6318 If, instead, you use the GCC driver to create shared libraries, you may
6319 find that they will not always be linked with the shared @file{libgcc}.
6320 If GCC finds, at its configuration time, that you have a non-GNU linker
6321 or a GNU linker that does not support option @option{--eh-frame-hdr},
6322 it will link the shared version of @file{libgcc} into shared libraries
6323 by default.  Otherwise, it will take advantage of the linker and optimize
6324 away the linking with the shared version of @file{libgcc}, linking with
6325 the static version of libgcc by default.  This allows exceptions to
6326 propagate through such shared libraries, without incurring relocation
6327 costs at library load time.
6329 However, if a library or main executable is supposed to throw or catch
6330 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6331 for the languages used in the program, or using the option
6332 @option{-shared-libgcc}, such that it is linked with the shared
6333 @file{libgcc}.
6335 @item -symbolic
6336 @opindex symbolic
6337 Bind references to global symbols when building a shared object.  Warn
6338 about any unresolved references (unless overridden by the link editor
6339 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6340 this option.
6342 @item -Xlinker @var{option}
6343 @opindex Xlinker
6344 Pass @var{option} as an option to the linker.  You can use this to
6345 supply system-specific linker options which GCC does not know how to
6346 recognize.
6348 If you want to pass an option that takes an argument, you must use
6349 @option{-Xlinker} twice, once for the option and once for the argument.
6350 For example, to pass @option{-assert definitions}, you must write
6351 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6352 @option{-Xlinker "-assert definitions"}, because this passes the entire
6353 string as a single argument, which is not what the linker expects.
6355 @item -Wl,@var{option}
6356 @opindex Wl
6357 Pass @var{option} as an option to the linker.  If @var{option} contains
6358 commas, it is split into multiple options at the commas.
6360 @item -u @var{symbol}
6361 @opindex u
6362 Pretend the symbol @var{symbol} is undefined, to force linking of
6363 library modules to define it.  You can use @option{-u} multiple times with
6364 different symbols to force loading of additional library modules.
6365 @end table
6367 @node Directory Options
6368 @section Options for Directory Search
6369 @cindex directory options
6370 @cindex options, directory search
6371 @cindex search path
6373 These options specify directories to search for header files, for
6374 libraries and for parts of the compiler:
6376 @table @gcctabopt
6377 @item -I@var{dir}
6378 @opindex I
6379 Add the directory @var{dir} to the head of the list of directories to be
6380 searched for header files.  This can be used to override a system header
6381 file, substituting your own version, since these directories are
6382 searched before the system header file directories.  However, you should
6383 not use this option to add directories that contain vendor-supplied
6384 system header files (use @option{-isystem} for that).  If you use more than
6385 one @option{-I} option, the directories are scanned in left-to-right
6386 order; the standard system directories come after.
6388 If a standard system include directory, or a directory specified with
6389 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6390 option will be ignored.  The directory will still be searched but as a
6391 system directory at its normal position in the system include chain.
6392 This is to ensure that GCC's procedure to fix buggy system headers and
6393 the ordering for the include_next directive are not inadvertently changed.
6394 If you really need to change the search order for system directories,
6395 use the @option{-nostdinc} and/or @option{-isystem} options.
6397 @item -iquote@var{dir}
6398 @opindex iquote
6399 Add the directory @var{dir} to the head of the list of directories to
6400 be searched for header files only for the case of @samp{#include
6401 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6402 otherwise just like @option{-I}.
6404 @item -L@var{dir}
6405 @opindex L
6406 Add directory @var{dir} to the list of directories to be searched
6407 for @option{-l}.
6409 @item -B@var{prefix}
6410 @opindex B
6411 This option specifies where to find the executables, libraries,
6412 include files, and data files of the compiler itself.
6414 The compiler driver program runs one or more of the subprograms
6415 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6416 @var{prefix} as a prefix for each program it tries to run, both with and
6417 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6419 For each subprogram to be run, the compiler driver first tries the
6420 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6421 was not specified, the driver tries two standard prefixes, which are
6422 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6423 those results in a file name that is found, the unmodified program
6424 name is searched for using the directories specified in your
6425 @env{PATH} environment variable.
6427 The compiler will check to see if the path provided by the @option{-B}
6428 refers to a directory, and if necessary it will add a directory
6429 separator character at the end of the path.
6431 @option{-B} prefixes that effectively specify directory names also apply
6432 to libraries in the linker, because the compiler translates these
6433 options into @option{-L} options for the linker.  They also apply to
6434 includes files in the preprocessor, because the compiler translates these
6435 options into @option{-isystem} options for the preprocessor.  In this case,
6436 the compiler appends @samp{include} to the prefix.
6438 The run-time support file @file{libgcc.a} can also be searched for using
6439 the @option{-B} prefix, if needed.  If it is not found there, the two
6440 standard prefixes above are tried, and that is all.  The file is left
6441 out of the link if it is not found by those means.
6443 Another way to specify a prefix much like the @option{-B} prefix is to use
6444 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6445 Variables}.
6447 As a special kludge, if the path provided by @option{-B} is
6448 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6449 9, then it will be replaced by @file{[dir/]include}.  This is to help
6450 with boot-strapping the compiler.
6452 @item -specs=@var{file}
6453 @opindex specs
6454 Process @var{file} after the compiler reads in the standard @file{specs}
6455 file, in order to override the defaults that the @file{gcc} driver
6456 program uses when determining what switches to pass to @file{cc1},
6457 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6458 @option{-specs=@var{file}} can be specified on the command line, and they
6459 are processed in order, from left to right.
6461 @item --sysroot=@var{dir}
6462 @opindex sysroot
6463 Use @var{dir} as the logical root directory for headers and libraries.
6464 For example, if the compiler would normally search for headers in
6465 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6466 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6468 If you use both this option and the @option{-isysroot} option, then
6469 the @option{--sysroot} option will apply to libraries, but the
6470 @option{-isysroot} option will apply to header files.
6472 The GNU linker (beginning with version 2.16) has the necessary support
6473 for this option.  If your linker does not support this option, the
6474 header file aspect of @option{--sysroot} will still work, but the
6475 library aspect will not.
6477 @item -I-
6478 @opindex I-
6479 This option has been deprecated.  Please use @option{-iquote} instead for
6480 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6481 Any directories you specify with @option{-I} options before the @option{-I-}
6482 option are searched only for the case of @samp{#include "@var{file}"};
6483 they are not searched for @samp{#include <@var{file}>}.
6485 If additional directories are specified with @option{-I} options after
6486 the @option{-I-}, these directories are searched for all @samp{#include}
6487 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6488 this way.)
6490 In addition, the @option{-I-} option inhibits the use of the current
6491 directory (where the current input file came from) as the first search
6492 directory for @samp{#include "@var{file}"}.  There is no way to
6493 override this effect of @option{-I-}.  With @option{-I.} you can specify
6494 searching the directory which was current when the compiler was
6495 invoked.  That is not exactly the same as what the preprocessor does
6496 by default, but it is often satisfactory.
6498 @option{-I-} does not inhibit the use of the standard system directories
6499 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6500 independent.
6501 @end table
6503 @c man end
6505 @node Spec Files
6506 @section Specifying subprocesses and the switches to pass to them
6507 @cindex Spec Files
6509 @command{gcc} is a driver program.  It performs its job by invoking a
6510 sequence of other programs to do the work of compiling, assembling and
6511 linking.  GCC interprets its command-line parameters and uses these to
6512 deduce which programs it should invoke, and which command-line options
6513 it ought to place on their command lines.  This behavior is controlled
6514 by @dfn{spec strings}.  In most cases there is one spec string for each
6515 program that GCC can invoke, but a few programs have multiple spec
6516 strings to control their behavior.  The spec strings built into GCC can
6517 be overridden by using the @option{-specs=} command-line switch to specify
6518 a spec file.
6520 @dfn{Spec files} are plaintext files that are used to construct spec
6521 strings.  They consist of a sequence of directives separated by blank
6522 lines.  The type of directive is determined by the first non-whitespace
6523 character on the line and it can be one of the following:
6525 @table @code
6526 @item %@var{command}
6527 Issues a @var{command} to the spec file processor.  The commands that can
6528 appear here are:
6530 @table @code
6531 @item %include <@var{file}>
6532 @cindex %include
6533 Search for @var{file} and insert its text at the current point in the
6534 specs file.
6536 @item %include_noerr <@var{file}>
6537 @cindex %include_noerr
6538 Just like @samp{%include}, but do not generate an error message if the include
6539 file cannot be found.
6541 @item %rename @var{old_name} @var{new_name}
6542 @cindex %rename
6543 Rename the spec string @var{old_name} to @var{new_name}.
6545 @end table
6547 @item *[@var{spec_name}]:
6548 This tells the compiler to create, override or delete the named spec
6549 string.  All lines after this directive up to the next directive or
6550 blank line are considered to be the text for the spec string.  If this
6551 results in an empty string then the spec will be deleted.  (Or, if the
6552 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6553 does not currently exist a new spec will be created.  If the spec does
6554 exist then its contents will be overridden by the text of this
6555 directive, unless the first character of that text is the @samp{+}
6556 character, in which case the text will be appended to the spec.
6558 @item [@var{suffix}]:
6559 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6560 and up to the next directive or blank line are considered to make up the
6561 spec string for the indicated suffix.  When the compiler encounters an
6562 input file with the named suffix, it will processes the spec string in
6563 order to work out how to compile that file.  For example:
6565 @smallexample
6566 .ZZ:
6567 z-compile -input %i
6568 @end smallexample
6570 This says that any input file whose name ends in @samp{.ZZ} should be
6571 passed to the program @samp{z-compile}, which should be invoked with the
6572 command-line switch @option{-input} and with the result of performing the
6573 @samp{%i} substitution.  (See below.)
6575 As an alternative to providing a spec string, the text that follows a
6576 suffix directive can be one of the following:
6578 @table @code
6579 @item @@@var{language}
6580 This says that the suffix is an alias for a known @var{language}.  This is
6581 similar to using the @option{-x} command-line switch to GCC to specify a
6582 language explicitly.  For example:
6584 @smallexample
6585 .ZZ:
6586 @@c++
6587 @end smallexample
6589 Says that .ZZ files are, in fact, C++ source files.
6591 @item #@var{name}
6592 This causes an error messages saying:
6594 @smallexample
6595 @var{name} compiler not installed on this system.
6596 @end smallexample
6597 @end table
6599 GCC already has an extensive list of suffixes built into it.
6600 This directive will add an entry to the end of the list of suffixes, but
6601 since the list is searched from the end backwards, it is effectively
6602 possible to override earlier entries using this technique.
6604 @end table
6606 GCC has the following spec strings built into it.  Spec files can
6607 override these strings or create their own.  Note that individual
6608 targets can also add their own spec strings to this list.
6610 @smallexample
6611 asm          Options to pass to the assembler
6612 asm_final    Options to pass to the assembler post-processor
6613 cpp          Options to pass to the C preprocessor
6614 cc1          Options to pass to the C compiler
6615 cc1plus      Options to pass to the C++ compiler
6616 endfile      Object files to include at the end of the link
6617 link         Options to pass to the linker
6618 lib          Libraries to include on the command line to the linker
6619 libgcc       Decides which GCC support library to pass to the linker
6620 linker       Sets the name of the linker
6621 predefines   Defines to be passed to the C preprocessor
6622 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6623              by default
6624 startfile    Object files to include at the start of the link
6625 @end smallexample
6627 Here is a small example of a spec file:
6629 @smallexample
6630 %rename lib                 old_lib
6632 *lib:
6633 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6634 @end smallexample
6636 This example renames the spec called @samp{lib} to @samp{old_lib} and
6637 then overrides the previous definition of @samp{lib} with a new one.
6638 The new definition adds in some extra command-line options before
6639 including the text of the old definition.
6641 @dfn{Spec strings} are a list of command-line options to be passed to their
6642 corresponding program.  In addition, the spec strings can contain
6643 @samp{%}-prefixed sequences to substitute variable text or to
6644 conditionally insert text into the command line.  Using these constructs
6645 it is possible to generate quite complex command lines.
6647 Here is a table of all defined @samp{%}-sequences for spec
6648 strings.  Note that spaces are not generated automatically around the
6649 results of expanding these sequences.  Therefore you can concatenate them
6650 together or combine them with constant text in a single argument.
6652 @table @code
6653 @item %%
6654 Substitute one @samp{%} into the program name or argument.
6656 @item %i
6657 Substitute the name of the input file being processed.
6659 @item %b
6660 Substitute the basename of the input file being processed.
6661 This is the substring up to (and not including) the last period
6662 and not including the directory.
6664 @item %B
6665 This is the same as @samp{%b}, but include the file suffix (text after
6666 the last period).
6668 @item %d
6669 Marks the argument containing or following the @samp{%d} as a
6670 temporary file name, so that that file will be deleted if GCC exits
6671 successfully.  Unlike @samp{%g}, this contributes no text to the
6672 argument.
6674 @item %g@var{suffix}
6675 Substitute a file name that has suffix @var{suffix} and is chosen
6676 once per compilation, and mark the argument in the same way as
6677 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6678 name is now chosen in a way that is hard to predict even when previously
6679 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6680 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6681 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6682 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6683 was simply substituted with a file name chosen once per compilation,
6684 without regard to any appended suffix (which was therefore treated
6685 just like ordinary text), making such attacks more likely to succeed.
6687 @item %u@var{suffix}
6688 Like @samp{%g}, but generates a new temporary file name even if
6689 @samp{%u@var{suffix}} was already seen.
6691 @item %U@var{suffix}
6692 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6693 new one if there is no such last file name.  In the absence of any
6694 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6695 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6696 would involve the generation of two distinct file names, one
6697 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6698 simply substituted with a file name chosen for the previous @samp{%u},
6699 without regard to any appended suffix.
6701 @item %j@var{suffix}
6702 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6703 writable, and if save-temps is off; otherwise, substitute the name
6704 of a temporary file, just like @samp{%u}.  This temporary file is not
6705 meant for communication between processes, but rather as a junk
6706 disposal mechanism.
6708 @item %|@var{suffix}
6709 @itemx %m@var{suffix}
6710 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6711 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6712 all.  These are the two most common ways to instruct a program that it
6713 should read from standard input or write to standard output.  If you
6714 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6715 construct: see for example @file{f/lang-specs.h}.
6717 @item %.@var{SUFFIX}
6718 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6719 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6720 terminated by the next space or %.
6722 @item %w
6723 Marks the argument containing or following the @samp{%w} as the
6724 designated output file of this compilation.  This puts the argument
6725 into the sequence of arguments that @samp{%o} will substitute later.
6727 @item %o
6728 Substitutes the names of all the output files, with spaces
6729 automatically placed around them.  You should write spaces
6730 around the @samp{%o} as well or the results are undefined.
6731 @samp{%o} is for use in the specs for running the linker.
6732 Input files whose names have no recognized suffix are not compiled
6733 at all, but they are included among the output files, so they will
6734 be linked.
6736 @item %O
6737 Substitutes the suffix for object files.  Note that this is
6738 handled specially when it immediately follows @samp{%g, %u, or %U},
6739 because of the need for those to form complete file names.  The
6740 handling is such that @samp{%O} is treated exactly as if it had already
6741 been substituted, except that @samp{%g, %u, and %U} do not currently
6742 support additional @var{suffix} characters following @samp{%O} as they would
6743 following, for example, @samp{.o}.
6745 @item %p
6746 Substitutes the standard macro predefinitions for the
6747 current target machine.  Use this when running @code{cpp}.
6749 @item %P
6750 Like @samp{%p}, but puts @samp{__} before and after the name of each
6751 predefined macro, except for macros that start with @samp{__} or with
6752 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6755 @item %I
6756 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6757 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6758 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6759 as necessary.
6761 @item %s
6762 Current argument is the name of a library or startup file of some sort.
6763 Search for that file in a standard list of directories and substitute
6764 the full name found.
6766 @item %e@var{str}
6767 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6768 Use this when inconsistent options are detected.
6770 @item %(@var{name})
6771 Substitute the contents of spec string @var{name} at this point.
6773 @item %[@var{name}]
6774 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6776 @item %x@{@var{option}@}
6777 Accumulate an option for @samp{%X}.
6779 @item %X
6780 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6781 spec string.
6783 @item %Y
6784 Output the accumulated assembler options specified by @option{-Wa}.
6786 @item %Z
6787 Output the accumulated preprocessor options specified by @option{-Wp}.
6789 @item %a
6790 Process the @code{asm} spec.  This is used to compute the
6791 switches to be passed to the assembler.
6793 @item %A
6794 Process the @code{asm_final} spec.  This is a spec string for
6795 passing switches to an assembler post-processor, if such a program is
6796 needed.
6798 @item %l
6799 Process the @code{link} spec.  This is the spec for computing the
6800 command line passed to the linker.  Typically it will make use of the
6801 @samp{%L %G %S %D and %E} sequences.
6803 @item %D
6804 Dump out a @option{-L} option for each directory that GCC believes might
6805 contain startup files.  If the target supports multilibs then the
6806 current multilib directory will be prepended to each of these paths.
6808 @item %L
6809 Process the @code{lib} spec.  This is a spec string for deciding which
6810 libraries should be included on the command line to the linker.
6812 @item %G
6813 Process the @code{libgcc} spec.  This is a spec string for deciding
6814 which GCC support library should be included on the command line to the linker.
6816 @item %S
6817 Process the @code{startfile} spec.  This is a spec for deciding which
6818 object files should be the first ones passed to the linker.  Typically
6819 this might be a file named @file{crt0.o}.
6821 @item %E
6822 Process the @code{endfile} spec.  This is a spec string that specifies
6823 the last object files that will be passed to the linker.
6825 @item %C
6826 Process the @code{cpp} spec.  This is used to construct the arguments
6827 to be passed to the C preprocessor.
6829 @item %1
6830 Process the @code{cc1} spec.  This is used to construct the options to be
6831 passed to the actual C compiler (@samp{cc1}).
6833 @item %2
6834 Process the @code{cc1plus} spec.  This is used to construct the options to be
6835 passed to the actual C++ compiler (@samp{cc1plus}).
6837 @item %*
6838 Substitute the variable part of a matched option.  See below.
6839 Note that each comma in the substituted string is replaced by
6840 a single space.
6842 @item %<@code{S}
6843 Remove all occurrences of @code{-S} from the command line.  Note---this
6844 command is position dependent.  @samp{%} commands in the spec string
6845 before this one will see @code{-S}, @samp{%} commands in the spec string
6846 after this one will not.
6848 @item %:@var{function}(@var{args})
6849 Call the named function @var{function}, passing it @var{args}.
6850 @var{args} is first processed as a nested spec string, then split
6851 into an argument vector in the usual fashion.  The function returns
6852 a string which is processed as if it had appeared literally as part
6853 of the current spec.
6855 The following built-in spec functions are provided:
6857 @table @code
6858 @item @code{if-exists}
6859 The @code{if-exists} spec function takes one argument, an absolute
6860 pathname to a file.  If the file exists, @code{if-exists} returns the
6861 pathname.  Here is a small example of its usage:
6863 @smallexample
6864 *startfile:
6865 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6866 @end smallexample
6868 @item @code{if-exists-else}
6869 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6870 spec function, except that it takes two arguments.  The first argument is
6871 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6872 returns the pathname.  If it does not exist, it returns the second argument.
6873 This way, @code{if-exists-else} can be used to select one file or another,
6874 based on the existence of the first.  Here is a small example of its usage:
6876 @smallexample
6877 *startfile:
6878 crt0%O%s %:if-exists(crti%O%s) \
6879 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6880 @end smallexample
6882 @item @code{replace-outfile}
6883 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6884 first argument in the outfiles array and replaces it with the second argument.  Here
6885 is a small example of its usage:
6887 @smallexample
6888 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6889 @end smallexample
6891 @end table
6893 @item %@{@code{S}@}
6894 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6895 If that switch was not specified, this substitutes nothing.  Note that
6896 the leading dash is omitted when specifying this option, and it is
6897 automatically inserted if the substitution is performed.  Thus the spec
6898 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6899 and would output the command line option @option{-foo}.
6901 @item %W@{@code{S}@}
6902 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6903 deleted on failure.
6905 @item %@{@code{S}*@}
6906 Substitutes all the switches specified to GCC whose names start
6907 with @code{-S}, but which also take an argument.  This is used for
6908 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6909 GCC considers @option{-o foo} as being
6910 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6911 text, including the space.  Thus two arguments would be generated.
6913 @item %@{@code{S}*&@code{T}*@}
6914 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6915 (the order of @code{S} and @code{T} in the spec is not significant).
6916 There can be any number of ampersand-separated variables; for each the
6917 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6919 @item %@{@code{S}:@code{X}@}
6920 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6922 @item %@{!@code{S}:@code{X}@}
6923 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6925 @item %@{@code{S}*:@code{X}@}
6926 Substitutes @code{X} if one or more switches whose names start with
6927 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6928 once, no matter how many such switches appeared.  However, if @code{%*}
6929 appears somewhere in @code{X}, then @code{X} will be substituted once
6930 for each matching switch, with the @code{%*} replaced by the part of
6931 that switch that matched the @code{*}.
6933 @item %@{.@code{S}:@code{X}@}
6934 Substitutes @code{X}, if processing a file with suffix @code{S}.
6936 @item %@{!.@code{S}:@code{X}@}
6937 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6939 @item %@{@code{S}|@code{P}:@code{X}@}
6940 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6941 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6942 although they have a stronger binding than the @samp{|}.  If @code{%*}
6943 appears in @code{X}, all of the alternatives must be starred, and only
6944 the first matching alternative is substituted.
6946 For example, a spec string like this:
6948 @smallexample
6949 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6950 @end smallexample
6952 will output the following command-line options from the following input
6953 command-line options:
6955 @smallexample
6956 fred.c        -foo -baz
6957 jim.d         -bar -boggle
6958 -d fred.c     -foo -baz -boggle
6959 -d jim.d      -bar -baz -boggle
6960 @end smallexample
6962 @item %@{S:X; T:Y; :D@}
6964 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6965 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6966 be as many clauses as you need.  This may be combined with @code{.},
6967 @code{!}, @code{|}, and @code{*} as needed.
6970 @end table
6972 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6973 construct may contain other nested @samp{%} constructs or spaces, or
6974 even newlines.  They are processed as usual, as described above.
6975 Trailing white space in @code{X} is ignored.  White space may also
6976 appear anywhere on the left side of the colon in these constructs,
6977 except between @code{.} or @code{*} and the corresponding word.
6979 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6980 handled specifically in these constructs.  If another value of
6981 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6982 @option{-W} switch is found later in the command line, the earlier
6983 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6984 just one letter, which passes all matching options.
6986 The character @samp{|} at the beginning of the predicate text is used to
6987 indicate that a command should be piped to the following command, but
6988 only if @option{-pipe} is specified.
6990 It is built into GCC which switches take arguments and which do not.
6991 (You might think it would be useful to generalize this to allow each
6992 compiler's spec to say which switches take arguments.  But this cannot
6993 be done in a consistent fashion.  GCC cannot even decide which input
6994 files have been specified without knowing which switches take arguments,
6995 and it must know which input files to compile in order to tell which
6996 compilers to run).
6998 GCC also knows implicitly that arguments starting in @option{-l} are to be
6999 treated as compiler output files, and passed to the linker in their
7000 proper position among the other output files.
7002 @c man begin OPTIONS
7004 @node Target Options
7005 @section Specifying Target Machine and Compiler Version
7006 @cindex target options
7007 @cindex cross compiling
7008 @cindex specifying machine version
7009 @cindex specifying compiler version and target machine
7010 @cindex compiler version, specifying
7011 @cindex target machine, specifying
7013 The usual way to run GCC is to run the executable called @file{gcc}, or
7014 @file{<machine>-gcc} when cross-compiling, or
7015 @file{<machine>-gcc-<version>} to run a version other than the one that
7016 was installed last.  Sometimes this is inconvenient, so GCC provides
7017 options that will switch to another cross-compiler or version.
7019 @table @gcctabopt
7020 @item -b @var{machine}
7021 @opindex b
7022 The argument @var{machine} specifies the target machine for compilation.
7024 The value to use for @var{machine} is the same as was specified as the
7025 machine type when configuring GCC as a cross-compiler.  For
7026 example, if a cross-compiler was configured with @samp{configure
7027 arm-elf}, meaning to compile for an arm processor with elf binaries,
7028 then you would specify @option{-b arm-elf} to run that cross compiler.
7029 Because there are other options beginning with @option{-b}, the
7030 configuration must contain a hyphen. 
7032 @item -V @var{version}
7033 @opindex V
7034 The argument @var{version} specifies which version of GCC to run.
7035 This is useful when multiple versions are installed.  For example,
7036 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7037 @end table
7039 The @option{-V} and @option{-b} options work by running the
7040 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7041 use them if you can just run that directly.
7043 @node Submodel Options
7044 @section Hardware Models and Configurations
7045 @cindex submodel options
7046 @cindex specifying hardware config
7047 @cindex hardware models and configurations, specifying
7048 @cindex machine dependent options
7050 Earlier we discussed the standard option @option{-b} which chooses among
7051 different installed compilers for completely different target
7052 machines, such as VAX vs.@: 68000 vs.@: 80386.
7054 In addition, each of these target machine types can have its own
7055 special options, starting with @samp{-m}, to choose among various
7056 hardware models or configurations---for example, 68010 vs 68020,
7057 floating coprocessor or none.  A single installed version of the
7058 compiler can compile for any model or configuration, according to the
7059 options specified.
7061 Some configurations of the compiler also support additional special
7062 options, usually for compatibility with other compilers on the same
7063 platform.
7065 @c This list is ordered alphanumerically by subsection name.
7066 @c It should be the same order and spelling as these options are listed
7067 @c in Machine Dependent Options
7069 @menu
7070 * ARC Options::
7071 * ARM Options::
7072 * AVR Options::
7073 * Blackfin Options::
7074 * CRIS Options::
7075 * CRX Options::
7076 * Darwin Options::
7077 * DEC Alpha Options::
7078 * DEC Alpha/VMS Options::
7079 * FRV Options::
7080 * H8/300 Options::
7081 * HPPA Options::
7082 * i386 and x86-64 Options::
7083 * IA-64 Options::
7084 * M32C Options::
7085 * M32R/D Options::
7086 * M680x0 Options::
7087 * M68hc1x Options::
7088 * MCore Options::
7089 * MIPS Options::
7090 * MMIX Options::
7091 * MN10300 Options::
7092 * MS1 Options::
7093 * PDP-11 Options::
7094 * PowerPC Options::
7095 * RS/6000 and PowerPC Options::
7096 * S/390 and zSeries Options::
7097 * SH Options::
7098 * SPARC Options::
7099 * System V Options::
7100 * TMS320C3x/C4x Options::
7101 * V850 Options::
7102 * VAX Options::
7103 * x86-64 Options::
7104 * Xstormy16 Options::
7105 * Xtensa Options::
7106 * zSeries Options::
7107 @end menu
7109 @node ARC Options
7110 @subsection ARC Options
7111 @cindex ARC Options
7113 These options are defined for ARC implementations:
7115 @table @gcctabopt
7116 @item -EL
7117 @opindex EL
7118 Compile code for little endian mode.  This is the default.
7120 @item -EB
7121 @opindex EB
7122 Compile code for big endian mode.
7124 @item -mmangle-cpu
7125 @opindex mmangle-cpu
7126 Prepend the name of the cpu to all public symbol names.
7127 In multiple-processor systems, there are many ARC variants with different
7128 instruction and register set characteristics.  This flag prevents code
7129 compiled for one cpu to be linked with code compiled for another.
7130 No facility exists for handling variants that are ``almost identical''.
7131 This is an all or nothing option.
7133 @item -mcpu=@var{cpu}
7134 @opindex mcpu
7135 Compile code for ARC variant @var{cpu}.
7136 Which variants are supported depend on the configuration.
7137 All variants support @option{-mcpu=base}, this is the default.
7139 @item -mtext=@var{text-section}
7140 @itemx -mdata=@var{data-section}
7141 @itemx -mrodata=@var{readonly-data-section}
7142 @opindex mtext
7143 @opindex mdata
7144 @opindex mrodata
7145 Put functions, data, and readonly data in @var{text-section},
7146 @var{data-section}, and @var{readonly-data-section} respectively
7147 by default.  This can be overridden with the @code{section} attribute.
7148 @xref{Variable Attributes}.
7150 @end table
7152 @node ARM Options
7153 @subsection ARM Options
7154 @cindex ARM options
7156 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7157 architectures:
7159 @table @gcctabopt
7160 @item -mabi=@var{name}
7161 @opindex mabi
7162 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7163 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7165 @item -mapcs-frame
7166 @opindex mapcs-frame
7167 Generate a stack frame that is compliant with the ARM Procedure Call
7168 Standard for all functions, even if this is not strictly necessary for
7169 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7170 with this option will cause the stack frames not to be generated for
7171 leaf functions.  The default is @option{-mno-apcs-frame}.
7173 @item -mapcs
7174 @opindex mapcs
7175 This is a synonym for @option{-mapcs-frame}.
7177 @ignore
7178 @c not currently implemented
7179 @item -mapcs-stack-check
7180 @opindex mapcs-stack-check
7181 Generate code to check the amount of stack space available upon entry to
7182 every function (that actually uses some stack space).  If there is
7183 insufficient space available then either the function
7184 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7185 called, depending upon the amount of stack space required.  The run time
7186 system is required to provide these functions.  The default is
7187 @option{-mno-apcs-stack-check}, since this produces smaller code.
7189 @c not currently implemented
7190 @item -mapcs-float
7191 @opindex mapcs-float
7192 Pass floating point arguments using the float point registers.  This is
7193 one of the variants of the APCS@.  This option is recommended if the
7194 target hardware has a floating point unit or if a lot of floating point
7195 arithmetic is going to be performed by the code.  The default is
7196 @option{-mno-apcs-float}, since integer only code is slightly increased in
7197 size if @option{-mapcs-float} is used.
7199 @c not currently implemented
7200 @item -mapcs-reentrant
7201 @opindex mapcs-reentrant
7202 Generate reentrant, position independent code.  The default is
7203 @option{-mno-apcs-reentrant}.
7204 @end ignore
7206 @item -mthumb-interwork
7207 @opindex mthumb-interwork
7208 Generate code which supports calling between the ARM and Thumb
7209 instruction sets.  Without this option the two instruction sets cannot
7210 be reliably used inside one program.  The default is
7211 @option{-mno-thumb-interwork}, since slightly larger code is generated
7212 when @option{-mthumb-interwork} is specified.
7214 @item -mno-sched-prolog
7215 @opindex mno-sched-prolog
7216 Prevent the reordering of instructions in the function prolog, or the
7217 merging of those instruction with the instructions in the function's
7218 body.  This means that all functions will start with a recognizable set
7219 of instructions (or in fact one of a choice from a small set of
7220 different function prologues), and this information can be used to
7221 locate the start if functions inside an executable piece of code.  The
7222 default is @option{-msched-prolog}.
7224 @item -mhard-float
7225 @opindex mhard-float
7226 Generate output containing floating point instructions.  This is the
7227 default.
7229 @item -msoft-float
7230 @opindex msoft-float
7231 Generate output containing library calls for floating point.
7232 @strong{Warning:} the requisite libraries are not available for all ARM
7233 targets.  Normally the facilities of the machine's usual C compiler are
7234 used, but this cannot be done directly in cross-compilation.  You must make
7235 your own arrangements to provide suitable library functions for
7236 cross-compilation.
7238 @option{-msoft-float} changes the calling convention in the output file;
7239 therefore, it is only useful if you compile @emph{all} of a program with
7240 this option.  In particular, you need to compile @file{libgcc.a}, the
7241 library that comes with GCC, with @option{-msoft-float} in order for
7242 this to work.
7244 @item -mfloat-abi=@var{name}
7245 @opindex mfloat-abi
7246 Specifies which ABI to use for floating point values.  Permissible values
7247 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7249 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7250 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7251 of floating point instructions, but still uses the soft-float calling
7252 conventions.
7254 @item -mlittle-endian
7255 @opindex mlittle-endian
7256 Generate code for a processor running in little-endian mode.  This is
7257 the default for all standard configurations.
7259 @item -mbig-endian
7260 @opindex mbig-endian
7261 Generate code for a processor running in big-endian mode; the default is
7262 to compile code for a little-endian processor.
7264 @item -mwords-little-endian
7265 @opindex mwords-little-endian
7266 This option only applies when generating code for big-endian processors.
7267 Generate code for a little-endian word order but a big-endian byte
7268 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7269 option should only be used if you require compatibility with code for
7270 big-endian ARM processors generated by versions of the compiler prior to
7271 2.8.
7273 @item -mcpu=@var{name}
7274 @opindex mcpu
7275 This specifies the name of the target ARM processor.  GCC uses this name
7276 to determine what kind of instructions it can emit when generating
7277 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7278 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7279 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7280 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7281 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7282 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7283 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7284 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7285 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7286 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7287 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7288 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7289 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7290 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7291 @samp{ep9312}.
7293 @itemx -mtune=@var{name}
7294 @opindex mtune
7295 This option is very similar to the @option{-mcpu=} option, except that
7296 instead of specifying the actual target processor type, and hence
7297 restricting which instructions can be used, it specifies that GCC should
7298 tune the performance of the code as if the target were of the type
7299 specified in this option, but still choosing the instructions that it
7300 will generate based on the cpu specified by a @option{-mcpu=} option.
7301 For some ARM implementations better performance can be obtained by using
7302 this option.
7304 @item -march=@var{name}
7305 @opindex march
7306 This specifies the name of the target ARM architecture.  GCC uses this
7307 name to determine what kind of instructions it can emit when generating
7308 assembly code.  This option can be used in conjunction with or instead
7309 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7310 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7311 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7312 @samp{iwmmxt}, @samp{ep9312}.
7314 @item -mfpu=@var{name}
7315 @itemx -mfpe=@var{number}
7316 @itemx -mfp=@var{number}
7317 @opindex mfpu
7318 @opindex mfpe
7319 @opindex mfp
7320 This specifies what floating point hardware (or hardware emulation) is
7321 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7322 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7323 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7324 with older versions of GCC@.
7326 If @option{-msoft-float} is specified this specifies the format of
7327 floating point values.
7329 @item -mstructure-size-boundary=@var{n}
7330 @opindex mstructure-size-boundary
7331 The size of all structures and unions will be rounded up to a multiple
7332 of the number of bits set by this option.  Permissible values are 8, 32
7333 and 64.  The default value varies for different toolchains.  For the COFF
7334 targeted toolchain the default value is 8.  A value of 64 is only allowed
7335 if the underlying ABI supports it.
7337 Specifying the larger number can produce faster, more efficient code, but
7338 can also increase the size of the program.  Different values are potentially
7339 incompatible.  Code compiled with one value cannot necessarily expect to
7340 work with code or libraries compiled with another value, if they exchange
7341 information using structures or unions.
7343 @item -mabort-on-noreturn
7344 @opindex mabort-on-noreturn
7345 Generate a call to the function @code{abort} at the end of a
7346 @code{noreturn} function.  It will be executed if the function tries to
7347 return.
7349 @item -mlong-calls
7350 @itemx -mno-long-calls
7351 @opindex mlong-calls
7352 @opindex mno-long-calls
7353 Tells the compiler to perform function calls by first loading the
7354 address of the function into a register and then performing a subroutine
7355 call on this register.  This switch is needed if the target function
7356 will lie outside of the 64 megabyte addressing range of the offset based
7357 version of subroutine call instruction.
7359 Even if this switch is enabled, not all function calls will be turned
7360 into long calls.  The heuristic is that static functions, functions
7361 which have the @samp{short-call} attribute, functions that are inside
7362 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7363 definitions have already been compiled within the current compilation
7364 unit, will not be turned into long calls.  The exception to this rule is
7365 that weak function definitions, functions with the @samp{long-call}
7366 attribute or the @samp{section} attribute, and functions that are within
7367 the scope of a @samp{#pragma long_calls} directive, will always be
7368 turned into long calls.
7370 This feature is not enabled by default.  Specifying
7371 @option{-mno-long-calls} will restore the default behavior, as will
7372 placing the function calls within the scope of a @samp{#pragma
7373 long_calls_off} directive.  Note these switches have no effect on how
7374 the compiler generates code to handle function calls via function
7375 pointers.
7377 @item -mnop-fun-dllimport
7378 @opindex mnop-fun-dllimport
7379 Disable support for the @code{dllimport} attribute.
7381 @item -msingle-pic-base
7382 @opindex msingle-pic-base
7383 Treat the register used for PIC addressing as read-only, rather than
7384 loading it in the prologue for each function.  The run-time system is
7385 responsible for initializing this register with an appropriate value
7386 before execution begins.
7388 @item -mpic-register=@var{reg}
7389 @opindex mpic-register
7390 Specify the register to be used for PIC addressing.  The default is R10
7391 unless stack-checking is enabled, when R9 is used.
7393 @item -mcirrus-fix-invalid-insns
7394 @opindex mcirrus-fix-invalid-insns
7395 @opindex mno-cirrus-fix-invalid-insns
7396 Insert NOPs into the instruction stream to in order to work around
7397 problems with invalid Maverick instruction combinations.  This option
7398 is only valid if the @option{-mcpu=ep9312} option has been used to
7399 enable generation of instructions for the Cirrus Maverick floating
7400 point co-processor.  This option is not enabled by default, since the
7401 problem is only present in older Maverick implementations.  The default
7402 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7403 switch.
7405 @item -mpoke-function-name
7406 @opindex mpoke-function-name
7407 Write the name of each function into the text section, directly
7408 preceding the function prologue.  The generated code is similar to this:
7410 @smallexample
7411      t0
7412          .ascii "arm_poke_function_name", 0
7413          .align
7414      t1
7415          .word 0xff000000 + (t1 - t0)
7416      arm_poke_function_name
7417          mov     ip, sp
7418          stmfd   sp!, @{fp, ip, lr, pc@}
7419          sub     fp, ip, #4
7420 @end smallexample
7422 When performing a stack backtrace, code can inspect the value of
7423 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7424 location @code{pc - 12} and the top 8 bits are set, then we know that
7425 there is a function name embedded immediately preceding this location
7426 and has length @code{((pc[-3]) & 0xff000000)}.
7428 @item -mthumb
7429 @opindex mthumb
7430 Generate code for the 16-bit Thumb instruction set.  The default is to
7431 use the 32-bit ARM instruction set.
7433 @item -mtpcs-frame
7434 @opindex mtpcs-frame
7435 Generate a stack frame that is compliant with the Thumb Procedure Call
7436 Standard for all non-leaf functions.  (A leaf function is one that does
7437 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7439 @item -mtpcs-leaf-frame
7440 @opindex mtpcs-leaf-frame
7441 Generate a stack frame that is compliant with the Thumb Procedure Call
7442 Standard for all leaf functions.  (A leaf function is one that does
7443 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7445 @item -mcallee-super-interworking
7446 @opindex mcallee-super-interworking
7447 Gives all externally visible functions in the file being compiled an ARM
7448 instruction set header which switches to Thumb mode before executing the
7449 rest of the function.  This allows these functions to be called from
7450 non-interworking code.
7452 @item -mcaller-super-interworking
7453 @opindex mcaller-super-interworking
7454 Allows calls via function pointers (including virtual functions) to
7455 execute correctly regardless of whether the target code has been
7456 compiled for interworking or not.  There is a small overhead in the cost
7457 of executing a function pointer if this option is enabled.
7459 @end table
7461 @node AVR Options
7462 @subsection AVR Options
7463 @cindex AVR Options
7465 These options are defined for AVR implementations:
7467 @table @gcctabopt
7468 @item -mmcu=@var{mcu}
7469 @opindex mmcu
7470 Specify ATMEL AVR instruction set or MCU type.
7472 Instruction set avr1 is for the minimal AVR core, not supported by the C
7473 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7474 attiny11, attiny12, attiny15, attiny28).
7476 Instruction set avr2 (default) is for the classic AVR core with up to
7477 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7478 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7479 at90c8534, at90s8535).
7481 Instruction set avr3 is for the classic AVR core with up to 128K program
7482 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7484 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7485 memory space (MCU types: atmega8, atmega83, atmega85).
7487 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7488 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7489 atmega64, atmega128, at43usb355, at94k).
7491 @item -msize
7492 @opindex msize
7493 Output instruction sizes to the asm file.
7495 @item -minit-stack=@var{N}
7496 @opindex minit-stack
7497 Specify the initial stack address, which may be a symbol or numeric value,
7498 @samp{__stack} is the default.
7500 @item -mno-interrupts
7501 @opindex mno-interrupts
7502 Generated code is not compatible with hardware interrupts.
7503 Code size will be smaller.
7505 @item -mcall-prologues
7506 @opindex mcall-prologues
7507 Functions prologues/epilogues expanded as call to appropriate
7508 subroutines.  Code size will be smaller.
7510 @item -mno-tablejump
7511 @opindex mno-tablejump
7512 Do not generate tablejump insns which sometimes increase code size.
7514 @item -mtiny-stack
7515 @opindex mtiny-stack
7516 Change only the low 8 bits of the stack pointer.
7518 @item -mint8
7519 @opindex mint8
7520 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7521 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7522 and long long will be 4 bytes.  Please note that this option does not
7523 comply to the C standards, but it will provide you with smaller code
7524 size.
7525 @end table
7527 @node Blackfin Options
7528 @subsection Blackfin Options
7529 @cindex Blackfin Options
7531 @table @gcctabopt
7532 @item -momit-leaf-frame-pointer
7533 @opindex momit-leaf-frame-pointer
7534 Don't keep the frame pointer in a register for leaf functions.  This
7535 avoids the instructions to save, set up and restore frame pointers and
7536 makes an extra register available in leaf functions.  The option
7537 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7538 which might make debugging harder.
7540 @item -mspecld-anomaly
7541 @opindex mspecld-anomaly
7542 When enabled, the compiler will ensure that the generated code does not
7543 contain speculative loads after jump instructions.  This option is enabled
7544 by default.
7546 @item -mno-specld-anomaly
7547 @opindex mno-specld-anomaly
7548 Don't generate extra code to prevent speculative loads from occurring.
7550 @item -mcsync-anomaly
7551 @opindex mcsync-anomaly
7552 When enabled, the compiler will ensure that the generated code does not
7553 contain CSYNC or SSYNC instructions too soon after conditional branches.
7554 This option is enabled by default.
7556 @item -mno-csync-anomaly
7557 @opindex mno-csync-anomaly
7558 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7559 occurring too soon after a conditional branch.
7561 @item -mlow-64k
7562 @opindex mlow-64k
7563 When enabled, the compiler is free to take advantage of the knowledge that
7564 the entire program fits into the low 64k of memory.
7566 @item -mno-low-64k
7567 @opindex mno-low-64k
7568 Assume that the program is arbitrarily large.  This is the default.
7570 @item -mid-shared-library
7571 @opindex mid-shared-library
7572 Generate code that supports shared libraries via the library ID method.
7573 This allows for execute in place and shared libraries in an environment
7574 without virtual memory management.  This option implies @option{-fPIC}.
7576 @item -mno-id-shared-library
7577 @opindex mno-id-shared-library
7578 Generate code that doesn't assume ID based shared libraries are being used.
7579 This is the default.
7581 @item -mshared-library-id=n
7582 @opindex mshared-library-id
7583 Specified the identification number of the ID based shared library being
7584 compiled.  Specifying a value of 0 will generate more compact code, specifying
7585 other values will force the allocation of that number to the current
7586 library but is no more space or time efficient than omitting this option.
7588 @item -mlong-calls
7589 @itemx -mno-long-calls
7590 @opindex mlong-calls
7591 @opindex mno-long-calls
7592 Tells the compiler to perform function calls by first loading the
7593 address of the function into a register and then performing a subroutine
7594 call on this register.  This switch is needed if the target function
7595 will lie outside of the 24 bit addressing range of the offset based
7596 version of subroutine call instruction.
7598 This feature is not enabled by default.  Specifying
7599 @option{-mno-long-calls} will restore the default behavior.  Note these
7600 switches have no effect on how the compiler generates code to handle
7601 function calls via function pointers.
7602 @end table
7604 @node CRIS Options
7605 @subsection CRIS Options
7606 @cindex CRIS Options
7608 These options are defined specifically for the CRIS ports.
7610 @table @gcctabopt
7611 @item -march=@var{architecture-type}
7612 @itemx -mcpu=@var{architecture-type}
7613 @opindex march
7614 @opindex mcpu
7615 Generate code for the specified architecture.  The choices for
7616 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7617 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7618 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7619 @samp{v10}.
7621 @item -mtune=@var{architecture-type}
7622 @opindex mtune
7623 Tune to @var{architecture-type} everything applicable about the generated
7624 code, except for the ABI and the set of available instructions.  The
7625 choices for @var{architecture-type} are the same as for
7626 @option{-march=@var{architecture-type}}.
7628 @item -mmax-stack-frame=@var{n}
7629 @opindex mmax-stack-frame
7630 Warn when the stack frame of a function exceeds @var{n} bytes.
7632 @item -melinux-stacksize=@var{n}
7633 @opindex melinux-stacksize
7634 Only available with the @samp{cris-axis-aout} target.  Arranges for
7635 indications in the program to the kernel loader that the stack of the
7636 program should be set to @var{n} bytes.
7638 @item -metrax4
7639 @itemx -metrax100
7640 @opindex metrax4
7641 @opindex metrax100
7642 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7643 @option{-march=v3} and @option{-march=v8} respectively.
7645 @item -mmul-bug-workaround
7646 @itemx -mno-mul-bug-workaround
7647 @opindex mmul-bug-workaround
7648 @opindex mno-mul-bug-workaround
7649 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7650 models where it applies.  This option is active by default.
7652 @item -mpdebug
7653 @opindex mpdebug
7654 Enable CRIS-specific verbose debug-related information in the assembly
7655 code.  This option also has the effect to turn off the @samp{#NO_APP}
7656 formatted-code indicator to the assembler at the beginning of the
7657 assembly file.
7659 @item -mcc-init
7660 @opindex mcc-init
7661 Do not use condition-code results from previous instruction; always emit
7662 compare and test instructions before use of condition codes.
7664 @item -mno-side-effects
7665 @opindex mno-side-effects
7666 Do not emit instructions with side-effects in addressing modes other than
7667 post-increment.
7669 @item -mstack-align
7670 @itemx -mno-stack-align
7671 @itemx -mdata-align
7672 @itemx -mno-data-align
7673 @itemx -mconst-align
7674 @itemx -mno-const-align
7675 @opindex mstack-align
7676 @opindex mno-stack-align
7677 @opindex mdata-align
7678 @opindex mno-data-align
7679 @opindex mconst-align
7680 @opindex mno-const-align
7681 These options (no-options) arranges (eliminate arrangements) for the
7682 stack-frame, individual data and constants to be aligned for the maximum
7683 single data access size for the chosen CPU model.  The default is to
7684 arrange for 32-bit alignment.  ABI details such as structure layout are
7685 not affected by these options.
7687 @item -m32-bit
7688 @itemx -m16-bit
7689 @itemx -m8-bit
7690 @opindex m32-bit
7691 @opindex m16-bit
7692 @opindex m8-bit
7693 Similar to the stack- data- and const-align options above, these options
7694 arrange for stack-frame, writable data and constants to all be 32-bit,
7695 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7697 @item -mno-prologue-epilogue
7698 @itemx -mprologue-epilogue
7699 @opindex mno-prologue-epilogue
7700 @opindex mprologue-epilogue
7701 With @option{-mno-prologue-epilogue}, the normal function prologue and
7702 epilogue that sets up the stack-frame are omitted and no return
7703 instructions or return sequences are generated in the code.  Use this
7704 option only together with visual inspection of the compiled code: no
7705 warnings or errors are generated when call-saved registers must be saved,
7706 or storage for local variable needs to be allocated.
7708 @item -mno-gotplt
7709 @itemx -mgotplt
7710 @opindex mno-gotplt
7711 @opindex mgotplt
7712 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7713 instruction sequences that load addresses for functions from the PLT part
7714 of the GOT rather than (traditional on other architectures) calls to the
7715 PLT@.  The default is @option{-mgotplt}.
7717 @item -maout
7718 @opindex maout
7719 Legacy no-op option only recognized with the cris-axis-aout target.
7721 @item -melf
7722 @opindex melf
7723 Legacy no-op option only recognized with the cris-axis-elf and
7724 cris-axis-linux-gnu targets.
7726 @item -melinux
7727 @opindex melinux
7728 Only recognized with the cris-axis-aout target, where it selects a
7729 GNU/linux-like multilib, include files and instruction set for
7730 @option{-march=v8}.
7732 @item -mlinux
7733 @opindex mlinux
7734 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7736 @item -sim
7737 @opindex sim
7738 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7739 to link with input-output functions from a simulator library.  Code,
7740 initialized data and zero-initialized data are allocated consecutively.
7742 @item -sim2
7743 @opindex sim2
7744 Like @option{-sim}, but pass linker options to locate initialized data at
7745 0x40000000 and zero-initialized data at 0x80000000.
7746 @end table
7748 @node CRX Options
7749 @subsection CRX Options
7750 @cindex CRX Options
7752 These options are defined specifically for the CRX ports.
7754 @table @gcctabopt
7756 @item -mmac
7757 @opindex mmac
7758 Enable the use of multiply-accumulate instructions. Disabled by default.
7760 @item -mpush-args
7761 @opindex mpush-args
7762 Push instructions will be used to pass outgoing arguments when functions
7763 are called. Enabled by default.
7764 @end table
7766 @node Darwin Options
7767 @subsection Darwin Options
7768 @cindex Darwin options
7770 These options are defined for all architectures running the Darwin operating
7771 system.
7773 FSF GCC on Darwin does not create ``fat'' object files; it will create
7774 an object file for the single architecture that it was built to
7775 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7776 @option{-arch} options are used; it does so by running the compiler or
7777 linker multiple times and joining the results together with
7778 @file{lipo}.
7780 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7781 @samp{i686}) is determined by the flags that specify the ISA
7782 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7783 @option{-force_cpusubtype_ALL} option can be used to override this.
7785 The Darwin tools vary in their behavior when presented with an ISA
7786 mismatch.  The assembler, @file{as}, will only permit instructions to
7787 be used that are valid for the subtype of the file it is generating,
7788 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7789 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7790 and print an error if asked to create a shared library with a less
7791 restrictive subtype than its input files (for instance, trying to put
7792 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7793 for executables, @file{ld}, will quietly give the executable the most
7794 restrictive subtype of any of its input files.
7796 @table @gcctabopt
7797 @item -F@var{dir}
7798 @opindex F
7799 Add the framework directory @var{dir} to the head of the list of
7800 directories to be searched for header files.  These directories are
7801 interleaved with those specified by @option{-I} options and are
7802 scanned in a left-to-right order.
7804 A framework directory is a directory with frameworks in it.  A
7805 framework is a directory with a @samp{"Headers"} and/or
7806 @samp{"PrivateHeaders"} directory contained directly in it that ends
7807 in @samp{".framework"}.  The name of a framework is the name of this
7808 directory excluding the @samp{".framework"}.  Headers associated with
7809 the framework are found in one of those two directories, with
7810 @samp{"Headers"} being searched first.  A subframework is a framework
7811 directory that is in a framework's @samp{"Frameworks"} directory.
7812 Includes of subframework headers can only appear in a header of a
7813 framework that contains the subframework, or in a sibling subframework
7814 header.  Two subframeworks are siblings if they occur in the same
7815 framework.  A subframework should not have the same name as a
7816 framework, a warning will be issued if this is violated.  Currently a
7817 subframework cannot have subframeworks, in the future, the mechanism
7818 may be extended to support this.  The standard frameworks can be found
7819 in @samp{"/System/Library/Frameworks"} and
7820 @samp{"/Library/Frameworks"}.  An example include looks like
7821 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7822 the name of the framework and header.h is found in the
7823 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7825 @item -gused
7826 @opindex -gused
7827 Emit debugging information for symbols that are used.  For STABS
7828 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7829 This is by default ON@.
7831 @item -gfull
7832 @opindex -gfull
7833 Emit debugging information for all symbols and types.
7835 @item -mmacosx-version-min=@var{version}
7836 The earliest version of MacOS X that this executable will run on
7837 is @var{version}.  Typical values of @var{version} include @code{10.1},
7838 @code{10.2}, and @code{10.3.9}.
7840 The default for this option is to make choices that seem to be most
7841 useful.  
7843 @item -mone-byte-bool
7844 @opindex -mone-byte-bool
7845 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7846 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7847 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7848 option has no effect on x86.
7850 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7851 to generate code that is not binary compatible with code generated
7852 without that switch.  Using this switch may require recompiling all
7853 other modules in a program, including system libraries.  Use this
7854 switch to conform to a non-default data model.
7856 @item -mfix-and-continue
7857 @itemx -ffix-and-continue
7858 @itemx -findirect-data
7859 @opindex mfix-and-continue
7860 @opindex ffix-and-continue
7861 @opindex findirect-data
7862 Generate code suitable for fast turn around development.  Needed to
7863 enable gdb to dynamically load @code{.o} files into already running
7864 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7865 are provided for backwards compatibility.
7867 @item -all_load
7868 @opindex all_load
7869 Loads all members of static archive libraries.
7870 See man ld(1) for more information.
7872 @item -arch_errors_fatal
7873 @opindex arch_errors_fatal
7874 Cause the errors having to do with files that have the wrong architecture
7875 to be fatal.
7877 @item -bind_at_load
7878 @opindex bind_at_load
7879 Causes the output file to be marked such that the dynamic linker will
7880 bind all undefined references when the file is loaded or launched.
7882 @item -bundle
7883 @opindex bundle
7884 Produce a Mach-o bundle format file.
7885 See man ld(1) for more information.
7887 @item -bundle_loader @var{executable}
7888 @opindex bundle_loader
7889 This option specifies the @var{executable} that will be loading the build
7890 output file being linked.  See man ld(1) for more information.
7892 @item -dynamiclib
7893 @opindex -dynamiclib
7894 When passed this option, GCC will produce a dynamic library instead of
7895 an executable when linking, using the Darwin @file{libtool} command.
7897 @item -force_cpusubtype_ALL
7898 @opindex -force_cpusubtype_ALL
7899 This causes GCC's output file to have the @var{ALL} subtype, instead of
7900 one controlled by the @option{-mcpu} or @option{-march} option.
7902 @item -allowable_client  @var{client_name}
7903 @itemx -client_name
7904 @itemx -compatibility_version
7905 @itemx -current_version
7906 @itemx -dead_strip
7907 @itemx -dependency-file
7908 @itemx -dylib_file
7909 @itemx -dylinker_install_name
7910 @itemx -dynamic
7911 @itemx -exported_symbols_list
7912 @itemx -filelist
7913 @itemx -flat_namespace
7914 @itemx -force_flat_namespace
7915 @itemx -headerpad_max_install_names
7916 @itemx -image_base
7917 @itemx -init
7918 @itemx -install_name
7919 @itemx -keep_private_externs
7920 @itemx -multi_module
7921 @itemx -multiply_defined
7922 @itemx -multiply_defined_unused
7923 @itemx -noall_load
7924 @itemx -no_dead_strip_inits_and_terms
7925 @itemx -nofixprebinding
7926 @itemx -nomultidefs
7927 @itemx -noprebind
7928 @itemx -noseglinkedit
7929 @itemx -pagezero_size
7930 @itemx -prebind
7931 @itemx -prebind_all_twolevel_modules
7932 @itemx -private_bundle
7933 @itemx -read_only_relocs
7934 @itemx -sectalign
7935 @itemx -sectobjectsymbols
7936 @itemx -whyload
7937 @itemx -seg1addr
7938 @itemx -sectcreate
7939 @itemx -sectobjectsymbols
7940 @itemx -sectorder
7941 @itemx -segaddr
7942 @itemx -segs_read_only_addr
7943 @itemx -segs_read_write_addr
7944 @itemx -seg_addr_table
7945 @itemx -seg_addr_table_filename
7946 @itemx -seglinkedit
7947 @itemx -segprot
7948 @itemx -segs_read_only_addr
7949 @itemx -segs_read_write_addr
7950 @itemx -single_module
7951 @itemx -static
7952 @itemx -sub_library
7953 @itemx -sub_umbrella
7954 @itemx -twolevel_namespace
7955 @itemx -umbrella
7956 @itemx -undefined
7957 @itemx -unexported_symbols_list
7958 @itemx -weak_reference_mismatches
7959 @itemx -whatsloaded
7961 @opindex allowable_client
7962 @opindex client_name
7963 @opindex compatibility_version
7964 @opindex current_version
7965 @opindex dead_strip
7966 @opindex dependency-file
7967 @opindex dylib_file
7968 @opindex dylinker_install_name
7969 @opindex dynamic
7970 @opindex exported_symbols_list
7971 @opindex filelist
7972 @opindex flat_namespace
7973 @opindex force_flat_namespace
7974 @opindex headerpad_max_install_names
7975 @opindex image_base
7976 @opindex init
7977 @opindex install_name
7978 @opindex keep_private_externs
7979 @opindex multi_module
7980 @opindex multiply_defined
7981 @opindex multiply_defined_unused
7982 @opindex noall_load
7983 @opindex no_dead_strip_inits_and_terms
7984 @opindex nofixprebinding
7985 @opindex nomultidefs
7986 @opindex noprebind
7987 @opindex noseglinkedit
7988 @opindex pagezero_size
7989 @opindex prebind
7990 @opindex prebind_all_twolevel_modules
7991 @opindex private_bundle
7992 @opindex read_only_relocs
7993 @opindex sectalign
7994 @opindex sectobjectsymbols
7995 @opindex whyload
7996 @opindex seg1addr
7997 @opindex sectcreate
7998 @opindex sectobjectsymbols
7999 @opindex sectorder
8000 @opindex segaddr
8001 @opindex segs_read_only_addr
8002 @opindex segs_read_write_addr
8003 @opindex seg_addr_table
8004 @opindex seg_addr_table_filename
8005 @opindex seglinkedit
8006 @opindex segprot
8007 @opindex segs_read_only_addr
8008 @opindex segs_read_write_addr
8009 @opindex single_module
8010 @opindex static
8011 @opindex sub_library
8012 @opindex sub_umbrella
8013 @opindex twolevel_namespace
8014 @opindex umbrella
8015 @opindex undefined
8016 @opindex unexported_symbols_list
8017 @opindex weak_reference_mismatches
8018 @opindex whatsloaded
8020 These options are passed to the Darwin linker.  The Darwin linker man page
8021 describes them in detail.
8022 @end table
8024 @node DEC Alpha Options
8025 @subsection DEC Alpha Options
8027 These @samp{-m} options are defined for the DEC Alpha implementations:
8029 @table @gcctabopt
8030 @item -mno-soft-float
8031 @itemx -msoft-float
8032 @opindex mno-soft-float
8033 @opindex msoft-float
8034 Use (do not use) the hardware floating-point instructions for
8035 floating-point operations.  When @option{-msoft-float} is specified,
8036 functions in @file{libgcc.a} will be used to perform floating-point
8037 operations.  Unless they are replaced by routines that emulate the
8038 floating-point operations, or compiled in such a way as to call such
8039 emulations routines, these routines will issue floating-point
8040 operations.   If you are compiling for an Alpha without floating-point
8041 operations, you must ensure that the library is built so as not to call
8042 them.
8044 Note that Alpha implementations without floating-point operations are
8045 required to have floating-point registers.
8047 @item -mfp-reg
8048 @itemx -mno-fp-regs
8049 @opindex mfp-reg
8050 @opindex mno-fp-regs
8051 Generate code that uses (does not use) the floating-point register set.
8052 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8053 register set is not used, floating point operands are passed in integer
8054 registers as if they were integers and floating-point results are passed
8055 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8056 so any function with a floating-point argument or return value called by code
8057 compiled with @option{-mno-fp-regs} must also be compiled with that
8058 option.
8060 A typical use of this option is building a kernel that does not use,
8061 and hence need not save and restore, any floating-point registers.
8063 @item -mieee
8064 @opindex mieee
8065 The Alpha architecture implements floating-point hardware optimized for
8066 maximum performance.  It is mostly compliant with the IEEE floating
8067 point standard.  However, for full compliance, software assistance is
8068 required.  This option generates code fully IEEE compliant code
8069 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8070 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8071 defined during compilation.  The resulting code is less efficient but is
8072 able to correctly support denormalized numbers and exceptional IEEE
8073 values such as not-a-number and plus/minus infinity.  Other Alpha
8074 compilers call this option @option{-ieee_with_no_inexact}.
8076 @item -mieee-with-inexact
8077 @opindex mieee-with-inexact
8078 This is like @option{-mieee} except the generated code also maintains
8079 the IEEE @var{inexact-flag}.  Turning on this option causes the
8080 generated code to implement fully-compliant IEEE math.  In addition to
8081 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8082 macro.  On some Alpha implementations the resulting code may execute
8083 significantly slower than the code generated by default.  Since there is
8084 very little code that depends on the @var{inexact-flag}, you should
8085 normally not specify this option.  Other Alpha compilers call this
8086 option @option{-ieee_with_inexact}.
8088 @item -mfp-trap-mode=@var{trap-mode}
8089 @opindex mfp-trap-mode
8090 This option controls what floating-point related traps are enabled.
8091 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8092 The trap mode can be set to one of four values:
8094 @table @samp
8095 @item n
8096 This is the default (normal) setting.  The only traps that are enabled
8097 are the ones that cannot be disabled in software (e.g., division by zero
8098 trap).
8100 @item u
8101 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8102 as well.
8104 @item su
8105 Like @samp{su}, but the instructions are marked to be safe for software
8106 completion (see Alpha architecture manual for details).
8108 @item sui
8109 Like @samp{su}, but inexact traps are enabled as well.
8110 @end table
8112 @item -mfp-rounding-mode=@var{rounding-mode}
8113 @opindex mfp-rounding-mode
8114 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8115 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8118 @table @samp
8119 @item n
8120 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8121 the nearest machine number or towards the even machine number in case
8122 of a tie.
8124 @item m
8125 Round towards minus infinity.
8127 @item c
8128 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8130 @item d
8131 Dynamic rounding mode.  A field in the floating point control register
8132 (@var{fpcr}, see Alpha architecture reference manual) controls the
8133 rounding mode in effect.  The C library initializes this register for
8134 rounding towards plus infinity.  Thus, unless your program modifies the
8135 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8136 @end table
8138 @item -mtrap-precision=@var{trap-precision}
8139 @opindex mtrap-precision
8140 In the Alpha architecture, floating point traps are imprecise.  This
8141 means without software assistance it is impossible to recover from a
8142 floating trap and program execution normally needs to be terminated.
8143 GCC can generate code that can assist operating system trap handlers
8144 in determining the exact location that caused a floating point trap.
8145 Depending on the requirements of an application, different levels of
8146 precisions can be selected:
8148 @table @samp
8149 @item p
8150 Program precision.  This option is the default and means a trap handler
8151 can only identify which program caused a floating point exception.
8153 @item f
8154 Function precision.  The trap handler can determine the function that
8155 caused a floating point exception.
8157 @item i
8158 Instruction precision.  The trap handler can determine the exact
8159 instruction that caused a floating point exception.
8160 @end table
8162 Other Alpha compilers provide the equivalent options called
8163 @option{-scope_safe} and @option{-resumption_safe}.
8165 @item -mieee-conformant
8166 @opindex mieee-conformant
8167 This option marks the generated code as IEEE conformant.  You must not
8168 use this option unless you also specify @option{-mtrap-precision=i} and either
8169 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8170 is to emit the line @samp{.eflag 48} in the function prologue of the
8171 generated assembly file.  Under DEC Unix, this has the effect that
8172 IEEE-conformant math library routines will be linked in.
8174 @item -mbuild-constants
8175 @opindex mbuild-constants
8176 Normally GCC examines a 32- or 64-bit integer constant to
8177 see if it can construct it from smaller constants in two or three
8178 instructions.  If it cannot, it will output the constant as a literal and
8179 generate code to load it from the data segment at runtime.
8181 Use this option to require GCC to construct @emph{all} integer constants
8182 using code, even if it takes more instructions (the maximum is six).
8184 You would typically use this option to build a shared library dynamic
8185 loader.  Itself a shared library, it must relocate itself in memory
8186 before it can find the variables and constants in its own data segment.
8188 @item -malpha-as
8189 @itemx -mgas
8190 @opindex malpha-as
8191 @opindex mgas
8192 Select whether to generate code to be assembled by the vendor-supplied
8193 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8195 @item -mbwx
8196 @itemx -mno-bwx
8197 @itemx -mcix
8198 @itemx -mno-cix
8199 @itemx -mfix
8200 @itemx -mno-fix
8201 @itemx -mmax
8202 @itemx -mno-max
8203 @opindex mbwx
8204 @opindex mno-bwx
8205 @opindex mcix
8206 @opindex mno-cix
8207 @opindex mfix
8208 @opindex mno-fix
8209 @opindex mmax
8210 @opindex mno-max
8211 Indicate whether GCC should generate code to use the optional BWX,
8212 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8213 sets supported by the CPU type specified via @option{-mcpu=} option or that
8214 of the CPU on which GCC was built if none was specified.
8216 @item -mfloat-vax
8217 @itemx -mfloat-ieee
8218 @opindex mfloat-vax
8219 @opindex mfloat-ieee
8220 Generate code that uses (does not use) VAX F and G floating point
8221 arithmetic instead of IEEE single and double precision.
8223 @item -mexplicit-relocs
8224 @itemx -mno-explicit-relocs
8225 @opindex mexplicit-relocs
8226 @opindex mno-explicit-relocs
8227 Older Alpha assemblers provided no way to generate symbol relocations
8228 except via assembler macros.  Use of these macros does not allow
8229 optimal instruction scheduling.  GNU binutils as of version 2.12
8230 supports a new syntax that allows the compiler to explicitly mark
8231 which relocations should apply to which instructions.  This option
8232 is mostly useful for debugging, as GCC detects the capabilities of
8233 the assembler when it is built and sets the default accordingly.
8235 @item -msmall-data
8236 @itemx -mlarge-data
8237 @opindex msmall-data
8238 @opindex mlarge-data
8239 When @option{-mexplicit-relocs} is in effect, static data is
8240 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8241 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8242 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8243 16-bit relocations off of the @code{$gp} register.  This limits the
8244 size of the small data area to 64KB, but allows the variables to be
8245 directly accessed via a single instruction.
8247 The default is @option{-mlarge-data}.  With this option the data area
8248 is limited to just below 2GB@.  Programs that require more than 2GB of
8249 data must use @code{malloc} or @code{mmap} to allocate the data in the
8250 heap instead of in the program's data segment.
8252 When generating code for shared libraries, @option{-fpic} implies
8253 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8255 @item -msmall-text
8256 @itemx -mlarge-text
8257 @opindex msmall-text
8258 @opindex mlarge-text
8259 When @option{-msmall-text} is used, the compiler assumes that the
8260 code of the entire program (or shared library) fits in 4MB, and is
8261 thus reachable with a branch instruction.  When @option{-msmall-data}
8262 is used, the compiler can assume that all local symbols share the
8263 same @code{$gp} value, and thus reduce the number of instructions
8264 required for a function call from 4 to 1.
8266 The default is @option{-mlarge-text}.
8268 @item -mcpu=@var{cpu_type}
8269 @opindex mcpu
8270 Set the instruction set and instruction scheduling parameters for
8271 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8272 style name or the corresponding chip number.  GCC supports scheduling
8273 parameters for the EV4, EV5 and EV6 family of processors and will
8274 choose the default values for the instruction set from the processor
8275 you specify.  If you do not specify a processor type, GCC will default
8276 to the processor on which the compiler was built.
8278 Supported values for @var{cpu_type} are
8280 @table @samp
8281 @item ev4
8282 @itemx ev45
8283 @itemx 21064
8284 Schedules as an EV4 and has no instruction set extensions.
8286 @item ev5
8287 @itemx 21164
8288 Schedules as an EV5 and has no instruction set extensions.
8290 @item ev56
8291 @itemx 21164a
8292 Schedules as an EV5 and supports the BWX extension.
8294 @item pca56
8295 @itemx 21164pc
8296 @itemx 21164PC
8297 Schedules as an EV5 and supports the BWX and MAX extensions.
8299 @item ev6
8300 @itemx 21264
8301 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8303 @item ev67
8304 @itemx 21264a
8305 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8306 @end table
8308 @item -mtune=@var{cpu_type}
8309 @opindex mtune
8310 Set only the instruction scheduling parameters for machine type
8311 @var{cpu_type}.  The instruction set is not changed.
8313 @item -mmemory-latency=@var{time}
8314 @opindex mmemory-latency
8315 Sets the latency the scheduler should assume for typical memory
8316 references as seen by the application.  This number is highly
8317 dependent on the memory access patterns used by the application
8318 and the size of the external cache on the machine.
8320 Valid options for @var{time} are
8322 @table @samp
8323 @item @var{number}
8324 A decimal number representing clock cycles.
8326 @item L1
8327 @itemx L2
8328 @itemx L3
8329 @itemx main
8330 The compiler contains estimates of the number of clock cycles for
8331 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8332 (also called Dcache, Scache, and Bcache), as well as to main memory.
8333 Note that L3 is only valid for EV5.
8335 @end table
8336 @end table
8338 @node DEC Alpha/VMS Options
8339 @subsection DEC Alpha/VMS Options
8341 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8343 @table @gcctabopt
8344 @item -mvms-return-codes
8345 @opindex mvms-return-codes
8346 Return VMS condition codes from main.  The default is to return POSIX
8347 style condition (e.g.@ error) codes.
8348 @end table
8350 @node FRV Options
8351 @subsection FRV Options
8352 @cindex FRV Options
8354 @table @gcctabopt
8355 @item -mgpr-32
8356 @opindex mgpr-32
8358 Only use the first 32 general purpose registers.
8360 @item -mgpr-64
8361 @opindex mgpr-64
8363 Use all 64 general purpose registers.
8365 @item -mfpr-32
8366 @opindex mfpr-32
8368 Use only the first 32 floating point registers.
8370 @item -mfpr-64
8371 @opindex mfpr-64
8373 Use all 64 floating point registers
8375 @item -mhard-float
8376 @opindex mhard-float
8378 Use hardware instructions for floating point operations.
8380 @item -msoft-float
8381 @opindex msoft-float
8383 Use library routines for floating point operations.
8385 @item -malloc-cc
8386 @opindex malloc-cc
8388 Dynamically allocate condition code registers.
8390 @item -mfixed-cc
8391 @opindex mfixed-cc
8393 Do not try to dynamically allocate condition code registers, only
8394 use @code{icc0} and @code{fcc0}.
8396 @item -mdword
8397 @opindex mdword
8399 Change ABI to use double word insns.
8401 @item -mno-dword
8402 @opindex mno-dword
8404 Do not use double word instructions.
8406 @item -mdouble
8407 @opindex mdouble
8409 Use floating point double instructions.
8411 @item -mno-double
8412 @opindex mno-double
8414 Do not use floating point double instructions.
8416 @item -mmedia
8417 @opindex mmedia
8419 Use media instructions.
8421 @item -mno-media
8422 @opindex mno-media
8424 Do not use media instructions.
8426 @item -mmuladd
8427 @opindex mmuladd
8429 Use multiply and add/subtract instructions.
8431 @item -mno-muladd
8432 @opindex mno-muladd
8434 Do not use multiply and add/subtract instructions.
8436 @item -mfdpic
8437 @opindex mfdpic
8439 Select the FDPIC ABI, that uses function descriptors to represent
8440 pointers to functions.  Without any PIC/PIE-related options, it
8441 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8442 assumes GOT entries and small data are within a 12-bit range from the
8443 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8444 are computed with 32 bits.
8446 @item -minline-plt
8447 @opindex minline-plt
8449 Enable inlining of PLT entries in function calls to functions that are
8450 not known to bind locally.  It has no effect without @option{-mfdpic}.
8451 It's enabled by default if optimizing for speed and compiling for
8452 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8453 optimization option such as @option{-O3} or above is present in the
8454 command line.
8456 @item -mTLS
8457 @opindex TLS
8459 Assume a large TLS segment when generating thread-local code.
8461 @item -mtls
8462 @opindex tls
8464 Do not assume a large TLS segment when generating thread-local code.
8466 @item -mgprel-ro
8467 @opindex mgprel-ro
8469 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8470 that is known to be in read-only sections.  It's enabled by default,
8471 except for @option{-fpic} or @option{-fpie}: even though it may help
8472 make the global offset table smaller, it trades 1 instruction for 4.
8473 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8474 one of which may be shared by multiple symbols, and it avoids the need
8475 for a GOT entry for the referenced symbol, so it's more likely to be a
8476 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8478 @item -multilib-library-pic
8479 @opindex multilib-library-pic
8481 Link with the (library, not FD) pic libraries.  It's implied by
8482 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8483 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8484 it explicitly.
8486 @item -mlinked-fp
8487 @opindex mlinked-fp
8489 Follow the EABI requirement of always creating a frame pointer whenever
8490 a stack frame is allocated.  This option is enabled by default and can
8491 be disabled with @option{-mno-linked-fp}.
8493 @item -mlong-calls
8494 @opindex mlong-calls
8496 Use indirect addressing to call functions outside the current
8497 compilation unit.  This allows the functions to be placed anywhere
8498 within the 32-bit address space.
8500 @item -malign-labels
8501 @opindex malign-labels
8503 Try to align labels to an 8-byte boundary by inserting nops into the
8504 previous packet.  This option only has an effect when VLIW packing
8505 is enabled.  It doesn't create new packets; it merely adds nops to
8506 existing ones.
8508 @item -mlibrary-pic
8509 @opindex mlibrary-pic
8511 Generate position-independent EABI code.
8513 @item -macc-4
8514 @opindex macc-4
8516 Use only the first four media accumulator registers.
8518 @item -macc-8
8519 @opindex macc-8
8521 Use all eight media accumulator registers.
8523 @item -mpack
8524 @opindex mpack
8526 Pack VLIW instructions.
8528 @item -mno-pack
8529 @opindex mno-pack
8531 Do not pack VLIW instructions.
8533 @item -mno-eflags
8534 @opindex mno-eflags
8536 Do not mark ABI switches in e_flags.
8538 @item -mcond-move
8539 @opindex mcond-move
8541 Enable the use of conditional-move instructions (default).
8543 This switch is mainly for debugging the compiler and will likely be removed
8544 in a future version.
8546 @item -mno-cond-move
8547 @opindex mno-cond-move
8549 Disable the use of conditional-move instructions.
8551 This switch is mainly for debugging the compiler and will likely be removed
8552 in a future version.
8554 @item -mscc
8555 @opindex mscc
8557 Enable the use of conditional set instructions (default).
8559 This switch is mainly for debugging the compiler and will likely be removed
8560 in a future version.
8562 @item -mno-scc
8563 @opindex mno-scc
8565 Disable the use of conditional set instructions.
8567 This switch is mainly for debugging the compiler and will likely be removed
8568 in a future version.
8570 @item -mcond-exec
8571 @opindex mcond-exec
8573 Enable the use of conditional execution (default).
8575 This switch is mainly for debugging the compiler and will likely be removed
8576 in a future version.
8578 @item -mno-cond-exec
8579 @opindex mno-cond-exec
8581 Disable the use of conditional execution.
8583 This switch is mainly for debugging the compiler and will likely be removed
8584 in a future version.
8586 @item -mvliw-branch
8587 @opindex mvliw-branch
8589 Run a pass to pack branches into VLIW instructions (default).
8591 This switch is mainly for debugging the compiler and will likely be removed
8592 in a future version.
8594 @item -mno-vliw-branch
8595 @opindex mno-vliw-branch
8597 Do not run a pass to pack branches into VLIW instructions.
8599 This switch is mainly for debugging the compiler and will likely be removed
8600 in a future version.
8602 @item -mmulti-cond-exec
8603 @opindex mmulti-cond-exec
8605 Enable optimization of @code{&&} and @code{||} in conditional execution
8606 (default).
8608 This switch is mainly for debugging the compiler and will likely be removed
8609 in a future version.
8611 @item -mno-multi-cond-exec
8612 @opindex mno-multi-cond-exec
8614 Disable optimization of @code{&&} and @code{||} in conditional execution.
8616 This switch is mainly for debugging the compiler and will likely be removed
8617 in a future version.
8619 @item -mnested-cond-exec
8620 @opindex mnested-cond-exec
8622 Enable nested conditional execution optimizations (default).
8624 This switch is mainly for debugging the compiler and will likely be removed
8625 in a future version.
8627 @item -mno-nested-cond-exec
8628 @opindex mno-nested-cond-exec
8630 Disable nested conditional execution optimizations.
8632 This switch is mainly for debugging the compiler and will likely be removed
8633 in a future version.
8635 @item -moptimize-membar
8636 @opindex moptimize-membar
8638 This switch removes redundant @code{membar} instructions from the
8639 compiler generated code.  It is enabled by default.
8641 @item -mno-optimize-membar
8642 @opindex mno-optimize-membar
8644 This switch disables the automatic removal of redundant @code{membar}
8645 instructions from the generated code.
8647 @item -mtomcat-stats
8648 @opindex mtomcat-stats
8650 Cause gas to print out tomcat statistics.
8652 @item -mcpu=@var{cpu}
8653 @opindex mcpu
8655 Select the processor type for which to generate code.  Possible values are
8656 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8657 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8659 @end table
8661 @node H8/300 Options
8662 @subsection H8/300 Options
8664 These @samp{-m} options are defined for the H8/300 implementations:
8666 @table @gcctabopt
8667 @item -mrelax
8668 @opindex mrelax
8669 Shorten some address references at link time, when possible; uses the
8670 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8671 ld, Using ld}, for a fuller description.
8673 @item -mh
8674 @opindex mh
8675 Generate code for the H8/300H@.
8677 @item -ms
8678 @opindex ms
8679 Generate code for the H8S@.
8681 @item -mn
8682 @opindex mn
8683 Generate code for the H8S and H8/300H in the normal mode.  This switch
8684 must be used either with @option{-mh} or @option{-ms}.
8686 @item -ms2600
8687 @opindex ms2600
8688 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8690 @item -mint32
8691 @opindex mint32
8692 Make @code{int} data 32 bits by default.
8694 @item -malign-300
8695 @opindex malign-300
8696 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8697 The default for the H8/300H and H8S is to align longs and floats on 4
8698 byte boundaries.
8699 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8700 This option has no effect on the H8/300.
8701 @end table
8703 @node HPPA Options
8704 @subsection HPPA Options
8705 @cindex HPPA Options
8707 These @samp{-m} options are defined for the HPPA family of computers:
8709 @table @gcctabopt
8710 @item -march=@var{architecture-type}
8711 @opindex march
8712 Generate code for the specified architecture.  The choices for
8713 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8714 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8715 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8716 architecture option for your machine.  Code compiled for lower numbered
8717 architectures will run on higher numbered architectures, but not the
8718 other way around.
8720 @item -mpa-risc-1-0
8721 @itemx -mpa-risc-1-1
8722 @itemx -mpa-risc-2-0
8723 @opindex mpa-risc-1-0
8724 @opindex mpa-risc-1-1
8725 @opindex mpa-risc-2-0
8726 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8728 @item -mbig-switch
8729 @opindex mbig-switch
8730 Generate code suitable for big switch tables.  Use this option only if
8731 the assembler/linker complain about out of range branches within a switch
8732 table.
8734 @item -mjump-in-delay
8735 @opindex mjump-in-delay
8736 Fill delay slots of function calls with unconditional jump instructions
8737 by modifying the return pointer for the function call to be the target
8738 of the conditional jump.
8740 @item -mdisable-fpregs
8741 @opindex mdisable-fpregs
8742 Prevent floating point registers from being used in any manner.  This is
8743 necessary for compiling kernels which perform lazy context switching of
8744 floating point registers.  If you use this option and attempt to perform
8745 floating point operations, the compiler will abort.
8747 @item -mdisable-indexing
8748 @opindex mdisable-indexing
8749 Prevent the compiler from using indexing address modes.  This avoids some
8750 rather obscure problems when compiling MIG generated code under MACH@.
8752 @item -mno-space-regs
8753 @opindex mno-space-regs
8754 Generate code that assumes the target has no space registers.  This allows
8755 GCC to generate faster indirect calls and use unscaled index address modes.
8757 Such code is suitable for level 0 PA systems and kernels.
8759 @item -mfast-indirect-calls
8760 @opindex mfast-indirect-calls
8761 Generate code that assumes calls never cross space boundaries.  This
8762 allows GCC to emit code which performs faster indirect calls.
8764 This option will not work in the presence of shared libraries or nested
8765 functions.
8767 @item -mfixed-range=@var{register-range}
8768 @opindex mfixed-range
8769 Generate code treating the given register range as fixed registers.
8770 A fixed register is one that the register allocator can not use.  This is
8771 useful when compiling kernel code.  A register range is specified as
8772 two registers separated by a dash.  Multiple register ranges can be
8773 specified separated by a comma.
8775 @item -mlong-load-store
8776 @opindex mlong-load-store
8777 Generate 3-instruction load and store sequences as sometimes required by
8778 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8779 the HP compilers.
8781 @item -mportable-runtime
8782 @opindex mportable-runtime
8783 Use the portable calling conventions proposed by HP for ELF systems.
8785 @item -mgas
8786 @opindex mgas
8787 Enable the use of assembler directives only GAS understands.
8789 @item -mschedule=@var{cpu-type}
8790 @opindex mschedule
8791 Schedule code according to the constraints for the machine type
8792 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8793 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8794 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8795 proper scheduling option for your machine.  The default scheduling is
8796 @samp{8000}.
8798 @item -mlinker-opt
8799 @opindex mlinker-opt
8800 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8801 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8802 linkers in which they give bogus error messages when linking some programs.
8804 @item -msoft-float
8805 @opindex msoft-float
8806 Generate output containing library calls for floating point.
8807 @strong{Warning:} the requisite libraries are not available for all HPPA
8808 targets.  Normally the facilities of the machine's usual C compiler are
8809 used, but this cannot be done directly in cross-compilation.  You must make
8810 your own arrangements to provide suitable library functions for
8811 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8812 does provide software floating point support.
8814 @option{-msoft-float} changes the calling convention in the output file;
8815 therefore, it is only useful if you compile @emph{all} of a program with
8816 this option.  In particular, you need to compile @file{libgcc.a}, the
8817 library that comes with GCC, with @option{-msoft-float} in order for
8818 this to work.
8820 @item -msio
8821 @opindex msio
8822 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8823 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8824 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8825 options are available under HP-UX and HI-UX@.
8827 @item -mgnu-ld
8828 @opindex gnu-ld
8829 Use GNU ld specific options.  This passes @option{-shared} to ld when
8830 building a shared library.  It is the default when GCC is configured,
8831 explicitly or implicitly, with the GNU linker.  This option does not
8832 have any affect on which ld is called, it only changes what parameters
8833 are passed to that ld.  The ld that is called is determined by the
8834 @option{--with-ld} configure option, GCC's program search path, and
8835 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8836 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8837 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8839 @item -mhp-ld
8840 @opindex hp-ld
8841 Use HP ld specific options.  This passes @option{-b} to ld when building
8842 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8843 links.  It is the default when GCC is configured, explicitly or
8844 implicitly, with the HP linker.  This option does not have any affect on
8845 which ld is called, it only changes what parameters are passed to that
8846 ld.  The ld that is called is determined by the @option{--with-ld}
8847 configure option, GCC's program search path, and finally by the user's
8848 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8849 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8850 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8852 @item -mlong-calls
8853 @opindex mno-long-calls
8854 Generate code that uses long call sequences.  This ensures that a call
8855 is always able to reach linker generated stubs.  The default is to generate
8856 long calls only when the distance from the call site to the beginning
8857 of the function or translation unit, as the case may be, exceeds a
8858 predefined limit set by the branch type being used.  The limits for
8859 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8860 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8861 240,000 bytes.
8863 Distances are measured from the beginning of functions when using the
8864 @option{-ffunction-sections} option, or when using the @option{-mgas}
8865 and @option{-mno-portable-runtime} options together under HP-UX with
8866 the SOM linker.
8868 It is normally not desirable to use this option as it will degrade
8869 performance.  However, it may be useful in large applications,
8870 particularly when partial linking is used to build the application.
8872 The types of long calls used depends on the capabilities of the
8873 assembler and linker, and the type of code being generated.  The
8874 impact on systems that support long absolute calls, and long pic
8875 symbol-difference or pc-relative calls should be relatively small.
8876 However, an indirect call is used on 32-bit ELF systems in pic code
8877 and it is quite long.
8879 @item -munix=@var{unix-std}
8880 @opindex march
8881 Generate compiler predefines and select a startfile for the specified
8882 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8883 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8884 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8885 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8886 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8887 and later.
8889 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8890 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8891 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8892 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8893 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8894 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8896 It is @emph{important} to note that this option changes the interfaces
8897 for various library routines.  It also affects the operational behavior
8898 of the C library.  Thus, @emph{extreme} care is needed in using this
8899 option.
8901 Library code that is intended to operate with more than one UNIX
8902 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8903 as appropriate.  Most GNU software doesn't provide this capability.
8905 @item -nolibdld
8906 @opindex nolibdld
8907 Suppress the generation of link options to search libdld.sl when the
8908 @option{-static} option is specified on HP-UX 10 and later.
8910 @item -static
8911 @opindex static
8912 The HP-UX implementation of setlocale in libc has a dependency on
8913 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8914 when the @option{-static} option is specified, special link options
8915 are needed to resolve this dependency.
8917 On HP-UX 10 and later, the GCC driver adds the necessary options to
8918 link with libdld.sl when the @option{-static} option is specified.
8919 This causes the resulting binary to be dynamic.  On the 64-bit port,
8920 the linkers generate dynamic binaries by default in any case.  The
8921 @option{-nolibdld} option can be used to prevent the GCC driver from
8922 adding these link options.
8924 @item -threads
8925 @opindex threads
8926 Add support for multithreading with the @dfn{dce thread} library
8927 under HP-UX@.  This option sets flags for both the preprocessor and
8928 linker.
8929 @end table
8931 @node i386 and x86-64 Options
8932 @subsection Intel 386 and AMD x86-64 Options
8933 @cindex i386 Options
8934 @cindex x86-64 Options
8935 @cindex Intel 386 Options
8936 @cindex AMD x86-64 Options
8938 These @samp{-m} options are defined for the i386 and x86-64 family of
8939 computers:
8941 @table @gcctabopt
8942 @item -mtune=@var{cpu-type}
8943 @opindex mtune
8944 Tune to @var{cpu-type} everything applicable about the generated code, except
8945 for the ABI and the set of available instructions.  The choices for
8946 @var{cpu-type} are:
8947 @table @emph
8948 @item i386
8949 Original Intel's i386 CPU@.
8950 @item i486
8951 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8952 @item i586, pentium
8953 Intel Pentium CPU with no MMX support.
8954 @item pentium-mmx
8955 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8956 @item i686, pentiumpro
8957 Intel PentiumPro CPU@.
8958 @item pentium2
8959 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8960 @item pentium3, pentium3m
8961 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8962 support.
8963 @item pentium-m
8964 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8965 support.  Used by Centrino notebooks.
8966 @item pentium4, pentium4m
8967 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8968 @item prescott
8969 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8970 set support.
8971 @item nocona
8972 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8973 SSE2 and SSE3 instruction set support.
8974 @item k6
8975 AMD K6 CPU with MMX instruction set support.
8976 @item k6-2, k6-3
8977 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8978 @item athlon, athlon-tbird
8979 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8980 support.
8981 @item athlon-4, athlon-xp, athlon-mp
8982 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8983 instruction set support.
8984 @item k8, opteron, athlon64, athlon-fx
8985 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8986 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8987 @item winchip-c6
8988 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8989 set support.
8990 @item winchip2
8991 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8992 instruction set support.
8993 @item c3
8994 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8995 implemented for this chip.)
8996 @item c3-2
8997 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8998 implemented for this chip.)
8999 @end table
9001 While picking a specific @var{cpu-type} will schedule things appropriately
9002 for that particular chip, the compiler will not generate any code that
9003 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9004 being used.
9006 @item -march=@var{cpu-type}
9007 @opindex march
9008 Generate instructions for the machine type @var{cpu-type}.  The choices
9009 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9010 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9012 @item -mcpu=@var{cpu-type}
9013 @opindex mcpu
9014 A deprecated synonym for @option{-mtune}.
9016 @item -m386
9017 @itemx -m486
9018 @itemx -mpentium
9019 @itemx -mpentiumpro
9020 @opindex m386
9021 @opindex m486
9022 @opindex mpentium
9023 @opindex mpentiumpro
9024 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9025 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9026 These synonyms are deprecated.
9028 @item -mfpmath=@var{unit}
9029 @opindex march
9030 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9031 for @var{unit} are:
9033 @table @samp
9034 @item 387
9035 Use the standard 387 floating point coprocessor present majority of chips and
9036 emulated otherwise.  Code compiled with this option will run almost everywhere.
9037 The temporary results are computed in 80bit precision instead of precision
9038 specified by the type resulting in slightly different results compared to most
9039 of other chips.  See @option{-ffloat-store} for more detailed description.
9041 This is the default choice for i386 compiler.
9043 @item sse
9044 Use scalar floating point instructions present in the SSE instruction set.
9045 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9046 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9047 instruction set supports only single precision arithmetics, thus the double and
9048 extended precision arithmetics is still done using 387.  Later version, present
9049 only in Pentium4 and the future AMD x86-64 chips supports double precision
9050 arithmetics too.
9052 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9053 or @option{-msse2} switches to enable SSE extensions and make this option
9054 effective.  For the x86-64 compiler, these extensions are enabled by default.
9056 The resulting code should be considerably faster in the majority of cases and avoid
9057 the numerical instability problems of 387 code, but may break some existing
9058 code that expects temporaries to be 80bit.
9060 This is the default choice for the x86-64 compiler.
9062 @item sse,387
9063 Attempt to utilize both instruction sets at once.  This effectively double the
9064 amount of available registers and on chips with separate execution units for
9065 387 and SSE the execution resources too.  Use this option with care, as it is
9066 still experimental, because the GCC register allocator does not model separate
9067 functional units well resulting in instable performance.
9068 @end table
9070 @item -masm=@var{dialect}
9071 @opindex masm=@var{dialect}
9072 Output asm instructions using selected @var{dialect}.  Supported choices are
9073 @samp{intel} or @samp{att} (the default one).
9075 @item -mieee-fp
9076 @itemx -mno-ieee-fp
9077 @opindex mieee-fp
9078 @opindex mno-ieee-fp
9079 Control whether or not the compiler uses IEEE floating point
9080 comparisons.  These handle correctly the case where the result of a
9081 comparison is unordered.
9083 @item -msoft-float
9084 @opindex msoft-float
9085 Generate output containing library calls for floating point.
9086 @strong{Warning:} the requisite libraries are not part of GCC@.
9087 Normally the facilities of the machine's usual C compiler are used, but
9088 this can't be done directly in cross-compilation.  You must make your
9089 own arrangements to provide suitable library functions for
9090 cross-compilation.
9092 On machines where a function returns floating point results in the 80387
9093 register stack, some floating point opcodes may be emitted even if
9094 @option{-msoft-float} is used.
9096 @item -mno-fp-ret-in-387
9097 @opindex mno-fp-ret-in-387
9098 Do not use the FPU registers for return values of functions.
9100 The usual calling convention has functions return values of types
9101 @code{float} and @code{double} in an FPU register, even if there
9102 is no FPU@.  The idea is that the operating system should emulate
9103 an FPU@.
9105 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9106 in ordinary CPU registers instead.
9108 @item -mno-fancy-math-387
9109 @opindex mno-fancy-math-387
9110 Some 387 emulators do not support the @code{sin}, @code{cos} and
9111 @code{sqrt} instructions for the 387.  Specify this option to avoid
9112 generating those instructions.  This option is the default on FreeBSD,
9113 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9114 indicates that the target cpu will always have an FPU and so the
9115 instruction will not need emulation.  As of revision 2.6.1, these
9116 instructions are not generated unless you also use the
9117 @option{-funsafe-math-optimizations} switch.
9119 @item -malign-double
9120 @itemx -mno-align-double
9121 @opindex malign-double
9122 @opindex mno-align-double
9123 Control whether GCC aligns @code{double}, @code{long double}, and
9124 @code{long long} variables on a two word boundary or a one word
9125 boundary.  Aligning @code{double} variables on a two word boundary will
9126 produce code that runs somewhat faster on a @samp{Pentium} at the
9127 expense of more memory.
9129 @strong{Warning:} if you use the @option{-malign-double} switch,
9130 structures containing the above types will be aligned differently than
9131 the published application binary interface specifications for the 386
9132 and will not be binary compatible with structures in code compiled
9133 without that switch.
9135 @item -m96bit-long-double
9136 @itemx -m128bit-long-double
9137 @opindex m96bit-long-double
9138 @opindex m128bit-long-double
9139 These switches control the size of @code{long double} type.  The i386
9140 application binary interface specifies the size to be 96 bits,
9141 so @option{-m96bit-long-double} is the default in 32 bit mode.
9143 Modern architectures (Pentium and newer) would prefer @code{long double}
9144 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9145 conforming to the ABI, this would not be possible.  So specifying a
9146 @option{-m128bit-long-double} will align @code{long double}
9147 to a 16 byte boundary by padding the @code{long double} with an additional
9148 32 bit zero.
9150 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9151 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9153 Notice that neither of these options enable any extra precision over the x87
9154 standard of 80 bits for a @code{long double}.
9156 @strong{Warning:} if you override the default value for your target ABI, the
9157 structures and arrays containing @code{long double} variables will change
9158 their size as well as function calling convention for function taking
9159 @code{long double} will be modified.  Hence they will not be binary
9160 compatible with arrays or structures in code compiled without that switch.
9162 @item -mmlarge-data-threshold=@var{number}
9163 @opindex mlarge-data-threshold=@var{number}
9164 When @option{-mcmodel=medium} is specified, the data greater than
9165 @var{threshold} are placed in large data section.  This value must be the
9166 same across all object linked into the binary and defaults to 65535.
9168 @item -msvr3-shlib
9169 @itemx -mno-svr3-shlib
9170 @opindex msvr3-shlib
9171 @opindex mno-svr3-shlib
9172 Control whether GCC places uninitialized local variables into the
9173 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9174 into @code{bss}.  These options are meaningful only on System V Release 3.
9176 @item -mrtd
9177 @opindex mrtd
9178 Use a different function-calling convention, in which functions that
9179 take a fixed number of arguments return with the @code{ret} @var{num}
9180 instruction, which pops their arguments while returning.  This saves one
9181 instruction in the caller since there is no need to pop the arguments
9182 there.
9184 You can specify that an individual function is called with this calling
9185 sequence with the function attribute @samp{stdcall}.  You can also
9186 override the @option{-mrtd} option by using the function attribute
9187 @samp{cdecl}.  @xref{Function Attributes}.
9189 @strong{Warning:} this calling convention is incompatible with the one
9190 normally used on Unix, so you cannot use it if you need to call
9191 libraries compiled with the Unix compiler.
9193 Also, you must provide function prototypes for all functions that
9194 take variable numbers of arguments (including @code{printf});
9195 otherwise incorrect code will be generated for calls to those
9196 functions.
9198 In addition, seriously incorrect code will result if you call a
9199 function with too many arguments.  (Normally, extra arguments are
9200 harmlessly ignored.)
9202 @item -mregparm=@var{num}
9203 @opindex mregparm
9204 Control how many registers are used to pass integer arguments.  By
9205 default, no registers are used to pass arguments, and at most 3
9206 registers can be used.  You can control this behavior for a specific
9207 function by using the function attribute @samp{regparm}.
9208 @xref{Function Attributes}.
9210 @strong{Warning:} if you use this switch, and
9211 @var{num} is nonzero, then you must build all modules with the same
9212 value, including any libraries.  This includes the system libraries and
9213 startup modules.
9215 @item -msseregparm
9216 @opindex msseregparm
9217 Use SSE register passing conventions for float and double arguments
9218 and return values.  You can control this behavior for a specific
9219 function by using the function attribute @samp{sseregparm}.
9220 @xref{Function Attributes}.
9222 @strong{Warning:} if you use this switch then you must build all
9223 modules with the same value, including any libraries.  This includes
9224 the system libraries and startup modules.
9226 @item -mpreferred-stack-boundary=@var{num}
9227 @opindex mpreferred-stack-boundary
9228 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9229 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9230 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9231 size (@option{-Os}), in which case the default is the minimum correct
9232 alignment (4 bytes for x86, and 8 bytes for x86-64).
9234 On Pentium and PentiumPro, @code{double} and @code{long double} values
9235 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9236 suffer significant run time performance penalties.  On Pentium III, the
9237 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9238 penalties if it is not 16 byte aligned.
9240 To ensure proper alignment of this values on the stack, the stack boundary
9241 must be as aligned as that required by any value stored on the stack.
9242 Further, every function must be generated such that it keeps the stack
9243 aligned.  Thus calling a function compiled with a higher preferred
9244 stack boundary from a function compiled with a lower preferred stack
9245 boundary will most likely misalign the stack.  It is recommended that
9246 libraries that use callbacks always use the default setting.
9248 This extra alignment does consume extra stack space, and generally
9249 increases code size.  Code that is sensitive to stack space usage, such
9250 as embedded systems and operating system kernels, may want to reduce the
9251 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9253 @item -mmmx
9254 @itemx -mno-mmx
9255 @item -msse
9256 @itemx -mno-sse
9257 @item -msse2
9258 @itemx -mno-sse2
9259 @item -msse3
9260 @itemx -mno-sse3
9261 @item -m3dnow
9262 @itemx -mno-3dnow
9263 @opindex mmmx
9264 @opindex mno-mmx
9265 @opindex msse
9266 @opindex mno-sse
9267 @opindex m3dnow
9268 @opindex mno-3dnow
9269 These switches enable or disable the use of instructions in the MMX,
9270 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9271 also available as built-in functions: see @ref{X86 Built-in Functions},
9272 for details of the functions enabled and disabled by these switches.
9274 To have SSE/SSE2 instructions generated automatically from floating-point
9275 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9277 These options will enable GCC to use these extended instructions in
9278 generated code, even without @option{-mfpmath=sse}.  Applications which
9279 perform runtime CPU detection must compile separate files for each
9280 supported architecture, using the appropriate flags.  In particular,
9281 the file containing the CPU detection code should be compiled without
9282 these options.
9284 @item -mpush-args
9285 @itemx -mno-push-args
9286 @opindex mpush-args
9287 @opindex mno-push-args
9288 Use PUSH operations to store outgoing parameters.  This method is shorter
9289 and usually equally fast as method using SUB/MOV operations and is enabled
9290 by default.  In some cases disabling it may improve performance because of
9291 improved scheduling and reduced dependencies.
9293 @item -maccumulate-outgoing-args
9294 @opindex maccumulate-outgoing-args
9295 If enabled, the maximum amount of space required for outgoing arguments will be
9296 computed in the function prologue.  This is faster on most modern CPUs
9297 because of reduced dependencies, improved scheduling and reduced stack usage
9298 when preferred stack boundary is not equal to 2.  The drawback is a notable
9299 increase in code size.  This switch implies @option{-mno-push-args}.
9301 @item -mthreads
9302 @opindex mthreads
9303 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9304 on thread-safe exception handling must compile and link all code with the
9305 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9306 @option{-D_MT}; when linking, it links in a special thread helper library
9307 @option{-lmingwthrd} which cleans up per thread exception handling data.
9309 @item -mno-align-stringops
9310 @opindex mno-align-stringops
9311 Do not align destination of inlined string operations.  This switch reduces
9312 code size and improves performance in case the destination is already aligned,
9313 but GCC doesn't know about it.
9315 @item -minline-all-stringops
9316 @opindex minline-all-stringops
9317 By default GCC inlines string operations only when destination is known to be
9318 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9319 size, but may improve performance of code that depends on fast memcpy, strlen
9320 and memset for short lengths.
9322 @item -momit-leaf-frame-pointer
9323 @opindex momit-leaf-frame-pointer
9324 Don't keep the frame pointer in a register for leaf functions.  This
9325 avoids the instructions to save, set up and restore frame pointers and
9326 makes an extra register available in leaf functions.  The option
9327 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9328 which might make debugging harder.
9330 @item -mtls-direct-seg-refs
9331 @itemx -mno-tls-direct-seg-refs
9332 @opindex mtls-direct-seg-refs
9333 Controls whether TLS variables may be accessed with offsets from the
9334 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9335 or whether the thread base pointer must be added.  Whether or not this
9336 is legal depends on the operating system, and whether it maps the
9337 segment to cover the entire TLS area.
9339 For systems that use GNU libc, the default is on.
9340 @end table
9342 These @samp{-m} switches are supported in addition to the above
9343 on AMD x86-64 processors in 64-bit environments.
9345 @table @gcctabopt
9346 @item -m32
9347 @itemx -m64
9348 @opindex m32
9349 @opindex m64
9350 Generate code for a 32-bit or 64-bit environment.
9351 The 32-bit environment sets int, long and pointer to 32 bits and
9352 generates code that runs on any i386 system.
9353 The 64-bit environment sets int to 32 bits and long and pointer
9354 to 64 bits and generates code for AMD's x86-64 architecture.
9356 @item -mno-red-zone
9357 @opindex no-red-zone
9358 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9359 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9360 stack pointer that will not be modified by signal or interrupt handlers
9361 and therefore can be used for temporary data without adjusting the stack
9362 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9364 @item -mcmodel=small
9365 @opindex mcmodel=small
9366 Generate code for the small code model: the program and its symbols must
9367 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9368 Programs can be statically or dynamically linked.  This is the default
9369 code model.
9371 @item -mcmodel=kernel
9372 @opindex mcmodel=kernel
9373 Generate code for the kernel code model.  The kernel runs in the
9374 negative 2 GB of the address space.
9375 This model has to be used for Linux kernel code.
9377 @item -mcmodel=medium
9378 @opindex mcmodel=medium
9379 Generate code for the medium model: The program is linked in the lower 2
9380 GB of the address space but symbols can be located anywhere in the
9381 address space.  Programs can be statically or dynamically linked, but
9382 building of shared libraries are not supported with the medium model.
9384 @item -mcmodel=large
9385 @opindex mcmodel=large
9386 Generate code for the large model: This model makes no assumptions
9387 about addresses and sizes of sections.  Currently GCC does not implement
9388 this model.
9389 @end table
9391 @node IA-64 Options
9392 @subsection IA-64 Options
9393 @cindex IA-64 Options
9395 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9397 @table @gcctabopt
9398 @item -mbig-endian
9399 @opindex mbig-endian
9400 Generate code for a big endian target.  This is the default for HP-UX@.
9402 @item -mlittle-endian
9403 @opindex mlittle-endian
9404 Generate code for a little endian target.  This is the default for AIX5
9405 and GNU/Linux.
9407 @item -mgnu-as
9408 @itemx -mno-gnu-as
9409 @opindex mgnu-as
9410 @opindex mno-gnu-as
9411 Generate (or don't) code for the GNU assembler.  This is the default.
9412 @c Also, this is the default if the configure option @option{--with-gnu-as}
9413 @c is used.
9415 @item -mgnu-ld
9416 @itemx -mno-gnu-ld
9417 @opindex mgnu-ld
9418 @opindex mno-gnu-ld
9419 Generate (or don't) code for the GNU linker.  This is the default.
9420 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9421 @c is used.
9423 @item -mno-pic
9424 @opindex mno-pic
9425 Generate code that does not use a global pointer register.  The result
9426 is not position independent code, and violates the IA-64 ABI@.
9428 @item -mvolatile-asm-stop
9429 @itemx -mno-volatile-asm-stop
9430 @opindex mvolatile-asm-stop
9431 @opindex mno-volatile-asm-stop
9432 Generate (or don't) a stop bit immediately before and after volatile asm
9433 statements.
9435 @item -mregister-names
9436 @itemx -mno-register-names
9437 @opindex mregister-names
9438 @opindex mno-register-names
9439 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9440 the stacked registers.  This may make assembler output more readable.
9442 @item -mno-sdata
9443 @itemx -msdata
9444 @opindex mno-sdata
9445 @opindex msdata
9446 Disable (or enable) optimizations that use the small data section.  This may
9447 be useful for working around optimizer bugs.
9449 @item -mconstant-gp
9450 @opindex mconstant-gp
9451 Generate code that uses a single constant global pointer value.  This is
9452 useful when compiling kernel code.
9454 @item -mauto-pic
9455 @opindex mauto-pic
9456 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9457 This is useful when compiling firmware code.
9459 @item -minline-float-divide-min-latency
9460 @opindex minline-float-divide-min-latency
9461 Generate code for inline divides of floating point values
9462 using the minimum latency algorithm.
9464 @item -minline-float-divide-max-throughput
9465 @opindex minline-float-divide-max-throughput
9466 Generate code for inline divides of floating point values
9467 using the maximum throughput algorithm.
9469 @item -minline-int-divide-min-latency
9470 @opindex minline-int-divide-min-latency
9471 Generate code for inline divides of integer values
9472 using the minimum latency algorithm.
9474 @item -minline-int-divide-max-throughput
9475 @opindex minline-int-divide-max-throughput
9476 Generate code for inline divides of integer values
9477 using the maximum throughput algorithm.
9479 @item -minline-sqrt-min-latency
9480 @opindex minline-sqrt-min-latency
9481 Generate code for inline square roots
9482 using the minimum latency algorithm.
9484 @item -minline-sqrt-max-throughput
9485 @opindex minline-sqrt-max-throughput
9486 Generate code for inline square roots
9487 using the maximum throughput algorithm.
9489 @item -mno-dwarf2-asm
9490 @itemx -mdwarf2-asm
9491 @opindex mno-dwarf2-asm
9492 @opindex mdwarf2-asm
9493 Don't (or do) generate assembler code for the DWARF2 line number debugging
9494 info.  This may be useful when not using the GNU assembler.
9496 @item -mearly-stop-bits
9497 @itemx -mno-early-stop-bits
9498 @opindex mearly-stop-bits
9499 @opindex mno-early-stop-bits
9500 Allow stop bits to be placed earlier than immediately preceding the
9501 instruction that triggered the stop bit.  This can improve instruction
9502 scheduling, but does not always do so.
9504 @item -mfixed-range=@var{register-range}
9505 @opindex mfixed-range
9506 Generate code treating the given register range as fixed registers.
9507 A fixed register is one that the register allocator can not use.  This is
9508 useful when compiling kernel code.  A register range is specified as
9509 two registers separated by a dash.  Multiple register ranges can be
9510 specified separated by a comma.
9512 @item -mtls-size=@var{tls-size}
9513 @opindex mtls-size
9514 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9517 @item -mtune=@var{cpu-type}
9518 @opindex mtune
9519 Tune the instruction scheduling for a particular CPU, Valid values are
9520 itanium, itanium1, merced, itanium2, and mckinley.
9522 @item -mt
9523 @itemx -pthread
9524 @opindex mt
9525 @opindex pthread
9526 Add support for multithreading using the POSIX threads library.  This
9527 option sets flags for both the preprocessor and linker.  It does
9528 not affect the thread safety of object code produced by the compiler or
9529 that of libraries supplied with it.  These are HP-UX specific flags.
9531 @item -milp32
9532 @itemx -mlp64
9533 @opindex milp32
9534 @opindex mlp64
9535 Generate code for a 32-bit or 64-bit environment.
9536 The 32-bit environment sets int, long and pointer to 32 bits.
9537 The 64-bit environment sets int to 32 bits and long and pointer
9538 to 64 bits.  These are HP-UX specific flags.
9540 @end table
9542 @node M32C Options
9543 @subsection M32C Options
9544 @cindex M32C options
9546 @table @gcctabopt
9547 @item -mcpu=@var{name}
9548 @opindex mcpu=
9549 Select the CPU for which code is generated.  @var{name} may be one of
9550 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9551 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9552 the M32C/80 series.
9554 @item -msim
9555 @opindex msim
9556 Specifies that the program will be run on the simulator.  This causes
9557 an alternate runtime library to be linked in which supports, for
9558 example, file I/O.  You must not use this option when generating
9559 programs that will run on real hardware; you must provide your own
9560 runtime library for whatever I/O functions are needed.
9562 @item -memregs=@var{number}
9563 @opindex memregs=
9564 Specifies the number of memory-based pseudo-registers GCC will use
9565 during code generation.  These pseudo-registers will be used like real
9566 registers, so there is a tradeoff between GCC's ability to fit the
9567 code into available registers, and the performance penalty of using
9568 memory instead of registers.  Note that all modules in a program must
9569 be compiled with the same value for this option.  Because of that, you
9570 must not use this option with the default runtime libraries gcc
9571 builds.
9573 @end table
9575 @node M32R/D Options
9576 @subsection M32R/D Options
9577 @cindex M32R/D options
9579 These @option{-m} options are defined for Renesas M32R/D architectures:
9581 @table @gcctabopt
9582 @item -m32r2
9583 @opindex m32r2
9584 Generate code for the M32R/2@.
9586 @item -m32rx
9587 @opindex m32rx
9588 Generate code for the M32R/X@.
9590 @item -m32r
9591 @opindex m32r
9592 Generate code for the M32R@.  This is the default.
9594 @item -mmodel=small
9595 @opindex mmodel=small
9596 Assume all objects live in the lower 16MB of memory (so that their addresses
9597 can be loaded with the @code{ld24} instruction), and assume all subroutines
9598 are reachable with the @code{bl} instruction.
9599 This is the default.
9601 The addressability of a particular object can be set with the
9602 @code{model} attribute.
9604 @item -mmodel=medium
9605 @opindex mmodel=medium
9606 Assume objects may be anywhere in the 32-bit address space (the compiler
9607 will generate @code{seth/add3} instructions to load their addresses), and
9608 assume all subroutines are reachable with the @code{bl} instruction.
9610 @item -mmodel=large
9611 @opindex mmodel=large
9612 Assume objects may be anywhere in the 32-bit address space (the compiler
9613 will generate @code{seth/add3} instructions to load their addresses), and
9614 assume subroutines may not be reachable with the @code{bl} instruction
9615 (the compiler will generate the much slower @code{seth/add3/jl}
9616 instruction sequence).
9618 @item -msdata=none
9619 @opindex msdata=none
9620 Disable use of the small data area.  Variables will be put into
9621 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9622 @code{section} attribute has been specified).
9623 This is the default.
9625 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9626 Objects may be explicitly put in the small data area with the
9627 @code{section} attribute using one of these sections.
9629 @item -msdata=sdata
9630 @opindex msdata=sdata
9631 Put small global and static data in the small data area, but do not
9632 generate special code to reference them.
9634 @item -msdata=use
9635 @opindex msdata=use
9636 Put small global and static data in the small data area, and generate
9637 special instructions to reference them.
9639 @item -G @var{num}
9640 @opindex G
9641 @cindex smaller data references
9642 Put global and static objects less than or equal to @var{num} bytes
9643 into the small data or bss sections instead of the normal data or bss
9644 sections.  The default value of @var{num} is 8.
9645 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9646 for this option to have any effect.
9648 All modules should be compiled with the same @option{-G @var{num}} value.
9649 Compiling with different values of @var{num} may or may not work; if it
9650 doesn't the linker will give an error message---incorrect code will not be
9651 generated.
9653 @item -mdebug
9654 @opindex mdebug
9655 Makes the M32R specific code in the compiler display some statistics
9656 that might help in debugging programs.
9658 @item -malign-loops
9659 @opindex malign-loops
9660 Align all loops to a 32-byte boundary.
9662 @item -mno-align-loops
9663 @opindex mno-align-loops
9664 Do not enforce a 32-byte alignment for loops.  This is the default.
9666 @item -missue-rate=@var{number}
9667 @opindex missue-rate=@var{number}
9668 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9669 or 2.
9671 @item -mbranch-cost=@var{number}
9672 @opindex mbranch-cost=@var{number}
9673 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9674 preferred over conditional code, if it is 2, then the opposite will
9675 apply.
9677 @item -mflush-trap=@var{number}
9678 @opindex mflush-trap=@var{number}
9679 Specifies the trap number to use to flush the cache.  The default is
9680 12.  Valid numbers are between 0 and 15 inclusive.
9682 @item -mno-flush-trap
9683 @opindex mno-flush-trap
9684 Specifies that the cache cannot be flushed by using a trap.
9686 @item -mflush-func=@var{name}
9687 @opindex mflush-func=@var{name}
9688 Specifies the name of the operating system function to call to flush
9689 the cache.  The default is @emph{_flush_cache}, but a function call
9690 will only be used if a trap is not available.
9692 @item -mno-flush-func
9693 @opindex mno-flush-func
9694 Indicates that there is no OS function for flushing the cache.
9696 @end table
9698 @node M680x0 Options
9699 @subsection M680x0 Options
9700 @cindex M680x0 options
9702 These are the @samp{-m} options defined for the 68000 series.  The default
9703 values for these options depends on which style of 68000 was selected when
9704 the compiler was configured; the defaults for the most common choices are
9705 given below.
9707 @table @gcctabopt
9708 @item -m68000
9709 @itemx -mc68000
9710 @opindex m68000
9711 @opindex mc68000
9712 Generate output for a 68000.  This is the default
9713 when the compiler is configured for 68000-based systems.
9715 Use this option for microcontrollers with a 68000 or EC000 core,
9716 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9718 @item -m68020
9719 @itemx -mc68020
9720 @opindex m68020
9721 @opindex mc68020
9722 Generate output for a 68020.  This is the default
9723 when the compiler is configured for 68020-based systems.
9725 @item -m68881
9726 @opindex m68881
9727 Generate output containing 68881 instructions for floating point.
9728 This is the default for most 68020 systems unless @option{--nfp} was
9729 specified when the compiler was configured.
9731 @item -m68030
9732 @opindex m68030
9733 Generate output for a 68030.  This is the default when the compiler is
9734 configured for 68030-based systems.
9736 @item -m68040
9737 @opindex m68040
9738 Generate output for a 68040.  This is the default when the compiler is
9739 configured for 68040-based systems.
9741 This option inhibits the use of 68881/68882 instructions that have to be
9742 emulated by software on the 68040.  Use this option if your 68040 does not
9743 have code to emulate those instructions.
9745 @item -m68060
9746 @opindex m68060
9747 Generate output for a 68060.  This is the default when the compiler is
9748 configured for 68060-based systems.
9750 This option inhibits the use of 68020 and 68881/68882 instructions that
9751 have to be emulated by software on the 68060.  Use this option if your 68060
9752 does not have code to emulate those instructions.
9754 @item -mcpu32
9755 @opindex mcpu32
9756 Generate output for a CPU32.  This is the default
9757 when the compiler is configured for CPU32-based systems.
9759 Use this option for microcontrollers with a
9760 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9761 68336, 68340, 68341, 68349 and 68360.
9763 @item -m5200
9764 @opindex m5200
9765 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9766 when the compiler is configured for 520X-based systems.
9768 Use this option for microcontroller with a 5200 core, including
9769 the MCF5202, MCF5203, MCF5204 and MCF5202.
9772 @item -m68020-40
9773 @opindex m68020-40
9774 Generate output for a 68040, without using any of the new instructions.
9775 This results in code which can run relatively efficiently on either a
9776 68020/68881 or a 68030 or a 68040.  The generated code does use the
9777 68881 instructions that are emulated on the 68040.
9779 @item -m68020-60
9780 @opindex m68020-60
9781 Generate output for a 68060, without using any of the new instructions.
9782 This results in code which can run relatively efficiently on either a
9783 68020/68881 or a 68030 or a 68040.  The generated code does use the
9784 68881 instructions that are emulated on the 68060.
9786 @item -msoft-float
9787 @opindex msoft-float
9788 Generate output containing library calls for floating point.
9789 @strong{Warning:} the requisite libraries are not available for all m68k
9790 targets.  Normally the facilities of the machine's usual C compiler are
9791 used, but this can't be done directly in cross-compilation.  You must
9792 make your own arrangements to provide suitable library functions for
9793 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9794 @samp{m68k-*-coff} do provide software floating point support.
9796 @item -mshort
9797 @opindex mshort
9798 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9799 Additionally, parameters passed on the stack are also aligned to a
9800 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9802 @item -mnobitfield
9803 @opindex mnobitfield
9804 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9805 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9807 @item -mbitfield
9808 @opindex mbitfield
9809 Do use the bit-field instructions.  The @option{-m68020} option implies
9810 @option{-mbitfield}.  This is the default if you use a configuration
9811 designed for a 68020.
9813 @item -mrtd
9814 @opindex mrtd
9815 Use a different function-calling convention, in which functions
9816 that take a fixed number of arguments return with the @code{rtd}
9817 instruction, which pops their arguments while returning.  This
9818 saves one instruction in the caller since there is no need to pop
9819 the arguments there.
9821 This calling convention is incompatible with the one normally
9822 used on Unix, so you cannot use it if you need to call libraries
9823 compiled with the Unix compiler.
9825 Also, you must provide function prototypes for all functions that
9826 take variable numbers of arguments (including @code{printf});
9827 otherwise incorrect code will be generated for calls to those
9828 functions.
9830 In addition, seriously incorrect code will result if you call a
9831 function with too many arguments.  (Normally, extra arguments are
9832 harmlessly ignored.)
9834 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9835 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9837 @item -malign-int
9838 @itemx -mno-align-int
9839 @opindex malign-int
9840 @opindex mno-align-int
9841 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9842 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9843 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9844 Aligning variables on 32-bit boundaries produces code that runs somewhat
9845 faster on processors with 32-bit busses at the expense of more memory.
9847 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9848 align structures containing the above types  differently than
9849 most published application binary interface specifications for the m68k.
9851 @item -mpcrel
9852 @opindex mpcrel
9853 Use the pc-relative addressing mode of the 68000 directly, instead of
9854 using a global offset table.  At present, this option implies @option{-fpic},
9855 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9856 not presently supported with @option{-mpcrel}, though this could be supported for
9857 68020 and higher processors.
9859 @item -mno-strict-align
9860 @itemx -mstrict-align
9861 @opindex mno-strict-align
9862 @opindex mstrict-align
9863 Do not (do) assume that unaligned memory references will be handled by
9864 the system.
9866 @item -msep-data
9867 Generate code that allows the data segment to be located in a different
9868 area of memory from the text segment.  This allows for execute in place in
9869 an environment without virtual memory management.  This option implies
9870 @option{-fPIC}.
9872 @item -mno-sep-data
9873 Generate code that assumes that the data segment follows the text segment.
9874 This is the default.
9876 @item -mid-shared-library
9877 Generate code that supports shared libraries via the library ID method.
9878 This allows for execute in place and shared libraries in an environment
9879 without virtual memory management.  This option implies @option{-fPIC}.
9881 @item -mno-id-shared-library
9882 Generate code that doesn't assume ID based shared libraries are being used.
9883 This is the default.
9885 @item -mshared-library-id=n
9886 Specified the identification number of the ID based shared library being
9887 compiled.  Specifying a value of 0 will generate more compact code, specifying
9888 other values will force the allocation of that number to the current
9889 library but is no more space or time efficient than omitting this option.
9891 @end table
9893 @node M68hc1x Options
9894 @subsection M68hc1x Options
9895 @cindex M68hc1x options
9897 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9898 microcontrollers.  The default values for these options depends on
9899 which style of microcontroller was selected when the compiler was configured;
9900 the defaults for the most common choices are given below.
9902 @table @gcctabopt
9903 @item -m6811
9904 @itemx -m68hc11
9905 @opindex m6811
9906 @opindex m68hc11
9907 Generate output for a 68HC11.  This is the default
9908 when the compiler is configured for 68HC11-based systems.
9910 @item -m6812
9911 @itemx -m68hc12
9912 @opindex m6812
9913 @opindex m68hc12
9914 Generate output for a 68HC12.  This is the default
9915 when the compiler is configured for 68HC12-based systems.
9917 @item -m68S12
9918 @itemx -m68hcs12
9919 @opindex m68S12
9920 @opindex m68hcs12
9921 Generate output for a 68HCS12.
9923 @item -mauto-incdec
9924 @opindex mauto-incdec
9925 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9926 addressing modes.
9928 @item -minmax
9929 @itemx -nominmax
9930 @opindex minmax
9931 @opindex mnominmax
9932 Enable the use of 68HC12 min and max instructions.
9934 @item -mlong-calls
9935 @itemx -mno-long-calls
9936 @opindex mlong-calls
9937 @opindex mno-long-calls
9938 Treat all calls as being far away (near).  If calls are assumed to be
9939 far away, the compiler will use the @code{call} instruction to
9940 call a function and the @code{rtc} instruction for returning.
9942 @item -mshort
9943 @opindex mshort
9944 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9946 @item -msoft-reg-count=@var{count}
9947 @opindex msoft-reg-count
9948 Specify the number of pseudo-soft registers which are used for the
9949 code generation.  The maximum number is 32.  Using more pseudo-soft
9950 register may or may not result in better code depending on the program.
9951 The default is 4 for 68HC11 and 2 for 68HC12.
9953 @end table
9955 @node MCore Options
9956 @subsection MCore Options
9957 @cindex MCore options
9959 These are the @samp{-m} options defined for the Motorola M*Core
9960 processors.
9962 @table @gcctabopt
9964 @item -mhardlit
9965 @itemx -mno-hardlit
9966 @opindex mhardlit
9967 @opindex mno-hardlit
9968 Inline constants into the code stream if it can be done in two
9969 instructions or less.
9971 @item -mdiv
9972 @itemx -mno-div
9973 @opindex mdiv
9974 @opindex mno-div
9975 Use the divide instruction.  (Enabled by default).
9977 @item -mrelax-immediate
9978 @itemx -mno-relax-immediate
9979 @opindex mrelax-immediate
9980 @opindex mno-relax-immediate
9981 Allow arbitrary sized immediates in bit operations.
9983 @item -mwide-bitfields
9984 @itemx -mno-wide-bitfields
9985 @opindex mwide-bitfields
9986 @opindex mno-wide-bitfields
9987 Always treat bit-fields as int-sized.
9989 @item -m4byte-functions
9990 @itemx -mno-4byte-functions
9991 @opindex m4byte-functions
9992 @opindex mno-4byte-functions
9993 Force all functions to be aligned to a four byte boundary.
9995 @item -mcallgraph-data
9996 @itemx -mno-callgraph-data
9997 @opindex mcallgraph-data
9998 @opindex mno-callgraph-data
9999 Emit callgraph information.
10001 @item -mslow-bytes
10002 @itemx -mno-slow-bytes
10003 @opindex mslow-bytes
10004 @opindex mno-slow-bytes
10005 Prefer word access when reading byte quantities.
10007 @item -mlittle-endian
10008 @itemx -mbig-endian
10009 @opindex mlittle-endian
10010 @opindex mbig-endian
10011 Generate code for a little endian target.
10013 @item -m210
10014 @itemx -m340
10015 @opindex m210
10016 @opindex m340
10017 Generate code for the 210 processor.
10018 @end table
10020 @node MIPS Options
10021 @subsection MIPS Options
10022 @cindex MIPS options
10024 @table @gcctabopt
10026 @item -EB
10027 @opindex EB
10028 Generate big-endian code.
10030 @item -EL
10031 @opindex EL
10032 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10033 configurations.
10035 @item -march=@var{arch}
10036 @opindex march
10037 Generate code that will run on @var{arch}, which can be the name of a
10038 generic MIPS ISA, or the name of a particular processor.
10039 The ISA names are:
10040 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10041 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10042 The processor names are:
10043 @samp{4kc}, @samp{4km}, @samp{4kp},
10044 @samp{5kc}, @samp{5kf},
10045 @samp{20kc},
10046 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10047 @samp{m4k},
10048 @samp{orion},
10049 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10050 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10051 @samp{rm7000}, @samp{rm9000},
10052 @samp{sb1},
10053 @samp{sr71000},
10054 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10055 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10056 The special value @samp{from-abi} selects the
10057 most compatible architecture for the selected ABI (that is,
10058 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10060 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10061 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10062 @samp{vr} may be written @samp{r}.
10064 GCC defines two macros based on the value of this option.  The first
10065 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10066 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10067 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10068 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10069 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10071 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10072 above.  In other words, it will have the full prefix and will not
10073 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10074 the macro names the resolved architecture (either @samp{"mips1"} or
10075 @samp{"mips3"}).  It names the default architecture when no
10076 @option{-march} option is given.
10078 @item -mtune=@var{arch}
10079 @opindex mtune
10080 Optimize for @var{arch}.  Among other things, this option controls
10081 the way instructions are scheduled, and the perceived cost of arithmetic
10082 operations.  The list of @var{arch} values is the same as for
10083 @option{-march}.
10085 When this option is not used, GCC will optimize for the processor
10086 specified by @option{-march}.  By using @option{-march} and
10087 @option{-mtune} together, it is possible to generate code that will
10088 run on a family of processors, but optimize the code for one
10089 particular member of that family.
10091 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10092 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10093 @samp{-march} ones described above.
10095 @item -mips1
10096 @opindex mips1
10097 Equivalent to @samp{-march=mips1}.
10099 @item -mips2
10100 @opindex mips2
10101 Equivalent to @samp{-march=mips2}.
10103 @item -mips3
10104 @opindex mips3
10105 Equivalent to @samp{-march=mips3}.
10107 @item -mips4
10108 @opindex mips4
10109 Equivalent to @samp{-march=mips4}.
10111 @item -mips32
10112 @opindex mips32
10113 Equivalent to @samp{-march=mips32}.
10115 @item -mips32r2
10116 @opindex mips32r2
10117 Equivalent to @samp{-march=mips32r2}.
10119 @item -mips64
10120 @opindex mips64
10121 Equivalent to @samp{-march=mips64}.
10123 @item -mips16
10124 @itemx -mno-mips16
10125 @opindex mips16
10126 @opindex mno-mips16
10127 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10128 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10130 @item -mabi=32
10131 @itemx -mabi=o64
10132 @itemx -mabi=n32
10133 @itemx -mabi=64
10134 @itemx -mabi=eabi
10135 @opindex mabi=32
10136 @opindex mabi=o64
10137 @opindex mabi=n32
10138 @opindex mabi=64
10139 @opindex mabi=eabi
10140 Generate code for the given ABI@.
10142 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10143 generates 64-bit code when you select a 64-bit architecture, but you
10144 can use @option{-mgp32} to get 32-bit code instead.
10146 For information about the O64 ABI, see
10147 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10149 @item -mabicalls
10150 @itemx -mno-abicalls
10151 @opindex mabicalls
10152 @opindex mno-abicalls
10153 Generate (do not generate) SVR4-style position-independent code.
10154 @option{-mabicalls} is the default for SVR4-based systems.
10156 @item -mxgot
10157 @itemx -mno-xgot
10158 @opindex mxgot
10159 @opindex mno-xgot
10160 Lift (do not lift) the usual restrictions on the size of the global
10161 offset table.
10163 GCC normally uses a single instruction to load values from the GOT@.
10164 While this is relatively efficient, it will only work if the GOT
10165 is smaller than about 64k.  Anything larger will cause the linker
10166 to report an error such as:
10168 @cindex relocation truncated to fit (MIPS)
10169 @smallexample
10170 relocation truncated to fit: R_MIPS_GOT16 foobar
10171 @end smallexample
10173 If this happens, you should recompile your code with @option{-mxgot}.
10174 It should then work with very large GOTs, although it will also be
10175 less efficient, since it will take three instructions to fetch the
10176 value of a global symbol.
10178 Note that some linkers can create multiple GOTs.  If you have such a
10179 linker, you should only need to use @option{-mxgot} when a single object
10180 file accesses more than 64k's worth of GOT entries.  Very few do.
10182 These options have no effect unless GCC is generating position
10183 independent code.
10185 @item -mgp32
10186 @opindex mgp32
10187 Assume that general-purpose registers are 32 bits wide.
10189 @item -mgp64
10190 @opindex mgp64
10191 Assume that general-purpose registers are 64 bits wide.
10193 @item -mfp32
10194 @opindex mfp32
10195 Assume that floating-point registers are 32 bits wide.
10197 @item -mfp64
10198 @opindex mfp64
10199 Assume that floating-point registers are 64 bits wide.
10201 @item -mhard-float
10202 @opindex mhard-float
10203 Use floating-point coprocessor instructions.
10205 @item -msoft-float
10206 @opindex msoft-float
10207 Do not use floating-point coprocessor instructions.  Implement
10208 floating-point calculations using library calls instead.
10210 @item -msingle-float
10211 @opindex msingle-float
10212 Assume that the floating-point coprocessor only supports single-precision
10213 operations.
10215 @itemx -mdouble-float
10216 @opindex mdouble-float
10217 Assume that the floating-point coprocessor supports double-precision
10218 operations.  This is the default.
10220 @itemx -mdsp
10221 @itemx -mno-dsp
10222 @opindex mdsp
10223 @opindex mno-dsp
10224 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10226 @itemx -mpaired-single
10227 @itemx -mno-paired-single
10228 @opindex mpaired-single
10229 @opindex mno-paired-single
10230 Use (do not use) paired-single floating-point instructions.
10231 @xref{MIPS Paired-Single Support}.  This option can only be used
10232 when generating 64-bit code and requires hardware floating-point
10233 support to be enabled.
10235 @itemx -mips3d
10236 @itemx -mno-mips3d
10237 @opindex mips3d
10238 @opindex mno-mips3d
10239 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10240 The option @option{-mips3d} implies @option{-mpaired-single}.
10242 @item -mlong64
10243 @opindex mlong64
10244 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10245 an explanation of the default and the way that the pointer size is
10246 determined.
10248 @item -mlong32
10249 @opindex mlong32
10250 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10252 The default size of @code{int}s, @code{long}s and pointers depends on
10253 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10254 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10255 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10256 or the same size as integer registers, whichever is smaller.
10258 @item -msym32
10259 @itemx -mno-sym32
10260 @opindex msym32
10261 @opindex mno-sym32
10262 Assume (do not assume) that all symbols have 32-bit values, regardless
10263 of the selected ABI@.  This option is useful in combination with
10264 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10265 to generate shorter and faster references to symbolic addresses.
10267 @item -G @var{num}
10268 @opindex G
10269 @cindex smaller data references (MIPS)
10270 @cindex gp-relative references (MIPS)
10271 Put global and static items less than or equal to @var{num} bytes into
10272 the small data or bss section instead of the normal data or bss section.
10273 This allows the data to be accessed using a single instruction.
10275 All modules should be compiled with the same @option{-G @var{num}}
10276 value.
10278 @item -membedded-data
10279 @itemx -mno-embedded-data
10280 @opindex membedded-data
10281 @opindex mno-embedded-data
10282 Allocate variables to the read-only data section first if possible, then
10283 next in the small data section if possible, otherwise in data.  This gives
10284 slightly slower code than the default, but reduces the amount of RAM required
10285 when executing, and thus may be preferred for some embedded systems.
10287 @item -muninit-const-in-rodata
10288 @itemx -mno-uninit-const-in-rodata
10289 @opindex muninit-const-in-rodata
10290 @opindex mno-uninit-const-in-rodata
10291 Put uninitialized @code{const} variables in the read-only data section.
10292 This option is only meaningful in conjunction with @option{-membedded-data}.
10294 @item -msplit-addresses
10295 @itemx -mno-split-addresses
10296 @opindex msplit-addresses
10297 @opindex mno-split-addresses
10298 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10299 relocation operators.  This option has been superseded by
10300 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10302 @item -mexplicit-relocs
10303 @itemx -mno-explicit-relocs
10304 @opindex mexplicit-relocs
10305 @opindex mno-explicit-relocs
10306 Use (do not use) assembler relocation operators when dealing with symbolic
10307 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10308 is to use assembler macros instead.
10310 @option{-mexplicit-relocs} is the default if GCC was configured
10311 to use an assembler that supports relocation operators.
10313 @item -mcheck-zero-division
10314 @itemx -mno-check-zero-division
10315 @opindex mcheck-zero-division
10316 @opindex mno-check-zero-division
10317 Trap (do not trap) on integer division by zero.  The default is
10318 @option{-mcheck-zero-division}.
10320 @item -mdivide-traps
10321 @itemx -mdivide-breaks
10322 @opindex mdivide-traps
10323 @opindex mdivide-breaks
10324 MIPS systems check for division by zero by generating either a
10325 conditional trap or a break instruction.  Using traps results in
10326 smaller code, but is only supported on MIPS II and later.  Also, some
10327 versions of the Linux kernel have a bug that prevents trap from
10328 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10329 allow conditional traps on architectures that support them and
10330 @option{-mdivide-breaks} to force the use of breaks.
10332 The default is usually @option{-mdivide-traps}, but this can be
10333 overridden at configure time using @option{--with-divide=breaks}.
10334 Divide-by-zero checks can be completely disabled using
10335 @option{-mno-check-zero-division}.
10337 @item -mmemcpy
10338 @itemx -mno-memcpy
10339 @opindex mmemcpy
10340 @opindex mno-memcpy
10341 Force (do not force) the use of @code{memcpy()} for non-trivial block
10342 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10343 most constant-sized copies.
10345 @item -mlong-calls
10346 @itemx -mno-long-calls
10347 @opindex mlong-calls
10348 @opindex mno-long-calls
10349 Disable (do not disable) use of the @code{jal} instruction.  Calling
10350 functions using @code{jal} is more efficient but requires the caller
10351 and callee to be in the same 256 megabyte segment.
10353 This option has no effect on abicalls code.  The default is
10354 @option{-mno-long-calls}.
10356 @item -mmad
10357 @itemx -mno-mad
10358 @opindex mmad
10359 @opindex mno-mad
10360 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10361 instructions, as provided by the R4650 ISA@.
10363 @item -mfused-madd
10364 @itemx -mno-fused-madd
10365 @opindex mfused-madd
10366 @opindex mno-fused-madd
10367 Enable (disable) use of the floating point multiply-accumulate
10368 instructions, when they are available.  The default is
10369 @option{-mfused-madd}.
10371 When multiply-accumulate instructions are used, the intermediate
10372 product is calculated to infinite precision and is not subject to
10373 the FCSR Flush to Zero bit.  This may be undesirable in some
10374 circumstances.
10376 @item -nocpp
10377 @opindex nocpp
10378 Tell the MIPS assembler to not run its preprocessor over user
10379 assembler files (with a @samp{.s} suffix) when assembling them.
10381 @item -mfix-r4000
10382 @itemx -mno-fix-r4000
10383 @opindex mfix-r4000
10384 @opindex mno-fix-r4000
10385 Work around certain R4000 CPU errata:
10386 @itemize @minus
10387 @item
10388 A double-word or a variable shift may give an incorrect result if executed
10389 immediately after starting an integer division.
10390 @item
10391 A double-word or a variable shift may give an incorrect result if executed
10392 while an integer multiplication is in progress.
10393 @item
10394 An integer division may give an incorrect result if started in a delay slot
10395 of a taken branch or a jump.
10396 @end itemize
10398 @item -mfix-r4400
10399 @itemx -mno-fix-r4400
10400 @opindex mfix-r4400
10401 @opindex mno-fix-r4400
10402 Work around certain R4400 CPU errata:
10403 @itemize @minus
10404 @item
10405 A double-word or a variable shift may give an incorrect result if executed
10406 immediately after starting an integer division.
10407 @end itemize
10409 @item -mfix-vr4120
10410 @itemx -mno-fix-vr4120
10411 @opindex mfix-vr4120
10412 Work around certain VR4120 errata:
10413 @itemize @minus
10414 @item
10415 @code{dmultu} does not always produce the correct result.
10416 @item
10417 @code{div} and @code{ddiv} do not always produce the correct result if one
10418 of the operands is negative.
10419 @end itemize
10420 The workarounds for the division errata rely on special functions in
10421 @file{libgcc.a}.  At present, these functions are only provided by
10422 the @code{mips64vr*-elf} configurations.
10424 Other VR4120 errata require a nop to be inserted between certain pairs of
10425 instructions.  These errata are handled by the assembler, not by GCC itself.
10427 @item -mfix-vr4130
10428 @opindex mfix-vr4130
10429 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10430 workarounds are implemented by the assembler rather than by GCC,
10431 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10432 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10433 instructions are available instead.
10435 @item -mfix-sb1
10436 @itemx -mno-fix-sb1
10437 @opindex mfix-sb1
10438 Work around certain SB-1 CPU core errata.
10439 (This flag currently works around the SB-1 revision 2
10440 ``F1'' and ``F2'' floating point errata.)
10442 @item -mflush-func=@var{func}
10443 @itemx -mno-flush-func
10444 @opindex mflush-func
10445 Specifies the function to call to flush the I and D caches, or to not
10446 call any such function.  If called, the function must take the same
10447 arguments as the common @code{_flush_func()}, that is, the address of the
10448 memory range for which the cache is being flushed, the size of the
10449 memory range, and the number 3 (to flush both caches).  The default
10450 depends on the target GCC was configured for, but commonly is either
10451 @samp{_flush_func} or @samp{__cpu_flush}.
10453 @item -mbranch-likely
10454 @itemx -mno-branch-likely
10455 @opindex mbranch-likely
10456 @opindex mno-branch-likely
10457 Enable or disable use of Branch Likely instructions, regardless of the
10458 default for the selected architecture.  By default, Branch Likely
10459 instructions may be generated if they are supported by the selected
10460 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10461 and processors which implement those architectures; for those, Branch
10462 Likely instructions will not be generated by default because the MIPS32
10463 and MIPS64 architectures specifically deprecate their use.
10465 @item -mfp-exceptions
10466 @itemx -mno-fp-exceptions
10467 @opindex mfp-exceptions
10468 Specifies whether FP exceptions are enabled.  This affects how we schedule
10469 FP instructions for some processors.  The default is that FP exceptions are
10470 enabled.
10472 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10473 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10474 FP pipe.
10476 @item -mvr4130-align
10477 @itemx -mno-vr4130-align
10478 @opindex mvr4130-align
10479 The VR4130 pipeline is two-way superscalar, but can only issue two
10480 instructions together if the first one is 8-byte aligned.  When this
10481 option is enabled, GCC will align pairs of instructions that it
10482 thinks should execute in parallel.
10484 This option only has an effect when optimizing for the VR4130.
10485 It normally makes code faster, but at the expense of making it bigger.
10486 It is enabled by default at optimization level @option{-O3}.
10487 @end table
10489 @node MMIX Options
10490 @subsection MMIX Options
10491 @cindex MMIX Options
10493 These options are defined for the MMIX:
10495 @table @gcctabopt
10496 @item -mlibfuncs
10497 @itemx -mno-libfuncs
10498 @opindex mlibfuncs
10499 @opindex mno-libfuncs
10500 Specify that intrinsic library functions are being compiled, passing all
10501 values in registers, no matter the size.
10503 @item -mepsilon
10504 @itemx -mno-epsilon
10505 @opindex mepsilon
10506 @opindex mno-epsilon
10507 Generate floating-point comparison instructions that compare with respect
10508 to the @code{rE} epsilon register.
10510 @item -mabi=mmixware
10511 @itemx -mabi=gnu
10512 @opindex mabi-mmixware
10513 @opindex mabi=gnu
10514 Generate code that passes function parameters and return values that (in
10515 the called function) are seen as registers @code{$0} and up, as opposed to
10516 the GNU ABI which uses global registers @code{$231} and up.
10518 @item -mzero-extend
10519 @itemx -mno-zero-extend
10520 @opindex mzero-extend
10521 @opindex mno-zero-extend
10522 When reading data from memory in sizes shorter than 64 bits, use (do not
10523 use) zero-extending load instructions by default, rather than
10524 sign-extending ones.
10526 @item -mknuthdiv
10527 @itemx -mno-knuthdiv
10528 @opindex mknuthdiv
10529 @opindex mno-knuthdiv
10530 Make the result of a division yielding a remainder have the same sign as
10531 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10532 remainder follows the sign of the dividend.  Both methods are
10533 arithmetically valid, the latter being almost exclusively used.
10535 @item -mtoplevel-symbols
10536 @itemx -mno-toplevel-symbols
10537 @opindex mtoplevel-symbols
10538 @opindex mno-toplevel-symbols
10539 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10540 code can be used with the @code{PREFIX} assembly directive.
10542 @item -melf
10543 @opindex melf
10544 Generate an executable in the ELF format, rather than the default
10545 @samp{mmo} format used by the @command{mmix} simulator.
10547 @item -mbranch-predict
10548 @itemx -mno-branch-predict
10549 @opindex mbranch-predict
10550 @opindex mno-branch-predict
10551 Use (do not use) the probable-branch instructions, when static branch
10552 prediction indicates a probable branch.
10554 @item -mbase-addresses
10555 @itemx -mno-base-addresses
10556 @opindex mbase-addresses
10557 @opindex mno-base-addresses
10558 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10559 base address automatically generates a request (handled by the assembler
10560 and the linker) for a constant to be set up in a global register.  The
10561 register is used for one or more base address requests within the range 0
10562 to 255 from the value held in the register.  The generally leads to short
10563 and fast code, but the number of different data items that can be
10564 addressed is limited.  This means that a program that uses lots of static
10565 data may require @option{-mno-base-addresses}.
10567 @item -msingle-exit
10568 @itemx -mno-single-exit
10569 @opindex msingle-exit
10570 @opindex mno-single-exit
10571 Force (do not force) generated code to have a single exit point in each
10572 function.
10573 @end table
10575 @node MN10300 Options
10576 @subsection MN10300 Options
10577 @cindex MN10300 options
10579 These @option{-m} options are defined for Matsushita MN10300 architectures:
10581 @table @gcctabopt
10582 @item -mmult-bug
10583 @opindex mmult-bug
10584 Generate code to avoid bugs in the multiply instructions for the MN10300
10585 processors.  This is the default.
10587 @item -mno-mult-bug
10588 @opindex mno-mult-bug
10589 Do not generate code to avoid bugs in the multiply instructions for the
10590 MN10300 processors.
10592 @item -mam33
10593 @opindex mam33
10594 Generate code which uses features specific to the AM33 processor.
10596 @item -mno-am33
10597 @opindex mno-am33
10598 Do not generate code which uses features specific to the AM33 processor.  This
10599 is the default.
10601 @item -mreturn-pointer-on-d0
10602 @opindex mreturn-pointer-on-d0
10603 When generating a function which returns a pointer, return the pointer
10604 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10605 only in a0, and attempts to call such functions without a prototype
10606 would result in errors.  Note that this option is on by default; use
10607 @option{-mno-return-pointer-on-d0} to disable it.
10609 @item -mno-crt0
10610 @opindex mno-crt0
10611 Do not link in the C run-time initialization object file.
10613 @item -mrelax
10614 @opindex mrelax
10615 Indicate to the linker that it should perform a relaxation optimization pass
10616 to shorten branches, calls and absolute memory addresses.  This option only
10617 has an effect when used on the command line for the final link step.
10619 This option makes symbolic debugging impossible.
10620 @end table
10622 @node MS1 Options
10623 @subsection MS1 Options
10624 @cindex MS1 options
10626 These @option{-m} options are defined for Morpho MS1 architectures:
10628 @table @gcctabopt
10630 @item -march=@var{cpu-type}
10631 @opindex march
10632 Generate code that will run on @var{cpu-type}, which is the name of a system
10633 representing a certain processor type.  Possible values for
10634 @var{cpu-type} are @samp{MS1-64-001}, @samp{MS1-16-002}, and
10635 @samp{MS1-16-003}.
10637 When this option is not used, the default is @option{-march=MS1-16-003}.
10639 @item -mmul
10640 @opindex mmul
10641 Generate multiply instructions.
10643 @item -mno-mul
10644 @opindex mno-mul
10645 Do not generate multiply instructions.
10647 @item -mbacc
10648 @opindex mbacc
10649 Use byte loads and stores when generating code.
10651 @item -mno-bacc
10652 @opindex mno-bacc
10653 Do not use byte loads and stores when generating code.
10655 @item -msim
10656 @opindex msim
10657 Use simulator runtime
10659 @item -mno-crt0
10660 @opindex mno-crt0
10661 Do not link in the C run-time initialization object file
10662 @file{crti.o}.  Other run-time initialization and termination files
10663 such as @file{startup.o} and @file{exit.o} are still included on the
10664 linker command line.
10666 @end table
10668 @node PDP-11 Options
10669 @subsection PDP-11 Options
10670 @cindex PDP-11 Options
10672 These options are defined for the PDP-11:
10674 @table @gcctabopt
10675 @item -mfpu
10676 @opindex mfpu
10677 Use hardware FPP floating point.  This is the default.  (FIS floating
10678 point on the PDP-11/40 is not supported.)
10680 @item -msoft-float
10681 @opindex msoft-float
10682 Do not use hardware floating point.
10684 @item -mac0
10685 @opindex mac0
10686 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10688 @item -mno-ac0
10689 @opindex mno-ac0
10690 Return floating-point results in memory.  This is the default.
10692 @item -m40
10693 @opindex m40
10694 Generate code for a PDP-11/40.
10696 @item -m45
10697 @opindex m45
10698 Generate code for a PDP-11/45.  This is the default.
10700 @item -m10
10701 @opindex m10
10702 Generate code for a PDP-11/10.
10704 @item -mbcopy-builtin
10705 @opindex bcopy-builtin
10706 Use inline @code{movmemhi} patterns for copying memory.  This is the
10707 default.
10709 @item -mbcopy
10710 @opindex mbcopy
10711 Do not use inline @code{movmemhi} patterns for copying memory.
10713 @item -mint16
10714 @itemx -mno-int32
10715 @opindex mint16
10716 @opindex mno-int32
10717 Use 16-bit @code{int}.  This is the default.
10719 @item -mint32
10720 @itemx -mno-int16
10721 @opindex mint32
10722 @opindex mno-int16
10723 Use 32-bit @code{int}.
10725 @item -mfloat64
10726 @itemx -mno-float32
10727 @opindex mfloat64
10728 @opindex mno-float32
10729 Use 64-bit @code{float}.  This is the default.
10731 @item -mfloat32
10732 @itemx -mno-float64
10733 @opindex mfloat32
10734 @opindex mno-float64
10735 Use 32-bit @code{float}.
10737 @item -mabshi
10738 @opindex mabshi
10739 Use @code{abshi2} pattern.  This is the default.
10741 @item -mno-abshi
10742 @opindex mno-abshi
10743 Do not use @code{abshi2} pattern.
10745 @item -mbranch-expensive
10746 @opindex mbranch-expensive
10747 Pretend that branches are expensive.  This is for experimenting with
10748 code generation only.
10750 @item -mbranch-cheap
10751 @opindex mbranch-cheap
10752 Do not pretend that branches are expensive.  This is the default.
10754 @item -msplit
10755 @opindex msplit
10756 Generate code for a system with split I&D@.
10758 @item -mno-split
10759 @opindex mno-split
10760 Generate code for a system without split I&D@.  This is the default.
10762 @item -munix-asm
10763 @opindex munix-asm
10764 Use Unix assembler syntax.  This is the default when configured for
10765 @samp{pdp11-*-bsd}.
10767 @item -mdec-asm
10768 @opindex mdec-asm
10769 Use DEC assembler syntax.  This is the default when configured for any
10770 PDP-11 target other than @samp{pdp11-*-bsd}.
10771 @end table
10773 @node PowerPC Options
10774 @subsection PowerPC Options
10775 @cindex PowerPC options
10777 These are listed under @xref{RS/6000 and PowerPC Options}.
10779 @node RS/6000 and PowerPC Options
10780 @subsection IBM RS/6000 and PowerPC Options
10781 @cindex RS/6000 and PowerPC Options
10782 @cindex IBM RS/6000 and PowerPC Options
10784 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10785 @table @gcctabopt
10786 @item -mpower
10787 @itemx -mno-power
10788 @itemx -mpower2
10789 @itemx -mno-power2
10790 @itemx -mpowerpc
10791 @itemx -mno-powerpc
10792 @itemx -mpowerpc-gpopt
10793 @itemx -mno-powerpc-gpopt
10794 @itemx -mpowerpc-gfxopt
10795 @itemx -mno-powerpc-gfxopt
10796 @itemx -mpowerpc64
10797 @itemx -mno-powerpc64
10798 @opindex mpower
10799 @opindex mno-power
10800 @opindex mpower2
10801 @opindex mno-power2
10802 @opindex mpowerpc
10803 @opindex mno-powerpc
10804 @opindex mpowerpc-gpopt
10805 @opindex mno-powerpc-gpopt
10806 @opindex mpowerpc-gfxopt
10807 @opindex mno-powerpc-gfxopt
10808 @opindex mpowerpc64
10809 @opindex mno-powerpc64
10810 GCC supports two related instruction set architectures for the
10811 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10812 instructions supported by the @samp{rios} chip set used in the original
10813 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10814 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10815 the IBM 4xx microprocessors.
10817 Neither architecture is a subset of the other.  However there is a
10818 large common subset of instructions supported by both.  An MQ
10819 register is included in processors supporting the POWER architecture.
10821 You use these options to specify which instructions are available on the
10822 processor you are using.  The default value of these options is
10823 determined when configuring GCC@.  Specifying the
10824 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10825 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10826 rather than the options listed above.
10828 The @option{-mpower} option allows GCC to generate instructions that
10829 are found only in the POWER architecture and to use the MQ register.
10830 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10831 to generate instructions that are present in the POWER2 architecture but
10832 not the original POWER architecture.
10834 The @option{-mpowerpc} option allows GCC to generate instructions that
10835 are found only in the 32-bit subset of the PowerPC architecture.
10836 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10837 GCC to use the optional PowerPC architecture instructions in the
10838 General Purpose group, including floating-point square root.  Specifying
10839 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10840 use the optional PowerPC architecture instructions in the Graphics
10841 group, including floating-point select.
10843 The @option{-mpowerpc64} option allows GCC to generate the additional
10844 64-bit instructions that are found in the full PowerPC64 architecture
10845 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10846 @option{-mno-powerpc64}.
10848 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10849 will use only the instructions in the common subset of both
10850 architectures plus some special AIX common-mode calls, and will not use
10851 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10852 permits GCC to use any instruction from either architecture and to
10853 allow use of the MQ register; specify this for the Motorola MPC601.
10855 @item -mnew-mnemonics
10856 @itemx -mold-mnemonics
10857 @opindex mnew-mnemonics
10858 @opindex mold-mnemonics
10859 Select which mnemonics to use in the generated assembler code.  With
10860 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10861 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10862 assembler mnemonics defined for the POWER architecture.  Instructions
10863 defined in only one architecture have only one mnemonic; GCC uses that
10864 mnemonic irrespective of which of these options is specified.
10866 GCC defaults to the mnemonics appropriate for the architecture in
10867 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10868 value of these option.  Unless you are building a cross-compiler, you
10869 should normally not specify either @option{-mnew-mnemonics} or
10870 @option{-mold-mnemonics}, but should instead accept the default.
10872 @item -mcpu=@var{cpu_type}
10873 @opindex mcpu
10874 Set architecture type, register usage, choice of mnemonics, and
10875 instruction scheduling parameters for machine type @var{cpu_type}.
10876 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10877 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10878 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10879 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10880 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10881 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10882 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10883 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10884 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10886 @option{-mcpu=common} selects a completely generic processor.  Code
10887 generated under this option will run on any POWER or PowerPC processor.
10888 GCC will use only the instructions in the common subset of both
10889 architectures, and will not use the MQ register.  GCC assumes a generic
10890 processor model for scheduling purposes.
10892 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10893 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10894 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10895 types, with an appropriate, generic processor model assumed for
10896 scheduling purposes.
10898 The other options specify a specific processor.  Code generated under
10899 those options will run best on that processor, and may not run at all on
10900 others.
10902 The @option{-mcpu} options automatically enable or disable the
10903 following options: @option{-maltivec}, @option{-mhard-float},
10904 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10905 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10906 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10907 @option{-mstring}.  The particular options set for any particular CPU
10908 will vary between compiler versions, depending on what setting seems
10909 to produce optimal code for that CPU; it doesn't necessarily reflect
10910 the actual hardware's capabilities.  If you wish to set an individual
10911 option to a particular value, you may specify it after the
10912 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10914 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10915 not enabled or disabled by the @option{-mcpu} option at present, since
10916 AIX does not have full support for these options.  You may still
10917 enable or disable them individually if you're sure it'll work in your
10918 environment.
10920 @item -mtune=@var{cpu_type}
10921 @opindex mtune
10922 Set the instruction scheduling parameters for machine type
10923 @var{cpu_type}, but do not set the architecture type, register usage, or
10924 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10925 values for @var{cpu_type} are used for @option{-mtune} as for
10926 @option{-mcpu}.  If both are specified, the code generated will use the
10927 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10928 scheduling parameters set by @option{-mtune}.
10930 @item -mswdiv
10931 @itemx -mno-swdiv
10932 @opindex mswdiv
10933 @opindex mno-swdiv
10934 Generate code to compute division as reciprocal estimate and iterative
10935 refinement, creating opportunities for increased throughput.  This
10936 feature requires: optional PowerPC Graphics instruction set for single
10937 precision and FRE instruction for double precision, assuming divides
10938 cannot generate user-visible traps, and the domain values not include
10939 Infinities, denormals or zero denominator.
10941 @item -maltivec
10942 @itemx -mno-altivec
10943 @opindex maltivec
10944 @opindex mno-altivec
10945 Generate code that uses (does not use) AltiVec instructions, and also
10946 enable the use of built-in functions that allow more direct access to
10947 the AltiVec instruction set.  You may also need to set
10948 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10949 enhancements.
10951 @item -mvrsave
10952 @item -mno-vrsave
10953 @opindex mvrsave
10954 @opindex mno-vrsave
10955 Generate VRSAVE instructions when generating AltiVec code.
10957 @item -mabi=spe
10958 @opindex mabi=spe
10959 Extend the current ABI with SPE ABI extensions.  This does not change
10960 the default ABI, instead it adds the SPE ABI extensions to the current
10961 ABI@.
10963 @item -mabi=no-spe
10964 @opindex mabi=no-spe
10965 Disable Booke SPE ABI extensions for the current ABI@.
10967 @item -msecure-plt
10968 @opindex msecure-plt
10969 Generate code that allows ld and ld.so to build executables and shared
10970 libraries with non-exec .plt and .got sections.  This is a PowerPC
10971 32-bit SYSV ABI option.
10973 @item -mbss-plt
10974 @opindex mbss-plt
10975 Generate code that uses a BSS .plt section that ld.so fills in, and
10976 requires .plt and .got sections that are both writable and executable.
10977 This is a PowerPC 32-bit SYSV ABI option.
10979 @item -misel
10980 @itemx -mno-isel
10981 @opindex misel
10982 @opindex mno-isel
10983 This switch enables or disables the generation of ISEL instructions.
10985 @item -misel=@var{yes/no}
10986 This switch has been deprecated.  Use @option{-misel} and
10987 @option{-mno-isel} instead.
10989 @item -mspe
10990 @itemx -mno-isel
10991 @opindex mspe
10992 @opindex mno-spe
10993 This switch enables or disables the generation of SPE simd
10994 instructions.
10996 @item -mspe=@var{yes/no}
10997 This option has been deprecated.  Use @option{-mspe} and
10998 @option{-mno-spe} instead.
11000 @item -mfloat-gprs=@var{yes/single/double/no}
11001 @itemx -mfloat-gprs
11002 @opindex mfloat-gprs
11003 This switch enables or disables the generation of floating point
11004 operations on the general purpose registers for architectures that
11005 support it.
11007 The argument @var{yes} or @var{single} enables the use of
11008 single-precision floating point operations.
11010 The argument @var{double} enables the use of single and
11011 double-precision floating point operations.
11013 The argument @var{no} disables floating point operations on the
11014 general purpose registers.
11016 This option is currently only available on the MPC854x.
11018 @item -m32
11019 @itemx -m64
11020 @opindex m32
11021 @opindex m64
11022 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11023 targets (including GNU/Linux).  The 32-bit environment sets int, long
11024 and pointer to 32 bits and generates code that runs on any PowerPC
11025 variant.  The 64-bit environment sets int to 32 bits and long and
11026 pointer to 64 bits, and generates code for PowerPC64, as for
11027 @option{-mpowerpc64}.
11029 @item -mfull-toc
11030 @itemx -mno-fp-in-toc
11031 @itemx -mno-sum-in-toc
11032 @itemx -mminimal-toc
11033 @opindex mfull-toc
11034 @opindex mno-fp-in-toc
11035 @opindex mno-sum-in-toc
11036 @opindex mminimal-toc
11037 Modify generation of the TOC (Table Of Contents), which is created for
11038 every executable file.  The @option{-mfull-toc} option is selected by
11039 default.  In that case, GCC will allocate at least one TOC entry for
11040 each unique non-automatic variable reference in your program.  GCC
11041 will also place floating-point constants in the TOC@.  However, only
11042 16,384 entries are available in the TOC@.
11044 If you receive a linker error message that saying you have overflowed
11045 the available TOC space, you can reduce the amount of TOC space used
11046 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11047 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11048 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11049 generate code to calculate the sum of an address and a constant at
11050 run-time instead of putting that sum into the TOC@.  You may specify one
11051 or both of these options.  Each causes GCC to produce very slightly
11052 slower and larger code at the expense of conserving TOC space.
11054 If you still run out of space in the TOC even when you specify both of
11055 these options, specify @option{-mminimal-toc} instead.  This option causes
11056 GCC to make only one TOC entry for every file.  When you specify this
11057 option, GCC will produce code that is slower and larger but which
11058 uses extremely little TOC space.  You may wish to use this option
11059 only on files that contain less frequently executed code.
11061 @item -maix64
11062 @itemx -maix32
11063 @opindex maix64
11064 @opindex maix32
11065 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11066 @code{long} type, and the infrastructure needed to support them.
11067 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11068 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11069 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11071 @item -mxl-compat
11072 @itemx -mno-xl-compat
11073 @opindex mxl-compat
11074 @opindex mno-xl-compat
11075 Produce code that conforms more closely to IBM XLC semantics when using
11076 AIX-compatible ABI.  Pass floating-point arguments to prototyped
11077 functions beyond the register save area (RSA) on the stack in addition
11078 to argument FPRs.  Do not assume that most significant double in 128
11079 bit long double value is properly rounded when comparing values.
11081 The AIX calling convention was extended but not initially documented to
11082 handle an obscure K&R C case of calling a function that takes the
11083 address of its arguments with fewer arguments than declared.  AIX XL
11084 compilers access floating point arguments which do not fit in the
11085 RSA from the stack when a subroutine is compiled without
11086 optimization.  Because always storing floating-point arguments on the
11087 stack is inefficient and rarely needed, this option is not enabled by
11088 default and only is necessary when calling subroutines compiled by AIX
11089 XL compilers without optimization.
11091 @item -mpe
11092 @opindex mpe
11093 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11094 application written to use message passing with special startup code to
11095 enable the application to run.  The system must have PE installed in the
11096 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11097 must be overridden with the @option{-specs=} option to specify the
11098 appropriate directory location.  The Parallel Environment does not
11099 support threads, so the @option{-mpe} option and the @option{-pthread}
11100 option are incompatible.
11102 @item -malign-natural
11103 @itemx -malign-power
11104 @opindex malign-natural
11105 @opindex malign-power
11106 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11107 @option{-malign-natural} overrides the ABI-defined alignment of larger
11108 types, such as floating-point doubles, on their natural size-based boundary.
11109 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11110 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11112 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11113 is not supported.
11115 @item -msoft-float
11116 @itemx -mhard-float
11117 @opindex msoft-float
11118 @opindex mhard-float
11119 Generate code that does not use (uses) the floating-point register set.
11120 Software floating point emulation is provided if you use the
11121 @option{-msoft-float} option, and pass the option to GCC when linking.
11123 @item -mmultiple
11124 @itemx -mno-multiple
11125 @opindex mmultiple
11126 @opindex mno-multiple
11127 Generate code that uses (does not use) the load multiple word
11128 instructions and the store multiple word instructions.  These
11129 instructions are generated by default on POWER systems, and not
11130 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11131 endian PowerPC systems, since those instructions do not work when the
11132 processor is in little endian mode.  The exceptions are PPC740 and
11133 PPC750 which permit the instructions usage in little endian mode.
11135 @item -mstring
11136 @itemx -mno-string
11137 @opindex mstring
11138 @opindex mno-string
11139 Generate code that uses (does not use) the load string instructions
11140 and the store string word instructions to save multiple registers and
11141 do small block moves.  These instructions are generated by default on
11142 POWER systems, and not generated on PowerPC systems.  Do not use
11143 @option{-mstring} on little endian PowerPC systems, since those
11144 instructions do not work when the processor is in little endian mode.
11145 The exceptions are PPC740 and PPC750 which permit the instructions
11146 usage in little endian mode.
11148 @item -mupdate
11149 @itemx -mno-update
11150 @opindex mupdate
11151 @opindex mno-update
11152 Generate code that uses (does not use) the load or store instructions
11153 that update the base register to the address of the calculated memory
11154 location.  These instructions are generated by default.  If you use
11155 @option{-mno-update}, there is a small window between the time that the
11156 stack pointer is updated and the address of the previous frame is
11157 stored, which means code that walks the stack frame across interrupts or
11158 signals may get corrupted data.
11160 @item -mfused-madd
11161 @itemx -mno-fused-madd
11162 @opindex mfused-madd
11163 @opindex mno-fused-madd
11164 Generate code that uses (does not use) the floating point multiply and
11165 accumulate instructions.  These instructions are generated by default if
11166 hardware floating is used.
11168 @item -mno-bit-align
11169 @itemx -mbit-align
11170 @opindex mno-bit-align
11171 @opindex mbit-align
11172 On System V.4 and embedded PowerPC systems do not (do) force structures
11173 and unions that contain bit-fields to be aligned to the base type of the
11174 bit-field.
11176 For example, by default a structure containing nothing but 8
11177 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11178 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11179 the structure would be aligned to a 1 byte boundary and be one byte in
11180 size.
11182 @item -mno-strict-align
11183 @itemx -mstrict-align
11184 @opindex mno-strict-align
11185 @opindex mstrict-align
11186 On System V.4 and embedded PowerPC systems do not (do) assume that
11187 unaligned memory references will be handled by the system.
11189 @item -mrelocatable
11190 @itemx -mno-relocatable
11191 @opindex mrelocatable
11192 @opindex mno-relocatable
11193 On embedded PowerPC systems generate code that allows (does not allow)
11194 the program to be relocated to a different address at runtime.  If you
11195 use @option{-mrelocatable} on any module, all objects linked together must
11196 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11198 @item -mrelocatable-lib
11199 @itemx -mno-relocatable-lib
11200 @opindex mrelocatable-lib
11201 @opindex mno-relocatable-lib
11202 On embedded PowerPC systems generate code that allows (does not allow)
11203 the program to be relocated to a different address at runtime.  Modules
11204 compiled with @option{-mrelocatable-lib} can be linked with either modules
11205 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11206 with modules compiled with the @option{-mrelocatable} options.
11208 @item -mno-toc
11209 @itemx -mtoc
11210 @opindex mno-toc
11211 @opindex mtoc
11212 On System V.4 and embedded PowerPC systems do not (do) assume that
11213 register 2 contains a pointer to a global area pointing to the addresses
11214 used in the program.
11216 @item -mlittle
11217 @itemx -mlittle-endian
11218 @opindex mlittle
11219 @opindex mlittle-endian
11220 On System V.4 and embedded PowerPC systems compile code for the
11221 processor in little endian mode.  The @option{-mlittle-endian} option is
11222 the same as @option{-mlittle}.
11224 @item -mbig
11225 @itemx -mbig-endian
11226 @opindex mbig
11227 @opindex mbig-endian
11228 On System V.4 and embedded PowerPC systems compile code for the
11229 processor in big endian mode.  The @option{-mbig-endian} option is
11230 the same as @option{-mbig}.
11232 @item -mdynamic-no-pic
11233 @opindex mdynamic-no-pic
11234 On Darwin and Mac OS X systems, compile code so that it is not
11235 relocatable, but that its external references are relocatable.  The
11236 resulting code is suitable for applications, but not shared
11237 libraries.
11239 @item -mprioritize-restricted-insns=@var{priority}
11240 @opindex mprioritize-restricted-insns
11241 This option controls the priority that is assigned to
11242 dispatch-slot restricted instructions during the second scheduling
11243 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11244 @var{no/highest/second-highest} priority to dispatch slot restricted
11245 instructions.
11247 @item -msched-costly-dep=@var{dependence_type}
11248 @opindex msched-costly-dep
11249 This option controls which dependences are considered costly
11250 by the target during instruction scheduling.  The argument
11251 @var{dependence_type} takes one of the following values:
11252 @var{no}: no dependence is costly,
11253 @var{all}: all dependences are costly,
11254 @var{true_store_to_load}: a true dependence from store to load is costly,
11255 @var{store_to_load}: any dependence from store to load is costly,
11256 @var{number}: any dependence which latency >= @var{number} is costly.
11258 @item -minsert-sched-nops=@var{scheme}
11259 @opindex minsert-sched-nops
11260 This option controls which nop insertion scheme will be used during
11261 the second scheduling pass.  The argument @var{scheme} takes one of the
11262 following values:
11263 @var{no}: Don't insert nops.
11264 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11265 according to the scheduler's grouping.
11266 @var{regroup_exact}: Insert nops to force costly dependent insns into
11267 separate groups.  Insert exactly as many nops as needed to force an insn
11268 to a new group, according to the estimated processor grouping.
11269 @var{number}: Insert nops to force costly dependent insns into
11270 separate groups.  Insert @var{number} nops to force an insn to a new group.
11272 @item -mcall-sysv
11273 @opindex mcall-sysv
11274 On System V.4 and embedded PowerPC systems compile code using calling
11275 conventions that adheres to the March 1995 draft of the System V
11276 Application Binary Interface, PowerPC processor supplement.  This is the
11277 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11279 @item -mcall-sysv-eabi
11280 @opindex mcall-sysv-eabi
11281 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11283 @item -mcall-sysv-noeabi
11284 @opindex mcall-sysv-noeabi
11285 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11287 @item -mcall-solaris
11288 @opindex mcall-solaris
11289 On System V.4 and embedded PowerPC systems compile code for the Solaris
11290 operating system.
11292 @item -mcall-linux
11293 @opindex mcall-linux
11294 On System V.4 and embedded PowerPC systems compile code for the
11295 Linux-based GNU system.
11297 @item -mcall-gnu
11298 @opindex mcall-gnu
11299 On System V.4 and embedded PowerPC systems compile code for the
11300 Hurd-based GNU system.
11302 @item -mcall-netbsd
11303 @opindex mcall-netbsd
11304 On System V.4 and embedded PowerPC systems compile code for the
11305 NetBSD operating system.
11307 @item -maix-struct-return
11308 @opindex maix-struct-return
11309 Return all structures in memory (as specified by the AIX ABI)@.
11311 @item -msvr4-struct-return
11312 @opindex msvr4-struct-return
11313 Return structures smaller than 8 bytes in registers (as specified by the
11314 SVR4 ABI)@.
11316 @item -mabi=@var{abi-type}
11317 @opindex mabi
11318 Extend the current ABI with a particular extension, or remove such extension.
11319 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11320 @var{no-spe}@.
11322 @item -mprototype
11323 @itemx -mno-prototype
11324 @opindex mprototype
11325 @opindex mno-prototype
11326 On System V.4 and embedded PowerPC systems assume that all calls to
11327 variable argument functions are properly prototyped.  Otherwise, the
11328 compiler must insert an instruction before every non prototyped call to
11329 set or clear bit 6 of the condition code register (@var{CR}) to
11330 indicate whether floating point values were passed in the floating point
11331 registers in case the function takes a variable arguments.  With
11332 @option{-mprototype}, only calls to prototyped variable argument functions
11333 will set or clear the bit.
11335 @item -msim
11336 @opindex msim
11337 On embedded PowerPC systems, assume that the startup module is called
11338 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11339 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11340 configurations.
11342 @item -mmvme
11343 @opindex mmvme
11344 On embedded PowerPC systems, assume that the startup module is called
11345 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11346 @file{libc.a}.
11348 @item -mads
11349 @opindex mads
11350 On embedded PowerPC systems, assume that the startup module is called
11351 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11352 @file{libc.a}.
11354 @item -myellowknife
11355 @opindex myellowknife
11356 On embedded PowerPC systems, assume that the startup module is called
11357 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11358 @file{libc.a}.
11360 @item -mvxworks
11361 @opindex mvxworks
11362 On System V.4 and embedded PowerPC systems, specify that you are
11363 compiling for a VxWorks system.
11365 @item -mwindiss
11366 @opindex mwindiss
11367 Specify that you are compiling for the WindISS simulation environment.
11369 @item -memb
11370 @opindex memb
11371 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11372 header to indicate that @samp{eabi} extended relocations are used.
11374 @item -meabi
11375 @itemx -mno-eabi
11376 @opindex meabi
11377 @opindex mno-eabi
11378 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11379 Embedded Applications Binary Interface (eabi) which is a set of
11380 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11381 means that the stack is aligned to an 8 byte boundary, a function
11382 @code{__eabi} is called to from @code{main} to set up the eabi
11383 environment, and the @option{-msdata} option can use both @code{r2} and
11384 @code{r13} to point to two separate small data areas.  Selecting
11385 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11386 do not call an initialization function from @code{main}, and the
11387 @option{-msdata} option will only use @code{r13} to point to a single
11388 small data area.  The @option{-meabi} option is on by default if you
11389 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11391 @item -msdata=eabi
11392 @opindex msdata=eabi
11393 On System V.4 and embedded PowerPC systems, put small initialized
11394 @code{const} global and static data in the @samp{.sdata2} section, which
11395 is pointed to by register @code{r2}.  Put small initialized
11396 non-@code{const} global and static data in the @samp{.sdata} section,
11397 which is pointed to by register @code{r13}.  Put small uninitialized
11398 global and static data in the @samp{.sbss} section, which is adjacent to
11399 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11400 incompatible with the @option{-mrelocatable} option.  The
11401 @option{-msdata=eabi} option also sets the @option{-memb} option.
11403 @item -msdata=sysv
11404 @opindex msdata=sysv
11405 On System V.4 and embedded PowerPC systems, put small global and static
11406 data in the @samp{.sdata} section, which is pointed to by register
11407 @code{r13}.  Put small uninitialized global and static data in the
11408 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11409 The @option{-msdata=sysv} option is incompatible with the
11410 @option{-mrelocatable} option.
11412 @item -msdata=default
11413 @itemx -msdata
11414 @opindex msdata=default
11415 @opindex msdata
11416 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11417 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11418 same as @option{-msdata=sysv}.
11420 @item -msdata-data
11421 @opindex msdata-data
11422 On System V.4 and embedded PowerPC systems, put small global and static
11423 data in the @samp{.sdata} section.  Put small uninitialized global and
11424 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11425 to address small data however.  This is the default behavior unless
11426 other @option{-msdata} options are used.
11428 @item -msdata=none
11429 @itemx -mno-sdata
11430 @opindex msdata=none
11431 @opindex mno-sdata
11432 On embedded PowerPC systems, put all initialized global and static data
11433 in the @samp{.data} section, and all uninitialized data in the
11434 @samp{.bss} section.
11436 @item -G @var{num}
11437 @opindex G
11438 @cindex smaller data references (PowerPC)
11439 @cindex .sdata/.sdata2 references (PowerPC)
11440 On embedded PowerPC systems, put global and static items less than or
11441 equal to @var{num} bytes into the small data or bss sections instead of
11442 the normal data or bss section.  By default, @var{num} is 8.  The
11443 @option{-G @var{num}} switch is also passed to the linker.
11444 All modules should be compiled with the same @option{-G @var{num}} value.
11446 @item -mregnames
11447 @itemx -mno-regnames
11448 @opindex mregnames
11449 @opindex mno-regnames
11450 On System V.4 and embedded PowerPC systems do (do not) emit register
11451 names in the assembly language output using symbolic forms.
11453 @item -mlongcall
11454 @itemx -mno-longcall
11455 @opindex mlongcall
11456 @opindex mno-longcall
11457 Default to making all function calls indirectly, using a register, so
11458 that functions which reside further than 32 megabytes (33,554,432
11459 bytes) from the current location can be called.  This setting can be
11460 overridden by the @code{shortcall} function attribute, or by
11461 @code{#pragma longcall(0)}.
11463 Some linkers are capable of detecting out-of-range calls and generating
11464 glue code on the fly.  On these systems, long calls are unnecessary and
11465 generate slower code.  As of this writing, the AIX linker can do this,
11466 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11467 to the GNU linker for 32-bit PowerPC systems as well.
11469 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11470 callee, L42'', plus a ``branch island'' (glue code).  The two target
11471 addresses represent the callee and the ``branch island''.  The
11472 Darwin/PPC linker will prefer the first address and generate a ``bl
11473 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11474 otherwise, the linker will generate ``bl L42'' to call the ``branch
11475 island''.  The ``branch island'' is appended to the body of the
11476 calling function; it computes the full 32-bit address of the callee
11477 and jumps to it.
11479 On Mach-O (Darwin) systems, this option directs the compiler emit to
11480 the glue for every direct call, and the Darwin linker decides whether
11481 to use or discard it.
11483 In the future, we may cause GCC to ignore all longcall specifications
11484 when the linker is known to generate glue.
11486 @item -pthread
11487 @opindex pthread
11488 Adds support for multithreading with the @dfn{pthreads} library.
11489 This option sets flags for both the preprocessor and linker.
11491 @end table
11493 @node S/390 and zSeries Options
11494 @subsection S/390 and zSeries Options
11495 @cindex S/390 and zSeries Options
11497 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11499 @table @gcctabopt
11500 @item -mhard-float
11501 @itemx -msoft-float
11502 @opindex mhard-float
11503 @opindex msoft-float
11504 Use (do not use) the hardware floating-point instructions and registers
11505 for floating-point operations.  When @option{-msoft-float} is specified,
11506 functions in @file{libgcc.a} will be used to perform floating-point
11507 operations.  When @option{-mhard-float} is specified, the compiler
11508 generates IEEE floating-point instructions.  This is the default.
11510 @item -mbackchain
11511 @itemx -mno-backchain
11512 @opindex mbackchain
11513 @opindex mno-backchain
11514 Store (do not store) the address of the caller's frame as backchain pointer
11515 into the callee's stack frame.
11516 A backchain may be needed to allow debugging using tools that do not understand
11517 DWARF-2 call frame information.
11518 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11519 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11520 the backchain is placed into the topmost word of the 96/160 byte register
11521 save area.
11523 In general, code compiled with @option{-mbackchain} is call-compatible with
11524 code compiled with @option{-mmo-backchain}; however, use of the backchain
11525 for debugging purposes usually requires that the whole binary is built with
11526 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11527 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11528 to build a linux kernel use @option{-msoft-float}.
11530 The default is to not maintain the backchain.
11532 @item -mpacked-stack
11533 @item -mno-packed-stack
11534 @opindex mpacked-stack
11535 @opindex mno-packed-stack
11536 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11537 specified, the compiler uses the all fields of the 96/160 byte register save
11538 area only for their default purpose; unused fields still take up stack space.
11539 When @option{-mpacked-stack} is specified, register save slots are densely
11540 packed at the top of the register save area; unused space is reused for other
11541 purposes, allowing for more efficient use of the available stack space.
11542 However, when @option{-mbackchain} is also in effect, the topmost word of
11543 the save area is always used to store the backchain, and the return address
11544 register is always saved two words below the backchain.
11546 As long as the stack frame backchain is not used, code generated with
11547 @option{-mpacked-stack} is call-compatible with code generated with
11548 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11549 S/390 or zSeries generated code that uses the stack frame backchain at run
11550 time, not just for debugging purposes.  Such code is not call-compatible
11551 with code compiled with @option{-mpacked-stack}.  Also, note that the
11552 combination of @option{-mbackchain},
11553 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11554 to build a linux kernel use @option{-msoft-float}.
11556 The default is to not use the packed stack layout.
11558 @item -msmall-exec
11559 @itemx -mno-small-exec
11560 @opindex msmall-exec
11561 @opindex mno-small-exec
11562 Generate (or do not generate) code using the @code{bras} instruction
11563 to do subroutine calls.
11564 This only works reliably if the total executable size does not
11565 exceed 64k.  The default is to use the @code{basr} instruction instead,
11566 which does not have this limitation.
11568 @item -m64
11569 @itemx -m31
11570 @opindex m64
11571 @opindex m31
11572 When @option{-m31} is specified, generate code compliant to the
11573 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11574 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11575 particular to generate 64-bit instructions.  For the @samp{s390}
11576 targets, the default is @option{-m31}, while the @samp{s390x}
11577 targets default to @option{-m64}.
11579 @item -mzarch
11580 @itemx -mesa
11581 @opindex mzarch
11582 @opindex mesa
11583 When @option{-mzarch} is specified, generate code using the
11584 instructions available on z/Architecture.
11585 When @option{-mesa} is specified, generate code using the
11586 instructions available on ESA/390.  Note that @option{-mesa} is
11587 not possible with @option{-m64}.
11588 When generating code compliant to the GNU/Linux for S/390 ABI,
11589 the default is @option{-mesa}.  When generating code compliant
11590 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11592 @item -mmvcle
11593 @itemx -mno-mvcle
11594 @opindex mmvcle
11595 @opindex mno-mvcle
11596 Generate (or do not generate) code using the @code{mvcle} instruction
11597 to perform block moves.  When @option{-mno-mvcle} is specified,
11598 use a @code{mvc} loop instead.  This is the default unless optimizing for
11599 size.
11601 @item -mdebug
11602 @itemx -mno-debug
11603 @opindex mdebug
11604 @opindex mno-debug
11605 Print (or do not print) additional debug information when compiling.
11606 The default is to not print debug information.
11608 @item -march=@var{cpu-type}
11609 @opindex march
11610 Generate code that will run on @var{cpu-type}, which is the name of a system
11611 representing a certain processor type.  Possible values for
11612 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11613 When generating code using the instructions available on z/Architecture,
11614 the default is @option{-march=z900}.  Otherwise, the default is
11615 @option{-march=g5}.
11617 @item -mtune=@var{cpu-type}
11618 @opindex mtune
11619 Tune to @var{cpu-type} everything applicable about the generated code,
11620 except for the ABI and the set of available instructions.
11621 The list of @var{cpu-type} values is the same as for @option{-march}.
11622 The default is the value used for @option{-march}.
11624 @item -mtpf-trace
11625 @itemx -mno-tpf-trace
11626 @opindex mtpf-trace
11627 @opindex mno-tpf-trace
11628 Generate code that adds (does not add) in TPF OS specific branches to trace
11629 routines in the operating system.  This option is off by default, even
11630 when compiling for the TPF OS@.
11632 @item -mfused-madd
11633 @itemx -mno-fused-madd
11634 @opindex mfused-madd
11635 @opindex mno-fused-madd
11636 Generate code that uses (does not use) the floating point multiply and
11637 accumulate instructions.  These instructions are generated by default if
11638 hardware floating point is used.
11640 @item -mwarn-framesize=@var{framesize}
11641 @opindex mwarn-framesize
11642 Emit a warning if the current function exceeds the given frame size.  Because
11643 this is a compile time check it doesn't need to be a real problem when the program
11644 runs.  It is intended to identify functions which most probably cause
11645 a stack overflow.  It is useful to be used in an environment with limited stack
11646 size e.g.@: the linux kernel.
11648 @item -mwarn-dynamicstack
11649 @opindex mwarn-dynamicstack
11650 Emit a warning if the function calls alloca or uses dynamically
11651 sized arrays.  This is generally a bad idea with a limited stack size.
11653 @item -mstack-guard=@var{stack-guard}
11654 @item -mstack-size=@var{stack-size}
11655 @opindex mstack-guard
11656 @opindex mstack-size
11657 These arguments always have to be used in conjunction.  If they are present the s390
11658 back end emits additional instructions in the function prologue which trigger a trap
11659 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11660 (remember that the stack on s390 grows downward).  These options are intended to
11661 be used to help debugging stack overflow problems.  The additionally emitted code
11662 causes only little overhead and hence can also be used in production like systems
11663 without greater performance degradation.  The given values have to be exact
11664 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11665 exceeding 64k.
11666 In order to be efficient the extra code makes the assumption that the stack starts
11667 at an address aligned to the value given by @var{stack-size}.
11668 @end table
11670 @node SH Options
11671 @subsection SH Options
11673 These @samp{-m} options are defined for the SH implementations:
11675 @table @gcctabopt
11676 @item -m1
11677 @opindex m1
11678 Generate code for the SH1.
11680 @item -m2
11681 @opindex m2
11682 Generate code for the SH2.
11684 @item -m2e
11685 Generate code for the SH2e.
11687 @item -m3
11688 @opindex m3
11689 Generate code for the SH3.
11691 @item -m3e
11692 @opindex m3e
11693 Generate code for the SH3e.
11695 @item -m4-nofpu
11696 @opindex m4-nofpu
11697 Generate code for the SH4 without a floating-point unit.
11699 @item -m4-single-only
11700 @opindex m4-single-only
11701 Generate code for the SH4 with a floating-point unit that only
11702 supports single-precision arithmetic.
11704 @item -m4-single
11705 @opindex m4-single
11706 Generate code for the SH4 assuming the floating-point unit is in
11707 single-precision mode by default.
11709 @item -m4
11710 @opindex m4
11711 Generate code for the SH4.
11713 @item -m4a-nofpu
11714 @opindex m4a-nofpu
11715 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11716 floating-point unit is not used.
11718 @item -m4a-single-only
11719 @opindex m4a-single-only
11720 Generate code for the SH4a, in such a way that no double-precision
11721 floating point operations are used.
11723 @item -m4a-single
11724 @opindex m4a-single
11725 Generate code for the SH4a assuming the floating-point unit is in
11726 single-precision mode by default.
11728 @item -m4a
11729 @opindex m4a
11730 Generate code for the SH4a.
11732 @item -m4al
11733 @opindex m4al
11734 Same as @option{-m4a-nofpu}, except that it implicitly passes
11735 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11736 instructions at the moment.
11738 @item -mb
11739 @opindex mb
11740 Compile code for the processor in big endian mode.
11742 @item -ml
11743 @opindex ml
11744 Compile code for the processor in little endian mode.
11746 @item -mdalign
11747 @opindex mdalign
11748 Align doubles at 64-bit boundaries.  Note that this changes the calling
11749 conventions, and thus some functions from the standard C library will
11750 not work unless you recompile it first with @option{-mdalign}.
11752 @item -mrelax
11753 @opindex mrelax
11754 Shorten some address references at link time, when possible; uses the
11755 linker option @option{-relax}.
11757 @item -mbigtable
11758 @opindex mbigtable
11759 Use 32-bit offsets in @code{switch} tables.  The default is to use
11760 16-bit offsets.
11762 @item -mfmovd
11763 @opindex mfmovd
11764 Enable the use of the instruction @code{fmovd}.
11766 @item -mhitachi
11767 @opindex mhitachi
11768 Comply with the calling conventions defined by Renesas.
11770 @item -mrenesas
11771 @opindex mhitachi
11772 Comply with the calling conventions defined by Renesas.
11774 @item -mno-renesas
11775 @opindex mhitachi
11776 Comply with the calling conventions defined for GCC before the Renesas
11777 conventions were available.  This option is the default for all
11778 targets of the SH toolchain except for @samp{sh-symbianelf}.
11780 @item -mnomacsave
11781 @opindex mnomacsave
11782 Mark the @code{MAC} register as call-clobbered, even if
11783 @option{-mhitachi} is given.
11785 @item -mieee
11786 @opindex mieee
11787 Increase IEEE-compliance of floating-point code.
11788 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11789 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11790 comparisons of NANs / infinities incurs extra overhead in every
11791 floating point comparison, therefore the default is set to
11792 @option{-ffinite-math-only}.
11794 @item -misize
11795 @opindex misize
11796 Dump instruction size and location in the assembly code.
11798 @item -mpadstruct
11799 @opindex mpadstruct
11800 This option is deprecated.  It pads structures to multiple of 4 bytes,
11801 which is incompatible with the SH ABI@.
11803 @item -mspace
11804 @opindex mspace
11805 Optimize for space instead of speed.  Implied by @option{-Os}.
11807 @item -mprefergot
11808 @opindex mprefergot
11809 When generating position-independent code, emit function calls using
11810 the Global Offset Table instead of the Procedure Linkage Table.
11812 @item -musermode
11813 @opindex musermode
11814 Generate a library function call to invalidate instruction cache
11815 entries, after fixing up a trampoline.  This library function call
11816 doesn't assume it can write to the whole memory address space.  This
11817 is the default when the target is @code{sh-*-linux*}.
11819 @item -multcost=@var{number}
11820 @opindex multcost=@var{number}
11821 Set the cost to assume for a multiply insn.
11823 @item -mdiv=@var{strategy}
11824 @opindex mdiv=@var{strategy}
11825 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11826 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11827 inv:call2, inv:fp .
11828 "fp" performs the operation in floating point.  This has a very high latency,
11829 but needs only a few instructions, so it might be a good choice if
11830 your code has enough easily exploitable ILP to allow the compiler to
11831 schedule the floating point instructions together with other instructions.
11832 Division by zero causes a floating point exception.
11833 "inv" uses integer operations to calculate the inverse of the divisor,
11834 and then multiplies the dividend with the inverse.  This strategy allows
11835 cse and hoisting of the inverse calculation.  Division by zero calculates
11836 an unspecified result, but does not trap.
11837 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11838 have been found, or if the entire operation has been hoisted to the same
11839 place, the last stages of the inverse calculation are intertwined with the
11840 final multiply to reduce the overall latency, at the expense of using a few
11841 more instructions, and thus offering fewer scheduling opportunities with
11842 other code.
11843 "call" calls a library function that usually implements the inv:minlat
11844 strategy.
11845 This gives high code density for m5-*media-nofpu compilations.
11846 "call2" uses a different entry point of the same library function, where it
11847 assumes that a pointer to a lookup table has already been set up, which
11848 exposes the pointer load to cse / code hoisting optimizations.
11849 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11850 code generation, but if the code stays unoptimized, revert to the "call",
11851 "call2", or "fp" strategies, respectively.  Note that the
11852 potentially-trapping side effect of division by zero is carried by a
11853 separate instruction, so it is possible that all the integer instructions
11854 are hoisted out, but the marker for the side effect stays where it is.
11855 A recombination to fp operations or a call is not possible in that case.
11856 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11857 that the inverse calculation was nor separated from the multiply, they speed
11858 up division where the dividend fits into 20 bits (plus sign where applicable),
11859 by inserting a test to skip a number of operations in this case; this test
11860 slows down the case of larger dividends.  inv20u assumes the case of a such
11861 a small dividend to be unlikely, and inv20l assumes it to be likely.
11863 @item -mdivsi3_libfunc=@var{name}
11864 @opindex mdivsi3_libfunc=@var{name}
11865 Set the name of the library function used for 32 bit signed division to
11866 @var{name}.  This only affect the name used in the call and inv:call
11867 division strategies, and the compiler will still expect the same
11868 sets of input/output/clobbered registers as if this option was not present.
11870 @item -madjust-unroll
11871 @opindex madjust-unroll
11872 Throttle unrolling to avoid thrashing target registers.
11873 This option only has an effect if the gcc code base supports the
11874 TARGET_ADJUST_UNROLL_MAX target hook.
11876 @item -mindexed-addressing
11877 @opindex mindexed-addressing
11878 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11879 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11880 semantics for the indexed addressing mode.  The architecture allows the
11881 implementation of processors with 64 bit MMU, which the OS could use to
11882 get 32 bit addressing, but since no current hardware implementation supports
11883 this or any other way to make the indexed addressing mode safe to use in
11884 the 32 bit ABI, the default is -mno-indexed-addressing.
11886 @item -mgettrcost=@var{number}
11887 @opindex mgettrcost=@var{number}
11888 Set the cost assumed for the gettr instruction to @var{number}.
11889 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11891 @item -mpt-fixed
11892 @opindex mpt-fixed
11893 Assume pt* instructions won't trap.  This will generally generate better
11894 scheduled code, but is unsafe on current hardware.  The current architecture
11895 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11896 This has the unintentional effect of making it unsafe to schedule ptabs /
11897 ptrel before a branch, or hoist it out of a loop.  For example,
11898 __do_global_ctors, a part of libgcc that runs constructors at program
11899 startup, calls functions in a list which is delimited by -1.  With the
11900 -mpt-fixed option, the ptabs will be done before testing against -1.
11901 That means that all the constructors will be run a bit quicker, but when
11902 the loop comes to the end of the list, the program crashes because ptabs
11903 loads -1 into a target register.  Since this option is unsafe for any
11904 hardware implementing the current architecture specification, the default
11905 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11906 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11907 this deters register allocation using target registers for storing
11908 ordinary integers.
11910 @item -minvalid-symbols
11911 @opindex minvalid-symbols
11912 Assume symbols might be invalid.  Ordinary function symbols generated by
11913 the compiler will always be valid to load with movi/shori/ptabs or
11914 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11915 to generate symbols that will cause ptabs / ptrel to trap.
11916 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11917 It will then prevent cross-basic-block cse, hoisting and most scheduling
11918 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11919 @end table
11921 @node SPARC Options
11922 @subsection SPARC Options
11923 @cindex SPARC options
11925 These @samp{-m} options are supported on the SPARC:
11927 @table @gcctabopt
11928 @item -mno-app-regs
11929 @itemx -mapp-regs
11930 @opindex mno-app-regs
11931 @opindex mapp-regs
11932 Specify @option{-mapp-regs} to generate output using the global registers
11933 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11934 is the default.
11936 To be fully SVR4 ABI compliant at the cost of some performance loss,
11937 specify @option{-mno-app-regs}.  You should compile libraries and system
11938 software with this option.
11940 @item -mfpu
11941 @itemx -mhard-float
11942 @opindex mfpu
11943 @opindex mhard-float
11944 Generate output containing floating point instructions.  This is the
11945 default.
11947 @item -mno-fpu
11948 @itemx -msoft-float
11949 @opindex mno-fpu
11950 @opindex msoft-float
11951 Generate output containing library calls for floating point.
11952 @strong{Warning:} the requisite libraries are not available for all SPARC
11953 targets.  Normally the facilities of the machine's usual C compiler are
11954 used, but this cannot be done directly in cross-compilation.  You must make
11955 your own arrangements to provide suitable library functions for
11956 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11957 @samp{sparclite-*-*} do provide software floating point support.
11959 @option{-msoft-float} changes the calling convention in the output file;
11960 therefore, it is only useful if you compile @emph{all} of a program with
11961 this option.  In particular, you need to compile @file{libgcc.a}, the
11962 library that comes with GCC, with @option{-msoft-float} in order for
11963 this to work.
11965 @item -mhard-quad-float
11966 @opindex mhard-quad-float
11967 Generate output containing quad-word (long double) floating point
11968 instructions.
11970 @item -msoft-quad-float
11971 @opindex msoft-quad-float
11972 Generate output containing library calls for quad-word (long double)
11973 floating point instructions.  The functions called are those specified
11974 in the SPARC ABI@.  This is the default.
11976 As of this writing, there are no SPARC implementations that have hardware
11977 support for the quad-word floating point instructions.  They all invoke
11978 a trap handler for one of these instructions, and then the trap handler
11979 emulates the effect of the instruction.  Because of the trap handler overhead,
11980 this is much slower than calling the ABI library routines.  Thus the
11981 @option{-msoft-quad-float} option is the default.
11983 @item -mno-unaligned-doubles
11984 @itemx -munaligned-doubles
11985 @opindex mno-unaligned-doubles
11986 @opindex munaligned-doubles
11987 Assume that doubles have 8 byte alignment.  This is the default.
11989 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11990 alignment only if they are contained in another type, or if they have an
11991 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11992 Specifying this option avoids some rare compatibility problems with code
11993 generated by other compilers.  It is not the default because it results
11994 in a performance loss, especially for floating point code.
11996 @item -mno-faster-structs
11997 @itemx -mfaster-structs
11998 @opindex mno-faster-structs
11999 @opindex mfaster-structs
12000 With @option{-mfaster-structs}, the compiler assumes that structures
12001 should have 8 byte alignment.  This enables the use of pairs of
12002 @code{ldd} and @code{std} instructions for copies in structure
12003 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12004 However, the use of this changed alignment directly violates the SPARC
12005 ABI@.  Thus, it's intended only for use on targets where the developer
12006 acknowledges that their resulting code will not be directly in line with
12007 the rules of the ABI@.
12009 @item -mimpure-text
12010 @opindex mimpure-text
12011 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12012 the compiler to not pass @option{-z text} to the linker when linking a
12013 shared object.  Using this option, you can link position-dependent
12014 code into a shared object.
12016 @option{-mimpure-text} suppresses the ``relocations remain against
12017 allocatable but non-writable sections'' linker error message.
12018 However, the necessary relocations will trigger copy-on-write, and the
12019 shared object is not actually shared across processes.  Instead of
12020 using @option{-mimpure-text}, you should compile all source code with
12021 @option{-fpic} or @option{-fPIC}.
12023 This option is only available on SunOS and Solaris.
12025 @item -mcpu=@var{cpu_type}
12026 @opindex mcpu
12027 Set the instruction set, register set, and instruction scheduling parameters
12028 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12029 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12030 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12031 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12032 @samp{ultrasparc3}.
12034 Default instruction scheduling parameters are used for values that select
12035 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12036 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12038 Here is a list of each supported architecture and their supported
12039 implementations.
12041 @smallexample
12042     v7:             cypress
12043     v8:             supersparc, hypersparc
12044     sparclite:      f930, f934, sparclite86x
12045     sparclet:       tsc701
12046     v9:             ultrasparc, ultrasparc3
12047 @end smallexample
12049 By default (unless configured otherwise), GCC generates code for the V7
12050 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12051 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12052 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12053 SPARCStation 1, 2, IPX etc.
12055 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12056 architecture.  The only difference from V7 code is that the compiler emits
12057 the integer multiply and integer divide instructions which exist in SPARC-V8
12058 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12059 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12060 2000 series.
12062 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12063 the SPARC architecture.  This adds the integer multiply, integer divide step
12064 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12065 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12066 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12067 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12068 MB86934 chip, which is the more recent SPARClite with FPU@.
12070 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12071 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12072 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12073 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12074 optimizes it for the TEMIC SPARClet chip.
12076 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12077 architecture.  This adds 64-bit integer and floating-point move instructions,
12078 3 additional floating-point condition code registers and conditional move
12079 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12080 optimizes it for the Sun UltraSPARC I/II chips.  With
12081 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12082 Sun UltraSPARC III chip.
12084 @item -mtune=@var{cpu_type}
12085 @opindex mtune
12086 Set the instruction scheduling parameters for machine type
12087 @var{cpu_type}, but do not set the instruction set or register set that the
12088 option @option{-mcpu=@var{cpu_type}} would.
12090 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12091 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12092 that select a particular cpu implementation.  Those are @samp{cypress},
12093 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12094 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12095 @samp{ultrasparc3}.
12097 @item -mv8plus
12098 @itemx -mno-v8plus
12099 @opindex mv8plus
12100 @opindex mno-v8plus
12101 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12102 difference from the V8 ABI is that the global and out registers are
12103 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12104 mode for all SPARC-V9 processors.
12106 @item -mvis
12107 @itemx -mno-vis
12108 @opindex mvis
12109 @opindex mno-vis
12110 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12111 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12112 @end table
12114 These @samp{-m} options are supported in addition to the above
12115 on SPARC-V9 processors in 64-bit environments:
12117 @table @gcctabopt
12118 @item -mlittle-endian
12119 @opindex mlittle-endian
12120 Generate code for a processor running in little-endian mode.  It is only
12121 available for a few configurations and most notably not on Solaris and Linux.
12123 @item -m32
12124 @itemx -m64
12125 @opindex m32
12126 @opindex m64
12127 Generate code for a 32-bit or 64-bit environment.
12128 The 32-bit environment sets int, long and pointer to 32 bits.
12129 The 64-bit environment sets int to 32 bits and long and pointer
12130 to 64 bits.
12132 @item -mcmodel=medlow
12133 @opindex mcmodel=medlow
12134 Generate code for the Medium/Low code model: 64-bit addresses, programs
12135 must be linked in the low 32 bits of memory.  Programs can be statically
12136 or dynamically linked.
12138 @item -mcmodel=medmid
12139 @opindex mcmodel=medmid
12140 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12141 must be linked in the low 44 bits of memory, the text and data segments must
12142 be less than 2GB in size and the data segment must be located within 2GB of
12143 the text segment.
12145 @item -mcmodel=medany
12146 @opindex mcmodel=medany
12147 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12148 may be linked anywhere in memory, the text and data segments must be less
12149 than 2GB in size and the data segment must be located within 2GB of the
12150 text segment.
12152 @item -mcmodel=embmedany
12153 @opindex mcmodel=embmedany
12154 Generate code for the Medium/Anywhere code model for embedded systems:
12155 64-bit addresses, the text and data segments must be less than 2GB in
12156 size, both starting anywhere in memory (determined at link time).  The
12157 global register %g4 points to the base of the data segment.  Programs
12158 are statically linked and PIC is not supported.
12160 @item -mstack-bias
12161 @itemx -mno-stack-bias
12162 @opindex mstack-bias
12163 @opindex mno-stack-bias
12164 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12165 frame pointer if present, are offset by @minus{}2047 which must be added back
12166 when making stack frame references.  This is the default in 64-bit mode.
12167 Otherwise, assume no such offset is present.
12168 @end table
12170 These switches are supported in addition to the above on Solaris:
12172 @table @gcctabopt
12173 @item -threads
12174 @opindex threads
12175 Add support for multithreading using the Solaris threads library.  This
12176 option sets flags for both the preprocessor and linker.  This option does
12177 not affect the thread safety of object code produced by the compiler or
12178 that of libraries supplied with it.
12180 @item -pthreads
12181 @opindex pthreads
12182 Add support for multithreading using the POSIX threads library.  This
12183 option sets flags for both the preprocessor and linker.  This option does
12184 not affect the thread safety of object code produced  by the compiler or
12185 that of libraries supplied with it.
12186 @end table
12188 @node System V Options
12189 @subsection Options for System V
12191 These additional options are available on System V Release 4 for
12192 compatibility with other compilers on those systems:
12194 @table @gcctabopt
12195 @item -G
12196 @opindex G
12197 Create a shared object.
12198 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12200 @item -Qy
12201 @opindex Qy
12202 Identify the versions of each tool used by the compiler, in a
12203 @code{.ident} assembler directive in the output.
12205 @item -Qn
12206 @opindex Qn
12207 Refrain from adding @code{.ident} directives to the output file (this is
12208 the default).
12210 @item -YP,@var{dirs}
12211 @opindex YP
12212 Search the directories @var{dirs}, and no others, for libraries
12213 specified with @option{-l}.
12215 @item -Ym,@var{dir}
12216 @opindex Ym
12217 Look in the directory @var{dir} to find the M4 preprocessor.
12218 The assembler uses this option.
12219 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12220 @c the generic assembler that comes with Solaris takes just -Ym.
12221 @end table
12223 @node TMS320C3x/C4x Options
12224 @subsection TMS320C3x/C4x Options
12225 @cindex TMS320C3x/C4x Options
12227 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12229 @table @gcctabopt
12231 @item -mcpu=@var{cpu_type}
12232 @opindex mcpu
12233 Set the instruction set, register set, and instruction scheduling
12234 parameters for machine type @var{cpu_type}.  Supported values for
12235 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12236 @samp{c44}.  The default is @samp{c40} to generate code for the
12237 TMS320C40.
12239 @item -mbig-memory
12240 @itemx -mbig
12241 @itemx -msmall-memory
12242 @itemx -msmall
12243 @opindex mbig-memory
12244 @opindex mbig
12245 @opindex msmall-memory
12246 @opindex msmall
12247 Generates code for the big or small memory model.  The small memory
12248 model assumed that all data fits into one 64K word page.  At run-time
12249 the data page (DP) register must be set to point to the 64K page
12250 containing the .bss and .data program sections.  The big memory model is
12251 the default and requires reloading of the DP register for every direct
12252 memory access.
12254 @item -mbk
12255 @itemx -mno-bk
12256 @opindex mbk
12257 @opindex mno-bk
12258 Allow (disallow) allocation of general integer operands into the block
12259 count register BK@.
12261 @item -mdb
12262 @itemx -mno-db
12263 @opindex mdb
12264 @opindex mno-db
12265 Enable (disable) generation of code using decrement and branch,
12266 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12267 on the safe side, this is disabled for the C3x, since the maximum
12268 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12269 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12270 that it can utilize the decrement and branch instruction, but will give
12271 up if there is more than one memory reference in the loop.  Thus a loop
12272 where the loop counter is decremented can generate slightly more
12273 efficient code, in cases where the RPTB instruction cannot be utilized.
12275 @item -mdp-isr-reload
12276 @itemx -mparanoid
12277 @opindex mdp-isr-reload
12278 @opindex mparanoid
12279 Force the DP register to be saved on entry to an interrupt service
12280 routine (ISR), reloaded to point to the data section, and restored on
12281 exit from the ISR@.  This should not be required unless someone has
12282 violated the small memory model by modifying the DP register, say within
12283 an object library.
12285 @item -mmpyi
12286 @itemx -mno-mpyi
12287 @opindex mmpyi
12288 @opindex mno-mpyi
12289 For the C3x use the 24-bit MPYI instruction for integer multiplies
12290 instead of a library call to guarantee 32-bit results.  Note that if one
12291 of the operands is a constant, then the multiplication will be performed
12292 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12293 then squaring operations are performed inline instead of a library call.
12295 @item -mfast-fix
12296 @itemx -mno-fast-fix
12297 @opindex mfast-fix
12298 @opindex mno-fast-fix
12299 The C3x/C4x FIX instruction to convert a floating point value to an
12300 integer value chooses the nearest integer less than or equal to the
12301 floating point value rather than to the nearest integer.  Thus if the
12302 floating point number is negative, the result will be incorrectly
12303 truncated an additional code is necessary to detect and correct this
12304 case.  This option can be used to disable generation of the additional
12305 code required to correct the result.
12307 @item -mrptb
12308 @itemx -mno-rptb
12309 @opindex mrptb
12310 @opindex mno-rptb
12311 Enable (disable) generation of repeat block sequences using the RPTB
12312 instruction for zero overhead looping.  The RPTB construct is only used
12313 for innermost loops that do not call functions or jump across the loop
12314 boundaries.  There is no advantage having nested RPTB loops due to the
12315 overhead required to save and restore the RC, RS, and RE registers.
12316 This is enabled by default with @option{-O2}.
12318 @item -mrpts=@var{count}
12319 @itemx -mno-rpts
12320 @opindex mrpts
12321 @opindex mno-rpts
12322 Enable (disable) the use of the single instruction repeat instruction
12323 RPTS@.  If a repeat block contains a single instruction, and the loop
12324 count can be guaranteed to be less than the value @var{count}, GCC will
12325 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12326 then a RPTS will be emitted even if the loop count cannot be determined
12327 at compile time.  Note that the repeated instruction following RPTS does
12328 not have to be reloaded from memory each iteration, thus freeing up the
12329 CPU buses for operands.  However, since interrupts are blocked by this
12330 instruction, it is disabled by default.
12332 @item -mloop-unsigned
12333 @itemx -mno-loop-unsigned
12334 @opindex mloop-unsigned
12335 @opindex mno-loop-unsigned
12336 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12337 is @math{2^{31} + 1} since these instructions test if the iteration count is
12338 negative to terminate the loop.  If the iteration count is unsigned
12339 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12340 exceeded.  This switch allows an unsigned iteration count.
12342 @item -mti
12343 @opindex mti
12344 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12345 with.  This also enforces compatibility with the API employed by the TI
12346 C3x C compiler.  For example, long doubles are passed as structures
12347 rather than in floating point registers.
12349 @item -mregparm
12350 @itemx -mmemparm
12351 @opindex mregparm
12352 @opindex mmemparm
12353 Generate code that uses registers (stack) for passing arguments to functions.
12354 By default, arguments are passed in registers where possible rather
12355 than by pushing arguments on to the stack.
12357 @item -mparallel-insns
12358 @itemx -mno-parallel-insns
12359 @opindex mparallel-insns
12360 @opindex mno-parallel-insns
12361 Allow the generation of parallel instructions.  This is enabled by
12362 default with @option{-O2}.
12364 @item -mparallel-mpy
12365 @itemx -mno-parallel-mpy
12366 @opindex mparallel-mpy
12367 @opindex mno-parallel-mpy
12368 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12369 provided @option{-mparallel-insns} is also specified.  These instructions have
12370 tight register constraints which can pessimize the code generation
12371 of large functions.
12373 @end table
12375 @node V850 Options
12376 @subsection V850 Options
12377 @cindex V850 Options
12379 These @samp{-m} options are defined for V850 implementations:
12381 @table @gcctabopt
12382 @item -mlong-calls
12383 @itemx -mno-long-calls
12384 @opindex mlong-calls
12385 @opindex mno-long-calls
12386 Treat all calls as being far away (near).  If calls are assumed to be
12387 far away, the compiler will always load the functions address up into a
12388 register, and call indirect through the pointer.
12390 @item -mno-ep
12391 @itemx -mep
12392 @opindex mno-ep
12393 @opindex mep
12394 Do not optimize (do optimize) basic blocks that use the same index
12395 pointer 4 or more times to copy pointer into the @code{ep} register, and
12396 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12397 option is on by default if you optimize.
12399 @item -mno-prolog-function
12400 @itemx -mprolog-function
12401 @opindex mno-prolog-function
12402 @opindex mprolog-function
12403 Do not use (do use) external functions to save and restore registers
12404 at the prologue and epilogue of a function.  The external functions
12405 are slower, but use less code space if more than one function saves
12406 the same number of registers.  The @option{-mprolog-function} option
12407 is on by default if you optimize.
12409 @item -mspace
12410 @opindex mspace
12411 Try to make the code as small as possible.  At present, this just turns
12412 on the @option{-mep} and @option{-mprolog-function} options.
12414 @item -mtda=@var{n}
12415 @opindex mtda
12416 Put static or global variables whose size is @var{n} bytes or less into
12417 the tiny data area that register @code{ep} points to.  The tiny data
12418 area can hold up to 256 bytes in total (128 bytes for byte references).
12420 @item -msda=@var{n}
12421 @opindex msda
12422 Put static or global variables whose size is @var{n} bytes or less into
12423 the small data area that register @code{gp} points to.  The small data
12424 area can hold up to 64 kilobytes.
12426 @item -mzda=@var{n}
12427 @opindex mzda
12428 Put static or global variables whose size is @var{n} bytes or less into
12429 the first 32 kilobytes of memory.
12431 @item -mv850
12432 @opindex mv850
12433 Specify that the target processor is the V850.
12435 @item -mbig-switch
12436 @opindex mbig-switch
12437 Generate code suitable for big switch tables.  Use this option only if
12438 the assembler/linker complain about out of range branches within a switch
12439 table.
12441 @item -mapp-regs
12442 @opindex mapp-regs
12443 This option will cause r2 and r5 to be used in the code generated by
12444 the compiler.  This setting is the default.
12446 @item -mno-app-regs
12447 @opindex mno-app-regs
12448 This option will cause r2 and r5 to be treated as fixed registers.
12450 @item -mv850e1
12451 @opindex mv850e1
12452 Specify that the target processor is the V850E1.  The preprocessor
12453 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12454 this option is used.
12456 @item -mv850e
12457 @opindex mv850e
12458 Specify that the target processor is the V850E@.  The preprocessor
12459 constant @samp{__v850e__} will be defined if this option is used.
12461 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12462 are defined then a default target processor will be chosen and the
12463 relevant @samp{__v850*__} preprocessor constant will be defined.
12465 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12466 defined, regardless of which processor variant is the target.
12468 @item -mdisable-callt
12469 @opindex mdisable-callt
12470 This option will suppress generation of the CALLT instruction for the
12471 v850e and v850e1 flavors of the v850 architecture.  The default is
12472 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12474 @end table
12476 @node VAX Options
12477 @subsection VAX Options
12478 @cindex VAX options
12480 These @samp{-m} options are defined for the VAX:
12482 @table @gcctabopt
12483 @item -munix
12484 @opindex munix
12485 Do not output certain jump instructions (@code{aobleq} and so on)
12486 that the Unix assembler for the VAX cannot handle across long
12487 ranges.
12489 @item -mgnu
12490 @opindex mgnu
12491 Do output those jump instructions, on the assumption that you
12492 will assemble with the GNU assembler.
12494 @item -mg
12495 @opindex mg
12496 Output code for g-format floating point numbers instead of d-format.
12497 @end table
12499 @node x86-64 Options
12500 @subsection x86-64 Options
12501 @cindex x86-64 options
12503 These are listed under @xref{i386 and x86-64 Options}.
12505 @node Xstormy16 Options
12506 @subsection Xstormy16 Options
12507 @cindex Xstormy16 Options
12509 These options are defined for Xstormy16:
12511 @table @gcctabopt
12512 @item -msim
12513 @opindex msim
12514 Choose startup files and linker script suitable for the simulator.
12515 @end table
12517 @node Xtensa Options
12518 @subsection Xtensa Options
12519 @cindex Xtensa Options
12521 These options are supported for Xtensa targets:
12523 @table @gcctabopt
12524 @item -mconst16
12525 @itemx -mno-const16
12526 @opindex mconst16
12527 @opindex mno-const16
12528 Enable or disable use of @code{CONST16} instructions for loading
12529 constant values.  The @code{CONST16} instruction is currently not a
12530 standard option from Tensilica.  When enabled, @code{CONST16}
12531 instructions are always used in place of the standard @code{L32R}
12532 instructions.  The use of @code{CONST16} is enabled by default only if
12533 the @code{L32R} instruction is not available.
12535 @item -mfused-madd
12536 @itemx -mno-fused-madd
12537 @opindex mfused-madd
12538 @opindex mno-fused-madd
12539 Enable or disable use of fused multiply/add and multiply/subtract
12540 instructions in the floating-point option.  This has no effect if the
12541 floating-point option is not also enabled.  Disabling fused multiply/add
12542 and multiply/subtract instructions forces the compiler to use separate
12543 instructions for the multiply and add/subtract operations.  This may be
12544 desirable in some cases where strict IEEE 754-compliant results are
12545 required: the fused multiply add/subtract instructions do not round the
12546 intermediate result, thereby producing results with @emph{more} bits of
12547 precision than specified by the IEEE standard.  Disabling fused multiply
12548 add/subtract instructions also ensures that the program output is not
12549 sensitive to the compiler's ability to combine multiply and add/subtract
12550 operations.
12552 @item -mtext-section-literals
12553 @itemx -mno-text-section-literals
12554 @opindex mtext-section-literals
12555 @opindex mno-text-section-literals
12556 Control the treatment of literal pools.  The default is
12557 @option{-mno-text-section-literals}, which places literals in a separate
12558 section in the output file.  This allows the literal pool to be placed
12559 in a data RAM/ROM, and it also allows the linker to combine literal
12560 pools from separate object files to remove redundant literals and
12561 improve code size.  With @option{-mtext-section-literals}, the literals
12562 are interspersed in the text section in order to keep them as close as
12563 possible to their references.  This may be necessary for large assembly
12564 files.
12566 @item -mtarget-align
12567 @itemx -mno-target-align
12568 @opindex mtarget-align
12569 @opindex mno-target-align
12570 When this option is enabled, GCC instructs the assembler to
12571 automatically align instructions to reduce branch penalties at the
12572 expense of some code density.  The assembler attempts to widen density
12573 instructions to align branch targets and the instructions following call
12574 instructions.  If there are not enough preceding safe density
12575 instructions to align a target, no widening will be performed.  The
12576 default is @option{-mtarget-align}.  These options do not affect the
12577 treatment of auto-aligned instructions like @code{LOOP}, which the
12578 assembler will always align, either by widening density instructions or
12579 by inserting no-op instructions.
12581 @item -mlongcalls
12582 @itemx -mno-longcalls
12583 @opindex mlongcalls
12584 @opindex mno-longcalls
12585 When this option is enabled, GCC instructs the assembler to translate
12586 direct calls to indirect calls unless it can determine that the target
12587 of a direct call is in the range allowed by the call instruction.  This
12588 translation typically occurs for calls to functions in other source
12589 files.  Specifically, the assembler translates a direct @code{CALL}
12590 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12591 The default is @option{-mno-longcalls}.  This option should be used in
12592 programs where the call target can potentially be out of range.  This
12593 option is implemented in the assembler, not the compiler, so the
12594 assembly code generated by GCC will still show direct call
12595 instructions---look at the disassembled object code to see the actual
12596 instructions.  Note that the assembler will use an indirect call for
12597 every cross-file call, not just those that really will be out of range.
12598 @end table
12600 @node zSeries Options
12601 @subsection zSeries Options
12602 @cindex zSeries options
12604 These are listed under @xref{S/390 and zSeries Options}.
12606 @node Code Gen Options
12607 @section Options for Code Generation Conventions
12608 @cindex code generation conventions
12609 @cindex options, code generation
12610 @cindex run-time options
12612 These machine-independent options control the interface conventions
12613 used in code generation.
12615 Most of them have both positive and negative forms; the negative form
12616 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12617 one of the forms is listed---the one which is not the default.  You
12618 can figure out the other form by either removing @samp{no-} or adding
12621 @table @gcctabopt
12622 @item -fbounds-check
12623 @opindex fbounds-check
12624 For front-ends that support it, generate additional code to check that
12625 indices used to access arrays are within the declared range.  This is
12626 currently only supported by the Java and Fortran 77 front-ends, where
12627 this option defaults to true and false respectively.
12629 @item -ftrapv
12630 @opindex ftrapv
12631 This option generates traps for signed overflow on addition, subtraction,
12632 multiplication operations.
12634 @item -fwrapv
12635 @opindex fwrapv
12636 This option instructs the compiler to assume that signed arithmetic
12637 overflow of addition, subtraction and multiplication wraps around
12638 using twos-complement representation.  This flag enables some optimizations
12639 and disables others.  This option is enabled by default for the Java
12640 front-end, as required by the Java language specification.
12642 @item -fexceptions
12643 @opindex fexceptions
12644 Enable exception handling.  Generates extra code needed to propagate
12645 exceptions.  For some targets, this implies GCC will generate frame
12646 unwind information for all functions, which can produce significant data
12647 size overhead, although it does not affect execution.  If you do not
12648 specify this option, GCC will enable it by default for languages like
12649 C++ which normally require exception handling, and disable it for
12650 languages like C that do not normally require it.  However, you may need
12651 to enable this option when compiling C code that needs to interoperate
12652 properly with exception handlers written in C++.  You may also wish to
12653 disable this option if you are compiling older C++ programs that don't
12654 use exception handling.
12656 @item -fnon-call-exceptions
12657 @opindex fnon-call-exceptions
12658 Generate code that allows trapping instructions to throw exceptions.
12659 Note that this requires platform-specific runtime support that does
12660 not exist everywhere.  Moreover, it only allows @emph{trapping}
12661 instructions to throw exceptions, i.e.@: memory references or floating
12662 point instructions.  It does not allow exceptions to be thrown from
12663 arbitrary signal handlers such as @code{SIGALRM}.
12665 @item -funwind-tables
12666 @opindex funwind-tables
12667 Similar to @option{-fexceptions}, except that it will just generate any needed
12668 static data, but will not affect the generated code in any other way.
12669 You will normally not enable this option; instead, a language processor
12670 that needs this handling would enable it on your behalf.
12672 @item -fasynchronous-unwind-tables
12673 @opindex fasynchronous-unwind-tables
12674 Generate unwind table in dwarf2 format, if supported by target machine.  The
12675 table is exact at each instruction boundary, so it can be used for stack
12676 unwinding from asynchronous events (such as debugger or garbage collector).
12678 @item -fpcc-struct-return
12679 @opindex fpcc-struct-return
12680 Return ``short'' @code{struct} and @code{union} values in memory like
12681 longer ones, rather than in registers.  This convention is less
12682 efficient, but it has the advantage of allowing intercallability between
12683 GCC-compiled files and files compiled with other compilers, particularly
12684 the Portable C Compiler (pcc).
12686 The precise convention for returning structures in memory depends
12687 on the target configuration macros.
12689 Short structures and unions are those whose size and alignment match
12690 that of some integer type.
12692 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12693 switch is not binary compatible with code compiled with the
12694 @option{-freg-struct-return} switch.
12695 Use it to conform to a non-default application binary interface.
12697 @item -freg-struct-return
12698 @opindex freg-struct-return
12699 Return @code{struct} and @code{union} values in registers when possible.
12700 This is more efficient for small structures than
12701 @option{-fpcc-struct-return}.
12703 If you specify neither @option{-fpcc-struct-return} nor
12704 @option{-freg-struct-return}, GCC defaults to whichever convention is
12705 standard for the target.  If there is no standard convention, GCC
12706 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12707 the principal compiler.  In those cases, we can choose the standard, and
12708 we chose the more efficient register return alternative.
12710 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12711 switch is not binary compatible with code compiled with the
12712 @option{-fpcc-struct-return} switch.
12713 Use it to conform to a non-default application binary interface.
12715 @item -fshort-enums
12716 @opindex fshort-enums
12717 Allocate to an @code{enum} type only as many bytes as it needs for the
12718 declared range of possible values.  Specifically, the @code{enum} type
12719 will be equivalent to the smallest integer type which has enough room.
12721 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12722 code that is not binary compatible with code generated without that switch.
12723 Use it to conform to a non-default application binary interface.
12725 @item -fshort-double
12726 @opindex fshort-double
12727 Use the same size for @code{double} as for @code{float}.
12729 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12730 code that is not binary compatible with code generated without that switch.
12731 Use it to conform to a non-default application binary interface.
12733 @item -fshort-wchar
12734 @opindex fshort-wchar
12735 Override the underlying type for @samp{wchar_t} to be @samp{short
12736 unsigned int} instead of the default for the target.  This option is
12737 useful for building programs to run under WINE@.
12739 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12740 code that is not binary compatible with code generated without that switch.
12741 Use it to conform to a non-default application binary interface.
12743 @item -fshared-data
12744 @opindex fshared-data
12745 Requests that the data and non-@code{const} variables of this
12746 compilation be shared data rather than private data.  The distinction
12747 makes sense only on certain operating systems, where shared data is
12748 shared between processes running the same program, while private data
12749 exists in one copy per process.
12751 @item -fno-common
12752 @opindex fno-common
12753 In C, allocate even uninitialized global variables in the data section of the
12754 object file, rather than generating them as common blocks.  This has the
12755 effect that if the same variable is declared (without @code{extern}) in
12756 two different compilations, you will get an error when you link them.
12757 The only reason this might be useful is if you wish to verify that the
12758 program will work on other systems which always work this way.
12760 @item -fno-ident
12761 @opindex fno-ident
12762 Ignore the @samp{#ident} directive.
12764 @item -finhibit-size-directive
12765 @opindex finhibit-size-directive
12766 Don't output a @code{.size} assembler directive, or anything else that
12767 would cause trouble if the function is split in the middle, and the
12768 two halves are placed at locations far apart in memory.  This option is
12769 used when compiling @file{crtstuff.c}; you should not need to use it
12770 for anything else.
12772 @item -fverbose-asm
12773 @opindex fverbose-asm
12774 Put extra commentary information in the generated assembly code to
12775 make it more readable.  This option is generally only of use to those
12776 who actually need to read the generated assembly code (perhaps while
12777 debugging the compiler itself).
12779 @option{-fno-verbose-asm}, the default, causes the
12780 extra information to be omitted and is useful when comparing two assembler
12781 files.
12783 @item -fpic
12784 @opindex fpic
12785 @cindex global offset table
12786 @cindex PIC
12787 Generate position-independent code (PIC) suitable for use in a shared
12788 library, if supported for the target machine.  Such code accesses all
12789 constant addresses through a global offset table (GOT)@.  The dynamic
12790 loader resolves the GOT entries when the program starts (the dynamic
12791 loader is not part of GCC; it is part of the operating system).  If
12792 the GOT size for the linked executable exceeds a machine-specific
12793 maximum size, you get an error message from the linker indicating that
12794 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12795 instead.  (These maximums are 8k on the SPARC and 32k
12796 on the m68k and RS/6000.  The 386 has no such limit.)
12798 Position-independent code requires special support, and therefore works
12799 only on certain machines.  For the 386, GCC supports PIC for System V
12800 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12801 position-independent.
12803 @item -fPIC
12804 @opindex fPIC
12805 If supported for the target machine, emit position-independent code,
12806 suitable for dynamic linking and avoiding any limit on the size of the
12807 global offset table.  This option makes a difference on the m68k,
12808 PowerPC and SPARC@.
12810 Position-independent code requires special support, and therefore works
12811 only on certain machines.
12813 @item -fpie
12814 @itemx -fPIE
12815 @opindex fpie
12816 @opindex fPIE
12817 These options are similar to @option{-fpic} and @option{-fPIC}, but
12818 generated position independent code can be only linked into executables.
12819 Usually these options are used when @option{-pie} GCC option will be
12820 used during linking.
12822 @item -fno-jump-tables
12823 @opindex fno-jump-tables
12824 Do not use jump tables for switch statements even where it would be
12825 more efficient than other code generation strategies.  This option is
12826 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12827 building code which forms part of a dynamic linker and cannot
12828 reference the address of a jump table.  On some targets, jump tables
12829 do not require a GOT and this option is not needed.
12831 @item -ffixed-@var{reg}
12832 @opindex ffixed
12833 Treat the register named @var{reg} as a fixed register; generated code
12834 should never refer to it (except perhaps as a stack pointer, frame
12835 pointer or in some other fixed role).
12837 @var{reg} must be the name of a register.  The register names accepted
12838 are machine-specific and are defined in the @code{REGISTER_NAMES}
12839 macro in the machine description macro file.
12841 This flag does not have a negative form, because it specifies a
12842 three-way choice.
12844 @item -fcall-used-@var{reg}
12845 @opindex fcall-used
12846 Treat the register named @var{reg} as an allocable register that is
12847 clobbered by function calls.  It may be allocated for temporaries or
12848 variables that do not live across a call.  Functions compiled this way
12849 will not save and restore the register @var{reg}.
12851 It is an error to used this flag with the frame pointer or stack pointer.
12852 Use of this flag for other registers that have fixed pervasive roles in
12853 the machine's execution model will produce disastrous results.
12855 This flag does not have a negative form, because it specifies a
12856 three-way choice.
12858 @item -fcall-saved-@var{reg}
12859 @opindex fcall-saved
12860 Treat the register named @var{reg} as an allocable register saved by
12861 functions.  It may be allocated even for temporaries or variables that
12862 live across a call.  Functions compiled this way will save and restore
12863 the register @var{reg} if they use it.
12865 It is an error to used this flag with the frame pointer or stack pointer.
12866 Use of this flag for other registers that have fixed pervasive roles in
12867 the machine's execution model will produce disastrous results.
12869 A different sort of disaster will result from the use of this flag for
12870 a register in which function values may be returned.
12872 This flag does not have a negative form, because it specifies a
12873 three-way choice.
12875 @item -fpack-struct[=@var{n}]
12876 @opindex fpack-struct
12877 Without a value specified, pack all structure members together without
12878 holes.  When a value is specified (which must be a small power of two), pack
12879 structure members according to this value, representing the maximum
12880 alignment (that is, objects with default alignment requirements larger than
12881 this will be output potentially unaligned at the next fitting location.
12883 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12884 code that is not binary compatible with code generated without that switch.
12885 Additionally, it makes the code suboptimal.
12886 Use it to conform to a non-default application binary interface.
12888 @item -finstrument-functions
12889 @opindex finstrument-functions
12890 Generate instrumentation calls for entry and exit to functions.  Just
12891 after function entry and just before function exit, the following
12892 profiling functions will be called with the address of the current
12893 function and its call site.  (On some platforms,
12894 @code{__builtin_return_address} does not work beyond the current
12895 function, so the call site information may not be available to the
12896 profiling functions otherwise.)
12898 @smallexample
12899 void __cyg_profile_func_enter (void *this_fn,
12900                                void *call_site);
12901 void __cyg_profile_func_exit  (void *this_fn,
12902                                void *call_site);
12903 @end smallexample
12905 The first argument is the address of the start of the current function,
12906 which may be looked up exactly in the symbol table.
12908 This instrumentation is also done for functions expanded inline in other
12909 functions.  The profiling calls will indicate where, conceptually, the
12910 inline function is entered and exited.  This means that addressable
12911 versions of such functions must be available.  If all your uses of a
12912 function are expanded inline, this may mean an additional expansion of
12913 code size.  If you use @samp{extern inline} in your C code, an
12914 addressable version of such functions must be provided.  (This is
12915 normally the case anyways, but if you get lucky and the optimizer always
12916 expands the functions inline, you might have gotten away without
12917 providing static copies.)
12919 A function may be given the attribute @code{no_instrument_function}, in
12920 which case this instrumentation will not be done.  This can be used, for
12921 example, for the profiling functions listed above, high-priority
12922 interrupt routines, and any functions from which the profiling functions
12923 cannot safely be called (perhaps signal handlers, if the profiling
12924 routines generate output or allocate memory).
12926 @item -fstack-check
12927 @opindex fstack-check
12928 Generate code to verify that you do not go beyond the boundary of the
12929 stack.  You should specify this flag if you are running in an
12930 environment with multiple threads, but only rarely need to specify it in
12931 a single-threaded environment since stack overflow is automatically
12932 detected on nearly all systems if there is only one stack.
12934 Note that this switch does not actually cause checking to be done; the
12935 operating system must do that.  The switch causes generation of code
12936 to ensure that the operating system sees the stack being extended.
12938 @item -fstack-limit-register=@var{reg}
12939 @itemx -fstack-limit-symbol=@var{sym}
12940 @itemx -fno-stack-limit
12941 @opindex fstack-limit-register
12942 @opindex fstack-limit-symbol
12943 @opindex fno-stack-limit
12944 Generate code to ensure that the stack does not grow beyond a certain value,
12945 either the value of a register or the address of a symbol.  If the stack
12946 would grow beyond the value, a signal is raised.  For most targets,
12947 the signal is raised before the stack overruns the boundary, so
12948 it is possible to catch the signal without taking special precautions.
12950 For instance, if the stack starts at absolute address @samp{0x80000000}
12951 and grows downwards, you can use the flags
12952 @option{-fstack-limit-symbol=__stack_limit} and
12953 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12954 of 128KB@.  Note that this may only work with the GNU linker.
12956 @cindex aliasing of parameters
12957 @cindex parameters, aliased
12958 @item -fargument-alias
12959 @itemx -fargument-noalias
12960 @itemx -fargument-noalias-global
12961 @opindex fargument-alias
12962 @opindex fargument-noalias
12963 @opindex fargument-noalias-global
12964 Specify the possible relationships among parameters and between
12965 parameters and global data.
12967 @option{-fargument-alias} specifies that arguments (parameters) may
12968 alias each other and may alias global storage.@*
12969 @option{-fargument-noalias} specifies that arguments do not alias
12970 each other, but may alias global storage.@*
12971 @option{-fargument-noalias-global} specifies that arguments do not
12972 alias each other and do not alias global storage.
12974 Each language will automatically use whatever option is required by
12975 the language standard.  You should not need to use these options yourself.
12977 @item -fleading-underscore
12978 @opindex fleading-underscore
12979 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12980 change the way C symbols are represented in the object file.  One use
12981 is to help link with legacy assembly code.
12983 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12984 generate code that is not binary compatible with code generated without that
12985 switch.  Use it to conform to a non-default application binary interface.
12986 Not all targets provide complete support for this switch.
12988 @item -ftls-model=@var{model}
12989 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12990 The @var{model} argument should be one of @code{global-dynamic},
12991 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12993 The default without @option{-fpic} is @code{initial-exec}; with
12994 @option{-fpic} the default is @code{global-dynamic}.
12996 @item -fvisibility=@var{default|internal|hidden|protected}
12997 @opindex fvisibility
12998 Set the default ELF image symbol visibility to the specified option---all
12999 symbols will be marked with this unless overridden within the code.
13000 Using this feature can very substantially improve linking and
13001 load times of shared object libraries, produce more optimized
13002 code, provide near-perfect API export and prevent symbol clashes.
13003 It is @strong{strongly} recommended that you use this in any shared objects
13004 you distribute.
13006 Despite the nomenclature, @code{default} always means public ie;
13007 available to be linked against from outside the shared object.
13008 @code{protected} and @code{internal} are pretty useless in real-world
13009 usage so the only other commonly used option will be @code{hidden}.
13010 The default if @option{-fvisibility} isn't specified is
13011 @code{default}, i.e., make every
13012 symbol public---this causes the same behavior as previous versions of
13013 GCC@.
13015 A good explanation of the benefits offered by ensuring ELF
13016 symbols have the correct visibility is given by ``How To Write
13017 Shared Libraries'' by Ulrich Drepper (which can be found at
13018 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13019 solution made possible by this option to marking things hidden when
13020 the default is public is to make the default hidden and mark things
13021 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13022 and @code{__attribute__ ((visibility("default")))} instead of
13023 @code{__declspec(dllexport)} you get almost identical semantics with
13024 identical syntax.  This is a great boon to those working with
13025 cross-platform projects.
13027 For those adding visibility support to existing code, you may find
13028 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13029 the declarations you wish to set visibility for with (for example)
13030 @samp{#pragma GCC visibility push(hidden)} and
13031 @samp{#pragma GCC visibility pop}.
13032 Bear in mind that symbol visibility should be viewed @strong{as
13033 part of the API interface contract} and thus all new code should
13034 always specify visibility when it is not the default ie; declarations
13035 only for use within the local DSO should @strong{always} be marked explicitly
13036 as hidden as so to avoid PLT indirection overheads---making this
13037 abundantly clear also aids readability and self-documentation of the code.
13038 Note that due to ISO C++ specification requirements, operator new and
13039 operator delete must always be of default visibility.
13041 An overview of these techniques, their benefits and how to use them
13042 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13044 @end table
13046 @c man end
13048 @node Environment Variables
13049 @section Environment Variables Affecting GCC
13050 @cindex environment variables
13052 @c man begin ENVIRONMENT
13053 This section describes several environment variables that affect how GCC
13054 operates.  Some of them work by specifying directories or prefixes to use
13055 when searching for various kinds of files.  Some are used to specify other
13056 aspects of the compilation environment.
13058 Note that you can also specify places to search using options such as
13059 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13060 take precedence over places specified using environment variables, which
13061 in turn take precedence over those specified by the configuration of GCC@.
13062 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13063 GNU Compiler Collection (GCC) Internals}.
13065 @table @env
13066 @item LANG
13067 @itemx LC_CTYPE
13068 @c @itemx LC_COLLATE
13069 @itemx LC_MESSAGES
13070 @c @itemx LC_MONETARY
13071 @c @itemx LC_NUMERIC
13072 @c @itemx LC_TIME
13073 @itemx LC_ALL
13074 @findex LANG
13075 @findex LC_CTYPE
13076 @c @findex LC_COLLATE
13077 @findex LC_MESSAGES
13078 @c @findex LC_MONETARY
13079 @c @findex LC_NUMERIC
13080 @c @findex LC_TIME
13081 @findex LC_ALL
13082 @cindex locale
13083 These environment variables control the way that GCC uses
13084 localization information that allow GCC to work with different
13085 national conventions.  GCC inspects the locale categories
13086 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13087 so.  These locale categories can be set to any value supported by your
13088 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13089 Kingdom encoded in UTF-8.
13091 The @env{LC_CTYPE} environment variable specifies character
13092 classification.  GCC uses it to determine the character boundaries in
13093 a string; this is needed for some multibyte encodings that contain quote
13094 and escape characters that would otherwise be interpreted as a string
13095 end or escape.
13097 The @env{LC_MESSAGES} environment variable specifies the language to
13098 use in diagnostic messages.
13100 If the @env{LC_ALL} environment variable is set, it overrides the value
13101 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13102 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13103 environment variable.  If none of these variables are set, GCC
13104 defaults to traditional C English behavior.
13106 @item TMPDIR
13107 @findex TMPDIR
13108 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13109 files.  GCC uses temporary files to hold the output of one stage of
13110 compilation which is to be used as input to the next stage: for example,
13111 the output of the preprocessor, which is the input to the compiler
13112 proper.
13114 @item GCC_EXEC_PREFIX
13115 @findex GCC_EXEC_PREFIX
13116 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13117 names of the subprograms executed by the compiler.  No slash is added
13118 when this prefix is combined with the name of a subprogram, but you can
13119 specify a prefix that ends with a slash if you wish.
13121 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13122 an appropriate prefix to use based on the pathname it was invoked with.
13124 If GCC cannot find the subprogram using the specified prefix, it
13125 tries looking in the usual places for the subprogram.
13127 The default value of @env{GCC_EXEC_PREFIX} is
13128 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13129 of @code{prefix} when you ran the @file{configure} script.
13131 Other prefixes specified with @option{-B} take precedence over this prefix.
13133 This prefix is also used for finding files such as @file{crt0.o} that are
13134 used for linking.
13136 In addition, the prefix is used in an unusual way in finding the
13137 directories to search for header files.  For each of the standard
13138 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13139 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13140 replacing that beginning with the specified prefix to produce an
13141 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13142 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13143 These alternate directories are searched first; the standard directories
13144 come next.
13146 @item COMPILER_PATH
13147 @findex COMPILER_PATH
13148 The value of @env{COMPILER_PATH} is a colon-separated list of
13149 directories, much like @env{PATH}.  GCC tries the directories thus
13150 specified when searching for subprograms, if it can't find the
13151 subprograms using @env{GCC_EXEC_PREFIX}.
13153 @item LIBRARY_PATH
13154 @findex LIBRARY_PATH
13155 The value of @env{LIBRARY_PATH} is a colon-separated list of
13156 directories, much like @env{PATH}.  When configured as a native compiler,
13157 GCC tries the directories thus specified when searching for special
13158 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13159 using GCC also uses these directories when searching for ordinary
13160 libraries for the @option{-l} option (but directories specified with
13161 @option{-L} come first).
13163 @item LANG
13164 @findex LANG
13165 @cindex locale definition
13166 This variable is used to pass locale information to the compiler.  One way in
13167 which this information is used is to determine the character set to be used
13168 when character literals, string literals and comments are parsed in C and C++.
13169 When the compiler is configured to allow multibyte characters,
13170 the following values for @env{LANG} are recognized:
13172 @table @samp
13173 @item C-JIS
13174 Recognize JIS characters.
13175 @item C-SJIS
13176 Recognize SJIS characters.
13177 @item C-EUCJP
13178 Recognize EUCJP characters.
13179 @end table
13181 If @env{LANG} is not defined, or if it has some other value, then the
13182 compiler will use mblen and mbtowc as defined by the default locale to
13183 recognize and translate multibyte characters.
13184 @end table
13186 @noindent
13187 Some additional environments variables affect the behavior of the
13188 preprocessor.
13190 @include cppenv.texi
13192 @c man end
13194 @node Precompiled Headers
13195 @section Using Precompiled Headers
13196 @cindex precompiled headers
13197 @cindex speed of compilation
13199 Often large projects have many header files that are included in every
13200 source file.  The time the compiler takes to process these header files
13201 over and over again can account for nearly all of the time required to
13202 build the project.  To make builds faster, GCC allows users to
13203 `precompile' a header file; then, if builds can use the precompiled
13204 header file they will be much faster.
13206 To create a precompiled header file, simply compile it as you would any
13207 other file, if necessary using the @option{-x} option to make the driver
13208 treat it as a C or C++ header file.  You will probably want to use a
13209 tool like @command{make} to keep the precompiled header up-to-date when
13210 the headers it contains change.
13212 A precompiled header file will be searched for when @code{#include} is
13213 seen in the compilation.  As it searches for the included file
13214 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13215 compiler looks for a precompiled header in each directory just before it
13216 looks for the include file in that directory.  The name searched for is
13217 the name specified in the @code{#include} with @samp{.gch} appended.  If
13218 the precompiled header file can't be used, it is ignored.
13220 For instance, if you have @code{#include "all.h"}, and you have
13221 @file{all.h.gch} in the same directory as @file{all.h}, then the
13222 precompiled header file will be used if possible, and the original
13223 header will be used otherwise.
13225 Alternatively, you might decide to put the precompiled header file in a
13226 directory and use @option{-I} to ensure that directory is searched
13227 before (or instead of) the directory containing the original header.
13228 Then, if you want to check that the precompiled header file is always
13229 used, you can put a file of the same name as the original header in this
13230 directory containing an @code{#error} command.
13232 This also works with @option{-include}.  So yet another way to use
13233 precompiled headers, good for projects not designed with precompiled
13234 header files in mind, is to simply take most of the header files used by
13235 a project, include them from another header file, precompile that header
13236 file, and @option{-include} the precompiled header.  If the header files
13237 have guards against multiple inclusion, they will be skipped because
13238 they've already been included (in the precompiled header).
13240 If you need to precompile the same header file for different
13241 languages, targets, or compiler options, you can instead make a
13242 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13243 header in the directory, perhaps using @option{-o}.  It doesn't matter
13244 what you call the files in the directory, every precompiled header in
13245 the directory will be considered.  The first precompiled header
13246 encountered in the directory that is valid for this compilation will
13247 be used; they're searched in no particular order.
13249 There are many other possibilities, limited only by your imagination,
13250 good sense, and the constraints of your build system.
13252 A precompiled header file can be used only when these conditions apply:
13254 @itemize
13255 @item
13256 Only one precompiled header can be used in a particular compilation.
13258 @item
13259 A precompiled header can't be used once the first C token is seen.  You
13260 can have preprocessor directives before a precompiled header; you can
13261 even include a precompiled header from inside another header, so long as
13262 there are no C tokens before the @code{#include}.
13264 @item
13265 The precompiled header file must be produced for the same language as
13266 the current compilation.  You can't use a C precompiled header for a C++
13267 compilation.
13269 @item
13270 The precompiled header file must have been produced by the same compiler
13271 binary as the current compilation is using.
13273 @item
13274 Any macros defined before the precompiled header is included must
13275 either be defined in the same way as when the precompiled header was
13276 generated, or must not affect the precompiled header, which usually
13277 means that they don't appear in the precompiled header at all.
13279 The @option{-D} option is one way to define a macro before a
13280 precompiled header is included; using a @code{#define} can also do it.
13281 There are also some options that define macros implicitly, like
13282 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13283 defined this way.
13285 @item If debugging information is output when using the precompiled
13286 header, using @option{-g} or similar, the same kind of debugging information
13287 must have been output when building the precompiled header.  However,
13288 a precompiled header built using @option{-g} can be used in a compilation
13289 when no debugging information is being output.
13291 @item The same @option{-m} options must generally be used when building
13292 and using the precompiled header.  @xref{Submodel Options},
13293 for any cases where this rule is relaxed.
13295 @item Each of the following options must be the same when building and using
13296 the precompiled header:
13298 @gccoptlist{-fexceptions -funit-at-a-time}
13300 @item
13301 Some other command-line options starting with @option{-f},
13302 @option{-p}, or @option{-O} must be defined in the same way as when
13303 the precompiled header was generated.  At present, it's not clear
13304 which options are safe to change and which are not; the safest choice
13305 is to use exactly the same options when generating and using the
13306 precompiled header.  The following are known to be safe:
13308 @gccoptlist{-fmessage-length= -fpreprocessed
13309 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13310 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13311 -pedantic-errors}
13313 @end itemize
13315 For all of these except the last, the compiler will automatically
13316 ignore the precompiled header if the conditions aren't met.  If you
13317 find an option combination that doesn't work and doesn't cause the
13318 precompiled header to be ignored, please consider filing a bug report,
13319 see @ref{Bugs}.
13321 If you do use differing options when generating and using the
13322 precompiled header, the actual behavior will be a mixture of the
13323 behavior for the options.  For instance, if you use @option{-g} to
13324 generate the precompiled header but not when using it, you may or may
13325 not get debugging information for routines in the precompiled header.
13327 @node Running Protoize
13328 @section Running Protoize
13330 The program @code{protoize} is an optional part of GCC@.  You can use
13331 it to add prototypes to a program, thus converting the program to ISO
13332 C in one respect.  The companion program @code{unprotoize} does the
13333 reverse: it removes argument types from any prototypes that are found.
13335 When you run these programs, you must specify a set of source files as
13336 command line arguments.  The conversion programs start out by compiling
13337 these files to see what functions they define.  The information gathered
13338 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13340 After scanning comes actual conversion.  The specified files are all
13341 eligible to be converted; any files they include (whether sources or
13342 just headers) are eligible as well.
13344 But not all the eligible files are converted.  By default,
13345 @code{protoize} and @code{unprotoize} convert only source and header
13346 files in the current directory.  You can specify additional directories
13347 whose files should be converted with the @option{-d @var{directory}}
13348 option.  You can also specify particular files to exclude with the
13349 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13350 directory name matches one of the specified directory names, and its
13351 name within the directory has not been excluded.
13353 Basic conversion with @code{protoize} consists of rewriting most
13354 function definitions and function declarations to specify the types of
13355 the arguments.  The only ones not rewritten are those for varargs
13356 functions.
13358 @code{protoize} optionally inserts prototype declarations at the
13359 beginning of the source file, to make them available for any calls that
13360 precede the function's definition.  Or it can insert prototype
13361 declarations with block scope in the blocks where undeclared functions
13362 are called.
13364 Basic conversion with @code{unprotoize} consists of rewriting most
13365 function declarations to remove any argument types, and rewriting
13366 function definitions to the old-style pre-ISO form.
13368 Both conversion programs print a warning for any function declaration or
13369 definition that they can't convert.  You can suppress these warnings
13370 with @option{-q}.
13372 The output from @code{protoize} or @code{unprotoize} replaces the
13373 original source file.  The original file is renamed to a name ending
13374 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13375 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13376 for DOS) file already exists, then the source file is simply discarded.
13378 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13379 scan the program and collect information about the functions it uses.
13380 So neither of these programs will work until GCC is installed.
13382 Here is a table of the options you can use with @code{protoize} and
13383 @code{unprotoize}.  Each option works with both programs unless
13384 otherwise stated.
13386 @table @code
13387 @item -B @var{directory}
13388 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13389 usual directory (normally @file{/usr/local/lib}).  This file contains
13390 prototype information about standard system functions.  This option
13391 applies only to @code{protoize}.
13393 @item -c @var{compilation-options}
13394 Use @var{compilation-options} as the options when running @command{gcc} to
13395 produce the @samp{.X} files.  The special option @option{-aux-info} is
13396 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13398 Note that the compilation options must be given as a single argument to
13399 @code{protoize} or @code{unprotoize}.  If you want to specify several
13400 @command{gcc} options, you must quote the entire set of compilation options
13401 to make them a single word in the shell.
13403 There are certain @command{gcc} arguments that you cannot use, because they
13404 would produce the wrong kind of output.  These include @option{-g},
13405 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13406 the @var{compilation-options}, they are ignored.
13408 @item -C
13409 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13410 systems) instead of @samp{.c}.  This is convenient if you are converting
13411 a C program to C++.  This option applies only to @code{protoize}.
13413 @item -g
13414 Add explicit global declarations.  This means inserting explicit
13415 declarations at the beginning of each source file for each function
13416 that is called in the file and was not declared.  These declarations
13417 precede the first function definition that contains a call to an
13418 undeclared function.  This option applies only to @code{protoize}.
13420 @item -i @var{string}
13421 Indent old-style parameter declarations with the string @var{string}.
13422 This option applies only to @code{protoize}.
13424 @code{unprotoize} converts prototyped function definitions to old-style
13425 function definitions, where the arguments are declared between the
13426 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13427 uses five spaces as the indentation.  If you want to indent with just
13428 one space instead, use @option{-i " "}.
13430 @item -k
13431 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13432 is finished.
13434 @item -l
13435 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13436 a prototype declaration for each function in each block which calls the
13437 function without any declaration.  This option applies only to
13438 @code{protoize}.
13440 @item -n
13441 Make no real changes.  This mode just prints information about the conversions
13442 that would have been done without @option{-n}.
13444 @item -N
13445 Make no @samp{.save} files.  The original files are simply deleted.
13446 Use this option with caution.
13448 @item -p @var{program}
13449 Use the program @var{program} as the compiler.  Normally, the name
13450 @file{gcc} is used.
13452 @item -q
13453 Work quietly.  Most warnings are suppressed.
13455 @item -v
13456 Print the version number, just like @option{-v} for @command{gcc}.
13457 @end table
13459 If you need special compiler options to compile one of your program's
13460 source files, then you should generate that file's @samp{.X} file
13461 specially, by running @command{gcc} on that source file with the
13462 appropriate options and the option @option{-aux-info}.  Then run
13463 @code{protoize} on the entire set of files.  @code{protoize} will use
13464 the existing @samp{.X} file because it is newer than the source file.
13465 For example:
13467 @smallexample
13468 gcc -Dfoo=bar file1.c -aux-info file1.X
13469 protoize *.c
13470 @end smallexample
13472 @noindent
13473 You need to include the special files along with the rest in the
13474 @code{protoize} command, even though their @samp{.X} files already
13475 exist, because otherwise they won't get converted.
13477 @xref{Protoize Caveats}, for more information on how to use
13478 @code{protoize} successfully.