* c-cppbuiltin.c (c_cpp_builtins): Define __pic__ and __PIC__ when
[official-gcc.git] / gcc / doc / invoke.texi
blobe84f72849317c06b405eec6608eb349f74837dc7
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 -Wvolatile-register-var  -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 @gol
416 -mtp=@var{name}}
418 @emph{AVR Options}
419 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
420 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
422 @emph{Blackfin Options}
423 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
424 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
425 -mlow-64k -mno-low64k -mid-shared-library @gol
426 -mno-id-shared-library -mshared-library-id=@var{n} @gol
427 -mlong-calls  -mno-long-calls}
429 @emph{CRIS Options}
430 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
431 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
432 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
433 -mstack-align  -mdata-align  -mconst-align @gol
434 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
435 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
436 -mmul-bug-workaround  -mno-mul-bug-workaround}
438 @emph{CRX Options}
439 @gccoptlist{-mmac -mpush-args}
441 @emph{Darwin Options}
442 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
443 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
444 -client_name  -compatibility_version  -current_version @gol
445 -dead_strip @gol
446 -dependency-file  -dylib_file  -dylinker_install_name @gol
447 -dynamic  -dynamiclib  -exported_symbols_list @gol
448 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
449 -force_flat_namespace  -headerpad_max_install_names @gol
450 -image_base  -init  -install_name  -keep_private_externs @gol
451 -multi_module  -multiply_defined  -multiply_defined_unused @gol
452 -noall_load   -no_dead_strip_inits_and_terms @gol
453 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
454 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
455 -private_bundle  -read_only_relocs  -sectalign @gol
456 -sectobjectsymbols  -whyload  -seg1addr @gol
457 -sectcreate  -sectobjectsymbols  -sectorder @gol
458 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
459 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
460 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
461 -single_module  -static  -sub_library  -sub_umbrella @gol
462 -twolevel_namespace  -umbrella  -undefined @gol
463 -unexported_symbols_list  -weak_reference_mismatches @gol
464 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
465 -mone-byte-bool}
467 @emph{DEC Alpha Options}
468 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
469 -mieee  -mieee-with-inexact  -mieee-conformant @gol
470 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
471 -mtrap-precision=@var{mode}  -mbuild-constants @gol
472 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
473 -mbwx  -mmax  -mfix  -mcix @gol
474 -mfloat-vax  -mfloat-ieee @gol
475 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
476 -msmall-text  -mlarge-text @gol
477 -mmemory-latency=@var{time}}
479 @emph{DEC Alpha/VMS Options}
480 @gccoptlist{-mvms-return-codes}
482 @emph{FRV Options}
483 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
484 -mhard-float  -msoft-float @gol
485 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
486 -mdouble  -mno-double @gol
487 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
488 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
489 -mlinked-fp  -mlong-calls  -malign-labels @gol
490 -mlibrary-pic  -macc-4  -macc-8 @gol
491 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
492 -moptimize-membar -mno-optimize-membar @gol
493 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
494 -mvliw-branch  -mno-vliw-branch @gol
495 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
496 -mno-nested-cond-exec  -mtomcat-stats @gol
497 -mTLS -mtls @gol
498 -mcpu=@var{cpu}}
500 @emph{H8/300 Options}
501 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
503 @emph{HPPA Options}
504 @gccoptlist{-march=@var{architecture-type} @gol
505 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
506 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
507 -mfixed-range=@var{register-range} @gol
508 -mjump-in-delay -mlinker-opt -mlong-calls @gol
509 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
510 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
511 -mno-jump-in-delay  -mno-long-load-store @gol
512 -mno-portable-runtime  -mno-soft-float @gol
513 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
514 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
515 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
516 -munix=@var{unix-std}  -nolibdld  -static  -threads}
518 @emph{i386 and x86-64 Options}
519 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
520 -mfpmath=@var{unit} @gol
521 -masm=@var{dialect}  -mno-fancy-math-387 @gol
522 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
523 -mno-wide-multiply  -mrtd  -malign-double @gol
524 -mpreferred-stack-boundary=@var{num} @gol
525 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
526 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
527 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
528 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
529 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
530 -mcmodel=@var{code-model} @gol
531 -m32  -m64 -mlarge-data-threshold=@var{num}}
533 @emph{IA-64 Options}
534 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
535 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
536 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
537 -minline-float-divide-max-throughput @gol
538 -minline-int-divide-min-latency @gol
539 -minline-int-divide-max-throughput  @gol
540 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
541 -mno-dwarf2-asm -mearly-stop-bits @gol
542 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
543 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
545 @emph{M32R/D Options}
546 @gccoptlist{-m32r2 -m32rx -m32r @gol
547 -mdebug @gol
548 -malign-loops -mno-align-loops @gol
549 -missue-rate=@var{number} @gol
550 -mbranch-cost=@var{number} @gol
551 -mmodel=@var{code-size-model-type} @gol
552 -msdata=@var{sdata-type} @gol
553 -mno-flush-func -mflush-func=@var{name} @gol
554 -mno-flush-trap -mflush-trap=@var{number} @gol
555 -G @var{num}}
557 @emph{M32C Options}
558 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
560 @emph{M680x0 Options}
561 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
562 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
563 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
564 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
565 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
567 @emph{M68hc1x Options}
568 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
569 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
570 -msoft-reg-count=@var{count}}
572 @emph{MCore Options}
573 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
574 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
575 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
576 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
577 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
579 @emph{MIPS Options}
580 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
581 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
582 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
583 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
584 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
585 -mdsp  -mpaired-single  -mips3d @gol
586 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
587 -G@var{num}  -membedded-data  -mno-embedded-data @gol
588 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
589 -msplit-addresses  -mno-split-addresses  @gol
590 -mexplicit-relocs  -mno-explicit-relocs  @gol
591 -mcheck-zero-division  -mno-check-zero-division @gol
592 -mdivide-traps  -mdivide-breaks @gol
593 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
594 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
595 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
596 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
597 -mfix-sb1  -mno-fix-sb1 @gol
598 -mflush-func=@var{func}  -mno-flush-func @gol
599 -mbranch-likely  -mno-branch-likely @gol
600 -mfp-exceptions -mno-fp-exceptions @gol
601 -mvr4130-align -mno-vr4130-align}
603 @emph{MMIX Options}
604 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
605 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
606 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
607 -mno-base-addresses  -msingle-exit  -mno-single-exit}
609 @emph{MN10300 Options}
610 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
611 -mam33  -mno-am33 @gol
612 -mam33-2  -mno-am33-2 @gol
613 -mreturn-pointer-on-d0 @gol
614 -mno-crt0  -mrelax}
616 @emph{MS1 Options}
617 @gccoptlist{-mno-crt0 -mmul -mbacc -msim @gol
618 -march=@var{cpu-type} }
620 @emph{PDP-11 Options}
621 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
622 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
623 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
624 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
625 -mbranch-expensive  -mbranch-cheap @gol
626 -msplit  -mno-split  -munix-asm  -mdec-asm}
628 @emph{PowerPC Options}
629 See RS/6000 and PowerPC Options.
631 @emph{RS/6000 and PowerPC Options}
632 @gccoptlist{-mcpu=@var{cpu-type} @gol
633 -mtune=@var{cpu-type} @gol
634 -mpower  -mno-power  -mpower2  -mno-power2 @gol
635 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
636 -maltivec  -mno-altivec @gol
637 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
638 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
639 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
640 -mnew-mnemonics  -mold-mnemonics @gol
641 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
642 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
643 -malign-power  -malign-natural @gol
644 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
645 -mstring  -mno-string  -mupdate  -mno-update @gol
646 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
647 -mstrict-align  -mno-strict-align  -mrelocatable @gol
648 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
649 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
650 -mdynamic-no-pic  -maltivec  -mswdiv @gol
651 -mprioritize-restricted-insns=@var{priority} @gol
652 -msched-costly-dep=@var{dependence_type} @gol
653 -minsert-sched-nops=@var{scheme} @gol
654 -mcall-sysv  -mcall-netbsd @gol
655 -maix-struct-return  -msvr4-struct-return @gol
656 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
657 -misel -mno-isel @gol
658 -misel=yes  -misel=no @gol
659 -mspe -mno-spe @gol
660 -mspe=yes  -mspe=no @gol
661 -mvrsave -mno-vrsave @gol
662 -mmulhw -mno-mulhw @gol
663 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
664 -mprototype  -mno-prototype @gol
665 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
666 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
668 @emph{S/390 and zSeries Options}
669 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
670 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
671 -mpacked-stack  -mno-packed-stack @gol
672 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
673 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
674 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
675 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
677 @emph{SH Options}
678 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
679 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
680 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
681 -m5-64media  -m5-64media-nofpu @gol
682 -m5-32media  -m5-32media-nofpu @gol
683 -m5-compact  -m5-compact-nofpu @gol
684 -mb  -ml  -mdalign  -mrelax @gol
685 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
686 -mieee  -misize  -mpadstruct  -mspace @gol
687 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
688 -mdivsi3_libfunc=@var{name}  @gol
689 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
690  -minvalid-symbols}
692 @emph{SPARC Options}
693 @gccoptlist{-mcpu=@var{cpu-type} @gol
694 -mtune=@var{cpu-type} @gol
695 -mcmodel=@var{code-model} @gol
696 -m32  -m64  -mapp-regs  -mno-app-regs @gol
697 -mfaster-structs  -mno-faster-structs @gol
698 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
699 -mhard-quad-float  -msoft-quad-float @gol
700 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
701 -mstack-bias  -mno-stack-bias @gol
702 -munaligned-doubles  -mno-unaligned-doubles @gol
703 -mv8plus  -mno-v8plus  -mvis  -mno-vis
704 -threads -pthreads}
706 @emph{System V Options}
707 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
709 @emph{TMS320C3x/C4x Options}
710 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
711 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
712 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
713 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
715 @emph{V850 Options}
716 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
717 -mprolog-function  -mno-prolog-function  -mspace @gol
718 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
719 -mapp-regs  -mno-app-regs @gol
720 -mdisable-callt  -mno-disable-callt @gol
721 -mv850e1 @gol
722 -mv850e @gol
723 -mv850  -mbig-switch}
725 @emph{VAX Options}
726 @gccoptlist{-mg  -mgnu  -munix}
728 @emph{x86-64 Options}
729 See i386 and x86-64 Options.
731 @emph{Xstormy16 Options}
732 @gccoptlist{-msim}
734 @emph{Xtensa Options}
735 @gccoptlist{-mconst16 -mno-const16 @gol
736 -mfused-madd  -mno-fused-madd @gol
737 -mtext-section-literals  -mno-text-section-literals @gol
738 -mtarget-align  -mno-target-align @gol
739 -mlongcalls  -mno-longcalls}
741 @emph{zSeries Options}
742 See S/390 and zSeries Options.
744 @item Code Generation Options
745 @xref{Code Gen Options,,Options for Code Generation Conventions}.
746 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
747 -ffixed-@var{reg}  -fexceptions @gol
748 -fnon-call-exceptions  -funwind-tables @gol
749 -fasynchronous-unwind-tables @gol
750 -finhibit-size-directive  -finstrument-functions @gol
751 -fno-common  -fno-ident @gol
752 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
753 -fno-jump-tables @gol
754 -freg-struct-return  -fshared-data  -fshort-enums @gol
755 -fshort-double  -fshort-wchar @gol
756 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
757 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
758 -fargument-alias  -fargument-noalias @gol
759 -fargument-noalias-global  -fleading-underscore @gol
760 -ftls-model=@var{model} @gol
761 -ftrapv  -fwrapv  -fbounds-check @gol
762 -fvisibility}
763 @end table
765 @menu
766 * Overall Options::     Controlling the kind of output:
767                         an executable, object files, assembler files,
768                         or preprocessed source.
769 * C Dialect Options::   Controlling the variant of C language compiled.
770 * C++ Dialect Options:: Variations on C++.
771 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
772                         and Objective-C++.
773 * Language Independent Options:: Controlling how diagnostics should be
774                         formatted.
775 * Warning Options::     How picky should the compiler be?
776 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
777 * Optimize Options::    How much optimization?
778 * Preprocessor Options:: Controlling header files and macro definitions.
779                          Also, getting dependency information for Make.
780 * Assembler Options::   Passing options to the assembler.
781 * Link Options::        Specifying libraries and so on.
782 * Directory Options::   Where to find header files and libraries.
783                         Where to find the compiler executable files.
784 * Spec Files::          How to pass switches to sub-processes.
785 * Target Options::      Running a cross-compiler, or an old version of GCC.
786 @end menu
788 @node Overall Options
789 @section Options Controlling the Kind of Output
791 Compilation can involve up to four stages: preprocessing, compilation
792 proper, assembly and linking, always in that order.  GCC is capable of
793 preprocessing and compiling several files either into several
794 assembler input files, or into one assembler input file; then each
795 assembler input file produces an object file, and linking combines all
796 the object files (those newly compiled, and those specified as input)
797 into an executable file.
799 @cindex file name suffix
800 For any given input file, the file name suffix determines what kind of
801 compilation is done:
803 @table @gcctabopt
804 @item @var{file}.c
805 C source code which must be preprocessed.
807 @item @var{file}.i
808 C source code which should not be preprocessed.
810 @item @var{file}.ii
811 C++ source code which should not be preprocessed.
813 @item @var{file}.m
814 Objective-C source code.  Note that you must link with the @file{libobjc}
815 library to make an Objective-C program work.
817 @item @var{file}.mi
818 Objective-C source code which should not be preprocessed.
820 @item @var{file}.mm
821 @itemx @var{file}.M
822 Objective-C++ source code.  Note that you must link with the @file{libobjc}
823 library to make an Objective-C++ program work.  Note that @samp{.M} refers
824 to a literal capital M@.
826 @item @var{file}.mii
827 Objective-C++ source code which should not be preprocessed.
829 @item @var{file}.h
830 C, C++, Objective-C or Objective-C++ header file to be turned into a
831 precompiled header.
833 @item @var{file}.cc
834 @itemx @var{file}.cp
835 @itemx @var{file}.cxx
836 @itemx @var{file}.cpp
837 @itemx @var{file}.CPP
838 @itemx @var{file}.c++
839 @itemx @var{file}.C
840 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
841 the last two letters must both be literally @samp{x}.  Likewise,
842 @samp{.C} refers to a literal capital C@.
844 @item @var{file}.mm
845 @itemx @var{file}.M
846 Objective-C++ source code which must be preprocessed.
848 @item @var{file}.mii
849 Objective-C++ source code which should not be preprocessed.
851 @item @var{file}.hh
852 @itemx @var{file}.H
853 C++ header file to be turned into a precompiled header.
855 @item @var{file}.f
856 @itemx @var{file}.for
857 @itemx @var{file}.FOR
858 Fixed form Fortran source code which should not be preprocessed.
860 @item @var{file}.F
861 @itemx @var{file}.fpp
862 @itemx @var{file}.FPP
863 Fixed form Fortran source code which must be preprocessed (with the traditional
864 preprocessor).
866 @item @var{file}.f90
867 @itemx @var{file}.f95
868 Free form Fortran source code which should not be preprocessed.
870 @item @var{file}.F90
871 @itemx @var{file}.F95
872 Free form Fortran source code which must be preprocessed (with the
873 traditional preprocessor).
875 @c FIXME: Descriptions of Java file types.
876 @c @var{file}.java
877 @c @var{file}.class
878 @c @var{file}.zip
879 @c @var{file}.jar
881 @item @var{file}.ads
882 Ada source code file which contains a library unit declaration (a
883 declaration of a package, subprogram, or generic, or a generic
884 instantiation), or a library unit renaming declaration (a package,
885 generic, or subprogram renaming declaration).  Such files are also
886 called @dfn{specs}.
888 @itemx @var{file}.adb
889 Ada source code file containing a library unit body (a subprogram or
890 package body).  Such files are also called @dfn{bodies}.
892 @c GCC also knows about some suffixes for languages not yet included:
893 @c Pascal:
894 @c @var{file}.p
895 @c @var{file}.pas
896 @c Ratfor:
897 @c @var{file}.r
899 @item @var{file}.s
900 Assembler code.
902 @item @var{file}.S
903 Assembler code which must be preprocessed.
905 @item @var{other}
906 An object file to be fed straight into linking.
907 Any file name with no recognized suffix is treated this way.
908 @end table
910 @opindex x
911 You can specify the input language explicitly with the @option{-x} option:
913 @table @gcctabopt
914 @item -x @var{language}
915 Specify explicitly the @var{language} for the following input files
916 (rather than letting the compiler choose a default based on the file
917 name suffix).  This option applies to all following input files until
918 the next @option{-x} option.  Possible values for @var{language} are:
919 @smallexample
920 c  c-header  c-cpp-output
921 c++  c++-header  c++-cpp-output
922 objective-c  objective-c-header  objective-c-cpp-output
923 objective-c++ objective-c++-header objective-c++-cpp-output
924 assembler  assembler-with-cpp
926 f77  f77-cpp-input
927 f95  f95-cpp-input
928 java
929 treelang
930 @end smallexample
932 @item -x none
933 Turn off any specification of a language, so that subsequent files are
934 handled according to their file name suffixes (as they are if @option{-x}
935 has not been used at all).
937 @item -pass-exit-codes
938 @opindex pass-exit-codes
939 Normally the @command{gcc} program will exit with the code of 1 if any
940 phase of the compiler returns a non-success return code.  If you specify
941 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
942 numerically highest error produced by any phase that returned an error
943 indication.
944 @end table
946 If you only want some of the stages of compilation, you can use
947 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
948 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
949 @command{gcc} is to stop.  Note that some combinations (for example,
950 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
952 @table @gcctabopt
953 @item -c
954 @opindex c
955 Compile or assemble the source files, but do not link.  The linking
956 stage simply is not done.  The ultimate output is in the form of an
957 object file for each source file.
959 By default, the object file name for a source file is made by replacing
960 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
962 Unrecognized input files, not requiring compilation or assembly, are
963 ignored.
965 @item -S
966 @opindex S
967 Stop after the stage of compilation proper; do not assemble.  The output
968 is in the form of an assembler code file for each non-assembler input
969 file specified.
971 By default, the assembler file name for a source file is made by
972 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
974 Input files that don't require compilation are ignored.
976 @item -E
977 @opindex E
978 Stop after the preprocessing stage; do not run the compiler proper.  The
979 output is in the form of preprocessed source code, which is sent to the
980 standard output.
982 Input files which don't require preprocessing are ignored.
984 @cindex output file option
985 @item -o @var{file}
986 @opindex o
987 Place output in file @var{file}.  This applies regardless to whatever
988 sort of output is being produced, whether it be an executable file,
989 an object file, an assembler file or preprocessed C code.
991 If @option{-o} is not specified, the default is to put an executable
992 file in @file{a.out}, the object file for
993 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
994 assembler file in @file{@var{source}.s}, a precompiled header file in
995 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
996 standard output.
998 @item -v
999 @opindex v
1000 Print (on standard error output) the commands executed to run the stages
1001 of compilation.  Also print the version number of the compiler driver
1002 program and of the preprocessor and the compiler proper.
1004 @item -###
1005 @opindex ###
1006 Like @option{-v} except the commands are not executed and all command
1007 arguments are quoted.  This is useful for shell scripts to capture the
1008 driver-generated command lines.
1010 @item -pipe
1011 @opindex pipe
1012 Use pipes rather than temporary files for communication between the
1013 various stages of compilation.  This fails to work on some systems where
1014 the assembler is unable to read from a pipe; but the GNU assembler has
1015 no trouble.
1017 @item -combine
1018 @opindex combine
1019 If you are compiling multiple source files, this option tells the driver
1020 to pass all the source files to the compiler at once (for those
1021 languages for which the compiler can handle this).  This will allow
1022 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1023 language for which this is supported is C@.  If you pass source files for
1024 multiple languages to the driver, using this option, the driver will invoke
1025 the compiler(s) that support IMA once each, passing each compiler all the
1026 source files appropriate for it.  For those languages that do not support
1027 IMA this option will be ignored, and the compiler will be invoked once for
1028 each source file in that language.  If you use this option in conjunction
1029 with @option{-save-temps}, the compiler will generate multiple
1030 pre-processed files
1031 (one for each source file), but only one (combined) @file{.o} or
1032 @file{.s} file.
1034 @item --help
1035 @opindex help
1036 Print (on the standard output) a description of the command line options
1037 understood by @command{gcc}.  If the @option{-v} option is also specified
1038 then @option{--help} will also be passed on to the various processes
1039 invoked by @command{gcc}, so that they can display the command line options
1040 they accept.  If the @option{-Wextra} option is also specified then command
1041 line options which have no documentation associated with them will also
1042 be displayed.
1044 @item --target-help
1045 @opindex target-help
1046 Print (on the standard output) a description of target specific command
1047 line options for each tool.
1049 @item --version
1050 @opindex version
1051 Display the version number and copyrights of the invoked GCC@.
1052 @end table
1054 @node Invoking G++
1055 @section Compiling C++ Programs
1057 @cindex suffixes for C++ source
1058 @cindex C++ source file suffixes
1059 C++ source files conventionally use one of the suffixes @samp{.C},
1060 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1061 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1062 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1063 files with these names and compiles them as C++ programs even if you
1064 call the compiler the same way as for compiling C programs (usually
1065 with the name @command{gcc}).
1067 @findex g++
1068 @findex c++
1069 However, C++ programs often require class libraries as well as a
1070 compiler that understands the C++ language---and under some
1071 circumstances, you might want to compile programs or header files from
1072 standard input, or otherwise without a suffix that flags them as C++
1073 programs.  You might also like to precompile a C header file with a
1074 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1075 program that calls GCC with the default language set to C++, and
1076 automatically specifies linking against the C++ library.  On many
1077 systems, @command{g++} is also installed with the name @command{c++}.
1079 @cindex invoking @command{g++}
1080 When you compile C++ programs, you may specify many of the same
1081 command-line options that you use for compiling programs in any
1082 language; or command-line options meaningful for C and related
1083 languages; or options that are meaningful only for C++ programs.
1084 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1085 explanations of options for languages related to C@.
1086 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1087 explanations of options that are meaningful only for C++ programs.
1089 @node C Dialect Options
1090 @section Options Controlling C Dialect
1091 @cindex dialect options
1092 @cindex language dialect options
1093 @cindex options, dialect
1095 The following options control the dialect of C (or languages derived
1096 from C, such as C++, Objective-C and Objective-C++) that the compiler
1097 accepts:
1099 @table @gcctabopt
1100 @cindex ANSI support
1101 @cindex ISO support
1102 @item -ansi
1103 @opindex ansi
1104 In C mode, support all ISO C90 programs.  In C++ mode,
1105 remove GNU extensions that conflict with ISO C++.
1107 This turns off certain features of GCC that are incompatible with ISO
1108 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1109 such as the @code{asm} and @code{typeof} keywords, and
1110 predefined macros such as @code{unix} and @code{vax} that identify the
1111 type of system you are using.  It also enables the undesirable and
1112 rarely used ISO trigraph feature.  For the C compiler,
1113 it disables recognition of C++ style @samp{//} comments as well as
1114 the @code{inline} keyword.
1116 The alternate keywords @code{__asm__}, @code{__extension__},
1117 @code{__inline__} and @code{__typeof__} continue to work despite
1118 @option{-ansi}.  You would not want to use them in an ISO C program, of
1119 course, but it is useful to put them in header files that might be included
1120 in compilations done with @option{-ansi}.  Alternate predefined macros
1121 such as @code{__unix__} and @code{__vax__} are also available, with or
1122 without @option{-ansi}.
1124 The @option{-ansi} option does not cause non-ISO programs to be
1125 rejected gratuitously.  For that, @option{-pedantic} is required in
1126 addition to @option{-ansi}.  @xref{Warning Options}.
1128 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1129 option is used.  Some header files may notice this macro and refrain
1130 from declaring certain functions or defining certain macros that the
1131 ISO standard doesn't call for; this is to avoid interfering with any
1132 programs that might use these names for other things.
1134 Functions which would normally be built in but do not have semantics
1135 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1136 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1137 built-in functions provided by GCC}, for details of the functions
1138 affected.
1140 @item -std=
1141 @opindex std
1142 Determine the language standard.  This option is currently only
1143 supported when compiling C or C++.  A value for this option must be
1144 provided; possible values are
1146 @table @samp
1147 @item c89
1148 @itemx iso9899:1990
1149 ISO C90 (same as @option{-ansi}).
1151 @item iso9899:199409
1152 ISO C90 as modified in amendment 1.
1154 @item c99
1155 @itemx c9x
1156 @itemx iso9899:1999
1157 @itemx iso9899:199x
1158 ISO C99.  Note that this standard is not yet fully supported; see
1159 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1160 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1162 @item gnu89
1163 Default, ISO C90 plus GNU extensions (including some C99 features).
1165 @item gnu99
1166 @itemx gnu9x
1167 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1168 this will become the default.  The name @samp{gnu9x} is deprecated.
1170 @item c++98
1171 The 1998 ISO C++ standard plus amendments.
1173 @item gnu++98
1174 The same as @option{-std=c++98} plus GNU extensions.  This is the
1175 default for C++ code.
1176 @end table
1178 Even when this option is not specified, you can still use some of the
1179 features of newer standards in so far as they do not conflict with
1180 previous C standards.  For example, you may use @code{__restrict__} even
1181 when @option{-std=c99} is not specified.
1183 The @option{-std} options specifying some version of ISO C have the same
1184 effects as @option{-ansi}, except that features that were not in ISO C90
1185 but are in the specified version (for example, @samp{//} comments and
1186 the @code{inline} keyword in ISO C99) are not disabled.
1188 @xref{Standards,,Language Standards Supported by GCC}, for details of
1189 these standard versions.
1191 @item -aux-info @var{filename}
1192 @opindex aux-info
1193 Output to the given filename prototyped declarations for all functions
1194 declared and/or defined in a translation unit, including those in header
1195 files.  This option is silently ignored in any language other than C@.
1197 Besides declarations, the file indicates, in comments, the origin of
1198 each declaration (source file and line), whether the declaration was
1199 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1200 @samp{O} for old, respectively, in the first character after the line
1201 number and the colon), and whether it came from a declaration or a
1202 definition (@samp{C} or @samp{F}, respectively, in the following
1203 character).  In the case of function definitions, a K&R-style list of
1204 arguments followed by their declarations is also provided, inside
1205 comments, after the declaration.
1207 @item -fno-asm
1208 @opindex fno-asm
1209 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1210 keyword, so that code can use these words as identifiers.  You can use
1211 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1212 instead.  @option{-ansi} implies @option{-fno-asm}.
1214 In C++, this switch only affects the @code{typeof} keyword, since
1215 @code{asm} and @code{inline} are standard keywords.  You may want to
1216 use the @option{-fno-gnu-keywords} flag instead, which has the same
1217 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1218 switch only affects the @code{asm} and @code{typeof} keywords, since
1219 @code{inline} is a standard keyword in ISO C99.
1221 @item -fno-builtin
1222 @itemx -fno-builtin-@var{function}
1223 @opindex fno-builtin
1224 @cindex built-in functions
1225 Don't recognize built-in functions that do not begin with
1226 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1227 functions provided by GCC}, for details of the functions affected,
1228 including those which are not built-in functions when @option{-ansi} or
1229 @option{-std} options for strict ISO C conformance are used because they
1230 do not have an ISO standard meaning.
1232 GCC normally generates special code to handle certain built-in functions
1233 more efficiently; for instance, calls to @code{alloca} may become single
1234 instructions that adjust the stack directly, and calls to @code{memcpy}
1235 may become inline copy loops.  The resulting code is often both smaller
1236 and faster, but since the function calls no longer appear as such, you
1237 cannot set a breakpoint on those calls, nor can you change the behavior
1238 of the functions by linking with a different library.  In addition,
1239 when a function is recognized as a built-in function, GCC may use
1240 information about that function to warn about problems with calls to
1241 that function, or to generate more efficient code, even if the
1242 resulting code still contains calls to that function.  For example,
1243 warnings are given with @option{-Wformat} for bad calls to
1244 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1245 known not to modify global memory.
1247 With the @option{-fno-builtin-@var{function}} option
1248 only the built-in function @var{function} is
1249 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1250 function is named this is not built-in in this version of GCC, this
1251 option is ignored.  There is no corresponding
1252 @option{-fbuiltin-@var{function}} option; if you wish to enable
1253 built-in functions selectively when using @option{-fno-builtin} or
1254 @option{-ffreestanding}, you may define macros such as:
1256 @smallexample
1257 #define abs(n)          __builtin_abs ((n))
1258 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1259 @end smallexample
1261 @item -fhosted
1262 @opindex fhosted
1263 @cindex hosted environment
1265 Assert that compilation takes place in a hosted environment.  This implies
1266 @option{-fbuiltin}.  A hosted environment is one in which the
1267 entire standard library is available, and in which @code{main} has a return
1268 type of @code{int}.  Examples are nearly everything except a kernel.
1269 This is equivalent to @option{-fno-freestanding}.
1271 @item -ffreestanding
1272 @opindex ffreestanding
1273 @cindex hosted environment
1275 Assert that compilation takes place in a freestanding environment.  This
1276 implies @option{-fno-builtin}.  A freestanding environment
1277 is one in which the standard library may not exist, and program startup may
1278 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1279 This is equivalent to @option{-fno-hosted}.
1281 @xref{Standards,,Language Standards Supported by GCC}, for details of
1282 freestanding and hosted environments.
1284 @item -fms-extensions
1285 @opindex fms-extensions
1286 Accept some non-standard constructs used in Microsoft header files.
1288 Some cases of unnamed fields in structures and unions are only
1289 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1290 fields within structs/unions}, for details.
1292 @item -trigraphs
1293 @opindex trigraphs
1294 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1295 options for strict ISO C conformance) implies @option{-trigraphs}.
1297 @item -no-integrated-cpp
1298 @opindex no-integrated-cpp
1299 Performs a compilation in two passes: preprocessing and compiling.  This
1300 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1301 @option{-B} option.  The user supplied compilation step can then add in
1302 an additional preprocessing step after normal preprocessing but before
1303 compiling.  The default is to use the integrated cpp (internal cpp)
1305 The semantics of this option will change if "cc1", "cc1plus", and
1306 "cc1obj" are merged.
1308 @cindex traditional C language
1309 @cindex C language, traditional
1310 @item -traditional
1311 @itemx -traditional-cpp
1312 @opindex traditional-cpp
1313 @opindex traditional
1314 Formerly, these options caused GCC to attempt to emulate a pre-standard
1315 C compiler.  They are now only supported with the @option{-E} switch.
1316 The preprocessor continues to support a pre-standard mode.  See the GNU
1317 CPP manual for details.
1319 @item -fcond-mismatch
1320 @opindex fcond-mismatch
1321 Allow conditional expressions with mismatched types in the second and
1322 third arguments.  The value of such an expression is void.  This option
1323 is not supported for C++.
1325 @item -funsigned-char
1326 @opindex funsigned-char
1327 Let the type @code{char} be unsigned, like @code{unsigned char}.
1329 Each kind of machine has a default for what @code{char} should
1330 be.  It is either like @code{unsigned char} by default or like
1331 @code{signed char} by default.
1333 Ideally, a portable program should always use @code{signed char} or
1334 @code{unsigned char} when it depends on the signedness of an object.
1335 But many programs have been written to use plain @code{char} and
1336 expect it to be signed, or expect it to be unsigned, depending on the
1337 machines they were written for.  This option, and its inverse, let you
1338 make such a program work with the opposite default.
1340 The type @code{char} is always a distinct type from each of
1341 @code{signed char} or @code{unsigned char}, even though its behavior
1342 is always just like one of those two.
1344 @item -fsigned-char
1345 @opindex fsigned-char
1346 Let the type @code{char} be signed, like @code{signed char}.
1348 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1349 the negative form of @option{-funsigned-char}.  Likewise, the option
1350 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1352 @item -fsigned-bitfields
1353 @itemx -funsigned-bitfields
1354 @itemx -fno-signed-bitfields
1355 @itemx -fno-unsigned-bitfields
1356 @opindex fsigned-bitfields
1357 @opindex funsigned-bitfields
1358 @opindex fno-signed-bitfields
1359 @opindex fno-unsigned-bitfields
1360 These options control whether a bit-field is signed or unsigned, when the
1361 declaration does not use either @code{signed} or @code{unsigned}.  By
1362 default, such a bit-field is signed, because this is consistent: the
1363 basic integer types such as @code{int} are signed types.
1364 @end table
1366 @node C++ Dialect Options
1367 @section Options Controlling C++ Dialect
1369 @cindex compiler options, C++
1370 @cindex C++ options, command line
1371 @cindex options, C++
1372 This section describes the command-line options that are only meaningful
1373 for C++ programs; but you can also use most of the GNU compiler options
1374 regardless of what language your program is in.  For example, you
1375 might compile a file @code{firstClass.C} like this:
1377 @smallexample
1378 g++ -g -frepo -O -c firstClass.C
1379 @end smallexample
1381 @noindent
1382 In this example, only @option{-frepo} is an option meant
1383 only for C++ programs; you can use the other options with any
1384 language supported by GCC@.
1386 Here is a list of options that are @emph{only} for compiling C++ programs:
1388 @table @gcctabopt
1390 @item -fabi-version=@var{n}
1391 @opindex fabi-version
1392 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1393 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1394 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1395 the version that conforms most closely to the C++ ABI specification.
1396 Therefore, the ABI obtained using version 0 will change as ABI bugs
1397 are fixed.
1399 The default is version 2.
1401 @item -fno-access-control
1402 @opindex fno-access-control
1403 Turn off all access checking.  This switch is mainly useful for working
1404 around bugs in the access control code.
1406 @item -fcheck-new
1407 @opindex fcheck-new
1408 Check that the pointer returned by @code{operator new} is non-null
1409 before attempting to modify the storage allocated.  This check is
1410 normally unnecessary because the C++ standard specifies that
1411 @code{operator new} will only return @code{0} if it is declared
1412 @samp{throw()}, in which case the compiler will always check the
1413 return value even without this option.  In all other cases, when
1414 @code{operator new} has a non-empty exception specification, memory
1415 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1416 @samp{new (nothrow)}.
1418 @item -fconserve-space
1419 @opindex fconserve-space
1420 Put uninitialized or runtime-initialized global variables into the
1421 common segment, as C does.  This saves space in the executable at the
1422 cost of not diagnosing duplicate definitions.  If you compile with this
1423 flag and your program mysteriously crashes after @code{main()} has
1424 completed, you may have an object that is being destroyed twice because
1425 two definitions were merged.
1427 This option is no longer useful on most targets, now that support has
1428 been added for putting variables into BSS without making them common.
1430 @item -ffriend-injection
1431 @opindex ffriend-injection
1432 Inject friend functions into the enclosing namespace, so that they are
1433 visible outside the scope of the class in which they are declared.
1434 Friend functions were documented to work this way in the old Annotated
1435 C++ Reference Manual, and versions of G++ before 4.1 always worked
1436 that way.  However, in ISO C++ a friend function which is not declared
1437 in an enclosing scope can only be found using argument dependent
1438 lookup.  This option causes friends to be injected as they were in
1439 earlier releases.
1441 This option is for compatibility, and may be removed in a future
1442 release of G++.
1444 @item -fno-const-strings
1445 @opindex fno-const-strings
1446 Give string constants type @code{char *} instead of type @code{const
1447 char *}.  By default, G++ uses type @code{const char *} as required by
1448 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1449 actually modify the value of a string constant.
1451 This option might be removed in a future release of G++.  For maximum
1452 portability, you should structure your code so that it works with
1453 string constants that have type @code{const char *}.
1455 @item -fno-elide-constructors
1456 @opindex fno-elide-constructors
1457 The C++ standard allows an implementation to omit creating a temporary
1458 which is only used to initialize another object of the same type.
1459 Specifying this option disables that optimization, and forces G++ to
1460 call the copy constructor in all cases.
1462 @item -fno-enforce-eh-specs
1463 @opindex fno-enforce-eh-specs
1464 Don't generate code to check for violation of exception specifications
1465 at runtime.  This option violates the C++ standard, but may be useful
1466 for reducing code size in production builds, much like defining
1467 @samp{NDEBUG}.  This does not give user code permission to throw
1468 exceptions in violation of the exception specifications; the compiler
1469 will still optimize based on the specifications, so throwing an
1470 unexpected exception will result in undefined behavior.
1472 @item -ffor-scope
1473 @itemx -fno-for-scope
1474 @opindex ffor-scope
1475 @opindex fno-for-scope
1476 If @option{-ffor-scope} is specified, the scope of variables declared in
1477 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1478 as specified by the C++ standard.
1479 If @option{-fno-for-scope} is specified, the scope of variables declared in
1480 a @i{for-init-statement} extends to the end of the enclosing scope,
1481 as was the case in old versions of G++, and other (traditional)
1482 implementations of C++.
1484 The default if neither flag is given to follow the standard,
1485 but to allow and give a warning for old-style code that would
1486 otherwise be invalid, or have different behavior.
1488 @item -fno-gnu-keywords
1489 @opindex fno-gnu-keywords
1490 Do not recognize @code{typeof} as a keyword, so that code can use this
1491 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1492 @option{-ansi} implies @option{-fno-gnu-keywords}.
1494 @item -fno-implicit-templates
1495 @opindex fno-implicit-templates
1496 Never emit code for non-inline templates which are instantiated
1497 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1498 @xref{Template Instantiation}, for more information.
1500 @item -fno-implicit-inline-templates
1501 @opindex fno-implicit-inline-templates
1502 Don't emit code for implicit instantiations of inline templates, either.
1503 The default is to handle inlines differently so that compiles with and
1504 without optimization will need the same set of explicit instantiations.
1506 @item -fno-implement-inlines
1507 @opindex fno-implement-inlines
1508 To save space, do not emit out-of-line copies of inline functions
1509 controlled by @samp{#pragma implementation}.  This will cause linker
1510 errors if these functions are not inlined everywhere they are called.
1512 @item -fms-extensions
1513 @opindex fms-extensions
1514 Disable pedantic warnings about constructs used in MFC, such as implicit
1515 int and getting a pointer to member function via non-standard syntax.
1517 @item -fno-nonansi-builtins
1518 @opindex fno-nonansi-builtins
1519 Disable built-in declarations of functions that are not mandated by
1520 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1521 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1523 @item -fno-operator-names
1524 @opindex fno-operator-names
1525 Do not treat the operator name keywords @code{and}, @code{bitand},
1526 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1527 synonyms as keywords.
1529 @item -fno-optional-diags
1530 @opindex fno-optional-diags
1531 Disable diagnostics that the standard says a compiler does not need to
1532 issue.  Currently, the only such diagnostic issued by G++ is the one for
1533 a name having multiple meanings within a class.
1535 @item -fpermissive
1536 @opindex fpermissive
1537 Downgrade some diagnostics about nonconformant code from errors to
1538 warnings.  Thus, using @option{-fpermissive} will allow some
1539 nonconforming code to compile.
1541 @item -frepo
1542 @opindex frepo
1543 Enable automatic template instantiation at link time.  This option also
1544 implies @option{-fno-implicit-templates}.  @xref{Template
1545 Instantiation}, for more information.
1547 @item -fno-rtti
1548 @opindex fno-rtti
1549 Disable generation of information about every class with virtual
1550 functions for use by the C++ runtime type identification features
1551 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1552 of the language, you can save some space by using this flag.  Note that
1553 exception handling uses the same information, but it will generate it as
1554 needed.
1556 @item -fstats
1557 @opindex fstats
1558 Emit statistics about front-end processing at the end of the compilation.
1559 This information is generally only useful to the G++ development team.
1561 @item -ftemplate-depth-@var{n}
1562 @opindex ftemplate-depth
1563 Set the maximum instantiation depth for template classes to @var{n}.
1564 A limit on the template instantiation depth is needed to detect
1565 endless recursions during template class instantiation.  ANSI/ISO C++
1566 conforming programs must not rely on a maximum depth greater than 17.
1568 @item -fno-threadsafe-statics
1569 @opindex fno-threadsafe-statics
1570 Do not emit the extra code to use the routines specified in the C++
1571 ABI for thread-safe initialization of local statics.  You can use this
1572 option to reduce code size slightly in code that doesn't need to be
1573 thread-safe.
1575 @item -fuse-cxa-atexit
1576 @opindex fuse-cxa-atexit
1577 Register destructors for objects with static storage duration with the
1578 @code{__cxa_atexit} function rather than the @code{atexit} function.
1579 This option is required for fully standards-compliant handling of static
1580 destructors, but will only work if your C library supports
1581 @code{__cxa_atexit}.
1583 @item -fvisibility-inlines-hidden
1584 @opindex fvisibility-inlines-hidden
1585 Causes all inlined methods to be marked with
1586 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1587 appear in the export table of a DSO and do not require a PLT indirection
1588 when used within the DSO@.  Enabling this option can have a dramatic effect
1589 on load and link times of a DSO as it massively reduces the size of the
1590 dynamic export table when the library makes heavy use of templates.  While
1591 it can cause bloating through duplication of code within each DSO where
1592 it is used, often the wastage is less than the considerable space occupied
1593 by a long symbol name in the export table which is typical when using
1594 templates and namespaces.  For even more savings, combine with the
1595 @option{-fvisibility=hidden} switch.
1597 @item -fno-weak
1598 @opindex fno-weak
1599 Do not use weak symbol support, even if it is provided by the linker.
1600 By default, G++ will use weak symbols if they are available.  This
1601 option exists only for testing, and should not be used by end-users;
1602 it will result in inferior code and has no benefits.  This option may
1603 be removed in a future release of G++.
1605 @item -nostdinc++
1606 @opindex nostdinc++
1607 Do not search for header files in the standard directories specific to
1608 C++, but do still search the other standard directories.  (This option
1609 is used when building the C++ library.)
1610 @end table
1612 In addition, these optimization, warning, and code generation options
1613 have meanings only for C++ programs:
1615 @table @gcctabopt
1616 @item -fno-default-inline
1617 @opindex fno-default-inline
1618 Do not assume @samp{inline} for functions defined inside a class scope.
1619 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1620 functions will have linkage like inline functions; they just won't be
1621 inlined by default.
1623 @item -Wabi @r{(C++ only)}
1624 @opindex Wabi
1625 Warn when G++ generates code that is probably not compatible with the
1626 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1627 all such cases, there are probably some cases that are not warned about,
1628 even though G++ is generating incompatible code.  There may also be
1629 cases where warnings are emitted even though the code that is generated
1630 will be compatible.
1632 You should rewrite your code to avoid these warnings if you are
1633 concerned about the fact that code generated by G++ may not be binary
1634 compatible with code generated by other compilers.
1636 The known incompatibilities at this point include:
1638 @itemize @bullet
1640 @item
1641 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1642 pack data into the same byte as a base class.  For example:
1644 @smallexample
1645 struct A @{ virtual void f(); int f1 : 1; @};
1646 struct B : public A @{ int f2 : 1; @};
1647 @end smallexample
1649 @noindent
1650 In this case, G++ will place @code{B::f2} into the same byte
1651 as@code{A::f1}; other compilers will not.  You can avoid this problem
1652 by explicitly padding @code{A} so that its size is a multiple of the
1653 byte size on your platform; that will cause G++ and other compilers to
1654 layout @code{B} identically.
1656 @item
1657 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1658 tail padding when laying out virtual bases.  For example:
1660 @smallexample
1661 struct A @{ virtual void f(); char c1; @};
1662 struct B @{ B(); char c2; @};
1663 struct C : public A, public virtual B @{@};
1664 @end smallexample
1666 @noindent
1667 In this case, G++ will not place @code{B} into the tail-padding for
1668 @code{A}; other compilers will.  You can avoid this problem by
1669 explicitly padding @code{A} so that its size is a multiple of its
1670 alignment (ignoring virtual base classes); that will cause G++ and other
1671 compilers to layout @code{C} identically.
1673 @item
1674 Incorrect handling of bit-fields with declared widths greater than that
1675 of their underlying types, when the bit-fields appear in a union.  For
1676 example:
1678 @smallexample
1679 union U @{ int i : 4096; @};
1680 @end smallexample
1682 @noindent
1683 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1684 union too small by the number of bits in an @code{int}.
1686 @item
1687 Empty classes can be placed at incorrect offsets.  For example:
1689 @smallexample
1690 struct A @{@};
1692 struct B @{
1693   A a;
1694   virtual void f ();
1697 struct C : public B, public A @{@};
1698 @end smallexample
1700 @noindent
1701 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1702 it should be placed at offset zero.  G++ mistakenly believes that the
1703 @code{A} data member of @code{B} is already at offset zero.
1705 @item
1706 Names of template functions whose types involve @code{typename} or
1707 template template parameters can be mangled incorrectly.
1709 @smallexample
1710 template <typename Q>
1711 void f(typename Q::X) @{@}
1713 template <template <typename> class Q>
1714 void f(typename Q<int>::X) @{@}
1715 @end smallexample
1717 @noindent
1718 Instantiations of these templates may be mangled incorrectly.
1720 @end itemize
1722 @item -Wctor-dtor-privacy @r{(C++ only)}
1723 @opindex Wctor-dtor-privacy
1724 Warn when a class seems unusable because all the constructors or
1725 destructors in that class are private, and it has neither friends nor
1726 public static member functions.
1728 @item -Wnon-virtual-dtor @r{(C++ only)}
1729 @opindex Wnon-virtual-dtor
1730 Warn when a class appears to be polymorphic, thereby requiring a virtual
1731 destructor, yet it declares a non-virtual one.
1732 This warning is enabled by @option{-Wall}.
1734 @item -Wreorder @r{(C++ only)}
1735 @opindex Wreorder
1736 @cindex reordering, warning
1737 @cindex warning for reordering of member initializers
1738 Warn when the order of member initializers given in the code does not
1739 match the order in which they must be executed.  For instance:
1741 @smallexample
1742 struct A @{
1743   int i;
1744   int j;
1745   A(): j (0), i (1) @{ @}
1747 @end smallexample
1749 The compiler will rearrange the member initializers for @samp{i}
1750 and @samp{j} to match the declaration order of the members, emitting
1751 a warning to that effect.  This warning is enabled by @option{-Wall}.
1752 @end table
1754 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1756 @table @gcctabopt
1757 @item -Weffc++ @r{(C++ only)}
1758 @opindex Weffc++
1759 Warn about violations of the following style guidelines from Scott Meyers'
1760 @cite{Effective C++} book:
1762 @itemize @bullet
1763 @item
1764 Item 11:  Define a copy constructor and an assignment operator for classes
1765 with dynamically allocated memory.
1767 @item
1768 Item 12:  Prefer initialization to assignment in constructors.
1770 @item
1771 Item 14:  Make destructors virtual in base classes.
1773 @item
1774 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1776 @item
1777 Item 23:  Don't try to return a reference when you must return an object.
1779 @end itemize
1781 Also warn about violations of the following style guidelines from
1782 Scott Meyers' @cite{More Effective C++} book:
1784 @itemize @bullet
1785 @item
1786 Item 6:  Distinguish between prefix and postfix forms of increment and
1787 decrement operators.
1789 @item
1790 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1792 @end itemize
1794 When selecting this option, be aware that the standard library
1795 headers do not obey all of these guidelines; use @samp{grep -v}
1796 to filter out those warnings.
1798 @item -Wno-deprecated @r{(C++ only)}
1799 @opindex Wno-deprecated
1800 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1802 @item -Wstrict-null-sentinel @r{(C++ only)}
1803 @opindex Wstrict-null-sentinel
1804 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1805 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1806 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1807 it is guaranteed to of the same size as a pointer.  But this use is
1808 not portable across different compilers.
1810 @item -Wno-non-template-friend @r{(C++ only)}
1811 @opindex Wno-non-template-friend
1812 Disable warnings when non-templatized friend functions are declared
1813 within a template.  Since the advent of explicit template specification
1814 support in G++, if the name of the friend is an unqualified-id (i.e.,
1815 @samp{friend foo(int)}), the C++ language specification demands that the
1816 friend declare or define an ordinary, nontemplate function.  (Section
1817 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1818 could be interpreted as a particular specialization of a templatized
1819 function.  Because this non-conforming behavior is no longer the default
1820 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1821 check existing code for potential trouble spots and is on by default.
1822 This new compiler behavior can be turned off with
1823 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1824 but disables the helpful warning.
1826 @item -Wold-style-cast @r{(C++ only)}
1827 @opindex Wold-style-cast
1828 Warn if an old-style (C-style) cast to a non-void type is used within
1829 a C++ program.  The new-style casts (@samp{dynamic_cast},
1830 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1831 less vulnerable to unintended effects and much easier to search for.
1833 @item -Woverloaded-virtual @r{(C++ only)}
1834 @opindex Woverloaded-virtual
1835 @cindex overloaded virtual fn, warning
1836 @cindex warning for overloaded virtual fn
1837 Warn when a function declaration hides virtual functions from a
1838 base class.  For example, in:
1840 @smallexample
1841 struct A @{
1842   virtual void f();
1845 struct B: public A @{
1846   void f(int);
1848 @end smallexample
1850 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1851 like:
1853 @smallexample
1854 B* b;
1855 b->f();
1856 @end smallexample
1858 will fail to compile.
1860 @item -Wno-pmf-conversions @r{(C++ only)}
1861 @opindex Wno-pmf-conversions
1862 Disable the diagnostic for converting a bound pointer to member function
1863 to a plain pointer.
1865 @item -Wsign-promo @r{(C++ only)}
1866 @opindex Wsign-promo
1867 Warn when overload resolution chooses a promotion from unsigned or
1868 enumerated type to a signed type, over a conversion to an unsigned type of
1869 the same size.  Previous versions of G++ would try to preserve
1870 unsignedness, but the standard mandates the current behavior.
1872 @smallexample
1873 struct A @{
1874   operator int ();
1875   A& operator = (int);
1878 main ()
1880   A a,b;
1881   a = b;
1883 @end smallexample
1885 In this example, G++ will synthesize a default @samp{A& operator =
1886 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1887 @end table
1889 @node Objective-C and Objective-C++ Dialect Options
1890 @section Options Controlling Objective-C and Objective-C++ Dialects
1892 @cindex compiler options, Objective-C and Objective-C++
1893 @cindex Objective-C and Objective-C++ options, command line
1894 @cindex options, Objective-C and Objective-C++
1895 (NOTE: This manual does not describe the Objective-C and Objective-C++
1896 languages themselves.  See @xref{Standards,,Language Standards
1897 Supported by GCC}, for references.)
1899 This section describes the command-line options that are only meaningful
1900 for Objective-C and Objective-C++ programs, but you can also use most of
1901 the language-independent GNU compiler options.
1902 For example, you might compile a file @code{some_class.m} like this:
1904 @smallexample
1905 gcc -g -fgnu-runtime -O -c some_class.m
1906 @end smallexample
1908 @noindent
1909 In this example, @option{-fgnu-runtime} is an option meant only for
1910 Objective-C and Objective-C++ programs; you can use the other options with
1911 any language supported by GCC@.
1913 Note that since Objective-C is an extension of the C language, Objective-C
1914 compilations may also use options specific to the C front-end (e.g.,
1915 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1916 C++-specific options (e.g., @option{-Wabi}).
1918 Here is a list of options that are @emph{only} for compiling Objective-C
1919 and Objective-C++ programs:
1921 @table @gcctabopt
1922 @item -fconstant-string-class=@var{class-name}
1923 @opindex fconstant-string-class
1924 Use @var{class-name} as the name of the class to instantiate for each
1925 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1926 class name is @code{NXConstantString} if the GNU runtime is being used, and
1927 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1928 @option{-fconstant-cfstrings} option, if also present, will override the
1929 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1930 to be laid out as constant CoreFoundation strings.
1932 @item -fgnu-runtime
1933 @opindex fgnu-runtime
1934 Generate object code compatible with the standard GNU Objective-C
1935 runtime.  This is the default for most types of systems.
1937 @item -fnext-runtime
1938 @opindex fnext-runtime
1939 Generate output compatible with the NeXT runtime.  This is the default
1940 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1941 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1942 used.
1944 @item -fno-nil-receivers
1945 @opindex fno-nil-receivers
1946 Assume that all Objective-C message dispatches (e.g.,
1947 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1948 is not @code{nil}.  This allows for more efficient entry points in the runtime
1949 to be used.  Currently, this option is only available in conjunction with
1950 the NeXT runtime on Mac OS X 10.3 and later.
1952 @item -fobjc-call-cxx-cdtors
1953 @opindex fobjc-call-cxx-cdtors
1954 For each Objective-C class, check if any of its instance variables is a
1955 C++ object with a non-trivial default constructor.  If so, synthesize a
1956 special @code{- (id) .cxx_construct} instance method that will run
1957 non-trivial default constructors on any such instance variables, in order,
1958 and then return @code{self}.  Similarly, check if any instance variable
1959 is a C++ object with a non-trivial destructor, and if so, synthesize a
1960 special @code{- (void) .cxx_destruct} method that will run
1961 all such default destructors, in reverse order.
1963 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1964 thusly generated will only operate on instance variables declared in the
1965 current Objective-C class, and not those inherited from superclasses.  It
1966 is the responsibility of the Objective-C runtime to invoke all such methods
1967 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1968 will be invoked by the runtime immediately after a new object
1969 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1970 be invoked immediately before the runtime deallocates an object instance.
1972 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1973 support for invoking the @code{- (id) .cxx_construct} and
1974 @code{- (void) .cxx_destruct} methods.
1976 @item -fobjc-direct-dispatch
1977 @opindex fobjc-direct-dispatch
1978 Allow fast jumps to the message dispatcher.  On Darwin this is
1979 accomplished via the comm page.
1981 @item -fobjc-exceptions
1982 @opindex fobjc-exceptions
1983 Enable syntactic support for structured exception handling in Objective-C,
1984 similar to what is offered by C++ and Java.  Currently, this option is only
1985 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1987 @smallexample
1988   @@try @{
1989     @dots{}
1990        @@throw expr;
1991     @dots{}
1992   @}
1993   @@catch (AnObjCClass *exc) @{
1994     @dots{}
1995       @@throw expr;
1996     @dots{}
1997       @@throw;
1998     @dots{}
1999   @}
2000   @@catch (AnotherClass *exc) @{
2001     @dots{}
2002   @}
2003   @@catch (id allOthers) @{
2004     @dots{}
2005   @}
2006   @@finally @{
2007     @dots{}
2008       @@throw expr;
2009     @dots{}
2010   @}
2011 @end smallexample
2013 The @code{@@throw} statement may appear anywhere in an Objective-C or
2014 Objective-C++ program; when used inside of a @code{@@catch} block, the
2015 @code{@@throw} may appear without an argument (as shown above), in which case
2016 the object caught by the @code{@@catch} will be rethrown.
2018 Note that only (pointers to) Objective-C objects may be thrown and
2019 caught using this scheme.  When an object is thrown, it will be caught
2020 by the nearest @code{@@catch} clause capable of handling objects of that type,
2021 analogously to how @code{catch} blocks work in C++ and Java.  A
2022 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2023 any and all Objective-C exceptions not caught by previous @code{@@catch}
2024 clauses (if any).
2026 The @code{@@finally} clause, if present, will be executed upon exit from the
2027 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2028 regardless of whether any exceptions are thrown, caught or rethrown
2029 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2030 of the @code{finally} clause in Java.
2032 There are several caveats to using the new exception mechanism:
2034 @itemize @bullet
2035 @item
2036 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2037 idioms provided by the @code{NSException} class, the new
2038 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2039 systems, due to additional functionality needed in the (NeXT) Objective-C
2040 runtime.
2042 @item
2043 As mentioned above, the new exceptions do not support handling
2044 types other than Objective-C objects.   Furthermore, when used from
2045 Objective-C++, the Objective-C exception model does not interoperate with C++
2046 exceptions at this time.  This means you cannot @code{@@throw} an exception
2047 from Objective-C and @code{catch} it in C++, or vice versa
2048 (i.e., @code{throw @dots{} @@catch}).
2049 @end itemize
2051 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2052 blocks for thread-safe execution:
2054 @smallexample
2055   @@synchronized (ObjCClass *guard) @{
2056     @dots{}
2057   @}
2058 @end smallexample
2060 Upon entering the @code{@@synchronized} block, a thread of execution shall
2061 first check whether a lock has been placed on the corresponding @code{guard}
2062 object by another thread.  If it has, the current thread shall wait until
2063 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2064 the current thread will place its own lock on it, execute the code contained in
2065 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2066 making @code{guard} available to other threads).
2068 Unlike Java, Objective-C does not allow for entire methods to be marked
2069 @code{@@synchronized}.  Note that throwing exceptions out of
2070 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2071 to be unlocked properly.
2073 @item -fobjc-gc
2074 @opindex fobjc-gc
2075 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2077 @item -freplace-objc-classes
2078 @opindex freplace-objc-classes
2079 Emit a special marker instructing @command{ld(1)} not to statically link in
2080 the resulting object file, and allow @command{dyld(1)} to load it in at
2081 run time instead.  This is used in conjunction with the Fix-and-Continue
2082 debugging mode, where the object file in question may be recompiled and
2083 dynamically reloaded in the course of program execution, without the need
2084 to restart the program itself.  Currently, Fix-and-Continue functionality
2085 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2086 and later.
2088 @item -fzero-link
2089 @opindex fzero-link
2090 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2091 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2092 compile time) with static class references that get initialized at load time,
2093 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2094 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2095 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2096 for individual class implementations to be modified during program execution.
2098 @item -gen-decls
2099 @opindex gen-decls
2100 Dump interface declarations for all classes seen in the source file to a
2101 file named @file{@var{sourcename}.decl}.
2103 @item -Wassign-intercept
2104 @opindex Wassign-intercept
2105 Warn whenever an Objective-C assignment is being intercepted by the
2106 garbage collector.
2108 @item -Wno-protocol
2109 @opindex Wno-protocol
2110 If a class is declared to implement a protocol, a warning is issued for
2111 every method in the protocol that is not implemented by the class.  The
2112 default behavior is to issue a warning for every method not explicitly
2113 implemented in the class, even if a method implementation is inherited
2114 from the superclass.  If you use the @option{-Wno-protocol} option, then
2115 methods inherited from the superclass are considered to be implemented,
2116 and no warning is issued for them.
2118 @item -Wselector
2119 @opindex Wselector
2120 Warn if multiple methods of different types for the same selector are
2121 found during compilation.  The check is performed on the list of methods
2122 in the final stage of compilation.  Additionally, a check is performed
2123 for each selector appearing in a @code{@@selector(@dots{})}
2124 expression, and a corresponding method for that selector has been found
2125 during compilation.  Because these checks scan the method table only at
2126 the end of compilation, these warnings are not produced if the final
2127 stage of compilation is not reached, for example because an error is
2128 found during compilation, or because the @option{-fsyntax-only} option is
2129 being used.
2131 @item -Wstrict-selector-match
2132 @opindex Wstrict-selector-match
2133 Warn if multiple methods with differing argument and/or return types are
2134 found for a given selector when attempting to send a message using this
2135 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2136 is off (which is the default behavior), the compiler will omit such warnings
2137 if any differences found are confined to types which share the same size
2138 and alignment.
2140 @item -Wundeclared-selector
2141 @opindex Wundeclared-selector
2142 Warn if a @code{@@selector(@dots{})} expression referring to an
2143 undeclared selector is found.  A selector is considered undeclared if no
2144 method with that name has been declared before the
2145 @code{@@selector(@dots{})} expression, either explicitly in an
2146 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2147 an @code{@@implementation} section.  This option always performs its
2148 checks as soon as a @code{@@selector(@dots{})} expression is found,
2149 while @option{-Wselector} only performs its checks in the final stage of
2150 compilation.  This also enforces the coding style convention
2151 that methods and selectors must be declared before being used.
2153 @item -print-objc-runtime-info
2154 @opindex print-objc-runtime-info
2155 Generate C header describing the largest structure that is passed by
2156 value, if any.
2158 @end table
2160 @node Language Independent Options
2161 @section Options to Control Diagnostic Messages Formatting
2162 @cindex options to control diagnostics formatting
2163 @cindex diagnostic messages
2164 @cindex message formatting
2166 Traditionally, diagnostic messages have been formatted irrespective of
2167 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2168 below can be used to control the diagnostic messages formatting
2169 algorithm, e.g.@: how many characters per line, how often source location
2170 information should be reported.  Right now, only the C++ front end can
2171 honor these options.  However it is expected, in the near future, that
2172 the remaining front ends would be able to digest them correctly.
2174 @table @gcctabopt
2175 @item -fmessage-length=@var{n}
2176 @opindex fmessage-length
2177 Try to format error messages so that they fit on lines of about @var{n}
2178 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2179 the front ends supported by GCC@.  If @var{n} is zero, then no
2180 line-wrapping will be done; each error message will appear on a single
2181 line.
2183 @opindex fdiagnostics-show-location
2184 @item -fdiagnostics-show-location=once
2185 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2186 reporter to emit @emph{once} source location information; that is, in
2187 case the message is too long to fit on a single physical line and has to
2188 be wrapped, the source location won't be emitted (as prefix) again,
2189 over and over, in subsequent continuation lines.  This is the default
2190 behavior.
2192 @item -fdiagnostics-show-location=every-line
2193 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2194 messages reporter to emit the same source location information (as
2195 prefix) for physical lines that result from the process of breaking
2196 a message which is too long to fit on a single line.
2198 @item -fdiagnostics-show-options
2199 @opindex fdiagnostics-show-options
2200 This option instructs the diagnostic machinery to add text to each
2201 diagnostic emitted, which indicates which command line option directly
2202 controls that diagnostic, when such an option is known to the
2203 diagnostic machinery.
2205 @end table
2207 @node Warning Options
2208 @section Options to Request or Suppress Warnings
2209 @cindex options to control warnings
2210 @cindex warning messages
2211 @cindex messages, warning
2212 @cindex suppressing warnings
2214 Warnings are diagnostic messages that report constructions which
2215 are not inherently erroneous but which are risky or suggest there
2216 may have been an error.
2218 You can request many specific warnings with options beginning @samp{-W},
2219 for example @option{-Wimplicit} to request warnings on implicit
2220 declarations.  Each of these specific warning options also has a
2221 negative form beginning @samp{-Wno-} to turn off warnings;
2222 for example, @option{-Wno-implicit}.  This manual lists only one of the
2223 two forms, whichever is not the default.
2225 The following options control the amount and kinds of warnings produced
2226 by GCC; for further, language-specific options also refer to
2227 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2228 Options}.
2230 @table @gcctabopt
2231 @cindex syntax checking
2232 @item -fsyntax-only
2233 @opindex fsyntax-only
2234 Check the code for syntax errors, but don't do anything beyond that.
2236 @item -pedantic
2237 @opindex pedantic
2238 Issue all the warnings demanded by strict ISO C and ISO C++;
2239 reject all programs that use forbidden extensions, and some other
2240 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2241 version of the ISO C standard specified by any @option{-std} option used.
2243 Valid ISO C and ISO C++ programs should compile properly with or without
2244 this option (though a rare few will require @option{-ansi} or a
2245 @option{-std} option specifying the required version of ISO C)@.  However,
2246 without this option, certain GNU extensions and traditional C and C++
2247 features are supported as well.  With this option, they are rejected.
2249 @option{-pedantic} does not cause warning messages for use of the
2250 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2251 warnings are also disabled in the expression that follows
2252 @code{__extension__}.  However, only system header files should use
2253 these escape routes; application programs should avoid them.
2254 @xref{Alternate Keywords}.
2256 Some users try to use @option{-pedantic} to check programs for strict ISO
2257 C conformance.  They soon find that it does not do quite what they want:
2258 it finds some non-ISO practices, but not all---only those for which
2259 ISO C @emph{requires} a diagnostic, and some others for which
2260 diagnostics have been added.
2262 A feature to report any failure to conform to ISO C might be useful in
2263 some instances, but would require considerable additional work and would
2264 be quite different from @option{-pedantic}.  We don't have plans to
2265 support such a feature in the near future.
2267 Where the standard specified with @option{-std} represents a GNU
2268 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2269 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2270 extended dialect is based.  Warnings from @option{-pedantic} are given
2271 where they are required by the base standard.  (It would not make sense
2272 for such warnings to be given only for features not in the specified GNU
2273 C dialect, since by definition the GNU dialects of C include all
2274 features the compiler supports with the given option, and there would be
2275 nothing to warn about.)
2277 @item -pedantic-errors
2278 @opindex pedantic-errors
2279 Like @option{-pedantic}, except that errors are produced rather than
2280 warnings.
2282 @item -w
2283 @opindex w
2284 Inhibit all warning messages.
2286 @item -Wno-import
2287 @opindex Wno-import
2288 Inhibit warning messages about the use of @samp{#import}.
2290 @item -Wchar-subscripts
2291 @opindex Wchar-subscripts
2292 Warn if an array subscript has type @code{char}.  This is a common cause
2293 of error, as programmers often forget that this type is signed on some
2294 machines.
2295 This warning is enabled by @option{-Wall}.
2297 @item -Wcomment
2298 @opindex Wcomment
2299 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2300 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2301 This warning is enabled by @option{-Wall}.
2303 @item -Wfatal-errors
2304 @opindex Wfatal-errors
2305 This option causes the compiler to abort compilation on the first error
2306 occurred rather than trying to keep going and printing further error
2307 messages.
2309 @item -Wformat
2310 @opindex Wformat
2311 @opindex ffreestanding
2312 @opindex fno-builtin
2313 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2314 the arguments supplied have types appropriate to the format string
2315 specified, and that the conversions specified in the format string make
2316 sense.  This includes standard functions, and others specified by format
2317 attributes (@pxref{Function Attributes}), in the @code{printf},
2318 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2319 not in the C standard) families (or other target-specific families).
2320 Which functions are checked without format attributes having been
2321 specified depends on the standard version selected, and such checks of
2322 functions without the attribute specified are disabled by
2323 @option{-ffreestanding} or @option{-fno-builtin}.
2325 The formats are checked against the format features supported by GNU
2326 libc version 2.2.  These include all ISO C90 and C99 features, as well
2327 as features from the Single Unix Specification and some BSD and GNU
2328 extensions.  Other library implementations may not support all these
2329 features; GCC does not support warning about features that go beyond a
2330 particular library's limitations.  However, if @option{-pedantic} is used
2331 with @option{-Wformat}, warnings will be given about format features not
2332 in the selected standard version (but not for @code{strfmon} formats,
2333 since those are not in any version of the C standard).  @xref{C Dialect
2334 Options,,Options Controlling C Dialect}.
2336 Since @option{-Wformat} also checks for null format arguments for
2337 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2339 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2340 aspects of format checking, the options @option{-Wformat-y2k},
2341 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2342 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2343 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2345 @item -Wformat-y2k
2346 @opindex Wformat-y2k
2347 If @option{-Wformat} is specified, also warn about @code{strftime}
2348 formats which may yield only a two-digit year.
2350 @item -Wno-format-extra-args
2351 @opindex Wno-format-extra-args
2352 If @option{-Wformat} is specified, do not warn about excess arguments to a
2353 @code{printf} or @code{scanf} format function.  The C standard specifies
2354 that such arguments are ignored.
2356 Where the unused arguments lie between used arguments that are
2357 specified with @samp{$} operand number specifications, normally
2358 warnings are still given, since the implementation could not know what
2359 type to pass to @code{va_arg} to skip the unused arguments.  However,
2360 in the case of @code{scanf} formats, this option will suppress the
2361 warning if the unused arguments are all pointers, since the Single
2362 Unix Specification says that such unused arguments are allowed.
2364 @item -Wno-format-zero-length
2365 @opindex Wno-format-zero-length
2366 If @option{-Wformat} is specified, do not warn about zero-length formats.
2367 The C standard specifies that zero-length formats are allowed.
2369 @item -Wformat-nonliteral
2370 @opindex Wformat-nonliteral
2371 If @option{-Wformat} is specified, also warn if the format string is not a
2372 string literal and so cannot be checked, unless the format function
2373 takes its format arguments as a @code{va_list}.
2375 @item -Wformat-security
2376 @opindex Wformat-security
2377 If @option{-Wformat} is specified, also warn about uses of format
2378 functions that represent possible security problems.  At present, this
2379 warns about calls to @code{printf} and @code{scanf} functions where the
2380 format string is not a string literal and there are no format arguments,
2381 as in @code{printf (foo);}.  This may be a security hole if the format
2382 string came from untrusted input and contains @samp{%n}.  (This is
2383 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2384 in future warnings may be added to @option{-Wformat-security} that are not
2385 included in @option{-Wformat-nonliteral}.)
2387 @item -Wformat=2
2388 @opindex Wformat=2
2389 Enable @option{-Wformat} plus format checks not included in
2390 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2391 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2393 @item -Wnonnull
2394 @opindex Wnonnull
2395 Warn about passing a null pointer for arguments marked as
2396 requiring a non-null value by the @code{nonnull} function attribute.
2398 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2399 can be disabled with the @option{-Wno-nonnull} option.
2401 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2402 @opindex Winit-self
2403 Warn about uninitialized variables which are initialized with themselves.
2404 Note this option can only be used with the @option{-Wuninitialized} option,
2405 which in turn only works with @option{-O1} and above.
2407 For example, GCC will warn about @code{i} being uninitialized in the
2408 following snippet only when @option{-Winit-self} has been specified:
2409 @smallexample
2410 @group
2411 int f()
2413   int i = i;
2414   return i;
2416 @end group
2417 @end smallexample
2419 @item -Wimplicit-int
2420 @opindex Wimplicit-int
2421 Warn when a declaration does not specify a type.
2422 This warning is enabled by @option{-Wall}.
2424 @item -Wimplicit-function-declaration
2425 @itemx -Werror-implicit-function-declaration
2426 @opindex Wimplicit-function-declaration
2427 @opindex Werror-implicit-function-declaration
2428 Give a warning (or error) whenever a function is used before being
2429 declared.  The form @option{-Wno-error-implicit-function-declaration}
2430 is not supported.
2431 This warning is enabled by @option{-Wall} (as a warning, not an error).
2433 @item -Wimplicit
2434 @opindex Wimplicit
2435 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2436 This warning is enabled by @option{-Wall}.
2438 @item -Wmain
2439 @opindex Wmain
2440 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2441 function with external linkage, returning int, taking either zero
2442 arguments, two, or three arguments of appropriate types.
2443 This warning is enabled by @option{-Wall}.
2445 @item -Wmissing-braces
2446 @opindex Wmissing-braces
2447 Warn if an aggregate or union initializer is not fully bracketed.  In
2448 the following example, the initializer for @samp{a} is not fully
2449 bracketed, but that for @samp{b} is fully bracketed.
2451 @smallexample
2452 int a[2][2] = @{ 0, 1, 2, 3 @};
2453 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2454 @end smallexample
2456 This warning is enabled by @option{-Wall}.
2458 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2459 @opindex Wmissing-include-dirs
2460 Warn if a user-supplied include directory does not exist.
2462 @item -Wparentheses
2463 @opindex Wparentheses
2464 Warn if parentheses are omitted in certain contexts, such
2465 as when there is an assignment in a context where a truth value
2466 is expected, or when operators are nested whose precedence people
2467 often get confused about.  Only the warning for an assignment used as
2468 a truth value is supported when compiling C++; the other warnings are
2469 only supported when compiling C@.
2471 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2472 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2473 interpretation from that of ordinary mathematical notation.
2475 Also warn about constructions where there may be confusion to which
2476 @code{if} statement an @code{else} branch belongs.  Here is an example of
2477 such a case:
2479 @smallexample
2480 @group
2482   if (a)
2483     if (b)
2484       foo ();
2485   else
2486     bar ();
2488 @end group
2489 @end smallexample
2491 In C, every @code{else} branch belongs to the innermost possible @code{if}
2492 statement, which in this example is @code{if (b)}.  This is often not
2493 what the programmer expected, as illustrated in the above example by
2494 indentation the programmer chose.  When there is the potential for this
2495 confusion, GCC will issue a warning when this flag is specified.
2496 To eliminate the warning, add explicit braces around the innermost
2497 @code{if} statement so there is no way the @code{else} could belong to
2498 the enclosing @code{if}.  The resulting code would look like this:
2500 @smallexample
2501 @group
2503   if (a)
2504     @{
2505       if (b)
2506         foo ();
2507       else
2508         bar ();
2509     @}
2511 @end group
2512 @end smallexample
2514 This warning is enabled by @option{-Wall}.
2516 @item -Wsequence-point
2517 @opindex Wsequence-point
2518 Warn about code that may have undefined semantics because of violations
2519 of sequence point rules in the C standard.
2521 The C standard defines the order in which expressions in a C program are
2522 evaluated in terms of @dfn{sequence points}, which represent a partial
2523 ordering between the execution of parts of the program: those executed
2524 before the sequence point, and those executed after it.  These occur
2525 after the evaluation of a full expression (one which is not part of a
2526 larger expression), after the evaluation of the first operand of a
2527 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2528 function is called (but after the evaluation of its arguments and the
2529 expression denoting the called function), and in certain other places.
2530 Other than as expressed by the sequence point rules, the order of
2531 evaluation of subexpressions of an expression is not specified.  All
2532 these rules describe only a partial order rather than a total order,
2533 since, for example, if two functions are called within one expression
2534 with no sequence point between them, the order in which the functions
2535 are called is not specified.  However, the standards committee have
2536 ruled that function calls do not overlap.
2538 It is not specified when between sequence points modifications to the
2539 values of objects take effect.  Programs whose behavior depends on this
2540 have undefined behavior; the C standard specifies that ``Between the
2541 previous and next sequence point an object shall have its stored value
2542 modified at most once by the evaluation of an expression.  Furthermore,
2543 the prior value shall be read only to determine the value to be
2544 stored.''.  If a program breaks these rules, the results on any
2545 particular implementation are entirely unpredictable.
2547 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2548 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2549 diagnosed by this option, and it may give an occasional false positive
2550 result, but in general it has been found fairly effective at detecting
2551 this sort of problem in programs.
2553 The present implementation of this option only works for C programs.  A
2554 future implementation may also work for C++ programs.
2556 The C standard is worded confusingly, therefore there is some debate
2557 over the precise meaning of the sequence point rules in subtle cases.
2558 Links to discussions of the problem, including proposed formal
2559 definitions, may be found on the GCC readings page, at
2560 @w{@uref{http://gcc.gnu.org/readings.html}}.
2562 This warning is enabled by @option{-Wall}.
2564 @item -Wreturn-type
2565 @opindex Wreturn-type
2566 Warn whenever a function is defined with a return-type that defaults to
2567 @code{int}.  Also warn about any @code{return} statement with no
2568 return-value in a function whose return-type is not @code{void}.
2570 For C, also warn if the return type of a function has a type qualifier
2571 such as @code{const}.  Such a type qualifier has no effect, since the
2572 value returned by a function is not an lvalue.  ISO C prohibits
2573 qualified @code{void} return types on function definitions, so such
2574 return types always receive a warning even without this option.
2576 For C++, a function without return type always produces a diagnostic
2577 message, even when @option{-Wno-return-type} is specified.  The only
2578 exceptions are @samp{main} and functions defined in system headers.
2580 This warning is enabled by @option{-Wall}.
2582 @item -Wswitch
2583 @opindex Wswitch
2584 Warn whenever a @code{switch} statement has an index of enumerated type
2585 and lacks a @code{case} for one or more of the named codes of that
2586 enumeration.  (The presence of a @code{default} label prevents this
2587 warning.)  @code{case} labels outside the enumeration range also
2588 provoke warnings when this option is used.
2589 This warning is enabled by @option{-Wall}.
2591 @item -Wswitch-default
2592 @opindex Wswitch-switch
2593 Warn whenever a @code{switch} statement does not have a @code{default}
2594 case.
2596 @item -Wswitch-enum
2597 @opindex Wswitch-enum
2598 Warn whenever a @code{switch} statement has an index of enumerated type
2599 and lacks a @code{case} for one or more of the named codes of that
2600 enumeration.  @code{case} labels outside the enumeration range also
2601 provoke warnings when this option is used.
2603 @item -Wtrigraphs
2604 @opindex Wtrigraphs
2605 Warn if any trigraphs are encountered that might change the meaning of
2606 the program (trigraphs within comments are not warned about).
2607 This warning is enabled by @option{-Wall}.
2609 @item -Wunused-function
2610 @opindex Wunused-function
2611 Warn whenever a static function is declared but not defined or a
2612 non-inline static function is unused.
2613 This warning is enabled by @option{-Wall}.
2615 @item -Wunused-label
2616 @opindex Wunused-label
2617 Warn whenever a label is declared but not used.
2618 This warning is enabled by @option{-Wall}.
2620 To suppress this warning use the @samp{unused} attribute
2621 (@pxref{Variable Attributes}).
2623 @item -Wunused-parameter
2624 @opindex Wunused-parameter
2625 Warn whenever a function parameter is unused aside from its declaration.
2627 To suppress this warning use the @samp{unused} attribute
2628 (@pxref{Variable Attributes}).
2630 @item -Wunused-variable
2631 @opindex Wunused-variable
2632 Warn whenever a local variable or non-constant static variable is unused
2633 aside from its declaration
2634 This warning is enabled by @option{-Wall}.
2636 To suppress this warning use the @samp{unused} attribute
2637 (@pxref{Variable Attributes}).
2639 @item -Wunused-value
2640 @opindex Wunused-value
2641 Warn whenever a statement computes a result that is explicitly not used.
2642 This warning is enabled by @option{-Wall}.
2644 To suppress this warning cast the expression to @samp{void}.
2646 @item -Wunused
2647 @opindex Wunused
2648 All the above @option{-Wunused} options combined.
2650 In order to get a warning about an unused function parameter, you must
2651 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2652 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2654 @item -Wuninitialized
2655 @opindex Wuninitialized
2656 Warn if an automatic variable is used without first being initialized or
2657 if a variable may be clobbered by a @code{setjmp} call.
2659 These warnings are possible only in optimizing compilation,
2660 because they require data flow information that is computed only
2661 when optimizing.  If you don't specify @option{-O}, you simply won't
2662 get these warnings.
2664 If you want to warn about code which uses the uninitialized value of the
2665 variable in its own initializer, use the @option{-Winit-self} option.
2667 These warnings occur for individual uninitialized or clobbered
2668 elements of structure, union or array variables as well as for
2669 variables which are uninitialized or clobbered as a whole.  They do
2670 not occur for variables or elements declared @code{volatile}.  Because
2671 these warnings depend on optimization, the exact variables or elements
2672 for which there are warnings will depend on the precise optimization
2673 options and version of GCC used.
2675 Note that there may be no warning about a variable that is used only
2676 to compute a value that itself is never used, because such
2677 computations may be deleted by data flow analysis before the warnings
2678 are printed.
2680 These warnings are made optional because GCC is not smart
2681 enough to see all the reasons why the code might be correct
2682 despite appearing to have an error.  Here is one example of how
2683 this can happen:
2685 @smallexample
2686 @group
2688   int x;
2689   switch (y)
2690     @{
2691     case 1: x = 1;
2692       break;
2693     case 2: x = 4;
2694       break;
2695     case 3: x = 5;
2696     @}
2697   foo (x);
2699 @end group
2700 @end smallexample
2702 @noindent
2703 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2704 always initialized, but GCC doesn't know this.  Here is
2705 another common case:
2707 @smallexample
2709   int save_y;
2710   if (change_y) save_y = y, y = new_y;
2711   @dots{}
2712   if (change_y) y = save_y;
2714 @end smallexample
2716 @noindent
2717 This has no bug because @code{save_y} is used only if it is set.
2719 @cindex @code{longjmp} warnings
2720 This option also warns when a non-volatile automatic variable might be
2721 changed by a call to @code{longjmp}.  These warnings as well are possible
2722 only in optimizing compilation.
2724 The compiler sees only the calls to @code{setjmp}.  It cannot know
2725 where @code{longjmp} will be called; in fact, a signal handler could
2726 call it at any point in the code.  As a result, you may get a warning
2727 even when there is in fact no problem because @code{longjmp} cannot
2728 in fact be called at the place which would cause a problem.
2730 Some spurious warnings can be avoided if you declare all the functions
2731 you use that never return as @code{noreturn}.  @xref{Function
2732 Attributes}.
2734 This warning is enabled by @option{-Wall}.
2736 @item -Wunknown-pragmas
2737 @opindex Wunknown-pragmas
2738 @cindex warning for unknown pragmas
2739 @cindex unknown pragmas, warning
2740 @cindex pragmas, warning of unknown
2741 Warn when a #pragma directive is encountered which is not understood by
2742 GCC@.  If this command line option is used, warnings will even be issued
2743 for unknown pragmas in system header files.  This is not the case if
2744 the warnings were only enabled by the @option{-Wall} command line option.
2746 @item -Wno-pragmas
2747 @opindex Wno-pragmas
2748 @opindex Wpragmas
2749 Do not warn about misuses of pragmas, such as incorrect parameters,
2750 invalid syntax, or conflicts between pragmas.  See also
2751 @samp{-Wunknown-pragmas}.
2753 @item -Wstrict-aliasing
2754 @opindex Wstrict-aliasing
2755 This option is only active when @option{-fstrict-aliasing} is active.
2756 It warns about code which might break the strict aliasing rules that the
2757 compiler is using for optimization.  The warning does not catch all
2758 cases, but does attempt to catch the more common pitfalls.  It is
2759 included in @option{-Wall}.
2761 @item -Wstrict-aliasing=2
2762 @opindex Wstrict-aliasing=2
2763 This option is only active when @option{-fstrict-aliasing} is active.
2764 It warns about code which might break the strict aliasing rules that the
2765 compiler is using for optimization.  This warning catches more cases than
2766 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2767 cases that are safe.
2769 @item -Wall
2770 @opindex Wall
2771 All of the above @samp{-W} options combined.  This enables all the
2772 warnings about constructions that some users consider questionable, and
2773 that are easy to avoid (or modify to prevent the warning), even in
2774 conjunction with macros.  This also enables some language-specific
2775 warnings described in @ref{C++ Dialect Options} and
2776 @ref{Objective-C and Objective-C++ Dialect Options}.
2777 @end table
2779 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2780 Some of them warn about constructions that users generally do not
2781 consider questionable, but which occasionally you might wish to check
2782 for; others warn about constructions that are necessary or hard to avoid
2783 in some cases, and there is no simple way to modify the code to suppress
2784 the warning.
2786 @table @gcctabopt
2787 @item -Wextra
2788 @opindex W
2789 @opindex Wextra
2790 (This option used to be called @option{-W}.  The older name is still
2791 supported, but the newer name is more descriptive.)  Print extra warning
2792 messages for these events:
2794 @itemize @bullet
2795 @item
2796 A function can return either with or without a value.  (Falling
2797 off the end of the function body is considered returning without
2798 a value.)  For example, this function would evoke such a
2799 warning:
2801 @smallexample
2802 @group
2803 foo (a)
2805   if (a > 0)
2806     return a;
2808 @end group
2809 @end smallexample
2811 @item
2812 An expression-statement or the left-hand side of a comma expression
2813 contains no side effects.
2814 To suppress the warning, cast the unused expression to void.
2815 For example, an expression such as @samp{x[i,j]} will cause a warning,
2816 but @samp{x[(void)i,j]} will not.
2818 @item
2819 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2821 @item
2822 Storage-class specifiers like @code{static} are not the first things in
2823 a declaration.  According to the C Standard, this usage is obsolescent.
2825 @item
2826 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2827 arguments.
2829 @item
2830 A comparison between signed and unsigned values could produce an
2831 incorrect result when the signed value is converted to unsigned.
2832 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2834 @item
2835 An aggregate has an initializer which does not initialize all members.
2836 This warning can be independently controlled by
2837 @option{-Wmissing-field-initializers}.
2839 @item
2840 A function parameter is declared without a type specifier in K&R-style
2841 functions:
2843 @smallexample
2844 void foo(bar) @{ @}
2845 @end smallexample
2847 @item
2848 An empty body occurs in an @samp{if} or @samp{else} statement.
2850 @item
2851 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2852 @samp{>}, or @samp{>=}.
2854 @item
2855 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2857 @item
2858 Any of several floating-point events that often indicate errors, such as
2859 overflow, underflow, loss of precision, etc.
2861 @item @r{(C++ only)}
2862 An enumerator and a non-enumerator both appear in a conditional expression.
2864 @item @r{(C++ only)}
2865 A non-static reference or non-static @samp{const} member appears in a
2866 class without constructors.
2868 @item @r{(C++ only)}
2869 Ambiguous virtual bases.
2871 @item @r{(C++ only)}
2872 Subscripting an array which has been declared @samp{register}.
2874 @item @r{(C++ only)}
2875 Taking the address of a variable which has been declared @samp{register}.
2877 @item @r{(C++ only)}
2878 A base class is not initialized in a derived class' copy constructor.
2879 @end itemize
2881 @item -Wno-div-by-zero
2882 @opindex Wno-div-by-zero
2883 @opindex Wdiv-by-zero
2884 Do not warn about compile-time integer division by zero.  Floating point
2885 division by zero is not warned about, as it can be a legitimate way of
2886 obtaining infinities and NaNs.
2888 @item -Wsystem-headers
2889 @opindex Wsystem-headers
2890 @cindex warnings from system headers
2891 @cindex system headers, warnings from
2892 Print warning messages for constructs found in system header files.
2893 Warnings from system headers are normally suppressed, on the assumption
2894 that they usually do not indicate real problems and would only make the
2895 compiler output harder to read.  Using this command line option tells
2896 GCC to emit warnings from system headers as if they occurred in user
2897 code.  However, note that using @option{-Wall} in conjunction with this
2898 option will @emph{not} warn about unknown pragmas in system
2899 headers---for that, @option{-Wunknown-pragmas} must also be used.
2901 @item -Wfloat-equal
2902 @opindex Wfloat-equal
2903 Warn if floating point values are used in equality comparisons.
2905 The idea behind this is that sometimes it is convenient (for the
2906 programmer) to consider floating-point values as approximations to
2907 infinitely precise real numbers.  If you are doing this, then you need
2908 to compute (by analyzing the code, or in some other way) the maximum or
2909 likely maximum error that the computation introduces, and allow for it
2910 when performing comparisons (and when producing output, but that's a
2911 different problem).  In particular, instead of testing for equality, you
2912 would check to see whether the two values have ranges that overlap; and
2913 this is done with the relational operators, so equality comparisons are
2914 probably mistaken.
2916 @item -Wtraditional @r{(C only)}
2917 @opindex Wtraditional
2918 Warn about certain constructs that behave differently in traditional and
2919 ISO C@.  Also warn about ISO C constructs that have no traditional C
2920 equivalent, and/or problematic constructs which should be avoided.
2922 @itemize @bullet
2923 @item
2924 Macro parameters that appear within string literals in the macro body.
2925 In traditional C macro replacement takes place within string literals,
2926 but does not in ISO C@.
2928 @item
2929 In traditional C, some preprocessor directives did not exist.
2930 Traditional preprocessors would only consider a line to be a directive
2931 if the @samp{#} appeared in column 1 on the line.  Therefore
2932 @option{-Wtraditional} warns about directives that traditional C
2933 understands but would ignore because the @samp{#} does not appear as the
2934 first character on the line.  It also suggests you hide directives like
2935 @samp{#pragma} not understood by traditional C by indenting them.  Some
2936 traditional implementations would not recognize @samp{#elif}, so it
2937 suggests avoiding it altogether.
2939 @item
2940 A function-like macro that appears without arguments.
2942 @item
2943 The unary plus operator.
2945 @item
2946 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2947 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2948 constants.)  Note, these suffixes appear in macros defined in the system
2949 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2950 Use of these macros in user code might normally lead to spurious
2951 warnings, however GCC's integrated preprocessor has enough context to
2952 avoid warning in these cases.
2954 @item
2955 A function declared external in one block and then used after the end of
2956 the block.
2958 @item
2959 A @code{switch} statement has an operand of type @code{long}.
2961 @item
2962 A non-@code{static} function declaration follows a @code{static} one.
2963 This construct is not accepted by some traditional C compilers.
2965 @item
2966 The ISO type of an integer constant has a different width or
2967 signedness from its traditional type.  This warning is only issued if
2968 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2969 typically represent bit patterns, are not warned about.
2971 @item
2972 Usage of ISO string concatenation is detected.
2974 @item
2975 Initialization of automatic aggregates.
2977 @item
2978 Identifier conflicts with labels.  Traditional C lacks a separate
2979 namespace for labels.
2981 @item
2982 Initialization of unions.  If the initializer is zero, the warning is
2983 omitted.  This is done under the assumption that the zero initializer in
2984 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2985 initializer warnings and relies on default initialization to zero in the
2986 traditional C case.
2988 @item
2989 Conversions by prototypes between fixed/floating point values and vice
2990 versa.  The absence of these prototypes when compiling with traditional
2991 C would cause serious problems.  This is a subset of the possible
2992 conversion warnings, for the full set use @option{-Wconversion}.
2994 @item
2995 Use of ISO C style function definitions.  This warning intentionally is
2996 @emph{not} issued for prototype declarations or variadic functions
2997 because these ISO C features will appear in your code when using
2998 libiberty's traditional C compatibility macros, @code{PARAMS} and
2999 @code{VPARAMS}.  This warning is also bypassed for nested functions
3000 because that feature is already a GCC extension and thus not relevant to
3001 traditional C compatibility.
3002 @end itemize
3004 @item -Wdeclaration-after-statement @r{(C only)}
3005 @opindex Wdeclaration-after-statement
3006 Warn when a declaration is found after a statement in a block.  This
3007 construct, known from C++, was introduced with ISO C99 and is by default
3008 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3009 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3011 @item -Wundef
3012 @opindex Wundef
3013 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3015 @item -Wno-endif-labels
3016 @opindex Wno-endif-labels
3017 @opindex Wendif-labels
3018 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3020 @item -Wshadow
3021 @opindex Wshadow
3022 Warn whenever a local variable shadows another local variable, parameter or
3023 global variable or whenever a built-in function is shadowed.
3025 @item -Wlarger-than-@var{len}
3026 @opindex Wlarger-than
3027 Warn whenever an object of larger than @var{len} bytes is defined.
3029 @item -Wunsafe-loop-optimizations
3030 @opindex Wunsafe-loop-optimizations
3031 Warn if the loop cannot be optimized because the compiler could not
3032 assume anything on the bounds of the loop indices.  With
3033 @option{-funsafe-loop-optimizations} warn if the compiler made
3034 such assumptions.
3036 @item -Wpointer-arith
3037 @opindex Wpointer-arith
3038 Warn about anything that depends on the ``size of'' a function type or
3039 of @code{void}.  GNU C assigns these types a size of 1, for
3040 convenience in calculations with @code{void *} pointers and pointers
3041 to functions.
3043 @item -Wbad-function-cast @r{(C only)}
3044 @opindex Wbad-function-cast
3045 Warn whenever a function call is cast to a non-matching type.
3046 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3048 @item -Wc++-compat
3049 Warn about ISO C constructs that are outside of the common subset of
3050 ISO C and ISO C++, e.g.@: request for implicit conversion from
3051 @code{void *} to a pointer to non-@code{void} type.
3053 @item -Wcast-qual
3054 @opindex Wcast-qual
3055 Warn whenever a pointer is cast so as to remove a type qualifier from
3056 the target type.  For example, warn if a @code{const char *} is cast
3057 to an ordinary @code{char *}.
3059 @item -Wcast-align
3060 @opindex Wcast-align
3061 Warn whenever a pointer is cast such that the required alignment of the
3062 target is increased.  For example, warn if a @code{char *} is cast to
3063 an @code{int *} on machines where integers can only be accessed at
3064 two- or four-byte boundaries.
3066 @item -Wwrite-strings
3067 @opindex Wwrite-strings
3068 When compiling C, give string constants the type @code{const
3069 char[@var{length}]} so that
3070 copying the address of one into a non-@code{const} @code{char *}
3071 pointer will get a warning; when compiling C++, warn about the
3072 deprecated conversion from string constants to @code{char *}.
3073 These warnings will help you find at
3074 compile time code that can try to write into a string constant, but
3075 only if you have been very careful about using @code{const} in
3076 declarations and prototypes.  Otherwise, it will just be a nuisance;
3077 this is why we did not make @option{-Wall} request these warnings.
3079 @item -Wconversion
3080 @opindex Wconversion
3081 Warn if a prototype causes a type conversion that is different from what
3082 would happen to the same argument in the absence of a prototype.  This
3083 includes conversions of fixed point to floating and vice versa, and
3084 conversions changing the width or signedness of a fixed point argument
3085 except when the same as the default promotion.
3087 Also, warn if a negative integer constant expression is implicitly
3088 converted to an unsigned type.  For example, warn about the assignment
3089 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3090 casts like @code{(unsigned) -1}.
3092 @item -Wsign-compare
3093 @opindex Wsign-compare
3094 @cindex warning for comparison of signed and unsigned values
3095 @cindex comparison of signed and unsigned values, warning
3096 @cindex signed and unsigned values, comparison warning
3097 Warn when a comparison between signed and unsigned values could produce
3098 an incorrect result when the signed value is converted to unsigned.
3099 This warning is also enabled by @option{-Wextra}; to get the other warnings
3100 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3102 @item -Waggregate-return
3103 @opindex Waggregate-return
3104 Warn if any functions that return structures or unions are defined or
3105 called.  (In languages where you can return an array, this also elicits
3106 a warning.)
3108 @item -Wno-attributes
3109 @opindex Wno-attributes
3110 @opindex Wattributes
3111 Do not warn if an unexpected @code{__attribute__} is used, such as
3112 unrecognized attributes, function attributes applied to variables,
3113 etc.  This will not stop errors for incorrect use of supported
3114 attributes.
3116 @item -Wstrict-prototypes @r{(C only)}
3117 @opindex Wstrict-prototypes
3118 Warn if a function is declared or defined without specifying the
3119 argument types.  (An old-style function definition is permitted without
3120 a warning if preceded by a declaration which specifies the argument
3121 types.)
3123 @item -Wold-style-definition @r{(C only)}
3124 @opindex Wold-style-definition
3125 Warn if an old-style function definition is used.  A warning is given
3126 even if there is a previous prototype.
3128 @item -Wmissing-prototypes @r{(C only)}
3129 @opindex Wmissing-prototypes
3130 Warn if a global function is defined without a previous prototype
3131 declaration.  This warning is issued even if the definition itself
3132 provides a prototype.  The aim is to detect global functions that fail
3133 to be declared in header files.
3135 @item -Wmissing-declarations @r{(C only)}
3136 @opindex Wmissing-declarations
3137 Warn if a global function is defined without a previous declaration.
3138 Do so even if the definition itself provides a prototype.
3139 Use this option to detect global functions that are not declared in
3140 header files.
3142 @item -Wmissing-field-initializers
3143 @opindex Wmissing-field-initializers
3144 @opindex W
3145 @opindex Wextra
3146 Warn if a structure's initializer has some fields missing.  For
3147 example, the following code would cause such a warning, because
3148 @code{x.h} is implicitly zero:
3150 @smallexample
3151 struct s @{ int f, g, h; @};
3152 struct s x = @{ 3, 4 @};
3153 @end smallexample
3155 This option does not warn about designated initializers, so the following
3156 modification would not trigger a warning:
3158 @smallexample
3159 struct s @{ int f, g, h; @};
3160 struct s x = @{ .f = 3, .g = 4 @};
3161 @end smallexample
3163 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3164 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3166 @item -Wmissing-noreturn
3167 @opindex Wmissing-noreturn
3168 Warn about functions which might be candidates for attribute @code{noreturn}.
3169 Note these are only possible candidates, not absolute ones.  Care should
3170 be taken to manually verify functions actually do not ever return before
3171 adding the @code{noreturn} attribute, otherwise subtle code generation
3172 bugs could be introduced.  You will not get a warning for @code{main} in
3173 hosted C environments.
3175 @item -Wmissing-format-attribute
3176 @opindex Wmissing-format-attribute
3177 @opindex Wformat
3178 Warn about function pointers which might be candidates for @code{format}
3179 attributes.  Note these are only possible candidates, not absolute ones.
3180 GCC will guess that function pointers with @code{format} attributes that
3181 are used in assignment, initialization, parameter passing or return
3182 statements should have a corresponding @code{format} attribute in the
3183 resulting type.  I.e.@: the left-hand side of the assignment or
3184 initialization, the type of the parameter variable, or the return type
3185 of the containing function respectively should also have a @code{format}
3186 attribute to avoid the warning.
3188 GCC will also warn about function definitions which might be
3189 candidates for @code{format} attributes.  Again, these are only
3190 possible candidates.  GCC will guess that @code{format} attributes
3191 might be appropriate for any function that calls a function like
3192 @code{vprintf} or @code{vscanf}, but this might not always be the
3193 case, and some functions for which @code{format} attributes are
3194 appropriate may not be detected.
3196 @item -Wno-multichar
3197 @opindex Wno-multichar
3198 @opindex Wmultichar
3199 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3200 Usually they indicate a typo in the user's code, as they have
3201 implementation-defined values, and should not be used in portable code.
3203 @item -Wnormalized=<none|id|nfc|nfkc>
3204 @opindex Wnormalized
3205 @cindex NFC
3206 @cindex NFKC
3207 @cindex character set, input normalization
3208 In ISO C and ISO C++, two identifiers are different if they are
3209 different sequences of characters.  However, sometimes when characters
3210 outside the basic ASCII character set are used, you can have two
3211 different character sequences that look the same.  To avoid confusion,
3212 the ISO 10646 standard sets out some @dfn{normalization rules} which
3213 when applied ensure that two sequences that look the same are turned into
3214 the same sequence.  GCC can warn you if you are using identifiers which
3215 have not been normalized; this option controls that warning.
3217 There are four levels of warning that GCC supports.  The default is
3218 @option{-Wnormalized=nfc}, which warns about any identifier which is
3219 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3220 recommended form for most uses.
3222 Unfortunately, there are some characters which ISO C and ISO C++ allow
3223 in identifiers that when turned into NFC aren't allowable as
3224 identifiers.  That is, there's no way to use these symbols in portable
3225 ISO C or C++ and have all your identifiers in NFC.
3226 @option{-Wnormalized=id} suppresses the warning for these characters.
3227 It is hoped that future versions of the standards involved will correct
3228 this, which is why this option is not the default.
3230 You can switch the warning off for all characters by writing
3231 @option{-Wnormalized=none}.  You would only want to do this if you
3232 were using some other normalization scheme (like ``D''), because
3233 otherwise you can easily create bugs that are literally impossible to see.
3235 Some characters in ISO 10646 have distinct meanings but look identical
3236 in some fonts or display methodologies, especially once formatting has
3237 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3238 LETTER N'', will display just like a regular @code{n} which has been
3239 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3240 normalisation scheme to convert all these into a standard form as
3241 well, and GCC will warn if your code is not in NFKC if you use
3242 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3243 about every identifier that contains the letter O because it might be
3244 confused with the digit 0, and so is not the default, but may be
3245 useful as a local coding convention if the programming environment is
3246 unable to be fixed to display these characters distinctly.
3248 @item -Wno-deprecated-declarations
3249 @opindex Wno-deprecated-declarations
3250 Do not warn about uses of functions, variables, and types marked as
3251 deprecated by using the @code{deprecated} attribute.
3252 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3253 @pxref{Type Attributes}.)
3255 @item -Wpacked
3256 @opindex Wpacked
3257 Warn if a structure is given the packed attribute, but the packed
3258 attribute has no effect on the layout or size of the structure.
3259 Such structures may be mis-aligned for little benefit.  For
3260 instance, in this code, the variable @code{f.x} in @code{struct bar}
3261 will be misaligned even though @code{struct bar} does not itself
3262 have the packed attribute:
3264 @smallexample
3265 @group
3266 struct foo @{
3267   int x;
3268   char a, b, c, d;
3269 @} __attribute__((packed));
3270 struct bar @{
3271   char z;
3272   struct foo f;
3274 @end group
3275 @end smallexample
3277 @item -Wpadded
3278 @opindex Wpadded
3279 Warn if padding is included in a structure, either to align an element
3280 of the structure or to align the whole structure.  Sometimes when this
3281 happens it is possible to rearrange the fields of the structure to
3282 reduce the padding and so make the structure smaller.
3284 @item -Wredundant-decls
3285 @opindex Wredundant-decls
3286 Warn if anything is declared more than once in the same scope, even in
3287 cases where multiple declaration is valid and changes nothing.
3289 @item -Wnested-externs @r{(C only)}
3290 @opindex Wnested-externs
3291 Warn if an @code{extern} declaration is encountered within a function.
3293 @item -Wunreachable-code
3294 @opindex Wunreachable-code
3295 Warn if the compiler detects that code will never be executed.
3297 This option is intended to warn when the compiler detects that at
3298 least a whole line of source code will never be executed, because
3299 some condition is never satisfied or because it is after a
3300 procedure that never returns.
3302 It is possible for this option to produce a warning even though there
3303 are circumstances under which part of the affected line can be executed,
3304 so care should be taken when removing apparently-unreachable code.
3306 For instance, when a function is inlined, a warning may mean that the
3307 line is unreachable in only one inlined copy of the function.
3309 This option is not made part of @option{-Wall} because in a debugging
3310 version of a program there is often substantial code which checks
3311 correct functioning of the program and is, hopefully, unreachable
3312 because the program does work.  Another common use of unreachable
3313 code is to provide behavior which is selectable at compile-time.
3315 @item -Winline
3316 @opindex Winline
3317 Warn if a function can not be inlined and it was declared as inline.
3318 Even with this option, the compiler will not warn about failures to
3319 inline functions declared in system headers.
3321 The compiler uses a variety of heuristics to determine whether or not
3322 to inline a function.  For example, the compiler takes into account
3323 the size of the function being inlined and the amount of inlining
3324 that has already been done in the current function.  Therefore,
3325 seemingly insignificant changes in the source program can cause the
3326 warnings produced by @option{-Winline} to appear or disappear.
3328 @item -Wno-invalid-offsetof @r{(C++ only)}
3329 @opindex Wno-invalid-offsetof
3330 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3331 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3332 to a non-POD type is undefined.  In existing C++ implementations,
3333 however, @samp{offsetof} typically gives meaningful results even when
3334 applied to certain kinds of non-POD types. (Such as a simple
3335 @samp{struct} that fails to be a POD type only by virtue of having a
3336 constructor.)  This flag is for users who are aware that they are
3337 writing nonportable code and who have deliberately chosen to ignore the
3338 warning about it.
3340 The restrictions on @samp{offsetof} may be relaxed in a future version
3341 of the C++ standard.
3343 @item -Wno-int-to-pointer-cast @r{(C only)}
3344 @opindex Wno-int-to-pointer-cast
3345 Suppress warnings from casts to pointer type of an integer of a
3346 different size.
3348 @item -Wno-pointer-to-int-cast @r{(C only)}
3349 @opindex Wno-pointer-to-int-cast
3350 Suppress warnings from casts from a pointer to an integer type of a
3351 different size.
3353 @item -Winvalid-pch
3354 @opindex Winvalid-pch
3355 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3356 the search path but can't be used.
3358 @item -Wlong-long
3359 @opindex Wlong-long
3360 @opindex Wno-long-long
3361 Warn if @samp{long long} type is used.  This is default.  To inhibit
3362 the warning messages, use @option{-Wno-long-long}.  Flags
3363 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3364 only when @option{-pedantic} flag is used.
3366 @item -Wvariadic-macros
3367 @opindex Wvariadic-macros
3368 @opindex Wno-variadic-macros
3369 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3370 alternate syntax when in pedantic ISO C99 mode.  This is default.
3371 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3373 @item -Wvolatile-register-var
3374 @opindex Wvolatile-register-var
3375 @opindex Wno-volatile-register-var
3376 Warn if a register variable is declared volatile.  The volatile
3377 modifier does not inhibit all optimizations that may eliminate reads
3378 and/or writes to register variables.
3380 @item -Wdisabled-optimization
3381 @opindex Wdisabled-optimization
3382 Warn if a requested optimization pass is disabled.  This warning does
3383 not generally indicate that there is anything wrong with your code; it
3384 merely indicates that GCC's optimizers were unable to handle the code
3385 effectively.  Often, the problem is that your code is too big or too
3386 complex; GCC will refuse to optimize programs when the optimization
3387 itself is likely to take inordinate amounts of time.
3389 @item -Wno-pointer-sign
3390 @opindex Wno-pointer-sign
3391 Don't warn for pointer argument passing or assignment with different signedness.
3392 Only useful in the negative form since this warning is enabled by default.
3393 This option is only supported for C and Objective-C@.
3395 @item -Werror
3396 @opindex Werror
3397 Make all warnings into errors.
3399 @item -Wstack-protector
3400 This option is only active when @option{-fstack-protector} is active.  It
3401 warns about functions that will not be protected against stack smashing.
3403 @end table
3405 @node Debugging Options
3406 @section Options for Debugging Your Program or GCC
3407 @cindex options, debugging
3408 @cindex debugging information options
3410 GCC has various special options that are used for debugging
3411 either your program or GCC:
3413 @table @gcctabopt
3414 @item -g
3415 @opindex g
3416 Produce debugging information in the operating system's native format
3417 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3418 information.
3420 On most systems that use stabs format, @option{-g} enables use of extra
3421 debugging information that only GDB can use; this extra information
3422 makes debugging work better in GDB but will probably make other debuggers
3423 crash or
3424 refuse to read the program.  If you want to control for certain whether
3425 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3426 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3428 GCC allows you to use @option{-g} with
3429 @option{-O}.  The shortcuts taken by optimized code may occasionally
3430 produce surprising results: some variables you declared may not exist
3431 at all; flow of control may briefly move where you did not expect it;
3432 some statements may not be executed because they compute constant
3433 results or their values were already at hand; some statements may
3434 execute in different places because they were moved out of loops.
3436 Nevertheless it proves possible to debug optimized output.  This makes
3437 it reasonable to use the optimizer for programs that might have bugs.
3439 The following options are useful when GCC is generated with the
3440 capability for more than one debugging format.
3442 @item -ggdb
3443 @opindex ggdb
3444 Produce debugging information for use by GDB@.  This means to use the
3445 most expressive format available (DWARF 2, stabs, or the native format
3446 if neither of those are supported), including GDB extensions if at all
3447 possible.
3449 @item -gstabs
3450 @opindex gstabs
3451 Produce debugging information in stabs format (if that is supported),
3452 without GDB extensions.  This is the format used by DBX on most BSD
3453 systems.  On MIPS, Alpha and System V Release 4 systems this option
3454 produces stabs debugging output which is not understood by DBX or SDB@.
3455 On System V Release 4 systems this option requires the GNU assembler.
3457 @item -feliminate-unused-debug-symbols
3458 @opindex feliminate-unused-debug-symbols
3459 Produce debugging information in stabs format (if that is supported),
3460 for only symbols that are actually used.
3462 @item -gstabs+
3463 @opindex gstabs+
3464 Produce debugging information in stabs format (if that is supported),
3465 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3466 use of these extensions is likely to make other debuggers crash or
3467 refuse to read the program.
3469 @item -gcoff
3470 @opindex gcoff
3471 Produce debugging information in COFF format (if that is supported).
3472 This is the format used by SDB on most System V systems prior to
3473 System V Release 4.
3475 @item -gxcoff
3476 @opindex gxcoff
3477 Produce debugging information in XCOFF format (if that is supported).
3478 This is the format used by the DBX debugger on IBM RS/6000 systems.
3480 @item -gxcoff+
3481 @opindex gxcoff+
3482 Produce debugging information in XCOFF format (if that is supported),
3483 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3484 use of these extensions is likely to make other debuggers crash or
3485 refuse to read the program, and may cause assemblers other than the GNU
3486 assembler (GAS) to fail with an error.
3488 @item -gdwarf-2
3489 @opindex gdwarf-2
3490 Produce debugging information in DWARF version 2 format (if that is
3491 supported).  This is the format used by DBX on IRIX 6.  With this
3492 option, GCC uses features of DWARF version 3 when they are useful;
3493 version 3 is upward compatible with version 2, but may still cause
3494 problems for older debuggers.
3496 @item -gvms
3497 @opindex gvms
3498 Produce debugging information in VMS debug format (if that is
3499 supported).  This is the format used by DEBUG on VMS systems.
3501 @item -g@var{level}
3502 @itemx -ggdb@var{level}
3503 @itemx -gstabs@var{level}
3504 @itemx -gcoff@var{level}
3505 @itemx -gxcoff@var{level}
3506 @itemx -gvms@var{level}
3507 Request debugging information and also use @var{level} to specify how
3508 much information.  The default level is 2.
3510 Level 1 produces minimal information, enough for making backtraces in
3511 parts of the program that you don't plan to debug.  This includes
3512 descriptions of functions and external variables, but no information
3513 about local variables and no line numbers.
3515 Level 3 includes extra information, such as all the macro definitions
3516 present in the program.  Some debuggers support macro expansion when
3517 you use @option{-g3}.
3519 @option{-gdwarf-2} does not accept a concatenated debug level, because
3520 GCC used to support an option @option{-gdwarf} that meant to generate
3521 debug information in version 1 of the DWARF format (which is very
3522 different from version 2), and it would have been too confusing.  That
3523 debug format is long obsolete, but the option cannot be changed now.
3524 Instead use an additional @option{-g@var{level}} option to change the
3525 debug level for DWARF2.
3527 @item -feliminate-dwarf2-dups
3528 @opindex feliminate-dwarf2-dups
3529 Compress DWARF2 debugging information by eliminating duplicated
3530 information about each symbol.  This option only makes sense when
3531 generating DWARF2 debugging information with @option{-gdwarf-2}.
3533 @cindex @command{prof}
3534 @item -p
3535 @opindex p
3536 Generate extra code to write profile information suitable for the
3537 analysis program @command{prof}.  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 @cindex @command{gprof}
3542 @item -pg
3543 @opindex pg
3544 Generate extra code to write profile information suitable for the
3545 analysis program @command{gprof}.  You must use this option when compiling
3546 the source files you want data about, and you must also use it when
3547 linking.
3549 @item -Q
3550 @opindex Q
3551 Makes the compiler print out each function name as it is compiled, and
3552 print some statistics about each pass when it finishes.
3554 @item -ftime-report
3555 @opindex ftime-report
3556 Makes the compiler print some statistics about the time consumed by each
3557 pass when it finishes.
3559 @item -fmem-report
3560 @opindex fmem-report
3561 Makes the compiler print some statistics about permanent memory
3562 allocation when it finishes.
3564 @item -fprofile-arcs
3565 @opindex fprofile-arcs
3566 Add code so that program flow @dfn{arcs} are instrumented.  During
3567 execution the program records how many times each branch and call is
3568 executed and how many times it is taken or returns.  When the compiled
3569 program exits it saves this data to a file called
3570 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3571 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3572 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3573 @var{auxname} is generated from the name of the output file, if
3574 explicitly specified and it is not the final executable, otherwise it is
3575 the basename of the source file.  In both cases any suffix is removed
3576 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3577 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3578 @xref{Cross-profiling}.
3580 @cindex @command{gcov}
3581 @item --coverage
3582 @opindex coverage
3584 This option is used to compile and link code instrumented for coverage
3585 analysis.  The option is a synonym for @option{-fprofile-arcs}
3586 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3587 linking).  See the documentation for those options for more details.
3589 @itemize
3591 @item
3592 Compile the source files with @option{-fprofile-arcs} plus optimization
3593 and code generation options.  For test coverage analysis, use the
3594 additional @option{-ftest-coverage} option.  You do not need to profile
3595 every source file in a program.
3597 @item
3598 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3599 (the latter implies the former).
3601 @item
3602 Run the program on a representative workload to generate the arc profile
3603 information.  This may be repeated any number of times.  You can run
3604 concurrent instances of your program, and provided that the file system
3605 supports locking, the data files will be correctly updated.  Also
3606 @code{fork} calls are detected and correctly handled (double counting
3607 will not happen).
3609 @item
3610 For profile-directed optimizations, compile the source files again with
3611 the same optimization and code generation options plus
3612 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3613 Control Optimization}).
3615 @item
3616 For test coverage analysis, use @command{gcov} to produce human readable
3617 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3618 @command{gcov} documentation for further information.
3620 @end itemize
3622 With @option{-fprofile-arcs}, for each function of your program GCC
3623 creates a program flow graph, then finds a spanning tree for the graph.
3624 Only arcs that are not on the spanning tree have to be instrumented: the
3625 compiler adds code to count the number of times that these arcs are
3626 executed.  When an arc is the only exit or only entrance to a block, the
3627 instrumentation code can be added to the block; otherwise, a new basic
3628 block must be created to hold the instrumentation code.
3630 @need 2000
3631 @item -ftest-coverage
3632 @opindex ftest-coverage
3633 Produce a notes file that the @command{gcov} code-coverage utility
3634 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3635 show program coverage.  Each source file's note file is called
3636 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3637 above for a description of @var{auxname} and instructions on how to
3638 generate test coverage data.  Coverage data will match the source files
3639 more closely, if you do not optimize.
3641 @item -d@var{letters}
3642 @item -fdump-rtl-@var{pass}
3643 @opindex d
3644 Says to make debugging dumps during compilation at times specified by
3645 @var{letters}.    This is used for debugging the RTL-based passes of the
3646 compiler.  The file names for most of the dumps are made by appending a
3647 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3648 from the name of the output file, if explicitly specified and it is not
3649 an executable, otherwise it is the basename of the source file.
3651 Most debug dumps can be enabled either passing a letter to the @option{-d}
3652 option, or with a long @option{-fdump-rtl} switch; here are the possible
3653 letters for use in @var{letters} and @var{pass}, and their meanings:
3655 @table @gcctabopt
3656 @item -dA
3657 @opindex dA
3658 Annotate the assembler output with miscellaneous debugging information.
3660 @item -db
3661 @itemx -fdump-rtl-bp
3662 @opindex db
3663 @opindex fdump-rtl-bp
3664 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3666 @item -dB
3667 @itemx -fdump-rtl-bbro
3668 @opindex dB
3669 @opindex fdump-rtl-bbro
3670 Dump after block reordering, to @file{@var{file}.30.bbro}.
3672 @item -dc
3673 @itemx -fdump-rtl-combine
3674 @opindex dc
3675 @opindex fdump-rtl-combine
3676 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3678 @item -dC
3679 @itemx -fdump-rtl-ce1
3680 @itemx -fdump-rtl-ce2
3681 @opindex dC
3682 @opindex fdump-rtl-ce1
3683 @opindex fdump-rtl-ce2
3684 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3685 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3686 and @option{-fdump-rtl-ce2} enable dumping after the second if
3687 conversion, to the file @file{@var{file}.18.ce2}.
3689 @item -dd
3690 @itemx -fdump-rtl-btl
3691 @itemx -fdump-rtl-dbr
3692 @opindex dd
3693 @opindex fdump-rtl-btl
3694 @opindex fdump-rtl-dbr
3695 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3696 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3697 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3698 scheduling, to @file{@var{file}.36.dbr}.
3700 @item -dD
3701 @opindex dD
3702 Dump all macro definitions, at the end of preprocessing, in addition to
3703 normal output.
3705 @item -dE
3706 @itemx -fdump-rtl-ce3
3707 @opindex dE
3708 @opindex fdump-rtl-ce3
3709 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3711 @item -df
3712 @itemx -fdump-rtl-cfg
3713 @itemx -fdump-rtl-life
3714 @opindex df
3715 @opindex fdump-rtl-cfg
3716 @opindex fdump-rtl-life
3717 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3718 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3719 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3720 to @file{@var{file}.16.life}.
3722 @item -dg
3723 @itemx -fdump-rtl-greg
3724 @opindex dg
3725 @opindex fdump-rtl-greg
3726 Dump after global register allocation, to @file{@var{file}.23.greg}.
3728 @item -dG
3729 @itemx -fdump-rtl-gcse
3730 @itemx -fdump-rtl-bypass
3731 @opindex dG
3732 @opindex fdump-rtl-gcse
3733 @opindex fdump-rtl-bypass
3734 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3735 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3736 enable dumping after jump bypassing and control flow optimizations, to
3737 @file{@var{file}.07.bypass}.
3739 @item -dh
3740 @itemx -fdump-rtl-eh
3741 @opindex dh
3742 @opindex fdump-rtl-eh
3743 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3745 @item -di
3746 @itemx -fdump-rtl-sibling
3747 @opindex di
3748 @opindex fdump-rtl-sibling
3749 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3751 @item -dj
3752 @itemx -fdump-rtl-jump
3753 @opindex dj
3754 @opindex fdump-rtl-jump
3755 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3757 @item -dk
3758 @itemx -fdump-rtl-stack
3759 @opindex dk
3760 @opindex fdump-rtl-stack
3761 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3763 @item -dl
3764 @itemx -fdump-rtl-lreg
3765 @opindex dl
3766 @opindex fdump-rtl-lreg
3767 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3769 @item -dL
3770 @itemx -fdump-rtl-loop
3771 @itemx -fdump-rtl-loop2
3772 @opindex dL
3773 @opindex fdump-rtl-loop
3774 @opindex fdump-rtl-loop2
3775 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3776 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3777 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3778 @file{@var{file}.13.loop2}.
3780 @item -dm
3781 @itemx -fdump-rtl-sms
3782 @opindex dm
3783 @opindex fdump-rtl-sms
3784 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3786 @item -dM
3787 @itemx -fdump-rtl-mach
3788 @opindex dM
3789 @opindex fdump-rtl-mach
3790 Dump after performing the machine dependent reorganization pass, to
3791 @file{@var{file}.35.mach}.
3793 @item -dn
3794 @itemx -fdump-rtl-rnreg
3795 @opindex dn
3796 @opindex fdump-rtl-rnreg
3797 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3799 @item -dN
3800 @itemx -fdump-rtl-regmove
3801 @opindex dN
3802 @opindex fdump-rtl-regmove
3803 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3805 @item -do
3806 @itemx -fdump-rtl-postreload
3807 @opindex do
3808 @opindex fdump-rtl-postreload
3809 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3811 @item -dr
3812 @itemx -fdump-rtl-expand
3813 @opindex dr
3814 @opindex fdump-rtl-expand
3815 Dump after RTL generation, to @file{@var{file}.00.expand}.
3817 @item -dR
3818 @itemx -fdump-rtl-sched2
3819 @opindex dR
3820 @opindex fdump-rtl-sched2
3821 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3823 @item -ds
3824 @itemx -fdump-rtl-cse
3825 @opindex ds
3826 @opindex fdump-rtl-cse
3827 Dump after CSE (including the jump optimization that sometimes follows
3828 CSE), to @file{@var{file}.04.cse}.
3830 @item -dS
3831 @itemx -fdump-rtl-sched
3832 @opindex dS
3833 @opindex fdump-rtl-sched
3834 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3836 @item -dt
3837 @itemx -fdump-rtl-cse2
3838 @opindex dt
3839 @opindex fdump-rtl-cse2
3840 Dump after the second CSE pass (including the jump optimization that
3841 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3843 @item -dT
3844 @itemx -fdump-rtl-tracer
3845 @opindex dT
3846 @opindex fdump-rtl-tracer
3847 Dump after running tracer, to @file{@var{file}.12.tracer}.
3849 @item -dV
3850 @itemx -fdump-rtl-vpt
3851 @itemx -fdump-rtl-vartrack
3852 @opindex dV
3853 @opindex fdump-rtl-vpt
3854 @opindex fdump-rtl-vartrack
3855 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3856 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3857 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3858 to @file{@var{file}.34.vartrack}.
3860 @item -dw
3861 @itemx -fdump-rtl-flow2
3862 @opindex dw
3863 @opindex fdump-rtl-flow2
3864 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3866 @item -dz
3867 @itemx -fdump-rtl-peephole2
3868 @opindex dz
3869 @opindex fdump-rtl-peephole2
3870 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3872 @item -dZ
3873 @itemx -fdump-rtl-web
3874 @opindex dZ
3875 @opindex fdump-rtl-web
3876 Dump after live range splitting, to @file{@var{file}.14.web}.
3878 @item -da
3879 @itemx -fdump-rtl-all
3880 @opindex da
3881 @opindex fdump-rtl-all
3882 Produce all the dumps listed above.
3884 @item -dH
3885 @opindex dH
3886 Produce a core dump whenever an error occurs.
3888 @item -dm
3889 @opindex dm
3890 Print statistics on memory usage, at the end of the run, to
3891 standard error.
3893 @item -dp
3894 @opindex dp
3895 Annotate the assembler output with a comment indicating which
3896 pattern and alternative was used.  The length of each instruction is
3897 also printed.
3899 @item -dP
3900 @opindex dP
3901 Dump the RTL in the assembler output as a comment before each instruction.
3902 Also turns on @option{-dp} annotation.
3904 @item -dv
3905 @opindex dv
3906 For each of the other indicated dump files (either with @option{-d} or
3907 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3908 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3910 @item -dx
3911 @opindex dx
3912 Just generate RTL for a function instead of compiling it.  Usually used
3913 with @samp{r} (@option{-fdump-rtl-expand}).
3915 @item -dy
3916 @opindex dy
3917 Dump debugging information during parsing, to standard error.
3918 @end table
3920 @item -fdump-unnumbered
3921 @opindex fdump-unnumbered
3922 When doing debugging dumps (see @option{-d} option above), suppress instruction
3923 numbers and line number note output.  This makes it more feasible to
3924 use diff on debugging dumps for compiler invocations with different
3925 options, in particular with and without @option{-g}.
3927 @item -fdump-translation-unit @r{(C++ only)}
3928 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3929 @opindex fdump-translation-unit
3930 Dump a representation of the tree structure for the entire translation
3931 unit to a file.  The file name is made by appending @file{.tu} to the
3932 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3933 controls the details of the dump as described for the
3934 @option{-fdump-tree} options.
3936 @item -fdump-class-hierarchy @r{(C++ only)}
3937 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3938 @opindex fdump-class-hierarchy
3939 Dump a representation of each class's hierarchy and virtual function
3940 table layout to a file.  The file name is made by appending @file{.class}
3941 to the source file name.  If the @samp{-@var{options}} form is used,
3942 @var{options} controls the details of the dump as described for the
3943 @option{-fdump-tree} options.
3945 @item -fdump-ipa-@var{switch}
3946 @opindex fdump-ipa
3947 Control the dumping at various stages of inter-procedural analysis
3948 language tree to a file.  The file name is generated by appending a switch
3949 specific suffix to the source file name.  The following dumps are possible:
3951 @table @samp
3952 @item all
3953 Enables all inter-procedural analysis dumps; currently the only produced
3954 dump is the @samp{cgraph} dump.
3956 @item cgraph
3957 Dumps information about call-graph optimization, unused function removal,
3958 and inlining decisions.
3959 @end table
3961 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3962 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3963 @opindex fdump-tree
3964 Control the dumping at various stages of processing the intermediate
3965 language tree to a file.  The file name is generated by appending a switch
3966 specific suffix to the source file name.  If the @samp{-@var{options}}
3967 form is used, @var{options} is a list of @samp{-} separated options that
3968 control the details of the dump.  Not all options are applicable to all
3969 dumps, those which are not meaningful will be ignored.  The following
3970 options are available
3972 @table @samp
3973 @item address
3974 Print the address of each node.  Usually this is not meaningful as it
3975 changes according to the environment and source file.  Its primary use
3976 is for tying up a dump file with a debug environment.
3977 @item slim
3978 Inhibit dumping of members of a scope or body of a function merely
3979 because that scope has been reached.  Only dump such items when they
3980 are directly reachable by some other path.  When dumping pretty-printed
3981 trees, this option inhibits dumping the bodies of control structures.
3982 @item raw
3983 Print a raw representation of the tree.  By default, trees are
3984 pretty-printed into a C-like representation.
3985 @item details
3986 Enable more detailed dumps (not honored by every dump option).
3987 @item stats
3988 Enable dumping various statistics about the pass (not honored by every dump
3989 option).
3990 @item blocks
3991 Enable showing basic block boundaries (disabled in raw dumps).
3992 @item vops
3993 Enable showing virtual operands for every statement.
3994 @item lineno
3995 Enable showing line numbers for statements.
3996 @item uid
3997 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3998 @item all
3999 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4000 @end table
4002 The following tree dumps are possible:
4003 @table @samp
4005 @item original
4006 Dump before any tree based optimization, to @file{@var{file}.original}.
4008 @item optimized
4009 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4011 @item inlined
4012 Dump after function inlining, to @file{@var{file}.inlined}.
4014 @item gimple
4015 @opindex fdump-tree-gimple
4016 Dump each function before and after the gimplification pass to a file.  The
4017 file name is made by appending @file{.gimple} to the source file name.
4019 @item cfg
4020 @opindex fdump-tree-cfg
4021 Dump the control flow graph of each function to a file.  The file name is
4022 made by appending @file{.cfg} to the source file name.
4024 @item vcg
4025 @opindex fdump-tree-vcg
4026 Dump the control flow graph of each function to a file in VCG format.  The
4027 file name is made by appending @file{.vcg} to the source file name.  Note
4028 that if the file contains more than one function, the generated file cannot
4029 be used directly by VCG@.  You will need to cut and paste each function's
4030 graph into its own separate file first.
4032 @item ch
4033 @opindex fdump-tree-ch
4034 Dump each function after copying loop headers.  The file name is made by
4035 appending @file{.ch} to the source file name.
4037 @item ssa
4038 @opindex fdump-tree-ssa
4039 Dump SSA related information to a file.  The file name is made by appending
4040 @file{.ssa} to the source file name.
4042 @item salias
4043 @opindex fdump-tree-salias
4044 Dump structure aliasing variable information to a file.  This file name
4045 is made by appending @file{.salias} to the source file name.
4047 @item alias
4048 @opindex fdump-tree-alias
4049 Dump aliasing information for each function.  The file name is made by
4050 appending @file{.alias} to the source file name.
4052 @item ccp
4053 @opindex fdump-tree-ccp
4054 Dump each function after CCP@.  The file name is made by appending
4055 @file{.ccp} to the source file name.
4057 @item storeccp
4058 @opindex fdump-tree-storeccp
4059 Dump each function after STORE-CCP.  The file name is made by appending
4060 @file{.storeccp} to the source file name.
4062 @item pre
4063 @opindex fdump-tree-pre
4064 Dump trees after partial redundancy elimination.  The file name is made
4065 by appending @file{.pre} to the source file name.
4067 @item fre
4068 @opindex fdump-tree-fre
4069 Dump trees after full redundancy elimination.  The file name is made
4070 by appending @file{.fre} to the source file name.
4072 @item copyprop
4073 @opindex fdump-tree-copyprop
4074 Dump trees after copy propagation.  The file name is made
4075 by appending @file{.copyprop} to the source file name.
4077 @item store_copyprop
4078 @opindex fdump-tree-store_copyprop
4079 Dump trees after store copy-propagation.  The file name is made
4080 by appending @file{.store_copyprop} to the source file name.
4082 @item dce
4083 @opindex fdump-tree-dce
4084 Dump each function after dead code elimination.  The file name is made by
4085 appending @file{.dce} to the source file name.
4087 @item mudflap
4088 @opindex fdump-tree-mudflap
4089 Dump each function after adding mudflap instrumentation.  The file name is
4090 made by appending @file{.mudflap} to the source file name.
4092 @item sra
4093 @opindex fdump-tree-sra
4094 Dump each function after performing scalar replacement of aggregates.  The
4095 file name is made by appending @file{.sra} to the source file name.
4097 @item sink
4098 @opindex fdump-tree-sink
4099 Dump each function after performing code sinking.  The file name is made
4100 by appending @file{.sink} to the source file name. 
4102 @item dom
4103 @opindex fdump-tree-dom
4104 Dump each function after applying dominator tree optimizations.  The file
4105 name is made by appending @file{.dom} to the source file name.
4107 @item dse
4108 @opindex fdump-tree-dse
4109 Dump each function after applying dead store elimination.  The file
4110 name is made by appending @file{.dse} to the source file name.
4112 @item phiopt
4113 @opindex fdump-tree-phiopt
4114 Dump each function after optimizing PHI nodes into straightline code.  The file
4115 name is made by appending @file{.phiopt} to the source file name.
4117 @item forwprop
4118 @opindex fdump-tree-forwprop
4119 Dump each function after forward propagating single use variables.  The file
4120 name is made by appending @file{.forwprop} to the source file name.
4122 @item copyrename
4123 @opindex fdump-tree-copyrename
4124 Dump each function after applying the copy rename optimization.  The file
4125 name is made by appending @file{.copyrename} to the source file name.
4127 @item nrv
4128 @opindex fdump-tree-nrv
4129 Dump each function after applying the named return value optimization on
4130 generic trees.  The file name is made by appending @file{.nrv} to the source
4131 file name.
4133 @item vect
4134 @opindex fdump-tree-vect
4135 Dump each function after applying vectorization of loops.  The file name is
4136 made by appending @file{.vect} to the source file name.
4138 @item vrp
4139 @opindex fdump-tree-vrp
4140 Dump each function after Value Range Propagation (VRP).  The file name
4141 is made by appending @file{.vrp} to the source file name.
4143 @item all
4144 @opindex fdump-tree-all
4145 Enable all the available tree dumps with the flags provided in this option.
4146 @end table
4148 @item -ftree-vectorizer-verbose=@var{n}
4149 @opindex ftree-vectorizer-verbose
4150 This option controls the amount of debugging output the vectorizer prints.
4151 This information is written to standard error, unless @option{-fdump-tree-all}
4152 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4153 usual dump listing file, @file{.vect}.
4155 @item -frandom-seed=@var{string}
4156 @opindex frandom-string
4157 This option provides a seed that GCC uses when it would otherwise use
4158 random numbers.  It is used to generate certain symbol names
4159 that have to be different in every compiled file.  It is also used to
4160 place unique stamps in coverage data files and the object files that
4161 produce them.  You can use the @option{-frandom-seed} option to produce
4162 reproducibly identical object files.
4164 The @var{string} should be different for every file you compile.
4166 @item -fsched-verbose=@var{n}
4167 @opindex fsched-verbose
4168 On targets that use instruction scheduling, this option controls the
4169 amount of debugging output the scheduler prints.  This information is
4170 written to standard error, unless @option{-dS} or @option{-dR} is
4171 specified, in which case it is output to the usual dump
4172 listing file, @file{.sched} or @file{.sched2} respectively.  However
4173 for @var{n} greater than nine, the output is always printed to standard
4174 error.
4176 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4177 same information as @option{-dRS}.  For @var{n} greater than one, it
4178 also output basic block probabilities, detailed ready list information
4179 and unit/insn info.  For @var{n} greater than two, it includes RTL
4180 at abort point, control-flow and regions info.  And for @var{n} over
4181 four, @option{-fsched-verbose} also includes dependence info.
4183 @item -save-temps
4184 @opindex save-temps
4185 Store the usual ``temporary'' intermediate files permanently; place them
4186 in the current directory and name them based on the source file.  Thus,
4187 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4188 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4189 preprocessed @file{foo.i} output file even though the compiler now
4190 normally uses an integrated preprocessor.
4192 When used in combination with the @option{-x} command line option,
4193 @option{-save-temps} is sensible enough to avoid over writing an
4194 input source file with the same extension as an intermediate file.
4195 The corresponding intermediate file may be obtained by renaming the
4196 source file before using @option{-save-temps}.
4198 @item -time
4199 @opindex time
4200 Report the CPU time taken by each subprocess in the compilation
4201 sequence.  For C source files, this is the compiler proper and assembler
4202 (plus the linker if linking is done).  The output looks like this:
4204 @smallexample
4205 # cc1 0.12 0.01
4206 # as 0.00 0.01
4207 @end smallexample
4209 The first number on each line is the ``user time'', that is time spent
4210 executing the program itself.  The second number is ``system time'',
4211 time spent executing operating system routines on behalf of the program.
4212 Both numbers are in seconds.
4214 @item -fvar-tracking
4215 @opindex fvar-tracking
4216 Run variable tracking pass.  It computes where variables are stored at each
4217 position in code.  Better debugging information is then generated
4218 (if the debugging information format supports this information).
4220 It is enabled by default when compiling with optimization (@option{-Os},
4221 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4222 the debug info format supports it.
4224 @item -print-file-name=@var{library}
4225 @opindex print-file-name
4226 Print the full absolute name of the library file @var{library} that
4227 would be used when linking---and don't do anything else.  With this
4228 option, GCC does not compile or link anything; it just prints the
4229 file name.
4231 @item -print-multi-directory
4232 @opindex print-multi-directory
4233 Print the directory name corresponding to the multilib selected by any
4234 other switches present in the command line.  This directory is supposed
4235 to exist in @env{GCC_EXEC_PREFIX}.
4237 @item -print-multi-lib
4238 @opindex print-multi-lib
4239 Print the mapping from multilib directory names to compiler switches
4240 that enable them.  The directory name is separated from the switches by
4241 @samp{;}, and each switch starts with an @samp{@@} instead of the
4242 @samp{-}, without spaces between multiple switches.  This is supposed to
4243 ease shell-processing.
4245 @item -print-prog-name=@var{program}
4246 @opindex print-prog-name
4247 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4249 @item -print-libgcc-file-name
4250 @opindex print-libgcc-file-name
4251 Same as @option{-print-file-name=libgcc.a}.
4253 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4254 but you do want to link with @file{libgcc.a}.  You can do
4256 @smallexample
4257 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4258 @end smallexample
4260 @item -print-search-dirs
4261 @opindex print-search-dirs
4262 Print the name of the configured installation directory and a list of
4263 program and library directories @command{gcc} will search---and don't do anything else.
4265 This is useful when @command{gcc} prints the error message
4266 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4267 To resolve this you either need to put @file{cpp0} and the other compiler
4268 components where @command{gcc} expects to find them, or you can set the environment
4269 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4270 Don't forget the trailing @samp{/}.
4271 @xref{Environment Variables}.
4273 @item -dumpmachine
4274 @opindex dumpmachine
4275 Print the compiler's target machine (for example,
4276 @samp{i686-pc-linux-gnu})---and don't do anything else.
4278 @item -dumpversion
4279 @opindex dumpversion
4280 Print the compiler version (for example, @samp{3.0})---and don't do
4281 anything else.
4283 @item -dumpspecs
4284 @opindex dumpspecs
4285 Print the compiler's built-in specs---and don't do anything else.  (This
4286 is used when GCC itself is being built.)  @xref{Spec Files}.
4288 @item -feliminate-unused-debug-types
4289 @opindex feliminate-unused-debug-types
4290 Normally, when producing DWARF2 output, GCC will emit debugging
4291 information for all types declared in a compilation
4292 unit, regardless of whether or not they are actually used
4293 in that compilation unit.  Sometimes this is useful, such as
4294 if, in the debugger, you want to cast a value to a type that is
4295 not actually used in your program (but is declared).  More often,
4296 however, this results in a significant amount of wasted space.
4297 With this option, GCC will avoid producing debug symbol output
4298 for types that are nowhere used in the source file being compiled.
4299 @end table
4301 @node Optimize Options
4302 @section Options That Control Optimization
4303 @cindex optimize options
4304 @cindex options, optimization
4306 These options control various sorts of optimizations.
4308 Without any optimization option, the compiler's goal is to reduce the
4309 cost of compilation and to make debugging produce the expected
4310 results.  Statements are independent: if you stop the program with a
4311 breakpoint between statements, you can then assign a new value to any
4312 variable or change the program counter to any other statement in the
4313 function and get exactly the results you would expect from the source
4314 code.
4316 Turning on optimization flags makes the compiler attempt to improve
4317 the performance and/or code size at the expense of compilation time
4318 and possibly the ability to debug the program.
4320 The compiler performs optimization based on the knowledge it has of
4321 the program.  Optimization levels @option{-O2} and above, in
4322 particular, enable @emph{unit-at-a-time} mode, which allows the
4323 compiler to consider information gained from later functions in
4324 the file when compiling a function.  Compiling multiple files at
4325 once to a single output file in @emph{unit-at-a-time} mode allows
4326 the compiler to use information gained from all of the files when
4327 compiling each of them.
4329 Not all optimizations are controlled directly by a flag.  Only
4330 optimizations that have a flag are listed.
4332 @table @gcctabopt
4333 @item -O
4334 @itemx -O1
4335 @opindex O
4336 @opindex O1
4337 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4338 more memory for a large function.
4340 With @option{-O}, the compiler tries to reduce code size and execution
4341 time, without performing any optimizations that take a great deal of
4342 compilation time.
4344 @option{-O} turns on the following optimization flags:
4345 @gccoptlist{-fdefer-pop @gol
4346 -fdelayed-branch @gol
4347 -fguess-branch-probability @gol
4348 -fcprop-registers @gol
4349 -floop-optimize @gol
4350 -fif-conversion @gol
4351 -fif-conversion2 @gol
4352 -ftree-ccp @gol
4353 -ftree-dce @gol
4354 -ftree-dominator-opts @gol
4355 -ftree-dse @gol
4356 -ftree-ter @gol
4357 -ftree-lrs @gol
4358 -ftree-sra @gol
4359 -ftree-copyrename @gol
4360 -ftree-fre @gol
4361 -ftree-ch @gol
4362 -fmerge-constants}
4364 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4365 where doing so does not interfere with debugging.
4367 @item -O2
4368 @opindex O2
4369 Optimize even more.  GCC performs nearly all supported optimizations
4370 that do not involve a space-speed tradeoff.  The compiler does not
4371 perform loop unrolling or function inlining when you specify @option{-O2}.
4372 As compared to @option{-O}, this option increases both compilation time
4373 and the performance of the generated code.
4375 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4376 also turns on the following optimization flags:
4377 @gccoptlist{-fthread-jumps @gol
4378 -fcrossjumping @gol
4379 -foptimize-sibling-calls @gol
4380 -fcse-follow-jumps  -fcse-skip-blocks @gol
4381 -fgcse  -fgcse-lm  @gol
4382 -fexpensive-optimizations @gol
4383 -fstrength-reduce @gol
4384 -frerun-cse-after-loop  -frerun-loop-opt @gol
4385 -fcaller-saves @gol
4386 -fpeephole2 @gol
4387 -fschedule-insns  -fschedule-insns2 @gol
4388 -fsched-interblock  -fsched-spec @gol
4389 -fregmove @gol
4390 -fstrict-aliasing @gol
4391 -fdelete-null-pointer-checks @gol
4392 -freorder-blocks  -freorder-functions @gol
4393 -funit-at-a-time @gol
4394 -falign-functions  -falign-jumps @gol
4395 -falign-loops  -falign-labels @gol
4396 -ftree-vrp @gol
4397 -ftree-pre}
4399 Please note the warning under @option{-fgcse} about
4400 invoking @option{-O2} on programs that use computed gotos.
4402 @item -O3
4403 @opindex O3
4404 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4405 @option{-O2} and also turns on the @option{-finline-functions},
4406 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4408 @item -O0
4409 @opindex O0
4410 Do not optimize.  This is the default.
4412 @item -Os
4413 @opindex Os
4414 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4415 do not typically increase code size.  It also performs further
4416 optimizations designed to reduce code size.
4418 @option{-Os} disables the following optimization flags:
4419 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4420 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4421 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4423 If you use multiple @option{-O} options, with or without level numbers,
4424 the last such option is the one that is effective.
4425 @end table
4427 Options of the form @option{-f@var{flag}} specify machine-independent
4428 flags.  Most flags have both positive and negative forms; the negative
4429 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4430 below, only one of the forms is listed---the one you typically will
4431 use.  You can figure out the other form by either removing @samp{no-}
4432 or adding it.
4434 The following options control specific optimizations.  They are either
4435 activated by @option{-O} options or are related to ones that are.  You
4436 can use the following flags in the rare cases when ``fine-tuning'' of
4437 optimizations to be performed is desired.
4439 @table @gcctabopt
4440 @item -fno-default-inline
4441 @opindex fno-default-inline
4442 Do not make member functions inline by default merely because they are
4443 defined inside the class scope (C++ only).  Otherwise, when you specify
4444 @w{@option{-O}}, member functions defined inside class scope are compiled
4445 inline by default; i.e., you don't need to add @samp{inline} in front of
4446 the member function name.
4448 @item -fno-defer-pop
4449 @opindex fno-defer-pop
4450 Always pop the arguments to each function call as soon as that function
4451 returns.  For machines which must pop arguments after a function call,
4452 the compiler normally lets arguments accumulate on the stack for several
4453 function calls and pops them all at once.
4455 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4457 @item -fforce-mem
4458 @opindex fforce-mem
4459 Force memory operands to be copied into registers before doing
4460 arithmetic on them.  This produces better code by making all memory
4461 references potential common subexpressions.  When they are not common
4462 subexpressions, instruction combination should eliminate the separate
4463 register-load. This option is now a nop and will be removed in 4.2.
4465 @item -fforce-addr
4466 @opindex fforce-addr
4467 Force memory address constants to be copied into registers before
4468 doing arithmetic on them.
4470 @item -fomit-frame-pointer
4471 @opindex fomit-frame-pointer
4472 Don't keep the frame pointer in a register for functions that
4473 don't need one.  This avoids the instructions to save, set up and
4474 restore frame pointers; it also makes an extra register available
4475 in many functions.  @strong{It also makes debugging impossible on
4476 some machines.}
4478 On some machines, such as the VAX, this flag has no effect, because
4479 the standard calling sequence automatically handles the frame pointer
4480 and nothing is saved by pretending it doesn't exist.  The
4481 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4482 whether a target machine supports this flag.  @xref{Registers,,Register
4483 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4485 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4487 @item -foptimize-sibling-calls
4488 @opindex foptimize-sibling-calls
4489 Optimize sibling and tail recursive calls.
4491 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4493 @item -fno-inline
4494 @opindex fno-inline
4495 Don't pay attention to the @code{inline} keyword.  Normally this option
4496 is used to keep the compiler from expanding any functions inline.
4497 Note that if you are not optimizing, no functions can be expanded inline.
4499 @item -finline-functions
4500 @opindex finline-functions
4501 Integrate all simple functions into their callers.  The compiler
4502 heuristically decides which functions are simple enough to be worth
4503 integrating in this way.
4505 If all calls to a given function are integrated, and the function is
4506 declared @code{static}, then the function is normally not output as
4507 assembler code in its own right.
4509 Enabled at level @option{-O3}.
4511 @item -finline-functions-called-once
4512 @opindex finline-functions-called-once
4513 Consider all @code{static} functions called once for inlining into their
4514 caller even if they are not marked @code{inline}.  If a call to a given
4515 function is integrated, then the function is not output as assembler code
4516 in its own right.
4518 Enabled if @option{-funit-at-a-time} is enabled.
4520 @item -fearly-inlining
4521 @opindex fearly-inlining
4522 Inline functions marked by @code{always_inline} and functions whose body seems
4523 smaller than the function call overhead early before doing
4524 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4525 makes profiling significantly cheaper and usually inlining faster on programs
4526 having large chains of nested wrapper functions.
4528 Enabled by default.
4530 @item -finline-limit=@var{n}
4531 @opindex finline-limit
4532 By default, GCC limits the size of functions that can be inlined.  This flag
4533 allows the control of this limit for functions that are explicitly marked as
4534 inline (i.e., marked with the inline keyword or defined within the class
4535 definition in c++).  @var{n} is the size of functions that can be inlined in
4536 number of pseudo instructions (not counting parameter handling).  The default
4537 value of @var{n} is 600.
4538 Increasing this value can result in more inlined code at
4539 the cost of compilation time and memory consumption.  Decreasing usually makes
4540 the compilation faster and less code will be inlined (which presumably
4541 means slower programs).  This option is particularly useful for programs that
4542 use inlining heavily such as those based on recursive templates with C++.
4544 Inlining is actually controlled by a number of parameters, which may be
4545 specified individually by using @option{--param @var{name}=@var{value}}.
4546 The @option{-finline-limit=@var{n}} option sets some of these parameters
4547 as follows:
4549 @table @gcctabopt
4550  @item max-inline-insns-single
4551   is set to @var{n}/2.
4552  @item max-inline-insns-auto
4553   is set to @var{n}/2.
4554  @item min-inline-insns
4555   is set to 130 or @var{n}/4, whichever is smaller.
4556  @item max-inline-insns-rtl
4557   is set to @var{n}.
4558 @end table
4560 See below for a documentation of the individual
4561 parameters controlling inlining.
4563 @emph{Note:} pseudo instruction represents, in this particular context, an
4564 abstract measurement of function's size.  In no way does it represent a count
4565 of assembly instructions and as such its exact meaning might change from one
4566 release to an another.
4568 @item -fkeep-inline-functions
4569 @opindex fkeep-inline-functions
4570 In C, emit @code{static} functions that are declared @code{inline}
4571 into the object file, even if the function has been inlined into all
4572 of its callers.  This switch does not affect functions using the
4573 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4574 inline functions into the object file.
4576 @item -fkeep-static-consts
4577 @opindex fkeep-static-consts
4578 Emit variables declared @code{static const} when optimization isn't turned
4579 on, even if the variables aren't referenced.
4581 GCC enables this option by default.  If you want to force the compiler to
4582 check if the variable was referenced, regardless of whether or not
4583 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4585 @item -fmerge-constants
4586 Attempt to merge identical constants (string constants and floating point
4587 constants) across compilation units.
4589 This option is the default for optimized compilation if the assembler and
4590 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4591 behavior.
4593 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4595 @item -fmerge-all-constants
4596 Attempt to merge identical constants and identical variables.
4598 This option implies @option{-fmerge-constants}.  In addition to
4599 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4600 arrays or initialized constant variables with integral or floating point
4601 types.  Languages like C or C++ require each non-automatic variable to
4602 have distinct location, so using this option will result in non-conforming
4603 behavior.
4605 @item -fmodulo-sched
4606 @opindex fmodulo-sched
4607 Perform swing modulo scheduling immediately before the first scheduling
4608 pass.  This pass looks at innermost loops and reorders their
4609 instructions by overlapping different iterations.
4611 @item -fno-branch-count-reg
4612 @opindex fno-branch-count-reg
4613 Do not use ``decrement and branch'' instructions on a count register,
4614 but instead generate a sequence of instructions that decrement a
4615 register, compare it against zero, then branch based upon the result.
4616 This option is only meaningful on architectures that support such
4617 instructions, which include x86, PowerPC, IA-64 and S/390.
4619 The default is @option{-fbranch-count-reg}, enabled when
4620 @option{-fstrength-reduce} is enabled.
4622 @item -fno-function-cse
4623 @opindex fno-function-cse
4624 Do not put function addresses in registers; make each instruction that
4625 calls a constant function contain the function's address explicitly.
4627 This option results in less efficient code, but some strange hacks
4628 that alter the assembler output may be confused by the optimizations
4629 performed when this option is not used.
4631 The default is @option{-ffunction-cse}
4633 @item -fno-zero-initialized-in-bss
4634 @opindex fno-zero-initialized-in-bss
4635 If the target supports a BSS section, GCC by default puts variables that
4636 are initialized to zero into BSS@.  This can save space in the resulting
4637 code.
4639 This option turns off this behavior because some programs explicitly
4640 rely on variables going to the data section.  E.g., so that the
4641 resulting executable can find the beginning of that section and/or make
4642 assumptions based on that.
4644 The default is @option{-fzero-initialized-in-bss}.
4646 @item -fbounds-check
4647 @opindex fbounds-check
4648 For front-ends that support it, generate additional code to check that
4649 indices used to access arrays are within the declared range.  This is
4650 currently only supported by the Java and Fortran front-ends, where
4651 this option defaults to true and false respectively.
4653 @item -fmudflap -fmudflapth -fmudflapir
4654 @opindex fmudflap
4655 @opindex fmudflapth
4656 @opindex fmudflapir
4657 @cindex bounds checking
4658 @cindex mudflap
4659 For front-ends that support it (C and C++), instrument all risky
4660 pointer/array dereferencing operations, some standard library
4661 string/heap functions, and some other associated constructs with
4662 range/validity tests.  Modules so instrumented should be immune to
4663 buffer overflows, invalid heap use, and some other classes of C/C++
4664 programming errors.  The instrumentation relies on a separate runtime
4665 library (@file{libmudflap}), which will be linked into a program if
4666 @option{-fmudflap} is given at link time.  Run-time behavior of the
4667 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4668 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4669 for its options.
4671 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4672 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4673 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4674 instrumentation should ignore pointer reads.  This produces less
4675 instrumentation (and therefore faster execution) and still provides
4676 some protection against outright memory corrupting writes, but allows
4677 erroneously read data to propagate within a program.
4679 @item -fstrength-reduce
4680 @opindex fstrength-reduce
4681 Perform the optimizations of loop strength reduction and
4682 elimination of iteration variables.
4684 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4686 @item -fthread-jumps
4687 @opindex fthread-jumps
4688 Perform optimizations where we check to see if a jump branches to a
4689 location where another comparison subsumed by the first is found.  If
4690 so, the first branch is redirected to either the destination of the
4691 second branch or a point immediately following it, depending on whether
4692 the condition is known to be true or false.
4694 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4696 @item -fcse-follow-jumps
4697 @opindex fcse-follow-jumps
4698 In common subexpression elimination, scan through jump instructions
4699 when the target of the jump is not reached by any other path.  For
4700 example, when CSE encounters an @code{if} statement with an
4701 @code{else} clause, CSE will follow the jump when the condition
4702 tested is false.
4704 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4706 @item -fcse-skip-blocks
4707 @opindex fcse-skip-blocks
4708 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4709 follow jumps which conditionally skip over blocks.  When CSE
4710 encounters a simple @code{if} statement with no else clause,
4711 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4712 body of the @code{if}.
4714 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4716 @item -frerun-cse-after-loop
4717 @opindex frerun-cse-after-loop
4718 Re-run common subexpression elimination after loop optimizations has been
4719 performed.
4721 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4723 @item -frerun-loop-opt
4724 @opindex frerun-loop-opt
4725 Run the loop optimizer twice.
4727 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4729 @item -fgcse
4730 @opindex fgcse
4731 Perform a global common subexpression elimination pass.
4732 This pass also performs global constant and copy propagation.
4734 @emph{Note:} When compiling a program using computed gotos, a GCC
4735 extension, you may get better runtime performance if you disable
4736 the global common subexpression elimination pass by adding
4737 @option{-fno-gcse} to the command line.
4739 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4741 @item -fgcse-lm
4742 @opindex fgcse-lm
4743 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4744 attempt to move loads which are only killed by stores into themselves.  This
4745 allows a loop containing a load/store sequence to be changed to a load outside
4746 the loop, and a copy/store within the loop.
4748 Enabled by default when gcse is enabled.
4750 @item -fgcse-sm
4751 @opindex fgcse-sm
4752 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4753 global common subexpression elimination.  This pass will attempt to move
4754 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4755 loops containing a load/store sequence can be changed to a load before
4756 the loop and a store after the loop.
4758 Not enabled at any optimization level.
4760 @item -fgcse-las
4761 @opindex fgcse-las
4762 When @option{-fgcse-las} is enabled, the global common subexpression
4763 elimination pass eliminates redundant loads that come after stores to the
4764 same memory location (both partial and full redundancies).
4766 Not enabled at any optimization level.
4768 @item -fgcse-after-reload
4769 @opindex fgcse-after-reload
4770 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4771 pass is performed after reload.  The purpose of this pass is to cleanup
4772 redundant spilling.
4774 @item -floop-optimize
4775 @opindex floop-optimize
4776 Perform loop optimizations: move constant expressions out of loops, simplify
4777 exit test conditions and optionally do strength-reduction as well.
4779 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4781 @item -floop-optimize2
4782 @opindex floop-optimize2
4783 Perform loop optimizations using the new loop optimizer.  The optimizations
4784 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4785 by separate flags.
4787 @item -funsafe-loop-optimizations
4788 @opindex funsafe-loop-optimizations
4789 If given, the loop optimizer will assume that loop indices do not
4790 overflow, and that the loops with nontrivial exit condition are not
4791 infinite.  This enables a wider range of loop optimizations even if
4792 the loop optimizer itself cannot prove that these assumptions are valid.
4793 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4794 if it finds this kind of loop.
4796 @item -fcrossjumping
4797 @opindex crossjumping
4798 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4799 resulting code may or may not perform better than without cross-jumping.
4801 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4803 @item -fif-conversion
4804 @opindex if-conversion
4805 Attempt to transform conditional jumps into branch-less equivalents.  This
4806 include use of conditional moves, min, max, set flags and abs instructions, and
4807 some tricks doable by standard arithmetics.  The use of conditional execution
4808 on chips where it is available is controlled by @code{if-conversion2}.
4810 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4812 @item -fif-conversion2
4813 @opindex if-conversion2
4814 Use conditional execution (where available) to transform conditional jumps into
4815 branch-less equivalents.
4817 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4819 @item -fdelete-null-pointer-checks
4820 @opindex fdelete-null-pointer-checks
4821 Use global dataflow analysis to identify and eliminate useless checks
4822 for null pointers.  The compiler assumes that dereferencing a null
4823 pointer would have halted the program.  If a pointer is checked after
4824 it has already been dereferenced, it cannot be null.
4826 In some environments, this assumption is not true, and programs can
4827 safely dereference null pointers.  Use
4828 @option{-fno-delete-null-pointer-checks} to disable this optimization
4829 for programs which depend on that behavior.
4831 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4833 @item -fexpensive-optimizations
4834 @opindex fexpensive-optimizations
4835 Perform a number of minor optimizations that are relatively expensive.
4837 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4839 @item -foptimize-register-move
4840 @itemx -fregmove
4841 @opindex foptimize-register-move
4842 @opindex fregmove
4843 Attempt to reassign register numbers in move instructions and as
4844 operands of other simple instructions in order to maximize the amount of
4845 register tying.  This is especially helpful on machines with two-operand
4846 instructions.
4848 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4849 optimization.
4851 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4853 @item -fdelayed-branch
4854 @opindex fdelayed-branch
4855 If supported for the target machine, attempt to reorder instructions
4856 to exploit instruction slots available after delayed branch
4857 instructions.
4859 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4861 @item -fschedule-insns
4862 @opindex fschedule-insns
4863 If supported for the target machine, attempt to reorder instructions to
4864 eliminate execution stalls due to required data being unavailable.  This
4865 helps machines that have slow floating point or memory load instructions
4866 by allowing other instructions to be issued until the result of the load
4867 or floating point instruction is required.
4869 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4871 @item -fschedule-insns2
4872 @opindex fschedule-insns2
4873 Similar to @option{-fschedule-insns}, but requests an additional pass of
4874 instruction scheduling after register allocation has been done.  This is
4875 especially useful on machines with a relatively small number of
4876 registers and where memory load instructions take more than one cycle.
4878 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4880 @item -fno-sched-interblock
4881 @opindex fno-sched-interblock
4882 Don't schedule instructions across basic blocks.  This is normally
4883 enabled by default when scheduling before register allocation, i.e.@:
4884 with @option{-fschedule-insns} or at @option{-O2} or higher.
4886 @item -fno-sched-spec
4887 @opindex fno-sched-spec
4888 Don't allow speculative motion of non-load instructions.  This is normally
4889 enabled by default when scheduling before register allocation, i.e.@:
4890 with @option{-fschedule-insns} or at @option{-O2} or higher.
4892 @item -fsched-spec-load
4893 @opindex fsched-spec-load
4894 Allow speculative motion of some load instructions.  This only makes
4895 sense when scheduling before register allocation, i.e.@: with
4896 @option{-fschedule-insns} or at @option{-O2} or higher.
4898 @item -fsched-spec-load-dangerous
4899 @opindex fsched-spec-load-dangerous
4900 Allow speculative motion of more load instructions.  This only makes
4901 sense when scheduling before register allocation, i.e.@: with
4902 @option{-fschedule-insns} or at @option{-O2} or higher.
4904 @item -fsched-stalled-insns=@var{n}
4905 @opindex fsched-stalled-insns
4906 Define how many insns (if any) can be moved prematurely from the queue
4907 of stalled insns into the ready list, during the second scheduling pass.
4909 @item -fsched-stalled-insns-dep=@var{n}
4910 @opindex fsched-stalled-insns-dep
4911 Define how many insn groups (cycles) will be examined for a dependency
4912 on a stalled insn that is candidate for premature removal from the queue
4913 of stalled insns.  Has an effect only during the second scheduling pass,
4914 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4916 @item -fsched2-use-superblocks
4917 @opindex fsched2-use-superblocks
4918 When scheduling after register allocation, do use superblock scheduling
4919 algorithm.  Superblock scheduling allows motion across basic block boundaries
4920 resulting on faster schedules.  This option is experimental, as not all machine
4921 descriptions used by GCC model the CPU closely enough to avoid unreliable
4922 results from the algorithm.
4924 This only makes sense when scheduling after register allocation, i.e.@: with
4925 @option{-fschedule-insns2} or at @option{-O2} or higher.
4927 @item -fsched2-use-traces
4928 @opindex fsched2-use-traces
4929 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4930 allocation and additionally perform code duplication in order to increase the
4931 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4932 trace formation.
4934 This mode should produce faster but significantly longer programs.  Also
4935 without @option{-fbranch-probabilities} the traces constructed may not
4936 match the reality and hurt the performance.  This only makes
4937 sense when scheduling after register allocation, i.e.@: with
4938 @option{-fschedule-insns2} or at @option{-O2} or higher.
4940 @item -freschedule-modulo-scheduled-loops
4941 @opindex fscheduling-in-modulo-scheduled-loops
4942 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4943 we may want to prevent the later scheduling passes from changing its schedule, we use this
4944 option to control that.
4946 @item -fcaller-saves
4947 @opindex fcaller-saves
4948 Enable values to be allocated in registers that will be clobbered by
4949 function calls, by emitting extra instructions to save and restore the
4950 registers around such calls.  Such allocation is done only when it
4951 seems to result in better code than would otherwise be produced.
4953 This option is always enabled by default on certain machines, usually
4954 those which have no call-preserved registers to use instead.
4956 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4958 @item -ftree-pre
4959 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4960 enabled by default at @option{-O2} and @option{-O3}.
4962 @item -ftree-fre
4963 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4964 between FRE and PRE is that FRE only considers expressions
4965 that are computed on all paths leading to the redundant computation.
4966 This analysis faster than PRE, though it exposes fewer redundancies.
4967 This flag is enabled by default at @option{-O} and higher.
4969 @item -ftree-copy-prop
4970 Perform copy propagation on trees.  This pass eliminates unnecessary
4971 copy operations.  This flag is enabled by default at @option{-O} and
4972 higher.
4974 @item -ftree-store-copy-prop
4975 Perform copy propagation of memory loads and stores.  This pass
4976 eliminates unnecessary copy operations in memory references
4977 (structures, global variables, arrays, etc).  This flag is enabled by
4978 default at @option{-O2} and higher.
4980 @item -ftree-salias
4981 Perform structural alias analysis on trees.  This flag
4982 is enabled by default at @option{-O} and higher.
4984 @item -ftree-sink
4985 Perform forward store motion  on trees.  This flag is
4986 enabled by default at @option{-O} and higher.
4988 @item -ftree-ccp
4989 Perform sparse conditional constant propagation (CCP) on trees.  This
4990 pass only operates on local scalar variables and is enabled by default
4991 at @option{-O} and higher.
4993 @item -ftree-store-ccp
4994 Perform sparse conditional constant propagation (CCP) on trees.  This
4995 pass operates on both local scalar variables and memory stores and
4996 loads (global variables, structures, arrays, etc).  This flag is
4997 enabled by default at @option{-O2} and higher.
4999 @item -ftree-dce
5000 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5001 default at @option{-O} and higher.
5003 @item -ftree-dominator-opts
5004 Perform a variety of simple scalar cleanups (constant/copy
5005 propagation, redundancy elimination, range propagation and expression
5006 simplification) based on a dominator tree traversal.  This also
5007 performs jump threading (to reduce jumps to jumps). This flag is
5008 enabled by default at @option{-O} and higher.
5010 @item -ftree-ch
5011 Perform loop header copying on trees.  This is beneficial since it increases
5012 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5013 is enabled by default at @option{-O} and higher.  It is not enabled
5014 for @option{-Os}, since it usually increases code size.
5016 @item -ftree-loop-optimize
5017 Perform loop optimizations on trees.  This flag is enabled by default
5018 at @option{-O} and higher.
5020 @item -ftree-loop-linear
5021 Perform linear loop transformations on tree.  This flag can improve cache
5022 performance and allow further loop optimizations to take place.
5024 @item -ftree-loop-im
5025 Perform loop invariant motion on trees.  This pass moves only invariants that
5026 would be hard to handle at RTL level (function calls, operations that expand to
5027 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5028 operands of conditions that are invariant out of the loop, so that we can use
5029 just trivial invariantness analysis in loop unswitching.  The pass also includes
5030 store motion.
5032 @item -ftree-loop-ivcanon
5033 Create a canonical counter for number of iterations in the loop for that
5034 determining number of iterations requires complicated analysis.  Later
5035 optimizations then may determine the number easily.  Useful especially
5036 in connection with unrolling.
5038 @item -fivopts
5039 Perform induction variable optimizations (strength reduction, induction
5040 variable merging and induction variable elimination) on trees.
5042 @item -ftree-sra
5043 Perform scalar replacement of aggregates.  This pass replaces structure
5044 references with scalars to prevent committing structures to memory too
5045 early.  This flag is enabled by default at @option{-O} and higher.
5047 @item -ftree-copyrename
5048 Perform copy renaming on trees.  This pass attempts to rename compiler
5049 temporaries to other variables at copy locations, usually resulting in
5050 variable names which more closely resemble the original variables.  This flag
5051 is enabled by default at @option{-O} and higher.
5053 @item -ftree-ter
5054 Perform temporary expression replacement during the SSA->normal phase.  Single
5055 use/single def temporaries are replaced at their use location with their
5056 defining expression.  This results in non-GIMPLE code, but gives the expanders
5057 much more complex trees to work on resulting in better RTL generation.  This is
5058 enabled by default at @option{-O} and higher.
5060 @item -ftree-lrs
5061 Perform live range splitting during the SSA->normal phase.  Distinct live
5062 ranges of a variable are split into unique variables, allowing for better
5063 optimization later.  This is enabled by default at @option{-O} and higher.
5065 @item -ftree-vectorize
5066 Perform loop vectorization on trees.
5068 @item -ftree-vect-loop-version
5069 @opindex ftree-vect-loop-version
5070 Perform loop versioning when doing loop vectorization on trees.  When a loop
5071 appears to be vectorizable except that data alignment or data dependence cannot
5072 be determined at compile time then vectorized and non-vectorized versions of
5073 the loop are generated along with runtime checks for alignment or dependence
5074 to control which version is executed.  This option is enabled by default
5075 except at level @option{-Os} where it is disabled.
5077 @item -ftree-vrp
5078 Perform Value Range Propagation on trees.  This is similar to the
5079 constant propagation pass, but instead of values, ranges of values are
5080 propagated.  This allows the optimizers to remove unnecessary range
5081 checks like array bound checks and null pointer checks.  This is
5082 enabled by default at @option{-O2} and higher.  Null pointer check
5083 elimination is only done if @option{-fdelete-null-pointer-checks} is
5084 enabled.
5086 @item -ftracer
5087 @opindex ftracer
5088 Perform tail duplication to enlarge superblock size.  This transformation
5089 simplifies the control flow of the function allowing other optimizations to do
5090 better job.
5092 @item -funroll-loops
5093 @opindex funroll-loops
5094 Unroll loops whose number of iterations can be determined at compile
5095 time or upon entry to the loop.  @option{-funroll-loops} implies both
5096 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5097 option makes code larger, and may or may not make it run faster.
5099 @item -funroll-all-loops
5100 @opindex funroll-all-loops
5101 Unroll all loops, even if their number of iterations is uncertain when
5102 the loop is entered.  This usually makes programs run more slowly.
5103 @option{-funroll-all-loops} implies the same options as
5104 @option{-funroll-loops},
5106 @item -fsplit-ivs-in-unroller
5107 @opindex -fsplit-ivs-in-unroller
5108 Enables expressing of values of induction variables in later iterations
5109 of the unrolled loop using the value in the first iteration.  This breaks
5110 long dependency chains, thus improving efficiency of the scheduling passes.
5112 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5113 same effect.  However in cases the loop body is more complicated than
5114 a single basic block, this is not reliable.  It also does not work at all
5115 on some of the architectures due to restrictions in the CSE pass.
5117 This optimization is enabled by default.
5119 @item -fvariable-expansion-in-unroller
5120 @opindex -fvariable-expansion-in-unroller
5121 With this option, the compiler will create multiple copies of some
5122 local variables when unrolling a loop which can result in superior code.
5124 @item -fprefetch-loop-arrays
5125 @opindex fprefetch-loop-arrays
5126 If supported by the target machine, generate instructions to prefetch
5127 memory to improve the performance of loops that access large arrays.
5129 These options may generate better or worse code; results are highly
5130 dependent on the structure of loops within the source code.
5132 @item -fno-peephole
5133 @itemx -fno-peephole2
5134 @opindex fno-peephole
5135 @opindex fno-peephole2
5136 Disable any machine-specific peephole optimizations.  The difference
5137 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5138 are implemented in the compiler; some targets use one, some use the
5139 other, a few use both.
5141 @option{-fpeephole} is enabled by default.
5142 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5144 @item -fno-guess-branch-probability
5145 @opindex fno-guess-branch-probability
5146 Do not guess branch probabilities using heuristics.
5148 GCC will use heuristics to guess branch probabilities if they are
5149 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5150 heuristics are based on the control flow graph.  If some branch probabilities
5151 are specified by @samp{__builtin_expect}, then the heuristics will be
5152 used to guess branch probabilities for the rest of the control flow graph,
5153 taking the @samp{__builtin_expect} info into account.  The interactions
5154 between the heuristics and @samp{__builtin_expect} can be complex, and in
5155 some cases, it may be useful to disable the heuristics so that the effects
5156 of @samp{__builtin_expect} are easier to understand.
5158 The default is @option{-fguess-branch-probability} at levels
5159 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5161 @item -freorder-blocks
5162 @opindex freorder-blocks
5163 Reorder basic blocks in the compiled function in order to reduce number of
5164 taken branches and improve code locality.
5166 Enabled at levels @option{-O2}, @option{-O3}.
5168 @item -freorder-blocks-and-partition
5169 @opindex freorder-blocks-and-partition
5170 In addition to reordering basic blocks in the compiled function, in order
5171 to reduce number of taken branches, partitions hot and cold basic blocks
5172 into separate sections of the assembly and .o files, to improve
5173 paging and cache locality performance.
5175 This optimization is automatically turned off in the presence of
5176 exception handling, for linkonce sections, for functions with a user-defined
5177 section attribute and on any architecture that does not support named
5178 sections.
5180 @item -freorder-functions
5181 @opindex freorder-functions
5182 Reorder functions in the object file in order to
5183 improve code locality.  This is implemented by using special
5184 subsections @code{.text.hot} for most frequently executed functions and
5185 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5186 the linker so object file format must support named sections and linker must
5187 place them in a reasonable way.
5189 Also profile feedback must be available in to make this option effective.  See
5190 @option{-fprofile-arcs} for details.
5192 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5194 @item -fstrict-aliasing
5195 @opindex fstrict-aliasing
5196 Allows the compiler to assume the strictest aliasing rules applicable to
5197 the language being compiled.  For C (and C++), this activates
5198 optimizations based on the type of expressions.  In particular, an
5199 object of one type is assumed never to reside at the same address as an
5200 object of a different type, unless the types are almost the same.  For
5201 example, an @code{unsigned int} can alias an @code{int}, but not a
5202 @code{void*} or a @code{double}.  A character type may alias any other
5203 type.
5205 Pay special attention to code like this:
5206 @smallexample
5207 union a_union @{
5208   int i;
5209   double d;
5212 int f() @{
5213   a_union t;
5214   t.d = 3.0;
5215   return t.i;
5217 @end smallexample
5218 The practice of reading from a different union member than the one most
5219 recently written to (called ``type-punning'') is common.  Even with
5220 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5221 is accessed through the union type.  So, the code above will work as
5222 expected.  However, this code might not:
5223 @smallexample
5224 int f() @{
5225   a_union t;
5226   int* ip;
5227   t.d = 3.0;
5228   ip = &t.i;
5229   return *ip;
5231 @end smallexample
5233 Every language that wishes to perform language-specific alias analysis
5234 should define a function that computes, given an @code{tree}
5235 node, an alias set for the node.  Nodes in different alias sets are not
5236 allowed to alias.  For an example, see the C front-end function
5237 @code{c_get_alias_set}.
5239 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5241 @item -falign-functions
5242 @itemx -falign-functions=@var{n}
5243 @opindex falign-functions
5244 Align the start of functions to the next power-of-two greater than
5245 @var{n}, skipping up to @var{n} bytes.  For instance,
5246 @option{-falign-functions=32} aligns functions to the next 32-byte
5247 boundary, but @option{-falign-functions=24} would align to the next
5248 32-byte boundary only if this can be done by skipping 23 bytes or less.
5250 @option{-fno-align-functions} and @option{-falign-functions=1} are
5251 equivalent and mean that functions will not be aligned.
5253 Some assemblers only support this flag when @var{n} is a power of two;
5254 in that case, it is rounded up.
5256 If @var{n} is not specified or is zero, use a machine-dependent default.
5258 Enabled at levels @option{-O2}, @option{-O3}.
5260 @item -falign-labels
5261 @itemx -falign-labels=@var{n}
5262 @opindex falign-labels
5263 Align all branch targets to a power-of-two boundary, skipping up to
5264 @var{n} bytes like @option{-falign-functions}.  This option can easily
5265 make code slower, because it must insert dummy operations for when the
5266 branch target is reached in the usual flow of the code.
5268 @option{-fno-align-labels} and @option{-falign-labels=1} are
5269 equivalent and mean that labels will not be aligned.
5271 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5272 are greater than this value, then their values are used instead.
5274 If @var{n} is not specified or is zero, use a machine-dependent default
5275 which is very likely to be @samp{1}, meaning no alignment.
5277 Enabled at levels @option{-O2}, @option{-O3}.
5279 @item -falign-loops
5280 @itemx -falign-loops=@var{n}
5281 @opindex falign-loops
5282 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5283 like @option{-falign-functions}.  The hope is that the loop will be
5284 executed many times, which will make up for any execution of the dummy
5285 operations.
5287 @option{-fno-align-loops} and @option{-falign-loops=1} are
5288 equivalent and mean that loops will not be aligned.
5290 If @var{n} is not specified or is zero, use a machine-dependent default.
5292 Enabled at levels @option{-O2}, @option{-O3}.
5294 @item -falign-jumps
5295 @itemx -falign-jumps=@var{n}
5296 @opindex falign-jumps
5297 Align branch targets to a power-of-two boundary, for branch targets
5298 where the targets can only be reached by jumping, skipping up to @var{n}
5299 bytes like @option{-falign-functions}.  In this case, no dummy operations
5300 need be executed.
5302 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5303 equivalent and mean that loops will not be aligned.
5305 If @var{n} is not specified or is zero, use a machine-dependent default.
5307 Enabled at levels @option{-O2}, @option{-O3}.
5309 @item -funit-at-a-time
5310 @opindex funit-at-a-time
5311 Parse the whole compilation unit before starting to produce code.
5312 This allows some extra optimizations to take place but consumes
5313 more memory (in general).  There are some compatibility issues
5314 with @emph{unit-at-at-time} mode:
5315 @itemize @bullet
5316 @item
5317 enabling @emph{unit-at-a-time} mode may change the order
5318 in which functions, variables, and top-level @code{asm} statements
5319 are emitted, and will likely break code relying on some particular
5320 ordering.  The majority of such top-level @code{asm} statements,
5321 though, can be replaced by @code{section} attributes.
5323 @item
5324 @emph{unit-at-a-time} mode removes unreferenced static variables
5325 and functions.  This may result in undefined references
5326 when an @code{asm} statement refers directly to variables or functions
5327 that are otherwise unused.  In that case either the variable/function
5328 shall be listed as an operand of the @code{asm} statement operand or,
5329 in the case of top-level @code{asm} statements the attribute @code{used}
5330 shall be used on the declaration.
5332 @item
5333 Static functions now can use non-standard passing conventions that
5334 may break @code{asm} statements calling functions directly.  Again,
5335 attribute @code{used} will prevent this behavior.
5336 @end itemize
5338 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5339 but this scheme may not be supported by future releases of GCC@.
5341 Enabled at levels @option{-O2}, @option{-O3}.
5343 @item -fweb
5344 @opindex fweb
5345 Constructs webs as commonly used for register allocation purposes and assign
5346 each web individual pseudo register.  This allows the register allocation pass
5347 to operate on pseudos directly, but also strengthens several other optimization
5348 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5349 however, make debugging impossible, since variables will no longer stay in a
5350 ``home register''.
5352 Enabled by default with @option{-funroll-loops}.
5354 @item -fwhole-program
5355 @opindex fwhole-program
5356 Assume that the current compilation unit represents whole program being
5357 compiled.  All public functions and variables with the exception of @code{main}
5358 and those merged by attribute @code{externally_visible} become static functions
5359 and in a affect gets more aggressively optimized by interprocedural optimizers.
5360 While this option is equivalent to proper use of @code{static} keyword for
5361 programs consisting of single file, in combination with option
5362 @option{--combine} this flag can be used to compile most of smaller scale C
5363 programs since the functions and variables become local for the whole combined
5364 compilation unit, not for the single source file itself.
5367 @item -fno-cprop-registers
5368 @opindex fno-cprop-registers
5369 After register allocation and post-register allocation instruction splitting,
5370 we perform a copy-propagation pass to try to reduce scheduling dependencies
5371 and occasionally eliminate the copy.
5373 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5375 @item -fprofile-generate
5376 @opindex fprofile-generate
5378 Enable options usually used for instrumenting application to produce
5379 profile useful for later recompilation with profile feedback based
5380 optimization.  You must use @option{-fprofile-generate} both when
5381 compiling and when linking your program.
5383 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5385 @item -fprofile-use
5386 @opindex fprofile-use
5387 Enable profile feedback directed optimizations, and optimizations
5388 generally profitable only with profile feedback available.
5390 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5391 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5392 @code{-fno-loop-optimize}.
5394 @end table
5396 The following options control compiler behavior regarding floating
5397 point arithmetic.  These options trade off between speed and
5398 correctness.  All must be specifically enabled.
5400 @table @gcctabopt
5401 @item -ffloat-store
5402 @opindex ffloat-store
5403 Do not store floating point variables in registers, and inhibit other
5404 options that might change whether a floating point value is taken from a
5405 register or memory.
5407 @cindex floating point precision
5408 This option prevents undesirable excess precision on machines such as
5409 the 68000 where the floating registers (of the 68881) keep more
5410 precision than a @code{double} is supposed to have.  Similarly for the
5411 x86 architecture.  For most programs, the excess precision does only
5412 good, but a few programs rely on the precise definition of IEEE floating
5413 point.  Use @option{-ffloat-store} for such programs, after modifying
5414 them to store all pertinent intermediate computations into variables.
5416 @item -ffast-math
5417 @opindex ffast-math
5418 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5419 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5420 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5421 and @option{fcx-limited-range}.
5423 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5425 This option should never be turned on by any @option{-O} option since
5426 it can result in incorrect output for programs which depend on
5427 an exact implementation of IEEE or ISO rules/specifications for
5428 math functions.
5430 @item -fno-math-errno
5431 @opindex fno-math-errno
5432 Do not set ERRNO after calling math functions that are executed
5433 with a single instruction, e.g., sqrt.  A program that relies on
5434 IEEE exceptions for math error handling may want to use this flag
5435 for speed while maintaining IEEE arithmetic compatibility.
5437 This option should never be turned on by any @option{-O} option since
5438 it can result in incorrect output for programs which depend on
5439 an exact implementation of IEEE or ISO rules/specifications for
5440 math functions.
5442 The default is @option{-fmath-errno}.
5444 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5445 no reason for the compiler to consider the possibility that it might,
5446 and @option{-fno-math-errno} is the default.
5448 @item -funsafe-math-optimizations
5449 @opindex funsafe-math-optimizations
5450 Allow optimizations for floating-point arithmetic that (a) assume
5451 that arguments and results are valid and (b) may violate IEEE or
5452 ANSI standards.  When used at link-time, it may include libraries
5453 or startup files that change the default FPU control word or other
5454 similar optimizations.
5456 This option should never be turned on by any @option{-O} option since
5457 it can result in incorrect output for programs which depend on
5458 an exact implementation of IEEE or ISO rules/specifications for
5459 math functions.
5461 The default is @option{-fno-unsafe-math-optimizations}.
5463 @item -ffinite-math-only
5464 @opindex ffinite-math-only
5465 Allow optimizations for floating-point arithmetic that assume
5466 that arguments and results are not NaNs or +-Infs.
5468 This option should never be turned on by any @option{-O} option since
5469 it can result in incorrect output for programs which depend on
5470 an exact implementation of IEEE or ISO rules/specifications.
5472 The default is @option{-fno-finite-math-only}.
5474 @item -fno-trapping-math
5475 @opindex fno-trapping-math
5476 Compile code assuming that floating-point operations cannot generate
5477 user-visible traps.  These traps include division by zero, overflow,
5478 underflow, inexact result and invalid operation.  This option implies
5479 @option{-fno-signaling-nans}.  Setting this option may allow faster
5480 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5482 This option should never be turned on by any @option{-O} option since
5483 it can result in incorrect output for programs which depend on
5484 an exact implementation of IEEE or ISO rules/specifications for
5485 math functions.
5487 The default is @option{-ftrapping-math}.
5489 @item -frounding-math
5490 @opindex frounding-math
5491 Disable transformations and optimizations that assume default floating
5492 point rounding behavior.  This is round-to-zero for all floating point
5493 to integer conversions, and round-to-nearest for all other arithmetic
5494 truncations.  This option should be specified for programs that change
5495 the FP rounding mode dynamically, or that may be executed with a
5496 non-default rounding mode.  This option disables constant folding of
5497 floating point expressions at compile-time (which may be affected by
5498 rounding mode) and arithmetic transformations that are unsafe in the
5499 presence of sign-dependent rounding modes.
5501 The default is @option{-fno-rounding-math}.
5503 This option is experimental and does not currently guarantee to
5504 disable all GCC optimizations that are affected by rounding mode.
5505 Future versions of GCC may provide finer control of this setting
5506 using C99's @code{FENV_ACCESS} pragma.  This command line option
5507 will be used to specify the default state for @code{FENV_ACCESS}.
5509 @item -fsignaling-nans
5510 @opindex fsignaling-nans
5511 Compile code assuming that IEEE signaling NaNs may generate user-visible
5512 traps during floating-point operations.  Setting this option disables
5513 optimizations that may change the number of exceptions visible with
5514 signaling NaNs.  This option implies @option{-ftrapping-math}.
5516 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5517 be defined.
5519 The default is @option{-fno-signaling-nans}.
5521 This option is experimental and does not currently guarantee to
5522 disable all GCC optimizations that affect signaling NaN behavior.
5524 @item -fsingle-precision-constant
5525 @opindex fsingle-precision-constant
5526 Treat floating point constant as single precision constant instead of
5527 implicitly converting it to double precision constant.
5529 @item -fcx-limited-range
5530 @itemx -fno-cx-limited-range
5531 @opindex fcx-limited-range
5532 @opindex fno-cx-limited-range
5533 When enabled, this option states that a range reduction step is not
5534 needed when performing complex division.  The default is
5535 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5537 This option controls the default setting of the ISO C99 
5538 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5539 all languages.
5541 @end table
5543 The following options control optimizations that may improve
5544 performance, but are not enabled by any @option{-O} options.  This
5545 section includes experimental options that may produce broken code.
5547 @table @gcctabopt
5548 @item -fbranch-probabilities
5549 @opindex fbranch-probabilities
5550 After running a program compiled with @option{-fprofile-arcs}
5551 (@pxref{Debugging Options,, Options for Debugging Your Program or
5552 @command{gcc}}), you can compile it a second time using
5553 @option{-fbranch-probabilities}, to improve optimizations based on
5554 the number of times each branch was taken.  When the program
5555 compiled with @option{-fprofile-arcs} exits it saves arc execution
5556 counts to a file called @file{@var{sourcename}.gcda} for each source
5557 file  The information in this data file is very dependent on the
5558 structure of the generated code, so you must use the same source code
5559 and the same optimization options for both compilations.
5561 With @option{-fbranch-probabilities}, GCC puts a
5562 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5563 These can be used to improve optimization.  Currently, they are only
5564 used in one place: in @file{reorg.c}, instead of guessing which path a
5565 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5566 exactly determine which path is taken more often.
5568 @item -fprofile-values
5569 @opindex fprofile-values
5570 If combined with @option{-fprofile-arcs}, it adds code so that some
5571 data about values of expressions in the program is gathered.
5573 With @option{-fbranch-probabilities}, it reads back the data gathered
5574 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5575 notes to instructions for their later usage in optimizations.
5577 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5579 @item -fvpt
5580 @opindex fvpt
5581 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5582 a code to gather information about values of expressions.
5584 With @option{-fbranch-probabilities}, it reads back the data gathered
5585 and actually performs the optimizations based on them.
5586 Currently the optimizations include specialization of division operation
5587 using the knowledge about the value of the denominator.
5589 @item -frename-registers
5590 @opindex frename-registers
5591 Attempt to avoid false dependencies in scheduled code by making use
5592 of registers left over after register allocation.  This optimization
5593 will most benefit processors with lots of registers.  Depending on the
5594 debug information format adopted by the target, however, it can
5595 make debugging impossible, since variables will no longer stay in
5596 a ``home register''.
5598 Enabled by default with @option{-funroll-loops}.
5600 @item -ftracer
5601 @opindex ftracer
5602 Perform tail duplication to enlarge superblock size.  This transformation
5603 simplifies the control flow of the function allowing other optimizations to do
5604 better job.
5606 Enabled with @option{-fprofile-use}.
5608 @item -funroll-loops
5609 @opindex funroll-loops
5610 Unroll loops whose number of iterations can be determined at compile time or
5611 upon entry to the loop.  @option{-funroll-loops} implies
5612 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5613 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5614 small constant number of iterations).  This option makes code larger, and may
5615 or may not make it run faster.
5617 Enabled with @option{-fprofile-use}.
5619 @item -funroll-all-loops
5620 @opindex funroll-all-loops
5621 Unroll all loops, even if their number of iterations is uncertain when
5622 the loop is entered.  This usually makes programs run more slowly.
5623 @option{-funroll-all-loops} implies the same options as
5624 @option{-funroll-loops}.
5626 @item -fpeel-loops
5627 @opindex fpeel-loops
5628 Peels the loops for that there is enough information that they do not
5629 roll much (from profile feedback).  It also turns on complete loop peeling
5630 (i.e.@: complete removal of loops with small constant number of iterations).
5632 Enabled with @option{-fprofile-use}.
5634 @item -fmove-loop-invariants
5635 @opindex fmove-loop-invariants
5636 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5637 at level @option{-O1}
5639 @item -funswitch-loops
5640 @opindex funswitch-loops
5641 Move branches with loop invariant conditions out of the loop, with duplicates
5642 of the loop on both branches (modified according to result of the condition).
5644 @item -fprefetch-loop-arrays
5645 @opindex fprefetch-loop-arrays
5646 If supported by the target machine, generate instructions to prefetch
5647 memory to improve the performance of loops that access large arrays.
5649 Disabled at level @option{-Os}.
5651 @item -ffunction-sections
5652 @itemx -fdata-sections
5653 @opindex ffunction-sections
5654 @opindex fdata-sections
5655 Place each function or data item into its own section in the output
5656 file if the target supports arbitrary sections.  The name of the
5657 function or the name of the data item determines the section's name
5658 in the output file.
5660 Use these options on systems where the linker can perform optimizations
5661 to improve locality of reference in the instruction space.  Most systems
5662 using the ELF object format and SPARC processors running Solaris 2 have
5663 linkers with such optimizations.  AIX may have these optimizations in
5664 the future.
5666 Only use these options when there are significant benefits from doing
5667 so.  When you specify these options, the assembler and linker will
5668 create larger object and executable files and will also be slower.
5669 You will not be able to use @code{gprof} on all systems if you
5670 specify this option and you may have problems with debugging if
5671 you specify both this option and @option{-g}.
5673 @item -fbranch-target-load-optimize
5674 @opindex fbranch-target-load-optimize
5675 Perform branch target register load optimization before prologue / epilogue
5676 threading.
5677 The use of target registers can typically be exposed only during reload,
5678 thus hoisting loads out of loops and doing inter-block scheduling needs
5679 a separate optimization pass.
5681 @item -fbranch-target-load-optimize2
5682 @opindex fbranch-target-load-optimize2
5683 Perform branch target register load optimization after prologue / epilogue
5684 threading.
5686 @item -fbtr-bb-exclusive
5687 @opindex fbtr-bb-exclusive
5688 When performing branch target register load optimization, don't reuse
5689 branch target registers in within any basic block.
5691 @item -fstack-protector
5692 Emit extra code to check for buffer overflows, such as stack smashing
5693 attacks.  This is done by adding a guard variable to functions with
5694 vulnerable objects.  This includes functions that call alloca, and
5695 functions with buffers larger than 8 bytes.  The guards are initialized
5696 when a function is entered and then checked when the function exits.
5697 If a guard check fails, an error message is printed and the program exits.
5699 @item -fstack-protector-all
5700 Like @option{-fstack-protector} except that all functions are protected.
5702 @item --param @var{name}=@var{value}
5703 @opindex param
5704 In some places, GCC uses various constants to control the amount of
5705 optimization that is done.  For example, GCC will not inline functions
5706 that contain more that a certain number of instructions.  You can
5707 control some of these constants on the command-line using the
5708 @option{--param} option.
5710 The names of specific parameters, and the meaning of the values, are
5711 tied to the internals of the compiler, and are subject to change
5712 without notice in future releases.
5714 In each case, the @var{value} is an integer.  The allowable choices for
5715 @var{name} are given in the following table:
5717 @table @gcctabopt
5718 @item salias-max-implicit-fields
5719 The maximum number of fields in a variable without direct
5720 structure accesses for which structure aliasing will consider trying 
5721 to track each field.  The default is 5
5723 @item sra-max-structure-size
5724 The maximum structure size, in bytes, at which the scalar replacement
5725 of aggregates (SRA) optimization will perform block copies.  The
5726 default value, 0, implies that GCC will select the most appropriate
5727 size itself.
5729 @item sra-field-structure-ratio
5730 The threshold ratio (as a percentage) between instantiated fields and
5731 the complete structure size.  We say that if the ratio of the number
5732 of bytes in instantiated fields to the number of bytes in the complete
5733 structure exceeds this parameter, then block copies are not used.  The
5734 default is 75.
5736 @item max-crossjump-edges
5737 The maximum number of incoming edges to consider for crossjumping.
5738 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5739 the number of edges incoming to each block.  Increasing values mean
5740 more aggressive optimization, making the compile time increase with
5741 probably small improvement in executable size.
5743 @item min-crossjump-insns
5744 The minimum number of instructions which must be matched at the end
5745 of two blocks before crossjumping will be performed on them.  This
5746 value is ignored in the case where all instructions in the block being
5747 crossjumped from are matched.  The default value is 5.
5749 @item max-grow-copy-bb-insns
5750 The maximum code size expansion factor when copying basic blocks
5751 instead of jumping.  The expansion is relative to a jump instruction.
5752 The default value is 8.
5754 @item max-goto-duplication-insns
5755 The maximum number of instructions to duplicate to a block that jumps
5756 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5757 passes, GCC factors computed gotos early in the compilation process,
5758 and unfactors them as late as possible.  Only computed jumps at the
5759 end of a basic blocks with no more than max-goto-duplication-insns are
5760 unfactored.  The default value is 8.
5762 @item max-delay-slot-insn-search
5763 The maximum number of instructions to consider when looking for an
5764 instruction to fill a delay slot.  If more than this arbitrary number of
5765 instructions is searched, the time savings from filling the delay slot
5766 will be minimal so stop searching.  Increasing values mean more
5767 aggressive optimization, making the compile time increase with probably
5768 small improvement in executable run time.
5770 @item max-delay-slot-live-search
5771 When trying to fill delay slots, the maximum number of instructions to
5772 consider when searching for a block with valid live register
5773 information.  Increasing this arbitrarily chosen value means more
5774 aggressive optimization, increasing the compile time.  This parameter
5775 should be removed when the delay slot code is rewritten to maintain the
5776 control-flow graph.
5778 @item max-gcse-memory
5779 The approximate maximum amount of memory that will be allocated in
5780 order to perform the global common subexpression elimination
5781 optimization.  If more memory than specified is required, the
5782 optimization will not be done.
5784 @item max-gcse-passes
5785 The maximum number of passes of GCSE to run.  The default is 1.
5787 @item max-pending-list-length
5788 The maximum number of pending dependencies scheduling will allow
5789 before flushing the current state and starting over.  Large functions
5790 with few branches or calls can create excessively large lists which
5791 needlessly consume memory and resources.
5793 @item max-inline-insns-single
5794 Several parameters control the tree inliner used in gcc.
5795 This number sets the maximum number of instructions (counted in GCC's
5796 internal representation) in a single function that the tree inliner
5797 will consider for inlining.  This only affects functions declared
5798 inline and methods implemented in a class declaration (C++).
5799 The default value is 450.
5801 @item max-inline-insns-auto
5802 When you use @option{-finline-functions} (included in @option{-O3}),
5803 a lot of functions that would otherwise not be considered for inlining
5804 by the compiler will be investigated.  To those functions, a different
5805 (more restrictive) limit compared to functions declared inline can
5806 be applied.
5807 The default value is 90.
5809 @item large-function-insns
5810 The limit specifying really large functions.  For functions larger than this
5811 limit after inlining inlining is constrained by
5812 @option{--param large-function-growth}.  This parameter is useful primarily
5813 to avoid extreme compilation time caused by non-linear algorithms used by the
5814 backend.
5815 This parameter is ignored when @option{-funit-at-a-time} is not used.
5816 The default value is 2700.
5818 @item large-function-growth
5819 Specifies maximal growth of large function caused by inlining in percents.
5820 This parameter is ignored when @option{-funit-at-a-time} is not used.
5821 The default value is 100 which limits large function growth to 2.0 times
5822 the original size.
5824 @item large-unit-insns
5825 The limit specifying large translation unit.  Growth caused by inlining of
5826 units larger than this limit is limited by @option{--param inline-unit-growth}.
5827 For small units this might be too tight (consider unit consisting of function A
5828 that is inline and B that just calls A three time.  If B is small relative to
5829 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5830 large units consisting of small inlininable functions however the overall unit
5831 growth limit is needed to avoid exponential explosion of code size.  Thus for
5832 smaller units, the size is increased to @option{--param large-unit-insns}
5833 before aplying @option{--param inline-unit-growth}.  The default is 10000
5835 @item inline-unit-growth
5836 Specifies maximal overall growth of the compilation unit caused by inlining.
5837 This parameter is ignored when @option{-funit-at-a-time} is not used.
5838 The default value is 50 which limits unit growth to 1.5 times the original
5839 size.
5841 @item max-inline-insns-recursive
5842 @itemx max-inline-insns-recursive-auto
5843 Specifies maximum number of instructions out-of-line copy of self recursive inline
5844 function can grow into by performing recursive inlining.
5846 For functions declared inline @option{--param max-inline-insns-recursive} is
5847 taken into acount.  For function not declared inline, recursive inlining
5848 happens only when @option{-finline-functions} (included in @option{-O3}) is
5849 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5850 default value is 450.
5852 @item max-inline-recursive-depth
5853 @itemx max-inline-recursive-depth-auto
5854 Specifies maximum recursion depth used by the recursive inlining.
5856 For functions declared inline @option{--param max-inline-recursive-depth} is
5857 taken into acount.  For function not declared inline, recursive inlining
5858 happens only when @option{-finline-functions} (included in @option{-O3}) is
5859 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5860 default value is 450.
5862 @item min-inline-recursive-probability
5863 Recursive inlining is profitable only for function having deep recursion
5864 in average and can hurt for function having little recursion depth by
5865 increasing the prologue size or complexity of function body to other
5866 optimizers.
5868 When profile feedback is available (see @option{-fprofile-generate}) the actual
5869 recursion depth can be guessed from probability that function will recurse via
5870 given call expression.  This parameter limits inlining only to call expression
5871 whose probability exceeds given threshold (in percents).  The default value is
5874 @item inline-call-cost
5875 Specify cost of call instruction relative to simple arithmetics operations
5876 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5877 functions and at the same time increases size of leaf function that is believed to
5878 reduce function size by being inlined.  In effect it increases amount of
5879 inlining for code having large abstraction penalty (many functions that just
5880 pass the arguments to other functions) and decrease inlining for code with low
5881 abstraction penalty.  The default value is 16.
5883 @item max-unrolled-insns
5884 The maximum number of instructions that a loop should have if that loop
5885 is unrolled, and if the loop is unrolled, it determines how many times
5886 the loop code is unrolled.
5888 @item max-average-unrolled-insns
5889 The maximum number of instructions biased by probabilities of their execution
5890 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5891 it determines how many times the loop code is unrolled.
5893 @item max-unroll-times
5894 The maximum number of unrollings of a single loop.
5896 @item max-peeled-insns
5897 The maximum number of instructions that a loop should have if that loop
5898 is peeled, and if the loop is peeled, it determines how many times
5899 the loop code is peeled.
5901 @item max-peel-times
5902 The maximum number of peelings of a single loop.
5904 @item max-completely-peeled-insns
5905 The maximum number of insns of a completely peeled loop.
5907 @item max-completely-peel-times
5908 The maximum number of iterations of a loop to be suitable for complete peeling.
5910 @item max-unswitch-insns
5911 The maximum number of insns of an unswitched loop.
5913 @item max-unswitch-level
5914 The maximum number of branches unswitched in a single loop.
5916 @item lim-expensive
5917 The minimum cost of an expensive expression in the loop invariant motion.
5919 @item iv-consider-all-candidates-bound
5920 Bound on number of candidates for induction variables below that
5921 all candidates are considered for each use in induction variable
5922 optimizations.  Only the most relevant candidates are considered
5923 if there are more candidates, to avoid quadratic time complexity.
5925 @item iv-max-considered-uses
5926 The induction variable optimizations give up on loops that contain more
5927 induction variable uses.
5929 @item iv-always-prune-cand-set-bound
5930 If number of candidates in the set is smaller than this value,
5931 we always try to remove unnecessary ivs from the set during its
5932 optimization when a new iv is added to the set.
5934 @item scev-max-expr-size
5935 Bound on size of expressions used in the scalar evolutions analyzer.
5936 Large expressions slow the analyzer.
5938 @item vect-max-version-checks
5939 The maximum number of runtime checks that can be performed when doing
5940 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5941 for more information.
5943 @item max-iterations-to-track
5945 The maximum number of iterations of a loop the brute force algorithm
5946 for analysis of # of iterations of the loop tries to evaluate.
5948 @item hot-bb-count-fraction
5949 Select fraction of the maximal count of repetitions of basic block in program
5950 given basic block needs to have to be considered hot.
5952 @item hot-bb-frequency-fraction
5953 Select fraction of the maximal frequency of executions of basic block in
5954 function given basic block needs to have to be considered hot
5956 @item max-predicted-iterations
5957 The maximum number of loop iterations we predict statically.  This is useful
5958 in cases where function contain single loop with known bound and other loop
5959 with unknown.  We predict the known number of iterations correctly, while
5960 the unknown number of iterations average to roughly 10.  This means that the
5961 loop without bounds would appear artificially cold relative to the other one.
5963 @item tracer-dynamic-coverage
5964 @itemx tracer-dynamic-coverage-feedback
5966 This value is used to limit superblock formation once the given percentage of
5967 executed instructions is covered.  This limits unnecessary code size
5968 expansion.
5970 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5971 feedback is available.  The real profiles (as opposed to statically estimated
5972 ones) are much less balanced allowing the threshold to be larger value.
5974 @item tracer-max-code-growth
5975 Stop tail duplication once code growth has reached given percentage.  This is
5976 rather hokey argument, as most of the duplicates will be eliminated later in
5977 cross jumping, so it may be set to much higher values than is the desired code
5978 growth.
5980 @item tracer-min-branch-ratio
5982 Stop reverse growth when the reverse probability of best edge is less than this
5983 threshold (in percent).
5985 @item tracer-min-branch-ratio
5986 @itemx tracer-min-branch-ratio-feedback
5988 Stop forward growth if the best edge do have probability lower than this
5989 threshold.
5991 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5992 compilation for profile feedback and one for compilation without.  The value
5993 for compilation with profile feedback needs to be more conservative (higher) in
5994 order to make tracer effective.
5996 @item max-cse-path-length
5998 Maximum number of basic blocks on path that cse considers.  The default is 10.
6000 @item max-cse-insns
6001 The maximum instructions CSE process before flushing. The default is 1000.
6003 @item global-var-threshold
6005 Counts the number of function calls (@var{n}) and the number of
6006 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6007 single artificial variable will be created to represent all the
6008 call-clobbered variables at function call sites.  This artificial
6009 variable will then be made to alias every call-clobbered variable.
6010 (done as @code{int * size_t} on the host machine; beware overflow).
6012 @item max-aliased-vops
6014 Maximum number of virtual operands allowed to represent aliases
6015 before triggering the alias grouping heuristic.  Alias grouping
6016 reduces compile times and memory consumption needed for aliasing at
6017 the expense of precision loss in alias information.
6019 @item ggc-min-expand
6021 GCC uses a garbage collector to manage its own memory allocation.  This
6022 parameter specifies the minimum percentage by which the garbage
6023 collector's heap should be allowed to expand between collections.
6024 Tuning this may improve compilation speed; it has no effect on code
6025 generation.
6027 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6028 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6029 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6030 GCC is not able to calculate RAM on a particular platform, the lower
6031 bound of 30% is used.  Setting this parameter and
6032 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6033 every opportunity.  This is extremely slow, but can be useful for
6034 debugging.
6036 @item ggc-min-heapsize
6038 Minimum size of the garbage collector's heap before it begins bothering
6039 to collect garbage.  The first collection occurs after the heap expands
6040 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6041 tuning this may improve compilation speed, and has no effect on code
6042 generation.
6044 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6045 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6046 with a lower bound of 4096 (four megabytes) and an upper bound of
6047 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6048 particular platform, the lower bound is used.  Setting this parameter
6049 very large effectively disables garbage collection.  Setting this
6050 parameter and @option{ggc-min-expand} to zero causes a full collection
6051 to occur at every opportunity.
6053 @item max-reload-search-insns
6054 The maximum number of instruction reload should look backward for equivalent
6055 register.  Increasing values mean more aggressive optimization, making the
6056 compile time increase with probably slightly better performance.  The default
6057 value is 100.
6059 @item max-cselib-memory-location
6060 The maximum number of memory locations cselib should take into acount.
6061 Increasing values mean more aggressive optimization, making the compile time
6062 increase with probably slightly better performance.  The default value is 500.
6064 @item max-flow-memory-location
6065 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6066 The default value is 100.
6068 @item reorder-blocks-duplicate
6069 @itemx reorder-blocks-duplicate-feedback
6071 Used by basic block reordering pass to decide whether to use unconditional
6072 branch or duplicate the code on its destination.  Code is duplicated when its
6073 estimated size is smaller than this value multiplied by the estimated size of
6074 unconditional jump in the hot spots of the program.
6076 The @option{reorder-block-duplicate-feedback} is used only when profile
6077 feedback is available and may be set to higher values than
6078 @option{reorder-block-duplicate} since information about the hot spots is more
6079 accurate.
6081 @item max-sched-region-blocks
6082 The maximum number of blocks in a region to be considered for
6083 interblock scheduling.  The default value is 10.
6085 @item max-sched-region-insns
6086 The maximum number of insns in a region to be considered for
6087 interblock scheduling.  The default value is 100.
6089 @item min-sched-prob
6090 The minimum probability of reaching a source block for interblock
6091 speculative scheduling.  The default value is 40.
6093 @item max-last-value-rtl
6095 The maximum size measured as number of RTLs that can be recorded in an expression
6096 in combiner for a pseudo register as last known value of that register.  The default
6097 is 10000.
6099 @item integer-share-limit
6100 Small integer constants can use a shared data structure, reducing the
6101 compiler's memory usage and increasing its speed.  This sets the maximum
6102 value of a shared integer constant's.  The default value is 256.
6104 @item min-virtual-mappings
6105 Specifies the minimum number of virtual mappings in the incremental
6106 SSA updater that should be registered to trigger the virtual mappings
6107 heuristic defined by virtual-mappings-ratio.  The default value is
6108 100.
6110 @item virtual-mappings-ratio
6111 If the number of virtual mappings is virtual-mappings-ratio bigger
6112 than the number of virtual symbols to be updated, then the incremental
6113 SSA updater switches to a full update for those symbols.  The default
6114 ratio is 3.
6116 @item ssp-buffer-size
6117 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6118 protection when @option{-fstack-protection} is used.
6120 @item max-jump-thread-duplication-stmts
6121 Maximum number of statements allowed in a block that needs to be
6122 duplicated when threading jumps.
6123 @end table
6124 @end table
6126 @node Preprocessor Options
6127 @section Options Controlling the Preprocessor
6128 @cindex preprocessor options
6129 @cindex options, preprocessor
6131 These options control the C preprocessor, which is run on each C source
6132 file before actual compilation.
6134 If you use the @option{-E} option, nothing is done except preprocessing.
6135 Some of these options make sense only together with @option{-E} because
6136 they cause the preprocessor output to be unsuitable for actual
6137 compilation.
6139 @table @gcctabopt
6140 @opindex Wp
6141 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6142 and pass @var{option} directly through to the preprocessor.  If
6143 @var{option} contains commas, it is split into multiple options at the
6144 commas.  However, many options are modified, translated or interpreted
6145 by the compiler driver before being passed to the preprocessor, and
6146 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6147 interface is undocumented and subject to change, so whenever possible
6148 you should avoid using @option{-Wp} and let the driver handle the
6149 options instead.
6151 @item -Xpreprocessor @var{option}
6152 @opindex preprocessor
6153 Pass @var{option} as an option to the preprocessor.  You can use this to
6154 supply system-specific preprocessor options which GCC does not know how to
6155 recognize.
6157 If you want to pass an option that takes an argument, you must use
6158 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6159 @end table
6161 @include cppopts.texi
6163 @node Assembler Options
6164 @section Passing Options to the Assembler
6166 @c prevent bad page break with this line
6167 You can pass options to the assembler.
6169 @table @gcctabopt
6170 @item -Wa,@var{option}
6171 @opindex Wa
6172 Pass @var{option} as an option to the assembler.  If @var{option}
6173 contains commas, it is split into multiple options at the commas.
6175 @item -Xassembler @var{option}
6176 @opindex Xassembler
6177 Pass @var{option} as an option to the assembler.  You can use this to
6178 supply system-specific assembler options which GCC does not know how to
6179 recognize.
6181 If you want to pass an option that takes an argument, you must use
6182 @option{-Xassembler} twice, once for the option and once for the argument.
6184 @end table
6186 @node Link Options
6187 @section Options for Linking
6188 @cindex link options
6189 @cindex options, linking
6191 These options come into play when the compiler links object files into
6192 an executable output file.  They are meaningless if the compiler is
6193 not doing a link step.
6195 @table @gcctabopt
6196 @cindex file names
6197 @item @var{object-file-name}
6198 A file name that does not end in a special recognized suffix is
6199 considered to name an object file or library.  (Object files are
6200 distinguished from libraries by the linker according to the file
6201 contents.)  If linking is done, these object files are used as input
6202 to the linker.
6204 @item -c
6205 @itemx -S
6206 @itemx -E
6207 @opindex c
6208 @opindex S
6209 @opindex E
6210 If any of these options is used, then the linker is not run, and
6211 object file names should not be used as arguments.  @xref{Overall
6212 Options}.
6214 @cindex Libraries
6215 @item -l@var{library}
6216 @itemx -l @var{library}
6217 @opindex l
6218 Search the library named @var{library} when linking.  (The second
6219 alternative with the library as a separate argument is only for
6220 POSIX compliance and is not recommended.)
6222 It makes a difference where in the command you write this option; the
6223 linker searches and processes libraries and object files in the order they
6224 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6225 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6226 to functions in @samp{z}, those functions may not be loaded.
6228 The linker searches a standard list of directories for the library,
6229 which is actually a file named @file{lib@var{library}.a}.  The linker
6230 then uses this file as if it had been specified precisely by name.
6232 The directories searched include several standard system directories
6233 plus any that you specify with @option{-L}.
6235 Normally the files found this way are library files---archive files
6236 whose members are object files.  The linker handles an archive file by
6237 scanning through it for members which define symbols that have so far
6238 been referenced but not defined.  But if the file that is found is an
6239 ordinary object file, it is linked in the usual fashion.  The only
6240 difference between using an @option{-l} option and specifying a file name
6241 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6242 and searches several directories.
6244 @item -lobjc
6245 @opindex lobjc
6246 You need this special case of the @option{-l} option in order to
6247 link an Objective-C or Objective-C++ program.
6249 @item -nostartfiles
6250 @opindex nostartfiles
6251 Do not use the standard system startup files when linking.
6252 The standard system libraries are used normally, unless @option{-nostdlib}
6253 or @option{-nodefaultlibs} is used.
6255 @item -nodefaultlibs
6256 @opindex nodefaultlibs
6257 Do not use the standard system libraries when linking.
6258 Only the libraries you specify will be passed to the linker.
6259 The standard startup files are used normally, unless @option{-nostartfiles}
6260 is used.  The compiler may generate calls to @code{memcmp},
6261 @code{memset}, @code{memcpy} and @code{memmove}.
6262 These entries are usually resolved by entries in
6263 libc.  These entry points should be supplied through some other
6264 mechanism when this option is specified.
6266 @item -nostdlib
6267 @opindex nostdlib
6268 Do not use the standard system startup files or libraries when linking.
6269 No startup files and only the libraries you specify will be passed to
6270 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6271 @code{memcpy} and @code{memmove}.
6272 These entries are usually resolved by entries in
6273 libc.  These entry points should be supplied through some other
6274 mechanism when this option is specified.
6276 @cindex @option{-lgcc}, use with @option{-nostdlib}
6277 @cindex @option{-nostdlib} and unresolved references
6278 @cindex unresolved references and @option{-nostdlib}
6279 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6280 @cindex @option{-nodefaultlibs} and unresolved references
6281 @cindex unresolved references and @option{-nodefaultlibs}
6282 One of the standard libraries bypassed by @option{-nostdlib} and
6283 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6284 that GCC uses to overcome shortcomings of particular machines, or special
6285 needs for some languages.
6286 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6287 Collection (GCC) Internals},
6288 for more discussion of @file{libgcc.a}.)
6289 In most cases, you need @file{libgcc.a} even when you want to avoid
6290 other standard libraries.  In other words, when you specify @option{-nostdlib}
6291 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6292 This ensures that you have no unresolved references to internal GCC
6293 library subroutines.  (For example, @samp{__main}, used to ensure C++
6294 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6295 GNU Compiler Collection (GCC) Internals}.)
6297 @item -pie
6298 @opindex pie
6299 Produce a position independent executable on targets which support it.
6300 For predictable results, you must also specify the same set of options
6301 that were used to generate code (@option{-fpie}, @option{-fPIE},
6302 or model suboptions) when you specify this option.
6304 @item -rdynamic
6305 @opindex rdynamic
6306 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6307 that support it. This instructs the linker to add all symbols, not
6308 only used ones, to the dynamic symbol table. This option is needed
6309 for some uses of @code{dlopen} or to allow obtaining backtraces
6310 from within a program.
6312 @item -s
6313 @opindex s
6314 Remove all symbol table and relocation information from the executable.
6316 @item -static
6317 @opindex static
6318 On systems that support dynamic linking, this prevents linking with the shared
6319 libraries.  On other systems, this option has no effect.
6321 @item -shared
6322 @opindex shared
6323 Produce a shared object which can then be linked with other objects to
6324 form an executable.  Not all systems support this option.  For predictable
6325 results, you must also specify the same set of options that were used to
6326 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6327 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6328 needs to build supplementary stub code for constructors to work.  On
6329 multi-libbed systems, @samp{gcc -shared} must select the correct support
6330 libraries to link against.  Failing to supply the correct flags may lead
6331 to subtle defects.  Supplying them in cases where they are not necessary
6332 is innocuous.}
6334 @item -shared-libgcc
6335 @itemx -static-libgcc
6336 @opindex shared-libgcc
6337 @opindex static-libgcc
6338 On systems that provide @file{libgcc} as a shared library, these options
6339 force the use of either the shared or static version respectively.
6340 If no shared version of @file{libgcc} was built when the compiler was
6341 configured, these options have no effect.
6343 There are several situations in which an application should use the
6344 shared @file{libgcc} instead of the static version.  The most common
6345 of these is when the application wishes to throw and catch exceptions
6346 across different shared libraries.  In that case, each of the libraries
6347 as well as the application itself should use the shared @file{libgcc}.
6349 Therefore, the G++ and GCJ drivers automatically add
6350 @option{-shared-libgcc} whenever you build a shared library or a main
6351 executable, because C++ and Java programs typically use exceptions, so
6352 this is the right thing to do.
6354 If, instead, you use the GCC driver to create shared libraries, you may
6355 find that they will not always be linked with the shared @file{libgcc}.
6356 If GCC finds, at its configuration time, that you have a non-GNU linker
6357 or a GNU linker that does not support option @option{--eh-frame-hdr},
6358 it will link the shared version of @file{libgcc} into shared libraries
6359 by default.  Otherwise, it will take advantage of the linker and optimize
6360 away the linking with the shared version of @file{libgcc}, linking with
6361 the static version of libgcc by default.  This allows exceptions to
6362 propagate through such shared libraries, without incurring relocation
6363 costs at library load time.
6365 However, if a library or main executable is supposed to throw or catch
6366 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6367 for the languages used in the program, or using the option
6368 @option{-shared-libgcc}, such that it is linked with the shared
6369 @file{libgcc}.
6371 @item -symbolic
6372 @opindex symbolic
6373 Bind references to global symbols when building a shared object.  Warn
6374 about any unresolved references (unless overridden by the link editor
6375 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6376 this option.
6378 @item -Xlinker @var{option}
6379 @opindex Xlinker
6380 Pass @var{option} as an option to the linker.  You can use this to
6381 supply system-specific linker options which GCC does not know how to
6382 recognize.
6384 If you want to pass an option that takes an argument, you must use
6385 @option{-Xlinker} twice, once for the option and once for the argument.
6386 For example, to pass @option{-assert definitions}, you must write
6387 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6388 @option{-Xlinker "-assert definitions"}, because this passes the entire
6389 string as a single argument, which is not what the linker expects.
6391 @item -Wl,@var{option}
6392 @opindex Wl
6393 Pass @var{option} as an option to the linker.  If @var{option} contains
6394 commas, it is split into multiple options at the commas.
6396 @item -u @var{symbol}
6397 @opindex u
6398 Pretend the symbol @var{symbol} is undefined, to force linking of
6399 library modules to define it.  You can use @option{-u} multiple times with
6400 different symbols to force loading of additional library modules.
6401 @end table
6403 @node Directory Options
6404 @section Options for Directory Search
6405 @cindex directory options
6406 @cindex options, directory search
6407 @cindex search path
6409 These options specify directories to search for header files, for
6410 libraries and for parts of the compiler:
6412 @table @gcctabopt
6413 @item -I@var{dir}
6414 @opindex I
6415 Add the directory @var{dir} to the head of the list of directories to be
6416 searched for header files.  This can be used to override a system header
6417 file, substituting your own version, since these directories are
6418 searched before the system header file directories.  However, you should
6419 not use this option to add directories that contain vendor-supplied
6420 system header files (use @option{-isystem} for that).  If you use more than
6421 one @option{-I} option, the directories are scanned in left-to-right
6422 order; the standard system directories come after.
6424 If a standard system include directory, or a directory specified with
6425 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6426 option will be ignored.  The directory will still be searched but as a
6427 system directory at its normal position in the system include chain.
6428 This is to ensure that GCC's procedure to fix buggy system headers and
6429 the ordering for the include_next directive are not inadvertently changed.
6430 If you really need to change the search order for system directories,
6431 use the @option{-nostdinc} and/or @option{-isystem} options.
6433 @item -iquote@var{dir}
6434 @opindex iquote
6435 Add the directory @var{dir} to the head of the list of directories to
6436 be searched for header files only for the case of @samp{#include
6437 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6438 otherwise just like @option{-I}.
6440 @item -L@var{dir}
6441 @opindex L
6442 Add directory @var{dir} to the list of directories to be searched
6443 for @option{-l}.
6445 @item -B@var{prefix}
6446 @opindex B
6447 This option specifies where to find the executables, libraries,
6448 include files, and data files of the compiler itself.
6450 The compiler driver program runs one or more of the subprograms
6451 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6452 @var{prefix} as a prefix for each program it tries to run, both with and
6453 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6455 For each subprogram to be run, the compiler driver first tries the
6456 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6457 was not specified, the driver tries two standard prefixes, which are
6458 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6459 those results in a file name that is found, the unmodified program
6460 name is searched for using the directories specified in your
6461 @env{PATH} environment variable.
6463 The compiler will check to see if the path provided by the @option{-B}
6464 refers to a directory, and if necessary it will add a directory
6465 separator character at the end of the path.
6467 @option{-B} prefixes that effectively specify directory names also apply
6468 to libraries in the linker, because the compiler translates these
6469 options into @option{-L} options for the linker.  They also apply to
6470 includes files in the preprocessor, because the compiler translates these
6471 options into @option{-isystem} options for the preprocessor.  In this case,
6472 the compiler appends @samp{include} to the prefix.
6474 The run-time support file @file{libgcc.a} can also be searched for using
6475 the @option{-B} prefix, if needed.  If it is not found there, the two
6476 standard prefixes above are tried, and that is all.  The file is left
6477 out of the link if it is not found by those means.
6479 Another way to specify a prefix much like the @option{-B} prefix is to use
6480 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6481 Variables}.
6483 As a special kludge, if the path provided by @option{-B} is
6484 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6485 9, then it will be replaced by @file{[dir/]include}.  This is to help
6486 with boot-strapping the compiler.
6488 @item -specs=@var{file}
6489 @opindex specs
6490 Process @var{file} after the compiler reads in the standard @file{specs}
6491 file, in order to override the defaults that the @file{gcc} driver
6492 program uses when determining what switches to pass to @file{cc1},
6493 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6494 @option{-specs=@var{file}} can be specified on the command line, and they
6495 are processed in order, from left to right.
6497 @item --sysroot=@var{dir}
6498 @opindex sysroot
6499 Use @var{dir} as the logical root directory for headers and libraries.
6500 For example, if the compiler would normally search for headers in
6501 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6502 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6504 If you use both this option and the @option{-isysroot} option, then
6505 the @option{--sysroot} option will apply to libraries, but the
6506 @option{-isysroot} option will apply to header files.
6508 The GNU linker (beginning with version 2.16) has the necessary support
6509 for this option.  If your linker does not support this option, the
6510 header file aspect of @option{--sysroot} will still work, but the
6511 library aspect will not.
6513 @item -I-
6514 @opindex I-
6515 This option has been deprecated.  Please use @option{-iquote} instead for
6516 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6517 Any directories you specify with @option{-I} options before the @option{-I-}
6518 option are searched only for the case of @samp{#include "@var{file}"};
6519 they are not searched for @samp{#include <@var{file}>}.
6521 If additional directories are specified with @option{-I} options after
6522 the @option{-I-}, these directories are searched for all @samp{#include}
6523 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6524 this way.)
6526 In addition, the @option{-I-} option inhibits the use of the current
6527 directory (where the current input file came from) as the first search
6528 directory for @samp{#include "@var{file}"}.  There is no way to
6529 override this effect of @option{-I-}.  With @option{-I.} you can specify
6530 searching the directory which was current when the compiler was
6531 invoked.  That is not exactly the same as what the preprocessor does
6532 by default, but it is often satisfactory.
6534 @option{-I-} does not inhibit the use of the standard system directories
6535 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6536 independent.
6537 @end table
6539 @c man end
6541 @node Spec Files
6542 @section Specifying subprocesses and the switches to pass to them
6543 @cindex Spec Files
6545 @command{gcc} is a driver program.  It performs its job by invoking a
6546 sequence of other programs to do the work of compiling, assembling and
6547 linking.  GCC interprets its command-line parameters and uses these to
6548 deduce which programs it should invoke, and which command-line options
6549 it ought to place on their command lines.  This behavior is controlled
6550 by @dfn{spec strings}.  In most cases there is one spec string for each
6551 program that GCC can invoke, but a few programs have multiple spec
6552 strings to control their behavior.  The spec strings built into GCC can
6553 be overridden by using the @option{-specs=} command-line switch to specify
6554 a spec file.
6556 @dfn{Spec files} are plaintext files that are used to construct spec
6557 strings.  They consist of a sequence of directives separated by blank
6558 lines.  The type of directive is determined by the first non-whitespace
6559 character on the line and it can be one of the following:
6561 @table @code
6562 @item %@var{command}
6563 Issues a @var{command} to the spec file processor.  The commands that can
6564 appear here are:
6566 @table @code
6567 @item %include <@var{file}>
6568 @cindex %include
6569 Search for @var{file} and insert its text at the current point in the
6570 specs file.
6572 @item %include_noerr <@var{file}>
6573 @cindex %include_noerr
6574 Just like @samp{%include}, but do not generate an error message if the include
6575 file cannot be found.
6577 @item %rename @var{old_name} @var{new_name}
6578 @cindex %rename
6579 Rename the spec string @var{old_name} to @var{new_name}.
6581 @end table
6583 @item *[@var{spec_name}]:
6584 This tells the compiler to create, override or delete the named spec
6585 string.  All lines after this directive up to the next directive or
6586 blank line are considered to be the text for the spec string.  If this
6587 results in an empty string then the spec will be deleted.  (Or, if the
6588 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6589 does not currently exist a new spec will be created.  If the spec does
6590 exist then its contents will be overridden by the text of this
6591 directive, unless the first character of that text is the @samp{+}
6592 character, in which case the text will be appended to the spec.
6594 @item [@var{suffix}]:
6595 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6596 and up to the next directive or blank line are considered to make up the
6597 spec string for the indicated suffix.  When the compiler encounters an
6598 input file with the named suffix, it will processes the spec string in
6599 order to work out how to compile that file.  For example:
6601 @smallexample
6602 .ZZ:
6603 z-compile -input %i
6604 @end smallexample
6606 This says that any input file whose name ends in @samp{.ZZ} should be
6607 passed to the program @samp{z-compile}, which should be invoked with the
6608 command-line switch @option{-input} and with the result of performing the
6609 @samp{%i} substitution.  (See below.)
6611 As an alternative to providing a spec string, the text that follows a
6612 suffix directive can be one of the following:
6614 @table @code
6615 @item @@@var{language}
6616 This says that the suffix is an alias for a known @var{language}.  This is
6617 similar to using the @option{-x} command-line switch to GCC to specify a
6618 language explicitly.  For example:
6620 @smallexample
6621 .ZZ:
6622 @@c++
6623 @end smallexample
6625 Says that .ZZ files are, in fact, C++ source files.
6627 @item #@var{name}
6628 This causes an error messages saying:
6630 @smallexample
6631 @var{name} compiler not installed on this system.
6632 @end smallexample
6633 @end table
6635 GCC already has an extensive list of suffixes built into it.
6636 This directive will add an entry to the end of the list of suffixes, but
6637 since the list is searched from the end backwards, it is effectively
6638 possible to override earlier entries using this technique.
6640 @end table
6642 GCC has the following spec strings built into it.  Spec files can
6643 override these strings or create their own.  Note that individual
6644 targets can also add their own spec strings to this list.
6646 @smallexample
6647 asm          Options to pass to the assembler
6648 asm_final    Options to pass to the assembler post-processor
6649 cpp          Options to pass to the C preprocessor
6650 cc1          Options to pass to the C compiler
6651 cc1plus      Options to pass to the C++ compiler
6652 endfile      Object files to include at the end of the link
6653 link         Options to pass to the linker
6654 lib          Libraries to include on the command line to the linker
6655 libgcc       Decides which GCC support library to pass to the linker
6656 linker       Sets the name of the linker
6657 predefines   Defines to be passed to the C preprocessor
6658 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6659              by default
6660 startfile    Object files to include at the start of the link
6661 @end smallexample
6663 Here is a small example of a spec file:
6665 @smallexample
6666 %rename lib                 old_lib
6668 *lib:
6669 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6670 @end smallexample
6672 This example renames the spec called @samp{lib} to @samp{old_lib} and
6673 then overrides the previous definition of @samp{lib} with a new one.
6674 The new definition adds in some extra command-line options before
6675 including the text of the old definition.
6677 @dfn{Spec strings} are a list of command-line options to be passed to their
6678 corresponding program.  In addition, the spec strings can contain
6679 @samp{%}-prefixed sequences to substitute variable text or to
6680 conditionally insert text into the command line.  Using these constructs
6681 it is possible to generate quite complex command lines.
6683 Here is a table of all defined @samp{%}-sequences for spec
6684 strings.  Note that spaces are not generated automatically around the
6685 results of expanding these sequences.  Therefore you can concatenate them
6686 together or combine them with constant text in a single argument.
6688 @table @code
6689 @item %%
6690 Substitute one @samp{%} into the program name or argument.
6692 @item %i
6693 Substitute the name of the input file being processed.
6695 @item %b
6696 Substitute the basename of the input file being processed.
6697 This is the substring up to (and not including) the last period
6698 and not including the directory.
6700 @item %B
6701 This is the same as @samp{%b}, but include the file suffix (text after
6702 the last period).
6704 @item %d
6705 Marks the argument containing or following the @samp{%d} as a
6706 temporary file name, so that that file will be deleted if GCC exits
6707 successfully.  Unlike @samp{%g}, this contributes no text to the
6708 argument.
6710 @item %g@var{suffix}
6711 Substitute a file name that has suffix @var{suffix} and is chosen
6712 once per compilation, and mark the argument in the same way as
6713 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6714 name is now chosen in a way that is hard to predict even when previously
6715 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6716 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6717 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6718 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6719 was simply substituted with a file name chosen once per compilation,
6720 without regard to any appended suffix (which was therefore treated
6721 just like ordinary text), making such attacks more likely to succeed.
6723 @item %u@var{suffix}
6724 Like @samp{%g}, but generates a new temporary file name even if
6725 @samp{%u@var{suffix}} was already seen.
6727 @item %U@var{suffix}
6728 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6729 new one if there is no such last file name.  In the absence of any
6730 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6731 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6732 would involve the generation of two distinct file names, one
6733 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6734 simply substituted with a file name chosen for the previous @samp{%u},
6735 without regard to any appended suffix.
6737 @item %j@var{suffix}
6738 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6739 writable, and if save-temps is off; otherwise, substitute the name
6740 of a temporary file, just like @samp{%u}.  This temporary file is not
6741 meant for communication between processes, but rather as a junk
6742 disposal mechanism.
6744 @item %|@var{suffix}
6745 @itemx %m@var{suffix}
6746 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6747 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6748 all.  These are the two most common ways to instruct a program that it
6749 should read from standard input or write to standard output.  If you
6750 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6751 construct: see for example @file{f/lang-specs.h}.
6753 @item %.@var{SUFFIX}
6754 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6755 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6756 terminated by the next space or %.
6758 @item %w
6759 Marks the argument containing or following the @samp{%w} as the
6760 designated output file of this compilation.  This puts the argument
6761 into the sequence of arguments that @samp{%o} will substitute later.
6763 @item %o
6764 Substitutes the names of all the output files, with spaces
6765 automatically placed around them.  You should write spaces
6766 around the @samp{%o} as well or the results are undefined.
6767 @samp{%o} is for use in the specs for running the linker.
6768 Input files whose names have no recognized suffix are not compiled
6769 at all, but they are included among the output files, so they will
6770 be linked.
6772 @item %O
6773 Substitutes the suffix for object files.  Note that this is
6774 handled specially when it immediately follows @samp{%g, %u, or %U},
6775 because of the need for those to form complete file names.  The
6776 handling is such that @samp{%O} is treated exactly as if it had already
6777 been substituted, except that @samp{%g, %u, and %U} do not currently
6778 support additional @var{suffix} characters following @samp{%O} as they would
6779 following, for example, @samp{.o}.
6781 @item %p
6782 Substitutes the standard macro predefinitions for the
6783 current target machine.  Use this when running @code{cpp}.
6785 @item %P
6786 Like @samp{%p}, but puts @samp{__} before and after the name of each
6787 predefined macro, except for macros that start with @samp{__} or with
6788 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6791 @item %I
6792 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6793 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6794 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6795 as necessary.
6797 @item %s
6798 Current argument is the name of a library or startup file of some sort.
6799 Search for that file in a standard list of directories and substitute
6800 the full name found.
6802 @item %e@var{str}
6803 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6804 Use this when inconsistent options are detected.
6806 @item %(@var{name})
6807 Substitute the contents of spec string @var{name} at this point.
6809 @item %[@var{name}]
6810 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6812 @item %x@{@var{option}@}
6813 Accumulate an option for @samp{%X}.
6815 @item %X
6816 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6817 spec string.
6819 @item %Y
6820 Output the accumulated assembler options specified by @option{-Wa}.
6822 @item %Z
6823 Output the accumulated preprocessor options specified by @option{-Wp}.
6825 @item %a
6826 Process the @code{asm} spec.  This is used to compute the
6827 switches to be passed to the assembler.
6829 @item %A
6830 Process the @code{asm_final} spec.  This is a spec string for
6831 passing switches to an assembler post-processor, if such a program is
6832 needed.
6834 @item %l
6835 Process the @code{link} spec.  This is the spec for computing the
6836 command line passed to the linker.  Typically it will make use of the
6837 @samp{%L %G %S %D and %E} sequences.
6839 @item %D
6840 Dump out a @option{-L} option for each directory that GCC believes might
6841 contain startup files.  If the target supports multilibs then the
6842 current multilib directory will be prepended to each of these paths.
6844 @item %L
6845 Process the @code{lib} spec.  This is a spec string for deciding which
6846 libraries should be included on the command line to the linker.
6848 @item %G
6849 Process the @code{libgcc} spec.  This is a spec string for deciding
6850 which GCC support library should be included on the command line to the linker.
6852 @item %S
6853 Process the @code{startfile} spec.  This is a spec for deciding which
6854 object files should be the first ones passed to the linker.  Typically
6855 this might be a file named @file{crt0.o}.
6857 @item %E
6858 Process the @code{endfile} spec.  This is a spec string that specifies
6859 the last object files that will be passed to the linker.
6861 @item %C
6862 Process the @code{cpp} spec.  This is used to construct the arguments
6863 to be passed to the C preprocessor.
6865 @item %1
6866 Process the @code{cc1} spec.  This is used to construct the options to be
6867 passed to the actual C compiler (@samp{cc1}).
6869 @item %2
6870 Process the @code{cc1plus} spec.  This is used to construct the options to be
6871 passed to the actual C++ compiler (@samp{cc1plus}).
6873 @item %*
6874 Substitute the variable part of a matched option.  See below.
6875 Note that each comma in the substituted string is replaced by
6876 a single space.
6878 @item %<@code{S}
6879 Remove all occurrences of @code{-S} from the command line.  Note---this
6880 command is position dependent.  @samp{%} commands in the spec string
6881 before this one will see @code{-S}, @samp{%} commands in the spec string
6882 after this one will not.
6884 @item %:@var{function}(@var{args})
6885 Call the named function @var{function}, passing it @var{args}.
6886 @var{args} is first processed as a nested spec string, then split
6887 into an argument vector in the usual fashion.  The function returns
6888 a string which is processed as if it had appeared literally as part
6889 of the current spec.
6891 The following built-in spec functions are provided:
6893 @table @code
6894 @item @code{if-exists}
6895 The @code{if-exists} spec function takes one argument, an absolute
6896 pathname to a file.  If the file exists, @code{if-exists} returns the
6897 pathname.  Here is a small example of its usage:
6899 @smallexample
6900 *startfile:
6901 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6902 @end smallexample
6904 @item @code{if-exists-else}
6905 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6906 spec function, except that it takes two arguments.  The first argument is
6907 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6908 returns the pathname.  If it does not exist, it returns the second argument.
6909 This way, @code{if-exists-else} can be used to select one file or another,
6910 based on the existence of the first.  Here is a small example of its usage:
6912 @smallexample
6913 *startfile:
6914 crt0%O%s %:if-exists(crti%O%s) \
6915 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6916 @end smallexample
6918 @item @code{replace-outfile}
6919 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6920 first argument in the outfiles array and replaces it with the second argument.  Here
6921 is a small example of its usage:
6923 @smallexample
6924 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6925 @end smallexample
6927 @end table
6929 @item %@{@code{S}@}
6930 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6931 If that switch was not specified, this substitutes nothing.  Note that
6932 the leading dash is omitted when specifying this option, and it is
6933 automatically inserted if the substitution is performed.  Thus the spec
6934 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6935 and would output the command line option @option{-foo}.
6937 @item %W@{@code{S}@}
6938 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6939 deleted on failure.
6941 @item %@{@code{S}*@}
6942 Substitutes all the switches specified to GCC whose names start
6943 with @code{-S}, but which also take an argument.  This is used for
6944 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6945 GCC considers @option{-o foo} as being
6946 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6947 text, including the space.  Thus two arguments would be generated.
6949 @item %@{@code{S}*&@code{T}*@}
6950 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6951 (the order of @code{S} and @code{T} in the spec is not significant).
6952 There can be any number of ampersand-separated variables; for each the
6953 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6955 @item %@{@code{S}:@code{X}@}
6956 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6958 @item %@{!@code{S}:@code{X}@}
6959 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6961 @item %@{@code{S}*:@code{X}@}
6962 Substitutes @code{X} if one or more switches whose names start with
6963 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6964 once, no matter how many such switches appeared.  However, if @code{%*}
6965 appears somewhere in @code{X}, then @code{X} will be substituted once
6966 for each matching switch, with the @code{%*} replaced by the part of
6967 that switch that matched the @code{*}.
6969 @item %@{.@code{S}:@code{X}@}
6970 Substitutes @code{X}, if processing a file with suffix @code{S}.
6972 @item %@{!.@code{S}:@code{X}@}
6973 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6975 @item %@{@code{S}|@code{P}:@code{X}@}
6976 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6977 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6978 although they have a stronger binding than the @samp{|}.  If @code{%*}
6979 appears in @code{X}, all of the alternatives must be starred, and only
6980 the first matching alternative is substituted.
6982 For example, a spec string like this:
6984 @smallexample
6985 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6986 @end smallexample
6988 will output the following command-line options from the following input
6989 command-line options:
6991 @smallexample
6992 fred.c        -foo -baz
6993 jim.d         -bar -boggle
6994 -d fred.c     -foo -baz -boggle
6995 -d jim.d      -bar -baz -boggle
6996 @end smallexample
6998 @item %@{S:X; T:Y; :D@}
7000 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7001 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7002 be as many clauses as you need.  This may be combined with @code{.},
7003 @code{!}, @code{|}, and @code{*} as needed.
7006 @end table
7008 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7009 construct may contain other nested @samp{%} constructs or spaces, or
7010 even newlines.  They are processed as usual, as described above.
7011 Trailing white space in @code{X} is ignored.  White space may also
7012 appear anywhere on the left side of the colon in these constructs,
7013 except between @code{.} or @code{*} and the corresponding word.
7015 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7016 handled specifically in these constructs.  If another value of
7017 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7018 @option{-W} switch is found later in the command line, the earlier
7019 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7020 just one letter, which passes all matching options.
7022 The character @samp{|} at the beginning of the predicate text is used to
7023 indicate that a command should be piped to the following command, but
7024 only if @option{-pipe} is specified.
7026 It is built into GCC which switches take arguments and which do not.
7027 (You might think it would be useful to generalize this to allow each
7028 compiler's spec to say which switches take arguments.  But this cannot
7029 be done in a consistent fashion.  GCC cannot even decide which input
7030 files have been specified without knowing which switches take arguments,
7031 and it must know which input files to compile in order to tell which
7032 compilers to run).
7034 GCC also knows implicitly that arguments starting in @option{-l} are to be
7035 treated as compiler output files, and passed to the linker in their
7036 proper position among the other output files.
7038 @c man begin OPTIONS
7040 @node Target Options
7041 @section Specifying Target Machine and Compiler Version
7042 @cindex target options
7043 @cindex cross compiling
7044 @cindex specifying machine version
7045 @cindex specifying compiler version and target machine
7046 @cindex compiler version, specifying
7047 @cindex target machine, specifying
7049 The usual way to run GCC is to run the executable called @file{gcc}, or
7050 @file{<machine>-gcc} when cross-compiling, or
7051 @file{<machine>-gcc-<version>} to run a version other than the one that
7052 was installed last.  Sometimes this is inconvenient, so GCC provides
7053 options that will switch to another cross-compiler or version.
7055 @table @gcctabopt
7056 @item -b @var{machine}
7057 @opindex b
7058 The argument @var{machine} specifies the target machine for compilation.
7060 The value to use for @var{machine} is the same as was specified as the
7061 machine type when configuring GCC as a cross-compiler.  For
7062 example, if a cross-compiler was configured with @samp{configure
7063 arm-elf}, meaning to compile for an arm processor with elf binaries,
7064 then you would specify @option{-b arm-elf} to run that cross compiler.
7065 Because there are other options beginning with @option{-b}, the
7066 configuration must contain a hyphen. 
7068 @item -V @var{version}
7069 @opindex V
7070 The argument @var{version} specifies which version of GCC to run.
7071 This is useful when multiple versions are installed.  For example,
7072 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7073 @end table
7075 The @option{-V} and @option{-b} options work by running the
7076 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7077 use them if you can just run that directly.
7079 @node Submodel Options
7080 @section Hardware Models and Configurations
7081 @cindex submodel options
7082 @cindex specifying hardware config
7083 @cindex hardware models and configurations, specifying
7084 @cindex machine dependent options
7086 Earlier we discussed the standard option @option{-b} which chooses among
7087 different installed compilers for completely different target
7088 machines, such as VAX vs.@: 68000 vs.@: 80386.
7090 In addition, each of these target machine types can have its own
7091 special options, starting with @samp{-m}, to choose among various
7092 hardware models or configurations---for example, 68010 vs 68020,
7093 floating coprocessor or none.  A single installed version of the
7094 compiler can compile for any model or configuration, according to the
7095 options specified.
7097 Some configurations of the compiler also support additional special
7098 options, usually for compatibility with other compilers on the same
7099 platform.
7101 @c This list is ordered alphanumerically by subsection name.
7102 @c It should be the same order and spelling as these options are listed
7103 @c in Machine Dependent Options
7105 @menu
7106 * ARC Options::
7107 * ARM Options::
7108 * AVR Options::
7109 * Blackfin Options::
7110 * CRIS Options::
7111 * CRX Options::
7112 * Darwin Options::
7113 * DEC Alpha Options::
7114 * DEC Alpha/VMS Options::
7115 * FRV Options::
7116 * H8/300 Options::
7117 * HPPA Options::
7118 * i386 and x86-64 Options::
7119 * IA-64 Options::
7120 * M32C Options::
7121 * M32R/D Options::
7122 * M680x0 Options::
7123 * M68hc1x Options::
7124 * MCore Options::
7125 * MIPS Options::
7126 * MMIX Options::
7127 * MN10300 Options::
7128 * MS1 Options::
7129 * PDP-11 Options::
7130 * PowerPC Options::
7131 * RS/6000 and PowerPC Options::
7132 * S/390 and zSeries Options::
7133 * SH Options::
7134 * SPARC Options::
7135 * System V Options::
7136 * TMS320C3x/C4x Options::
7137 * V850 Options::
7138 * VAX Options::
7139 * x86-64 Options::
7140 * Xstormy16 Options::
7141 * Xtensa Options::
7142 * zSeries Options::
7143 @end menu
7145 @node ARC Options
7146 @subsection ARC Options
7147 @cindex ARC Options
7149 These options are defined for ARC implementations:
7151 @table @gcctabopt
7152 @item -EL
7153 @opindex EL
7154 Compile code for little endian mode.  This is the default.
7156 @item -EB
7157 @opindex EB
7158 Compile code for big endian mode.
7160 @item -mmangle-cpu
7161 @opindex mmangle-cpu
7162 Prepend the name of the cpu to all public symbol names.
7163 In multiple-processor systems, there are many ARC variants with different
7164 instruction and register set characteristics.  This flag prevents code
7165 compiled for one cpu to be linked with code compiled for another.
7166 No facility exists for handling variants that are ``almost identical''.
7167 This is an all or nothing option.
7169 @item -mcpu=@var{cpu}
7170 @opindex mcpu
7171 Compile code for ARC variant @var{cpu}.
7172 Which variants are supported depend on the configuration.
7173 All variants support @option{-mcpu=base}, this is the default.
7175 @item -mtext=@var{text-section}
7176 @itemx -mdata=@var{data-section}
7177 @itemx -mrodata=@var{readonly-data-section}
7178 @opindex mtext
7179 @opindex mdata
7180 @opindex mrodata
7181 Put functions, data, and readonly data in @var{text-section},
7182 @var{data-section}, and @var{readonly-data-section} respectively
7183 by default.  This can be overridden with the @code{section} attribute.
7184 @xref{Variable Attributes}.
7186 @end table
7188 @node ARM Options
7189 @subsection ARM Options
7190 @cindex ARM options
7192 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7193 architectures:
7195 @table @gcctabopt
7196 @item -mabi=@var{name}
7197 @opindex mabi
7198 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7199 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7201 @item -mapcs-frame
7202 @opindex mapcs-frame
7203 Generate a stack frame that is compliant with the ARM Procedure Call
7204 Standard for all functions, even if this is not strictly necessary for
7205 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7206 with this option will cause the stack frames not to be generated for
7207 leaf functions.  The default is @option{-mno-apcs-frame}.
7209 @item -mapcs
7210 @opindex mapcs
7211 This is a synonym for @option{-mapcs-frame}.
7213 @ignore
7214 @c not currently implemented
7215 @item -mapcs-stack-check
7216 @opindex mapcs-stack-check
7217 Generate code to check the amount of stack space available upon entry to
7218 every function (that actually uses some stack space).  If there is
7219 insufficient space available then either the function
7220 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7221 called, depending upon the amount of stack space required.  The run time
7222 system is required to provide these functions.  The default is
7223 @option{-mno-apcs-stack-check}, since this produces smaller code.
7225 @c not currently implemented
7226 @item -mapcs-float
7227 @opindex mapcs-float
7228 Pass floating point arguments using the float point registers.  This is
7229 one of the variants of the APCS@.  This option is recommended if the
7230 target hardware has a floating point unit or if a lot of floating point
7231 arithmetic is going to be performed by the code.  The default is
7232 @option{-mno-apcs-float}, since integer only code is slightly increased in
7233 size if @option{-mapcs-float} is used.
7235 @c not currently implemented
7236 @item -mapcs-reentrant
7237 @opindex mapcs-reentrant
7238 Generate reentrant, position independent code.  The default is
7239 @option{-mno-apcs-reentrant}.
7240 @end ignore
7242 @item -mthumb-interwork
7243 @opindex mthumb-interwork
7244 Generate code which supports calling between the ARM and Thumb
7245 instruction sets.  Without this option the two instruction sets cannot
7246 be reliably used inside one program.  The default is
7247 @option{-mno-thumb-interwork}, since slightly larger code is generated
7248 when @option{-mthumb-interwork} is specified.
7250 @item -mno-sched-prolog
7251 @opindex mno-sched-prolog
7252 Prevent the reordering of instructions in the function prolog, or the
7253 merging of those instruction with the instructions in the function's
7254 body.  This means that all functions will start with a recognizable set
7255 of instructions (or in fact one of a choice from a small set of
7256 different function prologues), and this information can be used to
7257 locate the start if functions inside an executable piece of code.  The
7258 default is @option{-msched-prolog}.
7260 @item -mhard-float
7261 @opindex mhard-float
7262 Generate output containing floating point instructions.  This is the
7263 default.
7265 @item -msoft-float
7266 @opindex msoft-float
7267 Generate output containing library calls for floating point.
7268 @strong{Warning:} the requisite libraries are not available for all ARM
7269 targets.  Normally the facilities of the machine's usual C compiler are
7270 used, but this cannot be done directly in cross-compilation.  You must make
7271 your own arrangements to provide suitable library functions for
7272 cross-compilation.
7274 @option{-msoft-float} changes the calling convention in the output file;
7275 therefore, it is only useful if you compile @emph{all} of a program with
7276 this option.  In particular, you need to compile @file{libgcc.a}, the
7277 library that comes with GCC, with @option{-msoft-float} in order for
7278 this to work.
7280 @item -mfloat-abi=@var{name}
7281 @opindex mfloat-abi
7282 Specifies which ABI to use for floating point values.  Permissible values
7283 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7285 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7286 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7287 of floating point instructions, but still uses the soft-float calling
7288 conventions.
7290 @item -mlittle-endian
7291 @opindex mlittle-endian
7292 Generate code for a processor running in little-endian mode.  This is
7293 the default for all standard configurations.
7295 @item -mbig-endian
7296 @opindex mbig-endian
7297 Generate code for a processor running in big-endian mode; the default is
7298 to compile code for a little-endian processor.
7300 @item -mwords-little-endian
7301 @opindex mwords-little-endian
7302 This option only applies when generating code for big-endian processors.
7303 Generate code for a little-endian word order but a big-endian byte
7304 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7305 option should only be used if you require compatibility with code for
7306 big-endian ARM processors generated by versions of the compiler prior to
7307 2.8.
7309 @item -mcpu=@var{name}
7310 @opindex mcpu
7311 This specifies the name of the target ARM processor.  GCC uses this name
7312 to determine what kind of instructions it can emit when generating
7313 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7314 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7315 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7316 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7317 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7318 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7319 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7320 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7321 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7322 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7323 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7324 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7325 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7326 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7327 @samp{ep9312}.
7329 @itemx -mtune=@var{name}
7330 @opindex mtune
7331 This option is very similar to the @option{-mcpu=} option, except that
7332 instead of specifying the actual target processor type, and hence
7333 restricting which instructions can be used, it specifies that GCC should
7334 tune the performance of the code as if the target were of the type
7335 specified in this option, but still choosing the instructions that it
7336 will generate based on the cpu specified by a @option{-mcpu=} option.
7337 For some ARM implementations better performance can be obtained by using
7338 this option.
7340 @item -march=@var{name}
7341 @opindex march
7342 This specifies the name of the target ARM architecture.  GCC uses this
7343 name to determine what kind of instructions it can emit when generating
7344 assembly code.  This option can be used in conjunction with or instead
7345 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7346 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7347 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7348 @samp{iwmmxt}, @samp{ep9312}.
7350 @item -mfpu=@var{name}
7351 @itemx -mfpe=@var{number}
7352 @itemx -mfp=@var{number}
7353 @opindex mfpu
7354 @opindex mfpe
7355 @opindex mfp
7356 This specifies what floating point hardware (or hardware emulation) is
7357 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7358 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7359 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7360 with older versions of GCC@.
7362 If @option{-msoft-float} is specified this specifies the format of
7363 floating point values.
7365 @item -mstructure-size-boundary=@var{n}
7366 @opindex mstructure-size-boundary
7367 The size of all structures and unions will be rounded up to a multiple
7368 of the number of bits set by this option.  Permissible values are 8, 32
7369 and 64.  The default value varies for different toolchains.  For the COFF
7370 targeted toolchain the default value is 8.  A value of 64 is only allowed
7371 if the underlying ABI supports it.
7373 Specifying the larger number can produce faster, more efficient code, but
7374 can also increase the size of the program.  Different values are potentially
7375 incompatible.  Code compiled with one value cannot necessarily expect to
7376 work with code or libraries compiled with another value, if they exchange
7377 information using structures or unions.
7379 @item -mabort-on-noreturn
7380 @opindex mabort-on-noreturn
7381 Generate a call to the function @code{abort} at the end of a
7382 @code{noreturn} function.  It will be executed if the function tries to
7383 return.
7385 @item -mlong-calls
7386 @itemx -mno-long-calls
7387 @opindex mlong-calls
7388 @opindex mno-long-calls
7389 Tells the compiler to perform function calls by first loading the
7390 address of the function into a register and then performing a subroutine
7391 call on this register.  This switch is needed if the target function
7392 will lie outside of the 64 megabyte addressing range of the offset based
7393 version of subroutine call instruction.
7395 Even if this switch is enabled, not all function calls will be turned
7396 into long calls.  The heuristic is that static functions, functions
7397 which have the @samp{short-call} attribute, functions that are inside
7398 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7399 definitions have already been compiled within the current compilation
7400 unit, will not be turned into long calls.  The exception to this rule is
7401 that weak function definitions, functions with the @samp{long-call}
7402 attribute or the @samp{section} attribute, and functions that are within
7403 the scope of a @samp{#pragma long_calls} directive, will always be
7404 turned into long calls.
7406 This feature is not enabled by default.  Specifying
7407 @option{-mno-long-calls} will restore the default behavior, as will
7408 placing the function calls within the scope of a @samp{#pragma
7409 long_calls_off} directive.  Note these switches have no effect on how
7410 the compiler generates code to handle function calls via function
7411 pointers.
7413 @item -mnop-fun-dllimport
7414 @opindex mnop-fun-dllimport
7415 Disable support for the @code{dllimport} attribute.
7417 @item -msingle-pic-base
7418 @opindex msingle-pic-base
7419 Treat the register used for PIC addressing as read-only, rather than
7420 loading it in the prologue for each function.  The run-time system is
7421 responsible for initializing this register with an appropriate value
7422 before execution begins.
7424 @item -mpic-register=@var{reg}
7425 @opindex mpic-register
7426 Specify the register to be used for PIC addressing.  The default is R10
7427 unless stack-checking is enabled, when R9 is used.
7429 @item -mcirrus-fix-invalid-insns
7430 @opindex mcirrus-fix-invalid-insns
7431 @opindex mno-cirrus-fix-invalid-insns
7432 Insert NOPs into the instruction stream to in order to work around
7433 problems with invalid Maverick instruction combinations.  This option
7434 is only valid if the @option{-mcpu=ep9312} option has been used to
7435 enable generation of instructions for the Cirrus Maverick floating
7436 point co-processor.  This option is not enabled by default, since the
7437 problem is only present in older Maverick implementations.  The default
7438 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7439 switch.
7441 @item -mpoke-function-name
7442 @opindex mpoke-function-name
7443 Write the name of each function into the text section, directly
7444 preceding the function prologue.  The generated code is similar to this:
7446 @smallexample
7447      t0
7448          .ascii "arm_poke_function_name", 0
7449          .align
7450      t1
7451          .word 0xff000000 + (t1 - t0)
7452      arm_poke_function_name
7453          mov     ip, sp
7454          stmfd   sp!, @{fp, ip, lr, pc@}
7455          sub     fp, ip, #4
7456 @end smallexample
7458 When performing a stack backtrace, code can inspect the value of
7459 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7460 location @code{pc - 12} and the top 8 bits are set, then we know that
7461 there is a function name embedded immediately preceding this location
7462 and has length @code{((pc[-3]) & 0xff000000)}.
7464 @item -mthumb
7465 @opindex mthumb
7466 Generate code for the 16-bit Thumb instruction set.  The default is to
7467 use the 32-bit ARM instruction set.
7469 @item -mtpcs-frame
7470 @opindex mtpcs-frame
7471 Generate a stack frame that is compliant with the Thumb Procedure Call
7472 Standard for all non-leaf functions.  (A leaf function is one that does
7473 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7475 @item -mtpcs-leaf-frame
7476 @opindex mtpcs-leaf-frame
7477 Generate a stack frame that is compliant with the Thumb Procedure Call
7478 Standard for all leaf functions.  (A leaf function is one that does
7479 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7481 @item -mcallee-super-interworking
7482 @opindex mcallee-super-interworking
7483 Gives all externally visible functions in the file being compiled an ARM
7484 instruction set header which switches to Thumb mode before executing the
7485 rest of the function.  This allows these functions to be called from
7486 non-interworking code.
7488 @item -mcaller-super-interworking
7489 @opindex mcaller-super-interworking
7490 Allows calls via function pointers (including virtual functions) to
7491 execute correctly regardless of whether the target code has been
7492 compiled for interworking or not.  There is a small overhead in the cost
7493 of executing a function pointer if this option is enabled.
7495 @item -mtp=@var{name}
7496 @opindex mtp
7497 Specify the access model for the thread local storage pointer.  The valid
7498 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7499 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7500 (supported in the arm6k architecture), and @option{auto}, which uses the
7501 best available method for the selected processor.  The default setting is
7502 @option{auto}.
7504 @end table
7506 @node AVR Options
7507 @subsection AVR Options
7508 @cindex AVR Options
7510 These options are defined for AVR implementations:
7512 @table @gcctabopt
7513 @item -mmcu=@var{mcu}
7514 @opindex mmcu
7515 Specify ATMEL AVR instruction set or MCU type.
7517 Instruction set avr1 is for the minimal AVR core, not supported by the C
7518 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7519 attiny11, attiny12, attiny15, attiny28).
7521 Instruction set avr2 (default) is for the classic AVR core with up to
7522 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7523 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7524 at90c8534, at90s8535).
7526 Instruction set avr3 is for the classic AVR core with up to 128K program
7527 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7529 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7530 memory space (MCU types: atmega8, atmega83, atmega85).
7532 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7533 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7534 atmega64, atmega128, at43usb355, at94k).
7536 @item -msize
7537 @opindex msize
7538 Output instruction sizes to the asm file.
7540 @item -minit-stack=@var{N}
7541 @opindex minit-stack
7542 Specify the initial stack address, which may be a symbol or numeric value,
7543 @samp{__stack} is the default.
7545 @item -mno-interrupts
7546 @opindex mno-interrupts
7547 Generated code is not compatible with hardware interrupts.
7548 Code size will be smaller.
7550 @item -mcall-prologues
7551 @opindex mcall-prologues
7552 Functions prologues/epilogues expanded as call to appropriate
7553 subroutines.  Code size will be smaller.
7555 @item -mno-tablejump
7556 @opindex mno-tablejump
7557 Do not generate tablejump insns which sometimes increase code size.
7559 @item -mtiny-stack
7560 @opindex mtiny-stack
7561 Change only the low 8 bits of the stack pointer.
7563 @item -mint8
7564 @opindex mint8
7565 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7566 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7567 and long long will be 4 bytes.  Please note that this option does not
7568 comply to the C standards, but it will provide you with smaller code
7569 size.
7570 @end table
7572 @node Blackfin Options
7573 @subsection Blackfin Options
7574 @cindex Blackfin Options
7576 @table @gcctabopt
7577 @item -momit-leaf-frame-pointer
7578 @opindex momit-leaf-frame-pointer
7579 Don't keep the frame pointer in a register for leaf functions.  This
7580 avoids the instructions to save, set up and restore frame pointers and
7581 makes an extra register available in leaf functions.  The option
7582 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7583 which might make debugging harder.
7585 @item -mspecld-anomaly
7586 @opindex mspecld-anomaly
7587 When enabled, the compiler will ensure that the generated code does not
7588 contain speculative loads after jump instructions.  This option is enabled
7589 by default.
7591 @item -mno-specld-anomaly
7592 @opindex mno-specld-anomaly
7593 Don't generate extra code to prevent speculative loads from occurring.
7595 @item -mcsync-anomaly
7596 @opindex mcsync-anomaly
7597 When enabled, the compiler will ensure that the generated code does not
7598 contain CSYNC or SSYNC instructions too soon after conditional branches.
7599 This option is enabled by default.
7601 @item -mno-csync-anomaly
7602 @opindex mno-csync-anomaly
7603 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7604 occurring too soon after a conditional branch.
7606 @item -mlow-64k
7607 @opindex mlow-64k
7608 When enabled, the compiler is free to take advantage of the knowledge that
7609 the entire program fits into the low 64k of memory.
7611 @item -mno-low-64k
7612 @opindex mno-low-64k
7613 Assume that the program is arbitrarily large.  This is the default.
7615 @item -mid-shared-library
7616 @opindex mid-shared-library
7617 Generate code that supports shared libraries via the library ID method.
7618 This allows for execute in place and shared libraries in an environment
7619 without virtual memory management.  This option implies @option{-fPIC}.
7621 @item -mno-id-shared-library
7622 @opindex mno-id-shared-library
7623 Generate code that doesn't assume ID based shared libraries are being used.
7624 This is the default.
7626 @item -mshared-library-id=n
7627 @opindex mshared-library-id
7628 Specified the identification number of the ID based shared library being
7629 compiled.  Specifying a value of 0 will generate more compact code, specifying
7630 other values will force the allocation of that number to the current
7631 library but is no more space or time efficient than omitting this option.
7633 @item -mlong-calls
7634 @itemx -mno-long-calls
7635 @opindex mlong-calls
7636 @opindex mno-long-calls
7637 Tells the compiler to perform function calls by first loading the
7638 address of the function into a register and then performing a subroutine
7639 call on this register.  This switch is needed if the target function
7640 will lie outside of the 24 bit addressing range of the offset based
7641 version of subroutine call instruction.
7643 This feature is not enabled by default.  Specifying
7644 @option{-mno-long-calls} will restore the default behavior.  Note these
7645 switches have no effect on how the compiler generates code to handle
7646 function calls via function pointers.
7647 @end table
7649 @node CRIS Options
7650 @subsection CRIS Options
7651 @cindex CRIS Options
7653 These options are defined specifically for the CRIS ports.
7655 @table @gcctabopt
7656 @item -march=@var{architecture-type}
7657 @itemx -mcpu=@var{architecture-type}
7658 @opindex march
7659 @opindex mcpu
7660 Generate code for the specified architecture.  The choices for
7661 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7662 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7663 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7664 @samp{v10}.
7666 @item -mtune=@var{architecture-type}
7667 @opindex mtune
7668 Tune to @var{architecture-type} everything applicable about the generated
7669 code, except for the ABI and the set of available instructions.  The
7670 choices for @var{architecture-type} are the same as for
7671 @option{-march=@var{architecture-type}}.
7673 @item -mmax-stack-frame=@var{n}
7674 @opindex mmax-stack-frame
7675 Warn when the stack frame of a function exceeds @var{n} bytes.
7677 @item -melinux-stacksize=@var{n}
7678 @opindex melinux-stacksize
7679 Only available with the @samp{cris-axis-aout} target.  Arranges for
7680 indications in the program to the kernel loader that the stack of the
7681 program should be set to @var{n} bytes.
7683 @item -metrax4
7684 @itemx -metrax100
7685 @opindex metrax4
7686 @opindex metrax100
7687 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7688 @option{-march=v3} and @option{-march=v8} respectively.
7690 @item -mmul-bug-workaround
7691 @itemx -mno-mul-bug-workaround
7692 @opindex mmul-bug-workaround
7693 @opindex mno-mul-bug-workaround
7694 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7695 models where it applies.  This option is active by default.
7697 @item -mpdebug
7698 @opindex mpdebug
7699 Enable CRIS-specific verbose debug-related information in the assembly
7700 code.  This option also has the effect to turn off the @samp{#NO_APP}
7701 formatted-code indicator to the assembler at the beginning of the
7702 assembly file.
7704 @item -mcc-init
7705 @opindex mcc-init
7706 Do not use condition-code results from previous instruction; always emit
7707 compare and test instructions before use of condition codes.
7709 @item -mno-side-effects
7710 @opindex mno-side-effects
7711 Do not emit instructions with side-effects in addressing modes other than
7712 post-increment.
7714 @item -mstack-align
7715 @itemx -mno-stack-align
7716 @itemx -mdata-align
7717 @itemx -mno-data-align
7718 @itemx -mconst-align
7719 @itemx -mno-const-align
7720 @opindex mstack-align
7721 @opindex mno-stack-align
7722 @opindex mdata-align
7723 @opindex mno-data-align
7724 @opindex mconst-align
7725 @opindex mno-const-align
7726 These options (no-options) arranges (eliminate arrangements) for the
7727 stack-frame, individual data and constants to be aligned for the maximum
7728 single data access size for the chosen CPU model.  The default is to
7729 arrange for 32-bit alignment.  ABI details such as structure layout are
7730 not affected by these options.
7732 @item -m32-bit
7733 @itemx -m16-bit
7734 @itemx -m8-bit
7735 @opindex m32-bit
7736 @opindex m16-bit
7737 @opindex m8-bit
7738 Similar to the stack- data- and const-align options above, these options
7739 arrange for stack-frame, writable data and constants to all be 32-bit,
7740 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7742 @item -mno-prologue-epilogue
7743 @itemx -mprologue-epilogue
7744 @opindex mno-prologue-epilogue
7745 @opindex mprologue-epilogue
7746 With @option{-mno-prologue-epilogue}, the normal function prologue and
7747 epilogue that sets up the stack-frame are omitted and no return
7748 instructions or return sequences are generated in the code.  Use this
7749 option only together with visual inspection of the compiled code: no
7750 warnings or errors are generated when call-saved registers must be saved,
7751 or storage for local variable needs to be allocated.
7753 @item -mno-gotplt
7754 @itemx -mgotplt
7755 @opindex mno-gotplt
7756 @opindex mgotplt
7757 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7758 instruction sequences that load addresses for functions from the PLT part
7759 of the GOT rather than (traditional on other architectures) calls to the
7760 PLT@.  The default is @option{-mgotplt}.
7762 @item -maout
7763 @opindex maout
7764 Legacy no-op option only recognized with the cris-axis-aout target.
7766 @item -melf
7767 @opindex melf
7768 Legacy no-op option only recognized with the cris-axis-elf and
7769 cris-axis-linux-gnu targets.
7771 @item -melinux
7772 @opindex melinux
7773 Only recognized with the cris-axis-aout target, where it selects a
7774 GNU/linux-like multilib, include files and instruction set for
7775 @option{-march=v8}.
7777 @item -mlinux
7778 @opindex mlinux
7779 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7781 @item -sim
7782 @opindex sim
7783 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7784 to link with input-output functions from a simulator library.  Code,
7785 initialized data and zero-initialized data are allocated consecutively.
7787 @item -sim2
7788 @opindex sim2
7789 Like @option{-sim}, but pass linker options to locate initialized data at
7790 0x40000000 and zero-initialized data at 0x80000000.
7791 @end table
7793 @node CRX Options
7794 @subsection CRX Options
7795 @cindex CRX Options
7797 These options are defined specifically for the CRX ports.
7799 @table @gcctabopt
7801 @item -mmac
7802 @opindex mmac
7803 Enable the use of multiply-accumulate instructions. Disabled by default.
7805 @item -mpush-args
7806 @opindex mpush-args
7807 Push instructions will be used to pass outgoing arguments when functions
7808 are called. Enabled by default.
7809 @end table
7811 @node Darwin Options
7812 @subsection Darwin Options
7813 @cindex Darwin options
7815 These options are defined for all architectures running the Darwin operating
7816 system.
7818 FSF GCC on Darwin does not create ``fat'' object files; it will create
7819 an object file for the single architecture that it was built to
7820 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7821 @option{-arch} options are used; it does so by running the compiler or
7822 linker multiple times and joining the results together with
7823 @file{lipo}.
7825 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7826 @samp{i686}) is determined by the flags that specify the ISA
7827 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7828 @option{-force_cpusubtype_ALL} option can be used to override this.
7830 The Darwin tools vary in their behavior when presented with an ISA
7831 mismatch.  The assembler, @file{as}, will only permit instructions to
7832 be used that are valid for the subtype of the file it is generating,
7833 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7834 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7835 and print an error if asked to create a shared library with a less
7836 restrictive subtype than its input files (for instance, trying to put
7837 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7838 for executables, @file{ld}, will quietly give the executable the most
7839 restrictive subtype of any of its input files.
7841 @table @gcctabopt
7842 @item -F@var{dir}
7843 @opindex F
7844 Add the framework directory @var{dir} to the head of the list of
7845 directories to be searched for header files.  These directories are
7846 interleaved with those specified by @option{-I} options and are
7847 scanned in a left-to-right order.
7849 A framework directory is a directory with frameworks in it.  A
7850 framework is a directory with a @samp{"Headers"} and/or
7851 @samp{"PrivateHeaders"} directory contained directly in it that ends
7852 in @samp{".framework"}.  The name of a framework is the name of this
7853 directory excluding the @samp{".framework"}.  Headers associated with
7854 the framework are found in one of those two directories, with
7855 @samp{"Headers"} being searched first.  A subframework is a framework
7856 directory that is in a framework's @samp{"Frameworks"} directory.
7857 Includes of subframework headers can only appear in a header of a
7858 framework that contains the subframework, or in a sibling subframework
7859 header.  Two subframeworks are siblings if they occur in the same
7860 framework.  A subframework should not have the same name as a
7861 framework, a warning will be issued if this is violated.  Currently a
7862 subframework cannot have subframeworks, in the future, the mechanism
7863 may be extended to support this.  The standard frameworks can be found
7864 in @samp{"/System/Library/Frameworks"} and
7865 @samp{"/Library/Frameworks"}.  An example include looks like
7866 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7867 the name of the framework and header.h is found in the
7868 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7870 @item -gused
7871 @opindex -gused
7872 Emit debugging information for symbols that are used.  For STABS
7873 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7874 This is by default ON@.
7876 @item -gfull
7877 @opindex -gfull
7878 Emit debugging information for all symbols and types.
7880 @item -mmacosx-version-min=@var{version}
7881 The earliest version of MacOS X that this executable will run on
7882 is @var{version}.  Typical values of @var{version} include @code{10.1},
7883 @code{10.2}, and @code{10.3.9}.
7885 The default for this option is to make choices that seem to be most
7886 useful.  
7888 @item -mone-byte-bool
7889 @opindex -mone-byte-bool
7890 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7891 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7892 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7893 option has no effect on x86.
7895 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7896 to generate code that is not binary compatible with code generated
7897 without that switch.  Using this switch may require recompiling all
7898 other modules in a program, including system libraries.  Use this
7899 switch to conform to a non-default data model.
7901 @item -mfix-and-continue
7902 @itemx -ffix-and-continue
7903 @itemx -findirect-data
7904 @opindex mfix-and-continue
7905 @opindex ffix-and-continue
7906 @opindex findirect-data
7907 Generate code suitable for fast turn around development.  Needed to
7908 enable gdb to dynamically load @code{.o} files into already running
7909 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7910 are provided for backwards compatibility.
7912 @item -all_load
7913 @opindex all_load
7914 Loads all members of static archive libraries.
7915 See man ld(1) for more information.
7917 @item -arch_errors_fatal
7918 @opindex arch_errors_fatal
7919 Cause the errors having to do with files that have the wrong architecture
7920 to be fatal.
7922 @item -bind_at_load
7923 @opindex bind_at_load
7924 Causes the output file to be marked such that the dynamic linker will
7925 bind all undefined references when the file is loaded or launched.
7927 @item -bundle
7928 @opindex bundle
7929 Produce a Mach-o bundle format file.
7930 See man ld(1) for more information.
7932 @item -bundle_loader @var{executable}
7933 @opindex bundle_loader
7934 This option specifies the @var{executable} that will be loading the build
7935 output file being linked.  See man ld(1) for more information.
7937 @item -dynamiclib
7938 @opindex -dynamiclib
7939 When passed this option, GCC will produce a dynamic library instead of
7940 an executable when linking, using the Darwin @file{libtool} command.
7942 @item -force_cpusubtype_ALL
7943 @opindex -force_cpusubtype_ALL
7944 This causes GCC's output file to have the @var{ALL} subtype, instead of
7945 one controlled by the @option{-mcpu} or @option{-march} option.
7947 @item -allowable_client  @var{client_name}
7948 @itemx -client_name
7949 @itemx -compatibility_version
7950 @itemx -current_version
7951 @itemx -dead_strip
7952 @itemx -dependency-file
7953 @itemx -dylib_file
7954 @itemx -dylinker_install_name
7955 @itemx -dynamic
7956 @itemx -exported_symbols_list
7957 @itemx -filelist
7958 @itemx -flat_namespace
7959 @itemx -force_flat_namespace
7960 @itemx -headerpad_max_install_names
7961 @itemx -image_base
7962 @itemx -init
7963 @itemx -install_name
7964 @itemx -keep_private_externs
7965 @itemx -multi_module
7966 @itemx -multiply_defined
7967 @itemx -multiply_defined_unused
7968 @itemx -noall_load
7969 @itemx -no_dead_strip_inits_and_terms
7970 @itemx -nofixprebinding
7971 @itemx -nomultidefs
7972 @itemx -noprebind
7973 @itemx -noseglinkedit
7974 @itemx -pagezero_size
7975 @itemx -prebind
7976 @itemx -prebind_all_twolevel_modules
7977 @itemx -private_bundle
7978 @itemx -read_only_relocs
7979 @itemx -sectalign
7980 @itemx -sectobjectsymbols
7981 @itemx -whyload
7982 @itemx -seg1addr
7983 @itemx -sectcreate
7984 @itemx -sectobjectsymbols
7985 @itemx -sectorder
7986 @itemx -segaddr
7987 @itemx -segs_read_only_addr
7988 @itemx -segs_read_write_addr
7989 @itemx -seg_addr_table
7990 @itemx -seg_addr_table_filename
7991 @itemx -seglinkedit
7992 @itemx -segprot
7993 @itemx -segs_read_only_addr
7994 @itemx -segs_read_write_addr
7995 @itemx -single_module
7996 @itemx -static
7997 @itemx -sub_library
7998 @itemx -sub_umbrella
7999 @itemx -twolevel_namespace
8000 @itemx -umbrella
8001 @itemx -undefined
8002 @itemx -unexported_symbols_list
8003 @itemx -weak_reference_mismatches
8004 @itemx -whatsloaded
8006 @opindex allowable_client
8007 @opindex client_name
8008 @opindex compatibility_version
8009 @opindex current_version
8010 @opindex dead_strip
8011 @opindex dependency-file
8012 @opindex dylib_file
8013 @opindex dylinker_install_name
8014 @opindex dynamic
8015 @opindex exported_symbols_list
8016 @opindex filelist
8017 @opindex flat_namespace
8018 @opindex force_flat_namespace
8019 @opindex headerpad_max_install_names
8020 @opindex image_base
8021 @opindex init
8022 @opindex install_name
8023 @opindex keep_private_externs
8024 @opindex multi_module
8025 @opindex multiply_defined
8026 @opindex multiply_defined_unused
8027 @opindex noall_load
8028 @opindex no_dead_strip_inits_and_terms
8029 @opindex nofixprebinding
8030 @opindex nomultidefs
8031 @opindex noprebind
8032 @opindex noseglinkedit
8033 @opindex pagezero_size
8034 @opindex prebind
8035 @opindex prebind_all_twolevel_modules
8036 @opindex private_bundle
8037 @opindex read_only_relocs
8038 @opindex sectalign
8039 @opindex sectobjectsymbols
8040 @opindex whyload
8041 @opindex seg1addr
8042 @opindex sectcreate
8043 @opindex sectobjectsymbols
8044 @opindex sectorder
8045 @opindex segaddr
8046 @opindex segs_read_only_addr
8047 @opindex segs_read_write_addr
8048 @opindex seg_addr_table
8049 @opindex seg_addr_table_filename
8050 @opindex seglinkedit
8051 @opindex segprot
8052 @opindex segs_read_only_addr
8053 @opindex segs_read_write_addr
8054 @opindex single_module
8055 @opindex static
8056 @opindex sub_library
8057 @opindex sub_umbrella
8058 @opindex twolevel_namespace
8059 @opindex umbrella
8060 @opindex undefined
8061 @opindex unexported_symbols_list
8062 @opindex weak_reference_mismatches
8063 @opindex whatsloaded
8065 These options are passed to the Darwin linker.  The Darwin linker man page
8066 describes them in detail.
8067 @end table
8069 @node DEC Alpha Options
8070 @subsection DEC Alpha Options
8072 These @samp{-m} options are defined for the DEC Alpha implementations:
8074 @table @gcctabopt
8075 @item -mno-soft-float
8076 @itemx -msoft-float
8077 @opindex mno-soft-float
8078 @opindex msoft-float
8079 Use (do not use) the hardware floating-point instructions for
8080 floating-point operations.  When @option{-msoft-float} is specified,
8081 functions in @file{libgcc.a} will be used to perform floating-point
8082 operations.  Unless they are replaced by routines that emulate the
8083 floating-point operations, or compiled in such a way as to call such
8084 emulations routines, these routines will issue floating-point
8085 operations.   If you are compiling for an Alpha without floating-point
8086 operations, you must ensure that the library is built so as not to call
8087 them.
8089 Note that Alpha implementations without floating-point operations are
8090 required to have floating-point registers.
8092 @item -mfp-reg
8093 @itemx -mno-fp-regs
8094 @opindex mfp-reg
8095 @opindex mno-fp-regs
8096 Generate code that uses (does not use) the floating-point register set.
8097 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8098 register set is not used, floating point operands are passed in integer
8099 registers as if they were integers and floating-point results are passed
8100 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8101 so any function with a floating-point argument or return value called by code
8102 compiled with @option{-mno-fp-regs} must also be compiled with that
8103 option.
8105 A typical use of this option is building a kernel that does not use,
8106 and hence need not save and restore, any floating-point registers.
8108 @item -mieee
8109 @opindex mieee
8110 The Alpha architecture implements floating-point hardware optimized for
8111 maximum performance.  It is mostly compliant with the IEEE floating
8112 point standard.  However, for full compliance, software assistance is
8113 required.  This option generates code fully IEEE compliant code
8114 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8115 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8116 defined during compilation.  The resulting code is less efficient but is
8117 able to correctly support denormalized numbers and exceptional IEEE
8118 values such as not-a-number and plus/minus infinity.  Other Alpha
8119 compilers call this option @option{-ieee_with_no_inexact}.
8121 @item -mieee-with-inexact
8122 @opindex mieee-with-inexact
8123 This is like @option{-mieee} except the generated code also maintains
8124 the IEEE @var{inexact-flag}.  Turning on this option causes the
8125 generated code to implement fully-compliant IEEE math.  In addition to
8126 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8127 macro.  On some Alpha implementations the resulting code may execute
8128 significantly slower than the code generated by default.  Since there is
8129 very little code that depends on the @var{inexact-flag}, you should
8130 normally not specify this option.  Other Alpha compilers call this
8131 option @option{-ieee_with_inexact}.
8133 @item -mfp-trap-mode=@var{trap-mode}
8134 @opindex mfp-trap-mode
8135 This option controls what floating-point related traps are enabled.
8136 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8137 The trap mode can be set to one of four values:
8139 @table @samp
8140 @item n
8141 This is the default (normal) setting.  The only traps that are enabled
8142 are the ones that cannot be disabled in software (e.g., division by zero
8143 trap).
8145 @item u
8146 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8147 as well.
8149 @item su
8150 Like @samp{su}, but the instructions are marked to be safe for software
8151 completion (see Alpha architecture manual for details).
8153 @item sui
8154 Like @samp{su}, but inexact traps are enabled as well.
8155 @end table
8157 @item -mfp-rounding-mode=@var{rounding-mode}
8158 @opindex mfp-rounding-mode
8159 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8160 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8163 @table @samp
8164 @item n
8165 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8166 the nearest machine number or towards the even machine number in case
8167 of a tie.
8169 @item m
8170 Round towards minus infinity.
8172 @item c
8173 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8175 @item d
8176 Dynamic rounding mode.  A field in the floating point control register
8177 (@var{fpcr}, see Alpha architecture reference manual) controls the
8178 rounding mode in effect.  The C library initializes this register for
8179 rounding towards plus infinity.  Thus, unless your program modifies the
8180 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8181 @end table
8183 @item -mtrap-precision=@var{trap-precision}
8184 @opindex mtrap-precision
8185 In the Alpha architecture, floating point traps are imprecise.  This
8186 means without software assistance it is impossible to recover from a
8187 floating trap and program execution normally needs to be terminated.
8188 GCC can generate code that can assist operating system trap handlers
8189 in determining the exact location that caused a floating point trap.
8190 Depending on the requirements of an application, different levels of
8191 precisions can be selected:
8193 @table @samp
8194 @item p
8195 Program precision.  This option is the default and means a trap handler
8196 can only identify which program caused a floating point exception.
8198 @item f
8199 Function precision.  The trap handler can determine the function that
8200 caused a floating point exception.
8202 @item i
8203 Instruction precision.  The trap handler can determine the exact
8204 instruction that caused a floating point exception.
8205 @end table
8207 Other Alpha compilers provide the equivalent options called
8208 @option{-scope_safe} and @option{-resumption_safe}.
8210 @item -mieee-conformant
8211 @opindex mieee-conformant
8212 This option marks the generated code as IEEE conformant.  You must not
8213 use this option unless you also specify @option{-mtrap-precision=i} and either
8214 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8215 is to emit the line @samp{.eflag 48} in the function prologue of the
8216 generated assembly file.  Under DEC Unix, this has the effect that
8217 IEEE-conformant math library routines will be linked in.
8219 @item -mbuild-constants
8220 @opindex mbuild-constants
8221 Normally GCC examines a 32- or 64-bit integer constant to
8222 see if it can construct it from smaller constants in two or three
8223 instructions.  If it cannot, it will output the constant as a literal and
8224 generate code to load it from the data segment at runtime.
8226 Use this option to require GCC to construct @emph{all} integer constants
8227 using code, even if it takes more instructions (the maximum is six).
8229 You would typically use this option to build a shared library dynamic
8230 loader.  Itself a shared library, it must relocate itself in memory
8231 before it can find the variables and constants in its own data segment.
8233 @item -malpha-as
8234 @itemx -mgas
8235 @opindex malpha-as
8236 @opindex mgas
8237 Select whether to generate code to be assembled by the vendor-supplied
8238 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8240 @item -mbwx
8241 @itemx -mno-bwx
8242 @itemx -mcix
8243 @itemx -mno-cix
8244 @itemx -mfix
8245 @itemx -mno-fix
8246 @itemx -mmax
8247 @itemx -mno-max
8248 @opindex mbwx
8249 @opindex mno-bwx
8250 @opindex mcix
8251 @opindex mno-cix
8252 @opindex mfix
8253 @opindex mno-fix
8254 @opindex mmax
8255 @opindex mno-max
8256 Indicate whether GCC should generate code to use the optional BWX,
8257 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8258 sets supported by the CPU type specified via @option{-mcpu=} option or that
8259 of the CPU on which GCC was built if none was specified.
8261 @item -mfloat-vax
8262 @itemx -mfloat-ieee
8263 @opindex mfloat-vax
8264 @opindex mfloat-ieee
8265 Generate code that uses (does not use) VAX F and G floating point
8266 arithmetic instead of IEEE single and double precision.
8268 @item -mexplicit-relocs
8269 @itemx -mno-explicit-relocs
8270 @opindex mexplicit-relocs
8271 @opindex mno-explicit-relocs
8272 Older Alpha assemblers provided no way to generate symbol relocations
8273 except via assembler macros.  Use of these macros does not allow
8274 optimal instruction scheduling.  GNU binutils as of version 2.12
8275 supports a new syntax that allows the compiler to explicitly mark
8276 which relocations should apply to which instructions.  This option
8277 is mostly useful for debugging, as GCC detects the capabilities of
8278 the assembler when it is built and sets the default accordingly.
8280 @item -msmall-data
8281 @itemx -mlarge-data
8282 @opindex msmall-data
8283 @opindex mlarge-data
8284 When @option{-mexplicit-relocs} is in effect, static data is
8285 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8286 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8287 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8288 16-bit relocations off of the @code{$gp} register.  This limits the
8289 size of the small data area to 64KB, but allows the variables to be
8290 directly accessed via a single instruction.
8292 The default is @option{-mlarge-data}.  With this option the data area
8293 is limited to just below 2GB@.  Programs that require more than 2GB of
8294 data must use @code{malloc} or @code{mmap} to allocate the data in the
8295 heap instead of in the program's data segment.
8297 When generating code for shared libraries, @option{-fpic} implies
8298 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8300 @item -msmall-text
8301 @itemx -mlarge-text
8302 @opindex msmall-text
8303 @opindex mlarge-text
8304 When @option{-msmall-text} is used, the compiler assumes that the
8305 code of the entire program (or shared library) fits in 4MB, and is
8306 thus reachable with a branch instruction.  When @option{-msmall-data}
8307 is used, the compiler can assume that all local symbols share the
8308 same @code{$gp} value, and thus reduce the number of instructions
8309 required for a function call from 4 to 1.
8311 The default is @option{-mlarge-text}.
8313 @item -mcpu=@var{cpu_type}
8314 @opindex mcpu
8315 Set the instruction set and instruction scheduling parameters for
8316 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8317 style name or the corresponding chip number.  GCC supports scheduling
8318 parameters for the EV4, EV5 and EV6 family of processors and will
8319 choose the default values for the instruction set from the processor
8320 you specify.  If you do not specify a processor type, GCC will default
8321 to the processor on which the compiler was built.
8323 Supported values for @var{cpu_type} are
8325 @table @samp
8326 @item ev4
8327 @itemx ev45
8328 @itemx 21064
8329 Schedules as an EV4 and has no instruction set extensions.
8331 @item ev5
8332 @itemx 21164
8333 Schedules as an EV5 and has no instruction set extensions.
8335 @item ev56
8336 @itemx 21164a
8337 Schedules as an EV5 and supports the BWX extension.
8339 @item pca56
8340 @itemx 21164pc
8341 @itemx 21164PC
8342 Schedules as an EV5 and supports the BWX and MAX extensions.
8344 @item ev6
8345 @itemx 21264
8346 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8348 @item ev67
8349 @itemx 21264a
8350 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8351 @end table
8353 @item -mtune=@var{cpu_type}
8354 @opindex mtune
8355 Set only the instruction scheduling parameters for machine type
8356 @var{cpu_type}.  The instruction set is not changed.
8358 @item -mmemory-latency=@var{time}
8359 @opindex mmemory-latency
8360 Sets the latency the scheduler should assume for typical memory
8361 references as seen by the application.  This number is highly
8362 dependent on the memory access patterns used by the application
8363 and the size of the external cache on the machine.
8365 Valid options for @var{time} are
8367 @table @samp
8368 @item @var{number}
8369 A decimal number representing clock cycles.
8371 @item L1
8372 @itemx L2
8373 @itemx L3
8374 @itemx main
8375 The compiler contains estimates of the number of clock cycles for
8376 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8377 (also called Dcache, Scache, and Bcache), as well as to main memory.
8378 Note that L3 is only valid for EV5.
8380 @end table
8381 @end table
8383 @node DEC Alpha/VMS Options
8384 @subsection DEC Alpha/VMS Options
8386 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8388 @table @gcctabopt
8389 @item -mvms-return-codes
8390 @opindex mvms-return-codes
8391 Return VMS condition codes from main.  The default is to return POSIX
8392 style condition (e.g.@ error) codes.
8393 @end table
8395 @node FRV Options
8396 @subsection FRV Options
8397 @cindex FRV Options
8399 @table @gcctabopt
8400 @item -mgpr-32
8401 @opindex mgpr-32
8403 Only use the first 32 general purpose registers.
8405 @item -mgpr-64
8406 @opindex mgpr-64
8408 Use all 64 general purpose registers.
8410 @item -mfpr-32
8411 @opindex mfpr-32
8413 Use only the first 32 floating point registers.
8415 @item -mfpr-64
8416 @opindex mfpr-64
8418 Use all 64 floating point registers
8420 @item -mhard-float
8421 @opindex mhard-float
8423 Use hardware instructions for floating point operations.
8425 @item -msoft-float
8426 @opindex msoft-float
8428 Use library routines for floating point operations.
8430 @item -malloc-cc
8431 @opindex malloc-cc
8433 Dynamically allocate condition code registers.
8435 @item -mfixed-cc
8436 @opindex mfixed-cc
8438 Do not try to dynamically allocate condition code registers, only
8439 use @code{icc0} and @code{fcc0}.
8441 @item -mdword
8442 @opindex mdword
8444 Change ABI to use double word insns.
8446 @item -mno-dword
8447 @opindex mno-dword
8449 Do not use double word instructions.
8451 @item -mdouble
8452 @opindex mdouble
8454 Use floating point double instructions.
8456 @item -mno-double
8457 @opindex mno-double
8459 Do not use floating point double instructions.
8461 @item -mmedia
8462 @opindex mmedia
8464 Use media instructions.
8466 @item -mno-media
8467 @opindex mno-media
8469 Do not use media instructions.
8471 @item -mmuladd
8472 @opindex mmuladd
8474 Use multiply and add/subtract instructions.
8476 @item -mno-muladd
8477 @opindex mno-muladd
8479 Do not use multiply and add/subtract instructions.
8481 @item -mfdpic
8482 @opindex mfdpic
8484 Select the FDPIC ABI, that uses function descriptors to represent
8485 pointers to functions.  Without any PIC/PIE-related options, it
8486 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8487 assumes GOT entries and small data are within a 12-bit range from the
8488 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8489 are computed with 32 bits.
8491 @item -minline-plt
8492 @opindex minline-plt
8494 Enable inlining of PLT entries in function calls to functions that are
8495 not known to bind locally.  It has no effect without @option{-mfdpic}.
8496 It's enabled by default if optimizing for speed and compiling for
8497 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8498 optimization option such as @option{-O3} or above is present in the
8499 command line.
8501 @item -mTLS
8502 @opindex TLS
8504 Assume a large TLS segment when generating thread-local code.
8506 @item -mtls
8507 @opindex tls
8509 Do not assume a large TLS segment when generating thread-local code.
8511 @item -mgprel-ro
8512 @opindex mgprel-ro
8514 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8515 that is known to be in read-only sections.  It's enabled by default,
8516 except for @option{-fpic} or @option{-fpie}: even though it may help
8517 make the global offset table smaller, it trades 1 instruction for 4.
8518 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8519 one of which may be shared by multiple symbols, and it avoids the need
8520 for a GOT entry for the referenced symbol, so it's more likely to be a
8521 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8523 @item -multilib-library-pic
8524 @opindex multilib-library-pic
8526 Link with the (library, not FD) pic libraries.  It's implied by
8527 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8528 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8529 it explicitly.
8531 @item -mlinked-fp
8532 @opindex mlinked-fp
8534 Follow the EABI requirement of always creating a frame pointer whenever
8535 a stack frame is allocated.  This option is enabled by default and can
8536 be disabled with @option{-mno-linked-fp}.
8538 @item -mlong-calls
8539 @opindex mlong-calls
8541 Use indirect addressing to call functions outside the current
8542 compilation unit.  This allows the functions to be placed anywhere
8543 within the 32-bit address space.
8545 @item -malign-labels
8546 @opindex malign-labels
8548 Try to align labels to an 8-byte boundary by inserting nops into the
8549 previous packet.  This option only has an effect when VLIW packing
8550 is enabled.  It doesn't create new packets; it merely adds nops to
8551 existing ones.
8553 @item -mlibrary-pic
8554 @opindex mlibrary-pic
8556 Generate position-independent EABI code.
8558 @item -macc-4
8559 @opindex macc-4
8561 Use only the first four media accumulator registers.
8563 @item -macc-8
8564 @opindex macc-8
8566 Use all eight media accumulator registers.
8568 @item -mpack
8569 @opindex mpack
8571 Pack VLIW instructions.
8573 @item -mno-pack
8574 @opindex mno-pack
8576 Do not pack VLIW instructions.
8578 @item -mno-eflags
8579 @opindex mno-eflags
8581 Do not mark ABI switches in e_flags.
8583 @item -mcond-move
8584 @opindex mcond-move
8586 Enable the use of conditional-move instructions (default).
8588 This switch is mainly for debugging the compiler and will likely be removed
8589 in a future version.
8591 @item -mno-cond-move
8592 @opindex mno-cond-move
8594 Disable the use of conditional-move instructions.
8596 This switch is mainly for debugging the compiler and will likely be removed
8597 in a future version.
8599 @item -mscc
8600 @opindex mscc
8602 Enable the use of conditional set instructions (default).
8604 This switch is mainly for debugging the compiler and will likely be removed
8605 in a future version.
8607 @item -mno-scc
8608 @opindex mno-scc
8610 Disable the use of conditional set instructions.
8612 This switch is mainly for debugging the compiler and will likely be removed
8613 in a future version.
8615 @item -mcond-exec
8616 @opindex mcond-exec
8618 Enable the use of conditional execution (default).
8620 This switch is mainly for debugging the compiler and will likely be removed
8621 in a future version.
8623 @item -mno-cond-exec
8624 @opindex mno-cond-exec
8626 Disable the use of conditional execution.
8628 This switch is mainly for debugging the compiler and will likely be removed
8629 in a future version.
8631 @item -mvliw-branch
8632 @opindex mvliw-branch
8634 Run a pass to pack branches into VLIW instructions (default).
8636 This switch is mainly for debugging the compiler and will likely be removed
8637 in a future version.
8639 @item -mno-vliw-branch
8640 @opindex mno-vliw-branch
8642 Do not run a pass to pack branches into VLIW instructions.
8644 This switch is mainly for debugging the compiler and will likely be removed
8645 in a future version.
8647 @item -mmulti-cond-exec
8648 @opindex mmulti-cond-exec
8650 Enable optimization of @code{&&} and @code{||} in conditional execution
8651 (default).
8653 This switch is mainly for debugging the compiler and will likely be removed
8654 in a future version.
8656 @item -mno-multi-cond-exec
8657 @opindex mno-multi-cond-exec
8659 Disable optimization of @code{&&} and @code{||} in conditional execution.
8661 This switch is mainly for debugging the compiler and will likely be removed
8662 in a future version.
8664 @item -mnested-cond-exec
8665 @opindex mnested-cond-exec
8667 Enable nested conditional execution optimizations (default).
8669 This switch is mainly for debugging the compiler and will likely be removed
8670 in a future version.
8672 @item -mno-nested-cond-exec
8673 @opindex mno-nested-cond-exec
8675 Disable nested conditional execution optimizations.
8677 This switch is mainly for debugging the compiler and will likely be removed
8678 in a future version.
8680 @item -moptimize-membar
8681 @opindex moptimize-membar
8683 This switch removes redundant @code{membar} instructions from the
8684 compiler generated code.  It is enabled by default.
8686 @item -mno-optimize-membar
8687 @opindex mno-optimize-membar
8689 This switch disables the automatic removal of redundant @code{membar}
8690 instructions from the generated code.
8692 @item -mtomcat-stats
8693 @opindex mtomcat-stats
8695 Cause gas to print out tomcat statistics.
8697 @item -mcpu=@var{cpu}
8698 @opindex mcpu
8700 Select the processor type for which to generate code.  Possible values are
8701 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8702 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8704 @end table
8706 @node H8/300 Options
8707 @subsection H8/300 Options
8709 These @samp{-m} options are defined for the H8/300 implementations:
8711 @table @gcctabopt
8712 @item -mrelax
8713 @opindex mrelax
8714 Shorten some address references at link time, when possible; uses the
8715 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8716 ld, Using ld}, for a fuller description.
8718 @item -mh
8719 @opindex mh
8720 Generate code for the H8/300H@.
8722 @item -ms
8723 @opindex ms
8724 Generate code for the H8S@.
8726 @item -mn
8727 @opindex mn
8728 Generate code for the H8S and H8/300H in the normal mode.  This switch
8729 must be used either with @option{-mh} or @option{-ms}.
8731 @item -ms2600
8732 @opindex ms2600
8733 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8735 @item -mint32
8736 @opindex mint32
8737 Make @code{int} data 32 bits by default.
8739 @item -malign-300
8740 @opindex malign-300
8741 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8742 The default for the H8/300H and H8S is to align longs and floats on 4
8743 byte boundaries.
8744 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8745 This option has no effect on the H8/300.
8746 @end table
8748 @node HPPA Options
8749 @subsection HPPA Options
8750 @cindex HPPA Options
8752 These @samp{-m} options are defined for the HPPA family of computers:
8754 @table @gcctabopt
8755 @item -march=@var{architecture-type}
8756 @opindex march
8757 Generate code for the specified architecture.  The choices for
8758 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8759 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8760 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8761 architecture option for your machine.  Code compiled for lower numbered
8762 architectures will run on higher numbered architectures, but not the
8763 other way around.
8765 @item -mpa-risc-1-0
8766 @itemx -mpa-risc-1-1
8767 @itemx -mpa-risc-2-0
8768 @opindex mpa-risc-1-0
8769 @opindex mpa-risc-1-1
8770 @opindex mpa-risc-2-0
8771 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8773 @item -mbig-switch
8774 @opindex mbig-switch
8775 Generate code suitable for big switch tables.  Use this option only if
8776 the assembler/linker complain about out of range branches within a switch
8777 table.
8779 @item -mjump-in-delay
8780 @opindex mjump-in-delay
8781 Fill delay slots of function calls with unconditional jump instructions
8782 by modifying the return pointer for the function call to be the target
8783 of the conditional jump.
8785 @item -mdisable-fpregs
8786 @opindex mdisable-fpregs
8787 Prevent floating point registers from being used in any manner.  This is
8788 necessary for compiling kernels which perform lazy context switching of
8789 floating point registers.  If you use this option and attempt to perform
8790 floating point operations, the compiler will abort.
8792 @item -mdisable-indexing
8793 @opindex mdisable-indexing
8794 Prevent the compiler from using indexing address modes.  This avoids some
8795 rather obscure problems when compiling MIG generated code under MACH@.
8797 @item -mno-space-regs
8798 @opindex mno-space-regs
8799 Generate code that assumes the target has no space registers.  This allows
8800 GCC to generate faster indirect calls and use unscaled index address modes.
8802 Such code is suitable for level 0 PA systems and kernels.
8804 @item -mfast-indirect-calls
8805 @opindex mfast-indirect-calls
8806 Generate code that assumes calls never cross space boundaries.  This
8807 allows GCC to emit code which performs faster indirect calls.
8809 This option will not work in the presence of shared libraries or nested
8810 functions.
8812 @item -mfixed-range=@var{register-range}
8813 @opindex mfixed-range
8814 Generate code treating the given register range as fixed registers.
8815 A fixed register is one that the register allocator can not use.  This is
8816 useful when compiling kernel code.  A register range is specified as
8817 two registers separated by a dash.  Multiple register ranges can be
8818 specified separated by a comma.
8820 @item -mlong-load-store
8821 @opindex mlong-load-store
8822 Generate 3-instruction load and store sequences as sometimes required by
8823 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8824 the HP compilers.
8826 @item -mportable-runtime
8827 @opindex mportable-runtime
8828 Use the portable calling conventions proposed by HP for ELF systems.
8830 @item -mgas
8831 @opindex mgas
8832 Enable the use of assembler directives only GAS understands.
8834 @item -mschedule=@var{cpu-type}
8835 @opindex mschedule
8836 Schedule code according to the constraints for the machine type
8837 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8838 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8839 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8840 proper scheduling option for your machine.  The default scheduling is
8841 @samp{8000}.
8843 @item -mlinker-opt
8844 @opindex mlinker-opt
8845 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8846 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8847 linkers in which they give bogus error messages when linking some programs.
8849 @item -msoft-float
8850 @opindex msoft-float
8851 Generate output containing library calls for floating point.
8852 @strong{Warning:} the requisite libraries are not available for all HPPA
8853 targets.  Normally the facilities of the machine's usual C compiler are
8854 used, but this cannot be done directly in cross-compilation.  You must make
8855 your own arrangements to provide suitable library functions for
8856 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8857 does provide software floating point support.
8859 @option{-msoft-float} changes the calling convention in the output file;
8860 therefore, it is only useful if you compile @emph{all} of a program with
8861 this option.  In particular, you need to compile @file{libgcc.a}, the
8862 library that comes with GCC, with @option{-msoft-float} in order for
8863 this to work.
8865 @item -msio
8866 @opindex msio
8867 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8868 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8869 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8870 options are available under HP-UX and HI-UX@.
8872 @item -mgnu-ld
8873 @opindex gnu-ld
8874 Use GNU ld specific options.  This passes @option{-shared} to ld when
8875 building a shared library.  It is the default when GCC is configured,
8876 explicitly or implicitly, with the GNU linker.  This option does not
8877 have any affect on which ld is called, it only changes what parameters
8878 are passed to that ld.  The ld that is called is determined by the
8879 @option{--with-ld} configure option, GCC's program search path, and
8880 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8881 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8882 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8884 @item -mhp-ld
8885 @opindex hp-ld
8886 Use HP ld specific options.  This passes @option{-b} to ld when building
8887 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8888 links.  It is the default when GCC is configured, explicitly or
8889 implicitly, with the HP linker.  This option does not have any affect on
8890 which ld is called, it only changes what parameters are passed to that
8891 ld.  The ld that is called is determined by the @option{--with-ld}
8892 configure option, GCC's program search path, and finally by the user's
8893 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8894 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8895 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8897 @item -mlong-calls
8898 @opindex mno-long-calls
8899 Generate code that uses long call sequences.  This ensures that a call
8900 is always able to reach linker generated stubs.  The default is to generate
8901 long calls only when the distance from the call site to the beginning
8902 of the function or translation unit, as the case may be, exceeds a
8903 predefined limit set by the branch type being used.  The limits for
8904 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8905 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8906 240,000 bytes.
8908 Distances are measured from the beginning of functions when using the
8909 @option{-ffunction-sections} option, or when using the @option{-mgas}
8910 and @option{-mno-portable-runtime} options together under HP-UX with
8911 the SOM linker.
8913 It is normally not desirable to use this option as it will degrade
8914 performance.  However, it may be useful in large applications,
8915 particularly when partial linking is used to build the application.
8917 The types of long calls used depends on the capabilities of the
8918 assembler and linker, and the type of code being generated.  The
8919 impact on systems that support long absolute calls, and long pic
8920 symbol-difference or pc-relative calls should be relatively small.
8921 However, an indirect call is used on 32-bit ELF systems in pic code
8922 and it is quite long.
8924 @item -munix=@var{unix-std}
8925 @opindex march
8926 Generate compiler predefines and select a startfile for the specified
8927 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8928 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8929 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8930 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8931 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8932 and later.
8934 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8935 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8936 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8937 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8938 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8939 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8941 It is @emph{important} to note that this option changes the interfaces
8942 for various library routines.  It also affects the operational behavior
8943 of the C library.  Thus, @emph{extreme} care is needed in using this
8944 option.
8946 Library code that is intended to operate with more than one UNIX
8947 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8948 as appropriate.  Most GNU software doesn't provide this capability.
8950 @item -nolibdld
8951 @opindex nolibdld
8952 Suppress the generation of link options to search libdld.sl when the
8953 @option{-static} option is specified on HP-UX 10 and later.
8955 @item -static
8956 @opindex static
8957 The HP-UX implementation of setlocale in libc has a dependency on
8958 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8959 when the @option{-static} option is specified, special link options
8960 are needed to resolve this dependency.
8962 On HP-UX 10 and later, the GCC driver adds the necessary options to
8963 link with libdld.sl when the @option{-static} option is specified.
8964 This causes the resulting binary to be dynamic.  On the 64-bit port,
8965 the linkers generate dynamic binaries by default in any case.  The
8966 @option{-nolibdld} option can be used to prevent the GCC driver from
8967 adding these link options.
8969 @item -threads
8970 @opindex threads
8971 Add support for multithreading with the @dfn{dce thread} library
8972 under HP-UX@.  This option sets flags for both the preprocessor and
8973 linker.
8974 @end table
8976 @node i386 and x86-64 Options
8977 @subsection Intel 386 and AMD x86-64 Options
8978 @cindex i386 Options
8979 @cindex x86-64 Options
8980 @cindex Intel 386 Options
8981 @cindex AMD x86-64 Options
8983 These @samp{-m} options are defined for the i386 and x86-64 family of
8984 computers:
8986 @table @gcctabopt
8987 @item -mtune=@var{cpu-type}
8988 @opindex mtune
8989 Tune to @var{cpu-type} everything applicable about the generated code, except
8990 for the ABI and the set of available instructions.  The choices for
8991 @var{cpu-type} are:
8992 @table @emph
8993 @item i386
8994 Original Intel's i386 CPU@.
8995 @item i486
8996 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8997 @item i586, pentium
8998 Intel Pentium CPU with no MMX support.
8999 @item pentium-mmx
9000 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9001 @item i686, pentiumpro
9002 Intel PentiumPro CPU@.
9003 @item pentium2
9004 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9005 @item pentium3, pentium3m
9006 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9007 support.
9008 @item pentium-m
9009 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9010 support.  Used by Centrino notebooks.
9011 @item pentium4, pentium4m
9012 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9013 @item prescott
9014 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9015 set support.
9016 @item nocona
9017 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9018 SSE2 and SSE3 instruction set support.
9019 @item k6
9020 AMD K6 CPU with MMX instruction set support.
9021 @item k6-2, k6-3
9022 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9023 @item athlon, athlon-tbird
9024 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9025 support.
9026 @item athlon-4, athlon-xp, athlon-mp
9027 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9028 instruction set support.
9029 @item k8, opteron, athlon64, athlon-fx
9030 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9031 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9032 @item winchip-c6
9033 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9034 set support.
9035 @item winchip2
9036 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9037 instruction set support.
9038 @item c3
9039 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9040 implemented for this chip.)
9041 @item c3-2
9042 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9043 implemented for this chip.)
9044 @end table
9046 While picking a specific @var{cpu-type} will schedule things appropriately
9047 for that particular chip, the compiler will not generate any code that
9048 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9049 being used.
9051 @item -march=@var{cpu-type}
9052 @opindex march
9053 Generate instructions for the machine type @var{cpu-type}.  The choices
9054 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9055 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9057 @item -mcpu=@var{cpu-type}
9058 @opindex mcpu
9059 A deprecated synonym for @option{-mtune}.
9061 @item -m386
9062 @itemx -m486
9063 @itemx -mpentium
9064 @itemx -mpentiumpro
9065 @opindex m386
9066 @opindex m486
9067 @opindex mpentium
9068 @opindex mpentiumpro
9069 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9070 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9071 These synonyms are deprecated.
9073 @item -mfpmath=@var{unit}
9074 @opindex march
9075 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9076 for @var{unit} are:
9078 @table @samp
9079 @item 387
9080 Use the standard 387 floating point coprocessor present majority of chips and
9081 emulated otherwise.  Code compiled with this option will run almost everywhere.
9082 The temporary results are computed in 80bit precision instead of precision
9083 specified by the type resulting in slightly different results compared to most
9084 of other chips.  See @option{-ffloat-store} for more detailed description.
9086 This is the default choice for i386 compiler.
9088 @item sse
9089 Use scalar floating point instructions present in the SSE instruction set.
9090 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9091 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9092 instruction set supports only single precision arithmetics, thus the double and
9093 extended precision arithmetics is still done using 387.  Later version, present
9094 only in Pentium4 and the future AMD x86-64 chips supports double precision
9095 arithmetics too.
9097 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9098 or @option{-msse2} switches to enable SSE extensions and make this option
9099 effective.  For the x86-64 compiler, these extensions are enabled by default.
9101 The resulting code should be considerably faster in the majority of cases and avoid
9102 the numerical instability problems of 387 code, but may break some existing
9103 code that expects temporaries to be 80bit.
9105 This is the default choice for the x86-64 compiler.
9107 @item sse,387
9108 Attempt to utilize both instruction sets at once.  This effectively double the
9109 amount of available registers and on chips with separate execution units for
9110 387 and SSE the execution resources too.  Use this option with care, as it is
9111 still experimental, because the GCC register allocator does not model separate
9112 functional units well resulting in instable performance.
9113 @end table
9115 @item -masm=@var{dialect}
9116 @opindex masm=@var{dialect}
9117 Output asm instructions using selected @var{dialect}.  Supported
9118 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9119 not support @samp{intel}.
9121 @item -mieee-fp
9122 @itemx -mno-ieee-fp
9123 @opindex mieee-fp
9124 @opindex mno-ieee-fp
9125 Control whether or not the compiler uses IEEE floating point
9126 comparisons.  These handle correctly the case where the result of a
9127 comparison is unordered.
9129 @item -msoft-float
9130 @opindex msoft-float
9131 Generate output containing library calls for floating point.
9132 @strong{Warning:} the requisite libraries are not part of GCC@.
9133 Normally the facilities of the machine's usual C compiler are used, but
9134 this can't be done directly in cross-compilation.  You must make your
9135 own arrangements to provide suitable library functions for
9136 cross-compilation.
9138 On machines where a function returns floating point results in the 80387
9139 register stack, some floating point opcodes may be emitted even if
9140 @option{-msoft-float} is used.
9142 @item -mno-fp-ret-in-387
9143 @opindex mno-fp-ret-in-387
9144 Do not use the FPU registers for return values of functions.
9146 The usual calling convention has functions return values of types
9147 @code{float} and @code{double} in an FPU register, even if there
9148 is no FPU@.  The idea is that the operating system should emulate
9149 an FPU@.
9151 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9152 in ordinary CPU registers instead.
9154 @item -mno-fancy-math-387
9155 @opindex mno-fancy-math-387
9156 Some 387 emulators do not support the @code{sin}, @code{cos} and
9157 @code{sqrt} instructions for the 387.  Specify this option to avoid
9158 generating those instructions.  This option is the default on FreeBSD,
9159 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9160 indicates that the target cpu will always have an FPU and so the
9161 instruction will not need emulation.  As of revision 2.6.1, these
9162 instructions are not generated unless you also use the
9163 @option{-funsafe-math-optimizations} switch.
9165 @item -malign-double
9166 @itemx -mno-align-double
9167 @opindex malign-double
9168 @opindex mno-align-double
9169 Control whether GCC aligns @code{double}, @code{long double}, and
9170 @code{long long} variables on a two word boundary or a one word
9171 boundary.  Aligning @code{double} variables on a two word boundary will
9172 produce code that runs somewhat faster on a @samp{Pentium} at the
9173 expense of more memory.
9175 @strong{Warning:} if you use the @option{-malign-double} switch,
9176 structures containing the above types will be aligned differently than
9177 the published application binary interface specifications for the 386
9178 and will not be binary compatible with structures in code compiled
9179 without that switch.
9181 @item -m96bit-long-double
9182 @itemx -m128bit-long-double
9183 @opindex m96bit-long-double
9184 @opindex m128bit-long-double
9185 These switches control the size of @code{long double} type.  The i386
9186 application binary interface specifies the size to be 96 bits,
9187 so @option{-m96bit-long-double} is the default in 32 bit mode.
9189 Modern architectures (Pentium and newer) would prefer @code{long double}
9190 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9191 conforming to the ABI, this would not be possible.  So specifying a
9192 @option{-m128bit-long-double} will align @code{long double}
9193 to a 16 byte boundary by padding the @code{long double} with an additional
9194 32 bit zero.
9196 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9197 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9199 Notice that neither of these options enable any extra precision over the x87
9200 standard of 80 bits for a @code{long double}.
9202 @strong{Warning:} if you override the default value for your target ABI, the
9203 structures and arrays containing @code{long double} variables will change
9204 their size as well as function calling convention for function taking
9205 @code{long double} will be modified.  Hence they will not be binary
9206 compatible with arrays or structures in code compiled without that switch.
9208 @item -mmlarge-data-threshold=@var{number}
9209 @opindex mlarge-data-threshold=@var{number}
9210 When @option{-mcmodel=medium} is specified, the data greater than
9211 @var{threshold} are placed in large data section.  This value must be the
9212 same across all object linked into the binary and defaults to 65535.
9214 @item -msvr3-shlib
9215 @itemx -mno-svr3-shlib
9216 @opindex msvr3-shlib
9217 @opindex mno-svr3-shlib
9218 Control whether GCC places uninitialized local variables into the
9219 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9220 into @code{bss}.  These options are meaningful only on System V Release 3.
9222 @item -mrtd
9223 @opindex mrtd
9224 Use a different function-calling convention, in which functions that
9225 take a fixed number of arguments return with the @code{ret} @var{num}
9226 instruction, which pops their arguments while returning.  This saves one
9227 instruction in the caller since there is no need to pop the arguments
9228 there.
9230 You can specify that an individual function is called with this calling
9231 sequence with the function attribute @samp{stdcall}.  You can also
9232 override the @option{-mrtd} option by using the function attribute
9233 @samp{cdecl}.  @xref{Function Attributes}.
9235 @strong{Warning:} this calling convention is incompatible with the one
9236 normally used on Unix, so you cannot use it if you need to call
9237 libraries compiled with the Unix compiler.
9239 Also, you must provide function prototypes for all functions that
9240 take variable numbers of arguments (including @code{printf});
9241 otherwise incorrect code will be generated for calls to those
9242 functions.
9244 In addition, seriously incorrect code will result if you call a
9245 function with too many arguments.  (Normally, extra arguments are
9246 harmlessly ignored.)
9248 @item -mregparm=@var{num}
9249 @opindex mregparm
9250 Control how many registers are used to pass integer arguments.  By
9251 default, no registers are used to pass arguments, and at most 3
9252 registers can be used.  You can control this behavior for a specific
9253 function by using the function attribute @samp{regparm}.
9254 @xref{Function Attributes}.
9256 @strong{Warning:} if you use this switch, and
9257 @var{num} is nonzero, then you must build all modules with the same
9258 value, including any libraries.  This includes the system libraries and
9259 startup modules.
9261 @item -msseregparm
9262 @opindex msseregparm
9263 Use SSE register passing conventions for float and double arguments
9264 and return values.  You can control this behavior for a specific
9265 function by using the function attribute @samp{sseregparm}.
9266 @xref{Function Attributes}.
9268 @strong{Warning:} if you use this switch then you must build all
9269 modules with the same value, including any libraries.  This includes
9270 the system libraries and startup modules.
9272 @item -mpreferred-stack-boundary=@var{num}
9273 @opindex mpreferred-stack-boundary
9274 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9275 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9276 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9277 size (@option{-Os}), in which case the default is the minimum correct
9278 alignment (4 bytes for x86, and 8 bytes for x86-64).
9280 On Pentium and PentiumPro, @code{double} and @code{long double} values
9281 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9282 suffer significant run time performance penalties.  On Pentium III, the
9283 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9284 penalties if it is not 16 byte aligned.
9286 To ensure proper alignment of this values on the stack, the stack boundary
9287 must be as aligned as that required by any value stored on the stack.
9288 Further, every function must be generated such that it keeps the stack
9289 aligned.  Thus calling a function compiled with a higher preferred
9290 stack boundary from a function compiled with a lower preferred stack
9291 boundary will most likely misalign the stack.  It is recommended that
9292 libraries that use callbacks always use the default setting.
9294 This extra alignment does consume extra stack space, and generally
9295 increases code size.  Code that is sensitive to stack space usage, such
9296 as embedded systems and operating system kernels, may want to reduce the
9297 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9299 @item -mmmx
9300 @itemx -mno-mmx
9301 @item -msse
9302 @itemx -mno-sse
9303 @item -msse2
9304 @itemx -mno-sse2
9305 @item -msse3
9306 @itemx -mno-sse3
9307 @item -m3dnow
9308 @itemx -mno-3dnow
9309 @opindex mmmx
9310 @opindex mno-mmx
9311 @opindex msse
9312 @opindex mno-sse
9313 @opindex m3dnow
9314 @opindex mno-3dnow
9315 These switches enable or disable the use of instructions in the MMX,
9316 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9317 also available as built-in functions: see @ref{X86 Built-in Functions},
9318 for details of the functions enabled and disabled by these switches.
9320 To have SSE/SSE2 instructions generated automatically from floating-point
9321 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9323 These options will enable GCC to use these extended instructions in
9324 generated code, even without @option{-mfpmath=sse}.  Applications which
9325 perform runtime CPU detection must compile separate files for each
9326 supported architecture, using the appropriate flags.  In particular,
9327 the file containing the CPU detection code should be compiled without
9328 these options.
9330 @item -mpush-args
9331 @itemx -mno-push-args
9332 @opindex mpush-args
9333 @opindex mno-push-args
9334 Use PUSH operations to store outgoing parameters.  This method is shorter
9335 and usually equally fast as method using SUB/MOV operations and is enabled
9336 by default.  In some cases disabling it may improve performance because of
9337 improved scheduling and reduced dependencies.
9339 @item -maccumulate-outgoing-args
9340 @opindex maccumulate-outgoing-args
9341 If enabled, the maximum amount of space required for outgoing arguments will be
9342 computed in the function prologue.  This is faster on most modern CPUs
9343 because of reduced dependencies, improved scheduling and reduced stack usage
9344 when preferred stack boundary is not equal to 2.  The drawback is a notable
9345 increase in code size.  This switch implies @option{-mno-push-args}.
9347 @item -mthreads
9348 @opindex mthreads
9349 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9350 on thread-safe exception handling must compile and link all code with the
9351 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9352 @option{-D_MT}; when linking, it links in a special thread helper library
9353 @option{-lmingwthrd} which cleans up per thread exception handling data.
9355 @item -mno-align-stringops
9356 @opindex mno-align-stringops
9357 Do not align destination of inlined string operations.  This switch reduces
9358 code size and improves performance in case the destination is already aligned,
9359 but GCC doesn't know about it.
9361 @item -minline-all-stringops
9362 @opindex minline-all-stringops
9363 By default GCC inlines string operations only when destination is known to be
9364 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9365 size, but may improve performance of code that depends on fast memcpy, strlen
9366 and memset for short lengths.
9368 @item -momit-leaf-frame-pointer
9369 @opindex momit-leaf-frame-pointer
9370 Don't keep the frame pointer in a register for leaf functions.  This
9371 avoids the instructions to save, set up and restore frame pointers and
9372 makes an extra register available in leaf functions.  The option
9373 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9374 which might make debugging harder.
9376 @item -mtls-direct-seg-refs
9377 @itemx -mno-tls-direct-seg-refs
9378 @opindex mtls-direct-seg-refs
9379 Controls whether TLS variables may be accessed with offsets from the
9380 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9381 or whether the thread base pointer must be added.  Whether or not this
9382 is legal depends on the operating system, and whether it maps the
9383 segment to cover the entire TLS area.
9385 For systems that use GNU libc, the default is on.
9386 @end table
9388 These @samp{-m} switches are supported in addition to the above
9389 on AMD x86-64 processors in 64-bit environments.
9391 @table @gcctabopt
9392 @item -m32
9393 @itemx -m64
9394 @opindex m32
9395 @opindex m64
9396 Generate code for a 32-bit or 64-bit environment.
9397 The 32-bit environment sets int, long and pointer to 32 bits and
9398 generates code that runs on any i386 system.
9399 The 64-bit environment sets int to 32 bits and long and pointer
9400 to 64 bits and generates code for AMD's x86-64 architecture.
9402 @item -mno-red-zone
9403 @opindex no-red-zone
9404 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9405 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9406 stack pointer that will not be modified by signal or interrupt handlers
9407 and therefore can be used for temporary data without adjusting the stack
9408 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9410 @item -mcmodel=small
9411 @opindex mcmodel=small
9412 Generate code for the small code model: the program and its symbols must
9413 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9414 Programs can be statically or dynamically linked.  This is the default
9415 code model.
9417 @item -mcmodel=kernel
9418 @opindex mcmodel=kernel
9419 Generate code for the kernel code model.  The kernel runs in the
9420 negative 2 GB of the address space.
9421 This model has to be used for Linux kernel code.
9423 @item -mcmodel=medium
9424 @opindex mcmodel=medium
9425 Generate code for the medium model: The program is linked in the lower 2
9426 GB of the address space but symbols can be located anywhere in the
9427 address space.  Programs can be statically or dynamically linked, but
9428 building of shared libraries are not supported with the medium model.
9430 @item -mcmodel=large
9431 @opindex mcmodel=large
9432 Generate code for the large model: This model makes no assumptions
9433 about addresses and sizes of sections.  Currently GCC does not implement
9434 this model.
9435 @end table
9437 @node IA-64 Options
9438 @subsection IA-64 Options
9439 @cindex IA-64 Options
9441 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9443 @table @gcctabopt
9444 @item -mbig-endian
9445 @opindex mbig-endian
9446 Generate code for a big endian target.  This is the default for HP-UX@.
9448 @item -mlittle-endian
9449 @opindex mlittle-endian
9450 Generate code for a little endian target.  This is the default for AIX5
9451 and GNU/Linux.
9453 @item -mgnu-as
9454 @itemx -mno-gnu-as
9455 @opindex mgnu-as
9456 @opindex mno-gnu-as
9457 Generate (or don't) code for the GNU assembler.  This is the default.
9458 @c Also, this is the default if the configure option @option{--with-gnu-as}
9459 @c is used.
9461 @item -mgnu-ld
9462 @itemx -mno-gnu-ld
9463 @opindex mgnu-ld
9464 @opindex mno-gnu-ld
9465 Generate (or don't) code for the GNU linker.  This is the default.
9466 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9467 @c is used.
9469 @item -mno-pic
9470 @opindex mno-pic
9471 Generate code that does not use a global pointer register.  The result
9472 is not position independent code, and violates the IA-64 ABI@.
9474 @item -mvolatile-asm-stop
9475 @itemx -mno-volatile-asm-stop
9476 @opindex mvolatile-asm-stop
9477 @opindex mno-volatile-asm-stop
9478 Generate (or don't) a stop bit immediately before and after volatile asm
9479 statements.
9481 @item -mregister-names
9482 @itemx -mno-register-names
9483 @opindex mregister-names
9484 @opindex mno-register-names
9485 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9486 the stacked registers.  This may make assembler output more readable.
9488 @item -mno-sdata
9489 @itemx -msdata
9490 @opindex mno-sdata
9491 @opindex msdata
9492 Disable (or enable) optimizations that use the small data section.  This may
9493 be useful for working around optimizer bugs.
9495 @item -mconstant-gp
9496 @opindex mconstant-gp
9497 Generate code that uses a single constant global pointer value.  This is
9498 useful when compiling kernel code.
9500 @item -mauto-pic
9501 @opindex mauto-pic
9502 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9503 This is useful when compiling firmware code.
9505 @item -minline-float-divide-min-latency
9506 @opindex minline-float-divide-min-latency
9507 Generate code for inline divides of floating point values
9508 using the minimum latency algorithm.
9510 @item -minline-float-divide-max-throughput
9511 @opindex minline-float-divide-max-throughput
9512 Generate code for inline divides of floating point values
9513 using the maximum throughput algorithm.
9515 @item -minline-int-divide-min-latency
9516 @opindex minline-int-divide-min-latency
9517 Generate code for inline divides of integer values
9518 using the minimum latency algorithm.
9520 @item -minline-int-divide-max-throughput
9521 @opindex minline-int-divide-max-throughput
9522 Generate code for inline divides of integer values
9523 using the maximum throughput algorithm.
9525 @item -minline-sqrt-min-latency
9526 @opindex minline-sqrt-min-latency
9527 Generate code for inline square roots
9528 using the minimum latency algorithm.
9530 @item -minline-sqrt-max-throughput
9531 @opindex minline-sqrt-max-throughput
9532 Generate code for inline square roots
9533 using the maximum throughput algorithm.
9535 @item -mno-dwarf2-asm
9536 @itemx -mdwarf2-asm
9537 @opindex mno-dwarf2-asm
9538 @opindex mdwarf2-asm
9539 Don't (or do) generate assembler code for the DWARF2 line number debugging
9540 info.  This may be useful when not using the GNU assembler.
9542 @item -mearly-stop-bits
9543 @itemx -mno-early-stop-bits
9544 @opindex mearly-stop-bits
9545 @opindex mno-early-stop-bits
9546 Allow stop bits to be placed earlier than immediately preceding the
9547 instruction that triggered the stop bit.  This can improve instruction
9548 scheduling, but does not always do so.
9550 @item -mfixed-range=@var{register-range}
9551 @opindex mfixed-range
9552 Generate code treating the given register range as fixed registers.
9553 A fixed register is one that the register allocator can not use.  This is
9554 useful when compiling kernel code.  A register range is specified as
9555 two registers separated by a dash.  Multiple register ranges can be
9556 specified separated by a comma.
9558 @item -mtls-size=@var{tls-size}
9559 @opindex mtls-size
9560 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9563 @item -mtune=@var{cpu-type}
9564 @opindex mtune
9565 Tune the instruction scheduling for a particular CPU, Valid values are
9566 itanium, itanium1, merced, itanium2, and mckinley.
9568 @item -mt
9569 @itemx -pthread
9570 @opindex mt
9571 @opindex pthread
9572 Add support for multithreading using the POSIX threads library.  This
9573 option sets flags for both the preprocessor and linker.  It does
9574 not affect the thread safety of object code produced by the compiler or
9575 that of libraries supplied with it.  These are HP-UX specific flags.
9577 @item -milp32
9578 @itemx -mlp64
9579 @opindex milp32
9580 @opindex mlp64
9581 Generate code for a 32-bit or 64-bit environment.
9582 The 32-bit environment sets int, long and pointer to 32 bits.
9583 The 64-bit environment sets int to 32 bits and long and pointer
9584 to 64 bits.  These are HP-UX specific flags.
9586 @end table
9588 @node M32C Options
9589 @subsection M32C Options
9590 @cindex M32C options
9592 @table @gcctabopt
9593 @item -mcpu=@var{name}
9594 @opindex mcpu=
9595 Select the CPU for which code is generated.  @var{name} may be one of
9596 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9597 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9598 the M32C/80 series.
9600 @item -msim
9601 @opindex msim
9602 Specifies that the program will be run on the simulator.  This causes
9603 an alternate runtime library to be linked in which supports, for
9604 example, file I/O.  You must not use this option when generating
9605 programs that will run on real hardware; you must provide your own
9606 runtime library for whatever I/O functions are needed.
9608 @item -memregs=@var{number}
9609 @opindex memregs=
9610 Specifies the number of memory-based pseudo-registers GCC will use
9611 during code generation.  These pseudo-registers will be used like real
9612 registers, so there is a tradeoff between GCC's ability to fit the
9613 code into available registers, and the performance penalty of using
9614 memory instead of registers.  Note that all modules in a program must
9615 be compiled with the same value for this option.  Because of that, you
9616 must not use this option with the default runtime libraries gcc
9617 builds.
9619 @end table
9621 @node M32R/D Options
9622 @subsection M32R/D Options
9623 @cindex M32R/D options
9625 These @option{-m} options are defined for Renesas M32R/D architectures:
9627 @table @gcctabopt
9628 @item -m32r2
9629 @opindex m32r2
9630 Generate code for the M32R/2@.
9632 @item -m32rx
9633 @opindex m32rx
9634 Generate code for the M32R/X@.
9636 @item -m32r
9637 @opindex m32r
9638 Generate code for the M32R@.  This is the default.
9640 @item -mmodel=small
9641 @opindex mmodel=small
9642 Assume all objects live in the lower 16MB of memory (so that their addresses
9643 can be loaded with the @code{ld24} instruction), and assume all subroutines
9644 are reachable with the @code{bl} instruction.
9645 This is the default.
9647 The addressability of a particular object can be set with the
9648 @code{model} attribute.
9650 @item -mmodel=medium
9651 @opindex mmodel=medium
9652 Assume objects may be anywhere in the 32-bit address space (the compiler
9653 will generate @code{seth/add3} instructions to load their addresses), and
9654 assume all subroutines are reachable with the @code{bl} instruction.
9656 @item -mmodel=large
9657 @opindex mmodel=large
9658 Assume objects may be anywhere in the 32-bit address space (the compiler
9659 will generate @code{seth/add3} instructions to load their addresses), and
9660 assume subroutines may not be reachable with the @code{bl} instruction
9661 (the compiler will generate the much slower @code{seth/add3/jl}
9662 instruction sequence).
9664 @item -msdata=none
9665 @opindex msdata=none
9666 Disable use of the small data area.  Variables will be put into
9667 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9668 @code{section} attribute has been specified).
9669 This is the default.
9671 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9672 Objects may be explicitly put in the small data area with the
9673 @code{section} attribute using one of these sections.
9675 @item -msdata=sdata
9676 @opindex msdata=sdata
9677 Put small global and static data in the small data area, but do not
9678 generate special code to reference them.
9680 @item -msdata=use
9681 @opindex msdata=use
9682 Put small global and static data in the small data area, and generate
9683 special instructions to reference them.
9685 @item -G @var{num}
9686 @opindex G
9687 @cindex smaller data references
9688 Put global and static objects less than or equal to @var{num} bytes
9689 into the small data or bss sections instead of the normal data or bss
9690 sections.  The default value of @var{num} is 8.
9691 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9692 for this option to have any effect.
9694 All modules should be compiled with the same @option{-G @var{num}} value.
9695 Compiling with different values of @var{num} may or may not work; if it
9696 doesn't the linker will give an error message---incorrect code will not be
9697 generated.
9699 @item -mdebug
9700 @opindex mdebug
9701 Makes the M32R specific code in the compiler display some statistics
9702 that might help in debugging programs.
9704 @item -malign-loops
9705 @opindex malign-loops
9706 Align all loops to a 32-byte boundary.
9708 @item -mno-align-loops
9709 @opindex mno-align-loops
9710 Do not enforce a 32-byte alignment for loops.  This is the default.
9712 @item -missue-rate=@var{number}
9713 @opindex missue-rate=@var{number}
9714 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9715 or 2.
9717 @item -mbranch-cost=@var{number}
9718 @opindex mbranch-cost=@var{number}
9719 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9720 preferred over conditional code, if it is 2, then the opposite will
9721 apply.
9723 @item -mflush-trap=@var{number}
9724 @opindex mflush-trap=@var{number}
9725 Specifies the trap number to use to flush the cache.  The default is
9726 12.  Valid numbers are between 0 and 15 inclusive.
9728 @item -mno-flush-trap
9729 @opindex mno-flush-trap
9730 Specifies that the cache cannot be flushed by using a trap.
9732 @item -mflush-func=@var{name}
9733 @opindex mflush-func=@var{name}
9734 Specifies the name of the operating system function to call to flush
9735 the cache.  The default is @emph{_flush_cache}, but a function call
9736 will only be used if a trap is not available.
9738 @item -mno-flush-func
9739 @opindex mno-flush-func
9740 Indicates that there is no OS function for flushing the cache.
9742 @end table
9744 @node M680x0 Options
9745 @subsection M680x0 Options
9746 @cindex M680x0 options
9748 These are the @samp{-m} options defined for the 68000 series.  The default
9749 values for these options depends on which style of 68000 was selected when
9750 the compiler was configured; the defaults for the most common choices are
9751 given below.
9753 @table @gcctabopt
9754 @item -m68000
9755 @itemx -mc68000
9756 @opindex m68000
9757 @opindex mc68000
9758 Generate output for a 68000.  This is the default
9759 when the compiler is configured for 68000-based systems.
9761 Use this option for microcontrollers with a 68000 or EC000 core,
9762 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9764 @item -m68020
9765 @itemx -mc68020
9766 @opindex m68020
9767 @opindex mc68020
9768 Generate output for a 68020.  This is the default
9769 when the compiler is configured for 68020-based systems.
9771 @item -m68881
9772 @opindex m68881
9773 Generate output containing 68881 instructions for floating point.
9774 This is the default for most 68020 systems unless @option{--nfp} was
9775 specified when the compiler was configured.
9777 @item -m68030
9778 @opindex m68030
9779 Generate output for a 68030.  This is the default when the compiler is
9780 configured for 68030-based systems.
9782 @item -m68040
9783 @opindex m68040
9784 Generate output for a 68040.  This is the default when the compiler is
9785 configured for 68040-based systems.
9787 This option inhibits the use of 68881/68882 instructions that have to be
9788 emulated by software on the 68040.  Use this option if your 68040 does not
9789 have code to emulate those instructions.
9791 @item -m68060
9792 @opindex m68060
9793 Generate output for a 68060.  This is the default when the compiler is
9794 configured for 68060-based systems.
9796 This option inhibits the use of 68020 and 68881/68882 instructions that
9797 have to be emulated by software on the 68060.  Use this option if your 68060
9798 does not have code to emulate those instructions.
9800 @item -mcpu32
9801 @opindex mcpu32
9802 Generate output for a CPU32.  This is the default
9803 when the compiler is configured for CPU32-based systems.
9805 Use this option for microcontrollers with a
9806 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9807 68336, 68340, 68341, 68349 and 68360.
9809 @item -m5200
9810 @opindex m5200
9811 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9812 when the compiler is configured for 520X-based systems.
9814 Use this option for microcontroller with a 5200 core, including
9815 the MCF5202, MCF5203, MCF5204 and MCF5202.
9818 @item -m68020-40
9819 @opindex m68020-40
9820 Generate output for a 68040, without using any of the new instructions.
9821 This results in code which can run relatively efficiently on either a
9822 68020/68881 or a 68030 or a 68040.  The generated code does use the
9823 68881 instructions that are emulated on the 68040.
9825 @item -m68020-60
9826 @opindex m68020-60
9827 Generate output for a 68060, without using any of the new instructions.
9828 This results in code which can run relatively efficiently on either a
9829 68020/68881 or a 68030 or a 68040.  The generated code does use the
9830 68881 instructions that are emulated on the 68060.
9832 @item -msoft-float
9833 @opindex msoft-float
9834 Generate output containing library calls for floating point.
9835 @strong{Warning:} the requisite libraries are not available for all m68k
9836 targets.  Normally the facilities of the machine's usual C compiler are
9837 used, but this can't be done directly in cross-compilation.  You must
9838 make your own arrangements to provide suitable library functions for
9839 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9840 @samp{m68k-*-coff} do provide software floating point support.
9842 @item -mshort
9843 @opindex mshort
9844 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9845 Additionally, parameters passed on the stack are also aligned to a
9846 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9848 @item -mnobitfield
9849 @opindex mnobitfield
9850 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9851 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9853 @item -mbitfield
9854 @opindex mbitfield
9855 Do use the bit-field instructions.  The @option{-m68020} option implies
9856 @option{-mbitfield}.  This is the default if you use a configuration
9857 designed for a 68020.
9859 @item -mrtd
9860 @opindex mrtd
9861 Use a different function-calling convention, in which functions
9862 that take a fixed number of arguments return with the @code{rtd}
9863 instruction, which pops their arguments while returning.  This
9864 saves one instruction in the caller since there is no need to pop
9865 the arguments there.
9867 This calling convention is incompatible with the one normally
9868 used on Unix, so you cannot use it if you need to call libraries
9869 compiled with the Unix compiler.
9871 Also, you must provide function prototypes for all functions that
9872 take variable numbers of arguments (including @code{printf});
9873 otherwise incorrect code will be generated for calls to those
9874 functions.
9876 In addition, seriously incorrect code will result if you call a
9877 function with too many arguments.  (Normally, extra arguments are
9878 harmlessly ignored.)
9880 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9881 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9883 @item -malign-int
9884 @itemx -mno-align-int
9885 @opindex malign-int
9886 @opindex mno-align-int
9887 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9888 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9889 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9890 Aligning variables on 32-bit boundaries produces code that runs somewhat
9891 faster on processors with 32-bit busses at the expense of more memory.
9893 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9894 align structures containing the above types  differently than
9895 most published application binary interface specifications for the m68k.
9897 @item -mpcrel
9898 @opindex mpcrel
9899 Use the pc-relative addressing mode of the 68000 directly, instead of
9900 using a global offset table.  At present, this option implies @option{-fpic},
9901 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9902 not presently supported with @option{-mpcrel}, though this could be supported for
9903 68020 and higher processors.
9905 @item -mno-strict-align
9906 @itemx -mstrict-align
9907 @opindex mno-strict-align
9908 @opindex mstrict-align
9909 Do not (do) assume that unaligned memory references will be handled by
9910 the system.
9912 @item -msep-data
9913 Generate code that allows the data segment to be located in a different
9914 area of memory from the text segment.  This allows for execute in place in
9915 an environment without virtual memory management.  This option implies
9916 @option{-fPIC}.
9918 @item -mno-sep-data
9919 Generate code that assumes that the data segment follows the text segment.
9920 This is the default.
9922 @item -mid-shared-library
9923 Generate code that supports shared libraries via the library ID method.
9924 This allows for execute in place and shared libraries in an environment
9925 without virtual memory management.  This option implies @option{-fPIC}.
9927 @item -mno-id-shared-library
9928 Generate code that doesn't assume ID based shared libraries are being used.
9929 This is the default.
9931 @item -mshared-library-id=n
9932 Specified the identification number of the ID based shared library being
9933 compiled.  Specifying a value of 0 will generate more compact code, specifying
9934 other values will force the allocation of that number to the current
9935 library but is no more space or time efficient than omitting this option.
9937 @end table
9939 @node M68hc1x Options
9940 @subsection M68hc1x Options
9941 @cindex M68hc1x options
9943 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9944 microcontrollers.  The default values for these options depends on
9945 which style of microcontroller was selected when the compiler was configured;
9946 the defaults for the most common choices are given below.
9948 @table @gcctabopt
9949 @item -m6811
9950 @itemx -m68hc11
9951 @opindex m6811
9952 @opindex m68hc11
9953 Generate output for a 68HC11.  This is the default
9954 when the compiler is configured for 68HC11-based systems.
9956 @item -m6812
9957 @itemx -m68hc12
9958 @opindex m6812
9959 @opindex m68hc12
9960 Generate output for a 68HC12.  This is the default
9961 when the compiler is configured for 68HC12-based systems.
9963 @item -m68S12
9964 @itemx -m68hcs12
9965 @opindex m68S12
9966 @opindex m68hcs12
9967 Generate output for a 68HCS12.
9969 @item -mauto-incdec
9970 @opindex mauto-incdec
9971 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9972 addressing modes.
9974 @item -minmax
9975 @itemx -nominmax
9976 @opindex minmax
9977 @opindex mnominmax
9978 Enable the use of 68HC12 min and max instructions.
9980 @item -mlong-calls
9981 @itemx -mno-long-calls
9982 @opindex mlong-calls
9983 @opindex mno-long-calls
9984 Treat all calls as being far away (near).  If calls are assumed to be
9985 far away, the compiler will use the @code{call} instruction to
9986 call a function and the @code{rtc} instruction for returning.
9988 @item -mshort
9989 @opindex mshort
9990 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9992 @item -msoft-reg-count=@var{count}
9993 @opindex msoft-reg-count
9994 Specify the number of pseudo-soft registers which are used for the
9995 code generation.  The maximum number is 32.  Using more pseudo-soft
9996 register may or may not result in better code depending on the program.
9997 The default is 4 for 68HC11 and 2 for 68HC12.
9999 @end table
10001 @node MCore Options
10002 @subsection MCore Options
10003 @cindex MCore options
10005 These are the @samp{-m} options defined for the Motorola M*Core
10006 processors.
10008 @table @gcctabopt
10010 @item -mhardlit
10011 @itemx -mno-hardlit
10012 @opindex mhardlit
10013 @opindex mno-hardlit
10014 Inline constants into the code stream if it can be done in two
10015 instructions or less.
10017 @item -mdiv
10018 @itemx -mno-div
10019 @opindex mdiv
10020 @opindex mno-div
10021 Use the divide instruction.  (Enabled by default).
10023 @item -mrelax-immediate
10024 @itemx -mno-relax-immediate
10025 @opindex mrelax-immediate
10026 @opindex mno-relax-immediate
10027 Allow arbitrary sized immediates in bit operations.
10029 @item -mwide-bitfields
10030 @itemx -mno-wide-bitfields
10031 @opindex mwide-bitfields
10032 @opindex mno-wide-bitfields
10033 Always treat bit-fields as int-sized.
10035 @item -m4byte-functions
10036 @itemx -mno-4byte-functions
10037 @opindex m4byte-functions
10038 @opindex mno-4byte-functions
10039 Force all functions to be aligned to a four byte boundary.
10041 @item -mcallgraph-data
10042 @itemx -mno-callgraph-data
10043 @opindex mcallgraph-data
10044 @opindex mno-callgraph-data
10045 Emit callgraph information.
10047 @item -mslow-bytes
10048 @itemx -mno-slow-bytes
10049 @opindex mslow-bytes
10050 @opindex mno-slow-bytes
10051 Prefer word access when reading byte quantities.
10053 @item -mlittle-endian
10054 @itemx -mbig-endian
10055 @opindex mlittle-endian
10056 @opindex mbig-endian
10057 Generate code for a little endian target.
10059 @item -m210
10060 @itemx -m340
10061 @opindex m210
10062 @opindex m340
10063 Generate code for the 210 processor.
10064 @end table
10066 @node MIPS Options
10067 @subsection MIPS Options
10068 @cindex MIPS options
10070 @table @gcctabopt
10072 @item -EB
10073 @opindex EB
10074 Generate big-endian code.
10076 @item -EL
10077 @opindex EL
10078 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10079 configurations.
10081 @item -march=@var{arch}
10082 @opindex march
10083 Generate code that will run on @var{arch}, which can be the name of a
10084 generic MIPS ISA, or the name of a particular processor.
10085 The ISA names are:
10086 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10087 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10088 The processor names are:
10089 @samp{4kc}, @samp{4km}, @samp{4kp},
10090 @samp{5kc}, @samp{5kf},
10091 @samp{20kc},
10092 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10093 @samp{m4k},
10094 @samp{orion},
10095 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10096 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10097 @samp{rm7000}, @samp{rm9000},
10098 @samp{sb1},
10099 @samp{sr71000},
10100 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10101 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10102 The special value @samp{from-abi} selects the
10103 most compatible architecture for the selected ABI (that is,
10104 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10106 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10107 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10108 @samp{vr} may be written @samp{r}.
10110 GCC defines two macros based on the value of this option.  The first
10111 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10112 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10113 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10114 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10115 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10117 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10118 above.  In other words, it will have the full prefix and will not
10119 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10120 the macro names the resolved architecture (either @samp{"mips1"} or
10121 @samp{"mips3"}).  It names the default architecture when no
10122 @option{-march} option is given.
10124 @item -mtune=@var{arch}
10125 @opindex mtune
10126 Optimize for @var{arch}.  Among other things, this option controls
10127 the way instructions are scheduled, and the perceived cost of arithmetic
10128 operations.  The list of @var{arch} values is the same as for
10129 @option{-march}.
10131 When this option is not used, GCC will optimize for the processor
10132 specified by @option{-march}.  By using @option{-march} and
10133 @option{-mtune} together, it is possible to generate code that will
10134 run on a family of processors, but optimize the code for one
10135 particular member of that family.
10137 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10138 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10139 @samp{-march} ones described above.
10141 @item -mips1
10142 @opindex mips1
10143 Equivalent to @samp{-march=mips1}.
10145 @item -mips2
10146 @opindex mips2
10147 Equivalent to @samp{-march=mips2}.
10149 @item -mips3
10150 @opindex mips3
10151 Equivalent to @samp{-march=mips3}.
10153 @item -mips4
10154 @opindex mips4
10155 Equivalent to @samp{-march=mips4}.
10157 @item -mips32
10158 @opindex mips32
10159 Equivalent to @samp{-march=mips32}.
10161 @item -mips32r2
10162 @opindex mips32r2
10163 Equivalent to @samp{-march=mips32r2}.
10165 @item -mips64
10166 @opindex mips64
10167 Equivalent to @samp{-march=mips64}.
10169 @item -mips16
10170 @itemx -mno-mips16
10171 @opindex mips16
10172 @opindex mno-mips16
10173 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10174 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10176 @item -mabi=32
10177 @itemx -mabi=o64
10178 @itemx -mabi=n32
10179 @itemx -mabi=64
10180 @itemx -mabi=eabi
10181 @opindex mabi=32
10182 @opindex mabi=o64
10183 @opindex mabi=n32
10184 @opindex mabi=64
10185 @opindex mabi=eabi
10186 Generate code for the given ABI@.
10188 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10189 generates 64-bit code when you select a 64-bit architecture, but you
10190 can use @option{-mgp32} to get 32-bit code instead.
10192 For information about the O64 ABI, see
10193 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10195 @item -mabicalls
10196 @itemx -mno-abicalls
10197 @opindex mabicalls
10198 @opindex mno-abicalls
10199 Generate (do not generate) SVR4-style position-independent code.
10200 @option{-mabicalls} is the default for SVR4-based systems.
10202 @item -mxgot
10203 @itemx -mno-xgot
10204 @opindex mxgot
10205 @opindex mno-xgot
10206 Lift (do not lift) the usual restrictions on the size of the global
10207 offset table.
10209 GCC normally uses a single instruction to load values from the GOT@.
10210 While this is relatively efficient, it will only work if the GOT
10211 is smaller than about 64k.  Anything larger will cause the linker
10212 to report an error such as:
10214 @cindex relocation truncated to fit (MIPS)
10215 @smallexample
10216 relocation truncated to fit: R_MIPS_GOT16 foobar
10217 @end smallexample
10219 If this happens, you should recompile your code with @option{-mxgot}.
10220 It should then work with very large GOTs, although it will also be
10221 less efficient, since it will take three instructions to fetch the
10222 value of a global symbol.
10224 Note that some linkers can create multiple GOTs.  If you have such a
10225 linker, you should only need to use @option{-mxgot} when a single object
10226 file accesses more than 64k's worth of GOT entries.  Very few do.
10228 These options have no effect unless GCC is generating position
10229 independent code.
10231 @item -mgp32
10232 @opindex mgp32
10233 Assume that general-purpose registers are 32 bits wide.
10235 @item -mgp64
10236 @opindex mgp64
10237 Assume that general-purpose registers are 64 bits wide.
10239 @item -mfp32
10240 @opindex mfp32
10241 Assume that floating-point registers are 32 bits wide.
10243 @item -mfp64
10244 @opindex mfp64
10245 Assume that floating-point registers are 64 bits wide.
10247 @item -mhard-float
10248 @opindex mhard-float
10249 Use floating-point coprocessor instructions.
10251 @item -msoft-float
10252 @opindex msoft-float
10253 Do not use floating-point coprocessor instructions.  Implement
10254 floating-point calculations using library calls instead.
10256 @item -msingle-float
10257 @opindex msingle-float
10258 Assume that the floating-point coprocessor only supports single-precision
10259 operations.
10261 @itemx -mdouble-float
10262 @opindex mdouble-float
10263 Assume that the floating-point coprocessor supports double-precision
10264 operations.  This is the default.
10266 @itemx -mdsp
10267 @itemx -mno-dsp
10268 @opindex mdsp
10269 @opindex mno-dsp
10270 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10272 @itemx -mpaired-single
10273 @itemx -mno-paired-single
10274 @opindex mpaired-single
10275 @opindex mno-paired-single
10276 Use (do not use) paired-single floating-point instructions.
10277 @xref{MIPS Paired-Single Support}.  This option can only be used
10278 when generating 64-bit code and requires hardware floating-point
10279 support to be enabled.
10281 @itemx -mips3d
10282 @itemx -mno-mips3d
10283 @opindex mips3d
10284 @opindex mno-mips3d
10285 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10286 The option @option{-mips3d} implies @option{-mpaired-single}.
10288 @item -mlong64
10289 @opindex mlong64
10290 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10291 an explanation of the default and the way that the pointer size is
10292 determined.
10294 @item -mlong32
10295 @opindex mlong32
10296 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10298 The default size of @code{int}s, @code{long}s and pointers depends on
10299 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10300 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10301 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10302 or the same size as integer registers, whichever is smaller.
10304 @item -msym32
10305 @itemx -mno-sym32
10306 @opindex msym32
10307 @opindex mno-sym32
10308 Assume (do not assume) that all symbols have 32-bit values, regardless
10309 of the selected ABI@.  This option is useful in combination with
10310 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10311 to generate shorter and faster references to symbolic addresses.
10313 @item -G @var{num}
10314 @opindex G
10315 @cindex smaller data references (MIPS)
10316 @cindex gp-relative references (MIPS)
10317 Put global and static items less than or equal to @var{num} bytes into
10318 the small data or bss section instead of the normal data or bss section.
10319 This allows the data to be accessed using a single instruction.
10321 All modules should be compiled with the same @option{-G @var{num}}
10322 value.
10324 @item -membedded-data
10325 @itemx -mno-embedded-data
10326 @opindex membedded-data
10327 @opindex mno-embedded-data
10328 Allocate variables to the read-only data section first if possible, then
10329 next in the small data section if possible, otherwise in data.  This gives
10330 slightly slower code than the default, but reduces the amount of RAM required
10331 when executing, and thus may be preferred for some embedded systems.
10333 @item -muninit-const-in-rodata
10334 @itemx -mno-uninit-const-in-rodata
10335 @opindex muninit-const-in-rodata
10336 @opindex mno-uninit-const-in-rodata
10337 Put uninitialized @code{const} variables in the read-only data section.
10338 This option is only meaningful in conjunction with @option{-membedded-data}.
10340 @item -msplit-addresses
10341 @itemx -mno-split-addresses
10342 @opindex msplit-addresses
10343 @opindex mno-split-addresses
10344 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10345 relocation operators.  This option has been superseded by
10346 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10348 @item -mexplicit-relocs
10349 @itemx -mno-explicit-relocs
10350 @opindex mexplicit-relocs
10351 @opindex mno-explicit-relocs
10352 Use (do not use) assembler relocation operators when dealing with symbolic
10353 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10354 is to use assembler macros instead.
10356 @option{-mexplicit-relocs} is the default if GCC was configured
10357 to use an assembler that supports relocation operators.
10359 @item -mcheck-zero-division
10360 @itemx -mno-check-zero-division
10361 @opindex mcheck-zero-division
10362 @opindex mno-check-zero-division
10363 Trap (do not trap) on integer division by zero.  The default is
10364 @option{-mcheck-zero-division}.
10366 @item -mdivide-traps
10367 @itemx -mdivide-breaks
10368 @opindex mdivide-traps
10369 @opindex mdivide-breaks
10370 MIPS systems check for division by zero by generating either a
10371 conditional trap or a break instruction.  Using traps results in
10372 smaller code, but is only supported on MIPS II and later.  Also, some
10373 versions of the Linux kernel have a bug that prevents trap from
10374 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10375 allow conditional traps on architectures that support them and
10376 @option{-mdivide-breaks} to force the use of breaks.
10378 The default is usually @option{-mdivide-traps}, but this can be
10379 overridden at configure time using @option{--with-divide=breaks}.
10380 Divide-by-zero checks can be completely disabled using
10381 @option{-mno-check-zero-division}.
10383 @item -mmemcpy
10384 @itemx -mno-memcpy
10385 @opindex mmemcpy
10386 @opindex mno-memcpy
10387 Force (do not force) the use of @code{memcpy()} for non-trivial block
10388 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10389 most constant-sized copies.
10391 @item -mlong-calls
10392 @itemx -mno-long-calls
10393 @opindex mlong-calls
10394 @opindex mno-long-calls
10395 Disable (do not disable) use of the @code{jal} instruction.  Calling
10396 functions using @code{jal} is more efficient but requires the caller
10397 and callee to be in the same 256 megabyte segment.
10399 This option has no effect on abicalls code.  The default is
10400 @option{-mno-long-calls}.
10402 @item -mmad
10403 @itemx -mno-mad
10404 @opindex mmad
10405 @opindex mno-mad
10406 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10407 instructions, as provided by the R4650 ISA@.
10409 @item -mfused-madd
10410 @itemx -mno-fused-madd
10411 @opindex mfused-madd
10412 @opindex mno-fused-madd
10413 Enable (disable) use of the floating point multiply-accumulate
10414 instructions, when they are available.  The default is
10415 @option{-mfused-madd}.
10417 When multiply-accumulate instructions are used, the intermediate
10418 product is calculated to infinite precision and is not subject to
10419 the FCSR Flush to Zero bit.  This may be undesirable in some
10420 circumstances.
10422 @item -nocpp
10423 @opindex nocpp
10424 Tell the MIPS assembler to not run its preprocessor over user
10425 assembler files (with a @samp{.s} suffix) when assembling them.
10427 @item -mfix-r4000
10428 @itemx -mno-fix-r4000
10429 @opindex mfix-r4000
10430 @opindex mno-fix-r4000
10431 Work around certain R4000 CPU errata:
10432 @itemize @minus
10433 @item
10434 A double-word or a variable shift may give an incorrect result if executed
10435 immediately after starting an integer division.
10436 @item
10437 A double-word or a variable shift may give an incorrect result if executed
10438 while an integer multiplication is in progress.
10439 @item
10440 An integer division may give an incorrect result if started in a delay slot
10441 of a taken branch or a jump.
10442 @end itemize
10444 @item -mfix-r4400
10445 @itemx -mno-fix-r4400
10446 @opindex mfix-r4400
10447 @opindex mno-fix-r4400
10448 Work around certain R4400 CPU errata:
10449 @itemize @minus
10450 @item
10451 A double-word or a variable shift may give an incorrect result if executed
10452 immediately after starting an integer division.
10453 @end itemize
10455 @item -mfix-vr4120
10456 @itemx -mno-fix-vr4120
10457 @opindex mfix-vr4120
10458 Work around certain VR4120 errata:
10459 @itemize @minus
10460 @item
10461 @code{dmultu} does not always produce the correct result.
10462 @item
10463 @code{div} and @code{ddiv} do not always produce the correct result if one
10464 of the operands is negative.
10465 @end itemize
10466 The workarounds for the division errata rely on special functions in
10467 @file{libgcc.a}.  At present, these functions are only provided by
10468 the @code{mips64vr*-elf} configurations.
10470 Other VR4120 errata require a nop to be inserted between certain pairs of
10471 instructions.  These errata are handled by the assembler, not by GCC itself.
10473 @item -mfix-vr4130
10474 @opindex mfix-vr4130
10475 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10476 workarounds are implemented by the assembler rather than by GCC,
10477 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10478 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10479 instructions are available instead.
10481 @item -mfix-sb1
10482 @itemx -mno-fix-sb1
10483 @opindex mfix-sb1
10484 Work around certain SB-1 CPU core errata.
10485 (This flag currently works around the SB-1 revision 2
10486 ``F1'' and ``F2'' floating point errata.)
10488 @item -mflush-func=@var{func}
10489 @itemx -mno-flush-func
10490 @opindex mflush-func
10491 Specifies the function to call to flush the I and D caches, or to not
10492 call any such function.  If called, the function must take the same
10493 arguments as the common @code{_flush_func()}, that is, the address of the
10494 memory range for which the cache is being flushed, the size of the
10495 memory range, and the number 3 (to flush both caches).  The default
10496 depends on the target GCC was configured for, but commonly is either
10497 @samp{_flush_func} or @samp{__cpu_flush}.
10499 @item -mbranch-likely
10500 @itemx -mno-branch-likely
10501 @opindex mbranch-likely
10502 @opindex mno-branch-likely
10503 Enable or disable use of Branch Likely instructions, regardless of the
10504 default for the selected architecture.  By default, Branch Likely
10505 instructions may be generated if they are supported by the selected
10506 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10507 and processors which implement those architectures; for those, Branch
10508 Likely instructions will not be generated by default because the MIPS32
10509 and MIPS64 architectures specifically deprecate their use.
10511 @item -mfp-exceptions
10512 @itemx -mno-fp-exceptions
10513 @opindex mfp-exceptions
10514 Specifies whether FP exceptions are enabled.  This affects how we schedule
10515 FP instructions for some processors.  The default is that FP exceptions are
10516 enabled.
10518 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10519 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10520 FP pipe.
10522 @item -mvr4130-align
10523 @itemx -mno-vr4130-align
10524 @opindex mvr4130-align
10525 The VR4130 pipeline is two-way superscalar, but can only issue two
10526 instructions together if the first one is 8-byte aligned.  When this
10527 option is enabled, GCC will align pairs of instructions that it
10528 thinks should execute in parallel.
10530 This option only has an effect when optimizing for the VR4130.
10531 It normally makes code faster, but at the expense of making it bigger.
10532 It is enabled by default at optimization level @option{-O3}.
10533 @end table
10535 @node MMIX Options
10536 @subsection MMIX Options
10537 @cindex MMIX Options
10539 These options are defined for the MMIX:
10541 @table @gcctabopt
10542 @item -mlibfuncs
10543 @itemx -mno-libfuncs
10544 @opindex mlibfuncs
10545 @opindex mno-libfuncs
10546 Specify that intrinsic library functions are being compiled, passing all
10547 values in registers, no matter the size.
10549 @item -mepsilon
10550 @itemx -mno-epsilon
10551 @opindex mepsilon
10552 @opindex mno-epsilon
10553 Generate floating-point comparison instructions that compare with respect
10554 to the @code{rE} epsilon register.
10556 @item -mabi=mmixware
10557 @itemx -mabi=gnu
10558 @opindex mabi-mmixware
10559 @opindex mabi=gnu
10560 Generate code that passes function parameters and return values that (in
10561 the called function) are seen as registers @code{$0} and up, as opposed to
10562 the GNU ABI which uses global registers @code{$231} and up.
10564 @item -mzero-extend
10565 @itemx -mno-zero-extend
10566 @opindex mzero-extend
10567 @opindex mno-zero-extend
10568 When reading data from memory in sizes shorter than 64 bits, use (do not
10569 use) zero-extending load instructions by default, rather than
10570 sign-extending ones.
10572 @item -mknuthdiv
10573 @itemx -mno-knuthdiv
10574 @opindex mknuthdiv
10575 @opindex mno-knuthdiv
10576 Make the result of a division yielding a remainder have the same sign as
10577 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10578 remainder follows the sign of the dividend.  Both methods are
10579 arithmetically valid, the latter being almost exclusively used.
10581 @item -mtoplevel-symbols
10582 @itemx -mno-toplevel-symbols
10583 @opindex mtoplevel-symbols
10584 @opindex mno-toplevel-symbols
10585 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10586 code can be used with the @code{PREFIX} assembly directive.
10588 @item -melf
10589 @opindex melf
10590 Generate an executable in the ELF format, rather than the default
10591 @samp{mmo} format used by the @command{mmix} simulator.
10593 @item -mbranch-predict
10594 @itemx -mno-branch-predict
10595 @opindex mbranch-predict
10596 @opindex mno-branch-predict
10597 Use (do not use) the probable-branch instructions, when static branch
10598 prediction indicates a probable branch.
10600 @item -mbase-addresses
10601 @itemx -mno-base-addresses
10602 @opindex mbase-addresses
10603 @opindex mno-base-addresses
10604 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10605 base address automatically generates a request (handled by the assembler
10606 and the linker) for a constant to be set up in a global register.  The
10607 register is used for one or more base address requests within the range 0
10608 to 255 from the value held in the register.  The generally leads to short
10609 and fast code, but the number of different data items that can be
10610 addressed is limited.  This means that a program that uses lots of static
10611 data may require @option{-mno-base-addresses}.
10613 @item -msingle-exit
10614 @itemx -mno-single-exit
10615 @opindex msingle-exit
10616 @opindex mno-single-exit
10617 Force (do not force) generated code to have a single exit point in each
10618 function.
10619 @end table
10621 @node MN10300 Options
10622 @subsection MN10300 Options
10623 @cindex MN10300 options
10625 These @option{-m} options are defined for Matsushita MN10300 architectures:
10627 @table @gcctabopt
10628 @item -mmult-bug
10629 @opindex mmult-bug
10630 Generate code to avoid bugs in the multiply instructions for the MN10300
10631 processors.  This is the default.
10633 @item -mno-mult-bug
10634 @opindex mno-mult-bug
10635 Do not generate code to avoid bugs in the multiply instructions for the
10636 MN10300 processors.
10638 @item -mam33
10639 @opindex mam33
10640 Generate code which uses features specific to the AM33 processor.
10642 @item -mno-am33
10643 @opindex mno-am33
10644 Do not generate code which uses features specific to the AM33 processor.  This
10645 is the default.
10647 @item -mreturn-pointer-on-d0
10648 @opindex mreturn-pointer-on-d0
10649 When generating a function which returns a pointer, return the pointer
10650 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10651 only in a0, and attempts to call such functions without a prototype
10652 would result in errors.  Note that this option is on by default; use
10653 @option{-mno-return-pointer-on-d0} to disable it.
10655 @item -mno-crt0
10656 @opindex mno-crt0
10657 Do not link in the C run-time initialization object file.
10659 @item -mrelax
10660 @opindex mrelax
10661 Indicate to the linker that it should perform a relaxation optimization pass
10662 to shorten branches, calls and absolute memory addresses.  This option only
10663 has an effect when used on the command line for the final link step.
10665 This option makes symbolic debugging impossible.
10666 @end table
10668 @node MS1 Options
10669 @subsection MS1 Options
10670 @cindex MS1 options
10672 These @option{-m} options are defined for Morpho MS1 architectures:
10674 @table @gcctabopt
10676 @item -march=@var{cpu-type}
10677 @opindex march
10678 Generate code that will run on @var{cpu-type}, which is the name of a system
10679 representing a certain processor type.  Possible values for
10680 @var{cpu-type} are @samp{MS1-64-001}, @samp{MS1-16-002}, and
10681 @samp{MS1-16-003}.
10683 When this option is not used, the default is @option{-march=MS1-16-003}.
10685 @item -mmul
10686 @opindex mmul
10687 Generate multiply instructions.
10689 @item -mno-mul
10690 @opindex mno-mul
10691 Do not generate multiply instructions.
10693 @item -mbacc
10694 @opindex mbacc
10695 Use byte loads and stores when generating code.
10697 @item -mno-bacc
10698 @opindex mno-bacc
10699 Do not use byte loads and stores when generating code.
10701 @item -msim
10702 @opindex msim
10703 Use simulator runtime
10705 @item -mno-crt0
10706 @opindex mno-crt0
10707 Do not link in the C run-time initialization object file
10708 @file{crti.o}.  Other run-time initialization and termination files
10709 such as @file{startup.o} and @file{exit.o} are still included on the
10710 linker command line.
10712 @end table
10714 @node PDP-11 Options
10715 @subsection PDP-11 Options
10716 @cindex PDP-11 Options
10718 These options are defined for the PDP-11:
10720 @table @gcctabopt
10721 @item -mfpu
10722 @opindex mfpu
10723 Use hardware FPP floating point.  This is the default.  (FIS floating
10724 point on the PDP-11/40 is not supported.)
10726 @item -msoft-float
10727 @opindex msoft-float
10728 Do not use hardware floating point.
10730 @item -mac0
10731 @opindex mac0
10732 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10734 @item -mno-ac0
10735 @opindex mno-ac0
10736 Return floating-point results in memory.  This is the default.
10738 @item -m40
10739 @opindex m40
10740 Generate code for a PDP-11/40.
10742 @item -m45
10743 @opindex m45
10744 Generate code for a PDP-11/45.  This is the default.
10746 @item -m10
10747 @opindex m10
10748 Generate code for a PDP-11/10.
10750 @item -mbcopy-builtin
10751 @opindex bcopy-builtin
10752 Use inline @code{movmemhi} patterns for copying memory.  This is the
10753 default.
10755 @item -mbcopy
10756 @opindex mbcopy
10757 Do not use inline @code{movmemhi} patterns for copying memory.
10759 @item -mint16
10760 @itemx -mno-int32
10761 @opindex mint16
10762 @opindex mno-int32
10763 Use 16-bit @code{int}.  This is the default.
10765 @item -mint32
10766 @itemx -mno-int16
10767 @opindex mint32
10768 @opindex mno-int16
10769 Use 32-bit @code{int}.
10771 @item -mfloat64
10772 @itemx -mno-float32
10773 @opindex mfloat64
10774 @opindex mno-float32
10775 Use 64-bit @code{float}.  This is the default.
10777 @item -mfloat32
10778 @itemx -mno-float64
10779 @opindex mfloat32
10780 @opindex mno-float64
10781 Use 32-bit @code{float}.
10783 @item -mabshi
10784 @opindex mabshi
10785 Use @code{abshi2} pattern.  This is the default.
10787 @item -mno-abshi
10788 @opindex mno-abshi
10789 Do not use @code{abshi2} pattern.
10791 @item -mbranch-expensive
10792 @opindex mbranch-expensive
10793 Pretend that branches are expensive.  This is for experimenting with
10794 code generation only.
10796 @item -mbranch-cheap
10797 @opindex mbranch-cheap
10798 Do not pretend that branches are expensive.  This is the default.
10800 @item -msplit
10801 @opindex msplit
10802 Generate code for a system with split I&D@.
10804 @item -mno-split
10805 @opindex mno-split
10806 Generate code for a system without split I&D@.  This is the default.
10808 @item -munix-asm
10809 @opindex munix-asm
10810 Use Unix assembler syntax.  This is the default when configured for
10811 @samp{pdp11-*-bsd}.
10813 @item -mdec-asm
10814 @opindex mdec-asm
10815 Use DEC assembler syntax.  This is the default when configured for any
10816 PDP-11 target other than @samp{pdp11-*-bsd}.
10817 @end table
10819 @node PowerPC Options
10820 @subsection PowerPC Options
10821 @cindex PowerPC options
10823 These are listed under @xref{RS/6000 and PowerPC Options}.
10825 @node RS/6000 and PowerPC Options
10826 @subsection IBM RS/6000 and PowerPC Options
10827 @cindex RS/6000 and PowerPC Options
10828 @cindex IBM RS/6000 and PowerPC Options
10830 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10831 @table @gcctabopt
10832 @item -mpower
10833 @itemx -mno-power
10834 @itemx -mpower2
10835 @itemx -mno-power2
10836 @itemx -mpowerpc
10837 @itemx -mno-powerpc
10838 @itemx -mpowerpc-gpopt
10839 @itemx -mno-powerpc-gpopt
10840 @itemx -mpowerpc-gfxopt
10841 @itemx -mno-powerpc-gfxopt
10842 @itemx -mpowerpc64
10843 @itemx -mno-powerpc64
10844 @itemx -mmfcrf
10845 @itemx -mno-mfcrf
10846 @itemx -mpopcntb
10847 @itemx -mno-popcntb
10848 @itemx -mfprnd
10849 @itemx -mno-fprnd
10850 @opindex mpower
10851 @opindex mno-power
10852 @opindex mpower2
10853 @opindex mno-power2
10854 @opindex mpowerpc
10855 @opindex mno-powerpc
10856 @opindex mpowerpc-gpopt
10857 @opindex mno-powerpc-gpopt
10858 @opindex mpowerpc-gfxopt
10859 @opindex mno-powerpc-gfxopt
10860 @opindex mpowerpc64
10861 @opindex mno-powerpc64
10862 @opindex mmfcrf
10863 @opindex mno-mfcrf
10864 @opindex mpopcntb
10865 @opindex mno-popcntb
10866 @opindex mfprnd
10867 @opindex mno-fprnd
10868 GCC supports two related instruction set architectures for the
10869 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10870 instructions supported by the @samp{rios} chip set used in the original
10871 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10872 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10873 the IBM 4xx, 6xx, and follow-on microprocessors.
10875 Neither architecture is a subset of the other.  However there is a
10876 large common subset of instructions supported by both.  An MQ
10877 register is included in processors supporting the POWER architecture.
10879 You use these options to specify which instructions are available on the
10880 processor you are using.  The default value of these options is
10881 determined when configuring GCC@.  Specifying the
10882 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10883 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10884 rather than the options listed above.
10886 The @option{-mpower} option allows GCC to generate instructions that
10887 are found only in the POWER architecture and to use the MQ register.
10888 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10889 to generate instructions that are present in the POWER2 architecture but
10890 not the original POWER architecture.
10892 The @option{-mpowerpc} option allows GCC to generate instructions that
10893 are found only in the 32-bit subset of the PowerPC architecture.
10894 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10895 GCC to use the optional PowerPC architecture instructions in the
10896 General Purpose group, including floating-point square root.  Specifying
10897 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10898 use the optional PowerPC architecture instructions in the Graphics
10899 group, including floating-point select.
10901 The @option{-mmfcrf} option allows GCC to generate the move from
10902 condition register field instruction implemented on the POWER4
10903 processor and other processors that support the PowerPC V2.01
10904 architecture.
10905 The @option{-mpopcntb} option allows GCC to generate the popcount and
10906 double precision FP reciprocal estimate instruction implemented on the
10907 POWER5 processor and other processors that support the PowerPC V2.02
10908 architecture.
10909 The @option{-mfprnd} option allows GCC to generate the FP round to
10910 integer instructions implemented on the POWER5+ processor and other
10911 processors that support the PowerPC V2.03 architecture.
10913 The @option{-mpowerpc64} option allows GCC to generate the additional
10914 64-bit instructions that are found in the full PowerPC64 architecture
10915 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10916 @option{-mno-powerpc64}.
10918 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10919 will use only the instructions in the common subset of both
10920 architectures plus some special AIX common-mode calls, and will not use
10921 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10922 permits GCC to use any instruction from either architecture and to
10923 allow use of the MQ register; specify this for the Motorola MPC601.
10925 @item -mnew-mnemonics
10926 @itemx -mold-mnemonics
10927 @opindex mnew-mnemonics
10928 @opindex mold-mnemonics
10929 Select which mnemonics to use in the generated assembler code.  With
10930 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10931 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10932 assembler mnemonics defined for the POWER architecture.  Instructions
10933 defined in only one architecture have only one mnemonic; GCC uses that
10934 mnemonic irrespective of which of these options is specified.
10936 GCC defaults to the mnemonics appropriate for the architecture in
10937 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10938 value of these option.  Unless you are building a cross-compiler, you
10939 should normally not specify either @option{-mnew-mnemonics} or
10940 @option{-mold-mnemonics}, but should instead accept the default.
10942 @item -mcpu=@var{cpu_type}
10943 @opindex mcpu
10944 Set architecture type, register usage, choice of mnemonics, and
10945 instruction scheduling parameters for machine type @var{cpu_type}.
10946 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10947 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10948 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10949 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10950 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10951 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
10952 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10953 @samp{power4}, @samp{power5}, @samp{power5+},
10954 @samp{common}, @samp{powerpc}, @samp{powerpc64},
10955 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10957 @option{-mcpu=common} selects a completely generic processor.  Code
10958 generated under this option will run on any POWER or PowerPC processor.
10959 GCC will use only the instructions in the common subset of both
10960 architectures, and will not use the MQ register.  GCC assumes a generic
10961 processor model for scheduling purposes.
10963 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10964 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10965 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10966 types, with an appropriate, generic processor model assumed for
10967 scheduling purposes.
10969 The other options specify a specific processor.  Code generated under
10970 those options will run best on that processor, and may not run at all on
10971 others.
10973 The @option{-mcpu} options automatically enable or disable the
10974 following options: @option{-maltivec}, @option{-mfprnd},
10975 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
10976 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
10977 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
10978 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
10979 The particular options
10980 set for any particular CPU will vary between compiler versions,
10981 depending on what setting seems to produce optimal code for that CPU;
10982 it doesn't necessarily reflect the actual hardware's capabilities.  If
10983 you wish to set an individual option to a particular value, you may
10984 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
10985 -mno-altivec}.
10987 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10988 not enabled or disabled by the @option{-mcpu} option at present because
10989 AIX does not have full support for these options.  You may still
10990 enable or disable them individually if you're sure it'll work in your
10991 environment.
10993 @item -mtune=@var{cpu_type}
10994 @opindex mtune
10995 Set the instruction scheduling parameters for machine type
10996 @var{cpu_type}, but do not set the architecture type, register usage, or
10997 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10998 values for @var{cpu_type} are used for @option{-mtune} as for
10999 @option{-mcpu}.  If both are specified, the code generated will use the
11000 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11001 scheduling parameters set by @option{-mtune}.
11003 @item -mswdiv
11004 @itemx -mno-swdiv
11005 @opindex mswdiv
11006 @opindex mno-swdiv
11007 Generate code to compute division as reciprocal estimate and iterative
11008 refinement, creating opportunities for increased throughput.  This
11009 feature requires: optional PowerPC Graphics instruction set for single
11010 precision and FRE instruction for double precision, assuming divides
11011 cannot generate user-visible traps, and the domain values not include
11012 Infinities, denormals or zero denominator.
11014 @item -maltivec
11015 @itemx -mno-altivec
11016 @opindex maltivec
11017 @opindex mno-altivec
11018 Generate code that uses (does not use) AltiVec instructions, and also
11019 enable the use of built-in functions that allow more direct access to
11020 the AltiVec instruction set.  You may also need to set
11021 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11022 enhancements.
11024 @item -mvrsave
11025 @item -mno-vrsave
11026 @opindex mvrsave
11027 @opindex mno-vrsave
11028 Generate VRSAVE instructions when generating AltiVec code.
11030 @item -mabi=spe
11031 @opindex mabi=spe
11032 Extend the current ABI with SPE ABI extensions.  This does not change
11033 the default ABI, instead it adds the SPE ABI extensions to the current
11034 ABI@.
11036 @item -mabi=no-spe
11037 @opindex mabi=no-spe
11038 Disable Booke SPE ABI extensions for the current ABI@.
11040 @item -msecure-plt
11041 @opindex msecure-plt
11042 Generate code that allows ld and ld.so to build executables and shared
11043 libraries with non-exec .plt and .got sections.  This is a PowerPC
11044 32-bit SYSV ABI option.
11046 @item -mbss-plt
11047 @opindex mbss-plt
11048 Generate code that uses a BSS .plt section that ld.so fills in, and
11049 requires .plt and .got sections that are both writable and executable.
11050 This is a PowerPC 32-bit SYSV ABI option.
11052 @item -misel
11053 @itemx -mno-isel
11054 @opindex misel
11055 @opindex mno-isel
11056 This switch enables or disables the generation of ISEL instructions.
11058 @item -misel=@var{yes/no}
11059 This switch has been deprecated.  Use @option{-misel} and
11060 @option{-mno-isel} instead.
11062 @item -mspe
11063 @itemx -mno-isel
11064 @opindex mspe
11065 @opindex mno-spe
11066 This switch enables or disables the generation of SPE simd
11067 instructions.
11069 @item -mspe=@var{yes/no}
11070 This option has been deprecated.  Use @option{-mspe} and
11071 @option{-mno-spe} instead.
11073 @item -mfloat-gprs=@var{yes/single/double/no}
11074 @itemx -mfloat-gprs
11075 @opindex mfloat-gprs
11076 This switch enables or disables the generation of floating point
11077 operations on the general purpose registers for architectures that
11078 support it.
11080 The argument @var{yes} or @var{single} enables the use of
11081 single-precision floating point operations.
11083 The argument @var{double} enables the use of single and
11084 double-precision floating point operations.
11086 The argument @var{no} disables floating point operations on the
11087 general purpose registers.
11089 This option is currently only available on the MPC854x.
11091 @item -m32
11092 @itemx -m64
11093 @opindex m32
11094 @opindex m64
11095 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11096 targets (including GNU/Linux).  The 32-bit environment sets int, long
11097 and pointer to 32 bits and generates code that runs on any PowerPC
11098 variant.  The 64-bit environment sets int to 32 bits and long and
11099 pointer to 64 bits, and generates code for PowerPC64, as for
11100 @option{-mpowerpc64}.
11102 @item -mfull-toc
11103 @itemx -mno-fp-in-toc
11104 @itemx -mno-sum-in-toc
11105 @itemx -mminimal-toc
11106 @opindex mfull-toc
11107 @opindex mno-fp-in-toc
11108 @opindex mno-sum-in-toc
11109 @opindex mminimal-toc
11110 Modify generation of the TOC (Table Of Contents), which is created for
11111 every executable file.  The @option{-mfull-toc} option is selected by
11112 default.  In that case, GCC will allocate at least one TOC entry for
11113 each unique non-automatic variable reference in your program.  GCC
11114 will also place floating-point constants in the TOC@.  However, only
11115 16,384 entries are available in the TOC@.
11117 If you receive a linker error message that saying you have overflowed
11118 the available TOC space, you can reduce the amount of TOC space used
11119 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11120 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11121 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11122 generate code to calculate the sum of an address and a constant at
11123 run-time instead of putting that sum into the TOC@.  You may specify one
11124 or both of these options.  Each causes GCC to produce very slightly
11125 slower and larger code at the expense of conserving TOC space.
11127 If you still run out of space in the TOC even when you specify both of
11128 these options, specify @option{-mminimal-toc} instead.  This option causes
11129 GCC to make only one TOC entry for every file.  When you specify this
11130 option, GCC will produce code that is slower and larger but which
11131 uses extremely little TOC space.  You may wish to use this option
11132 only on files that contain less frequently executed code.
11134 @item -maix64
11135 @itemx -maix32
11136 @opindex maix64
11137 @opindex maix32
11138 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11139 @code{long} type, and the infrastructure needed to support them.
11140 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11141 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11142 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11144 @item -mxl-compat
11145 @itemx -mno-xl-compat
11146 @opindex mxl-compat
11147 @opindex mno-xl-compat
11148 Produce code that conforms more closely to IBM XLC semantics when using
11149 AIX-compatible ABI.  Pass floating-point arguments to prototyped
11150 functions beyond the register save area (RSA) on the stack in addition
11151 to argument FPRs.  Do not assume that most significant double in 128
11152 bit long double value is properly rounded when comparing values.
11154 The AIX calling convention was extended but not initially documented to
11155 handle an obscure K&R C case of calling a function that takes the
11156 address of its arguments with fewer arguments than declared.  AIX XL
11157 compilers access floating point arguments which do not fit in the
11158 RSA from the stack when a subroutine is compiled without
11159 optimization.  Because always storing floating-point arguments on the
11160 stack is inefficient and rarely needed, this option is not enabled by
11161 default and only is necessary when calling subroutines compiled by AIX
11162 XL compilers without optimization.
11164 @item -mpe
11165 @opindex mpe
11166 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11167 application written to use message passing with special startup code to
11168 enable the application to run.  The system must have PE installed in the
11169 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11170 must be overridden with the @option{-specs=} option to specify the
11171 appropriate directory location.  The Parallel Environment does not
11172 support threads, so the @option{-mpe} option and the @option{-pthread}
11173 option are incompatible.
11175 @item -malign-natural
11176 @itemx -malign-power
11177 @opindex malign-natural
11178 @opindex malign-power
11179 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11180 @option{-malign-natural} overrides the ABI-defined alignment of larger
11181 types, such as floating-point doubles, on their natural size-based boundary.
11182 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11183 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11185 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11186 is not supported.
11188 @item -msoft-float
11189 @itemx -mhard-float
11190 @opindex msoft-float
11191 @opindex mhard-float
11192 Generate code that does not use (uses) the floating-point register set.
11193 Software floating point emulation is provided if you use the
11194 @option{-msoft-float} option, and pass the option to GCC when linking.
11196 @item -mmultiple
11197 @itemx -mno-multiple
11198 @opindex mmultiple
11199 @opindex mno-multiple
11200 Generate code that uses (does not use) the load multiple word
11201 instructions and the store multiple word instructions.  These
11202 instructions are generated by default on POWER systems, and not
11203 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11204 endian PowerPC systems, since those instructions do not work when the
11205 processor is in little endian mode.  The exceptions are PPC740 and
11206 PPC750 which permit the instructions usage in little endian mode.
11208 @item -mstring
11209 @itemx -mno-string
11210 @opindex mstring
11211 @opindex mno-string
11212 Generate code that uses (does not use) the load string instructions
11213 and the store string word instructions to save multiple registers and
11214 do small block moves.  These instructions are generated by default on
11215 POWER systems, and not generated on PowerPC systems.  Do not use
11216 @option{-mstring} on little endian PowerPC systems, since those
11217 instructions do not work when the processor is in little endian mode.
11218 The exceptions are PPC740 and PPC750 which permit the instructions
11219 usage in little endian mode.
11221 @item -mupdate
11222 @itemx -mno-update
11223 @opindex mupdate
11224 @opindex mno-update
11225 Generate code that uses (does not use) the load or store instructions
11226 that update the base register to the address of the calculated memory
11227 location.  These instructions are generated by default.  If you use
11228 @option{-mno-update}, there is a small window between the time that the
11229 stack pointer is updated and the address of the previous frame is
11230 stored, which means code that walks the stack frame across interrupts or
11231 signals may get corrupted data.
11233 @item -mfused-madd
11234 @itemx -mno-fused-madd
11235 @opindex mfused-madd
11236 @opindex mno-fused-madd
11237 Generate code that uses (does not use) the floating point multiply and
11238 accumulate instructions.  These instructions are generated by default if
11239 hardware floating is used.
11241 @item -mmulhw
11242 @itemx -mno-mulhw
11243 @opindex mmulhw
11244 @opindex mno-mulhw
11245 Generate code that uses (does not use) the half-word multiply and
11246 multiply-accumulate instructions on the IBM 405 and 440 processors.
11247 These instructions are generated by default when targetting those
11248 processors.
11250 @item -mno-bit-align
11251 @itemx -mbit-align
11252 @opindex mno-bit-align
11253 @opindex mbit-align
11254 On System V.4 and embedded PowerPC systems do not (do) force structures
11255 and unions that contain bit-fields to be aligned to the base type of the
11256 bit-field.
11258 For example, by default a structure containing nothing but 8
11259 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11260 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11261 the structure would be aligned to a 1 byte boundary and be one byte in
11262 size.
11264 @item -mno-strict-align
11265 @itemx -mstrict-align
11266 @opindex mno-strict-align
11267 @opindex mstrict-align
11268 On System V.4 and embedded PowerPC systems do not (do) assume that
11269 unaligned memory references will be handled by the system.
11271 @item -mrelocatable
11272 @itemx -mno-relocatable
11273 @opindex mrelocatable
11274 @opindex mno-relocatable
11275 On embedded PowerPC systems generate code that allows (does not allow)
11276 the program to be relocated to a different address at runtime.  If you
11277 use @option{-mrelocatable} on any module, all objects linked together must
11278 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11280 @item -mrelocatable-lib
11281 @itemx -mno-relocatable-lib
11282 @opindex mrelocatable-lib
11283 @opindex mno-relocatable-lib
11284 On embedded PowerPC systems generate code that allows (does not allow)
11285 the program to be relocated to a different address at runtime.  Modules
11286 compiled with @option{-mrelocatable-lib} can be linked with either modules
11287 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11288 with modules compiled with the @option{-mrelocatable} options.
11290 @item -mno-toc
11291 @itemx -mtoc
11292 @opindex mno-toc
11293 @opindex mtoc
11294 On System V.4 and embedded PowerPC systems do not (do) assume that
11295 register 2 contains a pointer to a global area pointing to the addresses
11296 used in the program.
11298 @item -mlittle
11299 @itemx -mlittle-endian
11300 @opindex mlittle
11301 @opindex mlittle-endian
11302 On System V.4 and embedded PowerPC systems compile code for the
11303 processor in little endian mode.  The @option{-mlittle-endian} option is
11304 the same as @option{-mlittle}.
11306 @item -mbig
11307 @itemx -mbig-endian
11308 @opindex mbig
11309 @opindex mbig-endian
11310 On System V.4 and embedded PowerPC systems compile code for the
11311 processor in big endian mode.  The @option{-mbig-endian} option is
11312 the same as @option{-mbig}.
11314 @item -mdynamic-no-pic
11315 @opindex mdynamic-no-pic
11316 On Darwin and Mac OS X systems, compile code so that it is not
11317 relocatable, but that its external references are relocatable.  The
11318 resulting code is suitable for applications, but not shared
11319 libraries.
11321 @item -mprioritize-restricted-insns=@var{priority}
11322 @opindex mprioritize-restricted-insns
11323 This option controls the priority that is assigned to
11324 dispatch-slot restricted instructions during the second scheduling
11325 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11326 @var{no/highest/second-highest} priority to dispatch slot restricted
11327 instructions.
11329 @item -msched-costly-dep=@var{dependence_type}
11330 @opindex msched-costly-dep
11331 This option controls which dependences are considered costly
11332 by the target during instruction scheduling.  The argument
11333 @var{dependence_type} takes one of the following values:
11334 @var{no}: no dependence is costly,
11335 @var{all}: all dependences are costly,
11336 @var{true_store_to_load}: a true dependence from store to load is costly,
11337 @var{store_to_load}: any dependence from store to load is costly,
11338 @var{number}: any dependence which latency >= @var{number} is costly.
11340 @item -minsert-sched-nops=@var{scheme}
11341 @opindex minsert-sched-nops
11342 This option controls which nop insertion scheme will be used during
11343 the second scheduling pass.  The argument @var{scheme} takes one of the
11344 following values:
11345 @var{no}: Don't insert nops.
11346 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11347 according to the scheduler's grouping.
11348 @var{regroup_exact}: Insert nops to force costly dependent insns into
11349 separate groups.  Insert exactly as many nops as needed to force an insn
11350 to a new group, according to the estimated processor grouping.
11351 @var{number}: Insert nops to force costly dependent insns into
11352 separate groups.  Insert @var{number} nops to force an insn to a new group.
11354 @item -mcall-sysv
11355 @opindex mcall-sysv
11356 On System V.4 and embedded PowerPC systems compile code using calling
11357 conventions that adheres to the March 1995 draft of the System V
11358 Application Binary Interface, PowerPC processor supplement.  This is the
11359 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11361 @item -mcall-sysv-eabi
11362 @opindex mcall-sysv-eabi
11363 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11365 @item -mcall-sysv-noeabi
11366 @opindex mcall-sysv-noeabi
11367 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11369 @item -mcall-solaris
11370 @opindex mcall-solaris
11371 On System V.4 and embedded PowerPC systems compile code for the Solaris
11372 operating system.
11374 @item -mcall-linux
11375 @opindex mcall-linux
11376 On System V.4 and embedded PowerPC systems compile code for the
11377 Linux-based GNU system.
11379 @item -mcall-gnu
11380 @opindex mcall-gnu
11381 On System V.4 and embedded PowerPC systems compile code for the
11382 Hurd-based GNU system.
11384 @item -mcall-netbsd
11385 @opindex mcall-netbsd
11386 On System V.4 and embedded PowerPC systems compile code for the
11387 NetBSD operating system.
11389 @item -maix-struct-return
11390 @opindex maix-struct-return
11391 Return all structures in memory (as specified by the AIX ABI)@.
11393 @item -msvr4-struct-return
11394 @opindex msvr4-struct-return
11395 Return structures smaller than 8 bytes in registers (as specified by the
11396 SVR4 ABI)@.
11398 @item -mabi=@var{abi-type}
11399 @opindex mabi
11400 Extend the current ABI with a particular extension, or remove such extension.
11401 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11402 @var{no-spe}@.
11404 @item -mprototype
11405 @itemx -mno-prototype
11406 @opindex mprototype
11407 @opindex mno-prototype
11408 On System V.4 and embedded PowerPC systems assume that all calls to
11409 variable argument functions are properly prototyped.  Otherwise, the
11410 compiler must insert an instruction before every non prototyped call to
11411 set or clear bit 6 of the condition code register (@var{CR}) to
11412 indicate whether floating point values were passed in the floating point
11413 registers in case the function takes a variable arguments.  With
11414 @option{-mprototype}, only calls to prototyped variable argument functions
11415 will set or clear the bit.
11417 @item -msim
11418 @opindex msim
11419 On embedded PowerPC systems, assume that the startup module is called
11420 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11421 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11422 configurations.
11424 @item -mmvme
11425 @opindex mmvme
11426 On embedded PowerPC systems, assume that the startup module is called
11427 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11428 @file{libc.a}.
11430 @item -mads
11431 @opindex mads
11432 On embedded PowerPC systems, assume that the startup module is called
11433 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11434 @file{libc.a}.
11436 @item -myellowknife
11437 @opindex myellowknife
11438 On embedded PowerPC systems, assume that the startup module is called
11439 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11440 @file{libc.a}.
11442 @item -mvxworks
11443 @opindex mvxworks
11444 On System V.4 and embedded PowerPC systems, specify that you are
11445 compiling for a VxWorks system.
11447 @item -mwindiss
11448 @opindex mwindiss
11449 Specify that you are compiling for the WindISS simulation environment.
11451 @item -memb
11452 @opindex memb
11453 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11454 header to indicate that @samp{eabi} extended relocations are used.
11456 @item -meabi
11457 @itemx -mno-eabi
11458 @opindex meabi
11459 @opindex mno-eabi
11460 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11461 Embedded Applications Binary Interface (eabi) which is a set of
11462 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11463 means that the stack is aligned to an 8 byte boundary, a function
11464 @code{__eabi} is called to from @code{main} to set up the eabi
11465 environment, and the @option{-msdata} option can use both @code{r2} and
11466 @code{r13} to point to two separate small data areas.  Selecting
11467 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11468 do not call an initialization function from @code{main}, and the
11469 @option{-msdata} option will only use @code{r13} to point to a single
11470 small data area.  The @option{-meabi} option is on by default if you
11471 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11473 @item -msdata=eabi
11474 @opindex msdata=eabi
11475 On System V.4 and embedded PowerPC systems, put small initialized
11476 @code{const} global and static data in the @samp{.sdata2} section, which
11477 is pointed to by register @code{r2}.  Put small initialized
11478 non-@code{const} global and static data in the @samp{.sdata} section,
11479 which is pointed to by register @code{r13}.  Put small uninitialized
11480 global and static data in the @samp{.sbss} section, which is adjacent to
11481 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11482 incompatible with the @option{-mrelocatable} option.  The
11483 @option{-msdata=eabi} option also sets the @option{-memb} option.
11485 @item -msdata=sysv
11486 @opindex msdata=sysv
11487 On System V.4 and embedded PowerPC systems, put small global and static
11488 data in the @samp{.sdata} section, which is pointed to by register
11489 @code{r13}.  Put small uninitialized global and static data in the
11490 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11491 The @option{-msdata=sysv} option is incompatible with the
11492 @option{-mrelocatable} option.
11494 @item -msdata=default
11495 @itemx -msdata
11496 @opindex msdata=default
11497 @opindex msdata
11498 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11499 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11500 same as @option{-msdata=sysv}.
11502 @item -msdata-data
11503 @opindex msdata-data
11504 On System V.4 and embedded PowerPC systems, put small global and static
11505 data in the @samp{.sdata} section.  Put small uninitialized global and
11506 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11507 to address small data however.  This is the default behavior unless
11508 other @option{-msdata} options are used.
11510 @item -msdata=none
11511 @itemx -mno-sdata
11512 @opindex msdata=none
11513 @opindex mno-sdata
11514 On embedded PowerPC systems, put all initialized global and static data
11515 in the @samp{.data} section, and all uninitialized data in the
11516 @samp{.bss} section.
11518 @item -G @var{num}
11519 @opindex G
11520 @cindex smaller data references (PowerPC)
11521 @cindex .sdata/.sdata2 references (PowerPC)
11522 On embedded PowerPC systems, put global and static items less than or
11523 equal to @var{num} bytes into the small data or bss sections instead of
11524 the normal data or bss section.  By default, @var{num} is 8.  The
11525 @option{-G @var{num}} switch is also passed to the linker.
11526 All modules should be compiled with the same @option{-G @var{num}} value.
11528 @item -mregnames
11529 @itemx -mno-regnames
11530 @opindex mregnames
11531 @opindex mno-regnames
11532 On System V.4 and embedded PowerPC systems do (do not) emit register
11533 names in the assembly language output using symbolic forms.
11535 @item -mlongcall
11536 @itemx -mno-longcall
11537 @opindex mlongcall
11538 @opindex mno-longcall
11539 Default to making all function calls indirectly, using a register, so
11540 that functions which reside further than 32 megabytes (33,554,432
11541 bytes) from the current location can be called.  This setting can be
11542 overridden by the @code{shortcall} function attribute, or by
11543 @code{#pragma longcall(0)}.
11545 Some linkers are capable of detecting out-of-range calls and generating
11546 glue code on the fly.  On these systems, long calls are unnecessary and
11547 generate slower code.  As of this writing, the AIX linker can do this,
11548 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11549 to the GNU linker for 32-bit PowerPC systems as well.
11551 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11552 callee, L42'', plus a ``branch island'' (glue code).  The two target
11553 addresses represent the callee and the ``branch island''.  The
11554 Darwin/PPC linker will prefer the first address and generate a ``bl
11555 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11556 otherwise, the linker will generate ``bl L42'' to call the ``branch
11557 island''.  The ``branch island'' is appended to the body of the
11558 calling function; it computes the full 32-bit address of the callee
11559 and jumps to it.
11561 On Mach-O (Darwin) systems, this option directs the compiler emit to
11562 the glue for every direct call, and the Darwin linker decides whether
11563 to use or discard it.
11565 In the future, we may cause GCC to ignore all longcall specifications
11566 when the linker is known to generate glue.
11568 @item -pthread
11569 @opindex pthread
11570 Adds support for multithreading with the @dfn{pthreads} library.
11571 This option sets flags for both the preprocessor and linker.
11573 @end table
11575 @node S/390 and zSeries Options
11576 @subsection S/390 and zSeries Options
11577 @cindex S/390 and zSeries Options
11579 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11581 @table @gcctabopt
11582 @item -mhard-float
11583 @itemx -msoft-float
11584 @opindex mhard-float
11585 @opindex msoft-float
11586 Use (do not use) the hardware floating-point instructions and registers
11587 for floating-point operations.  When @option{-msoft-float} is specified,
11588 functions in @file{libgcc.a} will be used to perform floating-point
11589 operations.  When @option{-mhard-float} is specified, the compiler
11590 generates IEEE floating-point instructions.  This is the default.
11592 @item -mbackchain
11593 @itemx -mno-backchain
11594 @opindex mbackchain
11595 @opindex mno-backchain
11596 Store (do not store) the address of the caller's frame as backchain pointer
11597 into the callee's stack frame.
11598 A backchain may be needed to allow debugging using tools that do not understand
11599 DWARF-2 call frame information.
11600 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11601 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11602 the backchain is placed into the topmost word of the 96/160 byte register
11603 save area.
11605 In general, code compiled with @option{-mbackchain} is call-compatible with
11606 code compiled with @option{-mmo-backchain}; however, use of the backchain
11607 for debugging purposes usually requires that the whole binary is built with
11608 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11609 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11610 to build a linux kernel use @option{-msoft-float}.
11612 The default is to not maintain the backchain.
11614 @item -mpacked-stack
11615 @item -mno-packed-stack
11616 @opindex mpacked-stack
11617 @opindex mno-packed-stack
11618 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11619 specified, the compiler uses the all fields of the 96/160 byte register save
11620 area only for their default purpose; unused fields still take up stack space.
11621 When @option{-mpacked-stack} is specified, register save slots are densely
11622 packed at the top of the register save area; unused space is reused for other
11623 purposes, allowing for more efficient use of the available stack space.
11624 However, when @option{-mbackchain} is also in effect, the topmost word of
11625 the save area is always used to store the backchain, and the return address
11626 register is always saved two words below the backchain.
11628 As long as the stack frame backchain is not used, code generated with
11629 @option{-mpacked-stack} is call-compatible with code generated with
11630 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11631 S/390 or zSeries generated code that uses the stack frame backchain at run
11632 time, not just for debugging purposes.  Such code is not call-compatible
11633 with code compiled with @option{-mpacked-stack}.  Also, note that the
11634 combination of @option{-mbackchain},
11635 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11636 to build a linux kernel use @option{-msoft-float}.
11638 The default is to not use the packed stack layout.
11640 @item -msmall-exec
11641 @itemx -mno-small-exec
11642 @opindex msmall-exec
11643 @opindex mno-small-exec
11644 Generate (or do not generate) code using the @code{bras} instruction
11645 to do subroutine calls.
11646 This only works reliably if the total executable size does not
11647 exceed 64k.  The default is to use the @code{basr} instruction instead,
11648 which does not have this limitation.
11650 @item -m64
11651 @itemx -m31
11652 @opindex m64
11653 @opindex m31
11654 When @option{-m31} is specified, generate code compliant to the
11655 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11656 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11657 particular to generate 64-bit instructions.  For the @samp{s390}
11658 targets, the default is @option{-m31}, while the @samp{s390x}
11659 targets default to @option{-m64}.
11661 @item -mzarch
11662 @itemx -mesa
11663 @opindex mzarch
11664 @opindex mesa
11665 When @option{-mzarch} is specified, generate code using the
11666 instructions available on z/Architecture.
11667 When @option{-mesa} is specified, generate code using the
11668 instructions available on ESA/390.  Note that @option{-mesa} is
11669 not possible with @option{-m64}.
11670 When generating code compliant to the GNU/Linux for S/390 ABI,
11671 the default is @option{-mesa}.  When generating code compliant
11672 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11674 @item -mmvcle
11675 @itemx -mno-mvcle
11676 @opindex mmvcle
11677 @opindex mno-mvcle
11678 Generate (or do not generate) code using the @code{mvcle} instruction
11679 to perform block moves.  When @option{-mno-mvcle} is specified,
11680 use a @code{mvc} loop instead.  This is the default unless optimizing for
11681 size.
11683 @item -mdebug
11684 @itemx -mno-debug
11685 @opindex mdebug
11686 @opindex mno-debug
11687 Print (or do not print) additional debug information when compiling.
11688 The default is to not print debug information.
11690 @item -march=@var{cpu-type}
11691 @opindex march
11692 Generate code that will run on @var{cpu-type}, which is the name of a system
11693 representing a certain processor type.  Possible values for
11694 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11695 When generating code using the instructions available on z/Architecture,
11696 the default is @option{-march=z900}.  Otherwise, the default is
11697 @option{-march=g5}.
11699 @item -mtune=@var{cpu-type}
11700 @opindex mtune
11701 Tune to @var{cpu-type} everything applicable about the generated code,
11702 except for the ABI and the set of available instructions.
11703 The list of @var{cpu-type} values is the same as for @option{-march}.
11704 The default is the value used for @option{-march}.
11706 @item -mtpf-trace
11707 @itemx -mno-tpf-trace
11708 @opindex mtpf-trace
11709 @opindex mno-tpf-trace
11710 Generate code that adds (does not add) in TPF OS specific branches to trace
11711 routines in the operating system.  This option is off by default, even
11712 when compiling for the TPF OS@.
11714 @item -mfused-madd
11715 @itemx -mno-fused-madd
11716 @opindex mfused-madd
11717 @opindex mno-fused-madd
11718 Generate code that uses (does not use) the floating point multiply and
11719 accumulate instructions.  These instructions are generated by default if
11720 hardware floating point is used.
11722 @item -mwarn-framesize=@var{framesize}
11723 @opindex mwarn-framesize
11724 Emit a warning if the current function exceeds the given frame size.  Because
11725 this is a compile time check it doesn't need to be a real problem when the program
11726 runs.  It is intended to identify functions which most probably cause
11727 a stack overflow.  It is useful to be used in an environment with limited stack
11728 size e.g.@: the linux kernel.
11730 @item -mwarn-dynamicstack
11731 @opindex mwarn-dynamicstack
11732 Emit a warning if the function calls alloca or uses dynamically
11733 sized arrays.  This is generally a bad idea with a limited stack size.
11735 @item -mstack-guard=@var{stack-guard}
11736 @item -mstack-size=@var{stack-size}
11737 @opindex mstack-guard
11738 @opindex mstack-size
11739 These arguments always have to be used in conjunction.  If they are present the s390
11740 back end emits additional instructions in the function prologue which trigger a trap
11741 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11742 (remember that the stack on s390 grows downward).  These options are intended to
11743 be used to help debugging stack overflow problems.  The additionally emitted code
11744 causes only little overhead and hence can also be used in production like systems
11745 without greater performance degradation.  The given values have to be exact
11746 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11747 exceeding 64k.
11748 In order to be efficient the extra code makes the assumption that the stack starts
11749 at an address aligned to the value given by @var{stack-size}.
11750 @end table
11752 @node SH Options
11753 @subsection SH Options
11755 These @samp{-m} options are defined for the SH implementations:
11757 @table @gcctabopt
11758 @item -m1
11759 @opindex m1
11760 Generate code for the SH1.
11762 @item -m2
11763 @opindex m2
11764 Generate code for the SH2.
11766 @item -m2e
11767 Generate code for the SH2e.
11769 @item -m3
11770 @opindex m3
11771 Generate code for the SH3.
11773 @item -m3e
11774 @opindex m3e
11775 Generate code for the SH3e.
11777 @item -m4-nofpu
11778 @opindex m4-nofpu
11779 Generate code for the SH4 without a floating-point unit.
11781 @item -m4-single-only
11782 @opindex m4-single-only
11783 Generate code for the SH4 with a floating-point unit that only
11784 supports single-precision arithmetic.
11786 @item -m4-single
11787 @opindex m4-single
11788 Generate code for the SH4 assuming the floating-point unit is in
11789 single-precision mode by default.
11791 @item -m4
11792 @opindex m4
11793 Generate code for the SH4.
11795 @item -m4a-nofpu
11796 @opindex m4a-nofpu
11797 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11798 floating-point unit is not used.
11800 @item -m4a-single-only
11801 @opindex m4a-single-only
11802 Generate code for the SH4a, in such a way that no double-precision
11803 floating point operations are used.
11805 @item -m4a-single
11806 @opindex m4a-single
11807 Generate code for the SH4a assuming the floating-point unit is in
11808 single-precision mode by default.
11810 @item -m4a
11811 @opindex m4a
11812 Generate code for the SH4a.
11814 @item -m4al
11815 @opindex m4al
11816 Same as @option{-m4a-nofpu}, except that it implicitly passes
11817 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11818 instructions at the moment.
11820 @item -mb
11821 @opindex mb
11822 Compile code for the processor in big endian mode.
11824 @item -ml
11825 @opindex ml
11826 Compile code for the processor in little endian mode.
11828 @item -mdalign
11829 @opindex mdalign
11830 Align doubles at 64-bit boundaries.  Note that this changes the calling
11831 conventions, and thus some functions from the standard C library will
11832 not work unless you recompile it first with @option{-mdalign}.
11834 @item -mrelax
11835 @opindex mrelax
11836 Shorten some address references at link time, when possible; uses the
11837 linker option @option{-relax}.
11839 @item -mbigtable
11840 @opindex mbigtable
11841 Use 32-bit offsets in @code{switch} tables.  The default is to use
11842 16-bit offsets.
11844 @item -mfmovd
11845 @opindex mfmovd
11846 Enable the use of the instruction @code{fmovd}.
11848 @item -mhitachi
11849 @opindex mhitachi
11850 Comply with the calling conventions defined by Renesas.
11852 @item -mrenesas
11853 @opindex mhitachi
11854 Comply with the calling conventions defined by Renesas.
11856 @item -mno-renesas
11857 @opindex mhitachi
11858 Comply with the calling conventions defined for GCC before the Renesas
11859 conventions were available.  This option is the default for all
11860 targets of the SH toolchain except for @samp{sh-symbianelf}.
11862 @item -mnomacsave
11863 @opindex mnomacsave
11864 Mark the @code{MAC} register as call-clobbered, even if
11865 @option{-mhitachi} is given.
11867 @item -mieee
11868 @opindex mieee
11869 Increase IEEE-compliance of floating-point code.
11870 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11871 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11872 comparisons of NANs / infinities incurs extra overhead in every
11873 floating point comparison, therefore the default is set to
11874 @option{-ffinite-math-only}.
11876 @item -misize
11877 @opindex misize
11878 Dump instruction size and location in the assembly code.
11880 @item -mpadstruct
11881 @opindex mpadstruct
11882 This option is deprecated.  It pads structures to multiple of 4 bytes,
11883 which is incompatible with the SH ABI@.
11885 @item -mspace
11886 @opindex mspace
11887 Optimize for space instead of speed.  Implied by @option{-Os}.
11889 @item -mprefergot
11890 @opindex mprefergot
11891 When generating position-independent code, emit function calls using
11892 the Global Offset Table instead of the Procedure Linkage Table.
11894 @item -musermode
11895 @opindex musermode
11896 Generate a library function call to invalidate instruction cache
11897 entries, after fixing up a trampoline.  This library function call
11898 doesn't assume it can write to the whole memory address space.  This
11899 is the default when the target is @code{sh-*-linux*}.
11901 @item -multcost=@var{number}
11902 @opindex multcost=@var{number}
11903 Set the cost to assume for a multiply insn.
11905 @item -mdiv=@var{strategy}
11906 @opindex mdiv=@var{strategy}
11907 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11908 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11909 inv:call2, inv:fp .
11910 "fp" performs the operation in floating point.  This has a very high latency,
11911 but needs only a few instructions, so it might be a good choice if
11912 your code has enough easily exploitable ILP to allow the compiler to
11913 schedule the floating point instructions together with other instructions.
11914 Division by zero causes a floating point exception.
11915 "inv" uses integer operations to calculate the inverse of the divisor,
11916 and then multiplies the dividend with the inverse.  This strategy allows
11917 cse and hoisting of the inverse calculation.  Division by zero calculates
11918 an unspecified result, but does not trap.
11919 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11920 have been found, or if the entire operation has been hoisted to the same
11921 place, the last stages of the inverse calculation are intertwined with the
11922 final multiply to reduce the overall latency, at the expense of using a few
11923 more instructions, and thus offering fewer scheduling opportunities with
11924 other code.
11925 "call" calls a library function that usually implements the inv:minlat
11926 strategy.
11927 This gives high code density for m5-*media-nofpu compilations.
11928 "call2" uses a different entry point of the same library function, where it
11929 assumes that a pointer to a lookup table has already been set up, which
11930 exposes the pointer load to cse / code hoisting optimizations.
11931 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11932 code generation, but if the code stays unoptimized, revert to the "call",
11933 "call2", or "fp" strategies, respectively.  Note that the
11934 potentially-trapping side effect of division by zero is carried by a
11935 separate instruction, so it is possible that all the integer instructions
11936 are hoisted out, but the marker for the side effect stays where it is.
11937 A recombination to fp operations or a call is not possible in that case.
11938 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11939 that the inverse calculation was nor separated from the multiply, they speed
11940 up division where the dividend fits into 20 bits (plus sign where applicable),
11941 by inserting a test to skip a number of operations in this case; this test
11942 slows down the case of larger dividends.  inv20u assumes the case of a such
11943 a small dividend to be unlikely, and inv20l assumes it to be likely.
11945 @item -mdivsi3_libfunc=@var{name}
11946 @opindex mdivsi3_libfunc=@var{name}
11947 Set the name of the library function used for 32 bit signed division to
11948 @var{name}.  This only affect the name used in the call and inv:call
11949 division strategies, and the compiler will still expect the same
11950 sets of input/output/clobbered registers as if this option was not present.
11952 @item -madjust-unroll
11953 @opindex madjust-unroll
11954 Throttle unrolling to avoid thrashing target registers.
11955 This option only has an effect if the gcc code base supports the
11956 TARGET_ADJUST_UNROLL_MAX target hook.
11958 @item -mindexed-addressing
11959 @opindex mindexed-addressing
11960 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11961 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11962 semantics for the indexed addressing mode.  The architecture allows the
11963 implementation of processors with 64 bit MMU, which the OS could use to
11964 get 32 bit addressing, but since no current hardware implementation supports
11965 this or any other way to make the indexed addressing mode safe to use in
11966 the 32 bit ABI, the default is -mno-indexed-addressing.
11968 @item -mgettrcost=@var{number}
11969 @opindex mgettrcost=@var{number}
11970 Set the cost assumed for the gettr instruction to @var{number}.
11971 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11973 @item -mpt-fixed
11974 @opindex mpt-fixed
11975 Assume pt* instructions won't trap.  This will generally generate better
11976 scheduled code, but is unsafe on current hardware.  The current architecture
11977 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11978 This has the unintentional effect of making it unsafe to schedule ptabs /
11979 ptrel before a branch, or hoist it out of a loop.  For example,
11980 __do_global_ctors, a part of libgcc that runs constructors at program
11981 startup, calls functions in a list which is delimited by -1.  With the
11982 -mpt-fixed option, the ptabs will be done before testing against -1.
11983 That means that all the constructors will be run a bit quicker, but when
11984 the loop comes to the end of the list, the program crashes because ptabs
11985 loads -1 into a target register.  Since this option is unsafe for any
11986 hardware implementing the current architecture specification, the default
11987 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11988 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11989 this deters register allocation using target registers for storing
11990 ordinary integers.
11992 @item -minvalid-symbols
11993 @opindex minvalid-symbols
11994 Assume symbols might be invalid.  Ordinary function symbols generated by
11995 the compiler will always be valid to load with movi/shori/ptabs or
11996 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11997 to generate symbols that will cause ptabs / ptrel to trap.
11998 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11999 It will then prevent cross-basic-block cse, hoisting and most scheduling
12000 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12001 @end table
12003 @node SPARC Options
12004 @subsection SPARC Options
12005 @cindex SPARC options
12007 These @samp{-m} options are supported on the SPARC:
12009 @table @gcctabopt
12010 @item -mno-app-regs
12011 @itemx -mapp-regs
12012 @opindex mno-app-regs
12013 @opindex mapp-regs
12014 Specify @option{-mapp-regs} to generate output using the global registers
12015 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12016 is the default.
12018 To be fully SVR4 ABI compliant at the cost of some performance loss,
12019 specify @option{-mno-app-regs}.  You should compile libraries and system
12020 software with this option.
12022 @item -mfpu
12023 @itemx -mhard-float
12024 @opindex mfpu
12025 @opindex mhard-float
12026 Generate output containing floating point instructions.  This is the
12027 default.
12029 @item -mno-fpu
12030 @itemx -msoft-float
12031 @opindex mno-fpu
12032 @opindex msoft-float
12033 Generate output containing library calls for floating point.
12034 @strong{Warning:} the requisite libraries are not available for all SPARC
12035 targets.  Normally the facilities of the machine's usual C compiler are
12036 used, but this cannot be done directly in cross-compilation.  You must make
12037 your own arrangements to provide suitable library functions for
12038 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12039 @samp{sparclite-*-*} do provide software floating point support.
12041 @option{-msoft-float} changes the calling convention in the output file;
12042 therefore, it is only useful if you compile @emph{all} of a program with
12043 this option.  In particular, you need to compile @file{libgcc.a}, the
12044 library that comes with GCC, with @option{-msoft-float} in order for
12045 this to work.
12047 @item -mhard-quad-float
12048 @opindex mhard-quad-float
12049 Generate output containing quad-word (long double) floating point
12050 instructions.
12052 @item -msoft-quad-float
12053 @opindex msoft-quad-float
12054 Generate output containing library calls for quad-word (long double)
12055 floating point instructions.  The functions called are those specified
12056 in the SPARC ABI@.  This is the default.
12058 As of this writing, there are no SPARC implementations that have hardware
12059 support for the quad-word floating point instructions.  They all invoke
12060 a trap handler for one of these instructions, and then the trap handler
12061 emulates the effect of the instruction.  Because of the trap handler overhead,
12062 this is much slower than calling the ABI library routines.  Thus the
12063 @option{-msoft-quad-float} option is the default.
12065 @item -mno-unaligned-doubles
12066 @itemx -munaligned-doubles
12067 @opindex mno-unaligned-doubles
12068 @opindex munaligned-doubles
12069 Assume that doubles have 8 byte alignment.  This is the default.
12071 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12072 alignment only if they are contained in another type, or if they have an
12073 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12074 Specifying this option avoids some rare compatibility problems with code
12075 generated by other compilers.  It is not the default because it results
12076 in a performance loss, especially for floating point code.
12078 @item -mno-faster-structs
12079 @itemx -mfaster-structs
12080 @opindex mno-faster-structs
12081 @opindex mfaster-structs
12082 With @option{-mfaster-structs}, the compiler assumes that structures
12083 should have 8 byte alignment.  This enables the use of pairs of
12084 @code{ldd} and @code{std} instructions for copies in structure
12085 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12086 However, the use of this changed alignment directly violates the SPARC
12087 ABI@.  Thus, it's intended only for use on targets where the developer
12088 acknowledges that their resulting code will not be directly in line with
12089 the rules of the ABI@.
12091 @item -mimpure-text
12092 @opindex mimpure-text
12093 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12094 the compiler to not pass @option{-z text} to the linker when linking a
12095 shared object.  Using this option, you can link position-dependent
12096 code into a shared object.
12098 @option{-mimpure-text} suppresses the ``relocations remain against
12099 allocatable but non-writable sections'' linker error message.
12100 However, the necessary relocations will trigger copy-on-write, and the
12101 shared object is not actually shared across processes.  Instead of
12102 using @option{-mimpure-text}, you should compile all source code with
12103 @option{-fpic} or @option{-fPIC}.
12105 This option is only available on SunOS and Solaris.
12107 @item -mcpu=@var{cpu_type}
12108 @opindex mcpu
12109 Set the instruction set, register set, and instruction scheduling parameters
12110 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12111 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12112 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12113 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12114 @samp{ultrasparc3}.
12116 Default instruction scheduling parameters are used for values that select
12117 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12118 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12120 Here is a list of each supported architecture and their supported
12121 implementations.
12123 @smallexample
12124     v7:             cypress
12125     v8:             supersparc, hypersparc
12126     sparclite:      f930, f934, sparclite86x
12127     sparclet:       tsc701
12128     v9:             ultrasparc, ultrasparc3
12129 @end smallexample
12131 By default (unless configured otherwise), GCC generates code for the V7
12132 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12133 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12134 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12135 SPARCStation 1, 2, IPX etc.
12137 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12138 architecture.  The only difference from V7 code is that the compiler emits
12139 the integer multiply and integer divide instructions which exist in SPARC-V8
12140 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12141 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12142 2000 series.
12144 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12145 the SPARC architecture.  This adds the integer multiply, integer divide step
12146 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12147 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12148 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12149 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12150 MB86934 chip, which is the more recent SPARClite with FPU@.
12152 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12153 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12154 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12155 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12156 optimizes it for the TEMIC SPARClet chip.
12158 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12159 architecture.  This adds 64-bit integer and floating-point move instructions,
12160 3 additional floating-point condition code registers and conditional move
12161 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12162 optimizes it for the Sun UltraSPARC I/II chips.  With
12163 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12164 Sun UltraSPARC III chip.
12166 @item -mtune=@var{cpu_type}
12167 @opindex mtune
12168 Set the instruction scheduling parameters for machine type
12169 @var{cpu_type}, but do not set the instruction set or register set that the
12170 option @option{-mcpu=@var{cpu_type}} would.
12172 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12173 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12174 that select a particular cpu implementation.  Those are @samp{cypress},
12175 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12176 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12177 @samp{ultrasparc3}.
12179 @item -mv8plus
12180 @itemx -mno-v8plus
12181 @opindex mv8plus
12182 @opindex mno-v8plus
12183 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12184 difference from the V8 ABI is that the global and out registers are
12185 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12186 mode for all SPARC-V9 processors.
12188 @item -mvis
12189 @itemx -mno-vis
12190 @opindex mvis
12191 @opindex mno-vis
12192 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12193 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12194 @end table
12196 These @samp{-m} options are supported in addition to the above
12197 on SPARC-V9 processors in 64-bit environments:
12199 @table @gcctabopt
12200 @item -mlittle-endian
12201 @opindex mlittle-endian
12202 Generate code for a processor running in little-endian mode.  It is only
12203 available for a few configurations and most notably not on Solaris and Linux.
12205 @item -m32
12206 @itemx -m64
12207 @opindex m32
12208 @opindex m64
12209 Generate code for a 32-bit or 64-bit environment.
12210 The 32-bit environment sets int, long and pointer to 32 bits.
12211 The 64-bit environment sets int to 32 bits and long and pointer
12212 to 64 bits.
12214 @item -mcmodel=medlow
12215 @opindex mcmodel=medlow
12216 Generate code for the Medium/Low code model: 64-bit addresses, programs
12217 must be linked in the low 32 bits of memory.  Programs can be statically
12218 or dynamically linked.
12220 @item -mcmodel=medmid
12221 @opindex mcmodel=medmid
12222 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12223 must be linked in the low 44 bits of memory, the text and data segments must
12224 be less than 2GB in size and the data segment must be located within 2GB of
12225 the text segment.
12227 @item -mcmodel=medany
12228 @opindex mcmodel=medany
12229 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12230 may be linked anywhere in memory, the text and data segments must be less
12231 than 2GB in size and the data segment must be located within 2GB of the
12232 text segment.
12234 @item -mcmodel=embmedany
12235 @opindex mcmodel=embmedany
12236 Generate code for the Medium/Anywhere code model for embedded systems:
12237 64-bit addresses, the text and data segments must be less than 2GB in
12238 size, both starting anywhere in memory (determined at link time).  The
12239 global register %g4 points to the base of the data segment.  Programs
12240 are statically linked and PIC is not supported.
12242 @item -mstack-bias
12243 @itemx -mno-stack-bias
12244 @opindex mstack-bias
12245 @opindex mno-stack-bias
12246 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12247 frame pointer if present, are offset by @minus{}2047 which must be added back
12248 when making stack frame references.  This is the default in 64-bit mode.
12249 Otherwise, assume no such offset is present.
12250 @end table
12252 These switches are supported in addition to the above on Solaris:
12254 @table @gcctabopt
12255 @item -threads
12256 @opindex threads
12257 Add support for multithreading using the Solaris threads library.  This
12258 option sets flags for both the preprocessor and linker.  This option does
12259 not affect the thread safety of object code produced by the compiler or
12260 that of libraries supplied with it.
12262 @item -pthreads
12263 @opindex pthreads
12264 Add support for multithreading using the POSIX threads library.  This
12265 option sets flags for both the preprocessor and linker.  This option does
12266 not affect the thread safety of object code produced  by the compiler or
12267 that of libraries supplied with it.
12268 @end table
12270 @node System V Options
12271 @subsection Options for System V
12273 These additional options are available on System V Release 4 for
12274 compatibility with other compilers on those systems:
12276 @table @gcctabopt
12277 @item -G
12278 @opindex G
12279 Create a shared object.
12280 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12282 @item -Qy
12283 @opindex Qy
12284 Identify the versions of each tool used by the compiler, in a
12285 @code{.ident} assembler directive in the output.
12287 @item -Qn
12288 @opindex Qn
12289 Refrain from adding @code{.ident} directives to the output file (this is
12290 the default).
12292 @item -YP,@var{dirs}
12293 @opindex YP
12294 Search the directories @var{dirs}, and no others, for libraries
12295 specified with @option{-l}.
12297 @item -Ym,@var{dir}
12298 @opindex Ym
12299 Look in the directory @var{dir} to find the M4 preprocessor.
12300 The assembler uses this option.
12301 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12302 @c the generic assembler that comes with Solaris takes just -Ym.
12303 @end table
12305 @node TMS320C3x/C4x Options
12306 @subsection TMS320C3x/C4x Options
12307 @cindex TMS320C3x/C4x Options
12309 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12311 @table @gcctabopt
12313 @item -mcpu=@var{cpu_type}
12314 @opindex mcpu
12315 Set the instruction set, register set, and instruction scheduling
12316 parameters for machine type @var{cpu_type}.  Supported values for
12317 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12318 @samp{c44}.  The default is @samp{c40} to generate code for the
12319 TMS320C40.
12321 @item -mbig-memory
12322 @itemx -mbig
12323 @itemx -msmall-memory
12324 @itemx -msmall
12325 @opindex mbig-memory
12326 @opindex mbig
12327 @opindex msmall-memory
12328 @opindex msmall
12329 Generates code for the big or small memory model.  The small memory
12330 model assumed that all data fits into one 64K word page.  At run-time
12331 the data page (DP) register must be set to point to the 64K page
12332 containing the .bss and .data program sections.  The big memory model is
12333 the default and requires reloading of the DP register for every direct
12334 memory access.
12336 @item -mbk
12337 @itemx -mno-bk
12338 @opindex mbk
12339 @opindex mno-bk
12340 Allow (disallow) allocation of general integer operands into the block
12341 count register BK@.
12343 @item -mdb
12344 @itemx -mno-db
12345 @opindex mdb
12346 @opindex mno-db
12347 Enable (disable) generation of code using decrement and branch,
12348 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12349 on the safe side, this is disabled for the C3x, since the maximum
12350 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12351 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12352 that it can utilize the decrement and branch instruction, but will give
12353 up if there is more than one memory reference in the loop.  Thus a loop
12354 where the loop counter is decremented can generate slightly more
12355 efficient code, in cases where the RPTB instruction cannot be utilized.
12357 @item -mdp-isr-reload
12358 @itemx -mparanoid
12359 @opindex mdp-isr-reload
12360 @opindex mparanoid
12361 Force the DP register to be saved on entry to an interrupt service
12362 routine (ISR), reloaded to point to the data section, and restored on
12363 exit from the ISR@.  This should not be required unless someone has
12364 violated the small memory model by modifying the DP register, say within
12365 an object library.
12367 @item -mmpyi
12368 @itemx -mno-mpyi
12369 @opindex mmpyi
12370 @opindex mno-mpyi
12371 For the C3x use the 24-bit MPYI instruction for integer multiplies
12372 instead of a library call to guarantee 32-bit results.  Note that if one
12373 of the operands is a constant, then the multiplication will be performed
12374 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12375 then squaring operations are performed inline instead of a library call.
12377 @item -mfast-fix
12378 @itemx -mno-fast-fix
12379 @opindex mfast-fix
12380 @opindex mno-fast-fix
12381 The C3x/C4x FIX instruction to convert a floating point value to an
12382 integer value chooses the nearest integer less than or equal to the
12383 floating point value rather than to the nearest integer.  Thus if the
12384 floating point number is negative, the result will be incorrectly
12385 truncated an additional code is necessary to detect and correct this
12386 case.  This option can be used to disable generation of the additional
12387 code required to correct the result.
12389 @item -mrptb
12390 @itemx -mno-rptb
12391 @opindex mrptb
12392 @opindex mno-rptb
12393 Enable (disable) generation of repeat block sequences using the RPTB
12394 instruction for zero overhead looping.  The RPTB construct is only used
12395 for innermost loops that do not call functions or jump across the loop
12396 boundaries.  There is no advantage having nested RPTB loops due to the
12397 overhead required to save and restore the RC, RS, and RE registers.
12398 This is enabled by default with @option{-O2}.
12400 @item -mrpts=@var{count}
12401 @itemx -mno-rpts
12402 @opindex mrpts
12403 @opindex mno-rpts
12404 Enable (disable) the use of the single instruction repeat instruction
12405 RPTS@.  If a repeat block contains a single instruction, and the loop
12406 count can be guaranteed to be less than the value @var{count}, GCC will
12407 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12408 then a RPTS will be emitted even if the loop count cannot be determined
12409 at compile time.  Note that the repeated instruction following RPTS does
12410 not have to be reloaded from memory each iteration, thus freeing up the
12411 CPU buses for operands.  However, since interrupts are blocked by this
12412 instruction, it is disabled by default.
12414 @item -mloop-unsigned
12415 @itemx -mno-loop-unsigned
12416 @opindex mloop-unsigned
12417 @opindex mno-loop-unsigned
12418 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12419 is @math{2^{31} + 1} since these instructions test if the iteration count is
12420 negative to terminate the loop.  If the iteration count is unsigned
12421 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12422 exceeded.  This switch allows an unsigned iteration count.
12424 @item -mti
12425 @opindex mti
12426 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12427 with.  This also enforces compatibility with the API employed by the TI
12428 C3x C compiler.  For example, long doubles are passed as structures
12429 rather than in floating point registers.
12431 @item -mregparm
12432 @itemx -mmemparm
12433 @opindex mregparm
12434 @opindex mmemparm
12435 Generate code that uses registers (stack) for passing arguments to functions.
12436 By default, arguments are passed in registers where possible rather
12437 than by pushing arguments on to the stack.
12439 @item -mparallel-insns
12440 @itemx -mno-parallel-insns
12441 @opindex mparallel-insns
12442 @opindex mno-parallel-insns
12443 Allow the generation of parallel instructions.  This is enabled by
12444 default with @option{-O2}.
12446 @item -mparallel-mpy
12447 @itemx -mno-parallel-mpy
12448 @opindex mparallel-mpy
12449 @opindex mno-parallel-mpy
12450 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12451 provided @option{-mparallel-insns} is also specified.  These instructions have
12452 tight register constraints which can pessimize the code generation
12453 of large functions.
12455 @end table
12457 @node V850 Options
12458 @subsection V850 Options
12459 @cindex V850 Options
12461 These @samp{-m} options are defined for V850 implementations:
12463 @table @gcctabopt
12464 @item -mlong-calls
12465 @itemx -mno-long-calls
12466 @opindex mlong-calls
12467 @opindex mno-long-calls
12468 Treat all calls as being far away (near).  If calls are assumed to be
12469 far away, the compiler will always load the functions address up into a
12470 register, and call indirect through the pointer.
12472 @item -mno-ep
12473 @itemx -mep
12474 @opindex mno-ep
12475 @opindex mep
12476 Do not optimize (do optimize) basic blocks that use the same index
12477 pointer 4 or more times to copy pointer into the @code{ep} register, and
12478 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12479 option is on by default if you optimize.
12481 @item -mno-prolog-function
12482 @itemx -mprolog-function
12483 @opindex mno-prolog-function
12484 @opindex mprolog-function
12485 Do not use (do use) external functions to save and restore registers
12486 at the prologue and epilogue of a function.  The external functions
12487 are slower, but use less code space if more than one function saves
12488 the same number of registers.  The @option{-mprolog-function} option
12489 is on by default if you optimize.
12491 @item -mspace
12492 @opindex mspace
12493 Try to make the code as small as possible.  At present, this just turns
12494 on the @option{-mep} and @option{-mprolog-function} options.
12496 @item -mtda=@var{n}
12497 @opindex mtda
12498 Put static or global variables whose size is @var{n} bytes or less into
12499 the tiny data area that register @code{ep} points to.  The tiny data
12500 area can hold up to 256 bytes in total (128 bytes for byte references).
12502 @item -msda=@var{n}
12503 @opindex msda
12504 Put static or global variables whose size is @var{n} bytes or less into
12505 the small data area that register @code{gp} points to.  The small data
12506 area can hold up to 64 kilobytes.
12508 @item -mzda=@var{n}
12509 @opindex mzda
12510 Put static or global variables whose size is @var{n} bytes or less into
12511 the first 32 kilobytes of memory.
12513 @item -mv850
12514 @opindex mv850
12515 Specify that the target processor is the V850.
12517 @item -mbig-switch
12518 @opindex mbig-switch
12519 Generate code suitable for big switch tables.  Use this option only if
12520 the assembler/linker complain about out of range branches within a switch
12521 table.
12523 @item -mapp-regs
12524 @opindex mapp-regs
12525 This option will cause r2 and r5 to be used in the code generated by
12526 the compiler.  This setting is the default.
12528 @item -mno-app-regs
12529 @opindex mno-app-regs
12530 This option will cause r2 and r5 to be treated as fixed registers.
12532 @item -mv850e1
12533 @opindex mv850e1
12534 Specify that the target processor is the V850E1.  The preprocessor
12535 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12536 this option is used.
12538 @item -mv850e
12539 @opindex mv850e
12540 Specify that the target processor is the V850E@.  The preprocessor
12541 constant @samp{__v850e__} will be defined if this option is used.
12543 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12544 are defined then a default target processor will be chosen and the
12545 relevant @samp{__v850*__} preprocessor constant will be defined.
12547 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12548 defined, regardless of which processor variant is the target.
12550 @item -mdisable-callt
12551 @opindex mdisable-callt
12552 This option will suppress generation of the CALLT instruction for the
12553 v850e and v850e1 flavors of the v850 architecture.  The default is
12554 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12556 @end table
12558 @node VAX Options
12559 @subsection VAX Options
12560 @cindex VAX options
12562 These @samp{-m} options are defined for the VAX:
12564 @table @gcctabopt
12565 @item -munix
12566 @opindex munix
12567 Do not output certain jump instructions (@code{aobleq} and so on)
12568 that the Unix assembler for the VAX cannot handle across long
12569 ranges.
12571 @item -mgnu
12572 @opindex mgnu
12573 Do output those jump instructions, on the assumption that you
12574 will assemble with the GNU assembler.
12576 @item -mg
12577 @opindex mg
12578 Output code for g-format floating point numbers instead of d-format.
12579 @end table
12581 @node x86-64 Options
12582 @subsection x86-64 Options
12583 @cindex x86-64 options
12585 These are listed under @xref{i386 and x86-64 Options}.
12587 @node Xstormy16 Options
12588 @subsection Xstormy16 Options
12589 @cindex Xstormy16 Options
12591 These options are defined for Xstormy16:
12593 @table @gcctabopt
12594 @item -msim
12595 @opindex msim
12596 Choose startup files and linker script suitable for the simulator.
12597 @end table
12599 @node Xtensa Options
12600 @subsection Xtensa Options
12601 @cindex Xtensa Options
12603 These options are supported for Xtensa targets:
12605 @table @gcctabopt
12606 @item -mconst16
12607 @itemx -mno-const16
12608 @opindex mconst16
12609 @opindex mno-const16
12610 Enable or disable use of @code{CONST16} instructions for loading
12611 constant values.  The @code{CONST16} instruction is currently not a
12612 standard option from Tensilica.  When enabled, @code{CONST16}
12613 instructions are always used in place of the standard @code{L32R}
12614 instructions.  The use of @code{CONST16} is enabled by default only if
12615 the @code{L32R} instruction is not available.
12617 @item -mfused-madd
12618 @itemx -mno-fused-madd
12619 @opindex mfused-madd
12620 @opindex mno-fused-madd
12621 Enable or disable use of fused multiply/add and multiply/subtract
12622 instructions in the floating-point option.  This has no effect if the
12623 floating-point option is not also enabled.  Disabling fused multiply/add
12624 and multiply/subtract instructions forces the compiler to use separate
12625 instructions for the multiply and add/subtract operations.  This may be
12626 desirable in some cases where strict IEEE 754-compliant results are
12627 required: the fused multiply add/subtract instructions do not round the
12628 intermediate result, thereby producing results with @emph{more} bits of
12629 precision than specified by the IEEE standard.  Disabling fused multiply
12630 add/subtract instructions also ensures that the program output is not
12631 sensitive to the compiler's ability to combine multiply and add/subtract
12632 operations.
12634 @item -mtext-section-literals
12635 @itemx -mno-text-section-literals
12636 @opindex mtext-section-literals
12637 @opindex mno-text-section-literals
12638 Control the treatment of literal pools.  The default is
12639 @option{-mno-text-section-literals}, which places literals in a separate
12640 section in the output file.  This allows the literal pool to be placed
12641 in a data RAM/ROM, and it also allows the linker to combine literal
12642 pools from separate object files to remove redundant literals and
12643 improve code size.  With @option{-mtext-section-literals}, the literals
12644 are interspersed in the text section in order to keep them as close as
12645 possible to their references.  This may be necessary for large assembly
12646 files.
12648 @item -mtarget-align
12649 @itemx -mno-target-align
12650 @opindex mtarget-align
12651 @opindex mno-target-align
12652 When this option is enabled, GCC instructs the assembler to
12653 automatically align instructions to reduce branch penalties at the
12654 expense of some code density.  The assembler attempts to widen density
12655 instructions to align branch targets and the instructions following call
12656 instructions.  If there are not enough preceding safe density
12657 instructions to align a target, no widening will be performed.  The
12658 default is @option{-mtarget-align}.  These options do not affect the
12659 treatment of auto-aligned instructions like @code{LOOP}, which the
12660 assembler will always align, either by widening density instructions or
12661 by inserting no-op instructions.
12663 @item -mlongcalls
12664 @itemx -mno-longcalls
12665 @opindex mlongcalls
12666 @opindex mno-longcalls
12667 When this option is enabled, GCC instructs the assembler to translate
12668 direct calls to indirect calls unless it can determine that the target
12669 of a direct call is in the range allowed by the call instruction.  This
12670 translation typically occurs for calls to functions in other source
12671 files.  Specifically, the assembler translates a direct @code{CALL}
12672 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12673 The default is @option{-mno-longcalls}.  This option should be used in
12674 programs where the call target can potentially be out of range.  This
12675 option is implemented in the assembler, not the compiler, so the
12676 assembly code generated by GCC will still show direct call
12677 instructions---look at the disassembled object code to see the actual
12678 instructions.  Note that the assembler will use an indirect call for
12679 every cross-file call, not just those that really will be out of range.
12680 @end table
12682 @node zSeries Options
12683 @subsection zSeries Options
12684 @cindex zSeries options
12686 These are listed under @xref{S/390 and zSeries Options}.
12688 @node Code Gen Options
12689 @section Options for Code Generation Conventions
12690 @cindex code generation conventions
12691 @cindex options, code generation
12692 @cindex run-time options
12694 These machine-independent options control the interface conventions
12695 used in code generation.
12697 Most of them have both positive and negative forms; the negative form
12698 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12699 one of the forms is listed---the one which is not the default.  You
12700 can figure out the other form by either removing @samp{no-} or adding
12703 @table @gcctabopt
12704 @item -fbounds-check
12705 @opindex fbounds-check
12706 For front-ends that support it, generate additional code to check that
12707 indices used to access arrays are within the declared range.  This is
12708 currently only supported by the Java and Fortran 77 front-ends, where
12709 this option defaults to true and false respectively.
12711 @item -ftrapv
12712 @opindex ftrapv
12713 This option generates traps for signed overflow on addition, subtraction,
12714 multiplication operations.
12716 @item -fwrapv
12717 @opindex fwrapv
12718 This option instructs the compiler to assume that signed arithmetic
12719 overflow of addition, subtraction and multiplication wraps around
12720 using twos-complement representation.  This flag enables some optimizations
12721 and disables others.  This option is enabled by default for the Java
12722 front-end, as required by the Java language specification.
12724 @item -fexceptions
12725 @opindex fexceptions
12726 Enable exception handling.  Generates extra code needed to propagate
12727 exceptions.  For some targets, this implies GCC will generate frame
12728 unwind information for all functions, which can produce significant data
12729 size overhead, although it does not affect execution.  If you do not
12730 specify this option, GCC will enable it by default for languages like
12731 C++ which normally require exception handling, and disable it for
12732 languages like C that do not normally require it.  However, you may need
12733 to enable this option when compiling C code that needs to interoperate
12734 properly with exception handlers written in C++.  You may also wish to
12735 disable this option if you are compiling older C++ programs that don't
12736 use exception handling.
12738 @item -fnon-call-exceptions
12739 @opindex fnon-call-exceptions
12740 Generate code that allows trapping instructions to throw exceptions.
12741 Note that this requires platform-specific runtime support that does
12742 not exist everywhere.  Moreover, it only allows @emph{trapping}
12743 instructions to throw exceptions, i.e.@: memory references or floating
12744 point instructions.  It does not allow exceptions to be thrown from
12745 arbitrary signal handlers such as @code{SIGALRM}.
12747 @item -funwind-tables
12748 @opindex funwind-tables
12749 Similar to @option{-fexceptions}, except that it will just generate any needed
12750 static data, but will not affect the generated code in any other way.
12751 You will normally not enable this option; instead, a language processor
12752 that needs this handling would enable it on your behalf.
12754 @item -fasynchronous-unwind-tables
12755 @opindex fasynchronous-unwind-tables
12756 Generate unwind table in dwarf2 format, if supported by target machine.  The
12757 table is exact at each instruction boundary, so it can be used for stack
12758 unwinding from asynchronous events (such as debugger or garbage collector).
12760 @item -fpcc-struct-return
12761 @opindex fpcc-struct-return
12762 Return ``short'' @code{struct} and @code{union} values in memory like
12763 longer ones, rather than in registers.  This convention is less
12764 efficient, but it has the advantage of allowing intercallability between
12765 GCC-compiled files and files compiled with other compilers, particularly
12766 the Portable C Compiler (pcc).
12768 The precise convention for returning structures in memory depends
12769 on the target configuration macros.
12771 Short structures and unions are those whose size and alignment match
12772 that of some integer type.
12774 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12775 switch is not binary compatible with code compiled with the
12776 @option{-freg-struct-return} switch.
12777 Use it to conform to a non-default application binary interface.
12779 @item -freg-struct-return
12780 @opindex freg-struct-return
12781 Return @code{struct} and @code{union} values in registers when possible.
12782 This is more efficient for small structures than
12783 @option{-fpcc-struct-return}.
12785 If you specify neither @option{-fpcc-struct-return} nor
12786 @option{-freg-struct-return}, GCC defaults to whichever convention is
12787 standard for the target.  If there is no standard convention, GCC
12788 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12789 the principal compiler.  In those cases, we can choose the standard, and
12790 we chose the more efficient register return alternative.
12792 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12793 switch is not binary compatible with code compiled with the
12794 @option{-fpcc-struct-return} switch.
12795 Use it to conform to a non-default application binary interface.
12797 @item -fshort-enums
12798 @opindex fshort-enums
12799 Allocate to an @code{enum} type only as many bytes as it needs for the
12800 declared range of possible values.  Specifically, the @code{enum} type
12801 will be equivalent to the smallest integer type which has enough room.
12803 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12804 code that is not binary compatible with code generated without that switch.
12805 Use it to conform to a non-default application binary interface.
12807 @item -fshort-double
12808 @opindex fshort-double
12809 Use the same size for @code{double} as for @code{float}.
12811 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12812 code that is not binary compatible with code generated without that switch.
12813 Use it to conform to a non-default application binary interface.
12815 @item -fshort-wchar
12816 @opindex fshort-wchar
12817 Override the underlying type for @samp{wchar_t} to be @samp{short
12818 unsigned int} instead of the default for the target.  This option is
12819 useful for building programs to run under WINE@.
12821 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12822 code that is not binary compatible with code generated without that switch.
12823 Use it to conform to a non-default application binary interface.
12825 @item -fshared-data
12826 @opindex fshared-data
12827 Requests that the data and non-@code{const} variables of this
12828 compilation be shared data rather than private data.  The distinction
12829 makes sense only on certain operating systems, where shared data is
12830 shared between processes running the same program, while private data
12831 exists in one copy per process.
12833 @item -fno-common
12834 @opindex fno-common
12835 In C, allocate even uninitialized global variables in the data section of the
12836 object file, rather than generating them as common blocks.  This has the
12837 effect that if the same variable is declared (without @code{extern}) in
12838 two different compilations, you will get an error when you link them.
12839 The only reason this might be useful is if you wish to verify that the
12840 program will work on other systems which always work this way.
12842 @item -fno-ident
12843 @opindex fno-ident
12844 Ignore the @samp{#ident} directive.
12846 @item -finhibit-size-directive
12847 @opindex finhibit-size-directive
12848 Don't output a @code{.size} assembler directive, or anything else that
12849 would cause trouble if the function is split in the middle, and the
12850 two halves are placed at locations far apart in memory.  This option is
12851 used when compiling @file{crtstuff.c}; you should not need to use it
12852 for anything else.
12854 @item -fverbose-asm
12855 @opindex fverbose-asm
12856 Put extra commentary information in the generated assembly code to
12857 make it more readable.  This option is generally only of use to those
12858 who actually need to read the generated assembly code (perhaps while
12859 debugging the compiler itself).
12861 @option{-fno-verbose-asm}, the default, causes the
12862 extra information to be omitted and is useful when comparing two assembler
12863 files.
12865 @item -fpic
12866 @opindex fpic
12867 @cindex global offset table
12868 @cindex PIC
12869 Generate position-independent code (PIC) suitable for use in a shared
12870 library, if supported for the target machine.  Such code accesses all
12871 constant addresses through a global offset table (GOT)@.  The dynamic
12872 loader resolves the GOT entries when the program starts (the dynamic
12873 loader is not part of GCC; it is part of the operating system).  If
12874 the GOT size for the linked executable exceeds a machine-specific
12875 maximum size, you get an error message from the linker indicating that
12876 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12877 instead.  (These maximums are 8k on the SPARC and 32k
12878 on the m68k and RS/6000.  The 386 has no such limit.)
12880 Position-independent code requires special support, and therefore works
12881 only on certain machines.  For the 386, GCC supports PIC for System V
12882 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12883 position-independent.
12885 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12886 are defined to 1.
12888 @item -fPIC
12889 @opindex fPIC
12890 If supported for the target machine, emit position-independent code,
12891 suitable for dynamic linking and avoiding any limit on the size of the
12892 global offset table.  This option makes a difference on the m68k,
12893 PowerPC and SPARC@.
12895 Position-independent code requires special support, and therefore works
12896 only on certain machines.
12898 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12899 are defined to 2.
12901 @item -fpie
12902 @itemx -fPIE
12903 @opindex fpie
12904 @opindex fPIE
12905 These options are similar to @option{-fpic} and @option{-fPIC}, but
12906 generated position independent code can be only linked into executables.
12907 Usually these options are used when @option{-pie} GCC option will be
12908 used during linking.
12910 @item -fno-jump-tables
12911 @opindex fno-jump-tables
12912 Do not use jump tables for switch statements even where it would be
12913 more efficient than other code generation strategies.  This option is
12914 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12915 building code which forms part of a dynamic linker and cannot
12916 reference the address of a jump table.  On some targets, jump tables
12917 do not require a GOT and this option is not needed.
12919 @item -ffixed-@var{reg}
12920 @opindex ffixed
12921 Treat the register named @var{reg} as a fixed register; generated code
12922 should never refer to it (except perhaps as a stack pointer, frame
12923 pointer or in some other fixed role).
12925 @var{reg} must be the name of a register.  The register names accepted
12926 are machine-specific and are defined in the @code{REGISTER_NAMES}
12927 macro in the machine description macro file.
12929 This flag does not have a negative form, because it specifies a
12930 three-way choice.
12932 @item -fcall-used-@var{reg}
12933 @opindex fcall-used
12934 Treat the register named @var{reg} as an allocable register that is
12935 clobbered by function calls.  It may be allocated for temporaries or
12936 variables that do not live across a call.  Functions compiled this way
12937 will not save and restore the register @var{reg}.
12939 It is an error to used this flag with the frame pointer or stack pointer.
12940 Use of this flag for other registers that have fixed pervasive roles in
12941 the machine's execution model will produce disastrous results.
12943 This flag does not have a negative form, because it specifies a
12944 three-way choice.
12946 @item -fcall-saved-@var{reg}
12947 @opindex fcall-saved
12948 Treat the register named @var{reg} as an allocable register saved by
12949 functions.  It may be allocated even for temporaries or variables that
12950 live across a call.  Functions compiled this way will save and restore
12951 the register @var{reg} if they use it.
12953 It is an error to used this flag with the frame pointer or stack pointer.
12954 Use of this flag for other registers that have fixed pervasive roles in
12955 the machine's execution model will produce disastrous results.
12957 A different sort of disaster will result from the use of this flag for
12958 a register in which function values may be returned.
12960 This flag does not have a negative form, because it specifies a
12961 three-way choice.
12963 @item -fpack-struct[=@var{n}]
12964 @opindex fpack-struct
12965 Without a value specified, pack all structure members together without
12966 holes.  When a value is specified (which must be a small power of two), pack
12967 structure members according to this value, representing the maximum
12968 alignment (that is, objects with default alignment requirements larger than
12969 this will be output potentially unaligned at the next fitting location.
12971 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12972 code that is not binary compatible with code generated without that switch.
12973 Additionally, it makes the code suboptimal.
12974 Use it to conform to a non-default application binary interface.
12976 @item -finstrument-functions
12977 @opindex finstrument-functions
12978 Generate instrumentation calls for entry and exit to functions.  Just
12979 after function entry and just before function exit, the following
12980 profiling functions will be called with the address of the current
12981 function and its call site.  (On some platforms,
12982 @code{__builtin_return_address} does not work beyond the current
12983 function, so the call site information may not be available to the
12984 profiling functions otherwise.)
12986 @smallexample
12987 void __cyg_profile_func_enter (void *this_fn,
12988                                void *call_site);
12989 void __cyg_profile_func_exit  (void *this_fn,
12990                                void *call_site);
12991 @end smallexample
12993 The first argument is the address of the start of the current function,
12994 which may be looked up exactly in the symbol table.
12996 This instrumentation is also done for functions expanded inline in other
12997 functions.  The profiling calls will indicate where, conceptually, the
12998 inline function is entered and exited.  This means that addressable
12999 versions of such functions must be available.  If all your uses of a
13000 function are expanded inline, this may mean an additional expansion of
13001 code size.  If you use @samp{extern inline} in your C code, an
13002 addressable version of such functions must be provided.  (This is
13003 normally the case anyways, but if you get lucky and the optimizer always
13004 expands the functions inline, you might have gotten away without
13005 providing static copies.)
13007 A function may be given the attribute @code{no_instrument_function}, in
13008 which case this instrumentation will not be done.  This can be used, for
13009 example, for the profiling functions listed above, high-priority
13010 interrupt routines, and any functions from which the profiling functions
13011 cannot safely be called (perhaps signal handlers, if the profiling
13012 routines generate output or allocate memory).
13014 @item -fstack-check
13015 @opindex fstack-check
13016 Generate code to verify that you do not go beyond the boundary of the
13017 stack.  You should specify this flag if you are running in an
13018 environment with multiple threads, but only rarely need to specify it in
13019 a single-threaded environment since stack overflow is automatically
13020 detected on nearly all systems if there is only one stack.
13022 Note that this switch does not actually cause checking to be done; the
13023 operating system must do that.  The switch causes generation of code
13024 to ensure that the operating system sees the stack being extended.
13026 @item -fstack-limit-register=@var{reg}
13027 @itemx -fstack-limit-symbol=@var{sym}
13028 @itemx -fno-stack-limit
13029 @opindex fstack-limit-register
13030 @opindex fstack-limit-symbol
13031 @opindex fno-stack-limit
13032 Generate code to ensure that the stack does not grow beyond a certain value,
13033 either the value of a register or the address of a symbol.  If the stack
13034 would grow beyond the value, a signal is raised.  For most targets,
13035 the signal is raised before the stack overruns the boundary, so
13036 it is possible to catch the signal without taking special precautions.
13038 For instance, if the stack starts at absolute address @samp{0x80000000}
13039 and grows downwards, you can use the flags
13040 @option{-fstack-limit-symbol=__stack_limit} and
13041 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13042 of 128KB@.  Note that this may only work with the GNU linker.
13044 @cindex aliasing of parameters
13045 @cindex parameters, aliased
13046 @item -fargument-alias
13047 @itemx -fargument-noalias
13048 @itemx -fargument-noalias-global
13049 @opindex fargument-alias
13050 @opindex fargument-noalias
13051 @opindex fargument-noalias-global
13052 Specify the possible relationships among parameters and between
13053 parameters and global data.
13055 @option{-fargument-alias} specifies that arguments (parameters) may
13056 alias each other and may alias global storage.@*
13057 @option{-fargument-noalias} specifies that arguments do not alias
13058 each other, but may alias global storage.@*
13059 @option{-fargument-noalias-global} specifies that arguments do not
13060 alias each other and do not alias global storage.
13062 Each language will automatically use whatever option is required by
13063 the language standard.  You should not need to use these options yourself.
13065 @item -fleading-underscore
13066 @opindex fleading-underscore
13067 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13068 change the way C symbols are represented in the object file.  One use
13069 is to help link with legacy assembly code.
13071 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13072 generate code that is not binary compatible with code generated without that
13073 switch.  Use it to conform to a non-default application binary interface.
13074 Not all targets provide complete support for this switch.
13076 @item -ftls-model=@var{model}
13077 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13078 The @var{model} argument should be one of @code{global-dynamic},
13079 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13081 The default without @option{-fpic} is @code{initial-exec}; with
13082 @option{-fpic} the default is @code{global-dynamic}.
13084 @item -fvisibility=@var{default|internal|hidden|protected}
13085 @opindex fvisibility
13086 Set the default ELF image symbol visibility to the specified option---all
13087 symbols will be marked with this unless overridden within the code.
13088 Using this feature can very substantially improve linking and
13089 load times of shared object libraries, produce more optimized
13090 code, provide near-perfect API export and prevent symbol clashes.
13091 It is @strong{strongly} recommended that you use this in any shared objects
13092 you distribute.
13094 Despite the nomenclature, @code{default} always means public ie;
13095 available to be linked against from outside the shared object.
13096 @code{protected} and @code{internal} are pretty useless in real-world
13097 usage so the only other commonly used option will be @code{hidden}.
13098 The default if @option{-fvisibility} isn't specified is
13099 @code{default}, i.e., make every
13100 symbol public---this causes the same behavior as previous versions of
13101 GCC@.
13103 A good explanation of the benefits offered by ensuring ELF
13104 symbols have the correct visibility is given by ``How To Write
13105 Shared Libraries'' by Ulrich Drepper (which can be found at
13106 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13107 solution made possible by this option to marking things hidden when
13108 the default is public is to make the default hidden and mark things
13109 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13110 and @code{__attribute__ ((visibility("default")))} instead of
13111 @code{__declspec(dllexport)} you get almost identical semantics with
13112 identical syntax.  This is a great boon to those working with
13113 cross-platform projects.
13115 For those adding visibility support to existing code, you may find
13116 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13117 the declarations you wish to set visibility for with (for example)
13118 @samp{#pragma GCC visibility push(hidden)} and
13119 @samp{#pragma GCC visibility pop}.
13120 Bear in mind that symbol visibility should be viewed @strong{as
13121 part of the API interface contract} and thus all new code should
13122 always specify visibility when it is not the default ie; declarations
13123 only for use within the local DSO should @strong{always} be marked explicitly
13124 as hidden as so to avoid PLT indirection overheads---making this
13125 abundantly clear also aids readability and self-documentation of the code.
13126 Note that due to ISO C++ specification requirements, operator new and
13127 operator delete must always be of default visibility.
13129 An overview of these techniques, their benefits and how to use them
13130 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13132 @end table
13134 @c man end
13136 @node Environment Variables
13137 @section Environment Variables Affecting GCC
13138 @cindex environment variables
13140 @c man begin ENVIRONMENT
13141 This section describes several environment variables that affect how GCC
13142 operates.  Some of them work by specifying directories or prefixes to use
13143 when searching for various kinds of files.  Some are used to specify other
13144 aspects of the compilation environment.
13146 Note that you can also specify places to search using options such as
13147 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13148 take precedence over places specified using environment variables, which
13149 in turn take precedence over those specified by the configuration of GCC@.
13150 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13151 GNU Compiler Collection (GCC) Internals}.
13153 @table @env
13154 @item LANG
13155 @itemx LC_CTYPE
13156 @c @itemx LC_COLLATE
13157 @itemx LC_MESSAGES
13158 @c @itemx LC_MONETARY
13159 @c @itemx LC_NUMERIC
13160 @c @itemx LC_TIME
13161 @itemx LC_ALL
13162 @findex LANG
13163 @findex LC_CTYPE
13164 @c @findex LC_COLLATE
13165 @findex LC_MESSAGES
13166 @c @findex LC_MONETARY
13167 @c @findex LC_NUMERIC
13168 @c @findex LC_TIME
13169 @findex LC_ALL
13170 @cindex locale
13171 These environment variables control the way that GCC uses
13172 localization information that allow GCC to work with different
13173 national conventions.  GCC inspects the locale categories
13174 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13175 so.  These locale categories can be set to any value supported by your
13176 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13177 Kingdom encoded in UTF-8.
13179 The @env{LC_CTYPE} environment variable specifies character
13180 classification.  GCC uses it to determine the character boundaries in
13181 a string; this is needed for some multibyte encodings that contain quote
13182 and escape characters that would otherwise be interpreted as a string
13183 end or escape.
13185 The @env{LC_MESSAGES} environment variable specifies the language to
13186 use in diagnostic messages.
13188 If the @env{LC_ALL} environment variable is set, it overrides the value
13189 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13190 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13191 environment variable.  If none of these variables are set, GCC
13192 defaults to traditional C English behavior.
13194 @item TMPDIR
13195 @findex TMPDIR
13196 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13197 files.  GCC uses temporary files to hold the output of one stage of
13198 compilation which is to be used as input to the next stage: for example,
13199 the output of the preprocessor, which is the input to the compiler
13200 proper.
13202 @item GCC_EXEC_PREFIX
13203 @findex GCC_EXEC_PREFIX
13204 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13205 names of the subprograms executed by the compiler.  No slash is added
13206 when this prefix is combined with the name of a subprogram, but you can
13207 specify a prefix that ends with a slash if you wish.
13209 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13210 an appropriate prefix to use based on the pathname it was invoked with.
13212 If GCC cannot find the subprogram using the specified prefix, it
13213 tries looking in the usual places for the subprogram.
13215 The default value of @env{GCC_EXEC_PREFIX} is
13216 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13217 of @code{prefix} when you ran the @file{configure} script.
13219 Other prefixes specified with @option{-B} take precedence over this prefix.
13221 This prefix is also used for finding files such as @file{crt0.o} that are
13222 used for linking.
13224 In addition, the prefix is used in an unusual way in finding the
13225 directories to search for header files.  For each of the standard
13226 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13227 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13228 replacing that beginning with the specified prefix to produce an
13229 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13230 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13231 These alternate directories are searched first; the standard directories
13232 come next.
13234 @item COMPILER_PATH
13235 @findex COMPILER_PATH
13236 The value of @env{COMPILER_PATH} is a colon-separated list of
13237 directories, much like @env{PATH}.  GCC tries the directories thus
13238 specified when searching for subprograms, if it can't find the
13239 subprograms using @env{GCC_EXEC_PREFIX}.
13241 @item LIBRARY_PATH
13242 @findex LIBRARY_PATH
13243 The value of @env{LIBRARY_PATH} is a colon-separated list of
13244 directories, much like @env{PATH}.  When configured as a native compiler,
13245 GCC tries the directories thus specified when searching for special
13246 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13247 using GCC also uses these directories when searching for ordinary
13248 libraries for the @option{-l} option (but directories specified with
13249 @option{-L} come first).
13251 @item LANG
13252 @findex LANG
13253 @cindex locale definition
13254 This variable is used to pass locale information to the compiler.  One way in
13255 which this information is used is to determine the character set to be used
13256 when character literals, string literals and comments are parsed in C and C++.
13257 When the compiler is configured to allow multibyte characters,
13258 the following values for @env{LANG} are recognized:
13260 @table @samp
13261 @item C-JIS
13262 Recognize JIS characters.
13263 @item C-SJIS
13264 Recognize SJIS characters.
13265 @item C-EUCJP
13266 Recognize EUCJP characters.
13267 @end table
13269 If @env{LANG} is not defined, or if it has some other value, then the
13270 compiler will use mblen and mbtowc as defined by the default locale to
13271 recognize and translate multibyte characters.
13272 @end table
13274 @noindent
13275 Some additional environments variables affect the behavior of the
13276 preprocessor.
13278 @include cppenv.texi
13280 @c man end
13282 @node Precompiled Headers
13283 @section Using Precompiled Headers
13284 @cindex precompiled headers
13285 @cindex speed of compilation
13287 Often large projects have many header files that are included in every
13288 source file.  The time the compiler takes to process these header files
13289 over and over again can account for nearly all of the time required to
13290 build the project.  To make builds faster, GCC allows users to
13291 `precompile' a header file; then, if builds can use the precompiled
13292 header file they will be much faster.
13294 To create a precompiled header file, simply compile it as you would any
13295 other file, if necessary using the @option{-x} option to make the driver
13296 treat it as a C or C++ header file.  You will probably want to use a
13297 tool like @command{make} to keep the precompiled header up-to-date when
13298 the headers it contains change.
13300 A precompiled header file will be searched for when @code{#include} is
13301 seen in the compilation.  As it searches for the included file
13302 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13303 compiler looks for a precompiled header in each directory just before it
13304 looks for the include file in that directory.  The name searched for is
13305 the name specified in the @code{#include} with @samp{.gch} appended.  If
13306 the precompiled header file can't be used, it is ignored.
13308 For instance, if you have @code{#include "all.h"}, and you have
13309 @file{all.h.gch} in the same directory as @file{all.h}, then the
13310 precompiled header file will be used if possible, and the original
13311 header will be used otherwise.
13313 Alternatively, you might decide to put the precompiled header file in a
13314 directory and use @option{-I} to ensure that directory is searched
13315 before (or instead of) the directory containing the original header.
13316 Then, if you want to check that the precompiled header file is always
13317 used, you can put a file of the same name as the original header in this
13318 directory containing an @code{#error} command.
13320 This also works with @option{-include}.  So yet another way to use
13321 precompiled headers, good for projects not designed with precompiled
13322 header files in mind, is to simply take most of the header files used by
13323 a project, include them from another header file, precompile that header
13324 file, and @option{-include} the precompiled header.  If the header files
13325 have guards against multiple inclusion, they will be skipped because
13326 they've already been included (in the precompiled header).
13328 If you need to precompile the same header file for different
13329 languages, targets, or compiler options, you can instead make a
13330 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13331 header in the directory, perhaps using @option{-o}.  It doesn't matter
13332 what you call the files in the directory, every precompiled header in
13333 the directory will be considered.  The first precompiled header
13334 encountered in the directory that is valid for this compilation will
13335 be used; they're searched in no particular order.
13337 There are many other possibilities, limited only by your imagination,
13338 good sense, and the constraints of your build system.
13340 A precompiled header file can be used only when these conditions apply:
13342 @itemize
13343 @item
13344 Only one precompiled header can be used in a particular compilation.
13346 @item
13347 A precompiled header can't be used once the first C token is seen.  You
13348 can have preprocessor directives before a precompiled header; you can
13349 even include a precompiled header from inside another header, so long as
13350 there are no C tokens before the @code{#include}.
13352 @item
13353 The precompiled header file must be produced for the same language as
13354 the current compilation.  You can't use a C precompiled header for a C++
13355 compilation.
13357 @item
13358 The precompiled header file must have been produced by the same compiler
13359 binary as the current compilation is using.
13361 @item
13362 Any macros defined before the precompiled header is included must
13363 either be defined in the same way as when the precompiled header was
13364 generated, or must not affect the precompiled header, which usually
13365 means that they don't appear in the precompiled header at all.
13367 The @option{-D} option is one way to define a macro before a
13368 precompiled header is included; using a @code{#define} can also do it.
13369 There are also some options that define macros implicitly, like
13370 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13371 defined this way.
13373 @item If debugging information is output when using the precompiled
13374 header, using @option{-g} or similar, the same kind of debugging information
13375 must have been output when building the precompiled header.  However,
13376 a precompiled header built using @option{-g} can be used in a compilation
13377 when no debugging information is being output.
13379 @item The same @option{-m} options must generally be used when building
13380 and using the precompiled header.  @xref{Submodel Options},
13381 for any cases where this rule is relaxed.
13383 @item Each of the following options must be the same when building and using
13384 the precompiled header:
13386 @gccoptlist{-fexceptions -funit-at-a-time}
13388 @item
13389 Some other command-line options starting with @option{-f},
13390 @option{-p}, or @option{-O} must be defined in the same way as when
13391 the precompiled header was generated.  At present, it's not clear
13392 which options are safe to change and which are not; the safest choice
13393 is to use exactly the same options when generating and using the
13394 precompiled header.  The following are known to be safe:
13396 @gccoptlist{-fmessage-length= -fpreprocessed
13397 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13398 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13399 -pedantic-errors}
13401 @end itemize
13403 For all of these except the last, the compiler will automatically
13404 ignore the precompiled header if the conditions aren't met.  If you
13405 find an option combination that doesn't work and doesn't cause the
13406 precompiled header to be ignored, please consider filing a bug report,
13407 see @ref{Bugs}.
13409 If you do use differing options when generating and using the
13410 precompiled header, the actual behavior will be a mixture of the
13411 behavior for the options.  For instance, if you use @option{-g} to
13412 generate the precompiled header but not when using it, you may or may
13413 not get debugging information for routines in the precompiled header.
13415 @node Running Protoize
13416 @section Running Protoize
13418 The program @code{protoize} is an optional part of GCC@.  You can use
13419 it to add prototypes to a program, thus converting the program to ISO
13420 C in one respect.  The companion program @code{unprotoize} does the
13421 reverse: it removes argument types from any prototypes that are found.
13423 When you run these programs, you must specify a set of source files as
13424 command line arguments.  The conversion programs start out by compiling
13425 these files to see what functions they define.  The information gathered
13426 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13428 After scanning comes actual conversion.  The specified files are all
13429 eligible to be converted; any files they include (whether sources or
13430 just headers) are eligible as well.
13432 But not all the eligible files are converted.  By default,
13433 @code{protoize} and @code{unprotoize} convert only source and header
13434 files in the current directory.  You can specify additional directories
13435 whose files should be converted with the @option{-d @var{directory}}
13436 option.  You can also specify particular files to exclude with the
13437 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13438 directory name matches one of the specified directory names, and its
13439 name within the directory has not been excluded.
13441 Basic conversion with @code{protoize} consists of rewriting most
13442 function definitions and function declarations to specify the types of
13443 the arguments.  The only ones not rewritten are those for varargs
13444 functions.
13446 @code{protoize} optionally inserts prototype declarations at the
13447 beginning of the source file, to make them available for any calls that
13448 precede the function's definition.  Or it can insert prototype
13449 declarations with block scope in the blocks where undeclared functions
13450 are called.
13452 Basic conversion with @code{unprotoize} consists of rewriting most
13453 function declarations to remove any argument types, and rewriting
13454 function definitions to the old-style pre-ISO form.
13456 Both conversion programs print a warning for any function declaration or
13457 definition that they can't convert.  You can suppress these warnings
13458 with @option{-q}.
13460 The output from @code{protoize} or @code{unprotoize} replaces the
13461 original source file.  The original file is renamed to a name ending
13462 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13463 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13464 for DOS) file already exists, then the source file is simply discarded.
13466 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13467 scan the program and collect information about the functions it uses.
13468 So neither of these programs will work until GCC is installed.
13470 Here is a table of the options you can use with @code{protoize} and
13471 @code{unprotoize}.  Each option works with both programs unless
13472 otherwise stated.
13474 @table @code
13475 @item -B @var{directory}
13476 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13477 usual directory (normally @file{/usr/local/lib}).  This file contains
13478 prototype information about standard system functions.  This option
13479 applies only to @code{protoize}.
13481 @item -c @var{compilation-options}
13482 Use @var{compilation-options} as the options when running @command{gcc} to
13483 produce the @samp{.X} files.  The special option @option{-aux-info} is
13484 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13486 Note that the compilation options must be given as a single argument to
13487 @code{protoize} or @code{unprotoize}.  If you want to specify several
13488 @command{gcc} options, you must quote the entire set of compilation options
13489 to make them a single word in the shell.
13491 There are certain @command{gcc} arguments that you cannot use, because they
13492 would produce the wrong kind of output.  These include @option{-g},
13493 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13494 the @var{compilation-options}, they are ignored.
13496 @item -C
13497 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13498 systems) instead of @samp{.c}.  This is convenient if you are converting
13499 a C program to C++.  This option applies only to @code{protoize}.
13501 @item -g
13502 Add explicit global declarations.  This means inserting explicit
13503 declarations at the beginning of each source file for each function
13504 that is called in the file and was not declared.  These declarations
13505 precede the first function definition that contains a call to an
13506 undeclared function.  This option applies only to @code{protoize}.
13508 @item -i @var{string}
13509 Indent old-style parameter declarations with the string @var{string}.
13510 This option applies only to @code{protoize}.
13512 @code{unprotoize} converts prototyped function definitions to old-style
13513 function definitions, where the arguments are declared between the
13514 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13515 uses five spaces as the indentation.  If you want to indent with just
13516 one space instead, use @option{-i " "}.
13518 @item -k
13519 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13520 is finished.
13522 @item -l
13523 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13524 a prototype declaration for each function in each block which calls the
13525 function without any declaration.  This option applies only to
13526 @code{protoize}.
13528 @item -n
13529 Make no real changes.  This mode just prints information about the conversions
13530 that would have been done without @option{-n}.
13532 @item -N
13533 Make no @samp{.save} files.  The original files are simply deleted.
13534 Use this option with caution.
13536 @item -p @var{program}
13537 Use the program @var{program} as the compiler.  Normally, the name
13538 @file{gcc} is used.
13540 @item -q
13541 Work quietly.  Most warnings are suppressed.
13543 @item -v
13544 Print the version number, just like @option{-v} for @command{gcc}.
13545 @end table
13547 If you need special compiler options to compile one of your program's
13548 source files, then you should generate that file's @samp{.X} file
13549 specially, by running @command{gcc} on that source file with the
13550 appropriate options and the option @option{-aux-info}.  Then run
13551 @code{protoize} on the entire set of files.  @code{protoize} will use
13552 the existing @samp{.X} file because it is newer than the source file.
13553 For example:
13555 @smallexample
13556 gcc -Dfoo=bar file1.c -aux-info file1.X
13557 protoize *.c
13558 @end smallexample
13560 @noindent
13561 You need to include the special files along with the rest in the
13562 @code{protoize} command, even though their @samp{.X} files already
13563 exist, because otherwise they won't get converted.
13565 @xref{Protoize Caveats}, for more information on how to use
13566 @code{protoize} successfully.