* basic-block.h, config/i386/winnt.c, config/pa/pa.c,
[official-gcc.git] / gcc / doc / invoke.texi
blob3dbefc03fe8a1ff10c15e49c0b78d2b8cf38f649
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 INCLUDE
8 @include gcc-vers.texi
9 @c man end
11 @c man begin COPYRIGHT
12 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
13 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.2 or
17 any later version published by the Free Software Foundation; with the
18 Invariant Sections being ``GNU General Public License'' and ``Funding
19 Free Software'', the Front-Cover texts being (a) (see below), and with
20 the Back-Cover Texts being (b) (see below).  A copy of the license is
21 included in the gfdl(7) man page.
23 (a) The FSF's Front-Cover Text is:
25      A GNU Manual
27 (b) The FSF's Back-Cover Text is:
29      You have freedom to copy and modify this GNU Manual, like GNU
30      software.  Copies published by the Free Software Foundation raise
31      funds for GNU development.
32 @c man end
33 @c Set file name and title for the man page.
34 @setfilename gcc
35 @settitle GNU project C and C++ compiler
36 @c man begin SYNOPSIS
37 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
43     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45 Only the most useful options are listed here; see below for the
46 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
47 @c man end
48 @c man begin SEEALSO
49 gpl(7), gfdl(7), fsf-funding(7),
50 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
52 @file{ld}, @file{binutils} and @file{gdb}.
53 @c man end
54 @c man begin BUGS
55 For instructions on reporting bugs, see
56 @w{@uref{http://gcc.gnu.org/bugs.html}}.
57 @c man end
58 @c man begin AUTHOR
59 See the Info entry for @command{gcc}, or
60 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61 for contributors to GCC@.
62 @c man end
63 @end ignore
65 @node Invoking GCC
66 @chapter GCC Command Options
67 @cindex GCC command options
68 @cindex command options
69 @cindex options, GCC command
71 @c man begin DESCRIPTION
72 When you invoke GCC, it normally does preprocessing, compilation,
73 assembly and linking.  The ``overall options'' allow you to stop this
74 process at an intermediate stage.  For example, the @option{-c} option
75 says not to run the linker.  Then the output consists of object files
76 output by the assembler.
78 Other options are passed on to one stage of processing.  Some options
79 control the preprocessor and others the compiler itself.  Yet other
80 options control the assembler and linker; most of these are not
81 documented here, since you rarely need to use any of them.
83 @cindex C compilation options
84 Most of the command line options that you can use with GCC are useful
85 for C programs; when an option is only useful with another language
86 (usually C++), the explanation says so explicitly.  If the description
87 for a particular option does not mention a source language, you can use
88 that option with all supported languages.
90 @cindex C++ compilation options
91 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92 options for compiling C++ programs.
94 @cindex grouping options
95 @cindex options, grouping
96 The @command{gcc} program accepts options and file names as operands.  Many
97 options have multi-letter names; therefore multiple single-letter options
98 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
99 -r}}.
101 @cindex order of options
102 @cindex options, order
103 You can mix options and other arguments.  For the most part, the order
104 you use doesn't matter.  Order does matter when you use several options
105 of the same kind; for example, if you specify @option{-L} more than once,
106 the directories are searched in the order specified.
108 Many options have long names starting with @samp{-f} or with
109 @samp{-W}---for example, 
110 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
111 these have both positive and negative forms; the negative form of
112 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
113 only one of these two forms, whichever one is not the default.
115 @c man end
117 @xref{Option Index}, for an index to GCC's options.
119 @menu
120 * Option Summary::      Brief list of all options, without explanations.
121 * Overall Options::     Controlling the kind of output:
122                         an executable, object files, assembler files,
123                         or preprocessed source.
124 * Invoking G++::        Compiling C++ programs.
125 * C Dialect Options::   Controlling the variant of C language compiled.
126 * C++ Dialect Options:: Variations on C++.
127 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128                         and Objective-C++.
129 * Language Independent Options:: Controlling how diagnostics should be
130                         formatted.
131 * Warning Options::     How picky should the compiler be?
132 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
133 * Optimize Options::    How much optimization?
134 * Preprocessor Options:: Controlling header files and macro definitions.
135                          Also, getting dependency information for Make.
136 * Assembler Options::   Passing options to the assembler.
137 * Link Options::        Specifying libraries and so on.
138 * Directory Options::   Where to find header files and libraries.
139                         Where to find the compiler executable files.
140 * Spec Files::          How to pass switches to sub-processes.
141 * Target Options::      Running a cross-compiler, or an old version of GCC.
142 * Submodel Options::    Specifying minor hardware or convention variations,
143                         such as 68010 vs 68020.
144 * Code Gen Options::    Specifying conventions for function calls, data layout
145                         and register usage.
146 * Environment Variables:: Env vars that affect GCC.
147 * Precompiled Headers:: Compiling a header once, and using it many times.
148 * Running Protoize::    Automatically adding or removing function prototypes.
149 @end menu
151 @c man begin OPTIONS
153 @node Option Summary
154 @section Option Summary
156 Here is a summary of all the options, grouped by type.  Explanations are
157 in the following sections.
159 @table @emph
160 @item Overall Options
161 @xref{Overall Options,,Options Controlling the Kind of Output}.
162 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
163 -x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
165 @item C Language Options
166 @xref{C Dialect Options,,Options Controlling C Dialect}.
167 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
168 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
169 -fhosted  -ffreestanding  -fms-extensions @gol
170 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
171 -fallow-single-precision  -fcond-mismatch @gol
172 -fsigned-bitfields  -fsigned-char @gol
173 -funsigned-bitfields  -funsigned-char}
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
178 -fconserve-space  -ffriend-injection  -fno-const-strings @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs @gol
181 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
182 -fno-implicit-templates @gol
183 -fno-implicit-inline-templates @gol
184 -fno-implement-inlines  -fms-extensions @gol
185 -fno-nonansi-builtins  -fno-operator-names @gol
186 -fno-optional-diags  -fpermissive @gol
187 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
188 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
189 -fno-default-inline  -fvisibility-inlines-hidden @gol
190 -Wabi  -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor  -Wreorder @gol
192 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
193 -Wno-non-template-friend  -Wold-style-cast @gol
194 -Woverloaded-virtual  -Wno-pmf-conversions @gol
195 -Wsign-promo}
197 @item Objective-C and Objective-C++ Language Options
198 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199 Objective-C and Objective-C++ Dialects}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime @gol
203 -fno-nil-receivers @gol
204 -fobjc-call-cxx-cdtors @gol
205 -fobjc-direct-dispatch @gol
206 -fobjc-exceptions @gol
207 -fobjc-gc @gol
208 -freplace-objc-classes @gol
209 -fzero-link @gol
210 -gen-decls @gol
211 -Wassign-intercept @gol
212 -Wno-protocol  -Wselector @gol
213 -Wstrict-selector-match @gol
214 -Wundeclared-selector}
216 @item Language Independent Options
217 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218 @gccoptlist{-fmessage-length=@var{n}  @gol
219 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
220 -fdiagnostics-show-options
222 @item Warning Options
223 @xref{Warning Options,,Options to Request or Suppress Warnings}.
224 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
225 -w  -Wextra  -Wall  -Waggregate-return -Walways-true -Wno-attributes @gol
226 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
227 -Wconversion  -Wno-deprecated-declarations @gol
228 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
229 -Werror  -Werror-implicit-function-declaration @gol
230 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
231 -Wno-format-extra-args -Wformat-nonliteral @gol
232 -Wformat-security  -Wformat-y2k @gol
233 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
234 -Wimport  -Wno-import  -Winit-self  -Winline @gol
235 -Wno-int-to-pointer-cast @gol
236 -Wno-invalid-offsetof  -Winvalid-pch @gol
237 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
238 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
239 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
240 -Wmissing-noreturn @gol
241 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
242 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
243 -Wredundant-decls @gol
244 -Wreturn-type  -Wsequence-point  -Wshadow @gol
245 -Wsign-compare  -Wstack-protector @gol
246 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
247 -Wstring-literal-comparison @gol
248 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
249 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
250 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
251 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
252 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
253 -Wvolatile-register-var  -Wwrite-strings}
255 @item C-only Warning Options
256 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
257 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
258 -Wstrict-prototypes  -Wtraditional @gol
259 -Wdeclaration-after-statement -Wno-pointer-sign}
261 @item Debugging Options
262 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
263 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
264 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
265 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
266 -fdump-ipa-all -fdump-ipa-cgraph @gol
267 -fdump-tree-all @gol
268 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
269 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272 -fdump-tree-ch @gol
273 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-nrv -fdump-tree-vect @gol
282 -fdump-tree-sink @gol
283 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-salias @gol
285 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
287 -ftree-vectorizer-verbose=@var{n} @gol
288 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
289 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
290 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
291 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
292 -ftest-coverage  -ftime-report -fvar-tracking @gol
293 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
294 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
295 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
296 -print-multi-directory  -print-multi-lib @gol
297 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
298 -save-temps  -time}
300 @item Optimization Options
301 @xref{Optimize Options,,Options that Control Optimization}.
302 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
303 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
304 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
305 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
306 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
307 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
308 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
309 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
310 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
311 -fforce-addr  -ffunction-sections @gol
312 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
313 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
314 -finline-functions  -finline-functions-called-once @gol
315 -finline-limit=@var{n}  -fkeep-inline-functions @gol
316 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
317 -fmodulo-sched -fno-branch-count-reg @gol
318 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
319 -fno-function-cse  -fno-guess-branch-probability @gol
320 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
321 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
322 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
323 -fomit-frame-pointer  -foptimize-register-move @gol
324 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
325 -fprofile-generate -fprofile-use @gol
326 -fregmove  -frename-registers @gol
327 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
328 -frerun-cse-after-loop  -frerun-loop-opt @gol
329 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
330 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
331 -fsched-spec-load-dangerous  @gol
332 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
333 -fsched2-use-superblocks @gol
334 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
335 -fsignaling-nans -fsingle-precision-constant  @gol
336 -fstack-protector  -fstack-protector-all @gol
337 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
338 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
339 -fsplit-ivs-in-unroller -funswitch-loops @gol
340 -fvariable-expansion-in-unroller @gol
341 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
342 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
343 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
344 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
345 -ftree-vect-loop-version -ftree-salias -fweb @gol
346 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
347 --param @var{name}=@var{value}
348 -O  -O0  -O1  -O2  -O3  -Os}
350 @item Preprocessor Options
351 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
352 @gccoptlist{-A@var{question}=@var{answer} @gol
353 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
354 -C  -dD  -dI  -dM  -dN @gol
355 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
356 -idirafter @var{dir} @gol
357 -include @var{file}  -imacros @var{file} @gol
358 -iprefix @var{file}  -iwithprefix @var{dir} @gol
359 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
360 -isysroot @var{dir} @gol
361 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
362 -P  -fworking-directory  -remap @gol
363 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
364 -Xpreprocessor @var{option}}
366 @item Assembler Option
367 @xref{Assembler Options,,Passing Options to the Assembler}.
368 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
370 @item Linker Options
371 @xref{Link Options,,Options for Linking}.
372 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
373 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
374 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
375 -Wl,@var{option}  -Xlinker @var{option} @gol
376 -u @var{symbol}}
378 @item Directory Options
379 @xref{Directory Options,,Options for Directory Search}.
380 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
381 -specs=@var{file}  -I- --sysroot=@var{dir}}
383 @item Target Options
384 @c I wrote this xref this way to avoid overfull hbox. -- rms
385 @xref{Target Options}.
386 @gccoptlist{-V @var{version}  -b @var{machine}}
388 @item Machine Dependent Options
389 @xref{Submodel Options,,Hardware Models and Configurations}.
390 @c This list is ordered alphanumerically by subsection name.
391 @c Try and put the significant identifier (CPU or system) first,
392 @c so users have a clue at guessing where the ones they want will be.
394 @emph{ARC Options}
395 @gccoptlist{-EB  -EL @gol
396 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
397 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
399 @emph{ARM Options}
400 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
401 -mabi=@var{name} @gol
402 -mapcs-stack-check  -mno-apcs-stack-check @gol
403 -mapcs-float  -mno-apcs-float @gol
404 -mapcs-reentrant  -mno-apcs-reentrant @gol
405 -msched-prolog  -mno-sched-prolog @gol
406 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
407 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
408 -mthumb-interwork  -mno-thumb-interwork @gol
409 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
410 -mstructure-size-boundary=@var{n} @gol
411 -mabort-on-noreturn @gol
412 -mlong-calls  -mno-long-calls @gol
413 -msingle-pic-base  -mno-single-pic-base @gol
414 -mpic-register=@var{reg} @gol
415 -mnop-fun-dllimport @gol
416 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
417 -mpoke-function-name @gol
418 -mthumb  -marm @gol
419 -mtpcs-frame  -mtpcs-leaf-frame @gol
420 -mcaller-super-interworking  -mcallee-super-interworking @gol
421 -mtp=@var{name}}
423 @emph{AVR Options}
424 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
425 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
427 @emph{Blackfin Options}
428 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
429 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
430 -mlow-64k -mno-low64k -mid-shared-library @gol
431 -mno-id-shared-library -mshared-library-id=@var{n} @gol
432 -mlong-calls  -mno-long-calls}
434 @emph{CRIS Options}
435 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
436 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
437 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
438 -mstack-align  -mdata-align  -mconst-align @gol
439 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
440 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
441 -mmul-bug-workaround  -mno-mul-bug-workaround}
443 @emph{CRX Options}
444 @gccoptlist{-mmac -mpush-args}
446 @emph{Darwin Options}
447 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
448 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
449 -client_name  -compatibility_version  -current_version @gol
450 -dead_strip @gol
451 -dependency-file  -dylib_file  -dylinker_install_name @gol
452 -dynamic  -dynamiclib  -exported_symbols_list @gol
453 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
454 -force_flat_namespace  -headerpad_max_install_names @gol
455 -image_base  -init  -install_name  -keep_private_externs @gol
456 -multi_module  -multiply_defined  -multiply_defined_unused @gol
457 -noall_load   -no_dead_strip_inits_and_terms @gol
458 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
459 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
460 -private_bundle  -read_only_relocs  -sectalign @gol
461 -sectobjectsymbols  -whyload  -seg1addr @gol
462 -sectcreate  -sectobjectsymbols  -sectorder @gol
463 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
464 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
465 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
466 -single_module  -static  -sub_library  -sub_umbrella @gol
467 -twolevel_namespace  -umbrella  -undefined @gol
468 -unexported_symbols_list  -weak_reference_mismatches @gol
469 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
470 -mone-byte-bool}
472 @emph{DEC Alpha Options}
473 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
474 -mieee  -mieee-with-inexact  -mieee-conformant @gol
475 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
476 -mtrap-precision=@var{mode}  -mbuild-constants @gol
477 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
478 -mbwx  -mmax  -mfix  -mcix @gol
479 -mfloat-vax  -mfloat-ieee @gol
480 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
481 -msmall-text  -mlarge-text @gol
482 -mmemory-latency=@var{time}}
484 @emph{DEC Alpha/VMS Options}
485 @gccoptlist{-mvms-return-codes}
487 @emph{FRV Options}
488 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
489 -mhard-float  -msoft-float @gol
490 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
491 -mdouble  -mno-double @gol
492 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
493 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
494 -mlinked-fp  -mlong-calls  -malign-labels @gol
495 -mlibrary-pic  -macc-4  -macc-8 @gol
496 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
497 -moptimize-membar -mno-optimize-membar @gol
498 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
499 -mvliw-branch  -mno-vliw-branch @gol
500 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
501 -mno-nested-cond-exec  -mtomcat-stats @gol
502 -mTLS -mtls @gol
503 -mcpu=@var{cpu}}
505 @emph{H8/300 Options}
506 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
508 @emph{HPPA Options}
509 @gccoptlist{-march=@var{architecture-type} @gol
510 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
511 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
512 -mfixed-range=@var{register-range} @gol
513 -mjump-in-delay -mlinker-opt -mlong-calls @gol
514 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
515 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
516 -mno-jump-in-delay  -mno-long-load-store @gol
517 -mno-portable-runtime  -mno-soft-float @gol
518 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
519 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
520 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
521 -munix=@var{unix-std}  -nolibdld  -static  -threads}
523 @emph{i386 and x86-64 Options}
524 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
525 -mfpmath=@var{unit} @gol
526 -masm=@var{dialect}  -mno-fancy-math-387 @gol
527 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
528 -mno-wide-multiply  -mrtd  -malign-double @gol
529 -mpreferred-stack-boundary=@var{num} @gol
530 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
531 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
532 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
533 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
534 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
535 -mcmodel=@var{code-model} @gol
536 -m32  -m64 -mlarge-data-threshold=@var{num}}
538 @emph{IA-64 Options}
539 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
540 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
541 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
542 -minline-float-divide-max-throughput @gol
543 -minline-int-divide-min-latency @gol
544 -minline-int-divide-max-throughput  @gol
545 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
546 -mno-dwarf2-asm -mearly-stop-bits @gol
547 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
548 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
550 @emph{M32R/D Options}
551 @gccoptlist{-m32r2 -m32rx -m32r @gol
552 -mdebug @gol
553 -malign-loops -mno-align-loops @gol
554 -missue-rate=@var{number} @gol
555 -mbranch-cost=@var{number} @gol
556 -mmodel=@var{code-size-model-type} @gol
557 -msdata=@var{sdata-type} @gol
558 -mno-flush-func -mflush-func=@var{name} @gol
559 -mno-flush-trap -mflush-trap=@var{number} @gol
560 -G @var{num}}
562 @emph{M32C Options}
563 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
565 @emph{M680x0 Options}
566 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
567 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
568 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
569 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
570 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
572 @emph{M68hc1x Options}
573 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
574 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
575 -msoft-reg-count=@var{count}}
577 @emph{MCore Options}
578 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
579 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
580 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
581 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
582 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
584 @emph{MIPS Options}
585 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
586 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
587 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
588 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
589 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
590 -mdsp  -mpaired-single  -mips3d @gol
591 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
592 -G@var{num}  -membedded-data  -mno-embedded-data @gol
593 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
594 -msplit-addresses  -mno-split-addresses  @gol
595 -mexplicit-relocs  -mno-explicit-relocs  @gol
596 -mcheck-zero-division  -mno-check-zero-division @gol
597 -mdivide-traps  -mdivide-breaks @gol
598 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
599 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
600 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
601 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
602 -mfix-sb1  -mno-fix-sb1 @gol
603 -mflush-func=@var{func}  -mno-flush-func @gol
604 -mbranch-likely  -mno-branch-likely @gol
605 -mfp-exceptions -mno-fp-exceptions @gol
606 -mvr4130-align -mno-vr4130-align}
608 @emph{MMIX Options}
609 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
610 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
611 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
612 -mno-base-addresses  -msingle-exit  -mno-single-exit}
614 @emph{MN10300 Options}
615 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
616 -mam33  -mno-am33 @gol
617 -mam33-2  -mno-am33-2 @gol
618 -mreturn-pointer-on-d0 @gol
619 -mno-crt0  -mrelax}
621 @emph{MT Options}
622 @gccoptlist{-mno-crt0 -mbacc -msim @gol
623 -march=@var{cpu-type} }
625 @emph{PDP-11 Options}
626 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
627 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
628 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
629 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
630 -mbranch-expensive  -mbranch-cheap @gol
631 -msplit  -mno-split  -munix-asm  -mdec-asm}
633 @emph{PowerPC Options}
634 See RS/6000 and PowerPC Options.
636 @emph{RS/6000 and PowerPC Options}
637 @gccoptlist{-mcpu=@var{cpu-type} @gol
638 -mtune=@var{cpu-type} @gol
639 -mpower  -mno-power  -mpower2  -mno-power2 @gol
640 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
641 -maltivec  -mno-altivec @gol
642 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
643 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
644 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
645 -mnew-mnemonics  -mold-mnemonics @gol
646 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
647 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
648 -malign-power  -malign-natural @gol
649 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
650 -mstring  -mno-string  -mupdate  -mno-update @gol
651 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
652 -mstrict-align  -mno-strict-align  -mrelocatable @gol
653 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
654 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
655 -mdynamic-no-pic  -maltivec  -mswdiv @gol
656 -mprioritize-restricted-insns=@var{priority} @gol
657 -msched-costly-dep=@var{dependence_type} @gol
658 -minsert-sched-nops=@var{scheme} @gol
659 -mcall-sysv  -mcall-netbsd @gol
660 -maix-struct-return  -msvr4-struct-return @gol
661 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
662 -misel -mno-isel @gol
663 -misel=yes  -misel=no @gol
664 -mspe -mno-spe @gol
665 -mspe=yes  -mspe=no @gol
666 -mvrsave -mno-vrsave @gol
667 -mmulhw -mno-mulhw @gol
668 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
669 -mprototype  -mno-prototype @gol
670 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
671 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
673 @emph{S/390 and zSeries Options}
674 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
675 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
676 -mpacked-stack  -mno-packed-stack @gol
677 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
678 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
679 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
680 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
682 @emph{SH Options}
683 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
684 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
685 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
686 -m5-64media  -m5-64media-nofpu @gol
687 -m5-32media  -m5-32media-nofpu @gol
688 -m5-compact  -m5-compact-nofpu @gol
689 -mb  -ml  -mdalign  -mrelax @gol
690 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
691 -mieee  -misize  -mpadstruct  -mspace @gol
692 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
693 -mdivsi3_libfunc=@var{name}  @gol
694 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
695  -minvalid-symbols}
697 @emph{SPARC Options}
698 @gccoptlist{-mcpu=@var{cpu-type} @gol
699 -mtune=@var{cpu-type} @gol
700 -mcmodel=@var{code-model} @gol
701 -m32  -m64  -mapp-regs  -mno-app-regs @gol
702 -mfaster-structs  -mno-faster-structs @gol
703 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
704 -mhard-quad-float  -msoft-quad-float @gol
705 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
706 -mstack-bias  -mno-stack-bias @gol
707 -munaligned-doubles  -mno-unaligned-doubles @gol
708 -mv8plus  -mno-v8plus  -mvis  -mno-vis
709 -threads -pthreads}
711 @emph{System V Options}
712 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
714 @emph{TMS320C3x/C4x Options}
715 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
716 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
717 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
718 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
720 @emph{V850 Options}
721 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
722 -mprolog-function  -mno-prolog-function  -mspace @gol
723 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
724 -mapp-regs  -mno-app-regs @gol
725 -mdisable-callt  -mno-disable-callt @gol
726 -mv850e1 @gol
727 -mv850e @gol
728 -mv850  -mbig-switch}
730 @emph{VAX Options}
731 @gccoptlist{-mg  -mgnu  -munix}
733 @emph{x86-64 Options}
734 See i386 and x86-64 Options.
736 @emph{Xstormy16 Options}
737 @gccoptlist{-msim}
739 @emph{Xtensa Options}
740 @gccoptlist{-mconst16 -mno-const16 @gol
741 -mfused-madd  -mno-fused-madd @gol
742 -mtext-section-literals  -mno-text-section-literals @gol
743 -mtarget-align  -mno-target-align @gol
744 -mlongcalls  -mno-longcalls}
746 @emph{zSeries Options}
747 See S/390 and zSeries Options.
749 @item Code Generation Options
750 @xref{Code Gen Options,,Options for Code Generation Conventions}.
751 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
752 -ffixed-@var{reg}  -fexceptions @gol
753 -fnon-call-exceptions  -funwind-tables @gol
754 -fasynchronous-unwind-tables @gol
755 -finhibit-size-directive  -finstrument-functions @gol
756 -fno-common  -fno-ident @gol
757 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
758 -fno-jump-tables @gol
759 -freg-struct-return  -fshared-data  -fshort-enums @gol
760 -fshort-double  -fshort-wchar @gol
761 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
762 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
763 -fargument-alias  -fargument-noalias @gol
764 -fargument-noalias-global  -fleading-underscore @gol
765 -ftls-model=@var{model} @gol
766 -ftrapv  -fwrapv  -fbounds-check @gol
767 -fvisibility}
768 @end table
770 @menu
771 * Overall Options::     Controlling the kind of output:
772                         an executable, object files, assembler files,
773                         or preprocessed source.
774 * C Dialect Options::   Controlling the variant of C language compiled.
775 * C++ Dialect Options:: Variations on C++.
776 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
777                         and Objective-C++.
778 * Language Independent Options:: Controlling how diagnostics should be
779                         formatted.
780 * Warning Options::     How picky should the compiler be?
781 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
782 * Optimize Options::    How much optimization?
783 * Preprocessor Options:: Controlling header files and macro definitions.
784                          Also, getting dependency information for Make.
785 * Assembler Options::   Passing options to the assembler.
786 * Link Options::        Specifying libraries and so on.
787 * Directory Options::   Where to find header files and libraries.
788                         Where to find the compiler executable files.
789 * Spec Files::          How to pass switches to sub-processes.
790 * Target Options::      Running a cross-compiler, or an old version of GCC.
791 @end menu
793 @node Overall Options
794 @section Options Controlling the Kind of Output
796 Compilation can involve up to four stages: preprocessing, compilation
797 proper, assembly and linking, always in that order.  GCC is capable of
798 preprocessing and compiling several files either into several
799 assembler input files, or into one assembler input file; then each
800 assembler input file produces an object file, and linking combines all
801 the object files (those newly compiled, and those specified as input)
802 into an executable file.
804 @cindex file name suffix
805 For any given input file, the file name suffix determines what kind of
806 compilation is done:
808 @table @gcctabopt
809 @item @var{file}.c
810 C source code which must be preprocessed.
812 @item @var{file}.i
813 C source code which should not be preprocessed.
815 @item @var{file}.ii
816 C++ source code which should not be preprocessed.
818 @item @var{file}.m
819 Objective-C source code.  Note that you must link with the @file{libobjc}
820 library to make an Objective-C program work.
822 @item @var{file}.mi
823 Objective-C source code which should not be preprocessed.
825 @item @var{file}.mm
826 @itemx @var{file}.M
827 Objective-C++ source code.  Note that you must link with the @file{libobjc}
828 library to make an Objective-C++ program work.  Note that @samp{.M} refers
829 to a literal capital M@.
831 @item @var{file}.mii
832 Objective-C++ source code which should not be preprocessed.
834 @item @var{file}.h
835 C, C++, Objective-C or Objective-C++ header file to be turned into a
836 precompiled header.
838 @item @var{file}.cc
839 @itemx @var{file}.cp
840 @itemx @var{file}.cxx
841 @itemx @var{file}.cpp
842 @itemx @var{file}.CPP
843 @itemx @var{file}.c++
844 @itemx @var{file}.C
845 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
846 the last two letters must both be literally @samp{x}.  Likewise,
847 @samp{.C} refers to a literal capital C@.
849 @item @var{file}.mm
850 @itemx @var{file}.M
851 Objective-C++ source code which must be preprocessed.
853 @item @var{file}.mii
854 Objective-C++ source code which should not be preprocessed.
856 @item @var{file}.hh
857 @itemx @var{file}.H
858 C++ header file to be turned into a precompiled header.
860 @item @var{file}.f
861 @itemx @var{file}.for
862 @itemx @var{file}.FOR
863 Fixed form Fortran source code which should not be preprocessed.
865 @item @var{file}.F
866 @itemx @var{file}.fpp
867 @itemx @var{file}.FPP
868 Fixed form Fortran source code which must be preprocessed (with the traditional
869 preprocessor).
871 @item @var{file}.f90
872 @itemx @var{file}.f95
873 Free form Fortran source code which should not be preprocessed.
875 @item @var{file}.F90
876 @itemx @var{file}.F95
877 Free form Fortran source code which must be preprocessed (with the
878 traditional preprocessor).
880 @c FIXME: Descriptions of Java file types.
881 @c @var{file}.java
882 @c @var{file}.class
883 @c @var{file}.zip
884 @c @var{file}.jar
886 @item @var{file}.ads
887 Ada source code file which contains a library unit declaration (a
888 declaration of a package, subprogram, or generic, or a generic
889 instantiation), or a library unit renaming declaration (a package,
890 generic, or subprogram renaming declaration).  Such files are also
891 called @dfn{specs}.
893 @itemx @var{file}.adb
894 Ada source code file containing a library unit body (a subprogram or
895 package body).  Such files are also called @dfn{bodies}.
897 @c GCC also knows about some suffixes for languages not yet included:
898 @c Pascal:
899 @c @var{file}.p
900 @c @var{file}.pas
901 @c Ratfor:
902 @c @var{file}.r
904 @item @var{file}.s
905 Assembler code.
907 @item @var{file}.S
908 Assembler code which must be preprocessed.
910 @item @var{other}
911 An object file to be fed straight into linking.
912 Any file name with no recognized suffix is treated this way.
913 @end table
915 @opindex x
916 You can specify the input language explicitly with the @option{-x} option:
918 @table @gcctabopt
919 @item -x @var{language}
920 Specify explicitly the @var{language} for the following input files
921 (rather than letting the compiler choose a default based on the file
922 name suffix).  This option applies to all following input files until
923 the next @option{-x} option.  Possible values for @var{language} are:
924 @smallexample
925 c  c-header  c-cpp-output
926 c++  c++-header  c++-cpp-output
927 objective-c  objective-c-header  objective-c-cpp-output
928 objective-c++ objective-c++-header objective-c++-cpp-output
929 assembler  assembler-with-cpp
931 f77  f77-cpp-input
932 f95  f95-cpp-input
933 java
934 treelang
935 @end smallexample
937 @item -x none
938 Turn off any specification of a language, so that subsequent files are
939 handled according to their file name suffixes (as they are if @option{-x}
940 has not been used at all).
942 @item -pass-exit-codes
943 @opindex pass-exit-codes
944 Normally the @command{gcc} program will exit with the code of 1 if any
945 phase of the compiler returns a non-success return code.  If you specify
946 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
947 numerically highest error produced by any phase that returned an error
948 indication.
949 @end table
951 If you only want some of the stages of compilation, you can use
952 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
953 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
954 @command{gcc} is to stop.  Note that some combinations (for example,
955 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
957 @table @gcctabopt
958 @item -c
959 @opindex c
960 Compile or assemble the source files, but do not link.  The linking
961 stage simply is not done.  The ultimate output is in the form of an
962 object file for each source file.
964 By default, the object file name for a source file is made by replacing
965 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
967 Unrecognized input files, not requiring compilation or assembly, are
968 ignored.
970 @item -S
971 @opindex S
972 Stop after the stage of compilation proper; do not assemble.  The output
973 is in the form of an assembler code file for each non-assembler input
974 file specified.
976 By default, the assembler file name for a source file is made by
977 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
979 Input files that don't require compilation are ignored.
981 @item -E
982 @opindex E
983 Stop after the preprocessing stage; do not run the compiler proper.  The
984 output is in the form of preprocessed source code, which is sent to the
985 standard output.
987 Input files which don't require preprocessing are ignored.
989 @cindex output file option
990 @item -o @var{file}
991 @opindex o
992 Place output in file @var{file}.  This applies regardless to whatever
993 sort of output is being produced, whether it be an executable file,
994 an object file, an assembler file or preprocessed C code.
996 If @option{-o} is not specified, the default is to put an executable
997 file in @file{a.out}, the object file for
998 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
999 assembler file in @file{@var{source}.s}, a precompiled header file in
1000 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1001 standard output.
1003 @item -v
1004 @opindex v
1005 Print (on standard error output) the commands executed to run the stages
1006 of compilation.  Also print the version number of the compiler driver
1007 program and of the preprocessor and the compiler proper.
1009 @item -###
1010 @opindex ###
1011 Like @option{-v} except the commands are not executed and all command
1012 arguments are quoted.  This is useful for shell scripts to capture the
1013 driver-generated command lines.
1015 @item -pipe
1016 @opindex pipe
1017 Use pipes rather than temporary files for communication between the
1018 various stages of compilation.  This fails to work on some systems where
1019 the assembler is unable to read from a pipe; but the GNU assembler has
1020 no trouble.
1022 @item -combine
1023 @opindex combine
1024 If you are compiling multiple source files, this option tells the driver
1025 to pass all the source files to the compiler at once (for those
1026 languages for which the compiler can handle this).  This will allow
1027 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1028 language for which this is supported is C@.  If you pass source files for
1029 multiple languages to the driver, using this option, the driver will invoke
1030 the compiler(s) that support IMA once each, passing each compiler all the
1031 source files appropriate for it.  For those languages that do not support
1032 IMA this option will be ignored, and the compiler will be invoked once for
1033 each source file in that language.  If you use this option in conjunction
1034 with @option{-save-temps}, the compiler will generate multiple
1035 pre-processed files
1036 (one for each source file), but only one (combined) @file{.o} or
1037 @file{.s} file.
1039 @item --help
1040 @opindex help
1041 Print (on the standard output) a description of the command line options
1042 understood by @command{gcc}.  If the @option{-v} option is also specified
1043 then @option{--help} will also be passed on to the various processes
1044 invoked by @command{gcc}, so that they can display the command line options
1045 they accept.  If the @option{-Wextra} option is also specified then command
1046 line options which have no documentation associated with them will also
1047 be displayed.
1049 @item --target-help
1050 @opindex target-help
1051 Print (on the standard output) a description of target specific command
1052 line options for each tool.
1054 @item --version
1055 @opindex version
1056 Display the version number and copyrights of the invoked GCC@.
1058 @include @value{srcdir}/../libiberty/at-file.texi
1059 @end table
1061 @node Invoking G++
1062 @section Compiling C++ Programs
1064 @cindex suffixes for C++ source
1065 @cindex C++ source file suffixes
1066 C++ source files conventionally use one of the suffixes @samp{.C},
1067 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1068 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1069 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1070 files with these names and compiles them as C++ programs even if you
1071 call the compiler the same way as for compiling C programs (usually
1072 with the name @command{gcc}).
1074 @findex g++
1075 @findex c++
1076 However, C++ programs often require class libraries as well as a
1077 compiler that understands the C++ language---and under some
1078 circumstances, you might want to compile programs or header files from
1079 standard input, or otherwise without a suffix that flags them as C++
1080 programs.  You might also like to precompile a C header file with a
1081 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1082 program that calls GCC with the default language set to C++, and
1083 automatically specifies linking against the C++ library.  On many
1084 systems, @command{g++} is also installed with the name @command{c++}.
1086 @cindex invoking @command{g++}
1087 When you compile C++ programs, you may specify many of the same
1088 command-line options that you use for compiling programs in any
1089 language; or command-line options meaningful for C and related
1090 languages; or options that are meaningful only for C++ programs.
1091 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1092 explanations of options for languages related to C@.
1093 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1094 explanations of options that are meaningful only for C++ programs.
1096 @node C Dialect Options
1097 @section Options Controlling C Dialect
1098 @cindex dialect options
1099 @cindex language dialect options
1100 @cindex options, dialect
1102 The following options control the dialect of C (or languages derived
1103 from C, such as C++, Objective-C and Objective-C++) that the compiler
1104 accepts:
1106 @table @gcctabopt
1107 @cindex ANSI support
1108 @cindex ISO support
1109 @item -ansi
1110 @opindex ansi
1111 In C mode, support all ISO C90 programs.  In C++ mode,
1112 remove GNU extensions that conflict with ISO C++.
1114 This turns off certain features of GCC that are incompatible with ISO
1115 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1116 such as the @code{asm} and @code{typeof} keywords, and
1117 predefined macros such as @code{unix} and @code{vax} that identify the
1118 type of system you are using.  It also enables the undesirable and
1119 rarely used ISO trigraph feature.  For the C compiler,
1120 it disables recognition of C++ style @samp{//} comments as well as
1121 the @code{inline} keyword.
1123 The alternate keywords @code{__asm__}, @code{__extension__},
1124 @code{__inline__} and @code{__typeof__} continue to work despite
1125 @option{-ansi}.  You would not want to use them in an ISO C program, of
1126 course, but it is useful to put them in header files that might be included
1127 in compilations done with @option{-ansi}.  Alternate predefined macros
1128 such as @code{__unix__} and @code{__vax__} are also available, with or
1129 without @option{-ansi}.
1131 The @option{-ansi} option does not cause non-ISO programs to be
1132 rejected gratuitously.  For that, @option{-pedantic} is required in
1133 addition to @option{-ansi}.  @xref{Warning Options}.
1135 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1136 option is used.  Some header files may notice this macro and refrain
1137 from declaring certain functions or defining certain macros that the
1138 ISO standard doesn't call for; this is to avoid interfering with any
1139 programs that might use these names for other things.
1141 Functions which would normally be built in but do not have semantics
1142 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1143 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1144 built-in functions provided by GCC}, for details of the functions
1145 affected.
1147 @item -std=
1148 @opindex std
1149 Determine the language standard.  This option is currently only
1150 supported when compiling C or C++.  A value for this option must be
1151 provided; possible values are
1153 @table @samp
1154 @item c89
1155 @itemx iso9899:1990
1156 ISO C90 (same as @option{-ansi}).
1158 @item iso9899:199409
1159 ISO C90 as modified in amendment 1.
1161 @item c99
1162 @itemx c9x
1163 @itemx iso9899:1999
1164 @itemx iso9899:199x
1165 ISO C99.  Note that this standard is not yet fully supported; see
1166 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1167 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1169 @item gnu89
1170 Default, ISO C90 plus GNU extensions (including some C99 features).
1172 @item gnu99
1173 @itemx gnu9x
1174 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1175 this will become the default.  The name @samp{gnu9x} is deprecated.
1177 @item c++98
1178 The 1998 ISO C++ standard plus amendments.
1180 @item gnu++98
1181 The same as @option{-std=c++98} plus GNU extensions.  This is the
1182 default for C++ code.
1183 @end table
1185 Even when this option is not specified, you can still use some of the
1186 features of newer standards in so far as they do not conflict with
1187 previous C standards.  For example, you may use @code{__restrict__} even
1188 when @option{-std=c99} is not specified.
1190 The @option{-std} options specifying some version of ISO C have the same
1191 effects as @option{-ansi}, except that features that were not in ISO C90
1192 but are in the specified version (for example, @samp{//} comments and
1193 the @code{inline} keyword in ISO C99) are not disabled.
1195 @xref{Standards,,Language Standards Supported by GCC}, for details of
1196 these standard versions.
1198 @item -aux-info @var{filename}
1199 @opindex aux-info
1200 Output to the given filename prototyped declarations for all functions
1201 declared and/or defined in a translation unit, including those in header
1202 files.  This option is silently ignored in any language other than C@.
1204 Besides declarations, the file indicates, in comments, the origin of
1205 each declaration (source file and line), whether the declaration was
1206 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1207 @samp{O} for old, respectively, in the first character after the line
1208 number and the colon), and whether it came from a declaration or a
1209 definition (@samp{C} or @samp{F}, respectively, in the following
1210 character).  In the case of function definitions, a K&R-style list of
1211 arguments followed by their declarations is also provided, inside
1212 comments, after the declaration.
1214 @item -fno-asm
1215 @opindex fno-asm
1216 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1217 keyword, so that code can use these words as identifiers.  You can use
1218 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1219 instead.  @option{-ansi} implies @option{-fno-asm}.
1221 In C++, this switch only affects the @code{typeof} keyword, since
1222 @code{asm} and @code{inline} are standard keywords.  You may want to
1223 use the @option{-fno-gnu-keywords} flag instead, which has the same
1224 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1225 switch only affects the @code{asm} and @code{typeof} keywords, since
1226 @code{inline} is a standard keyword in ISO C99.
1228 @item -fno-builtin
1229 @itemx -fno-builtin-@var{function}
1230 @opindex fno-builtin
1231 @cindex built-in functions
1232 Don't recognize built-in functions that do not begin with
1233 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1234 functions provided by GCC}, for details of the functions affected,
1235 including those which are not built-in functions when @option{-ansi} or
1236 @option{-std} options for strict ISO C conformance are used because they
1237 do not have an ISO standard meaning.
1239 GCC normally generates special code to handle certain built-in functions
1240 more efficiently; for instance, calls to @code{alloca} may become single
1241 instructions that adjust the stack directly, and calls to @code{memcpy}
1242 may become inline copy loops.  The resulting code is often both smaller
1243 and faster, but since the function calls no longer appear as such, you
1244 cannot set a breakpoint on those calls, nor can you change the behavior
1245 of the functions by linking with a different library.  In addition,
1246 when a function is recognized as a built-in function, GCC may use
1247 information about that function to warn about problems with calls to
1248 that function, or to generate more efficient code, even if the
1249 resulting code still contains calls to that function.  For example,
1250 warnings are given with @option{-Wformat} for bad calls to
1251 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1252 known not to modify global memory.
1254 With the @option{-fno-builtin-@var{function}} option
1255 only the built-in function @var{function} is
1256 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1257 function is named this is not built-in in this version of GCC, this
1258 option is ignored.  There is no corresponding
1259 @option{-fbuiltin-@var{function}} option; if you wish to enable
1260 built-in functions selectively when using @option{-fno-builtin} or
1261 @option{-ffreestanding}, you may define macros such as:
1263 @smallexample
1264 #define abs(n)          __builtin_abs ((n))
1265 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1266 @end smallexample
1268 @item -fhosted
1269 @opindex fhosted
1270 @cindex hosted environment
1272 Assert that compilation takes place in a hosted environment.  This implies
1273 @option{-fbuiltin}.  A hosted environment is one in which the
1274 entire standard library is available, and in which @code{main} has a return
1275 type of @code{int}.  Examples are nearly everything except a kernel.
1276 This is equivalent to @option{-fno-freestanding}.
1278 @item -ffreestanding
1279 @opindex ffreestanding
1280 @cindex hosted environment
1282 Assert that compilation takes place in a freestanding environment.  This
1283 implies @option{-fno-builtin}.  A freestanding environment
1284 is one in which the standard library may not exist, and program startup may
1285 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1286 This is equivalent to @option{-fno-hosted}.
1288 @xref{Standards,,Language Standards Supported by GCC}, for details of
1289 freestanding and hosted environments.
1291 @item -fms-extensions
1292 @opindex fms-extensions
1293 Accept some non-standard constructs used in Microsoft header files.
1295 Some cases of unnamed fields in structures and unions are only
1296 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1297 fields within structs/unions}, for details.
1299 @item -trigraphs
1300 @opindex trigraphs
1301 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1302 options for strict ISO C conformance) implies @option{-trigraphs}.
1304 @item -no-integrated-cpp
1305 @opindex no-integrated-cpp
1306 Performs a compilation in two passes: preprocessing and compiling.  This
1307 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1308 @option{-B} option.  The user supplied compilation step can then add in
1309 an additional preprocessing step after normal preprocessing but before
1310 compiling.  The default is to use the integrated cpp (internal cpp)
1312 The semantics of this option will change if "cc1", "cc1plus", and
1313 "cc1obj" are merged.
1315 @cindex traditional C language
1316 @cindex C language, traditional
1317 @item -traditional
1318 @itemx -traditional-cpp
1319 @opindex traditional-cpp
1320 @opindex traditional
1321 Formerly, these options caused GCC to attempt to emulate a pre-standard
1322 C compiler.  They are now only supported with the @option{-E} switch.
1323 The preprocessor continues to support a pre-standard mode.  See the GNU
1324 CPP manual for details.
1326 @item -fcond-mismatch
1327 @opindex fcond-mismatch
1328 Allow conditional expressions with mismatched types in the second and
1329 third arguments.  The value of such an expression is void.  This option
1330 is not supported for C++.
1332 @item -funsigned-char
1333 @opindex funsigned-char
1334 Let the type @code{char} be unsigned, like @code{unsigned char}.
1336 Each kind of machine has a default for what @code{char} should
1337 be.  It is either like @code{unsigned char} by default or like
1338 @code{signed char} by default.
1340 Ideally, a portable program should always use @code{signed char} or
1341 @code{unsigned char} when it depends on the signedness of an object.
1342 But many programs have been written to use plain @code{char} and
1343 expect it to be signed, or expect it to be unsigned, depending on the
1344 machines they were written for.  This option, and its inverse, let you
1345 make such a program work with the opposite default.
1347 The type @code{char} is always a distinct type from each of
1348 @code{signed char} or @code{unsigned char}, even though its behavior
1349 is always just like one of those two.
1351 @item -fsigned-char
1352 @opindex fsigned-char
1353 Let the type @code{char} be signed, like @code{signed char}.
1355 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1356 the negative form of @option{-funsigned-char}.  Likewise, the option
1357 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1359 @item -fsigned-bitfields
1360 @itemx -funsigned-bitfields
1361 @itemx -fno-signed-bitfields
1362 @itemx -fno-unsigned-bitfields
1363 @opindex fsigned-bitfields
1364 @opindex funsigned-bitfields
1365 @opindex fno-signed-bitfields
1366 @opindex fno-unsigned-bitfields
1367 These options control whether a bit-field is signed or unsigned, when the
1368 declaration does not use either @code{signed} or @code{unsigned}.  By
1369 default, such a bit-field is signed, because this is consistent: the
1370 basic integer types such as @code{int} are signed types.
1371 @end table
1373 @node C++ Dialect Options
1374 @section Options Controlling C++ Dialect
1376 @cindex compiler options, C++
1377 @cindex C++ options, command line
1378 @cindex options, C++
1379 This section describes the command-line options that are only meaningful
1380 for C++ programs; but you can also use most of the GNU compiler options
1381 regardless of what language your program is in.  For example, you
1382 might compile a file @code{firstClass.C} like this:
1384 @smallexample
1385 g++ -g -frepo -O -c firstClass.C
1386 @end smallexample
1388 @noindent
1389 In this example, only @option{-frepo} is an option meant
1390 only for C++ programs; you can use the other options with any
1391 language supported by GCC@.
1393 Here is a list of options that are @emph{only} for compiling C++ programs:
1395 @table @gcctabopt
1397 @item -fabi-version=@var{n}
1398 @opindex fabi-version
1399 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1400 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1401 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1402 the version that conforms most closely to the C++ ABI specification.
1403 Therefore, the ABI obtained using version 0 will change as ABI bugs
1404 are fixed.
1406 The default is version 2.
1408 @item -fno-access-control
1409 @opindex fno-access-control
1410 Turn off all access checking.  This switch is mainly useful for working
1411 around bugs in the access control code.
1413 @item -fcheck-new
1414 @opindex fcheck-new
1415 Check that the pointer returned by @code{operator new} is non-null
1416 before attempting to modify the storage allocated.  This check is
1417 normally unnecessary because the C++ standard specifies that
1418 @code{operator new} will only return @code{0} if it is declared
1419 @samp{throw()}, in which case the compiler will always check the
1420 return value even without this option.  In all other cases, when
1421 @code{operator new} has a non-empty exception specification, memory
1422 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1423 @samp{new (nothrow)}.
1425 @item -fconserve-space
1426 @opindex fconserve-space
1427 Put uninitialized or runtime-initialized global variables into the
1428 common segment, as C does.  This saves space in the executable at the
1429 cost of not diagnosing duplicate definitions.  If you compile with this
1430 flag and your program mysteriously crashes after @code{main()} has
1431 completed, you may have an object that is being destroyed twice because
1432 two definitions were merged.
1434 This option is no longer useful on most targets, now that support has
1435 been added for putting variables into BSS without making them common.
1437 @item -ffriend-injection
1438 @opindex ffriend-injection
1439 Inject friend functions into the enclosing namespace, so that they are
1440 visible outside the scope of the class in which they are declared.
1441 Friend functions were documented to work this way in the old Annotated
1442 C++ Reference Manual, and versions of G++ before 4.1 always worked
1443 that way.  However, in ISO C++ a friend function which is not declared
1444 in an enclosing scope can only be found using argument dependent
1445 lookup.  This option causes friends to be injected as they were in
1446 earlier releases.
1448 This option is for compatibility, and may be removed in a future
1449 release of G++.
1451 @item -fno-const-strings
1452 @opindex fno-const-strings
1453 Give string constants type @code{char *} instead of type @code{const
1454 char *}.  By default, G++ uses type @code{const char *} as required by
1455 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1456 actually modify the value of a string constant.
1458 This option might be removed in a future release of G++.  For maximum
1459 portability, you should structure your code so that it works with
1460 string constants that have type @code{const char *}.
1462 @item -fno-elide-constructors
1463 @opindex fno-elide-constructors
1464 The C++ standard allows an implementation to omit creating a temporary
1465 which is only used to initialize another object of the same type.
1466 Specifying this option disables that optimization, and forces G++ to
1467 call the copy constructor in all cases.
1469 @item -fno-enforce-eh-specs
1470 @opindex fno-enforce-eh-specs
1471 Don't generate code to check for violation of exception specifications
1472 at runtime.  This option violates the C++ standard, but may be useful
1473 for reducing code size in production builds, much like defining
1474 @samp{NDEBUG}.  This does not give user code permission to throw
1475 exceptions in violation of the exception specifications; the compiler
1476 will still optimize based on the specifications, so throwing an
1477 unexpected exception will result in undefined behavior.
1479 @item -ffor-scope
1480 @itemx -fno-for-scope
1481 @opindex ffor-scope
1482 @opindex fno-for-scope
1483 If @option{-ffor-scope} is specified, the scope of variables declared in
1484 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1485 as specified by the C++ standard.
1486 If @option{-fno-for-scope} is specified, the scope of variables declared in
1487 a @i{for-init-statement} extends to the end of the enclosing scope,
1488 as was the case in old versions of G++, and other (traditional)
1489 implementations of C++.
1491 The default if neither flag is given to follow the standard,
1492 but to allow and give a warning for old-style code that would
1493 otherwise be invalid, or have different behavior.
1495 @item -fno-gnu-keywords
1496 @opindex fno-gnu-keywords
1497 Do not recognize @code{typeof} as a keyword, so that code can use this
1498 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1499 @option{-ansi} implies @option{-fno-gnu-keywords}.
1501 @item -fno-implicit-templates
1502 @opindex fno-implicit-templates
1503 Never emit code for non-inline templates which are instantiated
1504 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1505 @xref{Template Instantiation}, for more information.
1507 @item -fno-implicit-inline-templates
1508 @opindex fno-implicit-inline-templates
1509 Don't emit code for implicit instantiations of inline templates, either.
1510 The default is to handle inlines differently so that compiles with and
1511 without optimization will need the same set of explicit instantiations.
1513 @item -fno-implement-inlines
1514 @opindex fno-implement-inlines
1515 To save space, do not emit out-of-line copies of inline functions
1516 controlled by @samp{#pragma implementation}.  This will cause linker
1517 errors if these functions are not inlined everywhere they are called.
1519 @item -fms-extensions
1520 @opindex fms-extensions
1521 Disable pedantic warnings about constructs used in MFC, such as implicit
1522 int and getting a pointer to member function via non-standard syntax.
1524 @item -fno-nonansi-builtins
1525 @opindex fno-nonansi-builtins
1526 Disable built-in declarations of functions that are not mandated by
1527 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1528 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1530 @item -fno-operator-names
1531 @opindex fno-operator-names
1532 Do not treat the operator name keywords @code{and}, @code{bitand},
1533 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1534 synonyms as keywords.
1536 @item -fno-optional-diags
1537 @opindex fno-optional-diags
1538 Disable diagnostics that the standard says a compiler does not need to
1539 issue.  Currently, the only such diagnostic issued by G++ is the one for
1540 a name having multiple meanings within a class.
1542 @item -fpermissive
1543 @opindex fpermissive
1544 Downgrade some diagnostics about nonconformant code from errors to
1545 warnings.  Thus, using @option{-fpermissive} will allow some
1546 nonconforming code to compile.
1548 @item -frepo
1549 @opindex frepo
1550 Enable automatic template instantiation at link time.  This option also
1551 implies @option{-fno-implicit-templates}.  @xref{Template
1552 Instantiation}, for more information.
1554 @item -fno-rtti
1555 @opindex fno-rtti
1556 Disable generation of information about every class with virtual
1557 functions for use by the C++ runtime type identification features
1558 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1559 of the language, you can save some space by using this flag.  Note that
1560 exception handling uses the same information, but it will generate it as
1561 needed.
1563 @item -fstats
1564 @opindex fstats
1565 Emit statistics about front-end processing at the end of the compilation.
1566 This information is generally only useful to the G++ development team.
1568 @item -ftemplate-depth-@var{n}
1569 @opindex ftemplate-depth
1570 Set the maximum instantiation depth for template classes to @var{n}.
1571 A limit on the template instantiation depth is needed to detect
1572 endless recursions during template class instantiation.  ANSI/ISO C++
1573 conforming programs must not rely on a maximum depth greater than 17.
1575 @item -fno-threadsafe-statics
1576 @opindex fno-threadsafe-statics
1577 Do not emit the extra code to use the routines specified in the C++
1578 ABI for thread-safe initialization of local statics.  You can use this
1579 option to reduce code size slightly in code that doesn't need to be
1580 thread-safe.
1582 @item -fuse-cxa-atexit
1583 @opindex fuse-cxa-atexit
1584 Register destructors for objects with static storage duration with the
1585 @code{__cxa_atexit} function rather than the @code{atexit} function.
1586 This option is required for fully standards-compliant handling of static
1587 destructors, but will only work if your C library supports
1588 @code{__cxa_atexit}.
1590 @item -fvisibility-inlines-hidden
1591 @opindex fvisibility-inlines-hidden
1592 Causes all inlined methods to be marked with
1593 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1594 appear in the export table of a DSO and do not require a PLT indirection
1595 when used within the DSO@.  Enabling this option can have a dramatic effect
1596 on load and link times of a DSO as it massively reduces the size of the
1597 dynamic export table when the library makes heavy use of templates.  While
1598 it can cause bloating through duplication of code within each DSO where
1599 it is used, often the wastage is less than the considerable space occupied
1600 by a long symbol name in the export table which is typical when using
1601 templates and namespaces.  For even more savings, combine with the
1602 @option{-fvisibility=hidden} switch.
1604 @item -fno-weak
1605 @opindex fno-weak
1606 Do not use weak symbol support, even if it is provided by the linker.
1607 By default, G++ will use weak symbols if they are available.  This
1608 option exists only for testing, and should not be used by end-users;
1609 it will result in inferior code and has no benefits.  This option may
1610 be removed in a future release of G++.
1612 @item -nostdinc++
1613 @opindex nostdinc++
1614 Do not search for header files in the standard directories specific to
1615 C++, but do still search the other standard directories.  (This option
1616 is used when building the C++ library.)
1617 @end table
1619 In addition, these optimization, warning, and code generation options
1620 have meanings only for C++ programs:
1622 @table @gcctabopt
1623 @item -fno-default-inline
1624 @opindex fno-default-inline
1625 Do not assume @samp{inline} for functions defined inside a class scope.
1626 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1627 functions will have linkage like inline functions; they just won't be
1628 inlined by default.
1630 @item -Wabi @r{(C++ only)}
1631 @opindex Wabi
1632 Warn when G++ generates code that is probably not compatible with the
1633 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1634 all such cases, there are probably some cases that are not warned about,
1635 even though G++ is generating incompatible code.  There may also be
1636 cases where warnings are emitted even though the code that is generated
1637 will be compatible.
1639 You should rewrite your code to avoid these warnings if you are
1640 concerned about the fact that code generated by G++ may not be binary
1641 compatible with code generated by other compilers.
1643 The known incompatibilities at this point include:
1645 @itemize @bullet
1647 @item
1648 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1649 pack data into the same byte as a base class.  For example:
1651 @smallexample
1652 struct A @{ virtual void f(); int f1 : 1; @};
1653 struct B : public A @{ int f2 : 1; @};
1654 @end smallexample
1656 @noindent
1657 In this case, G++ will place @code{B::f2} into the same byte
1658 as@code{A::f1}; other compilers will not.  You can avoid this problem
1659 by explicitly padding @code{A} so that its size is a multiple of the
1660 byte size on your platform; that will cause G++ and other compilers to
1661 layout @code{B} identically.
1663 @item
1664 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1665 tail padding when laying out virtual bases.  For example:
1667 @smallexample
1668 struct A @{ virtual void f(); char c1; @};
1669 struct B @{ B(); char c2; @};
1670 struct C : public A, public virtual B @{@};
1671 @end smallexample
1673 @noindent
1674 In this case, G++ will not place @code{B} into the tail-padding for
1675 @code{A}; other compilers will.  You can avoid this problem by
1676 explicitly padding @code{A} so that its size is a multiple of its
1677 alignment (ignoring virtual base classes); that will cause G++ and other
1678 compilers to layout @code{C} identically.
1680 @item
1681 Incorrect handling of bit-fields with declared widths greater than that
1682 of their underlying types, when the bit-fields appear in a union.  For
1683 example:
1685 @smallexample
1686 union U @{ int i : 4096; @};
1687 @end smallexample
1689 @noindent
1690 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1691 union too small by the number of bits in an @code{int}.
1693 @item
1694 Empty classes can be placed at incorrect offsets.  For example:
1696 @smallexample
1697 struct A @{@};
1699 struct B @{
1700   A a;
1701   virtual void f ();
1704 struct C : public B, public A @{@};
1705 @end smallexample
1707 @noindent
1708 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1709 it should be placed at offset zero.  G++ mistakenly believes that the
1710 @code{A} data member of @code{B} is already at offset zero.
1712 @item
1713 Names of template functions whose types involve @code{typename} or
1714 template template parameters can be mangled incorrectly.
1716 @smallexample
1717 template <typename Q>
1718 void f(typename Q::X) @{@}
1720 template <template <typename> class Q>
1721 void f(typename Q<int>::X) @{@}
1722 @end smallexample
1724 @noindent
1725 Instantiations of these templates may be mangled incorrectly.
1727 @end itemize
1729 @item -Wctor-dtor-privacy @r{(C++ only)}
1730 @opindex Wctor-dtor-privacy
1731 Warn when a class seems unusable because all the constructors or
1732 destructors in that class are private, and it has neither friends nor
1733 public static member functions.
1735 @item -Wnon-virtual-dtor @r{(C++ only)}
1736 @opindex Wnon-virtual-dtor
1737 Warn when a class appears to be polymorphic, thereby requiring a virtual
1738 destructor, yet it declares a non-virtual one.
1739 This warning is enabled by @option{-Wall}.
1741 @item -Wreorder @r{(C++ only)}
1742 @opindex Wreorder
1743 @cindex reordering, warning
1744 @cindex warning for reordering of member initializers
1745 Warn when the order of member initializers given in the code does not
1746 match the order in which they must be executed.  For instance:
1748 @smallexample
1749 struct A @{
1750   int i;
1751   int j;
1752   A(): j (0), i (1) @{ @}
1754 @end smallexample
1756 The compiler will rearrange the member initializers for @samp{i}
1757 and @samp{j} to match the declaration order of the members, emitting
1758 a warning to that effect.  This warning is enabled by @option{-Wall}.
1759 @end table
1761 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1763 @table @gcctabopt
1764 @item -Weffc++ @r{(C++ only)}
1765 @opindex Weffc++
1766 Warn about violations of the following style guidelines from Scott Meyers'
1767 @cite{Effective C++} book:
1769 @itemize @bullet
1770 @item
1771 Item 11:  Define a copy constructor and an assignment operator for classes
1772 with dynamically allocated memory.
1774 @item
1775 Item 12:  Prefer initialization to assignment in constructors.
1777 @item
1778 Item 14:  Make destructors virtual in base classes.
1780 @item
1781 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1783 @item
1784 Item 23:  Don't try to return a reference when you must return an object.
1786 @end itemize
1788 Also warn about violations of the following style guidelines from
1789 Scott Meyers' @cite{More Effective C++} book:
1791 @itemize @bullet
1792 @item
1793 Item 6:  Distinguish between prefix and postfix forms of increment and
1794 decrement operators.
1796 @item
1797 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1799 @end itemize
1801 When selecting this option, be aware that the standard library
1802 headers do not obey all of these guidelines; use @samp{grep -v}
1803 to filter out those warnings.
1805 @item -Wno-deprecated @r{(C++ only)}
1806 @opindex Wno-deprecated
1807 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1809 @item -Wstrict-null-sentinel @r{(C++ only)}
1810 @opindex Wstrict-null-sentinel
1811 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1812 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1813 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1814 it is guaranteed to of the same size as a pointer.  But this use is
1815 not portable across different compilers.
1817 @item -Wno-non-template-friend @r{(C++ only)}
1818 @opindex Wno-non-template-friend
1819 Disable warnings when non-templatized friend functions are declared
1820 within a template.  Since the advent of explicit template specification
1821 support in G++, if the name of the friend is an unqualified-id (i.e.,
1822 @samp{friend foo(int)}), the C++ language specification demands that the
1823 friend declare or define an ordinary, nontemplate function.  (Section
1824 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1825 could be interpreted as a particular specialization of a templatized
1826 function.  Because this non-conforming behavior is no longer the default
1827 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1828 check existing code for potential trouble spots and is on by default.
1829 This new compiler behavior can be turned off with
1830 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1831 but disables the helpful warning.
1833 @item -Wold-style-cast @r{(C++ only)}
1834 @opindex Wold-style-cast
1835 Warn if an old-style (C-style) cast to a non-void type is used within
1836 a C++ program.  The new-style casts (@samp{dynamic_cast},
1837 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1838 less vulnerable to unintended effects and much easier to search for.
1840 @item -Woverloaded-virtual @r{(C++ only)}
1841 @opindex Woverloaded-virtual
1842 @cindex overloaded virtual fn, warning
1843 @cindex warning for overloaded virtual fn
1844 Warn when a function declaration hides virtual functions from a
1845 base class.  For example, in:
1847 @smallexample
1848 struct A @{
1849   virtual void f();
1852 struct B: public A @{
1853   void f(int);
1855 @end smallexample
1857 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1858 like:
1860 @smallexample
1861 B* b;
1862 b->f();
1863 @end smallexample
1865 will fail to compile.
1867 @item -Wno-pmf-conversions @r{(C++ only)}
1868 @opindex Wno-pmf-conversions
1869 Disable the diagnostic for converting a bound pointer to member function
1870 to a plain pointer.
1872 @item -Wsign-promo @r{(C++ only)}
1873 @opindex Wsign-promo
1874 Warn when overload resolution chooses a promotion from unsigned or
1875 enumerated type to a signed type, over a conversion to an unsigned type of
1876 the same size.  Previous versions of G++ would try to preserve
1877 unsignedness, but the standard mandates the current behavior.
1879 @smallexample
1880 struct A @{
1881   operator int ();
1882   A& operator = (int);
1885 main ()
1887   A a,b;
1888   a = b;
1890 @end smallexample
1892 In this example, G++ will synthesize a default @samp{A& operator =
1893 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1894 @end table
1896 @node Objective-C and Objective-C++ Dialect Options
1897 @section Options Controlling Objective-C and Objective-C++ Dialects
1899 @cindex compiler options, Objective-C and Objective-C++
1900 @cindex Objective-C and Objective-C++ options, command line
1901 @cindex options, Objective-C and Objective-C++
1902 (NOTE: This manual does not describe the Objective-C and Objective-C++
1903 languages themselves.  See @xref{Standards,,Language Standards
1904 Supported by GCC}, for references.)
1906 This section describes the command-line options that are only meaningful
1907 for Objective-C and Objective-C++ programs, but you can also use most of
1908 the language-independent GNU compiler options.
1909 For example, you might compile a file @code{some_class.m} like this:
1911 @smallexample
1912 gcc -g -fgnu-runtime -O -c some_class.m
1913 @end smallexample
1915 @noindent
1916 In this example, @option{-fgnu-runtime} is an option meant only for
1917 Objective-C and Objective-C++ programs; you can use the other options with
1918 any language supported by GCC@.
1920 Note that since Objective-C is an extension of the C language, Objective-C
1921 compilations may also use options specific to the C front-end (e.g.,
1922 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1923 C++-specific options (e.g., @option{-Wabi}).
1925 Here is a list of options that are @emph{only} for compiling Objective-C
1926 and Objective-C++ programs:
1928 @table @gcctabopt
1929 @item -fconstant-string-class=@var{class-name}
1930 @opindex fconstant-string-class
1931 Use @var{class-name} as the name of the class to instantiate for each
1932 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1933 class name is @code{NXConstantString} if the GNU runtime is being used, and
1934 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1935 @option{-fconstant-cfstrings} option, if also present, will override the
1936 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1937 to be laid out as constant CoreFoundation strings.
1939 @item -fgnu-runtime
1940 @opindex fgnu-runtime
1941 Generate object code compatible with the standard GNU Objective-C
1942 runtime.  This is the default for most types of systems.
1944 @item -fnext-runtime
1945 @opindex fnext-runtime
1946 Generate output compatible with the NeXT runtime.  This is the default
1947 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1948 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1949 used.
1951 @item -fno-nil-receivers
1952 @opindex fno-nil-receivers
1953 Assume that all Objective-C message dispatches (e.g.,
1954 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1955 is not @code{nil}.  This allows for more efficient entry points in the runtime
1956 to be used.  Currently, this option is only available in conjunction with
1957 the NeXT runtime on Mac OS X 10.3 and later.
1959 @item -fobjc-call-cxx-cdtors
1960 @opindex fobjc-call-cxx-cdtors
1961 For each Objective-C class, check if any of its instance variables is a
1962 C++ object with a non-trivial default constructor.  If so, synthesize a
1963 special @code{- (id) .cxx_construct} instance method that will run
1964 non-trivial default constructors on any such instance variables, in order,
1965 and then return @code{self}.  Similarly, check if any instance variable
1966 is a C++ object with a non-trivial destructor, and if so, synthesize a
1967 special @code{- (void) .cxx_destruct} method that will run
1968 all such default destructors, in reverse order.
1970 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1971 thusly generated will only operate on instance variables declared in the
1972 current Objective-C class, and not those inherited from superclasses.  It
1973 is the responsibility of the Objective-C runtime to invoke all such methods
1974 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1975 will be invoked by the runtime immediately after a new object
1976 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1977 be invoked immediately before the runtime deallocates an object instance.
1979 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1980 support for invoking the @code{- (id) .cxx_construct} and
1981 @code{- (void) .cxx_destruct} methods.
1983 @item -fobjc-direct-dispatch
1984 @opindex fobjc-direct-dispatch
1985 Allow fast jumps to the message dispatcher.  On Darwin this is
1986 accomplished via the comm page.
1988 @item -fobjc-exceptions
1989 @opindex fobjc-exceptions
1990 Enable syntactic support for structured exception handling in Objective-C,
1991 similar to what is offered by C++ and Java.  Currently, this option is only
1992 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1994 @smallexample
1995   @@try @{
1996     @dots{}
1997        @@throw expr;
1998     @dots{}
1999   @}
2000   @@catch (AnObjCClass *exc) @{
2001     @dots{}
2002       @@throw expr;
2003     @dots{}
2004       @@throw;
2005     @dots{}
2006   @}
2007   @@catch (AnotherClass *exc) @{
2008     @dots{}
2009   @}
2010   @@catch (id allOthers) @{
2011     @dots{}
2012   @}
2013   @@finally @{
2014     @dots{}
2015       @@throw expr;
2016     @dots{}
2017   @}
2018 @end smallexample
2020 The @code{@@throw} statement may appear anywhere in an Objective-C or
2021 Objective-C++ program; when used inside of a @code{@@catch} block, the
2022 @code{@@throw} may appear without an argument (as shown above), in which case
2023 the object caught by the @code{@@catch} will be rethrown.
2025 Note that only (pointers to) Objective-C objects may be thrown and
2026 caught using this scheme.  When an object is thrown, it will be caught
2027 by the nearest @code{@@catch} clause capable of handling objects of that type,
2028 analogously to how @code{catch} blocks work in C++ and Java.  A
2029 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2030 any and all Objective-C exceptions not caught by previous @code{@@catch}
2031 clauses (if any).
2033 The @code{@@finally} clause, if present, will be executed upon exit from the
2034 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2035 regardless of whether any exceptions are thrown, caught or rethrown
2036 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2037 of the @code{finally} clause in Java.
2039 There are several caveats to using the new exception mechanism:
2041 @itemize @bullet
2042 @item
2043 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2044 idioms provided by the @code{NSException} class, the new
2045 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2046 systems, due to additional functionality needed in the (NeXT) Objective-C
2047 runtime.
2049 @item
2050 As mentioned above, the new exceptions do not support handling
2051 types other than Objective-C objects.   Furthermore, when used from
2052 Objective-C++, the Objective-C exception model does not interoperate with C++
2053 exceptions at this time.  This means you cannot @code{@@throw} an exception
2054 from Objective-C and @code{catch} it in C++, or vice versa
2055 (i.e., @code{throw @dots{} @@catch}).
2056 @end itemize
2058 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2059 blocks for thread-safe execution:
2061 @smallexample
2062   @@synchronized (ObjCClass *guard) @{
2063     @dots{}
2064   @}
2065 @end smallexample
2067 Upon entering the @code{@@synchronized} block, a thread of execution shall
2068 first check whether a lock has been placed on the corresponding @code{guard}
2069 object by another thread.  If it has, the current thread shall wait until
2070 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2071 the current thread will place its own lock on it, execute the code contained in
2072 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2073 making @code{guard} available to other threads).
2075 Unlike Java, Objective-C does not allow for entire methods to be marked
2076 @code{@@synchronized}.  Note that throwing exceptions out of
2077 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2078 to be unlocked properly.
2080 @item -fobjc-gc
2081 @opindex fobjc-gc
2082 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2084 @item -freplace-objc-classes
2085 @opindex freplace-objc-classes
2086 Emit a special marker instructing @command{ld(1)} not to statically link in
2087 the resulting object file, and allow @command{dyld(1)} to load it in at
2088 run time instead.  This is used in conjunction with the Fix-and-Continue
2089 debugging mode, where the object file in question may be recompiled and
2090 dynamically reloaded in the course of program execution, without the need
2091 to restart the program itself.  Currently, Fix-and-Continue functionality
2092 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2093 and later.
2095 @item -fzero-link
2096 @opindex fzero-link
2097 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2098 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2099 compile time) with static class references that get initialized at load time,
2100 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2101 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2102 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2103 for individual class implementations to be modified during program execution.
2105 @item -gen-decls
2106 @opindex gen-decls
2107 Dump interface declarations for all classes seen in the source file to a
2108 file named @file{@var{sourcename}.decl}.
2110 @item -Wassign-intercept
2111 @opindex Wassign-intercept
2112 Warn whenever an Objective-C assignment is being intercepted by the
2113 garbage collector.
2115 @item -Wno-protocol
2116 @opindex Wno-protocol
2117 If a class is declared to implement a protocol, a warning is issued for
2118 every method in the protocol that is not implemented by the class.  The
2119 default behavior is to issue a warning for every method not explicitly
2120 implemented in the class, even if a method implementation is inherited
2121 from the superclass.  If you use the @option{-Wno-protocol} option, then
2122 methods inherited from the superclass are considered to be implemented,
2123 and no warning is issued for them.
2125 @item -Wselector
2126 @opindex Wselector
2127 Warn if multiple methods of different types for the same selector are
2128 found during compilation.  The check is performed on the list of methods
2129 in the final stage of compilation.  Additionally, a check is performed
2130 for each selector appearing in a @code{@@selector(@dots{})}
2131 expression, and a corresponding method for that selector has been found
2132 during compilation.  Because these checks scan the method table only at
2133 the end of compilation, these warnings are not produced if the final
2134 stage of compilation is not reached, for example because an error is
2135 found during compilation, or because the @option{-fsyntax-only} option is
2136 being used.
2138 @item -Wstrict-selector-match
2139 @opindex Wstrict-selector-match
2140 Warn if multiple methods with differing argument and/or return types are
2141 found for a given selector when attempting to send a message using this
2142 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2143 is off (which is the default behavior), the compiler will omit such warnings
2144 if any differences found are confined to types which share the same size
2145 and alignment.
2147 @item -Wundeclared-selector
2148 @opindex Wundeclared-selector
2149 Warn if a @code{@@selector(@dots{})} expression referring to an
2150 undeclared selector is found.  A selector is considered undeclared if no
2151 method with that name has been declared before the
2152 @code{@@selector(@dots{})} expression, either explicitly in an
2153 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2154 an @code{@@implementation} section.  This option always performs its
2155 checks as soon as a @code{@@selector(@dots{})} expression is found,
2156 while @option{-Wselector} only performs its checks in the final stage of
2157 compilation.  This also enforces the coding style convention
2158 that methods and selectors must be declared before being used.
2160 @item -print-objc-runtime-info
2161 @opindex print-objc-runtime-info
2162 Generate C header describing the largest structure that is passed by
2163 value, if any.
2165 @end table
2167 @node Language Independent Options
2168 @section Options to Control Diagnostic Messages Formatting
2169 @cindex options to control diagnostics formatting
2170 @cindex diagnostic messages
2171 @cindex message formatting
2173 Traditionally, diagnostic messages have been formatted irrespective of
2174 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2175 below can be used to control the diagnostic messages formatting
2176 algorithm, e.g.@: how many characters per line, how often source location
2177 information should be reported.  Right now, only the C++ front end can
2178 honor these options.  However it is expected, in the near future, that
2179 the remaining front ends would be able to digest them correctly.
2181 @table @gcctabopt
2182 @item -fmessage-length=@var{n}
2183 @opindex fmessage-length
2184 Try to format error messages so that they fit on lines of about @var{n}
2185 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2186 the front ends supported by GCC@.  If @var{n} is zero, then no
2187 line-wrapping will be done; each error message will appear on a single
2188 line.
2190 @opindex fdiagnostics-show-location
2191 @item -fdiagnostics-show-location=once
2192 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2193 reporter to emit @emph{once} source location information; that is, in
2194 case the message is too long to fit on a single physical line and has to
2195 be wrapped, the source location won't be emitted (as prefix) again,
2196 over and over, in subsequent continuation lines.  This is the default
2197 behavior.
2199 @item -fdiagnostics-show-location=every-line
2200 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2201 messages reporter to emit the same source location information (as
2202 prefix) for physical lines that result from the process of breaking
2203 a message which is too long to fit on a single line.
2205 @item -fdiagnostics-show-options
2206 @opindex fdiagnostics-show-options
2207 This option instructs the diagnostic machinery to add text to each
2208 diagnostic emitted, which indicates which command line option directly
2209 controls that diagnostic, when such an option is known to the
2210 diagnostic machinery.
2212 @end table
2214 @node Warning Options
2215 @section Options to Request or Suppress Warnings
2216 @cindex options to control warnings
2217 @cindex warning messages
2218 @cindex messages, warning
2219 @cindex suppressing warnings
2221 Warnings are diagnostic messages that report constructions which
2222 are not inherently erroneous but which are risky or suggest there
2223 may have been an error.
2225 You can request many specific warnings with options beginning @samp{-W},
2226 for example @option{-Wimplicit} to request warnings on implicit
2227 declarations.  Each of these specific warning options also has a
2228 negative form beginning @samp{-Wno-} to turn off warnings;
2229 for example, @option{-Wno-implicit}.  This manual lists only one of the
2230 two forms, whichever is not the default.
2232 The following options control the amount and kinds of warnings produced
2233 by GCC; for further, language-specific options also refer to
2234 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2235 Options}.
2237 @table @gcctabopt
2238 @cindex syntax checking
2239 @item -fsyntax-only
2240 @opindex fsyntax-only
2241 Check the code for syntax errors, but don't do anything beyond that.
2243 @item -pedantic
2244 @opindex pedantic
2245 Issue all the warnings demanded by strict ISO C and ISO C++;
2246 reject all programs that use forbidden extensions, and some other
2247 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2248 version of the ISO C standard specified by any @option{-std} option used.
2250 Valid ISO C and ISO C++ programs should compile properly with or without
2251 this option (though a rare few will require @option{-ansi} or a
2252 @option{-std} option specifying the required version of ISO C)@.  However,
2253 without this option, certain GNU extensions and traditional C and C++
2254 features are supported as well.  With this option, they are rejected.
2256 @option{-pedantic} does not cause warning messages for use of the
2257 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2258 warnings are also disabled in the expression that follows
2259 @code{__extension__}.  However, only system header files should use
2260 these escape routes; application programs should avoid them.
2261 @xref{Alternate Keywords}.
2263 Some users try to use @option{-pedantic} to check programs for strict ISO
2264 C conformance.  They soon find that it does not do quite what they want:
2265 it finds some non-ISO practices, but not all---only those for which
2266 ISO C @emph{requires} a diagnostic, and some others for which
2267 diagnostics have been added.
2269 A feature to report any failure to conform to ISO C might be useful in
2270 some instances, but would require considerable additional work and would
2271 be quite different from @option{-pedantic}.  We don't have plans to
2272 support such a feature in the near future.
2274 Where the standard specified with @option{-std} represents a GNU
2275 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2276 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2277 extended dialect is based.  Warnings from @option{-pedantic} are given
2278 where they are required by the base standard.  (It would not make sense
2279 for such warnings to be given only for features not in the specified GNU
2280 C dialect, since by definition the GNU dialects of C include all
2281 features the compiler supports with the given option, and there would be
2282 nothing to warn about.)
2284 @item -pedantic-errors
2285 @opindex pedantic-errors
2286 Like @option{-pedantic}, except that errors are produced rather than
2287 warnings.
2289 @item -w
2290 @opindex w
2291 Inhibit all warning messages.
2293 @item -Wno-import
2294 @opindex Wno-import
2295 Inhibit warning messages about the use of @samp{#import}.
2297 @item -Wchar-subscripts
2298 @opindex Wchar-subscripts
2299 Warn if an array subscript has type @code{char}.  This is a common cause
2300 of error, as programmers often forget that this type is signed on some
2301 machines.
2302 This warning is enabled by @option{-Wall}.
2304 @item -Wcomment
2305 @opindex Wcomment
2306 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2307 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2308 This warning is enabled by @option{-Wall}.
2310 @item -Wfatal-errors
2311 @opindex Wfatal-errors
2312 This option causes the compiler to abort compilation on the first error
2313 occurred rather than trying to keep going and printing further error
2314 messages.
2316 @item -Wformat
2317 @opindex Wformat
2318 @opindex ffreestanding
2319 @opindex fno-builtin
2320 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2321 the arguments supplied have types appropriate to the format string
2322 specified, and that the conversions specified in the format string make
2323 sense.  This includes standard functions, and others specified by format
2324 attributes (@pxref{Function Attributes}), in the @code{printf},
2325 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2326 not in the C standard) families (or other target-specific families).
2327 Which functions are checked without format attributes having been
2328 specified depends on the standard version selected, and such checks of
2329 functions without the attribute specified are disabled by
2330 @option{-ffreestanding} or @option{-fno-builtin}.
2332 The formats are checked against the format features supported by GNU
2333 libc version 2.2.  These include all ISO C90 and C99 features, as well
2334 as features from the Single Unix Specification and some BSD and GNU
2335 extensions.  Other library implementations may not support all these
2336 features; GCC does not support warning about features that go beyond a
2337 particular library's limitations.  However, if @option{-pedantic} is used
2338 with @option{-Wformat}, warnings will be given about format features not
2339 in the selected standard version (but not for @code{strfmon} formats,
2340 since those are not in any version of the C standard).  @xref{C Dialect
2341 Options,,Options Controlling C Dialect}.
2343 Since @option{-Wformat} also checks for null format arguments for
2344 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2346 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2347 aspects of format checking, the options @option{-Wformat-y2k},
2348 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2349 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2350 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2352 @item -Wformat-y2k
2353 @opindex Wformat-y2k
2354 If @option{-Wformat} is specified, also warn about @code{strftime}
2355 formats which may yield only a two-digit year.
2357 @item -Wno-format-extra-args
2358 @opindex Wno-format-extra-args
2359 If @option{-Wformat} is specified, do not warn about excess arguments to a
2360 @code{printf} or @code{scanf} format function.  The C standard specifies
2361 that such arguments are ignored.
2363 Where the unused arguments lie between used arguments that are
2364 specified with @samp{$} operand number specifications, normally
2365 warnings are still given, since the implementation could not know what
2366 type to pass to @code{va_arg} to skip the unused arguments.  However,
2367 in the case of @code{scanf} formats, this option will suppress the
2368 warning if the unused arguments are all pointers, since the Single
2369 Unix Specification says that such unused arguments are allowed.
2371 @item -Wno-format-zero-length
2372 @opindex Wno-format-zero-length
2373 If @option{-Wformat} is specified, do not warn about zero-length formats.
2374 The C standard specifies that zero-length formats are allowed.
2376 @item -Wformat-nonliteral
2377 @opindex Wformat-nonliteral
2378 If @option{-Wformat} is specified, also warn if the format string is not a
2379 string literal and so cannot be checked, unless the format function
2380 takes its format arguments as a @code{va_list}.
2382 @item -Wformat-security
2383 @opindex Wformat-security
2384 If @option{-Wformat} is specified, also warn about uses of format
2385 functions that represent possible security problems.  At present, this
2386 warns about calls to @code{printf} and @code{scanf} functions where the
2387 format string is not a string literal and there are no format arguments,
2388 as in @code{printf (foo);}.  This may be a security hole if the format
2389 string came from untrusted input and contains @samp{%n}.  (This is
2390 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2391 in future warnings may be added to @option{-Wformat-security} that are not
2392 included in @option{-Wformat-nonliteral}.)
2394 @item -Wformat=2
2395 @opindex Wformat=2
2396 Enable @option{-Wformat} plus format checks not included in
2397 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2398 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2400 @item -Wnonnull
2401 @opindex Wnonnull
2402 Warn about passing a null pointer for arguments marked as
2403 requiring a non-null value by the @code{nonnull} function attribute.
2405 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2406 can be disabled with the @option{-Wno-nonnull} option.
2408 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2409 @opindex Winit-self
2410 Warn about uninitialized variables which are initialized with themselves.
2411 Note this option can only be used with the @option{-Wuninitialized} option,
2412 which in turn only works with @option{-O1} and above.
2414 For example, GCC will warn about @code{i} being uninitialized in the
2415 following snippet only when @option{-Winit-self} has been specified:
2416 @smallexample
2417 @group
2418 int f()
2420   int i = i;
2421   return i;
2423 @end group
2424 @end smallexample
2426 @item -Wimplicit-int
2427 @opindex Wimplicit-int
2428 Warn when a declaration does not specify a type.
2429 This warning is enabled by @option{-Wall}.
2431 @item -Wimplicit-function-declaration
2432 @itemx -Werror-implicit-function-declaration
2433 @opindex Wimplicit-function-declaration
2434 @opindex Werror-implicit-function-declaration
2435 Give a warning (or error) whenever a function is used before being
2436 declared.  The form @option{-Wno-error-implicit-function-declaration}
2437 is not supported.
2438 This warning is enabled by @option{-Wall} (as a warning, not an error).
2440 @item -Wimplicit
2441 @opindex Wimplicit
2442 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2443 This warning is enabled by @option{-Wall}.
2445 @item -Wmain
2446 @opindex Wmain
2447 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2448 function with external linkage, returning int, taking either zero
2449 arguments, two, or three arguments of appropriate types.
2450 This warning is enabled by @option{-Wall}.
2452 @item -Wmissing-braces
2453 @opindex Wmissing-braces
2454 Warn if an aggregate or union initializer is not fully bracketed.  In
2455 the following example, the initializer for @samp{a} is not fully
2456 bracketed, but that for @samp{b} is fully bracketed.
2458 @smallexample
2459 int a[2][2] = @{ 0, 1, 2, 3 @};
2460 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2461 @end smallexample
2463 This warning is enabled by @option{-Wall}.
2465 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2466 @opindex Wmissing-include-dirs
2467 Warn if a user-supplied include directory does not exist.
2469 @item -Wparentheses
2470 @opindex Wparentheses
2471 Warn if parentheses are omitted in certain contexts, such
2472 as when there is an assignment in a context where a truth value
2473 is expected, or when operators are nested whose precedence people
2474 often get confused about.  Only the warning for an assignment used as
2475 a truth value is supported when compiling C++; the other warnings are
2476 only supported when compiling C@.
2478 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2479 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2480 interpretation from that of ordinary mathematical notation.
2482 Also warn about constructions where there may be confusion to which
2483 @code{if} statement an @code{else} branch belongs.  Here is an example of
2484 such a case:
2486 @smallexample
2487 @group
2489   if (a)
2490     if (b)
2491       foo ();
2492   else
2493     bar ();
2495 @end group
2496 @end smallexample
2498 In C, every @code{else} branch belongs to the innermost possible @code{if}
2499 statement, which in this example is @code{if (b)}.  This is often not
2500 what the programmer expected, as illustrated in the above example by
2501 indentation the programmer chose.  When there is the potential for this
2502 confusion, GCC will issue a warning when this flag is specified.
2503 To eliminate the warning, add explicit braces around the innermost
2504 @code{if} statement so there is no way the @code{else} could belong to
2505 the enclosing @code{if}.  The resulting code would look like this:
2507 @smallexample
2508 @group
2510   if (a)
2511     @{
2512       if (b)
2513         foo ();
2514       else
2515         bar ();
2516     @}
2518 @end group
2519 @end smallexample
2521 This warning is enabled by @option{-Wall}.
2523 @item -Wsequence-point
2524 @opindex Wsequence-point
2525 Warn about code that may have undefined semantics because of violations
2526 of sequence point rules in the C standard.
2528 The C standard defines the order in which expressions in a C program are
2529 evaluated in terms of @dfn{sequence points}, which represent a partial
2530 ordering between the execution of parts of the program: those executed
2531 before the sequence point, and those executed after it.  These occur
2532 after the evaluation of a full expression (one which is not part of a
2533 larger expression), after the evaluation of the first operand of a
2534 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2535 function is called (but after the evaluation of its arguments and the
2536 expression denoting the called function), and in certain other places.
2537 Other than as expressed by the sequence point rules, the order of
2538 evaluation of subexpressions of an expression is not specified.  All
2539 these rules describe only a partial order rather than a total order,
2540 since, for example, if two functions are called within one expression
2541 with no sequence point between them, the order in which the functions
2542 are called is not specified.  However, the standards committee have
2543 ruled that function calls do not overlap.
2545 It is not specified when between sequence points modifications to the
2546 values of objects take effect.  Programs whose behavior depends on this
2547 have undefined behavior; the C standard specifies that ``Between the
2548 previous and next sequence point an object shall have its stored value
2549 modified at most once by the evaluation of an expression.  Furthermore,
2550 the prior value shall be read only to determine the value to be
2551 stored.''.  If a program breaks these rules, the results on any
2552 particular implementation are entirely unpredictable.
2554 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2555 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2556 diagnosed by this option, and it may give an occasional false positive
2557 result, but in general it has been found fairly effective at detecting
2558 this sort of problem in programs.
2560 The present implementation of this option only works for C programs.  A
2561 future implementation may also work for C++ programs.
2563 The C standard is worded confusingly, therefore there is some debate
2564 over the precise meaning of the sequence point rules in subtle cases.
2565 Links to discussions of the problem, including proposed formal
2566 definitions, may be found on the GCC readings page, at
2567 @w{@uref{http://gcc.gnu.org/readings.html}}.
2569 This warning is enabled by @option{-Wall}.
2571 @item -Wreturn-type
2572 @opindex Wreturn-type
2573 Warn whenever a function is defined with a return-type that defaults to
2574 @code{int}.  Also warn about any @code{return} statement with no
2575 return-value in a function whose return-type is not @code{void}.
2577 For C, also warn if the return type of a function has a type qualifier
2578 such as @code{const}.  Such a type qualifier has no effect, since the
2579 value returned by a function is not an lvalue.  ISO C prohibits
2580 qualified @code{void} return types on function definitions, so such
2581 return types always receive a warning even without this option.
2583 For C++, a function without return type always produces a diagnostic
2584 message, even when @option{-Wno-return-type} is specified.  The only
2585 exceptions are @samp{main} and functions defined in system headers.
2587 This warning is enabled by @option{-Wall}.
2589 @item -Wswitch
2590 @opindex Wswitch
2591 Warn whenever a @code{switch} statement has an index of enumerated type
2592 and lacks a @code{case} for one or more of the named codes of that
2593 enumeration.  (The presence of a @code{default} label prevents this
2594 warning.)  @code{case} labels outside the enumeration range also
2595 provoke warnings when this option is used.
2596 This warning is enabled by @option{-Wall}.
2598 @item -Wswitch-default
2599 @opindex Wswitch-switch
2600 Warn whenever a @code{switch} statement does not have a @code{default}
2601 case.
2603 @item -Wswitch-enum
2604 @opindex Wswitch-enum
2605 Warn whenever a @code{switch} statement has an index of enumerated type
2606 and lacks a @code{case} for one or more of the named codes of that
2607 enumeration.  @code{case} labels outside the enumeration range also
2608 provoke warnings when this option is used.
2610 @item -Wtrigraphs
2611 @opindex Wtrigraphs
2612 Warn if any trigraphs are encountered that might change the meaning of
2613 the program (trigraphs within comments are not warned about).
2614 This warning is enabled by @option{-Wall}.
2616 @item -Wunused-function
2617 @opindex Wunused-function
2618 Warn whenever a static function is declared but not defined or a
2619 non-inline static function is unused.
2620 This warning is enabled by @option{-Wall}.
2622 @item -Wunused-label
2623 @opindex Wunused-label
2624 Warn whenever a label is declared but not used.
2625 This warning is enabled by @option{-Wall}.
2627 To suppress this warning use the @samp{unused} attribute
2628 (@pxref{Variable Attributes}).
2630 @item -Wunused-parameter
2631 @opindex Wunused-parameter
2632 Warn whenever a function parameter is unused aside from its declaration.
2634 To suppress this warning use the @samp{unused} attribute
2635 (@pxref{Variable Attributes}).
2637 @item -Wunused-variable
2638 @opindex Wunused-variable
2639 Warn whenever a local variable or non-constant static variable is unused
2640 aside from its declaration
2641 This warning is enabled by @option{-Wall}.
2643 To suppress this warning use the @samp{unused} attribute
2644 (@pxref{Variable Attributes}).
2646 @item -Wunused-value
2647 @opindex Wunused-value
2648 Warn whenever a statement computes a result that is explicitly not used.
2649 This warning is enabled by @option{-Wall}.
2651 To suppress this warning cast the expression to @samp{void}.
2653 @item -Wunused
2654 @opindex Wunused
2655 All the above @option{-Wunused} options combined.
2657 In order to get a warning about an unused function parameter, you must
2658 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2659 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2661 @item -Wuninitialized
2662 @opindex Wuninitialized
2663 Warn if an automatic variable is used without first being initialized or
2664 if a variable may be clobbered by a @code{setjmp} call.
2666 These warnings are possible only in optimizing compilation,
2667 because they require data flow information that is computed only
2668 when optimizing.  If you don't specify @option{-O}, you simply won't
2669 get these warnings.
2671 If you want to warn about code which uses the uninitialized value of the
2672 variable in its own initializer, use the @option{-Winit-self} option.
2674 These warnings occur for individual uninitialized or clobbered
2675 elements of structure, union or array variables as well as for
2676 variables which are uninitialized or clobbered as a whole.  They do
2677 not occur for variables or elements declared @code{volatile}.  Because
2678 these warnings depend on optimization, the exact variables or elements
2679 for which there are warnings will depend on the precise optimization
2680 options and version of GCC used.
2682 Note that there may be no warning about a variable that is used only
2683 to compute a value that itself is never used, because such
2684 computations may be deleted by data flow analysis before the warnings
2685 are printed.
2687 These warnings are made optional because GCC is not smart
2688 enough to see all the reasons why the code might be correct
2689 despite appearing to have an error.  Here is one example of how
2690 this can happen:
2692 @smallexample
2693 @group
2695   int x;
2696   switch (y)
2697     @{
2698     case 1: x = 1;
2699       break;
2700     case 2: x = 4;
2701       break;
2702     case 3: x = 5;
2703     @}
2704   foo (x);
2706 @end group
2707 @end smallexample
2709 @noindent
2710 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2711 always initialized, but GCC doesn't know this.  Here is
2712 another common case:
2714 @smallexample
2716   int save_y;
2717   if (change_y) save_y = y, y = new_y;
2718   @dots{}
2719   if (change_y) y = save_y;
2721 @end smallexample
2723 @noindent
2724 This has no bug because @code{save_y} is used only if it is set.
2726 @cindex @code{longjmp} warnings
2727 This option also warns when a non-volatile automatic variable might be
2728 changed by a call to @code{longjmp}.  These warnings as well are possible
2729 only in optimizing compilation.
2731 The compiler sees only the calls to @code{setjmp}.  It cannot know
2732 where @code{longjmp} will be called; in fact, a signal handler could
2733 call it at any point in the code.  As a result, you may get a warning
2734 even when there is in fact no problem because @code{longjmp} cannot
2735 in fact be called at the place which would cause a problem.
2737 Some spurious warnings can be avoided if you declare all the functions
2738 you use that never return as @code{noreturn}.  @xref{Function
2739 Attributes}.
2741 This warning is enabled by @option{-Wall}.
2743 @item -Wunknown-pragmas
2744 @opindex Wunknown-pragmas
2745 @cindex warning for unknown pragmas
2746 @cindex unknown pragmas, warning
2747 @cindex pragmas, warning of unknown
2748 Warn when a #pragma directive is encountered which is not understood by
2749 GCC@.  If this command line option is used, warnings will even be issued
2750 for unknown pragmas in system header files.  This is not the case if
2751 the warnings were only enabled by the @option{-Wall} command line option.
2753 @item -Wno-pragmas
2754 @opindex Wno-pragmas
2755 @opindex Wpragmas
2756 Do not warn about misuses of pragmas, such as incorrect parameters,
2757 invalid syntax, or conflicts between pragmas.  See also
2758 @samp{-Wunknown-pragmas}.
2760 @item -Wstrict-aliasing
2761 @opindex Wstrict-aliasing
2762 This option is only active when @option{-fstrict-aliasing} is active.
2763 It warns about code which might break the strict aliasing rules that the
2764 compiler is using for optimization.  The warning does not catch all
2765 cases, but does attempt to catch the more common pitfalls.  It is
2766 included in @option{-Wall}.
2768 @item -Wstrict-aliasing=2
2769 @opindex Wstrict-aliasing=2
2770 This option is only active when @option{-fstrict-aliasing} is active.
2771 It warns about code which might break the strict aliasing rules that the
2772 compiler is using for optimization.  This warning catches more cases than
2773 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2774 cases that are safe.
2776 @item -Wall
2777 @opindex Wall
2778 All of the above @samp{-W} options combined.  This enables all the
2779 warnings about constructions that some users consider questionable, and
2780 that are easy to avoid (or modify to prevent the warning), even in
2781 conjunction with macros.  This also enables some language-specific
2782 warnings described in @ref{C++ Dialect Options} and
2783 @ref{Objective-C and Objective-C++ Dialect Options}.
2784 @end table
2786 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2787 Some of them warn about constructions that users generally do not
2788 consider questionable, but which occasionally you might wish to check
2789 for; others warn about constructions that are necessary or hard to avoid
2790 in some cases, and there is no simple way to modify the code to suppress
2791 the warning.
2793 @table @gcctabopt
2794 @item -Wextra
2795 @opindex W
2796 @opindex Wextra
2797 (This option used to be called @option{-W}.  The older name is still
2798 supported, but the newer name is more descriptive.)  Print extra warning
2799 messages for these events:
2801 @itemize @bullet
2802 @item
2803 A function can return either with or without a value.  (Falling
2804 off the end of the function body is considered returning without
2805 a value.)  For example, this function would evoke such a
2806 warning:
2808 @smallexample
2809 @group
2810 foo (a)
2812   if (a > 0)
2813     return a;
2815 @end group
2816 @end smallexample
2818 @item
2819 An expression-statement or the left-hand side of a comma expression
2820 contains no side effects.
2821 To suppress the warning, cast the unused expression to void.
2822 For example, an expression such as @samp{x[i,j]} will cause a warning,
2823 but @samp{x[(void)i,j]} will not.
2825 @item
2826 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2828 @item
2829 Storage-class specifiers like @code{static} are not the first things in
2830 a declaration.  According to the C Standard, this usage is obsolescent.
2832 @item
2833 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2834 arguments.
2836 @item
2837 A comparison between signed and unsigned values could produce an
2838 incorrect result when the signed value is converted to unsigned.
2839 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2841 @item
2842 An aggregate has an initializer which does not initialize all members.
2843 This warning can be independently controlled by
2844 @option{-Wmissing-field-initializers}.
2846 @item
2847 A function parameter is declared without a type specifier in K&R-style
2848 functions:
2850 @smallexample
2851 void foo(bar) @{ @}
2852 @end smallexample
2854 @item
2855 An empty body occurs in an @samp{if} or @samp{else} statement.
2857 @item
2858 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2859 @samp{>}, or @samp{>=}.
2861 @item
2862 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2864 @item
2865 Any of several floating-point events that often indicate errors, such as
2866 overflow, underflow, loss of precision, etc.
2868 @item @r{(C++ only)}
2869 An enumerator and a non-enumerator both appear in a conditional expression.
2871 @item @r{(C++ only)}
2872 A non-static reference or non-static @samp{const} member appears in a
2873 class without constructors.
2875 @item @r{(C++ only)}
2876 Ambiguous virtual bases.
2878 @item @r{(C++ only)}
2879 Subscripting an array which has been declared @samp{register}.
2881 @item @r{(C++ only)}
2882 Taking the address of a variable which has been declared @samp{register}.
2884 @item @r{(C++ only)}
2885 A base class is not initialized in a derived class' copy constructor.
2886 @end itemize
2888 @item -Wno-div-by-zero
2889 @opindex Wno-div-by-zero
2890 @opindex Wdiv-by-zero
2891 Do not warn about compile-time integer division by zero.  Floating point
2892 division by zero is not warned about, as it can be a legitimate way of
2893 obtaining infinities and NaNs.
2895 @item -Wsystem-headers
2896 @opindex Wsystem-headers
2897 @cindex warnings from system headers
2898 @cindex system headers, warnings from
2899 Print warning messages for constructs found in system header files.
2900 Warnings from system headers are normally suppressed, on the assumption
2901 that they usually do not indicate real problems and would only make the
2902 compiler output harder to read.  Using this command line option tells
2903 GCC to emit warnings from system headers as if they occurred in user
2904 code.  However, note that using @option{-Wall} in conjunction with this
2905 option will @emph{not} warn about unknown pragmas in system
2906 headers---for that, @option{-Wunknown-pragmas} must also be used.
2908 @item -Wfloat-equal
2909 @opindex Wfloat-equal
2910 Warn if floating point values are used in equality comparisons.
2912 The idea behind this is that sometimes it is convenient (for the
2913 programmer) to consider floating-point values as approximations to
2914 infinitely precise real numbers.  If you are doing this, then you need
2915 to compute (by analyzing the code, or in some other way) the maximum or
2916 likely maximum error that the computation introduces, and allow for it
2917 when performing comparisons (and when producing output, but that's a
2918 different problem).  In particular, instead of testing for equality, you
2919 would check to see whether the two values have ranges that overlap; and
2920 this is done with the relational operators, so equality comparisons are
2921 probably mistaken.
2923 @item -Wtraditional @r{(C only)}
2924 @opindex Wtraditional
2925 Warn about certain constructs that behave differently in traditional and
2926 ISO C@.  Also warn about ISO C constructs that have no traditional C
2927 equivalent, and/or problematic constructs which should be avoided.
2929 @itemize @bullet
2930 @item
2931 Macro parameters that appear within string literals in the macro body.
2932 In traditional C macro replacement takes place within string literals,
2933 but does not in ISO C@.
2935 @item
2936 In traditional C, some preprocessor directives did not exist.
2937 Traditional preprocessors would only consider a line to be a directive
2938 if the @samp{#} appeared in column 1 on the line.  Therefore
2939 @option{-Wtraditional} warns about directives that traditional C
2940 understands but would ignore because the @samp{#} does not appear as the
2941 first character on the line.  It also suggests you hide directives like
2942 @samp{#pragma} not understood by traditional C by indenting them.  Some
2943 traditional implementations would not recognize @samp{#elif}, so it
2944 suggests avoiding it altogether.
2946 @item
2947 A function-like macro that appears without arguments.
2949 @item
2950 The unary plus operator.
2952 @item
2953 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2954 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2955 constants.)  Note, these suffixes appear in macros defined in the system
2956 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2957 Use of these macros in user code might normally lead to spurious
2958 warnings, however GCC's integrated preprocessor has enough context to
2959 avoid warning in these cases.
2961 @item
2962 A function declared external in one block and then used after the end of
2963 the block.
2965 @item
2966 A @code{switch} statement has an operand of type @code{long}.
2968 @item
2969 A non-@code{static} function declaration follows a @code{static} one.
2970 This construct is not accepted by some traditional C compilers.
2972 @item
2973 The ISO type of an integer constant has a different width or
2974 signedness from its traditional type.  This warning is only issued if
2975 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2976 typically represent bit patterns, are not warned about.
2978 @item
2979 Usage of ISO string concatenation is detected.
2981 @item
2982 Initialization of automatic aggregates.
2984 @item
2985 Identifier conflicts with labels.  Traditional C lacks a separate
2986 namespace for labels.
2988 @item
2989 Initialization of unions.  If the initializer is zero, the warning is
2990 omitted.  This is done under the assumption that the zero initializer in
2991 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2992 initializer warnings and relies on default initialization to zero in the
2993 traditional C case.
2995 @item
2996 Conversions by prototypes between fixed/floating point values and vice
2997 versa.  The absence of these prototypes when compiling with traditional
2998 C would cause serious problems.  This is a subset of the possible
2999 conversion warnings, for the full set use @option{-Wconversion}.
3001 @item
3002 Use of ISO C style function definitions.  This warning intentionally is
3003 @emph{not} issued for prototype declarations or variadic functions
3004 because these ISO C features will appear in your code when using
3005 libiberty's traditional C compatibility macros, @code{PARAMS} and
3006 @code{VPARAMS}.  This warning is also bypassed for nested functions
3007 because that feature is already a GCC extension and thus not relevant to
3008 traditional C compatibility.
3009 @end itemize
3011 @item -Wdeclaration-after-statement @r{(C only)}
3012 @opindex Wdeclaration-after-statement
3013 Warn when a declaration is found after a statement in a block.  This
3014 construct, known from C++, was introduced with ISO C99 and is by default
3015 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3016 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3018 @item -Wundef
3019 @opindex Wundef
3020 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3022 @item -Wno-endif-labels
3023 @opindex Wno-endif-labels
3024 @opindex Wendif-labels
3025 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3027 @item -Wshadow
3028 @opindex Wshadow
3029 Warn whenever a local variable shadows another local variable, parameter or
3030 global variable or whenever a built-in function is shadowed.
3032 @item -Wlarger-than-@var{len}
3033 @opindex Wlarger-than
3034 Warn whenever an object of larger than @var{len} bytes is defined.
3036 @item -Wunsafe-loop-optimizations
3037 @opindex Wunsafe-loop-optimizations
3038 Warn if the loop cannot be optimized because the compiler could not
3039 assume anything on the bounds of the loop indices.  With
3040 @option{-funsafe-loop-optimizations} warn if the compiler made
3041 such assumptions.
3043 @item -Wpointer-arith
3044 @opindex Wpointer-arith
3045 Warn about anything that depends on the ``size of'' a function type or
3046 of @code{void}.  GNU C assigns these types a size of 1, for
3047 convenience in calculations with @code{void *} pointers and pointers
3048 to functions.
3050 @item -Wbad-function-cast @r{(C only)}
3051 @opindex Wbad-function-cast
3052 Warn whenever a function call is cast to a non-matching type.
3053 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3055 @item -Wc++-compat
3056 Warn about ISO C constructs that are outside of the common subset of
3057 ISO C and ISO C++, e.g.@: request for implicit conversion from
3058 @code{void *} to a pointer to non-@code{void} type.
3060 @item -Wcast-qual
3061 @opindex Wcast-qual
3062 Warn whenever a pointer is cast so as to remove a type qualifier from
3063 the target type.  For example, warn if a @code{const char *} is cast
3064 to an ordinary @code{char *}.
3066 @item -Wcast-align
3067 @opindex Wcast-align
3068 Warn whenever a pointer is cast such that the required alignment of the
3069 target is increased.  For example, warn if a @code{char *} is cast to
3070 an @code{int *} on machines where integers can only be accessed at
3071 two- or four-byte boundaries.
3073 @item -Wwrite-strings
3074 @opindex Wwrite-strings
3075 When compiling C, give string constants the type @code{const
3076 char[@var{length}]} so that
3077 copying the address of one into a non-@code{const} @code{char *}
3078 pointer will get a warning; when compiling C++, warn about the
3079 deprecated conversion from string constants to @code{char *}.
3080 These warnings will help you find at
3081 compile time code that can try to write into a string constant, but
3082 only if you have been very careful about using @code{const} in
3083 declarations and prototypes.  Otherwise, it will just be a nuisance;
3084 this is why we did not make @option{-Wall} request these warnings.
3086 @item -Wconversion
3087 @opindex Wconversion
3088 Warn if a prototype causes a type conversion that is different from what
3089 would happen to the same argument in the absence of a prototype.  This
3090 includes conversions of fixed point to floating and vice versa, and
3091 conversions changing the width or signedness of a fixed point argument
3092 except when the same as the default promotion.
3094 Also, warn if a negative integer constant expression is implicitly
3095 converted to an unsigned type.  For example, warn about the assignment
3096 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3097 casts like @code{(unsigned) -1}.
3099 @item -Wsign-compare
3100 @opindex Wsign-compare
3101 @cindex warning for comparison of signed and unsigned values
3102 @cindex comparison of signed and unsigned values, warning
3103 @cindex signed and unsigned values, comparison warning
3104 Warn when a comparison between signed and unsigned values could produce
3105 an incorrect result when the signed value is converted to unsigned.
3106 This warning is also enabled by @option{-Wextra}; to get the other warnings
3107 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3109 @item -Waggregate-return
3110 @opindex Waggregate-return
3111 Warn if any functions that return structures or unions are defined or
3112 called.  (In languages where you can return an array, this also elicits
3113 a warning.)
3115 @item -Walways-true
3116 @opindex Walways-true
3117 Warn about comparisons which are always true such as testing if
3118 unsigned values are greater than or equal to zero.  This warning is
3119 enabled by @option{-Wall}.
3121 @item -Wno-attributes
3122 @opindex Wno-attributes
3123 @opindex Wattributes
3124 Do not warn if an unexpected @code{__attribute__} is used, such as
3125 unrecognized attributes, function attributes applied to variables,
3126 etc.  This will not stop errors for incorrect use of supported
3127 attributes.
3129 @item -Wstrict-prototypes @r{(C only)}
3130 @opindex Wstrict-prototypes
3131 Warn if a function is declared or defined without specifying the
3132 argument types.  (An old-style function definition is permitted without
3133 a warning if preceded by a declaration which specifies the argument
3134 types.)
3136 @item -Wold-style-definition @r{(C only)}
3137 @opindex Wold-style-definition
3138 Warn if an old-style function definition is used.  A warning is given
3139 even if there is a previous prototype.
3141 @item -Wmissing-prototypes @r{(C only)}
3142 @opindex Wmissing-prototypes
3143 Warn if a global function is defined without a previous prototype
3144 declaration.  This warning is issued even if the definition itself
3145 provides a prototype.  The aim is to detect global functions that fail
3146 to be declared in header files.
3148 @item -Wmissing-declarations @r{(C only)}
3149 @opindex Wmissing-declarations
3150 Warn if a global function is defined without a previous declaration.
3151 Do so even if the definition itself provides a prototype.
3152 Use this option to detect global functions that are not declared in
3153 header files.
3155 @item -Wmissing-field-initializers
3156 @opindex Wmissing-field-initializers
3157 @opindex W
3158 @opindex Wextra
3159 Warn if a structure's initializer has some fields missing.  For
3160 example, the following code would cause such a warning, because
3161 @code{x.h} is implicitly zero:
3163 @smallexample
3164 struct s @{ int f, g, h; @};
3165 struct s x = @{ 3, 4 @};
3166 @end smallexample
3168 This option does not warn about designated initializers, so the following
3169 modification would not trigger a warning:
3171 @smallexample
3172 struct s @{ int f, g, h; @};
3173 struct s x = @{ .f = 3, .g = 4 @};
3174 @end smallexample
3176 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3177 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3179 @item -Wmissing-noreturn
3180 @opindex Wmissing-noreturn
3181 Warn about functions which might be candidates for attribute @code{noreturn}.
3182 Note these are only possible candidates, not absolute ones.  Care should
3183 be taken to manually verify functions actually do not ever return before
3184 adding the @code{noreturn} attribute, otherwise subtle code generation
3185 bugs could be introduced.  You will not get a warning for @code{main} in
3186 hosted C environments.
3188 @item -Wmissing-format-attribute
3189 @opindex Wmissing-format-attribute
3190 @opindex Wformat
3191 Warn about function pointers which might be candidates for @code{format}
3192 attributes.  Note these are only possible candidates, not absolute ones.
3193 GCC will guess that function pointers with @code{format} attributes that
3194 are used in assignment, initialization, parameter passing or return
3195 statements should have a corresponding @code{format} attribute in the
3196 resulting type.  I.e.@: the left-hand side of the assignment or
3197 initialization, the type of the parameter variable, or the return type
3198 of the containing function respectively should also have a @code{format}
3199 attribute to avoid the warning.
3201 GCC will also warn about function definitions which might be
3202 candidates for @code{format} attributes.  Again, these are only
3203 possible candidates.  GCC will guess that @code{format} attributes
3204 might be appropriate for any function that calls a function like
3205 @code{vprintf} or @code{vscanf}, but this might not always be the
3206 case, and some functions for which @code{format} attributes are
3207 appropriate may not be detected.
3209 @item -Wno-multichar
3210 @opindex Wno-multichar
3211 @opindex Wmultichar
3212 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3213 Usually they indicate a typo in the user's code, as they have
3214 implementation-defined values, and should not be used in portable code.
3216 @item -Wnormalized=<none|id|nfc|nfkc>
3217 @opindex Wnormalized
3218 @cindex NFC
3219 @cindex NFKC
3220 @cindex character set, input normalization
3221 In ISO C and ISO C++, two identifiers are different if they are
3222 different sequences of characters.  However, sometimes when characters
3223 outside the basic ASCII character set are used, you can have two
3224 different character sequences that look the same.  To avoid confusion,
3225 the ISO 10646 standard sets out some @dfn{normalization rules} which
3226 when applied ensure that two sequences that look the same are turned into
3227 the same sequence.  GCC can warn you if you are using identifiers which
3228 have not been normalized; this option controls that warning.
3230 There are four levels of warning that GCC supports.  The default is
3231 @option{-Wnormalized=nfc}, which warns about any identifier which is
3232 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3233 recommended form for most uses.
3235 Unfortunately, there are some characters which ISO C and ISO C++ allow
3236 in identifiers that when turned into NFC aren't allowable as
3237 identifiers.  That is, there's no way to use these symbols in portable
3238 ISO C or C++ and have all your identifiers in NFC.
3239 @option{-Wnormalized=id} suppresses the warning for these characters.
3240 It is hoped that future versions of the standards involved will correct
3241 this, which is why this option is not the default.
3243 You can switch the warning off for all characters by writing
3244 @option{-Wnormalized=none}.  You would only want to do this if you
3245 were using some other normalization scheme (like ``D''), because
3246 otherwise you can easily create bugs that are literally impossible to see.
3248 Some characters in ISO 10646 have distinct meanings but look identical
3249 in some fonts or display methodologies, especially once formatting has
3250 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3251 LETTER N'', will display just like a regular @code{n} which has been
3252 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3253 normalisation scheme to convert all these into a standard form as
3254 well, and GCC will warn if your code is not in NFKC if you use
3255 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3256 about every identifier that contains the letter O because it might be
3257 confused with the digit 0, and so is not the default, but may be
3258 useful as a local coding convention if the programming environment is
3259 unable to be fixed to display these characters distinctly.
3261 @item -Wno-deprecated-declarations
3262 @opindex Wno-deprecated-declarations
3263 Do not warn about uses of functions, variables, and types marked as
3264 deprecated by using the @code{deprecated} attribute.
3265 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3266 @pxref{Type Attributes}.)
3268 @item -Wpacked
3269 @opindex Wpacked
3270 Warn if a structure is given the packed attribute, but the packed
3271 attribute has no effect on the layout or size of the structure.
3272 Such structures may be mis-aligned for little benefit.  For
3273 instance, in this code, the variable @code{f.x} in @code{struct bar}
3274 will be misaligned even though @code{struct bar} does not itself
3275 have the packed attribute:
3277 @smallexample
3278 @group
3279 struct foo @{
3280   int x;
3281   char a, b, c, d;
3282 @} __attribute__((packed));
3283 struct bar @{
3284   char z;
3285   struct foo f;
3287 @end group
3288 @end smallexample
3290 @item -Wpadded
3291 @opindex Wpadded
3292 Warn if padding is included in a structure, either to align an element
3293 of the structure or to align the whole structure.  Sometimes when this
3294 happens it is possible to rearrange the fields of the structure to
3295 reduce the padding and so make the structure smaller.
3297 @item -Wredundant-decls
3298 @opindex Wredundant-decls
3299 Warn if anything is declared more than once in the same scope, even in
3300 cases where multiple declaration is valid and changes nothing.
3302 @item -Wnested-externs @r{(C only)}
3303 @opindex Wnested-externs
3304 Warn if an @code{extern} declaration is encountered within a function.
3306 @item -Wunreachable-code
3307 @opindex Wunreachable-code
3308 Warn if the compiler detects that code will never be executed.
3310 This option is intended to warn when the compiler detects that at
3311 least a whole line of source code will never be executed, because
3312 some condition is never satisfied or because it is after a
3313 procedure that never returns.
3315 It is possible for this option to produce a warning even though there
3316 are circumstances under which part of the affected line can be executed,
3317 so care should be taken when removing apparently-unreachable code.
3319 For instance, when a function is inlined, a warning may mean that the
3320 line is unreachable in only one inlined copy of the function.
3322 This option is not made part of @option{-Wall} because in a debugging
3323 version of a program there is often substantial code which checks
3324 correct functioning of the program and is, hopefully, unreachable
3325 because the program does work.  Another common use of unreachable
3326 code is to provide behavior which is selectable at compile-time.
3328 @item -Winline
3329 @opindex Winline
3330 Warn if a function can not be inlined and it was declared as inline.
3331 Even with this option, the compiler will not warn about failures to
3332 inline functions declared in system headers.
3334 The compiler uses a variety of heuristics to determine whether or not
3335 to inline a function.  For example, the compiler takes into account
3336 the size of the function being inlined and the amount of inlining
3337 that has already been done in the current function.  Therefore,
3338 seemingly insignificant changes in the source program can cause the
3339 warnings produced by @option{-Winline} to appear or disappear.
3341 @item -Wno-invalid-offsetof @r{(C++ only)}
3342 @opindex Wno-invalid-offsetof
3343 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3344 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3345 to a non-POD type is undefined.  In existing C++ implementations,
3346 however, @samp{offsetof} typically gives meaningful results even when
3347 applied to certain kinds of non-POD types. (Such as a simple
3348 @samp{struct} that fails to be a POD type only by virtue of having a
3349 constructor.)  This flag is for users who are aware that they are
3350 writing nonportable code and who have deliberately chosen to ignore the
3351 warning about it.
3353 The restrictions on @samp{offsetof} may be relaxed in a future version
3354 of the C++ standard.
3356 @item -Wno-int-to-pointer-cast @r{(C only)}
3357 @opindex Wno-int-to-pointer-cast
3358 Suppress warnings from casts to pointer type of an integer of a
3359 different size.
3361 @item -Wno-pointer-to-int-cast @r{(C only)}
3362 @opindex Wno-pointer-to-int-cast
3363 Suppress warnings from casts from a pointer to an integer type of a
3364 different size.
3366 @item -Winvalid-pch
3367 @opindex Winvalid-pch
3368 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3369 the search path but can't be used.
3371 @item -Wlong-long
3372 @opindex Wlong-long
3373 @opindex Wno-long-long
3374 Warn if @samp{long long} type is used.  This is default.  To inhibit
3375 the warning messages, use @option{-Wno-long-long}.  Flags
3376 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3377 only when @option{-pedantic} flag is used.
3379 @item -Wvariadic-macros
3380 @opindex Wvariadic-macros
3381 @opindex Wno-variadic-macros
3382 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3383 alternate syntax when in pedantic ISO C99 mode.  This is default.
3384 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3386 @item -Wvolatile-register-var
3387 @opindex Wvolatile-register-var
3388 @opindex Wno-volatile-register-var
3389 Warn if a register variable is declared volatile.  The volatile
3390 modifier does not inhibit all optimizations that may eliminate reads
3391 and/or writes to register variables.
3393 @item -Wdisabled-optimization
3394 @opindex Wdisabled-optimization
3395 Warn if a requested optimization pass is disabled.  This warning does
3396 not generally indicate that there is anything wrong with your code; it
3397 merely indicates that GCC's optimizers were unable to handle the code
3398 effectively.  Often, the problem is that your code is too big or too
3399 complex; GCC will refuse to optimize programs when the optimization
3400 itself is likely to take inordinate amounts of time.
3402 @item -Wno-pointer-sign
3403 @opindex Wno-pointer-sign
3404 Don't warn for pointer argument passing or assignment with different signedness.
3405 Only useful in the negative form since this warning is enabled by default.
3406 This option is only supported for C and Objective-C@.
3408 @item -Werror
3409 @opindex Werror
3410 Make all warnings into errors.
3412 @item -Wstack-protector
3413 @opindex Wstack-protector
3414 This option is only active when @option{-fstack-protector} is active.  It
3415 warns about functions that will not be protected against stack smashing.
3417 @item -Wstring-literal-comparison
3418 @opindex Wstring-literal-comparison
3419 Warn about suspicious comparisons to string literal constants.  In C,
3420 direct comparisons against the memory address of a string literal, such
3421 as @code{if (x == "abc")}, typically indicate a programmer error, and
3422 even when intentional, result in unspecified behavior and are not portable.
3423 Usually these warnings alert that the programmer intended to use
3424 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3426 @end table
3428 @node Debugging Options
3429 @section Options for Debugging Your Program or GCC
3430 @cindex options, debugging
3431 @cindex debugging information options
3433 GCC has various special options that are used for debugging
3434 either your program or GCC:
3436 @table @gcctabopt
3437 @item -g
3438 @opindex g
3439 Produce debugging information in the operating system's native format
3440 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3441 information.
3443 On most systems that use stabs format, @option{-g} enables use of extra
3444 debugging information that only GDB can use; this extra information
3445 makes debugging work better in GDB but will probably make other debuggers
3446 crash or
3447 refuse to read the program.  If you want to control for certain whether
3448 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3449 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3451 GCC allows you to use @option{-g} with
3452 @option{-O}.  The shortcuts taken by optimized code may occasionally
3453 produce surprising results: some variables you declared may not exist
3454 at all; flow of control may briefly move where you did not expect it;
3455 some statements may not be executed because they compute constant
3456 results or their values were already at hand; some statements may
3457 execute in different places because they were moved out of loops.
3459 Nevertheless it proves possible to debug optimized output.  This makes
3460 it reasonable to use the optimizer for programs that might have bugs.
3462 The following options are useful when GCC is generated with the
3463 capability for more than one debugging format.
3465 @item -ggdb
3466 @opindex ggdb
3467 Produce debugging information for use by GDB@.  This means to use the
3468 most expressive format available (DWARF 2, stabs, or the native format
3469 if neither of those are supported), including GDB extensions if at all
3470 possible.
3472 @item -gstabs
3473 @opindex gstabs
3474 Produce debugging information in stabs format (if that is supported),
3475 without GDB extensions.  This is the format used by DBX on most BSD
3476 systems.  On MIPS, Alpha and System V Release 4 systems this option
3477 produces stabs debugging output which is not understood by DBX or SDB@.
3478 On System V Release 4 systems this option requires the GNU assembler.
3480 @item -feliminate-unused-debug-symbols
3481 @opindex feliminate-unused-debug-symbols
3482 Produce debugging information in stabs format (if that is supported),
3483 for only symbols that are actually used.
3485 @item -gstabs+
3486 @opindex gstabs+
3487 Produce debugging information in stabs format (if that is supported),
3488 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3489 use of these extensions is likely to make other debuggers crash or
3490 refuse to read the program.
3492 @item -gcoff
3493 @opindex gcoff
3494 Produce debugging information in COFF format (if that is supported).
3495 This is the format used by SDB on most System V systems prior to
3496 System V Release 4.
3498 @item -gxcoff
3499 @opindex gxcoff
3500 Produce debugging information in XCOFF format (if that is supported).
3501 This is the format used by the DBX debugger on IBM RS/6000 systems.
3503 @item -gxcoff+
3504 @opindex gxcoff+
3505 Produce debugging information in XCOFF format (if that is supported),
3506 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3507 use of these extensions is likely to make other debuggers crash or
3508 refuse to read the program, and may cause assemblers other than the GNU
3509 assembler (GAS) to fail with an error.
3511 @item -gdwarf-2
3512 @opindex gdwarf-2
3513 Produce debugging information in DWARF version 2 format (if that is
3514 supported).  This is the format used by DBX on IRIX 6.  With this
3515 option, GCC uses features of DWARF version 3 when they are useful;
3516 version 3 is upward compatible with version 2, but may still cause
3517 problems for older debuggers.
3519 @item -gvms
3520 @opindex gvms
3521 Produce debugging information in VMS debug format (if that is
3522 supported).  This is the format used by DEBUG on VMS systems.
3524 @item -g@var{level}
3525 @itemx -ggdb@var{level}
3526 @itemx -gstabs@var{level}
3527 @itemx -gcoff@var{level}
3528 @itemx -gxcoff@var{level}
3529 @itemx -gvms@var{level}
3530 Request debugging information and also use @var{level} to specify how
3531 much information.  The default level is 2.
3533 Level 1 produces minimal information, enough for making backtraces in
3534 parts of the program that you don't plan to debug.  This includes
3535 descriptions of functions and external variables, but no information
3536 about local variables and no line numbers.
3538 Level 3 includes extra information, such as all the macro definitions
3539 present in the program.  Some debuggers support macro expansion when
3540 you use @option{-g3}.
3542 @option{-gdwarf-2} does not accept a concatenated debug level, because
3543 GCC used to support an option @option{-gdwarf} that meant to generate
3544 debug information in version 1 of the DWARF format (which is very
3545 different from version 2), and it would have been too confusing.  That
3546 debug format is long obsolete, but the option cannot be changed now.
3547 Instead use an additional @option{-g@var{level}} option to change the
3548 debug level for DWARF2.
3550 @item -feliminate-dwarf2-dups
3551 @opindex feliminate-dwarf2-dups
3552 Compress DWARF2 debugging information by eliminating duplicated
3553 information about each symbol.  This option only makes sense when
3554 generating DWARF2 debugging information with @option{-gdwarf-2}.
3556 @cindex @command{prof}
3557 @item -p
3558 @opindex p
3559 Generate extra code to write profile information suitable for the
3560 analysis program @command{prof}.  You must use this option when compiling
3561 the source files you want data about, and you must also use it when
3562 linking.
3564 @cindex @command{gprof}
3565 @item -pg
3566 @opindex pg
3567 Generate extra code to write profile information suitable for the
3568 analysis program @command{gprof}.  You must use this option when compiling
3569 the source files you want data about, and you must also use it when
3570 linking.
3572 @item -Q
3573 @opindex Q
3574 Makes the compiler print out each function name as it is compiled, and
3575 print some statistics about each pass when it finishes.
3577 @item -ftime-report
3578 @opindex ftime-report
3579 Makes the compiler print some statistics about the time consumed by each
3580 pass when it finishes.
3582 @item -fmem-report
3583 @opindex fmem-report
3584 Makes the compiler print some statistics about permanent memory
3585 allocation when it finishes.
3587 @item -fprofile-arcs
3588 @opindex fprofile-arcs
3589 Add code so that program flow @dfn{arcs} are instrumented.  During
3590 execution the program records how many times each branch and call is
3591 executed and how many times it is taken or returns.  When the compiled
3592 program exits it saves this data to a file called
3593 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3594 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3595 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3596 @var{auxname} is generated from the name of the output file, if
3597 explicitly specified and it is not the final executable, otherwise it is
3598 the basename of the source file.  In both cases any suffix is removed
3599 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3600 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3601 @xref{Cross-profiling}.
3603 @cindex @command{gcov}
3604 @item --coverage
3605 @opindex coverage
3607 This option is used to compile and link code instrumented for coverage
3608 analysis.  The option is a synonym for @option{-fprofile-arcs}
3609 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3610 linking).  See the documentation for those options for more details.
3612 @itemize
3614 @item
3615 Compile the source files with @option{-fprofile-arcs} plus optimization
3616 and code generation options.  For test coverage analysis, use the
3617 additional @option{-ftest-coverage} option.  You do not need to profile
3618 every source file in a program.
3620 @item
3621 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3622 (the latter implies the former).
3624 @item
3625 Run the program on a representative workload to generate the arc profile
3626 information.  This may be repeated any number of times.  You can run
3627 concurrent instances of your program, and provided that the file system
3628 supports locking, the data files will be correctly updated.  Also
3629 @code{fork} calls are detected and correctly handled (double counting
3630 will not happen).
3632 @item
3633 For profile-directed optimizations, compile the source files again with
3634 the same optimization and code generation options plus
3635 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3636 Control Optimization}).
3638 @item
3639 For test coverage analysis, use @command{gcov} to produce human readable
3640 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3641 @command{gcov} documentation for further information.
3643 @end itemize
3645 With @option{-fprofile-arcs}, for each function of your program GCC
3646 creates a program flow graph, then finds a spanning tree for the graph.
3647 Only arcs that are not on the spanning tree have to be instrumented: the
3648 compiler adds code to count the number of times that these arcs are
3649 executed.  When an arc is the only exit or only entrance to a block, the
3650 instrumentation code can be added to the block; otherwise, a new basic
3651 block must be created to hold the instrumentation code.
3653 @need 2000
3654 @item -ftest-coverage
3655 @opindex ftest-coverage
3656 Produce a notes file that the @command{gcov} code-coverage utility
3657 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3658 show program coverage.  Each source file's note file is called
3659 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3660 above for a description of @var{auxname} and instructions on how to
3661 generate test coverage data.  Coverage data will match the source files
3662 more closely, if you do not optimize.
3664 @item -d@var{letters}
3665 @item -fdump-rtl-@var{pass}
3666 @opindex d
3667 Says to make debugging dumps during compilation at times specified by
3668 @var{letters}.    This is used for debugging the RTL-based passes of the
3669 compiler.  The file names for most of the dumps are made by appending a
3670 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3671 from the name of the output file, if explicitly specified and it is not
3672 an executable, otherwise it is the basename of the source file.
3674 Most debug dumps can be enabled either passing a letter to the @option{-d}
3675 option, or with a long @option{-fdump-rtl} switch; here are the possible
3676 letters for use in @var{letters} and @var{pass}, and their meanings:
3678 @table @gcctabopt
3679 @item -dA
3680 @opindex dA
3681 Annotate the assembler output with miscellaneous debugging information.
3683 @item -db
3684 @itemx -fdump-rtl-bp
3685 @opindex db
3686 @opindex fdump-rtl-bp
3687 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3689 @item -dB
3690 @itemx -fdump-rtl-bbro
3691 @opindex dB
3692 @opindex fdump-rtl-bbro
3693 Dump after block reordering, to @file{@var{file}.30.bbro}.
3695 @item -dc
3696 @itemx -fdump-rtl-combine
3697 @opindex dc
3698 @opindex fdump-rtl-combine
3699 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3701 @item -dC
3702 @itemx -fdump-rtl-ce1
3703 @itemx -fdump-rtl-ce2
3704 @opindex dC
3705 @opindex fdump-rtl-ce1
3706 @opindex fdump-rtl-ce2
3707 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3708 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3709 and @option{-fdump-rtl-ce2} enable dumping after the second if
3710 conversion, to the file @file{@var{file}.18.ce2}.
3712 @item -dd
3713 @itemx -fdump-rtl-btl
3714 @itemx -fdump-rtl-dbr
3715 @opindex dd
3716 @opindex fdump-rtl-btl
3717 @opindex fdump-rtl-dbr
3718 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3719 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3720 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3721 scheduling, to @file{@var{file}.36.dbr}.
3723 @item -dD
3724 @opindex dD
3725 Dump all macro definitions, at the end of preprocessing, in addition to
3726 normal output.
3728 @item -dE
3729 @itemx -fdump-rtl-ce3
3730 @opindex dE
3731 @opindex fdump-rtl-ce3
3732 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3734 @item -df
3735 @itemx -fdump-rtl-cfg
3736 @itemx -fdump-rtl-life
3737 @opindex df
3738 @opindex fdump-rtl-cfg
3739 @opindex fdump-rtl-life
3740 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3741 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3742 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3743 to @file{@var{file}.16.life}.
3745 @item -dg
3746 @itemx -fdump-rtl-greg
3747 @opindex dg
3748 @opindex fdump-rtl-greg
3749 Dump after global register allocation, to @file{@var{file}.23.greg}.
3751 @item -dG
3752 @itemx -fdump-rtl-gcse
3753 @itemx -fdump-rtl-bypass
3754 @opindex dG
3755 @opindex fdump-rtl-gcse
3756 @opindex fdump-rtl-bypass
3757 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3758 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3759 enable dumping after jump bypassing and control flow optimizations, to
3760 @file{@var{file}.07.bypass}.
3762 @item -dh
3763 @itemx -fdump-rtl-eh
3764 @opindex dh
3765 @opindex fdump-rtl-eh
3766 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3768 @item -di
3769 @itemx -fdump-rtl-sibling
3770 @opindex di
3771 @opindex fdump-rtl-sibling
3772 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3774 @item -dj
3775 @itemx -fdump-rtl-jump
3776 @opindex dj
3777 @opindex fdump-rtl-jump
3778 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3780 @item -dk
3781 @itemx -fdump-rtl-stack
3782 @opindex dk
3783 @opindex fdump-rtl-stack
3784 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3786 @item -dl
3787 @itemx -fdump-rtl-lreg
3788 @opindex dl
3789 @opindex fdump-rtl-lreg
3790 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3792 @item -dL
3793 @itemx -fdump-rtl-loop
3794 @itemx -fdump-rtl-loop2
3795 @opindex dL
3796 @opindex fdump-rtl-loop
3797 @opindex fdump-rtl-loop2
3798 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3799 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3800 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3801 @file{@var{file}.13.loop2}.
3803 @item -dm
3804 @itemx -fdump-rtl-sms
3805 @opindex dm
3806 @opindex fdump-rtl-sms
3807 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3809 @item -dM
3810 @itemx -fdump-rtl-mach
3811 @opindex dM
3812 @opindex fdump-rtl-mach
3813 Dump after performing the machine dependent reorganization pass, to
3814 @file{@var{file}.35.mach}.
3816 @item -dn
3817 @itemx -fdump-rtl-rnreg
3818 @opindex dn
3819 @opindex fdump-rtl-rnreg
3820 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3822 @item -dN
3823 @itemx -fdump-rtl-regmove
3824 @opindex dN
3825 @opindex fdump-rtl-regmove
3826 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3828 @item -do
3829 @itemx -fdump-rtl-postreload
3830 @opindex do
3831 @opindex fdump-rtl-postreload
3832 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3834 @item -dr
3835 @itemx -fdump-rtl-expand
3836 @opindex dr
3837 @opindex fdump-rtl-expand
3838 Dump after RTL generation, to @file{@var{file}.00.expand}.
3840 @item -dR
3841 @itemx -fdump-rtl-sched2
3842 @opindex dR
3843 @opindex fdump-rtl-sched2
3844 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3846 @item -ds
3847 @itemx -fdump-rtl-cse
3848 @opindex ds
3849 @opindex fdump-rtl-cse
3850 Dump after CSE (including the jump optimization that sometimes follows
3851 CSE), to @file{@var{file}.04.cse}.
3853 @item -dS
3854 @itemx -fdump-rtl-sched
3855 @opindex dS
3856 @opindex fdump-rtl-sched
3857 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3859 @item -dt
3860 @itemx -fdump-rtl-cse2
3861 @opindex dt
3862 @opindex fdump-rtl-cse2
3863 Dump after the second CSE pass (including the jump optimization that
3864 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3866 @item -dT
3867 @itemx -fdump-rtl-tracer
3868 @opindex dT
3869 @opindex fdump-rtl-tracer
3870 Dump after running tracer, to @file{@var{file}.12.tracer}.
3872 @item -dV
3873 @itemx -fdump-rtl-vpt
3874 @itemx -fdump-rtl-vartrack
3875 @opindex dV
3876 @opindex fdump-rtl-vpt
3877 @opindex fdump-rtl-vartrack
3878 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3879 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3880 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3881 to @file{@var{file}.34.vartrack}.
3883 @item -dw
3884 @itemx -fdump-rtl-flow2
3885 @opindex dw
3886 @opindex fdump-rtl-flow2
3887 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3889 @item -dz
3890 @itemx -fdump-rtl-peephole2
3891 @opindex dz
3892 @opindex fdump-rtl-peephole2
3893 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3895 @item -dZ
3896 @itemx -fdump-rtl-web
3897 @opindex dZ
3898 @opindex fdump-rtl-web
3899 Dump after live range splitting, to @file{@var{file}.14.web}.
3901 @item -da
3902 @itemx -fdump-rtl-all
3903 @opindex da
3904 @opindex fdump-rtl-all
3905 Produce all the dumps listed above.
3907 @item -dH
3908 @opindex dH
3909 Produce a core dump whenever an error occurs.
3911 @item -dm
3912 @opindex dm
3913 Print statistics on memory usage, at the end of the run, to
3914 standard error.
3916 @item -dp
3917 @opindex dp
3918 Annotate the assembler output with a comment indicating which
3919 pattern and alternative was used.  The length of each instruction is
3920 also printed.
3922 @item -dP
3923 @opindex dP
3924 Dump the RTL in the assembler output as a comment before each instruction.
3925 Also turns on @option{-dp} annotation.
3927 @item -dv
3928 @opindex dv
3929 For each of the other indicated dump files (either with @option{-d} or
3930 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3931 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3933 @item -dx
3934 @opindex dx
3935 Just generate RTL for a function instead of compiling it.  Usually used
3936 with @samp{r} (@option{-fdump-rtl-expand}).
3938 @item -dy
3939 @opindex dy
3940 Dump debugging information during parsing, to standard error.
3941 @end table
3943 @item -fdump-unnumbered
3944 @opindex fdump-unnumbered
3945 When doing debugging dumps (see @option{-d} option above), suppress instruction
3946 numbers and line number note output.  This makes it more feasible to
3947 use diff on debugging dumps for compiler invocations with different
3948 options, in particular with and without @option{-g}.
3950 @item -fdump-translation-unit @r{(C++ only)}
3951 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3952 @opindex fdump-translation-unit
3953 Dump a representation of the tree structure for the entire translation
3954 unit to a file.  The file name is made by appending @file{.tu} to the
3955 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3956 controls the details of the dump as described for the
3957 @option{-fdump-tree} options.
3959 @item -fdump-class-hierarchy @r{(C++ only)}
3960 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3961 @opindex fdump-class-hierarchy
3962 Dump a representation of each class's hierarchy and virtual function
3963 table layout to a file.  The file name is made by appending @file{.class}
3964 to the source file name.  If the @samp{-@var{options}} form is used,
3965 @var{options} controls the details of the dump as described for the
3966 @option{-fdump-tree} options.
3968 @item -fdump-ipa-@var{switch}
3969 @opindex fdump-ipa
3970 Control the dumping at various stages of inter-procedural analysis
3971 language tree to a file.  The file name is generated by appending a switch
3972 specific suffix to the source file name.  The following dumps are possible:
3974 @table @samp
3975 @item all
3976 Enables all inter-procedural analysis dumps; currently the only produced
3977 dump is the @samp{cgraph} dump.
3979 @item cgraph
3980 Dumps information about call-graph optimization, unused function removal,
3981 and inlining decisions.
3982 @end table
3984 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3985 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3986 @opindex fdump-tree
3987 Control the dumping at various stages of processing the intermediate
3988 language tree to a file.  The file name is generated by appending a switch
3989 specific suffix to the source file name.  If the @samp{-@var{options}}
3990 form is used, @var{options} is a list of @samp{-} separated options that
3991 control the details of the dump.  Not all options are applicable to all
3992 dumps, those which are not meaningful will be ignored.  The following
3993 options are available
3995 @table @samp
3996 @item address
3997 Print the address of each node.  Usually this is not meaningful as it
3998 changes according to the environment and source file.  Its primary use
3999 is for tying up a dump file with a debug environment.
4000 @item slim
4001 Inhibit dumping of members of a scope or body of a function merely
4002 because that scope has been reached.  Only dump such items when they
4003 are directly reachable by some other path.  When dumping pretty-printed
4004 trees, this option inhibits dumping the bodies of control structures.
4005 @item raw
4006 Print a raw representation of the tree.  By default, trees are
4007 pretty-printed into a C-like representation.
4008 @item details
4009 Enable more detailed dumps (not honored by every dump option).
4010 @item stats
4011 Enable dumping various statistics about the pass (not honored by every dump
4012 option).
4013 @item blocks
4014 Enable showing basic block boundaries (disabled in raw dumps).
4015 @item vops
4016 Enable showing virtual operands for every statement.
4017 @item lineno
4018 Enable showing line numbers for statements.
4019 @item uid
4020 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4021 @item all
4022 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4023 @end table
4025 The following tree dumps are possible:
4026 @table @samp
4028 @item original
4029 Dump before any tree based optimization, to @file{@var{file}.original}.
4031 @item optimized
4032 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4034 @item inlined
4035 Dump after function inlining, to @file{@var{file}.inlined}.
4037 @item gimple
4038 @opindex fdump-tree-gimple
4039 Dump each function before and after the gimplification pass to a file.  The
4040 file name is made by appending @file{.gimple} to the source file name.
4042 @item cfg
4043 @opindex fdump-tree-cfg
4044 Dump the control flow graph of each function to a file.  The file name is
4045 made by appending @file{.cfg} to the source file name.
4047 @item vcg
4048 @opindex fdump-tree-vcg
4049 Dump the control flow graph of each function to a file in VCG format.  The
4050 file name is made by appending @file{.vcg} to the source file name.  Note
4051 that if the file contains more than one function, the generated file cannot
4052 be used directly by VCG@.  You will need to cut and paste each function's
4053 graph into its own separate file first.
4055 @item ch
4056 @opindex fdump-tree-ch
4057 Dump each function after copying loop headers.  The file name is made by
4058 appending @file{.ch} to the source file name.
4060 @item ssa
4061 @opindex fdump-tree-ssa
4062 Dump SSA related information to a file.  The file name is made by appending
4063 @file{.ssa} to the source file name.
4065 @item salias
4066 @opindex fdump-tree-salias
4067 Dump structure aliasing variable information to a file.  This file name
4068 is made by appending @file{.salias} to the source file name.
4070 @item alias
4071 @opindex fdump-tree-alias
4072 Dump aliasing information for each function.  The file name is made by
4073 appending @file{.alias} to the source file name.
4075 @item ccp
4076 @opindex fdump-tree-ccp
4077 Dump each function after CCP@.  The file name is made by appending
4078 @file{.ccp} to the source file name.
4080 @item storeccp
4081 @opindex fdump-tree-storeccp
4082 Dump each function after STORE-CCP.  The file name is made by appending
4083 @file{.storeccp} to the source file name.
4085 @item pre
4086 @opindex fdump-tree-pre
4087 Dump trees after partial redundancy elimination.  The file name is made
4088 by appending @file{.pre} to the source file name.
4090 @item fre
4091 @opindex fdump-tree-fre
4092 Dump trees after full redundancy elimination.  The file name is made
4093 by appending @file{.fre} to the source file name.
4095 @item copyprop
4096 @opindex fdump-tree-copyprop
4097 Dump trees after copy propagation.  The file name is made
4098 by appending @file{.copyprop} to the source file name.
4100 @item store_copyprop
4101 @opindex fdump-tree-store_copyprop
4102 Dump trees after store copy-propagation.  The file name is made
4103 by appending @file{.store_copyprop} to the source file name.
4105 @item dce
4106 @opindex fdump-tree-dce
4107 Dump each function after dead code elimination.  The file name is made by
4108 appending @file{.dce} to the source file name.
4110 @item mudflap
4111 @opindex fdump-tree-mudflap
4112 Dump each function after adding mudflap instrumentation.  The file name is
4113 made by appending @file{.mudflap} to the source file name.
4115 @item sra
4116 @opindex fdump-tree-sra
4117 Dump each function after performing scalar replacement of aggregates.  The
4118 file name is made by appending @file{.sra} to the source file name.
4120 @item sink
4121 @opindex fdump-tree-sink
4122 Dump each function after performing code sinking.  The file name is made
4123 by appending @file{.sink} to the source file name. 
4125 @item dom
4126 @opindex fdump-tree-dom
4127 Dump each function after applying dominator tree optimizations.  The file
4128 name is made by appending @file{.dom} to the source file name.
4130 @item dse
4131 @opindex fdump-tree-dse
4132 Dump each function after applying dead store elimination.  The file
4133 name is made by appending @file{.dse} to the source file name.
4135 @item phiopt
4136 @opindex fdump-tree-phiopt
4137 Dump each function after optimizing PHI nodes into straightline code.  The file
4138 name is made by appending @file{.phiopt} to the source file name.
4140 @item forwprop
4141 @opindex fdump-tree-forwprop
4142 Dump each function after forward propagating single use variables.  The file
4143 name is made by appending @file{.forwprop} to the source file name.
4145 @item copyrename
4146 @opindex fdump-tree-copyrename
4147 Dump each function after applying the copy rename optimization.  The file
4148 name is made by appending @file{.copyrename} to the source file name.
4150 @item nrv
4151 @opindex fdump-tree-nrv
4152 Dump each function after applying the named return value optimization on
4153 generic trees.  The file name is made by appending @file{.nrv} to the source
4154 file name.
4156 @item vect
4157 @opindex fdump-tree-vect
4158 Dump each function after applying vectorization of loops.  The file name is
4159 made by appending @file{.vect} to the source file name.
4161 @item vrp
4162 @opindex fdump-tree-vrp
4163 Dump each function after Value Range Propagation (VRP).  The file name
4164 is made by appending @file{.vrp} to the source file name.
4166 @item all
4167 @opindex fdump-tree-all
4168 Enable all the available tree dumps with the flags provided in this option.
4169 @end table
4171 @item -ftree-vectorizer-verbose=@var{n}
4172 @opindex ftree-vectorizer-verbose
4173 This option controls the amount of debugging output the vectorizer prints.
4174 This information is written to standard error, unless @option{-fdump-tree-all}
4175 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4176 usual dump listing file, @file{.vect}.
4178 @item -frandom-seed=@var{string}
4179 @opindex frandom-string
4180 This option provides a seed that GCC uses when it would otherwise use
4181 random numbers.  It is used to generate certain symbol names
4182 that have to be different in every compiled file.  It is also used to
4183 place unique stamps in coverage data files and the object files that
4184 produce them.  You can use the @option{-frandom-seed} option to produce
4185 reproducibly identical object files.
4187 The @var{string} should be different for every file you compile.
4189 @item -fsched-verbose=@var{n}
4190 @opindex fsched-verbose
4191 On targets that use instruction scheduling, this option controls the
4192 amount of debugging output the scheduler prints.  This information is
4193 written to standard error, unless @option{-dS} or @option{-dR} is
4194 specified, in which case it is output to the usual dump
4195 listing file, @file{.sched} or @file{.sched2} respectively.  However
4196 for @var{n} greater than nine, the output is always printed to standard
4197 error.
4199 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4200 same information as @option{-dRS}.  For @var{n} greater than one, it
4201 also output basic block probabilities, detailed ready list information
4202 and unit/insn info.  For @var{n} greater than two, it includes RTL
4203 at abort point, control-flow and regions info.  And for @var{n} over
4204 four, @option{-fsched-verbose} also includes dependence info.
4206 @item -save-temps
4207 @opindex save-temps
4208 Store the usual ``temporary'' intermediate files permanently; place them
4209 in the current directory and name them based on the source file.  Thus,
4210 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4211 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4212 preprocessed @file{foo.i} output file even though the compiler now
4213 normally uses an integrated preprocessor.
4215 When used in combination with the @option{-x} command line option,
4216 @option{-save-temps} is sensible enough to avoid over writing an
4217 input source file with the same extension as an intermediate file.
4218 The corresponding intermediate file may be obtained by renaming the
4219 source file before using @option{-save-temps}.
4221 @item -time
4222 @opindex time
4223 Report the CPU time taken by each subprocess in the compilation
4224 sequence.  For C source files, this is the compiler proper and assembler
4225 (plus the linker if linking is done).  The output looks like this:
4227 @smallexample
4228 # cc1 0.12 0.01
4229 # as 0.00 0.01
4230 @end smallexample
4232 The first number on each line is the ``user time'', that is time spent
4233 executing the program itself.  The second number is ``system time'',
4234 time spent executing operating system routines on behalf of the program.
4235 Both numbers are in seconds.
4237 @item -fvar-tracking
4238 @opindex fvar-tracking
4239 Run variable tracking pass.  It computes where variables are stored at each
4240 position in code.  Better debugging information is then generated
4241 (if the debugging information format supports this information).
4243 It is enabled by default when compiling with optimization (@option{-Os},
4244 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4245 the debug info format supports it.
4247 @item -print-file-name=@var{library}
4248 @opindex print-file-name
4249 Print the full absolute name of the library file @var{library} that
4250 would be used when linking---and don't do anything else.  With this
4251 option, GCC does not compile or link anything; it just prints the
4252 file name.
4254 @item -print-multi-directory
4255 @opindex print-multi-directory
4256 Print the directory name corresponding to the multilib selected by any
4257 other switches present in the command line.  This directory is supposed
4258 to exist in @env{GCC_EXEC_PREFIX}.
4260 @item -print-multi-lib
4261 @opindex print-multi-lib
4262 Print the mapping from multilib directory names to compiler switches
4263 that enable them.  The directory name is separated from the switches by
4264 @samp{;}, and each switch starts with an @samp{@@} instead of the
4265 @samp{-}, without spaces between multiple switches.  This is supposed to
4266 ease shell-processing.
4268 @item -print-prog-name=@var{program}
4269 @opindex print-prog-name
4270 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4272 @item -print-libgcc-file-name
4273 @opindex print-libgcc-file-name
4274 Same as @option{-print-file-name=libgcc.a}.
4276 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4277 but you do want to link with @file{libgcc.a}.  You can do
4279 @smallexample
4280 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4281 @end smallexample
4283 @item -print-search-dirs
4284 @opindex print-search-dirs
4285 Print the name of the configured installation directory and a list of
4286 program and library directories @command{gcc} will search---and don't do anything else.
4288 This is useful when @command{gcc} prints the error message
4289 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4290 To resolve this you either need to put @file{cpp0} and the other compiler
4291 components where @command{gcc} expects to find them, or you can set the environment
4292 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4293 Don't forget the trailing @samp{/}.
4294 @xref{Environment Variables}.
4296 @item -dumpmachine
4297 @opindex dumpmachine
4298 Print the compiler's target machine (for example,
4299 @samp{i686-pc-linux-gnu})---and don't do anything else.
4301 @item -dumpversion
4302 @opindex dumpversion
4303 Print the compiler version (for example, @samp{3.0})---and don't do
4304 anything else.
4306 @item -dumpspecs
4307 @opindex dumpspecs
4308 Print the compiler's built-in specs---and don't do anything else.  (This
4309 is used when GCC itself is being built.)  @xref{Spec Files}.
4311 @item -feliminate-unused-debug-types
4312 @opindex feliminate-unused-debug-types
4313 Normally, when producing DWARF2 output, GCC will emit debugging
4314 information for all types declared in a compilation
4315 unit, regardless of whether or not they are actually used
4316 in that compilation unit.  Sometimes this is useful, such as
4317 if, in the debugger, you want to cast a value to a type that is
4318 not actually used in your program (but is declared).  More often,
4319 however, this results in a significant amount of wasted space.
4320 With this option, GCC will avoid producing debug symbol output
4321 for types that are nowhere used in the source file being compiled.
4322 @end table
4324 @node Optimize Options
4325 @section Options That Control Optimization
4326 @cindex optimize options
4327 @cindex options, optimization
4329 These options control various sorts of optimizations.
4331 Without any optimization option, the compiler's goal is to reduce the
4332 cost of compilation and to make debugging produce the expected
4333 results.  Statements are independent: if you stop the program with a
4334 breakpoint between statements, you can then assign a new value to any
4335 variable or change the program counter to any other statement in the
4336 function and get exactly the results you would expect from the source
4337 code.
4339 Turning on optimization flags makes the compiler attempt to improve
4340 the performance and/or code size at the expense of compilation time
4341 and possibly the ability to debug the program.
4343 The compiler performs optimization based on the knowledge it has of
4344 the program.  Optimization levels @option{-O2} and above, in
4345 particular, enable @emph{unit-at-a-time} mode, which allows the
4346 compiler to consider information gained from later functions in
4347 the file when compiling a function.  Compiling multiple files at
4348 once to a single output file in @emph{unit-at-a-time} mode allows
4349 the compiler to use information gained from all of the files when
4350 compiling each of them.
4352 Not all optimizations are controlled directly by a flag.  Only
4353 optimizations that have a flag are listed.
4355 @table @gcctabopt
4356 @item -O
4357 @itemx -O1
4358 @opindex O
4359 @opindex O1
4360 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4361 more memory for a large function.
4363 With @option{-O}, the compiler tries to reduce code size and execution
4364 time, without performing any optimizations that take a great deal of
4365 compilation time.
4367 @option{-O} turns on the following optimization flags:
4368 @gccoptlist{-fdefer-pop @gol
4369 -fdelayed-branch @gol
4370 -fguess-branch-probability @gol
4371 -fcprop-registers @gol
4372 -floop-optimize @gol
4373 -fif-conversion @gol
4374 -fif-conversion2 @gol
4375 -ftree-ccp @gol
4376 -ftree-dce @gol
4377 -ftree-dominator-opts @gol
4378 -ftree-dse @gol
4379 -ftree-ter @gol
4380 -ftree-lrs @gol
4381 -ftree-sra @gol
4382 -ftree-copyrename @gol
4383 -ftree-fre @gol
4384 -ftree-ch @gol
4385 -fmerge-constants}
4387 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4388 where doing so does not interfere with debugging.
4390 @item -O2
4391 @opindex O2
4392 Optimize even more.  GCC performs nearly all supported optimizations
4393 that do not involve a space-speed tradeoff.  The compiler does not
4394 perform loop unrolling or function inlining when you specify @option{-O2}.
4395 As compared to @option{-O}, this option increases both compilation time
4396 and the performance of the generated code.
4398 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4399 also turns on the following optimization flags:
4400 @gccoptlist{-fthread-jumps @gol
4401 -fcrossjumping @gol
4402 -foptimize-sibling-calls @gol
4403 -fcse-follow-jumps  -fcse-skip-blocks @gol
4404 -fgcse  -fgcse-lm  @gol
4405 -fexpensive-optimizations @gol
4406 -fstrength-reduce @gol
4407 -frerun-cse-after-loop  -frerun-loop-opt @gol
4408 -fcaller-saves @gol
4409 -fpeephole2 @gol
4410 -fschedule-insns  -fschedule-insns2 @gol
4411 -fsched-interblock  -fsched-spec @gol
4412 -fregmove @gol
4413 -fstrict-aliasing @gol
4414 -fdelete-null-pointer-checks @gol
4415 -freorder-blocks  -freorder-functions @gol
4416 -funit-at-a-time @gol
4417 -falign-functions  -falign-jumps @gol
4418 -falign-loops  -falign-labels @gol
4419 -ftree-vrp @gol
4420 -ftree-pre}
4422 Please note the warning under @option{-fgcse} about
4423 invoking @option{-O2} on programs that use computed gotos.
4425 @item -O3
4426 @opindex O3
4427 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4428 @option{-O2} and also turns on the @option{-finline-functions},
4429 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4431 @item -O0
4432 @opindex O0
4433 Do not optimize.  This is the default.
4435 @item -Os
4436 @opindex Os
4437 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4438 do not typically increase code size.  It also performs further
4439 optimizations designed to reduce code size.
4441 @option{-Os} disables the following optimization flags:
4442 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4443 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4444 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4446 If you use multiple @option{-O} options, with or without level numbers,
4447 the last such option is the one that is effective.
4448 @end table
4450 Options of the form @option{-f@var{flag}} specify machine-independent
4451 flags.  Most flags have both positive and negative forms; the negative
4452 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4453 below, only one of the forms is listed---the one you typically will
4454 use.  You can figure out the other form by either removing @samp{no-}
4455 or adding it.
4457 The following options control specific optimizations.  They are either
4458 activated by @option{-O} options or are related to ones that are.  You
4459 can use the following flags in the rare cases when ``fine-tuning'' of
4460 optimizations to be performed is desired.
4462 @table @gcctabopt
4463 @item -fno-default-inline
4464 @opindex fno-default-inline
4465 Do not make member functions inline by default merely because they are
4466 defined inside the class scope (C++ only).  Otherwise, when you specify
4467 @w{@option{-O}}, member functions defined inside class scope are compiled
4468 inline by default; i.e., you don't need to add @samp{inline} in front of
4469 the member function name.
4471 @item -fno-defer-pop
4472 @opindex fno-defer-pop
4473 Always pop the arguments to each function call as soon as that function
4474 returns.  For machines which must pop arguments after a function call,
4475 the compiler normally lets arguments accumulate on the stack for several
4476 function calls and pops them all at once.
4478 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4480 @item -fforce-mem
4481 @opindex fforce-mem
4482 Force memory operands to be copied into registers before doing
4483 arithmetic on them.  This produces better code by making all memory
4484 references potential common subexpressions.  When they are not common
4485 subexpressions, instruction combination should eliminate the separate
4486 register-load. This option is now a nop and will be removed in 4.2.
4488 @item -fforce-addr
4489 @opindex fforce-addr
4490 Force memory address constants to be copied into registers before
4491 doing arithmetic on them.
4493 @item -fomit-frame-pointer
4494 @opindex fomit-frame-pointer
4495 Don't keep the frame pointer in a register for functions that
4496 don't need one.  This avoids the instructions to save, set up and
4497 restore frame pointers; it also makes an extra register available
4498 in many functions.  @strong{It also makes debugging impossible on
4499 some machines.}
4501 On some machines, such as the VAX, this flag has no effect, because
4502 the standard calling sequence automatically handles the frame pointer
4503 and nothing is saved by pretending it doesn't exist.  The
4504 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4505 whether a target machine supports this flag.  @xref{Registers,,Register
4506 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4508 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4510 @item -foptimize-sibling-calls
4511 @opindex foptimize-sibling-calls
4512 Optimize sibling and tail recursive calls.
4514 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4516 @item -fno-inline
4517 @opindex fno-inline
4518 Don't pay attention to the @code{inline} keyword.  Normally this option
4519 is used to keep the compiler from expanding any functions inline.
4520 Note that if you are not optimizing, no functions can be expanded inline.
4522 @item -finline-functions
4523 @opindex finline-functions
4524 Integrate all simple functions into their callers.  The compiler
4525 heuristically decides which functions are simple enough to be worth
4526 integrating in this way.
4528 If all calls to a given function are integrated, and the function is
4529 declared @code{static}, then the function is normally not output as
4530 assembler code in its own right.
4532 Enabled at level @option{-O3}.
4534 @item -finline-functions-called-once
4535 @opindex finline-functions-called-once
4536 Consider all @code{static} functions called once for inlining into their
4537 caller even if they are not marked @code{inline}.  If a call to a given
4538 function is integrated, then the function is not output as assembler code
4539 in its own right.
4541 Enabled if @option{-funit-at-a-time} is enabled.
4543 @item -fearly-inlining
4544 @opindex fearly-inlining
4545 Inline functions marked by @code{always_inline} and functions whose body seems
4546 smaller than the function call overhead early before doing
4547 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4548 makes profiling significantly cheaper and usually inlining faster on programs
4549 having large chains of nested wrapper functions.
4551 Enabled by default.
4553 @item -finline-limit=@var{n}
4554 @opindex finline-limit
4555 By default, GCC limits the size of functions that can be inlined.  This flag
4556 allows the control of this limit for functions that are explicitly marked as
4557 inline (i.e., marked with the inline keyword or defined within the class
4558 definition in c++).  @var{n} is the size of functions that can be inlined in
4559 number of pseudo instructions (not counting parameter handling).  The default
4560 value of @var{n} is 600.
4561 Increasing this value can result in more inlined code at
4562 the cost of compilation time and memory consumption.  Decreasing usually makes
4563 the compilation faster and less code will be inlined (which presumably
4564 means slower programs).  This option is particularly useful for programs that
4565 use inlining heavily such as those based on recursive templates with C++.
4567 Inlining is actually controlled by a number of parameters, which may be
4568 specified individually by using @option{--param @var{name}=@var{value}}.
4569 The @option{-finline-limit=@var{n}} option sets some of these parameters
4570 as follows:
4572 @table @gcctabopt
4573  @item max-inline-insns-single
4574   is set to @var{n}/2.
4575  @item max-inline-insns-auto
4576   is set to @var{n}/2.
4577  @item min-inline-insns
4578   is set to 130 or @var{n}/4, whichever is smaller.
4579  @item max-inline-insns-rtl
4580   is set to @var{n}.
4581 @end table
4583 See below for a documentation of the individual
4584 parameters controlling inlining.
4586 @emph{Note:} pseudo instruction represents, in this particular context, an
4587 abstract measurement of function's size.  In no way does it represent a count
4588 of assembly instructions and as such its exact meaning might change from one
4589 release to an another.
4591 @item -fkeep-inline-functions
4592 @opindex fkeep-inline-functions
4593 In C, emit @code{static} functions that are declared @code{inline}
4594 into the object file, even if the function has been inlined into all
4595 of its callers.  This switch does not affect functions using the
4596 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4597 inline functions into the object file.
4599 @item -fkeep-static-consts
4600 @opindex fkeep-static-consts
4601 Emit variables declared @code{static const} when optimization isn't turned
4602 on, even if the variables aren't referenced.
4604 GCC enables this option by default.  If you want to force the compiler to
4605 check if the variable was referenced, regardless of whether or not
4606 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4608 @item -fmerge-constants
4609 Attempt to merge identical constants (string constants and floating point
4610 constants) across compilation units.
4612 This option is the default for optimized compilation if the assembler and
4613 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4614 behavior.
4616 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4618 @item -fmerge-all-constants
4619 Attempt to merge identical constants and identical variables.
4621 This option implies @option{-fmerge-constants}.  In addition to
4622 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4623 arrays or initialized constant variables with integral or floating point
4624 types.  Languages like C or C++ require each non-automatic variable to
4625 have distinct location, so using this option will result in non-conforming
4626 behavior.
4628 @item -fmodulo-sched
4629 @opindex fmodulo-sched
4630 Perform swing modulo scheduling immediately before the first scheduling
4631 pass.  This pass looks at innermost loops and reorders their
4632 instructions by overlapping different iterations.
4634 @item -fno-branch-count-reg
4635 @opindex fno-branch-count-reg
4636 Do not use ``decrement and branch'' instructions on a count register,
4637 but instead generate a sequence of instructions that decrement a
4638 register, compare it against zero, then branch based upon the result.
4639 This option is only meaningful on architectures that support such
4640 instructions, which include x86, PowerPC, IA-64 and S/390.
4642 The default is @option{-fbranch-count-reg}, enabled when
4643 @option{-fstrength-reduce} is enabled.
4645 @item -fno-function-cse
4646 @opindex fno-function-cse
4647 Do not put function addresses in registers; make each instruction that
4648 calls a constant function contain the function's address explicitly.
4650 This option results in less efficient code, but some strange hacks
4651 that alter the assembler output may be confused by the optimizations
4652 performed when this option is not used.
4654 The default is @option{-ffunction-cse}
4656 @item -fno-zero-initialized-in-bss
4657 @opindex fno-zero-initialized-in-bss
4658 If the target supports a BSS section, GCC by default puts variables that
4659 are initialized to zero into BSS@.  This can save space in the resulting
4660 code.
4662 This option turns off this behavior because some programs explicitly
4663 rely on variables going to the data section.  E.g., so that the
4664 resulting executable can find the beginning of that section and/or make
4665 assumptions based on that.
4667 The default is @option{-fzero-initialized-in-bss}.
4669 @item -fbounds-check
4670 @opindex fbounds-check
4671 For front-ends that support it, generate additional code to check that
4672 indices used to access arrays are within the declared range.  This is
4673 currently only supported by the Java and Fortran front-ends, where
4674 this option defaults to true and false respectively.
4676 @item -fmudflap -fmudflapth -fmudflapir
4677 @opindex fmudflap
4678 @opindex fmudflapth
4679 @opindex fmudflapir
4680 @cindex bounds checking
4681 @cindex mudflap
4682 For front-ends that support it (C and C++), instrument all risky
4683 pointer/array dereferencing operations, some standard library
4684 string/heap functions, and some other associated constructs with
4685 range/validity tests.  Modules so instrumented should be immune to
4686 buffer overflows, invalid heap use, and some other classes of C/C++
4687 programming errors.  The instrumentation relies on a separate runtime
4688 library (@file{libmudflap}), which will be linked into a program if
4689 @option{-fmudflap} is given at link time.  Run-time behavior of the
4690 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4691 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4692 for its options.
4694 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4695 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4696 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4697 instrumentation should ignore pointer reads.  This produces less
4698 instrumentation (and therefore faster execution) and still provides
4699 some protection against outright memory corrupting writes, but allows
4700 erroneously read data to propagate within a program.
4702 @item -fstrength-reduce
4703 @opindex fstrength-reduce
4704 Perform the optimizations of loop strength reduction and
4705 elimination of iteration variables.
4707 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4709 @item -fthread-jumps
4710 @opindex fthread-jumps
4711 Perform optimizations where we check to see if a jump branches to a
4712 location where another comparison subsumed by the first is found.  If
4713 so, the first branch is redirected to either the destination of the
4714 second branch or a point immediately following it, depending on whether
4715 the condition is known to be true or false.
4717 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4719 @item -fcse-follow-jumps
4720 @opindex fcse-follow-jumps
4721 In common subexpression elimination, scan through jump instructions
4722 when the target of the jump is not reached by any other path.  For
4723 example, when CSE encounters an @code{if} statement with an
4724 @code{else} clause, CSE will follow the jump when the condition
4725 tested is false.
4727 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4729 @item -fcse-skip-blocks
4730 @opindex fcse-skip-blocks
4731 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4732 follow jumps which conditionally skip over blocks.  When CSE
4733 encounters a simple @code{if} statement with no else clause,
4734 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4735 body of the @code{if}.
4737 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4739 @item -frerun-cse-after-loop
4740 @opindex frerun-cse-after-loop
4741 Re-run common subexpression elimination after loop optimizations has been
4742 performed.
4744 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4746 @item -frerun-loop-opt
4747 @opindex frerun-loop-opt
4748 Run the loop optimizer twice.
4750 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4752 @item -fgcse
4753 @opindex fgcse
4754 Perform a global common subexpression elimination pass.
4755 This pass also performs global constant and copy propagation.
4757 @emph{Note:} When compiling a program using computed gotos, a GCC
4758 extension, you may get better runtime performance if you disable
4759 the global common subexpression elimination pass by adding
4760 @option{-fno-gcse} to the command line.
4762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4764 @item -fgcse-lm
4765 @opindex fgcse-lm
4766 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4767 attempt to move loads which are only killed by stores into themselves.  This
4768 allows a loop containing a load/store sequence to be changed to a load outside
4769 the loop, and a copy/store within the loop.
4771 Enabled by default when gcse is enabled.
4773 @item -fgcse-sm
4774 @opindex fgcse-sm
4775 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4776 global common subexpression elimination.  This pass will attempt to move
4777 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4778 loops containing a load/store sequence can be changed to a load before
4779 the loop and a store after the loop.
4781 Not enabled at any optimization level.
4783 @item -fgcse-las
4784 @opindex fgcse-las
4785 When @option{-fgcse-las} is enabled, the global common subexpression
4786 elimination pass eliminates redundant loads that come after stores to the
4787 same memory location (both partial and full redundancies).
4789 Not enabled at any optimization level.
4791 @item -fgcse-after-reload
4792 @opindex fgcse-after-reload
4793 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4794 pass is performed after reload.  The purpose of this pass is to cleanup
4795 redundant spilling.
4797 @item -floop-optimize
4798 @opindex floop-optimize
4799 Perform loop optimizations: move constant expressions out of loops, simplify
4800 exit test conditions and optionally do strength-reduction as well.
4802 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4804 @item -floop-optimize2
4805 @opindex floop-optimize2
4806 Perform loop optimizations using the new loop optimizer.  The optimizations
4807 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4808 by separate flags.
4810 @item -funsafe-loop-optimizations
4811 @opindex funsafe-loop-optimizations
4812 If given, the loop optimizer will assume that loop indices do not
4813 overflow, and that the loops with nontrivial exit condition are not
4814 infinite.  This enables a wider range of loop optimizations even if
4815 the loop optimizer itself cannot prove that these assumptions are valid.
4816 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4817 if it finds this kind of loop.
4819 @item -fcrossjumping
4820 @opindex crossjumping
4821 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4822 resulting code may or may not perform better than without cross-jumping.
4824 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4826 @item -fif-conversion
4827 @opindex if-conversion
4828 Attempt to transform conditional jumps into branch-less equivalents.  This
4829 include use of conditional moves, min, max, set flags and abs instructions, and
4830 some tricks doable by standard arithmetics.  The use of conditional execution
4831 on chips where it is available is controlled by @code{if-conversion2}.
4833 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4835 @item -fif-conversion2
4836 @opindex if-conversion2
4837 Use conditional execution (where available) to transform conditional jumps into
4838 branch-less equivalents.
4840 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4842 @item -fdelete-null-pointer-checks
4843 @opindex fdelete-null-pointer-checks
4844 Use global dataflow analysis to identify and eliminate useless checks
4845 for null pointers.  The compiler assumes that dereferencing a null
4846 pointer would have halted the program.  If a pointer is checked after
4847 it has already been dereferenced, it cannot be null.
4849 In some environments, this assumption is not true, and programs can
4850 safely dereference null pointers.  Use
4851 @option{-fno-delete-null-pointer-checks} to disable this optimization
4852 for programs which depend on that behavior.
4854 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4856 @item -fexpensive-optimizations
4857 @opindex fexpensive-optimizations
4858 Perform a number of minor optimizations that are relatively expensive.
4860 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4862 @item -foptimize-register-move
4863 @itemx -fregmove
4864 @opindex foptimize-register-move
4865 @opindex fregmove
4866 Attempt to reassign register numbers in move instructions and as
4867 operands of other simple instructions in order to maximize the amount of
4868 register tying.  This is especially helpful on machines with two-operand
4869 instructions.
4871 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4872 optimization.
4874 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4876 @item -fdelayed-branch
4877 @opindex fdelayed-branch
4878 If supported for the target machine, attempt to reorder instructions
4879 to exploit instruction slots available after delayed branch
4880 instructions.
4882 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4884 @item -fschedule-insns
4885 @opindex fschedule-insns
4886 If supported for the target machine, attempt to reorder instructions to
4887 eliminate execution stalls due to required data being unavailable.  This
4888 helps machines that have slow floating point or memory load instructions
4889 by allowing other instructions to be issued until the result of the load
4890 or floating point instruction is required.
4892 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4894 @item -fschedule-insns2
4895 @opindex fschedule-insns2
4896 Similar to @option{-fschedule-insns}, but requests an additional pass of
4897 instruction scheduling after register allocation has been done.  This is
4898 especially useful on machines with a relatively small number of
4899 registers and where memory load instructions take more than one cycle.
4901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4903 @item -fno-sched-interblock
4904 @opindex fno-sched-interblock
4905 Don't schedule instructions across basic blocks.  This is normally
4906 enabled by default when scheduling before register allocation, i.e.@:
4907 with @option{-fschedule-insns} or at @option{-O2} or higher.
4909 @item -fno-sched-spec
4910 @opindex fno-sched-spec
4911 Don't allow speculative motion of non-load instructions.  This is normally
4912 enabled by default when scheduling before register allocation, i.e.@:
4913 with @option{-fschedule-insns} or at @option{-O2} or higher.
4915 @item -fsched-spec-load
4916 @opindex fsched-spec-load
4917 Allow speculative motion of some load instructions.  This only makes
4918 sense when scheduling before register allocation, i.e.@: with
4919 @option{-fschedule-insns} or at @option{-O2} or higher.
4921 @item -fsched-spec-load-dangerous
4922 @opindex fsched-spec-load-dangerous
4923 Allow speculative motion of more load instructions.  This only makes
4924 sense when scheduling before register allocation, i.e.@: with
4925 @option{-fschedule-insns} or at @option{-O2} or higher.
4927 @item -fsched-stalled-insns=@var{n}
4928 @opindex fsched-stalled-insns
4929 Define how many insns (if any) can be moved prematurely from the queue
4930 of stalled insns into the ready list, during the second scheduling pass.
4932 @item -fsched-stalled-insns-dep=@var{n}
4933 @opindex fsched-stalled-insns-dep
4934 Define how many insn groups (cycles) will be examined for a dependency
4935 on a stalled insn that is candidate for premature removal from the queue
4936 of stalled insns.  Has an effect only during the second scheduling pass,
4937 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4939 @item -fsched2-use-superblocks
4940 @opindex fsched2-use-superblocks
4941 When scheduling after register allocation, do use superblock scheduling
4942 algorithm.  Superblock scheduling allows motion across basic block boundaries
4943 resulting on faster schedules.  This option is experimental, as not all machine
4944 descriptions used by GCC model the CPU closely enough to avoid unreliable
4945 results from the algorithm.
4947 This only makes sense when scheduling after register allocation, i.e.@: with
4948 @option{-fschedule-insns2} or at @option{-O2} or higher.
4950 @item -fsched2-use-traces
4951 @opindex fsched2-use-traces
4952 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4953 allocation and additionally perform code duplication in order to increase the
4954 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4955 trace formation.
4957 This mode should produce faster but significantly longer programs.  Also
4958 without @option{-fbranch-probabilities} the traces constructed may not
4959 match the reality and hurt the performance.  This only makes
4960 sense when scheduling after register allocation, i.e.@: with
4961 @option{-fschedule-insns2} or at @option{-O2} or higher.
4963 @item -freschedule-modulo-scheduled-loops
4964 @opindex fscheduling-in-modulo-scheduled-loops
4965 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4966 we may want to prevent the later scheduling passes from changing its schedule, we use this
4967 option to control that.
4969 @item -fcaller-saves
4970 @opindex fcaller-saves
4971 Enable values to be allocated in registers that will be clobbered by
4972 function calls, by emitting extra instructions to save and restore the
4973 registers around such calls.  Such allocation is done only when it
4974 seems to result in better code than would otherwise be produced.
4976 This option is always enabled by default on certain machines, usually
4977 those which have no call-preserved registers to use instead.
4979 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4981 @item -ftree-pre
4982 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4983 enabled by default at @option{-O2} and @option{-O3}.
4985 @item -ftree-fre
4986 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4987 between FRE and PRE is that FRE only considers expressions
4988 that are computed on all paths leading to the redundant computation.
4989 This analysis faster than PRE, though it exposes fewer redundancies.
4990 This flag is enabled by default at @option{-O} and higher.
4992 @item -ftree-copy-prop
4993 Perform copy propagation on trees.  This pass eliminates unnecessary
4994 copy operations.  This flag is enabled by default at @option{-O} and
4995 higher.
4997 @item -ftree-store-copy-prop
4998 Perform copy propagation of memory loads and stores.  This pass
4999 eliminates unnecessary copy operations in memory references
5000 (structures, global variables, arrays, etc).  This flag is enabled by
5001 default at @option{-O2} and higher.
5003 @item -ftree-salias
5004 Perform structural alias analysis on trees.  This flag
5005 is enabled by default at @option{-O} and higher.
5007 @item -ftree-sink
5008 Perform forward store motion  on trees.  This flag is
5009 enabled by default at @option{-O} and higher.
5011 @item -ftree-ccp
5012 Perform sparse conditional constant propagation (CCP) on trees.  This
5013 pass only operates on local scalar variables and is enabled by default
5014 at @option{-O} and higher.
5016 @item -ftree-store-ccp
5017 Perform sparse conditional constant propagation (CCP) on trees.  This
5018 pass operates on both local scalar variables and memory stores and
5019 loads (global variables, structures, arrays, etc).  This flag is
5020 enabled by default at @option{-O2} and higher.
5022 @item -ftree-dce
5023 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5024 default at @option{-O} and higher.
5026 @item -ftree-dominator-opts
5027 Perform a variety of simple scalar cleanups (constant/copy
5028 propagation, redundancy elimination, range propagation and expression
5029 simplification) based on a dominator tree traversal.  This also
5030 performs jump threading (to reduce jumps to jumps). This flag is
5031 enabled by default at @option{-O} and higher.
5033 @item -ftree-ch
5034 Perform loop header copying on trees.  This is beneficial since it increases
5035 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5036 is enabled by default at @option{-O} and higher.  It is not enabled
5037 for @option{-Os}, since it usually increases code size.
5039 @item -ftree-loop-optimize
5040 Perform loop optimizations on trees.  This flag is enabled by default
5041 at @option{-O} and higher.
5043 @item -ftree-loop-linear
5044 Perform linear loop transformations on tree.  This flag can improve cache
5045 performance and allow further loop optimizations to take place.
5047 @item -ftree-loop-im
5048 Perform loop invariant motion on trees.  This pass moves only invariants that
5049 would be hard to handle at RTL level (function calls, operations that expand to
5050 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5051 operands of conditions that are invariant out of the loop, so that we can use
5052 just trivial invariantness analysis in loop unswitching.  The pass also includes
5053 store motion.
5055 @item -ftree-loop-ivcanon
5056 Create a canonical counter for number of iterations in the loop for that
5057 determining number of iterations requires complicated analysis.  Later
5058 optimizations then may determine the number easily.  Useful especially
5059 in connection with unrolling.
5061 @item -fivopts
5062 Perform induction variable optimizations (strength reduction, induction
5063 variable merging and induction variable elimination) on trees.
5065 @item -ftree-sra
5066 Perform scalar replacement of aggregates.  This pass replaces structure
5067 references with scalars to prevent committing structures to memory too
5068 early.  This flag is enabled by default at @option{-O} and higher.
5070 @item -ftree-copyrename
5071 Perform copy renaming on trees.  This pass attempts to rename compiler
5072 temporaries to other variables at copy locations, usually resulting in
5073 variable names which more closely resemble the original variables.  This flag
5074 is enabled by default at @option{-O} and higher.
5076 @item -ftree-ter
5077 Perform temporary expression replacement during the SSA->normal phase.  Single
5078 use/single def temporaries are replaced at their use location with their
5079 defining expression.  This results in non-GIMPLE code, but gives the expanders
5080 much more complex trees to work on resulting in better RTL generation.  This is
5081 enabled by default at @option{-O} and higher.
5083 @item -ftree-lrs
5084 Perform live range splitting during the SSA->normal phase.  Distinct live
5085 ranges of a variable are split into unique variables, allowing for better
5086 optimization later.  This is enabled by default at @option{-O} and higher.
5088 @item -ftree-vectorize
5089 Perform loop vectorization on trees.
5091 @item -ftree-vect-loop-version
5092 @opindex ftree-vect-loop-version
5093 Perform loop versioning when doing loop vectorization on trees.  When a loop
5094 appears to be vectorizable except that data alignment or data dependence cannot
5095 be determined at compile time then vectorized and non-vectorized versions of
5096 the loop are generated along with runtime checks for alignment or dependence
5097 to control which version is executed.  This option is enabled by default
5098 except at level @option{-Os} where it is disabled.
5100 @item -ftree-vrp
5101 Perform Value Range Propagation on trees.  This is similar to the
5102 constant propagation pass, but instead of values, ranges of values are
5103 propagated.  This allows the optimizers to remove unnecessary range
5104 checks like array bound checks and null pointer checks.  This is
5105 enabled by default at @option{-O2} and higher.  Null pointer check
5106 elimination is only done if @option{-fdelete-null-pointer-checks} is
5107 enabled.
5109 @item -ftracer
5110 @opindex ftracer
5111 Perform tail duplication to enlarge superblock size.  This transformation
5112 simplifies the control flow of the function allowing other optimizations to do
5113 better job.
5115 @item -funroll-loops
5116 @opindex funroll-loops
5117 Unroll loops whose number of iterations can be determined at compile
5118 time or upon entry to the loop.  @option{-funroll-loops} implies both
5119 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5120 option makes code larger, and may or may not make it run faster.
5122 @item -funroll-all-loops
5123 @opindex funroll-all-loops
5124 Unroll all loops, even if their number of iterations is uncertain when
5125 the loop is entered.  This usually makes programs run more slowly.
5126 @option{-funroll-all-loops} implies the same options as
5127 @option{-funroll-loops},
5129 @item -fsplit-ivs-in-unroller
5130 @opindex -fsplit-ivs-in-unroller
5131 Enables expressing of values of induction variables in later iterations
5132 of the unrolled loop using the value in the first iteration.  This breaks
5133 long dependency chains, thus improving efficiency of the scheduling passes.
5135 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5136 same effect.  However in cases the loop body is more complicated than
5137 a single basic block, this is not reliable.  It also does not work at all
5138 on some of the architectures due to restrictions in the CSE pass.
5140 This optimization is enabled by default.
5142 @item -fvariable-expansion-in-unroller
5143 @opindex -fvariable-expansion-in-unroller
5144 With this option, the compiler will create multiple copies of some
5145 local variables when unrolling a loop which can result in superior code.
5147 @item -fprefetch-loop-arrays
5148 @opindex fprefetch-loop-arrays
5149 If supported by the target machine, generate instructions to prefetch
5150 memory to improve the performance of loops that access large arrays.
5152 These options may generate better or worse code; results are highly
5153 dependent on the structure of loops within the source code.
5155 @item -fno-peephole
5156 @itemx -fno-peephole2
5157 @opindex fno-peephole
5158 @opindex fno-peephole2
5159 Disable any machine-specific peephole optimizations.  The difference
5160 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5161 are implemented in the compiler; some targets use one, some use the
5162 other, a few use both.
5164 @option{-fpeephole} is enabled by default.
5165 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5167 @item -fno-guess-branch-probability
5168 @opindex fno-guess-branch-probability
5169 Do not guess branch probabilities using heuristics.
5171 GCC will use heuristics to guess branch probabilities if they are
5172 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5173 heuristics are based on the control flow graph.  If some branch probabilities
5174 are specified by @samp{__builtin_expect}, then the heuristics will be
5175 used to guess branch probabilities for the rest of the control flow graph,
5176 taking the @samp{__builtin_expect} info into account.  The interactions
5177 between the heuristics and @samp{__builtin_expect} can be complex, and in
5178 some cases, it may be useful to disable the heuristics so that the effects
5179 of @samp{__builtin_expect} are easier to understand.
5181 The default is @option{-fguess-branch-probability} at levels
5182 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5184 @item -freorder-blocks
5185 @opindex freorder-blocks
5186 Reorder basic blocks in the compiled function in order to reduce number of
5187 taken branches and improve code locality.
5189 Enabled at levels @option{-O2}, @option{-O3}.
5191 @item -freorder-blocks-and-partition
5192 @opindex freorder-blocks-and-partition
5193 In addition to reordering basic blocks in the compiled function, in order
5194 to reduce number of taken branches, partitions hot and cold basic blocks
5195 into separate sections of the assembly and .o files, to improve
5196 paging and cache locality performance.
5198 This optimization is automatically turned off in the presence of
5199 exception handling, for linkonce sections, for functions with a user-defined
5200 section attribute and on any architecture that does not support named
5201 sections.
5203 @item -freorder-functions
5204 @opindex freorder-functions
5205 Reorder functions in the object file in order to
5206 improve code locality.  This is implemented by using special
5207 subsections @code{.text.hot} for most frequently executed functions and
5208 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5209 the linker so object file format must support named sections and linker must
5210 place them in a reasonable way.
5212 Also profile feedback must be available in to make this option effective.  See
5213 @option{-fprofile-arcs} for details.
5215 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5217 @item -fstrict-aliasing
5218 @opindex fstrict-aliasing
5219 Allows the compiler to assume the strictest aliasing rules applicable to
5220 the language being compiled.  For C (and C++), this activates
5221 optimizations based on the type of expressions.  In particular, an
5222 object of one type is assumed never to reside at the same address as an
5223 object of a different type, unless the types are almost the same.  For
5224 example, an @code{unsigned int} can alias an @code{int}, but not a
5225 @code{void*} or a @code{double}.  A character type may alias any other
5226 type.
5228 Pay special attention to code like this:
5229 @smallexample
5230 union a_union @{
5231   int i;
5232   double d;
5235 int f() @{
5236   a_union t;
5237   t.d = 3.0;
5238   return t.i;
5240 @end smallexample
5241 The practice of reading from a different union member than the one most
5242 recently written to (called ``type-punning'') is common.  Even with
5243 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5244 is accessed through the union type.  So, the code above will work as
5245 expected.  However, this code might not:
5246 @smallexample
5247 int f() @{
5248   a_union t;
5249   int* ip;
5250   t.d = 3.0;
5251   ip = &t.i;
5252   return *ip;
5254 @end smallexample
5256 Every language that wishes to perform language-specific alias analysis
5257 should define a function that computes, given an @code{tree}
5258 node, an alias set for the node.  Nodes in different alias sets are not
5259 allowed to alias.  For an example, see the C front-end function
5260 @code{c_get_alias_set}.
5262 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5264 @item -falign-functions
5265 @itemx -falign-functions=@var{n}
5266 @opindex falign-functions
5267 Align the start of functions to the next power-of-two greater than
5268 @var{n}, skipping up to @var{n} bytes.  For instance,
5269 @option{-falign-functions=32} aligns functions to the next 32-byte
5270 boundary, but @option{-falign-functions=24} would align to the next
5271 32-byte boundary only if this can be done by skipping 23 bytes or less.
5273 @option{-fno-align-functions} and @option{-falign-functions=1} are
5274 equivalent and mean that functions will not be aligned.
5276 Some assemblers only support this flag when @var{n} is a power of two;
5277 in that case, it is rounded up.
5279 If @var{n} is not specified or is zero, use a machine-dependent default.
5281 Enabled at levels @option{-O2}, @option{-O3}.
5283 @item -falign-labels
5284 @itemx -falign-labels=@var{n}
5285 @opindex falign-labels
5286 Align all branch targets to a power-of-two boundary, skipping up to
5287 @var{n} bytes like @option{-falign-functions}.  This option can easily
5288 make code slower, because it must insert dummy operations for when the
5289 branch target is reached in the usual flow of the code.
5291 @option{-fno-align-labels} and @option{-falign-labels=1} are
5292 equivalent and mean that labels will not be aligned.
5294 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5295 are greater than this value, then their values are used instead.
5297 If @var{n} is not specified or is zero, use a machine-dependent default
5298 which is very likely to be @samp{1}, meaning no alignment.
5300 Enabled at levels @option{-O2}, @option{-O3}.
5302 @item -falign-loops
5303 @itemx -falign-loops=@var{n}
5304 @opindex falign-loops
5305 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5306 like @option{-falign-functions}.  The hope is that the loop will be
5307 executed many times, which will make up for any execution of the dummy
5308 operations.
5310 @option{-fno-align-loops} and @option{-falign-loops=1} are
5311 equivalent and mean that loops will not be aligned.
5313 If @var{n} is not specified or is zero, use a machine-dependent default.
5315 Enabled at levels @option{-O2}, @option{-O3}.
5317 @item -falign-jumps
5318 @itemx -falign-jumps=@var{n}
5319 @opindex falign-jumps
5320 Align branch targets to a power-of-two boundary, for branch targets
5321 where the targets can only be reached by jumping, skipping up to @var{n}
5322 bytes like @option{-falign-functions}.  In this case, no dummy operations
5323 need be executed.
5325 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5326 equivalent and mean that loops will not be aligned.
5328 If @var{n} is not specified or is zero, use a machine-dependent default.
5330 Enabled at levels @option{-O2}, @option{-O3}.
5332 @item -funit-at-a-time
5333 @opindex funit-at-a-time
5334 Parse the whole compilation unit before starting to produce code.
5335 This allows some extra optimizations to take place but consumes
5336 more memory (in general).  There are some compatibility issues
5337 with @emph{unit-at-at-time} mode:
5338 @itemize @bullet
5339 @item
5340 enabling @emph{unit-at-a-time} mode may change the order
5341 in which functions, variables, and top-level @code{asm} statements
5342 are emitted, and will likely break code relying on some particular
5343 ordering.  The majority of such top-level @code{asm} statements,
5344 though, can be replaced by @code{section} attributes.
5346 @item
5347 @emph{unit-at-a-time} mode removes unreferenced static variables
5348 and functions.  This may result in undefined references
5349 when an @code{asm} statement refers directly to variables or functions
5350 that are otherwise unused.  In that case either the variable/function
5351 shall be listed as an operand of the @code{asm} statement operand or,
5352 in the case of top-level @code{asm} statements the attribute @code{used}
5353 shall be used on the declaration.
5355 @item
5356 Static functions now can use non-standard passing conventions that
5357 may break @code{asm} statements calling functions directly.  Again,
5358 attribute @code{used} will prevent this behavior.
5359 @end itemize
5361 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5362 but this scheme may not be supported by future releases of GCC@.
5364 Enabled at levels @option{-O2}, @option{-O3}.
5366 @item -fweb
5367 @opindex fweb
5368 Constructs webs as commonly used for register allocation purposes and assign
5369 each web individual pseudo register.  This allows the register allocation pass
5370 to operate on pseudos directly, but also strengthens several other optimization
5371 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5372 however, make debugging impossible, since variables will no longer stay in a
5373 ``home register''.
5375 Enabled by default with @option{-funroll-loops}.
5377 @item -fwhole-program
5378 @opindex fwhole-program
5379 Assume that the current compilation unit represents whole program being
5380 compiled.  All public functions and variables with the exception of @code{main}
5381 and those merged by attribute @code{externally_visible} become static functions
5382 and in a affect gets more aggressively optimized by interprocedural optimizers.
5383 While this option is equivalent to proper use of @code{static} keyword for
5384 programs consisting of single file, in combination with option
5385 @option{--combine} this flag can be used to compile most of smaller scale C
5386 programs since the functions and variables become local for the whole combined
5387 compilation unit, not for the single source file itself.
5390 @item -fno-cprop-registers
5391 @opindex fno-cprop-registers
5392 After register allocation and post-register allocation instruction splitting,
5393 we perform a copy-propagation pass to try to reduce scheduling dependencies
5394 and occasionally eliminate the copy.
5396 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5398 @item -fprofile-generate
5399 @opindex fprofile-generate
5401 Enable options usually used for instrumenting application to produce
5402 profile useful for later recompilation with profile feedback based
5403 optimization.  You must use @option{-fprofile-generate} both when
5404 compiling and when linking your program.
5406 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5408 @item -fprofile-use
5409 @opindex fprofile-use
5410 Enable profile feedback directed optimizations, and optimizations
5411 generally profitable only with profile feedback available.
5413 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5414 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5415 @code{-fno-loop-optimize}.
5417 @end table
5419 The following options control compiler behavior regarding floating
5420 point arithmetic.  These options trade off between speed and
5421 correctness.  All must be specifically enabled.
5423 @table @gcctabopt
5424 @item -ffloat-store
5425 @opindex ffloat-store
5426 Do not store floating point variables in registers, and inhibit other
5427 options that might change whether a floating point value is taken from a
5428 register or memory.
5430 @cindex floating point precision
5431 This option prevents undesirable excess precision on machines such as
5432 the 68000 where the floating registers (of the 68881) keep more
5433 precision than a @code{double} is supposed to have.  Similarly for the
5434 x86 architecture.  For most programs, the excess precision does only
5435 good, but a few programs rely on the precise definition of IEEE floating
5436 point.  Use @option{-ffloat-store} for such programs, after modifying
5437 them to store all pertinent intermediate computations into variables.
5439 @item -ffast-math
5440 @opindex ffast-math
5441 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5442 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5443 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5444 and @option{fcx-limited-range}.
5446 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5448 This option should never be turned on by any @option{-O} option since
5449 it can result in incorrect output for programs which depend on
5450 an exact implementation of IEEE or ISO rules/specifications for
5451 math functions.
5453 @item -fno-math-errno
5454 @opindex fno-math-errno
5455 Do not set ERRNO after calling math functions that are executed
5456 with a single instruction, e.g., sqrt.  A program that relies on
5457 IEEE exceptions for math error handling may want to use this flag
5458 for speed while maintaining IEEE arithmetic compatibility.
5460 This option should never be turned on by any @option{-O} option since
5461 it can result in incorrect output for programs which depend on
5462 an exact implementation of IEEE or ISO rules/specifications for
5463 math functions.
5465 The default is @option{-fmath-errno}.
5467 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5468 no reason for the compiler to consider the possibility that it might,
5469 and @option{-fno-math-errno} is the default.
5471 @item -funsafe-math-optimizations
5472 @opindex funsafe-math-optimizations
5473 Allow optimizations for floating-point arithmetic that (a) assume
5474 that arguments and results are valid and (b) may violate IEEE or
5475 ANSI standards.  When used at link-time, it may include libraries
5476 or startup files that change the default FPU control word or other
5477 similar optimizations.
5479 This option should never be turned on by any @option{-O} option since
5480 it can result in incorrect output for programs which depend on
5481 an exact implementation of IEEE or ISO rules/specifications for
5482 math functions.
5484 The default is @option{-fno-unsafe-math-optimizations}.
5486 @item -ffinite-math-only
5487 @opindex ffinite-math-only
5488 Allow optimizations for floating-point arithmetic that assume
5489 that arguments and results are not NaNs or +-Infs.
5491 This option should never be turned on by any @option{-O} option since
5492 it can result in incorrect output for programs which depend on
5493 an exact implementation of IEEE or ISO rules/specifications.
5495 The default is @option{-fno-finite-math-only}.
5497 @item -fno-trapping-math
5498 @opindex fno-trapping-math
5499 Compile code assuming that floating-point operations cannot generate
5500 user-visible traps.  These traps include division by zero, overflow,
5501 underflow, inexact result and invalid operation.  This option implies
5502 @option{-fno-signaling-nans}.  Setting this option may allow faster
5503 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5505 This option should never be turned on by any @option{-O} option since
5506 it can result in incorrect output for programs which depend on
5507 an exact implementation of IEEE or ISO rules/specifications for
5508 math functions.
5510 The default is @option{-ftrapping-math}.
5512 @item -frounding-math
5513 @opindex frounding-math
5514 Disable transformations and optimizations that assume default floating
5515 point rounding behavior.  This is round-to-zero for all floating point
5516 to integer conversions, and round-to-nearest for all other arithmetic
5517 truncations.  This option should be specified for programs that change
5518 the FP rounding mode dynamically, or that may be executed with a
5519 non-default rounding mode.  This option disables constant folding of
5520 floating point expressions at compile-time (which may be affected by
5521 rounding mode) and arithmetic transformations that are unsafe in the
5522 presence of sign-dependent rounding modes.
5524 The default is @option{-fno-rounding-math}.
5526 This option is experimental and does not currently guarantee to
5527 disable all GCC optimizations that are affected by rounding mode.
5528 Future versions of GCC may provide finer control of this setting
5529 using C99's @code{FENV_ACCESS} pragma.  This command line option
5530 will be used to specify the default state for @code{FENV_ACCESS}.
5532 @item -fsignaling-nans
5533 @opindex fsignaling-nans
5534 Compile code assuming that IEEE signaling NaNs may generate user-visible
5535 traps during floating-point operations.  Setting this option disables
5536 optimizations that may change the number of exceptions visible with
5537 signaling NaNs.  This option implies @option{-ftrapping-math}.
5539 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5540 be defined.
5542 The default is @option{-fno-signaling-nans}.
5544 This option is experimental and does not currently guarantee to
5545 disable all GCC optimizations that affect signaling NaN behavior.
5547 @item -fsingle-precision-constant
5548 @opindex fsingle-precision-constant
5549 Treat floating point constant as single precision constant instead of
5550 implicitly converting it to double precision constant.
5552 @item -fcx-limited-range
5553 @itemx -fno-cx-limited-range
5554 @opindex fcx-limited-range
5555 @opindex fno-cx-limited-range
5556 When enabled, this option states that a range reduction step is not
5557 needed when performing complex division.  The default is
5558 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5560 This option controls the default setting of the ISO C99 
5561 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5562 all languages.
5564 @end table
5566 The following options control optimizations that may improve
5567 performance, but are not enabled by any @option{-O} options.  This
5568 section includes experimental options that may produce broken code.
5570 @table @gcctabopt
5571 @item -fbranch-probabilities
5572 @opindex fbranch-probabilities
5573 After running a program compiled with @option{-fprofile-arcs}
5574 (@pxref{Debugging Options,, Options for Debugging Your Program or
5575 @command{gcc}}), you can compile it a second time using
5576 @option{-fbranch-probabilities}, to improve optimizations based on
5577 the number of times each branch was taken.  When the program
5578 compiled with @option{-fprofile-arcs} exits it saves arc execution
5579 counts to a file called @file{@var{sourcename}.gcda} for each source
5580 file  The information in this data file is very dependent on the
5581 structure of the generated code, so you must use the same source code
5582 and the same optimization options for both compilations.
5584 With @option{-fbranch-probabilities}, GCC puts a
5585 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5586 These can be used to improve optimization.  Currently, they are only
5587 used in one place: in @file{reorg.c}, instead of guessing which path a
5588 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5589 exactly determine which path is taken more often.
5591 @item -fprofile-values
5592 @opindex fprofile-values
5593 If combined with @option{-fprofile-arcs}, it adds code so that some
5594 data about values of expressions in the program is gathered.
5596 With @option{-fbranch-probabilities}, it reads back the data gathered
5597 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5598 notes to instructions for their later usage in optimizations.
5600 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5602 @item -fvpt
5603 @opindex fvpt
5604 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5605 a code to gather information about values of expressions.
5607 With @option{-fbranch-probabilities}, it reads back the data gathered
5608 and actually performs the optimizations based on them.
5609 Currently the optimizations include specialization of division operation
5610 using the knowledge about the value of the denominator.
5612 @item -frename-registers
5613 @opindex frename-registers
5614 Attempt to avoid false dependencies in scheduled code by making use
5615 of registers left over after register allocation.  This optimization
5616 will most benefit processors with lots of registers.  Depending on the
5617 debug information format adopted by the target, however, it can
5618 make debugging impossible, since variables will no longer stay in
5619 a ``home register''.
5621 Enabled by default with @option{-funroll-loops}.
5623 @item -ftracer
5624 @opindex ftracer
5625 Perform tail duplication to enlarge superblock size.  This transformation
5626 simplifies the control flow of the function allowing other optimizations to do
5627 better job.
5629 Enabled with @option{-fprofile-use}.
5631 @item -funroll-loops
5632 @opindex funroll-loops
5633 Unroll loops whose number of iterations can be determined at compile time or
5634 upon entry to the loop.  @option{-funroll-loops} implies
5635 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5636 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5637 small constant number of iterations).  This option makes code larger, and may
5638 or may not make it run faster.
5640 Enabled with @option{-fprofile-use}.
5642 @item -funroll-all-loops
5643 @opindex funroll-all-loops
5644 Unroll all loops, even if their number of iterations is uncertain when
5645 the loop is entered.  This usually makes programs run more slowly.
5646 @option{-funroll-all-loops} implies the same options as
5647 @option{-funroll-loops}.
5649 @item -fpeel-loops
5650 @opindex fpeel-loops
5651 Peels the loops for that there is enough information that they do not
5652 roll much (from profile feedback).  It also turns on complete loop peeling
5653 (i.e.@: complete removal of loops with small constant number of iterations).
5655 Enabled with @option{-fprofile-use}.
5657 @item -fmove-loop-invariants
5658 @opindex fmove-loop-invariants
5659 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5660 at level @option{-O1}
5662 @item -funswitch-loops
5663 @opindex funswitch-loops
5664 Move branches with loop invariant conditions out of the loop, with duplicates
5665 of the loop on both branches (modified according to result of the condition).
5667 @item -fprefetch-loop-arrays
5668 @opindex fprefetch-loop-arrays
5669 If supported by the target machine, generate instructions to prefetch
5670 memory to improve the performance of loops that access large arrays.
5672 Disabled at level @option{-Os}.
5674 @item -ffunction-sections
5675 @itemx -fdata-sections
5676 @opindex ffunction-sections
5677 @opindex fdata-sections
5678 Place each function or data item into its own section in the output
5679 file if the target supports arbitrary sections.  The name of the
5680 function or the name of the data item determines the section's name
5681 in the output file.
5683 Use these options on systems where the linker can perform optimizations
5684 to improve locality of reference in the instruction space.  Most systems
5685 using the ELF object format and SPARC processors running Solaris 2 have
5686 linkers with such optimizations.  AIX may have these optimizations in
5687 the future.
5689 Only use these options when there are significant benefits from doing
5690 so.  When you specify these options, the assembler and linker will
5691 create larger object and executable files and will also be slower.
5692 You will not be able to use @code{gprof} on all systems if you
5693 specify this option and you may have problems with debugging if
5694 you specify both this option and @option{-g}.
5696 @item -fbranch-target-load-optimize
5697 @opindex fbranch-target-load-optimize
5698 Perform branch target register load optimization before prologue / epilogue
5699 threading.
5700 The use of target registers can typically be exposed only during reload,
5701 thus hoisting loads out of loops and doing inter-block scheduling needs
5702 a separate optimization pass.
5704 @item -fbranch-target-load-optimize2
5705 @opindex fbranch-target-load-optimize2
5706 Perform branch target register load optimization after prologue / epilogue
5707 threading.
5709 @item -fbtr-bb-exclusive
5710 @opindex fbtr-bb-exclusive
5711 When performing branch target register load optimization, don't reuse
5712 branch target registers in within any basic block.
5714 @item -fstack-protector
5715 Emit extra code to check for buffer overflows, such as stack smashing
5716 attacks.  This is done by adding a guard variable to functions with
5717 vulnerable objects.  This includes functions that call alloca, and
5718 functions with buffers larger than 8 bytes.  The guards are initialized
5719 when a function is entered and then checked when the function exits.
5720 If a guard check fails, an error message is printed and the program exits.
5722 @item -fstack-protector-all
5723 Like @option{-fstack-protector} except that all functions are protected.
5725 @item --param @var{name}=@var{value}
5726 @opindex param
5727 In some places, GCC uses various constants to control the amount of
5728 optimization that is done.  For example, GCC will not inline functions
5729 that contain more that a certain number of instructions.  You can
5730 control some of these constants on the command-line using the
5731 @option{--param} option.
5733 The names of specific parameters, and the meaning of the values, are
5734 tied to the internals of the compiler, and are subject to change
5735 without notice in future releases.
5737 In each case, the @var{value} is an integer.  The allowable choices for
5738 @var{name} are given in the following table:
5740 @table @gcctabopt
5741 @item salias-max-implicit-fields
5742 The maximum number of fields in a variable without direct
5743 structure accesses for which structure aliasing will consider trying 
5744 to track each field.  The default is 5
5746 @item sra-max-structure-size
5747 The maximum structure size, in bytes, at which the scalar replacement
5748 of aggregates (SRA) optimization will perform block copies.  The
5749 default value, 0, implies that GCC will select the most appropriate
5750 size itself.
5752 @item sra-field-structure-ratio
5753 The threshold ratio (as a percentage) between instantiated fields and
5754 the complete structure size.  We say that if the ratio of the number
5755 of bytes in instantiated fields to the number of bytes in the complete
5756 structure exceeds this parameter, then block copies are not used.  The
5757 default is 75.
5759 @item max-crossjump-edges
5760 The maximum number of incoming edges to consider for crossjumping.
5761 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5762 the number of edges incoming to each block.  Increasing values mean
5763 more aggressive optimization, making the compile time increase with
5764 probably small improvement in executable size.
5766 @item min-crossjump-insns
5767 The minimum number of instructions which must be matched at the end
5768 of two blocks before crossjumping will be performed on them.  This
5769 value is ignored in the case where all instructions in the block being
5770 crossjumped from are matched.  The default value is 5.
5772 @item max-grow-copy-bb-insns
5773 The maximum code size expansion factor when copying basic blocks
5774 instead of jumping.  The expansion is relative to a jump instruction.
5775 The default value is 8.
5777 @item max-goto-duplication-insns
5778 The maximum number of instructions to duplicate to a block that jumps
5779 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5780 passes, GCC factors computed gotos early in the compilation process,
5781 and unfactors them as late as possible.  Only computed jumps at the
5782 end of a basic blocks with no more than max-goto-duplication-insns are
5783 unfactored.  The default value is 8.
5785 @item max-delay-slot-insn-search
5786 The maximum number of instructions to consider when looking for an
5787 instruction to fill a delay slot.  If more than this arbitrary number of
5788 instructions is searched, the time savings from filling the delay slot
5789 will be minimal so stop searching.  Increasing values mean more
5790 aggressive optimization, making the compile time increase with probably
5791 small improvement in executable run time.
5793 @item max-delay-slot-live-search
5794 When trying to fill delay slots, the maximum number of instructions to
5795 consider when searching for a block with valid live register
5796 information.  Increasing this arbitrarily chosen value means more
5797 aggressive optimization, increasing the compile time.  This parameter
5798 should be removed when the delay slot code is rewritten to maintain the
5799 control-flow graph.
5801 @item max-gcse-memory
5802 The approximate maximum amount of memory that will be allocated in
5803 order to perform the global common subexpression elimination
5804 optimization.  If more memory than specified is required, the
5805 optimization will not be done.
5807 @item max-gcse-passes
5808 The maximum number of passes of GCSE to run.  The default is 1.
5810 @item max-pending-list-length
5811 The maximum number of pending dependencies scheduling will allow
5812 before flushing the current state and starting over.  Large functions
5813 with few branches or calls can create excessively large lists which
5814 needlessly consume memory and resources.
5816 @item max-inline-insns-single
5817 Several parameters control the tree inliner used in gcc.
5818 This number sets the maximum number of instructions (counted in GCC's
5819 internal representation) in a single function that the tree inliner
5820 will consider for inlining.  This only affects functions declared
5821 inline and methods implemented in a class declaration (C++).
5822 The default value is 450.
5824 @item max-inline-insns-auto
5825 When you use @option{-finline-functions} (included in @option{-O3}),
5826 a lot of functions that would otherwise not be considered for inlining
5827 by the compiler will be investigated.  To those functions, a different
5828 (more restrictive) limit compared to functions declared inline can
5829 be applied.
5830 The default value is 90.
5832 @item large-function-insns
5833 The limit specifying really large functions.  For functions larger than this
5834 limit after inlining inlining is constrained by
5835 @option{--param large-function-growth}.  This parameter is useful primarily
5836 to avoid extreme compilation time caused by non-linear algorithms used by the
5837 backend.
5838 This parameter is ignored when @option{-funit-at-a-time} is not used.
5839 The default value is 2700.
5841 @item large-function-growth
5842 Specifies maximal growth of large function caused by inlining in percents.
5843 This parameter is ignored when @option{-funit-at-a-time} is not used.
5844 The default value is 100 which limits large function growth to 2.0 times
5845 the original size.
5847 @item large-unit-insns
5848 The limit specifying large translation unit.  Growth caused by inlining of
5849 units larger than this limit is limited by @option{--param inline-unit-growth}.
5850 For small units this might be too tight (consider unit consisting of function A
5851 that is inline and B that just calls A three time.  If B is small relative to
5852 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5853 large units consisting of small inlininable functions however the overall unit
5854 growth limit is needed to avoid exponential explosion of code size.  Thus for
5855 smaller units, the size is increased to @option{--param large-unit-insns}
5856 before applying @option{--param inline-unit-growth}.  The default is 10000
5858 @item inline-unit-growth
5859 Specifies maximal overall growth of the compilation unit caused by inlining.
5860 This parameter is ignored when @option{-funit-at-a-time} is not used.
5861 The default value is 50 which limits unit growth to 1.5 times the original
5862 size.
5864 @item max-inline-insns-recursive
5865 @itemx max-inline-insns-recursive-auto
5866 Specifies maximum number of instructions out-of-line copy of self recursive inline
5867 function can grow into by performing recursive inlining.
5869 For functions declared inline @option{--param max-inline-insns-recursive} is
5870 taken into acount.  For function not declared inline, recursive inlining
5871 happens only when @option{-finline-functions} (included in @option{-O3}) is
5872 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5873 default value is 450.
5875 @item max-inline-recursive-depth
5876 @itemx max-inline-recursive-depth-auto
5877 Specifies maximum recursion depth used by the recursive inlining.
5879 For functions declared inline @option{--param max-inline-recursive-depth} is
5880 taken into acount.  For function not declared inline, recursive inlining
5881 happens only when @option{-finline-functions} (included in @option{-O3}) is
5882 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5883 default value is 450.
5885 @item min-inline-recursive-probability
5886 Recursive inlining is profitable only for function having deep recursion
5887 in average and can hurt for function having little recursion depth by
5888 increasing the prologue size or complexity of function body to other
5889 optimizers.
5891 When profile feedback is available (see @option{-fprofile-generate}) the actual
5892 recursion depth can be guessed from probability that function will recurse via
5893 given call expression.  This parameter limits inlining only to call expression
5894 whose probability exceeds given threshold (in percents).  The default value is
5897 @item inline-call-cost
5898 Specify cost of call instruction relative to simple arithmetics operations
5899 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5900 functions and at the same time increases size of leaf function that is believed to
5901 reduce function size by being inlined.  In effect it increases amount of
5902 inlining for code having large abstraction penalty (many functions that just
5903 pass the arguments to other functions) and decrease inlining for code with low
5904 abstraction penalty.  The default value is 16.
5906 @item max-unrolled-insns
5907 The maximum number of instructions that a loop should have if that loop
5908 is unrolled, and if the loop is unrolled, it determines how many times
5909 the loop code is unrolled.
5911 @item max-average-unrolled-insns
5912 The maximum number of instructions biased by probabilities of their execution
5913 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5914 it determines how many times the loop code is unrolled.
5916 @item max-unroll-times
5917 The maximum number of unrollings of a single loop.
5919 @item max-peeled-insns
5920 The maximum number of instructions that a loop should have if that loop
5921 is peeled, and if the loop is peeled, it determines how many times
5922 the loop code is peeled.
5924 @item max-peel-times
5925 The maximum number of peelings of a single loop.
5927 @item max-completely-peeled-insns
5928 The maximum number of insns of a completely peeled loop.
5930 @item max-completely-peel-times
5931 The maximum number of iterations of a loop to be suitable for complete peeling.
5933 @item max-unswitch-insns
5934 The maximum number of insns of an unswitched loop.
5936 @item max-unswitch-level
5937 The maximum number of branches unswitched in a single loop.
5939 @item lim-expensive
5940 The minimum cost of an expensive expression in the loop invariant motion.
5942 @item iv-consider-all-candidates-bound
5943 Bound on number of candidates for induction variables below that
5944 all candidates are considered for each use in induction variable
5945 optimizations.  Only the most relevant candidates are considered
5946 if there are more candidates, to avoid quadratic time complexity.
5948 @item iv-max-considered-uses
5949 The induction variable optimizations give up on loops that contain more
5950 induction variable uses.
5952 @item iv-always-prune-cand-set-bound
5953 If number of candidates in the set is smaller than this value,
5954 we always try to remove unnecessary ivs from the set during its
5955 optimization when a new iv is added to the set.
5957 @item scev-max-expr-size
5958 Bound on size of expressions used in the scalar evolutions analyzer.
5959 Large expressions slow the analyzer.
5961 @item vect-max-version-checks
5962 The maximum number of runtime checks that can be performed when doing
5963 loop versioning in the vectorizer.  See option ftree-vect-loop-version
5964 for more information.
5966 @item max-iterations-to-track
5968 The maximum number of iterations of a loop the brute force algorithm
5969 for analysis of # of iterations of the loop tries to evaluate.
5971 @item hot-bb-count-fraction
5972 Select fraction of the maximal count of repetitions of basic block in program
5973 given basic block needs to have to be considered hot.
5975 @item hot-bb-frequency-fraction
5976 Select fraction of the maximal frequency of executions of basic block in
5977 function given basic block needs to have to be considered hot
5979 @item max-predicted-iterations
5980 The maximum number of loop iterations we predict statically.  This is useful
5981 in cases where function contain single loop with known bound and other loop
5982 with unknown.  We predict the known number of iterations correctly, while
5983 the unknown number of iterations average to roughly 10.  This means that the
5984 loop without bounds would appear artificially cold relative to the other one.
5986 @item tracer-dynamic-coverage
5987 @itemx tracer-dynamic-coverage-feedback
5989 This value is used to limit superblock formation once the given percentage of
5990 executed instructions is covered.  This limits unnecessary code size
5991 expansion.
5993 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5994 feedback is available.  The real profiles (as opposed to statically estimated
5995 ones) are much less balanced allowing the threshold to be larger value.
5997 @item tracer-max-code-growth
5998 Stop tail duplication once code growth has reached given percentage.  This is
5999 rather hokey argument, as most of the duplicates will be eliminated later in
6000 cross jumping, so it may be set to much higher values than is the desired code
6001 growth.
6003 @item tracer-min-branch-ratio
6005 Stop reverse growth when the reverse probability of best edge is less than this
6006 threshold (in percent).
6008 @item tracer-min-branch-ratio
6009 @itemx tracer-min-branch-ratio-feedback
6011 Stop forward growth if the best edge do have probability lower than this
6012 threshold.
6014 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6015 compilation for profile feedback and one for compilation without.  The value
6016 for compilation with profile feedback needs to be more conservative (higher) in
6017 order to make tracer effective.
6019 @item max-cse-path-length
6021 Maximum number of basic blocks on path that cse considers.  The default is 10.
6023 @item max-cse-insns
6024 The maximum instructions CSE process before flushing. The default is 1000.
6026 @item global-var-threshold
6028 Counts the number of function calls (@var{n}) and the number of
6029 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6030 single artificial variable will be created to represent all the
6031 call-clobbered variables at function call sites.  This artificial
6032 variable will then be made to alias every call-clobbered variable.
6033 (done as @code{int * size_t} on the host machine; beware overflow).
6035 @item max-aliased-vops
6037 Maximum number of virtual operands allowed to represent aliases
6038 before triggering the alias grouping heuristic.  Alias grouping
6039 reduces compile times and memory consumption needed for aliasing at
6040 the expense of precision loss in alias information.
6042 @item ggc-min-expand
6044 GCC uses a garbage collector to manage its own memory allocation.  This
6045 parameter specifies the minimum percentage by which the garbage
6046 collector's heap should be allowed to expand between collections.
6047 Tuning this may improve compilation speed; it has no effect on code
6048 generation.
6050 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6051 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6052 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6053 GCC is not able to calculate RAM on a particular platform, the lower
6054 bound of 30% is used.  Setting this parameter and
6055 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6056 every opportunity.  This is extremely slow, but can be useful for
6057 debugging.
6059 @item ggc-min-heapsize
6061 Minimum size of the garbage collector's heap before it begins bothering
6062 to collect garbage.  The first collection occurs after the heap expands
6063 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6064 tuning this may improve compilation speed, and has no effect on code
6065 generation.
6067 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6068 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6069 with a lower bound of 4096 (four megabytes) and an upper bound of
6070 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6071 particular platform, the lower bound is used.  Setting this parameter
6072 very large effectively disables garbage collection.  Setting this
6073 parameter and @option{ggc-min-expand} to zero causes a full collection
6074 to occur at every opportunity.
6076 @item max-reload-search-insns
6077 The maximum number of instruction reload should look backward for equivalent
6078 register.  Increasing values mean more aggressive optimization, making the
6079 compile time increase with probably slightly better performance.  The default
6080 value is 100.
6082 @item max-cselib-memory-location
6083 The maximum number of memory locations cselib should take into acount.
6084 Increasing values mean more aggressive optimization, making the compile time
6085 increase with probably slightly better performance.  The default value is 500.
6087 @item max-flow-memory-location
6088 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6089 The default value is 100.
6091 @item reorder-blocks-duplicate
6092 @itemx reorder-blocks-duplicate-feedback
6094 Used by basic block reordering pass to decide whether to use unconditional
6095 branch or duplicate the code on its destination.  Code is duplicated when its
6096 estimated size is smaller than this value multiplied by the estimated size of
6097 unconditional jump in the hot spots of the program.
6099 The @option{reorder-block-duplicate-feedback} is used only when profile
6100 feedback is available and may be set to higher values than
6101 @option{reorder-block-duplicate} since information about the hot spots is more
6102 accurate.
6104 @item max-sched-region-blocks
6105 The maximum number of blocks in a region to be considered for
6106 interblock scheduling.  The default value is 10.
6108 @item max-sched-region-insns
6109 The maximum number of insns in a region to be considered for
6110 interblock scheduling.  The default value is 100.
6112 @item min-sched-prob
6113 The minimum probability of reaching a source block for interblock
6114 speculative scheduling.  The default value is 40.
6116 @item max-last-value-rtl
6118 The maximum size measured as number of RTLs that can be recorded in an expression
6119 in combiner for a pseudo register as last known value of that register.  The default
6120 is 10000.
6122 @item integer-share-limit
6123 Small integer constants can use a shared data structure, reducing the
6124 compiler's memory usage and increasing its speed.  This sets the maximum
6125 value of a shared integer constant's.  The default value is 256.
6127 @item min-virtual-mappings
6128 Specifies the minimum number of virtual mappings in the incremental
6129 SSA updater that should be registered to trigger the virtual mappings
6130 heuristic defined by virtual-mappings-ratio.  The default value is
6131 100.
6133 @item virtual-mappings-ratio
6134 If the number of virtual mappings is virtual-mappings-ratio bigger
6135 than the number of virtual symbols to be updated, then the incremental
6136 SSA updater switches to a full update for those symbols.  The default
6137 ratio is 3.
6139 @item ssp-buffer-size
6140 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6141 protection when @option{-fstack-protection} is used.
6143 @item max-jump-thread-duplication-stmts
6144 Maximum number of statements allowed in a block that needs to be
6145 duplicated when threading jumps.
6146 @end table
6147 @end table
6149 @node Preprocessor Options
6150 @section Options Controlling the Preprocessor
6151 @cindex preprocessor options
6152 @cindex options, preprocessor
6154 These options control the C preprocessor, which is run on each C source
6155 file before actual compilation.
6157 If you use the @option{-E} option, nothing is done except preprocessing.
6158 Some of these options make sense only together with @option{-E} because
6159 they cause the preprocessor output to be unsuitable for actual
6160 compilation.
6162 @table @gcctabopt
6163 @opindex Wp
6164 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6165 and pass @var{option} directly through to the preprocessor.  If
6166 @var{option} contains commas, it is split into multiple options at the
6167 commas.  However, many options are modified, translated or interpreted
6168 by the compiler driver before being passed to the preprocessor, and
6169 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6170 interface is undocumented and subject to change, so whenever possible
6171 you should avoid using @option{-Wp} and let the driver handle the
6172 options instead.
6174 @item -Xpreprocessor @var{option}
6175 @opindex preprocessor
6176 Pass @var{option} as an option to the preprocessor.  You can use this to
6177 supply system-specific preprocessor options which GCC does not know how to
6178 recognize.
6180 If you want to pass an option that takes an argument, you must use
6181 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6182 @end table
6184 @include cppopts.texi
6186 @node Assembler Options
6187 @section Passing Options to the Assembler
6189 @c prevent bad page break with this line
6190 You can pass options to the assembler.
6192 @table @gcctabopt
6193 @item -Wa,@var{option}
6194 @opindex Wa
6195 Pass @var{option} as an option to the assembler.  If @var{option}
6196 contains commas, it is split into multiple options at the commas.
6198 @item -Xassembler @var{option}
6199 @opindex Xassembler
6200 Pass @var{option} as an option to the assembler.  You can use this to
6201 supply system-specific assembler options which GCC does not know how to
6202 recognize.
6204 If you want to pass an option that takes an argument, you must use
6205 @option{-Xassembler} twice, once for the option and once for the argument.
6207 @end table
6209 @node Link Options
6210 @section Options for Linking
6211 @cindex link options
6212 @cindex options, linking
6214 These options come into play when the compiler links object files into
6215 an executable output file.  They are meaningless if the compiler is
6216 not doing a link step.
6218 @table @gcctabopt
6219 @cindex file names
6220 @item @var{object-file-name}
6221 A file name that does not end in a special recognized suffix is
6222 considered to name an object file or library.  (Object files are
6223 distinguished from libraries by the linker according to the file
6224 contents.)  If linking is done, these object files are used as input
6225 to the linker.
6227 @item -c
6228 @itemx -S
6229 @itemx -E
6230 @opindex c
6231 @opindex S
6232 @opindex E
6233 If any of these options is used, then the linker is not run, and
6234 object file names should not be used as arguments.  @xref{Overall
6235 Options}.
6237 @cindex Libraries
6238 @item -l@var{library}
6239 @itemx -l @var{library}
6240 @opindex l
6241 Search the library named @var{library} when linking.  (The second
6242 alternative with the library as a separate argument is only for
6243 POSIX compliance and is not recommended.)
6245 It makes a difference where in the command you write this option; the
6246 linker searches and processes libraries and object files in the order they
6247 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6248 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6249 to functions in @samp{z}, those functions may not be loaded.
6251 The linker searches a standard list of directories for the library,
6252 which is actually a file named @file{lib@var{library}.a}.  The linker
6253 then uses this file as if it had been specified precisely by name.
6255 The directories searched include several standard system directories
6256 plus any that you specify with @option{-L}.
6258 Normally the files found this way are library files---archive files
6259 whose members are object files.  The linker handles an archive file by
6260 scanning through it for members which define symbols that have so far
6261 been referenced but not defined.  But if the file that is found is an
6262 ordinary object file, it is linked in the usual fashion.  The only
6263 difference between using an @option{-l} option and specifying a file name
6264 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6265 and searches several directories.
6267 @item -lobjc
6268 @opindex lobjc
6269 You need this special case of the @option{-l} option in order to
6270 link an Objective-C or Objective-C++ program.
6272 @item -nostartfiles
6273 @opindex nostartfiles
6274 Do not use the standard system startup files when linking.
6275 The standard system libraries are used normally, unless @option{-nostdlib}
6276 or @option{-nodefaultlibs} is used.
6278 @item -nodefaultlibs
6279 @opindex nodefaultlibs
6280 Do not use the standard system libraries when linking.
6281 Only the libraries you specify will be passed to the linker.
6282 The standard startup files are used normally, unless @option{-nostartfiles}
6283 is used.  The compiler may generate calls to @code{memcmp},
6284 @code{memset}, @code{memcpy} and @code{memmove}.
6285 These entries are usually resolved by entries in
6286 libc.  These entry points should be supplied through some other
6287 mechanism when this option is specified.
6289 @item -nostdlib
6290 @opindex nostdlib
6291 Do not use the standard system startup files or libraries when linking.
6292 No startup files and only the libraries you specify will be passed to
6293 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6294 @code{memcpy} and @code{memmove}.
6295 These entries are usually resolved by entries in
6296 libc.  These entry points should be supplied through some other
6297 mechanism when this option is specified.
6299 @cindex @option{-lgcc}, use with @option{-nostdlib}
6300 @cindex @option{-nostdlib} and unresolved references
6301 @cindex unresolved references and @option{-nostdlib}
6302 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6303 @cindex @option{-nodefaultlibs} and unresolved references
6304 @cindex unresolved references and @option{-nodefaultlibs}
6305 One of the standard libraries bypassed by @option{-nostdlib} and
6306 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6307 that GCC uses to overcome shortcomings of particular machines, or special
6308 needs for some languages.
6309 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6310 Collection (GCC) Internals},
6311 for more discussion of @file{libgcc.a}.)
6312 In most cases, you need @file{libgcc.a} even when you want to avoid
6313 other standard libraries.  In other words, when you specify @option{-nostdlib}
6314 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6315 This ensures that you have no unresolved references to internal GCC
6316 library subroutines.  (For example, @samp{__main}, used to ensure C++
6317 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6318 GNU Compiler Collection (GCC) Internals}.)
6320 @item -pie
6321 @opindex pie
6322 Produce a position independent executable on targets which support it.
6323 For predictable results, you must also specify the same set of options
6324 that were used to generate code (@option{-fpie}, @option{-fPIE},
6325 or model suboptions) when you specify this option.
6327 @item -rdynamic
6328 @opindex rdynamic
6329 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6330 that support it. This instructs the linker to add all symbols, not
6331 only used ones, to the dynamic symbol table. This option is needed
6332 for some uses of @code{dlopen} or to allow obtaining backtraces
6333 from within a program.
6335 @item -s
6336 @opindex s
6337 Remove all symbol table and relocation information from the executable.
6339 @item -static
6340 @opindex static
6341 On systems that support dynamic linking, this prevents linking with the shared
6342 libraries.  On other systems, this option has no effect.
6344 @item -shared
6345 @opindex shared
6346 Produce a shared object which can then be linked with other objects to
6347 form an executable.  Not all systems support this option.  For predictable
6348 results, you must also specify the same set of options that were used to
6349 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6350 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6351 needs to build supplementary stub code for constructors to work.  On
6352 multi-libbed systems, @samp{gcc -shared} must select the correct support
6353 libraries to link against.  Failing to supply the correct flags may lead
6354 to subtle defects.  Supplying them in cases where they are not necessary
6355 is innocuous.}
6357 @item -shared-libgcc
6358 @itemx -static-libgcc
6359 @opindex shared-libgcc
6360 @opindex static-libgcc
6361 On systems that provide @file{libgcc} as a shared library, these options
6362 force the use of either the shared or static version respectively.
6363 If no shared version of @file{libgcc} was built when the compiler was
6364 configured, these options have no effect.
6366 There are several situations in which an application should use the
6367 shared @file{libgcc} instead of the static version.  The most common
6368 of these is when the application wishes to throw and catch exceptions
6369 across different shared libraries.  In that case, each of the libraries
6370 as well as the application itself should use the shared @file{libgcc}.
6372 Therefore, the G++ and GCJ drivers automatically add
6373 @option{-shared-libgcc} whenever you build a shared library or a main
6374 executable, because C++ and Java programs typically use exceptions, so
6375 this is the right thing to do.
6377 If, instead, you use the GCC driver to create shared libraries, you may
6378 find that they will not always be linked with the shared @file{libgcc}.
6379 If GCC finds, at its configuration time, that you have a non-GNU linker
6380 or a GNU linker that does not support option @option{--eh-frame-hdr},
6381 it will link the shared version of @file{libgcc} into shared libraries
6382 by default.  Otherwise, it will take advantage of the linker and optimize
6383 away the linking with the shared version of @file{libgcc}, linking with
6384 the static version of libgcc by default.  This allows exceptions to
6385 propagate through such shared libraries, without incurring relocation
6386 costs at library load time.
6388 However, if a library or main executable is supposed to throw or catch
6389 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6390 for the languages used in the program, or using the option
6391 @option{-shared-libgcc}, such that it is linked with the shared
6392 @file{libgcc}.
6394 @item -symbolic
6395 @opindex symbolic
6396 Bind references to global symbols when building a shared object.  Warn
6397 about any unresolved references (unless overridden by the link editor
6398 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6399 this option.
6401 @item -Xlinker @var{option}
6402 @opindex Xlinker
6403 Pass @var{option} as an option to the linker.  You can use this to
6404 supply system-specific linker options which GCC does not know how to
6405 recognize.
6407 If you want to pass an option that takes an argument, you must use
6408 @option{-Xlinker} twice, once for the option and once for the argument.
6409 For example, to pass @option{-assert definitions}, you must write
6410 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6411 @option{-Xlinker "-assert definitions"}, because this passes the entire
6412 string as a single argument, which is not what the linker expects.
6414 @item -Wl,@var{option}
6415 @opindex Wl
6416 Pass @var{option} as an option to the linker.  If @var{option} contains
6417 commas, it is split into multiple options at the commas.
6419 @item -u @var{symbol}
6420 @opindex u
6421 Pretend the symbol @var{symbol} is undefined, to force linking of
6422 library modules to define it.  You can use @option{-u} multiple times with
6423 different symbols to force loading of additional library modules.
6424 @end table
6426 @node Directory Options
6427 @section Options for Directory Search
6428 @cindex directory options
6429 @cindex options, directory search
6430 @cindex search path
6432 These options specify directories to search for header files, for
6433 libraries and for parts of the compiler:
6435 @table @gcctabopt
6436 @item -I@var{dir}
6437 @opindex I
6438 Add the directory @var{dir} to the head of the list of directories to be
6439 searched for header files.  This can be used to override a system header
6440 file, substituting your own version, since these directories are
6441 searched before the system header file directories.  However, you should
6442 not use this option to add directories that contain vendor-supplied
6443 system header files (use @option{-isystem} for that).  If you use more than
6444 one @option{-I} option, the directories are scanned in left-to-right
6445 order; the standard system directories come after.
6447 If a standard system include directory, or a directory specified with
6448 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6449 option will be ignored.  The directory will still be searched but as a
6450 system directory at its normal position in the system include chain.
6451 This is to ensure that GCC's procedure to fix buggy system headers and
6452 the ordering for the include_next directive are not inadvertently changed.
6453 If you really need to change the search order for system directories,
6454 use the @option{-nostdinc} and/or @option{-isystem} options.
6456 @item -iquote@var{dir}
6457 @opindex iquote
6458 Add the directory @var{dir} to the head of the list of directories to
6459 be searched for header files only for the case of @samp{#include
6460 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6461 otherwise just like @option{-I}.
6463 @item -L@var{dir}
6464 @opindex L
6465 Add directory @var{dir} to the list of directories to be searched
6466 for @option{-l}.
6468 @item -B@var{prefix}
6469 @opindex B
6470 This option specifies where to find the executables, libraries,
6471 include files, and data files of the compiler itself.
6473 The compiler driver program runs one or more of the subprograms
6474 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6475 @var{prefix} as a prefix for each program it tries to run, both with and
6476 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6478 For each subprogram to be run, the compiler driver first tries the
6479 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6480 was not specified, the driver tries two standard prefixes, which are
6481 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6482 those results in a file name that is found, the unmodified program
6483 name is searched for using the directories specified in your
6484 @env{PATH} environment variable.
6486 The compiler will check to see if the path provided by the @option{-B}
6487 refers to a directory, and if necessary it will add a directory
6488 separator character at the end of the path.
6490 @option{-B} prefixes that effectively specify directory names also apply
6491 to libraries in the linker, because the compiler translates these
6492 options into @option{-L} options for the linker.  They also apply to
6493 includes files in the preprocessor, because the compiler translates these
6494 options into @option{-isystem} options for the preprocessor.  In this case,
6495 the compiler appends @samp{include} to the prefix.
6497 The run-time support file @file{libgcc.a} can also be searched for using
6498 the @option{-B} prefix, if needed.  If it is not found there, the two
6499 standard prefixes above are tried, and that is all.  The file is left
6500 out of the link if it is not found by those means.
6502 Another way to specify a prefix much like the @option{-B} prefix is to use
6503 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6504 Variables}.
6506 As a special kludge, if the path provided by @option{-B} is
6507 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6508 9, then it will be replaced by @file{[dir/]include}.  This is to help
6509 with boot-strapping the compiler.
6511 @item -specs=@var{file}
6512 @opindex specs
6513 Process @var{file} after the compiler reads in the standard @file{specs}
6514 file, in order to override the defaults that the @file{gcc} driver
6515 program uses when determining what switches to pass to @file{cc1},
6516 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6517 @option{-specs=@var{file}} can be specified on the command line, and they
6518 are processed in order, from left to right.
6520 @item --sysroot=@var{dir}
6521 @opindex sysroot
6522 Use @var{dir} as the logical root directory for headers and libraries.
6523 For example, if the compiler would normally search for headers in
6524 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6525 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6527 If you use both this option and the @option{-isysroot} option, then
6528 the @option{--sysroot} option will apply to libraries, but the
6529 @option{-isysroot} option will apply to header files.
6531 The GNU linker (beginning with version 2.16) has the necessary support
6532 for this option.  If your linker does not support this option, the
6533 header file aspect of @option{--sysroot} will still work, but the
6534 library aspect will not.
6536 @item -I-
6537 @opindex I-
6538 This option has been deprecated.  Please use @option{-iquote} instead for
6539 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6540 Any directories you specify with @option{-I} options before the @option{-I-}
6541 option are searched only for the case of @samp{#include "@var{file}"};
6542 they are not searched for @samp{#include <@var{file}>}.
6544 If additional directories are specified with @option{-I} options after
6545 the @option{-I-}, these directories are searched for all @samp{#include}
6546 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6547 this way.)
6549 In addition, the @option{-I-} option inhibits the use of the current
6550 directory (where the current input file came from) as the first search
6551 directory for @samp{#include "@var{file}"}.  There is no way to
6552 override this effect of @option{-I-}.  With @option{-I.} you can specify
6553 searching the directory which was current when the compiler was
6554 invoked.  That is not exactly the same as what the preprocessor does
6555 by default, but it is often satisfactory.
6557 @option{-I-} does not inhibit the use of the standard system directories
6558 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6559 independent.
6560 @end table
6562 @c man end
6564 @node Spec Files
6565 @section Specifying subprocesses and the switches to pass to them
6566 @cindex Spec Files
6568 @command{gcc} is a driver program.  It performs its job by invoking a
6569 sequence of other programs to do the work of compiling, assembling and
6570 linking.  GCC interprets its command-line parameters and uses these to
6571 deduce which programs it should invoke, and which command-line options
6572 it ought to place on their command lines.  This behavior is controlled
6573 by @dfn{spec strings}.  In most cases there is one spec string for each
6574 program that GCC can invoke, but a few programs have multiple spec
6575 strings to control their behavior.  The spec strings built into GCC can
6576 be overridden by using the @option{-specs=} command-line switch to specify
6577 a spec file.
6579 @dfn{Spec files} are plaintext files that are used to construct spec
6580 strings.  They consist of a sequence of directives separated by blank
6581 lines.  The type of directive is determined by the first non-whitespace
6582 character on the line and it can be one of the following:
6584 @table @code
6585 @item %@var{command}
6586 Issues a @var{command} to the spec file processor.  The commands that can
6587 appear here are:
6589 @table @code
6590 @item %include <@var{file}>
6591 @cindex %include
6592 Search for @var{file} and insert its text at the current point in the
6593 specs file.
6595 @item %include_noerr <@var{file}>
6596 @cindex %include_noerr
6597 Just like @samp{%include}, but do not generate an error message if the include
6598 file cannot be found.
6600 @item %rename @var{old_name} @var{new_name}
6601 @cindex %rename
6602 Rename the spec string @var{old_name} to @var{new_name}.
6604 @end table
6606 @item *[@var{spec_name}]:
6607 This tells the compiler to create, override or delete the named spec
6608 string.  All lines after this directive up to the next directive or
6609 blank line are considered to be the text for the spec string.  If this
6610 results in an empty string then the spec will be deleted.  (Or, if the
6611 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6612 does not currently exist a new spec will be created.  If the spec does
6613 exist then its contents will be overridden by the text of this
6614 directive, unless the first character of that text is the @samp{+}
6615 character, in which case the text will be appended to the spec.
6617 @item [@var{suffix}]:
6618 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6619 and up to the next directive or blank line are considered to make up the
6620 spec string for the indicated suffix.  When the compiler encounters an
6621 input file with the named suffix, it will processes the spec string in
6622 order to work out how to compile that file.  For example:
6624 @smallexample
6625 .ZZ:
6626 z-compile -input %i
6627 @end smallexample
6629 This says that any input file whose name ends in @samp{.ZZ} should be
6630 passed to the program @samp{z-compile}, which should be invoked with the
6631 command-line switch @option{-input} and with the result of performing the
6632 @samp{%i} substitution.  (See below.)
6634 As an alternative to providing a spec string, the text that follows a
6635 suffix directive can be one of the following:
6637 @table @code
6638 @item @@@var{language}
6639 This says that the suffix is an alias for a known @var{language}.  This is
6640 similar to using the @option{-x} command-line switch to GCC to specify a
6641 language explicitly.  For example:
6643 @smallexample
6644 .ZZ:
6645 @@c++
6646 @end smallexample
6648 Says that .ZZ files are, in fact, C++ source files.
6650 @item #@var{name}
6651 This causes an error messages saying:
6653 @smallexample
6654 @var{name} compiler not installed on this system.
6655 @end smallexample
6656 @end table
6658 GCC already has an extensive list of suffixes built into it.
6659 This directive will add an entry to the end of the list of suffixes, but
6660 since the list is searched from the end backwards, it is effectively
6661 possible to override earlier entries using this technique.
6663 @end table
6665 GCC has the following spec strings built into it.  Spec files can
6666 override these strings or create their own.  Note that individual
6667 targets can also add their own spec strings to this list.
6669 @smallexample
6670 asm          Options to pass to the assembler
6671 asm_final    Options to pass to the assembler post-processor
6672 cpp          Options to pass to the C preprocessor
6673 cc1          Options to pass to the C compiler
6674 cc1plus      Options to pass to the C++ compiler
6675 endfile      Object files to include at the end of the link
6676 link         Options to pass to the linker
6677 lib          Libraries to include on the command line to the linker
6678 libgcc       Decides which GCC support library to pass to the linker
6679 linker       Sets the name of the linker
6680 predefines   Defines to be passed to the C preprocessor
6681 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6682              by default
6683 startfile    Object files to include at the start of the link
6684 @end smallexample
6686 Here is a small example of a spec file:
6688 @smallexample
6689 %rename lib                 old_lib
6691 *lib:
6692 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6693 @end smallexample
6695 This example renames the spec called @samp{lib} to @samp{old_lib} and
6696 then overrides the previous definition of @samp{lib} with a new one.
6697 The new definition adds in some extra command-line options before
6698 including the text of the old definition.
6700 @dfn{Spec strings} are a list of command-line options to be passed to their
6701 corresponding program.  In addition, the spec strings can contain
6702 @samp{%}-prefixed sequences to substitute variable text or to
6703 conditionally insert text into the command line.  Using these constructs
6704 it is possible to generate quite complex command lines.
6706 Here is a table of all defined @samp{%}-sequences for spec
6707 strings.  Note that spaces are not generated automatically around the
6708 results of expanding these sequences.  Therefore you can concatenate them
6709 together or combine them with constant text in a single argument.
6711 @table @code
6712 @item %%
6713 Substitute one @samp{%} into the program name or argument.
6715 @item %i
6716 Substitute the name of the input file being processed.
6718 @item %b
6719 Substitute the basename of the input file being processed.
6720 This is the substring up to (and not including) the last period
6721 and not including the directory.
6723 @item %B
6724 This is the same as @samp{%b}, but include the file suffix (text after
6725 the last period).
6727 @item %d
6728 Marks the argument containing or following the @samp{%d} as a
6729 temporary file name, so that that file will be deleted if GCC exits
6730 successfully.  Unlike @samp{%g}, this contributes no text to the
6731 argument.
6733 @item %g@var{suffix}
6734 Substitute a file name that has suffix @var{suffix} and is chosen
6735 once per compilation, and mark the argument in the same way as
6736 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6737 name is now chosen in a way that is hard to predict even when previously
6738 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6739 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6740 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6741 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6742 was simply substituted with a file name chosen once per compilation,
6743 without regard to any appended suffix (which was therefore treated
6744 just like ordinary text), making such attacks more likely to succeed.
6746 @item %u@var{suffix}
6747 Like @samp{%g}, but generates a new temporary file name even if
6748 @samp{%u@var{suffix}} was already seen.
6750 @item %U@var{suffix}
6751 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6752 new one if there is no such last file name.  In the absence of any
6753 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6754 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6755 would involve the generation of two distinct file names, one
6756 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6757 simply substituted with a file name chosen for the previous @samp{%u},
6758 without regard to any appended suffix.
6760 @item %j@var{suffix}
6761 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6762 writable, and if save-temps is off; otherwise, substitute the name
6763 of a temporary file, just like @samp{%u}.  This temporary file is not
6764 meant for communication between processes, but rather as a junk
6765 disposal mechanism.
6767 @item %|@var{suffix}
6768 @itemx %m@var{suffix}
6769 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6770 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6771 all.  These are the two most common ways to instruct a program that it
6772 should read from standard input or write to standard output.  If you
6773 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6774 construct: see for example @file{f/lang-specs.h}.
6776 @item %.@var{SUFFIX}
6777 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6778 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6779 terminated by the next space or %.
6781 @item %w
6782 Marks the argument containing or following the @samp{%w} as the
6783 designated output file of this compilation.  This puts the argument
6784 into the sequence of arguments that @samp{%o} will substitute later.
6786 @item %o
6787 Substitutes the names of all the output files, with spaces
6788 automatically placed around them.  You should write spaces
6789 around the @samp{%o} as well or the results are undefined.
6790 @samp{%o} is for use in the specs for running the linker.
6791 Input files whose names have no recognized suffix are not compiled
6792 at all, but they are included among the output files, so they will
6793 be linked.
6795 @item %O
6796 Substitutes the suffix for object files.  Note that this is
6797 handled specially when it immediately follows @samp{%g, %u, or %U},
6798 because of the need for those to form complete file names.  The
6799 handling is such that @samp{%O} is treated exactly as if it had already
6800 been substituted, except that @samp{%g, %u, and %U} do not currently
6801 support additional @var{suffix} characters following @samp{%O} as they would
6802 following, for example, @samp{.o}.
6804 @item %p
6805 Substitutes the standard macro predefinitions for the
6806 current target machine.  Use this when running @code{cpp}.
6808 @item %P
6809 Like @samp{%p}, but puts @samp{__} before and after the name of each
6810 predefined macro, except for macros that start with @samp{__} or with
6811 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6814 @item %I
6815 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6816 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6817 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6818 as necessary.
6820 @item %s
6821 Current argument is the name of a library or startup file of some sort.
6822 Search for that file in a standard list of directories and substitute
6823 the full name found.
6825 @item %e@var{str}
6826 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6827 Use this when inconsistent options are detected.
6829 @item %(@var{name})
6830 Substitute the contents of spec string @var{name} at this point.
6832 @item %[@var{name}]
6833 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6835 @item %x@{@var{option}@}
6836 Accumulate an option for @samp{%X}.
6838 @item %X
6839 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6840 spec string.
6842 @item %Y
6843 Output the accumulated assembler options specified by @option{-Wa}.
6845 @item %Z
6846 Output the accumulated preprocessor options specified by @option{-Wp}.
6848 @item %a
6849 Process the @code{asm} spec.  This is used to compute the
6850 switches to be passed to the assembler.
6852 @item %A
6853 Process the @code{asm_final} spec.  This is a spec string for
6854 passing switches to an assembler post-processor, if such a program is
6855 needed.
6857 @item %l
6858 Process the @code{link} spec.  This is the spec for computing the
6859 command line passed to the linker.  Typically it will make use of the
6860 @samp{%L %G %S %D and %E} sequences.
6862 @item %D
6863 Dump out a @option{-L} option for each directory that GCC believes might
6864 contain startup files.  If the target supports multilibs then the
6865 current multilib directory will be prepended to each of these paths.
6867 @item %L
6868 Process the @code{lib} spec.  This is a spec string for deciding which
6869 libraries should be included on the command line to the linker.
6871 @item %G
6872 Process the @code{libgcc} spec.  This is a spec string for deciding
6873 which GCC support library should be included on the command line to the linker.
6875 @item %S
6876 Process the @code{startfile} spec.  This is a spec for deciding which
6877 object files should be the first ones passed to the linker.  Typically
6878 this might be a file named @file{crt0.o}.
6880 @item %E
6881 Process the @code{endfile} spec.  This is a spec string that specifies
6882 the last object files that will be passed to the linker.
6884 @item %C
6885 Process the @code{cpp} spec.  This is used to construct the arguments
6886 to be passed to the C preprocessor.
6888 @item %1
6889 Process the @code{cc1} spec.  This is used to construct the options to be
6890 passed to the actual C compiler (@samp{cc1}).
6892 @item %2
6893 Process the @code{cc1plus} spec.  This is used to construct the options to be
6894 passed to the actual C++ compiler (@samp{cc1plus}).
6896 @item %*
6897 Substitute the variable part of a matched option.  See below.
6898 Note that each comma in the substituted string is replaced by
6899 a single space.
6901 @item %<@code{S}
6902 Remove all occurrences of @code{-S} from the command line.  Note---this
6903 command is position dependent.  @samp{%} commands in the spec string
6904 before this one will see @code{-S}, @samp{%} commands in the spec string
6905 after this one will not.
6907 @item %:@var{function}(@var{args})
6908 Call the named function @var{function}, passing it @var{args}.
6909 @var{args} is first processed as a nested spec string, then split
6910 into an argument vector in the usual fashion.  The function returns
6911 a string which is processed as if it had appeared literally as part
6912 of the current spec.
6914 The following built-in spec functions are provided:
6916 @table @code
6917 @item @code{if-exists}
6918 The @code{if-exists} spec function takes one argument, an absolute
6919 pathname to a file.  If the file exists, @code{if-exists} returns the
6920 pathname.  Here is a small example of its usage:
6922 @smallexample
6923 *startfile:
6924 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6925 @end smallexample
6927 @item @code{if-exists-else}
6928 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6929 spec function, except that it takes two arguments.  The first argument is
6930 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6931 returns the pathname.  If it does not exist, it returns the second argument.
6932 This way, @code{if-exists-else} can be used to select one file or another,
6933 based on the existence of the first.  Here is a small example of its usage:
6935 @smallexample
6936 *startfile:
6937 crt0%O%s %:if-exists(crti%O%s) \
6938 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6939 @end smallexample
6941 @item @code{replace-outfile}
6942 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6943 first argument in the outfiles array and replaces it with the second argument.  Here
6944 is a small example of its usage:
6946 @smallexample
6947 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6948 @end smallexample
6950 @end table
6952 @item %@{@code{S}@}
6953 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6954 If that switch was not specified, this substitutes nothing.  Note that
6955 the leading dash is omitted when specifying this option, and it is
6956 automatically inserted if the substitution is performed.  Thus the spec
6957 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6958 and would output the command line option @option{-foo}.
6960 @item %W@{@code{S}@}
6961 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6962 deleted on failure.
6964 @item %@{@code{S}*@}
6965 Substitutes all the switches specified to GCC whose names start
6966 with @code{-S}, but which also take an argument.  This is used for
6967 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6968 GCC considers @option{-o foo} as being
6969 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6970 text, including the space.  Thus two arguments would be generated.
6972 @item %@{@code{S}*&@code{T}*@}
6973 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6974 (the order of @code{S} and @code{T} in the spec is not significant).
6975 There can be any number of ampersand-separated variables; for each the
6976 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6978 @item %@{@code{S}:@code{X}@}
6979 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6981 @item %@{!@code{S}:@code{X}@}
6982 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6984 @item %@{@code{S}*:@code{X}@}
6985 Substitutes @code{X} if one or more switches whose names start with
6986 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6987 once, no matter how many such switches appeared.  However, if @code{%*}
6988 appears somewhere in @code{X}, then @code{X} will be substituted once
6989 for each matching switch, with the @code{%*} replaced by the part of
6990 that switch that matched the @code{*}.
6992 @item %@{.@code{S}:@code{X}@}
6993 Substitutes @code{X}, if processing a file with suffix @code{S}.
6995 @item %@{!.@code{S}:@code{X}@}
6996 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6998 @item %@{@code{S}|@code{P}:@code{X}@}
6999 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7000 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7001 although they have a stronger binding than the @samp{|}.  If @code{%*}
7002 appears in @code{X}, all of the alternatives must be starred, and only
7003 the first matching alternative is substituted.
7005 For example, a spec string like this:
7007 @smallexample
7008 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7009 @end smallexample
7011 will output the following command-line options from the following input
7012 command-line options:
7014 @smallexample
7015 fred.c        -foo -baz
7016 jim.d         -bar -boggle
7017 -d fred.c     -foo -baz -boggle
7018 -d jim.d      -bar -baz -boggle
7019 @end smallexample
7021 @item %@{S:X; T:Y; :D@}
7023 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7024 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7025 be as many clauses as you need.  This may be combined with @code{.},
7026 @code{!}, @code{|}, and @code{*} as needed.
7029 @end table
7031 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7032 construct may contain other nested @samp{%} constructs or spaces, or
7033 even newlines.  They are processed as usual, as described above.
7034 Trailing white space in @code{X} is ignored.  White space may also
7035 appear anywhere on the left side of the colon in these constructs,
7036 except between @code{.} or @code{*} and the corresponding word.
7038 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7039 handled specifically in these constructs.  If another value of
7040 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7041 @option{-W} switch is found later in the command line, the earlier
7042 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7043 just one letter, which passes all matching options.
7045 The character @samp{|} at the beginning of the predicate text is used to
7046 indicate that a command should be piped to the following command, but
7047 only if @option{-pipe} is specified.
7049 It is built into GCC which switches take arguments and which do not.
7050 (You might think it would be useful to generalize this to allow each
7051 compiler's spec to say which switches take arguments.  But this cannot
7052 be done in a consistent fashion.  GCC cannot even decide which input
7053 files have been specified without knowing which switches take arguments,
7054 and it must know which input files to compile in order to tell which
7055 compilers to run).
7057 GCC also knows implicitly that arguments starting in @option{-l} are to be
7058 treated as compiler output files, and passed to the linker in their
7059 proper position among the other output files.
7061 @c man begin OPTIONS
7063 @node Target Options
7064 @section Specifying Target Machine and Compiler Version
7065 @cindex target options
7066 @cindex cross compiling
7067 @cindex specifying machine version
7068 @cindex specifying compiler version and target machine
7069 @cindex compiler version, specifying
7070 @cindex target machine, specifying
7072 The usual way to run GCC is to run the executable called @file{gcc}, or
7073 @file{<machine>-gcc} when cross-compiling, or
7074 @file{<machine>-gcc-<version>} to run a version other than the one that
7075 was installed last.  Sometimes this is inconvenient, so GCC provides
7076 options that will switch to another cross-compiler or version.
7078 @table @gcctabopt
7079 @item -b @var{machine}
7080 @opindex b
7081 The argument @var{machine} specifies the target machine for compilation.
7083 The value to use for @var{machine} is the same as was specified as the
7084 machine type when configuring GCC as a cross-compiler.  For
7085 example, if a cross-compiler was configured with @samp{configure
7086 arm-elf}, meaning to compile for an arm processor with elf binaries,
7087 then you would specify @option{-b arm-elf} to run that cross compiler.
7088 Because there are other options beginning with @option{-b}, the
7089 configuration must contain a hyphen. 
7091 @item -V @var{version}
7092 @opindex V
7093 The argument @var{version} specifies which version of GCC to run.
7094 This is useful when multiple versions are installed.  For example,
7095 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7096 @end table
7098 The @option{-V} and @option{-b} options work by running the
7099 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7100 use them if you can just run that directly.
7102 @node Submodel Options
7103 @section Hardware Models and Configurations
7104 @cindex submodel options
7105 @cindex specifying hardware config
7106 @cindex hardware models and configurations, specifying
7107 @cindex machine dependent options
7109 Earlier we discussed the standard option @option{-b} which chooses among
7110 different installed compilers for completely different target
7111 machines, such as VAX vs.@: 68000 vs.@: 80386.
7113 In addition, each of these target machine types can have its own
7114 special options, starting with @samp{-m}, to choose among various
7115 hardware models or configurations---for example, 68010 vs 68020,
7116 floating coprocessor or none.  A single installed version of the
7117 compiler can compile for any model or configuration, according to the
7118 options specified.
7120 Some configurations of the compiler also support additional special
7121 options, usually for compatibility with other compilers on the same
7122 platform.
7124 @c This list is ordered alphanumerically by subsection name.
7125 @c It should be the same order and spelling as these options are listed
7126 @c in Machine Dependent Options
7128 @menu
7129 * ARC Options::
7130 * ARM Options::
7131 * AVR Options::
7132 * Blackfin Options::
7133 * CRIS Options::
7134 * CRX Options::
7135 * Darwin Options::
7136 * DEC Alpha Options::
7137 * DEC Alpha/VMS Options::
7138 * FRV Options::
7139 * H8/300 Options::
7140 * HPPA Options::
7141 * i386 and x86-64 Options::
7142 * IA-64 Options::
7143 * M32C Options::
7144 * M32R/D Options::
7145 * M680x0 Options::
7146 * M68hc1x Options::
7147 * MCore Options::
7148 * MIPS Options::
7149 * MMIX Options::
7150 * MN10300 Options::
7151 * MT Options::
7152 * PDP-11 Options::
7153 * PowerPC Options::
7154 * RS/6000 and PowerPC Options::
7155 * S/390 and zSeries Options::
7156 * SH Options::
7157 * SPARC Options::
7158 * System V Options::
7159 * TMS320C3x/C4x Options::
7160 * V850 Options::
7161 * VAX Options::
7162 * x86-64 Options::
7163 * Xstormy16 Options::
7164 * Xtensa Options::
7165 * zSeries Options::
7166 @end menu
7168 @node ARC Options
7169 @subsection ARC Options
7170 @cindex ARC Options
7172 These options are defined for ARC implementations:
7174 @table @gcctabopt
7175 @item -EL
7176 @opindex EL
7177 Compile code for little endian mode.  This is the default.
7179 @item -EB
7180 @opindex EB
7181 Compile code for big endian mode.
7183 @item -mmangle-cpu
7184 @opindex mmangle-cpu
7185 Prepend the name of the cpu to all public symbol names.
7186 In multiple-processor systems, there are many ARC variants with different
7187 instruction and register set characteristics.  This flag prevents code
7188 compiled for one cpu to be linked with code compiled for another.
7189 No facility exists for handling variants that are ``almost identical''.
7190 This is an all or nothing option.
7192 @item -mcpu=@var{cpu}
7193 @opindex mcpu
7194 Compile code for ARC variant @var{cpu}.
7195 Which variants are supported depend on the configuration.
7196 All variants support @option{-mcpu=base}, this is the default.
7198 @item -mtext=@var{text-section}
7199 @itemx -mdata=@var{data-section}
7200 @itemx -mrodata=@var{readonly-data-section}
7201 @opindex mtext
7202 @opindex mdata
7203 @opindex mrodata
7204 Put functions, data, and readonly data in @var{text-section},
7205 @var{data-section}, and @var{readonly-data-section} respectively
7206 by default.  This can be overridden with the @code{section} attribute.
7207 @xref{Variable Attributes}.
7209 @end table
7211 @node ARM Options
7212 @subsection ARM Options
7213 @cindex ARM options
7215 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7216 architectures:
7218 @table @gcctabopt
7219 @item -mabi=@var{name}
7220 @opindex mabi
7221 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7222 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7224 @item -mapcs-frame
7225 @opindex mapcs-frame
7226 Generate a stack frame that is compliant with the ARM Procedure Call
7227 Standard for all functions, even if this is not strictly necessary for
7228 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7229 with this option will cause the stack frames not to be generated for
7230 leaf functions.  The default is @option{-mno-apcs-frame}.
7232 @item -mapcs
7233 @opindex mapcs
7234 This is a synonym for @option{-mapcs-frame}.
7236 @ignore
7237 @c not currently implemented
7238 @item -mapcs-stack-check
7239 @opindex mapcs-stack-check
7240 Generate code to check the amount of stack space available upon entry to
7241 every function (that actually uses some stack space).  If there is
7242 insufficient space available then either the function
7243 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7244 called, depending upon the amount of stack space required.  The run time
7245 system is required to provide these functions.  The default is
7246 @option{-mno-apcs-stack-check}, since this produces smaller code.
7248 @c not currently implemented
7249 @item -mapcs-float
7250 @opindex mapcs-float
7251 Pass floating point arguments using the float point registers.  This is
7252 one of the variants of the APCS@.  This option is recommended if the
7253 target hardware has a floating point unit or if a lot of floating point
7254 arithmetic is going to be performed by the code.  The default is
7255 @option{-mno-apcs-float}, since integer only code is slightly increased in
7256 size if @option{-mapcs-float} is used.
7258 @c not currently implemented
7259 @item -mapcs-reentrant
7260 @opindex mapcs-reentrant
7261 Generate reentrant, position independent code.  The default is
7262 @option{-mno-apcs-reentrant}.
7263 @end ignore
7265 @item -mthumb-interwork
7266 @opindex mthumb-interwork
7267 Generate code which supports calling between the ARM and Thumb
7268 instruction sets.  Without this option the two instruction sets cannot
7269 be reliably used inside one program.  The default is
7270 @option{-mno-thumb-interwork}, since slightly larger code is generated
7271 when @option{-mthumb-interwork} is specified.
7273 @item -mno-sched-prolog
7274 @opindex mno-sched-prolog
7275 Prevent the reordering of instructions in the function prolog, or the
7276 merging of those instruction with the instructions in the function's
7277 body.  This means that all functions will start with a recognizable set
7278 of instructions (or in fact one of a choice from a small set of
7279 different function prologues), and this information can be used to
7280 locate the start if functions inside an executable piece of code.  The
7281 default is @option{-msched-prolog}.
7283 @item -mhard-float
7284 @opindex mhard-float
7285 Generate output containing floating point instructions.  This is the
7286 default.
7288 @item -msoft-float
7289 @opindex msoft-float
7290 Generate output containing library calls for floating point.
7291 @strong{Warning:} the requisite libraries are not available for all ARM
7292 targets.  Normally the facilities of the machine's usual C compiler are
7293 used, but this cannot be done directly in cross-compilation.  You must make
7294 your own arrangements to provide suitable library functions for
7295 cross-compilation.
7297 @option{-msoft-float} changes the calling convention in the output file;
7298 therefore, it is only useful if you compile @emph{all} of a program with
7299 this option.  In particular, you need to compile @file{libgcc.a}, the
7300 library that comes with GCC, with @option{-msoft-float} in order for
7301 this to work.
7303 @item -mfloat-abi=@var{name}
7304 @opindex mfloat-abi
7305 Specifies which ABI to use for floating point values.  Permissible values
7306 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7308 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7309 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7310 of floating point instructions, but still uses the soft-float calling
7311 conventions.
7313 @item -mlittle-endian
7314 @opindex mlittle-endian
7315 Generate code for a processor running in little-endian mode.  This is
7316 the default for all standard configurations.
7318 @item -mbig-endian
7319 @opindex mbig-endian
7320 Generate code for a processor running in big-endian mode; the default is
7321 to compile code for a little-endian processor.
7323 @item -mwords-little-endian
7324 @opindex mwords-little-endian
7325 This option only applies when generating code for big-endian processors.
7326 Generate code for a little-endian word order but a big-endian byte
7327 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7328 option should only be used if you require compatibility with code for
7329 big-endian ARM processors generated by versions of the compiler prior to
7330 2.8.
7332 @item -mcpu=@var{name}
7333 @opindex mcpu
7334 This specifies the name of the target ARM processor.  GCC uses this name
7335 to determine what kind of instructions it can emit when generating
7336 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7337 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7338 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7339 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7340 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7341 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7342 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7343 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7344 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7345 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7346 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7347 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7348 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7349 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7350 @samp{ep9312}.
7352 @itemx -mtune=@var{name}
7353 @opindex mtune
7354 This option is very similar to the @option{-mcpu=} option, except that
7355 instead of specifying the actual target processor type, and hence
7356 restricting which instructions can be used, it specifies that GCC should
7357 tune the performance of the code as if the target were of the type
7358 specified in this option, but still choosing the instructions that it
7359 will generate based on the cpu specified by a @option{-mcpu=} option.
7360 For some ARM implementations better performance can be obtained by using
7361 this option.
7363 @item -march=@var{name}
7364 @opindex march
7365 This specifies the name of the target ARM architecture.  GCC uses this
7366 name to determine what kind of instructions it can emit when generating
7367 assembly code.  This option can be used in conjunction with or instead
7368 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7369 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7370 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7371 @samp{iwmmxt}, @samp{ep9312}.
7373 @item -mfpu=@var{name}
7374 @itemx -mfpe=@var{number}
7375 @itemx -mfp=@var{number}
7376 @opindex mfpu
7377 @opindex mfpe
7378 @opindex mfp
7379 This specifies what floating point hardware (or hardware emulation) is
7380 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7381 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7382 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7383 with older versions of GCC@.
7385 If @option{-msoft-float} is specified this specifies the format of
7386 floating point values.
7388 @item -mstructure-size-boundary=@var{n}
7389 @opindex mstructure-size-boundary
7390 The size of all structures and unions will be rounded up to a multiple
7391 of the number of bits set by this option.  Permissible values are 8, 32
7392 and 64.  The default value varies for different toolchains.  For the COFF
7393 targeted toolchain the default value is 8.  A value of 64 is only allowed
7394 if the underlying ABI supports it.
7396 Specifying the larger number can produce faster, more efficient code, but
7397 can also increase the size of the program.  Different values are potentially
7398 incompatible.  Code compiled with one value cannot necessarily expect to
7399 work with code or libraries compiled with another value, if they exchange
7400 information using structures or unions.
7402 @item -mabort-on-noreturn
7403 @opindex mabort-on-noreturn
7404 Generate a call to the function @code{abort} at the end of a
7405 @code{noreturn} function.  It will be executed if the function tries to
7406 return.
7408 @item -mlong-calls
7409 @itemx -mno-long-calls
7410 @opindex mlong-calls
7411 @opindex mno-long-calls
7412 Tells the compiler to perform function calls by first loading the
7413 address of the function into a register and then performing a subroutine
7414 call on this register.  This switch is needed if the target function
7415 will lie outside of the 64 megabyte addressing range of the offset based
7416 version of subroutine call instruction.
7418 Even if this switch is enabled, not all function calls will be turned
7419 into long calls.  The heuristic is that static functions, functions
7420 which have the @samp{short-call} attribute, functions that are inside
7421 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7422 definitions have already been compiled within the current compilation
7423 unit, will not be turned into long calls.  The exception to this rule is
7424 that weak function definitions, functions with the @samp{long-call}
7425 attribute or the @samp{section} attribute, and functions that are within
7426 the scope of a @samp{#pragma long_calls} directive, will always be
7427 turned into long calls.
7429 This feature is not enabled by default.  Specifying
7430 @option{-mno-long-calls} will restore the default behavior, as will
7431 placing the function calls within the scope of a @samp{#pragma
7432 long_calls_off} directive.  Note these switches have no effect on how
7433 the compiler generates code to handle function calls via function
7434 pointers.
7436 @item -mnop-fun-dllimport
7437 @opindex mnop-fun-dllimport
7438 Disable support for the @code{dllimport} attribute.
7440 @item -msingle-pic-base
7441 @opindex msingle-pic-base
7442 Treat the register used for PIC addressing as read-only, rather than
7443 loading it in the prologue for each function.  The run-time system is
7444 responsible for initializing this register with an appropriate value
7445 before execution begins.
7447 @item -mpic-register=@var{reg}
7448 @opindex mpic-register
7449 Specify the register to be used for PIC addressing.  The default is R10
7450 unless stack-checking is enabled, when R9 is used.
7452 @item -mcirrus-fix-invalid-insns
7453 @opindex mcirrus-fix-invalid-insns
7454 @opindex mno-cirrus-fix-invalid-insns
7455 Insert NOPs into the instruction stream to in order to work around
7456 problems with invalid Maverick instruction combinations.  This option
7457 is only valid if the @option{-mcpu=ep9312} option has been used to
7458 enable generation of instructions for the Cirrus Maverick floating
7459 point co-processor.  This option is not enabled by default, since the
7460 problem is only present in older Maverick implementations.  The default
7461 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7462 switch.
7464 @item -mpoke-function-name
7465 @opindex mpoke-function-name
7466 Write the name of each function into the text section, directly
7467 preceding the function prologue.  The generated code is similar to this:
7469 @smallexample
7470      t0
7471          .ascii "arm_poke_function_name", 0
7472          .align
7473      t1
7474          .word 0xff000000 + (t1 - t0)
7475      arm_poke_function_name
7476          mov     ip, sp
7477          stmfd   sp!, @{fp, ip, lr, pc@}
7478          sub     fp, ip, #4
7479 @end smallexample
7481 When performing a stack backtrace, code can inspect the value of
7482 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7483 location @code{pc - 12} and the top 8 bits are set, then we know that
7484 there is a function name embedded immediately preceding this location
7485 and has length @code{((pc[-3]) & 0xff000000)}.
7487 @item -mthumb
7488 @opindex mthumb
7489 Generate code for the 16-bit Thumb instruction set.  The default is to
7490 use the 32-bit ARM instruction set.
7492 @item -mtpcs-frame
7493 @opindex mtpcs-frame
7494 Generate a stack frame that is compliant with the Thumb Procedure Call
7495 Standard for all non-leaf functions.  (A leaf function is one that does
7496 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7498 @item -mtpcs-leaf-frame
7499 @opindex mtpcs-leaf-frame
7500 Generate a stack frame that is compliant with the Thumb Procedure Call
7501 Standard for all leaf functions.  (A leaf function is one that does
7502 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7504 @item -mcallee-super-interworking
7505 @opindex mcallee-super-interworking
7506 Gives all externally visible functions in the file being compiled an ARM
7507 instruction set header which switches to Thumb mode before executing the
7508 rest of the function.  This allows these functions to be called from
7509 non-interworking code.
7511 @item -mcaller-super-interworking
7512 @opindex mcaller-super-interworking
7513 Allows calls via function pointers (including virtual functions) to
7514 execute correctly regardless of whether the target code has been
7515 compiled for interworking or not.  There is a small overhead in the cost
7516 of executing a function pointer if this option is enabled.
7518 @item -mtp=@var{name}
7519 @opindex mtp
7520 Specify the access model for the thread local storage pointer.  The valid
7521 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7522 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7523 (supported in the arm6k architecture), and @option{auto}, which uses the
7524 best available method for the selected processor.  The default setting is
7525 @option{auto}.
7527 @end table
7529 @node AVR Options
7530 @subsection AVR Options
7531 @cindex AVR Options
7533 These options are defined for AVR implementations:
7535 @table @gcctabopt
7536 @item -mmcu=@var{mcu}
7537 @opindex mmcu
7538 Specify ATMEL AVR instruction set or MCU type.
7540 Instruction set avr1 is for the minimal AVR core, not supported by the C
7541 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7542 attiny11, attiny12, attiny15, attiny28).
7544 Instruction set avr2 (default) is for the classic AVR core with up to
7545 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7546 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7547 at90c8534, at90s8535).
7549 Instruction set avr3 is for the classic AVR core with up to 128K program
7550 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7552 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7553 memory space (MCU types: atmega8, atmega83, atmega85).
7555 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7556 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7557 atmega64, atmega128, at43usb355, at94k).
7559 @item -msize
7560 @opindex msize
7561 Output instruction sizes to the asm file.
7563 @item -minit-stack=@var{N}
7564 @opindex minit-stack
7565 Specify the initial stack address, which may be a symbol or numeric value,
7566 @samp{__stack} is the default.
7568 @item -mno-interrupts
7569 @opindex mno-interrupts
7570 Generated code is not compatible with hardware interrupts.
7571 Code size will be smaller.
7573 @item -mcall-prologues
7574 @opindex mcall-prologues
7575 Functions prologues/epilogues expanded as call to appropriate
7576 subroutines.  Code size will be smaller.
7578 @item -mno-tablejump
7579 @opindex mno-tablejump
7580 Do not generate tablejump insns which sometimes increase code size.
7582 @item -mtiny-stack
7583 @opindex mtiny-stack
7584 Change only the low 8 bits of the stack pointer.
7586 @item -mint8
7587 @opindex mint8
7588 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7589 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7590 and long long will be 4 bytes.  Please note that this option does not
7591 comply to the C standards, but it will provide you with smaller code
7592 size.
7593 @end table
7595 @node Blackfin Options
7596 @subsection Blackfin Options
7597 @cindex Blackfin Options
7599 @table @gcctabopt
7600 @item -momit-leaf-frame-pointer
7601 @opindex momit-leaf-frame-pointer
7602 Don't keep the frame pointer in a register for leaf functions.  This
7603 avoids the instructions to save, set up and restore frame pointers and
7604 makes an extra register available in leaf functions.  The option
7605 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7606 which might make debugging harder.
7608 @item -mspecld-anomaly
7609 @opindex mspecld-anomaly
7610 When enabled, the compiler will ensure that the generated code does not
7611 contain speculative loads after jump instructions.  This option is enabled
7612 by default.
7614 @item -mno-specld-anomaly
7615 @opindex mno-specld-anomaly
7616 Don't generate extra code to prevent speculative loads from occurring.
7618 @item -mcsync-anomaly
7619 @opindex mcsync-anomaly
7620 When enabled, the compiler will ensure that the generated code does not
7621 contain CSYNC or SSYNC instructions too soon after conditional branches.
7622 This option is enabled by default.
7624 @item -mno-csync-anomaly
7625 @opindex mno-csync-anomaly
7626 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7627 occurring too soon after a conditional branch.
7629 @item -mlow-64k
7630 @opindex mlow-64k
7631 When enabled, the compiler is free to take advantage of the knowledge that
7632 the entire program fits into the low 64k of memory.
7634 @item -mno-low-64k
7635 @opindex mno-low-64k
7636 Assume that the program is arbitrarily large.  This is the default.
7638 @item -mid-shared-library
7639 @opindex mid-shared-library
7640 Generate code that supports shared libraries via the library ID method.
7641 This allows for execute in place and shared libraries in an environment
7642 without virtual memory management.  This option implies @option{-fPIC}.
7644 @item -mno-id-shared-library
7645 @opindex mno-id-shared-library
7646 Generate code that doesn't assume ID based shared libraries are being used.
7647 This is the default.
7649 @item -mshared-library-id=n
7650 @opindex mshared-library-id
7651 Specified the identification number of the ID based shared library being
7652 compiled.  Specifying a value of 0 will generate more compact code, specifying
7653 other values will force the allocation of that number to the current
7654 library but is no more space or time efficient than omitting this option.
7656 @item -mlong-calls
7657 @itemx -mno-long-calls
7658 @opindex mlong-calls
7659 @opindex mno-long-calls
7660 Tells the compiler to perform function calls by first loading the
7661 address of the function into a register and then performing a subroutine
7662 call on this register.  This switch is needed if the target function
7663 will lie outside of the 24 bit addressing range of the offset based
7664 version of subroutine call instruction.
7666 This feature is not enabled by default.  Specifying
7667 @option{-mno-long-calls} will restore the default behavior.  Note these
7668 switches have no effect on how the compiler generates code to handle
7669 function calls via function pointers.
7670 @end table
7672 @node CRIS Options
7673 @subsection CRIS Options
7674 @cindex CRIS Options
7676 These options are defined specifically for the CRIS ports.
7678 @table @gcctabopt
7679 @item -march=@var{architecture-type}
7680 @itemx -mcpu=@var{architecture-type}
7681 @opindex march
7682 @opindex mcpu
7683 Generate code for the specified architecture.  The choices for
7684 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7685 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7686 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7687 @samp{v10}.
7689 @item -mtune=@var{architecture-type}
7690 @opindex mtune
7691 Tune to @var{architecture-type} everything applicable about the generated
7692 code, except for the ABI and the set of available instructions.  The
7693 choices for @var{architecture-type} are the same as for
7694 @option{-march=@var{architecture-type}}.
7696 @item -mmax-stack-frame=@var{n}
7697 @opindex mmax-stack-frame
7698 Warn when the stack frame of a function exceeds @var{n} bytes.
7700 @item -melinux-stacksize=@var{n}
7701 @opindex melinux-stacksize
7702 Only available with the @samp{cris-axis-aout} target.  Arranges for
7703 indications in the program to the kernel loader that the stack of the
7704 program should be set to @var{n} bytes.
7706 @item -metrax4
7707 @itemx -metrax100
7708 @opindex metrax4
7709 @opindex metrax100
7710 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7711 @option{-march=v3} and @option{-march=v8} respectively.
7713 @item -mmul-bug-workaround
7714 @itemx -mno-mul-bug-workaround
7715 @opindex mmul-bug-workaround
7716 @opindex mno-mul-bug-workaround
7717 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7718 models where it applies.  This option is active by default.
7720 @item -mpdebug
7721 @opindex mpdebug
7722 Enable CRIS-specific verbose debug-related information in the assembly
7723 code.  This option also has the effect to turn off the @samp{#NO_APP}
7724 formatted-code indicator to the assembler at the beginning of the
7725 assembly file.
7727 @item -mcc-init
7728 @opindex mcc-init
7729 Do not use condition-code results from previous instruction; always emit
7730 compare and test instructions before use of condition codes.
7732 @item -mno-side-effects
7733 @opindex mno-side-effects
7734 Do not emit instructions with side-effects in addressing modes other than
7735 post-increment.
7737 @item -mstack-align
7738 @itemx -mno-stack-align
7739 @itemx -mdata-align
7740 @itemx -mno-data-align
7741 @itemx -mconst-align
7742 @itemx -mno-const-align
7743 @opindex mstack-align
7744 @opindex mno-stack-align
7745 @opindex mdata-align
7746 @opindex mno-data-align
7747 @opindex mconst-align
7748 @opindex mno-const-align
7749 These options (no-options) arranges (eliminate arrangements) for the
7750 stack-frame, individual data and constants to be aligned for the maximum
7751 single data access size for the chosen CPU model.  The default is to
7752 arrange for 32-bit alignment.  ABI details such as structure layout are
7753 not affected by these options.
7755 @item -m32-bit
7756 @itemx -m16-bit
7757 @itemx -m8-bit
7758 @opindex m32-bit
7759 @opindex m16-bit
7760 @opindex m8-bit
7761 Similar to the stack- data- and const-align options above, these options
7762 arrange for stack-frame, writable data and constants to all be 32-bit,
7763 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7765 @item -mno-prologue-epilogue
7766 @itemx -mprologue-epilogue
7767 @opindex mno-prologue-epilogue
7768 @opindex mprologue-epilogue
7769 With @option{-mno-prologue-epilogue}, the normal function prologue and
7770 epilogue that sets up the stack-frame are omitted and no return
7771 instructions or return sequences are generated in the code.  Use this
7772 option only together with visual inspection of the compiled code: no
7773 warnings or errors are generated when call-saved registers must be saved,
7774 or storage for local variable needs to be allocated.
7776 @item -mno-gotplt
7777 @itemx -mgotplt
7778 @opindex mno-gotplt
7779 @opindex mgotplt
7780 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7781 instruction sequences that load addresses for functions from the PLT part
7782 of the GOT rather than (traditional on other architectures) calls to the
7783 PLT@.  The default is @option{-mgotplt}.
7785 @item -maout
7786 @opindex maout
7787 Legacy no-op option only recognized with the cris-axis-aout target.
7789 @item -melf
7790 @opindex melf
7791 Legacy no-op option only recognized with the cris-axis-elf and
7792 cris-axis-linux-gnu targets.
7794 @item -melinux
7795 @opindex melinux
7796 Only recognized with the cris-axis-aout target, where it selects a
7797 GNU/linux-like multilib, include files and instruction set for
7798 @option{-march=v8}.
7800 @item -mlinux
7801 @opindex mlinux
7802 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7804 @item -sim
7805 @opindex sim
7806 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7807 to link with input-output functions from a simulator library.  Code,
7808 initialized data and zero-initialized data are allocated consecutively.
7810 @item -sim2
7811 @opindex sim2
7812 Like @option{-sim}, but pass linker options to locate initialized data at
7813 0x40000000 and zero-initialized data at 0x80000000.
7814 @end table
7816 @node CRX Options
7817 @subsection CRX Options
7818 @cindex CRX Options
7820 These options are defined specifically for the CRX ports.
7822 @table @gcctabopt
7824 @item -mmac
7825 @opindex mmac
7826 Enable the use of multiply-accumulate instructions. Disabled by default.
7828 @item -mpush-args
7829 @opindex mpush-args
7830 Push instructions will be used to pass outgoing arguments when functions
7831 are called. Enabled by default.
7832 @end table
7834 @node Darwin Options
7835 @subsection Darwin Options
7836 @cindex Darwin options
7838 These options are defined for all architectures running the Darwin operating
7839 system.
7841 FSF GCC on Darwin does not create ``fat'' object files; it will create
7842 an object file for the single architecture that it was built to
7843 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7844 @option{-arch} options are used; it does so by running the compiler or
7845 linker multiple times and joining the results together with
7846 @file{lipo}.
7848 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7849 @samp{i686}) is determined by the flags that specify the ISA
7850 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7851 @option{-force_cpusubtype_ALL} option can be used to override this.
7853 The Darwin tools vary in their behavior when presented with an ISA
7854 mismatch.  The assembler, @file{as}, will only permit instructions to
7855 be used that are valid for the subtype of the file it is generating,
7856 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7857 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7858 and print an error if asked to create a shared library with a less
7859 restrictive subtype than its input files (for instance, trying to put
7860 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7861 for executables, @file{ld}, will quietly give the executable the most
7862 restrictive subtype of any of its input files.
7864 @table @gcctabopt
7865 @item -F@var{dir}
7866 @opindex F
7867 Add the framework directory @var{dir} to the head of the list of
7868 directories to be searched for header files.  These directories are
7869 interleaved with those specified by @option{-I} options and are
7870 scanned in a left-to-right order.
7872 A framework directory is a directory with frameworks in it.  A
7873 framework is a directory with a @samp{"Headers"} and/or
7874 @samp{"PrivateHeaders"} directory contained directly in it that ends
7875 in @samp{".framework"}.  The name of a framework is the name of this
7876 directory excluding the @samp{".framework"}.  Headers associated with
7877 the framework are found in one of those two directories, with
7878 @samp{"Headers"} being searched first.  A subframework is a framework
7879 directory that is in a framework's @samp{"Frameworks"} directory.
7880 Includes of subframework headers can only appear in a header of a
7881 framework that contains the subframework, or in a sibling subframework
7882 header.  Two subframeworks are siblings if they occur in the same
7883 framework.  A subframework should not have the same name as a
7884 framework, a warning will be issued if this is violated.  Currently a
7885 subframework cannot have subframeworks, in the future, the mechanism
7886 may be extended to support this.  The standard frameworks can be found
7887 in @samp{"/System/Library/Frameworks"} and
7888 @samp{"/Library/Frameworks"}.  An example include looks like
7889 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7890 the name of the framework and header.h is found in the
7891 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7893 @item -gused
7894 @opindex -gused
7895 Emit debugging information for symbols that are used.  For STABS
7896 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7897 This is by default ON@.
7899 @item -gfull
7900 @opindex -gfull
7901 Emit debugging information for all symbols and types.
7903 @item -mmacosx-version-min=@var{version}
7904 The earliest version of MacOS X that this executable will run on
7905 is @var{version}.  Typical values of @var{version} include @code{10.1},
7906 @code{10.2}, and @code{10.3.9}.
7908 The default for this option is to make choices that seem to be most
7909 useful.  
7911 @item -mone-byte-bool
7912 @opindex -mone-byte-bool
7913 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7914 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7915 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7916 option has no effect on x86.
7918 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7919 to generate code that is not binary compatible with code generated
7920 without that switch.  Using this switch may require recompiling all
7921 other modules in a program, including system libraries.  Use this
7922 switch to conform to a non-default data model.
7924 @item -mfix-and-continue
7925 @itemx -ffix-and-continue
7926 @itemx -findirect-data
7927 @opindex mfix-and-continue
7928 @opindex ffix-and-continue
7929 @opindex findirect-data
7930 Generate code suitable for fast turn around development.  Needed to
7931 enable gdb to dynamically load @code{.o} files into already running
7932 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7933 are provided for backwards compatibility.
7935 @item -all_load
7936 @opindex all_load
7937 Loads all members of static archive libraries.
7938 See man ld(1) for more information.
7940 @item -arch_errors_fatal
7941 @opindex arch_errors_fatal
7942 Cause the errors having to do with files that have the wrong architecture
7943 to be fatal.
7945 @item -bind_at_load
7946 @opindex bind_at_load
7947 Causes the output file to be marked such that the dynamic linker will
7948 bind all undefined references when the file is loaded or launched.
7950 @item -bundle
7951 @opindex bundle
7952 Produce a Mach-o bundle format file.
7953 See man ld(1) for more information.
7955 @item -bundle_loader @var{executable}
7956 @opindex bundle_loader
7957 This option specifies the @var{executable} that will be loading the build
7958 output file being linked.  See man ld(1) for more information.
7960 @item -dynamiclib
7961 @opindex -dynamiclib
7962 When passed this option, GCC will produce a dynamic library instead of
7963 an executable when linking, using the Darwin @file{libtool} command.
7965 @item -force_cpusubtype_ALL
7966 @opindex -force_cpusubtype_ALL
7967 This causes GCC's output file to have the @var{ALL} subtype, instead of
7968 one controlled by the @option{-mcpu} or @option{-march} option.
7970 @item -allowable_client  @var{client_name}
7971 @itemx -client_name
7972 @itemx -compatibility_version
7973 @itemx -current_version
7974 @itemx -dead_strip
7975 @itemx -dependency-file
7976 @itemx -dylib_file
7977 @itemx -dylinker_install_name
7978 @itemx -dynamic
7979 @itemx -exported_symbols_list
7980 @itemx -filelist
7981 @itemx -flat_namespace
7982 @itemx -force_flat_namespace
7983 @itemx -headerpad_max_install_names
7984 @itemx -image_base
7985 @itemx -init
7986 @itemx -install_name
7987 @itemx -keep_private_externs
7988 @itemx -multi_module
7989 @itemx -multiply_defined
7990 @itemx -multiply_defined_unused
7991 @itemx -noall_load
7992 @itemx -no_dead_strip_inits_and_terms
7993 @itemx -nofixprebinding
7994 @itemx -nomultidefs
7995 @itemx -noprebind
7996 @itemx -noseglinkedit
7997 @itemx -pagezero_size
7998 @itemx -prebind
7999 @itemx -prebind_all_twolevel_modules
8000 @itemx -private_bundle
8001 @itemx -read_only_relocs
8002 @itemx -sectalign
8003 @itemx -sectobjectsymbols
8004 @itemx -whyload
8005 @itemx -seg1addr
8006 @itemx -sectcreate
8007 @itemx -sectobjectsymbols
8008 @itemx -sectorder
8009 @itemx -segaddr
8010 @itemx -segs_read_only_addr
8011 @itemx -segs_read_write_addr
8012 @itemx -seg_addr_table
8013 @itemx -seg_addr_table_filename
8014 @itemx -seglinkedit
8015 @itemx -segprot
8016 @itemx -segs_read_only_addr
8017 @itemx -segs_read_write_addr
8018 @itemx -single_module
8019 @itemx -static
8020 @itemx -sub_library
8021 @itemx -sub_umbrella
8022 @itemx -twolevel_namespace
8023 @itemx -umbrella
8024 @itemx -undefined
8025 @itemx -unexported_symbols_list
8026 @itemx -weak_reference_mismatches
8027 @itemx -whatsloaded
8029 @opindex allowable_client
8030 @opindex client_name
8031 @opindex compatibility_version
8032 @opindex current_version
8033 @opindex dead_strip
8034 @opindex dependency-file
8035 @opindex dylib_file
8036 @opindex dylinker_install_name
8037 @opindex dynamic
8038 @opindex exported_symbols_list
8039 @opindex filelist
8040 @opindex flat_namespace
8041 @opindex force_flat_namespace
8042 @opindex headerpad_max_install_names
8043 @opindex image_base
8044 @opindex init
8045 @opindex install_name
8046 @opindex keep_private_externs
8047 @opindex multi_module
8048 @opindex multiply_defined
8049 @opindex multiply_defined_unused
8050 @opindex noall_load
8051 @opindex no_dead_strip_inits_and_terms
8052 @opindex nofixprebinding
8053 @opindex nomultidefs
8054 @opindex noprebind
8055 @opindex noseglinkedit
8056 @opindex pagezero_size
8057 @opindex prebind
8058 @opindex prebind_all_twolevel_modules
8059 @opindex private_bundle
8060 @opindex read_only_relocs
8061 @opindex sectalign
8062 @opindex sectobjectsymbols
8063 @opindex whyload
8064 @opindex seg1addr
8065 @opindex sectcreate
8066 @opindex sectobjectsymbols
8067 @opindex sectorder
8068 @opindex segaddr
8069 @opindex segs_read_only_addr
8070 @opindex segs_read_write_addr
8071 @opindex seg_addr_table
8072 @opindex seg_addr_table_filename
8073 @opindex seglinkedit
8074 @opindex segprot
8075 @opindex segs_read_only_addr
8076 @opindex segs_read_write_addr
8077 @opindex single_module
8078 @opindex static
8079 @opindex sub_library
8080 @opindex sub_umbrella
8081 @opindex twolevel_namespace
8082 @opindex umbrella
8083 @opindex undefined
8084 @opindex unexported_symbols_list
8085 @opindex weak_reference_mismatches
8086 @opindex whatsloaded
8088 These options are passed to the Darwin linker.  The Darwin linker man page
8089 describes them in detail.
8090 @end table
8092 @node DEC Alpha Options
8093 @subsection DEC Alpha Options
8095 These @samp{-m} options are defined for the DEC Alpha implementations:
8097 @table @gcctabopt
8098 @item -mno-soft-float
8099 @itemx -msoft-float
8100 @opindex mno-soft-float
8101 @opindex msoft-float
8102 Use (do not use) the hardware floating-point instructions for
8103 floating-point operations.  When @option{-msoft-float} is specified,
8104 functions in @file{libgcc.a} will be used to perform floating-point
8105 operations.  Unless they are replaced by routines that emulate the
8106 floating-point operations, or compiled in such a way as to call such
8107 emulations routines, these routines will issue floating-point
8108 operations.   If you are compiling for an Alpha without floating-point
8109 operations, you must ensure that the library is built so as not to call
8110 them.
8112 Note that Alpha implementations without floating-point operations are
8113 required to have floating-point registers.
8115 @item -mfp-reg
8116 @itemx -mno-fp-regs
8117 @opindex mfp-reg
8118 @opindex mno-fp-regs
8119 Generate code that uses (does not use) the floating-point register set.
8120 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8121 register set is not used, floating point operands are passed in integer
8122 registers as if they were integers and floating-point results are passed
8123 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8124 so any function with a floating-point argument or return value called by code
8125 compiled with @option{-mno-fp-regs} must also be compiled with that
8126 option.
8128 A typical use of this option is building a kernel that does not use,
8129 and hence need not save and restore, any floating-point registers.
8131 @item -mieee
8132 @opindex mieee
8133 The Alpha architecture implements floating-point hardware optimized for
8134 maximum performance.  It is mostly compliant with the IEEE floating
8135 point standard.  However, for full compliance, software assistance is
8136 required.  This option generates code fully IEEE compliant code
8137 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8138 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8139 defined during compilation.  The resulting code is less efficient but is
8140 able to correctly support denormalized numbers and exceptional IEEE
8141 values such as not-a-number and plus/minus infinity.  Other Alpha
8142 compilers call this option @option{-ieee_with_no_inexact}.
8144 @item -mieee-with-inexact
8145 @opindex mieee-with-inexact
8146 This is like @option{-mieee} except the generated code also maintains
8147 the IEEE @var{inexact-flag}.  Turning on this option causes the
8148 generated code to implement fully-compliant IEEE math.  In addition to
8149 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8150 macro.  On some Alpha implementations the resulting code may execute
8151 significantly slower than the code generated by default.  Since there is
8152 very little code that depends on the @var{inexact-flag}, you should
8153 normally not specify this option.  Other Alpha compilers call this
8154 option @option{-ieee_with_inexact}.
8156 @item -mfp-trap-mode=@var{trap-mode}
8157 @opindex mfp-trap-mode
8158 This option controls what floating-point related traps are enabled.
8159 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8160 The trap mode can be set to one of four values:
8162 @table @samp
8163 @item n
8164 This is the default (normal) setting.  The only traps that are enabled
8165 are the ones that cannot be disabled in software (e.g., division by zero
8166 trap).
8168 @item u
8169 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8170 as well.
8172 @item su
8173 Like @samp{su}, but the instructions are marked to be safe for software
8174 completion (see Alpha architecture manual for details).
8176 @item sui
8177 Like @samp{su}, but inexact traps are enabled as well.
8178 @end table
8180 @item -mfp-rounding-mode=@var{rounding-mode}
8181 @opindex mfp-rounding-mode
8182 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8183 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8186 @table @samp
8187 @item n
8188 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8189 the nearest machine number or towards the even machine number in case
8190 of a tie.
8192 @item m
8193 Round towards minus infinity.
8195 @item c
8196 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8198 @item d
8199 Dynamic rounding mode.  A field in the floating point control register
8200 (@var{fpcr}, see Alpha architecture reference manual) controls the
8201 rounding mode in effect.  The C library initializes this register for
8202 rounding towards plus infinity.  Thus, unless your program modifies the
8203 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8204 @end table
8206 @item -mtrap-precision=@var{trap-precision}
8207 @opindex mtrap-precision
8208 In the Alpha architecture, floating point traps are imprecise.  This
8209 means without software assistance it is impossible to recover from a
8210 floating trap and program execution normally needs to be terminated.
8211 GCC can generate code that can assist operating system trap handlers
8212 in determining the exact location that caused a floating point trap.
8213 Depending on the requirements of an application, different levels of
8214 precisions can be selected:
8216 @table @samp
8217 @item p
8218 Program precision.  This option is the default and means a trap handler
8219 can only identify which program caused a floating point exception.
8221 @item f
8222 Function precision.  The trap handler can determine the function that
8223 caused a floating point exception.
8225 @item i
8226 Instruction precision.  The trap handler can determine the exact
8227 instruction that caused a floating point exception.
8228 @end table
8230 Other Alpha compilers provide the equivalent options called
8231 @option{-scope_safe} and @option{-resumption_safe}.
8233 @item -mieee-conformant
8234 @opindex mieee-conformant
8235 This option marks the generated code as IEEE conformant.  You must not
8236 use this option unless you also specify @option{-mtrap-precision=i} and either
8237 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8238 is to emit the line @samp{.eflag 48} in the function prologue of the
8239 generated assembly file.  Under DEC Unix, this has the effect that
8240 IEEE-conformant math library routines will be linked in.
8242 @item -mbuild-constants
8243 @opindex mbuild-constants
8244 Normally GCC examines a 32- or 64-bit integer constant to
8245 see if it can construct it from smaller constants in two or three
8246 instructions.  If it cannot, it will output the constant as a literal and
8247 generate code to load it from the data segment at runtime.
8249 Use this option to require GCC to construct @emph{all} integer constants
8250 using code, even if it takes more instructions (the maximum is six).
8252 You would typically use this option to build a shared library dynamic
8253 loader.  Itself a shared library, it must relocate itself in memory
8254 before it can find the variables and constants in its own data segment.
8256 @item -malpha-as
8257 @itemx -mgas
8258 @opindex malpha-as
8259 @opindex mgas
8260 Select whether to generate code to be assembled by the vendor-supplied
8261 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8263 @item -mbwx
8264 @itemx -mno-bwx
8265 @itemx -mcix
8266 @itemx -mno-cix
8267 @itemx -mfix
8268 @itemx -mno-fix
8269 @itemx -mmax
8270 @itemx -mno-max
8271 @opindex mbwx
8272 @opindex mno-bwx
8273 @opindex mcix
8274 @opindex mno-cix
8275 @opindex mfix
8276 @opindex mno-fix
8277 @opindex mmax
8278 @opindex mno-max
8279 Indicate whether GCC should generate code to use the optional BWX,
8280 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8281 sets supported by the CPU type specified via @option{-mcpu=} option or that
8282 of the CPU on which GCC was built if none was specified.
8284 @item -mfloat-vax
8285 @itemx -mfloat-ieee
8286 @opindex mfloat-vax
8287 @opindex mfloat-ieee
8288 Generate code that uses (does not use) VAX F and G floating point
8289 arithmetic instead of IEEE single and double precision.
8291 @item -mexplicit-relocs
8292 @itemx -mno-explicit-relocs
8293 @opindex mexplicit-relocs
8294 @opindex mno-explicit-relocs
8295 Older Alpha assemblers provided no way to generate symbol relocations
8296 except via assembler macros.  Use of these macros does not allow
8297 optimal instruction scheduling.  GNU binutils as of version 2.12
8298 supports a new syntax that allows the compiler to explicitly mark
8299 which relocations should apply to which instructions.  This option
8300 is mostly useful for debugging, as GCC detects the capabilities of
8301 the assembler when it is built and sets the default accordingly.
8303 @item -msmall-data
8304 @itemx -mlarge-data
8305 @opindex msmall-data
8306 @opindex mlarge-data
8307 When @option{-mexplicit-relocs} is in effect, static data is
8308 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8309 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8310 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8311 16-bit relocations off of the @code{$gp} register.  This limits the
8312 size of the small data area to 64KB, but allows the variables to be
8313 directly accessed via a single instruction.
8315 The default is @option{-mlarge-data}.  With this option the data area
8316 is limited to just below 2GB@.  Programs that require more than 2GB of
8317 data must use @code{malloc} or @code{mmap} to allocate the data in the
8318 heap instead of in the program's data segment.
8320 When generating code for shared libraries, @option{-fpic} implies
8321 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8323 @item -msmall-text
8324 @itemx -mlarge-text
8325 @opindex msmall-text
8326 @opindex mlarge-text
8327 When @option{-msmall-text} is used, the compiler assumes that the
8328 code of the entire program (or shared library) fits in 4MB, and is
8329 thus reachable with a branch instruction.  When @option{-msmall-data}
8330 is used, the compiler can assume that all local symbols share the
8331 same @code{$gp} value, and thus reduce the number of instructions
8332 required for a function call from 4 to 1.
8334 The default is @option{-mlarge-text}.
8336 @item -mcpu=@var{cpu_type}
8337 @opindex mcpu
8338 Set the instruction set and instruction scheduling parameters for
8339 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8340 style name or the corresponding chip number.  GCC supports scheduling
8341 parameters for the EV4, EV5 and EV6 family of processors and will
8342 choose the default values for the instruction set from the processor
8343 you specify.  If you do not specify a processor type, GCC will default
8344 to the processor on which the compiler was built.
8346 Supported values for @var{cpu_type} are
8348 @table @samp
8349 @item ev4
8350 @itemx ev45
8351 @itemx 21064
8352 Schedules as an EV4 and has no instruction set extensions.
8354 @item ev5
8355 @itemx 21164
8356 Schedules as an EV5 and has no instruction set extensions.
8358 @item ev56
8359 @itemx 21164a
8360 Schedules as an EV5 and supports the BWX extension.
8362 @item pca56
8363 @itemx 21164pc
8364 @itemx 21164PC
8365 Schedules as an EV5 and supports the BWX and MAX extensions.
8367 @item ev6
8368 @itemx 21264
8369 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8371 @item ev67
8372 @itemx 21264a
8373 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8374 @end table
8376 @item -mtune=@var{cpu_type}
8377 @opindex mtune
8378 Set only the instruction scheduling parameters for machine type
8379 @var{cpu_type}.  The instruction set is not changed.
8381 @item -mmemory-latency=@var{time}
8382 @opindex mmemory-latency
8383 Sets the latency the scheduler should assume for typical memory
8384 references as seen by the application.  This number is highly
8385 dependent on the memory access patterns used by the application
8386 and the size of the external cache on the machine.
8388 Valid options for @var{time} are
8390 @table @samp
8391 @item @var{number}
8392 A decimal number representing clock cycles.
8394 @item L1
8395 @itemx L2
8396 @itemx L3
8397 @itemx main
8398 The compiler contains estimates of the number of clock cycles for
8399 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8400 (also called Dcache, Scache, and Bcache), as well as to main memory.
8401 Note that L3 is only valid for EV5.
8403 @end table
8404 @end table
8406 @node DEC Alpha/VMS Options
8407 @subsection DEC Alpha/VMS Options
8409 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8411 @table @gcctabopt
8412 @item -mvms-return-codes
8413 @opindex mvms-return-codes
8414 Return VMS condition codes from main.  The default is to return POSIX
8415 style condition (e.g.@ error) codes.
8416 @end table
8418 @node FRV Options
8419 @subsection FRV Options
8420 @cindex FRV Options
8422 @table @gcctabopt
8423 @item -mgpr-32
8424 @opindex mgpr-32
8426 Only use the first 32 general purpose registers.
8428 @item -mgpr-64
8429 @opindex mgpr-64
8431 Use all 64 general purpose registers.
8433 @item -mfpr-32
8434 @opindex mfpr-32
8436 Use only the first 32 floating point registers.
8438 @item -mfpr-64
8439 @opindex mfpr-64
8441 Use all 64 floating point registers
8443 @item -mhard-float
8444 @opindex mhard-float
8446 Use hardware instructions for floating point operations.
8448 @item -msoft-float
8449 @opindex msoft-float
8451 Use library routines for floating point operations.
8453 @item -malloc-cc
8454 @opindex malloc-cc
8456 Dynamically allocate condition code registers.
8458 @item -mfixed-cc
8459 @opindex mfixed-cc
8461 Do not try to dynamically allocate condition code registers, only
8462 use @code{icc0} and @code{fcc0}.
8464 @item -mdword
8465 @opindex mdword
8467 Change ABI to use double word insns.
8469 @item -mno-dword
8470 @opindex mno-dword
8472 Do not use double word instructions.
8474 @item -mdouble
8475 @opindex mdouble
8477 Use floating point double instructions.
8479 @item -mno-double
8480 @opindex mno-double
8482 Do not use floating point double instructions.
8484 @item -mmedia
8485 @opindex mmedia
8487 Use media instructions.
8489 @item -mno-media
8490 @opindex mno-media
8492 Do not use media instructions.
8494 @item -mmuladd
8495 @opindex mmuladd
8497 Use multiply and add/subtract instructions.
8499 @item -mno-muladd
8500 @opindex mno-muladd
8502 Do not use multiply and add/subtract instructions.
8504 @item -mfdpic
8505 @opindex mfdpic
8507 Select the FDPIC ABI, that uses function descriptors to represent
8508 pointers to functions.  Without any PIC/PIE-related options, it
8509 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8510 assumes GOT entries and small data are within a 12-bit range from the
8511 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8512 are computed with 32 bits.
8514 @item -minline-plt
8515 @opindex minline-plt
8517 Enable inlining of PLT entries in function calls to functions that are
8518 not known to bind locally.  It has no effect without @option{-mfdpic}.
8519 It's enabled by default if optimizing for speed and compiling for
8520 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8521 optimization option such as @option{-O3} or above is present in the
8522 command line.
8524 @item -mTLS
8525 @opindex TLS
8527 Assume a large TLS segment when generating thread-local code.
8529 @item -mtls
8530 @opindex tls
8532 Do not assume a large TLS segment when generating thread-local code.
8534 @item -mgprel-ro
8535 @opindex mgprel-ro
8537 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8538 that is known to be in read-only sections.  It's enabled by default,
8539 except for @option{-fpic} or @option{-fpie}: even though it may help
8540 make the global offset table smaller, it trades 1 instruction for 4.
8541 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8542 one of which may be shared by multiple symbols, and it avoids the need
8543 for a GOT entry for the referenced symbol, so it's more likely to be a
8544 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8546 @item -multilib-library-pic
8547 @opindex multilib-library-pic
8549 Link with the (library, not FD) pic libraries.  It's implied by
8550 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8551 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8552 it explicitly.
8554 @item -mlinked-fp
8555 @opindex mlinked-fp
8557 Follow the EABI requirement of always creating a frame pointer whenever
8558 a stack frame is allocated.  This option is enabled by default and can
8559 be disabled with @option{-mno-linked-fp}.
8561 @item -mlong-calls
8562 @opindex mlong-calls
8564 Use indirect addressing to call functions outside the current
8565 compilation unit.  This allows the functions to be placed anywhere
8566 within the 32-bit address space.
8568 @item -malign-labels
8569 @opindex malign-labels
8571 Try to align labels to an 8-byte boundary by inserting nops into the
8572 previous packet.  This option only has an effect when VLIW packing
8573 is enabled.  It doesn't create new packets; it merely adds nops to
8574 existing ones.
8576 @item -mlibrary-pic
8577 @opindex mlibrary-pic
8579 Generate position-independent EABI code.
8581 @item -macc-4
8582 @opindex macc-4
8584 Use only the first four media accumulator registers.
8586 @item -macc-8
8587 @opindex macc-8
8589 Use all eight media accumulator registers.
8591 @item -mpack
8592 @opindex mpack
8594 Pack VLIW instructions.
8596 @item -mno-pack
8597 @opindex mno-pack
8599 Do not pack VLIW instructions.
8601 @item -mno-eflags
8602 @opindex mno-eflags
8604 Do not mark ABI switches in e_flags.
8606 @item -mcond-move
8607 @opindex mcond-move
8609 Enable the use of conditional-move instructions (default).
8611 This switch is mainly for debugging the compiler and will likely be removed
8612 in a future version.
8614 @item -mno-cond-move
8615 @opindex mno-cond-move
8617 Disable the use of conditional-move instructions.
8619 This switch is mainly for debugging the compiler and will likely be removed
8620 in a future version.
8622 @item -mscc
8623 @opindex mscc
8625 Enable the use of conditional set instructions (default).
8627 This switch is mainly for debugging the compiler and will likely be removed
8628 in a future version.
8630 @item -mno-scc
8631 @opindex mno-scc
8633 Disable the use of conditional set instructions.
8635 This switch is mainly for debugging the compiler and will likely be removed
8636 in a future version.
8638 @item -mcond-exec
8639 @opindex mcond-exec
8641 Enable the use of conditional execution (default).
8643 This switch is mainly for debugging the compiler and will likely be removed
8644 in a future version.
8646 @item -mno-cond-exec
8647 @opindex mno-cond-exec
8649 Disable the use of conditional execution.
8651 This switch is mainly for debugging the compiler and will likely be removed
8652 in a future version.
8654 @item -mvliw-branch
8655 @opindex mvliw-branch
8657 Run a pass to pack branches into VLIW instructions (default).
8659 This switch is mainly for debugging the compiler and will likely be removed
8660 in a future version.
8662 @item -mno-vliw-branch
8663 @opindex mno-vliw-branch
8665 Do not run a pass to pack branches into VLIW instructions.
8667 This switch is mainly for debugging the compiler and will likely be removed
8668 in a future version.
8670 @item -mmulti-cond-exec
8671 @opindex mmulti-cond-exec
8673 Enable optimization of @code{&&} and @code{||} in conditional execution
8674 (default).
8676 This switch is mainly for debugging the compiler and will likely be removed
8677 in a future version.
8679 @item -mno-multi-cond-exec
8680 @opindex mno-multi-cond-exec
8682 Disable optimization of @code{&&} and @code{||} in conditional execution.
8684 This switch is mainly for debugging the compiler and will likely be removed
8685 in a future version.
8687 @item -mnested-cond-exec
8688 @opindex mnested-cond-exec
8690 Enable nested conditional execution optimizations (default).
8692 This switch is mainly for debugging the compiler and will likely be removed
8693 in a future version.
8695 @item -mno-nested-cond-exec
8696 @opindex mno-nested-cond-exec
8698 Disable nested conditional execution optimizations.
8700 This switch is mainly for debugging the compiler and will likely be removed
8701 in a future version.
8703 @item -moptimize-membar
8704 @opindex moptimize-membar
8706 This switch removes redundant @code{membar} instructions from the
8707 compiler generated code.  It is enabled by default.
8709 @item -mno-optimize-membar
8710 @opindex mno-optimize-membar
8712 This switch disables the automatic removal of redundant @code{membar}
8713 instructions from the generated code.
8715 @item -mtomcat-stats
8716 @opindex mtomcat-stats
8718 Cause gas to print out tomcat statistics.
8720 @item -mcpu=@var{cpu}
8721 @opindex mcpu
8723 Select the processor type for which to generate code.  Possible values are
8724 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8725 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8727 @end table
8729 @node H8/300 Options
8730 @subsection H8/300 Options
8732 These @samp{-m} options are defined for the H8/300 implementations:
8734 @table @gcctabopt
8735 @item -mrelax
8736 @opindex mrelax
8737 Shorten some address references at link time, when possible; uses the
8738 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8739 ld, Using ld}, for a fuller description.
8741 @item -mh
8742 @opindex mh
8743 Generate code for the H8/300H@.
8745 @item -ms
8746 @opindex ms
8747 Generate code for the H8S@.
8749 @item -mn
8750 @opindex mn
8751 Generate code for the H8S and H8/300H in the normal mode.  This switch
8752 must be used either with @option{-mh} or @option{-ms}.
8754 @item -ms2600
8755 @opindex ms2600
8756 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8758 @item -mint32
8759 @opindex mint32
8760 Make @code{int} data 32 bits by default.
8762 @item -malign-300
8763 @opindex malign-300
8764 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8765 The default for the H8/300H and H8S is to align longs and floats on 4
8766 byte boundaries.
8767 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8768 This option has no effect on the H8/300.
8769 @end table
8771 @node HPPA Options
8772 @subsection HPPA Options
8773 @cindex HPPA Options
8775 These @samp{-m} options are defined for the HPPA family of computers:
8777 @table @gcctabopt
8778 @item -march=@var{architecture-type}
8779 @opindex march
8780 Generate code for the specified architecture.  The choices for
8781 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8782 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8783 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8784 architecture option for your machine.  Code compiled for lower numbered
8785 architectures will run on higher numbered architectures, but not the
8786 other way around.
8788 @item -mpa-risc-1-0
8789 @itemx -mpa-risc-1-1
8790 @itemx -mpa-risc-2-0
8791 @opindex mpa-risc-1-0
8792 @opindex mpa-risc-1-1
8793 @opindex mpa-risc-2-0
8794 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8796 @item -mbig-switch
8797 @opindex mbig-switch
8798 Generate code suitable for big switch tables.  Use this option only if
8799 the assembler/linker complain about out of range branches within a switch
8800 table.
8802 @item -mjump-in-delay
8803 @opindex mjump-in-delay
8804 Fill delay slots of function calls with unconditional jump instructions
8805 by modifying the return pointer for the function call to be the target
8806 of the conditional jump.
8808 @item -mdisable-fpregs
8809 @opindex mdisable-fpregs
8810 Prevent floating point registers from being used in any manner.  This is
8811 necessary for compiling kernels which perform lazy context switching of
8812 floating point registers.  If you use this option and attempt to perform
8813 floating point operations, the compiler will abort.
8815 @item -mdisable-indexing
8816 @opindex mdisable-indexing
8817 Prevent the compiler from using indexing address modes.  This avoids some
8818 rather obscure problems when compiling MIG generated code under MACH@.
8820 @item -mno-space-regs
8821 @opindex mno-space-regs
8822 Generate code that assumes the target has no space registers.  This allows
8823 GCC to generate faster indirect calls and use unscaled index address modes.
8825 Such code is suitable for level 0 PA systems and kernels.
8827 @item -mfast-indirect-calls
8828 @opindex mfast-indirect-calls
8829 Generate code that assumes calls never cross space boundaries.  This
8830 allows GCC to emit code which performs faster indirect calls.
8832 This option will not work in the presence of shared libraries or nested
8833 functions.
8835 @item -mfixed-range=@var{register-range}
8836 @opindex mfixed-range
8837 Generate code treating the given register range as fixed registers.
8838 A fixed register is one that the register allocator can not use.  This is
8839 useful when compiling kernel code.  A register range is specified as
8840 two registers separated by a dash.  Multiple register ranges can be
8841 specified separated by a comma.
8843 @item -mlong-load-store
8844 @opindex mlong-load-store
8845 Generate 3-instruction load and store sequences as sometimes required by
8846 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8847 the HP compilers.
8849 @item -mportable-runtime
8850 @opindex mportable-runtime
8851 Use the portable calling conventions proposed by HP for ELF systems.
8853 @item -mgas
8854 @opindex mgas
8855 Enable the use of assembler directives only GAS understands.
8857 @item -mschedule=@var{cpu-type}
8858 @opindex mschedule
8859 Schedule code according to the constraints for the machine type
8860 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8861 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8862 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8863 proper scheduling option for your machine.  The default scheduling is
8864 @samp{8000}.
8866 @item -mlinker-opt
8867 @opindex mlinker-opt
8868 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8869 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8870 linkers in which they give bogus error messages when linking some programs.
8872 @item -msoft-float
8873 @opindex msoft-float
8874 Generate output containing library calls for floating point.
8875 @strong{Warning:} the requisite libraries are not available for all HPPA
8876 targets.  Normally the facilities of the machine's usual C compiler are
8877 used, but this cannot be done directly in cross-compilation.  You must make
8878 your own arrangements to provide suitable library functions for
8879 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8880 does provide software floating point support.
8882 @option{-msoft-float} changes the calling convention in the output file;
8883 therefore, it is only useful if you compile @emph{all} of a program with
8884 this option.  In particular, you need to compile @file{libgcc.a}, the
8885 library that comes with GCC, with @option{-msoft-float} in order for
8886 this to work.
8888 @item -msio
8889 @opindex msio
8890 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8891 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8892 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8893 options are available under HP-UX and HI-UX@.
8895 @item -mgnu-ld
8896 @opindex gnu-ld
8897 Use GNU ld specific options.  This passes @option{-shared} to ld when
8898 building a shared library.  It is the default when GCC is configured,
8899 explicitly or implicitly, with the GNU linker.  This option does not
8900 have any affect on which ld is called, it only changes what parameters
8901 are passed to that ld.  The ld that is called is determined by the
8902 @option{--with-ld} configure option, GCC's program search path, and
8903 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8904 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8905 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8907 @item -mhp-ld
8908 @opindex hp-ld
8909 Use HP ld specific options.  This passes @option{-b} to ld when building
8910 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8911 links.  It is the default when GCC is configured, explicitly or
8912 implicitly, with the HP linker.  This option does not have any affect on
8913 which ld is called, it only changes what parameters are passed to that
8914 ld.  The ld that is called is determined by the @option{--with-ld}
8915 configure option, GCC's program search path, and finally by the user's
8916 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8917 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
8918 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8920 @item -mlong-calls
8921 @opindex mno-long-calls
8922 Generate code that uses long call sequences.  This ensures that a call
8923 is always able to reach linker generated stubs.  The default is to generate
8924 long calls only when the distance from the call site to the beginning
8925 of the function or translation unit, as the case may be, exceeds a
8926 predefined limit set by the branch type being used.  The limits for
8927 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8928 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8929 240,000 bytes.
8931 Distances are measured from the beginning of functions when using the
8932 @option{-ffunction-sections} option, or when using the @option{-mgas}
8933 and @option{-mno-portable-runtime} options together under HP-UX with
8934 the SOM linker.
8936 It is normally not desirable to use this option as it will degrade
8937 performance.  However, it may be useful in large applications,
8938 particularly when partial linking is used to build the application.
8940 The types of long calls used depends on the capabilities of the
8941 assembler and linker, and the type of code being generated.  The
8942 impact on systems that support long absolute calls, and long pic
8943 symbol-difference or pc-relative calls should be relatively small.
8944 However, an indirect call is used on 32-bit ELF systems in pic code
8945 and it is quite long.
8947 @item -munix=@var{unix-std}
8948 @opindex march
8949 Generate compiler predefines and select a startfile for the specified
8950 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8951 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8952 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8953 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8954 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8955 and later.
8957 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8958 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8959 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8960 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8961 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8962 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8964 It is @emph{important} to note that this option changes the interfaces
8965 for various library routines.  It also affects the operational behavior
8966 of the C library.  Thus, @emph{extreme} care is needed in using this
8967 option.
8969 Library code that is intended to operate with more than one UNIX
8970 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8971 as appropriate.  Most GNU software doesn't provide this capability.
8973 @item -nolibdld
8974 @opindex nolibdld
8975 Suppress the generation of link options to search libdld.sl when the
8976 @option{-static} option is specified on HP-UX 10 and later.
8978 @item -static
8979 @opindex static
8980 The HP-UX implementation of setlocale in libc has a dependency on
8981 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8982 when the @option{-static} option is specified, special link options
8983 are needed to resolve this dependency.
8985 On HP-UX 10 and later, the GCC driver adds the necessary options to
8986 link with libdld.sl when the @option{-static} option is specified.
8987 This causes the resulting binary to be dynamic.  On the 64-bit port,
8988 the linkers generate dynamic binaries by default in any case.  The
8989 @option{-nolibdld} option can be used to prevent the GCC driver from
8990 adding these link options.
8992 @item -threads
8993 @opindex threads
8994 Add support for multithreading with the @dfn{dce thread} library
8995 under HP-UX@.  This option sets flags for both the preprocessor and
8996 linker.
8997 @end table
8999 @node i386 and x86-64 Options
9000 @subsection Intel 386 and AMD x86-64 Options
9001 @cindex i386 Options
9002 @cindex x86-64 Options
9003 @cindex Intel 386 Options
9004 @cindex AMD x86-64 Options
9006 These @samp{-m} options are defined for the i386 and x86-64 family of
9007 computers:
9009 @table @gcctabopt
9010 @item -mtune=@var{cpu-type}
9011 @opindex mtune
9012 Tune to @var{cpu-type} everything applicable about the generated code, except
9013 for the ABI and the set of available instructions.  The choices for
9014 @var{cpu-type} are:
9015 @table @emph
9016 @item i386
9017 Original Intel's i386 CPU@.
9018 @item i486
9019 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9020 @item i586, pentium
9021 Intel Pentium CPU with no MMX support.
9022 @item pentium-mmx
9023 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9024 @item i686, pentiumpro
9025 Intel PentiumPro CPU@.
9026 @item pentium2
9027 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9028 @item pentium3, pentium3m
9029 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9030 support.
9031 @item pentium-m
9032 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9033 support.  Used by Centrino notebooks.
9034 @item pentium4, pentium4m
9035 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9036 @item prescott
9037 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9038 set support.
9039 @item nocona
9040 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9041 SSE2 and SSE3 instruction set support.
9042 @item k6
9043 AMD K6 CPU with MMX instruction set support.
9044 @item k6-2, k6-3
9045 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9046 @item athlon, athlon-tbird
9047 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9048 support.
9049 @item athlon-4, athlon-xp, athlon-mp
9050 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9051 instruction set support.
9052 @item k8, opteron, athlon64, athlon-fx
9053 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9054 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9055 @item winchip-c6
9056 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9057 set support.
9058 @item winchip2
9059 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9060 instruction set support.
9061 @item c3
9062 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9063 implemented for this chip.)
9064 @item c3-2
9065 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9066 implemented for this chip.)
9067 @end table
9069 While picking a specific @var{cpu-type} will schedule things appropriately
9070 for that particular chip, the compiler will not generate any code that
9071 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9072 being used.
9074 @item -march=@var{cpu-type}
9075 @opindex march
9076 Generate instructions for the machine type @var{cpu-type}.  The choices
9077 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9078 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9080 @item -mcpu=@var{cpu-type}
9081 @opindex mcpu
9082 A deprecated synonym for @option{-mtune}.
9084 @item -m386
9085 @itemx -m486
9086 @itemx -mpentium
9087 @itemx -mpentiumpro
9088 @opindex m386
9089 @opindex m486
9090 @opindex mpentium
9091 @opindex mpentiumpro
9092 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9093 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9094 These synonyms are deprecated.
9096 @item -mfpmath=@var{unit}
9097 @opindex march
9098 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9099 for @var{unit} are:
9101 @table @samp
9102 @item 387
9103 Use the standard 387 floating point coprocessor present majority of chips and
9104 emulated otherwise.  Code compiled with this option will run almost everywhere.
9105 The temporary results are computed in 80bit precision instead of precision
9106 specified by the type resulting in slightly different results compared to most
9107 of other chips.  See @option{-ffloat-store} for more detailed description.
9109 This is the default choice for i386 compiler.
9111 @item sse
9112 Use scalar floating point instructions present in the SSE instruction set.
9113 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9114 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9115 instruction set supports only single precision arithmetics, thus the double and
9116 extended precision arithmetics is still done using 387.  Later version, present
9117 only in Pentium4 and the future AMD x86-64 chips supports double precision
9118 arithmetics too.
9120 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9121 or @option{-msse2} switches to enable SSE extensions and make this option
9122 effective.  For the x86-64 compiler, these extensions are enabled by default.
9124 The resulting code should be considerably faster in the majority of cases and avoid
9125 the numerical instability problems of 387 code, but may break some existing
9126 code that expects temporaries to be 80bit.
9128 This is the default choice for the x86-64 compiler.
9130 @item sse,387
9131 Attempt to utilize both instruction sets at once.  This effectively double the
9132 amount of available registers and on chips with separate execution units for
9133 387 and SSE the execution resources too.  Use this option with care, as it is
9134 still experimental, because the GCC register allocator does not model separate
9135 functional units well resulting in instable performance.
9136 @end table
9138 @item -masm=@var{dialect}
9139 @opindex masm=@var{dialect}
9140 Output asm instructions using selected @var{dialect}.  Supported
9141 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9142 not support @samp{intel}.
9144 @item -mieee-fp
9145 @itemx -mno-ieee-fp
9146 @opindex mieee-fp
9147 @opindex mno-ieee-fp
9148 Control whether or not the compiler uses IEEE floating point
9149 comparisons.  These handle correctly the case where the result of a
9150 comparison is unordered.
9152 @item -msoft-float
9153 @opindex msoft-float
9154 Generate output containing library calls for floating point.
9155 @strong{Warning:} the requisite libraries are not part of GCC@.
9156 Normally the facilities of the machine's usual C compiler are used, but
9157 this can't be done directly in cross-compilation.  You must make your
9158 own arrangements to provide suitable library functions for
9159 cross-compilation.
9161 On machines where a function returns floating point results in the 80387
9162 register stack, some floating point opcodes may be emitted even if
9163 @option{-msoft-float} is used.
9165 @item -mno-fp-ret-in-387
9166 @opindex mno-fp-ret-in-387
9167 Do not use the FPU registers for return values of functions.
9169 The usual calling convention has functions return values of types
9170 @code{float} and @code{double} in an FPU register, even if there
9171 is no FPU@.  The idea is that the operating system should emulate
9172 an FPU@.
9174 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9175 in ordinary CPU registers instead.
9177 @item -mno-fancy-math-387
9178 @opindex mno-fancy-math-387
9179 Some 387 emulators do not support the @code{sin}, @code{cos} and
9180 @code{sqrt} instructions for the 387.  Specify this option to avoid
9181 generating those instructions.  This option is the default on FreeBSD,
9182 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9183 indicates that the target cpu will always have an FPU and so the
9184 instruction will not need emulation.  As of revision 2.6.1, these
9185 instructions are not generated unless you also use the
9186 @option{-funsafe-math-optimizations} switch.
9188 @item -malign-double
9189 @itemx -mno-align-double
9190 @opindex malign-double
9191 @opindex mno-align-double
9192 Control whether GCC aligns @code{double}, @code{long double}, and
9193 @code{long long} variables on a two word boundary or a one word
9194 boundary.  Aligning @code{double} variables on a two word boundary will
9195 produce code that runs somewhat faster on a @samp{Pentium} at the
9196 expense of more memory.
9198 @strong{Warning:} if you use the @option{-malign-double} switch,
9199 structures containing the above types will be aligned differently than
9200 the published application binary interface specifications for the 386
9201 and will not be binary compatible with structures in code compiled
9202 without that switch.
9204 @item -m96bit-long-double
9205 @itemx -m128bit-long-double
9206 @opindex m96bit-long-double
9207 @opindex m128bit-long-double
9208 These switches control the size of @code{long double} type.  The i386
9209 application binary interface specifies the size to be 96 bits,
9210 so @option{-m96bit-long-double} is the default in 32 bit mode.
9212 Modern architectures (Pentium and newer) would prefer @code{long double}
9213 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9214 conforming to the ABI, this would not be possible.  So specifying a
9215 @option{-m128bit-long-double} will align @code{long double}
9216 to a 16 byte boundary by padding the @code{long double} with an additional
9217 32 bit zero.
9219 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9220 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9222 Notice that neither of these options enable any extra precision over the x87
9223 standard of 80 bits for a @code{long double}.
9225 @strong{Warning:} if you override the default value for your target ABI, the
9226 structures and arrays containing @code{long double} variables will change
9227 their size as well as function calling convention for function taking
9228 @code{long double} will be modified.  Hence they will not be binary
9229 compatible with arrays or structures in code compiled without that switch.
9231 @item -mmlarge-data-threshold=@var{number}
9232 @opindex mlarge-data-threshold=@var{number}
9233 When @option{-mcmodel=medium} is specified, the data greater than
9234 @var{threshold} are placed in large data section.  This value must be the
9235 same across all object linked into the binary and defaults to 65535.
9237 @item -msvr3-shlib
9238 @itemx -mno-svr3-shlib
9239 @opindex msvr3-shlib
9240 @opindex mno-svr3-shlib
9241 Control whether GCC places uninitialized local variables into the
9242 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9243 into @code{bss}.  These options are meaningful only on System V Release 3.
9245 @item -mrtd
9246 @opindex mrtd
9247 Use a different function-calling convention, in which functions that
9248 take a fixed number of arguments return with the @code{ret} @var{num}
9249 instruction, which pops their arguments while returning.  This saves one
9250 instruction in the caller since there is no need to pop the arguments
9251 there.
9253 You can specify that an individual function is called with this calling
9254 sequence with the function attribute @samp{stdcall}.  You can also
9255 override the @option{-mrtd} option by using the function attribute
9256 @samp{cdecl}.  @xref{Function Attributes}.
9258 @strong{Warning:} this calling convention is incompatible with the one
9259 normally used on Unix, so you cannot use it if you need to call
9260 libraries compiled with the Unix compiler.
9262 Also, you must provide function prototypes for all functions that
9263 take variable numbers of arguments (including @code{printf});
9264 otherwise incorrect code will be generated for calls to those
9265 functions.
9267 In addition, seriously incorrect code will result if you call a
9268 function with too many arguments.  (Normally, extra arguments are
9269 harmlessly ignored.)
9271 @item -mregparm=@var{num}
9272 @opindex mregparm
9273 Control how many registers are used to pass integer arguments.  By
9274 default, no registers are used to pass arguments, and at most 3
9275 registers can be used.  You can control this behavior for a specific
9276 function by using the function attribute @samp{regparm}.
9277 @xref{Function Attributes}.
9279 @strong{Warning:} if you use this switch, and
9280 @var{num} is nonzero, then you must build all modules with the same
9281 value, including any libraries.  This includes the system libraries and
9282 startup modules.
9284 @item -msseregparm
9285 @opindex msseregparm
9286 Use SSE register passing conventions for float and double arguments
9287 and return values.  You can control this behavior for a specific
9288 function by using the function attribute @samp{sseregparm}.
9289 @xref{Function Attributes}.
9291 @strong{Warning:} if you use this switch then you must build all
9292 modules with the same value, including any libraries.  This includes
9293 the system libraries and startup modules.
9295 @item -mpreferred-stack-boundary=@var{num}
9296 @opindex mpreferred-stack-boundary
9297 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9298 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9299 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9300 size (@option{-Os}), in which case the default is the minimum correct
9301 alignment (4 bytes for x86, and 8 bytes for x86-64).
9303 On Pentium and PentiumPro, @code{double} and @code{long double} values
9304 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9305 suffer significant run time performance penalties.  On Pentium III, the
9306 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9307 penalties if it is not 16 byte aligned.
9309 To ensure proper alignment of this values on the stack, the stack boundary
9310 must be as aligned as that required by any value stored on the stack.
9311 Further, every function must be generated such that it keeps the stack
9312 aligned.  Thus calling a function compiled with a higher preferred
9313 stack boundary from a function compiled with a lower preferred stack
9314 boundary will most likely misalign the stack.  It is recommended that
9315 libraries that use callbacks always use the default setting.
9317 This extra alignment does consume extra stack space, and generally
9318 increases code size.  Code that is sensitive to stack space usage, such
9319 as embedded systems and operating system kernels, may want to reduce the
9320 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9322 @item -mmmx
9323 @itemx -mno-mmx
9324 @item -msse
9325 @itemx -mno-sse
9326 @item -msse2
9327 @itemx -mno-sse2
9328 @item -msse3
9329 @itemx -mno-sse3
9330 @item -m3dnow
9331 @itemx -mno-3dnow
9332 @opindex mmmx
9333 @opindex mno-mmx
9334 @opindex msse
9335 @opindex mno-sse
9336 @opindex m3dnow
9337 @opindex mno-3dnow
9338 These switches enable or disable the use of instructions in the MMX,
9339 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9340 also available as built-in functions: see @ref{X86 Built-in Functions},
9341 for details of the functions enabled and disabled by these switches.
9343 To have SSE/SSE2 instructions generated automatically from floating-point
9344 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9346 These options will enable GCC to use these extended instructions in
9347 generated code, even without @option{-mfpmath=sse}.  Applications which
9348 perform runtime CPU detection must compile separate files for each
9349 supported architecture, using the appropriate flags.  In particular,
9350 the file containing the CPU detection code should be compiled without
9351 these options.
9353 @item -mpush-args
9354 @itemx -mno-push-args
9355 @opindex mpush-args
9356 @opindex mno-push-args
9357 Use PUSH operations to store outgoing parameters.  This method is shorter
9358 and usually equally fast as method using SUB/MOV operations and is enabled
9359 by default.  In some cases disabling it may improve performance because of
9360 improved scheduling and reduced dependencies.
9362 @item -maccumulate-outgoing-args
9363 @opindex maccumulate-outgoing-args
9364 If enabled, the maximum amount of space required for outgoing arguments will be
9365 computed in the function prologue.  This is faster on most modern CPUs
9366 because of reduced dependencies, improved scheduling and reduced stack usage
9367 when preferred stack boundary is not equal to 2.  The drawback is a notable
9368 increase in code size.  This switch implies @option{-mno-push-args}.
9370 @item -mthreads
9371 @opindex mthreads
9372 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9373 on thread-safe exception handling must compile and link all code with the
9374 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9375 @option{-D_MT}; when linking, it links in a special thread helper library
9376 @option{-lmingwthrd} which cleans up per thread exception handling data.
9378 @item -mno-align-stringops
9379 @opindex mno-align-stringops
9380 Do not align destination of inlined string operations.  This switch reduces
9381 code size and improves performance in case the destination is already aligned,
9382 but GCC doesn't know about it.
9384 @item -minline-all-stringops
9385 @opindex minline-all-stringops
9386 By default GCC inlines string operations only when destination is known to be
9387 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9388 size, but may improve performance of code that depends on fast memcpy, strlen
9389 and memset for short lengths.
9391 @item -momit-leaf-frame-pointer
9392 @opindex momit-leaf-frame-pointer
9393 Don't keep the frame pointer in a register for leaf functions.  This
9394 avoids the instructions to save, set up and restore frame pointers and
9395 makes an extra register available in leaf functions.  The option
9396 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9397 which might make debugging harder.
9399 @item -mtls-direct-seg-refs
9400 @itemx -mno-tls-direct-seg-refs
9401 @opindex mtls-direct-seg-refs
9402 Controls whether TLS variables may be accessed with offsets from the
9403 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9404 or whether the thread base pointer must be added.  Whether or not this
9405 is legal depends on the operating system, and whether it maps the
9406 segment to cover the entire TLS area.
9408 For systems that use GNU libc, the default is on.
9409 @end table
9411 These @samp{-m} switches are supported in addition to the above
9412 on AMD x86-64 processors in 64-bit environments.
9414 @table @gcctabopt
9415 @item -m32
9416 @itemx -m64
9417 @opindex m32
9418 @opindex m64
9419 Generate code for a 32-bit or 64-bit environment.
9420 The 32-bit environment sets int, long and pointer to 32 bits and
9421 generates code that runs on any i386 system.
9422 The 64-bit environment sets int to 32 bits and long and pointer
9423 to 64 bits and generates code for AMD's x86-64 architecture.
9425 @item -mno-red-zone
9426 @opindex no-red-zone
9427 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9428 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9429 stack pointer that will not be modified by signal or interrupt handlers
9430 and therefore can be used for temporary data without adjusting the stack
9431 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9433 @item -mcmodel=small
9434 @opindex mcmodel=small
9435 Generate code for the small code model: the program and its symbols must
9436 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9437 Programs can be statically or dynamically linked.  This is the default
9438 code model.
9440 @item -mcmodel=kernel
9441 @opindex mcmodel=kernel
9442 Generate code for the kernel code model.  The kernel runs in the
9443 negative 2 GB of the address space.
9444 This model has to be used for Linux kernel code.
9446 @item -mcmodel=medium
9447 @opindex mcmodel=medium
9448 Generate code for the medium model: The program is linked in the lower 2
9449 GB of the address space but symbols can be located anywhere in the
9450 address space.  Programs can be statically or dynamically linked, but
9451 building of shared libraries are not supported with the medium model.
9453 @item -mcmodel=large
9454 @opindex mcmodel=large
9455 Generate code for the large model: This model makes no assumptions
9456 about addresses and sizes of sections.  Currently GCC does not implement
9457 this model.
9458 @end table
9460 @node IA-64 Options
9461 @subsection IA-64 Options
9462 @cindex IA-64 Options
9464 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9466 @table @gcctabopt
9467 @item -mbig-endian
9468 @opindex mbig-endian
9469 Generate code for a big endian target.  This is the default for HP-UX@.
9471 @item -mlittle-endian
9472 @opindex mlittle-endian
9473 Generate code for a little endian target.  This is the default for AIX5
9474 and GNU/Linux.
9476 @item -mgnu-as
9477 @itemx -mno-gnu-as
9478 @opindex mgnu-as
9479 @opindex mno-gnu-as
9480 Generate (or don't) code for the GNU assembler.  This is the default.
9481 @c Also, this is the default if the configure option @option{--with-gnu-as}
9482 @c is used.
9484 @item -mgnu-ld
9485 @itemx -mno-gnu-ld
9486 @opindex mgnu-ld
9487 @opindex mno-gnu-ld
9488 Generate (or don't) code for the GNU linker.  This is the default.
9489 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9490 @c is used.
9492 @item -mno-pic
9493 @opindex mno-pic
9494 Generate code that does not use a global pointer register.  The result
9495 is not position independent code, and violates the IA-64 ABI@.
9497 @item -mvolatile-asm-stop
9498 @itemx -mno-volatile-asm-stop
9499 @opindex mvolatile-asm-stop
9500 @opindex mno-volatile-asm-stop
9501 Generate (or don't) a stop bit immediately before and after volatile asm
9502 statements.
9504 @item -mregister-names
9505 @itemx -mno-register-names
9506 @opindex mregister-names
9507 @opindex mno-register-names
9508 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9509 the stacked registers.  This may make assembler output more readable.
9511 @item -mno-sdata
9512 @itemx -msdata
9513 @opindex mno-sdata
9514 @opindex msdata
9515 Disable (or enable) optimizations that use the small data section.  This may
9516 be useful for working around optimizer bugs.
9518 @item -mconstant-gp
9519 @opindex mconstant-gp
9520 Generate code that uses a single constant global pointer value.  This is
9521 useful when compiling kernel code.
9523 @item -mauto-pic
9524 @opindex mauto-pic
9525 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9526 This is useful when compiling firmware code.
9528 @item -minline-float-divide-min-latency
9529 @opindex minline-float-divide-min-latency
9530 Generate code for inline divides of floating point values
9531 using the minimum latency algorithm.
9533 @item -minline-float-divide-max-throughput
9534 @opindex minline-float-divide-max-throughput
9535 Generate code for inline divides of floating point values
9536 using the maximum throughput algorithm.
9538 @item -minline-int-divide-min-latency
9539 @opindex minline-int-divide-min-latency
9540 Generate code for inline divides of integer values
9541 using the minimum latency algorithm.
9543 @item -minline-int-divide-max-throughput
9544 @opindex minline-int-divide-max-throughput
9545 Generate code for inline divides of integer values
9546 using the maximum throughput algorithm.
9548 @item -minline-sqrt-min-latency
9549 @opindex minline-sqrt-min-latency
9550 Generate code for inline square roots
9551 using the minimum latency algorithm.
9553 @item -minline-sqrt-max-throughput
9554 @opindex minline-sqrt-max-throughput
9555 Generate code for inline square roots
9556 using the maximum throughput algorithm.
9558 @item -mno-dwarf2-asm
9559 @itemx -mdwarf2-asm
9560 @opindex mno-dwarf2-asm
9561 @opindex mdwarf2-asm
9562 Don't (or do) generate assembler code for the DWARF2 line number debugging
9563 info.  This may be useful when not using the GNU assembler.
9565 @item -mearly-stop-bits
9566 @itemx -mno-early-stop-bits
9567 @opindex mearly-stop-bits
9568 @opindex mno-early-stop-bits
9569 Allow stop bits to be placed earlier than immediately preceding the
9570 instruction that triggered the stop bit.  This can improve instruction
9571 scheduling, but does not always do so.
9573 @item -mfixed-range=@var{register-range}
9574 @opindex mfixed-range
9575 Generate code treating the given register range as fixed registers.
9576 A fixed register is one that the register allocator can not use.  This is
9577 useful when compiling kernel code.  A register range is specified as
9578 two registers separated by a dash.  Multiple register ranges can be
9579 specified separated by a comma.
9581 @item -mtls-size=@var{tls-size}
9582 @opindex mtls-size
9583 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9586 @item -mtune=@var{cpu-type}
9587 @opindex mtune
9588 Tune the instruction scheduling for a particular CPU, Valid values are
9589 itanium, itanium1, merced, itanium2, and mckinley.
9591 @item -mt
9592 @itemx -pthread
9593 @opindex mt
9594 @opindex pthread
9595 Add support for multithreading using the POSIX threads library.  This
9596 option sets flags for both the preprocessor and linker.  It does
9597 not affect the thread safety of object code produced by the compiler or
9598 that of libraries supplied with it.  These are HP-UX specific flags.
9600 @item -milp32
9601 @itemx -mlp64
9602 @opindex milp32
9603 @opindex mlp64
9604 Generate code for a 32-bit or 64-bit environment.
9605 The 32-bit environment sets int, long and pointer to 32 bits.
9606 The 64-bit environment sets int to 32 bits and long and pointer
9607 to 64 bits.  These are HP-UX specific flags.
9609 @end table
9611 @node M32C Options
9612 @subsection M32C Options
9613 @cindex M32C options
9615 @table @gcctabopt
9616 @item -mcpu=@var{name}
9617 @opindex mcpu=
9618 Select the CPU for which code is generated.  @var{name} may be one of
9619 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9620 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9621 the M32C/80 series.
9623 @item -msim
9624 @opindex msim
9625 Specifies that the program will be run on the simulator.  This causes
9626 an alternate runtime library to be linked in which supports, for
9627 example, file I/O.  You must not use this option when generating
9628 programs that will run on real hardware; you must provide your own
9629 runtime library for whatever I/O functions are needed.
9631 @item -memregs=@var{number}
9632 @opindex memregs=
9633 Specifies the number of memory-based pseudo-registers GCC will use
9634 during code generation.  These pseudo-registers will be used like real
9635 registers, so there is a tradeoff between GCC's ability to fit the
9636 code into available registers, and the performance penalty of using
9637 memory instead of registers.  Note that all modules in a program must
9638 be compiled with the same value for this option.  Because of that, you
9639 must not use this option with the default runtime libraries gcc
9640 builds.
9642 @end table
9644 @node M32R/D Options
9645 @subsection M32R/D Options
9646 @cindex M32R/D options
9648 These @option{-m} options are defined for Renesas M32R/D architectures:
9650 @table @gcctabopt
9651 @item -m32r2
9652 @opindex m32r2
9653 Generate code for the M32R/2@.
9655 @item -m32rx
9656 @opindex m32rx
9657 Generate code for the M32R/X@.
9659 @item -m32r
9660 @opindex m32r
9661 Generate code for the M32R@.  This is the default.
9663 @item -mmodel=small
9664 @opindex mmodel=small
9665 Assume all objects live in the lower 16MB of memory (so that their addresses
9666 can be loaded with the @code{ld24} instruction), and assume all subroutines
9667 are reachable with the @code{bl} instruction.
9668 This is the default.
9670 The addressability of a particular object can be set with the
9671 @code{model} attribute.
9673 @item -mmodel=medium
9674 @opindex mmodel=medium
9675 Assume objects may be anywhere in the 32-bit address space (the compiler
9676 will generate @code{seth/add3} instructions to load their addresses), and
9677 assume all subroutines are reachable with the @code{bl} instruction.
9679 @item -mmodel=large
9680 @opindex mmodel=large
9681 Assume objects may be anywhere in the 32-bit address space (the compiler
9682 will generate @code{seth/add3} instructions to load their addresses), and
9683 assume subroutines may not be reachable with the @code{bl} instruction
9684 (the compiler will generate the much slower @code{seth/add3/jl}
9685 instruction sequence).
9687 @item -msdata=none
9688 @opindex msdata=none
9689 Disable use of the small data area.  Variables will be put into
9690 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9691 @code{section} attribute has been specified).
9692 This is the default.
9694 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9695 Objects may be explicitly put in the small data area with the
9696 @code{section} attribute using one of these sections.
9698 @item -msdata=sdata
9699 @opindex msdata=sdata
9700 Put small global and static data in the small data area, but do not
9701 generate special code to reference them.
9703 @item -msdata=use
9704 @opindex msdata=use
9705 Put small global and static data in the small data area, and generate
9706 special instructions to reference them.
9708 @item -G @var{num}
9709 @opindex G
9710 @cindex smaller data references
9711 Put global and static objects less than or equal to @var{num} bytes
9712 into the small data or bss sections instead of the normal data or bss
9713 sections.  The default value of @var{num} is 8.
9714 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9715 for this option to have any effect.
9717 All modules should be compiled with the same @option{-G @var{num}} value.
9718 Compiling with different values of @var{num} may or may not work; if it
9719 doesn't the linker will give an error message---incorrect code will not be
9720 generated.
9722 @item -mdebug
9723 @opindex mdebug
9724 Makes the M32R specific code in the compiler display some statistics
9725 that might help in debugging programs.
9727 @item -malign-loops
9728 @opindex malign-loops
9729 Align all loops to a 32-byte boundary.
9731 @item -mno-align-loops
9732 @opindex mno-align-loops
9733 Do not enforce a 32-byte alignment for loops.  This is the default.
9735 @item -missue-rate=@var{number}
9736 @opindex missue-rate=@var{number}
9737 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9738 or 2.
9740 @item -mbranch-cost=@var{number}
9741 @opindex mbranch-cost=@var{number}
9742 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9743 preferred over conditional code, if it is 2, then the opposite will
9744 apply.
9746 @item -mflush-trap=@var{number}
9747 @opindex mflush-trap=@var{number}
9748 Specifies the trap number to use to flush the cache.  The default is
9749 12.  Valid numbers are between 0 and 15 inclusive.
9751 @item -mno-flush-trap
9752 @opindex mno-flush-trap
9753 Specifies that the cache cannot be flushed by using a trap.
9755 @item -mflush-func=@var{name}
9756 @opindex mflush-func=@var{name}
9757 Specifies the name of the operating system function to call to flush
9758 the cache.  The default is @emph{_flush_cache}, but a function call
9759 will only be used if a trap is not available.
9761 @item -mno-flush-func
9762 @opindex mno-flush-func
9763 Indicates that there is no OS function for flushing the cache.
9765 @end table
9767 @node M680x0 Options
9768 @subsection M680x0 Options
9769 @cindex M680x0 options
9771 These are the @samp{-m} options defined for the 68000 series.  The default
9772 values for these options depends on which style of 68000 was selected when
9773 the compiler was configured; the defaults for the most common choices are
9774 given below.
9776 @table @gcctabopt
9777 @item -m68000
9778 @itemx -mc68000
9779 @opindex m68000
9780 @opindex mc68000
9781 Generate output for a 68000.  This is the default
9782 when the compiler is configured for 68000-based systems.
9784 Use this option for microcontrollers with a 68000 or EC000 core,
9785 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9787 @item -m68020
9788 @itemx -mc68020
9789 @opindex m68020
9790 @opindex mc68020
9791 Generate output for a 68020.  This is the default
9792 when the compiler is configured for 68020-based systems.
9794 @item -m68881
9795 @opindex m68881
9796 Generate output containing 68881 instructions for floating point.
9797 This is the default for most 68020 systems unless @option{--nfp} was
9798 specified when the compiler was configured.
9800 @item -m68030
9801 @opindex m68030
9802 Generate output for a 68030.  This is the default when the compiler is
9803 configured for 68030-based systems.
9805 @item -m68040
9806 @opindex m68040
9807 Generate output for a 68040.  This is the default when the compiler is
9808 configured for 68040-based systems.
9810 This option inhibits the use of 68881/68882 instructions that have to be
9811 emulated by software on the 68040.  Use this option if your 68040 does not
9812 have code to emulate those instructions.
9814 @item -m68060
9815 @opindex m68060
9816 Generate output for a 68060.  This is the default when the compiler is
9817 configured for 68060-based systems.
9819 This option inhibits the use of 68020 and 68881/68882 instructions that
9820 have to be emulated by software on the 68060.  Use this option if your 68060
9821 does not have code to emulate those instructions.
9823 @item -mcpu32
9824 @opindex mcpu32
9825 Generate output for a CPU32.  This is the default
9826 when the compiler is configured for CPU32-based systems.
9828 Use this option for microcontrollers with a
9829 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9830 68336, 68340, 68341, 68349 and 68360.
9832 @item -m5200
9833 @opindex m5200
9834 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9835 when the compiler is configured for 520X-based systems.
9837 Use this option for microcontroller with a 5200 core, including
9838 the MCF5202, MCF5203, MCF5204 and MCF5202.
9841 @item -m68020-40
9842 @opindex m68020-40
9843 Generate output for a 68040, without using any of the new instructions.
9844 This results in code which can run relatively efficiently on either a
9845 68020/68881 or a 68030 or a 68040.  The generated code does use the
9846 68881 instructions that are emulated on the 68040.
9848 @item -m68020-60
9849 @opindex m68020-60
9850 Generate output for a 68060, without using any of the new instructions.
9851 This results in code which can run relatively efficiently on either a
9852 68020/68881 or a 68030 or a 68040.  The generated code does use the
9853 68881 instructions that are emulated on the 68060.
9855 @item -msoft-float
9856 @opindex msoft-float
9857 Generate output containing library calls for floating point.
9858 @strong{Warning:} the requisite libraries are not available for all m68k
9859 targets.  Normally the facilities of the machine's usual C compiler are
9860 used, but this can't be done directly in cross-compilation.  You must
9861 make your own arrangements to provide suitable library functions for
9862 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9863 @samp{m68k-*-coff} do provide software floating point support.
9865 @item -mshort
9866 @opindex mshort
9867 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9868 Additionally, parameters passed on the stack are also aligned to a
9869 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9871 @item -mnobitfield
9872 @opindex mnobitfield
9873 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9874 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9876 @item -mbitfield
9877 @opindex mbitfield
9878 Do use the bit-field instructions.  The @option{-m68020} option implies
9879 @option{-mbitfield}.  This is the default if you use a configuration
9880 designed for a 68020.
9882 @item -mrtd
9883 @opindex mrtd
9884 Use a different function-calling convention, in which functions
9885 that take a fixed number of arguments return with the @code{rtd}
9886 instruction, which pops their arguments while returning.  This
9887 saves one instruction in the caller since there is no need to pop
9888 the arguments there.
9890 This calling convention is incompatible with the one normally
9891 used on Unix, so you cannot use it if you need to call libraries
9892 compiled with the Unix compiler.
9894 Also, you must provide function prototypes for all functions that
9895 take variable numbers of arguments (including @code{printf});
9896 otherwise incorrect code will be generated for calls to those
9897 functions.
9899 In addition, seriously incorrect code will result if you call a
9900 function with too many arguments.  (Normally, extra arguments are
9901 harmlessly ignored.)
9903 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9904 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9906 @item -malign-int
9907 @itemx -mno-align-int
9908 @opindex malign-int
9909 @opindex mno-align-int
9910 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9911 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9912 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9913 Aligning variables on 32-bit boundaries produces code that runs somewhat
9914 faster on processors with 32-bit busses at the expense of more memory.
9916 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9917 align structures containing the above types  differently than
9918 most published application binary interface specifications for the m68k.
9920 @item -mpcrel
9921 @opindex mpcrel
9922 Use the pc-relative addressing mode of the 68000 directly, instead of
9923 using a global offset table.  At present, this option implies @option{-fpic},
9924 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9925 not presently supported with @option{-mpcrel}, though this could be supported for
9926 68020 and higher processors.
9928 @item -mno-strict-align
9929 @itemx -mstrict-align
9930 @opindex mno-strict-align
9931 @opindex mstrict-align
9932 Do not (do) assume that unaligned memory references will be handled by
9933 the system.
9935 @item -msep-data
9936 Generate code that allows the data segment to be located in a different
9937 area of memory from the text segment.  This allows for execute in place in
9938 an environment without virtual memory management.  This option implies
9939 @option{-fPIC}.
9941 @item -mno-sep-data
9942 Generate code that assumes that the data segment follows the text segment.
9943 This is the default.
9945 @item -mid-shared-library
9946 Generate code that supports shared libraries via the library ID method.
9947 This allows for execute in place and shared libraries in an environment
9948 without virtual memory management.  This option implies @option{-fPIC}.
9950 @item -mno-id-shared-library
9951 Generate code that doesn't assume ID based shared libraries are being used.
9952 This is the default.
9954 @item -mshared-library-id=n
9955 Specified the identification number of the ID based shared library being
9956 compiled.  Specifying a value of 0 will generate more compact code, specifying
9957 other values will force the allocation of that number to the current
9958 library but is no more space or time efficient than omitting this option.
9960 @end table
9962 @node M68hc1x Options
9963 @subsection M68hc1x Options
9964 @cindex M68hc1x options
9966 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9967 microcontrollers.  The default values for these options depends on
9968 which style of microcontroller was selected when the compiler was configured;
9969 the defaults for the most common choices are given below.
9971 @table @gcctabopt
9972 @item -m6811
9973 @itemx -m68hc11
9974 @opindex m6811
9975 @opindex m68hc11
9976 Generate output for a 68HC11.  This is the default
9977 when the compiler is configured for 68HC11-based systems.
9979 @item -m6812
9980 @itemx -m68hc12
9981 @opindex m6812
9982 @opindex m68hc12
9983 Generate output for a 68HC12.  This is the default
9984 when the compiler is configured for 68HC12-based systems.
9986 @item -m68S12
9987 @itemx -m68hcs12
9988 @opindex m68S12
9989 @opindex m68hcs12
9990 Generate output for a 68HCS12.
9992 @item -mauto-incdec
9993 @opindex mauto-incdec
9994 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9995 addressing modes.
9997 @item -minmax
9998 @itemx -nominmax
9999 @opindex minmax
10000 @opindex mnominmax
10001 Enable the use of 68HC12 min and max instructions.
10003 @item -mlong-calls
10004 @itemx -mno-long-calls
10005 @opindex mlong-calls
10006 @opindex mno-long-calls
10007 Treat all calls as being far away (near).  If calls are assumed to be
10008 far away, the compiler will use the @code{call} instruction to
10009 call a function and the @code{rtc} instruction for returning.
10011 @item -mshort
10012 @opindex mshort
10013 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10015 @item -msoft-reg-count=@var{count}
10016 @opindex msoft-reg-count
10017 Specify the number of pseudo-soft registers which are used for the
10018 code generation.  The maximum number is 32.  Using more pseudo-soft
10019 register may or may not result in better code depending on the program.
10020 The default is 4 for 68HC11 and 2 for 68HC12.
10022 @end table
10024 @node MCore Options
10025 @subsection MCore Options
10026 @cindex MCore options
10028 These are the @samp{-m} options defined for the Motorola M*Core
10029 processors.
10031 @table @gcctabopt
10033 @item -mhardlit
10034 @itemx -mno-hardlit
10035 @opindex mhardlit
10036 @opindex mno-hardlit
10037 Inline constants into the code stream if it can be done in two
10038 instructions or less.
10040 @item -mdiv
10041 @itemx -mno-div
10042 @opindex mdiv
10043 @opindex mno-div
10044 Use the divide instruction.  (Enabled by default).
10046 @item -mrelax-immediate
10047 @itemx -mno-relax-immediate
10048 @opindex mrelax-immediate
10049 @opindex mno-relax-immediate
10050 Allow arbitrary sized immediates in bit operations.
10052 @item -mwide-bitfields
10053 @itemx -mno-wide-bitfields
10054 @opindex mwide-bitfields
10055 @opindex mno-wide-bitfields
10056 Always treat bit-fields as int-sized.
10058 @item -m4byte-functions
10059 @itemx -mno-4byte-functions
10060 @opindex m4byte-functions
10061 @opindex mno-4byte-functions
10062 Force all functions to be aligned to a four byte boundary.
10064 @item -mcallgraph-data
10065 @itemx -mno-callgraph-data
10066 @opindex mcallgraph-data
10067 @opindex mno-callgraph-data
10068 Emit callgraph information.
10070 @item -mslow-bytes
10071 @itemx -mno-slow-bytes
10072 @opindex mslow-bytes
10073 @opindex mno-slow-bytes
10074 Prefer word access when reading byte quantities.
10076 @item -mlittle-endian
10077 @itemx -mbig-endian
10078 @opindex mlittle-endian
10079 @opindex mbig-endian
10080 Generate code for a little endian target.
10082 @item -m210
10083 @itemx -m340
10084 @opindex m210
10085 @opindex m340
10086 Generate code for the 210 processor.
10087 @end table
10089 @node MIPS Options
10090 @subsection MIPS Options
10091 @cindex MIPS options
10093 @table @gcctabopt
10095 @item -EB
10096 @opindex EB
10097 Generate big-endian code.
10099 @item -EL
10100 @opindex EL
10101 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10102 configurations.
10104 @item -march=@var{arch}
10105 @opindex march
10106 Generate code that will run on @var{arch}, which can be the name of a
10107 generic MIPS ISA, or the name of a particular processor.
10108 The ISA names are:
10109 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10110 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10111 The processor names are:
10112 @samp{4kc}, @samp{4km}, @samp{4kp},
10113 @samp{5kc}, @samp{5kf},
10114 @samp{20kc},
10115 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10116 @samp{m4k},
10117 @samp{orion},
10118 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10119 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10120 @samp{rm7000}, @samp{rm9000},
10121 @samp{sb1},
10122 @samp{sr71000},
10123 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10124 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10125 The special value @samp{from-abi} selects the
10126 most compatible architecture for the selected ABI (that is,
10127 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10129 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10130 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10131 @samp{vr} may be written @samp{r}.
10133 GCC defines two macros based on the value of this option.  The first
10134 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10135 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10136 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10137 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10138 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10140 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10141 above.  In other words, it will have the full prefix and will not
10142 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10143 the macro names the resolved architecture (either @samp{"mips1"} or
10144 @samp{"mips3"}).  It names the default architecture when no
10145 @option{-march} option is given.
10147 @item -mtune=@var{arch}
10148 @opindex mtune
10149 Optimize for @var{arch}.  Among other things, this option controls
10150 the way instructions are scheduled, and the perceived cost of arithmetic
10151 operations.  The list of @var{arch} values is the same as for
10152 @option{-march}.
10154 When this option is not used, GCC will optimize for the processor
10155 specified by @option{-march}.  By using @option{-march} and
10156 @option{-mtune} together, it is possible to generate code that will
10157 run on a family of processors, but optimize the code for one
10158 particular member of that family.
10160 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10161 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10162 @samp{-march} ones described above.
10164 @item -mips1
10165 @opindex mips1
10166 Equivalent to @samp{-march=mips1}.
10168 @item -mips2
10169 @opindex mips2
10170 Equivalent to @samp{-march=mips2}.
10172 @item -mips3
10173 @opindex mips3
10174 Equivalent to @samp{-march=mips3}.
10176 @item -mips4
10177 @opindex mips4
10178 Equivalent to @samp{-march=mips4}.
10180 @item -mips32
10181 @opindex mips32
10182 Equivalent to @samp{-march=mips32}.
10184 @item -mips32r2
10185 @opindex mips32r2
10186 Equivalent to @samp{-march=mips32r2}.
10188 @item -mips64
10189 @opindex mips64
10190 Equivalent to @samp{-march=mips64}.
10192 @item -mips16
10193 @itemx -mno-mips16
10194 @opindex mips16
10195 @opindex mno-mips16
10196 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10197 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10199 @item -mabi=32
10200 @itemx -mabi=o64
10201 @itemx -mabi=n32
10202 @itemx -mabi=64
10203 @itemx -mabi=eabi
10204 @opindex mabi=32
10205 @opindex mabi=o64
10206 @opindex mabi=n32
10207 @opindex mabi=64
10208 @opindex mabi=eabi
10209 Generate code for the given ABI@.
10211 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10212 generates 64-bit code when you select a 64-bit architecture, but you
10213 can use @option{-mgp32} to get 32-bit code instead.
10215 For information about the O64 ABI, see
10216 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10218 @item -mabicalls
10219 @itemx -mno-abicalls
10220 @opindex mabicalls
10221 @opindex mno-abicalls
10222 Generate (do not generate) SVR4-style position-independent code.
10223 @option{-mabicalls} is the default for SVR4-based systems.
10225 @item -mxgot
10226 @itemx -mno-xgot
10227 @opindex mxgot
10228 @opindex mno-xgot
10229 Lift (do not lift) the usual restrictions on the size of the global
10230 offset table.
10232 GCC normally uses a single instruction to load values from the GOT@.
10233 While this is relatively efficient, it will only work if the GOT
10234 is smaller than about 64k.  Anything larger will cause the linker
10235 to report an error such as:
10237 @cindex relocation truncated to fit (MIPS)
10238 @smallexample
10239 relocation truncated to fit: R_MIPS_GOT16 foobar
10240 @end smallexample
10242 If this happens, you should recompile your code with @option{-mxgot}.
10243 It should then work with very large GOTs, although it will also be
10244 less efficient, since it will take three instructions to fetch the
10245 value of a global symbol.
10247 Note that some linkers can create multiple GOTs.  If you have such a
10248 linker, you should only need to use @option{-mxgot} when a single object
10249 file accesses more than 64k's worth of GOT entries.  Very few do.
10251 These options have no effect unless GCC is generating position
10252 independent code.
10254 @item -mgp32
10255 @opindex mgp32
10256 Assume that general-purpose registers are 32 bits wide.
10258 @item -mgp64
10259 @opindex mgp64
10260 Assume that general-purpose registers are 64 bits wide.
10262 @item -mfp32
10263 @opindex mfp32
10264 Assume that floating-point registers are 32 bits wide.
10266 @item -mfp64
10267 @opindex mfp64
10268 Assume that floating-point registers are 64 bits wide.
10270 @item -mhard-float
10271 @opindex mhard-float
10272 Use floating-point coprocessor instructions.
10274 @item -msoft-float
10275 @opindex msoft-float
10276 Do not use floating-point coprocessor instructions.  Implement
10277 floating-point calculations using library calls instead.
10279 @item -msingle-float
10280 @opindex msingle-float
10281 Assume that the floating-point coprocessor only supports single-precision
10282 operations.
10284 @itemx -mdouble-float
10285 @opindex mdouble-float
10286 Assume that the floating-point coprocessor supports double-precision
10287 operations.  This is the default.
10289 @itemx -mdsp
10290 @itemx -mno-dsp
10291 @opindex mdsp
10292 @opindex mno-dsp
10293 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10295 @itemx -mpaired-single
10296 @itemx -mno-paired-single
10297 @opindex mpaired-single
10298 @opindex mno-paired-single
10299 Use (do not use) paired-single floating-point instructions.
10300 @xref{MIPS Paired-Single Support}.  This option can only be used
10301 when generating 64-bit code and requires hardware floating-point
10302 support to be enabled.
10304 @itemx -mips3d
10305 @itemx -mno-mips3d
10306 @opindex mips3d
10307 @opindex mno-mips3d
10308 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10309 The option @option{-mips3d} implies @option{-mpaired-single}.
10311 @item -mlong64
10312 @opindex mlong64
10313 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10314 an explanation of the default and the way that the pointer size is
10315 determined.
10317 @item -mlong32
10318 @opindex mlong32
10319 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10321 The default size of @code{int}s, @code{long}s and pointers depends on
10322 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10323 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10324 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10325 or the same size as integer registers, whichever is smaller.
10327 @item -msym32
10328 @itemx -mno-sym32
10329 @opindex msym32
10330 @opindex mno-sym32
10331 Assume (do not assume) that all symbols have 32-bit values, regardless
10332 of the selected ABI@.  This option is useful in combination with
10333 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10334 to generate shorter and faster references to symbolic addresses.
10336 @item -G @var{num}
10337 @opindex G
10338 @cindex smaller data references (MIPS)
10339 @cindex gp-relative references (MIPS)
10340 Put global and static items less than or equal to @var{num} bytes into
10341 the small data or bss section instead of the normal data or bss section.
10342 This allows the data to be accessed using a single instruction.
10344 All modules should be compiled with the same @option{-G @var{num}}
10345 value.
10347 @item -membedded-data
10348 @itemx -mno-embedded-data
10349 @opindex membedded-data
10350 @opindex mno-embedded-data
10351 Allocate variables to the read-only data section first if possible, then
10352 next in the small data section if possible, otherwise in data.  This gives
10353 slightly slower code than the default, but reduces the amount of RAM required
10354 when executing, and thus may be preferred for some embedded systems.
10356 @item -muninit-const-in-rodata
10357 @itemx -mno-uninit-const-in-rodata
10358 @opindex muninit-const-in-rodata
10359 @opindex mno-uninit-const-in-rodata
10360 Put uninitialized @code{const} variables in the read-only data section.
10361 This option is only meaningful in conjunction with @option{-membedded-data}.
10363 @item -msplit-addresses
10364 @itemx -mno-split-addresses
10365 @opindex msplit-addresses
10366 @opindex mno-split-addresses
10367 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10368 relocation operators.  This option has been superseded by
10369 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10371 @item -mexplicit-relocs
10372 @itemx -mno-explicit-relocs
10373 @opindex mexplicit-relocs
10374 @opindex mno-explicit-relocs
10375 Use (do not use) assembler relocation operators when dealing with symbolic
10376 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10377 is to use assembler macros instead.
10379 @option{-mexplicit-relocs} is the default if GCC was configured
10380 to use an assembler that supports relocation operators.
10382 @item -mcheck-zero-division
10383 @itemx -mno-check-zero-division
10384 @opindex mcheck-zero-division
10385 @opindex mno-check-zero-division
10386 Trap (do not trap) on integer division by zero.  The default is
10387 @option{-mcheck-zero-division}.
10389 @item -mdivide-traps
10390 @itemx -mdivide-breaks
10391 @opindex mdivide-traps
10392 @opindex mdivide-breaks
10393 MIPS systems check for division by zero by generating either a
10394 conditional trap or a break instruction.  Using traps results in
10395 smaller code, but is only supported on MIPS II and later.  Also, some
10396 versions of the Linux kernel have a bug that prevents trap from
10397 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10398 allow conditional traps on architectures that support them and
10399 @option{-mdivide-breaks} to force the use of breaks.
10401 The default is usually @option{-mdivide-traps}, but this can be
10402 overridden at configure time using @option{--with-divide=breaks}.
10403 Divide-by-zero checks can be completely disabled using
10404 @option{-mno-check-zero-division}.
10406 @item -mmemcpy
10407 @itemx -mno-memcpy
10408 @opindex mmemcpy
10409 @opindex mno-memcpy
10410 Force (do not force) the use of @code{memcpy()} for non-trivial block
10411 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10412 most constant-sized copies.
10414 @item -mlong-calls
10415 @itemx -mno-long-calls
10416 @opindex mlong-calls
10417 @opindex mno-long-calls
10418 Disable (do not disable) use of the @code{jal} instruction.  Calling
10419 functions using @code{jal} is more efficient but requires the caller
10420 and callee to be in the same 256 megabyte segment.
10422 This option has no effect on abicalls code.  The default is
10423 @option{-mno-long-calls}.
10425 @item -mmad
10426 @itemx -mno-mad
10427 @opindex mmad
10428 @opindex mno-mad
10429 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10430 instructions, as provided by the R4650 ISA@.
10432 @item -mfused-madd
10433 @itemx -mno-fused-madd
10434 @opindex mfused-madd
10435 @opindex mno-fused-madd
10436 Enable (disable) use of the floating point multiply-accumulate
10437 instructions, when they are available.  The default is
10438 @option{-mfused-madd}.
10440 When multiply-accumulate instructions are used, the intermediate
10441 product is calculated to infinite precision and is not subject to
10442 the FCSR Flush to Zero bit.  This may be undesirable in some
10443 circumstances.
10445 @item -nocpp
10446 @opindex nocpp
10447 Tell the MIPS assembler to not run its preprocessor over user
10448 assembler files (with a @samp{.s} suffix) when assembling them.
10450 @item -mfix-r4000
10451 @itemx -mno-fix-r4000
10452 @opindex mfix-r4000
10453 @opindex mno-fix-r4000
10454 Work around certain R4000 CPU errata:
10455 @itemize @minus
10456 @item
10457 A double-word or a variable shift may give an incorrect result if executed
10458 immediately after starting an integer division.
10459 @item
10460 A double-word or a variable shift may give an incorrect result if executed
10461 while an integer multiplication is in progress.
10462 @item
10463 An integer division may give an incorrect result if started in a delay slot
10464 of a taken branch or a jump.
10465 @end itemize
10467 @item -mfix-r4400
10468 @itemx -mno-fix-r4400
10469 @opindex mfix-r4400
10470 @opindex mno-fix-r4400
10471 Work around certain R4400 CPU errata:
10472 @itemize @minus
10473 @item
10474 A double-word or a variable shift may give an incorrect result if executed
10475 immediately after starting an integer division.
10476 @end itemize
10478 @item -mfix-vr4120
10479 @itemx -mno-fix-vr4120
10480 @opindex mfix-vr4120
10481 Work around certain VR4120 errata:
10482 @itemize @minus
10483 @item
10484 @code{dmultu} does not always produce the correct result.
10485 @item
10486 @code{div} and @code{ddiv} do not always produce the correct result if one
10487 of the operands is negative.
10488 @end itemize
10489 The workarounds for the division errata rely on special functions in
10490 @file{libgcc.a}.  At present, these functions are only provided by
10491 the @code{mips64vr*-elf} configurations.
10493 Other VR4120 errata require a nop to be inserted between certain pairs of
10494 instructions.  These errata are handled by the assembler, not by GCC itself.
10496 @item -mfix-vr4130
10497 @opindex mfix-vr4130
10498 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10499 workarounds are implemented by the assembler rather than by GCC,
10500 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10501 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10502 instructions are available instead.
10504 @item -mfix-sb1
10505 @itemx -mno-fix-sb1
10506 @opindex mfix-sb1
10507 Work around certain SB-1 CPU core errata.
10508 (This flag currently works around the SB-1 revision 2
10509 ``F1'' and ``F2'' floating point errata.)
10511 @item -mflush-func=@var{func}
10512 @itemx -mno-flush-func
10513 @opindex mflush-func
10514 Specifies the function to call to flush the I and D caches, or to not
10515 call any such function.  If called, the function must take the same
10516 arguments as the common @code{_flush_func()}, that is, the address of the
10517 memory range for which the cache is being flushed, the size of the
10518 memory range, and the number 3 (to flush both caches).  The default
10519 depends on the target GCC was configured for, but commonly is either
10520 @samp{_flush_func} or @samp{__cpu_flush}.
10522 @item -mbranch-likely
10523 @itemx -mno-branch-likely
10524 @opindex mbranch-likely
10525 @opindex mno-branch-likely
10526 Enable or disable use of Branch Likely instructions, regardless of the
10527 default for the selected architecture.  By default, Branch Likely
10528 instructions may be generated if they are supported by the selected
10529 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10530 and processors which implement those architectures; for those, Branch
10531 Likely instructions will not be generated by default because the MIPS32
10532 and MIPS64 architectures specifically deprecate their use.
10534 @item -mfp-exceptions
10535 @itemx -mno-fp-exceptions
10536 @opindex mfp-exceptions
10537 Specifies whether FP exceptions are enabled.  This affects how we schedule
10538 FP instructions for some processors.  The default is that FP exceptions are
10539 enabled.
10541 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10542 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10543 FP pipe.
10545 @item -mvr4130-align
10546 @itemx -mno-vr4130-align
10547 @opindex mvr4130-align
10548 The VR4130 pipeline is two-way superscalar, but can only issue two
10549 instructions together if the first one is 8-byte aligned.  When this
10550 option is enabled, GCC will align pairs of instructions that it
10551 thinks should execute in parallel.
10553 This option only has an effect when optimizing for the VR4130.
10554 It normally makes code faster, but at the expense of making it bigger.
10555 It is enabled by default at optimization level @option{-O3}.
10556 @end table
10558 @node MMIX Options
10559 @subsection MMIX Options
10560 @cindex MMIX Options
10562 These options are defined for the MMIX:
10564 @table @gcctabopt
10565 @item -mlibfuncs
10566 @itemx -mno-libfuncs
10567 @opindex mlibfuncs
10568 @opindex mno-libfuncs
10569 Specify that intrinsic library functions are being compiled, passing all
10570 values in registers, no matter the size.
10572 @item -mepsilon
10573 @itemx -mno-epsilon
10574 @opindex mepsilon
10575 @opindex mno-epsilon
10576 Generate floating-point comparison instructions that compare with respect
10577 to the @code{rE} epsilon register.
10579 @item -mabi=mmixware
10580 @itemx -mabi=gnu
10581 @opindex mabi-mmixware
10582 @opindex mabi=gnu
10583 Generate code that passes function parameters and return values that (in
10584 the called function) are seen as registers @code{$0} and up, as opposed to
10585 the GNU ABI which uses global registers @code{$231} and up.
10587 @item -mzero-extend
10588 @itemx -mno-zero-extend
10589 @opindex mzero-extend
10590 @opindex mno-zero-extend
10591 When reading data from memory in sizes shorter than 64 bits, use (do not
10592 use) zero-extending load instructions by default, rather than
10593 sign-extending ones.
10595 @item -mknuthdiv
10596 @itemx -mno-knuthdiv
10597 @opindex mknuthdiv
10598 @opindex mno-knuthdiv
10599 Make the result of a division yielding a remainder have the same sign as
10600 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10601 remainder follows the sign of the dividend.  Both methods are
10602 arithmetically valid, the latter being almost exclusively used.
10604 @item -mtoplevel-symbols
10605 @itemx -mno-toplevel-symbols
10606 @opindex mtoplevel-symbols
10607 @opindex mno-toplevel-symbols
10608 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10609 code can be used with the @code{PREFIX} assembly directive.
10611 @item -melf
10612 @opindex melf
10613 Generate an executable in the ELF format, rather than the default
10614 @samp{mmo} format used by the @command{mmix} simulator.
10616 @item -mbranch-predict
10617 @itemx -mno-branch-predict
10618 @opindex mbranch-predict
10619 @opindex mno-branch-predict
10620 Use (do not use) the probable-branch instructions, when static branch
10621 prediction indicates a probable branch.
10623 @item -mbase-addresses
10624 @itemx -mno-base-addresses
10625 @opindex mbase-addresses
10626 @opindex mno-base-addresses
10627 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10628 base address automatically generates a request (handled by the assembler
10629 and the linker) for a constant to be set up in a global register.  The
10630 register is used for one or more base address requests within the range 0
10631 to 255 from the value held in the register.  The generally leads to short
10632 and fast code, but the number of different data items that can be
10633 addressed is limited.  This means that a program that uses lots of static
10634 data may require @option{-mno-base-addresses}.
10636 @item -msingle-exit
10637 @itemx -mno-single-exit
10638 @opindex msingle-exit
10639 @opindex mno-single-exit
10640 Force (do not force) generated code to have a single exit point in each
10641 function.
10642 @end table
10644 @node MN10300 Options
10645 @subsection MN10300 Options
10646 @cindex MN10300 options
10648 These @option{-m} options are defined for Matsushita MN10300 architectures:
10650 @table @gcctabopt
10651 @item -mmult-bug
10652 @opindex mmult-bug
10653 Generate code to avoid bugs in the multiply instructions for the MN10300
10654 processors.  This is the default.
10656 @item -mno-mult-bug
10657 @opindex mno-mult-bug
10658 Do not generate code to avoid bugs in the multiply instructions for the
10659 MN10300 processors.
10661 @item -mam33
10662 @opindex mam33
10663 Generate code which uses features specific to the AM33 processor.
10665 @item -mno-am33
10666 @opindex mno-am33
10667 Do not generate code which uses features specific to the AM33 processor.  This
10668 is the default.
10670 @item -mreturn-pointer-on-d0
10671 @opindex mreturn-pointer-on-d0
10672 When generating a function which returns a pointer, return the pointer
10673 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10674 only in a0, and attempts to call such functions without a prototype
10675 would result in errors.  Note that this option is on by default; use
10676 @option{-mno-return-pointer-on-d0} to disable it.
10678 @item -mno-crt0
10679 @opindex mno-crt0
10680 Do not link in the C run-time initialization object file.
10682 @item -mrelax
10683 @opindex mrelax
10684 Indicate to the linker that it should perform a relaxation optimization pass
10685 to shorten branches, calls and absolute memory addresses.  This option only
10686 has an effect when used on the command line for the final link step.
10688 This option makes symbolic debugging impossible.
10689 @end table
10691 @node MT Options
10692 @subsection MT Options
10693 @cindex MT options
10695 These @option{-m} options are defined for Morpho MT architectures:
10697 @table @gcctabopt
10699 @item -march=@var{cpu-type}
10700 @opindex march
10701 Generate code that will run on @var{cpu-type}, which is the name of a system
10702 representing a certain processor type.  Possible values for
10703 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10704 @samp{ms1-16-003} and @samp{ms2}.
10706 When this option is not used, the default is @option{-march=ms1-16-002}.
10708 @item -mbacc
10709 @opindex mbacc
10710 Use byte loads and stores when generating code.
10712 @item -mno-bacc
10713 @opindex mno-bacc
10714 Do not use byte loads and stores when generating code.
10716 @item -msim
10717 @opindex msim
10718 Use simulator runtime
10720 @item -mno-crt0
10721 @opindex mno-crt0
10722 Do not link in the C run-time initialization object file
10723 @file{crti.o}.  Other run-time initialization and termination files
10724 such as @file{startup.o} and @file{exit.o} are still included on the
10725 linker command line.
10727 @end table
10729 @node PDP-11 Options
10730 @subsection PDP-11 Options
10731 @cindex PDP-11 Options
10733 These options are defined for the PDP-11:
10735 @table @gcctabopt
10736 @item -mfpu
10737 @opindex mfpu
10738 Use hardware FPP floating point.  This is the default.  (FIS floating
10739 point on the PDP-11/40 is not supported.)
10741 @item -msoft-float
10742 @opindex msoft-float
10743 Do not use hardware floating point.
10745 @item -mac0
10746 @opindex mac0
10747 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10749 @item -mno-ac0
10750 @opindex mno-ac0
10751 Return floating-point results in memory.  This is the default.
10753 @item -m40
10754 @opindex m40
10755 Generate code for a PDP-11/40.
10757 @item -m45
10758 @opindex m45
10759 Generate code for a PDP-11/45.  This is the default.
10761 @item -m10
10762 @opindex m10
10763 Generate code for a PDP-11/10.
10765 @item -mbcopy-builtin
10766 @opindex bcopy-builtin
10767 Use inline @code{movmemhi} patterns for copying memory.  This is the
10768 default.
10770 @item -mbcopy
10771 @opindex mbcopy
10772 Do not use inline @code{movmemhi} patterns for copying memory.
10774 @item -mint16
10775 @itemx -mno-int32
10776 @opindex mint16
10777 @opindex mno-int32
10778 Use 16-bit @code{int}.  This is the default.
10780 @item -mint32
10781 @itemx -mno-int16
10782 @opindex mint32
10783 @opindex mno-int16
10784 Use 32-bit @code{int}.
10786 @item -mfloat64
10787 @itemx -mno-float32
10788 @opindex mfloat64
10789 @opindex mno-float32
10790 Use 64-bit @code{float}.  This is the default.
10792 @item -mfloat32
10793 @itemx -mno-float64
10794 @opindex mfloat32
10795 @opindex mno-float64
10796 Use 32-bit @code{float}.
10798 @item -mabshi
10799 @opindex mabshi
10800 Use @code{abshi2} pattern.  This is the default.
10802 @item -mno-abshi
10803 @opindex mno-abshi
10804 Do not use @code{abshi2} pattern.
10806 @item -mbranch-expensive
10807 @opindex mbranch-expensive
10808 Pretend that branches are expensive.  This is for experimenting with
10809 code generation only.
10811 @item -mbranch-cheap
10812 @opindex mbranch-cheap
10813 Do not pretend that branches are expensive.  This is the default.
10815 @item -msplit
10816 @opindex msplit
10817 Generate code for a system with split I&D@.
10819 @item -mno-split
10820 @opindex mno-split
10821 Generate code for a system without split I&D@.  This is the default.
10823 @item -munix-asm
10824 @opindex munix-asm
10825 Use Unix assembler syntax.  This is the default when configured for
10826 @samp{pdp11-*-bsd}.
10828 @item -mdec-asm
10829 @opindex mdec-asm
10830 Use DEC assembler syntax.  This is the default when configured for any
10831 PDP-11 target other than @samp{pdp11-*-bsd}.
10832 @end table
10834 @node PowerPC Options
10835 @subsection PowerPC Options
10836 @cindex PowerPC options
10838 These are listed under @xref{RS/6000 and PowerPC Options}.
10840 @node RS/6000 and PowerPC Options
10841 @subsection IBM RS/6000 and PowerPC Options
10842 @cindex RS/6000 and PowerPC Options
10843 @cindex IBM RS/6000 and PowerPC Options
10845 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10846 @table @gcctabopt
10847 @item -mpower
10848 @itemx -mno-power
10849 @itemx -mpower2
10850 @itemx -mno-power2
10851 @itemx -mpowerpc
10852 @itemx -mno-powerpc
10853 @itemx -mpowerpc-gpopt
10854 @itemx -mno-powerpc-gpopt
10855 @itemx -mpowerpc-gfxopt
10856 @itemx -mno-powerpc-gfxopt
10857 @itemx -mpowerpc64
10858 @itemx -mno-powerpc64
10859 @itemx -mmfcrf
10860 @itemx -mno-mfcrf
10861 @itemx -mpopcntb
10862 @itemx -mno-popcntb
10863 @itemx -mfprnd
10864 @itemx -mno-fprnd
10865 @opindex mpower
10866 @opindex mno-power
10867 @opindex mpower2
10868 @opindex mno-power2
10869 @opindex mpowerpc
10870 @opindex mno-powerpc
10871 @opindex mpowerpc-gpopt
10872 @opindex mno-powerpc-gpopt
10873 @opindex mpowerpc-gfxopt
10874 @opindex mno-powerpc-gfxopt
10875 @opindex mpowerpc64
10876 @opindex mno-powerpc64
10877 @opindex mmfcrf
10878 @opindex mno-mfcrf
10879 @opindex mpopcntb
10880 @opindex mno-popcntb
10881 @opindex mfprnd
10882 @opindex mno-fprnd
10883 GCC supports two related instruction set architectures for the
10884 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10885 instructions supported by the @samp{rios} chip set used in the original
10886 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10887 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10888 the IBM 4xx, 6xx, and follow-on microprocessors.
10890 Neither architecture is a subset of the other.  However there is a
10891 large common subset of instructions supported by both.  An MQ
10892 register is included in processors supporting the POWER architecture.
10894 You use these options to specify which instructions are available on the
10895 processor you are using.  The default value of these options is
10896 determined when configuring GCC@.  Specifying the
10897 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10898 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10899 rather than the options listed above.
10901 The @option{-mpower} option allows GCC to generate instructions that
10902 are found only in the POWER architecture and to use the MQ register.
10903 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10904 to generate instructions that are present in the POWER2 architecture but
10905 not the original POWER architecture.
10907 The @option{-mpowerpc} option allows GCC to generate instructions that
10908 are found only in the 32-bit subset of the PowerPC architecture.
10909 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10910 GCC to use the optional PowerPC architecture instructions in the
10911 General Purpose group, including floating-point square root.  Specifying
10912 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10913 use the optional PowerPC architecture instructions in the Graphics
10914 group, including floating-point select.
10916 The @option{-mmfcrf} option allows GCC to generate the move from
10917 condition register field instruction implemented on the POWER4
10918 processor and other processors that support the PowerPC V2.01
10919 architecture.
10920 The @option{-mpopcntb} option allows GCC to generate the popcount and
10921 double precision FP reciprocal estimate instruction implemented on the
10922 POWER5 processor and other processors that support the PowerPC V2.02
10923 architecture.
10924 The @option{-mfprnd} option allows GCC to generate the FP round to
10925 integer instructions implemented on the POWER5+ processor and other
10926 processors that support the PowerPC V2.03 architecture.
10928 The @option{-mpowerpc64} option allows GCC to generate the additional
10929 64-bit instructions that are found in the full PowerPC64 architecture
10930 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10931 @option{-mno-powerpc64}.
10933 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10934 will use only the instructions in the common subset of both
10935 architectures plus some special AIX common-mode calls, and will not use
10936 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10937 permits GCC to use any instruction from either architecture and to
10938 allow use of the MQ register; specify this for the Motorola MPC601.
10940 @item -mnew-mnemonics
10941 @itemx -mold-mnemonics
10942 @opindex mnew-mnemonics
10943 @opindex mold-mnemonics
10944 Select which mnemonics to use in the generated assembler code.  With
10945 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10946 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10947 assembler mnemonics defined for the POWER architecture.  Instructions
10948 defined in only one architecture have only one mnemonic; GCC uses that
10949 mnemonic irrespective of which of these options is specified.
10951 GCC defaults to the mnemonics appropriate for the architecture in
10952 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10953 value of these option.  Unless you are building a cross-compiler, you
10954 should normally not specify either @option{-mnew-mnemonics} or
10955 @option{-mold-mnemonics}, but should instead accept the default.
10957 @item -mcpu=@var{cpu_type}
10958 @opindex mcpu
10959 Set architecture type, register usage, choice of mnemonics, and
10960 instruction scheduling parameters for machine type @var{cpu_type}.
10961 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10962 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10963 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10964 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10965 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10966 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
10967 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10968 @samp{power4}, @samp{power5}, @samp{power5+},
10969 @samp{common}, @samp{powerpc}, @samp{powerpc64},
10970 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10972 @option{-mcpu=common} selects a completely generic processor.  Code
10973 generated under this option will run on any POWER or PowerPC processor.
10974 GCC will use only the instructions in the common subset of both
10975 architectures, and will not use the MQ register.  GCC assumes a generic
10976 processor model for scheduling purposes.
10978 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10979 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10980 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10981 types, with an appropriate, generic processor model assumed for
10982 scheduling purposes.
10984 The other options specify a specific processor.  Code generated under
10985 those options will run best on that processor, and may not run at all on
10986 others.
10988 The @option{-mcpu} options automatically enable or disable the
10989 following options: @option{-maltivec}, @option{-mfprnd},
10990 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
10991 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
10992 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
10993 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
10994 The particular options
10995 set for any particular CPU will vary between compiler versions,
10996 depending on what setting seems to produce optimal code for that CPU;
10997 it doesn't necessarily reflect the actual hardware's capabilities.  If
10998 you wish to set an individual option to a particular value, you may
10999 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11000 -mno-altivec}.
11002 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11003 not enabled or disabled by the @option{-mcpu} option at present because
11004 AIX does not have full support for these options.  You may still
11005 enable or disable them individually if you're sure it'll work in your
11006 environment.
11008 @item -mtune=@var{cpu_type}
11009 @opindex mtune
11010 Set the instruction scheduling parameters for machine type
11011 @var{cpu_type}, but do not set the architecture type, register usage, or
11012 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11013 values for @var{cpu_type} are used for @option{-mtune} as for
11014 @option{-mcpu}.  If both are specified, the code generated will use the
11015 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11016 scheduling parameters set by @option{-mtune}.
11018 @item -mswdiv
11019 @itemx -mno-swdiv
11020 @opindex mswdiv
11021 @opindex mno-swdiv
11022 Generate code to compute division as reciprocal estimate and iterative
11023 refinement, creating opportunities for increased throughput.  This
11024 feature requires: optional PowerPC Graphics instruction set for single
11025 precision and FRE instruction for double precision, assuming divides
11026 cannot generate user-visible traps, and the domain values not include
11027 Infinities, denormals or zero denominator.
11029 @item -maltivec
11030 @itemx -mno-altivec
11031 @opindex maltivec
11032 @opindex mno-altivec
11033 Generate code that uses (does not use) AltiVec instructions, and also
11034 enable the use of built-in functions that allow more direct access to
11035 the AltiVec instruction set.  You may also need to set
11036 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11037 enhancements.
11039 @item -mvrsave
11040 @item -mno-vrsave
11041 @opindex mvrsave
11042 @opindex mno-vrsave
11043 Generate VRSAVE instructions when generating AltiVec code.
11045 @item -mabi=spe
11046 @opindex mabi=spe
11047 Extend the current ABI with SPE ABI extensions.  This does not change
11048 the default ABI, instead it adds the SPE ABI extensions to the current
11049 ABI@.
11051 @item -mabi=no-spe
11052 @opindex mabi=no-spe
11053 Disable Booke SPE ABI extensions for the current ABI@.
11055 @item -msecure-plt
11056 @opindex msecure-plt
11057 Generate code that allows ld and ld.so to build executables and shared
11058 libraries with non-exec .plt and .got sections.  This is a PowerPC
11059 32-bit SYSV ABI option.
11061 @item -mbss-plt
11062 @opindex mbss-plt
11063 Generate code that uses a BSS .plt section that ld.so fills in, and
11064 requires .plt and .got sections that are both writable and executable.
11065 This is a PowerPC 32-bit SYSV ABI option.
11067 @item -misel
11068 @itemx -mno-isel
11069 @opindex misel
11070 @opindex mno-isel
11071 This switch enables or disables the generation of ISEL instructions.
11073 @item -misel=@var{yes/no}
11074 This switch has been deprecated.  Use @option{-misel} and
11075 @option{-mno-isel} instead.
11077 @item -mspe
11078 @itemx -mno-isel
11079 @opindex mspe
11080 @opindex mno-spe
11081 This switch enables or disables the generation of SPE simd
11082 instructions.
11084 @item -mspe=@var{yes/no}
11085 This option has been deprecated.  Use @option{-mspe} and
11086 @option{-mno-spe} instead.
11088 @item -mfloat-gprs=@var{yes/single/double/no}
11089 @itemx -mfloat-gprs
11090 @opindex mfloat-gprs
11091 This switch enables or disables the generation of floating point
11092 operations on the general purpose registers for architectures that
11093 support it.
11095 The argument @var{yes} or @var{single} enables the use of
11096 single-precision floating point operations.
11098 The argument @var{double} enables the use of single and
11099 double-precision floating point operations.
11101 The argument @var{no} disables floating point operations on the
11102 general purpose registers.
11104 This option is currently only available on the MPC854x.
11106 @item -m32
11107 @itemx -m64
11108 @opindex m32
11109 @opindex m64
11110 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11111 targets (including GNU/Linux).  The 32-bit environment sets int, long
11112 and pointer to 32 bits and generates code that runs on any PowerPC
11113 variant.  The 64-bit environment sets int to 32 bits and long and
11114 pointer to 64 bits, and generates code for PowerPC64, as for
11115 @option{-mpowerpc64}.
11117 @item -mfull-toc
11118 @itemx -mno-fp-in-toc
11119 @itemx -mno-sum-in-toc
11120 @itemx -mminimal-toc
11121 @opindex mfull-toc
11122 @opindex mno-fp-in-toc
11123 @opindex mno-sum-in-toc
11124 @opindex mminimal-toc
11125 Modify generation of the TOC (Table Of Contents), which is created for
11126 every executable file.  The @option{-mfull-toc} option is selected by
11127 default.  In that case, GCC will allocate at least one TOC entry for
11128 each unique non-automatic variable reference in your program.  GCC
11129 will also place floating-point constants in the TOC@.  However, only
11130 16,384 entries are available in the TOC@.
11132 If you receive a linker error message that saying you have overflowed
11133 the available TOC space, you can reduce the amount of TOC space used
11134 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11135 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11136 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11137 generate code to calculate the sum of an address and a constant at
11138 run-time instead of putting that sum into the TOC@.  You may specify one
11139 or both of these options.  Each causes GCC to produce very slightly
11140 slower and larger code at the expense of conserving TOC space.
11142 If you still run out of space in the TOC even when you specify both of
11143 these options, specify @option{-mminimal-toc} instead.  This option causes
11144 GCC to make only one TOC entry for every file.  When you specify this
11145 option, GCC will produce code that is slower and larger but which
11146 uses extremely little TOC space.  You may wish to use this option
11147 only on files that contain less frequently executed code.
11149 @item -maix64
11150 @itemx -maix32
11151 @opindex maix64
11152 @opindex maix32
11153 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11154 @code{long} type, and the infrastructure needed to support them.
11155 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11156 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11157 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11159 @item -mxl-compat
11160 @itemx -mno-xl-compat
11161 @opindex mxl-compat
11162 @opindex mno-xl-compat
11163 Produce code that conforms more closely to IBM XLC semantics when using
11164 AIX-compatible ABI.  Pass floating-point arguments to prototyped
11165 functions beyond the register save area (RSA) on the stack in addition
11166 to argument FPRs.  Do not assume that most significant double in 128
11167 bit long double value is properly rounded when comparing values.
11169 The AIX calling convention was extended but not initially documented to
11170 handle an obscure K&R C case of calling a function that takes the
11171 address of its arguments with fewer arguments than declared.  AIX XL
11172 compilers access floating point arguments which do not fit in the
11173 RSA from the stack when a subroutine is compiled without
11174 optimization.  Because always storing floating-point arguments on the
11175 stack is inefficient and rarely needed, this option is not enabled by
11176 default and only is necessary when calling subroutines compiled by AIX
11177 XL compilers without optimization.
11179 @item -mpe
11180 @opindex mpe
11181 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11182 application written to use message passing with special startup code to
11183 enable the application to run.  The system must have PE installed in the
11184 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11185 must be overridden with the @option{-specs=} option to specify the
11186 appropriate directory location.  The Parallel Environment does not
11187 support threads, so the @option{-mpe} option and the @option{-pthread}
11188 option are incompatible.
11190 @item -malign-natural
11191 @itemx -malign-power
11192 @opindex malign-natural
11193 @opindex malign-power
11194 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11195 @option{-malign-natural} overrides the ABI-defined alignment of larger
11196 types, such as floating-point doubles, on their natural size-based boundary.
11197 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11198 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11200 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11201 is not supported.
11203 @item -msoft-float
11204 @itemx -mhard-float
11205 @opindex msoft-float
11206 @opindex mhard-float
11207 Generate code that does not use (uses) the floating-point register set.
11208 Software floating point emulation is provided if you use the
11209 @option{-msoft-float} option, and pass the option to GCC when linking.
11211 @item -mmultiple
11212 @itemx -mno-multiple
11213 @opindex mmultiple
11214 @opindex mno-multiple
11215 Generate code that uses (does not use) the load multiple word
11216 instructions and the store multiple word instructions.  These
11217 instructions are generated by default on POWER systems, and not
11218 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11219 endian PowerPC systems, since those instructions do not work when the
11220 processor is in little endian mode.  The exceptions are PPC740 and
11221 PPC750 which permit the instructions usage in little endian mode.
11223 @item -mstring
11224 @itemx -mno-string
11225 @opindex mstring
11226 @opindex mno-string
11227 Generate code that uses (does not use) the load string instructions
11228 and the store string word instructions to save multiple registers and
11229 do small block moves.  These instructions are generated by default on
11230 POWER systems, and not generated on PowerPC systems.  Do not use
11231 @option{-mstring} on little endian PowerPC systems, since those
11232 instructions do not work when the processor is in little endian mode.
11233 The exceptions are PPC740 and PPC750 which permit the instructions
11234 usage in little endian mode.
11236 @item -mupdate
11237 @itemx -mno-update
11238 @opindex mupdate
11239 @opindex mno-update
11240 Generate code that uses (does not use) the load or store instructions
11241 that update the base register to the address of the calculated memory
11242 location.  These instructions are generated by default.  If you use
11243 @option{-mno-update}, there is a small window between the time that the
11244 stack pointer is updated and the address of the previous frame is
11245 stored, which means code that walks the stack frame across interrupts or
11246 signals may get corrupted data.
11248 @item -mfused-madd
11249 @itemx -mno-fused-madd
11250 @opindex mfused-madd
11251 @opindex mno-fused-madd
11252 Generate code that uses (does not use) the floating point multiply and
11253 accumulate instructions.  These instructions are generated by default if
11254 hardware floating is used.
11256 @item -mmulhw
11257 @itemx -mno-mulhw
11258 @opindex mmulhw
11259 @opindex mno-mulhw
11260 Generate code that uses (does not use) the half-word multiply and
11261 multiply-accumulate instructions on the IBM 405 and 440 processors.
11262 These instructions are generated by default when targetting those
11263 processors.
11265 @item -mno-bit-align
11266 @itemx -mbit-align
11267 @opindex mno-bit-align
11268 @opindex mbit-align
11269 On System V.4 and embedded PowerPC systems do not (do) force structures
11270 and unions that contain bit-fields to be aligned to the base type of the
11271 bit-field.
11273 For example, by default a structure containing nothing but 8
11274 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11275 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11276 the structure would be aligned to a 1 byte boundary and be one byte in
11277 size.
11279 @item -mno-strict-align
11280 @itemx -mstrict-align
11281 @opindex mno-strict-align
11282 @opindex mstrict-align
11283 On System V.4 and embedded PowerPC systems do not (do) assume that
11284 unaligned memory references will be handled by the system.
11286 @item -mrelocatable
11287 @itemx -mno-relocatable
11288 @opindex mrelocatable
11289 @opindex mno-relocatable
11290 On embedded PowerPC systems generate code that allows (does not allow)
11291 the program to be relocated to a different address at runtime.  If you
11292 use @option{-mrelocatable} on any module, all objects linked together must
11293 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11295 @item -mrelocatable-lib
11296 @itemx -mno-relocatable-lib
11297 @opindex mrelocatable-lib
11298 @opindex mno-relocatable-lib
11299 On embedded PowerPC systems generate code that allows (does not allow)
11300 the program to be relocated to a different address at runtime.  Modules
11301 compiled with @option{-mrelocatable-lib} can be linked with either modules
11302 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11303 with modules compiled with the @option{-mrelocatable} options.
11305 @item -mno-toc
11306 @itemx -mtoc
11307 @opindex mno-toc
11308 @opindex mtoc
11309 On System V.4 and embedded PowerPC systems do not (do) assume that
11310 register 2 contains a pointer to a global area pointing to the addresses
11311 used in the program.
11313 @item -mlittle
11314 @itemx -mlittle-endian
11315 @opindex mlittle
11316 @opindex mlittle-endian
11317 On System V.4 and embedded PowerPC systems compile code for the
11318 processor in little endian mode.  The @option{-mlittle-endian} option is
11319 the same as @option{-mlittle}.
11321 @item -mbig
11322 @itemx -mbig-endian
11323 @opindex mbig
11324 @opindex mbig-endian
11325 On System V.4 and embedded PowerPC systems compile code for the
11326 processor in big endian mode.  The @option{-mbig-endian} option is
11327 the same as @option{-mbig}.
11329 @item -mdynamic-no-pic
11330 @opindex mdynamic-no-pic
11331 On Darwin and Mac OS X systems, compile code so that it is not
11332 relocatable, but that its external references are relocatable.  The
11333 resulting code is suitable for applications, but not shared
11334 libraries.
11336 @item -mprioritize-restricted-insns=@var{priority}
11337 @opindex mprioritize-restricted-insns
11338 This option controls the priority that is assigned to
11339 dispatch-slot restricted instructions during the second scheduling
11340 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11341 @var{no/highest/second-highest} priority to dispatch slot restricted
11342 instructions.
11344 @item -msched-costly-dep=@var{dependence_type}
11345 @opindex msched-costly-dep
11346 This option controls which dependences are considered costly
11347 by the target during instruction scheduling.  The argument
11348 @var{dependence_type} takes one of the following values:
11349 @var{no}: no dependence is costly,
11350 @var{all}: all dependences are costly,
11351 @var{true_store_to_load}: a true dependence from store to load is costly,
11352 @var{store_to_load}: any dependence from store to load is costly,
11353 @var{number}: any dependence which latency >= @var{number} is costly.
11355 @item -minsert-sched-nops=@var{scheme}
11356 @opindex minsert-sched-nops
11357 This option controls which nop insertion scheme will be used during
11358 the second scheduling pass.  The argument @var{scheme} takes one of the
11359 following values:
11360 @var{no}: Don't insert nops.
11361 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11362 according to the scheduler's grouping.
11363 @var{regroup_exact}: Insert nops to force costly dependent insns into
11364 separate groups.  Insert exactly as many nops as needed to force an insn
11365 to a new group, according to the estimated processor grouping.
11366 @var{number}: Insert nops to force costly dependent insns into
11367 separate groups.  Insert @var{number} nops to force an insn to a new group.
11369 @item -mcall-sysv
11370 @opindex mcall-sysv
11371 On System V.4 and embedded PowerPC systems compile code using calling
11372 conventions that adheres to the March 1995 draft of the System V
11373 Application Binary Interface, PowerPC processor supplement.  This is the
11374 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11376 @item -mcall-sysv-eabi
11377 @opindex mcall-sysv-eabi
11378 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11380 @item -mcall-sysv-noeabi
11381 @opindex mcall-sysv-noeabi
11382 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11384 @item -mcall-solaris
11385 @opindex mcall-solaris
11386 On System V.4 and embedded PowerPC systems compile code for the Solaris
11387 operating system.
11389 @item -mcall-linux
11390 @opindex mcall-linux
11391 On System V.4 and embedded PowerPC systems compile code for the
11392 Linux-based GNU system.
11394 @item -mcall-gnu
11395 @opindex mcall-gnu
11396 On System V.4 and embedded PowerPC systems compile code for the
11397 Hurd-based GNU system.
11399 @item -mcall-netbsd
11400 @opindex mcall-netbsd
11401 On System V.4 and embedded PowerPC systems compile code for the
11402 NetBSD operating system.
11404 @item -maix-struct-return
11405 @opindex maix-struct-return
11406 Return all structures in memory (as specified by the AIX ABI)@.
11408 @item -msvr4-struct-return
11409 @opindex msvr4-struct-return
11410 Return structures smaller than 8 bytes in registers (as specified by the
11411 SVR4 ABI)@.
11413 @item -mabi=@var{abi-type}
11414 @opindex mabi
11415 Extend the current ABI with a particular extension, or remove such extension.
11416 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11417 @var{no-spe}@.
11419 @item -mprototype
11420 @itemx -mno-prototype
11421 @opindex mprototype
11422 @opindex mno-prototype
11423 On System V.4 and embedded PowerPC systems assume that all calls to
11424 variable argument functions are properly prototyped.  Otherwise, the
11425 compiler must insert an instruction before every non prototyped call to
11426 set or clear bit 6 of the condition code register (@var{CR}) to
11427 indicate whether floating point values were passed in the floating point
11428 registers in case the function takes a variable arguments.  With
11429 @option{-mprototype}, only calls to prototyped variable argument functions
11430 will set or clear the bit.
11432 @item -msim
11433 @opindex msim
11434 On embedded PowerPC systems, assume that the startup module is called
11435 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11436 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11437 configurations.
11439 @item -mmvme
11440 @opindex mmvme
11441 On embedded PowerPC systems, assume that the startup module is called
11442 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11443 @file{libc.a}.
11445 @item -mads
11446 @opindex mads
11447 On embedded PowerPC systems, assume that the startup module is called
11448 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11449 @file{libc.a}.
11451 @item -myellowknife
11452 @opindex myellowknife
11453 On embedded PowerPC systems, assume that the startup module is called
11454 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11455 @file{libc.a}.
11457 @item -mvxworks
11458 @opindex mvxworks
11459 On System V.4 and embedded PowerPC systems, specify that you are
11460 compiling for a VxWorks system.
11462 @item -mwindiss
11463 @opindex mwindiss
11464 Specify that you are compiling for the WindISS simulation environment.
11466 @item -memb
11467 @opindex memb
11468 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11469 header to indicate that @samp{eabi} extended relocations are used.
11471 @item -meabi
11472 @itemx -mno-eabi
11473 @opindex meabi
11474 @opindex mno-eabi
11475 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11476 Embedded Applications Binary Interface (eabi) which is a set of
11477 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11478 means that the stack is aligned to an 8 byte boundary, a function
11479 @code{__eabi} is called to from @code{main} to set up the eabi
11480 environment, and the @option{-msdata} option can use both @code{r2} and
11481 @code{r13} to point to two separate small data areas.  Selecting
11482 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11483 do not call an initialization function from @code{main}, and the
11484 @option{-msdata} option will only use @code{r13} to point to a single
11485 small data area.  The @option{-meabi} option is on by default if you
11486 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11488 @item -msdata=eabi
11489 @opindex msdata=eabi
11490 On System V.4 and embedded PowerPC systems, put small initialized
11491 @code{const} global and static data in the @samp{.sdata2} section, which
11492 is pointed to by register @code{r2}.  Put small initialized
11493 non-@code{const} global and static data in the @samp{.sdata} section,
11494 which is pointed to by register @code{r13}.  Put small uninitialized
11495 global and static data in the @samp{.sbss} section, which is adjacent to
11496 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11497 incompatible with the @option{-mrelocatable} option.  The
11498 @option{-msdata=eabi} option also sets the @option{-memb} option.
11500 @item -msdata=sysv
11501 @opindex msdata=sysv
11502 On System V.4 and embedded PowerPC systems, put small global and static
11503 data in the @samp{.sdata} section, which is pointed to by register
11504 @code{r13}.  Put small uninitialized global and static data in the
11505 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11506 The @option{-msdata=sysv} option is incompatible with the
11507 @option{-mrelocatable} option.
11509 @item -msdata=default
11510 @itemx -msdata
11511 @opindex msdata=default
11512 @opindex msdata
11513 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11514 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11515 same as @option{-msdata=sysv}.
11517 @item -msdata-data
11518 @opindex msdata-data
11519 On System V.4 and embedded PowerPC systems, put small global
11520 data in the @samp{.sdata} section.  Put small uninitialized global
11521 data in the @samp{.sbss} section.  Do not use register @code{r13}
11522 to address small data however.  This is the default behavior unless
11523 other @option{-msdata} options are used.
11525 @item -msdata=none
11526 @itemx -mno-sdata
11527 @opindex msdata=none
11528 @opindex mno-sdata
11529 On embedded PowerPC systems, put all initialized global and static data
11530 in the @samp{.data} section, and all uninitialized data in the
11531 @samp{.bss} section.
11533 @item -G @var{num}
11534 @opindex G
11535 @cindex smaller data references (PowerPC)
11536 @cindex .sdata/.sdata2 references (PowerPC)
11537 On embedded PowerPC systems, put global and static items less than or
11538 equal to @var{num} bytes into the small data or bss sections instead of
11539 the normal data or bss section.  By default, @var{num} is 8.  The
11540 @option{-G @var{num}} switch is also passed to the linker.
11541 All modules should be compiled with the same @option{-G @var{num}} value.
11543 @item -mregnames
11544 @itemx -mno-regnames
11545 @opindex mregnames
11546 @opindex mno-regnames
11547 On System V.4 and embedded PowerPC systems do (do not) emit register
11548 names in the assembly language output using symbolic forms.
11550 @item -mlongcall
11551 @itemx -mno-longcall
11552 @opindex mlongcall
11553 @opindex mno-longcall
11554 Default to making all function calls indirectly, using a register, so
11555 that functions which reside further than 32 megabytes (33,554,432
11556 bytes) from the current location can be called.  This setting can be
11557 overridden by the @code{shortcall} function attribute, or by
11558 @code{#pragma longcall(0)}.
11560 Some linkers are capable of detecting out-of-range calls and generating
11561 glue code on the fly.  On these systems, long calls are unnecessary and
11562 generate slower code.  As of this writing, the AIX linker can do this,
11563 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11564 to the GNU linker for 32-bit PowerPC systems as well.
11566 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11567 callee, L42'', plus a ``branch island'' (glue code).  The two target
11568 addresses represent the callee and the ``branch island''.  The
11569 Darwin/PPC linker will prefer the first address and generate a ``bl
11570 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11571 otherwise, the linker will generate ``bl L42'' to call the ``branch
11572 island''.  The ``branch island'' is appended to the body of the
11573 calling function; it computes the full 32-bit address of the callee
11574 and jumps to it.
11576 On Mach-O (Darwin) systems, this option directs the compiler emit to
11577 the glue for every direct call, and the Darwin linker decides whether
11578 to use or discard it.
11580 In the future, we may cause GCC to ignore all longcall specifications
11581 when the linker is known to generate glue.
11583 @item -pthread
11584 @opindex pthread
11585 Adds support for multithreading with the @dfn{pthreads} library.
11586 This option sets flags for both the preprocessor and linker.
11588 @end table
11590 @node S/390 and zSeries Options
11591 @subsection S/390 and zSeries Options
11592 @cindex S/390 and zSeries Options
11594 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11596 @table @gcctabopt
11597 @item -mhard-float
11598 @itemx -msoft-float
11599 @opindex mhard-float
11600 @opindex msoft-float
11601 Use (do not use) the hardware floating-point instructions and registers
11602 for floating-point operations.  When @option{-msoft-float} is specified,
11603 functions in @file{libgcc.a} will be used to perform floating-point
11604 operations.  When @option{-mhard-float} is specified, the compiler
11605 generates IEEE floating-point instructions.  This is the default.
11607 @item -mbackchain
11608 @itemx -mno-backchain
11609 @opindex mbackchain
11610 @opindex mno-backchain
11611 Store (do not store) the address of the caller's frame as backchain pointer
11612 into the callee's stack frame.
11613 A backchain may be needed to allow debugging using tools that do not understand
11614 DWARF-2 call frame information.
11615 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11616 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11617 the backchain is placed into the topmost word of the 96/160 byte register
11618 save area.
11620 In general, code compiled with @option{-mbackchain} is call-compatible with
11621 code compiled with @option{-mmo-backchain}; however, use of the backchain
11622 for debugging purposes usually requires that the whole binary is built with
11623 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11624 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11625 to build a linux kernel use @option{-msoft-float}.
11627 The default is to not maintain the backchain.
11629 @item -mpacked-stack
11630 @item -mno-packed-stack
11631 @opindex mpacked-stack
11632 @opindex mno-packed-stack
11633 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11634 specified, the compiler uses the all fields of the 96/160 byte register save
11635 area only for their default purpose; unused fields still take up stack space.
11636 When @option{-mpacked-stack} is specified, register save slots are densely
11637 packed at the top of the register save area; unused space is reused for other
11638 purposes, allowing for more efficient use of the available stack space.
11639 However, when @option{-mbackchain} is also in effect, the topmost word of
11640 the save area is always used to store the backchain, and the return address
11641 register is always saved two words below the backchain.
11643 As long as the stack frame backchain is not used, code generated with
11644 @option{-mpacked-stack} is call-compatible with code generated with
11645 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11646 S/390 or zSeries generated code that uses the stack frame backchain at run
11647 time, not just for debugging purposes.  Such code is not call-compatible
11648 with code compiled with @option{-mpacked-stack}.  Also, note that the
11649 combination of @option{-mbackchain},
11650 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11651 to build a linux kernel use @option{-msoft-float}.
11653 The default is to not use the packed stack layout.
11655 @item -msmall-exec
11656 @itemx -mno-small-exec
11657 @opindex msmall-exec
11658 @opindex mno-small-exec
11659 Generate (or do not generate) code using the @code{bras} instruction
11660 to do subroutine calls.
11661 This only works reliably if the total executable size does not
11662 exceed 64k.  The default is to use the @code{basr} instruction instead,
11663 which does not have this limitation.
11665 @item -m64
11666 @itemx -m31
11667 @opindex m64
11668 @opindex m31
11669 When @option{-m31} is specified, generate code compliant to the
11670 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11671 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11672 particular to generate 64-bit instructions.  For the @samp{s390}
11673 targets, the default is @option{-m31}, while the @samp{s390x}
11674 targets default to @option{-m64}.
11676 @item -mzarch
11677 @itemx -mesa
11678 @opindex mzarch
11679 @opindex mesa
11680 When @option{-mzarch} is specified, generate code using the
11681 instructions available on z/Architecture.
11682 When @option{-mesa} is specified, generate code using the
11683 instructions available on ESA/390.  Note that @option{-mesa} is
11684 not possible with @option{-m64}.
11685 When generating code compliant to the GNU/Linux for S/390 ABI,
11686 the default is @option{-mesa}.  When generating code compliant
11687 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11689 @item -mmvcle
11690 @itemx -mno-mvcle
11691 @opindex mmvcle
11692 @opindex mno-mvcle
11693 Generate (or do not generate) code using the @code{mvcle} instruction
11694 to perform block moves.  When @option{-mno-mvcle} is specified,
11695 use a @code{mvc} loop instead.  This is the default unless optimizing for
11696 size.
11698 @item -mdebug
11699 @itemx -mno-debug
11700 @opindex mdebug
11701 @opindex mno-debug
11702 Print (or do not print) additional debug information when compiling.
11703 The default is to not print debug information.
11705 @item -march=@var{cpu-type}
11706 @opindex march
11707 Generate code that will run on @var{cpu-type}, which is the name of a system
11708 representing a certain processor type.  Possible values for
11709 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11710 When generating code using the instructions available on z/Architecture,
11711 the default is @option{-march=z900}.  Otherwise, the default is
11712 @option{-march=g5}.
11714 @item -mtune=@var{cpu-type}
11715 @opindex mtune
11716 Tune to @var{cpu-type} everything applicable about the generated code,
11717 except for the ABI and the set of available instructions.
11718 The list of @var{cpu-type} values is the same as for @option{-march}.
11719 The default is the value used for @option{-march}.
11721 @item -mtpf-trace
11722 @itemx -mno-tpf-trace
11723 @opindex mtpf-trace
11724 @opindex mno-tpf-trace
11725 Generate code that adds (does not add) in TPF OS specific branches to trace
11726 routines in the operating system.  This option is off by default, even
11727 when compiling for the TPF OS@.
11729 @item -mfused-madd
11730 @itemx -mno-fused-madd
11731 @opindex mfused-madd
11732 @opindex mno-fused-madd
11733 Generate code that uses (does not use) the floating point multiply and
11734 accumulate instructions.  These instructions are generated by default if
11735 hardware floating point is used.
11737 @item -mwarn-framesize=@var{framesize}
11738 @opindex mwarn-framesize
11739 Emit a warning if the current function exceeds the given frame size.  Because
11740 this is a compile time check it doesn't need to be a real problem when the program
11741 runs.  It is intended to identify functions which most probably cause
11742 a stack overflow.  It is useful to be used in an environment with limited stack
11743 size e.g.@: the linux kernel.
11745 @item -mwarn-dynamicstack
11746 @opindex mwarn-dynamicstack
11747 Emit a warning if the function calls alloca or uses dynamically
11748 sized arrays.  This is generally a bad idea with a limited stack size.
11750 @item -mstack-guard=@var{stack-guard}
11751 @item -mstack-size=@var{stack-size}
11752 @opindex mstack-guard
11753 @opindex mstack-size
11754 These arguments always have to be used in conjunction.  If they are present the s390
11755 back end emits additional instructions in the function prologue which trigger a trap
11756 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11757 (remember that the stack on s390 grows downward).  These options are intended to
11758 be used to help debugging stack overflow problems.  The additionally emitted code
11759 causes only little overhead and hence can also be used in production like systems
11760 without greater performance degradation.  The given values have to be exact
11761 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11762 exceeding 64k.
11763 In order to be efficient the extra code makes the assumption that the stack starts
11764 at an address aligned to the value given by @var{stack-size}.
11765 @end table
11767 @node SH Options
11768 @subsection SH Options
11770 These @samp{-m} options are defined for the SH implementations:
11772 @table @gcctabopt
11773 @item -m1
11774 @opindex m1
11775 Generate code for the SH1.
11777 @item -m2
11778 @opindex m2
11779 Generate code for the SH2.
11781 @item -m2e
11782 Generate code for the SH2e.
11784 @item -m3
11785 @opindex m3
11786 Generate code for the SH3.
11788 @item -m3e
11789 @opindex m3e
11790 Generate code for the SH3e.
11792 @item -m4-nofpu
11793 @opindex m4-nofpu
11794 Generate code for the SH4 without a floating-point unit.
11796 @item -m4-single-only
11797 @opindex m4-single-only
11798 Generate code for the SH4 with a floating-point unit that only
11799 supports single-precision arithmetic.
11801 @item -m4-single
11802 @opindex m4-single
11803 Generate code for the SH4 assuming the floating-point unit is in
11804 single-precision mode by default.
11806 @item -m4
11807 @opindex m4
11808 Generate code for the SH4.
11810 @item -m4a-nofpu
11811 @opindex m4a-nofpu
11812 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11813 floating-point unit is not used.
11815 @item -m4a-single-only
11816 @opindex m4a-single-only
11817 Generate code for the SH4a, in such a way that no double-precision
11818 floating point operations are used.
11820 @item -m4a-single
11821 @opindex m4a-single
11822 Generate code for the SH4a assuming the floating-point unit is in
11823 single-precision mode by default.
11825 @item -m4a
11826 @opindex m4a
11827 Generate code for the SH4a.
11829 @item -m4al
11830 @opindex m4al
11831 Same as @option{-m4a-nofpu}, except that it implicitly passes
11832 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11833 instructions at the moment.
11835 @item -mb
11836 @opindex mb
11837 Compile code for the processor in big endian mode.
11839 @item -ml
11840 @opindex ml
11841 Compile code for the processor in little endian mode.
11843 @item -mdalign
11844 @opindex mdalign
11845 Align doubles at 64-bit boundaries.  Note that this changes the calling
11846 conventions, and thus some functions from the standard C library will
11847 not work unless you recompile it first with @option{-mdalign}.
11849 @item -mrelax
11850 @opindex mrelax
11851 Shorten some address references at link time, when possible; uses the
11852 linker option @option{-relax}.
11854 @item -mbigtable
11855 @opindex mbigtable
11856 Use 32-bit offsets in @code{switch} tables.  The default is to use
11857 16-bit offsets.
11859 @item -mfmovd
11860 @opindex mfmovd
11861 Enable the use of the instruction @code{fmovd}.
11863 @item -mhitachi
11864 @opindex mhitachi
11865 Comply with the calling conventions defined by Renesas.
11867 @item -mrenesas
11868 @opindex mhitachi
11869 Comply with the calling conventions defined by Renesas.
11871 @item -mno-renesas
11872 @opindex mhitachi
11873 Comply with the calling conventions defined for GCC before the Renesas
11874 conventions were available.  This option is the default for all
11875 targets of the SH toolchain except for @samp{sh-symbianelf}.
11877 @item -mnomacsave
11878 @opindex mnomacsave
11879 Mark the @code{MAC} register as call-clobbered, even if
11880 @option{-mhitachi} is given.
11882 @item -mieee
11883 @opindex mieee
11884 Increase IEEE-compliance of floating-point code.
11885 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11886 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11887 comparisons of NANs / infinities incurs extra overhead in every
11888 floating point comparison, therefore the default is set to
11889 @option{-ffinite-math-only}.
11891 @item -misize
11892 @opindex misize
11893 Dump instruction size and location in the assembly code.
11895 @item -mpadstruct
11896 @opindex mpadstruct
11897 This option is deprecated.  It pads structures to multiple of 4 bytes,
11898 which is incompatible with the SH ABI@.
11900 @item -mspace
11901 @opindex mspace
11902 Optimize for space instead of speed.  Implied by @option{-Os}.
11904 @item -mprefergot
11905 @opindex mprefergot
11906 When generating position-independent code, emit function calls using
11907 the Global Offset Table instead of the Procedure Linkage Table.
11909 @item -musermode
11910 @opindex musermode
11911 Generate a library function call to invalidate instruction cache
11912 entries, after fixing up a trampoline.  This library function call
11913 doesn't assume it can write to the whole memory address space.  This
11914 is the default when the target is @code{sh-*-linux*}.
11916 @item -multcost=@var{number}
11917 @opindex multcost=@var{number}
11918 Set the cost to assume for a multiply insn.
11920 @item -mdiv=@var{strategy}
11921 @opindex mdiv=@var{strategy}
11922 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11923 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11924 inv:call2, inv:fp .
11925 "fp" performs the operation in floating point.  This has a very high latency,
11926 but needs only a few instructions, so it might be a good choice if
11927 your code has enough easily exploitable ILP to allow the compiler to
11928 schedule the floating point instructions together with other instructions.
11929 Division by zero causes a floating point exception.
11930 "inv" uses integer operations to calculate the inverse of the divisor,
11931 and then multiplies the dividend with the inverse.  This strategy allows
11932 cse and hoisting of the inverse calculation.  Division by zero calculates
11933 an unspecified result, but does not trap.
11934 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11935 have been found, or if the entire operation has been hoisted to the same
11936 place, the last stages of the inverse calculation are intertwined with the
11937 final multiply to reduce the overall latency, at the expense of using a few
11938 more instructions, and thus offering fewer scheduling opportunities with
11939 other code.
11940 "call" calls a library function that usually implements the inv:minlat
11941 strategy.
11942 This gives high code density for m5-*media-nofpu compilations.
11943 "call2" uses a different entry point of the same library function, where it
11944 assumes that a pointer to a lookup table has already been set up, which
11945 exposes the pointer load to cse / code hoisting optimizations.
11946 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11947 code generation, but if the code stays unoptimized, revert to the "call",
11948 "call2", or "fp" strategies, respectively.  Note that the
11949 potentially-trapping side effect of division by zero is carried by a
11950 separate instruction, so it is possible that all the integer instructions
11951 are hoisted out, but the marker for the side effect stays where it is.
11952 A recombination to fp operations or a call is not possible in that case.
11953 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11954 that the inverse calculation was nor separated from the multiply, they speed
11955 up division where the dividend fits into 20 bits (plus sign where applicable),
11956 by inserting a test to skip a number of operations in this case; this test
11957 slows down the case of larger dividends.  inv20u assumes the case of a such
11958 a small dividend to be unlikely, and inv20l assumes it to be likely.
11960 @item -mdivsi3_libfunc=@var{name}
11961 @opindex mdivsi3_libfunc=@var{name}
11962 Set the name of the library function used for 32 bit signed division to
11963 @var{name}.  This only affect the name used in the call and inv:call
11964 division strategies, and the compiler will still expect the same
11965 sets of input/output/clobbered registers as if this option was not present.
11967 @item -madjust-unroll
11968 @opindex madjust-unroll
11969 Throttle unrolling to avoid thrashing target registers.
11970 This option only has an effect if the gcc code base supports the
11971 TARGET_ADJUST_UNROLL_MAX target hook.
11973 @item -mindexed-addressing
11974 @opindex mindexed-addressing
11975 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11976 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11977 semantics for the indexed addressing mode.  The architecture allows the
11978 implementation of processors with 64 bit MMU, which the OS could use to
11979 get 32 bit addressing, but since no current hardware implementation supports
11980 this or any other way to make the indexed addressing mode safe to use in
11981 the 32 bit ABI, the default is -mno-indexed-addressing.
11983 @item -mgettrcost=@var{number}
11984 @opindex mgettrcost=@var{number}
11985 Set the cost assumed for the gettr instruction to @var{number}.
11986 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11988 @item -mpt-fixed
11989 @opindex mpt-fixed
11990 Assume pt* instructions won't trap.  This will generally generate better
11991 scheduled code, but is unsafe on current hardware.  The current architecture
11992 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11993 This has the unintentional effect of making it unsafe to schedule ptabs /
11994 ptrel before a branch, or hoist it out of a loop.  For example,
11995 __do_global_ctors, a part of libgcc that runs constructors at program
11996 startup, calls functions in a list which is delimited by -1.  With the
11997 -mpt-fixed option, the ptabs will be done before testing against -1.
11998 That means that all the constructors will be run a bit quicker, but when
11999 the loop comes to the end of the list, the program crashes because ptabs
12000 loads -1 into a target register.  Since this option is unsafe for any
12001 hardware implementing the current architecture specification, the default
12002 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12003 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12004 this deters register allocation using target registers for storing
12005 ordinary integers.
12007 @item -minvalid-symbols
12008 @opindex minvalid-symbols
12009 Assume symbols might be invalid.  Ordinary function symbols generated by
12010 the compiler will always be valid to load with movi/shori/ptabs or
12011 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12012 to generate symbols that will cause ptabs / ptrel to trap.
12013 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12014 It will then prevent cross-basic-block cse, hoisting and most scheduling
12015 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12016 @end table
12018 @node SPARC Options
12019 @subsection SPARC Options
12020 @cindex SPARC options
12022 These @samp{-m} options are supported on the SPARC:
12024 @table @gcctabopt
12025 @item -mno-app-regs
12026 @itemx -mapp-regs
12027 @opindex mno-app-regs
12028 @opindex mapp-regs
12029 Specify @option{-mapp-regs} to generate output using the global registers
12030 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12031 is the default.
12033 To be fully SVR4 ABI compliant at the cost of some performance loss,
12034 specify @option{-mno-app-regs}.  You should compile libraries and system
12035 software with this option.
12037 @item -mfpu
12038 @itemx -mhard-float
12039 @opindex mfpu
12040 @opindex mhard-float
12041 Generate output containing floating point instructions.  This is the
12042 default.
12044 @item -mno-fpu
12045 @itemx -msoft-float
12046 @opindex mno-fpu
12047 @opindex msoft-float
12048 Generate output containing library calls for floating point.
12049 @strong{Warning:} the requisite libraries are not available for all SPARC
12050 targets.  Normally the facilities of the machine's usual C compiler are
12051 used, but this cannot be done directly in cross-compilation.  You must make
12052 your own arrangements to provide suitable library functions for
12053 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12054 @samp{sparclite-*-*} do provide software floating point support.
12056 @option{-msoft-float} changes the calling convention in the output file;
12057 therefore, it is only useful if you compile @emph{all} of a program with
12058 this option.  In particular, you need to compile @file{libgcc.a}, the
12059 library that comes with GCC, with @option{-msoft-float} in order for
12060 this to work.
12062 @item -mhard-quad-float
12063 @opindex mhard-quad-float
12064 Generate output containing quad-word (long double) floating point
12065 instructions.
12067 @item -msoft-quad-float
12068 @opindex msoft-quad-float
12069 Generate output containing library calls for quad-word (long double)
12070 floating point instructions.  The functions called are those specified
12071 in the SPARC ABI@.  This is the default.
12073 As of this writing, there are no SPARC implementations that have hardware
12074 support for the quad-word floating point instructions.  They all invoke
12075 a trap handler for one of these instructions, and then the trap handler
12076 emulates the effect of the instruction.  Because of the trap handler overhead,
12077 this is much slower than calling the ABI library routines.  Thus the
12078 @option{-msoft-quad-float} option is the default.
12080 @item -mno-unaligned-doubles
12081 @itemx -munaligned-doubles
12082 @opindex mno-unaligned-doubles
12083 @opindex munaligned-doubles
12084 Assume that doubles have 8 byte alignment.  This is the default.
12086 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12087 alignment only if they are contained in another type, or if they have an
12088 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12089 Specifying this option avoids some rare compatibility problems with code
12090 generated by other compilers.  It is not the default because it results
12091 in a performance loss, especially for floating point code.
12093 @item -mno-faster-structs
12094 @itemx -mfaster-structs
12095 @opindex mno-faster-structs
12096 @opindex mfaster-structs
12097 With @option{-mfaster-structs}, the compiler assumes that structures
12098 should have 8 byte alignment.  This enables the use of pairs of
12099 @code{ldd} and @code{std} instructions for copies in structure
12100 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12101 However, the use of this changed alignment directly violates the SPARC
12102 ABI@.  Thus, it's intended only for use on targets where the developer
12103 acknowledges that their resulting code will not be directly in line with
12104 the rules of the ABI@.
12106 @item -mimpure-text
12107 @opindex mimpure-text
12108 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12109 the compiler to not pass @option{-z text} to the linker when linking a
12110 shared object.  Using this option, you can link position-dependent
12111 code into a shared object.
12113 @option{-mimpure-text} suppresses the ``relocations remain against
12114 allocatable but non-writable sections'' linker error message.
12115 However, the necessary relocations will trigger copy-on-write, and the
12116 shared object is not actually shared across processes.  Instead of
12117 using @option{-mimpure-text}, you should compile all source code with
12118 @option{-fpic} or @option{-fPIC}.
12120 This option is only available on SunOS and Solaris.
12122 @item -mcpu=@var{cpu_type}
12123 @opindex mcpu
12124 Set the instruction set, register set, and instruction scheduling parameters
12125 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12126 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12127 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12128 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12129 @samp{ultrasparc3}.
12131 Default instruction scheduling parameters are used for values that select
12132 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12133 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12135 Here is a list of each supported architecture and their supported
12136 implementations.
12138 @smallexample
12139     v7:             cypress
12140     v8:             supersparc, hypersparc
12141     sparclite:      f930, f934, sparclite86x
12142     sparclet:       tsc701
12143     v9:             ultrasparc, ultrasparc3
12144 @end smallexample
12146 By default (unless configured otherwise), GCC generates code for the V7
12147 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12148 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12149 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12150 SPARCStation 1, 2, IPX etc.
12152 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12153 architecture.  The only difference from V7 code is that the compiler emits
12154 the integer multiply and integer divide instructions which exist in SPARC-V8
12155 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12156 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12157 2000 series.
12159 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12160 the SPARC architecture.  This adds the integer multiply, integer divide step
12161 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12162 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12163 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12164 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12165 MB86934 chip, which is the more recent SPARClite with FPU@.
12167 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12168 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12169 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12170 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12171 optimizes it for the TEMIC SPARClet chip.
12173 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12174 architecture.  This adds 64-bit integer and floating-point move instructions,
12175 3 additional floating-point condition code registers and conditional move
12176 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12177 optimizes it for the Sun UltraSPARC I/II chips.  With
12178 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12179 Sun UltraSPARC III chip.
12181 @item -mtune=@var{cpu_type}
12182 @opindex mtune
12183 Set the instruction scheduling parameters for machine type
12184 @var{cpu_type}, but do not set the instruction set or register set that the
12185 option @option{-mcpu=@var{cpu_type}} would.
12187 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12188 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12189 that select a particular cpu implementation.  Those are @samp{cypress},
12190 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12191 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12192 @samp{ultrasparc3}.
12194 @item -mv8plus
12195 @itemx -mno-v8plus
12196 @opindex mv8plus
12197 @opindex mno-v8plus
12198 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12199 difference from the V8 ABI is that the global and out registers are
12200 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12201 mode for all SPARC-V9 processors.
12203 @item -mvis
12204 @itemx -mno-vis
12205 @opindex mvis
12206 @opindex mno-vis
12207 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12208 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12209 @end table
12211 These @samp{-m} options are supported in addition to the above
12212 on SPARC-V9 processors in 64-bit environments:
12214 @table @gcctabopt
12215 @item -mlittle-endian
12216 @opindex mlittle-endian
12217 Generate code for a processor running in little-endian mode.  It is only
12218 available for a few configurations and most notably not on Solaris and Linux.
12220 @item -m32
12221 @itemx -m64
12222 @opindex m32
12223 @opindex m64
12224 Generate code for a 32-bit or 64-bit environment.
12225 The 32-bit environment sets int, long and pointer to 32 bits.
12226 The 64-bit environment sets int to 32 bits and long and pointer
12227 to 64 bits.
12229 @item -mcmodel=medlow
12230 @opindex mcmodel=medlow
12231 Generate code for the Medium/Low code model: 64-bit addresses, programs
12232 must be linked in the low 32 bits of memory.  Programs can be statically
12233 or dynamically linked.
12235 @item -mcmodel=medmid
12236 @opindex mcmodel=medmid
12237 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12238 must be linked in the low 44 bits of memory, the text and data segments must
12239 be less than 2GB in size and the data segment must be located within 2GB of
12240 the text segment.
12242 @item -mcmodel=medany
12243 @opindex mcmodel=medany
12244 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12245 may be linked anywhere in memory, the text and data segments must be less
12246 than 2GB in size and the data segment must be located within 2GB of the
12247 text segment.
12249 @item -mcmodel=embmedany
12250 @opindex mcmodel=embmedany
12251 Generate code for the Medium/Anywhere code model for embedded systems:
12252 64-bit addresses, the text and data segments must be less than 2GB in
12253 size, both starting anywhere in memory (determined at link time).  The
12254 global register %g4 points to the base of the data segment.  Programs
12255 are statically linked and PIC is not supported.
12257 @item -mstack-bias
12258 @itemx -mno-stack-bias
12259 @opindex mstack-bias
12260 @opindex mno-stack-bias
12261 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12262 frame pointer if present, are offset by @minus{}2047 which must be added back
12263 when making stack frame references.  This is the default in 64-bit mode.
12264 Otherwise, assume no such offset is present.
12265 @end table
12267 These switches are supported in addition to the above on Solaris:
12269 @table @gcctabopt
12270 @item -threads
12271 @opindex threads
12272 Add support for multithreading using the Solaris threads library.  This
12273 option sets flags for both the preprocessor and linker.  This option does
12274 not affect the thread safety of object code produced by the compiler or
12275 that of libraries supplied with it.
12277 @item -pthreads
12278 @opindex pthreads
12279 Add support for multithreading using the POSIX threads library.  This
12280 option sets flags for both the preprocessor and linker.  This option does
12281 not affect the thread safety of object code produced  by the compiler or
12282 that of libraries supplied with it.
12283 @end table
12285 @node System V Options
12286 @subsection Options for System V
12288 These additional options are available on System V Release 4 for
12289 compatibility with other compilers on those systems:
12291 @table @gcctabopt
12292 @item -G
12293 @opindex G
12294 Create a shared object.
12295 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12297 @item -Qy
12298 @opindex Qy
12299 Identify the versions of each tool used by the compiler, in a
12300 @code{.ident} assembler directive in the output.
12302 @item -Qn
12303 @opindex Qn
12304 Refrain from adding @code{.ident} directives to the output file (this is
12305 the default).
12307 @item -YP,@var{dirs}
12308 @opindex YP
12309 Search the directories @var{dirs}, and no others, for libraries
12310 specified with @option{-l}.
12312 @item -Ym,@var{dir}
12313 @opindex Ym
12314 Look in the directory @var{dir} to find the M4 preprocessor.
12315 The assembler uses this option.
12316 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12317 @c the generic assembler that comes with Solaris takes just -Ym.
12318 @end table
12320 @node TMS320C3x/C4x Options
12321 @subsection TMS320C3x/C4x Options
12322 @cindex TMS320C3x/C4x Options
12324 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12326 @table @gcctabopt
12328 @item -mcpu=@var{cpu_type}
12329 @opindex mcpu
12330 Set the instruction set, register set, and instruction scheduling
12331 parameters for machine type @var{cpu_type}.  Supported values for
12332 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12333 @samp{c44}.  The default is @samp{c40} to generate code for the
12334 TMS320C40.
12336 @item -mbig-memory
12337 @itemx -mbig
12338 @itemx -msmall-memory
12339 @itemx -msmall
12340 @opindex mbig-memory
12341 @opindex mbig
12342 @opindex msmall-memory
12343 @opindex msmall
12344 Generates code for the big or small memory model.  The small memory
12345 model assumed that all data fits into one 64K word page.  At run-time
12346 the data page (DP) register must be set to point to the 64K page
12347 containing the .bss and .data program sections.  The big memory model is
12348 the default and requires reloading of the DP register for every direct
12349 memory access.
12351 @item -mbk
12352 @itemx -mno-bk
12353 @opindex mbk
12354 @opindex mno-bk
12355 Allow (disallow) allocation of general integer operands into the block
12356 count register BK@.
12358 @item -mdb
12359 @itemx -mno-db
12360 @opindex mdb
12361 @opindex mno-db
12362 Enable (disable) generation of code using decrement and branch,
12363 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12364 on the safe side, this is disabled for the C3x, since the maximum
12365 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12366 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12367 that it can utilize the decrement and branch instruction, but will give
12368 up if there is more than one memory reference in the loop.  Thus a loop
12369 where the loop counter is decremented can generate slightly more
12370 efficient code, in cases where the RPTB instruction cannot be utilized.
12372 @item -mdp-isr-reload
12373 @itemx -mparanoid
12374 @opindex mdp-isr-reload
12375 @opindex mparanoid
12376 Force the DP register to be saved on entry to an interrupt service
12377 routine (ISR), reloaded to point to the data section, and restored on
12378 exit from the ISR@.  This should not be required unless someone has
12379 violated the small memory model by modifying the DP register, say within
12380 an object library.
12382 @item -mmpyi
12383 @itemx -mno-mpyi
12384 @opindex mmpyi
12385 @opindex mno-mpyi
12386 For the C3x use the 24-bit MPYI instruction for integer multiplies
12387 instead of a library call to guarantee 32-bit results.  Note that if one
12388 of the operands is a constant, then the multiplication will be performed
12389 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12390 then squaring operations are performed inline instead of a library call.
12392 @item -mfast-fix
12393 @itemx -mno-fast-fix
12394 @opindex mfast-fix
12395 @opindex mno-fast-fix
12396 The C3x/C4x FIX instruction to convert a floating point value to an
12397 integer value chooses the nearest integer less than or equal to the
12398 floating point value rather than to the nearest integer.  Thus if the
12399 floating point number is negative, the result will be incorrectly
12400 truncated an additional code is necessary to detect and correct this
12401 case.  This option can be used to disable generation of the additional
12402 code required to correct the result.
12404 @item -mrptb
12405 @itemx -mno-rptb
12406 @opindex mrptb
12407 @opindex mno-rptb
12408 Enable (disable) generation of repeat block sequences using the RPTB
12409 instruction for zero overhead looping.  The RPTB construct is only used
12410 for innermost loops that do not call functions or jump across the loop
12411 boundaries.  There is no advantage having nested RPTB loops due to the
12412 overhead required to save and restore the RC, RS, and RE registers.
12413 This is enabled by default with @option{-O2}.
12415 @item -mrpts=@var{count}
12416 @itemx -mno-rpts
12417 @opindex mrpts
12418 @opindex mno-rpts
12419 Enable (disable) the use of the single instruction repeat instruction
12420 RPTS@.  If a repeat block contains a single instruction, and the loop
12421 count can be guaranteed to be less than the value @var{count}, GCC will
12422 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12423 then a RPTS will be emitted even if the loop count cannot be determined
12424 at compile time.  Note that the repeated instruction following RPTS does
12425 not have to be reloaded from memory each iteration, thus freeing up the
12426 CPU buses for operands.  However, since interrupts are blocked by this
12427 instruction, it is disabled by default.
12429 @item -mloop-unsigned
12430 @itemx -mno-loop-unsigned
12431 @opindex mloop-unsigned
12432 @opindex mno-loop-unsigned
12433 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12434 is @math{2^{31} + 1} since these instructions test if the iteration count is
12435 negative to terminate the loop.  If the iteration count is unsigned
12436 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12437 exceeded.  This switch allows an unsigned iteration count.
12439 @item -mti
12440 @opindex mti
12441 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12442 with.  This also enforces compatibility with the API employed by the TI
12443 C3x C compiler.  For example, long doubles are passed as structures
12444 rather than in floating point registers.
12446 @item -mregparm
12447 @itemx -mmemparm
12448 @opindex mregparm
12449 @opindex mmemparm
12450 Generate code that uses registers (stack) for passing arguments to functions.
12451 By default, arguments are passed in registers where possible rather
12452 than by pushing arguments on to the stack.
12454 @item -mparallel-insns
12455 @itemx -mno-parallel-insns
12456 @opindex mparallel-insns
12457 @opindex mno-parallel-insns
12458 Allow the generation of parallel instructions.  This is enabled by
12459 default with @option{-O2}.
12461 @item -mparallel-mpy
12462 @itemx -mno-parallel-mpy
12463 @opindex mparallel-mpy
12464 @opindex mno-parallel-mpy
12465 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12466 provided @option{-mparallel-insns} is also specified.  These instructions have
12467 tight register constraints which can pessimize the code generation
12468 of large functions.
12470 @end table
12472 @node V850 Options
12473 @subsection V850 Options
12474 @cindex V850 Options
12476 These @samp{-m} options are defined for V850 implementations:
12478 @table @gcctabopt
12479 @item -mlong-calls
12480 @itemx -mno-long-calls
12481 @opindex mlong-calls
12482 @opindex mno-long-calls
12483 Treat all calls as being far away (near).  If calls are assumed to be
12484 far away, the compiler will always load the functions address up into a
12485 register, and call indirect through the pointer.
12487 @item -mno-ep
12488 @itemx -mep
12489 @opindex mno-ep
12490 @opindex mep
12491 Do not optimize (do optimize) basic blocks that use the same index
12492 pointer 4 or more times to copy pointer into the @code{ep} register, and
12493 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12494 option is on by default if you optimize.
12496 @item -mno-prolog-function
12497 @itemx -mprolog-function
12498 @opindex mno-prolog-function
12499 @opindex mprolog-function
12500 Do not use (do use) external functions to save and restore registers
12501 at the prologue and epilogue of a function.  The external functions
12502 are slower, but use less code space if more than one function saves
12503 the same number of registers.  The @option{-mprolog-function} option
12504 is on by default if you optimize.
12506 @item -mspace
12507 @opindex mspace
12508 Try to make the code as small as possible.  At present, this just turns
12509 on the @option{-mep} and @option{-mprolog-function} options.
12511 @item -mtda=@var{n}
12512 @opindex mtda
12513 Put static or global variables whose size is @var{n} bytes or less into
12514 the tiny data area that register @code{ep} points to.  The tiny data
12515 area can hold up to 256 bytes in total (128 bytes for byte references).
12517 @item -msda=@var{n}
12518 @opindex msda
12519 Put static or global variables whose size is @var{n} bytes or less into
12520 the small data area that register @code{gp} points to.  The small data
12521 area can hold up to 64 kilobytes.
12523 @item -mzda=@var{n}
12524 @opindex mzda
12525 Put static or global variables whose size is @var{n} bytes or less into
12526 the first 32 kilobytes of memory.
12528 @item -mv850
12529 @opindex mv850
12530 Specify that the target processor is the V850.
12532 @item -mbig-switch
12533 @opindex mbig-switch
12534 Generate code suitable for big switch tables.  Use this option only if
12535 the assembler/linker complain about out of range branches within a switch
12536 table.
12538 @item -mapp-regs
12539 @opindex mapp-regs
12540 This option will cause r2 and r5 to be used in the code generated by
12541 the compiler.  This setting is the default.
12543 @item -mno-app-regs
12544 @opindex mno-app-regs
12545 This option will cause r2 and r5 to be treated as fixed registers.
12547 @item -mv850e1
12548 @opindex mv850e1
12549 Specify that the target processor is the V850E1.  The preprocessor
12550 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12551 this option is used.
12553 @item -mv850e
12554 @opindex mv850e
12555 Specify that the target processor is the V850E@.  The preprocessor
12556 constant @samp{__v850e__} will be defined if this option is used.
12558 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12559 are defined then a default target processor will be chosen and the
12560 relevant @samp{__v850*__} preprocessor constant will be defined.
12562 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12563 defined, regardless of which processor variant is the target.
12565 @item -mdisable-callt
12566 @opindex mdisable-callt
12567 This option will suppress generation of the CALLT instruction for the
12568 v850e and v850e1 flavors of the v850 architecture.  The default is
12569 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12571 @end table
12573 @node VAX Options
12574 @subsection VAX Options
12575 @cindex VAX options
12577 These @samp{-m} options are defined for the VAX:
12579 @table @gcctabopt
12580 @item -munix
12581 @opindex munix
12582 Do not output certain jump instructions (@code{aobleq} and so on)
12583 that the Unix assembler for the VAX cannot handle across long
12584 ranges.
12586 @item -mgnu
12587 @opindex mgnu
12588 Do output those jump instructions, on the assumption that you
12589 will assemble with the GNU assembler.
12591 @item -mg
12592 @opindex mg
12593 Output code for g-format floating point numbers instead of d-format.
12594 @end table
12596 @node x86-64 Options
12597 @subsection x86-64 Options
12598 @cindex x86-64 options
12600 These are listed under @xref{i386 and x86-64 Options}.
12602 @node Xstormy16 Options
12603 @subsection Xstormy16 Options
12604 @cindex Xstormy16 Options
12606 These options are defined for Xstormy16:
12608 @table @gcctabopt
12609 @item -msim
12610 @opindex msim
12611 Choose startup files and linker script suitable for the simulator.
12612 @end table
12614 @node Xtensa Options
12615 @subsection Xtensa Options
12616 @cindex Xtensa Options
12618 These options are supported for Xtensa targets:
12620 @table @gcctabopt
12621 @item -mconst16
12622 @itemx -mno-const16
12623 @opindex mconst16
12624 @opindex mno-const16
12625 Enable or disable use of @code{CONST16} instructions for loading
12626 constant values.  The @code{CONST16} instruction is currently not a
12627 standard option from Tensilica.  When enabled, @code{CONST16}
12628 instructions are always used in place of the standard @code{L32R}
12629 instructions.  The use of @code{CONST16} is enabled by default only if
12630 the @code{L32R} instruction is not available.
12632 @item -mfused-madd
12633 @itemx -mno-fused-madd
12634 @opindex mfused-madd
12635 @opindex mno-fused-madd
12636 Enable or disable use of fused multiply/add and multiply/subtract
12637 instructions in the floating-point option.  This has no effect if the
12638 floating-point option is not also enabled.  Disabling fused multiply/add
12639 and multiply/subtract instructions forces the compiler to use separate
12640 instructions for the multiply and add/subtract operations.  This may be
12641 desirable in some cases where strict IEEE 754-compliant results are
12642 required: the fused multiply add/subtract instructions do not round the
12643 intermediate result, thereby producing results with @emph{more} bits of
12644 precision than specified by the IEEE standard.  Disabling fused multiply
12645 add/subtract instructions also ensures that the program output is not
12646 sensitive to the compiler's ability to combine multiply and add/subtract
12647 operations.
12649 @item -mtext-section-literals
12650 @itemx -mno-text-section-literals
12651 @opindex mtext-section-literals
12652 @opindex mno-text-section-literals
12653 Control the treatment of literal pools.  The default is
12654 @option{-mno-text-section-literals}, which places literals in a separate
12655 section in the output file.  This allows the literal pool to be placed
12656 in a data RAM/ROM, and it also allows the linker to combine literal
12657 pools from separate object files to remove redundant literals and
12658 improve code size.  With @option{-mtext-section-literals}, the literals
12659 are interspersed in the text section in order to keep them as close as
12660 possible to their references.  This may be necessary for large assembly
12661 files.
12663 @item -mtarget-align
12664 @itemx -mno-target-align
12665 @opindex mtarget-align
12666 @opindex mno-target-align
12667 When this option is enabled, GCC instructs the assembler to
12668 automatically align instructions to reduce branch penalties at the
12669 expense of some code density.  The assembler attempts to widen density
12670 instructions to align branch targets and the instructions following call
12671 instructions.  If there are not enough preceding safe density
12672 instructions to align a target, no widening will be performed.  The
12673 default is @option{-mtarget-align}.  These options do not affect the
12674 treatment of auto-aligned instructions like @code{LOOP}, which the
12675 assembler will always align, either by widening density instructions or
12676 by inserting no-op instructions.
12678 @item -mlongcalls
12679 @itemx -mno-longcalls
12680 @opindex mlongcalls
12681 @opindex mno-longcalls
12682 When this option is enabled, GCC instructs the assembler to translate
12683 direct calls to indirect calls unless it can determine that the target
12684 of a direct call is in the range allowed by the call instruction.  This
12685 translation typically occurs for calls to functions in other source
12686 files.  Specifically, the assembler translates a direct @code{CALL}
12687 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12688 The default is @option{-mno-longcalls}.  This option should be used in
12689 programs where the call target can potentially be out of range.  This
12690 option is implemented in the assembler, not the compiler, so the
12691 assembly code generated by GCC will still show direct call
12692 instructions---look at the disassembled object code to see the actual
12693 instructions.  Note that the assembler will use an indirect call for
12694 every cross-file call, not just those that really will be out of range.
12695 @end table
12697 @node zSeries Options
12698 @subsection zSeries Options
12699 @cindex zSeries options
12701 These are listed under @xref{S/390 and zSeries Options}.
12703 @node Code Gen Options
12704 @section Options for Code Generation Conventions
12705 @cindex code generation conventions
12706 @cindex options, code generation
12707 @cindex run-time options
12709 These machine-independent options control the interface conventions
12710 used in code generation.
12712 Most of them have both positive and negative forms; the negative form
12713 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12714 one of the forms is listed---the one which is not the default.  You
12715 can figure out the other form by either removing @samp{no-} or adding
12718 @table @gcctabopt
12719 @item -fbounds-check
12720 @opindex fbounds-check
12721 For front-ends that support it, generate additional code to check that
12722 indices used to access arrays are within the declared range.  This is
12723 currently only supported by the Java and Fortran 77 front-ends, where
12724 this option defaults to true and false respectively.
12726 @item -ftrapv
12727 @opindex ftrapv
12728 This option generates traps for signed overflow on addition, subtraction,
12729 multiplication operations.
12731 @item -fwrapv
12732 @opindex fwrapv
12733 This option instructs the compiler to assume that signed arithmetic
12734 overflow of addition, subtraction and multiplication wraps around
12735 using twos-complement representation.  This flag enables some optimizations
12736 and disables others.  This option is enabled by default for the Java
12737 front-end, as required by the Java language specification.
12739 @item -fexceptions
12740 @opindex fexceptions
12741 Enable exception handling.  Generates extra code needed to propagate
12742 exceptions.  For some targets, this implies GCC will generate frame
12743 unwind information for all functions, which can produce significant data
12744 size overhead, although it does not affect execution.  If you do not
12745 specify this option, GCC will enable it by default for languages like
12746 C++ which normally require exception handling, and disable it for
12747 languages like C that do not normally require it.  However, you may need
12748 to enable this option when compiling C code that needs to interoperate
12749 properly with exception handlers written in C++.  You may also wish to
12750 disable this option if you are compiling older C++ programs that don't
12751 use exception handling.
12753 @item -fnon-call-exceptions
12754 @opindex fnon-call-exceptions
12755 Generate code that allows trapping instructions to throw exceptions.
12756 Note that this requires platform-specific runtime support that does
12757 not exist everywhere.  Moreover, it only allows @emph{trapping}
12758 instructions to throw exceptions, i.e.@: memory references or floating
12759 point instructions.  It does not allow exceptions to be thrown from
12760 arbitrary signal handlers such as @code{SIGALRM}.
12762 @item -funwind-tables
12763 @opindex funwind-tables
12764 Similar to @option{-fexceptions}, except that it will just generate any needed
12765 static data, but will not affect the generated code in any other way.
12766 You will normally not enable this option; instead, a language processor
12767 that needs this handling would enable it on your behalf.
12769 @item -fasynchronous-unwind-tables
12770 @opindex fasynchronous-unwind-tables
12771 Generate unwind table in dwarf2 format, if supported by target machine.  The
12772 table is exact at each instruction boundary, so it can be used for stack
12773 unwinding from asynchronous events (such as debugger or garbage collector).
12775 @item -fpcc-struct-return
12776 @opindex fpcc-struct-return
12777 Return ``short'' @code{struct} and @code{union} values in memory like
12778 longer ones, rather than in registers.  This convention is less
12779 efficient, but it has the advantage of allowing intercallability between
12780 GCC-compiled files and files compiled with other compilers, particularly
12781 the Portable C Compiler (pcc).
12783 The precise convention for returning structures in memory depends
12784 on the target configuration macros.
12786 Short structures and unions are those whose size and alignment match
12787 that of some integer type.
12789 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12790 switch is not binary compatible with code compiled with the
12791 @option{-freg-struct-return} switch.
12792 Use it to conform to a non-default application binary interface.
12794 @item -freg-struct-return
12795 @opindex freg-struct-return
12796 Return @code{struct} and @code{union} values in registers when possible.
12797 This is more efficient for small structures than
12798 @option{-fpcc-struct-return}.
12800 If you specify neither @option{-fpcc-struct-return} nor
12801 @option{-freg-struct-return}, GCC defaults to whichever convention is
12802 standard for the target.  If there is no standard convention, GCC
12803 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12804 the principal compiler.  In those cases, we can choose the standard, and
12805 we chose the more efficient register return alternative.
12807 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12808 switch is not binary compatible with code compiled with the
12809 @option{-fpcc-struct-return} switch.
12810 Use it to conform to a non-default application binary interface.
12812 @item -fshort-enums
12813 @opindex fshort-enums
12814 Allocate to an @code{enum} type only as many bytes as it needs for the
12815 declared range of possible values.  Specifically, the @code{enum} type
12816 will be equivalent to the smallest integer type which has enough room.
12818 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12819 code that is not binary compatible with code generated without that switch.
12820 Use it to conform to a non-default application binary interface.
12822 @item -fshort-double
12823 @opindex fshort-double
12824 Use the same size for @code{double} as for @code{float}.
12826 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12827 code that is not binary compatible with code generated without that switch.
12828 Use it to conform to a non-default application binary interface.
12830 @item -fshort-wchar
12831 @opindex fshort-wchar
12832 Override the underlying type for @samp{wchar_t} to be @samp{short
12833 unsigned int} instead of the default for the target.  This option is
12834 useful for building programs to run under WINE@.
12836 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12837 code that is not binary compatible with code generated without that switch.
12838 Use it to conform to a non-default application binary interface.
12840 @item -fshared-data
12841 @opindex fshared-data
12842 Requests that the data and non-@code{const} variables of this
12843 compilation be shared data rather than private data.  The distinction
12844 makes sense only on certain operating systems, where shared data is
12845 shared between processes running the same program, while private data
12846 exists in one copy per process.
12848 @item -fno-common
12849 @opindex fno-common
12850 In C, allocate even uninitialized global variables in the data section of the
12851 object file, rather than generating them as common blocks.  This has the
12852 effect that if the same variable is declared (without @code{extern}) in
12853 two different compilations, you will get an error when you link them.
12854 The only reason this might be useful is if you wish to verify that the
12855 program will work on other systems which always work this way.
12857 @item -fno-ident
12858 @opindex fno-ident
12859 Ignore the @samp{#ident} directive.
12861 @item -finhibit-size-directive
12862 @opindex finhibit-size-directive
12863 Don't output a @code{.size} assembler directive, or anything else that
12864 would cause trouble if the function is split in the middle, and the
12865 two halves are placed at locations far apart in memory.  This option is
12866 used when compiling @file{crtstuff.c}; you should not need to use it
12867 for anything else.
12869 @item -fverbose-asm
12870 @opindex fverbose-asm
12871 Put extra commentary information in the generated assembly code to
12872 make it more readable.  This option is generally only of use to those
12873 who actually need to read the generated assembly code (perhaps while
12874 debugging the compiler itself).
12876 @option{-fno-verbose-asm}, the default, causes the
12877 extra information to be omitted and is useful when comparing two assembler
12878 files.
12880 @item -fpic
12881 @opindex fpic
12882 @cindex global offset table
12883 @cindex PIC
12884 Generate position-independent code (PIC) suitable for use in a shared
12885 library, if supported for the target machine.  Such code accesses all
12886 constant addresses through a global offset table (GOT)@.  The dynamic
12887 loader resolves the GOT entries when the program starts (the dynamic
12888 loader is not part of GCC; it is part of the operating system).  If
12889 the GOT size for the linked executable exceeds a machine-specific
12890 maximum size, you get an error message from the linker indicating that
12891 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12892 instead.  (These maximums are 8k on the SPARC and 32k
12893 on the m68k and RS/6000.  The 386 has no such limit.)
12895 Position-independent code requires special support, and therefore works
12896 only on certain machines.  For the 386, GCC supports PIC for System V
12897 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12898 position-independent.
12900 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12901 are defined to 1.
12903 @item -fPIC
12904 @opindex fPIC
12905 If supported for the target machine, emit position-independent code,
12906 suitable for dynamic linking and avoiding any limit on the size of the
12907 global offset table.  This option makes a difference on the m68k,
12908 PowerPC and SPARC@.
12910 Position-independent code requires special support, and therefore works
12911 only on certain machines.
12913 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
12914 are defined to 2.
12916 @item -fpie
12917 @itemx -fPIE
12918 @opindex fpie
12919 @opindex fPIE
12920 These options are similar to @option{-fpic} and @option{-fPIC}, but
12921 generated position independent code can be only linked into executables.
12922 Usually these options are used when @option{-pie} GCC option will be
12923 used during linking.
12925 @item -fno-jump-tables
12926 @opindex fno-jump-tables
12927 Do not use jump tables for switch statements even where it would be
12928 more efficient than other code generation strategies.  This option is
12929 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12930 building code which forms part of a dynamic linker and cannot
12931 reference the address of a jump table.  On some targets, jump tables
12932 do not require a GOT and this option is not needed.
12934 @item -ffixed-@var{reg}
12935 @opindex ffixed
12936 Treat the register named @var{reg} as a fixed register; generated code
12937 should never refer to it (except perhaps as a stack pointer, frame
12938 pointer or in some other fixed role).
12940 @var{reg} must be the name of a register.  The register names accepted
12941 are machine-specific and are defined in the @code{REGISTER_NAMES}
12942 macro in the machine description macro file.
12944 This flag does not have a negative form, because it specifies a
12945 three-way choice.
12947 @item -fcall-used-@var{reg}
12948 @opindex fcall-used
12949 Treat the register named @var{reg} as an allocable register that is
12950 clobbered by function calls.  It may be allocated for temporaries or
12951 variables that do not live across a call.  Functions compiled this way
12952 will not save and restore the register @var{reg}.
12954 It is an error to used this flag with the frame pointer or stack pointer.
12955 Use of this flag for other registers that have fixed pervasive roles in
12956 the machine's execution model will produce disastrous results.
12958 This flag does not have a negative form, because it specifies a
12959 three-way choice.
12961 @item -fcall-saved-@var{reg}
12962 @opindex fcall-saved
12963 Treat the register named @var{reg} as an allocable register saved by
12964 functions.  It may be allocated even for temporaries or variables that
12965 live across a call.  Functions compiled this way will save and restore
12966 the register @var{reg} if they use it.
12968 It is an error to used this flag with the frame pointer or stack pointer.
12969 Use of this flag for other registers that have fixed pervasive roles in
12970 the machine's execution model will produce disastrous results.
12972 A different sort of disaster will result from the use of this flag for
12973 a register in which function values may be returned.
12975 This flag does not have a negative form, because it specifies a
12976 three-way choice.
12978 @item -fpack-struct[=@var{n}]
12979 @opindex fpack-struct
12980 Without a value specified, pack all structure members together without
12981 holes.  When a value is specified (which must be a small power of two), pack
12982 structure members according to this value, representing the maximum
12983 alignment (that is, objects with default alignment requirements larger than
12984 this will be output potentially unaligned at the next fitting location.
12986 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12987 code that is not binary compatible with code generated without that switch.
12988 Additionally, it makes the code suboptimal.
12989 Use it to conform to a non-default application binary interface.
12991 @item -finstrument-functions
12992 @opindex finstrument-functions
12993 Generate instrumentation calls for entry and exit to functions.  Just
12994 after function entry and just before function exit, the following
12995 profiling functions will be called with the address of the current
12996 function and its call site.  (On some platforms,
12997 @code{__builtin_return_address} does not work beyond the current
12998 function, so the call site information may not be available to the
12999 profiling functions otherwise.)
13001 @smallexample
13002 void __cyg_profile_func_enter (void *this_fn,
13003                                void *call_site);
13004 void __cyg_profile_func_exit  (void *this_fn,
13005                                void *call_site);
13006 @end smallexample
13008 The first argument is the address of the start of the current function,
13009 which may be looked up exactly in the symbol table.
13011 This instrumentation is also done for functions expanded inline in other
13012 functions.  The profiling calls will indicate where, conceptually, the
13013 inline function is entered and exited.  This means that addressable
13014 versions of such functions must be available.  If all your uses of a
13015 function are expanded inline, this may mean an additional expansion of
13016 code size.  If you use @samp{extern inline} in your C code, an
13017 addressable version of such functions must be provided.  (This is
13018 normally the case anyways, but if you get lucky and the optimizer always
13019 expands the functions inline, you might have gotten away without
13020 providing static copies.)
13022 A function may be given the attribute @code{no_instrument_function}, in
13023 which case this instrumentation will not be done.  This can be used, for
13024 example, for the profiling functions listed above, high-priority
13025 interrupt routines, and any functions from which the profiling functions
13026 cannot safely be called (perhaps signal handlers, if the profiling
13027 routines generate output or allocate memory).
13029 @item -fstack-check
13030 @opindex fstack-check
13031 Generate code to verify that you do not go beyond the boundary of the
13032 stack.  You should specify this flag if you are running in an
13033 environment with multiple threads, but only rarely need to specify it in
13034 a single-threaded environment since stack overflow is automatically
13035 detected on nearly all systems if there is only one stack.
13037 Note that this switch does not actually cause checking to be done; the
13038 operating system must do that.  The switch causes generation of code
13039 to ensure that the operating system sees the stack being extended.
13041 @item -fstack-limit-register=@var{reg}
13042 @itemx -fstack-limit-symbol=@var{sym}
13043 @itemx -fno-stack-limit
13044 @opindex fstack-limit-register
13045 @opindex fstack-limit-symbol
13046 @opindex fno-stack-limit
13047 Generate code to ensure that the stack does not grow beyond a certain value,
13048 either the value of a register or the address of a symbol.  If the stack
13049 would grow beyond the value, a signal is raised.  For most targets,
13050 the signal is raised before the stack overruns the boundary, so
13051 it is possible to catch the signal without taking special precautions.
13053 For instance, if the stack starts at absolute address @samp{0x80000000}
13054 and grows downwards, you can use the flags
13055 @option{-fstack-limit-symbol=__stack_limit} and
13056 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13057 of 128KB@.  Note that this may only work with the GNU linker.
13059 @cindex aliasing of parameters
13060 @cindex parameters, aliased
13061 @item -fargument-alias
13062 @itemx -fargument-noalias
13063 @itemx -fargument-noalias-global
13064 @opindex fargument-alias
13065 @opindex fargument-noalias
13066 @opindex fargument-noalias-global
13067 Specify the possible relationships among parameters and between
13068 parameters and global data.
13070 @option{-fargument-alias} specifies that arguments (parameters) may
13071 alias each other and may alias global storage.@*
13072 @option{-fargument-noalias} specifies that arguments do not alias
13073 each other, but may alias global storage.@*
13074 @option{-fargument-noalias-global} specifies that arguments do not
13075 alias each other and do not alias global storage.
13077 Each language will automatically use whatever option is required by
13078 the language standard.  You should not need to use these options yourself.
13080 @item -fleading-underscore
13081 @opindex fleading-underscore
13082 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13083 change the way C symbols are represented in the object file.  One use
13084 is to help link with legacy assembly code.
13086 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13087 generate code that is not binary compatible with code generated without that
13088 switch.  Use it to conform to a non-default application binary interface.
13089 Not all targets provide complete support for this switch.
13091 @item -ftls-model=@var{model}
13092 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13093 The @var{model} argument should be one of @code{global-dynamic},
13094 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13096 The default without @option{-fpic} is @code{initial-exec}; with
13097 @option{-fpic} the default is @code{global-dynamic}.
13099 @item -fvisibility=@var{default|internal|hidden|protected}
13100 @opindex fvisibility
13101 Set the default ELF image symbol visibility to the specified option---all
13102 symbols will be marked with this unless overridden within the code.
13103 Using this feature can very substantially improve linking and
13104 load times of shared object libraries, produce more optimized
13105 code, provide near-perfect API export and prevent symbol clashes.
13106 It is @strong{strongly} recommended that you use this in any shared objects
13107 you distribute.
13109 Despite the nomenclature, @code{default} always means public ie;
13110 available to be linked against from outside the shared object.
13111 @code{protected} and @code{internal} are pretty useless in real-world
13112 usage so the only other commonly used option will be @code{hidden}.
13113 The default if @option{-fvisibility} isn't specified is
13114 @code{default}, i.e., make every
13115 symbol public---this causes the same behavior as previous versions of
13116 GCC@.
13118 A good explanation of the benefits offered by ensuring ELF
13119 symbols have the correct visibility is given by ``How To Write
13120 Shared Libraries'' by Ulrich Drepper (which can be found at
13121 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13122 solution made possible by this option to marking things hidden when
13123 the default is public is to make the default hidden and mark things
13124 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13125 and @code{__attribute__ ((visibility("default")))} instead of
13126 @code{__declspec(dllexport)} you get almost identical semantics with
13127 identical syntax.  This is a great boon to those working with
13128 cross-platform projects.
13130 For those adding visibility support to existing code, you may find
13131 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13132 the declarations you wish to set visibility for with (for example)
13133 @samp{#pragma GCC visibility push(hidden)} and
13134 @samp{#pragma GCC visibility pop}.
13135 Bear in mind that symbol visibility should be viewed @strong{as
13136 part of the API interface contract} and thus all new code should
13137 always specify visibility when it is not the default ie; declarations
13138 only for use within the local DSO should @strong{always} be marked explicitly
13139 as hidden as so to avoid PLT indirection overheads---making this
13140 abundantly clear also aids readability and self-documentation of the code.
13141 Note that due to ISO C++ specification requirements, operator new and
13142 operator delete must always be of default visibility.
13144 An overview of these techniques, their benefits and how to use them
13145 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13147 @end table
13149 @c man end
13151 @node Environment Variables
13152 @section Environment Variables Affecting GCC
13153 @cindex environment variables
13155 @c man begin ENVIRONMENT
13156 This section describes several environment variables that affect how GCC
13157 operates.  Some of them work by specifying directories or prefixes to use
13158 when searching for various kinds of files.  Some are used to specify other
13159 aspects of the compilation environment.
13161 Note that you can also specify places to search using options such as
13162 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13163 take precedence over places specified using environment variables, which
13164 in turn take precedence over those specified by the configuration of GCC@.
13165 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13166 GNU Compiler Collection (GCC) Internals}.
13168 @table @env
13169 @item LANG
13170 @itemx LC_CTYPE
13171 @c @itemx LC_COLLATE
13172 @itemx LC_MESSAGES
13173 @c @itemx LC_MONETARY
13174 @c @itemx LC_NUMERIC
13175 @c @itemx LC_TIME
13176 @itemx LC_ALL
13177 @findex LANG
13178 @findex LC_CTYPE
13179 @c @findex LC_COLLATE
13180 @findex LC_MESSAGES
13181 @c @findex LC_MONETARY
13182 @c @findex LC_NUMERIC
13183 @c @findex LC_TIME
13184 @findex LC_ALL
13185 @cindex locale
13186 These environment variables control the way that GCC uses
13187 localization information that allow GCC to work with different
13188 national conventions.  GCC inspects the locale categories
13189 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13190 so.  These locale categories can be set to any value supported by your
13191 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13192 Kingdom encoded in UTF-8.
13194 The @env{LC_CTYPE} environment variable specifies character
13195 classification.  GCC uses it to determine the character boundaries in
13196 a string; this is needed for some multibyte encodings that contain quote
13197 and escape characters that would otherwise be interpreted as a string
13198 end or escape.
13200 The @env{LC_MESSAGES} environment variable specifies the language to
13201 use in diagnostic messages.
13203 If the @env{LC_ALL} environment variable is set, it overrides the value
13204 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13205 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13206 environment variable.  If none of these variables are set, GCC
13207 defaults to traditional C English behavior.
13209 @item TMPDIR
13210 @findex TMPDIR
13211 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13212 files.  GCC uses temporary files to hold the output of one stage of
13213 compilation which is to be used as input to the next stage: for example,
13214 the output of the preprocessor, which is the input to the compiler
13215 proper.
13217 @item GCC_EXEC_PREFIX
13218 @findex GCC_EXEC_PREFIX
13219 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13220 names of the subprograms executed by the compiler.  No slash is added
13221 when this prefix is combined with the name of a subprogram, but you can
13222 specify a prefix that ends with a slash if you wish.
13224 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13225 an appropriate prefix to use based on the pathname it was invoked with.
13227 If GCC cannot find the subprogram using the specified prefix, it
13228 tries looking in the usual places for the subprogram.
13230 The default value of @env{GCC_EXEC_PREFIX} is
13231 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13232 of @code{prefix} when you ran the @file{configure} script.
13234 Other prefixes specified with @option{-B} take precedence over this prefix.
13236 This prefix is also used for finding files such as @file{crt0.o} that are
13237 used for linking.
13239 In addition, the prefix is used in an unusual way in finding the
13240 directories to search for header files.  For each of the standard
13241 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13242 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13243 replacing that beginning with the specified prefix to produce an
13244 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13245 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13246 These alternate directories are searched first; the standard directories
13247 come next.
13249 @item COMPILER_PATH
13250 @findex COMPILER_PATH
13251 The value of @env{COMPILER_PATH} is a colon-separated list of
13252 directories, much like @env{PATH}.  GCC tries the directories thus
13253 specified when searching for subprograms, if it can't find the
13254 subprograms using @env{GCC_EXEC_PREFIX}.
13256 @item LIBRARY_PATH
13257 @findex LIBRARY_PATH
13258 The value of @env{LIBRARY_PATH} is a colon-separated list of
13259 directories, much like @env{PATH}.  When configured as a native compiler,
13260 GCC tries the directories thus specified when searching for special
13261 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13262 using GCC also uses these directories when searching for ordinary
13263 libraries for the @option{-l} option (but directories specified with
13264 @option{-L} come first).
13266 @item LANG
13267 @findex LANG
13268 @cindex locale definition
13269 This variable is used to pass locale information to the compiler.  One way in
13270 which this information is used is to determine the character set to be used
13271 when character literals, string literals and comments are parsed in C and C++.
13272 When the compiler is configured to allow multibyte characters,
13273 the following values for @env{LANG} are recognized:
13275 @table @samp
13276 @item C-JIS
13277 Recognize JIS characters.
13278 @item C-SJIS
13279 Recognize SJIS characters.
13280 @item C-EUCJP
13281 Recognize EUCJP characters.
13282 @end table
13284 If @env{LANG} is not defined, or if it has some other value, then the
13285 compiler will use mblen and mbtowc as defined by the default locale to
13286 recognize and translate multibyte characters.
13287 @end table
13289 @noindent
13290 Some additional environments variables affect the behavior of the
13291 preprocessor.
13293 @include cppenv.texi
13295 @c man end
13297 @node Precompiled Headers
13298 @section Using Precompiled Headers
13299 @cindex precompiled headers
13300 @cindex speed of compilation
13302 Often large projects have many header files that are included in every
13303 source file.  The time the compiler takes to process these header files
13304 over and over again can account for nearly all of the time required to
13305 build the project.  To make builds faster, GCC allows users to
13306 `precompile' a header file; then, if builds can use the precompiled
13307 header file they will be much faster.
13309 To create a precompiled header file, simply compile it as you would any
13310 other file, if necessary using the @option{-x} option to make the driver
13311 treat it as a C or C++ header file.  You will probably want to use a
13312 tool like @command{make} to keep the precompiled header up-to-date when
13313 the headers it contains change.
13315 A precompiled header file will be searched for when @code{#include} is
13316 seen in the compilation.  As it searches for the included file
13317 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13318 compiler looks for a precompiled header in each directory just before it
13319 looks for the include file in that directory.  The name searched for is
13320 the name specified in the @code{#include} with @samp{.gch} appended.  If
13321 the precompiled header file can't be used, it is ignored.
13323 For instance, if you have @code{#include "all.h"}, and you have
13324 @file{all.h.gch} in the same directory as @file{all.h}, then the
13325 precompiled header file will be used if possible, and the original
13326 header will be used otherwise.
13328 Alternatively, you might decide to put the precompiled header file in a
13329 directory and use @option{-I} to ensure that directory is searched
13330 before (or instead of) the directory containing the original header.
13331 Then, if you want to check that the precompiled header file is always
13332 used, you can put a file of the same name as the original header in this
13333 directory containing an @code{#error} command.
13335 This also works with @option{-include}.  So yet another way to use
13336 precompiled headers, good for projects not designed with precompiled
13337 header files in mind, is to simply take most of the header files used by
13338 a project, include them from another header file, precompile that header
13339 file, and @option{-include} the precompiled header.  If the header files
13340 have guards against multiple inclusion, they will be skipped because
13341 they've already been included (in the precompiled header).
13343 If you need to precompile the same header file for different
13344 languages, targets, or compiler options, you can instead make a
13345 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13346 header in the directory, perhaps using @option{-o}.  It doesn't matter
13347 what you call the files in the directory, every precompiled header in
13348 the directory will be considered.  The first precompiled header
13349 encountered in the directory that is valid for this compilation will
13350 be used; they're searched in no particular order.
13352 There are many other possibilities, limited only by your imagination,
13353 good sense, and the constraints of your build system.
13355 A precompiled header file can be used only when these conditions apply:
13357 @itemize
13358 @item
13359 Only one precompiled header can be used in a particular compilation.
13361 @item
13362 A precompiled header can't be used once the first C token is seen.  You
13363 can have preprocessor directives before a precompiled header; you can
13364 even include a precompiled header from inside another header, so long as
13365 there are no C tokens before the @code{#include}.
13367 @item
13368 The precompiled header file must be produced for the same language as
13369 the current compilation.  You can't use a C precompiled header for a C++
13370 compilation.
13372 @item
13373 The precompiled header file must have been produced by the same compiler
13374 binary as the current compilation is using.
13376 @item
13377 Any macros defined before the precompiled header is included must
13378 either be defined in the same way as when the precompiled header was
13379 generated, or must not affect the precompiled header, which usually
13380 means that they don't appear in the precompiled header at all.
13382 The @option{-D} option is one way to define a macro before a
13383 precompiled header is included; using a @code{#define} can also do it.
13384 There are also some options that define macros implicitly, like
13385 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13386 defined this way.
13388 @item If debugging information is output when using the precompiled
13389 header, using @option{-g} or similar, the same kind of debugging information
13390 must have been output when building the precompiled header.  However,
13391 a precompiled header built using @option{-g} can be used in a compilation
13392 when no debugging information is being output.
13394 @item The same @option{-m} options must generally be used when building
13395 and using the precompiled header.  @xref{Submodel Options},
13396 for any cases where this rule is relaxed.
13398 @item Each of the following options must be the same when building and using
13399 the precompiled header:
13401 @gccoptlist{-fexceptions -funit-at-a-time}
13403 @item
13404 Some other command-line options starting with @option{-f},
13405 @option{-p}, or @option{-O} must be defined in the same way as when
13406 the precompiled header was generated.  At present, it's not clear
13407 which options are safe to change and which are not; the safest choice
13408 is to use exactly the same options when generating and using the
13409 precompiled header.  The following are known to be safe:
13411 @gccoptlist{-fmessage-length= -fpreprocessed
13412 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13413 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13414 -pedantic-errors}
13416 @end itemize
13418 For all of these except the last, the compiler will automatically
13419 ignore the precompiled header if the conditions aren't met.  If you
13420 find an option combination that doesn't work and doesn't cause the
13421 precompiled header to be ignored, please consider filing a bug report,
13422 see @ref{Bugs}.
13424 If you do use differing options when generating and using the
13425 precompiled header, the actual behavior will be a mixture of the
13426 behavior for the options.  For instance, if you use @option{-g} to
13427 generate the precompiled header but not when using it, you may or may
13428 not get debugging information for routines in the precompiled header.
13430 @node Running Protoize
13431 @section Running Protoize
13433 The program @code{protoize} is an optional part of GCC@.  You can use
13434 it to add prototypes to a program, thus converting the program to ISO
13435 C in one respect.  The companion program @code{unprotoize} does the
13436 reverse: it removes argument types from any prototypes that are found.
13438 When you run these programs, you must specify a set of source files as
13439 command line arguments.  The conversion programs start out by compiling
13440 these files to see what functions they define.  The information gathered
13441 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13443 After scanning comes actual conversion.  The specified files are all
13444 eligible to be converted; any files they include (whether sources or
13445 just headers) are eligible as well.
13447 But not all the eligible files are converted.  By default,
13448 @code{protoize} and @code{unprotoize} convert only source and header
13449 files in the current directory.  You can specify additional directories
13450 whose files should be converted with the @option{-d @var{directory}}
13451 option.  You can also specify particular files to exclude with the
13452 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13453 directory name matches one of the specified directory names, and its
13454 name within the directory has not been excluded.
13456 Basic conversion with @code{protoize} consists of rewriting most
13457 function definitions and function declarations to specify the types of
13458 the arguments.  The only ones not rewritten are those for varargs
13459 functions.
13461 @code{protoize} optionally inserts prototype declarations at the
13462 beginning of the source file, to make them available for any calls that
13463 precede the function's definition.  Or it can insert prototype
13464 declarations with block scope in the blocks where undeclared functions
13465 are called.
13467 Basic conversion with @code{unprotoize} consists of rewriting most
13468 function declarations to remove any argument types, and rewriting
13469 function definitions to the old-style pre-ISO form.
13471 Both conversion programs print a warning for any function declaration or
13472 definition that they can't convert.  You can suppress these warnings
13473 with @option{-q}.
13475 The output from @code{protoize} or @code{unprotoize} replaces the
13476 original source file.  The original file is renamed to a name ending
13477 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13478 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13479 for DOS) file already exists, then the source file is simply discarded.
13481 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13482 scan the program and collect information about the functions it uses.
13483 So neither of these programs will work until GCC is installed.
13485 Here is a table of the options you can use with @code{protoize} and
13486 @code{unprotoize}.  Each option works with both programs unless
13487 otherwise stated.
13489 @table @code
13490 @item -B @var{directory}
13491 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13492 usual directory (normally @file{/usr/local/lib}).  This file contains
13493 prototype information about standard system functions.  This option
13494 applies only to @code{protoize}.
13496 @item -c @var{compilation-options}
13497 Use @var{compilation-options} as the options when running @command{gcc} to
13498 produce the @samp{.X} files.  The special option @option{-aux-info} is
13499 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13501 Note that the compilation options must be given as a single argument to
13502 @code{protoize} or @code{unprotoize}.  If you want to specify several
13503 @command{gcc} options, you must quote the entire set of compilation options
13504 to make them a single word in the shell.
13506 There are certain @command{gcc} arguments that you cannot use, because they
13507 would produce the wrong kind of output.  These include @option{-g},
13508 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13509 the @var{compilation-options}, they are ignored.
13511 @item -C
13512 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13513 systems) instead of @samp{.c}.  This is convenient if you are converting
13514 a C program to C++.  This option applies only to @code{protoize}.
13516 @item -g
13517 Add explicit global declarations.  This means inserting explicit
13518 declarations at the beginning of each source file for each function
13519 that is called in the file and was not declared.  These declarations
13520 precede the first function definition that contains a call to an
13521 undeclared function.  This option applies only to @code{protoize}.
13523 @item -i @var{string}
13524 Indent old-style parameter declarations with the string @var{string}.
13525 This option applies only to @code{protoize}.
13527 @code{unprotoize} converts prototyped function definitions to old-style
13528 function definitions, where the arguments are declared between the
13529 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13530 uses five spaces as the indentation.  If you want to indent with just
13531 one space instead, use @option{-i " "}.
13533 @item -k
13534 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13535 is finished.
13537 @item -l
13538 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13539 a prototype declaration for each function in each block which calls the
13540 function without any declaration.  This option applies only to
13541 @code{protoize}.
13543 @item -n
13544 Make no real changes.  This mode just prints information about the conversions
13545 that would have been done without @option{-n}.
13547 @item -N
13548 Make no @samp{.save} files.  The original files are simply deleted.
13549 Use this option with caution.
13551 @item -p @var{program}
13552 Use the program @var{program} as the compiler.  Normally, the name
13553 @file{gcc} is used.
13555 @item -q
13556 Work quietly.  Most warnings are suppressed.
13558 @item -v
13559 Print the version number, just like @option{-v} for @command{gcc}.
13560 @end table
13562 If you need special compiler options to compile one of your program's
13563 source files, then you should generate that file's @samp{.X} file
13564 specially, by running @command{gcc} on that source file with the
13565 appropriate options and the option @option{-aux-info}.  Then run
13566 @code{protoize} on the entire set of files.  @code{protoize} will use
13567 the existing @samp{.X} file because it is newer than the source file.
13568 For example:
13570 @smallexample
13571 gcc -Dfoo=bar file1.c -aux-info file1.X
13572 protoize *.c
13573 @end smallexample
13575 @noindent
13576 You need to include the special files along with the rest in the
13577 @code{protoize} command, even though their @samp{.X} files already
13578 exist, because otherwise they won't get converted.
13580 @xref{Protoize Caveats}, for more information on how to use
13581 @code{protoize} successfully.