* output.h (enum section_category): Export from varasm.c
[official-gcc.git] / gcc / doc / invoke.texi
blob399083de5c136de9b5babe561582b270af6bf7e6
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, 
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
111 @c man end
113 @xref{Option Index}, for an index to GCC's options.
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated  -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol  -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n}  @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
221 -w  -Wextra  -Wall  -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
223 -Wconversion  -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
225 -Werror  -Werror-implicit-function-declaration @gol
226 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security  -Wformat-y2k @gol
229 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
230 -Wimport  -Wno-import  -Winit-self  -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof  -Winvalid-pch @gol
233 -Wlarger-than-@var{len}  -Wunsafe-loop-optimizations  -Wlong-long @gol
234 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
238 -Wparentheses  -Wpointer-arith  -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type  -Wsequence-point  -Wshadow @gol
241 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
242 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
243 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
244 -Wunknown-pragmas  -Wno-pragmas -Wunreachable-code @gol
245 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
246 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
247 -Wvariadic-macros}
249 @item C-only Warning Options
250 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
251 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
252 -Wstrict-prototypes  -Wtraditional @gol
253 -Wdeclaration-after-statement -Wno-pointer-sign}
255 @item Debugging Options
256 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
257 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
258 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
259 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
260 -fdump-ipa-all -fdump-ipa-cgraph @gol
261 -fdump-tree-all @gol
262 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
263 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
266 -fdump-tree-ch @gol
267 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-nrv -fdump-tree-vect @gol
276 -fdump-tree-sink @gol
277 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-salias @gol
279 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
281 -ftree-vectorizer-verbose=@var{n} @gol
282 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
283 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
284 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
285 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
286 -ftest-coverage  -ftime-report -fvar-tracking @gol
287 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
288 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
289 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
290 -print-multi-directory  -print-multi-lib @gol
291 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
292 -save-temps  -time}
294 @item Optimization Options
295 @xref{Optimize Options,,Options that Control Optimization}.
296 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
297 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
298 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
299 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
300 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
301 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
302 -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
303 -fdelayed-branch  -fdelete-null-pointer-checks -fearly-inlining @gol
304 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
305 -fforce-addr  -ffunction-sections @gol
306 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
307 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
308 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
309 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
310 -fmodulo-sched -fno-branch-count-reg @gol
311 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
312 -fno-function-cse  -fno-guess-branch-probability @gol
313 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
314 -funsafe-math-optimizations  -funsafe-loop-optimizations  -ffinite-math-only @gol
315 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
316 -fomit-frame-pointer  -foptimize-register-move @gol
317 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
318 -fprofile-generate -fprofile-use @gol
319 -fregmove  -frename-registers @gol
320 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
321 -frerun-cse-after-loop  -frerun-loop-opt @gol
322 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
323 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
324 -fsched-spec-load-dangerous  @gol
325 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
326 -fsched2-use-superblocks @gol
327 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
328 -fsignaling-nans -fsingle-precision-constant  @gol
329 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
330 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
331 -fsplit-ivs-in-unroller -funswitch-loops @gol
332 -fvariable-expansion-in-unroller @gol
333 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
334 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
335 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
336 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
337 -ftree-salias -fweb @gol
338 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
339 --param @var{name}=@var{value}
340 -O  -O0  -O1  -O2  -O3  -Os}
342 @item Preprocessor Options
343 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
344 @gccoptlist{-A@var{question}=@var{answer} @gol
345 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
346 -C  -dD  -dI  -dM  -dN @gol
347 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
348 -idirafter @var{dir} @gol
349 -include @var{file}  -imacros @var{file} @gol
350 -iprefix @var{file}  -iwithprefix @var{dir} @gol
351 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
352 -isysroot @var{dir} @gol
353 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
354 -P  -fworking-directory  -remap @gol
355 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
356 -Xpreprocessor @var{option}}
358 @item Assembler Option
359 @xref{Assembler Options,,Passing Options to the Assembler}.
360 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
362 @item Linker Options
363 @xref{Link Options,,Options for Linking}.
364 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
365 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
366 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
367 -Wl,@var{option}  -Xlinker @var{option} @gol
368 -u @var{symbol}}
370 @item Directory Options
371 @xref{Directory Options,,Options for Directory Search}.
372 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}
373 -specs=@var{file}  -I- --sysroot=@var{dir}}
375 @item Target Options
376 @c I wrote this xref this way to avoid overfull hbox. -- rms
377 @xref{Target Options}.
378 @gccoptlist{-V @var{version}  -b @var{machine}}
380 @item Machine Dependent Options
381 @xref{Submodel Options,,Hardware Models and Configurations}.
382 @c This list is ordered alphanumerically by subsection name.
383 @c Try and put the significant identifier (CPU or system) first,
384 @c so users have a clue at guessing where the ones they want will be.
386 @emph{ARC Options}
387 @gccoptlist{-EB  -EL @gol
388 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
389 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
391 @emph{ARM Options}
392 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
393 -mabi=@var{name} @gol
394 -mapcs-stack-check  -mno-apcs-stack-check @gol
395 -mapcs-float  -mno-apcs-float @gol
396 -mapcs-reentrant  -mno-apcs-reentrant @gol
397 -msched-prolog  -mno-sched-prolog @gol
398 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
399 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
400 -mthumb-interwork  -mno-thumb-interwork @gol
401 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
402 -mstructure-size-boundary=@var{n} @gol
403 -mabort-on-noreturn @gol
404 -mlong-calls  -mno-long-calls @gol
405 -msingle-pic-base  -mno-single-pic-base @gol
406 -mpic-register=@var{reg} @gol
407 -mnop-fun-dllimport @gol
408 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
409 -mpoke-function-name @gol
410 -mthumb  -marm @gol
411 -mtpcs-frame  -mtpcs-leaf-frame @gol
412 -mcaller-super-interworking  -mcallee-super-interworking}
414 @emph{AVR Options}
415 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
416 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
418 @emph{Blackfin Options}
419 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
420 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
421 -mlow-64k -mno-low64k -mid-shared-library @gol
422 -mno-id-shared-library -mshared-library-id=@var{n} @gol
423 -mlong-calls  -mno-long-calls}
425 @emph{CRIS Options}
426 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
427 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
428 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
429 -mstack-align  -mdata-align  -mconst-align @gol
430 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
431 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
432 -mmul-bug-workaround  -mno-mul-bug-workaround}
434 @emph{Darwin Options}
435 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
436 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
437 -client_name  -compatibility_version  -current_version @gol
438 -dead_strip @gol
439 -dependency-file  -dylib_file  -dylinker_install_name @gol
440 -dynamic  -dynamiclib  -exported_symbols_list @gol
441 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
442 -force_flat_namespace  -headerpad_max_install_names @gol
443 -image_base  -init  -install_name  -keep_private_externs @gol
444 -multi_module  -multiply_defined  -multiply_defined_unused @gol
445 -noall_load   -no_dead_strip_inits_and_terms @gol
446 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
447 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
448 -private_bundle  -read_only_relocs  -sectalign @gol
449 -sectobjectsymbols  -whyload  -seg1addr @gol
450 -sectcreate  -sectobjectsymbols  -sectorder @gol
451 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
452 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
453 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
454 -single_module  -static  -sub_library  -sub_umbrella @gol
455 -twolevel_namespace  -umbrella  -undefined @gol
456 -unexported_symbols_list  -weak_reference_mismatches @gol
457 -whatsloaded -F -gused -gfull -mmacosx-min-version=@var{version} @gol
458 -mone-byte-bool}
460 @emph{DEC Alpha Options}
461 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
462 -mieee  -mieee-with-inexact  -mieee-conformant @gol
463 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
464 -mtrap-precision=@var{mode}  -mbuild-constants @gol
465 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
466 -mbwx  -mmax  -mfix  -mcix @gol
467 -mfloat-vax  -mfloat-ieee @gol
468 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
469 -msmall-text  -mlarge-text @gol
470 -mmemory-latency=@var{time}}
472 @emph{DEC Alpha/VMS Options}
473 @gccoptlist{-mvms-return-codes}
475 @emph{FRV Options}
476 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
477 -mhard-float  -msoft-float @gol
478 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
479 -mdouble  -mno-double @gol
480 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
481 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
482 -mlinked-fp  -mlong-calls  -malign-labels @gol
483 -mlibrary-pic  -macc-4  -macc-8 @gol
484 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
485 -moptimize-membar -mno-optimize-membar @gol
486 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
487 -mvliw-branch  -mno-vliw-branch @gol
488 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
489 -mno-nested-cond-exec  -mtomcat-stats @gol
490 -mTLS -mtls @gol
491 -mcpu=@var{cpu}}
493 @emph{H8/300 Options}
494 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
496 @emph{HPPA Options}
497 @gccoptlist{-march=@var{architecture-type} @gol
498 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
499 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
500 -mfixed-range=@var{register-range} @gol
501 -mjump-in-delay -mlinker-opt -mlong-calls @gol
502 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
503 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
504 -mno-jump-in-delay  -mno-long-load-store @gol
505 -mno-portable-runtime  -mno-soft-float @gol
506 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
507 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
508 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
509 -munix=@var{unix-std}  -nolibdld  -static  -threads}
511 @emph{i386 and x86-64 Options}
512 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
513 -mfpmath=@var{unit} @gol
514 -masm=@var{dialect}  -mno-fancy-math-387 @gol
515 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
516 -mno-wide-multiply  -mrtd  -malign-double @gol
517 -mpreferred-stack-boundary=@var{num} @gol
518 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
519 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
520 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
521 -m96bit-long-double  -mregparm=@var{num}  -msseregparm @gol
522 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
523 -mcmodel=@var{code-model} @gol
524 -m32  -m64 -mlarge-data-threshold=@var{num}}
526 @emph{IA-64 Options}
527 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
528 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
529 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
530 -minline-float-divide-max-throughput @gol
531 -minline-int-divide-min-latency @gol
532 -minline-int-divide-max-throughput  @gol
533 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
534 -mno-dwarf2-asm -mearly-stop-bits @gol
535 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
536 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
538 @emph{M32R/D Options}
539 @gccoptlist{-m32r2 -m32rx -m32r @gol
540 -mdebug @gol
541 -malign-loops -mno-align-loops @gol
542 -missue-rate=@var{number} @gol
543 -mbranch-cost=@var{number} @gol
544 -mmodel=@var{code-size-model-type} @gol
545 -msdata=@var{sdata-type} @gol
546 -mno-flush-func -mflush-func=@var{name} @gol
547 -mno-flush-trap -mflush-trap=@var{number} @gol
548 -G @var{num}}
550 @emph{M32C Options}
551 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
553 @emph{M680x0 Options}
554 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
555 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
556 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
557 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
558 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
560 @emph{M68hc1x Options}
561 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
562 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
563 -msoft-reg-count=@var{count}}
565 @emph{MCore Options}
566 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
567 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
568 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
569 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
570 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
572 @emph{MIPS Options}
573 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
574 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
575 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
576 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
577 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
578 -mdsp  -mpaired-single  -mips3d @gol
579 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
580 -G@var{num}  -membedded-data  -mno-embedded-data @gol
581 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
582 -msplit-addresses  -mno-split-addresses  @gol
583 -mexplicit-relocs  -mno-explicit-relocs  @gol
584 -mcheck-zero-division  -mno-check-zero-division @gol
585 -mdivide-traps  -mdivide-breaks @gol
586 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
587 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
588 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
589 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
590 -mfix-sb1  -mno-fix-sb1 @gol
591 -mflush-func=@var{func}  -mno-flush-func @gol
592 -mbranch-likely  -mno-branch-likely @gol
593 -mfp-exceptions -mno-fp-exceptions @gol
594 -mvr4130-align -mno-vr4130-align}
596 @emph{MMIX Options}
597 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
598 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
599 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
600 -mno-base-addresses  -msingle-exit  -mno-single-exit}
602 @emph{MN10300 Options}
603 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
604 -mam33  -mno-am33 @gol
605 -mam33-2  -mno-am33-2 @gol
606 -mno-crt0  -mrelax}
608 @emph{PDP-11 Options}
609 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
610 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
611 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
612 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
613 -mbranch-expensive  -mbranch-cheap @gol
614 -msplit  -mno-split  -munix-asm  -mdec-asm}
616 @emph{PowerPC Options}
617 See RS/6000 and PowerPC Options.
619 @emph{RS/6000 and PowerPC Options}
620 @gccoptlist{-mcpu=@var{cpu-type} @gol
621 -mtune=@var{cpu-type} @gol
622 -mpower  -mno-power  -mpower2  -mno-power2 @gol
623 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
624 -maltivec  -mno-altivec @gol
625 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
626 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
627 -mnew-mnemonics  -mold-mnemonics @gol
628 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
629 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
630 -malign-power  -malign-natural @gol
631 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
632 -mstring  -mno-string  -mupdate  -mno-update @gol
633 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
634 -mstrict-align  -mno-strict-align  -mrelocatable @gol
635 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
636 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
637 -mdynamic-no-pic  -maltivec  -mswdiv @gol
638 -mprioritize-restricted-insns=@var{priority} @gol
639 -msched-costly-dep=@var{dependence_type} @gol
640 -minsert-sched-nops=@var{scheme} @gol
641 -mcall-sysv  -mcall-netbsd @gol
642 -maix-struct-return  -msvr4-struct-return @gol
643 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
644 -misel -mno-isel @gol
645 -misel=yes  -misel=no @gol
646 -mspe -mno-spe @gol
647 -mspe=yes  -mspe=no @gol
648 -mvrsave -mno-vrsave @gol
649 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
650 -mprototype  -mno-prototype @gol
651 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
652 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
654 @emph{S/390 and zSeries Options}
655 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
656 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
657 -mpacked-stack  -mno-packed-stack @gol
658 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
659 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
660 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
661 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
663 @emph{SH Options}
664 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
665 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
666 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
667 -m5-64media  -m5-64media-nofpu @gol
668 -m5-32media  -m5-32media-nofpu @gol
669 -m5-compact  -m5-compact-nofpu @gol
670 -mb  -ml  -mdalign  -mrelax @gol
671 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
672 -mieee  -misize  -mpadstruct  -mspace @gol
673 -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
674 -mdivsi3_libfunc=@var{name}  @gol
675 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
676  -minvalid-symbols}
678 @emph{SPARC Options}
679 @gccoptlist{-mcpu=@var{cpu-type} @gol
680 -mtune=@var{cpu-type} @gol
681 -mcmodel=@var{code-model} @gol
682 -m32  -m64  -mapp-regs  -mno-app-regs @gol
683 -mfaster-structs  -mno-faster-structs @gol
684 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
685 -mhard-quad-float  -msoft-quad-float @gol
686 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
687 -mstack-bias  -mno-stack-bias @gol
688 -munaligned-doubles  -mno-unaligned-doubles @gol
689 -mv8plus  -mno-v8plus  -mvis  -mno-vis
690 -threads -pthreads}
692 @emph{System V Options}
693 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
695 @emph{TMS320C3x/C4x Options}
696 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
697 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
698 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
699 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
701 @emph{V850 Options}
702 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
703 -mprolog-function  -mno-prolog-function  -mspace @gol
704 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
705 -mapp-regs  -mno-app-regs @gol
706 -mdisable-callt  -mno-disable-callt @gol
707 -mv850e1 @gol
708 -mv850e @gol
709 -mv850  -mbig-switch}
711 @emph{VAX Options}
712 @gccoptlist{-mg  -mgnu  -munix}
714 @emph{x86-64 Options}
715 See i386 and x86-64 Options.
717 @emph{Xstormy16 Options}
718 @gccoptlist{-msim}
720 @emph{Xtensa Options}
721 @gccoptlist{-mconst16 -mno-const16 @gol
722 -mfused-madd  -mno-fused-madd @gol
723 -mtext-section-literals  -mno-text-section-literals @gol
724 -mtarget-align  -mno-target-align @gol
725 -mlongcalls  -mno-longcalls}
727 @emph{zSeries Options}
728 See S/390 and zSeries Options.
730 @item Code Generation Options
731 @xref{Code Gen Options,,Options for Code Generation Conventions}.
732 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
733 -ffixed-@var{reg}  -fexceptions @gol
734 -fnon-call-exceptions  -funwind-tables @gol
735 -fasynchronous-unwind-tables @gol
736 -finhibit-size-directive  -finstrument-functions @gol
737 -fno-common  -fno-ident @gol
738 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
739 -fno-jump-tables @gol
740 -freg-struct-return  -fshared-data  -fshort-enums @gol
741 -fshort-double  -fshort-wchar @gol
742 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
743 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
744 -fargument-alias  -fargument-noalias @gol
745 -fargument-noalias-global  -fleading-underscore @gol
746 -ftls-model=@var{model} @gol
747 -ftrapv  -fwrapv  -fbounds-check @gol
748 -fvisibility}
749 @end table
751 @menu
752 * Overall Options::     Controlling the kind of output:
753                         an executable, object files, assembler files,
754                         or preprocessed source.
755 * C Dialect Options::   Controlling the variant of C language compiled.
756 * C++ Dialect Options:: Variations on C++.
757 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
758                         and Objective-C++.
759 * Language Independent Options:: Controlling how diagnostics should be
760                         formatted.
761 * Warning Options::     How picky should the compiler be?
762 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
763 * Optimize Options::    How much optimization?
764 * Preprocessor Options:: Controlling header files and macro definitions.
765                          Also, getting dependency information for Make.
766 * Assembler Options::   Passing options to the assembler.
767 * Link Options::        Specifying libraries and so on.
768 * Directory Options::   Where to find header files and libraries.
769                         Where to find the compiler executable files.
770 * Spec Files::          How to pass switches to sub-processes.
771 * Target Options::      Running a cross-compiler, or an old version of GCC.
772 @end menu
774 @node Overall Options
775 @section Options Controlling the Kind of Output
777 Compilation can involve up to four stages: preprocessing, compilation
778 proper, assembly and linking, always in that order.  GCC is capable of
779 preprocessing and compiling several files either into several
780 assembler input files, or into one assembler input file; then each
781 assembler input file produces an object file, and linking combines all
782 the object files (those newly compiled, and those specified as input)
783 into an executable file.
785 @cindex file name suffix
786 For any given input file, the file name suffix determines what kind of
787 compilation is done:
789 @table @gcctabopt
790 @item @var{file}.c
791 C source code which must be preprocessed.
793 @item @var{file}.i
794 C source code which should not be preprocessed.
796 @item @var{file}.ii
797 C++ source code which should not be preprocessed.
799 @item @var{file}.m
800 Objective-C source code.  Note that you must link with the @file{libobjc}
801 library to make an Objective-C program work.
803 @item @var{file}.mi
804 Objective-C source code which should not be preprocessed.
806 @item @var{file}.mm
807 @itemx @var{file}.M
808 Objective-C++ source code.  Note that you must link with the @file{libobjc}
809 library to make an Objective-C++ program work.  Note that @samp{.M} refers
810 to a literal capital M@.
812 @item @var{file}.mii
813 Objective-C++ source code which should not be preprocessed.
815 @item @var{file}.h
816 C, C++, Objective-C or Objective-C++ header file to be turned into a
817 precompiled header.
819 @item @var{file}.cc
820 @itemx @var{file}.cp
821 @itemx @var{file}.cxx
822 @itemx @var{file}.cpp
823 @itemx @var{file}.CPP
824 @itemx @var{file}.c++
825 @itemx @var{file}.C
826 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
827 the last two letters must both be literally @samp{x}.  Likewise,
828 @samp{.C} refers to a literal capital C@.
830 @item @var{file}.mm
831 @itemx @var{file}.M
832 Objective-C++ source code which must be preprocessed.
834 @item @var{file}.mii
835 Objective-C++ source code which should not be preprocessed.
837 @item @var{file}.hh
838 @itemx @var{file}.H
839 C++ header file to be turned into a precompiled header.
841 @item @var{file}.f
842 @itemx @var{file}.for
843 @itemx @var{file}.FOR
844 Fortran source code which should not be preprocessed.
846 @item @var{file}.F
847 @itemx @var{file}.fpp
848 @itemx @var{file}.FPP
849 Fortran source code which must be preprocessed (with the traditional
850 preprocessor).
852 @item @var{file}.r
853 Fortran source code which must be preprocessed with a RATFOR
854 preprocessor (not included with GCC)@.
856 @item @var{file}.f90
857 @itemx @var{file}.f95
858 Fortran 90/95 source code which should not be preprocessed.
860 @c FIXME: Descriptions of Java file types.
861 @c @var{file}.java
862 @c @var{file}.class
863 @c @var{file}.zip
864 @c @var{file}.jar
866 @item @var{file}.ads
867 Ada source code file which contains a library unit declaration (a
868 declaration of a package, subprogram, or generic, or a generic
869 instantiation), or a library unit renaming declaration (a package,
870 generic, or subprogram renaming declaration).  Such files are also
871 called @dfn{specs}.
873 @itemx @var{file}.adb
874 Ada source code file containing a library unit body (a subprogram or
875 package body).  Such files are also called @dfn{bodies}.
877 @c GCC also knows about some suffixes for languages not yet included:
878 @c Pascal:
879 @c @var{file}.p
880 @c @var{file}.pas
882 @item @var{file}.s
883 Assembler code.
885 @item @var{file}.S
886 Assembler code which must be preprocessed.
888 @item @var{other}
889 An object file to be fed straight into linking.
890 Any file name with no recognized suffix is treated this way.
891 @end table
893 @opindex x
894 You can specify the input language explicitly with the @option{-x} option:
896 @table @gcctabopt
897 @item -x @var{language}
898 Specify explicitly the @var{language} for the following input files
899 (rather than letting the compiler choose a default based on the file
900 name suffix).  This option applies to all following input files until
901 the next @option{-x} option.  Possible values for @var{language} are:
902 @smallexample
903 c  c-header  c-cpp-output
904 c++  c++-header  c++-cpp-output
905 objective-c  objective-c-header  objective-c-cpp-output
906 objective-c++ objective-c++-header objective-c++-cpp-output
907 assembler  assembler-with-cpp
909 f77  f77-cpp-input  ratfor
911 java
912 treelang
913 @end smallexample
915 @item -x none
916 Turn off any specification of a language, so that subsequent files are
917 handled according to their file name suffixes (as they are if @option{-x}
918 has not been used at all).
920 @item -pass-exit-codes
921 @opindex pass-exit-codes
922 Normally the @command{gcc} program will exit with the code of 1 if any
923 phase of the compiler returns a non-success return code.  If you specify
924 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
925 numerically highest error produced by any phase that returned an error
926 indication.
927 @end table
929 If you only want some of the stages of compilation, you can use
930 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
931 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
932 @command{gcc} is to stop.  Note that some combinations (for example,
933 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
935 @table @gcctabopt
936 @item -c
937 @opindex c
938 Compile or assemble the source files, but do not link.  The linking
939 stage simply is not done.  The ultimate output is in the form of an
940 object file for each source file.
942 By default, the object file name for a source file is made by replacing
943 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
945 Unrecognized input files, not requiring compilation or assembly, are
946 ignored.
948 @item -S
949 @opindex S
950 Stop after the stage of compilation proper; do not assemble.  The output
951 is in the form of an assembler code file for each non-assembler input
952 file specified.
954 By default, the assembler file name for a source file is made by
955 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
957 Input files that don't require compilation are ignored.
959 @item -E
960 @opindex E
961 Stop after the preprocessing stage; do not run the compiler proper.  The
962 output is in the form of preprocessed source code, which is sent to the
963 standard output.
965 Input files which don't require preprocessing are ignored.
967 @cindex output file option
968 @item -o @var{file}
969 @opindex o
970 Place output in file @var{file}.  This applies regardless to whatever
971 sort of output is being produced, whether it be an executable file,
972 an object file, an assembler file or preprocessed C code.
974 If @option{-o} is not specified, the default is to put an executable
975 file in @file{a.out}, the object file for
976 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
977 assembler file in @file{@var{source}.s}, a precompiled header file in
978 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
979 standard output.
981 @item -v
982 @opindex v
983 Print (on standard error output) the commands executed to run the stages
984 of compilation.  Also print the version number of the compiler driver
985 program and of the preprocessor and the compiler proper.
987 @item -###
988 @opindex ###
989 Like @option{-v} except the commands are not executed and all command
990 arguments are quoted.  This is useful for shell scripts to capture the
991 driver-generated command lines.
993 @item -pipe
994 @opindex pipe
995 Use pipes rather than temporary files for communication between the
996 various stages of compilation.  This fails to work on some systems where
997 the assembler is unable to read from a pipe; but the GNU assembler has
998 no trouble.
1000 @item -combine
1001 @opindex combine
1002 If you are compiling multiple source files, this option tells the driver
1003 to pass all the source files to the compiler at once (for those
1004 languages for which the compiler can handle this).  This will allow
1005 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
1006 language for which this is supported is C@.  If you pass source files for
1007 multiple languages to the driver, using this option, the driver will invoke
1008 the compiler(s) that support IMA once each, passing each compiler all the
1009 source files appropriate for it.  For those languages that do not support
1010 IMA this option will be ignored, and the compiler will be invoked once for
1011 each source file in that language.  If you use this option in conjunction
1012 with @option{-save-temps}, the compiler will generate multiple
1013 pre-processed files
1014 (one for each source file), but only one (combined) @file{.o} or
1015 @file{.s} file.
1017 @item --help
1018 @opindex help
1019 Print (on the standard output) a description of the command line options
1020 understood by @command{gcc}.  If the @option{-v} option is also specified
1021 then @option{--help} will also be passed on to the various processes
1022 invoked by @command{gcc}, so that they can display the command line options
1023 they accept.  If the @option{-Wextra} option is also specified then command
1024 line options which have no documentation associated with them will also
1025 be displayed.
1027 @item --target-help
1028 @opindex target-help
1029 Print (on the standard output) a description of target specific command
1030 line options for each tool.
1032 @item --version
1033 @opindex version
1034 Display the version number and copyrights of the invoked GCC@.
1035 @end table
1037 @node Invoking G++
1038 @section Compiling C++ Programs
1040 @cindex suffixes for C++ source
1041 @cindex C++ source file suffixes
1042 C++ source files conventionally use one of the suffixes @samp{.C},
1043 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1044 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1045 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1046 files with these names and compiles them as C++ programs even if you
1047 call the compiler the same way as for compiling C programs (usually
1048 with the name @command{gcc}).
1050 @findex g++
1051 @findex c++
1052 However, C++ programs often require class libraries as well as a
1053 compiler that understands the C++ language---and under some
1054 circumstances, you might want to compile programs or header files from
1055 standard input, or otherwise without a suffix that flags them as C++
1056 programs.  You might also like to precompile a C header file with a
1057 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1058 program that calls GCC with the default language set to C++, and
1059 automatically specifies linking against the C++ library.  On many
1060 systems, @command{g++} is also installed with the name @command{c++}.
1062 @cindex invoking @command{g++}
1063 When you compile C++ programs, you may specify many of the same
1064 command-line options that you use for compiling programs in any
1065 language; or command-line options meaningful for C and related
1066 languages; or options that are meaningful only for C++ programs.
1067 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1068 explanations of options for languages related to C@.
1069 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1070 explanations of options that are meaningful only for C++ programs.
1072 @node C Dialect Options
1073 @section Options Controlling C Dialect
1074 @cindex dialect options
1075 @cindex language dialect options
1076 @cindex options, dialect
1078 The following options control the dialect of C (or languages derived
1079 from C, such as C++, Objective-C and Objective-C++) that the compiler
1080 accepts:
1082 @table @gcctabopt
1083 @cindex ANSI support
1084 @cindex ISO support
1085 @item -ansi
1086 @opindex ansi
1087 In C mode, support all ISO C90 programs.  In C++ mode,
1088 remove GNU extensions that conflict with ISO C++.
1090 This turns off certain features of GCC that are incompatible with ISO
1091 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1092 such as the @code{asm} and @code{typeof} keywords, and
1093 predefined macros such as @code{unix} and @code{vax} that identify the
1094 type of system you are using.  It also enables the undesirable and
1095 rarely used ISO trigraph feature.  For the C compiler,
1096 it disables recognition of C++ style @samp{//} comments as well as
1097 the @code{inline} keyword.
1099 The alternate keywords @code{__asm__}, @code{__extension__},
1100 @code{__inline__} and @code{__typeof__} continue to work despite
1101 @option{-ansi}.  You would not want to use them in an ISO C program, of
1102 course, but it is useful to put them in header files that might be included
1103 in compilations done with @option{-ansi}.  Alternate predefined macros
1104 such as @code{__unix__} and @code{__vax__} are also available, with or
1105 without @option{-ansi}.
1107 The @option{-ansi} option does not cause non-ISO programs to be
1108 rejected gratuitously.  For that, @option{-pedantic} is required in
1109 addition to @option{-ansi}.  @xref{Warning Options}.
1111 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1112 option is used.  Some header files may notice this macro and refrain
1113 from declaring certain functions or defining certain macros that the
1114 ISO standard doesn't call for; this is to avoid interfering with any
1115 programs that might use these names for other things.
1117 Functions which would normally be built in but do not have semantics
1118 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1119 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1120 built-in functions provided by GCC}, for details of the functions
1121 affected.
1123 @item -std=
1124 @opindex std
1125 Determine the language standard.  This option is currently only
1126 supported when compiling C or C++.  A value for this option must be
1127 provided; possible values are
1129 @table @samp
1130 @item c89
1131 @itemx iso9899:1990
1132 ISO C90 (same as @option{-ansi}).
1134 @item iso9899:199409
1135 ISO C90 as modified in amendment 1.
1137 @item c99
1138 @itemx c9x
1139 @itemx iso9899:1999
1140 @itemx iso9899:199x
1141 ISO C99.  Note that this standard is not yet fully supported; see
1142 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1143 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1145 @item gnu89
1146 Default, ISO C90 plus GNU extensions (including some C99 features).
1148 @item gnu99
1149 @itemx gnu9x
1150 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1151 this will become the default.  The name @samp{gnu9x} is deprecated.
1153 @item c++98
1154 The 1998 ISO C++ standard plus amendments.
1156 @item gnu++98
1157 The same as @option{-std=c++98} plus GNU extensions.  This is the
1158 default for C++ code.
1159 @end table
1161 Even when this option is not specified, you can still use some of the
1162 features of newer standards in so far as they do not conflict with
1163 previous C standards.  For example, you may use @code{__restrict__} even
1164 when @option{-std=c99} is not specified.
1166 The @option{-std} options specifying some version of ISO C have the same
1167 effects as @option{-ansi}, except that features that were not in ISO C90
1168 but are in the specified version (for example, @samp{//} comments and
1169 the @code{inline} keyword in ISO C99) are not disabled.
1171 @xref{Standards,,Language Standards Supported by GCC}, for details of
1172 these standard versions.
1174 @item -aux-info @var{filename}
1175 @opindex aux-info
1176 Output to the given filename prototyped declarations for all functions
1177 declared and/or defined in a translation unit, including those in header
1178 files.  This option is silently ignored in any language other than C@.
1180 Besides declarations, the file indicates, in comments, the origin of
1181 each declaration (source file and line), whether the declaration was
1182 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1183 @samp{O} for old, respectively, in the first character after the line
1184 number and the colon), and whether it came from a declaration or a
1185 definition (@samp{C} or @samp{F}, respectively, in the following
1186 character).  In the case of function definitions, a K&R-style list of
1187 arguments followed by their declarations is also provided, inside
1188 comments, after the declaration.
1190 @item -fno-asm
1191 @opindex fno-asm
1192 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1193 keyword, so that code can use these words as identifiers.  You can use
1194 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1195 instead.  @option{-ansi} implies @option{-fno-asm}.
1197 In C++, this switch only affects the @code{typeof} keyword, since
1198 @code{asm} and @code{inline} are standard keywords.  You may want to
1199 use the @option{-fno-gnu-keywords} flag instead, which has the same
1200 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1201 switch only affects the @code{asm} and @code{typeof} keywords, since
1202 @code{inline} is a standard keyword in ISO C99.
1204 @item -fno-builtin
1205 @itemx -fno-builtin-@var{function}
1206 @opindex fno-builtin
1207 @cindex built-in functions
1208 Don't recognize built-in functions that do not begin with
1209 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1210 functions provided by GCC}, for details of the functions affected,
1211 including those which are not built-in functions when @option{-ansi} or
1212 @option{-std} options for strict ISO C conformance are used because they
1213 do not have an ISO standard meaning.
1215 GCC normally generates special code to handle certain built-in functions
1216 more efficiently; for instance, calls to @code{alloca} may become single
1217 instructions that adjust the stack directly, and calls to @code{memcpy}
1218 may become inline copy loops.  The resulting code is often both smaller
1219 and faster, but since the function calls no longer appear as such, you
1220 cannot set a breakpoint on those calls, nor can you change the behavior
1221 of the functions by linking with a different library.  In addition,
1222 when a function is recognized as a built-in function, GCC may use
1223 information about that function to warn about problems with calls to
1224 that function, or to generate more efficient code, even if the
1225 resulting code still contains calls to that function.  For example,
1226 warnings are given with @option{-Wformat} for bad calls to
1227 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1228 known not to modify global memory.
1230 With the @option{-fno-builtin-@var{function}} option
1231 only the built-in function @var{function} is
1232 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1233 function is named this is not built-in in this version of GCC, this
1234 option is ignored.  There is no corresponding
1235 @option{-fbuiltin-@var{function}} option; if you wish to enable
1236 built-in functions selectively when using @option{-fno-builtin} or
1237 @option{-ffreestanding}, you may define macros such as:
1239 @smallexample
1240 #define abs(n)          __builtin_abs ((n))
1241 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1242 @end smallexample
1244 @item -fhosted
1245 @opindex fhosted
1246 @cindex hosted environment
1248 Assert that compilation takes place in a hosted environment.  This implies
1249 @option{-fbuiltin}.  A hosted environment is one in which the
1250 entire standard library is available, and in which @code{main} has a return
1251 type of @code{int}.  Examples are nearly everything except a kernel.
1252 This is equivalent to @option{-fno-freestanding}.
1254 @item -ffreestanding
1255 @opindex ffreestanding
1256 @cindex hosted environment
1258 Assert that compilation takes place in a freestanding environment.  This
1259 implies @option{-fno-builtin}.  A freestanding environment
1260 is one in which the standard library may not exist, and program startup may
1261 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1262 This is equivalent to @option{-fno-hosted}.
1264 @xref{Standards,,Language Standards Supported by GCC}, for details of
1265 freestanding and hosted environments.
1267 @item -fms-extensions
1268 @opindex fms-extensions
1269 Accept some non-standard constructs used in Microsoft header files.
1271 Some cases of unnamed fields in structures and unions are only
1272 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1273 fields within structs/unions}, for details.
1275 @item -trigraphs
1276 @opindex trigraphs
1277 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1278 options for strict ISO C conformance) implies @option{-trigraphs}.
1280 @item -no-integrated-cpp
1281 @opindex no-integrated-cpp
1282 Performs a compilation in two passes: preprocessing and compiling.  This
1283 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1284 @option{-B} option.  The user supplied compilation step can then add in
1285 an additional preprocessing step after normal preprocessing but before
1286 compiling.  The default is to use the integrated cpp (internal cpp)
1288 The semantics of this option will change if "cc1", "cc1plus", and
1289 "cc1obj" are merged.
1291 @cindex traditional C language
1292 @cindex C language, traditional
1293 @item -traditional
1294 @itemx -traditional-cpp
1295 @opindex traditional-cpp
1296 @opindex traditional
1297 Formerly, these options caused GCC to attempt to emulate a pre-standard
1298 C compiler.  They are now only supported with the @option{-E} switch.
1299 The preprocessor continues to support a pre-standard mode.  See the GNU
1300 CPP manual for details.
1302 @item -fcond-mismatch
1303 @opindex fcond-mismatch
1304 Allow conditional expressions with mismatched types in the second and
1305 third arguments.  The value of such an expression is void.  This option
1306 is not supported for C++.
1308 @item -funsigned-char
1309 @opindex funsigned-char
1310 Let the type @code{char} be unsigned, like @code{unsigned char}.
1312 Each kind of machine has a default for what @code{char} should
1313 be.  It is either like @code{unsigned char} by default or like
1314 @code{signed char} by default.
1316 Ideally, a portable program should always use @code{signed char} or
1317 @code{unsigned char} when it depends on the signedness of an object.
1318 But many programs have been written to use plain @code{char} and
1319 expect it to be signed, or expect it to be unsigned, depending on the
1320 machines they were written for.  This option, and its inverse, let you
1321 make such a program work with the opposite default.
1323 The type @code{char} is always a distinct type from each of
1324 @code{signed char} or @code{unsigned char}, even though its behavior
1325 is always just like one of those two.
1327 @item -fsigned-char
1328 @opindex fsigned-char
1329 Let the type @code{char} be signed, like @code{signed char}.
1331 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1332 the negative form of @option{-funsigned-char}.  Likewise, the option
1333 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1335 @item -fsigned-bitfields
1336 @itemx -funsigned-bitfields
1337 @itemx -fno-signed-bitfields
1338 @itemx -fno-unsigned-bitfields
1339 @opindex fsigned-bitfields
1340 @opindex funsigned-bitfields
1341 @opindex fno-signed-bitfields
1342 @opindex fno-unsigned-bitfields
1343 These options control whether a bit-field is signed or unsigned, when the
1344 declaration does not use either @code{signed} or @code{unsigned}.  By
1345 default, such a bit-field is signed, because this is consistent: the
1346 basic integer types such as @code{int} are signed types.
1347 @end table
1349 @node C++ Dialect Options
1350 @section Options Controlling C++ Dialect
1352 @cindex compiler options, C++
1353 @cindex C++ options, command line
1354 @cindex options, C++
1355 This section describes the command-line options that are only meaningful
1356 for C++ programs; but you can also use most of the GNU compiler options
1357 regardless of what language your program is in.  For example, you
1358 might compile a file @code{firstClass.C} like this:
1360 @smallexample
1361 g++ -g -frepo -O -c firstClass.C
1362 @end smallexample
1364 @noindent
1365 In this example, only @option{-frepo} is an option meant
1366 only for C++ programs; you can use the other options with any
1367 language supported by GCC@.
1369 Here is a list of options that are @emph{only} for compiling C++ programs:
1371 @table @gcctabopt
1373 @item -fabi-version=@var{n}
1374 @opindex fabi-version
1375 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1376 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1377 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1378 the version that conforms most closely to the C++ ABI specification.
1379 Therefore, the ABI obtained using version 0 will change as ABI bugs
1380 are fixed.
1382 The default is version 2.
1384 @item -fno-access-control
1385 @opindex fno-access-control
1386 Turn off all access checking.  This switch is mainly useful for working
1387 around bugs in the access control code.
1389 @item -fcheck-new
1390 @opindex fcheck-new
1391 Check that the pointer returned by @code{operator new} is non-null
1392 before attempting to modify the storage allocated.  This check is
1393 normally unnecessary because the C++ standard specifies that
1394 @code{operator new} will only return @code{0} if it is declared
1395 @samp{throw()}, in which case the compiler will always check the
1396 return value even without this option.  In all other cases, when
1397 @code{operator new} has a non-empty exception specification, memory
1398 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1399 @samp{new (nothrow)}.
1401 @item -fconserve-space
1402 @opindex fconserve-space
1403 Put uninitialized or runtime-initialized global variables into the
1404 common segment, as C does.  This saves space in the executable at the
1405 cost of not diagnosing duplicate definitions.  If you compile with this
1406 flag and your program mysteriously crashes after @code{main()} has
1407 completed, you may have an object that is being destroyed twice because
1408 two definitions were merged.
1410 This option is no longer useful on most targets, now that support has
1411 been added for putting variables into BSS without making them common.
1413 @item -fno-const-strings
1414 @opindex fno-const-strings
1415 Give string constants type @code{char *} instead of type @code{const
1416 char *}.  By default, G++ uses type @code{const char *} as required by
1417 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1418 actually modify the value of a string constant.
1420 This option might be removed in a future release of G++.  For maximum
1421 portability, you should structure your code so that it works with
1422 string constants that have type @code{const char *}.
1424 @item -fno-elide-constructors
1425 @opindex fno-elide-constructors
1426 The C++ standard allows an implementation to omit creating a temporary
1427 which is only used to initialize another object of the same type.
1428 Specifying this option disables that optimization, and forces G++ to
1429 call the copy constructor in all cases.
1431 @item -fno-enforce-eh-specs
1432 @opindex fno-enforce-eh-specs
1433 Don't check for violation of exception specifications at runtime.  This
1434 option violates the C++ standard, but may be useful for reducing code
1435 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1436 will still optimize based on the exception specifications.
1438 @item -ffor-scope
1439 @itemx -fno-for-scope
1440 @opindex ffor-scope
1441 @opindex fno-for-scope
1442 If @option{-ffor-scope} is specified, the scope of variables declared in
1443 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1444 as specified by the C++ standard.
1445 If @option{-fno-for-scope} is specified, the scope of variables declared in
1446 a @i{for-init-statement} extends to the end of the enclosing scope,
1447 as was the case in old versions of G++, and other (traditional)
1448 implementations of C++.
1450 The default if neither flag is given to follow the standard,
1451 but to allow and give a warning for old-style code that would
1452 otherwise be invalid, or have different behavior.
1454 @item -fno-gnu-keywords
1455 @opindex fno-gnu-keywords
1456 Do not recognize @code{typeof} as a keyword, so that code can use this
1457 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1458 @option{-ansi} implies @option{-fno-gnu-keywords}.
1460 @item -fno-implicit-templates
1461 @opindex fno-implicit-templates
1462 Never emit code for non-inline templates which are instantiated
1463 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1464 @xref{Template Instantiation}, for more information.
1466 @item -fno-implicit-inline-templates
1467 @opindex fno-implicit-inline-templates
1468 Don't emit code for implicit instantiations of inline templates, either.
1469 The default is to handle inlines differently so that compiles with and
1470 without optimization will need the same set of explicit instantiations.
1472 @item -fno-implement-inlines
1473 @opindex fno-implement-inlines
1474 To save space, do not emit out-of-line copies of inline functions
1475 controlled by @samp{#pragma implementation}.  This will cause linker
1476 errors if these functions are not inlined everywhere they are called.
1478 @item -fms-extensions
1479 @opindex fms-extensions
1480 Disable pedantic warnings about constructs used in MFC, such as implicit
1481 int and getting a pointer to member function via non-standard syntax.
1483 @item -fno-nonansi-builtins
1484 @opindex fno-nonansi-builtins
1485 Disable built-in declarations of functions that are not mandated by
1486 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1487 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1489 @item -fno-operator-names
1490 @opindex fno-operator-names
1491 Do not treat the operator name keywords @code{and}, @code{bitand},
1492 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1493 synonyms as keywords.
1495 @item -fno-optional-diags
1496 @opindex fno-optional-diags
1497 Disable diagnostics that the standard says a compiler does not need to
1498 issue.  Currently, the only such diagnostic issued by G++ is the one for
1499 a name having multiple meanings within a class.
1501 @item -fpermissive
1502 @opindex fpermissive
1503 Downgrade some diagnostics about nonconformant code from errors to
1504 warnings.  Thus, using @option{-fpermissive} will allow some
1505 nonconforming code to compile.
1507 @item -frepo
1508 @opindex frepo
1509 Enable automatic template instantiation at link time.  This option also
1510 implies @option{-fno-implicit-templates}.  @xref{Template
1511 Instantiation}, for more information.
1513 @item -fno-rtti
1514 @opindex fno-rtti
1515 Disable generation of information about every class with virtual
1516 functions for use by the C++ runtime type identification features
1517 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1518 of the language, you can save some space by using this flag.  Note that
1519 exception handling uses the same information, but it will generate it as
1520 needed.
1522 @item -fstats
1523 @opindex fstats
1524 Emit statistics about front-end processing at the end of the compilation.
1525 This information is generally only useful to the G++ development team.
1527 @item -ftemplate-depth-@var{n}
1528 @opindex ftemplate-depth
1529 Set the maximum instantiation depth for template classes to @var{n}.
1530 A limit on the template instantiation depth is needed to detect
1531 endless recursions during template class instantiation.  ANSI/ISO C++
1532 conforming programs must not rely on a maximum depth greater than 17.
1534 @item -fno-threadsafe-statics
1535 @opindex fno-threadsafe-statics
1536 Do not emit the extra code to use the routines specified in the C++
1537 ABI for thread-safe initialization of local statics.  You can use this
1538 option to reduce code size slightly in code that doesn't need to be
1539 thread-safe.
1541 @item -fuse-cxa-atexit
1542 @opindex fuse-cxa-atexit
1543 Register destructors for objects with static storage duration with the
1544 @code{__cxa_atexit} function rather than the @code{atexit} function.
1545 This option is required for fully standards-compliant handling of static
1546 destructors, but will only work if your C library supports
1547 @code{__cxa_atexit}.
1549 @item -fvisibility-inlines-hidden
1550 @opindex fvisibility-inlines-hidden
1551 Causes all inlined methods to be marked with
1552 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1553 appear in the export table of a DSO and do not require a PLT indirection
1554 when used within the DSO@.  Enabling this option can have a dramatic effect
1555 on load and link times of a DSO as it massively reduces the size of the
1556 dynamic export table when the library makes heavy use of templates.  While
1557 it can cause bloating through duplication of code within each DSO where
1558 it is used, often the wastage is less than the considerable space occupied
1559 by a long symbol name in the export table which is typical when using
1560 templates and namespaces.  For even more savings, combine with the
1561 @option{-fvisibility=hidden} switch.
1563 @item -fno-weak
1564 @opindex fno-weak
1565 Do not use weak symbol support, even if it is provided by the linker.
1566 By default, G++ will use weak symbols if they are available.  This
1567 option exists only for testing, and should not be used by end-users;
1568 it will result in inferior code and has no benefits.  This option may
1569 be removed in a future release of G++.
1571 @item -nostdinc++
1572 @opindex nostdinc++
1573 Do not search for header files in the standard directories specific to
1574 C++, but do still search the other standard directories.  (This option
1575 is used when building the C++ library.)
1576 @end table
1578 In addition, these optimization, warning, and code generation options
1579 have meanings only for C++ programs:
1581 @table @gcctabopt
1582 @item -fno-default-inline
1583 @opindex fno-default-inline
1584 Do not assume @samp{inline} for functions defined inside a class scope.
1585 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1586 functions will have linkage like inline functions; they just won't be
1587 inlined by default.
1589 @item -Wabi @r{(C++ only)}
1590 @opindex Wabi
1591 Warn when G++ generates code that is probably not compatible with the
1592 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1593 all such cases, there are probably some cases that are not warned about,
1594 even though G++ is generating incompatible code.  There may also be
1595 cases where warnings are emitted even though the code that is generated
1596 will be compatible.
1598 You should rewrite your code to avoid these warnings if you are
1599 concerned about the fact that code generated by G++ may not be binary
1600 compatible with code generated by other compilers.
1602 The known incompatibilities at this point include:
1604 @itemize @bullet
1606 @item
1607 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1608 pack data into the same byte as a base class.  For example:
1610 @smallexample
1611 struct A @{ virtual void f(); int f1 : 1; @};
1612 struct B : public A @{ int f2 : 1; @};
1613 @end smallexample
1615 @noindent
1616 In this case, G++ will place @code{B::f2} into the same byte
1617 as@code{A::f1}; other compilers will not.  You can avoid this problem
1618 by explicitly padding @code{A} so that its size is a multiple of the
1619 byte size on your platform; that will cause G++ and other compilers to
1620 layout @code{B} identically.
1622 @item
1623 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1624 tail padding when laying out virtual bases.  For example:
1626 @smallexample
1627 struct A @{ virtual void f(); char c1; @};
1628 struct B @{ B(); char c2; @};
1629 struct C : public A, public virtual B @{@};
1630 @end smallexample
1632 @noindent
1633 In this case, G++ will not place @code{B} into the tail-padding for
1634 @code{A}; other compilers will.  You can avoid this problem by
1635 explicitly padding @code{A} so that its size is a multiple of its
1636 alignment (ignoring virtual base classes); that will cause G++ and other
1637 compilers to layout @code{C} identically.
1639 @item
1640 Incorrect handling of bit-fields with declared widths greater than that
1641 of their underlying types, when the bit-fields appear in a union.  For
1642 example:
1644 @smallexample
1645 union U @{ int i : 4096; @};
1646 @end smallexample
1648 @noindent
1649 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1650 union too small by the number of bits in an @code{int}.
1652 @item
1653 Empty classes can be placed at incorrect offsets.  For example:
1655 @smallexample
1656 struct A @{@};
1658 struct B @{
1659   A a;
1660   virtual void f ();
1663 struct C : public B, public A @{@};
1664 @end smallexample
1666 @noindent
1667 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1668 it should be placed at offset zero.  G++ mistakenly believes that the
1669 @code{A} data member of @code{B} is already at offset zero.
1671 @item
1672 Names of template functions whose types involve @code{typename} or
1673 template template parameters can be mangled incorrectly.
1675 @smallexample
1676 template <typename Q>
1677 void f(typename Q::X) @{@}
1679 template <template <typename> class Q>
1680 void f(typename Q<int>::X) @{@}
1681 @end smallexample
1683 @noindent
1684 Instantiations of these templates may be mangled incorrectly.
1686 @end itemize
1688 @item -Wctor-dtor-privacy @r{(C++ only)}
1689 @opindex Wctor-dtor-privacy
1690 Warn when a class seems unusable because all the constructors or
1691 destructors in that class are private, and it has neither friends nor
1692 public static member functions.
1694 @item -Wnon-virtual-dtor @r{(C++ only)}
1695 @opindex Wnon-virtual-dtor
1696 Warn when a class appears to be polymorphic, thereby requiring a virtual
1697 destructor, yet it declares a non-virtual one.
1698 This warning is enabled by @option{-Wall}.
1700 @item -Wreorder @r{(C++ only)}
1701 @opindex Wreorder
1702 @cindex reordering, warning
1703 @cindex warning for reordering of member initializers
1704 Warn when the order of member initializers given in the code does not
1705 match the order in which they must be executed.  For instance:
1707 @smallexample
1708 struct A @{
1709   int i;
1710   int j;
1711   A(): j (0), i (1) @{ @}
1713 @end smallexample
1715 The compiler will rearrange the member initializers for @samp{i}
1716 and @samp{j} to match the declaration order of the members, emitting
1717 a warning to that effect.  This warning is enabled by @option{-Wall}.
1718 @end table
1720 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1722 @table @gcctabopt
1723 @item -Weffc++ @r{(C++ only)}
1724 @opindex Weffc++
1725 Warn about violations of the following style guidelines from Scott Meyers'
1726 @cite{Effective C++} book:
1728 @itemize @bullet
1729 @item
1730 Item 11:  Define a copy constructor and an assignment operator for classes
1731 with dynamically allocated memory.
1733 @item
1734 Item 12:  Prefer initialization to assignment in constructors.
1736 @item
1737 Item 14:  Make destructors virtual in base classes.
1739 @item
1740 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1742 @item
1743 Item 23:  Don't try to return a reference when you must return an object.
1745 @end itemize
1747 Also warn about violations of the following style guidelines from
1748 Scott Meyers' @cite{More Effective C++} book:
1750 @itemize @bullet
1751 @item
1752 Item 6:  Distinguish between prefix and postfix forms of increment and
1753 decrement operators.
1755 @item
1756 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1758 @end itemize
1760 When selecting this option, be aware that the standard library
1761 headers do not obey all of these guidelines; use @samp{grep -v}
1762 to filter out those warnings.
1764 @item -Wno-deprecated @r{(C++ only)}
1765 @opindex Wno-deprecated
1766 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1768 @item -Wstrict-null-sentinel @r{(C++ only)}
1769 @opindex Wstrict-null-sentinel
1770 Warn also about the use of an uncasted @code{NULL} as sentinel.  When
1771 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1772 to @code{__null}.  Although it is a null pointer constant not a null pointer,
1773 it is guaranteed to of the same size as a pointer.  But this use is
1774 not portable across different compilers.
1776 @item -Wno-non-template-friend @r{(C++ only)}
1777 @opindex Wno-non-template-friend
1778 Disable warnings when non-templatized friend functions are declared
1779 within a template.  Since the advent of explicit template specification
1780 support in G++, if the name of the friend is an unqualified-id (i.e.,
1781 @samp{friend foo(int)}), the C++ language specification demands that the
1782 friend declare or define an ordinary, nontemplate function.  (Section
1783 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1784 could be interpreted as a particular specialization of a templatized
1785 function.  Because this non-conforming behavior is no longer the default
1786 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1787 check existing code for potential trouble spots and is on by default.
1788 This new compiler behavior can be turned off with
1789 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1790 but disables the helpful warning.
1792 @item -Wold-style-cast @r{(C++ only)}
1793 @opindex Wold-style-cast
1794 Warn if an old-style (C-style) cast to a non-void type is used within
1795 a C++ program.  The new-style casts (@samp{static_cast},
1796 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1797 unintended effects and much easier to search for.
1799 @item -Woverloaded-virtual @r{(C++ only)}
1800 @opindex Woverloaded-virtual
1801 @cindex overloaded virtual fn, warning
1802 @cindex warning for overloaded virtual fn
1803 Warn when a function declaration hides virtual functions from a
1804 base class.  For example, in:
1806 @smallexample
1807 struct A @{
1808   virtual void f();
1811 struct B: public A @{
1812   void f(int);
1814 @end smallexample
1816 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1817 like:
1819 @smallexample
1820 B* b;
1821 b->f();
1822 @end smallexample
1824 will fail to compile.
1826 @item -Wno-pmf-conversions @r{(C++ only)}
1827 @opindex Wno-pmf-conversions
1828 Disable the diagnostic for converting a bound pointer to member function
1829 to a plain pointer.
1831 @item -Wsign-promo @r{(C++ only)}
1832 @opindex Wsign-promo
1833 Warn when overload resolution chooses a promotion from unsigned or
1834 enumerated type to a signed type, over a conversion to an unsigned type of
1835 the same size.  Previous versions of G++ would try to preserve
1836 unsignedness, but the standard mandates the current behavior.
1838 @smallexample
1839 struct A @{
1840   operator int ();
1841   A& operator = (int);
1844 main ()
1846   A a,b;
1847   a = b;
1849 @end smallexample
1851 In this example, G++ will synthesize a default @samp{A& operator =
1852 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1853 @end table
1855 @node Objective-C and Objective-C++ Dialect Options
1856 @section Options Controlling Objective-C and Objective-C++ Dialects
1858 @cindex compiler options, Objective-C and Objective-C++
1859 @cindex Objective-C and Objective-C++ options, command line
1860 @cindex options, Objective-C and Objective-C++
1861 (NOTE: This manual does not describe the Objective-C and Objective-C++
1862 languages themselves.  See @xref{Standards,,Language Standards
1863 Supported by GCC}, for references.)
1865 This section describes the command-line options that are only meaningful
1866 for Objective-C and Objective-C++ programs, but you can also use most of
1867 the language-independent GNU compiler options.
1868 For example, you might compile a file @code{some_class.m} like this:
1870 @smallexample
1871 gcc -g -fgnu-runtime -O -c some_class.m
1872 @end smallexample
1874 @noindent
1875 In this example, @option{-fgnu-runtime} is an option meant only for
1876 Objective-C and Objective-C++ programs; you can use the other options with
1877 any language supported by GCC@.
1879 Note that since Objective-C is an extension of the C language, Objective-C
1880 compilations may also use options specific to the C front-end (e.g.,
1881 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1882 C++-specific options (e.g., @option{-Wabi}).
1884 Here is a list of options that are @emph{only} for compiling Objective-C
1885 and Objective-C++ programs:
1887 @table @gcctabopt
1888 @item -fconstant-string-class=@var{class-name}
1889 @opindex fconstant-string-class
1890 Use @var{class-name} as the name of the class to instantiate for each
1891 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1892 class name is @code{NXConstantString} if the GNU runtime is being used, and
1893 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1894 @option{-fconstant-cfstrings} option, if also present, will override the
1895 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1896 to be laid out as constant CoreFoundation strings.
1898 @item -fgnu-runtime
1899 @opindex fgnu-runtime
1900 Generate object code compatible with the standard GNU Objective-C
1901 runtime.  This is the default for most types of systems.
1903 @item -fnext-runtime
1904 @opindex fnext-runtime
1905 Generate output compatible with the NeXT runtime.  This is the default
1906 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1907 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1908 used.
1910 @item -fno-nil-receivers
1911 @opindex fno-nil-receivers
1912 Assume that all Objective-C message dispatches (e.g.,
1913 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1914 is not @code{nil}.  This allows for more efficient entry points in the runtime
1915 to be used.  Currently, this option is only available in conjunction with
1916 the NeXT runtime on Mac OS X 10.3 and later.
1918 @item -fobjc-call-cxx-cdtors
1919 @opindex fobjc-call-cxx-cdtors
1920 For each Objective-C class, check if any of its instance variables is a
1921 C++ object with a non-trivial default constructor.  If so, synthesize a
1922 special @code{- (id) .cxx_construct} instance method that will run
1923 non-trivial default constructors on any such instance variables, in order,
1924 and then return @code{self}.  Similarly, check if any instance variable
1925 is a C++ object with a non-trivial destructor, and if so, synthesize a
1926 special @code{- (void) .cxx_destruct} method that will run
1927 all such default destructors, in reverse order.
1929 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1930 thusly generated will only operate on instance variables declared in the
1931 current Objective-C class, and not those inherited from superclasses.  It
1932 is the responsibility of the Objective-C runtime to invoke all such methods
1933 in an object's inheritance hierarchy.  The @code{- (id) .cxx_construct} methods
1934 will be invoked by the runtime immediately after a new object
1935 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1936 be invoked immediately before the runtime deallocates an object instance.
1938 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1939 support for invoking the @code{- (id) .cxx_construct} and
1940 @code{- (void) .cxx_destruct} methods.
1942 @item -fobjc-direct-dispatch
1943 @opindex fobjc-direct-dispatch
1944 Allow fast jumps to the message dispatcher.  On Darwin this is
1945 accomplished via the comm page.
1947 @item -fobjc-exceptions
1948 @opindex fobjc-exceptions
1949 Enable syntactic support for structured exception handling in Objective-C,
1950 similar to what is offered by C++ and Java.  Currently, this option is only
1951 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1953 @smallexample
1954   @@try @{
1955     @dots{}
1956        @@throw expr;
1957     @dots{}
1958   @}
1959   @@catch (AnObjCClass *exc) @{
1960     @dots{}
1961       @@throw expr;
1962     @dots{}
1963       @@throw;
1964     @dots{}
1965   @}
1966   @@catch (AnotherClass *exc) @{
1967     @dots{}
1968   @}
1969   @@catch (id allOthers) @{
1970     @dots{}
1971   @}
1972   @@finally @{
1973     @dots{}
1974       @@throw expr;
1975     @dots{}
1976   @}
1977 @end smallexample
1979 The @code{@@throw} statement may appear anywhere in an Objective-C or
1980 Objective-C++ program; when used inside of a @code{@@catch} block, the
1981 @code{@@throw} may appear without an argument (as shown above), in which case
1982 the object caught by the @code{@@catch} will be rethrown.
1984 Note that only (pointers to) Objective-C objects may be thrown and
1985 caught using this scheme.  When an object is thrown, it will be caught
1986 by the nearest @code{@@catch} clause capable of handling objects of that type,
1987 analogously to how @code{catch} blocks work in C++ and Java.  A
1988 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1989 any and all Objective-C exceptions not caught by previous @code{@@catch}
1990 clauses (if any).
1992 The @code{@@finally} clause, if present, will be executed upon exit from the
1993 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1994 regardless of whether any exceptions are thrown, caught or rethrown
1995 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1996 of the @code{finally} clause in Java.
1998 There are several caveats to using the new exception mechanism:
2000 @itemize @bullet
2001 @item
2002 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2003 idioms provided by the @code{NSException} class, the new
2004 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2005 systems, due to additional functionality needed in the (NeXT) Objective-C
2006 runtime.
2008 @item
2009 As mentioned above, the new exceptions do not support handling
2010 types other than Objective-C objects.   Furthermore, when used from
2011 Objective-C++, the Objective-C exception model does not interoperate with C++
2012 exceptions at this time.  This means you cannot @code{@@throw} an exception
2013 from Objective-C and @code{catch} it in C++, or vice versa
2014 (i.e., @code{throw @dots{} @@catch}).
2015 @end itemize
2017 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2018 blocks for thread-safe execution:
2020 @smallexample
2021   @@synchronized (ObjCClass *guard) @{
2022     @dots{}
2023   @}
2024 @end smallexample
2026 Upon entering the @code{@@synchronized} block, a thread of execution shall
2027 first check whether a lock has been placed on the corresponding @code{guard}
2028 object by another thread.  If it has, the current thread shall wait until
2029 the other thread relinquishes its lock.  Once @code{guard} becomes available,
2030 the current thread will place its own lock on it, execute the code contained in
2031 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2032 making @code{guard} available to other threads).
2034 Unlike Java, Objective-C does not allow for entire methods to be marked
2035 @code{@@synchronized}.  Note that throwing exceptions out of
2036 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2037 to be unlocked properly.
2039 @item -fobjc-gc
2040 @opindex fobjc-gc
2041 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2043 @item -freplace-objc-classes
2044 @opindex freplace-objc-classes
2045 Emit a special marker instructing @command{ld(1)} not to statically link in
2046 the resulting object file, and allow @command{dyld(1)} to load it in at
2047 run time instead.  This is used in conjunction with the Fix-and-Continue
2048 debugging mode, where the object file in question may be recompiled and
2049 dynamically reloaded in the course of program execution, without the need
2050 to restart the program itself.  Currently, Fix-and-Continue functionality
2051 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2052 and later.
2054 @item -fzero-link
2055 @opindex fzero-link
2056 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2057 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2058 compile time) with static class references that get initialized at load time,
2059 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2060 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2061 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2062 for individual class implementations to be modified during program execution.
2064 @item -gen-decls
2065 @opindex gen-decls
2066 Dump interface declarations for all classes seen in the source file to a
2067 file named @file{@var{sourcename}.decl}.
2069 @item -Wassign-intercept
2070 @opindex Wassign-intercept
2071 Warn whenever an Objective-C assignment is being intercepted by the
2072 garbage collector.
2074 @item -Wno-protocol
2075 @opindex Wno-protocol
2076 If a class is declared to implement a protocol, a warning is issued for
2077 every method in the protocol that is not implemented by the class.  The
2078 default behavior is to issue a warning for every method not explicitly
2079 implemented in the class, even if a method implementation is inherited
2080 from the superclass.  If you use the @option{-Wno-protocol} option, then
2081 methods inherited from the superclass are considered to be implemented,
2082 and no warning is issued for them.
2084 @item -Wselector
2085 @opindex Wselector
2086 Warn if multiple methods of different types for the same selector are
2087 found during compilation.  The check is performed on the list of methods
2088 in the final stage of compilation.  Additionally, a check is performed
2089 for each selector appearing in a @code{@@selector(@dots{})}
2090 expression, and a corresponding method for that selector has been found
2091 during compilation.  Because these checks scan the method table only at
2092 the end of compilation, these warnings are not produced if the final
2093 stage of compilation is not reached, for example because an error is
2094 found during compilation, or because the @option{-fsyntax-only} option is
2095 being used.
2097 @item -Wstrict-selector-match
2098 @opindex Wstrict-selector-match
2099 Warn if multiple methods with differing argument and/or return types are
2100 found for a given selector when attempting to send a message using this
2101 selector to a receiver of type @code{id} or @code{Class}.  When this flag
2102 is off (which is the default behavior), the compiler will omit such warnings
2103 if any differences found are confined to types which share the same size
2104 and alignment.
2106 @item -Wundeclared-selector
2107 @opindex Wundeclared-selector
2108 Warn if a @code{@@selector(@dots{})} expression referring to an
2109 undeclared selector is found.  A selector is considered undeclared if no
2110 method with that name has been declared before the
2111 @code{@@selector(@dots{})} expression, either explicitly in an
2112 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2113 an @code{@@implementation} section.  This option always performs its
2114 checks as soon as a @code{@@selector(@dots{})} expression is found,
2115 while @option{-Wselector} only performs its checks in the final stage of
2116 compilation.  This also enforces the coding style convention
2117 that methods and selectors must be declared before being used.
2119 @item -print-objc-runtime-info
2120 @opindex print-objc-runtime-info
2121 Generate C header describing the largest structure that is passed by
2122 value, if any.
2124 @end table
2126 @node Language Independent Options
2127 @section Options to Control Diagnostic Messages Formatting
2128 @cindex options to control diagnostics formatting
2129 @cindex diagnostic messages
2130 @cindex message formatting
2132 Traditionally, diagnostic messages have been formatted irrespective of
2133 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2134 below can be used to control the diagnostic messages formatting
2135 algorithm, e.g.@: how many characters per line, how often source location
2136 information should be reported.  Right now, only the C++ front end can
2137 honor these options.  However it is expected, in the near future, that
2138 the remaining front ends would be able to digest them correctly.
2140 @table @gcctabopt
2141 @item -fmessage-length=@var{n}
2142 @opindex fmessage-length
2143 Try to format error messages so that they fit on lines of about @var{n}
2144 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2145 the front ends supported by GCC@.  If @var{n} is zero, then no
2146 line-wrapping will be done; each error message will appear on a single
2147 line.
2149 @opindex fdiagnostics-show-location
2150 @item -fdiagnostics-show-location=once
2151 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2152 reporter to emit @emph{once} source location information; that is, in
2153 case the message is too long to fit on a single physical line and has to
2154 be wrapped, the source location won't be emitted (as prefix) again,
2155 over and over, in subsequent continuation lines.  This is the default
2156 behavior.
2158 @item -fdiagnostics-show-location=every-line
2159 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2160 messages reporter to emit the same source location information (as
2161 prefix) for physical lines that result from the process of breaking
2162 a message which is too long to fit on a single line.
2164 @item -fdiagnostics-show-options
2165 @opindex fdiagnostics-show-options
2166 This option instructs the diagnostic machinery to add text to each
2167 diagnostic emitted, which indicates which command line option directly
2168 controls that diagnostic, when such an option is known to the
2169 diagnostic machinery.
2171 @end table
2173 @node Warning Options
2174 @section Options to Request or Suppress Warnings
2175 @cindex options to control warnings
2176 @cindex warning messages
2177 @cindex messages, warning
2178 @cindex suppressing warnings
2180 Warnings are diagnostic messages that report constructions which
2181 are not inherently erroneous but which are risky or suggest there
2182 may have been an error.
2184 You can request many specific warnings with options beginning @samp{-W},
2185 for example @option{-Wimplicit} to request warnings on implicit
2186 declarations.  Each of these specific warning options also has a
2187 negative form beginning @samp{-Wno-} to turn off warnings;
2188 for example, @option{-Wno-implicit}.  This manual lists only one of the
2189 two forms, whichever is not the default.
2191 The following options control the amount and kinds of warnings produced
2192 by GCC; for further, language-specific options also refer to
2193 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2194 Options}.
2196 @table @gcctabopt
2197 @cindex syntax checking
2198 @item -fsyntax-only
2199 @opindex fsyntax-only
2200 Check the code for syntax errors, but don't do anything beyond that.
2202 @item -pedantic
2203 @opindex pedantic
2204 Issue all the warnings demanded by strict ISO C and ISO C++;
2205 reject all programs that use forbidden extensions, and some other
2206 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2207 version of the ISO C standard specified by any @option{-std} option used.
2209 Valid ISO C and ISO C++ programs should compile properly with or without
2210 this option (though a rare few will require @option{-ansi} or a
2211 @option{-std} option specifying the required version of ISO C)@.  However,
2212 without this option, certain GNU extensions and traditional C and C++
2213 features are supported as well.  With this option, they are rejected.
2215 @option{-pedantic} does not cause warning messages for use of the
2216 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2217 warnings are also disabled in the expression that follows
2218 @code{__extension__}.  However, only system header files should use
2219 these escape routes; application programs should avoid them.
2220 @xref{Alternate Keywords}.
2222 Some users try to use @option{-pedantic} to check programs for strict ISO
2223 C conformance.  They soon find that it does not do quite what they want:
2224 it finds some non-ISO practices, but not all---only those for which
2225 ISO C @emph{requires} a diagnostic, and some others for which
2226 diagnostics have been added.
2228 A feature to report any failure to conform to ISO C might be useful in
2229 some instances, but would require considerable additional work and would
2230 be quite different from @option{-pedantic}.  We don't have plans to
2231 support such a feature in the near future.
2233 Where the standard specified with @option{-std} represents a GNU
2234 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2235 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2236 extended dialect is based.  Warnings from @option{-pedantic} are given
2237 where they are required by the base standard.  (It would not make sense
2238 for such warnings to be given only for features not in the specified GNU
2239 C dialect, since by definition the GNU dialects of C include all
2240 features the compiler supports with the given option, and there would be
2241 nothing to warn about.)
2243 @item -pedantic-errors
2244 @opindex pedantic-errors
2245 Like @option{-pedantic}, except that errors are produced rather than
2246 warnings.
2248 @item -w
2249 @opindex w
2250 Inhibit all warning messages.
2252 @item -Wno-import
2253 @opindex Wno-import
2254 Inhibit warning messages about the use of @samp{#import}.
2256 @item -Wchar-subscripts
2257 @opindex Wchar-subscripts
2258 Warn if an array subscript has type @code{char}.  This is a common cause
2259 of error, as programmers often forget that this type is signed on some
2260 machines.
2261 This warning is enabled by @option{-Wall}.
2263 @item -Wcomment
2264 @opindex Wcomment
2265 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2266 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2267 This warning is enabled by @option{-Wall}.
2269 @item -Wfatal-errors
2270 @opindex Wfatal-errors
2271 This option causes the compiler to abort compilation on the first error
2272 occurred rather than trying to keep going and printing further error
2273 messages.
2275 @item -Wformat
2276 @opindex Wformat
2277 @opindex ffreestanding
2278 @opindex fno-builtin
2279 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2280 the arguments supplied have types appropriate to the format string
2281 specified, and that the conversions specified in the format string make
2282 sense.  This includes standard functions, and others specified by format
2283 attributes (@pxref{Function Attributes}), in the @code{printf},
2284 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2285 not in the C standard) families (or other target-specific families).
2286 Which functions are checked without format attributes having been
2287 specified depends on the standard version selected, and such checks of
2288 functions without the attribute specified are disabled by
2289 @option{-ffreestanding} or @option{-fno-builtin}.
2291 The formats are checked against the format features supported by GNU
2292 libc version 2.2.  These include all ISO C90 and C99 features, as well
2293 as features from the Single Unix Specification and some BSD and GNU
2294 extensions.  Other library implementations may not support all these
2295 features; GCC does not support warning about features that go beyond a
2296 particular library's limitations.  However, if @option{-pedantic} is used
2297 with @option{-Wformat}, warnings will be given about format features not
2298 in the selected standard version (but not for @code{strfmon} formats,
2299 since those are not in any version of the C standard).  @xref{C Dialect
2300 Options,,Options Controlling C Dialect}.
2302 Since @option{-Wformat} also checks for null format arguments for
2303 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2305 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2306 aspects of format checking, the options @option{-Wformat-y2k},
2307 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2308 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2309 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2311 @item -Wformat-y2k
2312 @opindex Wformat-y2k
2313 If @option{-Wformat} is specified, also warn about @code{strftime}
2314 formats which may yield only a two-digit year.
2316 @item -Wno-format-extra-args
2317 @opindex Wno-format-extra-args
2318 If @option{-Wformat} is specified, do not warn about excess arguments to a
2319 @code{printf} or @code{scanf} format function.  The C standard specifies
2320 that such arguments are ignored.
2322 Where the unused arguments lie between used arguments that are
2323 specified with @samp{$} operand number specifications, normally
2324 warnings are still given, since the implementation could not know what
2325 type to pass to @code{va_arg} to skip the unused arguments.  However,
2326 in the case of @code{scanf} formats, this option will suppress the
2327 warning if the unused arguments are all pointers, since the Single
2328 Unix Specification says that such unused arguments are allowed.
2330 @item -Wno-format-zero-length
2331 @opindex Wno-format-zero-length
2332 If @option{-Wformat} is specified, do not warn about zero-length formats.
2333 The C standard specifies that zero-length formats are allowed.
2335 @item -Wformat-nonliteral
2336 @opindex Wformat-nonliteral
2337 If @option{-Wformat} is specified, also warn if the format string is not a
2338 string literal and so cannot be checked, unless the format function
2339 takes its format arguments as a @code{va_list}.
2341 @item -Wformat-security
2342 @opindex Wformat-security
2343 If @option{-Wformat} is specified, also warn about uses of format
2344 functions that represent possible security problems.  At present, this
2345 warns about calls to @code{printf} and @code{scanf} functions where the
2346 format string is not a string literal and there are no format arguments,
2347 as in @code{printf (foo);}.  This may be a security hole if the format
2348 string came from untrusted input and contains @samp{%n}.  (This is
2349 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2350 in future warnings may be added to @option{-Wformat-security} that are not
2351 included in @option{-Wformat-nonliteral}.)
2353 @item -Wformat=2
2354 @opindex Wformat=2
2355 Enable @option{-Wformat} plus format checks not included in
2356 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2357 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2359 @item -Wnonnull
2360 @opindex Wnonnull
2361 Warn about passing a null pointer for arguments marked as
2362 requiring a non-null value by the @code{nonnull} function attribute.
2364 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2365 can be disabled with the @option{-Wno-nonnull} option.
2367 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2368 @opindex Winit-self
2369 Warn about uninitialized variables which are initialized with themselves.
2370 Note this option can only be used with the @option{-Wuninitialized} option,
2371 which in turn only works with @option{-O1} and above.
2373 For example, GCC will warn about @code{i} being uninitialized in the
2374 following snippet only when @option{-Winit-self} has been specified:
2375 @smallexample
2376 @group
2377 int f()
2379   int i = i;
2380   return i;
2382 @end group
2383 @end smallexample
2385 @item -Wimplicit-int
2386 @opindex Wimplicit-int
2387 Warn when a declaration does not specify a type.
2388 This warning is enabled by @option{-Wall}.
2390 @item -Wimplicit-function-declaration
2391 @itemx -Werror-implicit-function-declaration
2392 @opindex Wimplicit-function-declaration
2393 @opindex Werror-implicit-function-declaration
2394 Give a warning (or error) whenever a function is used before being
2395 declared.  The form @option{-Wno-error-implicit-function-declaration}
2396 is not supported.
2397 This warning is enabled by @option{-Wall} (as a warning, not an error).
2399 @item -Wimplicit
2400 @opindex Wimplicit
2401 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2402 This warning is enabled by @option{-Wall}.
2404 @item -Wmain
2405 @opindex Wmain
2406 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2407 function with external linkage, returning int, taking either zero
2408 arguments, two, or three arguments of appropriate types.
2409 This warning is enabled by @option{-Wall}.
2411 @item -Wmissing-braces
2412 @opindex Wmissing-braces
2413 Warn if an aggregate or union initializer is not fully bracketed.  In
2414 the following example, the initializer for @samp{a} is not fully
2415 bracketed, but that for @samp{b} is fully bracketed.
2417 @smallexample
2418 int a[2][2] = @{ 0, 1, 2, 3 @};
2419 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2420 @end smallexample
2422 This warning is enabled by @option{-Wall}.
2424 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2425 @opindex Wmissing-include-dirs
2426 Warn if a user-supplied include directory does not exist.
2428 @item -Wparentheses
2429 @opindex Wparentheses
2430 Warn if parentheses are omitted in certain contexts, such
2431 as when there is an assignment in a context where a truth value
2432 is expected, or when operators are nested whose precedence people
2433 often get confused about.  Only the warning for an assignment used as
2434 a truth value is supported when compiling C++; the other warnings are
2435 only supported when compiling C@.
2437 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2438 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2439 interpretation from that of ordinary mathematical notation.
2441 Also warn about constructions where there may be confusion to which
2442 @code{if} statement an @code{else} branch belongs.  Here is an example of
2443 such a case:
2445 @smallexample
2446 @group
2448   if (a)
2449     if (b)
2450       foo ();
2451   else
2452     bar ();
2454 @end group
2455 @end smallexample
2457 In C, every @code{else} branch belongs to the innermost possible @code{if}
2458 statement, which in this example is @code{if (b)}.  This is often not
2459 what the programmer expected, as illustrated in the above example by
2460 indentation the programmer chose.  When there is the potential for this
2461 confusion, GCC will issue a warning when this flag is specified.
2462 To eliminate the warning, add explicit braces around the innermost
2463 @code{if} statement so there is no way the @code{else} could belong to
2464 the enclosing @code{if}.  The resulting code would look like this:
2466 @smallexample
2467 @group
2469   if (a)
2470     @{
2471       if (b)
2472         foo ();
2473       else
2474         bar ();
2475     @}
2477 @end group
2478 @end smallexample
2480 This warning is enabled by @option{-Wall}.
2482 @item -Wsequence-point
2483 @opindex Wsequence-point
2484 Warn about code that may have undefined semantics because of violations
2485 of sequence point rules in the C standard.
2487 The C standard defines the order in which expressions in a C program are
2488 evaluated in terms of @dfn{sequence points}, which represent a partial
2489 ordering between the execution of parts of the program: those executed
2490 before the sequence point, and those executed after it.  These occur
2491 after the evaluation of a full expression (one which is not part of a
2492 larger expression), after the evaluation of the first operand of a
2493 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2494 function is called (but after the evaluation of its arguments and the
2495 expression denoting the called function), and in certain other places.
2496 Other than as expressed by the sequence point rules, the order of
2497 evaluation of subexpressions of an expression is not specified.  All
2498 these rules describe only a partial order rather than a total order,
2499 since, for example, if two functions are called within one expression
2500 with no sequence point between them, the order in which the functions
2501 are called is not specified.  However, the standards committee have
2502 ruled that function calls do not overlap.
2504 It is not specified when between sequence points modifications to the
2505 values of objects take effect.  Programs whose behavior depends on this
2506 have undefined behavior; the C standard specifies that ``Between the
2507 previous and next sequence point an object shall have its stored value
2508 modified at most once by the evaluation of an expression.  Furthermore,
2509 the prior value shall be read only to determine the value to be
2510 stored.''.  If a program breaks these rules, the results on any
2511 particular implementation are entirely unpredictable.
2513 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2514 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2515 diagnosed by this option, and it may give an occasional false positive
2516 result, but in general it has been found fairly effective at detecting
2517 this sort of problem in programs.
2519 The present implementation of this option only works for C programs.  A
2520 future implementation may also work for C++ programs.
2522 The C standard is worded confusingly, therefore there is some debate
2523 over the precise meaning of the sequence point rules in subtle cases.
2524 Links to discussions of the problem, including proposed formal
2525 definitions, may be found on the GCC readings page, at
2526 @w{@uref{http://gcc.gnu.org/readings.html}}.
2528 This warning is enabled by @option{-Wall}.
2530 @item -Wreturn-type
2531 @opindex Wreturn-type
2532 Warn whenever a function is defined with a return-type that defaults to
2533 @code{int}.  Also warn about any @code{return} statement with no
2534 return-value in a function whose return-type is not @code{void}.
2536 For C, also warn if the return type of a function has a type qualifier
2537 such as @code{const}.  Such a type qualifier has no effect, since the
2538 value returned by a function is not an lvalue.  ISO C prohibits
2539 qualified @code{void} return types on function definitions, so such
2540 return types always receive a warning even without this option.
2542 For C++, a function without return type always produces a diagnostic
2543 message, even when @option{-Wno-return-type} is specified.  The only
2544 exceptions are @samp{main} and functions defined in system headers.
2546 This warning is enabled by @option{-Wall}.
2548 @item -Wswitch
2549 @opindex Wswitch
2550 Warn whenever a @code{switch} statement has an index of enumerated type
2551 and lacks a @code{case} for one or more of the named codes of that
2552 enumeration.  (The presence of a @code{default} label prevents this
2553 warning.)  @code{case} labels outside the enumeration range also
2554 provoke warnings when this option is used.
2555 This warning is enabled by @option{-Wall}.
2557 @item -Wswitch-default
2558 @opindex Wswitch-switch
2559 Warn whenever a @code{switch} statement does not have a @code{default}
2560 case.
2562 @item -Wswitch-enum
2563 @opindex Wswitch-enum
2564 Warn whenever a @code{switch} statement has an index of enumerated type
2565 and lacks a @code{case} for one or more of the named codes of that
2566 enumeration.  @code{case} labels outside the enumeration range also
2567 provoke warnings when this option is used.
2569 @item -Wtrigraphs
2570 @opindex Wtrigraphs
2571 Warn if any trigraphs are encountered that might change the meaning of
2572 the program (trigraphs within comments are not warned about).
2573 This warning is enabled by @option{-Wall}.
2575 @item -Wunused-function
2576 @opindex Wunused-function
2577 Warn whenever a static function is declared but not defined or a
2578 non\-inline static function is unused.
2579 This warning is enabled by @option{-Wall}.
2581 @item -Wunused-label
2582 @opindex Wunused-label
2583 Warn whenever a label is declared but not used.
2584 This warning is enabled by @option{-Wall}.
2586 To suppress this warning use the @samp{unused} attribute
2587 (@pxref{Variable Attributes}).
2589 @item -Wunused-parameter
2590 @opindex Wunused-parameter
2591 Warn whenever a function parameter is unused aside from its declaration.
2593 To suppress this warning use the @samp{unused} attribute
2594 (@pxref{Variable Attributes}).
2596 @item -Wunused-variable
2597 @opindex Wunused-variable
2598 Warn whenever a local variable or non-constant static variable is unused
2599 aside from its declaration
2600 This warning is enabled by @option{-Wall}.
2602 To suppress this warning use the @samp{unused} attribute
2603 (@pxref{Variable Attributes}).
2605 @item -Wunused-value
2606 @opindex Wunused-value
2607 Warn whenever a statement computes a result that is explicitly not used.
2608 This warning is enabled by @option{-Wall}.
2610 To suppress this warning cast the expression to @samp{void}.
2612 @item -Wunused
2613 @opindex Wunused
2614 All the above @option{-Wunused} options combined.
2616 In order to get a warning about an unused function parameter, you must
2617 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2618 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2620 @item -Wuninitialized
2621 @opindex Wuninitialized
2622 Warn if an automatic variable is used without first being initialized or
2623 if a variable may be clobbered by a @code{setjmp} call.
2625 These warnings are possible only in optimizing compilation,
2626 because they require data flow information that is computed only
2627 when optimizing.  If you don't specify @option{-O}, you simply won't
2628 get these warnings.
2630 If you want to warn about code which uses the uninitialized value of the
2631 variable in its own initializer, use the @option{-Winit-self} option.
2633 These warnings occur for individual uninitialized or clobbered
2634 elements of structure, union or array variables as well as for
2635 variables which are uninitialized or clobbered as a whole.  They do
2636 not occur for variables or elements declared @code{volatile}.  Because
2637 these warnings depend on optimization, the exact variables or elements
2638 for which there are warnings will depend on the precise optimization
2639 options and version of GCC used.
2641 Note that there may be no warning about a variable that is used only
2642 to compute a value that itself is never used, because such
2643 computations may be deleted by data flow analysis before the warnings
2644 are printed.
2646 These warnings are made optional because GCC is not smart
2647 enough to see all the reasons why the code might be correct
2648 despite appearing to have an error.  Here is one example of how
2649 this can happen:
2651 @smallexample
2652 @group
2654   int x;
2655   switch (y)
2656     @{
2657     case 1: x = 1;
2658       break;
2659     case 2: x = 4;
2660       break;
2661     case 3: x = 5;
2662     @}
2663   foo (x);
2665 @end group
2666 @end smallexample
2668 @noindent
2669 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2670 always initialized, but GCC doesn't know this.  Here is
2671 another common case:
2673 @smallexample
2675   int save_y;
2676   if (change_y) save_y = y, y = new_y;
2677   @dots{}
2678   if (change_y) y = save_y;
2680 @end smallexample
2682 @noindent
2683 This has no bug because @code{save_y} is used only if it is set.
2685 @cindex @code{longjmp} warnings
2686 This option also warns when a non-volatile automatic variable might be
2687 changed by a call to @code{longjmp}.  These warnings as well are possible
2688 only in optimizing compilation.
2690 The compiler sees only the calls to @code{setjmp}.  It cannot know
2691 where @code{longjmp} will be called; in fact, a signal handler could
2692 call it at any point in the code.  As a result, you may get a warning
2693 even when there is in fact no problem because @code{longjmp} cannot
2694 in fact be called at the place which would cause a problem.
2696 Some spurious warnings can be avoided if you declare all the functions
2697 you use that never return as @code{noreturn}.  @xref{Function
2698 Attributes}.
2700 This warning is enabled by @option{-Wall}.
2702 @item -Wunknown-pragmas
2703 @opindex Wunknown-pragmas
2704 @cindex warning for unknown pragmas
2705 @cindex unknown pragmas, warning
2706 @cindex pragmas, warning of unknown
2707 Warn when a #pragma directive is encountered which is not understood by
2708 GCC@.  If this command line option is used, warnings will even be issued
2709 for unknown pragmas in system header files.  This is not the case if
2710 the warnings were only enabled by the @option{-Wall} command line option.
2712 @item -Wno-pragmas
2713 @opindex Wno-pragmas
2714 @opindex Wpragmas
2715 Do not warn about misuses of pragmas, such as incorrect parameters,
2716 invalid syntax, or conflicts between pragmas.  See also
2717 @samp{-Wunknown-pragmas}.
2719 @item -Wstrict-aliasing
2720 @opindex Wstrict-aliasing
2721 This option is only active when @option{-fstrict-aliasing} is active.
2722 It warns about code which might break the strict aliasing rules that the
2723 compiler is using for optimization.  The warning does not catch all
2724 cases, but does attempt to catch the more common pitfalls.  It is
2725 included in @option{-Wall}.
2727 @item -Wstrict-aliasing=2
2728 @opindex Wstrict-aliasing=2
2729 This option is only active when @option{-fstrict-aliasing} is active.
2730 It warns about code which might break the strict aliasing rules that the
2731 compiler is using for optimization.  This warning catches more cases than
2732 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2733 cases that are safe.
2735 @item -Wall
2736 @opindex Wall
2737 All of the above @samp{-W} options combined.  This enables all the
2738 warnings about constructions that some users consider questionable, and
2739 that are easy to avoid (or modify to prevent the warning), even in
2740 conjunction with macros.  This also enables some language-specific
2741 warnings described in @ref{C++ Dialect Options} and
2742 @ref{Objective-C and Objective-C++ Dialect Options}.
2743 @end table
2745 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2746 Some of them warn about constructions that users generally do not
2747 consider questionable, but which occasionally you might wish to check
2748 for; others warn about constructions that are necessary or hard to avoid
2749 in some cases, and there is no simple way to modify the code to suppress
2750 the warning.
2752 @table @gcctabopt
2753 @item -Wextra
2754 @opindex W
2755 @opindex Wextra
2756 (This option used to be called @option{-W}.  The older name is still
2757 supported, but the newer name is more descriptive.)  Print extra warning
2758 messages for these events:
2760 @itemize @bullet
2761 @item
2762 A function can return either with or without a value.  (Falling
2763 off the end of the function body is considered returning without
2764 a value.)  For example, this function would evoke such a
2765 warning:
2767 @smallexample
2768 @group
2769 foo (a)
2771   if (a > 0)
2772     return a;
2774 @end group
2775 @end smallexample
2777 @item
2778 An expression-statement or the left-hand side of a comma expression
2779 contains no side effects.
2780 To suppress the warning, cast the unused expression to void.
2781 For example, an expression such as @samp{x[i,j]} will cause a warning,
2782 but @samp{x[(void)i,j]} will not.
2784 @item
2785 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2787 @item
2788 Storage-class specifiers like @code{static} are not the first things in
2789 a declaration.  According to the C Standard, this usage is obsolescent.
2791 @item
2792 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2793 arguments.
2795 @item
2796 A comparison between signed and unsigned values could produce an
2797 incorrect result when the signed value is converted to unsigned.
2798 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2800 @item
2801 An aggregate has an initializer which does not initialize all members.
2802 This warning can be independently controlled by
2803 @option{-Wmissing-field-initializers}.
2805 @item
2806 A function parameter is declared without a type specifier in K&R-style
2807 functions:
2809 @smallexample
2810 void foo(bar) @{ @}
2811 @end smallexample
2813 @item
2814 An empty body occurs in an @samp{if} or @samp{else} statement.
2816 @item
2817 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2818 @samp{>}, or @samp{>=}.
2820 @item
2821 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2823 @item
2824 Any of several floating-point events that often indicate errors, such as
2825 overflow, underflow, loss of precision, etc.
2827 @item @r{(C++ only)}
2828 An enumerator and a non-enumerator both appear in a conditional expression.
2830 @item @r{(C++ only)}
2831 A non-static reference or non-static @samp{const} member appears in a
2832 class without constructors.
2834 @item @r{(C++ only)}
2835 Ambiguous virtual bases.
2837 @item @r{(C++ only)}
2838 Subscripting an array which has been declared @samp{register}.
2840 @item @r{(C++ only)}
2841 Taking the address of a variable which has been declared @samp{register}.
2843 @item @r{(C++ only)}
2844 A base class is not initialized in a derived class' copy constructor.
2845 @end itemize
2847 @item -Wno-div-by-zero
2848 @opindex Wno-div-by-zero
2849 @opindex Wdiv-by-zero
2850 Do not warn about compile-time integer division by zero.  Floating point
2851 division by zero is not warned about, as it can be a legitimate way of
2852 obtaining infinities and NaNs.
2854 @item -Wsystem-headers
2855 @opindex Wsystem-headers
2856 @cindex warnings from system headers
2857 @cindex system headers, warnings from
2858 Print warning messages for constructs found in system header files.
2859 Warnings from system headers are normally suppressed, on the assumption
2860 that they usually do not indicate real problems and would only make the
2861 compiler output harder to read.  Using this command line option tells
2862 GCC to emit warnings from system headers as if they occurred in user
2863 code.  However, note that using @option{-Wall} in conjunction with this
2864 option will @emph{not} warn about unknown pragmas in system
2865 headers---for that, @option{-Wunknown-pragmas} must also be used.
2867 @item -Wfloat-equal
2868 @opindex Wfloat-equal
2869 Warn if floating point values are used in equality comparisons.
2871 The idea behind this is that sometimes it is convenient (for the
2872 programmer) to consider floating-point values as approximations to
2873 infinitely precise real numbers.  If you are doing this, then you need
2874 to compute (by analyzing the code, or in some other way) the maximum or
2875 likely maximum error that the computation introduces, and allow for it
2876 when performing comparisons (and when producing output, but that's a
2877 different problem).  In particular, instead of testing for equality, you
2878 would check to see whether the two values have ranges that overlap; and
2879 this is done with the relational operators, so equality comparisons are
2880 probably mistaken.
2882 @item -Wtraditional @r{(C only)}
2883 @opindex Wtraditional
2884 Warn about certain constructs that behave differently in traditional and
2885 ISO C@.  Also warn about ISO C constructs that have no traditional C
2886 equivalent, and/or problematic constructs which should be avoided.
2888 @itemize @bullet
2889 @item
2890 Macro parameters that appear within string literals in the macro body.
2891 In traditional C macro replacement takes place within string literals,
2892 but does not in ISO C@.
2894 @item
2895 In traditional C, some preprocessor directives did not exist.
2896 Traditional preprocessors would only consider a line to be a directive
2897 if the @samp{#} appeared in column 1 on the line.  Therefore
2898 @option{-Wtraditional} warns about directives that traditional C
2899 understands but would ignore because the @samp{#} does not appear as the
2900 first character on the line.  It also suggests you hide directives like
2901 @samp{#pragma} not understood by traditional C by indenting them.  Some
2902 traditional implementations would not recognize @samp{#elif}, so it
2903 suggests avoiding it altogether.
2905 @item
2906 A function-like macro that appears without arguments.
2908 @item
2909 The unary plus operator.
2911 @item
2912 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2913 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2914 constants.)  Note, these suffixes appear in macros defined in the system
2915 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2916 Use of these macros in user code might normally lead to spurious
2917 warnings, however GCC's integrated preprocessor has enough context to
2918 avoid warning in these cases.
2920 @item
2921 A function declared external in one block and then used after the end of
2922 the block.
2924 @item
2925 A @code{switch} statement has an operand of type @code{long}.
2927 @item
2928 A non-@code{static} function declaration follows a @code{static} one.
2929 This construct is not accepted by some traditional C compilers.
2931 @item
2932 The ISO type of an integer constant has a different width or
2933 signedness from its traditional type.  This warning is only issued if
2934 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2935 typically represent bit patterns, are not warned about.
2937 @item
2938 Usage of ISO string concatenation is detected.
2940 @item
2941 Initialization of automatic aggregates.
2943 @item
2944 Identifier conflicts with labels.  Traditional C lacks a separate
2945 namespace for labels.
2947 @item
2948 Initialization of unions.  If the initializer is zero, the warning is
2949 omitted.  This is done under the assumption that the zero initializer in
2950 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2951 initializer warnings and relies on default initialization to zero in the
2952 traditional C case.
2954 @item
2955 Conversions by prototypes between fixed/floating point values and vice
2956 versa.  The absence of these prototypes when compiling with traditional
2957 C would cause serious problems.  This is a subset of the possible
2958 conversion warnings, for the full set use @option{-Wconversion}.
2960 @item
2961 Use of ISO C style function definitions.  This warning intentionally is
2962 @emph{not} issued for prototype declarations or variadic functions
2963 because these ISO C features will appear in your code when using
2964 libiberty's traditional C compatibility macros, @code{PARAMS} and
2965 @code{VPARAMS}.  This warning is also bypassed for nested functions
2966 because that feature is already a GCC extension and thus not relevant to
2967 traditional C compatibility.
2968 @end itemize
2970 @item -Wdeclaration-after-statement @r{(C only)}
2971 @opindex Wdeclaration-after-statement
2972 Warn when a declaration is found after a statement in a block.  This
2973 construct, known from C++, was introduced with ISO C99 and is by default
2974 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2975 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2977 @item -Wundef
2978 @opindex Wundef
2979 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2981 @item -Wno-endif-labels
2982 @opindex Wno-endif-labels
2983 @opindex Wendif-labels
2984 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2986 @item -Wshadow
2987 @opindex Wshadow
2988 Warn whenever a local variable shadows another local variable, parameter or
2989 global variable or whenever a built-in function is shadowed.
2991 @item -Wlarger-than-@var{len}
2992 @opindex Wlarger-than
2993 Warn whenever an object of larger than @var{len} bytes is defined.
2995 @item -Wunsafe-loop-optimizations
2996 @opindex Wunsafe-loop-optimizations
2997 Warn if the loop cannot be optimized because the compiler could not
2998 assume anything on the bounds of the loop indices.  With
2999 @option{-funsafe-loop-optimizations} warn if the compiler made
3000 such assumptions.
3002 @item -Wpointer-arith
3003 @opindex Wpointer-arith
3004 Warn about anything that depends on the ``size of'' a function type or
3005 of @code{void}.  GNU C assigns these types a size of 1, for
3006 convenience in calculations with @code{void *} pointers and pointers
3007 to functions.
3009 @item -Wbad-function-cast @r{(C only)}
3010 @opindex Wbad-function-cast
3011 Warn whenever a function call is cast to a non-matching type.
3012 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3014 @item -Wc++-compat
3015 Warn about ISO C constructs that are outside of the common subset of
3016 ISO C and ISO C++, e.g.@: request for implicit conversion from
3017 @code{void *} to a pointer to non-@code{void} type.
3019 @item -Wcast-qual
3020 @opindex Wcast-qual
3021 Warn whenever a pointer is cast so as to remove a type qualifier from
3022 the target type.  For example, warn if a @code{const char *} is cast
3023 to an ordinary @code{char *}.
3025 @item -Wcast-align
3026 @opindex Wcast-align
3027 Warn whenever a pointer is cast such that the required alignment of the
3028 target is increased.  For example, warn if a @code{char *} is cast to
3029 an @code{int *} on machines where integers can only be accessed at
3030 two- or four-byte boundaries.
3032 @item -Wwrite-strings
3033 @opindex Wwrite-strings
3034 When compiling C, give string constants the type @code{const
3035 char[@var{length}]} so that
3036 copying the address of one into a non-@code{const} @code{char *}
3037 pointer will get a warning; when compiling C++, warn about the
3038 deprecated conversion from string constants to @code{char *}.
3039 These warnings will help you find at
3040 compile time code that can try to write into a string constant, but
3041 only if you have been very careful about using @code{const} in
3042 declarations and prototypes.  Otherwise, it will just be a nuisance;
3043 this is why we did not make @option{-Wall} request these warnings.
3045 @item -Wconversion
3046 @opindex Wconversion
3047 Warn if a prototype causes a type conversion that is different from what
3048 would happen to the same argument in the absence of a prototype.  This
3049 includes conversions of fixed point to floating and vice versa, and
3050 conversions changing the width or signedness of a fixed point argument
3051 except when the same as the default promotion.
3053 Also, warn if a negative integer constant expression is implicitly
3054 converted to an unsigned type.  For example, warn about the assignment
3055 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
3056 casts like @code{(unsigned) -1}.
3058 @item -Wsign-compare
3059 @opindex Wsign-compare
3060 @cindex warning for comparison of signed and unsigned values
3061 @cindex comparison of signed and unsigned values, warning
3062 @cindex signed and unsigned values, comparison warning
3063 Warn when a comparison between signed and unsigned values could produce
3064 an incorrect result when the signed value is converted to unsigned.
3065 This warning is also enabled by @option{-Wextra}; to get the other warnings
3066 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3068 @item -Waggregate-return
3069 @opindex Waggregate-return
3070 Warn if any functions that return structures or unions are defined or
3071 called.  (In languages where you can return an array, this also elicits
3072 a warning.)
3074 @item -Wno-attributes
3075 @opindex Wno-attributes
3076 @opindex Wattributes
3077 Do not warn if an unexpected @code{__attribute__} is used, such as
3078 unrecognized attributes, function attributes applied to variables,
3079 etc.  This will not stop errors for incorrect use of supported
3080 attributes.
3082 @item -Wstrict-prototypes @r{(C only)}
3083 @opindex Wstrict-prototypes
3084 Warn if a function is declared or defined without specifying the
3085 argument types.  (An old-style function definition is permitted without
3086 a warning if preceded by a declaration which specifies the argument
3087 types.)
3089 @item -Wold-style-definition @r{(C only)}
3090 @opindex Wold-style-definition
3091 Warn if an old-style function definition is used.  A warning is given
3092 even if there is a previous prototype.
3094 @item -Wmissing-prototypes @r{(C only)}
3095 @opindex Wmissing-prototypes
3096 Warn if a global function is defined without a previous prototype
3097 declaration.  This warning is issued even if the definition itself
3098 provides a prototype.  The aim is to detect global functions that fail
3099 to be declared in header files.
3101 @item -Wmissing-declarations @r{(C only)}
3102 @opindex Wmissing-declarations
3103 Warn if a global function is defined without a previous declaration.
3104 Do so even if the definition itself provides a prototype.
3105 Use this option to detect global functions that are not declared in
3106 header files.
3108 @item -Wmissing-field-initializers
3109 @opindex Wmissing-field-initializers
3110 @opindex W
3111 @opindex Wextra
3112 Warn if a structure's initializer has some fields missing.  For
3113 example, the following code would cause such a warning, because
3114 @code{x.h} is implicitly zero:
3116 @smallexample
3117 struct s @{ int f, g, h; @};
3118 struct s x = @{ 3, 4 @};
3119 @end smallexample
3121 This option does not warn about designated initializers, so the following
3122 modification would not trigger a warning:
3124 @smallexample
3125 struct s @{ int f, g, h; @};
3126 struct s x = @{ .f = 3, .g = 4 @};
3127 @end smallexample
3129 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3130 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3132 @item -Wmissing-noreturn
3133 @opindex Wmissing-noreturn
3134 Warn about functions which might be candidates for attribute @code{noreturn}.
3135 Note these are only possible candidates, not absolute ones.  Care should
3136 be taken to manually verify functions actually do not ever return before
3137 adding the @code{noreturn} attribute, otherwise subtle code generation
3138 bugs could be introduced.  You will not get a warning for @code{main} in
3139 hosted C environments.
3141 @item -Wmissing-format-attribute
3142 @opindex Wmissing-format-attribute
3143 @opindex Wformat
3144 Warn about function pointers which might be candidates for @code{format}
3145 attributes.  Note these are only possible candidates, not absolute ones.
3146 GCC will guess that function pointers with @code{format} attributes that
3147 are used in assignment, initialization, parameter passing or return
3148 statements should have a corresponding @code{format} attribute in the
3149 resulting type.  I.e.@: the left-hand side of the assignment or
3150 initialization, the type of the parameter variable, or the return type
3151 of the containing function respectively should also have a @code{format}
3152 attribute to avoid the warning.
3154 GCC will also warn about function definitions which might be
3155 candidates for @code{format} attributes.  Again, these are only
3156 possible candidates.  GCC will guess that @code{format} attributes
3157 might be appropriate for any function that calls a function like
3158 @code{vprintf} or @code{vscanf}, but this might not always be the
3159 case, and some functions for which @code{format} attributes are
3160 appropriate may not be detected.
3162 @item -Wno-multichar
3163 @opindex Wno-multichar
3164 @opindex Wmultichar
3165 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3166 Usually they indicate a typo in the user's code, as they have
3167 implementation-defined values, and should not be used in portable code.
3169 @item -Wnormalized=<none|id|nfc|nfkc>
3170 @opindex Wnormalized
3171 @cindex NFC
3172 @cindex NFKC
3173 @cindex character set, input normalization
3174 In ISO C and ISO C++, two identifiers are different if they are
3175 different sequences of characters.  However, sometimes when characters
3176 outside the basic ASCII character set are used, you can have two
3177 different character sequences that look the same.  To avoid confusion,
3178 the ISO 10646 standard sets out some @dfn{normalization rules} which
3179 when applied ensure that two sequences that look the same are turned into
3180 the same sequence.  GCC can warn you if you are using identifiers which
3181 have not been normalized; this option controls that warning.
3183 There are four levels of warning that GCC supports.  The default is
3184 @option{-Wnormalized=nfc}, which warns about any identifier which is
3185 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3186 recommended form for most uses.
3188 Unfortunately, there are some characters which ISO C and ISO C++ allow
3189 in identifiers that when turned into NFC aren't allowable as
3190 identifiers.  That is, there's no way to use these symbols in portable
3191 ISO C or C++ and have all your identifiers in NFC.
3192 @option{-Wnormalized=id} suppresses the warning for these characters.
3193 It is hoped that future versions of the standards involved will correct
3194 this, which is why this option is not the default.
3196 You can switch the warning off for all characters by writing
3197 @option{-Wnormalized=none}.  You would only want to do this if you
3198 were using some other normalization scheme (like ``D''), because
3199 otherwise you can easily create bugs that are literally impossible to see.
3201 Some characters in ISO 10646 have distinct meanings but look identical
3202 in some fonts or display methodologies, especially once formatting has
3203 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3204 LETTER N'', will display just like a regular @code{n} which has been
3205 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3206 normalisation scheme to convert all these into a standard form as
3207 well, and GCC will warn if your code is not in NFKC if you use
3208 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3209 about every identifier that contains the letter O because it might be
3210 confused with the digit 0, and so is not the default, but may be
3211 useful as a local coding convention if the programming environment is
3212 unable to be fixed to display these characters distinctly.
3214 @item -Wno-deprecated-declarations
3215 @opindex Wno-deprecated-declarations
3216 Do not warn about uses of functions, variables, and types marked as
3217 deprecated by using the @code{deprecated} attribute.
3218 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3219 @pxref{Type Attributes}.)
3221 @item -Wpacked
3222 @opindex Wpacked
3223 Warn if a structure is given the packed attribute, but the packed
3224 attribute has no effect on the layout or size of the structure.
3225 Such structures may be mis-aligned for little benefit.  For
3226 instance, in this code, the variable @code{f.x} in @code{struct bar}
3227 will be misaligned even though @code{struct bar} does not itself
3228 have the packed attribute:
3230 @smallexample
3231 @group
3232 struct foo @{
3233   int x;
3234   char a, b, c, d;
3235 @} __attribute__((packed));
3236 struct bar @{
3237   char z;
3238   struct foo f;
3240 @end group
3241 @end smallexample
3243 @item -Wpadded
3244 @opindex Wpadded
3245 Warn if padding is included in a structure, either to align an element
3246 of the structure or to align the whole structure.  Sometimes when this
3247 happens it is possible to rearrange the fields of the structure to
3248 reduce the padding and so make the structure smaller.
3250 @item -Wredundant-decls
3251 @opindex Wredundant-decls
3252 Warn if anything is declared more than once in the same scope, even in
3253 cases where multiple declaration is valid and changes nothing.
3255 @item -Wnested-externs @r{(C only)}
3256 @opindex Wnested-externs
3257 Warn if an @code{extern} declaration is encountered within a function.
3259 @item -Wunreachable-code
3260 @opindex Wunreachable-code
3261 Warn if the compiler detects that code will never be executed.
3263 This option is intended to warn when the compiler detects that at
3264 least a whole line of source code will never be executed, because
3265 some condition is never satisfied or because it is after a
3266 procedure that never returns.
3268 It is possible for this option to produce a warning even though there
3269 are circumstances under which part of the affected line can be executed,
3270 so care should be taken when removing apparently-unreachable code.
3272 For instance, when a function is inlined, a warning may mean that the
3273 line is unreachable in only one inlined copy of the function.
3275 This option is not made part of @option{-Wall} because in a debugging
3276 version of a program there is often substantial code which checks
3277 correct functioning of the program and is, hopefully, unreachable
3278 because the program does work.  Another common use of unreachable
3279 code is to provide behavior which is selectable at compile-time.
3281 @item -Winline
3282 @opindex Winline
3283 Warn if a function can not be inlined and it was declared as inline.
3284 Even with this option, the compiler will not warn about failures to
3285 inline functions declared in system headers.
3287 The compiler uses a variety of heuristics to determine whether or not
3288 to inline a function.  For example, the compiler takes into account
3289 the size of the function being inlined and the amount of inlining
3290 that has already been done in the current function.  Therefore,
3291 seemingly insignificant changes in the source program can cause the
3292 warnings produced by @option{-Winline} to appear or disappear.
3294 @item -Wno-invalid-offsetof @r{(C++ only)}
3295 @opindex Wno-invalid-offsetof
3296 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3297 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3298 to a non-POD type is undefined.  In existing C++ implementations,
3299 however, @samp{offsetof} typically gives meaningful results even when
3300 applied to certain kinds of non-POD types. (Such as a simple
3301 @samp{struct} that fails to be a POD type only by virtue of having a
3302 constructor.)  This flag is for users who are aware that they are
3303 writing nonportable code and who have deliberately chosen to ignore the
3304 warning about it.
3306 The restrictions on @samp{offsetof} may be relaxed in a future version
3307 of the C++ standard.
3309 @item -Wno-int-to-pointer-cast @r{(C only)}
3310 @opindex Wno-int-to-pointer-cast
3311 Suppress warnings from casts to pointer type of an integer of a
3312 different size.
3314 @item -Wno-pointer-to-int-cast @r{(C only)}
3315 @opindex Wno-pointer-to-int-cast
3316 Suppress warnings from casts from a pointer to an integer type of a
3317 different size.
3319 @item -Winvalid-pch
3320 @opindex Winvalid-pch
3321 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3322 the search path but can't be used.
3324 @item -Wlong-long
3325 @opindex Wlong-long
3326 @opindex Wno-long-long
3327 Warn if @samp{long long} type is used.  This is default.  To inhibit
3328 the warning messages, use @option{-Wno-long-long}.  Flags
3329 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3330 only when @option{-pedantic} flag is used.
3332 @item -Wvariadic-macros
3333 @opindex Wvariadic-macros
3334 @opindex Wno-variadic-macros
3335 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3336 alternate syntax when in pedantic ISO C99 mode.  This is default.
3337 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3339 @item -Wdisabled-optimization
3340 @opindex Wdisabled-optimization
3341 Warn if a requested optimization pass is disabled.  This warning does
3342 not generally indicate that there is anything wrong with your code; it
3343 merely indicates that GCC's optimizers were unable to handle the code
3344 effectively.  Often, the problem is that your code is too big or too
3345 complex; GCC will refuse to optimize programs when the optimization
3346 itself is likely to take inordinate amounts of time.
3348 @item -Wno-pointer-sign
3349 @opindex Wno-pointer-sign
3350 Don't warn for pointer argument passing or assignment with different signedness.
3351 Only useful in the negative form since this warning is enabled by default.
3352 This option is only supported for C and Objective-C@.
3354 @item -Werror
3355 @opindex Werror
3356 Make all warnings into errors.
3357 @end table
3359 @node Debugging Options
3360 @section Options for Debugging Your Program or GCC
3361 @cindex options, debugging
3362 @cindex debugging information options
3364 GCC has various special options that are used for debugging
3365 either your program or GCC:
3367 @table @gcctabopt
3368 @item -g
3369 @opindex g
3370 Produce debugging information in the operating system's native format
3371 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3372 information.
3374 On most systems that use stabs format, @option{-g} enables use of extra
3375 debugging information that only GDB can use; this extra information
3376 makes debugging work better in GDB but will probably make other debuggers
3377 crash or
3378 refuse to read the program.  If you want to control for certain whether
3379 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3380 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3382 GCC allows you to use @option{-g} with
3383 @option{-O}.  The shortcuts taken by optimized code may occasionally
3384 produce surprising results: some variables you declared may not exist
3385 at all; flow of control may briefly move where you did not expect it;
3386 some statements may not be executed because they compute constant
3387 results or their values were already at hand; some statements may
3388 execute in different places because they were moved out of loops.
3390 Nevertheless it proves possible to debug optimized output.  This makes
3391 it reasonable to use the optimizer for programs that might have bugs.
3393 The following options are useful when GCC is generated with the
3394 capability for more than one debugging format.
3396 @item -ggdb
3397 @opindex ggdb
3398 Produce debugging information for use by GDB@.  This means to use the
3399 most expressive format available (DWARF 2, stabs, or the native format
3400 if neither of those are supported), including GDB extensions if at all
3401 possible.
3403 @item -gstabs
3404 @opindex gstabs
3405 Produce debugging information in stabs format (if that is supported),
3406 without GDB extensions.  This is the format used by DBX on most BSD
3407 systems.  On MIPS, Alpha and System V Release 4 systems this option
3408 produces stabs debugging output which is not understood by DBX or SDB@.
3409 On System V Release 4 systems this option requires the GNU assembler.
3411 @item -feliminate-unused-debug-symbols
3412 @opindex feliminate-unused-debug-symbols
3413 Produce debugging information in stabs format (if that is supported),
3414 for only symbols that are actually used.
3416 @item -gstabs+
3417 @opindex gstabs+
3418 Produce debugging information in stabs format (if that is supported),
3419 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3420 use of these extensions is likely to make other debuggers crash or
3421 refuse to read the program.
3423 @item -gcoff
3424 @opindex gcoff
3425 Produce debugging information in COFF format (if that is supported).
3426 This is the format used by SDB on most System V systems prior to
3427 System V Release 4.
3429 @item -gxcoff
3430 @opindex gxcoff
3431 Produce debugging information in XCOFF format (if that is supported).
3432 This is the format used by the DBX debugger on IBM RS/6000 systems.
3434 @item -gxcoff+
3435 @opindex gxcoff+
3436 Produce debugging information in XCOFF format (if that is supported),
3437 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3438 use of these extensions is likely to make other debuggers crash or
3439 refuse to read the program, and may cause assemblers other than the GNU
3440 assembler (GAS) to fail with an error.
3442 @item -gdwarf-2
3443 @opindex gdwarf-2
3444 Produce debugging information in DWARF version 2 format (if that is
3445 supported).  This is the format used by DBX on IRIX 6.  With this
3446 option, GCC uses features of DWARF version 3 when they are useful;
3447 version 3 is upward compatible with version 2, but may still cause
3448 problems for older debuggers.
3450 @item -gvms
3451 @opindex gvms
3452 Produce debugging information in VMS debug format (if that is
3453 supported).  This is the format used by DEBUG on VMS systems.
3455 @item -g@var{level}
3456 @itemx -ggdb@var{level}
3457 @itemx -gstabs@var{level}
3458 @itemx -gcoff@var{level}
3459 @itemx -gxcoff@var{level}
3460 @itemx -gvms@var{level}
3461 Request debugging information and also use @var{level} to specify how
3462 much information.  The default level is 2.
3464 Level 1 produces minimal information, enough for making backtraces in
3465 parts of the program that you don't plan to debug.  This includes
3466 descriptions of functions and external variables, but no information
3467 about local variables and no line numbers.
3469 Level 3 includes extra information, such as all the macro definitions
3470 present in the program.  Some debuggers support macro expansion when
3471 you use @option{-g3}.
3473 @option{-gdwarf-2} does not accept a concatenated debug level, because
3474 GCC used to support an option @option{-gdwarf} that meant to generate
3475 debug information in version 1 of the DWARF format (which is very
3476 different from version 2), and it would have been too confusing.  That
3477 debug format is long obsolete, but the option cannot be changed now.
3478 Instead use an additional @option{-g@var{level}} option to change the
3479 debug level for DWARF2.
3481 @item -feliminate-dwarf2-dups
3482 @opindex feliminate-dwarf2-dups
3483 Compress DWARF2 debugging information by eliminating duplicated
3484 information about each symbol.  This option only makes sense when
3485 generating DWARF2 debugging information with @option{-gdwarf-2}.
3487 @cindex @command{prof}
3488 @item -p
3489 @opindex p
3490 Generate extra code to write profile information suitable for the
3491 analysis program @command{prof}.  You must use this option when compiling
3492 the source files you want data about, and you must also use it when
3493 linking.
3495 @cindex @command{gprof}
3496 @item -pg
3497 @opindex pg
3498 Generate extra code to write profile information suitable for the
3499 analysis program @command{gprof}.  You must use this option when compiling
3500 the source files you want data about, and you must also use it when
3501 linking.
3503 @item -Q
3504 @opindex Q
3505 Makes the compiler print out each function name as it is compiled, and
3506 print some statistics about each pass when it finishes.
3508 @item -ftime-report
3509 @opindex ftime-report
3510 Makes the compiler print some statistics about the time consumed by each
3511 pass when it finishes.
3513 @item -fmem-report
3514 @opindex fmem-report
3515 Makes the compiler print some statistics about permanent memory
3516 allocation when it finishes.
3518 @item -fprofile-arcs
3519 @opindex fprofile-arcs
3520 Add code so that program flow @dfn{arcs} are instrumented.  During
3521 execution the program records how many times each branch and call is
3522 executed and how many times it is taken or returns.  When the compiled
3523 program exits it saves this data to a file called
3524 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3525 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3526 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3527 @var{auxname} is generated from the name of the output file, if
3528 explicitly specified and it is not the final executable, otherwise it is
3529 the basename of the source file.  In both cases any suffix is removed
3530 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3531 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3532 @xref{Cross-profiling}.
3534 @cindex @command{gcov}
3535 @item --coverage
3536 @opindex coverage
3538 This option is used to compile and link code instrumented for coverage
3539 analysis.  The option is a synonym for @option{-fprofile-arcs}
3540 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3541 linking).  See the documentation for those options for more details.
3543 @itemize
3545 @item
3546 Compile the source files with @option{-fprofile-arcs} plus optimization
3547 and code generation options.  For test coverage analysis, use the
3548 additional @option{-ftest-coverage} option.  You do not need to profile
3549 every source file in a program.
3551 @item
3552 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3553 (the latter implies the former).
3555 @item
3556 Run the program on a representative workload to generate the arc profile
3557 information.  This may be repeated any number of times.  You can run
3558 concurrent instances of your program, and provided that the file system
3559 supports locking, the data files will be correctly updated.  Also
3560 @code{fork} calls are detected and correctly handled (double counting
3561 will not happen).
3563 @item
3564 For profile-directed optimizations, compile the source files again with
3565 the same optimization and code generation options plus
3566 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3567 Control Optimization}).
3569 @item
3570 For test coverage analysis, use @command{gcov} to produce human readable
3571 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3572 @command{gcov} documentation for further information.
3574 @end itemize
3576 With @option{-fprofile-arcs}, for each function of your program GCC
3577 creates a program flow graph, then finds a spanning tree for the graph.
3578 Only arcs that are not on the spanning tree have to be instrumented: the
3579 compiler adds code to count the number of times that these arcs are
3580 executed.  When an arc is the only exit or only entrance to a block, the
3581 instrumentation code can be added to the block; otherwise, a new basic
3582 block must be created to hold the instrumentation code.
3584 @need 2000
3585 @item -ftest-coverage
3586 @opindex ftest-coverage
3587 Produce a notes file that the @command{gcov} code-coverage utility
3588 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3589 show program coverage.  Each source file's note file is called
3590 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3591 above for a description of @var{auxname} and instructions on how to
3592 generate test coverage data.  Coverage data will match the source files
3593 more closely, if you do not optimize.
3595 @item -d@var{letters}
3596 @item -fdump-rtl-@var{pass}
3597 @opindex d
3598 Says to make debugging dumps during compilation at times specified by
3599 @var{letters}.    This is used for debugging the RTL-based passes of the
3600 compiler.  The file names for most of the dumps are made by appending a
3601 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3602 from the name of the output file, if explicitly specified and it is not
3603 an executable, otherwise it is the basename of the source file.
3605 Most debug dumps can be enabled either passing a letter to the @option{-d}
3606 option, or with a long @option{-fdump-rtl} switch; here are the possible
3607 letters for use in @var{letters} and @var{pass}, and their meanings:
3609 @table @gcctabopt
3610 @item -dA
3611 @opindex dA
3612 Annotate the assembler output with miscellaneous debugging information.
3614 @item -db
3615 @itemx -fdump-rtl-bp
3616 @opindex db
3617 @opindex fdump-rtl-bp
3618 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3620 @item -dB
3621 @itemx -fdump-rtl-bbro
3622 @opindex dB
3623 @opindex fdump-rtl-bbro
3624 Dump after block reordering, to @file{@var{file}.30.bbro}.
3626 @item -dc
3627 @itemx -fdump-rtl-combine
3628 @opindex dc
3629 @opindex fdump-rtl-combine
3630 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3632 @item -dC
3633 @itemx -fdump-rtl-ce1
3634 @itemx -fdump-rtl-ce2
3635 @opindex dC
3636 @opindex fdump-rtl-ce1
3637 @opindex fdump-rtl-ce2
3638 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3639 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3640 and @option{-fdump-rtl-ce2} enable dumping after the second if
3641 conversion, to the file @file{@var{file}.18.ce2}.
3643 @item -dd
3644 @itemx -fdump-rtl-btl
3645 @itemx -fdump-rtl-dbr
3646 @opindex dd
3647 @opindex fdump-rtl-btl
3648 @opindex fdump-rtl-dbr
3649 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3650 target load optimization, to @file{@var{file}.31.btl}.  @option{-dd}
3651 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3652 scheduling, to @file{@var{file}.36.dbr}.
3654 @item -dD
3655 @opindex dD
3656 Dump all macro definitions, at the end of preprocessing, in addition to
3657 normal output.
3659 @item -dE
3660 @itemx -fdump-rtl-ce3
3661 @opindex dE
3662 @opindex fdump-rtl-ce3
3663 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3665 @item -df
3666 @itemx -fdump-rtl-cfg
3667 @itemx -fdump-rtl-life
3668 @opindex df
3669 @opindex fdump-rtl-cfg
3670 @opindex fdump-rtl-life
3671 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3672 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3673 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3674 to @file{@var{file}.16.life}.
3676 @item -dg
3677 @itemx -fdump-rtl-greg
3678 @opindex dg
3679 @opindex fdump-rtl-greg
3680 Dump after global register allocation, to @file{@var{file}.23.greg}.
3682 @item -dG
3683 @itemx -fdump-rtl-gcse
3684 @itemx -fdump-rtl-bypass
3685 @opindex dG
3686 @opindex fdump-rtl-gcse
3687 @opindex fdump-rtl-bypass
3688 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3689 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3690 enable dumping after jump bypassing and control flow optimizations, to
3691 @file{@var{file}.07.bypass}.
3693 @item -dh
3694 @itemx -fdump-rtl-eh
3695 @opindex dh
3696 @opindex fdump-rtl-eh
3697 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3699 @item -di
3700 @itemx -fdump-rtl-sibling
3701 @opindex di
3702 @opindex fdump-rtl-sibling
3703 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3705 @item -dj
3706 @itemx -fdump-rtl-jump
3707 @opindex dj
3708 @opindex fdump-rtl-jump
3709 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3711 @item -dk
3712 @itemx -fdump-rtl-stack
3713 @opindex dk
3714 @opindex fdump-rtl-stack
3715 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3717 @item -dl
3718 @itemx -fdump-rtl-lreg
3719 @opindex dl
3720 @opindex fdump-rtl-lreg
3721 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3723 @item -dL
3724 @itemx -fdump-rtl-loop
3725 @itemx -fdump-rtl-loop2
3726 @opindex dL
3727 @opindex fdump-rtl-loop
3728 @opindex fdump-rtl-loop2
3729 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3730 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3731 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3732 @file{@var{file}.13.loop2}.
3734 @item -dm
3735 @itemx -fdump-rtl-sms
3736 @opindex dm
3737 @opindex fdump-rtl-sms
3738 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3740 @item -dM
3741 @itemx -fdump-rtl-mach
3742 @opindex dM
3743 @opindex fdump-rtl-mach
3744 Dump after performing the machine dependent reorganization pass, to
3745 @file{@var{file}.35.mach}.
3747 @item -dn
3748 @itemx -fdump-rtl-rnreg
3749 @opindex dn
3750 @opindex fdump-rtl-rnreg
3751 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3753 @item -dN
3754 @itemx -fdump-rtl-regmove
3755 @opindex dN
3756 @opindex fdump-rtl-regmove
3757 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3759 @item -do
3760 @itemx -fdump-rtl-postreload
3761 @opindex do
3762 @opindex fdump-rtl-postreload
3763 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3765 @item -dr
3766 @itemx -fdump-rtl-expand
3767 @opindex dr
3768 @opindex fdump-rtl-expand
3769 Dump after RTL generation, to @file{@var{file}.00.expand}.
3771 @item -dR
3772 @itemx -fdump-rtl-sched2
3773 @opindex dR
3774 @opindex fdump-rtl-sched2
3775 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3777 @item -ds
3778 @itemx -fdump-rtl-cse
3779 @opindex ds
3780 @opindex fdump-rtl-cse
3781 Dump after CSE (including the jump optimization that sometimes follows
3782 CSE), to @file{@var{file}.04.cse}.
3784 @item -dS
3785 @itemx -fdump-rtl-sched
3786 @opindex dS
3787 @opindex fdump-rtl-sched
3788 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3790 @item -dt
3791 @itemx -fdump-rtl-cse2
3792 @opindex dt
3793 @opindex fdump-rtl-cse2
3794 Dump after the second CSE pass (including the jump optimization that
3795 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3797 @item -dT
3798 @itemx -fdump-rtl-tracer
3799 @opindex dT
3800 @opindex fdump-rtl-tracer
3801 Dump after running tracer, to @file{@var{file}.12.tracer}.
3803 @item -dV
3804 @itemx -fdump-rtl-vpt
3805 @itemx -fdump-rtl-vartrack
3806 @opindex dV
3807 @opindex fdump-rtl-vpt
3808 @opindex fdump-rtl-vartrack
3809 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3810 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3811 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3812 to @file{@var{file}.34.vartrack}.
3814 @item -dw
3815 @itemx -fdump-rtl-flow2
3816 @opindex dw
3817 @opindex fdump-rtl-flow2
3818 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3820 @item -dz
3821 @itemx -fdump-rtl-peephole2
3822 @opindex dz
3823 @opindex fdump-rtl-peephole2
3824 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3826 @item -dZ
3827 @itemx -fdump-rtl-web
3828 @opindex dZ
3829 @opindex fdump-rtl-web
3830 Dump after live range splitting, to @file{@var{file}.14.web}.
3832 @item -da
3833 @itemx -fdump-rtl-all
3834 @opindex da
3835 @opindex fdump-rtl-all
3836 Produce all the dumps listed above.
3838 @item -dH
3839 @opindex dH
3840 Produce a core dump whenever an error occurs.
3842 @item -dm
3843 @opindex dm
3844 Print statistics on memory usage, at the end of the run, to
3845 standard error.
3847 @item -dp
3848 @opindex dp
3849 Annotate the assembler output with a comment indicating which
3850 pattern and alternative was used.  The length of each instruction is
3851 also printed.
3853 @item -dP
3854 @opindex dP
3855 Dump the RTL in the assembler output as a comment before each instruction.
3856 Also turns on @option{-dp} annotation.
3858 @item -dv
3859 @opindex dv
3860 For each of the other indicated dump files (either with @option{-d} or
3861 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3862 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3864 @item -dx
3865 @opindex dx
3866 Just generate RTL for a function instead of compiling it.  Usually used
3867 with @samp{r} (@option{-fdump-rtl-expand}).
3869 @item -dy
3870 @opindex dy
3871 Dump debugging information during parsing, to standard error.
3872 @end table
3874 @item -fdump-unnumbered
3875 @opindex fdump-unnumbered
3876 When doing debugging dumps (see @option{-d} option above), suppress instruction
3877 numbers and line number note output.  This makes it more feasible to
3878 use diff on debugging dumps for compiler invocations with different
3879 options, in particular with and without @option{-g}.
3881 @item -fdump-translation-unit @r{(C++ only)}
3882 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3883 @opindex fdump-translation-unit
3884 Dump a representation of the tree structure for the entire translation
3885 unit to a file.  The file name is made by appending @file{.tu} to the
3886 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3887 controls the details of the dump as described for the
3888 @option{-fdump-tree} options.
3890 @item -fdump-class-hierarchy @r{(C++ only)}
3891 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3892 @opindex fdump-class-hierarchy
3893 Dump a representation of each class's hierarchy and virtual function
3894 table layout to a file.  The file name is made by appending @file{.class}
3895 to the source file name.  If the @samp{-@var{options}} form is used,
3896 @var{options} controls the details of the dump as described for the
3897 @option{-fdump-tree} options.
3899 @item -fdump-ipa-@var{switch}
3900 @opindex fdump-ipa
3901 Control the dumping at various stages of inter-procedural analysis
3902 language tree to a file.  The file name is generated by appending a switch
3903 specific suffix to the source file name.  The following dumps are possible:
3905 @table @samp
3906 @item all
3907 Enables all inter-procedural analysis dumps; currently the only produced
3908 dump is the @samp{cgraph} dump.
3910 @item cgraph
3911 Dumps information about call-graph optimization, unused function removal,
3912 and inlining decisions.
3913 @end table
3915 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3916 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3917 @opindex fdump-tree
3918 Control the dumping at various stages of processing the intermediate
3919 language tree to a file.  The file name is generated by appending a switch
3920 specific suffix to the source file name.  If the @samp{-@var{options}}
3921 form is used, @var{options} is a list of @samp{-} separated options that
3922 control the details of the dump.  Not all options are applicable to all
3923 dumps, those which are not meaningful will be ignored.  The following
3924 options are available
3926 @table @samp
3927 @item address
3928 Print the address of each node.  Usually this is not meaningful as it
3929 changes according to the environment and source file.  Its primary use
3930 is for tying up a dump file with a debug environment.
3931 @item slim
3932 Inhibit dumping of members of a scope or body of a function merely
3933 because that scope has been reached.  Only dump such items when they
3934 are directly reachable by some other path.  When dumping pretty-printed
3935 trees, this option inhibits dumping the bodies of control structures.
3936 @item raw
3937 Print a raw representation of the tree.  By default, trees are
3938 pretty-printed into a C-like representation.
3939 @item details
3940 Enable more detailed dumps (not honored by every dump option).
3941 @item stats
3942 Enable dumping various statistics about the pass (not honored by every dump
3943 option).
3944 @item blocks
3945 Enable showing basic block boundaries (disabled in raw dumps).
3946 @item vops
3947 Enable showing virtual operands for every statement.
3948 @item lineno
3949 Enable showing line numbers for statements.
3950 @item uid
3951 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3952 @item all
3953 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3954 @end table
3956 The following tree dumps are possible:
3957 @table @samp
3959 @item original
3960 Dump before any tree based optimization, to @file{@var{file}.original}.
3962 @item optimized
3963 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3965 @item inlined
3966 Dump after function inlining, to @file{@var{file}.inlined}.
3968 @item gimple
3969 @opindex fdump-tree-gimple
3970 Dump each function before and after the gimplification pass to a file.  The
3971 file name is made by appending @file{.gimple} to the source file name.
3973 @item cfg
3974 @opindex fdump-tree-cfg
3975 Dump the control flow graph of each function to a file.  The file name is
3976 made by appending @file{.cfg} to the source file name.
3978 @item vcg
3979 @opindex fdump-tree-vcg
3980 Dump the control flow graph of each function to a file in VCG format.  The
3981 file name is made by appending @file{.vcg} to the source file name.  Note
3982 that if the file contains more than one function, the generated file cannot
3983 be used directly by VCG@.  You will need to cut and paste each function's
3984 graph into its own separate file first.
3986 @item ch
3987 @opindex fdump-tree-ch
3988 Dump each function after copying loop headers.  The file name is made by
3989 appending @file{.ch} to the source file name.
3991 @item ssa
3992 @opindex fdump-tree-ssa
3993 Dump SSA related information to a file.  The file name is made by appending
3994 @file{.ssa} to the source file name.
3996 @item salias
3997 @opindex fdump-tree-salias
3998 Dump structure aliasing variable information to a file.  This file name
3999 is made by appending @file{.salias} to the source file name.
4001 @item alias
4002 @opindex fdump-tree-alias
4003 Dump aliasing information for each function.  The file name is made by
4004 appending @file{.alias} to the source file name.
4006 @item ccp
4007 @opindex fdump-tree-ccp
4008 Dump each function after CCP@.  The file name is made by appending
4009 @file{.ccp} to the source file name.
4011 @item storeccp
4012 @opindex fdump-tree-storeccp
4013 Dump each function after STORE-CCP.  The file name is made by appending
4014 @file{.storeccp} to the source file name.
4016 @item pre
4017 @opindex fdump-tree-pre
4018 Dump trees after partial redundancy elimination.  The file name is made
4019 by appending @file{.pre} to the source file name.
4021 @item fre
4022 @opindex fdump-tree-fre
4023 Dump trees after full redundancy elimination.  The file name is made
4024 by appending @file{.fre} to the source file name.
4026 @item copyprop
4027 @opindex fdump-tree-copyprop
4028 Dump trees after copy propagation.  The file name is made
4029 by appending @file{.copyprop} to the source file name.
4031 @item store_copyprop
4032 @opindex fdump-tree-store_copyprop
4033 Dump trees after store copy-propagation.  The file name is made
4034 by appending @file{.store_copyprop} to the source file name.
4036 @item dce
4037 @opindex fdump-tree-dce
4038 Dump each function after dead code elimination.  The file name is made by
4039 appending @file{.dce} to the source file name.
4041 @item mudflap
4042 @opindex fdump-tree-mudflap
4043 Dump each function after adding mudflap instrumentation.  The file name is
4044 made by appending @file{.mudflap} to the source file name.
4046 @item sra
4047 @opindex fdump-tree-sra
4048 Dump each function after performing scalar replacement of aggregates.  The
4049 file name is made by appending @file{.sra} to the source file name.
4051 @item sink
4052 @opindex fdump-tree-sink
4053 Dump each function after performing code sinking.  The file name is made
4054 by appending @file{.sink} to the source file name. 
4056 @item dom
4057 @opindex fdump-tree-dom
4058 Dump each function after applying dominator tree optimizations.  The file
4059 name is made by appending @file{.dom} to the source file name.
4061 @item dse
4062 @opindex fdump-tree-dse
4063 Dump each function after applying dead store elimination.  The file
4064 name is made by appending @file{.dse} to the source file name.
4066 @item phiopt
4067 @opindex fdump-tree-phiopt
4068 Dump each function after optimizing PHI nodes into straightline code.  The file
4069 name is made by appending @file{.phiopt} to the source file name.
4071 @item forwprop
4072 @opindex fdump-tree-forwprop
4073 Dump each function after forward propagating single use variables.  The file
4074 name is made by appending @file{.forwprop} to the source file name.
4076 @item copyrename
4077 @opindex fdump-tree-copyrename
4078 Dump each function after applying the copy rename optimization.  The file
4079 name is made by appending @file{.copyrename} to the source file name.
4081 @item nrv
4082 @opindex fdump-tree-nrv
4083 Dump each function after applying the named return value optimization on
4084 generic trees.  The file name is made by appending @file{.nrv} to the source
4085 file name.
4087 @item vect
4088 @opindex fdump-tree-vect
4089 Dump each function after applying vectorization of loops.  The file name is
4090 made by appending @file{.vect} to the source file name.
4092 @item vrp
4093 @opindex fdump-tree-vrp
4094 Dump each function after Value Range Propagation (VRP).  The file name
4095 is made by appending @file{.vrp} to the source file name.
4097 @item all
4098 @opindex fdump-tree-all
4099 Enable all the available tree dumps with the flags provided in this option.
4100 @end table
4102 @item -ftree-vectorizer-verbose=@var{n}
4103 @opindex ftree-vectorizer-verbose
4104 This option controls the amount of debugging output the vectorizer prints.
4105 This information is written to standard error, unless @option{-fdump-tree-all}
4106 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4107 usual dump listing file, @file{.vect}.
4109 @item -frandom-seed=@var{string}
4110 @opindex frandom-string
4111 This option provides a seed that GCC uses when it would otherwise use
4112 random numbers.  It is used to generate certain symbol names
4113 that have to be different in every compiled file.  It is also used to
4114 place unique stamps in coverage data files and the object files that
4115 produce them.  You can use the @option{-frandom-seed} option to produce
4116 reproducibly identical object files.
4118 The @var{string} should be different for every file you compile.
4120 @item -fsched-verbose=@var{n}
4121 @opindex fsched-verbose
4122 On targets that use instruction scheduling, this option controls the
4123 amount of debugging output the scheduler prints.  This information is
4124 written to standard error, unless @option{-dS} or @option{-dR} is
4125 specified, in which case it is output to the usual dump
4126 listing file, @file{.sched} or @file{.sched2} respectively.  However
4127 for @var{n} greater than nine, the output is always printed to standard
4128 error.
4130 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4131 same information as @option{-dRS}.  For @var{n} greater than one, it
4132 also output basic block probabilities, detailed ready list information
4133 and unit/insn info.  For @var{n} greater than two, it includes RTL
4134 at abort point, control-flow and regions info.  And for @var{n} over
4135 four, @option{-fsched-verbose} also includes dependence info.
4137 @item -save-temps
4138 @opindex save-temps
4139 Store the usual ``temporary'' intermediate files permanently; place them
4140 in the current directory and name them based on the source file.  Thus,
4141 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4142 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
4143 preprocessed @file{foo.i} output file even though the compiler now
4144 normally uses an integrated preprocessor.
4146 When used in combination with the @option{-x} command line option,
4147 @option{-save-temps} is sensible enough to avoid over writing an
4148 input source file with the same extension as an intermediate file.
4149 The corresponding intermediate file may be obtained by renaming the
4150 source file before using @option{-save-temps}.
4152 @item -time
4153 @opindex time
4154 Report the CPU time taken by each subprocess in the compilation
4155 sequence.  For C source files, this is the compiler proper and assembler
4156 (plus the linker if linking is done).  The output looks like this:
4158 @smallexample
4159 # cc1 0.12 0.01
4160 # as 0.00 0.01
4161 @end smallexample
4163 The first number on each line is the ``user time'', that is time spent
4164 executing the program itself.  The second number is ``system time'',
4165 time spent executing operating system routines on behalf of the program.
4166 Both numbers are in seconds.
4168 @item -fvar-tracking
4169 @opindex fvar-tracking
4170 Run variable tracking pass.  It computes where variables are stored at each
4171 position in code.  Better debugging information is then generated
4172 (if the debugging information format supports this information).
4174 It is enabled by default when compiling with optimization (@option{-Os},
4175 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4176 the debug info format supports it.
4178 @item -print-file-name=@var{library}
4179 @opindex print-file-name
4180 Print the full absolute name of the library file @var{library} that
4181 would be used when linking---and don't do anything else.  With this
4182 option, GCC does not compile or link anything; it just prints the
4183 file name.
4185 @item -print-multi-directory
4186 @opindex print-multi-directory
4187 Print the directory name corresponding to the multilib selected by any
4188 other switches present in the command line.  This directory is supposed
4189 to exist in @env{GCC_EXEC_PREFIX}.
4191 @item -print-multi-lib
4192 @opindex print-multi-lib
4193 Print the mapping from multilib directory names to compiler switches
4194 that enable them.  The directory name is separated from the switches by
4195 @samp{;}, and each switch starts with an @samp{@@} instead of the
4196 @samp{-}, without spaces between multiple switches.  This is supposed to
4197 ease shell-processing.
4199 @item -print-prog-name=@var{program}
4200 @opindex print-prog-name
4201 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4203 @item -print-libgcc-file-name
4204 @opindex print-libgcc-file-name
4205 Same as @option{-print-file-name=libgcc.a}.
4207 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4208 but you do want to link with @file{libgcc.a}.  You can do
4210 @smallexample
4211 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4212 @end smallexample
4214 @item -print-search-dirs
4215 @opindex print-search-dirs
4216 Print the name of the configured installation directory and a list of
4217 program and library directories @command{gcc} will search---and don't do anything else.
4219 This is useful when @command{gcc} prints the error message
4220 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4221 To resolve this you either need to put @file{cpp0} and the other compiler
4222 components where @command{gcc} expects to find them, or you can set the environment
4223 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4224 Don't forget the trailing @samp{/}.
4225 @xref{Environment Variables}.
4227 @item -dumpmachine
4228 @opindex dumpmachine
4229 Print the compiler's target machine (for example,
4230 @samp{i686-pc-linux-gnu})---and don't do anything else.
4232 @item -dumpversion
4233 @opindex dumpversion
4234 Print the compiler version (for example, @samp{3.0})---and don't do
4235 anything else.
4237 @item -dumpspecs
4238 @opindex dumpspecs
4239 Print the compiler's built-in specs---and don't do anything else.  (This
4240 is used when GCC itself is being built.)  @xref{Spec Files}.
4242 @item -feliminate-unused-debug-types
4243 @opindex feliminate-unused-debug-types
4244 Normally, when producing DWARF2 output, GCC will emit debugging
4245 information for all types declared in a compilation
4246 unit, regardless of whether or not they are actually used
4247 in that compilation unit.  Sometimes this is useful, such as
4248 if, in the debugger, you want to cast a value to a type that is
4249 not actually used in your program (but is declared).  More often,
4250 however, this results in a significant amount of wasted space.
4251 With this option, GCC will avoid producing debug symbol output
4252 for types that are nowhere used in the source file being compiled.
4253 @end table
4255 @node Optimize Options
4256 @section Options That Control Optimization
4257 @cindex optimize options
4258 @cindex options, optimization
4260 These options control various sorts of optimizations.
4262 Without any optimization option, the compiler's goal is to reduce the
4263 cost of compilation and to make debugging produce the expected
4264 results.  Statements are independent: if you stop the program with a
4265 breakpoint between statements, you can then assign a new value to any
4266 variable or change the program counter to any other statement in the
4267 function and get exactly the results you would expect from the source
4268 code.
4270 Turning on optimization flags makes the compiler attempt to improve
4271 the performance and/or code size at the expense of compilation time
4272 and possibly the ability to debug the program.
4274 The compiler performs optimization based on the knowledge it has of
4275 the program.  Optimization levels @option{-O2} and above, in
4276 particular, enable @emph{unit-at-a-time} mode, which allows the
4277 compiler to consider information gained from later functions in
4278 the file when compiling a function.  Compiling multiple files at
4279 once to a single output file in @emph{unit-at-a-time} mode allows
4280 the compiler to use information gained from all of the files when
4281 compiling each of them.
4283 Not all optimizations are controlled directly by a flag.  Only
4284 optimizations that have a flag are listed.
4286 @table @gcctabopt
4287 @item -O
4288 @itemx -O1
4289 @opindex O
4290 @opindex O1
4291 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4292 more memory for a large function.
4294 With @option{-O}, the compiler tries to reduce code size and execution
4295 time, without performing any optimizations that take a great deal of
4296 compilation time.
4298 @option{-O} turns on the following optimization flags:
4299 @gccoptlist{-fdefer-pop @gol
4300 -fdelayed-branch @gol
4301 -fguess-branch-probability @gol
4302 -fcprop-registers @gol
4303 -floop-optimize @gol
4304 -fif-conversion @gol
4305 -fif-conversion2 @gol
4306 -ftree-ccp @gol
4307 -ftree-dce @gol
4308 -ftree-dominator-opts @gol
4309 -ftree-dse @gol
4310 -ftree-ter @gol
4311 -ftree-lrs @gol
4312 -ftree-sra @gol
4313 -ftree-copyrename @gol
4314 -ftree-fre @gol
4315 -ftree-ch @gol
4316 -fmerge-constants}
4318 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4319 where doing so does not interfere with debugging.
4321 @item -O2
4322 @opindex O2
4323 Optimize even more.  GCC performs nearly all supported optimizations
4324 that do not involve a space-speed tradeoff.  The compiler does not
4325 perform loop unrolling or function inlining when you specify @option{-O2}.
4326 As compared to @option{-O}, this option increases both compilation time
4327 and the performance of the generated code.
4329 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4330 also turns on the following optimization flags:
4331 @gccoptlist{-fthread-jumps @gol
4332 -fcrossjumping @gol
4333 -foptimize-sibling-calls @gol
4334 -fcse-follow-jumps  -fcse-skip-blocks @gol
4335 -fgcse  -fgcse-lm  @gol
4336 -fexpensive-optimizations @gol
4337 -fstrength-reduce @gol
4338 -frerun-cse-after-loop  -frerun-loop-opt @gol
4339 -fcaller-saves @gol
4340 -fpeephole2 @gol
4341 -fschedule-insns  -fschedule-insns2 @gol
4342 -fsched-interblock  -fsched-spec @gol
4343 -fregmove @gol
4344 -fstrict-aliasing @gol
4345 -fdelete-null-pointer-checks @gol
4346 -freorder-blocks  -freorder-functions @gol
4347 -funit-at-a-time @gol
4348 -falign-functions  -falign-jumps @gol
4349 -falign-loops  -falign-labels @gol
4350 -ftree-vrp @gol
4351 -ftree-pre}
4353 Please note the warning under @option{-fgcse} about
4354 invoking @option{-O2} on programs that use computed gotos.
4356 @item -O3
4357 @opindex O3
4358 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4359 @option{-O2} and also turns on the @option{-finline-functions},
4360 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4362 @item -O0
4363 @opindex O0
4364 Do not optimize.  This is the default.
4366 @item -Os
4367 @opindex Os
4368 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4369 do not typically increase code size.  It also performs further
4370 optimizations designed to reduce code size.
4372 @option{-Os} disables the following optimization flags:
4373 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4374 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4376 If you use multiple @option{-O} options, with or without level numbers,
4377 the last such option is the one that is effective.
4378 @end table
4380 Options of the form @option{-f@var{flag}} specify machine-independent
4381 flags.  Most flags have both positive and negative forms; the negative
4382 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4383 below, only one of the forms is listed---the one you typically will
4384 use.  You can figure out the other form by either removing @samp{no-}
4385 or adding it.
4387 The following options control specific optimizations.  They are either
4388 activated by @option{-O} options or are related to ones that are.  You
4389 can use the following flags in the rare cases when ``fine-tuning'' of
4390 optimizations to be performed is desired.
4392 @table @gcctabopt
4393 @item -fno-default-inline
4394 @opindex fno-default-inline
4395 Do not make member functions inline by default merely because they are
4396 defined inside the class scope (C++ only).  Otherwise, when you specify
4397 @w{@option{-O}}, member functions defined inside class scope are compiled
4398 inline by default; i.e., you don't need to add @samp{inline} in front of
4399 the member function name.
4401 @item -fno-defer-pop
4402 @opindex fno-defer-pop
4403 Always pop the arguments to each function call as soon as that function
4404 returns.  For machines which must pop arguments after a function call,
4405 the compiler normally lets arguments accumulate on the stack for several
4406 function calls and pops them all at once.
4408 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4410 @item -fforce-mem
4411 @opindex fforce-mem
4412 Force memory operands to be copied into registers before doing
4413 arithmetic on them.  This produces better code by making all memory
4414 references potential common subexpressions.  When they are not common
4415 subexpressions, instruction combination should eliminate the separate
4416 register-load. This option is now a nop and will be removed in 4.2.
4418 @item -fforce-addr
4419 @opindex fforce-addr
4420 Force memory address constants to be copied into registers before
4421 doing arithmetic on them.
4423 @item -fomit-frame-pointer
4424 @opindex fomit-frame-pointer
4425 Don't keep the frame pointer in a register for functions that
4426 don't need one.  This avoids the instructions to save, set up and
4427 restore frame pointers; it also makes an extra register available
4428 in many functions.  @strong{It also makes debugging impossible on
4429 some machines.}
4431 On some machines, such as the VAX, this flag has no effect, because
4432 the standard calling sequence automatically handles the frame pointer
4433 and nothing is saved by pretending it doesn't exist.  The
4434 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4435 whether a target machine supports this flag.  @xref{Registers,,Register
4436 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4438 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4440 @item -foptimize-sibling-calls
4441 @opindex foptimize-sibling-calls
4442 Optimize sibling and tail recursive calls.
4444 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4446 @item -fno-inline
4447 @opindex fno-inline
4448 Don't pay attention to the @code{inline} keyword.  Normally this option
4449 is used to keep the compiler from expanding any functions inline.
4450 Note that if you are not optimizing, no functions can be expanded inline.
4452 @item -finline-functions
4453 @opindex finline-functions
4454 Integrate all simple functions into their callers.  The compiler
4455 heuristically decides which functions are simple enough to be worth
4456 integrating in this way.
4458 If all calls to a given function are integrated, and the function is
4459 declared @code{static}, then the function is normally not output as
4460 assembler code in its own right.
4462 Enabled at level @option{-O3}.
4464 @item -fearly-inlining
4465 @opindex fearly-inlining
4466 Inline functions marked by @code{always_inline} and functions whose body seems
4467 smaller than the function call overhead early before doing
4468 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
4469 makes profiling significantly cheaper and usually inlining faster on programs
4470 having large chains of nested wrapper functions.
4472 Enabled by default.
4474 @item -finline-limit=@var{n}
4475 @opindex finline-limit
4476 By default, GCC limits the size of functions that can be inlined.  This flag
4477 allows the control of this limit for functions that are explicitly marked as
4478 inline (i.e., marked with the inline keyword or defined within the class
4479 definition in c++).  @var{n} is the size of functions that can be inlined in
4480 number of pseudo instructions (not counting parameter handling).  The default
4481 value of @var{n} is 600.
4482 Increasing this value can result in more inlined code at
4483 the cost of compilation time and memory consumption.  Decreasing usually makes
4484 the compilation faster and less code will be inlined (which presumably
4485 means slower programs).  This option is particularly useful for programs that
4486 use inlining heavily such as those based on recursive templates with C++.
4488 Inlining is actually controlled by a number of parameters, which may be
4489 specified individually by using @option{--param @var{name}=@var{value}}.
4490 The @option{-finline-limit=@var{n}} option sets some of these parameters
4491 as follows:
4493 @table @gcctabopt
4494  @item max-inline-insns-single
4495   is set to @var{n}/2.
4496  @item max-inline-insns-auto
4497   is set to @var{n}/2.
4498  @item min-inline-insns
4499   is set to 130 or @var{n}/4, whichever is smaller.
4500  @item max-inline-insns-rtl
4501   is set to @var{n}.
4502 @end table
4504 See below for a documentation of the individual
4505 parameters controlling inlining.
4507 @emph{Note:} pseudo instruction represents, in this particular context, an
4508 abstract measurement of function's size.  In no way does it represent a count
4509 of assembly instructions and as such its exact meaning might change from one
4510 release to an another.
4512 @item -fkeep-inline-functions
4513 @opindex fkeep-inline-functions
4514 In C, emit @code{static} functions that are declared @code{inline}
4515 into the object file, even if the function has been inlined into all
4516 of its callers.  This switch does not affect functions using the
4517 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4518 inline functions into the object file.
4520 @item -fkeep-static-consts
4521 @opindex fkeep-static-consts
4522 Emit variables declared @code{static const} when optimization isn't turned
4523 on, even if the variables aren't referenced.
4525 GCC enables this option by default.  If you want to force the compiler to
4526 check if the variable was referenced, regardless of whether or not
4527 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4529 @item -fmerge-constants
4530 Attempt to merge identical constants (string constants and floating point
4531 constants) across compilation units.
4533 This option is the default for optimized compilation if the assembler and
4534 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4535 behavior.
4537 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4539 @item -fmerge-all-constants
4540 Attempt to merge identical constants and identical variables.
4542 This option implies @option{-fmerge-constants}.  In addition to
4543 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4544 arrays or initialized constant variables with integral or floating point
4545 types.  Languages like C or C++ require each non-automatic variable to
4546 have distinct location, so using this option will result in non-conforming
4547 behavior.
4549 @item -fmodulo-sched
4550 @opindex fmodulo-sched
4551 Perform swing modulo scheduling immediately before the first scheduling
4552 pass.  This pass looks at innermost loops and reorders their
4553 instructions by overlapping different iterations.
4555 @item -fno-branch-count-reg
4556 @opindex fno-branch-count-reg
4557 Do not use ``decrement and branch'' instructions on a count register,
4558 but instead generate a sequence of instructions that decrement a
4559 register, compare it against zero, then branch based upon the result.
4560 This option is only meaningful on architectures that support such
4561 instructions, which include x86, PowerPC, IA-64 and S/390.
4563 The default is @option{-fbranch-count-reg}, enabled when
4564 @option{-fstrength-reduce} is enabled.
4566 @item -fno-function-cse
4567 @opindex fno-function-cse
4568 Do not put function addresses in registers; make each instruction that
4569 calls a constant function contain the function's address explicitly.
4571 This option results in less efficient code, but some strange hacks
4572 that alter the assembler output may be confused by the optimizations
4573 performed when this option is not used.
4575 The default is @option{-ffunction-cse}
4577 @item -fno-zero-initialized-in-bss
4578 @opindex fno-zero-initialized-in-bss
4579 If the target supports a BSS section, GCC by default puts variables that
4580 are initialized to zero into BSS@.  This can save space in the resulting
4581 code.
4583 This option turns off this behavior because some programs explicitly
4584 rely on variables going to the data section.  E.g., so that the
4585 resulting executable can find the beginning of that section and/or make
4586 assumptions based on that.
4588 The default is @option{-fzero-initialized-in-bss}.
4590 @item -fbounds-check
4591 @opindex fbounds-check
4592 For front-ends that support it, generate additional code to check that
4593 indices used to access arrays are within the declared range.  This is
4594 currently only supported by the Java and Fortran front-ends, where
4595 this option defaults to true and false respectively.
4597 @item -fmudflap -fmudflapth -fmudflapir
4598 @opindex fmudflap
4599 @opindex fmudflapth
4600 @opindex fmudflapir
4601 @cindex bounds checking
4602 @cindex mudflap
4603 For front-ends that support it (C and C++), instrument all risky
4604 pointer/array dereferencing operations, some standard library
4605 string/heap functions, and some other associated constructs with
4606 range/validity tests.  Modules so instrumented should be immune to
4607 buffer overflows, invalid heap use, and some other classes of C/C++
4608 programming errors.  The instrumentation relies on a separate runtime
4609 library (@file{libmudflap}), which will be linked into a program if
4610 @option{-fmudflap} is given at link time.  Run-time behavior of the
4611 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4612 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4613 for its options.
4615 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4616 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4617 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4618 instrumentation should ignore pointer reads.  This produces less
4619 instrumentation (and therefore faster execution) and still provides
4620 some protection against outright memory corrupting writes, but allows
4621 erroneously read data to propagate within a program.
4623 @item -fstrength-reduce
4624 @opindex fstrength-reduce
4625 Perform the optimizations of loop strength reduction and
4626 elimination of iteration variables.
4628 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4630 @item -fthread-jumps
4631 @opindex fthread-jumps
4632 Perform optimizations where we check to see if a jump branches to a
4633 location where another comparison subsumed by the first is found.  If
4634 so, the first branch is redirected to either the destination of the
4635 second branch or a point immediately following it, depending on whether
4636 the condition is known to be true or false.
4638 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4640 @item -fcse-follow-jumps
4641 @opindex fcse-follow-jumps
4642 In common subexpression elimination, scan through jump instructions
4643 when the target of the jump is not reached by any other path.  For
4644 example, when CSE encounters an @code{if} statement with an
4645 @code{else} clause, CSE will follow the jump when the condition
4646 tested is false.
4648 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4650 @item -fcse-skip-blocks
4651 @opindex fcse-skip-blocks
4652 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4653 follow jumps which conditionally skip over blocks.  When CSE
4654 encounters a simple @code{if} statement with no else clause,
4655 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4656 body of the @code{if}.
4658 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4660 @item -frerun-cse-after-loop
4661 @opindex frerun-cse-after-loop
4662 Re-run common subexpression elimination after loop optimizations has been
4663 performed.
4665 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4667 @item -frerun-loop-opt
4668 @opindex frerun-loop-opt
4669 Run the loop optimizer twice.
4671 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4673 @item -fgcse
4674 @opindex fgcse
4675 Perform a global common subexpression elimination pass.
4676 This pass also performs global constant and copy propagation.
4678 @emph{Note:} When compiling a program using computed gotos, a GCC
4679 extension, you may get better runtime performance if you disable
4680 the global common subexpression elimination pass by adding
4681 @option{-fno-gcse} to the command line.
4683 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4685 @item -fgcse-lm
4686 @opindex fgcse-lm
4687 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4688 attempt to move loads which are only killed by stores into themselves.  This
4689 allows a loop containing a load/store sequence to be changed to a load outside
4690 the loop, and a copy/store within the loop.
4692 Enabled by default when gcse is enabled.
4694 @item -fgcse-sm
4695 @opindex fgcse-sm
4696 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4697 global common subexpression elimination.  This pass will attempt to move
4698 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4699 loops containing a load/store sequence can be changed to a load before
4700 the loop and a store after the loop.
4702 Not enabled at any optimization level.
4704 @item -fgcse-las
4705 @opindex fgcse-las
4706 When @option{-fgcse-las} is enabled, the global common subexpression
4707 elimination pass eliminates redundant loads that come after stores to the
4708 same memory location (both partial and full redundancies).
4710 Not enabled at any optimization level.
4712 @item -fgcse-after-reload
4713 @opindex fgcse-after-reload
4714 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4715 pass is performed after reload.  The purpose of this pass is to cleanup
4716 redundant spilling.
4718 @item -floop-optimize
4719 @opindex floop-optimize
4720 Perform loop optimizations: move constant expressions out of loops, simplify
4721 exit test conditions and optionally do strength-reduction as well.
4723 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4725 @item -floop-optimize2
4726 @opindex floop-optimize2
4727 Perform loop optimizations using the new loop optimizer.  The optimizations
4728 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4729 by separate flags.
4731 @item -funsafe-loop-optimizations
4732 @opindex funsafe-loop-optimizations
4733 If given, the loop optimizer will assume that loop indices do not
4734 overflow, and that the loops with nontrivial exit condition are not
4735 infinite.  This enables a wider range of loop optimizations even if
4736 the loop optimizer itself cannot prove that these assumptions are valid.
4737 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4738 if it finds this kind of loop.
4740 @item -fcrossjumping
4741 @opindex crossjumping
4742 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4743 resulting code may or may not perform better than without cross-jumping.
4745 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4747 @item -fif-conversion
4748 @opindex if-conversion
4749 Attempt to transform conditional jumps into branch-less equivalents.  This
4750 include use of conditional moves, min, max, set flags and abs instructions, and
4751 some tricks doable by standard arithmetics.  The use of conditional execution
4752 on chips where it is available is controlled by @code{if-conversion2}.
4754 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4756 @item -fif-conversion2
4757 @opindex if-conversion2
4758 Use conditional execution (where available) to transform conditional jumps into
4759 branch-less equivalents.
4761 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4763 @item -fdelete-null-pointer-checks
4764 @opindex fdelete-null-pointer-checks
4765 Use global dataflow analysis to identify and eliminate useless checks
4766 for null pointers.  The compiler assumes that dereferencing a null
4767 pointer would have halted the program.  If a pointer is checked after
4768 it has already been dereferenced, it cannot be null.
4770 In some environments, this assumption is not true, and programs can
4771 safely dereference null pointers.  Use
4772 @option{-fno-delete-null-pointer-checks} to disable this optimization
4773 for programs which depend on that behavior.
4775 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4777 @item -fexpensive-optimizations
4778 @opindex fexpensive-optimizations
4779 Perform a number of minor optimizations that are relatively expensive.
4781 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4783 @item -foptimize-register-move
4784 @itemx -fregmove
4785 @opindex foptimize-register-move
4786 @opindex fregmove
4787 Attempt to reassign register numbers in move instructions and as
4788 operands of other simple instructions in order to maximize the amount of
4789 register tying.  This is especially helpful on machines with two-operand
4790 instructions.
4792 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4793 optimization.
4795 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4797 @item -fdelayed-branch
4798 @opindex fdelayed-branch
4799 If supported for the target machine, attempt to reorder instructions
4800 to exploit instruction slots available after delayed branch
4801 instructions.
4803 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4805 @item -fschedule-insns
4806 @opindex fschedule-insns
4807 If supported for the target machine, attempt to reorder instructions to
4808 eliminate execution stalls due to required data being unavailable.  This
4809 helps machines that have slow floating point or memory load instructions
4810 by allowing other instructions to be issued until the result of the load
4811 or floating point instruction is required.
4813 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4815 @item -fschedule-insns2
4816 @opindex fschedule-insns2
4817 Similar to @option{-fschedule-insns}, but requests an additional pass of
4818 instruction scheduling after register allocation has been done.  This is
4819 especially useful on machines with a relatively small number of
4820 registers and where memory load instructions take more than one cycle.
4822 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4824 @item -fno-sched-interblock
4825 @opindex fno-sched-interblock
4826 Don't schedule instructions across basic blocks.  This is normally
4827 enabled by default when scheduling before register allocation, i.e.@:
4828 with @option{-fschedule-insns} or at @option{-O2} or higher.
4830 @item -fno-sched-spec
4831 @opindex fno-sched-spec
4832 Don't allow speculative motion of non-load instructions.  This is normally
4833 enabled by default when scheduling before register allocation, i.e.@:
4834 with @option{-fschedule-insns} or at @option{-O2} or higher.
4836 @item -fsched-spec-load
4837 @opindex fsched-spec-load
4838 Allow speculative motion of some load instructions.  This only makes
4839 sense when scheduling before register allocation, i.e.@: with
4840 @option{-fschedule-insns} or at @option{-O2} or higher.
4842 @item -fsched-spec-load-dangerous
4843 @opindex fsched-spec-load-dangerous
4844 Allow speculative motion of more load instructions.  This only makes
4845 sense when scheduling before register allocation, i.e.@: with
4846 @option{-fschedule-insns} or at @option{-O2} or higher.
4848 @item -fsched-stalled-insns=@var{n}
4849 @opindex fsched-stalled-insns
4850 Define how many insns (if any) can be moved prematurely from the queue
4851 of stalled insns into the ready list, during the second scheduling pass.
4853 @item -fsched-stalled-insns-dep=@var{n}
4854 @opindex fsched-stalled-insns-dep
4855 Define how many insn groups (cycles) will be examined for a dependency
4856 on a stalled insn that is candidate for premature removal from the queue
4857 of stalled insns.  Has an effect only during the second scheduling pass,
4858 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4860 @item -fsched2-use-superblocks
4861 @opindex fsched2-use-superblocks
4862 When scheduling after register allocation, do use superblock scheduling
4863 algorithm.  Superblock scheduling allows motion across basic block boundaries
4864 resulting on faster schedules.  This option is experimental, as not all machine
4865 descriptions used by GCC model the CPU closely enough to avoid unreliable
4866 results from the algorithm.
4868 This only makes sense when scheduling after register allocation, i.e.@: with
4869 @option{-fschedule-insns2} or at @option{-O2} or higher.
4871 @item -fsched2-use-traces
4872 @opindex fsched2-use-traces
4873 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4874 allocation and additionally perform code duplication in order to increase the
4875 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4876 trace formation.
4878 This mode should produce faster but significantly longer programs.  Also
4879 without @option{-fbranch-probabilities} the traces constructed may not
4880 match the reality and hurt the performance.  This only makes
4881 sense when scheduling after register allocation, i.e.@: with
4882 @option{-fschedule-insns2} or at @option{-O2} or higher.
4884 @item -freschedule-modulo-scheduled-loops
4885 @opindex fscheduling-in-modulo-scheduled-loops
4886 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4887 we may want to prevent the later scheduling passes from changing its schedule, we use this
4888 option to control that.
4890 @item -fcaller-saves
4891 @opindex fcaller-saves
4892 Enable values to be allocated in registers that will be clobbered by
4893 function calls, by emitting extra instructions to save and restore the
4894 registers around such calls.  Such allocation is done only when it
4895 seems to result in better code than would otherwise be produced.
4897 This option is always enabled by default on certain machines, usually
4898 those which have no call-preserved registers to use instead.
4900 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4902 @item -ftree-pre
4903 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4904 enabled by default at @option{-O2} and @option{-O3}.
4906 @item -ftree-fre
4907 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4908 between FRE and PRE is that FRE only considers expressions
4909 that are computed on all paths leading to the redundant computation.
4910 This analysis faster than PRE, though it exposes fewer redundancies.
4911 This flag is enabled by default at @option{-O} and higher.
4913 @item -ftree-copy-prop
4914 Perform copy propagation on trees.  This pass eliminates unnecessary
4915 copy operations.  This flag is enabled by default at @option{-O} and
4916 higher.
4918 @item -ftree-store-copy-prop
4919 Perform copy propagation of memory loads and stores.  This pass
4920 eliminates unnecessary copy operations in memory references
4921 (structures, global variables, arrays, etc).  This flag is enabled by
4922 default at @option{-O2} and higher.
4924 @item -ftree-salias
4925 Perform structural alias analysis on trees.  This flag
4926 is enabled by default at @option{-O} and higher.
4928 @item -ftree-sink
4929 Perform forward store motion  on trees.  This flag is
4930 enabled by default at @option{-O} and higher.
4932 @item -ftree-ccp
4933 Perform sparse conditional constant propagation (CCP) on trees.  This
4934 pass only operates on local scalar variables and is enabled by default
4935 at @option{-O} and higher.
4937 @item -ftree-store-ccp
4938 Perform sparse conditional constant propagation (CCP) on trees.  This
4939 pass operates on both local scalar variables and memory stores and
4940 loads (global variables, structures, arrays, etc).  This flag is
4941 enabled by default at @option{-O2} and higher.
4943 @item -ftree-dce
4944 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4945 default at @option{-O} and higher.
4947 @item -ftree-dominator-opts
4948 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4949 default at @option{-O} and higher.
4951 @item -ftree-ch
4952 Perform loop header copying on trees.  This is beneficial since it increases
4953 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4954 is enabled by default at @option{-O} and higher.  It is not enabled
4955 for @option{-Os}, since it usually increases code size.
4957 @item -ftree-loop-optimize
4958 Perform loop optimizations on trees.  This flag is enabled by default
4959 at @option{-O} and higher.
4961 @item -ftree-loop-linear
4962 Perform linear loop transformations on tree.  This flag can improve cache
4963 performance and allow further loop optimizations to take place.
4965 @item -ftree-loop-im
4966 Perform loop invariant motion on trees.  This pass moves only invariants that
4967 would be hard to handle at RTL level (function calls, operations that expand to
4968 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4969 operands of conditions that are invariant out of the loop, so that we can use
4970 just trivial invariantness analysis in loop unswitching.  The pass also includes
4971 store motion.
4973 @item -ftree-loop-ivcanon
4974 Create a canonical counter for number of iterations in the loop for that
4975 determining number of iterations requires complicated analysis.  Later
4976 optimizations then may determine the number easily.  Useful especially
4977 in connection with unrolling.
4979 @item -fivopts
4980 Perform induction variable optimizations (strength reduction, induction
4981 variable merging and induction variable elimination) on trees.
4983 @item -ftree-sra
4984 Perform scalar replacement of aggregates.  This pass replaces structure
4985 references with scalars to prevent committing structures to memory too
4986 early.  This flag is enabled by default at @option{-O} and higher.
4988 @item -ftree-copyrename
4989 Perform copy renaming on trees.  This pass attempts to rename compiler
4990 temporaries to other variables at copy locations, usually resulting in
4991 variable names which more closely resemble the original variables.  This flag
4992 is enabled by default at @option{-O} and higher.
4994 @item -ftree-ter
4995 Perform temporary expression replacement during the SSA->normal phase.  Single
4996 use/single def temporaries are replaced at their use location with their
4997 defining expression.  This results in non-GIMPLE code, but gives the expanders
4998 much more complex trees to work on resulting in better RTL generation.  This is
4999 enabled by default at @option{-O} and higher.
5001 @item -ftree-lrs
5002 Perform live range splitting during the SSA->normal phase.  Distinct live
5003 ranges of a variable are split into unique variables, allowing for better
5004 optimization later.  This is enabled by default at @option{-O} and higher.
5006 @item -ftree-vectorize
5007 Perform loop vectorization on trees.
5009 @item -ftree-vrp
5010 Perform Value Range Propagation on trees.  This is similar to the
5011 constant propagation pass, but instead of values, ranges of values are
5012 propagated.  This allows the optimizers to remove unnecessary range
5013 checks like array bound checks and null pointer checks.  This is
5014 enabled by default at @option{-O2} and higher.  Null pointer check
5015 elimination is only done if @option{-fdelete-null-pointer-checks} is
5016 enabled.
5018 @item -ftracer
5019 @opindex ftracer
5020 Perform tail duplication to enlarge superblock size.  This transformation
5021 simplifies the control flow of the function allowing other optimizations to do
5022 better job.
5024 @item -funroll-loops
5025 @opindex funroll-loops
5026 Unroll loops whose number of iterations can be determined at compile
5027 time or upon entry to the loop.  @option{-funroll-loops} implies both
5028 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5029 option makes code larger, and may or may not make it run faster.
5031 @item -funroll-all-loops
5032 @opindex funroll-all-loops
5033 Unroll all loops, even if their number of iterations is uncertain when
5034 the loop is entered.  This usually makes programs run more slowly.
5035 @option{-funroll-all-loops} implies the same options as
5036 @option{-funroll-loops},
5038 @item -fsplit-ivs-in-unroller
5039 @opindex -fsplit-ivs-in-unroller
5040 Enables expressing of values of induction variables in later iterations
5041 of the unrolled loop using the value in the first iteration.  This breaks
5042 long dependency chains, thus improving efficiency of the scheduling passes.
5044 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5045 same effect.  However in cases the loop body is more complicated than
5046 a single basic block, this is not reliable.  It also does not work at all
5047 on some of the architectures due to restrictions in the CSE pass.
5049 This optimization is enabled by default.
5051 @item -fvariable-expansion-in-unroller
5052 @opindex -fvariable-expansion-in-unroller
5053 With this option, the compiler will create multiple copies of some
5054 local variables when unrolling a loop which can result in superior code.
5056 @item -fprefetch-loop-arrays
5057 @opindex fprefetch-loop-arrays
5058 If supported by the target machine, generate instructions to prefetch
5059 memory to improve the performance of loops that access large arrays.
5061 These options may generate better or worse code; results are highly
5062 dependent on the structure of loops within the source code.
5064 @item -fno-peephole
5065 @itemx -fno-peephole2
5066 @opindex fno-peephole
5067 @opindex fno-peephole2
5068 Disable any machine-specific peephole optimizations.  The difference
5069 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5070 are implemented in the compiler; some targets use one, some use the
5071 other, a few use both.
5073 @option{-fpeephole} is enabled by default.
5074 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5076 @item -fno-guess-branch-probability
5077 @opindex fno-guess-branch-probability
5078 Do not guess branch probabilities using heuristics.
5080 GCC will use heuristics to guess branch probabilities if they are
5081 not provided by profiling feedback (@option{-fprofile-arcs}).  These
5082 heuristics are based on the control flow graph.  If some branch probabilities
5083 are specified by @samp{__builtin_expect}, then the heuristics will be
5084 used to guess branch probabilities for the rest of the control flow graph,
5085 taking the @samp{__builtin_expect} info into account.  The interactions
5086 between the heuristics and @samp{__builtin_expect} can be complex, and in
5087 some cases, it may be useful to disable the heuristics so that the effects
5088 of @samp{__builtin_expect} are easier to understand.
5090 The default is @option{-fguess-branch-probability} at levels
5091 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5093 @item -freorder-blocks
5094 @opindex freorder-blocks
5095 Reorder basic blocks in the compiled function in order to reduce number of
5096 taken branches and improve code locality.
5098 Enabled at levels @option{-O2}, @option{-O3}.
5100 @item -freorder-blocks-and-partition
5101 @opindex freorder-blocks-and-partition
5102 In addition to reordering basic blocks in the compiled function, in order
5103 to reduce number of taken branches, partitions hot and cold basic blocks
5104 into separate sections of the assembly and .o files, to improve
5105 paging and cache locality performance.
5107 This optimization is automatically turned off in the presence of
5108 exception handling, for linkonce sections, for functions with a user-defined
5109 section attribute and on any architecture that does not support named
5110 sections.
5112 @item -freorder-functions
5113 @opindex freorder-functions
5114 Reorder functions in the object file in order to
5115 improve code locality.  This is implemented by using special
5116 subsections @code{.text.hot} for most frequently executed functions and
5117 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
5118 the linker so object file format must support named sections and linker must
5119 place them in a reasonable way.
5121 Also profile feedback must be available in to make this option effective.  See
5122 @option{-fprofile-arcs} for details.
5124 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5126 @item -fstrict-aliasing
5127 @opindex fstrict-aliasing
5128 Allows the compiler to assume the strictest aliasing rules applicable to
5129 the language being compiled.  For C (and C++), this activates
5130 optimizations based on the type of expressions.  In particular, an
5131 object of one type is assumed never to reside at the same address as an
5132 object of a different type, unless the types are almost the same.  For
5133 example, an @code{unsigned int} can alias an @code{int}, but not a
5134 @code{void*} or a @code{double}.  A character type may alias any other
5135 type.
5137 Pay special attention to code like this:
5138 @smallexample
5139 union a_union @{
5140   int i;
5141   double d;
5144 int f() @{
5145   a_union t;
5146   t.d = 3.0;
5147   return t.i;
5149 @end smallexample
5150 The practice of reading from a different union member than the one most
5151 recently written to (called ``type-punning'') is common.  Even with
5152 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5153 is accessed through the union type.  So, the code above will work as
5154 expected.  However, this code might not:
5155 @smallexample
5156 int f() @{
5157   a_union t;
5158   int* ip;
5159   t.d = 3.0;
5160   ip = &t.i;
5161   return *ip;
5163 @end smallexample
5165 Every language that wishes to perform language-specific alias analysis
5166 should define a function that computes, given an @code{tree}
5167 node, an alias set for the node.  Nodes in different alias sets are not
5168 allowed to alias.  For an example, see the C front-end function
5169 @code{c_get_alias_set}.
5171 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5173 @item -falign-functions
5174 @itemx -falign-functions=@var{n}
5175 @opindex falign-functions
5176 Align the start of functions to the next power-of-two greater than
5177 @var{n}, skipping up to @var{n} bytes.  For instance,
5178 @option{-falign-functions=32} aligns functions to the next 32-byte
5179 boundary, but @option{-falign-functions=24} would align to the next
5180 32-byte boundary only if this can be done by skipping 23 bytes or less.
5182 @option{-fno-align-functions} and @option{-falign-functions=1} are
5183 equivalent and mean that functions will not be aligned.
5185 Some assemblers only support this flag when @var{n} is a power of two;
5186 in that case, it is rounded up.
5188 If @var{n} is not specified or is zero, use a machine-dependent default.
5190 Enabled at levels @option{-O2}, @option{-O3}.
5192 @item -falign-labels
5193 @itemx -falign-labels=@var{n}
5194 @opindex falign-labels
5195 Align all branch targets to a power-of-two boundary, skipping up to
5196 @var{n} bytes like @option{-falign-functions}.  This option can easily
5197 make code slower, because it must insert dummy operations for when the
5198 branch target is reached in the usual flow of the code.
5200 @option{-fno-align-labels} and @option{-falign-labels=1} are
5201 equivalent and mean that labels will not be aligned.
5203 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5204 are greater than this value, then their values are used instead.
5206 If @var{n} is not specified or is zero, use a machine-dependent default
5207 which is very likely to be @samp{1}, meaning no alignment.
5209 Enabled at levels @option{-O2}, @option{-O3}.
5211 @item -falign-loops
5212 @itemx -falign-loops=@var{n}
5213 @opindex falign-loops
5214 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5215 like @option{-falign-functions}.  The hope is that the loop will be
5216 executed many times, which will make up for any execution of the dummy
5217 operations.
5219 @option{-fno-align-loops} and @option{-falign-loops=1} are
5220 equivalent and mean that loops will not be aligned.
5222 If @var{n} is not specified or is zero, use a machine-dependent default.
5224 Enabled at levels @option{-O2}, @option{-O3}.
5226 @item -falign-jumps
5227 @itemx -falign-jumps=@var{n}
5228 @opindex falign-jumps
5229 Align branch targets to a power-of-two boundary, for branch targets
5230 where the targets can only be reached by jumping, skipping up to @var{n}
5231 bytes like @option{-falign-functions}.  In this case, no dummy operations
5232 need be executed.
5234 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5235 equivalent and mean that loops will not be aligned.
5237 If @var{n} is not specified or is zero, use a machine-dependent default.
5239 Enabled at levels @option{-O2}, @option{-O3}.
5241 @item -funit-at-a-time
5242 @opindex funit-at-a-time
5243 Parse the whole compilation unit before starting to produce code.
5244 This allows some extra optimizations to take place but consumes
5245 more memory (in general).  There are some compatibility issues
5246 with @emph{unit-at-at-time} mode:
5247 @itemize @bullet
5248 @item
5249 enabling @emph{unit-at-a-time} mode may change the order
5250 in which functions, variables, and top-level @code{asm} statements
5251 are emitted, and will likely break code relying on some particular
5252 ordering.  The majority of such top-level @code{asm} statements,
5253 though, can be replaced by @code{section} attributes.
5255 @item
5256 @emph{unit-at-a-time} mode removes unreferenced static variables
5257 and functions.  This may result in undefined references
5258 when an @code{asm} statement refers directly to variables or functions
5259 that are otherwise unused.  In that case either the variable/function
5260 shall be listed as an operand of the @code{asm} statement operand or,
5261 in the case of top-level @code{asm} statements the attribute @code{used}
5262 shall be used on the declaration.
5264 @item
5265 Static functions now can use non-standard passing conventions that
5266 may break @code{asm} statements calling functions directly.  Again,
5267 attribute @code{used} will prevent this behavior.
5268 @end itemize
5270 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5271 but this scheme may not be supported by future releases of GCC@.
5273 Enabled at levels @option{-O2}, @option{-O3}.
5275 @item -fweb
5276 @opindex fweb
5277 Constructs webs as commonly used for register allocation purposes and assign
5278 each web individual pseudo register.  This allows the register allocation pass
5279 to operate on pseudos directly, but also strengthens several other optimization
5280 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5281 however, make debugging impossible, since variables will no longer stay in a
5282 ``home register''.
5284 Enabled by default with @option{-funroll-loops}.
5286 @item -fwhole-program
5287 @opindex fwhole-program
5288 Assume that the current compilation unit represents whole program being
5289 compiled.  All public functions and variables with the exception of @code{main}
5290 and those merged by attribute @code{externally_visible} become static functions
5291 and in a affect gets more aggressively optimized by interprocedural optimizers.
5292 While this option is equivalent to proper use of @code{static} keyword for
5293 programs consisting of single file, in combination with option
5294 @option{--combine} this flag can be used to compile most of smaller scale C
5295 programs since the functions and variables become local for the whole combined
5296 compilation unit, not for the single source file itself.
5299 @item -fno-cprop-registers
5300 @opindex fno-cprop-registers
5301 After register allocation and post-register allocation instruction splitting,
5302 we perform a copy-propagation pass to try to reduce scheduling dependencies
5303 and occasionally eliminate the copy.
5305 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5307 @item -fprofile-generate
5308 @opindex fprofile-generate
5310 Enable options usually used for instrumenting application to produce
5311 profile useful for later recompilation with profile feedback based
5312 optimization.  You must use @option{-fprofile-generate} both when
5313 compiling and when linking your program.
5315 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5317 @item -fprofile-use
5318 @opindex fprofile-use
5319 Enable profile feedback directed optimizations, and optimizations
5320 generally profitable only with profile feedback available.
5322 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5323 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5324 @code{-fno-loop-optimize}.
5326 @end table
5328 The following options control compiler behavior regarding floating
5329 point arithmetic.  These options trade off between speed and
5330 correctness.  All must be specifically enabled.
5332 @table @gcctabopt
5333 @item -ffloat-store
5334 @opindex ffloat-store
5335 Do not store floating point variables in registers, and inhibit other
5336 options that might change whether a floating point value is taken from a
5337 register or memory.
5339 @cindex floating point precision
5340 This option prevents undesirable excess precision on machines such as
5341 the 68000 where the floating registers (of the 68881) keep more
5342 precision than a @code{double} is supposed to have.  Similarly for the
5343 x86 architecture.  For most programs, the excess precision does only
5344 good, but a few programs rely on the precise definition of IEEE floating
5345 point.  Use @option{-ffloat-store} for such programs, after modifying
5346 them to store all pertinent intermediate computations into variables.
5348 @item -ffast-math
5349 @opindex ffast-math
5350 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5351 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5352 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5353 and @option{fcx-limited-range}.
5355 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5357 This option should never be turned on by any @option{-O} option since
5358 it can result in incorrect output for programs which depend on
5359 an exact implementation of IEEE or ISO rules/specifications for
5360 math functions.
5362 @item -fno-math-errno
5363 @opindex fno-math-errno
5364 Do not set ERRNO after calling math functions that are executed
5365 with a single instruction, e.g., sqrt.  A program that relies on
5366 IEEE exceptions for math error handling may want to use this flag
5367 for speed while maintaining IEEE arithmetic compatibility.
5369 This option should never be turned on by any @option{-O} option since
5370 it can result in incorrect output for programs which depend on
5371 an exact implementation of IEEE or ISO rules/specifications for
5372 math functions.
5374 The default is @option{-fmath-errno}.
5376 On Darwin systems, the math library never sets @code{errno}.  There is therefore
5377 no reason for the compiler to consider the possibility that it might,
5378 and @option{-fno-math-errno} is the default.
5380 @item -funsafe-math-optimizations
5381 @opindex funsafe-math-optimizations
5382 Allow optimizations for floating-point arithmetic that (a) assume
5383 that arguments and results are valid and (b) may violate IEEE or
5384 ANSI standards.  When used at link-time, it may include libraries
5385 or startup files that change the default FPU control word or other
5386 similar optimizations.
5388 This option should never be turned on by any @option{-O} option since
5389 it can result in incorrect output for programs which depend on
5390 an exact implementation of IEEE or ISO rules/specifications for
5391 math functions.
5393 The default is @option{-fno-unsafe-math-optimizations}.
5395 @item -ffinite-math-only
5396 @opindex ffinite-math-only
5397 Allow optimizations for floating-point arithmetic that assume
5398 that arguments and results are not NaNs or +-Infs.
5400 This option should never be turned on by any @option{-O} option since
5401 it can result in incorrect output for programs which depend on
5402 an exact implementation of IEEE or ISO rules/specifications.
5404 The default is @option{-fno-finite-math-only}.
5406 @item -fno-trapping-math
5407 @opindex fno-trapping-math
5408 Compile code assuming that floating-point operations cannot generate
5409 user-visible traps.  These traps include division by zero, overflow,
5410 underflow, inexact result and invalid operation.  This option implies
5411 @option{-fno-signaling-nans}.  Setting this option may allow faster
5412 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5414 This option should never be turned on by any @option{-O} option since
5415 it can result in incorrect output for programs which depend on
5416 an exact implementation of IEEE or ISO rules/specifications for
5417 math functions.
5419 The default is @option{-ftrapping-math}.
5421 @item -frounding-math
5422 @opindex frounding-math
5423 Disable transformations and optimizations that assume default floating
5424 point rounding behavior.  This is round-to-zero for all floating point
5425 to integer conversions, and round-to-nearest for all other arithmetic
5426 truncations.  This option should be specified for programs that change
5427 the FP rounding mode dynamically, or that may be executed with a
5428 non-default rounding mode.  This option disables constant folding of
5429 floating point expressions at compile-time (which may be affected by
5430 rounding mode) and arithmetic transformations that are unsafe in the
5431 presence of sign-dependent rounding modes.
5433 The default is @option{-fno-rounding-math}.
5435 This option is experimental and does not currently guarantee to
5436 disable all GCC optimizations that are affected by rounding mode.
5437 Future versions of GCC may provide finer control of this setting
5438 using C99's @code{FENV_ACCESS} pragma.  This command line option
5439 will be used to specify the default state for @code{FENV_ACCESS}.
5441 @item -fsignaling-nans
5442 @opindex fsignaling-nans
5443 Compile code assuming that IEEE signaling NaNs may generate user-visible
5444 traps during floating-point operations.  Setting this option disables
5445 optimizations that may change the number of exceptions visible with
5446 signaling NaNs.  This option implies @option{-ftrapping-math}.
5448 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5449 be defined.
5451 The default is @option{-fno-signaling-nans}.
5453 This option is experimental and does not currently guarantee to
5454 disable all GCC optimizations that affect signaling NaN behavior.
5456 @item -fsingle-precision-constant
5457 @opindex fsingle-precision-constant
5458 Treat floating point constant as single precision constant instead of
5459 implicitly converting it to double precision constant.
5461 @item -fcx-limited-range
5462 @itemx -fno-cx-limited-range
5463 @opindex fcx-limited-range
5464 @opindex fno-cx-limited-range
5465 When enabled, this option states that a range reduction step is not
5466 needed when performing complex division.  The default is
5467 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5469 This option controls the default setting of the ISO C99 
5470 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5471 all languages.
5473 @end table
5475 The following options control optimizations that may improve
5476 performance, but are not enabled by any @option{-O} options.  This
5477 section includes experimental options that may produce broken code.
5479 @table @gcctabopt
5480 @item -fbranch-probabilities
5481 @opindex fbranch-probabilities
5482 After running a program compiled with @option{-fprofile-arcs}
5483 (@pxref{Debugging Options,, Options for Debugging Your Program or
5484 @command{gcc}}), you can compile it a second time using
5485 @option{-fbranch-probabilities}, to improve optimizations based on
5486 the number of times each branch was taken.  When the program
5487 compiled with @option{-fprofile-arcs} exits it saves arc execution
5488 counts to a file called @file{@var{sourcename}.gcda} for each source
5489 file  The information in this data file is very dependent on the
5490 structure of the generated code, so you must use the same source code
5491 and the same optimization options for both compilations.
5493 With @option{-fbranch-probabilities}, GCC puts a
5494 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5495 These can be used to improve optimization.  Currently, they are only
5496 used in one place: in @file{reorg.c}, instead of guessing which path a
5497 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5498 exactly determine which path is taken more often.
5500 @item -fprofile-values
5501 @opindex fprofile-values
5502 If combined with @option{-fprofile-arcs}, it adds code so that some
5503 data about values of expressions in the program is gathered.
5505 With @option{-fbranch-probabilities}, it reads back the data gathered
5506 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5507 notes to instructions for their later usage in optimizations.
5509 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5511 @item -fvpt
5512 @opindex fvpt
5513 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5514 a code to gather information about values of expressions.
5516 With @option{-fbranch-probabilities}, it reads back the data gathered
5517 and actually performs the optimizations based on them.
5518 Currently the optimizations include specialization of division operation
5519 using the knowledge about the value of the denominator.
5521 @item -frename-registers
5522 @opindex frename-registers
5523 Attempt to avoid false dependencies in scheduled code by making use
5524 of registers left over after register allocation.  This optimization
5525 will most benefit processors with lots of registers.  Depending on the
5526 debug information format adopted by the target, however, it can
5527 make debugging impossible, since variables will no longer stay in
5528 a ``home register''.
5530 Enabled by default with @option{-funroll-loops}.
5532 @item -ftracer
5533 @opindex ftracer
5534 Perform tail duplication to enlarge superblock size.  This transformation
5535 simplifies the control flow of the function allowing other optimizations to do
5536 better job.
5538 Enabled with @option{-fprofile-use}.
5540 @item -funroll-loops
5541 @opindex funroll-loops
5542 Unroll loops whose number of iterations can be determined at compile time or
5543 upon entry to the loop.  @option{-funroll-loops} implies
5544 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}. 
5545 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5546 small constant number of iterations).  This option makes code larger, and may
5547 or may not make it run faster.
5549 Enabled with @option{-fprofile-use}.
5551 @item -funroll-all-loops
5552 @opindex funroll-all-loops
5553 Unroll all loops, even if their number of iterations is uncertain when
5554 the loop is entered.  This usually makes programs run more slowly.
5555 @option{-funroll-all-loops} implies the same options as
5556 @option{-funroll-loops}.
5558 @item -fpeel-loops
5559 @opindex fpeel-loops
5560 Peels the loops for that there is enough information that they do not
5561 roll much (from profile feedback).  It also turns on complete loop peeling
5562 (i.e.@: complete removal of loops with small constant number of iterations).
5564 Enabled with @option{-fprofile-use}.
5566 @item -fmove-loop-invariants
5567 @opindex fmove-loop-invariants
5568 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5569 at level @option{-O1}
5571 @item -funswitch-loops
5572 @opindex funswitch-loops
5573 Move branches with loop invariant conditions out of the loop, with duplicates
5574 of the loop on both branches (modified according to result of the condition).
5576 @item -fprefetch-loop-arrays
5577 @opindex fprefetch-loop-arrays
5578 If supported by the target machine, generate instructions to prefetch
5579 memory to improve the performance of loops that access large arrays.
5581 Disabled at level @option{-Os}.
5583 @item -ffunction-sections
5584 @itemx -fdata-sections
5585 @opindex ffunction-sections
5586 @opindex fdata-sections
5587 Place each function or data item into its own section in the output
5588 file if the target supports arbitrary sections.  The name of the
5589 function or the name of the data item determines the section's name
5590 in the output file.
5592 Use these options on systems where the linker can perform optimizations
5593 to improve locality of reference in the instruction space.  Most systems
5594 using the ELF object format and SPARC processors running Solaris 2 have
5595 linkers with such optimizations.  AIX may have these optimizations in
5596 the future.
5598 Only use these options when there are significant benefits from doing
5599 so.  When you specify these options, the assembler and linker will
5600 create larger object and executable files and will also be slower.
5601 You will not be able to use @code{gprof} on all systems if you
5602 specify this option and you may have problems with debugging if
5603 you specify both this option and @option{-g}.
5605 @item -fbranch-target-load-optimize
5606 @opindex fbranch-target-load-optimize
5607 Perform branch target register load optimization before prologue / epilogue
5608 threading.
5609 The use of target registers can typically be exposed only during reload,
5610 thus hoisting loads out of loops and doing inter-block scheduling needs
5611 a separate optimization pass.
5613 @item -fbranch-target-load-optimize2
5614 @opindex fbranch-target-load-optimize2
5615 Perform branch target register load optimization after prologue / epilogue
5616 threading.
5618 @item -fbtr-bb-exclusive
5619 @opindex fbtr-bb-exclusive
5620 When performing branch target register load optimization, don't reuse
5621 branch target registers in within any basic block.
5623 @item --param @var{name}=@var{value}
5624 @opindex param
5625 In some places, GCC uses various constants to control the amount of
5626 optimization that is done.  For example, GCC will not inline functions
5627 that contain more that a certain number of instructions.  You can
5628 control some of these constants on the command-line using the
5629 @option{--param} option.
5631 The names of specific parameters, and the meaning of the values, are
5632 tied to the internals of the compiler, and are subject to change
5633 without notice in future releases.
5635 In each case, the @var{value} is an integer.  The allowable choices for
5636 @var{name} are given in the following table:
5638 @table @gcctabopt
5639 @item salias-max-implicit-fields
5640 The maximum number of fields in a variable without direct
5641 structure accesses for which structure aliasing will consider trying 
5642 to track each field.  The default is 5
5644 @item sra-max-structure-size
5645 The maximum structure size, in bytes, at which the scalar replacement
5646 of aggregates (SRA) optimization will perform block copies.  The
5647 default value, 0, implies that GCC will select the most appropriate
5648 size itself.
5650 @item sra-field-structure-ratio
5651 The threshold ratio (as a percentage) between instantiated fields and
5652 the complete structure size.  We say that if the ratio of the number
5653 of bytes in instantiated fields to the number of bytes in the complete
5654 structure exceeds this parameter, then block copies are not used.  The
5655 default is 75.
5657 @item max-crossjump-edges
5658 The maximum number of incoming edges to consider for crossjumping.
5659 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5660 the number of edges incoming to each block.  Increasing values mean
5661 more aggressive optimization, making the compile time increase with
5662 probably small improvement in executable size.
5664 @item min-crossjump-insns
5665 The minimum number of instructions which must be matched at the end
5666 of two blocks before crossjumping will be performed on them.  This
5667 value is ignored in the case where all instructions in the block being
5668 crossjumped from are matched.  The default value is 5.
5670 @item max-goto-duplication-insns
5671 The maximum number of instructions to duplicate to a block that jumps
5672 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5673 passes, GCC factors computed gotos early in the compilation process,
5674 and unfactors them as late as possible.  Only computed jumps at the
5675 end of a basic blocks with no more than max-goto-duplication-insns are
5676 unfactored.  The default value is 8.
5678 @item max-delay-slot-insn-search
5679 The maximum number of instructions to consider when looking for an
5680 instruction to fill a delay slot.  If more than this arbitrary number of
5681 instructions is searched, the time savings from filling the delay slot
5682 will be minimal so stop searching.  Increasing values mean more
5683 aggressive optimization, making the compile time increase with probably
5684 small improvement in executable run time.
5686 @item max-delay-slot-live-search
5687 When trying to fill delay slots, the maximum number of instructions to
5688 consider when searching for a block with valid live register
5689 information.  Increasing this arbitrarily chosen value means more
5690 aggressive optimization, increasing the compile time.  This parameter
5691 should be removed when the delay slot code is rewritten to maintain the
5692 control-flow graph.
5694 @item max-gcse-memory
5695 The approximate maximum amount of memory that will be allocated in
5696 order to perform the global common subexpression elimination
5697 optimization.  If more memory than specified is required, the
5698 optimization will not be done.
5700 @item max-gcse-passes
5701 The maximum number of passes of GCSE to run.  The default is 1.
5703 @item max-pending-list-length
5704 The maximum number of pending dependencies scheduling will allow
5705 before flushing the current state and starting over.  Large functions
5706 with few branches or calls can create excessively large lists which
5707 needlessly consume memory and resources.
5709 @item max-inline-insns-single
5710 Several parameters control the tree inliner used in gcc.
5711 This number sets the maximum number of instructions (counted in GCC's
5712 internal representation) in a single function that the tree inliner
5713 will consider for inlining.  This only affects functions declared
5714 inline and methods implemented in a class declaration (C++).
5715 The default value is 450.
5717 @item max-inline-insns-auto
5718 When you use @option{-finline-functions} (included in @option{-O3}),
5719 a lot of functions that would otherwise not be considered for inlining
5720 by the compiler will be investigated.  To those functions, a different
5721 (more restrictive) limit compared to functions declared inline can
5722 be applied.
5723 The default value is 90.
5725 @item large-function-insns
5726 The limit specifying really large functions.  For functions larger than this
5727 limit after inlining inlining is constrained by
5728 @option{--param large-function-growth}.  This parameter is useful primarily
5729 to avoid extreme compilation time caused by non-linear algorithms used by the
5730 backend.
5731 This parameter is ignored when @option{-funit-at-a-time} is not used.
5732 The default value is 2700.
5734 @item large-function-growth
5735 Specifies maximal growth of large function caused by inlining in percents.
5736 This parameter is ignored when @option{-funit-at-a-time} is not used.
5737 The default value is 100 which limits large function growth to 2.0 times
5738 the original size.
5740 @item inline-unit-growth
5741 Specifies maximal overall growth of the compilation unit caused by inlining.
5742 This parameter is ignored when @option{-funit-at-a-time} is not used.
5743 The default value is 50 which limits unit growth to 1.5 times the original
5744 size.
5746 @item max-inline-insns-recursive
5747 @itemx max-inline-insns-recursive-auto
5748 Specifies maximum number of instructions out-of-line copy of self recursive inline
5749 function can grow into by performing recursive inlining.
5751 For functions declared inline @option{--param max-inline-insns-recursive} is
5752 taken into acount.  For function not declared inline, recursive inlining
5753 happens only when @option{-finline-functions} (included in @option{-O3}) is
5754 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5755 default value is 450.
5757 @item max-inline-recursive-depth
5758 @itemx max-inline-recursive-depth-auto
5759 Specifies maximum recursion depth used by the recursive inlining.
5761 For functions declared inline @option{--param max-inline-recursive-depth} is
5762 taken into acount.  For function not declared inline, recursive inlining
5763 happens only when @option{-finline-functions} (included in @option{-O3}) is
5764 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5765 default value is 450.
5767 @item min-inline-recursive-probability
5768 Recursive inlining is profitable only for function having deep recursion
5769 in average and can hurt for function having little recursion depth by
5770 increasing the prologue size or complexity of function body to other
5771 optimizers.
5773 When profile feedback is available (see @option{-fprofile-generate}) the actual
5774 recursion depth can be guessed from probability that function will recurse via
5775 given call expression.  This parameter limits inlining only to call expression
5776 whose probability exceeds given threshold (in percents).  The default value is
5779 @item inline-call-cost
5780 Specify cost of call instruction relative to simple arithmetics operations
5781 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5782 functions and at the same time increases size of leaf function that is believed to
5783 reduce function size by being inlined.  In effect it increases amount of
5784 inlining for code having large abstraction penalty (many functions that just
5785 pass the arguments to other functions) and decrease inlining for code with low
5786 abstraction penalty.  The default value is 16.
5788 @item max-unrolled-insns
5789 The maximum number of instructions that a loop should have if that loop
5790 is unrolled, and if the loop is unrolled, it determines how many times
5791 the loop code is unrolled.
5793 @item max-average-unrolled-insns
5794 The maximum number of instructions biased by probabilities of their execution
5795 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5796 it determines how many times the loop code is unrolled.
5798 @item max-unroll-times
5799 The maximum number of unrollings of a single loop.
5801 @item max-peeled-insns
5802 The maximum number of instructions that a loop should have if that loop
5803 is peeled, and if the loop is peeled, it determines how many times
5804 the loop code is peeled.
5806 @item max-peel-times
5807 The maximum number of peelings of a single loop.
5809 @item max-completely-peeled-insns
5810 The maximum number of insns of a completely peeled loop.
5812 @item max-completely-peel-times
5813 The maximum number of iterations of a loop to be suitable for complete peeling.
5815 @item max-unswitch-insns
5816 The maximum number of insns of an unswitched loop.
5818 @item max-unswitch-level
5819 The maximum number of branches unswitched in a single loop.
5821 @item lim-expensive
5822 The minimum cost of an expensive expression in the loop invariant motion.
5824 @item iv-consider-all-candidates-bound
5825 Bound on number of candidates for induction variables below that
5826 all candidates are considered for each use in induction variable
5827 optimizations.  Only the most relevant candidates are considered
5828 if there are more candidates, to avoid quadratic time complexity.
5830 @item iv-max-considered-uses
5831 The induction variable optimizations give up on loops that contain more
5832 induction variable uses.
5834 @item iv-always-prune-cand-set-bound
5835 If number of candidates in the set is smaller than this value,
5836 we always try to remove unnecessary ivs from the set during its
5837 optimization when a new iv is added to the set.
5839 @item scev-max-expr-size
5840 Bound on size of expressions used in the scalar evolutions analyzer.
5841 Large expressions slow the analyzer.
5843 @item max-iterations-to-track
5845 The maximum number of iterations of a loop the brute force algorithm
5846 for analysis of # of iterations of the loop tries to evaluate.
5848 @item hot-bb-count-fraction
5849 Select fraction of the maximal count of repetitions of basic block in program
5850 given basic block needs to have to be considered hot.
5852 @item hot-bb-frequency-fraction
5853 Select fraction of the maximal frequency of executions of basic block in
5854 function given basic block needs to have to be considered hot
5856 @item tracer-dynamic-coverage
5857 @itemx tracer-dynamic-coverage-feedback
5859 This value is used to limit superblock formation once the given percentage of
5860 executed instructions is covered.  This limits unnecessary code size
5861 expansion.
5863 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5864 feedback is available.  The real profiles (as opposed to statically estimated
5865 ones) are much less balanced allowing the threshold to be larger value.
5867 @item tracer-max-code-growth
5868 Stop tail duplication once code growth has reached given percentage.  This is
5869 rather hokey argument, as most of the duplicates will be eliminated later in
5870 cross jumping, so it may be set to much higher values than is the desired code
5871 growth.
5873 @item tracer-min-branch-ratio
5875 Stop reverse growth when the reverse probability of best edge is less than this
5876 threshold (in percent).
5878 @item tracer-min-branch-ratio
5879 @itemx tracer-min-branch-ratio-feedback
5881 Stop forward growth if the best edge do have probability lower than this
5882 threshold.
5884 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5885 compilation for profile feedback and one for compilation without.  The value
5886 for compilation with profile feedback needs to be more conservative (higher) in
5887 order to make tracer effective.
5889 @item max-cse-path-length
5891 Maximum number of basic blocks on path that cse considers.  The default is 10.
5893 @item global-var-threshold
5895 Counts the number of function calls (@var{n}) and the number of
5896 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5897 single artificial variable will be created to represent all the
5898 call-clobbered variables at function call sites.  This artificial
5899 variable will then be made to alias every call-clobbered variable.
5900 (done as @code{int * size_t} on the host machine; beware overflow).
5902 @item max-aliased-vops
5904 Maximum number of virtual operands allowed to represent aliases
5905 before triggering the alias grouping heuristic.  Alias grouping
5906 reduces compile times and memory consumption needed for aliasing at
5907 the expense of precision loss in alias information.
5909 @item ggc-min-expand
5911 GCC uses a garbage collector to manage its own memory allocation.  This
5912 parameter specifies the minimum percentage by which the garbage
5913 collector's heap should be allowed to expand between collections.
5914 Tuning this may improve compilation speed; it has no effect on code
5915 generation.
5917 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5918 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5919 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5920 GCC is not able to calculate RAM on a particular platform, the lower
5921 bound of 30% is used.  Setting this parameter and
5922 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5923 every opportunity.  This is extremely slow, but can be useful for
5924 debugging.
5926 @item ggc-min-heapsize
5928 Minimum size of the garbage collector's heap before it begins bothering
5929 to collect garbage.  The first collection occurs after the heap expands
5930 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5931 tuning this may improve compilation speed, and has no effect on code
5932 generation.
5934 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5935 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5936 with a lower bound of 4096 (four megabytes) and an upper bound of
5937 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5938 particular platform, the lower bound is used.  Setting this parameter
5939 very large effectively disables garbage collection.  Setting this
5940 parameter and @option{ggc-min-expand} to zero causes a full collection
5941 to occur at every opportunity.
5943 @item max-reload-search-insns
5944 The maximum number of instruction reload should look backward for equivalent
5945 register.  Increasing values mean more aggressive optimization, making the
5946 compile time increase with probably slightly better performance.  The default
5947 value is 100.
5949 @item max-cselib-memory-location
5950 The maximum number of memory locations cselib should take into acount.
5951 Increasing values mean more aggressive optimization, making the compile time
5952 increase with probably slightly better performance.  The default value is 500.
5954 @item reorder-blocks-duplicate
5955 @itemx reorder-blocks-duplicate-feedback
5957 Used by basic block reordering pass to decide whether to use unconditional
5958 branch or duplicate the code on its destination.  Code is duplicated when its
5959 estimated size is smaller than this value multiplied by the estimated size of
5960 unconditional jump in the hot spots of the program.
5962 The @option{reorder-block-duplicate-feedback} is used only when profile
5963 feedback is available and may be set to higher values than
5964 @option{reorder-block-duplicate} since information about the hot spots is more
5965 accurate.
5967 @item max-sched-region-blocks
5968 The maximum number of blocks in a region to be considered for
5969 interblock scheduling.  The default value is 10.
5971 @item max-sched-region-insns
5972 The maximum number of insns in a region to be considered for
5973 interblock scheduling.  The default value is 100.
5975 @item max-last-value-rtl
5977 The maximum size measured as number of RTLs that can be recorded in an expression
5978 in combiner for a pseudo register as last known value of that register.  The default
5979 is 10000.
5981 @item integer-share-limit
5982 Small integer constants can use a shared data structure, reducing the
5983 compiler's memory usage and increasing its speed.  This sets the maximum
5984 value of a shared integer constant's.  The default value is 256.
5986 @item min-virtual-mappings
5987 Specifies the minimum number of virtual mappings in the incremental
5988 SSA updater that should be registered to trigger the virtual mappings
5989 heuristic defined by virtual-mappings-ratio.  The default value is
5990 100.
5992 @item virtual-mappings-ratio
5993 If the number of virtual mappings is virtual-mappings-ratio bigger
5994 than the number of virtual symbols to be updated, then the incremental
5995 SSA updater switches to a full update for those symbols.  The default
5996 ratio is 3.
5998 @end table
5999 @end table
6001 @node Preprocessor Options
6002 @section Options Controlling the Preprocessor
6003 @cindex preprocessor options
6004 @cindex options, preprocessor
6006 These options control the C preprocessor, which is run on each C source
6007 file before actual compilation.
6009 If you use the @option{-E} option, nothing is done except preprocessing.
6010 Some of these options make sense only together with @option{-E} because
6011 they cause the preprocessor output to be unsuitable for actual
6012 compilation.
6014 @table @gcctabopt
6015 @opindex Wp
6016 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6017 and pass @var{option} directly through to the preprocessor.  If
6018 @var{option} contains commas, it is split into multiple options at the
6019 commas.  However, many options are modified, translated or interpreted
6020 by the compiler driver before being passed to the preprocessor, and
6021 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
6022 interface is undocumented and subject to change, so whenever possible
6023 you should avoid using @option{-Wp} and let the driver handle the
6024 options instead.
6026 @item -Xpreprocessor @var{option}
6027 @opindex preprocessor
6028 Pass @var{option} as an option to the preprocessor.  You can use this to
6029 supply system-specific preprocessor options which GCC does not know how to
6030 recognize.
6032 If you want to pass an option that takes an argument, you must use
6033 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6034 @end table
6036 @include cppopts.texi
6038 @node Assembler Options
6039 @section Passing Options to the Assembler
6041 @c prevent bad page break with this line
6042 You can pass options to the assembler.
6044 @table @gcctabopt
6045 @item -Wa,@var{option}
6046 @opindex Wa
6047 Pass @var{option} as an option to the assembler.  If @var{option}
6048 contains commas, it is split into multiple options at the commas.
6050 @item -Xassembler @var{option}
6051 @opindex Xassembler
6052 Pass @var{option} as an option to the assembler.  You can use this to
6053 supply system-specific assembler options which GCC does not know how to
6054 recognize.
6056 If you want to pass an option that takes an argument, you must use
6057 @option{-Xassembler} twice, once for the option and once for the argument.
6059 @end table
6061 @node Link Options
6062 @section Options for Linking
6063 @cindex link options
6064 @cindex options, linking
6066 These options come into play when the compiler links object files into
6067 an executable output file.  They are meaningless if the compiler is
6068 not doing a link step.
6070 @table @gcctabopt
6071 @cindex file names
6072 @item @var{object-file-name}
6073 A file name that does not end in a special recognized suffix is
6074 considered to name an object file or library.  (Object files are
6075 distinguished from libraries by the linker according to the file
6076 contents.)  If linking is done, these object files are used as input
6077 to the linker.
6079 @item -c
6080 @itemx -S
6081 @itemx -E
6082 @opindex c
6083 @opindex S
6084 @opindex E
6085 If any of these options is used, then the linker is not run, and
6086 object file names should not be used as arguments.  @xref{Overall
6087 Options}.
6089 @cindex Libraries
6090 @item -l@var{library}
6091 @itemx -l @var{library}
6092 @opindex l
6093 Search the library named @var{library} when linking.  (The second
6094 alternative with the library as a separate argument is only for
6095 POSIX compliance and is not recommended.)
6097 It makes a difference where in the command you write this option; the
6098 linker searches and processes libraries and object files in the order they
6099 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6100 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
6101 to functions in @samp{z}, those functions may not be loaded.
6103 The linker searches a standard list of directories for the library,
6104 which is actually a file named @file{lib@var{library}.a}.  The linker
6105 then uses this file as if it had been specified precisely by name.
6107 The directories searched include several standard system directories
6108 plus any that you specify with @option{-L}.
6110 Normally the files found this way are library files---archive files
6111 whose members are object files.  The linker handles an archive file by
6112 scanning through it for members which define symbols that have so far
6113 been referenced but not defined.  But if the file that is found is an
6114 ordinary object file, it is linked in the usual fashion.  The only
6115 difference between using an @option{-l} option and specifying a file name
6116 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6117 and searches several directories.
6119 @item -lobjc
6120 @opindex lobjc
6121 You need this special case of the @option{-l} option in order to
6122 link an Objective-C or Objective-C++ program.
6124 @item -nostartfiles
6125 @opindex nostartfiles
6126 Do not use the standard system startup files when linking.
6127 The standard system libraries are used normally, unless @option{-nostdlib}
6128 or @option{-nodefaultlibs} is used.
6130 @item -nodefaultlibs
6131 @opindex nodefaultlibs
6132 Do not use the standard system libraries when linking.
6133 Only the libraries you specify will be passed to the linker.
6134 The standard startup files are used normally, unless @option{-nostartfiles}
6135 is used.  The compiler may generate calls to @code{memcmp},
6136 @code{memset}, @code{memcpy} and @code{memmove}.
6137 These entries are usually resolved by entries in
6138 libc.  These entry points should be supplied through some other
6139 mechanism when this option is specified.
6141 @item -nostdlib
6142 @opindex nostdlib
6143 Do not use the standard system startup files or libraries when linking.
6144 No startup files and only the libraries you specify will be passed to
6145 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
6146 @code{memcpy} and @code{memmove}.
6147 These entries are usually resolved by entries in
6148 libc.  These entry points should be supplied through some other
6149 mechanism when this option is specified.
6151 @cindex @option{-lgcc}, use with @option{-nostdlib}
6152 @cindex @option{-nostdlib} and unresolved references
6153 @cindex unresolved references and @option{-nostdlib}
6154 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6155 @cindex @option{-nodefaultlibs} and unresolved references
6156 @cindex unresolved references and @option{-nodefaultlibs}
6157 One of the standard libraries bypassed by @option{-nostdlib} and
6158 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6159 that GCC uses to overcome shortcomings of particular machines, or special
6160 needs for some languages.
6161 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6162 Collection (GCC) Internals},
6163 for more discussion of @file{libgcc.a}.)
6164 In most cases, you need @file{libgcc.a} even when you want to avoid
6165 other standard libraries.  In other words, when you specify @option{-nostdlib}
6166 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6167 This ensures that you have no unresolved references to internal GCC
6168 library subroutines.  (For example, @samp{__main}, used to ensure C++
6169 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6170 GNU Compiler Collection (GCC) Internals}.)
6172 @item -pie
6173 @opindex pie
6174 Produce a position independent executable on targets which support it.
6175 For predictable results, you must also specify the same set of options
6176 that were used to generate code (@option{-fpie}, @option{-fPIE},
6177 or model suboptions) when you specify this option.
6179 @item -rdynamic
6180 @opindex rdynamic
6181 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6182 that support it. This instructs the linker to add all symbols, not
6183 only used ones, to the dynamic symbol table. This option is needed
6184 for some uses of @code{dlopen} or to allow obtaining backtraces
6185 from within a program.
6187 @item -s
6188 @opindex s
6189 Remove all symbol table and relocation information from the executable.
6191 @item -static
6192 @opindex static
6193 On systems that support dynamic linking, this prevents linking with the shared
6194 libraries.  On other systems, this option has no effect.
6196 @item -shared
6197 @opindex shared
6198 Produce a shared object which can then be linked with other objects to
6199 form an executable.  Not all systems support this option.  For predictable
6200 results, you must also specify the same set of options that were used to
6201 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6202 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6203 needs to build supplementary stub code for constructors to work.  On
6204 multi-libbed systems, @samp{gcc -shared} must select the correct support
6205 libraries to link against.  Failing to supply the correct flags may lead
6206 to subtle defects.  Supplying them in cases where they are not necessary
6207 is innocuous.}
6209 @item -shared-libgcc
6210 @itemx -static-libgcc
6211 @opindex shared-libgcc
6212 @opindex static-libgcc
6213 On systems that provide @file{libgcc} as a shared library, these options
6214 force the use of either the shared or static version respectively.
6215 If no shared version of @file{libgcc} was built when the compiler was
6216 configured, these options have no effect.
6218 There are several situations in which an application should use the
6219 shared @file{libgcc} instead of the static version.  The most common
6220 of these is when the application wishes to throw and catch exceptions
6221 across different shared libraries.  In that case, each of the libraries
6222 as well as the application itself should use the shared @file{libgcc}.
6224 Therefore, the G++ and GCJ drivers automatically add
6225 @option{-shared-libgcc} whenever you build a shared library or a main
6226 executable, because C++ and Java programs typically use exceptions, so
6227 this is the right thing to do.
6229 If, instead, you use the GCC driver to create shared libraries, you may
6230 find that they will not always be linked with the shared @file{libgcc}.
6231 If GCC finds, at its configuration time, that you have a non-GNU linker
6232 or a GNU linker that does not support option @option{--eh-frame-hdr},
6233 it will link the shared version of @file{libgcc} into shared libraries
6234 by default.  Otherwise, it will take advantage of the linker and optimize
6235 away the linking with the shared version of @file{libgcc}, linking with
6236 the static version of libgcc by default.  This allows exceptions to
6237 propagate through such shared libraries, without incurring relocation
6238 costs at library load time.
6240 However, if a library or main executable is supposed to throw or catch
6241 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6242 for the languages used in the program, or using the option
6243 @option{-shared-libgcc}, such that it is linked with the shared
6244 @file{libgcc}.
6246 @item -symbolic
6247 @opindex symbolic
6248 Bind references to global symbols when building a shared object.  Warn
6249 about any unresolved references (unless overridden by the link editor
6250 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6251 this option.
6253 @item -Xlinker @var{option}
6254 @opindex Xlinker
6255 Pass @var{option} as an option to the linker.  You can use this to
6256 supply system-specific linker options which GCC does not know how to
6257 recognize.
6259 If you want to pass an option that takes an argument, you must use
6260 @option{-Xlinker} twice, once for the option and once for the argument.
6261 For example, to pass @option{-assert definitions}, you must write
6262 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6263 @option{-Xlinker "-assert definitions"}, because this passes the entire
6264 string as a single argument, which is not what the linker expects.
6266 @item -Wl,@var{option}
6267 @opindex Wl
6268 Pass @var{option} as an option to the linker.  If @var{option} contains
6269 commas, it is split into multiple options at the commas.
6271 @item -u @var{symbol}
6272 @opindex u
6273 Pretend the symbol @var{symbol} is undefined, to force linking of
6274 library modules to define it.  You can use @option{-u} multiple times with
6275 different symbols to force loading of additional library modules.
6276 @end table
6278 @node Directory Options
6279 @section Options for Directory Search
6280 @cindex directory options
6281 @cindex options, directory search
6282 @cindex search path
6284 These options specify directories to search for header files, for
6285 libraries and for parts of the compiler:
6287 @table @gcctabopt
6288 @item -I@var{dir}
6289 @opindex I
6290 Add the directory @var{dir} to the head of the list of directories to be
6291 searched for header files.  This can be used to override a system header
6292 file, substituting your own version, since these directories are
6293 searched before the system header file directories.  However, you should
6294 not use this option to add directories that contain vendor-supplied
6295 system header files (use @option{-isystem} for that).  If you use more than
6296 one @option{-I} option, the directories are scanned in left-to-right
6297 order; the standard system directories come after.
6299 If a standard system include directory, or a directory specified with
6300 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6301 option will be ignored.  The directory will still be searched but as a
6302 system directory at its normal position in the system include chain.
6303 This is to ensure that GCC's procedure to fix buggy system headers and
6304 the ordering for the include_next directive are not inadvertently changed.
6305 If you really need to change the search order for system directories,
6306 use the @option{-nostdinc} and/or @option{-isystem} options.
6308 @item -iquote@var{dir}
6309 @opindex iquote
6310 Add the directory @var{dir} to the head of the list of directories to
6311 be searched for header files only for the case of @samp{#include
6312 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6313 otherwise just like @option{-I}.
6315 @item -L@var{dir}
6316 @opindex L
6317 Add directory @var{dir} to the list of directories to be searched
6318 for @option{-l}.
6320 @item -B@var{prefix}
6321 @opindex B
6322 This option specifies where to find the executables, libraries,
6323 include files, and data files of the compiler itself.
6325 The compiler driver program runs one or more of the subprograms
6326 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6327 @var{prefix} as a prefix for each program it tries to run, both with and
6328 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6330 For each subprogram to be run, the compiler driver first tries the
6331 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6332 was not specified, the driver tries two standard prefixes, which are
6333 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6334 those results in a file name that is found, the unmodified program
6335 name is searched for using the directories specified in your
6336 @env{PATH} environment variable.
6338 The compiler will check to see if the path provided by the @option{-B}
6339 refers to a directory, and if necessary it will add a directory
6340 separator character at the end of the path.
6342 @option{-B} prefixes that effectively specify directory names also apply
6343 to libraries in the linker, because the compiler translates these
6344 options into @option{-L} options for the linker.  They also apply to
6345 includes files in the preprocessor, because the compiler translates these
6346 options into @option{-isystem} options for the preprocessor.  In this case,
6347 the compiler appends @samp{include} to the prefix.
6349 The run-time support file @file{libgcc.a} can also be searched for using
6350 the @option{-B} prefix, if needed.  If it is not found there, the two
6351 standard prefixes above are tried, and that is all.  The file is left
6352 out of the link if it is not found by those means.
6354 Another way to specify a prefix much like the @option{-B} prefix is to use
6355 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6356 Variables}.
6358 As a special kludge, if the path provided by @option{-B} is
6359 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6360 9, then it will be replaced by @file{[dir/]include}.  This is to help
6361 with boot-strapping the compiler.
6363 @item -specs=@var{file}
6364 @opindex specs
6365 Process @var{file} after the compiler reads in the standard @file{specs}
6366 file, in order to override the defaults that the @file{gcc} driver
6367 program uses when determining what switches to pass to @file{cc1},
6368 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6369 @option{-specs=@var{file}} can be specified on the command line, and they
6370 are processed in order, from left to right.
6372 @item --sysroot=@var{dir}
6373 @opindex sysroot
6374 Use @var{dir} as the logical root directory for headers and libraries.
6375 For example, if the compiler would normally search for headers in
6376 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6377 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.  
6379 If you use both this option and the @option{-isysroot} option, then
6380 the @option{--sysroot} option will apply to libraries, but the
6381 @option{-isysroot} option will apply to header files.
6383 The GNU linker (beginning with version 2.16) has the necessary support
6384 for this option.  If your linker does not support this option, the
6385 header file aspect of @option{--sysroot} will still work, but the
6386 library aspect will not.
6388 @item -I-
6389 @opindex I-
6390 This option has been deprecated.  Please use @option{-iquote} instead for
6391 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6392 Any directories you specify with @option{-I} options before the @option{-I-}
6393 option are searched only for the case of @samp{#include "@var{file}"};
6394 they are not searched for @samp{#include <@var{file}>}.
6396 If additional directories are specified with @option{-I} options after
6397 the @option{-I-}, these directories are searched for all @samp{#include}
6398 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6399 this way.)
6401 In addition, the @option{-I-} option inhibits the use of the current
6402 directory (where the current input file came from) as the first search
6403 directory for @samp{#include "@var{file}"}.  There is no way to
6404 override this effect of @option{-I-}.  With @option{-I.} you can specify
6405 searching the directory which was current when the compiler was
6406 invoked.  That is not exactly the same as what the preprocessor does
6407 by default, but it is often satisfactory.
6409 @option{-I-} does not inhibit the use of the standard system directories
6410 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6411 independent.
6412 @end table
6414 @c man end
6416 @node Spec Files
6417 @section Specifying subprocesses and the switches to pass to them
6418 @cindex Spec Files
6420 @command{gcc} is a driver program.  It performs its job by invoking a
6421 sequence of other programs to do the work of compiling, assembling and
6422 linking.  GCC interprets its command-line parameters and uses these to
6423 deduce which programs it should invoke, and which command-line options
6424 it ought to place on their command lines.  This behavior is controlled
6425 by @dfn{spec strings}.  In most cases there is one spec string for each
6426 program that GCC can invoke, but a few programs have multiple spec
6427 strings to control their behavior.  The spec strings built into GCC can
6428 be overridden by using the @option{-specs=} command-line switch to specify
6429 a spec file.
6431 @dfn{Spec files} are plaintext files that are used to construct spec
6432 strings.  They consist of a sequence of directives separated by blank
6433 lines.  The type of directive is determined by the first non-whitespace
6434 character on the line and it can be one of the following:
6436 @table @code
6437 @item %@var{command}
6438 Issues a @var{command} to the spec file processor.  The commands that can
6439 appear here are:
6441 @table @code
6442 @item %include <@var{file}>
6443 @cindex %include
6444 Search for @var{file} and insert its text at the current point in the
6445 specs file.
6447 @item %include_noerr <@var{file}>
6448 @cindex %include_noerr
6449 Just like @samp{%include}, but do not generate an error message if the include
6450 file cannot be found.
6452 @item %rename @var{old_name} @var{new_name}
6453 @cindex %rename
6454 Rename the spec string @var{old_name} to @var{new_name}.
6456 @end table
6458 @item *[@var{spec_name}]:
6459 This tells the compiler to create, override or delete the named spec
6460 string.  All lines after this directive up to the next directive or
6461 blank line are considered to be the text for the spec string.  If this
6462 results in an empty string then the spec will be deleted.  (Or, if the
6463 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6464 does not currently exist a new spec will be created.  If the spec does
6465 exist then its contents will be overridden by the text of this
6466 directive, unless the first character of that text is the @samp{+}
6467 character, in which case the text will be appended to the spec.
6469 @item [@var{suffix}]:
6470 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6471 and up to the next directive or blank line are considered to make up the
6472 spec string for the indicated suffix.  When the compiler encounters an
6473 input file with the named suffix, it will processes the spec string in
6474 order to work out how to compile that file.  For example:
6476 @smallexample
6477 .ZZ:
6478 z-compile -input %i
6479 @end smallexample
6481 This says that any input file whose name ends in @samp{.ZZ} should be
6482 passed to the program @samp{z-compile}, which should be invoked with the
6483 command-line switch @option{-input} and with the result of performing the
6484 @samp{%i} substitution.  (See below.)
6486 As an alternative to providing a spec string, the text that follows a
6487 suffix directive can be one of the following:
6489 @table @code
6490 @item @@@var{language}
6491 This says that the suffix is an alias for a known @var{language}.  This is
6492 similar to using the @option{-x} command-line switch to GCC to specify a
6493 language explicitly.  For example:
6495 @smallexample
6496 .ZZ:
6497 @@c++
6498 @end smallexample
6500 Says that .ZZ files are, in fact, C++ source files.
6502 @item #@var{name}
6503 This causes an error messages saying:
6505 @smallexample
6506 @var{name} compiler not installed on this system.
6507 @end smallexample
6508 @end table
6510 GCC already has an extensive list of suffixes built into it.
6511 This directive will add an entry to the end of the list of suffixes, but
6512 since the list is searched from the end backwards, it is effectively
6513 possible to override earlier entries using this technique.
6515 @end table
6517 GCC has the following spec strings built into it.  Spec files can
6518 override these strings or create their own.  Note that individual
6519 targets can also add their own spec strings to this list.
6521 @smallexample
6522 asm          Options to pass to the assembler
6523 asm_final    Options to pass to the assembler post-processor
6524 cpp          Options to pass to the C preprocessor
6525 cc1          Options to pass to the C compiler
6526 cc1plus      Options to pass to the C++ compiler
6527 endfile      Object files to include at the end of the link
6528 link         Options to pass to the linker
6529 lib          Libraries to include on the command line to the linker
6530 libgcc       Decides which GCC support library to pass to the linker
6531 linker       Sets the name of the linker
6532 predefines   Defines to be passed to the C preprocessor
6533 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6534              by default
6535 startfile    Object files to include at the start of the link
6536 @end smallexample
6538 Here is a small example of a spec file:
6540 @smallexample
6541 %rename lib                 old_lib
6543 *lib:
6544 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6545 @end smallexample
6547 This example renames the spec called @samp{lib} to @samp{old_lib} and
6548 then overrides the previous definition of @samp{lib} with a new one.
6549 The new definition adds in some extra command-line options before
6550 including the text of the old definition.
6552 @dfn{Spec strings} are a list of command-line options to be passed to their
6553 corresponding program.  In addition, the spec strings can contain
6554 @samp{%}-prefixed sequences to substitute variable text or to
6555 conditionally insert text into the command line.  Using these constructs
6556 it is possible to generate quite complex command lines.
6558 Here is a table of all defined @samp{%}-sequences for spec
6559 strings.  Note that spaces are not generated automatically around the
6560 results of expanding these sequences.  Therefore you can concatenate them
6561 together or combine them with constant text in a single argument.
6563 @table @code
6564 @item %%
6565 Substitute one @samp{%} into the program name or argument.
6567 @item %i
6568 Substitute the name of the input file being processed.
6570 @item %b
6571 Substitute the basename of the input file being processed.
6572 This is the substring up to (and not including) the last period
6573 and not including the directory.
6575 @item %B
6576 This is the same as @samp{%b}, but include the file suffix (text after
6577 the last period).
6579 @item %d
6580 Marks the argument containing or following the @samp{%d} as a
6581 temporary file name, so that that file will be deleted if GCC exits
6582 successfully.  Unlike @samp{%g}, this contributes no text to the
6583 argument.
6585 @item %g@var{suffix}
6586 Substitute a file name that has suffix @var{suffix} and is chosen
6587 once per compilation, and mark the argument in the same way as
6588 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6589 name is now chosen in a way that is hard to predict even when previously
6590 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6591 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6592 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6593 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6594 was simply substituted with a file name chosen once per compilation,
6595 without regard to any appended suffix (which was therefore treated
6596 just like ordinary text), making such attacks more likely to succeed.
6598 @item %u@var{suffix}
6599 Like @samp{%g}, but generates a new temporary file name even if
6600 @samp{%u@var{suffix}} was already seen.
6602 @item %U@var{suffix}
6603 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6604 new one if there is no such last file name.  In the absence of any
6605 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6606 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6607 would involve the generation of two distinct file names, one
6608 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6609 simply substituted with a file name chosen for the previous @samp{%u},
6610 without regard to any appended suffix.
6612 @item %j@var{suffix}
6613 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6614 writable, and if save-temps is off; otherwise, substitute the name
6615 of a temporary file, just like @samp{%u}.  This temporary file is not
6616 meant for communication between processes, but rather as a junk
6617 disposal mechanism.
6619 @item %|@var{suffix}
6620 @itemx %m@var{suffix}
6621 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6622 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6623 all.  These are the two most common ways to instruct a program that it
6624 should read from standard input or write to standard output.  If you
6625 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6626 construct: see for example @file{f/lang-specs.h}.
6628 @item %.@var{SUFFIX}
6629 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6630 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6631 terminated by the next space or %.
6633 @item %w
6634 Marks the argument containing or following the @samp{%w} as the
6635 designated output file of this compilation.  This puts the argument
6636 into the sequence of arguments that @samp{%o} will substitute later.
6638 @item %o
6639 Substitutes the names of all the output files, with spaces
6640 automatically placed around them.  You should write spaces
6641 around the @samp{%o} as well or the results are undefined.
6642 @samp{%o} is for use in the specs for running the linker.
6643 Input files whose names have no recognized suffix are not compiled
6644 at all, but they are included among the output files, so they will
6645 be linked.
6647 @item %O
6648 Substitutes the suffix for object files.  Note that this is
6649 handled specially when it immediately follows @samp{%g, %u, or %U},
6650 because of the need for those to form complete file names.  The
6651 handling is such that @samp{%O} is treated exactly as if it had already
6652 been substituted, except that @samp{%g, %u, and %U} do not currently
6653 support additional @var{suffix} characters following @samp{%O} as they would
6654 following, for example, @samp{.o}.
6656 @item %p
6657 Substitutes the standard macro predefinitions for the
6658 current target machine.  Use this when running @code{cpp}.
6660 @item %P
6661 Like @samp{%p}, but puts @samp{__} before and after the name of each
6662 predefined macro, except for macros that start with @samp{__} or with
6663 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6666 @item %I
6667 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6668 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6669 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6670 as necessary.
6672 @item %s
6673 Current argument is the name of a library or startup file of some sort.
6674 Search for that file in a standard list of directories and substitute
6675 the full name found.
6677 @item %e@var{str}
6678 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6679 Use this when inconsistent options are detected.
6681 @item %(@var{name})
6682 Substitute the contents of spec string @var{name} at this point.
6684 @item %[@var{name}]
6685 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6687 @item %x@{@var{option}@}
6688 Accumulate an option for @samp{%X}.
6690 @item %X
6691 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6692 spec string.
6694 @item %Y
6695 Output the accumulated assembler options specified by @option{-Wa}.
6697 @item %Z
6698 Output the accumulated preprocessor options specified by @option{-Wp}.
6700 @item %a
6701 Process the @code{asm} spec.  This is used to compute the
6702 switches to be passed to the assembler.
6704 @item %A
6705 Process the @code{asm_final} spec.  This is a spec string for
6706 passing switches to an assembler post-processor, if such a program is
6707 needed.
6709 @item %l
6710 Process the @code{link} spec.  This is the spec for computing the
6711 command line passed to the linker.  Typically it will make use of the
6712 @samp{%L %G %S %D and %E} sequences.
6714 @item %D
6715 Dump out a @option{-L} option for each directory that GCC believes might
6716 contain startup files.  If the target supports multilibs then the
6717 current multilib directory will be prepended to each of these paths.
6719 @item %L
6720 Process the @code{lib} spec.  This is a spec string for deciding which
6721 libraries should be included on the command line to the linker.
6723 @item %G
6724 Process the @code{libgcc} spec.  This is a spec string for deciding
6725 which GCC support library should be included on the command line to the linker.
6727 @item %S
6728 Process the @code{startfile} spec.  This is a spec for deciding which
6729 object files should be the first ones passed to the linker.  Typically
6730 this might be a file named @file{crt0.o}.
6732 @item %E
6733 Process the @code{endfile} spec.  This is a spec string that specifies
6734 the last object files that will be passed to the linker.
6736 @item %C
6737 Process the @code{cpp} spec.  This is used to construct the arguments
6738 to be passed to the C preprocessor.
6740 @item %1
6741 Process the @code{cc1} spec.  This is used to construct the options to be
6742 passed to the actual C compiler (@samp{cc1}).
6744 @item %2
6745 Process the @code{cc1plus} spec.  This is used to construct the options to be
6746 passed to the actual C++ compiler (@samp{cc1plus}).
6748 @item %*
6749 Substitute the variable part of a matched option.  See below.
6750 Note that each comma in the substituted string is replaced by
6751 a single space.
6753 @item %<@code{S}
6754 Remove all occurrences of @code{-S} from the command line.  Note---this
6755 command is position dependent.  @samp{%} commands in the spec string
6756 before this one will see @code{-S}, @samp{%} commands in the spec string
6757 after this one will not.
6759 @item %:@var{function}(@var{args})
6760 Call the named function @var{function}, passing it @var{args}.
6761 @var{args} is first processed as a nested spec string, then split
6762 into an argument vector in the usual fashion.  The function returns
6763 a string which is processed as if it had appeared literally as part
6764 of the current spec.
6766 The following built-in spec functions are provided:
6768 @table @code
6769 @item @code{if-exists}
6770 The @code{if-exists} spec function takes one argument, an absolute
6771 pathname to a file.  If the file exists, @code{if-exists} returns the
6772 pathname.  Here is a small example of its usage:
6774 @smallexample
6775 *startfile:
6776 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6777 @end smallexample
6779 @item @code{if-exists-else}
6780 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6781 spec function, except that it takes two arguments.  The first argument is
6782 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6783 returns the pathname.  If it does not exist, it returns the second argument.
6784 This way, @code{if-exists-else} can be used to select one file or another,
6785 based on the existence of the first.  Here is a small example of its usage:
6787 @smallexample
6788 *startfile:
6789 crt0%O%s %:if-exists(crti%O%s) \
6790 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6791 @end smallexample
6793 @item @code{replace-outfile}
6794 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6795 first argument in the outfiles array and replaces it with the second argument.  Here
6796 is a small example of its usage:
6798 @smallexample
6799 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6800 @end smallexample
6802 @end table
6804 @item %@{@code{S}@}
6805 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6806 If that switch was not specified, this substitutes nothing.  Note that
6807 the leading dash is omitted when specifying this option, and it is
6808 automatically inserted if the substitution is performed.  Thus the spec
6809 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6810 and would output the command line option @option{-foo}.
6812 @item %W@{@code{S}@}
6813 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6814 deleted on failure.
6816 @item %@{@code{S}*@}
6817 Substitutes all the switches specified to GCC whose names start
6818 with @code{-S}, but which also take an argument.  This is used for
6819 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6820 GCC considers @option{-o foo} as being
6821 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6822 text, including the space.  Thus two arguments would be generated.
6824 @item %@{@code{S}*&@code{T}*@}
6825 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6826 (the order of @code{S} and @code{T} in the spec is not significant).
6827 There can be any number of ampersand-separated variables; for each the
6828 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6830 @item %@{@code{S}:@code{X}@}
6831 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6833 @item %@{!@code{S}:@code{X}@}
6834 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6836 @item %@{@code{S}*:@code{X}@}
6837 Substitutes @code{X} if one or more switches whose names start with
6838 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6839 once, no matter how many such switches appeared.  However, if @code{%*}
6840 appears somewhere in @code{X}, then @code{X} will be substituted once
6841 for each matching switch, with the @code{%*} replaced by the part of
6842 that switch that matched the @code{*}.
6844 @item %@{.@code{S}:@code{X}@}
6845 Substitutes @code{X}, if processing a file with suffix @code{S}.
6847 @item %@{!.@code{S}:@code{X}@}
6848 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6850 @item %@{@code{S}|@code{P}:@code{X}@}
6851 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6852 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6853 although they have a stronger binding than the @samp{|}.  If @code{%*}
6854 appears in @code{X}, all of the alternatives must be starred, and only
6855 the first matching alternative is substituted.
6857 For example, a spec string like this:
6859 @smallexample
6860 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6861 @end smallexample
6863 will output the following command-line options from the following input
6864 command-line options:
6866 @smallexample
6867 fred.c        -foo -baz
6868 jim.d         -bar -boggle
6869 -d fred.c     -foo -baz -boggle
6870 -d jim.d      -bar -baz -boggle
6871 @end smallexample
6873 @item %@{S:X; T:Y; :D@}
6875 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6876 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6877 be as many clauses as you need.  This may be combined with @code{.},
6878 @code{!}, @code{|}, and @code{*} as needed.
6881 @end table
6883 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6884 construct may contain other nested @samp{%} constructs or spaces, or
6885 even newlines.  They are processed as usual, as described above.
6886 Trailing white space in @code{X} is ignored.  White space may also
6887 appear anywhere on the left side of the colon in these constructs,
6888 except between @code{.} or @code{*} and the corresponding word.
6890 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6891 handled specifically in these constructs.  If another value of
6892 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6893 @option{-W} switch is found later in the command line, the earlier
6894 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6895 just one letter, which passes all matching options.
6897 The character @samp{|} at the beginning of the predicate text is used to
6898 indicate that a command should be piped to the following command, but
6899 only if @option{-pipe} is specified.
6901 It is built into GCC which switches take arguments and which do not.
6902 (You might think it would be useful to generalize this to allow each
6903 compiler's spec to say which switches take arguments.  But this cannot
6904 be done in a consistent fashion.  GCC cannot even decide which input
6905 files have been specified without knowing which switches take arguments,
6906 and it must know which input files to compile in order to tell which
6907 compilers to run).
6909 GCC also knows implicitly that arguments starting in @option{-l} are to be
6910 treated as compiler output files, and passed to the linker in their
6911 proper position among the other output files.
6913 @c man begin OPTIONS
6915 @node Target Options
6916 @section Specifying Target Machine and Compiler Version
6917 @cindex target options
6918 @cindex cross compiling
6919 @cindex specifying machine version
6920 @cindex specifying compiler version and target machine
6921 @cindex compiler version, specifying
6922 @cindex target machine, specifying
6924 The usual way to run GCC is to run the executable called @file{gcc}, or
6925 @file{<machine>-gcc} when cross-compiling, or
6926 @file{<machine>-gcc-<version>} to run a version other than the one that
6927 was installed last.  Sometimes this is inconvenient, so GCC provides
6928 options that will switch to another cross-compiler or version.
6930 @table @gcctabopt
6931 @item -b @var{machine}
6932 @opindex b
6933 The argument @var{machine} specifies the target machine for compilation.
6935 The value to use for @var{machine} is the same as was specified as the
6936 machine type when configuring GCC as a cross-compiler.  For
6937 example, if a cross-compiler was configured with @samp{configure
6938 i386v}, meaning to compile for an 80386 running System V, then you
6939 would specify @option{-b i386v} to run that cross compiler.
6941 @item -V @var{version}
6942 @opindex V
6943 The argument @var{version} specifies which version of GCC to run.
6944 This is useful when multiple versions are installed.  For example,
6945 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6946 @end table
6948 The @option{-V} and @option{-b} options work by running the
6949 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6950 use them if you can just run that directly.
6952 @node Submodel Options
6953 @section Hardware Models and Configurations
6954 @cindex submodel options
6955 @cindex specifying hardware config
6956 @cindex hardware models and configurations, specifying
6957 @cindex machine dependent options
6959 Earlier we discussed the standard option @option{-b} which chooses among
6960 different installed compilers for completely different target
6961 machines, such as VAX vs.@: 68000 vs.@: 80386.
6963 In addition, each of these target machine types can have its own
6964 special options, starting with @samp{-m}, to choose among various
6965 hardware models or configurations---for example, 68010 vs 68020,
6966 floating coprocessor or none.  A single installed version of the
6967 compiler can compile for any model or configuration, according to the
6968 options specified.
6970 Some configurations of the compiler also support additional special
6971 options, usually for compatibility with other compilers on the same
6972 platform.
6974 @c This list is ordered alphanumerically by subsection name.
6975 @c It should be the same order and spelling as these options are listed
6976 @c in Machine Dependent Options
6978 @menu
6979 * ARC Options::
6980 * ARM Options::
6981 * AVR Options::
6982 * Blackfin Options::
6983 * CRIS Options::
6984 * Darwin Options::
6985 * DEC Alpha Options::
6986 * DEC Alpha/VMS Options::
6987 * FRV Options::
6988 * H8/300 Options::
6989 * HPPA Options::
6990 * i386 and x86-64 Options::
6991 * IA-64 Options::
6992 * M32C Options::
6993 * M32R/D Options::
6994 * M680x0 Options::
6995 * M68hc1x Options::
6996 * MCore Options::
6997 * MIPS Options::
6998 * MMIX Options::
6999 * MN10300 Options::
7000 * PDP-11 Options::
7001 * PowerPC Options::
7002 * RS/6000 and PowerPC Options::
7003 * S/390 and zSeries Options::
7004 * SH Options::
7005 * SPARC Options::
7006 * System V Options::
7007 * TMS320C3x/C4x Options::
7008 * V850 Options::
7009 * VAX Options::
7010 * x86-64 Options::
7011 * Xstormy16 Options::
7012 * Xtensa Options::
7013 * zSeries Options::
7014 @end menu
7016 @node ARC Options
7017 @subsection ARC Options
7018 @cindex ARC Options
7020 These options are defined for ARC implementations:
7022 @table @gcctabopt
7023 @item -EL
7024 @opindex EL
7025 Compile code for little endian mode.  This is the default.
7027 @item -EB
7028 @opindex EB
7029 Compile code for big endian mode.
7031 @item -mmangle-cpu
7032 @opindex mmangle-cpu
7033 Prepend the name of the cpu to all public symbol names.
7034 In multiple-processor systems, there are many ARC variants with different
7035 instruction and register set characteristics.  This flag prevents code
7036 compiled for one cpu to be linked with code compiled for another.
7037 No facility exists for handling variants that are ``almost identical''.
7038 This is an all or nothing option.
7040 @item -mcpu=@var{cpu}
7041 @opindex mcpu
7042 Compile code for ARC variant @var{cpu}.
7043 Which variants are supported depend on the configuration.
7044 All variants support @option{-mcpu=base}, this is the default.
7046 @item -mtext=@var{text-section}
7047 @itemx -mdata=@var{data-section}
7048 @itemx -mrodata=@var{readonly-data-section}
7049 @opindex mtext
7050 @opindex mdata
7051 @opindex mrodata
7052 Put functions, data, and readonly data in @var{text-section},
7053 @var{data-section}, and @var{readonly-data-section} respectively
7054 by default.  This can be overridden with the @code{section} attribute.
7055 @xref{Variable Attributes}.
7057 @end table
7059 @node ARM Options
7060 @subsection ARM Options
7061 @cindex ARM options
7063 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7064 architectures:
7066 @table @gcctabopt
7067 @item -mabi=@var{name}
7068 @opindex mabi
7069 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
7070 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
7072 @item -mapcs-frame
7073 @opindex mapcs-frame
7074 Generate a stack frame that is compliant with the ARM Procedure Call
7075 Standard for all functions, even if this is not strictly necessary for
7076 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
7077 with this option will cause the stack frames not to be generated for
7078 leaf functions.  The default is @option{-mno-apcs-frame}.
7080 @item -mapcs
7081 @opindex mapcs
7082 This is a synonym for @option{-mapcs-frame}.
7084 @ignore
7085 @c not currently implemented
7086 @item -mapcs-stack-check
7087 @opindex mapcs-stack-check
7088 Generate code to check the amount of stack space available upon entry to
7089 every function (that actually uses some stack space).  If there is
7090 insufficient space available then either the function
7091 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7092 called, depending upon the amount of stack space required.  The run time
7093 system is required to provide these functions.  The default is
7094 @option{-mno-apcs-stack-check}, since this produces smaller code.
7096 @c not currently implemented
7097 @item -mapcs-float
7098 @opindex mapcs-float
7099 Pass floating point arguments using the float point registers.  This is
7100 one of the variants of the APCS@.  This option is recommended if the
7101 target hardware has a floating point unit or if a lot of floating point
7102 arithmetic is going to be performed by the code.  The default is
7103 @option{-mno-apcs-float}, since integer only code is slightly increased in
7104 size if @option{-mapcs-float} is used.
7106 @c not currently implemented
7107 @item -mapcs-reentrant
7108 @opindex mapcs-reentrant
7109 Generate reentrant, position independent code.  The default is
7110 @option{-mno-apcs-reentrant}.
7111 @end ignore
7113 @item -mthumb-interwork
7114 @opindex mthumb-interwork
7115 Generate code which supports calling between the ARM and Thumb
7116 instruction sets.  Without this option the two instruction sets cannot
7117 be reliably used inside one program.  The default is
7118 @option{-mno-thumb-interwork}, since slightly larger code is generated
7119 when @option{-mthumb-interwork} is specified.
7121 @item -mno-sched-prolog
7122 @opindex mno-sched-prolog
7123 Prevent the reordering of instructions in the function prolog, or the
7124 merging of those instruction with the instructions in the function's
7125 body.  This means that all functions will start with a recognizable set
7126 of instructions (or in fact one of a choice from a small set of
7127 different function prologues), and this information can be used to
7128 locate the start if functions inside an executable piece of code.  The
7129 default is @option{-msched-prolog}.
7131 @item -mhard-float
7132 @opindex mhard-float
7133 Generate output containing floating point instructions.  This is the
7134 default.
7136 @item -msoft-float
7137 @opindex msoft-float
7138 Generate output containing library calls for floating point.
7139 @strong{Warning:} the requisite libraries are not available for all ARM
7140 targets.  Normally the facilities of the machine's usual C compiler are
7141 used, but this cannot be done directly in cross-compilation.  You must make
7142 your own arrangements to provide suitable library functions for
7143 cross-compilation.
7145 @option{-msoft-float} changes the calling convention in the output file;
7146 therefore, it is only useful if you compile @emph{all} of a program with
7147 this option.  In particular, you need to compile @file{libgcc.a}, the
7148 library that comes with GCC, with @option{-msoft-float} in order for
7149 this to work.
7151 @item -mfloat-abi=@var{name}
7152 @opindex mfloat-abi
7153 Specifies which ABI to use for floating point values.  Permissible values
7154 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7156 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7157 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
7158 of floating point instructions, but still uses the soft-float calling
7159 conventions.
7161 @item -mlittle-endian
7162 @opindex mlittle-endian
7163 Generate code for a processor running in little-endian mode.  This is
7164 the default for all standard configurations.
7166 @item -mbig-endian
7167 @opindex mbig-endian
7168 Generate code for a processor running in big-endian mode; the default is
7169 to compile code for a little-endian processor.
7171 @item -mwords-little-endian
7172 @opindex mwords-little-endian
7173 This option only applies when generating code for big-endian processors.
7174 Generate code for a little-endian word order but a big-endian byte
7175 order.  That is, a byte order of the form @samp{32107654}.  Note: this
7176 option should only be used if you require compatibility with code for
7177 big-endian ARM processors generated by versions of the compiler prior to
7178 2.8.
7180 @item -mcpu=@var{name}
7181 @opindex mcpu
7182 This specifies the name of the target ARM processor.  GCC uses this name
7183 to determine what kind of instructions it can emit when generating
7184 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
7185 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7186 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7187 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7188 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7189 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7190 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7191 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7192 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7193 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7194 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7195 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7196 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7197 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7198 @samp{ep9312}.
7200 @itemx -mtune=@var{name}
7201 @opindex mtune
7202 This option is very similar to the @option{-mcpu=} option, except that
7203 instead of specifying the actual target processor type, and hence
7204 restricting which instructions can be used, it specifies that GCC should
7205 tune the performance of the code as if the target were of the type
7206 specified in this option, but still choosing the instructions that it
7207 will generate based on the cpu specified by a @option{-mcpu=} option.
7208 For some ARM implementations better performance can be obtained by using
7209 this option.
7211 @item -march=@var{name}
7212 @opindex march
7213 This specifies the name of the target ARM architecture.  GCC uses this
7214 name to determine what kind of instructions it can emit when generating
7215 assembly code.  This option can be used in conjunction with or instead
7216 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
7217 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7218 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7219 @samp{iwmmxt}, @samp{ep9312}.
7221 @item -mfpu=@var{name}
7222 @itemx -mfpe=@var{number}
7223 @itemx -mfp=@var{number}
7224 @opindex mfpu
7225 @opindex mfpe
7226 @opindex mfp
7227 This specifies what floating point hardware (or hardware emulation) is
7228 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
7229 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
7230 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7231 with older versions of GCC@.
7233 If @option{-msoft-float} is specified this specifies the format of
7234 floating point values.
7236 @item -mstructure-size-boundary=@var{n}
7237 @opindex mstructure-size-boundary
7238 The size of all structures and unions will be rounded up to a multiple
7239 of the number of bits set by this option.  Permissible values are 8, 32
7240 and 64.  The default value varies for different toolchains.  For the COFF
7241 targeted toolchain the default value is 8.  A value of 64 is only allowed
7242 if the underlying ABI supports it.
7244 Specifying the larger number can produce faster, more efficient code, but
7245 can also increase the size of the program.  Different values are potentially
7246 incompatible.  Code compiled with one value cannot necessarily expect to
7247 work with code or libraries compiled with another value, if they exchange
7248 information using structures or unions.
7250 @item -mabort-on-noreturn
7251 @opindex mabort-on-noreturn
7252 Generate a call to the function @code{abort} at the end of a
7253 @code{noreturn} function.  It will be executed if the function tries to
7254 return.
7256 @item -mlong-calls
7257 @itemx -mno-long-calls
7258 @opindex mlong-calls
7259 @opindex mno-long-calls
7260 Tells the compiler to perform function calls by first loading the
7261 address of the function into a register and then performing a subroutine
7262 call on this register.  This switch is needed if the target function
7263 will lie outside of the 64 megabyte addressing range of the offset based
7264 version of subroutine call instruction.
7266 Even if this switch is enabled, not all function calls will be turned
7267 into long calls.  The heuristic is that static functions, functions
7268 which have the @samp{short-call} attribute, functions that are inside
7269 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7270 definitions have already been compiled within the current compilation
7271 unit, will not be turned into long calls.  The exception to this rule is
7272 that weak function definitions, functions with the @samp{long-call}
7273 attribute or the @samp{section} attribute, and functions that are within
7274 the scope of a @samp{#pragma long_calls} directive, will always be
7275 turned into long calls.
7277 This feature is not enabled by default.  Specifying
7278 @option{-mno-long-calls} will restore the default behavior, as will
7279 placing the function calls within the scope of a @samp{#pragma
7280 long_calls_off} directive.  Note these switches have no effect on how
7281 the compiler generates code to handle function calls via function
7282 pointers.
7284 @item -mnop-fun-dllimport
7285 @opindex mnop-fun-dllimport
7286 Disable support for the @code{dllimport} attribute.
7288 @item -msingle-pic-base
7289 @opindex msingle-pic-base
7290 Treat the register used for PIC addressing as read-only, rather than
7291 loading it in the prologue for each function.  The run-time system is
7292 responsible for initializing this register with an appropriate value
7293 before execution begins.
7295 @item -mpic-register=@var{reg}
7296 @opindex mpic-register
7297 Specify the register to be used for PIC addressing.  The default is R10
7298 unless stack-checking is enabled, when R9 is used.
7300 @item -mcirrus-fix-invalid-insns
7301 @opindex mcirrus-fix-invalid-insns
7302 @opindex mno-cirrus-fix-invalid-insns
7303 Insert NOPs into the instruction stream to in order to work around
7304 problems with invalid Maverick instruction combinations.  This option
7305 is only valid if the @option{-mcpu=ep9312} option has been used to
7306 enable generation of instructions for the Cirrus Maverick floating
7307 point co-processor.  This option is not enabled by default, since the
7308 problem is only present in older Maverick implementations.  The default
7309 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7310 switch.
7312 @item -mpoke-function-name
7313 @opindex mpoke-function-name
7314 Write the name of each function into the text section, directly
7315 preceding the function prologue.  The generated code is similar to this:
7317 @smallexample
7318      t0
7319          .ascii "arm_poke_function_name", 0
7320          .align
7321      t1
7322          .word 0xff000000 + (t1 - t0)
7323      arm_poke_function_name
7324          mov     ip, sp
7325          stmfd   sp!, @{fp, ip, lr, pc@}
7326          sub     fp, ip, #4
7327 @end smallexample
7329 When performing a stack backtrace, code can inspect the value of
7330 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7331 location @code{pc - 12} and the top 8 bits are set, then we know that
7332 there is a function name embedded immediately preceding this location
7333 and has length @code{((pc[-3]) & 0xff000000)}.
7335 @item -mthumb
7336 @opindex mthumb
7337 Generate code for the 16-bit Thumb instruction set.  The default is to
7338 use the 32-bit ARM instruction set.
7340 @item -mtpcs-frame
7341 @opindex mtpcs-frame
7342 Generate a stack frame that is compliant with the Thumb Procedure Call
7343 Standard for all non-leaf functions.  (A leaf function is one that does
7344 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7346 @item -mtpcs-leaf-frame
7347 @opindex mtpcs-leaf-frame
7348 Generate a stack frame that is compliant with the Thumb Procedure Call
7349 Standard for all leaf functions.  (A leaf function is one that does
7350 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7352 @item -mcallee-super-interworking
7353 @opindex mcallee-super-interworking
7354 Gives all externally visible functions in the file being compiled an ARM
7355 instruction set header which switches to Thumb mode before executing the
7356 rest of the function.  This allows these functions to be called from
7357 non-interworking code.
7359 @item -mcaller-super-interworking
7360 @opindex mcaller-super-interworking
7361 Allows calls via function pointers (including virtual functions) to
7362 execute correctly regardless of whether the target code has been
7363 compiled for interworking or not.  There is a small overhead in the cost
7364 of executing a function pointer if this option is enabled.
7366 @end table
7368 @node AVR Options
7369 @subsection AVR Options
7370 @cindex AVR Options
7372 These options are defined for AVR implementations:
7374 @table @gcctabopt
7375 @item -mmcu=@var{mcu}
7376 @opindex mmcu
7377 Specify ATMEL AVR instruction set or MCU type.
7379 Instruction set avr1 is for the minimal AVR core, not supported by the C
7380 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7381 attiny11, attiny12, attiny15, attiny28).
7383 Instruction set avr2 (default) is for the classic AVR core with up to
7384 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7385 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7386 at90c8534, at90s8535).
7388 Instruction set avr3 is for the classic AVR core with up to 128K program
7389 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7391 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7392 memory space (MCU types: atmega8, atmega83, atmega85).
7394 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7395 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7396 atmega64, atmega128, at43usb355, at94k).
7398 @item -msize
7399 @opindex msize
7400 Output instruction sizes to the asm file.
7402 @item -minit-stack=@var{N}
7403 @opindex minit-stack
7404 Specify the initial stack address, which may be a symbol or numeric value,
7405 @samp{__stack} is the default.
7407 @item -mno-interrupts
7408 @opindex mno-interrupts
7409 Generated code is not compatible with hardware interrupts.
7410 Code size will be smaller.
7412 @item -mcall-prologues
7413 @opindex mcall-prologues
7414 Functions prologues/epilogues expanded as call to appropriate
7415 subroutines.  Code size will be smaller.
7417 @item -mno-tablejump
7418 @opindex mno-tablejump
7419 Do not generate tablejump insns which sometimes increase code size.
7421 @item -mtiny-stack
7422 @opindex mtiny-stack
7423 Change only the low 8 bits of the stack pointer.
7425 @item -mint8
7426 @opindex mint8
7427 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7428 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7429 and long long will be 4 bytes.  Please note that this option does not
7430 comply to the C standards, but it will provide you with smaller code
7431 size.
7432 @end table
7434 @node Blackfin Options
7435 @subsection Blackfin Options
7436 @cindex Blackfin Options
7438 @table @gcctabopt
7439 @item -momit-leaf-frame-pointer
7440 @opindex momit-leaf-frame-pointer
7441 Don't keep the frame pointer in a register for leaf functions.  This
7442 avoids the instructions to save, set up and restore frame pointers and
7443 makes an extra register available in leaf functions.  The option
7444 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7445 which might make debugging harder.
7447 @item -mspecld-anomaly
7448 @opindex mspecld-anomaly
7449 When enabled, the compiler will ensure that the generated code does not
7450 contain speculative loads after jump instructions.  This option is enabled
7451 by default.
7453 @item -mno-specld-anomaly
7454 @opindex mno-specld-anomaly
7455 Don't generate extra code to prevent speculative loads from occurring.
7457 @item -mcsync-anomaly
7458 @opindex mcsync-anomaly
7459 When enabled, the compiler will ensure that the generated code does not
7460 contain CSYNC or SSYNC instructions too soon after conditional branches.
7461 This option is enabled by default.
7463 @item -mno-csync-anomaly
7464 @opindex mno-csync-anomaly
7465 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7466 occurring too soon after a conditional branch.
7468 @item -mlow-64k
7469 @opindex mlow-64k
7470 When enabled, the compiler is free to take advantage of the knowledge that
7471 the entire program fits into the low 64k of memory.
7473 @item -mno-low-64k
7474 @opindex mno-low-64k
7475 Assume that the program is arbitrarily large.  This is the default.
7477 @item -mid-shared-library
7478 @opindex mid-shared-library
7479 Generate code that supports shared libraries via the library ID method.
7480 This allows for execute in place and shared libraries in an environment
7481 without virtual memory management.  This option implies @option{-fPIC}.
7483 @item -mno-id-shared-library
7484 @opindex mno-id-shared-library
7485 Generate code that doesn't assume ID based shared libraries are being used.
7486 This is the default.
7488 @item -mshared-library-id=n
7489 @opindex mshared-library-id
7490 Specified the identification number of the ID based shared library being
7491 compiled.  Specifying a value of 0 will generate more compact code, specifying
7492 other values will force the allocation of that number to the current
7493 library but is no more space or time efficient than omitting this option.
7495 @item -mlong-calls
7496 @itemx -mno-long-calls
7497 @opindex mlong-calls
7498 @opindex mno-long-calls
7499 Tells the compiler to perform function calls by first loading the
7500 address of the function into a register and then performing a subroutine
7501 call on this register.  This switch is needed if the target function
7502 will lie outside of the 24 bit addressing range of the offset based
7503 version of subroutine call instruction.
7505 This feature is not enabled by default.  Specifying
7506 @option{-mno-long-calls} will restore the default behavior.  Note these
7507 switches have no effect on how the compiler generates code to handle
7508 function calls via function pointers.
7509 @end table
7511 @node CRIS Options
7512 @subsection CRIS Options
7513 @cindex CRIS Options
7515 These options are defined specifically for the CRIS ports.
7517 @table @gcctabopt
7518 @item -march=@var{architecture-type}
7519 @itemx -mcpu=@var{architecture-type}
7520 @opindex march
7521 @opindex mcpu
7522 Generate code for the specified architecture.  The choices for
7523 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7524 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7525 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7526 @samp{v10}.
7528 @item -mtune=@var{architecture-type}
7529 @opindex mtune
7530 Tune to @var{architecture-type} everything applicable about the generated
7531 code, except for the ABI and the set of available instructions.  The
7532 choices for @var{architecture-type} are the same as for
7533 @option{-march=@var{architecture-type}}.
7535 @item -mmax-stack-frame=@var{n}
7536 @opindex mmax-stack-frame
7537 Warn when the stack frame of a function exceeds @var{n} bytes.
7539 @item -melinux-stacksize=@var{n}
7540 @opindex melinux-stacksize
7541 Only available with the @samp{cris-axis-aout} target.  Arranges for
7542 indications in the program to the kernel loader that the stack of the
7543 program should be set to @var{n} bytes.
7545 @item -metrax4
7546 @itemx -metrax100
7547 @opindex metrax4
7548 @opindex metrax100
7549 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7550 @option{-march=v3} and @option{-march=v8} respectively.
7552 @item -mmul-bug-workaround
7553 @itemx -mno-mul-bug-workaround
7554 @opindex mmul-bug-workaround
7555 @opindex mno-mul-bug-workaround
7556 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7557 models where it applies.  This option is active by default.
7559 @item -mpdebug
7560 @opindex mpdebug
7561 Enable CRIS-specific verbose debug-related information in the assembly
7562 code.  This option also has the effect to turn off the @samp{#NO_APP}
7563 formatted-code indicator to the assembler at the beginning of the
7564 assembly file.
7566 @item -mcc-init
7567 @opindex mcc-init
7568 Do not use condition-code results from previous instruction; always emit
7569 compare and test instructions before use of condition codes.
7571 @item -mno-side-effects
7572 @opindex mno-side-effects
7573 Do not emit instructions with side-effects in addressing modes other than
7574 post-increment.
7576 @item -mstack-align
7577 @itemx -mno-stack-align
7578 @itemx -mdata-align
7579 @itemx -mno-data-align
7580 @itemx -mconst-align
7581 @itemx -mno-const-align
7582 @opindex mstack-align
7583 @opindex mno-stack-align
7584 @opindex mdata-align
7585 @opindex mno-data-align
7586 @opindex mconst-align
7587 @opindex mno-const-align
7588 These options (no-options) arranges (eliminate arrangements) for the
7589 stack-frame, individual data and constants to be aligned for the maximum
7590 single data access size for the chosen CPU model.  The default is to
7591 arrange for 32-bit alignment.  ABI details such as structure layout are
7592 not affected by these options.
7594 @item -m32-bit
7595 @itemx -m16-bit
7596 @itemx -m8-bit
7597 @opindex m32-bit
7598 @opindex m16-bit
7599 @opindex m8-bit
7600 Similar to the stack- data- and const-align options above, these options
7601 arrange for stack-frame, writable data and constants to all be 32-bit,
7602 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7604 @item -mno-prologue-epilogue
7605 @itemx -mprologue-epilogue
7606 @opindex mno-prologue-epilogue
7607 @opindex mprologue-epilogue
7608 With @option{-mno-prologue-epilogue}, the normal function prologue and
7609 epilogue that sets up the stack-frame are omitted and no return
7610 instructions or return sequences are generated in the code.  Use this
7611 option only together with visual inspection of the compiled code: no
7612 warnings or errors are generated when call-saved registers must be saved,
7613 or storage for local variable needs to be allocated.
7615 @item -mno-gotplt
7616 @itemx -mgotplt
7617 @opindex mno-gotplt
7618 @opindex mgotplt
7619 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7620 instruction sequences that load addresses for functions from the PLT part
7621 of the GOT rather than (traditional on other architectures) calls to the
7622 PLT@.  The default is @option{-mgotplt}.
7624 @item -maout
7625 @opindex maout
7626 Legacy no-op option only recognized with the cris-axis-aout target.
7628 @item -melf
7629 @opindex melf
7630 Legacy no-op option only recognized with the cris-axis-elf and
7631 cris-axis-linux-gnu targets.
7633 @item -melinux
7634 @opindex melinux
7635 Only recognized with the cris-axis-aout target, where it selects a
7636 GNU/linux-like multilib, include files and instruction set for
7637 @option{-march=v8}.
7639 @item -mlinux
7640 @opindex mlinux
7641 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7643 @item -sim
7644 @opindex sim
7645 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7646 to link with input-output functions from a simulator library.  Code,
7647 initialized data and zero-initialized data are allocated consecutively.
7649 @item -sim2
7650 @opindex sim2
7651 Like @option{-sim}, but pass linker options to locate initialized data at
7652 0x40000000 and zero-initialized data at 0x80000000.
7653 @end table
7655 @node Darwin Options
7656 @subsection Darwin Options
7657 @cindex Darwin options
7659 These options are defined for all architectures running the Darwin operating
7660 system.
7662 FSF GCC on Darwin does not create ``fat'' object files; it will create
7663 an object file for the single architecture that it was built to
7664 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7665 @option{-arch} options are used; it does so by running the compiler or
7666 linker multiple times and joining the results together with
7667 @file{lipo}.
7669 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7670 @samp{i686}) is determined by the flags that specify the ISA
7671 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7672 @option{-force_cpusubtype_ALL} option can be used to override this.
7674 The Darwin tools vary in their behavior when presented with an ISA
7675 mismatch.  The assembler, @file{as}, will only permit instructions to
7676 be used that are valid for the subtype of the file it is generating,
7677 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7678 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7679 and print an error if asked to create a shared library with a less
7680 restrictive subtype than its input files (for instance, trying to put
7681 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7682 for executables, @file{ld}, will quietly give the executable the most
7683 restrictive subtype of any of its input files.
7685 @table @gcctabopt
7686 @item -F@var{dir}
7687 @opindex F
7688 Add the framework directory @var{dir} to the head of the list of
7689 directories to be searched for header files.  These directories are
7690 interleaved with those specified by @option{-I} options and are
7691 scanned in a left-to-right order.
7693 A framework directory is a directory with frameworks in it.  A
7694 framework is a directory with a @samp{"Headers"} and/or
7695 @samp{"PrivateHeaders"} directory contained directly in it that ends
7696 in @samp{".framework"}.  The name of a framework is the name of this
7697 directory excluding the @samp{".framework"}.  Headers associated with
7698 the framework are found in one of those two directories, with
7699 @samp{"Headers"} being searched first.  A subframework is a framework
7700 directory that is in a framework's @samp{"Frameworks"} directory.
7701 Includes of subframework headers can only appear in a header of a
7702 framework that contains the subframework, or in a sibling subframework
7703 header.  Two subframeworks are siblings if they occur in the same
7704 framework.  A subframework should not have the same name as a
7705 framework, a warning will be issued if this is violated.  Currently a
7706 subframework cannot have subframeworks, in the future, the mechanism
7707 may be extended to support this.  The standard frameworks can be found
7708 in @samp{"/System/Library/Frameworks"} and
7709 @samp{"/Library/Frameworks"}.  An example include looks like
7710 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7711 the name of the framework and header.h is found in the
7712 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7714 @item -gused
7715 @opindex -gused
7716 Emit debugging information for symbols that are used.  For STABS
7717 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7718 This is by default ON@.
7720 @item -gfull
7721 @opindex -gfull
7722 Emit debugging information for all symbols and types.
7724 @item -mmacosx-version-min=@var{version}
7725 The earliest version of MacOS X that this executable will run on
7726 is @var{version}.  Typical values of @var{version} include @code{10.1},
7727 @code{10.2}, and @code{10.3.9}.
7729 The default for this option is to make choices that seem to be most
7730 useful.  
7732 @item -mone-byte-bool
7733 @opindex -mone-byte-bool
7734 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7735 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7736 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7737 option has no effect on x86.
7739 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7740 to generate code that is not binary compatible with code generated
7741 without that switch.  Using this switch may require recompiling all
7742 other modules in a program, including system libraries.  Use this
7743 switch to conform to a non-default data model.
7745 @item -mfix-and-continue
7746 @itemx -ffix-and-continue
7747 @itemx -findirect-data
7748 @opindex mfix-and-continue
7749 @opindex ffix-and-continue
7750 @opindex findirect-data
7751 Generate code suitable for fast turn around development.  Needed to
7752 enable gdb to dynamically load @code{.o} files into already running
7753 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7754 are provided for backwards compatibility.
7756 @item -all_load
7757 @opindex all_load
7758 Loads all members of static archive libraries.
7759 See man ld(1) for more information.
7761 @item -arch_errors_fatal
7762 @opindex arch_errors_fatal
7763 Cause the errors having to do with files that have the wrong architecture
7764 to be fatal.
7766 @item -bind_at_load
7767 @opindex bind_at_load
7768 Causes the output file to be marked such that the dynamic linker will
7769 bind all undefined references when the file is loaded or launched.
7771 @item -bundle
7772 @opindex bundle
7773 Produce a Mach-o bundle format file.
7774 See man ld(1) for more information.
7776 @item -bundle_loader @var{executable}
7777 @opindex bundle_loader
7778 This option specifies the @var{executable} that will be loading the build
7779 output file being linked.  See man ld(1) for more information.
7781 @item -dynamiclib
7782 @opindex -dynamiclib
7783 When passed this option, GCC will produce a dynamic library instead of
7784 an executable when linking, using the Darwin @file{libtool} command.
7786 @item -force_cpusubtype_ALL
7787 @opindex -force_cpusubtype_ALL
7788 This causes GCC's output file to have the @var{ALL} subtype, instead of
7789 one controlled by the @option{-mcpu} or @option{-march} option.
7791 @item -allowable_client  @var{client_name}
7792 @itemx -client_name
7793 @itemx -compatibility_version
7794 @itemx -current_version
7795 @itemx -dead_strip
7796 @itemx -dependency-file
7797 @itemx -dylib_file
7798 @itemx -dylinker_install_name
7799 @itemx -dynamic
7800 @itemx -exported_symbols_list
7801 @itemx -filelist
7802 @itemx -flat_namespace
7803 @itemx -force_flat_namespace
7804 @itemx -headerpad_max_install_names
7805 @itemx -image_base
7806 @itemx -init
7807 @itemx -install_name
7808 @itemx -keep_private_externs
7809 @itemx -multi_module
7810 @itemx -multiply_defined
7811 @itemx -multiply_defined_unused
7812 @itemx -noall_load
7813 @itemx -no_dead_strip_inits_and_terms
7814 @itemx -nofixprebinding
7815 @itemx -nomultidefs
7816 @itemx -noprebind
7817 @itemx -noseglinkedit
7818 @itemx -pagezero_size
7819 @itemx -prebind
7820 @itemx -prebind_all_twolevel_modules
7821 @itemx -private_bundle
7822 @itemx -read_only_relocs
7823 @itemx -sectalign
7824 @itemx -sectobjectsymbols
7825 @itemx -whyload
7826 @itemx -seg1addr
7827 @itemx -sectcreate
7828 @itemx -sectobjectsymbols
7829 @itemx -sectorder
7830 @itemx -segaddr
7831 @itemx -segs_read_only_addr
7832 @itemx -segs_read_write_addr
7833 @itemx -seg_addr_table
7834 @itemx -seg_addr_table_filename
7835 @itemx -seglinkedit
7836 @itemx -segprot
7837 @itemx -segs_read_only_addr
7838 @itemx -segs_read_write_addr
7839 @itemx -single_module
7840 @itemx -static
7841 @itemx -sub_library
7842 @itemx -sub_umbrella
7843 @itemx -twolevel_namespace
7844 @itemx -umbrella
7845 @itemx -undefined
7846 @itemx -unexported_symbols_list
7847 @itemx -weak_reference_mismatches
7848 @itemx -whatsloaded
7850 @opindex allowable_client
7851 @opindex client_name
7852 @opindex compatibility_version
7853 @opindex current_version
7854 @opindex dead_strip
7855 @opindex dependency-file
7856 @opindex dylib_file
7857 @opindex dylinker_install_name
7858 @opindex dynamic
7859 @opindex exported_symbols_list
7860 @opindex filelist
7861 @opindex flat_namespace
7862 @opindex force_flat_namespace
7863 @opindex headerpad_max_install_names
7864 @opindex image_base
7865 @opindex init
7866 @opindex install_name
7867 @opindex keep_private_externs
7868 @opindex multi_module
7869 @opindex multiply_defined
7870 @opindex multiply_defined_unused
7871 @opindex noall_load
7872 @opindex no_dead_strip_inits_and_terms
7873 @opindex nofixprebinding
7874 @opindex nomultidefs
7875 @opindex noprebind
7876 @opindex noseglinkedit
7877 @opindex pagezero_size
7878 @opindex prebind
7879 @opindex prebind_all_twolevel_modules
7880 @opindex private_bundle
7881 @opindex read_only_relocs
7882 @opindex sectalign
7883 @opindex sectobjectsymbols
7884 @opindex whyload
7885 @opindex seg1addr
7886 @opindex sectcreate
7887 @opindex sectobjectsymbols
7888 @opindex sectorder
7889 @opindex segaddr
7890 @opindex segs_read_only_addr
7891 @opindex segs_read_write_addr
7892 @opindex seg_addr_table
7893 @opindex seg_addr_table_filename
7894 @opindex seglinkedit
7895 @opindex segprot
7896 @opindex segs_read_only_addr
7897 @opindex segs_read_write_addr
7898 @opindex single_module
7899 @opindex static
7900 @opindex sub_library
7901 @opindex sub_umbrella
7902 @opindex twolevel_namespace
7903 @opindex umbrella
7904 @opindex undefined
7905 @opindex unexported_symbols_list
7906 @opindex weak_reference_mismatches
7907 @opindex whatsloaded
7909 These options are passed to the Darwin linker.  The Darwin linker man page
7910 describes them in detail.
7911 @end table
7913 @node DEC Alpha Options
7914 @subsection DEC Alpha Options
7916 These @samp{-m} options are defined for the DEC Alpha implementations:
7918 @table @gcctabopt
7919 @item -mno-soft-float
7920 @itemx -msoft-float
7921 @opindex mno-soft-float
7922 @opindex msoft-float
7923 Use (do not use) the hardware floating-point instructions for
7924 floating-point operations.  When @option{-msoft-float} is specified,
7925 functions in @file{libgcc.a} will be used to perform floating-point
7926 operations.  Unless they are replaced by routines that emulate the
7927 floating-point operations, or compiled in such a way as to call such
7928 emulations routines, these routines will issue floating-point
7929 operations.   If you are compiling for an Alpha without floating-point
7930 operations, you must ensure that the library is built so as not to call
7931 them.
7933 Note that Alpha implementations without floating-point operations are
7934 required to have floating-point registers.
7936 @item -mfp-reg
7937 @itemx -mno-fp-regs
7938 @opindex mfp-reg
7939 @opindex mno-fp-regs
7940 Generate code that uses (does not use) the floating-point register set.
7941 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7942 register set is not used, floating point operands are passed in integer
7943 registers as if they were integers and floating-point results are passed
7944 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7945 so any function with a floating-point argument or return value called by code
7946 compiled with @option{-mno-fp-regs} must also be compiled with that
7947 option.
7949 A typical use of this option is building a kernel that does not use,
7950 and hence need not save and restore, any floating-point registers.
7952 @item -mieee
7953 @opindex mieee
7954 The Alpha architecture implements floating-point hardware optimized for
7955 maximum performance.  It is mostly compliant with the IEEE floating
7956 point standard.  However, for full compliance, software assistance is
7957 required.  This option generates code fully IEEE compliant code
7958 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7959 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7960 defined during compilation.  The resulting code is less efficient but is
7961 able to correctly support denormalized numbers and exceptional IEEE
7962 values such as not-a-number and plus/minus infinity.  Other Alpha
7963 compilers call this option @option{-ieee_with_no_inexact}.
7965 @item -mieee-with-inexact
7966 @opindex mieee-with-inexact
7967 This is like @option{-mieee} except the generated code also maintains
7968 the IEEE @var{inexact-flag}.  Turning on this option causes the
7969 generated code to implement fully-compliant IEEE math.  In addition to
7970 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7971 macro.  On some Alpha implementations the resulting code may execute
7972 significantly slower than the code generated by default.  Since there is
7973 very little code that depends on the @var{inexact-flag}, you should
7974 normally not specify this option.  Other Alpha compilers call this
7975 option @option{-ieee_with_inexact}.
7977 @item -mfp-trap-mode=@var{trap-mode}
7978 @opindex mfp-trap-mode
7979 This option controls what floating-point related traps are enabled.
7980 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7981 The trap mode can be set to one of four values:
7983 @table @samp
7984 @item n
7985 This is the default (normal) setting.  The only traps that are enabled
7986 are the ones that cannot be disabled in software (e.g., division by zero
7987 trap).
7989 @item u
7990 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7991 as well.
7993 @item su
7994 Like @samp{su}, but the instructions are marked to be safe for software
7995 completion (see Alpha architecture manual for details).
7997 @item sui
7998 Like @samp{su}, but inexact traps are enabled as well.
7999 @end table
8001 @item -mfp-rounding-mode=@var{rounding-mode}
8002 @opindex mfp-rounding-mode
8003 Selects the IEEE rounding mode.  Other Alpha compilers call this option
8004 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
8007 @table @samp
8008 @item n
8009 Normal IEEE rounding mode.  Floating point numbers are rounded towards
8010 the nearest machine number or towards the even machine number in case
8011 of a tie.
8013 @item m
8014 Round towards minus infinity.
8016 @item c
8017 Chopped rounding mode.  Floating point numbers are rounded towards zero.
8019 @item d
8020 Dynamic rounding mode.  A field in the floating point control register
8021 (@var{fpcr}, see Alpha architecture reference manual) controls the
8022 rounding mode in effect.  The C library initializes this register for
8023 rounding towards plus infinity.  Thus, unless your program modifies the
8024 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8025 @end table
8027 @item -mtrap-precision=@var{trap-precision}
8028 @opindex mtrap-precision
8029 In the Alpha architecture, floating point traps are imprecise.  This
8030 means without software assistance it is impossible to recover from a
8031 floating trap and program execution normally needs to be terminated.
8032 GCC can generate code that can assist operating system trap handlers
8033 in determining the exact location that caused a floating point trap.
8034 Depending on the requirements of an application, different levels of
8035 precisions can be selected:
8037 @table @samp
8038 @item p
8039 Program precision.  This option is the default and means a trap handler
8040 can only identify which program caused a floating point exception.
8042 @item f
8043 Function precision.  The trap handler can determine the function that
8044 caused a floating point exception.
8046 @item i
8047 Instruction precision.  The trap handler can determine the exact
8048 instruction that caused a floating point exception.
8049 @end table
8051 Other Alpha compilers provide the equivalent options called
8052 @option{-scope_safe} and @option{-resumption_safe}.
8054 @item -mieee-conformant
8055 @opindex mieee-conformant
8056 This option marks the generated code as IEEE conformant.  You must not
8057 use this option unless you also specify @option{-mtrap-precision=i} and either
8058 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
8059 is to emit the line @samp{.eflag 48} in the function prologue of the
8060 generated assembly file.  Under DEC Unix, this has the effect that
8061 IEEE-conformant math library routines will be linked in.
8063 @item -mbuild-constants
8064 @opindex mbuild-constants
8065 Normally GCC examines a 32- or 64-bit integer constant to
8066 see if it can construct it from smaller constants in two or three
8067 instructions.  If it cannot, it will output the constant as a literal and
8068 generate code to load it from the data segment at runtime.
8070 Use this option to require GCC to construct @emph{all} integer constants
8071 using code, even if it takes more instructions (the maximum is six).
8073 You would typically use this option to build a shared library dynamic
8074 loader.  Itself a shared library, it must relocate itself in memory
8075 before it can find the variables and constants in its own data segment.
8077 @item -malpha-as
8078 @itemx -mgas
8079 @opindex malpha-as
8080 @opindex mgas
8081 Select whether to generate code to be assembled by the vendor-supplied
8082 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8084 @item -mbwx
8085 @itemx -mno-bwx
8086 @itemx -mcix
8087 @itemx -mno-cix
8088 @itemx -mfix
8089 @itemx -mno-fix
8090 @itemx -mmax
8091 @itemx -mno-max
8092 @opindex mbwx
8093 @opindex mno-bwx
8094 @opindex mcix
8095 @opindex mno-cix
8096 @opindex mfix
8097 @opindex mno-fix
8098 @opindex mmax
8099 @opindex mno-max
8100 Indicate whether GCC should generate code to use the optional BWX,
8101 CIX, FIX and MAX instruction sets.  The default is to use the instruction
8102 sets supported by the CPU type specified via @option{-mcpu=} option or that
8103 of the CPU on which GCC was built if none was specified.
8105 @item -mfloat-vax
8106 @itemx -mfloat-ieee
8107 @opindex mfloat-vax
8108 @opindex mfloat-ieee
8109 Generate code that uses (does not use) VAX F and G floating point
8110 arithmetic instead of IEEE single and double precision.
8112 @item -mexplicit-relocs
8113 @itemx -mno-explicit-relocs
8114 @opindex mexplicit-relocs
8115 @opindex mno-explicit-relocs
8116 Older Alpha assemblers provided no way to generate symbol relocations
8117 except via assembler macros.  Use of these macros does not allow
8118 optimal instruction scheduling.  GNU binutils as of version 2.12
8119 supports a new syntax that allows the compiler to explicitly mark
8120 which relocations should apply to which instructions.  This option
8121 is mostly useful for debugging, as GCC detects the capabilities of
8122 the assembler when it is built and sets the default accordingly.
8124 @item -msmall-data
8125 @itemx -mlarge-data
8126 @opindex msmall-data
8127 @opindex mlarge-data
8128 When @option{-mexplicit-relocs} is in effect, static data is
8129 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
8130 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8131 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8132 16-bit relocations off of the @code{$gp} register.  This limits the
8133 size of the small data area to 64KB, but allows the variables to be
8134 directly accessed via a single instruction.
8136 The default is @option{-mlarge-data}.  With this option the data area
8137 is limited to just below 2GB@.  Programs that require more than 2GB of
8138 data must use @code{malloc} or @code{mmap} to allocate the data in the
8139 heap instead of in the program's data segment.
8141 When generating code for shared libraries, @option{-fpic} implies
8142 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8144 @item -msmall-text
8145 @itemx -mlarge-text
8146 @opindex msmall-text
8147 @opindex mlarge-text
8148 When @option{-msmall-text} is used, the compiler assumes that the
8149 code of the entire program (or shared library) fits in 4MB, and is
8150 thus reachable with a branch instruction.  When @option{-msmall-data}
8151 is used, the compiler can assume that all local symbols share the
8152 same @code{$gp} value, and thus reduce the number of instructions
8153 required for a function call from 4 to 1.
8155 The default is @option{-mlarge-text}.
8157 @item -mcpu=@var{cpu_type}
8158 @opindex mcpu
8159 Set the instruction set and instruction scheduling parameters for
8160 machine type @var{cpu_type}.  You can specify either the @samp{EV}
8161 style name or the corresponding chip number.  GCC supports scheduling
8162 parameters for the EV4, EV5 and EV6 family of processors and will
8163 choose the default values for the instruction set from the processor
8164 you specify.  If you do not specify a processor type, GCC will default
8165 to the processor on which the compiler was built.
8167 Supported values for @var{cpu_type} are
8169 @table @samp
8170 @item ev4
8171 @itemx ev45
8172 @itemx 21064
8173 Schedules as an EV4 and has no instruction set extensions.
8175 @item ev5
8176 @itemx 21164
8177 Schedules as an EV5 and has no instruction set extensions.
8179 @item ev56
8180 @itemx 21164a
8181 Schedules as an EV5 and supports the BWX extension.
8183 @item pca56
8184 @itemx 21164pc
8185 @itemx 21164PC
8186 Schedules as an EV5 and supports the BWX and MAX extensions.
8188 @item ev6
8189 @itemx 21264
8190 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8192 @item ev67
8193 @itemx 21264a
8194 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8195 @end table
8197 @item -mtune=@var{cpu_type}
8198 @opindex mtune
8199 Set only the instruction scheduling parameters for machine type
8200 @var{cpu_type}.  The instruction set is not changed.
8202 @item -mmemory-latency=@var{time}
8203 @opindex mmemory-latency
8204 Sets the latency the scheduler should assume for typical memory
8205 references as seen by the application.  This number is highly
8206 dependent on the memory access patterns used by the application
8207 and the size of the external cache on the machine.
8209 Valid options for @var{time} are
8211 @table @samp
8212 @item @var{number}
8213 A decimal number representing clock cycles.
8215 @item L1
8216 @itemx L2
8217 @itemx L3
8218 @itemx main
8219 The compiler contains estimates of the number of clock cycles for
8220 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8221 (also called Dcache, Scache, and Bcache), as well as to main memory.
8222 Note that L3 is only valid for EV5.
8224 @end table
8225 @end table
8227 @node DEC Alpha/VMS Options
8228 @subsection DEC Alpha/VMS Options
8230 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8232 @table @gcctabopt
8233 @item -mvms-return-codes
8234 @opindex mvms-return-codes
8235 Return VMS condition codes from main.  The default is to return POSIX
8236 style condition (e.g.@ error) codes.
8237 @end table
8239 @node FRV Options
8240 @subsection FRV Options
8241 @cindex FRV Options
8243 @table @gcctabopt
8244 @item -mgpr-32
8245 @opindex mgpr-32
8247 Only use the first 32 general purpose registers.
8249 @item -mgpr-64
8250 @opindex mgpr-64
8252 Use all 64 general purpose registers.
8254 @item -mfpr-32
8255 @opindex mfpr-32
8257 Use only the first 32 floating point registers.
8259 @item -mfpr-64
8260 @opindex mfpr-64
8262 Use all 64 floating point registers
8264 @item -mhard-float
8265 @opindex mhard-float
8267 Use hardware instructions for floating point operations.
8269 @item -msoft-float
8270 @opindex msoft-float
8272 Use library routines for floating point operations.
8274 @item -malloc-cc
8275 @opindex malloc-cc
8277 Dynamically allocate condition code registers.
8279 @item -mfixed-cc
8280 @opindex mfixed-cc
8282 Do not try to dynamically allocate condition code registers, only
8283 use @code{icc0} and @code{fcc0}.
8285 @item -mdword
8286 @opindex mdword
8288 Change ABI to use double word insns.
8290 @item -mno-dword
8291 @opindex mno-dword
8293 Do not use double word instructions.
8295 @item -mdouble
8296 @opindex mdouble
8298 Use floating point double instructions.
8300 @item -mno-double
8301 @opindex mno-double
8303 Do not use floating point double instructions.
8305 @item -mmedia
8306 @opindex mmedia
8308 Use media instructions.
8310 @item -mno-media
8311 @opindex mno-media
8313 Do not use media instructions.
8315 @item -mmuladd
8316 @opindex mmuladd
8318 Use multiply and add/subtract instructions.
8320 @item -mno-muladd
8321 @opindex mno-muladd
8323 Do not use multiply and add/subtract instructions.
8325 @item -mfdpic
8326 @opindex mfdpic
8328 Select the FDPIC ABI, that uses function descriptors to represent
8329 pointers to functions.  Without any PIC/PIE-related options, it
8330 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
8331 assumes GOT entries and small data are within a 12-bit range from the
8332 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8333 are computed with 32 bits.
8335 @item -minline-plt
8336 @opindex minline-plt
8338 Enable inlining of PLT entries in function calls to functions that are
8339 not known to bind locally.  It has no effect without @option{-mfdpic}.
8340 It's enabled by default if optimizing for speed and compiling for
8341 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8342 optimization option such as @option{-O3} or above is present in the
8343 command line.
8345 @item -mTLS
8346 @opindex TLS
8348 Assume a large TLS segment when generating thread-local code.
8350 @item -mtls
8351 @opindex tls
8353 Do not assume a large TLS segment when generating thread-local code.
8355 @item -mgprel-ro
8356 @opindex mgprel-ro
8358 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8359 that is known to be in read-only sections.  It's enabled by default,
8360 except for @option{-fpic} or @option{-fpie}: even though it may help
8361 make the global offset table smaller, it trades 1 instruction for 4.
8362 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8363 one of which may be shared by multiple symbols, and it avoids the need
8364 for a GOT entry for the referenced symbol, so it's more likely to be a
8365 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8367 @item -multilib-library-pic
8368 @opindex multilib-library-pic
8370 Link with the (library, not FD) pic libraries.  It's implied by
8371 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8372 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8373 it explicitly.
8375 @item -mlinked-fp
8376 @opindex mlinked-fp
8378 Follow the EABI requirement of always creating a frame pointer whenever
8379 a stack frame is allocated.  This option is enabled by default and can
8380 be disabled with @option{-mno-linked-fp}.
8382 @item -mlong-calls
8383 @opindex mlong-calls
8385 Use indirect addressing to call functions outside the current
8386 compilation unit.  This allows the functions to be placed anywhere
8387 within the 32-bit address space.
8389 @item -malign-labels
8390 @opindex malign-labels
8392 Try to align labels to an 8-byte boundary by inserting nops into the
8393 previous packet.  This option only has an effect when VLIW packing
8394 is enabled.  It doesn't create new packets; it merely adds nops to
8395 existing ones.
8397 @item -mlibrary-pic
8398 @opindex mlibrary-pic
8400 Generate position-independent EABI code.
8402 @item -macc-4
8403 @opindex macc-4
8405 Use only the first four media accumulator registers.
8407 @item -macc-8
8408 @opindex macc-8
8410 Use all eight media accumulator registers.
8412 @item -mpack
8413 @opindex mpack
8415 Pack VLIW instructions.
8417 @item -mno-pack
8418 @opindex mno-pack
8420 Do not pack VLIW instructions.
8422 @item -mno-eflags
8423 @opindex mno-eflags
8425 Do not mark ABI switches in e_flags.
8427 @item -mcond-move
8428 @opindex mcond-move
8430 Enable the use of conditional-move instructions (default).
8432 This switch is mainly for debugging the compiler and will likely be removed
8433 in a future version.
8435 @item -mno-cond-move
8436 @opindex mno-cond-move
8438 Disable the use of conditional-move instructions.
8440 This switch is mainly for debugging the compiler and will likely be removed
8441 in a future version.
8443 @item -mscc
8444 @opindex mscc
8446 Enable the use of conditional set instructions (default).
8448 This switch is mainly for debugging the compiler and will likely be removed
8449 in a future version.
8451 @item -mno-scc
8452 @opindex mno-scc
8454 Disable the use of conditional set instructions.
8456 This switch is mainly for debugging the compiler and will likely be removed
8457 in a future version.
8459 @item -mcond-exec
8460 @opindex mcond-exec
8462 Enable the use of conditional execution (default).
8464 This switch is mainly for debugging the compiler and will likely be removed
8465 in a future version.
8467 @item -mno-cond-exec
8468 @opindex mno-cond-exec
8470 Disable the use of conditional execution.
8472 This switch is mainly for debugging the compiler and will likely be removed
8473 in a future version.
8475 @item -mvliw-branch
8476 @opindex mvliw-branch
8478 Run a pass to pack branches into VLIW instructions (default).
8480 This switch is mainly for debugging the compiler and will likely be removed
8481 in a future version.
8483 @item -mno-vliw-branch
8484 @opindex mno-vliw-branch
8486 Do not run a pass to pack branches into VLIW instructions.
8488 This switch is mainly for debugging the compiler and will likely be removed
8489 in a future version.
8491 @item -mmulti-cond-exec
8492 @opindex mmulti-cond-exec
8494 Enable optimization of @code{&&} and @code{||} in conditional execution
8495 (default).
8497 This switch is mainly for debugging the compiler and will likely be removed
8498 in a future version.
8500 @item -mno-multi-cond-exec
8501 @opindex mno-multi-cond-exec
8503 Disable optimization of @code{&&} and @code{||} in conditional execution.
8505 This switch is mainly for debugging the compiler and will likely be removed
8506 in a future version.
8508 @item -mnested-cond-exec
8509 @opindex mnested-cond-exec
8511 Enable nested conditional execution optimizations (default).
8513 This switch is mainly for debugging the compiler and will likely be removed
8514 in a future version.
8516 @item -mno-nested-cond-exec
8517 @opindex mno-nested-cond-exec
8519 Disable nested conditional execution optimizations.
8521 This switch is mainly for debugging the compiler and will likely be removed
8522 in a future version.
8524 @item -moptimize-membar
8525 @opindex moptimize-membar
8527 This switch removes redundant @code{membar} instructions from the
8528 compiler generated code.  It is enabled by default.
8530 @item -mno-optimize-membar
8531 @opindex mno-optimize-membar
8533 This switch disables the automatic removal of redundant @code{membar}
8534 instructions from the generated code.
8536 @item -mtomcat-stats
8537 @opindex mtomcat-stats
8539 Cause gas to print out tomcat statistics.
8541 @item -mcpu=@var{cpu}
8542 @opindex mcpu
8544 Select the processor type for which to generate code.  Possible values are
8545 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8546 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8548 @end table
8550 @node H8/300 Options
8551 @subsection H8/300 Options
8553 These @samp{-m} options are defined for the H8/300 implementations:
8555 @table @gcctabopt
8556 @item -mrelax
8557 @opindex mrelax
8558 Shorten some address references at link time, when possible; uses the
8559 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8560 ld, Using ld}, for a fuller description.
8562 @item -mh
8563 @opindex mh
8564 Generate code for the H8/300H@.
8566 @item -ms
8567 @opindex ms
8568 Generate code for the H8S@.
8570 @item -mn
8571 @opindex mn
8572 Generate code for the H8S and H8/300H in the normal mode.  This switch
8573 must be used either with @option{-mh} or @option{-ms}.
8575 @item -ms2600
8576 @opindex ms2600
8577 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8579 @item -mint32
8580 @opindex mint32
8581 Make @code{int} data 32 bits by default.
8583 @item -malign-300
8584 @opindex malign-300
8585 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8586 The default for the H8/300H and H8S is to align longs and floats on 4
8587 byte boundaries.
8588 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8589 This option has no effect on the H8/300.
8590 @end table
8592 @node HPPA Options
8593 @subsection HPPA Options
8594 @cindex HPPA Options
8596 These @samp{-m} options are defined for the HPPA family of computers:
8598 @table @gcctabopt
8599 @item -march=@var{architecture-type}
8600 @opindex march
8601 Generate code for the specified architecture.  The choices for
8602 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8603 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8604 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8605 architecture option for your machine.  Code compiled for lower numbered
8606 architectures will run on higher numbered architectures, but not the
8607 other way around.
8609 @item -mpa-risc-1-0
8610 @itemx -mpa-risc-1-1
8611 @itemx -mpa-risc-2-0
8612 @opindex mpa-risc-1-0
8613 @opindex mpa-risc-1-1
8614 @opindex mpa-risc-2-0
8615 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8617 @item -mbig-switch
8618 @opindex mbig-switch
8619 Generate code suitable for big switch tables.  Use this option only if
8620 the assembler/linker complain about out of range branches within a switch
8621 table.
8623 @item -mjump-in-delay
8624 @opindex mjump-in-delay
8625 Fill delay slots of function calls with unconditional jump instructions
8626 by modifying the return pointer for the function call to be the target
8627 of the conditional jump.
8629 @item -mdisable-fpregs
8630 @opindex mdisable-fpregs
8631 Prevent floating point registers from being used in any manner.  This is
8632 necessary for compiling kernels which perform lazy context switching of
8633 floating point registers.  If you use this option and attempt to perform
8634 floating point operations, the compiler will abort.
8636 @item -mdisable-indexing
8637 @opindex mdisable-indexing
8638 Prevent the compiler from using indexing address modes.  This avoids some
8639 rather obscure problems when compiling MIG generated code under MACH@.
8641 @item -mno-space-regs
8642 @opindex mno-space-regs
8643 Generate code that assumes the target has no space registers.  This allows
8644 GCC to generate faster indirect calls and use unscaled index address modes.
8646 Such code is suitable for level 0 PA systems and kernels.
8648 @item -mfast-indirect-calls
8649 @opindex mfast-indirect-calls
8650 Generate code that assumes calls never cross space boundaries.  This
8651 allows GCC to emit code which performs faster indirect calls.
8653 This option will not work in the presence of shared libraries or nested
8654 functions.
8656 @item -mfixed-range=@var{register-range}
8657 @opindex mfixed-range
8658 Generate code treating the given register range as fixed registers.
8659 A fixed register is one that the register allocator can not use.  This is
8660 useful when compiling kernel code.  A register range is specified as
8661 two registers separated by a dash.  Multiple register ranges can be
8662 specified separated by a comma.
8664 @item -mlong-load-store
8665 @opindex mlong-load-store
8666 Generate 3-instruction load and store sequences as sometimes required by
8667 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8668 the HP compilers.
8670 @item -mportable-runtime
8671 @opindex mportable-runtime
8672 Use the portable calling conventions proposed by HP for ELF systems.
8674 @item -mgas
8675 @opindex mgas
8676 Enable the use of assembler directives only GAS understands.
8678 @item -mschedule=@var{cpu-type}
8679 @opindex mschedule
8680 Schedule code according to the constraints for the machine type
8681 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8682 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8683 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8684 proper scheduling option for your machine.  The default scheduling is
8685 @samp{8000}.
8687 @item -mlinker-opt
8688 @opindex mlinker-opt
8689 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8690 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8691 linkers in which they give bogus error messages when linking some programs.
8693 @item -msoft-float
8694 @opindex msoft-float
8695 Generate output containing library calls for floating point.
8696 @strong{Warning:} the requisite libraries are not available for all HPPA
8697 targets.  Normally the facilities of the machine's usual C compiler are
8698 used, but this cannot be done directly in cross-compilation.  You must make
8699 your own arrangements to provide suitable library functions for
8700 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8701 does provide software floating point support.
8703 @option{-msoft-float} changes the calling convention in the output file;
8704 therefore, it is only useful if you compile @emph{all} of a program with
8705 this option.  In particular, you need to compile @file{libgcc.a}, the
8706 library that comes with GCC, with @option{-msoft-float} in order for
8707 this to work.
8709 @item -msio
8710 @opindex msio
8711 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8712 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8713 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8714 options are available under HP-UX and HI-UX@.
8716 @item -mgnu-ld
8717 @opindex gnu-ld
8718 Use GNU ld specific options.  This passes @option{-shared} to ld when
8719 building a shared library.  It is the default when GCC is configured,
8720 explicitly or implicitly, with the GNU linker.  This option does not
8721 have any affect on which ld is called, it only changes what parameters
8722 are passed to that ld.  The ld that is called is determined by the
8723 @option{--with-ld} configure option, GCC's program search path, and
8724 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8725 using @samp{which `gcc -print-prog-name=ld`}.
8727 @item -mhp-ld
8728 @opindex hp-ld
8729 Use HP ld specific options.  This passes @option{-b} to ld when building
8730 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8731 links.  It is the default when GCC is configured, explicitly or
8732 implicitly, with the HP linker.  This option does not have any affect on
8733 which ld is called, it only changes what parameters are passed to that
8734 ld.  The ld that is called is determined by the @option{--with-ld}
8735 configure option, GCC's program search path, and finally by the user's
8736 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8737 `gcc -print-prog-name=ld`}.
8739 @item -mlong-calls
8740 @opindex mno-long-calls
8741 Generate code that uses long call sequences.  This ensures that a call
8742 is always able to reach linker generated stubs.  The default is to generate
8743 long calls only when the distance from the call site to the beginning
8744 of the function or translation unit, as the case may be, exceeds a
8745 predefined limit set by the branch type being used.  The limits for
8746 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8747 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8748 240,000 bytes.
8750 Distances are measured from the beginning of functions when using the
8751 @option{-ffunction-sections} option, or when using the @option{-mgas}
8752 and @option{-mno-portable-runtime} options together under HP-UX with
8753 the SOM linker.
8755 It is normally not desirable to use this option as it will degrade
8756 performance.  However, it may be useful in large applications,
8757 particularly when partial linking is used to build the application.
8759 The types of long calls used depends on the capabilities of the
8760 assembler and linker, and the type of code being generated.  The
8761 impact on systems that support long absolute calls, and long pic
8762 symbol-difference or pc-relative calls should be relatively small.
8763 However, an indirect call is used on 32-bit ELF systems in pic code
8764 and it is quite long.
8766 @item -munix=@var{unix-std}
8767 @opindex march
8768 Generate compiler predefines and select a startfile for the specified
8769 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8770 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8771 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8772 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8773 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8774 and later.
8776 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8777 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8778 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8779 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8780 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8781 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8783 It is @emph{important} to note that this option changes the interfaces
8784 for various library routines.  It also affects the operational behavior
8785 of the C library.  Thus, @emph{extreme} care is needed in using this
8786 option.
8788 Library code that is intended to operate with more than one UNIX
8789 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8790 as appropriate.  Most GNU software doesn't provide this capability.
8792 @item -nolibdld
8793 @opindex nolibdld
8794 Suppress the generation of link options to search libdld.sl when the
8795 @option{-static} option is specified on HP-UX 10 and later.
8797 @item -static
8798 @opindex static
8799 The HP-UX implementation of setlocale in libc has a dependency on
8800 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8801 when the @option{-static} option is specified, special link options
8802 are needed to resolve this dependency.
8804 On HP-UX 10 and later, the GCC driver adds the necessary options to
8805 link with libdld.sl when the @option{-static} option is specified.
8806 This causes the resulting binary to be dynamic.  On the 64-bit port,
8807 the linkers generate dynamic binaries by default in any case.  The
8808 @option{-nolibdld} option can be used to prevent the GCC driver from
8809 adding these link options.
8811 @item -threads
8812 @opindex threads
8813 Add support for multithreading with the @dfn{dce thread} library
8814 under HP-UX@.  This option sets flags for both the preprocessor and
8815 linker.
8816 @end table
8818 @node i386 and x86-64 Options
8819 @subsection Intel 386 and AMD x86-64 Options
8820 @cindex i386 Options
8821 @cindex x86-64 Options
8822 @cindex Intel 386 Options
8823 @cindex AMD x86-64 Options
8825 These @samp{-m} options are defined for the i386 and x86-64 family of
8826 computers:
8828 @table @gcctabopt
8829 @item -mtune=@var{cpu-type}
8830 @opindex mtune
8831 Tune to @var{cpu-type} everything applicable about the generated code, except
8832 for the ABI and the set of available instructions.  The choices for
8833 @var{cpu-type} are:
8834 @table @emph
8835 @item i386
8836 Original Intel's i386 CPU@.
8837 @item i486
8838 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8839 @item i586, pentium
8840 Intel Pentium CPU with no MMX support.
8841 @item pentium-mmx
8842 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8843 @item i686, pentiumpro
8844 Intel PentiumPro CPU@.
8845 @item pentium2
8846 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8847 @item pentium3, pentium3m
8848 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8849 support.
8850 @item pentium-m
8851 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8852 support.  Used by Centrino notebooks.
8853 @item pentium4, pentium4m
8854 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8855 @item prescott
8856 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8857 set support.
8858 @item nocona
8859 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8860 SSE2 and SSE3 instruction set support.
8861 @item k6
8862 AMD K6 CPU with MMX instruction set support.
8863 @item k6-2, k6-3
8864 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8865 @item athlon, athlon-tbird
8866 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8867 support.
8868 @item athlon-4, athlon-xp, athlon-mp
8869 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8870 instruction set support.
8871 @item k8, opteron, athlon64, athlon-fx
8872 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8873 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8874 @item winchip-c6
8875 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8876 set support.
8877 @item winchip2
8878 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8879 instruction set support.
8880 @item c3
8881 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8882 implemented for this chip.)
8883 @item c3-2
8884 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8885 implemented for this chip.)
8886 @end table
8888 While picking a specific @var{cpu-type} will schedule things appropriately
8889 for that particular chip, the compiler will not generate any code that
8890 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8891 being used.
8893 @item -march=@var{cpu-type}
8894 @opindex march
8895 Generate instructions for the machine type @var{cpu-type}.  The choices
8896 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8897 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8899 @item -mcpu=@var{cpu-type}
8900 @opindex mcpu
8901 A deprecated synonym for @option{-mtune}.
8903 @item -m386
8904 @itemx -m486
8905 @itemx -mpentium
8906 @itemx -mpentiumpro
8907 @opindex m386
8908 @opindex m486
8909 @opindex mpentium
8910 @opindex mpentiumpro
8911 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8912 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8913 These synonyms are deprecated.
8915 @item -mfpmath=@var{unit}
8916 @opindex march
8917 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8918 for @var{unit} are:
8920 @table @samp
8921 @item 387
8922 Use the standard 387 floating point coprocessor present majority of chips and
8923 emulated otherwise.  Code compiled with this option will run almost everywhere.
8924 The temporary results are computed in 80bit precision instead of precision
8925 specified by the type resulting in slightly different results compared to most
8926 of other chips.  See @option{-ffloat-store} for more detailed description.
8928 This is the default choice for i386 compiler.
8930 @item sse
8931 Use scalar floating point instructions present in the SSE instruction set.
8932 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8933 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8934 instruction set supports only single precision arithmetics, thus the double and
8935 extended precision arithmetics is still done using 387.  Later version, present
8936 only in Pentium4 and the future AMD x86-64 chips supports double precision
8937 arithmetics too.
8939 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8940 or @option{-msse2} switches to enable SSE extensions and make this option
8941 effective.  For the x86-64 compiler, these extensions are enabled by default.
8943 The resulting code should be considerably faster in the majority of cases and avoid
8944 the numerical instability problems of 387 code, but may break some existing
8945 code that expects temporaries to be 80bit.
8947 This is the default choice for the x86-64 compiler.
8949 @item sse,387
8950 Attempt to utilize both instruction sets at once.  This effectively double the
8951 amount of available registers and on chips with separate execution units for
8952 387 and SSE the execution resources too.  Use this option with care, as it is
8953 still experimental, because the GCC register allocator does not model separate
8954 functional units well resulting in instable performance.
8955 @end table
8957 @item -masm=@var{dialect}
8958 @opindex masm=@var{dialect}
8959 Output asm instructions using selected @var{dialect}.  Supported choices are
8960 @samp{intel} or @samp{att} (the default one).
8962 @item -mieee-fp
8963 @itemx -mno-ieee-fp
8964 @opindex mieee-fp
8965 @opindex mno-ieee-fp
8966 Control whether or not the compiler uses IEEE floating point
8967 comparisons.  These handle correctly the case where the result of a
8968 comparison is unordered.
8970 @item -msoft-float
8971 @opindex msoft-float
8972 Generate output containing library calls for floating point.
8973 @strong{Warning:} the requisite libraries are not part of GCC@.
8974 Normally the facilities of the machine's usual C compiler are used, but
8975 this can't be done directly in cross-compilation.  You must make your
8976 own arrangements to provide suitable library functions for
8977 cross-compilation.
8979 On machines where a function returns floating point results in the 80387
8980 register stack, some floating point opcodes may be emitted even if
8981 @option{-msoft-float} is used.
8983 @item -mno-fp-ret-in-387
8984 @opindex mno-fp-ret-in-387
8985 Do not use the FPU registers for return values of functions.
8987 The usual calling convention has functions return values of types
8988 @code{float} and @code{double} in an FPU register, even if there
8989 is no FPU@.  The idea is that the operating system should emulate
8990 an FPU@.
8992 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8993 in ordinary CPU registers instead.
8995 @item -mno-fancy-math-387
8996 @opindex mno-fancy-math-387
8997 Some 387 emulators do not support the @code{sin}, @code{cos} and
8998 @code{sqrt} instructions for the 387.  Specify this option to avoid
8999 generating those instructions.  This option is the default on FreeBSD,
9000 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
9001 indicates that the target cpu will always have an FPU and so the
9002 instruction will not need emulation.  As of revision 2.6.1, these
9003 instructions are not generated unless you also use the
9004 @option{-funsafe-math-optimizations} switch.
9006 @item -malign-double
9007 @itemx -mno-align-double
9008 @opindex malign-double
9009 @opindex mno-align-double
9010 Control whether GCC aligns @code{double}, @code{long double}, and
9011 @code{long long} variables on a two word boundary or a one word
9012 boundary.  Aligning @code{double} variables on a two word boundary will
9013 produce code that runs somewhat faster on a @samp{Pentium} at the
9014 expense of more memory.
9016 @strong{Warning:} if you use the @option{-malign-double} switch,
9017 structures containing the above types will be aligned differently than
9018 the published application binary interface specifications for the 386
9019 and will not be binary compatible with structures in code compiled
9020 without that switch.
9022 @item -m96bit-long-double
9023 @itemx -m128bit-long-double
9024 @opindex m96bit-long-double
9025 @opindex m128bit-long-double
9026 These switches control the size of @code{long double} type.  The i386
9027 application binary interface specifies the size to be 96 bits,
9028 so @option{-m96bit-long-double} is the default in 32 bit mode.
9030 Modern architectures (Pentium and newer) would prefer @code{long double}
9031 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
9032 conforming to the ABI, this would not be possible.  So specifying a
9033 @option{-m128bit-long-double} will align @code{long double}
9034 to a 16 byte boundary by padding the @code{long double} with an additional
9035 32 bit zero.
9037 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9038 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9040 Notice that neither of these options enable any extra precision over the x87
9041 standard of 80 bits for a @code{long double}.
9043 @strong{Warning:} if you override the default value for your target ABI, the
9044 structures and arrays containing @code{long double} variables will change
9045 their size as well as function calling convention for function taking
9046 @code{long double} will be modified.  Hence they will not be binary
9047 compatible with arrays or structures in code compiled without that switch.
9049 @item -mmlarge-data-threshold=@var{number}
9050 @opindex mlarge-data-threshold=@var{number}
9051 When @option{-mcmodel=medium} is specified, the data greater than
9052 @var{threshold} are placed in large data section.  This value must be the
9053 same across all object linked into the binarry and defaults to 65535.
9055 @item -msvr3-shlib
9056 @itemx -mno-svr3-shlib
9057 @opindex msvr3-shlib
9058 @opindex mno-svr3-shlib
9059 Control whether GCC places uninitialized local variables into the
9060 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
9061 into @code{bss}.  These options are meaningful only on System V Release 3.
9063 @item -mrtd
9064 @opindex mrtd
9065 Use a different function-calling convention, in which functions that
9066 take a fixed number of arguments return with the @code{ret} @var{num}
9067 instruction, which pops their arguments while returning.  This saves one
9068 instruction in the caller since there is no need to pop the arguments
9069 there.
9071 You can specify that an individual function is called with this calling
9072 sequence with the function attribute @samp{stdcall}.  You can also
9073 override the @option{-mrtd} option by using the function attribute
9074 @samp{cdecl}.  @xref{Function Attributes}.
9076 @strong{Warning:} this calling convention is incompatible with the one
9077 normally used on Unix, so you cannot use it if you need to call
9078 libraries compiled with the Unix compiler.
9080 Also, you must provide function prototypes for all functions that
9081 take variable numbers of arguments (including @code{printf});
9082 otherwise incorrect code will be generated for calls to those
9083 functions.
9085 In addition, seriously incorrect code will result if you call a
9086 function with too many arguments.  (Normally, extra arguments are
9087 harmlessly ignored.)
9089 @item -mregparm=@var{num}
9090 @opindex mregparm
9091 Control how many registers are used to pass integer arguments.  By
9092 default, no registers are used to pass arguments, and at most 3
9093 registers can be used.  You can control this behavior for a specific
9094 function by using the function attribute @samp{regparm}.
9095 @xref{Function Attributes}.
9097 @strong{Warning:} if you use this switch, and
9098 @var{num} is nonzero, then you must build all modules with the same
9099 value, including any libraries.  This includes the system libraries and
9100 startup modules.
9102 @item -msseregparm
9103 @opindex msseregparm
9104 Use SSE register passing conventions for float and double arguments
9105 and return values.  You can control this behavior for a specific
9106 function by using the function attribute @samp{sseregparm}.
9107 @xref{Function Attributes}.
9109 @strong{Warning:} if you use this switch then you must build all
9110 modules with the same value, including any libraries.  This includes
9111 the system libraries and startup modules.
9113 @item -mpreferred-stack-boundary=@var{num}
9114 @opindex mpreferred-stack-boundary
9115 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9116 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
9117 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9118 size (@option{-Os}), in which case the default is the minimum correct
9119 alignment (4 bytes for x86, and 8 bytes for x86-64).
9121 On Pentium and PentiumPro, @code{double} and @code{long double} values
9122 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9123 suffer significant run time performance penalties.  On Pentium III, the
9124 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9125 penalties if it is not 16 byte aligned.
9127 To ensure proper alignment of this values on the stack, the stack boundary
9128 must be as aligned as that required by any value stored on the stack.
9129 Further, every function must be generated such that it keeps the stack
9130 aligned.  Thus calling a function compiled with a higher preferred
9131 stack boundary from a function compiled with a lower preferred stack
9132 boundary will most likely misalign the stack.  It is recommended that
9133 libraries that use callbacks always use the default setting.
9135 This extra alignment does consume extra stack space, and generally
9136 increases code size.  Code that is sensitive to stack space usage, such
9137 as embedded systems and operating system kernels, may want to reduce the
9138 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9140 @item -mmmx
9141 @itemx -mno-mmx
9142 @item -msse
9143 @itemx -mno-sse
9144 @item -msse2
9145 @itemx -mno-sse2
9146 @item -msse3
9147 @itemx -mno-sse3
9148 @item -m3dnow
9149 @itemx -mno-3dnow
9150 @opindex mmmx
9151 @opindex mno-mmx
9152 @opindex msse
9153 @opindex mno-sse
9154 @opindex m3dnow
9155 @opindex mno-3dnow
9156 These switches enable or disable the use of built-in functions that allow
9157 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9158 instruction set.
9160 @xref{X86 Built-in Functions}, for details of the functions enabled
9161 and disabled by these switches.
9163 To have SSE/SSE2 instructions generated automatically from floating-point
9164 code, see @option{-mfpmath=sse}.
9166 @item -mpush-args
9167 @itemx -mno-push-args
9168 @opindex mpush-args
9169 @opindex mno-push-args
9170 Use PUSH operations to store outgoing parameters.  This method is shorter
9171 and usually equally fast as method using SUB/MOV operations and is enabled
9172 by default.  In some cases disabling it may improve performance because of
9173 improved scheduling and reduced dependencies.
9175 @item -maccumulate-outgoing-args
9176 @opindex maccumulate-outgoing-args
9177 If enabled, the maximum amount of space required for outgoing arguments will be
9178 computed in the function prologue.  This is faster on most modern CPUs
9179 because of reduced dependencies, improved scheduling and reduced stack usage
9180 when preferred stack boundary is not equal to 2.  The drawback is a notable
9181 increase in code size.  This switch implies @option{-mno-push-args}.
9183 @item -mthreads
9184 @opindex mthreads
9185 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
9186 on thread-safe exception handling must compile and link all code with the
9187 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
9188 @option{-D_MT}; when linking, it links in a special thread helper library
9189 @option{-lmingwthrd} which cleans up per thread exception handling data.
9191 @item -mno-align-stringops
9192 @opindex mno-align-stringops
9193 Do not align destination of inlined string operations.  This switch reduces
9194 code size and improves performance in case the destination is already aligned,
9195 but GCC doesn't know about it.
9197 @item -minline-all-stringops
9198 @opindex minline-all-stringops
9199 By default GCC inlines string operations only when destination is known to be
9200 aligned at least to 4 byte boundary.  This enables more inlining, increase code
9201 size, but may improve performance of code that depends on fast memcpy, strlen
9202 and memset for short lengths.
9204 @item -momit-leaf-frame-pointer
9205 @opindex momit-leaf-frame-pointer
9206 Don't keep the frame pointer in a register for leaf functions.  This
9207 avoids the instructions to save, set up and restore frame pointers and
9208 makes an extra register available in leaf functions.  The option
9209 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9210 which might make debugging harder.
9212 @item -mtls-direct-seg-refs
9213 @itemx -mno-tls-direct-seg-refs
9214 @opindex mtls-direct-seg-refs
9215 Controls whether TLS variables may be accessed with offsets from the
9216 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9217 or whether the thread base pointer must be added.  Whether or not this
9218 is legal depends on the operating system, and whether it maps the
9219 segment to cover the entire TLS area.
9221 For systems that use GNU libc, the default is on.
9222 @end table
9224 These @samp{-m} switches are supported in addition to the above
9225 on AMD x86-64 processors in 64-bit environments.
9227 @table @gcctabopt
9228 @item -m32
9229 @itemx -m64
9230 @opindex m32
9231 @opindex m64
9232 Generate code for a 32-bit or 64-bit environment.
9233 The 32-bit environment sets int, long and pointer to 32 bits and
9234 generates code that runs on any i386 system.
9235 The 64-bit environment sets int to 32 bits and long and pointer
9236 to 64 bits and generates code for AMD's x86-64 architecture.
9238 @item -mno-red-zone
9239 @opindex no-red-zone
9240 Do not use a so called red zone for x86-64 code.  The red zone is mandated
9241 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9242 stack pointer that will not be modified by signal or interrupt handlers
9243 and therefore can be used for temporary data without adjusting the stack
9244 pointer.  The flag @option{-mno-red-zone} disables this red zone.
9246 @item -mcmodel=small
9247 @opindex mcmodel=small
9248 Generate code for the small code model: the program and its symbols must
9249 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
9250 Programs can be statically or dynamically linked.  This is the default
9251 code model.
9253 @item -mcmodel=kernel
9254 @opindex mcmodel=kernel
9255 Generate code for the kernel code model.  The kernel runs in the
9256 negative 2 GB of the address space.
9257 This model has to be used for Linux kernel code.
9259 @item -mcmodel=medium
9260 @opindex mcmodel=medium
9261 Generate code for the medium model: The program is linked in the lower 2
9262 GB of the address space but symbols can be located anywhere in the
9263 address space.  Programs can be statically or dynamically linked, but
9264 building of shared libraries are not supported with the medium model.
9266 @item -mcmodel=large
9267 @opindex mcmodel=large
9268 Generate code for the large model: This model makes no assumptions
9269 about addresses and sizes of sections.  Currently GCC does not implement
9270 this model.
9271 @end table
9273 @node IA-64 Options
9274 @subsection IA-64 Options
9275 @cindex IA-64 Options
9277 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9279 @table @gcctabopt
9280 @item -mbig-endian
9281 @opindex mbig-endian
9282 Generate code for a big endian target.  This is the default for HP-UX@.
9284 @item -mlittle-endian
9285 @opindex mlittle-endian
9286 Generate code for a little endian target.  This is the default for AIX5
9287 and GNU/Linux.
9289 @item -mgnu-as
9290 @itemx -mno-gnu-as
9291 @opindex mgnu-as
9292 @opindex mno-gnu-as
9293 Generate (or don't) code for the GNU assembler.  This is the default.
9294 @c Also, this is the default if the configure option @option{--with-gnu-as}
9295 @c is used.
9297 @item -mgnu-ld
9298 @itemx -mno-gnu-ld
9299 @opindex mgnu-ld
9300 @opindex mno-gnu-ld
9301 Generate (or don't) code for the GNU linker.  This is the default.
9302 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9303 @c is used.
9305 @item -mno-pic
9306 @opindex mno-pic
9307 Generate code that does not use a global pointer register.  The result
9308 is not position independent code, and violates the IA-64 ABI@.
9310 @item -mvolatile-asm-stop
9311 @itemx -mno-volatile-asm-stop
9312 @opindex mvolatile-asm-stop
9313 @opindex mno-volatile-asm-stop
9314 Generate (or don't) a stop bit immediately before and after volatile asm
9315 statements.
9317 @item -mregister-names
9318 @itemx -mno-register-names
9319 @opindex mregister-names
9320 @opindex mno-register-names
9321 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9322 the stacked registers.  This may make assembler output more readable.
9324 @item -mno-sdata
9325 @itemx -msdata
9326 @opindex mno-sdata
9327 @opindex msdata
9328 Disable (or enable) optimizations that use the small data section.  This may
9329 be useful for working around optimizer bugs.
9331 @item -mconstant-gp
9332 @opindex mconstant-gp
9333 Generate code that uses a single constant global pointer value.  This is
9334 useful when compiling kernel code.
9336 @item -mauto-pic
9337 @opindex mauto-pic
9338 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
9339 This is useful when compiling firmware code.
9341 @item -minline-float-divide-min-latency
9342 @opindex minline-float-divide-min-latency
9343 Generate code for inline divides of floating point values
9344 using the minimum latency algorithm.
9346 @item -minline-float-divide-max-throughput
9347 @opindex minline-float-divide-max-throughput
9348 Generate code for inline divides of floating point values
9349 using the maximum throughput algorithm.
9351 @item -minline-int-divide-min-latency
9352 @opindex minline-int-divide-min-latency
9353 Generate code for inline divides of integer values
9354 using the minimum latency algorithm.
9356 @item -minline-int-divide-max-throughput
9357 @opindex minline-int-divide-max-throughput
9358 Generate code for inline divides of integer values
9359 using the maximum throughput algorithm.
9361 @item -minline-sqrt-min-latency
9362 @opindex minline-sqrt-min-latency
9363 Generate code for inline square roots
9364 using the minimum latency algorithm.
9366 @item -minline-sqrt-max-throughput
9367 @opindex minline-sqrt-max-throughput
9368 Generate code for inline square roots
9369 using the maximum throughput algorithm.
9371 @item -mno-dwarf2-asm
9372 @itemx -mdwarf2-asm
9373 @opindex mno-dwarf2-asm
9374 @opindex mdwarf2-asm
9375 Don't (or do) generate assembler code for the DWARF2 line number debugging
9376 info.  This may be useful when not using the GNU assembler.
9378 @item -mearly-stop-bits
9379 @itemx -mno-early-stop-bits
9380 @opindex mearly-stop-bits
9381 @opindex mno-early-stop-bits
9382 Allow stop bits to be placed earlier than immediately preceding the
9383 instruction that triggered the stop bit.  This can improve instruction
9384 scheduling, but does not always do so.
9386 @item -mfixed-range=@var{register-range}
9387 @opindex mfixed-range
9388 Generate code treating the given register range as fixed registers.
9389 A fixed register is one that the register allocator can not use.  This is
9390 useful when compiling kernel code.  A register range is specified as
9391 two registers separated by a dash.  Multiple register ranges can be
9392 specified separated by a comma.
9394 @item -mtls-size=@var{tls-size}
9395 @opindex mtls-size
9396 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9399 @item -mtune-arch=@var{cpu-type}
9400 @opindex mtune-arch
9401 Tune the instruction scheduling for a particular CPU, Valid values are
9402 itanium, itanium1, merced, itanium2, and mckinley.
9404 @item -mt
9405 @itemx -pthread
9406 @opindex mt
9407 @opindex pthread
9408 Add support for multithreading using the POSIX threads library.  This
9409 option sets flags for both the preprocessor and linker.  It does
9410 not affect the thread safety of object code produced by the compiler or
9411 that of libraries supplied with it.  These are HP-UX specific flags.
9413 @item -milp32
9414 @itemx -mlp64
9415 @opindex milp32
9416 @opindex mlp64
9417 Generate code for a 32-bit or 64-bit environment.
9418 The 32-bit environment sets int, long and pointer to 32 bits.
9419 The 64-bit environment sets int to 32 bits and long and pointer
9420 to 64 bits.  These are HP-UX specific flags.
9422 @end table
9424 @node M32C Options
9425 @subsection M32C Options
9426 @cindex M32C options
9428 @table @gcctabopt
9429 @item -mcpu=@var{name}
9430 @opindex mcpu=
9431 Select the CPU for which code is generated.  @var{name} may be one of
9432 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9433 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9434 the M32C/80 series.
9436 @item -msim
9437 @opindex msim
9438 Specifies that the program will be run on the simulator.  This causes
9439 an alternate runtime library to be linked in which supports, for
9440 example, file I/O.  You must not use this option when generating
9441 programs that will run on real hardware; you must provide your own
9442 runtime library for whatever I/O functions are needed.
9444 @item -memregs=@var{number}
9445 @opindex memregs=
9446 Specifies the number of memory-based pseudo-registers GCC will use
9447 during code generation.  These pseudo-registers will be used like real
9448 registers, so there is a tradeoff between GCC's ability to fit the
9449 code into available registers, and the performance penalty of using
9450 memory instead of registers.  Note that all modules in a program must
9451 be compiled with the same value for this option.  Because of that, you
9452 must not use this option with the default runtime libraries gcc
9453 builds.
9455 @end table
9457 @node M32R/D Options
9458 @subsection M32R/D Options
9459 @cindex M32R/D options
9461 These @option{-m} options are defined for Renesas M32R/D architectures:
9463 @table @gcctabopt
9464 @item -m32r2
9465 @opindex m32r2
9466 Generate code for the M32R/2@.
9468 @item -m32rx
9469 @opindex m32rx
9470 Generate code for the M32R/X@.
9472 @item -m32r
9473 @opindex m32r
9474 Generate code for the M32R@.  This is the default.
9476 @item -mmodel=small
9477 @opindex mmodel=small
9478 Assume all objects live in the lower 16MB of memory (so that their addresses
9479 can be loaded with the @code{ld24} instruction), and assume all subroutines
9480 are reachable with the @code{bl} instruction.
9481 This is the default.
9483 The addressability of a particular object can be set with the
9484 @code{model} attribute.
9486 @item -mmodel=medium
9487 @opindex mmodel=medium
9488 Assume objects may be anywhere in the 32-bit address space (the compiler
9489 will generate @code{seth/add3} instructions to load their addresses), and
9490 assume all subroutines are reachable with the @code{bl} instruction.
9492 @item -mmodel=large
9493 @opindex mmodel=large
9494 Assume objects may be anywhere in the 32-bit address space (the compiler
9495 will generate @code{seth/add3} instructions to load their addresses), and
9496 assume subroutines may not be reachable with the @code{bl} instruction
9497 (the compiler will generate the much slower @code{seth/add3/jl}
9498 instruction sequence).
9500 @item -msdata=none
9501 @opindex msdata=none
9502 Disable use of the small data area.  Variables will be put into
9503 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9504 @code{section} attribute has been specified).
9505 This is the default.
9507 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9508 Objects may be explicitly put in the small data area with the
9509 @code{section} attribute using one of these sections.
9511 @item -msdata=sdata
9512 @opindex msdata=sdata
9513 Put small global and static data in the small data area, but do not
9514 generate special code to reference them.
9516 @item -msdata=use
9517 @opindex msdata=use
9518 Put small global and static data in the small data area, and generate
9519 special instructions to reference them.
9521 @item -G @var{num}
9522 @opindex G
9523 @cindex smaller data references
9524 Put global and static objects less than or equal to @var{num} bytes
9525 into the small data or bss sections instead of the normal data or bss
9526 sections.  The default value of @var{num} is 8.
9527 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9528 for this option to have any effect.
9530 All modules should be compiled with the same @option{-G @var{num}} value.
9531 Compiling with different values of @var{num} may or may not work; if it
9532 doesn't the linker will give an error message---incorrect code will not be
9533 generated.
9535 @item -mdebug
9536 @opindex mdebug
9537 Makes the M32R specific code in the compiler display some statistics
9538 that might help in debugging programs.
9540 @item -malign-loops
9541 @opindex malign-loops
9542 Align all loops to a 32-byte boundary.
9544 @item -mno-align-loops
9545 @opindex mno-align-loops
9546 Do not enforce a 32-byte alignment for loops.  This is the default.
9548 @item -missue-rate=@var{number}
9549 @opindex missue-rate=@var{number}
9550 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9551 or 2.
9553 @item -mbranch-cost=@var{number}
9554 @opindex mbranch-cost=@var{number}
9555 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9556 preferred over conditional code, if it is 2, then the opposite will
9557 apply.
9559 @item -mflush-trap=@var{number}
9560 @opindex mflush-trap=@var{number}
9561 Specifies the trap number to use to flush the cache.  The default is
9562 12.  Valid numbers are between 0 and 15 inclusive.
9564 @item -mno-flush-trap
9565 @opindex mno-flush-trap
9566 Specifies that the cache cannot be flushed by using a trap.
9568 @item -mflush-func=@var{name}
9569 @opindex mflush-func=@var{name}
9570 Specifies the name of the operating system function to call to flush
9571 the cache.  The default is @emph{_flush_cache}, but a function call
9572 will only be used if a trap is not available.
9574 @item -mno-flush-func
9575 @opindex mno-flush-func
9576 Indicates that there is no OS function for flushing the cache.
9578 @end table
9580 @node M680x0 Options
9581 @subsection M680x0 Options
9582 @cindex M680x0 options
9584 These are the @samp{-m} options defined for the 68000 series.  The default
9585 values for these options depends on which style of 68000 was selected when
9586 the compiler was configured; the defaults for the most common choices are
9587 given below.
9589 @table @gcctabopt
9590 @item -m68000
9591 @itemx -mc68000
9592 @opindex m68000
9593 @opindex mc68000
9594 Generate output for a 68000.  This is the default
9595 when the compiler is configured for 68000-based systems.
9597 Use this option for microcontrollers with a 68000 or EC000 core,
9598 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9600 @item -m68020
9601 @itemx -mc68020
9602 @opindex m68020
9603 @opindex mc68020
9604 Generate output for a 68020.  This is the default
9605 when the compiler is configured for 68020-based systems.
9607 @item -m68881
9608 @opindex m68881
9609 Generate output containing 68881 instructions for floating point.
9610 This is the default for most 68020 systems unless @option{--nfp} was
9611 specified when the compiler was configured.
9613 @item -m68030
9614 @opindex m68030
9615 Generate output for a 68030.  This is the default when the compiler is
9616 configured for 68030-based systems.
9618 @item -m68040
9619 @opindex m68040
9620 Generate output for a 68040.  This is the default when the compiler is
9621 configured for 68040-based systems.
9623 This option inhibits the use of 68881/68882 instructions that have to be
9624 emulated by software on the 68040.  Use this option if your 68040 does not
9625 have code to emulate those instructions.
9627 @item -m68060
9628 @opindex m68060
9629 Generate output for a 68060.  This is the default when the compiler is
9630 configured for 68060-based systems.
9632 This option inhibits the use of 68020 and 68881/68882 instructions that
9633 have to be emulated by software on the 68060.  Use this option if your 68060
9634 does not have code to emulate those instructions.
9636 @item -mcpu32
9637 @opindex mcpu32
9638 Generate output for a CPU32.  This is the default
9639 when the compiler is configured for CPU32-based systems.
9641 Use this option for microcontrollers with a
9642 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9643 68336, 68340, 68341, 68349 and 68360.
9645 @item -m5200
9646 @opindex m5200
9647 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9648 when the compiler is configured for 520X-based systems.
9650 Use this option for microcontroller with a 5200 core, including
9651 the MCF5202, MCF5203, MCF5204 and MCF5202.
9654 @item -m68020-40
9655 @opindex m68020-40
9656 Generate output for a 68040, without using any of the new instructions.
9657 This results in code which can run relatively efficiently on either a
9658 68020/68881 or a 68030 or a 68040.  The generated code does use the
9659 68881 instructions that are emulated on the 68040.
9661 @item -m68020-60
9662 @opindex m68020-60
9663 Generate output for a 68060, without using any of the new instructions.
9664 This results in code which can run relatively efficiently on either a
9665 68020/68881 or a 68030 or a 68040.  The generated code does use the
9666 68881 instructions that are emulated on the 68060.
9668 @item -msoft-float
9669 @opindex msoft-float
9670 Generate output containing library calls for floating point.
9671 @strong{Warning:} the requisite libraries are not available for all m68k
9672 targets.  Normally the facilities of the machine's usual C compiler are
9673 used, but this can't be done directly in cross-compilation.  You must
9674 make your own arrangements to provide suitable library functions for
9675 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9676 @samp{m68k-*-coff} do provide software floating point support.
9678 @item -mshort
9679 @opindex mshort
9680 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9681 Additionally, parameters passed on the stack are also aligned to a
9682 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9684 @item -mnobitfield
9685 @opindex mnobitfield
9686 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9687 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9689 @item -mbitfield
9690 @opindex mbitfield
9691 Do use the bit-field instructions.  The @option{-m68020} option implies
9692 @option{-mbitfield}.  This is the default if you use a configuration
9693 designed for a 68020.
9695 @item -mrtd
9696 @opindex mrtd
9697 Use a different function-calling convention, in which functions
9698 that take a fixed number of arguments return with the @code{rtd}
9699 instruction, which pops their arguments while returning.  This
9700 saves one instruction in the caller since there is no need to pop
9701 the arguments there.
9703 This calling convention is incompatible with the one normally
9704 used on Unix, so you cannot use it if you need to call libraries
9705 compiled with the Unix compiler.
9707 Also, you must provide function prototypes for all functions that
9708 take variable numbers of arguments (including @code{printf});
9709 otherwise incorrect code will be generated for calls to those
9710 functions.
9712 In addition, seriously incorrect code will result if you call a
9713 function with too many arguments.  (Normally, extra arguments are
9714 harmlessly ignored.)
9716 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9717 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9719 @item -malign-int
9720 @itemx -mno-align-int
9721 @opindex malign-int
9722 @opindex mno-align-int
9723 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9724 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9725 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9726 Aligning variables on 32-bit boundaries produces code that runs somewhat
9727 faster on processors with 32-bit busses at the expense of more memory.
9729 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9730 align structures containing the above types  differently than
9731 most published application binary interface specifications for the m68k.
9733 @item -mpcrel
9734 @opindex mpcrel
9735 Use the pc-relative addressing mode of the 68000 directly, instead of
9736 using a global offset table.  At present, this option implies @option{-fpic},
9737 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9738 not presently supported with @option{-mpcrel}, though this could be supported for
9739 68020 and higher processors.
9741 @item -mno-strict-align
9742 @itemx -mstrict-align
9743 @opindex mno-strict-align
9744 @opindex mstrict-align
9745 Do not (do) assume that unaligned memory references will be handled by
9746 the system.
9748 @item -msep-data
9749 Generate code that allows the data segment to be located in a different
9750 area of memory from the text segment.  This allows for execute in place in
9751 an environment without virtual memory management.  This option implies
9752 @option{-fPIC}.
9754 @item -mno-sep-data
9755 Generate code that assumes that the data segment follows the text segment.
9756 This is the default.
9758 @item -mid-shared-library
9759 Generate code that supports shared libraries via the library ID method.
9760 This allows for execute in place and shared libraries in an environment
9761 without virtual memory management.  This option implies @option{-fPIC}.
9763 @item -mno-id-shared-library
9764 Generate code that doesn't assume ID based shared libraries are being used.
9765 This is the default.
9767 @item -mshared-library-id=n
9768 Specified the identification number of the ID based shared library being
9769 compiled.  Specifying a value of 0 will generate more compact code, specifying
9770 other values will force the allocation of that number to the current
9771 library but is no more space or time efficient than omitting this option.
9773 @end table
9775 @node M68hc1x Options
9776 @subsection M68hc1x Options
9777 @cindex M68hc1x options
9779 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9780 microcontrollers.  The default values for these options depends on
9781 which style of microcontroller was selected when the compiler was configured;
9782 the defaults for the most common choices are given below.
9784 @table @gcctabopt
9785 @item -m6811
9786 @itemx -m68hc11
9787 @opindex m6811
9788 @opindex m68hc11
9789 Generate output for a 68HC11.  This is the default
9790 when the compiler is configured for 68HC11-based systems.
9792 @item -m6812
9793 @itemx -m68hc12
9794 @opindex m6812
9795 @opindex m68hc12
9796 Generate output for a 68HC12.  This is the default
9797 when the compiler is configured for 68HC12-based systems.
9799 @item -m68S12
9800 @itemx -m68hcs12
9801 @opindex m68S12
9802 @opindex m68hcs12
9803 Generate output for a 68HCS12.
9805 @item -mauto-incdec
9806 @opindex mauto-incdec
9807 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9808 addressing modes.
9810 @item -minmax
9811 @itemx -nominmax
9812 @opindex minmax
9813 @opindex mnominmax
9814 Enable the use of 68HC12 min and max instructions.
9816 @item -mlong-calls
9817 @itemx -mno-long-calls
9818 @opindex mlong-calls
9819 @opindex mno-long-calls
9820 Treat all calls as being far away (near).  If calls are assumed to be
9821 far away, the compiler will use the @code{call} instruction to
9822 call a function and the @code{rtc} instruction for returning.
9824 @item -mshort
9825 @opindex mshort
9826 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9828 @item -msoft-reg-count=@var{count}
9829 @opindex msoft-reg-count
9830 Specify the number of pseudo-soft registers which are used for the
9831 code generation.  The maximum number is 32.  Using more pseudo-soft
9832 register may or may not result in better code depending on the program.
9833 The default is 4 for 68HC11 and 2 for 68HC12.
9835 @end table
9837 @node MCore Options
9838 @subsection MCore Options
9839 @cindex MCore options
9841 These are the @samp{-m} options defined for the Motorola M*Core
9842 processors.
9844 @table @gcctabopt
9846 @item -mhardlit
9847 @itemx -mno-hardlit
9848 @opindex mhardlit
9849 @opindex mno-hardlit
9850 Inline constants into the code stream if it can be done in two
9851 instructions or less.
9853 @item -mdiv
9854 @itemx -mno-div
9855 @opindex mdiv
9856 @opindex mno-div
9857 Use the divide instruction.  (Enabled by default).
9859 @item -mrelax-immediate
9860 @itemx -mno-relax-immediate
9861 @opindex mrelax-immediate
9862 @opindex mno-relax-immediate
9863 Allow arbitrary sized immediates in bit operations.
9865 @item -mwide-bitfields
9866 @itemx -mno-wide-bitfields
9867 @opindex mwide-bitfields
9868 @opindex mno-wide-bitfields
9869 Always treat bit-fields as int-sized.
9871 @item -m4byte-functions
9872 @itemx -mno-4byte-functions
9873 @opindex m4byte-functions
9874 @opindex mno-4byte-functions
9875 Force all functions to be aligned to a four byte boundary.
9877 @item -mcallgraph-data
9878 @itemx -mno-callgraph-data
9879 @opindex mcallgraph-data
9880 @opindex mno-callgraph-data
9881 Emit callgraph information.
9883 @item -mslow-bytes
9884 @itemx -mno-slow-bytes
9885 @opindex mslow-bytes
9886 @opindex mno-slow-bytes
9887 Prefer word access when reading byte quantities.
9889 @item -mlittle-endian
9890 @itemx -mbig-endian
9891 @opindex mlittle-endian
9892 @opindex mbig-endian
9893 Generate code for a little endian target.
9895 @item -m210
9896 @itemx -m340
9897 @opindex m210
9898 @opindex m340
9899 Generate code for the 210 processor.
9900 @end table
9902 @node MIPS Options
9903 @subsection MIPS Options
9904 @cindex MIPS options
9906 @table @gcctabopt
9908 @item -EB
9909 @opindex EB
9910 Generate big-endian code.
9912 @item -EL
9913 @opindex EL
9914 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9915 configurations.
9917 @item -march=@var{arch}
9918 @opindex march
9919 Generate code that will run on @var{arch}, which can be the name of a
9920 generic MIPS ISA, or the name of a particular processor.
9921 The ISA names are:
9922 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9923 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9924 The processor names are:
9925 @samp{4kc}, @samp{4km}, @samp{4kp},
9926 @samp{5kc}, @samp{5kf},
9927 @samp{20kc},
9928 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
9929 @samp{m4k},
9930 @samp{orion},
9931 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9932 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
9933 @samp{rm7000}, @samp{rm9000},
9934 @samp{sb1},
9935 @samp{sr71000},
9936 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9937 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9938 The special value @samp{from-abi} selects the
9939 most compatible architecture for the selected ABI (that is,
9940 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9942 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9943 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9944 @samp{vr} may be written @samp{r}.
9946 GCC defines two macros based on the value of this option.  The first
9947 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9948 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9949 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9950 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9951 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9953 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9954 above.  In other words, it will have the full prefix and will not
9955 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9956 the macro names the resolved architecture (either @samp{"mips1"} or
9957 @samp{"mips3"}).  It names the default architecture when no
9958 @option{-march} option is given.
9960 @item -mtune=@var{arch}
9961 @opindex mtune
9962 Optimize for @var{arch}.  Among other things, this option controls
9963 the way instructions are scheduled, and the perceived cost of arithmetic
9964 operations.  The list of @var{arch} values is the same as for
9965 @option{-march}.
9967 When this option is not used, GCC will optimize for the processor
9968 specified by @option{-march}.  By using @option{-march} and
9969 @option{-mtune} together, it is possible to generate code that will
9970 run on a family of processors, but optimize the code for one
9971 particular member of that family.
9973 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9974 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9975 @samp{-march} ones described above.
9977 @item -mips1
9978 @opindex mips1
9979 Equivalent to @samp{-march=mips1}.
9981 @item -mips2
9982 @opindex mips2
9983 Equivalent to @samp{-march=mips2}.
9985 @item -mips3
9986 @opindex mips3
9987 Equivalent to @samp{-march=mips3}.
9989 @item -mips4
9990 @opindex mips4
9991 Equivalent to @samp{-march=mips4}.
9993 @item -mips32
9994 @opindex mips32
9995 Equivalent to @samp{-march=mips32}.
9997 @item -mips32r2
9998 @opindex mips32r2
9999 Equivalent to @samp{-march=mips32r2}.
10001 @item -mips64
10002 @opindex mips64
10003 Equivalent to @samp{-march=mips64}.
10005 @item -mips16
10006 @itemx -mno-mips16
10007 @opindex mips16
10008 @opindex mno-mips16
10009 Generate (do not generate) MIPS16 code.  If GCC is targetting a
10010 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10012 @item -mabi=32
10013 @itemx -mabi=o64
10014 @itemx -mabi=n32
10015 @itemx -mabi=64
10016 @itemx -mabi=eabi
10017 @opindex mabi=32
10018 @opindex mabi=o64
10019 @opindex mabi=n32
10020 @opindex mabi=64
10021 @opindex mabi=eabi
10022 Generate code for the given ABI@.
10024 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
10025 generates 64-bit code when you select a 64-bit architecture, but you
10026 can use @option{-mgp32} to get 32-bit code instead.
10028 For information about the O64 ABI, see
10029 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10031 @item -mabicalls
10032 @itemx -mno-abicalls
10033 @opindex mabicalls
10034 @opindex mno-abicalls
10035 Generate (do not generate) SVR4-style position-independent code.
10036 @option{-mabicalls} is the default for SVR4-based systems.
10038 @item -mxgot
10039 @itemx -mno-xgot
10040 @opindex mxgot
10041 @opindex mno-xgot
10042 Lift (do not lift) the usual restrictions on the size of the global
10043 offset table.
10045 GCC normally uses a single instruction to load values from the GOT@.
10046 While this is relatively efficient, it will only work if the GOT
10047 is smaller than about 64k.  Anything larger will cause the linker
10048 to report an error such as:
10050 @cindex relocation truncated to fit (MIPS)
10051 @smallexample
10052 relocation truncated to fit: R_MIPS_GOT16 foobar
10053 @end smallexample
10055 If this happens, you should recompile your code with @option{-mxgot}.
10056 It should then work with very large GOTs, although it will also be
10057 less efficient, since it will take three instructions to fetch the
10058 value of a global symbol.
10060 Note that some linkers can create multiple GOTs.  If you have such a
10061 linker, you should only need to use @option{-mxgot} when a single object
10062 file accesses more than 64k's worth of GOT entries.  Very few do.
10064 These options have no effect unless GCC is generating position
10065 independent code.
10067 @item -mgp32
10068 @opindex mgp32
10069 Assume that general-purpose registers are 32 bits wide.
10071 @item -mgp64
10072 @opindex mgp64
10073 Assume that general-purpose registers are 64 bits wide.
10075 @item -mfp32
10076 @opindex mfp32
10077 Assume that floating-point registers are 32 bits wide.
10079 @item -mfp64
10080 @opindex mfp64
10081 Assume that floating-point registers are 64 bits wide.
10083 @item -mhard-float
10084 @opindex mhard-float
10085 Use floating-point coprocessor instructions.
10087 @item -msoft-float
10088 @opindex msoft-float
10089 Do not use floating-point coprocessor instructions.  Implement
10090 floating-point calculations using library calls instead.
10092 @item -msingle-float
10093 @opindex msingle-float
10094 Assume that the floating-point coprocessor only supports single-precision
10095 operations.
10097 @itemx -mdouble-float
10098 @opindex mdouble-float
10099 Assume that the floating-point coprocessor supports double-precision
10100 operations.  This is the default.
10102 @itemx -mdsp
10103 @itemx -mno-dsp
10104 @opindex mdsp
10105 @opindex mno-dsp
10106 Use (do not use) the MIPS DSP ASE.  @xref{MIPS DSP Built-in Functions}.
10108 @itemx -mpaired-single
10109 @itemx -mno-paired-single
10110 @opindex mpaired-single
10111 @opindex mno-paired-single
10112 Use (do not use) paired-single floating-point instructions.
10113 @xref{MIPS Paired-Single Support}.  This option can only be used
10114 when generating 64-bit code and requires hardware floating-point
10115 support to be enabled.
10117 @itemx -mips3d
10118 @itemx -mno-mips3d
10119 @opindex mips3d
10120 @opindex mno-mips3d
10121 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
10122 The option @option{-mips3d} implies @option{-mpaired-single}.
10124 @item -mlong64
10125 @opindex mlong64
10126 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
10127 an explanation of the default and the way that the pointer size is
10128 determined.
10130 @item -mlong32
10131 @opindex mlong32
10132 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10134 The default size of @code{int}s, @code{long}s and pointers depends on
10135 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
10136 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10137 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
10138 or the same size as integer registers, whichever is smaller.
10140 @item -msym32
10141 @itemx -mno-sym32
10142 @opindex msym32
10143 @opindex mno-sym32
10144 Assume (do not assume) that all symbols have 32-bit values, regardless
10145 of the selected ABI@.  This option is useful in combination with
10146 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10147 to generate shorter and faster references to symbolic addresses.
10149 @item -G @var{num}
10150 @opindex G
10151 @cindex smaller data references (MIPS)
10152 @cindex gp-relative references (MIPS)
10153 Put global and static items less than or equal to @var{num} bytes into
10154 the small data or bss section instead of the normal data or bss section.
10155 This allows the data to be accessed using a single instruction.
10157 All modules should be compiled with the same @option{-G @var{num}}
10158 value.
10160 @item -membedded-data
10161 @itemx -mno-embedded-data
10162 @opindex membedded-data
10163 @opindex mno-embedded-data
10164 Allocate variables to the read-only data section first if possible, then
10165 next in the small data section if possible, otherwise in data.  This gives
10166 slightly slower code than the default, but reduces the amount of RAM required
10167 when executing, and thus may be preferred for some embedded systems.
10169 @item -muninit-const-in-rodata
10170 @itemx -mno-uninit-const-in-rodata
10171 @opindex muninit-const-in-rodata
10172 @opindex mno-uninit-const-in-rodata
10173 Put uninitialized @code{const} variables in the read-only data section.
10174 This option is only meaningful in conjunction with @option{-membedded-data}.
10176 @item -msplit-addresses
10177 @itemx -mno-split-addresses
10178 @opindex msplit-addresses
10179 @opindex mno-split-addresses
10180 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10181 relocation operators.  This option has been superseded by
10182 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10184 @item -mexplicit-relocs
10185 @itemx -mno-explicit-relocs
10186 @opindex mexplicit-relocs
10187 @opindex mno-explicit-relocs
10188 Use (do not use) assembler relocation operators when dealing with symbolic
10189 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
10190 is to use assembler macros instead.
10192 @option{-mexplicit-relocs} is the default if GCC was configured
10193 to use an assembler that supports relocation operators.
10195 @item -mcheck-zero-division
10196 @itemx -mno-check-zero-division
10197 @opindex mcheck-zero-division
10198 @opindex mno-check-zero-division
10199 Trap (do not trap) on integer division by zero.  The default is
10200 @option{-mcheck-zero-division}.
10202 @item -mdivide-traps
10203 @itemx -mdivide-breaks
10204 @opindex mdivide-traps
10205 @opindex mdivide-breaks
10206 MIPS systems check for division by zero by generating either a
10207 conditional trap or a break instruction.  Using traps results in
10208 smaller code, but is only supported on MIPS II and later.  Also, some
10209 versions of the Linux kernel have a bug that prevents trap from
10210 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
10211 allow conditional traps on architectures that support them and
10212 @option{-mdivide-breaks} to force the use of breaks.
10214 The default is usually @option{-mdivide-traps}, but this can be
10215 overridden at configure time using @option{--with-divide=breaks}.
10216 Divide-by-zero checks can be completely disabled using
10217 @option{-mno-check-zero-division}.
10219 @item -mmemcpy
10220 @itemx -mno-memcpy
10221 @opindex mmemcpy
10222 @opindex mno-memcpy
10223 Force (do not force) the use of @code{memcpy()} for non-trivial block
10224 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
10225 most constant-sized copies.
10227 @item -mlong-calls
10228 @itemx -mno-long-calls
10229 @opindex mlong-calls
10230 @opindex mno-long-calls
10231 Disable (do not disable) use of the @code{jal} instruction.  Calling
10232 functions using @code{jal} is more efficient but requires the caller
10233 and callee to be in the same 256 megabyte segment.
10235 This option has no effect on abicalls code.  The default is
10236 @option{-mno-long-calls}.
10238 @item -mmad
10239 @itemx -mno-mad
10240 @opindex mmad
10241 @opindex mno-mad
10242 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10243 instructions, as provided by the R4650 ISA@.
10245 @item -mfused-madd
10246 @itemx -mno-fused-madd
10247 @opindex mfused-madd
10248 @opindex mno-fused-madd
10249 Enable (disable) use of the floating point multiply-accumulate
10250 instructions, when they are available.  The default is
10251 @option{-mfused-madd}.
10253 When multiply-accumulate instructions are used, the intermediate
10254 product is calculated to infinite precision and is not subject to
10255 the FCSR Flush to Zero bit.  This may be undesirable in some
10256 circumstances.
10258 @item -nocpp
10259 @opindex nocpp
10260 Tell the MIPS assembler to not run its preprocessor over user
10261 assembler files (with a @samp{.s} suffix) when assembling them.
10263 @item -mfix-r4000
10264 @itemx -mno-fix-r4000
10265 @opindex mfix-r4000
10266 @opindex mno-fix-r4000
10267 Work around certain R4000 CPU errata:
10268 @itemize @minus
10269 @item
10270 A double-word or a variable shift may give an incorrect result if executed
10271 immediately after starting an integer division.
10272 @item
10273 A double-word or a variable shift may give an incorrect result if executed
10274 while an integer multiplication is in progress.
10275 @item
10276 An integer division may give an incorrect result if started in a delay slot
10277 of a taken branch or a jump.
10278 @end itemize
10280 @item -mfix-r4400
10281 @itemx -mno-fix-r4400
10282 @opindex mfix-r4400
10283 @opindex mno-fix-r4400
10284 Work around certain R4400 CPU errata:
10285 @itemize @minus
10286 @item
10287 A double-word or a variable shift may give an incorrect result if executed
10288 immediately after starting an integer division.
10289 @end itemize
10291 @item -mfix-vr4120
10292 @itemx -mno-fix-vr4120
10293 @opindex mfix-vr4120
10294 Work around certain VR4120 errata:
10295 @itemize @minus
10296 @item
10297 @code{dmultu} does not always produce the correct result.
10298 @item
10299 @code{div} and @code{ddiv} do not always produce the correct result if one
10300 of the operands is negative.
10301 @end itemize
10302 The workarounds for the division errata rely on special functions in
10303 @file{libgcc.a}.  At present, these functions are only provided by
10304 the @code{mips64vr*-elf} configurations.
10306 Other VR4120 errata require a nop to be inserted between certain pairs of
10307 instructions.  These errata are handled by the assembler, not by GCC itself.
10309 @item -mfix-vr4130
10310 @opindex mfix-vr4130
10311 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
10312 workarounds are implemented by the assembler rather than by GCC,
10313 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10314 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10315 instructions are available instead.
10317 @item -mfix-sb1
10318 @itemx -mno-fix-sb1
10319 @opindex mfix-sb1
10320 Work around certain SB-1 CPU core errata.
10321 (This flag currently works around the SB-1 revision 2
10322 ``F1'' and ``F2'' floating point errata.)
10324 @item -mflush-func=@var{func}
10325 @itemx -mno-flush-func
10326 @opindex mflush-func
10327 Specifies the function to call to flush the I and D caches, or to not
10328 call any such function.  If called, the function must take the same
10329 arguments as the common @code{_flush_func()}, that is, the address of the
10330 memory range for which the cache is being flushed, the size of the
10331 memory range, and the number 3 (to flush both caches).  The default
10332 depends on the target GCC was configured for, but commonly is either
10333 @samp{_flush_func} or @samp{__cpu_flush}.
10335 @item -mbranch-likely
10336 @itemx -mno-branch-likely
10337 @opindex mbranch-likely
10338 @opindex mno-branch-likely
10339 Enable or disable use of Branch Likely instructions, regardless of the
10340 default for the selected architecture.  By default, Branch Likely
10341 instructions may be generated if they are supported by the selected
10342 architecture.  An exception is for the MIPS32 and MIPS64 architectures
10343 and processors which implement those architectures; for those, Branch
10344 Likely instructions will not be generated by default because the MIPS32
10345 and MIPS64 architectures specifically deprecate their use.
10347 @item -mfp-exceptions
10348 @itemx -mno-fp-exceptions
10349 @opindex mfp-exceptions
10350 Specifies whether FP exceptions are enabled.  This affects how we schedule
10351 FP instructions for some processors.  The default is that FP exceptions are
10352 enabled.
10354 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10355 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
10356 FP pipe.
10358 @item -mvr4130-align
10359 @itemx -mno-vr4130-align
10360 @opindex mvr4130-align
10361 The VR4130 pipeline is two-way superscalar, but can only issue two
10362 instructions together if the first one is 8-byte aligned.  When this
10363 option is enabled, GCC will align pairs of instructions that it
10364 thinks should execute in parallel.
10366 This option only has an effect when optimizing for the VR4130.
10367 It normally makes code faster, but at the expense of making it bigger.
10368 It is enabled by default at optimization level @option{-O3}.
10369 @end table
10371 @node MMIX Options
10372 @subsection MMIX Options
10373 @cindex MMIX Options
10375 These options are defined for the MMIX:
10377 @table @gcctabopt
10378 @item -mlibfuncs
10379 @itemx -mno-libfuncs
10380 @opindex mlibfuncs
10381 @opindex mno-libfuncs
10382 Specify that intrinsic library functions are being compiled, passing all
10383 values in registers, no matter the size.
10385 @item -mepsilon
10386 @itemx -mno-epsilon
10387 @opindex mepsilon
10388 @opindex mno-epsilon
10389 Generate floating-point comparison instructions that compare with respect
10390 to the @code{rE} epsilon register.
10392 @item -mabi=mmixware
10393 @itemx -mabi=gnu
10394 @opindex mabi-mmixware
10395 @opindex mabi=gnu
10396 Generate code that passes function parameters and return values that (in
10397 the called function) are seen as registers @code{$0} and up, as opposed to
10398 the GNU ABI which uses global registers @code{$231} and up.
10400 @item -mzero-extend
10401 @itemx -mno-zero-extend
10402 @opindex mzero-extend
10403 @opindex mno-zero-extend
10404 When reading data from memory in sizes shorter than 64 bits, use (do not
10405 use) zero-extending load instructions by default, rather than
10406 sign-extending ones.
10408 @item -mknuthdiv
10409 @itemx -mno-knuthdiv
10410 @opindex mknuthdiv
10411 @opindex mno-knuthdiv
10412 Make the result of a division yielding a remainder have the same sign as
10413 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10414 remainder follows the sign of the dividend.  Both methods are
10415 arithmetically valid, the latter being almost exclusively used.
10417 @item -mtoplevel-symbols
10418 @itemx -mno-toplevel-symbols
10419 @opindex mtoplevel-symbols
10420 @opindex mno-toplevel-symbols
10421 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10422 code can be used with the @code{PREFIX} assembly directive.
10424 @item -melf
10425 @opindex melf
10426 Generate an executable in the ELF format, rather than the default
10427 @samp{mmo} format used by the @command{mmix} simulator.
10429 @item -mbranch-predict
10430 @itemx -mno-branch-predict
10431 @opindex mbranch-predict
10432 @opindex mno-branch-predict
10433 Use (do not use) the probable-branch instructions, when static branch
10434 prediction indicates a probable branch.
10436 @item -mbase-addresses
10437 @itemx -mno-base-addresses
10438 @opindex mbase-addresses
10439 @opindex mno-base-addresses
10440 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10441 base address automatically generates a request (handled by the assembler
10442 and the linker) for a constant to be set up in a global register.  The
10443 register is used for one or more base address requests within the range 0
10444 to 255 from the value held in the register.  The generally leads to short
10445 and fast code, but the number of different data items that can be
10446 addressed is limited.  This means that a program that uses lots of static
10447 data may require @option{-mno-base-addresses}.
10449 @item -msingle-exit
10450 @itemx -mno-single-exit
10451 @opindex msingle-exit
10452 @opindex mno-single-exit
10453 Force (do not force) generated code to have a single exit point in each
10454 function.
10455 @end table
10457 @node MN10300 Options
10458 @subsection MN10300 Options
10459 @cindex MN10300 options
10461 These @option{-m} options are defined for Matsushita MN10300 architectures:
10463 @table @gcctabopt
10464 @item -mmult-bug
10465 @opindex mmult-bug
10466 Generate code to avoid bugs in the multiply instructions for the MN10300
10467 processors.  This is the default.
10469 @item -mno-mult-bug
10470 @opindex mno-mult-bug
10471 Do not generate code to avoid bugs in the multiply instructions for the
10472 MN10300 processors.
10474 @item -mam33
10475 @opindex mam33
10476 Generate code which uses features specific to the AM33 processor.
10478 @item -mno-am33
10479 @opindex mno-am33
10480 Do not generate code which uses features specific to the AM33 processor.  This
10481 is the default.
10483 @item -mno-crt0
10484 @opindex mno-crt0
10485 Do not link in the C run-time initialization object file.
10487 @item -mrelax
10488 @opindex mrelax
10489 Indicate to the linker that it should perform a relaxation optimization pass
10490 to shorten branches, calls and absolute memory addresses.  This option only
10491 has an effect when used on the command line for the final link step.
10493 This option makes symbolic debugging impossible.
10494 @end table
10496 @node PDP-11 Options
10497 @subsection PDP-11 Options
10498 @cindex PDP-11 Options
10500 These options are defined for the PDP-11:
10502 @table @gcctabopt
10503 @item -mfpu
10504 @opindex mfpu
10505 Use hardware FPP floating point.  This is the default.  (FIS floating
10506 point on the PDP-11/40 is not supported.)
10508 @item -msoft-float
10509 @opindex msoft-float
10510 Do not use hardware floating point.
10512 @item -mac0
10513 @opindex mac0
10514 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10516 @item -mno-ac0
10517 @opindex mno-ac0
10518 Return floating-point results in memory.  This is the default.
10520 @item -m40
10521 @opindex m40
10522 Generate code for a PDP-11/40.
10524 @item -m45
10525 @opindex m45
10526 Generate code for a PDP-11/45.  This is the default.
10528 @item -m10
10529 @opindex m10
10530 Generate code for a PDP-11/10.
10532 @item -mbcopy-builtin
10533 @opindex bcopy-builtin
10534 Use inline @code{movmemhi} patterns for copying memory.  This is the
10535 default.
10537 @item -mbcopy
10538 @opindex mbcopy
10539 Do not use inline @code{movmemhi} patterns for copying memory.
10541 @item -mint16
10542 @itemx -mno-int32
10543 @opindex mint16
10544 @opindex mno-int32
10545 Use 16-bit @code{int}.  This is the default.
10547 @item -mint32
10548 @itemx -mno-int16
10549 @opindex mint32
10550 @opindex mno-int16
10551 Use 32-bit @code{int}.
10553 @item -mfloat64
10554 @itemx -mno-float32
10555 @opindex mfloat64
10556 @opindex mno-float32
10557 Use 64-bit @code{float}.  This is the default.
10559 @item -mfloat32
10560 @itemx -mno-float64
10561 @opindex mfloat32
10562 @opindex mno-float64
10563 Use 32-bit @code{float}.
10565 @item -mabshi
10566 @opindex mabshi
10567 Use @code{abshi2} pattern.  This is the default.
10569 @item -mno-abshi
10570 @opindex mno-abshi
10571 Do not use @code{abshi2} pattern.
10573 @item -mbranch-expensive
10574 @opindex mbranch-expensive
10575 Pretend that branches are expensive.  This is for experimenting with
10576 code generation only.
10578 @item -mbranch-cheap
10579 @opindex mbranch-cheap
10580 Do not pretend that branches are expensive.  This is the default.
10582 @item -msplit
10583 @opindex msplit
10584 Generate code for a system with split I&D@.
10586 @item -mno-split
10587 @opindex mno-split
10588 Generate code for a system without split I&D@.  This is the default.
10590 @item -munix-asm
10591 @opindex munix-asm
10592 Use Unix assembler syntax.  This is the default when configured for
10593 @samp{pdp11-*-bsd}.
10595 @item -mdec-asm
10596 @opindex mdec-asm
10597 Use DEC assembler syntax.  This is the default when configured for any
10598 PDP-11 target other than @samp{pdp11-*-bsd}.
10599 @end table
10601 @node PowerPC Options
10602 @subsection PowerPC Options
10603 @cindex PowerPC options
10605 These are listed under @xref{RS/6000 and PowerPC Options}.
10607 @node RS/6000 and PowerPC Options
10608 @subsection IBM RS/6000 and PowerPC Options
10609 @cindex RS/6000 and PowerPC Options
10610 @cindex IBM RS/6000 and PowerPC Options
10612 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10613 @table @gcctabopt
10614 @item -mpower
10615 @itemx -mno-power
10616 @itemx -mpower2
10617 @itemx -mno-power2
10618 @itemx -mpowerpc
10619 @itemx -mno-powerpc
10620 @itemx -mpowerpc-gpopt
10621 @itemx -mno-powerpc-gpopt
10622 @itemx -mpowerpc-gfxopt
10623 @itemx -mno-powerpc-gfxopt
10624 @itemx -mpowerpc64
10625 @itemx -mno-powerpc64
10626 @opindex mpower
10627 @opindex mno-power
10628 @opindex mpower2
10629 @opindex mno-power2
10630 @opindex mpowerpc
10631 @opindex mno-powerpc
10632 @opindex mpowerpc-gpopt
10633 @opindex mno-powerpc-gpopt
10634 @opindex mpowerpc-gfxopt
10635 @opindex mno-powerpc-gfxopt
10636 @opindex mpowerpc64
10637 @opindex mno-powerpc64
10638 GCC supports two related instruction set architectures for the
10639 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10640 instructions supported by the @samp{rios} chip set used in the original
10641 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10642 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10643 the IBM 4xx microprocessors.
10645 Neither architecture is a subset of the other.  However there is a
10646 large common subset of instructions supported by both.  An MQ
10647 register is included in processors supporting the POWER architecture.
10649 You use these options to specify which instructions are available on the
10650 processor you are using.  The default value of these options is
10651 determined when configuring GCC@.  Specifying the
10652 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10653 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10654 rather than the options listed above.
10656 The @option{-mpower} option allows GCC to generate instructions that
10657 are found only in the POWER architecture and to use the MQ register.
10658 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10659 to generate instructions that are present in the POWER2 architecture but
10660 not the original POWER architecture.
10662 The @option{-mpowerpc} option allows GCC to generate instructions that
10663 are found only in the 32-bit subset of the PowerPC architecture.
10664 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10665 GCC to use the optional PowerPC architecture instructions in the
10666 General Purpose group, including floating-point square root.  Specifying
10667 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10668 use the optional PowerPC architecture instructions in the Graphics
10669 group, including floating-point select.
10671 The @option{-mpowerpc64} option allows GCC to generate the additional
10672 64-bit instructions that are found in the full PowerPC64 architecture
10673 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10674 @option{-mno-powerpc64}.
10676 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10677 will use only the instructions in the common subset of both
10678 architectures plus some special AIX common-mode calls, and will not use
10679 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10680 permits GCC to use any instruction from either architecture and to
10681 allow use of the MQ register; specify this for the Motorola MPC601.
10683 @item -mnew-mnemonics
10684 @itemx -mold-mnemonics
10685 @opindex mnew-mnemonics
10686 @opindex mold-mnemonics
10687 Select which mnemonics to use in the generated assembler code.  With
10688 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10689 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10690 assembler mnemonics defined for the POWER architecture.  Instructions
10691 defined in only one architecture have only one mnemonic; GCC uses that
10692 mnemonic irrespective of which of these options is specified.
10694 GCC defaults to the mnemonics appropriate for the architecture in
10695 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10696 value of these option.  Unless you are building a cross-compiler, you
10697 should normally not specify either @option{-mnew-mnemonics} or
10698 @option{-mold-mnemonics}, but should instead accept the default.
10700 @item -mcpu=@var{cpu_type}
10701 @opindex mcpu
10702 Set architecture type, register usage, choice of mnemonics, and
10703 instruction scheduling parameters for machine type @var{cpu_type}.
10704 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10705 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10706 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10707 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10708 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10709 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10710 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10711 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10712 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10714 @option{-mcpu=common} selects a completely generic processor.  Code
10715 generated under this option will run on any POWER or PowerPC processor.
10716 GCC will use only the instructions in the common subset of both
10717 architectures, and will not use the MQ register.  GCC assumes a generic
10718 processor model for scheduling purposes.
10720 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10721 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10722 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10723 types, with an appropriate, generic processor model assumed for
10724 scheduling purposes.
10726 The other options specify a specific processor.  Code generated under
10727 those options will run best on that processor, and may not run at all on
10728 others.
10730 The @option{-mcpu} options automatically enable or disable the
10731 following options: @option{-maltivec}, @option{-mhard-float},
10732 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10733 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10734 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10735 @option{-mstring}.  The particular options set for any particular CPU
10736 will vary between compiler versions, depending on what setting seems
10737 to produce optimal code for that CPU; it doesn't necessarily reflect
10738 the actual hardware's capabilities.  If you wish to set an individual
10739 option to a particular value, you may specify it after the
10740 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10742 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10743 not enabled or disabled by the @option{-mcpu} option at present, since
10744 AIX does not have full support for these options.  You may still
10745 enable or disable them individually if you're sure it'll work in your
10746 environment.
10748 @item -mtune=@var{cpu_type}
10749 @opindex mtune
10750 Set the instruction scheduling parameters for machine type
10751 @var{cpu_type}, but do not set the architecture type, register usage, or
10752 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10753 values for @var{cpu_type} are used for @option{-mtune} as for
10754 @option{-mcpu}.  If both are specified, the code generated will use the
10755 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10756 scheduling parameters set by @option{-mtune}.
10758 @item -mswdiv
10759 @itemx -mno-swdiv
10760 @opindex mswdiv
10761 @opindex mno-swdiv
10762 Generate code to compute division as reciprocal estimate and iterative
10763 refinement, creating opportunities for increased throughput.  This
10764 feature requires: optional PowerPC Graphics instruction set for single
10765 precision and FRE instruction for double precision, assuming divides
10766 cannot generate user-visible traps, and the domain values not include
10767 Infinities, denormals or zero denominator.
10769 @item -maltivec
10770 @itemx -mno-altivec
10771 @opindex maltivec
10772 @opindex mno-altivec
10773 Generate code that uses (does not use) AltiVec instructions, and also
10774 enable the use of built-in functions that allow more direct access to
10775 the AltiVec instruction set.  You may also need to set
10776 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10777 enhancements.
10779 @item -mvrsave
10780 @item -mno-vrsave
10781 @opindex mvrsave
10782 @opindex mno-vrsave
10783 Generate VRSAVE instructions when generating AltiVec code.
10785 @item -mabi=spe
10786 @opindex mabi=spe
10787 Extend the current ABI with SPE ABI extensions.  This does not change
10788 the default ABI, instead it adds the SPE ABI extensions to the current
10789 ABI@.
10791 @item -mabi=no-spe
10792 @opindex mabi=no-spe
10793 Disable Booke SPE ABI extensions for the current ABI@.
10795 @item -msecure-plt
10796 @opindex msecure-plt
10797 Generate code that allows ld and ld.so to build executables and shared
10798 libraries with non-exec .plt and .got sections.  This is a PowerPC
10799 32-bit SYSV ABI option.
10801 @item -mbss-plt
10802 @opindex mbss-plt
10803 Generate code that uses a BSS .plt section that ld.so fills in, and
10804 requires .plt and .got sections that are both writable and executable.
10805 This is a PowerPC 32-bit SYSV ABI option.
10807 @item -misel
10808 @itemx -mno-isel
10809 @opindex misel
10810 @opindex mno-isel
10811 This switch enables or disables the generation of ISEL instructions.
10813 @item -misel=@var{yes/no}
10814 This switch has been deprecated.  Use @option{-misel} and
10815 @option{-mno-isel} instead.
10817 @item -mspe
10818 @itemx -mno-isel
10819 @opindex mspe
10820 @opindex mno-spe
10821 This switch enables or disables the generation of SPE simd
10822 instructions.
10824 @item -mspe=@var{yes/no}
10825 This option has been deprecated.  Use @option{-mspe} and
10826 @option{-mno-spe} instead.
10828 @item -mfloat-gprs=@var{yes/single/double/no}
10829 @itemx -mfloat-gprs
10830 @opindex mfloat-gprs
10831 This switch enables or disables the generation of floating point
10832 operations on the general purpose registers for architectures that
10833 support it.
10835 The argument @var{yes} or @var{single} enables the use of
10836 single-precision floating point operations.
10838 The argument @var{double} enables the use of single and
10839 double-precision floating point operations.
10841 The argument @var{no} disables floating point operations on the
10842 general purpose registers.
10844 This option is currently only available on the MPC854x.
10846 @item -m32
10847 @itemx -m64
10848 @opindex m32
10849 @opindex m64
10850 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10851 targets (including GNU/Linux).  The 32-bit environment sets int, long
10852 and pointer to 32 bits and generates code that runs on any PowerPC
10853 variant.  The 64-bit environment sets int to 32 bits and long and
10854 pointer to 64 bits, and generates code for PowerPC64, as for
10855 @option{-mpowerpc64}.
10857 @item -mfull-toc
10858 @itemx -mno-fp-in-toc
10859 @itemx -mno-sum-in-toc
10860 @itemx -mminimal-toc
10861 @opindex mfull-toc
10862 @opindex mno-fp-in-toc
10863 @opindex mno-sum-in-toc
10864 @opindex mminimal-toc
10865 Modify generation of the TOC (Table Of Contents), which is created for
10866 every executable file.  The @option{-mfull-toc} option is selected by
10867 default.  In that case, GCC will allocate at least one TOC entry for
10868 each unique non-automatic variable reference in your program.  GCC
10869 will also place floating-point constants in the TOC@.  However, only
10870 16,384 entries are available in the TOC@.
10872 If you receive a linker error message that saying you have overflowed
10873 the available TOC space, you can reduce the amount of TOC space used
10874 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10875 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10876 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10877 generate code to calculate the sum of an address and a constant at
10878 run-time instead of putting that sum into the TOC@.  You may specify one
10879 or both of these options.  Each causes GCC to produce very slightly
10880 slower and larger code at the expense of conserving TOC space.
10882 If you still run out of space in the TOC even when you specify both of
10883 these options, specify @option{-mminimal-toc} instead.  This option causes
10884 GCC to make only one TOC entry for every file.  When you specify this
10885 option, GCC will produce code that is slower and larger but which
10886 uses extremely little TOC space.  You may wish to use this option
10887 only on files that contain less frequently executed code.
10889 @item -maix64
10890 @itemx -maix32
10891 @opindex maix64
10892 @opindex maix32
10893 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10894 @code{long} type, and the infrastructure needed to support them.
10895 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10896 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10897 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10899 @item -mxl-compat
10900 @itemx -mno-xl-compat
10901 @opindex mxl-compat
10902 @opindex mno-xl-compat
10903 Produce code that conforms more closely to IBM XLC semantics when using
10904 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10905 functions beyond the register save area (RSA) on the stack in addition
10906 to argument FPRs.  Do not assume that most significant double in 128
10907 bit long double value is properly rounded when comparing values.
10909 The AIX calling convention was extended but not initially documented to
10910 handle an obscure K&R C case of calling a function that takes the
10911 address of its arguments with fewer arguments than declared.  AIX XL
10912 compilers access floating point arguments which do not fit in the
10913 RSA from the stack when a subroutine is compiled without
10914 optimization.  Because always storing floating-point arguments on the
10915 stack is inefficient and rarely needed, this option is not enabled by
10916 default and only is necessary when calling subroutines compiled by AIX
10917 XL compilers without optimization.
10919 @item -mpe
10920 @opindex mpe
10921 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10922 application written to use message passing with special startup code to
10923 enable the application to run.  The system must have PE installed in the
10924 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10925 must be overridden with the @option{-specs=} option to specify the
10926 appropriate directory location.  The Parallel Environment does not
10927 support threads, so the @option{-mpe} option and the @option{-pthread}
10928 option are incompatible.
10930 @item -malign-natural
10931 @itemx -malign-power
10932 @opindex malign-natural
10933 @opindex malign-power
10934 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10935 @option{-malign-natural} overrides the ABI-defined alignment of larger
10936 types, such as floating-point doubles, on their natural size-based boundary.
10937 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10938 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10940 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10941 is not supported.
10943 @item -msoft-float
10944 @itemx -mhard-float
10945 @opindex msoft-float
10946 @opindex mhard-float
10947 Generate code that does not use (uses) the floating-point register set.
10948 Software floating point emulation is provided if you use the
10949 @option{-msoft-float} option, and pass the option to GCC when linking.
10951 @item -mmultiple
10952 @itemx -mno-multiple
10953 @opindex mmultiple
10954 @opindex mno-multiple
10955 Generate code that uses (does not use) the load multiple word
10956 instructions and the store multiple word instructions.  These
10957 instructions are generated by default on POWER systems, and not
10958 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10959 endian PowerPC systems, since those instructions do not work when the
10960 processor is in little endian mode.  The exceptions are PPC740 and
10961 PPC750 which permit the instructions usage in little endian mode.
10963 @item -mstring
10964 @itemx -mno-string
10965 @opindex mstring
10966 @opindex mno-string
10967 Generate code that uses (does not use) the load string instructions
10968 and the store string word instructions to save multiple registers and
10969 do small block moves.  These instructions are generated by default on
10970 POWER systems, and not generated on PowerPC systems.  Do not use
10971 @option{-mstring} on little endian PowerPC systems, since those
10972 instructions do not work when the processor is in little endian mode.
10973 The exceptions are PPC740 and PPC750 which permit the instructions
10974 usage in little endian mode.
10976 @item -mupdate
10977 @itemx -mno-update
10978 @opindex mupdate
10979 @opindex mno-update
10980 Generate code that uses (does not use) the load or store instructions
10981 that update the base register to the address of the calculated memory
10982 location.  These instructions are generated by default.  If you use
10983 @option{-mno-update}, there is a small window between the time that the
10984 stack pointer is updated and the address of the previous frame is
10985 stored, which means code that walks the stack frame across interrupts or
10986 signals may get corrupted data.
10988 @item -mfused-madd
10989 @itemx -mno-fused-madd
10990 @opindex mfused-madd
10991 @opindex mno-fused-madd
10992 Generate code that uses (does not use) the floating point multiply and
10993 accumulate instructions.  These instructions are generated by default if
10994 hardware floating is used.
10996 @item -mno-bit-align
10997 @itemx -mbit-align
10998 @opindex mno-bit-align
10999 @opindex mbit-align
11000 On System V.4 and embedded PowerPC systems do not (do) force structures
11001 and unions that contain bit-fields to be aligned to the base type of the
11002 bit-field.
11004 For example, by default a structure containing nothing but 8
11005 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11006 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
11007 the structure would be aligned to a 1 byte boundary and be one byte in
11008 size.
11010 @item -mno-strict-align
11011 @itemx -mstrict-align
11012 @opindex mno-strict-align
11013 @opindex mstrict-align
11014 On System V.4 and embedded PowerPC systems do not (do) assume that
11015 unaligned memory references will be handled by the system.
11017 @item -mrelocatable
11018 @itemx -mno-relocatable
11019 @opindex mrelocatable
11020 @opindex mno-relocatable
11021 On embedded PowerPC systems generate code that allows (does not allow)
11022 the program to be relocated to a different address at runtime.  If you
11023 use @option{-mrelocatable} on any module, all objects linked together must
11024 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11026 @item -mrelocatable-lib
11027 @itemx -mno-relocatable-lib
11028 @opindex mrelocatable-lib
11029 @opindex mno-relocatable-lib
11030 On embedded PowerPC systems generate code that allows (does not allow)
11031 the program to be relocated to a different address at runtime.  Modules
11032 compiled with @option{-mrelocatable-lib} can be linked with either modules
11033 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11034 with modules compiled with the @option{-mrelocatable} options.
11036 @item -mno-toc
11037 @itemx -mtoc
11038 @opindex mno-toc
11039 @opindex mtoc
11040 On System V.4 and embedded PowerPC systems do not (do) assume that
11041 register 2 contains a pointer to a global area pointing to the addresses
11042 used in the program.
11044 @item -mlittle
11045 @itemx -mlittle-endian
11046 @opindex mlittle
11047 @opindex mlittle-endian
11048 On System V.4 and embedded PowerPC systems compile code for the
11049 processor in little endian mode.  The @option{-mlittle-endian} option is
11050 the same as @option{-mlittle}.
11052 @item -mbig
11053 @itemx -mbig-endian
11054 @opindex mbig
11055 @opindex mbig-endian
11056 On System V.4 and embedded PowerPC systems compile code for the
11057 processor in big endian mode.  The @option{-mbig-endian} option is
11058 the same as @option{-mbig}.
11060 @item -mdynamic-no-pic
11061 @opindex mdynamic-no-pic
11062 On Darwin and Mac OS X systems, compile code so that it is not
11063 relocatable, but that its external references are relocatable.  The
11064 resulting code is suitable for applications, but not shared
11065 libraries.
11067 @item -mprioritize-restricted-insns=@var{priority}
11068 @opindex mprioritize-restricted-insns
11069 This option controls the priority that is assigned to
11070 dispatch-slot restricted instructions during the second scheduling
11071 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
11072 @var{no/highest/second-highest} priority to dispatch slot restricted
11073 instructions.
11075 @item -msched-costly-dep=@var{dependence_type}
11076 @opindex msched-costly-dep
11077 This option controls which dependences are considered costly
11078 by the target during instruction scheduling.  The argument
11079 @var{dependence_type} takes one of the following values:
11080 @var{no}: no dependence is costly,
11081 @var{all}: all dependences are costly,
11082 @var{true_store_to_load}: a true dependence from store to load is costly,
11083 @var{store_to_load}: any dependence from store to load is costly,
11084 @var{number}: any dependence which latency >= @var{number} is costly.
11086 @item -minsert-sched-nops=@var{scheme}
11087 @opindex minsert-sched-nops
11088 This option controls which nop insertion scheme will be used during
11089 the second scheduling pass.  The argument @var{scheme} takes one of the
11090 following values:
11091 @var{no}: Don't insert nops.
11092 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11093 according to the scheduler's grouping.
11094 @var{regroup_exact}: Insert nops to force costly dependent insns into
11095 separate groups.  Insert exactly as many nops as needed to force an insn
11096 to a new group, according to the estimated processor grouping.
11097 @var{number}: Insert nops to force costly dependent insns into
11098 separate groups.  Insert @var{number} nops to force an insn to a new group.
11100 @item -mcall-sysv
11101 @opindex mcall-sysv
11102 On System V.4 and embedded PowerPC systems compile code using calling
11103 conventions that adheres to the March 1995 draft of the System V
11104 Application Binary Interface, PowerPC processor supplement.  This is the
11105 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11107 @item -mcall-sysv-eabi
11108 @opindex mcall-sysv-eabi
11109 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11111 @item -mcall-sysv-noeabi
11112 @opindex mcall-sysv-noeabi
11113 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11115 @item -mcall-solaris
11116 @opindex mcall-solaris
11117 On System V.4 and embedded PowerPC systems compile code for the Solaris
11118 operating system.
11120 @item -mcall-linux
11121 @opindex mcall-linux
11122 On System V.4 and embedded PowerPC systems compile code for the
11123 Linux-based GNU system.
11125 @item -mcall-gnu
11126 @opindex mcall-gnu
11127 On System V.4 and embedded PowerPC systems compile code for the
11128 Hurd-based GNU system.
11130 @item -mcall-netbsd
11131 @opindex mcall-netbsd
11132 On System V.4 and embedded PowerPC systems compile code for the
11133 NetBSD operating system.
11135 @item -maix-struct-return
11136 @opindex maix-struct-return
11137 Return all structures in memory (as specified by the AIX ABI)@.
11139 @item -msvr4-struct-return
11140 @opindex msvr4-struct-return
11141 Return structures smaller than 8 bytes in registers (as specified by the
11142 SVR4 ABI)@.
11144 @item -mabi=@var{abi-type}
11145 @opindex mabi
11146 Extend the current ABI with a particular extension, or remove such extension.
11147 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11148 @var{no-spe}@.
11150 @item -mprototype
11151 @itemx -mno-prototype
11152 @opindex mprototype
11153 @opindex mno-prototype
11154 On System V.4 and embedded PowerPC systems assume that all calls to
11155 variable argument functions are properly prototyped.  Otherwise, the
11156 compiler must insert an instruction before every non prototyped call to
11157 set or clear bit 6 of the condition code register (@var{CR}) to
11158 indicate whether floating point values were passed in the floating point
11159 registers in case the function takes a variable arguments.  With
11160 @option{-mprototype}, only calls to prototyped variable argument functions
11161 will set or clear the bit.
11163 @item -msim
11164 @opindex msim
11165 On embedded PowerPC systems, assume that the startup module is called
11166 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11167 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
11168 configurations.
11170 @item -mmvme
11171 @opindex mmvme
11172 On embedded PowerPC systems, assume that the startup module is called
11173 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11174 @file{libc.a}.
11176 @item -mads
11177 @opindex mads
11178 On embedded PowerPC systems, assume that the startup module is called
11179 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11180 @file{libc.a}.
11182 @item -myellowknife
11183 @opindex myellowknife
11184 On embedded PowerPC systems, assume that the startup module is called
11185 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11186 @file{libc.a}.
11188 @item -mvxworks
11189 @opindex mvxworks
11190 On System V.4 and embedded PowerPC systems, specify that you are
11191 compiling for a VxWorks system.
11193 @item -mwindiss
11194 @opindex mwindiss
11195 Specify that you are compiling for the WindISS simulation environment.
11197 @item -memb
11198 @opindex memb
11199 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11200 header to indicate that @samp{eabi} extended relocations are used.
11202 @item -meabi
11203 @itemx -mno-eabi
11204 @opindex meabi
11205 @opindex mno-eabi
11206 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11207 Embedded Applications Binary Interface (eabi) which is a set of
11208 modifications to the System V.4 specifications.  Selecting @option{-meabi}
11209 means that the stack is aligned to an 8 byte boundary, a function
11210 @code{__eabi} is called to from @code{main} to set up the eabi
11211 environment, and the @option{-msdata} option can use both @code{r2} and
11212 @code{r13} to point to two separate small data areas.  Selecting
11213 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11214 do not call an initialization function from @code{main}, and the
11215 @option{-msdata} option will only use @code{r13} to point to a single
11216 small data area.  The @option{-meabi} option is on by default if you
11217 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11219 @item -msdata=eabi
11220 @opindex msdata=eabi
11221 On System V.4 and embedded PowerPC systems, put small initialized
11222 @code{const} global and static data in the @samp{.sdata2} section, which
11223 is pointed to by register @code{r2}.  Put small initialized
11224 non-@code{const} global and static data in the @samp{.sdata} section,
11225 which is pointed to by register @code{r13}.  Put small uninitialized
11226 global and static data in the @samp{.sbss} section, which is adjacent to
11227 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
11228 incompatible with the @option{-mrelocatable} option.  The
11229 @option{-msdata=eabi} option also sets the @option{-memb} option.
11231 @item -msdata=sysv
11232 @opindex msdata=sysv
11233 On System V.4 and embedded PowerPC systems, put small global and static
11234 data in the @samp{.sdata} section, which is pointed to by register
11235 @code{r13}.  Put small uninitialized global and static data in the
11236 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11237 The @option{-msdata=sysv} option is incompatible with the
11238 @option{-mrelocatable} option.
11240 @item -msdata=default
11241 @itemx -msdata
11242 @opindex msdata=default
11243 @opindex msdata
11244 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11245 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11246 same as @option{-msdata=sysv}.
11248 @item -msdata-data
11249 @opindex msdata-data
11250 On System V.4 and embedded PowerPC systems, put small global and static
11251 data in the @samp{.sdata} section.  Put small uninitialized global and
11252 static data in the @samp{.sbss} section.  Do not use register @code{r13}
11253 to address small data however.  This is the default behavior unless
11254 other @option{-msdata} options are used.
11256 @item -msdata=none
11257 @itemx -mno-sdata
11258 @opindex msdata=none
11259 @opindex mno-sdata
11260 On embedded PowerPC systems, put all initialized global and static data
11261 in the @samp{.data} section, and all uninitialized data in the
11262 @samp{.bss} section.
11264 @item -G @var{num}
11265 @opindex G
11266 @cindex smaller data references (PowerPC)
11267 @cindex .sdata/.sdata2 references (PowerPC)
11268 On embedded PowerPC systems, put global and static items less than or
11269 equal to @var{num} bytes into the small data or bss sections instead of
11270 the normal data or bss section.  By default, @var{num} is 8.  The
11271 @option{-G @var{num}} switch is also passed to the linker.
11272 All modules should be compiled with the same @option{-G @var{num}} value.
11274 @item -mregnames
11275 @itemx -mno-regnames
11276 @opindex mregnames
11277 @opindex mno-regnames
11278 On System V.4 and embedded PowerPC systems do (do not) emit register
11279 names in the assembly language output using symbolic forms.
11281 @item -mlongcall
11282 @itemx -mno-longcall
11283 @opindex mlongcall
11284 @opindex mno-longcall
11285 Default to making all function calls indirectly, using a register, so
11286 that functions which reside further than 32 megabytes (33,554,432
11287 bytes) from the current location can be called.  This setting can be
11288 overridden by the @code{shortcall} function attribute, or by
11289 @code{#pragma longcall(0)}.
11291 Some linkers are capable of detecting out-of-range calls and generating
11292 glue code on the fly.  On these systems, long calls are unnecessary and
11293 generate slower code.  As of this writing, the AIX linker can do this,
11294 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11295 to the GNU linker for 32-bit PowerPC systems as well.
11297 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11298 callee, L42'', plus a ``branch island'' (glue code).  The two target
11299 addresses represent the callee and the ``branch island''.  The
11300 Darwin/PPC linker will prefer the first address and generate a ``bl
11301 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11302 otherwise, the linker will generate ``bl L42'' to call the ``branch
11303 island''.  The ``branch island'' is appended to the body of the
11304 calling function; it computes the full 32-bit address of the callee
11305 and jumps to it.
11307 On Mach-O (Darwin) systems, this option directs the compiler emit to
11308 the glue for every direct call, and the Darwin linker decides whether
11309 to use or discard it.
11311 In the future, we may cause GCC to ignore all longcall specifications
11312 when the linker is known to generate glue.
11314 @item -pthread
11315 @opindex pthread
11316 Adds support for multithreading with the @dfn{pthreads} library.
11317 This option sets flags for both the preprocessor and linker.
11319 @end table
11321 @node S/390 and zSeries Options
11322 @subsection S/390 and zSeries Options
11323 @cindex S/390 and zSeries Options
11325 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11327 @table @gcctabopt
11328 @item -mhard-float
11329 @itemx -msoft-float
11330 @opindex mhard-float
11331 @opindex msoft-float
11332 Use (do not use) the hardware floating-point instructions and registers
11333 for floating-point operations.  When @option{-msoft-float} is specified,
11334 functions in @file{libgcc.a} will be used to perform floating-point
11335 operations.  When @option{-mhard-float} is specified, the compiler
11336 generates IEEE floating-point instructions.  This is the default.
11338 @item -mbackchain
11339 @itemx -mno-backchain
11340 @opindex mbackchain
11341 @opindex mno-backchain
11342 Store (do not store) the address of the caller's frame as backchain pointer
11343 into the callee's stack frame.
11344 A backchain may be needed to allow debugging using tools that do not understand
11345 DWARF-2 call frame information.
11346 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11347 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11348 the backchain is placed into the topmost word of the 96/160 byte register
11349 save area.
11351 In general, code compiled with @option{-mbackchain} is call-compatible with
11352 code compiled with @option{-mmo-backchain}; however, use of the backchain
11353 for debugging purposes usually requires that the whole binary is built with
11354 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11355 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11356 to build a linux kernel use @option{-msoft-float}.
11358 The default is to not maintain the backchain.
11360 @item -mpacked-stack
11361 @item -mno-packed-stack
11362 @opindex mpacked-stack
11363 @opindex mno-packed-stack
11364 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11365 specified, the compiler uses the all fields of the 96/160 byte register save
11366 area only for their default purpose; unused fields still take up stack space.
11367 When @option{-mpacked-stack} is specified, register save slots are densely
11368 packed at the top of the register save area; unused space is reused for other
11369 purposes, allowing for more efficient use of the available stack space.
11370 However, when @option{-mbackchain} is also in effect, the topmost word of
11371 the save area is always used to store the backchain, and the return address
11372 register is always saved two words below the backchain.
11374 As long as the stack frame backchain is not used, code generated with
11375 @option{-mpacked-stack} is call-compatible with code generated with
11376 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11377 S/390 or zSeries generated code that uses the stack frame backchain at run
11378 time, not just for debugging purposes.  Such code is not call-compatible
11379 with code compiled with @option{-mpacked-stack}.  Also, note that the
11380 combination of @option{-mbackchain},
11381 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11382 to build a linux kernel use @option{-msoft-float}.
11384 The default is to not use the packed stack layout.
11386 @item -msmall-exec
11387 @itemx -mno-small-exec
11388 @opindex msmall-exec
11389 @opindex mno-small-exec
11390 Generate (or do not generate) code using the @code{bras} instruction
11391 to do subroutine calls.
11392 This only works reliably if the total executable size does not
11393 exceed 64k.  The default is to use the @code{basr} instruction instead,
11394 which does not have this limitation.
11396 @item -m64
11397 @itemx -m31
11398 @opindex m64
11399 @opindex m31
11400 When @option{-m31} is specified, generate code compliant to the
11401 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11402 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11403 particular to generate 64-bit instructions.  For the @samp{s390}
11404 targets, the default is @option{-m31}, while the @samp{s390x}
11405 targets default to @option{-m64}.
11407 @item -mzarch
11408 @itemx -mesa
11409 @opindex mzarch
11410 @opindex mesa
11411 When @option{-mzarch} is specified, generate code using the
11412 instructions available on z/Architecture.
11413 When @option{-mesa} is specified, generate code using the
11414 instructions available on ESA/390.  Note that @option{-mesa} is
11415 not possible with @option{-m64}.
11416 When generating code compliant to the GNU/Linux for S/390 ABI,
11417 the default is @option{-mesa}.  When generating code compliant
11418 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11420 @item -mmvcle
11421 @itemx -mno-mvcle
11422 @opindex mmvcle
11423 @opindex mno-mvcle
11424 Generate (or do not generate) code using the @code{mvcle} instruction
11425 to perform block moves.  When @option{-mno-mvcle} is specified,
11426 use a @code{mvc} loop instead.  This is the default unless optimizing for
11427 size.
11429 @item -mdebug
11430 @itemx -mno-debug
11431 @opindex mdebug
11432 @opindex mno-debug
11433 Print (or do not print) additional debug information when compiling.
11434 The default is to not print debug information.
11436 @item -march=@var{cpu-type}
11437 @opindex march
11438 Generate code that will run on @var{cpu-type}, which is the name of a system
11439 representing a certain processor type.  Possible values for
11440 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11441 When generating code using the instructions available on z/Architecture,
11442 the default is @option{-march=z900}.  Otherwise, the default is
11443 @option{-march=g5}.
11445 @item -mtune=@var{cpu-type}
11446 @opindex mtune
11447 Tune to @var{cpu-type} everything applicable about the generated code,
11448 except for the ABI and the set of available instructions.
11449 The list of @var{cpu-type} values is the same as for @option{-march}.
11450 The default is the value used for @option{-march}.
11452 @item -mtpf-trace
11453 @itemx -mno-tpf-trace
11454 @opindex mtpf-trace
11455 @opindex mno-tpf-trace
11456 Generate code that adds (does not add) in TPF OS specific branches to trace
11457 routines in the operating system.  This option is off by default, even
11458 when compiling for the TPF OS@.
11460 @item -mfused-madd
11461 @itemx -mno-fused-madd
11462 @opindex mfused-madd
11463 @opindex mno-fused-madd
11464 Generate code that uses (does not use) the floating point multiply and
11465 accumulate instructions.  These instructions are generated by default if
11466 hardware floating point is used.
11468 @item -mwarn-framesize=@var{framesize}
11469 @opindex mwarn-framesize
11470 Emit a warning if the current function exceeds the given frame size.  Because
11471 this is a compile time check it doesn't need to be a real problem when the program
11472 runs.  It is intended to identify functions which most probably cause
11473 a stack overflow.  It is useful to be used in an environment with limited stack
11474 size e.g.@: the linux kernel.
11476 @item -mwarn-dynamicstack
11477 @opindex mwarn-dynamicstack
11478 Emit a warning if the function calls alloca or uses dynamically
11479 sized arrays.  This is generally a bad idea with a limited stack size.
11481 @item -mstack-guard=@var{stack-guard}
11482 @item -mstack-size=@var{stack-size}
11483 @opindex mstack-guard
11484 @opindex mstack-size
11485 These arguments always have to be used in conjunction.  If they are present the s390
11486 back end emits additional instructions in the function prologue which trigger a trap
11487 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11488 (remember that the stack on s390 grows downward).  These options are intended to
11489 be used to help debugging stack overflow problems.  The additionally emitted code
11490 cause only little overhead and hence can also be used in production like systems
11491 without greater performance degradation.  The given values have to be exact
11492 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11493 In order to be efficient the extra code makes the assumption that the stack starts
11494 at an address aligned to the value given by @var{stack-size}.
11495 @end table
11497 @node SH Options
11498 @subsection SH Options
11500 These @samp{-m} options are defined for the SH implementations:
11502 @table @gcctabopt
11503 @item -m1
11504 @opindex m1
11505 Generate code for the SH1.
11507 @item -m2
11508 @opindex m2
11509 Generate code for the SH2.
11511 @item -m2e
11512 Generate code for the SH2e.
11514 @item -m3
11515 @opindex m3
11516 Generate code for the SH3.
11518 @item -m3e
11519 @opindex m3e
11520 Generate code for the SH3e.
11522 @item -m4-nofpu
11523 @opindex m4-nofpu
11524 Generate code for the SH4 without a floating-point unit.
11526 @item -m4-single-only
11527 @opindex m4-single-only
11528 Generate code for the SH4 with a floating-point unit that only
11529 supports single-precision arithmetic.
11531 @item -m4-single
11532 @opindex m4-single
11533 Generate code for the SH4 assuming the floating-point unit is in
11534 single-precision mode by default.
11536 @item -m4
11537 @opindex m4
11538 Generate code for the SH4.
11540 @item -m4a-nofpu
11541 @opindex m4a-nofpu
11542 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11543 floating-point unit is not used.
11545 @item -m4a-single-only
11546 @opindex m4a-single-only
11547 Generate code for the SH4a, in such a way that no double-precision
11548 floating point operations are used.
11550 @item -m4a-single
11551 @opindex m4a-single
11552 Generate code for the SH4a assuming the floating-point unit is in
11553 single-precision mode by default.
11555 @item -m4a
11556 @opindex m4a
11557 Generate code for the SH4a.
11559 @item -m4al
11560 @opindex m4al
11561 Same as @option{-m4a-nofpu}, except that it implicitly passes
11562 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11563 instructions at the moment.
11565 @item -mb
11566 @opindex mb
11567 Compile code for the processor in big endian mode.
11569 @item -ml
11570 @opindex ml
11571 Compile code for the processor in little endian mode.
11573 @item -mdalign
11574 @opindex mdalign
11575 Align doubles at 64-bit boundaries.  Note that this changes the calling
11576 conventions, and thus some functions from the standard C library will
11577 not work unless you recompile it first with @option{-mdalign}.
11579 @item -mrelax
11580 @opindex mrelax
11581 Shorten some address references at link time, when possible; uses the
11582 linker option @option{-relax}.
11584 @item -mbigtable
11585 @opindex mbigtable
11586 Use 32-bit offsets in @code{switch} tables.  The default is to use
11587 16-bit offsets.
11589 @item -mfmovd
11590 @opindex mfmovd
11591 Enable the use of the instruction @code{fmovd}.
11593 @item -mhitachi
11594 @opindex mhitachi
11595 Comply with the calling conventions defined by Renesas.
11597 @item -mrenesas
11598 @opindex mhitachi
11599 Comply with the calling conventions defined by Renesas.
11601 @item -mno-renesas
11602 @opindex mhitachi
11603 Comply with the calling conventions defined for GCC before the Renesas
11604 conventions were available.  This option is the default for all
11605 targets of the SH toolchain except for @samp{sh-symbianelf}.
11607 @item -mnomacsave
11608 @opindex mnomacsave
11609 Mark the @code{MAC} register as call-clobbered, even if
11610 @option{-mhitachi} is given.
11612 @item -mieee
11613 @opindex mieee
11614 Increase IEEE-compliance of floating-point code.
11615 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11616 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11617 comparisons of NANs / infinities incurs extra overhead in every
11618 floating point comparison, therefore the default is set to
11619 @option{-ffinite-math-only}.
11621 @item -misize
11622 @opindex misize
11623 Dump instruction size and location in the assembly code.
11625 @item -mpadstruct
11626 @opindex mpadstruct
11627 This option is deprecated.  It pads structures to multiple of 4 bytes,
11628 which is incompatible with the SH ABI@.
11630 @item -mspace
11631 @opindex mspace
11632 Optimize for space instead of speed.  Implied by @option{-Os}.
11634 @item -mprefergot
11635 @opindex mprefergot
11636 When generating position-independent code, emit function calls using
11637 the Global Offset Table instead of the Procedure Linkage Table.
11639 @item -musermode
11640 @opindex musermode
11641 Generate a library function call to invalidate instruction cache
11642 entries, after fixing up a trampoline.  This library function call
11643 doesn't assume it can write to the whole memory address space.  This
11644 is the default when the target is @code{sh-*-linux*}.
11646 @item -multcost=@var{number}
11647 @opindex multcost=@var{number}
11648 Set the cost to assume for a multiply insn.
11650 @item -mdiv=@var{strategy}
11651 @opindex mdiv=@var{strategy}
11652 Set the division strategy to use for SHmedia code.  @var{strategy} must be
11653 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11654 inv:call2, inv:fp .
11655 "fp" performs the operation in floating point.  This has a very high latency,
11656 but needs only a few instructions, so it might be a good choice if
11657 your code has enough easily exploitable ILP to allow the compiler to
11658 schedule the floating point instructions together with other instructions.
11659 Division by zero causes a floating point exception.
11660 "inv" uses integer operations to calculate the inverse of the divisor,
11661 and then multiplies the dividend with the inverse.  This strategy allows
11662 cse and hoisting of the inverse calculation.  Division by zero calculates
11663 an unspecified result, but does not trap.
11664 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11665 have been found, or if the entire operation has been hoisted to the same
11666 place, the last stages of the inverse calculation are intertwined with the
11667 final multiply to reduce the overall latency, at the expense of using a few
11668 more instructions, and thus offering fewer scheduling opportunities with
11669 other code.
11670 "call" calls a library function that usually implements the inv:minlat
11671 strategy.
11672 This gives high code density for m5-*media-nofpu compilations.
11673 "call2" uses a different entry point of the same library function, where it
11674 assumes that a pointer to a lookup table has already been set up, which
11675 exposes the pointer load to cse / code hoisting optimizations.
11676 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11677 code generation, but if the code stays unoptimized, revert to the "call",
11678 "call2", or "fp" strategies, respectively.  Note that the
11679 potentially-trapping side effect of division by zero is carried by a
11680 separate instruction, so it is possible that all the integer instructions
11681 are hoisted out, but the marker for the side effect stays where it is.
11682 A recombination to fp operations or a call is not possible in that case.
11683 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy.  In the case
11684 that the inverse calculation was nor separated from the multiply, they speed
11685 up division where the dividend fits into 20 bits (plus sign where applicable),
11686 by inserting a test to skip a number of operations in this case; this test
11687 slows down the case of larger dividends.  inv20u assumes the case of a such
11688 a small dividend to be unlikely, and inv20l assumes it to be likely.
11690 @item -mdivsi3_libfunc=@var{name}
11691 @opindex mdivsi3_libfunc=@var{name}
11692 Set the name of the library function used for 32 bit signed division to
11693 @var{name}.  This only affect the name used in the call and inv:call
11694 division strategies, and the compiler will still expect the same
11695 sets of input/output/clobbered registers as if this option was not present.
11697 @item -madjust-unroll
11698 @opindex madjust-unroll
11699 Throttle unrolling to avoid thrashing target registers.
11700 This option only has an effect if the gcc code base supports the
11701 TARGET_ADJUST_UNROLL_MAX target hook.
11703 @item -mindexed-addressing
11704 @opindex mindexed-addressing
11705 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11706 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11707 semantics for the indexed addressing mode.  The architecture allows the
11708 implementation of processors with 64 bit MMU, which the OS could use to
11709 get 32 bit addressing, but since no current hardware implementation supports
11710 this or any other way to make the indexed addressing mode safe to use in
11711 the 32 bit ABI, the default is -mno-indexed-addressing.
11713 @item -mgettrcost=@var{number}
11714 @opindex mgettrcost=@var{number}
11715 Set the cost assumed for the gettr instruction to @var{number}.
11716 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11718 @item -mpt-fixed
11719 @opindex mpt-fixed
11720 Assume pt* instructions won't trap.  This will generally generate better
11721 scheduled code, but is unsafe on current hardware.  The current architecture
11722 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11723 This has the unintentional effect of making it unsafe to schedule ptabs /
11724 ptrel before a branch, or hoist it out of a loop.  For example,
11725 __do_global_ctors, a part of libgcc that runs constructors at program
11726 startup, calls functions in a list which is delimited by -1.  With the
11727 -mpt-fixed option, the ptabs will be done before testing against -1.
11728 That means that all the constructors will be run a bit quicker, but when
11729 the loop comes to the end of the list, the program crashes because ptabs
11730 loads -1 into a target register.  Since this option is unsafe for any
11731 hardware implementing the current architecture specification, the default
11732 is -mno-pt-fixed.  Unless the user specifies a specific cost with
11733 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11734 this deters register allocation using target registers for storing
11735 ordinary integers.
11737 @item -minvalid-symbols
11738 @opindex minvalid-symbols
11739 Assume symbols might be invalid.  Ordinary function symbols generated by
11740 the compiler will always be valid to load with movi/shori/ptabs or
11741 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11742 to generate symbols that will cause ptabs / ptrel to trap.
11743 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11744 It will then prevent cross-basic-block cse, hoisting and most scheduling
11745 of symbol loads.  The default is @option{-mno-invalid-symbols}.
11746 @end table
11748 @node SPARC Options
11749 @subsection SPARC Options
11750 @cindex SPARC options
11752 These @samp{-m} options are supported on the SPARC:
11754 @table @gcctabopt
11755 @item -mno-app-regs
11756 @itemx -mapp-regs
11757 @opindex mno-app-regs
11758 @opindex mapp-regs
11759 Specify @option{-mapp-regs} to generate output using the global registers
11760 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11761 is the default.
11763 To be fully SVR4 ABI compliant at the cost of some performance loss,
11764 specify @option{-mno-app-regs}.  You should compile libraries and system
11765 software with this option.
11767 @item -mfpu
11768 @itemx -mhard-float
11769 @opindex mfpu
11770 @opindex mhard-float
11771 Generate output containing floating point instructions.  This is the
11772 default.
11774 @item -mno-fpu
11775 @itemx -msoft-float
11776 @opindex mno-fpu
11777 @opindex msoft-float
11778 Generate output containing library calls for floating point.
11779 @strong{Warning:} the requisite libraries are not available for all SPARC
11780 targets.  Normally the facilities of the machine's usual C compiler are
11781 used, but this cannot be done directly in cross-compilation.  You must make
11782 your own arrangements to provide suitable library functions for
11783 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11784 @samp{sparclite-*-*} do provide software floating point support.
11786 @option{-msoft-float} changes the calling convention in the output file;
11787 therefore, it is only useful if you compile @emph{all} of a program with
11788 this option.  In particular, you need to compile @file{libgcc.a}, the
11789 library that comes with GCC, with @option{-msoft-float} in order for
11790 this to work.
11792 @item -mhard-quad-float
11793 @opindex mhard-quad-float
11794 Generate output containing quad-word (long double) floating point
11795 instructions.
11797 @item -msoft-quad-float
11798 @opindex msoft-quad-float
11799 Generate output containing library calls for quad-word (long double)
11800 floating point instructions.  The functions called are those specified
11801 in the SPARC ABI@.  This is the default.
11803 As of this writing, there are no SPARC implementations that have hardware
11804 support for the quad-word floating point instructions.  They all invoke
11805 a trap handler for one of these instructions, and then the trap handler
11806 emulates the effect of the instruction.  Because of the trap handler overhead,
11807 this is much slower than calling the ABI library routines.  Thus the
11808 @option{-msoft-quad-float} option is the default.
11810 @item -mno-unaligned-doubles
11811 @itemx -munaligned-doubles
11812 @opindex mno-unaligned-doubles
11813 @opindex munaligned-doubles
11814 Assume that doubles have 8 byte alignment.  This is the default.
11816 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11817 alignment only if they are contained in another type, or if they have an
11818 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11819 Specifying this option avoids some rare compatibility problems with code
11820 generated by other compilers.  It is not the default because it results
11821 in a performance loss, especially for floating point code.
11823 @item -mno-faster-structs
11824 @itemx -mfaster-structs
11825 @opindex mno-faster-structs
11826 @opindex mfaster-structs
11827 With @option{-mfaster-structs}, the compiler assumes that structures
11828 should have 8 byte alignment.  This enables the use of pairs of
11829 @code{ldd} and @code{std} instructions for copies in structure
11830 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11831 However, the use of this changed alignment directly violates the SPARC
11832 ABI@.  Thus, it's intended only for use on targets where the developer
11833 acknowledges that their resulting code will not be directly in line with
11834 the rules of the ABI@.
11836 @item -mimpure-text
11837 @opindex mimpure-text
11838 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11839 the compiler to not pass @option{-z text} to the linker when linking a
11840 shared object.  Using this option, you can link position-dependent
11841 code into a shared object.
11843 @option{-mimpure-text} suppresses the ``relocations remain against
11844 allocatable but non-writable sections'' linker error message.
11845 However, the necessary relocations will trigger copy-on-write, and the
11846 shared object is not actually shared across processes.  Instead of
11847 using @option{-mimpure-text}, you should compile all source code with
11848 @option{-fpic} or @option{-fPIC}.
11850 This option is only available on SunOS and Solaris.
11852 @item -mcpu=@var{cpu_type}
11853 @opindex mcpu
11854 Set the instruction set, register set, and instruction scheduling parameters
11855 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11856 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11857 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11858 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11859 @samp{ultrasparc3}.
11861 Default instruction scheduling parameters are used for values that select
11862 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11863 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11865 Here is a list of each supported architecture and their supported
11866 implementations.
11868 @smallexample
11869     v7:             cypress
11870     v8:             supersparc, hypersparc
11871     sparclite:      f930, f934, sparclite86x
11872     sparclet:       tsc701
11873     v9:             ultrasparc, ultrasparc3
11874 @end smallexample
11876 By default (unless configured otherwise), GCC generates code for the V7
11877 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11878 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11879 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11880 SPARCStation 1, 2, IPX etc.
11882 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11883 architecture.  The only difference from V7 code is that the compiler emits
11884 the integer multiply and integer divide instructions which exist in SPARC-V8
11885 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11886 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11887 2000 series.
11889 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11890 the SPARC architecture.  This adds the integer multiply, integer divide step
11891 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11892 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11893 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11894 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11895 MB86934 chip, which is the more recent SPARClite with FPU@.
11897 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11898 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11899 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11900 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11901 optimizes it for the TEMIC SPARClet chip.
11903 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11904 architecture.  This adds 64-bit integer and floating-point move instructions,
11905 3 additional floating-point condition code registers and conditional move
11906 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11907 optimizes it for the Sun UltraSPARC I/II chips.  With
11908 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11909 Sun UltraSPARC III chip.
11911 @item -mtune=@var{cpu_type}
11912 @opindex mtune
11913 Set the instruction scheduling parameters for machine type
11914 @var{cpu_type}, but do not set the instruction set or register set that the
11915 option @option{-mcpu=@var{cpu_type}} would.
11917 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11918 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11919 that select a particular cpu implementation.  Those are @samp{cypress},
11920 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11921 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11922 @samp{ultrasparc3}.
11924 @item -mv8plus
11925 @itemx -mno-v8plus
11926 @opindex mv8plus
11927 @opindex mno-v8plus
11928 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11929 difference from the V8 ABI is that the global and out registers are
11930 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11931 mode for all SPARC-V9 processors.
11933 @item -mvis
11934 @itemx -mno-vis
11935 @opindex mvis
11936 @opindex mno-vis
11937 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11938 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11939 @end table
11941 These @samp{-m} options are supported in addition to the above
11942 on SPARC-V9 processors in 64-bit environments:
11944 @table @gcctabopt
11945 @item -mlittle-endian
11946 @opindex mlittle-endian
11947 Generate code for a processor running in little-endian mode.  It is only
11948 available for a few configurations and most notably not on Solaris and Linux.
11950 @item -m32
11951 @itemx -m64
11952 @opindex m32
11953 @opindex m64
11954 Generate code for a 32-bit or 64-bit environment.
11955 The 32-bit environment sets int, long and pointer to 32 bits.
11956 The 64-bit environment sets int to 32 bits and long and pointer
11957 to 64 bits.
11959 @item -mcmodel=medlow
11960 @opindex mcmodel=medlow
11961 Generate code for the Medium/Low code model: 64-bit addresses, programs
11962 must be linked in the low 32 bits of memory.  Programs can be statically
11963 or dynamically linked.
11965 @item -mcmodel=medmid
11966 @opindex mcmodel=medmid
11967 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11968 must be linked in the low 44 bits of memory, the text and data segments must
11969 be less than 2GB in size and the data segment must be located within 2GB of
11970 the text segment.
11972 @item -mcmodel=medany
11973 @opindex mcmodel=medany
11974 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11975 may be linked anywhere in memory, the text and data segments must be less
11976 than 2GB in size and the data segment must be located within 2GB of the
11977 text segment.
11979 @item -mcmodel=embmedany
11980 @opindex mcmodel=embmedany
11981 Generate code for the Medium/Anywhere code model for embedded systems:
11982 64-bit addresses, the text and data segments must be less than 2GB in
11983 size, both starting anywhere in memory (determined at link time).  The
11984 global register %g4 points to the base of the data segment.  Programs
11985 are statically linked and PIC is not supported.
11987 @item -mstack-bias
11988 @itemx -mno-stack-bias
11989 @opindex mstack-bias
11990 @opindex mno-stack-bias
11991 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11992 frame pointer if present, are offset by @minus{}2047 which must be added back
11993 when making stack frame references.  This is the default in 64-bit mode.
11994 Otherwise, assume no such offset is present.
11995 @end table
11997 These switches are supported in addition to the above on Solaris:
11999 @table @gcctabopt
12000 @item -threads
12001 @opindex threads
12002 Add support for multithreading using the Solaris threads library.  This
12003 option sets flags for both the preprocessor and linker.  This option does
12004 not affect the thread safety of object code produced by the compiler or
12005 that of libraries supplied with it.
12007 @item -pthreads
12008 @opindex pthreads
12009 Add support for multithreading using the POSIX threads library.  This
12010 option sets flags for both the preprocessor and linker.  This option does
12011 not affect the thread safety of object code produced  by the compiler or
12012 that of libraries supplied with it.
12013 @end table
12015 @node System V Options
12016 @subsection Options for System V
12018 These additional options are available on System V Release 4 for
12019 compatibility with other compilers on those systems:
12021 @table @gcctabopt
12022 @item -G
12023 @opindex G
12024 Create a shared object.
12025 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12027 @item -Qy
12028 @opindex Qy
12029 Identify the versions of each tool used by the compiler, in a
12030 @code{.ident} assembler directive in the output.
12032 @item -Qn
12033 @opindex Qn
12034 Refrain from adding @code{.ident} directives to the output file (this is
12035 the default).
12037 @item -YP,@var{dirs}
12038 @opindex YP
12039 Search the directories @var{dirs}, and no others, for libraries
12040 specified with @option{-l}.
12042 @item -Ym,@var{dir}
12043 @opindex Ym
12044 Look in the directory @var{dir} to find the M4 preprocessor.
12045 The assembler uses this option.
12046 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12047 @c the generic assembler that comes with Solaris takes just -Ym.
12048 @end table
12050 @node TMS320C3x/C4x Options
12051 @subsection TMS320C3x/C4x Options
12052 @cindex TMS320C3x/C4x Options
12054 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12056 @table @gcctabopt
12058 @item -mcpu=@var{cpu_type}
12059 @opindex mcpu
12060 Set the instruction set, register set, and instruction scheduling
12061 parameters for machine type @var{cpu_type}.  Supported values for
12062 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12063 @samp{c44}.  The default is @samp{c40} to generate code for the
12064 TMS320C40.
12066 @item -mbig-memory
12067 @itemx -mbig
12068 @itemx -msmall-memory
12069 @itemx -msmall
12070 @opindex mbig-memory
12071 @opindex mbig
12072 @opindex msmall-memory
12073 @opindex msmall
12074 Generates code for the big or small memory model.  The small memory
12075 model assumed that all data fits into one 64K word page.  At run-time
12076 the data page (DP) register must be set to point to the 64K page
12077 containing the .bss and .data program sections.  The big memory model is
12078 the default and requires reloading of the DP register for every direct
12079 memory access.
12081 @item -mbk
12082 @itemx -mno-bk
12083 @opindex mbk
12084 @opindex mno-bk
12085 Allow (disallow) allocation of general integer operands into the block
12086 count register BK@.
12088 @item -mdb
12089 @itemx -mno-db
12090 @opindex mdb
12091 @opindex mno-db
12092 Enable (disable) generation of code using decrement and branch,
12093 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
12094 on the safe side, this is disabled for the C3x, since the maximum
12095 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12096 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
12097 that it can utilize the decrement and branch instruction, but will give
12098 up if there is more than one memory reference in the loop.  Thus a loop
12099 where the loop counter is decremented can generate slightly more
12100 efficient code, in cases where the RPTB instruction cannot be utilized.
12102 @item -mdp-isr-reload
12103 @itemx -mparanoid
12104 @opindex mdp-isr-reload
12105 @opindex mparanoid
12106 Force the DP register to be saved on entry to an interrupt service
12107 routine (ISR), reloaded to point to the data section, and restored on
12108 exit from the ISR@.  This should not be required unless someone has
12109 violated the small memory model by modifying the DP register, say within
12110 an object library.
12112 @item -mmpyi
12113 @itemx -mno-mpyi
12114 @opindex mmpyi
12115 @opindex mno-mpyi
12116 For the C3x use the 24-bit MPYI instruction for integer multiplies
12117 instead of a library call to guarantee 32-bit results.  Note that if one
12118 of the operands is a constant, then the multiplication will be performed
12119 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
12120 then squaring operations are performed inline instead of a library call.
12122 @item -mfast-fix
12123 @itemx -mno-fast-fix
12124 @opindex mfast-fix
12125 @opindex mno-fast-fix
12126 The C3x/C4x FIX instruction to convert a floating point value to an
12127 integer value chooses the nearest integer less than or equal to the
12128 floating point value rather than to the nearest integer.  Thus if the
12129 floating point number is negative, the result will be incorrectly
12130 truncated an additional code is necessary to detect and correct this
12131 case.  This option can be used to disable generation of the additional
12132 code required to correct the result.
12134 @item -mrptb
12135 @itemx -mno-rptb
12136 @opindex mrptb
12137 @opindex mno-rptb
12138 Enable (disable) generation of repeat block sequences using the RPTB
12139 instruction for zero overhead looping.  The RPTB construct is only used
12140 for innermost loops that do not call functions or jump across the loop
12141 boundaries.  There is no advantage having nested RPTB loops due to the
12142 overhead required to save and restore the RC, RS, and RE registers.
12143 This is enabled by default with @option{-O2}.
12145 @item -mrpts=@var{count}
12146 @itemx -mno-rpts
12147 @opindex mrpts
12148 @opindex mno-rpts
12149 Enable (disable) the use of the single instruction repeat instruction
12150 RPTS@.  If a repeat block contains a single instruction, and the loop
12151 count can be guaranteed to be less than the value @var{count}, GCC will
12152 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
12153 then a RPTS will be emitted even if the loop count cannot be determined
12154 at compile time.  Note that the repeated instruction following RPTS does
12155 not have to be reloaded from memory each iteration, thus freeing up the
12156 CPU buses for operands.  However, since interrupts are blocked by this
12157 instruction, it is disabled by default.
12159 @item -mloop-unsigned
12160 @itemx -mno-loop-unsigned
12161 @opindex mloop-unsigned
12162 @opindex mno-loop-unsigned
12163 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12164 is @math{2^{31} + 1} since these instructions test if the iteration count is
12165 negative to terminate the loop.  If the iteration count is unsigned
12166 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12167 exceeded.  This switch allows an unsigned iteration count.
12169 @item -mti
12170 @opindex mti
12171 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12172 with.  This also enforces compatibility with the API employed by the TI
12173 C3x C compiler.  For example, long doubles are passed as structures
12174 rather than in floating point registers.
12176 @item -mregparm
12177 @itemx -mmemparm
12178 @opindex mregparm
12179 @opindex mmemparm
12180 Generate code that uses registers (stack) for passing arguments to functions.
12181 By default, arguments are passed in registers where possible rather
12182 than by pushing arguments on to the stack.
12184 @item -mparallel-insns
12185 @itemx -mno-parallel-insns
12186 @opindex mparallel-insns
12187 @opindex mno-parallel-insns
12188 Allow the generation of parallel instructions.  This is enabled by
12189 default with @option{-O2}.
12191 @item -mparallel-mpy
12192 @itemx -mno-parallel-mpy
12193 @opindex mparallel-mpy
12194 @opindex mno-parallel-mpy
12195 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12196 provided @option{-mparallel-insns} is also specified.  These instructions have
12197 tight register constraints which can pessimize the code generation
12198 of large functions.
12200 @end table
12202 @node V850 Options
12203 @subsection V850 Options
12204 @cindex V850 Options
12206 These @samp{-m} options are defined for V850 implementations:
12208 @table @gcctabopt
12209 @item -mlong-calls
12210 @itemx -mno-long-calls
12211 @opindex mlong-calls
12212 @opindex mno-long-calls
12213 Treat all calls as being far away (near).  If calls are assumed to be
12214 far away, the compiler will always load the functions address up into a
12215 register, and call indirect through the pointer.
12217 @item -mno-ep
12218 @itemx -mep
12219 @opindex mno-ep
12220 @opindex mep
12221 Do not optimize (do optimize) basic blocks that use the same index
12222 pointer 4 or more times to copy pointer into the @code{ep} register, and
12223 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
12224 option is on by default if you optimize.
12226 @item -mno-prolog-function
12227 @itemx -mprolog-function
12228 @opindex mno-prolog-function
12229 @opindex mprolog-function
12230 Do not use (do use) external functions to save and restore registers
12231 at the prologue and epilogue of a function.  The external functions
12232 are slower, but use less code space if more than one function saves
12233 the same number of registers.  The @option{-mprolog-function} option
12234 is on by default if you optimize.
12236 @item -mspace
12237 @opindex mspace
12238 Try to make the code as small as possible.  At present, this just turns
12239 on the @option{-mep} and @option{-mprolog-function} options.
12241 @item -mtda=@var{n}
12242 @opindex mtda
12243 Put static or global variables whose size is @var{n} bytes or less into
12244 the tiny data area that register @code{ep} points to.  The tiny data
12245 area can hold up to 256 bytes in total (128 bytes for byte references).
12247 @item -msda=@var{n}
12248 @opindex msda
12249 Put static or global variables whose size is @var{n} bytes or less into
12250 the small data area that register @code{gp} points to.  The small data
12251 area can hold up to 64 kilobytes.
12253 @item -mzda=@var{n}
12254 @opindex mzda
12255 Put static or global variables whose size is @var{n} bytes or less into
12256 the first 32 kilobytes of memory.
12258 @item -mv850
12259 @opindex mv850
12260 Specify that the target processor is the V850.
12262 @item -mbig-switch
12263 @opindex mbig-switch
12264 Generate code suitable for big switch tables.  Use this option only if
12265 the assembler/linker complain about out of range branches within a switch
12266 table.
12268 @item -mapp-regs
12269 @opindex mapp-regs
12270 This option will cause r2 and r5 to be used in the code generated by
12271 the compiler.  This setting is the default.
12273 @item -mno-app-regs
12274 @opindex mno-app-regs
12275 This option will cause r2 and r5 to be treated as fixed registers.
12277 @item -mv850e1
12278 @opindex mv850e1
12279 Specify that the target processor is the V850E1.  The preprocessor
12280 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12281 this option is used.
12283 @item -mv850e
12284 @opindex mv850e
12285 Specify that the target processor is the V850E@.  The preprocessor
12286 constant @samp{__v850e__} will be defined if this option is used.
12288 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12289 are defined then a default target processor will be chosen and the
12290 relevant @samp{__v850*__} preprocessor constant will be defined.
12292 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12293 defined, regardless of which processor variant is the target.
12295 @item -mdisable-callt
12296 @opindex mdisable-callt
12297 This option will suppress generation of the CALLT instruction for the
12298 v850e and v850e1 flavors of the v850 architecture.  The default is
12299 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12301 @end table
12303 @node VAX Options
12304 @subsection VAX Options
12305 @cindex VAX options
12307 These @samp{-m} options are defined for the VAX:
12309 @table @gcctabopt
12310 @item -munix
12311 @opindex munix
12312 Do not output certain jump instructions (@code{aobleq} and so on)
12313 that the Unix assembler for the VAX cannot handle across long
12314 ranges.
12316 @item -mgnu
12317 @opindex mgnu
12318 Do output those jump instructions, on the assumption that you
12319 will assemble with the GNU assembler.
12321 @item -mg
12322 @opindex mg
12323 Output code for g-format floating point numbers instead of d-format.
12324 @end table
12326 @node x86-64 Options
12327 @subsection x86-64 Options
12328 @cindex x86-64 options
12330 These are listed under @xref{i386 and x86-64 Options}.
12332 @node Xstormy16 Options
12333 @subsection Xstormy16 Options
12334 @cindex Xstormy16 Options
12336 These options are defined for Xstormy16:
12338 @table @gcctabopt
12339 @item -msim
12340 @opindex msim
12341 Choose startup files and linker script suitable for the simulator.
12342 @end table
12344 @node Xtensa Options
12345 @subsection Xtensa Options
12346 @cindex Xtensa Options
12348 These options are supported for Xtensa targets:
12350 @table @gcctabopt
12351 @item -mconst16
12352 @itemx -mno-const16
12353 @opindex mconst16
12354 @opindex mno-const16
12355 Enable or disable use of @code{CONST16} instructions for loading
12356 constant values.  The @code{CONST16} instruction is currently not a
12357 standard option from Tensilica.  When enabled, @code{CONST16}
12358 instructions are always used in place of the standard @code{L32R}
12359 instructions.  The use of @code{CONST16} is enabled by default only if
12360 the @code{L32R} instruction is not available.
12362 @item -mfused-madd
12363 @itemx -mno-fused-madd
12364 @opindex mfused-madd
12365 @opindex mno-fused-madd
12366 Enable or disable use of fused multiply/add and multiply/subtract
12367 instructions in the floating-point option.  This has no effect if the
12368 floating-point option is not also enabled.  Disabling fused multiply/add
12369 and multiply/subtract instructions forces the compiler to use separate
12370 instructions for the multiply and add/subtract operations.  This may be
12371 desirable in some cases where strict IEEE 754-compliant results are
12372 required: the fused multiply add/subtract instructions do not round the
12373 intermediate result, thereby producing results with @emph{more} bits of
12374 precision than specified by the IEEE standard.  Disabling fused multiply
12375 add/subtract instructions also ensures that the program output is not
12376 sensitive to the compiler's ability to combine multiply and add/subtract
12377 operations.
12379 @item -mtext-section-literals
12380 @itemx -mno-text-section-literals
12381 @opindex mtext-section-literals
12382 @opindex mno-text-section-literals
12383 Control the treatment of literal pools.  The default is
12384 @option{-mno-text-section-literals}, which places literals in a separate
12385 section in the output file.  This allows the literal pool to be placed
12386 in a data RAM/ROM, and it also allows the linker to combine literal
12387 pools from separate object files to remove redundant literals and
12388 improve code size.  With @option{-mtext-section-literals}, the literals
12389 are interspersed in the text section in order to keep them as close as
12390 possible to their references.  This may be necessary for large assembly
12391 files.
12393 @item -mtarget-align
12394 @itemx -mno-target-align
12395 @opindex mtarget-align
12396 @opindex mno-target-align
12397 When this option is enabled, GCC instructs the assembler to
12398 automatically align instructions to reduce branch penalties at the
12399 expense of some code density.  The assembler attempts to widen density
12400 instructions to align branch targets and the instructions following call
12401 instructions.  If there are not enough preceding safe density
12402 instructions to align a target, no widening will be performed.  The
12403 default is @option{-mtarget-align}.  These options do not affect the
12404 treatment of auto-aligned instructions like @code{LOOP}, which the
12405 assembler will always align, either by widening density instructions or
12406 by inserting no-op instructions.
12408 @item -mlongcalls
12409 @itemx -mno-longcalls
12410 @opindex mlongcalls
12411 @opindex mno-longcalls
12412 When this option is enabled, GCC instructs the assembler to translate
12413 direct calls to indirect calls unless it can determine that the target
12414 of a direct call is in the range allowed by the call instruction.  This
12415 translation typically occurs for calls to functions in other source
12416 files.  Specifically, the assembler translates a direct @code{CALL}
12417 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12418 The default is @option{-mno-longcalls}.  This option should be used in
12419 programs where the call target can potentially be out of range.  This
12420 option is implemented in the assembler, not the compiler, so the
12421 assembly code generated by GCC will still show direct call
12422 instructions---look at the disassembled object code to see the actual
12423 instructions.  Note that the assembler will use an indirect call for
12424 every cross-file call, not just those that really will be out of range.
12425 @end table
12427 @node zSeries Options
12428 @subsection zSeries Options
12429 @cindex zSeries options
12431 These are listed under @xref{S/390 and zSeries Options}.
12433 @node Code Gen Options
12434 @section Options for Code Generation Conventions
12435 @cindex code generation conventions
12436 @cindex options, code generation
12437 @cindex run-time options
12439 These machine-independent options control the interface conventions
12440 used in code generation.
12442 Most of them have both positive and negative forms; the negative form
12443 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12444 one of the forms is listed---the one which is not the default.  You
12445 can figure out the other form by either removing @samp{no-} or adding
12448 @table @gcctabopt
12449 @item -fbounds-check
12450 @opindex fbounds-check
12451 For front-ends that support it, generate additional code to check that
12452 indices used to access arrays are within the declared range.  This is
12453 currently only supported by the Java and Fortran 77 front-ends, where
12454 this option defaults to true and false respectively.
12456 @item -ftrapv
12457 @opindex ftrapv
12458 This option generates traps for signed overflow on addition, subtraction,
12459 multiplication operations.
12461 @item -fwrapv
12462 @opindex fwrapv
12463 This option instructs the compiler to assume that signed arithmetic
12464 overflow of addition, subtraction and multiplication wraps around
12465 using twos-complement representation.  This flag enables some optimizations
12466 and disables other.  This option is enabled by default for the Java
12467 front-end, as required by the Java language specification.
12469 @item -fexceptions
12470 @opindex fexceptions
12471 Enable exception handling.  Generates extra code needed to propagate
12472 exceptions.  For some targets, this implies GCC will generate frame
12473 unwind information for all functions, which can produce significant data
12474 size overhead, although it does not affect execution.  If you do not
12475 specify this option, GCC will enable it by default for languages like
12476 C++ which normally require exception handling, and disable it for
12477 languages like C that do not normally require it.  However, you may need
12478 to enable this option when compiling C code that needs to interoperate
12479 properly with exception handlers written in C++.  You may also wish to
12480 disable this option if you are compiling older C++ programs that don't
12481 use exception handling.
12483 @item -fnon-call-exceptions
12484 @opindex fnon-call-exceptions
12485 Generate code that allows trapping instructions to throw exceptions.
12486 Note that this requires platform-specific runtime support that does
12487 not exist everywhere.  Moreover, it only allows @emph{trapping}
12488 instructions to throw exceptions, i.e.@: memory references or floating
12489 point instructions.  It does not allow exceptions to be thrown from
12490 arbitrary signal handlers such as @code{SIGALRM}.
12492 @item -funwind-tables
12493 @opindex funwind-tables
12494 Similar to @option{-fexceptions}, except that it will just generate any needed
12495 static data, but will not affect the generated code in any other way.
12496 You will normally not enable this option; instead, a language processor
12497 that needs this handling would enable it on your behalf.
12499 @item -fasynchronous-unwind-tables
12500 @opindex fasynchronous-unwind-tables
12501 Generate unwind table in dwarf2 format, if supported by target machine.  The
12502 table is exact at each instruction boundary, so it can be used for stack
12503 unwinding from asynchronous events (such as debugger or garbage collector).
12505 @item -fpcc-struct-return
12506 @opindex fpcc-struct-return
12507 Return ``short'' @code{struct} and @code{union} values in memory like
12508 longer ones, rather than in registers.  This convention is less
12509 efficient, but it has the advantage of allowing intercallability between
12510 GCC-compiled files and files compiled with other compilers, particularly
12511 the Portable C Compiler (pcc).
12513 The precise convention for returning structures in memory depends
12514 on the target configuration macros.
12516 Short structures and unions are those whose size and alignment match
12517 that of some integer type.
12519 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12520 switch is not binary compatible with code compiled with the
12521 @option{-freg-struct-return} switch.
12522 Use it to conform to a non-default application binary interface.
12524 @item -freg-struct-return
12525 @opindex freg-struct-return
12526 Return @code{struct} and @code{union} values in registers when possible.
12527 This is more efficient for small structures than
12528 @option{-fpcc-struct-return}.
12530 If you specify neither @option{-fpcc-struct-return} nor
12531 @option{-freg-struct-return}, GCC defaults to whichever convention is
12532 standard for the target.  If there is no standard convention, GCC
12533 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12534 the principal compiler.  In those cases, we can choose the standard, and
12535 we chose the more efficient register return alternative.
12537 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12538 switch is not binary compatible with code compiled with the
12539 @option{-fpcc-struct-return} switch.
12540 Use it to conform to a non-default application binary interface.
12542 @item -fshort-enums
12543 @opindex fshort-enums
12544 Allocate to an @code{enum} type only as many bytes as it needs for the
12545 declared range of possible values.  Specifically, the @code{enum} type
12546 will be equivalent to the smallest integer type which has enough room.
12548 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12549 code that is not binary compatible with code generated without that switch.
12550 Use it to conform to a non-default application binary interface.
12552 @item -fshort-double
12553 @opindex fshort-double
12554 Use the same size for @code{double} as for @code{float}.
12556 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12557 code that is not binary compatible with code generated without that switch.
12558 Use it to conform to a non-default application binary interface.
12560 @item -fshort-wchar
12561 @opindex fshort-wchar
12562 Override the underlying type for @samp{wchar_t} to be @samp{short
12563 unsigned int} instead of the default for the target.  This option is
12564 useful for building programs to run under WINE@.
12566 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12567 code that is not binary compatible with code generated without that switch.
12568 Use it to conform to a non-default application binary interface.
12570 @item -fshared-data
12571 @opindex fshared-data
12572 Requests that the data and non-@code{const} variables of this
12573 compilation be shared data rather than private data.  The distinction
12574 makes sense only on certain operating systems, where shared data is
12575 shared between processes running the same program, while private data
12576 exists in one copy per process.
12578 @item -fno-common
12579 @opindex fno-common
12580 In C, allocate even uninitialized global variables in the data section of the
12581 object file, rather than generating them as common blocks.  This has the
12582 effect that if the same variable is declared (without @code{extern}) in
12583 two different compilations, you will get an error when you link them.
12584 The only reason this might be useful is if you wish to verify that the
12585 program will work on other systems which always work this way.
12587 @item -fno-ident
12588 @opindex fno-ident
12589 Ignore the @samp{#ident} directive.
12591 @item -finhibit-size-directive
12592 @opindex finhibit-size-directive
12593 Don't output a @code{.size} assembler directive, or anything else that
12594 would cause trouble if the function is split in the middle, and the
12595 two halves are placed at locations far apart in memory.  This option is
12596 used when compiling @file{crtstuff.c}; you should not need to use it
12597 for anything else.
12599 @item -fverbose-asm
12600 @opindex fverbose-asm
12601 Put extra commentary information in the generated assembly code to
12602 make it more readable.  This option is generally only of use to those
12603 who actually need to read the generated assembly code (perhaps while
12604 debugging the compiler itself).
12606 @option{-fno-verbose-asm}, the default, causes the
12607 extra information to be omitted and is useful when comparing two assembler
12608 files.
12610 @item -fpic
12611 @opindex fpic
12612 @cindex global offset table
12613 @cindex PIC
12614 Generate position-independent code (PIC) suitable for use in a shared
12615 library, if supported for the target machine.  Such code accesses all
12616 constant addresses through a global offset table (GOT)@.  The dynamic
12617 loader resolves the GOT entries when the program starts (the dynamic
12618 loader is not part of GCC; it is part of the operating system).  If
12619 the GOT size for the linked executable exceeds a machine-specific
12620 maximum size, you get an error message from the linker indicating that
12621 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12622 instead.  (These maximums are 8k on the SPARC and 32k
12623 on the m68k and RS/6000.  The 386 has no such limit.)
12625 Position-independent code requires special support, and therefore works
12626 only on certain machines.  For the 386, GCC supports PIC for System V
12627 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12628 position-independent.
12630 @item -fPIC
12631 @opindex fPIC
12632 If supported for the target machine, emit position-independent code,
12633 suitable for dynamic linking and avoiding any limit on the size of the
12634 global offset table.  This option makes a difference on the m68k,
12635 PowerPC and SPARC@.
12637 Position-independent code requires special support, and therefore works
12638 only on certain machines.
12640 @item -fpie
12641 @itemx -fPIE
12642 @opindex fpie
12643 @opindex fPIE
12644 These options are similar to @option{-fpic} and @option{-fPIC}, but
12645 generated position independent code can be only linked into executables.
12646 Usually these options are used when @option{-pie} GCC option will be
12647 used during linking.
12649 @item -fno-jump-tables
12650 @opindex fno-jump-tables
12651 Do not use jump tables for switch statements even where it would be
12652 more efficient than other code generation strategies.  This option is
12653 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12654 building code which forms part of a dynamic linker and cannot
12655 reference the address of a jump table.  On some targets, jump tables
12656 do not require a GOT and this option is not needed.
12658 @item -ffixed-@var{reg}
12659 @opindex ffixed
12660 Treat the register named @var{reg} as a fixed register; generated code
12661 should never refer to it (except perhaps as a stack pointer, frame
12662 pointer or in some other fixed role).
12664 @var{reg} must be the name of a register.  The register names accepted
12665 are machine-specific and are defined in the @code{REGISTER_NAMES}
12666 macro in the machine description macro file.
12668 This flag does not have a negative form, because it specifies a
12669 three-way choice.
12671 @item -fcall-used-@var{reg}
12672 @opindex fcall-used
12673 Treat the register named @var{reg} as an allocable register that is
12674 clobbered by function calls.  It may be allocated for temporaries or
12675 variables that do not live across a call.  Functions compiled this way
12676 will not save and restore the register @var{reg}.
12678 It is an error to used this flag with the frame pointer or stack pointer.
12679 Use of this flag for other registers that have fixed pervasive roles in
12680 the machine's execution model will produce disastrous results.
12682 This flag does not have a negative form, because it specifies a
12683 three-way choice.
12685 @item -fcall-saved-@var{reg}
12686 @opindex fcall-saved
12687 Treat the register named @var{reg} as an allocable register saved by
12688 functions.  It may be allocated even for temporaries or variables that
12689 live across a call.  Functions compiled this way will save and restore
12690 the register @var{reg} if they use it.
12692 It is an error to used this flag with the frame pointer or stack pointer.
12693 Use of this flag for other registers that have fixed pervasive roles in
12694 the machine's execution model will produce disastrous results.
12696 A different sort of disaster will result from the use of this flag for
12697 a register in which function values may be returned.
12699 This flag does not have a negative form, because it specifies a
12700 three-way choice.
12702 @item -fpack-struct[=@var{n}]
12703 @opindex fpack-struct
12704 Without a value specified, pack all structure members together without
12705 holes.  When a value is specified (which must be a small power of two), pack
12706 structure members according to this value, representing the maximum
12707 alignment (that is, objects with default alignment requirements larger than
12708 this will be output potentially unaligned at the next fitting location.
12710 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12711 code that is not binary compatible with code generated without that switch.
12712 Additionally, it makes the code suboptimal.
12713 Use it to conform to a non-default application binary interface.
12715 @item -finstrument-functions
12716 @opindex finstrument-functions
12717 Generate instrumentation calls for entry and exit to functions.  Just
12718 after function entry and just before function exit, the following
12719 profiling functions will be called with the address of the current
12720 function and its call site.  (On some platforms,
12721 @code{__builtin_return_address} does not work beyond the current
12722 function, so the call site information may not be available to the
12723 profiling functions otherwise.)
12725 @smallexample
12726 void __cyg_profile_func_enter (void *this_fn,
12727                                void *call_site);
12728 void __cyg_profile_func_exit  (void *this_fn,
12729                                void *call_site);
12730 @end smallexample
12732 The first argument is the address of the start of the current function,
12733 which may be looked up exactly in the symbol table.
12735 This instrumentation is also done for functions expanded inline in other
12736 functions.  The profiling calls will indicate where, conceptually, the
12737 inline function is entered and exited.  This means that addressable
12738 versions of such functions must be available.  If all your uses of a
12739 function are expanded inline, this may mean an additional expansion of
12740 code size.  If you use @samp{extern inline} in your C code, an
12741 addressable version of such functions must be provided.  (This is
12742 normally the case anyways, but if you get lucky and the optimizer always
12743 expands the functions inline, you might have gotten away without
12744 providing static copies.)
12746 A function may be given the attribute @code{no_instrument_function}, in
12747 which case this instrumentation will not be done.  This can be used, for
12748 example, for the profiling functions listed above, high-priority
12749 interrupt routines, and any functions from which the profiling functions
12750 cannot safely be called (perhaps signal handlers, if the profiling
12751 routines generate output or allocate memory).
12753 @item -fstack-check
12754 @opindex fstack-check
12755 Generate code to verify that you do not go beyond the boundary of the
12756 stack.  You should specify this flag if you are running in an
12757 environment with multiple threads, but only rarely need to specify it in
12758 a single-threaded environment since stack overflow is automatically
12759 detected on nearly all systems if there is only one stack.
12761 Note that this switch does not actually cause checking to be done; the
12762 operating system must do that.  The switch causes generation of code
12763 to ensure that the operating system sees the stack being extended.
12765 @item -fstack-limit-register=@var{reg}
12766 @itemx -fstack-limit-symbol=@var{sym}
12767 @itemx -fno-stack-limit
12768 @opindex fstack-limit-register
12769 @opindex fstack-limit-symbol
12770 @opindex fno-stack-limit
12771 Generate code to ensure that the stack does not grow beyond a certain value,
12772 either the value of a register or the address of a symbol.  If the stack
12773 would grow beyond the value, a signal is raised.  For most targets,
12774 the signal is raised before the stack overruns the boundary, so
12775 it is possible to catch the signal without taking special precautions.
12777 For instance, if the stack starts at absolute address @samp{0x80000000}
12778 and grows downwards, you can use the flags
12779 @option{-fstack-limit-symbol=__stack_limit} and
12780 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12781 of 128KB@.  Note that this may only work with the GNU linker.
12783 @cindex aliasing of parameters
12784 @cindex parameters, aliased
12785 @item -fargument-alias
12786 @itemx -fargument-noalias
12787 @itemx -fargument-noalias-global
12788 @opindex fargument-alias
12789 @opindex fargument-noalias
12790 @opindex fargument-noalias-global
12791 Specify the possible relationships among parameters and between
12792 parameters and global data.
12794 @option{-fargument-alias} specifies that arguments (parameters) may
12795 alias each other and may alias global storage.@*
12796 @option{-fargument-noalias} specifies that arguments do not alias
12797 each other, but may alias global storage.@*
12798 @option{-fargument-noalias-global} specifies that arguments do not
12799 alias each other and do not alias global storage.
12801 Each language will automatically use whatever option is required by
12802 the language standard.  You should not need to use these options yourself.
12804 @item -fleading-underscore
12805 @opindex fleading-underscore
12806 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12807 change the way C symbols are represented in the object file.  One use
12808 is to help link with legacy assembly code.
12810 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12811 generate code that is not binary compatible with code generated without that
12812 switch.  Use it to conform to a non-default application binary interface.
12813 Not all targets provide complete support for this switch.
12815 @item -ftls-model=@var{model}
12816 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12817 The @var{model} argument should be one of @code{global-dynamic},
12818 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12820 The default without @option{-fpic} is @code{initial-exec}; with
12821 @option{-fpic} the default is @code{global-dynamic}.
12823 @item -fvisibility=@var{default|internal|hidden|protected}
12824 @opindex fvisibility
12825 Set the default ELF image symbol visibility to the specified option---all
12826 symbols will be marked with this unless overridden within the code.
12827 Using this feature can very substantially improve linking and
12828 load times of shared object libraries, produce more optimized
12829 code, provide near-perfect API export and prevent symbol clashes.
12830 It is @strong{strongly} recommended that you use this in any shared objects
12831 you distribute.
12833 Despite the nomenclature, @code{default} always means public ie;
12834 available to be linked against from outside the shared object.
12835 @code{protected} and @code{internal} are pretty useless in real-world
12836 usage so the only other commonly used option will be @code{hidden}.
12837 The default if @option{-fvisibility} isn't specified is
12838 @code{default}, i.e., make every
12839 symbol public---this causes the same behavior as previous versions of
12840 GCC@.
12842 A good explanation of the benefits offered by ensuring ELF
12843 symbols have the correct visibility is given by ``How To Write
12844 Shared Libraries'' by Ulrich Drepper (which can be found at
12845 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12846 solution made possible by this option to marking things hidden when
12847 the default is public is to make the default hidden and mark things
12848 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12849 and @code{__attribute__ ((visibility("default")))} instead of
12850 @code{__declspec(dllexport)} you get almost identical semantics with
12851 identical syntax.  This is a great boon to those working with
12852 cross-platform projects.
12854 For those adding visibility support to existing code, you may find
12855 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12856 the declarations you wish to set visibility for with (for example)
12857 @samp{#pragma GCC visibility push(hidden)} and
12858 @samp{#pragma GCC visibility pop}.
12859 Bear in mind that symbol visibility should be viewed @strong{as
12860 part of the API interface contract} and thus all new code should
12861 always specify visibility when it is not the default ie; declarations
12862 only for use within the local DSO should @strong{always} be marked explicitly
12863 as hidden as so to avoid PLT indirection overheads---making this
12864 abundantly clear also aids readability and self-documentation of the code.
12865 Note that due to ISO C++ specification requirements, operator new and
12866 operator delete must always be of default visibility.
12868 An overview of these techniques, their benefits and how to use them
12869 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12871 @end table
12873 @c man end
12875 @node Environment Variables
12876 @section Environment Variables Affecting GCC
12877 @cindex environment variables
12879 @c man begin ENVIRONMENT
12880 This section describes several environment variables that affect how GCC
12881 operates.  Some of them work by specifying directories or prefixes to use
12882 when searching for various kinds of files.  Some are used to specify other
12883 aspects of the compilation environment.
12885 Note that you can also specify places to search using options such as
12886 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12887 take precedence over places specified using environment variables, which
12888 in turn take precedence over those specified by the configuration of GCC@.
12889 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12890 GNU Compiler Collection (GCC) Internals}.
12892 @table @env
12893 @item LANG
12894 @itemx LC_CTYPE
12895 @c @itemx LC_COLLATE
12896 @itemx LC_MESSAGES
12897 @c @itemx LC_MONETARY
12898 @c @itemx LC_NUMERIC
12899 @c @itemx LC_TIME
12900 @itemx LC_ALL
12901 @findex LANG
12902 @findex LC_CTYPE
12903 @c @findex LC_COLLATE
12904 @findex LC_MESSAGES
12905 @c @findex LC_MONETARY
12906 @c @findex LC_NUMERIC
12907 @c @findex LC_TIME
12908 @findex LC_ALL
12909 @cindex locale
12910 These environment variables control the way that GCC uses
12911 localization information that allow GCC to work with different
12912 national conventions.  GCC inspects the locale categories
12913 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12914 so.  These locale categories can be set to any value supported by your
12915 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12916 Kingdom encoded in UTF-8.
12918 The @env{LC_CTYPE} environment variable specifies character
12919 classification.  GCC uses it to determine the character boundaries in
12920 a string; this is needed for some multibyte encodings that contain quote
12921 and escape characters that would otherwise be interpreted as a string
12922 end or escape.
12924 The @env{LC_MESSAGES} environment variable specifies the language to
12925 use in diagnostic messages.
12927 If the @env{LC_ALL} environment variable is set, it overrides the value
12928 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12929 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12930 environment variable.  If none of these variables are set, GCC
12931 defaults to traditional C English behavior.
12933 @item TMPDIR
12934 @findex TMPDIR
12935 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12936 files.  GCC uses temporary files to hold the output of one stage of
12937 compilation which is to be used as input to the next stage: for example,
12938 the output of the preprocessor, which is the input to the compiler
12939 proper.
12941 @item GCC_EXEC_PREFIX
12942 @findex GCC_EXEC_PREFIX
12943 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12944 names of the subprograms executed by the compiler.  No slash is added
12945 when this prefix is combined with the name of a subprogram, but you can
12946 specify a prefix that ends with a slash if you wish.
12948 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12949 an appropriate prefix to use based on the pathname it was invoked with.
12951 If GCC cannot find the subprogram using the specified prefix, it
12952 tries looking in the usual places for the subprogram.
12954 The default value of @env{GCC_EXEC_PREFIX} is
12955 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12956 of @code{prefix} when you ran the @file{configure} script.
12958 Other prefixes specified with @option{-B} take precedence over this prefix.
12960 This prefix is also used for finding files such as @file{crt0.o} that are
12961 used for linking.
12963 In addition, the prefix is used in an unusual way in finding the
12964 directories to search for header files.  For each of the standard
12965 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12966 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12967 replacing that beginning with the specified prefix to produce an
12968 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12969 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12970 These alternate directories are searched first; the standard directories
12971 come next.
12973 @item COMPILER_PATH
12974 @findex COMPILER_PATH
12975 The value of @env{COMPILER_PATH} is a colon-separated list of
12976 directories, much like @env{PATH}.  GCC tries the directories thus
12977 specified when searching for subprograms, if it can't find the
12978 subprograms using @env{GCC_EXEC_PREFIX}.
12980 @item LIBRARY_PATH
12981 @findex LIBRARY_PATH
12982 The value of @env{LIBRARY_PATH} is a colon-separated list of
12983 directories, much like @env{PATH}.  When configured as a native compiler,
12984 GCC tries the directories thus specified when searching for special
12985 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12986 using GCC also uses these directories when searching for ordinary
12987 libraries for the @option{-l} option (but directories specified with
12988 @option{-L} come first).
12990 @item LANG
12991 @findex LANG
12992 @cindex locale definition
12993 This variable is used to pass locale information to the compiler.  One way in
12994 which this information is used is to determine the character set to be used
12995 when character literals, string literals and comments are parsed in C and C++.
12996 When the compiler is configured to allow multibyte characters,
12997 the following values for @env{LANG} are recognized:
12999 @table @samp
13000 @item C-JIS
13001 Recognize JIS characters.
13002 @item C-SJIS
13003 Recognize SJIS characters.
13004 @item C-EUCJP
13005 Recognize EUCJP characters.
13006 @end table
13008 If @env{LANG} is not defined, or if it has some other value, then the
13009 compiler will use mblen and mbtowc as defined by the default locale to
13010 recognize and translate multibyte characters.
13011 @end table
13013 @noindent
13014 Some additional environments variables affect the behavior of the
13015 preprocessor.
13017 @include cppenv.texi
13019 @c man end
13021 @node Precompiled Headers
13022 @section Using Precompiled Headers
13023 @cindex precompiled headers
13024 @cindex speed of compilation
13026 Often large projects have many header files that are included in every
13027 source file.  The time the compiler takes to process these header files
13028 over and over again can account for nearly all of the time required to
13029 build the project.  To make builds faster, GCC allows users to
13030 `precompile' a header file; then, if builds can use the precompiled
13031 header file they will be much faster.
13033 To create a precompiled header file, simply compile it as you would any
13034 other file, if necessary using the @option{-x} option to make the driver
13035 treat it as a C or C++ header file.  You will probably want to use a
13036 tool like @command{make} to keep the precompiled header up-to-date when
13037 the headers it contains change.
13039 A precompiled header file will be searched for when @code{#include} is
13040 seen in the compilation.  As it searches for the included file
13041 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13042 compiler looks for a precompiled header in each directory just before it
13043 looks for the include file in that directory.  The name searched for is
13044 the name specified in the @code{#include} with @samp{.gch} appended.  If
13045 the precompiled header file can't be used, it is ignored.
13047 For instance, if you have @code{#include "all.h"}, and you have
13048 @file{all.h.gch} in the same directory as @file{all.h}, then the
13049 precompiled header file will be used if possible, and the original
13050 header will be used otherwise.
13052 Alternatively, you might decide to put the precompiled header file in a
13053 directory and use @option{-I} to ensure that directory is searched
13054 before (or instead of) the directory containing the original header.
13055 Then, if you want to check that the precompiled header file is always
13056 used, you can put a file of the same name as the original header in this
13057 directory containing an @code{#error} command.
13059 This also works with @option{-include}.  So yet another way to use
13060 precompiled headers, good for projects not designed with precompiled
13061 header files in mind, is to simply take most of the header files used by
13062 a project, include them from another header file, precompile that header
13063 file, and @option{-include} the precompiled header.  If the header files
13064 have guards against multiple inclusion, they will be skipped because
13065 they've already been included (in the precompiled header).
13067 If you need to precompile the same header file for different
13068 languages, targets, or compiler options, you can instead make a
13069 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13070 header in the directory, perhaps using @option{-o}.  It doesn't matter
13071 what you call the files in the directory, every precompiled header in
13072 the directory will be considered.  The first precompiled header
13073 encountered in the directory that is valid for this compilation will
13074 be used; they're searched in no particular order.
13076 There are many other possibilities, limited only by your imagination,
13077 good sense, and the constraints of your build system.
13079 A precompiled header file can be used only when these conditions apply:
13081 @itemize
13082 @item
13083 Only one precompiled header can be used in a particular compilation.
13085 @item
13086 A precompiled header can't be used once the first C token is seen.  You
13087 can have preprocessor directives before a precompiled header; you can
13088 even include a precompiled header from inside another header, so long as
13089 there are no C tokens before the @code{#include}.
13091 @item
13092 The precompiled header file must be produced for the same language as
13093 the current compilation.  You can't use a C precompiled header for a C++
13094 compilation.
13096 @item
13097 The precompiled header file must have been produced by the same compiler
13098 binary as the current compilation is using.
13100 @item
13101 Any macros defined before the precompiled header is included must
13102 either be defined in the same way as when the precompiled header was
13103 generated, or must not affect the precompiled header, which usually
13104 means that they don't appear in the precompiled header at all.
13106 The @option{-D} option is one way to define a macro before a
13107 precompiled header is included; using a @code{#define} can also do it.
13108 There are also some options that define macros implicitly, like
13109 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13110 defined this way.
13112 @item If debugging information is output when using the precompiled
13113 header, using @option{-g} or similar, the same kind of debugging information
13114 must have been output when building the precompiled header.  However,
13115 a precompiled header built using @option{-g} can be used in a compilation
13116 when no debugging information is being output.
13118 @item The same @option{-m} options must generally be used when building
13119 and using the precompiled header.  @xref{Submodel Options},
13120 for any cases where this rule is relaxed.
13122 @item Each of the following options must be the same when building and using
13123 the precompiled header:
13125 @gccoptlist{-fexceptions -funit-at-a-time}
13127 @item
13128 Some other command-line options starting with @option{-f},
13129 @option{-p}, or @option{-O} must be defined in the same way as when
13130 the precompiled header was generated.  At present, it's not clear
13131 which options are safe to change and which are not; the safest choice
13132 is to use exactly the same options when generating and using the
13133 precompiled header.  The following are known to be safe:
13135 @gccoptlist{-fpreprocessed
13136 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13137 -fsched-verbose=<number> -fschedule-insns
13138 -pedantic-errors}
13140 @end itemize
13142 For all of these except the last, the compiler will automatically
13143 ignore the precompiled header if the conditions aren't met.  If you
13144 find an option combination that doesn't work and doesn't cause the
13145 precompiled header to be ignored, please consider filing a bug report,
13146 see @ref{Bugs}.
13148 If you do use differing options when generating and using the
13149 precompiled header, the actual behavior will be a mixture of the
13150 behavior for the options.  For instance, if you use @option{-g} to
13151 generate the precompiled header but not when using it, you may or may
13152 not get debugging information for routines in the precompiled header.
13154 @node Running Protoize
13155 @section Running Protoize
13157 The program @code{protoize} is an optional part of GCC@.  You can use
13158 it to add prototypes to a program, thus converting the program to ISO
13159 C in one respect.  The companion program @code{unprotoize} does the
13160 reverse: it removes argument types from any prototypes that are found.
13162 When you run these programs, you must specify a set of source files as
13163 command line arguments.  The conversion programs start out by compiling
13164 these files to see what functions they define.  The information gathered
13165 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13167 After scanning comes actual conversion.  The specified files are all
13168 eligible to be converted; any files they include (whether sources or
13169 just headers) are eligible as well.
13171 But not all the eligible files are converted.  By default,
13172 @code{protoize} and @code{unprotoize} convert only source and header
13173 files in the current directory.  You can specify additional directories
13174 whose files should be converted with the @option{-d @var{directory}}
13175 option.  You can also specify particular files to exclude with the
13176 @option{-x @var{file}} option.  A file is converted if it is eligible, its
13177 directory name matches one of the specified directory names, and its
13178 name within the directory has not been excluded.
13180 Basic conversion with @code{protoize} consists of rewriting most
13181 function definitions and function declarations to specify the types of
13182 the arguments.  The only ones not rewritten are those for varargs
13183 functions.
13185 @code{protoize} optionally inserts prototype declarations at the
13186 beginning of the source file, to make them available for any calls that
13187 precede the function's definition.  Or it can insert prototype
13188 declarations with block scope in the blocks where undeclared functions
13189 are called.
13191 Basic conversion with @code{unprotoize} consists of rewriting most
13192 function declarations to remove any argument types, and rewriting
13193 function definitions to the old-style pre-ISO form.
13195 Both conversion programs print a warning for any function declaration or
13196 definition that they can't convert.  You can suppress these warnings
13197 with @option{-q}.
13199 The output from @code{protoize} or @code{unprotoize} replaces the
13200 original source file.  The original file is renamed to a name ending
13201 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13202 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
13203 for DOS) file already exists, then the source file is simply discarded.
13205 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13206 scan the program and collect information about the functions it uses.
13207 So neither of these programs will work until GCC is installed.
13209 Here is a table of the options you can use with @code{protoize} and
13210 @code{unprotoize}.  Each option works with both programs unless
13211 otherwise stated.
13213 @table @code
13214 @item -B @var{directory}
13215 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13216 usual directory (normally @file{/usr/local/lib}).  This file contains
13217 prototype information about standard system functions.  This option
13218 applies only to @code{protoize}.
13220 @item -c @var{compilation-options}
13221 Use @var{compilation-options} as the options when running @command{gcc} to
13222 produce the @samp{.X} files.  The special option @option{-aux-info} is
13223 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13225 Note that the compilation options must be given as a single argument to
13226 @code{protoize} or @code{unprotoize}.  If you want to specify several
13227 @command{gcc} options, you must quote the entire set of compilation options
13228 to make them a single word in the shell.
13230 There are certain @command{gcc} arguments that you cannot use, because they
13231 would produce the wrong kind of output.  These include @option{-g},
13232 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13233 the @var{compilation-options}, they are ignored.
13235 @item -C
13236 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13237 systems) instead of @samp{.c}.  This is convenient if you are converting
13238 a C program to C++.  This option applies only to @code{protoize}.
13240 @item -g
13241 Add explicit global declarations.  This means inserting explicit
13242 declarations at the beginning of each source file for each function
13243 that is called in the file and was not declared.  These declarations
13244 precede the first function definition that contains a call to an
13245 undeclared function.  This option applies only to @code{protoize}.
13247 @item -i @var{string}
13248 Indent old-style parameter declarations with the string @var{string}.
13249 This option applies only to @code{protoize}.
13251 @code{unprotoize} converts prototyped function definitions to old-style
13252 function definitions, where the arguments are declared between the
13253 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
13254 uses five spaces as the indentation.  If you want to indent with just
13255 one space instead, use @option{-i " "}.
13257 @item -k
13258 Keep the @samp{.X} files.  Normally, they are deleted after conversion
13259 is finished.
13261 @item -l
13262 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
13263 a prototype declaration for each function in each block which calls the
13264 function without any declaration.  This option applies only to
13265 @code{protoize}.
13267 @item -n
13268 Make no real changes.  This mode just prints information about the conversions
13269 that would have been done without @option{-n}.
13271 @item -N
13272 Make no @samp{.save} files.  The original files are simply deleted.
13273 Use this option with caution.
13275 @item -p @var{program}
13276 Use the program @var{program} as the compiler.  Normally, the name
13277 @file{gcc} is used.
13279 @item -q
13280 Work quietly.  Most warnings are suppressed.
13282 @item -v
13283 Print the version number, just like @option{-v} for @command{gcc}.
13284 @end table
13286 If you need special compiler options to compile one of your program's
13287 source files, then you should generate that file's @samp{.X} file
13288 specially, by running @command{gcc} on that source file with the
13289 appropriate options and the option @option{-aux-info}.  Then run
13290 @code{protoize} on the entire set of files.  @code{protoize} will use
13291 the existing @samp{.X} file because it is newer than the source file.
13292 For example:
13294 @smallexample
13295 gcc -Dfoo=bar file1.c -aux-info file1.X
13296 protoize *.c
13297 @end smallexample
13299 @noindent
13300 You need to include the special files along with the rest in the
13301 @code{protoize} command, even though their @samp{.X} files already
13302 exist, because otherwise they won't get converted.
13304 @xref{Protoize Caveats}, for more information on how to use
13305 @code{protoize} successfully.