* predict.c (estimate_probability): Remove.
[official-gcc.git] / gcc / doc / invoke.texi
blob99fbf8f070719a08c8779d211d240ac0bb1f4269
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin INCLUDE
8 @include gcc-vers.texi
9 @c man end
11 @c man begin COPYRIGHT
12 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
13 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.2 or
17 any later version published by the Free Software Foundation; with the
18 Invariant Sections being ``GNU General Public License'' and ``Funding
19 Free Software'', the Front-Cover texts being (a) (see below), and with
20 the Back-Cover Texts being (b) (see below).  A copy of the license is
21 included in the gfdl(7) man page.
23 (a) The FSF's Front-Cover Text is:
25      A GNU Manual
27 (b) The FSF's Back-Cover Text is:
29      You have freedom to copy and modify this GNU Manual, like GNU
30      software.  Copies published by the Free Software Foundation raise
31      funds for GNU development.
32 @c man end
33 @c Set file name and title for the man page.
34 @setfilename gcc
35 @settitle GNU project C and C++ compiler
36 @c man begin SYNOPSIS
37 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
43     [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45 Only the most useful options are listed here; see below for the
46 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
47 @c man end
48 @c man begin SEEALSO
49 gpl(7), gfdl(7), fsf-funding(7),
50 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
52 @file{ld}, @file{binutils} and @file{gdb}.
53 @c man end
54 @c man begin BUGS
55 For instructions on reporting bugs, see
56 @w{@uref{http://gcc.gnu.org/bugs.html}}.
57 @c man end
58 @c man begin AUTHOR
59 See the Info entry for @command{gcc}, or
60 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61 for contributors to GCC@.
62 @c man end
63 @end ignore
65 @node Invoking GCC
66 @chapter GCC Command Options
67 @cindex GCC command options
68 @cindex command options
69 @cindex options, GCC command
71 @c man begin DESCRIPTION
72 When you invoke GCC, it normally does preprocessing, compilation,
73 assembly and linking.  The ``overall options'' allow you to stop this
74 process at an intermediate stage.  For example, the @option{-c} option
75 says not to run the linker.  Then the output consists of object files
76 output by the assembler.
78 Other options are passed on to one stage of processing.  Some options
79 control the preprocessor and others the compiler itself.  Yet other
80 options control the assembler and linker; most of these are not
81 documented here, since you rarely need to use any of them.
83 @cindex C compilation options
84 Most of the command line options that you can use with GCC are useful
85 for C programs; when an option is only useful with another language
86 (usually C++), the explanation says so explicitly.  If the description
87 for a particular option does not mention a source language, you can use
88 that option with all supported languages.
90 @cindex C++ compilation options
91 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92 options for compiling C++ programs.
94 @cindex grouping options
95 @cindex options, grouping
96 The @command{gcc} program accepts options and file names as operands.  Many
97 options have multi-letter names; therefore multiple single-letter options
98 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
99 -r}}.
101 @cindex order of options
102 @cindex options, order
103 You can mix options and other arguments.  For the most part, the order
104 you use doesn't matter.  Order does matter when you use several options
105 of the same kind; for example, if you specify @option{-L} more than once,
106 the directories are searched in the order specified.
108 Many options have long names starting with @samp{-f} or with
109 @samp{-W}---for example, 
110 @option{-fmove-loop-invariants}, @option{-Wformat} and so on.  Most of
111 these have both positive and negative forms; the negative form of
112 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
113 only one of these two forms, whichever one is not the default.
115 @c man end
117 @xref{Option Index}, for an index to GCC's options.
119 @menu
120 * Option Summary::      Brief list of all options, without explanations.
121 * Overall Options::     Controlling the kind of output:
122                         an executable, object files, assembler files,
123                         or preprocessed source.
124 * Invoking G++::        Compiling C++ programs.
125 * C Dialect Options::   Controlling the variant of C language compiled.
126 * C++ Dialect Options:: Variations on C++.
127 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128                         and Objective-C++.
129 * Language Independent Options:: Controlling how diagnostics should be
130                         formatted.
131 * Warning Options::     How picky should the compiler be?
132 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
133 * Optimize Options::    How much optimization?
134 * Preprocessor Options:: Controlling header files and macro definitions.
135                          Also, getting dependency information for Make.
136 * Assembler Options::   Passing options to the assembler.
137 * Link Options::        Specifying libraries and so on.
138 * Directory Options::   Where to find header files and libraries.
139                         Where to find the compiler executable files.
140 * Spec Files::          How to pass switches to sub-processes.
141 * Target Options::      Running a cross-compiler, or an old version of GCC.
142 * Submodel Options::    Specifying minor hardware or convention variations,
143                         such as 68010 vs 68020.
144 * Code Gen Options::    Specifying conventions for function calls, data layout
145                         and register usage.
146 * Environment Variables:: Env vars that affect GCC.
147 * Precompiled Headers:: Compiling a header once, and using it many times.
148 * Running Protoize::    Automatically adding or removing function prototypes.
149 @end menu
151 @c man begin OPTIONS
153 @node Option Summary
154 @section Option Summary
156 Here is a summary of all the options, grouped by type.  Explanations are
157 in the following sections.
159 @table @emph
160 @item Overall Options
161 @xref{Overall Options,,Options Controlling the Kind of Output}.
162 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
163 -x @var{language}  -v  -###  --help  --target-help  --version @@@var{file}}
165 @item C Language Options
166 @xref{C Dialect Options,,Options Controlling C Dialect}.
167 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
168 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
169 -fhosted  -ffreestanding  -fms-extensions @gol
170 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
171 -fallow-single-precision  -fcond-mismatch @gol
172 -fsigned-bitfields  -fsigned-char @gol
173 -funsigned-bitfields  -funsigned-char}
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
178 -fconserve-space  -ffriend-injection @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs @gol
181 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
182 -fno-implicit-templates @gol
183 -fno-implicit-inline-templates @gol
184 -fno-implement-inlines  -fms-extensions @gol
185 -fno-nonansi-builtins  -fno-operator-names @gol
186 -fno-optional-diags  -fpermissive @gol
187 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
188 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
189 -fno-default-inline  -fvisibility-inlines-hidden @gol
190 -Wabi  -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor  -Wreorder @gol
192 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
193 -Wno-non-template-friend  -Wold-style-cast @gol
194 -Woverloaded-virtual  -Wno-pmf-conversions @gol
195 -Wsign-promo}
197 @item Objective-C and Objective-C++ Language Options
198 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199 Objective-C and Objective-C++ Dialects}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime  -fnext-runtime @gol
203 -fno-nil-receivers @gol
204 -fobjc-call-cxx-cdtors @gol
205 -fobjc-direct-dispatch @gol
206 -fobjc-exceptions @gol
207 -fobjc-gc @gol
208 -freplace-objc-classes @gol
209 -fzero-link @gol
210 -gen-decls @gol
211 -Wassign-intercept @gol
212 -Wno-protocol  -Wselector @gol
213 -Wstrict-selector-match @gol
214 -Wundeclared-selector}
216 @item Language Independent Options
217 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218 @gccoptlist{-fmessage-length=@var{n}  @gol
219 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
220 -fdiagnostics-show-options
222 @item Warning Options
223 @xref{Warning Options,,Options to Request or Suppress Warnings}.
224 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
225 -w  -Wextra  -Wall  -Waggregate-return -Walways-true -Wno-attributes @gol
226 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
227 -Wconversion  -Wno-deprecated-declarations @gol
228 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
229 -Werror  -Werror-* -Werror-implicit-function-declaration @gol
230 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
231 -Wno-format-extra-args -Wformat-nonliteral @gol
232 -Wformat-security  -Wformat-y2k @gol
233 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
234 -Wimport  -Wno-import  -Winit-self  -Winline @gol
235 -Wno-int-to-pointer-cast @gol
236 -Wno-invalid-offsetof  -Winvalid-pch @gol
237 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
238 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
239 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
240 -Wmissing-noreturn @gol
241 -Wno-multichar  -Wnonnull  -Woverlength-strings  -Wpacked  -Wpadded @gol
242 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
243 -Wredundant-decls @gol
244 -Wreturn-type  -Wsequence-point  -Wshadow @gol
245 -Wsign-compare  -Wstack-protector @gol
246 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
247 -Wstring-literal-comparison @gol
248 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
249 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
250 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
251 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
252 -Wunused-value  -Wunused-variable  -Wvariadic-macros @gol
253 -Wvolatile-register-var  -Wwrite-strings}
255 @item C-only Warning Options
256 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
257 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
258 -Wstrict-prototypes  -Wtraditional @gol
259 -Wdeclaration-after-statement -Wpointer-sign}
261 @item Debugging Options
262 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
263 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
264 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
265 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
266 -fdump-ipa-all -fdump-ipa-cgraph @gol
267 -fdump-tree-all @gol
268 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
269 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272 -fdump-tree-ch @gol
273 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-nrv -fdump-tree-vect @gol
282 -fdump-tree-sink @gol
283 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-salias @gol
285 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
287 -ftree-vectorizer-verbose=@var{n} @gol
288 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
289 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
290 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
291 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
292 -ftest-coverage  -ftime-report -fvar-tracking @gol
293 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
294 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
295 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
296 -print-multi-directory  -print-multi-lib @gol
297 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
298 -save-temps  -time}
300 @item Optimization Options
301 @xref{Optimize Options,,Options that Control Optimization}.
302 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
303 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
304 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
305 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
306 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
307 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
308 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
309 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
310 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
311 -fforce-addr  -ffunction-sections @gol
312 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
313 -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
314 -finline-functions  -finline-functions-called-once @gol
315 -finline-limit=@var{n}  -fkeep-inline-functions @gol
316 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
317 -fmodulo-sched -fno-branch-count-reg @gol
318 -fno-default-inline  -fno-defer-pop -fmove-loop-invariants @gol
319 -fno-function-cse  -fno-guess-branch-probability @gol
320 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
321 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
322 -fno-toplevel-reorder -fno-trapping-math  -fno-zero-initialized-in-bss @gol
323 -fomit-frame-pointer  -foptimize-register-move @gol
324 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
325 -fprofile-generate -fprofile-use @gol
326 -fregmove  -frename-registers @gol
327 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
328 -frerun-cse-after-loop @gol
329 -frounding-math -frtl-abstract-sequences @gol
330 -fschedule-insns  -fschedule-insns2 @gol
331 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
332 -fsched-spec-load-dangerous  @gol
333 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
334 -fsched2-use-superblocks @gol
335 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
336 -fsection-anchors  -fsignaling-nans  -fsingle-precision-constant @gol
337 -fstack-protector  -fstack-protector-all @gol
338 -fstrict-aliasing  -ftracer  -fthread-jumps @gol
339 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
340 -fsplit-ivs-in-unroller -funswitch-loops @gol
341 -fvariable-expansion-in-unroller @gol
342 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
343 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
344 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
345 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
346 -ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
347 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
348 --param @var{name}=@var{value}
349 -O  -O0  -O1  -O2  -O3  -Os}
351 @item Preprocessor Options
352 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
353 @gccoptlist{-A@var{question}=@var{answer} @gol
354 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
355 -C  -dD  -dI  -dM  -dN @gol
356 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
357 -idirafter @var{dir} @gol
358 -include @var{file}  -imacros @var{file} @gol
359 -iprefix @var{file}  -iwithprefix @var{dir} @gol
360 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
361 -imultilib @var{dir} -isysroot @var{dir} @gol
362 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
363 -P  -fworking-directory  -remap @gol
364 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
365 -Xpreprocessor @var{option}}
367 @item Assembler Option
368 @xref{Assembler Options,,Passing Options to the Assembler}.
369 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
371 @item Linker Options
372 @xref{Link Options,,Options for Linking}.
373 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
374 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
375 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
376 -Wl,@var{option}  -Xlinker @var{option} @gol
377 -u @var{symbol}}
379 @item Directory Options
380 @xref{Directory Options,,Options for Directory Search}.
381 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
382 -specs=@var{file}  -I- --sysroot=@var{dir}}
384 @item Target Options
385 @c I wrote this xref this way to avoid overfull hbox. -- rms
386 @xref{Target Options}.
387 @gccoptlist{-V @var{version}  -b @var{machine}}
389 @item Machine Dependent Options
390 @xref{Submodel Options,,Hardware Models and Configurations}.
391 @c This list is ordered alphanumerically by subsection name.
392 @c Try and put the significant identifier (CPU or system) first,
393 @c so users have a clue at guessing where the ones they want will be.
395 @emph{ARC Options}
396 @gccoptlist{-EB  -EL @gol
397 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
398 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
400 @emph{ARM Options}
401 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
402 -mabi=@var{name} @gol
403 -mapcs-stack-check  -mno-apcs-stack-check @gol
404 -mapcs-float  -mno-apcs-float @gol
405 -mapcs-reentrant  -mno-apcs-reentrant @gol
406 -msched-prolog  -mno-sched-prolog @gol
407 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
408 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
409 -mthumb-interwork  -mno-thumb-interwork @gol
410 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
411 -mstructure-size-boundary=@var{n} @gol
412 -mabort-on-noreturn @gol
413 -mlong-calls  -mno-long-calls @gol
414 -msingle-pic-base  -mno-single-pic-base @gol
415 -mpic-register=@var{reg} @gol
416 -mnop-fun-dllimport @gol
417 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
418 -mpoke-function-name @gol
419 -mthumb  -marm @gol
420 -mtpcs-frame  -mtpcs-leaf-frame @gol
421 -mcaller-super-interworking  -mcallee-super-interworking @gol
422 -mtp=@var{name}}
424 @emph{AVR Options}
425 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
426 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
428 @emph{Blackfin Options}
429 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
430 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
431 -mlow-64k -mno-low64k -mid-shared-library @gol
432 -mno-id-shared-library -mshared-library-id=@var{n} @gol
433 -mlong-calls  -mno-long-calls}
435 @emph{CRIS Options}
436 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
437 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
438 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
439 -mstack-align  -mdata-align  -mconst-align @gol
440 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
441 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
442 -mmul-bug-workaround  -mno-mul-bug-workaround}
444 @emph{CRX Options}
445 @gccoptlist{-mmac -mpush-args}
447 @emph{Darwin Options}
448 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
449 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
450 -client_name  -compatibility_version  -current_version @gol
451 -dead_strip @gol
452 -dependency-file  -dylib_file  -dylinker_install_name @gol
453 -dynamic  -dynamiclib  -exported_symbols_list @gol
454 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
455 -force_flat_namespace  -headerpad_max_install_names @gol
456 -image_base  -init  -install_name  -keep_private_externs @gol
457 -multi_module  -multiply_defined  -multiply_defined_unused @gol
458 -noall_load   -no_dead_strip_inits_and_terms @gol
459 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
460 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
461 -private_bundle  -read_only_relocs  -sectalign @gol
462 -sectobjectsymbols  -whyload  -seg1addr @gol
463 -sectcreate  -sectobjectsymbols  -sectorder @gol
464 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
465 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
466 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
467 -single_module  -static  -sub_library  -sub_umbrella @gol
468 -twolevel_namespace  -umbrella  -undefined @gol
469 -unexported_symbols_list  -weak_reference_mismatches @gol
470 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
471 -mone-byte-bool}
473 @emph{DEC Alpha Options}
474 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
475 -mieee  -mieee-with-inexact  -mieee-conformant @gol
476 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
477 -mtrap-precision=@var{mode}  -mbuild-constants @gol
478 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
479 -mbwx  -mmax  -mfix  -mcix @gol
480 -mfloat-vax  -mfloat-ieee @gol
481 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
482 -msmall-text  -mlarge-text @gol
483 -mmemory-latency=@var{time}}
485 @emph{DEC Alpha/VMS Options}
486 @gccoptlist{-mvms-return-codes}
488 @emph{FRV Options}
489 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
490 -mhard-float  -msoft-float @gol
491 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
492 -mdouble  -mno-double @gol
493 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
494 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
495 -mlinked-fp  -mlong-calls  -malign-labels @gol
496 -mlibrary-pic  -macc-4  -macc-8 @gol
497 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
498 -moptimize-membar -mno-optimize-membar @gol
499 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
500 -mvliw-branch  -mno-vliw-branch @gol
501 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
502 -mno-nested-cond-exec  -mtomcat-stats @gol
503 -mTLS -mtls @gol
504 -mcpu=@var{cpu}}
506 @emph{GNU/Linux Options}
507 @gccoptlist{-muclibc}
509 @emph{H8/300 Options}
510 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
512 @emph{HPPA Options}
513 @gccoptlist{-march=@var{architecture-type} @gol
514 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
515 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
516 -mfixed-range=@var{register-range} @gol
517 -mjump-in-delay -mlinker-opt -mlong-calls @gol
518 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
519 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
520 -mno-jump-in-delay  -mno-long-load-store @gol
521 -mno-portable-runtime  -mno-soft-float @gol
522 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
523 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
524 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
525 -munix=@var{unix-std}  -nolibdld  -static  -threads}
527 @emph{i386 and x86-64 Options}
528 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
529 -mfpmath=@var{unit} @gol
530 -masm=@var{dialect}  -mno-fancy-math-387 @gol
531 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
532 -mno-wide-multiply  -mrtd  -malign-double @gol
533 -mpreferred-stack-boundary=@var{num} @gol
534 -mmmx  -msse  -msse2 -msse3 -m3dnow -msselibm @gol
535 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
536 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
537 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
538 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
539 -mcmodel=@var{code-model} @gol
540 -m32  -m64 -mlarge-data-threshold=@var{num}}
542 @emph{IA-64 Options}
543 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
544 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
545 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
546 -minline-float-divide-max-throughput @gol
547 -minline-int-divide-min-latency @gol
548 -minline-int-divide-max-throughput  @gol
549 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
550 -mno-dwarf2-asm -mearly-stop-bits @gol
551 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
552 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
554 @emph{M32R/D Options}
555 @gccoptlist{-m32r2 -m32rx -m32r @gol
556 -mdebug @gol
557 -malign-loops -mno-align-loops @gol
558 -missue-rate=@var{number} @gol
559 -mbranch-cost=@var{number} @gol
560 -mmodel=@var{code-size-model-type} @gol
561 -msdata=@var{sdata-type} @gol
562 -mno-flush-func -mflush-func=@var{name} @gol
563 -mno-flush-trap -mflush-trap=@var{number} @gol
564 -G @var{num}}
566 @emph{M32C Options}
567 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
569 @emph{M680x0 Options}
570 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
571 -m68060  -mcpu32  -m5200  -mcfv4e -m68881  -mbitfield  @gol
572 -mc68000  -mc68020   @gol
573 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
574 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
575 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
577 @emph{M68hc1x Options}
578 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
579 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
580 -msoft-reg-count=@var{count}}
582 @emph{MCore Options}
583 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
584 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
585 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
586 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
587 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
589 @emph{MIPS Options}
590 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
591 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
592 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
593 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
594 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
595 -mdsp  -mpaired-single  -mips3d @gol
596 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
597 -G@var{num}  -membedded-data  -mno-embedded-data @gol
598 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
599 -msplit-addresses  -mno-split-addresses  @gol
600 -mexplicit-relocs  -mno-explicit-relocs  @gol
601 -mcheck-zero-division  -mno-check-zero-division @gol
602 -mdivide-traps  -mdivide-breaks @gol
603 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
604 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
605 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
606 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
607 -mfix-sb1  -mno-fix-sb1 @gol
608 -mflush-func=@var{func}  -mno-flush-func @gol
609 -mbranch-likely  -mno-branch-likely @gol
610 -mfp-exceptions -mno-fp-exceptions @gol
611 -mvr4130-align -mno-vr4130-align}
613 @emph{MMIX Options}
614 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
615 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
616 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
617 -mno-base-addresses  -msingle-exit  -mno-single-exit}
619 @emph{MN10300 Options}
620 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
621 -mam33  -mno-am33 @gol
622 -mam33-2  -mno-am33-2 @gol
623 -mreturn-pointer-on-d0 @gol
624 -mno-crt0  -mrelax}
626 @emph{MT Options}
627 @gccoptlist{-mno-crt0 -mbacc -msim @gol
628 -march=@var{cpu-type} }
630 @emph{PDP-11 Options}
631 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
632 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
633 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
634 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
635 -mbranch-expensive  -mbranch-cheap @gol
636 -msplit  -mno-split  -munix-asm  -mdec-asm}
638 @emph{PowerPC Options}
639 See RS/6000 and PowerPC Options.
641 @emph{RS/6000 and PowerPC Options}
642 @gccoptlist{-mcpu=@var{cpu-type} @gol
643 -mtune=@var{cpu-type} @gol
644 -mpower  -mno-power  -mpower2  -mno-power2 @gol
645 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
646 -maltivec  -mno-altivec @gol
647 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
648 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
649 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb  -mfprnd  -mno-fprnd @gol
650 -mnew-mnemonics  -mold-mnemonics @gol
651 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
652 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
653 -malign-power  -malign-natural @gol
654 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
655 -mstring  -mno-string  -mupdate  -mno-update @gol
656 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
657 -mstrict-align  -mno-strict-align  -mrelocatable @gol
658 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
659 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
660 -mdynamic-no-pic  -maltivec  -mswdiv @gol
661 -mprioritize-restricted-insns=@var{priority} @gol
662 -msched-costly-dep=@var{dependence_type} @gol
663 -minsert-sched-nops=@var{scheme} @gol
664 -mcall-sysv  -mcall-netbsd @gol
665 -maix-struct-return  -msvr4-struct-return @gol
666 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
667 -misel -mno-isel @gol
668 -misel=yes  -misel=no @gol
669 -mspe -mno-spe @gol
670 -mspe=yes  -mspe=no @gol
671 -mvrsave -mno-vrsave @gol
672 -mmulhw -mno-mulhw @gol
673 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
674 -mprototype  -mno-prototype @gol
675 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
676 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
678 @emph{S/390 and zSeries Options}
679 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
680 -mhard-float  -msoft-float -mlong-double-64 -mlong-double-128 @gol
681 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
682 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
683 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
684 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
685 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
687 @emph{SH Options}
688 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
689 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
690 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
691 -m5-64media  -m5-64media-nofpu @gol
692 -m5-32media  -m5-32media-nofpu @gol
693 -m5-compact  -m5-compact-nofpu @gol
694 -mb  -ml  -mdalign  -mrelax @gol
695 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
696 -mieee  -misize  -mpadstruct  -mspace @gol
697 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
698 -mdivsi3_libfunc=@var{name}  @gol
699 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
700  -minvalid-symbols}
702 @emph{SPARC Options}
703 @gccoptlist{-mcpu=@var{cpu-type} @gol
704 -mtune=@var{cpu-type} @gol
705 -mcmodel=@var{code-model} @gol
706 -m32  -m64  -mapp-regs  -mno-app-regs @gol
707 -mfaster-structs  -mno-faster-structs @gol
708 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
709 -mhard-quad-float  -msoft-quad-float @gol
710 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
711 -mstack-bias  -mno-stack-bias @gol
712 -munaligned-doubles  -mno-unaligned-doubles @gol
713 -mv8plus  -mno-v8plus  -mvis  -mno-vis
714 -threads -pthreads -pthread}
716 @emph{System V Options}
717 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
719 @emph{TMS320C3x/C4x Options}
720 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
721 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
722 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
723 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
725 @emph{V850 Options}
726 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
727 -mprolog-function  -mno-prolog-function  -mspace @gol
728 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
729 -mapp-regs  -mno-app-regs @gol
730 -mdisable-callt  -mno-disable-callt @gol
731 -mv850e1 @gol
732 -mv850e @gol
733 -mv850  -mbig-switch}
735 @emph{VAX Options}
736 @gccoptlist{-mg  -mgnu  -munix}
738 @emph{x86-64 Options}
739 See i386 and x86-64 Options.
741 @emph{Xstormy16 Options}
742 @gccoptlist{-msim}
744 @emph{Xtensa Options}
745 @gccoptlist{-mconst16 -mno-const16 @gol
746 -mfused-madd  -mno-fused-madd @gol
747 -mtext-section-literals  -mno-text-section-literals @gol
748 -mtarget-align  -mno-target-align @gol
749 -mlongcalls  -mno-longcalls}
751 @emph{zSeries Options}
752 See S/390 and zSeries Options.
754 @item Code Generation Options
755 @xref{Code Gen Options,,Options for Code Generation Conventions}.
756 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
757 -ffixed-@var{reg}  -fexceptions @gol
758 -fnon-call-exceptions  -funwind-tables @gol
759 -fasynchronous-unwind-tables @gol
760 -finhibit-size-directive  -finstrument-functions @gol
761 -fno-common  -fno-ident @gol
762 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
763 -fno-jump-tables @gol
764 -freg-struct-return  -fshort-enums @gol
765 -fshort-double  -fshort-wchar @gol
766 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
767 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
768 -fargument-alias  -fargument-noalias @gol
769 -fargument-noalias-global  -fleading-underscore @gol
770 -ftls-model=@var{model} @gol
771 -ftrapv  -fwrapv  -fbounds-check @gol
772 -fvisibility  -fopenmp}
773 @end table
775 @menu
776 * Overall Options::     Controlling the kind of output:
777                         an executable, object files, assembler files,
778                         or preprocessed source.
779 * C Dialect Options::   Controlling the variant of C language compiled.
780 * C++ Dialect Options:: Variations on C++.
781 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
782                         and Objective-C++.
783 * Language Independent Options:: Controlling how diagnostics should be
784                         formatted.
785 * Warning Options::     How picky should the compiler be?
786 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
787 * Optimize Options::    How much optimization?
788 * Preprocessor Options:: Controlling header files and macro definitions.
789                          Also, getting dependency information for Make.
790 * Assembler Options::   Passing options to the assembler.
791 * Link Options::        Specifying libraries and so on.
792 * Directory Options::   Where to find header files and libraries.
793                         Where to find the compiler executable files.
794 * Spec Files::          How to pass switches to sub-processes.
795 * Target Options::      Running a cross-compiler, or an old version of GCC.
796 @end menu
798 @node Overall Options
799 @section Options Controlling the Kind of Output
801 Compilation can involve up to four stages: preprocessing, compilation
802 proper, assembly and linking, always in that order.  GCC is capable of
803 preprocessing and compiling several files either into several
804 assembler input files, or into one assembler input file; then each
805 assembler input file produces an object file, and linking combines all
806 the object files (those newly compiled, and those specified as input)
807 into an executable file.
809 @cindex file name suffix
810 For any given input file, the file name suffix determines what kind of
811 compilation is done:
813 @table @gcctabopt
814 @item @var{file}.c
815 C source code which must be preprocessed.
817 @item @var{file}.i
818 C source code which should not be preprocessed.
820 @item @var{file}.ii
821 C++ source code which should not be preprocessed.
823 @item @var{file}.m
824 Objective-C source code.  Note that you must link with the @file{libobjc}
825 library to make an Objective-C program work.
827 @item @var{file}.mi
828 Objective-C source code which should not be preprocessed.
830 @item @var{file}.mm
831 @itemx @var{file}.M
832 Objective-C++ source code.  Note that you must link with the @file{libobjc}
833 library to make an Objective-C++ program work.  Note that @samp{.M} refers
834 to a literal capital M@.
836 @item @var{file}.mii
837 Objective-C++ source code which should not be preprocessed.
839 @item @var{file}.h
840 C, C++, Objective-C or Objective-C++ header file to be turned into a
841 precompiled header.
843 @item @var{file}.cc
844 @itemx @var{file}.cp
845 @itemx @var{file}.cxx
846 @itemx @var{file}.cpp
847 @itemx @var{file}.CPP
848 @itemx @var{file}.c++
849 @itemx @var{file}.C
850 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
851 the last two letters must both be literally @samp{x}.  Likewise,
852 @samp{.C} refers to a literal capital C@.
854 @item @var{file}.mm
855 @itemx @var{file}.M
856 Objective-C++ source code which must be preprocessed.
858 @item @var{file}.mii
859 Objective-C++ source code which should not be preprocessed.
861 @item @var{file}.hh
862 @itemx @var{file}.H
863 C++ header file to be turned into a precompiled header.
865 @item @var{file}.f
866 @itemx @var{file}.for
867 @itemx @var{file}.FOR
868 Fixed form Fortran source code which should not be preprocessed.
870 @item @var{file}.F
871 @itemx @var{file}.fpp
872 @itemx @var{file}.FPP
873 Fixed form Fortran source code which must be preprocessed (with the traditional
874 preprocessor).
876 @item @var{file}.f90
877 @itemx @var{file}.f95
878 Free form Fortran source code which should not be preprocessed.
880 @item @var{file}.F90
881 @itemx @var{file}.F95
882 Free form Fortran source code which must be preprocessed (with the
883 traditional preprocessor).
885 @c FIXME: Descriptions of Java file types.
886 @c @var{file}.java
887 @c @var{file}.class
888 @c @var{file}.zip
889 @c @var{file}.jar
891 @item @var{file}.ads
892 Ada source code file which contains a library unit declaration (a
893 declaration of a package, subprogram, or generic, or a generic
894 instantiation), or a library unit renaming declaration (a package,
895 generic, or subprogram renaming declaration).  Such files are also
896 called @dfn{specs}.
898 @itemx @var{file}.adb
899 Ada source code file containing a library unit body (a subprogram or
900 package body).  Such files are also called @dfn{bodies}.
902 @c GCC also knows about some suffixes for languages not yet included:
903 @c Pascal:
904 @c @var{file}.p
905 @c @var{file}.pas
906 @c Ratfor:
907 @c @var{file}.r
909 @item @var{file}.s
910 Assembler code.
912 @item @var{file}.S
913 Assembler code which must be preprocessed.
915 @item @var{other}
916 An object file to be fed straight into linking.
917 Any file name with no recognized suffix is treated this way.
918 @end table
920 @opindex x
921 You can specify the input language explicitly with the @option{-x} option:
923 @table @gcctabopt
924 @item -x @var{language}
925 Specify explicitly the @var{language} for the following input files
926 (rather than letting the compiler choose a default based on the file
927 name suffix).  This option applies to all following input files until
928 the next @option{-x} option.  Possible values for @var{language} are:
929 @smallexample
930 c  c-header  c-cpp-output
931 c++  c++-header  c++-cpp-output
932 objective-c  objective-c-header  objective-c-cpp-output
933 objective-c++ objective-c++-header objective-c++-cpp-output
934 assembler  assembler-with-cpp
936 f77  f77-cpp-input
937 f95  f95-cpp-input
938 java
939 treelang
940 @end smallexample
942 @item -x none
943 Turn off any specification of a language, so that subsequent files are
944 handled according to their file name suffixes (as they are if @option{-x}
945 has not been used at all).
947 @item -pass-exit-codes
948 @opindex pass-exit-codes
949 Normally the @command{gcc} program will exit with the code of 1 if any
950 phase of the compiler returns a non-success return code.  If you specify
951 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
952 numerically highest error produced by any phase that returned an error
953 indication.
954 @end table
956 If you only want some of the stages of compilation, you can use
957 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
958 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
959 @command{gcc} is to stop.  Note that some combinations (for example,
960 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
962 @table @gcctabopt
963 @item -c
964 @opindex c
965 Compile or assemble the source files, but do not link.  The linking
966 stage simply is not done.  The ultimate output is in the form of an
967 object file for each source file.
969 By default, the object file name for a source file is made by replacing
970 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
972 Unrecognized input files, not requiring compilation or assembly, are
973 ignored.
975 @item -S
976 @opindex S
977 Stop after the stage of compilation proper; do not assemble.  The output
978 is in the form of an assembler code file for each non-assembler input
979 file specified.
981 By default, the assembler file name for a source file is made by
982 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
984 Input files that don't require compilation are ignored.
986 @item -E
987 @opindex E
988 Stop after the preprocessing stage; do not run the compiler proper.  The
989 output is in the form of preprocessed source code, which is sent to the
990 standard output.
992 Input files which don't require preprocessing are ignored.
994 @cindex output file option
995 @item -o @var{file}
996 @opindex o
997 Place output in file @var{file}.  This applies regardless to whatever
998 sort of output is being produced, whether it be an executable file,
999 an object file, an assembler file or preprocessed C code.
1001 If @option{-o} is not specified, the default is to put an executable
1002 file in @file{a.out}, the object file for
1003 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1004 assembler file in @file{@var{source}.s}, a precompiled header file in
1005 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1006 standard output.
1008 @item -v
1009 @opindex v
1010 Print (on standard error output) the commands executed to run the stages
1011 of compilation.  Also print the version number of the compiler driver
1012 program and of the preprocessor and the compiler proper.
1014 @item -###
1015 @opindex ###
1016 Like @option{-v} except the commands are not executed and all command
1017 arguments are quoted.  This is useful for shell scripts to capture the
1018 driver-generated command lines.
1020 @item -pipe
1021 @opindex pipe
1022 Use pipes rather than temporary files for communication between the
1023 various stages of compilation.  This fails to work on some systems where
1024 the assembler is unable to read from a pipe; but the GNU assembler has
1025 no trouble.
1027 @item -combine
1028 @opindex combine
1029 If you are compiling multiple source files, this option tells the driver
1030 to pass all the source files to the compiler at once (for those
1031 languages for which the compiler can handle this).  This will allow
1032 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1033 language for which this is supported is C@.  If you pass source files for
1034 multiple languages to the driver, using this option, the driver will invoke
1035 the compiler(s) that support IMA once each, passing each compiler all the
1036 source files appropriate for it.  For those languages that do not support
1037 IMA this option will be ignored, and the compiler will be invoked once for
1038 each source file in that language.  If you use this option in conjunction
1039 with @option{-save-temps}, the compiler will generate multiple
1040 pre-processed files
1041 (one for each source file), but only one (combined) @file{.o} or
1042 @file{.s} file.
1044 @item --help
1045 @opindex help
1046 Print (on the standard output) a description of the command line options
1047 understood by @command{gcc}.  If the @option{-v} option is also specified
1048 then @option{--help} will also be passed on to the various processes
1049 invoked by @command{gcc}, so that they can display the command line options
1050 they accept.  If the @option{-Wextra} option is also specified then command
1051 line options which have no documentation associated with them will also
1052 be displayed.
1054 @item --target-help
1055 @opindex target-help
1056 Print (on the standard output) a description of target specific command
1057 line options for each tool.
1059 @item --version
1060 @opindex version
1061 Display the version number and copyrights of the invoked GCC@.
1063 @include @value{srcdir}/../libiberty/at-file.texi
1064 @end table
1066 @node Invoking G++
1067 @section Compiling C++ Programs
1069 @cindex suffixes for C++ source
1070 @cindex C++ source file suffixes
1071 C++ source files conventionally use one of the suffixes @samp{.C},
1072 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1073 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1074 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1075 files with these names and compiles them as C++ programs even if you
1076 call the compiler the same way as for compiling C programs (usually
1077 with the name @command{gcc}).
1079 @findex g++
1080 @findex c++
1081 However, C++ programs often require class libraries as well as a
1082 compiler that understands the C++ language---and under some
1083 circumstances, you might want to compile programs or header files from
1084 standard input, or otherwise without a suffix that flags them as C++
1085 programs.  You might also like to precompile a C header file with a
1086 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1087 program that calls GCC with the default language set to C++, and
1088 automatically specifies linking against the C++ library.  On many
1089 systems, @command{g++} is also installed with the name @command{c++}.
1091 @cindex invoking @command{g++}
1092 When you compile C++ programs, you may specify many of the same
1093 command-line options that you use for compiling programs in any
1094 language; or command-line options meaningful for C and related
1095 languages; or options that are meaningful only for C++ programs.
1096 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1097 explanations of options for languages related to C@.
1098 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1099 explanations of options that are meaningful only for C++ programs.
1101 @node C Dialect Options
1102 @section Options Controlling C Dialect
1103 @cindex dialect options
1104 @cindex language dialect options
1105 @cindex options, dialect
1107 The following options control the dialect of C (or languages derived
1108 from C, such as C++, Objective-C and Objective-C++) that the compiler
1109 accepts:
1111 @table @gcctabopt
1112 @cindex ANSI support
1113 @cindex ISO support
1114 @item -ansi
1115 @opindex ansi
1116 In C mode, support all ISO C90 programs.  In C++ mode,
1117 remove GNU extensions that conflict with ISO C++.
1119 This turns off certain features of GCC that are incompatible with ISO
1120 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1121 such as the @code{asm} and @code{typeof} keywords, and
1122 predefined macros such as @code{unix} and @code{vax} that identify the
1123 type of system you are using.  It also enables the undesirable and
1124 rarely used ISO trigraph feature.  For the C compiler,
1125 it disables recognition of C++ style @samp{//} comments as well as
1126 the @code{inline} keyword.
1128 The alternate keywords @code{__asm__}, @code{__extension__},
1129 @code{__inline__} and @code{__typeof__} continue to work despite
1130 @option{-ansi}.  You would not want to use them in an ISO C program, of
1131 course, but it is useful to put them in header files that might be included
1132 in compilations done with @option{-ansi}.  Alternate predefined macros
1133 such as @code{__unix__} and @code{__vax__} are also available, with or
1134 without @option{-ansi}.
1136 The @option{-ansi} option does not cause non-ISO programs to be
1137 rejected gratuitously.  For that, @option{-pedantic} is required in
1138 addition to @option{-ansi}.  @xref{Warning Options}.
1140 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1141 option is used.  Some header files may notice this macro and refrain
1142 from declaring certain functions or defining certain macros that the
1143 ISO standard doesn't call for; this is to avoid interfering with any
1144 programs that might use these names for other things.
1146 Functions which would normally be built in but do not have semantics
1147 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1148 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1149 built-in functions provided by GCC}, for details of the functions
1150 affected.
1152 @item -std=
1153 @opindex std
1154 Determine the language standard.  This option is currently only
1155 supported when compiling C or C++.  A value for this option must be
1156 provided; possible values are
1158 @table @samp
1159 @item c89
1160 @itemx iso9899:1990
1161 ISO C90 (same as @option{-ansi}).
1163 @item iso9899:199409
1164 ISO C90 as modified in amendment 1.
1166 @item c99
1167 @itemx c9x
1168 @itemx iso9899:1999
1169 @itemx iso9899:199x
1170 ISO C99.  Note that this standard is not yet fully supported; see
1171 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1172 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1174 @item gnu89
1175 Default, ISO C90 plus GNU extensions (including some C99 features).
1177 @item gnu99
1178 @itemx gnu9x
1179 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1180 this will become the default.  The name @samp{gnu9x} is deprecated.
1182 @item c++98
1183 The 1998 ISO C++ standard plus amendments.
1185 @item gnu++98
1186 The same as @option{-std=c++98} plus GNU extensions.  This is the
1187 default for C++ code.
1188 @end table
1190 Even when this option is not specified, you can still use some of the
1191 features of newer standards in so far as they do not conflict with
1192 previous C standards.  For example, you may use @code{__restrict__} even
1193 when @option{-std=c99} is not specified.
1195 The @option{-std} options specifying some version of ISO C have the same
1196 effects as @option{-ansi}, except that features that were not in ISO C90
1197 but are in the specified version (for example, @samp{//} comments and
1198 the @code{inline} keyword in ISO C99) are not disabled.
1200 @xref{Standards,,Language Standards Supported by GCC}, for details of
1201 these standard versions.
1203 @item -aux-info @var{filename}
1204 @opindex aux-info
1205 Output to the given filename prototyped declarations for all functions
1206 declared and/or defined in a translation unit, including those in header
1207 files.  This option is silently ignored in any language other than C@.
1209 Besides declarations, the file indicates, in comments, the origin of
1210 each declaration (source file and line), whether the declaration was
1211 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1212 @samp{O} for old, respectively, in the first character after the line
1213 number and the colon), and whether it came from a declaration or a
1214 definition (@samp{C} or @samp{F}, respectively, in the following
1215 character).  In the case of function definitions, a K&R-style list of
1216 arguments followed by their declarations is also provided, inside
1217 comments, after the declaration.
1219 @item -fno-asm
1220 @opindex fno-asm
1221 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1222 keyword, so that code can use these words as identifiers.  You can use
1223 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1224 instead.  @option{-ansi} implies @option{-fno-asm}.
1226 In C++, this switch only affects the @code{typeof} keyword, since
1227 @code{asm} and @code{inline} are standard keywords.  You may want to
1228 use the @option{-fno-gnu-keywords} flag instead, which has the same
1229 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1230 switch only affects the @code{asm} and @code{typeof} keywords, since
1231 @code{inline} is a standard keyword in ISO C99.
1233 @item -fno-builtin
1234 @itemx -fno-builtin-@var{function}
1235 @opindex fno-builtin
1236 @cindex built-in functions
1237 Don't recognize built-in functions that do not begin with
1238 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1239 functions provided by GCC}, for details of the functions affected,
1240 including those which are not built-in functions when @option{-ansi} or
1241 @option{-std} options for strict ISO C conformance are used because they
1242 do not have an ISO standard meaning.
1244 GCC normally generates special code to handle certain built-in functions
1245 more efficiently; for instance, calls to @code{alloca} may become single
1246 instructions that adjust the stack directly, and calls to @code{memcpy}
1247 may become inline copy loops.  The resulting code is often both smaller
1248 and faster, but since the function calls no longer appear as such, you
1249 cannot set a breakpoint on those calls, nor can you change the behavior
1250 of the functions by linking with a different library.  In addition,
1251 when a function is recognized as a built-in function, GCC may use
1252 information about that function to warn about problems with calls to
1253 that function, or to generate more efficient code, even if the
1254 resulting code still contains calls to that function.  For example,
1255 warnings are given with @option{-Wformat} for bad calls to
1256 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1257 known not to modify global memory.
1259 With the @option{-fno-builtin-@var{function}} option
1260 only the built-in function @var{function} is
1261 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1262 function is named this is not built-in in this version of GCC, this
1263 option is ignored.  There is no corresponding
1264 @option{-fbuiltin-@var{function}} option; if you wish to enable
1265 built-in functions selectively when using @option{-fno-builtin} or
1266 @option{-ffreestanding}, you may define macros such as:
1268 @smallexample
1269 #define abs(n)          __builtin_abs ((n))
1270 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1271 @end smallexample
1273 @item -fhosted
1274 @opindex fhosted
1275 @cindex hosted environment
1277 Assert that compilation takes place in a hosted environment.  This implies
1278 @option{-fbuiltin}.  A hosted environment is one in which the
1279 entire standard library is available, and in which @code{main} has a return
1280 type of @code{int}.  Examples are nearly everything except a kernel.
1281 This is equivalent to @option{-fno-freestanding}.
1283 @item -ffreestanding
1284 @opindex ffreestanding
1285 @cindex hosted environment
1287 Assert that compilation takes place in a freestanding environment.  This
1288 implies @option{-fno-builtin}.  A freestanding environment
1289 is one in which the standard library may not exist, and program startup may
1290 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1291 This is equivalent to @option{-fno-hosted}.
1293 @xref{Standards,,Language Standards Supported by GCC}, for details of
1294 freestanding and hosted environments.
1296 @item -fms-extensions
1297 @opindex fms-extensions
1298 Accept some non-standard constructs used in Microsoft header files.
1300 Some cases of unnamed fields in structures and unions are only
1301 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1302 fields within structs/unions}, for details.
1304 @item -trigraphs
1305 @opindex trigraphs
1306 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1307 options for strict ISO C conformance) implies @option{-trigraphs}.
1309 @item -no-integrated-cpp
1310 @opindex no-integrated-cpp
1311 Performs a compilation in two passes: preprocessing and compiling.  This
1312 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1313 @option{-B} option.  The user supplied compilation step can then add in
1314 an additional preprocessing step after normal preprocessing but before
1315 compiling.  The default is to use the integrated cpp (internal cpp)
1317 The semantics of this option will change if "cc1", "cc1plus", and
1318 "cc1obj" are merged.
1320 @cindex traditional C language
1321 @cindex C language, traditional
1322 @item -traditional
1323 @itemx -traditional-cpp
1324 @opindex traditional-cpp
1325 @opindex traditional
1326 Formerly, these options caused GCC to attempt to emulate a pre-standard
1327 C compiler.  They are now only supported with the @option{-E} switch.
1328 The preprocessor continues to support a pre-standard mode.  See the GNU
1329 CPP manual for details.
1331 @item -fcond-mismatch
1332 @opindex fcond-mismatch
1333 Allow conditional expressions with mismatched types in the second and
1334 third arguments.  The value of such an expression is void.  This option
1335 is not supported for C++.
1337 @item -funsigned-char
1338 @opindex funsigned-char
1339 Let the type @code{char} be unsigned, like @code{unsigned char}.
1341 Each kind of machine has a default for what @code{char} should
1342 be.  It is either like @code{unsigned char} by default or like
1343 @code{signed char} by default.
1345 Ideally, a portable program should always use @code{signed char} or
1346 @code{unsigned char} when it depends on the signedness of an object.
1347 But many programs have been written to use plain @code{char} and
1348 expect it to be signed, or expect it to be unsigned, depending on the
1349 machines they were written for.  This option, and its inverse, let you
1350 make such a program work with the opposite default.
1352 The type @code{char} is always a distinct type from each of
1353 @code{signed char} or @code{unsigned char}, even though its behavior
1354 is always just like one of those two.
1356 @item -fsigned-char
1357 @opindex fsigned-char
1358 Let the type @code{char} be signed, like @code{signed char}.
1360 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1361 the negative form of @option{-funsigned-char}.  Likewise, the option
1362 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1364 @item -fsigned-bitfields
1365 @itemx -funsigned-bitfields
1366 @itemx -fno-signed-bitfields
1367 @itemx -fno-unsigned-bitfields
1368 @opindex fsigned-bitfields
1369 @opindex funsigned-bitfields
1370 @opindex fno-signed-bitfields
1371 @opindex fno-unsigned-bitfields
1372 These options control whether a bit-field is signed or unsigned, when the
1373 declaration does not use either @code{signed} or @code{unsigned}.  By
1374 default, such a bit-field is signed, because this is consistent: the
1375 basic integer types such as @code{int} are signed types.
1376 @end table
1378 @node C++ Dialect Options
1379 @section Options Controlling C++ Dialect
1381 @cindex compiler options, C++
1382 @cindex C++ options, command line
1383 @cindex options, C++
1384 This section describes the command-line options that are only meaningful
1385 for C++ programs; but you can also use most of the GNU compiler options
1386 regardless of what language your program is in.  For example, you
1387 might compile a file @code{firstClass.C} like this:
1389 @smallexample
1390 g++ -g -frepo -O -c firstClass.C
1391 @end smallexample
1393 @noindent
1394 In this example, only @option{-frepo} is an option meant
1395 only for C++ programs; you can use the other options with any
1396 language supported by GCC@.
1398 Here is a list of options that are @emph{only} for compiling C++ programs:
1400 @table @gcctabopt
1402 @item -fabi-version=@var{n}
1403 @opindex fabi-version
1404 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1405 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1406 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1407 the version that conforms most closely to the C++ ABI specification.
1408 Therefore, the ABI obtained using version 0 will change as ABI bugs
1409 are fixed.
1411 The default is version 2.
1413 @item -fno-access-control
1414 @opindex fno-access-control
1415 Turn off all access checking.  This switch is mainly useful for working
1416 around bugs in the access control code.
1418 @item -fcheck-new
1419 @opindex fcheck-new
1420 Check that the pointer returned by @code{operator new} is non-null
1421 before attempting to modify the storage allocated.  This check is
1422 normally unnecessary because the C++ standard specifies that
1423 @code{operator new} will only return @code{0} if it is declared
1424 @samp{throw()}, in which case the compiler will always check the
1425 return value even without this option.  In all other cases, when
1426 @code{operator new} has a non-empty exception specification, memory
1427 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1428 @samp{new (nothrow)}.
1430 @item -fconserve-space
1431 @opindex fconserve-space
1432 Put uninitialized or runtime-initialized global variables into the
1433 common segment, as C does.  This saves space in the executable at the
1434 cost of not diagnosing duplicate definitions.  If you compile with this
1435 flag and your program mysteriously crashes after @code{main()} has
1436 completed, you may have an object that is being destroyed twice because
1437 two definitions were merged.
1439 This option is no longer useful on most targets, now that support has
1440 been added for putting variables into BSS without making them common.
1442 @item -ffriend-injection
1443 @opindex ffriend-injection
1444 Inject friend functions into the enclosing namespace, so that they are
1445 visible outside the scope of the class in which they are declared.
1446 Friend functions were documented to work this way in the old Annotated
1447 C++ Reference Manual, and versions of G++ before 4.1 always worked
1448 that way.  However, in ISO C++ a friend function which is not declared
1449 in an enclosing scope can only be found using argument dependent
1450 lookup.  This option causes friends to be injected as they were in
1451 earlier releases.
1453 This option is for compatibility, and may be removed in a future
1454 release of G++.
1456 @item -fno-elide-constructors
1457 @opindex fno-elide-constructors
1458 The C++ standard allows an implementation to omit creating a temporary
1459 which is only used to initialize another object of the same type.
1460 Specifying this option disables that optimization, and forces G++ to
1461 call the copy constructor in all cases.
1463 @item -fno-enforce-eh-specs
1464 @opindex fno-enforce-eh-specs
1465 Don't generate code to check for violation of exception specifications
1466 at runtime.  This option violates the C++ standard, but may be useful
1467 for reducing code size in production builds, much like defining
1468 @samp{NDEBUG}.  This does not give user code permission to throw
1469 exceptions in violation of the exception specifications; the compiler
1470 will still optimize based on the specifications, so throwing an
1471 unexpected exception will result in undefined behavior.
1473 @item -ffor-scope
1474 @itemx -fno-for-scope
1475 @opindex ffor-scope
1476 @opindex fno-for-scope
1477 If @option{-ffor-scope} is specified, the scope of variables declared in
1478 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1479 as specified by the C++ standard.
1480 If @option{-fno-for-scope} is specified, the scope of variables declared in
1481 a @i{for-init-statement} extends to the end of the enclosing scope,
1482 as was the case in old versions of G++, and other (traditional)
1483 implementations of C++.
1485 The default if neither flag is given to follow the standard,
1486 but to allow and give a warning for old-style code that would
1487 otherwise be invalid, or have different behavior.
1489 @item -fno-gnu-keywords
1490 @opindex fno-gnu-keywords
1491 Do not recognize @code{typeof} as a keyword, so that code can use this
1492 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1493 @option{-ansi} implies @option{-fno-gnu-keywords}.
1495 @item -fno-implicit-templates
1496 @opindex fno-implicit-templates
1497 Never emit code for non-inline templates which are instantiated
1498 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1499 @xref{Template Instantiation}, for more information.
1501 @item -fno-implicit-inline-templates
1502 @opindex fno-implicit-inline-templates
1503 Don't emit code for implicit instantiations of inline templates, either.
1504 The default is to handle inlines differently so that compiles with and
1505 without optimization will need the same set of explicit instantiations.
1507 @item -fno-implement-inlines
1508 @opindex fno-implement-inlines
1509 To save space, do not emit out-of-line copies of inline functions
1510 controlled by @samp{#pragma implementation}.  This will cause linker
1511 errors if these functions are not inlined everywhere they are called.
1513 @item -fms-extensions
1514 @opindex fms-extensions
1515 Disable pedantic warnings about constructs used in MFC, such as implicit
1516 int and getting a pointer to member function via non-standard syntax.
1518 @item -fno-nonansi-builtins
1519 @opindex fno-nonansi-builtins
1520 Disable built-in declarations of functions that are not mandated by
1521 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1522 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1524 @item -fno-operator-names
1525 @opindex fno-operator-names
1526 Do not treat the operator name keywords @code{and}, @code{bitand},
1527 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1528 synonyms as keywords.
1530 @item -fno-optional-diags
1531 @opindex fno-optional-diags
1532 Disable diagnostics that the standard says a compiler does not need to
1533 issue.  Currently, the only such diagnostic issued by G++ is the one for
1534 a name having multiple meanings within a class.
1536 @item -fpermissive
1537 @opindex fpermissive
1538 Downgrade some diagnostics about nonconformant code from errors to
1539 warnings.  Thus, using @option{-fpermissive} will allow some
1540 nonconforming code to compile.
1542 @item -frepo
1543 @opindex frepo
1544 Enable automatic template instantiation at link time.  This option also
1545 implies @option{-fno-implicit-templates}.  @xref{Template
1546 Instantiation}, for more information.
1548 @item -fno-rtti
1549 @opindex fno-rtti
1550 Disable generation of information about every class with virtual
1551 functions for use by the C++ runtime type identification features
1552 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1553 of the language, you can save some space by using this flag.  Note that
1554 exception handling uses the same information, but it will generate it as
1555 needed.
1557 @item -fstats
1558 @opindex fstats
1559 Emit statistics about front-end processing at the end of the compilation.
1560 This information is generally only useful to the G++ development team.
1562 @item -ftemplate-depth-@var{n}
1563 @opindex ftemplate-depth
1564 Set the maximum instantiation depth for template classes to @var{n}.
1565 A limit on the template instantiation depth is needed to detect
1566 endless recursions during template class instantiation.  ANSI/ISO C++
1567 conforming programs must not rely on a maximum depth greater than 17.
1569 @item -fno-threadsafe-statics
1570 @opindex fno-threadsafe-statics
1571 Do not emit the extra code to use the routines specified in the C++
1572 ABI for thread-safe initialization of local statics.  You can use this
1573 option to reduce code size slightly in code that doesn't need to be
1574 thread-safe.
1576 @item -fuse-cxa-atexit
1577 @opindex fuse-cxa-atexit
1578 Register destructors for objects with static storage duration with the
1579 @code{__cxa_atexit} function rather than the @code{atexit} function.
1580 This option is required for fully standards-compliant handling of static
1581 destructors, but will only work if your C library supports
1582 @code{__cxa_atexit}.
1584 @item -fno-use-cxa-get-exception-ptr
1585 @opindex fno-use-cxa-get-exception-ptr
1586 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
1587 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1588 if the runtime routine is not available.
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.  This warning is also
1739 enabled if -Weffc++ is specified.
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.  This option is
1992 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
1993 earlier.
1995 @smallexample
1996   @@try @{
1997     @dots{}
1998        @@throw expr;
1999     @dots{}
2000   @}
2001   @@catch (AnObjCClass *exc) @{
2002     @dots{}
2003       @@throw expr;
2004     @dots{}
2005       @@throw;
2006     @dots{}
2007   @}
2008   @@catch (AnotherClass *exc) @{
2009     @dots{}
2010   @}
2011   @@catch (id allOthers) @{
2012     @dots{}
2013   @}
2014   @@finally @{
2015     @dots{}
2016       @@throw expr;
2017     @dots{}
2018   @}
2019 @end smallexample
2021 The @code{@@throw} statement may appear anywhere in an Objective-C or
2022 Objective-C++ program; when used inside of a @code{@@catch} block, the
2023 @code{@@throw} may appear without an argument (as shown above), in which case
2024 the object caught by the @code{@@catch} will be rethrown.
2026 Note that only (pointers to) Objective-C objects may be thrown and
2027 caught using this scheme.  When an object is thrown, it will be caught
2028 by the nearest @code{@@catch} clause capable of handling objects of that type,
2029 analogously to how @code{catch} blocks work in C++ and Java.  A
2030 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2031 any and all Objective-C exceptions not caught by previous @code{@@catch}
2032 clauses (if any).
2034 The @code{@@finally} clause, if present, will be executed upon exit from the
2035 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
2036 regardless of whether any exceptions are thrown, caught or rethrown
2037 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2038 of the @code{finally} clause in Java.
2040 There are several caveats to using the new exception mechanism:
2042 @itemize @bullet
2043 @item
2044 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2045 idioms provided by the @code{NSException} class, the new
2046 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2047 systems, due to additional functionality needed in the (NeXT) Objective-C
2048 runtime.
2050 @item
2051 As mentioned above, the new exceptions do not support handling
2052 types other than Objective-C objects.   Furthermore, when used from
2053 Objective-C++, the Objective-C exception model does not interoperate with C++
2054 exceptions at this time.  This means you cannot @code{@@throw} an exception
2055 from Objective-C and @code{catch} it in C++, or vice versa
2056 (i.e., @code{throw @dots{} @@catch}).
2057 @end itemize
2059 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2060 blocks for thread-safe execution:
2062 @smallexample
2063   @@synchronized (ObjCClass *guard) @{
2064     @dots{}
2065   @}
2066 @end smallexample
2068 Upon entering the @code{@@synchronized} block, a thread of execution shall
2069 first check whether a lock has been placed on the corresponding @code{guard}
2070 object by another thread.  If it has, the current thread shall wait until
2071 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2072 the current thread will place its own lock on it, execute the code contained in
2073 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2074 making @code{guard} available to other threads).
2076 Unlike Java, Objective-C does not allow for entire methods to be marked
2077 @code{@@synchronized}.  Note that throwing exceptions out of
2078 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2079 to be unlocked properly.
2081 @item -fobjc-gc
2082 @opindex fobjc-gc
2083 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2085 @item -freplace-objc-classes
2086 @opindex freplace-objc-classes
2087 Emit a special marker instructing @command{ld(1)} not to statically link in
2088 the resulting object file, and allow @command{dyld(1)} to load it in at
2089 run time instead.  This is used in conjunction with the Fix-and-Continue
2090 debugging mode, where the object file in question may be recompiled and
2091 dynamically reloaded in the course of program execution, without the need
2092 to restart the program itself.  Currently, Fix-and-Continue functionality
2093 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2094 and later.
2096 @item -fzero-link
2097 @opindex fzero-link
2098 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2099 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2100 compile time) with static class references that get initialized at load time,
2101 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2102 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2103 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2104 for individual class implementations to be modified during program execution.
2106 @item -gen-decls
2107 @opindex gen-decls
2108 Dump interface declarations for all classes seen in the source file to a
2109 file named @file{@var{sourcename}.decl}.
2111 @item -Wassign-intercept
2112 @opindex Wassign-intercept
2113 Warn whenever an Objective-C assignment is being intercepted by the
2114 garbage collector.
2116 @item -Wno-protocol
2117 @opindex Wno-protocol
2118 If a class is declared to implement a protocol, a warning is issued for
2119 every method in the protocol that is not implemented by the class.  The
2120 default behavior is to issue a warning for every method not explicitly
2121 implemented in the class, even if a method implementation is inherited
2122 from the superclass.  If you use the @option{-Wno-protocol} option, then
2123 methods inherited from the superclass are considered to be implemented,
2124 and no warning is issued for them.
2126 @item -Wselector
2127 @opindex Wselector
2128 Warn if multiple methods of different types for the same selector are
2129 found during compilation.  The check is performed on the list of methods
2130 in the final stage of compilation.  Additionally, a check is performed
2131 for each selector appearing in a @code{@@selector(@dots{})}
2132 expression, and a corresponding method for that selector has been found
2133 during compilation.  Because these checks scan the method table only at
2134 the end of compilation, these warnings are not produced if the final
2135 stage of compilation is not reached, for example because an error is
2136 found during compilation, or because the @option{-fsyntax-only} option is
2137 being used.
2139 @item -Wstrict-selector-match
2140 @opindex Wstrict-selector-match
2141 Warn if multiple methods with differing argument and/or return types are
2142 found for a given selector when attempting to send a message using this
2143 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2144 is off (which is the default behavior), the compiler will omit such warnings
2145 if any differences found are confined to types which share the same size
2146 and alignment.
2148 @item -Wundeclared-selector
2149 @opindex Wundeclared-selector
2150 Warn if a @code{@@selector(@dots{})} expression referring to an
2151 undeclared selector is found.  A selector is considered undeclared if no
2152 method with that name has been declared before the
2153 @code{@@selector(@dots{})} expression, either explicitly in an
2154 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2155 an @code{@@implementation} section.  This option always performs its
2156 checks as soon as a @code{@@selector(@dots{})} expression is found,
2157 while @option{-Wselector} only performs its checks in the final stage of
2158 compilation.  This also enforces the coding style convention
2159 that methods and selectors must be declared before being used.
2161 @item -print-objc-runtime-info
2162 @opindex print-objc-runtime-info
2163 Generate C header describing the largest structure that is passed by
2164 value, if any.
2166 @end table
2168 @node Language Independent Options
2169 @section Options to Control Diagnostic Messages Formatting
2170 @cindex options to control diagnostics formatting
2171 @cindex diagnostic messages
2172 @cindex message formatting
2174 Traditionally, diagnostic messages have been formatted irrespective of
2175 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2176 below can be used to control the diagnostic messages formatting
2177 algorithm, e.g.@: how many characters per line, how often source location
2178 information should be reported.  Right now, only the C++ front end can
2179 honor these options.  However it is expected, in the near future, that
2180 the remaining front ends would be able to digest them correctly.
2182 @table @gcctabopt
2183 @item -fmessage-length=@var{n}
2184 @opindex fmessage-length
2185 Try to format error messages so that they fit on lines of about @var{n}
2186 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2187 the front ends supported by GCC@.  If @var{n} is zero, then no
2188 line-wrapping will be done; each error message will appear on a single
2189 line.
2191 @opindex fdiagnostics-show-location
2192 @item -fdiagnostics-show-location=once
2193 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2194 reporter to emit @emph{once} source location information; that is, in
2195 case the message is too long to fit on a single physical line and has to
2196 be wrapped, the source location won't be emitted (as prefix) again,
2197 over and over, in subsequent continuation lines.  This is the default
2198 behavior.
2200 @item -fdiagnostics-show-location=every-line
2201 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2202 messages reporter to emit the same source location information (as
2203 prefix) for physical lines that result from the process of breaking
2204 a message which is too long to fit on a single line.
2206 @item -fdiagnostics-show-options
2207 @opindex fdiagnostics-show-options
2208 This option instructs the diagnostic machinery to add text to each
2209 diagnostic emitted, which indicates which command line option directly
2210 controls that diagnostic, when such an option is known to the
2211 diagnostic machinery.
2213 @end table
2215 @node Warning Options
2216 @section Options to Request or Suppress Warnings
2217 @cindex options to control warnings
2218 @cindex warning messages
2219 @cindex messages, warning
2220 @cindex suppressing warnings
2222 Warnings are diagnostic messages that report constructions which
2223 are not inherently erroneous but which are risky or suggest there
2224 may have been an error.
2226 You can request many specific warnings with options beginning @samp{-W},
2227 for example @option{-Wimplicit} to request warnings on implicit
2228 declarations.  Each of these specific warning options also has a
2229 negative form beginning @samp{-Wno-} to turn off warnings;
2230 for example, @option{-Wno-implicit}.  This manual lists only one of the
2231 two forms, whichever is not the default.
2233 The following options control the amount and kinds of warnings produced
2234 by GCC; for further, language-specific options also refer to
2235 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2236 Options}.
2238 @table @gcctabopt
2239 @cindex syntax checking
2240 @item -fsyntax-only
2241 @opindex fsyntax-only
2242 Check the code for syntax errors, but don't do anything beyond that.
2244 @item -pedantic
2245 @opindex pedantic
2246 Issue all the warnings demanded by strict ISO C and ISO C++;
2247 reject all programs that use forbidden extensions, and some other
2248 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2249 version of the ISO C standard specified by any @option{-std} option used.
2251 Valid ISO C and ISO C++ programs should compile properly with or without
2252 this option (though a rare few will require @option{-ansi} or a
2253 @option{-std} option specifying the required version of ISO C)@.  However,
2254 without this option, certain GNU extensions and traditional C and C++
2255 features are supported as well.  With this option, they are rejected.
2257 @option{-pedantic} does not cause warning messages for use of the
2258 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2259 warnings are also disabled in the expression that follows
2260 @code{__extension__}.  However, only system header files should use
2261 these escape routes; application programs should avoid them.
2262 @xref{Alternate Keywords}.
2264 Some users try to use @option{-pedantic} to check programs for strict ISO
2265 C conformance.  They soon find that it does not do quite what they want:
2266 it finds some non-ISO practices, but not all---only those for which
2267 ISO C @emph{requires} a diagnostic, and some others for which
2268 diagnostics have been added.
2270 A feature to report any failure to conform to ISO C might be useful in
2271 some instances, but would require considerable additional work and would
2272 be quite different from @option{-pedantic}.  We don't have plans to
2273 support such a feature in the near future.
2275 Where the standard specified with @option{-std} represents a GNU
2276 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2277 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2278 extended dialect is based.  Warnings from @option{-pedantic} are given
2279 where they are required by the base standard.  (It would not make sense
2280 for such warnings to be given only for features not in the specified GNU
2281 C dialect, since by definition the GNU dialects of C include all
2282 features the compiler supports with the given option, and there would be
2283 nothing to warn about.)
2285 @item -pedantic-errors
2286 @opindex pedantic-errors
2287 Like @option{-pedantic}, except that errors are produced rather than
2288 warnings.
2290 @item -w
2291 @opindex w
2292 Inhibit all warning messages.
2294 @item -Wno-import
2295 @opindex Wno-import
2296 Inhibit warning messages about the use of @samp{#import}.
2298 @item -Wchar-subscripts
2299 @opindex Wchar-subscripts
2300 Warn if an array subscript has type @code{char}.  This is a common cause
2301 of error, as programmers often forget that this type is signed on some
2302 machines.
2303 This warning is enabled by @option{-Wall}.
2305 @item -Wcomment
2306 @opindex Wcomment
2307 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2308 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2309 This warning is enabled by @option{-Wall}.
2311 @item -Wfatal-errors
2312 @opindex Wfatal-errors
2313 This option causes the compiler to abort compilation on the first error
2314 occurred rather than trying to keep going and printing further error
2315 messages.
2317 @item -Wformat
2318 @opindex Wformat
2319 @opindex ffreestanding
2320 @opindex fno-builtin
2321 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2322 the arguments supplied have types appropriate to the format string
2323 specified, and that the conversions specified in the format string make
2324 sense.  This includes standard functions, and others specified by format
2325 attributes (@pxref{Function Attributes}), in the @code{printf},
2326 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2327 not in the C standard) families (or other target-specific families).
2328 Which functions are checked without format attributes having been
2329 specified depends on the standard version selected, and such checks of
2330 functions without the attribute specified are disabled by
2331 @option{-ffreestanding} or @option{-fno-builtin}.
2333 The formats are checked against the format features supported by GNU
2334 libc version 2.2.  These include all ISO C90 and C99 features, as well
2335 as features from the Single Unix Specification and some BSD and GNU
2336 extensions.  Other library implementations may not support all these
2337 features; GCC does not support warning about features that go beyond a
2338 particular library's limitations.  However, if @option{-pedantic} is used
2339 with @option{-Wformat}, warnings will be given about format features not
2340 in the selected standard version (but not for @code{strfmon} formats,
2341 since those are not in any version of the C standard).  @xref{C Dialect
2342 Options,,Options Controlling C Dialect}.
2344 Since @option{-Wformat} also checks for null format arguments for
2345 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2347 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2348 aspects of format checking, the options @option{-Wformat-y2k},
2349 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2350 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2351 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2353 @item -Wformat-y2k
2354 @opindex Wformat-y2k
2355 If @option{-Wformat} is specified, also warn about @code{strftime}
2356 formats which may yield only a two-digit year.
2358 @item -Wno-format-extra-args
2359 @opindex Wno-format-extra-args
2360 If @option{-Wformat} is specified, do not warn about excess arguments to a
2361 @code{printf} or @code{scanf} format function.  The C standard specifies
2362 that such arguments are ignored.
2364 Where the unused arguments lie between used arguments that are
2365 specified with @samp{$} operand number specifications, normally
2366 warnings are still given, since the implementation could not know what
2367 type to pass to @code{va_arg} to skip the unused arguments.  However,
2368 in the case of @code{scanf} formats, this option will suppress the
2369 warning if the unused arguments are all pointers, since the Single
2370 Unix Specification says that such unused arguments are allowed.
2372 @item -Wno-format-zero-length
2373 @opindex Wno-format-zero-length
2374 If @option{-Wformat} is specified, do not warn about zero-length formats.
2375 The C standard specifies that zero-length formats are allowed.
2377 @item -Wformat-nonliteral
2378 @opindex Wformat-nonliteral
2379 If @option{-Wformat} is specified, also warn if the format string is not a
2380 string literal and so cannot be checked, unless the format function
2381 takes its format arguments as a @code{va_list}.
2383 @item -Wformat-security
2384 @opindex Wformat-security
2385 If @option{-Wformat} is specified, also warn about uses of format
2386 functions that represent possible security problems.  At present, this
2387 warns about calls to @code{printf} and @code{scanf} functions where the
2388 format string is not a string literal and there are no format arguments,
2389 as in @code{printf (foo);}.  This may be a security hole if the format
2390 string came from untrusted input and contains @samp{%n}.  (This is
2391 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2392 in future warnings may be added to @option{-Wformat-security} that are not
2393 included in @option{-Wformat-nonliteral}.)
2395 @item -Wformat=2
2396 @opindex Wformat=2
2397 Enable @option{-Wformat} plus format checks not included in
2398 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2399 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2401 @item -Wnonnull
2402 @opindex Wnonnull
2403 Warn about passing a null pointer for arguments marked as
2404 requiring a non-null value by the @code{nonnull} function attribute.
2406 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2407 can be disabled with the @option{-Wno-nonnull} option.
2409 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2410 @opindex Winit-self
2411 Warn about uninitialized variables which are initialized with themselves.
2412 Note this option can only be used with the @option{-Wuninitialized} option,
2413 which in turn only works with @option{-O1} and above.
2415 For example, GCC will warn about @code{i} being uninitialized in the
2416 following snippet only when @option{-Winit-self} has been specified:
2417 @smallexample
2418 @group
2419 int f()
2421   int i = i;
2422   return i;
2424 @end group
2425 @end smallexample
2427 @item -Wimplicit-int
2428 @opindex Wimplicit-int
2429 Warn when a declaration does not specify a type.
2430 This warning is enabled by @option{-Wall}.
2432 @item -Wimplicit-function-declaration
2433 @itemx -Werror-implicit-function-declaration
2434 @opindex Wimplicit-function-declaration
2435 @opindex Werror-implicit-function-declaration
2436 Give a warning (or error) whenever a function is used before being
2437 declared.  The form @option{-Wno-error-implicit-function-declaration}
2438 is not supported.
2439 This warning is enabled by @option{-Wall} (as a warning, not an error).
2441 @item -Wimplicit
2442 @opindex Wimplicit
2443 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2444 This warning is enabled by @option{-Wall}.
2446 @item -Wmain
2447 @opindex Wmain
2448 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2449 function with external linkage, returning int, taking either zero
2450 arguments, two, or three arguments of appropriate types.
2451 This warning is enabled by @option{-Wall}.
2453 @item -Wmissing-braces
2454 @opindex Wmissing-braces
2455 Warn if an aggregate or union initializer is not fully bracketed.  In
2456 the following example, the initializer for @samp{a} is not fully
2457 bracketed, but that for @samp{b} is fully bracketed.
2459 @smallexample
2460 int a[2][2] = @{ 0, 1, 2, 3 @};
2461 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2462 @end smallexample
2464 This warning is enabled by @option{-Wall}.
2466 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2467 @opindex Wmissing-include-dirs
2468 Warn if a user-supplied include directory does not exist.
2470 @item -Wparentheses
2471 @opindex Wparentheses
2472 Warn if parentheses are omitted in certain contexts, such
2473 as when there is an assignment in a context where a truth value
2474 is expected, or when operators are nested whose precedence people
2475 often get confused about.  Only the warning for an assignment used as
2476 a truth value is supported when compiling C++; the other warnings are
2477 only supported when compiling C@.
2479 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2480 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2481 interpretation from that of ordinary mathematical notation.
2483 Also warn about constructions where there may be confusion to which
2484 @code{if} statement an @code{else} branch belongs.  Here is an example of
2485 such a case:
2487 @smallexample
2488 @group
2490   if (a)
2491     if (b)
2492       foo ();
2493   else
2494     bar ();
2496 @end group
2497 @end smallexample
2499 In C, every @code{else} branch belongs to the innermost possible @code{if}
2500 statement, which in this example is @code{if (b)}.  This is often not
2501 what the programmer expected, as illustrated in the above example by
2502 indentation the programmer chose.  When there is the potential for this
2503 confusion, GCC will issue a warning when this flag is specified.
2504 To eliminate the warning, add explicit braces around the innermost
2505 @code{if} statement so there is no way the @code{else} could belong to
2506 the enclosing @code{if}.  The resulting code would look like this:
2508 @smallexample
2509 @group
2511   if (a)
2512     @{
2513       if (b)
2514         foo ();
2515       else
2516         bar ();
2517     @}
2519 @end group
2520 @end smallexample
2522 This warning is enabled by @option{-Wall}.
2524 @item -Wsequence-point
2525 @opindex Wsequence-point
2526 Warn about code that may have undefined semantics because of violations
2527 of sequence point rules in the C and C++ standards.
2529 The C and C++ standards defines the order in which expressions in a C/C++
2530 program are evaluated in terms of @dfn{sequence points}, which represent
2531 a partial ordering between the execution of parts of the program: those
2532 executed before the sequence point, and those executed after it.  These
2533 occur after the evaluation of a full expression (one which is not part
2534 of a larger expression), after the evaluation of the first operand of a
2535 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2536 function is called (but after the evaluation of its arguments and the
2537 expression denoting the called function), and in certain other places.
2538 Other than as expressed by the sequence point rules, the order of
2539 evaluation of subexpressions of an expression is not specified.  All
2540 these rules describe only a partial order rather than a total order,
2541 since, for example, if two functions are called within one expression
2542 with no sequence point between them, the order in which the functions
2543 are called is not specified.  However, the standards committee have
2544 ruled that function calls do not overlap.
2546 It is not specified when between sequence points modifications to the
2547 values of objects take effect.  Programs whose behavior depends on this
2548 have undefined behavior; the C and C++ standards specify that ``Between
2549 the previous and next sequence point an object shall have its stored
2550 value modified at most once by the evaluation of an expression.  
2551 Furthermore, the prior value shall be read only to determine the value
2552 to be stored.''.  If a program breaks these rules, the results on any
2553 particular implementation are entirely unpredictable.
2555 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2556 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2557 diagnosed by this option, and it may give an occasional false positive
2558 result, but in general it has been found fairly effective at detecting
2559 this sort of problem in programs.
2561 The standard is worded confusingly, therefore there is some debate
2562 over the precise meaning of the sequence point rules in subtle cases.
2563 Links to discussions of the problem, including proposed formal
2564 definitions, may be found on the GCC readings page, at
2565 @w{@uref{http://gcc.gnu.org/readings.html}}.
2567 This warning is enabled by @option{-Wall} for C and C++.
2569 @item -Wreturn-type
2570 @opindex Wreturn-type
2571 Warn whenever a function is defined with a return-type that defaults to
2572 @code{int}.  Also warn about any @code{return} statement with no
2573 return-value in a function whose return-type is not @code{void}.
2575 For C, also warn if the return type of a function has a type qualifier
2576 such as @code{const}.  Such a type qualifier has no effect, since the
2577 value returned by a function is not an lvalue.  ISO C prohibits
2578 qualified @code{void} return types on function definitions, so such
2579 return types always receive a warning even without this option.
2581 For C++, a function without return type always produces a diagnostic
2582 message, even when @option{-Wno-return-type} is specified.  The only
2583 exceptions are @samp{main} and functions defined in system headers.
2585 This warning is enabled by @option{-Wall}.
2587 @item -Wswitch
2588 @opindex Wswitch
2589 Warn whenever a @code{switch} statement has an index of enumerated type
2590 and lacks a @code{case} for one or more of the named codes of that
2591 enumeration.  (The presence of a @code{default} label prevents this
2592 warning.)  @code{case} labels outside the enumeration range also
2593 provoke warnings when this option is used.
2594 This warning is enabled by @option{-Wall}.
2596 @item -Wswitch-default
2597 @opindex Wswitch-switch
2598 Warn whenever a @code{switch} statement does not have a @code{default}
2599 case.
2601 @item -Wswitch-enum
2602 @opindex Wswitch-enum
2603 Warn whenever a @code{switch} statement has an index of enumerated type
2604 and lacks a @code{case} for one or more of the named codes of that
2605 enumeration.  @code{case} labels outside the enumeration range also
2606 provoke warnings when this option is used.
2608 @item -Wtrigraphs
2609 @opindex Wtrigraphs
2610 Warn if any trigraphs are encountered that might change the meaning of
2611 the program (trigraphs within comments are not warned about).
2612 This warning is enabled by @option{-Wall}.
2614 @item -Wunused-function
2615 @opindex Wunused-function
2616 Warn whenever a static function is declared but not defined or a
2617 non-inline static function is unused.
2618 This warning is enabled by @option{-Wall}.
2620 @item -Wunused-label
2621 @opindex Wunused-label
2622 Warn whenever a label is declared but not used.
2623 This warning is enabled by @option{-Wall}.
2625 To suppress this warning use the @samp{unused} attribute
2626 (@pxref{Variable Attributes}).
2628 @item -Wunused-parameter
2629 @opindex Wunused-parameter
2630 Warn whenever a function parameter is unused aside from its declaration.
2632 To suppress this warning use the @samp{unused} attribute
2633 (@pxref{Variable Attributes}).
2635 @item -Wunused-variable
2636 @opindex Wunused-variable
2637 Warn whenever a local variable or non-constant static variable is unused
2638 aside from its declaration
2639 This warning is enabled by @option{-Wall}.
2641 To suppress this warning use the @samp{unused} attribute
2642 (@pxref{Variable Attributes}).
2644 @item -Wunused-value
2645 @opindex Wunused-value
2646 Warn whenever a statement computes a result that is explicitly not used.
2647 This warning is enabled by @option{-Wall}.
2649 To suppress this warning cast the expression to @samp{void}.
2651 @item -Wunused
2652 @opindex Wunused
2653 All the above @option{-Wunused} options combined.
2655 In order to get a warning about an unused function parameter, you must
2656 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2657 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2659 @item -Wuninitialized
2660 @opindex Wuninitialized
2661 Warn if an automatic variable is used without first being initialized or
2662 if a variable may be clobbered by a @code{setjmp} call.
2664 These warnings are possible only in optimizing compilation,
2665 because they require data flow information that is computed only
2666 when optimizing.  If you don't specify @option{-O}, you simply won't
2667 get these warnings.
2669 If you want to warn about code which uses the uninitialized value of the
2670 variable in its own initializer, use the @option{-Winit-self} option.
2672 These warnings occur for individual uninitialized or clobbered
2673 elements of structure, union or array variables as well as for
2674 variables which are uninitialized or clobbered as a whole.  They do
2675 not occur for variables or elements declared @code{volatile}.  Because
2676 these warnings depend on optimization, the exact variables or elements
2677 for which there are warnings will depend on the precise optimization
2678 options and version of GCC used.
2680 Note that there may be no warning about a variable that is used only
2681 to compute a value that itself is never used, because such
2682 computations may be deleted by data flow analysis before the warnings
2683 are printed.
2685 These warnings are made optional because GCC is not smart
2686 enough to see all the reasons why the code might be correct
2687 despite appearing to have an error.  Here is one example of how
2688 this can happen:
2690 @smallexample
2691 @group
2693   int x;
2694   switch (y)
2695     @{
2696     case 1: x = 1;
2697       break;
2698     case 2: x = 4;
2699       break;
2700     case 3: x = 5;
2701     @}
2702   foo (x);
2704 @end group
2705 @end smallexample
2707 @noindent
2708 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2709 always initialized, but GCC doesn't know this.  Here is
2710 another common case:
2712 @smallexample
2714   int save_y;
2715   if (change_y) save_y = y, y = new_y;
2716   @dots{}
2717   if (change_y) y = save_y;
2719 @end smallexample
2721 @noindent
2722 This has no bug because @code{save_y} is used only if it is set.
2724 @cindex @code{longjmp} warnings
2725 This option also warns when a non-volatile automatic variable might be
2726 changed by a call to @code{longjmp}.  These warnings as well are possible
2727 only in optimizing compilation.
2729 The compiler sees only the calls to @code{setjmp}.  It cannot know
2730 where @code{longjmp} will be called; in fact, a signal handler could
2731 call it at any point in the code.  As a result, you may get a warning
2732 even when there is in fact no problem because @code{longjmp} cannot
2733 in fact be called at the place which would cause a problem.
2735 Some spurious warnings can be avoided if you declare all the functions
2736 you use that never return as @code{noreturn}.  @xref{Function
2737 Attributes}.
2739 This warning is enabled by @option{-Wall}.
2741 @item -Wunknown-pragmas
2742 @opindex Wunknown-pragmas
2743 @cindex warning for unknown pragmas
2744 @cindex unknown pragmas, warning
2745 @cindex pragmas, warning of unknown
2746 Warn when a #pragma directive is encountered which is not understood by
2747 GCC@.  If this command line option is used, warnings will even be issued
2748 for unknown pragmas in system header files.  This is not the case if
2749 the warnings were only enabled by the @option{-Wall} command line option.
2751 @item -Wno-pragmas
2752 @opindex Wno-pragmas
2753 @opindex Wpragmas
2754 Do not warn about misuses of pragmas, such as incorrect parameters,
2755 invalid syntax, or conflicts between pragmas.  See also
2756 @samp{-Wunknown-pragmas}.
2758 @item -Wstrict-aliasing
2759 @opindex Wstrict-aliasing
2760 This option is only active when @option{-fstrict-aliasing} is active.
2761 It warns about code which might break the strict aliasing rules that the
2762 compiler is using for optimization.  The warning does not catch all
2763 cases, but does attempt to catch the more common pitfalls.  It is
2764 included in @option{-Wall}.
2766 @item -Wstrict-aliasing=2
2767 @opindex Wstrict-aliasing=2
2768 This option is only active when @option{-fstrict-aliasing} is active.
2769 It warns about code which might break the strict aliasing rules that the
2770 compiler is using for optimization.  This warning catches more cases than
2771 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2772 cases that are safe.
2774 @item -Wall
2775 @opindex Wall
2776 All of the above @samp{-W} options combined.  This enables all the
2777 warnings about constructions that some users consider questionable, and
2778 that are easy to avoid (or modify to prevent the warning), even in
2779 conjunction with macros.  This also enables some language-specific
2780 warnings described in @ref{C++ Dialect Options} and
2781 @ref{Objective-C and Objective-C++ Dialect Options}.
2782 @end table
2784 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2785 Some of them warn about constructions that users generally do not
2786 consider questionable, but which occasionally you might wish to check
2787 for; others warn about constructions that are necessary or hard to avoid
2788 in some cases, and there is no simple way to modify the code to suppress
2789 the warning.
2791 @table @gcctabopt
2792 @item -Wextra
2793 @opindex W
2794 @opindex Wextra
2795 (This option used to be called @option{-W}.  The older name is still
2796 supported, but the newer name is more descriptive.)  Print extra warning
2797 messages for these events:
2799 @itemize @bullet
2800 @item
2801 A function can return either with or without a value.  (Falling
2802 off the end of the function body is considered returning without
2803 a value.)  For example, this function would evoke such a
2804 warning:
2806 @smallexample
2807 @group
2808 foo (a)
2810   if (a > 0)
2811     return a;
2813 @end group
2814 @end smallexample
2816 @item
2817 An expression-statement or the left-hand side of a comma expression
2818 contains no side effects.
2819 To suppress the warning, cast the unused expression to void.
2820 For example, an expression such as @samp{x[i,j]} will cause a warning,
2821 but @samp{x[(void)i,j]} will not.
2823 @item
2824 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2826 @item
2827 Storage-class specifiers like @code{static} are not the first things in
2828 a declaration.  According to the C Standard, this usage is obsolescent.
2830 @item
2831 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2832 arguments.
2834 @item
2835 A comparison between signed and unsigned values could produce an
2836 incorrect result when the signed value is converted to unsigned.
2837 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2839 @item
2840 An aggregate has an initializer which does not initialize all members.
2841 This warning can be independently controlled by
2842 @option{-Wmissing-field-initializers}.
2844 @item
2845 A function parameter is declared without a type specifier in K&R-style
2846 functions:
2848 @smallexample
2849 void foo(bar) @{ @}
2850 @end smallexample
2852 @item
2853 An empty body occurs in an @samp{if} or @samp{else} statement.
2855 @item
2856 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2857 @samp{>}, or @samp{>=}.
2859 @item
2860 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2862 @item
2863 Any of several floating-point events that often indicate errors, such as
2864 overflow, underflow, loss of precision, etc.
2866 @item @r{(C++ only)}
2867 An enumerator and a non-enumerator both appear in a conditional expression.
2869 @item @r{(C++ only)}
2870 A non-static reference or non-static @samp{const} member appears in a
2871 class without constructors.
2873 @item @r{(C++ only)}
2874 Ambiguous virtual bases.
2876 @item @r{(C++ only)}
2877 Subscripting an array which has been declared @samp{register}.
2879 @item @r{(C++ only)}
2880 Taking the address of a variable which has been declared @samp{register}.
2882 @item @r{(C++ only)}
2883 A base class is not initialized in a derived class' copy constructor.
2884 @end itemize
2886 @item -Wno-div-by-zero
2887 @opindex Wno-div-by-zero
2888 @opindex Wdiv-by-zero
2889 Do not warn about compile-time integer division by zero.  Floating point
2890 division by zero is not warned about, as it can be a legitimate way of
2891 obtaining infinities and NaNs.
2893 @item -Wsystem-headers
2894 @opindex Wsystem-headers
2895 @cindex warnings from system headers
2896 @cindex system headers, warnings from
2897 Print warning messages for constructs found in system header files.
2898 Warnings from system headers are normally suppressed, on the assumption
2899 that they usually do not indicate real problems and would only make the
2900 compiler output harder to read.  Using this command line option tells
2901 GCC to emit warnings from system headers as if they occurred in user
2902 code.  However, note that using @option{-Wall} in conjunction with this
2903 option will @emph{not} warn about unknown pragmas in system
2904 headers---for that, @option{-Wunknown-pragmas} must also be used.
2906 @item -Wfloat-equal
2907 @opindex Wfloat-equal
2908 Warn if floating point values are used in equality comparisons.
2910 The idea behind this is that sometimes it is convenient (for the
2911 programmer) to consider floating-point values as approximations to
2912 infinitely precise real numbers.  If you are doing this, then you need
2913 to compute (by analyzing the code, or in some other way) the maximum or
2914 likely maximum error that the computation introduces, and allow for it
2915 when performing comparisons (and when producing output, but that's a
2916 different problem).  In particular, instead of testing for equality, you
2917 would check to see whether the two values have ranges that overlap; and
2918 this is done with the relational operators, so equality comparisons are
2919 probably mistaken.
2921 @item -Wtraditional @r{(C only)}
2922 @opindex Wtraditional
2923 Warn about certain constructs that behave differently in traditional and
2924 ISO C@.  Also warn about ISO C constructs that have no traditional C
2925 equivalent, and/or problematic constructs which should be avoided.
2927 @itemize @bullet
2928 @item
2929 Macro parameters that appear within string literals in the macro body.
2930 In traditional C macro replacement takes place within string literals,
2931 but does not in ISO C@.
2933 @item
2934 In traditional C, some preprocessor directives did not exist.
2935 Traditional preprocessors would only consider a line to be a directive
2936 if the @samp{#} appeared in column 1 on the line.  Therefore
2937 @option{-Wtraditional} warns about directives that traditional C
2938 understands but would ignore because the @samp{#} does not appear as the
2939 first character on the line.  It also suggests you hide directives like
2940 @samp{#pragma} not understood by traditional C by indenting them.  Some
2941 traditional implementations would not recognize @samp{#elif}, so it
2942 suggests avoiding it altogether.
2944 @item
2945 A function-like macro that appears without arguments.
2947 @item
2948 The unary plus operator.
2950 @item
2951 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2952 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2953 constants.)  Note, these suffixes appear in macros defined in the system
2954 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2955 Use of these macros in user code might normally lead to spurious
2956 warnings, however GCC's integrated preprocessor has enough context to
2957 avoid warning in these cases.
2959 @item
2960 A function declared external in one block and then used after the end of
2961 the block.
2963 @item
2964 A @code{switch} statement has an operand of type @code{long}.
2966 @item
2967 A non-@code{static} function declaration follows a @code{static} one.
2968 This construct is not accepted by some traditional C compilers.
2970 @item
2971 The ISO type of an integer constant has a different width or
2972 signedness from its traditional type.  This warning is only issued if
2973 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2974 typically represent bit patterns, are not warned about.
2976 @item
2977 Usage of ISO string concatenation is detected.
2979 @item
2980 Initialization of automatic aggregates.
2982 @item
2983 Identifier conflicts with labels.  Traditional C lacks a separate
2984 namespace for labels.
2986 @item
2987 Initialization of unions.  If the initializer is zero, the warning is
2988 omitted.  This is done under the assumption that the zero initializer in
2989 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2990 initializer warnings and relies on default initialization to zero in the
2991 traditional C case.
2993 @item
2994 Conversions by prototypes between fixed/floating point values and vice
2995 versa.  The absence of these prototypes when compiling with traditional
2996 C would cause serious problems.  This is a subset of the possible
2997 conversion warnings, for the full set use @option{-Wconversion}.
2999 @item
3000 Use of ISO C style function definitions.  This warning intentionally is
3001 @emph{not} issued for prototype declarations or variadic functions
3002 because these ISO C features will appear in your code when using
3003 libiberty's traditional C compatibility macros, @code{PARAMS} and
3004 @code{VPARAMS}.  This warning is also bypassed for nested functions
3005 because that feature is already a GCC extension and thus not relevant to
3006 traditional C compatibility.
3007 @end itemize
3009 @item -Wdeclaration-after-statement @r{(C only)}
3010 @opindex Wdeclaration-after-statement
3011 Warn when a declaration is found after a statement in a block.  This
3012 construct, known from C++, was introduced with ISO C99 and is by default
3013 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
3014 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
3016 @item -Wundef
3017 @opindex Wundef
3018 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3020 @item -Wno-endif-labels
3021 @opindex Wno-endif-labels
3022 @opindex Wendif-labels
3023 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3025 @item -Wshadow
3026 @opindex Wshadow
3027 Warn whenever a local variable shadows another local variable, parameter or
3028 global variable or whenever a built-in function is shadowed.
3030 @item -Wlarger-than-@var{len}
3031 @opindex Wlarger-than
3032 Warn whenever an object of larger than @var{len} bytes is defined.
3034 @item -Wunsafe-loop-optimizations
3035 @opindex Wunsafe-loop-optimizations
3036 Warn if the loop cannot be optimized because the compiler could not
3037 assume anything on the bounds of the loop indices.  With
3038 @option{-funsafe-loop-optimizations} warn if the compiler made
3039 such assumptions.
3041 @item -Wpointer-arith
3042 @opindex Wpointer-arith
3043 Warn about anything that depends on the ``size of'' a function type or
3044 of @code{void}.  GNU C assigns these types a size of 1, for
3045 convenience in calculations with @code{void *} pointers and pointers
3046 to functions.
3048 @item -Wbad-function-cast @r{(C only)}
3049 @opindex Wbad-function-cast
3050 Warn whenever a function call is cast to a non-matching type.
3051 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3053 @item -Wc++-compat
3054 Warn about ISO C constructs that are outside of the common subset of
3055 ISO C and ISO C++, e.g.@: request for implicit conversion from
3056 @code{void *} to a pointer to non-@code{void} type.
3058 @item -Wcast-qual
3059 @opindex Wcast-qual
3060 Warn whenever a pointer is cast so as to remove a type qualifier from
3061 the target type.  For example, warn if a @code{const char *} is cast
3062 to an ordinary @code{char *}.
3064 @item -Wcast-align
3065 @opindex Wcast-align
3066 Warn whenever a pointer is cast such that the required alignment of the
3067 target is increased.  For example, warn if a @code{char *} is cast to
3068 an @code{int *} on machines where integers can only be accessed at
3069 two- or four-byte boundaries.
3071 @item -Wwrite-strings
3072 @opindex Wwrite-strings
3073 When compiling C, give string constants the type @code{const
3074 char[@var{length}]} so that
3075 copying the address of one into a non-@code{const} @code{char *}
3076 pointer will get a warning; when compiling C++, warn about the
3077 deprecated conversion from string literals to @code{char *}.  This
3078 warning, by default, is enabled for C++ programs.
3079 These warnings will help you find at
3080 compile time code that can try to write into a string constant, but
3081 only if you have been very careful about using @code{const} in
3082 declarations and prototypes.  Otherwise, it will just be a nuisance;
3083 this is why we did not make @option{-Wall} request these warnings.
3085 @item -Wconversion
3086 @opindex Wconversion
3087 Warn if a prototype causes a type conversion that is different from what
3088 would happen to the same argument in the absence of a prototype.  This
3089 includes conversions of fixed point to floating and vice versa, and
3090 conversions changing the width or signedness of a fixed point argument
3091 except when the same as the default promotion.
3093 Also, warn if a negative integer constant expression is implicitly
3094 converted to an unsigned type.  For example, warn about the assignment
3095 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3096 casts like @code{(unsigned) -1}.
3098 @item -Wsign-compare
3099 @opindex Wsign-compare
3100 @cindex warning for comparison of signed and unsigned values
3101 @cindex comparison of signed and unsigned values, warning
3102 @cindex signed and unsigned values, comparison warning
3103 Warn when a comparison between signed and unsigned values could produce
3104 an incorrect result when the signed value is converted to unsigned.
3105 This warning is also enabled by @option{-Wextra}; to get the other warnings
3106 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3108 @item -Waggregate-return
3109 @opindex Waggregate-return
3110 Warn if any functions that return structures or unions are defined or
3111 called.  (In languages where you can return an array, this also elicits
3112 a warning.)
3114 @item -Walways-true
3115 @opindex Walways-true
3116 Warn about comparisons which are always true such as testing if
3117 unsigned values are greater than or equal to zero.  This warning is
3118 enabled by @option{-Wall}.
3120 @item -Wno-attributes
3121 @opindex Wno-attributes
3122 @opindex Wattributes
3123 Do not warn if an unexpected @code{__attribute__} is used, such as
3124 unrecognized attributes, function attributes applied to variables,
3125 etc.  This will not stop errors for incorrect use of supported
3126 attributes.
3128 @item -Wstrict-prototypes @r{(C only)}
3129 @opindex Wstrict-prototypes
3130 Warn if a function is declared or defined without specifying the
3131 argument types.  (An old-style function definition is permitted without
3132 a warning if preceded by a declaration which specifies the argument
3133 types.)
3135 @item -Wold-style-definition @r{(C only)}
3136 @opindex Wold-style-definition
3137 Warn if an old-style function definition is used.  A warning is given
3138 even if there is a previous prototype.
3140 @item -Wmissing-prototypes @r{(C only)}
3141 @opindex Wmissing-prototypes
3142 Warn if a global function is defined without a previous prototype
3143 declaration.  This warning is issued even if the definition itself
3144 provides a prototype.  The aim is to detect global functions that fail
3145 to be declared in header files.
3147 @item -Wmissing-declarations @r{(C only)}
3148 @opindex Wmissing-declarations
3149 Warn if a global function is defined without a previous declaration.
3150 Do so even if the definition itself provides a prototype.
3151 Use this option to detect global functions that are not declared in
3152 header files.
3154 @item -Wmissing-field-initializers
3155 @opindex Wmissing-field-initializers
3156 @opindex W
3157 @opindex Wextra
3158 Warn if a structure's initializer has some fields missing.  For
3159 example, the following code would cause such a warning, because
3160 @code{x.h} is implicitly zero:
3162 @smallexample
3163 struct s @{ int f, g, h; @};
3164 struct s x = @{ 3, 4 @};
3165 @end smallexample
3167 This option does not warn about designated initializers, so the following
3168 modification would not trigger a warning:
3170 @smallexample
3171 struct s @{ int f, g, h; @};
3172 struct s x = @{ .f = 3, .g = 4 @};
3173 @end smallexample
3175 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3176 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3178 @item -Wmissing-noreturn
3179 @opindex Wmissing-noreturn
3180 Warn about functions which might be candidates for attribute @code{noreturn}.
3181 Note these are only possible candidates, not absolute ones.  Care should
3182 be taken to manually verify functions actually do not ever return before
3183 adding the @code{noreturn} attribute, otherwise subtle code generation
3184 bugs could be introduced.  You will not get a warning for @code{main} in
3185 hosted C environments.
3187 @item -Wmissing-format-attribute
3188 @opindex Wmissing-format-attribute
3189 @opindex Wformat
3190 Warn about function pointers which might be candidates for @code{format}
3191 attributes.  Note these are only possible candidates, not absolute ones.
3192 GCC will guess that function pointers with @code{format} attributes that
3193 are used in assignment, initialization, parameter passing or return
3194 statements should have a corresponding @code{format} attribute in the
3195 resulting type.  I.e.@: the left-hand side of the assignment or
3196 initialization, the type of the parameter variable, or the return type
3197 of the containing function respectively should also have a @code{format}
3198 attribute to avoid the warning.
3200 GCC will also warn about function definitions which might be
3201 candidates for @code{format} attributes.  Again, these are only
3202 possible candidates.  GCC will guess that @code{format} attributes
3203 might be appropriate for any function that calls a function like
3204 @code{vprintf} or @code{vscanf}, but this might not always be the
3205 case, and some functions for which @code{format} attributes are
3206 appropriate may not be detected.
3208 @item -Wno-multichar
3209 @opindex Wno-multichar
3210 @opindex Wmultichar
3211 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3212 Usually they indicate a typo in the user's code, as they have
3213 implementation-defined values, and should not be used in portable code.
3215 @item -Wnormalized=<none|id|nfc|nfkc>
3216 @opindex Wnormalized
3217 @cindex NFC
3218 @cindex NFKC
3219 @cindex character set, input normalization
3220 In ISO C and ISO C++, two identifiers are different if they are
3221 different sequences of characters.  However, sometimes when characters
3222 outside the basic ASCII character set are used, you can have two
3223 different character sequences that look the same.  To avoid confusion,
3224 the ISO 10646 standard sets out some @dfn{normalization rules} which
3225 when applied ensure that two sequences that look the same are turned into
3226 the same sequence.  GCC can warn you if you are using identifiers which
3227 have not been normalized; this option controls that warning.
3229 There are four levels of warning that GCC supports.  The default is
3230 @option{-Wnormalized=nfc}, which warns about any identifier which is
3231 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3232 recommended form for most uses.
3234 Unfortunately, there are some characters which ISO C and ISO C++ allow
3235 in identifiers that when turned into NFC aren't allowable as
3236 identifiers.  That is, there's no way to use these symbols in portable
3237 ISO C or C++ and have all your identifiers in NFC.
3238 @option{-Wnormalized=id} suppresses the warning for these characters.
3239 It is hoped that future versions of the standards involved will correct
3240 this, which is why this option is not the default.
3242 You can switch the warning off for all characters by writing
3243 @option{-Wnormalized=none}.  You would only want to do this if you
3244 were using some other normalization scheme (like ``D''), because
3245 otherwise you can easily create bugs that are literally impossible to see.
3247 Some characters in ISO 10646 have distinct meanings but look identical
3248 in some fonts or display methodologies, especially once formatting has
3249 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3250 LETTER N'', will display just like a regular @code{n} which has been
3251 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3252 normalisation scheme to convert all these into a standard form as
3253 well, and GCC will warn if your code is not in NFKC if you use
3254 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3255 about every identifier that contains the letter O because it might be
3256 confused with the digit 0, and so is not the default, but may be
3257 useful as a local coding convention if the programming environment is
3258 unable to be fixed to display these characters distinctly.
3260 @item -Wno-deprecated-declarations
3261 @opindex Wno-deprecated-declarations
3262 Do not warn about uses of functions, variables, and types marked as
3263 deprecated by using the @code{deprecated} attribute.
3264 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3265 @pxref{Type Attributes}.)
3267 @item -Wpacked
3268 @opindex Wpacked
3269 Warn if a structure is given the packed attribute, but the packed
3270 attribute has no effect on the layout or size of the structure.
3271 Such structures may be mis-aligned for little benefit.  For
3272 instance, in this code, the variable @code{f.x} in @code{struct bar}
3273 will be misaligned even though @code{struct bar} does not itself
3274 have the packed attribute:
3276 @smallexample
3277 @group
3278 struct foo @{
3279   int x;
3280   char a, b, c, d;
3281 @} __attribute__((packed));
3282 struct bar @{
3283   char z;
3284   struct foo f;
3286 @end group
3287 @end smallexample
3289 @item -Wpadded
3290 @opindex Wpadded
3291 Warn if padding is included in a structure, either to align an element
3292 of the structure or to align the whole structure.  Sometimes when this
3293 happens it is possible to rearrange the fields of the structure to
3294 reduce the padding and so make the structure smaller.
3296 @item -Wredundant-decls
3297 @opindex Wredundant-decls
3298 Warn if anything is declared more than once in the same scope, even in
3299 cases where multiple declaration is valid and changes nothing.
3301 @item -Wnested-externs @r{(C only)}
3302 @opindex Wnested-externs
3303 Warn if an @code{extern} declaration is encountered within a function.
3305 @item -Wunreachable-code
3306 @opindex Wunreachable-code
3307 Warn if the compiler detects that code will never be executed.
3309 This option is intended to warn when the compiler detects that at
3310 least a whole line of source code will never be executed, because
3311 some condition is never satisfied or because it is after a
3312 procedure that never returns.
3314 It is possible for this option to produce a warning even though there
3315 are circumstances under which part of the affected line can be executed,
3316 so care should be taken when removing apparently-unreachable code.
3318 For instance, when a function is inlined, a warning may mean that the
3319 line is unreachable in only one inlined copy of the function.
3321 This option is not made part of @option{-Wall} because in a debugging
3322 version of a program there is often substantial code which checks
3323 correct functioning of the program and is, hopefully, unreachable
3324 because the program does work.  Another common use of unreachable
3325 code is to provide behavior which is selectable at compile-time.
3327 @item -Winline
3328 @opindex Winline
3329 Warn if a function can not be inlined and it was declared as inline.
3330 Even with this option, the compiler will not warn about failures to
3331 inline functions declared in system headers.
3333 The compiler uses a variety of heuristics to determine whether or not
3334 to inline a function.  For example, the compiler takes into account
3335 the size of the function being inlined and the amount of inlining
3336 that has already been done in the current function.  Therefore,
3337 seemingly insignificant changes in the source program can cause the
3338 warnings produced by @option{-Winline} to appear or disappear.
3340 @item -Wno-invalid-offsetof @r{(C++ only)}
3341 @opindex Wno-invalid-offsetof
3342 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3343 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3344 to a non-POD type is undefined.  In existing C++ implementations,
3345 however, @samp{offsetof} typically gives meaningful results even when
3346 applied to certain kinds of non-POD types. (Such as a simple
3347 @samp{struct} that fails to be a POD type only by virtue of having a
3348 constructor.)  This flag is for users who are aware that they are
3349 writing nonportable code and who have deliberately chosen to ignore the
3350 warning about it.
3352 The restrictions on @samp{offsetof} may be relaxed in a future version
3353 of the C++ standard.
3355 @item -Wno-int-to-pointer-cast @r{(C only)}
3356 @opindex Wno-int-to-pointer-cast
3357 Suppress warnings from casts to pointer type of an integer of a
3358 different size.
3360 @item -Wno-pointer-to-int-cast @r{(C only)}
3361 @opindex Wno-pointer-to-int-cast
3362 Suppress warnings from casts from a pointer to an integer type of a
3363 different size.
3365 @item -Winvalid-pch
3366 @opindex Winvalid-pch
3367 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3368 the search path but can't be used.
3370 @item -Wlong-long
3371 @opindex Wlong-long
3372 @opindex Wno-long-long
3373 Warn if @samp{long long} type is used.  This is default.  To inhibit
3374 the warning messages, use @option{-Wno-long-long}.  Flags
3375 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3376 only when @option{-pedantic} flag is used.
3378 @item -Wvariadic-macros
3379 @opindex Wvariadic-macros
3380 @opindex Wno-variadic-macros
3381 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3382 alternate syntax when in pedantic ISO C99 mode.  This is default.
3383 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3385 @item -Wvolatile-register-var
3386 @opindex Wvolatile-register-var
3387 @opindex Wno-volatile-register-var
3388 Warn if a register variable is declared volatile.  The volatile
3389 modifier does not inhibit all optimizations that may eliminate reads
3390 and/or writes to register variables.
3392 @item -Wdisabled-optimization
3393 @opindex Wdisabled-optimization
3394 Warn if a requested optimization pass is disabled.  This warning does
3395 not generally indicate that there is anything wrong with your code; it
3396 merely indicates that GCC's optimizers were unable to handle the code
3397 effectively.  Often, the problem is that your code is too big or too
3398 complex; GCC will refuse to optimize programs when the optimization
3399 itself is likely to take inordinate amounts of time.
3401 @item -Wpointer-sign
3402 @opindex Wpointer-sign
3403 @opindex Wno-pointer-sign
3404 Warn for pointer argument passing or assignment with different signedness.
3405 This option is only supported for C and Objective-C@.  It is implied by
3406 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3407 @option{-Wno-pointer-sign}.
3409 @item -Werror
3410 @opindex Werror
3411 Make all warnings into errors.
3413 @item -Werror=
3414 @opindex Werror=
3415 Make the specified warning into an errors.  The specifier for a
3416 warning is appended, for example @option{-Werror=switch} turns the
3417 warnings controlled by @option{-Wswitch} into errors.  This switch
3418 takes a negative form, to be used to negate @option{-Werror} for
3419 specific warnings, for example @option{-Wno-error=switch} makes
3420 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3421 is in effect.  You can use the @option{-fdiagnostics-show-option}
3422 option to have each controllable warning amended with the option which
3423 controls it, to determine what to use with this option.
3425 Note that specifying @option{-Werror=}@var{foo} automatically implies
3426 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3427 imply anything.
3429 @item -Wstack-protector
3430 @opindex Wstack-protector
3431 This option is only active when @option{-fstack-protector} is active.  It
3432 warns about functions that will not be protected against stack smashing.
3434 @item -Wstring-literal-comparison
3435 @opindex Wstring-literal-comparison
3436 Warn about suspicious comparisons to string literal constants.  In C,
3437 direct comparisons against the memory address of a string literal, such
3438 as @code{if (x == "abc")}, typically indicate a programmer error, and
3439 even when intentional, result in unspecified behavior and are not portable.
3440 Usually these warnings alert that the programmer intended to use
3441 @code{strcmp}.  This warning is enabled by @option{-Wall}.
3443 @item -Woverlength-strings
3444 @opindex Woverlength-strings
3445 Warn about string constants which are longer than the ``minimum
3446 maximum'' length specified in the C standard.  Modern compilers
3447 generally allow string constants which are much longer than the
3448 standard's minimum limit, but very portable programs should avoid
3449 using longer strings.
3451 The limit applies @emph{after} string constant concatenation, and does
3452 not count the trailing NUL@.  In C89, the limit was 509 characters; in
3453 C99, it was raised to 4095.  C++98 does not specify a normative
3454 minimum maximum, so we do not diagnose overlength strings in C++@.
3456 This option is implied by @option{-pedantic}, and can be disabled with
3457 @option{-Wno-overlength-strings}.
3458 @end table
3460 @node Debugging Options
3461 @section Options for Debugging Your Program or GCC
3462 @cindex options, debugging
3463 @cindex debugging information options
3465 GCC has various special options that are used for debugging
3466 either your program or GCC:
3468 @table @gcctabopt
3469 @item -g
3470 @opindex g
3471 Produce debugging information in the operating system's native format
3472 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3473 information.
3475 On most systems that use stabs format, @option{-g} enables use of extra
3476 debugging information that only GDB can use; this extra information
3477 makes debugging work better in GDB but will probably make other debuggers
3478 crash or
3479 refuse to read the program.  If you want to control for certain whether
3480 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3481 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3483 GCC allows you to use @option{-g} with
3484 @option{-O}.  The shortcuts taken by optimized code may occasionally
3485 produce surprising results: some variables you declared may not exist
3486 at all; flow of control may briefly move where you did not expect it;
3487 some statements may not be executed because they compute constant
3488 results or their values were already at hand; some statements may
3489 execute in different places because they were moved out of loops.
3491 Nevertheless it proves possible to debug optimized output.  This makes
3492 it reasonable to use the optimizer for programs that might have bugs.
3494 The following options are useful when GCC is generated with the
3495 capability for more than one debugging format.
3497 @item -ggdb
3498 @opindex ggdb
3499 Produce debugging information for use by GDB@.  This means to use the
3500 most expressive format available (DWARF 2, stabs, or the native format
3501 if neither of those are supported), including GDB extensions if at all
3502 possible.
3504 @item -gstabs
3505 @opindex gstabs
3506 Produce debugging information in stabs format (if that is supported),
3507 without GDB extensions.  This is the format used by DBX on most BSD
3508 systems.  On MIPS, Alpha and System V Release 4 systems this option
3509 produces stabs debugging output which is not understood by DBX or SDB@.
3510 On System V Release 4 systems this option requires the GNU assembler.
3512 @item -feliminate-unused-debug-symbols
3513 @opindex feliminate-unused-debug-symbols
3514 Produce debugging information in stabs format (if that is supported),
3515 for only symbols that are actually used.
3517 @item -gstabs+
3518 @opindex gstabs+
3519 Produce debugging information in stabs format (if that is supported),
3520 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3521 use of these extensions is likely to make other debuggers crash or
3522 refuse to read the program.
3524 @item -gcoff
3525 @opindex gcoff
3526 Produce debugging information in COFF format (if that is supported).
3527 This is the format used by SDB on most System V systems prior to
3528 System V Release 4.
3530 @item -gxcoff
3531 @opindex gxcoff
3532 Produce debugging information in XCOFF format (if that is supported).
3533 This is the format used by the DBX debugger on IBM RS/6000 systems.
3535 @item -gxcoff+
3536 @opindex gxcoff+
3537 Produce debugging information in XCOFF format (if that is supported),
3538 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3539 use of these extensions is likely to make other debuggers crash or
3540 refuse to read the program, and may cause assemblers other than the GNU
3541 assembler (GAS) to fail with an error.
3543 @item -gdwarf-2
3544 @opindex gdwarf-2
3545 Produce debugging information in DWARF version 2 format (if that is
3546 supported).  This is the format used by DBX on IRIX 6.  With this
3547 option, GCC uses features of DWARF version 3 when they are useful;
3548 version 3 is upward compatible with version 2, but may still cause
3549 problems for older debuggers.
3551 @item -gvms
3552 @opindex gvms
3553 Produce debugging information in VMS debug format (if that is
3554 supported).  This is the format used by DEBUG on VMS systems.
3556 @item -g@var{level}
3557 @itemx -ggdb@var{level}
3558 @itemx -gstabs@var{level}
3559 @itemx -gcoff@var{level}
3560 @itemx -gxcoff@var{level}
3561 @itemx -gvms@var{level}
3562 Request debugging information and also use @var{level} to specify how
3563 much information.  The default level is 2.
3565 Level 1 produces minimal information, enough for making backtraces in
3566 parts of the program that you don't plan to debug.  This includes
3567 descriptions of functions and external variables, but no information
3568 about local variables and no line numbers.
3570 Level 3 includes extra information, such as all the macro definitions
3571 present in the program.  Some debuggers support macro expansion when
3572 you use @option{-g3}.
3574 @option{-gdwarf-2} does not accept a concatenated debug level, because
3575 GCC used to support an option @option{-gdwarf} that meant to generate
3576 debug information in version 1 of the DWARF format (which is very
3577 different from version 2), and it would have been too confusing.  That
3578 debug format is long obsolete, but the option cannot be changed now.
3579 Instead use an additional @option{-g@var{level}} option to change the
3580 debug level for DWARF2.
3582 @item -feliminate-dwarf2-dups
3583 @opindex feliminate-dwarf2-dups
3584 Compress DWARF2 debugging information by eliminating duplicated
3585 information about each symbol.  This option only makes sense when
3586 generating DWARF2 debugging information with @option{-gdwarf-2}.
3588 @cindex @command{prof}
3589 @item -p
3590 @opindex p
3591 Generate extra code to write profile information suitable for the
3592 analysis program @command{prof}.  You must use this option when compiling
3593 the source files you want data about, and you must also use it when
3594 linking.
3596 @cindex @command{gprof}
3597 @item -pg
3598 @opindex pg
3599 Generate extra code to write profile information suitable for the
3600 analysis program @command{gprof}.  You must use this option when compiling
3601 the source files you want data about, and you must also use it when
3602 linking.
3604 @item -Q
3605 @opindex Q
3606 Makes the compiler print out each function name as it is compiled, and
3607 print some statistics about each pass when it finishes.
3609 @item -ftime-report
3610 @opindex ftime-report
3611 Makes the compiler print some statistics about the time consumed by each
3612 pass when it finishes.
3614 @item -fmem-report
3615 @opindex fmem-report
3616 Makes the compiler print some statistics about permanent memory
3617 allocation when it finishes.
3619 @item -fprofile-arcs
3620 @opindex fprofile-arcs
3621 Add code so that program flow @dfn{arcs} are instrumented.  During
3622 execution the program records how many times each branch and call is
3623 executed and how many times it is taken or returns.  When the compiled
3624 program exits it saves this data to a file called
3625 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3626 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3627 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3628 @var{auxname} is generated from the name of the output file, if
3629 explicitly specified and it is not the final executable, otherwise it is
3630 the basename of the source file.  In both cases any suffix is removed
3631 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3632 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3633 @xref{Cross-profiling}.
3635 @cindex @command{gcov}
3636 @item --coverage
3637 @opindex coverage
3639 This option is used to compile and link code instrumented for coverage
3640 analysis.  The option is a synonym for @option{-fprofile-arcs}
3641 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3642 linking).  See the documentation for those options for more details.
3644 @itemize
3646 @item
3647 Compile the source files with @option{-fprofile-arcs} plus optimization
3648 and code generation options.  For test coverage analysis, use the
3649 additional @option{-ftest-coverage} option.  You do not need to profile
3650 every source file in a program.
3652 @item
3653 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3654 (the latter implies the former).
3656 @item
3657 Run the program on a representative workload to generate the arc profile
3658 information.  This may be repeated any number of times.  You can run
3659 concurrent instances of your program, and provided that the file system
3660 supports locking, the data files will be correctly updated.  Also
3661 @code{fork} calls are detected and correctly handled (double counting
3662 will not happen).
3664 @item
3665 For profile-directed optimizations, compile the source files again with
3666 the same optimization and code generation options plus
3667 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3668 Control Optimization}).
3670 @item
3671 For test coverage analysis, use @command{gcov} to produce human readable
3672 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3673 @command{gcov} documentation for further information.
3675 @end itemize
3677 With @option{-fprofile-arcs}, for each function of your program GCC
3678 creates a program flow graph, then finds a spanning tree for the graph.
3679 Only arcs that are not on the spanning tree have to be instrumented: the
3680 compiler adds code to count the number of times that these arcs are
3681 executed.  When an arc is the only exit or only entrance to a block, the
3682 instrumentation code can be added to the block; otherwise, a new basic
3683 block must be created to hold the instrumentation code.
3685 @need 2000
3686 @item -ftest-coverage
3687 @opindex ftest-coverage
3688 Produce a notes file that the @command{gcov} code-coverage utility
3689 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3690 show program coverage.  Each source file's note file is called
3691 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3692 above for a description of @var{auxname} and instructions on how to
3693 generate test coverage data.  Coverage data will match the source files
3694 more closely, if you do not optimize.
3696 @item -d@var{letters}
3697 @item -fdump-rtl-@var{pass}
3698 @opindex d
3699 Says to make debugging dumps during compilation at times specified by
3700 @var{letters}.    This is used for debugging the RTL-based passes of the
3701 compiler.  The file names for most of the dumps are made by appending a
3702 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3703 from the name of the output file, if explicitly specified and it is not
3704 an executable, otherwise it is the basename of the source file.
3706 Most debug dumps can be enabled either passing a letter to the @option{-d}
3707 option, or with a long @option{-fdump-rtl} switch; here are the possible
3708 letters for use in @var{letters} and @var{pass}, and their meanings:
3710 @table @gcctabopt
3711 @item -dA
3712 @opindex dA
3713 Annotate the assembler output with miscellaneous debugging information.
3715 @item -dB
3716 @itemx -fdump-rtl-bbro
3717 @opindex dB
3718 @opindex fdump-rtl-bbro
3719 Dump after block reordering, to @file{@var{file}.30.bbro}.
3721 @item -dc
3722 @itemx -fdump-rtl-combine
3723 @opindex dc
3724 @opindex fdump-rtl-combine
3725 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3727 @item -dC
3728 @itemx -fdump-rtl-ce1
3729 @itemx -fdump-rtl-ce2
3730 @opindex dC
3731 @opindex fdump-rtl-ce1
3732 @opindex fdump-rtl-ce2
3733 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3734 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3735 and @option{-fdump-rtl-ce2} enable dumping after the second if
3736 conversion, to the file @file{@var{file}.18.ce2}.
3738 @item -dd
3739 @itemx -fdump-rtl-btl
3740 @itemx -fdump-rtl-dbr
3741 @opindex dd
3742 @opindex fdump-rtl-btl
3743 @opindex fdump-rtl-dbr
3744 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3745 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3746 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3747 scheduling, to @file{@var{file}.36.dbr}.
3749 @item -dD
3750 @opindex dD
3751 Dump all macro definitions, at the end of preprocessing, in addition to
3752 normal output.
3754 @item -dE
3755 @itemx -fdump-rtl-ce3
3756 @opindex dE
3757 @opindex fdump-rtl-ce3
3758 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3760 @item -df
3761 @itemx -fdump-rtl-cfg
3762 @itemx -fdump-rtl-life
3763 @opindex df
3764 @opindex fdump-rtl-cfg
3765 @opindex fdump-rtl-life
3766 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3767 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3768 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3769 to @file{@var{file}.16.life}.
3771 @item -dg
3772 @itemx -fdump-rtl-greg
3773 @opindex dg
3774 @opindex fdump-rtl-greg
3775 Dump after global register allocation, to @file{@var{file}.23.greg}.
3777 @item -dG
3778 @itemx -fdump-rtl-gcse
3779 @itemx -fdump-rtl-bypass
3780 @opindex dG
3781 @opindex fdump-rtl-gcse
3782 @opindex fdump-rtl-bypass
3783 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3784 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3785 enable dumping after jump bypassing and control flow optimizations, to
3786 @file{@var{file}.07.bypass}.
3788 @item -dh
3789 @itemx -fdump-rtl-eh
3790 @opindex dh
3791 @opindex fdump-rtl-eh
3792 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3794 @item -di
3795 @itemx -fdump-rtl-sibling
3796 @opindex di
3797 @opindex fdump-rtl-sibling
3798 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3800 @item -dj
3801 @itemx -fdump-rtl-jump
3802 @opindex dj
3803 @opindex fdump-rtl-jump
3804 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3806 @item -dk
3807 @itemx -fdump-rtl-stack
3808 @opindex dk
3809 @opindex fdump-rtl-stack
3810 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3812 @item -dl
3813 @itemx -fdump-rtl-lreg
3814 @opindex dl
3815 @opindex fdump-rtl-lreg
3816 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3818 @item -dL
3819 @itemx -fdump-rtl-loop
3820 @itemx -fdump-rtl-loop2
3821 @opindex dL
3822 @opindex fdump-rtl-loop
3823 @opindex fdump-rtl-loop2
3824 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3825 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3826 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3827 @file{@var{file}.13.loop2}.
3829 @item -dm
3830 @itemx -fdump-rtl-sms
3831 @opindex dm
3832 @opindex fdump-rtl-sms
3833 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3835 @item -dM
3836 @itemx -fdump-rtl-mach
3837 @opindex dM
3838 @opindex fdump-rtl-mach
3839 Dump after performing the machine dependent reorganization pass, to
3840 @file{@var{file}.35.mach}.
3842 @item -dn
3843 @itemx -fdump-rtl-rnreg
3844 @opindex dn
3845 @opindex fdump-rtl-rnreg
3846 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3848 @item -dN
3849 @itemx -fdump-rtl-regmove
3850 @opindex dN
3851 @opindex fdump-rtl-regmove
3852 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3854 @item -do
3855 @itemx -fdump-rtl-postreload
3856 @opindex do
3857 @opindex fdump-rtl-postreload
3858 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3860 @item -dr
3861 @itemx -fdump-rtl-expand
3862 @opindex dr
3863 @opindex fdump-rtl-expand
3864 Dump after RTL generation, to @file{@var{file}.00.expand}.
3866 @item -dR
3867 @itemx -fdump-rtl-sched2
3868 @opindex dR
3869 @opindex fdump-rtl-sched2
3870 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3872 @item -ds
3873 @itemx -fdump-rtl-cse
3874 @opindex ds
3875 @opindex fdump-rtl-cse
3876 Dump after CSE (including the jump optimization that sometimes follows
3877 CSE), to @file{@var{file}.04.cse}.
3879 @item -dS
3880 @itemx -fdump-rtl-sched
3881 @opindex dS
3882 @opindex fdump-rtl-sched
3883 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3885 @item -dt
3886 @itemx -fdump-rtl-cse2
3887 @opindex dt
3888 @opindex fdump-rtl-cse2
3889 Dump after the second CSE pass (including the jump optimization that
3890 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3892 @item -dT
3893 @itemx -fdump-rtl-tracer
3894 @opindex dT
3895 @opindex fdump-rtl-tracer
3896 Dump after running tracer, to @file{@var{file}.12.tracer}.
3898 @item -dV
3899 @itemx -fdump-rtl-vpt
3900 @itemx -fdump-rtl-vartrack
3901 @opindex dV
3902 @opindex fdump-rtl-vpt
3903 @opindex fdump-rtl-vartrack
3904 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3905 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3906 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3907 to @file{@var{file}.34.vartrack}.
3909 @item -dw
3910 @itemx -fdump-rtl-flow2
3911 @opindex dw
3912 @opindex fdump-rtl-flow2
3913 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3915 @item -dz
3916 @itemx -fdump-rtl-peephole2
3917 @opindex dz
3918 @opindex fdump-rtl-peephole2
3919 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3921 @item -dZ
3922 @itemx -fdump-rtl-web
3923 @opindex dZ
3924 @opindex fdump-rtl-web
3925 Dump after live range splitting, to @file{@var{file}.14.web}.
3927 @item -da
3928 @itemx -fdump-rtl-all
3929 @opindex da
3930 @opindex fdump-rtl-all
3931 Produce all the dumps listed above.
3933 @item -dH
3934 @opindex dH
3935 Produce a core dump whenever an error occurs.
3937 @item -dm
3938 @opindex dm
3939 Print statistics on memory usage, at the end of the run, to
3940 standard error.
3942 @item -dp
3943 @opindex dp
3944 Annotate the assembler output with a comment indicating which
3945 pattern and alternative was used.  The length of each instruction is
3946 also printed.
3948 @item -dP
3949 @opindex dP
3950 Dump the RTL in the assembler output as a comment before each instruction.
3951 Also turns on @option{-dp} annotation.
3953 @item -dv
3954 @opindex dv
3955 For each of the other indicated dump files (either with @option{-d} or
3956 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3957 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3959 @item -dx
3960 @opindex dx
3961 Just generate RTL for a function instead of compiling it.  Usually used
3962 with @samp{r} (@option{-fdump-rtl-expand}).
3964 @item -dy
3965 @opindex dy
3966 Dump debugging information during parsing, to standard error.
3967 @end table
3969 @item -fdump-unnumbered
3970 @opindex fdump-unnumbered
3971 When doing debugging dumps (see @option{-d} option above), suppress instruction
3972 numbers and line number note output.  This makes it more feasible to
3973 use diff on debugging dumps for compiler invocations with different
3974 options, in particular with and without @option{-g}.
3976 @item -fdump-translation-unit @r{(C++ only)}
3977 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3978 @opindex fdump-translation-unit
3979 Dump a representation of the tree structure for the entire translation
3980 unit to a file.  The file name is made by appending @file{.tu} to the
3981 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3982 controls the details of the dump as described for the
3983 @option{-fdump-tree} options.
3985 @item -fdump-class-hierarchy @r{(C++ only)}
3986 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3987 @opindex fdump-class-hierarchy
3988 Dump a representation of each class's hierarchy and virtual function
3989 table layout to a file.  The file name is made by appending @file{.class}
3990 to the source file name.  If the @samp{-@var{options}} form is used,
3991 @var{options} controls the details of the dump as described for the
3992 @option{-fdump-tree} options.
3994 @item -fdump-ipa-@var{switch}
3995 @opindex fdump-ipa
3996 Control the dumping at various stages of inter-procedural analysis
3997 language tree to a file.  The file name is generated by appending a switch
3998 specific suffix to the source file name.  The following dumps are possible:
4000 @table @samp
4001 @item all
4002 Enables all inter-procedural analysis dumps; currently the only produced
4003 dump is the @samp{cgraph} dump.
4005 @item cgraph
4006 Dumps information about call-graph optimization, unused function removal,
4007 and inlining decisions.
4008 @end table
4010 @item -fdump-tree-@var{switch}
4011 @itemx -fdump-tree-@var{switch}-@var{options}
4012 @opindex fdump-tree
4013 Control the dumping at various stages of processing the intermediate
4014 language tree to a file.  The file name is generated by appending a switch
4015 specific suffix to the source file name.  If the @samp{-@var{options}}
4016 form is used, @var{options} is a list of @samp{-} separated options that
4017 control the details of the dump.  Not all options are applicable to all
4018 dumps, those which are not meaningful will be ignored.  The following
4019 options are available
4021 @table @samp
4022 @item address
4023 Print the address of each node.  Usually this is not meaningful as it
4024 changes according to the environment and source file.  Its primary use
4025 is for tying up a dump file with a debug environment.
4026 @item slim
4027 Inhibit dumping of members of a scope or body of a function merely
4028 because that scope has been reached.  Only dump such items when they
4029 are directly reachable by some other path.  When dumping pretty-printed
4030 trees, this option inhibits dumping the bodies of control structures.
4031 @item raw
4032 Print a raw representation of the tree.  By default, trees are
4033 pretty-printed into a C-like representation.
4034 @item details
4035 Enable more detailed dumps (not honored by every dump option).
4036 @item stats
4037 Enable dumping various statistics about the pass (not honored by every dump
4038 option).
4039 @item blocks
4040 Enable showing basic block boundaries (disabled in raw dumps).
4041 @item vops
4042 Enable showing virtual operands for every statement.
4043 @item lineno
4044 Enable showing line numbers for statements.
4045 @item uid
4046 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4047 @item all
4048 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4049 @end table
4051 The following tree dumps are possible:
4052 @table @samp
4054 @item original
4055 Dump before any tree based optimization, to @file{@var{file}.original}.
4057 @item optimized
4058 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4060 @item inlined
4061 Dump after function inlining, to @file{@var{file}.inlined}.
4063 @item gimple
4064 @opindex fdump-tree-gimple
4065 Dump each function before and after the gimplification pass to a file.  The
4066 file name is made by appending @file{.gimple} to the source file name.
4068 @item cfg
4069 @opindex fdump-tree-cfg
4070 Dump the control flow graph of each function to a file.  The file name is
4071 made by appending @file{.cfg} to the source file name.
4073 @item vcg
4074 @opindex fdump-tree-vcg
4075 Dump the control flow graph of each function to a file in VCG format.  The
4076 file name is made by appending @file{.vcg} to the source file name.  Note
4077 that if the file contains more than one function, the generated file cannot
4078 be used directly by VCG@.  You will need to cut and paste each function's
4079 graph into its own separate file first.
4081 @item ch
4082 @opindex fdump-tree-ch
4083 Dump each function after copying loop headers.  The file name is made by
4084 appending @file{.ch} to the source file name.
4086 @item ssa
4087 @opindex fdump-tree-ssa
4088 Dump SSA related information to a file.  The file name is made by appending
4089 @file{.ssa} to the source file name.
4091 @item salias
4092 @opindex fdump-tree-salias
4093 Dump structure aliasing variable information to a file.  This file name
4094 is made by appending @file{.salias} to the source file name.
4096 @item alias
4097 @opindex fdump-tree-alias
4098 Dump aliasing information for each function.  The file name is made by
4099 appending @file{.alias} to the source file name.
4101 @item ccp
4102 @opindex fdump-tree-ccp
4103 Dump each function after CCP@.  The file name is made by appending
4104 @file{.ccp} to the source file name.
4106 @item storeccp
4107 @opindex fdump-tree-storeccp
4108 Dump each function after STORE-CCP.  The file name is made by appending
4109 @file{.storeccp} to the source file name.
4111 @item pre
4112 @opindex fdump-tree-pre
4113 Dump trees after partial redundancy elimination.  The file name is made
4114 by appending @file{.pre} to the source file name.
4116 @item fre
4117 @opindex fdump-tree-fre
4118 Dump trees after full redundancy elimination.  The file name is made
4119 by appending @file{.fre} to the source file name.
4121 @item copyprop
4122 @opindex fdump-tree-copyprop
4123 Dump trees after copy propagation.  The file name is made
4124 by appending @file{.copyprop} to the source file name.
4126 @item store_copyprop
4127 @opindex fdump-tree-store_copyprop
4128 Dump trees after store copy-propagation.  The file name is made
4129 by appending @file{.store_copyprop} to the source file name.
4131 @item dce
4132 @opindex fdump-tree-dce
4133 Dump each function after dead code elimination.  The file name is made by
4134 appending @file{.dce} to the source file name.
4136 @item mudflap
4137 @opindex fdump-tree-mudflap
4138 Dump each function after adding mudflap instrumentation.  The file name is
4139 made by appending @file{.mudflap} to the source file name.
4141 @item sra
4142 @opindex fdump-tree-sra
4143 Dump each function after performing scalar replacement of aggregates.  The
4144 file name is made by appending @file{.sra} to the source file name.
4146 @item sink
4147 @opindex fdump-tree-sink
4148 Dump each function after performing code sinking.  The file name is made
4149 by appending @file{.sink} to the source file name. 
4151 @item dom
4152 @opindex fdump-tree-dom
4153 Dump each function after applying dominator tree optimizations.  The file
4154 name is made by appending @file{.dom} to the source file name.
4156 @item dse
4157 @opindex fdump-tree-dse
4158 Dump each function after applying dead store elimination.  The file
4159 name is made by appending @file{.dse} to the source file name.
4161 @item phiopt
4162 @opindex fdump-tree-phiopt
4163 Dump each function after optimizing PHI nodes into straightline code.  The file
4164 name is made by appending @file{.phiopt} to the source file name.
4166 @item forwprop
4167 @opindex fdump-tree-forwprop
4168 Dump each function after forward propagating single use variables.  The file
4169 name is made by appending @file{.forwprop} to the source file name.
4171 @item copyrename
4172 @opindex fdump-tree-copyrename
4173 Dump each function after applying the copy rename optimization.  The file
4174 name is made by appending @file{.copyrename} to the source file name.
4176 @item nrv
4177 @opindex fdump-tree-nrv
4178 Dump each function after applying the named return value optimization on
4179 generic trees.  The file name is made by appending @file{.nrv} to the source
4180 file name.
4182 @item vect
4183 @opindex fdump-tree-vect
4184 Dump each function after applying vectorization of loops.  The file name is
4185 made by appending @file{.vect} to the source file name.
4187 @item vrp
4188 @opindex fdump-tree-vrp
4189 Dump each function after Value Range Propagation (VRP).  The file name
4190 is made by appending @file{.vrp} to the source file name.
4192 @item all
4193 @opindex fdump-tree-all
4194 Enable all the available tree dumps with the flags provided in this option.
4195 @end table
4197 @item -ftree-vectorizer-verbose=@var{n}
4198 @opindex ftree-vectorizer-verbose
4199 This option controls the amount of debugging output the vectorizer prints.
4200 This information is written to standard error, unless 
4201 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified, 
4202 in which case it is output to the usual dump listing file, @file{.vect}.
4203 For @var{n}=0 no diagnostic information is reported.
4204 If @var{n}=1 the vectorizer reports each loop that got vectorized, 
4205 and the total number of loops that got vectorized.
4206 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed 
4207 the first analysis phase (vect_analyze_loop_form) - i.e. countable, 
4208 inner-most, single-bb, single-entry/exit loops.  This is the same verbosity 
4209 level that @option{-fdump-tree-vect-stats} uses.
4210 Higher verbosity levels mean either more information dumped for each 
4211 reported loop, or same amount of information reported for more loops:
4212 If @var{n}=3, alignment related information is added to the reports.
4213 If @var{n}=4, data-references related information (e.g. memory dependences, 
4214 memory access-patterns) is added to the reports.
4215 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops 
4216 that did not pass the first analysis phase (i.e. may not be countable, or 
4217 may have complicated control-flow).
4218 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4219 For @var{n}=7, all the information the vectorizer generates during its 
4220 analysis and transformation is reported.  This is the same verbosity level
4221 that @option{-fdump-tree-vect-details} uses.
4223 @item -frandom-seed=@var{string}
4224 @opindex frandom-string
4225 This option provides a seed that GCC uses when it would otherwise use
4226 random numbers.  It is used to generate certain symbol names
4227 that have to be different in every compiled file.  It is also used to
4228 place unique stamps in coverage data files and the object files that
4229 produce them.  You can use the @option{-frandom-seed} option to produce
4230 reproducibly identical object files.
4232 The @var{string} should be different for every file you compile.
4234 @item -fsched-verbose=@var{n}
4235 @opindex fsched-verbose
4236 On targets that use instruction scheduling, this option controls the
4237 amount of debugging output the scheduler prints.  This information is
4238 written to standard error, unless @option{-dS} or @option{-dR} is
4239 specified, in which case it is output to the usual dump
4240 listing file, @file{.sched} or @file{.sched2} respectively.  However
4241 for @var{n} greater than nine, the output is always printed to standard
4242 error.
4244 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4245 same information as @option{-dRS}.  For @var{n} greater than one, it
4246 also output basic block probabilities, detailed ready list information
4247 and unit/insn info.  For @var{n} greater than two, it includes RTL
4248 at abort point, control-flow and regions info.  And for @var{n} over
4249 four, @option{-fsched-verbose} also includes dependence info.
4251 @item -save-temps
4252 @opindex save-temps
4253 Store the usual ``temporary'' intermediate files permanently; place them
4254 in the current directory and name them based on the source file.  Thus,
4255 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4256 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4257 preprocessed @file{foo.i} output file even though the compiler now
4258 normally uses an integrated preprocessor.
4260 When used in combination with the @option{-x} command line option,
4261 @option{-save-temps} is sensible enough to avoid over writing an
4262 input source file with the same extension as an intermediate file.
4263 The corresponding intermediate file may be obtained by renaming the
4264 source file before using @option{-save-temps}.
4266 @item -time
4267 @opindex time
4268 Report the CPU time taken by each subprocess in the compilation
4269 sequence.  For C source files, this is the compiler proper and assembler
4270 (plus the linker if linking is done).  The output looks like this:
4272 @smallexample
4273 # cc1 0.12 0.01
4274 # as 0.00 0.01
4275 @end smallexample
4277 The first number on each line is the ``user time'', that is time spent
4278 executing the program itself.  The second number is ``system time'',
4279 time spent executing operating system routines on behalf of the program.
4280 Both numbers are in seconds.
4282 @item -fvar-tracking
4283 @opindex fvar-tracking
4284 Run variable tracking pass.  It computes where variables are stored at each
4285 position in code.  Better debugging information is then generated
4286 (if the debugging information format supports this information).
4288 It is enabled by default when compiling with optimization (@option{-Os},
4289 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4290 the debug info format supports it.
4292 @item -print-file-name=@var{library}
4293 @opindex print-file-name
4294 Print the full absolute name of the library file @var{library} that
4295 would be used when linking---and don't do anything else.  With this
4296 option, GCC does not compile or link anything; it just prints the
4297 file name.
4299 @item -print-multi-directory
4300 @opindex print-multi-directory
4301 Print the directory name corresponding to the multilib selected by any
4302 other switches present in the command line.  This directory is supposed
4303 to exist in @env{GCC_EXEC_PREFIX}.
4305 @item -print-multi-lib
4306 @opindex print-multi-lib
4307 Print the mapping from multilib directory names to compiler switches
4308 that enable them.  The directory name is separated from the switches by
4309 @samp{;}, and each switch starts with an @samp{@@} instead of the
4310 @samp{-}, without spaces between multiple switches.  This is supposed to
4311 ease shell-processing.
4313 @item -print-prog-name=@var{program}
4314 @opindex print-prog-name
4315 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4317 @item -print-libgcc-file-name
4318 @opindex print-libgcc-file-name
4319 Same as @option{-print-file-name=libgcc.a}.
4321 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4322 but you do want to link with @file{libgcc.a}.  You can do
4324 @smallexample
4325 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4326 @end smallexample
4328 @item -print-search-dirs
4329 @opindex print-search-dirs
4330 Print the name of the configured installation directory and a list of
4331 program and library directories @command{gcc} will search---and don't do anything else.
4333 This is useful when @command{gcc} prints the error message
4334 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4335 To resolve this you either need to put @file{cpp0} and the other compiler
4336 components where @command{gcc} expects to find them, or you can set the environment
4337 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4338 Don't forget the trailing @samp{/}.
4339 @xref{Environment Variables}.
4341 @item -dumpmachine
4342 @opindex dumpmachine
4343 Print the compiler's target machine (for example,
4344 @samp{i686-pc-linux-gnu})---and don't do anything else.
4346 @item -dumpversion
4347 @opindex dumpversion
4348 Print the compiler version (for example, @samp{3.0})---and don't do
4349 anything else.
4351 @item -dumpspecs
4352 @opindex dumpspecs
4353 Print the compiler's built-in specs---and don't do anything else.  (This
4354 is used when GCC itself is being built.)  @xref{Spec Files}.
4356 @item -feliminate-unused-debug-types
4357 @opindex feliminate-unused-debug-types
4358 Normally, when producing DWARF2 output, GCC will emit debugging
4359 information for all types declared in a compilation
4360 unit, regardless of whether or not they are actually used
4361 in that compilation unit.  Sometimes this is useful, such as
4362 if, in the debugger, you want to cast a value to a type that is
4363 not actually used in your program (but is declared).  More often,
4364 however, this results in a significant amount of wasted space.
4365 With this option, GCC will avoid producing debug symbol output
4366 for types that are nowhere used in the source file being compiled.
4367 @end table
4369 @node Optimize Options
4370 @section Options That Control Optimization
4371 @cindex optimize options
4372 @cindex options, optimization
4374 These options control various sorts of optimizations.
4376 Without any optimization option, the compiler's goal is to reduce the
4377 cost of compilation and to make debugging produce the expected
4378 results.  Statements are independent: if you stop the program with a
4379 breakpoint between statements, you can then assign a new value to any
4380 variable or change the program counter to any other statement in the
4381 function and get exactly the results you would expect from the source
4382 code.
4384 Turning on optimization flags makes the compiler attempt to improve
4385 the performance and/or code size at the expense of compilation time
4386 and possibly the ability to debug the program.
4388 The compiler performs optimization based on the knowledge it has of
4389 the program.  Optimization levels @option{-O2} and above, in
4390 particular, enable @emph{unit-at-a-time} mode, which allows the
4391 compiler to consider information gained from later functions in
4392 the file when compiling a function.  Compiling multiple files at
4393 once to a single output file in @emph{unit-at-a-time} mode allows
4394 the compiler to use information gained from all of the files when
4395 compiling each of them.
4397 Not all optimizations are controlled directly by a flag.  Only
4398 optimizations that have a flag are listed.
4400 @table @gcctabopt
4401 @item -O
4402 @itemx -O1
4403 @opindex O
4404 @opindex O1
4405 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4406 more memory for a large function.
4408 With @option{-O}, the compiler tries to reduce code size and execution
4409 time, without performing any optimizations that take a great deal of
4410 compilation time.
4412 @option{-O} turns on the following optimization flags:
4413 @gccoptlist{-fdefer-pop @gol
4414 -fdelayed-branch @gol
4415 -fguess-branch-probability @gol
4416 -fcprop-registers @gol
4417 -fif-conversion @gol
4418 -fif-conversion2 @gol
4419 -ftree-ccp @gol
4420 -ftree-dce @gol
4421 -ftree-dominator-opts @gol
4422 -ftree-dse @gol
4423 -ftree-ter @gol
4424 -ftree-lrs @gol
4425 -ftree-sra @gol
4426 -ftree-copyrename @gol
4427 -ftree-fre @gol
4428 -ftree-ch @gol
4429 -fmerge-constants}
4431 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4432 where doing so does not interfere with debugging.
4434 @item -O2
4435 @opindex O2
4436 Optimize even more.  GCC performs nearly all supported optimizations
4437 that do not involve a space-speed tradeoff.  The compiler does not
4438 perform loop unrolling or function inlining when you specify @option{-O2}.
4439 As compared to @option{-O}, this option increases both compilation time
4440 and the performance of the generated code.
4442 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4443 also turns on the following optimization flags:
4444 @gccoptlist{-fthread-jumps @gol
4445 -fcrossjumping @gol
4446 -foptimize-sibling-calls @gol
4447 -fcse-follow-jumps  -fcse-skip-blocks @gol
4448 -fgcse  -fgcse-lm  @gol
4449 -fexpensive-optimizations @gol
4450 -frerun-cse-after-loop  @gol
4451 -fcaller-saves @gol
4452 -fpeephole2 @gol
4453 -fschedule-insns  -fschedule-insns2 @gol
4454 -fsched-interblock  -fsched-spec @gol
4455 -fregmove @gol
4456 -fstrict-aliasing @gol
4457 -fdelete-null-pointer-checks @gol
4458 -freorder-blocks  -freorder-functions @gol
4459 -funit-at-a-time @gol
4460 -falign-functions  -falign-jumps @gol
4461 -falign-loops  -falign-labels @gol
4462 -ftree-vrp @gol
4463 -ftree-pre}
4465 Please note the warning under @option{-fgcse} about
4466 invoking @option{-O2} on programs that use computed gotos.
4468 @item -O3
4469 @opindex O3
4470 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4471 @option{-O2} and also turns on the @option{-finline-functions},
4472 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4474 @item -O0
4475 @opindex O0
4476 Do not optimize.  This is the default.
4478 @item -Os
4479 @opindex Os
4480 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4481 do not typically increase code size.  It also performs further
4482 optimizations designed to reduce code size.
4484 @option{-Os} disables the following optimization flags:
4485 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4486 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
4487 -fprefetch-loop-arrays  -ftree-vect-loop-version}
4489 If you use multiple @option{-O} options, with or without level numbers,
4490 the last such option is the one that is effective.
4491 @end table
4493 Options of the form @option{-f@var{flag}} specify machine-independent
4494 flags.  Most flags have both positive and negative forms; the negative
4495 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4496 below, only one of the forms is listed---the one you typically will
4497 use.  You can figure out the other form by either removing @samp{no-}
4498 or adding it.
4500 The following options control specific optimizations.  They are either
4501 activated by @option{-O} options or are related to ones that are.  You
4502 can use the following flags in the rare cases when ``fine-tuning'' of
4503 optimizations to be performed is desired.
4505 @table @gcctabopt
4506 @item -fno-default-inline
4507 @opindex fno-default-inline
4508 Do not make member functions inline by default merely because they are
4509 defined inside the class scope (C++ only).  Otherwise, when you specify
4510 @w{@option{-O}}, member functions defined inside class scope are compiled
4511 inline by default; i.e., you don't need to add @samp{inline} in front of
4512 the member function name.
4514 @item -fno-defer-pop
4515 @opindex fno-defer-pop
4516 Always pop the arguments to each function call as soon as that function
4517 returns.  For machines which must pop arguments after a function call,
4518 the compiler normally lets arguments accumulate on the stack for several
4519 function calls and pops them all at once.
4521 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4523 @item -fforce-mem
4524 @opindex fforce-mem
4525 Force memory operands to be copied into registers before doing
4526 arithmetic on them.  This produces better code by making all memory
4527 references potential common subexpressions.  When they are not common
4528 subexpressions, instruction combination should eliminate the separate
4529 register-load. This option is now a nop and will be removed in 4.2.
4531 @item -fforce-addr
4532 @opindex fforce-addr
4533 Force memory address constants to be copied into registers before
4534 doing arithmetic on them.
4536 @item -fomit-frame-pointer
4537 @opindex fomit-frame-pointer
4538 Don't keep the frame pointer in a register for functions that
4539 don't need one.  This avoids the instructions to save, set up and
4540 restore frame pointers; it also makes an extra register available
4541 in many functions.  @strong{It also makes debugging impossible on
4542 some machines.}
4544 On some machines, such as the VAX, this flag has no effect, because
4545 the standard calling sequence automatically handles the frame pointer
4546 and nothing is saved by pretending it doesn't exist.  The
4547 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4548 whether a target machine supports this flag.  @xref{Registers,,Register
4549 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4551 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4553 @item -foptimize-sibling-calls
4554 @opindex foptimize-sibling-calls
4555 Optimize sibling and tail recursive calls.
4557 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4559 @item -fno-inline
4560 @opindex fno-inline
4561 Don't pay attention to the @code{inline} keyword.  Normally this option
4562 is used to keep the compiler from expanding any functions inline.
4563 Note that if you are not optimizing, no functions can be expanded inline.
4565 @item -finline-functions
4566 @opindex finline-functions
4567 Integrate all simple functions into their callers.  The compiler
4568 heuristically decides which functions are simple enough to be worth
4569 integrating in this way.
4571 If all calls to a given function are integrated, and the function is
4572 declared @code{static}, then the function is normally not output as
4573 assembler code in its own right.
4575 Enabled at level @option{-O3}.
4577 @item -finline-functions-called-once
4578 @opindex finline-functions-called-once
4579 Consider all @code{static} functions called once for inlining into their
4580 caller even if they are not marked @code{inline}.  If a call to a given
4581 function is integrated, then the function is not output as assembler code
4582 in its own right.
4584 Enabled if @option{-funit-at-a-time} is enabled.
4586 @item -fearly-inlining
4587 @opindex fearly-inlining
4588 Inline functions marked by @code{always_inline} and functions whose body seems
4589 smaller than the function call overhead early before doing
4590 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4591 makes profiling significantly cheaper and usually inlining faster on programs
4592 having large chains of nested wrapper functions.
4594 Enabled by default.
4596 @item -finline-limit=@var{n}
4597 @opindex finline-limit
4598 By default, GCC limits the size of functions that can be inlined.  This flag
4599 allows the control of this limit for functions that are explicitly marked as
4600 inline (i.e., marked with the inline keyword or defined within the class
4601 definition in c++).  @var{n} is the size of functions that can be inlined in
4602 number of pseudo instructions (not counting parameter handling).  The default
4603 value of @var{n} is 600.
4604 Increasing this value can result in more inlined code at
4605 the cost of compilation time and memory consumption.  Decreasing usually makes
4606 the compilation faster and less code will be inlined (which presumably
4607 means slower programs).  This option is particularly useful for programs that
4608 use inlining heavily such as those based on recursive templates with C++.
4610 Inlining is actually controlled by a number of parameters, which may be
4611 specified individually by using @option{--param @var{name}=@var{value}}.
4612 The @option{-finline-limit=@var{n}} option sets some of these parameters
4613 as follows:
4615 @table @gcctabopt
4616  @item max-inline-insns-single
4617   is set to @var{n}/2.
4618  @item max-inline-insns-auto
4619   is set to @var{n}/2.
4620  @item min-inline-insns
4621   is set to 130 or @var{n}/4, whichever is smaller.
4622  @item max-inline-insns-rtl
4623   is set to @var{n}.
4624 @end table
4626 See below for a documentation of the individual
4627 parameters controlling inlining.
4629 @emph{Note:} pseudo instruction represents, in this particular context, an
4630 abstract measurement of function's size.  In no way does it represent a count
4631 of assembly instructions and as such its exact meaning might change from one
4632 release to an another.
4634 @item -fkeep-inline-functions
4635 @opindex fkeep-inline-functions
4636 In C, emit @code{static} functions that are declared @code{inline}
4637 into the object file, even if the function has been inlined into all
4638 of its callers.  This switch does not affect functions using the
4639 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4640 inline functions into the object file.
4642 @item -fkeep-static-consts
4643 @opindex fkeep-static-consts
4644 Emit variables declared @code{static const} when optimization isn't turned
4645 on, even if the variables aren't referenced.
4647 GCC enables this option by default.  If you want to force the compiler to
4648 check if the variable was referenced, regardless of whether or not
4649 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4651 @item -fmerge-constants
4652 Attempt to merge identical constants (string constants and floating point
4653 constants) across compilation units.
4655 This option is the default for optimized compilation if the assembler and
4656 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4657 behavior.
4659 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4661 @item -fmerge-all-constants
4662 Attempt to merge identical constants and identical variables.
4664 This option implies @option{-fmerge-constants}.  In addition to
4665 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4666 arrays or initialized constant variables with integral or floating point
4667 types.  Languages like C or C++ require each non-automatic variable to
4668 have distinct location, so using this option will result in non-conforming
4669 behavior.
4671 @item -fmodulo-sched
4672 @opindex fmodulo-sched
4673 Perform swing modulo scheduling immediately before the first scheduling
4674 pass.  This pass looks at innermost loops and reorders their
4675 instructions by overlapping different iterations.
4677 @item -fno-branch-count-reg
4678 @opindex fno-branch-count-reg
4679 Do not use ``decrement and branch'' instructions on a count register,
4680 but instead generate a sequence of instructions that decrement a
4681 register, compare it against zero, then branch based upon the result.
4682 This option is only meaningful on architectures that support such
4683 instructions, which include x86, PowerPC, IA-64 and S/390.
4685 The default is @option{-fbranch-count-reg}.
4687 @item -fno-function-cse
4688 @opindex fno-function-cse
4689 Do not put function addresses in registers; make each instruction that
4690 calls a constant function contain the function's address explicitly.
4692 This option results in less efficient code, but some strange hacks
4693 that alter the assembler output may be confused by the optimizations
4694 performed when this option is not used.
4696 The default is @option{-ffunction-cse}
4698 @item -fno-zero-initialized-in-bss
4699 @opindex fno-zero-initialized-in-bss
4700 If the target supports a BSS section, GCC by default puts variables that
4701 are initialized to zero into BSS@.  This can save space in the resulting
4702 code.
4704 This option turns off this behavior because some programs explicitly
4705 rely on variables going to the data section.  E.g., so that the
4706 resulting executable can find the beginning of that section and/or make
4707 assumptions based on that.
4709 The default is @option{-fzero-initialized-in-bss}.
4711 @item -fbounds-check
4712 @opindex fbounds-check
4713 For front-ends that support it, generate additional code to check that
4714 indices used to access arrays are within the declared range.  This is
4715 currently only supported by the Java and Fortran front-ends, where
4716 this option defaults to true and false respectively.
4718 @item -fmudflap -fmudflapth -fmudflapir
4719 @opindex fmudflap
4720 @opindex fmudflapth
4721 @opindex fmudflapir
4722 @cindex bounds checking
4723 @cindex mudflap
4724 For front-ends that support it (C and C++), instrument all risky
4725 pointer/array dereferencing operations, some standard library
4726 string/heap functions, and some other associated constructs with
4727 range/validity tests.  Modules so instrumented should be immune to
4728 buffer overflows, invalid heap use, and some other classes of C/C++
4729 programming errors.  The instrumentation relies on a separate runtime
4730 library (@file{libmudflap}), which will be linked into a program if
4731 @option{-fmudflap} is given at link time.  Run-time behavior of the
4732 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4733 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4734 for its options.
4736 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4737 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4738 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4739 instrumentation should ignore pointer reads.  This produces less
4740 instrumentation (and therefore faster execution) and still provides
4741 some protection against outright memory corrupting writes, but allows
4742 erroneously read data to propagate within a program.
4744 @item -fthread-jumps
4745 @opindex fthread-jumps
4746 Perform optimizations where we check to see if a jump branches to a
4747 location where another comparison subsumed by the first is found.  If
4748 so, the first branch is redirected to either the destination of the
4749 second branch or a point immediately following it, depending on whether
4750 the condition is known to be true or false.
4752 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4754 @item -fcse-follow-jumps
4755 @opindex fcse-follow-jumps
4756 In common subexpression elimination, scan through jump instructions
4757 when the target of the jump is not reached by any other path.  For
4758 example, when CSE encounters an @code{if} statement with an
4759 @code{else} clause, CSE will follow the jump when the condition
4760 tested is false.
4762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4764 @item -fcse-skip-blocks
4765 @opindex fcse-skip-blocks
4766 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4767 follow jumps which conditionally skip over blocks.  When CSE
4768 encounters a simple @code{if} statement with no else clause,
4769 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4770 body of the @code{if}.
4772 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4774 @item -frerun-cse-after-loop
4775 @opindex frerun-cse-after-loop
4776 Re-run common subexpression elimination after loop optimizations has been
4777 performed.
4779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4781 @item -fgcse
4782 @opindex fgcse
4783 Perform a global common subexpression elimination pass.
4784 This pass also performs global constant and copy propagation.
4786 @emph{Note:} When compiling a program using computed gotos, a GCC
4787 extension, you may get better runtime performance if you disable
4788 the global common subexpression elimination pass by adding
4789 @option{-fno-gcse} to the command line.
4791 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4793 @item -fgcse-lm
4794 @opindex fgcse-lm
4795 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4796 attempt to move loads which are only killed by stores into themselves.  This
4797 allows a loop containing a load/store sequence to be changed to a load outside
4798 the loop, and a copy/store within the loop.
4800 Enabled by default when gcse is enabled.
4802 @item -fgcse-sm
4803 @opindex fgcse-sm
4804 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4805 global common subexpression elimination.  This pass will attempt to move
4806 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4807 loops containing a load/store sequence can be changed to a load before
4808 the loop and a store after the loop.
4810 Not enabled at any optimization level.
4812 @item -fgcse-las
4813 @opindex fgcse-las
4814 When @option{-fgcse-las} is enabled, the global common subexpression
4815 elimination pass eliminates redundant loads that come after stores to the
4816 same memory location (both partial and full redundancies).
4818 Not enabled at any optimization level.
4820 @item -fgcse-after-reload
4821 @opindex fgcse-after-reload
4822 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4823 pass is performed after reload.  The purpose of this pass is to cleanup
4824 redundant spilling.
4826 @item -funsafe-loop-optimizations
4827 @opindex funsafe-loop-optimizations
4828 If given, the loop optimizer will assume that loop indices do not
4829 overflow, and that the loops with nontrivial exit condition are not
4830 infinite.  This enables a wider range of loop optimizations even if
4831 the loop optimizer itself cannot prove that these assumptions are valid.
4832 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4833 if it finds this kind of loop.
4835 @item -fcrossjumping
4836 @opindex crossjumping
4837 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4838 resulting code may or may not perform better than without cross-jumping.
4840 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4842 @item -fif-conversion
4843 @opindex if-conversion
4844 Attempt to transform conditional jumps into branch-less equivalents.  This
4845 include use of conditional moves, min, max, set flags and abs instructions, and
4846 some tricks doable by standard arithmetics.  The use of conditional execution
4847 on chips where it is available is controlled by @code{if-conversion2}.
4849 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4851 @item -fif-conversion2
4852 @opindex if-conversion2
4853 Use conditional execution (where available) to transform conditional jumps into
4854 branch-less equivalents.
4856 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4858 @item -fdelete-null-pointer-checks
4859 @opindex fdelete-null-pointer-checks
4860 Use global dataflow analysis to identify and eliminate useless checks
4861 for null pointers.  The compiler assumes that dereferencing a null
4862 pointer would have halted the program.  If a pointer is checked after
4863 it has already been dereferenced, it cannot be null.
4865 In some environments, this assumption is not true, and programs can
4866 safely dereference null pointers.  Use
4867 @option{-fno-delete-null-pointer-checks} to disable this optimization
4868 for programs which depend on that behavior.
4870 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4872 @item -fexpensive-optimizations
4873 @opindex fexpensive-optimizations
4874 Perform a number of minor optimizations that are relatively expensive.
4876 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4878 @item -foptimize-register-move
4879 @itemx -fregmove
4880 @opindex foptimize-register-move
4881 @opindex fregmove
4882 Attempt to reassign register numbers in move instructions and as
4883 operands of other simple instructions in order to maximize the amount of
4884 register tying.  This is especially helpful on machines with two-operand
4885 instructions.
4887 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4888 optimization.
4890 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4892 @item -fdelayed-branch
4893 @opindex fdelayed-branch
4894 If supported for the target machine, attempt to reorder instructions
4895 to exploit instruction slots available after delayed branch
4896 instructions.
4898 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4900 @item -fschedule-insns
4901 @opindex fschedule-insns
4902 If supported for the target machine, attempt to reorder instructions to
4903 eliminate execution stalls due to required data being unavailable.  This
4904 helps machines that have slow floating point or memory load instructions
4905 by allowing other instructions to be issued until the result of the load
4906 or floating point instruction is required.
4908 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4910 @item -fschedule-insns2
4911 @opindex fschedule-insns2
4912 Similar to @option{-fschedule-insns}, but requests an additional pass of
4913 instruction scheduling after register allocation has been done.  This is
4914 especially useful on machines with a relatively small number of
4915 registers and where memory load instructions take more than one cycle.
4917 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4919 @item -fno-sched-interblock
4920 @opindex fno-sched-interblock
4921 Don't schedule instructions across basic blocks.  This is normally
4922 enabled by default when scheduling before register allocation, i.e.@:
4923 with @option{-fschedule-insns} or at @option{-O2} or higher.
4925 @item -fno-sched-spec
4926 @opindex fno-sched-spec
4927 Don't allow speculative motion of non-load instructions.  This is normally
4928 enabled by default when scheduling before register allocation, i.e.@:
4929 with @option{-fschedule-insns} or at @option{-O2} or higher.
4931 @item -fsched-spec-load
4932 @opindex fsched-spec-load
4933 Allow speculative motion of some load instructions.  This only makes
4934 sense when scheduling before register allocation, i.e.@: with
4935 @option{-fschedule-insns} or at @option{-O2} or higher.
4937 @item -fsched-spec-load-dangerous
4938 @opindex fsched-spec-load-dangerous
4939 Allow speculative motion of more load instructions.  This only makes
4940 sense when scheduling before register allocation, i.e.@: with
4941 @option{-fschedule-insns} or at @option{-O2} or higher.
4943 @item -fsched-stalled-insns=@var{n}
4944 @opindex fsched-stalled-insns
4945 Define how many insns (if any) can be moved prematurely from the queue
4946 of stalled insns into the ready list, during the second scheduling pass.
4948 @item -fsched-stalled-insns-dep=@var{n}
4949 @opindex fsched-stalled-insns-dep
4950 Define how many insn groups (cycles) will be examined for a dependency
4951 on a stalled insn that is candidate for premature removal from the queue
4952 of stalled insns.  Has an effect only during the second scheduling pass,
4953 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4955 @item -fsched2-use-superblocks
4956 @opindex fsched2-use-superblocks
4957 When scheduling after register allocation, do use superblock scheduling
4958 algorithm.  Superblock scheduling allows motion across basic block boundaries
4959 resulting on faster schedules.  This option is experimental, as not all machine
4960 descriptions used by GCC model the CPU closely enough to avoid unreliable
4961 results from the algorithm.
4963 This only makes sense when scheduling after register allocation, i.e.@: with
4964 @option{-fschedule-insns2} or at @option{-O2} or higher.
4966 @item -fsched2-use-traces
4967 @opindex fsched2-use-traces
4968 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4969 allocation and additionally perform code duplication in order to increase the
4970 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4971 trace formation.
4973 This mode should produce faster but significantly longer programs.  Also
4974 without @option{-fbranch-probabilities} the traces constructed may not
4975 match the reality and hurt the performance.  This only makes
4976 sense when scheduling after register allocation, i.e.@: with
4977 @option{-fschedule-insns2} or at @option{-O2} or higher.
4979 @item -freschedule-modulo-scheduled-loops
4980 @opindex fscheduling-in-modulo-scheduled-loops
4981 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4982 we may want to prevent the later scheduling passes from changing its schedule, we use this
4983 option to control that.
4985 @item -fcaller-saves
4986 @opindex fcaller-saves
4987 Enable values to be allocated in registers that will be clobbered by
4988 function calls, by emitting extra instructions to save and restore the
4989 registers around such calls.  Such allocation is done only when it
4990 seems to result in better code than would otherwise be produced.
4992 This option is always enabled by default on certain machines, usually
4993 those which have no call-preserved registers to use instead.
4995 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4997 @item -ftree-pre
4998 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4999 enabled by default at @option{-O2} and @option{-O3}.
5001 @item -ftree-fre
5002 Perform Full Redundancy Elimination (FRE) on trees.  The difference
5003 between FRE and PRE is that FRE only considers expressions
5004 that are computed on all paths leading to the redundant computation.
5005 This analysis faster than PRE, though it exposes fewer redundancies.
5006 This flag is enabled by default at @option{-O} and higher.
5008 @item -ftree-copy-prop
5009 Perform copy propagation on trees.  This pass eliminates unnecessary
5010 copy operations.  This flag is enabled by default at @option{-O} and
5011 higher.
5013 @item -ftree-store-copy-prop
5014 Perform copy propagation of memory loads and stores.  This pass
5015 eliminates unnecessary copy operations in memory references
5016 (structures, global variables, arrays, etc).  This flag is enabled by
5017 default at @option{-O2} and higher.
5019 @item -ftree-salias
5020 Perform structural alias analysis on trees.  This flag
5021 is enabled by default at @option{-O} and higher.
5023 @item -fipa-pta
5024 Perform interprocedural pointer analysis.
5026 @item -ftree-sink
5027 Perform forward store motion  on trees.  This flag is
5028 enabled by default at @option{-O} and higher.
5030 @item -ftree-ccp
5031 Perform sparse conditional constant propagation (CCP) on trees.  This
5032 pass only operates on local scalar variables and is enabled by default
5033 at @option{-O} and higher.
5035 @item -ftree-store-ccp
5036 Perform sparse conditional constant propagation (CCP) on trees.  This
5037 pass operates on both local scalar variables and memory stores and
5038 loads (global variables, structures, arrays, etc).  This flag is
5039 enabled by default at @option{-O2} and higher.
5041 @item -ftree-dce
5042 Perform dead code elimination (DCE) on trees.  This flag is enabled by
5043 default at @option{-O} and higher.
5045 @item -ftree-dominator-opts
5046 Perform a variety of simple scalar cleanups (constant/copy
5047 propagation, redundancy elimination, range propagation and expression
5048 simplification) based on a dominator tree traversal.  This also
5049 performs jump threading (to reduce jumps to jumps). This flag is
5050 enabled by default at @option{-O} and higher.
5052 @item -ftree-ch
5053 Perform loop header copying on trees.  This is beneficial since it increases
5054 effectiveness of code motion optimizations.  It also saves one jump.  This flag
5055 is enabled by default at @option{-O} and higher.  It is not enabled
5056 for @option{-Os}, since it usually increases code size.
5058 @item -ftree-loop-optimize
5059 Perform loop optimizations on trees.  This flag is enabled by default
5060 at @option{-O} and higher.
5062 @item -ftree-loop-linear
5063 Perform linear loop transformations on tree.  This flag can improve cache
5064 performance and allow further loop optimizations to take place.
5066 @item -ftree-loop-im
5067 Perform loop invariant motion on trees.  This pass moves only invariants that
5068 would be hard to handle at RTL level (function calls, operations that expand to
5069 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
5070 operands of conditions that are invariant out of the loop, so that we can use
5071 just trivial invariantness analysis in loop unswitching.  The pass also includes
5072 store motion.
5074 @item -ftree-loop-ivcanon
5075 Create a canonical counter for number of iterations in the loop for that
5076 determining number of iterations requires complicated analysis.  Later
5077 optimizations then may determine the number easily.  Useful especially
5078 in connection with unrolling.
5080 @item -fivopts
5081 Perform induction variable optimizations (strength reduction, induction
5082 variable merging and induction variable elimination) on trees.
5084 @item -ftree-sra
5085 Perform scalar replacement of aggregates.  This pass replaces structure
5086 references with scalars to prevent committing structures to memory too
5087 early.  This flag is enabled by default at @option{-O} and higher.
5089 @item -ftree-copyrename
5090 Perform copy renaming on trees.  This pass attempts to rename compiler
5091 temporaries to other variables at copy locations, usually resulting in
5092 variable names which more closely resemble the original variables.  This flag
5093 is enabled by default at @option{-O} and higher.
5095 @item -ftree-ter
5096 Perform temporary expression replacement during the SSA->normal phase.  Single
5097 use/single def temporaries are replaced at their use location with their
5098 defining expression.  This results in non-GIMPLE code, but gives the expanders
5099 much more complex trees to work on resulting in better RTL generation.  This is
5100 enabled by default at @option{-O} and higher.
5102 @item -ftree-lrs
5103 Perform live range splitting during the SSA->normal phase.  Distinct live
5104 ranges of a variable are split into unique variables, allowing for better
5105 optimization later.  This is enabled by default at @option{-O} and higher.
5107 @item -ftree-vectorize
5108 Perform loop vectorization on trees.
5110 @item -ftree-vect-loop-version
5111 @opindex ftree-vect-loop-version
5112 Perform loop versioning when doing loop vectorization on trees.  When a loop
5113 appears to be vectorizable except that data alignment or data dependence cannot
5114 be determined at compile time then vectorized and non-vectorized versions of
5115 the loop are generated along with runtime checks for alignment or dependence
5116 to control which version is executed.  This option is enabled by default
5117 except at level @option{-Os} where it is disabled.
5119 @item -ftree-vrp
5120 Perform Value Range Propagation on trees.  This is similar to the
5121 constant propagation pass, but instead of values, ranges of values are
5122 propagated.  This allows the optimizers to remove unnecessary range
5123 checks like array bound checks and null pointer checks.  This is
5124 enabled by default at @option{-O2} and higher.  Null pointer check
5125 elimination is only done if @option{-fdelete-null-pointer-checks} is
5126 enabled.
5128 @item -ftracer
5129 @opindex ftracer
5130 Perform tail duplication to enlarge superblock size.  This transformation
5131 simplifies the control flow of the function allowing other optimizations to do
5132 better job.
5134 @item -funroll-loops
5135 @opindex funroll-loops
5136 Unroll loops whose number of iterations can be determined at compile
5137 time or upon entry to the loop.  @option{-funroll-loops} implies
5138 @option{-frerun-cse-after-loop}.  This option makes code larger,
5139 and may or may not make it run faster.
5141 @item -funroll-all-loops
5142 @opindex funroll-all-loops
5143 Unroll all loops, even if their number of iterations is uncertain when
5144 the loop is entered.  This usually makes programs run more slowly.
5145 @option{-funroll-all-loops} implies the same options as
5146 @option{-funroll-loops},
5148 @item -fsplit-ivs-in-unroller
5149 @opindex -fsplit-ivs-in-unroller
5150 Enables expressing of values of induction variables in later iterations
5151 of the unrolled loop using the value in the first iteration.  This breaks
5152 long dependency chains, thus improving efficiency of the scheduling passes.
5154 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5155 same effect.  However in cases the loop body is more complicated than
5156 a single basic block, this is not reliable.  It also does not work at all
5157 on some of the architectures due to restrictions in the CSE pass.
5159 This optimization is enabled by default.
5161 @item -fvariable-expansion-in-unroller
5162 @opindex -fvariable-expansion-in-unroller
5163 With this option, the compiler will create multiple copies of some
5164 local variables when unrolling a loop which can result in superior code.
5166 @item -fprefetch-loop-arrays
5167 @opindex fprefetch-loop-arrays
5168 If supported by the target machine, generate instructions to prefetch
5169 memory to improve the performance of loops that access large arrays.
5171 This option may generate better or worse code; results are highly
5172 dependent on the structure of loops within the source code.
5174 Disabled at level @option{-Os}.
5176 @item -fno-peephole
5177 @itemx -fno-peephole2
5178 @opindex fno-peephole
5179 @opindex fno-peephole2
5180 Disable any machine-specific peephole optimizations.  The difference
5181 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5182 are implemented in the compiler; some targets use one, some use the
5183 other, a few use both.
5185 @option{-fpeephole} is enabled by default.
5186 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5188 @item -fno-guess-branch-probability
5189 @opindex fno-guess-branch-probability
5190 Do not guess branch probabilities using heuristics.
5192 GCC will use heuristics to guess branch probabilities if they are
5193 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5194 heuristics are based on the control flow graph.  If some branch probabilities
5195 are specified by @samp{__builtin_expect}, then the heuristics will be
5196 used to guess branch probabilities for the rest of the control flow graph,
5197 taking the @samp{__builtin_expect} info into account.  The interactions
5198 between the heuristics and @samp{__builtin_expect} can be complex, and in
5199 some cases, it may be useful to disable the heuristics so that the effects
5200 of @samp{__builtin_expect} are easier to understand.
5202 The default is @option{-fguess-branch-probability} at levels
5203 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5205 @item -freorder-blocks
5206 @opindex freorder-blocks
5207 Reorder basic blocks in the compiled function in order to reduce number of
5208 taken branches and improve code locality.
5210 Enabled at levels @option{-O2}, @option{-O3}.
5212 @item -freorder-blocks-and-partition
5213 @opindex freorder-blocks-and-partition
5214 In addition to reordering basic blocks in the compiled function, in order
5215 to reduce number of taken branches, partitions hot and cold basic blocks
5216 into separate sections of the assembly and .o files, to improve
5217 paging and cache locality performance.
5219 This optimization is automatically turned off in the presence of
5220 exception handling, for linkonce sections, for functions with a user-defined
5221 section attribute and on any architecture that does not support named
5222 sections.
5224 @item -freorder-functions
5225 @opindex freorder-functions
5226 Reorder functions in the object file in order to
5227 improve code locality.  This is implemented by using special
5228 subsections @code{.text.hot} for most frequently executed functions and
5229 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5230 the linker so object file format must support named sections and linker must
5231 place them in a reasonable way.
5233 Also profile feedback must be available in to make this option effective.  See
5234 @option{-fprofile-arcs} for details.
5236 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5238 @item -fstrict-aliasing
5239 @opindex fstrict-aliasing
5240 Allows the compiler to assume the strictest aliasing rules applicable to
5241 the language being compiled.  For C (and C++), this activates
5242 optimizations based on the type of expressions.  In particular, an
5243 object of one type is assumed never to reside at the same address as an
5244 object of a different type, unless the types are almost the same.  For
5245 example, an @code{unsigned int} can alias an @code{int}, but not a
5246 @code{void*} or a @code{double}.  A character type may alias any other
5247 type.
5249 Pay special attention to code like this:
5250 @smallexample
5251 union a_union @{
5252   int i;
5253   double d;
5256 int f() @{
5257   a_union t;
5258   t.d = 3.0;
5259   return t.i;
5261 @end smallexample
5262 The practice of reading from a different union member than the one most
5263 recently written to (called ``type-punning'') is common.  Even with
5264 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5265 is accessed through the union type.  So, the code above will work as
5266 expected.  However, this code might not:
5267 @smallexample
5268 int f() @{
5269   a_union t;
5270   int* ip;
5271   t.d = 3.0;
5272   ip = &t.i;
5273   return *ip;
5275 @end smallexample
5277 Every language that wishes to perform language-specific alias analysis
5278 should define a function that computes, given an @code{tree}
5279 node, an alias set for the node.  Nodes in different alias sets are not
5280 allowed to alias.  For an example, see the C front-end function
5281 @code{c_get_alias_set}.
5283 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5285 @item -falign-functions
5286 @itemx -falign-functions=@var{n}
5287 @opindex falign-functions
5288 Align the start of functions to the next power-of-two greater than
5289 @var{n}, skipping up to @var{n} bytes.  For instance,
5290 @option{-falign-functions=32} aligns functions to the next 32-byte
5291 boundary, but @option{-falign-functions=24} would align to the next
5292 32-byte boundary only if this can be done by skipping 23 bytes or less.
5294 @option{-fno-align-functions} and @option{-falign-functions=1} are
5295 equivalent and mean that functions will not be aligned.
5297 Some assemblers only support this flag when @var{n} is a power of two;
5298 in that case, it is rounded up.
5300 If @var{n} is not specified or is zero, use a machine-dependent default.
5302 Enabled at levels @option{-O2}, @option{-O3}.
5304 @item -falign-labels
5305 @itemx -falign-labels=@var{n}
5306 @opindex falign-labels
5307 Align all branch targets to a power-of-two boundary, skipping up to
5308 @var{n} bytes like @option{-falign-functions}.  This option can easily
5309 make code slower, because it must insert dummy operations for when the
5310 branch target is reached in the usual flow of the code.
5312 @option{-fno-align-labels} and @option{-falign-labels=1} are
5313 equivalent and mean that labels will not be aligned.
5315 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5316 are greater than this value, then their values are used instead.
5318 If @var{n} is not specified or is zero, use a machine-dependent default
5319 which is very likely to be @samp{1}, meaning no alignment.
5321 Enabled at levels @option{-O2}, @option{-O3}.
5323 @item -falign-loops
5324 @itemx -falign-loops=@var{n}
5325 @opindex falign-loops
5326 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5327 like @option{-falign-functions}.  The hope is that the loop will be
5328 executed many times, which will make up for any execution of the dummy
5329 operations.
5331 @option{-fno-align-loops} and @option{-falign-loops=1} are
5332 equivalent and mean that loops will not be aligned.
5334 If @var{n} is not specified or is zero, use a machine-dependent default.
5336 Enabled at levels @option{-O2}, @option{-O3}.
5338 @item -falign-jumps
5339 @itemx -falign-jumps=@var{n}
5340 @opindex falign-jumps
5341 Align branch targets to a power-of-two boundary, for branch targets
5342 where the targets can only be reached by jumping, skipping up to @var{n}
5343 bytes like @option{-falign-functions}.  In this case, no dummy operations
5344 need be executed.
5346 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5347 equivalent and mean that loops will not be aligned.
5349 If @var{n} is not specified or is zero, use a machine-dependent default.
5351 Enabled at levels @option{-O2}, @option{-O3}.
5353 @item -funit-at-a-time
5354 @opindex funit-at-a-time
5355 Parse the whole compilation unit before starting to produce code.
5356 This allows some extra optimizations to take place but consumes
5357 more memory (in general).  There are some compatibility issues
5358 with @emph{unit-at-a-time} mode:
5359 @itemize @bullet
5360 @item
5361 enabling @emph{unit-at-a-time} mode may change the order
5362 in which functions, variables, and top-level @code{asm} statements
5363 are emitted, and will likely break code relying on some particular
5364 ordering.  The majority of such top-level @code{asm} statements,
5365 though, can be replaced by @code{section} attributes.  The
5366 @option{fno-toplevel-reorder} option may be used to keep the ordering
5367 used in the input file, at the cost of some optimizations.
5369 @item
5370 @emph{unit-at-a-time} mode removes unreferenced static variables
5371 and functions.  This may result in undefined references
5372 when an @code{asm} statement refers directly to variables or functions
5373 that are otherwise unused.  In that case either the variable/function
5374 shall be listed as an operand of the @code{asm} statement operand or,
5375 in the case of top-level @code{asm} statements the attribute @code{used}
5376 shall be used on the declaration.
5378 @item
5379 Static functions now can use non-standard passing conventions that
5380 may break @code{asm} statements calling functions directly.  Again,
5381 attribute @code{used} will prevent this behavior.
5382 @end itemize
5384 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5385 but this scheme may not be supported by future releases of GCC@.
5387 Enabled at levels @option{-O2}, @option{-O3}.
5389 @item -fno-toplevel-reorder
5390 Do not reorder top-level functions, variables, and @code{asm}
5391 statements.  Output them in the same order that they appear in the
5392 input file.  When this option is used, unreferenced static variables
5393 will not be removed.  This option is intended to support existing code
5394 which relies on a particular ordering.  For new code, it is better to
5395 use attributes.
5397 @item -fweb
5398 @opindex fweb
5399 Constructs webs as commonly used for register allocation purposes and assign
5400 each web individual pseudo register.  This allows the register allocation pass
5401 to operate on pseudos directly, but also strengthens several other optimization
5402 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5403 however, make debugging impossible, since variables will no longer stay in a
5404 ``home register''.
5406 Enabled by default with @option{-funroll-loops}.
5408 @item -fwhole-program
5409 @opindex fwhole-program
5410 Assume that the current compilation unit represents whole program being
5411 compiled.  All public functions and variables with the exception of @code{main}
5412 and those merged by attribute @code{externally_visible} become static functions
5413 and in a affect gets more aggressively optimized by interprocedural optimizers.
5414 While this option is equivalent to proper use of @code{static} keyword for
5415 programs consisting of single file, in combination with option
5416 @option{--combine} this flag can be used to compile most of smaller scale C
5417 programs since the functions and variables become local for the whole combined
5418 compilation unit, not for the single source file itself.
5421 @item -fno-cprop-registers
5422 @opindex fno-cprop-registers
5423 After register allocation and post-register allocation instruction splitting,
5424 we perform a copy-propagation pass to try to reduce scheduling dependencies
5425 and occasionally eliminate the copy.
5427 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5429 @item -fprofile-generate
5430 @opindex fprofile-generate
5432 Enable options usually used for instrumenting application to produce
5433 profile useful for later recompilation with profile feedback based
5434 optimization.  You must use @option{-fprofile-generate} both when
5435 compiling and when linking your program.
5437 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5439 @item -fprofile-use
5440 @opindex fprofile-use
5441 Enable profile feedback directed optimizations, and optimizations
5442 generally profitable only with profile feedback available.
5444 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5445 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5447 @end table
5449 The following options control compiler behavior regarding floating
5450 point arithmetic.  These options trade off between speed and
5451 correctness.  All must be specifically enabled.
5453 @table @gcctabopt
5454 @item -ffloat-store
5455 @opindex ffloat-store
5456 Do not store floating point variables in registers, and inhibit other
5457 options that might change whether a floating point value is taken from a
5458 register or memory.
5460 @cindex floating point precision
5461 This option prevents undesirable excess precision on machines such as
5462 the 68000 where the floating registers (of the 68881) keep more
5463 precision than a @code{double} is supposed to have.  Similarly for the
5464 x86 architecture.  For most programs, the excess precision does only
5465 good, but a few programs rely on the precise definition of IEEE floating
5466 point.  Use @option{-ffloat-store} for such programs, after modifying
5467 them to store all pertinent intermediate computations into variables.
5469 @item -ffast-math
5470 @opindex ffast-math
5471 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5472 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5473 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5474 and @option{fcx-limited-range}.
5476 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5478 This option should never be turned on by any @option{-O} option since
5479 it can result in incorrect output for programs which depend on
5480 an exact implementation of IEEE or ISO rules/specifications for
5481 math functions.
5483 @item -fno-math-errno
5484 @opindex fno-math-errno
5485 Do not set ERRNO after calling math functions that are executed
5486 with a single instruction, e.g., sqrt.  A program that relies on
5487 IEEE exceptions for math error handling may want to use this flag
5488 for speed while maintaining IEEE arithmetic compatibility.
5490 This option should never be turned on by any @option{-O} option since
5491 it can result in incorrect output for programs which depend on
5492 an exact implementation of IEEE or ISO rules/specifications for
5493 math functions.
5495 The default is @option{-fmath-errno}.
5497 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5498 no reason for the compiler to consider the possibility that it might,
5499 and @option{-fno-math-errno} is the default.
5501 @item -funsafe-math-optimizations
5502 @opindex funsafe-math-optimizations
5503 Allow optimizations for floating-point arithmetic that (a) assume
5504 that arguments and results are valid and (b) may violate IEEE or
5505 ANSI standards.  When used at link-time, it may include libraries
5506 or startup files that change the default FPU control word or other
5507 similar optimizations.
5509 This option should never be turned on by any @option{-O} option since
5510 it can result in incorrect output for programs which depend on
5511 an exact implementation of IEEE or ISO rules/specifications for
5512 math functions.
5514 The default is @option{-fno-unsafe-math-optimizations}.
5516 @item -ffinite-math-only
5517 @opindex ffinite-math-only
5518 Allow optimizations for floating-point arithmetic that assume
5519 that arguments and results are not NaNs or +-Infs.
5521 This option should never be turned on by any @option{-O} option since
5522 it can result in incorrect output for programs which depend on
5523 an exact implementation of IEEE or ISO rules/specifications.
5525 The default is @option{-fno-finite-math-only}.
5527 @item -fno-trapping-math
5528 @opindex fno-trapping-math
5529 Compile code assuming that floating-point operations cannot generate
5530 user-visible traps.  These traps include division by zero, overflow,
5531 underflow, inexact result and invalid operation.  This option implies
5532 @option{-fno-signaling-nans}.  Setting this option may allow faster
5533 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5535 This option should never be turned on by any @option{-O} option since
5536 it can result in incorrect output for programs which depend on
5537 an exact implementation of IEEE or ISO rules/specifications for
5538 math functions.
5540 The default is @option{-ftrapping-math}.
5542 @item -frounding-math
5543 @opindex frounding-math
5544 Disable transformations and optimizations that assume default floating
5545 point rounding behavior.  This is round-to-zero for all floating point
5546 to integer conversions, and round-to-nearest for all other arithmetic
5547 truncations.  This option should be specified for programs that change
5548 the FP rounding mode dynamically, or that may be executed with a
5549 non-default rounding mode.  This option disables constant folding of
5550 floating point expressions at compile-time (which may be affected by
5551 rounding mode) and arithmetic transformations that are unsafe in the
5552 presence of sign-dependent rounding modes.
5554 The default is @option{-fno-rounding-math}.
5556 This option is experimental and does not currently guarantee to
5557 disable all GCC optimizations that are affected by rounding mode.
5558 Future versions of GCC may provide finer control of this setting
5559 using C99's @code{FENV_ACCESS} pragma.  This command line option
5560 will be used to specify the default state for @code{FENV_ACCESS}.
5562 @item -frtl-abstract-sequences
5563 @opindex frtl-abstract-sequences
5564 It is a size optimization method. This option is to find identical
5565 sequences of code, which can be turned into pseudo-procedures  and
5566 then  replace  all  occurrences with  calls to  the  newly created
5567 subroutine. It is kind of an opposite of @option{-finline-functions}.
5568 This optimization runs at RTL level.
5570 @item -fsignaling-nans
5571 @opindex fsignaling-nans
5572 Compile code assuming that IEEE signaling NaNs may generate user-visible
5573 traps during floating-point operations.  Setting this option disables
5574 optimizations that may change the number of exceptions visible with
5575 signaling NaNs.  This option implies @option{-ftrapping-math}.
5577 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5578 be defined.
5580 The default is @option{-fno-signaling-nans}.
5582 This option is experimental and does not currently guarantee to
5583 disable all GCC optimizations that affect signaling NaN behavior.
5585 @item -fsingle-precision-constant
5586 @opindex fsingle-precision-constant
5587 Treat floating point constant as single precision constant instead of
5588 implicitly converting it to double precision constant.
5590 @item -fcx-limited-range
5591 @itemx -fno-cx-limited-range
5592 @opindex fcx-limited-range
5593 @opindex fno-cx-limited-range
5594 When enabled, this option states that a range reduction step is not
5595 needed when performing complex division.  The default is
5596 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5598 This option controls the default setting of the ISO C99 
5599 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5600 all languages.
5602 @end table
5604 The following options control optimizations that may improve
5605 performance, but are not enabled by any @option{-O} options.  This
5606 section includes experimental options that may produce broken code.
5608 @table @gcctabopt
5609 @item -fbranch-probabilities
5610 @opindex fbranch-probabilities
5611 After running a program compiled with @option{-fprofile-arcs}
5612 (@pxref{Debugging Options,, Options for Debugging Your Program or
5613 @command{gcc}}), you can compile it a second time using
5614 @option{-fbranch-probabilities}, to improve optimizations based on
5615 the number of times each branch was taken.  When the program
5616 compiled with @option{-fprofile-arcs} exits it saves arc execution
5617 counts to a file called @file{@var{sourcename}.gcda} for each source
5618 file  The information in this data file is very dependent on the
5619 structure of the generated code, so you must use the same source code
5620 and the same optimization options for both compilations.
5622 With @option{-fbranch-probabilities}, GCC puts a
5623 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5624 These can be used to improve optimization.  Currently, they are only
5625 used in one place: in @file{reorg.c}, instead of guessing which path a
5626 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5627 exactly determine which path is taken more often.
5629 @item -fprofile-values
5630 @opindex fprofile-values
5631 If combined with @option{-fprofile-arcs}, it adds code so that some
5632 data about values of expressions in the program is gathered.
5634 With @option{-fbranch-probabilities}, it reads back the data gathered
5635 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5636 notes to instructions for their later usage in optimizations.
5638 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5640 @item -fvpt
5641 @opindex fvpt
5642 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5643 a code to gather information about values of expressions.
5645 With @option{-fbranch-probabilities}, it reads back the data gathered
5646 and actually performs the optimizations based on them.
5647 Currently the optimizations include specialization of division operation
5648 using the knowledge about the value of the denominator.
5650 @item -frename-registers
5651 @opindex frename-registers
5652 Attempt to avoid false dependencies in scheduled code by making use
5653 of registers left over after register allocation.  This optimization
5654 will most benefit processors with lots of registers.  Depending on the
5655 debug information format adopted by the target, however, it can
5656 make debugging impossible, since variables will no longer stay in
5657 a ``home register''.
5659 Enabled by default with @option{-funroll-loops}.
5661 @item -ftracer
5662 @opindex ftracer
5663 Perform tail duplication to enlarge superblock size.  This transformation
5664 simplifies the control flow of the function allowing other optimizations to do
5665 better job.
5667 Enabled with @option{-fprofile-use}.
5669 @item -funroll-loops
5670 @opindex funroll-loops
5671 Unroll loops whose number of iterations can be determined at compile time or
5672 upon entry to the loop.  @option{-funroll-loops} implies
5673 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5674 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5675 small constant number of iterations).  This option makes code larger, and may
5676 or may not make it run faster.
5678 Enabled with @option{-fprofile-use}.
5680 @item -funroll-all-loops
5681 @opindex funroll-all-loops
5682 Unroll all loops, even if their number of iterations is uncertain when
5683 the loop is entered.  This usually makes programs run more slowly.
5684 @option{-funroll-all-loops} implies the same options as
5685 @option{-funroll-loops}.
5687 @item -fpeel-loops
5688 @opindex fpeel-loops
5689 Peels the loops for that there is enough information that they do not
5690 roll much (from profile feedback).  It also turns on complete loop peeling
5691 (i.e.@: complete removal of loops with small constant number of iterations).
5693 Enabled with @option{-fprofile-use}.
5695 @item -fmove-loop-invariants
5696 @opindex fmove-loop-invariants
5697 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
5698 at level @option{-O1}
5700 @item -funswitch-loops
5701 @opindex funswitch-loops
5702 Move branches with loop invariant conditions out of the loop, with duplicates
5703 of the loop on both branches (modified according to result of the condition).
5705 @item -ffunction-sections
5706 @itemx -fdata-sections
5707 @opindex ffunction-sections
5708 @opindex fdata-sections
5709 Place each function or data item into its own section in the output
5710 file if the target supports arbitrary sections.  The name of the
5711 function or the name of the data item determines the section's name
5712 in the output file.
5714 Use these options on systems where the linker can perform optimizations
5715 to improve locality of reference in the instruction space.  Most systems
5716 using the ELF object format and SPARC processors running Solaris 2 have
5717 linkers with such optimizations.  AIX may have these optimizations in
5718 the future.
5720 Only use these options when there are significant benefits from doing
5721 so.  When you specify these options, the assembler and linker will
5722 create larger object and executable files and will also be slower.
5723 You will not be able to use @code{gprof} on all systems if you
5724 specify this option and you may have problems with debugging if
5725 you specify both this option and @option{-g}.
5727 @item -fbranch-target-load-optimize
5728 @opindex fbranch-target-load-optimize
5729 Perform branch target register load optimization before prologue / epilogue
5730 threading.
5731 The use of target registers can typically be exposed only during reload,
5732 thus hoisting loads out of loops and doing inter-block scheduling needs
5733 a separate optimization pass.
5735 @item -fbranch-target-load-optimize2
5736 @opindex fbranch-target-load-optimize2
5737 Perform branch target register load optimization after prologue / epilogue
5738 threading.
5740 @item -fbtr-bb-exclusive
5741 @opindex fbtr-bb-exclusive
5742 When performing branch target register load optimization, don't reuse
5743 branch target registers in within any basic block.
5745 @item -fstack-protector
5746 Emit extra code to check for buffer overflows, such as stack smashing
5747 attacks.  This is done by adding a guard variable to functions with
5748 vulnerable objects.  This includes functions that call alloca, and
5749 functions with buffers larger than 8 bytes.  The guards are initialized
5750 when a function is entered and then checked when the function exits.
5751 If a guard check fails, an error message is printed and the program exits.
5753 @item -fstack-protector-all
5754 Like @option{-fstack-protector} except that all functions are protected.
5756 @item -fsection-anchors
5757 @opindex fsection-anchors
5758 Try to reduce the number of symbolic address calculations by using
5759 shared ``anchor'' symbols to address nearby objects.  This transformation
5760 can help to reduce the number of GOT entries and GOT accesses on some
5761 targets.
5763 For example, the implementation of the following function @code{foo}:
5765 @smallexample
5766 static int a, b, c;
5767 int foo (void) @{ return a + b + c; @}
5768 @end smallexample
5770 would usually calculate the addresses of all three variables, but if you
5771 compile it with @option{-fsection-anchors}, it will access the variables
5772 from a common anchor point instead.  The effect is similar to the
5773 following pseudocode (which isn't valid C):
5775 @smallexample
5776 int foo (void)
5778   register int *xr = &x;
5779   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
5781 @end smallexample
5783 Not all targets support this option.
5785 @item --param @var{name}=@var{value}
5786 @opindex param
5787 In some places, GCC uses various constants to control the amount of
5788 optimization that is done.  For example, GCC will not inline functions
5789 that contain more that a certain number of instructions.  You can
5790 control some of these constants on the command-line using the
5791 @option{--param} option.
5793 The names of specific parameters, and the meaning of the values, are
5794 tied to the internals of the compiler, and are subject to change
5795 without notice in future releases.
5797 In each case, the @var{value} is an integer.  The allowable choices for
5798 @var{name} are given in the following table:
5800 @table @gcctabopt
5801 @item salias-max-implicit-fields
5802 The maximum number of fields in a variable without direct
5803 structure accesses for which structure aliasing will consider trying 
5804 to track each field.  The default is 5
5806 @item salias-max-array-elements
5807 The maximum number of elements an array can have and its elements
5808 still be tracked individually by structure aliasing. The default is 4
5810 @item sra-max-structure-size
5811 The maximum structure size, in bytes, at which the scalar replacement
5812 of aggregates (SRA) optimization will perform block copies.  The
5813 default value, 0, implies that GCC will select the most appropriate
5814 size itself.
5816 @item sra-field-structure-ratio
5817 The threshold ratio (as a percentage) between instantiated fields and
5818 the complete structure size.  We say that if the ratio of the number
5819 of bytes in instantiated fields to the number of bytes in the complete
5820 structure exceeds this parameter, then block copies are not used.  The
5821 default is 75.
5823 @item max-crossjump-edges
5824 The maximum number of incoming edges to consider for crossjumping.
5825 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5826 the number of edges incoming to each block.  Increasing values mean
5827 more aggressive optimization, making the compile time increase with
5828 probably small improvement in executable size.
5830 @item min-crossjump-insns
5831 The minimum number of instructions which must be matched at the end
5832 of two blocks before crossjumping will be performed on them.  This
5833 value is ignored in the case where all instructions in the block being
5834 crossjumped from are matched.  The default value is 5.
5836 @item max-grow-copy-bb-insns
5837 The maximum code size expansion factor when copying basic blocks
5838 instead of jumping.  The expansion is relative to a jump instruction.
5839 The default value is 8.
5841 @item max-goto-duplication-insns
5842 The maximum number of instructions to duplicate to a block that jumps
5843 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5844 passes, GCC factors computed gotos early in the compilation process,
5845 and unfactors them as late as possible.  Only computed jumps at the
5846 end of a basic blocks with no more than max-goto-duplication-insns are
5847 unfactored.  The default value is 8.
5849 @item max-delay-slot-insn-search
5850 The maximum number of instructions to consider when looking for an
5851 instruction to fill a delay slot.  If more than this arbitrary number of
5852 instructions is searched, the time savings from filling the delay slot
5853 will be minimal so stop searching.  Increasing values mean more
5854 aggressive optimization, making the compile time increase with probably
5855 small improvement in executable run time.
5857 @item max-delay-slot-live-search
5858 When trying to fill delay slots, the maximum number of instructions to
5859 consider when searching for a block with valid live register
5860 information.  Increasing this arbitrarily chosen value means more
5861 aggressive optimization, increasing the compile time.  This parameter
5862 should be removed when the delay slot code is rewritten to maintain the
5863 control-flow graph.
5865 @item max-gcse-memory
5866 The approximate maximum amount of memory that will be allocated in
5867 order to perform the global common subexpression elimination
5868 optimization.  If more memory than specified is required, the
5869 optimization will not be done.
5871 @item max-gcse-passes
5872 The maximum number of passes of GCSE to run.  The default is 1.
5874 @item max-pending-list-length
5875 The maximum number of pending dependencies scheduling will allow
5876 before flushing the current state and starting over.  Large functions
5877 with few branches or calls can create excessively large lists which
5878 needlessly consume memory and resources.
5880 @item max-inline-insns-single
5881 Several parameters control the tree inliner used in gcc.
5882 This number sets the maximum number of instructions (counted in GCC's
5883 internal representation) in a single function that the tree inliner
5884 will consider for inlining.  This only affects functions declared
5885 inline and methods implemented in a class declaration (C++).
5886 The default value is 450.
5888 @item max-inline-insns-auto
5889 When you use @option{-finline-functions} (included in @option{-O3}),
5890 a lot of functions that would otherwise not be considered for inlining
5891 by the compiler will be investigated.  To those functions, a different
5892 (more restrictive) limit compared to functions declared inline can
5893 be applied.
5894 The default value is 90.
5896 @item large-function-insns
5897 The limit specifying really large functions.  For functions larger than this
5898 limit after inlining inlining is constrained by
5899 @option{--param large-function-growth}.  This parameter is useful primarily
5900 to avoid extreme compilation time caused by non-linear algorithms used by the
5901 backend.
5902 This parameter is ignored when @option{-funit-at-a-time} is not used.
5903 The default value is 2700.
5905 @item large-function-growth
5906 Specifies maximal growth of large function caused by inlining in percents.
5907 This parameter is ignored when @option{-funit-at-a-time} is not used.
5908 The default value is 100 which limits large function growth to 2.0 times
5909 the original size.
5911 @item large-unit-insns
5912 The limit specifying large translation unit.  Growth caused by inlining of
5913 units larger than this limit is limited by @option{--param inline-unit-growth}.
5914 For small units this might be too tight (consider unit consisting of function A
5915 that is inline and B that just calls A three time.  If B is small relative to
5916 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
5917 large units consisting of small inlininable functions however the overall unit
5918 growth limit is needed to avoid exponential explosion of code size.  Thus for
5919 smaller units, the size is increased to @option{--param large-unit-insns}
5920 before applying @option{--param inline-unit-growth}.  The default is 10000
5922 @item inline-unit-growth
5923 Specifies maximal overall growth of the compilation unit caused by inlining.
5924 This parameter is ignored when @option{-funit-at-a-time} is not used.
5925 The default value is 50 which limits unit growth to 1.5 times the original
5926 size.
5928 @item max-inline-insns-recursive
5929 @itemx max-inline-insns-recursive-auto
5930 Specifies maximum number of instructions out-of-line copy of self recursive inline
5931 function can grow into by performing recursive inlining.
5933 For functions declared inline @option{--param max-inline-insns-recursive} is
5934 taken into acount.  For function not declared inline, recursive inlining
5935 happens only when @option{-finline-functions} (included in @option{-O3}) is
5936 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5937 default value is 450.
5939 @item max-inline-recursive-depth
5940 @itemx max-inline-recursive-depth-auto
5941 Specifies maximum recursion depth used by the recursive inlining.
5943 For functions declared inline @option{--param max-inline-recursive-depth} is
5944 taken into acount.  For function not declared inline, recursive inlining
5945 happens only when @option{-finline-functions} (included in @option{-O3}) is
5946 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5947 default value is 450.
5949 @item min-inline-recursive-probability
5950 Recursive inlining is profitable only for function having deep recursion
5951 in average and can hurt for function having little recursion depth by
5952 increasing the prologue size or complexity of function body to other
5953 optimizers.
5955 When profile feedback is available (see @option{-fprofile-generate}) the actual
5956 recursion depth can be guessed from probability that function will recurse via
5957 given call expression.  This parameter limits inlining only to call expression
5958 whose probability exceeds given threshold (in percents).  The default value is
5961 @item inline-call-cost
5962 Specify cost of call instruction relative to simple arithmetics operations
5963 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5964 functions and at the same time increases size of leaf function that is believed to
5965 reduce function size by being inlined.  In effect it increases amount of
5966 inlining for code having large abstraction penalty (many functions that just
5967 pass the arguments to other functions) and decrease inlining for code with low
5968 abstraction penalty.  The default value is 16.
5970 @item max-unrolled-insns
5971 The maximum number of instructions that a loop should have if that loop
5972 is unrolled, and if the loop is unrolled, it determines how many times
5973 the loop code is unrolled.
5975 @item max-average-unrolled-insns
5976 The maximum number of instructions biased by probabilities of their execution
5977 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5978 it determines how many times the loop code is unrolled.
5980 @item max-unroll-times
5981 The maximum number of unrollings of a single loop.
5983 @item max-peeled-insns
5984 The maximum number of instructions that a loop should have if that loop
5985 is peeled, and if the loop is peeled, it determines how many times
5986 the loop code is peeled.
5988 @item max-peel-times
5989 The maximum number of peelings of a single loop.
5991 @item max-completely-peeled-insns
5992 The maximum number of insns of a completely peeled loop.
5994 @item max-completely-peel-times
5995 The maximum number of iterations of a loop to be suitable for complete peeling.
5997 @item max-unswitch-insns
5998 The maximum number of insns of an unswitched loop.
6000 @item max-unswitch-level
6001 The maximum number of branches unswitched in a single loop.
6003 @item lim-expensive
6004 The minimum cost of an expensive expression in the loop invariant motion.
6006 @item iv-consider-all-candidates-bound
6007 Bound on number of candidates for induction variables below that
6008 all candidates are considered for each use in induction variable
6009 optimizations.  Only the most relevant candidates are considered
6010 if there are more candidates, to avoid quadratic time complexity.
6012 @item iv-max-considered-uses
6013 The induction variable optimizations give up on loops that contain more
6014 induction variable uses.
6016 @item iv-always-prune-cand-set-bound
6017 If number of candidates in the set is smaller than this value,
6018 we always try to remove unnecessary ivs from the set during its
6019 optimization when a new iv is added to the set.
6021 @item scev-max-expr-size
6022 Bound on size of expressions used in the scalar evolutions analyzer.
6023 Large expressions slow the analyzer.
6025 @item vect-max-version-checks
6026 The maximum number of runtime checks that can be performed when doing
6027 loop versioning in the vectorizer.  See option ftree-vect-loop-version
6028 for more information.
6030 @item max-iterations-to-track
6032 The maximum number of iterations of a loop the brute force algorithm
6033 for analysis of # of iterations of the loop tries to evaluate.
6035 @item hot-bb-count-fraction
6036 Select fraction of the maximal count of repetitions of basic block in program
6037 given basic block needs to have to be considered hot.
6039 @item hot-bb-frequency-fraction
6040 Select fraction of the maximal frequency of executions of basic block in
6041 function given basic block needs to have to be considered hot
6043 @item max-predicted-iterations
6044 The maximum number of loop iterations we predict statically.  This is useful
6045 in cases where function contain single loop with known bound and other loop
6046 with unknown.  We predict the known number of iterations correctly, while
6047 the unknown number of iterations average to roughly 10.  This means that the
6048 loop without bounds would appear artificially cold relative to the other one.
6050 @item tracer-dynamic-coverage
6051 @itemx tracer-dynamic-coverage-feedback
6053 This value is used to limit superblock formation once the given percentage of
6054 executed instructions is covered.  This limits unnecessary code size
6055 expansion.
6057 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6058 feedback is available.  The real profiles (as opposed to statically estimated
6059 ones) are much less balanced allowing the threshold to be larger value.
6061 @item tracer-max-code-growth
6062 Stop tail duplication once code growth has reached given percentage.  This is
6063 rather hokey argument, as most of the duplicates will be eliminated later in
6064 cross jumping, so it may be set to much higher values than is the desired code
6065 growth.
6067 @item tracer-min-branch-ratio
6069 Stop reverse growth when the reverse probability of best edge is less than this
6070 threshold (in percent).
6072 @item tracer-min-branch-ratio
6073 @itemx tracer-min-branch-ratio-feedback
6075 Stop forward growth if the best edge do have probability lower than this
6076 threshold.
6078 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6079 compilation for profile feedback and one for compilation without.  The value
6080 for compilation with profile feedback needs to be more conservative (higher) in
6081 order to make tracer effective.
6083 @item max-cse-path-length
6085 Maximum number of basic blocks on path that cse considers.  The default is 10.
6087 @item max-cse-insns
6088 The maximum instructions CSE process before flushing. The default is 1000.
6090 @item global-var-threshold
6092 Counts the number of function calls (@var{n}) and the number of
6093 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
6094 single artificial variable will be created to represent all the
6095 call-clobbered variables at function call sites.  This artificial
6096 variable will then be made to alias every call-clobbered variable.
6097 (done as @code{int * size_t} on the host machine; beware overflow).
6099 @item max-aliased-vops
6101 Maximum number of virtual operands allowed to represent aliases
6102 before triggering the alias grouping heuristic.  Alias grouping
6103 reduces compile times and memory consumption needed for aliasing at
6104 the expense of precision loss in alias information.
6106 @item ggc-min-expand
6108 GCC uses a garbage collector to manage its own memory allocation.  This
6109 parameter specifies the minimum percentage by which the garbage
6110 collector's heap should be allowed to expand between collections.
6111 Tuning this may improve compilation speed; it has no effect on code
6112 generation.
6114 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6115 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
6116 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
6117 GCC is not able to calculate RAM on a particular platform, the lower
6118 bound of 30% is used.  Setting this parameter and
6119 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6120 every opportunity.  This is extremely slow, but can be useful for
6121 debugging.
6123 @item ggc-min-heapsize
6125 Minimum size of the garbage collector's heap before it begins bothering
6126 to collect garbage.  The first collection occurs after the heap expands
6127 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
6128 tuning this may improve compilation speed, and has no effect on code
6129 generation.
6131 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6132 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6133 with a lower bound of 4096 (four megabytes) and an upper bound of
6134 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
6135 particular platform, the lower bound is used.  Setting this parameter
6136 very large effectively disables garbage collection.  Setting this
6137 parameter and @option{ggc-min-expand} to zero causes a full collection
6138 to occur at every opportunity.
6140 @item max-reload-search-insns
6141 The maximum number of instruction reload should look backward for equivalent
6142 register.  Increasing values mean more aggressive optimization, making the
6143 compile time increase with probably slightly better performance.  The default
6144 value is 100.
6146 @item max-cselib-memory-location
6147 The maximum number of memory locations cselib should take into acount.
6148 Increasing values mean more aggressive optimization, making the compile time
6149 increase with probably slightly better performance.  The default value is 500.
6151 @item max-flow-memory-location
6152 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6153 The default value is 100.
6155 @item reorder-blocks-duplicate
6156 @itemx reorder-blocks-duplicate-feedback
6158 Used by basic block reordering pass to decide whether to use unconditional
6159 branch or duplicate the code on its destination.  Code is duplicated when its
6160 estimated size is smaller than this value multiplied by the estimated size of
6161 unconditional jump in the hot spots of the program.
6163 The @option{reorder-block-duplicate-feedback} is used only when profile
6164 feedback is available and may be set to higher values than
6165 @option{reorder-block-duplicate} since information about the hot spots is more
6166 accurate.
6168 @item max-sched-region-blocks
6169 The maximum number of blocks in a region to be considered for
6170 interblock scheduling.  The default value is 10.
6172 @item max-sched-region-insns
6173 The maximum number of insns in a region to be considered for
6174 interblock scheduling.  The default value is 100.
6176 @item min-spec-prob
6177 The minimum probability (in percents) of reaching a source block
6178 for interblock speculative scheduling.  The default value is 40.
6180 @item max-last-value-rtl
6182 The maximum size measured as number of RTLs that can be recorded in an expression
6183 in combiner for a pseudo register as last known value of that register.  The default
6184 is 10000.
6186 @item integer-share-limit
6187 Small integer constants can use a shared data structure, reducing the
6188 compiler's memory usage and increasing its speed.  This sets the maximum
6189 value of a shared integer constant's.  The default value is 256.
6191 @item min-virtual-mappings
6192 Specifies the minimum number of virtual mappings in the incremental
6193 SSA updater that should be registered to trigger the virtual mappings
6194 heuristic defined by virtual-mappings-ratio.  The default value is
6195 100.
6197 @item virtual-mappings-ratio
6198 If the number of virtual mappings is virtual-mappings-ratio bigger
6199 than the number of virtual symbols to be updated, then the incremental
6200 SSA updater switches to a full update for those symbols.  The default
6201 ratio is 3.
6203 @item ssp-buffer-size
6204 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6205 protection when @option{-fstack-protection} is used.
6207 @item max-jump-thread-duplication-stmts
6208 Maximum number of statements allowed in a block that needs to be
6209 duplicated when threading jumps.
6211 @item max-fields-for-field-sensitive
6212 Maximum number of fields in a structure we will treat in
6213 a field sensitive manner during pointer analysis.
6215 @end table
6216 @end table
6218 @node Preprocessor Options
6219 @section Options Controlling the Preprocessor
6220 @cindex preprocessor options
6221 @cindex options, preprocessor
6223 These options control the C preprocessor, which is run on each C source
6224 file before actual compilation.
6226 If you use the @option{-E} option, nothing is done except preprocessing.
6227 Some of these options make sense only together with @option{-E} because
6228 they cause the preprocessor output to be unsuitable for actual
6229 compilation.
6231 @table @gcctabopt
6232 @opindex Wp
6233 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6234 and pass @var{option} directly through to the preprocessor.  If
6235 @var{option} contains commas, it is split into multiple options at the
6236 commas.  However, many options are modified, translated or interpreted
6237 by the compiler driver before being passed to the preprocessor, and
6238 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6239 interface is undocumented and subject to change, so whenever possible
6240 you should avoid using @option{-Wp} and let the driver handle the
6241 options instead.
6243 @item -Xpreprocessor @var{option}
6244 @opindex preprocessor
6245 Pass @var{option} as an option to the preprocessor.  You can use this to
6246 supply system-specific preprocessor options which GCC does not know how to
6247 recognize.
6249 If you want to pass an option that takes an argument, you must use
6250 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6251 @end table
6253 @include cppopts.texi
6255 @node Assembler Options
6256 @section Passing Options to the Assembler
6258 @c prevent bad page break with this line
6259 You can pass options to the assembler.
6261 @table @gcctabopt
6262 @item -Wa,@var{option}
6263 @opindex Wa
6264 Pass @var{option} as an option to the assembler.  If @var{option}
6265 contains commas, it is split into multiple options at the commas.
6267 @item -Xassembler @var{option}
6268 @opindex Xassembler
6269 Pass @var{option} as an option to the assembler.  You can use this to
6270 supply system-specific assembler options which GCC does not know how to
6271 recognize.
6273 If you want to pass an option that takes an argument, you must use
6274 @option{-Xassembler} twice, once for the option and once for the argument.
6276 @end table
6278 @node Link Options
6279 @section Options for Linking
6280 @cindex link options
6281 @cindex options, linking
6283 These options come into play when the compiler links object files into
6284 an executable output file.  They are meaningless if the compiler is
6285 not doing a link step.
6287 @table @gcctabopt
6288 @cindex file names
6289 @item @var{object-file-name}
6290 A file name that does not end in a special recognized suffix is
6291 considered to name an object file or library.  (Object files are
6292 distinguished from libraries by the linker according to the file
6293 contents.)  If linking is done, these object files are used as input
6294 to the linker.
6296 @item -c
6297 @itemx -S
6298 @itemx -E
6299 @opindex c
6300 @opindex S
6301 @opindex E
6302 If any of these options is used, then the linker is not run, and
6303 object file names should not be used as arguments.  @xref{Overall
6304 Options}.
6306 @cindex Libraries
6307 @item -l@var{library}
6308 @itemx -l @var{library}
6309 @opindex l
6310 Search the library named @var{library} when linking.  (The second
6311 alternative with the library as a separate argument is only for
6312 POSIX compliance and is not recommended.)
6314 It makes a difference where in the command you write this option; the
6315 linker searches and processes libraries and object files in the order they
6316 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6317 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6318 to functions in @samp{z}, those functions may not be loaded.
6320 The linker searches a standard list of directories for the library,
6321 which is actually a file named @file{lib@var{library}.a}.  The linker
6322 then uses this file as if it had been specified precisely by name.
6324 The directories searched include several standard system directories
6325 plus any that you specify with @option{-L}.
6327 Normally the files found this way are library files---archive files
6328 whose members are object files.  The linker handles an archive file by
6329 scanning through it for members which define symbols that have so far
6330 been referenced but not defined.  But if the file that is found is an
6331 ordinary object file, it is linked in the usual fashion.  The only
6332 difference between using an @option{-l} option and specifying a file name
6333 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6334 and searches several directories.
6336 @item -lobjc
6337 @opindex lobjc
6338 You need this special case of the @option{-l} option in order to
6339 link an Objective-C or Objective-C++ program.
6341 @item -nostartfiles
6342 @opindex nostartfiles
6343 Do not use the standard system startup files when linking.
6344 The standard system libraries are used normally, unless @option{-nostdlib}
6345 or @option{-nodefaultlibs} is used.
6347 @item -nodefaultlibs
6348 @opindex nodefaultlibs
6349 Do not use the standard system libraries when linking.
6350 Only the libraries you specify will be passed to the linker.
6351 The standard startup files are used normally, unless @option{-nostartfiles}
6352 is used.  The compiler may generate calls to @code{memcmp},
6353 @code{memset}, @code{memcpy} and @code{memmove}.
6354 These entries are usually resolved by entries in
6355 libc.  These entry points should be supplied through some other
6356 mechanism when this option is specified.
6358 @item -nostdlib
6359 @opindex nostdlib
6360 Do not use the standard system startup files or libraries when linking.
6361 No startup files and only the libraries you specify will be passed to
6362 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6363 @code{memcpy} and @code{memmove}.
6364 These entries are usually resolved by entries in
6365 libc.  These entry points should be supplied through some other
6366 mechanism when this option is specified.
6368 @cindex @option{-lgcc}, use with @option{-nostdlib}
6369 @cindex @option{-nostdlib} and unresolved references
6370 @cindex unresolved references and @option{-nostdlib}
6371 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6372 @cindex @option{-nodefaultlibs} and unresolved references
6373 @cindex unresolved references and @option{-nodefaultlibs}
6374 One of the standard libraries bypassed by @option{-nostdlib} and
6375 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6376 that GCC uses to overcome shortcomings of particular machines, or special
6377 needs for some languages.
6378 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6379 Collection (GCC) Internals},
6380 for more discussion of @file{libgcc.a}.)
6381 In most cases, you need @file{libgcc.a} even when you want to avoid
6382 other standard libraries.  In other words, when you specify @option{-nostdlib}
6383 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6384 This ensures that you have no unresolved references to internal GCC
6385 library subroutines.  (For example, @samp{__main}, used to ensure C++
6386 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6387 GNU Compiler Collection (GCC) Internals}.)
6389 @item -pie
6390 @opindex pie
6391 Produce a position independent executable on targets which support it.
6392 For predictable results, you must also specify the same set of options
6393 that were used to generate code (@option{-fpie}, @option{-fPIE},
6394 or model suboptions) when you specify this option.
6396 @item -rdynamic
6397 @opindex rdynamic
6398 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6399 that support it. This instructs the linker to add all symbols, not
6400 only used ones, to the dynamic symbol table. This option is needed
6401 for some uses of @code{dlopen} or to allow obtaining backtraces
6402 from within a program.
6404 @item -s
6405 @opindex s
6406 Remove all symbol table and relocation information from the executable.
6408 @item -static
6409 @opindex static
6410 On systems that support dynamic linking, this prevents linking with the shared
6411 libraries.  On other systems, this option has no effect.
6413 @item -shared
6414 @opindex shared
6415 Produce a shared object which can then be linked with other objects to
6416 form an executable.  Not all systems support this option.  For predictable
6417 results, you must also specify the same set of options that were used to
6418 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6419 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6420 needs to build supplementary stub code for constructors to work.  On
6421 multi-libbed systems, @samp{gcc -shared} must select the correct support
6422 libraries to link against.  Failing to supply the correct flags may lead
6423 to subtle defects.  Supplying them in cases where they are not necessary
6424 is innocuous.}
6426 @item -shared-libgcc
6427 @itemx -static-libgcc
6428 @opindex shared-libgcc
6429 @opindex static-libgcc
6430 On systems that provide @file{libgcc} as a shared library, these options
6431 force the use of either the shared or static version respectively.
6432 If no shared version of @file{libgcc} was built when the compiler was
6433 configured, these options have no effect.
6435 There are several situations in which an application should use the
6436 shared @file{libgcc} instead of the static version.  The most common
6437 of these is when the application wishes to throw and catch exceptions
6438 across different shared libraries.  In that case, each of the libraries
6439 as well as the application itself should use the shared @file{libgcc}.
6441 Therefore, the G++ and GCJ drivers automatically add
6442 @option{-shared-libgcc} whenever you build a shared library or a main
6443 executable, because C++ and Java programs typically use exceptions, so
6444 this is the right thing to do.
6446 If, instead, you use the GCC driver to create shared libraries, you may
6447 find that they will not always be linked with the shared @file{libgcc}.
6448 If GCC finds, at its configuration time, that you have a non-GNU linker
6449 or a GNU linker that does not support option @option{--eh-frame-hdr},
6450 it will link the shared version of @file{libgcc} into shared libraries
6451 by default.  Otherwise, it will take advantage of the linker and optimize
6452 away the linking with the shared version of @file{libgcc}, linking with
6453 the static version of libgcc by default.  This allows exceptions to
6454 propagate through such shared libraries, without incurring relocation
6455 costs at library load time.
6457 However, if a library or main executable is supposed to throw or catch
6458 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6459 for the languages used in the program, or using the option
6460 @option{-shared-libgcc}, such that it is linked with the shared
6461 @file{libgcc}.
6463 @item -symbolic
6464 @opindex symbolic
6465 Bind references to global symbols when building a shared object.  Warn
6466 about any unresolved references (unless overridden by the link editor
6467 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6468 this option.
6470 @item -Xlinker @var{option}
6471 @opindex Xlinker
6472 Pass @var{option} as an option to the linker.  You can use this to
6473 supply system-specific linker options which GCC does not know how to
6474 recognize.
6476 If you want to pass an option that takes an argument, you must use
6477 @option{-Xlinker} twice, once for the option and once for the argument.
6478 For example, to pass @option{-assert definitions}, you must write
6479 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6480 @option{-Xlinker "-assert definitions"}, because this passes the entire
6481 string as a single argument, which is not what the linker expects.
6483 @item -Wl,@var{option}
6484 @opindex Wl
6485 Pass @var{option} as an option to the linker.  If @var{option} contains
6486 commas, it is split into multiple options at the commas.
6488 @item -u @var{symbol}
6489 @opindex u
6490 Pretend the symbol @var{symbol} is undefined, to force linking of
6491 library modules to define it.  You can use @option{-u} multiple times with
6492 different symbols to force loading of additional library modules.
6493 @end table
6495 @node Directory Options
6496 @section Options for Directory Search
6497 @cindex directory options
6498 @cindex options, directory search
6499 @cindex search path
6501 These options specify directories to search for header files, for
6502 libraries and for parts of the compiler:
6504 @table @gcctabopt
6505 @item -I@var{dir}
6506 @opindex I
6507 Add the directory @var{dir} to the head of the list of directories to be
6508 searched for header files.  This can be used to override a system header
6509 file, substituting your own version, since these directories are
6510 searched before the system header file directories.  However, you should
6511 not use this option to add directories that contain vendor-supplied
6512 system header files (use @option{-isystem} for that).  If you use more than
6513 one @option{-I} option, the directories are scanned in left-to-right
6514 order; the standard system directories come after.
6516 If a standard system include directory, or a directory specified with
6517 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6518 option will be ignored.  The directory will still be searched but as a
6519 system directory at its normal position in the system include chain.
6520 This is to ensure that GCC's procedure to fix buggy system headers and
6521 the ordering for the include_next directive are not inadvertently changed.
6522 If you really need to change the search order for system directories,
6523 use the @option{-nostdinc} and/or @option{-isystem} options.
6525 @item -iquote@var{dir}
6526 @opindex iquote
6527 Add the directory @var{dir} to the head of the list of directories to
6528 be searched for header files only for the case of @samp{#include
6529 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6530 otherwise just like @option{-I}.
6532 @item -L@var{dir}
6533 @opindex L
6534 Add directory @var{dir} to the list of directories to be searched
6535 for @option{-l}.
6537 @item -B@var{prefix}
6538 @opindex B
6539 This option specifies where to find the executables, libraries,
6540 include files, and data files of the compiler itself.
6542 The compiler driver program runs one or more of the subprograms
6543 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6544 @var{prefix} as a prefix for each program it tries to run, both with and
6545 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6547 For each subprogram to be run, the compiler driver first tries the
6548 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6549 was not specified, the driver tries two standard prefixes, which are
6550 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6551 those results in a file name that is found, the unmodified program
6552 name is searched for using the directories specified in your
6553 @env{PATH} environment variable.
6555 The compiler will check to see if the path provided by the @option{-B}
6556 refers to a directory, and if necessary it will add a directory
6557 separator character at the end of the path.
6559 @option{-B} prefixes that effectively specify directory names also apply
6560 to libraries in the linker, because the compiler translates these
6561 options into @option{-L} options for the linker.  They also apply to
6562 includes files in the preprocessor, because the compiler translates these
6563 options into @option{-isystem} options for the preprocessor.  In this case,
6564 the compiler appends @samp{include} to the prefix.
6566 The run-time support file @file{libgcc.a} can also be searched for using
6567 the @option{-B} prefix, if needed.  If it is not found there, the two
6568 standard prefixes above are tried, and that is all.  The file is left
6569 out of the link if it is not found by those means.
6571 Another way to specify a prefix much like the @option{-B} prefix is to use
6572 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6573 Variables}.
6575 As a special kludge, if the path provided by @option{-B} is
6576 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6577 9, then it will be replaced by @file{[dir/]include}.  This is to help
6578 with boot-strapping the compiler.
6580 @item -specs=@var{file}
6581 @opindex specs
6582 Process @var{file} after the compiler reads in the standard @file{specs}
6583 file, in order to override the defaults that the @file{gcc} driver
6584 program uses when determining what switches to pass to @file{cc1},
6585 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6586 @option{-specs=@var{file}} can be specified on the command line, and they
6587 are processed in order, from left to right.
6589 @item --sysroot=@var{dir}
6590 @opindex sysroot
6591 Use @var{dir} as the logical root directory for headers and libraries.
6592 For example, if the compiler would normally search for headers in
6593 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6594 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6596 If you use both this option and the @option{-isysroot} option, then
6597 the @option{--sysroot} option will apply to libraries, but the
6598 @option{-isysroot} option will apply to header files.
6600 The GNU linker (beginning with version 2.16) has the necessary support
6601 for this option.  If your linker does not support this option, the
6602 header file aspect of @option{--sysroot} will still work, but the
6603 library aspect will not.
6605 @item -I-
6606 @opindex I-
6607 This option has been deprecated.  Please use @option{-iquote} instead for
6608 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6609 Any directories you specify with @option{-I} options before the @option{-I-}
6610 option are searched only for the case of @samp{#include "@var{file}"};
6611 they are not searched for @samp{#include <@var{file}>}.
6613 If additional directories are specified with @option{-I} options after
6614 the @option{-I-}, these directories are searched for all @samp{#include}
6615 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6616 this way.)
6618 In addition, the @option{-I-} option inhibits the use of the current
6619 directory (where the current input file came from) as the first search
6620 directory for @samp{#include "@var{file}"}.  There is no way to
6621 override this effect of @option{-I-}.  With @option{-I.} you can specify
6622 searching the directory which was current when the compiler was
6623 invoked.  That is not exactly the same as what the preprocessor does
6624 by default, but it is often satisfactory.
6626 @option{-I-} does not inhibit the use of the standard system directories
6627 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6628 independent.
6629 @end table
6631 @c man end
6633 @node Spec Files
6634 @section Specifying subprocesses and the switches to pass to them
6635 @cindex Spec Files
6637 @command{gcc} is a driver program.  It performs its job by invoking a
6638 sequence of other programs to do the work of compiling, assembling and
6639 linking.  GCC interprets its command-line parameters and uses these to
6640 deduce which programs it should invoke, and which command-line options
6641 it ought to place on their command lines.  This behavior is controlled
6642 by @dfn{spec strings}.  In most cases there is one spec string for each
6643 program that GCC can invoke, but a few programs have multiple spec
6644 strings to control their behavior.  The spec strings built into GCC can
6645 be overridden by using the @option{-specs=} command-line switch to specify
6646 a spec file.
6648 @dfn{Spec files} are plaintext files that are used to construct spec
6649 strings.  They consist of a sequence of directives separated by blank
6650 lines.  The type of directive is determined by the first non-whitespace
6651 character on the line and it can be one of the following:
6653 @table @code
6654 @item %@var{command}
6655 Issues a @var{command} to the spec file processor.  The commands that can
6656 appear here are:
6658 @table @code
6659 @item %include <@var{file}>
6660 @cindex %include
6661 Search for @var{file} and insert its text at the current point in the
6662 specs file.
6664 @item %include_noerr <@var{file}>
6665 @cindex %include_noerr
6666 Just like @samp{%include}, but do not generate an error message if the include
6667 file cannot be found.
6669 @item %rename @var{old_name} @var{new_name}
6670 @cindex %rename
6671 Rename the spec string @var{old_name} to @var{new_name}.
6673 @end table
6675 @item *[@var{spec_name}]:
6676 This tells the compiler to create, override or delete the named spec
6677 string.  All lines after this directive up to the next directive or
6678 blank line are considered to be the text for the spec string.  If this
6679 results in an empty string then the spec will be deleted.  (Or, if the
6680 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6681 does not currently exist a new spec will be created.  If the spec does
6682 exist then its contents will be overridden by the text of this
6683 directive, unless the first character of that text is the @samp{+}
6684 character, in which case the text will be appended to the spec.
6686 @item [@var{suffix}]:
6687 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6688 and up to the next directive or blank line are considered to make up the
6689 spec string for the indicated suffix.  When the compiler encounters an
6690 input file with the named suffix, it will processes the spec string in
6691 order to work out how to compile that file.  For example:
6693 @smallexample
6694 .ZZ:
6695 z-compile -input %i
6696 @end smallexample
6698 This says that any input file whose name ends in @samp{.ZZ} should be
6699 passed to the program @samp{z-compile}, which should be invoked with the
6700 command-line switch @option{-input} and with the result of performing the
6701 @samp{%i} substitution.  (See below.)
6703 As an alternative to providing a spec string, the text that follows a
6704 suffix directive can be one of the following:
6706 @table @code
6707 @item @@@var{language}
6708 This says that the suffix is an alias for a known @var{language}.  This is
6709 similar to using the @option{-x} command-line switch to GCC to specify a
6710 language explicitly.  For example:
6712 @smallexample
6713 .ZZ:
6714 @@c++
6715 @end smallexample
6717 Says that .ZZ files are, in fact, C++ source files.
6719 @item #@var{name}
6720 This causes an error messages saying:
6722 @smallexample
6723 @var{name} compiler not installed on this system.
6724 @end smallexample
6725 @end table
6727 GCC already has an extensive list of suffixes built into it.
6728 This directive will add an entry to the end of the list of suffixes, but
6729 since the list is searched from the end backwards, it is effectively
6730 possible to override earlier entries using this technique.
6732 @end table
6734 GCC has the following spec strings built into it.  Spec files can
6735 override these strings or create their own.  Note that individual
6736 targets can also add their own spec strings to this list.
6738 @smallexample
6739 asm          Options to pass to the assembler
6740 asm_final    Options to pass to the assembler post-processor
6741 cpp          Options to pass to the C preprocessor
6742 cc1          Options to pass to the C compiler
6743 cc1plus      Options to pass to the C++ compiler
6744 endfile      Object files to include at the end of the link
6745 link         Options to pass to the linker
6746 lib          Libraries to include on the command line to the linker
6747 libgcc       Decides which GCC support library to pass to the linker
6748 linker       Sets the name of the linker
6749 predefines   Defines to be passed to the C preprocessor
6750 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6751              by default
6752 startfile    Object files to include at the start of the link
6753 @end smallexample
6755 Here is a small example of a spec file:
6757 @smallexample
6758 %rename lib                 old_lib
6760 *lib:
6761 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6762 @end smallexample
6764 This example renames the spec called @samp{lib} to @samp{old_lib} and
6765 then overrides the previous definition of @samp{lib} with a new one.
6766 The new definition adds in some extra command-line options before
6767 including the text of the old definition.
6769 @dfn{Spec strings} are a list of command-line options to be passed to their
6770 corresponding program.  In addition, the spec strings can contain
6771 @samp{%}-prefixed sequences to substitute variable text or to
6772 conditionally insert text into the command line.  Using these constructs
6773 it is possible to generate quite complex command lines.
6775 Here is a table of all defined @samp{%}-sequences for spec
6776 strings.  Note that spaces are not generated automatically around the
6777 results of expanding these sequences.  Therefore you can concatenate them
6778 together or combine them with constant text in a single argument.
6780 @table @code
6781 @item %%
6782 Substitute one @samp{%} into the program name or argument.
6784 @item %i
6785 Substitute the name of the input file being processed.
6787 @item %b
6788 Substitute the basename of the input file being processed.
6789 This is the substring up to (and not including) the last period
6790 and not including the directory.
6792 @item %B
6793 This is the same as @samp{%b}, but include the file suffix (text after
6794 the last period).
6796 @item %d
6797 Marks the argument containing or following the @samp{%d} as a
6798 temporary file name, so that that file will be deleted if GCC exits
6799 successfully.  Unlike @samp{%g}, this contributes no text to the
6800 argument.
6802 @item %g@var{suffix}
6803 Substitute a file name that has suffix @var{suffix} and is chosen
6804 once per compilation, and mark the argument in the same way as
6805 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6806 name is now chosen in a way that is hard to predict even when previously
6807 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6808 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6809 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6810 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6811 was simply substituted with a file name chosen once per compilation,
6812 without regard to any appended suffix (which was therefore treated
6813 just like ordinary text), making such attacks more likely to succeed.
6815 @item %u@var{suffix}
6816 Like @samp{%g}, but generates a new temporary file name even if
6817 @samp{%u@var{suffix}} was already seen.
6819 @item %U@var{suffix}
6820 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6821 new one if there is no such last file name.  In the absence of any
6822 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6823 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6824 would involve the generation of two distinct file names, one
6825 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6826 simply substituted with a file name chosen for the previous @samp{%u},
6827 without regard to any appended suffix.
6829 @item %j@var{suffix}
6830 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6831 writable, and if save-temps is off; otherwise, substitute the name
6832 of a temporary file, just like @samp{%u}.  This temporary file is not
6833 meant for communication between processes, but rather as a junk
6834 disposal mechanism.
6836 @item %|@var{suffix}
6837 @itemx %m@var{suffix}
6838 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6839 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6840 all.  These are the two most common ways to instruct a program that it
6841 should read from standard input or write to standard output.  If you
6842 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6843 construct: see for example @file{f/lang-specs.h}.
6845 @item %.@var{SUFFIX}
6846 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6847 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6848 terminated by the next space or %.
6850 @item %w
6851 Marks the argument containing or following the @samp{%w} as the
6852 designated output file of this compilation.  This puts the argument
6853 into the sequence of arguments that @samp{%o} will substitute later.
6855 @item %o
6856 Substitutes the names of all the output files, with spaces
6857 automatically placed around them.  You should write spaces
6858 around the @samp{%o} as well or the results are undefined.
6859 @samp{%o} is for use in the specs for running the linker.
6860 Input files whose names have no recognized suffix are not compiled
6861 at all, but they are included among the output files, so they will
6862 be linked.
6864 @item %O
6865 Substitutes the suffix for object files.  Note that this is
6866 handled specially when it immediately follows @samp{%g, %u, or %U},
6867 because of the need for those to form complete file names.  The
6868 handling is such that @samp{%O} is treated exactly as if it had already
6869 been substituted, except that @samp{%g, %u, and %U} do not currently
6870 support additional @var{suffix} characters following @samp{%O} as they would
6871 following, for example, @samp{.o}.
6873 @item %p
6874 Substitutes the standard macro predefinitions for the
6875 current target machine.  Use this when running @code{cpp}.
6877 @item %P
6878 Like @samp{%p}, but puts @samp{__} before and after the name of each
6879 predefined macro, except for macros that start with @samp{__} or with
6880 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6883 @item %I
6884 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6885 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
6886 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6887 and @option{-imultilib} as necessary.
6889 @item %s
6890 Current argument is the name of a library or startup file of some sort.
6891 Search for that file in a standard list of directories and substitute
6892 the full name found.
6894 @item %e@var{str}
6895 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6896 Use this when inconsistent options are detected.
6898 @item %(@var{name})
6899 Substitute the contents of spec string @var{name} at this point.
6901 @item %[@var{name}]
6902 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6904 @item %x@{@var{option}@}
6905 Accumulate an option for @samp{%X}.
6907 @item %X
6908 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6909 spec string.
6911 @item %Y
6912 Output the accumulated assembler options specified by @option{-Wa}.
6914 @item %Z
6915 Output the accumulated preprocessor options specified by @option{-Wp}.
6917 @item %a
6918 Process the @code{asm} spec.  This is used to compute the
6919 switches to be passed to the assembler.
6921 @item %A
6922 Process the @code{asm_final} spec.  This is a spec string for
6923 passing switches to an assembler post-processor, if such a program is
6924 needed.
6926 @item %l
6927 Process the @code{link} spec.  This is the spec for computing the
6928 command line passed to the linker.  Typically it will make use of the
6929 @samp{%L %G %S %D and %E} sequences.
6931 @item %D
6932 Dump out a @option{-L} option for each directory that GCC believes might
6933 contain startup files.  If the target supports multilibs then the
6934 current multilib directory will be prepended to each of these paths.
6936 @item %L
6937 Process the @code{lib} spec.  This is a spec string for deciding which
6938 libraries should be included on the command line to the linker.
6940 @item %G
6941 Process the @code{libgcc} spec.  This is a spec string for deciding
6942 which GCC support library should be included on the command line to the linker.
6944 @item %S
6945 Process the @code{startfile} spec.  This is a spec for deciding which
6946 object files should be the first ones passed to the linker.  Typically
6947 this might be a file named @file{crt0.o}.
6949 @item %E
6950 Process the @code{endfile} spec.  This is a spec string that specifies
6951 the last object files that will be passed to the linker.
6953 @item %C
6954 Process the @code{cpp} spec.  This is used to construct the arguments
6955 to be passed to the C preprocessor.
6957 @item %1
6958 Process the @code{cc1} spec.  This is used to construct the options to be
6959 passed to the actual C compiler (@samp{cc1}).
6961 @item %2
6962 Process the @code{cc1plus} spec.  This is used to construct the options to be
6963 passed to the actual C++ compiler (@samp{cc1plus}).
6965 @item %*
6966 Substitute the variable part of a matched option.  See below.
6967 Note that each comma in the substituted string is replaced by
6968 a single space.
6970 @item %<@code{S}
6971 Remove all occurrences of @code{-S} from the command line.  Note---this
6972 command is position dependent.  @samp{%} commands in the spec string
6973 before this one will see @code{-S}, @samp{%} commands in the spec string
6974 after this one will not.
6976 @item %:@var{function}(@var{args})
6977 Call the named function @var{function}, passing it @var{args}.
6978 @var{args} is first processed as a nested spec string, then split
6979 into an argument vector in the usual fashion.  The function returns
6980 a string which is processed as if it had appeared literally as part
6981 of the current spec.
6983 The following built-in spec functions are provided:
6985 @table @code
6986 @item @code{if-exists}
6987 The @code{if-exists} spec function takes one argument, an absolute
6988 pathname to a file.  If the file exists, @code{if-exists} returns the
6989 pathname.  Here is a small example of its usage:
6991 @smallexample
6992 *startfile:
6993 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6994 @end smallexample
6996 @item @code{if-exists-else}
6997 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6998 spec function, except that it takes two arguments.  The first argument is
6999 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
7000 returns the pathname.  If it does not exist, it returns the second argument.
7001 This way, @code{if-exists-else} can be used to select one file or another,
7002 based on the existence of the first.  Here is a small example of its usage:
7004 @smallexample
7005 *startfile:
7006 crt0%O%s %:if-exists(crti%O%s) \
7007 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7008 @end smallexample
7010 @item @code{replace-outfile}
7011 The @code{replace-outfile} spec function takes two arguments.  It looks for the
7012 first argument in the outfiles array and replaces it with the second argument.  Here
7013 is a small example of its usage:
7015 @smallexample
7016 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7017 @end smallexample
7019 @end table
7021 @item %@{@code{S}@}
7022 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7023 If that switch was not specified, this substitutes nothing.  Note that
7024 the leading dash is omitted when specifying this option, and it is
7025 automatically inserted if the substitution is performed.  Thus the spec
7026 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7027 and would output the command line option @option{-foo}.
7029 @item %W@{@code{S}@}
7030 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7031 deleted on failure.
7033 @item %@{@code{S}*@}
7034 Substitutes all the switches specified to GCC whose names start
7035 with @code{-S}, but which also take an argument.  This is used for
7036 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7037 GCC considers @option{-o foo} as being
7038 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
7039 text, including the space.  Thus two arguments would be generated.
7041 @item %@{@code{S}*&@code{T}*@}
7042 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7043 (the order of @code{S} and @code{T} in the spec is not significant).
7044 There can be any number of ampersand-separated variables; for each the
7045 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
7047 @item %@{@code{S}:@code{X}@}
7048 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7050 @item %@{!@code{S}:@code{X}@}
7051 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7053 @item %@{@code{S}*:@code{X}@}
7054 Substitutes @code{X} if one or more switches whose names start with
7055 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
7056 once, no matter how many such switches appeared.  However, if @code{%*}
7057 appears somewhere in @code{X}, then @code{X} will be substituted once
7058 for each matching switch, with the @code{%*} replaced by the part of
7059 that switch that matched the @code{*}.
7061 @item %@{.@code{S}:@code{X}@}
7062 Substitutes @code{X}, if processing a file with suffix @code{S}.
7064 @item %@{!.@code{S}:@code{X}@}
7065 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7067 @item %@{@code{S}|@code{P}:@code{X}@}
7068 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7069 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7070 although they have a stronger binding than the @samp{|}.  If @code{%*}
7071 appears in @code{X}, all of the alternatives must be starred, and only
7072 the first matching alternative is substituted.
7074 For example, a spec string like this:
7076 @smallexample
7077 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7078 @end smallexample
7080 will output the following command-line options from the following input
7081 command-line options:
7083 @smallexample
7084 fred.c        -foo -baz
7085 jim.d         -bar -boggle
7086 -d fred.c     -foo -baz -boggle
7087 -d jim.d      -bar -baz -boggle
7088 @end smallexample
7090 @item %@{S:X; T:Y; :D@}
7092 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7093 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
7094 be as many clauses as you need.  This may be combined with @code{.},
7095 @code{!}, @code{|}, and @code{*} as needed.
7098 @end table
7100 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7101 construct may contain other nested @samp{%} constructs or spaces, or
7102 even newlines.  They are processed as usual, as described above.
7103 Trailing white space in @code{X} is ignored.  White space may also
7104 appear anywhere on the left side of the colon in these constructs,
7105 except between @code{.} or @code{*} and the corresponding word.
7107 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7108 handled specifically in these constructs.  If another value of
7109 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7110 @option{-W} switch is found later in the command line, the earlier
7111 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7112 just one letter, which passes all matching options.
7114 The character @samp{|} at the beginning of the predicate text is used to
7115 indicate that a command should be piped to the following command, but
7116 only if @option{-pipe} is specified.
7118 It is built into GCC which switches take arguments and which do not.
7119 (You might think it would be useful to generalize this to allow each
7120 compiler's spec to say which switches take arguments.  But this cannot
7121 be done in a consistent fashion.  GCC cannot even decide which input
7122 files have been specified without knowing which switches take arguments,
7123 and it must know which input files to compile in order to tell which
7124 compilers to run).
7126 GCC also knows implicitly that arguments starting in @option{-l} are to be
7127 treated as compiler output files, and passed to the linker in their
7128 proper position among the other output files.
7130 @c man begin OPTIONS
7132 @node Target Options
7133 @section Specifying Target Machine and Compiler Version
7134 @cindex target options
7135 @cindex cross compiling
7136 @cindex specifying machine version
7137 @cindex specifying compiler version and target machine
7138 @cindex compiler version, specifying
7139 @cindex target machine, specifying
7141 The usual way to run GCC is to run the executable called @file{gcc}, or
7142 @file{<machine>-gcc} when cross-compiling, or
7143 @file{<machine>-gcc-<version>} to run a version other than the one that
7144 was installed last.  Sometimes this is inconvenient, so GCC provides
7145 options that will switch to another cross-compiler or version.
7147 @table @gcctabopt
7148 @item -b @var{machine}
7149 @opindex b
7150 The argument @var{machine} specifies the target machine for compilation.
7152 The value to use for @var{machine} is the same as was specified as the
7153 machine type when configuring GCC as a cross-compiler.  For
7154 example, if a cross-compiler was configured with @samp{configure
7155 arm-elf}, meaning to compile for an arm processor with elf binaries,
7156 then you would specify @option{-b arm-elf} to run that cross compiler.
7157 Because there are other options beginning with @option{-b}, the
7158 configuration must contain a hyphen. 
7160 @item -V @var{version}
7161 @opindex V
7162 The argument @var{version} specifies which version of GCC to run.
7163 This is useful when multiple versions are installed.  For example,
7164 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7165 @end table
7167 The @option{-V} and @option{-b} options work by running the
7168 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7169 use them if you can just run that directly.
7171 @node Submodel Options
7172 @section Hardware Models and Configurations
7173 @cindex submodel options
7174 @cindex specifying hardware config
7175 @cindex hardware models and configurations, specifying
7176 @cindex machine dependent options
7178 Earlier we discussed the standard option @option{-b} which chooses among
7179 different installed compilers for completely different target
7180 machines, such as VAX vs.@: 68000 vs.@: 80386.
7182 In addition, each of these target machine types can have its own
7183 special options, starting with @samp{-m}, to choose among various
7184 hardware models or configurations---for example, 68010 vs 68020,
7185 floating coprocessor or none.  A single installed version of the
7186 compiler can compile for any model or configuration, according to the
7187 options specified.
7189 Some configurations of the compiler also support additional special
7190 options, usually for compatibility with other compilers on the same
7191 platform.
7193 @c This list is ordered alphanumerically by subsection name.
7194 @c It should be the same order and spelling as these options are listed
7195 @c in Machine Dependent Options
7197 @menu
7198 * ARC Options::
7199 * ARM Options::
7200 * AVR Options::
7201 * Blackfin Options::
7202 * CRIS Options::
7203 * CRX Options::
7204 * Darwin Options::
7205 * DEC Alpha Options::
7206 * DEC Alpha/VMS Options::
7207 * FRV Options::
7208 * GNU/Linux Options::
7209 * H8/300 Options::
7210 * HPPA Options::
7211 * i386 and x86-64 Options::
7212 * IA-64 Options::
7213 * M32C Options::
7214 * M32R/D Options::
7215 * M680x0 Options::
7216 * M68hc1x Options::
7217 * MCore Options::
7218 * MIPS Options::
7219 * MMIX Options::
7220 * MN10300 Options::
7221 * MT Options::
7222 * PDP-11 Options::
7223 * PowerPC Options::
7224 * RS/6000 and PowerPC Options::
7225 * S/390 and zSeries Options::
7226 * SH Options::
7227 * SPARC Options::
7228 * System V Options::
7229 * TMS320C3x/C4x Options::
7230 * V850 Options::
7231 * VAX Options::
7232 * x86-64 Options::
7233 * Xstormy16 Options::
7234 * Xtensa Options::
7235 * zSeries Options::
7236 @end menu
7238 @node ARC Options
7239 @subsection ARC Options
7240 @cindex ARC Options
7242 These options are defined for ARC implementations:
7244 @table @gcctabopt
7245 @item -EL
7246 @opindex EL
7247 Compile code for little endian mode.  This is the default.
7249 @item -EB
7250 @opindex EB
7251 Compile code for big endian mode.
7253 @item -mmangle-cpu
7254 @opindex mmangle-cpu
7255 Prepend the name of the cpu to all public symbol names.
7256 In multiple-processor systems, there are many ARC variants with different
7257 instruction and register set characteristics.  This flag prevents code
7258 compiled for one cpu to be linked with code compiled for another.
7259 No facility exists for handling variants that are ``almost identical''.
7260 This is an all or nothing option.
7262 @item -mcpu=@var{cpu}
7263 @opindex mcpu
7264 Compile code for ARC variant @var{cpu}.
7265 Which variants are supported depend on the configuration.
7266 All variants support @option{-mcpu=base}, this is the default.
7268 @item -mtext=@var{text-section}
7269 @itemx -mdata=@var{data-section}
7270 @itemx -mrodata=@var{readonly-data-section}
7271 @opindex mtext
7272 @opindex mdata
7273 @opindex mrodata
7274 Put functions, data, and readonly data in @var{text-section},
7275 @var{data-section}, and @var{readonly-data-section} respectively
7276 by default.  This can be overridden with the @code{section} attribute.
7277 @xref{Variable Attributes}.
7279 @end table
7281 @node ARM Options
7282 @subsection ARM Options
7283 @cindex ARM options
7285 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7286 architectures:
7288 @table @gcctabopt
7289 @item -mabi=@var{name}
7290 @opindex mabi
7291 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7292 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7294 @item -mapcs-frame
7295 @opindex mapcs-frame
7296 Generate a stack frame that is compliant with the ARM Procedure Call
7297 Standard for all functions, even if this is not strictly necessary for
7298 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7299 with this option will cause the stack frames not to be generated for
7300 leaf functions.  The default is @option{-mno-apcs-frame}.
7302 @item -mapcs
7303 @opindex mapcs
7304 This is a synonym for @option{-mapcs-frame}.
7306 @ignore
7307 @c not currently implemented
7308 @item -mapcs-stack-check
7309 @opindex mapcs-stack-check
7310 Generate code to check the amount of stack space available upon entry to
7311 every function (that actually uses some stack space).  If there is
7312 insufficient space available then either the function
7313 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7314 called, depending upon the amount of stack space required.  The run time
7315 system is required to provide these functions.  The default is
7316 @option{-mno-apcs-stack-check}, since this produces smaller code.
7318 @c not currently implemented
7319 @item -mapcs-float
7320 @opindex mapcs-float
7321 Pass floating point arguments using the float point registers.  This is
7322 one of the variants of the APCS@.  This option is recommended if the
7323 target hardware has a floating point unit or if a lot of floating point
7324 arithmetic is going to be performed by the code.  The default is
7325 @option{-mno-apcs-float}, since integer only code is slightly increased in
7326 size if @option{-mapcs-float} is used.
7328 @c not currently implemented
7329 @item -mapcs-reentrant
7330 @opindex mapcs-reentrant
7331 Generate reentrant, position independent code.  The default is
7332 @option{-mno-apcs-reentrant}.
7333 @end ignore
7335 @item -mthumb-interwork
7336 @opindex mthumb-interwork
7337 Generate code which supports calling between the ARM and Thumb
7338 instruction sets.  Without this option the two instruction sets cannot
7339 be reliably used inside one program.  The default is
7340 @option{-mno-thumb-interwork}, since slightly larger code is generated
7341 when @option{-mthumb-interwork} is specified.
7343 @item -mno-sched-prolog
7344 @opindex mno-sched-prolog
7345 Prevent the reordering of instructions in the function prolog, or the
7346 merging of those instruction with the instructions in the function's
7347 body.  This means that all functions will start with a recognizable set
7348 of instructions (or in fact one of a choice from a small set of
7349 different function prologues), and this information can be used to
7350 locate the start if functions inside an executable piece of code.  The
7351 default is @option{-msched-prolog}.
7353 @item -mhard-float
7354 @opindex mhard-float
7355 Generate output containing floating point instructions.  This is the
7356 default.
7358 @item -msoft-float
7359 @opindex msoft-float
7360 Generate output containing library calls for floating point.
7361 @strong{Warning:} the requisite libraries are not available for all ARM
7362 targets.  Normally the facilities of the machine's usual C compiler are
7363 used, but this cannot be done directly in cross-compilation.  You must make
7364 your own arrangements to provide suitable library functions for
7365 cross-compilation.
7367 @option{-msoft-float} changes the calling convention in the output file;
7368 therefore, it is only useful if you compile @emph{all} of a program with
7369 this option.  In particular, you need to compile @file{libgcc.a}, the
7370 library that comes with GCC, with @option{-msoft-float} in order for
7371 this to work.
7373 @item -mfloat-abi=@var{name}
7374 @opindex mfloat-abi
7375 Specifies which ABI to use for floating point values.  Permissible values
7376 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7378 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7379 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7380 of floating point instructions, but still uses the soft-float calling
7381 conventions.
7383 @item -mlittle-endian
7384 @opindex mlittle-endian
7385 Generate code for a processor running in little-endian mode.  This is
7386 the default for all standard configurations.
7388 @item -mbig-endian
7389 @opindex mbig-endian
7390 Generate code for a processor running in big-endian mode; the default is
7391 to compile code for a little-endian processor.
7393 @item -mwords-little-endian
7394 @opindex mwords-little-endian
7395 This option only applies when generating code for big-endian processors.
7396 Generate code for a little-endian word order but a big-endian byte
7397 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7398 option should only be used if you require compatibility with code for
7399 big-endian ARM processors generated by versions of the compiler prior to
7400 2.8.
7402 @item -mcpu=@var{name}
7403 @opindex mcpu
7404 This specifies the name of the target ARM processor.  GCC uses this name
7405 to determine what kind of instructions it can emit when generating
7406 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7407 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7408 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7409 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7410 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7411 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7412 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7413 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7414 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7415 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7416 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7417 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7418 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7419 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7420 @samp{ep9312}.
7422 @itemx -mtune=@var{name}
7423 @opindex mtune
7424 This option is very similar to the @option{-mcpu=} option, except that
7425 instead of specifying the actual target processor type, and hence
7426 restricting which instructions can be used, it specifies that GCC should
7427 tune the performance of the code as if the target were of the type
7428 specified in this option, but still choosing the instructions that it
7429 will generate based on the cpu specified by a @option{-mcpu=} option.
7430 For some ARM implementations better performance can be obtained by using
7431 this option.
7433 @item -march=@var{name}
7434 @opindex march
7435 This specifies the name of the target ARM architecture.  GCC uses this
7436 name to determine what kind of instructions it can emit when generating
7437 assembly code.  This option can be used in conjunction with or instead
7438 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7439 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7440 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7441 @samp{iwmmxt}, @samp{ep9312}.
7443 @item -mfpu=@var{name}
7444 @itemx -mfpe=@var{number}
7445 @itemx -mfp=@var{number}
7446 @opindex mfpu
7447 @opindex mfpe
7448 @opindex mfp
7449 This specifies what floating point hardware (or hardware emulation) is
7450 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7451 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7452 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7453 with older versions of GCC@.
7455 If @option{-msoft-float} is specified this specifies the format of
7456 floating point values.
7458 @item -mstructure-size-boundary=@var{n}
7459 @opindex mstructure-size-boundary
7460 The size of all structures and unions will be rounded up to a multiple
7461 of the number of bits set by this option.  Permissible values are 8, 32
7462 and 64.  The default value varies for different toolchains.  For the COFF
7463 targeted toolchain the default value is 8.  A value of 64 is only allowed
7464 if the underlying ABI supports it.
7466 Specifying the larger number can produce faster, more efficient code, but
7467 can also increase the size of the program.  Different values are potentially
7468 incompatible.  Code compiled with one value cannot necessarily expect to
7469 work with code or libraries compiled with another value, if they exchange
7470 information using structures or unions.
7472 @item -mabort-on-noreturn
7473 @opindex mabort-on-noreturn
7474 Generate a call to the function @code{abort} at the end of a
7475 @code{noreturn} function.  It will be executed if the function tries to
7476 return.
7478 @item -mlong-calls
7479 @itemx -mno-long-calls
7480 @opindex mlong-calls
7481 @opindex mno-long-calls
7482 Tells the compiler to perform function calls by first loading the
7483 address of the function into a register and then performing a subroutine
7484 call on this register.  This switch is needed if the target function
7485 will lie outside of the 64 megabyte addressing range of the offset based
7486 version of subroutine call instruction.
7488 Even if this switch is enabled, not all function calls will be turned
7489 into long calls.  The heuristic is that static functions, functions
7490 which have the @samp{short-call} attribute, functions that are inside
7491 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7492 definitions have already been compiled within the current compilation
7493 unit, will not be turned into long calls.  The exception to this rule is
7494 that weak function definitions, functions with the @samp{long-call}
7495 attribute or the @samp{section} attribute, and functions that are within
7496 the scope of a @samp{#pragma long_calls} directive, will always be
7497 turned into long calls.
7499 This feature is not enabled by default.  Specifying
7500 @option{-mno-long-calls} will restore the default behavior, as will
7501 placing the function calls within the scope of a @samp{#pragma
7502 long_calls_off} directive.  Note these switches have no effect on how
7503 the compiler generates code to handle function calls via function
7504 pointers.
7506 @item -mnop-fun-dllimport
7507 @opindex mnop-fun-dllimport
7508 Disable support for the @code{dllimport} attribute.
7510 @item -msingle-pic-base
7511 @opindex msingle-pic-base
7512 Treat the register used for PIC addressing as read-only, rather than
7513 loading it in the prologue for each function.  The run-time system is
7514 responsible for initializing this register with an appropriate value
7515 before execution begins.
7517 @item -mpic-register=@var{reg}
7518 @opindex mpic-register
7519 Specify the register to be used for PIC addressing.  The default is R10
7520 unless stack-checking is enabled, when R9 is used.
7522 @item -mcirrus-fix-invalid-insns
7523 @opindex mcirrus-fix-invalid-insns
7524 @opindex mno-cirrus-fix-invalid-insns
7525 Insert NOPs into the instruction stream to in order to work around
7526 problems with invalid Maverick instruction combinations.  This option
7527 is only valid if the @option{-mcpu=ep9312} option has been used to
7528 enable generation of instructions for the Cirrus Maverick floating
7529 point co-processor.  This option is not enabled by default, since the
7530 problem is only present in older Maverick implementations.  The default
7531 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7532 switch.
7534 @item -mpoke-function-name
7535 @opindex mpoke-function-name
7536 Write the name of each function into the text section, directly
7537 preceding the function prologue.  The generated code is similar to this:
7539 @smallexample
7540      t0
7541          .ascii "arm_poke_function_name", 0
7542          .align
7543      t1
7544          .word 0xff000000 + (t1 - t0)
7545      arm_poke_function_name
7546          mov     ip, sp
7547          stmfd   sp!, @{fp, ip, lr, pc@}
7548          sub     fp, ip, #4
7549 @end smallexample
7551 When performing a stack backtrace, code can inspect the value of
7552 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7553 location @code{pc - 12} and the top 8 bits are set, then we know that
7554 there is a function name embedded immediately preceding this location
7555 and has length @code{((pc[-3]) & 0xff000000)}.
7557 @item -mthumb
7558 @opindex mthumb
7559 Generate code for the 16-bit Thumb instruction set.  The default is to
7560 use the 32-bit ARM instruction set.
7562 @item -mtpcs-frame
7563 @opindex mtpcs-frame
7564 Generate a stack frame that is compliant with the Thumb Procedure Call
7565 Standard for all non-leaf functions.  (A leaf function is one that does
7566 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7568 @item -mtpcs-leaf-frame
7569 @opindex mtpcs-leaf-frame
7570 Generate a stack frame that is compliant with the Thumb Procedure Call
7571 Standard for all leaf functions.  (A leaf function is one that does
7572 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7574 @item -mcallee-super-interworking
7575 @opindex mcallee-super-interworking
7576 Gives all externally visible functions in the file being compiled an ARM
7577 instruction set header which switches to Thumb mode before executing the
7578 rest of the function.  This allows these functions to be called from
7579 non-interworking code.
7581 @item -mcaller-super-interworking
7582 @opindex mcaller-super-interworking
7583 Allows calls via function pointers (including virtual functions) to
7584 execute correctly regardless of whether the target code has been
7585 compiled for interworking or not.  There is a small overhead in the cost
7586 of executing a function pointer if this option is enabled.
7588 @item -mtp=@var{name}
7589 @opindex mtp
7590 Specify the access model for the thread local storage pointer.  The valid
7591 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7592 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7593 (supported in the arm6k architecture), and @option{auto}, which uses the
7594 best available method for the selected processor.  The default setting is
7595 @option{auto}.
7597 @end table
7599 @node AVR Options
7600 @subsection AVR Options
7601 @cindex AVR Options
7603 These options are defined for AVR implementations:
7605 @table @gcctabopt
7606 @item -mmcu=@var{mcu}
7607 @opindex mmcu
7608 Specify ATMEL AVR instruction set or MCU type.
7610 Instruction set avr1 is for the minimal AVR core, not supported by the C
7611 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7612 attiny11, attiny12, attiny15, attiny28).
7614 Instruction set avr2 (default) is for the classic AVR core with up to
7615 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7616 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7617 at90c8534, at90s8535).
7619 Instruction set avr3 is for the classic AVR core with up to 128K program
7620 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7622 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7623 memory space (MCU types: atmega8, atmega83, atmega85).
7625 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7626 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7627 atmega64, atmega128, at43usb355, at94k).
7629 @item -msize
7630 @opindex msize
7631 Output instruction sizes to the asm file.
7633 @item -minit-stack=@var{N}
7634 @opindex minit-stack
7635 Specify the initial stack address, which may be a symbol or numeric value,
7636 @samp{__stack} is the default.
7638 @item -mno-interrupts
7639 @opindex mno-interrupts
7640 Generated code is not compatible with hardware interrupts.
7641 Code size will be smaller.
7643 @item -mcall-prologues
7644 @opindex mcall-prologues
7645 Functions prologues/epilogues expanded as call to appropriate
7646 subroutines.  Code size will be smaller.
7648 @item -mno-tablejump
7649 @opindex mno-tablejump
7650 Do not generate tablejump insns which sometimes increase code size.
7652 @item -mtiny-stack
7653 @opindex mtiny-stack
7654 Change only the low 8 bits of the stack pointer.
7656 @item -mint8
7657 @opindex mint8
7658 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7659 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7660 and long long will be 4 bytes.  Please note that this option does not
7661 comply to the C standards, but it will provide you with smaller code
7662 size.
7663 @end table
7665 @node Blackfin Options
7666 @subsection Blackfin Options
7667 @cindex Blackfin Options
7669 @table @gcctabopt
7670 @item -momit-leaf-frame-pointer
7671 @opindex momit-leaf-frame-pointer
7672 Don't keep the frame pointer in a register for leaf functions.  This
7673 avoids the instructions to save, set up and restore frame pointers and
7674 makes an extra register available in leaf functions.  The option
7675 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7676 which might make debugging harder.
7678 @item -mspecld-anomaly
7679 @opindex mspecld-anomaly
7680 When enabled, the compiler will ensure that the generated code does not
7681 contain speculative loads after jump instructions.  This option is enabled
7682 by default.
7684 @item -mno-specld-anomaly
7685 @opindex mno-specld-anomaly
7686 Don't generate extra code to prevent speculative loads from occurring.
7688 @item -mcsync-anomaly
7689 @opindex mcsync-anomaly
7690 When enabled, the compiler will ensure that the generated code does not
7691 contain CSYNC or SSYNC instructions too soon after conditional branches.
7692 This option is enabled by default.
7694 @item -mno-csync-anomaly
7695 @opindex mno-csync-anomaly
7696 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7697 occurring too soon after a conditional branch.
7699 @item -mlow-64k
7700 @opindex mlow-64k
7701 When enabled, the compiler is free to take advantage of the knowledge that
7702 the entire program fits into the low 64k of memory.
7704 @item -mno-low-64k
7705 @opindex mno-low-64k
7706 Assume that the program is arbitrarily large.  This is the default.
7708 @item -mid-shared-library
7709 @opindex mid-shared-library
7710 Generate code that supports shared libraries via the library ID method.
7711 This allows for execute in place and shared libraries in an environment
7712 without virtual memory management.  This option implies @option{-fPIC}.
7714 @item -mno-id-shared-library
7715 @opindex mno-id-shared-library
7716 Generate code that doesn't assume ID based shared libraries are being used.
7717 This is the default.
7719 @item -mshared-library-id=n
7720 @opindex mshared-library-id
7721 Specified the identification number of the ID based shared library being
7722 compiled.  Specifying a value of 0 will generate more compact code, specifying
7723 other values will force the allocation of that number to the current
7724 library but is no more space or time efficient than omitting this option.
7726 @item -mlong-calls
7727 @itemx -mno-long-calls
7728 @opindex mlong-calls
7729 @opindex mno-long-calls
7730 Tells the compiler to perform function calls by first loading the
7731 address of the function into a register and then performing a subroutine
7732 call on this register.  This switch is needed if the target function
7733 will lie outside of the 24 bit addressing range of the offset based
7734 version of subroutine call instruction.
7736 This feature is not enabled by default.  Specifying
7737 @option{-mno-long-calls} will restore the default behavior.  Note these
7738 switches have no effect on how the compiler generates code to handle
7739 function calls via function pointers.
7740 @end table
7742 @node CRIS Options
7743 @subsection CRIS Options
7744 @cindex CRIS Options
7746 These options are defined specifically for the CRIS ports.
7748 @table @gcctabopt
7749 @item -march=@var{architecture-type}
7750 @itemx -mcpu=@var{architecture-type}
7751 @opindex march
7752 @opindex mcpu
7753 Generate code for the specified architecture.  The choices for
7754 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7755 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7756 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7757 @samp{v10}.
7759 @item -mtune=@var{architecture-type}
7760 @opindex mtune
7761 Tune to @var{architecture-type} everything applicable about the generated
7762 code, except for the ABI and the set of available instructions.  The
7763 choices for @var{architecture-type} are the same as for
7764 @option{-march=@var{architecture-type}}.
7766 @item -mmax-stack-frame=@var{n}
7767 @opindex mmax-stack-frame
7768 Warn when the stack frame of a function exceeds @var{n} bytes.
7770 @item -melinux-stacksize=@var{n}
7771 @opindex melinux-stacksize
7772 Only available with the @samp{cris-axis-aout} target.  Arranges for
7773 indications in the program to the kernel loader that the stack of the
7774 program should be set to @var{n} bytes.
7776 @item -metrax4
7777 @itemx -metrax100
7778 @opindex metrax4
7779 @opindex metrax100
7780 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7781 @option{-march=v3} and @option{-march=v8} respectively.
7783 @item -mmul-bug-workaround
7784 @itemx -mno-mul-bug-workaround
7785 @opindex mmul-bug-workaround
7786 @opindex mno-mul-bug-workaround
7787 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7788 models where it applies.  This option is active by default.
7790 @item -mpdebug
7791 @opindex mpdebug
7792 Enable CRIS-specific verbose debug-related information in the assembly
7793 code.  This option also has the effect to turn off the @samp{#NO_APP}
7794 formatted-code indicator to the assembler at the beginning of the
7795 assembly file.
7797 @item -mcc-init
7798 @opindex mcc-init
7799 Do not use condition-code results from previous instruction; always emit
7800 compare and test instructions before use of condition codes.
7802 @item -mno-side-effects
7803 @opindex mno-side-effects
7804 Do not emit instructions with side-effects in addressing modes other than
7805 post-increment.
7807 @item -mstack-align
7808 @itemx -mno-stack-align
7809 @itemx -mdata-align
7810 @itemx -mno-data-align
7811 @itemx -mconst-align
7812 @itemx -mno-const-align
7813 @opindex mstack-align
7814 @opindex mno-stack-align
7815 @opindex mdata-align
7816 @opindex mno-data-align
7817 @opindex mconst-align
7818 @opindex mno-const-align
7819 These options (no-options) arranges (eliminate arrangements) for the
7820 stack-frame, individual data and constants to be aligned for the maximum
7821 single data access size for the chosen CPU model.  The default is to
7822 arrange for 32-bit alignment.  ABI details such as structure layout are
7823 not affected by these options.
7825 @item -m32-bit
7826 @itemx -m16-bit
7827 @itemx -m8-bit
7828 @opindex m32-bit
7829 @opindex m16-bit
7830 @opindex m8-bit
7831 Similar to the stack- data- and const-align options above, these options
7832 arrange for stack-frame, writable data and constants to all be 32-bit,
7833 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7835 @item -mno-prologue-epilogue
7836 @itemx -mprologue-epilogue
7837 @opindex mno-prologue-epilogue
7838 @opindex mprologue-epilogue
7839 With @option{-mno-prologue-epilogue}, the normal function prologue and
7840 epilogue that sets up the stack-frame are omitted and no return
7841 instructions or return sequences are generated in the code.  Use this
7842 option only together with visual inspection of the compiled code: no
7843 warnings or errors are generated when call-saved registers must be saved,
7844 or storage for local variable needs to be allocated.
7846 @item -mno-gotplt
7847 @itemx -mgotplt
7848 @opindex mno-gotplt
7849 @opindex mgotplt
7850 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7851 instruction sequences that load addresses for functions from the PLT part
7852 of the GOT rather than (traditional on other architectures) calls to the
7853 PLT@.  The default is @option{-mgotplt}.
7855 @item -maout
7856 @opindex maout
7857 Legacy no-op option only recognized with the cris-axis-aout target.
7859 @item -melf
7860 @opindex melf
7861 Legacy no-op option only recognized with the cris-axis-elf and
7862 cris-axis-linux-gnu targets.
7864 @item -melinux
7865 @opindex melinux
7866 Only recognized with the cris-axis-aout target, where it selects a
7867 GNU/linux-like multilib, include files and instruction set for
7868 @option{-march=v8}.
7870 @item -mlinux
7871 @opindex mlinux
7872 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7874 @item -sim
7875 @opindex sim
7876 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7877 to link with input-output functions from a simulator library.  Code,
7878 initialized data and zero-initialized data are allocated consecutively.
7880 @item -sim2
7881 @opindex sim2
7882 Like @option{-sim}, but pass linker options to locate initialized data at
7883 0x40000000 and zero-initialized data at 0x80000000.
7884 @end table
7886 @node CRX Options
7887 @subsection CRX Options
7888 @cindex CRX Options
7890 These options are defined specifically for the CRX ports.
7892 @table @gcctabopt
7894 @item -mmac
7895 @opindex mmac
7896 Enable the use of multiply-accumulate instructions. Disabled by default.
7898 @item -mpush-args
7899 @opindex mpush-args
7900 Push instructions will be used to pass outgoing arguments when functions
7901 are called. Enabled by default.
7902 @end table
7904 @node Darwin Options
7905 @subsection Darwin Options
7906 @cindex Darwin options
7908 These options are defined for all architectures running the Darwin operating
7909 system.
7911 FSF GCC on Darwin does not create ``fat'' object files; it will create
7912 an object file for the single architecture that it was built to
7913 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7914 @option{-arch} options are used; it does so by running the compiler or
7915 linker multiple times and joining the results together with
7916 @file{lipo}.
7918 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7919 @samp{i686}) is determined by the flags that specify the ISA
7920 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7921 @option{-force_cpusubtype_ALL} option can be used to override this.
7923 The Darwin tools vary in their behavior when presented with an ISA
7924 mismatch.  The assembler, @file{as}, will only permit instructions to
7925 be used that are valid for the subtype of the file it is generating,
7926 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7927 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7928 and print an error if asked to create a shared library with a less
7929 restrictive subtype than its input files (for instance, trying to put
7930 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7931 for executables, @file{ld}, will quietly give the executable the most
7932 restrictive subtype of any of its input files.
7934 @table @gcctabopt
7935 @item -F@var{dir}
7936 @opindex F
7937 Add the framework directory @var{dir} to the head of the list of
7938 directories to be searched for header files.  These directories are
7939 interleaved with those specified by @option{-I} options and are
7940 scanned in a left-to-right order.
7942 A framework directory is a directory with frameworks in it.  A
7943 framework is a directory with a @samp{"Headers"} and/or
7944 @samp{"PrivateHeaders"} directory contained directly in it that ends
7945 in @samp{".framework"}.  The name of a framework is the name of this
7946 directory excluding the @samp{".framework"}.  Headers associated with
7947 the framework are found in one of those two directories, with
7948 @samp{"Headers"} being searched first.  A subframework is a framework
7949 directory that is in a framework's @samp{"Frameworks"} directory.
7950 Includes of subframework headers can only appear in a header of a
7951 framework that contains the subframework, or in a sibling subframework
7952 header.  Two subframeworks are siblings if they occur in the same
7953 framework.  A subframework should not have the same name as a
7954 framework, a warning will be issued if this is violated.  Currently a
7955 subframework cannot have subframeworks, in the future, the mechanism
7956 may be extended to support this.  The standard frameworks can be found
7957 in @samp{"/System/Library/Frameworks"} and
7958 @samp{"/Library/Frameworks"}.  An example include looks like
7959 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7960 the name of the framework and header.h is found in the
7961 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7963 @item -gused
7964 @opindex -gused
7965 Emit debugging information for symbols that are used.  For STABS
7966 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7967 This is by default ON@.
7969 @item -gfull
7970 @opindex -gfull
7971 Emit debugging information for all symbols and types.
7973 @item -mmacosx-version-min=@var{version}
7974 The earliest version of MacOS X that this executable will run on
7975 is @var{version}.  Typical values of @var{version} include @code{10.1},
7976 @code{10.2}, and @code{10.3.9}.
7978 The default for this option is to make choices that seem to be most
7979 useful.  
7981 @item -mone-byte-bool
7982 @opindex -mone-byte-bool
7983 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7984 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7985 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7986 option has no effect on x86.
7988 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7989 to generate code that is not binary compatible with code generated
7990 without that switch.  Using this switch may require recompiling all
7991 other modules in a program, including system libraries.  Use this
7992 switch to conform to a non-default data model.
7994 @item -mfix-and-continue
7995 @itemx -ffix-and-continue
7996 @itemx -findirect-data
7997 @opindex mfix-and-continue
7998 @opindex ffix-and-continue
7999 @opindex findirect-data
8000 Generate code suitable for fast turn around development.  Needed to
8001 enable gdb to dynamically load @code{.o} files into already running
8002 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
8003 are provided for backwards compatibility.
8005 @item -all_load
8006 @opindex all_load
8007 Loads all members of static archive libraries.
8008 See man ld(1) for more information.
8010 @item -arch_errors_fatal
8011 @opindex arch_errors_fatal
8012 Cause the errors having to do with files that have the wrong architecture
8013 to be fatal.
8015 @item -bind_at_load
8016 @opindex bind_at_load
8017 Causes the output file to be marked such that the dynamic linker will
8018 bind all undefined references when the file is loaded or launched.
8020 @item -bundle
8021 @opindex bundle
8022 Produce a Mach-o bundle format file.
8023 See man ld(1) for more information.
8025 @item -bundle_loader @var{executable}
8026 @opindex bundle_loader
8027 This option specifies the @var{executable} that will be loading the build
8028 output file being linked.  See man ld(1) for more information.
8030 @item -dynamiclib
8031 @opindex -dynamiclib
8032 When passed this option, GCC will produce a dynamic library instead of
8033 an executable when linking, using the Darwin @file{libtool} command.
8035 @item -force_cpusubtype_ALL
8036 @opindex -force_cpusubtype_ALL
8037 This causes GCC's output file to have the @var{ALL} subtype, instead of
8038 one controlled by the @option{-mcpu} or @option{-march} option.
8040 @item -allowable_client  @var{client_name}
8041 @itemx -client_name
8042 @itemx -compatibility_version
8043 @itemx -current_version
8044 @itemx -dead_strip
8045 @itemx -dependency-file
8046 @itemx -dylib_file
8047 @itemx -dylinker_install_name
8048 @itemx -dynamic
8049 @itemx -exported_symbols_list
8050 @itemx -filelist
8051 @itemx -flat_namespace
8052 @itemx -force_flat_namespace
8053 @itemx -headerpad_max_install_names
8054 @itemx -image_base
8055 @itemx -init
8056 @itemx -install_name
8057 @itemx -keep_private_externs
8058 @itemx -multi_module
8059 @itemx -multiply_defined
8060 @itemx -multiply_defined_unused
8061 @itemx -noall_load
8062 @itemx -no_dead_strip_inits_and_terms
8063 @itemx -nofixprebinding
8064 @itemx -nomultidefs
8065 @itemx -noprebind
8066 @itemx -noseglinkedit
8067 @itemx -pagezero_size
8068 @itemx -prebind
8069 @itemx -prebind_all_twolevel_modules
8070 @itemx -private_bundle
8071 @itemx -read_only_relocs
8072 @itemx -sectalign
8073 @itemx -sectobjectsymbols
8074 @itemx -whyload
8075 @itemx -seg1addr
8076 @itemx -sectcreate
8077 @itemx -sectobjectsymbols
8078 @itemx -sectorder
8079 @itemx -segaddr
8080 @itemx -segs_read_only_addr
8081 @itemx -segs_read_write_addr
8082 @itemx -seg_addr_table
8083 @itemx -seg_addr_table_filename
8084 @itemx -seglinkedit
8085 @itemx -segprot
8086 @itemx -segs_read_only_addr
8087 @itemx -segs_read_write_addr
8088 @itemx -single_module
8089 @itemx -static
8090 @itemx -sub_library
8091 @itemx -sub_umbrella
8092 @itemx -twolevel_namespace
8093 @itemx -umbrella
8094 @itemx -undefined
8095 @itemx -unexported_symbols_list
8096 @itemx -weak_reference_mismatches
8097 @itemx -whatsloaded
8099 @opindex allowable_client
8100 @opindex client_name
8101 @opindex compatibility_version
8102 @opindex current_version
8103 @opindex dead_strip
8104 @opindex dependency-file
8105 @opindex dylib_file
8106 @opindex dylinker_install_name
8107 @opindex dynamic
8108 @opindex exported_symbols_list
8109 @opindex filelist
8110 @opindex flat_namespace
8111 @opindex force_flat_namespace
8112 @opindex headerpad_max_install_names
8113 @opindex image_base
8114 @opindex init
8115 @opindex install_name
8116 @opindex keep_private_externs
8117 @opindex multi_module
8118 @opindex multiply_defined
8119 @opindex multiply_defined_unused
8120 @opindex noall_load
8121 @opindex no_dead_strip_inits_and_terms
8122 @opindex nofixprebinding
8123 @opindex nomultidefs
8124 @opindex noprebind
8125 @opindex noseglinkedit
8126 @opindex pagezero_size
8127 @opindex prebind
8128 @opindex prebind_all_twolevel_modules
8129 @opindex private_bundle
8130 @opindex read_only_relocs
8131 @opindex sectalign
8132 @opindex sectobjectsymbols
8133 @opindex whyload
8134 @opindex seg1addr
8135 @opindex sectcreate
8136 @opindex sectobjectsymbols
8137 @opindex sectorder
8138 @opindex segaddr
8139 @opindex segs_read_only_addr
8140 @opindex segs_read_write_addr
8141 @opindex seg_addr_table
8142 @opindex seg_addr_table_filename
8143 @opindex seglinkedit
8144 @opindex segprot
8145 @opindex segs_read_only_addr
8146 @opindex segs_read_write_addr
8147 @opindex single_module
8148 @opindex static
8149 @opindex sub_library
8150 @opindex sub_umbrella
8151 @opindex twolevel_namespace
8152 @opindex umbrella
8153 @opindex undefined
8154 @opindex unexported_symbols_list
8155 @opindex weak_reference_mismatches
8156 @opindex whatsloaded
8158 These options are passed to the Darwin linker.  The Darwin linker man page
8159 describes them in detail.
8160 @end table
8162 @node DEC Alpha Options
8163 @subsection DEC Alpha Options
8165 These @samp{-m} options are defined for the DEC Alpha implementations:
8167 @table @gcctabopt
8168 @item -mno-soft-float
8169 @itemx -msoft-float
8170 @opindex mno-soft-float
8171 @opindex msoft-float
8172 Use (do not use) the hardware floating-point instructions for
8173 floating-point operations.  When @option{-msoft-float} is specified,
8174 functions in @file{libgcc.a} will be used to perform floating-point
8175 operations.  Unless they are replaced by routines that emulate the
8176 floating-point operations, or compiled in such a way as to call such
8177 emulations routines, these routines will issue floating-point
8178 operations.   If you are compiling for an Alpha without floating-point
8179 operations, you must ensure that the library is built so as not to call
8180 them.
8182 Note that Alpha implementations without floating-point operations are
8183 required to have floating-point registers.
8185 @item -mfp-reg
8186 @itemx -mno-fp-regs
8187 @opindex mfp-reg
8188 @opindex mno-fp-regs
8189 Generate code that uses (does not use) the floating-point register set.
8190 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
8191 register set is not used, floating point operands are passed in integer
8192 registers as if they were integers and floating-point results are passed
8193 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
8194 so any function with a floating-point argument or return value called by code
8195 compiled with @option{-mno-fp-regs} must also be compiled with that
8196 option.
8198 A typical use of this option is building a kernel that does not use,
8199 and hence need not save and restore, any floating-point registers.
8201 @item -mieee
8202 @opindex mieee
8203 The Alpha architecture implements floating-point hardware optimized for
8204 maximum performance.  It is mostly compliant with the IEEE floating
8205 point standard.  However, for full compliance, software assistance is
8206 required.  This option generates code fully IEEE compliant code
8207 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8208 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8209 defined during compilation.  The resulting code is less efficient but is
8210 able to correctly support denormalized numbers and exceptional IEEE
8211 values such as not-a-number and plus/minus infinity.  Other Alpha
8212 compilers call this option @option{-ieee_with_no_inexact}.
8214 @item -mieee-with-inexact
8215 @opindex mieee-with-inexact
8216 This is like @option{-mieee} except the generated code also maintains
8217 the IEEE @var{inexact-flag}.  Turning on this option causes the
8218 generated code to implement fully-compliant IEEE math.  In addition to
8219 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8220 macro.  On some Alpha implementations the resulting code may execute
8221 significantly slower than the code generated by default.  Since there is
8222 very little code that depends on the @var{inexact-flag}, you should
8223 normally not specify this option.  Other Alpha compilers call this
8224 option @option{-ieee_with_inexact}.
8226 @item -mfp-trap-mode=@var{trap-mode}
8227 @opindex mfp-trap-mode
8228 This option controls what floating-point related traps are enabled.
8229 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8230 The trap mode can be set to one of four values:
8232 @table @samp
8233 @item n
8234 This is the default (normal) setting.  The only traps that are enabled
8235 are the ones that cannot be disabled in software (e.g., division by zero
8236 trap).
8238 @item u
8239 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8240 as well.
8242 @item su
8243 Like @samp{su}, but the instructions are marked to be safe for software
8244 completion (see Alpha architecture manual for details).
8246 @item sui
8247 Like @samp{su}, but inexact traps are enabled as well.
8248 @end table
8250 @item -mfp-rounding-mode=@var{rounding-mode}
8251 @opindex mfp-rounding-mode
8252 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8253 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8256 @table @samp
8257 @item n
8258 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8259 the nearest machine number or towards the even machine number in case
8260 of a tie.
8262 @item m
8263 Round towards minus infinity.
8265 @item c
8266 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8268 @item d
8269 Dynamic rounding mode.  A field in the floating point control register
8270 (@var{fpcr}, see Alpha architecture reference manual) controls the
8271 rounding mode in effect.  The C library initializes this register for
8272 rounding towards plus infinity.  Thus, unless your program modifies the
8273 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8274 @end table
8276 @item -mtrap-precision=@var{trap-precision}
8277 @opindex mtrap-precision
8278 In the Alpha architecture, floating point traps are imprecise.  This
8279 means without software assistance it is impossible to recover from a
8280 floating trap and program execution normally needs to be terminated.
8281 GCC can generate code that can assist operating system trap handlers
8282 in determining the exact location that caused a floating point trap.
8283 Depending on the requirements of an application, different levels of
8284 precisions can be selected:
8286 @table @samp
8287 @item p
8288 Program precision.  This option is the default and means a trap handler
8289 can only identify which program caused a floating point exception.
8291 @item f
8292 Function precision.  The trap handler can determine the function that
8293 caused a floating point exception.
8295 @item i
8296 Instruction precision.  The trap handler can determine the exact
8297 instruction that caused a floating point exception.
8298 @end table
8300 Other Alpha compilers provide the equivalent options called
8301 @option{-scope_safe} and @option{-resumption_safe}.
8303 @item -mieee-conformant
8304 @opindex mieee-conformant
8305 This option marks the generated code as IEEE conformant.  You must not
8306 use this option unless you also specify @option{-mtrap-precision=i} and either
8307 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8308 is to emit the line @samp{.eflag 48} in the function prologue of the
8309 generated assembly file.  Under DEC Unix, this has the effect that
8310 IEEE-conformant math library routines will be linked in.
8312 @item -mbuild-constants
8313 @opindex mbuild-constants
8314 Normally GCC examines a 32- or 64-bit integer constant to
8315 see if it can construct it from smaller constants in two or three
8316 instructions.  If it cannot, it will output the constant as a literal and
8317 generate code to load it from the data segment at runtime.
8319 Use this option to require GCC to construct @emph{all} integer constants
8320 using code, even if it takes more instructions (the maximum is six).
8322 You would typically use this option to build a shared library dynamic
8323 loader.  Itself a shared library, it must relocate itself in memory
8324 before it can find the variables and constants in its own data segment.
8326 @item -malpha-as
8327 @itemx -mgas
8328 @opindex malpha-as
8329 @opindex mgas
8330 Select whether to generate code to be assembled by the vendor-supplied
8331 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8333 @item -mbwx
8334 @itemx -mno-bwx
8335 @itemx -mcix
8336 @itemx -mno-cix
8337 @itemx -mfix
8338 @itemx -mno-fix
8339 @itemx -mmax
8340 @itemx -mno-max
8341 @opindex mbwx
8342 @opindex mno-bwx
8343 @opindex mcix
8344 @opindex mno-cix
8345 @opindex mfix
8346 @opindex mno-fix
8347 @opindex mmax
8348 @opindex mno-max
8349 Indicate whether GCC should generate code to use the optional BWX,
8350 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8351 sets supported by the CPU type specified via @option{-mcpu=} option or that
8352 of the CPU on which GCC was built if none was specified.
8354 @item -mfloat-vax
8355 @itemx -mfloat-ieee
8356 @opindex mfloat-vax
8357 @opindex mfloat-ieee
8358 Generate code that uses (does not use) VAX F and G floating point
8359 arithmetic instead of IEEE single and double precision.
8361 @item -mexplicit-relocs
8362 @itemx -mno-explicit-relocs
8363 @opindex mexplicit-relocs
8364 @opindex mno-explicit-relocs
8365 Older Alpha assemblers provided no way to generate symbol relocations
8366 except via assembler macros.  Use of these macros does not allow
8367 optimal instruction scheduling.  GNU binutils as of version 2.12
8368 supports a new syntax that allows the compiler to explicitly mark
8369 which relocations should apply to which instructions.  This option
8370 is mostly useful for debugging, as GCC detects the capabilities of
8371 the assembler when it is built and sets the default accordingly.
8373 @item -msmall-data
8374 @itemx -mlarge-data
8375 @opindex msmall-data
8376 @opindex mlarge-data
8377 When @option{-mexplicit-relocs} is in effect, static data is
8378 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8379 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8380 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8381 16-bit relocations off of the @code{$gp} register.  This limits the
8382 size of the small data area to 64KB, but allows the variables to be
8383 directly accessed via a single instruction.
8385 The default is @option{-mlarge-data}.  With this option the data area
8386 is limited to just below 2GB@.  Programs that require more than 2GB of
8387 data must use @code{malloc} or @code{mmap} to allocate the data in the
8388 heap instead of in the program's data segment.
8390 When generating code for shared libraries, @option{-fpic} implies
8391 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8393 @item -msmall-text
8394 @itemx -mlarge-text
8395 @opindex msmall-text
8396 @opindex mlarge-text
8397 When @option{-msmall-text} is used, the compiler assumes that the
8398 code of the entire program (or shared library) fits in 4MB, and is
8399 thus reachable with a branch instruction.  When @option{-msmall-data}
8400 is used, the compiler can assume that all local symbols share the
8401 same @code{$gp} value, and thus reduce the number of instructions
8402 required for a function call from 4 to 1.
8404 The default is @option{-mlarge-text}.
8406 @item -mcpu=@var{cpu_type}
8407 @opindex mcpu
8408 Set the instruction set and instruction scheduling parameters for
8409 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8410 style name or the corresponding chip number.  GCC supports scheduling
8411 parameters for the EV4, EV5 and EV6 family of processors and will
8412 choose the default values for the instruction set from the processor
8413 you specify.  If you do not specify a processor type, GCC will default
8414 to the processor on which the compiler was built.
8416 Supported values for @var{cpu_type} are
8418 @table @samp
8419 @item ev4
8420 @itemx ev45
8421 @itemx 21064
8422 Schedules as an EV4 and has no instruction set extensions.
8424 @item ev5
8425 @itemx 21164
8426 Schedules as an EV5 and has no instruction set extensions.
8428 @item ev56
8429 @itemx 21164a
8430 Schedules as an EV5 and supports the BWX extension.
8432 @item pca56
8433 @itemx 21164pc
8434 @itemx 21164PC
8435 Schedules as an EV5 and supports the BWX and MAX extensions.
8437 @item ev6
8438 @itemx 21264
8439 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8441 @item ev67
8442 @itemx 21264a
8443 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8444 @end table
8446 @item -mtune=@var{cpu_type}
8447 @opindex mtune
8448 Set only the instruction scheduling parameters for machine type
8449 @var{cpu_type}.  The instruction set is not changed.
8451 @item -mmemory-latency=@var{time}
8452 @opindex mmemory-latency
8453 Sets the latency the scheduler should assume for typical memory
8454 references as seen by the application.  This number is highly
8455 dependent on the memory access patterns used by the application
8456 and the size of the external cache on the machine.
8458 Valid options for @var{time} are
8460 @table @samp
8461 @item @var{number}
8462 A decimal number representing clock cycles.
8464 @item L1
8465 @itemx L2
8466 @itemx L3
8467 @itemx main
8468 The compiler contains estimates of the number of clock cycles for
8469 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8470 (also called Dcache, Scache, and Bcache), as well as to main memory.
8471 Note that L3 is only valid for EV5.
8473 @end table
8474 @end table
8476 @node DEC Alpha/VMS Options
8477 @subsection DEC Alpha/VMS Options
8479 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8481 @table @gcctabopt
8482 @item -mvms-return-codes
8483 @opindex mvms-return-codes
8484 Return VMS condition codes from main.  The default is to return POSIX
8485 style condition (e.g.@ error) codes.
8486 @end table
8488 @node FRV Options
8489 @subsection FRV Options
8490 @cindex FRV Options
8492 @table @gcctabopt
8493 @item -mgpr-32
8494 @opindex mgpr-32
8496 Only use the first 32 general purpose registers.
8498 @item -mgpr-64
8499 @opindex mgpr-64
8501 Use all 64 general purpose registers.
8503 @item -mfpr-32
8504 @opindex mfpr-32
8506 Use only the first 32 floating point registers.
8508 @item -mfpr-64
8509 @opindex mfpr-64
8511 Use all 64 floating point registers
8513 @item -mhard-float
8514 @opindex mhard-float
8516 Use hardware instructions for floating point operations.
8518 @item -msoft-float
8519 @opindex msoft-float
8521 Use library routines for floating point operations.
8523 @item -malloc-cc
8524 @opindex malloc-cc
8526 Dynamically allocate condition code registers.
8528 @item -mfixed-cc
8529 @opindex mfixed-cc
8531 Do not try to dynamically allocate condition code registers, only
8532 use @code{icc0} and @code{fcc0}.
8534 @item -mdword
8535 @opindex mdword
8537 Change ABI to use double word insns.
8539 @item -mno-dword
8540 @opindex mno-dword
8542 Do not use double word instructions.
8544 @item -mdouble
8545 @opindex mdouble
8547 Use floating point double instructions.
8549 @item -mno-double
8550 @opindex mno-double
8552 Do not use floating point double instructions.
8554 @item -mmedia
8555 @opindex mmedia
8557 Use media instructions.
8559 @item -mno-media
8560 @opindex mno-media
8562 Do not use media instructions.
8564 @item -mmuladd
8565 @opindex mmuladd
8567 Use multiply and add/subtract instructions.
8569 @item -mno-muladd
8570 @opindex mno-muladd
8572 Do not use multiply and add/subtract instructions.
8574 @item -mfdpic
8575 @opindex mfdpic
8577 Select the FDPIC ABI, that uses function descriptors to represent
8578 pointers to functions.  Without any PIC/PIE-related options, it
8579 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8580 assumes GOT entries and small data are within a 12-bit range from the
8581 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8582 are computed with 32 bits.
8584 @item -minline-plt
8585 @opindex minline-plt
8587 Enable inlining of PLT entries in function calls to functions that are
8588 not known to bind locally.  It has no effect without @option{-mfdpic}.
8589 It's enabled by default if optimizing for speed and compiling for
8590 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8591 optimization option such as @option{-O3} or above is present in the
8592 command line.
8594 @item -mTLS
8595 @opindex TLS
8597 Assume a large TLS segment when generating thread-local code.
8599 @item -mtls
8600 @opindex tls
8602 Do not assume a large TLS segment when generating thread-local code.
8604 @item -mgprel-ro
8605 @opindex mgprel-ro
8607 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8608 that is known to be in read-only sections.  It's enabled by default,
8609 except for @option{-fpic} or @option{-fpie}: even though it may help
8610 make the global offset table smaller, it trades 1 instruction for 4.
8611 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8612 one of which may be shared by multiple symbols, and it avoids the need
8613 for a GOT entry for the referenced symbol, so it's more likely to be a
8614 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8616 @item -multilib-library-pic
8617 @opindex multilib-library-pic
8619 Link with the (library, not FD) pic libraries.  It's implied by
8620 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8621 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8622 it explicitly.
8624 @item -mlinked-fp
8625 @opindex mlinked-fp
8627 Follow the EABI requirement of always creating a frame pointer whenever
8628 a stack frame is allocated.  This option is enabled by default and can
8629 be disabled with @option{-mno-linked-fp}.
8631 @item -mlong-calls
8632 @opindex mlong-calls
8634 Use indirect addressing to call functions outside the current
8635 compilation unit.  This allows the functions to be placed anywhere
8636 within the 32-bit address space.
8638 @item -malign-labels
8639 @opindex malign-labels
8641 Try to align labels to an 8-byte boundary by inserting nops into the
8642 previous packet.  This option only has an effect when VLIW packing
8643 is enabled.  It doesn't create new packets; it merely adds nops to
8644 existing ones.
8646 @item -mlibrary-pic
8647 @opindex mlibrary-pic
8649 Generate position-independent EABI code.
8651 @item -macc-4
8652 @opindex macc-4
8654 Use only the first four media accumulator registers.
8656 @item -macc-8
8657 @opindex macc-8
8659 Use all eight media accumulator registers.
8661 @item -mpack
8662 @opindex mpack
8664 Pack VLIW instructions.
8666 @item -mno-pack
8667 @opindex mno-pack
8669 Do not pack VLIW instructions.
8671 @item -mno-eflags
8672 @opindex mno-eflags
8674 Do not mark ABI switches in e_flags.
8676 @item -mcond-move
8677 @opindex mcond-move
8679 Enable the use of conditional-move instructions (default).
8681 This switch is mainly for debugging the compiler and will likely be removed
8682 in a future version.
8684 @item -mno-cond-move
8685 @opindex mno-cond-move
8687 Disable the use of conditional-move instructions.
8689 This switch is mainly for debugging the compiler and will likely be removed
8690 in a future version.
8692 @item -mscc
8693 @opindex mscc
8695 Enable the use of conditional set instructions (default).
8697 This switch is mainly for debugging the compiler and will likely be removed
8698 in a future version.
8700 @item -mno-scc
8701 @opindex mno-scc
8703 Disable the use of conditional set instructions.
8705 This switch is mainly for debugging the compiler and will likely be removed
8706 in a future version.
8708 @item -mcond-exec
8709 @opindex mcond-exec
8711 Enable the use of conditional execution (default).
8713 This switch is mainly for debugging the compiler and will likely be removed
8714 in a future version.
8716 @item -mno-cond-exec
8717 @opindex mno-cond-exec
8719 Disable the use of conditional execution.
8721 This switch is mainly for debugging the compiler and will likely be removed
8722 in a future version.
8724 @item -mvliw-branch
8725 @opindex mvliw-branch
8727 Run a pass to pack branches into VLIW instructions (default).
8729 This switch is mainly for debugging the compiler and will likely be removed
8730 in a future version.
8732 @item -mno-vliw-branch
8733 @opindex mno-vliw-branch
8735 Do not run a pass to pack branches into VLIW instructions.
8737 This switch is mainly for debugging the compiler and will likely be removed
8738 in a future version.
8740 @item -mmulti-cond-exec
8741 @opindex mmulti-cond-exec
8743 Enable optimization of @code{&&} and @code{||} in conditional execution
8744 (default).
8746 This switch is mainly for debugging the compiler and will likely be removed
8747 in a future version.
8749 @item -mno-multi-cond-exec
8750 @opindex mno-multi-cond-exec
8752 Disable optimization of @code{&&} and @code{||} in conditional execution.
8754 This switch is mainly for debugging the compiler and will likely be removed
8755 in a future version.
8757 @item -mnested-cond-exec
8758 @opindex mnested-cond-exec
8760 Enable nested conditional execution optimizations (default).
8762 This switch is mainly for debugging the compiler and will likely be removed
8763 in a future version.
8765 @item -mno-nested-cond-exec
8766 @opindex mno-nested-cond-exec
8768 Disable nested conditional execution optimizations.
8770 This switch is mainly for debugging the compiler and will likely be removed
8771 in a future version.
8773 @item -moptimize-membar
8774 @opindex moptimize-membar
8776 This switch removes redundant @code{membar} instructions from the
8777 compiler generated code.  It is enabled by default.
8779 @item -mno-optimize-membar
8780 @opindex mno-optimize-membar
8782 This switch disables the automatic removal of redundant @code{membar}
8783 instructions from the generated code.
8785 @item -mtomcat-stats
8786 @opindex mtomcat-stats
8788 Cause gas to print out tomcat statistics.
8790 @item -mcpu=@var{cpu}
8791 @opindex mcpu
8793 Select the processor type for which to generate code.  Possible values are
8794 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8795 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8797 @end table
8799 @node GNU/Linux Options
8800 @subsection GNU/Linux Options
8802 These @samp{-m} options are defined for GNU/Linux targets:
8804 @table @gcctabopt
8805 @item -mglibc
8806 @opindex mglibc
8807 Use the GNU C library instead of uClibc.  This is the default except
8808 on @samp{*-*-linux-*uclibc*} targets.
8810 @item -muclibc
8811 @opindex muclibc
8812 Use uClibc instead of the GNU C library.  This is the default on
8813 @samp{*-*-linux-*uclibc*} targets.
8814 @end table
8816 @node H8/300 Options
8817 @subsection H8/300 Options
8819 These @samp{-m} options are defined for the H8/300 implementations:
8821 @table @gcctabopt
8822 @item -mrelax
8823 @opindex mrelax
8824 Shorten some address references at link time, when possible; uses the
8825 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8826 ld, Using ld}, for a fuller description.
8828 @item -mh
8829 @opindex mh
8830 Generate code for the H8/300H@.
8832 @item -ms
8833 @opindex ms
8834 Generate code for the H8S@.
8836 @item -mn
8837 @opindex mn
8838 Generate code for the H8S and H8/300H in the normal mode.  This switch
8839 must be used either with @option{-mh} or @option{-ms}.
8841 @item -ms2600
8842 @opindex ms2600
8843 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8845 @item -mint32
8846 @opindex mint32
8847 Make @code{int} data 32 bits by default.
8849 @item -malign-300
8850 @opindex malign-300
8851 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8852 The default for the H8/300H and H8S is to align longs and floats on 4
8853 byte boundaries.
8854 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8855 This option has no effect on the H8/300.
8856 @end table
8858 @node HPPA Options
8859 @subsection HPPA Options
8860 @cindex HPPA Options
8862 These @samp{-m} options are defined for the HPPA family of computers:
8864 @table @gcctabopt
8865 @item -march=@var{architecture-type}
8866 @opindex march
8867 Generate code for the specified architecture.  The choices for
8868 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8869 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8870 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8871 architecture option for your machine.  Code compiled for lower numbered
8872 architectures will run on higher numbered architectures, but not the
8873 other way around.
8875 @item -mpa-risc-1-0
8876 @itemx -mpa-risc-1-1
8877 @itemx -mpa-risc-2-0
8878 @opindex mpa-risc-1-0
8879 @opindex mpa-risc-1-1
8880 @opindex mpa-risc-2-0
8881 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8883 @item -mbig-switch
8884 @opindex mbig-switch
8885 Generate code suitable for big switch tables.  Use this option only if
8886 the assembler/linker complain about out of range branches within a switch
8887 table.
8889 @item -mjump-in-delay
8890 @opindex mjump-in-delay
8891 Fill delay slots of function calls with unconditional jump instructions
8892 by modifying the return pointer for the function call to be the target
8893 of the conditional jump.
8895 @item -mdisable-fpregs
8896 @opindex mdisable-fpregs
8897 Prevent floating point registers from being used in any manner.  This is
8898 necessary for compiling kernels which perform lazy context switching of
8899 floating point registers.  If you use this option and attempt to perform
8900 floating point operations, the compiler will abort.
8902 @item -mdisable-indexing
8903 @opindex mdisable-indexing
8904 Prevent the compiler from using indexing address modes.  This avoids some
8905 rather obscure problems when compiling MIG generated code under MACH@.
8907 @item -mno-space-regs
8908 @opindex mno-space-regs
8909 Generate code that assumes the target has no space registers.  This allows
8910 GCC to generate faster indirect calls and use unscaled index address modes.
8912 Such code is suitable for level 0 PA systems and kernels.
8914 @item -mfast-indirect-calls
8915 @opindex mfast-indirect-calls
8916 Generate code that assumes calls never cross space boundaries.  This
8917 allows GCC to emit code which performs faster indirect calls.
8919 This option will not work in the presence of shared libraries or nested
8920 functions.
8922 @item -mfixed-range=@var{register-range}
8923 @opindex mfixed-range
8924 Generate code treating the given register range as fixed registers.
8925 A fixed register is one that the register allocator can not use.  This is
8926 useful when compiling kernel code.  A register range is specified as
8927 two registers separated by a dash.  Multiple register ranges can be
8928 specified separated by a comma.
8930 @item -mlong-load-store
8931 @opindex mlong-load-store
8932 Generate 3-instruction load and store sequences as sometimes required by
8933 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8934 the HP compilers.
8936 @item -mportable-runtime
8937 @opindex mportable-runtime
8938 Use the portable calling conventions proposed by HP for ELF systems.
8940 @item -mgas
8941 @opindex mgas
8942 Enable the use of assembler directives only GAS understands.
8944 @item -mschedule=@var{cpu-type}
8945 @opindex mschedule
8946 Schedule code according to the constraints for the machine type
8947 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8948 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8949 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8950 proper scheduling option for your machine.  The default scheduling is
8951 @samp{8000}.
8953 @item -mlinker-opt
8954 @opindex mlinker-opt
8955 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8956 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8957 linkers in which they give bogus error messages when linking some programs.
8959 @item -msoft-float
8960 @opindex msoft-float
8961 Generate output containing library calls for floating point.
8962 @strong{Warning:} the requisite libraries are not available for all HPPA
8963 targets.  Normally the facilities of the machine's usual C compiler are
8964 used, but this cannot be done directly in cross-compilation.  You must make
8965 your own arrangements to provide suitable library functions for
8966 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8967 does provide software floating point support.
8969 @option{-msoft-float} changes the calling convention in the output file;
8970 therefore, it is only useful if you compile @emph{all} of a program with
8971 this option.  In particular, you need to compile @file{libgcc.a}, the
8972 library that comes with GCC, with @option{-msoft-float} in order for
8973 this to work.
8975 @item -msio
8976 @opindex msio
8977 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8978 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8979 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8980 options are available under HP-UX and HI-UX@.
8982 @item -mgnu-ld
8983 @opindex gnu-ld
8984 Use GNU ld specific options.  This passes @option{-shared} to ld when
8985 building a shared library.  It is the default when GCC is configured,
8986 explicitly or implicitly, with the GNU linker.  This option does not
8987 have any affect on which ld is called, it only changes what parameters
8988 are passed to that ld.  The ld that is called is determined by the
8989 @option{--with-ld} configure option, GCC's program search path, and
8990 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8991 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
8992 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8994 @item -mhp-ld
8995 @opindex hp-ld
8996 Use HP ld specific options.  This passes @option{-b} to ld when building
8997 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8998 links.  It is the default when GCC is configured, explicitly or
8999 implicitly, with the HP linker.  This option does not have any affect on
9000 which ld is called, it only changes what parameters are passed to that
9001 ld.  The ld that is called is determined by the @option{--with-ld}
9002 configure option, GCC's program search path, and finally by the user's
9003 @env{PATH}.  The linker used by GCC can be printed using @samp{which
9004 `gcc -print-prog-name=ld`}.  This option is only available on the 64 bit
9005 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9007 @item -mlong-calls
9008 @opindex mno-long-calls
9009 Generate code that uses long call sequences.  This ensures that a call
9010 is always able to reach linker generated stubs.  The default is to generate
9011 long calls only when the distance from the call site to the beginning
9012 of the function or translation unit, as the case may be, exceeds a
9013 predefined limit set by the branch type being used.  The limits for
9014 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9015 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
9016 240,000 bytes.
9018 Distances are measured from the beginning of functions when using the
9019 @option{-ffunction-sections} option, or when using the @option{-mgas}
9020 and @option{-mno-portable-runtime} options together under HP-UX with
9021 the SOM linker.
9023 It is normally not desirable to use this option as it will degrade
9024 performance.  However, it may be useful in large applications,
9025 particularly when partial linking is used to build the application.
9027 The types of long calls used depends on the capabilities of the
9028 assembler and linker, and the type of code being generated.  The
9029 impact on systems that support long absolute calls, and long pic
9030 symbol-difference or pc-relative calls should be relatively small.
9031 However, an indirect call is used on 32-bit ELF systems in pic code
9032 and it is quite long.
9034 @item -munix=@var{unix-std}
9035 @opindex march
9036 Generate compiler predefines and select a startfile for the specified
9037 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
9038 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
9039 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
9040 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
9041 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9042 and later.
9044 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9045 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9046 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9047 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9048 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9049 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9051 It is @emph{important} to note that this option changes the interfaces
9052 for various library routines.  It also affects the operational behavior
9053 of the C library.  Thus, @emph{extreme} care is needed in using this
9054 option.
9056 Library code that is intended to operate with more than one UNIX
9057 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9058 as appropriate.  Most GNU software doesn't provide this capability.
9060 @item -nolibdld
9061 @opindex nolibdld
9062 Suppress the generation of link options to search libdld.sl when the
9063 @option{-static} option is specified on HP-UX 10 and later.
9065 @item -static
9066 @opindex static
9067 The HP-UX implementation of setlocale in libc has a dependency on
9068 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
9069 when the @option{-static} option is specified, special link options
9070 are needed to resolve this dependency.
9072 On HP-UX 10 and later, the GCC driver adds the necessary options to
9073 link with libdld.sl when the @option{-static} option is specified.
9074 This causes the resulting binary to be dynamic.  On the 64-bit port,
9075 the linkers generate dynamic binaries by default in any case.  The
9076 @option{-nolibdld} option can be used to prevent the GCC driver from
9077 adding these link options.
9079 @item -threads
9080 @opindex threads
9081 Add support for multithreading with the @dfn{dce thread} library
9082 under HP-UX@.  This option sets flags for both the preprocessor and
9083 linker.
9084 @end table
9086 @node i386 and x86-64 Options
9087 @subsection Intel 386 and AMD x86-64 Options
9088 @cindex i386 Options
9089 @cindex x86-64 Options
9090 @cindex Intel 386 Options
9091 @cindex AMD x86-64 Options
9093 These @samp{-m} options are defined for the i386 and x86-64 family of
9094 computers:
9096 @table @gcctabopt
9097 @item -mtune=@var{cpu-type}
9098 @opindex mtune
9099 Tune to @var{cpu-type} everything applicable about the generated code, except
9100 for the ABI and the set of available instructions.  The choices for
9101 @var{cpu-type} are:
9102 @table @emph
9103 @item generic
9104 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9105 If you know the CPU on which your code will run, then you should use
9106 the corresponding @option{-mtune} option instead of
9107 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
9108 of your application will have, then you should use this option.
9110 As new processors are deployed in the marketplace, the behavior of this
9111 option will change.  Therefore, if you upgrade to a newer version of
9112 GCC, the code generated option will change to reflect the processors
9113 that were most common when that version of GCC was released.
9115 There is no @option{-march=generic} option because @option{-march}
9116 indicates the instruction set the compiler can use, and there is no
9117 generic instruction set applicable to all processors.  In contrast,
9118 @option{-mtune} indicates the processor (or, in this case, collection of
9119 processors) for which the code is optimized.
9120 @item i386
9121 Original Intel's i386 CPU@.
9122 @item i486
9123 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
9124 @item i586, pentium
9125 Intel Pentium CPU with no MMX support.
9126 @item pentium-mmx
9127 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9128 @item pentiumpro
9129 Intel PentiumPro CPU@.
9130 @item i686
9131 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9132 instruction set will be used, so the code will run on all i686 familly chips.
9133 @item pentium2
9134 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9135 @item pentium3, pentium3m
9136 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9137 support.
9138 @item pentium-m
9139 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9140 support.  Used by Centrino notebooks.
9141 @item pentium4, pentium4m
9142 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9143 @item prescott
9144 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9145 set support.
9146 @item nocona
9147 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9148 SSE2 and SSE3 instruction set support.
9149 @item k6
9150 AMD K6 CPU with MMX instruction set support.
9151 @item k6-2, k6-3
9152 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9153 @item athlon, athlon-tbird
9154 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9155 support.
9156 @item athlon-4, athlon-xp, athlon-mp
9157 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9158 instruction set support.
9159 @item k8, opteron, athlon64, athlon-fx
9160 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
9161 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9162 @item winchip-c6
9163 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9164 set support.
9165 @item winchip2
9166 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9167 instruction set support.
9168 @item c3
9169 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
9170 implemented for this chip.)
9171 @item c3-2
9172 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
9173 implemented for this chip.)
9174 @end table
9176 While picking a specific @var{cpu-type} will schedule things appropriately
9177 for that particular chip, the compiler will not generate any code that
9178 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9179 being used.
9181 @item -march=@var{cpu-type}
9182 @opindex march
9183 Generate instructions for the machine type @var{cpu-type}.  The choices
9184 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
9185 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9187 @item -mcpu=@var{cpu-type}
9188 @opindex mcpu
9189 A deprecated synonym for @option{-mtune}.
9191 @item -m386
9192 @itemx -m486
9193 @itemx -mpentium
9194 @itemx -mpentiumpro
9195 @opindex m386
9196 @opindex m486
9197 @opindex mpentium
9198 @opindex mpentiumpro
9199 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9200 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9201 These synonyms are deprecated.
9203 @item -mfpmath=@var{unit}
9204 @opindex march
9205 Generate floating point arithmetics for selected unit @var{unit}.  The choices
9206 for @var{unit} are:
9208 @table @samp
9209 @item 387
9210 Use the standard 387 floating point coprocessor present majority of chips and
9211 emulated otherwise.  Code compiled with this option will run almost everywhere.
9212 The temporary results are computed in 80bit precision instead of precision
9213 specified by the type resulting in slightly different results compared to most
9214 of other chips.  See @option{-ffloat-store} for more detailed description.
9216 This is the default choice for i386 compiler.
9218 @item sse
9219 Use scalar floating point instructions present in the SSE instruction set.
9220 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9221 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
9222 instruction set supports only single precision arithmetics, thus the double and
9223 extended precision arithmetics is still done using 387.  Later version, present
9224 only in Pentium4 and the future AMD x86-64 chips supports double precision
9225 arithmetics too.
9227 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9228 or @option{-msse2} switches to enable SSE extensions and make this option
9229 effective.  For the x86-64 compiler, these extensions are enabled by default.
9231 The resulting code should be considerably faster in the majority of cases and avoid
9232 the numerical instability problems of 387 code, but may break some existing
9233 code that expects temporaries to be 80bit.
9235 This is the default choice for the x86-64 compiler.
9237 @item sse,387
9238 Attempt to utilize both instruction sets at once.  This effectively double the
9239 amount of available registers and on chips with separate execution units for
9240 387 and SSE the execution resources too.  Use this option with care, as it is
9241 still experimental, because the GCC register allocator does not model separate
9242 functional units well resulting in instable performance.
9243 @end table
9245 @item -masm=@var{dialect}
9246 @opindex masm=@var{dialect}
9247 Output asm instructions using selected @var{dialect}.  Supported
9248 choices are @samp{intel} or @samp{att} (the default one).  Darwin does
9249 not support @samp{intel}.
9251 @item -mieee-fp
9252 @itemx -mno-ieee-fp
9253 @opindex mieee-fp
9254 @opindex mno-ieee-fp
9255 Control whether or not the compiler uses IEEE floating point
9256 comparisons.  These handle correctly the case where the result of a
9257 comparison is unordered.
9259 @item -msoft-float
9260 @opindex msoft-float
9261 Generate output containing library calls for floating point.
9262 @strong{Warning:} the requisite libraries are not part of GCC@.
9263 Normally the facilities of the machine's usual C compiler are used, but
9264 this can't be done directly in cross-compilation.  You must make your
9265 own arrangements to provide suitable library functions for
9266 cross-compilation.
9268 On machines where a function returns floating point results in the 80387
9269 register stack, some floating point opcodes may be emitted even if
9270 @option{-msoft-float} is used.
9272 @item -mno-fp-ret-in-387
9273 @opindex mno-fp-ret-in-387
9274 Do not use the FPU registers for return values of functions.
9276 The usual calling convention has functions return values of types
9277 @code{float} and @code{double} in an FPU register, even if there
9278 is no FPU@.  The idea is that the operating system should emulate
9279 an FPU@.
9281 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9282 in ordinary CPU registers instead.
9284 @item -mno-fancy-math-387
9285 @opindex mno-fancy-math-387
9286 Some 387 emulators do not support the @code{sin}, @code{cos} and
9287 @code{sqrt} instructions for the 387.  Specify this option to avoid
9288 generating those instructions.  This option is the default on FreeBSD,
9289 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9290 indicates that the target cpu will always have an FPU and so the
9291 instruction will not need emulation.  As of revision 2.6.1, these
9292 instructions are not generated unless you also use the
9293 @option{-funsafe-math-optimizations} switch.
9295 @item -malign-double
9296 @itemx -mno-align-double
9297 @opindex malign-double
9298 @opindex mno-align-double
9299 Control whether GCC aligns @code{double}, @code{long double}, and
9300 @code{long long} variables on a two word boundary or a one word
9301 boundary.  Aligning @code{double} variables on a two word boundary will
9302 produce code that runs somewhat faster on a @samp{Pentium} at the
9303 expense of more memory.
9305 @strong{Warning:} if you use the @option{-malign-double} switch,
9306 structures containing the above types will be aligned differently than
9307 the published application binary interface specifications for the 386
9308 and will not be binary compatible with structures in code compiled
9309 without that switch.
9311 @item -m96bit-long-double
9312 @itemx -m128bit-long-double
9313 @opindex m96bit-long-double
9314 @opindex m128bit-long-double
9315 These switches control the size of @code{long double} type.  The i386
9316 application binary interface specifies the size to be 96 bits,
9317 so @option{-m96bit-long-double} is the default in 32 bit mode.
9319 Modern architectures (Pentium and newer) would prefer @code{long double}
9320 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9321 conforming to the ABI, this would not be possible.  So specifying a
9322 @option{-m128bit-long-double} will align @code{long double}
9323 to a 16 byte boundary by padding the @code{long double} with an additional
9324 32 bit zero.
9326 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9327 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9329 Notice that neither of these options enable any extra precision over the x87
9330 standard of 80 bits for a @code{long double}.
9332 @strong{Warning:} if you override the default value for your target ABI, the
9333 structures and arrays containing @code{long double} variables will change
9334 their size as well as function calling convention for function taking
9335 @code{long double} will be modified.  Hence they will not be binary
9336 compatible with arrays or structures in code compiled without that switch.
9338 @item -mmlarge-data-threshold=@var{number}
9339 @opindex mlarge-data-threshold=@var{number}
9340 When @option{-mcmodel=medium} is specified, the data greater than
9341 @var{threshold} are placed in large data section.  This value must be the
9342 same across all object linked into the binary and defaults to 65535.
9344 @item -msvr3-shlib
9345 @itemx -mno-svr3-shlib
9346 @opindex msvr3-shlib
9347 @opindex mno-svr3-shlib
9348 Control whether GCC places uninitialized local variables into the
9349 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9350 into @code{bss}.  These options are meaningful only on System V Release 3.
9352 @item -mrtd
9353 @opindex mrtd
9354 Use a different function-calling convention, in which functions that
9355 take a fixed number of arguments return with the @code{ret} @var{num}
9356 instruction, which pops their arguments while returning.  This saves one
9357 instruction in the caller since there is no need to pop the arguments
9358 there.
9360 You can specify that an individual function is called with this calling
9361 sequence with the function attribute @samp{stdcall}.  You can also
9362 override the @option{-mrtd} option by using the function attribute
9363 @samp{cdecl}.  @xref{Function Attributes}.
9365 @strong{Warning:} this calling convention is incompatible with the one
9366 normally used on Unix, so you cannot use it if you need to call
9367 libraries compiled with the Unix compiler.
9369 Also, you must provide function prototypes for all functions that
9370 take variable numbers of arguments (including @code{printf});
9371 otherwise incorrect code will be generated for calls to those
9372 functions.
9374 In addition, seriously incorrect code will result if you call a
9375 function with too many arguments.  (Normally, extra arguments are
9376 harmlessly ignored.)
9378 @item -mregparm=@var{num}
9379 @opindex mregparm
9380 Control how many registers are used to pass integer arguments.  By
9381 default, no registers are used to pass arguments, and at most 3
9382 registers can be used.  You can control this behavior for a specific
9383 function by using the function attribute @samp{regparm}.
9384 @xref{Function Attributes}.
9386 @strong{Warning:} if you use this switch, and
9387 @var{num} is nonzero, then you must build all modules with the same
9388 value, including any libraries.  This includes the system libraries and
9389 startup modules.
9391 @item -msseregparm
9392 @opindex msseregparm
9393 Use SSE register passing conventions for float and double arguments
9394 and return values.  You can control this behavior for a specific
9395 function by using the function attribute @samp{sseregparm}.
9396 @xref{Function Attributes}.
9398 @strong{Warning:} if you use this switch then you must build all
9399 modules with the same value, including any libraries.  This includes
9400 the system libraries and startup modules.
9402 @item -mpreferred-stack-boundary=@var{num}
9403 @opindex mpreferred-stack-boundary
9404 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9405 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9406 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9407 size (@option{-Os}), in which case the default is the minimum correct
9408 alignment (4 bytes for x86, and 8 bytes for x86-64).
9410 On Pentium and PentiumPro, @code{double} and @code{long double} values
9411 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9412 suffer significant run time performance penalties.  On Pentium III, the
9413 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9414 penalties if it is not 16 byte aligned.
9416 To ensure proper alignment of this values on the stack, the stack boundary
9417 must be as aligned as that required by any value stored on the stack.
9418 Further, every function must be generated such that it keeps the stack
9419 aligned.  Thus calling a function compiled with a higher preferred
9420 stack boundary from a function compiled with a lower preferred stack
9421 boundary will most likely misalign the stack.  It is recommended that
9422 libraries that use callbacks always use the default setting.
9424 This extra alignment does consume extra stack space, and generally
9425 increases code size.  Code that is sensitive to stack space usage, such
9426 as embedded systems and operating system kernels, may want to reduce the
9427 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9429 @item -mmmx
9430 @itemx -mno-mmx
9431 @item -msse
9432 @itemx -mno-sse
9433 @item -msse2
9434 @itemx -mno-sse2
9435 @item -msse3
9436 @itemx -mno-sse3
9437 @item -m3dnow
9438 @itemx -mno-3dnow
9439 @opindex mmmx
9440 @opindex mno-mmx
9441 @opindex msse
9442 @opindex mno-sse
9443 @opindex m3dnow
9444 @opindex mno-3dnow
9445 These switches enable or disable the use of instructions in the MMX,
9446 SSE, SSE2 or 3DNow! extended instruction sets.  These extensions are
9447 also available as built-in functions: see @ref{X86 Built-in Functions},
9448 for details of the functions enabled and disabled by these switches.
9450 To have SSE/SSE2 instructions generated automatically from floating-point
9451 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9453 These options will enable GCC to use these extended instructions in
9454 generated code, even without @option{-mfpmath=sse}.  Applications which
9455 perform runtime CPU detection must compile separate files for each
9456 supported architecture, using the appropriate flags.  In particular,
9457 the file containing the CPU detection code should be compiled without
9458 these options.
9460 @item -msselibm
9461 @opindex msselibm
9462 Use special versions of certain libm routines that come with an SSE
9463 ABI and an SSE implementation.  Useful together with @option{-mfpmath=sse}
9464 to avoid moving values between SSE registers and the x87 FP stack.
9466 @item -mpush-args
9467 @itemx -mno-push-args
9468 @opindex mpush-args
9469 @opindex mno-push-args
9470 Use PUSH operations to store outgoing parameters.  This method is shorter
9471 and usually equally fast as method using SUB/MOV operations and is enabled
9472 by default.  In some cases disabling it may improve performance because of
9473 improved scheduling and reduced dependencies.
9475 @item -maccumulate-outgoing-args
9476 @opindex maccumulate-outgoing-args
9477 If enabled, the maximum amount of space required for outgoing arguments will be
9478 computed in the function prologue.  This is faster on most modern CPUs
9479 because of reduced dependencies, improved scheduling and reduced stack usage
9480 when preferred stack boundary is not equal to 2.  The drawback is a notable
9481 increase in code size.  This switch implies @option{-mno-push-args}.
9483 @item -mthreads
9484 @opindex mthreads
9485 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9486 on thread-safe exception handling must compile and link all code with the
9487 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9488 @option{-D_MT}; when linking, it links in a special thread helper library
9489 @option{-lmingwthrd} which cleans up per thread exception handling data.
9491 @item -mno-align-stringops
9492 @opindex mno-align-stringops
9493 Do not align destination of inlined string operations.  This switch reduces
9494 code size and improves performance in case the destination is already aligned,
9495 but GCC doesn't know about it.
9497 @item -minline-all-stringops
9498 @opindex minline-all-stringops
9499 By default GCC inlines string operations only when destination is known to be
9500 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9501 size, but may improve performance of code that depends on fast memcpy, strlen
9502 and memset for short lengths.
9504 @item -momit-leaf-frame-pointer
9505 @opindex momit-leaf-frame-pointer
9506 Don't keep the frame pointer in a register for leaf functions.  This
9507 avoids the instructions to save, set up and restore frame pointers and
9508 makes an extra register available in leaf functions.  The option
9509 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9510 which might make debugging harder.
9512 @item -mtls-direct-seg-refs
9513 @itemx -mno-tls-direct-seg-refs
9514 @opindex mtls-direct-seg-refs
9515 Controls whether TLS variables may be accessed with offsets from the
9516 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9517 or whether the thread base pointer must be added.  Whether or not this
9518 is legal depends on the operating system, and whether it maps the
9519 segment to cover the entire TLS area.
9521 For systems that use GNU libc, the default is on.
9522 @end table
9524 These @samp{-m} switches are supported in addition to the above
9525 on AMD x86-64 processors in 64-bit environments.
9527 @table @gcctabopt
9528 @item -m32
9529 @itemx -m64
9530 @opindex m32
9531 @opindex m64
9532 Generate code for a 32-bit or 64-bit environment.
9533 The 32-bit environment sets int, long and pointer to 32 bits and
9534 generates code that runs on any i386 system.
9535 The 64-bit environment sets int to 32 bits and long and pointer
9536 to 64 bits and generates code for AMD's x86-64 architecture.
9538 @item -mno-red-zone
9539 @opindex no-red-zone
9540 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9541 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9542 stack pointer that will not be modified by signal or interrupt handlers
9543 and therefore can be used for temporary data without adjusting the stack
9544 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9546 @item -mcmodel=small
9547 @opindex mcmodel=small
9548 Generate code for the small code model: the program and its symbols must
9549 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9550 Programs can be statically or dynamically linked.  This is the default
9551 code model.
9553 @item -mcmodel=kernel
9554 @opindex mcmodel=kernel
9555 Generate code for the kernel code model.  The kernel runs in the
9556 negative 2 GB of the address space.
9557 This model has to be used for Linux kernel code.
9559 @item -mcmodel=medium
9560 @opindex mcmodel=medium
9561 Generate code for the medium model: The program is linked in the lower 2
9562 GB of the address space but symbols can be located anywhere in the
9563 address space.  Programs can be statically or dynamically linked, but
9564 building of shared libraries are not supported with the medium model.
9566 @item -mcmodel=large
9567 @opindex mcmodel=large
9568 Generate code for the large model: This model makes no assumptions
9569 about addresses and sizes of sections.  Currently GCC does not implement
9570 this model.
9571 @end table
9573 @node IA-64 Options
9574 @subsection IA-64 Options
9575 @cindex IA-64 Options
9577 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9579 @table @gcctabopt
9580 @item -mbig-endian
9581 @opindex mbig-endian
9582 Generate code for a big endian target.  This is the default for HP-UX@.
9584 @item -mlittle-endian
9585 @opindex mlittle-endian
9586 Generate code for a little endian target.  This is the default for AIX5
9587 and GNU/Linux.
9589 @item -mgnu-as
9590 @itemx -mno-gnu-as
9591 @opindex mgnu-as
9592 @opindex mno-gnu-as
9593 Generate (or don't) code for the GNU assembler.  This is the default.
9594 @c Also, this is the default if the configure option @option{--with-gnu-as}
9595 @c is used.
9597 @item -mgnu-ld
9598 @itemx -mno-gnu-ld
9599 @opindex mgnu-ld
9600 @opindex mno-gnu-ld
9601 Generate (or don't) code for the GNU linker.  This is the default.
9602 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9603 @c is used.
9605 @item -mno-pic
9606 @opindex mno-pic
9607 Generate code that does not use a global pointer register.  The result
9608 is not position independent code, and violates the IA-64 ABI@.
9610 @item -mvolatile-asm-stop
9611 @itemx -mno-volatile-asm-stop
9612 @opindex mvolatile-asm-stop
9613 @opindex mno-volatile-asm-stop
9614 Generate (or don't) a stop bit immediately before and after volatile asm
9615 statements.
9617 @item -mregister-names
9618 @itemx -mno-register-names
9619 @opindex mregister-names
9620 @opindex mno-register-names
9621 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9622 the stacked registers.  This may make assembler output more readable.
9624 @item -mno-sdata
9625 @itemx -msdata
9626 @opindex mno-sdata
9627 @opindex msdata
9628 Disable (or enable) optimizations that use the small data section.  This may
9629 be useful for working around optimizer bugs.
9631 @item -mconstant-gp
9632 @opindex mconstant-gp
9633 Generate code that uses a single constant global pointer value.  This is
9634 useful when compiling kernel code.
9636 @item -mauto-pic
9637 @opindex mauto-pic
9638 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9639 This is useful when compiling firmware code.
9641 @item -minline-float-divide-min-latency
9642 @opindex minline-float-divide-min-latency
9643 Generate code for inline divides of floating point values
9644 using the minimum latency algorithm.
9646 @item -minline-float-divide-max-throughput
9647 @opindex minline-float-divide-max-throughput
9648 Generate code for inline divides of floating point values
9649 using the maximum throughput algorithm.
9651 @item -minline-int-divide-min-latency
9652 @opindex minline-int-divide-min-latency
9653 Generate code for inline divides of integer values
9654 using the minimum latency algorithm.
9656 @item -minline-int-divide-max-throughput
9657 @opindex minline-int-divide-max-throughput
9658 Generate code for inline divides of integer values
9659 using the maximum throughput algorithm.
9661 @item -minline-sqrt-min-latency
9662 @opindex minline-sqrt-min-latency
9663 Generate code for inline square roots
9664 using the minimum latency algorithm.
9666 @item -minline-sqrt-max-throughput
9667 @opindex minline-sqrt-max-throughput
9668 Generate code for inline square roots
9669 using the maximum throughput algorithm.
9671 @item -mno-dwarf2-asm
9672 @itemx -mdwarf2-asm
9673 @opindex mno-dwarf2-asm
9674 @opindex mdwarf2-asm
9675 Don't (or do) generate assembler code for the DWARF2 line number debugging
9676 info.  This may be useful when not using the GNU assembler.
9678 @item -mearly-stop-bits
9679 @itemx -mno-early-stop-bits
9680 @opindex mearly-stop-bits
9681 @opindex mno-early-stop-bits
9682 Allow stop bits to be placed earlier than immediately preceding the
9683 instruction that triggered the stop bit.  This can improve instruction
9684 scheduling, but does not always do so.
9686 @item -mfixed-range=@var{register-range}
9687 @opindex mfixed-range
9688 Generate code treating the given register range as fixed registers.
9689 A fixed register is one that the register allocator can not use.  This is
9690 useful when compiling kernel code.  A register range is specified as
9691 two registers separated by a dash.  Multiple register ranges can be
9692 specified separated by a comma.
9694 @item -mtls-size=@var{tls-size}
9695 @opindex mtls-size
9696 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9699 @item -mtune=@var{cpu-type}
9700 @opindex mtune
9701 Tune the instruction scheduling for a particular CPU, Valid values are
9702 itanium, itanium1, merced, itanium2, and mckinley.
9704 @item -mt
9705 @itemx -pthread
9706 @opindex mt
9707 @opindex pthread
9708 Add support for multithreading using the POSIX threads library.  This
9709 option sets flags for both the preprocessor and linker.  It does
9710 not affect the thread safety of object code produced by the compiler or
9711 that of libraries supplied with it.  These are HP-UX specific flags.
9713 @item -milp32
9714 @itemx -mlp64
9715 @opindex milp32
9716 @opindex mlp64
9717 Generate code for a 32-bit or 64-bit environment.
9718 The 32-bit environment sets int, long and pointer to 32 bits.
9719 The 64-bit environment sets int to 32 bits and long and pointer
9720 to 64 bits.  These are HP-UX specific flags.
9722 @end table
9724 @node M32C Options
9725 @subsection M32C Options
9726 @cindex M32C options
9728 @table @gcctabopt
9729 @item -mcpu=@var{name}
9730 @opindex mcpu=
9731 Select the CPU for which code is generated.  @var{name} may be one of
9732 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9733 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9734 the M32C/80 series.
9736 @item -msim
9737 @opindex msim
9738 Specifies that the program will be run on the simulator.  This causes
9739 an alternate runtime library to be linked in which supports, for
9740 example, file I/O.  You must not use this option when generating
9741 programs that will run on real hardware; you must provide your own
9742 runtime library for whatever I/O functions are needed.
9744 @item -memregs=@var{number}
9745 @opindex memregs=
9746 Specifies the number of memory-based pseudo-registers GCC will use
9747 during code generation.  These pseudo-registers will be used like real
9748 registers, so there is a tradeoff between GCC's ability to fit the
9749 code into available registers, and the performance penalty of using
9750 memory instead of registers.  Note that all modules in a program must
9751 be compiled with the same value for this option.  Because of that, you
9752 must not use this option with the default runtime libraries gcc
9753 builds.
9755 @end table
9757 @node M32R/D Options
9758 @subsection M32R/D Options
9759 @cindex M32R/D options
9761 These @option{-m} options are defined for Renesas M32R/D architectures:
9763 @table @gcctabopt
9764 @item -m32r2
9765 @opindex m32r2
9766 Generate code for the M32R/2@.
9768 @item -m32rx
9769 @opindex m32rx
9770 Generate code for the M32R/X@.
9772 @item -m32r
9773 @opindex m32r
9774 Generate code for the M32R@.  This is the default.
9776 @item -mmodel=small
9777 @opindex mmodel=small
9778 Assume all objects live in the lower 16MB of memory (so that their addresses
9779 can be loaded with the @code{ld24} instruction), and assume all subroutines
9780 are reachable with the @code{bl} instruction.
9781 This is the default.
9783 The addressability of a particular object can be set with the
9784 @code{model} attribute.
9786 @item -mmodel=medium
9787 @opindex mmodel=medium
9788 Assume objects may be anywhere in the 32-bit address space (the compiler
9789 will generate @code{seth/add3} instructions to load their addresses), and
9790 assume all subroutines are reachable with the @code{bl} instruction.
9792 @item -mmodel=large
9793 @opindex mmodel=large
9794 Assume objects may be anywhere in the 32-bit address space (the compiler
9795 will generate @code{seth/add3} instructions to load their addresses), and
9796 assume subroutines may not be reachable with the @code{bl} instruction
9797 (the compiler will generate the much slower @code{seth/add3/jl}
9798 instruction sequence).
9800 @item -msdata=none
9801 @opindex msdata=none
9802 Disable use of the small data area.  Variables will be put into
9803 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9804 @code{section} attribute has been specified).
9805 This is the default.
9807 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9808 Objects may be explicitly put in the small data area with the
9809 @code{section} attribute using one of these sections.
9811 @item -msdata=sdata
9812 @opindex msdata=sdata
9813 Put small global and static data in the small data area, but do not
9814 generate special code to reference them.
9816 @item -msdata=use
9817 @opindex msdata=use
9818 Put small global and static data in the small data area, and generate
9819 special instructions to reference them.
9821 @item -G @var{num}
9822 @opindex G
9823 @cindex smaller data references
9824 Put global and static objects less than or equal to @var{num} bytes
9825 into the small data or bss sections instead of the normal data or bss
9826 sections.  The default value of @var{num} is 8.
9827 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9828 for this option to have any effect.
9830 All modules should be compiled with the same @option{-G @var{num}} value.
9831 Compiling with different values of @var{num} may or may not work; if it
9832 doesn't the linker will give an error message---incorrect code will not be
9833 generated.
9835 @item -mdebug
9836 @opindex mdebug
9837 Makes the M32R specific code in the compiler display some statistics
9838 that might help in debugging programs.
9840 @item -malign-loops
9841 @opindex malign-loops
9842 Align all loops to a 32-byte boundary.
9844 @item -mno-align-loops
9845 @opindex mno-align-loops
9846 Do not enforce a 32-byte alignment for loops.  This is the default.
9848 @item -missue-rate=@var{number}
9849 @opindex missue-rate=@var{number}
9850 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9851 or 2.
9853 @item -mbranch-cost=@var{number}
9854 @opindex mbranch-cost=@var{number}
9855 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9856 preferred over conditional code, if it is 2, then the opposite will
9857 apply.
9859 @item -mflush-trap=@var{number}
9860 @opindex mflush-trap=@var{number}
9861 Specifies the trap number to use to flush the cache.  The default is
9862 12.  Valid numbers are between 0 and 15 inclusive.
9864 @item -mno-flush-trap
9865 @opindex mno-flush-trap
9866 Specifies that the cache cannot be flushed by using a trap.
9868 @item -mflush-func=@var{name}
9869 @opindex mflush-func=@var{name}
9870 Specifies the name of the operating system function to call to flush
9871 the cache.  The default is @emph{_flush_cache}, but a function call
9872 will only be used if a trap is not available.
9874 @item -mno-flush-func
9875 @opindex mno-flush-func
9876 Indicates that there is no OS function for flushing the cache.
9878 @end table
9880 @node M680x0 Options
9881 @subsection M680x0 Options
9882 @cindex M680x0 options
9884 These are the @samp{-m} options defined for the 68000 series.  The default
9885 values for these options depends on which style of 68000 was selected when
9886 the compiler was configured; the defaults for the most common choices are
9887 given below.
9889 @table @gcctabopt
9890 @item -m68000
9891 @itemx -mc68000
9892 @opindex m68000
9893 @opindex mc68000
9894 Generate output for a 68000.  This is the default
9895 when the compiler is configured for 68000-based systems.
9897 Use this option for microcontrollers with a 68000 or EC000 core,
9898 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9900 @item -m68020
9901 @itemx -mc68020
9902 @opindex m68020
9903 @opindex mc68020
9904 Generate output for a 68020.  This is the default
9905 when the compiler is configured for 68020-based systems.
9907 @item -m68881
9908 @opindex m68881
9909 Generate output containing 68881 instructions for floating point.
9910 This is the default for most 68020 systems unless @option{--nfp} was
9911 specified when the compiler was configured.
9913 @item -m68030
9914 @opindex m68030
9915 Generate output for a 68030.  This is the default when the compiler is
9916 configured for 68030-based systems.
9918 @item -m68040
9919 @opindex m68040
9920 Generate output for a 68040.  This is the default when the compiler is
9921 configured for 68040-based systems.
9923 This option inhibits the use of 68881/68882 instructions that have to be
9924 emulated by software on the 68040.  Use this option if your 68040 does not
9925 have code to emulate those instructions.
9927 @item -m68060
9928 @opindex m68060
9929 Generate output for a 68060.  This is the default when the compiler is
9930 configured for 68060-based systems.
9932 This option inhibits the use of 68020 and 68881/68882 instructions that
9933 have to be emulated by software on the 68060.  Use this option if your 68060
9934 does not have code to emulate those instructions.
9936 @item -mcpu32
9937 @opindex mcpu32
9938 Generate output for a CPU32.  This is the default
9939 when the compiler is configured for CPU32-based systems.
9941 Use this option for microcontrollers with a
9942 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9943 68336, 68340, 68341, 68349 and 68360.
9945 @item -m5200
9946 @opindex m5200
9947 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9948 when the compiler is configured for 520X-based systems.
9950 Use this option for microcontroller with a 5200 core, including
9951 the MCF5202, MCF5203, MCF5204 and MCF5202.
9953 @item -mcfv4e
9954 @opindex mcfv4e
9955 Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
9956 This includes use of hardware floating point instructions.
9958 @item -m68020-40
9959 @opindex m68020-40
9960 Generate output for a 68040, without using any of the new instructions.
9961 This results in code which can run relatively efficiently on either a
9962 68020/68881 or a 68030 or a 68040.  The generated code does use the
9963 68881 instructions that are emulated on the 68040.
9965 @item -m68020-60
9966 @opindex m68020-60
9967 Generate output for a 68060, without using any of the new instructions.
9968 This results in code which can run relatively efficiently on either a
9969 68020/68881 or a 68030 or a 68040.  The generated code does use the
9970 68881 instructions that are emulated on the 68060.
9972 @item -msoft-float
9973 @opindex msoft-float
9974 Generate output containing library calls for floating point.
9975 @strong{Warning:} the requisite libraries are not available for all m68k
9976 targets.  Normally the facilities of the machine's usual C compiler are
9977 used, but this can't be done directly in cross-compilation.  You must
9978 make your own arrangements to provide suitable library functions for
9979 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9980 @samp{m68k-*-coff} do provide software floating point support.
9982 @item -mshort
9983 @opindex mshort
9984 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9985 Additionally, parameters passed on the stack are also aligned to a
9986 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9988 @item -mnobitfield
9989 @opindex mnobitfield
9990 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9991 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9993 @item -mbitfield
9994 @opindex mbitfield
9995 Do use the bit-field instructions.  The @option{-m68020} option implies
9996 @option{-mbitfield}.  This is the default if you use a configuration
9997 designed for a 68020.
9999 @item -mrtd
10000 @opindex mrtd
10001 Use a different function-calling convention, in which functions
10002 that take a fixed number of arguments return with the @code{rtd}
10003 instruction, which pops their arguments while returning.  This
10004 saves one instruction in the caller since there is no need to pop
10005 the arguments there.
10007 This calling convention is incompatible with the one normally
10008 used on Unix, so you cannot use it if you need to call libraries
10009 compiled with the Unix compiler.
10011 Also, you must provide function prototypes for all functions that
10012 take variable numbers of arguments (including @code{printf});
10013 otherwise incorrect code will be generated for calls to those
10014 functions.
10016 In addition, seriously incorrect code will result if you call a
10017 function with too many arguments.  (Normally, extra arguments are
10018 harmlessly ignored.)
10020 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10021 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10023 @item -malign-int
10024 @itemx -mno-align-int
10025 @opindex malign-int
10026 @opindex mno-align-int
10027 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10028 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10029 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10030 Aligning variables on 32-bit boundaries produces code that runs somewhat
10031 faster on processors with 32-bit busses at the expense of more memory.
10033 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10034 align structures containing the above types  differently than
10035 most published application binary interface specifications for the m68k.
10037 @item -mpcrel
10038 @opindex mpcrel
10039 Use the pc-relative addressing mode of the 68000 directly, instead of
10040 using a global offset table.  At present, this option implies @option{-fpic},
10041 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
10042 not presently supported with @option{-mpcrel}, though this could be supported for
10043 68020 and higher processors.
10045 @item -mno-strict-align
10046 @itemx -mstrict-align
10047 @opindex mno-strict-align
10048 @opindex mstrict-align
10049 Do not (do) assume that unaligned memory references will be handled by
10050 the system.
10052 @item -msep-data
10053 Generate code that allows the data segment to be located in a different
10054 area of memory from the text segment.  This allows for execute in place in
10055 an environment without virtual memory management.  This option implies
10056 @option{-fPIC}.
10058 @item -mno-sep-data
10059 Generate code that assumes that the data segment follows the text segment.
10060 This is the default.
10062 @item -mid-shared-library
10063 Generate code that supports shared libraries via the library ID method.
10064 This allows for execute in place and shared libraries in an environment
10065 without virtual memory management.  This option implies @option{-fPIC}.
10067 @item -mno-id-shared-library
10068 Generate code that doesn't assume ID based shared libraries are being used.
10069 This is the default.
10071 @item -mshared-library-id=n
10072 Specified the identification number of the ID based shared library being
10073 compiled.  Specifying a value of 0 will generate more compact code, specifying
10074 other values will force the allocation of that number to the current
10075 library but is no more space or time efficient than omitting this option.
10077 @end table
10079 @node M68hc1x Options
10080 @subsection M68hc1x Options
10081 @cindex M68hc1x options
10083 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10084 microcontrollers.  The default values for these options depends on
10085 which style of microcontroller was selected when the compiler was configured;
10086 the defaults for the most common choices are given below.
10088 @table @gcctabopt
10089 @item -m6811
10090 @itemx -m68hc11
10091 @opindex m6811
10092 @opindex m68hc11
10093 Generate output for a 68HC11.  This is the default
10094 when the compiler is configured for 68HC11-based systems.
10096 @item -m6812
10097 @itemx -m68hc12
10098 @opindex m6812
10099 @opindex m68hc12
10100 Generate output for a 68HC12.  This is the default
10101 when the compiler is configured for 68HC12-based systems.
10103 @item -m68S12
10104 @itemx -m68hcs12
10105 @opindex m68S12
10106 @opindex m68hcs12
10107 Generate output for a 68HCS12.
10109 @item -mauto-incdec
10110 @opindex mauto-incdec
10111 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10112 addressing modes.
10114 @item -minmax
10115 @itemx -nominmax
10116 @opindex minmax
10117 @opindex mnominmax
10118 Enable the use of 68HC12 min and max instructions.
10120 @item -mlong-calls
10121 @itemx -mno-long-calls
10122 @opindex mlong-calls
10123 @opindex mno-long-calls
10124 Treat all calls as being far away (near).  If calls are assumed to be
10125 far away, the compiler will use the @code{call} instruction to
10126 call a function and the @code{rtc} instruction for returning.
10128 @item -mshort
10129 @opindex mshort
10130 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10132 @item -msoft-reg-count=@var{count}
10133 @opindex msoft-reg-count
10134 Specify the number of pseudo-soft registers which are used for the
10135 code generation.  The maximum number is 32.  Using more pseudo-soft
10136 register may or may not result in better code depending on the program.
10137 The default is 4 for 68HC11 and 2 for 68HC12.
10139 @end table
10141 @node MCore Options
10142 @subsection MCore Options
10143 @cindex MCore options
10145 These are the @samp{-m} options defined for the Motorola M*Core
10146 processors.
10148 @table @gcctabopt
10150 @item -mhardlit
10151 @itemx -mno-hardlit
10152 @opindex mhardlit
10153 @opindex mno-hardlit
10154 Inline constants into the code stream if it can be done in two
10155 instructions or less.
10157 @item -mdiv
10158 @itemx -mno-div
10159 @opindex mdiv
10160 @opindex mno-div
10161 Use the divide instruction.  (Enabled by default).
10163 @item -mrelax-immediate
10164 @itemx -mno-relax-immediate
10165 @opindex mrelax-immediate
10166 @opindex mno-relax-immediate
10167 Allow arbitrary sized immediates in bit operations.
10169 @item -mwide-bitfields
10170 @itemx -mno-wide-bitfields
10171 @opindex mwide-bitfields
10172 @opindex mno-wide-bitfields
10173 Always treat bit-fields as int-sized.
10175 @item -m4byte-functions
10176 @itemx -mno-4byte-functions
10177 @opindex m4byte-functions
10178 @opindex mno-4byte-functions
10179 Force all functions to be aligned to a four byte boundary.
10181 @item -mcallgraph-data
10182 @itemx -mno-callgraph-data
10183 @opindex mcallgraph-data
10184 @opindex mno-callgraph-data
10185 Emit callgraph information.
10187 @item -mslow-bytes
10188 @itemx -mno-slow-bytes
10189 @opindex mslow-bytes
10190 @opindex mno-slow-bytes
10191 Prefer word access when reading byte quantities.
10193 @item -mlittle-endian
10194 @itemx -mbig-endian
10195 @opindex mlittle-endian
10196 @opindex mbig-endian
10197 Generate code for a little endian target.
10199 @item -m210
10200 @itemx -m340
10201 @opindex m210
10202 @opindex m340
10203 Generate code for the 210 processor.
10204 @end table
10206 @node MIPS Options
10207 @subsection MIPS Options
10208 @cindex MIPS options
10210 @table @gcctabopt
10212 @item -EB
10213 @opindex EB
10214 Generate big-endian code.
10216 @item -EL
10217 @opindex EL
10218 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
10219 configurations.
10221 @item -march=@var{arch}
10222 @opindex march
10223 Generate code that will run on @var{arch}, which can be the name of a
10224 generic MIPS ISA, or the name of a particular processor.
10225 The ISA names are:
10226 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10227 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10228 The processor names are:
10229 @samp{4kc}, @samp{4km}, @samp{4kp},
10230 @samp{5kc}, @samp{5kf},
10231 @samp{20kc},
10232 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10233 @samp{m4k},
10234 @samp{orion},
10235 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10236 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10237 @samp{rm7000}, @samp{rm9000},
10238 @samp{sb1},
10239 @samp{sr71000},
10240 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10241 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10242 The special value @samp{from-abi} selects the
10243 most compatible architecture for the selected ABI (that is,
10244 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10246 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10247 (for example, @samp{-march=r2k}).  Prefixes are optional, and
10248 @samp{vr} may be written @samp{r}.
10250 GCC defines two macros based on the value of this option.  The first
10251 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10252 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
10253 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10254 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10255 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10257 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10258 above.  In other words, it will have the full prefix and will not
10259 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
10260 the macro names the resolved architecture (either @samp{"mips1"} or
10261 @samp{"mips3"}).  It names the default architecture when no
10262 @option{-march} option is given.
10264 @item -mtune=@var{arch}
10265 @opindex mtune
10266 Optimize for @var{arch}.  Among other things, this option controls
10267 the way instructions are scheduled, and the perceived cost of arithmetic
10268 operations.  The list of @var{arch} values is the same as for
10269 @option{-march}.
10271 When this option is not used, GCC will optimize for the processor
10272 specified by @option{-march}.  By using @option{-march} and
10273 @option{-mtune} together, it is possible to generate code that will
10274 run on a family of processors, but optimize the code for one
10275 particular member of that family.
10277 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10278 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10279 @samp{-march} ones described above.
10281 @item -mips1
10282 @opindex mips1
10283 Equivalent to @samp{-march=mips1}.
10285 @item -mips2
10286 @opindex mips2
10287 Equivalent to @samp{-march=mips2}.
10289 @item -mips3
10290 @opindex mips3
10291 Equivalent to @samp{-march=mips3}.
10293 @item -mips4
10294 @opindex mips4
10295 Equivalent to @samp{-march=mips4}.
10297 @item -mips32
10298 @opindex mips32
10299 Equivalent to @samp{-march=mips32}.
10301 @item -mips32r2
10302 @opindex mips32r2
10303 Equivalent to @samp{-march=mips32r2}.
10305 @item -mips64
10306 @opindex mips64
10307 Equivalent to @samp{-march=mips64}.
10309 @item -mips16
10310 @itemx -mno-mips16
10311 @opindex mips16
10312 @opindex mno-mips16
10313 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10314 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10316 @item -mabi=32
10317 @itemx -mabi=o64
10318 @itemx -mabi=n32
10319 @itemx -mabi=64
10320 @itemx -mabi=eabi
10321 @opindex mabi=32
10322 @opindex mabi=o64
10323 @opindex mabi=n32
10324 @opindex mabi=64
10325 @opindex mabi=eabi
10326 Generate code for the given ABI@.
10328 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10329 generates 64-bit code when you select a 64-bit architecture, but you
10330 can use @option{-mgp32} to get 32-bit code instead.
10332 For information about the O64 ABI, see
10333 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10335 @item -mabicalls
10336 @itemx -mno-abicalls
10337 @opindex mabicalls
10338 @opindex mno-abicalls
10339 Generate (do not generate) SVR4-style position-independent code.
10340 @option{-mabicalls} is the default for SVR4-based systems.
10342 @item -mxgot
10343 @itemx -mno-xgot
10344 @opindex mxgot
10345 @opindex mno-xgot
10346 Lift (do not lift) the usual restrictions on the size of the global
10347 offset table.
10349 GCC normally uses a single instruction to load values from the GOT@.
10350 While this is relatively efficient, it will only work if the GOT
10351 is smaller than about 64k.  Anything larger will cause the linker
10352 to report an error such as:
10354 @cindex relocation truncated to fit (MIPS)
10355 @smallexample
10356 relocation truncated to fit: R_MIPS_GOT16 foobar
10357 @end smallexample
10359 If this happens, you should recompile your code with @option{-mxgot}.
10360 It should then work with very large GOTs, although it will also be
10361 less efficient, since it will take three instructions to fetch the
10362 value of a global symbol.
10364 Note that some linkers can create multiple GOTs.  If you have such a
10365 linker, you should only need to use @option{-mxgot} when a single object
10366 file accesses more than 64k's worth of GOT entries.  Very few do.
10368 These options have no effect unless GCC is generating position
10369 independent code.
10371 @item -mgp32
10372 @opindex mgp32
10373 Assume that general-purpose registers are 32 bits wide.
10375 @item -mgp64
10376 @opindex mgp64
10377 Assume that general-purpose registers are 64 bits wide.
10379 @item -mfp32
10380 @opindex mfp32
10381 Assume that floating-point registers are 32 bits wide.
10383 @item -mfp64
10384 @opindex mfp64
10385 Assume that floating-point registers are 64 bits wide.
10387 @item -mhard-float
10388 @opindex mhard-float
10389 Use floating-point coprocessor instructions.
10391 @item -msoft-float
10392 @opindex msoft-float
10393 Do not use floating-point coprocessor instructions.  Implement
10394 floating-point calculations using library calls instead.
10396 @item -msingle-float
10397 @opindex msingle-float
10398 Assume that the floating-point coprocessor only supports single-precision
10399 operations.
10401 @itemx -mdouble-float
10402 @opindex mdouble-float
10403 Assume that the floating-point coprocessor supports double-precision
10404 operations.  This is the default.
10406 @itemx -mdsp
10407 @itemx -mno-dsp
10408 @opindex mdsp
10409 @opindex mno-dsp
10410 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10412 @itemx -mpaired-single
10413 @itemx -mno-paired-single
10414 @opindex mpaired-single
10415 @opindex mno-paired-single
10416 Use (do not use) paired-single floating-point instructions.
10417 @xref{MIPS Paired-Single Support}.  This option can only be used
10418 when generating 64-bit code and requires hardware floating-point
10419 support to be enabled.
10421 @itemx -mips3d
10422 @itemx -mno-mips3d
10423 @opindex mips3d
10424 @opindex mno-mips3d
10425 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10426 The option @option{-mips3d} implies @option{-mpaired-single}.
10428 @item -mlong64
10429 @opindex mlong64
10430 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10431 an explanation of the default and the way that the pointer size is
10432 determined.
10434 @item -mlong32
10435 @opindex mlong32
10436 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10438 The default size of @code{int}s, @code{long}s and pointers depends on
10439 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10440 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10441 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10442 or the same size as integer registers, whichever is smaller.
10444 @item -msym32
10445 @itemx -mno-sym32
10446 @opindex msym32
10447 @opindex mno-sym32
10448 Assume (do not assume) that all symbols have 32-bit values, regardless
10449 of the selected ABI@.  This option is useful in combination with
10450 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10451 to generate shorter and faster references to symbolic addresses.
10453 @item -G @var{num}
10454 @opindex G
10455 @cindex smaller data references (MIPS)
10456 @cindex gp-relative references (MIPS)
10457 Put global and static items less than or equal to @var{num} bytes into
10458 the small data or bss section instead of the normal data or bss section.
10459 This allows the data to be accessed using a single instruction.
10461 All modules should be compiled with the same @option{-G @var{num}}
10462 value.
10464 @item -membedded-data
10465 @itemx -mno-embedded-data
10466 @opindex membedded-data
10467 @opindex mno-embedded-data
10468 Allocate variables to the read-only data section first if possible, then
10469 next in the small data section if possible, otherwise in data.  This gives
10470 slightly slower code than the default, but reduces the amount of RAM required
10471 when executing, and thus may be preferred for some embedded systems.
10473 @item -muninit-const-in-rodata
10474 @itemx -mno-uninit-const-in-rodata
10475 @opindex muninit-const-in-rodata
10476 @opindex mno-uninit-const-in-rodata
10477 Put uninitialized @code{const} variables in the read-only data section.
10478 This option is only meaningful in conjunction with @option{-membedded-data}.
10480 @item -msplit-addresses
10481 @itemx -mno-split-addresses
10482 @opindex msplit-addresses
10483 @opindex mno-split-addresses
10484 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10485 relocation operators.  This option has been superseded by
10486 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10488 @item -mexplicit-relocs
10489 @itemx -mno-explicit-relocs
10490 @opindex mexplicit-relocs
10491 @opindex mno-explicit-relocs
10492 Use (do not use) assembler relocation operators when dealing with symbolic
10493 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10494 is to use assembler macros instead.
10496 @option{-mexplicit-relocs} is the default if GCC was configured
10497 to use an assembler that supports relocation operators.
10499 @item -mcheck-zero-division
10500 @itemx -mno-check-zero-division
10501 @opindex mcheck-zero-division
10502 @opindex mno-check-zero-division
10503 Trap (do not trap) on integer division by zero.  The default is
10504 @option{-mcheck-zero-division}.
10506 @item -mdivide-traps
10507 @itemx -mdivide-breaks
10508 @opindex mdivide-traps
10509 @opindex mdivide-breaks
10510 MIPS systems check for division by zero by generating either a
10511 conditional trap or a break instruction.  Using traps results in
10512 smaller code, but is only supported on MIPS II and later.  Also, some
10513 versions of the Linux kernel have a bug that prevents trap from
10514 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10515 allow conditional traps on architectures that support them and
10516 @option{-mdivide-breaks} to force the use of breaks.
10518 The default is usually @option{-mdivide-traps}, but this can be
10519 overridden at configure time using @option{--with-divide=breaks}.
10520 Divide-by-zero checks can be completely disabled using
10521 @option{-mno-check-zero-division}.
10523 @item -mmemcpy
10524 @itemx -mno-memcpy
10525 @opindex mmemcpy
10526 @opindex mno-memcpy
10527 Force (do not force) the use of @code{memcpy()} for non-trivial block
10528 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10529 most constant-sized copies.
10531 @item -mlong-calls
10532 @itemx -mno-long-calls
10533 @opindex mlong-calls
10534 @opindex mno-long-calls
10535 Disable (do not disable) use of the @code{jal} instruction.  Calling
10536 functions using @code{jal} is more efficient but requires the caller
10537 and callee to be in the same 256 megabyte segment.
10539 This option has no effect on abicalls code.  The default is
10540 @option{-mno-long-calls}.
10542 @item -mmad
10543 @itemx -mno-mad
10544 @opindex mmad
10545 @opindex mno-mad
10546 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10547 instructions, as provided by the R4650 ISA@.
10549 @item -mfused-madd
10550 @itemx -mno-fused-madd
10551 @opindex mfused-madd
10552 @opindex mno-fused-madd
10553 Enable (disable) use of the floating point multiply-accumulate
10554 instructions, when they are available.  The default is
10555 @option{-mfused-madd}.
10557 When multiply-accumulate instructions are used, the intermediate
10558 product is calculated to infinite precision and is not subject to
10559 the FCSR Flush to Zero bit.  This may be undesirable in some
10560 circumstances.
10562 @item -nocpp
10563 @opindex nocpp
10564 Tell the MIPS assembler to not run its preprocessor over user
10565 assembler files (with a @samp{.s} suffix) when assembling them.
10567 @item -mfix-r4000
10568 @itemx -mno-fix-r4000
10569 @opindex mfix-r4000
10570 @opindex mno-fix-r4000
10571 Work around certain R4000 CPU errata:
10572 @itemize @minus
10573 @item
10574 A double-word or a variable shift may give an incorrect result if executed
10575 immediately after starting an integer division.
10576 @item
10577 A double-word or a variable shift may give an incorrect result if executed
10578 while an integer multiplication is in progress.
10579 @item
10580 An integer division may give an incorrect result if started in a delay slot
10581 of a taken branch or a jump.
10582 @end itemize
10584 @item -mfix-r4400
10585 @itemx -mno-fix-r4400
10586 @opindex mfix-r4400
10587 @opindex mno-fix-r4400
10588 Work around certain R4400 CPU errata:
10589 @itemize @minus
10590 @item
10591 A double-word or a variable shift may give an incorrect result if executed
10592 immediately after starting an integer division.
10593 @end itemize
10595 @item -mfix-vr4120
10596 @itemx -mno-fix-vr4120
10597 @opindex mfix-vr4120
10598 Work around certain VR4120 errata:
10599 @itemize @minus
10600 @item
10601 @code{dmultu} does not always produce the correct result.
10602 @item
10603 @code{div} and @code{ddiv} do not always produce the correct result if one
10604 of the operands is negative.
10605 @end itemize
10606 The workarounds for the division errata rely on special functions in
10607 @file{libgcc.a}.  At present, these functions are only provided by
10608 the @code{mips64vr*-elf} configurations.
10610 Other VR4120 errata require a nop to be inserted between certain pairs of
10611 instructions.  These errata are handled by the assembler, not by GCC itself.
10613 @item -mfix-vr4130
10614 @opindex mfix-vr4130
10615 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10616 workarounds are implemented by the assembler rather than by GCC,
10617 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10618 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10619 instructions are available instead.
10621 @item -mfix-sb1
10622 @itemx -mno-fix-sb1
10623 @opindex mfix-sb1
10624 Work around certain SB-1 CPU core errata.
10625 (This flag currently works around the SB-1 revision 2
10626 ``F1'' and ``F2'' floating point errata.)
10628 @item -mflush-func=@var{func}
10629 @itemx -mno-flush-func
10630 @opindex mflush-func
10631 Specifies the function to call to flush the I and D caches, or to not
10632 call any such function.  If called, the function must take the same
10633 arguments as the common @code{_flush_func()}, that is, the address of the
10634 memory range for which the cache is being flushed, the size of the
10635 memory range, and the number 3 (to flush both caches).  The default
10636 depends on the target GCC was configured for, but commonly is either
10637 @samp{_flush_func} or @samp{__cpu_flush}.
10639 @item -mbranch-likely
10640 @itemx -mno-branch-likely
10641 @opindex mbranch-likely
10642 @opindex mno-branch-likely
10643 Enable or disable use of Branch Likely instructions, regardless of the
10644 default for the selected architecture.  By default, Branch Likely
10645 instructions may be generated if they are supported by the selected
10646 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10647 and processors which implement those architectures; for those, Branch
10648 Likely instructions will not be generated by default because the MIPS32
10649 and MIPS64 architectures specifically deprecate their use.
10651 @item -mfp-exceptions
10652 @itemx -mno-fp-exceptions
10653 @opindex mfp-exceptions
10654 Specifies whether FP exceptions are enabled.  This affects how we schedule
10655 FP instructions for some processors.  The default is that FP exceptions are
10656 enabled.
10658 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10659 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10660 FP pipe.
10662 @item -mvr4130-align
10663 @itemx -mno-vr4130-align
10664 @opindex mvr4130-align
10665 The VR4130 pipeline is two-way superscalar, but can only issue two
10666 instructions together if the first one is 8-byte aligned.  When this
10667 option is enabled, GCC will align pairs of instructions that it
10668 thinks should execute in parallel.
10670 This option only has an effect when optimizing for the VR4130.
10671 It normally makes code faster, but at the expense of making it bigger.
10672 It is enabled by default at optimization level @option{-O3}.
10673 @end table
10675 @node MMIX Options
10676 @subsection MMIX Options
10677 @cindex MMIX Options
10679 These options are defined for the MMIX:
10681 @table @gcctabopt
10682 @item -mlibfuncs
10683 @itemx -mno-libfuncs
10684 @opindex mlibfuncs
10685 @opindex mno-libfuncs
10686 Specify that intrinsic library functions are being compiled, passing all
10687 values in registers, no matter the size.
10689 @item -mepsilon
10690 @itemx -mno-epsilon
10691 @opindex mepsilon
10692 @opindex mno-epsilon
10693 Generate floating-point comparison instructions that compare with respect
10694 to the @code{rE} epsilon register.
10696 @item -mabi=mmixware
10697 @itemx -mabi=gnu
10698 @opindex mabi-mmixware
10699 @opindex mabi=gnu
10700 Generate code that passes function parameters and return values that (in
10701 the called function) are seen as registers @code{$0} and up, as opposed to
10702 the GNU ABI which uses global registers @code{$231} and up.
10704 @item -mzero-extend
10705 @itemx -mno-zero-extend
10706 @opindex mzero-extend
10707 @opindex mno-zero-extend
10708 When reading data from memory in sizes shorter than 64 bits, use (do not
10709 use) zero-extending load instructions by default, rather than
10710 sign-extending ones.
10712 @item -mknuthdiv
10713 @itemx -mno-knuthdiv
10714 @opindex mknuthdiv
10715 @opindex mno-knuthdiv
10716 Make the result of a division yielding a remainder have the same sign as
10717 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10718 remainder follows the sign of the dividend.  Both methods are
10719 arithmetically valid, the latter being almost exclusively used.
10721 @item -mtoplevel-symbols
10722 @itemx -mno-toplevel-symbols
10723 @opindex mtoplevel-symbols
10724 @opindex mno-toplevel-symbols
10725 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10726 code can be used with the @code{PREFIX} assembly directive.
10728 @item -melf
10729 @opindex melf
10730 Generate an executable in the ELF format, rather than the default
10731 @samp{mmo} format used by the @command{mmix} simulator.
10733 @item -mbranch-predict
10734 @itemx -mno-branch-predict
10735 @opindex mbranch-predict
10736 @opindex mno-branch-predict
10737 Use (do not use) the probable-branch instructions, when static branch
10738 prediction indicates a probable branch.
10740 @item -mbase-addresses
10741 @itemx -mno-base-addresses
10742 @opindex mbase-addresses
10743 @opindex mno-base-addresses
10744 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10745 base address automatically generates a request (handled by the assembler
10746 and the linker) for a constant to be set up in a global register.  The
10747 register is used for one or more base address requests within the range 0
10748 to 255 from the value held in the register.  The generally leads to short
10749 and fast code, but the number of different data items that can be
10750 addressed is limited.  This means that a program that uses lots of static
10751 data may require @option{-mno-base-addresses}.
10753 @item -msingle-exit
10754 @itemx -mno-single-exit
10755 @opindex msingle-exit
10756 @opindex mno-single-exit
10757 Force (do not force) generated code to have a single exit point in each
10758 function.
10759 @end table
10761 @node MN10300 Options
10762 @subsection MN10300 Options
10763 @cindex MN10300 options
10765 These @option{-m} options are defined for Matsushita MN10300 architectures:
10767 @table @gcctabopt
10768 @item -mmult-bug
10769 @opindex mmult-bug
10770 Generate code to avoid bugs in the multiply instructions for the MN10300
10771 processors.  This is the default.
10773 @item -mno-mult-bug
10774 @opindex mno-mult-bug
10775 Do not generate code to avoid bugs in the multiply instructions for the
10776 MN10300 processors.
10778 @item -mam33
10779 @opindex mam33
10780 Generate code which uses features specific to the AM33 processor.
10782 @item -mno-am33
10783 @opindex mno-am33
10784 Do not generate code which uses features specific to the AM33 processor.  This
10785 is the default.
10787 @item -mreturn-pointer-on-d0
10788 @opindex mreturn-pointer-on-d0
10789 When generating a function which returns a pointer, return the pointer
10790 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
10791 only in a0, and attempts to call such functions without a prototype
10792 would result in errors.  Note that this option is on by default; use
10793 @option{-mno-return-pointer-on-d0} to disable it.
10795 @item -mno-crt0
10796 @opindex mno-crt0
10797 Do not link in the C run-time initialization object file.
10799 @item -mrelax
10800 @opindex mrelax
10801 Indicate to the linker that it should perform a relaxation optimization pass
10802 to shorten branches, calls and absolute memory addresses.  This option only
10803 has an effect when used on the command line for the final link step.
10805 This option makes symbolic debugging impossible.
10806 @end table
10808 @node MT Options
10809 @subsection MT Options
10810 @cindex MT options
10812 These @option{-m} options are defined for Morpho MT architectures:
10814 @table @gcctabopt
10816 @item -march=@var{cpu-type}
10817 @opindex march
10818 Generate code that will run on @var{cpu-type}, which is the name of a system
10819 representing a certain processor type.  Possible values for
10820 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10821 @samp{ms1-16-003} and @samp{ms2}.
10823 When this option is not used, the default is @option{-march=ms1-16-002}.
10825 @item -mbacc
10826 @opindex mbacc
10827 Use byte loads and stores when generating code.
10829 @item -mno-bacc
10830 @opindex mno-bacc
10831 Do not use byte loads and stores when generating code.
10833 @item -msim
10834 @opindex msim
10835 Use simulator runtime
10837 @item -mno-crt0
10838 @opindex mno-crt0
10839 Do not link in the C run-time initialization object file
10840 @file{crti.o}.  Other run-time initialization and termination files
10841 such as @file{startup.o} and @file{exit.o} are still included on the
10842 linker command line.
10844 @end table
10846 @node PDP-11 Options
10847 @subsection PDP-11 Options
10848 @cindex PDP-11 Options
10850 These options are defined for the PDP-11:
10852 @table @gcctabopt
10853 @item -mfpu
10854 @opindex mfpu
10855 Use hardware FPP floating point.  This is the default.  (FIS floating
10856 point on the PDP-11/40 is not supported.)
10858 @item -msoft-float
10859 @opindex msoft-float
10860 Do not use hardware floating point.
10862 @item -mac0
10863 @opindex mac0
10864 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10866 @item -mno-ac0
10867 @opindex mno-ac0
10868 Return floating-point results in memory.  This is the default.
10870 @item -m40
10871 @opindex m40
10872 Generate code for a PDP-11/40.
10874 @item -m45
10875 @opindex m45
10876 Generate code for a PDP-11/45.  This is the default.
10878 @item -m10
10879 @opindex m10
10880 Generate code for a PDP-11/10.
10882 @item -mbcopy-builtin
10883 @opindex bcopy-builtin
10884 Use inline @code{movmemhi} patterns for copying memory.  This is the
10885 default.
10887 @item -mbcopy
10888 @opindex mbcopy
10889 Do not use inline @code{movmemhi} patterns for copying memory.
10891 @item -mint16
10892 @itemx -mno-int32
10893 @opindex mint16
10894 @opindex mno-int32
10895 Use 16-bit @code{int}.  This is the default.
10897 @item -mint32
10898 @itemx -mno-int16
10899 @opindex mint32
10900 @opindex mno-int16
10901 Use 32-bit @code{int}.
10903 @item -mfloat64
10904 @itemx -mno-float32
10905 @opindex mfloat64
10906 @opindex mno-float32
10907 Use 64-bit @code{float}.  This is the default.
10909 @item -mfloat32
10910 @itemx -mno-float64
10911 @opindex mfloat32
10912 @opindex mno-float64
10913 Use 32-bit @code{float}.
10915 @item -mabshi
10916 @opindex mabshi
10917 Use @code{abshi2} pattern.  This is the default.
10919 @item -mno-abshi
10920 @opindex mno-abshi
10921 Do not use @code{abshi2} pattern.
10923 @item -mbranch-expensive
10924 @opindex mbranch-expensive
10925 Pretend that branches are expensive.  This is for experimenting with
10926 code generation only.
10928 @item -mbranch-cheap
10929 @opindex mbranch-cheap
10930 Do not pretend that branches are expensive.  This is the default.
10932 @item -msplit
10933 @opindex msplit
10934 Generate code for a system with split I&D@.
10936 @item -mno-split
10937 @opindex mno-split
10938 Generate code for a system without split I&D@.  This is the default.
10940 @item -munix-asm
10941 @opindex munix-asm
10942 Use Unix assembler syntax.  This is the default when configured for
10943 @samp{pdp11-*-bsd}.
10945 @item -mdec-asm
10946 @opindex mdec-asm
10947 Use DEC assembler syntax.  This is the default when configured for any
10948 PDP-11 target other than @samp{pdp11-*-bsd}.
10949 @end table
10951 @node PowerPC Options
10952 @subsection PowerPC Options
10953 @cindex PowerPC options
10955 These are listed under @xref{RS/6000 and PowerPC Options}.
10957 @node RS/6000 and PowerPC Options
10958 @subsection IBM RS/6000 and PowerPC Options
10959 @cindex RS/6000 and PowerPC Options
10960 @cindex IBM RS/6000 and PowerPC Options
10962 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10963 @table @gcctabopt
10964 @item -mpower
10965 @itemx -mno-power
10966 @itemx -mpower2
10967 @itemx -mno-power2
10968 @itemx -mpowerpc
10969 @itemx -mno-powerpc
10970 @itemx -mpowerpc-gpopt
10971 @itemx -mno-powerpc-gpopt
10972 @itemx -mpowerpc-gfxopt
10973 @itemx -mno-powerpc-gfxopt
10974 @itemx -mpowerpc64
10975 @itemx -mno-powerpc64
10976 @itemx -mmfcrf
10977 @itemx -mno-mfcrf
10978 @itemx -mpopcntb
10979 @itemx -mno-popcntb
10980 @itemx -mfprnd
10981 @itemx -mno-fprnd
10982 @opindex mpower
10983 @opindex mno-power
10984 @opindex mpower2
10985 @opindex mno-power2
10986 @opindex mpowerpc
10987 @opindex mno-powerpc
10988 @opindex mpowerpc-gpopt
10989 @opindex mno-powerpc-gpopt
10990 @opindex mpowerpc-gfxopt
10991 @opindex mno-powerpc-gfxopt
10992 @opindex mpowerpc64
10993 @opindex mno-powerpc64
10994 @opindex mmfcrf
10995 @opindex mno-mfcrf
10996 @opindex mpopcntb
10997 @opindex mno-popcntb
10998 @opindex mfprnd
10999 @opindex mno-fprnd
11000 GCC supports two related instruction set architectures for the
11001 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
11002 instructions supported by the @samp{rios} chip set used in the original
11003 RS/6000 systems and the @dfn{PowerPC} instruction set is the
11004 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11005 the IBM 4xx, 6xx, and follow-on microprocessors.
11007 Neither architecture is a subset of the other.  However there is a
11008 large common subset of instructions supported by both.  An MQ
11009 register is included in processors supporting the POWER architecture.
11011 You use these options to specify which instructions are available on the
11012 processor you are using.  The default value of these options is
11013 determined when configuring GCC@.  Specifying the
11014 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11015 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
11016 rather than the options listed above.
11018 The @option{-mpower} option allows GCC to generate instructions that
11019 are found only in the POWER architecture and to use the MQ register.
11020 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11021 to generate instructions that are present in the POWER2 architecture but
11022 not the original POWER architecture.
11024 The @option{-mpowerpc} option allows GCC to generate instructions that
11025 are found only in the 32-bit subset of the PowerPC architecture.
11026 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11027 GCC to use the optional PowerPC architecture instructions in the
11028 General Purpose group, including floating-point square root.  Specifying
11029 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11030 use the optional PowerPC architecture instructions in the Graphics
11031 group, including floating-point select.
11033 The @option{-mmfcrf} option allows GCC to generate the move from
11034 condition register field instruction implemented on the POWER4
11035 processor and other processors that support the PowerPC V2.01
11036 architecture.
11037 The @option{-mpopcntb} option allows GCC to generate the popcount and
11038 double precision FP reciprocal estimate instruction implemented on the
11039 POWER5 processor and other processors that support the PowerPC V2.02
11040 architecture.
11041 The @option{-mfprnd} option allows GCC to generate the FP round to
11042 integer instructions implemented on the POWER5+ processor and other
11043 processors that support the PowerPC V2.03 architecture.
11045 The @option{-mpowerpc64} option allows GCC to generate the additional
11046 64-bit instructions that are found in the full PowerPC64 architecture
11047 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
11048 @option{-mno-powerpc64}.
11050 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11051 will use only the instructions in the common subset of both
11052 architectures plus some special AIX common-mode calls, and will not use
11053 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
11054 permits GCC to use any instruction from either architecture and to
11055 allow use of the MQ register; specify this for the Motorola MPC601.
11057 @item -mnew-mnemonics
11058 @itemx -mold-mnemonics
11059 @opindex mnew-mnemonics
11060 @opindex mold-mnemonics
11061 Select which mnemonics to use in the generated assembler code.  With
11062 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11063 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
11064 assembler mnemonics defined for the POWER architecture.  Instructions
11065 defined in only one architecture have only one mnemonic; GCC uses that
11066 mnemonic irrespective of which of these options is specified.
11068 GCC defaults to the mnemonics appropriate for the architecture in
11069 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11070 value of these option.  Unless you are building a cross-compiler, you
11071 should normally not specify either @option{-mnew-mnemonics} or
11072 @option{-mold-mnemonics}, but should instead accept the default.
11074 @item -mcpu=@var{cpu_type}
11075 @opindex mcpu
11076 Set architecture type, register usage, choice of mnemonics, and
11077 instruction scheduling parameters for machine type @var{cpu_type}.
11078 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11079 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11080 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11081 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11082 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11083 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11084 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11085 @samp{power4}, @samp{power5}, @samp{power5+},
11086 @samp{common}, @samp{powerpc}, @samp{powerpc64},
11087 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11089 @option{-mcpu=common} selects a completely generic processor.  Code
11090 generated under this option will run on any POWER or PowerPC processor.
11091 GCC will use only the instructions in the common subset of both
11092 architectures, and will not use the MQ register.  GCC assumes a generic
11093 processor model for scheduling purposes.
11095 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11096 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11097 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11098 types, with an appropriate, generic processor model assumed for
11099 scheduling purposes.
11101 The other options specify a specific processor.  Code generated under
11102 those options will run best on that processor, and may not run at all on
11103 others.
11105 The @option{-mcpu} options automatically enable or disable the
11106 following options: @option{-maltivec}, @option{-mfprnd},
11107 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11108 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11109 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11110 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
11111 The particular options
11112 set for any particular CPU will vary between compiler versions,
11113 depending on what setting seems to produce optimal code for that CPU;
11114 it doesn't necessarily reflect the actual hardware's capabilities.  If
11115 you wish to set an individual option to a particular value, you may
11116 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11117 -mno-altivec}.
11119 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11120 not enabled or disabled by the @option{-mcpu} option at present because
11121 AIX does not have full support for these options.  You may still
11122 enable or disable them individually if you're sure it'll work in your
11123 environment.
11125 @item -mtune=@var{cpu_type}
11126 @opindex mtune
11127 Set the instruction scheduling parameters for machine type
11128 @var{cpu_type}, but do not set the architecture type, register usage, or
11129 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
11130 values for @var{cpu_type} are used for @option{-mtune} as for
11131 @option{-mcpu}.  If both are specified, the code generated will use the
11132 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11133 scheduling parameters set by @option{-mtune}.
11135 @item -mswdiv
11136 @itemx -mno-swdiv
11137 @opindex mswdiv
11138 @opindex mno-swdiv
11139 Generate code to compute division as reciprocal estimate and iterative
11140 refinement, creating opportunities for increased throughput.  This
11141 feature requires: optional PowerPC Graphics instruction set for single
11142 precision and FRE instruction for double precision, assuming divides
11143 cannot generate user-visible traps, and the domain values not include
11144 Infinities, denormals or zero denominator.
11146 @item -maltivec
11147 @itemx -mno-altivec
11148 @opindex maltivec
11149 @opindex mno-altivec
11150 Generate code that uses (does not use) AltiVec instructions, and also
11151 enable the use of built-in functions that allow more direct access to
11152 the AltiVec instruction set.  You may also need to set
11153 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11154 enhancements.
11156 @item -mvrsave
11157 @item -mno-vrsave
11158 @opindex mvrsave
11159 @opindex mno-vrsave
11160 Generate VRSAVE instructions when generating AltiVec code.
11162 @item -msecure-plt
11163 @opindex msecure-plt
11164 Generate code that allows ld and ld.so to build executables and shared
11165 libraries with non-exec .plt and .got sections.  This is a PowerPC
11166 32-bit SYSV ABI option.
11168 @item -mbss-plt
11169 @opindex mbss-plt
11170 Generate code that uses a BSS .plt section that ld.so fills in, and
11171 requires .plt and .got sections that are both writable and executable.
11172 This is a PowerPC 32-bit SYSV ABI option.
11174 @item -misel
11175 @itemx -mno-isel
11176 @opindex misel
11177 @opindex mno-isel
11178 This switch enables or disables the generation of ISEL instructions.
11180 @item -misel=@var{yes/no}
11181 This switch has been deprecated.  Use @option{-misel} and
11182 @option{-mno-isel} instead.
11184 @item -mspe
11185 @itemx -mno-isel
11186 @opindex mspe
11187 @opindex mno-spe
11188 This switch enables or disables the generation of SPE simd
11189 instructions.
11191 @item -mspe=@var{yes/no}
11192 This option has been deprecated.  Use @option{-mspe} and
11193 @option{-mno-spe} instead.
11195 @item -mfloat-gprs=@var{yes/single/double/no}
11196 @itemx -mfloat-gprs
11197 @opindex mfloat-gprs
11198 This switch enables or disables the generation of floating point
11199 operations on the general purpose registers for architectures that
11200 support it.
11202 The argument @var{yes} or @var{single} enables the use of
11203 single-precision floating point operations.
11205 The argument @var{double} enables the use of single and
11206 double-precision floating point operations.
11208 The argument @var{no} disables floating point operations on the
11209 general purpose registers.
11211 This option is currently only available on the MPC854x.
11213 @item -m32
11214 @itemx -m64
11215 @opindex m32
11216 @opindex m64
11217 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11218 targets (including GNU/Linux).  The 32-bit environment sets int, long
11219 and pointer to 32 bits and generates code that runs on any PowerPC
11220 variant.  The 64-bit environment sets int to 32 bits and long and
11221 pointer to 64 bits, and generates code for PowerPC64, as for
11222 @option{-mpowerpc64}.
11224 @item -mfull-toc
11225 @itemx -mno-fp-in-toc
11226 @itemx -mno-sum-in-toc
11227 @itemx -mminimal-toc
11228 @opindex mfull-toc
11229 @opindex mno-fp-in-toc
11230 @opindex mno-sum-in-toc
11231 @opindex mminimal-toc
11232 Modify generation of the TOC (Table Of Contents), which is created for
11233 every executable file.  The @option{-mfull-toc} option is selected by
11234 default.  In that case, GCC will allocate at least one TOC entry for
11235 each unique non-automatic variable reference in your program.  GCC
11236 will also place floating-point constants in the TOC@.  However, only
11237 16,384 entries are available in the TOC@.
11239 If you receive a linker error message that saying you have overflowed
11240 the available TOC space, you can reduce the amount of TOC space used
11241 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11242 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11243 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11244 generate code to calculate the sum of an address and a constant at
11245 run-time instead of putting that sum into the TOC@.  You may specify one
11246 or both of these options.  Each causes GCC to produce very slightly
11247 slower and larger code at the expense of conserving TOC space.
11249 If you still run out of space in the TOC even when you specify both of
11250 these options, specify @option{-mminimal-toc} instead.  This option causes
11251 GCC to make only one TOC entry for every file.  When you specify this
11252 option, GCC will produce code that is slower and larger but which
11253 uses extremely little TOC space.  You may wish to use this option
11254 only on files that contain less frequently executed code.
11256 @item -maix64
11257 @itemx -maix32
11258 @opindex maix64
11259 @opindex maix32
11260 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11261 @code{long} type, and the infrastructure needed to support them.
11262 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11263 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11264 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
11266 @item -mxl-compat
11267 @itemx -mno-xl-compat
11268 @opindex mxl-compat
11269 @opindex mno-xl-compat
11270 Produce code that conforms more closely to IBM XL compiler semantics
11271 when using AIX-compatible ABI.  Pass floating-point arguments to
11272 prototyped functions beyond the register save area (RSA) on the stack
11273 in addition to argument FPRs.  Do not assume that most significant
11274 double in 128-bit long double value is properly rounded when comparing
11275 values and converting to double.  Use XL symbol names for long double
11276 support routines.
11278 The AIX calling convention was extended but not initially documented to
11279 handle an obscure K&R C case of calling a function that takes the
11280 address of its arguments with fewer arguments than declared.  IBM XL
11281 compilers access floating point arguments which do not fit in the
11282 RSA from the stack when a subroutine is compiled without
11283 optimization.  Because always storing floating-point arguments on the
11284 stack is inefficient and rarely needed, this option is not enabled by
11285 default and only is necessary when calling subroutines compiled by IBM
11286 XL compilers without optimization.
11288 @item -mpe
11289 @opindex mpe
11290 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
11291 application written to use message passing with special startup code to
11292 enable the application to run.  The system must have PE installed in the
11293 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11294 must be overridden with the @option{-specs=} option to specify the
11295 appropriate directory location.  The Parallel Environment does not
11296 support threads, so the @option{-mpe} option and the @option{-pthread}
11297 option are incompatible.
11299 @item -malign-natural
11300 @itemx -malign-power
11301 @opindex malign-natural
11302 @opindex malign-power
11303 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11304 @option{-malign-natural} overrides the ABI-defined alignment of larger
11305 types, such as floating-point doubles, on their natural size-based boundary.
11306 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11307 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
11309 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11310 is not supported.
11312 @item -msoft-float
11313 @itemx -mhard-float
11314 @opindex msoft-float
11315 @opindex mhard-float
11316 Generate code that does not use (uses) the floating-point register set.
11317 Software floating point emulation is provided if you use the
11318 @option{-msoft-float} option, and pass the option to GCC when linking.
11320 @item -mmultiple
11321 @itemx -mno-multiple
11322 @opindex mmultiple
11323 @opindex mno-multiple
11324 Generate code that uses (does not use) the load multiple word
11325 instructions and the store multiple word instructions.  These
11326 instructions are generated by default on POWER systems, and not
11327 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
11328 endian PowerPC systems, since those instructions do not work when the
11329 processor is in little endian mode.  The exceptions are PPC740 and
11330 PPC750 which permit the instructions usage in little endian mode.
11332 @item -mstring
11333 @itemx -mno-string
11334 @opindex mstring
11335 @opindex mno-string
11336 Generate code that uses (does not use) the load string instructions
11337 and the store string word instructions to save multiple registers and
11338 do small block moves.  These instructions are generated by default on
11339 POWER systems, and not generated on PowerPC systems.  Do not use
11340 @option{-mstring} on little endian PowerPC systems, since those
11341 instructions do not work when the processor is in little endian mode.
11342 The exceptions are PPC740 and PPC750 which permit the instructions
11343 usage in little endian mode.
11345 @item -mupdate
11346 @itemx -mno-update
11347 @opindex mupdate
11348 @opindex mno-update
11349 Generate code that uses (does not use) the load or store instructions
11350 that update the base register to the address of the calculated memory
11351 location.  These instructions are generated by default.  If you use
11352 @option{-mno-update}, there is a small window between the time that the
11353 stack pointer is updated and the address of the previous frame is
11354 stored, which means code that walks the stack frame across interrupts or
11355 signals may get corrupted data.
11357 @item -mfused-madd
11358 @itemx -mno-fused-madd
11359 @opindex mfused-madd
11360 @opindex mno-fused-madd
11361 Generate code that uses (does not use) the floating point multiply and
11362 accumulate instructions.  These instructions are generated by default if
11363 hardware floating is used.
11365 @item -mmulhw
11366 @itemx -mno-mulhw
11367 @opindex mmulhw
11368 @opindex mno-mulhw
11369 Generate code that uses (does not use) the half-word multiply and
11370 multiply-accumulate instructions on the IBM 405 and 440 processors.
11371 These instructions are generated by default when targetting those
11372 processors.
11374 @item -mno-bit-align
11375 @itemx -mbit-align
11376 @opindex mno-bit-align
11377 @opindex mbit-align
11378 On System V.4 and embedded PowerPC systems do not (do) force structures
11379 and unions that contain bit-fields to be aligned to the base type of the
11380 bit-field.
11382 For example, by default a structure containing nothing but 8
11383 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11384 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11385 the structure would be aligned to a 1 byte boundary and be one byte in
11386 size.
11388 @item -mno-strict-align
11389 @itemx -mstrict-align
11390 @opindex mno-strict-align
11391 @opindex mstrict-align
11392 On System V.4 and embedded PowerPC systems do not (do) assume that
11393 unaligned memory references will be handled by the system.
11395 @item -mrelocatable
11396 @itemx -mno-relocatable
11397 @opindex mrelocatable
11398 @opindex mno-relocatable
11399 On embedded PowerPC systems generate code that allows (does not allow)
11400 the program to be relocated to a different address at runtime.  If you
11401 use @option{-mrelocatable} on any module, all objects linked together must
11402 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11404 @item -mrelocatable-lib
11405 @itemx -mno-relocatable-lib
11406 @opindex mrelocatable-lib
11407 @opindex mno-relocatable-lib
11408 On embedded PowerPC systems generate code that allows (does not allow)
11409 the program to be relocated to a different address at runtime.  Modules
11410 compiled with @option{-mrelocatable-lib} can be linked with either modules
11411 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11412 with modules compiled with the @option{-mrelocatable} options.
11414 @item -mno-toc
11415 @itemx -mtoc
11416 @opindex mno-toc
11417 @opindex mtoc
11418 On System V.4 and embedded PowerPC systems do not (do) assume that
11419 register 2 contains a pointer to a global area pointing to the addresses
11420 used in the program.
11422 @item -mlittle
11423 @itemx -mlittle-endian
11424 @opindex mlittle
11425 @opindex mlittle-endian
11426 On System V.4 and embedded PowerPC systems compile code for the
11427 processor in little endian mode.  The @option{-mlittle-endian} option is
11428 the same as @option{-mlittle}.
11430 @item -mbig
11431 @itemx -mbig-endian
11432 @opindex mbig
11433 @opindex mbig-endian
11434 On System V.4 and embedded PowerPC systems compile code for the
11435 processor in big endian mode.  The @option{-mbig-endian} option is
11436 the same as @option{-mbig}.
11438 @item -mdynamic-no-pic
11439 @opindex mdynamic-no-pic
11440 On Darwin and Mac OS X systems, compile code so that it is not
11441 relocatable, but that its external references are relocatable.  The
11442 resulting code is suitable for applications, but not shared
11443 libraries.
11445 @item -mprioritize-restricted-insns=@var{priority}
11446 @opindex mprioritize-restricted-insns
11447 This option controls the priority that is assigned to
11448 dispatch-slot restricted instructions during the second scheduling
11449 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11450 @var{no/highest/second-highest} priority to dispatch slot restricted
11451 instructions.
11453 @item -msched-costly-dep=@var{dependence_type}
11454 @opindex msched-costly-dep
11455 This option controls which dependences are considered costly
11456 by the target during instruction scheduling.  The argument
11457 @var{dependence_type} takes one of the following values:
11458 @var{no}: no dependence is costly,
11459 @var{all}: all dependences are costly,
11460 @var{true_store_to_load}: a true dependence from store to load is costly,
11461 @var{store_to_load}: any dependence from store to load is costly,
11462 @var{number}: any dependence which latency >= @var{number} is costly.
11464 @item -minsert-sched-nops=@var{scheme}
11465 @opindex minsert-sched-nops
11466 This option controls which nop insertion scheme will be used during
11467 the second scheduling pass.  The argument @var{scheme} takes one of the
11468 following values:
11469 @var{no}: Don't insert nops.
11470 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11471 according to the scheduler's grouping.
11472 @var{regroup_exact}: Insert nops to force costly dependent insns into
11473 separate groups.  Insert exactly as many nops as needed to force an insn
11474 to a new group, according to the estimated processor grouping.
11475 @var{number}: Insert nops to force costly dependent insns into
11476 separate groups.  Insert @var{number} nops to force an insn to a new group.
11478 @item -mcall-sysv
11479 @opindex mcall-sysv
11480 On System V.4 and embedded PowerPC systems compile code using calling
11481 conventions that adheres to the March 1995 draft of the System V
11482 Application Binary Interface, PowerPC processor supplement.  This is the
11483 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11485 @item -mcall-sysv-eabi
11486 @opindex mcall-sysv-eabi
11487 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11489 @item -mcall-sysv-noeabi
11490 @opindex mcall-sysv-noeabi
11491 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11493 @item -mcall-solaris
11494 @opindex mcall-solaris
11495 On System V.4 and embedded PowerPC systems compile code for the Solaris
11496 operating system.
11498 @item -mcall-linux
11499 @opindex mcall-linux
11500 On System V.4 and embedded PowerPC systems compile code for the
11501 Linux-based GNU system.
11503 @item -mcall-gnu
11504 @opindex mcall-gnu
11505 On System V.4 and embedded PowerPC systems compile code for the
11506 Hurd-based GNU system.
11508 @item -mcall-netbsd
11509 @opindex mcall-netbsd
11510 On System V.4 and embedded PowerPC systems compile code for the
11511 NetBSD operating system.
11513 @item -maix-struct-return
11514 @opindex maix-struct-return
11515 Return all structures in memory (as specified by the AIX ABI)@.
11517 @item -msvr4-struct-return
11518 @opindex msvr4-struct-return
11519 Return structures smaller than 8 bytes in registers (as specified by the
11520 SVR4 ABI)@.
11522 @item -mabi=@var{abi-type}
11523 @opindex mabi
11524 Extend the current ABI with a particular extension, or remove such extension.
11525 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11526 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11528 @item -mabi=spe
11529 @opindex mabi=spe
11530 Extend the current ABI with SPE ABI extensions.  This does not change
11531 the default ABI, instead it adds the SPE ABI extensions to the current
11532 ABI@.
11534 @item -mabi=no-spe
11535 @opindex mabi=no-spe
11536 Disable Booke SPE ABI extensions for the current ABI@.
11538 @item -mabi=ibmlongdouble
11539 @opindex mabi=ibmlongdouble
11540 Change the current ABI to use IBM extended precision long double.
11541 This is a PowerPC 32-bit SYSV ABI option.
11543 @item -mabi=ieeelongdouble
11544 @opindex mabi=ieeelongdouble
11545 Change the current ABI to use IEEE extended precision long double.
11546 This is a PowerPC 32-bit Linux ABI option.
11548 @item -mprototype
11549 @itemx -mno-prototype
11550 @opindex mprototype
11551 @opindex mno-prototype
11552 On System V.4 and embedded PowerPC systems assume that all calls to
11553 variable argument functions are properly prototyped.  Otherwise, the
11554 compiler must insert an instruction before every non prototyped call to
11555 set or clear bit 6 of the condition code register (@var{CR}) to
11556 indicate whether floating point values were passed in the floating point
11557 registers in case the function takes a variable arguments.  With
11558 @option{-mprototype}, only calls to prototyped variable argument functions
11559 will set or clear the bit.
11561 @item -msim
11562 @opindex msim
11563 On embedded PowerPC systems, assume that the startup module is called
11564 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11565 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11566 configurations.
11568 @item -mmvme
11569 @opindex mmvme
11570 On embedded PowerPC systems, assume that the startup module is called
11571 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11572 @file{libc.a}.
11574 @item -mads
11575 @opindex mads
11576 On embedded PowerPC systems, assume that the startup module is called
11577 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11578 @file{libc.a}.
11580 @item -myellowknife
11581 @opindex myellowknife
11582 On embedded PowerPC systems, assume that the startup module is called
11583 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11584 @file{libc.a}.
11586 @item -mvxworks
11587 @opindex mvxworks
11588 On System V.4 and embedded PowerPC systems, specify that you are
11589 compiling for a VxWorks system.
11591 @item -mwindiss
11592 @opindex mwindiss
11593 Specify that you are compiling for the WindISS simulation environment.
11595 @item -memb
11596 @opindex memb
11597 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11598 header to indicate that @samp{eabi} extended relocations are used.
11600 @item -meabi
11601 @itemx -mno-eabi
11602 @opindex meabi
11603 @opindex mno-eabi
11604 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11605 Embedded Applications Binary Interface (eabi) which is a set of
11606 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11607 means that the stack is aligned to an 8 byte boundary, a function
11608 @code{__eabi} is called to from @code{main} to set up the eabi
11609 environment, and the @option{-msdata} option can use both @code{r2} and
11610 @code{r13} to point to two separate small data areas.  Selecting
11611 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11612 do not call an initialization function from @code{main}, and the
11613 @option{-msdata} option will only use @code{r13} to point to a single
11614 small data area.  The @option{-meabi} option is on by default if you
11615 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11617 @item -msdata=eabi
11618 @opindex msdata=eabi
11619 On System V.4 and embedded PowerPC systems, put small initialized
11620 @code{const} global and static data in the @samp{.sdata2} section, which
11621 is pointed to by register @code{r2}.  Put small initialized
11622 non-@code{const} global and static data in the @samp{.sdata} section,
11623 which is pointed to by register @code{r13}.  Put small uninitialized
11624 global and static data in the @samp{.sbss} section, which is adjacent to
11625 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11626 incompatible with the @option{-mrelocatable} option.  The
11627 @option{-msdata=eabi} option also sets the @option{-memb} option.
11629 @item -msdata=sysv
11630 @opindex msdata=sysv
11631 On System V.4 and embedded PowerPC systems, put small global and static
11632 data in the @samp{.sdata} section, which is pointed to by register
11633 @code{r13}.  Put small uninitialized global and static data in the
11634 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11635 The @option{-msdata=sysv} option is incompatible with the
11636 @option{-mrelocatable} option.
11638 @item -msdata=default
11639 @itemx -msdata
11640 @opindex msdata=default
11641 @opindex msdata
11642 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11643 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11644 same as @option{-msdata=sysv}.
11646 @item -msdata-data
11647 @opindex msdata-data
11648 On System V.4 and embedded PowerPC systems, put small global
11649 data in the @samp{.sdata} section.  Put small uninitialized global
11650 data in the @samp{.sbss} section.  Do not use register @code{r13}
11651 to address small data however.  This is the default behavior unless
11652 other @option{-msdata} options are used.
11654 @item -msdata=none
11655 @itemx -mno-sdata
11656 @opindex msdata=none
11657 @opindex mno-sdata
11658 On embedded PowerPC systems, put all initialized global and static data
11659 in the @samp{.data} section, and all uninitialized data in the
11660 @samp{.bss} section.
11662 @item -G @var{num}
11663 @opindex G
11664 @cindex smaller data references (PowerPC)
11665 @cindex .sdata/.sdata2 references (PowerPC)
11666 On embedded PowerPC systems, put global and static items less than or
11667 equal to @var{num} bytes into the small data or bss sections instead of
11668 the normal data or bss section.  By default, @var{num} is 8.  The
11669 @option{-G @var{num}} switch is also passed to the linker.
11670 All modules should be compiled with the same @option{-G @var{num}} value.
11672 @item -mregnames
11673 @itemx -mno-regnames
11674 @opindex mregnames
11675 @opindex mno-regnames
11676 On System V.4 and embedded PowerPC systems do (do not) emit register
11677 names in the assembly language output using symbolic forms.
11679 @item -mlongcall
11680 @itemx -mno-longcall
11681 @opindex mlongcall
11682 @opindex mno-longcall
11683 Default to making all function calls indirectly, using a register, so
11684 that functions which reside further than 32 megabytes (33,554,432
11685 bytes) from the current location can be called.  This setting can be
11686 overridden by the @code{shortcall} function attribute, or by
11687 @code{#pragma longcall(0)}.
11689 Some linkers are capable of detecting out-of-range calls and generating
11690 glue code on the fly.  On these systems, long calls are unnecessary and
11691 generate slower code.  As of this writing, the AIX linker can do this,
11692 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11693 to the GNU linker for 32-bit PowerPC systems as well.
11695 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11696 callee, L42'', plus a ``branch island'' (glue code).  The two target
11697 addresses represent the callee and the ``branch island''.  The
11698 Darwin/PPC linker will prefer the first address and generate a ``bl
11699 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11700 otherwise, the linker will generate ``bl L42'' to call the ``branch
11701 island''.  The ``branch island'' is appended to the body of the
11702 calling function; it computes the full 32-bit address of the callee
11703 and jumps to it.
11705 On Mach-O (Darwin) systems, this option directs the compiler emit to
11706 the glue for every direct call, and the Darwin linker decides whether
11707 to use or discard it.
11709 In the future, we may cause GCC to ignore all longcall specifications
11710 when the linker is known to generate glue.
11712 @item -pthread
11713 @opindex pthread
11714 Adds support for multithreading with the @dfn{pthreads} library.
11715 This option sets flags for both the preprocessor and linker.
11717 @end table
11719 @node S/390 and zSeries Options
11720 @subsection S/390 and zSeries Options
11721 @cindex S/390 and zSeries Options
11723 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11725 @table @gcctabopt
11726 @item -mhard-float
11727 @itemx -msoft-float
11728 @opindex mhard-float
11729 @opindex msoft-float
11730 Use (do not use) the hardware floating-point instructions and registers
11731 for floating-point operations.  When @option{-msoft-float} is specified,
11732 functions in @file{libgcc.a} will be used to perform floating-point
11733 operations.  When @option{-mhard-float} is specified, the compiler
11734 generates IEEE floating-point instructions.  This is the default.
11736 @item -mlong-double-64
11737 @itemx -mlong-double-128
11738 @opindex mlong-double-64
11739 @opindex mlong-double-128
11740 These switches control the size of @code{long double} type. A size
11741 of 64bit makes the @code{long double} type equivalent to the @code{double}
11742 type. This is the default.
11744 @item -mbackchain
11745 @itemx -mno-backchain
11746 @opindex mbackchain
11747 @opindex mno-backchain
11748 Store (do not store) the address of the caller's frame as backchain pointer
11749 into the callee's stack frame.
11750 A backchain may be needed to allow debugging using tools that do not understand
11751 DWARF-2 call frame information.
11752 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11753 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11754 the backchain is placed into the topmost word of the 96/160 byte register
11755 save area.
11757 In general, code compiled with @option{-mbackchain} is call-compatible with
11758 code compiled with @option{-mmo-backchain}; however, use of the backchain
11759 for debugging purposes usually requires that the whole binary is built with
11760 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11761 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11762 to build a linux kernel use @option{-msoft-float}.
11764 The default is to not maintain the backchain.
11766 @item -mpacked-stack
11767 @item -mno-packed-stack
11768 @opindex mpacked-stack
11769 @opindex mno-packed-stack
11770 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11771 specified, the compiler uses the all fields of the 96/160 byte register save
11772 area only for their default purpose; unused fields still take up stack space.
11773 When @option{-mpacked-stack} is specified, register save slots are densely
11774 packed at the top of the register save area; unused space is reused for other
11775 purposes, allowing for more efficient use of the available stack space.
11776 However, when @option{-mbackchain} is also in effect, the topmost word of
11777 the save area is always used to store the backchain, and the return address
11778 register is always saved two words below the backchain.
11780 As long as the stack frame backchain is not used, code generated with
11781 @option{-mpacked-stack} is call-compatible with code generated with
11782 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11783 S/390 or zSeries generated code that uses the stack frame backchain at run
11784 time, not just for debugging purposes.  Such code is not call-compatible
11785 with code compiled with @option{-mpacked-stack}.  Also, note that the
11786 combination of @option{-mbackchain},
11787 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11788 to build a linux kernel use @option{-msoft-float}.
11790 The default is to not use the packed stack layout.
11792 @item -msmall-exec
11793 @itemx -mno-small-exec
11794 @opindex msmall-exec
11795 @opindex mno-small-exec
11796 Generate (or do not generate) code using the @code{bras} instruction
11797 to do subroutine calls.
11798 This only works reliably if the total executable size does not
11799 exceed 64k.  The default is to use the @code{basr} instruction instead,
11800 which does not have this limitation.
11802 @item -m64
11803 @itemx -m31
11804 @opindex m64
11805 @opindex m31
11806 When @option{-m31} is specified, generate code compliant to the
11807 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11808 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11809 particular to generate 64-bit instructions.  For the @samp{s390}
11810 targets, the default is @option{-m31}, while the @samp{s390x}
11811 targets default to @option{-m64}.
11813 @item -mzarch
11814 @itemx -mesa
11815 @opindex mzarch
11816 @opindex mesa
11817 When @option{-mzarch} is specified, generate code using the
11818 instructions available on z/Architecture.
11819 When @option{-mesa} is specified, generate code using the
11820 instructions available on ESA/390.  Note that @option{-mesa} is
11821 not possible with @option{-m64}.
11822 When generating code compliant to the GNU/Linux for S/390 ABI,
11823 the default is @option{-mesa}.  When generating code compliant
11824 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11826 @item -mmvcle
11827 @itemx -mno-mvcle
11828 @opindex mmvcle
11829 @opindex mno-mvcle
11830 Generate (or do not generate) code using the @code{mvcle} instruction
11831 to perform block moves.  When @option{-mno-mvcle} is specified,
11832 use a @code{mvc} loop instead.  This is the default unless optimizing for
11833 size.
11835 @item -mdebug
11836 @itemx -mno-debug
11837 @opindex mdebug
11838 @opindex mno-debug
11839 Print (or do not print) additional debug information when compiling.
11840 The default is to not print debug information.
11842 @item -march=@var{cpu-type}
11843 @opindex march
11844 Generate code that will run on @var{cpu-type}, which is the name of a system
11845 representing a certain processor type.  Possible values for
11846 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11847 When generating code using the instructions available on z/Architecture,
11848 the default is @option{-march=z900}.  Otherwise, the default is
11849 @option{-march=g5}.
11851 @item -mtune=@var{cpu-type}
11852 @opindex mtune
11853 Tune to @var{cpu-type} everything applicable about the generated code,
11854 except for the ABI and the set of available instructions.
11855 The list of @var{cpu-type} values is the same as for @option{-march}.
11856 The default is the value used for @option{-march}.
11858 @item -mtpf-trace
11859 @itemx -mno-tpf-trace
11860 @opindex mtpf-trace
11861 @opindex mno-tpf-trace
11862 Generate code that adds (does not add) in TPF OS specific branches to trace
11863 routines in the operating system.  This option is off by default, even
11864 when compiling for the TPF OS@.
11866 @item -mfused-madd
11867 @itemx -mno-fused-madd
11868 @opindex mfused-madd
11869 @opindex mno-fused-madd
11870 Generate code that uses (does not use) the floating point multiply and
11871 accumulate instructions.  These instructions are generated by default if
11872 hardware floating point is used.
11874 @item -mwarn-framesize=@var{framesize}
11875 @opindex mwarn-framesize
11876 Emit a warning if the current function exceeds the given frame size.  Because
11877 this is a compile time check it doesn't need to be a real problem when the program
11878 runs.  It is intended to identify functions which most probably cause
11879 a stack overflow.  It is useful to be used in an environment with limited stack
11880 size e.g.@: the linux kernel.
11882 @item -mwarn-dynamicstack
11883 @opindex mwarn-dynamicstack
11884 Emit a warning if the function calls alloca or uses dynamically
11885 sized arrays.  This is generally a bad idea with a limited stack size.
11887 @item -mstack-guard=@var{stack-guard}
11888 @item -mstack-size=@var{stack-size}
11889 @opindex mstack-guard
11890 @opindex mstack-size
11891 These arguments always have to be used in conjunction.  If they are present the s390
11892 back end emits additional instructions in the function prologue which trigger a trap
11893 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11894 (remember that the stack on s390 grows downward).  These options are intended to
11895 be used to help debugging stack overflow problems.  The additionally emitted code
11896 causes only little overhead and hence can also be used in production like systems
11897 without greater performance degradation.  The given values have to be exact
11898 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11899 exceeding 64k.
11900 In order to be efficient the extra code makes the assumption that the stack starts
11901 at an address aligned to the value given by @var{stack-size}.
11902 @end table
11904 @node SH Options
11905 @subsection SH Options
11907 These @samp{-m} options are defined for the SH implementations:
11909 @table @gcctabopt
11910 @item -m1
11911 @opindex m1
11912 Generate code for the SH1.
11914 @item -m2
11915 @opindex m2
11916 Generate code for the SH2.
11918 @item -m2e
11919 Generate code for the SH2e.
11921 @item -m3
11922 @opindex m3
11923 Generate code for the SH3.
11925 @item -m3e
11926 @opindex m3e
11927 Generate code for the SH3e.
11929 @item -m4-nofpu
11930 @opindex m4-nofpu
11931 Generate code for the SH4 without a floating-point unit.
11933 @item -m4-single-only
11934 @opindex m4-single-only
11935 Generate code for the SH4 with a floating-point unit that only
11936 supports single-precision arithmetic.
11938 @item -m4-single
11939 @opindex m4-single
11940 Generate code for the SH4 assuming the floating-point unit is in
11941 single-precision mode by default.
11943 @item -m4
11944 @opindex m4
11945 Generate code for the SH4.
11947 @item -m4a-nofpu
11948 @opindex m4a-nofpu
11949 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11950 floating-point unit is not used.
11952 @item -m4a-single-only
11953 @opindex m4a-single-only
11954 Generate code for the SH4a, in such a way that no double-precision
11955 floating point operations are used.
11957 @item -m4a-single
11958 @opindex m4a-single
11959 Generate code for the SH4a assuming the floating-point unit is in
11960 single-precision mode by default.
11962 @item -m4a
11963 @opindex m4a
11964 Generate code for the SH4a.
11966 @item -m4al
11967 @opindex m4al
11968 Same as @option{-m4a-nofpu}, except that it implicitly passes
11969 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11970 instructions at the moment.
11972 @item -mb
11973 @opindex mb
11974 Compile code for the processor in big endian mode.
11976 @item -ml
11977 @opindex ml
11978 Compile code for the processor in little endian mode.
11980 @item -mdalign
11981 @opindex mdalign
11982 Align doubles at 64-bit boundaries.  Note that this changes the calling
11983 conventions, and thus some functions from the standard C library will
11984 not work unless you recompile it first with @option{-mdalign}.
11986 @item -mrelax
11987 @opindex mrelax
11988 Shorten some address references at link time, when possible; uses the
11989 linker option @option{-relax}.
11991 @item -mbigtable
11992 @opindex mbigtable
11993 Use 32-bit offsets in @code{switch} tables.  The default is to use
11994 16-bit offsets.
11996 @item -mfmovd
11997 @opindex mfmovd
11998 Enable the use of the instruction @code{fmovd}.
12000 @item -mhitachi
12001 @opindex mhitachi
12002 Comply with the calling conventions defined by Renesas.
12004 @item -mrenesas
12005 @opindex mhitachi
12006 Comply with the calling conventions defined by Renesas.
12008 @item -mno-renesas
12009 @opindex mhitachi
12010 Comply with the calling conventions defined for GCC before the Renesas
12011 conventions were available.  This option is the default for all
12012 targets of the SH toolchain except for @samp{sh-symbianelf}.
12014 @item -mnomacsave
12015 @opindex mnomacsave
12016 Mark the @code{MAC} register as call-clobbered, even if
12017 @option{-mhitachi} is given.
12019 @item -mieee
12020 @opindex mieee
12021 Increase IEEE-compliance of floating-point code.
12022 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12023 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12024 comparisons of NANs / infinities incurs extra overhead in every
12025 floating point comparison, therefore the default is set to
12026 @option{-ffinite-math-only}.
12028 @item -misize
12029 @opindex misize
12030 Dump instruction size and location in the assembly code.
12032 @item -mpadstruct
12033 @opindex mpadstruct
12034 This option is deprecated.  It pads structures to multiple of 4 bytes,
12035 which is incompatible with the SH ABI@.
12037 @item -mspace
12038 @opindex mspace
12039 Optimize for space instead of speed.  Implied by @option{-Os}.
12041 @item -mprefergot
12042 @opindex mprefergot
12043 When generating position-independent code, emit function calls using
12044 the Global Offset Table instead of the Procedure Linkage Table.
12046 @item -musermode
12047 @opindex musermode
12048 Generate a library function call to invalidate instruction cache
12049 entries, after fixing up a trampoline.  This library function call
12050 doesn't assume it can write to the whole memory address space.  This
12051 is the default when the target is @code{sh-*-linux*}.
12053 @item -multcost=@var{number}
12054 @opindex multcost=@var{number}
12055 Set the cost to assume for a multiply insn.
12057 @item -mdiv=@var{strategy}
12058 @opindex mdiv=@var{strategy}
12059 Set the division strategy to use for SHmedia code.  @var{strategy} must be
12060 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12061 inv:call2, inv:fp .
12062 "fp" performs the operation in floating point.  This has a very high latency,
12063 but needs only a few instructions, so it might be a good choice if
12064 your code has enough easily exploitable ILP to allow the compiler to
12065 schedule the floating point instructions together with other instructions.
12066 Division by zero causes a floating point exception.
12067 "inv" uses integer operations to calculate the inverse of the divisor,
12068 and then multiplies the dividend with the inverse.  This strategy allows
12069 cse and hoisting of the inverse calculation.  Division by zero calculates
12070 an unspecified result, but does not trap.
12071 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12072 have been found, or if the entire operation has been hoisted to the same
12073 place, the last stages of the inverse calculation are intertwined with the
12074 final multiply to reduce the overall latency, at the expense of using a few
12075 more instructions, and thus offering fewer scheduling opportunities with
12076 other code.
12077 "call" calls a library function that usually implements the inv:minlat
12078 strategy.
12079 This gives high code density for m5-*media-nofpu compilations.
12080 "call2" uses a different entry point of the same library function, where it
12081 assumes that a pointer to a lookup table has already been set up, which
12082 exposes the pointer load to cse / code hoisting optimizations.
12083 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12084 code generation, but if the code stays unoptimized, revert to the "call",
12085 "call2", or "fp" strategies, respectively.  Note that the
12086 potentially-trapping side effect of division by zero is carried by a
12087 separate instruction, so it is possible that all the integer instructions
12088 are hoisted out, but the marker for the side effect stays where it is.
12089 A recombination to fp operations or a call is not possible in that case.
12090 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
12091 that the inverse calculation was nor separated from the multiply, they speed
12092 up division where the dividend fits into 20 bits (plus sign where applicable),
12093 by inserting a test to skip a number of operations in this case; this test
12094 slows down the case of larger dividends.  inv20u assumes the case of a such
12095 a small dividend to be unlikely, and inv20l assumes it to be likely.
12097 @item -mdivsi3_libfunc=@var{name}
12098 @opindex mdivsi3_libfunc=@var{name}
12099 Set the name of the library function used for 32 bit signed division to
12100 @var{name}.  This only affect the name used in the call and inv:call
12101 division strategies, and the compiler will still expect the same
12102 sets of input/output/clobbered registers as if this option was not present.
12104 @item -madjust-unroll
12105 @opindex madjust-unroll
12106 Throttle unrolling to avoid thrashing target registers.
12107 This option only has an effect if the gcc code base supports the
12108 TARGET_ADJUST_UNROLL_MAX target hook.
12110 @item -mindexed-addressing
12111 @opindex mindexed-addressing
12112 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12113 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12114 semantics for the indexed addressing mode.  The architecture allows the
12115 implementation of processors with 64 bit MMU, which the OS could use to
12116 get 32 bit addressing, but since no current hardware implementation supports
12117 this or any other way to make the indexed addressing mode safe to use in
12118 the 32 bit ABI, the default is -mno-indexed-addressing.
12120 @item -mgettrcost=@var{number}
12121 @opindex mgettrcost=@var{number}
12122 Set the cost assumed for the gettr instruction to @var{number}.
12123 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12125 @item -mpt-fixed
12126 @opindex mpt-fixed
12127 Assume pt* instructions won't trap.  This will generally generate better
12128 scheduled code, but is unsafe on current hardware.  The current architecture
12129 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12130 This has the unintentional effect of making it unsafe to schedule ptabs /
12131 ptrel before a branch, or hoist it out of a loop.  For example,
12132 __do_global_ctors, a part of libgcc that runs constructors at program
12133 startup, calls functions in a list which is delimited by -1.  With the
12134 -mpt-fixed option, the ptabs will be done before testing against -1.
12135 That means that all the constructors will be run a bit quicker, but when
12136 the loop comes to the end of the list, the program crashes because ptabs
12137 loads -1 into a target register.  Since this option is unsafe for any
12138 hardware implementing the current architecture specification, the default
12139 is -mno-pt-fixed.  Unless the user specifies a specific cost with
12140 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12141 this deters register allocation using target registers for storing
12142 ordinary integers.
12144 @item -minvalid-symbols
12145 @opindex minvalid-symbols
12146 Assume symbols might be invalid.  Ordinary function symbols generated by
12147 the compiler will always be valid to load with movi/shori/ptabs or
12148 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12149 to generate symbols that will cause ptabs / ptrel to trap.
12150 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12151 It will then prevent cross-basic-block cse, hoisting and most scheduling
12152 of symbol loads.  The default is @option{-mno-invalid-symbols}.
12153 @end table
12155 @node SPARC Options
12156 @subsection SPARC Options
12157 @cindex SPARC options
12159 These @samp{-m} options are supported on the SPARC:
12161 @table @gcctabopt
12162 @item -mno-app-regs
12163 @itemx -mapp-regs
12164 @opindex mno-app-regs
12165 @opindex mapp-regs
12166 Specify @option{-mapp-regs} to generate output using the global registers
12167 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
12168 is the default.
12170 To be fully SVR4 ABI compliant at the cost of some performance loss,
12171 specify @option{-mno-app-regs}.  You should compile libraries and system
12172 software with this option.
12174 @item -mfpu
12175 @itemx -mhard-float
12176 @opindex mfpu
12177 @opindex mhard-float
12178 Generate output containing floating point instructions.  This is the
12179 default.
12181 @item -mno-fpu
12182 @itemx -msoft-float
12183 @opindex mno-fpu
12184 @opindex msoft-float
12185 Generate output containing library calls for floating point.
12186 @strong{Warning:} the requisite libraries are not available for all SPARC
12187 targets.  Normally the facilities of the machine's usual C compiler are
12188 used, but this cannot be done directly in cross-compilation.  You must make
12189 your own arrangements to provide suitable library functions for
12190 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
12191 @samp{sparclite-*-*} do provide software floating point support.
12193 @option{-msoft-float} changes the calling convention in the output file;
12194 therefore, it is only useful if you compile @emph{all} of a program with
12195 this option.  In particular, you need to compile @file{libgcc.a}, the
12196 library that comes with GCC, with @option{-msoft-float} in order for
12197 this to work.
12199 @item -mhard-quad-float
12200 @opindex mhard-quad-float
12201 Generate output containing quad-word (long double) floating point
12202 instructions.
12204 @item -msoft-quad-float
12205 @opindex msoft-quad-float
12206 Generate output containing library calls for quad-word (long double)
12207 floating point instructions.  The functions called are those specified
12208 in the SPARC ABI@.  This is the default.
12210 As of this writing, there are no SPARC implementations that have hardware
12211 support for the quad-word floating point instructions.  They all invoke
12212 a trap handler for one of these instructions, and then the trap handler
12213 emulates the effect of the instruction.  Because of the trap handler overhead,
12214 this is much slower than calling the ABI library routines.  Thus the
12215 @option{-msoft-quad-float} option is the default.
12217 @item -mno-unaligned-doubles
12218 @itemx -munaligned-doubles
12219 @opindex mno-unaligned-doubles
12220 @opindex munaligned-doubles
12221 Assume that doubles have 8 byte alignment.  This is the default.
12223 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12224 alignment only if they are contained in another type, or if they have an
12225 absolute address.  Otherwise, it assumes they have 4 byte alignment.
12226 Specifying this option avoids some rare compatibility problems with code
12227 generated by other compilers.  It is not the default because it results
12228 in a performance loss, especially for floating point code.
12230 @item -mno-faster-structs
12231 @itemx -mfaster-structs
12232 @opindex mno-faster-structs
12233 @opindex mfaster-structs
12234 With @option{-mfaster-structs}, the compiler assumes that structures
12235 should have 8 byte alignment.  This enables the use of pairs of
12236 @code{ldd} and @code{std} instructions for copies in structure
12237 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12238 However, the use of this changed alignment directly violates the SPARC
12239 ABI@.  Thus, it's intended only for use on targets where the developer
12240 acknowledges that their resulting code will not be directly in line with
12241 the rules of the ABI@.
12243 @item -mimpure-text
12244 @opindex mimpure-text
12245 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12246 the compiler to not pass @option{-z text} to the linker when linking a
12247 shared object.  Using this option, you can link position-dependent
12248 code into a shared object.
12250 @option{-mimpure-text} suppresses the ``relocations remain against
12251 allocatable but non-writable sections'' linker error message.
12252 However, the necessary relocations will trigger copy-on-write, and the
12253 shared object is not actually shared across processes.  Instead of
12254 using @option{-mimpure-text}, you should compile all source code with
12255 @option{-fpic} or @option{-fPIC}.
12257 This option is only available on SunOS and Solaris.
12259 @item -mcpu=@var{cpu_type}
12260 @opindex mcpu
12261 Set the instruction set, register set, and instruction scheduling parameters
12262 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
12263 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12264 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12265 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12266 @samp{ultrasparc3}, and @samp{niagara}.
12268 Default instruction scheduling parameters are used for values that select
12269 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
12270 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12272 Here is a list of each supported architecture and their supported
12273 implementations.
12275 @smallexample
12276     v7:             cypress
12277     v8:             supersparc, hypersparc
12278     sparclite:      f930, f934, sparclite86x
12279     sparclet:       tsc701
12280     v9:             ultrasparc, ultrasparc3, niagara
12281 @end smallexample
12283 By default (unless configured otherwise), GCC generates code for the V7
12284 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
12285 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12286 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
12287 SPARCStation 1, 2, IPX etc.
12289 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12290 architecture.  The only difference from V7 code is that the compiler emits
12291 the integer multiply and integer divide instructions which exist in SPARC-V8
12292 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
12293 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12294 2000 series.
12296 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12297 the SPARC architecture.  This adds the integer multiply, integer divide step
12298 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12299 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12300 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
12301 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12302 MB86934 chip, which is the more recent SPARClite with FPU@.
12304 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12305 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
12306 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12307 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
12308 optimizes it for the TEMIC SPARClet chip.
12310 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12311 architecture.  This adds 64-bit integer and floating-point move instructions,
12312 3 additional floating-point condition code registers and conditional move
12313 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
12314 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
12315 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12316 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
12317 @option{-mcpu=niagara}, the compiler additionally optimizes it for
12318 Sun UltraSPARC T1 chips.
12320 @item -mtune=@var{cpu_type}
12321 @opindex mtune
12322 Set the instruction scheduling parameters for machine type
12323 @var{cpu_type}, but do not set the instruction set or register set that the
12324 option @option{-mcpu=@var{cpu_type}} would.
12326 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12327 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12328 that select a particular cpu implementation.  Those are @samp{cypress},
12329 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12330 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
12331 @samp{ultrasparc3}, and @samp{niagara}.
12333 @item -mv8plus
12334 @itemx -mno-v8plus
12335 @opindex mv8plus
12336 @opindex mno-v8plus
12337 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
12338 difference from the V8 ABI is that the global and out registers are
12339 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
12340 mode for all SPARC-V9 processors.
12342 @item -mvis
12343 @itemx -mno-vis
12344 @opindex mvis
12345 @opindex mno-vis
12346 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12347 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
12348 @end table
12350 These @samp{-m} options are supported in addition to the above
12351 on SPARC-V9 processors in 64-bit environments:
12353 @table @gcctabopt
12354 @item -mlittle-endian
12355 @opindex mlittle-endian
12356 Generate code for a processor running in little-endian mode.  It is only
12357 available for a few configurations and most notably not on Solaris and Linux.
12359 @item -m32
12360 @itemx -m64
12361 @opindex m32
12362 @opindex m64
12363 Generate code for a 32-bit or 64-bit environment.
12364 The 32-bit environment sets int, long and pointer to 32 bits.
12365 The 64-bit environment sets int to 32 bits and long and pointer
12366 to 64 bits.
12368 @item -mcmodel=medlow
12369 @opindex mcmodel=medlow
12370 Generate code for the Medium/Low code model: 64-bit addresses, programs
12371 must be linked in the low 32 bits of memory.  Programs can be statically
12372 or dynamically linked.
12374 @item -mcmodel=medmid
12375 @opindex mcmodel=medmid
12376 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12377 must be linked in the low 44 bits of memory, the text and data segments must
12378 be less than 2GB in size and the data segment must be located within 2GB of
12379 the text segment.
12381 @item -mcmodel=medany
12382 @opindex mcmodel=medany
12383 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12384 may be linked anywhere in memory, the text and data segments must be less
12385 than 2GB in size and the data segment must be located within 2GB of the
12386 text segment.
12388 @item -mcmodel=embmedany
12389 @opindex mcmodel=embmedany
12390 Generate code for the Medium/Anywhere code model for embedded systems:
12391 64-bit addresses, the text and data segments must be less than 2GB in
12392 size, both starting anywhere in memory (determined at link time).  The
12393 global register %g4 points to the base of the data segment.  Programs
12394 are statically linked and PIC is not supported.
12396 @item -mstack-bias
12397 @itemx -mno-stack-bias
12398 @opindex mstack-bias
12399 @opindex mno-stack-bias
12400 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12401 frame pointer if present, are offset by @minus{}2047 which must be added back
12402 when making stack frame references.  This is the default in 64-bit mode.
12403 Otherwise, assume no such offset is present.
12404 @end table
12406 These switches are supported in addition to the above on Solaris:
12408 @table @gcctabopt
12409 @item -threads
12410 @opindex threads
12411 Add support for multithreading using the Solaris threads library.  This
12412 option sets flags for both the preprocessor and linker.  This option does
12413 not affect the thread safety of object code produced by the compiler or
12414 that of libraries supplied with it.
12416 @item -pthreads
12417 @opindex pthreads
12418 Add support for multithreading using the POSIX threads library.  This
12419 option sets flags for both the preprocessor and linker.  This option does
12420 not affect the thread safety of object code produced  by the compiler or
12421 that of libraries supplied with it.
12423 @item -pthread
12424 @opindex pthread
12425 This is a synonym for @option{-pthreads}.
12426 @end table
12428 @node System V Options
12429 @subsection Options for System V
12431 These additional options are available on System V Release 4 for
12432 compatibility with other compilers on those systems:
12434 @table @gcctabopt
12435 @item -G
12436 @opindex G
12437 Create a shared object.
12438 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12440 @item -Qy
12441 @opindex Qy
12442 Identify the versions of each tool used by the compiler, in a
12443 @code{.ident} assembler directive in the output.
12445 @item -Qn
12446 @opindex Qn
12447 Refrain from adding @code{.ident} directives to the output file (this is
12448 the default).
12450 @item -YP,@var{dirs}
12451 @opindex YP
12452 Search the directories @var{dirs}, and no others, for libraries
12453 specified with @option{-l}.
12455 @item -Ym,@var{dir}
12456 @opindex Ym
12457 Look in the directory @var{dir} to find the M4 preprocessor.
12458 The assembler uses this option.
12459 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12460 @c the generic assembler that comes with Solaris takes just -Ym.
12461 @end table
12463 @node TMS320C3x/C4x Options
12464 @subsection TMS320C3x/C4x Options
12465 @cindex TMS320C3x/C4x Options
12467 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12469 @table @gcctabopt
12471 @item -mcpu=@var{cpu_type}
12472 @opindex mcpu
12473 Set the instruction set, register set, and instruction scheduling
12474 parameters for machine type @var{cpu_type}.  Supported values for
12475 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12476 @samp{c44}.  The default is @samp{c40} to generate code for the
12477 TMS320C40.
12479 @item -mbig-memory
12480 @itemx -mbig
12481 @itemx -msmall-memory
12482 @itemx -msmall
12483 @opindex mbig-memory
12484 @opindex mbig
12485 @opindex msmall-memory
12486 @opindex msmall
12487 Generates code for the big or small memory model.  The small memory
12488 model assumed that all data fits into one 64K word page.  At run-time
12489 the data page (DP) register must be set to point to the 64K page
12490 containing the .bss and .data program sections.  The big memory model is
12491 the default and requires reloading of the DP register for every direct
12492 memory access.
12494 @item -mbk
12495 @itemx -mno-bk
12496 @opindex mbk
12497 @opindex mno-bk
12498 Allow (disallow) allocation of general integer operands into the block
12499 count register BK@.
12501 @item -mdb
12502 @itemx -mno-db
12503 @opindex mdb
12504 @opindex mno-db
12505 Enable (disable) generation of code using decrement and branch,
12506 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12507 on the safe side, this is disabled for the C3x, since the maximum
12508 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12509 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12510 that it can utilize the decrement and branch instruction, but will give
12511 up if there is more than one memory reference in the loop.  Thus a loop
12512 where the loop counter is decremented can generate slightly more
12513 efficient code, in cases where the RPTB instruction cannot be utilized.
12515 @item -mdp-isr-reload
12516 @itemx -mparanoid
12517 @opindex mdp-isr-reload
12518 @opindex mparanoid
12519 Force the DP register to be saved on entry to an interrupt service
12520 routine (ISR), reloaded to point to the data section, and restored on
12521 exit from the ISR@.  This should not be required unless someone has
12522 violated the small memory model by modifying the DP register, say within
12523 an object library.
12525 @item -mmpyi
12526 @itemx -mno-mpyi
12527 @opindex mmpyi
12528 @opindex mno-mpyi
12529 For the C3x use the 24-bit MPYI instruction for integer multiplies
12530 instead of a library call to guarantee 32-bit results.  Note that if one
12531 of the operands is a constant, then the multiplication will be performed
12532 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12533 then squaring operations are performed inline instead of a library call.
12535 @item -mfast-fix
12536 @itemx -mno-fast-fix
12537 @opindex mfast-fix
12538 @opindex mno-fast-fix
12539 The C3x/C4x FIX instruction to convert a floating point value to an
12540 integer value chooses the nearest integer less than or equal to the
12541 floating point value rather than to the nearest integer.  Thus if the
12542 floating point number is negative, the result will be incorrectly
12543 truncated an additional code is necessary to detect and correct this
12544 case.  This option can be used to disable generation of the additional
12545 code required to correct the result.
12547 @item -mrptb
12548 @itemx -mno-rptb
12549 @opindex mrptb
12550 @opindex mno-rptb
12551 Enable (disable) generation of repeat block sequences using the RPTB
12552 instruction for zero overhead looping.  The RPTB construct is only used
12553 for innermost loops that do not call functions or jump across the loop
12554 boundaries.  There is no advantage having nested RPTB loops due to the
12555 overhead required to save and restore the RC, RS, and RE registers.
12556 This is enabled by default with @option{-O2}.
12558 @item -mrpts=@var{count}
12559 @itemx -mno-rpts
12560 @opindex mrpts
12561 @opindex mno-rpts
12562 Enable (disable) the use of the single instruction repeat instruction
12563 RPTS@.  If a repeat block contains a single instruction, and the loop
12564 count can be guaranteed to be less than the value @var{count}, GCC will
12565 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12566 then a RPTS will be emitted even if the loop count cannot be determined
12567 at compile time.  Note that the repeated instruction following RPTS does
12568 not have to be reloaded from memory each iteration, thus freeing up the
12569 CPU buses for operands.  However, since interrupts are blocked by this
12570 instruction, it is disabled by default.
12572 @item -mloop-unsigned
12573 @itemx -mno-loop-unsigned
12574 @opindex mloop-unsigned
12575 @opindex mno-loop-unsigned
12576 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12577 is @math{2^{31} + 1} since these instructions test if the iteration count is
12578 negative to terminate the loop.  If the iteration count is unsigned
12579 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12580 exceeded.  This switch allows an unsigned iteration count.
12582 @item -mti
12583 @opindex mti
12584 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12585 with.  This also enforces compatibility with the API employed by the TI
12586 C3x C compiler.  For example, long doubles are passed as structures
12587 rather than in floating point registers.
12589 @item -mregparm
12590 @itemx -mmemparm
12591 @opindex mregparm
12592 @opindex mmemparm
12593 Generate code that uses registers (stack) for passing arguments to functions.
12594 By default, arguments are passed in registers where possible rather
12595 than by pushing arguments on to the stack.
12597 @item -mparallel-insns
12598 @itemx -mno-parallel-insns
12599 @opindex mparallel-insns
12600 @opindex mno-parallel-insns
12601 Allow the generation of parallel instructions.  This is enabled by
12602 default with @option{-O2}.
12604 @item -mparallel-mpy
12605 @itemx -mno-parallel-mpy
12606 @opindex mparallel-mpy
12607 @opindex mno-parallel-mpy
12608 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12609 provided @option{-mparallel-insns} is also specified.  These instructions have
12610 tight register constraints which can pessimize the code generation
12611 of large functions.
12613 @end table
12615 @node V850 Options
12616 @subsection V850 Options
12617 @cindex V850 Options
12619 These @samp{-m} options are defined for V850 implementations:
12621 @table @gcctabopt
12622 @item -mlong-calls
12623 @itemx -mno-long-calls
12624 @opindex mlong-calls
12625 @opindex mno-long-calls
12626 Treat all calls as being far away (near).  If calls are assumed to be
12627 far away, the compiler will always load the functions address up into a
12628 register, and call indirect through the pointer.
12630 @item -mno-ep
12631 @itemx -mep
12632 @opindex mno-ep
12633 @opindex mep
12634 Do not optimize (do optimize) basic blocks that use the same index
12635 pointer 4 or more times to copy pointer into the @code{ep} register, and
12636 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12637 option is on by default if you optimize.
12639 @item -mno-prolog-function
12640 @itemx -mprolog-function
12641 @opindex mno-prolog-function
12642 @opindex mprolog-function
12643 Do not use (do use) external functions to save and restore registers
12644 at the prologue and epilogue of a function.  The external functions
12645 are slower, but use less code space if more than one function saves
12646 the same number of registers.  The @option{-mprolog-function} option
12647 is on by default if you optimize.
12649 @item -mspace
12650 @opindex mspace
12651 Try to make the code as small as possible.  At present, this just turns
12652 on the @option{-mep} and @option{-mprolog-function} options.
12654 @item -mtda=@var{n}
12655 @opindex mtda
12656 Put static or global variables whose size is @var{n} bytes or less into
12657 the tiny data area that register @code{ep} points to.  The tiny data
12658 area can hold up to 256 bytes in total (128 bytes for byte references).
12660 @item -msda=@var{n}
12661 @opindex msda
12662 Put static or global variables whose size is @var{n} bytes or less into
12663 the small data area that register @code{gp} points to.  The small data
12664 area can hold up to 64 kilobytes.
12666 @item -mzda=@var{n}
12667 @opindex mzda
12668 Put static or global variables whose size is @var{n} bytes or less into
12669 the first 32 kilobytes of memory.
12671 @item -mv850
12672 @opindex mv850
12673 Specify that the target processor is the V850.
12675 @item -mbig-switch
12676 @opindex mbig-switch
12677 Generate code suitable for big switch tables.  Use this option only if
12678 the assembler/linker complain about out of range branches within a switch
12679 table.
12681 @item -mapp-regs
12682 @opindex mapp-regs
12683 This option will cause r2 and r5 to be used in the code generated by
12684 the compiler.  This setting is the default.
12686 @item -mno-app-regs
12687 @opindex mno-app-regs
12688 This option will cause r2 and r5 to be treated as fixed registers.
12690 @item -mv850e1
12691 @opindex mv850e1
12692 Specify that the target processor is the V850E1.  The preprocessor
12693 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12694 this option is used.
12696 @item -mv850e
12697 @opindex mv850e
12698 Specify that the target processor is the V850E@.  The preprocessor
12699 constant @samp{__v850e__} will be defined if this option is used.
12701 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12702 are defined then a default target processor will be chosen and the
12703 relevant @samp{__v850*__} preprocessor constant will be defined.
12705 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12706 defined, regardless of which processor variant is the target.
12708 @item -mdisable-callt
12709 @opindex mdisable-callt
12710 This option will suppress generation of the CALLT instruction for the
12711 v850e and v850e1 flavors of the v850 architecture.  The default is
12712 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12714 @end table
12716 @node VAX Options
12717 @subsection VAX Options
12718 @cindex VAX options
12720 These @samp{-m} options are defined for the VAX:
12722 @table @gcctabopt
12723 @item -munix
12724 @opindex munix
12725 Do not output certain jump instructions (@code{aobleq} and so on)
12726 that the Unix assembler for the VAX cannot handle across long
12727 ranges.
12729 @item -mgnu
12730 @opindex mgnu
12731 Do output those jump instructions, on the assumption that you
12732 will assemble with the GNU assembler.
12734 @item -mg
12735 @opindex mg
12736 Output code for g-format floating point numbers instead of d-format.
12737 @end table
12739 @node x86-64 Options
12740 @subsection x86-64 Options
12741 @cindex x86-64 options
12743 These are listed under @xref{i386 and x86-64 Options}.
12745 @node Xstormy16 Options
12746 @subsection Xstormy16 Options
12747 @cindex Xstormy16 Options
12749 These options are defined for Xstormy16:
12751 @table @gcctabopt
12752 @item -msim
12753 @opindex msim
12754 Choose startup files and linker script suitable for the simulator.
12755 @end table
12757 @node Xtensa Options
12758 @subsection Xtensa Options
12759 @cindex Xtensa Options
12761 These options are supported for Xtensa targets:
12763 @table @gcctabopt
12764 @item -mconst16
12765 @itemx -mno-const16
12766 @opindex mconst16
12767 @opindex mno-const16
12768 Enable or disable use of @code{CONST16} instructions for loading
12769 constant values.  The @code{CONST16} instruction is currently not a
12770 standard option from Tensilica.  When enabled, @code{CONST16}
12771 instructions are always used in place of the standard @code{L32R}
12772 instructions.  The use of @code{CONST16} is enabled by default only if
12773 the @code{L32R} instruction is not available.
12775 @item -mfused-madd
12776 @itemx -mno-fused-madd
12777 @opindex mfused-madd
12778 @opindex mno-fused-madd
12779 Enable or disable use of fused multiply/add and multiply/subtract
12780 instructions in the floating-point option.  This has no effect if the
12781 floating-point option is not also enabled.  Disabling fused multiply/add
12782 and multiply/subtract instructions forces the compiler to use separate
12783 instructions for the multiply and add/subtract operations.  This may be
12784 desirable in some cases where strict IEEE 754-compliant results are
12785 required: the fused multiply add/subtract instructions do not round the
12786 intermediate result, thereby producing results with @emph{more} bits of
12787 precision than specified by the IEEE standard.  Disabling fused multiply
12788 add/subtract instructions also ensures that the program output is not
12789 sensitive to the compiler's ability to combine multiply and add/subtract
12790 operations.
12792 @item -mtext-section-literals
12793 @itemx -mno-text-section-literals
12794 @opindex mtext-section-literals
12795 @opindex mno-text-section-literals
12796 Control the treatment of literal pools.  The default is
12797 @option{-mno-text-section-literals}, which places literals in a separate
12798 section in the output file.  This allows the literal pool to be placed
12799 in a data RAM/ROM, and it also allows the linker to combine literal
12800 pools from separate object files to remove redundant literals and
12801 improve code size.  With @option{-mtext-section-literals}, the literals
12802 are interspersed in the text section in order to keep them as close as
12803 possible to their references.  This may be necessary for large assembly
12804 files.
12806 @item -mtarget-align
12807 @itemx -mno-target-align
12808 @opindex mtarget-align
12809 @opindex mno-target-align
12810 When this option is enabled, GCC instructs the assembler to
12811 automatically align instructions to reduce branch penalties at the
12812 expense of some code density.  The assembler attempts to widen density
12813 instructions to align branch targets and the instructions following call
12814 instructions.  If there are not enough preceding safe density
12815 instructions to align a target, no widening will be performed.  The
12816 default is @option{-mtarget-align}.  These options do not affect the
12817 treatment of auto-aligned instructions like @code{LOOP}, which the
12818 assembler will always align, either by widening density instructions or
12819 by inserting no-op instructions.
12821 @item -mlongcalls
12822 @itemx -mno-longcalls
12823 @opindex mlongcalls
12824 @opindex mno-longcalls
12825 When this option is enabled, GCC instructs the assembler to translate
12826 direct calls to indirect calls unless it can determine that the target
12827 of a direct call is in the range allowed by the call instruction.  This
12828 translation typically occurs for calls to functions in other source
12829 files.  Specifically, the assembler translates a direct @code{CALL}
12830 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12831 The default is @option{-mno-longcalls}.  This option should be used in
12832 programs where the call target can potentially be out of range.  This
12833 option is implemented in the assembler, not the compiler, so the
12834 assembly code generated by GCC will still show direct call
12835 instructions---look at the disassembled object code to see the actual
12836 instructions.  Note that the assembler will use an indirect call for
12837 every cross-file call, not just those that really will be out of range.
12838 @end table
12840 @node zSeries Options
12841 @subsection zSeries Options
12842 @cindex zSeries options
12844 These are listed under @xref{S/390 and zSeries Options}.
12846 @node Code Gen Options
12847 @section Options for Code Generation Conventions
12848 @cindex code generation conventions
12849 @cindex options, code generation
12850 @cindex run-time options
12852 These machine-independent options control the interface conventions
12853 used in code generation.
12855 Most of them have both positive and negative forms; the negative form
12856 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12857 one of the forms is listed---the one which is not the default.  You
12858 can figure out the other form by either removing @samp{no-} or adding
12861 @table @gcctabopt
12862 @item -fbounds-check
12863 @opindex fbounds-check
12864 For front-ends that support it, generate additional code to check that
12865 indices used to access arrays are within the declared range.  This is
12866 currently only supported by the Java and Fortran 77 front-ends, where
12867 this option defaults to true and false respectively.
12869 @item -ftrapv
12870 @opindex ftrapv
12871 This option generates traps for signed overflow on addition, subtraction,
12872 multiplication operations.
12874 @item -fwrapv
12875 @opindex fwrapv
12876 This option instructs the compiler to assume that signed arithmetic
12877 overflow of addition, subtraction and multiplication wraps around
12878 using twos-complement representation.  This flag enables some optimizations
12879 and disables others.  This option is enabled by default for the Java
12880 front-end, as required by the Java language specification.
12882 @item -fexceptions
12883 @opindex fexceptions
12884 Enable exception handling.  Generates extra code needed to propagate
12885 exceptions.  For some targets, this implies GCC will generate frame
12886 unwind information for all functions, which can produce significant data
12887 size overhead, although it does not affect execution.  If you do not
12888 specify this option, GCC will enable it by default for languages like
12889 C++ which normally require exception handling, and disable it for
12890 languages like C that do not normally require it.  However, you may need
12891 to enable this option when compiling C code that needs to interoperate
12892 properly with exception handlers written in C++.  You may also wish to
12893 disable this option if you are compiling older C++ programs that don't
12894 use exception handling.
12896 @item -fnon-call-exceptions
12897 @opindex fnon-call-exceptions
12898 Generate code that allows trapping instructions to throw exceptions.
12899 Note that this requires platform-specific runtime support that does
12900 not exist everywhere.  Moreover, it only allows @emph{trapping}
12901 instructions to throw exceptions, i.e.@: memory references or floating
12902 point instructions.  It does not allow exceptions to be thrown from
12903 arbitrary signal handlers such as @code{SIGALRM}.
12905 @item -funwind-tables
12906 @opindex funwind-tables
12907 Similar to @option{-fexceptions}, except that it will just generate any needed
12908 static data, but will not affect the generated code in any other way.
12909 You will normally not enable this option; instead, a language processor
12910 that needs this handling would enable it on your behalf.
12912 @item -fasynchronous-unwind-tables
12913 @opindex fasynchronous-unwind-tables
12914 Generate unwind table in dwarf2 format, if supported by target machine.  The
12915 table is exact at each instruction boundary, so it can be used for stack
12916 unwinding from asynchronous events (such as debugger or garbage collector).
12918 @item -fpcc-struct-return
12919 @opindex fpcc-struct-return
12920 Return ``short'' @code{struct} and @code{union} values in memory like
12921 longer ones, rather than in registers.  This convention is less
12922 efficient, but it has the advantage of allowing intercallability between
12923 GCC-compiled files and files compiled with other compilers, particularly
12924 the Portable C Compiler (pcc).
12926 The precise convention for returning structures in memory depends
12927 on the target configuration macros.
12929 Short structures and unions are those whose size and alignment match
12930 that of some integer type.
12932 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12933 switch is not binary compatible with code compiled with the
12934 @option{-freg-struct-return} switch.
12935 Use it to conform to a non-default application binary interface.
12937 @item -freg-struct-return
12938 @opindex freg-struct-return
12939 Return @code{struct} and @code{union} values in registers when possible.
12940 This is more efficient for small structures than
12941 @option{-fpcc-struct-return}.
12943 If you specify neither @option{-fpcc-struct-return} nor
12944 @option{-freg-struct-return}, GCC defaults to whichever convention is
12945 standard for the target.  If there is no standard convention, GCC
12946 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12947 the principal compiler.  In those cases, we can choose the standard, and
12948 we chose the more efficient register return alternative.
12950 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12951 switch is not binary compatible with code compiled with the
12952 @option{-fpcc-struct-return} switch.
12953 Use it to conform to a non-default application binary interface.
12955 @item -fshort-enums
12956 @opindex fshort-enums
12957 Allocate to an @code{enum} type only as many bytes as it needs for the
12958 declared range of possible values.  Specifically, the @code{enum} type
12959 will be equivalent to the smallest integer type which has enough room.
12961 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12962 code that is not binary compatible with code generated without that switch.
12963 Use it to conform to a non-default application binary interface.
12965 @item -fshort-double
12966 @opindex fshort-double
12967 Use the same size for @code{double} as for @code{float}.
12969 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12970 code that is not binary compatible with code generated without that switch.
12971 Use it to conform to a non-default application binary interface.
12973 @item -fshort-wchar
12974 @opindex fshort-wchar
12975 Override the underlying type for @samp{wchar_t} to be @samp{short
12976 unsigned int} instead of the default for the target.  This option is
12977 useful for building programs to run under WINE@.
12979 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12980 code that is not binary compatible with code generated without that switch.
12981 Use it to conform to a non-default application binary interface.
12983 @item -fno-common
12984 @opindex fno-common
12985 In C, allocate even uninitialized global variables in the data section of the
12986 object file, rather than generating them as common blocks.  This has the
12987 effect that if the same variable is declared (without @code{extern}) in
12988 two different compilations, you will get an error when you link them.
12989 The only reason this might be useful is if you wish to verify that the
12990 program will work on other systems which always work this way.
12992 @item -fno-ident
12993 @opindex fno-ident
12994 Ignore the @samp{#ident} directive.
12996 @item -finhibit-size-directive
12997 @opindex finhibit-size-directive
12998 Don't output a @code{.size} assembler directive, or anything else that
12999 would cause trouble if the function is split in the middle, and the
13000 two halves are placed at locations far apart in memory.  This option is
13001 used when compiling @file{crtstuff.c}; you should not need to use it
13002 for anything else.
13004 @item -fverbose-asm
13005 @opindex fverbose-asm
13006 Put extra commentary information in the generated assembly code to
13007 make it more readable.  This option is generally only of use to those
13008 who actually need to read the generated assembly code (perhaps while
13009 debugging the compiler itself).
13011 @option{-fno-verbose-asm}, the default, causes the
13012 extra information to be omitted and is useful when comparing two assembler
13013 files.
13015 @item -fpic
13016 @opindex fpic
13017 @cindex global offset table
13018 @cindex PIC
13019 Generate position-independent code (PIC) suitable for use in a shared
13020 library, if supported for the target machine.  Such code accesses all
13021 constant addresses through a global offset table (GOT)@.  The dynamic
13022 loader resolves the GOT entries when the program starts (the dynamic
13023 loader is not part of GCC; it is part of the operating system).  If
13024 the GOT size for the linked executable exceeds a machine-specific
13025 maximum size, you get an error message from the linker indicating that
13026 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13027 instead.  (These maximums are 8k on the SPARC and 32k
13028 on the m68k and RS/6000.  The 386 has no such limit.)
13030 Position-independent code requires special support, and therefore works
13031 only on certain machines.  For the 386, GCC supports PIC for System V
13032 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
13033 position-independent.
13035 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13036 are defined to 1.
13038 @item -fPIC
13039 @opindex fPIC
13040 If supported for the target machine, emit position-independent code,
13041 suitable for dynamic linking and avoiding any limit on the size of the
13042 global offset table.  This option makes a difference on the m68k,
13043 PowerPC and SPARC@.
13045 Position-independent code requires special support, and therefore works
13046 only on certain machines.
13048 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13049 are defined to 2.
13051 @item -fpie
13052 @itemx -fPIE
13053 @opindex fpie
13054 @opindex fPIE
13055 These options are similar to @option{-fpic} and @option{-fPIC}, but
13056 generated position independent code can be only linked into executables.
13057 Usually these options are used when @option{-pie} GCC option will be
13058 used during linking.
13060 @item -fno-jump-tables
13061 @opindex fno-jump-tables
13062 Do not use jump tables for switch statements even where it would be
13063 more efficient than other code generation strategies.  This option is
13064 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13065 building code which forms part of a dynamic linker and cannot
13066 reference the address of a jump table.  On some targets, jump tables
13067 do not require a GOT and this option is not needed.
13069 @item -ffixed-@var{reg}
13070 @opindex ffixed
13071 Treat the register named @var{reg} as a fixed register; generated code
13072 should never refer to it (except perhaps as a stack pointer, frame
13073 pointer or in some other fixed role).
13075 @var{reg} must be the name of a register.  The register names accepted
13076 are machine-specific and are defined in the @code{REGISTER_NAMES}
13077 macro in the machine description macro file.
13079 This flag does not have a negative form, because it specifies a
13080 three-way choice.
13082 @item -fcall-used-@var{reg}
13083 @opindex fcall-used
13084 Treat the register named @var{reg} as an allocable register that is
13085 clobbered by function calls.  It may be allocated for temporaries or
13086 variables that do not live across a call.  Functions compiled this way
13087 will not save and restore the register @var{reg}.
13089 It is an error to used this flag with the frame pointer or stack pointer.
13090 Use of this flag for other registers that have fixed pervasive roles in
13091 the machine's execution model will produce disastrous results.
13093 This flag does not have a negative form, because it specifies a
13094 three-way choice.
13096 @item -fcall-saved-@var{reg}
13097 @opindex fcall-saved
13098 Treat the register named @var{reg} as an allocable register saved by
13099 functions.  It may be allocated even for temporaries or variables that
13100 live across a call.  Functions compiled this way will save and restore
13101 the register @var{reg} if they use it.
13103 It is an error to used this flag with the frame pointer or stack pointer.
13104 Use of this flag for other registers that have fixed pervasive roles in
13105 the machine's execution model will produce disastrous results.
13107 A different sort of disaster will result from the use of this flag for
13108 a register in which function values may be returned.
13110 This flag does not have a negative form, because it specifies a
13111 three-way choice.
13113 @item -fpack-struct[=@var{n}]
13114 @opindex fpack-struct
13115 Without a value specified, pack all structure members together without
13116 holes.  When a value is specified (which must be a small power of two), pack
13117 structure members according to this value, representing the maximum
13118 alignment (that is, objects with default alignment requirements larger than
13119 this will be output potentially unaligned at the next fitting location.
13121 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13122 code that is not binary compatible with code generated without that switch.
13123 Additionally, it makes the code suboptimal.
13124 Use it to conform to a non-default application binary interface.
13126 @item -finstrument-functions
13127 @opindex finstrument-functions
13128 Generate instrumentation calls for entry and exit to functions.  Just
13129 after function entry and just before function exit, the following
13130 profiling functions will be called with the address of the current
13131 function and its call site.  (On some platforms,
13132 @code{__builtin_return_address} does not work beyond the current
13133 function, so the call site information may not be available to the
13134 profiling functions otherwise.)
13136 @smallexample
13137 void __cyg_profile_func_enter (void *this_fn,
13138                                void *call_site);
13139 void __cyg_profile_func_exit  (void *this_fn,
13140                                void *call_site);
13141 @end smallexample
13143 The first argument is the address of the start of the current function,
13144 which may be looked up exactly in the symbol table.
13146 This instrumentation is also done for functions expanded inline in other
13147 functions.  The profiling calls will indicate where, conceptually, the
13148 inline function is entered and exited.  This means that addressable
13149 versions of such functions must be available.  If all your uses of a
13150 function are expanded inline, this may mean an additional expansion of
13151 code size.  If you use @samp{extern inline} in your C code, an
13152 addressable version of such functions must be provided.  (This is
13153 normally the case anyways, but if you get lucky and the optimizer always
13154 expands the functions inline, you might have gotten away without
13155 providing static copies.)
13157 A function may be given the attribute @code{no_instrument_function}, in
13158 which case this instrumentation will not be done.  This can be used, for
13159 example, for the profiling functions listed above, high-priority
13160 interrupt routines, and any functions from which the profiling functions
13161 cannot safely be called (perhaps signal handlers, if the profiling
13162 routines generate output or allocate memory).
13164 @item -fstack-check
13165 @opindex fstack-check
13166 Generate code to verify that you do not go beyond the boundary of the
13167 stack.  You should specify this flag if you are running in an
13168 environment with multiple threads, but only rarely need to specify it in
13169 a single-threaded environment since stack overflow is automatically
13170 detected on nearly all systems if there is only one stack.
13172 Note that this switch does not actually cause checking to be done; the
13173 operating system must do that.  The switch causes generation of code
13174 to ensure that the operating system sees the stack being extended.
13176 @item -fstack-limit-register=@var{reg}
13177 @itemx -fstack-limit-symbol=@var{sym}
13178 @itemx -fno-stack-limit
13179 @opindex fstack-limit-register
13180 @opindex fstack-limit-symbol
13181 @opindex fno-stack-limit
13182 Generate code to ensure that the stack does not grow beyond a certain value,
13183 either the value of a register or the address of a symbol.  If the stack
13184 would grow beyond the value, a signal is raised.  For most targets,
13185 the signal is raised before the stack overruns the boundary, so
13186 it is possible to catch the signal without taking special precautions.
13188 For instance, if the stack starts at absolute address @samp{0x80000000}
13189 and grows downwards, you can use the flags
13190 @option{-fstack-limit-symbol=__stack_limit} and
13191 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13192 of 128KB@.  Note that this may only work with the GNU linker.
13194 @cindex aliasing of parameters
13195 @cindex parameters, aliased
13196 @item -fargument-alias
13197 @itemx -fargument-noalias
13198 @itemx -fargument-noalias-global
13199 @opindex fargument-alias
13200 @opindex fargument-noalias
13201 @opindex fargument-noalias-global
13202 Specify the possible relationships among parameters and between
13203 parameters and global data.
13205 @option{-fargument-alias} specifies that arguments (parameters) may
13206 alias each other and may alias global storage.@*
13207 @option{-fargument-noalias} specifies that arguments do not alias
13208 each other, but may alias global storage.@*
13209 @option{-fargument-noalias-global} specifies that arguments do not
13210 alias each other and do not alias global storage.
13212 Each language will automatically use whatever option is required by
13213 the language standard.  You should not need to use these options yourself.
13215 @item -fleading-underscore
13216 @opindex fleading-underscore
13217 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13218 change the way C symbols are represented in the object file.  One use
13219 is to help link with legacy assembly code.
13221 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13222 generate code that is not binary compatible with code generated without that
13223 switch.  Use it to conform to a non-default application binary interface.
13224 Not all targets provide complete support for this switch.
13226 @item -ftls-model=@var{model}
13227 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13228 The @var{model} argument should be one of @code{global-dynamic},
13229 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13231 The default without @option{-fpic} is @code{initial-exec}; with
13232 @option{-fpic} the default is @code{global-dynamic}.
13234 @item -fvisibility=@var{default|internal|hidden|protected}
13235 @opindex fvisibility
13236 Set the default ELF image symbol visibility to the specified option---all
13237 symbols will be marked with this unless overridden within the code.
13238 Using this feature can very substantially improve linking and
13239 load times of shared object libraries, produce more optimized
13240 code, provide near-perfect API export and prevent symbol clashes.
13241 It is @strong{strongly} recommended that you use this in any shared objects
13242 you distribute.
13244 Despite the nomenclature, @code{default} always means public ie;
13245 available to be linked against from outside the shared object.
13246 @code{protected} and @code{internal} are pretty useless in real-world
13247 usage so the only other commonly used option will be @code{hidden}.
13248 The default if @option{-fvisibility} isn't specified is
13249 @code{default}, i.e., make every
13250 symbol public---this causes the same behavior as previous versions of
13251 GCC@.
13253 A good explanation of the benefits offered by ensuring ELF
13254 symbols have the correct visibility is given by ``How To Write
13255 Shared Libraries'' by Ulrich Drepper (which can be found at
13256 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13257 solution made possible by this option to marking things hidden when
13258 the default is public is to make the default hidden and mark things
13259 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13260 and @code{__attribute__ ((visibility("default")))} instead of
13261 @code{__declspec(dllexport)} you get almost identical semantics with
13262 identical syntax.  This is a great boon to those working with
13263 cross-platform projects.
13265 For those adding visibility support to existing code, you may find
13266 @samp{#pragma GCC visibility} of use.  This works by you enclosing
13267 the declarations you wish to set visibility for with (for example)
13268 @samp{#pragma GCC visibility push(hidden)} and
13269 @samp{#pragma GCC visibility pop}.
13270 Bear in mind that symbol visibility should be viewed @strong{as
13271 part of the API interface contract} and thus all new code should
13272 always specify visibility when it is not the default ie; declarations
13273 only for use within the local DSO should @strong{always} be marked explicitly
13274 as hidden as so to avoid PLT indirection overheads---making this
13275 abundantly clear also aids readability and self-documentation of the code.
13276 Note that due to ISO C++ specification requirements, operator new and
13277 operator delete must always be of default visibility.
13279 An overview of these techniques, their benefits and how to use them
13280 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13282 @item -fopenmp
13283 @opindex fopenmp
13284 @cindex openmp parallel
13285 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
13286 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
13287 compiler generates parallel code according to the OpenMP Application
13288 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
13290 @end table
13292 @c man end
13294 @node Environment Variables
13295 @section Environment Variables Affecting GCC
13296 @cindex environment variables
13298 @c man begin ENVIRONMENT
13299 This section describes several environment variables that affect how GCC
13300 operates.  Some of them work by specifying directories or prefixes to use
13301 when searching for various kinds of files.  Some are used to specify other
13302 aspects of the compilation environment.
13304 Note that you can also specify places to search using options such as
13305 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
13306 take precedence over places specified using environment variables, which
13307 in turn take precedence over those specified by the configuration of GCC@.
13308 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13309 GNU Compiler Collection (GCC) Internals}.
13311 @table @env
13312 @item LANG
13313 @itemx LC_CTYPE
13314 @c @itemx LC_COLLATE
13315 @itemx LC_MESSAGES
13316 @c @itemx LC_MONETARY
13317 @c @itemx LC_NUMERIC
13318 @c @itemx LC_TIME
13319 @itemx LC_ALL
13320 @findex LANG
13321 @findex LC_CTYPE
13322 @c @findex LC_COLLATE
13323 @findex LC_MESSAGES
13324 @c @findex LC_MONETARY
13325 @c @findex LC_NUMERIC
13326 @c @findex LC_TIME
13327 @findex LC_ALL
13328 @cindex locale
13329 These environment variables control the way that GCC uses
13330 localization information that allow GCC to work with different
13331 national conventions.  GCC inspects the locale categories
13332 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13333 so.  These locale categories can be set to any value supported by your
13334 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
13335 Kingdom encoded in UTF-8.
13337 The @env{LC_CTYPE} environment variable specifies character
13338 classification.  GCC uses it to determine the character boundaries in
13339 a string; this is needed for some multibyte encodings that contain quote
13340 and escape characters that would otherwise be interpreted as a string
13341 end or escape.
13343 The @env{LC_MESSAGES} environment variable specifies the language to
13344 use in diagnostic messages.
13346 If the @env{LC_ALL} environment variable is set, it overrides the value
13347 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13348 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13349 environment variable.  If none of these variables are set, GCC
13350 defaults to traditional C English behavior.
13352 @item TMPDIR
13353 @findex TMPDIR
13354 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13355 files.  GCC uses temporary files to hold the output of one stage of
13356 compilation which is to be used as input to the next stage: for example,
13357 the output of the preprocessor, which is the input to the compiler
13358 proper.
13360 @item GCC_EXEC_PREFIX
13361 @findex GCC_EXEC_PREFIX
13362 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13363 names of the subprograms executed by the compiler.  No slash is added
13364 when this prefix is combined with the name of a subprogram, but you can
13365 specify a prefix that ends with a slash if you wish.
13367 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13368 an appropriate prefix to use based on the pathname it was invoked with.
13370 If GCC cannot find the subprogram using the specified prefix, it
13371 tries looking in the usual places for the subprogram.
13373 The default value of @env{GCC_EXEC_PREFIX} is
13374 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13375 of @code{prefix} when you ran the @file{configure} script.
13377 Other prefixes specified with @option{-B} take precedence over this prefix.
13379 This prefix is also used for finding files such as @file{crt0.o} that are
13380 used for linking.
13382 In addition, the prefix is used in an unusual way in finding the
13383 directories to search for header files.  For each of the standard
13384 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13385 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13386 replacing that beginning with the specified prefix to produce an
13387 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
13388 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13389 These alternate directories are searched first; the standard directories
13390 come next.
13392 @item COMPILER_PATH
13393 @findex COMPILER_PATH
13394 The value of @env{COMPILER_PATH} is a colon-separated list of
13395 directories, much like @env{PATH}.  GCC tries the directories thus
13396 specified when searching for subprograms, if it can't find the
13397 subprograms using @env{GCC_EXEC_PREFIX}.
13399 @item LIBRARY_PATH
13400 @findex LIBRARY_PATH
13401 The value of @env{LIBRARY_PATH} is a colon-separated list of
13402 directories, much like @env{PATH}.  When configured as a native compiler,
13403 GCC tries the directories thus specified when searching for special
13404 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
13405 using GCC also uses these directories when searching for ordinary
13406 libraries for the @option{-l} option (but directories specified with
13407 @option{-L} come first).
13409 @item LANG
13410 @findex LANG
13411 @cindex locale definition
13412 This variable is used to pass locale information to the compiler.  One way in
13413 which this information is used is to determine the character set to be used
13414 when character literals, string literals and comments are parsed in C and C++.
13415 When the compiler is configured to allow multibyte characters,
13416 the following values for @env{LANG} are recognized:
13418 @table @samp
13419 @item C-JIS
13420 Recognize JIS characters.
13421 @item C-SJIS
13422 Recognize SJIS characters.
13423 @item C-EUCJP
13424 Recognize EUCJP characters.
13425 @end table
13427 If @env{LANG} is not defined, or if it has some other value, then the
13428 compiler will use mblen and mbtowc as defined by the default locale to
13429 recognize and translate multibyte characters.
13430 @end table
13432 @noindent
13433 Some additional environments variables affect the behavior of the
13434 preprocessor.
13436 @include cppenv.texi
13438 @c man end
13440 @node Precompiled Headers
13441 @section Using Precompiled Headers
13442 @cindex precompiled headers
13443 @cindex speed of compilation
13445 Often large projects have many header files that are included in every
13446 source file.  The time the compiler takes to process these header files
13447 over and over again can account for nearly all of the time required to
13448 build the project.  To make builds faster, GCC allows users to
13449 `precompile' a header file; then, if builds can use the precompiled
13450 header file they will be much faster.
13452 To create a precompiled header file, simply compile it as you would any
13453 other file, if necessary using the @option{-x} option to make the driver
13454 treat it as a C or C++ header file.  You will probably want to use a
13455 tool like @command{make} to keep the precompiled header up-to-date when
13456 the headers it contains change.
13458 A precompiled header file will be searched for when @code{#include} is
13459 seen in the compilation.  As it searches for the included file
13460 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13461 compiler looks for a precompiled header in each directory just before it
13462 looks for the include file in that directory.  The name searched for is
13463 the name specified in the @code{#include} with @samp{.gch} appended.  If
13464 the precompiled header file can't be used, it is ignored.
13466 For instance, if you have @code{#include "all.h"}, and you have
13467 @file{all.h.gch} in the same directory as @file{all.h}, then the
13468 precompiled header file will be used if possible, and the original
13469 header will be used otherwise.
13471 Alternatively, you might decide to put the precompiled header file in a
13472 directory and use @option{-I} to ensure that directory is searched
13473 before (or instead of) the directory containing the original header.
13474 Then, if you want to check that the precompiled header file is always
13475 used, you can put a file of the same name as the original header in this
13476 directory containing an @code{#error} command.
13478 This also works with @option{-include}.  So yet another way to use
13479 precompiled headers, good for projects not designed with precompiled
13480 header files in mind, is to simply take most of the header files used by
13481 a project, include them from another header file, precompile that header
13482 file, and @option{-include} the precompiled header.  If the header files
13483 have guards against multiple inclusion, they will be skipped because
13484 they've already been included (in the precompiled header).
13486 If you need to precompile the same header file for different
13487 languages, targets, or compiler options, you can instead make a
13488 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13489 header in the directory, perhaps using @option{-o}.  It doesn't matter
13490 what you call the files in the directory, every precompiled header in
13491 the directory will be considered.  The first precompiled header
13492 encountered in the directory that is valid for this compilation will
13493 be used; they're searched in no particular order.
13495 There are many other possibilities, limited only by your imagination,
13496 good sense, and the constraints of your build system.
13498 A precompiled header file can be used only when these conditions apply:
13500 @itemize
13501 @item
13502 Only one precompiled header can be used in a particular compilation.
13504 @item
13505 A precompiled header can't be used once the first C token is seen.  You
13506 can have preprocessor directives before a precompiled header; you can
13507 even include a precompiled header from inside another header, so long as
13508 there are no C tokens before the @code{#include}.
13510 @item
13511 The precompiled header file must be produced for the same language as
13512 the current compilation.  You can't use a C precompiled header for a C++
13513 compilation.
13515 @item
13516 The precompiled header file must have been produced by the same compiler
13517 binary as the current compilation is using.
13519 @item
13520 Any macros defined before the precompiled header is included must
13521 either be defined in the same way as when the precompiled header was
13522 generated, or must not affect the precompiled header, which usually
13523 means that they don't appear in the precompiled header at all.
13525 The @option{-D} option is one way to define a macro before a
13526 precompiled header is included; using a @code{#define} can also do it.
13527 There are also some options that define macros implicitly, like
13528 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13529 defined this way.
13531 @item If debugging information is output when using the precompiled
13532 header, using @option{-g} or similar, the same kind of debugging information
13533 must have been output when building the precompiled header.  However,
13534 a precompiled header built using @option{-g} can be used in a compilation
13535 when no debugging information is being output.
13537 @item The same @option{-m} options must generally be used when building
13538 and using the precompiled header.  @xref{Submodel Options},
13539 for any cases where this rule is relaxed.
13541 @item Each of the following options must be the same when building and using
13542 the precompiled header:
13544 @gccoptlist{-fexceptions -funit-at-a-time}
13546 @item
13547 Some other command-line options starting with @option{-f},
13548 @option{-p}, or @option{-O} must be defined in the same way as when
13549 the precompiled header was generated.  At present, it's not clear
13550 which options are safe to change and which are not; the safest choice
13551 is to use exactly the same options when generating and using the
13552 precompiled header.  The following are known to be safe:
13554 @gccoptlist{-fmessage-length= -fpreprocessed
13555 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13556 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13557 -pedantic-errors}
13559 @end itemize
13561 For all of these except the last, the compiler will automatically
13562 ignore the precompiled header if the conditions aren't met.  If you
13563 find an option combination that doesn't work and doesn't cause the
13564 precompiled header to be ignored, please consider filing a bug report,
13565 see @ref{Bugs}.
13567 If you do use differing options when generating and using the
13568 precompiled header, the actual behavior will be a mixture of the
13569 behavior for the options.  For instance, if you use @option{-g} to
13570 generate the precompiled header but not when using it, you may or may
13571 not get debugging information for routines in the precompiled header.
13573 @node Running Protoize
13574 @section Running Protoize
13576 The program @code{protoize} is an optional part of GCC@.  You can use
13577 it to add prototypes to a program, thus converting the program to ISO
13578 C in one respect.  The companion program @code{unprotoize} does the
13579 reverse: it removes argument types from any prototypes that are found.
13581 When you run these programs, you must specify a set of source files as
13582 command line arguments.  The conversion programs start out by compiling
13583 these files to see what functions they define.  The information gathered
13584 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13586 After scanning comes actual conversion.  The specified files are all
13587 eligible to be converted; any files they include (whether sources or
13588 just headers) are eligible as well.
13590 But not all the eligible files are converted.  By default,
13591 @code{protoize} and @code{unprotoize} convert only source and header
13592 files in the current directory.  You can specify additional directories
13593 whose files should be converted with the @option{-d @var{directory}}
13594 option.  You can also specify particular files to exclude with the
13595 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13596 directory name matches one of the specified directory names, and its
13597 name within the directory has not been excluded.
13599 Basic conversion with @code{protoize} consists of rewriting most
13600 function definitions and function declarations to specify the types of
13601 the arguments.  The only ones not rewritten are those for varargs
13602 functions.
13604 @code{protoize} optionally inserts prototype declarations at the
13605 beginning of the source file, to make them available for any calls that
13606 precede the function's definition.  Or it can insert prototype
13607 declarations with block scope in the blocks where undeclared functions
13608 are called.
13610 Basic conversion with @code{unprotoize} consists of rewriting most
13611 function declarations to remove any argument types, and rewriting
13612 function definitions to the old-style pre-ISO form.
13614 Both conversion programs print a warning for any function declaration or
13615 definition that they can't convert.  You can suppress these warnings
13616 with @option{-q}.
13618 The output from @code{protoize} or @code{unprotoize} replaces the
13619 original source file.  The original file is renamed to a name ending
13620 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13621 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13622 for DOS) file already exists, then the source file is simply discarded.
13624 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13625 scan the program and collect information about the functions it uses.
13626 So neither of these programs will work until GCC is installed.
13628 Here is a table of the options you can use with @code{protoize} and
13629 @code{unprotoize}.  Each option works with both programs unless
13630 otherwise stated.
13632 @table @code
13633 @item -B @var{directory}
13634 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13635 usual directory (normally @file{/usr/local/lib}).  This file contains
13636 prototype information about standard system functions.  This option
13637 applies only to @code{protoize}.
13639 @item -c @var{compilation-options}
13640 Use @var{compilation-options} as the options when running @command{gcc} to
13641 produce the @samp{.X} files.  The special option @option{-aux-info} is
13642 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13644 Note that the compilation options must be given as a single argument to
13645 @code{protoize} or @code{unprotoize}.  If you want to specify several
13646 @command{gcc} options, you must quote the entire set of compilation options
13647 to make them a single word in the shell.
13649 There are certain @command{gcc} arguments that you cannot use, because they
13650 would produce the wrong kind of output.  These include @option{-g},
13651 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13652 the @var{compilation-options}, they are ignored.
13654 @item -C
13655 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13656 systems) instead of @samp{.c}.  This is convenient if you are converting
13657 a C program to C++.  This option applies only to @code{protoize}.
13659 @item -g
13660 Add explicit global declarations.  This means inserting explicit
13661 declarations at the beginning of each source file for each function
13662 that is called in the file and was not declared.  These declarations
13663 precede the first function definition that contains a call to an
13664 undeclared function.  This option applies only to @code{protoize}.
13666 @item -i @var{string}
13667 Indent old-style parameter declarations with the string @var{string}.
13668 This option applies only to @code{protoize}.
13670 @code{unprotoize} converts prototyped function definitions to old-style
13671 function definitions, where the arguments are declared between the
13672 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13673 uses five spaces as the indentation.  If you want to indent with just
13674 one space instead, use @option{-i " "}.
13676 @item -k
13677 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13678 is finished.
13680 @item -l
13681 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13682 a prototype declaration for each function in each block which calls the
13683 function without any declaration.  This option applies only to
13684 @code{protoize}.
13686 @item -n
13687 Make no real changes.  This mode just prints information about the conversions
13688 that would have been done without @option{-n}.
13690 @item -N
13691 Make no @samp{.save} files.  The original files are simply deleted.
13692 Use this option with caution.
13694 @item -p @var{program}
13695 Use the program @var{program} as the compiler.  Normally, the name
13696 @file{gcc} is used.
13698 @item -q
13699 Work quietly.  Most warnings are suppressed.
13701 @item -v
13702 Print the version number, just like @option{-v} for @command{gcc}.
13703 @end table
13705 If you need special compiler options to compile one of your program's
13706 source files, then you should generate that file's @samp{.X} file
13707 specially, by running @command{gcc} on that source file with the
13708 appropriate options and the option @option{-aux-info}.  Then run
13709 @code{protoize} on the entire set of files.  @code{protoize} will use
13710 the existing @samp{.X} file because it is newer than the source file.
13711 For example:
13713 @smallexample
13714 gcc -Dfoo=bar file1.c -aux-info file1.X
13715 protoize *.c
13716 @end smallexample
13718 @noindent
13719 You need to include the special files along with the rest in the
13720 @code{protoize} command, even though their @samp{.X} files already
13721 exist, because otherwise they won't get converted.
13723 @xref{Protoize Caveats}, for more information on how to use
13724 @code{protoize} successfully.