* doc/invoke.texi (Optimize Options): Document -frename-registers
[official-gcc.git] / gcc / doc / invoke.texi
blobd094b724fb19e86dcc7c2bdb5eb8cba916039d93
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 Dialect Options:: Variations on Objective-C.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -Wabi  -Wctor-dtor-privacy @gol
186 -Wnon-virtual-dtor  -Wreorder @gol
187 -Weffc++  -Wno-deprecated @gol
188 -Wno-non-template-friend  -Wold-style-cast @gol
189 -Woverloaded-virtual  -Wno-pmf-conversions @gol
190 -Wsign-promo  -Wsynth}
192 @item Objective-C Language Options
193 @xref{Objective-C Dialect Options,,Options Controlling Objective-C Dialect}.
194 @gccoptlist{
195 -fconstant-string-class=@var{class-name} @gol
196 -fgnu-runtime  -fnext-runtime @gol
197 -fno-nil-receivers @gol
198 -fobjc-exceptions @gol
199 -freplace-objc-classes @gol
200 -fzero-link @gol
201 -gen-decls @gol
202 -Wno-protocol  -Wselector -Wundeclared-selector}
204 @item Language Independent Options
205 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
206 @gccoptlist{-fmessage-length=@var{n}  @gol
207 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
209 @item Warning Options
210 @xref{Warning Options,,Options to Request or Suppress Warnings}.
211 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
212 -w  -Wextra  -Wall  -Waggregate-return @gol
213 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
214 -Wconversion  -Wno-deprecated-declarations @gol
215 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
216 -Werror  -Werror-implicit-function-declaration @gol
217 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
218 -Wno-format-extra-args -Wformat-nonliteral @gol
219 -Wformat-security  -Wformat-y2k @gol
220 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
221 -Wimport  -Wno-import  -Winit-self  -Winline @gol
222 -Wno-invalid-offsetof  -Winvalid-pch @gol
223 -Wlarger-than-@var{len}  -Wlong-long @gol
224 -Wmain  -Wmissing-braces @gol
225 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
226 -Wmissing-noreturn @gol
227 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
228 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
229 -Wreturn-type  -Wsequence-point  -Wshadow @gol
230 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
231 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
232 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
233 -Wunknown-pragmas  -Wunreachable-code @gol
234 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
235 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
236 -Wvariadic-macros}
238 @item C-only Warning Options
239 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
240 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
241 -Wstrict-prototypes  -Wtraditional @gol
242 -Wdeclaration-after-statement}
244 @item Debugging Options
245 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
246 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
247 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
248 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
249 -fdump-tree-all @gol
250 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
251 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
253 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
254 -fdump-tree-ch @gol
255 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
258 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-nrv @gol
264 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
266 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
267 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
268 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
269 -ftest-coverage  -ftime-report -fvar-tracking @gol
270 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
271 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
272 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
273 -print-multi-directory  -print-multi-lib @gol
274 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
275 -save-temps  -time}
277 @item Optimization Options
278 @xref{Optimize Options,,Options that Control Optimization}.
279 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
280 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
281 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
282 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
283 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
284 -fcaller-saves  -fcprop-registers @gol
285 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
286 -fdelayed-branch  -fdelete-null-pointer-checks @gol
287 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
288 -fforce-addr  -fforce-mem  -ffunction-sections @gol
289 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
290 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
291 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
292 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
293 -fmodulo-sched -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
294 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
295 -fno-function-cse  -fno-guess-branch-probability @gol
296 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
297 -funsafe-math-optimizations  -ffinite-math-only @gol
298 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
299 -fomit-frame-pointer  -foptimize-register-move @gol
300 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
301 -fprofile-generate -fprofile-use @gol
302 -freduce-all-givs  -fregmove  -frename-registers @gol
303 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
304 -frerun-cse-after-loop  -frerun-loop-opt @gol
305 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
306 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
307 -fsched-spec-load-dangerous  @gol
308 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
309 -fsched2-use-superblocks @gol
310 -fsched2-use-traces  -fsignaling-nans @gol
311 -fsingle-precision-constant  @gol
312 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
313 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
314 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
315 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
316 -ftree-lim @gol
317 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
318 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre @gol
319 --param @var{name}=@var{value}
320 -O  -O0  -O1  -O2  -O3  -Os}
322 @item Preprocessor Options
323 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
324 @gccoptlist{-A@var{question}=@var{answer} @gol
325 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
326 -C  -dD  -dI  -dM  -dN @gol
327 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
328 -idirafter @var{dir} @gol
329 -include @var{file}  -imacros @var{file} @gol
330 -iprefix @var{file}  -iwithprefix @var{dir} @gol
331 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
332 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
333 -P  -fworking-directory  -remap @gol
334 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
335 -Xpreprocessor @var{option}}
337 @item Assembler Option
338 @xref{Assembler Options,,Passing Options to the Assembler}.
339 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
341 @item Linker Options
342 @xref{Link Options,,Options for Linking}.
343 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
344 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
345 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
346 -Wl,@var{option}  -Xlinker @var{option} @gol
347 -u @var{symbol}}
349 @item Directory Options
350 @xref{Directory Options,,Options for Directory Search}.
351 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
353 @item Target Options
354 @c I wrote this xref this way to avoid overfull hbox. -- rms
355 @xref{Target Options}.
356 @gccoptlist{-V @var{version}  -b @var{machine}}
358 @item Machine Dependent Options
359 @xref{Submodel Options,,Hardware Models and Configurations}.
360 @c This list is ordered alphanumerically by subsection name.
361 @c Try and put the significant identifier (CPU or system) first,
362 @c so users have a clue at guessing where the ones they want will be.
364 @emph{ARC Options}
365 @gccoptlist{-EB  -EL @gol
366 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
367 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
369 @emph{ARM Options}
370 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
371 -mabi=@var{name} @gol
372 -mapcs-stack-check  -mno-apcs-stack-check @gol
373 -mapcs-float  -mno-apcs-float @gol
374 -mapcs-reentrant  -mno-apcs-reentrant @gol
375 -msched-prolog  -mno-sched-prolog @gol
376 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
377 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
378 -mthumb-interwork  -mno-thumb-interwork @gol
379 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
380 -mstructure-size-boundary=@var{n} @gol
381 -mabort-on-noreturn @gol
382 -mlong-calls  -mno-long-calls @gol
383 -msingle-pic-base  -mno-single-pic-base @gol
384 -mpic-register=@var{reg} @gol
385 -mnop-fun-dllimport @gol
386 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
387 -mpoke-function-name @gol
388 -mthumb  -marm @gol
389 -mtpcs-frame  -mtpcs-leaf-frame @gol
390 -mcaller-super-interworking  -mcallee-super-interworking}
392 @emph{AVR Options}
393 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
394 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
396 @emph{CRIS Options}
397 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
398 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
399 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
400 -mstack-align  -mdata-align  -mconst-align @gol
401 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
402 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
403 -mmul-bug-workaround  -mno-mul-bug-workaround}
405 @emph{Darwin Options}
406 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
407 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
408 -client_name  -compatibility_version  -current_version @gol
409 -dependency-file  -dylib_file  -dylinker_install_name @gol
410 -dynamic  -dynamiclib  -exported_symbols_list @gol
411 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
412 -force_flat_namespace  -headerpad_max_install_names @gol
413 -image_base  -init  -install_name  -keep_private_externs @gol
414 -multi_module  -multiply_defined  -multiply_defined_unused @gol
415 -noall_load  -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
416 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
417 -private_bundle  -read_only_relocs  -sectalign @gol
418 -sectobjectsymbols  -whyload  -seg1addr @gol
419 -sectcreate  -sectobjectsymbols  -sectorder @gol
420 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
421 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
422 -single_module  -static  -sub_library  -sub_umbrella @gol
423 -twolevel_namespace  -umbrella  -undefined @gol
424 -unexported_symbols_list  -weak_reference_mismatches @gol
425 -whatsloaded -F}
427 @emph{DEC Alpha Options}
428 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
429 -mieee  -mieee-with-inexact  -mieee-conformant @gol
430 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
431 -mtrap-precision=@var{mode}  -mbuild-constants @gol
432 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
433 -mbwx  -mmax  -mfix  -mcix @gol
434 -mfloat-vax  -mfloat-ieee @gol
435 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
436 -msmall-text  -mlarge-text @gol
437 -mmemory-latency=@var{time}}
439 @emph{DEC Alpha/VMS Options}
440 @gccoptlist{-mvms-return-codes}
442 @emph{FRV Options}
443 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
444 -mhard-float  -msoft-float @gol
445 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
446 -mdouble  -mno-double @gol
447 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
448 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic -mlinked-fp @gol
449 -mlibrary-pic  -macc-4 -macc-8 @gol
450 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
451 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
452 -mvliw-branch  -mno-vliw-branch @gol
453 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
454 -mno-nested-cond-exec  -mtomcat-stats @gol
455 -mcpu=@var{cpu}}
457 @emph{H8/300 Options}
458 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
460 @emph{HPPA Options}
461 @gccoptlist{-march=@var{architecture-type} @gol
462 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
463 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
464 -mjump-in-delay -mlinker-opt -mlong-calls @gol
465 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
466 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
467 -mno-jump-in-delay  -mno-long-load-store @gol
468 -mno-portable-runtime  -mno-soft-float @gol
469 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
470 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
471 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
472 -nolibdld  -static  -threads}
474 @emph{i386 and x86-64 Options}
475 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
476 -mfpmath=@var{unit} @gol
477 -masm=@var{dialect}  -mno-fancy-math-387 @gol
478 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
479 -mno-wide-multiply  -mrtd  -malign-double @gol
480 -mpreferred-stack-boundary=@var{num} @gol
481 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
482 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
483 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
484 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
485 -mno-red-zone -mno-tls-direct-seg-refs @gol
486 -mcmodel=@var{code-model} @gol
487 -m32  -m64}
489 @emph{IA-64 Options}
490 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
491 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
492 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
493 -minline-float-divide-max-throughput @gol
494 -minline-int-divide-min-latency @gol
495 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
496 -mfixed-range=@var{register-range}}
498 @emph{M32R/D Options}
499 @gccoptlist{-m32r2 -m32rx -m32r @gol
500 -mdebug @gol
501 -malign-loops -mno-align-loops @gol
502 -missue-rate=@var{number} @gol
503 -mbranch-cost=@var{number} @gol
504 -mmodel=@var{code-size-model-type} @gol
505 -msdata=@var{sdata-type} @gol
506 -mno-flush-func -mflush-func=@var{name} @gol
507 -mno-flush-trap -mflush-trap=@var{number} @gol
508 -G @var{num}}
510 @emph{M680x0 Options}
511 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
512 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
513 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
514 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
515 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
517 @emph{M68hc1x Options}
518 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
519 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
520 -msoft-reg-count=@var{count}}
522 @emph{MCore Options}
523 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
524 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
525 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
526 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
527 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
529 @emph{MIPS Options}
530 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
531 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
532 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
533 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
534 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
535 -mint64  -mlong64  -mlong32 @gol
536 -G@var{num}  -membedded-data  -mno-embedded-data @gol
537 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
538 -msplit-addresses  -mno-split-addresses  @gol
539 -mexplicit-relocs  -mno-explicit-relocs  @gol
540 -mrnames  -mno-rnames @gol
541 -mcheck-zero-division  -mno-check-zero-division @gol
542 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
543 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
544 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
545 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
546 -mflush-func=@var{func}  -mno-flush-func @gol
547 -mbranch-likely  -mno-branch-likely @gol
548 -mfp-exceptions -mno-fp-exceptions @gol
549 -mvr4130-align -mno-vr4130-align}
551 @emph{MMIX Options}
552 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
553 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
554 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
555 -mno-base-addresses  -msingle-exit  -mno-single-exit}
557 @emph{MN10300 Options}
558 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
559 -mam33  -mno-am33 @gol
560 -mam33-2  -mno-am33-2 @gol
561 -mno-crt0  -mrelax}
563 @emph{NS32K Options}
564 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
565 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
566 -mregparam  -mnoregparam  -msb  -mnosb @gol
567 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
569 @emph{PDP-11 Options}
570 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
571 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
572 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
573 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
574 -mbranch-expensive  -mbranch-cheap @gol
575 -msplit  -mno-split  -munix-asm  -mdec-asm}
577 @emph{PowerPC Options}
578 See RS/6000 and PowerPC Options.
580 @emph{RS/6000 and PowerPC Options}
581 @gccoptlist{-mcpu=@var{cpu-type} @gol
582 -mtune=@var{cpu-type} @gol
583 -mpower  -mno-power  -mpower2  -mno-power2 @gol
584 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
585 -maltivec  -mno-altivec @gol
586 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
587 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
588 -mnew-mnemonics  -mold-mnemonics @gol
589 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
590 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
591 -malign-power  -malign-natural @gol
592 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
593 -mstring  -mno-string  -mupdate  -mno-update @gol
594 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
595 -mstrict-align  -mno-strict-align  -mrelocatable @gol
596 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
597 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
598 -mdynamic-no-pic @gol
599 -mprioritize-restricted-insns=@var{priority} @gol
600 -msched-costly-dep=@var{dependence_type} @gol
601 -minsert-sched-nops=@var{scheme} @gol
602 -mcall-sysv  -mcall-netbsd @gol
603 -maix-struct-return  -msvr4-struct-return @gol
604 -mabi=altivec  -mabi=no-altivec @gol
605 -mabi=spe  -mabi=no-spe @gol
606 -misel=yes  -misel=no @gol
607 -mspe=yes  -mspe=no @gol
608 -mfloat-gprs=yes  -mfloat-gprs=no @gol
609 -mprototype  -mno-prototype @gol
610 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
611 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
613 @emph{S/390 and zSeries Options}
614 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
615 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
616 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
617 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
618 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd}
620 @emph{SH Options}
621 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
622 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
623 -m5-64media  -m5-64media-nofpu @gol
624 -m5-32media  -m5-32media-nofpu @gol
625 -m5-compact  -m5-compact-nofpu @gol
626 -mb  -ml  -mdalign  -mrelax @gol
627 -mbigtable  -mfmovd  -mhitachi  -mnomacsave @gol
628 -mieee  -misize  -mpadstruct  -mspace @gol
629 -mprefergot  -musermode}
631 @emph{SPARC Options}
632 @gccoptlist{-mcpu=@var{cpu-type} @gol
633 -mtune=@var{cpu-type} @gol
634 -mcmodel=@var{code-model} @gol
635 -m32  -m64  -mapp-regs  -mno-app-regs @gol
636 -mfaster-structs  -mno-faster-structs @gol
637 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
638 -mhard-quad-float  -msoft-quad-float @gol
639 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
640 -mstack-bias  -mno-stack-bias @gol
641 -munaligned-doubles  -mno-unaligned-doubles @gol
642 -mv8plus  -mno-v8plus  -mvis  -mno-vis}
644 @emph{System V Options}
645 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
647 @emph{TMS320C3x/C4x Options}
648 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
649 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
650 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
651 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
653 @emph{V850 Options}
654 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
655 -mprolog-function  -mno-prolog-function  -mspace @gol
656 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
657 -mapp-regs  -mno-app-regs @gol
658 -mdisable-callt  -mno-disable-callt @gol
659 -mv850e1 @gol
660 -mv850e @gol
661 -mv850  -mbig-switch}
663 @emph{VAX Options}
664 @gccoptlist{-mg  -mgnu  -munix}
666 @emph{x86-64 Options}
667 See i386 and x86-64 Options.
669 @emph{Xstormy16 Options}
670 @gccoptlist{-msim}
672 @emph{Xtensa Options}
673 @gccoptlist{-mconst16 -mno-const16 @gol
674 -mfused-madd  -mno-fused-madd @gol
675 -mtext-section-literals  -mno-text-section-literals @gol
676 -mtarget-align  -mno-target-align @gol
677 -mlongcalls  -mno-longcalls}
679 @emph{zSeries Options}
680 See S/390 and zSeries Options.
682 @item Code Generation Options
683 @xref{Code Gen Options,,Options for Code Generation Conventions}.
684 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
685 -ffixed-@var{reg}  -fexceptions @gol
686 -fnon-call-exceptions  -funwind-tables @gol
687 -fasynchronous-unwind-tables @gol
688 -finhibit-size-directive  -finstrument-functions @gol
689 -fno-common  -fno-ident @gol
690 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
691 -freg-struct-return  -fshared-data  -fshort-enums @gol
692 -fshort-double  -fshort-wchar @gol
693 -fverbose-asm  -fpack-struct  -fstack-check @gol
694 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
695 -fargument-alias  -fargument-noalias @gol
696 -fargument-noalias-global  -fleading-underscore @gol
697 -ftls-model=@var{model} @gol
698 -ftrapv  -fwrapv  -fbounds-check}
699 @end table
701 @menu
702 * Overall Options::     Controlling the kind of output:
703                         an executable, object files, assembler files,
704                         or preprocessed source.
705 * C Dialect Options::   Controlling the variant of C language compiled.
706 * C++ Dialect Options:: Variations on C++.
707 * Objective-C Dialect Options:: Variations on Objective-C.
708 * Language Independent Options:: Controlling how diagnostics should be
709                         formatted.
710 * Warning Options::     How picky should the compiler be?
711 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
712 * Optimize Options::    How much optimization?
713 * Preprocessor Options:: Controlling header files and macro definitions.
714                          Also, getting dependency information for Make.
715 * Assembler Options::   Passing options to the assembler.
716 * Link Options::        Specifying libraries and so on.
717 * Directory Options::   Where to find header files and libraries.
718                         Where to find the compiler executable files.
719 * Spec Files::          How to pass switches to sub-processes.
720 * Target Options::      Running a cross-compiler, or an old version of GCC.
721 @end menu
723 @node Overall Options
724 @section Options Controlling the Kind of Output
726 Compilation can involve up to four stages: preprocessing, compilation
727 proper, assembly and linking, always in that order.  GCC is capable of
728 preprocessing and compiling several files either into several
729 assembler input files, or into one assembler input file; then each
730 assembler input file produces an object file, and linking combines all
731 the object files (those newly compiled, and those specified as input)
732 into an executable file.
734 @cindex file name suffix
735 For any given input file, the file name suffix determines what kind of
736 compilation is done:
738 @table @gcctabopt
739 @item @var{file}.c
740 C source code which must be preprocessed.
742 @item @var{file}.i
743 C source code which should not be preprocessed.
745 @item @var{file}.ii
746 C++ source code which should not be preprocessed.
748 @item @var{file}.m
749 Objective-C source code.  Note that you must link with the library
750 @file{libobjc.a} to make an Objective-C program work.
752 @item @var{file}.mi
753 Objective-C source code which should not be preprocessed.
755 @item @var{file}.h
756 C or C++ header file to be turned into a precompiled header.
758 @item @var{file}.cc
759 @itemx @var{file}.cp
760 @itemx @var{file}.cxx
761 @itemx @var{file}.cpp
762 @itemx @var{file}.CPP
763 @itemx @var{file}.c++
764 @itemx @var{file}.C
765 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
766 the last two letters must both be literally @samp{x}.  Likewise,
767 @samp{.C} refers to a literal capital C@.
769 @item @var{file}.hh
770 @itemx @var{file}.H
771 C++ header file to be turned into a precompiled header.
773 @item @var{file}.f
774 @itemx @var{file}.for
775 @itemx @var{file}.FOR
776 Fortran source code which should not be preprocessed.
778 @item @var{file}.F
779 @itemx @var{file}.fpp
780 @itemx @var{file}.FPP
781 Fortran source code which must be preprocessed (with the traditional
782 preprocessor).
784 @item @var{file}.r
785 Fortran source code which must be preprocessed with a RATFOR
786 preprocessor (not included with GCC)@.
788 @item @var{file}.f90
789 @itemx @var{file}.f95
790 Fortran 90/95 source code which should not be preprocessed.
792 @c FIXME: Descriptions of Java file types.
793 @c @var{file}.java
794 @c @var{file}.class
795 @c @var{file}.zip
796 @c @var{file}.jar
798 @item @var{file}.ads
799 Ada source code file which contains a library unit declaration (a
800 declaration of a package, subprogram, or generic, or a generic
801 instantiation), or a library unit renaming declaration (a package,
802 generic, or subprogram renaming declaration).  Such files are also
803 called @dfn{specs}.
805 @itemx @var{file}.adb
806 Ada source code file containing a library unit body (a subprogram or
807 package body).  Such files are also called @dfn{bodies}.
809 @c GCC also knows about some suffixes for languages not yet included:
810 @c Pascal:
811 @c @var{file}.p
812 @c @var{file}.pas
814 @item @var{file}.s
815 Assembler code.
817 @item @var{file}.S
818 Assembler code which must be preprocessed.
820 @item @var{other}
821 An object file to be fed straight into linking.
822 Any file name with no recognized suffix is treated this way.
823 @end table
825 @opindex x
826 You can specify the input language explicitly with the @option{-x} option:
828 @table @gcctabopt
829 @item -x @var{language}
830 Specify explicitly the @var{language} for the following input files
831 (rather than letting the compiler choose a default based on the file
832 name suffix).  This option applies to all following input files until
833 the next @option{-x} option.  Possible values for @var{language} are:
834 @smallexample
835 c  c-header  cpp-output
836 c++  c++-header  c++-cpp-output
837 objective-c  objective-c-header  objc-cpp-output
838 assembler  assembler-with-cpp
840 f77  f77-cpp-input  ratfor
842 java
843 treelang
844 @end smallexample
846 @item -x none
847 Turn off any specification of a language, so that subsequent files are
848 handled according to their file name suffixes (as they are if @option{-x}
849 has not been used at all).
851 @item -pass-exit-codes
852 @opindex pass-exit-codes
853 Normally the @command{gcc} program will exit with the code of 1 if any
854 phase of the compiler returns a non-success return code.  If you specify
855 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
856 numerically highest error produced by any phase that returned an error
857 indication.
858 @end table
860 If you only want some of the stages of compilation, you can use
861 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
862 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
863 @command{gcc} is to stop.  Note that some combinations (for example,
864 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
866 @table @gcctabopt
867 @item -c
868 @opindex c
869 Compile or assemble the source files, but do not link.  The linking
870 stage simply is not done.  The ultimate output is in the form of an
871 object file for each source file.
873 By default, the object file name for a source file is made by replacing
874 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
876 Unrecognized input files, not requiring compilation or assembly, are
877 ignored.
879 @item -S
880 @opindex S
881 Stop after the stage of compilation proper; do not assemble.  The output
882 is in the form of an assembler code file for each non-assembler input
883 file specified.
885 By default, the assembler file name for a source file is made by
886 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
888 Input files that don't require compilation are ignored.
890 @item -E
891 @opindex E
892 Stop after the preprocessing stage; do not run the compiler proper.  The
893 output is in the form of preprocessed source code, which is sent to the
894 standard output.
896 Input files which don't require preprocessing are ignored.
898 @cindex output file option
899 @item -o @var{file}
900 @opindex o
901 Place output in file @var{file}.  This applies regardless to whatever
902 sort of output is being produced, whether it be an executable file,
903 an object file, an assembler file or preprocessed C code.
905 If @option{-o} is not specified, the default is to put an executable
906 file in @file{a.out}, the object file for
907 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
908 assembler file in @file{@var{source}.s}, a precompiled header file in
909 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
910 standard output.
912 @item -v
913 @opindex v
914 Print (on standard error output) the commands executed to run the stages
915 of compilation.  Also print the version number of the compiler driver
916 program and of the preprocessor and the compiler proper.
918 @item -###
919 @opindex ###
920 Like @option{-v} except the commands are not executed and all command
921 arguments are quoted.  This is useful for shell scripts to capture the
922 driver-generated command lines.
924 @item -pipe
925 @opindex pipe
926 Use pipes rather than temporary files for communication between the
927 various stages of compilation.  This fails to work on some systems where
928 the assembler is unable to read from a pipe; but the GNU assembler has
929 no trouble.
931 @item -combine
932 @opindex combine
933 If you are compiling multiple source files, this option tells the driver
934 to pass all the source files to the compiler at once (for those
935 languages for which the compiler can handle this).  This will allow
936 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
937 language for which this is supported is C.  If you pass source files for
938 multiple languages to the driver, using this option, the driver will invoke
939 the compiler(s) that support IMA once each, passing each compiler all the
940 source files appropriate for it.  For those languages that do not support
941 IMA this option will be ignored, and the compiler will be invoked once for
942 each source file in that language.  If you use this option in conjunction
943 with -save-temps, the compiler will generate multiple pre-processed files
944 (one for each source file), but only one (combined) .o or .s file.
946 @item --help
947 @opindex help
948 Print (on the standard output) a description of the command line options
949 understood by @command{gcc}.  If the @option{-v} option is also specified
950 then @option{--help} will also be passed on to the various processes
951 invoked by @command{gcc}, so that they can display the command line options
952 they accept.  If the @option{-Wextra} option is also specified then command
953 line options which have no documentation associated with them will also
954 be displayed.
956 @item --target-help
957 @opindex target-help
958 Print (on the standard output) a description of target specific command
959 line options for each tool.
961 @item --version
962 @opindex version
963 Display the version number and copyrights of the invoked GCC.
964 @end table
966 @node Invoking G++
967 @section Compiling C++ Programs
969 @cindex suffixes for C++ source
970 @cindex C++ source file suffixes
971 C++ source files conventionally use one of the suffixes @samp{.C},
972 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
973 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
974 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
975 files with these names and compiles them as C++ programs even if you
976 call the compiler the same way as for compiling C programs (usually
977 with the name @command{gcc}).
979 @findex g++
980 @findex c++
981 However, C++ programs often require class libraries as well as a
982 compiler that understands the C++ language---and under some
983 circumstances, you might want to compile programs or header files from
984 standard input, or otherwise without a suffix that flags them as C++
985 programs.  You might also like to precompile a C header file with a
986 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
987 program that calls GCC with the default language set to C++, and
988 automatically specifies linking against the C++ library.  On many
989 systems, @command{g++} is also installed with the name @command{c++}.
991 @cindex invoking @command{g++}
992 When you compile C++ programs, you may specify many of the same
993 command-line options that you use for compiling programs in any
994 language; or command-line options meaningful for C and related
995 languages; or options that are meaningful only for C++ programs.
996 @xref{C Dialect Options,,Options Controlling C Dialect}, for
997 explanations of options for languages related to C@.
998 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
999 explanations of options that are meaningful only for C++ programs.
1001 @node C Dialect Options
1002 @section Options Controlling C Dialect
1003 @cindex dialect options
1004 @cindex language dialect options
1005 @cindex options, dialect
1007 The following options control the dialect of C (or languages derived
1008 from C, such as C++ and Objective-C) that the compiler accepts:
1010 @table @gcctabopt
1011 @cindex ANSI support
1012 @cindex ISO support
1013 @item -ansi
1014 @opindex ansi
1015 In C mode, support all ISO C90 programs.  In C++ mode,
1016 remove GNU extensions that conflict with ISO C++.
1018 This turns off certain features of GCC that are incompatible with ISO
1019 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1020 such as the @code{asm} and @code{typeof} keywords, and
1021 predefined macros such as @code{unix} and @code{vax} that identify the
1022 type of system you are using.  It also enables the undesirable and
1023 rarely used ISO trigraph feature.  For the C compiler,
1024 it disables recognition of C++ style @samp{//} comments as well as
1025 the @code{inline} keyword.
1027 The alternate keywords @code{__asm__}, @code{__extension__},
1028 @code{__inline__} and @code{__typeof__} continue to work despite
1029 @option{-ansi}.  You would not want to use them in an ISO C program, of
1030 course, but it is useful to put them in header files that might be included
1031 in compilations done with @option{-ansi}.  Alternate predefined macros
1032 such as @code{__unix__} and @code{__vax__} are also available, with or
1033 without @option{-ansi}.
1035 The @option{-ansi} option does not cause non-ISO programs to be
1036 rejected gratuitously.  For that, @option{-pedantic} is required in
1037 addition to @option{-ansi}.  @xref{Warning Options}.
1039 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1040 option is used.  Some header files may notice this macro and refrain
1041 from declaring certain functions or defining certain macros that the
1042 ISO standard doesn't call for; this is to avoid interfering with any
1043 programs that might use these names for other things.
1045 Functions which would normally be built in but do not have semantics
1046 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1047 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1048 built-in functions provided by GCC}, for details of the functions
1049 affected.
1051 @item -std=
1052 @opindex std
1053 Determine the language standard.  This option is currently only
1054 supported when compiling C or C++.  A value for this option must be
1055 provided; possible values are
1057 @table @samp
1058 @item c89
1059 @itemx iso9899:1990
1060 ISO C90 (same as @option{-ansi}).
1062 @item iso9899:199409
1063 ISO C90 as modified in amendment 1.
1065 @item c99
1066 @itemx c9x
1067 @itemx iso9899:1999
1068 @itemx iso9899:199x
1069 ISO C99.  Note that this standard is not yet fully supported; see
1070 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1071 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1073 @item gnu89
1074 Default, ISO C90 plus GNU extensions (including some C99 features).
1076 @item gnu99
1077 @itemx gnu9x
1078 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1079 this will become the default.  The name @samp{gnu9x} is deprecated.
1081 @item c++98
1082 The 1998 ISO C++ standard plus amendments.
1084 @item gnu++98
1085 The same as @option{-std=c++98} plus GNU extensions.  This is the
1086 default for C++ code.
1087 @end table
1089 Even when this option is not specified, you can still use some of the
1090 features of newer standards in so far as they do not conflict with
1091 previous C standards.  For example, you may use @code{__restrict__} even
1092 when @option{-std=c99} is not specified.
1094 The @option{-std} options specifying some version of ISO C have the same
1095 effects as @option{-ansi}, except that features that were not in ISO C90
1096 but are in the specified version (for example, @samp{//} comments and
1097 the @code{inline} keyword in ISO C99) are not disabled.
1099 @xref{Standards,,Language Standards Supported by GCC}, for details of
1100 these standard versions.
1102 @item -aux-info @var{filename}
1103 @opindex aux-info
1104 Output to the given filename prototyped declarations for all functions
1105 declared and/or defined in a translation unit, including those in header
1106 files.  This option is silently ignored in any language other than C@.
1108 Besides declarations, the file indicates, in comments, the origin of
1109 each declaration (source file and line), whether the declaration was
1110 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1111 @samp{O} for old, respectively, in the first character after the line
1112 number and the colon), and whether it came from a declaration or a
1113 definition (@samp{C} or @samp{F}, respectively, in the following
1114 character).  In the case of function definitions, a K&R-style list of
1115 arguments followed by their declarations is also provided, inside
1116 comments, after the declaration.
1118 @item -fno-asm
1119 @opindex fno-asm
1120 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1121 keyword, so that code can use these words as identifiers.  You can use
1122 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1123 instead.  @option{-ansi} implies @option{-fno-asm}.
1125 In C++, this switch only affects the @code{typeof} keyword, since
1126 @code{asm} and @code{inline} are standard keywords.  You may want to
1127 use the @option{-fno-gnu-keywords} flag instead, which has the same
1128 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1129 switch only affects the @code{asm} and @code{typeof} keywords, since
1130 @code{inline} is a standard keyword in ISO C99.
1132 @item -fno-builtin
1133 @itemx -fno-builtin-@var{function}
1134 @opindex fno-builtin
1135 @cindex built-in functions
1136 Don't recognize built-in functions that do not begin with
1137 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1138 functions provided by GCC}, for details of the functions affected,
1139 including those which are not built-in functions when @option{-ansi} or
1140 @option{-std} options for strict ISO C conformance are used because they
1141 do not have an ISO standard meaning.
1143 GCC normally generates special code to handle certain built-in functions
1144 more efficiently; for instance, calls to @code{alloca} may become single
1145 instructions that adjust the stack directly, and calls to @code{memcpy}
1146 may become inline copy loops.  The resulting code is often both smaller
1147 and faster, but since the function calls no longer appear as such, you
1148 cannot set a breakpoint on those calls, nor can you change the behavior
1149 of the functions by linking with a different library.
1151 With the @option{-fno-builtin-@var{function}} option
1152 only the built-in function @var{function} is
1153 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1154 function is named this is not built-in in this version of GCC, this
1155 option is ignored.  There is no corresponding
1156 @option{-fbuiltin-@var{function}} option; if you wish to enable
1157 built-in functions selectively when using @option{-fno-builtin} or
1158 @option{-ffreestanding}, you may define macros such as:
1160 @smallexample
1161 #define abs(n)          __builtin_abs ((n))
1162 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1163 @end smallexample
1165 @item -fhosted
1166 @opindex fhosted
1167 @cindex hosted environment
1169 Assert that compilation takes place in a hosted environment.  This implies
1170 @option{-fbuiltin}.  A hosted environment is one in which the
1171 entire standard library is available, and in which @code{main} has a return
1172 type of @code{int}.  Examples are nearly everything except a kernel.
1173 This is equivalent to @option{-fno-freestanding}.
1175 @item -ffreestanding
1176 @opindex ffreestanding
1177 @cindex hosted environment
1179 Assert that compilation takes place in a freestanding environment.  This
1180 implies @option{-fno-builtin}.  A freestanding environment
1181 is one in which the standard library may not exist, and program startup may
1182 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1183 This is equivalent to @option{-fno-hosted}.
1185 @xref{Standards,,Language Standards Supported by GCC}, for details of
1186 freestanding and hosted environments.
1188 @item -fms-extensions
1189 @opindex fms-extensions
1190 Accept some non-standard constructs used in Microsoft header files.
1192 @item -trigraphs
1193 @opindex trigraphs
1194 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1195 options for strict ISO C conformance) implies @option{-trigraphs}.
1197 @item -no-integrated-cpp
1198 @opindex no-integrated-cpp
1199 Performs a compilation in two passes: preprocessing and compiling.  This
1200 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1201 @option{-B} option. The user supplied compilation step can then add in
1202 an additional preprocessing step after normal preprocessing but before
1203 compiling. The default is to use the integrated cpp (internal cpp)
1205 The semantics of this option will change if "cc1", "cc1plus", and
1206 "cc1obj" are merged.
1208 @cindex traditional C language
1209 @cindex C language, traditional
1210 @item -traditional
1211 @itemx -traditional-cpp
1212 @opindex traditional-cpp
1213 @opindex traditional
1214 Formerly, these options caused GCC to attempt to emulate a pre-standard
1215 C compiler.  They are now only supported with the @option{-E} switch.
1216 The preprocessor continues to support a pre-standard mode.  See the GNU
1217 CPP manual for details.
1219 @item -fcond-mismatch
1220 @opindex fcond-mismatch
1221 Allow conditional expressions with mismatched types in the second and
1222 third arguments.  The value of such an expression is void.  This option
1223 is not supported for C++.
1225 @item -funsigned-char
1226 @opindex funsigned-char
1227 Let the type @code{char} be unsigned, like @code{unsigned char}.
1229 Each kind of machine has a default for what @code{char} should
1230 be.  It is either like @code{unsigned char} by default or like
1231 @code{signed char} by default.
1233 Ideally, a portable program should always use @code{signed char} or
1234 @code{unsigned char} when it depends on the signedness of an object.
1235 But many programs have been written to use plain @code{char} and
1236 expect it to be signed, or expect it to be unsigned, depending on the
1237 machines they were written for.  This option, and its inverse, let you
1238 make such a program work with the opposite default.
1240 The type @code{char} is always a distinct type from each of
1241 @code{signed char} or @code{unsigned char}, even though its behavior
1242 is always just like one of those two.
1244 @item -fsigned-char
1245 @opindex fsigned-char
1246 Let the type @code{char} be signed, like @code{signed char}.
1248 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1249 the negative form of @option{-funsigned-char}.  Likewise, the option
1250 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1252 @item -fsigned-bitfields
1253 @itemx -funsigned-bitfields
1254 @itemx -fno-signed-bitfields
1255 @itemx -fno-unsigned-bitfields
1256 @opindex fsigned-bitfields
1257 @opindex funsigned-bitfields
1258 @opindex fno-signed-bitfields
1259 @opindex fno-unsigned-bitfields
1260 These options control whether a bit-field is signed or unsigned, when the
1261 declaration does not use either @code{signed} or @code{unsigned}.  By
1262 default, such a bit-field is signed, because this is consistent: the
1263 basic integer types such as @code{int} are signed types.
1264 @end table
1266 @node C++ Dialect Options
1267 @section Options Controlling C++ Dialect
1269 @cindex compiler options, C++
1270 @cindex C++ options, command line
1271 @cindex options, C++
1272 This section describes the command-line options that are only meaningful
1273 for C++ programs; but you can also use most of the GNU compiler options
1274 regardless of what language your program is in.  For example, you
1275 might compile a file @code{firstClass.C} like this:
1277 @smallexample
1278 g++ -g -frepo -O -c firstClass.C
1279 @end smallexample
1281 @noindent
1282 In this example, only @option{-frepo} is an option meant
1283 only for C++ programs; you can use the other options with any
1284 language supported by GCC@.
1286 Here is a list of options that are @emph{only} for compiling C++ programs:
1288 @table @gcctabopt
1290 @item -fabi-version=@var{n}
1291 @opindex fabi-version
1292 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1293 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1294 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1295 the version that conforms most closely to the C++ ABI specification.
1296 Therefore, the ABI obtained using version 0 will change as ABI bugs
1297 are fixed.
1299 The default is version 2.
1301 @item -fno-access-control
1302 @opindex fno-access-control
1303 Turn off all access checking.  This switch is mainly useful for working
1304 around bugs in the access control code.
1306 @item -fcheck-new
1307 @opindex fcheck-new
1308 Check that the pointer returned by @code{operator new} is non-null
1309 before attempting to modify the storage allocated.  This check is
1310 normally unnecessary because the C++ standard specifies that
1311 @code{operator new} will only return @code{0} if it is declared
1312 @samp{throw()}, in which case the compiler will always check the
1313 return value even without this option.  In all other cases, when
1314 @code{operator new} has a non-empty exception specification, memory
1315 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1316 @samp{new (nothrow)}.
1318 @item -fconserve-space
1319 @opindex fconserve-space
1320 Put uninitialized or runtime-initialized global variables into the
1321 common segment, as C does.  This saves space in the executable at the
1322 cost of not diagnosing duplicate definitions.  If you compile with this
1323 flag and your program mysteriously crashes after @code{main()} has
1324 completed, you may have an object that is being destroyed twice because
1325 two definitions were merged.
1327 This option is no longer useful on most targets, now that support has
1328 been added for putting variables into BSS without making them common.
1330 @item -fno-const-strings
1331 @opindex fno-const-strings
1332 Give string constants type @code{char *} instead of type @code{const
1333 char *}.  By default, G++ uses type @code{const char *} as required by
1334 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1335 actually modify the value of a string constant.
1337 This option might be removed in a future release of G++.  For maximum
1338 portability, you should structure your code so that it works with
1339 string constants that have type @code{const char *}.
1341 @item -fno-elide-constructors
1342 @opindex fno-elide-constructors
1343 The C++ standard allows an implementation to omit creating a temporary
1344 which is only used to initialize another object of the same type.
1345 Specifying this option disables that optimization, and forces G++ to
1346 call the copy constructor in all cases.
1348 @item -fno-enforce-eh-specs
1349 @opindex fno-enforce-eh-specs
1350 Don't check for violation of exception specifications at runtime.  This
1351 option violates the C++ standard, but may be useful for reducing code
1352 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1353 will still optimize based on the exception specifications.
1355 @item -ffor-scope
1356 @itemx -fno-for-scope
1357 @opindex ffor-scope
1358 @opindex fno-for-scope
1359 If @option{-ffor-scope} is specified, the scope of variables declared in
1360 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1361 as specified by the C++ standard.
1362 If @option{-fno-for-scope} is specified, the scope of variables declared in
1363 a @i{for-init-statement} extends to the end of the enclosing scope,
1364 as was the case in old versions of G++, and other (traditional)
1365 implementations of C++.
1367 The default if neither flag is given to follow the standard,
1368 but to allow and give a warning for old-style code that would
1369 otherwise be invalid, or have different behavior.
1371 @item -fno-gnu-keywords
1372 @opindex fno-gnu-keywords
1373 Do not recognize @code{typeof} as a keyword, so that code can use this
1374 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1375 @option{-ansi} implies @option{-fno-gnu-keywords}.
1377 @item -fno-implicit-templates
1378 @opindex fno-implicit-templates
1379 Never emit code for non-inline templates which are instantiated
1380 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1381 @xref{Template Instantiation}, for more information.
1383 @item -fno-implicit-inline-templates
1384 @opindex fno-implicit-inline-templates
1385 Don't emit code for implicit instantiations of inline templates, either.
1386 The default is to handle inlines differently so that compiles with and
1387 without optimization will need the same set of explicit instantiations.
1389 @item -fno-implement-inlines
1390 @opindex fno-implement-inlines
1391 To save space, do not emit out-of-line copies of inline functions
1392 controlled by @samp{#pragma implementation}.  This will cause linker
1393 errors if these functions are not inlined everywhere they are called.
1395 @item -fms-extensions
1396 @opindex fms-extensions
1397 Disable pedantic warnings about constructs used in MFC, such as implicit
1398 int and getting a pointer to member function via non-standard syntax.
1400 @item -fno-nonansi-builtins
1401 @opindex fno-nonansi-builtins
1402 Disable built-in declarations of functions that are not mandated by
1403 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1404 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1406 @item -fno-operator-names
1407 @opindex fno-operator-names
1408 Do not treat the operator name keywords @code{and}, @code{bitand},
1409 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1410 synonyms as keywords.
1412 @item -fno-optional-diags
1413 @opindex fno-optional-diags
1414 Disable diagnostics that the standard says a compiler does not need to
1415 issue.  Currently, the only such diagnostic issued by G++ is the one for
1416 a name having multiple meanings within a class.
1418 @item -fpermissive
1419 @opindex fpermissive
1420 Downgrade some diagnostics about nonconformant code from errors to
1421 warnings.  Thus, using @option{-fpermissive} will allow some
1422 nonconforming code to compile.
1424 @item -frepo
1425 @opindex frepo
1426 Enable automatic template instantiation at link time.  This option also
1427 implies @option{-fno-implicit-templates}.  @xref{Template
1428 Instantiation}, for more information.
1430 @item -fno-rtti
1431 @opindex fno-rtti
1432 Disable generation of information about every class with virtual
1433 functions for use by the C++ runtime type identification features
1434 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1435 of the language, you can save some space by using this flag.  Note that
1436 exception handling uses the same information, but it will generate it as
1437 needed.
1439 @item -fstats
1440 @opindex fstats
1441 Emit statistics about front-end processing at the end of the compilation.
1442 This information is generally only useful to the G++ development team.
1444 @item -ftemplate-depth-@var{n}
1445 @opindex ftemplate-depth
1446 Set the maximum instantiation depth for template classes to @var{n}.
1447 A limit on the template instantiation depth is needed to detect
1448 endless recursions during template class instantiation.  ANSI/ISO C++
1449 conforming programs must not rely on a maximum depth greater than 17.
1451 @item -fuse-cxa-atexit
1452 @opindex fuse-cxa-atexit
1453 Register destructors for objects with static storage duration with the
1454 @code{__cxa_atexit} function rather than the @code{atexit} function.
1455 This option is required for fully standards-compliant handling of static
1456 destructors, but will only work if your C library supports
1457 @code{__cxa_atexit}.
1459 @item -fno-weak
1460 @opindex fno-weak
1461 Do not use weak symbol support, even if it is provided by the linker.
1462 By default, G++ will use weak symbols if they are available.  This
1463 option exists only for testing, and should not be used by end-users;
1464 it will result in inferior code and has no benefits.  This option may
1465 be removed in a future release of G++.
1467 @item -nostdinc++
1468 @opindex nostdinc++
1469 Do not search for header files in the standard directories specific to
1470 C++, but do still search the other standard directories.  (This option
1471 is used when building the C++ library.)
1472 @end table
1474 In addition, these optimization, warning, and code generation options
1475 have meanings only for C++ programs:
1477 @table @gcctabopt
1478 @item -fno-default-inline
1479 @opindex fno-default-inline
1480 Do not assume @samp{inline} for functions defined inside a class scope.
1481 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1482 functions will have linkage like inline functions; they just won't be
1483 inlined by default.
1485 @item -Wabi @r{(C++ only)}
1486 @opindex Wabi
1487 Warn when G++ generates code that is probably not compatible with the
1488 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1489 all such cases, there are probably some cases that are not warned about,
1490 even though G++ is generating incompatible code.  There may also be
1491 cases where warnings are emitted even though the code that is generated
1492 will be compatible.
1494 You should rewrite your code to avoid these warnings if you are
1495 concerned about the fact that code generated by G++ may not be binary
1496 compatible with code generated by other compilers.
1498 The known incompatibilities at this point include:
1500 @itemize @bullet
1502 @item
1503 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1504 pack data into the same byte as a base class.  For example:
1506 @smallexample
1507 struct A @{ virtual void f(); int f1 : 1; @};
1508 struct B : public A @{ int f2 : 1; @};
1509 @end smallexample
1511 @noindent
1512 In this case, G++ will place @code{B::f2} into the same byte
1513 as@code{A::f1}; other compilers will not.  You can avoid this problem
1514 by explicitly padding @code{A} so that its size is a multiple of the
1515 byte size on your platform; that will cause G++ and other compilers to
1516 layout @code{B} identically.
1518 @item
1519 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1520 tail padding when laying out virtual bases.  For example:
1522 @smallexample
1523 struct A @{ virtual void f(); char c1; @};
1524 struct B @{ B(); char c2; @};
1525 struct C : public A, public virtual B @{@};
1526 @end smallexample
1528 @noindent
1529 In this case, G++ will not place @code{B} into the tail-padding for
1530 @code{A}; other compilers will.  You can avoid this problem by
1531 explicitly padding @code{A} so that its size is a multiple of its
1532 alignment (ignoring virtual base classes); that will cause G++ and other
1533 compilers to layout @code{C} identically.
1535 @item
1536 Incorrect handling of bit-fields with declared widths greater than that
1537 of their underlying types, when the bit-fields appear in a union.  For
1538 example:
1540 @smallexample
1541 union U @{ int i : 4096; @};
1542 @end smallexample
1544 @noindent
1545 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1546 union too small by the number of bits in an @code{int}.
1548 @item
1549 Empty classes can be placed at incorrect offsets.  For example:
1551 @smallexample
1552 struct A @{@};
1554 struct B @{
1555   A a;
1556   virtual void f ();
1559 struct C : public B, public A @{@};
1560 @end smallexample
1562 @noindent
1563 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1564 it should be placed at offset zero.  G++ mistakenly believes that the
1565 @code{A} data member of @code{B} is already at offset zero.
1567 @item
1568 Names of template functions whose types involve @code{typename} or
1569 template template parameters can be mangled incorrectly.
1571 @smallexample
1572 template <typename Q>
1573 void f(typename Q::X) @{@}
1575 template <template <typename> class Q>
1576 void f(typename Q<int>::X) @{@}
1577 @end smallexample
1579 @noindent
1580 Instantiations of these templates may be mangled incorrectly.
1582 @end itemize
1584 @item -Wctor-dtor-privacy @r{(C++ only)}
1585 @opindex Wctor-dtor-privacy
1586 Warn when a class seems unusable because all the constructors or
1587 destructors in that class are private, and it has neither friends nor
1588 public static member functions.
1590 @item -Wnon-virtual-dtor @r{(C++ only)}
1591 @opindex Wnon-virtual-dtor
1592 Warn when a class appears to be polymorphic, thereby requiring a virtual
1593 destructor, yet it declares a non-virtual one.
1594 This warning is enabled by @option{-Wall}.
1596 @item -Wreorder @r{(C++ only)}
1597 @opindex Wreorder
1598 @cindex reordering, warning
1599 @cindex warning for reordering of member initializers
1600 Warn when the order of member initializers given in the code does not
1601 match the order in which they must be executed.  For instance:
1603 @smallexample
1604 struct A @{
1605   int i;
1606   int j;
1607   A(): j (0), i (1) @{ @}
1609 @end smallexample
1611 The compiler will rearrange the member initializers for @samp{i}
1612 and @samp{j} to match the declaration order of the members, emitting
1613 a warning to that effect.  This warning is enabled by @option{-Wall}.
1614 @end table
1616 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1618 @table @gcctabopt
1619 @item -Weffc++ @r{(C++ only)}
1620 @opindex Weffc++
1621 Warn about violations of the following style guidelines from Scott Meyers'
1622 @cite{Effective C++} book:
1624 @itemize @bullet
1625 @item
1626 Item 11:  Define a copy constructor and an assignment operator for classes
1627 with dynamically allocated memory.
1629 @item
1630 Item 12:  Prefer initialization to assignment in constructors.
1632 @item
1633 Item 14:  Make destructors virtual in base classes.
1635 @item
1636 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1638 @item
1639 Item 23:  Don't try to return a reference when you must return an object.
1641 @end itemize
1643 Also warn about violations of the following style guidelines from
1644 Scott Meyers' @cite{More Effective C++} book:
1646 @itemize @bullet
1647 @item
1648 Item 6:  Distinguish between prefix and postfix forms of increment and
1649 decrement operators.
1651 @item
1652 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1654 @end itemize
1656 When selecting this option, be aware that the standard library
1657 headers do not obey all of these guidelines; use @samp{grep -v}
1658 to filter out those warnings.
1660 @item -Wno-deprecated @r{(C++ only)}
1661 @opindex Wno-deprecated
1662 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1664 @item -Wno-non-template-friend @r{(C++ only)}
1665 @opindex Wno-non-template-friend
1666 Disable warnings when non-templatized friend functions are declared
1667 within a template.  Since the advent of explicit template specification
1668 support in G++, if the name of the friend is an unqualified-id (i.e.,
1669 @samp{friend foo(int)}), the C++ language specification demands that the
1670 friend declare or define an ordinary, nontemplate function.  (Section
1671 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1672 could be interpreted as a particular specialization of a templatized
1673 function.  Because this non-conforming behavior is no longer the default
1674 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1675 check existing code for potential trouble spots and is on by default.
1676 This new compiler behavior can be turned off with
1677 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1678 but disables the helpful warning.
1680 @item -Wold-style-cast @r{(C++ only)}
1681 @opindex Wold-style-cast
1682 Warn if an old-style (C-style) cast to a non-void type is used within
1683 a C++ program.  The new-style casts (@samp{static_cast},
1684 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1685 unintended effects and much easier to search for.
1687 @item -Woverloaded-virtual @r{(C++ only)}
1688 @opindex Woverloaded-virtual
1689 @cindex overloaded virtual fn, warning
1690 @cindex warning for overloaded virtual fn
1691 Warn when a function declaration hides virtual functions from a
1692 base class.  For example, in:
1694 @smallexample
1695 struct A @{
1696   virtual void f();
1699 struct B: public A @{
1700   void f(int);
1702 @end smallexample
1704 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1705 like:
1707 @smallexample
1708 B* b;
1709 b->f();
1710 @end smallexample
1712 will fail to compile.
1714 @item -Wno-pmf-conversions @r{(C++ only)}
1715 @opindex Wno-pmf-conversions
1716 Disable the diagnostic for converting a bound pointer to member function
1717 to a plain pointer.
1719 @item -Wsign-promo @r{(C++ only)}
1720 @opindex Wsign-promo
1721 Warn when overload resolution chooses a promotion from unsigned or
1722 enumerated type to a signed type, over a conversion to an unsigned type of
1723 the same size.  Previous versions of G++ would try to preserve
1724 unsignedness, but the standard mandates the current behavior.
1726 @item -Wsynth @r{(C++ only)}
1727 @opindex Wsynth
1728 @cindex warning for synthesized methods
1729 @cindex synthesized methods, warning
1730 Warn when G++'s synthesis behavior does not match that of cfront.  For
1731 instance:
1733 @smallexample
1734 struct A @{
1735   operator int ();
1736   A& operator = (int);
1739 main ()
1741   A a,b;
1742   a = b;
1744 @end smallexample
1746 In this example, G++ will synthesize a default @samp{A& operator =
1747 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1748 @end table
1750 @node Objective-C Dialect Options
1751 @section Options Controlling Objective-C Dialect
1753 @cindex compiler options, Objective-C
1754 @cindex Objective-C options, command line
1755 @cindex options, Objective-C
1756 (NOTE: This manual does not describe the Objective-C language itself.  See
1757 @w{@uref{http://gcc.gnu.org/readings.html}} for references.)
1759 This section describes the command-line options that are only meaningful
1760 for Objective-C programs, but you can also use most of the GNU compiler
1761 options regardless of what language your program is in.  For example,
1762 you might compile a file @code{some_class.m} like this:
1764 @smallexample
1765 gcc -g -fgnu-runtime -O -c some_class.m
1766 @end smallexample
1768 @noindent
1769 In this example, @option{-fgnu-runtime} is an option meant only for
1770 Objective-C programs; you can use the other options with any language
1771 supported by GCC@.
1773 Here is a list of options that are @emph{only} for compiling Objective-C
1774 programs:
1776 @table @gcctabopt
1777 @item -fconstant-string-class=@var{class-name}
1778 @opindex fconstant-string-class
1779 Use @var{class-name} as the name of the class to instantiate for each
1780 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1781 class name is @code{NXConstantString} if the GNU runtime is being used, and
1782 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1783 @option{-fconstant-cfstrings} option, if also present, will override the
1784 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1785 to be laid out as constant CoreFoundation strings.
1787 @item -fgnu-runtime
1788 @opindex fgnu-runtime
1789 Generate object code compatible with the standard GNU Objective-C
1790 runtime.  This is the default for most types of systems.
1792 @item -fnext-runtime
1793 @opindex fnext-runtime
1794 Generate output compatible with the NeXT runtime.  This is the default
1795 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1796 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1797 used.
1799 @item -fno-nil-receivers
1800 @opindex fno-nil-receivers
1801 Assume that all Objective-C message dispatches (e.g.,
1802 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1803 is not @code{nil}.  This allows for more efficient entry points in the runtime to be
1804 used.  Currently, this option is only available in conjunction with
1805 the NeXT runtime on Mac OS X 10.3 and later.
1807 @item -fobjc-exceptions
1808 @opindex fobjc-exceptions
1809 Enable syntactic support for structured exception handling in Objective-C,
1810 similar to what is offered by C++ and Java.  Currently, this option is only
1811 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1813 @smallexample
1814   @@try @{
1815     @dots{}
1816        @@throw expr;
1817     @dots{}
1818   @}
1819   @@catch (AnObjCClass *exc) @{
1820     @dots{}
1821       @@throw expr;
1822     @dots{}
1823       @@throw;
1824     @dots{}
1825   @}
1826   @@catch (AnotherClass *exc) @{
1827     @dots{}
1828   @}
1829   @@catch (id allOthers) @{
1830     @dots{}
1831   @}
1832   @@finally @{
1833     @dots{}
1834       @@throw expr;
1835     @dots{}
1836   @}
1837 @end smallexample
1839 The @code{@@throw} statement may appear anywhere in an Objective-C or
1840 Objective-C++ program; when used inside of a @code{@@catch} block, the
1841 @code{@@throw} may appear without an argument (as shown above), in which case
1842 the object caught by the @code{@@catch} will be rethrown.
1844 Note that only (pointers to) Objective-C objects may be thrown and
1845 caught using this scheme.  When an object is thrown, it will be caught
1846 by the nearest @code{@@catch} clause capable of handling objects of that type,
1847 analogously to how @code{catch} blocks work in C++ and Java.  A
1848 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1849 any and all Objective-C exceptions not caught by previous @code{@@catch}
1850 clauses (if any).
1852 The @code{@@finally} clause, if present, will be executed upon exit from the
1853 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1854 regardless of whether any exceptions are thrown, caught or rethrown
1855 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1856 of the @code{finally} clause in Java.
1858 There are several caveats to using the new exception mechanism:
1860 @itemize @bullet
1861 @item
1862 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1863 idioms provided by the @code{NSException} class, the new
1864 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1865 systems, due to additional functionality needed in the (NeXT) Objective-C
1866 runtime.
1868 @item
1869 As mentioned above, the new exceptions do not support handling
1870 types other than Objective-C objects.   Furthermore, when used from
1871 Objective-C++, the Objective-C exception model does not interoperate with C++
1872 exceptions at this time.  This means you cannot @code{@@throw} an exception
1873 from Objective-C and @code{catch} it in C++, or vice versa
1874 (i.e., @code{throw @dots{} @@catch}).
1875 @end itemize
1877 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1878 blocks for thread-safe execution:
1880 @smallexample
1881   @@synchronized (ObjCClass *guard) @{
1882     @dots{}
1883   @}
1884 @end smallexample
1886 Upon entering the @code{@@synchronized} block, a thread of execution shall
1887 first check whether a lock has been placed on the corresponding @code{guard}
1888 object by another thread.  If it has, the current thread shall wait until
1889 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1890 the current thread will place its own lock on it, execute the code contained in
1891 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1892 making @code{guard} available to other threads).
1894 Unlike Java, Objective-C does not allow for entire methods to be marked
1895 @code{@@synchronized}.  Note that throwing exceptions out of
1896 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1897 to be unlocked properly.
1899 @item -freplace-objc-classes
1900 @opindex freplace-objc-classes
1901 Emit a special marker instructing @command{ld(1)} not to statically link in
1902 the resulting object file, and allow @command{dyld(1)} to load it in at
1903 run time instead.  This is used in conjunction with the Fix-and-Continue
1904 debugging mode, where the object file in question may be recompiled and
1905 dynamically reloaded in the course of program execution, without the need
1906 to restart the program itself.  Currently, Fix-and-Continue functionality
1907 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1908 and later.
1910 @item -fzero-link
1911 @opindex fzero-link
1912 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1913 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1914 compile time) with static class references that get initialized at load time,
1915 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1916 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1917 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1918 for individual class implementations to be modified during program execution.
1920 @item -gen-decls
1921 @opindex gen-decls
1922 Dump interface declarations for all classes seen in the source file to a
1923 file named @file{@var{sourcename}.decl}.
1925 @item -Wno-protocol
1926 @opindex Wno-protocol
1927 If a class is declared to implement a protocol, a warning is issued for
1928 every method in the protocol that is not implemented by the class.  The
1929 default behavior is to issue a warning for every method not explicitly
1930 implemented in the class, even if a method implementation is inherited
1931 from the superclass.  If you use the @code{-Wno-protocol} option, then
1932 methods inherited from the superclass are considered to be implemented,
1933 and no warning is issued for them.
1935 @item -Wselector
1936 @opindex Wselector
1937 Warn if multiple methods of different types for the same selector are
1938 found during compilation.  The check is performed on the list of methods
1939 in the final stage of compilation.  Additionally, a check is performed
1940 for each selector appearing in a @code{@@selector(@dots{})}
1941 expression, and a corresponding method for that selector has been found
1942 during compilation.  Because these checks scan the method table only at
1943 the end of compilation, these warnings are not produced if the final
1944 stage of compilation is not reached, for example because an error is
1945 found during compilation, or because the @code{-fsyntax-only} option is
1946 being used.
1948 @item -Wundeclared-selector
1949 @opindex Wundeclared-selector
1950 Warn if a @code{@@selector(@dots{})} expression referring to an
1951 undeclared selector is found.  A selector is considered undeclared if no
1952 method with that name has been declared before the
1953 @code{@@selector(@dots{})} expression, either explicitly in an
1954 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
1955 an @code{@@implementation} section.  This option always performs its
1956 checks as soon as a @code{@@selector(@dots{})} expression is found,
1957 while @code{-Wselector} only performs its checks in the final stage of
1958 compilation.  This also enforces the coding style convention
1959 that methods and selectors must be declared before being used.
1961 @item -print-objc-runtime-info
1962 @opindex print-objc-runtime-info
1963 Generate C header describing the largest structure that is passed by
1964 value, if any.
1966 @end table
1968 @node Language Independent Options
1969 @section Options to Control Diagnostic Messages Formatting
1970 @cindex options to control diagnostics formatting
1971 @cindex diagnostic messages
1972 @cindex message formatting
1974 Traditionally, diagnostic messages have been formatted irrespective of
1975 the output device's aspect (e.g.@: its width, @dots{}).  The options described
1976 below can be used to control the diagnostic messages formatting
1977 algorithm, e.g.@: how many characters per line, how often source location
1978 information should be reported.  Right now, only the C++ front end can
1979 honor these options.  However it is expected, in the near future, that
1980 the remaining front ends would be able to digest them correctly.
1982 @table @gcctabopt
1983 @item -fmessage-length=@var{n}
1984 @opindex fmessage-length
1985 Try to format error messages so that they fit on lines of about @var{n}
1986 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
1987 the front ends supported by GCC@.  If @var{n} is zero, then no
1988 line-wrapping will be done; each error message will appear on a single
1989 line.
1991 @opindex fdiagnostics-show-location
1992 @item -fdiagnostics-show-location=once
1993 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
1994 reporter to emit @emph{once} source location information; that is, in
1995 case the message is too long to fit on a single physical line and has to
1996 be wrapped, the source location won't be emitted (as prefix) again,
1997 over and over, in subsequent continuation lines.  This is the default
1998 behavior.
2000 @item -fdiagnostics-show-location=every-line
2001 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2002 messages reporter to emit the same source location information (as
2003 prefix) for physical lines that result from the process of breaking
2004 a message which is too long to fit on a single line.
2006 @end table
2008 @node Warning Options
2009 @section Options to Request or Suppress Warnings
2010 @cindex options to control warnings
2011 @cindex warning messages
2012 @cindex messages, warning
2013 @cindex suppressing warnings
2015 Warnings are diagnostic messages that report constructions which
2016 are not inherently erroneous but which are risky or suggest there
2017 may have been an error.
2019 You can request many specific warnings with options beginning @samp{-W},
2020 for example @option{-Wimplicit} to request warnings on implicit
2021 declarations.  Each of these specific warning options also has a
2022 negative form beginning @samp{-Wno-} to turn off warnings;
2023 for example, @option{-Wno-implicit}.  This manual lists only one of the
2024 two forms, whichever is not the default.
2026 The following options control the amount and kinds of warnings produced
2027 by GCC; for further, language-specific options also refer to
2028 @ref{C++ Dialect Options} and @ref{Objective-C Dialect Options}.
2030 @table @gcctabopt
2031 @cindex syntax checking
2032 @item -fsyntax-only
2033 @opindex fsyntax-only
2034 Check the code for syntax errors, but don't do anything beyond that.
2036 @item -pedantic
2037 @opindex pedantic
2038 Issue all the warnings demanded by strict ISO C and ISO C++;
2039 reject all programs that use forbidden extensions, and some other
2040 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2041 version of the ISO C standard specified by any @option{-std} option used.
2043 Valid ISO C and ISO C++ programs should compile properly with or without
2044 this option (though a rare few will require @option{-ansi} or a
2045 @option{-std} option specifying the required version of ISO C)@.  However,
2046 without this option, certain GNU extensions and traditional C and C++
2047 features are supported as well.  With this option, they are rejected.
2049 @option{-pedantic} does not cause warning messages for use of the
2050 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2051 warnings are also disabled in the expression that follows
2052 @code{__extension__}.  However, only system header files should use
2053 these escape routes; application programs should avoid them.
2054 @xref{Alternate Keywords}.
2056 Some users try to use @option{-pedantic} to check programs for strict ISO
2057 C conformance.  They soon find that it does not do quite what they want:
2058 it finds some non-ISO practices, but not all---only those for which
2059 ISO C @emph{requires} a diagnostic, and some others for which
2060 diagnostics have been added.
2062 A feature to report any failure to conform to ISO C might be useful in
2063 some instances, but would require considerable additional work and would
2064 be quite different from @option{-pedantic}.  We don't have plans to
2065 support such a feature in the near future.
2067 Where the standard specified with @option{-std} represents a GNU
2068 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2069 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2070 extended dialect is based.  Warnings from @option{-pedantic} are given
2071 where they are required by the base standard.  (It would not make sense
2072 for such warnings to be given only for features not in the specified GNU
2073 C dialect, since by definition the GNU dialects of C include all
2074 features the compiler supports with the given option, and there would be
2075 nothing to warn about.)
2077 @item -pedantic-errors
2078 @opindex pedantic-errors
2079 Like @option{-pedantic}, except that errors are produced rather than
2080 warnings.
2082 @item -w
2083 @opindex w
2084 Inhibit all warning messages.
2086 @item -Wno-import
2087 @opindex Wno-import
2088 Inhibit warning messages about the use of @samp{#import}.
2090 @item -Wchar-subscripts
2091 @opindex Wchar-subscripts
2092 Warn if an array subscript has type @code{char}.  This is a common cause
2093 of error, as programmers often forget that this type is signed on some
2094 machines.
2096 @item -Wcomment
2097 @opindex Wcomment
2098 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2099 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2101 @item -Wfatal-errors
2102 @opindex Wfatal-errors
2103 This option causes the compiler to abort compilation on the first error
2104 occurred rather than trying to keep going and printing further error
2105 messages.
2107 @item -Wformat
2108 @opindex Wformat
2109 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2110 the arguments supplied have types appropriate to the format string
2111 specified, and that the conversions specified in the format string make
2112 sense.  This includes standard functions, and others specified by format
2113 attributes (@pxref{Function Attributes}), in the @code{printf},
2114 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2115 not in the C standard) families.
2117 The formats are checked against the format features supported by GNU
2118 libc version 2.2.  These include all ISO C90 and C99 features, as well
2119 as features from the Single Unix Specification and some BSD and GNU
2120 extensions.  Other library implementations may not support all these
2121 features; GCC does not support warning about features that go beyond a
2122 particular library's limitations.  However, if @option{-pedantic} is used
2123 with @option{-Wformat}, warnings will be given about format features not
2124 in the selected standard version (but not for @code{strfmon} formats,
2125 since those are not in any version of the C standard).  @xref{C Dialect
2126 Options,,Options Controlling C Dialect}.
2128 Since @option{-Wformat} also checks for null format arguments for
2129 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2131 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2132 aspects of format checking, the options @option{-Wformat-y2k},
2133 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2134 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2135 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2137 @item -Wformat-y2k
2138 @opindex Wformat-y2k
2139 If @option{-Wformat} is specified, also warn about @code{strftime}
2140 formats which may yield only a two-digit year.
2142 @item -Wno-format-extra-args
2143 @opindex Wno-format-extra-args
2144 If @option{-Wformat} is specified, do not warn about excess arguments to a
2145 @code{printf} or @code{scanf} format function.  The C standard specifies
2146 that such arguments are ignored.
2148 Where the unused arguments lie between used arguments that are
2149 specified with @samp{$} operand number specifications, normally
2150 warnings are still given, since the implementation could not know what
2151 type to pass to @code{va_arg} to skip the unused arguments.  However,
2152 in the case of @code{scanf} formats, this option will suppress the
2153 warning if the unused arguments are all pointers, since the Single
2154 Unix Specification says that such unused arguments are allowed.
2156 @item -Wno-format-zero-length
2157 @opindex Wno-format-zero-length
2158 If @option{-Wformat} is specified, do not warn about zero-length formats.
2159 The C standard specifies that zero-length formats are allowed.
2161 @item -Wformat-nonliteral
2162 @opindex Wformat-nonliteral
2163 If @option{-Wformat} is specified, also warn if the format string is not a
2164 string literal and so cannot be checked, unless the format function
2165 takes its format arguments as a @code{va_list}.
2167 @item -Wformat-security
2168 @opindex Wformat-security
2169 If @option{-Wformat} is specified, also warn about uses of format
2170 functions that represent possible security problems.  At present, this
2171 warns about calls to @code{printf} and @code{scanf} functions where the
2172 format string is not a string literal and there are no format arguments,
2173 as in @code{printf (foo);}.  This may be a security hole if the format
2174 string came from untrusted input and contains @samp{%n}.  (This is
2175 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2176 in future warnings may be added to @option{-Wformat-security} that are not
2177 included in @option{-Wformat-nonliteral}.)
2179 @item -Wformat=2
2180 @opindex Wformat=2
2181 Enable @option{-Wformat} plus format checks not included in
2182 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2183 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2185 @item -Wnonnull
2186 @opindex Wnonnull
2187 Warn about passing a null pointer for arguments marked as
2188 requiring a non-null value by the @code{nonnull} function attribute.
2190 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2191 can be disabled with the @option{-Wno-nonnull} option.
2193 @item -Winit-self @r{(C, C++, and Objective-C only)}
2194 @opindex Winit-self
2195 Warn about uninitialized variables which are initialized with themselves.
2196 Note this option can only be used with the @option{-Wuninitialized} option,
2197 which in turn only works with @option{-O1} and above.
2199 For example, GCC will warn about @code{i} being uninitialized in the
2200 following snippet only when @option{-Winit-self} has been specified:
2201 @smallexample
2202 @group
2203 int f()
2205   int i = i;
2206   return i;
2208 @end group
2209 @end smallexample
2211 @item -Wimplicit-int
2212 @opindex Wimplicit-int
2213 Warn when a declaration does not specify a type.
2215 @item -Wimplicit-function-declaration
2216 @itemx -Werror-implicit-function-declaration
2217 @opindex Wimplicit-function-declaration
2218 @opindex Werror-implicit-function-declaration
2219 Give a warning (or error) whenever a function is used before being
2220 declared.
2222 @item -Wimplicit
2223 @opindex Wimplicit
2224 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2226 @item -Wmain
2227 @opindex Wmain
2228 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2229 function with external linkage, returning int, taking either zero
2230 arguments, two, or three arguments of appropriate types.
2232 @item -Wmissing-braces
2233 @opindex Wmissing-braces
2234 Warn if an aggregate or union initializer is not fully bracketed.  In
2235 the following example, the initializer for @samp{a} is not fully
2236 bracketed, but that for @samp{b} is fully bracketed.
2238 @smallexample
2239 int a[2][2] = @{ 0, 1, 2, 3 @};
2240 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2241 @end smallexample
2243 @item -Wmissing-include-dirs @r{(C, C++, and Objective-C only)}
2244 @opindex Wmissing-include-dirs
2245 Warn if a user-supplied include directory does not exist.
2247 @item -Wparentheses
2248 @opindex Wparentheses
2249 Warn if parentheses are omitted in certain contexts, such
2250 as when there is an assignment in a context where a truth value
2251 is expected, or when operators are nested whose precedence people
2252 often get confused about.
2254 Also warn about constructions where there may be confusion to which
2255 @code{if} statement an @code{else} branch belongs.  Here is an example of
2256 such a case:
2258 @smallexample
2259 @group
2261   if (a)
2262     if (b)
2263       foo ();
2264   else
2265     bar ();
2267 @end group
2268 @end smallexample
2270 In C, every @code{else} branch belongs to the innermost possible @code{if}
2271 statement, which in this example is @code{if (b)}.  This is often not
2272 what the programmer expected, as illustrated in the above example by
2273 indentation the programmer chose.  When there is the potential for this
2274 confusion, GCC will issue a warning when this flag is specified.
2275 To eliminate the warning, add explicit braces around the innermost
2276 @code{if} statement so there is no way the @code{else} could belong to
2277 the enclosing @code{if}.  The resulting code would look like this:
2279 @smallexample
2280 @group
2282   if (a)
2283     @{
2284       if (b)
2285         foo ();
2286       else
2287         bar ();
2288     @}
2290 @end group
2291 @end smallexample
2293 @item -Wsequence-point
2294 @opindex Wsequence-point
2295 Warn about code that may have undefined semantics because of violations
2296 of sequence point rules in the C standard.
2298 The C standard defines the order in which expressions in a C program are
2299 evaluated in terms of @dfn{sequence points}, which represent a partial
2300 ordering between the execution of parts of the program: those executed
2301 before the sequence point, and those executed after it.  These occur
2302 after the evaluation of a full expression (one which is not part of a
2303 larger expression), after the evaluation of the first operand of a
2304 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2305 function is called (but after the evaluation of its arguments and the
2306 expression denoting the called function), and in certain other places.
2307 Other than as expressed by the sequence point rules, the order of
2308 evaluation of subexpressions of an expression is not specified.  All
2309 these rules describe only a partial order rather than a total order,
2310 since, for example, if two functions are called within one expression
2311 with no sequence point between them, the order in which the functions
2312 are called is not specified.  However, the standards committee have
2313 ruled that function calls do not overlap.
2315 It is not specified when between sequence points modifications to the
2316 values of objects take effect.  Programs whose behavior depends on this
2317 have undefined behavior; the C standard specifies that ``Between the
2318 previous and next sequence point an object shall have its stored value
2319 modified at most once by the evaluation of an expression.  Furthermore,
2320 the prior value shall be read only to determine the value to be
2321 stored.''.  If a program breaks these rules, the results on any
2322 particular implementation are entirely unpredictable.
2324 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2325 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2326 diagnosed by this option, and it may give an occasional false positive
2327 result, but in general it has been found fairly effective at detecting
2328 this sort of problem in programs.
2330 The present implementation of this option only works for C programs.  A
2331 future implementation may also work for C++ programs.
2333 The C standard is worded confusingly, therefore there is some debate
2334 over the precise meaning of the sequence point rules in subtle cases.
2335 Links to discussions of the problem, including proposed formal
2336 definitions, may be found on the GCC readings page, at
2337 @w{@uref{http://gcc.gnu.org/readings.html}}.
2339 @item -Wreturn-type
2340 @opindex Wreturn-type
2341 Warn whenever a function is defined with a return-type that defaults to
2342 @code{int}.  Also warn about any @code{return} statement with no
2343 return-value in a function whose return-type is not @code{void}.
2345 For C++, a function without return type always produces a diagnostic
2346 message, even when @option{-Wno-return-type} is specified.  The only
2347 exceptions are @samp{main} and functions defined in system headers.
2349 @item -Wswitch
2350 @opindex Wswitch
2351 Warn whenever a @code{switch} statement has an index of enumerated type
2352 and lacks a @code{case} for one or more of the named codes of that
2353 enumeration.  (The presence of a @code{default} label prevents this
2354 warning.)  @code{case} labels outside the enumeration range also
2355 provoke warnings when this option is used.
2357 @item -Wswitch-default
2358 @opindex Wswitch-switch
2359 Warn whenever a @code{switch} statement does not have a @code{default}
2360 case.
2362 @item -Wswitch-enum
2363 @opindex Wswitch-enum
2364 Warn whenever a @code{switch} statement has an index of enumerated type
2365 and lacks a @code{case} for one or more of the named codes of that
2366 enumeration.  @code{case} labels outside the enumeration range also
2367 provoke warnings when this option is used.
2369 @item -Wtrigraphs
2370 @opindex Wtrigraphs
2371 Warn if any trigraphs are encountered that might change the meaning of
2372 the program (trigraphs within comments are not warned about).
2374 @item -Wunused-function
2375 @opindex Wunused-function
2376 Warn whenever a static function is declared but not defined or a
2377 non\-inline static function is unused.
2379 @item -Wunused-label
2380 @opindex Wunused-label
2381 Warn whenever a label is declared but not used.
2383 To suppress this warning use the @samp{unused} attribute
2384 (@pxref{Variable Attributes}).
2386 @item -Wunused-parameter
2387 @opindex Wunused-parameter
2388 Warn whenever a function parameter is unused aside from its declaration.
2390 To suppress this warning use the @samp{unused} attribute
2391 (@pxref{Variable Attributes}).
2393 @item -Wunused-variable
2394 @opindex Wunused-variable
2395 Warn whenever a local variable or non-constant static variable is unused
2396 aside from its declaration
2398 To suppress this warning use the @samp{unused} attribute
2399 (@pxref{Variable Attributes}).
2401 @item -Wunused-value
2402 @opindex Wunused-value
2403 Warn whenever a statement computes a result that is explicitly not used.
2405 To suppress this warning cast the expression to @samp{void}.
2407 @item -Wunused
2408 @opindex Wunused
2409 All the above @option{-Wunused} options combined.
2411 In order to get a warning about an unused function parameter, you must
2412 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2413 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2415 @item -Wuninitialized
2416 @opindex Wuninitialized
2417 Warn if an automatic variable is used without first being initialized or
2418 if a variable may be clobbered by a @code{setjmp} call.
2420 These warnings are possible only in optimizing compilation,
2421 because they require data flow information that is computed only
2422 when optimizing.  If you don't specify @option{-O}, you simply won't
2423 get these warnings.
2425 If you want to warn about code which uses the uninitialized value of the
2426 variable in its own initializer, use the @option{-Winit-self} option.
2428 These warnings occur only for variables that are candidates for
2429 register allocation.  Therefore, they do not occur for a variable that
2430 is declared @code{volatile}, or whose address is taken, or whose size
2431 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2432 structures, unions or arrays, even when they are in registers.
2434 Note that there may be no warning about a variable that is used only
2435 to compute a value that itself is never used, because such
2436 computations may be deleted by data flow analysis before the warnings
2437 are printed.
2439 These warnings are made optional because GCC is not smart
2440 enough to see all the reasons why the code might be correct
2441 despite appearing to have an error.  Here is one example of how
2442 this can happen:
2444 @smallexample
2445 @group
2447   int x;
2448   switch (y)
2449     @{
2450     case 1: x = 1;
2451       break;
2452     case 2: x = 4;
2453       break;
2454     case 3: x = 5;
2455     @}
2456   foo (x);
2458 @end group
2459 @end smallexample
2461 @noindent
2462 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2463 always initialized, but GCC doesn't know this.  Here is
2464 another common case:
2466 @smallexample
2468   int save_y;
2469   if (change_y) save_y = y, y = new_y;
2470   @dots{}
2471   if (change_y) y = save_y;
2473 @end smallexample
2475 @noindent
2476 This has no bug because @code{save_y} is used only if it is set.
2478 @cindex @code{longjmp} warnings
2479 This option also warns when a non-volatile automatic variable might be
2480 changed by a call to @code{longjmp}.  These warnings as well are possible
2481 only in optimizing compilation.
2483 The compiler sees only the calls to @code{setjmp}.  It cannot know
2484 where @code{longjmp} will be called; in fact, a signal handler could
2485 call it at any point in the code.  As a result, you may get a warning
2486 even when there is in fact no problem because @code{longjmp} cannot
2487 in fact be called at the place which would cause a problem.
2489 Some spurious warnings can be avoided if you declare all the functions
2490 you use that never return as @code{noreturn}.  @xref{Function
2491 Attributes}.
2493 @item -Wunknown-pragmas
2494 @opindex Wunknown-pragmas
2495 @cindex warning for unknown pragmas
2496 @cindex unknown pragmas, warning
2497 @cindex pragmas, warning of unknown
2498 Warn when a #pragma directive is encountered which is not understood by
2499 GCC@.  If this command line option is used, warnings will even be issued
2500 for unknown pragmas in system header files.  This is not the case if
2501 the warnings were only enabled by the @option{-Wall} command line option.
2503 @item -Wstrict-aliasing
2504 @opindex Wstrict-aliasing
2505 This option is only active when @option{-fstrict-aliasing} is active.
2506 It warns about code which might break the strict aliasing rules that the
2507 compiler is using for optimization. The warning does not catch all
2508 cases, but does attempt to catch the more common pitfalls. It is
2509 included in @option{-Wall}.
2511 @item -Wstrict-aliasing=2
2512 @opindex Wstrict-aliasing=2
2513 This option is only active when @option{-fstrict-aliasing} is active.
2514 It warns about all code which might break the strict aliasing rules that the
2515 compiler is using for optimization.  This warning catches all cases, but
2516 it will also give a warning for some ambiguous cases that are safe.
2518 @item -Wall
2519 @opindex Wall
2520 All of the above @samp{-W} options combined.  This enables all the
2521 warnings about constructions that some users consider questionable, and
2522 that are easy to avoid (or modify to prevent the warning), even in
2523 conjunction with macros.  This also enables some language-specific
2524 warnings described in @ref{C++ Dialect Options} and
2525 @ref{Objective-C Dialect Options}.
2526 @end table
2528 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2529 Some of them warn about constructions that users generally do not
2530 consider questionable, but which occasionally you might wish to check
2531 for; others warn about constructions that are necessary or hard to avoid
2532 in some cases, and there is no simple way to modify the code to suppress
2533 the warning.
2535 @table @gcctabopt
2536 @item -Wextra
2537 @opindex W
2538 @opindex Wextra
2539 (This option used to be called @option{-W}.  The older name is still
2540 supported, but the newer name is more descriptive.)  Print extra warning
2541 messages for these events:
2543 @itemize @bullet
2544 @item
2545 A function can return either with or without a value.  (Falling
2546 off the end of the function body is considered returning without
2547 a value.)  For example, this function would evoke such a
2548 warning:
2550 @smallexample
2551 @group
2552 foo (a)
2554   if (a > 0)
2555     return a;
2557 @end group
2558 @end smallexample
2560 @item
2561 An expression-statement or the left-hand side of a comma expression
2562 contains no side effects.
2563 To suppress the warning, cast the unused expression to void.
2564 For example, an expression such as @samp{x[i,j]} will cause a warning,
2565 but @samp{x[(void)i,j]} will not.
2567 @item
2568 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2570 @item
2571 A comparison like @samp{x<=y<=z} appears; this is equivalent to
2572 @samp{(x<=y ? 1 : 0) <= z}, which is a different interpretation from
2573 that of ordinary mathematical notation.
2575 @item
2576 Storage-class specifiers like @code{static} are not the first things in
2577 a declaration.  According to the C Standard, this usage is obsolescent.
2579 @item
2580 The return type of a function has a type qualifier such as @code{const}.
2581 Such a type qualifier has no effect, since the value returned by a
2582 function is not an lvalue.  (But don't warn about the GNU extension of
2583 @code{volatile void} return types.  That extension will be warned about
2584 if @option{-pedantic} is specified.)
2586 @item
2587 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2588 arguments.
2590 @item
2591 A comparison between signed and unsigned values could produce an
2592 incorrect result when the signed value is converted to unsigned.
2593 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2595 @item
2596 An aggregate has an initializer which does not initialize all members.
2597 For example, the following code would cause such a warning, because
2598 @code{x.h} would be implicitly initialized to zero:
2600 @smallexample
2601 struct s @{ int f, g, h; @};
2602 struct s x = @{ 3, 4 @};
2603 @end smallexample
2605 @item
2606 A function parameter is declared without a type specifier in K&R-style
2607 functions:
2609 @smallexample
2610 void foo(bar) @{ @}
2611 @end smallexample
2613 @item
2614 An empty body occurs in an @samp{if} or @samp{else} statement.
2616 @item
2617 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2618 @samp{>}, or @samp{>=}.
2620 @item
2621 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2623 @item
2624 Any of several floating-point events that often indicate errors, such as
2625 overflow, underflow, loss of precision, etc.
2627 @item @r{(C++ only)}
2628 An enumerator and a non-enumerator both appear in a conditional expression.
2630 @item @r{(C++ only)}
2631 A non-static reference or non-static @samp{const} member appears in a
2632 class without constructors.
2634 @item @r{(C++ only)}
2635 Ambiguous virtual bases.
2637 @item @r{(C++ only)}
2638 Subscripting an array which has been declared @samp{register}.
2640 @item @r{(C++ only)}
2641 Taking the address of a variable which has been declared @samp{register}.
2643 @item @r{(C++ only)}
2644 A base class is not initialized in a derived class' copy constructor.
2645 @end itemize
2647 @item -Wno-div-by-zero
2648 @opindex Wno-div-by-zero
2649 @opindex Wdiv-by-zero
2650 Do not warn about compile-time integer division by zero.  Floating point
2651 division by zero is not warned about, as it can be a legitimate way of
2652 obtaining infinities and NaNs.
2654 @item -Wsystem-headers
2655 @opindex Wsystem-headers
2656 @cindex warnings from system headers
2657 @cindex system headers, warnings from
2658 Print warning messages for constructs found in system header files.
2659 Warnings from system headers are normally suppressed, on the assumption
2660 that they usually do not indicate real problems and would only make the
2661 compiler output harder to read.  Using this command line option tells
2662 GCC to emit warnings from system headers as if they occurred in user
2663 code.  However, note that using @option{-Wall} in conjunction with this
2664 option will @emph{not} warn about unknown pragmas in system
2665 headers---for that, @option{-Wunknown-pragmas} must also be used.
2667 @item -Wfloat-equal
2668 @opindex Wfloat-equal
2669 Warn if floating point values are used in equality comparisons.
2671 The idea behind this is that sometimes it is convenient (for the
2672 programmer) to consider floating-point values as approximations to
2673 infinitely precise real numbers.  If you are doing this, then you need
2674 to compute (by analyzing the code, or in some other way) the maximum or
2675 likely maximum error that the computation introduces, and allow for it
2676 when performing comparisons (and when producing output, but that's a
2677 different problem).  In particular, instead of testing for equality, you
2678 would check to see whether the two values have ranges that overlap; and
2679 this is done with the relational operators, so equality comparisons are
2680 probably mistaken.
2682 @item -Wtraditional @r{(C only)}
2683 @opindex Wtraditional
2684 Warn about certain constructs that behave differently in traditional and
2685 ISO C@.  Also warn about ISO C constructs that have no traditional C
2686 equivalent, and/or problematic constructs which should be avoided.
2688 @itemize @bullet
2689 @item
2690 Macro parameters that appear within string literals in the macro body.
2691 In traditional C macro replacement takes place within string literals,
2692 but does not in ISO C@.
2694 @item
2695 In traditional C, some preprocessor directives did not exist.
2696 Traditional preprocessors would only consider a line to be a directive
2697 if the @samp{#} appeared in column 1 on the line.  Therefore
2698 @option{-Wtraditional} warns about directives that traditional C
2699 understands but would ignore because the @samp{#} does not appear as the
2700 first character on the line.  It also suggests you hide directives like
2701 @samp{#pragma} not understood by traditional C by indenting them.  Some
2702 traditional implementations would not recognize @samp{#elif}, so it
2703 suggests avoiding it altogether.
2705 @item
2706 A function-like macro that appears without arguments.
2708 @item
2709 The unary plus operator.
2711 @item
2712 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2713 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2714 constants.)  Note, these suffixes appear in macros defined in the system
2715 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2716 Use of these macros in user code might normally lead to spurious
2717 warnings, however GCC's integrated preprocessor has enough context to
2718 avoid warning in these cases.
2720 @item
2721 A function declared external in one block and then used after the end of
2722 the block.
2724 @item
2725 A @code{switch} statement has an operand of type @code{long}.
2727 @item
2728 A non-@code{static} function declaration follows a @code{static} one.
2729 This construct is not accepted by some traditional C compilers.
2731 @item
2732 The ISO type of an integer constant has a different width or
2733 signedness from its traditional type.  This warning is only issued if
2734 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2735 typically represent bit patterns, are not warned about.
2737 @item
2738 Usage of ISO string concatenation is detected.
2740 @item
2741 Initialization of automatic aggregates.
2743 @item
2744 Identifier conflicts with labels.  Traditional C lacks a separate
2745 namespace for labels.
2747 @item
2748 Initialization of unions.  If the initializer is zero, the warning is
2749 omitted.  This is done under the assumption that the zero initializer in
2750 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2751 initializer warnings and relies on default initialization to zero in the
2752 traditional C case.
2754 @item
2755 Conversions by prototypes between fixed/floating point values and vice
2756 versa.  The absence of these prototypes when compiling with traditional
2757 C would cause serious problems.  This is a subset of the possible
2758 conversion warnings, for the full set use @option{-Wconversion}.
2760 @item
2761 Use of ISO C style function definitions.  This warning intentionally is
2762 @emph{not} issued for prototype declarations or variadic functions
2763 because these ISO C features will appear in your code when using
2764 libiberty's traditional C compatibility macros, @code{PARAMS} and
2765 @code{VPARAMS}.  This warning is also bypassed for nested functions
2766 because that feature is already a GCC extension and thus not relevant to
2767 traditional C compatibility.
2768 @end itemize
2770 @item -Wdeclaration-after-statement @r{(C only)}
2771 @opindex Wdeclaration-after-statement
2772 Warn when a declaration is found after a statement in a block.  This
2773 construct, known from C++, was introduced with ISO C99 and is by default
2774 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2775 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2777 @item -Wundef
2778 @opindex Wundef
2779 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2781 @item -Wendif-labels
2782 @opindex Wendif-labels
2783 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2785 @item -Wshadow
2786 @opindex Wshadow
2787 Warn whenever a local variable shadows another local variable, parameter or
2788 global variable or whenever a built-in function is shadowed.
2790 @item -Wlarger-than-@var{len}
2791 @opindex Wlarger-than
2792 Warn whenever an object of larger than @var{len} bytes is defined.
2794 @item -Wpointer-arith
2795 @opindex Wpointer-arith
2796 Warn about anything that depends on the ``size of'' a function type or
2797 of @code{void}.  GNU C assigns these types a size of 1, for
2798 convenience in calculations with @code{void *} pointers and pointers
2799 to functions.
2801 @item -Wbad-function-cast @r{(C only)}
2802 @opindex Wbad-function-cast
2803 Warn whenever a function call is cast to a non-matching type.
2804 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2806 @item -Wcast-qual
2807 @opindex Wcast-qual
2808 Warn whenever a pointer is cast so as to remove a type qualifier from
2809 the target type.  For example, warn if a @code{const char *} is cast
2810 to an ordinary @code{char *}.
2812 @item -Wcast-align
2813 @opindex Wcast-align
2814 Warn whenever a pointer is cast such that the required alignment of the
2815 target is increased.  For example, warn if a @code{char *} is cast to
2816 an @code{int *} on machines where integers can only be accessed at
2817 two- or four-byte boundaries.
2819 @item -Wwrite-strings
2820 @opindex Wwrite-strings
2821 When compiling C, give string constants the type @code{const
2822 char[@var{length}]} so that
2823 copying the address of one into a non-@code{const} @code{char *}
2824 pointer will get a warning; when compiling C++, warn about the
2825 deprecated conversion from string constants to @code{char *}.
2826 These warnings will help you find at
2827 compile time code that can try to write into a string constant, but
2828 only if you have been very careful about using @code{const} in
2829 declarations and prototypes.  Otherwise, it will just be a nuisance;
2830 this is why we did not make @option{-Wall} request these warnings.
2832 @item -Wconversion
2833 @opindex Wconversion
2834 Warn if a prototype causes a type conversion that is different from what
2835 would happen to the same argument in the absence of a prototype.  This
2836 includes conversions of fixed point to floating and vice versa, and
2837 conversions changing the width or signedness of a fixed point argument
2838 except when the same as the default promotion.
2840 Also, warn if a negative integer constant expression is implicitly
2841 converted to an unsigned type.  For example, warn about the assignment
2842 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2843 casts like @code{(unsigned) -1}.
2845 @item -Wsign-compare
2846 @opindex Wsign-compare
2847 @cindex warning for comparison of signed and unsigned values
2848 @cindex comparison of signed and unsigned values, warning
2849 @cindex signed and unsigned values, comparison warning
2850 Warn when a comparison between signed and unsigned values could produce
2851 an incorrect result when the signed value is converted to unsigned.
2852 This warning is also enabled by @option{-Wextra}; to get the other warnings
2853 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2855 @item -Waggregate-return
2856 @opindex Waggregate-return
2857 Warn if any functions that return structures or unions are defined or
2858 called.  (In languages where you can return an array, this also elicits
2859 a warning.)
2861 @item -Wstrict-prototypes @r{(C only)}
2862 @opindex Wstrict-prototypes
2863 Warn if a function is declared or defined without specifying the
2864 argument types.  (An old-style function definition is permitted without
2865 a warning if preceded by a declaration which specifies the argument
2866 types.)
2868 @item -Wold-style-definition @r{(C only)}
2869 @opindex Wold-style-definition
2870 Warn if an old-style function definition is used.  A warning is given
2871 even if there is a previous prototype.
2873 @item -Wmissing-prototypes @r{(C only)}
2874 @opindex Wmissing-prototypes
2875 Warn if a global function is defined without a previous prototype
2876 declaration.  This warning is issued even if the definition itself
2877 provides a prototype.  The aim is to detect global functions that fail
2878 to be declared in header files.
2880 @item -Wmissing-declarations @r{(C only)}
2881 @opindex Wmissing-declarations
2882 Warn if a global function is defined without a previous declaration.
2883 Do so even if the definition itself provides a prototype.
2884 Use this option to detect global functions that are not declared in
2885 header files.
2887 @item -Wmissing-noreturn
2888 @opindex Wmissing-noreturn
2889 Warn about functions which might be candidates for attribute @code{noreturn}.
2890 Note these are only possible candidates, not absolute ones.  Care should
2891 be taken to manually verify functions actually do not ever return before
2892 adding the @code{noreturn} attribute, otherwise subtle code generation
2893 bugs could be introduced.  You will not get a warning for @code{main} in
2894 hosted C environments.
2896 @item -Wmissing-format-attribute
2897 @opindex Wmissing-format-attribute
2898 @opindex Wformat
2899 If @option{-Wformat} is enabled, also warn about functions which might be
2900 candidates for @code{format} attributes.  Note these are only possible
2901 candidates, not absolute ones.  GCC will guess that @code{format}
2902 attributes might be appropriate for any function that calls a function
2903 like @code{vprintf} or @code{vscanf}, but this might not always be the
2904 case, and some functions for which @code{format} attributes are
2905 appropriate may not be detected.  This option has no effect unless
2906 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2908 @item -Wno-multichar
2909 @opindex Wno-multichar
2910 @opindex Wmultichar
2911 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2912 Usually they indicate a typo in the user's code, as they have
2913 implementation-defined values, and should not be used in portable code.
2915 @item -Wno-deprecated-declarations
2916 @opindex Wno-deprecated-declarations
2917 Do not warn about uses of functions, variables, and types marked as
2918 deprecated by using the @code{deprecated} attribute.
2919 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2920 @pxref{Type Attributes}.)
2922 @item -Wpacked
2923 @opindex Wpacked
2924 Warn if a structure is given the packed attribute, but the packed
2925 attribute has no effect on the layout or size of the structure.
2926 Such structures may be mis-aligned for little benefit.  For
2927 instance, in this code, the variable @code{f.x} in @code{struct bar}
2928 will be misaligned even though @code{struct bar} does not itself
2929 have the packed attribute:
2931 @smallexample
2932 @group
2933 struct foo @{
2934   int x;
2935   char a, b, c, d;
2936 @} __attribute__((packed));
2937 struct bar @{
2938   char z;
2939   struct foo f;
2941 @end group
2942 @end smallexample
2944 @item -Wpadded
2945 @opindex Wpadded
2946 Warn if padding is included in a structure, either to align an element
2947 of the structure or to align the whole structure.  Sometimes when this
2948 happens it is possible to rearrange the fields of the structure to
2949 reduce the padding and so make the structure smaller.
2951 @item -Wredundant-decls
2952 @opindex Wredundant-decls
2953 Warn if anything is declared more than once in the same scope, even in
2954 cases where multiple declaration is valid and changes nothing.
2956 @item -Wnested-externs @r{(C only)}
2957 @opindex Wnested-externs
2958 Warn if an @code{extern} declaration is encountered within a function.
2960 @item -Wunreachable-code
2961 @opindex Wunreachable-code
2962 Warn if the compiler detects that code will never be executed.
2964 This option is intended to warn when the compiler detects that at
2965 least a whole line of source code will never be executed, because
2966 some condition is never satisfied or because it is after a
2967 procedure that never returns.
2969 It is possible for this option to produce a warning even though there
2970 are circumstances under which part of the affected line can be executed,
2971 so care should be taken when removing apparently-unreachable code.
2973 For instance, when a function is inlined, a warning may mean that the
2974 line is unreachable in only one inlined copy of the function.
2976 This option is not made part of @option{-Wall} because in a debugging
2977 version of a program there is often substantial code which checks
2978 correct functioning of the program and is, hopefully, unreachable
2979 because the program does work.  Another common use of unreachable
2980 code is to provide behavior which is selectable at compile-time.
2982 @item -Winline
2983 @opindex Winline
2984 Warn if a function can not be inlined and it was declared as inline.
2985 Even with this option, the compiler will not warn about failures to
2986 inline functions declared in system headers.
2988 The compiler uses a variety of heuristics to determine whether or not
2989 to inline a function.  For example, the compiler takes into account
2990 the size of the function being inlined and the the amount of inlining
2991 that has already been done in the current function.  Therefore,
2992 seemingly insignificant changes in the source program can cause the
2993 warnings produced by @option{-Winline} to appear or disappear.
2995 @item -Wno-invalid-offsetof @r{(C++ only)}
2996 @opindex Wno-invalid-offsetof
2997 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
2998 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
2999 to a non-POD type is undefined.  In existing C++ implementations,
3000 however, @samp{offsetof} typically gives meaningful results even when
3001 applied to certain kinds of non-POD types. (Such as a simple
3002 @samp{struct} that fails to be a POD type only by virtue of having a
3003 constructor.)  This flag is for users who are aware that they are
3004 writing nonportable code and who have deliberately chosen to ignore the
3005 warning about it.
3007 The restrictions on @samp{offsetof} may be relaxed in a future version
3008 of the C++ standard.
3010 @item -Winvalid-pch
3011 @opindex Winvalid-pch
3012 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3013 the search path but can't be used.
3015 @item -Wlong-long
3016 @opindex Wlong-long
3017 @opindex Wno-long-long
3018 Warn if @samp{long long} type is used.  This is default.  To inhibit
3019 the warning messages, use @option{-Wno-long-long}.  Flags
3020 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3021 only when @option{-pedantic} flag is used.
3023 @item -Wvariadic-macros
3024 @opindex Wvariadic-macros
3025 @opindex Wno-variadic-macros
3026 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3027 alternate syntax when in pedantic ISO C99 mode.  This is default.
3028 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3030 @item -Wdisabled-optimization
3031 @opindex Wdisabled-optimization
3032 Warn if a requested optimization pass is disabled.  This warning does
3033 not generally indicate that there is anything wrong with your code; it
3034 merely indicates that GCC's optimizers were unable to handle the code
3035 effectively.  Often, the problem is that your code is too big or too
3036 complex; GCC will refuse to optimize programs when the optimization
3037 itself is likely to take inordinate amounts of time.
3039 @item -Werror
3040 @opindex Werror
3041 Make all warnings into errors.
3042 @end table
3044 @node Debugging Options
3045 @section Options for Debugging Your Program or GCC
3046 @cindex options, debugging
3047 @cindex debugging information options
3049 GCC has various special options that are used for debugging
3050 either your program or GCC:
3052 @table @gcctabopt
3053 @item -g
3054 @opindex g
3055 Produce debugging information in the operating system's native format
3056 (stabs, COFF, XCOFF, or DWARF)@.  GDB can work with this debugging
3057 information.
3059 On most systems that use stabs format, @option{-g} enables use of extra
3060 debugging information that only GDB can use; this extra information
3061 makes debugging work better in GDB but will probably make other debuggers
3062 crash or
3063 refuse to read the program.  If you want to control for certain whether
3064 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3065 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3067 Unlike most other C compilers, GCC allows you to use @option{-g} with
3068 @option{-O}.  The shortcuts taken by optimized code may occasionally
3069 produce surprising results: some variables you declared may not exist
3070 at all; flow of control may briefly move where you did not expect it;
3071 some statements may not be executed because they compute constant
3072 results or their values were already at hand; some statements may
3073 execute in different places because they were moved out of loops.
3075 Nevertheless it proves possible to debug optimized output.  This makes
3076 it reasonable to use the optimizer for programs that might have bugs.
3078 The following options are useful when GCC is generated with the
3079 capability for more than one debugging format.
3081 @item -ggdb
3082 @opindex ggdb
3083 Produce debugging information for use by GDB@.  This means to use the
3084 most expressive format available (DWARF 2, stabs, or the native format
3085 if neither of those are supported), including GDB extensions if at all
3086 possible.
3088 @item -gstabs
3089 @opindex gstabs
3090 Produce debugging information in stabs format (if that is supported),
3091 without GDB extensions.  This is the format used by DBX on most BSD
3092 systems.  On MIPS, Alpha and System V Release 4 systems this option
3093 produces stabs debugging output which is not understood by DBX or SDB@.
3094 On System V Release 4 systems this option requires the GNU assembler.
3096 @item -feliminate-unused-debug-symbols
3097 @opindex feliminate-unused-debug-symbols
3098 Produce debugging information in stabs format (if that is supported),
3099 for only symbols that are actually used.
3101 @item -gstabs+
3102 @opindex gstabs+
3103 Produce debugging information in stabs format (if that is supported),
3104 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3105 use of these extensions is likely to make other debuggers crash or
3106 refuse to read the program.
3108 @item -gcoff
3109 @opindex gcoff
3110 Produce debugging information in COFF format (if that is supported).
3111 This is the format used by SDB on most System V systems prior to
3112 System V Release 4.
3114 @item -gxcoff
3115 @opindex gxcoff
3116 Produce debugging information in XCOFF format (if that is supported).
3117 This is the format used by the DBX debugger on IBM RS/6000 systems.
3119 @item -gxcoff+
3120 @opindex gxcoff+
3121 Produce debugging information in XCOFF format (if that is supported),
3122 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3123 use of these extensions is likely to make other debuggers crash or
3124 refuse to read the program, and may cause assemblers other than the GNU
3125 assembler (GAS) to fail with an error.
3127 @item -gdwarf-2
3128 @opindex gdwarf-2
3129 Produce debugging information in DWARF version 2 format (if that is
3130 supported).  This is the format used by DBX on IRIX 6.
3132 @item -gvms
3133 @opindex gvms
3134 Produce debugging information in VMS debug format (if that is
3135 supported).  This is the format used by DEBUG on VMS systems.
3137 @item -g@var{level}
3138 @itemx -ggdb@var{level}
3139 @itemx -gstabs@var{level}
3140 @itemx -gcoff@var{level}
3141 @itemx -gxcoff@var{level}
3142 @itemx -gvms@var{level}
3143 Request debugging information and also use @var{level} to specify how
3144 much information.  The default level is 2.
3146 Level 1 produces minimal information, enough for making backtraces in
3147 parts of the program that you don't plan to debug.  This includes
3148 descriptions of functions and external variables, but no information
3149 about local variables and no line numbers.
3151 Level 3 includes extra information, such as all the macro definitions
3152 present in the program.  Some debuggers support macro expansion when
3153 you use @option{-g3}.
3155 Note that in order to avoid confusion between DWARF1 debug level 2,
3156 and DWARF2 @option{-gdwarf-2} does not accept a concatenated debug
3157 level.  Instead use an additional @option{-g@var{level}} option to
3158 change the debug level for DWARF2.
3160 @item -feliminate-dwarf2-dups
3161 @opindex feliminate-dwarf2-dups
3162 Compress DWARF2 debugging information by eliminating duplicated
3163 information about each symbol.  This option only makes sense when
3164 generating DWARF2 debugging information with @option{-gdwarf-2}.
3166 @cindex @command{prof}
3167 @item -p
3168 @opindex p
3169 Generate extra code to write profile information suitable for the
3170 analysis program @command{prof}.  You must use this option when compiling
3171 the source files you want data about, and you must also use it when
3172 linking.
3174 @cindex @command{gprof}
3175 @item -pg
3176 @opindex pg
3177 Generate extra code to write profile information suitable for the
3178 analysis program @command{gprof}.  You must use this option when compiling
3179 the source files you want data about, and you must also use it when
3180 linking.
3182 @item -Q
3183 @opindex Q
3184 Makes the compiler print out each function name as it is compiled, and
3185 print some statistics about each pass when it finishes.
3187 @item -ftime-report
3188 @opindex ftime-report
3189 Makes the compiler print some statistics about the time consumed by each
3190 pass when it finishes.
3192 @item -fmem-report
3193 @opindex fmem-report
3194 Makes the compiler print some statistics about permanent memory
3195 allocation when it finishes.
3197 @item -fprofile-arcs
3198 @opindex fprofile-arcs
3199 Add code so that program flow @dfn{arcs} are instrumented.  During
3200 execution the program records how many times each branch and call is
3201 executed and how many times it is taken or returns.  When the compiled
3202 program exits it saves this data to a file called
3203 @file{@var{auxname}.gcda} for each source file. The data may be used for
3204 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3205 test coverage analysis (@option{-ftest-coverage}). Each object file's
3206 @var{auxname} is generated from the name of the output file, if
3207 explicitly specified and it is not the final executable, otherwise it is
3208 the basename of the source file. In both cases any suffix is removed
3209 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3210 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3212 @itemize
3214 @item
3215 Compile the source files with @option{-fprofile-arcs} plus optimization
3216 and code generation options. For test coverage analysis, use the
3217 additional @option{-ftest-coverage} option. You do not need to profile
3218 every source file in a program.
3220 @item
3221 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3222 (the latter implies the former).
3224 @item
3225 Run the program on a representative workload to generate the arc profile
3226 information. This may be repeated any number of times. You can run
3227 concurrent instances of your program, and provided that the file system
3228 supports locking, the data files will be correctly updated. Also
3229 @code{fork} calls are detected and correctly handled (double counting
3230 will not happen).
3232 @item
3233 For profile-directed optimizations, compile the source files again with
3234 the same optimization and code generation options plus
3235 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3236 Control Optimization}).
3238 @item
3239 For test coverage analysis, use @command{gcov} to produce human readable
3240 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3241 @command{gcov} documentation for further information.
3243 @end itemize
3245 With @option{-fprofile-arcs}, for each function of your program GCC
3246 creates a program flow graph, then finds a spanning tree for the graph.
3247 Only arcs that are not on the spanning tree have to be instrumented: the
3248 compiler adds code to count the number of times that these arcs are
3249 executed.  When an arc is the only exit or only entrance to a block, the
3250 instrumentation code can be added to the block; otherwise, a new basic
3251 block must be created to hold the instrumentation code.
3253 @item -ftree-based-profiling
3254 @opindex ftree-based-profiling
3255 This option is used in addition to @option{-fprofile-arcs} or
3256 @option{-fbranch-probabilities} to control whether those optimizations
3257 are performed on a tree-based or rtl-based internal representation.
3258 If you use this option when compiling with @option{-fprofile-arcs},
3259 you must also use it when compiling later with @option{-fbranch-probabilities}.
3260 Currently the tree-based optimization is in an early stage of
3261 development, and this option is recommended only for those people
3262 working on improving it.
3264 @need 2000
3265 @item -ftest-coverage
3266 @opindex ftest-coverage
3267 Produce a notes file that the @command{gcov} code-coverage utility
3268 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3269 show program coverage. Each source file's note file is called
3270 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3271 above for a description of @var{auxname} and instructions on how to
3272 generate test coverage data. Coverage data will match the source files
3273 more closely, if you do not optimize.
3275 @item -d@var{letters}
3276 @opindex d
3277 Says to make debugging dumps during compilation at times specified by
3278 @var{letters}.  This is used for debugging the compiler.  The file names
3279 for most of the dumps are made by appending a pass number and a word to
3280 the @var{dumpname}. @var{dumpname} is generated from the name of the
3281 output file, if explicitly specified and it is not an executable,
3282 otherwise it is the basename of the source file. In both cases any
3283 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3284 Here are the possible letters for use in @var{letters}, and their
3285 meanings:
3287 @table @samp
3288 @item A
3289 @opindex dA
3290 Annotate the assembler output with miscellaneous debugging information.
3291 @item b
3292 @opindex db
3293 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3294 @item B
3295 @opindex dB
3296 Dump after block reordering, to @file{@var{file}.32.bbro}.
3297 @item c
3298 @opindex dc
3299 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3300 @item C
3301 @opindex dC
3302 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3303 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3304 @item d
3305 @opindex dd
3306 Dump after branch target load optimization, to to @file{@var{file}.33.btl}.
3307 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3308 @item D
3309 @opindex dD
3310 Dump all macro definitions, at the end of preprocessing, in addition to
3311 normal output.
3312 @item E
3313 @opindex dE
3314 Dump after the third if conversion, to @file{@var{file}.31.ce3}.
3315 @item f
3316 @opindex df
3317 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3318 Also dump after life analysis, to @file{@var{file}.19.life}.
3319 @item g
3320 @opindex dg
3321 Dump after global register allocation, to @file{@var{file}.26.greg}.
3322 @item G
3323 @opindex dG
3324 Dump after GCSE, to @file{@var{file}.08.gcse}.
3325 Also dump after jump bypassing and control flow optimizations, to
3326 @file{@var{file}.10.bypass}.
3327 @item h
3328 @opindex dh
3329 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3330 @item i
3331 @opindex di
3332 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3333 @item j
3334 @opindex dj
3335 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3336 @item k
3337 @opindex dk
3338 Dump after conversion from registers to stack, to @file{@var{file}.35.stack}.
3339 @item l
3340 @opindex dl
3341 Dump after local register allocation, to @file{@var{file}.25.lreg}.
3342 @item L
3343 @opindex dL
3344 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3345 @file{@var{file}.16.loop2}.
3346 @item m
3347 @opindex dm
3348 Dump after modulo scheduling, to @file{@var{file}.23.sms}.
3349 @item M
3350 @opindex dM
3351 Dump after performing the machine dependent reorganization pass, to
3352 @file{@var{file}.36.mach}.
3353 @item n
3354 @opindex dn
3355 Dump after register renumbering, to @file{@var{file}.30.rnreg}.
3356 @item N
3357 @opindex dN
3358 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3359 @item o
3360 @opindex do
3361 Dump after post-reload optimizations, to @file{@var{file}.27.postreload}.
3362 @item r
3363 @opindex dr
3364 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3365 @item R
3366 @opindex dR
3367 Dump after the second scheduling pass, to @file{@var{file}.34.sched2}.
3368 @item s
3369 @opindex ds
3370 Dump after CSE (including the jump optimization that sometimes follows
3371 CSE), to @file{@var{file}.06.cse}.
3372 @item S
3373 @opindex dS
3374 Dump after the first scheduling pass, to @file{@var{file}.24.sched}.
3375 @item t
3376 @opindex dt
3377 Dump after the second CSE pass (including the jump optimization that
3378 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3379 @item T
3380 @opindex dT
3381 Dump after running tracer, to @file{@var{file}.15.tracer}.
3382 @item u
3383 @opindex du
3384 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3385 @item U
3386 @opindex dU
3387 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3388 @item V
3389 @opindex dV
3390 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3391 Also dump after variable tracking, to @file{@var{file}.35.vartrack}.
3392 @item w
3393 @opindex dw
3394 Dump after the second flow pass, to @file{@var{file}.28.flow2}.
3395 @item z
3396 @opindex dz
3397 Dump after the peephole pass, to @file{@var{file}.29.peephole2}.
3398 @item Z
3399 @opindex dZ
3400 Dump after constructing the web, to @file{@var{file}.17.web}.
3401 @item a
3402 @opindex da
3403 Produce all the dumps listed above.
3404 @item H
3405 @opindex dH
3406 Produce a core dump whenever an error occurs.
3407 @item m
3408 @opindex dm
3409 Print statistics on memory usage, at the end of the run, to
3410 standard error.
3411 @item p
3412 @opindex dp
3413 Annotate the assembler output with a comment indicating which
3414 pattern and alternative was used.  The length of each instruction is
3415 also printed.
3416 @item P
3417 @opindex dP
3418 Dump the RTL in the assembler output as a comment before each instruction.
3419 Also turns on @option{-dp} annotation.
3420 @item v
3421 @opindex dv
3422 For each of the other indicated dump files (except for
3423 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3424 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3425 @item x
3426 @opindex dx
3427 Just generate RTL for a function instead of compiling it.  Usually used
3428 with @samp{r}.
3429 @item y
3430 @opindex dy
3431 Dump debugging information during parsing, to standard error.
3432 @end table
3434 @item -fdump-unnumbered
3435 @opindex fdump-unnumbered
3436 When doing debugging dumps (see @option{-d} option above), suppress instruction
3437 numbers and line number note output.  This makes it more feasible to
3438 use diff on debugging dumps for compiler invocations with different
3439 options, in particular with and without @option{-g}.
3441 @item -fdump-translation-unit @r{(C and C++ only)}
3442 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3443 @opindex fdump-translation-unit
3444 Dump a representation of the tree structure for the entire translation
3445 unit to a file.  The file name is made by appending @file{.tu} to the
3446 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3447 controls the details of the dump as described for the
3448 @option{-fdump-tree} options.
3450 @item -fdump-class-hierarchy @r{(C++ only)}
3451 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3452 @opindex fdump-class-hierarchy
3453 Dump a representation of each class's hierarchy and virtual function
3454 table layout to a file.  The file name is made by appending @file{.class}
3455 to the source file name.  If the @samp{-@var{options}} form is used,
3456 @var{options} controls the details of the dump as described for the
3457 @option{-fdump-tree} options.
3459 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3460 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3461 @opindex fdump-tree
3462 Control the dumping at various stages of processing the intermediate
3463 language tree to a file.  The file name is generated by appending a switch
3464 specific suffix to the source file name.  If the @samp{-@var{options}}
3465 form is used, @var{options} is a list of @samp{-} separated options that
3466 control the details of the dump. Not all options are applicable to all
3467 dumps, those which are not meaningful will be ignored. The following
3468 options are available
3470 @table @samp
3471 @item address
3472 Print the address of each node.  Usually this is not meaningful as it
3473 changes according to the environment and source file. Its primary use
3474 is for tying up a dump file with a debug environment.
3475 @item slim
3476 Inhibit dumping of members of a scope or body of a function merely
3477 because that scope has been reached.  Only dump such items when they
3478 are directly reachable by some other path.  When dumping pretty-printed
3479 trees, this option inhibits dumping the bodies of control structures.
3480 @item raw
3481 Print a raw representation of the tree.  By default, trees are
3482 pretty-printed into a C-like representation.
3483 @item details
3484 Enable more detailed dumps (not honored by every dump option).
3485 @item stats
3486 Enable dumping various statistics about the pass (not honored by every dump
3487 option).
3488 @item blocks
3489 Enable showing basic block boundaries (disabled in raw dumps).
3490 @item vops
3491 Enable showing virtual operands for every statement.
3492 @item lineno
3493 Enable showing line numbers for statements.
3494 @item uid
3495 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3496 @item all
3497 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3498 @end table
3500 The following tree dumps are possible:
3501 @table @samp
3503 @item original
3504 Dump before any tree based optimization, to @file{@var{file}.original}.
3506 @item optimized
3507 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3509 @item inlined
3510 Dump after function inlining, to @file{@var{file}.inlined}.
3512 @item gimple
3513 @opindex fdump-tree-gimple
3514 Dump each function before and after the gimplification pass to a file.  The
3515 file name is made by appending @file{.gimple} to the source file name.
3517 @item cfg
3518 @opindex fdump-tree-cfg
3519 Dump the control flow graph of each function to a file.  The file name is
3520 made by appending @file{.cfg} to the source file name.
3522 @item vcg
3523 @opindex fdump-tree-vcg
3524 Dump the control flow graph of each function to a file in VCG format.  The
3525 file name is made by appending @file{.vcg} to the source file name.  Note
3526 that if the file contains more than one function, the generated file cannot
3527 be used directly by VCG.  You will need to cut and paste each function's
3528 graph into its own separate file first.
3530 @item ch
3531 @opindex fdump-tree-ch
3532 Dump each function after copying loop headers.  The file name is made by
3533 appending @file{.ch} to the source file name.
3535 @item ssa
3536 @opindex fdump-tree-ssa
3537 Dump SSA related information to a file.  The file name is made by appending
3538 @file{.ssa} to the source file name.
3540 @item alias
3541 @opindex fdump-tree-alias
3542 Dump aliasing information for each function.  The file name is made by
3543 appending @file{.alias} to the source file name.
3545 @item ccp
3546 @opindex fdump-tree-ccp
3547 Dump each function after CCP.  The file name is made by appending
3548 @file{.ccp} to the source file name.
3550 @item pre
3551 @opindex fdump-tree-pre
3552 Dump trees after partial redundancy elimination.  The file name is made
3553 by appending @file{.pre} to the source file name.
3555 @item fre
3556 @opindex fdump-tree-fre
3557 Dump trees after full redundancy elimination.  The file name is made
3558 by appending @file{.fre} to the source file name.
3560 @item dce
3561 @opindex fdump-tree-dce
3562 Dump each function after dead code elimination.  The file name is made by
3563 appending @file{.dce} to the source file name.
3565 @item mudflap
3566 @opindex fdump-tree-mudflap
3567 Dump each function after adding mudflap instrumentation.  The file name is
3568 made by appending @file{.mudflap} to the source file name.
3570 @item sra
3571 @opindex fdump-tree-sra
3572 Dump each function after performing scalar replacement of aggregates.  The
3573 file name is made by appending @file{.sra} to the source file name.
3575 @item dom
3576 @opindex fdump-tree-dom
3577 Dump each function after applying dominator tree optimizations.  The file
3578 name is made by appending @file{.dom} to the source file name.
3580 @item dse
3581 @opindex fdump-tree-dse
3582 Dump each function after applying dead store elimination.  The file
3583 name is made by appending @file{.dse} to the source file name.
3585 @item phiopt
3586 @opindex fdump-tree-phiopt
3587 Dump each function after optimizing PHI nodes into straightline code.  The file
3588 name is made by appending @file{.phiopt} to the source file name.
3590 @item forwprop
3591 @opindex fdump-tree-forwprop
3592 Dump each function after forward propagating single use variables.  The file
3593 name is made by appending @file{.forwprop} to the source file name.
3595 @item copyrename
3596 @opindex fdump-tree-copyrename
3597 Dump each function after applying the copy rename optimization.  The file
3598 name is made by appending @file{.copyrename} to the source file name.
3600 @item nrv
3601 @opindex fdump-tree-nrv
3602 Dump each function after applying the named return value optimization on
3603 generic trees.  The file name is made by appending @file{.nrv} to the source
3604 file name.
3606 @item all
3607 @opindex fdump-tree-all
3608 Enable all the available tree dumps with the flags provided in this option.
3609 @end table
3611 @item -frandom-seed=@var{string}
3612 @opindex frandom-string
3613 This option provides a seed that GCC uses when it would otherwise use
3614 random numbers.  It is used to generate certain symbol names
3615 that have to be different in every compiled file. It is also used to
3616 place unique stamps in coverage data files and the object files that
3617 produce them. You can use the @option{-frandom-seed} option to produce
3618 reproducibly identical object files.
3620 The @var{string} should be different for every file you compile.
3622 @item -fsched-verbose=@var{n}
3623 @opindex fsched-verbose
3624 On targets that use instruction scheduling, this option controls the
3625 amount of debugging output the scheduler prints.  This information is
3626 written to standard error, unless @option{-dS} or @option{-dR} is
3627 specified, in which case it is output to the usual dump
3628 listing file, @file{.sched} or @file{.sched2} respectively.  However
3629 for @var{n} greater than nine, the output is always printed to standard
3630 error.
3632 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3633 same information as @option{-dRS}.  For @var{n} greater than one, it
3634 also output basic block probabilities, detailed ready list information
3635 and unit/insn info.  For @var{n} greater than two, it includes RTL
3636 at abort point, control-flow and regions info.  And for @var{n} over
3637 four, @option{-fsched-verbose} also includes dependence info.
3639 @item -save-temps
3640 @opindex save-temps
3641 Store the usual ``temporary'' intermediate files permanently; place them
3642 in the current directory and name them based on the source file.  Thus,
3643 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3644 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3645 preprocessed @file{foo.i} output file even though the compiler now
3646 normally uses an integrated preprocessor.
3648 @item -time
3649 @opindex time
3650 Report the CPU time taken by each subprocess in the compilation
3651 sequence.  For C source files, this is the compiler proper and assembler
3652 (plus the linker if linking is done).  The output looks like this:
3654 @smallexample
3655 # cc1 0.12 0.01
3656 # as 0.00 0.01
3657 @end smallexample
3659 The first number on each line is the ``user time,'' that is time spent
3660 executing the program itself.  The second number is ``system time,''
3661 time spent executing operating system routines on behalf of the program.
3662 Both numbers are in seconds.
3664 @item -fvar-tracking
3665 @opindex fvar-tracking
3666 Run variable tracking pass. It computes where variables are stored at each
3667 position in code. Better debugging information is then generated
3668 (if the debugging information format supports this information).
3670 It is enabled by default when compiling with optimization (@option{-Os},
3671 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3672 the debug info format supports it.
3674 @item -print-file-name=@var{library}
3675 @opindex print-file-name
3676 Print the full absolute name of the library file @var{library} that
3677 would be used when linking---and don't do anything else.  With this
3678 option, GCC does not compile or link anything; it just prints the
3679 file name.
3681 @item -print-multi-directory
3682 @opindex print-multi-directory
3683 Print the directory name corresponding to the multilib selected by any
3684 other switches present in the command line.  This directory is supposed
3685 to exist in @env{GCC_EXEC_PREFIX}.
3687 @item -print-multi-lib
3688 @opindex print-multi-lib
3689 Print the mapping from multilib directory names to compiler switches
3690 that enable them.  The directory name is separated from the switches by
3691 @samp{;}, and each switch starts with an @samp{@@} instead of the
3692 @samp{-}, without spaces between multiple switches.  This is supposed to
3693 ease shell-processing.
3695 @item -print-prog-name=@var{program}
3696 @opindex print-prog-name
3697 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3699 @item -print-libgcc-file-name
3700 @opindex print-libgcc-file-name
3701 Same as @option{-print-file-name=libgcc.a}.
3703 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3704 but you do want to link with @file{libgcc.a}.  You can do
3706 @smallexample
3707 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3708 @end smallexample
3710 @item -print-search-dirs
3711 @opindex print-search-dirs
3712 Print the name of the configured installation directory and a list of
3713 program and library directories @command{gcc} will search---and don't do anything else.
3715 This is useful when @command{gcc} prints the error message
3716 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3717 To resolve this you either need to put @file{cpp0} and the other compiler
3718 components where @command{gcc} expects to find them, or you can set the environment
3719 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3720 Don't forget the trailing '/'.
3721 @xref{Environment Variables}.
3723 @item -dumpmachine
3724 @opindex dumpmachine
3725 Print the compiler's target machine (for example,
3726 @samp{i686-pc-linux-gnu})---and don't do anything else.
3728 @item -dumpversion
3729 @opindex dumpversion
3730 Print the compiler version (for example, @samp{3.0})---and don't do
3731 anything else.
3733 @item -dumpspecs
3734 @opindex dumpspecs
3735 Print the compiler's built-in specs---and don't do anything else.  (This
3736 is used when GCC itself is being built.)  @xref{Spec Files}.
3738 @item -feliminate-unused-debug-types
3739 @opindex feliminate-unused-debug-types
3740 Normally, when producing DWARF2 output, GCC will emit debugging
3741 information for all types declared in a compilation
3742 unit, regardless of whether or not they are actually used
3743 in that compilation unit.  Sometimes this is useful, such as
3744 if, in the debugger, you want to cast a value to a type that is
3745 not actually used in your program (but is declared).  More often,
3746 however, this results in a significant amount of wasted space.
3747 With this option, GCC will avoid producing debug symbol output
3748 for types that are nowhere used in the source file being compiled.
3749 @end table
3751 @node Optimize Options
3752 @section Options That Control Optimization
3753 @cindex optimize options
3754 @cindex options, optimization
3756 These options control various sorts of optimizations.
3758 Without any optimization option, the compiler's goal is to reduce the
3759 cost of compilation and to make debugging produce the expected
3760 results.  Statements are independent: if you stop the program with a
3761 breakpoint between statements, you can then assign a new value to any
3762 variable or change the program counter to any other statement in the
3763 function and get exactly the results you would expect from the source
3764 code.
3766 Turning on optimization flags makes the compiler attempt to improve
3767 the performance and/or code size at the expense of compilation time
3768 and possibly the ability to debug the program.
3770 The compiler performs optimization based on the knowledge it has of
3771 the program.  Optimization levels @option{-O2} and above, in
3772 particular, enable @emph{unit-at-a-time} mode, which allows the
3773 compiler to consider information gained from later functions in
3774 the file when compiling a function.  Compiling multiple files at
3775 once to a single output file in @emph{unit-at-a-time} mode allows
3776 the compiler to use information gained from all of the files when
3777 compiling each of them.
3779 Not all optimizations are controlled directly by a flag.  Only
3780 optimizations that have a flag are listed.
3782 @table @gcctabopt
3783 @item -O
3784 @itemx -O1
3785 @opindex O
3786 @opindex O1
3787 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3788 more memory for a large function.
3790 With @option{-O}, the compiler tries to reduce code size and execution
3791 time, without performing any optimizations that take a great deal of
3792 compilation time.
3794 @option{-O} turns on the following optimization flags:
3795 @gccoptlist{-fdefer-pop @gol
3796 -fmerge-constants @gol
3797 -fthread-jumps @gol
3798 -floop-optimize @gol
3799 -fif-conversion @gol
3800 -fif-conversion2 @gol
3801 -fdelayed-branch @gol
3802 -fguess-branch-probability @gol
3803 -fcprop-registers}
3805 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3806 where doing so does not interfere with debugging.
3808 @item -O2
3809 @opindex O2
3810 Optimize even more.  GCC performs nearly all supported optimizations
3811 that do not involve a space-speed tradeoff.  The compiler does not
3812 perform loop unrolling or function inlining when you specify @option{-O2}.
3813 As compared to @option{-O}, this option increases both compilation time
3814 and the performance of the generated code.
3816 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3817 also turns on the following optimization flags:
3818 @gccoptlist{-fforce-mem @gol
3819 -foptimize-sibling-calls @gol
3820 -fstrength-reduce @gol
3821 -fcse-follow-jumps  -fcse-skip-blocks @gol
3822 -frerun-cse-after-loop  -frerun-loop-opt @gol
3823 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3824 -fdelete-null-pointer-checks @gol
3825 -fexpensive-optimizations @gol
3826 -fregmove @gol
3827 -fschedule-insns  -fschedule-insns2 @gol
3828 -fsched-interblock  -fsched-spec @gol
3829 -fcaller-saves @gol
3830 -fpeephole2 @gol
3831 -freorder-blocks  -freorder-functions @gol
3832 -fstrict-aliasing @gol
3833 -funit-at-a-time @gol
3834 -falign-functions  -falign-jumps @gol
3835 -falign-loops  -falign-labels @gol
3836 -fcrossjumping}
3838 Please note the warning under @option{-fgcse} about
3839 invoking @option{-O2} on programs that use computed gotos.
3841 @item -O3
3842 @opindex O3
3843 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3844 @option{-O2} and also turns on the @option{-finline-functions},
3845 @option{-fweb} and @option{-fgcse-after-reload} options.
3847 @item -O0
3848 @opindex O0
3849 Do not optimize.  This is the default.
3851 @item -Os
3852 @opindex Os
3853 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3854 do not typically increase code size.  It also performs further
3855 optimizations designed to reduce code size.
3857 @option{-Os} disables the following optimization flags:
3858 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3859 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
3861 If you use multiple @option{-O} options, with or without level numbers,
3862 the last such option is the one that is effective.
3863 @end table
3865 Options of the form @option{-f@var{flag}} specify machine-independent
3866 flags.  Most flags have both positive and negative forms; the negative
3867 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3868 below, only one of the forms is listed---the one you typically will
3869 use.  You can figure out the other form by either removing @samp{no-}
3870 or adding it.
3872 The following options control specific optimizations.  They are either
3873 activated by @option{-O} options or are related to ones that are.  You
3874 can use the following flags in the rare cases when ``fine-tuning'' of
3875 optimizations to be performed is desired.
3877 @table @gcctabopt
3878 @item -fno-default-inline
3879 @opindex fno-default-inline
3880 Do not make member functions inline by default merely because they are
3881 defined inside the class scope (C++ only).  Otherwise, when you specify
3882 @w{@option{-O}}, member functions defined inside class scope are compiled
3883 inline by default; i.e., you don't need to add @samp{inline} in front of
3884 the member function name.
3886 @item -fno-defer-pop
3887 @opindex fno-defer-pop
3888 Always pop the arguments to each function call as soon as that function
3889 returns.  For machines which must pop arguments after a function call,
3890 the compiler normally lets arguments accumulate on the stack for several
3891 function calls and pops them all at once.
3893 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3895 @item -fforce-mem
3896 @opindex fforce-mem
3897 Force memory operands to be copied into registers before doing
3898 arithmetic on them.  This produces better code by making all memory
3899 references potential common subexpressions.  When they are not common
3900 subexpressions, instruction combination should eliminate the separate
3901 register-load.
3903 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3905 @item -fforce-addr
3906 @opindex fforce-addr
3907 Force memory address constants to be copied into registers before
3908 doing arithmetic on them.  This may produce better code just as
3909 @option{-fforce-mem} may.
3911 @item -fomit-frame-pointer
3912 @opindex fomit-frame-pointer
3913 Don't keep the frame pointer in a register for functions that
3914 don't need one.  This avoids the instructions to save, set up and
3915 restore frame pointers; it also makes an extra register available
3916 in many functions.  @strong{It also makes debugging impossible on
3917 some machines.}
3919 On some machines, such as the VAX, this flag has no effect, because
3920 the standard calling sequence automatically handles the frame pointer
3921 and nothing is saved by pretending it doesn't exist.  The
3922 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
3923 whether a target machine supports this flag.  @xref{Registers,,Register
3924 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
3926 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3928 @item -foptimize-sibling-calls
3929 @opindex foptimize-sibling-calls
3930 Optimize sibling and tail recursive calls.
3932 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3934 @item -fno-inline
3935 @opindex fno-inline
3936 Don't pay attention to the @code{inline} keyword.  Normally this option
3937 is used to keep the compiler from expanding any functions inline.
3938 Note that if you are not optimizing, no functions can be expanded inline.
3940 @item -finline-functions
3941 @opindex finline-functions
3942 Integrate all simple functions into their callers.  The compiler
3943 heuristically decides which functions are simple enough to be worth
3944 integrating in this way.
3946 If all calls to a given function are integrated, and the function is
3947 declared @code{static}, then the function is normally not output as
3948 assembler code in its own right.
3950 Enabled at level @option{-O3}.
3952 @item -finline-limit=@var{n}
3953 @opindex finline-limit
3954 By default, GCC limits the size of functions that can be inlined.  This flag
3955 allows the control of this limit for functions that are explicitly marked as
3956 inline (i.e., marked with the inline keyword or defined within the class
3957 definition in c++).  @var{n} is the size of functions that can be inlined in
3958 number of pseudo instructions (not counting parameter handling).  The default
3959 value of @var{n} is 600.
3960 Increasing this value can result in more inlined code at
3961 the cost of compilation time and memory consumption.  Decreasing usually makes
3962 the compilation faster and less code will be inlined (which presumably
3963 means slower programs).  This option is particularly useful for programs that
3964 use inlining heavily such as those based on recursive templates with C++.
3966 Inlining is actually controlled by a number of parameters, which may be
3967 specified individually by using @option{--param @var{name}=@var{value}}.
3968 The @option{-finline-limit=@var{n}} option sets some of these parameters
3969 as follows:
3971 @table @gcctabopt
3972  @item max-inline-insns-single
3973   is set to @var{n}/2.
3974  @item max-inline-insns-auto
3975   is set to @var{n}/2.
3976  @item min-inline-insns
3977   is set to 130 or @var{n}/4, whichever is smaller.
3978  @item max-inline-insns-rtl
3979   is set to @var{n}.
3980 @end table
3982 See below for a documentation of the individual
3983 parameters controlling inlining.
3985 @emph{Note:} pseudo instruction represents, in this particular context, an
3986 abstract measurement of function's size.  In no way, it represents a count
3987 of assembly instructions and as such its exact meaning might change from one
3988 release to an another.
3990 @item -fkeep-inline-functions
3991 @opindex fkeep-inline-functions
3992 Even if all calls to a given function are integrated, and the function
3993 is declared @code{static}, nevertheless output a separate run-time
3994 callable version of the function.  This switch does not affect
3995 @code{extern inline} functions.
3997 @item -fkeep-static-consts
3998 @opindex fkeep-static-consts
3999 Emit variables declared @code{static const} when optimization isn't turned
4000 on, even if the variables aren't referenced.
4002 GCC enables this option by default.  If you want to force the compiler to
4003 check if the variable was referenced, regardless of whether or not
4004 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4006 @item -fmerge-constants
4007 Attempt to merge identical constants (string constants and floating point
4008 constants) across compilation units.
4010 This option is the default for optimized compilation if the assembler and
4011 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4012 behavior.
4014 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4016 @item -fmerge-all-constants
4017 Attempt to merge identical constants and identical variables.
4019 This option implies @option{-fmerge-constants}.  In addition to
4020 @option{-fmerge-constants} this considers e.g. even constant initialized
4021 arrays or initialized constant variables with integral or floating point
4022 types.  Languages like C or C++ require each non-automatic variable to
4023 have distinct location, so using this option will result in non-conforming
4024 behavior.
4026 @item -fmodulo-sched
4027 @opindex fmodulo-sched
4028 Perform swing modulo scheduling immediately before the first scheduling
4029 pass.  This pass looks at innermost loops and reorders their
4030 instructions by overlapping different iterations.
4032 @item -fnew-ra
4033 @opindex fnew-ra
4034 Use a graph coloring register allocator.  Currently this option is meant
4035 only for testing.  Users should not specify this option, since it is not
4036 yet ready for production use.
4038 @item -fno-branch-count-reg
4039 @opindex fno-branch-count-reg
4040 Do not use ``decrement and branch'' instructions on a count register,
4041 but instead generate a sequence of instructions that decrement a
4042 register, compare it against zero, then branch based upon the result.
4043 This option is only meaningful on architectures that support such
4044 instructions, which include x86, PowerPC, IA-64 and S/390.
4046 The default is @option{-fbranch-count-reg}, enabled when
4047 @option{-fstrength-reduce} is enabled.
4049 @item -fno-function-cse
4050 @opindex fno-function-cse
4051 Do not put function addresses in registers; make each instruction that
4052 calls a constant function contain the function's address explicitly.
4054 This option results in less efficient code, but some strange hacks
4055 that alter the assembler output may be confused by the optimizations
4056 performed when this option is not used.
4058 The default is @option{-ffunction-cse}
4060 @item -fno-zero-initialized-in-bss
4061 @opindex fno-zero-initialized-in-bss
4062 If the target supports a BSS section, GCC by default puts variables that
4063 are initialized to zero into BSS@.  This can save space in the resulting
4064 code.
4066 This option turns off this behavior because some programs explicitly
4067 rely on variables going to the data section.  E.g., so that the
4068 resulting executable can find the beginning of that section and/or make
4069 assumptions based on that.
4071 The default is @option{-fzero-initialized-in-bss}.
4073 @item -fbounds-check
4074 @opindex fbounds-check
4075 For front-ends that support it, generate additional code to check that
4076 indices used to access arrays are within the declared range.  This is
4077 currently only supported by the Java and Fortran front-ends, where
4078 this option defaults to true and false respectively.
4080 @item -fmudflap -fmudflapth -fmudflapir
4081 @opindex fmudflap
4082 @opindex fmudflapth
4083 @opindex fmudflapir
4084 @cindex bounds checking
4085 @cindex mudflap
4086 For front-ends that support it (C and C++), instrument all risky
4087 pointer/array dereferencing operations, some standard library
4088 string/heap functions, and some other associated constructs with
4089 range/validity tests.  Modules so instrumented should be immune to
4090 buffer overflows, invalid heap use, and some other classes of C/C++
4091 programming errors.  The instrumentation relies on a separate runtime
4092 library (@file{libmudflap}), which will be linked into a program if
4093 @option{-fmudflap} is given at link time.  Run-time behavior of the
4094 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4095 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4096 for its options.
4098 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4099 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4100 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4101 instrumentation should ignore pointer reads.  This produces less
4102 instrumentation (and therefore faster execution) and still provides
4103 some protection against outright memory corrupting writes, but allows
4104 erroneously read data to propagate within a program.
4106 @item -fstrength-reduce
4107 @opindex fstrength-reduce
4108 Perform the optimizations of loop strength reduction and
4109 elimination of iteration variables.
4111 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4113 @item -fthread-jumps
4114 @opindex fthread-jumps
4115 Perform optimizations where we check to see if a jump branches to a
4116 location where another comparison subsumed by the first is found.  If
4117 so, the first branch is redirected to either the destination of the
4118 second branch or a point immediately following it, depending on whether
4119 the condition is known to be true or false.
4121 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4123 @item -fcse-follow-jumps
4124 @opindex fcse-follow-jumps
4125 In common subexpression elimination, scan through jump instructions
4126 when the target of the jump is not reached by any other path.  For
4127 example, when CSE encounters an @code{if} statement with an
4128 @code{else} clause, CSE will follow the jump when the condition
4129 tested is false.
4131 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4133 @item -fcse-skip-blocks
4134 @opindex fcse-skip-blocks
4135 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4136 follow jumps which conditionally skip over blocks.  When CSE
4137 encounters a simple @code{if} statement with no else clause,
4138 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4139 body of the @code{if}.
4141 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4143 @item -frerun-cse-after-loop
4144 @opindex frerun-cse-after-loop
4145 Re-run common subexpression elimination after loop optimizations has been
4146 performed.
4148 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4150 @item -frerun-loop-opt
4151 @opindex frerun-loop-opt
4152 Run the loop optimizer twice.
4154 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4156 @item -fgcse
4157 @opindex fgcse
4158 Perform a global common subexpression elimination pass.
4159 This pass also performs global constant and copy propagation.
4161 @emph{Note:} When compiling a program using computed gotos, a GCC
4162 extension, you may get better runtime performance if you disable
4163 the global common subexpression elimination pass by adding
4164 @option{-fno-gcse} to the command line.
4166 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4168 @item -fgcse-lm
4169 @opindex fgcse-lm
4170 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4171 attempt to move loads which are only killed by stores into themselves.  This
4172 allows a loop containing a load/store sequence to be changed to a load outside
4173 the loop, and a copy/store within the loop.
4175 Enabled by default when gcse is enabled.
4177 @item -fgcse-sm
4178 @opindex fgcse-sm
4179 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4180 global common subexpression elimination.  This pass will attempt to move
4181 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4182 loops containing a load/store sequence can be changed to a load before
4183 the loop and a store after the loop.
4185 Enabled by default when gcse is enabled.
4187 @item -fgcse-las
4188 @opindex fgcse-las
4189 When @option{-fgcse-las} is enabled, the global common subexpression
4190 elimination pass eliminates redundant loads that come after stores to the
4191 same memory location (both partial and full redundancies).
4193 Enabled by default when gcse is enabled.
4195 @item -fgcse-after-reload
4196 @opindex fgcse-after-reload
4197 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4198 pass is performed after reload. The purpose of this pass is to cleanup
4199 redundant spilling.
4201 @item -floop-optimize
4202 @opindex floop-optimize
4203 Perform loop optimizations: move constant expressions out of loops, simplify
4204 exit test conditions and optionally do strength-reduction and loop unrolling as
4205 well.
4207 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4209 @item -floop-optimize2
4210 @opindex floop-optimize2
4211 Perform loop optimizations using the new loop optimizer.  The optimizations
4212 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4213 by separate flags.
4215 @item -fcrossjumping
4216 @opindex crossjumping
4217 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4218 resulting code may or may not perform better than without cross-jumping.
4220 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4222 @item -fif-conversion
4223 @opindex if-conversion
4224 Attempt to transform conditional jumps into branch-less equivalents.  This
4225 include use of conditional moves, min, max, set flags and abs instructions, and
4226 some tricks doable by standard arithmetics.  The use of conditional execution
4227 on chips where it is available is controlled by @code{if-conversion2}.
4229 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4231 @item -fif-conversion2
4232 @opindex if-conversion2
4233 Use conditional execution (where available) to transform conditional jumps into
4234 branch-less equivalents.
4236 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4238 @item -fdelete-null-pointer-checks
4239 @opindex fdelete-null-pointer-checks
4240 Use global dataflow analysis to identify and eliminate useless checks
4241 for null pointers.  The compiler assumes that dereferencing a null
4242 pointer would have halted the program.  If a pointer is checked after
4243 it has already been dereferenced, it cannot be null.
4245 In some environments, this assumption is not true, and programs can
4246 safely dereference null pointers.  Use
4247 @option{-fno-delete-null-pointer-checks} to disable this optimization
4248 for programs which depend on that behavior.
4250 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4252 @item -fexpensive-optimizations
4253 @opindex fexpensive-optimizations
4254 Perform a number of minor optimizations that are relatively expensive.
4256 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4258 @item -foptimize-register-move
4259 @itemx -fregmove
4260 @opindex foptimize-register-move
4261 @opindex fregmove
4262 Attempt to reassign register numbers in move instructions and as
4263 operands of other simple instructions in order to maximize the amount of
4264 register tying.  This is especially helpful on machines with two-operand
4265 instructions.
4267 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4268 optimization.
4270 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4272 @item -fdelayed-branch
4273 @opindex fdelayed-branch
4274 If supported for the target machine, attempt to reorder instructions
4275 to exploit instruction slots available after delayed branch
4276 instructions.
4278 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4280 @item -fschedule-insns
4281 @opindex fschedule-insns
4282 If supported for the target machine, attempt to reorder instructions to
4283 eliminate execution stalls due to required data being unavailable.  This
4284 helps machines that have slow floating point or memory load instructions
4285 by allowing other instructions to be issued until the result of the load
4286 or floating point instruction is required.
4288 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4290 @item -fschedule-insns2
4291 @opindex fschedule-insns2
4292 Similar to @option{-fschedule-insns}, but requests an additional pass of
4293 instruction scheduling after register allocation has been done.  This is
4294 especially useful on machines with a relatively small number of
4295 registers and where memory load instructions take more than one cycle.
4297 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4299 @item -fno-sched-interblock
4300 @opindex fno-sched-interblock
4301 Don't schedule instructions across basic blocks.  This is normally
4302 enabled by default when scheduling before register allocation, i.e.@:
4303 with @option{-fschedule-insns} or at @option{-O2} or higher.
4305 @item -fno-sched-spec
4306 @opindex fno-sched-spec
4307 Don't allow speculative motion of non-load instructions.  This is normally
4308 enabled by default when scheduling before register allocation, i.e.@:
4309 with @option{-fschedule-insns} or at @option{-O2} or higher.
4311 @item -fsched-spec-load
4312 @opindex fsched-spec-load
4313 Allow speculative motion of some load instructions.  This only makes
4314 sense when scheduling before register allocation, i.e.@: with
4315 @option{-fschedule-insns} or at @option{-O2} or higher.
4317 @item -fsched-spec-load-dangerous
4318 @opindex fsched-spec-load-dangerous
4319 Allow speculative motion of more load instructions.  This only makes
4320 sense when scheduling before register allocation, i.e.@: with
4321 @option{-fschedule-insns} or at @option{-O2} or higher.
4323 @item -fsched-stalled-insns=@var{n}
4324 @opindex fsched-stalled-insns
4325 Define how many insns (if any) can be moved prematurely from the queue
4326 of stalled insns into the ready list, during the second scheduling pass.
4328 @item -fsched-stalled-insns-dep=@var{n}
4329 @opindex fsched-stalled-insns-dep
4330 Define how many insn groups (cycles) will be examined for a dependency
4331 on a stalled insn that is candidate for premature removal from the queue
4332 of stalled insns.  Has an effect only during the second scheduling pass,
4333 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4335 @item -fsched2-use-superblocks
4336 @opindex fsched2-use-superblocks
4337 When scheduling after register allocation, do use superblock scheduling
4338 algorithm.  Superblock scheduling allows motion across basic block boundaries
4339 resulting on faster schedules.  This option is experimental, as not all machine
4340 descriptions used by GCC model the CPU closely enough to avoid unreliable
4341 results from the algorithm.
4343 This only makes sense when scheduling after register allocation, i.e.@: with
4344 @option{-fschedule-insns2} or at @option{-O2} or higher.
4346 @item -fsched2-use-traces
4347 @opindex fsched2-use-traces
4348 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4349 allocation and additionally perform code duplication in order to increase the
4350 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4351 trace formation.
4353 This mode should produce faster but significantly longer programs.  Also
4354 without @code{-fbranch-probabilities} the traces constructed may not match the
4355 reality and hurt the performance.  This only makes
4356 sense when scheduling after register allocation, i.e.@: with
4357 @option{-fschedule-insns2} or at @option{-O2} or higher.
4359 @item -fcaller-saves
4360 @opindex fcaller-saves
4361 Enable values to be allocated in registers that will be clobbered by
4362 function calls, by emitting extra instructions to save and restore the
4363 registers around such calls.  Such allocation is done only when it
4364 seems to result in better code than would otherwise be produced.
4366 This option is always enabled by default on certain machines, usually
4367 those which have no call-preserved registers to use instead.
4369 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4371 @item -ftree-pre
4372 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4373 enabled by default at -O and higher.
4375 @item -ftree-fre
4376 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4377 between FRE and PRE is that FRE only considers expressions
4378 that are computed on all paths leading to the redundant computation.
4379 This analysis faster than PRE, though it exposes fewer redundancies.
4380 This flag is enabled by default at -O and higher.
4382 @item -ftree-ccp
4383 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4384 is enabled by default at -O and higher.
4386 @item -ftree-dce
4387 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4388 default at -O and higher.
4390 @item -ftree-dominator-opts
4391 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4392 default at -O and higher.
4394 @item -ftree-ch
4395 Perform loop header copying on trees.  This is beneficial since it increases
4396 effectivity of code motion optimizations.  It also saves one jump.  This flag
4397 is enabled by default at -O and higher.  It is not enabled for -Os, since it
4398 usually increases code size.
4400 @item -ftree-loop-optimize
4401 Perform loop optimizations on trees.  This flag is enabled by default at -O
4402 and higher.
4404 @item -ftree-lim
4405 Perform loop invariant motion on trees.  This pass moves only invartiants that
4406 would be hard to handle on rtl level (function calls, operations that expand to
4407 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4408 operands of conditions that are invariant out of the loop, so that we can use
4409 just trivial invariantness analysis in loop unswitching.  The pass also includes
4410 store motion.
4412 @item -ftree-sra
4413 Perform scalar replacement of aggregates.  This pass replaces structure
4414 references with scalars to prevent committing structures to memory too
4415 early.  This flag is enabled by default at -O and higher.
4417 @item -ftree-copyrename
4418 Perform copy renaming on trees.  This pass attempts to rename compiler
4419 temporaries to other variables at copy locations, usually resulting in
4420 variable names which more closely resemble the original variables.  This flag
4421 is enabled by default at -O and higher.
4423 @item -ftree-ter
4424 Perform temporary expression replacement during the SSA->normal phase.  Single
4425 use/single def temporaries are replaced at their use location with their
4426 defining expression.  This results in non-GIMPLE code, but gives the expanders
4427 much more complex trees to work on resulting in better RTL generation.  This is
4428 enabled by default at -O and higher.
4430 @item -ftree-lrs
4431 Perform live range splitting during the SSA->normal phase.  Distinct live
4432 ranges of a variable are split into unique variables, allowing for better
4433 optimization later.  This is enabled by default at -O and higher.
4435 @item -ftracer
4436 @opindex ftracer
4437 Perform tail duplication to enlarge superblock size. This transformation
4438 simplifies the control flow of the function allowing other optimizations to do
4439 better job.
4441 @item -funroll-loops
4442 @opindex funroll-loops
4443 Unroll loops whose number of iterations can be determined at compile
4444 time or upon entry to the loop.  @option{-funroll-loops} implies both
4445 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4446 option makes code larger, and may or may not make it run faster.
4448 @item -funroll-all-loops
4449 @opindex funroll-all-loops
4450 Unroll all loops, even if their number of iterations is uncertain when
4451 the loop is entered.  This usually makes programs run more slowly.
4452 @option{-funroll-all-loops} implies the same options as
4453 @option{-funroll-loops},
4455 @item -fprefetch-loop-arrays
4456 @opindex fprefetch-loop-arrays
4457 If supported by the target machine, generate instructions to prefetch
4458 memory to improve the performance of loops that access large arrays.
4460 @item -fmove-all-movables
4461 @opindex fmove-all-movables
4462 Forces all invariant computations in loops to be moved
4463 outside the loop.
4465 @item -freduce-all-givs
4466 @opindex freduce-all-givs
4467 Forces all general-induction variables in loops to be
4468 strength-reduced.
4470 @emph{Note:} When compiling programs written in Fortran,
4471 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4472 by default when you use the optimizer.
4474 These options may generate better or worse code; results are highly
4475 dependent on the structure of loops within the source code.
4477 These two options are intended to be removed someday, once
4478 they have helped determine the efficacy of various
4479 approaches to improving loop optimizations.
4481 Please contact @w{@email{gcc@@gcc.gnu.org}}, and describe how use of
4482 these options affects the performance of your production code.
4483 Examples of code that runs @emph{slower} when these options are
4484 @emph{enabled} are very valuable.
4486 @item -fno-peephole
4487 @itemx -fno-peephole2
4488 @opindex fno-peephole
4489 @opindex fno-peephole2
4490 Disable any machine-specific peephole optimizations.  The difference
4491 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4492 are implemented in the compiler; some targets use one, some use the
4493 other, a few use both.
4495 @option{-fpeephole} is enabled by default.
4496 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4498 @item -fno-guess-branch-probability
4499 @opindex fno-guess-branch-probability
4500 Do not guess branch probabilities using a randomized model.
4502 Sometimes GCC will opt to use a randomized model to guess branch
4503 probabilities, when none are available from either profiling feedback
4504 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4505 different runs of the compiler on the same program may produce different
4506 object code.
4508 In a hard real-time system, people don't want different runs of the
4509 compiler to produce code that has different behavior; minimizing
4510 non-determinism is of paramount import.  This switch allows users to
4511 reduce non-determinism, possibly at the expense of inferior
4512 optimization.
4514 The default is @option{-fguess-branch-probability} at levels
4515 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4517 @item -freorder-blocks
4518 @opindex freorder-blocks
4519 Reorder basic blocks in the compiled function in order to reduce number of
4520 taken branches and improve code locality.
4522 Enabled at levels @option{-O2}, @option{-O3}.
4524 @item -freorder-blocks-and-partition
4525 @opindex freorder-blocks-and-partition
4526 In addition to reordering basic blocks in the compiled function, in order
4527 to reduce number of taken branches, partitions hot and cold basic blocks
4528 into separate sections of the assembly and .o files, to improve
4529 paging and cache locality performance.
4531 @item -freorder-functions
4532 @opindex freorder-functions
4533 Reorder basic blocks in the compiled function in order to reduce number of
4534 taken branches and improve code locality. This is implemented by using special
4535 subsections @code{.text.hot} for most frequently executed functions and
4536 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4537 the linker so object file format must support named sections and linker must
4538 place them in a reasonable way.
4540 Also profile feedback must be available in to make this option effective.  See
4541 @option{-fprofile-arcs} for details.
4543 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4545 @item -fstrict-aliasing
4546 @opindex fstrict-aliasing
4547 Allows the compiler to assume the strictest aliasing rules applicable to
4548 the language being compiled.  For C (and C++), this activates
4549 optimizations based on the type of expressions.  In particular, an
4550 object of one type is assumed never to reside at the same address as an
4551 object of a different type, unless the types are almost the same.  For
4552 example, an @code{unsigned int} can alias an @code{int}, but not a
4553 @code{void*} or a @code{double}.  A character type may alias any other
4554 type.
4556 Pay special attention to code like this:
4557 @smallexample
4558 union a_union @{
4559   int i;
4560   double d;
4563 int f() @{
4564   a_union t;
4565   t.d = 3.0;
4566   return t.i;
4568 @end smallexample
4569 The practice of reading from a different union member than the one most
4570 recently written to (called ``type-punning'') is common.  Even with
4571 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4572 is accessed through the union type.  So, the code above will work as
4573 expected.  However, this code might not:
4574 @smallexample
4575 int f() @{
4576   a_union t;
4577   int* ip;
4578   t.d = 3.0;
4579   ip = &t.i;
4580   return *ip;
4582 @end smallexample
4584 Every language that wishes to perform language-specific alias analysis
4585 should define a function that computes, given an @code{tree}
4586 node, an alias set for the node.  Nodes in different alias sets are not
4587 allowed to alias.  For an example, see the C front-end function
4588 @code{c_get_alias_set}.
4590 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4592 @item -falign-functions
4593 @itemx -falign-functions=@var{n}
4594 @opindex falign-functions
4595 Align the start of functions to the next power-of-two greater than
4596 @var{n}, skipping up to @var{n} bytes.  For instance,
4597 @option{-falign-functions=32} aligns functions to the next 32-byte
4598 boundary, but @option{-falign-functions=24} would align to the next
4599 32-byte boundary only if this can be done by skipping 23 bytes or less.
4601 @option{-fno-align-functions} and @option{-falign-functions=1} are
4602 equivalent and mean that functions will not be aligned.
4604 Some assemblers only support this flag when @var{n} is a power of two;
4605 in that case, it is rounded up.
4607 If @var{n} is not specified or is zero, use a machine-dependent default.
4609 Enabled at levels @option{-O2}, @option{-O3}.
4611 @item -falign-labels
4612 @itemx -falign-labels=@var{n}
4613 @opindex falign-labels
4614 Align all branch targets to a power-of-two boundary, skipping up to
4615 @var{n} bytes like @option{-falign-functions}.  This option can easily
4616 make code slower, because it must insert dummy operations for when the
4617 branch target is reached in the usual flow of the code.
4619 @option{-fno-align-labels} and @option{-falign-labels=1} are
4620 equivalent and mean that labels will not be aligned.
4622 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4623 are greater than this value, then their values are used instead.
4625 If @var{n} is not specified or is zero, use a machine-dependent default
4626 which is very likely to be @samp{1}, meaning no alignment.
4628 Enabled at levels @option{-O2}, @option{-O3}.
4630 @item -falign-loops
4631 @itemx -falign-loops=@var{n}
4632 @opindex falign-loops
4633 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4634 like @option{-falign-functions}.  The hope is that the loop will be
4635 executed many times, which will make up for any execution of the dummy
4636 operations.
4638 @option{-fno-align-loops} and @option{-falign-loops=1} are
4639 equivalent and mean that loops will not be aligned.
4641 If @var{n} is not specified or is zero, use a machine-dependent default.
4643 Enabled at levels @option{-O2}, @option{-O3}.
4645 @item -falign-jumps
4646 @itemx -falign-jumps=@var{n}
4647 @opindex falign-jumps
4648 Align branch targets to a power-of-two boundary, for branch targets
4649 where the targets can only be reached by jumping, skipping up to @var{n}
4650 bytes like @option{-falign-functions}.  In this case, no dummy operations
4651 need be executed.
4653 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4654 equivalent and mean that loops will not be aligned.
4656 If @var{n} is not specified or is zero, use a machine-dependent default.
4658 Enabled at levels @option{-O2}, @option{-O3}.
4660 @item -funit-at-a-time
4661 @opindex funit-at-a-time
4662 Parse the whole compilation unit before starting to produce code.
4663 This allows some extra optimizations to take place but consumes
4664 more memory (in general).  There are some compatibility issues
4665 with @emph{unit-at-at-time} mode:
4666 @itemize @bullet
4667 @item
4668 enabling @emph{unit-at-a-time} mode may change the order
4669 in which functions, variables, and top-level @code{asm} statements
4670 are emitted, and will likely break code relying on some particular
4671 ordering.  The majority of such top-level @code{asm} statements,
4672 though, can be replaced by @code{section} attributes.
4674 @item
4675 @emph{unit-at-a-time} mode removes unreferenced static variables
4676 and functions are removed.  This may result in undefined references
4677 when an @code{asm} statement refers directly to variables or functions
4678 that are otherwise unused.  In that case either the variable/function
4679 shall be listed as an operand of the @code{asm} statement operand or,
4680 in the case of top-level @code{asm} statements the attribute @code{used}
4681 shall be used on the declaration.
4683 @item
4684 Static functions now can use non-standard passing conventions that
4685 may break @code{asm} statements calling functions directly. Again,
4686 attribute @code{used} will prevent this behavior.
4687 @end itemize
4689 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4690 but this scheme may not be supported by future releases of GCC.
4692 Enabled at levels @option{-O2}, @option{-O3}.
4694 @item -fweb
4695 @opindex fweb
4696 Constructs webs as commonly used for register allocation purposes and assign
4697 each web individual pseudo register.  This allows the register allocation pass
4698 to operate on pseudos directly, but also strengthens several other optimization
4699 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4700 however, make debugging impossible, since variables will no longer stay in a
4701 ``home register''.
4703 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4704 on targets where the default format for debugging information supports
4705 variable tracking.
4707 @item -fno-cprop-registers
4708 @opindex fno-cprop-registers
4709 After register allocation and post-register allocation instruction splitting,
4710 we perform a copy-propagation pass to try to reduce scheduling dependencies
4711 and occasionally eliminate the copy.
4713 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4715 @item -fprofile-generate
4716 @opindex fprofile-generate
4718 Enable options usually used for instrumenting application to produce
4719 profile useful for later recompilation with profile feedback based
4720 optimization.  You must use @code{-fprofile-generate} both when
4721 compiling and when linking your program.
4723 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4725 @item -fprofile-use
4726 @opindex fprofile-use
4727 Enable profile feedback directed optimizations, and optimizations
4728 generally profitable only with profile feedback available.
4730 The following options are enabled: @code{-fbranch-probabilities},
4731 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4733 @end table
4735 The following options control compiler behavior regarding floating
4736 point arithmetic.  These options trade off between speed and
4737 correctness.  All must be specifically enabled.
4739 @table @gcctabopt
4740 @item -ffloat-store
4741 @opindex ffloat-store
4742 Do not store floating point variables in registers, and inhibit other
4743 options that might change whether a floating point value is taken from a
4744 register or memory.
4746 @cindex floating point precision
4747 This option prevents undesirable excess precision on machines such as
4748 the 68000 where the floating registers (of the 68881) keep more
4749 precision than a @code{double} is supposed to have.  Similarly for the
4750 x86 architecture.  For most programs, the excess precision does only
4751 good, but a few programs rely on the precise definition of IEEE floating
4752 point.  Use @option{-ffloat-store} for such programs, after modifying
4753 them to store all pertinent intermediate computations into variables.
4755 @item -ffast-math
4756 @opindex ffast-math
4757 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4758 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4759 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4761 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4763 This option should never be turned on by any @option{-O} option since
4764 it can result in incorrect output for programs which depend on
4765 an exact implementation of IEEE or ISO rules/specifications for
4766 math functions.
4768 @item -fno-math-errno
4769 @opindex fno-math-errno
4770 Do not set ERRNO after calling math functions that are executed
4771 with a single instruction, e.g., sqrt.  A program that relies on
4772 IEEE exceptions for math error handling may want to use this flag
4773 for speed while maintaining IEEE arithmetic compatibility.
4775 This option should never be turned on by any @option{-O} option since
4776 it can result in incorrect output for programs which depend on
4777 an exact implementation of IEEE or ISO rules/specifications for
4778 math functions.
4780 The default is @option{-fmath-errno}.
4782 @item -funsafe-math-optimizations
4783 @opindex funsafe-math-optimizations
4784 Allow optimizations for floating-point arithmetic that (a) assume
4785 that arguments and results are valid and (b) may violate IEEE or
4786 ANSI standards.  When used at link-time, it may include libraries
4787 or startup files that change the default FPU control word or other
4788 similar optimizations.
4790 This option should never be turned on by any @option{-O} option since
4791 it can result in incorrect output for programs which depend on
4792 an exact implementation of IEEE or ISO rules/specifications for
4793 math functions.
4795 The default is @option{-fno-unsafe-math-optimizations}.
4797 @item -ffinite-math-only
4798 @opindex ffinite-math-only
4799 Allow optimizations for floating-point arithmetic that assume
4800 that arguments and results are not NaNs or +-Infs.
4802 This option should never be turned on by any @option{-O} option since
4803 it can result in incorrect output for programs which depend on
4804 an exact implementation of IEEE or ISO rules/specifications.
4806 The default is @option{-fno-finite-math-only}.
4808 @item -fno-trapping-math
4809 @opindex fno-trapping-math
4810 Compile code assuming that floating-point operations cannot generate
4811 user-visible traps.  These traps include division by zero, overflow,
4812 underflow, inexact result and invalid operation.  This option implies
4813 @option{-fno-signaling-nans}.  Setting this option may allow faster
4814 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4816 This option should never be turned on by any @option{-O} option since
4817 it can result in incorrect output for programs which depend on
4818 an exact implementation of IEEE or ISO rules/specifications for
4819 math functions.
4821 The default is @option{-ftrapping-math}.
4823 @item -frounding-math
4824 @opindex frounding-math
4825 Disable transformations and optimizations that assume default floating
4826 point rounding behavior.  This is round-to-zero for all floating point
4827 to integer conversions, and round-to-nearest for all other arithmetic
4828 truncations.  This option should be specified for programs that change
4829 the FP rounding mode dynamically, or that may be executed with a
4830 non-default rounding mode.  This option disables constant folding of
4831 floating point expressions at compile-time (which may be affected by
4832 rounding mode) and arithmetic transformations that are unsafe in the
4833 presence of sign-dependent rounding modes.
4835 The default is @option{-fno-rounding-math}.
4837 This option is experimental and does not currently guarantee to
4838 disable all GCC optimizations that are affected by rounding mode.
4839 Future versions of GCC may provide finer control of this setting
4840 using C99's @code{FENV_ACCESS} pragma.  This command line option
4841 will be used to specify the default state for @code{FENV_ACCESS}.
4843 @item -fsignaling-nans
4844 @opindex fsignaling-nans
4845 Compile code assuming that IEEE signaling NaNs may generate user-visible
4846 traps during floating-point operations.  Setting this option disables
4847 optimizations that may change the number of exceptions visible with
4848 signaling NaNs.  This option implies @option{-ftrapping-math}.
4850 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4851 be defined.
4853 The default is @option{-fno-signaling-nans}.
4855 This option is experimental and does not currently guarantee to
4856 disable all GCC optimizations that affect signaling NaN behavior.
4858 @item -fsingle-precision-constant
4859 @opindex fsingle-precision-constant
4860 Treat floating point constant as single precision constant instead of
4861 implicitly converting it to double precision constant.
4864 @end table
4866 The following options control optimizations that may improve
4867 performance, but are not enabled by any @option{-O} options.  This
4868 section includes experimental options that may produce broken code.
4870 @table @gcctabopt
4871 @item -fbranch-probabilities
4872 @opindex fbranch-probabilities
4873 After running a program compiled with @option{-fprofile-arcs}
4874 (@pxref{Debugging Options,, Options for Debugging Your Program or
4875 @command{gcc}}), you can compile it a second time using
4876 @option{-fbranch-probabilities}, to improve optimizations based on
4877 the number of times each branch was taken.  When the program
4878 compiled with @option{-fprofile-arcs} exits it saves arc execution
4879 counts to a file called @file{@var{sourcename}.gcda} for each source
4880 file  The information in this data file is very dependent on the
4881 structure of the generated code, so you must use the same source code
4882 and the same optimization options for both compilations.
4884 With @option{-fbranch-probabilities}, GCC puts a
4885 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4886 These can be used to improve optimization.  Currently, they are only
4887 used in one place: in @file{reorg.c}, instead of guessing which path a
4888 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4889 exactly determine which path is taken more often.
4891 @item -fprofile-values
4892 @opindex fprofile-values
4893 If combined with @option{-fprofile-arcs}, it adds code so that some
4894 data about values of expressions in the program is gathered.
4896 With @option{-fbranch-probabilities}, it reads back the data gathered
4897 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
4898 notes to instructions for their later usage in optimizations.
4900 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
4902 @item -fvpt
4903 @opindex fvpt
4904 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
4905 a code to gather information about values of expressions.
4907 With @option{-fbranch-probabilities}, it reads back the data gathered
4908 and actually performs the optimizations based on them.
4909 Currently the optimizations include specialization of division operation
4910 using the knowledge about the value of the denominator.
4912 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
4914 @item -frename-registers
4915 @opindex frename-registers
4916 Attempt to avoid false dependencies in scheduled code by making use
4917 of registers left over after register allocation.  This optimization
4918 will most benefit processors with lots of registers.  Depending on the
4919 debug information format adopted by the target, however, it can
4920 make debugging impossible, since variables will no longer stay in
4921 a ``home register''.
4923 Not enabled by default at any level because it has known bugs.
4925 @item -fnew-ra
4926 @opindex fnew-ra
4927 Use a graph coloring register allocator.  Currently this option is meant
4928 for testing, so we are interested to hear about miscompilations with
4929 @option{-fnew-ra}.
4931 @item -ftracer
4932 @opindex ftracer
4933 Perform tail duplication to enlarge superblock size. This transformation
4934 simplifies the control flow of the function allowing other optimizations to do
4935 better job.
4937 Enabled with @option{-fprofile-use}.
4939 @item -funroll-loops
4940 @opindex funroll-loops
4941 Unroll loops whose number of iterations can be determined at compile time or
4942 upon entry to the loop.  @option{-funroll-loops} implies
4943 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
4944 (i.e. complete removal of loops with small constant number of iterations).
4945 This option makes code larger, and may or may not make it run faster.
4947 Enabled with @option{-fprofile-use}.
4949 @item -funroll-all-loops
4950 @opindex funroll-all-loops
4951 Unroll all loops, even if their number of iterations is uncertain when
4952 the loop is entered.  This usually makes programs run more slowly.
4953 @option{-funroll-all-loops} implies the same options as
4954 @option{-funroll-loops}.
4956 @item -fpeel-loops
4957 @opindex fpeel-loops
4958 Peels the loops for that there is enough information that they do not
4959 roll much (from profile feedback).  It also turns on complete loop peeling
4960 (i.e. complete removal of loops with small constant number of iterations).
4962 Enabled with @option{-fprofile-use}.
4964 @item -fmove-loop-invariants
4965 @opindex fmove-loop-invariants
4966 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
4967 at level @option{-O1}
4969 @item -funswitch-loops
4970 @opindex funswitch-loops
4971 Move branches with loop invariant conditions out of the loop, with duplicates
4972 of the loop on both branches (modified according to result of the condition).
4974 @item -fold-unroll-loops
4975 @opindex fold-unroll-loops
4976 Unroll loops whose number of iterations can be determined at compile
4977 time or upon entry to the loop, using the old loop unroller whose loop
4978 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
4979 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4980 option makes code larger, and may or may not make it run faster.
4982 @item -fold-unroll-all-loops
4983 @opindex fold-unroll-all-loops
4984 Unroll all loops, even if their number of iterations is uncertain when
4985 the loop is entered. This is done using the old loop unroller whose loop
4986 recognition is based on notes from frontend.  This usually makes programs run more slowly.
4987 @option{-fold-unroll-all-loops} implies the same options as
4988 @option{-fold-unroll-loops}.
4990 @item -fprefetch-loop-arrays
4991 @opindex fprefetch-loop-arrays
4992 If supported by the target machine, generate instructions to prefetch
4993 memory to improve the performance of loops that access large arrays.
4995 Disabled at level @option{-Os}.
4997 @item -ffunction-sections
4998 @itemx -fdata-sections
4999 @opindex ffunction-sections
5000 @opindex fdata-sections
5001 Place each function or data item into its own section in the output
5002 file if the target supports arbitrary sections.  The name of the
5003 function or the name of the data item determines the section's name
5004 in the output file.
5006 Use these options on systems where the linker can perform optimizations
5007 to improve locality of reference in the instruction space.  Most systems
5008 using the ELF object format and SPARC processors running Solaris 2 have
5009 linkers with such optimizations.  AIX may have these optimizations in
5010 the future.
5012 Only use these options when there are significant benefits from doing
5013 so.  When you specify these options, the assembler and linker will
5014 create larger object and executable files and will also be slower.
5015 You will not be able to use @code{gprof} on all systems if you
5016 specify this option and you may have problems with debugging if
5017 you specify both this option and @option{-g}.
5019 @item -fbranch-target-load-optimize
5020 @opindex fbranch-target-load-optimize
5021 Perform branch target register load optimization before prologue / epilogue
5022 threading.
5023 The use of target registers can typically be exposed only during reload,
5024 thus hoisting loads out of loops and doing inter-block scheduling needs
5025 a separate optimization pass.
5027 @item -fbranch-target-load-optimize2
5028 @opindex fbranch-target-load-optimize2
5029 Perform branch target register load optimization after prologue / epilogue
5030 threading.
5032 @item -fbtr-bb-exclusive
5033 @opindex fbtr-bb-exclusive
5034 When performing branch target register load optimization, don't reuse
5035 branch target registers in within any basic block.
5037 @item --param @var{name}=@var{value}
5038 @opindex param
5039 In some places, GCC uses various constants to control the amount of
5040 optimization that is done.  For example, GCC will not inline functions
5041 that contain more that a certain number of instructions.  You can
5042 control some of these constants on the command-line using the
5043 @option{--param} option.
5045 The names of specific parameters, and the meaning of the values, are
5046 tied to the internals of the compiler, and are subject to change
5047 without notice in future releases.
5049 In each case, the @var{value} is an integer.  The allowable choices for
5050 @var{name} are given in the following table:
5052 @table @gcctabopt
5053 @item max-crossjump-edges
5054 The maximum number of incoming edges to consider for crossjumping.
5055 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5056 the number of edges incoming to each block.  Increasing values mean
5057 more aggressive optimization, making the compile time increase with
5058 probably small improvement in executable size.
5060 @item max-delay-slot-insn-search
5061 The maximum number of instructions to consider when looking for an
5062 instruction to fill a delay slot.  If more than this arbitrary number of
5063 instructions is searched, the time savings from filling the delay slot
5064 will be minimal so stop searching.  Increasing values mean more
5065 aggressive optimization, making the compile time increase with probably
5066 small improvement in executable run time.
5068 @item max-delay-slot-live-search
5069 When trying to fill delay slots, the maximum number of instructions to
5070 consider when searching for a block with valid live register
5071 information.  Increasing this arbitrarily chosen value means more
5072 aggressive optimization, increasing the compile time.  This parameter
5073 should be removed when the delay slot code is rewritten to maintain the
5074 control-flow graph.
5076 @item max-gcse-memory
5077 The approximate maximum amount of memory that will be allocated in
5078 order to perform the global common subexpression elimination
5079 optimization.  If more memory than specified is required, the
5080 optimization will not be done.
5082 @item max-gcse-passes
5083 The maximum number of passes of GCSE to run.  The default is 1.
5085 @item max-pending-list-length
5086 The maximum number of pending dependencies scheduling will allow
5087 before flushing the current state and starting over.  Large functions
5088 with few branches or calls can create excessively large lists which
5089 needlessly consume memory and resources.
5091 @item max-inline-insns-single
5092 Several parameters control the tree inliner used in gcc.
5093 This number sets the maximum number of instructions (counted in GCC's
5094 internal representation) in a single function that the tree inliner
5095 will consider for inlining.  This only affects functions declared
5096 inline and methods implemented in a class declaration (C++).
5097 The default value is 500.
5099 @item max-inline-insns-auto
5100 When you use @option{-finline-functions} (included in @option{-O3}),
5101 a lot of functions that would otherwise not be considered for inlining
5102 by the compiler will be investigated.  To those functions, a different
5103 (more restrictive) limit compared to functions declared inline can
5104 be applied.
5105 The default value is 120.
5107 @item large-function-insns
5108 The limit specifying really large functions.  For functions greater than this
5109 limit inlining is constrained by @option{--param large-function-growth}.
5110 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
5111 algorithms used by the backend.
5112 This parameter is ignored when @option{-funit-at-a-time} is not used.
5113 The default value is 3000.
5115 @item large-function-growth
5116 Specifies maximal growth of large function caused by inlining in percents.
5117 This parameter is ignored when @option{-funit-at-a-time} is not used.
5118 The default value is 200.
5120 @item inline-unit-growth
5121 Specifies maximal overall growth of the compilation unit caused by inlining.
5122 This parameter is ignored when @option{-funit-at-a-time} is not used.
5123 The default value is 150.
5125 @item max-inline-insns-recursive
5126 @itemx max-inline-insns-recursive-auto
5127 Specifies maximum number of instructions out-of-line copy of self recursive inline
5128 function can grow into by performing recursive inlining.
5130 For functions declared inline @option{--param max-inline-insns-recursive} is
5131 taken into acount.  For function not declared inline, recursive inlining
5132 happens only when @option{-finline-functions} (included in @option{-O3}) is
5133 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5134 default value is 500.
5136 @item max-inline-recursive-depth
5137 @itemx max-inline-recursive-depth-auto
5138 Specifies maximum recursion depth used by the recursive inlining.
5140 For functions declared inline @option{--param max-inline-recursive-depth} is
5141 taken into acount.  For function not declared inline, recursive inlining
5142 happens only when @option{-finline-functions} (included in @option{-O3}) is
5143 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5144 default value is 500.
5146 @item max-inline-insns-rtl
5147 For languages that use the RTL inliner (this happens at a later stage
5148 than tree inlining), you can set the maximum allowable size (counted
5149 in RTL instructions) for the RTL inliner with this parameter.
5150 The default value is 600.
5152 @item max-unrolled-insns
5153 The maximum number of instructions that a loop should have if that loop
5154 is unrolled, and if the loop is unrolled, it determines how many times
5155 the loop code is unrolled.
5157 @item max-average-unrolled-insns
5158 The maximum number of instructions biased by probabilities of their execution
5159 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5160 it determines how many times the loop code is unrolled.
5162 @item max-unroll-times
5163 The maximum number of unrollings of a single loop.
5165 @item max-peeled-insns
5166 The maximum number of instructions that a loop should have if that loop
5167 is peeled, and if the loop is peeled, it determines how many times
5168 the loop code is peeled.
5170 @item max-peel-times
5171 The maximum number of peelings of a single loop.
5173 @item max-completely-peeled-insns
5174 The maximum number of insns of a completely peeled loop.
5176 @item max-completely-peel-times
5177 The maximum number of iterations of a loop to be suitable for complete peeling.
5179 @item max-unswitch-insns
5180 The maximum number of insns of an unswitched loop.
5182 @item max-unswitch-level
5183 The maximum number of branches unswitched in a single loop.
5185 @item lim-expensive
5186 The minimum cost of an expensive expression in the loop invariant motion.
5188 @item max-iterations-to-track
5190 The maximum number of iterations of a loop the brute force algorithm
5191 for analysis of # of iterations of the loop tries to evaluate.
5193 @item hot-bb-count-fraction
5194 Select fraction of the maximal count of repetitions of basic block in program
5195 given basic block needs to have to be considered hot.
5197 @item hot-bb-frequency-fraction
5198 Select fraction of the maximal frequency of executions of basic block in
5199 function given basic block needs to have to be considered hot
5201 @item tracer-dynamic-coverage
5202 @itemx tracer-dynamic-coverage-feedback
5204 This value is used to limit superblock formation once the given percentage of
5205 executed instructions is covered.  This limits unnecessary code size
5206 expansion.
5208 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5209 feedback is available.  The real profiles (as opposed to statically estimated
5210 ones) are much less balanced allowing the threshold to be larger value.
5212 @item tracer-max-code-growth
5213 Stop tail duplication once code growth has reached given percentage.  This is
5214 rather hokey argument, as most of the duplicates will be eliminated later in
5215 cross jumping, so it may be set to much higher values than is the desired code
5216 growth.
5218 @item tracer-min-branch-ratio
5220 Stop reverse growth when the reverse probability of best edge is less than this
5221 threshold (in percent).
5223 @item tracer-min-branch-ratio
5224 @itemx tracer-min-branch-ratio-feedback
5226 Stop forward growth if the best edge do have probability lower than this
5227 threshold.
5229 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5230 compilation for profile feedback and one for compilation without.  The value
5231 for compilation with profile feedback needs to be more conservative (higher) in
5232 order to make tracer effective.
5234 @item max-cse-path-length
5236 Maximum number of basic blocks on path that cse considers.  The default is 10.
5238 @item global-var-threshold
5240 Counts the number of function calls (N) and the number of
5241 call-clobbered variables (V).  If NxV is larger than this limit, a
5242 single artificial variable will be created to represent all the
5243 call-clobbered variables at function call sites.  This artificial
5244 variable will then be made to alias every call-clobbered variable.
5245 (done as int * size_t on the host machine; beware overflow).
5247 @item max-aliased-vops
5249 Maxiumum number of virtual operands allowed to represent aliases
5250 before triggering the alias grouping heuristic.  Alias grouping
5251 reduces compile times and memory consumption needed for aliasing at
5252 the expense of precision loss in alias information.
5254 @item ggc-min-expand
5256 GCC uses a garbage collector to manage its own memory allocation.  This
5257 parameter specifies the minimum percentage by which the garbage
5258 collector's heap should be allowed to expand between collections.
5259 Tuning this may improve compilation speed; it has no effect on code
5260 generation.
5262 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5263 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
5264 the smallest of actual RAM, RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If
5265 GCC is not able to calculate RAM on a particular platform, the lower
5266 bound of 30% is used.  Setting this parameter and
5267 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5268 every opportunity.  This is extremely slow, but can be useful for
5269 debugging.
5271 @item ggc-min-heapsize
5273 Minimum size of the garbage collector's heap before it begins bothering
5274 to collect garbage.  The first collection occurs after the heap expands
5275 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5276 tuning this may improve compilation speed, and has no effect on code
5277 generation.
5279 The default is RAM/8, with a lower bound of 4096 (four megabytes) and an
5280 upper bound of 131072 (128 megabytes).  If @code{getrlimit} is
5281 available, the notion of "RAM" is the smallest of actual RAM,
5282 RLIMIT_RSS, RLIMIT_DATA and RLIMIT_AS.  If GCC is not able to calculate
5283 RAM on a particular platform, the lower bound is used.  Setting this
5284 parameter very large effectively disables garbage collection.  Setting
5285 this parameter and @option{ggc-min-expand} to zero causes a full
5286 collection to occur at every opportunity.
5288 @item max-reload-search-insns
5289 The maximum number of instruction reload should look backward for equivalent
5290 register.  Increasing values mean more aggressive optimization, making the
5291 compile time increase with probably slightly better performance.  The default
5292 value is 100.
5294 @item max-cselib-memory-location
5295 The maximum number of memory locations cselib should take into acount.
5296 Increasing values mean more aggressive optimization, making the compile time
5297 increase with probably slightly better performance.  The default value is 500.
5299 @item reorder-blocks-duplicate
5300 @itemx reorder-blocks-duplicate-feedback
5302 Used by basic block reordering pass to decide whether to use unconditional
5303 branch or duplicate the code on its destination.  Code is duplicated when its
5304 estimated size is smaller than this value multiplied by the estimated size of
5305 unconditional jump in the hot spots of the program.
5307 The @option{reorder-block-duplicate-feedback} is used only when profile
5308 feedback is available and may be set to higher values than
5309 @option{reorder-block-duplicate} since information about the hot spots is more
5310 accurate.
5312 @item max-sched-region-blocks
5313 The maximum number of blocks in a region to be considered for
5314 interblock scheduling.  The default value is 10.
5316 @item max-sched-region-insns
5317 The maximum number of insns in a region to be considered for
5318 interblock scheduling.  The default value is 100.
5319 @end table
5320 @end table
5322 @node Preprocessor Options
5323 @section Options Controlling the Preprocessor
5324 @cindex preprocessor options
5325 @cindex options, preprocessor
5327 These options control the C preprocessor, which is run on each C source
5328 file before actual compilation.
5330 If you use the @option{-E} option, nothing is done except preprocessing.
5331 Some of these options make sense only together with @option{-E} because
5332 they cause the preprocessor output to be unsuitable for actual
5333 compilation.
5335 @table @gcctabopt
5336 @opindex Wp
5337 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5338 and pass @var{option} directly through to the preprocessor.  If
5339 @var{option} contains commas, it is split into multiple options at the
5340 commas.  However, many options are modified, translated or interpreted
5341 by the compiler driver before being passed to the preprocessor, and
5342 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5343 interface is undocumented and subject to change, so whenever possible
5344 you should avoid using @option{-Wp} and let the driver handle the
5345 options instead.
5347 @item -Xpreprocessor @var{option}
5348 @opindex preprocessor
5349 Pass @var{option} as an option to the preprocessor.  You can use this to
5350 supply system-specific preprocessor options which GCC does not know how to
5351 recognize.
5353 If you want to pass an option that takes an argument, you must use
5354 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5355 @end table
5357 @include cppopts.texi
5359 @node Assembler Options
5360 @section Passing Options to the Assembler
5362 @c prevent bad page break with this line
5363 You can pass options to the assembler.
5365 @table @gcctabopt
5366 @item -Wa,@var{option}
5367 @opindex Wa
5368 Pass @var{option} as an option to the assembler.  If @var{option}
5369 contains commas, it is split into multiple options at the commas.
5371 @item -Xassembler @var{option}
5372 @opindex Xassembler
5373 Pass @var{option} as an option to the assembler.  You can use this to
5374 supply system-specific assembler options which GCC does not know how to
5375 recognize.
5377 If you want to pass an option that takes an argument, you must use
5378 @option{-Xassembler} twice, once for the option and once for the argument.
5380 @end table
5382 @node Link Options
5383 @section Options for Linking
5384 @cindex link options
5385 @cindex options, linking
5387 These options come into play when the compiler links object files into
5388 an executable output file.  They are meaningless if the compiler is
5389 not doing a link step.
5391 @table @gcctabopt
5392 @cindex file names
5393 @item @var{object-file-name}
5394 A file name that does not end in a special recognized suffix is
5395 considered to name an object file or library.  (Object files are
5396 distinguished from libraries by the linker according to the file
5397 contents.)  If linking is done, these object files are used as input
5398 to the linker.
5400 @item -c
5401 @itemx -S
5402 @itemx -E
5403 @opindex c
5404 @opindex S
5405 @opindex E
5406 If any of these options is used, then the linker is not run, and
5407 object file names should not be used as arguments.  @xref{Overall
5408 Options}.
5410 @cindex Libraries
5411 @item -l@var{library}
5412 @itemx -l @var{library}
5413 @opindex l
5414 Search the library named @var{library} when linking.  (The second
5415 alternative with the library as a separate argument is only for
5416 POSIX compliance and is not recommended.)
5418 It makes a difference where in the command you write this option; the
5419 linker searches and processes libraries and object files in the order they
5420 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5421 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5422 to functions in @samp{z}, those functions may not be loaded.
5424 The linker searches a standard list of directories for the library,
5425 which is actually a file named @file{lib@var{library}.a}.  The linker
5426 then uses this file as if it had been specified precisely by name.
5428 The directories searched include several standard system directories
5429 plus any that you specify with @option{-L}.
5431 Normally the files found this way are library files---archive files
5432 whose members are object files.  The linker handles an archive file by
5433 scanning through it for members which define symbols that have so far
5434 been referenced but not defined.  But if the file that is found is an
5435 ordinary object file, it is linked in the usual fashion.  The only
5436 difference between using an @option{-l} option and specifying a file name
5437 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5438 and searches several directories.
5440 @item -lobjc
5441 @opindex lobjc
5442 You need this special case of the @option{-l} option in order to
5443 link an Objective-C program.
5445 @item -nostartfiles
5446 @opindex nostartfiles
5447 Do not use the standard system startup files when linking.
5448 The standard system libraries are used normally, unless @option{-nostdlib}
5449 or @option{-nodefaultlibs} is used.
5451 @item -nodefaultlibs
5452 @opindex nodefaultlibs
5453 Do not use the standard system libraries when linking.
5454 Only the libraries you specify will be passed to the linker.
5455 The standard startup files are used normally, unless @option{-nostartfiles}
5456 is used.  The compiler may generate calls to @code{memcmp},
5457 @code{memset}, @code{memcpy} and @code{memmove}.
5458 These entries are usually resolved by entries in
5459 libc.  These entry points should be supplied through some other
5460 mechanism when this option is specified.
5462 @item -nostdlib
5463 @opindex nostdlib
5464 Do not use the standard system startup files or libraries when linking.
5465 No startup files and only the libraries you specify will be passed to
5466 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5467 @code{memcpy} and @code{memmove}.
5468 These entries are usually resolved by entries in
5469 libc.  These entry points should be supplied through some other
5470 mechanism when this option is specified.
5472 @cindex @option{-lgcc}, use with @option{-nostdlib}
5473 @cindex @option{-nostdlib} and unresolved references
5474 @cindex unresolved references and @option{-nostdlib}
5475 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5476 @cindex @option{-nodefaultlibs} and unresolved references
5477 @cindex unresolved references and @option{-nodefaultlibs}
5478 One of the standard libraries bypassed by @option{-nostdlib} and
5479 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5480 that GCC uses to overcome shortcomings of particular machines, or special
5481 needs for some languages.
5482 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5483 Collection (GCC) Internals},
5484 for more discussion of @file{libgcc.a}.)
5485 In most cases, you need @file{libgcc.a} even when you want to avoid
5486 other standard libraries.  In other words, when you specify @option{-nostdlib}
5487 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5488 This ensures that you have no unresolved references to internal GCC
5489 library subroutines.  (For example, @samp{__main}, used to ensure C++
5490 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5491 GNU Compiler Collection (GCC) Internals}.)
5493 @item -pie
5494 @opindex pie
5495 Produce a position independent executable on targets which support it.
5496 For predictable results, you must also specify the same set of options
5497 that were used to generate code (@option{-fpie}, @option{-fPIE},
5498 or model suboptions) when you specify this option.
5500 @item -s
5501 @opindex s
5502 Remove all symbol table and relocation information from the executable.
5504 @item -static
5505 @opindex static
5506 On systems that support dynamic linking, this prevents linking with the shared
5507 libraries.  On other systems, this option has no effect.
5509 @item -shared
5510 @opindex shared
5511 Produce a shared object which can then be linked with other objects to
5512 form an executable.  Not all systems support this option.  For predictable
5513 results, you must also specify the same set of options that were used to
5514 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5515 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5516 needs to build supplementary stub code for constructors to work.  On
5517 multi-libbed systems, @samp{gcc -shared} must select the correct support
5518 libraries to link against.  Failing to supply the correct flags may lead
5519 to subtle defects.  Supplying them in cases where they are not necessary
5520 is innocuous.}
5522 @item -shared-libgcc
5523 @itemx -static-libgcc
5524 @opindex shared-libgcc
5525 @opindex static-libgcc
5526 On systems that provide @file{libgcc} as a shared library, these options
5527 force the use of either the shared or static version respectively.
5528 If no shared version of @file{libgcc} was built when the compiler was
5529 configured, these options have no effect.
5531 There are several situations in which an application should use the
5532 shared @file{libgcc} instead of the static version.  The most common
5533 of these is when the application wishes to throw and catch exceptions
5534 across different shared libraries.  In that case, each of the libraries
5535 as well as the application itself should use the shared @file{libgcc}.
5537 Therefore, the G++ and GCJ drivers automatically add
5538 @option{-shared-libgcc} whenever you build a shared library or a main
5539 executable, because C++ and Java programs typically use exceptions, so
5540 this is the right thing to do.
5542 If, instead, you use the GCC driver to create shared libraries, you may
5543 find that they will not always be linked with the shared @file{libgcc}.
5544 If GCC finds, at its configuration time, that you have a non-GNU linker
5545 or a GNU linker that does not support option @option{--eh-frame-hdr},
5546 it will link the shared version of @file{libgcc} into shared libraries
5547 by default.  Otherwise, it will take advantage of the linker and optimize
5548 away the linking with the shared version of @file{libgcc}, linking with
5549 the static version of libgcc by default.  This allows exceptions to
5550 propagate through such shared libraries, without incurring relocation
5551 costs at library load time.
5553 However, if a library or main executable is supposed to throw or catch
5554 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5555 for the languages used in the program, or using the option
5556 @option{-shared-libgcc}, such that it is linked with the shared
5557 @file{libgcc}.
5559 @item -symbolic
5560 @opindex symbolic
5561 Bind references to global symbols when building a shared object.  Warn
5562 about any unresolved references (unless overridden by the link editor
5563 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5564 this option.
5566 @item -Xlinker @var{option}
5567 @opindex Xlinker
5568 Pass @var{option} as an option to the linker.  You can use this to
5569 supply system-specific linker options which GCC does not know how to
5570 recognize.
5572 If you want to pass an option that takes an argument, you must use
5573 @option{-Xlinker} twice, once for the option and once for the argument.
5574 For example, to pass @option{-assert definitions}, you must write
5575 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5576 @option{-Xlinker "-assert definitions"}, because this passes the entire
5577 string as a single argument, which is not what the linker expects.
5579 @item -Wl,@var{option}
5580 @opindex Wl
5581 Pass @var{option} as an option to the linker.  If @var{option} contains
5582 commas, it is split into multiple options at the commas.
5584 @item -u @var{symbol}
5585 @opindex u
5586 Pretend the symbol @var{symbol} is undefined, to force linking of
5587 library modules to define it.  You can use @option{-u} multiple times with
5588 different symbols to force loading of additional library modules.
5589 @end table
5591 @node Directory Options
5592 @section Options for Directory Search
5593 @cindex directory options
5594 @cindex options, directory search
5595 @cindex search path
5597 These options specify directories to search for header files, for
5598 libraries and for parts of the compiler:
5600 @table @gcctabopt
5601 @item -I@var{dir}
5602 @opindex I
5603 Add the directory @var{dir} to the head of the list of directories to be
5604 searched for header files.  This can be used to override a system header
5605 file, substituting your own version, since these directories are
5606 searched before the system header file directories.  However, you should
5607 not use this option to add directories that contain vendor-supplied
5608 system header files (use @option{-isystem} for that).  If you use more than
5609 one @option{-I} option, the directories are scanned in left-to-right
5610 order; the standard system directories come after.
5612 If a standard system include directory, or a directory specified with
5613 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5614 option will be ignored.  The directory will still be searched but as a
5615 system directory at its normal position in the system include chain.
5616 This is to ensure that GCC's procedure to fix buggy system headers and
5617 the ordering for the include_next directive are not inadvertently changed.
5618 If you really need to change the search order for system directories,
5619 use the @option{-nostdinc} and/or @option{-isystem} options.
5621 @item -iquote@var{dir}
5622 @opindex iquote
5623 Add the directory @var{dir} to the head of the list of directories to
5624 be searched for header files only for the case of @samp{#include
5625 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5626 otherwise just like @option{-I}.
5628 @item -L@var{dir}
5629 @opindex L
5630 Add directory @var{dir} to the list of directories to be searched
5631 for @option{-l}.
5633 @item -B@var{prefix}
5634 @opindex B
5635 This option specifies where to find the executables, libraries,
5636 include files, and data files of the compiler itself.
5638 The compiler driver program runs one or more of the subprograms
5639 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5640 @var{prefix} as a prefix for each program it tries to run, both with and
5641 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5643 For each subprogram to be run, the compiler driver first tries the
5644 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5645 was not specified, the driver tries two standard prefixes, which are
5646 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5647 those results in a file name that is found, the unmodified program
5648 name is searched for using the directories specified in your
5649 @env{PATH} environment variable.
5651 The compiler will check to see if the path provided by the @option{-B}
5652 refers to a directory, and if necessary it will add a directory
5653 separator character at the end of the path.
5655 @option{-B} prefixes that effectively specify directory names also apply
5656 to libraries in the linker, because the compiler translates these
5657 options into @option{-L} options for the linker.  They also apply to
5658 includes files in the preprocessor, because the compiler translates these
5659 options into @option{-isystem} options for the preprocessor.  In this case,
5660 the compiler appends @samp{include} to the prefix.
5662 The run-time support file @file{libgcc.a} can also be searched for using
5663 the @option{-B} prefix, if needed.  If it is not found there, the two
5664 standard prefixes above are tried, and that is all.  The file is left
5665 out of the link if it is not found by those means.
5667 Another way to specify a prefix much like the @option{-B} prefix is to use
5668 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5669 Variables}.
5671 As a special kludge, if the path provided by @option{-B} is
5672 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5673 9, then it will be replaced by @file{[dir/]include}.  This is to help
5674 with boot-strapping the compiler.
5676 @item -specs=@var{file}
5677 @opindex specs
5678 Process @var{file} after the compiler reads in the standard @file{specs}
5679 file, in order to override the defaults that the @file{gcc} driver
5680 program uses when determining what switches to pass to @file{cc1},
5681 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5682 @option{-specs=@var{file}} can be specified on the command line, and they
5683 are processed in order, from left to right.
5685 @item -I-
5686 @opindex I-
5687 This option has been deprecated.  Please use @option{-iquote} instead for
5688 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5689 Any directories you specify with @option{-I} options before the @option{-I-}
5690 option are searched only for the case of @samp{#include "@var{file}"};
5691 they are not searched for @samp{#include <@var{file}>}.
5693 If additional directories are specified with @option{-I} options after
5694 the @option{-I-}, these directories are searched for all @samp{#include}
5695 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5696 this way.)
5698 In addition, the @option{-I-} option inhibits the use of the current
5699 directory (where the current input file came from) as the first search
5700 directory for @samp{#include "@var{file}"}.  There is no way to
5701 override this effect of @option{-I-}.  With @option{-I.} you can specify
5702 searching the directory which was current when the compiler was
5703 invoked.  That is not exactly the same as what the preprocessor does
5704 by default, but it is often satisfactory.
5706 @option{-I-} does not inhibit the use of the standard system directories
5707 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5708 independent.
5709 @end table
5711 @c man end
5713 @node Spec Files
5714 @section Specifying subprocesses and the switches to pass to them
5715 @cindex Spec Files
5717 @command{gcc} is a driver program.  It performs its job by invoking a
5718 sequence of other programs to do the work of compiling, assembling and
5719 linking.  GCC interprets its command-line parameters and uses these to
5720 deduce which programs it should invoke, and which command-line options
5721 it ought to place on their command lines.  This behavior is controlled
5722 by @dfn{spec strings}.  In most cases there is one spec string for each
5723 program that GCC can invoke, but a few programs have multiple spec
5724 strings to control their behavior.  The spec strings built into GCC can
5725 be overridden by using the @option{-specs=} command-line switch to specify
5726 a spec file.
5728 @dfn{Spec files} are plaintext files that are used to construct spec
5729 strings.  They consist of a sequence of directives separated by blank
5730 lines.  The type of directive is determined by the first non-whitespace
5731 character on the line and it can be one of the following:
5733 @table @code
5734 @item %@var{command}
5735 Issues a @var{command} to the spec file processor.  The commands that can
5736 appear here are:
5738 @table @code
5739 @item %include <@var{file}>
5740 @cindex %include
5741 Search for @var{file} and insert its text at the current point in the
5742 specs file.
5744 @item %include_noerr <@var{file}>
5745 @cindex %include_noerr
5746 Just like @samp{%include}, but do not generate an error message if the include
5747 file cannot be found.
5749 @item %rename @var{old_name} @var{new_name}
5750 @cindex %rename
5751 Rename the spec string @var{old_name} to @var{new_name}.
5753 @end table
5755 @item *[@var{spec_name}]:
5756 This tells the compiler to create, override or delete the named spec
5757 string.  All lines after this directive up to the next directive or
5758 blank line are considered to be the text for the spec string.  If this
5759 results in an empty string then the spec will be deleted.  (Or, if the
5760 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5761 does not currently exist a new spec will be created.  If the spec does
5762 exist then its contents will be overridden by the text of this
5763 directive, unless the first character of that text is the @samp{+}
5764 character, in which case the text will be appended to the spec.
5766 @item [@var{suffix}]:
5767 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5768 and up to the next directive or blank line are considered to make up the
5769 spec string for the indicated suffix.  When the compiler encounters an
5770 input file with the named suffix, it will processes the spec string in
5771 order to work out how to compile that file.  For example:
5773 @smallexample
5774 .ZZ:
5775 z-compile -input %i
5776 @end smallexample
5778 This says that any input file whose name ends in @samp{.ZZ} should be
5779 passed to the program @samp{z-compile}, which should be invoked with the
5780 command-line switch @option{-input} and with the result of performing the
5781 @samp{%i} substitution.  (See below.)
5783 As an alternative to providing a spec string, the text that follows a
5784 suffix directive can be one of the following:
5786 @table @code
5787 @item @@@var{language}
5788 This says that the suffix is an alias for a known @var{language}.  This is
5789 similar to using the @option{-x} command-line switch to GCC to specify a
5790 language explicitly.  For example:
5792 @smallexample
5793 .ZZ:
5794 @@c++
5795 @end smallexample
5797 Says that .ZZ files are, in fact, C++ source files.
5799 @item #@var{name}
5800 This causes an error messages saying:
5802 @smallexample
5803 @var{name} compiler not installed on this system.
5804 @end smallexample
5805 @end table
5807 GCC already has an extensive list of suffixes built into it.
5808 This directive will add an entry to the end of the list of suffixes, but
5809 since the list is searched from the end backwards, it is effectively
5810 possible to override earlier entries using this technique.
5812 @end table
5814 GCC has the following spec strings built into it.  Spec files can
5815 override these strings or create their own.  Note that individual
5816 targets can also add their own spec strings to this list.
5818 @smallexample
5819 asm          Options to pass to the assembler
5820 asm_final    Options to pass to the assembler post-processor
5821 cpp          Options to pass to the C preprocessor
5822 cc1          Options to pass to the C compiler
5823 cc1plus      Options to pass to the C++ compiler
5824 endfile      Object files to include at the end of the link
5825 link         Options to pass to the linker
5826 lib          Libraries to include on the command line to the linker
5827 libgcc       Decides which GCC support library to pass to the linker
5828 linker       Sets the name of the linker
5829 predefines   Defines to be passed to the C preprocessor
5830 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5831              by default
5832 startfile    Object files to include at the start of the link
5833 @end smallexample
5835 Here is a small example of a spec file:
5837 @smallexample
5838 %rename lib                 old_lib
5840 *lib:
5841 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5842 @end smallexample
5844 This example renames the spec called @samp{lib} to @samp{old_lib} and
5845 then overrides the previous definition of @samp{lib} with a new one.
5846 The new definition adds in some extra command-line options before
5847 including the text of the old definition.
5849 @dfn{Spec strings} are a list of command-line options to be passed to their
5850 corresponding program.  In addition, the spec strings can contain
5851 @samp{%}-prefixed sequences to substitute variable text or to
5852 conditionally insert text into the command line.  Using these constructs
5853 it is possible to generate quite complex command lines.
5855 Here is a table of all defined @samp{%}-sequences for spec
5856 strings.  Note that spaces are not generated automatically around the
5857 results of expanding these sequences.  Therefore you can concatenate them
5858 together or combine them with constant text in a single argument.
5860 @table @code
5861 @item %%
5862 Substitute one @samp{%} into the program name or argument.
5864 @item %i
5865 Substitute the name of the input file being processed.
5867 @item %b
5868 Substitute the basename of the input file being processed.
5869 This is the substring up to (and not including) the last period
5870 and not including the directory.
5872 @item %B
5873 This is the same as @samp{%b}, but include the file suffix (text after
5874 the last period).
5876 @item %d
5877 Marks the argument containing or following the @samp{%d} as a
5878 temporary file name, so that that file will be deleted if GCC exits
5879 successfully.  Unlike @samp{%g}, this contributes no text to the
5880 argument.
5882 @item %g@var{suffix}
5883 Substitute a file name that has suffix @var{suffix} and is chosen
5884 once per compilation, and mark the argument in the same way as
5885 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
5886 name is now chosen in a way that is hard to predict even when previously
5887 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
5888 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
5889 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
5890 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
5891 was simply substituted with a file name chosen once per compilation,
5892 without regard to any appended suffix (which was therefore treated
5893 just like ordinary text), making such attacks more likely to succeed.
5895 @item %u@var{suffix}
5896 Like @samp{%g}, but generates a new temporary file name even if
5897 @samp{%u@var{suffix}} was already seen.
5899 @item %U@var{suffix}
5900 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
5901 new one if there is no such last file name.  In the absence of any
5902 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
5903 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
5904 would involve the generation of two distinct file names, one
5905 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
5906 simply substituted with a file name chosen for the previous @samp{%u},
5907 without regard to any appended suffix.
5909 @item %j@var{suffix}
5910 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
5911 writable, and if save-temps is off; otherwise, substitute the name
5912 of a temporary file, just like @samp{%u}.  This temporary file is not
5913 meant for communication between processes, but rather as a junk
5914 disposal mechanism.
5916 @item %|@var{suffix}
5917 @itemx %m@var{suffix}
5918 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
5919 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
5920 all.  These are the two most common ways to instruct a program that it
5921 should read from standard input or write to standard output.  If you
5922 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
5923 construct: see for example @file{f/lang-specs.h}.
5925 @item %.@var{SUFFIX}
5926 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
5927 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
5928 terminated by the next space or %.
5930 @item %w
5931 Marks the argument containing or following the @samp{%w} as the
5932 designated output file of this compilation.  This puts the argument
5933 into the sequence of arguments that @samp{%o} will substitute later.
5935 @item %o
5936 Substitutes the names of all the output files, with spaces
5937 automatically placed around them.  You should write spaces
5938 around the @samp{%o} as well or the results are undefined.
5939 @samp{%o} is for use in the specs for running the linker.
5940 Input files whose names have no recognized suffix are not compiled
5941 at all, but they are included among the output files, so they will
5942 be linked.
5944 @item %O
5945 Substitutes the suffix for object files.  Note that this is
5946 handled specially when it immediately follows @samp{%g, %u, or %U},
5947 because of the need for those to form complete file names.  The
5948 handling is such that @samp{%O} is treated exactly as if it had already
5949 been substituted, except that @samp{%g, %u, and %U} do not currently
5950 support additional @var{suffix} characters following @samp{%O} as they would
5951 following, for example, @samp{.o}.
5953 @item %p
5954 Substitutes the standard macro predefinitions for the
5955 current target machine.  Use this when running @code{cpp}.
5957 @item %P
5958 Like @samp{%p}, but puts @samp{__} before and after the name of each
5959 predefined macro, except for macros that start with @samp{__} or with
5960 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
5963 @item %I
5964 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
5965 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
5966 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
5967 as necessary.
5969 @item %s
5970 Current argument is the name of a library or startup file of some sort.
5971 Search for that file in a standard list of directories and substitute
5972 the full name found.
5974 @item %e@var{str}
5975 Print @var{str} as an error message.  @var{str} is terminated by a newline.
5976 Use this when inconsistent options are detected.
5978 @item %(@var{name})
5979 Substitute the contents of spec string @var{name} at this point.
5981 @item %[@var{name}]
5982 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
5984 @item %x@{@var{option}@}
5985 Accumulate an option for @samp{%X}.
5987 @item %X
5988 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
5989 spec string.
5991 @item %Y
5992 Output the accumulated assembler options specified by @option{-Wa}.
5994 @item %Z
5995 Output the accumulated preprocessor options specified by @option{-Wp}.
5997 @item %a
5998 Process the @code{asm} spec.  This is used to compute the
5999 switches to be passed to the assembler.
6001 @item %A
6002 Process the @code{asm_final} spec.  This is a spec string for
6003 passing switches to an assembler post-processor, if such a program is
6004 needed.
6006 @item %l
6007 Process the @code{link} spec.  This is the spec for computing the
6008 command line passed to the linker.  Typically it will make use of the
6009 @samp{%L %G %S %D and %E} sequences.
6011 @item %D
6012 Dump out a @option{-L} option for each directory that GCC believes might
6013 contain startup files.  If the target supports multilibs then the
6014 current multilib directory will be prepended to each of these paths.
6016 @item %M
6017 Output the multilib directory with directory separators replaced with
6018 @samp{_}.  If multilib directories are not set, or the multilib directory is
6019 @file{.} then this option emits nothing.
6021 @item %L
6022 Process the @code{lib} spec.  This is a spec string for deciding which
6023 libraries should be included on the command line to the linker.
6025 @item %G
6026 Process the @code{libgcc} spec.  This is a spec string for deciding
6027 which GCC support library should be included on the command line to the linker.
6029 @item %S
6030 Process the @code{startfile} spec.  This is a spec for deciding which
6031 object files should be the first ones passed to the linker.  Typically
6032 this might be a file named @file{crt0.o}.
6034 @item %E
6035 Process the @code{endfile} spec.  This is a spec string that specifies
6036 the last object files that will be passed to the linker.
6038 @item %C
6039 Process the @code{cpp} spec.  This is used to construct the arguments
6040 to be passed to the C preprocessor.
6042 @item %1
6043 Process the @code{cc1} spec.  This is used to construct the options to be
6044 passed to the actual C compiler (@samp{cc1}).
6046 @item %2
6047 Process the @code{cc1plus} spec.  This is used to construct the options to be
6048 passed to the actual C++ compiler (@samp{cc1plus}).
6050 @item %*
6051 Substitute the variable part of a matched option.  See below.
6052 Note that each comma in the substituted string is replaced by
6053 a single space.
6055 @item %<@code{S}
6056 Remove all occurrences of @code{-S} from the command line.  Note---this
6057 command is position dependent.  @samp{%} commands in the spec string
6058 before this one will see @code{-S}, @samp{%} commands in the spec string
6059 after this one will not.
6061 @item %:@var{function}(@var{args})
6062 Call the named function @var{function}, passing it @var{args}.
6063 @var{args} is first processed as a nested spec string, then split
6064 into an argument vector in the usual fashion.  The function returns
6065 a string which is processed as if it had appeared literally as part
6066 of the current spec.
6068 The following built-in spec functions are provided:
6070 @table @code
6071 @item @code{if-exists}
6072 The @code{if-exists} spec function takes one argument, an absolute
6073 pathname to a file.  If the file exists, @code{if-exists} returns the
6074 pathname.  Here is a small example of its usage:
6076 @smallexample
6077 *startfile:
6078 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6079 @end smallexample
6081 @item @code{if-exists-else}
6082 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6083 spec function, except that it takes two arguments.  The first argument is
6084 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6085 returns the pathname.  If it does not exist, it returns the second argument.
6086 This way, @code{if-exists-else} can be used to select one file or another,
6087 based on the existence of the first.  Here is a small example of its usage:
6089 @smallexample
6090 *startfile:
6091 crt0%O%s %:if-exists(crti%O%s) \
6092 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6093 @end smallexample
6094 @end table
6096 @item %@{@code{S}@}
6097 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6098 If that switch was not specified, this substitutes nothing.  Note that
6099 the leading dash is omitted when specifying this option, and it is
6100 automatically inserted if the substitution is performed.  Thus the spec
6101 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6102 and would output the command line option @option{-foo}.
6104 @item %W@{@code{S}@}
6105 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6106 deleted on failure.
6108 @item %@{@code{S}*@}
6109 Substitutes all the switches specified to GCC whose names start
6110 with @code{-S}, but which also take an argument.  This is used for
6111 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6112 GCC considers @option{-o foo} as being
6113 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6114 text, including the space.  Thus two arguments would be generated.
6116 @item %@{@code{S}*&@code{T}*@}
6117 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6118 (the order of @code{S} and @code{T} in the spec is not significant).
6119 There can be any number of ampersand-separated variables; for each the
6120 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6122 @item %@{@code{S}:@code{X}@}
6123 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6125 @item %@{!@code{S}:@code{X}@}
6126 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6128 @item %@{@code{S}*:@code{X}@}
6129 Substitutes @code{X} if one or more switches whose names start with
6130 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6131 once, no matter how many such switches appeared.  However, if @code{%*}
6132 appears somewhere in @code{X}, then @code{X} will be substituted once
6133 for each matching switch, with the @code{%*} replaced by the part of
6134 that switch that matched the @code{*}.
6136 @item %@{.@code{S}:@code{X}@}
6137 Substitutes @code{X}, if processing a file with suffix @code{S}.
6139 @item %@{!.@code{S}:@code{X}@}
6140 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6142 @item %@{@code{S}|@code{P}:@code{X}@}
6143 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6144 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6145 although they have a stronger binding than the @samp{|}.  If @code{%*}
6146 appears in @code{X}, all of the alternatives must be starred, and only
6147 the first matching alternative is substituted.
6149 For example, a spec string like this:
6151 @smallexample
6152 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6153 @end smallexample
6155 will output the following command-line options from the following input
6156 command-line options:
6158 @smallexample
6159 fred.c        -foo -baz
6160 jim.d         -bar -boggle
6161 -d fred.c     -foo -baz -boggle
6162 -d jim.d      -bar -baz -boggle
6163 @end smallexample
6165 @item %@{S:X; T:Y; :D@}
6167 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6168 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6169 be as many clauses as you need.  This may be combined with @code{.},
6170 @code{!}, @code{|}, and @code{*} as needed.
6173 @end table
6175 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6176 construct may contain other nested @samp{%} constructs or spaces, or
6177 even newlines.  They are processed as usual, as described above.
6178 Trailing white space in @code{X} is ignored.  White space may also
6179 appear anywhere on the left side of the colon in these constructs,
6180 except between @code{.} or @code{*} and the corresponding word.
6182 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6183 handled specifically in these constructs.  If another value of
6184 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6185 @option{-W} switch is found later in the command line, the earlier
6186 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6187 just one letter, which passes all matching options.
6189 The character @samp{|} at the beginning of the predicate text is used to
6190 indicate that a command should be piped to the following command, but
6191 only if @option{-pipe} is specified.
6193 It is built into GCC which switches take arguments and which do not.
6194 (You might think it would be useful to generalize this to allow each
6195 compiler's spec to say which switches take arguments.  But this cannot
6196 be done in a consistent fashion.  GCC cannot even decide which input
6197 files have been specified without knowing which switches take arguments,
6198 and it must know which input files to compile in order to tell which
6199 compilers to run).
6201 GCC also knows implicitly that arguments starting in @option{-l} are to be
6202 treated as compiler output files, and passed to the linker in their
6203 proper position among the other output files.
6205 @c man begin OPTIONS
6207 @node Target Options
6208 @section Specifying Target Machine and Compiler Version
6209 @cindex target options
6210 @cindex cross compiling
6211 @cindex specifying machine version
6212 @cindex specifying compiler version and target machine
6213 @cindex compiler version, specifying
6214 @cindex target machine, specifying
6216 The usual way to run GCC is to run the executable called @file{gcc}, or
6217 @file{<machine>-gcc} when cross-compiling, or
6218 @file{<machine>-gcc-<version>} to run a version other than the one that
6219 was installed last.  Sometimes this is inconvenient, so GCC provides
6220 options that will switch to another cross-compiler or version.
6222 @table @gcctabopt
6223 @item -b @var{machine}
6224 @opindex b
6225 The argument @var{machine} specifies the target machine for compilation.
6227 The value to use for @var{machine} is the same as was specified as the
6228 machine type when configuring GCC as a cross-compiler.  For
6229 example, if a cross-compiler was configured with @samp{configure
6230 i386v}, meaning to compile for an 80386 running System V, then you
6231 would specify @option{-b i386v} to run that cross compiler.
6233 @item -V @var{version}
6234 @opindex V
6235 The argument @var{version} specifies which version of GCC to run.
6236 This is useful when multiple versions are installed.  For example,
6237 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6238 @end table
6240 The @option{-V} and @option{-b} options work by running the
6241 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6242 use them if you can just run that directly.
6244 @node Submodel Options
6245 @section Hardware Models and Configurations
6246 @cindex submodel options
6247 @cindex specifying hardware config
6248 @cindex hardware models and configurations, specifying
6249 @cindex machine dependent options
6251 Earlier we discussed the standard option @option{-b} which chooses among
6252 different installed compilers for completely different target
6253 machines, such as VAX vs.@: 68000 vs.@: 80386.
6255 In addition, each of these target machine types can have its own
6256 special options, starting with @samp{-m}, to choose among various
6257 hardware models or configurations---for example, 68010 vs 68020,
6258 floating coprocessor or none.  A single installed version of the
6259 compiler can compile for any model or configuration, according to the
6260 options specified.
6262 Some configurations of the compiler also support additional special
6263 options, usually for compatibility with other compilers on the same
6264 platform.
6266 These options are defined by the macro @code{TARGET_SWITCHES} in the
6267 machine description.  The default for the options is also defined by
6268 that macro, which enables you to change the defaults.
6270 @c This list is ordered alphanumerically by subsection name.
6271 @c It should be the same order and spelling as these options are listed
6272 @c in Machine Dependent Options
6274 @menu
6275 * ARC Options::
6276 * ARM Options::
6277 * AVR Options::
6278 * CRIS Options::
6279 * Darwin Options::
6280 * DEC Alpha Options::
6281 * DEC Alpha/VMS Options::
6282 * FRV Options::
6283 * H8/300 Options::
6284 * HPPA Options::
6285 * i386 and x86-64 Options::
6286 * IA-64 Options::
6287 * M32R/D Options::
6288 * M680x0 Options::
6289 * M68hc1x Options::
6290 * MCore Options::
6291 * MIPS Options::
6292 * MMIX Options::
6293 * MN10300 Options::
6294 * NS32K Options::
6295 * PDP-11 Options::
6296 * PowerPC Options::
6297 * RS/6000 and PowerPC Options::
6298 * S/390 and zSeries Options::
6299 * SH Options::
6300 * SPARC Options::
6301 * System V Options::
6302 * TMS320C3x/C4x Options::
6303 * V850 Options::
6304 * VAX Options::
6305 * x86-64 Options::
6306 * Xstormy16 Options::
6307 * Xtensa Options::
6308 * zSeries Options::
6309 @end menu
6311 @node ARC Options
6312 @subsection ARC Options
6313 @cindex ARC Options
6315 These options are defined for ARC implementations:
6317 @table @gcctabopt
6318 @item -EL
6319 @opindex EL
6320 Compile code for little endian mode.  This is the default.
6322 @item -EB
6323 @opindex EB
6324 Compile code for big endian mode.
6326 @item -mmangle-cpu
6327 @opindex mmangle-cpu
6328 Prepend the name of the cpu to all public symbol names.
6329 In multiple-processor systems, there are many ARC variants with different
6330 instruction and register set characteristics.  This flag prevents code
6331 compiled for one cpu to be linked with code compiled for another.
6332 No facility exists for handling variants that are ``almost identical''.
6333 This is an all or nothing option.
6335 @item -mcpu=@var{cpu}
6336 @opindex mcpu
6337 Compile code for ARC variant @var{cpu}.
6338 Which variants are supported depend on the configuration.
6339 All variants support @option{-mcpu=base}, this is the default.
6341 @item -mtext=@var{text-section}
6342 @itemx -mdata=@var{data-section}
6343 @itemx -mrodata=@var{readonly-data-section}
6344 @opindex mtext
6345 @opindex mdata
6346 @opindex mrodata
6347 Put functions, data, and readonly data in @var{text-section},
6348 @var{data-section}, and @var{readonly-data-section} respectively
6349 by default.  This can be overridden with the @code{section} attribute.
6350 @xref{Variable Attributes}.
6352 @end table
6354 @node ARM Options
6355 @subsection ARM Options
6356 @cindex ARM options
6358 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6359 architectures:
6361 @table @gcctabopt
6362 @item -mabi=@var{name}
6363 @opindex mabi
6364 Generate code for the specified ABI.  Permissible values are: @samp{apcs-gnu},
6365 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6367 @item -mapcs-frame
6368 @opindex mapcs-frame
6369 Generate a stack frame that is compliant with the ARM Procedure Call
6370 Standard for all functions, even if this is not strictly necessary for
6371 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6372 with this option will cause the stack frames not to be generated for
6373 leaf functions.  The default is @option{-mno-apcs-frame}.
6375 @item -mapcs
6376 @opindex mapcs
6377 This is a synonym for @option{-mapcs-frame}.
6379 @ignore
6380 @c not currently implemented
6381 @item -mapcs-stack-check
6382 @opindex mapcs-stack-check
6383 Generate code to check the amount of stack space available upon entry to
6384 every function (that actually uses some stack space).  If there is
6385 insufficient space available then either the function
6386 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6387 called, depending upon the amount of stack space required.  The run time
6388 system is required to provide these functions.  The default is
6389 @option{-mno-apcs-stack-check}, since this produces smaller code.
6391 @c not currently implemented
6392 @item -mapcs-float
6393 @opindex mapcs-float
6394 Pass floating point arguments using the float point registers.  This is
6395 one of the variants of the APCS@.  This option is recommended if the
6396 target hardware has a floating point unit or if a lot of floating point
6397 arithmetic is going to be performed by the code.  The default is
6398 @option{-mno-apcs-float}, since integer only code is slightly increased in
6399 size if @option{-mapcs-float} is used.
6401 @c not currently implemented
6402 @item -mapcs-reentrant
6403 @opindex mapcs-reentrant
6404 Generate reentrant, position independent code.  The default is
6405 @option{-mno-apcs-reentrant}.
6406 @end ignore
6408 @item -mthumb-interwork
6409 @opindex mthumb-interwork
6410 Generate code which supports calling between the ARM and Thumb
6411 instruction sets.  Without this option the two instruction sets cannot
6412 be reliably used inside one program.  The default is
6413 @option{-mno-thumb-interwork}, since slightly larger code is generated
6414 when @option{-mthumb-interwork} is specified.
6416 @item -mno-sched-prolog
6417 @opindex mno-sched-prolog
6418 Prevent the reordering of instructions in the function prolog, or the
6419 merging of those instruction with the instructions in the function's
6420 body.  This means that all functions will start with a recognizable set
6421 of instructions (or in fact one of a choice from a small set of
6422 different function prologues), and this information can be used to
6423 locate the start if functions inside an executable piece of code.  The
6424 default is @option{-msched-prolog}.
6426 @item -mhard-float
6427 @opindex mhard-float
6428 Generate output containing floating point instructions.  This is the
6429 default.
6431 @item -msoft-float
6432 @opindex msoft-float
6433 Generate output containing library calls for floating point.
6434 @strong{Warning:} the requisite libraries are not available for all ARM
6435 targets.  Normally the facilities of the machine's usual C compiler are
6436 used, but this cannot be done directly in cross-compilation.  You must make
6437 your own arrangements to provide suitable library functions for
6438 cross-compilation.
6440 @option{-msoft-float} changes the calling convention in the output file;
6441 therefore, it is only useful if you compile @emph{all} of a program with
6442 this option.  In particular, you need to compile @file{libgcc.a}, the
6443 library that comes with GCC, with @option{-msoft-float} in order for
6444 this to work.
6446 @item -mfloat-abi=@var{name}
6447 @opindex mfloat-abi
6448 Specifies which ABI to use for floating point values.  Permissible values
6449 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6451 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6452 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6453 of floating point instructions, but still uses the soft-float calling
6454 conventions.
6456 @item -mlittle-endian
6457 @opindex mlittle-endian
6458 Generate code for a processor running in little-endian mode.  This is
6459 the default for all standard configurations.
6461 @item -mbig-endian
6462 @opindex mbig-endian
6463 Generate code for a processor running in big-endian mode; the default is
6464 to compile code for a little-endian processor.
6466 @item -mwords-little-endian
6467 @opindex mwords-little-endian
6468 This option only applies when generating code for big-endian processors.
6469 Generate code for a little-endian word order but a big-endian byte
6470 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6471 option should only be used if you require compatibility with code for
6472 big-endian ARM processors generated by versions of the compiler prior to
6473 2.8.
6475 @item -mcpu=@var{name}
6476 @opindex mcpu
6477 This specifies the name of the target ARM processor.  GCC uses this name
6478 to determine what kind of instructions it can emit when generating
6479 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6480 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6481 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6482 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6483 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6484 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6485 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6486 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6487 @samp{arm920t}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6488 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6489 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6490 @samp{ep9312}.
6492 @itemx -mtune=@var{name}
6493 @opindex mtune
6494 This option is very similar to the @option{-mcpu=} option, except that
6495 instead of specifying the actual target processor type, and hence
6496 restricting which instructions can be used, it specifies that GCC should
6497 tune the performance of the code as if the target were of the type
6498 specified in this option, but still choosing the instructions that it
6499 will generate based on the cpu specified by a @option{-mcpu=} option.
6500 For some ARM implementations better performance can be obtained by using
6501 this option.
6503 @item -march=@var{name}
6504 @opindex march
6505 This specifies the name of the target ARM architecture.  GCC uses this
6506 name to determine what kind of instructions it can emit when generating
6507 assembly code.  This option can be used in conjunction with or instead
6508 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6509 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6510 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6511 @samp{iwmmxt}, @samp{ep9312}.
6513 @item -mfpu=@var{name}
6514 @itemx -mfpe=@var{number}
6515 @itemx -mfp=@var{number}
6516 @opindex mfpu
6517 @opindex mfpe
6518 @opindex mfp
6519 This specifies what floating point hardware (or hardware emulation) is
6520 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6521 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6522 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6523 with older versions of GCC@.
6525 If @option{-msoft-float} is specified this specifies the format of
6526 floating point values.
6528 @item -mstructure-size-boundary=@var{n}
6529 @opindex mstructure-size-boundary
6530 The size of all structures and unions will be rounded up to a multiple
6531 of the number of bits set by this option.  Permissible values are 8, 32
6532 and 64.  The default value varies for different toolchains.  For the COFF
6533 targeted toolchain the default value is 8.  A value of 64 is only allowed
6534 if the underlying ABI supports it.
6536 Specifying the larger number can produce faster, more efficient code, but
6537 can also increase the size of the program.  Different values are potentially
6538 incompatible.  Code compiled with one value cannot necessarily expect to
6539 work with code or libraries compiled with another value, if they exchange
6540 information using structures or unions.
6542 @item -mabort-on-noreturn
6543 @opindex mabort-on-noreturn
6544 Generate a call to the function @code{abort} at the end of a
6545 @code{noreturn} function.  It will be executed if the function tries to
6546 return.
6548 @item -mlong-calls
6549 @itemx -mno-long-calls
6550 @opindex mlong-calls
6551 @opindex mno-long-calls
6552 Tells the compiler to perform function calls by first loading the
6553 address of the function into a register and then performing a subroutine
6554 call on this register.  This switch is needed if the target function
6555 will lie outside of the 64 megabyte addressing range of the offset based
6556 version of subroutine call instruction.
6558 Even if this switch is enabled, not all function calls will be turned
6559 into long calls.  The heuristic is that static functions, functions
6560 which have the @samp{short-call} attribute, functions that are inside
6561 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6562 definitions have already been compiled within the current compilation
6563 unit, will not be turned into long calls.  The exception to this rule is
6564 that weak function definitions, functions with the @samp{long-call}
6565 attribute or the @samp{section} attribute, and functions that are within
6566 the scope of a @samp{#pragma long_calls} directive, will always be
6567 turned into long calls.
6569 This feature is not enabled by default.  Specifying
6570 @option{-mno-long-calls} will restore the default behavior, as will
6571 placing the function calls within the scope of a @samp{#pragma
6572 long_calls_off} directive.  Note these switches have no effect on how
6573 the compiler generates code to handle function calls via function
6574 pointers.
6576 @item -mnop-fun-dllimport
6577 @opindex mnop-fun-dllimport
6578 Disable support for the @code{dllimport} attribute.
6580 @item -msingle-pic-base
6581 @opindex msingle-pic-base
6582 Treat the register used for PIC addressing as read-only, rather than
6583 loading it in the prologue for each function.  The run-time system is
6584 responsible for initializing this register with an appropriate value
6585 before execution begins.
6587 @item -mpic-register=@var{reg}
6588 @opindex mpic-register
6589 Specify the register to be used for PIC addressing.  The default is R10
6590 unless stack-checking is enabled, when R9 is used.
6592 @item -mcirrus-fix-invalid-insns
6593 @opindex mcirrus-fix-invalid-insns
6594 @opindex mno-cirrus-fix-invalid-insns
6595 Insert NOPs into the instruction stream to in order to work around
6596 problems with invalid Maverick instruction combinations.  This option
6597 is only valid if the @option{-mcpu=ep9312} option has been used to
6598 enable generation of instructions for the Cirrus Maverick floating
6599 point co-processor.  This option is not enabled by default, since the
6600 problem is only present in older Maverick implementations.  The default
6601 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6602 switch.
6604 @item -mpoke-function-name
6605 @opindex mpoke-function-name
6606 Write the name of each function into the text section, directly
6607 preceding the function prologue.  The generated code is similar to this:
6609 @smallexample
6610      t0
6611          .ascii "arm_poke_function_name", 0
6612          .align
6613      t1
6614          .word 0xff000000 + (t1 - t0)
6615      arm_poke_function_name
6616          mov     ip, sp
6617          stmfd   sp!, @{fp, ip, lr, pc@}
6618          sub     fp, ip, #4
6619 @end smallexample
6621 When performing a stack backtrace, code can inspect the value of
6622 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6623 location @code{pc - 12} and the top 8 bits are set, then we know that
6624 there is a function name embedded immediately preceding this location
6625 and has length @code{((pc[-3]) & 0xff000000)}.
6627 @item -mthumb
6628 @opindex mthumb
6629 Generate code for the 16-bit Thumb instruction set.  The default is to
6630 use the 32-bit ARM instruction set.
6632 @item -mtpcs-frame
6633 @opindex mtpcs-frame
6634 Generate a stack frame that is compliant with the Thumb Procedure Call
6635 Standard for all non-leaf functions.  (A leaf function is one that does
6636 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6638 @item -mtpcs-leaf-frame
6639 @opindex mtpcs-leaf-frame
6640 Generate a stack frame that is compliant with the Thumb Procedure Call
6641 Standard for all leaf functions.  (A leaf function is one that does
6642 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6644 @item -mcallee-super-interworking
6645 @opindex mcallee-super-interworking
6646 Gives all externally visible functions in the file being compiled an ARM
6647 instruction set header which switches to Thumb mode before executing the
6648 rest of the function.  This allows these functions to be called from
6649 non-interworking code.
6651 @item -mcaller-super-interworking
6652 @opindex mcaller-super-interworking
6653 Allows calls via function pointers (including virtual functions) to
6654 execute correctly regardless of whether the target code has been
6655 compiled for interworking or not.  There is a small overhead in the cost
6656 of executing a function pointer if this option is enabled.
6658 @end table
6660 @node AVR Options
6661 @subsection AVR Options
6662 @cindex AVR Options
6664 These options are defined for AVR implementations:
6666 @table @gcctabopt
6667 @item -mmcu=@var{mcu}
6668 @opindex mmcu
6669 Specify ATMEL AVR instruction set or MCU type.
6671 Instruction set avr1 is for the minimal AVR core, not supported by the C
6672 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6673 attiny11, attiny12, attiny15, attiny28).
6675 Instruction set avr2 (default) is for the classic AVR core with up to
6676 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
6677 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
6678 at90c8534, at90s8535).
6680 Instruction set avr3 is for the classic AVR core with up to 128K program
6681 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
6683 Instruction set avr4 is for the enhanced AVR core with up to 8K program
6684 memory space (MCU types: atmega8, atmega83, atmega85).
6686 Instruction set avr5 is for the enhanced AVR core with up to 128K program
6687 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
6688 atmega64, atmega128, at43usb355, at94k).
6690 @item -msize
6691 @opindex msize
6692 Output instruction sizes to the asm file.
6694 @item -minit-stack=@var{N}
6695 @opindex minit-stack
6696 Specify the initial stack address, which may be a symbol or numeric value,
6697 @samp{__stack} is the default.
6699 @item -mno-interrupts
6700 @opindex mno-interrupts
6701 Generated code is not compatible with hardware interrupts.
6702 Code size will be smaller.
6704 @item -mcall-prologues
6705 @opindex mcall-prologues
6706 Functions prologues/epilogues expanded as call to appropriate
6707 subroutines.  Code size will be smaller.
6709 @item -mno-tablejump
6710 @opindex mno-tablejump
6711 Do not generate tablejump insns which sometimes increase code size.
6713 @item -mtiny-stack
6714 @opindex mtiny-stack
6715 Change only the low 8 bits of the stack pointer.
6717 @item -mint8
6718 @opindex mint8
6719 Assume int to be 8 bit integer. This affects the sizes of all types: A
6720 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
6721 and long long will be 4 bytes. Please note that this option does not
6722 comply to the C standards, but it will provide you with smaller code
6723 size.
6724 @end table
6726 @node CRIS Options
6727 @subsection CRIS Options
6728 @cindex CRIS Options
6730 These options are defined specifically for the CRIS ports.
6732 @table @gcctabopt
6733 @item -march=@var{architecture-type}
6734 @itemx -mcpu=@var{architecture-type}
6735 @opindex march
6736 @opindex mcpu
6737 Generate code for the specified architecture.  The choices for
6738 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
6739 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
6740 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
6741 @samp{v10}.
6743 @item -mtune=@var{architecture-type}
6744 @opindex mtune
6745 Tune to @var{architecture-type} everything applicable about the generated
6746 code, except for the ABI and the set of available instructions.  The
6747 choices for @var{architecture-type} are the same as for
6748 @option{-march=@var{architecture-type}}.
6750 @item -mmax-stack-frame=@var{n}
6751 @opindex mmax-stack-frame
6752 Warn when the stack frame of a function exceeds @var{n} bytes.
6754 @item -melinux-stacksize=@var{n}
6755 @opindex melinux-stacksize
6756 Only available with the @samp{cris-axis-aout} target.  Arranges for
6757 indications in the program to the kernel loader that the stack of the
6758 program should be set to @var{n} bytes.
6760 @item -metrax4
6761 @itemx -metrax100
6762 @opindex metrax4
6763 @opindex metrax100
6764 The options @option{-metrax4} and @option{-metrax100} are synonyms for
6765 @option{-march=v3} and @option{-march=v8} respectively.
6767 @item -mmul-bug-workaround
6768 @itemx -mno-mul-bug-workaround
6769 @opindex mmul-bug-workaround
6770 @opindex mno-mul-bug-workaround
6771 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
6772 models where it applies.  This option is active by default.
6774 @item -mpdebug
6775 @opindex mpdebug
6776 Enable CRIS-specific verbose debug-related information in the assembly
6777 code.  This option also has the effect to turn off the @samp{#NO_APP}
6778 formatted-code indicator to the assembler at the beginning of the
6779 assembly file.
6781 @item -mcc-init
6782 @opindex mcc-init
6783 Do not use condition-code results from previous instruction; always emit
6784 compare and test instructions before use of condition codes.
6786 @item -mno-side-effects
6787 @opindex mno-side-effects
6788 Do not emit instructions with side-effects in addressing modes other than
6789 post-increment.
6791 @item -mstack-align
6792 @itemx -mno-stack-align
6793 @itemx -mdata-align
6794 @itemx -mno-data-align
6795 @itemx -mconst-align
6796 @itemx -mno-const-align
6797 @opindex mstack-align
6798 @opindex mno-stack-align
6799 @opindex mdata-align
6800 @opindex mno-data-align
6801 @opindex mconst-align
6802 @opindex mno-const-align
6803 These options (no-options) arranges (eliminate arrangements) for the
6804 stack-frame, individual data and constants to be aligned for the maximum
6805 single data access size for the chosen CPU model.  The default is to
6806 arrange for 32-bit alignment.  ABI details such as structure layout are
6807 not affected by these options.
6809 @item -m32-bit
6810 @itemx -m16-bit
6811 @itemx -m8-bit
6812 @opindex m32-bit
6813 @opindex m16-bit
6814 @opindex m8-bit
6815 Similar to the stack- data- and const-align options above, these options
6816 arrange for stack-frame, writable data and constants to all be 32-bit,
6817 16-bit or 8-bit aligned.  The default is 32-bit alignment.
6819 @item -mno-prologue-epilogue
6820 @itemx -mprologue-epilogue
6821 @opindex mno-prologue-epilogue
6822 @opindex mprologue-epilogue
6823 With @option{-mno-prologue-epilogue}, the normal function prologue and
6824 epilogue that sets up the stack-frame are omitted and no return
6825 instructions or return sequences are generated in the code.  Use this
6826 option only together with visual inspection of the compiled code: no
6827 warnings or errors are generated when call-saved registers must be saved,
6828 or storage for local variable needs to be allocated.
6830 @item -mno-gotplt
6831 @itemx -mgotplt
6832 @opindex mno-gotplt
6833 @opindex mgotplt
6834 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
6835 instruction sequences that load addresses for functions from the PLT part
6836 of the GOT rather than (traditional on other architectures) calls to the
6837 PLT.  The default is @option{-mgotplt}.
6839 @item -maout
6840 @opindex maout
6841 Legacy no-op option only recognized with the cris-axis-aout target.
6843 @item -melf
6844 @opindex melf
6845 Legacy no-op option only recognized with the cris-axis-elf and
6846 cris-axis-linux-gnu targets.
6848 @item -melinux
6849 @opindex melinux
6850 Only recognized with the cris-axis-aout target, where it selects a
6851 GNU/linux-like multilib, include files and instruction set for
6852 @option{-march=v8}.
6854 @item -mlinux
6855 @opindex mlinux
6856 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
6858 @item -sim
6859 @opindex sim
6860 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
6861 to link with input-output functions from a simulator library.  Code,
6862 initialized data and zero-initialized data are allocated consecutively.
6864 @item -sim2
6865 @opindex sim2
6866 Like @option{-sim}, but pass linker options to locate initialized data at
6867 0x40000000 and zero-initialized data at 0x80000000.
6868 @end table
6870 @node Darwin Options
6871 @subsection Darwin Options
6872 @cindex Darwin options
6874 These options are defined for all architectures running the Darwin operating
6875 system.  They are useful for compatibility with other Mac OS compilers.
6877 @table @gcctabopt
6878 @item -F@var{dir}
6879 @opindex F
6880 Add the framework directory @var{dir} to the head of the list of
6881 directories to be searched for header files.  These directories are
6882 interleaved with those specified by @option{-I} options and are
6883 scanned in a left-to-right order.
6885 A framework directory is a directory with frameworks in it.  A
6886 framework is a directory with a @samp{"Headers"} and/or
6887 @samp{"PrivateHeaders"} directory contained directly in it that ends
6888 in @samp{".framework"}.  The name of a framework is the name of this
6889 directory excluding the @samp{".framework"}.  Headers associated with
6890 the framework are found in one of those two directories, with
6891 @samp{"Headers"} being searched first.  A subframework is a framework
6892 directory that is in a framework's @samp{"Frameworks"} directory.
6893 Includes of subframework headers can only appear in a header of a
6894 framework that contains the subframework, or in a sibling subframework
6895 header.  Two subframeworks are siblings if they occur in the same
6896 framework.  A subframework should not have the same name as a
6897 framework, a warning will be issued if this is violated.  Currently a
6898 subframework cannot have subframeworks, in the future, the mechanism
6899 may be extended to support this.  The standard frameworks can be found
6900 in @samp{"/System/Library/Frameworks"}, @samp{"/Library/Frameworks"}
6901 and @samp{"/Local/Library/Frameworks"}.  An example include looks like
6902 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
6903 the name of the framework and header.h is found in the
6904 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
6906 @item -all_load
6907 @opindex all_load
6908 Loads all members of static archive libraries.
6909 See man ld(1) for more information.
6911 @item -arch_errors_fatal
6912 @opindex arch_errors_fatal
6913 Cause the errors having to do with files that have the wrong architecture
6914 to be fatal.
6916 @item -bind_at_load
6917 @opindex bind_at_load
6918 Causes the output file to be marked such that the dynamic linker will
6919 bind all undefined references when the file is loaded or launched.
6921 @item -bundle
6922 @opindex bundle
6923 Produce a Mach-o bundle format file.
6924 See man ld(1) for more information.
6926 @item -bundle_loader @var{executable}
6927 @opindex bundle_loader
6928 This specifies the @var{executable} that will be loading the build
6929 output file being linked. See man ld(1) for more information.
6931 @item -allowable_client  @var{client_name}
6932 @itemx -arch_only
6934 @itemx -client_name
6935 @itemx -compatibility_version
6936 @itemx -current_version
6937 @itemx -dependency-file
6938 @itemx -dylib_file
6939 @itemx -dylinker_install_name
6940 @itemx -dynamic
6941 @itemx -dynamiclib
6942 @itemx -exported_symbols_list
6943 @itemx -filelist
6944 @itemx -flat_namespace
6945 @itemx -force_cpusubtype_ALL
6946 @itemx -force_flat_namespace
6947 @itemx -headerpad_max_install_names
6948 @itemx -image_base
6949 @itemx -init
6950 @itemx -install_name
6951 @itemx -keep_private_externs
6952 @itemx -multi_module
6953 @itemx -multiply_defined
6954 @itemx -multiply_defined_unused
6955 @itemx -noall_load
6956 @itemx -nofixprebinding
6957 @itemx -nomultidefs
6958 @itemx -noprebind
6959 @itemx -noseglinkedit
6960 @itemx -pagezero_size
6961 @itemx -prebind
6962 @itemx -prebind_all_twolevel_modules
6963 @itemx -private_bundle
6964 @itemx -read_only_relocs
6965 @itemx -sectalign
6966 @itemx -sectobjectsymbols
6967 @itemx -whyload
6968 @itemx -seg1addr
6969 @itemx -sectcreate
6970 @itemx -sectobjectsymbols
6971 @itemx -sectorder
6972 @itemx -seg_addr_table
6973 @itemx -seg_addr_table_filename
6974 @itemx -seglinkedit
6975 @itemx -segprot
6976 @itemx -segs_read_only_addr
6977 @itemx -segs_read_write_addr
6978 @itemx -single_module
6979 @itemx -static
6980 @itemx -sub_library
6981 @itemx -sub_umbrella
6982 @itemx -twolevel_namespace
6983 @itemx -umbrella
6984 @itemx -undefined
6985 @itemx -unexported_symbols_list
6986 @itemx -weak_reference_mismatches
6987 @itemx -whatsloaded
6989 @opindex allowable_client
6990 @opindex arch_only
6991 @opindex client_name
6992 @opindex compatibility_version
6993 @opindex current_version
6994 @opindex dependency-file
6995 @opindex dylib_file
6996 @opindex dylinker_install_name
6997 @opindex dynamic
6998 @opindex dynamiclib
6999 @opindex exported_symbols_list
7000 @opindex filelist
7001 @opindex flat_namespace
7002 @opindex force_cpusubtype_ALL
7003 @opindex force_flat_namespace
7004 @opindex headerpad_max_install_names
7005 @opindex image_base
7006 @opindex init
7007 @opindex install_name
7008 @opindex keep_private_externs
7009 @opindex multi_module
7010 @opindex multiply_defined
7011 @opindex multiply_defined_unused
7012 @opindex noall_load
7013 @opindex nofixprebinding
7014 @opindex nomultidefs
7015 @opindex noprebind
7016 @opindex noseglinkedit
7017 @opindex pagezero_size
7018 @opindex prebind
7019 @opindex prebind_all_twolevel_modules
7020 @opindex private_bundle
7021 @opindex read_only_relocs
7022 @opindex sectalign
7023 @opindex sectobjectsymbols
7024 @opindex whyload
7025 @opindex seg1addr
7026 @opindex sectcreate
7027 @opindex sectobjectsymbols
7028 @opindex sectorder
7029 @opindex seg_addr_table
7030 @opindex seg_addr_table_filename
7031 @opindex seglinkedit
7032 @opindex segprot
7033 @opindex segs_read_only_addr
7034 @opindex segs_read_write_addr
7035 @opindex single_module
7036 @opindex static
7037 @opindex sub_library
7038 @opindex sub_umbrella
7039 @opindex twolevel_namespace
7040 @opindex umbrella
7041 @opindex undefined
7042 @opindex unexported_symbols_list
7043 @opindex weak_reference_mismatches
7044 @opindex whatsloaded
7046 These options are available for Darwin linker. Darwin linker man page
7047 describes them in detail.
7048 @end table
7050 @node DEC Alpha Options
7051 @subsection DEC Alpha Options
7053 These @samp{-m} options are defined for the DEC Alpha implementations:
7055 @table @gcctabopt
7056 @item -mno-soft-float
7057 @itemx -msoft-float
7058 @opindex mno-soft-float
7059 @opindex msoft-float
7060 Use (do not use) the hardware floating-point instructions for
7061 floating-point operations.  When @option{-msoft-float} is specified,
7062 functions in @file{libgcc.a} will be used to perform floating-point
7063 operations.  Unless they are replaced by routines that emulate the
7064 floating-point operations, or compiled in such a way as to call such
7065 emulations routines, these routines will issue floating-point
7066 operations.   If you are compiling for an Alpha without floating-point
7067 operations, you must ensure that the library is built so as not to call
7068 them.
7070 Note that Alpha implementations without floating-point operations are
7071 required to have floating-point registers.
7073 @item -mfp-reg
7074 @itemx -mno-fp-regs
7075 @opindex mfp-reg
7076 @opindex mno-fp-regs
7077 Generate code that uses (does not use) the floating-point register set.
7078 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7079 register set is not used, floating point operands are passed in integer
7080 registers as if they were integers and floating-point results are passed
7081 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7082 so any function with a floating-point argument or return value called by code
7083 compiled with @option{-mno-fp-regs} must also be compiled with that
7084 option.
7086 A typical use of this option is building a kernel that does not use,
7087 and hence need not save and restore, any floating-point registers.
7089 @item -mieee
7090 @opindex mieee
7091 The Alpha architecture implements floating-point hardware optimized for
7092 maximum performance.  It is mostly compliant with the IEEE floating
7093 point standard.  However, for full compliance, software assistance is
7094 required.  This option generates code fully IEEE compliant code
7095 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7096 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7097 defined during compilation.  The resulting code is less efficient but is
7098 able to correctly support denormalized numbers and exceptional IEEE
7099 values such as not-a-number and plus/minus infinity.  Other Alpha
7100 compilers call this option @option{-ieee_with_no_inexact}.
7102 @item -mieee-with-inexact
7103 @opindex mieee-with-inexact
7104 This is like @option{-mieee} except the generated code also maintains
7105 the IEEE @var{inexact-flag}.  Turning on this option causes the
7106 generated code to implement fully-compliant IEEE math.  In addition to
7107 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7108 macro.  On some Alpha implementations the resulting code may execute
7109 significantly slower than the code generated by default.  Since there is
7110 very little code that depends on the @var{inexact-flag}, you should
7111 normally not specify this option.  Other Alpha compilers call this
7112 option @option{-ieee_with_inexact}.
7114 @item -mfp-trap-mode=@var{trap-mode}
7115 @opindex mfp-trap-mode
7116 This option controls what floating-point related traps are enabled.
7117 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7118 The trap mode can be set to one of four values:
7120 @table @samp
7121 @item n
7122 This is the default (normal) setting.  The only traps that are enabled
7123 are the ones that cannot be disabled in software (e.g., division by zero
7124 trap).
7126 @item u
7127 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7128 as well.
7130 @item su
7131 Like @samp{su}, but the instructions are marked to be safe for software
7132 completion (see Alpha architecture manual for details).
7134 @item sui
7135 Like @samp{su}, but inexact traps are enabled as well.
7136 @end table
7138 @item -mfp-rounding-mode=@var{rounding-mode}
7139 @opindex mfp-rounding-mode
7140 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7141 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7144 @table @samp
7145 @item n
7146 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7147 the nearest machine number or towards the even machine number in case
7148 of a tie.
7150 @item m
7151 Round towards minus infinity.
7153 @item c
7154 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7156 @item d
7157 Dynamic rounding mode.  A field in the floating point control register
7158 (@var{fpcr}, see Alpha architecture reference manual) controls the
7159 rounding mode in effect.  The C library initializes this register for
7160 rounding towards plus infinity.  Thus, unless your program modifies the
7161 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7162 @end table
7164 @item -mtrap-precision=@var{trap-precision}
7165 @opindex mtrap-precision
7166 In the Alpha architecture, floating point traps are imprecise.  This
7167 means without software assistance it is impossible to recover from a
7168 floating trap and program execution normally needs to be terminated.
7169 GCC can generate code that can assist operating system trap handlers
7170 in determining the exact location that caused a floating point trap.
7171 Depending on the requirements of an application, different levels of
7172 precisions can be selected:
7174 @table @samp
7175 @item p
7176 Program precision.  This option is the default and means a trap handler
7177 can only identify which program caused a floating point exception.
7179 @item f
7180 Function precision.  The trap handler can determine the function that
7181 caused a floating point exception.
7183 @item i
7184 Instruction precision.  The trap handler can determine the exact
7185 instruction that caused a floating point exception.
7186 @end table
7188 Other Alpha compilers provide the equivalent options called
7189 @option{-scope_safe} and @option{-resumption_safe}.
7191 @item -mieee-conformant
7192 @opindex mieee-conformant
7193 This option marks the generated code as IEEE conformant.  You must not
7194 use this option unless you also specify @option{-mtrap-precision=i} and either
7195 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7196 is to emit the line @samp{.eflag 48} in the function prologue of the
7197 generated assembly file.  Under DEC Unix, this has the effect that
7198 IEEE-conformant math library routines will be linked in.
7200 @item -mbuild-constants
7201 @opindex mbuild-constants
7202 Normally GCC examines a 32- or 64-bit integer constant to
7203 see if it can construct it from smaller constants in two or three
7204 instructions.  If it cannot, it will output the constant as a literal and
7205 generate code to load it from the data segment at runtime.
7207 Use this option to require GCC to construct @emph{all} integer constants
7208 using code, even if it takes more instructions (the maximum is six).
7210 You would typically use this option to build a shared library dynamic
7211 loader.  Itself a shared library, it must relocate itself in memory
7212 before it can find the variables and constants in its own data segment.
7214 @item -malpha-as
7215 @itemx -mgas
7216 @opindex malpha-as
7217 @opindex mgas
7218 Select whether to generate code to be assembled by the vendor-supplied
7219 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7221 @item -mbwx
7222 @itemx -mno-bwx
7223 @itemx -mcix
7224 @itemx -mno-cix
7225 @itemx -mfix
7226 @itemx -mno-fix
7227 @itemx -mmax
7228 @itemx -mno-max
7229 @opindex mbwx
7230 @opindex mno-bwx
7231 @opindex mcix
7232 @opindex mno-cix
7233 @opindex mfix
7234 @opindex mno-fix
7235 @opindex mmax
7236 @opindex mno-max
7237 Indicate whether GCC should generate code to use the optional BWX,
7238 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7239 sets supported by the CPU type specified via @option{-mcpu=} option or that
7240 of the CPU on which GCC was built if none was specified.
7242 @item -mfloat-vax
7243 @itemx -mfloat-ieee
7244 @opindex mfloat-vax
7245 @opindex mfloat-ieee
7246 Generate code that uses (does not use) VAX F and G floating point
7247 arithmetic instead of IEEE single and double precision.
7249 @item -mexplicit-relocs
7250 @itemx -mno-explicit-relocs
7251 @opindex mexplicit-relocs
7252 @opindex mno-explicit-relocs
7253 Older Alpha assemblers provided no way to generate symbol relocations
7254 except via assembler macros.  Use of these macros does not allow
7255 optimal instruction scheduling.  GNU binutils as of version 2.12
7256 supports a new syntax that allows the compiler to explicitly mark
7257 which relocations should apply to which instructions.  This option
7258 is mostly useful for debugging, as GCC detects the capabilities of
7259 the assembler when it is built and sets the default accordingly.
7261 @item -msmall-data
7262 @itemx -mlarge-data
7263 @opindex msmall-data
7264 @opindex mlarge-data
7265 When @option{-mexplicit-relocs} is in effect, static data is
7266 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7267 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7268 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7269 16-bit relocations off of the @code{$gp} register.  This limits the
7270 size of the small data area to 64KB, but allows the variables to be
7271 directly accessed via a single instruction.
7273 The default is @option{-mlarge-data}.  With this option the data area
7274 is limited to just below 2GB.  Programs that require more than 2GB of
7275 data must use @code{malloc} or @code{mmap} to allocate the data in the
7276 heap instead of in the program's data segment.
7278 When generating code for shared libraries, @option{-fpic} implies
7279 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7281 @item -msmall-text
7282 @itemx -mlarge-text
7283 @opindex msmall-text
7284 @opindex mlarge-text
7285 When @option{-msmall-text} is used, the compiler assumes that the
7286 code of the entire program (or shared library) fits in 4MB, and is
7287 thus reachable with a branch instruction.  When @option{-msmall-data}
7288 is used, the compiler can assume that all local symbols share the
7289 same @code{$gp} value, and thus reduce the number of instructions
7290 required for a function call from 4 to 1.
7292 The default is @option{-mlarge-text}.
7294 @item -mcpu=@var{cpu_type}
7295 @opindex mcpu
7296 Set the instruction set and instruction scheduling parameters for
7297 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7298 style name or the corresponding chip number.  GCC supports scheduling
7299 parameters for the EV4, EV5 and EV6 family of processors and will
7300 choose the default values for the instruction set from the processor
7301 you specify.  If you do not specify a processor type, GCC will default
7302 to the processor on which the compiler was built.
7304 Supported values for @var{cpu_type} are
7306 @table @samp
7307 @item ev4
7308 @itemx ev45
7309 @itemx 21064
7310 Schedules as an EV4 and has no instruction set extensions.
7312 @item ev5
7313 @itemx 21164
7314 Schedules as an EV5 and has no instruction set extensions.
7316 @item ev56
7317 @itemx 21164a
7318 Schedules as an EV5 and supports the BWX extension.
7320 @item pca56
7321 @itemx 21164pc
7322 @itemx 21164PC
7323 Schedules as an EV5 and supports the BWX and MAX extensions.
7325 @item ev6
7326 @itemx 21264
7327 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7329 @item ev67
7330 @itemx 21264a
7331 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7332 @end table
7334 @item -mtune=@var{cpu_type}
7335 @opindex mtune
7336 Set only the instruction scheduling parameters for machine type
7337 @var{cpu_type}.  The instruction set is not changed.
7339 @item -mmemory-latency=@var{time}
7340 @opindex mmemory-latency
7341 Sets the latency the scheduler should assume for typical memory
7342 references as seen by the application.  This number is highly
7343 dependent on the memory access patterns used by the application
7344 and the size of the external cache on the machine.
7346 Valid options for @var{time} are
7348 @table @samp
7349 @item @var{number}
7350 A decimal number representing clock cycles.
7352 @item L1
7353 @itemx L2
7354 @itemx L3
7355 @itemx main
7356 The compiler contains estimates of the number of clock cycles for
7357 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7358 (also called Dcache, Scache, and Bcache), as well as to main memory.
7359 Note that L3 is only valid for EV5.
7361 @end table
7362 @end table
7364 @node DEC Alpha/VMS Options
7365 @subsection DEC Alpha/VMS Options
7367 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7369 @table @gcctabopt
7370 @item -mvms-return-codes
7371 @opindex mvms-return-codes
7372 Return VMS condition codes from main.  The default is to return POSIX
7373 style condition (e.g.@ error) codes.
7374 @end table
7376 @node FRV Options
7377 @subsection FRV Options
7378 @cindex FRV Options
7380 @table @gcctabopt
7381 @item -mgpr-32
7382 @opindex mgpr-32
7384 Only use the first 32 general purpose registers.
7386 @item -mgpr-64
7387 @opindex mgpr-64
7389 Use all 64 general purpose registers.
7391 @item -mfpr-32
7392 @opindex mfpr-32
7394 Use only the first 32 floating point registers.
7396 @item -mfpr-64
7397 @opindex mfpr-64
7399 Use all 64 floating point registers
7401 @item -mhard-float
7402 @opindex mhard-float
7404 Use hardware instructions for floating point operations.
7406 @item -msoft-float
7407 @opindex msoft-float
7409 Use library routines for floating point operations.
7411 @item -malloc-cc
7412 @opindex malloc-cc
7414 Dynamically allocate condition code registers.
7416 @item -mfixed-cc
7417 @opindex mfixed-cc
7419 Do not try to dynamically allocate condition code registers, only
7420 use @code{icc0} and @code{fcc0}.
7422 @item -mdword
7423 @opindex mdword
7425 Change ABI to use double word insns.
7427 @item -mno-dword
7428 @opindex mno-dword
7430 Do not use double word instructions.
7432 @item -mdouble
7433 @opindex mdouble
7435 Use floating point double instructions.
7437 @item -mno-double
7438 @opindex mno-double
7440 Do not use floating point double instructions.
7442 @item -mmedia
7443 @opindex mmedia
7445 Use media instructions.
7447 @item -mno-media
7448 @opindex mno-media
7450 Do not use media instructions.
7452 @item -mmuladd
7453 @opindex mmuladd
7455 Use multiply and add/subtract instructions.
7457 @item -mno-muladd
7458 @opindex mno-muladd
7460 Do not use multiply and add/subtract instructions.
7462 @item -mlibrary-pic
7463 @opindex mlibrary-pic
7465 Generate position-independent EABI code.
7467 @item -macc-4
7468 @opindex macc-4
7470 Use only the first four media accumulator registers.
7472 @item -macc-8
7473 @opindex macc-8
7475 Use all eight media accumulator registers.
7477 @item -mpack
7478 @opindex mpack
7480 Pack VLIW instructions.
7482 @item -mno-pack
7483 @opindex mno-pack
7485 Do not pack VLIW instructions.
7487 @item -mno-eflags
7488 @opindex mno-eflags
7490 Do not mark ABI switches in e_flags.
7492 @item -mcond-move
7493 @opindex mcond-move
7495 Enable the use of conditional-move instructions (default).
7497 This switch is mainly for debugging the compiler and will likely be removed
7498 in a future version.
7500 @item -mno-cond-move
7501 @opindex mno-cond-move
7503 Disable the use of conditional-move instructions.
7505 This switch is mainly for debugging the compiler and will likely be removed
7506 in a future version.
7508 @item -mscc
7509 @opindex mscc
7511 Enable the use of conditional set instructions (default).
7513 This switch is mainly for debugging the compiler and will likely be removed
7514 in a future version.
7516 @item -mno-scc
7517 @opindex mno-scc
7519 Disable the use of conditional set instructions.
7521 This switch is mainly for debugging the compiler and will likely be removed
7522 in a future version.
7524 @item -mcond-exec
7525 @opindex mcond-exec
7527 Enable the use of conditional execution (default).
7529 This switch is mainly for debugging the compiler and will likely be removed
7530 in a future version.
7532 @item -mno-cond-exec
7533 @opindex mno-cond-exec
7535 Disable the use of conditional execution.
7537 This switch is mainly for debugging the compiler and will likely be removed
7538 in a future version.
7540 @item -mvliw-branch
7541 @opindex mvliw-branch
7543 Run a pass to pack branches into VLIW instructions (default).
7545 This switch is mainly for debugging the compiler and will likely be removed
7546 in a future version.
7548 @item -mno-vliw-branch
7549 @opindex mno-vliw-branch
7551 Do not run a pass to pack branches into VLIW instructions.
7553 This switch is mainly for debugging the compiler and will likely be removed
7554 in a future version.
7556 @item -mmulti-cond-exec
7557 @opindex mmulti-cond-exec
7559 Enable optimization of @code{&&} and @code{||} in conditional execution
7560 (default).
7562 This switch is mainly for debugging the compiler and will likely be removed
7563 in a future version.
7565 @item -mno-multi-cond-exec
7566 @opindex mno-multi-cond-exec
7568 Disable optimization of @code{&&} and @code{||} in conditional execution.
7570 This switch is mainly for debugging the compiler and will likely be removed
7571 in a future version.
7573 @item -mnested-cond-exec
7574 @opindex mnested-cond-exec
7576 Enable nested conditional execution optimizations (default).
7578 This switch is mainly for debugging the compiler and will likely be removed
7579 in a future version.
7581 @item -mno-nested-cond-exec
7582 @opindex mno-nested-cond-exec
7584 Disable nested conditional execution optimizations.
7586 This switch is mainly for debugging the compiler and will likely be removed
7587 in a future version.
7589 @item -mtomcat-stats
7590 @opindex mtomcat-stats
7592 Cause gas to print out tomcat statistics.
7594 @item -mcpu=@var{cpu}
7595 @opindex mcpu
7597 Select the processor type for which to generate code.  Possible values are
7598 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
7599 @samp{frv}.
7601 @end table
7603 @node H8/300 Options
7604 @subsection H8/300 Options
7606 These @samp{-m} options are defined for the H8/300 implementations:
7608 @table @gcctabopt
7609 @item -mrelax
7610 @opindex mrelax
7611 Shorten some address references at link time, when possible; uses the
7612 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7613 ld, Using ld}, for a fuller description.
7615 @item -mh
7616 @opindex mh
7617 Generate code for the H8/300H@.
7619 @item -ms
7620 @opindex ms
7621 Generate code for the H8S@.
7623 @item -mn
7624 @opindex mn
7625 Generate code for the H8S and H8/300H in the normal mode.  This switch
7626 must be used either with -mh or -ms.
7628 @item -ms2600
7629 @opindex ms2600
7630 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
7632 @item -mint32
7633 @opindex mint32
7634 Make @code{int} data 32 bits by default.
7636 @item -malign-300
7637 @opindex malign-300
7638 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
7639 The default for the H8/300H and H8S is to align longs and floats on 4
7640 byte boundaries.
7641 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
7642 This option has no effect on the H8/300.
7643 @end table
7645 @node HPPA Options
7646 @subsection HPPA Options
7647 @cindex HPPA Options
7649 These @samp{-m} options are defined for the HPPA family of computers:
7651 @table @gcctabopt
7652 @item -march=@var{architecture-type}
7653 @opindex march
7654 Generate code for the specified architecture.  The choices for
7655 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
7656 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
7657 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7658 architecture option for your machine.  Code compiled for lower numbered
7659 architectures will run on higher numbered architectures, but not the
7660 other way around.
7662 PA 2.0 support currently requires gas snapshot 19990413 or later.  The
7663 next release of binutils (current is 2.9.1) will probably contain PA 2.0
7664 support.
7666 @item -mpa-risc-1-0
7667 @itemx -mpa-risc-1-1
7668 @itemx -mpa-risc-2-0
7669 @opindex mpa-risc-1-0
7670 @opindex mpa-risc-1-1
7671 @opindex mpa-risc-2-0
7672 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7674 @item -mbig-switch
7675 @opindex mbig-switch
7676 Generate code suitable for big switch tables.  Use this option only if
7677 the assembler/linker complain about out of range branches within a switch
7678 table.
7680 @item -mjump-in-delay
7681 @opindex mjump-in-delay
7682 Fill delay slots of function calls with unconditional jump instructions
7683 by modifying the return pointer for the function call to be the target
7684 of the conditional jump.
7686 @item -mdisable-fpregs
7687 @opindex mdisable-fpregs
7688 Prevent floating point registers from being used in any manner.  This is
7689 necessary for compiling kernels which perform lazy context switching of
7690 floating point registers.  If you use this option and attempt to perform
7691 floating point operations, the compiler will abort.
7693 @item -mdisable-indexing
7694 @opindex mdisable-indexing
7695 Prevent the compiler from using indexing address modes.  This avoids some
7696 rather obscure problems when compiling MIG generated code under MACH@.
7698 @item -mno-space-regs
7699 @opindex mno-space-regs
7700 Generate code that assumes the target has no space registers.  This allows
7701 GCC to generate faster indirect calls and use unscaled index address modes.
7703 Such code is suitable for level 0 PA systems and kernels.
7705 @item -mfast-indirect-calls
7706 @opindex mfast-indirect-calls
7707 Generate code that assumes calls never cross space boundaries.  This
7708 allows GCC to emit code which performs faster indirect calls.
7710 This option will not work in the presence of shared libraries or nested
7711 functions.
7713 @item -mlong-load-store
7714 @opindex mlong-load-store
7715 Generate 3-instruction load and store sequences as sometimes required by
7716 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
7717 the HP compilers.
7719 @item -mportable-runtime
7720 @opindex mportable-runtime
7721 Use the portable calling conventions proposed by HP for ELF systems.
7723 @item -mgas
7724 @opindex mgas
7725 Enable the use of assembler directives only GAS understands.
7727 @item -mschedule=@var{cpu-type}
7728 @opindex mschedule
7729 Schedule code according to the constraints for the machine type
7730 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
7731 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
7732 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
7733 proper scheduling option for your machine.  The default scheduling is
7734 @samp{8000}.
7736 @item -mlinker-opt
7737 @opindex mlinker-opt
7738 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
7739 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
7740 linkers in which they give bogus error messages when linking some programs.
7742 @item -msoft-float
7743 @opindex msoft-float
7744 Generate output containing library calls for floating point.
7745 @strong{Warning:} the requisite libraries are not available for all HPPA
7746 targets.  Normally the facilities of the machine's usual C compiler are
7747 used, but this cannot be done directly in cross-compilation.  You must make
7748 your own arrangements to provide suitable library functions for
7749 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
7750 does provide software floating point support.
7752 @option{-msoft-float} changes the calling convention in the output file;
7753 therefore, it is only useful if you compile @emph{all} of a program with
7754 this option.  In particular, you need to compile @file{libgcc.a}, the
7755 library that comes with GCC, with @option{-msoft-float} in order for
7756 this to work.
7758 @item -msio
7759 @opindex msio
7760 Generate the predefine, @code{_SIO}, for server IO.  The default is
7761 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
7762 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
7763 options are available under HP-UX and HI-UX.
7765 @item -mgnu-ld
7766 @opindex gnu-ld
7767 Use GNU ld specific options.  This passes @option{-shared} to ld when
7768 building a shared library.  It is the default when GCC is configured,
7769 explicitly or implicitly, with the GNU linker.  This option does not
7770 have any affect on which ld is called, it only changes what parameters
7771 are passed to that ld.  The ld that is called is determined by the
7772 @option{--with-ld} configure option, GCC's program search path, and
7773 finally by the user's @env{PATH}.  The linker used by GCC can be printed
7774 using @samp{which `gcc -print-prog-name=ld`}.
7776 @item -mhp-ld
7777 @opindex hp-ld
7778 Use HP ld specific options.  This passes @option{-b} to ld when building
7779 a shared library and passes @option{+Accept TypeMismatch} to ld on all
7780 links.  It is the default when GCC is configured, explicitly or
7781 implicitly, with the HP linker.  This option does not have any affect on
7782 which ld is called, it only changes what parameters are passed to that
7783 ld.  The ld that is called is determined by the @option{--with-ld}
7784 configure option, GCC's program search path, and finally by the user's
7785 @env{PATH}.  The linker used by GCC can be printed using @samp{which
7786 `gcc -print-prog-name=ld`}.
7788 @item -mfdpic
7789 @opindex mfdpic
7791 Select the FDPIC ABI, that uses function descriptors to represent
7792 pointers to functions.  Without any PIC/PIE-related options, it
7793 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7794 assumes GOT entries and small data are within a 12-bit range from the
7795 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7796 are computed with 32 bits.
7798 @item -minline-plt
7799 @opindex minline-plt
7801 Enable inlining of PLT entries in function calls to functions that are
7802 not known to bind locally.  It has no effect without @option{-mfdpic}.
7803 It's enabled by default if optimizing for speed and compiling for
7804 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7805 optimization option such as @option{-O3} or above is present in the
7806 command line.
7808 @item -mgprel-ro
7809 @opindex mgprel-ro
7811 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7812 that is known to be in read-only sections.  It's enabled by default,
7813 except for @option{-fpic} or @option{-fpie}: even though it may help
7814 make the global offset table smaller, it trades 1 instruction for 4.
7815 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7816 one of which may be shared by multiple symbols, and it avoids the need
7817 for a GOT entry for the referenced symbol, so it's more likely to be a
7818 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7820 @item -multilib-library-pic
7821 @opindex multilib-library-pic
7823 Link with the (library, not FD) pic libraries.  It's implied by
7824 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7825 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7826 it explicitly.
7828 @item -mlinked-fp
7829 @opindex mlinked-fp
7831 Follow the EABI requirement of always creating a frame pointer whenever
7832 a stack frame is allocated.  This option is enabled by default and can
7833 be disabled with @option{-mno-linked-fp}.
7835 @item -mlong-calls
7836 @opindex mno-long-calls
7837 Generate code that uses long call sequences.  This ensures that a call
7838 is always able to reach linker generated stubs.  The default is to generate
7839 long calls only when the distance from the call site to the beginning
7840 of the function or translation unit, as the case may be, exceeds a
7841 predefined limit set by the branch type being used.  The limits for
7842 normal calls are 7,600,000 and 240,000 bytes, respectively for the
7843 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
7844 240,000 bytes.
7846 Distances are measured from the beginning of functions when using the
7847 @option{-ffunction-sections} option, or when using the @option{-mgas}
7848 and @option{-mno-portable-runtime} options together under HP-UX with
7849 the SOM linker.
7851 It is normally not desirable to use this option as it will degrade
7852 performance.  However, it may be useful in large applications,
7853 particularly when partial linking is used to build the application.
7855 The types of long calls used depends on the capabilities of the
7856 assembler and linker, and the type of code being generated.  The
7857 impact on systems that support long absolute calls, and long pic
7858 symbol-difference or pc-relative calls should be relatively small.
7859 However, an indirect call is used on 32-bit ELF systems in pic code
7860 and it is quite long.
7862 @item -nolibdld
7863 @opindex nolibdld
7864 Suppress the generation of link options to search libdld.sl when the
7865 @option{-static} option is specified on HP-UX 10 and later.
7867 @item -static
7868 @opindex static
7869 The HP-UX implementation of setlocale in libc has a dependency on
7870 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
7871 when the @option{-static} option is specified, special link options
7872 are needed to resolve this dependency.
7874 On HP-UX 10 and later, the GCC driver adds the necessary options to
7875 link with libdld.sl when the @option{-static} option is specified.
7876 This causes the resulting binary to be dynamic.  On the 64-bit port,
7877 the linkers generate dynamic binaries by default in any case.  The
7878 @option{-nolibdld} option can be used to prevent the GCC driver from
7879 adding these link options.
7881 @item -threads
7882 @opindex threads
7883 Add support for multithreading with the @dfn{dce thread} library
7884 under HP-UX.  This option sets flags for both the preprocessor and
7885 linker.
7886 @end table
7888 @node i386 and x86-64 Options
7889 @subsection Intel 386 and AMD x86-64 Options
7890 @cindex i386 Options
7891 @cindex x86-64 Options
7892 @cindex Intel 386 Options
7893 @cindex AMD x86-64 Options
7895 These @samp{-m} options are defined for the i386 and x86-64 family of
7896 computers:
7898 @table @gcctabopt
7899 @item -mtune=@var{cpu-type}
7900 @opindex mtune
7901 Tune to @var{cpu-type} everything applicable about the generated code, except
7902 for the ABI and the set of available instructions.  The choices for
7903 @var{cpu-type} are:
7904 @table @emph
7905 @item i386
7906 Original Intel's i386 CPU.
7907 @item i486
7908 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
7909 @item i586, pentium
7910 Intel Pentium CPU with no MMX support.
7911 @item pentium-mmx
7912 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
7913 @item i686, pentiumpro
7914 Intel PentiumPro CPU.
7915 @item pentium2
7916 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
7917 @item pentium3, pentium3m
7918 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
7919 support.
7920 @item pentium-m
7921 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
7922 support.  Used by Centrino notebooks.
7923 @item pentium4, pentium4m
7924 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
7925 @item prescott
7926 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
7927 set support.
7928 @item nocona
7929 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
7930 SSE2 and SSE3 instruction set support.
7931 @item k6
7932 AMD K6 CPU with MMX instruction set support.
7933 @item k6-2, k6-3
7934 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
7935 @item athlon, athlon-tbird
7936 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
7937 support.
7938 @item athlon-4, athlon-xp, athlon-mp
7939 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
7940 instruction set support.
7941 @item k8, opteron, athlon64, athlon-fx
7942 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
7943 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
7944 @item winchip-c6
7945 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
7946 set support.
7947 @item winchip2
7948 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
7949 instruction set support.
7950 @item c3
7951 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
7952 implemented for this chip.)
7953 @item c3-2
7954 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
7955 implemented for this chip.)
7956 @end table
7958 While picking a specific @var{cpu-type} will schedule things appropriately
7959 for that particular chip, the compiler will not generate any code that
7960 does not run on the i386 without the @option{-march=@var{cpu-type}} option
7961 being used.
7963 @item -march=@var{cpu-type}
7964 @opindex march
7965 Generate instructions for the machine type @var{cpu-type}.  The choices
7966 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
7967 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
7969 @item -mcpu=@var{cpu-type}
7970 @opindex mcpu
7971 A deprecated synonym for @option{-mtune}.
7973 @item -m386
7974 @itemx -m486
7975 @itemx -mpentium
7976 @itemx -mpentiumpro
7977 @opindex m386
7978 @opindex m486
7979 @opindex mpentium
7980 @opindex mpentiumpro
7981 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
7982 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
7983 These synonyms are deprecated.
7985 @item -mfpmath=@var{unit}
7986 @opindex march
7987 Generate floating point arithmetics for selected unit @var{unit}.  The choices
7988 for @var{unit} are:
7990 @table @samp
7991 @item 387
7992 Use the standard 387 floating point coprocessor present majority of chips and
7993 emulated otherwise.  Code compiled with this option will run almost everywhere.
7994 The temporary results are computed in 80bit precision instead of precision
7995 specified by the type resulting in slightly different results compared to most
7996 of other chips. See @option{-ffloat-store} for more detailed description.
7998 This is the default choice for i386 compiler.
8000 @item sse
8001 Use scalar floating point instructions present in the SSE instruction set.
8002 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8003 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8004 instruction set supports only single precision arithmetics, thus the double and
8005 extended precision arithmetics is still done using 387.  Later version, present
8006 only in Pentium4 and the future AMD x86-64 chips supports double precision
8007 arithmetics too.
8009 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8010 @option{-msse2} switches to enable SSE extensions and make this option
8011 effective.  For x86-64 compiler, these extensions are enabled by default.
8013 The resulting code should be considerably faster in the majority of cases and avoid
8014 the numerical instability problems of 387 code, but may break some existing
8015 code that expects temporaries to be 80bit.
8017 This is the default choice for the x86-64 compiler.
8019 @item sse,387
8020 Attempt to utilize both instruction sets at once.  This effectively double the
8021 amount of available registers and on chips with separate execution units for
8022 387 and SSE the execution resources too.  Use this option with care, as it is
8023 still experimental, because the GCC register allocator does not model separate
8024 functional units well resulting in instable performance.
8025 @end table
8027 @item -masm=@var{dialect}
8028 @opindex masm=@var{dialect}
8029 Output asm instructions using selected @var{dialect}. Supported choices are
8030 @samp{intel} or @samp{att} (the default one).
8032 @item -mieee-fp
8033 @itemx -mno-ieee-fp
8034 @opindex mieee-fp
8035 @opindex mno-ieee-fp
8036 Control whether or not the compiler uses IEEE floating point
8037 comparisons.  These handle correctly the case where the result of a
8038 comparison is unordered.
8040 @item -msoft-float
8041 @opindex msoft-float
8042 Generate output containing library calls for floating point.
8043 @strong{Warning:} the requisite libraries are not part of GCC@.
8044 Normally the facilities of the machine's usual C compiler are used, but
8045 this can't be done directly in cross-compilation.  You must make your
8046 own arrangements to provide suitable library functions for
8047 cross-compilation.
8049 On machines where a function returns floating point results in the 80387
8050 register stack, some floating point opcodes may be emitted even if
8051 @option{-msoft-float} is used.
8053 @item -mno-fp-ret-in-387
8054 @opindex mno-fp-ret-in-387
8055 Do not use the FPU registers for return values of functions.
8057 The usual calling convention has functions return values of types
8058 @code{float} and @code{double} in an FPU register, even if there
8059 is no FPU@.  The idea is that the operating system should emulate
8060 an FPU@.
8062 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8063 in ordinary CPU registers instead.
8065 @item -mno-fancy-math-387
8066 @opindex mno-fancy-math-387
8067 Some 387 emulators do not support the @code{sin}, @code{cos} and
8068 @code{sqrt} instructions for the 387.  Specify this option to avoid
8069 generating those instructions.  This option is the default on FreeBSD,
8070 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8071 indicates that the target cpu will always have an FPU and so the
8072 instruction will not need emulation.  As of revision 2.6.1, these
8073 instructions are not generated unless you also use the
8074 @option{-funsafe-math-optimizations} switch.
8076 @item -malign-double
8077 @itemx -mno-align-double
8078 @opindex malign-double
8079 @opindex mno-align-double
8080 Control whether GCC aligns @code{double}, @code{long double}, and
8081 @code{long long} variables on a two word boundary or a one word
8082 boundary.  Aligning @code{double} variables on a two word boundary will
8083 produce code that runs somewhat faster on a @samp{Pentium} at the
8084 expense of more memory.
8086 @strong{Warning:} if you use the @option{-malign-double} switch,
8087 structures containing the above types will be aligned differently than
8088 the published application binary interface specifications for the 386
8089 and will not be binary compatible with structures in code compiled
8090 without that switch.
8092 @item -m96bit-long-double
8093 @itemx -m128bit-long-double
8094 @opindex m96bit-long-double
8095 @opindex m128bit-long-double
8096 These switches control the size of @code{long double} type. The i386
8097 application binary interface specifies the size to be 96 bits,
8098 so @option{-m96bit-long-double} is the default in 32 bit mode.
8100 Modern architectures (Pentium and newer) would prefer @code{long double}
8101 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8102 conforming to the ABI, this would not be possible.  So specifying a
8103 @option{-m128bit-long-double} will align @code{long double}
8104 to a 16 byte boundary by padding the @code{long double} with an additional
8105 32 bit zero.
8107 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8108 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8110 Notice that neither of these options enable any extra precision over the x87
8111 standard of 80 bits for a @code{long double}.
8113 @strong{Warning:} if you override the default value for your target ABI, the
8114 structures and arrays containing @code{long double} variables will change
8115 their size as well as function calling convention for function taking
8116 @code{long double} will be modified.  Hence they will not be binary
8117 compatible with arrays or structures in code compiled without that switch.
8120 @item -msvr3-shlib
8121 @itemx -mno-svr3-shlib
8122 @opindex msvr3-shlib
8123 @opindex mno-svr3-shlib
8124 Control whether GCC places uninitialized local variables into the
8125 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8126 into @code{bss}.  These options are meaningful only on System V Release 3.
8128 @item -mrtd
8129 @opindex mrtd
8130 Use a different function-calling convention, in which functions that
8131 take a fixed number of arguments return with the @code{ret} @var{num}
8132 instruction, which pops their arguments while returning.  This saves one
8133 instruction in the caller since there is no need to pop the arguments
8134 there.
8136 You can specify that an individual function is called with this calling
8137 sequence with the function attribute @samp{stdcall}.  You can also
8138 override the @option{-mrtd} option by using the function attribute
8139 @samp{cdecl}.  @xref{Function Attributes}.
8141 @strong{Warning:} this calling convention is incompatible with the one
8142 normally used on Unix, so you cannot use it if you need to call
8143 libraries compiled with the Unix compiler.
8145 Also, you must provide function prototypes for all functions that
8146 take variable numbers of arguments (including @code{printf});
8147 otherwise incorrect code will be generated for calls to those
8148 functions.
8150 In addition, seriously incorrect code will result if you call a
8151 function with too many arguments.  (Normally, extra arguments are
8152 harmlessly ignored.)
8154 @item -mregparm=@var{num}
8155 @opindex mregparm
8156 Control how many registers are used to pass integer arguments.  By
8157 default, no registers are used to pass arguments, and at most 3
8158 registers can be used.  You can control this behavior for a specific
8159 function by using the function attribute @samp{regparm}.
8160 @xref{Function Attributes}.
8162 @strong{Warning:} if you use this switch, and
8163 @var{num} is nonzero, then you must build all modules with the same
8164 value, including any libraries.  This includes the system libraries and
8165 startup modules.
8167 @item -mpreferred-stack-boundary=@var{num}
8168 @opindex mpreferred-stack-boundary
8169 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8170 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8171 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8172 size (@option{-Os}), in which case the default is the minimum correct
8173 alignment (4 bytes for x86, and 8 bytes for x86-64).
8175 On Pentium and PentiumPro, @code{double} and @code{long double} values
8176 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8177 suffer significant run time performance penalties.  On Pentium III, the
8178 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8179 penalties if it is not 16 byte aligned.
8181 To ensure proper alignment of this values on the stack, the stack boundary
8182 must be as aligned as that required by any value stored on the stack.
8183 Further, every function must be generated such that it keeps the stack
8184 aligned.  Thus calling a function compiled with a higher preferred
8185 stack boundary from a function compiled with a lower preferred stack
8186 boundary will most likely misalign the stack.  It is recommended that
8187 libraries that use callbacks always use the default setting.
8189 This extra alignment does consume extra stack space, and generally
8190 increases code size.  Code that is sensitive to stack space usage, such
8191 as embedded systems and operating system kernels, may want to reduce the
8192 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8194 @item -mmmx
8195 @itemx -mno-mmx
8196 @item -msse
8197 @itemx -mno-sse
8198 @item -msse2
8199 @itemx -mno-sse2
8200 @item -msse3
8201 @itemx -mno-sse3
8202 @item -m3dnow
8203 @itemx -mno-3dnow
8204 @opindex mmmx
8205 @opindex mno-mmx
8206 @opindex msse
8207 @opindex mno-sse
8208 @opindex m3dnow
8209 @opindex mno-3dnow
8210 These switches enable or disable the use of built-in functions that allow
8211 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8212 instruction set.
8214 @xref{X86 Built-in Functions}, for details of the functions enabled
8215 and disabled by these switches.
8217 To have SSE/SSE2 instructions generated automatically from floating-point
8218 code, see @option{-mfpmath=sse}.
8220 @item -mpush-args
8221 @itemx -mno-push-args
8222 @opindex mpush-args
8223 @opindex mno-push-args
8224 Use PUSH operations to store outgoing parameters.  This method is shorter
8225 and usually equally fast as method using SUB/MOV operations and is enabled
8226 by default.  In some cases disabling it may improve performance because of
8227 improved scheduling and reduced dependencies.
8229 @item -maccumulate-outgoing-args
8230 @opindex maccumulate-outgoing-args
8231 If enabled, the maximum amount of space required for outgoing arguments will be
8232 computed in the function prologue.  This is faster on most modern CPUs
8233 because of reduced dependencies, improved scheduling and reduced stack usage
8234 when preferred stack boundary is not equal to 2.  The drawback is a notable
8235 increase in code size.  This switch implies @option{-mno-push-args}.
8237 @item -mthreads
8238 @opindex mthreads
8239 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8240 on thread-safe exception handling must compile and link all code with the
8241 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8242 @option{-D_MT}; when linking, it links in a special thread helper library
8243 @option{-lmingwthrd} which cleans up per thread exception handling data.
8245 @item -mno-align-stringops
8246 @opindex mno-align-stringops
8247 Do not align destination of inlined string operations.  This switch reduces
8248 code size and improves performance in case the destination is already aligned,
8249 but GCC doesn't know about it.
8251 @item -minline-all-stringops
8252 @opindex minline-all-stringops
8253 By default GCC inlines string operations only when destination is known to be
8254 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8255 size, but may improve performance of code that depends on fast memcpy, strlen
8256 and memset for short lengths.
8258 @item -momit-leaf-frame-pointer
8259 @opindex momit-leaf-frame-pointer
8260 Don't keep the frame pointer in a register for leaf functions.  This
8261 avoids the instructions to save, set up and restore frame pointers and
8262 makes an extra register available in leaf functions.  The option
8263 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8264 which might make debugging harder.
8266 @item -mtls-direct-seg-refs
8267 @itemx -mno-tls-direct-seg-refs
8268 @opindex mtls-direct-seg-refs
8269 Controls whether TLS variables may be accessed with offsets from the
8270 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8271 or whether the thread base pointer must be added.  Whether or not this
8272 is legal depends on the operating system, and whether it maps the
8273 segment to cover the entire TLS area.
8275 For systems that use GNU libc, the default is on.
8276 @end table
8278 These @samp{-m} switches are supported in addition to the above
8279 on AMD x86-64 processors in 64-bit environments.
8281 @table @gcctabopt
8282 @item -m32
8283 @itemx -m64
8284 @opindex m32
8285 @opindex m64
8286 Generate code for a 32-bit or 64-bit environment.
8287 The 32-bit environment sets int, long and pointer to 32 bits and
8288 generates code that runs on any i386 system.
8289 The 64-bit environment sets int to 32 bits and long and pointer
8290 to 64 bits and generates code for AMD's x86-64 architecture.
8292 @item -mno-red-zone
8293 @opindex no-red-zone
8294 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8295 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8296 stack pointer that will not be modified by signal or interrupt handlers
8297 and therefore can be used for temporary data without adjusting the stack
8298 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8300 @item -mcmodel=small
8301 @opindex mcmodel=small
8302 Generate code for the small code model: the program and its symbols must
8303 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8304 Programs can be statically or dynamically linked.  This is the default
8305 code model.
8307 @item -mcmodel=kernel
8308 @opindex mcmodel=kernel
8309 Generate code for the kernel code model.  The kernel runs in the
8310 negative 2 GB of the address space.
8311 This model has to be used for Linux kernel code.
8313 @item -mcmodel=medium
8314 @opindex mcmodel=medium
8315 Generate code for the medium model: The program is linked in the lower 2
8316 GB of the address space but symbols can be located anywhere in the
8317 address space.  Programs can be statically or dynamically linked, but
8318 building of shared libraries are not supported with the medium model.
8320 @item -mcmodel=large
8321 @opindex mcmodel=large
8322 Generate code for the large model: This model makes no assumptions
8323 about addresses and sizes of sections.  Currently GCC does not implement
8324 this model.
8325 @end table
8327 @node IA-64 Options
8328 @subsection IA-64 Options
8329 @cindex IA-64 Options
8331 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8333 @table @gcctabopt
8334 @item -mbig-endian
8335 @opindex mbig-endian
8336 Generate code for a big endian target.  This is the default for HP-UX@.
8338 @item -mlittle-endian
8339 @opindex mlittle-endian
8340 Generate code for a little endian target.  This is the default for AIX5
8341 and GNU/Linux.
8343 @item -mgnu-as
8344 @itemx -mno-gnu-as
8345 @opindex mgnu-as
8346 @opindex mno-gnu-as
8347 Generate (or don't) code for the GNU assembler.  This is the default.
8348 @c Also, this is the default if the configure option @option{--with-gnu-as}
8349 @c is used.
8351 @item -mgnu-ld
8352 @itemx -mno-gnu-ld
8353 @opindex mgnu-ld
8354 @opindex mno-gnu-ld
8355 Generate (or don't) code for the GNU linker.  This is the default.
8356 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8357 @c is used.
8359 @item -mno-pic
8360 @opindex mno-pic
8361 Generate code that does not use a global pointer register.  The result
8362 is not position independent code, and violates the IA-64 ABI@.
8364 @item -mvolatile-asm-stop
8365 @itemx -mno-volatile-asm-stop
8366 @opindex mvolatile-asm-stop
8367 @opindex mno-volatile-asm-stop
8368 Generate (or don't) a stop bit immediately before and after volatile asm
8369 statements.
8371 @item -mb-step
8372 @opindex mb-step
8373 Generate code that works around Itanium B step errata.
8375 @item -mregister-names
8376 @itemx -mno-register-names
8377 @opindex mregister-names
8378 @opindex mno-register-names
8379 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8380 the stacked registers.  This may make assembler output more readable.
8382 @item -mno-sdata
8383 @itemx -msdata
8384 @opindex mno-sdata
8385 @opindex msdata
8386 Disable (or enable) optimizations that use the small data section.  This may
8387 be useful for working around optimizer bugs.
8389 @item -mconstant-gp
8390 @opindex mconstant-gp
8391 Generate code that uses a single constant global pointer value.  This is
8392 useful when compiling kernel code.
8394 @item -mauto-pic
8395 @opindex mauto-pic
8396 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8397 This is useful when compiling firmware code.
8399 @item -minline-float-divide-min-latency
8400 @opindex minline-float-divide-min-latency
8401 Generate code for inline divides of floating point values
8402 using the minimum latency algorithm.
8404 @item -minline-float-divide-max-throughput
8405 @opindex minline-float-divide-max-throughput
8406 Generate code for inline divides of floating point values
8407 using the maximum throughput algorithm.
8409 @item -minline-int-divide-min-latency
8410 @opindex minline-int-divide-min-latency
8411 Generate code for inline divides of integer values
8412 using the minimum latency algorithm.
8414 @item -minline-int-divide-max-throughput
8415 @opindex minline-int-divide-max-throughput
8416 Generate code for inline divides of integer values
8417 using the maximum throughput algorithm.
8419 @item -mno-dwarf2-asm
8420 @itemx -mdwarf2-asm
8421 @opindex mno-dwarf2-asm
8422 @opindex mdwarf2-asm
8423 Don't (or do) generate assembler code for the DWARF2 line number debugging
8424 info.  This may be useful when not using the GNU assembler.
8426 @item -mfixed-range=@var{register-range}
8427 @opindex mfixed-range
8428 Generate code treating the given register range as fixed registers.
8429 A fixed register is one that the register allocator can not use.  This is
8430 useful when compiling kernel code.  A register range is specified as
8431 two registers separated by a dash.  Multiple register ranges can be
8432 specified separated by a comma.
8434 @item -mearly-stop-bits
8435 @itemx -mno-early-stop-bits
8436 @opindex mearly-stop-bits
8437 @opindex mno-early-stop-bits
8438 Allow stop bits to be placed earlier than immediately preceding the
8439 instruction that triggered the stop bit.  This can improve instruction
8440 scheduling, but does not always do so.
8441 @end table
8443 @node M32R/D Options
8444 @subsection M32R/D Options
8445 @cindex M32R/D options
8447 These @option{-m} options are defined for Renesas M32R/D architectures:
8449 @table @gcctabopt
8450 @item -m32r2
8451 @opindex m32r2
8452 Generate code for the M32R/2@.
8454 @item -m32rx
8455 @opindex m32rx
8456 Generate code for the M32R/X@.
8458 @item -m32r
8459 @opindex m32r
8460 Generate code for the M32R@.  This is the default.
8462 @item -mmodel=small
8463 @opindex mmodel=small
8464 Assume all objects live in the lower 16MB of memory (so that their addresses
8465 can be loaded with the @code{ld24} instruction), and assume all subroutines
8466 are reachable with the @code{bl} instruction.
8467 This is the default.
8469 The addressability of a particular object can be set with the
8470 @code{model} attribute.
8472 @item -mmodel=medium
8473 @opindex mmodel=medium
8474 Assume objects may be anywhere in the 32-bit address space (the compiler
8475 will generate @code{seth/add3} instructions to load their addresses), and
8476 assume all subroutines are reachable with the @code{bl} instruction.
8478 @item -mmodel=large
8479 @opindex mmodel=large
8480 Assume objects may be anywhere in the 32-bit address space (the compiler
8481 will generate @code{seth/add3} instructions to load their addresses), and
8482 assume subroutines may not be reachable with the @code{bl} instruction
8483 (the compiler will generate the much slower @code{seth/add3/jl}
8484 instruction sequence).
8486 @item -msdata=none
8487 @opindex msdata=none
8488 Disable use of the small data area.  Variables will be put into
8489 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8490 @code{section} attribute has been specified).
8491 This is the default.
8493 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8494 Objects may be explicitly put in the small data area with the
8495 @code{section} attribute using one of these sections.
8497 @item -msdata=sdata
8498 @opindex msdata=sdata
8499 Put small global and static data in the small data area, but do not
8500 generate special code to reference them.
8502 @item -msdata=use
8503 @opindex msdata=use
8504 Put small global and static data in the small data area, and generate
8505 special instructions to reference them.
8507 @item -G @var{num}
8508 @opindex G
8509 @cindex smaller data references
8510 Put global and static objects less than or equal to @var{num} bytes
8511 into the small data or bss sections instead of the normal data or bss
8512 sections.  The default value of @var{num} is 8.
8513 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8514 for this option to have any effect.
8516 All modules should be compiled with the same @option{-G @var{num}} value.
8517 Compiling with different values of @var{num} may or may not work; if it
8518 doesn't the linker will give an error message---incorrect code will not be
8519 generated.
8521 @item -mdebug
8522 @opindex mdebug
8523 Makes the M32R specific code in the compiler display some statistics
8524 that might help in debugging programs.
8526 @item -malign-loops
8527 @opindex malign-loops
8528 Align all loops to a 32-byte boundary.
8530 @item -mno-align-loops
8531 @opindex mno-align-loops
8532 Do not enforce a 32-byte alignment for loops.  This is the default.
8534 @item -missue-rate=@var{number}
8535 @opindex missue-rate=@var{number}
8536 Issue @var{number} instructions per cycle.  @var{number} can only be 1
8537 or 2.
8539 @item -mbranch-cost=@var{number}
8540 @opindex mbranch-cost=@var{number}
8541 @var{number} can only be 1 or 2.  If it is 1 then branches will be
8542 preferred over conditional code, if it is 2, then the opposite will
8543 apply.
8545 @item -mflush-trap=@var{number}
8546 @opindex mflush-trap=@var{number}
8547 Specifies the trap number to use to flush the cache.  The default is
8548 12.  Valid numbers are between 0 and 15 inclusive.
8550 @item -mno-flush-trap
8551 @opindex mno-flush-trap
8552 Specifies that the cache cannot be flushed by using a trap.
8554 @item -mflush-func=@var{name}
8555 @opindex mflush-func=@var{name}
8556 Specifies the name of the operating system function to call to flush
8557 the cache.  The default is @emph{_flush_cache}, but a function call
8558 will only be used if a trap is not available.
8560 @item -mno-flush-func
8561 @opindex mno-flush-func
8562 Indicates that there is no OS function for flushing the cache.
8564 @end table
8566 @node M680x0 Options
8567 @subsection M680x0 Options
8568 @cindex M680x0 options
8570 These are the @samp{-m} options defined for the 68000 series.  The default
8571 values for these options depends on which style of 68000 was selected when
8572 the compiler was configured; the defaults for the most common choices are
8573 given below.
8575 @table @gcctabopt
8576 @item -m68000
8577 @itemx -mc68000
8578 @opindex m68000
8579 @opindex mc68000
8580 Generate output for a 68000.  This is the default
8581 when the compiler is configured for 68000-based systems.
8583 Use this option for microcontrollers with a 68000 or EC000 core,
8584 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
8586 @item -m68020
8587 @itemx -mc68020
8588 @opindex m68020
8589 @opindex mc68020
8590 Generate output for a 68020.  This is the default
8591 when the compiler is configured for 68020-based systems.
8593 @item -m68881
8594 @opindex m68881
8595 Generate output containing 68881 instructions for floating point.
8596 This is the default for most 68020 systems unless @option{--nfp} was
8597 specified when the compiler was configured.
8599 @item -m68030
8600 @opindex m68030
8601 Generate output for a 68030.  This is the default when the compiler is
8602 configured for 68030-based systems.
8604 @item -m68040
8605 @opindex m68040
8606 Generate output for a 68040.  This is the default when the compiler is
8607 configured for 68040-based systems.
8609 This option inhibits the use of 68881/68882 instructions that have to be
8610 emulated by software on the 68040.  Use this option if your 68040 does not
8611 have code to emulate those instructions.
8613 @item -m68060
8614 @opindex m68060
8615 Generate output for a 68060.  This is the default when the compiler is
8616 configured for 68060-based systems.
8618 This option inhibits the use of 68020 and 68881/68882 instructions that
8619 have to be emulated by software on the 68060.  Use this option if your 68060
8620 does not have code to emulate those instructions.
8622 @item -mcpu32
8623 @opindex mcpu32
8624 Generate output for a CPU32.  This is the default
8625 when the compiler is configured for CPU32-based systems.
8627 Use this option for microcontrollers with a
8628 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
8629 68336, 68340, 68341, 68349 and 68360.
8631 @item -m5200
8632 @opindex m5200
8633 Generate output for a 520X ``coldfire'' family cpu.  This is the default
8634 when the compiler is configured for 520X-based systems.
8636 Use this option for microcontroller with a 5200 core, including
8637 the MCF5202, MCF5203, MCF5204 and MCF5202.
8640 @item -m68020-40
8641 @opindex m68020-40
8642 Generate output for a 68040, without using any of the new instructions.
8643 This results in code which can run relatively efficiently on either a
8644 68020/68881 or a 68030 or a 68040.  The generated code does use the
8645 68881 instructions that are emulated on the 68040.
8647 @item -m68020-60
8648 @opindex m68020-60
8649 Generate output for a 68060, without using any of the new instructions.
8650 This results in code which can run relatively efficiently on either a
8651 68020/68881 or a 68030 or a 68040.  The generated code does use the
8652 68881 instructions that are emulated on the 68060.
8654 @item -msoft-float
8655 @opindex msoft-float
8656 Generate output containing library calls for floating point.
8657 @strong{Warning:} the requisite libraries are not available for all m68k
8658 targets.  Normally the facilities of the machine's usual C compiler are
8659 used, but this can't be done directly in cross-compilation.  You must
8660 make your own arrangements to provide suitable library functions for
8661 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
8662 @samp{m68k-*-coff} do provide software floating point support.
8664 @item -mshort
8665 @opindex mshort
8666 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8667 Additionally, parameters passed on the stack are also aligned to a
8668 16-bit boundary even on targets whose API mandates promotion to 32-bit.
8670 @item -mnobitfield
8671 @opindex mnobitfield
8672 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
8673 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
8675 @item -mbitfield
8676 @opindex mbitfield
8677 Do use the bit-field instructions.  The @option{-m68020} option implies
8678 @option{-mbitfield}.  This is the default if you use a configuration
8679 designed for a 68020.
8681 @item -mrtd
8682 @opindex mrtd
8683 Use a different function-calling convention, in which functions
8684 that take a fixed number of arguments return with the @code{rtd}
8685 instruction, which pops their arguments while returning.  This
8686 saves one instruction in the caller since there is no need to pop
8687 the arguments there.
8689 This calling convention is incompatible with the one normally
8690 used on Unix, so you cannot use it if you need to call libraries
8691 compiled with the Unix compiler.
8693 Also, you must provide function prototypes for all functions that
8694 take variable numbers of arguments (including @code{printf});
8695 otherwise incorrect code will be generated for calls to those
8696 functions.
8698 In addition, seriously incorrect code will result if you call a
8699 function with too many arguments.  (Normally, extra arguments are
8700 harmlessly ignored.)
8702 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
8703 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
8705 @item -malign-int
8706 @itemx -mno-align-int
8707 @opindex malign-int
8708 @opindex mno-align-int
8709 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
8710 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
8711 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
8712 Aligning variables on 32-bit boundaries produces code that runs somewhat
8713 faster on processors with 32-bit busses at the expense of more memory.
8715 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
8716 align structures containing the above types  differently than
8717 most published application binary interface specifications for the m68k.
8719 @item -mpcrel
8720 @opindex mpcrel
8721 Use the pc-relative addressing mode of the 68000 directly, instead of
8722 using a global offset table.  At present, this option implies @option{-fpic},
8723 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
8724 not presently supported with @option{-mpcrel}, though this could be supported for
8725 68020 and higher processors.
8727 @item -mno-strict-align
8728 @itemx -mstrict-align
8729 @opindex mno-strict-align
8730 @opindex mstrict-align
8731 Do not (do) assume that unaligned memory references will be handled by
8732 the system.
8734 @item -msep-data
8735 Generate code that allows the data segment to be located in a different
8736 area of memory from the text segment.  This allows for execute in place in
8737 an environment without virtual memory management.  This option implies -fPIC.
8739 @item -mno-sep-data
8740 Generate code that assumes that the data segment follows the text segment.
8741 This is the default.
8743 @item -mid-shared-library
8744 Generate code that supports shared libraries via the library ID method.
8745 This allows for execute in place and shared libraries in an environment
8746 without virtual memory management.  This option implies -fPIC.
8748 @item -mno-id-shared-library
8749 Generate code that doesn't assume ID based shared libraries are being used.
8750 This is the default.
8752 @item -mshared-library-id=n
8753 Specified the identification number of the ID based shared library being
8754 compiled.  Specifying a value of 0 will generate more compact code, specifying
8755 other values will force the allocation of that number to the current
8756 library but is no more space or time efficient than omitting this option.
8758 @end table
8760 @node M68hc1x Options
8761 @subsection M68hc1x Options
8762 @cindex M68hc1x options
8764 These are the @samp{-m} options defined for the 68hc11 and 68hc12
8765 microcontrollers.  The default values for these options depends on
8766 which style of microcontroller was selected when the compiler was configured;
8767 the defaults for the most common choices are given below.
8769 @table @gcctabopt
8770 @item -m6811
8771 @itemx -m68hc11
8772 @opindex m6811
8773 @opindex m68hc11
8774 Generate output for a 68HC11.  This is the default
8775 when the compiler is configured for 68HC11-based systems.
8777 @item -m6812
8778 @itemx -m68hc12
8779 @opindex m6812
8780 @opindex m68hc12
8781 Generate output for a 68HC12.  This is the default
8782 when the compiler is configured for 68HC12-based systems.
8784 @item -m68S12
8785 @itemx -m68hcs12
8786 @opindex m68S12
8787 @opindex m68hcs12
8788 Generate output for a 68HCS12.
8790 @item -mauto-incdec
8791 @opindex mauto-incdec
8792 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
8793 addressing modes.
8795 @item -minmax
8796 @itemx -nominmax
8797 @opindex minmax
8798 @opindex mnominmax
8799 Enable the use of 68HC12 min and max instructions.
8801 @item -mlong-calls
8802 @itemx -mno-long-calls
8803 @opindex mlong-calls
8804 @opindex mno-long-calls
8805 Treat all calls as being far away (near).  If calls are assumed to be
8806 far away, the compiler will use the @code{call} instruction to
8807 call a function and the @code{rtc} instruction for returning.
8809 @item -mshort
8810 @opindex mshort
8811 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8813 @item -msoft-reg-count=@var{count}
8814 @opindex msoft-reg-count
8815 Specify the number of pseudo-soft registers which are used for the
8816 code generation.  The maximum number is 32.  Using more pseudo-soft
8817 register may or may not result in better code depending on the program.
8818 The default is 4 for 68HC11 and 2 for 68HC12.
8820 @end table
8822 @node MCore Options
8823 @subsection MCore Options
8824 @cindex MCore options
8826 These are the @samp{-m} options defined for the Motorola M*Core
8827 processors.
8829 @table @gcctabopt
8831 @item -mhardlit
8832 @itemx -mno-hardlit
8833 @opindex mhardlit
8834 @opindex mno-hardlit
8835 Inline constants into the code stream if it can be done in two
8836 instructions or less.
8838 @item -mdiv
8839 @itemx -mno-div
8840 @opindex mdiv
8841 @opindex mno-div
8842 Use the divide instruction.  (Enabled by default).
8844 @item -mrelax-immediate
8845 @itemx -mno-relax-immediate
8846 @opindex mrelax-immediate
8847 @opindex mno-relax-immediate
8848 Allow arbitrary sized immediates in bit operations.
8850 @item -mwide-bitfields
8851 @itemx -mno-wide-bitfields
8852 @opindex mwide-bitfields
8853 @opindex mno-wide-bitfields
8854 Always treat bit-fields as int-sized.
8856 @item -m4byte-functions
8857 @itemx -mno-4byte-functions
8858 @opindex m4byte-functions
8859 @opindex mno-4byte-functions
8860 Force all functions to be aligned to a four byte boundary.
8862 @item -mcallgraph-data
8863 @itemx -mno-callgraph-data
8864 @opindex mcallgraph-data
8865 @opindex mno-callgraph-data
8866 Emit callgraph information.
8868 @item -mslow-bytes
8869 @itemx -mno-slow-bytes
8870 @opindex mslow-bytes
8871 @opindex mno-slow-bytes
8872 Prefer word access when reading byte quantities.
8874 @item -mlittle-endian
8875 @itemx -mbig-endian
8876 @opindex mlittle-endian
8877 @opindex mbig-endian
8878 Generate code for a little endian target.
8880 @item -m210
8881 @itemx -m340
8882 @opindex m210
8883 @opindex m340
8884 Generate code for the 210 processor.
8885 @end table
8887 @node MIPS Options
8888 @subsection MIPS Options
8889 @cindex MIPS options
8891 @table @gcctabopt
8893 @item -EB
8894 @opindex EB
8895 Generate big-endian code.
8897 @item -EL
8898 @opindex EL
8899 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
8900 configurations.
8902 @item -march=@var{arch}
8903 @opindex march
8904 Generate code that will run on @var{arch}, which can be the name of a
8905 generic MIPS ISA, or the name of a particular processor.
8906 The ISA names are:
8907 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
8908 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
8909 The processor names are:
8910 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
8911 @samp{m4k},
8912 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
8913 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
8914 @samp{rm9000},
8915 @samp{orion},
8916 @samp{sb1},
8917 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
8918 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
8919 The special value @samp{from-abi} selects the
8920 most compatible architecture for the selected ABI (that is,
8921 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
8923 In processor names, a final @samp{000} can be abbreviated as @samp{k}
8924 (for example, @samp{-march=r2k}).  Prefixes are optional, and
8925 @samp{vr} may be written @samp{r}.
8927 GCC defines two macros based on the value of this option.  The first
8928 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
8929 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
8930 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
8931 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
8932 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
8934 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
8935 above.  In other words, it will have the full prefix and will not
8936 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
8937 the macro names the resolved architecture (either @samp{"mips1"} or
8938 @samp{"mips3"}).  It names the default architecture when no
8939 @option{-march} option is given.
8941 @item -mtune=@var{arch}
8942 @opindex mtune
8943 Optimize for @var{arch}.  Among other things, this option controls
8944 the way instructions are scheduled, and the perceived cost of arithmetic
8945 operations.  The list of @var{arch} values is the same as for
8946 @option{-march}.
8948 When this option is not used, GCC will optimize for the processor
8949 specified by @option{-march}.  By using @option{-march} and
8950 @option{-mtune} together, it is possible to generate code that will
8951 run on a family of processors, but optimize the code for one
8952 particular member of that family.
8954 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
8955 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
8956 @samp{-march} ones described above.
8958 @item -mips1
8959 @opindex mips1
8960 Equivalent to @samp{-march=mips1}.
8962 @item -mips2
8963 @opindex mips2
8964 Equivalent to @samp{-march=mips2}.
8966 @item -mips3
8967 @opindex mips3
8968 Equivalent to @samp{-march=mips3}.
8970 @item -mips4
8971 @opindex mips4
8972 Equivalent to @samp{-march=mips4}.
8974 @item -mips32
8975 @opindex mips32
8976 Equivalent to @samp{-march=mips32}.
8978 @item -mips32r2
8979 @opindex mips32r2
8980 Equivalent to @samp{-march=mips32r2}.
8982 @item -mips64
8983 @opindex mips64
8984 Equivalent to @samp{-march=mips64}.
8986 @item -mips16
8987 @itemx -mno-mips16
8988 @opindex mips16
8989 @opindex mno-mips16
8990 Use (do not use) the MIPS16 ISA.
8992 @item -mabi=32
8993 @itemx -mabi=o64
8994 @itemx -mabi=n32
8995 @itemx -mabi=64
8996 @itemx -mabi=eabi
8997 @opindex mabi=32
8998 @opindex mabi=o64
8999 @opindex mabi=n32
9000 @opindex mabi=64
9001 @opindex mabi=eabi
9002 Generate code for the given ABI@.
9004 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9005 generates 64-bit code when you select a 64-bit architecture, but you
9006 can use @option{-mgp32} to get 32-bit code instead.
9008 For information about the O64 ABI, see
9009 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9011 @item -mabicalls
9012 @itemx -mno-abicalls
9013 @opindex mabicalls
9014 @opindex mno-abicalls
9015 Generate (do not generate) SVR4-style position-independent code.
9016 @option{-mabicalls} is the default for SVR4-based systems.
9018 @item -mxgot
9019 @itemx -mno-xgot
9020 @opindex mxgot
9021 @opindex mno-xgot
9022 Lift (do not lift) the usual restrictions on the size of the global
9023 offset table.
9025 GCC normally uses a single instruction to load values from the GOT.
9026 While this is relatively efficient, it will only work if the GOT
9027 is smaller than about 64k.  Anything larger will cause the linker
9028 to report an error such as:
9030 @cindex relocation truncated to fit (MIPS)
9031 @smallexample
9032 relocation truncated to fit: R_MIPS_GOT16 foobar
9033 @end smallexample
9035 If this happens, you should recompile your code with @option{-mxgot}.
9036 It should then work with very large GOTs, although it will also be
9037 less efficient, since it will take three instructions to fetch the
9038 value of a global symbol.
9040 Note that some linkers can create multiple GOTs.  If you have such a
9041 linker, you should only need to use @option{-mxgot} when a single object
9042 file accesses more than 64k's worth of GOT entries.  Very few do.
9044 These options have no effect unless GCC is generating position
9045 independent code.
9047 @item -mgp32
9048 @opindex mgp32
9049 Assume that general-purpose registers are 32 bits wide.
9051 @item -mgp64
9052 @opindex mgp64
9053 Assume that general-purpose registers are 64 bits wide.
9055 @item -mfp32
9056 @opindex mfp32
9057 Assume that floating-point registers are 32 bits wide.
9059 @item -mfp64
9060 @opindex mfp64
9061 Assume that floating-point registers are 64 bits wide.
9063 @item -mhard-float
9064 @opindex mhard-float
9065 Use floating-point coprocessor instructions.
9067 @item -msoft-float
9068 @opindex msoft-float
9069 Do not use floating-point coprocessor instructions.  Implement
9070 floating-point calculations using library calls instead.
9072 @item -msingle-float
9073 @opindex msingle-float
9074 Assume that the floating-point coprocessor only supports single-precision
9075 operations.
9077 @itemx -mdouble-float
9078 @opindex mdouble-float
9079 Assume that the floating-point coprocessor supports double-precision
9080 operations.  This is the default.
9082 @item -mint64
9083 @opindex mint64
9084 Force @code{int} and @code{long} types to be 64 bits wide.  See
9085 @option{-mlong32} for an explanation of the default and the way
9086 that the pointer size is determined.
9088 @item -mlong64
9089 @opindex mlong64
9090 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9091 an explanation of the default and the way that the pointer size is
9092 determined.
9094 @item -mlong32
9095 @opindex mlong32
9096 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9098 The default size of @code{int}s, @code{long}s and pointers depends on
9099 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9100 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9101 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9102 or the same size as integer registers, whichever is smaller.
9104 @item -G @var{num}
9105 @opindex G
9106 @cindex smaller data references (MIPS)
9107 @cindex gp-relative references (MIPS)
9108 Put global and static items less than or equal to @var{num} bytes into
9109 the small data or bss section instead of the normal data or bss section.
9110 This allows the data to be accessed using a single instruction.
9112 All modules should be compiled with the same @option{-G @var{num}}
9113 value.
9115 @item -membedded-data
9116 @itemx -mno-embedded-data
9117 @opindex membedded-data
9118 @opindex mno-embedded-data
9119 Allocate variables to the read-only data section first if possible, then
9120 next in the small data section if possible, otherwise in data.  This gives
9121 slightly slower code than the default, but reduces the amount of RAM required
9122 when executing, and thus may be preferred for some embedded systems.
9124 @item -muninit-const-in-rodata
9125 @itemx -mno-uninit-const-in-rodata
9126 @opindex muninit-const-in-rodata
9127 @opindex mno-uninit-const-in-rodata
9128 Put uninitialized @code{const} variables in the read-only data section.
9129 This option is only meaningful in conjunction with @option{-membedded-data}.
9131 @item -msplit-addresses
9132 @itemx -mno-split-addresses
9133 @opindex msplit-addresses
9134 @opindex mno-split-addresses
9135 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9136 relocation operators.  This option has been superceded by
9137 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9139 @item -mexplicit-relocs
9140 @itemx -mno-explicit-relocs
9141 @opindex mexplicit-relocs
9142 @opindex mno-explicit-relocs
9143 Use (do not use) assembler relocation operators when dealing with symbolic
9144 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9145 is to use assembler macros instead.
9147 @option{-mexplicit-relocs} is usually the default if GCC was configured
9148 to use an assembler that supports relocation operators.  However, the
9149 combination of @option{-mabicalls} and @option{-fno-unit-at-a-time}
9150 implies @option{-mno-explicit-relocs} unless explicitly overridden.
9151 This is because, when generating abicalls, the choice of relocation
9152 depends on whether a symbol is local or global.  In some rare cases,
9153 GCC will not be able to decide this until the whole compilation unit
9154 has been read.
9156 @item -mrnames
9157 @itemx -mno-rnames
9158 @opindex mrnames
9159 @opindex mno-rnames
9160 Generate (do not generate) code that refers to registers using their
9161 software names.  The default is @option{-mno-rnames}, which tells GCC
9162 to use hardware names like @samp{$4} instead of software names like
9163 @samp{a0}.  The only assembler known to support @option{-rnames} is
9164 the Algorithmics assembler.
9166 @item -mcheck-zero-division
9167 @itemx -mno-check-zero-division
9168 @opindex mcheck-zero-division
9169 @opindex mno-check-zero-division
9170 Trap (do not trap) on integer division by zero.  The default is
9171 @option{-mcheck-zero-division}.
9173 @item -mmemcpy
9174 @itemx -mno-memcpy
9175 @opindex mmemcpy
9176 @opindex mno-memcpy
9177 Force (do not force) the use of @code{memcpy()} for non-trivial block
9178 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9179 most constant-sized copies.
9181 @item -mlong-calls
9182 @itemx -mno-long-calls
9183 @opindex mlong-calls
9184 @opindex mno-long-calls
9185 Disable (do not disable) use of the @code{jal} instruction.  Calling
9186 functions using @code{jal} is more efficient but requires the caller
9187 and callee to be in the same 256 megabyte segment.
9189 This option has no effect on abicalls code.  The default is
9190 @option{-mno-long-calls}.
9192 @item -mmad
9193 @itemx -mno-mad
9194 @opindex mmad
9195 @opindex mno-mad
9196 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9197 instructions, as provided by the R4650 ISA.
9199 @item -mfused-madd
9200 @itemx -mno-fused-madd
9201 @opindex mfused-madd
9202 @opindex mno-fused-madd
9203 Enable (disable) use of the floating point multiply-accumulate
9204 instructions, when they are available.  The default is
9205 @option{-mfused-madd}.
9207 When multiply-accumulate instructions are used, the intermediate
9208 product is calculated to infinite precision and is not subject to
9209 the FCSR Flush to Zero bit.  This may be undesirable in some
9210 circumstances.
9212 @item -nocpp
9213 @opindex nocpp
9214 Tell the MIPS assembler to not run its preprocessor over user
9215 assembler files (with a @samp{.s} suffix) when assembling them.
9217 @item -mfix-r4000
9218 @itemx -mno-fix-r4000
9219 @opindex mfix-r4000
9220 @opindex mno-fix-r4000
9221 Work around certain R4000 CPU errata:
9222 @itemize @minus
9223 @item
9224 A double-word or a variable shift may give an incorrect result if executed
9225 immediately after starting an integer division.
9226 @item
9227 A double-word or a variable shift may give an incorrect result if executed
9228 while an integer multiplication is in progress.
9229 @item
9230 An integer division may give an incorrect result if started in a delay slot
9231 of a taken branch or a jump.
9232 @end itemize
9234 @item -mfix-r4400
9235 @itemx -mno-fix-r4400
9236 @opindex mfix-r4400
9237 @opindex mno-fix-r4400
9238 Work around certain R4400 CPU errata:
9239 @itemize @minus
9240 @item
9241 A double-word or a variable shift may give an incorrect result if executed
9242 immediately after starting an integer division.
9243 @end itemize
9245 @item -mfix-vr4120
9246 @itemx -mno-fix-vr4120
9247 @opindex mfix-vr4120
9248 Work around certain VR4120 errata:
9249 @itemize @minus
9250 @item
9251 @code{dmultu} does not always produce the correct result.
9252 @item
9253 @code{div} and @code{ddiv} do not always produce the correct result if one
9254 of the operands is negative.
9255 @end itemize
9256 The workarounds for the division errata rely on special functions in
9257 @file{libgcc.a}.  At present, these functions are only provided by
9258 the @code{mips64vr*-elf} configurations.
9260 Other VR4120 errata require a nop to be inserted between certain pairs of
9261 instructions.  These errata are handled by the assembler, not by GCC itself.
9263 @item -mfix-sb1
9264 @itemx -mno-fix-sb1
9265 @opindex mfix-sb1
9266 Work around certain SB-1 CPU core errata.
9267 (This flag currently works around the SB-1 revision 2
9268 ``F1'' and ``F2'' floating point errata.)
9270 @item -mflush-func=@var{func}
9271 @itemx -mno-flush-func
9272 @opindex mflush-func
9273 Specifies the function to call to flush the I and D caches, or to not
9274 call any such function.  If called, the function must take the same
9275 arguments as the common @code{_flush_func()}, that is, the address of the
9276 memory range for which the cache is being flushed, the size of the
9277 memory range, and the number 3 (to flush both caches).  The default
9278 depends on the target GCC was configured for, but commonly is either
9279 @samp{_flush_func} or @samp{__cpu_flush}.
9281 @item -mbranch-likely
9282 @itemx -mno-branch-likely
9283 @opindex mbranch-likely
9284 @opindex mno-branch-likely
9285 Enable or disable use of Branch Likely instructions, regardless of the
9286 default for the selected architecture.  By default, Branch Likely
9287 instructions may be generated if they are supported by the selected
9288 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9289 and processors which implement those architectures; for those, Branch
9290 Likely instructions will not be generated by default because the MIPS32
9291 and MIPS64 architectures specifically deprecate their use.
9293 @item -mfp-exceptions
9294 @itemx -mno-fp-exceptions
9295 @opindex mfp-exceptions
9296 Specifies whether FP exceptions are enabled.  This affects how we schedule
9297 FP instructions for some processors.  The default is that FP exceptions are
9298 enabled.
9300 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9301 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9302 FP pipe.
9304 @item -mvr4130-align
9305 @itemx -mno-vr4130-align
9306 @opindex mvr4130-align
9307 The VR4130 pipeline is two-way superscalar, but can only issue two
9308 instructions together if the first one is 8-byte aligned.  When this
9309 option is enabled, GCC will align pairs of instructions that it
9310 thinks should execute in parallel.
9312 This option only has an effect when optimizing for the VR4130.
9313 It normally makes code faster, but at the expense of making it bigger.
9314 It is enabled by default at optimization level @option{-O3}.
9315 @end table
9317 @node MMIX Options
9318 @subsection MMIX Options
9319 @cindex MMIX Options
9321 These options are defined for the MMIX:
9323 @table @gcctabopt
9324 @item -mlibfuncs
9325 @itemx -mno-libfuncs
9326 @opindex mlibfuncs
9327 @opindex mno-libfuncs
9328 Specify that intrinsic library functions are being compiled, passing all
9329 values in registers, no matter the size.
9331 @item -mepsilon
9332 @itemx -mno-epsilon
9333 @opindex mepsilon
9334 @opindex mno-epsilon
9335 Generate floating-point comparison instructions that compare with respect
9336 to the @code{rE} epsilon register.
9338 @item -mabi=mmixware
9339 @itemx -mabi=gnu
9340 @opindex mabi-mmixware
9341 @opindex mabi=gnu
9342 Generate code that passes function parameters and return values that (in
9343 the called function) are seen as registers @code{$0} and up, as opposed to
9344 the GNU ABI which uses global registers @code{$231} and up.
9346 @item -mzero-extend
9347 @itemx -mno-zero-extend
9348 @opindex mzero-extend
9349 @opindex mno-zero-extend
9350 When reading data from memory in sizes shorter than 64 bits, use (do not
9351 use) zero-extending load instructions by default, rather than
9352 sign-extending ones.
9354 @item -mknuthdiv
9355 @itemx -mno-knuthdiv
9356 @opindex mknuthdiv
9357 @opindex mno-knuthdiv
9358 Make the result of a division yielding a remainder have the same sign as
9359 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9360 remainder follows the sign of the dividend.  Both methods are
9361 arithmetically valid, the latter being almost exclusively used.
9363 @item -mtoplevel-symbols
9364 @itemx -mno-toplevel-symbols
9365 @opindex mtoplevel-symbols
9366 @opindex mno-toplevel-symbols
9367 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9368 code can be used with the @code{PREFIX} assembly directive.
9370 @item -melf
9371 @opindex melf
9372 Generate an executable in the ELF format, rather than the default
9373 @samp{mmo} format used by the @command{mmix} simulator.
9375 @item -mbranch-predict
9376 @itemx -mno-branch-predict
9377 @opindex mbranch-predict
9378 @opindex mno-branch-predict
9379 Use (do not use) the probable-branch instructions, when static branch
9380 prediction indicates a probable branch.
9382 @item -mbase-addresses
9383 @itemx -mno-base-addresses
9384 @opindex mbase-addresses
9385 @opindex mno-base-addresses
9386 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9387 base address automatically generates a request (handled by the assembler
9388 and the linker) for a constant to be set up in a global register.  The
9389 register is used for one or more base address requests within the range 0
9390 to 255 from the value held in the register.  The generally leads to short
9391 and fast code, but the number of different data items that can be
9392 addressed is limited.  This means that a program that uses lots of static
9393 data may require @option{-mno-base-addresses}.
9395 @item -msingle-exit
9396 @itemx -mno-single-exit
9397 @opindex msingle-exit
9398 @opindex mno-single-exit
9399 Force (do not force) generated code to have a single exit point in each
9400 function.
9401 @end table
9403 @node MN10300 Options
9404 @subsection MN10300 Options
9405 @cindex MN10300 options
9407 These @option{-m} options are defined for Matsushita MN10300 architectures:
9409 @table @gcctabopt
9410 @item -mmult-bug
9411 @opindex mmult-bug
9412 Generate code to avoid bugs in the multiply instructions for the MN10300
9413 processors.  This is the default.
9415 @item -mno-mult-bug
9416 @opindex mno-mult-bug
9417 Do not generate code to avoid bugs in the multiply instructions for the
9418 MN10300 processors.
9420 @item -mam33
9421 @opindex mam33
9422 Generate code which uses features specific to the AM33 processor.
9424 @item -mno-am33
9425 @opindex mno-am33
9426 Do not generate code which uses features specific to the AM33 processor.  This
9427 is the default.
9429 @item -mno-crt0
9430 @opindex mno-crt0
9431 Do not link in the C run-time initialization object file.
9433 @item -mrelax
9434 @opindex mrelax
9435 Indicate to the linker that it should perform a relaxation optimization pass
9436 to shorten branches, calls and absolute memory addresses.  This option only
9437 has an effect when used on the command line for the final link step.
9439 This option makes symbolic debugging impossible.
9440 @end table
9442 @node NS32K Options
9443 @subsection NS32K Options
9444 @cindex NS32K options
9446 These are the @samp{-m} options defined for the 32000 series.  The default
9447 values for these options depends on which style of 32000 was selected when
9448 the compiler was configured; the defaults for the most common choices are
9449 given below.
9451 @table @gcctabopt
9452 @item -m32032
9453 @itemx -m32032
9454 @opindex m32032
9455 @opindex m32032
9456 Generate output for a 32032.  This is the default
9457 when the compiler is configured for 32032 and 32016 based systems.
9459 @item -m32332
9460 @itemx -m32332
9461 @opindex m32332
9462 @opindex m32332
9463 Generate output for a 32332.  This is the default
9464 when the compiler is configured for 32332-based systems.
9466 @item -m32532
9467 @itemx -m32532
9468 @opindex m32532
9469 @opindex m32532
9470 Generate output for a 32532.  This is the default
9471 when the compiler is configured for 32532-based systems.
9473 @item -m32081
9474 @opindex m32081
9475 Generate output containing 32081 instructions for floating point.
9476 This is the default for all systems.
9478 @item -m32381
9479 @opindex m32381
9480 Generate output containing 32381 instructions for floating point.  This
9481 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9482 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9484 @item -mmulti-add
9485 @opindex mmulti-add
9486 Try and generate multiply-add floating point instructions @code{polyF}
9487 and @code{dotF}.  This option is only available if the @option{-m32381}
9488 option is in effect.  Using these instructions requires changes to
9489 register allocation which generally has a negative impact on
9490 performance.  This option should only be enabled when compiling code
9491 particularly likely to make heavy use of multiply-add instructions.
9493 @item -mnomulti-add
9494 @opindex mnomulti-add
9495 Do not try and generate multiply-add floating point instructions
9496 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9498 @item -msoft-float
9499 @opindex msoft-float
9500 Generate output containing library calls for floating point.
9501 @strong{Warning:} the requisite libraries may not be available.
9503 @item -mieee-compare
9504 @itemx -mno-ieee-compare
9505 @opindex mieee-compare
9506 @opindex mno-ieee-compare
9507 Control whether or not the compiler uses IEEE floating point
9508 comparisons.  These handle correctly the case where the result of a
9509 comparison is unordered.
9510 @strong{Warning:} the requisite kernel support may not be available.
9512 @item -mnobitfield
9513 @opindex mnobitfield
9514 Do not use the bit-field instructions.  On some machines it is faster to
9515 use shifting and masking operations.  This is the default for the pc532.
9517 @item -mbitfield
9518 @opindex mbitfield
9519 Do use the bit-field instructions.  This is the default for all platforms
9520 except the pc532.
9522 @item -mrtd
9523 @opindex mrtd
9524 Use a different function-calling convention, in which functions
9525 that take a fixed number of arguments return pop their
9526 arguments on return with the @code{ret} instruction.
9528 This calling convention is incompatible with the one normally
9529 used on Unix, so you cannot use it if you need to call libraries
9530 compiled with the Unix compiler.
9532 Also, you must provide function prototypes for all functions that
9533 take variable numbers of arguments (including @code{printf});
9534 otherwise incorrect code will be generated for calls to those
9535 functions.
9537 In addition, seriously incorrect code will result if you call a
9538 function with too many arguments.  (Normally, extra arguments are
9539 harmlessly ignored.)
9541 This option takes its name from the 680x0 @code{rtd} instruction.
9544 @item -mregparam
9545 @opindex mregparam
9546 Use a different function-calling convention where the first two arguments
9547 are passed in registers.
9549 This calling convention is incompatible with the one normally
9550 used on Unix, so you cannot use it if you need to call libraries
9551 compiled with the Unix compiler.
9553 @item -mnoregparam
9554 @opindex mnoregparam
9555 Do not pass any arguments in registers.  This is the default for all
9556 targets.
9558 @item -msb
9559 @opindex msb
9560 It is OK to use the sb as an index register which is always loaded with
9561 zero.  This is the default for the pc532-netbsd target.
9563 @item -mnosb
9564 @opindex mnosb
9565 The sb register is not available for use or has not been initialized to
9566 zero by the run time system.  This is the default for all targets except
9567 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9568 @option{-fpic} is set.
9570 @item -mhimem
9571 @opindex mhimem
9572 Many ns32000 series addressing modes use displacements of up to 512MB@.
9573 If an address is above 512MB then displacements from zero can not be used.
9574 This option causes code to be generated which can be loaded above 512MB@.
9575 This may be useful for operating systems or ROM code.
9577 @item -mnohimem
9578 @opindex mnohimem
9579 Assume code will be loaded in the first 512MB of virtual address space.
9580 This is the default for all platforms.
9582 @end table
9584 @node PDP-11 Options
9585 @subsection PDP-11 Options
9586 @cindex PDP-11 Options
9588 These options are defined for the PDP-11:
9590 @table @gcctabopt
9591 @item -mfpu
9592 @opindex mfpu
9593 Use hardware FPP floating point.  This is the default.  (FIS floating
9594 point on the PDP-11/40 is not supported.)
9596 @item -msoft-float
9597 @opindex msoft-float
9598 Do not use hardware floating point.
9600 @item -mac0
9601 @opindex mac0
9602 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9604 @item -mno-ac0
9605 @opindex mno-ac0
9606 Return floating-point results in memory.  This is the default.
9608 @item -m40
9609 @opindex m40
9610 Generate code for a PDP-11/40.
9612 @item -m45
9613 @opindex m45
9614 Generate code for a PDP-11/45.  This is the default.
9616 @item -m10
9617 @opindex m10
9618 Generate code for a PDP-11/10.
9620 @item -mbcopy-builtin
9621 @opindex bcopy-builtin
9622 Use inline @code{movmemhi} patterns for copying memory.  This is the
9623 default.
9625 @item -mbcopy
9626 @opindex mbcopy
9627 Do not use inline @code{movmemhi} patterns for copying memory.
9629 @item -mint16
9630 @itemx -mno-int32
9631 @opindex mint16
9632 @opindex mno-int32
9633 Use 16-bit @code{int}.  This is the default.
9635 @item -mint32
9636 @itemx -mno-int16
9637 @opindex mint32
9638 @opindex mno-int16
9639 Use 32-bit @code{int}.
9641 @item -mfloat64
9642 @itemx -mno-float32
9643 @opindex mfloat64
9644 @opindex mno-float32
9645 Use 64-bit @code{float}.  This is the default.
9647 @item -mfloat32
9648 @itemx -mno-float64
9649 @opindex mfloat32
9650 @opindex mno-float64
9651 Use 32-bit @code{float}.
9653 @item -mabshi
9654 @opindex mabshi
9655 Use @code{abshi2} pattern.  This is the default.
9657 @item -mno-abshi
9658 @opindex mno-abshi
9659 Do not use @code{abshi2} pattern.
9661 @item -mbranch-expensive
9662 @opindex mbranch-expensive
9663 Pretend that branches are expensive.  This is for experimenting with
9664 code generation only.
9666 @item -mbranch-cheap
9667 @opindex mbranch-cheap
9668 Do not pretend that branches are expensive.  This is the default.
9670 @item -msplit
9671 @opindex msplit
9672 Generate code for a system with split I&D.
9674 @item -mno-split
9675 @opindex mno-split
9676 Generate code for a system without split I&D.  This is the default.
9678 @item -munix-asm
9679 @opindex munix-asm
9680 Use Unix assembler syntax.  This is the default when configured for
9681 @samp{pdp11-*-bsd}.
9683 @item -mdec-asm
9684 @opindex mdec-asm
9685 Use DEC assembler syntax.  This is the default when configured for any
9686 PDP-11 target other than @samp{pdp11-*-bsd}.
9687 @end table
9689 @node PowerPC Options
9690 @subsection PowerPC Options
9691 @cindex PowerPC options
9693 These are listed under @xref{RS/6000 and PowerPC Options}.
9695 @node RS/6000 and PowerPC Options
9696 @subsection IBM RS/6000 and PowerPC Options
9697 @cindex RS/6000 and PowerPC Options
9698 @cindex IBM RS/6000 and PowerPC Options
9700 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
9701 @table @gcctabopt
9702 @item -mpower
9703 @itemx -mno-power
9704 @itemx -mpower2
9705 @itemx -mno-power2
9706 @itemx -mpowerpc
9707 @itemx -mno-powerpc
9708 @itemx -mpowerpc-gpopt
9709 @itemx -mno-powerpc-gpopt
9710 @itemx -mpowerpc-gfxopt
9711 @itemx -mno-powerpc-gfxopt
9712 @itemx -mpowerpc64
9713 @itemx -mno-powerpc64
9714 @opindex mpower
9715 @opindex mno-power
9716 @opindex mpower2
9717 @opindex mno-power2
9718 @opindex mpowerpc
9719 @opindex mno-powerpc
9720 @opindex mpowerpc-gpopt
9721 @opindex mno-powerpc-gpopt
9722 @opindex mpowerpc-gfxopt
9723 @opindex mno-powerpc-gfxopt
9724 @opindex mpowerpc64
9725 @opindex mno-powerpc64
9726 GCC supports two related instruction set architectures for the
9727 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
9728 instructions supported by the @samp{rios} chip set used in the original
9729 RS/6000 systems and the @dfn{PowerPC} instruction set is the
9730 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
9731 the IBM 4xx microprocessors.
9733 Neither architecture is a subset of the other.  However there is a
9734 large common subset of instructions supported by both.  An MQ
9735 register is included in processors supporting the POWER architecture.
9737 You use these options to specify which instructions are available on the
9738 processor you are using.  The default value of these options is
9739 determined when configuring GCC@.  Specifying the
9740 @option{-mcpu=@var{cpu_type}} overrides the specification of these
9741 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
9742 rather than the options listed above.
9744 The @option{-mpower} option allows GCC to generate instructions that
9745 are found only in the POWER architecture and to use the MQ register.
9746 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
9747 to generate instructions that are present in the POWER2 architecture but
9748 not the original POWER architecture.
9750 The @option{-mpowerpc} option allows GCC to generate instructions that
9751 are found only in the 32-bit subset of the PowerPC architecture.
9752 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
9753 GCC to use the optional PowerPC architecture instructions in the
9754 General Purpose group, including floating-point square root.  Specifying
9755 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
9756 use the optional PowerPC architecture instructions in the Graphics
9757 group, including floating-point select.
9759 The @option{-mpowerpc64} option allows GCC to generate the additional
9760 64-bit instructions that are found in the full PowerPC64 architecture
9761 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
9762 @option{-mno-powerpc64}.
9764 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
9765 will use only the instructions in the common subset of both
9766 architectures plus some special AIX common-mode calls, and will not use
9767 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
9768 permits GCC to use any instruction from either architecture and to
9769 allow use of the MQ register; specify this for the Motorola MPC601.
9771 @item -mnew-mnemonics
9772 @itemx -mold-mnemonics
9773 @opindex mnew-mnemonics
9774 @opindex mold-mnemonics
9775 Select which mnemonics to use in the generated assembler code.  With
9776 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
9777 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
9778 assembler mnemonics defined for the POWER architecture.  Instructions
9779 defined in only one architecture have only one mnemonic; GCC uses that
9780 mnemonic irrespective of which of these options is specified.
9782 GCC defaults to the mnemonics appropriate for the architecture in
9783 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
9784 value of these option.  Unless you are building a cross-compiler, you
9785 should normally not specify either @option{-mnew-mnemonics} or
9786 @option{-mold-mnemonics}, but should instead accept the default.
9788 @item -mcpu=@var{cpu_type}
9789 @opindex mcpu
9790 Set architecture type, register usage, choice of mnemonics, and
9791 instruction scheduling parameters for machine type @var{cpu_type}.
9792 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
9793 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
9794 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
9795 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
9796 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
9797 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
9798 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
9799 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
9800 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
9802 @option{-mcpu=common} selects a completely generic processor.  Code
9803 generated under this option will run on any POWER or PowerPC processor.
9804 GCC will use only the instructions in the common subset of both
9805 architectures, and will not use the MQ register.  GCC assumes a generic
9806 processor model for scheduling purposes.
9808 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
9809 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
9810 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
9811 types, with an appropriate, generic processor model assumed for
9812 scheduling purposes.
9814 The other options specify a specific processor.  Code generated under
9815 those options will run best on that processor, and may not run at all on
9816 others.
9818 The @option{-mcpu} options automatically enable or disable the
9819 following options: @option{-maltivec}, @option{-mhard-float},
9820 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
9821 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
9822 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
9823 @option{-mstring}.  The particular options set for any particular CPU
9824 will vary between compiler versions, depending on what setting seems
9825 to produce optimal code for that CPU; it doesn't necessarily reflect
9826 the actual hardware's capabilities.  If you wish to set an individual
9827 option to a particular value, you may specify it after the
9828 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
9830 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
9831 not enabled or disabled by the @option{-mcpu} option at present, since
9832 AIX does not have full support for these options.  You may still
9833 enable or disable them individually if you're sure it'll work in your
9834 environment.
9836 @item -mtune=@var{cpu_type}
9837 @opindex mtune
9838 Set the instruction scheduling parameters for machine type
9839 @var{cpu_type}, but do not set the architecture type, register usage, or
9840 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
9841 values for @var{cpu_type} are used for @option{-mtune} as for
9842 @option{-mcpu}.  If both are specified, the code generated will use the
9843 architecture, registers, and mnemonics set by @option{-mcpu}, but the
9844 scheduling parameters set by @option{-mtune}.
9846 @item -maltivec
9847 @itemx -mno-altivec
9848 @opindex maltivec
9849 @opindex mno-altivec
9850 These switches enable or disable the use of built-in functions that
9851 allow access to the AltiVec instruction set.  You may also need to set
9852 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
9853 enhancements.
9855 @item -mabi=spe
9856 @opindex mabi=spe
9857 Extend the current ABI with SPE ABI extensions.  This does not change
9858 the default ABI, instead it adds the SPE ABI extensions to the current
9859 ABI@.
9861 @item -mabi=no-spe
9862 @opindex mabi=no-spe
9863 Disable Booke SPE ABI extensions for the current ABI.
9865 @item -misel=@var{yes/no}
9866 @itemx -misel
9867 @opindex misel
9868 This switch enables or disables the generation of ISEL instructions.
9870 @item -mspe=@var{yes/no}
9871 @itemx -mspe
9872 @opindex mspe
9873 This switch enables or disables the generation of SPE simd
9874 instructions.
9876 @item -mfloat-gprs=@var{yes/no}
9877 @itemx -mfloat-gprs
9878 @opindex mfloat-gprs
9879 This switch enables or disables the generation of floating point
9880 operations on the general purpose registers for architectures that
9881 support it.  This option is currently only available on the MPC8540.
9883 @item -mfull-toc
9884 @itemx -mno-fp-in-toc
9885 @itemx -mno-sum-in-toc
9886 @itemx -mminimal-toc
9887 @opindex mfull-toc
9888 @opindex mno-fp-in-toc
9889 @opindex mno-sum-in-toc
9890 @opindex mminimal-toc
9891 Modify generation of the TOC (Table Of Contents), which is created for
9892 every executable file.  The @option{-mfull-toc} option is selected by
9893 default.  In that case, GCC will allocate at least one TOC entry for
9894 each unique non-automatic variable reference in your program.  GCC
9895 will also place floating-point constants in the TOC@.  However, only
9896 16,384 entries are available in the TOC@.
9898 If you receive a linker error message that saying you have overflowed
9899 the available TOC space, you can reduce the amount of TOC space used
9900 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
9901 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
9902 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
9903 generate code to calculate the sum of an address and a constant at
9904 run-time instead of putting that sum into the TOC@.  You may specify one
9905 or both of these options.  Each causes GCC to produce very slightly
9906 slower and larger code at the expense of conserving TOC space.
9908 If you still run out of space in the TOC even when you specify both of
9909 these options, specify @option{-mminimal-toc} instead.  This option causes
9910 GCC to make only one TOC entry for every file.  When you specify this
9911 option, GCC will produce code that is slower and larger but which
9912 uses extremely little TOC space.  You may wish to use this option
9913 only on files that contain less frequently executed code.
9915 @item -maix64
9916 @itemx -maix32
9917 @opindex maix64
9918 @opindex maix32
9919 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
9920 @code{long} type, and the infrastructure needed to support them.
9921 Specifying @option{-maix64} implies @option{-mpowerpc64} and
9922 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
9923 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
9925 @item -mxl-call
9926 @itemx -mno-xl-call
9927 @opindex mxl-call
9928 @opindex mno-xl-call
9929 On AIX, pass floating-point arguments to prototyped functions beyond the
9930 register save area (RSA) on the stack in addition to argument FPRs.  The
9931 AIX calling convention was extended but not initially documented to
9932 handle an obscure K&R C case of calling a function that takes the
9933 address of its arguments with fewer arguments than declared.  AIX XL
9934 compilers access floating point arguments which do not fit in the
9935 RSA from the stack when a subroutine is compiled without
9936 optimization.  Because always storing floating-point arguments on the
9937 stack is inefficient and rarely needed, this option is not enabled by
9938 default and only is necessary when calling subroutines compiled by AIX
9939 XL compilers without optimization.
9941 @item -mpe
9942 @opindex mpe
9943 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
9944 application written to use message passing with special startup code to
9945 enable the application to run.  The system must have PE installed in the
9946 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
9947 must be overridden with the @option{-specs=} option to specify the
9948 appropriate directory location.  The Parallel Environment does not
9949 support threads, so the @option{-mpe} option and the @option{-pthread}
9950 option are incompatible.
9952 @item -malign-natural
9953 @itemx -malign-power
9954 @opindex malign-natural
9955 @opindex malign-power
9956 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
9957 @option{-malign-natural} overrides the ABI-defined alignment of larger
9958 types, such as floating-point doubles, on their natural size-based boundary.
9959 The option @option{-malign-power} instructs GCC to follow the ABI-specified
9960 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
9962 @item -msoft-float
9963 @itemx -mhard-float
9964 @opindex msoft-float
9965 @opindex mhard-float
9966 Generate code that does not use (uses) the floating-point register set.
9967 Software floating point emulation is provided if you use the
9968 @option{-msoft-float} option, and pass the option to GCC when linking.
9970 @item -mmultiple
9971 @itemx -mno-multiple
9972 @opindex mmultiple
9973 @opindex mno-multiple
9974 Generate code that uses (does not use) the load multiple word
9975 instructions and the store multiple word instructions.  These
9976 instructions are generated by default on POWER systems, and not
9977 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
9978 endian PowerPC systems, since those instructions do not work when the
9979 processor is in little endian mode.  The exceptions are PPC740 and
9980 PPC750 which permit the instructions usage in little endian mode.
9982 @item -mstring
9983 @itemx -mno-string
9984 @opindex mstring
9985 @opindex mno-string
9986 Generate code that uses (does not use) the load string instructions
9987 and the store string word instructions to save multiple registers and
9988 do small block moves.  These instructions are generated by default on
9989 POWER systems, and not generated on PowerPC systems.  Do not use
9990 @option{-mstring} on little endian PowerPC systems, since those
9991 instructions do not work when the processor is in little endian mode.
9992 The exceptions are PPC740 and PPC750 which permit the instructions
9993 usage in little endian mode.
9995 @item -mupdate
9996 @itemx -mno-update
9997 @opindex mupdate
9998 @opindex mno-update
9999 Generate code that uses (does not use) the load or store instructions
10000 that update the base register to the address of the calculated memory
10001 location.  These instructions are generated by default.  If you use
10002 @option{-mno-update}, there is a small window between the time that the
10003 stack pointer is updated and the address of the previous frame is
10004 stored, which means code that walks the stack frame across interrupts or
10005 signals may get corrupted data.
10007 @item -mfused-madd
10008 @itemx -mno-fused-madd
10009 @opindex mfused-madd
10010 @opindex mno-fused-madd
10011 Generate code that uses (does not use) the floating point multiply and
10012 accumulate instructions.  These instructions are generated by default if
10013 hardware floating is used.
10015 @item -mno-bit-align
10016 @itemx -mbit-align
10017 @opindex mno-bit-align
10018 @opindex mbit-align
10019 On System V.4 and embedded PowerPC systems do not (do) force structures
10020 and unions that contain bit-fields to be aligned to the base type of the
10021 bit-field.
10023 For example, by default a structure containing nothing but 8
10024 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10025 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10026 the structure would be aligned to a 1 byte boundary and be one byte in
10027 size.
10029 @item -mno-strict-align
10030 @itemx -mstrict-align
10031 @opindex mno-strict-align
10032 @opindex mstrict-align
10033 On System V.4 and embedded PowerPC systems do not (do) assume that
10034 unaligned memory references will be handled by the system.
10036 @item -mrelocatable
10037 @itemx -mno-relocatable
10038 @opindex mrelocatable
10039 @opindex mno-relocatable
10040 On embedded PowerPC systems generate code that allows (does not allow)
10041 the program to be relocated to a different address at runtime.  If you
10042 use @option{-mrelocatable} on any module, all objects linked together must
10043 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10045 @item -mrelocatable-lib
10046 @itemx -mno-relocatable-lib
10047 @opindex mrelocatable-lib
10048 @opindex mno-relocatable-lib
10049 On embedded PowerPC systems generate code that allows (does not allow)
10050 the program to be relocated to a different address at runtime.  Modules
10051 compiled with @option{-mrelocatable-lib} can be linked with either modules
10052 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10053 with modules compiled with the @option{-mrelocatable} options.
10055 @item -mno-toc
10056 @itemx -mtoc
10057 @opindex mno-toc
10058 @opindex mtoc
10059 On System V.4 and embedded PowerPC systems do not (do) assume that
10060 register 2 contains a pointer to a global area pointing to the addresses
10061 used in the program.
10063 @item -mlittle
10064 @itemx -mlittle-endian
10065 @opindex mlittle
10066 @opindex mlittle-endian
10067 On System V.4 and embedded PowerPC systems compile code for the
10068 processor in little endian mode.  The @option{-mlittle-endian} option is
10069 the same as @option{-mlittle}.
10071 @item -mbig
10072 @itemx -mbig-endian
10073 @opindex mbig
10074 @opindex mbig-endian
10075 On System V.4 and embedded PowerPC systems compile code for the
10076 processor in big endian mode.  The @option{-mbig-endian} option is
10077 the same as @option{-mbig}.
10079 @item -mdynamic-no-pic
10080 @opindex mdynamic-no-pic
10081 On Darwin and Mac OS X systems, compile code so that it is not
10082 relocatable, but that its external references are relocatable.  The
10083 resulting code is suitable for applications, but not shared
10084 libraries.
10086 @item -mprioritize-restricted-insns=@var{priority}
10087 @opindex mprioritize-restricted-insns
10088 This option controls the priority that is assigned to
10089 dispatch-slot restricted instructions during the second scheduling
10090 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10091 @var{no/highest/second-highest} priority to dispatch slot restricted
10092 instructions.
10094 @item -msched-costly-dep=@var{dependence_type}
10095 @opindex msched-costly-dep
10096 This option controls which dependences are considered costly
10097 by the target during instruction scheduling.  The argument
10098 @var{dependence_type} takes one of the following values:
10099 @var{no}: no dependence is costly,
10100 @var{all}: all dependences are costly,
10101 @var{true_store_to_load}: a true dependence from store to load is costly,
10102 @var{store_to_load}: any dependence from store to load is costly,
10103 @var{number}: any dependence which latency >= @var{number} is costly.
10105 @item -minsert-sched-nops=@var{scheme}
10106 @opindex minsert-sched-nops
10107 This option controls which nop insertion scheme will be used during
10108 the second scheduling pass. The argument @var{scheme} takes one of the
10109 following values:
10110 @var{no}: Don't insert nops.
10111 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10112 according to the scheduler's grouping.
10113 @var{regroup_exact}: Insert nops to force costly dependent insns into
10114 separate groups.  Insert exactly as many nops as needed to force an insn
10115 to a new group, according to the estimated processor grouping.
10116 @var{number}: Insert nops to force costly dependent insns into
10117 separate groups.  Insert @var{number} nops to force an insn to a new group.
10119 @item -mcall-sysv
10120 @opindex mcall-sysv
10121 On System V.4 and embedded PowerPC systems compile code using calling
10122 conventions that adheres to the March 1995 draft of the System V
10123 Application Binary Interface, PowerPC processor supplement.  This is the
10124 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10126 @item -mcall-sysv-eabi
10127 @opindex mcall-sysv-eabi
10128 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10130 @item -mcall-sysv-noeabi
10131 @opindex mcall-sysv-noeabi
10132 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10134 @item -mcall-solaris
10135 @opindex mcall-solaris
10136 On System V.4 and embedded PowerPC systems compile code for the Solaris
10137 operating system.
10139 @item -mcall-linux
10140 @opindex mcall-linux
10141 On System V.4 and embedded PowerPC systems compile code for the
10142 Linux-based GNU system.
10144 @item -mcall-gnu
10145 @opindex mcall-gnu
10146 On System V.4 and embedded PowerPC systems compile code for the
10147 Hurd-based GNU system.
10149 @item -mcall-netbsd
10150 @opindex mcall-netbsd
10151 On System V.4 and embedded PowerPC systems compile code for the
10152 NetBSD operating system.
10154 @item -maix-struct-return
10155 @opindex maix-struct-return
10156 Return all structures in memory (as specified by the AIX ABI)@.
10158 @item -msvr4-struct-return
10159 @opindex msvr4-struct-return
10160 Return structures smaller than 8 bytes in registers (as specified by the
10161 SVR4 ABI)@.
10163 @item -mabi=altivec
10164 @opindex mabi=altivec
10165 Extend the current ABI with AltiVec ABI extensions.  This does not
10166 change the default ABI, instead it adds the AltiVec ABI extensions to
10167 the current ABI@.
10169 @item -mabi=no-altivec
10170 @opindex mabi=no-altivec
10171 Disable AltiVec ABI extensions for the current ABI.
10173 @item -mprototype
10174 @itemx -mno-prototype
10175 @opindex mprototype
10176 @opindex mno-prototype
10177 On System V.4 and embedded PowerPC systems assume that all calls to
10178 variable argument functions are properly prototyped.  Otherwise, the
10179 compiler must insert an instruction before every non prototyped call to
10180 set or clear bit 6 of the condition code register (@var{CR}) to
10181 indicate whether floating point values were passed in the floating point
10182 registers in case the function takes a variable arguments.  With
10183 @option{-mprototype}, only calls to prototyped variable argument functions
10184 will set or clear the bit.
10186 @item -msim
10187 @opindex msim
10188 On embedded PowerPC systems, assume that the startup module is called
10189 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10190 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10191 configurations.
10193 @item -mmvme
10194 @opindex mmvme
10195 On embedded PowerPC systems, assume that the startup module is called
10196 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10197 @file{libc.a}.
10199 @item -mads
10200 @opindex mads
10201 On embedded PowerPC systems, assume that the startup module is called
10202 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10203 @file{libc.a}.
10205 @item -myellowknife
10206 @opindex myellowknife
10207 On embedded PowerPC systems, assume that the startup module is called
10208 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10209 @file{libc.a}.
10211 @item -mvxworks
10212 @opindex mvxworks
10213 On System V.4 and embedded PowerPC systems, specify that you are
10214 compiling for a VxWorks system.
10216 @item -mwindiss
10217 @opindex mwindiss
10218 Specify that you are compiling for the WindISS simulation environment.
10220 @item -memb
10221 @opindex memb
10222 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10223 header to indicate that @samp{eabi} extended relocations are used.
10225 @item -meabi
10226 @itemx -mno-eabi
10227 @opindex meabi
10228 @opindex mno-eabi
10229 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10230 Embedded Applications Binary Interface (eabi) which is a set of
10231 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10232 means that the stack is aligned to an 8 byte boundary, a function
10233 @code{__eabi} is called to from @code{main} to set up the eabi
10234 environment, and the @option{-msdata} option can use both @code{r2} and
10235 @code{r13} to point to two separate small data areas.  Selecting
10236 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10237 do not call an initialization function from @code{main}, and the
10238 @option{-msdata} option will only use @code{r13} to point to a single
10239 small data area.  The @option{-meabi} option is on by default if you
10240 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10242 @item -msdata=eabi
10243 @opindex msdata=eabi
10244 On System V.4 and embedded PowerPC systems, put small initialized
10245 @code{const} global and static data in the @samp{.sdata2} section, which
10246 is pointed to by register @code{r2}.  Put small initialized
10247 non-@code{const} global and static data in the @samp{.sdata} section,
10248 which is pointed to by register @code{r13}.  Put small uninitialized
10249 global and static data in the @samp{.sbss} section, which is adjacent to
10250 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10251 incompatible with the @option{-mrelocatable} option.  The
10252 @option{-msdata=eabi} option also sets the @option{-memb} option.
10254 @item -msdata=sysv
10255 @opindex msdata=sysv
10256 On System V.4 and embedded PowerPC systems, put small global and static
10257 data in the @samp{.sdata} section, which is pointed to by register
10258 @code{r13}.  Put small uninitialized global and static data in the
10259 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10260 The @option{-msdata=sysv} option is incompatible with the
10261 @option{-mrelocatable} option.
10263 @item -msdata=default
10264 @itemx -msdata
10265 @opindex msdata=default
10266 @opindex msdata
10267 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10268 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10269 same as @option{-msdata=sysv}.
10271 @item -msdata-data
10272 @opindex msdata-data
10273 On System V.4 and embedded PowerPC systems, put small global and static
10274 data in the @samp{.sdata} section.  Put small uninitialized global and
10275 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10276 to address small data however.  This is the default behavior unless
10277 other @option{-msdata} options are used.
10279 @item -msdata=none
10280 @itemx -mno-sdata
10281 @opindex msdata=none
10282 @opindex mno-sdata
10283 On embedded PowerPC systems, put all initialized global and static data
10284 in the @samp{.data} section, and all uninitialized data in the
10285 @samp{.bss} section.
10287 @item -G @var{num}
10288 @opindex G
10289 @cindex smaller data references (PowerPC)
10290 @cindex .sdata/.sdata2 references (PowerPC)
10291 On embedded PowerPC systems, put global and static items less than or
10292 equal to @var{num} bytes into the small data or bss sections instead of
10293 the normal data or bss section.  By default, @var{num} is 8.  The
10294 @option{-G @var{num}} switch is also passed to the linker.
10295 All modules should be compiled with the same @option{-G @var{num}} value.
10297 @item -mregnames
10298 @itemx -mno-regnames
10299 @opindex mregnames
10300 @opindex mno-regnames
10301 On System V.4 and embedded PowerPC systems do (do not) emit register
10302 names in the assembly language output using symbolic forms.
10304 @item -mlongcall
10305 @itemx -mno-longcall
10306 @opindex mlongcall
10307 @opindex mno-longcall
10308 Default to making all function calls indirectly, using a register, so
10309 that functions which reside further than 32 megabytes (33,554,432
10310 bytes) from the current location can be called.  This setting can be
10311 overridden by the @code{shortcall} function attribute, or by
10312 @code{#pragma longcall(0)}.
10314 Some linkers are capable of detecting out-of-range calls and generating
10315 glue code on the fly.  On these systems, long calls are unnecessary and
10316 generate slower code.  As of this writing, the AIX linker can do this,
10317 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10318 to the GNU linker for 32-bit PowerPC systems as well.
10320 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10321 callee, L42'', plus a ``branch island'' (glue code).  The two target
10322 addresses represent the callee and the ``branch island.'' The
10323 Darwin/PPC linker will prefer the first address and generate a ``bl
10324 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10325 otherwise, the linker will generate ``bl L42'' to call the ``branch
10326 island.''  The ``branch island'' is appended to the body of the
10327 calling function; it computes the full 32-bit address of the callee
10328 and jumps to it.
10330 On Mach-O (Darwin) systems, this option directs the compiler emit to
10331 the glue for every direct call, and the Darwin linker decides whether
10332 to use or discard it.
10334 In the future, we may cause GCC to ignore all longcall specifications
10335 when the linker is known to generate glue.
10337 @item -pthread
10338 @opindex pthread
10339 Adds support for multithreading with the @dfn{pthreads} library.
10340 This option sets flags for both the preprocessor and linker.
10342 @end table
10344 @node S/390 and zSeries Options
10345 @subsection S/390 and zSeries Options
10346 @cindex S/390 and zSeries Options
10348 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10350 @table @gcctabopt
10351 @item -mhard-float
10352 @itemx -msoft-float
10353 @opindex mhard-float
10354 @opindex msoft-float
10355 Use (do not use) the hardware floating-point instructions and registers
10356 for floating-point operations.  When @option{-msoft-float} is specified,
10357 functions in @file{libgcc.a} will be used to perform floating-point
10358 operations.  When @option{-mhard-float} is specified, the compiler
10359 generates IEEE floating-point instructions.  This is the default.
10361 @item -mbackchain
10362 @itemx -mno-backchain
10363 @opindex mbackchain
10364 @opindex mno-backchain
10365 Generate (or do not generate) code which maintains an explicit
10366 backchain within the stack frame that points to the caller's frame.
10367 This may be needed to allow debugging using tools that do not understand
10368 DWARF-2 call frame information.  The default is not to generate the
10369 backchain.
10371 @item -msmall-exec
10372 @itemx -mno-small-exec
10373 @opindex msmall-exec
10374 @opindex mno-small-exec
10375 Generate (or do not generate) code using the @code{bras} instruction
10376 to do subroutine calls.
10377 This only works reliably if the total executable size does not
10378 exceed 64k.  The default is to use the @code{basr} instruction instead,
10379 which does not have this limitation.
10381 @item -m64
10382 @itemx -m31
10383 @opindex m64
10384 @opindex m31
10385 When @option{-m31} is specified, generate code compliant to the
10386 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10387 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10388 particular to generate 64-bit instructions.  For the @samp{s390}
10389 targets, the default is @option{-m31}, while the @samp{s390x}
10390 targets default to @option{-m64}.
10392 @item -mzarch
10393 @itemx -mesa
10394 @opindex mzarch
10395 @opindex mesa
10396 When @option{-mzarch} is specified, generate code using the
10397 instructions available on z/Architecture.
10398 When @option{-mesa} is specified, generate code using the
10399 instructions available on ESA/390. Note that @option{-mesa} is
10400 not possible with @option{-m64}.
10401 When generating code compliant to the GNU/Linux for S/390 ABI,
10402 the default is @option{-mesa}.  When generating code compliant
10403 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10405 @item -mmvcle
10406 @itemx -mno-mvcle
10407 @opindex mmvcle
10408 @opindex mno-mvcle
10409 Generate (or do not generate) code using the @code{mvcle} instruction
10410 to perform block moves.  When @option{-mno-mvcle} is specified,
10411 use a @code{mvc} loop instead.  This is the default.
10413 @item -mdebug
10414 @itemx -mno-debug
10415 @opindex mdebug
10416 @opindex mno-debug
10417 Print (or do not print) additional debug information when compiling.
10418 The default is to not print debug information.
10420 @item -march=@var{cpu-type}
10421 @opindex march
10422 Generate code that will run on @var{cpu-type}, which is the name of a system
10423 representing a certain processor type. Possible values for
10424 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10425 When generating code using the instructions available on z/Architecture,
10426 the default is @option{-march=z900}.  Otherwise, the default is
10427 @option{-march=g5}.
10429 @item -mtune=@var{cpu-type}
10430 @opindex mtune
10431 Tune to @var{cpu-type} everything applicable about the generated code,
10432 except for the ABI and the set of available instructions.
10433 The list of @var{cpu-type} values is the same as for @option{-march}.
10434 The default is the value used for @option{-march}.
10436 @item -mtpf-trace
10437 @itemx -mno-tpf-trace
10438 @opindex mtpf-trace
10439 @opindex mno-tpf-trace
10440 Generate code that adds (does not add) in TPF OS specific branches to trace
10441 routines in the operating system.  This option is off by default, even
10442 when compiling for the TPF OS.
10444 @item -mfused-madd
10445 @itemx -mno-fused-madd
10446 @opindex mfused-madd
10447 @opindex mno-fused-madd
10448 Generate code that uses (does not use) the floating point multiply and
10449 accumulate instructions.  These instructions are generated by default if
10450 hardware floating point is used.
10451 @end table
10453 @node SH Options
10454 @subsection SH Options
10456 These @samp{-m} options are defined for the SH implementations:
10458 @table @gcctabopt
10459 @item -m1
10460 @opindex m1
10461 Generate code for the SH1.
10463 @item -m2
10464 @opindex m2
10465 Generate code for the SH2.
10467 @item -m2e
10468 Generate code for the SH2e.
10470 @item -m3
10471 @opindex m3
10472 Generate code for the SH3.
10474 @item -m3e
10475 @opindex m3e
10476 Generate code for the SH3e.
10478 @item -m4-nofpu
10479 @opindex m4-nofpu
10480 Generate code for the SH4 without a floating-point unit.
10482 @item -m4-single-only
10483 @opindex m4-single-only
10484 Generate code for the SH4 with a floating-point unit that only
10485 supports single-precision arithmetic.
10487 @item -m4-single
10488 @opindex m4-single
10489 Generate code for the SH4 assuming the floating-point unit is in
10490 single-precision mode by default.
10492 @item -m4
10493 @opindex m4
10494 Generate code for the SH4.
10496 @item -mb
10497 @opindex mb
10498 Compile code for the processor in big endian mode.
10500 @item -ml
10501 @opindex ml
10502 Compile code for the processor in little endian mode.
10504 @item -mdalign
10505 @opindex mdalign
10506 Align doubles at 64-bit boundaries.  Note that this changes the calling
10507 conventions, and thus some functions from the standard C library will
10508 not work unless you recompile it first with @option{-mdalign}.
10510 @item -mrelax
10511 @opindex mrelax
10512 Shorten some address references at link time, when possible; uses the
10513 linker option @option{-relax}.
10515 @item -mbigtable
10516 @opindex mbigtable
10517 Use 32-bit offsets in @code{switch} tables.  The default is to use
10518 16-bit offsets.
10520 @item -mfmovd
10521 @opindex mfmovd
10522 Enable the use of the instruction @code{fmovd}.
10524 @item -mhitachi
10525 @opindex mhitachi
10526 Comply with the calling conventions defined by Renesas.
10528 @item -mnomacsave
10529 @opindex mnomacsave
10530 Mark the @code{MAC} register as call-clobbered, even if
10531 @option{-mhitachi} is given.
10533 @item -mieee
10534 @opindex mieee
10535 Increase IEEE-compliance of floating-point code.
10537 @item -misize
10538 @opindex misize
10539 Dump instruction size and location in the assembly code.
10541 @item -mpadstruct
10542 @opindex mpadstruct
10543 This option is deprecated.  It pads structures to multiple of 4 bytes,
10544 which is incompatible with the SH ABI@.
10546 @item -mspace
10547 @opindex mspace
10548 Optimize for space instead of speed.  Implied by @option{-Os}.
10550 @item -mprefergot
10551 @opindex mprefergot
10552 When generating position-independent code, emit function calls using
10553 the Global Offset Table instead of the Procedure Linkage Table.
10555 @item -musermode
10556 @opindex musermode
10557 Generate a library function call to invalidate instruction cache
10558 entries, after fixing up a trampoline.  This library function call
10559 doesn't assume it can write to the whole memory address space.  This
10560 is the default when the target is @code{sh-*-linux*}.
10561 @end table
10563 @node SPARC Options
10564 @subsection SPARC Options
10565 @cindex SPARC options
10567 These @samp{-m} options are supported on the SPARC:
10569 @table @gcctabopt
10570 @item -mno-app-regs
10571 @itemx -mapp-regs
10572 @opindex mno-app-regs
10573 @opindex mapp-regs
10574 Specify @option{-mapp-regs} to generate output using the global registers
10575 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
10576 is the default.
10578 To be fully SVR4 ABI compliant at the cost of some performance loss,
10579 specify @option{-mno-app-regs}.  You should compile libraries and system
10580 software with this option.
10582 @item -mfpu
10583 @itemx -mhard-float
10584 @opindex mfpu
10585 @opindex mhard-float
10586 Generate output containing floating point instructions.  This is the
10587 default.
10589 @item -mno-fpu
10590 @itemx -msoft-float
10591 @opindex mno-fpu
10592 @opindex msoft-float
10593 Generate output containing library calls for floating point.
10594 @strong{Warning:} the requisite libraries are not available for all SPARC
10595 targets.  Normally the facilities of the machine's usual C compiler are
10596 used, but this cannot be done directly in cross-compilation.  You must make
10597 your own arrangements to provide suitable library functions for
10598 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
10599 @samp{sparclite-*-*} do provide software floating point support.
10601 @option{-msoft-float} changes the calling convention in the output file;
10602 therefore, it is only useful if you compile @emph{all} of a program with
10603 this option.  In particular, you need to compile @file{libgcc.a}, the
10604 library that comes with GCC, with @option{-msoft-float} in order for
10605 this to work.
10607 @item -mhard-quad-float
10608 @opindex mhard-quad-float
10609 Generate output containing quad-word (long double) floating point
10610 instructions.
10612 @item -msoft-quad-float
10613 @opindex msoft-quad-float
10614 Generate output containing library calls for quad-word (long double)
10615 floating point instructions.  The functions called are those specified
10616 in the SPARC ABI@.  This is the default.
10618 As of this writing, there are no SPARC implementations that have hardware
10619 support for the quad-word floating point instructions.  They all invoke
10620 a trap handler for one of these instructions, and then the trap handler
10621 emulates the effect of the instruction.  Because of the trap handler overhead,
10622 this is much slower than calling the ABI library routines.  Thus the
10623 @option{-msoft-quad-float} option is the default.
10625 @item -mno-unaligned-doubles
10626 @itemx -munaligned-doubles
10627 @opindex mno-unaligned-doubles
10628 @opindex munaligned-doubles
10629 Assume that doubles have 8 byte alignment.  This is the default.
10631 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
10632 alignment only if they are contained in another type, or if they have an
10633 absolute address.  Otherwise, it assumes they have 4 byte alignment.
10634 Specifying this option avoids some rare compatibility problems with code
10635 generated by other compilers.  It is not the default because it results
10636 in a performance loss, especially for floating point code.
10638 @item -mno-faster-structs
10639 @itemx -mfaster-structs
10640 @opindex mno-faster-structs
10641 @opindex mfaster-structs
10642 With @option{-mfaster-structs}, the compiler assumes that structures
10643 should have 8 byte alignment.  This enables the use of pairs of
10644 @code{ldd} and @code{std} instructions for copies in structure
10645 assignment, in place of twice as many @code{ld} and @code{st} pairs.
10646 However, the use of this changed alignment directly violates the SPARC
10647 ABI@.  Thus, it's intended only for use on targets where the developer
10648 acknowledges that their resulting code will not be directly in line with
10649 the rules of the ABI@.
10651 @item -mimpure-text
10652 @opindex mimpure-text
10653 @option{-mimpure-text}, used in addition to @option{-shared}, tells
10654 the compiler to not pass @option{-z text} to the linker when linking a
10655 shared object.  Using this option, you can link position-dependent
10656 code into a shared object.
10658 @option{-mimpure-text} suppresses the ``relocations remain against
10659 allocatable but non-writable sections'' linker error message.
10660 However, the necessary relocations will trigger copy-on-write, and the
10661 shared object is not actually shared across processes.  Instead of
10662 using @option{-mimpure-text}, you should compile all source code with
10663 @option{-fpic} or @option{-fPIC}.
10665 This option is only available on SunOS and Solaris.
10667 @item -mcpu=@var{cpu_type}
10668 @opindex mcpu
10669 Set the instruction set, register set, and instruction scheduling parameters
10670 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
10671 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
10672 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
10673 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
10674 @samp{ultrasparc3}.
10676 Default instruction scheduling parameters are used for values that select
10677 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
10678 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
10680 Here is a list of each supported architecture and their supported
10681 implementations.
10683 @smallexample
10684     v7:             cypress
10685     v8:             supersparc, hypersparc
10686     sparclite:      f930, f934, sparclite86x
10687     sparclet:       tsc701
10688     v9:             ultrasparc, ultrasparc3
10689 @end smallexample
10691 By default (unless configured otherwise), GCC generates code for the V7
10692 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
10693 additionally optimizes it for the Cypress CY7C602 chip, as used in the
10694 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
10695 SPARCStation 1, 2, IPX etc.
10697 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
10698 architecture.  The only difference from V7 code is that the compiler emits
10699 the integer multiply and integer divide instructions which exist in SPARC-V8
10700 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
10701 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
10702 2000 series.
10704 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
10705 the SPARC architecture.  This adds the integer multiply, integer divide step
10706 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
10707 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
10708 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
10709 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
10710 MB86934 chip, which is the more recent SPARClite with FPU.
10712 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
10713 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
10714 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
10715 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
10716 optimizes it for the TEMIC SPARClet chip.
10718 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
10719 architecture.  This adds 64-bit integer and floating-point move instructions,
10720 3 additional floating-point condition code registers and conditional move
10721 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
10722 optimizes it for the Sun UltraSPARC I/II chips.  With
10723 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
10724 Sun UltraSPARC III chip.
10726 @item -mtune=@var{cpu_type}
10727 @opindex mtune
10728 Set the instruction scheduling parameters for machine type
10729 @var{cpu_type}, but do not set the instruction set or register set that the
10730 option @option{-mcpu=@var{cpu_type}} would.
10732 The same values for @option{-mcpu=@var{cpu_type}} can be used for
10733 @option{-mtune=@var{cpu_type}}, but the only useful values are those
10734 that select a particular cpu implementation.  Those are @samp{cypress},
10735 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
10736 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
10737 @samp{ultrasparc3}.
10739 @item -mv8plus
10740 @itemx -mno-v8plus
10741 @opindex mv8plus
10742 @opindex mno-v8plus
10743 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
10744 difference from the V8 ABI is that the global and out registers are
10745 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
10746 mode for all SPARC-V9 processors.
10748 @item -mvis
10749 @itemx -mno-vis
10750 @opindex mvis
10751 @opindex mno-vis
10752 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
10753 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
10754 @end table
10756 These @samp{-m} options are supported in addition to the above
10757 on SPARC-V9 processors in 64-bit environments:
10759 @table @gcctabopt
10760 @item -mlittle-endian
10761 @opindex mlittle-endian
10762 Generate code for a processor running in little-endian mode. It is only
10763 available for a few configurations and most notably not on Solaris.
10765 @item -m32
10766 @itemx -m64
10767 @opindex m32
10768 @opindex m64
10769 Generate code for a 32-bit or 64-bit environment.
10770 The 32-bit environment sets int, long and pointer to 32 bits.
10771 The 64-bit environment sets int to 32 bits and long and pointer
10772 to 64 bits.
10774 @item -mcmodel=medlow
10775 @opindex mcmodel=medlow
10776 Generate code for the Medium/Low code model: 64-bit addresses, programs
10777 must be linked in the low 32 bits of memory.  Programs can be statically
10778 or dynamically linked.
10780 @item -mcmodel=medmid
10781 @opindex mcmodel=medmid
10782 Generate code for the Medium/Middle code model: 64-bit addresses, programs
10783 must be linked in the low 44 bits of memory, the text and data segments must
10784 be less than 2GB in size and the data segment must be located within 2GB of
10785 the text segment.
10787 @item -mcmodel=medany
10788 @opindex mcmodel=medany
10789 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
10790 may be linked anywhere in memory, the text and data segments must be less
10791 than 2GB in size and the data segment must be located within 2GB of the
10792 text segment.
10794 @item -mcmodel=embmedany
10795 @opindex mcmodel=embmedany
10796 Generate code for the Medium/Anywhere code model for embedded systems:
10797 64-bit addresses, the text and data segments must be less than 2GB in
10798 size, both starting anywhere in memory (determined at link time).  The
10799 global register %g4 points to the base of the data segment.  Programs
10800 are statically linked and PIC is not supported.
10802 @item -mstack-bias
10803 @itemx -mno-stack-bias
10804 @opindex mstack-bias
10805 @opindex mno-stack-bias
10806 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
10807 frame pointer if present, are offset by @minus{}2047 which must be added back
10808 when making stack frame references.  This is the default in 64-bit mode.
10809 Otherwise, assume no such offset is present.
10810 @end table
10812 @node System V Options
10813 @subsection Options for System V
10815 These additional options are available on System V Release 4 for
10816 compatibility with other compilers on those systems:
10818 @table @gcctabopt
10819 @item -G
10820 @opindex G
10821 Create a shared object.
10822 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
10824 @item -Qy
10825 @opindex Qy
10826 Identify the versions of each tool used by the compiler, in a
10827 @code{.ident} assembler directive in the output.
10829 @item -Qn
10830 @opindex Qn
10831 Refrain from adding @code{.ident} directives to the output file (this is
10832 the default).
10834 @item -YP,@var{dirs}
10835 @opindex YP
10836 Search the directories @var{dirs}, and no others, for libraries
10837 specified with @option{-l}.
10839 @item -Ym,@var{dir}
10840 @opindex Ym
10841 Look in the directory @var{dir} to find the M4 preprocessor.
10842 The assembler uses this option.
10843 @c This is supposed to go with a -Yd for predefined M4 macro files, but
10844 @c the generic assembler that comes with Solaris takes just -Ym.
10845 @end table
10847 @node TMS320C3x/C4x Options
10848 @subsection TMS320C3x/C4x Options
10849 @cindex TMS320C3x/C4x Options
10851 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
10853 @table @gcctabopt
10855 @item -mcpu=@var{cpu_type}
10856 @opindex mcpu
10857 Set the instruction set, register set, and instruction scheduling
10858 parameters for machine type @var{cpu_type}.  Supported values for
10859 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
10860 @samp{c44}.  The default is @samp{c40} to generate code for the
10861 TMS320C40.
10863 @item -mbig-memory
10864 @itemx -mbig
10865 @itemx -msmall-memory
10866 @itemx -msmall
10867 @opindex mbig-memory
10868 @opindex mbig
10869 @opindex msmall-memory
10870 @opindex msmall
10871 Generates code for the big or small memory model.  The small memory
10872 model assumed that all data fits into one 64K word page.  At run-time
10873 the data page (DP) register must be set to point to the 64K page
10874 containing the .bss and .data program sections.  The big memory model is
10875 the default and requires reloading of the DP register for every direct
10876 memory access.
10878 @item -mbk
10879 @itemx -mno-bk
10880 @opindex mbk
10881 @opindex mno-bk
10882 Allow (disallow) allocation of general integer operands into the block
10883 count register BK@.
10885 @item -mdb
10886 @itemx -mno-db
10887 @opindex mdb
10888 @opindex mno-db
10889 Enable (disable) generation of code using decrement and branch,
10890 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
10891 on the safe side, this is disabled for the C3x, since the maximum
10892 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
10893 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
10894 that it can utilize the decrement and branch instruction, but will give
10895 up if there is more than one memory reference in the loop.  Thus a loop
10896 where the loop counter is decremented can generate slightly more
10897 efficient code, in cases where the RPTB instruction cannot be utilized.
10899 @item -mdp-isr-reload
10900 @itemx -mparanoid
10901 @opindex mdp-isr-reload
10902 @opindex mparanoid
10903 Force the DP register to be saved on entry to an interrupt service
10904 routine (ISR), reloaded to point to the data section, and restored on
10905 exit from the ISR@.  This should not be required unless someone has
10906 violated the small memory model by modifying the DP register, say within
10907 an object library.
10909 @item -mmpyi
10910 @itemx -mno-mpyi
10911 @opindex mmpyi
10912 @opindex mno-mpyi
10913 For the C3x use the 24-bit MPYI instruction for integer multiplies
10914 instead of a library call to guarantee 32-bit results.  Note that if one
10915 of the operands is a constant, then the multiplication will be performed
10916 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
10917 then squaring operations are performed inline instead of a library call.
10919 @item -mfast-fix
10920 @itemx -mno-fast-fix
10921 @opindex mfast-fix
10922 @opindex mno-fast-fix
10923 The C3x/C4x FIX instruction to convert a floating point value to an
10924 integer value chooses the nearest integer less than or equal to the
10925 floating point value rather than to the nearest integer.  Thus if the
10926 floating point number is negative, the result will be incorrectly
10927 truncated an additional code is necessary to detect and correct this
10928 case.  This option can be used to disable generation of the additional
10929 code required to correct the result.
10931 @item -mrptb
10932 @itemx -mno-rptb
10933 @opindex mrptb
10934 @opindex mno-rptb
10935 Enable (disable) generation of repeat block sequences using the RPTB
10936 instruction for zero overhead looping.  The RPTB construct is only used
10937 for innermost loops that do not call functions or jump across the loop
10938 boundaries.  There is no advantage having nested RPTB loops due to the
10939 overhead required to save and restore the RC, RS, and RE registers.
10940 This is enabled by default with @option{-O2}.
10942 @item -mrpts=@var{count}
10943 @itemx -mno-rpts
10944 @opindex mrpts
10945 @opindex mno-rpts
10946 Enable (disable) the use of the single instruction repeat instruction
10947 RPTS@.  If a repeat block contains a single instruction, and the loop
10948 count can be guaranteed to be less than the value @var{count}, GCC will
10949 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
10950 then a RPTS will be emitted even if the loop count cannot be determined
10951 at compile time.  Note that the repeated instruction following RPTS does
10952 not have to be reloaded from memory each iteration, thus freeing up the
10953 CPU buses for operands.  However, since interrupts are blocked by this
10954 instruction, it is disabled by default.
10956 @item -mloop-unsigned
10957 @itemx -mno-loop-unsigned
10958 @opindex mloop-unsigned
10959 @opindex mno-loop-unsigned
10960 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
10961 is @math{2^{31} + 1} since these instructions test if the iteration count is
10962 negative to terminate the loop.  If the iteration count is unsigned
10963 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
10964 exceeded.  This switch allows an unsigned iteration count.
10966 @item -mti
10967 @opindex mti
10968 Try to emit an assembler syntax that the TI assembler (asm30) is happy
10969 with.  This also enforces compatibility with the API employed by the TI
10970 C3x C compiler.  For example, long doubles are passed as structures
10971 rather than in floating point registers.
10973 @item -mregparm
10974 @itemx -mmemparm
10975 @opindex mregparm
10976 @opindex mmemparm
10977 Generate code that uses registers (stack) for passing arguments to functions.
10978 By default, arguments are passed in registers where possible rather
10979 than by pushing arguments on to the stack.
10981 @item -mparallel-insns
10982 @itemx -mno-parallel-insns
10983 @opindex mparallel-insns
10984 @opindex mno-parallel-insns
10985 Allow the generation of parallel instructions.  This is enabled by
10986 default with @option{-O2}.
10988 @item -mparallel-mpy
10989 @itemx -mno-parallel-mpy
10990 @opindex mparallel-mpy
10991 @opindex mno-parallel-mpy
10992 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
10993 provided @option{-mparallel-insns} is also specified.  These instructions have
10994 tight register constraints which can pessimize the code generation
10995 of large functions.
10997 @end table
10999 @node V850 Options
11000 @subsection V850 Options
11001 @cindex V850 Options
11003 These @samp{-m} options are defined for V850 implementations:
11005 @table @gcctabopt
11006 @item -mlong-calls
11007 @itemx -mno-long-calls
11008 @opindex mlong-calls
11009 @opindex mno-long-calls
11010 Treat all calls as being far away (near).  If calls are assumed to be
11011 far away, the compiler will always load the functions address up into a
11012 register, and call indirect through the pointer.
11014 @item -mno-ep
11015 @itemx -mep
11016 @opindex mno-ep
11017 @opindex mep
11018 Do not optimize (do optimize) basic blocks that use the same index
11019 pointer 4 or more times to copy pointer into the @code{ep} register, and
11020 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11021 option is on by default if you optimize.
11023 @item -mno-prolog-function
11024 @itemx -mprolog-function
11025 @opindex mno-prolog-function
11026 @opindex mprolog-function
11027 Do not use (do use) external functions to save and restore registers
11028 at the prologue and epilogue of a function.  The external functions
11029 are slower, but use less code space if more than one function saves
11030 the same number of registers.  The @option{-mprolog-function} option
11031 is on by default if you optimize.
11033 @item -mspace
11034 @opindex mspace
11035 Try to make the code as small as possible.  At present, this just turns
11036 on the @option{-mep} and @option{-mprolog-function} options.
11038 @item -mtda=@var{n}
11039 @opindex mtda
11040 Put static or global variables whose size is @var{n} bytes or less into
11041 the tiny data area that register @code{ep} points to.  The tiny data
11042 area can hold up to 256 bytes in total (128 bytes for byte references).
11044 @item -msda=@var{n}
11045 @opindex msda
11046 Put static or global variables whose size is @var{n} bytes or less into
11047 the small data area that register @code{gp} points to.  The small data
11048 area can hold up to 64 kilobytes.
11050 @item -mzda=@var{n}
11051 @opindex mzda
11052 Put static or global variables whose size is @var{n} bytes or less into
11053 the first 32 kilobytes of memory.
11055 @item -mv850
11056 @opindex mv850
11057 Specify that the target processor is the V850.
11059 @item -mbig-switch
11060 @opindex mbig-switch
11061 Generate code suitable for big switch tables.  Use this option only if
11062 the assembler/linker complain about out of range branches within a switch
11063 table.
11065 @item -mapp-regs
11066 @opindex mapp-regs
11067 This option will cause r2 and r5 to be used in the code generated by
11068 the compiler.  This setting is the default.
11070 @item -mno-app-regs
11071 @opindex mno-app-regs
11072 This option will cause r2 and r5 to be treated as fixed registers.
11074 @item -mv850e1
11075 @opindex mv850e1
11076 Specify that the target processor is the V850E1.  The preprocessor
11077 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11078 this option is used.
11080 @item -mv850e
11081 @opindex mv850e
11082 Specify that the target processor is the V850E.  The preprocessor
11083 constant @samp{__v850e__} will be defined if this option is used.
11085 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11086 are defined then a default target processor will be chosen and the
11087 relevant @samp{__v850*__} preprocessor constant will be defined.
11089 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11090 defined, regardless of which processor variant is the target.
11092 @item -mdisable-callt
11093 @opindex mdisable-callt
11094 This option will suppress generation of the CALLT instruction for the
11095 v850e and v850e1 flavors of the v850 architecture.  The default is
11096 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11098 @end table
11100 @node VAX Options
11101 @subsection VAX Options
11102 @cindex VAX options
11104 These @samp{-m} options are defined for the VAX:
11106 @table @gcctabopt
11107 @item -munix
11108 @opindex munix
11109 Do not output certain jump instructions (@code{aobleq} and so on)
11110 that the Unix assembler for the VAX cannot handle across long
11111 ranges.
11113 @item -mgnu
11114 @opindex mgnu
11115 Do output those jump instructions, on the assumption that you
11116 will assemble with the GNU assembler.
11118 @item -mg
11119 @opindex mg
11120 Output code for g-format floating point numbers instead of d-format.
11121 @end table
11123 @node x86-64 Options
11124 @subsection x86-64 Options
11125 @cindex x86-64 options
11127 These are listed under @xref{i386 and x86-64 Options}.
11129 @node Xstormy16 Options
11130 @subsection Xstormy16 Options
11131 @cindex Xstormy16 Options
11133 These options are defined for Xstormy16:
11135 @table @gcctabopt
11136 @item -msim
11137 @opindex msim
11138 Choose startup files and linker script suitable for the simulator.
11139 @end table
11141 @node Xtensa Options
11142 @subsection Xtensa Options
11143 @cindex Xtensa Options
11145 These options are supported for Xtensa targets:
11147 @table @gcctabopt
11148 @item -mconst16
11149 @itemx -mno-const16
11150 @opindex mconst16
11151 @opindex mno-const16
11152 Enable or disable use of @code{CONST16} instructions for loading
11153 constant values.  The @code{CONST16} instruction is currently not a
11154 standard option from Tensilica.  When enabled, @code{CONST16}
11155 instructions are always used in place of the standard @code{L32R}
11156 instructions.  The use of @code{CONST16} is enabled by default only if
11157 the @code{L32R} instruction is not available.
11159 @item -mfused-madd
11160 @itemx -mno-fused-madd
11161 @opindex mfused-madd
11162 @opindex mno-fused-madd
11163 Enable or disable use of fused multiply/add and multiply/subtract
11164 instructions in the floating-point option.  This has no effect if the
11165 floating-point option is not also enabled.  Disabling fused multiply/add
11166 and multiply/subtract instructions forces the compiler to use separate
11167 instructions for the multiply and add/subtract operations.  This may be
11168 desirable in some cases where strict IEEE 754-compliant results are
11169 required: the fused multiply add/subtract instructions do not round the
11170 intermediate result, thereby producing results with @emph{more} bits of
11171 precision than specified by the IEEE standard.  Disabling fused multiply
11172 add/subtract instructions also ensures that the program output is not
11173 sensitive to the compiler's ability to combine multiply and add/subtract
11174 operations.
11176 @item -mtext-section-literals
11177 @itemx -mno-text-section-literals
11178 @opindex mtext-section-literals
11179 @opindex mno-text-section-literals
11180 Control the treatment of literal pools.  The default is
11181 @option{-mno-text-section-literals}, which places literals in a separate
11182 section in the output file.  This allows the literal pool to be placed
11183 in a data RAM/ROM, and it also allows the linker to combine literal
11184 pools from separate object files to remove redundant literals and
11185 improve code size.  With @option{-mtext-section-literals}, the literals
11186 are interspersed in the text section in order to keep them as close as
11187 possible to their references.  This may be necessary for large assembly
11188 files.
11190 @item -mtarget-align
11191 @itemx -mno-target-align
11192 @opindex mtarget-align
11193 @opindex mno-target-align
11194 When this option is enabled, GCC instructs the assembler to
11195 automatically align instructions to reduce branch penalties at the
11196 expense of some code density.  The assembler attempts to widen density
11197 instructions to align branch targets and the instructions following call
11198 instructions.  If there are not enough preceding safe density
11199 instructions to align a target, no widening will be performed.  The
11200 default is @option{-mtarget-align}.  These options do not affect the
11201 treatment of auto-aligned instructions like @code{LOOP}, which the
11202 assembler will always align, either by widening density instructions or
11203 by inserting no-op instructions.
11205 @item -mlongcalls
11206 @itemx -mno-longcalls
11207 @opindex mlongcalls
11208 @opindex mno-longcalls
11209 When this option is enabled, GCC instructs the assembler to translate
11210 direct calls to indirect calls unless it can determine that the target
11211 of a direct call is in the range allowed by the call instruction.  This
11212 translation typically occurs for calls to functions in other source
11213 files.  Specifically, the assembler translates a direct @code{CALL}
11214 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11215 The default is @option{-mno-longcalls}.  This option should be used in
11216 programs where the call target can potentially be out of range.  This
11217 option is implemented in the assembler, not the compiler, so the
11218 assembly code generated by GCC will still show direct call
11219 instructions---look at the disassembled object code to see the actual
11220 instructions.  Note that the assembler will use an indirect call for
11221 every cross-file call, not just those that really will be out of range.
11222 @end table
11224 @node zSeries Options
11225 @subsection zSeries Options
11226 @cindex zSeries options
11228 These are listed under @xref{S/390 and zSeries Options}.
11230 @node Code Gen Options
11231 @section Options for Code Generation Conventions
11232 @cindex code generation conventions
11233 @cindex options, code generation
11234 @cindex run-time options
11236 These machine-independent options control the interface conventions
11237 used in code generation.
11239 Most of them have both positive and negative forms; the negative form
11240 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11241 one of the forms is listed---the one which is not the default.  You
11242 can figure out the other form by either removing @samp{no-} or adding
11245 @table @gcctabopt
11246 @item -fbounds-check
11247 @opindex fbounds-check
11248 For front-ends that support it, generate additional code to check that
11249 indices used to access arrays are within the declared range.  This is
11250 currently only supported by the Java and Fortran 77 front-ends, where
11251 this option defaults to true and false respectively.
11253 @item -ftrapv
11254 @opindex ftrapv
11255 This option generates traps for signed overflow on addition, subtraction,
11256 multiplication operations.
11258 @item -fwrapv
11259 @opindex fwrapv
11260 This option instructs the compiler to assume that signed arithmetic
11261 overflow of addition, subtraction and multiplication wraps around
11262 using twos-complement representation.  This flag enables some optimizations
11263 and disables other.  This option is enabled by default for the Java
11264 front-end, as required by the Java language specification.
11266 @item -fexceptions
11267 @opindex fexceptions
11268 Enable exception handling.  Generates extra code needed to propagate
11269 exceptions.  For some targets, this implies GCC will generate frame
11270 unwind information for all functions, which can produce significant data
11271 size overhead, although it does not affect execution.  If you do not
11272 specify this option, GCC will enable it by default for languages like
11273 C++ which normally require exception handling, and disable it for
11274 languages like C that do not normally require it.  However, you may need
11275 to enable this option when compiling C code that needs to interoperate
11276 properly with exception handlers written in C++.  You may also wish to
11277 disable this option if you are compiling older C++ programs that don't
11278 use exception handling.
11280 @item -fnon-call-exceptions
11281 @opindex fnon-call-exceptions
11282 Generate code that allows trapping instructions to throw exceptions.
11283 Note that this requires platform-specific runtime support that does
11284 not exist everywhere.  Moreover, it only allows @emph{trapping}
11285 instructions to throw exceptions, i.e.@: memory references or floating
11286 point instructions.  It does not allow exceptions to be thrown from
11287 arbitrary signal handlers such as @code{SIGALRM}.
11289 @item -funwind-tables
11290 @opindex funwind-tables
11291 Similar to @option{-fexceptions}, except that it will just generate any needed
11292 static data, but will not affect the generated code in any other way.
11293 You will normally not enable this option; instead, a language processor
11294 that needs this handling would enable it on your behalf.
11296 @item -fasynchronous-unwind-tables
11297 @opindex funwind-tables
11298 Generate unwind table in dwarf2 format, if supported by target machine.  The
11299 table is exact at each instruction boundary, so it can be used for stack
11300 unwinding from asynchronous events (such as debugger or garbage collector).
11302 @item -fpcc-struct-return
11303 @opindex fpcc-struct-return
11304 Return ``short'' @code{struct} and @code{union} values in memory like
11305 longer ones, rather than in registers.  This convention is less
11306 efficient, but it has the advantage of allowing intercallability between
11307 GCC-compiled files and files compiled with other compilers, particularly
11308 the Portable C Compiler (pcc).
11310 The precise convention for returning structures in memory depends
11311 on the target configuration macros.
11313 Short structures and unions are those whose size and alignment match
11314 that of some integer type.
11316 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11317 switch is not binary compatible with code compiled with the
11318 @option{-freg-struct-return} switch.
11319 Use it to conform to a non-default application binary interface.
11321 @item -freg-struct-return
11322 @opindex freg-struct-return
11323 Return @code{struct} and @code{union} values in registers when possible.
11324 This is more efficient for small structures than
11325 @option{-fpcc-struct-return}.
11327 If you specify neither @option{-fpcc-struct-return} nor
11328 @option{-freg-struct-return}, GCC defaults to whichever convention is
11329 standard for the target.  If there is no standard convention, GCC
11330 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11331 the principal compiler.  In those cases, we can choose the standard, and
11332 we chose the more efficient register return alternative.
11334 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11335 switch is not binary compatible with code compiled with the
11336 @option{-fpcc-struct-return} switch.
11337 Use it to conform to a non-default application binary interface.
11339 @item -fshort-enums
11340 @opindex fshort-enums
11341 Allocate to an @code{enum} type only as many bytes as it needs for the
11342 declared range of possible values.  Specifically, the @code{enum} type
11343 will be equivalent to the smallest integer type which has enough room.
11345 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11346 code that is not binary compatible with code generated without that switch.
11347 Use it to conform to a non-default application binary interface.
11349 @item -fshort-double
11350 @opindex fshort-double
11351 Use the same size for @code{double} as for @code{float}.
11353 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11354 code that is not binary compatible with code generated without that switch.
11355 Use it to conform to a non-default application binary interface.
11357 @item -fshort-wchar
11358 @opindex fshort-wchar
11359 Override the underlying type for @samp{wchar_t} to be @samp{short
11360 unsigned int} instead of the default for the target.  This option is
11361 useful for building programs to run under WINE@.
11363 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11364 code that is not binary compatible with code generated without that switch.
11365 Use it to conform to a non-default application binary interface.
11367 @item -fshared-data
11368 @opindex fshared-data
11369 Requests that the data and non-@code{const} variables of this
11370 compilation be shared data rather than private data.  The distinction
11371 makes sense only on certain operating systems, where shared data is
11372 shared between processes running the same program, while private data
11373 exists in one copy per process.
11375 @item -fno-common
11376 @opindex fno-common
11377 In C, allocate even uninitialized global variables in the data section of the
11378 object file, rather than generating them as common blocks.  This has the
11379 effect that if the same variable is declared (without @code{extern}) in
11380 two different compilations, you will get an error when you link them.
11381 The only reason this might be useful is if you wish to verify that the
11382 program will work on other systems which always work this way.
11384 @item -fno-ident
11385 @opindex fno-ident
11386 Ignore the @samp{#ident} directive.
11388 @item -finhibit-size-directive
11389 @opindex finhibit-size-directive
11390 Don't output a @code{.size} assembler directive, or anything else that
11391 would cause trouble if the function is split in the middle, and the
11392 two halves are placed at locations far apart in memory.  This option is
11393 used when compiling @file{crtstuff.c}; you should not need to use it
11394 for anything else.
11396 @item -fverbose-asm
11397 @opindex fverbose-asm
11398 Put extra commentary information in the generated assembly code to
11399 make it more readable.  This option is generally only of use to those
11400 who actually need to read the generated assembly code (perhaps while
11401 debugging the compiler itself).
11403 @option{-fno-verbose-asm}, the default, causes the
11404 extra information to be omitted and is useful when comparing two assembler
11405 files.
11407 @item -fpic
11408 @opindex fpic
11409 @cindex global offset table
11410 @cindex PIC
11411 Generate position-independent code (PIC) suitable for use in a shared
11412 library, if supported for the target machine.  Such code accesses all
11413 constant addresses through a global offset table (GOT)@.  The dynamic
11414 loader resolves the GOT entries when the program starts (the dynamic
11415 loader is not part of GCC; it is part of the operating system).  If
11416 the GOT size for the linked executable exceeds a machine-specific
11417 maximum size, you get an error message from the linker indicating that
11418 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11419 instead.  (These maximums are 8k on the SPARC and 32k
11420 on the m68k and RS/6000.  The 386 has no such limit.)
11422 Position-independent code requires special support, and therefore works
11423 only on certain machines.  For the 386, GCC supports PIC for System V
11424 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11425 position-independent.
11427 @item -fPIC
11428 @opindex fPIC
11429 If supported for the target machine, emit position-independent code,
11430 suitable for dynamic linking and avoiding any limit on the size of the
11431 global offset table.  This option makes a difference on the m68k
11432 and the SPARC.
11434 Position-independent code requires special support, and therefore works
11435 only on certain machines.
11437 @item -fpie
11438 @itemx -fPIE
11439 @opindex fpie
11440 @opindex fPIE
11441 These options are similar to @option{-fpic} and @option{-fPIC}, but
11442 generated position independent code can be only linked into executables.
11443 Usually these options are used when @option{-pie} GCC option will be
11444 used during linking.
11446 @item -ffixed-@var{reg}
11447 @opindex ffixed
11448 Treat the register named @var{reg} as a fixed register; generated code
11449 should never refer to it (except perhaps as a stack pointer, frame
11450 pointer or in some other fixed role).
11452 @var{reg} must be the name of a register.  The register names accepted
11453 are machine-specific and are defined in the @code{REGISTER_NAMES}
11454 macro in the machine description macro file.
11456 This flag does not have a negative form, because it specifies a
11457 three-way choice.
11459 @item -fcall-used-@var{reg}
11460 @opindex fcall-used
11461 Treat the register named @var{reg} as an allocable register that is
11462 clobbered by function calls.  It may be allocated for temporaries or
11463 variables that do not live across a call.  Functions compiled this way
11464 will not save and restore the register @var{reg}.
11466 It is an error to used this flag with the frame pointer or stack pointer.
11467 Use of this flag for other registers that have fixed pervasive roles in
11468 the machine's execution model will produce disastrous results.
11470 This flag does not have a negative form, because it specifies a
11471 three-way choice.
11473 @item -fcall-saved-@var{reg}
11474 @opindex fcall-saved
11475 Treat the register named @var{reg} as an allocable register saved by
11476 functions.  It may be allocated even for temporaries or variables that
11477 live across a call.  Functions compiled this way will save and restore
11478 the register @var{reg} if they use it.
11480 It is an error to used this flag with the frame pointer or stack pointer.
11481 Use of this flag for other registers that have fixed pervasive roles in
11482 the machine's execution model will produce disastrous results.
11484 A different sort of disaster will result from the use of this flag for
11485 a register in which function values may be returned.
11487 This flag does not have a negative form, because it specifies a
11488 three-way choice.
11490 @item -fpack-struct
11491 @opindex fpack-struct
11492 Pack all structure members together without holes.
11494 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11495 code that is not binary compatible with code generated without that switch.
11496 Additionally, it makes the code suboptimal.
11497 Use it to conform to a non-default application binary interface.
11499 @item -finstrument-functions
11500 @opindex finstrument-functions
11501 Generate instrumentation calls for entry and exit to functions.  Just
11502 after function entry and just before function exit, the following
11503 profiling functions will be called with the address of the current
11504 function and its call site.  (On some platforms,
11505 @code{__builtin_return_address} does not work beyond the current
11506 function, so the call site information may not be available to the
11507 profiling functions otherwise.)
11509 @smallexample
11510 void __cyg_profile_func_enter (void *this_fn,
11511                                void *call_site);
11512 void __cyg_profile_func_exit  (void *this_fn,
11513                                void *call_site);
11514 @end smallexample
11516 The first argument is the address of the start of the current function,
11517 which may be looked up exactly in the symbol table.
11519 This instrumentation is also done for functions expanded inline in other
11520 functions.  The profiling calls will indicate where, conceptually, the
11521 inline function is entered and exited.  This means that addressable
11522 versions of such functions must be available.  If all your uses of a
11523 function are expanded inline, this may mean an additional expansion of
11524 code size.  If you use @samp{extern inline} in your C code, an
11525 addressable version of such functions must be provided.  (This is
11526 normally the case anyways, but if you get lucky and the optimizer always
11527 expands the functions inline, you might have gotten away without
11528 providing static copies.)
11530 A function may be given the attribute @code{no_instrument_function}, in
11531 which case this instrumentation will not be done.  This can be used, for
11532 example, for the profiling functions listed above, high-priority
11533 interrupt routines, and any functions from which the profiling functions
11534 cannot safely be called (perhaps signal handlers, if the profiling
11535 routines generate output or allocate memory).
11537 @item -fstack-check
11538 @opindex fstack-check
11539 Generate code to verify that you do not go beyond the boundary of the
11540 stack.  You should specify this flag if you are running in an
11541 environment with multiple threads, but only rarely need to specify it in
11542 a single-threaded environment since stack overflow is automatically
11543 detected on nearly all systems if there is only one stack.
11545 Note that this switch does not actually cause checking to be done; the
11546 operating system must do that.  The switch causes generation of code
11547 to ensure that the operating system sees the stack being extended.
11549 @item -fstack-limit-register=@var{reg}
11550 @itemx -fstack-limit-symbol=@var{sym}
11551 @itemx -fno-stack-limit
11552 @opindex fstack-limit-register
11553 @opindex fstack-limit-symbol
11554 @opindex fno-stack-limit
11555 Generate code to ensure that the stack does not grow beyond a certain value,
11556 either the value of a register or the address of a symbol.  If the stack
11557 would grow beyond the value, a signal is raised.  For most targets,
11558 the signal is raised before the stack overruns the boundary, so
11559 it is possible to catch the signal without taking special precautions.
11561 For instance, if the stack starts at absolute address @samp{0x80000000}
11562 and grows downwards, you can use the flags
11563 @option{-fstack-limit-symbol=__stack_limit} and
11564 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11565 of 128KB@.  Note that this may only work with the GNU linker.
11567 @cindex aliasing of parameters
11568 @cindex parameters, aliased
11569 @item -fargument-alias
11570 @itemx -fargument-noalias
11571 @itemx -fargument-noalias-global
11572 @opindex fargument-alias
11573 @opindex fargument-noalias
11574 @opindex fargument-noalias-global
11575 Specify the possible relationships among parameters and between
11576 parameters and global data.
11578 @option{-fargument-alias} specifies that arguments (parameters) may
11579 alias each other and may alias global storage.@*
11580 @option{-fargument-noalias} specifies that arguments do not alias
11581 each other, but may alias global storage.@*
11582 @option{-fargument-noalias-global} specifies that arguments do not
11583 alias each other and do not alias global storage.
11585 Each language will automatically use whatever option is required by
11586 the language standard.  You should not need to use these options yourself.
11588 @item -fleading-underscore
11589 @opindex fleading-underscore
11590 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11591 change the way C symbols are represented in the object file.  One use
11592 is to help link with legacy assembly code.
11594 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11595 generate code that is not binary compatible with code generated without that
11596 switch.  Use it to conform to a non-default application binary interface.
11597 Not all targets provide complete support for this switch.
11599 @item -ftls-model=@var{model}
11600 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11601 The @var{model} argument should be one of @code{global-dynamic},
11602 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11604 The default without @option{-fpic} is @code{initial-exec}; with
11605 @option{-fpic} the default is @code{global-dynamic}.
11606 @end table
11608 @c man end
11610 @node Environment Variables
11611 @section Environment Variables Affecting GCC
11612 @cindex environment variables
11614 @c man begin ENVIRONMENT
11615 This section describes several environment variables that affect how GCC
11616 operates.  Some of them work by specifying directories or prefixes to use
11617 when searching for various kinds of files.  Some are used to specify other
11618 aspects of the compilation environment.
11620 Note that you can also specify places to search using options such as
11621 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11622 take precedence over places specified using environment variables, which
11623 in turn take precedence over those specified by the configuration of GCC@.
11624 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11625 GNU Compiler Collection (GCC) Internals}.
11627 @table @env
11628 @item LANG
11629 @itemx LC_CTYPE
11630 @c @itemx LC_COLLATE
11631 @itemx LC_MESSAGES
11632 @c @itemx LC_MONETARY
11633 @c @itemx LC_NUMERIC
11634 @c @itemx LC_TIME
11635 @itemx LC_ALL
11636 @findex LANG
11637 @findex LC_CTYPE
11638 @c @findex LC_COLLATE
11639 @findex LC_MESSAGES
11640 @c @findex LC_MONETARY
11641 @c @findex LC_NUMERIC
11642 @c @findex LC_TIME
11643 @findex LC_ALL
11644 @cindex locale
11645 These environment variables control the way that GCC uses
11646 localization information that allow GCC to work with different
11647 national conventions.  GCC inspects the locale categories
11648 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11649 so.  These locale categories can be set to any value supported by your
11650 installation.  A typical value is @samp{en_UK} for English in the United
11651 Kingdom.
11653 The @env{LC_CTYPE} environment variable specifies character
11654 classification.  GCC uses it to determine the character boundaries in
11655 a string; this is needed for some multibyte encodings that contain quote
11656 and escape characters that would otherwise be interpreted as a string
11657 end or escape.
11659 The @env{LC_MESSAGES} environment variable specifies the language to
11660 use in diagnostic messages.
11662 If the @env{LC_ALL} environment variable is set, it overrides the value
11663 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11664 and @env{LC_MESSAGES} default to the value of the @env{LANG}
11665 environment variable.  If none of these variables are set, GCC
11666 defaults to traditional C English behavior.
11668 @item TMPDIR
11669 @findex TMPDIR
11670 If @env{TMPDIR} is set, it specifies the directory to use for temporary
11671 files.  GCC uses temporary files to hold the output of one stage of
11672 compilation which is to be used as input to the next stage: for example,
11673 the output of the preprocessor, which is the input to the compiler
11674 proper.
11676 @item GCC_EXEC_PREFIX
11677 @findex GCC_EXEC_PREFIX
11678 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
11679 names of the subprograms executed by the compiler.  No slash is added
11680 when this prefix is combined with the name of a subprogram, but you can
11681 specify a prefix that ends with a slash if you wish.
11683 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
11684 an appropriate prefix to use based on the pathname it was invoked with.
11686 If GCC cannot find the subprogram using the specified prefix, it
11687 tries looking in the usual places for the subprogram.
11689 The default value of @env{GCC_EXEC_PREFIX} is
11690 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
11691 of @code{prefix} when you ran the @file{configure} script.
11693 Other prefixes specified with @option{-B} take precedence over this prefix.
11695 This prefix is also used for finding files such as @file{crt0.o} that are
11696 used for linking.
11698 In addition, the prefix is used in an unusual way in finding the
11699 directories to search for header files.  For each of the standard
11700 directories whose name normally begins with @samp{/usr/local/lib/gcc}
11701 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
11702 replacing that beginning with the specified prefix to produce an
11703 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
11704 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
11705 These alternate directories are searched first; the standard directories
11706 come next.
11708 @item COMPILER_PATH
11709 @findex COMPILER_PATH
11710 The value of @env{COMPILER_PATH} is a colon-separated list of
11711 directories, much like @env{PATH}.  GCC tries the directories thus
11712 specified when searching for subprograms, if it can't find the
11713 subprograms using @env{GCC_EXEC_PREFIX}.
11715 @item LIBRARY_PATH
11716 @findex LIBRARY_PATH
11717 The value of @env{LIBRARY_PATH} is a colon-separated list of
11718 directories, much like @env{PATH}.  When configured as a native compiler,
11719 GCC tries the directories thus specified when searching for special
11720 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
11721 using GCC also uses these directories when searching for ordinary
11722 libraries for the @option{-l} option (but directories specified with
11723 @option{-L} come first).
11725 @item LANG
11726 @findex LANG
11727 @cindex locale definition
11728 This variable is used to pass locale information to the compiler.  One way in
11729 which this information is used is to determine the character set to be used
11730 when character literals, string literals and comments are parsed in C and C++.
11731 When the compiler is configured to allow multibyte characters,
11732 the following values for @env{LANG} are recognized:
11734 @table @samp
11735 @item C-JIS
11736 Recognize JIS characters.
11737 @item C-SJIS
11738 Recognize SJIS characters.
11739 @item C-EUCJP
11740 Recognize EUCJP characters.
11741 @end table
11743 If @env{LANG} is not defined, or if it has some other value, then the
11744 compiler will use mblen and mbtowc as defined by the default locale to
11745 recognize and translate multibyte characters.
11746 @end table
11748 @noindent
11749 Some additional environments variables affect the behavior of the
11750 preprocessor.
11752 @include cppenv.texi
11754 @c man end
11756 @node Precompiled Headers
11757 @section Using Precompiled Headers
11758 @cindex precompiled headers
11759 @cindex speed of compilation
11761 Often large projects have many header files that are included in every
11762 source file.  The time the compiler takes to process these header files
11763 over and over again can account for nearly all of the time required to
11764 build the project.  To make builds faster, GCC allows users to
11765 `precompile' a header file; then, if builds can use the precompiled
11766 header file they will be much faster.
11768 @strong{Caution:} There are a few known situations where GCC will
11769 crash when trying to use a precompiled header.  If you have trouble
11770 with a precompiled header, you should remove the precompiled header
11771 and compile without it.  In addition, please use GCC's on-line
11772 defect-tracking system to report any problems you encounter with
11773 precompiled headers.  @xref{Bugs}.
11775 To create a precompiled header file, simply compile it as you would any
11776 other file, if necessary using the @option{-x} option to make the driver
11777 treat it as a C or C++ header file.  You will probably want to use a
11778 tool like @command{make} to keep the precompiled header up-to-date when
11779 the headers it contains change.
11781 A precompiled header file will be searched for when @code{#include} is
11782 seen in the compilation.  As it searches for the included file
11783 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
11784 compiler looks for a precompiled header in each directory just before it
11785 looks for the include file in that directory.  The name searched for is
11786 the name specified in the @code{#include} with @samp{.gch} appended.  If
11787 the precompiled header file can't be used, it is ignored.
11789 For instance, if you have @code{#include "all.h"}, and you have
11790 @file{all.h.gch} in the same directory as @file{all.h}, then the
11791 precompiled header file will be used if possible, and the original
11792 header will be used otherwise.
11794 Alternatively, you might decide to put the precompiled header file in a
11795 directory and use @option{-I} to ensure that directory is searched
11796 before (or instead of) the directory containing the original header.
11797 Then, if you want to check that the precompiled header file is always
11798 used, you can put a file of the same name as the original header in this
11799 directory containing an @code{#error} command.
11801 This also works with @option{-include}.  So yet another way to use
11802 precompiled headers, good for projects not designed with precompiled
11803 header files in mind, is to simply take most of the header files used by
11804 a project, include them from another header file, precompile that header
11805 file, and @option{-include} the precompiled header.  If the header files
11806 have guards against multiple inclusion, they will be skipped because
11807 they've already been included (in the precompiled header).
11809 If you need to precompile the same header file for different
11810 languages, targets, or compiler options, you can instead make a
11811 @emph{directory} named like @file{all.h.gch}, and put each precompiled
11812 header in the directory, perhaps using @option{-o}.  It doesn't matter
11813 what you call the files in the directory, every precompiled header in
11814 the directory will be considered.  The first precompiled header
11815 encountered in the directory that is valid for this compilation will
11816 be used; they're searched in no particular order.
11818 There are many other possibilities, limited only by your imagination,
11819 good sense, and the constraints of your build system.
11821 A precompiled header file can be used only when these conditions apply:
11823 @itemize
11824 @item
11825 Only one precompiled header can be used in a particular compilation.
11827 @item
11828 A precompiled header can't be used once the first C token is seen.  You
11829 can have preprocessor directives before a precompiled header; you can
11830 even include a precompiled header from inside another header, so long as
11831 there are no C tokens before the @code{#include}.
11833 @item
11834 The precompiled header file must be produced for the same language as
11835 the current compilation.  You can't use a C precompiled header for a C++
11836 compilation.
11838 @item
11839 The precompiled header file must be produced by the same compiler
11840 version and configuration as the current compilation is using.
11841 The easiest way to guarantee this is to use the same compiler binary
11842 for creating and using precompiled headers.
11844 @item
11845 Any macros defined before the precompiled header is included must
11846 either be defined in the same way as when the precompiled header was
11847 generated, or must not affect the precompiled header, which usually
11848 means that the they don't appear in the precompiled header at all.
11850 The @option{-D} option is one way to define a macro before a
11851 precompiled header is included; using a @code{#define} can also do it.
11852 There are also some options that define macros implicitly, like
11853 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
11854 defined this way.
11856 @item If debugging information is output when using the precompiled
11857 header, using @option{-g} or similar, the same kind of debugging information
11858 must have been output when building the precompiled header.  However,
11859 a precompiled header built using @option{-g} can be used in a compilation
11860 when no debugging information is being output.
11862 @item The same @option{-m} options must generally be used when building
11863 and using the precompiled header.  @xref{Submodel Options},
11864 for any cases where this rule is relaxed.
11866 @item Each of the following options must be the same when building and using
11867 the precompiled header:
11869 @gccoptlist{-fexceptions -funit-at-a-time}
11871 @item
11872 Some other command-line options starting with @option{-f},
11873 @option{-p}, or @option{-O} must be defined in the same way as when
11874 the precompiled header was generated.  At present, it's not clear
11875 which options are safe to change and which are not; the safest choice
11876 is to use exactly the same options when generating and using the
11877 precompiled header.  The following are known to be safe:
11879 @gccoptlist{-fpreprocessed -pedantic-errors}
11881 @end itemize
11883 For all of these except the last, the compiler will automatically
11884 ignore the precompiled header if the conditions aren't met.  If you
11885 find an option combination that doesn't work and doesn't cause the
11886 precompiled header to be ignored, please consider filing a bug report,
11887 see @ref{Bugs}.
11889 If you do use differing options when generating and using the
11890 precompiled header, the actual behaviour will be a mixture of the
11891 behaviour for the options.  For instance, if you use @option{-g} to
11892 generate the precompiled header but not when using it, you may or may
11893 not get debugging information for routines in the precompiled header.
11895 @node Running Protoize
11896 @section Running Protoize
11898 The program @code{protoize} is an optional part of GCC@.  You can use
11899 it to add prototypes to a program, thus converting the program to ISO
11900 C in one respect.  The companion program @code{unprotoize} does the
11901 reverse: it removes argument types from any prototypes that are found.
11903 When you run these programs, you must specify a set of source files as
11904 command line arguments.  The conversion programs start out by compiling
11905 these files to see what functions they define.  The information gathered
11906 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
11908 After scanning comes actual conversion.  The specified files are all
11909 eligible to be converted; any files they include (whether sources or
11910 just headers) are eligible as well.
11912 But not all the eligible files are converted.  By default,
11913 @code{protoize} and @code{unprotoize} convert only source and header
11914 files in the current directory.  You can specify additional directories
11915 whose files should be converted with the @option{-d @var{directory}}
11916 option.  You can also specify particular files to exclude with the
11917 @option{-x @var{file}} option.  A file is converted if it is eligible, its
11918 directory name matches one of the specified directory names, and its
11919 name within the directory has not been excluded.
11921 Basic conversion with @code{protoize} consists of rewriting most
11922 function definitions and function declarations to specify the types of
11923 the arguments.  The only ones not rewritten are those for varargs
11924 functions.
11926 @code{protoize} optionally inserts prototype declarations at the
11927 beginning of the source file, to make them available for any calls that
11928 precede the function's definition.  Or it can insert prototype
11929 declarations with block scope in the blocks where undeclared functions
11930 are called.
11932 Basic conversion with @code{unprotoize} consists of rewriting most
11933 function declarations to remove any argument types, and rewriting
11934 function definitions to the old-style pre-ISO form.
11936 Both conversion programs print a warning for any function declaration or
11937 definition that they can't convert.  You can suppress these warnings
11938 with @option{-q}.
11940 The output from @code{protoize} or @code{unprotoize} replaces the
11941 original source file.  The original file is renamed to a name ending
11942 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
11943 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
11944 for DOS) file already exists, then the source file is simply discarded.
11946 @code{protoize} and @code{unprotoize} both depend on GCC itself to
11947 scan the program and collect information about the functions it uses.
11948 So neither of these programs will work until GCC is installed.
11950 Here is a table of the options you can use with @code{protoize} and
11951 @code{unprotoize}.  Each option works with both programs unless
11952 otherwise stated.
11954 @table @code
11955 @item -B @var{directory}
11956 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
11957 usual directory (normally @file{/usr/local/lib}).  This file contains
11958 prototype information about standard system functions.  This option
11959 applies only to @code{protoize}.
11961 @item -c @var{compilation-options}
11962 Use @var{compilation-options} as the options when running @command{gcc} to
11963 produce the @samp{.X} files.  The special option @option{-aux-info} is
11964 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
11966 Note that the compilation options must be given as a single argument to
11967 @code{protoize} or @code{unprotoize}.  If you want to specify several
11968 @command{gcc} options, you must quote the entire set of compilation options
11969 to make them a single word in the shell.
11971 There are certain @command{gcc} arguments that you cannot use, because they
11972 would produce the wrong kind of output.  These include @option{-g},
11973 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
11974 the @var{compilation-options}, they are ignored.
11976 @item -C
11977 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
11978 systems) instead of @samp{.c}.  This is convenient if you are converting
11979 a C program to C++.  This option applies only to @code{protoize}.
11981 @item -g
11982 Add explicit global declarations.  This means inserting explicit
11983 declarations at the beginning of each source file for each function
11984 that is called in the file and was not declared.  These declarations
11985 precede the first function definition that contains a call to an
11986 undeclared function.  This option applies only to @code{protoize}.
11988 @item -i @var{string}
11989 Indent old-style parameter declarations with the string @var{string}.
11990 This option applies only to @code{protoize}.
11992 @code{unprotoize} converts prototyped function definitions to old-style
11993 function definitions, where the arguments are declared between the
11994 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
11995 uses five spaces as the indentation.  If you want to indent with just
11996 one space instead, use @option{-i " "}.
11998 @item -k
11999 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12000 is finished.
12002 @item -l
12003 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12004 a prototype declaration for each function in each block which calls the
12005 function without any declaration.  This option applies only to
12006 @code{protoize}.
12008 @item -n
12009 Make no real changes.  This mode just prints information about the conversions
12010 that would have been done without @option{-n}.
12012 @item -N
12013 Make no @samp{.save} files.  The original files are simply deleted.
12014 Use this option with caution.
12016 @item -p @var{program}
12017 Use the program @var{program} as the compiler.  Normally, the name
12018 @file{gcc} is used.
12020 @item -q
12021 Work quietly.  Most warnings are suppressed.
12023 @item -v
12024 Print the version number, just like @option{-v} for @command{gcc}.
12025 @end table
12027 If you need special compiler options to compile one of your program's
12028 source files, then you should generate that file's @samp{.X} file
12029 specially, by running @command{gcc} on that source file with the
12030 appropriate options and the option @option{-aux-info}.  Then run
12031 @code{protoize} on the entire set of files.  @code{protoize} will use
12032 the existing @samp{.X} file because it is newer than the source file.
12033 For example:
12035 @smallexample
12036 gcc -Dfoo=bar file1.c -aux-info file1.X
12037 protoize *.c
12038 @end smallexample
12040 @noindent
12041 You need to include the special files along with the rest in the
12042 @code{protoize} command, even though their @samp{.X} files already
12043 exist, because otherwise they won't get converted.
12045 @xref{Protoize Caveats}, for more information on how to use
12046 @code{protoize} successfully.