* config.gcc: Add armv6{k,z,zk}
[official-gcc.git] / gcc / doc / invoke.texi
blob3a62a128a311cdd847ea382ebbb58b7541ac42fd
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
112 @c man end
114 @xref{Option Index}, for an index to GCC's options.
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
125                         and Objective-C++.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
148 @c man begin OPTIONS
150 @node Option Summary
151 @section Option Summary
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-exceptions @gol
202 -freplace-objc-classes @gol
203 -fzero-link @gol
204 -gen-decls @gol
205 -Wno-protocol  -Wselector -Wundeclared-selector}
207 @item Language Independent Options
208 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
209 @gccoptlist{-fmessage-length=@var{n}  @gol
210 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
232 -Wreturn-type  -Wsequence-point  -Wshadow @gol
233 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
234 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
235 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
236 -Wunknown-pragmas  -Wunreachable-code @gol
237 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
238 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
239 -Wvariadic-macros}
241 @item C-only Warning Options
242 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
243 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
244 -Wstrict-prototypes  -Wtraditional @gol
245 -Wdeclaration-after-statement}
247 @item Debugging Options
248 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
249 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
250 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
251 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
252 -fdump-ipa-all -fdump-ipa-cgraph @gol
253 -fdump-tree-all @gol
254 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
255 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
258 -fdump-tree-ch @gol
259 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-nrv -fdump-tree-vect @gol
268 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
270 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
271 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
272 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
273 -ftest-coverage  -ftime-report -fvar-tracking @gol
274 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
275 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
276 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
277 -print-multi-directory  -print-multi-lib @gol
278 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
279 -save-temps  -time}
281 @item Optimization Options
282 @xref{Optimize Options,,Options that Control Optimization}.
283 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
284 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
285 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
286 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
287 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
288 -fcaller-saves  -fcprop-registers @gol
289 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
290 -fdelayed-branch  -fdelete-null-pointer-checks @gol
291 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
292 -fforce-addr  -fforce-mem  -ffunction-sections @gol
293 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
294 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
295 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
296 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
297 -fmodulo-sched -fnew-ra  -fno-branch-count-reg @gol
298 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
299 -fno-function-cse  -fno-guess-branch-probability @gol
300 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
301 -funsafe-math-optimizations  -ffinite-math-only @gol
302 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
303 -fomit-frame-pointer  -foptimize-register-move @gol
304 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
305 -fprofile-generate -fprofile-use @gol
306 -fregmove  -frename-registers @gol
307 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
308 -frerun-cse-after-loop  -frerun-loop-opt @gol
309 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
310 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
311 -fsched-spec-load-dangerous  @gol
312 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
313 -fsched2-use-superblocks @gol
314 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
315 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
316 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
317 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
318 -fsplit-ivs-in-unroller -funswitch-loops @gol
319 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
320 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
321 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
322 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
323 --param @var{name}=@var{value}
324 -O  -O0  -O1  -O2  -O3  -Os}
326 @item Preprocessor Options
327 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
328 @gccoptlist{-A@var{question}=@var{answer} @gol
329 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
330 -C  -dD  -dI  -dM  -dN @gol
331 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
332 -idirafter @var{dir} @gol
333 -include @var{file}  -imacros @var{file} @gol
334 -iprefix @var{file}  -iwithprefix @var{dir} @gol
335 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
336 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
337 -P  -fworking-directory  -remap @gol
338 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
339 -Xpreprocessor @var{option}}
341 @item Assembler Option
342 @xref{Assembler Options,,Passing Options to the Assembler}.
343 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
345 @item Linker Options
346 @xref{Link Options,,Options for Linking}.
347 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
348 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
349 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
350 -Wl,@var{option}  -Xlinker @var{option} @gol
351 -u @var{symbol}}
353 @item Directory Options
354 @xref{Directory Options,,Options for Directory Search}.
355 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
357 @item Target Options
358 @c I wrote this xref this way to avoid overfull hbox. -- rms
359 @xref{Target Options}.
360 @gccoptlist{-V @var{version}  -b @var{machine}}
362 @item Machine Dependent Options
363 @xref{Submodel Options,,Hardware Models and Configurations}.
364 @c This list is ordered alphanumerically by subsection name.
365 @c Try and put the significant identifier (CPU or system) first,
366 @c so users have a clue at guessing where the ones they want will be.
368 @emph{ARC Options}
369 @gccoptlist{-EB  -EL @gol
370 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
371 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
373 @emph{ARM Options}
374 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
375 -mabi=@var{name} @gol
376 -mapcs-stack-check  -mno-apcs-stack-check @gol
377 -mapcs-float  -mno-apcs-float @gol
378 -mapcs-reentrant  -mno-apcs-reentrant @gol
379 -msched-prolog  -mno-sched-prolog @gol
380 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
381 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
382 -mthumb-interwork  -mno-thumb-interwork @gol
383 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
384 -mstructure-size-boundary=@var{n} @gol
385 -mabort-on-noreturn @gol
386 -mlong-calls  -mno-long-calls @gol
387 -msingle-pic-base  -mno-single-pic-base @gol
388 -mpic-register=@var{reg} @gol
389 -mnop-fun-dllimport @gol
390 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
391 -mpoke-function-name @gol
392 -mthumb  -marm @gol
393 -mtpcs-frame  -mtpcs-leaf-frame @gol
394 -mcaller-super-interworking  -mcallee-super-interworking}
396 @emph{AVR Options}
397 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
398 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
400 @emph{CRIS Options}
401 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
402 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
403 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
404 -mstack-align  -mdata-align  -mconst-align @gol
405 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
406 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
407 -mmul-bug-workaround  -mno-mul-bug-workaround}
409 @emph{Darwin Options}
410 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
411 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
412 -client_name  -compatibility_version  -current_version @gol
413 -dead_strip @gol
414 -dependency-file  -dylib_file  -dylinker_install_name @gol
415 -dynamic  -dynamiclib  -exported_symbols_list @gol
416 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
417 -force_flat_namespace  -headerpad_max_install_names @gol
418 -image_base  -init  -install_name  -keep_private_externs @gol
419 -multi_module  -multiply_defined  -multiply_defined_unused @gol
420 -noall_load   -no_dead_strip_inits_and_terms @gol
421 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
422 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
423 -private_bundle  -read_only_relocs  -sectalign @gol
424 -sectobjectsymbols  -whyload  -seg1addr @gol
425 -sectcreate  -sectobjectsymbols  -sectorder @gol
426 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
427 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
428 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
429 -single_module  -static  -sub_library  -sub_umbrella @gol
430 -twolevel_namespace  -umbrella  -undefined @gol
431 -unexported_symbols_list  -weak_reference_mismatches @gol
432 -whatsloaded -F -gused -gfull -mone-byte-bool}
434 @emph{DEC Alpha Options}
435 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
436 -mieee  -mieee-with-inexact  -mieee-conformant @gol
437 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
438 -mtrap-precision=@var{mode}  -mbuild-constants @gol
439 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
440 -mbwx  -mmax  -mfix  -mcix @gol
441 -mfloat-vax  -mfloat-ieee @gol
442 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
443 -msmall-text  -mlarge-text @gol
444 -mmemory-latency=@var{time}}
446 @emph{DEC Alpha/VMS Options}
447 @gccoptlist{-mvms-return-codes}
449 @emph{FRV Options}
450 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
451 -mhard-float  -msoft-float @gol
452 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
453 -mdouble  -mno-double @gol
454 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
455 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
456 -mlinked-fp  -mlong-calls  -malign-labels @gol
457 -mlibrary-pic  -macc-4  -macc-8 @gol
458 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
459 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
460 -mvliw-branch  -mno-vliw-branch @gol
461 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
462 -mno-nested-cond-exec  -mtomcat-stats @gol
463 -mcpu=@var{cpu}}
465 @emph{H8/300 Options}
466 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
468 @emph{HPPA Options}
469 @gccoptlist{-march=@var{architecture-type} @gol
470 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
471 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
472 -mfixed-range=@var{register-range} @gol
473 -mjump-in-delay -mlinker-opt -mlong-calls @gol
474 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
475 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
476 -mno-jump-in-delay  -mno-long-load-store @gol
477 -mno-portable-runtime  -mno-soft-float @gol
478 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
479 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
480 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
481 -munix=@var{unix-std}  -nolibdld  -static  -threads}
483 @emph{i386 and x86-64 Options}
484 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
485 -mfpmath=@var{unit} @gol
486 -masm=@var{dialect}  -mno-fancy-math-387 @gol
487 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
488 -mno-wide-multiply  -mrtd  -malign-double @gol
489 -mpreferred-stack-boundary=@var{num} @gol
490 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
491 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
492 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
493 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
494 -mno-red-zone -mno-tls-direct-seg-refs @gol
495 -mcmodel=@var{code-model} @gol
496 -m32  -m64}
498 @emph{IA-64 Options}
499 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
500 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
501 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
502 -minline-float-divide-max-throughput @gol
503 -minline-int-divide-min-latency @gol
504 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
505 -mfixed-range=@var{register-range}}
507 @emph{M32R/D Options}
508 @gccoptlist{-m32r2 -m32rx -m32r @gol
509 -mdebug @gol
510 -malign-loops -mno-align-loops @gol
511 -missue-rate=@var{number} @gol
512 -mbranch-cost=@var{number} @gol
513 -mmodel=@var{code-size-model-type} @gol
514 -msdata=@var{sdata-type} @gol
515 -mno-flush-func -mflush-func=@var{name} @gol
516 -mno-flush-trap -mflush-trap=@var{number} @gol
517 -G @var{num}}
519 @emph{M680x0 Options}
520 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
521 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
522 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
523 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
524 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
526 @emph{M68hc1x Options}
527 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
528 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
529 -msoft-reg-count=@var{count}}
531 @emph{MCore Options}
532 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
533 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
534 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
535 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
536 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
538 @emph{MIPS Options}
539 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
540 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
541 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
542 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
543 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
544 -mpaired-single  -mips3d @gol
545 -mint64  -mlong64  -mlong32 @gol
546 -G@var{num}  -membedded-data  -mno-embedded-data @gol
547 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
548 -msplit-addresses  -mno-split-addresses  @gol
549 -mexplicit-relocs  -mno-explicit-relocs  @gol
550 -mcheck-zero-division  -mno-check-zero-division @gol
551 -mdivide-traps  -mdivide-breaks @gol
552 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
553 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
554 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
555 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
556 -mflush-func=@var{func}  -mno-flush-func @gol
557 -mbranch-likely  -mno-branch-likely @gol
558 -mfp-exceptions -mno-fp-exceptions @gol
559 -mvr4130-align -mno-vr4130-align}
561 @emph{MMIX Options}
562 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
563 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
564 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
565 -mno-base-addresses  -msingle-exit  -mno-single-exit}
567 @emph{MN10300 Options}
568 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
569 -mam33  -mno-am33 @gol
570 -mam33-2  -mno-am33-2 @gol
571 -mno-crt0  -mrelax}
573 @emph{NS32K Options}
574 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
575 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
576 -mregparam  -mnoregparam  -msb  -mnosb @gol
577 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
579 @emph{PDP-11 Options}
580 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
581 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
582 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
583 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
584 -mbranch-expensive  -mbranch-cheap @gol
585 -msplit  -mno-split  -munix-asm  -mdec-asm}
587 @emph{PowerPC Options}
588 See RS/6000 and PowerPC Options.
590 @emph{RS/6000 and PowerPC Options}
591 @gccoptlist{-mcpu=@var{cpu-type} @gol
592 -mtune=@var{cpu-type} @gol
593 -mpower  -mno-power  -mpower2  -mno-power2 @gol
594 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
595 -maltivec  -mno-altivec @gol
596 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
597 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
598 -mnew-mnemonics  -mold-mnemonics @gol
599 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
600 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
601 -malign-power  -malign-natural @gol
602 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
603 -mstring  -mno-string  -mupdate  -mno-update @gol
604 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
605 -mstrict-align  -mno-strict-align  -mrelocatable @gol
606 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
607 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
608 -mdynamic-no-pic @gol
609 -mprioritize-restricted-insns=@var{priority} @gol
610 -msched-costly-dep=@var{dependence_type} @gol
611 -minsert-sched-nops=@var{scheme} @gol
612 -mcall-sysv  -mcall-netbsd @gol
613 -maix-struct-return  -msvr4-struct-return @gol
614 -mabi=altivec  -mabi=no-altivec @gol
615 -mabi=spe  -mabi=no-spe @gol
616 -misel=yes  -misel=no @gol
617 -mspe=yes  -mspe=no @gol
618 -mfloat-gprs=yes  -mfloat-gprs=no @gol
619 -mprototype  -mno-prototype @gol
620 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
621 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
623 @emph{S/390 and zSeries Options}
624 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
625 -mhard-float  -msoft-float  -mbackchain  -mno-backchain -mkernel-backchain @gol
626 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
627 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
628 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
629 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
631 @emph{SH Options}
632 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
633 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
634 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
635 -m5-64media  -m5-64media-nofpu @gol
636 -m5-32media  -m5-32media-nofpu @gol
637 -m5-compact  -m5-compact-nofpu @gol
638 -mb  -ml  -mdalign  -mrelax @gol
639 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
640 -mieee  -misize  -mpadstruct  -mspace @gol
641 -mprefergot  -musermode}
643 @emph{SPARC Options}
644 @gccoptlist{-mcpu=@var{cpu-type} @gol
645 -mtune=@var{cpu-type} @gol
646 -mcmodel=@var{code-model} @gol
647 -m32  -m64  -mapp-regs  -mno-app-regs @gol
648 -mfaster-structs  -mno-faster-structs @gol
649 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
650 -mhard-quad-float  -msoft-quad-float @gol
651 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
652 -mstack-bias  -mno-stack-bias @gol
653 -munaligned-doubles  -mno-unaligned-doubles @gol
654 -mv8plus  -mno-v8plus  -mvis  -mno-vis
655 -threads -pthreads}
657 @emph{System V Options}
658 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
660 @emph{TMS320C3x/C4x Options}
661 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
662 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
663 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
664 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
666 @emph{V850 Options}
667 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
668 -mprolog-function  -mno-prolog-function  -mspace @gol
669 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
670 -mapp-regs  -mno-app-regs @gol
671 -mdisable-callt  -mno-disable-callt @gol
672 -mv850e1 @gol
673 -mv850e @gol
674 -mv850  -mbig-switch}
676 @emph{VAX Options}
677 @gccoptlist{-mg  -mgnu  -munix}
679 @emph{x86-64 Options}
680 See i386 and x86-64 Options.
682 @emph{Xstormy16 Options}
683 @gccoptlist{-msim}
685 @emph{Xtensa Options}
686 @gccoptlist{-mconst16 -mno-const16 @gol
687 -mfused-madd  -mno-fused-madd @gol
688 -mtext-section-literals  -mno-text-section-literals @gol
689 -mtarget-align  -mno-target-align @gol
690 -mlongcalls  -mno-longcalls}
692 @emph{zSeries Options}
693 See S/390 and zSeries Options.
695 @item Code Generation Options
696 @xref{Code Gen Options,,Options for Code Generation Conventions}.
697 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
698 -ffixed-@var{reg}  -fexceptions @gol
699 -fnon-call-exceptions  -funwind-tables @gol
700 -fasynchronous-unwind-tables @gol
701 -finhibit-size-directive  -finstrument-functions @gol
702 -fno-common  -fno-ident @gol
703 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
704 -freg-struct-return  -fshared-data  -fshort-enums @gol
705 -fshort-double  -fshort-wchar @gol
706 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
707 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
708 -fargument-alias  -fargument-noalias @gol
709 -fargument-noalias-global  -fleading-underscore @gol
710 -ftls-model=@var{model} @gol
711 -ftrapv  -fwrapv  -fbounds-check @gol
712 -fvisibility}
713 @end table
715 @menu
716 * Overall Options::     Controlling the kind of output:
717                         an executable, object files, assembler files,
718                         or preprocessed source.
719 * C Dialect Options::   Controlling the variant of C language compiled.
720 * C++ Dialect Options:: Variations on C++.
721 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
722                         and Objective-C++.
723 * Language Independent Options:: Controlling how diagnostics should be
724                         formatted.
725 * Warning Options::     How picky should the compiler be?
726 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
727 * Optimize Options::    How much optimization?
728 * Preprocessor Options:: Controlling header files and macro definitions.
729                          Also, getting dependency information for Make.
730 * Assembler Options::   Passing options to the assembler.
731 * Link Options::        Specifying libraries and so on.
732 * Directory Options::   Where to find header files and libraries.
733                         Where to find the compiler executable files.
734 * Spec Files::          How to pass switches to sub-processes.
735 * Target Options::      Running a cross-compiler, or an old version of GCC.
736 @end menu
738 @node Overall Options
739 @section Options Controlling the Kind of Output
741 Compilation can involve up to four stages: preprocessing, compilation
742 proper, assembly and linking, always in that order.  GCC is capable of
743 preprocessing and compiling several files either into several
744 assembler input files, or into one assembler input file; then each
745 assembler input file produces an object file, and linking combines all
746 the object files (those newly compiled, and those specified as input)
747 into an executable file.
749 @cindex file name suffix
750 For any given input file, the file name suffix determines what kind of
751 compilation is done:
753 @table @gcctabopt
754 @item @var{file}.c
755 C source code which must be preprocessed.
757 @item @var{file}.i
758 C source code which should not be preprocessed.
760 @item @var{file}.ii
761 C++ source code which should not be preprocessed.
763 @item @var{file}.m
764 Objective-C source code.  Note that you must link with the @file{libobjc}
765 library to make an Objective-C program work.
767 @item @var{file}.mi
768 Objective-C source code which should not be preprocessed.
770 @item @var{file}.mm
771 @itemx @var{file}.M
772 Objective-C++ source code.  Note that you must link with the @file{libobjc}
773 library to make an Objective-C++ program work.  Note that @samp{.M} refers
774 to a literal capital M@.
776 @item @var{file}.mii
777 Objective-C++ source code which should not be preprocessed.
779 @item @var{file}.h
780 C, C++, Objective-C or Objective-C++ header file to be turned into a
781 precompiled header.
783 @item @var{file}.cc
784 @itemx @var{file}.cp
785 @itemx @var{file}.cxx
786 @itemx @var{file}.cpp
787 @itemx @var{file}.CPP
788 @itemx @var{file}.c++
789 @itemx @var{file}.C
790 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
791 the last two letters must both be literally @samp{x}.  Likewise,
792 @samp{.C} refers to a literal capital C@.
794 @item @var{file}.hh
795 @itemx @var{file}.H
796 C++ header file to be turned into a precompiled header.
798 @item @var{file}.f
799 @itemx @var{file}.for
800 @itemx @var{file}.FOR
801 Fortran source code which should not be preprocessed.
803 @item @var{file}.F
804 @itemx @var{file}.fpp
805 @itemx @var{file}.FPP
806 Fortran source code which must be preprocessed (with the traditional
807 preprocessor).
809 @item @var{file}.r
810 Fortran source code which must be preprocessed with a RATFOR
811 preprocessor (not included with GCC)@.
813 @item @var{file}.f90
814 @itemx @var{file}.f95
815 Fortran 90/95 source code which should not be preprocessed.
817 @c FIXME: Descriptions of Java file types.
818 @c @var{file}.java
819 @c @var{file}.class
820 @c @var{file}.zip
821 @c @var{file}.jar
823 @item @var{file}.ads
824 Ada source code file which contains a library unit declaration (a
825 declaration of a package, subprogram, or generic, or a generic
826 instantiation), or a library unit renaming declaration (a package,
827 generic, or subprogram renaming declaration).  Such files are also
828 called @dfn{specs}.
830 @itemx @var{file}.adb
831 Ada source code file containing a library unit body (a subprogram or
832 package body).  Such files are also called @dfn{bodies}.
834 @c GCC also knows about some suffixes for languages not yet included:
835 @c Pascal:
836 @c @var{file}.p
837 @c @var{file}.pas
839 @item @var{file}.s
840 Assembler code.
842 @item @var{file}.S
843 Assembler code which must be preprocessed.
845 @item @var{other}
846 An object file to be fed straight into linking.
847 Any file name with no recognized suffix is treated this way.
848 @end table
850 @opindex x
851 You can specify the input language explicitly with the @option{-x} option:
853 @table @gcctabopt
854 @item -x @var{language}
855 Specify explicitly the @var{language} for the following input files
856 (rather than letting the compiler choose a default based on the file
857 name suffix).  This option applies to all following input files until
858 the next @option{-x} option.  Possible values for @var{language} are:
859 @smallexample
860 c  c-header  c-cpp-output
861 c++  c++-header  c++-cpp-output
862 objective-c  objective-c-header  objective-c-cpp-output
863 objective-c++ objective-c++-header objective-c++-cpp-output
864 assembler  assembler-with-cpp
866 f77  f77-cpp-input  ratfor
868 java
869 treelang
870 @end smallexample
872 @item -x none
873 Turn off any specification of a language, so that subsequent files are
874 handled according to their file name suffixes (as they are if @option{-x}
875 has not been used at all).
877 @item -pass-exit-codes
878 @opindex pass-exit-codes
879 Normally the @command{gcc} program will exit with the code of 1 if any
880 phase of the compiler returns a non-success return code.  If you specify
881 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
882 numerically highest error produced by any phase that returned an error
883 indication.
884 @end table
886 If you only want some of the stages of compilation, you can use
887 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
888 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
889 @command{gcc} is to stop.  Note that some combinations (for example,
890 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
892 @table @gcctabopt
893 @item -c
894 @opindex c
895 Compile or assemble the source files, but do not link.  The linking
896 stage simply is not done.  The ultimate output is in the form of an
897 object file for each source file.
899 By default, the object file name for a source file is made by replacing
900 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
902 Unrecognized input files, not requiring compilation or assembly, are
903 ignored.
905 @item -S
906 @opindex S
907 Stop after the stage of compilation proper; do not assemble.  The output
908 is in the form of an assembler code file for each non-assembler input
909 file specified.
911 By default, the assembler file name for a source file is made by
912 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
914 Input files that don't require compilation are ignored.
916 @item -E
917 @opindex E
918 Stop after the preprocessing stage; do not run the compiler proper.  The
919 output is in the form of preprocessed source code, which is sent to the
920 standard output.
922 Input files which don't require preprocessing are ignored.
924 @cindex output file option
925 @item -o @var{file}
926 @opindex o
927 Place output in file @var{file}.  This applies regardless to whatever
928 sort of output is being produced, whether it be an executable file,
929 an object file, an assembler file or preprocessed C code.
931 If @option{-o} is not specified, the default is to put an executable
932 file in @file{a.out}, the object file for
933 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
934 assembler file in @file{@var{source}.s}, a precompiled header file in
935 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
936 standard output.
938 @item -v
939 @opindex v
940 Print (on standard error output) the commands executed to run the stages
941 of compilation.  Also print the version number of the compiler driver
942 program and of the preprocessor and the compiler proper.
944 @item -###
945 @opindex ###
946 Like @option{-v} except the commands are not executed and all command
947 arguments are quoted.  This is useful for shell scripts to capture the
948 driver-generated command lines.
950 @item -pipe
951 @opindex pipe
952 Use pipes rather than temporary files for communication between the
953 various stages of compilation.  This fails to work on some systems where
954 the assembler is unable to read from a pipe; but the GNU assembler has
955 no trouble.
957 @item -combine
958 @opindex combine
959 If you are compiling multiple source files, this option tells the driver
960 to pass all the source files to the compiler at once (for those
961 languages for which the compiler can handle this).  This will allow
962 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
963 language for which this is supported is C.  If you pass source files for
964 multiple languages to the driver, using this option, the driver will invoke
965 the compiler(s) that support IMA once each, passing each compiler all the
966 source files appropriate for it.  For those languages that do not support
967 IMA this option will be ignored, and the compiler will be invoked once for
968 each source file in that language.  If you use this option in conjunction
969 with -save-temps, the compiler will generate multiple pre-processed files
970 (one for each source file), but only one (combined) .o or .s file.
972 @item --help
973 @opindex help
974 Print (on the standard output) a description of the command line options
975 understood by @command{gcc}.  If the @option{-v} option is also specified
976 then @option{--help} will also be passed on to the various processes
977 invoked by @command{gcc}, so that they can display the command line options
978 they accept.  If the @option{-Wextra} option is also specified then command
979 line options which have no documentation associated with them will also
980 be displayed.
982 @item --target-help
983 @opindex target-help
984 Print (on the standard output) a description of target specific command
985 line options for each tool.
987 @item --version
988 @opindex version
989 Display the version number and copyrights of the invoked GCC.
990 @end table
992 @node Invoking G++
993 @section Compiling C++ Programs
995 @cindex suffixes for C++ source
996 @cindex C++ source file suffixes
997 C++ source files conventionally use one of the suffixes @samp{.C},
998 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
999 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1000 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1001 files with these names and compiles them as C++ programs even if you
1002 call the compiler the same way as for compiling C programs (usually
1003 with the name @command{gcc}).
1005 @findex g++
1006 @findex c++
1007 However, C++ programs often require class libraries as well as a
1008 compiler that understands the C++ language---and under some
1009 circumstances, you might want to compile programs or header files from
1010 standard input, or otherwise without a suffix that flags them as C++
1011 programs.  You might also like to precompile a C header file with a
1012 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1013 program that calls GCC with the default language set to C++, and
1014 automatically specifies linking against the C++ library.  On many
1015 systems, @command{g++} is also installed with the name @command{c++}.
1017 @cindex invoking @command{g++}
1018 When you compile C++ programs, you may specify many of the same
1019 command-line options that you use for compiling programs in any
1020 language; or command-line options meaningful for C and related
1021 languages; or options that are meaningful only for C++ programs.
1022 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1023 explanations of options for languages related to C@.
1024 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1025 explanations of options that are meaningful only for C++ programs.
1027 @node C Dialect Options
1028 @section Options Controlling C Dialect
1029 @cindex dialect options
1030 @cindex language dialect options
1031 @cindex options, dialect
1033 The following options control the dialect of C (or languages derived
1034 from C, such as C++, Objective-C and Objective-C++) that the compiler
1035 accepts:
1037 @table @gcctabopt
1038 @cindex ANSI support
1039 @cindex ISO support
1040 @item -ansi
1041 @opindex ansi
1042 In C mode, support all ISO C90 programs.  In C++ mode,
1043 remove GNU extensions that conflict with ISO C++.
1045 This turns off certain features of GCC that are incompatible with ISO
1046 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1047 such as the @code{asm} and @code{typeof} keywords, and
1048 predefined macros such as @code{unix} and @code{vax} that identify the
1049 type of system you are using.  It also enables the undesirable and
1050 rarely used ISO trigraph feature.  For the C compiler,
1051 it disables recognition of C++ style @samp{//} comments as well as
1052 the @code{inline} keyword.
1054 The alternate keywords @code{__asm__}, @code{__extension__},
1055 @code{__inline__} and @code{__typeof__} continue to work despite
1056 @option{-ansi}.  You would not want to use them in an ISO C program, of
1057 course, but it is useful to put them in header files that might be included
1058 in compilations done with @option{-ansi}.  Alternate predefined macros
1059 such as @code{__unix__} and @code{__vax__} are also available, with or
1060 without @option{-ansi}.
1062 The @option{-ansi} option does not cause non-ISO programs to be
1063 rejected gratuitously.  For that, @option{-pedantic} is required in
1064 addition to @option{-ansi}.  @xref{Warning Options}.
1066 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1067 option is used.  Some header files may notice this macro and refrain
1068 from declaring certain functions or defining certain macros that the
1069 ISO standard doesn't call for; this is to avoid interfering with any
1070 programs that might use these names for other things.
1072 Functions which would normally be built in but do not have semantics
1073 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1074 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1075 built-in functions provided by GCC}, for details of the functions
1076 affected.
1078 @item -std=
1079 @opindex std
1080 Determine the language standard.  This option is currently only
1081 supported when compiling C or C++.  A value for this option must be
1082 provided; possible values are
1084 @table @samp
1085 @item c89
1086 @itemx iso9899:1990
1087 ISO C90 (same as @option{-ansi}).
1089 @item iso9899:199409
1090 ISO C90 as modified in amendment 1.
1092 @item c99
1093 @itemx c9x
1094 @itemx iso9899:1999
1095 @itemx iso9899:199x
1096 ISO C99.  Note that this standard is not yet fully supported; see
1097 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1098 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1100 @item gnu89
1101 Default, ISO C90 plus GNU extensions (including some C99 features).
1103 @item gnu99
1104 @itemx gnu9x
1105 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1106 this will become the default.  The name @samp{gnu9x} is deprecated.
1108 @item c++98
1109 The 1998 ISO C++ standard plus amendments.
1111 @item gnu++98
1112 The same as @option{-std=c++98} plus GNU extensions.  This is the
1113 default for C++ code.
1114 @end table
1116 Even when this option is not specified, you can still use some of the
1117 features of newer standards in so far as they do not conflict with
1118 previous C standards.  For example, you may use @code{__restrict__} even
1119 when @option{-std=c99} is not specified.
1121 The @option{-std} options specifying some version of ISO C have the same
1122 effects as @option{-ansi}, except that features that were not in ISO C90
1123 but are in the specified version (for example, @samp{//} comments and
1124 the @code{inline} keyword in ISO C99) are not disabled.
1126 @xref{Standards,,Language Standards Supported by GCC}, for details of
1127 these standard versions.
1129 @item -aux-info @var{filename}
1130 @opindex aux-info
1131 Output to the given filename prototyped declarations for all functions
1132 declared and/or defined in a translation unit, including those in header
1133 files.  This option is silently ignored in any language other than C@.
1135 Besides declarations, the file indicates, in comments, the origin of
1136 each declaration (source file and line), whether the declaration was
1137 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1138 @samp{O} for old, respectively, in the first character after the line
1139 number and the colon), and whether it came from a declaration or a
1140 definition (@samp{C} or @samp{F}, respectively, in the following
1141 character).  In the case of function definitions, a K&R-style list of
1142 arguments followed by their declarations is also provided, inside
1143 comments, after the declaration.
1145 @item -fno-asm
1146 @opindex fno-asm
1147 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1148 keyword, so that code can use these words as identifiers.  You can use
1149 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1150 instead.  @option{-ansi} implies @option{-fno-asm}.
1152 In C++, this switch only affects the @code{typeof} keyword, since
1153 @code{asm} and @code{inline} are standard keywords.  You may want to
1154 use the @option{-fno-gnu-keywords} flag instead, which has the same
1155 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1156 switch only affects the @code{asm} and @code{typeof} keywords, since
1157 @code{inline} is a standard keyword in ISO C99.
1159 @item -fno-builtin
1160 @itemx -fno-builtin-@var{function}
1161 @opindex fno-builtin
1162 @cindex built-in functions
1163 Don't recognize built-in functions that do not begin with
1164 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1165 functions provided by GCC}, for details of the functions affected,
1166 including those which are not built-in functions when @option{-ansi} or
1167 @option{-std} options for strict ISO C conformance are used because they
1168 do not have an ISO standard meaning.
1170 GCC normally generates special code to handle certain built-in functions
1171 more efficiently; for instance, calls to @code{alloca} may become single
1172 instructions that adjust the stack directly, and calls to @code{memcpy}
1173 may become inline copy loops.  The resulting code is often both smaller
1174 and faster, but since the function calls no longer appear as such, you
1175 cannot set a breakpoint on those calls, nor can you change the behavior
1176 of the functions by linking with a different library.  In addition,
1177 when a function is recognized as a built-in function, GCC may use
1178 information about that function to warn about problems with calls to
1179 that function, or to generate more efficient code, even if the
1180 resulting code still contains calls to that function.  For example,
1181 warnings are given with @option{-Wformat} for bad calls to
1182 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1183 known not to modify global memory.
1185 With the @option{-fno-builtin-@var{function}} option
1186 only the built-in function @var{function} is
1187 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1188 function is named this is not built-in in this version of GCC, this
1189 option is ignored.  There is no corresponding
1190 @option{-fbuiltin-@var{function}} option; if you wish to enable
1191 built-in functions selectively when using @option{-fno-builtin} or
1192 @option{-ffreestanding}, you may define macros such as:
1194 @smallexample
1195 #define abs(n)          __builtin_abs ((n))
1196 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1197 @end smallexample
1199 @item -fhosted
1200 @opindex fhosted
1201 @cindex hosted environment
1203 Assert that compilation takes place in a hosted environment.  This implies
1204 @option{-fbuiltin}.  A hosted environment is one in which the
1205 entire standard library is available, and in which @code{main} has a return
1206 type of @code{int}.  Examples are nearly everything except a kernel.
1207 This is equivalent to @option{-fno-freestanding}.
1209 @item -ffreestanding
1210 @opindex ffreestanding
1211 @cindex hosted environment
1213 Assert that compilation takes place in a freestanding environment.  This
1214 implies @option{-fno-builtin}.  A freestanding environment
1215 is one in which the standard library may not exist, and program startup may
1216 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1217 This is equivalent to @option{-fno-hosted}.
1219 @xref{Standards,,Language Standards Supported by GCC}, for details of
1220 freestanding and hosted environments.
1222 @item -fms-extensions
1223 @opindex fms-extensions
1224 Accept some non-standard constructs used in Microsoft header files.
1226 Some cases of unnamed fields in structures and unions are only
1227 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1228 fields within structs/unions}, for details.
1230 @item -trigraphs
1231 @opindex trigraphs
1232 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1233 options for strict ISO C conformance) implies @option{-trigraphs}.
1235 @item -no-integrated-cpp
1236 @opindex no-integrated-cpp
1237 Performs a compilation in two passes: preprocessing and compiling.  This
1238 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1239 @option{-B} option. The user supplied compilation step can then add in
1240 an additional preprocessing step after normal preprocessing but before
1241 compiling. The default is to use the integrated cpp (internal cpp)
1243 The semantics of this option will change if "cc1", "cc1plus", and
1244 "cc1obj" are merged.
1246 @cindex traditional C language
1247 @cindex C language, traditional
1248 @item -traditional
1249 @itemx -traditional-cpp
1250 @opindex traditional-cpp
1251 @opindex traditional
1252 Formerly, these options caused GCC to attempt to emulate a pre-standard
1253 C compiler.  They are now only supported with the @option{-E} switch.
1254 The preprocessor continues to support a pre-standard mode.  See the GNU
1255 CPP manual for details.
1257 @item -fcond-mismatch
1258 @opindex fcond-mismatch
1259 Allow conditional expressions with mismatched types in the second and
1260 third arguments.  The value of such an expression is void.  This option
1261 is not supported for C++.
1263 @item -funsigned-char
1264 @opindex funsigned-char
1265 Let the type @code{char} be unsigned, like @code{unsigned char}.
1267 Each kind of machine has a default for what @code{char} should
1268 be.  It is either like @code{unsigned char} by default or like
1269 @code{signed char} by default.
1271 Ideally, a portable program should always use @code{signed char} or
1272 @code{unsigned char} when it depends on the signedness of an object.
1273 But many programs have been written to use plain @code{char} and
1274 expect it to be signed, or expect it to be unsigned, depending on the
1275 machines they were written for.  This option, and its inverse, let you
1276 make such a program work with the opposite default.
1278 The type @code{char} is always a distinct type from each of
1279 @code{signed char} or @code{unsigned char}, even though its behavior
1280 is always just like one of those two.
1282 @item -fsigned-char
1283 @opindex fsigned-char
1284 Let the type @code{char} be signed, like @code{signed char}.
1286 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1287 the negative form of @option{-funsigned-char}.  Likewise, the option
1288 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1290 @item -fsigned-bitfields
1291 @itemx -funsigned-bitfields
1292 @itemx -fno-signed-bitfields
1293 @itemx -fno-unsigned-bitfields
1294 @opindex fsigned-bitfields
1295 @opindex funsigned-bitfields
1296 @opindex fno-signed-bitfields
1297 @opindex fno-unsigned-bitfields
1298 These options control whether a bit-field is signed or unsigned, when the
1299 declaration does not use either @code{signed} or @code{unsigned}.  By
1300 default, such a bit-field is signed, because this is consistent: the
1301 basic integer types such as @code{int} are signed types.
1302 @end table
1304 @node C++ Dialect Options
1305 @section Options Controlling C++ Dialect
1307 @cindex compiler options, C++
1308 @cindex C++ options, command line
1309 @cindex options, C++
1310 This section describes the command-line options that are only meaningful
1311 for C++ programs; but you can also use most of the GNU compiler options
1312 regardless of what language your program is in.  For example, you
1313 might compile a file @code{firstClass.C} like this:
1315 @smallexample
1316 g++ -g -frepo -O -c firstClass.C
1317 @end smallexample
1319 @noindent
1320 In this example, only @option{-frepo} is an option meant
1321 only for C++ programs; you can use the other options with any
1322 language supported by GCC@.
1324 Here is a list of options that are @emph{only} for compiling C++ programs:
1326 @table @gcctabopt
1328 @item -fabi-version=@var{n}
1329 @opindex fabi-version
1330 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1331 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1332 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1333 the version that conforms most closely to the C++ ABI specification.
1334 Therefore, the ABI obtained using version 0 will change as ABI bugs
1335 are fixed.
1337 The default is version 2.
1339 @item -fno-access-control
1340 @opindex fno-access-control
1341 Turn off all access checking.  This switch is mainly useful for working
1342 around bugs in the access control code.
1344 @item -fcheck-new
1345 @opindex fcheck-new
1346 Check that the pointer returned by @code{operator new} is non-null
1347 before attempting to modify the storage allocated.  This check is
1348 normally unnecessary because the C++ standard specifies that
1349 @code{operator new} will only return @code{0} if it is declared
1350 @samp{throw()}, in which case the compiler will always check the
1351 return value even without this option.  In all other cases, when
1352 @code{operator new} has a non-empty exception specification, memory
1353 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1354 @samp{new (nothrow)}.
1356 @item -fconserve-space
1357 @opindex fconserve-space
1358 Put uninitialized or runtime-initialized global variables into the
1359 common segment, as C does.  This saves space in the executable at the
1360 cost of not diagnosing duplicate definitions.  If you compile with this
1361 flag and your program mysteriously crashes after @code{main()} has
1362 completed, you may have an object that is being destroyed twice because
1363 two definitions were merged.
1365 This option is no longer useful on most targets, now that support has
1366 been added for putting variables into BSS without making them common.
1368 @item -fno-const-strings
1369 @opindex fno-const-strings
1370 Give string constants type @code{char *} instead of type @code{const
1371 char *}.  By default, G++ uses type @code{const char *} as required by
1372 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1373 actually modify the value of a string constant.
1375 This option might be removed in a future release of G++.  For maximum
1376 portability, you should structure your code so that it works with
1377 string constants that have type @code{const char *}.
1379 @item -fno-elide-constructors
1380 @opindex fno-elide-constructors
1381 The C++ standard allows an implementation to omit creating a temporary
1382 which is only used to initialize another object of the same type.
1383 Specifying this option disables that optimization, and forces G++ to
1384 call the copy constructor in all cases.
1386 @item -fno-enforce-eh-specs
1387 @opindex fno-enforce-eh-specs
1388 Don't check for violation of exception specifications at runtime.  This
1389 option violates the C++ standard, but may be useful for reducing code
1390 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1391 will still optimize based on the exception specifications.
1393 @item -ffor-scope
1394 @itemx -fno-for-scope
1395 @opindex ffor-scope
1396 @opindex fno-for-scope
1397 If @option{-ffor-scope} is specified, the scope of variables declared in
1398 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1399 as specified by the C++ standard.
1400 If @option{-fno-for-scope} is specified, the scope of variables declared in
1401 a @i{for-init-statement} extends to the end of the enclosing scope,
1402 as was the case in old versions of G++, and other (traditional)
1403 implementations of C++.
1405 The default if neither flag is given to follow the standard,
1406 but to allow and give a warning for old-style code that would
1407 otherwise be invalid, or have different behavior.
1409 @item -fno-gnu-keywords
1410 @opindex fno-gnu-keywords
1411 Do not recognize @code{typeof} as a keyword, so that code can use this
1412 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1413 @option{-ansi} implies @option{-fno-gnu-keywords}.
1415 @item -fno-implicit-templates
1416 @opindex fno-implicit-templates
1417 Never emit code for non-inline templates which are instantiated
1418 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1419 @xref{Template Instantiation}, for more information.
1421 @item -fno-implicit-inline-templates
1422 @opindex fno-implicit-inline-templates
1423 Don't emit code for implicit instantiations of inline templates, either.
1424 The default is to handle inlines differently so that compiles with and
1425 without optimization will need the same set of explicit instantiations.
1427 @item -fno-implement-inlines
1428 @opindex fno-implement-inlines
1429 To save space, do not emit out-of-line copies of inline functions
1430 controlled by @samp{#pragma implementation}.  This will cause linker
1431 errors if these functions are not inlined everywhere they are called.
1433 @item -fms-extensions
1434 @opindex fms-extensions
1435 Disable pedantic warnings about constructs used in MFC, such as implicit
1436 int and getting a pointer to member function via non-standard syntax.
1438 @item -fno-nonansi-builtins
1439 @opindex fno-nonansi-builtins
1440 Disable built-in declarations of functions that are not mandated by
1441 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1442 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1444 @item -fno-operator-names
1445 @opindex fno-operator-names
1446 Do not treat the operator name keywords @code{and}, @code{bitand},
1447 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1448 synonyms as keywords.
1450 @item -fno-optional-diags
1451 @opindex fno-optional-diags
1452 Disable diagnostics that the standard says a compiler does not need to
1453 issue.  Currently, the only such diagnostic issued by G++ is the one for
1454 a name having multiple meanings within a class.
1456 @item -fpermissive
1457 @opindex fpermissive
1458 Downgrade some diagnostics about nonconformant code from errors to
1459 warnings.  Thus, using @option{-fpermissive} will allow some
1460 nonconforming code to compile.
1462 @item -frepo
1463 @opindex frepo
1464 Enable automatic template instantiation at link time.  This option also
1465 implies @option{-fno-implicit-templates}.  @xref{Template
1466 Instantiation}, for more information.
1468 @item -fno-rtti
1469 @opindex fno-rtti
1470 Disable generation of information about every class with virtual
1471 functions for use by the C++ runtime type identification features
1472 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1473 of the language, you can save some space by using this flag.  Note that
1474 exception handling uses the same information, but it will generate it as
1475 needed.
1477 @item -fstats
1478 @opindex fstats
1479 Emit statistics about front-end processing at the end of the compilation.
1480 This information is generally only useful to the G++ development team.
1482 @item -ftemplate-depth-@var{n}
1483 @opindex ftemplate-depth
1484 Set the maximum instantiation depth for template classes to @var{n}.
1485 A limit on the template instantiation depth is needed to detect
1486 endless recursions during template class instantiation.  ANSI/ISO C++
1487 conforming programs must not rely on a maximum depth greater than 17.
1489 @item -fno-threadsafe-statics
1490 @opindex fno-threadsafe-statics
1491 Do not emit the extra code to use the routines specified in the C++
1492 ABI for thread-safe initialization of local statics.  You can use this
1493 option to reduce code size slightly in code that doesn't need to be
1494 thread-safe.
1496 @item -fuse-cxa-atexit
1497 @opindex fuse-cxa-atexit
1498 Register destructors for objects with static storage duration with the
1499 @code{__cxa_atexit} function rather than the @code{atexit} function.
1500 This option is required for fully standards-compliant handling of static
1501 destructors, but will only work if your C library supports
1502 @code{__cxa_atexit}.
1504 @item -fvisibility-inlines-hidden
1505 @opindex fvisibility-inlines-hidden
1506 Causes all inlined methods to be marked with
1507 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1508 appear in the export table of a DSO and do not require a PLT indirection
1509 when used within the DSO. Enabling this option can have a dramatic effect
1510 on load and link times of a DSO as it massively reduces the size of the
1511 dynamic export table when the library makes heavy use of templates. While
1512 it can cause bloating through duplication of code within each DSO where
1513 it is used, often the wastage is less than the considerable space occupied
1514 by a long symbol name in the export table which is typical when using
1515 templates and namespaces. For even more savings, combine with the
1516 @option{-fvisibility=hidden} switch.
1518 @item -fno-weak
1519 @opindex fno-weak
1520 Do not use weak symbol support, even if it is provided by the linker.
1521 By default, G++ will use weak symbols if they are available.  This
1522 option exists only for testing, and should not be used by end-users;
1523 it will result in inferior code and has no benefits.  This option may
1524 be removed in a future release of G++.
1526 @item -nostdinc++
1527 @opindex nostdinc++
1528 Do not search for header files in the standard directories specific to
1529 C++, but do still search the other standard directories.  (This option
1530 is used when building the C++ library.)
1531 @end table
1533 In addition, these optimization, warning, and code generation options
1534 have meanings only for C++ programs:
1536 @table @gcctabopt
1537 @item -fno-default-inline
1538 @opindex fno-default-inline
1539 Do not assume @samp{inline} for functions defined inside a class scope.
1540 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1541 functions will have linkage like inline functions; they just won't be
1542 inlined by default.
1544 @item -Wabi @r{(C++ only)}
1545 @opindex Wabi
1546 Warn when G++ generates code that is probably not compatible with the
1547 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1548 all such cases, there are probably some cases that are not warned about,
1549 even though G++ is generating incompatible code.  There may also be
1550 cases where warnings are emitted even though the code that is generated
1551 will be compatible.
1553 You should rewrite your code to avoid these warnings if you are
1554 concerned about the fact that code generated by G++ may not be binary
1555 compatible with code generated by other compilers.
1557 The known incompatibilities at this point include:
1559 @itemize @bullet
1561 @item
1562 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1563 pack data into the same byte as a base class.  For example:
1565 @smallexample
1566 struct A @{ virtual void f(); int f1 : 1; @};
1567 struct B : public A @{ int f2 : 1; @};
1568 @end smallexample
1570 @noindent
1571 In this case, G++ will place @code{B::f2} into the same byte
1572 as@code{A::f1}; other compilers will not.  You can avoid this problem
1573 by explicitly padding @code{A} so that its size is a multiple of the
1574 byte size on your platform; that will cause G++ and other compilers to
1575 layout @code{B} identically.
1577 @item
1578 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1579 tail padding when laying out virtual bases.  For example:
1581 @smallexample
1582 struct A @{ virtual void f(); char c1; @};
1583 struct B @{ B(); char c2; @};
1584 struct C : public A, public virtual B @{@};
1585 @end smallexample
1587 @noindent
1588 In this case, G++ will not place @code{B} into the tail-padding for
1589 @code{A}; other compilers will.  You can avoid this problem by
1590 explicitly padding @code{A} so that its size is a multiple of its
1591 alignment (ignoring virtual base classes); that will cause G++ and other
1592 compilers to layout @code{C} identically.
1594 @item
1595 Incorrect handling of bit-fields with declared widths greater than that
1596 of their underlying types, when the bit-fields appear in a union.  For
1597 example:
1599 @smallexample
1600 union U @{ int i : 4096; @};
1601 @end smallexample
1603 @noindent
1604 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1605 union too small by the number of bits in an @code{int}.
1607 @item
1608 Empty classes can be placed at incorrect offsets.  For example:
1610 @smallexample
1611 struct A @{@};
1613 struct B @{
1614   A a;
1615   virtual void f ();
1618 struct C : public B, public A @{@};
1619 @end smallexample
1621 @noindent
1622 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1623 it should be placed at offset zero.  G++ mistakenly believes that the
1624 @code{A} data member of @code{B} is already at offset zero.
1626 @item
1627 Names of template functions whose types involve @code{typename} or
1628 template template parameters can be mangled incorrectly.
1630 @smallexample
1631 template <typename Q>
1632 void f(typename Q::X) @{@}
1634 template <template <typename> class Q>
1635 void f(typename Q<int>::X) @{@}
1636 @end smallexample
1638 @noindent
1639 Instantiations of these templates may be mangled incorrectly.
1641 @end itemize
1643 @item -Wctor-dtor-privacy @r{(C++ only)}
1644 @opindex Wctor-dtor-privacy
1645 Warn when a class seems unusable because all the constructors or
1646 destructors in that class are private, and it has neither friends nor
1647 public static member functions.
1649 @item -Wnon-virtual-dtor @r{(C++ only)}
1650 @opindex Wnon-virtual-dtor
1651 Warn when a class appears to be polymorphic, thereby requiring a virtual
1652 destructor, yet it declares a non-virtual one.
1653 This warning is enabled by @option{-Wall}.
1655 @item -Wreorder @r{(C++ only)}
1656 @opindex Wreorder
1657 @cindex reordering, warning
1658 @cindex warning for reordering of member initializers
1659 Warn when the order of member initializers given in the code does not
1660 match the order in which they must be executed.  For instance:
1662 @smallexample
1663 struct A @{
1664   int i;
1665   int j;
1666   A(): j (0), i (1) @{ @}
1668 @end smallexample
1670 The compiler will rearrange the member initializers for @samp{i}
1671 and @samp{j} to match the declaration order of the members, emitting
1672 a warning to that effect.  This warning is enabled by @option{-Wall}.
1673 @end table
1675 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1677 @table @gcctabopt
1678 @item -Weffc++ @r{(C++ only)}
1679 @opindex Weffc++
1680 Warn about violations of the following style guidelines from Scott Meyers'
1681 @cite{Effective C++} book:
1683 @itemize @bullet
1684 @item
1685 Item 11:  Define a copy constructor and an assignment operator for classes
1686 with dynamically allocated memory.
1688 @item
1689 Item 12:  Prefer initialization to assignment in constructors.
1691 @item
1692 Item 14:  Make destructors virtual in base classes.
1694 @item
1695 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1697 @item
1698 Item 23:  Don't try to return a reference when you must return an object.
1700 @end itemize
1702 Also warn about violations of the following style guidelines from
1703 Scott Meyers' @cite{More Effective C++} book:
1705 @itemize @bullet
1706 @item
1707 Item 6:  Distinguish between prefix and postfix forms of increment and
1708 decrement operators.
1710 @item
1711 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1713 @end itemize
1715 When selecting this option, be aware that the standard library
1716 headers do not obey all of these guidelines; use @samp{grep -v}
1717 to filter out those warnings.
1719 @item -Wno-deprecated @r{(C++ only)}
1720 @opindex Wno-deprecated
1721 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1723 @item -Wno-non-template-friend @r{(C++ only)}
1724 @opindex Wno-non-template-friend
1725 Disable warnings when non-templatized friend functions are declared
1726 within a template.  Since the advent of explicit template specification
1727 support in G++, if the name of the friend is an unqualified-id (i.e.,
1728 @samp{friend foo(int)}), the C++ language specification demands that the
1729 friend declare or define an ordinary, nontemplate function.  (Section
1730 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1731 could be interpreted as a particular specialization of a templatized
1732 function.  Because this non-conforming behavior is no longer the default
1733 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1734 check existing code for potential trouble spots and is on by default.
1735 This new compiler behavior can be turned off with
1736 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1737 but disables the helpful warning.
1739 @item -Wold-style-cast @r{(C++ only)}
1740 @opindex Wold-style-cast
1741 Warn if an old-style (C-style) cast to a non-void type is used within
1742 a C++ program.  The new-style casts (@samp{static_cast},
1743 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1744 unintended effects and much easier to search for.
1746 @item -Woverloaded-virtual @r{(C++ only)}
1747 @opindex Woverloaded-virtual
1748 @cindex overloaded virtual fn, warning
1749 @cindex warning for overloaded virtual fn
1750 Warn when a function declaration hides virtual functions from a
1751 base class.  For example, in:
1753 @smallexample
1754 struct A @{
1755   virtual void f();
1758 struct B: public A @{
1759   void f(int);
1761 @end smallexample
1763 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1764 like:
1766 @smallexample
1767 B* b;
1768 b->f();
1769 @end smallexample
1771 will fail to compile.
1773 @item -Wno-pmf-conversions @r{(C++ only)}
1774 @opindex Wno-pmf-conversions
1775 Disable the diagnostic for converting a bound pointer to member function
1776 to a plain pointer.
1778 @item -Wsign-promo @r{(C++ only)}
1779 @opindex Wsign-promo
1780 Warn when overload resolution chooses a promotion from unsigned or
1781 enumerated type to a signed type, over a conversion to an unsigned type of
1782 the same size.  Previous versions of G++ would try to preserve
1783 unsignedness, but the standard mandates the current behavior.
1785 @item -Wsynth @r{(C++ only)}
1786 @opindex Wsynth
1787 @cindex warning for synthesized methods
1788 @cindex synthesized methods, warning
1789 Warn when G++'s synthesis behavior does not match that of cfront.  For
1790 instance:
1792 @smallexample
1793 struct A @{
1794   operator int ();
1795   A& operator = (int);
1798 main ()
1800   A a,b;
1801   a = b;
1803 @end smallexample
1805 In this example, G++ will synthesize a default @samp{A& operator =
1806 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1807 @end table
1809 @node Objective-C and Objective-C++ Dialect Options
1810 @section Options Controlling Objective-C and Objective-C++ Dialects
1812 @cindex compiler options, Objective-C and Objective-C++
1813 @cindex Objective-C and Objective-C++ options, command line
1814 @cindex options, Objective-C and Objective-C++
1815 (NOTE: This manual does not describe the Objective-C and Objective-C++
1816 languages themselves.  See @xref{Standards,,Language Standards
1817 Supported by GCC}, for references.)
1819 This section describes the command-line options that are only meaningful
1820 for Objective-C and Objective-C++ programs, but you can also use most of
1821 the language-independent GNU compiler options.
1822 For example, you might compile a file @code{some_class.m} like this:
1824 @smallexample
1825 gcc -g -fgnu-runtime -O -c some_class.m
1826 @end smallexample
1828 @noindent
1829 In this example, @option{-fgnu-runtime} is an option meant only for
1830 Objective-C and Objective-C++ programs; you can use the other options with
1831 any language supported by GCC@.
1833 Note that since Objective-C is an extension of the C language, Objective-C
1834 compilations may also use options specific to the C front-end (e.g., 
1835 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1836 C++-specific options (e.g., @option{-Wabi}).
1838 Here is a list of options that are @emph{only} for compiling Objective-C
1839 and Objective-C++ programs:
1841 @table @gcctabopt
1842 @item -fconstant-string-class=@var{class-name}
1843 @opindex fconstant-string-class
1844 Use @var{class-name} as the name of the class to instantiate for each
1845 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1846 class name is @code{NXConstantString} if the GNU runtime is being used, and
1847 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1848 @option{-fconstant-cfstrings} option, if also present, will override the
1849 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1850 to be laid out as constant CoreFoundation strings.
1852 @item -fgnu-runtime
1853 @opindex fgnu-runtime
1854 Generate object code compatible with the standard GNU Objective-C
1855 runtime.  This is the default for most types of systems.
1857 @item -fnext-runtime
1858 @opindex fnext-runtime
1859 Generate output compatible with the NeXT runtime.  This is the default
1860 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1861 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1862 used.
1864 @item -fno-nil-receivers
1865 @opindex fno-nil-receivers
1866 Assume that all Objective-C message dispatches (e.g.,
1867 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1868 is not @code{nil}.  This allows for more efficient entry points in the runtime
1869 to be used.  Currently, this option is only available in conjunction with
1870 the NeXT runtime on Mac OS X 10.3 and later.
1872 @item -fobjc-exceptions
1873 @opindex fobjc-exceptions
1874 Enable syntactic support for structured exception handling in Objective-C,
1875 similar to what is offered by C++ and Java.  Currently, this option is only
1876 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1878 @smallexample
1879   @@try @{
1880     @dots{}
1881        @@throw expr;
1882     @dots{}
1883   @}
1884   @@catch (AnObjCClass *exc) @{
1885     @dots{}
1886       @@throw expr;
1887     @dots{}
1888       @@throw;
1889     @dots{}
1890   @}
1891   @@catch (AnotherClass *exc) @{
1892     @dots{}
1893   @}
1894   @@catch (id allOthers) @{
1895     @dots{}
1896   @}
1897   @@finally @{
1898     @dots{}
1899       @@throw expr;
1900     @dots{}
1901   @}
1902 @end smallexample
1904 The @code{@@throw} statement may appear anywhere in an Objective-C or
1905 Objective-C++ program; when used inside of a @code{@@catch} block, the
1906 @code{@@throw} may appear without an argument (as shown above), in which case
1907 the object caught by the @code{@@catch} will be rethrown.
1909 Note that only (pointers to) Objective-C objects may be thrown and
1910 caught using this scheme.  When an object is thrown, it will be caught
1911 by the nearest @code{@@catch} clause capable of handling objects of that type,
1912 analogously to how @code{catch} blocks work in C++ and Java.  A
1913 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1914 any and all Objective-C exceptions not caught by previous @code{@@catch}
1915 clauses (if any).
1917 The @code{@@finally} clause, if present, will be executed upon exit from the
1918 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1919 regardless of whether any exceptions are thrown, caught or rethrown
1920 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1921 of the @code{finally} clause in Java.
1923 There are several caveats to using the new exception mechanism:
1925 @itemize @bullet
1926 @item
1927 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1928 idioms provided by the @code{NSException} class, the new
1929 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1930 systems, due to additional functionality needed in the (NeXT) Objective-C
1931 runtime.
1933 @item
1934 As mentioned above, the new exceptions do not support handling
1935 types other than Objective-C objects.   Furthermore, when used from
1936 Objective-C++, the Objective-C exception model does not interoperate with C++
1937 exceptions at this time.  This means you cannot @code{@@throw} an exception
1938 from Objective-C and @code{catch} it in C++, or vice versa
1939 (i.e., @code{throw @dots{} @@catch}).
1940 @end itemize
1942 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1943 blocks for thread-safe execution:
1945 @smallexample
1946   @@synchronized (ObjCClass *guard) @{
1947     @dots{}
1948   @}
1949 @end smallexample
1951 Upon entering the @code{@@synchronized} block, a thread of execution shall
1952 first check whether a lock has been placed on the corresponding @code{guard}
1953 object by another thread.  If it has, the current thread shall wait until
1954 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1955 the current thread will place its own lock on it, execute the code contained in
1956 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1957 making @code{guard} available to other threads).
1959 Unlike Java, Objective-C does not allow for entire methods to be marked
1960 @code{@@synchronized}.  Note that throwing exceptions out of
1961 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1962 to be unlocked properly.
1964 @item -freplace-objc-classes
1965 @opindex freplace-objc-classes
1966 Emit a special marker instructing @command{ld(1)} not to statically link in
1967 the resulting object file, and allow @command{dyld(1)} to load it in at
1968 run time instead.  This is used in conjunction with the Fix-and-Continue
1969 debugging mode, where the object file in question may be recompiled and
1970 dynamically reloaded in the course of program execution, without the need
1971 to restart the program itself.  Currently, Fix-and-Continue functionality
1972 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1973 and later.
1975 @item -fzero-link
1976 @opindex fzero-link
1977 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1978 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1979 compile time) with static class references that get initialized at load time,
1980 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1981 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1982 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1983 for individual class implementations to be modified during program execution.
1985 @item -gen-decls
1986 @opindex gen-decls
1987 Dump interface declarations for all classes seen in the source file to a
1988 file named @file{@var{sourcename}.decl}.
1990 @item -Wno-protocol
1991 @opindex Wno-protocol
1992 If a class is declared to implement a protocol, a warning is issued for
1993 every method in the protocol that is not implemented by the class.  The
1994 default behavior is to issue a warning for every method not explicitly
1995 implemented in the class, even if a method implementation is inherited
1996 from the superclass.  If you use the @option{-Wno-protocol} option, then
1997 methods inherited from the superclass are considered to be implemented,
1998 and no warning is issued for them.
2000 @item -Wselector
2001 @opindex Wselector
2002 Warn if multiple methods of different types for the same selector are
2003 found during compilation.  The check is performed on the list of methods
2004 in the final stage of compilation.  Additionally, a check is performed
2005 for each selector appearing in a @code{@@selector(@dots{})}
2006 expression, and a corresponding method for that selector has been found
2007 during compilation.  Because these checks scan the method table only at
2008 the end of compilation, these warnings are not produced if the final
2009 stage of compilation is not reached, for example because an error is
2010 found during compilation, or because the @option{-fsyntax-only} option is
2011 being used.
2013 @item -Wundeclared-selector
2014 @opindex Wundeclared-selector
2015 Warn if a @code{@@selector(@dots{})} expression referring to an
2016 undeclared selector is found.  A selector is considered undeclared if no
2017 method with that name has been declared before the
2018 @code{@@selector(@dots{})} expression, either explicitly in an
2019 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2020 an @code{@@implementation} section.  This option always performs its
2021 checks as soon as a @code{@@selector(@dots{})} expression is found,
2022 while @option{-Wselector} only performs its checks in the final stage of
2023 compilation.  This also enforces the coding style convention
2024 that methods and selectors must be declared before being used.
2026 @item -print-objc-runtime-info
2027 @opindex print-objc-runtime-info
2028 Generate C header describing the largest structure that is passed by
2029 value, if any.
2031 @end table
2033 @node Language Independent Options
2034 @section Options to Control Diagnostic Messages Formatting
2035 @cindex options to control diagnostics formatting
2036 @cindex diagnostic messages
2037 @cindex message formatting
2039 Traditionally, diagnostic messages have been formatted irrespective of
2040 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2041 below can be used to control the diagnostic messages formatting
2042 algorithm, e.g.@: how many characters per line, how often source location
2043 information should be reported.  Right now, only the C++ front end can
2044 honor these options.  However it is expected, in the near future, that
2045 the remaining front ends would be able to digest them correctly.
2047 @table @gcctabopt
2048 @item -fmessage-length=@var{n}
2049 @opindex fmessage-length
2050 Try to format error messages so that they fit on lines of about @var{n}
2051 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2052 the front ends supported by GCC@.  If @var{n} is zero, then no
2053 line-wrapping will be done; each error message will appear on a single
2054 line.
2056 @opindex fdiagnostics-show-location
2057 @item -fdiagnostics-show-location=once
2058 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2059 reporter to emit @emph{once} source location information; that is, in
2060 case the message is too long to fit on a single physical line and has to
2061 be wrapped, the source location won't be emitted (as prefix) again,
2062 over and over, in subsequent continuation lines.  This is the default
2063 behavior.
2065 @item -fdiagnostics-show-location=every-line
2066 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2067 messages reporter to emit the same source location information (as
2068 prefix) for physical lines that result from the process of breaking
2069 a message which is too long to fit on a single line.
2071 @end table
2073 @node Warning Options
2074 @section Options to Request or Suppress Warnings
2075 @cindex options to control warnings
2076 @cindex warning messages
2077 @cindex messages, warning
2078 @cindex suppressing warnings
2080 Warnings are diagnostic messages that report constructions which
2081 are not inherently erroneous but which are risky or suggest there
2082 may have been an error.
2084 You can request many specific warnings with options beginning @samp{-W},
2085 for example @option{-Wimplicit} to request warnings on implicit
2086 declarations.  Each of these specific warning options also has a
2087 negative form beginning @samp{-Wno-} to turn off warnings;
2088 for example, @option{-Wno-implicit}.  This manual lists only one of the
2089 two forms, whichever is not the default.
2091 The following options control the amount and kinds of warnings produced
2092 by GCC; for further, language-specific options also refer to
2093 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2094 Options}.
2096 @table @gcctabopt
2097 @cindex syntax checking
2098 @item -fsyntax-only
2099 @opindex fsyntax-only
2100 Check the code for syntax errors, but don't do anything beyond that.
2102 @item -pedantic
2103 @opindex pedantic
2104 Issue all the warnings demanded by strict ISO C and ISO C++;
2105 reject all programs that use forbidden extensions, and some other
2106 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2107 version of the ISO C standard specified by any @option{-std} option used.
2109 Valid ISO C and ISO C++ programs should compile properly with or without
2110 this option (though a rare few will require @option{-ansi} or a
2111 @option{-std} option specifying the required version of ISO C)@.  However,
2112 without this option, certain GNU extensions and traditional C and C++
2113 features are supported as well.  With this option, they are rejected.
2115 @option{-pedantic} does not cause warning messages for use of the
2116 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2117 warnings are also disabled in the expression that follows
2118 @code{__extension__}.  However, only system header files should use
2119 these escape routes; application programs should avoid them.
2120 @xref{Alternate Keywords}.
2122 Some users try to use @option{-pedantic} to check programs for strict ISO
2123 C conformance.  They soon find that it does not do quite what they want:
2124 it finds some non-ISO practices, but not all---only those for which
2125 ISO C @emph{requires} a diagnostic, and some others for which
2126 diagnostics have been added.
2128 A feature to report any failure to conform to ISO C might be useful in
2129 some instances, but would require considerable additional work and would
2130 be quite different from @option{-pedantic}.  We don't have plans to
2131 support such a feature in the near future.
2133 Where the standard specified with @option{-std} represents a GNU
2134 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2135 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2136 extended dialect is based.  Warnings from @option{-pedantic} are given
2137 where they are required by the base standard.  (It would not make sense
2138 for such warnings to be given only for features not in the specified GNU
2139 C dialect, since by definition the GNU dialects of C include all
2140 features the compiler supports with the given option, and there would be
2141 nothing to warn about.)
2143 @item -pedantic-errors
2144 @opindex pedantic-errors
2145 Like @option{-pedantic}, except that errors are produced rather than
2146 warnings.
2148 @item -w
2149 @opindex w
2150 Inhibit all warning messages.
2152 @item -Wno-import
2153 @opindex Wno-import
2154 Inhibit warning messages about the use of @samp{#import}.
2156 @item -Wchar-subscripts
2157 @opindex Wchar-subscripts
2158 Warn if an array subscript has type @code{char}.  This is a common cause
2159 of error, as programmers often forget that this type is signed on some
2160 machines.
2162 @item -Wcomment
2163 @opindex Wcomment
2164 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2165 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2167 @item -Wfatal-errors
2168 @opindex Wfatal-errors
2169 This option causes the compiler to abort compilation on the first error
2170 occurred rather than trying to keep going and printing further error
2171 messages.
2173 @item -Wformat
2174 @opindex Wformat
2175 @opindex ffreestanding
2176 @opindex fno-builtin
2177 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2178 the arguments supplied have types appropriate to the format string
2179 specified, and that the conversions specified in the format string make
2180 sense.  This includes standard functions, and others specified by format
2181 attributes (@pxref{Function Attributes}), in the @code{printf},
2182 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2183 not in the C standard) families (or other target-specific families).
2184 Which functions are checked without format attributes having been
2185 specified depends on the standard version selected, and such checks of
2186 functions without the attribute specified are disabled by
2187 @option{-ffreestanding} or @option{-fno-builtin}.
2189 The formats are checked against the format features supported by GNU
2190 libc version 2.2.  These include all ISO C90 and C99 features, as well
2191 as features from the Single Unix Specification and some BSD and GNU
2192 extensions.  Other library implementations may not support all these
2193 features; GCC does not support warning about features that go beyond a
2194 particular library's limitations.  However, if @option{-pedantic} is used
2195 with @option{-Wformat}, warnings will be given about format features not
2196 in the selected standard version (but not for @code{strfmon} formats,
2197 since those are not in any version of the C standard).  @xref{C Dialect
2198 Options,,Options Controlling C Dialect}.
2200 Since @option{-Wformat} also checks for null format arguments for
2201 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2203 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2204 aspects of format checking, the options @option{-Wformat-y2k},
2205 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2206 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2207 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2209 @item -Wformat-y2k
2210 @opindex Wformat-y2k
2211 If @option{-Wformat} is specified, also warn about @code{strftime}
2212 formats which may yield only a two-digit year.
2214 @item -Wno-format-extra-args
2215 @opindex Wno-format-extra-args
2216 If @option{-Wformat} is specified, do not warn about excess arguments to a
2217 @code{printf} or @code{scanf} format function.  The C standard specifies
2218 that such arguments are ignored.
2220 Where the unused arguments lie between used arguments that are
2221 specified with @samp{$} operand number specifications, normally
2222 warnings are still given, since the implementation could not know what
2223 type to pass to @code{va_arg} to skip the unused arguments.  However,
2224 in the case of @code{scanf} formats, this option will suppress the
2225 warning if the unused arguments are all pointers, since the Single
2226 Unix Specification says that such unused arguments are allowed.
2228 @item -Wno-format-zero-length
2229 @opindex Wno-format-zero-length
2230 If @option{-Wformat} is specified, do not warn about zero-length formats.
2231 The C standard specifies that zero-length formats are allowed.
2233 @item -Wformat-nonliteral
2234 @opindex Wformat-nonliteral
2235 If @option{-Wformat} is specified, also warn if the format string is not a
2236 string literal and so cannot be checked, unless the format function
2237 takes its format arguments as a @code{va_list}.
2239 @item -Wformat-security
2240 @opindex Wformat-security
2241 If @option{-Wformat} is specified, also warn about uses of format
2242 functions that represent possible security problems.  At present, this
2243 warns about calls to @code{printf} and @code{scanf} functions where the
2244 format string is not a string literal and there are no format arguments,
2245 as in @code{printf (foo);}.  This may be a security hole if the format
2246 string came from untrusted input and contains @samp{%n}.  (This is
2247 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2248 in future warnings may be added to @option{-Wformat-security} that are not
2249 included in @option{-Wformat-nonliteral}.)
2251 @item -Wformat=2
2252 @opindex Wformat=2
2253 Enable @option{-Wformat} plus format checks not included in
2254 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2255 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2257 @item -Wnonnull
2258 @opindex Wnonnull
2259 Warn about passing a null pointer for arguments marked as
2260 requiring a non-null value by the @code{nonnull} function attribute.
2262 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2263 can be disabled with the @option{-Wno-nonnull} option.
2265 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2266 @opindex Winit-self
2267 Warn about uninitialized variables which are initialized with themselves.
2268 Note this option can only be used with the @option{-Wuninitialized} option,
2269 which in turn only works with @option{-O1} and above.
2271 For example, GCC will warn about @code{i} being uninitialized in the
2272 following snippet only when @option{-Winit-self} has been specified:
2273 @smallexample
2274 @group
2275 int f()
2277   int i = i;
2278   return i;
2280 @end group
2281 @end smallexample
2283 @item -Wimplicit-int
2284 @opindex Wimplicit-int
2285 Warn when a declaration does not specify a type.
2287 @item -Wimplicit-function-declaration
2288 @itemx -Werror-implicit-function-declaration
2289 @opindex Wimplicit-function-declaration
2290 @opindex Werror-implicit-function-declaration
2291 Give a warning (or error) whenever a function is used before being
2292 declared.  The form @option{-Wno-error-implicit-function-declaration}
2293 is not supported.
2295 @item -Wimplicit
2296 @opindex Wimplicit
2297 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2299 @item -Wmain
2300 @opindex Wmain
2301 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2302 function with external linkage, returning int, taking either zero
2303 arguments, two, or three arguments of appropriate types.
2305 @item -Wmissing-braces
2306 @opindex Wmissing-braces
2307 Warn if an aggregate or union initializer is not fully bracketed.  In
2308 the following example, the initializer for @samp{a} is not fully
2309 bracketed, but that for @samp{b} is fully bracketed.
2311 @smallexample
2312 int a[2][2] = @{ 0, 1, 2, 3 @};
2313 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2314 @end smallexample
2316 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2317 @opindex Wmissing-include-dirs
2318 Warn if a user-supplied include directory does not exist.
2320 @item -Wparentheses
2321 @opindex Wparentheses
2322 Warn if parentheses are omitted in certain contexts, such
2323 as when there is an assignment in a context where a truth value
2324 is expected, or when operators are nested whose precedence people
2325 often get confused about.  Only the warning for an assignment used as
2326 a truth value is supported when compiling C++; the other warnings are
2327 only supported when compiling C@.
2329 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2330 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2331 interpretation from that of ordinary mathematical notation.
2333 Also warn about constructions where there may be confusion to which
2334 @code{if} statement an @code{else} branch belongs.  Here is an example of
2335 such a case:
2337 @smallexample
2338 @group
2340   if (a)
2341     if (b)
2342       foo ();
2343   else
2344     bar ();
2346 @end group
2347 @end smallexample
2349 In C, every @code{else} branch belongs to the innermost possible @code{if}
2350 statement, which in this example is @code{if (b)}.  This is often not
2351 what the programmer expected, as illustrated in the above example by
2352 indentation the programmer chose.  When there is the potential for this
2353 confusion, GCC will issue a warning when this flag is specified.
2354 To eliminate the warning, add explicit braces around the innermost
2355 @code{if} statement so there is no way the @code{else} could belong to
2356 the enclosing @code{if}.  The resulting code would look like this:
2358 @smallexample
2359 @group
2361   if (a)
2362     @{
2363       if (b)
2364         foo ();
2365       else
2366         bar ();
2367     @}
2369 @end group
2370 @end smallexample
2372 @item -Wsequence-point
2373 @opindex Wsequence-point
2374 Warn about code that may have undefined semantics because of violations
2375 of sequence point rules in the C standard.
2377 The C standard defines the order in which expressions in a C program are
2378 evaluated in terms of @dfn{sequence points}, which represent a partial
2379 ordering between the execution of parts of the program: those executed
2380 before the sequence point, and those executed after it.  These occur
2381 after the evaluation of a full expression (one which is not part of a
2382 larger expression), after the evaluation of the first operand of a
2383 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2384 function is called (but after the evaluation of its arguments and the
2385 expression denoting the called function), and in certain other places.
2386 Other than as expressed by the sequence point rules, the order of
2387 evaluation of subexpressions of an expression is not specified.  All
2388 these rules describe only a partial order rather than a total order,
2389 since, for example, if two functions are called within one expression
2390 with no sequence point between them, the order in which the functions
2391 are called is not specified.  However, the standards committee have
2392 ruled that function calls do not overlap.
2394 It is not specified when between sequence points modifications to the
2395 values of objects take effect.  Programs whose behavior depends on this
2396 have undefined behavior; the C standard specifies that ``Between the
2397 previous and next sequence point an object shall have its stored value
2398 modified at most once by the evaluation of an expression.  Furthermore,
2399 the prior value shall be read only to determine the value to be
2400 stored.''.  If a program breaks these rules, the results on any
2401 particular implementation are entirely unpredictable.
2403 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2404 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2405 diagnosed by this option, and it may give an occasional false positive
2406 result, but in general it has been found fairly effective at detecting
2407 this sort of problem in programs.
2409 The present implementation of this option only works for C programs.  A
2410 future implementation may also work for C++ programs.
2412 The C standard is worded confusingly, therefore there is some debate
2413 over the precise meaning of the sequence point rules in subtle cases.
2414 Links to discussions of the problem, including proposed formal
2415 definitions, may be found on the GCC readings page, at
2416 @w{@uref{http://gcc.gnu.org/readings.html}}.
2418 @item -Wreturn-type
2419 @opindex Wreturn-type
2420 Warn whenever a function is defined with a return-type that defaults to
2421 @code{int}.  Also warn about any @code{return} statement with no
2422 return-value in a function whose return-type is not @code{void}.
2424 For C, also warn if the return type of a function has a type qualifier
2425 such as @code{const}.  Such a type qualifier has no effect, since the
2426 value returned by a function is not an lvalue.  ISO C prohibits
2427 qualified @code{void} return types on function definitions, so such
2428 return types always receive a warning even without this option.
2430 For C++, a function without return type always produces a diagnostic
2431 message, even when @option{-Wno-return-type} is specified.  The only
2432 exceptions are @samp{main} and functions defined in system headers.
2434 @item -Wswitch
2435 @opindex Wswitch
2436 Warn whenever a @code{switch} statement has an index of enumerated type
2437 and lacks a @code{case} for one or more of the named codes of that
2438 enumeration.  (The presence of a @code{default} label prevents this
2439 warning.)  @code{case} labels outside the enumeration range also
2440 provoke warnings when this option is used.
2442 @item -Wswitch-default
2443 @opindex Wswitch-switch
2444 Warn whenever a @code{switch} statement does not have a @code{default}
2445 case.
2447 @item -Wswitch-enum
2448 @opindex Wswitch-enum
2449 Warn whenever a @code{switch} statement has an index of enumerated type
2450 and lacks a @code{case} for one or more of the named codes of that
2451 enumeration.  @code{case} labels outside the enumeration range also
2452 provoke warnings when this option is used.
2454 @item -Wtrigraphs
2455 @opindex Wtrigraphs
2456 Warn if any trigraphs are encountered that might change the meaning of
2457 the program (trigraphs within comments are not warned about).
2459 @item -Wunused-function
2460 @opindex Wunused-function
2461 Warn whenever a static function is declared but not defined or a
2462 non\-inline static function is unused.
2464 @item -Wunused-label
2465 @opindex Wunused-label
2466 Warn whenever a label is declared but not used.
2468 To suppress this warning use the @samp{unused} attribute
2469 (@pxref{Variable Attributes}).
2471 @item -Wunused-parameter
2472 @opindex Wunused-parameter
2473 Warn whenever a function parameter is unused aside from its declaration.
2475 To suppress this warning use the @samp{unused} attribute
2476 (@pxref{Variable Attributes}).
2478 @item -Wunused-variable
2479 @opindex Wunused-variable
2480 Warn whenever a local variable or non-constant static variable is unused
2481 aside from its declaration
2483 To suppress this warning use the @samp{unused} attribute
2484 (@pxref{Variable Attributes}).
2486 @item -Wunused-value
2487 @opindex Wunused-value
2488 Warn whenever a statement computes a result that is explicitly not used.
2490 To suppress this warning cast the expression to @samp{void}.
2492 @item -Wunused
2493 @opindex Wunused
2494 All the above @option{-Wunused} options combined.
2496 In order to get a warning about an unused function parameter, you must
2497 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2498 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2500 @item -Wuninitialized
2501 @opindex Wuninitialized
2502 Warn if an automatic variable is used without first being initialized or
2503 if a variable may be clobbered by a @code{setjmp} call.
2505 These warnings are possible only in optimizing compilation,
2506 because they require data flow information that is computed only
2507 when optimizing.  If you don't specify @option{-O}, you simply won't
2508 get these warnings.
2510 If you want to warn about code which uses the uninitialized value of the
2511 variable in its own initializer, use the @option{-Winit-self} option.
2513 These warnings occur only for variables that are candidates for
2514 register allocation.  Therefore, they do not occur for a variable that
2515 is declared @code{volatile}, or whose address is taken, or whose size
2516 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2517 structures, unions or arrays, even when they are in registers.
2519 Note that there may be no warning about a variable that is used only
2520 to compute a value that itself is never used, because such
2521 computations may be deleted by data flow analysis before the warnings
2522 are printed.
2524 These warnings are made optional because GCC is not smart
2525 enough to see all the reasons why the code might be correct
2526 despite appearing to have an error.  Here is one example of how
2527 this can happen:
2529 @smallexample
2530 @group
2532   int x;
2533   switch (y)
2534     @{
2535     case 1: x = 1;
2536       break;
2537     case 2: x = 4;
2538       break;
2539     case 3: x = 5;
2540     @}
2541   foo (x);
2543 @end group
2544 @end smallexample
2546 @noindent
2547 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2548 always initialized, but GCC doesn't know this.  Here is
2549 another common case:
2551 @smallexample
2553   int save_y;
2554   if (change_y) save_y = y, y = new_y;
2555   @dots{}
2556   if (change_y) y = save_y;
2558 @end smallexample
2560 @noindent
2561 This has no bug because @code{save_y} is used only if it is set.
2563 @cindex @code{longjmp} warnings
2564 This option also warns when a non-volatile automatic variable might be
2565 changed by a call to @code{longjmp}.  These warnings as well are possible
2566 only in optimizing compilation.
2568 The compiler sees only the calls to @code{setjmp}.  It cannot know
2569 where @code{longjmp} will be called; in fact, a signal handler could
2570 call it at any point in the code.  As a result, you may get a warning
2571 even when there is in fact no problem because @code{longjmp} cannot
2572 in fact be called at the place which would cause a problem.
2574 Some spurious warnings can be avoided if you declare all the functions
2575 you use that never return as @code{noreturn}.  @xref{Function
2576 Attributes}.
2578 @item -Wunknown-pragmas
2579 @opindex Wunknown-pragmas
2580 @cindex warning for unknown pragmas
2581 @cindex unknown pragmas, warning
2582 @cindex pragmas, warning of unknown
2583 Warn when a #pragma directive is encountered which is not understood by
2584 GCC@.  If this command line option is used, warnings will even be issued
2585 for unknown pragmas in system header files.  This is not the case if
2586 the warnings were only enabled by the @option{-Wall} command line option.
2588 @item -Wstrict-aliasing
2589 @opindex Wstrict-aliasing
2590 This option is only active when @option{-fstrict-aliasing} is active.
2591 It warns about code which might break the strict aliasing rules that the
2592 compiler is using for optimization. The warning does not catch all
2593 cases, but does attempt to catch the more common pitfalls. It is
2594 included in @option{-Wall}.
2596 @item -Wstrict-aliasing=2
2597 @opindex Wstrict-aliasing=2
2598 This option is only active when @option{-fstrict-aliasing} is active.
2599 It warns about all code which might break the strict aliasing rules that the
2600 compiler is using for optimization.  This warning catches all cases, but
2601 it will also give a warning for some ambiguous cases that are safe.
2603 @item -Wall
2604 @opindex Wall
2605 All of the above @samp{-W} options combined.  This enables all the
2606 warnings about constructions that some users consider questionable, and
2607 that are easy to avoid (or modify to prevent the warning), even in
2608 conjunction with macros.  This also enables some language-specific
2609 warnings described in @ref{C++ Dialect Options} and
2610 @ref{Objective-C and Objective-C++ Dialect Options}.
2611 @end table
2613 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2614 Some of them warn about constructions that users generally do not
2615 consider questionable, but which occasionally you might wish to check
2616 for; others warn about constructions that are necessary or hard to avoid
2617 in some cases, and there is no simple way to modify the code to suppress
2618 the warning.
2620 @table @gcctabopt
2621 @item -Wextra
2622 @opindex W
2623 @opindex Wextra
2624 (This option used to be called @option{-W}.  The older name is still
2625 supported, but the newer name is more descriptive.)  Print extra warning
2626 messages for these events:
2628 @itemize @bullet
2629 @item
2630 A function can return either with or without a value.  (Falling
2631 off the end of the function body is considered returning without
2632 a value.)  For example, this function would evoke such a
2633 warning:
2635 @smallexample
2636 @group
2637 foo (a)
2639   if (a > 0)
2640     return a;
2642 @end group
2643 @end smallexample
2645 @item
2646 An expression-statement or the left-hand side of a comma expression
2647 contains no side effects.
2648 To suppress the warning, cast the unused expression to void.
2649 For example, an expression such as @samp{x[i,j]} will cause a warning,
2650 but @samp{x[(void)i,j]} will not.
2652 @item
2653 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2655 @item
2656 Storage-class specifiers like @code{static} are not the first things in
2657 a declaration.  According to the C Standard, this usage is obsolescent.
2659 @item
2660 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2661 arguments.
2663 @item
2664 A comparison between signed and unsigned values could produce an
2665 incorrect result when the signed value is converted to unsigned.
2666 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2668 @item
2669 An aggregate has an initializer which does not initialize all members.
2670 This warning can be independently controlled by
2671 @option{-Wmissing-field-initializers}.
2673 @item
2674 A function parameter is declared without a type specifier in K&R-style
2675 functions:
2677 @smallexample
2678 void foo(bar) @{ @}
2679 @end smallexample
2681 @item
2682 An empty body occurs in an @samp{if} or @samp{else} statement.
2684 @item
2685 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2686 @samp{>}, or @samp{>=}.
2688 @item
2689 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2691 @item
2692 Any of several floating-point events that often indicate errors, such as
2693 overflow, underflow, loss of precision, etc.
2695 @item @r{(C++ only)}
2696 An enumerator and a non-enumerator both appear in a conditional expression.
2698 @item @r{(C++ only)}
2699 A non-static reference or non-static @samp{const} member appears in a
2700 class without constructors.
2702 @item @r{(C++ only)}
2703 Ambiguous virtual bases.
2705 @item @r{(C++ only)}
2706 Subscripting an array which has been declared @samp{register}.
2708 @item @r{(C++ only)}
2709 Taking the address of a variable which has been declared @samp{register}.
2711 @item @r{(C++ only)}
2712 A base class is not initialized in a derived class' copy constructor.
2713 @end itemize
2715 @item -Wno-div-by-zero
2716 @opindex Wno-div-by-zero
2717 @opindex Wdiv-by-zero
2718 Do not warn about compile-time integer division by zero.  Floating point
2719 division by zero is not warned about, as it can be a legitimate way of
2720 obtaining infinities and NaNs.
2722 @item -Wsystem-headers
2723 @opindex Wsystem-headers
2724 @cindex warnings from system headers
2725 @cindex system headers, warnings from
2726 Print warning messages for constructs found in system header files.
2727 Warnings from system headers are normally suppressed, on the assumption
2728 that they usually do not indicate real problems and would only make the
2729 compiler output harder to read.  Using this command line option tells
2730 GCC to emit warnings from system headers as if they occurred in user
2731 code.  However, note that using @option{-Wall} in conjunction with this
2732 option will @emph{not} warn about unknown pragmas in system
2733 headers---for that, @option{-Wunknown-pragmas} must also be used.
2735 @item -Wfloat-equal
2736 @opindex Wfloat-equal
2737 Warn if floating point values are used in equality comparisons.
2739 The idea behind this is that sometimes it is convenient (for the
2740 programmer) to consider floating-point values as approximations to
2741 infinitely precise real numbers.  If you are doing this, then you need
2742 to compute (by analyzing the code, or in some other way) the maximum or
2743 likely maximum error that the computation introduces, and allow for it
2744 when performing comparisons (and when producing output, but that's a
2745 different problem).  In particular, instead of testing for equality, you
2746 would check to see whether the two values have ranges that overlap; and
2747 this is done with the relational operators, so equality comparisons are
2748 probably mistaken.
2750 @item -Wtraditional @r{(C only)}
2751 @opindex Wtraditional
2752 Warn about certain constructs that behave differently in traditional and
2753 ISO C@.  Also warn about ISO C constructs that have no traditional C
2754 equivalent, and/or problematic constructs which should be avoided.
2756 @itemize @bullet
2757 @item
2758 Macro parameters that appear within string literals in the macro body.
2759 In traditional C macro replacement takes place within string literals,
2760 but does not in ISO C@.
2762 @item
2763 In traditional C, some preprocessor directives did not exist.
2764 Traditional preprocessors would only consider a line to be a directive
2765 if the @samp{#} appeared in column 1 on the line.  Therefore
2766 @option{-Wtraditional} warns about directives that traditional C
2767 understands but would ignore because the @samp{#} does not appear as the
2768 first character on the line.  It also suggests you hide directives like
2769 @samp{#pragma} not understood by traditional C by indenting them.  Some
2770 traditional implementations would not recognize @samp{#elif}, so it
2771 suggests avoiding it altogether.
2773 @item
2774 A function-like macro that appears without arguments.
2776 @item
2777 The unary plus operator.
2779 @item
2780 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2781 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2782 constants.)  Note, these suffixes appear in macros defined in the system
2783 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2784 Use of these macros in user code might normally lead to spurious
2785 warnings, however GCC's integrated preprocessor has enough context to
2786 avoid warning in these cases.
2788 @item
2789 A function declared external in one block and then used after the end of
2790 the block.
2792 @item
2793 A @code{switch} statement has an operand of type @code{long}.
2795 @item
2796 A non-@code{static} function declaration follows a @code{static} one.
2797 This construct is not accepted by some traditional C compilers.
2799 @item
2800 The ISO type of an integer constant has a different width or
2801 signedness from its traditional type.  This warning is only issued if
2802 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2803 typically represent bit patterns, are not warned about.
2805 @item
2806 Usage of ISO string concatenation is detected.
2808 @item
2809 Initialization of automatic aggregates.
2811 @item
2812 Identifier conflicts with labels.  Traditional C lacks a separate
2813 namespace for labels.
2815 @item
2816 Initialization of unions.  If the initializer is zero, the warning is
2817 omitted.  This is done under the assumption that the zero initializer in
2818 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2819 initializer warnings and relies on default initialization to zero in the
2820 traditional C case.
2822 @item
2823 Conversions by prototypes between fixed/floating point values and vice
2824 versa.  The absence of these prototypes when compiling with traditional
2825 C would cause serious problems.  This is a subset of the possible
2826 conversion warnings, for the full set use @option{-Wconversion}.
2828 @item
2829 Use of ISO C style function definitions.  This warning intentionally is
2830 @emph{not} issued for prototype declarations or variadic functions
2831 because these ISO C features will appear in your code when using
2832 libiberty's traditional C compatibility macros, @code{PARAMS} and
2833 @code{VPARAMS}.  This warning is also bypassed for nested functions
2834 because that feature is already a GCC extension and thus not relevant to
2835 traditional C compatibility.
2836 @end itemize
2838 @item -Wdeclaration-after-statement @r{(C only)}
2839 @opindex Wdeclaration-after-statement
2840 Warn when a declaration is found after a statement in a block.  This
2841 construct, known from C++, was introduced with ISO C99 and is by default
2842 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2843 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2845 @item -Wundef
2846 @opindex Wundef
2847 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2849 @item -Wendif-labels
2850 @opindex Wendif-labels
2851 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2853 @item -Wshadow
2854 @opindex Wshadow
2855 Warn whenever a local variable shadows another local variable, parameter or
2856 global variable or whenever a built-in function is shadowed.
2858 @item -Wlarger-than-@var{len}
2859 @opindex Wlarger-than
2860 Warn whenever an object of larger than @var{len} bytes is defined.
2862 @item -Wpointer-arith
2863 @opindex Wpointer-arith
2864 Warn about anything that depends on the ``size of'' a function type or
2865 of @code{void}.  GNU C assigns these types a size of 1, for
2866 convenience in calculations with @code{void *} pointers and pointers
2867 to functions.
2869 @item -Wbad-function-cast @r{(C only)}
2870 @opindex Wbad-function-cast
2871 Warn whenever a function call is cast to a non-matching type.
2872 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2874 @item -Wcast-qual
2875 @opindex Wcast-qual
2876 Warn whenever a pointer is cast so as to remove a type qualifier from
2877 the target type.  For example, warn if a @code{const char *} is cast
2878 to an ordinary @code{char *}.
2880 @item -Wcast-align
2881 @opindex Wcast-align
2882 Warn whenever a pointer is cast such that the required alignment of the
2883 target is increased.  For example, warn if a @code{char *} is cast to
2884 an @code{int *} on machines where integers can only be accessed at
2885 two- or four-byte boundaries.
2887 @item -Wwrite-strings
2888 @opindex Wwrite-strings
2889 When compiling C, give string constants the type @code{const
2890 char[@var{length}]} so that
2891 copying the address of one into a non-@code{const} @code{char *}
2892 pointer will get a warning; when compiling C++, warn about the
2893 deprecated conversion from string constants to @code{char *}.
2894 These warnings will help you find at
2895 compile time code that can try to write into a string constant, but
2896 only if you have been very careful about using @code{const} in
2897 declarations and prototypes.  Otherwise, it will just be a nuisance;
2898 this is why we did not make @option{-Wall} request these warnings.
2900 @item -Wconversion
2901 @opindex Wconversion
2902 Warn if a prototype causes a type conversion that is different from what
2903 would happen to the same argument in the absence of a prototype.  This
2904 includes conversions of fixed point to floating and vice versa, and
2905 conversions changing the width or signedness of a fixed point argument
2906 except when the same as the default promotion.
2908 Also, warn if a negative integer constant expression is implicitly
2909 converted to an unsigned type.  For example, warn about the assignment
2910 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2911 casts like @code{(unsigned) -1}.
2913 @item -Wsign-compare
2914 @opindex Wsign-compare
2915 @cindex warning for comparison of signed and unsigned values
2916 @cindex comparison of signed and unsigned values, warning
2917 @cindex signed and unsigned values, comparison warning
2918 Warn when a comparison between signed and unsigned values could produce
2919 an incorrect result when the signed value is converted to unsigned.
2920 This warning is also enabled by @option{-Wextra}; to get the other warnings
2921 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2923 @item -Waggregate-return
2924 @opindex Waggregate-return
2925 Warn if any functions that return structures or unions are defined or
2926 called.  (In languages where you can return an array, this also elicits
2927 a warning.)
2929 @item -Wstrict-prototypes @r{(C only)}
2930 @opindex Wstrict-prototypes
2931 Warn if a function is declared or defined without specifying the
2932 argument types.  (An old-style function definition is permitted without
2933 a warning if preceded by a declaration which specifies the argument
2934 types.)
2936 @item -Wold-style-definition @r{(C only)}
2937 @opindex Wold-style-definition
2938 Warn if an old-style function definition is used.  A warning is given
2939 even if there is a previous prototype.
2941 @item -Wmissing-prototypes @r{(C only)}
2942 @opindex Wmissing-prototypes
2943 Warn if a global function is defined without a previous prototype
2944 declaration.  This warning is issued even if the definition itself
2945 provides a prototype.  The aim is to detect global functions that fail
2946 to be declared in header files.
2948 @item -Wmissing-declarations @r{(C only)}
2949 @opindex Wmissing-declarations
2950 Warn if a global function is defined without a previous declaration.
2951 Do so even if the definition itself provides a prototype.
2952 Use this option to detect global functions that are not declared in
2953 header files.
2955 @item -Wmissing-field-initializers
2956 @opindex Wmissing-field-initializers
2957 @opindex W
2958 @opindex Wextra
2959 Warn if a structure's initializer has some fields missing.  For
2960 example, the following code would cause such a warning, because
2961 @code{x.h} is implicitly zero:
2963 @smallexample
2964 struct s @{ int f, g, h; @};
2965 struct s x = @{ 3, 4 @};
2966 @end smallexample
2968 This option does not warn about designated initializers, so the following
2969 modification would not trigger a warning:
2971 @smallexample
2972 struct s @{ int f, g, h; @};
2973 struct s x = @{ .f = 3, .g = 4 @};
2974 @end smallexample
2976 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2977 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2979 @item -Wmissing-noreturn
2980 @opindex Wmissing-noreturn
2981 Warn about functions which might be candidates for attribute @code{noreturn}.
2982 Note these are only possible candidates, not absolute ones.  Care should
2983 be taken to manually verify functions actually do not ever return before
2984 adding the @code{noreturn} attribute, otherwise subtle code generation
2985 bugs could be introduced.  You will not get a warning for @code{main} in
2986 hosted C environments.
2988 @item -Wmissing-format-attribute
2989 @opindex Wmissing-format-attribute
2990 @opindex Wformat
2991 If @option{-Wformat} is enabled, also warn about functions which might be
2992 candidates for @code{format} attributes.  Note these are only possible
2993 candidates, not absolute ones.  GCC will guess that @code{format}
2994 attributes might be appropriate for any function that calls a function
2995 like @code{vprintf} or @code{vscanf}, but this might not always be the
2996 case, and some functions for which @code{format} attributes are
2997 appropriate may not be detected.  This option has no effect unless
2998 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3000 @item -Wno-multichar
3001 @opindex Wno-multichar
3002 @opindex Wmultichar
3003 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3004 Usually they indicate a typo in the user's code, as they have
3005 implementation-defined values, and should not be used in portable code.
3007 @item -Wno-deprecated-declarations
3008 @opindex Wno-deprecated-declarations
3009 Do not warn about uses of functions, variables, and types marked as
3010 deprecated by using the @code{deprecated} attribute.
3011 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3012 @pxref{Type Attributes}.)
3014 @item -Wpacked
3015 @opindex Wpacked
3016 Warn if a structure is given the packed attribute, but the packed
3017 attribute has no effect on the layout or size of the structure.
3018 Such structures may be mis-aligned for little benefit.  For
3019 instance, in this code, the variable @code{f.x} in @code{struct bar}
3020 will be misaligned even though @code{struct bar} does not itself
3021 have the packed attribute:
3023 @smallexample
3024 @group
3025 struct foo @{
3026   int x;
3027   char a, b, c, d;
3028 @} __attribute__((packed));
3029 struct bar @{
3030   char z;
3031   struct foo f;
3033 @end group
3034 @end smallexample
3036 @item -Wpadded
3037 @opindex Wpadded
3038 Warn if padding is included in a structure, either to align an element
3039 of the structure or to align the whole structure.  Sometimes when this
3040 happens it is possible to rearrange the fields of the structure to
3041 reduce the padding and so make the structure smaller.
3043 @item -Wredundant-decls
3044 @opindex Wredundant-decls
3045 Warn if anything is declared more than once in the same scope, even in
3046 cases where multiple declaration is valid and changes nothing.
3048 @item -Wnested-externs @r{(C only)}
3049 @opindex Wnested-externs
3050 Warn if an @code{extern} declaration is encountered within a function.
3052 @item -Wunreachable-code
3053 @opindex Wunreachable-code
3054 Warn if the compiler detects that code will never be executed.
3056 This option is intended to warn when the compiler detects that at
3057 least a whole line of source code will never be executed, because
3058 some condition is never satisfied or because it is after a
3059 procedure that never returns.
3061 It is possible for this option to produce a warning even though there
3062 are circumstances under which part of the affected line can be executed,
3063 so care should be taken when removing apparently-unreachable code.
3065 For instance, when a function is inlined, a warning may mean that the
3066 line is unreachable in only one inlined copy of the function.
3068 This option is not made part of @option{-Wall} because in a debugging
3069 version of a program there is often substantial code which checks
3070 correct functioning of the program and is, hopefully, unreachable
3071 because the program does work.  Another common use of unreachable
3072 code is to provide behavior which is selectable at compile-time.
3074 @item -Winline
3075 @opindex Winline
3076 Warn if a function can not be inlined and it was declared as inline.
3077 Even with this option, the compiler will not warn about failures to
3078 inline functions declared in system headers.
3080 The compiler uses a variety of heuristics to determine whether or not
3081 to inline a function.  For example, the compiler takes into account
3082 the size of the function being inlined and the the amount of inlining
3083 that has already been done in the current function.  Therefore,
3084 seemingly insignificant changes in the source program can cause the
3085 warnings produced by @option{-Winline} to appear or disappear.
3087 @item -Wno-invalid-offsetof @r{(C++ only)}
3088 @opindex Wno-invalid-offsetof
3089 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3090 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3091 to a non-POD type is undefined.  In existing C++ implementations,
3092 however, @samp{offsetof} typically gives meaningful results even when
3093 applied to certain kinds of non-POD types. (Such as a simple
3094 @samp{struct} that fails to be a POD type only by virtue of having a
3095 constructor.)  This flag is for users who are aware that they are
3096 writing nonportable code and who have deliberately chosen to ignore the
3097 warning about it.
3099 The restrictions on @samp{offsetof} may be relaxed in a future version
3100 of the C++ standard.
3102 @item -Winvalid-pch
3103 @opindex Winvalid-pch
3104 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3105 the search path but can't be used.
3107 @item -Wlong-long
3108 @opindex Wlong-long
3109 @opindex Wno-long-long
3110 Warn if @samp{long long} type is used.  This is default.  To inhibit
3111 the warning messages, use @option{-Wno-long-long}.  Flags
3112 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3113 only when @option{-pedantic} flag is used.
3115 @item -Wvariadic-macros
3116 @opindex Wvariadic-macros
3117 @opindex Wno-variadic-macros
3118 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3119 alternate syntax when in pedantic ISO C99 mode.  This is default.
3120 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3122 @item -Wdisabled-optimization
3123 @opindex Wdisabled-optimization
3124 Warn if a requested optimization pass is disabled.  This warning does
3125 not generally indicate that there is anything wrong with your code; it
3126 merely indicates that GCC's optimizers were unable to handle the code
3127 effectively.  Often, the problem is that your code is too big or too
3128 complex; GCC will refuse to optimize programs when the optimization
3129 itself is likely to take inordinate amounts of time.
3131 @item -Werror
3132 @opindex Werror
3133 Make all warnings into errors.
3134 @end table
3136 @node Debugging Options
3137 @section Options for Debugging Your Program or GCC
3138 @cindex options, debugging
3139 @cindex debugging information options
3141 GCC has various special options that are used for debugging
3142 either your program or GCC:
3144 @table @gcctabopt
3145 @item -g
3146 @opindex g
3147 Produce debugging information in the operating system's native format
3148 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3149 information.
3151 On most systems that use stabs format, @option{-g} enables use of extra
3152 debugging information that only GDB can use; this extra information
3153 makes debugging work better in GDB but will probably make other debuggers
3154 crash or
3155 refuse to read the program.  If you want to control for certain whether
3156 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3157 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3159 GCC allows you to use @option{-g} with
3160 @option{-O}.  The shortcuts taken by optimized code may occasionally
3161 produce surprising results: some variables you declared may not exist
3162 at all; flow of control may briefly move where you did not expect it;
3163 some statements may not be executed because they compute constant
3164 results or their values were already at hand; some statements may
3165 execute in different places because they were moved out of loops.
3167 Nevertheless it proves possible to debug optimized output.  This makes
3168 it reasonable to use the optimizer for programs that might have bugs.
3170 The following options are useful when GCC is generated with the
3171 capability for more than one debugging format.
3173 @item -ggdb
3174 @opindex ggdb
3175 Produce debugging information for use by GDB@.  This means to use the
3176 most expressive format available (DWARF 2, stabs, or the native format
3177 if neither of those are supported), including GDB extensions if at all
3178 possible.
3180 @item -gstabs
3181 @opindex gstabs
3182 Produce debugging information in stabs format (if that is supported),
3183 without GDB extensions.  This is the format used by DBX on most BSD
3184 systems.  On MIPS, Alpha and System V Release 4 systems this option
3185 produces stabs debugging output which is not understood by DBX or SDB@.
3186 On System V Release 4 systems this option requires the GNU assembler.
3188 @item -feliminate-unused-debug-symbols
3189 @opindex feliminate-unused-debug-symbols
3190 Produce debugging information in stabs format (if that is supported),
3191 for only symbols that are actually used.
3193 @item -gstabs+
3194 @opindex gstabs+
3195 Produce debugging information in stabs format (if that is supported),
3196 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3197 use of these extensions is likely to make other debuggers crash or
3198 refuse to read the program.
3200 @item -gcoff
3201 @opindex gcoff
3202 Produce debugging information in COFF format (if that is supported).
3203 This is the format used by SDB on most System V systems prior to
3204 System V Release 4.
3206 @item -gxcoff
3207 @opindex gxcoff
3208 Produce debugging information in XCOFF format (if that is supported).
3209 This is the format used by the DBX debugger on IBM RS/6000 systems.
3211 @item -gxcoff+
3212 @opindex gxcoff+
3213 Produce debugging information in XCOFF format (if that is supported),
3214 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3215 use of these extensions is likely to make other debuggers crash or
3216 refuse to read the program, and may cause assemblers other than the GNU
3217 assembler (GAS) to fail with an error.
3219 @item -gdwarf-2
3220 @opindex gdwarf-2
3221 Produce debugging information in DWARF version 2 format (if that is
3222 supported).  This is the format used by DBX on IRIX 6.  With this
3223 option, GCC uses features of DWARF version 3 when they are useful;
3224 version 3 is upward compatible with version 2, but may still cause
3225 problems for older debuggers.
3227 @item -gvms
3228 @opindex gvms
3229 Produce debugging information in VMS debug format (if that is
3230 supported).  This is the format used by DEBUG on VMS systems.
3232 @item -g@var{level}
3233 @itemx -ggdb@var{level}
3234 @itemx -gstabs@var{level}
3235 @itemx -gcoff@var{level}
3236 @itemx -gxcoff@var{level}
3237 @itemx -gvms@var{level}
3238 Request debugging information and also use @var{level} to specify how
3239 much information.  The default level is 2.
3241 Level 1 produces minimal information, enough for making backtraces in
3242 parts of the program that you don't plan to debug.  This includes
3243 descriptions of functions and external variables, but no information
3244 about local variables and no line numbers.
3246 Level 3 includes extra information, such as all the macro definitions
3247 present in the program.  Some debuggers support macro expansion when
3248 you use @option{-g3}.
3250 @option{-gdwarf-2} does not accept a concatenated debug level, because
3251 GCC used to support an option @option{-gdwarf} that meant to generate
3252 debug information in version 1 of the DWARF format (which is very
3253 different from version 2), and it would have been too confusing.  That
3254 debug format is long obsolete, but the option cannot be changed now.
3255 Instead use an additional @option{-g@var{level}} option to change the
3256 debug level for DWARF2.
3258 @item -feliminate-dwarf2-dups
3259 @opindex feliminate-dwarf2-dups
3260 Compress DWARF2 debugging information by eliminating duplicated
3261 information about each symbol.  This option only makes sense when
3262 generating DWARF2 debugging information with @option{-gdwarf-2}.
3264 @cindex @command{prof}
3265 @item -p
3266 @opindex p
3267 Generate extra code to write profile information suitable for the
3268 analysis program @command{prof}.  You must use this option when compiling
3269 the source files you want data about, and you must also use it when
3270 linking.
3272 @cindex @command{gprof}
3273 @item -pg
3274 @opindex pg
3275 Generate extra code to write profile information suitable for the
3276 analysis program @command{gprof}.  You must use this option when compiling
3277 the source files you want data about, and you must also use it when
3278 linking.
3280 @item -Q
3281 @opindex Q
3282 Makes the compiler print out each function name as it is compiled, and
3283 print some statistics about each pass when it finishes.
3285 @item -ftime-report
3286 @opindex ftime-report
3287 Makes the compiler print some statistics about the time consumed by each
3288 pass when it finishes.
3290 @item -fmem-report
3291 @opindex fmem-report
3292 Makes the compiler print some statistics about permanent memory
3293 allocation when it finishes.
3295 @item -fprofile-arcs
3296 @opindex fprofile-arcs
3297 Add code so that program flow @dfn{arcs} are instrumented.  During
3298 execution the program records how many times each branch and call is
3299 executed and how many times it is taken or returns.  When the compiled
3300 program exits it saves this data to a file called
3301 @file{@var{auxname}.gcda} for each source file. The data may be used for
3302 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3303 test coverage analysis (@option{-ftest-coverage}). Each object file's
3304 @var{auxname} is generated from the name of the output file, if
3305 explicitly specified and it is not the final executable, otherwise it is
3306 the basename of the source file. In both cases any suffix is removed
3307 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3308 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3310 @itemize
3312 @item
3313 Compile the source files with @option{-fprofile-arcs} plus optimization
3314 and code generation options. For test coverage analysis, use the
3315 additional @option{-ftest-coverage} option. You do not need to profile
3316 every source file in a program.
3318 @item
3319 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3320 (the latter implies the former).
3322 @item
3323 Run the program on a representative workload to generate the arc profile
3324 information. This may be repeated any number of times. You can run
3325 concurrent instances of your program, and provided that the file system
3326 supports locking, the data files will be correctly updated. Also
3327 @code{fork} calls are detected and correctly handled (double counting
3328 will not happen).
3330 @item
3331 For profile-directed optimizations, compile the source files again with
3332 the same optimization and code generation options plus
3333 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3334 Control Optimization}).
3336 @item
3337 For test coverage analysis, use @command{gcov} to produce human readable
3338 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3339 @command{gcov} documentation for further information.
3341 @end itemize
3343 With @option{-fprofile-arcs}, for each function of your program GCC
3344 creates a program flow graph, then finds a spanning tree for the graph.
3345 Only arcs that are not on the spanning tree have to be instrumented: the
3346 compiler adds code to count the number of times that these arcs are
3347 executed.  When an arc is the only exit or only entrance to a block, the
3348 instrumentation code can be added to the block; otherwise, a new basic
3349 block must be created to hold the instrumentation code.
3351 @item -ftree-based-profiling
3352 @opindex ftree-based-profiling
3353 This option is used in addition to @option{-fprofile-arcs} or
3354 @option{-fbranch-probabilities} to control whether those optimizations
3355 are performed on a tree-based or rtl-based internal representation.
3356 If you use this option when compiling with @option{-fprofile-arcs},
3357 you must also use it when compiling later with @option{-fbranch-probabilities}.
3358 Currently the tree-based optimization is in an early stage of
3359 development, and this option is recommended only for those people
3360 working on improving it.
3362 @need 2000
3363 @item -ftest-coverage
3364 @opindex ftest-coverage
3365 Produce a notes file that the @command{gcov} code-coverage utility
3366 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3367 show program coverage. Each source file's note file is called
3368 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3369 above for a description of @var{auxname} and instructions on how to
3370 generate test coverage data. Coverage data will match the source files
3371 more closely, if you do not optimize.
3373 @item -d@var{letters}
3374 @item -fdump-rtl-@var{pass}
3375 @opindex d
3376 Says to make debugging dumps during compilation at times specified by
3377 @var{letters}.    This is used for debugging the RTL-based passes of the
3378 compiler.  The file names for most of the dumps are made by appending a
3379 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3380 from the name of the output file, if explicitly specified and it is not
3381 an executable, otherwise it is the basename of the source file.
3383 Most debug dumps can be enabled either passing a letter to the @option{-d}
3384 option, or with a long @option{-fdump-rtl} switch; here are the possible
3385 letters for use in @var{letters} and @var{pass}, and their meanings:
3387 @table @gcctabopt
3388 @item -dA
3389 @opindex dA
3390 Annotate the assembler output with miscellaneous debugging information.
3392 @item -db
3393 @itemx -fdump-rtl-bp
3394 @opindex db
3395 @opindex fdump-rtl-bp
3396 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3398 @item -dB
3399 @itemx -fdump-rtl-bbro
3400 @opindex dB
3401 @opindex fdump-rtl-bbro
3402 Dump after block reordering, to @file{@var{file}.30.bbro}.
3404 @item -dc
3405 @itemx -fdump-rtl-combine
3406 @opindex dc
3407 @opindex fdump-rtl-combine
3408 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3410 @item -dC
3411 @itemx -fdump-rtl-ce1
3412 @itemx -fdump-rtl-ce2
3413 @opindex dC
3414 @opindex fdump-rtl-ce1
3415 @opindex fdump-rtl-ce2
3416 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3417 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3418 and @option{-fdump-rtl-ce2} enable dumping after the second if
3419 conversion, to the file @file{@var{file}.18.ce2}.
3421 @item -dd
3422 @itemx -fdump-rtl-btl
3423 @itemx -fdump-rtl-dbr
3424 @opindex dd
3425 @opindex fdump-rtl-btl
3426 @opindex fdump-rtl-dbr
3427 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3428 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3429 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3430 scheduling, to @file{@var{file}.36.dbr}.
3432 @item -dD
3433 @opindex dD
3434 Dump all macro definitions, at the end of preprocessing, in addition to
3435 normal output.
3437 @item -dE
3438 @itemx -fdump-rtl-ce3
3439 @opindex dE
3440 @opindex fdump-rtl-ce3
3441 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3443 @item -df
3444 @itemx -fdump-rtl-cfg
3445 @itemx -fdump-rtl-life
3446 @opindex df
3447 @opindex fdump-rtl-cfg
3448 @opindex fdump-rtl-life
3449 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3450 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3451 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3452 to @file{@var{file}.16.life}.
3454 @item -dg
3455 @itemx -fdump-rtl-greg
3456 @opindex dg
3457 @opindex fdump-rtl-greg
3458 Dump after global register allocation, to @file{@var{file}.23.greg}.
3460 @item -dG
3461 @itemx -fdump-rtl-gcse
3462 @itemx -fdump-rtl-bypass
3463 @opindex dG
3464 @opindex fdump-rtl-gcse
3465 @opindex fdump-rtl-bypass
3466 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3467 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3468 enable dumping after jump bypassing and control flow optimizations, to
3469 @file{@var{file}.07.bypass}.
3471 @item -dh
3472 @itemx -fdump-rtl-eh
3473 @opindex dh
3474 @opindex fdump-rtl-eh
3475 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3477 @item -di
3478 @itemx -fdump-rtl-sibling
3479 @opindex di
3480 @opindex fdump-rtl-sibling
3481 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3483 @item -dj
3484 @itemx -fdump-rtl-jump
3485 @opindex dj
3486 @opindex fdump-rtl-jump
3487 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3489 @item -dk
3490 @itemx -fdump-rtl-stack
3491 @opindex dk
3492 @opindex fdump-rtl-stack
3493 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3495 @item -dl
3496 @itemx -fdump-rtl-lreg
3497 @opindex dl
3498 @opindex fdump-rtl-lreg
3499 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3501 @item -dL
3502 @itemx -fdump-rtl-loop
3503 @itemx -fdump-rtl-loop2
3504 @opindex dL
3505 @opindex fdump-rtl-loop
3506 @opindex fdump-rtl-loop2
3507 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3508 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3509 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3510 @file{@var{file}.13.loop2}.
3512 @item -dm
3513 @itemx -fdump-rtl-sms
3514 @opindex dm
3515 @opindex fdump-rtl-sms
3516 Dump after modulo scheduling, to @file{@var{file}.20.sms}. 
3518 @item -dM
3519 @itemx -fdump-rtl-mach
3520 @opindex dM
3521 @opindex fdump-rtl-mach
3522 Dump after performing the machine dependent reorganization pass, to
3523 @file{@var{file}.35.mach}.
3525 @item -dn
3526 @itemx -fdump-rtl-rnreg
3527 @opindex dn
3528 @opindex fdump-rtl-rnreg
3529 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3531 @item -dN
3532 @itemx -fdump-rtl-regmove
3533 @opindex dN
3534 @opindex fdump-rtl-regmove
3535 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3537 @item -do
3538 @itemx -fdump-rtl-postreload
3539 @opindex do
3540 @opindex fdump-rtl-postreload
3541 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3543 @item -dr
3544 @itemx -fdump-rtl-expand
3545 @opindex dr
3546 @opindex fdump-rtl-expand
3547 Dump after RTL generation, to @file{@var{file}.00.expand}.
3549 @item -dR
3550 @itemx -fdump-rtl-sched2
3551 @opindex dR
3552 @opindex fdump-rtl-sched2
3553 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3555 @item -ds
3556 @itemx -fdump-rtl-cse
3557 @opindex ds
3558 @opindex fdump-rtl-cse
3559 Dump after CSE (including the jump optimization that sometimes follows
3560 CSE), to @file{@var{file}.04.cse}.
3562 @item -dS
3563 @itemx -fdump-rtl-sched
3564 @opindex dS
3565 @opindex fdump-rtl-sched
3566 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3568 @item -dt
3569 @itemx -fdump-rtl-cse2
3570 @opindex dt
3571 @opindex fdump-rtl-cse2
3572 Dump after the second CSE pass (including the jump optimization that
3573 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3575 @item -dT
3576 @itemx -fdump-rtl-tracer
3577 @opindex dT
3578 @opindex fdump-rtl-tracer
3579 Dump after running tracer, to @file{@var{file}.12.tracer}.
3581 @item -dV
3582 @itemx -fdump-rtl-vpt
3583 @itemx -fdump-rtl-vartrack
3584 @opindex dV
3585 @opindex fdump-rtl-vpt
3586 @opindex fdump-rtl-vartrack
3587 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3588 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3589 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3590 to @file{@var{file}.34.vartrack}.
3592 @item -dw
3593 @itemx -fdump-rtl-flow2
3594 @opindex dw
3595 @opindex fdump-rtl-flow2
3596 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3598 @item -dz
3599 @itemx -fdump-rtl-peephole2
3600 @opindex dz
3601 @opindex fdump-rtl-peephole2
3602 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3604 @item -dZ
3605 @itemx -fdump-rtl-web
3606 @opindex dZ
3607 @opindex fdump-rtl-web
3608 Dump after live range splitting, to @file{@var{file}.14.web}.
3610 @item -da
3611 @itemx -fdump-rtl-all
3612 @opindex da
3613 @opindex fdump-rtl-all
3614 Produce all the dumps listed above.
3616 @item -dH
3617 @opindex dH
3618 Produce a core dump whenever an error occurs.
3620 @item -dm
3621 @opindex dm
3622 Print statistics on memory usage, at the end of the run, to
3623 standard error.
3625 @item -dp
3626 @opindex dp
3627 Annotate the assembler output with a comment indicating which
3628 pattern and alternative was used.  The length of each instruction is
3629 also printed.
3631 @item -dP
3632 @opindex dP
3633 Dump the RTL in the assembler output as a comment before each instruction.
3634 Also turns on @option{-dp} annotation.
3636 @item -dv
3637 @opindex dv
3638 For each of the other indicated dump files (either with @option{-d} or
3639 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3640 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3642 @item -dx
3643 @opindex dx
3644 Just generate RTL for a function instead of compiling it.  Usually used
3645 with @samp{r} (@option{-fdump-rtl-expand}).
3647 @item -dy
3648 @opindex dy
3649 Dump debugging information during parsing, to standard error.
3650 @end table
3652 @item -fdump-unnumbered
3653 @opindex fdump-unnumbered
3654 When doing debugging dumps (see @option{-d} option above), suppress instruction
3655 numbers and line number note output.  This makes it more feasible to
3656 use diff on debugging dumps for compiler invocations with different
3657 options, in particular with and without @option{-g}.
3659 @item -fdump-translation-unit @r{(C and C++ only)}
3660 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3661 @opindex fdump-translation-unit
3662 Dump a representation of the tree structure for the entire translation
3663 unit to a file.  The file name is made by appending @file{.tu} to the
3664 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3665 controls the details of the dump as described for the
3666 @option{-fdump-tree} options.
3668 @item -fdump-class-hierarchy @r{(C++ only)}
3669 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3670 @opindex fdump-class-hierarchy
3671 Dump a representation of each class's hierarchy and virtual function
3672 table layout to a file.  The file name is made by appending @file{.class}
3673 to the source file name.  If the @samp{-@var{options}} form is used,
3674 @var{options} controls the details of the dump as described for the
3675 @option{-fdump-tree} options.
3677 @item -fdump-ipa-@var{switch}
3678 @opindex fdump-ipa
3679 Control the dumping at various stages of inter-procedural analysis
3680 language tree to a file.  The file name is generated by appending a switch
3681 specific suffix to the source file name. The following dumps are possible:
3683 @table @samp
3684 @item all
3685 Enables all inter-procedural analysis dumps; currently the only produced
3686 dump is the @samp{cgraph} dump.
3688 @item cgraph
3689 Dumps information about call-graph optimization, unused function removal,
3690 and inlining decisions.
3691 @end table
3693 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3694 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3695 @opindex fdump-tree
3696 Control the dumping at various stages of processing the intermediate
3697 language tree to a file.  The file name is generated by appending a switch
3698 specific suffix to the source file name.  If the @samp{-@var{options}}
3699 form is used, @var{options} is a list of @samp{-} separated options that
3700 control the details of the dump. Not all options are applicable to all
3701 dumps, those which are not meaningful will be ignored. The following
3702 options are available
3704 @table @samp
3705 @item address
3706 Print the address of each node.  Usually this is not meaningful as it
3707 changes according to the environment and source file. Its primary use
3708 is for tying up a dump file with a debug environment.
3709 @item slim
3710 Inhibit dumping of members of a scope or body of a function merely
3711 because that scope has been reached.  Only dump such items when they
3712 are directly reachable by some other path.  When dumping pretty-printed
3713 trees, this option inhibits dumping the bodies of control structures.
3714 @item raw
3715 Print a raw representation of the tree.  By default, trees are
3716 pretty-printed into a C-like representation.
3717 @item details
3718 Enable more detailed dumps (not honored by every dump option).
3719 @item stats
3720 Enable dumping various statistics about the pass (not honored by every dump
3721 option).
3722 @item blocks
3723 Enable showing basic block boundaries (disabled in raw dumps).
3724 @item vops
3725 Enable showing virtual operands for every statement.
3726 @item lineno
3727 Enable showing line numbers for statements.
3728 @item uid
3729 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3730 @item all
3731 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3732 @end table
3734 The following tree dumps are possible:
3735 @table @samp
3737 @item original
3738 Dump before any tree based optimization, to @file{@var{file}.original}.
3740 @item optimized
3741 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3743 @item inlined
3744 Dump after function inlining, to @file{@var{file}.inlined}.
3746 @item gimple
3747 @opindex fdump-tree-gimple
3748 Dump each function before and after the gimplification pass to a file.  The
3749 file name is made by appending @file{.gimple} to the source file name.
3751 @item cfg
3752 @opindex fdump-tree-cfg
3753 Dump the control flow graph of each function to a file.  The file name is
3754 made by appending @file{.cfg} to the source file name.
3756 @item vcg
3757 @opindex fdump-tree-vcg
3758 Dump the control flow graph of each function to a file in VCG format.  The
3759 file name is made by appending @file{.vcg} to the source file name.  Note
3760 that if the file contains more than one function, the generated file cannot
3761 be used directly by VCG.  You will need to cut and paste each function's
3762 graph into its own separate file first.
3764 @item ch
3765 @opindex fdump-tree-ch
3766 Dump each function after copying loop headers.  The file name is made by
3767 appending @file{.ch} to the source file name.
3769 @item ssa
3770 @opindex fdump-tree-ssa
3771 Dump SSA related information to a file.  The file name is made by appending
3772 @file{.ssa} to the source file name.
3774 @item alias
3775 @opindex fdump-tree-alias
3776 Dump aliasing information for each function.  The file name is made by
3777 appending @file{.alias} to the source file name.
3779 @item ccp
3780 @opindex fdump-tree-ccp
3781 Dump each function after CCP.  The file name is made by appending
3782 @file{.ccp} to the source file name.
3784 @item pre
3785 @opindex fdump-tree-pre
3786 Dump trees after partial redundancy elimination.  The file name is made
3787 by appending @file{.pre} to the source file name.
3789 @item fre
3790 @opindex fdump-tree-fre
3791 Dump trees after full redundancy elimination.  The file name is made
3792 by appending @file{.fre} to the source file name.
3794 @item dce
3795 @opindex fdump-tree-dce
3796 Dump each function after dead code elimination.  The file name is made by
3797 appending @file{.dce} to the source file name.
3799 @item mudflap
3800 @opindex fdump-tree-mudflap
3801 Dump each function after adding mudflap instrumentation.  The file name is
3802 made by appending @file{.mudflap} to the source file name.
3804 @item sra
3805 @opindex fdump-tree-sra
3806 Dump each function after performing scalar replacement of aggregates.  The
3807 file name is made by appending @file{.sra} to the source file name.
3809 @item dom
3810 @opindex fdump-tree-dom
3811 Dump each function after applying dominator tree optimizations.  The file
3812 name is made by appending @file{.dom} to the source file name.
3814 @item dse
3815 @opindex fdump-tree-dse
3816 Dump each function after applying dead store elimination.  The file
3817 name is made by appending @file{.dse} to the source file name.
3819 @item phiopt
3820 @opindex fdump-tree-phiopt
3821 Dump each function after optimizing PHI nodes into straightline code.  The file
3822 name is made by appending @file{.phiopt} to the source file name.
3824 @item forwprop
3825 @opindex fdump-tree-forwprop
3826 Dump each function after forward propagating single use variables.  The file
3827 name is made by appending @file{.forwprop} to the source file name.
3829 @item copyrename
3830 @opindex fdump-tree-copyrename
3831 Dump each function after applying the copy rename optimization.  The file
3832 name is made by appending @file{.copyrename} to the source file name.
3834 @item nrv
3835 @opindex fdump-tree-nrv
3836 Dump each function after applying the named return value optimization on
3837 generic trees.  The file name is made by appending @file{.nrv} to the source
3838 file name.
3840 @item vect
3841 @opindex fdump-tree-vect
3842 Dump each function after applying vectorization of loops.  The file name is 
3843 made by appending @file{.vect} to the source file name.
3845 @item all
3846 @opindex fdump-tree-all
3847 Enable all the available tree dumps with the flags provided in this option.
3848 @end table
3850 @item -frandom-seed=@var{string}
3851 @opindex frandom-string
3852 This option provides a seed that GCC uses when it would otherwise use
3853 random numbers.  It is used to generate certain symbol names
3854 that have to be different in every compiled file. It is also used to
3855 place unique stamps in coverage data files and the object files that
3856 produce them. You can use the @option{-frandom-seed} option to produce
3857 reproducibly identical object files.
3859 The @var{string} should be different for every file you compile.
3861 @item -fsched-verbose=@var{n}
3862 @opindex fsched-verbose
3863 On targets that use instruction scheduling, this option controls the
3864 amount of debugging output the scheduler prints.  This information is
3865 written to standard error, unless @option{-dS} or @option{-dR} is
3866 specified, in which case it is output to the usual dump
3867 listing file, @file{.sched} or @file{.sched2} respectively.  However
3868 for @var{n} greater than nine, the output is always printed to standard
3869 error.
3871 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3872 same information as @option{-dRS}.  For @var{n} greater than one, it
3873 also output basic block probabilities, detailed ready list information
3874 and unit/insn info.  For @var{n} greater than two, it includes RTL
3875 at abort point, control-flow and regions info.  And for @var{n} over
3876 four, @option{-fsched-verbose} also includes dependence info.
3878 @item -save-temps
3879 @opindex save-temps
3880 Store the usual ``temporary'' intermediate files permanently; place them
3881 in the current directory and name them based on the source file.  Thus,
3882 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3883 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3884 preprocessed @file{foo.i} output file even though the compiler now
3885 normally uses an integrated preprocessor.
3887 @item -time
3888 @opindex time
3889 Report the CPU time taken by each subprocess in the compilation
3890 sequence.  For C source files, this is the compiler proper and assembler
3891 (plus the linker if linking is done).  The output looks like this:
3893 @smallexample
3894 # cc1 0.12 0.01
3895 # as 0.00 0.01
3896 @end smallexample
3898 The first number on each line is the ``user time,'' that is time spent
3899 executing the program itself.  The second number is ``system time,''
3900 time spent executing operating system routines on behalf of the program.
3901 Both numbers are in seconds.
3903 @item -fvar-tracking
3904 @opindex fvar-tracking
3905 Run variable tracking pass. It computes where variables are stored at each
3906 position in code. Better debugging information is then generated
3907 (if the debugging information format supports this information).
3909 It is enabled by default when compiling with optimization (@option{-Os},
3910 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3911 the debug info format supports it.
3913 @item -print-file-name=@var{library}
3914 @opindex print-file-name
3915 Print the full absolute name of the library file @var{library} that
3916 would be used when linking---and don't do anything else.  With this
3917 option, GCC does not compile or link anything; it just prints the
3918 file name.
3920 @item -print-multi-directory
3921 @opindex print-multi-directory
3922 Print the directory name corresponding to the multilib selected by any
3923 other switches present in the command line.  This directory is supposed
3924 to exist in @env{GCC_EXEC_PREFIX}.
3926 @item -print-multi-lib
3927 @opindex print-multi-lib
3928 Print the mapping from multilib directory names to compiler switches
3929 that enable them.  The directory name is separated from the switches by
3930 @samp{;}, and each switch starts with an @samp{@@} instead of the
3931 @samp{-}, without spaces between multiple switches.  This is supposed to
3932 ease shell-processing.
3934 @item -print-prog-name=@var{program}
3935 @opindex print-prog-name
3936 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3938 @item -print-libgcc-file-name
3939 @opindex print-libgcc-file-name
3940 Same as @option{-print-file-name=libgcc.a}.
3942 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3943 but you do want to link with @file{libgcc.a}.  You can do
3945 @smallexample
3946 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3947 @end smallexample
3949 @item -print-search-dirs
3950 @opindex print-search-dirs
3951 Print the name of the configured installation directory and a list of
3952 program and library directories @command{gcc} will search---and don't do anything else.
3954 This is useful when @command{gcc} prints the error message
3955 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3956 To resolve this you either need to put @file{cpp0} and the other compiler
3957 components where @command{gcc} expects to find them, or you can set the environment
3958 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3959 Don't forget the trailing '/'.
3960 @xref{Environment Variables}.
3962 @item -dumpmachine
3963 @opindex dumpmachine
3964 Print the compiler's target machine (for example,
3965 @samp{i686-pc-linux-gnu})---and don't do anything else.
3967 @item -dumpversion
3968 @opindex dumpversion
3969 Print the compiler version (for example, @samp{3.0})---and don't do
3970 anything else.
3972 @item -dumpspecs
3973 @opindex dumpspecs
3974 Print the compiler's built-in specs---and don't do anything else.  (This
3975 is used when GCC itself is being built.)  @xref{Spec Files}.
3977 @item -feliminate-unused-debug-types
3978 @opindex feliminate-unused-debug-types
3979 Normally, when producing DWARF2 output, GCC will emit debugging
3980 information for all types declared in a compilation
3981 unit, regardless of whether or not they are actually used
3982 in that compilation unit.  Sometimes this is useful, such as
3983 if, in the debugger, you want to cast a value to a type that is
3984 not actually used in your program (but is declared).  More often,
3985 however, this results in a significant amount of wasted space.
3986 With this option, GCC will avoid producing debug symbol output
3987 for types that are nowhere used in the source file being compiled.
3988 @end table
3990 @node Optimize Options
3991 @section Options That Control Optimization
3992 @cindex optimize options
3993 @cindex options, optimization
3995 These options control various sorts of optimizations.
3997 Without any optimization option, the compiler's goal is to reduce the
3998 cost of compilation and to make debugging produce the expected
3999 results.  Statements are independent: if you stop the program with a
4000 breakpoint between statements, you can then assign a new value to any
4001 variable or change the program counter to any other statement in the
4002 function and get exactly the results you would expect from the source
4003 code.
4005 Turning on optimization flags makes the compiler attempt to improve
4006 the performance and/or code size at the expense of compilation time
4007 and possibly the ability to debug the program.
4009 The compiler performs optimization based on the knowledge it has of
4010 the program.  Optimization levels @option{-O2} and above, in
4011 particular, enable @emph{unit-at-a-time} mode, which allows the
4012 compiler to consider information gained from later functions in
4013 the file when compiling a function.  Compiling multiple files at
4014 once to a single output file in @emph{unit-at-a-time} mode allows
4015 the compiler to use information gained from all of the files when
4016 compiling each of them.
4018 Not all optimizations are controlled directly by a flag.  Only
4019 optimizations that have a flag are listed.
4021 @table @gcctabopt
4022 @item -O
4023 @itemx -O1
4024 @opindex O
4025 @opindex O1
4026 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4027 more memory for a large function.
4029 With @option{-O}, the compiler tries to reduce code size and execution
4030 time, without performing any optimizations that take a great deal of
4031 compilation time.
4033 @option{-O} turns on the following optimization flags:
4034 @gccoptlist{-fdefer-pop @gol
4035 -fmerge-constants @gol
4036 -fthread-jumps @gol
4037 -floop-optimize @gol
4038 -fif-conversion @gol
4039 -fif-conversion2 @gol
4040 -fdelayed-branch @gol
4041 -fguess-branch-probability @gol
4042 -fcprop-registers}
4044 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4045 where doing so does not interfere with debugging.
4047 @item -O2
4048 @opindex O2
4049 Optimize even more.  GCC performs nearly all supported optimizations
4050 that do not involve a space-speed tradeoff.  The compiler does not
4051 perform loop unrolling or function inlining when you specify @option{-O2}.
4052 As compared to @option{-O}, this option increases both compilation time
4053 and the performance of the generated code.
4055 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4056 also turns on the following optimization flags:
4057 @gccoptlist{-fforce-mem @gol
4058 -foptimize-sibling-calls @gol
4059 -fstrength-reduce @gol
4060 -fcse-follow-jumps  -fcse-skip-blocks @gol
4061 -frerun-cse-after-loop  -frerun-loop-opt @gol
4062 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
4063 -fdelete-null-pointer-checks @gol
4064 -fexpensive-optimizations @gol
4065 -fregmove @gol
4066 -fschedule-insns  -fschedule-insns2 @gol
4067 -fsched-interblock  -fsched-spec @gol
4068 -fcaller-saves @gol
4069 -fpeephole2 @gol
4070 -freorder-blocks  -freorder-functions @gol
4071 -fstrict-aliasing @gol
4072 -funit-at-a-time @gol
4073 -falign-functions  -falign-jumps @gol
4074 -falign-loops  -falign-labels @gol
4075 -fcrossjumping}
4077 Please note the warning under @option{-fgcse} about
4078 invoking @option{-O2} on programs that use computed gotos.
4080 @item -O3
4081 @opindex O3
4082 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4083 @option{-O2} and also turns on the @option{-finline-functions},
4084 @option{-fweb} and @option{-fgcse-after-reload} options.
4086 @item -O0
4087 @opindex O0
4088 Do not optimize.  This is the default.
4090 @item -Os
4091 @opindex Os
4092 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4093 do not typically increase code size.  It also performs further
4094 optimizations designed to reduce code size.
4096 @option{-Os} disables the following optimization flags:
4097 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4098 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4100 If you use multiple @option{-O} options, with or without level numbers,
4101 the last such option is the one that is effective.
4102 @end table
4104 Options of the form @option{-f@var{flag}} specify machine-independent
4105 flags.  Most flags have both positive and negative forms; the negative
4106 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4107 below, only one of the forms is listed---the one you typically will
4108 use.  You can figure out the other form by either removing @samp{no-}
4109 or adding it.
4111 The following options control specific optimizations.  They are either
4112 activated by @option{-O} options or are related to ones that are.  You
4113 can use the following flags in the rare cases when ``fine-tuning'' of
4114 optimizations to be performed is desired.
4116 @table @gcctabopt
4117 @item -fno-default-inline
4118 @opindex fno-default-inline
4119 Do not make member functions inline by default merely because they are
4120 defined inside the class scope (C++ only).  Otherwise, when you specify
4121 @w{@option{-O}}, member functions defined inside class scope are compiled
4122 inline by default; i.e., you don't need to add @samp{inline} in front of
4123 the member function name.
4125 @item -fno-defer-pop
4126 @opindex fno-defer-pop
4127 Always pop the arguments to each function call as soon as that function
4128 returns.  For machines which must pop arguments after a function call,
4129 the compiler normally lets arguments accumulate on the stack for several
4130 function calls and pops them all at once.
4132 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4134 @item -fforce-mem
4135 @opindex fforce-mem
4136 Force memory operands to be copied into registers before doing
4137 arithmetic on them.  This produces better code by making all memory
4138 references potential common subexpressions.  When they are not common
4139 subexpressions, instruction combination should eliminate the separate
4140 register-load.
4142 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4144 @item -fforce-addr
4145 @opindex fforce-addr
4146 Force memory address constants to be copied into registers before
4147 doing arithmetic on them.  This may produce better code just as
4148 @option{-fforce-mem} may.
4150 @item -fomit-frame-pointer
4151 @opindex fomit-frame-pointer
4152 Don't keep the frame pointer in a register for functions that
4153 don't need one.  This avoids the instructions to save, set up and
4154 restore frame pointers; it also makes an extra register available
4155 in many functions.  @strong{It also makes debugging impossible on
4156 some machines.}
4158 On some machines, such as the VAX, this flag has no effect, because
4159 the standard calling sequence automatically handles the frame pointer
4160 and nothing is saved by pretending it doesn't exist.  The
4161 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4162 whether a target machine supports this flag.  @xref{Registers,,Register
4163 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4165 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4167 @item -foptimize-sibling-calls
4168 @opindex foptimize-sibling-calls
4169 Optimize sibling and tail recursive calls.
4171 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4173 @item -fno-inline
4174 @opindex fno-inline
4175 Don't pay attention to the @code{inline} keyword.  Normally this option
4176 is used to keep the compiler from expanding any functions inline.
4177 Note that if you are not optimizing, no functions can be expanded inline.
4179 @item -finline-functions
4180 @opindex finline-functions
4181 Integrate all simple functions into their callers.  The compiler
4182 heuristically decides which functions are simple enough to be worth
4183 integrating in this way.
4185 If all calls to a given function are integrated, and the function is
4186 declared @code{static}, then the function is normally not output as
4187 assembler code in its own right.
4189 Enabled at level @option{-O3}.
4191 @item -finline-limit=@var{n}
4192 @opindex finline-limit
4193 By default, GCC limits the size of functions that can be inlined.  This flag
4194 allows the control of this limit for functions that are explicitly marked as
4195 inline (i.e., marked with the inline keyword or defined within the class
4196 definition in c++).  @var{n} is the size of functions that can be inlined in
4197 number of pseudo instructions (not counting parameter handling).  The default
4198 value of @var{n} is 600.
4199 Increasing this value can result in more inlined code at
4200 the cost of compilation time and memory consumption.  Decreasing usually makes
4201 the compilation faster and less code will be inlined (which presumably
4202 means slower programs).  This option is particularly useful for programs that
4203 use inlining heavily such as those based on recursive templates with C++.
4205 Inlining is actually controlled by a number of parameters, which may be
4206 specified individually by using @option{--param @var{name}=@var{value}}.
4207 The @option{-finline-limit=@var{n}} option sets some of these parameters
4208 as follows:
4210 @table @gcctabopt
4211  @item max-inline-insns-single
4212   is set to @var{n}/2.
4213  @item max-inline-insns-auto
4214   is set to @var{n}/2.
4215  @item min-inline-insns
4216   is set to 130 or @var{n}/4, whichever is smaller.
4217  @item max-inline-insns-rtl
4218   is set to @var{n}.
4219 @end table
4221 See below for a documentation of the individual
4222 parameters controlling inlining.
4224 @emph{Note:} pseudo instruction represents, in this particular context, an
4225 abstract measurement of function's size.  In no way, it represents a count
4226 of assembly instructions and as such its exact meaning might change from one
4227 release to an another.
4229 @item -fkeep-inline-functions
4230 @opindex fkeep-inline-functions
4231 In C, emit @code{static} functions that are declared @code{inline}
4232 into the object file, even if the function has been inlined into all
4233 of its callers.  This switch does not affect functions using the
4234 @code{extern inline} extension in GNU C.  In C++, emit any and all
4235 inline functions into the object file.
4237 @item -fkeep-static-consts
4238 @opindex fkeep-static-consts
4239 Emit variables declared @code{static const} when optimization isn't turned
4240 on, even if the variables aren't referenced.
4242 GCC enables this option by default.  If you want to force the compiler to
4243 check if the variable was referenced, regardless of whether or not
4244 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4246 @item -fmerge-constants
4247 Attempt to merge identical constants (string constants and floating point
4248 constants) across compilation units.
4250 This option is the default for optimized compilation if the assembler and
4251 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4252 behavior.
4254 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4256 @item -fmerge-all-constants
4257 Attempt to merge identical constants and identical variables.
4259 This option implies @option{-fmerge-constants}.  In addition to
4260 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4261 arrays or initialized constant variables with integral or floating point
4262 types.  Languages like C or C++ require each non-automatic variable to
4263 have distinct location, so using this option will result in non-conforming
4264 behavior.
4266 @item -fmodulo-sched
4267 @opindex fmodulo-sched
4268 Perform swing modulo scheduling immediately before the first scheduling
4269 pass.  This pass looks at innermost loops and reorders their
4270 instructions by overlapping different iterations.
4272 @item -fnew-ra
4273 @opindex fnew-ra
4274 Use a graph coloring register allocator.  Currently this option is meant
4275 only for testing.  Users should not specify this option, since it is not
4276 yet ready for production use.
4278 @item -fno-branch-count-reg
4279 @opindex fno-branch-count-reg
4280 Do not use ``decrement and branch'' instructions on a count register,
4281 but instead generate a sequence of instructions that decrement a
4282 register, compare it against zero, then branch based upon the result.
4283 This option is only meaningful on architectures that support such
4284 instructions, which include x86, PowerPC, IA-64 and S/390.
4286 The default is @option{-fbranch-count-reg}, enabled when
4287 @option{-fstrength-reduce} is enabled.
4289 @item -fno-function-cse
4290 @opindex fno-function-cse
4291 Do not put function addresses in registers; make each instruction that
4292 calls a constant function contain the function's address explicitly.
4294 This option results in less efficient code, but some strange hacks
4295 that alter the assembler output may be confused by the optimizations
4296 performed when this option is not used.
4298 The default is @option{-ffunction-cse}
4300 @item -fno-zero-initialized-in-bss
4301 @opindex fno-zero-initialized-in-bss
4302 If the target supports a BSS section, GCC by default puts variables that
4303 are initialized to zero into BSS@.  This can save space in the resulting
4304 code.
4306 This option turns off this behavior because some programs explicitly
4307 rely on variables going to the data section.  E.g., so that the
4308 resulting executable can find the beginning of that section and/or make
4309 assumptions based on that.
4311 The default is @option{-fzero-initialized-in-bss}.
4313 @item -fbounds-check
4314 @opindex fbounds-check
4315 For front-ends that support it, generate additional code to check that
4316 indices used to access arrays are within the declared range.  This is
4317 currently only supported by the Java and Fortran front-ends, where
4318 this option defaults to true and false respectively.
4320 @item -fmudflap -fmudflapth -fmudflapir
4321 @opindex fmudflap
4322 @opindex fmudflapth
4323 @opindex fmudflapir
4324 @cindex bounds checking
4325 @cindex mudflap
4326 For front-ends that support it (C and C++), instrument all risky
4327 pointer/array dereferencing operations, some standard library
4328 string/heap functions, and some other associated constructs with
4329 range/validity tests.  Modules so instrumented should be immune to
4330 buffer overflows, invalid heap use, and some other classes of C/C++
4331 programming errors.  The instrumentation relies on a separate runtime
4332 library (@file{libmudflap}), which will be linked into a program if
4333 @option{-fmudflap} is given at link time.  Run-time behavior of the
4334 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4335 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4336 for its options.
4338 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4339 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4340 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4341 instrumentation should ignore pointer reads.  This produces less
4342 instrumentation (and therefore faster execution) and still provides
4343 some protection against outright memory corrupting writes, but allows
4344 erroneously read data to propagate within a program.
4346 @item -fstrength-reduce
4347 @opindex fstrength-reduce
4348 Perform the optimizations of loop strength reduction and
4349 elimination of iteration variables.
4351 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4353 @item -fthread-jumps
4354 @opindex fthread-jumps
4355 Perform optimizations where we check to see if a jump branches to a
4356 location where another comparison subsumed by the first is found.  If
4357 so, the first branch is redirected to either the destination of the
4358 second branch or a point immediately following it, depending on whether
4359 the condition is known to be true or false.
4361 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4363 @item -fcse-follow-jumps
4364 @opindex fcse-follow-jumps
4365 In common subexpression elimination, scan through jump instructions
4366 when the target of the jump is not reached by any other path.  For
4367 example, when CSE encounters an @code{if} statement with an
4368 @code{else} clause, CSE will follow the jump when the condition
4369 tested is false.
4371 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4373 @item -fcse-skip-blocks
4374 @opindex fcse-skip-blocks
4375 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4376 follow jumps which conditionally skip over blocks.  When CSE
4377 encounters a simple @code{if} statement with no else clause,
4378 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4379 body of the @code{if}.
4381 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4383 @item -frerun-cse-after-loop
4384 @opindex frerun-cse-after-loop
4385 Re-run common subexpression elimination after loop optimizations has been
4386 performed.
4388 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4390 @item -frerun-loop-opt
4391 @opindex frerun-loop-opt
4392 Run the loop optimizer twice.
4394 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4396 @item -fgcse
4397 @opindex fgcse
4398 Perform a global common subexpression elimination pass.
4399 This pass also performs global constant and copy propagation.
4401 @emph{Note:} When compiling a program using computed gotos, a GCC
4402 extension, you may get better runtime performance if you disable
4403 the global common subexpression elimination pass by adding
4404 @option{-fno-gcse} to the command line.
4406 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4408 @item -fgcse-lm
4409 @opindex fgcse-lm
4410 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4411 attempt to move loads which are only killed by stores into themselves.  This
4412 allows a loop containing a load/store sequence to be changed to a load outside
4413 the loop, and a copy/store within the loop.
4415 Enabled by default when gcse is enabled.
4417 @item -fgcse-sm
4418 @opindex fgcse-sm
4419 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4420 global common subexpression elimination.  This pass will attempt to move
4421 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4422 loops containing a load/store sequence can be changed to a load before
4423 the loop and a store after the loop.
4425 Enabled by default when gcse is enabled.
4427 @item -fgcse-las
4428 @opindex fgcse-las
4429 When @option{-fgcse-las} is enabled, the global common subexpression
4430 elimination pass eliminates redundant loads that come after stores to the
4431 same memory location (both partial and full redundancies).
4433 Enabled by default when gcse is enabled.
4435 @item -fgcse-after-reload
4436 @opindex fgcse-after-reload
4437 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4438 pass is performed after reload. The purpose of this pass is to cleanup
4439 redundant spilling.
4441 @item -floop-optimize
4442 @opindex floop-optimize
4443 Perform loop optimizations: move constant expressions out of loops, simplify
4444 exit test conditions and optionally do strength-reduction as well.
4446 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4448 @item -floop-optimize2
4449 @opindex floop-optimize2
4450 Perform loop optimizations using the new loop optimizer.  The optimizations
4451 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4452 by separate flags.
4454 @item -fcrossjumping
4455 @opindex crossjumping
4456 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4457 resulting code may or may not perform better than without cross-jumping.
4459 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4461 @item -fif-conversion
4462 @opindex if-conversion
4463 Attempt to transform conditional jumps into branch-less equivalents.  This
4464 include use of conditional moves, min, max, set flags and abs instructions, and
4465 some tricks doable by standard arithmetics.  The use of conditional execution
4466 on chips where it is available is controlled by @code{if-conversion2}.
4468 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4470 @item -fif-conversion2
4471 @opindex if-conversion2
4472 Use conditional execution (where available) to transform conditional jumps into
4473 branch-less equivalents.
4475 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4477 @item -fdelete-null-pointer-checks
4478 @opindex fdelete-null-pointer-checks
4479 Use global dataflow analysis to identify and eliminate useless checks
4480 for null pointers.  The compiler assumes that dereferencing a null
4481 pointer would have halted the program.  If a pointer is checked after
4482 it has already been dereferenced, it cannot be null.
4484 In some environments, this assumption is not true, and programs can
4485 safely dereference null pointers.  Use
4486 @option{-fno-delete-null-pointer-checks} to disable this optimization
4487 for programs which depend on that behavior.
4489 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4491 @item -fexpensive-optimizations
4492 @opindex fexpensive-optimizations
4493 Perform a number of minor optimizations that are relatively expensive.
4495 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4497 @item -foptimize-register-move
4498 @itemx -fregmove
4499 @opindex foptimize-register-move
4500 @opindex fregmove
4501 Attempt to reassign register numbers in move instructions and as
4502 operands of other simple instructions in order to maximize the amount of
4503 register tying.  This is especially helpful on machines with two-operand
4504 instructions.
4506 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4507 optimization.
4509 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4511 @item -fdelayed-branch
4512 @opindex fdelayed-branch
4513 If supported for the target machine, attempt to reorder instructions
4514 to exploit instruction slots available after delayed branch
4515 instructions.
4517 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4519 @item -fschedule-insns
4520 @opindex fschedule-insns
4521 If supported for the target machine, attempt to reorder instructions to
4522 eliminate execution stalls due to required data being unavailable.  This
4523 helps machines that have slow floating point or memory load instructions
4524 by allowing other instructions to be issued until the result of the load
4525 or floating point instruction is required.
4527 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4529 @item -fschedule-insns2
4530 @opindex fschedule-insns2
4531 Similar to @option{-fschedule-insns}, but requests an additional pass of
4532 instruction scheduling after register allocation has been done.  This is
4533 especially useful on machines with a relatively small number of
4534 registers and where memory load instructions take more than one cycle.
4536 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4538 @item -fno-sched-interblock
4539 @opindex fno-sched-interblock
4540 Don't schedule instructions across basic blocks.  This is normally
4541 enabled by default when scheduling before register allocation, i.e.@:
4542 with @option{-fschedule-insns} or at @option{-O2} or higher.
4544 @item -fno-sched-spec
4545 @opindex fno-sched-spec
4546 Don't allow speculative motion of non-load instructions.  This is normally
4547 enabled by default when scheduling before register allocation, i.e.@:
4548 with @option{-fschedule-insns} or at @option{-O2} or higher.
4550 @item -fsched-spec-load
4551 @opindex fsched-spec-load
4552 Allow speculative motion of some load instructions.  This only makes
4553 sense when scheduling before register allocation, i.e.@: with
4554 @option{-fschedule-insns} or at @option{-O2} or higher.
4556 @item -fsched-spec-load-dangerous
4557 @opindex fsched-spec-load-dangerous
4558 Allow speculative motion of more load instructions.  This only makes
4559 sense when scheduling before register allocation, i.e.@: with
4560 @option{-fschedule-insns} or at @option{-O2} or higher.
4562 @item -fsched-stalled-insns=@var{n}
4563 @opindex fsched-stalled-insns
4564 Define how many insns (if any) can be moved prematurely from the queue
4565 of stalled insns into the ready list, during the second scheduling pass.
4567 @item -fsched-stalled-insns-dep=@var{n}
4568 @opindex fsched-stalled-insns-dep
4569 Define how many insn groups (cycles) will be examined for a dependency
4570 on a stalled insn that is candidate for premature removal from the queue
4571 of stalled insns.  Has an effect only during the second scheduling pass,
4572 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4574 @item -fsched2-use-superblocks
4575 @opindex fsched2-use-superblocks
4576 When scheduling after register allocation, do use superblock scheduling
4577 algorithm.  Superblock scheduling allows motion across basic block boundaries
4578 resulting on faster schedules.  This option is experimental, as not all machine
4579 descriptions used by GCC model the CPU closely enough to avoid unreliable
4580 results from the algorithm.
4582 This only makes sense when scheduling after register allocation, i.e.@: with
4583 @option{-fschedule-insns2} or at @option{-O2} or higher.
4585 @item -fsched2-use-traces
4586 @opindex fsched2-use-traces
4587 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4588 allocation and additionally perform code duplication in order to increase the
4589 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4590 trace formation.
4592 This mode should produce faster but significantly longer programs.  Also
4593 without @option{-fbranch-probabilities} the traces constructed may not
4594 match the reality and hurt the performance.  This only makes
4595 sense when scheduling after register allocation, i.e.@: with
4596 @option{-fschedule-insns2} or at @option{-O2} or higher.
4598 @item -freschedule-modulo-scheduled-loops
4599 @opindex fscheduling-in-modulo-scheduled-loops
4600 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4601 we may want to prevent the later scheduling passes from changing its schedule, we use this
4602 option to control that.
4604 @item -fcaller-saves
4605 @opindex fcaller-saves
4606 Enable values to be allocated in registers that will be clobbered by
4607 function calls, by emitting extra instructions to save and restore the
4608 registers around such calls.  Such allocation is done only when it
4609 seems to result in better code than would otherwise be produced.
4611 This option is always enabled by default on certain machines, usually
4612 those which have no call-preserved registers to use instead.
4614 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4616 @item -ftree-pre
4617 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4618 enabled by default at @option{-O} and higher.
4620 @item -ftree-fre
4621 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4622 between FRE and PRE is that FRE only considers expressions
4623 that are computed on all paths leading to the redundant computation.
4624 This analysis faster than PRE, though it exposes fewer redundancies.
4625 This flag is enabled by default at @option{-O} and higher.
4627 @item -ftree-ccp
4628 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4629 is enabled by default at @option{-O} and higher.
4631 @item -ftree-dce
4632 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4633 default at @option{-O} and higher.
4635 @item -ftree-dominator-opts
4636 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4637 default at @option{-O} and higher.
4639 @item -ftree-ch
4640 Perform loop header copying on trees.  This is beneficial since it increases
4641 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4642 is enabled by default at @option{-O} and higher.  It is not enabled
4643 for @option{-Os}, since it usually increases code size.
4645 @item -ftree-loop-optimize
4646 Perform loop optimizations on trees.  This flag is enabled by default
4647 at @option{-O} and higher.
4649 @item -ftree-loop-linear
4650 Perform linear loop transformations on tree. This flag can improve cache 
4651 performance and allow further loop optimizations to take place.
4653 @item -ftree-lim
4654 Perform loop invariant motion on trees.  This pass moves only invartiants that
4655 would be hard to handle on rtl level (function calls, operations that expand to
4656 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4657 operands of conditions that are invariant out of the loop, so that we can use
4658 just trivial invariantness analysis in loop unswitching.  The pass also includes
4659 store motion.
4661 @item -fivcanon
4662 Create a canonical counter for number of iterations in the loop for that
4663 determining number of iterations requires complicated analysis.  Later
4664 optimizations then may determine the number easily.  Useful especially
4665 in connection with unrolling.
4667 @item -fivopts
4668 Perform induction variable optimizations (strength reduction, induction
4669 variable merging and induction variable elimination) on trees.
4671 @item -ftree-sra
4672 Perform scalar replacement of aggregates.  This pass replaces structure
4673 references with scalars to prevent committing structures to memory too
4674 early.  This flag is enabled by default at @option{-O} and higher.
4676 @item -ftree-copyrename
4677 Perform copy renaming on trees.  This pass attempts to rename compiler
4678 temporaries to other variables at copy locations, usually resulting in
4679 variable names which more closely resemble the original variables.  This flag
4680 is enabled by default at @option{-O} and higher.
4682 @item -ftree-ter
4683 Perform temporary expression replacement during the SSA->normal phase.  Single
4684 use/single def temporaries are replaced at their use location with their
4685 defining expression.  This results in non-GIMPLE code, but gives the expanders
4686 much more complex trees to work on resulting in better RTL generation.  This is
4687 enabled by default at @option{-O} and higher.
4689 @item -ftree-lrs
4690 Perform live range splitting during the SSA->normal phase.  Distinct live
4691 ranges of a variable are split into unique variables, allowing for better
4692 optimization later.  This is enabled by default at @option{-O} and higher.
4694 @item -ftree-vectorize
4695 Perform loop vectorization on trees.
4697 @item -ftracer
4698 @opindex ftracer
4699 Perform tail duplication to enlarge superblock size. This transformation
4700 simplifies the control flow of the function allowing other optimizations to do
4701 better job.
4703 @item -funroll-loops
4704 @opindex funroll-loops
4705 Unroll loops whose number of iterations can be determined at compile
4706 time or upon entry to the loop.  @option{-funroll-loops} implies both
4707 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4708 option makes code larger, and may or may not make it run faster.
4710 @item -funroll-all-loops
4711 @opindex funroll-all-loops
4712 Unroll all loops, even if their number of iterations is uncertain when
4713 the loop is entered.  This usually makes programs run more slowly.
4714 @option{-funroll-all-loops} implies the same options as
4715 @option{-funroll-loops},
4717 @item -fsplit-ivs-in-unroller
4718 @opindex -fsplit-ivs-in-unroller
4719 Enables expressing of values of induction variables in later iterations
4720 of the unrolled loop using the value in the first iteration.  This breaks
4721 long dependency chains, thus improving efficiency of the scheduling passes
4722 (for best results, @option{-fweb} should be used as well).
4724 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4725 same effect. However in cases the loop body is more complicated than
4726 a single basic block, this is not reliable.  It also does not work at all
4727 on some of the architectures due to restrictions in the CSE pass.
4729 This optimization is enabled by default.
4731 @item -fprefetch-loop-arrays
4732 @opindex fprefetch-loop-arrays
4733 If supported by the target machine, generate instructions to prefetch
4734 memory to improve the performance of loops that access large arrays.
4736 These options may generate better or worse code; results are highly
4737 dependent on the structure of loops within the source code.
4739 @item -fno-peephole
4740 @itemx -fno-peephole2
4741 @opindex fno-peephole
4742 @opindex fno-peephole2
4743 Disable any machine-specific peephole optimizations.  The difference
4744 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4745 are implemented in the compiler; some targets use one, some use the
4746 other, a few use both.
4748 @option{-fpeephole} is enabled by default.
4749 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4751 @item -fno-guess-branch-probability
4752 @opindex fno-guess-branch-probability
4753 Do not guess branch probabilities using a randomized model.
4755 Sometimes GCC will opt to use a randomized model to guess branch
4756 probabilities, when none are available from either profiling feedback
4757 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4758 different runs of the compiler on the same program may produce different
4759 object code.
4761 In a hard real-time system, people don't want different runs of the
4762 compiler to produce code that has different behavior; minimizing
4763 non-determinism is of paramount import.  This switch allows users to
4764 reduce non-determinism, possibly at the expense of inferior
4765 optimization.
4767 The default is @option{-fguess-branch-probability} at levels
4768 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4770 @item -freorder-blocks
4771 @opindex freorder-blocks
4772 Reorder basic blocks in the compiled function in order to reduce number of
4773 taken branches and improve code locality.
4775 Enabled at levels @option{-O2}, @option{-O3}.
4777 @item -freorder-blocks-and-partition
4778 @opindex freorder-blocks-and-partition
4779 In addition to reordering basic blocks in the compiled function, in order
4780 to reduce number of taken branches, partitions hot and cold basic blocks
4781 into separate sections of the assembly and .o files, to improve
4782 paging and cache locality performance.
4784 This optimization is automatically turned off in the presence of
4785 exception handling, for linkonce sections, for functions with a user-defined
4786 section attribute and on any architecture that does not support named
4787 sections.
4789 @item -freorder-functions
4790 @opindex freorder-functions
4791 Reorder basic blocks in the compiled function in order to reduce number of
4792 taken branches and improve code locality. This is implemented by using special
4793 subsections @code{.text.hot} for most frequently executed functions and
4794 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4795 the linker so object file format must support named sections and linker must
4796 place them in a reasonable way.
4798 Also profile feedback must be available in to make this option effective.  See
4799 @option{-fprofile-arcs} for details.
4801 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4803 @item -fstrict-aliasing
4804 @opindex fstrict-aliasing
4805 Allows the compiler to assume the strictest aliasing rules applicable to
4806 the language being compiled.  For C (and C++), this activates
4807 optimizations based on the type of expressions.  In particular, an
4808 object of one type is assumed never to reside at the same address as an
4809 object of a different type, unless the types are almost the same.  For
4810 example, an @code{unsigned int} can alias an @code{int}, but not a
4811 @code{void*} or a @code{double}.  A character type may alias any other
4812 type.
4814 Pay special attention to code like this:
4815 @smallexample
4816 union a_union @{
4817   int i;
4818   double d;
4821 int f() @{
4822   a_union t;
4823   t.d = 3.0;
4824   return t.i;
4826 @end smallexample
4827 The practice of reading from a different union member than the one most
4828 recently written to (called ``type-punning'') is common.  Even with
4829 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4830 is accessed through the union type.  So, the code above will work as
4831 expected.  However, this code might not:
4832 @smallexample
4833 int f() @{
4834   a_union t;
4835   int* ip;
4836   t.d = 3.0;
4837   ip = &t.i;
4838   return *ip;
4840 @end smallexample
4842 Every language that wishes to perform language-specific alias analysis
4843 should define a function that computes, given an @code{tree}
4844 node, an alias set for the node.  Nodes in different alias sets are not
4845 allowed to alias.  For an example, see the C front-end function
4846 @code{c_get_alias_set}.
4848 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4850 @item -falign-functions
4851 @itemx -falign-functions=@var{n}
4852 @opindex falign-functions
4853 Align the start of functions to the next power-of-two greater than
4854 @var{n}, skipping up to @var{n} bytes.  For instance,
4855 @option{-falign-functions=32} aligns functions to the next 32-byte
4856 boundary, but @option{-falign-functions=24} would align to the next
4857 32-byte boundary only if this can be done by skipping 23 bytes or less.
4859 @option{-fno-align-functions} and @option{-falign-functions=1} are
4860 equivalent and mean that functions will not be aligned.
4862 Some assemblers only support this flag when @var{n} is a power of two;
4863 in that case, it is rounded up.
4865 If @var{n} is not specified or is zero, use a machine-dependent default.
4867 Enabled at levels @option{-O2}, @option{-O3}.
4869 @item -falign-labels
4870 @itemx -falign-labels=@var{n}
4871 @opindex falign-labels
4872 Align all branch targets to a power-of-two boundary, skipping up to
4873 @var{n} bytes like @option{-falign-functions}.  This option can easily
4874 make code slower, because it must insert dummy operations for when the
4875 branch target is reached in the usual flow of the code.
4877 @option{-fno-align-labels} and @option{-falign-labels=1} are
4878 equivalent and mean that labels will not be aligned.
4880 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4881 are greater than this value, then their values are used instead.
4883 If @var{n} is not specified or is zero, use a machine-dependent default
4884 which is very likely to be @samp{1}, meaning no alignment.
4886 Enabled at levels @option{-O2}, @option{-O3}.
4888 @item -falign-loops
4889 @itemx -falign-loops=@var{n}
4890 @opindex falign-loops
4891 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4892 like @option{-falign-functions}.  The hope is that the loop will be
4893 executed many times, which will make up for any execution of the dummy
4894 operations.
4896 @option{-fno-align-loops} and @option{-falign-loops=1} are
4897 equivalent and mean that loops will not be aligned.
4899 If @var{n} is not specified or is zero, use a machine-dependent default.
4901 Enabled at levels @option{-O2}, @option{-O3}.
4903 @item -falign-jumps
4904 @itemx -falign-jumps=@var{n}
4905 @opindex falign-jumps
4906 Align branch targets to a power-of-two boundary, for branch targets
4907 where the targets can only be reached by jumping, skipping up to @var{n}
4908 bytes like @option{-falign-functions}.  In this case, no dummy operations
4909 need be executed.
4911 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4912 equivalent and mean that loops will not be aligned.
4914 If @var{n} is not specified or is zero, use a machine-dependent default.
4916 Enabled at levels @option{-O2}, @option{-O3}.
4918 @item -funit-at-a-time
4919 @opindex funit-at-a-time
4920 Parse the whole compilation unit before starting to produce code.
4921 This allows some extra optimizations to take place but consumes
4922 more memory (in general).  There are some compatibility issues
4923 with @emph{unit-at-at-time} mode:
4924 @itemize @bullet
4925 @item
4926 enabling @emph{unit-at-a-time} mode may change the order
4927 in which functions, variables, and top-level @code{asm} statements
4928 are emitted, and will likely break code relying on some particular
4929 ordering.  The majority of such top-level @code{asm} statements,
4930 though, can be replaced by @code{section} attributes.
4932 @item
4933 @emph{unit-at-a-time} mode removes unreferenced static variables
4934 and functions are removed.  This may result in undefined references
4935 when an @code{asm} statement refers directly to variables or functions
4936 that are otherwise unused.  In that case either the variable/function
4937 shall be listed as an operand of the @code{asm} statement operand or,
4938 in the case of top-level @code{asm} statements the attribute @code{used}
4939 shall be used on the declaration.
4941 @item
4942 Static functions now can use non-standard passing conventions that
4943 may break @code{asm} statements calling functions directly. Again,
4944 attribute @code{used} will prevent this behavior.
4945 @end itemize
4947 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4948 but this scheme may not be supported by future releases of GCC.
4950 Enabled at levels @option{-O2}, @option{-O3}.
4952 @item -fweb
4953 @opindex fweb
4954 Constructs webs as commonly used for register allocation purposes and assign
4955 each web individual pseudo register.  This allows the register allocation pass
4956 to operate on pseudos directly, but also strengthens several other optimization
4957 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4958 however, make debugging impossible, since variables will no longer stay in a
4959 ``home register''.
4961 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4962 on targets where the default format for debugging information supports
4963 variable tracking.
4965 @item -fno-cprop-registers
4966 @opindex fno-cprop-registers
4967 After register allocation and post-register allocation instruction splitting,
4968 we perform a copy-propagation pass to try to reduce scheduling dependencies
4969 and occasionally eliminate the copy.
4971 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4973 @item -fprofile-generate
4974 @opindex fprofile-generate
4976 Enable options usually used for instrumenting application to produce
4977 profile useful for later recompilation with profile feedback based
4978 optimization.  You must use @option{-fprofile-generate} both when
4979 compiling and when linking your program.
4981 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4983 @item -fprofile-use
4984 @opindex fprofile-use
4985 Enable profile feedback directed optimizations, and optimizations
4986 generally profitable only with profile feedback available.
4988 The following options are enabled: @code{-fbranch-probabilities},
4989 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4991 @end table
4993 The following options control compiler behavior regarding floating
4994 point arithmetic.  These options trade off between speed and
4995 correctness.  All must be specifically enabled.
4997 @table @gcctabopt
4998 @item -ffloat-store
4999 @opindex ffloat-store
5000 Do not store floating point variables in registers, and inhibit other
5001 options that might change whether a floating point value is taken from a
5002 register or memory.
5004 @cindex floating point precision
5005 This option prevents undesirable excess precision on machines such as
5006 the 68000 where the floating registers (of the 68881) keep more
5007 precision than a @code{double} is supposed to have.  Similarly for the
5008 x86 architecture.  For most programs, the excess precision does only
5009 good, but a few programs rely on the precise definition of IEEE floating
5010 point.  Use @option{-ffloat-store} for such programs, after modifying
5011 them to store all pertinent intermediate computations into variables.
5013 @item -ffast-math
5014 @opindex ffast-math
5015 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5016 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5017 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
5019 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5021 This option should never be turned on by any @option{-O} option since
5022 it can result in incorrect output for programs which depend on
5023 an exact implementation of IEEE or ISO rules/specifications for
5024 math functions.
5026 @item -fno-math-errno
5027 @opindex fno-math-errno
5028 Do not set ERRNO after calling math functions that are executed
5029 with a single instruction, e.g., sqrt.  A program that relies on
5030 IEEE exceptions for math error handling may want to use this flag
5031 for speed while maintaining IEEE arithmetic compatibility.
5033 This option should never be turned on by any @option{-O} option since
5034 it can result in incorrect output for programs which depend on
5035 an exact implementation of IEEE or ISO rules/specifications for
5036 math functions.
5038 The default is @option{-fmath-errno}.
5040 @item -funsafe-math-optimizations
5041 @opindex funsafe-math-optimizations
5042 Allow optimizations for floating-point arithmetic that (a) assume
5043 that arguments and results are valid and (b) may violate IEEE or
5044 ANSI standards.  When used at link-time, it may include libraries
5045 or startup files that change the default FPU control word or other
5046 similar optimizations.
5048 This option should never be turned on by any @option{-O} option since
5049 it can result in incorrect output for programs which depend on
5050 an exact implementation of IEEE or ISO rules/specifications for
5051 math functions.
5053 The default is @option{-fno-unsafe-math-optimizations}.
5055 @item -ffinite-math-only
5056 @opindex ffinite-math-only
5057 Allow optimizations for floating-point arithmetic that assume
5058 that arguments and results are not NaNs or +-Infs.
5060 This option should never be turned on by any @option{-O} option since
5061 it can result in incorrect output for programs which depend on
5062 an exact implementation of IEEE or ISO rules/specifications.
5064 The default is @option{-fno-finite-math-only}.
5066 @item -fno-trapping-math
5067 @opindex fno-trapping-math
5068 Compile code assuming that floating-point operations cannot generate
5069 user-visible traps.  These traps include division by zero, overflow,
5070 underflow, inexact result and invalid operation.  This option implies
5071 @option{-fno-signaling-nans}.  Setting this option may allow faster
5072 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5074 This option should never be turned on by any @option{-O} option since
5075 it can result in incorrect output for programs which depend on
5076 an exact implementation of IEEE or ISO rules/specifications for
5077 math functions.
5079 The default is @option{-ftrapping-math}.
5081 @item -frounding-math
5082 @opindex frounding-math
5083 Disable transformations and optimizations that assume default floating
5084 point rounding behavior.  This is round-to-zero for all floating point
5085 to integer conversions, and round-to-nearest for all other arithmetic
5086 truncations.  This option should be specified for programs that change
5087 the FP rounding mode dynamically, or that may be executed with a
5088 non-default rounding mode.  This option disables constant folding of
5089 floating point expressions at compile-time (which may be affected by
5090 rounding mode) and arithmetic transformations that are unsafe in the
5091 presence of sign-dependent rounding modes.
5093 The default is @option{-fno-rounding-math}.
5095 This option is experimental and does not currently guarantee to
5096 disable all GCC optimizations that are affected by rounding mode.
5097 Future versions of GCC may provide finer control of this setting
5098 using C99's @code{FENV_ACCESS} pragma.  This command line option
5099 will be used to specify the default state for @code{FENV_ACCESS}.
5101 @item -fsignaling-nans
5102 @opindex fsignaling-nans
5103 Compile code assuming that IEEE signaling NaNs may generate user-visible
5104 traps during floating-point operations.  Setting this option disables
5105 optimizations that may change the number of exceptions visible with
5106 signaling NaNs.  This option implies @option{-ftrapping-math}.
5108 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5109 be defined.
5111 The default is @option{-fno-signaling-nans}.
5113 This option is experimental and does not currently guarantee to
5114 disable all GCC optimizations that affect signaling NaN behavior.
5116 @item -fsingle-precision-constant
5117 @opindex fsingle-precision-constant
5118 Treat floating point constant as single precision constant instead of
5119 implicitly converting it to double precision constant.
5122 @end table
5124 The following options control optimizations that may improve
5125 performance, but are not enabled by any @option{-O} options.  This
5126 section includes experimental options that may produce broken code.
5128 @table @gcctabopt
5129 @item -fbranch-probabilities
5130 @opindex fbranch-probabilities
5131 After running a program compiled with @option{-fprofile-arcs}
5132 (@pxref{Debugging Options,, Options for Debugging Your Program or
5133 @command{gcc}}), you can compile it a second time using
5134 @option{-fbranch-probabilities}, to improve optimizations based on
5135 the number of times each branch was taken.  When the program
5136 compiled with @option{-fprofile-arcs} exits it saves arc execution
5137 counts to a file called @file{@var{sourcename}.gcda} for each source
5138 file  The information in this data file is very dependent on the
5139 structure of the generated code, so you must use the same source code
5140 and the same optimization options for both compilations.
5142 With @option{-fbranch-probabilities}, GCC puts a
5143 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5144 These can be used to improve optimization.  Currently, they are only
5145 used in one place: in @file{reorg.c}, instead of guessing which path a
5146 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5147 exactly determine which path is taken more often.
5149 @item -fprofile-values
5150 @opindex fprofile-values
5151 If combined with @option{-fprofile-arcs}, it adds code so that some
5152 data about values of expressions in the program is gathered.
5154 With @option{-fbranch-probabilities}, it reads back the data gathered
5155 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5156 notes to instructions for their later usage in optimizations.
5158 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5160 @item -fvpt
5161 @opindex fvpt
5162 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5163 a code to gather information about values of expressions.
5165 With @option{-fbranch-probabilities}, it reads back the data gathered
5166 and actually performs the optimizations based on them.
5167 Currently the optimizations include specialization of division operation
5168 using the knowledge about the value of the denominator.
5170 @item -fspeculative-prefetching
5171 @opindex fspeculative-prefetching
5172 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5173 a code to gather information about addresses of memory references in the
5174 program.
5176 With @option{-fbranch-probabilities}, it reads back the data gathered
5177 and issues prefetch instructions according to them.  In addition to the opportunities
5178 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5179 memory access patterns -- for example accesses to the data stored in linked
5180 list whose elements are usually allocated sequentially.
5182 In order to prevent issuing double prefetches, usage of
5183 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5185 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5187 @item -frename-registers
5188 @opindex frename-registers
5189 Attempt to avoid false dependencies in scheduled code by making use
5190 of registers left over after register allocation.  This optimization
5191 will most benefit processors with lots of registers.  Depending on the
5192 debug information format adopted by the target, however, it can
5193 make debugging impossible, since variables will no longer stay in
5194 a ``home register''.
5196 Not enabled by default at any level because it has known bugs.
5198 @item -fnew-ra
5199 @opindex fnew-ra
5200 Use a graph coloring register allocator.  Currently this option is meant
5201 for testing, so we are interested to hear about miscompilations with
5202 @option{-fnew-ra}.
5204 @item -ftracer
5205 @opindex ftracer
5206 Perform tail duplication to enlarge superblock size. This transformation
5207 simplifies the control flow of the function allowing other optimizations to do
5208 better job.
5210 Enabled with @option{-fprofile-use}.
5212 @item -funroll-loops
5213 @opindex funroll-loops
5214 Unroll loops whose number of iterations can be determined at compile time or
5215 upon entry to the loop.  @option{-funroll-loops} implies
5216 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5217 (i.e.@: complete removal of loops with small constant number of iterations).
5218 This option makes code larger, and may or may not make it run faster.
5220 Enabled with @option{-fprofile-use}.
5222 @item -funroll-all-loops
5223 @opindex funroll-all-loops
5224 Unroll all loops, even if their number of iterations is uncertain when
5225 the loop is entered.  This usually makes programs run more slowly.
5226 @option{-funroll-all-loops} implies the same options as
5227 @option{-funroll-loops}.
5229 @item -fpeel-loops
5230 @opindex fpeel-loops
5231 Peels the loops for that there is enough information that they do not
5232 roll much (from profile feedback).  It also turns on complete loop peeling
5233 (i.e.@: complete removal of loops with small constant number of iterations).
5235 Enabled with @option{-fprofile-use}.
5237 @item -fmove-loop-invariants
5238 @opindex fmove-loop-invariants
5239 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5240 at level @option{-O1}
5242 @item -funswitch-loops
5243 @opindex funswitch-loops
5244 Move branches with loop invariant conditions out of the loop, with duplicates
5245 of the loop on both branches (modified according to result of the condition).
5247 @item -fprefetch-loop-arrays
5248 @opindex fprefetch-loop-arrays
5249 If supported by the target machine, generate instructions to prefetch
5250 memory to improve the performance of loops that access large arrays.
5252 Disabled at level @option{-Os}.
5254 @item -ffunction-sections
5255 @itemx -fdata-sections
5256 @opindex ffunction-sections
5257 @opindex fdata-sections
5258 Place each function or data item into its own section in the output
5259 file if the target supports arbitrary sections.  The name of the
5260 function or the name of the data item determines the section's name
5261 in the output file.
5263 Use these options on systems where the linker can perform optimizations
5264 to improve locality of reference in the instruction space.  Most systems
5265 using the ELF object format and SPARC processors running Solaris 2 have
5266 linkers with such optimizations.  AIX may have these optimizations in
5267 the future.
5269 Only use these options when there are significant benefits from doing
5270 so.  When you specify these options, the assembler and linker will
5271 create larger object and executable files and will also be slower.
5272 You will not be able to use @code{gprof} on all systems if you
5273 specify this option and you may have problems with debugging if
5274 you specify both this option and @option{-g}.
5276 @item -fbranch-target-load-optimize
5277 @opindex fbranch-target-load-optimize
5278 Perform branch target register load optimization before prologue / epilogue
5279 threading.
5280 The use of target registers can typically be exposed only during reload,
5281 thus hoisting loads out of loops and doing inter-block scheduling needs
5282 a separate optimization pass.
5284 @item -fbranch-target-load-optimize2
5285 @opindex fbranch-target-load-optimize2
5286 Perform branch target register load optimization after prologue / epilogue
5287 threading.
5289 @item -fbtr-bb-exclusive
5290 @opindex fbtr-bb-exclusive
5291 When performing branch target register load optimization, don't reuse
5292 branch target registers in within any basic block.
5294 @item --param @var{name}=@var{value}
5295 @opindex param
5296 In some places, GCC uses various constants to control the amount of
5297 optimization that is done.  For example, GCC will not inline functions
5298 that contain more that a certain number of instructions.  You can
5299 control some of these constants on the command-line using the
5300 @option{--param} option.
5302 The names of specific parameters, and the meaning of the values, are
5303 tied to the internals of the compiler, and are subject to change
5304 without notice in future releases.
5306 In each case, the @var{value} is an integer.  The allowable choices for
5307 @var{name} are given in the following table:
5309 @table @gcctabopt
5310 @item max-crossjump-edges
5311 The maximum number of incoming edges to consider for crossjumping.
5312 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5313 the number of edges incoming to each block.  Increasing values mean
5314 more aggressive optimization, making the compile time increase with
5315 probably small improvement in executable size.
5317 @item min-crossjump-insns
5318 The minimum number of instructions which must be matched at the end
5319 of two blocks before crossjumping will be performed on them.  This
5320 value is ignored in the case where all instructions in the block being
5321 crossjumped from are matched.  The default value is 5.
5323 @item max-delay-slot-insn-search
5324 The maximum number of instructions to consider when looking for an
5325 instruction to fill a delay slot.  If more than this arbitrary number of
5326 instructions is searched, the time savings from filling the delay slot
5327 will be minimal so stop searching.  Increasing values mean more
5328 aggressive optimization, making the compile time increase with probably
5329 small improvement in executable run time.
5331 @item max-delay-slot-live-search
5332 When trying to fill delay slots, the maximum number of instructions to
5333 consider when searching for a block with valid live register
5334 information.  Increasing this arbitrarily chosen value means more
5335 aggressive optimization, increasing the compile time.  This parameter
5336 should be removed when the delay slot code is rewritten to maintain the
5337 control-flow graph.
5339 @item max-gcse-memory
5340 The approximate maximum amount of memory that will be allocated in
5341 order to perform the global common subexpression elimination
5342 optimization.  If more memory than specified is required, the
5343 optimization will not be done.
5345 @item max-gcse-passes
5346 The maximum number of passes of GCSE to run.  The default is 1.
5348 @item max-pending-list-length
5349 The maximum number of pending dependencies scheduling will allow
5350 before flushing the current state and starting over.  Large functions
5351 with few branches or calls can create excessively large lists which
5352 needlessly consume memory and resources.
5354 @item max-inline-insns-single
5355 Several parameters control the tree inliner used in gcc.
5356 This number sets the maximum number of instructions (counted in GCC's
5357 internal representation) in a single function that the tree inliner
5358 will consider for inlining.  This only affects functions declared
5359 inline and methods implemented in a class declaration (C++).
5360 The default value is 500.
5362 @item max-inline-insns-auto
5363 When you use @option{-finline-functions} (included in @option{-O3}),
5364 a lot of functions that would otherwise not be considered for inlining
5365 by the compiler will be investigated.  To those functions, a different
5366 (more restrictive) limit compared to functions declared inline can
5367 be applied.
5368 The default value is 120.
5370 @item large-function-insns
5371 The limit specifying really large functions.  For functions greater than this
5372 limit inlining is constrained by @option{--param large-function-growth}.
5373 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
5374 algorithms used by the backend.
5375 This parameter is ignored when @option{-funit-at-a-time} is not used.
5376 The default value is 3000.
5378 @item large-function-growth
5379 Specifies maximal growth of large function caused by inlining in percents.
5380 This parameter is ignored when @option{-funit-at-a-time} is not used.
5381 The default value is 200.
5383 @item inline-unit-growth
5384 Specifies maximal overall growth of the compilation unit caused by inlining.
5385 This parameter is ignored when @option{-funit-at-a-time} is not used.
5386 The default value is 150.
5388 @item max-inline-insns-recursive
5389 @itemx max-inline-insns-recursive-auto
5390 Specifies maximum number of instructions out-of-line copy of self recursive inline
5391 function can grow into by performing recursive inlining.
5393 For functions declared inline @option{--param max-inline-insns-recursive} is
5394 taken into acount.  For function not declared inline, recursive inlining
5395 happens only when @option{-finline-functions} (included in @option{-O3}) is
5396 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5397 default value is 500.
5399 @item max-inline-recursive-depth
5400 @itemx max-inline-recursive-depth-auto
5401 Specifies maximum recursion depth used by the recursive inlining.
5403 For functions declared inline @option{--param max-inline-recursive-depth} is
5404 taken into acount.  For function not declared inline, recursive inlining
5405 happens only when @option{-finline-functions} (included in @option{-O3}) is
5406 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5407 default value is 500.
5409 @item max-inline-insns-rtl
5410 For languages that use the RTL inliner (this happens at a later stage
5411 than tree inlining), you can set the maximum allowable size (counted
5412 in RTL instructions) for the RTL inliner with this parameter.
5413 The default value is 600.
5415 @item max-unrolled-insns
5416 The maximum number of instructions that a loop should have if that loop
5417 is unrolled, and if the loop is unrolled, it determines how many times
5418 the loop code is unrolled.
5420 @item max-average-unrolled-insns
5421 The maximum number of instructions biased by probabilities of their execution
5422 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5423 it determines how many times the loop code is unrolled.
5425 @item max-unroll-times
5426 The maximum number of unrollings of a single loop.
5428 @item max-peeled-insns
5429 The maximum number of instructions that a loop should have if that loop
5430 is peeled, and if the loop is peeled, it determines how many times
5431 the loop code is peeled.
5433 @item max-peel-times
5434 The maximum number of peelings of a single loop.
5436 @item max-completely-peeled-insns
5437 The maximum number of insns of a completely peeled loop.
5439 @item max-completely-peel-times
5440 The maximum number of iterations of a loop to be suitable for complete peeling.
5442 @item max-unswitch-insns
5443 The maximum number of insns of an unswitched loop.
5445 @item max-unswitch-level
5446 The maximum number of branches unswitched in a single loop.
5448 @item lim-expensive
5449 The minimum cost of an expensive expression in the loop invariant motion.
5451 @item iv-consider-all-candidates-bound
5452 Bound on number of candidates for induction variables below that
5453 all candidates are considered for each use in induction variable
5454 optimizations.  Only the most relevant candidates are considered
5455 if there are more candidates, to avoid quadratic time complexity.
5457 @item iv-max-considered-uses
5458 The induction variable optimizations give up on loops that contain more
5459 induction variable uses.
5461 @item max-iterations-to-track
5463 The maximum number of iterations of a loop the brute force algorithm
5464 for analysis of # of iterations of the loop tries to evaluate.
5466 @item hot-bb-count-fraction
5467 Select fraction of the maximal count of repetitions of basic block in program
5468 given basic block needs to have to be considered hot.
5470 @item hot-bb-frequency-fraction
5471 Select fraction of the maximal frequency of executions of basic block in
5472 function given basic block needs to have to be considered hot
5474 @item tracer-dynamic-coverage
5475 @itemx tracer-dynamic-coverage-feedback
5477 This value is used to limit superblock formation once the given percentage of
5478 executed instructions is covered.  This limits unnecessary code size
5479 expansion.
5481 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5482 feedback is available.  The real profiles (as opposed to statically estimated
5483 ones) are much less balanced allowing the threshold to be larger value.
5485 @item tracer-max-code-growth
5486 Stop tail duplication once code growth has reached given percentage.  This is
5487 rather hokey argument, as most of the duplicates will be eliminated later in
5488 cross jumping, so it may be set to much higher values than is the desired code
5489 growth.
5491 @item tracer-min-branch-ratio
5493 Stop reverse growth when the reverse probability of best edge is less than this
5494 threshold (in percent).
5496 @item tracer-min-branch-ratio
5497 @itemx tracer-min-branch-ratio-feedback
5499 Stop forward growth if the best edge do have probability lower than this
5500 threshold.
5502 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5503 compilation for profile feedback and one for compilation without.  The value
5504 for compilation with profile feedback needs to be more conservative (higher) in
5505 order to make tracer effective.
5507 @item max-cse-path-length
5509 Maximum number of basic blocks on path that cse considers.  The default is 10.
5511 @item global-var-threshold
5513 Counts the number of function calls (N) and the number of
5514 call-clobbered variables (V).  If NxV is larger than this limit, a
5515 single artificial variable will be created to represent all the
5516 call-clobbered variables at function call sites.  This artificial
5517 variable will then be made to alias every call-clobbered variable.
5518 (done as int * size_t on the host machine; beware overflow).
5520 @item max-aliased-vops
5522 Maximum number of virtual operands allowed to represent aliases
5523 before triggering the alias grouping heuristic.  Alias grouping
5524 reduces compile times and memory consumption needed for aliasing at
5525 the expense of precision loss in alias information.
5527 @item ggc-min-expand
5529 GCC uses a garbage collector to manage its own memory allocation.  This
5530 parameter specifies the minimum percentage by which the garbage
5531 collector's heap should be allowed to expand between collections.
5532 Tuning this may improve compilation speed; it has no effect on code
5533 generation.
5535 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5536 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
5537 the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS.  If
5538 GCC is not able to calculate RAM on a particular platform, the lower
5539 bound of 30% is used.  Setting this parameter and
5540 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5541 every opportunity.  This is extremely slow, but can be useful for
5542 debugging.
5544 @item ggc-min-heapsize
5546 Minimum size of the garbage collector's heap before it begins bothering
5547 to collect garbage.  The first collection occurs after the heap expands
5548 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5549 tuning this may improve compilation speed, and has no effect on code
5550 generation.
5552 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5553 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5554 with a lower bound of 4096 (four megabytes) and an upper bound of
5555 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5556 particular platform, the lower bound is used.  Setting this parameter
5557 very large effectively disables garbage collection.  Setting this
5558 parameter and @option{ggc-min-expand} to zero causes a full collection
5559 to occur at every opportunity.
5561 @item max-reload-search-insns
5562 The maximum number of instruction reload should look backward for equivalent
5563 register.  Increasing values mean more aggressive optimization, making the
5564 compile time increase with probably slightly better performance.  The default
5565 value is 100.
5567 @item max-cselib-memory-location
5568 The maximum number of memory locations cselib should take into acount.
5569 Increasing values mean more aggressive optimization, making the compile time
5570 increase with probably slightly better performance.  The default value is 500.
5572 @item reorder-blocks-duplicate
5573 @itemx reorder-blocks-duplicate-feedback
5575 Used by basic block reordering pass to decide whether to use unconditional
5576 branch or duplicate the code on its destination.  Code is duplicated when its
5577 estimated size is smaller than this value multiplied by the estimated size of
5578 unconditional jump in the hot spots of the program.
5580 The @option{reorder-block-duplicate-feedback} is used only when profile
5581 feedback is available and may be set to higher values than
5582 @option{reorder-block-duplicate} since information about the hot spots is more
5583 accurate.
5585 @item max-sched-region-blocks
5586 The maximum number of blocks in a region to be considered for
5587 interblock scheduling.  The default value is 10.
5589 @item max-sched-region-insns
5590 The maximum number of insns in a region to be considered for
5591 interblock scheduling.  The default value is 100.
5593 @item integer-share-limit
5594 Small integer constants can use a shared data structure, reducing the
5595 compiler's memory usage and increasing its speed.  This sets the maximum
5596 value of a shared integer constant's.  The default value is 256.
5598 @end table
5599 @end table
5601 @node Preprocessor Options
5602 @section Options Controlling the Preprocessor
5603 @cindex preprocessor options
5604 @cindex options, preprocessor
5606 These options control the C preprocessor, which is run on each C source
5607 file before actual compilation.
5609 If you use the @option{-E} option, nothing is done except preprocessing.
5610 Some of these options make sense only together with @option{-E} because
5611 they cause the preprocessor output to be unsuitable for actual
5612 compilation.
5614 @table @gcctabopt
5615 @opindex Wp
5616 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5617 and pass @var{option} directly through to the preprocessor.  If
5618 @var{option} contains commas, it is split into multiple options at the
5619 commas.  However, many options are modified, translated or interpreted
5620 by the compiler driver before being passed to the preprocessor, and
5621 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5622 interface is undocumented and subject to change, so whenever possible
5623 you should avoid using @option{-Wp} and let the driver handle the
5624 options instead.
5626 @item -Xpreprocessor @var{option}
5627 @opindex preprocessor
5628 Pass @var{option} as an option to the preprocessor.  You can use this to
5629 supply system-specific preprocessor options which GCC does not know how to
5630 recognize.
5632 If you want to pass an option that takes an argument, you must use
5633 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5634 @end table
5636 @include cppopts.texi
5638 @node Assembler Options
5639 @section Passing Options to the Assembler
5641 @c prevent bad page break with this line
5642 You can pass options to the assembler.
5644 @table @gcctabopt
5645 @item -Wa,@var{option}
5646 @opindex Wa
5647 Pass @var{option} as an option to the assembler.  If @var{option}
5648 contains commas, it is split into multiple options at the commas.
5650 @item -Xassembler @var{option}
5651 @opindex Xassembler
5652 Pass @var{option} as an option to the assembler.  You can use this to
5653 supply system-specific assembler options which GCC does not know how to
5654 recognize.
5656 If you want to pass an option that takes an argument, you must use
5657 @option{-Xassembler} twice, once for the option and once for the argument.
5659 @end table
5661 @node Link Options
5662 @section Options for Linking
5663 @cindex link options
5664 @cindex options, linking
5666 These options come into play when the compiler links object files into
5667 an executable output file.  They are meaningless if the compiler is
5668 not doing a link step.
5670 @table @gcctabopt
5671 @cindex file names
5672 @item @var{object-file-name}
5673 A file name that does not end in a special recognized suffix is
5674 considered to name an object file or library.  (Object files are
5675 distinguished from libraries by the linker according to the file
5676 contents.)  If linking is done, these object files are used as input
5677 to the linker.
5679 @item -c
5680 @itemx -S
5681 @itemx -E
5682 @opindex c
5683 @opindex S
5684 @opindex E
5685 If any of these options is used, then the linker is not run, and
5686 object file names should not be used as arguments.  @xref{Overall
5687 Options}.
5689 @cindex Libraries
5690 @item -l@var{library}
5691 @itemx -l @var{library}
5692 @opindex l
5693 Search the library named @var{library} when linking.  (The second
5694 alternative with the library as a separate argument is only for
5695 POSIX compliance and is not recommended.)
5697 It makes a difference where in the command you write this option; the
5698 linker searches and processes libraries and object files in the order they
5699 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5700 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5701 to functions in @samp{z}, those functions may not be loaded.
5703 The linker searches a standard list of directories for the library,
5704 which is actually a file named @file{lib@var{library}.a}.  The linker
5705 then uses this file as if it had been specified precisely by name.
5707 The directories searched include several standard system directories
5708 plus any that you specify with @option{-L}.
5710 Normally the files found this way are library files---archive files
5711 whose members are object files.  The linker handles an archive file by
5712 scanning through it for members which define symbols that have so far
5713 been referenced but not defined.  But if the file that is found is an
5714 ordinary object file, it is linked in the usual fashion.  The only
5715 difference between using an @option{-l} option and specifying a file name
5716 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5717 and searches several directories.
5719 @item -lobjc
5720 @opindex lobjc
5721 You need this special case of the @option{-l} option in order to
5722 link an Objective-C or Objective-C++ program.
5724 @item -nostartfiles
5725 @opindex nostartfiles
5726 Do not use the standard system startup files when linking.
5727 The standard system libraries are used normally, unless @option{-nostdlib}
5728 or @option{-nodefaultlibs} is used.
5730 @item -nodefaultlibs
5731 @opindex nodefaultlibs
5732 Do not use the standard system libraries when linking.
5733 Only the libraries you specify will be passed to the linker.
5734 The standard startup files are used normally, unless @option{-nostartfiles}
5735 is used.  The compiler may generate calls to @code{memcmp},
5736 @code{memset}, @code{memcpy} and @code{memmove}.
5737 These entries are usually resolved by entries in
5738 libc.  These entry points should be supplied through some other
5739 mechanism when this option is specified.
5741 @item -nostdlib
5742 @opindex nostdlib
5743 Do not use the standard system startup files or libraries when linking.
5744 No startup files and only the libraries you specify will be passed to
5745 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5746 @code{memcpy} and @code{memmove}.
5747 These entries are usually resolved by entries in
5748 libc.  These entry points should be supplied through some other
5749 mechanism when this option is specified.
5751 @cindex @option{-lgcc}, use with @option{-nostdlib}
5752 @cindex @option{-nostdlib} and unresolved references
5753 @cindex unresolved references and @option{-nostdlib}
5754 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5755 @cindex @option{-nodefaultlibs} and unresolved references
5756 @cindex unresolved references and @option{-nodefaultlibs}
5757 One of the standard libraries bypassed by @option{-nostdlib} and
5758 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5759 that GCC uses to overcome shortcomings of particular machines, or special
5760 needs for some languages.
5761 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5762 Collection (GCC) Internals},
5763 for more discussion of @file{libgcc.a}.)
5764 In most cases, you need @file{libgcc.a} even when you want to avoid
5765 other standard libraries.  In other words, when you specify @option{-nostdlib}
5766 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5767 This ensures that you have no unresolved references to internal GCC
5768 library subroutines.  (For example, @samp{__main}, used to ensure C++
5769 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5770 GNU Compiler Collection (GCC) Internals}.)
5772 @item -pie
5773 @opindex pie
5774 Produce a position independent executable on targets which support it.
5775 For predictable results, you must also specify the same set of options
5776 that were used to generate code (@option{-fpie}, @option{-fPIE},
5777 or model suboptions) when you specify this option.
5779 @item -s
5780 @opindex s
5781 Remove all symbol table and relocation information from the executable.
5783 @item -static
5784 @opindex static
5785 On systems that support dynamic linking, this prevents linking with the shared
5786 libraries.  On other systems, this option has no effect.
5788 @item -shared
5789 @opindex shared
5790 Produce a shared object which can then be linked with other objects to
5791 form an executable.  Not all systems support this option.  For predictable
5792 results, you must also specify the same set of options that were used to
5793 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5794 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5795 needs to build supplementary stub code for constructors to work.  On
5796 multi-libbed systems, @samp{gcc -shared} must select the correct support
5797 libraries to link against.  Failing to supply the correct flags may lead
5798 to subtle defects.  Supplying them in cases where they are not necessary
5799 is innocuous.}
5801 @item -shared-libgcc
5802 @itemx -static-libgcc
5803 @opindex shared-libgcc
5804 @opindex static-libgcc
5805 On systems that provide @file{libgcc} as a shared library, these options
5806 force the use of either the shared or static version respectively.
5807 If no shared version of @file{libgcc} was built when the compiler was
5808 configured, these options have no effect.
5810 There are several situations in which an application should use the
5811 shared @file{libgcc} instead of the static version.  The most common
5812 of these is when the application wishes to throw and catch exceptions
5813 across different shared libraries.  In that case, each of the libraries
5814 as well as the application itself should use the shared @file{libgcc}.
5816 Therefore, the G++ and GCJ drivers automatically add
5817 @option{-shared-libgcc} whenever you build a shared library or a main
5818 executable, because C++ and Java programs typically use exceptions, so
5819 this is the right thing to do.
5821 If, instead, you use the GCC driver to create shared libraries, you may
5822 find that they will not always be linked with the shared @file{libgcc}.
5823 If GCC finds, at its configuration time, that you have a non-GNU linker
5824 or a GNU linker that does not support option @option{--eh-frame-hdr},
5825 it will link the shared version of @file{libgcc} into shared libraries
5826 by default.  Otherwise, it will take advantage of the linker and optimize
5827 away the linking with the shared version of @file{libgcc}, linking with
5828 the static version of libgcc by default.  This allows exceptions to
5829 propagate through such shared libraries, without incurring relocation
5830 costs at library load time.
5832 However, if a library or main executable is supposed to throw or catch
5833 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5834 for the languages used in the program, or using the option
5835 @option{-shared-libgcc}, such that it is linked with the shared
5836 @file{libgcc}.
5838 @item -symbolic
5839 @opindex symbolic
5840 Bind references to global symbols when building a shared object.  Warn
5841 about any unresolved references (unless overridden by the link editor
5842 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5843 this option.
5845 @item -Xlinker @var{option}
5846 @opindex Xlinker
5847 Pass @var{option} as an option to the linker.  You can use this to
5848 supply system-specific linker options which GCC does not know how to
5849 recognize.
5851 If you want to pass an option that takes an argument, you must use
5852 @option{-Xlinker} twice, once for the option and once for the argument.
5853 For example, to pass @option{-assert definitions}, you must write
5854 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5855 @option{-Xlinker "-assert definitions"}, because this passes the entire
5856 string as a single argument, which is not what the linker expects.
5858 @item -Wl,@var{option}
5859 @opindex Wl
5860 Pass @var{option} as an option to the linker.  If @var{option} contains
5861 commas, it is split into multiple options at the commas.
5863 @item -u @var{symbol}
5864 @opindex u
5865 Pretend the symbol @var{symbol} is undefined, to force linking of
5866 library modules to define it.  You can use @option{-u} multiple times with
5867 different symbols to force loading of additional library modules.
5868 @end table
5870 @node Directory Options
5871 @section Options for Directory Search
5872 @cindex directory options
5873 @cindex options, directory search
5874 @cindex search path
5876 These options specify directories to search for header files, for
5877 libraries and for parts of the compiler:
5879 @table @gcctabopt
5880 @item -I@var{dir}
5881 @opindex I
5882 Add the directory @var{dir} to the head of the list of directories to be
5883 searched for header files.  This can be used to override a system header
5884 file, substituting your own version, since these directories are
5885 searched before the system header file directories.  However, you should
5886 not use this option to add directories that contain vendor-supplied
5887 system header files (use @option{-isystem} for that).  If you use more than
5888 one @option{-I} option, the directories are scanned in left-to-right
5889 order; the standard system directories come after.
5891 If a standard system include directory, or a directory specified with
5892 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5893 option will be ignored.  The directory will still be searched but as a
5894 system directory at its normal position in the system include chain.
5895 This is to ensure that GCC's procedure to fix buggy system headers and
5896 the ordering for the include_next directive are not inadvertently changed.
5897 If you really need to change the search order for system directories,
5898 use the @option{-nostdinc} and/or @option{-isystem} options.
5900 @item -iquote@var{dir}
5901 @opindex iquote
5902 Add the directory @var{dir} to the head of the list of directories to
5903 be searched for header files only for the case of @samp{#include
5904 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5905 otherwise just like @option{-I}.
5907 @item -L@var{dir}
5908 @opindex L
5909 Add directory @var{dir} to the list of directories to be searched
5910 for @option{-l}.
5912 @item -B@var{prefix}
5913 @opindex B
5914 This option specifies where to find the executables, libraries,
5915 include files, and data files of the compiler itself.
5917 The compiler driver program runs one or more of the subprograms
5918 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5919 @var{prefix} as a prefix for each program it tries to run, both with and
5920 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5922 For each subprogram to be run, the compiler driver first tries the
5923 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5924 was not specified, the driver tries two standard prefixes, which are
5925 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5926 those results in a file name that is found, the unmodified program
5927 name is searched for using the directories specified in your
5928 @env{PATH} environment variable.
5930 The compiler will check to see if the path provided by the @option{-B}
5931 refers to a directory, and if necessary it will add a directory
5932 separator character at the end of the path.
5934 @option{-B} prefixes that effectively specify directory names also apply
5935 to libraries in the linker, because the compiler translates these
5936 options into @option{-L} options for the linker.  They also apply to
5937 includes files in the preprocessor, because the compiler translates these
5938 options into @option{-isystem} options for the preprocessor.  In this case,
5939 the compiler appends @samp{include} to the prefix.
5941 The run-time support file @file{libgcc.a} can also be searched for using
5942 the @option{-B} prefix, if needed.  If it is not found there, the two
5943 standard prefixes above are tried, and that is all.  The file is left
5944 out of the link if it is not found by those means.
5946 Another way to specify a prefix much like the @option{-B} prefix is to use
5947 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5948 Variables}.
5950 As a special kludge, if the path provided by @option{-B} is
5951 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5952 9, then it will be replaced by @file{[dir/]include}.  This is to help
5953 with boot-strapping the compiler.
5955 @item -specs=@var{file}
5956 @opindex specs
5957 Process @var{file} after the compiler reads in the standard @file{specs}
5958 file, in order to override the defaults that the @file{gcc} driver
5959 program uses when determining what switches to pass to @file{cc1},
5960 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5961 @option{-specs=@var{file}} can be specified on the command line, and they
5962 are processed in order, from left to right.
5964 @item -I-
5965 @opindex I-
5966 This option has been deprecated.  Please use @option{-iquote} instead for
5967 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5968 Any directories you specify with @option{-I} options before the @option{-I-}
5969 option are searched only for the case of @samp{#include "@var{file}"};
5970 they are not searched for @samp{#include <@var{file}>}.
5972 If additional directories are specified with @option{-I} options after
5973 the @option{-I-}, these directories are searched for all @samp{#include}
5974 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5975 this way.)
5977 In addition, the @option{-I-} option inhibits the use of the current
5978 directory (where the current input file came from) as the first search
5979 directory for @samp{#include "@var{file}"}.  There is no way to
5980 override this effect of @option{-I-}.  With @option{-I.} you can specify
5981 searching the directory which was current when the compiler was
5982 invoked.  That is not exactly the same as what the preprocessor does
5983 by default, but it is often satisfactory.
5985 @option{-I-} does not inhibit the use of the standard system directories
5986 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5987 independent.
5988 @end table
5990 @c man end
5992 @node Spec Files
5993 @section Specifying subprocesses and the switches to pass to them
5994 @cindex Spec Files
5996 @command{gcc} is a driver program.  It performs its job by invoking a
5997 sequence of other programs to do the work of compiling, assembling and
5998 linking.  GCC interprets its command-line parameters and uses these to
5999 deduce which programs it should invoke, and which command-line options
6000 it ought to place on their command lines.  This behavior is controlled
6001 by @dfn{spec strings}.  In most cases there is one spec string for each
6002 program that GCC can invoke, but a few programs have multiple spec
6003 strings to control their behavior.  The spec strings built into GCC can
6004 be overridden by using the @option{-specs=} command-line switch to specify
6005 a spec file.
6007 @dfn{Spec files} are plaintext files that are used to construct spec
6008 strings.  They consist of a sequence of directives separated by blank
6009 lines.  The type of directive is determined by the first non-whitespace
6010 character on the line and it can be one of the following:
6012 @table @code
6013 @item %@var{command}
6014 Issues a @var{command} to the spec file processor.  The commands that can
6015 appear here are:
6017 @table @code
6018 @item %include <@var{file}>
6019 @cindex %include
6020 Search for @var{file} and insert its text at the current point in the
6021 specs file.
6023 @item %include_noerr <@var{file}>
6024 @cindex %include_noerr
6025 Just like @samp{%include}, but do not generate an error message if the include
6026 file cannot be found.
6028 @item %rename @var{old_name} @var{new_name}
6029 @cindex %rename
6030 Rename the spec string @var{old_name} to @var{new_name}.
6032 @end table
6034 @item *[@var{spec_name}]:
6035 This tells the compiler to create, override or delete the named spec
6036 string.  All lines after this directive up to the next directive or
6037 blank line are considered to be the text for the spec string.  If this
6038 results in an empty string then the spec will be deleted.  (Or, if the
6039 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6040 does not currently exist a new spec will be created.  If the spec does
6041 exist then its contents will be overridden by the text of this
6042 directive, unless the first character of that text is the @samp{+}
6043 character, in which case the text will be appended to the spec.
6045 @item [@var{suffix}]:
6046 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6047 and up to the next directive or blank line are considered to make up the
6048 spec string for the indicated suffix.  When the compiler encounters an
6049 input file with the named suffix, it will processes the spec string in
6050 order to work out how to compile that file.  For example:
6052 @smallexample
6053 .ZZ:
6054 z-compile -input %i
6055 @end smallexample
6057 This says that any input file whose name ends in @samp{.ZZ} should be
6058 passed to the program @samp{z-compile}, which should be invoked with the
6059 command-line switch @option{-input} and with the result of performing the
6060 @samp{%i} substitution.  (See below.)
6062 As an alternative to providing a spec string, the text that follows a
6063 suffix directive can be one of the following:
6065 @table @code
6066 @item @@@var{language}
6067 This says that the suffix is an alias for a known @var{language}.  This is
6068 similar to using the @option{-x} command-line switch to GCC to specify a
6069 language explicitly.  For example:
6071 @smallexample
6072 .ZZ:
6073 @@c++
6074 @end smallexample
6076 Says that .ZZ files are, in fact, C++ source files.
6078 @item #@var{name}
6079 This causes an error messages saying:
6081 @smallexample
6082 @var{name} compiler not installed on this system.
6083 @end smallexample
6084 @end table
6086 GCC already has an extensive list of suffixes built into it.
6087 This directive will add an entry to the end of the list of suffixes, but
6088 since the list is searched from the end backwards, it is effectively
6089 possible to override earlier entries using this technique.
6091 @end table
6093 GCC has the following spec strings built into it.  Spec files can
6094 override these strings or create their own.  Note that individual
6095 targets can also add their own spec strings to this list.
6097 @smallexample
6098 asm          Options to pass to the assembler
6099 asm_final    Options to pass to the assembler post-processor
6100 cpp          Options to pass to the C preprocessor
6101 cc1          Options to pass to the C compiler
6102 cc1plus      Options to pass to the C++ compiler
6103 endfile      Object files to include at the end of the link
6104 link         Options to pass to the linker
6105 lib          Libraries to include on the command line to the linker
6106 libgcc       Decides which GCC support library to pass to the linker
6107 linker       Sets the name of the linker
6108 predefines   Defines to be passed to the C preprocessor
6109 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6110              by default
6111 startfile    Object files to include at the start of the link
6112 @end smallexample
6114 Here is a small example of a spec file:
6116 @smallexample
6117 %rename lib                 old_lib
6119 *lib:
6120 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6121 @end smallexample
6123 This example renames the spec called @samp{lib} to @samp{old_lib} and
6124 then overrides the previous definition of @samp{lib} with a new one.
6125 The new definition adds in some extra command-line options before
6126 including the text of the old definition.
6128 @dfn{Spec strings} are a list of command-line options to be passed to their
6129 corresponding program.  In addition, the spec strings can contain
6130 @samp{%}-prefixed sequences to substitute variable text or to
6131 conditionally insert text into the command line.  Using these constructs
6132 it is possible to generate quite complex command lines.
6134 Here is a table of all defined @samp{%}-sequences for spec
6135 strings.  Note that spaces are not generated automatically around the
6136 results of expanding these sequences.  Therefore you can concatenate them
6137 together or combine them with constant text in a single argument.
6139 @table @code
6140 @item %%
6141 Substitute one @samp{%} into the program name or argument.
6143 @item %i
6144 Substitute the name of the input file being processed.
6146 @item %b
6147 Substitute the basename of the input file being processed.
6148 This is the substring up to (and not including) the last period
6149 and not including the directory.
6151 @item %B
6152 This is the same as @samp{%b}, but include the file suffix (text after
6153 the last period).
6155 @item %d
6156 Marks the argument containing or following the @samp{%d} as a
6157 temporary file name, so that that file will be deleted if GCC exits
6158 successfully.  Unlike @samp{%g}, this contributes no text to the
6159 argument.
6161 @item %g@var{suffix}
6162 Substitute a file name that has suffix @var{suffix} and is chosen
6163 once per compilation, and mark the argument in the same way as
6164 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6165 name is now chosen in a way that is hard to predict even when previously
6166 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6167 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6168 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6169 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6170 was simply substituted with a file name chosen once per compilation,
6171 without regard to any appended suffix (which was therefore treated
6172 just like ordinary text), making such attacks more likely to succeed.
6174 @item %u@var{suffix}
6175 Like @samp{%g}, but generates a new temporary file name even if
6176 @samp{%u@var{suffix}} was already seen.
6178 @item %U@var{suffix}
6179 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6180 new one if there is no such last file name.  In the absence of any
6181 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6182 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6183 would involve the generation of two distinct file names, one
6184 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6185 simply substituted with a file name chosen for the previous @samp{%u},
6186 without regard to any appended suffix.
6188 @item %j@var{suffix}
6189 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6190 writable, and if save-temps is off; otherwise, substitute the name
6191 of a temporary file, just like @samp{%u}.  This temporary file is not
6192 meant for communication between processes, but rather as a junk
6193 disposal mechanism.
6195 @item %|@var{suffix}
6196 @itemx %m@var{suffix}
6197 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6198 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6199 all.  These are the two most common ways to instruct a program that it
6200 should read from standard input or write to standard output.  If you
6201 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6202 construct: see for example @file{f/lang-specs.h}.
6204 @item %.@var{SUFFIX}
6205 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6206 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6207 terminated by the next space or %.
6209 @item %w
6210 Marks the argument containing or following the @samp{%w} as the
6211 designated output file of this compilation.  This puts the argument
6212 into the sequence of arguments that @samp{%o} will substitute later.
6214 @item %o
6215 Substitutes the names of all the output files, with spaces
6216 automatically placed around them.  You should write spaces
6217 around the @samp{%o} as well or the results are undefined.
6218 @samp{%o} is for use in the specs for running the linker.
6219 Input files whose names have no recognized suffix are not compiled
6220 at all, but they are included among the output files, so they will
6221 be linked.
6223 @item %O
6224 Substitutes the suffix for object files.  Note that this is
6225 handled specially when it immediately follows @samp{%g, %u, or %U},
6226 because of the need for those to form complete file names.  The
6227 handling is such that @samp{%O} is treated exactly as if it had already
6228 been substituted, except that @samp{%g, %u, and %U} do not currently
6229 support additional @var{suffix} characters following @samp{%O} as they would
6230 following, for example, @samp{.o}.
6232 @item %p
6233 Substitutes the standard macro predefinitions for the
6234 current target machine.  Use this when running @code{cpp}.
6236 @item %P
6237 Like @samp{%p}, but puts @samp{__} before and after the name of each
6238 predefined macro, except for macros that start with @samp{__} or with
6239 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6242 @item %I
6243 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6244 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6245 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6246 as necessary.
6248 @item %s
6249 Current argument is the name of a library or startup file of some sort.
6250 Search for that file in a standard list of directories and substitute
6251 the full name found.
6253 @item %e@var{str}
6254 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6255 Use this when inconsistent options are detected.
6257 @item %(@var{name})
6258 Substitute the contents of spec string @var{name} at this point.
6260 @item %[@var{name}]
6261 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6263 @item %x@{@var{option}@}
6264 Accumulate an option for @samp{%X}.
6266 @item %X
6267 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6268 spec string.
6270 @item %Y
6271 Output the accumulated assembler options specified by @option{-Wa}.
6273 @item %Z
6274 Output the accumulated preprocessor options specified by @option{-Wp}.
6276 @item %a
6277 Process the @code{asm} spec.  This is used to compute the
6278 switches to be passed to the assembler.
6280 @item %A
6281 Process the @code{asm_final} spec.  This is a spec string for
6282 passing switches to an assembler post-processor, if such a program is
6283 needed.
6285 @item %l
6286 Process the @code{link} spec.  This is the spec for computing the
6287 command line passed to the linker.  Typically it will make use of the
6288 @samp{%L %G %S %D and %E} sequences.
6290 @item %D
6291 Dump out a @option{-L} option for each directory that GCC believes might
6292 contain startup files.  If the target supports multilibs then the
6293 current multilib directory will be prepended to each of these paths.
6295 @item %M
6296 Output the multilib directory with directory separators replaced with
6297 @samp{_}.  If multilib directories are not set, or the multilib directory is
6298 @file{.} then this option emits nothing.
6300 @item %L
6301 Process the @code{lib} spec.  This is a spec string for deciding which
6302 libraries should be included on the command line to the linker.
6304 @item %G
6305 Process the @code{libgcc} spec.  This is a spec string for deciding
6306 which GCC support library should be included on the command line to the linker.
6308 @item %S
6309 Process the @code{startfile} spec.  This is a spec for deciding which
6310 object files should be the first ones passed to the linker.  Typically
6311 this might be a file named @file{crt0.o}.
6313 @item %E
6314 Process the @code{endfile} spec.  This is a spec string that specifies
6315 the last object files that will be passed to the linker.
6317 @item %C
6318 Process the @code{cpp} spec.  This is used to construct the arguments
6319 to be passed to the C preprocessor.
6321 @item %1
6322 Process the @code{cc1} spec.  This is used to construct the options to be
6323 passed to the actual C compiler (@samp{cc1}).
6325 @item %2
6326 Process the @code{cc1plus} spec.  This is used to construct the options to be
6327 passed to the actual C++ compiler (@samp{cc1plus}).
6329 @item %*
6330 Substitute the variable part of a matched option.  See below.
6331 Note that each comma in the substituted string is replaced by
6332 a single space.
6334 @item %<@code{S}
6335 Remove all occurrences of @code{-S} from the command line.  Note---this
6336 command is position dependent.  @samp{%} commands in the spec string
6337 before this one will see @code{-S}, @samp{%} commands in the spec string
6338 after this one will not.
6340 @item %:@var{function}(@var{args})
6341 Call the named function @var{function}, passing it @var{args}.
6342 @var{args} is first processed as a nested spec string, then split
6343 into an argument vector in the usual fashion.  The function returns
6344 a string which is processed as if it had appeared literally as part
6345 of the current spec.
6347 The following built-in spec functions are provided:
6349 @table @code
6350 @item @code{if-exists}
6351 The @code{if-exists} spec function takes one argument, an absolute
6352 pathname to a file.  If the file exists, @code{if-exists} returns the
6353 pathname.  Here is a small example of its usage:
6355 @smallexample
6356 *startfile:
6357 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6358 @end smallexample
6360 @item @code{if-exists-else}
6361 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6362 spec function, except that it takes two arguments.  The first argument is
6363 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6364 returns the pathname.  If it does not exist, it returns the second argument.
6365 This way, @code{if-exists-else} can be used to select one file or another,
6366 based on the existence of the first.  Here is a small example of its usage:
6368 @smallexample
6369 *startfile:
6370 crt0%O%s %:if-exists(crti%O%s) \
6371 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6372 @end smallexample
6374 @item @code{replace-outfile}
6375 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6376 first argument in the outfiles array and replaces it with the second argument.  Here
6377 is a small example of its usage:
6379 @smallexample
6380 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6381 @end smallexample
6383 @end table
6385 @item %@{@code{S}@}
6386 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6387 If that switch was not specified, this substitutes nothing.  Note that
6388 the leading dash is omitted when specifying this option, and it is
6389 automatically inserted if the substitution is performed.  Thus the spec
6390 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6391 and would output the command line option @option{-foo}.
6393 @item %W@{@code{S}@}
6394 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6395 deleted on failure.
6397 @item %@{@code{S}*@}
6398 Substitutes all the switches specified to GCC whose names start
6399 with @code{-S}, but which also take an argument.  This is used for
6400 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6401 GCC considers @option{-o foo} as being
6402 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6403 text, including the space.  Thus two arguments would be generated.
6405 @item %@{@code{S}*&@code{T}*@}
6406 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6407 (the order of @code{S} and @code{T} in the spec is not significant).
6408 There can be any number of ampersand-separated variables; for each the
6409 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6411 @item %@{@code{S}:@code{X}@}
6412 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6414 @item %@{!@code{S}:@code{X}@}
6415 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6417 @item %@{@code{S}*:@code{X}@}
6418 Substitutes @code{X} if one or more switches whose names start with
6419 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6420 once, no matter how many such switches appeared.  However, if @code{%*}
6421 appears somewhere in @code{X}, then @code{X} will be substituted once
6422 for each matching switch, with the @code{%*} replaced by the part of
6423 that switch that matched the @code{*}.
6425 @item %@{.@code{S}:@code{X}@}
6426 Substitutes @code{X}, if processing a file with suffix @code{S}.
6428 @item %@{!.@code{S}:@code{X}@}
6429 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6431 @item %@{@code{S}|@code{P}:@code{X}@}
6432 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6433 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6434 although they have a stronger binding than the @samp{|}.  If @code{%*}
6435 appears in @code{X}, all of the alternatives must be starred, and only
6436 the first matching alternative is substituted.
6438 For example, a spec string like this:
6440 @smallexample
6441 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6442 @end smallexample
6444 will output the following command-line options from the following input
6445 command-line options:
6447 @smallexample
6448 fred.c        -foo -baz
6449 jim.d         -bar -boggle
6450 -d fred.c     -foo -baz -boggle
6451 -d jim.d      -bar -baz -boggle
6452 @end smallexample
6454 @item %@{S:X; T:Y; :D@}
6456 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6457 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6458 be as many clauses as you need.  This may be combined with @code{.},
6459 @code{!}, @code{|}, and @code{*} as needed.
6462 @end table
6464 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6465 construct may contain other nested @samp{%} constructs or spaces, or
6466 even newlines.  They are processed as usual, as described above.
6467 Trailing white space in @code{X} is ignored.  White space may also
6468 appear anywhere on the left side of the colon in these constructs,
6469 except between @code{.} or @code{*} and the corresponding word.
6471 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6472 handled specifically in these constructs.  If another value of
6473 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6474 @option{-W} switch is found later in the command line, the earlier
6475 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6476 just one letter, which passes all matching options.
6478 The character @samp{|} at the beginning of the predicate text is used to
6479 indicate that a command should be piped to the following command, but
6480 only if @option{-pipe} is specified.
6482 It is built into GCC which switches take arguments and which do not.
6483 (You might think it would be useful to generalize this to allow each
6484 compiler's spec to say which switches take arguments.  But this cannot
6485 be done in a consistent fashion.  GCC cannot even decide which input
6486 files have been specified without knowing which switches take arguments,
6487 and it must know which input files to compile in order to tell which
6488 compilers to run).
6490 GCC also knows implicitly that arguments starting in @option{-l} are to be
6491 treated as compiler output files, and passed to the linker in their
6492 proper position among the other output files.
6494 @c man begin OPTIONS
6496 @node Target Options
6497 @section Specifying Target Machine and Compiler Version
6498 @cindex target options
6499 @cindex cross compiling
6500 @cindex specifying machine version
6501 @cindex specifying compiler version and target machine
6502 @cindex compiler version, specifying
6503 @cindex target machine, specifying
6505 The usual way to run GCC is to run the executable called @file{gcc}, or
6506 @file{<machine>-gcc} when cross-compiling, or
6507 @file{<machine>-gcc-<version>} to run a version other than the one that
6508 was installed last.  Sometimes this is inconvenient, so GCC provides
6509 options that will switch to another cross-compiler or version.
6511 @table @gcctabopt
6512 @item -b @var{machine}
6513 @opindex b
6514 The argument @var{machine} specifies the target machine for compilation.
6516 The value to use for @var{machine} is the same as was specified as the
6517 machine type when configuring GCC as a cross-compiler.  For
6518 example, if a cross-compiler was configured with @samp{configure
6519 i386v}, meaning to compile for an 80386 running System V, then you
6520 would specify @option{-b i386v} to run that cross compiler.
6522 @item -V @var{version}
6523 @opindex V
6524 The argument @var{version} specifies which version of GCC to run.
6525 This is useful when multiple versions are installed.  For example,
6526 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6527 @end table
6529 The @option{-V} and @option{-b} options work by running the
6530 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6531 use them if you can just run that directly.
6533 @node Submodel Options
6534 @section Hardware Models and Configurations
6535 @cindex submodel options
6536 @cindex specifying hardware config
6537 @cindex hardware models and configurations, specifying
6538 @cindex machine dependent options
6540 Earlier we discussed the standard option @option{-b} which chooses among
6541 different installed compilers for completely different target
6542 machines, such as VAX vs.@: 68000 vs.@: 80386.
6544 In addition, each of these target machine types can have its own
6545 special options, starting with @samp{-m}, to choose among various
6546 hardware models or configurations---for example, 68010 vs 68020,
6547 floating coprocessor or none.  A single installed version of the
6548 compiler can compile for any model or configuration, according to the
6549 options specified.
6551 Some configurations of the compiler also support additional special
6552 options, usually for compatibility with other compilers on the same
6553 platform.
6555 These options are defined by the macro @code{TARGET_SWITCHES} in the
6556 machine description.  The default for the options is also defined by
6557 that macro, which enables you to change the defaults.
6559 @c This list is ordered alphanumerically by subsection name.
6560 @c It should be the same order and spelling as these options are listed
6561 @c in Machine Dependent Options
6563 @menu
6564 * ARC Options::
6565 * ARM Options::
6566 * AVR Options::
6567 * CRIS Options::
6568 * Darwin Options::
6569 * DEC Alpha Options::
6570 * DEC Alpha/VMS Options::
6571 * FRV Options::
6572 * H8/300 Options::
6573 * HPPA Options::
6574 * i386 and x86-64 Options::
6575 * IA-64 Options::
6576 * M32R/D Options::
6577 * M680x0 Options::
6578 * M68hc1x Options::
6579 * MCore Options::
6580 * MIPS Options::
6581 * MMIX Options::
6582 * MN10300 Options::
6583 * NS32K Options::
6584 * PDP-11 Options::
6585 * PowerPC Options::
6586 * RS/6000 and PowerPC Options::
6587 * S/390 and zSeries Options::
6588 * SH Options::
6589 * SPARC Options::
6590 * System V Options::
6591 * TMS320C3x/C4x Options::
6592 * V850 Options::
6593 * VAX Options::
6594 * x86-64 Options::
6595 * Xstormy16 Options::
6596 * Xtensa Options::
6597 * zSeries Options::
6598 @end menu
6600 @node ARC Options
6601 @subsection ARC Options
6602 @cindex ARC Options
6604 These options are defined for ARC implementations:
6606 @table @gcctabopt
6607 @item -EL
6608 @opindex EL
6609 Compile code for little endian mode.  This is the default.
6611 @item -EB
6612 @opindex EB
6613 Compile code for big endian mode.
6615 @item -mmangle-cpu
6616 @opindex mmangle-cpu
6617 Prepend the name of the cpu to all public symbol names.
6618 In multiple-processor systems, there are many ARC variants with different
6619 instruction and register set characteristics.  This flag prevents code
6620 compiled for one cpu to be linked with code compiled for another.
6621 No facility exists for handling variants that are ``almost identical''.
6622 This is an all or nothing option.
6624 @item -mcpu=@var{cpu}
6625 @opindex mcpu
6626 Compile code for ARC variant @var{cpu}.
6627 Which variants are supported depend on the configuration.
6628 All variants support @option{-mcpu=base}, this is the default.
6630 @item -mtext=@var{text-section}
6631 @itemx -mdata=@var{data-section}
6632 @itemx -mrodata=@var{readonly-data-section}
6633 @opindex mtext
6634 @opindex mdata
6635 @opindex mrodata
6636 Put functions, data, and readonly data in @var{text-section},
6637 @var{data-section}, and @var{readonly-data-section} respectively
6638 by default.  This can be overridden with the @code{section} attribute.
6639 @xref{Variable Attributes}.
6641 @end table
6643 @node ARM Options
6644 @subsection ARM Options
6645 @cindex ARM options
6647 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6648 architectures:
6650 @table @gcctabopt
6651 @item -mabi=@var{name}
6652 @opindex mabi
6653 Generate code for the specified ABI.  Permissible values are: @samp{apcs-gnu},
6654 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6656 @item -mapcs-frame
6657 @opindex mapcs-frame
6658 Generate a stack frame that is compliant with the ARM Procedure Call
6659 Standard for all functions, even if this is not strictly necessary for
6660 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6661 with this option will cause the stack frames not to be generated for
6662 leaf functions.  The default is @option{-mno-apcs-frame}.
6664 @item -mapcs
6665 @opindex mapcs
6666 This is a synonym for @option{-mapcs-frame}.
6668 @ignore
6669 @c not currently implemented
6670 @item -mapcs-stack-check
6671 @opindex mapcs-stack-check
6672 Generate code to check the amount of stack space available upon entry to
6673 every function (that actually uses some stack space).  If there is
6674 insufficient space available then either the function
6675 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6676 called, depending upon the amount of stack space required.  The run time
6677 system is required to provide these functions.  The default is
6678 @option{-mno-apcs-stack-check}, since this produces smaller code.
6680 @c not currently implemented
6681 @item -mapcs-float
6682 @opindex mapcs-float
6683 Pass floating point arguments using the float point registers.  This is
6684 one of the variants of the APCS@.  This option is recommended if the
6685 target hardware has a floating point unit or if a lot of floating point
6686 arithmetic is going to be performed by the code.  The default is
6687 @option{-mno-apcs-float}, since integer only code is slightly increased in
6688 size if @option{-mapcs-float} is used.
6690 @c not currently implemented
6691 @item -mapcs-reentrant
6692 @opindex mapcs-reentrant
6693 Generate reentrant, position independent code.  The default is
6694 @option{-mno-apcs-reentrant}.
6695 @end ignore
6697 @item -mthumb-interwork
6698 @opindex mthumb-interwork
6699 Generate code which supports calling between the ARM and Thumb
6700 instruction sets.  Without this option the two instruction sets cannot
6701 be reliably used inside one program.  The default is
6702 @option{-mno-thumb-interwork}, since slightly larger code is generated
6703 when @option{-mthumb-interwork} is specified.
6705 @item -mno-sched-prolog
6706 @opindex mno-sched-prolog
6707 Prevent the reordering of instructions in the function prolog, or the
6708 merging of those instruction with the instructions in the function's
6709 body.  This means that all functions will start with a recognizable set
6710 of instructions (or in fact one of a choice from a small set of
6711 different function prologues), and this information can be used to
6712 locate the start if functions inside an executable piece of code.  The
6713 default is @option{-msched-prolog}.
6715 @item -mhard-float
6716 @opindex mhard-float
6717 Generate output containing floating point instructions.  This is the
6718 default.
6720 @item -msoft-float
6721 @opindex msoft-float
6722 Generate output containing library calls for floating point.
6723 @strong{Warning:} the requisite libraries are not available for all ARM
6724 targets.  Normally the facilities of the machine's usual C compiler are
6725 used, but this cannot be done directly in cross-compilation.  You must make
6726 your own arrangements to provide suitable library functions for
6727 cross-compilation.
6729 @option{-msoft-float} changes the calling convention in the output file;
6730 therefore, it is only useful if you compile @emph{all} of a program with
6731 this option.  In particular, you need to compile @file{libgcc.a}, the
6732 library that comes with GCC, with @option{-msoft-float} in order for
6733 this to work.
6735 @item -mfloat-abi=@var{name}
6736 @opindex mfloat-abi
6737 Specifies which ABI to use for floating point values.  Permissible values
6738 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6740 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6741 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6742 of floating point instructions, but still uses the soft-float calling
6743 conventions.
6745 @item -mlittle-endian
6746 @opindex mlittle-endian
6747 Generate code for a processor running in little-endian mode.  This is
6748 the default for all standard configurations.
6750 @item -mbig-endian
6751 @opindex mbig-endian
6752 Generate code for a processor running in big-endian mode; the default is
6753 to compile code for a little-endian processor.
6755 @item -mwords-little-endian
6756 @opindex mwords-little-endian
6757 This option only applies when generating code for big-endian processors.
6758 Generate code for a little-endian word order but a big-endian byte
6759 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6760 option should only be used if you require compatibility with code for
6761 big-endian ARM processors generated by versions of the compiler prior to
6762 2.8.
6764 @item -mcpu=@var{name}
6765 @opindex mcpu
6766 This specifies the name of the target ARM processor.  GCC uses this name
6767 to determine what kind of instructions it can emit when generating
6768 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6769 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6770 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6771 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6772 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6773 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6774 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6775 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6776 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6777 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6778 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6779 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6780 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6781 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6782 @samp{ep9312}.
6784 @itemx -mtune=@var{name}
6785 @opindex mtune
6786 This option is very similar to the @option{-mcpu=} option, except that
6787 instead of specifying the actual target processor type, and hence
6788 restricting which instructions can be used, it specifies that GCC should
6789 tune the performance of the code as if the target were of the type
6790 specified in this option, but still choosing the instructions that it
6791 will generate based on the cpu specified by a @option{-mcpu=} option.
6792 For some ARM implementations better performance can be obtained by using
6793 this option.
6795 @item -march=@var{name}
6796 @opindex march
6797 This specifies the name of the target ARM architecture.  GCC uses this
6798 name to determine what kind of instructions it can emit when generating
6799 assembly code.  This option can be used in conjunction with or instead
6800 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6801 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6802 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6803 @samp{iwmmxt}, @samp{ep9312}.
6805 @item -mfpu=@var{name}
6806 @itemx -mfpe=@var{number}
6807 @itemx -mfp=@var{number}
6808 @opindex mfpu
6809 @opindex mfpe
6810 @opindex mfp
6811 This specifies what floating point hardware (or hardware emulation) is
6812 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6813 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6814 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6815 with older versions of GCC@.
6817 If @option{-msoft-float} is specified this specifies the format of
6818 floating point values.
6820 @item -mstructure-size-boundary=@var{n}
6821 @opindex mstructure-size-boundary
6822 The size of all structures and unions will be rounded up to a multiple
6823 of the number of bits set by this option.  Permissible values are 8, 32
6824 and 64.  The default value varies for different toolchains.  For the COFF
6825 targeted toolchain the default value is 8.  A value of 64 is only allowed
6826 if the underlying ABI supports it.
6828 Specifying the larger number can produce faster, more efficient code, but
6829 can also increase the size of the program.  Different values are potentially
6830 incompatible.  Code compiled with one value cannot necessarily expect to
6831 work with code or libraries compiled with another value, if they exchange
6832 information using structures or unions.
6834 @item -mabort-on-noreturn
6835 @opindex mabort-on-noreturn
6836 Generate a call to the function @code{abort} at the end of a
6837 @code{noreturn} function.  It will be executed if the function tries to
6838 return.
6840 @item -mlong-calls
6841 @itemx -mno-long-calls
6842 @opindex mlong-calls
6843 @opindex mno-long-calls
6844 Tells the compiler to perform function calls by first loading the
6845 address of the function into a register and then performing a subroutine
6846 call on this register.  This switch is needed if the target function
6847 will lie outside of the 64 megabyte addressing range of the offset based
6848 version of subroutine call instruction.
6850 Even if this switch is enabled, not all function calls will be turned
6851 into long calls.  The heuristic is that static functions, functions
6852 which have the @samp{short-call} attribute, functions that are inside
6853 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6854 definitions have already been compiled within the current compilation
6855 unit, will not be turned into long calls.  The exception to this rule is
6856 that weak function definitions, functions with the @samp{long-call}
6857 attribute or the @samp{section} attribute, and functions that are within
6858 the scope of a @samp{#pragma long_calls} directive, will always be
6859 turned into long calls.
6861 This feature is not enabled by default.  Specifying
6862 @option{-mno-long-calls} will restore the default behavior, as will
6863 placing the function calls within the scope of a @samp{#pragma
6864 long_calls_off} directive.  Note these switches have no effect on how
6865 the compiler generates code to handle function calls via function
6866 pointers.
6868 @item -mnop-fun-dllimport
6869 @opindex mnop-fun-dllimport
6870 Disable support for the @code{dllimport} attribute.
6872 @item -msingle-pic-base
6873 @opindex msingle-pic-base
6874 Treat the register used for PIC addressing as read-only, rather than
6875 loading it in the prologue for each function.  The run-time system is
6876 responsible for initializing this register with an appropriate value
6877 before execution begins.
6879 @item -mpic-register=@var{reg}
6880 @opindex mpic-register
6881 Specify the register to be used for PIC addressing.  The default is R10
6882 unless stack-checking is enabled, when R9 is used.
6884 @item -mcirrus-fix-invalid-insns
6885 @opindex mcirrus-fix-invalid-insns
6886 @opindex mno-cirrus-fix-invalid-insns
6887 Insert NOPs into the instruction stream to in order to work around
6888 problems with invalid Maverick instruction combinations.  This option
6889 is only valid if the @option{-mcpu=ep9312} option has been used to
6890 enable generation of instructions for the Cirrus Maverick floating
6891 point co-processor.  This option is not enabled by default, since the
6892 problem is only present in older Maverick implementations.  The default
6893 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6894 switch.
6896 @item -mpoke-function-name
6897 @opindex mpoke-function-name
6898 Write the name of each function into the text section, directly
6899 preceding the function prologue.  The generated code is similar to this:
6901 @smallexample
6902      t0
6903          .ascii "arm_poke_function_name", 0
6904          .align
6905      t1
6906          .word 0xff000000 + (t1 - t0)
6907      arm_poke_function_name
6908          mov     ip, sp
6909          stmfd   sp!, @{fp, ip, lr, pc@}
6910          sub     fp, ip, #4
6911 @end smallexample
6913 When performing a stack backtrace, code can inspect the value of
6914 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6915 location @code{pc - 12} and the top 8 bits are set, then we know that
6916 there is a function name embedded immediately preceding this location
6917 and has length @code{((pc[-3]) & 0xff000000)}.
6919 @item -mthumb
6920 @opindex mthumb
6921 Generate code for the 16-bit Thumb instruction set.  The default is to
6922 use the 32-bit ARM instruction set.
6924 @item -mtpcs-frame
6925 @opindex mtpcs-frame
6926 Generate a stack frame that is compliant with the Thumb Procedure Call
6927 Standard for all non-leaf functions.  (A leaf function is one that does
6928 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6930 @item -mtpcs-leaf-frame
6931 @opindex mtpcs-leaf-frame
6932 Generate a stack frame that is compliant with the Thumb Procedure Call
6933 Standard for all leaf functions.  (A leaf function is one that does
6934 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6936 @item -mcallee-super-interworking
6937 @opindex mcallee-super-interworking
6938 Gives all externally visible functions in the file being compiled an ARM
6939 instruction set header which switches to Thumb mode before executing the
6940 rest of the function.  This allows these functions to be called from
6941 non-interworking code.
6943 @item -mcaller-super-interworking
6944 @opindex mcaller-super-interworking
6945 Allows calls via function pointers (including virtual functions) to
6946 execute correctly regardless of whether the target code has been
6947 compiled for interworking or not.  There is a small overhead in the cost
6948 of executing a function pointer if this option is enabled.
6950 @end table
6952 @node AVR Options
6953 @subsection AVR Options
6954 @cindex AVR Options
6956 These options are defined for AVR implementations:
6958 @table @gcctabopt
6959 @item -mmcu=@var{mcu}
6960 @opindex mmcu
6961 Specify ATMEL AVR instruction set or MCU type.
6963 Instruction set avr1 is for the minimal AVR core, not supported by the C
6964 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6965 attiny11, attiny12, attiny15, attiny28).
6967 Instruction set avr2 (default) is for the classic AVR core with up to
6968 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
6969 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
6970 at90c8534, at90s8535).
6972 Instruction set avr3 is for the classic AVR core with up to 128K program
6973 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
6975 Instruction set avr4 is for the enhanced AVR core with up to 8K program
6976 memory space (MCU types: atmega8, atmega83, atmega85).
6978 Instruction set avr5 is for the enhanced AVR core with up to 128K program
6979 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
6980 atmega64, atmega128, at43usb355, at94k).
6982 @item -msize
6983 @opindex msize
6984 Output instruction sizes to the asm file.
6986 @item -minit-stack=@var{N}
6987 @opindex minit-stack
6988 Specify the initial stack address, which may be a symbol or numeric value,
6989 @samp{__stack} is the default.
6991 @item -mno-interrupts
6992 @opindex mno-interrupts
6993 Generated code is not compatible with hardware interrupts.
6994 Code size will be smaller.
6996 @item -mcall-prologues
6997 @opindex mcall-prologues
6998 Functions prologues/epilogues expanded as call to appropriate
6999 subroutines.  Code size will be smaller.
7001 @item -mno-tablejump
7002 @opindex mno-tablejump
7003 Do not generate tablejump insns which sometimes increase code size.
7005 @item -mtiny-stack
7006 @opindex mtiny-stack
7007 Change only the low 8 bits of the stack pointer.
7009 @item -mint8
7010 @opindex mint8
7011 Assume int to be 8 bit integer. This affects the sizes of all types: A
7012 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7013 and long long will be 4 bytes. Please note that this option does not
7014 comply to the C standards, but it will provide you with smaller code
7015 size.
7016 @end table
7018 @node CRIS Options
7019 @subsection CRIS Options
7020 @cindex CRIS Options
7022 These options are defined specifically for the CRIS ports.
7024 @table @gcctabopt
7025 @item -march=@var{architecture-type}
7026 @itemx -mcpu=@var{architecture-type}
7027 @opindex march
7028 @opindex mcpu
7029 Generate code for the specified architecture.  The choices for
7030 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7031 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
7032 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7033 @samp{v10}.
7035 @item -mtune=@var{architecture-type}
7036 @opindex mtune
7037 Tune to @var{architecture-type} everything applicable about the generated
7038 code, except for the ABI and the set of available instructions.  The
7039 choices for @var{architecture-type} are the same as for
7040 @option{-march=@var{architecture-type}}.
7042 @item -mmax-stack-frame=@var{n}
7043 @opindex mmax-stack-frame
7044 Warn when the stack frame of a function exceeds @var{n} bytes.
7046 @item -melinux-stacksize=@var{n}
7047 @opindex melinux-stacksize
7048 Only available with the @samp{cris-axis-aout} target.  Arranges for
7049 indications in the program to the kernel loader that the stack of the
7050 program should be set to @var{n} bytes.
7052 @item -metrax4
7053 @itemx -metrax100
7054 @opindex metrax4
7055 @opindex metrax100
7056 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7057 @option{-march=v3} and @option{-march=v8} respectively.
7059 @item -mmul-bug-workaround
7060 @itemx -mno-mul-bug-workaround
7061 @opindex mmul-bug-workaround
7062 @opindex mno-mul-bug-workaround
7063 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7064 models where it applies.  This option is active by default.
7066 @item -mpdebug
7067 @opindex mpdebug
7068 Enable CRIS-specific verbose debug-related information in the assembly
7069 code.  This option also has the effect to turn off the @samp{#NO_APP}
7070 formatted-code indicator to the assembler at the beginning of the
7071 assembly file.
7073 @item -mcc-init
7074 @opindex mcc-init
7075 Do not use condition-code results from previous instruction; always emit
7076 compare and test instructions before use of condition codes.
7078 @item -mno-side-effects
7079 @opindex mno-side-effects
7080 Do not emit instructions with side-effects in addressing modes other than
7081 post-increment.
7083 @item -mstack-align
7084 @itemx -mno-stack-align
7085 @itemx -mdata-align
7086 @itemx -mno-data-align
7087 @itemx -mconst-align
7088 @itemx -mno-const-align
7089 @opindex mstack-align
7090 @opindex mno-stack-align
7091 @opindex mdata-align
7092 @opindex mno-data-align
7093 @opindex mconst-align
7094 @opindex mno-const-align
7095 These options (no-options) arranges (eliminate arrangements) for the
7096 stack-frame, individual data and constants to be aligned for the maximum
7097 single data access size for the chosen CPU model.  The default is to
7098 arrange for 32-bit alignment.  ABI details such as structure layout are
7099 not affected by these options.
7101 @item -m32-bit
7102 @itemx -m16-bit
7103 @itemx -m8-bit
7104 @opindex m32-bit
7105 @opindex m16-bit
7106 @opindex m8-bit
7107 Similar to the stack- data- and const-align options above, these options
7108 arrange for stack-frame, writable data and constants to all be 32-bit,
7109 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7111 @item -mno-prologue-epilogue
7112 @itemx -mprologue-epilogue
7113 @opindex mno-prologue-epilogue
7114 @opindex mprologue-epilogue
7115 With @option{-mno-prologue-epilogue}, the normal function prologue and
7116 epilogue that sets up the stack-frame are omitted and no return
7117 instructions or return sequences are generated in the code.  Use this
7118 option only together with visual inspection of the compiled code: no
7119 warnings or errors are generated when call-saved registers must be saved,
7120 or storage for local variable needs to be allocated.
7122 @item -mno-gotplt
7123 @itemx -mgotplt
7124 @opindex mno-gotplt
7125 @opindex mgotplt
7126 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7127 instruction sequences that load addresses for functions from the PLT part
7128 of the GOT rather than (traditional on other architectures) calls to the
7129 PLT.  The default is @option{-mgotplt}.
7131 @item -maout
7132 @opindex maout
7133 Legacy no-op option only recognized with the cris-axis-aout target.
7135 @item -melf
7136 @opindex melf
7137 Legacy no-op option only recognized with the cris-axis-elf and
7138 cris-axis-linux-gnu targets.
7140 @item -melinux
7141 @opindex melinux
7142 Only recognized with the cris-axis-aout target, where it selects a
7143 GNU/linux-like multilib, include files and instruction set for
7144 @option{-march=v8}.
7146 @item -mlinux
7147 @opindex mlinux
7148 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7150 @item -sim
7151 @opindex sim
7152 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7153 to link with input-output functions from a simulator library.  Code,
7154 initialized data and zero-initialized data are allocated consecutively.
7156 @item -sim2
7157 @opindex sim2
7158 Like @option{-sim}, but pass linker options to locate initialized data at
7159 0x40000000 and zero-initialized data at 0x80000000.
7160 @end table
7162 @node Darwin Options
7163 @subsection Darwin Options
7164 @cindex Darwin options
7166 These options are defined for all architectures running the Darwin operating
7167 system.  They are useful for compatibility with other Mac OS compilers.
7169 @table @gcctabopt
7170 @item -F@var{dir}
7171 @opindex F
7172 Add the framework directory @var{dir} to the head of the list of
7173 directories to be searched for header files.  These directories are
7174 interleaved with those specified by @option{-I} options and are
7175 scanned in a left-to-right order.
7177 A framework directory is a directory with frameworks in it.  A
7178 framework is a directory with a @samp{"Headers"} and/or
7179 @samp{"PrivateHeaders"} directory contained directly in it that ends
7180 in @samp{".framework"}.  The name of a framework is the name of this
7181 directory excluding the @samp{".framework"}.  Headers associated with
7182 the framework are found in one of those two directories, with
7183 @samp{"Headers"} being searched first.  A subframework is a framework
7184 directory that is in a framework's @samp{"Frameworks"} directory.
7185 Includes of subframework headers can only appear in a header of a
7186 framework that contains the subframework, or in a sibling subframework
7187 header.  Two subframeworks are siblings if they occur in the same
7188 framework.  A subframework should not have the same name as a
7189 framework, a warning will be issued if this is violated.  Currently a
7190 subframework cannot have subframeworks, in the future, the mechanism
7191 may be extended to support this.  The standard frameworks can be found
7192 in @samp{"/System/Library/Frameworks"} and
7193 @samp{"/Library/Frameworks"}.  An example include looks like
7194 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7195 the name of the framework and header.h is found in the
7196 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7198 @item -gused
7199 @opindex -gused
7200 Emit debugging information for symbols that are used. For STABS
7201 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7202 This is by default ON.
7204 @item -gfull
7205 @opindex -gfull
7206 Emit debugging information for all symbols and types.
7208 @item -mone-byte-bool
7209 @opindex -mone-byte-bool
7210 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7211 By default @samp{sizeof(bool)} is @samp{4} when compiling for 
7212 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7213 option has no effect on x86.
7215 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7216 to generate code that is not binary compatible with code generated
7217 without that switch.  Using this switch may require recompiling all
7218 other modules in a program, including system libraries.  Use this 
7219 switch to conform to a non-default data model.
7221 @item -mfix-and-continue
7222 @itemx -ffix-and-continue
7223 @itemx -findirect-data
7224 @opindex mfix-and-continue
7225 @opindex ffix-and-continue
7226 @opindex findirect-data
7227 Generate code suitable for fast turn around development.  Needed to
7228 enable gdb to dynamically load @code{.o} files into already running
7229 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7230 are provided for backwards compatibility.
7232 @item -all_load
7233 @opindex all_load
7234 Loads all members of static archive libraries.
7235 See man ld(1) for more information.
7237 @item -arch_errors_fatal
7238 @opindex arch_errors_fatal
7239 Cause the errors having to do with files that have the wrong architecture
7240 to be fatal.
7242 @item -bind_at_load
7243 @opindex bind_at_load
7244 Causes the output file to be marked such that the dynamic linker will
7245 bind all undefined references when the file is loaded or launched.
7247 @item -bundle
7248 @opindex bundle
7249 Produce a Mach-o bundle format file.
7250 See man ld(1) for more information.
7252 @item -bundle_loader @var{executable}
7253 @opindex bundle_loader
7254 This specifies the @var{executable} that will be loading the build
7255 output file being linked. See man ld(1) for more information.
7257 @item -allowable_client  @var{client_name}
7258 @itemx -arch_only
7260 @itemx -client_name
7261 @itemx -compatibility_version
7262 @itemx -current_version
7263 @itemx -dead_strip
7264 @itemx -dependency-file
7265 @itemx -dylib_file
7266 @itemx -dylinker_install_name
7267 @itemx -dynamic
7268 @itemx -dynamiclib
7269 @itemx -exported_symbols_list
7270 @itemx -filelist
7271 @itemx -flat_namespace
7272 @itemx -force_cpusubtype_ALL
7273 @itemx -force_flat_namespace
7274 @itemx -headerpad_max_install_names
7275 @itemx -image_base
7276 @itemx -init
7277 @itemx -install_name
7278 @itemx -keep_private_externs
7279 @itemx -multi_module
7280 @itemx -multiply_defined
7281 @itemx -multiply_defined_unused
7282 @itemx -noall_load
7283 @itemx -no_dead_strip_inits_and_terms
7284 @itemx -nofixprebinding
7285 @itemx -nomultidefs
7286 @itemx -noprebind
7287 @itemx -noseglinkedit
7288 @itemx -pagezero_size
7289 @itemx -prebind
7290 @itemx -prebind_all_twolevel_modules
7291 @itemx -private_bundle
7292 @itemx -read_only_relocs
7293 @itemx -sectalign
7294 @itemx -sectobjectsymbols
7295 @itemx -whyload
7296 @itemx -seg1addr
7297 @itemx -sectcreate
7298 @itemx -sectobjectsymbols
7299 @itemx -sectorder
7300 @itemx -segaddr
7301 @itemx -segs_read_only_addr
7302 @itemx -segs_read_write_addr
7303 @itemx -seg_addr_table
7304 @itemx -seg_addr_table_filename
7305 @itemx -seglinkedit
7306 @itemx -segprot
7307 @itemx -segs_read_only_addr
7308 @itemx -segs_read_write_addr
7309 @itemx -single_module
7310 @itemx -static
7311 @itemx -sub_library
7312 @itemx -sub_umbrella
7313 @itemx -twolevel_namespace
7314 @itemx -umbrella
7315 @itemx -undefined
7316 @itemx -unexported_symbols_list
7317 @itemx -weak_reference_mismatches
7318 @itemx -whatsloaded
7320 @opindex allowable_client
7321 @opindex arch_only
7322 @opindex client_name
7323 @opindex compatibility_version
7324 @opindex current_version
7325 @opindex dead_strip
7326 @opindex dependency-file
7327 @opindex dylib_file
7328 @opindex dylinker_install_name
7329 @opindex dynamic
7330 @opindex dynamiclib
7331 @opindex exported_symbols_list
7332 @opindex filelist
7333 @opindex flat_namespace
7334 @opindex force_cpusubtype_ALL
7335 @opindex force_flat_namespace
7336 @opindex headerpad_max_install_names
7337 @opindex image_base
7338 @opindex init
7339 @opindex install_name
7340 @opindex keep_private_externs
7341 @opindex multi_module
7342 @opindex multiply_defined
7343 @opindex multiply_defined_unused
7344 @opindex noall_load
7345 @opindex no_dead_strip_inits_and_terms
7346 @opindex nofixprebinding
7347 @opindex nomultidefs
7348 @opindex noprebind
7349 @opindex noseglinkedit
7350 @opindex pagezero_size
7351 @opindex prebind
7352 @opindex prebind_all_twolevel_modules
7353 @opindex private_bundle
7354 @opindex read_only_relocs
7355 @opindex sectalign
7356 @opindex sectobjectsymbols
7357 @opindex whyload
7358 @opindex seg1addr
7359 @opindex sectcreate
7360 @opindex sectobjectsymbols
7361 @opindex sectorder
7362 @opindex segaddr
7363 @opindex segs_read_only_addr
7364 @opindex segs_read_write_addr
7365 @opindex seg_addr_table
7366 @opindex seg_addr_table_filename
7367 @opindex seglinkedit
7368 @opindex segprot
7369 @opindex segs_read_only_addr
7370 @opindex segs_read_write_addr
7371 @opindex single_module
7372 @opindex static
7373 @opindex sub_library
7374 @opindex sub_umbrella
7375 @opindex twolevel_namespace
7376 @opindex umbrella
7377 @opindex undefined
7378 @opindex unexported_symbols_list
7379 @opindex weak_reference_mismatches
7380 @opindex whatsloaded
7382 These options are available for Darwin linker. Darwin linker man page
7383 describes them in detail.
7384 @end table
7386 @node DEC Alpha Options
7387 @subsection DEC Alpha Options
7389 These @samp{-m} options are defined for the DEC Alpha implementations:
7391 @table @gcctabopt
7392 @item -mno-soft-float
7393 @itemx -msoft-float
7394 @opindex mno-soft-float
7395 @opindex msoft-float
7396 Use (do not use) the hardware floating-point instructions for
7397 floating-point operations.  When @option{-msoft-float} is specified,
7398 functions in @file{libgcc.a} will be used to perform floating-point
7399 operations.  Unless they are replaced by routines that emulate the
7400 floating-point operations, or compiled in such a way as to call such
7401 emulations routines, these routines will issue floating-point
7402 operations.   If you are compiling for an Alpha without floating-point
7403 operations, you must ensure that the library is built so as not to call
7404 them.
7406 Note that Alpha implementations without floating-point operations are
7407 required to have floating-point registers.
7409 @item -mfp-reg
7410 @itemx -mno-fp-regs
7411 @opindex mfp-reg
7412 @opindex mno-fp-regs
7413 Generate code that uses (does not use) the floating-point register set.
7414 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7415 register set is not used, floating point operands are passed in integer
7416 registers as if they were integers and floating-point results are passed
7417 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7418 so any function with a floating-point argument or return value called by code
7419 compiled with @option{-mno-fp-regs} must also be compiled with that
7420 option.
7422 A typical use of this option is building a kernel that does not use,
7423 and hence need not save and restore, any floating-point registers.
7425 @item -mieee
7426 @opindex mieee
7427 The Alpha architecture implements floating-point hardware optimized for
7428 maximum performance.  It is mostly compliant with the IEEE floating
7429 point standard.  However, for full compliance, software assistance is
7430 required.  This option generates code fully IEEE compliant code
7431 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7432 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7433 defined during compilation.  The resulting code is less efficient but is
7434 able to correctly support denormalized numbers and exceptional IEEE
7435 values such as not-a-number and plus/minus infinity.  Other Alpha
7436 compilers call this option @option{-ieee_with_no_inexact}.
7438 @item -mieee-with-inexact
7439 @opindex mieee-with-inexact
7440 This is like @option{-mieee} except the generated code also maintains
7441 the IEEE @var{inexact-flag}.  Turning on this option causes the
7442 generated code to implement fully-compliant IEEE math.  In addition to
7443 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7444 macro.  On some Alpha implementations the resulting code may execute
7445 significantly slower than the code generated by default.  Since there is
7446 very little code that depends on the @var{inexact-flag}, you should
7447 normally not specify this option.  Other Alpha compilers call this
7448 option @option{-ieee_with_inexact}.
7450 @item -mfp-trap-mode=@var{trap-mode}
7451 @opindex mfp-trap-mode
7452 This option controls what floating-point related traps are enabled.
7453 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7454 The trap mode can be set to one of four values:
7456 @table @samp
7457 @item n
7458 This is the default (normal) setting.  The only traps that are enabled
7459 are the ones that cannot be disabled in software (e.g., division by zero
7460 trap).
7462 @item u
7463 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7464 as well.
7466 @item su
7467 Like @samp{su}, but the instructions are marked to be safe for software
7468 completion (see Alpha architecture manual for details).
7470 @item sui
7471 Like @samp{su}, but inexact traps are enabled as well.
7472 @end table
7474 @item -mfp-rounding-mode=@var{rounding-mode}
7475 @opindex mfp-rounding-mode
7476 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7477 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7480 @table @samp
7481 @item n
7482 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7483 the nearest machine number or towards the even machine number in case
7484 of a tie.
7486 @item m
7487 Round towards minus infinity.
7489 @item c
7490 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7492 @item d
7493 Dynamic rounding mode.  A field in the floating point control register
7494 (@var{fpcr}, see Alpha architecture reference manual) controls the
7495 rounding mode in effect.  The C library initializes this register for
7496 rounding towards plus infinity.  Thus, unless your program modifies the
7497 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7498 @end table
7500 @item -mtrap-precision=@var{trap-precision}
7501 @opindex mtrap-precision
7502 In the Alpha architecture, floating point traps are imprecise.  This
7503 means without software assistance it is impossible to recover from a
7504 floating trap and program execution normally needs to be terminated.
7505 GCC can generate code that can assist operating system trap handlers
7506 in determining the exact location that caused a floating point trap.
7507 Depending on the requirements of an application, different levels of
7508 precisions can be selected:
7510 @table @samp
7511 @item p
7512 Program precision.  This option is the default and means a trap handler
7513 can only identify which program caused a floating point exception.
7515 @item f
7516 Function precision.  The trap handler can determine the function that
7517 caused a floating point exception.
7519 @item i
7520 Instruction precision.  The trap handler can determine the exact
7521 instruction that caused a floating point exception.
7522 @end table
7524 Other Alpha compilers provide the equivalent options called
7525 @option{-scope_safe} and @option{-resumption_safe}.
7527 @item -mieee-conformant
7528 @opindex mieee-conformant
7529 This option marks the generated code as IEEE conformant.  You must not
7530 use this option unless you also specify @option{-mtrap-precision=i} and either
7531 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7532 is to emit the line @samp{.eflag 48} in the function prologue of the
7533 generated assembly file.  Under DEC Unix, this has the effect that
7534 IEEE-conformant math library routines will be linked in.
7536 @item -mbuild-constants
7537 @opindex mbuild-constants
7538 Normally GCC examines a 32- or 64-bit integer constant to
7539 see if it can construct it from smaller constants in two or three
7540 instructions.  If it cannot, it will output the constant as a literal and
7541 generate code to load it from the data segment at runtime.
7543 Use this option to require GCC to construct @emph{all} integer constants
7544 using code, even if it takes more instructions (the maximum is six).
7546 You would typically use this option to build a shared library dynamic
7547 loader.  Itself a shared library, it must relocate itself in memory
7548 before it can find the variables and constants in its own data segment.
7550 @item -malpha-as
7551 @itemx -mgas
7552 @opindex malpha-as
7553 @opindex mgas
7554 Select whether to generate code to be assembled by the vendor-supplied
7555 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7557 @item -mbwx
7558 @itemx -mno-bwx
7559 @itemx -mcix
7560 @itemx -mno-cix
7561 @itemx -mfix
7562 @itemx -mno-fix
7563 @itemx -mmax
7564 @itemx -mno-max
7565 @opindex mbwx
7566 @opindex mno-bwx
7567 @opindex mcix
7568 @opindex mno-cix
7569 @opindex mfix
7570 @opindex mno-fix
7571 @opindex mmax
7572 @opindex mno-max
7573 Indicate whether GCC should generate code to use the optional BWX,
7574 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7575 sets supported by the CPU type specified via @option{-mcpu=} option or that
7576 of the CPU on which GCC was built if none was specified.
7578 @item -mfloat-vax
7579 @itemx -mfloat-ieee
7580 @opindex mfloat-vax
7581 @opindex mfloat-ieee
7582 Generate code that uses (does not use) VAX F and G floating point
7583 arithmetic instead of IEEE single and double precision.
7585 @item -mexplicit-relocs
7586 @itemx -mno-explicit-relocs
7587 @opindex mexplicit-relocs
7588 @opindex mno-explicit-relocs
7589 Older Alpha assemblers provided no way to generate symbol relocations
7590 except via assembler macros.  Use of these macros does not allow
7591 optimal instruction scheduling.  GNU binutils as of version 2.12
7592 supports a new syntax that allows the compiler to explicitly mark
7593 which relocations should apply to which instructions.  This option
7594 is mostly useful for debugging, as GCC detects the capabilities of
7595 the assembler when it is built and sets the default accordingly.
7597 @item -msmall-data
7598 @itemx -mlarge-data
7599 @opindex msmall-data
7600 @opindex mlarge-data
7601 When @option{-mexplicit-relocs} is in effect, static data is
7602 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7603 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7604 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7605 16-bit relocations off of the @code{$gp} register.  This limits the
7606 size of the small data area to 64KB, but allows the variables to be
7607 directly accessed via a single instruction.
7609 The default is @option{-mlarge-data}.  With this option the data area
7610 is limited to just below 2GB.  Programs that require more than 2GB of
7611 data must use @code{malloc} or @code{mmap} to allocate the data in the
7612 heap instead of in the program's data segment.
7614 When generating code for shared libraries, @option{-fpic} implies
7615 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7617 @item -msmall-text
7618 @itemx -mlarge-text
7619 @opindex msmall-text
7620 @opindex mlarge-text
7621 When @option{-msmall-text} is used, the compiler assumes that the
7622 code of the entire program (or shared library) fits in 4MB, and is
7623 thus reachable with a branch instruction.  When @option{-msmall-data}
7624 is used, the compiler can assume that all local symbols share the
7625 same @code{$gp} value, and thus reduce the number of instructions
7626 required for a function call from 4 to 1.
7628 The default is @option{-mlarge-text}.
7630 @item -mcpu=@var{cpu_type}
7631 @opindex mcpu
7632 Set the instruction set and instruction scheduling parameters for
7633 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7634 style name or the corresponding chip number.  GCC supports scheduling
7635 parameters for the EV4, EV5 and EV6 family of processors and will
7636 choose the default values for the instruction set from the processor
7637 you specify.  If you do not specify a processor type, GCC will default
7638 to the processor on which the compiler was built.
7640 Supported values for @var{cpu_type} are
7642 @table @samp
7643 @item ev4
7644 @itemx ev45
7645 @itemx 21064
7646 Schedules as an EV4 and has no instruction set extensions.
7648 @item ev5
7649 @itemx 21164
7650 Schedules as an EV5 and has no instruction set extensions.
7652 @item ev56
7653 @itemx 21164a
7654 Schedules as an EV5 and supports the BWX extension.
7656 @item pca56
7657 @itemx 21164pc
7658 @itemx 21164PC
7659 Schedules as an EV5 and supports the BWX and MAX extensions.
7661 @item ev6
7662 @itemx 21264
7663 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7665 @item ev67
7666 @itemx 21264a
7667 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7668 @end table
7670 @item -mtune=@var{cpu_type}
7671 @opindex mtune
7672 Set only the instruction scheduling parameters for machine type
7673 @var{cpu_type}.  The instruction set is not changed.
7675 @item -mmemory-latency=@var{time}
7676 @opindex mmemory-latency
7677 Sets the latency the scheduler should assume for typical memory
7678 references as seen by the application.  This number is highly
7679 dependent on the memory access patterns used by the application
7680 and the size of the external cache on the machine.
7682 Valid options for @var{time} are
7684 @table @samp
7685 @item @var{number}
7686 A decimal number representing clock cycles.
7688 @item L1
7689 @itemx L2
7690 @itemx L3
7691 @itemx main
7692 The compiler contains estimates of the number of clock cycles for
7693 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7694 (also called Dcache, Scache, and Bcache), as well as to main memory.
7695 Note that L3 is only valid for EV5.
7697 @end table
7698 @end table
7700 @node DEC Alpha/VMS Options
7701 @subsection DEC Alpha/VMS Options
7703 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7705 @table @gcctabopt
7706 @item -mvms-return-codes
7707 @opindex mvms-return-codes
7708 Return VMS condition codes from main.  The default is to return POSIX
7709 style condition (e.g.@ error) codes.
7710 @end table
7712 @node FRV Options
7713 @subsection FRV Options
7714 @cindex FRV Options
7716 @table @gcctabopt
7717 @item -mgpr-32
7718 @opindex mgpr-32
7720 Only use the first 32 general purpose registers.
7722 @item -mgpr-64
7723 @opindex mgpr-64
7725 Use all 64 general purpose registers.
7727 @item -mfpr-32
7728 @opindex mfpr-32
7730 Use only the first 32 floating point registers.
7732 @item -mfpr-64
7733 @opindex mfpr-64
7735 Use all 64 floating point registers
7737 @item -mhard-float
7738 @opindex mhard-float
7740 Use hardware instructions for floating point operations.
7742 @item -msoft-float
7743 @opindex msoft-float
7745 Use library routines for floating point operations.
7747 @item -malloc-cc
7748 @opindex malloc-cc
7750 Dynamically allocate condition code registers.
7752 @item -mfixed-cc
7753 @opindex mfixed-cc
7755 Do not try to dynamically allocate condition code registers, only
7756 use @code{icc0} and @code{fcc0}.
7758 @item -mdword
7759 @opindex mdword
7761 Change ABI to use double word insns.
7763 @item -mno-dword
7764 @opindex mno-dword
7766 Do not use double word instructions.
7768 @item -mdouble
7769 @opindex mdouble
7771 Use floating point double instructions.
7773 @item -mno-double
7774 @opindex mno-double
7776 Do not use floating point double instructions.
7778 @item -mmedia
7779 @opindex mmedia
7781 Use media instructions.
7783 @item -mno-media
7784 @opindex mno-media
7786 Do not use media instructions.
7788 @item -mmuladd
7789 @opindex mmuladd
7791 Use multiply and add/subtract instructions.
7793 @item -mno-muladd
7794 @opindex mno-muladd
7796 Do not use multiply and add/subtract instructions.
7798 @item -mfdpic
7799 @opindex mfdpic
7801 Select the FDPIC ABI, that uses function descriptors to represent
7802 pointers to functions.  Without any PIC/PIE-related options, it
7803 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7804 assumes GOT entries and small data are within a 12-bit range from the
7805 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7806 are computed with 32 bits.
7808 @item -minline-plt
7809 @opindex minline-plt
7811 Enable inlining of PLT entries in function calls to functions that are
7812 not known to bind locally.  It has no effect without @option{-mfdpic}.
7813 It's enabled by default if optimizing for speed and compiling for
7814 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7815 optimization option such as @option{-O3} or above is present in the
7816 command line.
7818 @item -mgprel-ro
7819 @opindex mgprel-ro
7821 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7822 that is known to be in read-only sections.  It's enabled by default,
7823 except for @option{-fpic} or @option{-fpie}: even though it may help
7824 make the global offset table smaller, it trades 1 instruction for 4.
7825 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7826 one of which may be shared by multiple symbols, and it avoids the need
7827 for a GOT entry for the referenced symbol, so it's more likely to be a
7828 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7830 @item -multilib-library-pic
7831 @opindex multilib-library-pic
7833 Link with the (library, not FD) pic libraries.  It's implied by
7834 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7835 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7836 it explicitly.
7838 @item -mlinked-fp
7839 @opindex mlinked-fp
7841 Follow the EABI requirement of always creating a frame pointer whenever
7842 a stack frame is allocated.  This option is enabled by default and can
7843 be disabled with @option{-mno-linked-fp}.
7845 @item -mlong-calls
7846 @opindex mlong-calls
7848 Use indirect addressing to call functions outside the current
7849 compilation unit.  This allows the functions to be placed anywhere
7850 within the 32-bit address space.
7852 @item -malign-labels
7853 @opindex malign-labels
7855 Try to align labels to an 8-byte boundary by inserting nops into the
7856 previous packet.  This option only has an effect when VLIW packing
7857 is enabled.  It doesn't create new packets; it merely adds nops to
7858 existing ones.
7860 @item -mlibrary-pic
7861 @opindex mlibrary-pic
7863 Generate position-independent EABI code.
7865 @item -macc-4
7866 @opindex macc-4
7868 Use only the first four media accumulator registers.
7870 @item -macc-8
7871 @opindex macc-8
7873 Use all eight media accumulator registers.
7875 @item -mpack
7876 @opindex mpack
7878 Pack VLIW instructions.
7880 @item -mno-pack
7881 @opindex mno-pack
7883 Do not pack VLIW instructions.
7885 @item -mno-eflags
7886 @opindex mno-eflags
7888 Do not mark ABI switches in e_flags.
7890 @item -mcond-move
7891 @opindex mcond-move
7893 Enable the use of conditional-move instructions (default).
7895 This switch is mainly for debugging the compiler and will likely be removed
7896 in a future version.
7898 @item -mno-cond-move
7899 @opindex mno-cond-move
7901 Disable the use of conditional-move instructions.
7903 This switch is mainly for debugging the compiler and will likely be removed
7904 in a future version.
7906 @item -mscc
7907 @opindex mscc
7909 Enable the use of conditional set instructions (default).
7911 This switch is mainly for debugging the compiler and will likely be removed
7912 in a future version.
7914 @item -mno-scc
7915 @opindex mno-scc
7917 Disable the use of conditional set instructions.
7919 This switch is mainly for debugging the compiler and will likely be removed
7920 in a future version.
7922 @item -mcond-exec
7923 @opindex mcond-exec
7925 Enable the use of conditional execution (default).
7927 This switch is mainly for debugging the compiler and will likely be removed
7928 in a future version.
7930 @item -mno-cond-exec
7931 @opindex mno-cond-exec
7933 Disable the use of conditional execution.
7935 This switch is mainly for debugging the compiler and will likely be removed
7936 in a future version.
7938 @item -mvliw-branch
7939 @opindex mvliw-branch
7941 Run a pass to pack branches into VLIW instructions (default).
7943 This switch is mainly for debugging the compiler and will likely be removed
7944 in a future version.
7946 @item -mno-vliw-branch
7947 @opindex mno-vliw-branch
7949 Do not run a pass to pack branches into VLIW instructions.
7951 This switch is mainly for debugging the compiler and will likely be removed
7952 in a future version.
7954 @item -mmulti-cond-exec
7955 @opindex mmulti-cond-exec
7957 Enable optimization of @code{&&} and @code{||} in conditional execution
7958 (default).
7960 This switch is mainly for debugging the compiler and will likely be removed
7961 in a future version.
7963 @item -mno-multi-cond-exec
7964 @opindex mno-multi-cond-exec
7966 Disable optimization of @code{&&} and @code{||} in conditional execution.
7968 This switch is mainly for debugging the compiler and will likely be removed
7969 in a future version.
7971 @item -mnested-cond-exec
7972 @opindex mnested-cond-exec
7974 Enable nested conditional execution optimizations (default).
7976 This switch is mainly for debugging the compiler and will likely be removed
7977 in a future version.
7979 @item -mno-nested-cond-exec
7980 @opindex mno-nested-cond-exec
7982 Disable nested conditional execution optimizations.
7984 This switch is mainly for debugging the compiler and will likely be removed
7985 in a future version.
7987 @item -mtomcat-stats
7988 @opindex mtomcat-stats
7990 Cause gas to print out tomcat statistics.
7992 @item -mcpu=@var{cpu}
7993 @opindex mcpu
7995 Select the processor type for which to generate code.  Possible values are
7996 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
7997 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
7999 @end table
8001 @node H8/300 Options
8002 @subsection H8/300 Options
8004 These @samp{-m} options are defined for the H8/300 implementations:
8006 @table @gcctabopt
8007 @item -mrelax
8008 @opindex mrelax
8009 Shorten some address references at link time, when possible; uses the
8010 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8011 ld, Using ld}, for a fuller description.
8013 @item -mh
8014 @opindex mh
8015 Generate code for the H8/300H@.
8017 @item -ms
8018 @opindex ms
8019 Generate code for the H8S@.
8021 @item -mn
8022 @opindex mn
8023 Generate code for the H8S and H8/300H in the normal mode.  This switch
8024 must be used either with @option{-mh} or @option{-ms}.
8026 @item -ms2600
8027 @opindex ms2600
8028 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8030 @item -mint32
8031 @opindex mint32
8032 Make @code{int} data 32 bits by default.
8034 @item -malign-300
8035 @opindex malign-300
8036 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8037 The default for the H8/300H and H8S is to align longs and floats on 4
8038 byte boundaries.
8039 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8040 This option has no effect on the H8/300.
8041 @end table
8043 @node HPPA Options
8044 @subsection HPPA Options
8045 @cindex HPPA Options
8047 These @samp{-m} options are defined for the HPPA family of computers:
8049 @table @gcctabopt
8050 @item -march=@var{architecture-type}
8051 @opindex march
8052 Generate code for the specified architecture.  The choices for
8053 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8054 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8055 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8056 architecture option for your machine.  Code compiled for lower numbered
8057 architectures will run on higher numbered architectures, but not the
8058 other way around.
8060 @item -mpa-risc-1-0
8061 @itemx -mpa-risc-1-1
8062 @itemx -mpa-risc-2-0
8063 @opindex mpa-risc-1-0
8064 @opindex mpa-risc-1-1
8065 @opindex mpa-risc-2-0
8066 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8068 @item -mbig-switch
8069 @opindex mbig-switch
8070 Generate code suitable for big switch tables.  Use this option only if
8071 the assembler/linker complain about out of range branches within a switch
8072 table.
8074 @item -mjump-in-delay
8075 @opindex mjump-in-delay
8076 Fill delay slots of function calls with unconditional jump instructions
8077 by modifying the return pointer for the function call to be the target
8078 of the conditional jump.
8080 @item -mdisable-fpregs
8081 @opindex mdisable-fpregs
8082 Prevent floating point registers from being used in any manner.  This is
8083 necessary for compiling kernels which perform lazy context switching of
8084 floating point registers.  If you use this option and attempt to perform
8085 floating point operations, the compiler will abort.
8087 @item -mdisable-indexing
8088 @opindex mdisable-indexing
8089 Prevent the compiler from using indexing address modes.  This avoids some
8090 rather obscure problems when compiling MIG generated code under MACH@.
8092 @item -mno-space-regs
8093 @opindex mno-space-regs
8094 Generate code that assumes the target has no space registers.  This allows
8095 GCC to generate faster indirect calls and use unscaled index address modes.
8097 Such code is suitable for level 0 PA systems and kernels.
8099 @item -mfast-indirect-calls
8100 @opindex mfast-indirect-calls
8101 Generate code that assumes calls never cross space boundaries.  This
8102 allows GCC to emit code which performs faster indirect calls.
8104 This option will not work in the presence of shared libraries or nested
8105 functions.
8107 @item -mfixed-range=@var{register-range}
8108 @opindex mfixed-range
8109 Generate code treating the given register range as fixed registers.
8110 A fixed register is one that the register allocator can not use.  This is
8111 useful when compiling kernel code.  A register range is specified as
8112 two registers separated by a dash.  Multiple register ranges can be
8113 specified separated by a comma.
8115 @item -mlong-load-store
8116 @opindex mlong-load-store
8117 Generate 3-instruction load and store sequences as sometimes required by
8118 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8119 the HP compilers.
8121 @item -mportable-runtime
8122 @opindex mportable-runtime
8123 Use the portable calling conventions proposed by HP for ELF systems.
8125 @item -mgas
8126 @opindex mgas
8127 Enable the use of assembler directives only GAS understands.
8129 @item -mschedule=@var{cpu-type}
8130 @opindex mschedule
8131 Schedule code according to the constraints for the machine type
8132 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8133 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8134 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8135 proper scheduling option for your machine.  The default scheduling is
8136 @samp{8000}.
8138 @item -mlinker-opt
8139 @opindex mlinker-opt
8140 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8141 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8142 linkers in which they give bogus error messages when linking some programs.
8144 @item -msoft-float
8145 @opindex msoft-float
8146 Generate output containing library calls for floating point.
8147 @strong{Warning:} the requisite libraries are not available for all HPPA
8148 targets.  Normally the facilities of the machine's usual C compiler are
8149 used, but this cannot be done directly in cross-compilation.  You must make
8150 your own arrangements to provide suitable library functions for
8151 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8152 does provide software floating point support.
8154 @option{-msoft-float} changes the calling convention in the output file;
8155 therefore, it is only useful if you compile @emph{all} of a program with
8156 this option.  In particular, you need to compile @file{libgcc.a}, the
8157 library that comes with GCC, with @option{-msoft-float} in order for
8158 this to work.
8160 @item -msio
8161 @opindex msio
8162 Generate the predefine, @code{_SIO}, for server IO.  The default is
8163 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8164 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
8165 options are available under HP-UX and HI-UX.
8167 @item -mgnu-ld
8168 @opindex gnu-ld
8169 Use GNU ld specific options.  This passes @option{-shared} to ld when
8170 building a shared library.  It is the default when GCC is configured,
8171 explicitly or implicitly, with the GNU linker.  This option does not
8172 have any affect on which ld is called, it only changes what parameters
8173 are passed to that ld.  The ld that is called is determined by the
8174 @option{--with-ld} configure option, GCC's program search path, and
8175 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8176 using @samp{which `gcc -print-prog-name=ld`}.
8178 @item -mhp-ld
8179 @opindex hp-ld
8180 Use HP ld specific options.  This passes @option{-b} to ld when building
8181 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8182 links.  It is the default when GCC is configured, explicitly or
8183 implicitly, with the HP linker.  This option does not have any affect on
8184 which ld is called, it only changes what parameters are passed to that
8185 ld.  The ld that is called is determined by the @option{--with-ld}
8186 configure option, GCC's program search path, and finally by the user's
8187 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8188 `gcc -print-prog-name=ld`}.
8190 @item -mlong-calls
8191 @opindex mno-long-calls
8192 Generate code that uses long call sequences.  This ensures that a call
8193 is always able to reach linker generated stubs.  The default is to generate
8194 long calls only when the distance from the call site to the beginning
8195 of the function or translation unit, as the case may be, exceeds a
8196 predefined limit set by the branch type being used.  The limits for
8197 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8198 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8199 240,000 bytes.
8201 Distances are measured from the beginning of functions when using the
8202 @option{-ffunction-sections} option, or when using the @option{-mgas}
8203 and @option{-mno-portable-runtime} options together under HP-UX with
8204 the SOM linker.
8206 It is normally not desirable to use this option as it will degrade
8207 performance.  However, it may be useful in large applications,
8208 particularly when partial linking is used to build the application.
8210 The types of long calls used depends on the capabilities of the
8211 assembler and linker, and the type of code being generated.  The
8212 impact on systems that support long absolute calls, and long pic
8213 symbol-difference or pc-relative calls should be relatively small.
8214 However, an indirect call is used on 32-bit ELF systems in pic code
8215 and it is quite long.
8217 @item -munix=@var{unix-std}
8218 @opindex march
8219 Generate compiler predefines and select a startfile for the specified
8220 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8221 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8222 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8223 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8224 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8225 and later.
8227 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8228 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8229 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8230 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8231 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8232 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8234 It is @emph{important} to note that this option changes the interfaces
8235 for various library routines.  It also affects the operational behavior
8236 of the C library.  Thus, @emph{extreme} care is needed in using this
8237 option.
8239 Library code that is intended to operate with more than one UNIX
8240 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8241 as appropriate.  Most GNU software doesn't provide this capability.
8243 @item -nolibdld
8244 @opindex nolibdld
8245 Suppress the generation of link options to search libdld.sl when the
8246 @option{-static} option is specified on HP-UX 10 and later.
8248 @item -static
8249 @opindex static
8250 The HP-UX implementation of setlocale in libc has a dependency on
8251 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8252 when the @option{-static} option is specified, special link options
8253 are needed to resolve this dependency.
8255 On HP-UX 10 and later, the GCC driver adds the necessary options to
8256 link with libdld.sl when the @option{-static} option is specified.
8257 This causes the resulting binary to be dynamic.  On the 64-bit port,
8258 the linkers generate dynamic binaries by default in any case.  The
8259 @option{-nolibdld} option can be used to prevent the GCC driver from
8260 adding these link options.
8262 @item -threads
8263 @opindex threads
8264 Add support for multithreading with the @dfn{dce thread} library
8265 under HP-UX.  This option sets flags for both the preprocessor and
8266 linker.
8267 @end table
8269 @node i386 and x86-64 Options
8270 @subsection Intel 386 and AMD x86-64 Options
8271 @cindex i386 Options
8272 @cindex x86-64 Options
8273 @cindex Intel 386 Options
8274 @cindex AMD x86-64 Options
8276 These @samp{-m} options are defined for the i386 and x86-64 family of
8277 computers:
8279 @table @gcctabopt
8280 @item -mtune=@var{cpu-type}
8281 @opindex mtune
8282 Tune to @var{cpu-type} everything applicable about the generated code, except
8283 for the ABI and the set of available instructions.  The choices for
8284 @var{cpu-type} are:
8285 @table @emph
8286 @item i386
8287 Original Intel's i386 CPU.
8288 @item i486
8289 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8290 @item i586, pentium
8291 Intel Pentium CPU with no MMX support.
8292 @item pentium-mmx
8293 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8294 @item i686, pentiumpro
8295 Intel PentiumPro CPU.
8296 @item pentium2
8297 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8298 @item pentium3, pentium3m
8299 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8300 support.
8301 @item pentium-m
8302 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8303 support.  Used by Centrino notebooks.
8304 @item pentium4, pentium4m
8305 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8306 @item prescott
8307 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8308 set support.
8309 @item nocona
8310 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8311 SSE2 and SSE3 instruction set support.
8312 @item k6
8313 AMD K6 CPU with MMX instruction set support.
8314 @item k6-2, k6-3
8315 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8316 @item athlon, athlon-tbird
8317 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8318 support.
8319 @item athlon-4, athlon-xp, athlon-mp
8320 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8321 instruction set support.
8322 @item k8, opteron, athlon64, athlon-fx
8323 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8324 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8325 @item winchip-c6
8326 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8327 set support.
8328 @item winchip2
8329 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8330 instruction set support.
8331 @item c3
8332 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8333 implemented for this chip.)
8334 @item c3-2
8335 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8336 implemented for this chip.)
8337 @end table
8339 While picking a specific @var{cpu-type} will schedule things appropriately
8340 for that particular chip, the compiler will not generate any code that
8341 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8342 being used.
8344 @item -march=@var{cpu-type}
8345 @opindex march
8346 Generate instructions for the machine type @var{cpu-type}.  The choices
8347 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8348 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8350 @item -mcpu=@var{cpu-type}
8351 @opindex mcpu
8352 A deprecated synonym for @option{-mtune}.
8354 @item -m386
8355 @itemx -m486
8356 @itemx -mpentium
8357 @itemx -mpentiumpro
8358 @opindex m386
8359 @opindex m486
8360 @opindex mpentium
8361 @opindex mpentiumpro
8362 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8363 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8364 These synonyms are deprecated.
8366 @item -mfpmath=@var{unit}
8367 @opindex march
8368 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8369 for @var{unit} are:
8371 @table @samp
8372 @item 387
8373 Use the standard 387 floating point coprocessor present majority of chips and
8374 emulated otherwise.  Code compiled with this option will run almost everywhere.
8375 The temporary results are computed in 80bit precision instead of precision
8376 specified by the type resulting in slightly different results compared to most
8377 of other chips. See @option{-ffloat-store} for more detailed description.
8379 This is the default choice for i386 compiler.
8381 @item sse
8382 Use scalar floating point instructions present in the SSE instruction set.
8383 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8384 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8385 instruction set supports only single precision arithmetics, thus the double and
8386 extended precision arithmetics is still done using 387.  Later version, present
8387 only in Pentium4 and the future AMD x86-64 chips supports double precision
8388 arithmetics too.
8390 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8391 @option{-msse2} switches to enable SSE extensions and make this option
8392 effective.  For x86-64 compiler, these extensions are enabled by default.
8394 The resulting code should be considerably faster in the majority of cases and avoid
8395 the numerical instability problems of 387 code, but may break some existing
8396 code that expects temporaries to be 80bit.
8398 This is the default choice for the x86-64 compiler.
8400 @item sse,387
8401 Attempt to utilize both instruction sets at once.  This effectively double the
8402 amount of available registers and on chips with separate execution units for
8403 387 and SSE the execution resources too.  Use this option with care, as it is
8404 still experimental, because the GCC register allocator does not model separate
8405 functional units well resulting in instable performance.
8406 @end table
8408 @item -masm=@var{dialect}
8409 @opindex masm=@var{dialect}
8410 Output asm instructions using selected @var{dialect}. Supported choices are
8411 @samp{intel} or @samp{att} (the default one).
8413 @item -mieee-fp
8414 @itemx -mno-ieee-fp
8415 @opindex mieee-fp
8416 @opindex mno-ieee-fp
8417 Control whether or not the compiler uses IEEE floating point
8418 comparisons.  These handle correctly the case where the result of a
8419 comparison is unordered.
8421 @item -msoft-float
8422 @opindex msoft-float
8423 Generate output containing library calls for floating point.
8424 @strong{Warning:} the requisite libraries are not part of GCC@.
8425 Normally the facilities of the machine's usual C compiler are used, but
8426 this can't be done directly in cross-compilation.  You must make your
8427 own arrangements to provide suitable library functions for
8428 cross-compilation.
8430 On machines where a function returns floating point results in the 80387
8431 register stack, some floating point opcodes may be emitted even if
8432 @option{-msoft-float} is used.
8434 @item -mno-fp-ret-in-387
8435 @opindex mno-fp-ret-in-387
8436 Do not use the FPU registers for return values of functions.
8438 The usual calling convention has functions return values of types
8439 @code{float} and @code{double} in an FPU register, even if there
8440 is no FPU@.  The idea is that the operating system should emulate
8441 an FPU@.
8443 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8444 in ordinary CPU registers instead.
8446 @item -mno-fancy-math-387
8447 @opindex mno-fancy-math-387
8448 Some 387 emulators do not support the @code{sin}, @code{cos} and
8449 @code{sqrt} instructions for the 387.  Specify this option to avoid
8450 generating those instructions.  This option is the default on FreeBSD,
8451 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8452 indicates that the target cpu will always have an FPU and so the
8453 instruction will not need emulation.  As of revision 2.6.1, these
8454 instructions are not generated unless you also use the
8455 @option{-funsafe-math-optimizations} switch.
8457 @item -malign-double
8458 @itemx -mno-align-double
8459 @opindex malign-double
8460 @opindex mno-align-double
8461 Control whether GCC aligns @code{double}, @code{long double}, and
8462 @code{long long} variables on a two word boundary or a one word
8463 boundary.  Aligning @code{double} variables on a two word boundary will
8464 produce code that runs somewhat faster on a @samp{Pentium} at the
8465 expense of more memory.
8467 @strong{Warning:} if you use the @option{-malign-double} switch,
8468 structures containing the above types will be aligned differently than
8469 the published application binary interface specifications for the 386
8470 and will not be binary compatible with structures in code compiled
8471 without that switch.
8473 @item -m96bit-long-double
8474 @itemx -m128bit-long-double
8475 @opindex m96bit-long-double
8476 @opindex m128bit-long-double
8477 These switches control the size of @code{long double} type. The i386
8478 application binary interface specifies the size to be 96 bits,
8479 so @option{-m96bit-long-double} is the default in 32 bit mode.
8481 Modern architectures (Pentium and newer) would prefer @code{long double}
8482 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8483 conforming to the ABI, this would not be possible.  So specifying a
8484 @option{-m128bit-long-double} will align @code{long double}
8485 to a 16 byte boundary by padding the @code{long double} with an additional
8486 32 bit zero.
8488 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8489 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8491 Notice that neither of these options enable any extra precision over the x87
8492 standard of 80 bits for a @code{long double}.
8494 @strong{Warning:} if you override the default value for your target ABI, the
8495 structures and arrays containing @code{long double} variables will change
8496 their size as well as function calling convention for function taking
8497 @code{long double} will be modified.  Hence they will not be binary
8498 compatible with arrays or structures in code compiled without that switch.
8501 @item -msvr3-shlib
8502 @itemx -mno-svr3-shlib
8503 @opindex msvr3-shlib
8504 @opindex mno-svr3-shlib
8505 Control whether GCC places uninitialized local variables into the
8506 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8507 into @code{bss}.  These options are meaningful only on System V Release 3.
8509 @item -mrtd
8510 @opindex mrtd
8511 Use a different function-calling convention, in which functions that
8512 take a fixed number of arguments return with the @code{ret} @var{num}
8513 instruction, which pops their arguments while returning.  This saves one
8514 instruction in the caller since there is no need to pop the arguments
8515 there.
8517 You can specify that an individual function is called with this calling
8518 sequence with the function attribute @samp{stdcall}.  You can also
8519 override the @option{-mrtd} option by using the function attribute
8520 @samp{cdecl}.  @xref{Function Attributes}.
8522 @strong{Warning:} this calling convention is incompatible with the one
8523 normally used on Unix, so you cannot use it if you need to call
8524 libraries compiled with the Unix compiler.
8526 Also, you must provide function prototypes for all functions that
8527 take variable numbers of arguments (including @code{printf});
8528 otherwise incorrect code will be generated for calls to those
8529 functions.
8531 In addition, seriously incorrect code will result if you call a
8532 function with too many arguments.  (Normally, extra arguments are
8533 harmlessly ignored.)
8535 @item -mregparm=@var{num}
8536 @opindex mregparm
8537 Control how many registers are used to pass integer arguments.  By
8538 default, no registers are used to pass arguments, and at most 3
8539 registers can be used.  You can control this behavior for a specific
8540 function by using the function attribute @samp{regparm}.
8541 @xref{Function Attributes}.
8543 @strong{Warning:} if you use this switch, and
8544 @var{num} is nonzero, then you must build all modules with the same
8545 value, including any libraries.  This includes the system libraries and
8546 startup modules.
8548 @item -mpreferred-stack-boundary=@var{num}
8549 @opindex mpreferred-stack-boundary
8550 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8551 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8552 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8553 size (@option{-Os}), in which case the default is the minimum correct
8554 alignment (4 bytes for x86, and 8 bytes for x86-64).
8556 On Pentium and PentiumPro, @code{double} and @code{long double} values
8557 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8558 suffer significant run time performance penalties.  On Pentium III, the
8559 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8560 penalties if it is not 16 byte aligned.
8562 To ensure proper alignment of this values on the stack, the stack boundary
8563 must be as aligned as that required by any value stored on the stack.
8564 Further, every function must be generated such that it keeps the stack
8565 aligned.  Thus calling a function compiled with a higher preferred
8566 stack boundary from a function compiled with a lower preferred stack
8567 boundary will most likely misalign the stack.  It is recommended that
8568 libraries that use callbacks always use the default setting.
8570 This extra alignment does consume extra stack space, and generally
8571 increases code size.  Code that is sensitive to stack space usage, such
8572 as embedded systems and operating system kernels, may want to reduce the
8573 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8575 @item -mmmx
8576 @itemx -mno-mmx
8577 @item -msse
8578 @itemx -mno-sse
8579 @item -msse2
8580 @itemx -mno-sse2
8581 @item -msse3
8582 @itemx -mno-sse3
8583 @item -m3dnow
8584 @itemx -mno-3dnow
8585 @opindex mmmx
8586 @opindex mno-mmx
8587 @opindex msse
8588 @opindex mno-sse
8589 @opindex m3dnow
8590 @opindex mno-3dnow
8591 These switches enable or disable the use of built-in functions that allow
8592 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8593 instruction set.
8595 @xref{X86 Built-in Functions}, for details of the functions enabled
8596 and disabled by these switches.
8598 To have SSE/SSE2 instructions generated automatically from floating-point
8599 code, see @option{-mfpmath=sse}.
8601 @item -mpush-args
8602 @itemx -mno-push-args
8603 @opindex mpush-args
8604 @opindex mno-push-args
8605 Use PUSH operations to store outgoing parameters.  This method is shorter
8606 and usually equally fast as method using SUB/MOV operations and is enabled
8607 by default.  In some cases disabling it may improve performance because of
8608 improved scheduling and reduced dependencies.
8610 @item -maccumulate-outgoing-args
8611 @opindex maccumulate-outgoing-args
8612 If enabled, the maximum amount of space required for outgoing arguments will be
8613 computed in the function prologue.  This is faster on most modern CPUs
8614 because of reduced dependencies, improved scheduling and reduced stack usage
8615 when preferred stack boundary is not equal to 2.  The drawback is a notable
8616 increase in code size.  This switch implies @option{-mno-push-args}.
8618 @item -mthreads
8619 @opindex mthreads
8620 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8621 on thread-safe exception handling must compile and link all code with the
8622 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8623 @option{-D_MT}; when linking, it links in a special thread helper library
8624 @option{-lmingwthrd} which cleans up per thread exception handling data.
8626 @item -mno-align-stringops
8627 @opindex mno-align-stringops
8628 Do not align destination of inlined string operations.  This switch reduces
8629 code size and improves performance in case the destination is already aligned,
8630 but GCC doesn't know about it.
8632 @item -minline-all-stringops
8633 @opindex minline-all-stringops
8634 By default GCC inlines string operations only when destination is known to be
8635 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8636 size, but may improve performance of code that depends on fast memcpy, strlen
8637 and memset for short lengths.
8639 @item -momit-leaf-frame-pointer
8640 @opindex momit-leaf-frame-pointer
8641 Don't keep the frame pointer in a register for leaf functions.  This
8642 avoids the instructions to save, set up and restore frame pointers and
8643 makes an extra register available in leaf functions.  The option
8644 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8645 which might make debugging harder.
8647 @item -mtls-direct-seg-refs
8648 @itemx -mno-tls-direct-seg-refs
8649 @opindex mtls-direct-seg-refs
8650 Controls whether TLS variables may be accessed with offsets from the
8651 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8652 or whether the thread base pointer must be added.  Whether or not this
8653 is legal depends on the operating system, and whether it maps the
8654 segment to cover the entire TLS area.
8656 For systems that use GNU libc, the default is on.
8657 @end table
8659 These @samp{-m} switches are supported in addition to the above
8660 on AMD x86-64 processors in 64-bit environments.
8662 @table @gcctabopt
8663 @item -m32
8664 @itemx -m64
8665 @opindex m32
8666 @opindex m64
8667 Generate code for a 32-bit or 64-bit environment.
8668 The 32-bit environment sets int, long and pointer to 32 bits and
8669 generates code that runs on any i386 system.
8670 The 64-bit environment sets int to 32 bits and long and pointer
8671 to 64 bits and generates code for AMD's x86-64 architecture.
8673 @item -mno-red-zone
8674 @opindex no-red-zone
8675 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8676 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8677 stack pointer that will not be modified by signal or interrupt handlers
8678 and therefore can be used for temporary data without adjusting the stack
8679 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8681 @item -mcmodel=small
8682 @opindex mcmodel=small
8683 Generate code for the small code model: the program and its symbols must
8684 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8685 Programs can be statically or dynamically linked.  This is the default
8686 code model.
8688 @item -mcmodel=kernel
8689 @opindex mcmodel=kernel
8690 Generate code for the kernel code model.  The kernel runs in the
8691 negative 2 GB of the address space.
8692 This model has to be used for Linux kernel code.
8694 @item -mcmodel=medium
8695 @opindex mcmodel=medium
8696 Generate code for the medium model: The program is linked in the lower 2
8697 GB of the address space but symbols can be located anywhere in the
8698 address space.  Programs can be statically or dynamically linked, but
8699 building of shared libraries are not supported with the medium model.
8701 @item -mcmodel=large
8702 @opindex mcmodel=large
8703 Generate code for the large model: This model makes no assumptions
8704 about addresses and sizes of sections.  Currently GCC does not implement
8705 this model.
8706 @end table
8708 @node IA-64 Options
8709 @subsection IA-64 Options
8710 @cindex IA-64 Options
8712 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8714 @table @gcctabopt
8715 @item -mbig-endian
8716 @opindex mbig-endian
8717 Generate code for a big endian target.  This is the default for HP-UX@.
8719 @item -mlittle-endian
8720 @opindex mlittle-endian
8721 Generate code for a little endian target.  This is the default for AIX5
8722 and GNU/Linux.
8724 @item -mgnu-as
8725 @itemx -mno-gnu-as
8726 @opindex mgnu-as
8727 @opindex mno-gnu-as
8728 Generate (or don't) code for the GNU assembler.  This is the default.
8729 @c Also, this is the default if the configure option @option{--with-gnu-as}
8730 @c is used.
8732 @item -mgnu-ld
8733 @itemx -mno-gnu-ld
8734 @opindex mgnu-ld
8735 @opindex mno-gnu-ld
8736 Generate (or don't) code for the GNU linker.  This is the default.
8737 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8738 @c is used.
8740 @item -mno-pic
8741 @opindex mno-pic
8742 Generate code that does not use a global pointer register.  The result
8743 is not position independent code, and violates the IA-64 ABI@.
8745 @item -mvolatile-asm-stop
8746 @itemx -mno-volatile-asm-stop
8747 @opindex mvolatile-asm-stop
8748 @opindex mno-volatile-asm-stop
8749 Generate (or don't) a stop bit immediately before and after volatile asm
8750 statements.
8752 @item -mb-step
8753 @opindex mb-step
8754 Generate code that works around Itanium B step errata.
8756 @item -mregister-names
8757 @itemx -mno-register-names
8758 @opindex mregister-names
8759 @opindex mno-register-names
8760 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8761 the stacked registers.  This may make assembler output more readable.
8763 @item -mno-sdata
8764 @itemx -msdata
8765 @opindex mno-sdata
8766 @opindex msdata
8767 Disable (or enable) optimizations that use the small data section.  This may
8768 be useful for working around optimizer bugs.
8770 @item -mconstant-gp
8771 @opindex mconstant-gp
8772 Generate code that uses a single constant global pointer value.  This is
8773 useful when compiling kernel code.
8775 @item -mauto-pic
8776 @opindex mauto-pic
8777 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8778 This is useful when compiling firmware code.
8780 @item -minline-float-divide-min-latency
8781 @opindex minline-float-divide-min-latency
8782 Generate code for inline divides of floating point values
8783 using the minimum latency algorithm.
8785 @item -minline-float-divide-max-throughput
8786 @opindex minline-float-divide-max-throughput
8787 Generate code for inline divides of floating point values
8788 using the maximum throughput algorithm.
8790 @item -minline-int-divide-min-latency
8791 @opindex minline-int-divide-min-latency
8792 Generate code for inline divides of integer values
8793 using the minimum latency algorithm.
8795 @item -minline-int-divide-max-throughput
8796 @opindex minline-int-divide-max-throughput
8797 Generate code for inline divides of integer values
8798 using the maximum throughput algorithm.
8800 @item -mno-dwarf2-asm
8801 @itemx -mdwarf2-asm
8802 @opindex mno-dwarf2-asm
8803 @opindex mdwarf2-asm
8804 Don't (or do) generate assembler code for the DWARF2 line number debugging
8805 info.  This may be useful when not using the GNU assembler.
8807 @item -mfixed-range=@var{register-range}
8808 @opindex mfixed-range
8809 Generate code treating the given register range as fixed registers.
8810 A fixed register is one that the register allocator can not use.  This is
8811 useful when compiling kernel code.  A register range is specified as
8812 two registers separated by a dash.  Multiple register ranges can be
8813 specified separated by a comma.
8815 @item -mearly-stop-bits
8816 @itemx -mno-early-stop-bits
8817 @opindex mearly-stop-bits
8818 @opindex mno-early-stop-bits
8819 Allow stop bits to be placed earlier than immediately preceding the
8820 instruction that triggered the stop bit.  This can improve instruction
8821 scheduling, but does not always do so.
8822 @end table
8824 @node M32R/D Options
8825 @subsection M32R/D Options
8826 @cindex M32R/D options
8828 These @option{-m} options are defined for Renesas M32R/D architectures:
8830 @table @gcctabopt
8831 @item -m32r2
8832 @opindex m32r2
8833 Generate code for the M32R/2@.
8835 @item -m32rx
8836 @opindex m32rx
8837 Generate code for the M32R/X@.
8839 @item -m32r
8840 @opindex m32r
8841 Generate code for the M32R@.  This is the default.
8843 @item -mmodel=small
8844 @opindex mmodel=small
8845 Assume all objects live in the lower 16MB of memory (so that their addresses
8846 can be loaded with the @code{ld24} instruction), and assume all subroutines
8847 are reachable with the @code{bl} instruction.
8848 This is the default.
8850 The addressability of a particular object can be set with the
8851 @code{model} attribute.
8853 @item -mmodel=medium
8854 @opindex mmodel=medium
8855 Assume objects may be anywhere in the 32-bit address space (the compiler
8856 will generate @code{seth/add3} instructions to load their addresses), and
8857 assume all subroutines are reachable with the @code{bl} instruction.
8859 @item -mmodel=large
8860 @opindex mmodel=large
8861 Assume objects may be anywhere in the 32-bit address space (the compiler
8862 will generate @code{seth/add3} instructions to load their addresses), and
8863 assume subroutines may not be reachable with the @code{bl} instruction
8864 (the compiler will generate the much slower @code{seth/add3/jl}
8865 instruction sequence).
8867 @item -msdata=none
8868 @opindex msdata=none
8869 Disable use of the small data area.  Variables will be put into
8870 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8871 @code{section} attribute has been specified).
8872 This is the default.
8874 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8875 Objects may be explicitly put in the small data area with the
8876 @code{section} attribute using one of these sections.
8878 @item -msdata=sdata
8879 @opindex msdata=sdata
8880 Put small global and static data in the small data area, but do not
8881 generate special code to reference them.
8883 @item -msdata=use
8884 @opindex msdata=use
8885 Put small global and static data in the small data area, and generate
8886 special instructions to reference them.
8888 @item -G @var{num}
8889 @opindex G
8890 @cindex smaller data references
8891 Put global and static objects less than or equal to @var{num} bytes
8892 into the small data or bss sections instead of the normal data or bss
8893 sections.  The default value of @var{num} is 8.
8894 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8895 for this option to have any effect.
8897 All modules should be compiled with the same @option{-G @var{num}} value.
8898 Compiling with different values of @var{num} may or may not work; if it
8899 doesn't the linker will give an error message---incorrect code will not be
8900 generated.
8902 @item -mdebug
8903 @opindex mdebug
8904 Makes the M32R specific code in the compiler display some statistics
8905 that might help in debugging programs.
8907 @item -malign-loops
8908 @opindex malign-loops
8909 Align all loops to a 32-byte boundary.
8911 @item -mno-align-loops
8912 @opindex mno-align-loops
8913 Do not enforce a 32-byte alignment for loops.  This is the default.
8915 @item -missue-rate=@var{number}
8916 @opindex missue-rate=@var{number}
8917 Issue @var{number} instructions per cycle.  @var{number} can only be 1
8918 or 2.
8920 @item -mbranch-cost=@var{number}
8921 @opindex mbranch-cost=@var{number}
8922 @var{number} can only be 1 or 2.  If it is 1 then branches will be
8923 preferred over conditional code, if it is 2, then the opposite will
8924 apply.
8926 @item -mflush-trap=@var{number}
8927 @opindex mflush-trap=@var{number}
8928 Specifies the trap number to use to flush the cache.  The default is
8929 12.  Valid numbers are between 0 and 15 inclusive.
8931 @item -mno-flush-trap
8932 @opindex mno-flush-trap
8933 Specifies that the cache cannot be flushed by using a trap.
8935 @item -mflush-func=@var{name}
8936 @opindex mflush-func=@var{name}
8937 Specifies the name of the operating system function to call to flush
8938 the cache.  The default is @emph{_flush_cache}, but a function call
8939 will only be used if a trap is not available.
8941 @item -mno-flush-func
8942 @opindex mno-flush-func
8943 Indicates that there is no OS function for flushing the cache.
8945 @end table
8947 @node M680x0 Options
8948 @subsection M680x0 Options
8949 @cindex M680x0 options
8951 These are the @samp{-m} options defined for the 68000 series.  The default
8952 values for these options depends on which style of 68000 was selected when
8953 the compiler was configured; the defaults for the most common choices are
8954 given below.
8956 @table @gcctabopt
8957 @item -m68000
8958 @itemx -mc68000
8959 @opindex m68000
8960 @opindex mc68000
8961 Generate output for a 68000.  This is the default
8962 when the compiler is configured for 68000-based systems.
8964 Use this option for microcontrollers with a 68000 or EC000 core,
8965 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
8967 @item -m68020
8968 @itemx -mc68020
8969 @opindex m68020
8970 @opindex mc68020
8971 Generate output for a 68020.  This is the default
8972 when the compiler is configured for 68020-based systems.
8974 @item -m68881
8975 @opindex m68881
8976 Generate output containing 68881 instructions for floating point.
8977 This is the default for most 68020 systems unless @option{--nfp} was
8978 specified when the compiler was configured.
8980 @item -m68030
8981 @opindex m68030
8982 Generate output for a 68030.  This is the default when the compiler is
8983 configured for 68030-based systems.
8985 @item -m68040
8986 @opindex m68040
8987 Generate output for a 68040.  This is the default when the compiler is
8988 configured for 68040-based systems.
8990 This option inhibits the use of 68881/68882 instructions that have to be
8991 emulated by software on the 68040.  Use this option if your 68040 does not
8992 have code to emulate those instructions.
8994 @item -m68060
8995 @opindex m68060
8996 Generate output for a 68060.  This is the default when the compiler is
8997 configured for 68060-based systems.
8999 This option inhibits the use of 68020 and 68881/68882 instructions that
9000 have to be emulated by software on the 68060.  Use this option if your 68060
9001 does not have code to emulate those instructions.
9003 @item -mcpu32
9004 @opindex mcpu32
9005 Generate output for a CPU32.  This is the default
9006 when the compiler is configured for CPU32-based systems.
9008 Use this option for microcontrollers with a
9009 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9010 68336, 68340, 68341, 68349 and 68360.
9012 @item -m5200
9013 @opindex m5200
9014 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9015 when the compiler is configured for 520X-based systems.
9017 Use this option for microcontroller with a 5200 core, including
9018 the MCF5202, MCF5203, MCF5204 and MCF5202.
9021 @item -m68020-40
9022 @opindex m68020-40
9023 Generate output for a 68040, without using any of the new instructions.
9024 This results in code which can run relatively efficiently on either a
9025 68020/68881 or a 68030 or a 68040.  The generated code does use the
9026 68881 instructions that are emulated on the 68040.
9028 @item -m68020-60
9029 @opindex m68020-60
9030 Generate output for a 68060, without using any of the new instructions.
9031 This results in code which can run relatively efficiently on either a
9032 68020/68881 or a 68030 or a 68040.  The generated code does use the
9033 68881 instructions that are emulated on the 68060.
9035 @item -msoft-float
9036 @opindex msoft-float
9037 Generate output containing library calls for floating point.
9038 @strong{Warning:} the requisite libraries are not available for all m68k
9039 targets.  Normally the facilities of the machine's usual C compiler are
9040 used, but this can't be done directly in cross-compilation.  You must
9041 make your own arrangements to provide suitable library functions for
9042 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9043 @samp{m68k-*-coff} do provide software floating point support.
9045 @item -mshort
9046 @opindex mshort
9047 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9048 Additionally, parameters passed on the stack are also aligned to a
9049 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9051 @item -mnobitfield
9052 @opindex mnobitfield
9053 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9054 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9056 @item -mbitfield
9057 @opindex mbitfield
9058 Do use the bit-field instructions.  The @option{-m68020} option implies
9059 @option{-mbitfield}.  This is the default if you use a configuration
9060 designed for a 68020.
9062 @item -mrtd
9063 @opindex mrtd
9064 Use a different function-calling convention, in which functions
9065 that take a fixed number of arguments return with the @code{rtd}
9066 instruction, which pops their arguments while returning.  This
9067 saves one instruction in the caller since there is no need to pop
9068 the arguments there.
9070 This calling convention is incompatible with the one normally
9071 used on Unix, so you cannot use it if you need to call libraries
9072 compiled with the Unix compiler.
9074 Also, you must provide function prototypes for all functions that
9075 take variable numbers of arguments (including @code{printf});
9076 otherwise incorrect code will be generated for calls to those
9077 functions.
9079 In addition, seriously incorrect code will result if you call a
9080 function with too many arguments.  (Normally, extra arguments are
9081 harmlessly ignored.)
9083 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9084 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9086 @item -malign-int
9087 @itemx -mno-align-int
9088 @opindex malign-int
9089 @opindex mno-align-int
9090 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9091 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9092 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9093 Aligning variables on 32-bit boundaries produces code that runs somewhat
9094 faster on processors with 32-bit busses at the expense of more memory.
9096 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9097 align structures containing the above types  differently than
9098 most published application binary interface specifications for the m68k.
9100 @item -mpcrel
9101 @opindex mpcrel
9102 Use the pc-relative addressing mode of the 68000 directly, instead of
9103 using a global offset table.  At present, this option implies @option{-fpic},
9104 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9105 not presently supported with @option{-mpcrel}, though this could be supported for
9106 68020 and higher processors.
9108 @item -mno-strict-align
9109 @itemx -mstrict-align
9110 @opindex mno-strict-align
9111 @opindex mstrict-align
9112 Do not (do) assume that unaligned memory references will be handled by
9113 the system.
9115 @item -msep-data
9116 Generate code that allows the data segment to be located in a different
9117 area of memory from the text segment.  This allows for execute in place in
9118 an environment without virtual memory management.  This option implies
9119 @option{-fPIC}.
9121 @item -mno-sep-data
9122 Generate code that assumes that the data segment follows the text segment.
9123 This is the default.
9125 @item -mid-shared-library
9126 Generate code that supports shared libraries via the library ID method.
9127 This allows for execute in place and shared libraries in an environment
9128 without virtual memory management.  This option implies @option{-fPIC}.
9130 @item -mno-id-shared-library
9131 Generate code that doesn't assume ID based shared libraries are being used.
9132 This is the default.
9134 @item -mshared-library-id=n
9135 Specified the identification number of the ID based shared library being
9136 compiled.  Specifying a value of 0 will generate more compact code, specifying
9137 other values will force the allocation of that number to the current
9138 library but is no more space or time efficient than omitting this option.
9140 @end table
9142 @node M68hc1x Options
9143 @subsection M68hc1x Options
9144 @cindex M68hc1x options
9146 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9147 microcontrollers.  The default values for these options depends on
9148 which style of microcontroller was selected when the compiler was configured;
9149 the defaults for the most common choices are given below.
9151 @table @gcctabopt
9152 @item -m6811
9153 @itemx -m68hc11
9154 @opindex m6811
9155 @opindex m68hc11
9156 Generate output for a 68HC11.  This is the default
9157 when the compiler is configured for 68HC11-based systems.
9159 @item -m6812
9160 @itemx -m68hc12
9161 @opindex m6812
9162 @opindex m68hc12
9163 Generate output for a 68HC12.  This is the default
9164 when the compiler is configured for 68HC12-based systems.
9166 @item -m68S12
9167 @itemx -m68hcs12
9168 @opindex m68S12
9169 @opindex m68hcs12
9170 Generate output for a 68HCS12.
9172 @item -mauto-incdec
9173 @opindex mauto-incdec
9174 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9175 addressing modes.
9177 @item -minmax
9178 @itemx -nominmax
9179 @opindex minmax
9180 @opindex mnominmax
9181 Enable the use of 68HC12 min and max instructions.
9183 @item -mlong-calls
9184 @itemx -mno-long-calls
9185 @opindex mlong-calls
9186 @opindex mno-long-calls
9187 Treat all calls as being far away (near).  If calls are assumed to be
9188 far away, the compiler will use the @code{call} instruction to
9189 call a function and the @code{rtc} instruction for returning.
9191 @item -mshort
9192 @opindex mshort
9193 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9195 @item -msoft-reg-count=@var{count}
9196 @opindex msoft-reg-count
9197 Specify the number of pseudo-soft registers which are used for the
9198 code generation.  The maximum number is 32.  Using more pseudo-soft
9199 register may or may not result in better code depending on the program.
9200 The default is 4 for 68HC11 and 2 for 68HC12.
9202 @end table
9204 @node MCore Options
9205 @subsection MCore Options
9206 @cindex MCore options
9208 These are the @samp{-m} options defined for the Motorola M*Core
9209 processors.
9211 @table @gcctabopt
9213 @item -mhardlit
9214 @itemx -mno-hardlit
9215 @opindex mhardlit
9216 @opindex mno-hardlit
9217 Inline constants into the code stream if it can be done in two
9218 instructions or less.
9220 @item -mdiv
9221 @itemx -mno-div
9222 @opindex mdiv
9223 @opindex mno-div
9224 Use the divide instruction.  (Enabled by default).
9226 @item -mrelax-immediate
9227 @itemx -mno-relax-immediate
9228 @opindex mrelax-immediate
9229 @opindex mno-relax-immediate
9230 Allow arbitrary sized immediates in bit operations.
9232 @item -mwide-bitfields
9233 @itemx -mno-wide-bitfields
9234 @opindex mwide-bitfields
9235 @opindex mno-wide-bitfields
9236 Always treat bit-fields as int-sized.
9238 @item -m4byte-functions
9239 @itemx -mno-4byte-functions
9240 @opindex m4byte-functions
9241 @opindex mno-4byte-functions
9242 Force all functions to be aligned to a four byte boundary.
9244 @item -mcallgraph-data
9245 @itemx -mno-callgraph-data
9246 @opindex mcallgraph-data
9247 @opindex mno-callgraph-data
9248 Emit callgraph information.
9250 @item -mslow-bytes
9251 @itemx -mno-slow-bytes
9252 @opindex mslow-bytes
9253 @opindex mno-slow-bytes
9254 Prefer word access when reading byte quantities.
9256 @item -mlittle-endian
9257 @itemx -mbig-endian
9258 @opindex mlittle-endian
9259 @opindex mbig-endian
9260 Generate code for a little endian target.
9262 @item -m210
9263 @itemx -m340
9264 @opindex m210
9265 @opindex m340
9266 Generate code for the 210 processor.
9267 @end table
9269 @node MIPS Options
9270 @subsection MIPS Options
9271 @cindex MIPS options
9273 @table @gcctabopt
9275 @item -EB
9276 @opindex EB
9277 Generate big-endian code.
9279 @item -EL
9280 @opindex EL
9281 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9282 configurations.
9284 @item -march=@var{arch}
9285 @opindex march
9286 Generate code that will run on @var{arch}, which can be the name of a
9287 generic MIPS ISA, or the name of a particular processor.
9288 The ISA names are:
9289 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9290 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9291 The processor names are:
9292 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9293 @samp{m4k},
9294 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9295 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9296 @samp{rm9000},
9297 @samp{orion},
9298 @samp{sb1},
9299 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9300 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9301 The special value @samp{from-abi} selects the
9302 most compatible architecture for the selected ABI (that is,
9303 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9305 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9306 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9307 @samp{vr} may be written @samp{r}.
9309 GCC defines two macros based on the value of this option.  The first
9310 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9311 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9312 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9313 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9314 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9316 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9317 above.  In other words, it will have the full prefix and will not
9318 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9319 the macro names the resolved architecture (either @samp{"mips1"} or
9320 @samp{"mips3"}).  It names the default architecture when no
9321 @option{-march} option is given.
9323 @item -mtune=@var{arch}
9324 @opindex mtune
9325 Optimize for @var{arch}.  Among other things, this option controls
9326 the way instructions are scheduled, and the perceived cost of arithmetic
9327 operations.  The list of @var{arch} values is the same as for
9328 @option{-march}.
9330 When this option is not used, GCC will optimize for the processor
9331 specified by @option{-march}.  By using @option{-march} and
9332 @option{-mtune} together, it is possible to generate code that will
9333 run on a family of processors, but optimize the code for one
9334 particular member of that family.
9336 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9337 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9338 @samp{-march} ones described above.
9340 @item -mips1
9341 @opindex mips1
9342 Equivalent to @samp{-march=mips1}.
9344 @item -mips2
9345 @opindex mips2
9346 Equivalent to @samp{-march=mips2}.
9348 @item -mips3
9349 @opindex mips3
9350 Equivalent to @samp{-march=mips3}.
9352 @item -mips4
9353 @opindex mips4
9354 Equivalent to @samp{-march=mips4}.
9356 @item -mips32
9357 @opindex mips32
9358 Equivalent to @samp{-march=mips32}.
9360 @item -mips32r2
9361 @opindex mips32r2
9362 Equivalent to @samp{-march=mips32r2}.
9364 @item -mips64
9365 @opindex mips64
9366 Equivalent to @samp{-march=mips64}.
9368 @item -mips16
9369 @itemx -mno-mips16
9370 @opindex mips16
9371 @opindex mno-mips16
9372 Use (do not use) the MIPS16 ISA.
9374 @item -mabi=32
9375 @itemx -mabi=o64
9376 @itemx -mabi=n32
9377 @itemx -mabi=64
9378 @itemx -mabi=eabi
9379 @opindex mabi=32
9380 @opindex mabi=o64
9381 @opindex mabi=n32
9382 @opindex mabi=64
9383 @opindex mabi=eabi
9384 Generate code for the given ABI@.
9386 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9387 generates 64-bit code when you select a 64-bit architecture, but you
9388 can use @option{-mgp32} to get 32-bit code instead.
9390 For information about the O64 ABI, see
9391 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9393 @item -mabicalls
9394 @itemx -mno-abicalls
9395 @opindex mabicalls
9396 @opindex mno-abicalls
9397 Generate (do not generate) SVR4-style position-independent code.
9398 @option{-mabicalls} is the default for SVR4-based systems.
9400 @item -mxgot
9401 @itemx -mno-xgot
9402 @opindex mxgot
9403 @opindex mno-xgot
9404 Lift (do not lift) the usual restrictions on the size of the global
9405 offset table.
9407 GCC normally uses a single instruction to load values from the GOT.
9408 While this is relatively efficient, it will only work if the GOT
9409 is smaller than about 64k.  Anything larger will cause the linker
9410 to report an error such as:
9412 @cindex relocation truncated to fit (MIPS)
9413 @smallexample
9414 relocation truncated to fit: R_MIPS_GOT16 foobar
9415 @end smallexample
9417 If this happens, you should recompile your code with @option{-mxgot}.
9418 It should then work with very large GOTs, although it will also be
9419 less efficient, since it will take three instructions to fetch the
9420 value of a global symbol.
9422 Note that some linkers can create multiple GOTs.  If you have such a
9423 linker, you should only need to use @option{-mxgot} when a single object
9424 file accesses more than 64k's worth of GOT entries.  Very few do.
9426 These options have no effect unless GCC is generating position
9427 independent code.
9429 @item -mgp32
9430 @opindex mgp32
9431 Assume that general-purpose registers are 32 bits wide.
9433 @item -mgp64
9434 @opindex mgp64
9435 Assume that general-purpose registers are 64 bits wide.
9437 @item -mfp32
9438 @opindex mfp32
9439 Assume that floating-point registers are 32 bits wide.
9441 @item -mfp64
9442 @opindex mfp64
9443 Assume that floating-point registers are 64 bits wide.
9445 @item -mhard-float
9446 @opindex mhard-float
9447 Use floating-point coprocessor instructions.
9449 @item -msoft-float
9450 @opindex msoft-float
9451 Do not use floating-point coprocessor instructions.  Implement
9452 floating-point calculations using library calls instead.
9454 @item -msingle-float
9455 @opindex msingle-float
9456 Assume that the floating-point coprocessor only supports single-precision
9457 operations.
9459 @itemx -mdouble-float
9460 @opindex mdouble-float
9461 Assume that the floating-point coprocessor supports double-precision
9462 operations.  This is the default.
9464 @itemx -mpaired-single
9465 @itemx -mno-paired-single
9466 @opindex mpaired-single
9467 @opindex mno-paired-single
9468 Use (do not use) paired-single floating-point instructions.
9469 @xref{MIPS Paired-Single Support}.  This option can only be used
9470 when generating 64-bit code and requires hardware floating-point
9471 support to be enabled.
9473 @itemx -mips3d
9474 @itemx -mno-mips3d
9475 @opindex mips3d
9476 @opindex mno-mips3d
9477 Use (do not use) the MIPS-3D ASE.  @xref{MIPS-3D Built-in Functions}.
9478 The option @option{-mips3d} implies @option{-mpaired-single}.
9480 @item -mint64
9481 @opindex mint64
9482 Force @code{int} and @code{long} types to be 64 bits wide.  See
9483 @option{-mlong32} for an explanation of the default and the way
9484 that the pointer size is determined.
9486 @item -mlong64
9487 @opindex mlong64
9488 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9489 an explanation of the default and the way that the pointer size is
9490 determined.
9492 @item -mlong32
9493 @opindex mlong32
9494 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9496 The default size of @code{int}s, @code{long}s and pointers depends on
9497 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9498 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9499 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9500 or the same size as integer registers, whichever is smaller.
9502 @item -G @var{num}
9503 @opindex G
9504 @cindex smaller data references (MIPS)
9505 @cindex gp-relative references (MIPS)
9506 Put global and static items less than or equal to @var{num} bytes into
9507 the small data or bss section instead of the normal data or bss section.
9508 This allows the data to be accessed using a single instruction.
9510 All modules should be compiled with the same @option{-G @var{num}}
9511 value.
9513 @item -membedded-data
9514 @itemx -mno-embedded-data
9515 @opindex membedded-data
9516 @opindex mno-embedded-data
9517 Allocate variables to the read-only data section first if possible, then
9518 next in the small data section if possible, otherwise in data.  This gives
9519 slightly slower code than the default, but reduces the amount of RAM required
9520 when executing, and thus may be preferred for some embedded systems.
9522 @item -muninit-const-in-rodata
9523 @itemx -mno-uninit-const-in-rodata
9524 @opindex muninit-const-in-rodata
9525 @opindex mno-uninit-const-in-rodata
9526 Put uninitialized @code{const} variables in the read-only data section.
9527 This option is only meaningful in conjunction with @option{-membedded-data}.
9529 @item -msplit-addresses
9530 @itemx -mno-split-addresses
9531 @opindex msplit-addresses
9532 @opindex mno-split-addresses
9533 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9534 relocation operators.  This option has been superceded by
9535 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9537 @item -mexplicit-relocs
9538 @itemx -mno-explicit-relocs
9539 @opindex mexplicit-relocs
9540 @opindex mno-explicit-relocs
9541 Use (do not use) assembler relocation operators when dealing with symbolic
9542 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9543 is to use assembler macros instead.
9545 @option{-mexplicit-relocs} is the default if GCC was configured
9546 to use an assembler that supports relocation operators.
9548 @item -mcheck-zero-division
9549 @itemx -mno-check-zero-division
9550 @opindex mcheck-zero-division
9551 @opindex mno-check-zero-division
9552 Trap (do not trap) on integer division by zero.  The default is
9553 @option{-mcheck-zero-division}.
9555 @item -mdivide-traps
9556 @itemx -mdivide-breaks
9557 @opindex mdivide-traps
9558 @opindex mdivide-breaks
9559 MIPS systems check for division by zero by generating either a
9560 conditional trap or a break instruction.  Using traps results in
9561 smaller code, but is only supported on MIPS II and later.  Also, some
9562 versions of the Linux kernel have a bug that prevents trap from
9563 generating the proper signal (SIGFPE).  Use @option{-mdivide-traps} to
9564 allow conditional traps on architectures that support them and
9565 @option{-mdivide-breaks} to force the use of breaks.
9567 The default is usually @option{-mdivide-traps}, but this can be
9568 overridden at configure time using @option{--with-divide=breaks}.
9569 Divide-by-zero checks can be completely disabled using
9570 @option{-mno-check-zero-division}.
9572 @item -mmemcpy
9573 @itemx -mno-memcpy
9574 @opindex mmemcpy
9575 @opindex mno-memcpy
9576 Force (do not force) the use of @code{memcpy()} for non-trivial block
9577 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9578 most constant-sized copies.
9580 @item -mlong-calls
9581 @itemx -mno-long-calls
9582 @opindex mlong-calls
9583 @opindex mno-long-calls
9584 Disable (do not disable) use of the @code{jal} instruction.  Calling
9585 functions using @code{jal} is more efficient but requires the caller
9586 and callee to be in the same 256 megabyte segment.
9588 This option has no effect on abicalls code.  The default is
9589 @option{-mno-long-calls}.
9591 @item -mmad
9592 @itemx -mno-mad
9593 @opindex mmad
9594 @opindex mno-mad
9595 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9596 instructions, as provided by the R4650 ISA.
9598 @item -mfused-madd
9599 @itemx -mno-fused-madd
9600 @opindex mfused-madd
9601 @opindex mno-fused-madd
9602 Enable (disable) use of the floating point multiply-accumulate
9603 instructions, when they are available.  The default is
9604 @option{-mfused-madd}.
9606 When multiply-accumulate instructions are used, the intermediate
9607 product is calculated to infinite precision and is not subject to
9608 the FCSR Flush to Zero bit.  This may be undesirable in some
9609 circumstances.
9611 @item -nocpp
9612 @opindex nocpp
9613 Tell the MIPS assembler to not run its preprocessor over user
9614 assembler files (with a @samp{.s} suffix) when assembling them.
9616 @item -mfix-r4000
9617 @itemx -mno-fix-r4000
9618 @opindex mfix-r4000
9619 @opindex mno-fix-r4000
9620 Work around certain R4000 CPU errata:
9621 @itemize @minus
9622 @item
9623 A double-word or a variable shift may give an incorrect result if executed
9624 immediately after starting an integer division.
9625 @item
9626 A double-word or a variable shift may give an incorrect result if executed
9627 while an integer multiplication is in progress.
9628 @item
9629 An integer division may give an incorrect result if started in a delay slot
9630 of a taken branch or a jump.
9631 @end itemize
9633 @item -mfix-r4400
9634 @itemx -mno-fix-r4400
9635 @opindex mfix-r4400
9636 @opindex mno-fix-r4400
9637 Work around certain R4400 CPU errata:
9638 @itemize @minus
9639 @item
9640 A double-word or a variable shift may give an incorrect result if executed
9641 immediately after starting an integer division.
9642 @end itemize
9644 @item -mfix-vr4120
9645 @itemx -mno-fix-vr4120
9646 @opindex mfix-vr4120
9647 Work around certain VR4120 errata:
9648 @itemize @minus
9649 @item
9650 @code{dmultu} does not always produce the correct result.
9651 @item
9652 @code{div} and @code{ddiv} do not always produce the correct result if one
9653 of the operands is negative.
9654 @end itemize
9655 The workarounds for the division errata rely on special functions in
9656 @file{libgcc.a}.  At present, these functions are only provided by
9657 the @code{mips64vr*-elf} configurations.
9659 Other VR4120 errata require a nop to be inserted between certain pairs of
9660 instructions.  These errata are handled by the assembler, not by GCC itself.
9662 @item -mfix-sb1
9663 @itemx -mno-fix-sb1
9664 @opindex mfix-sb1
9665 Work around certain SB-1 CPU core errata.
9666 (This flag currently works around the SB-1 revision 2
9667 ``F1'' and ``F2'' floating point errata.)
9669 @item -mflush-func=@var{func}
9670 @itemx -mno-flush-func
9671 @opindex mflush-func
9672 Specifies the function to call to flush the I and D caches, or to not
9673 call any such function.  If called, the function must take the same
9674 arguments as the common @code{_flush_func()}, that is, the address of the
9675 memory range for which the cache is being flushed, the size of the
9676 memory range, and the number 3 (to flush both caches).  The default
9677 depends on the target GCC was configured for, but commonly is either
9678 @samp{_flush_func} or @samp{__cpu_flush}.
9680 @item -mbranch-likely
9681 @itemx -mno-branch-likely
9682 @opindex mbranch-likely
9683 @opindex mno-branch-likely
9684 Enable or disable use of Branch Likely instructions, regardless of the
9685 default for the selected architecture.  By default, Branch Likely
9686 instructions may be generated if they are supported by the selected
9687 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9688 and processors which implement those architectures; for those, Branch
9689 Likely instructions will not be generated by default because the MIPS32
9690 and MIPS64 architectures specifically deprecate their use.
9692 @item -mfp-exceptions
9693 @itemx -mno-fp-exceptions
9694 @opindex mfp-exceptions
9695 Specifies whether FP exceptions are enabled.  This affects how we schedule
9696 FP instructions for some processors.  The default is that FP exceptions are
9697 enabled.
9699 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9700 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9701 FP pipe.
9703 @item -mvr4130-align
9704 @itemx -mno-vr4130-align
9705 @opindex mvr4130-align
9706 The VR4130 pipeline is two-way superscalar, but can only issue two
9707 instructions together if the first one is 8-byte aligned.  When this
9708 option is enabled, GCC will align pairs of instructions that it
9709 thinks should execute in parallel.
9711 This option only has an effect when optimizing for the VR4130.
9712 It normally makes code faster, but at the expense of making it bigger.
9713 It is enabled by default at optimization level @option{-O3}.
9714 @end table
9716 @node MMIX Options
9717 @subsection MMIX Options
9718 @cindex MMIX Options
9720 These options are defined for the MMIX:
9722 @table @gcctabopt
9723 @item -mlibfuncs
9724 @itemx -mno-libfuncs
9725 @opindex mlibfuncs
9726 @opindex mno-libfuncs
9727 Specify that intrinsic library functions are being compiled, passing all
9728 values in registers, no matter the size.
9730 @item -mepsilon
9731 @itemx -mno-epsilon
9732 @opindex mepsilon
9733 @opindex mno-epsilon
9734 Generate floating-point comparison instructions that compare with respect
9735 to the @code{rE} epsilon register.
9737 @item -mabi=mmixware
9738 @itemx -mabi=gnu
9739 @opindex mabi-mmixware
9740 @opindex mabi=gnu
9741 Generate code that passes function parameters and return values that (in
9742 the called function) are seen as registers @code{$0} and up, as opposed to
9743 the GNU ABI which uses global registers @code{$231} and up.
9745 @item -mzero-extend
9746 @itemx -mno-zero-extend
9747 @opindex mzero-extend
9748 @opindex mno-zero-extend
9749 When reading data from memory in sizes shorter than 64 bits, use (do not
9750 use) zero-extending load instructions by default, rather than
9751 sign-extending ones.
9753 @item -mknuthdiv
9754 @itemx -mno-knuthdiv
9755 @opindex mknuthdiv
9756 @opindex mno-knuthdiv
9757 Make the result of a division yielding a remainder have the same sign as
9758 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9759 remainder follows the sign of the dividend.  Both methods are
9760 arithmetically valid, the latter being almost exclusively used.
9762 @item -mtoplevel-symbols
9763 @itemx -mno-toplevel-symbols
9764 @opindex mtoplevel-symbols
9765 @opindex mno-toplevel-symbols
9766 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9767 code can be used with the @code{PREFIX} assembly directive.
9769 @item -melf
9770 @opindex melf
9771 Generate an executable in the ELF format, rather than the default
9772 @samp{mmo} format used by the @command{mmix} simulator.
9774 @item -mbranch-predict
9775 @itemx -mno-branch-predict
9776 @opindex mbranch-predict
9777 @opindex mno-branch-predict
9778 Use (do not use) the probable-branch instructions, when static branch
9779 prediction indicates a probable branch.
9781 @item -mbase-addresses
9782 @itemx -mno-base-addresses
9783 @opindex mbase-addresses
9784 @opindex mno-base-addresses
9785 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9786 base address automatically generates a request (handled by the assembler
9787 and the linker) for a constant to be set up in a global register.  The
9788 register is used for one or more base address requests within the range 0
9789 to 255 from the value held in the register.  The generally leads to short
9790 and fast code, but the number of different data items that can be
9791 addressed is limited.  This means that a program that uses lots of static
9792 data may require @option{-mno-base-addresses}.
9794 @item -msingle-exit
9795 @itemx -mno-single-exit
9796 @opindex msingle-exit
9797 @opindex mno-single-exit
9798 Force (do not force) generated code to have a single exit point in each
9799 function.
9800 @end table
9802 @node MN10300 Options
9803 @subsection MN10300 Options
9804 @cindex MN10300 options
9806 These @option{-m} options are defined for Matsushita MN10300 architectures:
9808 @table @gcctabopt
9809 @item -mmult-bug
9810 @opindex mmult-bug
9811 Generate code to avoid bugs in the multiply instructions for the MN10300
9812 processors.  This is the default.
9814 @item -mno-mult-bug
9815 @opindex mno-mult-bug
9816 Do not generate code to avoid bugs in the multiply instructions for the
9817 MN10300 processors.
9819 @item -mam33
9820 @opindex mam33
9821 Generate code which uses features specific to the AM33 processor.
9823 @item -mno-am33
9824 @opindex mno-am33
9825 Do not generate code which uses features specific to the AM33 processor.  This
9826 is the default.
9828 @item -mno-crt0
9829 @opindex mno-crt0
9830 Do not link in the C run-time initialization object file.
9832 @item -mrelax
9833 @opindex mrelax
9834 Indicate to the linker that it should perform a relaxation optimization pass
9835 to shorten branches, calls and absolute memory addresses.  This option only
9836 has an effect when used on the command line for the final link step.
9838 This option makes symbolic debugging impossible.
9839 @end table
9841 @node NS32K Options
9842 @subsection NS32K Options
9843 @cindex NS32K options
9845 These are the @samp{-m} options defined for the 32000 series.  The default
9846 values for these options depends on which style of 32000 was selected when
9847 the compiler was configured; the defaults for the most common choices are
9848 given below.
9850 @table @gcctabopt
9851 @item -m32032
9852 @itemx -m32032
9853 @opindex m32032
9854 @opindex m32032
9855 Generate output for a 32032.  This is the default
9856 when the compiler is configured for 32032 and 32016 based systems.
9858 @item -m32332
9859 @itemx -m32332
9860 @opindex m32332
9861 @opindex m32332
9862 Generate output for a 32332.  This is the default
9863 when the compiler is configured for 32332-based systems.
9865 @item -m32532
9866 @itemx -m32532
9867 @opindex m32532
9868 @opindex m32532
9869 Generate output for a 32532.  This is the default
9870 when the compiler is configured for 32532-based systems.
9872 @item -m32081
9873 @opindex m32081
9874 Generate output containing 32081 instructions for floating point.
9875 This is the default for all systems.
9877 @item -m32381
9878 @opindex m32381
9879 Generate output containing 32381 instructions for floating point.  This
9880 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9881 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9883 @item -mmulti-add
9884 @opindex mmulti-add
9885 Try and generate multiply-add floating point instructions @code{polyF}
9886 and @code{dotF}.  This option is only available if the @option{-m32381}
9887 option is in effect.  Using these instructions requires changes to
9888 register allocation which generally has a negative impact on
9889 performance.  This option should only be enabled when compiling code
9890 particularly likely to make heavy use of multiply-add instructions.
9892 @item -mnomulti-add
9893 @opindex mnomulti-add
9894 Do not try and generate multiply-add floating point instructions
9895 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9897 @item -msoft-float
9898 @opindex msoft-float
9899 Generate output containing library calls for floating point.
9900 @strong{Warning:} the requisite libraries may not be available.
9902 @item -mieee-compare
9903 @itemx -mno-ieee-compare
9904 @opindex mieee-compare
9905 @opindex mno-ieee-compare
9906 Control whether or not the compiler uses IEEE floating point
9907 comparisons.  These handle correctly the case where the result of a
9908 comparison is unordered.
9909 @strong{Warning:} the requisite kernel support may not be available.
9911 @item -mnobitfield
9912 @opindex mnobitfield
9913 Do not use the bit-field instructions.  On some machines it is faster to
9914 use shifting and masking operations.  This is the default for the pc532.
9916 @item -mbitfield
9917 @opindex mbitfield
9918 Do use the bit-field instructions.  This is the default for all platforms
9919 except the pc532.
9921 @item -mrtd
9922 @opindex mrtd
9923 Use a different function-calling convention, in which functions
9924 that take a fixed number of arguments return pop their
9925 arguments on return with the @code{ret} instruction.
9927 This calling convention is incompatible with the one normally
9928 used on Unix, so you cannot use it if you need to call libraries
9929 compiled with the Unix compiler.
9931 Also, you must provide function prototypes for all functions that
9932 take variable numbers of arguments (including @code{printf});
9933 otherwise incorrect code will be generated for calls to those
9934 functions.
9936 In addition, seriously incorrect code will result if you call a
9937 function with too many arguments.  (Normally, extra arguments are
9938 harmlessly ignored.)
9940 This option takes its name from the 680x0 @code{rtd} instruction.
9943 @item -mregparam
9944 @opindex mregparam
9945 Use a different function-calling convention where the first two arguments
9946 are passed in registers.
9948 This calling convention is incompatible with the one normally
9949 used on Unix, so you cannot use it if you need to call libraries
9950 compiled with the Unix compiler.
9952 @item -mnoregparam
9953 @opindex mnoregparam
9954 Do not pass any arguments in registers.  This is the default for all
9955 targets.
9957 @item -msb
9958 @opindex msb
9959 It is OK to use the sb as an index register which is always loaded with
9960 zero.  This is the default for the pc532-netbsd target.
9962 @item -mnosb
9963 @opindex mnosb
9964 The sb register is not available for use or has not been initialized to
9965 zero by the run time system.  This is the default for all targets except
9966 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9967 @option{-fpic} is set.
9969 @item -mhimem
9970 @opindex mhimem
9971 Many ns32000 series addressing modes use displacements of up to 512MB@.
9972 If an address is above 512MB then displacements from zero can not be used.
9973 This option causes code to be generated which can be loaded above 512MB@.
9974 This may be useful for operating systems or ROM code.
9976 @item -mnohimem
9977 @opindex mnohimem
9978 Assume code will be loaded in the first 512MB of virtual address space.
9979 This is the default for all platforms.
9981 @end table
9983 @node PDP-11 Options
9984 @subsection PDP-11 Options
9985 @cindex PDP-11 Options
9987 These options are defined for the PDP-11:
9989 @table @gcctabopt
9990 @item -mfpu
9991 @opindex mfpu
9992 Use hardware FPP floating point.  This is the default.  (FIS floating
9993 point on the PDP-11/40 is not supported.)
9995 @item -msoft-float
9996 @opindex msoft-float
9997 Do not use hardware floating point.
9999 @item -mac0
10000 @opindex mac0
10001 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10003 @item -mno-ac0
10004 @opindex mno-ac0
10005 Return floating-point results in memory.  This is the default.
10007 @item -m40
10008 @opindex m40
10009 Generate code for a PDP-11/40.
10011 @item -m45
10012 @opindex m45
10013 Generate code for a PDP-11/45.  This is the default.
10015 @item -m10
10016 @opindex m10
10017 Generate code for a PDP-11/10.
10019 @item -mbcopy-builtin
10020 @opindex bcopy-builtin
10021 Use inline @code{movmemhi} patterns for copying memory.  This is the
10022 default.
10024 @item -mbcopy
10025 @opindex mbcopy
10026 Do not use inline @code{movmemhi} patterns for copying memory.
10028 @item -mint16
10029 @itemx -mno-int32
10030 @opindex mint16
10031 @opindex mno-int32
10032 Use 16-bit @code{int}.  This is the default.
10034 @item -mint32
10035 @itemx -mno-int16
10036 @opindex mint32
10037 @opindex mno-int16
10038 Use 32-bit @code{int}.
10040 @item -mfloat64
10041 @itemx -mno-float32
10042 @opindex mfloat64
10043 @opindex mno-float32
10044 Use 64-bit @code{float}.  This is the default.
10046 @item -mfloat32
10047 @itemx -mno-float64
10048 @opindex mfloat32
10049 @opindex mno-float64
10050 Use 32-bit @code{float}.
10052 @item -mabshi
10053 @opindex mabshi
10054 Use @code{abshi2} pattern.  This is the default.
10056 @item -mno-abshi
10057 @opindex mno-abshi
10058 Do not use @code{abshi2} pattern.
10060 @item -mbranch-expensive
10061 @opindex mbranch-expensive
10062 Pretend that branches are expensive.  This is for experimenting with
10063 code generation only.
10065 @item -mbranch-cheap
10066 @opindex mbranch-cheap
10067 Do not pretend that branches are expensive.  This is the default.
10069 @item -msplit
10070 @opindex msplit
10071 Generate code for a system with split I&D.
10073 @item -mno-split
10074 @opindex mno-split
10075 Generate code for a system without split I&D.  This is the default.
10077 @item -munix-asm
10078 @opindex munix-asm
10079 Use Unix assembler syntax.  This is the default when configured for
10080 @samp{pdp11-*-bsd}.
10082 @item -mdec-asm
10083 @opindex mdec-asm
10084 Use DEC assembler syntax.  This is the default when configured for any
10085 PDP-11 target other than @samp{pdp11-*-bsd}.
10086 @end table
10088 @node PowerPC Options
10089 @subsection PowerPC Options
10090 @cindex PowerPC options
10092 These are listed under @xref{RS/6000 and PowerPC Options}.
10094 @node RS/6000 and PowerPC Options
10095 @subsection IBM RS/6000 and PowerPC Options
10096 @cindex RS/6000 and PowerPC Options
10097 @cindex IBM RS/6000 and PowerPC Options
10099 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10100 @table @gcctabopt
10101 @item -mpower
10102 @itemx -mno-power
10103 @itemx -mpower2
10104 @itemx -mno-power2
10105 @itemx -mpowerpc
10106 @itemx -mno-powerpc
10107 @itemx -mpowerpc-gpopt
10108 @itemx -mno-powerpc-gpopt
10109 @itemx -mpowerpc-gfxopt
10110 @itemx -mno-powerpc-gfxopt
10111 @itemx -mpowerpc64
10112 @itemx -mno-powerpc64
10113 @opindex mpower
10114 @opindex mno-power
10115 @opindex mpower2
10116 @opindex mno-power2
10117 @opindex mpowerpc
10118 @opindex mno-powerpc
10119 @opindex mpowerpc-gpopt
10120 @opindex mno-powerpc-gpopt
10121 @opindex mpowerpc-gfxopt
10122 @opindex mno-powerpc-gfxopt
10123 @opindex mpowerpc64
10124 @opindex mno-powerpc64
10125 GCC supports two related instruction set architectures for the
10126 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10127 instructions supported by the @samp{rios} chip set used in the original
10128 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10129 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10130 the IBM 4xx microprocessors.
10132 Neither architecture is a subset of the other.  However there is a
10133 large common subset of instructions supported by both.  An MQ
10134 register is included in processors supporting the POWER architecture.
10136 You use these options to specify which instructions are available on the
10137 processor you are using.  The default value of these options is
10138 determined when configuring GCC@.  Specifying the
10139 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10140 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10141 rather than the options listed above.
10143 The @option{-mpower} option allows GCC to generate instructions that
10144 are found only in the POWER architecture and to use the MQ register.
10145 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10146 to generate instructions that are present in the POWER2 architecture but
10147 not the original POWER architecture.
10149 The @option{-mpowerpc} option allows GCC to generate instructions that
10150 are found only in the 32-bit subset of the PowerPC architecture.
10151 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10152 GCC to use the optional PowerPC architecture instructions in the
10153 General Purpose group, including floating-point square root.  Specifying
10154 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10155 use the optional PowerPC architecture instructions in the Graphics
10156 group, including floating-point select.
10158 The @option{-mpowerpc64} option allows GCC to generate the additional
10159 64-bit instructions that are found in the full PowerPC64 architecture
10160 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10161 @option{-mno-powerpc64}.
10163 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10164 will use only the instructions in the common subset of both
10165 architectures plus some special AIX common-mode calls, and will not use
10166 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10167 permits GCC to use any instruction from either architecture and to
10168 allow use of the MQ register; specify this for the Motorola MPC601.
10170 @item -mnew-mnemonics
10171 @itemx -mold-mnemonics
10172 @opindex mnew-mnemonics
10173 @opindex mold-mnemonics
10174 Select which mnemonics to use in the generated assembler code.  With
10175 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10176 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10177 assembler mnemonics defined for the POWER architecture.  Instructions
10178 defined in only one architecture have only one mnemonic; GCC uses that
10179 mnemonic irrespective of which of these options is specified.
10181 GCC defaults to the mnemonics appropriate for the architecture in
10182 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10183 value of these option.  Unless you are building a cross-compiler, you
10184 should normally not specify either @option{-mnew-mnemonics} or
10185 @option{-mold-mnemonics}, but should instead accept the default.
10187 @item -mcpu=@var{cpu_type}
10188 @opindex mcpu
10189 Set architecture type, register usage, choice of mnemonics, and
10190 instruction scheduling parameters for machine type @var{cpu_type}.
10191 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10192 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10193 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10194 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10195 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10196 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10197 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10198 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10199 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10201 @option{-mcpu=common} selects a completely generic processor.  Code
10202 generated under this option will run on any POWER or PowerPC processor.
10203 GCC will use only the instructions in the common subset of both
10204 architectures, and will not use the MQ register.  GCC assumes a generic
10205 processor model for scheduling purposes.
10207 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10208 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10209 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10210 types, with an appropriate, generic processor model assumed for
10211 scheduling purposes.
10213 The other options specify a specific processor.  Code generated under
10214 those options will run best on that processor, and may not run at all on
10215 others.
10217 The @option{-mcpu} options automatically enable or disable the
10218 following options: @option{-maltivec}, @option{-mhard-float},
10219 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10220 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10221 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10222 @option{-mstring}.  The particular options set for any particular CPU
10223 will vary between compiler versions, depending on what setting seems
10224 to produce optimal code for that CPU; it doesn't necessarily reflect
10225 the actual hardware's capabilities.  If you wish to set an individual
10226 option to a particular value, you may specify it after the
10227 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10229 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10230 not enabled or disabled by the @option{-mcpu} option at present, since
10231 AIX does not have full support for these options.  You may still
10232 enable or disable them individually if you're sure it'll work in your
10233 environment.
10235 @item -mtune=@var{cpu_type}
10236 @opindex mtune
10237 Set the instruction scheduling parameters for machine type
10238 @var{cpu_type}, but do not set the architecture type, register usage, or
10239 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10240 values for @var{cpu_type} are used for @option{-mtune} as for
10241 @option{-mcpu}.  If both are specified, the code generated will use the
10242 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10243 scheduling parameters set by @option{-mtune}.
10245 @item -maltivec
10246 @itemx -mno-altivec
10247 @opindex maltivec
10248 @opindex mno-altivec
10249 These switches enable or disable the use of built-in functions that
10250 allow access to the AltiVec instruction set.  You may also need to set
10251 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10252 enhancements.
10254 @item -mabi=spe
10255 @opindex mabi=spe
10256 Extend the current ABI with SPE ABI extensions.  This does not change
10257 the default ABI, instead it adds the SPE ABI extensions to the current
10258 ABI@.
10260 @item -mabi=no-spe
10261 @opindex mabi=no-spe
10262 Disable Booke SPE ABI extensions for the current ABI.
10264 @item -misel=@var{yes/no}
10265 @itemx -misel
10266 @opindex misel
10267 This switch enables or disables the generation of ISEL instructions.
10269 @item -mspe=@var{yes/no}
10270 @itemx -mspe
10271 @opindex mspe
10272 This switch enables or disables the generation of SPE simd
10273 instructions.
10275 @item -mfloat-gprs=@var{yes/no}
10276 @itemx -mfloat-gprs
10277 @opindex mfloat-gprs
10278 This switch enables or disables the generation of floating point
10279 operations on the general purpose registers for architectures that
10280 support it.  This option is currently only available on the MPC8540.
10282 @item -m32
10283 @itemx -m64
10284 @opindex m32
10285 @opindex m64
10286 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10287 targets (including GNU/Linux).  The 32-bit environment sets int, long
10288 and pointer to 32 bits and generates code that runs on any PowerPC
10289 variant.  The 64-bit environment sets int to 32 bits and long and
10290 pointer to 64 bits, and generates code for PowerPC64, as for
10291 @option{-mpowerpc64}.
10293 @item -mfull-toc
10294 @itemx -mno-fp-in-toc
10295 @itemx -mno-sum-in-toc
10296 @itemx -mminimal-toc
10297 @opindex mfull-toc
10298 @opindex mno-fp-in-toc
10299 @opindex mno-sum-in-toc
10300 @opindex mminimal-toc
10301 Modify generation of the TOC (Table Of Contents), which is created for
10302 every executable file.  The @option{-mfull-toc} option is selected by
10303 default.  In that case, GCC will allocate at least one TOC entry for
10304 each unique non-automatic variable reference in your program.  GCC
10305 will also place floating-point constants in the TOC@.  However, only
10306 16,384 entries are available in the TOC@.
10308 If you receive a linker error message that saying you have overflowed
10309 the available TOC space, you can reduce the amount of TOC space used
10310 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10311 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10312 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10313 generate code to calculate the sum of an address and a constant at
10314 run-time instead of putting that sum into the TOC@.  You may specify one
10315 or both of these options.  Each causes GCC to produce very slightly
10316 slower and larger code at the expense of conserving TOC space.
10318 If you still run out of space in the TOC even when you specify both of
10319 these options, specify @option{-mminimal-toc} instead.  This option causes
10320 GCC to make only one TOC entry for every file.  When you specify this
10321 option, GCC will produce code that is slower and larger but which
10322 uses extremely little TOC space.  You may wish to use this option
10323 only on files that contain less frequently executed code.
10325 @item -maix64
10326 @itemx -maix32
10327 @opindex maix64
10328 @opindex maix32
10329 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10330 @code{long} type, and the infrastructure needed to support them.
10331 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10332 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10333 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10335 @item -mxl-call
10336 @itemx -mno-xl-call
10337 @opindex mxl-call
10338 @opindex mno-xl-call
10339 On AIX, pass floating-point arguments to prototyped functions beyond the
10340 register save area (RSA) on the stack in addition to argument FPRs.  The
10341 AIX calling convention was extended but not initially documented to
10342 handle an obscure K&R C case of calling a function that takes the
10343 address of its arguments with fewer arguments than declared.  AIX XL
10344 compilers access floating point arguments which do not fit in the
10345 RSA from the stack when a subroutine is compiled without
10346 optimization.  Because always storing floating-point arguments on the
10347 stack is inefficient and rarely needed, this option is not enabled by
10348 default and only is necessary when calling subroutines compiled by AIX
10349 XL compilers without optimization.
10351 @item -mpe
10352 @opindex mpe
10353 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10354 application written to use message passing with special startup code to
10355 enable the application to run.  The system must have PE installed in the
10356 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10357 must be overridden with the @option{-specs=} option to specify the
10358 appropriate directory location.  The Parallel Environment does not
10359 support threads, so the @option{-mpe} option and the @option{-pthread}
10360 option are incompatible.
10362 @item -malign-natural
10363 @itemx -malign-power
10364 @opindex malign-natural
10365 @opindex malign-power
10366 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10367 @option{-malign-natural} overrides the ABI-defined alignment of larger
10368 types, such as floating-point doubles, on their natural size-based boundary.
10369 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10370 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
10372 @item -msoft-float
10373 @itemx -mhard-float
10374 @opindex msoft-float
10375 @opindex mhard-float
10376 Generate code that does not use (uses) the floating-point register set.
10377 Software floating point emulation is provided if you use the
10378 @option{-msoft-float} option, and pass the option to GCC when linking.
10380 @item -mmultiple
10381 @itemx -mno-multiple
10382 @opindex mmultiple
10383 @opindex mno-multiple
10384 Generate code that uses (does not use) the load multiple word
10385 instructions and the store multiple word instructions.  These
10386 instructions are generated by default on POWER systems, and not
10387 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10388 endian PowerPC systems, since those instructions do not work when the
10389 processor is in little endian mode.  The exceptions are PPC740 and
10390 PPC750 which permit the instructions usage in little endian mode.
10392 @item -mstring
10393 @itemx -mno-string
10394 @opindex mstring
10395 @opindex mno-string
10396 Generate code that uses (does not use) the load string instructions
10397 and the store string word instructions to save multiple registers and
10398 do small block moves.  These instructions are generated by default on
10399 POWER systems, and not generated on PowerPC systems.  Do not use
10400 @option{-mstring} on little endian PowerPC systems, since those
10401 instructions do not work when the processor is in little endian mode.
10402 The exceptions are PPC740 and PPC750 which permit the instructions
10403 usage in little endian mode.
10405 @item -mupdate
10406 @itemx -mno-update
10407 @opindex mupdate
10408 @opindex mno-update
10409 Generate code that uses (does not use) the load or store instructions
10410 that update the base register to the address of the calculated memory
10411 location.  These instructions are generated by default.  If you use
10412 @option{-mno-update}, there is a small window between the time that the
10413 stack pointer is updated and the address of the previous frame is
10414 stored, which means code that walks the stack frame across interrupts or
10415 signals may get corrupted data.
10417 @item -mfused-madd
10418 @itemx -mno-fused-madd
10419 @opindex mfused-madd
10420 @opindex mno-fused-madd
10421 Generate code that uses (does not use) the floating point multiply and
10422 accumulate instructions.  These instructions are generated by default if
10423 hardware floating is used.
10425 @item -mno-bit-align
10426 @itemx -mbit-align
10427 @opindex mno-bit-align
10428 @opindex mbit-align
10429 On System V.4 and embedded PowerPC systems do not (do) force structures
10430 and unions that contain bit-fields to be aligned to the base type of the
10431 bit-field.
10433 For example, by default a structure containing nothing but 8
10434 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10435 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10436 the structure would be aligned to a 1 byte boundary and be one byte in
10437 size.
10439 @item -mno-strict-align
10440 @itemx -mstrict-align
10441 @opindex mno-strict-align
10442 @opindex mstrict-align
10443 On System V.4 and embedded PowerPC systems do not (do) assume that
10444 unaligned memory references will be handled by the system.
10446 @item -mrelocatable
10447 @itemx -mno-relocatable
10448 @opindex mrelocatable
10449 @opindex mno-relocatable
10450 On embedded PowerPC systems generate code that allows (does not allow)
10451 the program to be relocated to a different address at runtime.  If you
10452 use @option{-mrelocatable} on any module, all objects linked together must
10453 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10455 @item -mrelocatable-lib
10456 @itemx -mno-relocatable-lib
10457 @opindex mrelocatable-lib
10458 @opindex mno-relocatable-lib
10459 On embedded PowerPC systems generate code that allows (does not allow)
10460 the program to be relocated to a different address at runtime.  Modules
10461 compiled with @option{-mrelocatable-lib} can be linked with either modules
10462 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10463 with modules compiled with the @option{-mrelocatable} options.
10465 @item -mno-toc
10466 @itemx -mtoc
10467 @opindex mno-toc
10468 @opindex mtoc
10469 On System V.4 and embedded PowerPC systems do not (do) assume that
10470 register 2 contains a pointer to a global area pointing to the addresses
10471 used in the program.
10473 @item -mlittle
10474 @itemx -mlittle-endian
10475 @opindex mlittle
10476 @opindex mlittle-endian
10477 On System V.4 and embedded PowerPC systems compile code for the
10478 processor in little endian mode.  The @option{-mlittle-endian} option is
10479 the same as @option{-mlittle}.
10481 @item -mbig
10482 @itemx -mbig-endian
10483 @opindex mbig
10484 @opindex mbig-endian
10485 On System V.4 and embedded PowerPC systems compile code for the
10486 processor in big endian mode.  The @option{-mbig-endian} option is
10487 the same as @option{-mbig}.
10489 @item -mdynamic-no-pic
10490 @opindex mdynamic-no-pic
10491 On Darwin and Mac OS X systems, compile code so that it is not
10492 relocatable, but that its external references are relocatable.  The
10493 resulting code is suitable for applications, but not shared
10494 libraries.
10496 @item -mprioritize-restricted-insns=@var{priority}
10497 @opindex mprioritize-restricted-insns
10498 This option controls the priority that is assigned to
10499 dispatch-slot restricted instructions during the second scheduling
10500 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10501 @var{no/highest/second-highest} priority to dispatch slot restricted
10502 instructions.
10504 @item -msched-costly-dep=@var{dependence_type}
10505 @opindex msched-costly-dep
10506 This option controls which dependences are considered costly
10507 by the target during instruction scheduling.  The argument
10508 @var{dependence_type} takes one of the following values:
10509 @var{no}: no dependence is costly,
10510 @var{all}: all dependences are costly,
10511 @var{true_store_to_load}: a true dependence from store to load is costly,
10512 @var{store_to_load}: any dependence from store to load is costly,
10513 @var{number}: any dependence which latency >= @var{number} is costly.
10515 @item -minsert-sched-nops=@var{scheme}
10516 @opindex minsert-sched-nops
10517 This option controls which nop insertion scheme will be used during
10518 the second scheduling pass. The argument @var{scheme} takes one of the
10519 following values:
10520 @var{no}: Don't insert nops.
10521 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10522 according to the scheduler's grouping.
10523 @var{regroup_exact}: Insert nops to force costly dependent insns into
10524 separate groups.  Insert exactly as many nops as needed to force an insn
10525 to a new group, according to the estimated processor grouping.
10526 @var{number}: Insert nops to force costly dependent insns into
10527 separate groups.  Insert @var{number} nops to force an insn to a new group.
10529 @item -mcall-sysv
10530 @opindex mcall-sysv
10531 On System V.4 and embedded PowerPC systems compile code using calling
10532 conventions that adheres to the March 1995 draft of the System V
10533 Application Binary Interface, PowerPC processor supplement.  This is the
10534 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10536 @item -mcall-sysv-eabi
10537 @opindex mcall-sysv-eabi
10538 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10540 @item -mcall-sysv-noeabi
10541 @opindex mcall-sysv-noeabi
10542 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10544 @item -mcall-solaris
10545 @opindex mcall-solaris
10546 On System V.4 and embedded PowerPC systems compile code for the Solaris
10547 operating system.
10549 @item -mcall-linux
10550 @opindex mcall-linux
10551 On System V.4 and embedded PowerPC systems compile code for the
10552 Linux-based GNU system.
10554 @item -mcall-gnu
10555 @opindex mcall-gnu
10556 On System V.4 and embedded PowerPC systems compile code for the
10557 Hurd-based GNU system.
10559 @item -mcall-netbsd
10560 @opindex mcall-netbsd
10561 On System V.4 and embedded PowerPC systems compile code for the
10562 NetBSD operating system.
10564 @item -maix-struct-return
10565 @opindex maix-struct-return
10566 Return all structures in memory (as specified by the AIX ABI)@.
10568 @item -msvr4-struct-return
10569 @opindex msvr4-struct-return
10570 Return structures smaller than 8 bytes in registers (as specified by the
10571 SVR4 ABI)@.
10573 @item -mabi=altivec
10574 @opindex mabi=altivec
10575 Extend the current ABI with AltiVec ABI extensions.  This does not
10576 change the default ABI, instead it adds the AltiVec ABI extensions to
10577 the current ABI@.
10579 @item -mabi=no-altivec
10580 @opindex mabi=no-altivec
10581 Disable AltiVec ABI extensions for the current ABI.
10583 @item -mprototype
10584 @itemx -mno-prototype
10585 @opindex mprototype
10586 @opindex mno-prototype
10587 On System V.4 and embedded PowerPC systems assume that all calls to
10588 variable argument functions are properly prototyped.  Otherwise, the
10589 compiler must insert an instruction before every non prototyped call to
10590 set or clear bit 6 of the condition code register (@var{CR}) to
10591 indicate whether floating point values were passed in the floating point
10592 registers in case the function takes a variable arguments.  With
10593 @option{-mprototype}, only calls to prototyped variable argument functions
10594 will set or clear the bit.
10596 @item -msim
10597 @opindex msim
10598 On embedded PowerPC systems, assume that the startup module is called
10599 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10600 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10601 configurations.
10603 @item -mmvme
10604 @opindex mmvme
10605 On embedded PowerPC systems, assume that the startup module is called
10606 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10607 @file{libc.a}.
10609 @item -mads
10610 @opindex mads
10611 On embedded PowerPC systems, assume that the startup module is called
10612 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10613 @file{libc.a}.
10615 @item -myellowknife
10616 @opindex myellowknife
10617 On embedded PowerPC systems, assume that the startup module is called
10618 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10619 @file{libc.a}.
10621 @item -mvxworks
10622 @opindex mvxworks
10623 On System V.4 and embedded PowerPC systems, specify that you are
10624 compiling for a VxWorks system.
10626 @item -mwindiss
10627 @opindex mwindiss
10628 Specify that you are compiling for the WindISS simulation environment.
10630 @item -memb
10631 @opindex memb
10632 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10633 header to indicate that @samp{eabi} extended relocations are used.
10635 @item -meabi
10636 @itemx -mno-eabi
10637 @opindex meabi
10638 @opindex mno-eabi
10639 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10640 Embedded Applications Binary Interface (eabi) which is a set of
10641 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10642 means that the stack is aligned to an 8 byte boundary, a function
10643 @code{__eabi} is called to from @code{main} to set up the eabi
10644 environment, and the @option{-msdata} option can use both @code{r2} and
10645 @code{r13} to point to two separate small data areas.  Selecting
10646 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10647 do not call an initialization function from @code{main}, and the
10648 @option{-msdata} option will only use @code{r13} to point to a single
10649 small data area.  The @option{-meabi} option is on by default if you
10650 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10652 @item -msdata=eabi
10653 @opindex msdata=eabi
10654 On System V.4 and embedded PowerPC systems, put small initialized
10655 @code{const} global and static data in the @samp{.sdata2} section, which
10656 is pointed to by register @code{r2}.  Put small initialized
10657 non-@code{const} global and static data in the @samp{.sdata} section,
10658 which is pointed to by register @code{r13}.  Put small uninitialized
10659 global and static data in the @samp{.sbss} section, which is adjacent to
10660 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10661 incompatible with the @option{-mrelocatable} option.  The
10662 @option{-msdata=eabi} option also sets the @option{-memb} option.
10664 @item -msdata=sysv
10665 @opindex msdata=sysv
10666 On System V.4 and embedded PowerPC systems, put small global and static
10667 data in the @samp{.sdata} section, which is pointed to by register
10668 @code{r13}.  Put small uninitialized global and static data in the
10669 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10670 The @option{-msdata=sysv} option is incompatible with the
10671 @option{-mrelocatable} option.
10673 @item -msdata=default
10674 @itemx -msdata
10675 @opindex msdata=default
10676 @opindex msdata
10677 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10678 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10679 same as @option{-msdata=sysv}.
10681 @item -msdata-data
10682 @opindex msdata-data
10683 On System V.4 and embedded PowerPC systems, put small global and static
10684 data in the @samp{.sdata} section.  Put small uninitialized global and
10685 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10686 to address small data however.  This is the default behavior unless
10687 other @option{-msdata} options are used.
10689 @item -msdata=none
10690 @itemx -mno-sdata
10691 @opindex msdata=none
10692 @opindex mno-sdata
10693 On embedded PowerPC systems, put all initialized global and static data
10694 in the @samp{.data} section, and all uninitialized data in the
10695 @samp{.bss} section.
10697 @item -G @var{num}
10698 @opindex G
10699 @cindex smaller data references (PowerPC)
10700 @cindex .sdata/.sdata2 references (PowerPC)
10701 On embedded PowerPC systems, put global and static items less than or
10702 equal to @var{num} bytes into the small data or bss sections instead of
10703 the normal data or bss section.  By default, @var{num} is 8.  The
10704 @option{-G @var{num}} switch is also passed to the linker.
10705 All modules should be compiled with the same @option{-G @var{num}} value.
10707 @item -mregnames
10708 @itemx -mno-regnames
10709 @opindex mregnames
10710 @opindex mno-regnames
10711 On System V.4 and embedded PowerPC systems do (do not) emit register
10712 names in the assembly language output using symbolic forms.
10714 @item -mlongcall
10715 @itemx -mno-longcall
10716 @opindex mlongcall
10717 @opindex mno-longcall
10718 Default to making all function calls indirectly, using a register, so
10719 that functions which reside further than 32 megabytes (33,554,432
10720 bytes) from the current location can be called.  This setting can be
10721 overridden by the @code{shortcall} function attribute, or by
10722 @code{#pragma longcall(0)}.
10724 Some linkers are capable of detecting out-of-range calls and generating
10725 glue code on the fly.  On these systems, long calls are unnecessary and
10726 generate slower code.  As of this writing, the AIX linker can do this,
10727 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10728 to the GNU linker for 32-bit PowerPC systems as well.
10730 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10731 callee, L42'', plus a ``branch island'' (glue code).  The two target
10732 addresses represent the callee and the ``branch island.'' The
10733 Darwin/PPC linker will prefer the first address and generate a ``bl
10734 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10735 otherwise, the linker will generate ``bl L42'' to call the ``branch
10736 island.''  The ``branch island'' is appended to the body of the
10737 calling function; it computes the full 32-bit address of the callee
10738 and jumps to it.
10740 On Mach-O (Darwin) systems, this option directs the compiler emit to
10741 the glue for every direct call, and the Darwin linker decides whether
10742 to use or discard it.
10744 In the future, we may cause GCC to ignore all longcall specifications
10745 when the linker is known to generate glue.
10747 @item -pthread
10748 @opindex pthread
10749 Adds support for multithreading with the @dfn{pthreads} library.
10750 This option sets flags for both the preprocessor and linker.
10752 @end table
10754 @node S/390 and zSeries Options
10755 @subsection S/390 and zSeries Options
10756 @cindex S/390 and zSeries Options
10758 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10760 @table @gcctabopt
10761 @item -mhard-float
10762 @itemx -msoft-float
10763 @opindex mhard-float
10764 @opindex msoft-float
10765 Use (do not use) the hardware floating-point instructions and registers
10766 for floating-point operations.  When @option{-msoft-float} is specified,
10767 functions in @file{libgcc.a} will be used to perform floating-point
10768 operations.  When @option{-mhard-float} is specified, the compiler
10769 generates IEEE floating-point instructions.  This is the default.
10771 @item -mbackchain
10772 @itemx -mno-backchain
10773 @itemx -mkernel-backchain
10774 @opindex mbackchain
10775 @opindex mno-backchain
10776 @opindex mkernel-backchain
10777 In order to provide a backchain the address of the caller's frame
10778 is stored within the callee's stack frame.
10779 A backchain may be needed to allow debugging using tools that do not understand
10780 DWARF-2 call frame information.
10781 For @option{-mno-backchain} no backchain is maintained at all which is the 
10782 default. 
10783 If one of the other options is present the backchain pointer is placed either 
10784 on top of the stack frame  (@option{-mkernel-backchain}) or on
10785 the bottom (@option{-mbackchain}).
10786 Beside the different backchain location @option{-mkernel-backchain}
10787 also changes stack frame layout breaking the ABI. This option
10788 is intended to be used for code which internally needs a backchain but has
10789 to get by with a limited stack size e.g.@: the linux kernel. 
10790 Internal unwinding code not using DWARF-2 info has to be able to locate the
10791 return address of a function. That will be eased be the fact that
10792 the return address of a function is placed two words below the backchain 
10793 pointer.
10795 @item -msmall-exec
10796 @itemx -mno-small-exec
10797 @opindex msmall-exec
10798 @opindex mno-small-exec
10799 Generate (or do not generate) code using the @code{bras} instruction
10800 to do subroutine calls.
10801 This only works reliably if the total executable size does not
10802 exceed 64k.  The default is to use the @code{basr} instruction instead,
10803 which does not have this limitation.
10805 @item -m64
10806 @itemx -m31
10807 @opindex m64
10808 @opindex m31
10809 When @option{-m31} is specified, generate code compliant to the
10810 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10811 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10812 particular to generate 64-bit instructions.  For the @samp{s390}
10813 targets, the default is @option{-m31}, while the @samp{s390x}
10814 targets default to @option{-m64}.
10816 @item -mzarch
10817 @itemx -mesa
10818 @opindex mzarch
10819 @opindex mesa
10820 When @option{-mzarch} is specified, generate code using the
10821 instructions available on z/Architecture.
10822 When @option{-mesa} is specified, generate code using the
10823 instructions available on ESA/390. Note that @option{-mesa} is
10824 not possible with @option{-m64}.
10825 When generating code compliant to the GNU/Linux for S/390 ABI,
10826 the default is @option{-mesa}.  When generating code compliant
10827 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10829 @item -mmvcle
10830 @itemx -mno-mvcle
10831 @opindex mmvcle
10832 @opindex mno-mvcle
10833 Generate (or do not generate) code using the @code{mvcle} instruction
10834 to perform block moves.  When @option{-mno-mvcle} is specified,
10835 use a @code{mvc} loop instead.  This is the default.
10837 @item -mdebug
10838 @itemx -mno-debug
10839 @opindex mdebug
10840 @opindex mno-debug
10841 Print (or do not print) additional debug information when compiling.
10842 The default is to not print debug information.
10844 @item -march=@var{cpu-type}
10845 @opindex march
10846 Generate code that will run on @var{cpu-type}, which is the name of a system
10847 representing a certain processor type. Possible values for
10848 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10849 When generating code using the instructions available on z/Architecture,
10850 the default is @option{-march=z900}.  Otherwise, the default is
10851 @option{-march=g5}.
10853 @item -mtune=@var{cpu-type}
10854 @opindex mtune
10855 Tune to @var{cpu-type} everything applicable about the generated code,
10856 except for the ABI and the set of available instructions.
10857 The list of @var{cpu-type} values is the same as for @option{-march}.
10858 The default is the value used for @option{-march}.
10860 @item -mtpf-trace
10861 @itemx -mno-tpf-trace
10862 @opindex mtpf-trace
10863 @opindex mno-tpf-trace
10864 Generate code that adds (does not add) in TPF OS specific branches to trace
10865 routines in the operating system.  This option is off by default, even
10866 when compiling for the TPF OS.
10868 @item -mfused-madd
10869 @itemx -mno-fused-madd
10870 @opindex mfused-madd
10871 @opindex mno-fused-madd
10872 Generate code that uses (does not use) the floating point multiply and
10873 accumulate instructions.  These instructions are generated by default if
10874 hardware floating point is used.
10876 @item -mwarn-framesize=@var{framesize}
10877 @opindex mwarn-framesize
10878 Emit a warning if the current function exceeds the given frame size.  Because
10879 this is a compile time check it doesn't need to be a real problem when the program
10880 runs.  It is intended to identify functions which most probably cause 
10881 a stack overflow.  It is useful to be used in an environment with limited stack 
10882 size e.g.@: the linux kernel.
10884 @item -mwarn-dynamicstack
10885 @opindex mwarn-dynamicstack
10886 Emit a warning if the function calls alloca or uses dynamically
10887 sized arrays.  This is generally a bad idea with a limited stack size.
10889 @item -mstack-guard=@var{stack-guard}
10890 @item -mstack-size=@var{stack-size}
10891 @opindex mstack-guard
10892 @opindex mstack-size
10893 These arguments always have to be used in conjunction.  If they are present the s390
10894 back end emits additional instructions in the function prologue which trigger a trap
10895 if the stack size is @var{stack-guard} bytes above the @var{stack-size} 
10896 (remember that the stack on s390 grows downward).  These options are intended to 
10897 be used to help debugging stack overflow problems.  The additionally emitted code 
10898 cause only little overhead and hence can also be used in production like systems 
10899 without greater performance degradation.  The given values have to be exact 
10900 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
10901 In order to be efficient the extra code makes the assumption that the stack starts
10902 at an address aligned to the value given by @var{stack-size}.
10903 @end table
10905 @node SH Options
10906 @subsection SH Options
10908 These @samp{-m} options are defined for the SH implementations:
10910 @table @gcctabopt
10911 @item -m1
10912 @opindex m1
10913 Generate code for the SH1.
10915 @item -m2
10916 @opindex m2
10917 Generate code for the SH2.
10919 @item -m2e
10920 Generate code for the SH2e.
10922 @item -m3
10923 @opindex m3
10924 Generate code for the SH3.
10926 @item -m3e
10927 @opindex m3e
10928 Generate code for the SH3e.
10930 @item -m4-nofpu
10931 @opindex m4-nofpu
10932 Generate code for the SH4 without a floating-point unit.
10934 @item -m4-single-only
10935 @opindex m4-single-only
10936 Generate code for the SH4 with a floating-point unit that only
10937 supports single-precision arithmetic.
10939 @item -m4-single
10940 @opindex m4-single
10941 Generate code for the SH4 assuming the floating-point unit is in
10942 single-precision mode by default.
10944 @item -m4
10945 @opindex m4
10946 Generate code for the SH4.
10948 @item -m4a-nofpu
10949 @opindex m4a-nofpu
10950 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
10951 floating-point unit is not used.
10953 @item -m4a-single-only
10954 @opindex m4a-single-only
10955 Generate code for the SH4a, in such a way that no double-precision
10956 floating point operations are used.
10958 @item -m4a-single
10959 @opindex m4a-single
10960 Generate code for the SH4a assuming the floating-point unit is in
10961 single-precision mode by default.
10963 @item -m4a
10964 @opindex m4a
10965 Generate code for the SH4a.
10967 @item -m4al
10968 @opindex m4al
10969 Same as @option{-m4a-nofpu}, except that it implicitly passes
10970 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
10971 instructions at the moment.
10973 @item -mb
10974 @opindex mb
10975 Compile code for the processor in big endian mode.
10977 @item -ml
10978 @opindex ml
10979 Compile code for the processor in little endian mode.
10981 @item -mdalign
10982 @opindex mdalign
10983 Align doubles at 64-bit boundaries.  Note that this changes the calling
10984 conventions, and thus some functions from the standard C library will
10985 not work unless you recompile it first with @option{-mdalign}.
10987 @item -mrelax
10988 @opindex mrelax
10989 Shorten some address references at link time, when possible; uses the
10990 linker option @option{-relax}.
10992 @item -mbigtable
10993 @opindex mbigtable
10994 Use 32-bit offsets in @code{switch} tables.  The default is to use
10995 16-bit offsets.
10997 @item -mfmovd
10998 @opindex mfmovd
10999 Enable the use of the instruction @code{fmovd}.
11001 @item -mhitachi
11002 @opindex mhitachi
11003 Comply with the calling conventions defined by Renesas.
11005 @item -mrenesas
11006 @opindex mhitachi
11007 Comply with the calling conventions defined by Renesas.
11009 @item -mno-renesas
11010 @opindex mhitachi
11011 Comply with the calling conventions defined for GCC before the Renesas
11012 conventions were available.  This option is the default for all
11013 targets of the SH toolchain except for @samp{sh-symbianelf}.
11015 @item -mnomacsave
11016 @opindex mnomacsave
11017 Mark the @code{MAC} register as call-clobbered, even if
11018 @option{-mhitachi} is given.
11020 @item -mieee
11021 @opindex mieee
11022 Increase IEEE-compliance of floating-point code.
11024 @item -misize
11025 @opindex misize
11026 Dump instruction size and location in the assembly code.
11028 @item -mpadstruct
11029 @opindex mpadstruct
11030 This option is deprecated.  It pads structures to multiple of 4 bytes,
11031 which is incompatible with the SH ABI@.
11033 @item -mspace
11034 @opindex mspace
11035 Optimize for space instead of speed.  Implied by @option{-Os}.
11037 @item -mprefergot
11038 @opindex mprefergot
11039 When generating position-independent code, emit function calls using
11040 the Global Offset Table instead of the Procedure Linkage Table.
11042 @item -musermode
11043 @opindex musermode
11044 Generate a library function call to invalidate instruction cache
11045 entries, after fixing up a trampoline.  This library function call
11046 doesn't assume it can write to the whole memory address space.  This
11047 is the default when the target is @code{sh-*-linux*}.
11048 @end table
11050 @node SPARC Options
11051 @subsection SPARC Options
11052 @cindex SPARC options
11054 These @samp{-m} options are supported on the SPARC:
11056 @table @gcctabopt
11057 @item -mno-app-regs
11058 @itemx -mapp-regs
11059 @opindex mno-app-regs
11060 @opindex mapp-regs
11061 Specify @option{-mapp-regs} to generate output using the global registers
11062 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11063 is the default.
11065 To be fully SVR4 ABI compliant at the cost of some performance loss,
11066 specify @option{-mno-app-regs}.  You should compile libraries and system
11067 software with this option.
11069 @item -mfpu
11070 @itemx -mhard-float
11071 @opindex mfpu
11072 @opindex mhard-float
11073 Generate output containing floating point instructions.  This is the
11074 default.
11076 @item -mno-fpu
11077 @itemx -msoft-float
11078 @opindex mno-fpu
11079 @opindex msoft-float
11080 Generate output containing library calls for floating point.
11081 @strong{Warning:} the requisite libraries are not available for all SPARC
11082 targets.  Normally the facilities of the machine's usual C compiler are
11083 used, but this cannot be done directly in cross-compilation.  You must make
11084 your own arrangements to provide suitable library functions for
11085 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11086 @samp{sparclite-*-*} do provide software floating point support.
11088 @option{-msoft-float} changes the calling convention in the output file;
11089 therefore, it is only useful if you compile @emph{all} of a program with
11090 this option.  In particular, you need to compile @file{libgcc.a}, the
11091 library that comes with GCC, with @option{-msoft-float} in order for
11092 this to work.
11094 @item -mhard-quad-float
11095 @opindex mhard-quad-float
11096 Generate output containing quad-word (long double) floating point
11097 instructions.
11099 @item -msoft-quad-float
11100 @opindex msoft-quad-float
11101 Generate output containing library calls for quad-word (long double)
11102 floating point instructions.  The functions called are those specified
11103 in the SPARC ABI@.  This is the default.
11105 As of this writing, there are no SPARC implementations that have hardware
11106 support for the quad-word floating point instructions.  They all invoke
11107 a trap handler for one of these instructions, and then the trap handler
11108 emulates the effect of the instruction.  Because of the trap handler overhead,
11109 this is much slower than calling the ABI library routines.  Thus the
11110 @option{-msoft-quad-float} option is the default.
11112 @item -mno-unaligned-doubles
11113 @itemx -munaligned-doubles
11114 @opindex mno-unaligned-doubles
11115 @opindex munaligned-doubles
11116 Assume that doubles have 8 byte alignment.  This is the default.
11118 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11119 alignment only if they are contained in another type, or if they have an
11120 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11121 Specifying this option avoids some rare compatibility problems with code
11122 generated by other compilers.  It is not the default because it results
11123 in a performance loss, especially for floating point code.
11125 @item -mno-faster-structs
11126 @itemx -mfaster-structs
11127 @opindex mno-faster-structs
11128 @opindex mfaster-structs
11129 With @option{-mfaster-structs}, the compiler assumes that structures
11130 should have 8 byte alignment.  This enables the use of pairs of
11131 @code{ldd} and @code{std} instructions for copies in structure
11132 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11133 However, the use of this changed alignment directly violates the SPARC
11134 ABI@.  Thus, it's intended only for use on targets where the developer
11135 acknowledges that their resulting code will not be directly in line with
11136 the rules of the ABI@.
11138 @item -mimpure-text
11139 @opindex mimpure-text
11140 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11141 the compiler to not pass @option{-z text} to the linker when linking a
11142 shared object.  Using this option, you can link position-dependent
11143 code into a shared object.
11145 @option{-mimpure-text} suppresses the ``relocations remain against
11146 allocatable but non-writable sections'' linker error message.
11147 However, the necessary relocations will trigger copy-on-write, and the
11148 shared object is not actually shared across processes.  Instead of
11149 using @option{-mimpure-text}, you should compile all source code with
11150 @option{-fpic} or @option{-fPIC}.
11152 This option is only available on SunOS and Solaris.
11154 @item -mcpu=@var{cpu_type}
11155 @opindex mcpu
11156 Set the instruction set, register set, and instruction scheduling parameters
11157 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11158 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11159 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11160 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11161 @samp{ultrasparc3}.
11163 Default instruction scheduling parameters are used for values that select
11164 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11165 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11167 Here is a list of each supported architecture and their supported
11168 implementations.
11170 @smallexample
11171     v7:             cypress
11172     v8:             supersparc, hypersparc
11173     sparclite:      f930, f934, sparclite86x
11174     sparclet:       tsc701
11175     v9:             ultrasparc, ultrasparc3
11176 @end smallexample
11178 By default (unless configured otherwise), GCC generates code for the V7
11179 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11180 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11181 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11182 SPARCStation 1, 2, IPX etc.
11184 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11185 architecture.  The only difference from V7 code is that the compiler emits
11186 the integer multiply and integer divide instructions which exist in SPARC-V8
11187 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11188 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11189 2000 series.
11191 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11192 the SPARC architecture.  This adds the integer multiply, integer divide step
11193 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11194 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11195 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
11196 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11197 MB86934 chip, which is the more recent SPARClite with FPU.
11199 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11200 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11201 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11202 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11203 optimizes it for the TEMIC SPARClet chip.
11205 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11206 architecture.  This adds 64-bit integer and floating-point move instructions,
11207 3 additional floating-point condition code registers and conditional move
11208 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11209 optimizes it for the Sun UltraSPARC I/II chips.  With
11210 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11211 Sun UltraSPARC III chip.
11213 @item -mtune=@var{cpu_type}
11214 @opindex mtune
11215 Set the instruction scheduling parameters for machine type
11216 @var{cpu_type}, but do not set the instruction set or register set that the
11217 option @option{-mcpu=@var{cpu_type}} would.
11219 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11220 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11221 that select a particular cpu implementation.  Those are @samp{cypress},
11222 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11223 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11224 @samp{ultrasparc3}.
11226 @item -mv8plus
11227 @itemx -mno-v8plus
11228 @opindex mv8plus
11229 @opindex mno-v8plus
11230 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
11231 difference from the V8 ABI is that the global and out registers are
11232 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11233 mode for all SPARC-V9 processors.
11235 @item -mvis
11236 @itemx -mno-vis
11237 @opindex mvis
11238 @opindex mno-vis
11239 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11240 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11241 @end table
11243 These @samp{-m} options are supported in addition to the above
11244 on SPARC-V9 processors in 64-bit environments:
11246 @table @gcctabopt
11247 @item -mlittle-endian
11248 @opindex mlittle-endian
11249 Generate code for a processor running in little-endian mode. It is only
11250 available for a few configurations and most notably not on Solaris.
11252 @item -m32
11253 @itemx -m64
11254 @opindex m32
11255 @opindex m64
11256 Generate code for a 32-bit or 64-bit environment.
11257 The 32-bit environment sets int, long and pointer to 32 bits.
11258 The 64-bit environment sets int to 32 bits and long and pointer
11259 to 64 bits.
11261 @item -mcmodel=medlow
11262 @opindex mcmodel=medlow
11263 Generate code for the Medium/Low code model: 64-bit addresses, programs
11264 must be linked in the low 32 bits of memory.  Programs can be statically
11265 or dynamically linked.
11267 @item -mcmodel=medmid
11268 @opindex mcmodel=medmid
11269 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11270 must be linked in the low 44 bits of memory, the text and data segments must
11271 be less than 2GB in size and the data segment must be located within 2GB of
11272 the text segment.
11274 @item -mcmodel=medany
11275 @opindex mcmodel=medany
11276 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11277 may be linked anywhere in memory, the text and data segments must be less
11278 than 2GB in size and the data segment must be located within 2GB of the
11279 text segment.
11281 @item -mcmodel=embmedany
11282 @opindex mcmodel=embmedany
11283 Generate code for the Medium/Anywhere code model for embedded systems:
11284 64-bit addresses, the text and data segments must be less than 2GB in
11285 size, both starting anywhere in memory (determined at link time).  The
11286 global register %g4 points to the base of the data segment.  Programs
11287 are statically linked and PIC is not supported.
11289 @item -mstack-bias
11290 @itemx -mno-stack-bias
11291 @opindex mstack-bias
11292 @opindex mno-stack-bias
11293 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11294 frame pointer if present, are offset by @minus{}2047 which must be added back
11295 when making stack frame references.  This is the default in 64-bit mode.
11296 Otherwise, assume no such offset is present.
11297 @end table
11299 These switches are supported in addition to the above on Solaris:
11301 @table @gcctabopt
11302 @item -threads
11303 @opindex threads
11304 Add support for multithreading using the Solaris threads library.  This
11305 option sets flags for both the preprocessor and linker.  This option does
11306 not affect the thread safety of object code produced by the compiler or
11307 that of libraries supplied with it.
11309 @item -pthreads
11310 @opindex pthreads
11311 Add support for multithreading using the POSIX threads library.  This
11312 option sets flags for both the preprocessor and linker.  This option does
11313 not affect the thread safety of object code produced  by the compiler or
11314 that of libraries supplied with it.
11315 @end table
11317 @node System V Options
11318 @subsection Options for System V
11320 These additional options are available on System V Release 4 for
11321 compatibility with other compilers on those systems:
11323 @table @gcctabopt
11324 @item -G
11325 @opindex G
11326 Create a shared object.
11327 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11329 @item -Qy
11330 @opindex Qy
11331 Identify the versions of each tool used by the compiler, in a
11332 @code{.ident} assembler directive in the output.
11334 @item -Qn
11335 @opindex Qn
11336 Refrain from adding @code{.ident} directives to the output file (this is
11337 the default).
11339 @item -YP,@var{dirs}
11340 @opindex YP
11341 Search the directories @var{dirs}, and no others, for libraries
11342 specified with @option{-l}.
11344 @item -Ym,@var{dir}
11345 @opindex Ym
11346 Look in the directory @var{dir} to find the M4 preprocessor.
11347 The assembler uses this option.
11348 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11349 @c the generic assembler that comes with Solaris takes just -Ym.
11350 @end table
11352 @node TMS320C3x/C4x Options
11353 @subsection TMS320C3x/C4x Options
11354 @cindex TMS320C3x/C4x Options
11356 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11358 @table @gcctabopt
11360 @item -mcpu=@var{cpu_type}
11361 @opindex mcpu
11362 Set the instruction set, register set, and instruction scheduling
11363 parameters for machine type @var{cpu_type}.  Supported values for
11364 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11365 @samp{c44}.  The default is @samp{c40} to generate code for the
11366 TMS320C40.
11368 @item -mbig-memory
11369 @itemx -mbig
11370 @itemx -msmall-memory
11371 @itemx -msmall
11372 @opindex mbig-memory
11373 @opindex mbig
11374 @opindex msmall-memory
11375 @opindex msmall
11376 Generates code for the big or small memory model.  The small memory
11377 model assumed that all data fits into one 64K word page.  At run-time
11378 the data page (DP) register must be set to point to the 64K page
11379 containing the .bss and .data program sections.  The big memory model is
11380 the default and requires reloading of the DP register for every direct
11381 memory access.
11383 @item -mbk
11384 @itemx -mno-bk
11385 @opindex mbk
11386 @opindex mno-bk
11387 Allow (disallow) allocation of general integer operands into the block
11388 count register BK@.
11390 @item -mdb
11391 @itemx -mno-db
11392 @opindex mdb
11393 @opindex mno-db
11394 Enable (disable) generation of code using decrement and branch,
11395 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11396 on the safe side, this is disabled for the C3x, since the maximum
11397 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11398 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11399 that it can utilize the decrement and branch instruction, but will give
11400 up if there is more than one memory reference in the loop.  Thus a loop
11401 where the loop counter is decremented can generate slightly more
11402 efficient code, in cases where the RPTB instruction cannot be utilized.
11404 @item -mdp-isr-reload
11405 @itemx -mparanoid
11406 @opindex mdp-isr-reload
11407 @opindex mparanoid
11408 Force the DP register to be saved on entry to an interrupt service
11409 routine (ISR), reloaded to point to the data section, and restored on
11410 exit from the ISR@.  This should not be required unless someone has
11411 violated the small memory model by modifying the DP register, say within
11412 an object library.
11414 @item -mmpyi
11415 @itemx -mno-mpyi
11416 @opindex mmpyi
11417 @opindex mno-mpyi
11418 For the C3x use the 24-bit MPYI instruction for integer multiplies
11419 instead of a library call to guarantee 32-bit results.  Note that if one
11420 of the operands is a constant, then the multiplication will be performed
11421 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11422 then squaring operations are performed inline instead of a library call.
11424 @item -mfast-fix
11425 @itemx -mno-fast-fix
11426 @opindex mfast-fix
11427 @opindex mno-fast-fix
11428 The C3x/C4x FIX instruction to convert a floating point value to an
11429 integer value chooses the nearest integer less than or equal to the
11430 floating point value rather than to the nearest integer.  Thus if the
11431 floating point number is negative, the result will be incorrectly
11432 truncated an additional code is necessary to detect and correct this
11433 case.  This option can be used to disable generation of the additional
11434 code required to correct the result.
11436 @item -mrptb
11437 @itemx -mno-rptb
11438 @opindex mrptb
11439 @opindex mno-rptb
11440 Enable (disable) generation of repeat block sequences using the RPTB
11441 instruction for zero overhead looping.  The RPTB construct is only used
11442 for innermost loops that do not call functions or jump across the loop
11443 boundaries.  There is no advantage having nested RPTB loops due to the
11444 overhead required to save and restore the RC, RS, and RE registers.
11445 This is enabled by default with @option{-O2}.
11447 @item -mrpts=@var{count}
11448 @itemx -mno-rpts
11449 @opindex mrpts
11450 @opindex mno-rpts
11451 Enable (disable) the use of the single instruction repeat instruction
11452 RPTS@.  If a repeat block contains a single instruction, and the loop
11453 count can be guaranteed to be less than the value @var{count}, GCC will
11454 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11455 then a RPTS will be emitted even if the loop count cannot be determined
11456 at compile time.  Note that the repeated instruction following RPTS does
11457 not have to be reloaded from memory each iteration, thus freeing up the
11458 CPU buses for operands.  However, since interrupts are blocked by this
11459 instruction, it is disabled by default.
11461 @item -mloop-unsigned
11462 @itemx -mno-loop-unsigned
11463 @opindex mloop-unsigned
11464 @opindex mno-loop-unsigned
11465 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11466 is @math{2^{31} + 1} since these instructions test if the iteration count is
11467 negative to terminate the loop.  If the iteration count is unsigned
11468 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11469 exceeded.  This switch allows an unsigned iteration count.
11471 @item -mti
11472 @opindex mti
11473 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11474 with.  This also enforces compatibility with the API employed by the TI
11475 C3x C compiler.  For example, long doubles are passed as structures
11476 rather than in floating point registers.
11478 @item -mregparm
11479 @itemx -mmemparm
11480 @opindex mregparm
11481 @opindex mmemparm
11482 Generate code that uses registers (stack) for passing arguments to functions.
11483 By default, arguments are passed in registers where possible rather
11484 than by pushing arguments on to the stack.
11486 @item -mparallel-insns
11487 @itemx -mno-parallel-insns
11488 @opindex mparallel-insns
11489 @opindex mno-parallel-insns
11490 Allow the generation of parallel instructions.  This is enabled by
11491 default with @option{-O2}.
11493 @item -mparallel-mpy
11494 @itemx -mno-parallel-mpy
11495 @opindex mparallel-mpy
11496 @opindex mno-parallel-mpy
11497 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11498 provided @option{-mparallel-insns} is also specified.  These instructions have
11499 tight register constraints which can pessimize the code generation
11500 of large functions.
11502 @end table
11504 @node V850 Options
11505 @subsection V850 Options
11506 @cindex V850 Options
11508 These @samp{-m} options are defined for V850 implementations:
11510 @table @gcctabopt
11511 @item -mlong-calls
11512 @itemx -mno-long-calls
11513 @opindex mlong-calls
11514 @opindex mno-long-calls
11515 Treat all calls as being far away (near).  If calls are assumed to be
11516 far away, the compiler will always load the functions address up into a
11517 register, and call indirect through the pointer.
11519 @item -mno-ep
11520 @itemx -mep
11521 @opindex mno-ep
11522 @opindex mep
11523 Do not optimize (do optimize) basic blocks that use the same index
11524 pointer 4 or more times to copy pointer into the @code{ep} register, and
11525 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11526 option is on by default if you optimize.
11528 @item -mno-prolog-function
11529 @itemx -mprolog-function
11530 @opindex mno-prolog-function
11531 @opindex mprolog-function
11532 Do not use (do use) external functions to save and restore registers
11533 at the prologue and epilogue of a function.  The external functions
11534 are slower, but use less code space if more than one function saves
11535 the same number of registers.  The @option{-mprolog-function} option
11536 is on by default if you optimize.
11538 @item -mspace
11539 @opindex mspace
11540 Try to make the code as small as possible.  At present, this just turns
11541 on the @option{-mep} and @option{-mprolog-function} options.
11543 @item -mtda=@var{n}
11544 @opindex mtda
11545 Put static or global variables whose size is @var{n} bytes or less into
11546 the tiny data area that register @code{ep} points to.  The tiny data
11547 area can hold up to 256 bytes in total (128 bytes for byte references).
11549 @item -msda=@var{n}
11550 @opindex msda
11551 Put static or global variables whose size is @var{n} bytes or less into
11552 the small data area that register @code{gp} points to.  The small data
11553 area can hold up to 64 kilobytes.
11555 @item -mzda=@var{n}
11556 @opindex mzda
11557 Put static or global variables whose size is @var{n} bytes or less into
11558 the first 32 kilobytes of memory.
11560 @item -mv850
11561 @opindex mv850
11562 Specify that the target processor is the V850.
11564 @item -mbig-switch
11565 @opindex mbig-switch
11566 Generate code suitable for big switch tables.  Use this option only if
11567 the assembler/linker complain about out of range branches within a switch
11568 table.
11570 @item -mapp-regs
11571 @opindex mapp-regs
11572 This option will cause r2 and r5 to be used in the code generated by
11573 the compiler.  This setting is the default.
11575 @item -mno-app-regs
11576 @opindex mno-app-regs
11577 This option will cause r2 and r5 to be treated as fixed registers.
11579 @item -mv850e1
11580 @opindex mv850e1
11581 Specify that the target processor is the V850E1.  The preprocessor
11582 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11583 this option is used.
11585 @item -mv850e
11586 @opindex mv850e
11587 Specify that the target processor is the V850E.  The preprocessor
11588 constant @samp{__v850e__} will be defined if this option is used.
11590 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11591 are defined then a default target processor will be chosen and the
11592 relevant @samp{__v850*__} preprocessor constant will be defined.
11594 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11595 defined, regardless of which processor variant is the target.
11597 @item -mdisable-callt
11598 @opindex mdisable-callt
11599 This option will suppress generation of the CALLT instruction for the
11600 v850e and v850e1 flavors of the v850 architecture.  The default is
11601 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11603 @end table
11605 @node VAX Options
11606 @subsection VAX Options
11607 @cindex VAX options
11609 These @samp{-m} options are defined for the VAX:
11611 @table @gcctabopt
11612 @item -munix
11613 @opindex munix
11614 Do not output certain jump instructions (@code{aobleq} and so on)
11615 that the Unix assembler for the VAX cannot handle across long
11616 ranges.
11618 @item -mgnu
11619 @opindex mgnu
11620 Do output those jump instructions, on the assumption that you
11621 will assemble with the GNU assembler.
11623 @item -mg
11624 @opindex mg
11625 Output code for g-format floating point numbers instead of d-format.
11626 @end table
11628 @node x86-64 Options
11629 @subsection x86-64 Options
11630 @cindex x86-64 options
11632 These are listed under @xref{i386 and x86-64 Options}.
11634 @node Xstormy16 Options
11635 @subsection Xstormy16 Options
11636 @cindex Xstormy16 Options
11638 These options are defined for Xstormy16:
11640 @table @gcctabopt
11641 @item -msim
11642 @opindex msim
11643 Choose startup files and linker script suitable for the simulator.
11644 @end table
11646 @node Xtensa Options
11647 @subsection Xtensa Options
11648 @cindex Xtensa Options
11650 These options are supported for Xtensa targets:
11652 @table @gcctabopt
11653 @item -mconst16
11654 @itemx -mno-const16
11655 @opindex mconst16
11656 @opindex mno-const16
11657 Enable or disable use of @code{CONST16} instructions for loading
11658 constant values.  The @code{CONST16} instruction is currently not a
11659 standard option from Tensilica.  When enabled, @code{CONST16}
11660 instructions are always used in place of the standard @code{L32R}
11661 instructions.  The use of @code{CONST16} is enabled by default only if
11662 the @code{L32R} instruction is not available.
11664 @item -mfused-madd
11665 @itemx -mno-fused-madd
11666 @opindex mfused-madd
11667 @opindex mno-fused-madd
11668 Enable or disable use of fused multiply/add and multiply/subtract
11669 instructions in the floating-point option.  This has no effect if the
11670 floating-point option is not also enabled.  Disabling fused multiply/add
11671 and multiply/subtract instructions forces the compiler to use separate
11672 instructions for the multiply and add/subtract operations.  This may be
11673 desirable in some cases where strict IEEE 754-compliant results are
11674 required: the fused multiply add/subtract instructions do not round the
11675 intermediate result, thereby producing results with @emph{more} bits of
11676 precision than specified by the IEEE standard.  Disabling fused multiply
11677 add/subtract instructions also ensures that the program output is not
11678 sensitive to the compiler's ability to combine multiply and add/subtract
11679 operations.
11681 @item -mtext-section-literals
11682 @itemx -mno-text-section-literals
11683 @opindex mtext-section-literals
11684 @opindex mno-text-section-literals
11685 Control the treatment of literal pools.  The default is
11686 @option{-mno-text-section-literals}, which places literals in a separate
11687 section in the output file.  This allows the literal pool to be placed
11688 in a data RAM/ROM, and it also allows the linker to combine literal
11689 pools from separate object files to remove redundant literals and
11690 improve code size.  With @option{-mtext-section-literals}, the literals
11691 are interspersed in the text section in order to keep them as close as
11692 possible to their references.  This may be necessary for large assembly
11693 files.
11695 @item -mtarget-align
11696 @itemx -mno-target-align
11697 @opindex mtarget-align
11698 @opindex mno-target-align
11699 When this option is enabled, GCC instructs the assembler to
11700 automatically align instructions to reduce branch penalties at the
11701 expense of some code density.  The assembler attempts to widen density
11702 instructions to align branch targets and the instructions following call
11703 instructions.  If there are not enough preceding safe density
11704 instructions to align a target, no widening will be performed.  The
11705 default is @option{-mtarget-align}.  These options do not affect the
11706 treatment of auto-aligned instructions like @code{LOOP}, which the
11707 assembler will always align, either by widening density instructions or
11708 by inserting no-op instructions.
11710 @item -mlongcalls
11711 @itemx -mno-longcalls
11712 @opindex mlongcalls
11713 @opindex mno-longcalls
11714 When this option is enabled, GCC instructs the assembler to translate
11715 direct calls to indirect calls unless it can determine that the target
11716 of a direct call is in the range allowed by the call instruction.  This
11717 translation typically occurs for calls to functions in other source
11718 files.  Specifically, the assembler translates a direct @code{CALL}
11719 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11720 The default is @option{-mno-longcalls}.  This option should be used in
11721 programs where the call target can potentially be out of range.  This
11722 option is implemented in the assembler, not the compiler, so the
11723 assembly code generated by GCC will still show direct call
11724 instructions---look at the disassembled object code to see the actual
11725 instructions.  Note that the assembler will use an indirect call for
11726 every cross-file call, not just those that really will be out of range.
11727 @end table
11729 @node zSeries Options
11730 @subsection zSeries Options
11731 @cindex zSeries options
11733 These are listed under @xref{S/390 and zSeries Options}.
11735 @node Code Gen Options
11736 @section Options for Code Generation Conventions
11737 @cindex code generation conventions
11738 @cindex options, code generation
11739 @cindex run-time options
11741 These machine-independent options control the interface conventions
11742 used in code generation.
11744 Most of them have both positive and negative forms; the negative form
11745 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11746 one of the forms is listed---the one which is not the default.  You
11747 can figure out the other form by either removing @samp{no-} or adding
11750 @table @gcctabopt
11751 @item -fbounds-check
11752 @opindex fbounds-check
11753 For front-ends that support it, generate additional code to check that
11754 indices used to access arrays are within the declared range.  This is
11755 currently only supported by the Java and Fortran 77 front-ends, where
11756 this option defaults to true and false respectively.
11758 @item -ftrapv
11759 @opindex ftrapv
11760 This option generates traps for signed overflow on addition, subtraction,
11761 multiplication operations.
11763 @item -fwrapv
11764 @opindex fwrapv
11765 This option instructs the compiler to assume that signed arithmetic
11766 overflow of addition, subtraction and multiplication wraps around
11767 using twos-complement representation.  This flag enables some optimizations
11768 and disables other.  This option is enabled by default for the Java
11769 front-end, as required by the Java language specification.
11771 @item -fexceptions
11772 @opindex fexceptions
11773 Enable exception handling.  Generates extra code needed to propagate
11774 exceptions.  For some targets, this implies GCC will generate frame
11775 unwind information for all functions, which can produce significant data
11776 size overhead, although it does not affect execution.  If you do not
11777 specify this option, GCC will enable it by default for languages like
11778 C++ which normally require exception handling, and disable it for
11779 languages like C that do not normally require it.  However, you may need
11780 to enable this option when compiling C code that needs to interoperate
11781 properly with exception handlers written in C++.  You may also wish to
11782 disable this option if you are compiling older C++ programs that don't
11783 use exception handling.
11785 @item -fnon-call-exceptions
11786 @opindex fnon-call-exceptions
11787 Generate code that allows trapping instructions to throw exceptions.
11788 Note that this requires platform-specific runtime support that does
11789 not exist everywhere.  Moreover, it only allows @emph{trapping}
11790 instructions to throw exceptions, i.e.@: memory references or floating
11791 point instructions.  It does not allow exceptions to be thrown from
11792 arbitrary signal handlers such as @code{SIGALRM}.
11794 @item -funwind-tables
11795 @opindex funwind-tables
11796 Similar to @option{-fexceptions}, except that it will just generate any needed
11797 static data, but will not affect the generated code in any other way.
11798 You will normally not enable this option; instead, a language processor
11799 that needs this handling would enable it on your behalf.
11801 @item -fasynchronous-unwind-tables
11802 @opindex fasynchronous-unwind-tables
11803 Generate unwind table in dwarf2 format, if supported by target machine.  The
11804 table is exact at each instruction boundary, so it can be used for stack
11805 unwinding from asynchronous events (such as debugger or garbage collector).
11807 @item -fpcc-struct-return
11808 @opindex fpcc-struct-return
11809 Return ``short'' @code{struct} and @code{union} values in memory like
11810 longer ones, rather than in registers.  This convention is less
11811 efficient, but it has the advantage of allowing intercallability between
11812 GCC-compiled files and files compiled with other compilers, particularly
11813 the Portable C Compiler (pcc).
11815 The precise convention for returning structures in memory depends
11816 on the target configuration macros.
11818 Short structures and unions are those whose size and alignment match
11819 that of some integer type.
11821 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11822 switch is not binary compatible with code compiled with the
11823 @option{-freg-struct-return} switch.
11824 Use it to conform to a non-default application binary interface.
11826 @item -freg-struct-return
11827 @opindex freg-struct-return
11828 Return @code{struct} and @code{union} values in registers when possible.
11829 This is more efficient for small structures than
11830 @option{-fpcc-struct-return}.
11832 If you specify neither @option{-fpcc-struct-return} nor
11833 @option{-freg-struct-return}, GCC defaults to whichever convention is
11834 standard for the target.  If there is no standard convention, GCC
11835 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11836 the principal compiler.  In those cases, we can choose the standard, and
11837 we chose the more efficient register return alternative.
11839 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11840 switch is not binary compatible with code compiled with the
11841 @option{-fpcc-struct-return} switch.
11842 Use it to conform to a non-default application binary interface.
11844 @item -fshort-enums
11845 @opindex fshort-enums
11846 Allocate to an @code{enum} type only as many bytes as it needs for the
11847 declared range of possible values.  Specifically, the @code{enum} type
11848 will be equivalent to the smallest integer type which has enough room.
11850 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11851 code that is not binary compatible with code generated without that switch.
11852 Use it to conform to a non-default application binary interface.
11854 @item -fshort-double
11855 @opindex fshort-double
11856 Use the same size for @code{double} as for @code{float}.
11858 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11859 code that is not binary compatible with code generated without that switch.
11860 Use it to conform to a non-default application binary interface.
11862 @item -fshort-wchar
11863 @opindex fshort-wchar
11864 Override the underlying type for @samp{wchar_t} to be @samp{short
11865 unsigned int} instead of the default for the target.  This option is
11866 useful for building programs to run under WINE@.
11868 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11869 code that is not binary compatible with code generated without that switch.
11870 Use it to conform to a non-default application binary interface.
11872 @item -fshared-data
11873 @opindex fshared-data
11874 Requests that the data and non-@code{const} variables of this
11875 compilation be shared data rather than private data.  The distinction
11876 makes sense only on certain operating systems, where shared data is
11877 shared between processes running the same program, while private data
11878 exists in one copy per process.
11880 @item -fno-common
11881 @opindex fno-common
11882 In C, allocate even uninitialized global variables in the data section of the
11883 object file, rather than generating them as common blocks.  This has the
11884 effect that if the same variable is declared (without @code{extern}) in
11885 two different compilations, you will get an error when you link them.
11886 The only reason this might be useful is if you wish to verify that the
11887 program will work on other systems which always work this way.
11889 @item -fno-ident
11890 @opindex fno-ident
11891 Ignore the @samp{#ident} directive.
11893 @item -finhibit-size-directive
11894 @opindex finhibit-size-directive
11895 Don't output a @code{.size} assembler directive, or anything else that
11896 would cause trouble if the function is split in the middle, and the
11897 two halves are placed at locations far apart in memory.  This option is
11898 used when compiling @file{crtstuff.c}; you should not need to use it
11899 for anything else.
11901 @item -fverbose-asm
11902 @opindex fverbose-asm
11903 Put extra commentary information in the generated assembly code to
11904 make it more readable.  This option is generally only of use to those
11905 who actually need to read the generated assembly code (perhaps while
11906 debugging the compiler itself).
11908 @option{-fno-verbose-asm}, the default, causes the
11909 extra information to be omitted and is useful when comparing two assembler
11910 files.
11912 @item -fpic
11913 @opindex fpic
11914 @cindex global offset table
11915 @cindex PIC
11916 Generate position-independent code (PIC) suitable for use in a shared
11917 library, if supported for the target machine.  Such code accesses all
11918 constant addresses through a global offset table (GOT)@.  The dynamic
11919 loader resolves the GOT entries when the program starts (the dynamic
11920 loader is not part of GCC; it is part of the operating system).  If
11921 the GOT size for the linked executable exceeds a machine-specific
11922 maximum size, you get an error message from the linker indicating that
11923 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11924 instead.  (These maximums are 8k on the SPARC and 32k
11925 on the m68k and RS/6000.  The 386 has no such limit.)
11927 Position-independent code requires special support, and therefore works
11928 only on certain machines.  For the 386, GCC supports PIC for System V
11929 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11930 position-independent.
11932 @item -fPIC
11933 @opindex fPIC
11934 If supported for the target machine, emit position-independent code,
11935 suitable for dynamic linking and avoiding any limit on the size of the
11936 global offset table.  This option makes a difference on the m68k
11937 and the SPARC.
11939 Position-independent code requires special support, and therefore works
11940 only on certain machines.
11942 @item -fpie
11943 @itemx -fPIE
11944 @opindex fpie
11945 @opindex fPIE
11946 These options are similar to @option{-fpic} and @option{-fPIC}, but
11947 generated position independent code can be only linked into executables.
11948 Usually these options are used when @option{-pie} GCC option will be
11949 used during linking.
11951 @item -ffixed-@var{reg}
11952 @opindex ffixed
11953 Treat the register named @var{reg} as a fixed register; generated code
11954 should never refer to it (except perhaps as a stack pointer, frame
11955 pointer or in some other fixed role).
11957 @var{reg} must be the name of a register.  The register names accepted
11958 are machine-specific and are defined in the @code{REGISTER_NAMES}
11959 macro in the machine description macro file.
11961 This flag does not have a negative form, because it specifies a
11962 three-way choice.
11964 @item -fcall-used-@var{reg}
11965 @opindex fcall-used
11966 Treat the register named @var{reg} as an allocable register that is
11967 clobbered by function calls.  It may be allocated for temporaries or
11968 variables that do not live across a call.  Functions compiled this way
11969 will not save and restore the register @var{reg}.
11971 It is an error to used this flag with the frame pointer or stack pointer.
11972 Use of this flag for other registers that have fixed pervasive roles in
11973 the machine's execution model will produce disastrous results.
11975 This flag does not have a negative form, because it specifies a
11976 three-way choice.
11978 @item -fcall-saved-@var{reg}
11979 @opindex fcall-saved
11980 Treat the register named @var{reg} as an allocable register saved by
11981 functions.  It may be allocated even for temporaries or variables that
11982 live across a call.  Functions compiled this way will save and restore
11983 the register @var{reg} if they use it.
11985 It is an error to used this flag with the frame pointer or stack pointer.
11986 Use of this flag for other registers that have fixed pervasive roles in
11987 the machine's execution model will produce disastrous results.
11989 A different sort of disaster will result from the use of this flag for
11990 a register in which function values may be returned.
11992 This flag does not have a negative form, because it specifies a
11993 three-way choice.
11995 @item -fpack-struct[=@var{n}]
11996 @opindex fpack-struct
11997 Without a value specified, pack all structure members together without
11998 holes. When a value is specified (which must be a small power of two), pack
11999 structure members according to this value, representing the maximum
12000 alignment (that is, objects with default alignment requirements larger than
12001 this will be output potentially unaligned at the next fitting location.
12003 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12004 code that is not binary compatible with code generated without that switch.
12005 Additionally, it makes the code suboptimal.
12006 Use it to conform to a non-default application binary interface.
12008 @item -finstrument-functions
12009 @opindex finstrument-functions
12010 Generate instrumentation calls for entry and exit to functions.  Just
12011 after function entry and just before function exit, the following
12012 profiling functions will be called with the address of the current
12013 function and its call site.  (On some platforms,
12014 @code{__builtin_return_address} does not work beyond the current
12015 function, so the call site information may not be available to the
12016 profiling functions otherwise.)
12018 @smallexample
12019 void __cyg_profile_func_enter (void *this_fn,
12020                                void *call_site);
12021 void __cyg_profile_func_exit  (void *this_fn,
12022                                void *call_site);
12023 @end smallexample
12025 The first argument is the address of the start of the current function,
12026 which may be looked up exactly in the symbol table.
12028 This instrumentation is also done for functions expanded inline in other
12029 functions.  The profiling calls will indicate where, conceptually, the
12030 inline function is entered and exited.  This means that addressable
12031 versions of such functions must be available.  If all your uses of a
12032 function are expanded inline, this may mean an additional expansion of
12033 code size.  If you use @samp{extern inline} in your C code, an
12034 addressable version of such functions must be provided.  (This is
12035 normally the case anyways, but if you get lucky and the optimizer always
12036 expands the functions inline, you might have gotten away without
12037 providing static copies.)
12039 A function may be given the attribute @code{no_instrument_function}, in
12040 which case this instrumentation will not be done.  This can be used, for
12041 example, for the profiling functions listed above, high-priority
12042 interrupt routines, and any functions from which the profiling functions
12043 cannot safely be called (perhaps signal handlers, if the profiling
12044 routines generate output or allocate memory).
12046 @item -fstack-check
12047 @opindex fstack-check
12048 Generate code to verify that you do not go beyond the boundary of the
12049 stack.  You should specify this flag if you are running in an
12050 environment with multiple threads, but only rarely need to specify it in
12051 a single-threaded environment since stack overflow is automatically
12052 detected on nearly all systems if there is only one stack.
12054 Note that this switch does not actually cause checking to be done; the
12055 operating system must do that.  The switch causes generation of code
12056 to ensure that the operating system sees the stack being extended.
12058 @item -fstack-limit-register=@var{reg}
12059 @itemx -fstack-limit-symbol=@var{sym}
12060 @itemx -fno-stack-limit
12061 @opindex fstack-limit-register
12062 @opindex fstack-limit-symbol
12063 @opindex fno-stack-limit
12064 Generate code to ensure that the stack does not grow beyond a certain value,
12065 either the value of a register or the address of a symbol.  If the stack
12066 would grow beyond the value, a signal is raised.  For most targets,
12067 the signal is raised before the stack overruns the boundary, so
12068 it is possible to catch the signal without taking special precautions.
12070 For instance, if the stack starts at absolute address @samp{0x80000000}
12071 and grows downwards, you can use the flags
12072 @option{-fstack-limit-symbol=__stack_limit} and
12073 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12074 of 128KB@.  Note that this may only work with the GNU linker.
12076 @cindex aliasing of parameters
12077 @cindex parameters, aliased
12078 @item -fargument-alias
12079 @itemx -fargument-noalias
12080 @itemx -fargument-noalias-global
12081 @opindex fargument-alias
12082 @opindex fargument-noalias
12083 @opindex fargument-noalias-global
12084 Specify the possible relationships among parameters and between
12085 parameters and global data.
12087 @option{-fargument-alias} specifies that arguments (parameters) may
12088 alias each other and may alias global storage.@*
12089 @option{-fargument-noalias} specifies that arguments do not alias
12090 each other, but may alias global storage.@*
12091 @option{-fargument-noalias-global} specifies that arguments do not
12092 alias each other and do not alias global storage.
12094 Each language will automatically use whatever option is required by
12095 the language standard.  You should not need to use these options yourself.
12097 @item -fleading-underscore
12098 @opindex fleading-underscore
12099 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12100 change the way C symbols are represented in the object file.  One use
12101 is to help link with legacy assembly code.
12103 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12104 generate code that is not binary compatible with code generated without that
12105 switch.  Use it to conform to a non-default application binary interface.
12106 Not all targets provide complete support for this switch.
12108 @item -ftls-model=@var{model}
12109 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12110 The @var{model} argument should be one of @code{global-dynamic},
12111 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12113 The default without @option{-fpic} is @code{initial-exec}; with
12114 @option{-fpic} the default is @code{global-dynamic}.
12116 @item -fvisibility=@var{default|internal|hidden|protected}
12117 @opindex fvisibility
12118 Set the default ELF image symbol visibility to the specified option - all
12119 symbols will be marked with this unless overridden within the code.
12120 Using this feature can very substantially improve linking and
12121 load times of shared object libraries, produce more optimized
12122 code, provide near-perfect API export and prevent symbol clashes.
12123 It is @strong{strongly} recommended that you use this in any shared objects
12124 you distribute.
12125      
12126 Despite the nomenclature, @code{default} always means public ie;
12127 available to be linked against from outside the shared object.
12128 @code{protected} and @code{internal} are pretty useless in real-world
12129 usage so the only other commonly used option will be @code{hidden}.
12130 The default if -fvisibility isn't specified is @code{default} ie; make every
12131 symbol public - this causes the same behavior as previous versions of
12132 GCC.
12133      
12134 A good explanation of the benefits offered by ensuring ELF
12135 symbols have the correct visibility is given by ``How To Write
12136 Shared Libraries'' by Ulrich Drepper (which can be found at
12137 @w{@uref{http://people.redhat.com/~drepper/}}) - however a superior
12138 solution made possible by this option to marking things hidden when
12139 the default is public is to make the default hidden and mark things
12140 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12141 and @code{__attribute__ ((visibility("default")))} instead of
12142 @code{__declspec(dllexport)} you get almost identical semantics with
12143 identical syntax. This is a great boon to those working with
12144 cross-platform projects.
12146 For those adding visibility support to existing code, you may find
12147 @samp{#pragma GCC visibility} of use. This works by you enclosing
12148 the declarations you wish to set visibility for with (for example)
12149 @samp{#pragma GCC visibility push(hidden)} and
12150 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
12151 times. Bear in mind that symbol visibility should be viewed @strong{as
12152 part of the API interface contract} and thus all new code should
12153 always specify visibility when it is not the default ie; declarations
12154 only for use within the local DSO should @strong{always} be marked explicitly
12155 as hidden as so to avoid PLT indirection overheads - making this
12156 abundantly clear also aids readability and self-documentation of the code.
12157 Note that due to ISO C++ specification requirements, operator new and
12158 operator delete must always be of default visibility.
12160 An overview of these techniques, their benefits and how to use them
12161 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
12163 @end table
12165 @c man end
12167 @node Environment Variables
12168 @section Environment Variables Affecting GCC
12169 @cindex environment variables
12171 @c man begin ENVIRONMENT
12172 This section describes several environment variables that affect how GCC
12173 operates.  Some of them work by specifying directories or prefixes to use
12174 when searching for various kinds of files.  Some are used to specify other
12175 aspects of the compilation environment.
12177 Note that you can also specify places to search using options such as
12178 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12179 take precedence over places specified using environment variables, which
12180 in turn take precedence over those specified by the configuration of GCC@.
12181 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12182 GNU Compiler Collection (GCC) Internals}.
12184 @table @env
12185 @item LANG
12186 @itemx LC_CTYPE
12187 @c @itemx LC_COLLATE
12188 @itemx LC_MESSAGES
12189 @c @itemx LC_MONETARY
12190 @c @itemx LC_NUMERIC
12191 @c @itemx LC_TIME
12192 @itemx LC_ALL
12193 @findex LANG
12194 @findex LC_CTYPE
12195 @c @findex LC_COLLATE
12196 @findex LC_MESSAGES
12197 @c @findex LC_MONETARY
12198 @c @findex LC_NUMERIC
12199 @c @findex LC_TIME
12200 @findex LC_ALL
12201 @cindex locale
12202 These environment variables control the way that GCC uses
12203 localization information that allow GCC to work with different
12204 national conventions.  GCC inspects the locale categories
12205 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12206 so.  These locale categories can be set to any value supported by your
12207 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12208 Kingdom encoded in UTF-8.
12210 The @env{LC_CTYPE} environment variable specifies character
12211 classification.  GCC uses it to determine the character boundaries in
12212 a string; this is needed for some multibyte encodings that contain quote
12213 and escape characters that would otherwise be interpreted as a string
12214 end or escape.
12216 The @env{LC_MESSAGES} environment variable specifies the language to
12217 use in diagnostic messages.
12219 If the @env{LC_ALL} environment variable is set, it overrides the value
12220 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12221 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12222 environment variable.  If none of these variables are set, GCC
12223 defaults to traditional C English behavior.
12225 @item TMPDIR
12226 @findex TMPDIR
12227 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12228 files.  GCC uses temporary files to hold the output of one stage of
12229 compilation which is to be used as input to the next stage: for example,
12230 the output of the preprocessor, which is the input to the compiler
12231 proper.
12233 @item GCC_EXEC_PREFIX
12234 @findex GCC_EXEC_PREFIX
12235 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12236 names of the subprograms executed by the compiler.  No slash is added
12237 when this prefix is combined with the name of a subprogram, but you can
12238 specify a prefix that ends with a slash if you wish.
12240 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12241 an appropriate prefix to use based on the pathname it was invoked with.
12243 If GCC cannot find the subprogram using the specified prefix, it
12244 tries looking in the usual places for the subprogram.
12246 The default value of @env{GCC_EXEC_PREFIX} is
12247 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12248 of @code{prefix} when you ran the @file{configure} script.
12250 Other prefixes specified with @option{-B} take precedence over this prefix.
12252 This prefix is also used for finding files such as @file{crt0.o} that are
12253 used for linking.
12255 In addition, the prefix is used in an unusual way in finding the
12256 directories to search for header files.  For each of the standard
12257 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12258 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12259 replacing that beginning with the specified prefix to produce an
12260 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12261 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12262 These alternate directories are searched first; the standard directories
12263 come next.
12265 @item COMPILER_PATH
12266 @findex COMPILER_PATH
12267 The value of @env{COMPILER_PATH} is a colon-separated list of
12268 directories, much like @env{PATH}.  GCC tries the directories thus
12269 specified when searching for subprograms, if it can't find the
12270 subprograms using @env{GCC_EXEC_PREFIX}.
12272 @item LIBRARY_PATH
12273 @findex LIBRARY_PATH
12274 The value of @env{LIBRARY_PATH} is a colon-separated list of
12275 directories, much like @env{PATH}.  When configured as a native compiler,
12276 GCC tries the directories thus specified when searching for special
12277 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12278 using GCC also uses these directories when searching for ordinary
12279 libraries for the @option{-l} option (but directories specified with
12280 @option{-L} come first).
12282 @item LANG
12283 @findex LANG
12284 @cindex locale definition
12285 This variable is used to pass locale information to the compiler.  One way in
12286 which this information is used is to determine the character set to be used
12287 when character literals, string literals and comments are parsed in C and C++.
12288 When the compiler is configured to allow multibyte characters,
12289 the following values for @env{LANG} are recognized:
12291 @table @samp
12292 @item C-JIS
12293 Recognize JIS characters.
12294 @item C-SJIS
12295 Recognize SJIS characters.
12296 @item C-EUCJP
12297 Recognize EUCJP characters.
12298 @end table
12300 If @env{LANG} is not defined, or if it has some other value, then the
12301 compiler will use mblen and mbtowc as defined by the default locale to
12302 recognize and translate multibyte characters.
12303 @end table
12305 @noindent
12306 Some additional environments variables affect the behavior of the
12307 preprocessor.
12309 @include cppenv.texi
12311 @c man end
12313 @node Precompiled Headers
12314 @section Using Precompiled Headers
12315 @cindex precompiled headers
12316 @cindex speed of compilation
12318 Often large projects have many header files that are included in every
12319 source file.  The time the compiler takes to process these header files
12320 over and over again can account for nearly all of the time required to
12321 build the project.  To make builds faster, GCC allows users to
12322 `precompile' a header file; then, if builds can use the precompiled
12323 header file they will be much faster.
12325 @strong{Caution:} There are a few known situations where GCC will
12326 crash when trying to use a precompiled header.  If you have trouble
12327 with a precompiled header, you should remove the precompiled header
12328 and compile without it.  In addition, please use GCC's on-line
12329 defect-tracking system to report any problems you encounter with
12330 precompiled headers.  @xref{Bugs}.
12332 To create a precompiled header file, simply compile it as you would any
12333 other file, if necessary using the @option{-x} option to make the driver
12334 treat it as a C or C++ header file.  You will probably want to use a
12335 tool like @command{make} to keep the precompiled header up-to-date when
12336 the headers it contains change.
12338 A precompiled header file will be searched for when @code{#include} is
12339 seen in the compilation.  As it searches for the included file
12340 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12341 compiler looks for a precompiled header in each directory just before it
12342 looks for the include file in that directory.  The name searched for is
12343 the name specified in the @code{#include} with @samp{.gch} appended.  If
12344 the precompiled header file can't be used, it is ignored.
12346 For instance, if you have @code{#include "all.h"}, and you have
12347 @file{all.h.gch} in the same directory as @file{all.h}, then the
12348 precompiled header file will be used if possible, and the original
12349 header will be used otherwise.
12351 Alternatively, you might decide to put the precompiled header file in a
12352 directory and use @option{-I} to ensure that directory is searched
12353 before (or instead of) the directory containing the original header.
12354 Then, if you want to check that the precompiled header file is always
12355 used, you can put a file of the same name as the original header in this
12356 directory containing an @code{#error} command.
12358 This also works with @option{-include}.  So yet another way to use
12359 precompiled headers, good for projects not designed with precompiled
12360 header files in mind, is to simply take most of the header files used by
12361 a project, include them from another header file, precompile that header
12362 file, and @option{-include} the precompiled header.  If the header files
12363 have guards against multiple inclusion, they will be skipped because
12364 they've already been included (in the precompiled header).
12366 If you need to precompile the same header file for different
12367 languages, targets, or compiler options, you can instead make a
12368 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12369 header in the directory, perhaps using @option{-o}.  It doesn't matter
12370 what you call the files in the directory, every precompiled header in
12371 the directory will be considered.  The first precompiled header
12372 encountered in the directory that is valid for this compilation will
12373 be used; they're searched in no particular order.
12375 There are many other possibilities, limited only by your imagination,
12376 good sense, and the constraints of your build system.
12378 A precompiled header file can be used only when these conditions apply:
12380 @itemize
12381 @item
12382 Only one precompiled header can be used in a particular compilation.
12384 @item
12385 A precompiled header can't be used once the first C token is seen.  You
12386 can have preprocessor directives before a precompiled header; you can
12387 even include a precompiled header from inside another header, so long as
12388 there are no C tokens before the @code{#include}.
12390 @item
12391 The precompiled header file must be produced for the same language as
12392 the current compilation.  You can't use a C precompiled header for a C++
12393 compilation.
12395 @item
12396 The precompiled header file must be produced by the same compiler
12397 version and configuration as the current compilation is using.
12398 The easiest way to guarantee this is to use the same compiler binary
12399 for creating and using precompiled headers.
12401 @item
12402 Any macros defined before the precompiled header is included must
12403 either be defined in the same way as when the precompiled header was
12404 generated, or must not affect the precompiled header, which usually
12405 means that the they don't appear in the precompiled header at all.
12407 The @option{-D} option is one way to define a macro before a
12408 precompiled header is included; using a @code{#define} can also do it.
12409 There are also some options that define macros implicitly, like
12410 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12411 defined this way.
12413 @item If debugging information is output when using the precompiled
12414 header, using @option{-g} or similar, the same kind of debugging information
12415 must have been output when building the precompiled header.  However,
12416 a precompiled header built using @option{-g} can be used in a compilation
12417 when no debugging information is being output.
12419 @item The same @option{-m} options must generally be used when building
12420 and using the precompiled header.  @xref{Submodel Options},
12421 for any cases where this rule is relaxed.
12423 @item Each of the following options must be the same when building and using
12424 the precompiled header:
12426 @gccoptlist{-fexceptions -funit-at-a-time}
12428 @item
12429 Some other command-line options starting with @option{-f},
12430 @option{-p}, or @option{-O} must be defined in the same way as when
12431 the precompiled header was generated.  At present, it's not clear
12432 which options are safe to change and which are not; the safest choice
12433 is to use exactly the same options when generating and using the
12434 precompiled header.  The following are known to be safe:
12436 @gccoptlist{-fpreprocessed -pedantic-errors}
12438 @end itemize
12440 For all of these except the last, the compiler will automatically
12441 ignore the precompiled header if the conditions aren't met.  If you
12442 find an option combination that doesn't work and doesn't cause the
12443 precompiled header to be ignored, please consider filing a bug report,
12444 see @ref{Bugs}.
12446 If you do use differing options when generating and using the
12447 precompiled header, the actual behavior will be a mixture of the
12448 behavior for the options.  For instance, if you use @option{-g} to
12449 generate the precompiled header but not when using it, you may or may
12450 not get debugging information for routines in the precompiled header.
12452 @node Running Protoize
12453 @section Running Protoize
12455 The program @code{protoize} is an optional part of GCC@.  You can use
12456 it to add prototypes to a program, thus converting the program to ISO
12457 C in one respect.  The companion program @code{unprotoize} does the
12458 reverse: it removes argument types from any prototypes that are found.
12460 When you run these programs, you must specify a set of source files as
12461 command line arguments.  The conversion programs start out by compiling
12462 these files to see what functions they define.  The information gathered
12463 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12465 After scanning comes actual conversion.  The specified files are all
12466 eligible to be converted; any files they include (whether sources or
12467 just headers) are eligible as well.
12469 But not all the eligible files are converted.  By default,
12470 @code{protoize} and @code{unprotoize} convert only source and header
12471 files in the current directory.  You can specify additional directories
12472 whose files should be converted with the @option{-d @var{directory}}
12473 option.  You can also specify particular files to exclude with the
12474 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12475 directory name matches one of the specified directory names, and its
12476 name within the directory has not been excluded.
12478 Basic conversion with @code{protoize} consists of rewriting most
12479 function definitions and function declarations to specify the types of
12480 the arguments.  The only ones not rewritten are those for varargs
12481 functions.
12483 @code{protoize} optionally inserts prototype declarations at the
12484 beginning of the source file, to make them available for any calls that
12485 precede the function's definition.  Or it can insert prototype
12486 declarations with block scope in the blocks where undeclared functions
12487 are called.
12489 Basic conversion with @code{unprotoize} consists of rewriting most
12490 function declarations to remove any argument types, and rewriting
12491 function definitions to the old-style pre-ISO form.
12493 Both conversion programs print a warning for any function declaration or
12494 definition that they can't convert.  You can suppress these warnings
12495 with @option{-q}.
12497 The output from @code{protoize} or @code{unprotoize} replaces the
12498 original source file.  The original file is renamed to a name ending
12499 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12500 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12501 for DOS) file already exists, then the source file is simply discarded.
12503 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12504 scan the program and collect information about the functions it uses.
12505 So neither of these programs will work until GCC is installed.
12507 Here is a table of the options you can use with @code{protoize} and
12508 @code{unprotoize}.  Each option works with both programs unless
12509 otherwise stated.
12511 @table @code
12512 @item -B @var{directory}
12513 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12514 usual directory (normally @file{/usr/local/lib}).  This file contains
12515 prototype information about standard system functions.  This option
12516 applies only to @code{protoize}.
12518 @item -c @var{compilation-options}
12519 Use @var{compilation-options} as the options when running @command{gcc} to
12520 produce the @samp{.X} files.  The special option @option{-aux-info} is
12521 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12523 Note that the compilation options must be given as a single argument to
12524 @code{protoize} or @code{unprotoize}.  If you want to specify several
12525 @command{gcc} options, you must quote the entire set of compilation options
12526 to make them a single word in the shell.
12528 There are certain @command{gcc} arguments that you cannot use, because they
12529 would produce the wrong kind of output.  These include @option{-g},
12530 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12531 the @var{compilation-options}, they are ignored.
12533 @item -C
12534 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12535 systems) instead of @samp{.c}.  This is convenient if you are converting
12536 a C program to C++.  This option applies only to @code{protoize}.
12538 @item -g
12539 Add explicit global declarations.  This means inserting explicit
12540 declarations at the beginning of each source file for each function
12541 that is called in the file and was not declared.  These declarations
12542 precede the first function definition that contains a call to an
12543 undeclared function.  This option applies only to @code{protoize}.
12545 @item -i @var{string}
12546 Indent old-style parameter declarations with the string @var{string}.
12547 This option applies only to @code{protoize}.
12549 @code{unprotoize} converts prototyped function definitions to old-style
12550 function definitions, where the arguments are declared between the
12551 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12552 uses five spaces as the indentation.  If you want to indent with just
12553 one space instead, use @option{-i " "}.
12555 @item -k
12556 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12557 is finished.
12559 @item -l
12560 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12561 a prototype declaration for each function in each block which calls the
12562 function without any declaration.  This option applies only to
12563 @code{protoize}.
12565 @item -n
12566 Make no real changes.  This mode just prints information about the conversions
12567 that would have been done without @option{-n}.
12569 @item -N
12570 Make no @samp{.save} files.  The original files are simply deleted.
12571 Use this option with caution.
12573 @item -p @var{program}
12574 Use the program @var{program} as the compiler.  Normally, the name
12575 @file{gcc} is used.
12577 @item -q
12578 Work quietly.  Most warnings are suppressed.
12580 @item -v
12581 Print the version number, just like @option{-v} for @command{gcc}.
12582 @end table
12584 If you need special compiler options to compile one of your program's
12585 source files, then you should generate that file's @samp{.X} file
12586 specially, by running @command{gcc} on that source file with the
12587 appropriate options and the option @option{-aux-info}.  Then run
12588 @code{protoize} on the entire set of files.  @code{protoize} will use
12589 the existing @samp{.X} file because it is newer than the source file.
12590 For example:
12592 @smallexample
12593 gcc -Dfoo=bar file1.c -aux-info file1.X
12594 protoize *.c
12595 @end smallexample
12597 @noindent
12598 You need to include the special files along with the rest in the
12599 @code{protoize} command, even though their @samp{.X} files already
12600 exist, because otherwise they won't get converted.
12602 @xref{Protoize Caveats}, for more information on how to use
12603 @code{protoize} successfully.