* function.c (expand_function_end): If current_function_calls_alloca,
[official-gcc.git] / gcc / doc / invoke.texi
blob7013bb2e29e9c1023bf14821f6709415ddeae224
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}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
112 @c man end
114 @xref{Option Index}, for an index to GCC's options.
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
125                         and Objective-C++.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
148 @c man begin OPTIONS
150 @node Option Summary
151 @section Option Summary
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-exceptions @gol
202 -freplace-objc-classes @gol
203 -fzero-link @gol
204 -gen-decls @gol
205 -Wno-protocol  -Wselector -Wundeclared-selector}
207 @item Language Independent Options
208 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
209 @gccoptlist{-fmessage-length=@var{n}  @gol
210 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
232 -Wreturn-type  -Wsequence-point  -Wshadow @gol
233 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
234 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
235 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
236 -Wunknown-pragmas  -Wunreachable-code @gol
237 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
238 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
239 -Wvariadic-macros}
241 @item C-only Warning Options
242 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
243 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
244 -Wstrict-prototypes  -Wtraditional @gol
245 -Wdeclaration-after-statement -Wno-pointer-sign}
247 @item Debugging Options
248 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
249 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
250 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
251 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
252 -fdump-ipa-all -fdump-ipa-cgraph @gol
253 -fdump-tree-all @gol
254 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
255 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
258 -fdump-tree-ch @gol
259 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-nrv -fdump-tree-vect @gol
268 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
270 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
271 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
272 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
273 -ftest-coverage  -ftime-report -fvar-tracking @gol
274 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
275 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
276 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
277 -print-multi-directory  -print-multi-lib @gol
278 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
279 -save-temps  -time}
281 @item Optimization Options
282 @xref{Optimize Options,,Options that Control Optimization}.
283 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
284 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
285 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
286 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
287 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
288 -fcaller-saves  -fcprop-registers @gol
289 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
290 -fdelayed-branch  -fdelete-null-pointer-checks @gol
291 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
292 -fforce-addr  -fforce-mem  -ffunction-sections @gol
293 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
294 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
295 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
296 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
297 -fmodulo-sched -fno-branch-count-reg @gol
298 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
299 -fno-function-cse  -fno-guess-branch-probability @gol
300 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
301 -funsafe-math-optimizations  -ffinite-math-only @gol
302 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
303 -fomit-frame-pointer  -foptimize-register-move @gol
304 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
305 -fprofile-generate -fprofile-use @gol
306 -fregmove  -frename-registers @gol
307 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
308 -frerun-cse-after-loop  -frerun-loop-opt @gol
309 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
310 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
311 -fsched-spec-load-dangerous  @gol
312 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
313 -fsched2-use-superblocks @gol
314 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
315 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
316 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
317 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
318 -fsplit-ivs-in-unroller -funswitch-loops @gol
319 -fvariable-expansion-in-unroller @gol
320 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
321 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
322 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
323 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
324 --param @var{name}=@var{value}
325 -O  -O0  -O1  -O2  -O3  -Os}
327 @item Preprocessor Options
328 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
329 @gccoptlist{-A@var{question}=@var{answer} @gol
330 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
331 -C  -dD  -dI  -dM  -dN @gol
332 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
333 -idirafter @var{dir} @gol
334 -include @var{file}  -imacros @var{file} @gol
335 -iprefix @var{file}  -iwithprefix @var{dir} @gol
336 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
337 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
338 -P  -fworking-directory  -remap @gol
339 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
340 -Xpreprocessor @var{option}}
342 @item Assembler Option
343 @xref{Assembler Options,,Passing Options to the Assembler}.
344 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
346 @item Linker Options
347 @xref{Link Options,,Options for Linking}.
348 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
349 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
350 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
351 -Wl,@var{option}  -Xlinker @var{option} @gol
352 -u @var{symbol}}
354 @item Directory Options
355 @xref{Directory Options,,Options for Directory Search}.
356 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
358 @item Target Options
359 @c I wrote this xref this way to avoid overfull hbox. -- rms
360 @xref{Target Options}.
361 @gccoptlist{-V @var{version}  -b @var{machine}}
363 @item Machine Dependent Options
364 @xref{Submodel Options,,Hardware Models and Configurations}.
365 @c This list is ordered alphanumerically by subsection name.
366 @c Try and put the significant identifier (CPU or system) first,
367 @c so users have a clue at guessing where the ones they want will be.
369 @emph{ARC Options}
370 @gccoptlist{-EB  -EL @gol
371 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
372 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
374 @emph{ARM Options}
375 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
376 -mabi=@var{name} @gol
377 -mapcs-stack-check  -mno-apcs-stack-check @gol
378 -mapcs-float  -mno-apcs-float @gol
379 -mapcs-reentrant  -mno-apcs-reentrant @gol
380 -msched-prolog  -mno-sched-prolog @gol
381 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
382 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
383 -mthumb-interwork  -mno-thumb-interwork @gol
384 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
385 -mstructure-size-boundary=@var{n} @gol
386 -mabort-on-noreturn @gol
387 -mlong-calls  -mno-long-calls @gol
388 -msingle-pic-base  -mno-single-pic-base @gol
389 -mpic-register=@var{reg} @gol
390 -mnop-fun-dllimport @gol
391 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
392 -mpoke-function-name @gol
393 -mthumb  -marm @gol
394 -mtpcs-frame  -mtpcs-leaf-frame @gol
395 -mcaller-super-interworking  -mcallee-super-interworking}
397 @emph{AVR Options}
398 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
399 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
401 @emph{CRIS Options}
402 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
403 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
404 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
405 -mstack-align  -mdata-align  -mconst-align @gol
406 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
407 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
408 -mmul-bug-workaround  -mno-mul-bug-workaround}
410 @emph{Darwin Options}
411 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
412 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
413 -client_name  -compatibility_version  -current_version @gol
414 -dead_strip @gol
415 -dependency-file  -dylib_file  -dylinker_install_name @gol
416 -dynamic  -dynamiclib  -exported_symbols_list @gol
417 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
418 -force_flat_namespace  -headerpad_max_install_names @gol
419 -image_base  -init  -install_name  -keep_private_externs @gol
420 -multi_module  -multiply_defined  -multiply_defined_unused @gol
421 -noall_load   -no_dead_strip_inits_and_terms @gol
422 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
423 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
424 -private_bundle  -read_only_relocs  -sectalign @gol
425 -sectobjectsymbols  -whyload  -seg1addr @gol
426 -sectcreate  -sectobjectsymbols  -sectorder @gol
427 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
428 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
429 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
430 -single_module  -static  -sub_library  -sub_umbrella @gol
431 -twolevel_namespace  -umbrella  -undefined @gol
432 -unexported_symbols_list  -weak_reference_mismatches @gol
433 -whatsloaded -F -gused -gfull -mone-byte-bool}
435 @emph{DEC Alpha Options}
436 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
437 -mieee  -mieee-with-inexact  -mieee-conformant @gol
438 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
439 -mtrap-precision=@var{mode}  -mbuild-constants @gol
440 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
441 -mbwx  -mmax  -mfix  -mcix @gol
442 -mfloat-vax  -mfloat-ieee @gol
443 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
444 -msmall-text  -mlarge-text @gol
445 -mmemory-latency=@var{time}}
447 @emph{DEC Alpha/VMS Options}
448 @gccoptlist{-mvms-return-codes}
450 @emph{FRV Options}
451 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
452 -mhard-float  -msoft-float @gol
453 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
454 -mdouble  -mno-double @gol
455 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
456 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
457 -mlinked-fp  -mlong-calls  -malign-labels @gol
458 -mlibrary-pic  -macc-4  -macc-8 @gol
459 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
460 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
461 -mvliw-branch  -mno-vliw-branch @gol
462 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
463 -mno-nested-cond-exec  -mtomcat-stats @gol
464 -mcpu=@var{cpu}}
466 @emph{H8/300 Options}
467 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
469 @emph{HPPA Options}
470 @gccoptlist{-march=@var{architecture-type} @gol
471 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
472 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
473 -mfixed-range=@var{register-range} @gol
474 -mjump-in-delay -mlinker-opt -mlong-calls @gol
475 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
476 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
477 -mno-jump-in-delay  -mno-long-load-store @gol
478 -mno-portable-runtime  -mno-soft-float @gol
479 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
480 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
481 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
482 -munix=@var{unix-std}  -nolibdld  -static  -threads}
484 @emph{i386 and x86-64 Options}
485 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
486 -mfpmath=@var{unit} @gol
487 -masm=@var{dialect}  -mno-fancy-math-387 @gol
488 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
489 -mno-wide-multiply  -mrtd  -malign-double @gol
490 -mpreferred-stack-boundary=@var{num} @gol
491 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
492 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
493 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
494 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
495 -mno-red-zone -mno-tls-direct-seg-refs @gol
496 -mcmodel=@var{code-model} @gol
497 -m32  -m64}
499 @emph{IA-64 Options}
500 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
501 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
502 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
503 -minline-float-divide-max-throughput @gol
504 -minline-int-divide-min-latency @gol
505 -minline-int-divide-max-throughput  @gol
506 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
507 -mno-dwarf2-asm -mearly-stop-bits @gol
508 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
509 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
511 @emph{M32R/D Options}
512 @gccoptlist{-m32r2 -m32rx -m32r @gol
513 -mdebug @gol
514 -malign-loops -mno-align-loops @gol
515 -missue-rate=@var{number} @gol
516 -mbranch-cost=@var{number} @gol
517 -mmodel=@var{code-size-model-type} @gol
518 -msdata=@var{sdata-type} @gol
519 -mno-flush-func -mflush-func=@var{name} @gol
520 -mno-flush-trap -mflush-trap=@var{number} @gol
521 -G @var{num}}
523 @emph{M680x0 Options}
524 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
525 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
526 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
527 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
528 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
530 @emph{M68hc1x Options}
531 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
532 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
533 -msoft-reg-count=@var{count}}
535 @emph{MCore Options}
536 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
537 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
538 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
539 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
540 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
542 @emph{MIPS Options}
543 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
544 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
545 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
546 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
547 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
548 -mpaired-single  -mips3d @gol
549 -mint64  -mlong64  -mlong32 @gol
550 -G@var{num}  -membedded-data  -mno-embedded-data @gol
551 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
552 -msplit-addresses  -mno-split-addresses  @gol
553 -mexplicit-relocs  -mno-explicit-relocs  @gol
554 -mcheck-zero-division  -mno-check-zero-division @gol
555 -mdivide-traps  -mdivide-breaks @gol
556 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
557 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
558 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
559 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
560 -mflush-func=@var{func}  -mno-flush-func @gol
561 -mbranch-likely  -mno-branch-likely @gol
562 -mfp-exceptions -mno-fp-exceptions @gol
563 -mvr4130-align -mno-vr4130-align}
565 @emph{MMIX Options}
566 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
567 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
568 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
569 -mno-base-addresses  -msingle-exit  -mno-single-exit}
571 @emph{MN10300 Options}
572 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
573 -mam33  -mno-am33 @gol
574 -mam33-2  -mno-am33-2 @gol
575 -mno-crt0  -mrelax}
577 @emph{NS32K Options}
578 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
579 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
580 -mregparam  -mnoregparam  -msb  -mnosb @gol
581 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
583 @emph{PDP-11 Options}
584 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
585 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
586 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
587 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
588 -mbranch-expensive  -mbranch-cheap @gol
589 -msplit  -mno-split  -munix-asm  -mdec-asm}
591 @emph{PowerPC Options}
592 See RS/6000 and PowerPC Options.
594 @emph{RS/6000 and PowerPC Options}
595 @gccoptlist{-mcpu=@var{cpu-type} @gol
596 -mtune=@var{cpu-type} @gol
597 -mpower  -mno-power  -mpower2  -mno-power2 @gol
598 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
599 -maltivec  -mno-altivec @gol
600 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
601 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
602 -mnew-mnemonics  -mold-mnemonics @gol
603 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
604 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
605 -malign-power  -malign-natural @gol
606 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
607 -mstring  -mno-string  -mupdate  -mno-update @gol
608 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
609 -mstrict-align  -mno-strict-align  -mrelocatable @gol
610 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
611 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
612 -mdynamic-no-pic @gol
613 -mprioritize-restricted-insns=@var{priority} @gol
614 -msched-costly-dep=@var{dependence_type} @gol
615 -minsert-sched-nops=@var{scheme} @gol
616 -mcall-sysv  -mcall-netbsd @gol
617 -maix-struct-return  -msvr4-struct-return @gol
618 -mabi=altivec  -mabi=no-altivec @gol
619 -mabi=spe  -mabi=no-spe @gol
620 -misel=yes  -misel=no @gol
621 -mspe=yes  -mspe=no @gol
622 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
623 -mprototype  -mno-prototype @gol
624 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
625 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
627 @emph{S/390 and zSeries Options}
628 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
629 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
630 -mpacked-stack  -mno-packed-stack @gol
631 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
632 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
633 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
634 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
636 @emph{SH Options}
637 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
638 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
639 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
640 -m5-64media  -m5-64media-nofpu @gol
641 -m5-32media  -m5-32media-nofpu @gol
642 -m5-compact  -m5-compact-nofpu @gol
643 -mb  -ml  -mdalign  -mrelax @gol
644 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
645 -mieee  -misize  -mpadstruct  -mspace @gol
646 -mprefergot  -musermode}
648 @emph{SPARC Options}
649 @gccoptlist{-mcpu=@var{cpu-type} @gol
650 -mtune=@var{cpu-type} @gol
651 -mcmodel=@var{code-model} @gol
652 -m32  -m64  -mapp-regs  -mno-app-regs @gol
653 -mfaster-structs  -mno-faster-structs @gol
654 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
655 -mhard-quad-float  -msoft-quad-float @gol
656 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
657 -mstack-bias  -mno-stack-bias @gol
658 -munaligned-doubles  -mno-unaligned-doubles @gol
659 -mv8plus  -mno-v8plus  -mvis  -mno-vis
660 -threads -pthreads}
662 @emph{System V Options}
663 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
665 @emph{TMS320C3x/C4x Options}
666 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
667 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
668 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
669 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
671 @emph{V850 Options}
672 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
673 -mprolog-function  -mno-prolog-function  -mspace @gol
674 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
675 -mapp-regs  -mno-app-regs @gol
676 -mdisable-callt  -mno-disable-callt @gol
677 -mv850e1 @gol
678 -mv850e @gol
679 -mv850  -mbig-switch}
681 @emph{VAX Options}
682 @gccoptlist{-mg  -mgnu  -munix}
684 @emph{x86-64 Options}
685 See i386 and x86-64 Options.
687 @emph{Xstormy16 Options}
688 @gccoptlist{-msim}
690 @emph{Xtensa Options}
691 @gccoptlist{-mconst16 -mno-const16 @gol
692 -mfused-madd  -mno-fused-madd @gol
693 -mtext-section-literals  -mno-text-section-literals @gol
694 -mtarget-align  -mno-target-align @gol
695 -mlongcalls  -mno-longcalls}
697 @emph{zSeries Options}
698 See S/390 and zSeries Options.
700 @item Code Generation Options
701 @xref{Code Gen Options,,Options for Code Generation Conventions}.
702 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
703 -ffixed-@var{reg}  -fexceptions @gol
704 -fnon-call-exceptions  -funwind-tables @gol
705 -fasynchronous-unwind-tables @gol
706 -finhibit-size-directive  -finstrument-functions @gol
707 -fno-common  -fno-ident @gol
708 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
709 -freg-struct-return  -fshared-data  -fshort-enums @gol
710 -fshort-double  -fshort-wchar @gol
711 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
712 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
713 -fargument-alias  -fargument-noalias @gol
714 -fargument-noalias-global  -fleading-underscore @gol
715 -ftls-model=@var{model} @gol
716 -ftrapv  -fwrapv  -fbounds-check @gol
717 -fvisibility}
718 @end table
720 @menu
721 * Overall Options::     Controlling the kind of output:
722                         an executable, object files, assembler files,
723                         or preprocessed source.
724 * C Dialect Options::   Controlling the variant of C language compiled.
725 * C++ Dialect Options:: Variations on C++.
726 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
727                         and Objective-C++.
728 * Language Independent Options:: Controlling how diagnostics should be
729                         formatted.
730 * Warning Options::     How picky should the compiler be?
731 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
732 * Optimize Options::    How much optimization?
733 * Preprocessor Options:: Controlling header files and macro definitions.
734                          Also, getting dependency information for Make.
735 * Assembler Options::   Passing options to the assembler.
736 * Link Options::        Specifying libraries and so on.
737 * Directory Options::   Where to find header files and libraries.
738                         Where to find the compiler executable files.
739 * Spec Files::          How to pass switches to sub-processes.
740 * Target Options::      Running a cross-compiler, or an old version of GCC.
741 @end menu
743 @node Overall Options
744 @section Options Controlling the Kind of Output
746 Compilation can involve up to four stages: preprocessing, compilation
747 proper, assembly and linking, always in that order.  GCC is capable of
748 preprocessing and compiling several files either into several
749 assembler input files, or into one assembler input file; then each
750 assembler input file produces an object file, and linking combines all
751 the object files (those newly compiled, and those specified as input)
752 into an executable file.
754 @cindex file name suffix
755 For any given input file, the file name suffix determines what kind of
756 compilation is done:
758 @table @gcctabopt
759 @item @var{file}.c
760 C source code which must be preprocessed.
762 @item @var{file}.i
763 C source code which should not be preprocessed.
765 @item @var{file}.ii
766 C++ source code which should not be preprocessed.
768 @item @var{file}.m
769 Objective-C source code.  Note that you must link with the @file{libobjc}
770 library to make an Objective-C program work.
772 @item @var{file}.mi
773 Objective-C source code which should not be preprocessed.
775 @item @var{file}.mm
776 @itemx @var{file}.M
777 Objective-C++ source code.  Note that you must link with the @file{libobjc}
778 library to make an Objective-C++ program work.  Note that @samp{.M} refers
779 to a literal capital M@.
781 @item @var{file}.mii
782 Objective-C++ source code which should not be preprocessed.
784 @item @var{file}.h
785 C, C++, Objective-C or Objective-C++ header file to be turned into a
786 precompiled header.
788 @item @var{file}.cc
789 @itemx @var{file}.cp
790 @itemx @var{file}.cxx
791 @itemx @var{file}.cpp
792 @itemx @var{file}.CPP
793 @itemx @var{file}.c++
794 @itemx @var{file}.C
795 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
796 the last two letters must both be literally @samp{x}.  Likewise,
797 @samp{.C} refers to a literal capital C@.
799 @item @var{file}.hh
800 @itemx @var{file}.H
801 C++ header file to be turned into a precompiled header.
803 @item @var{file}.f
804 @itemx @var{file}.for
805 @itemx @var{file}.FOR
806 Fortran source code which should not be preprocessed.
808 @item @var{file}.F
809 @itemx @var{file}.fpp
810 @itemx @var{file}.FPP
811 Fortran source code which must be preprocessed (with the traditional
812 preprocessor).
814 @item @var{file}.r
815 Fortran source code which must be preprocessed with a RATFOR
816 preprocessor (not included with GCC)@.
818 @item @var{file}.f90
819 @itemx @var{file}.f95
820 Fortran 90/95 source code which should not be preprocessed.
822 @c FIXME: Descriptions of Java file types.
823 @c @var{file}.java
824 @c @var{file}.class
825 @c @var{file}.zip
826 @c @var{file}.jar
828 @item @var{file}.ads
829 Ada source code file which contains a library unit declaration (a
830 declaration of a package, subprogram, or generic, or a generic
831 instantiation), or a library unit renaming declaration (a package,
832 generic, or subprogram renaming declaration).  Such files are also
833 called @dfn{specs}.
835 @itemx @var{file}.adb
836 Ada source code file containing a library unit body (a subprogram or
837 package body).  Such files are also called @dfn{bodies}.
839 @c GCC also knows about some suffixes for languages not yet included:
840 @c Pascal:
841 @c @var{file}.p
842 @c @var{file}.pas
844 @item @var{file}.s
845 Assembler code.
847 @item @var{file}.S
848 Assembler code which must be preprocessed.
850 @item @var{other}
851 An object file to be fed straight into linking.
852 Any file name with no recognized suffix is treated this way.
853 @end table
855 @opindex x
856 You can specify the input language explicitly with the @option{-x} option:
858 @table @gcctabopt
859 @item -x @var{language}
860 Specify explicitly the @var{language} for the following input files
861 (rather than letting the compiler choose a default based on the file
862 name suffix).  This option applies to all following input files until
863 the next @option{-x} option.  Possible values for @var{language} are:
864 @smallexample
865 c  c-header  c-cpp-output
866 c++  c++-header  c++-cpp-output
867 objective-c  objective-c-header  objective-c-cpp-output
868 objective-c++ objective-c++-header objective-c++-cpp-output
869 assembler  assembler-with-cpp
871 f77  f77-cpp-input  ratfor
873 java
874 treelang
875 @end smallexample
877 @item -x none
878 Turn off any specification of a language, so that subsequent files are
879 handled according to their file name suffixes (as they are if @option{-x}
880 has not been used at all).
882 @item -pass-exit-codes
883 @opindex pass-exit-codes
884 Normally the @command{gcc} program will exit with the code of 1 if any
885 phase of the compiler returns a non-success return code.  If you specify
886 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
887 numerically highest error produced by any phase that returned an error
888 indication.
889 @end table
891 If you only want some of the stages of compilation, you can use
892 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
893 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
894 @command{gcc} is to stop.  Note that some combinations (for example,
895 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
897 @table @gcctabopt
898 @item -c
899 @opindex c
900 Compile or assemble the source files, but do not link.  The linking
901 stage simply is not done.  The ultimate output is in the form of an
902 object file for each source file.
904 By default, the object file name for a source file is made by replacing
905 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
907 Unrecognized input files, not requiring compilation or assembly, are
908 ignored.
910 @item -S
911 @opindex S
912 Stop after the stage of compilation proper; do not assemble.  The output
913 is in the form of an assembler code file for each non-assembler input
914 file specified.
916 By default, the assembler file name for a source file is made by
917 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
919 Input files that don't require compilation are ignored.
921 @item -E
922 @opindex E
923 Stop after the preprocessing stage; do not run the compiler proper.  The
924 output is in the form of preprocessed source code, which is sent to the
925 standard output.
927 Input files which don't require preprocessing are ignored.
929 @cindex output file option
930 @item -o @var{file}
931 @opindex o
932 Place output in file @var{file}.  This applies regardless to whatever
933 sort of output is being produced, whether it be an executable file,
934 an object file, an assembler file or preprocessed C code.
936 If @option{-o} is not specified, the default is to put an executable
937 file in @file{a.out}, the object file for
938 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
939 assembler file in @file{@var{source}.s}, a precompiled header file in
940 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
941 standard output.
943 @item -v
944 @opindex v
945 Print (on standard error output) the commands executed to run the stages
946 of compilation.  Also print the version number of the compiler driver
947 program and of the preprocessor and the compiler proper.
949 @item -###
950 @opindex ###
951 Like @option{-v} except the commands are not executed and all command
952 arguments are quoted.  This is useful for shell scripts to capture the
953 driver-generated command lines.
955 @item -pipe
956 @opindex pipe
957 Use pipes rather than temporary files for communication between the
958 various stages of compilation.  This fails to work on some systems where
959 the assembler is unable to read from a pipe; but the GNU assembler has
960 no trouble.
962 @item -combine
963 @opindex combine
964 If you are compiling multiple source files, this option tells the driver
965 to pass all the source files to the compiler at once (for those
966 languages for which the compiler can handle this).  This will allow
967 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
968 language for which this is supported is C@.  If you pass source files for
969 multiple languages to the driver, using this option, the driver will invoke
970 the compiler(s) that support IMA once each, passing each compiler all the
971 source files appropriate for it.  For those languages that do not support
972 IMA this option will be ignored, and the compiler will be invoked once for
973 each source file in that language.  If you use this option in conjunction
974 with @option{-save-temps}, the compiler will generate multiple
975 pre-processed files
976 (one for each source file), but only one (combined) @file{.o} or
977 @file{.s} file.
979 @item --help
980 @opindex help
981 Print (on the standard output) a description of the command line options
982 understood by @command{gcc}.  If the @option{-v} option is also specified
983 then @option{--help} will also be passed on to the various processes
984 invoked by @command{gcc}, so that they can display the command line options
985 they accept.  If the @option{-Wextra} option is also specified then command
986 line options which have no documentation associated with them will also
987 be displayed.
989 @item --target-help
990 @opindex target-help
991 Print (on the standard output) a description of target specific command
992 line options for each tool.
994 @item --version
995 @opindex version
996 Display the version number and copyrights of the invoked GCC@.
997 @end table
999 @node Invoking G++
1000 @section Compiling C++ Programs
1002 @cindex suffixes for C++ source
1003 @cindex C++ source file suffixes
1004 C++ source files conventionally use one of the suffixes @samp{.C},
1005 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1006 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1007 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1008 files with these names and compiles them as C++ programs even if you
1009 call the compiler the same way as for compiling C programs (usually
1010 with the name @command{gcc}).
1012 @findex g++
1013 @findex c++
1014 However, C++ programs often require class libraries as well as a
1015 compiler that understands the C++ language---and under some
1016 circumstances, you might want to compile programs or header files from
1017 standard input, or otherwise without a suffix that flags them as C++
1018 programs.  You might also like to precompile a C header file with a
1019 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1020 program that calls GCC with the default language set to C++, and
1021 automatically specifies linking against the C++ library.  On many
1022 systems, @command{g++} is also installed with the name @command{c++}.
1024 @cindex invoking @command{g++}
1025 When you compile C++ programs, you may specify many of the same
1026 command-line options that you use for compiling programs in any
1027 language; or command-line options meaningful for C and related
1028 languages; or options that are meaningful only for C++ programs.
1029 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1030 explanations of options for languages related to C@.
1031 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1032 explanations of options that are meaningful only for C++ programs.
1034 @node C Dialect Options
1035 @section Options Controlling C Dialect
1036 @cindex dialect options
1037 @cindex language dialect options
1038 @cindex options, dialect
1040 The following options control the dialect of C (or languages derived
1041 from C, such as C++, Objective-C and Objective-C++) that the compiler
1042 accepts:
1044 @table @gcctabopt
1045 @cindex ANSI support
1046 @cindex ISO support
1047 @item -ansi
1048 @opindex ansi
1049 In C mode, support all ISO C90 programs.  In C++ mode,
1050 remove GNU extensions that conflict with ISO C++.
1052 This turns off certain features of GCC that are incompatible with ISO
1053 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1054 such as the @code{asm} and @code{typeof} keywords, and
1055 predefined macros such as @code{unix} and @code{vax} that identify the
1056 type of system you are using.  It also enables the undesirable and
1057 rarely used ISO trigraph feature.  For the C compiler,
1058 it disables recognition of C++ style @samp{//} comments as well as
1059 the @code{inline} keyword.
1061 The alternate keywords @code{__asm__}, @code{__extension__},
1062 @code{__inline__} and @code{__typeof__} continue to work despite
1063 @option{-ansi}.  You would not want to use them in an ISO C program, of
1064 course, but it is useful to put them in header files that might be included
1065 in compilations done with @option{-ansi}.  Alternate predefined macros
1066 such as @code{__unix__} and @code{__vax__} are also available, with or
1067 without @option{-ansi}.
1069 The @option{-ansi} option does not cause non-ISO programs to be
1070 rejected gratuitously.  For that, @option{-pedantic} is required in
1071 addition to @option{-ansi}.  @xref{Warning Options}.
1073 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1074 option is used.  Some header files may notice this macro and refrain
1075 from declaring certain functions or defining certain macros that the
1076 ISO standard doesn't call for; this is to avoid interfering with any
1077 programs that might use these names for other things.
1079 Functions which would normally be built in but do not have semantics
1080 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1081 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1082 built-in functions provided by GCC}, for details of the functions
1083 affected.
1085 @item -std=
1086 @opindex std
1087 Determine the language standard.  This option is currently only
1088 supported when compiling C or C++.  A value for this option must be
1089 provided; possible values are
1091 @table @samp
1092 @item c89
1093 @itemx iso9899:1990
1094 ISO C90 (same as @option{-ansi}).
1096 @item iso9899:199409
1097 ISO C90 as modified in amendment 1.
1099 @item c99
1100 @itemx c9x
1101 @itemx iso9899:1999
1102 @itemx iso9899:199x
1103 ISO C99.  Note that this standard is not yet fully supported; see
1104 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1105 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1107 @item gnu89
1108 Default, ISO C90 plus GNU extensions (including some C99 features).
1110 @item gnu99
1111 @itemx gnu9x
1112 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1113 this will become the default.  The name @samp{gnu9x} is deprecated.
1115 @item c++98
1116 The 1998 ISO C++ standard plus amendments.
1118 @item gnu++98
1119 The same as @option{-std=c++98} plus GNU extensions.  This is the
1120 default for C++ code.
1121 @end table
1123 Even when this option is not specified, you can still use some of the
1124 features of newer standards in so far as they do not conflict with
1125 previous C standards.  For example, you may use @code{__restrict__} even
1126 when @option{-std=c99} is not specified.
1128 The @option{-std} options specifying some version of ISO C have the same
1129 effects as @option{-ansi}, except that features that were not in ISO C90
1130 but are in the specified version (for example, @samp{//} comments and
1131 the @code{inline} keyword in ISO C99) are not disabled.
1133 @xref{Standards,,Language Standards Supported by GCC}, for details of
1134 these standard versions.
1136 @item -aux-info @var{filename}
1137 @opindex aux-info
1138 Output to the given filename prototyped declarations for all functions
1139 declared and/or defined in a translation unit, including those in header
1140 files.  This option is silently ignored in any language other than C@.
1142 Besides declarations, the file indicates, in comments, the origin of
1143 each declaration (source file and line), whether the declaration was
1144 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1145 @samp{O} for old, respectively, in the first character after the line
1146 number and the colon), and whether it came from a declaration or a
1147 definition (@samp{C} or @samp{F}, respectively, in the following
1148 character).  In the case of function definitions, a K&R-style list of
1149 arguments followed by their declarations is also provided, inside
1150 comments, after the declaration.
1152 @item -fno-asm
1153 @opindex fno-asm
1154 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1155 keyword, so that code can use these words as identifiers.  You can use
1156 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1157 instead.  @option{-ansi} implies @option{-fno-asm}.
1159 In C++, this switch only affects the @code{typeof} keyword, since
1160 @code{asm} and @code{inline} are standard keywords.  You may want to
1161 use the @option{-fno-gnu-keywords} flag instead, which has the same
1162 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1163 switch only affects the @code{asm} and @code{typeof} keywords, since
1164 @code{inline} is a standard keyword in ISO C99.
1166 @item -fno-builtin
1167 @itemx -fno-builtin-@var{function}
1168 @opindex fno-builtin
1169 @cindex built-in functions
1170 Don't recognize built-in functions that do not begin with
1171 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1172 functions provided by GCC}, for details of the functions affected,
1173 including those which are not built-in functions when @option{-ansi} or
1174 @option{-std} options for strict ISO C conformance are used because they
1175 do not have an ISO standard meaning.
1177 GCC normally generates special code to handle certain built-in functions
1178 more efficiently; for instance, calls to @code{alloca} may become single
1179 instructions that adjust the stack directly, and calls to @code{memcpy}
1180 may become inline copy loops.  The resulting code is often both smaller
1181 and faster, but since the function calls no longer appear as such, you
1182 cannot set a breakpoint on those calls, nor can you change the behavior
1183 of the functions by linking with a different library.  In addition,
1184 when a function is recognized as a built-in function, GCC may use
1185 information about that function to warn about problems with calls to
1186 that function, or to generate more efficient code, even if the
1187 resulting code still contains calls to that function.  For example,
1188 warnings are given with @option{-Wformat} for bad calls to
1189 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1190 known not to modify global memory.
1192 With the @option{-fno-builtin-@var{function}} option
1193 only the built-in function @var{function} is
1194 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1195 function is named this is not built-in in this version of GCC, this
1196 option is ignored.  There is no corresponding
1197 @option{-fbuiltin-@var{function}} option; if you wish to enable
1198 built-in functions selectively when using @option{-fno-builtin} or
1199 @option{-ffreestanding}, you may define macros such as:
1201 @smallexample
1202 #define abs(n)          __builtin_abs ((n))
1203 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1204 @end smallexample
1206 @item -fhosted
1207 @opindex fhosted
1208 @cindex hosted environment
1210 Assert that compilation takes place in a hosted environment.  This implies
1211 @option{-fbuiltin}.  A hosted environment is one in which the
1212 entire standard library is available, and in which @code{main} has a return
1213 type of @code{int}.  Examples are nearly everything except a kernel.
1214 This is equivalent to @option{-fno-freestanding}.
1216 @item -ffreestanding
1217 @opindex ffreestanding
1218 @cindex hosted environment
1220 Assert that compilation takes place in a freestanding environment.  This
1221 implies @option{-fno-builtin}.  A freestanding environment
1222 is one in which the standard library may not exist, and program startup may
1223 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1224 This is equivalent to @option{-fno-hosted}.
1226 @xref{Standards,,Language Standards Supported by GCC}, for details of
1227 freestanding and hosted environments.
1229 @item -fms-extensions
1230 @opindex fms-extensions
1231 Accept some non-standard constructs used in Microsoft header files.
1233 Some cases of unnamed fields in structures and unions are only
1234 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1235 fields within structs/unions}, for details.
1237 @item -trigraphs
1238 @opindex trigraphs
1239 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1240 options for strict ISO C conformance) implies @option{-trigraphs}.
1242 @item -no-integrated-cpp
1243 @opindex no-integrated-cpp
1244 Performs a compilation in two passes: preprocessing and compiling.  This
1245 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1246 @option{-B} option.  The user supplied compilation step can then add in
1247 an additional preprocessing step after normal preprocessing but before
1248 compiling.  The default is to use the integrated cpp (internal cpp)
1250 The semantics of this option will change if "cc1", "cc1plus", and
1251 "cc1obj" are merged.
1253 @cindex traditional C language
1254 @cindex C language, traditional
1255 @item -traditional
1256 @itemx -traditional-cpp
1257 @opindex traditional-cpp
1258 @opindex traditional
1259 Formerly, these options caused GCC to attempt to emulate a pre-standard
1260 C compiler.  They are now only supported with the @option{-E} switch.
1261 The preprocessor continues to support a pre-standard mode.  See the GNU
1262 CPP manual for details.
1264 @item -fcond-mismatch
1265 @opindex fcond-mismatch
1266 Allow conditional expressions with mismatched types in the second and
1267 third arguments.  The value of such an expression is void.  This option
1268 is not supported for C++.
1270 @item -funsigned-char
1271 @opindex funsigned-char
1272 Let the type @code{char} be unsigned, like @code{unsigned char}.
1274 Each kind of machine has a default for what @code{char} should
1275 be.  It is either like @code{unsigned char} by default or like
1276 @code{signed char} by default.
1278 Ideally, a portable program should always use @code{signed char} or
1279 @code{unsigned char} when it depends on the signedness of an object.
1280 But many programs have been written to use plain @code{char} and
1281 expect it to be signed, or expect it to be unsigned, depending on the
1282 machines they were written for.  This option, and its inverse, let you
1283 make such a program work with the opposite default.
1285 The type @code{char} is always a distinct type from each of
1286 @code{signed char} or @code{unsigned char}, even though its behavior
1287 is always just like one of those two.
1289 @item -fsigned-char
1290 @opindex fsigned-char
1291 Let the type @code{char} be signed, like @code{signed char}.
1293 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1294 the negative form of @option{-funsigned-char}.  Likewise, the option
1295 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1297 @item -fsigned-bitfields
1298 @itemx -funsigned-bitfields
1299 @itemx -fno-signed-bitfields
1300 @itemx -fno-unsigned-bitfields
1301 @opindex fsigned-bitfields
1302 @opindex funsigned-bitfields
1303 @opindex fno-signed-bitfields
1304 @opindex fno-unsigned-bitfields
1305 These options control whether a bit-field is signed or unsigned, when the
1306 declaration does not use either @code{signed} or @code{unsigned}.  By
1307 default, such a bit-field is signed, because this is consistent: the
1308 basic integer types such as @code{int} are signed types.
1309 @end table
1311 @node C++ Dialect Options
1312 @section Options Controlling C++ Dialect
1314 @cindex compiler options, C++
1315 @cindex C++ options, command line
1316 @cindex options, C++
1317 This section describes the command-line options that are only meaningful
1318 for C++ programs; but you can also use most of the GNU compiler options
1319 regardless of what language your program is in.  For example, you
1320 might compile a file @code{firstClass.C} like this:
1322 @smallexample
1323 g++ -g -frepo -O -c firstClass.C
1324 @end smallexample
1326 @noindent
1327 In this example, only @option{-frepo} is an option meant
1328 only for C++ programs; you can use the other options with any
1329 language supported by GCC@.
1331 Here is a list of options that are @emph{only} for compiling C++ programs:
1333 @table @gcctabopt
1335 @item -fabi-version=@var{n}
1336 @opindex fabi-version
1337 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1338 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1339 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1340 the version that conforms most closely to the C++ ABI specification.
1341 Therefore, the ABI obtained using version 0 will change as ABI bugs
1342 are fixed.
1344 The default is version 2.
1346 @item -fno-access-control
1347 @opindex fno-access-control
1348 Turn off all access checking.  This switch is mainly useful for working
1349 around bugs in the access control code.
1351 @item -fcheck-new
1352 @opindex fcheck-new
1353 Check that the pointer returned by @code{operator new} is non-null
1354 before attempting to modify the storage allocated.  This check is
1355 normally unnecessary because the C++ standard specifies that
1356 @code{operator new} will only return @code{0} if it is declared
1357 @samp{throw()}, in which case the compiler will always check the
1358 return value even without this option.  In all other cases, when
1359 @code{operator new} has a non-empty exception specification, memory
1360 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1361 @samp{new (nothrow)}.
1363 @item -fconserve-space
1364 @opindex fconserve-space
1365 Put uninitialized or runtime-initialized global variables into the
1366 common segment, as C does.  This saves space in the executable at the
1367 cost of not diagnosing duplicate definitions.  If you compile with this
1368 flag and your program mysteriously crashes after @code{main()} has
1369 completed, you may have an object that is being destroyed twice because
1370 two definitions were merged.
1372 This option is no longer useful on most targets, now that support has
1373 been added for putting variables into BSS without making them common.
1375 @item -fno-const-strings
1376 @opindex fno-const-strings
1377 Give string constants type @code{char *} instead of type @code{const
1378 char *}.  By default, G++ uses type @code{const char *} as required by
1379 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1380 actually modify the value of a string constant.
1382 This option might be removed in a future release of G++.  For maximum
1383 portability, you should structure your code so that it works with
1384 string constants that have type @code{const char *}.
1386 @item -fno-elide-constructors
1387 @opindex fno-elide-constructors
1388 The C++ standard allows an implementation to omit creating a temporary
1389 which is only used to initialize another object of the same type.
1390 Specifying this option disables that optimization, and forces G++ to
1391 call the copy constructor in all cases.
1393 @item -fno-enforce-eh-specs
1394 @opindex fno-enforce-eh-specs
1395 Don't check for violation of exception specifications at runtime.  This
1396 option violates the C++ standard, but may be useful for reducing code
1397 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1398 will still optimize based on the exception specifications.
1400 @item -ffor-scope
1401 @itemx -fno-for-scope
1402 @opindex ffor-scope
1403 @opindex fno-for-scope
1404 If @option{-ffor-scope} is specified, the scope of variables declared in
1405 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1406 as specified by the C++ standard.
1407 If @option{-fno-for-scope} is specified, the scope of variables declared in
1408 a @i{for-init-statement} extends to the end of the enclosing scope,
1409 as was the case in old versions of G++, and other (traditional)
1410 implementations of C++.
1412 The default if neither flag is given to follow the standard,
1413 but to allow and give a warning for old-style code that would
1414 otherwise be invalid, or have different behavior.
1416 @item -fno-gnu-keywords
1417 @opindex fno-gnu-keywords
1418 Do not recognize @code{typeof} as a keyword, so that code can use this
1419 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1420 @option{-ansi} implies @option{-fno-gnu-keywords}.
1422 @item -fno-implicit-templates
1423 @opindex fno-implicit-templates
1424 Never emit code for non-inline templates which are instantiated
1425 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1426 @xref{Template Instantiation}, for more information.
1428 @item -fno-implicit-inline-templates
1429 @opindex fno-implicit-inline-templates
1430 Don't emit code for implicit instantiations of inline templates, either.
1431 The default is to handle inlines differently so that compiles with and
1432 without optimization will need the same set of explicit instantiations.
1434 @item -fno-implement-inlines
1435 @opindex fno-implement-inlines
1436 To save space, do not emit out-of-line copies of inline functions
1437 controlled by @samp{#pragma implementation}.  This will cause linker
1438 errors if these functions are not inlined everywhere they are called.
1440 @item -fms-extensions
1441 @opindex fms-extensions
1442 Disable pedantic warnings about constructs used in MFC, such as implicit
1443 int and getting a pointer to member function via non-standard syntax.
1445 @item -fno-nonansi-builtins
1446 @opindex fno-nonansi-builtins
1447 Disable built-in declarations of functions that are not mandated by
1448 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1449 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1451 @item -fno-operator-names
1452 @opindex fno-operator-names
1453 Do not treat the operator name keywords @code{and}, @code{bitand},
1454 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1455 synonyms as keywords.
1457 @item -fno-optional-diags
1458 @opindex fno-optional-diags
1459 Disable diagnostics that the standard says a compiler does not need to
1460 issue.  Currently, the only such diagnostic issued by G++ is the one for
1461 a name having multiple meanings within a class.
1463 @item -fpermissive
1464 @opindex fpermissive
1465 Downgrade some diagnostics about nonconformant code from errors to
1466 warnings.  Thus, using @option{-fpermissive} will allow some
1467 nonconforming code to compile.
1469 @item -frepo
1470 @opindex frepo
1471 Enable automatic template instantiation at link time.  This option also
1472 implies @option{-fno-implicit-templates}.  @xref{Template
1473 Instantiation}, for more information.
1475 @item -fno-rtti
1476 @opindex fno-rtti
1477 Disable generation of information about every class with virtual
1478 functions for use by the C++ runtime type identification features
1479 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1480 of the language, you can save some space by using this flag.  Note that
1481 exception handling uses the same information, but it will generate it as
1482 needed.
1484 @item -fstats
1485 @opindex fstats
1486 Emit statistics about front-end processing at the end of the compilation.
1487 This information is generally only useful to the G++ development team.
1489 @item -ftemplate-depth-@var{n}
1490 @opindex ftemplate-depth
1491 Set the maximum instantiation depth for template classes to @var{n}.
1492 A limit on the template instantiation depth is needed to detect
1493 endless recursions during template class instantiation.  ANSI/ISO C++
1494 conforming programs must not rely on a maximum depth greater than 17.
1496 @item -fno-threadsafe-statics
1497 @opindex fno-threadsafe-statics
1498 Do not emit the extra code to use the routines specified in the C++
1499 ABI for thread-safe initialization of local statics.  You can use this
1500 option to reduce code size slightly in code that doesn't need to be
1501 thread-safe.
1503 @item -fuse-cxa-atexit
1504 @opindex fuse-cxa-atexit
1505 Register destructors for objects with static storage duration with the
1506 @code{__cxa_atexit} function rather than the @code{atexit} function.
1507 This option is required for fully standards-compliant handling of static
1508 destructors, but will only work if your C library supports
1509 @code{__cxa_atexit}.
1511 @item -fvisibility-inlines-hidden
1512 @opindex fvisibility-inlines-hidden
1513 Causes all inlined methods to be marked with
1514 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1515 appear in the export table of a DSO and do not require a PLT indirection
1516 when used within the DSO@.  Enabling this option can have a dramatic effect
1517 on load and link times of a DSO as it massively reduces the size of the
1518 dynamic export table when the library makes heavy use of templates.  While
1519 it can cause bloating through duplication of code within each DSO where
1520 it is used, often the wastage is less than the considerable space occupied
1521 by a long symbol name in the export table which is typical when using
1522 templates and namespaces.  For even more savings, combine with the
1523 @option{-fvisibility=hidden} switch.
1525 @item -fno-weak
1526 @opindex fno-weak
1527 Do not use weak symbol support, even if it is provided by the linker.
1528 By default, G++ will use weak symbols if they are available.  This
1529 option exists only for testing, and should not be used by end-users;
1530 it will result in inferior code and has no benefits.  This option may
1531 be removed in a future release of G++.
1533 @item -nostdinc++
1534 @opindex nostdinc++
1535 Do not search for header files in the standard directories specific to
1536 C++, but do still search the other standard directories.  (This option
1537 is used when building the C++ library.)
1538 @end table
1540 In addition, these optimization, warning, and code generation options
1541 have meanings only for C++ programs:
1543 @table @gcctabopt
1544 @item -fno-default-inline
1545 @opindex fno-default-inline
1546 Do not assume @samp{inline} for functions defined inside a class scope.
1547 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1548 functions will have linkage like inline functions; they just won't be
1549 inlined by default.
1551 @item -Wabi @r{(C++ only)}
1552 @opindex Wabi
1553 Warn when G++ generates code that is probably not compatible with the
1554 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1555 all such cases, there are probably some cases that are not warned about,
1556 even though G++ is generating incompatible code.  There may also be
1557 cases where warnings are emitted even though the code that is generated
1558 will be compatible.
1560 You should rewrite your code to avoid these warnings if you are
1561 concerned about the fact that code generated by G++ may not be binary
1562 compatible with code generated by other compilers.
1564 The known incompatibilities at this point include:
1566 @itemize @bullet
1568 @item
1569 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1570 pack data into the same byte as a base class.  For example:
1572 @smallexample
1573 struct A @{ virtual void f(); int f1 : 1; @};
1574 struct B : public A @{ int f2 : 1; @};
1575 @end smallexample
1577 @noindent
1578 In this case, G++ will place @code{B::f2} into the same byte
1579 as@code{A::f1}; other compilers will not.  You can avoid this problem
1580 by explicitly padding @code{A} so that its size is a multiple of the
1581 byte size on your platform; that will cause G++ and other compilers to
1582 layout @code{B} identically.
1584 @item
1585 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1586 tail padding when laying out virtual bases.  For example:
1588 @smallexample
1589 struct A @{ virtual void f(); char c1; @};
1590 struct B @{ B(); char c2; @};
1591 struct C : public A, public virtual B @{@};
1592 @end smallexample
1594 @noindent
1595 In this case, G++ will not place @code{B} into the tail-padding for
1596 @code{A}; other compilers will.  You can avoid this problem by
1597 explicitly padding @code{A} so that its size is a multiple of its
1598 alignment (ignoring virtual base classes); that will cause G++ and other
1599 compilers to layout @code{C} identically.
1601 @item
1602 Incorrect handling of bit-fields with declared widths greater than that
1603 of their underlying types, when the bit-fields appear in a union.  For
1604 example:
1606 @smallexample
1607 union U @{ int i : 4096; @};
1608 @end smallexample
1610 @noindent
1611 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1612 union too small by the number of bits in an @code{int}.
1614 @item
1615 Empty classes can be placed at incorrect offsets.  For example:
1617 @smallexample
1618 struct A @{@};
1620 struct B @{
1621   A a;
1622   virtual void f ();
1625 struct C : public B, public A @{@};
1626 @end smallexample
1628 @noindent
1629 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1630 it should be placed at offset zero.  G++ mistakenly believes that the
1631 @code{A} data member of @code{B} is already at offset zero.
1633 @item
1634 Names of template functions whose types involve @code{typename} or
1635 template template parameters can be mangled incorrectly.
1637 @smallexample
1638 template <typename Q>
1639 void f(typename Q::X) @{@}
1641 template <template <typename> class Q>
1642 void f(typename Q<int>::X) @{@}
1643 @end smallexample
1645 @noindent
1646 Instantiations of these templates may be mangled incorrectly.
1648 @end itemize
1650 @item -Wctor-dtor-privacy @r{(C++ only)}
1651 @opindex Wctor-dtor-privacy
1652 Warn when a class seems unusable because all the constructors or
1653 destructors in that class are private, and it has neither friends nor
1654 public static member functions.
1656 @item -Wnon-virtual-dtor @r{(C++ only)}
1657 @opindex Wnon-virtual-dtor
1658 Warn when a class appears to be polymorphic, thereby requiring a virtual
1659 destructor, yet it declares a non-virtual one.
1660 This warning is enabled by @option{-Wall}.
1662 @item -Wreorder @r{(C++ only)}
1663 @opindex Wreorder
1664 @cindex reordering, warning
1665 @cindex warning for reordering of member initializers
1666 Warn when the order of member initializers given in the code does not
1667 match the order in which they must be executed.  For instance:
1669 @smallexample
1670 struct A @{
1671   int i;
1672   int j;
1673   A(): j (0), i (1) @{ @}
1675 @end smallexample
1677 The compiler will rearrange the member initializers for @samp{i}
1678 and @samp{j} to match the declaration order of the members, emitting
1679 a warning to that effect.  This warning is enabled by @option{-Wall}.
1680 @end table
1682 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1684 @table @gcctabopt
1685 @item -Weffc++ @r{(C++ only)}
1686 @opindex Weffc++
1687 Warn about violations of the following style guidelines from Scott Meyers'
1688 @cite{Effective C++} book:
1690 @itemize @bullet
1691 @item
1692 Item 11:  Define a copy constructor and an assignment operator for classes
1693 with dynamically allocated memory.
1695 @item
1696 Item 12:  Prefer initialization to assignment in constructors.
1698 @item
1699 Item 14:  Make destructors virtual in base classes.
1701 @item
1702 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1704 @item
1705 Item 23:  Don't try to return a reference when you must return an object.
1707 @end itemize
1709 Also warn about violations of the following style guidelines from
1710 Scott Meyers' @cite{More Effective C++} book:
1712 @itemize @bullet
1713 @item
1714 Item 6:  Distinguish between prefix and postfix forms of increment and
1715 decrement operators.
1717 @item
1718 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1720 @end itemize
1722 When selecting this option, be aware that the standard library
1723 headers do not obey all of these guidelines; use @samp{grep -v}
1724 to filter out those warnings.
1726 @item -Wno-deprecated @r{(C++ only)}
1727 @opindex Wno-deprecated
1728 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1730 @item -Wno-non-template-friend @r{(C++ only)}
1731 @opindex Wno-non-template-friend
1732 Disable warnings when non-templatized friend functions are declared
1733 within a template.  Since the advent of explicit template specification
1734 support in G++, if the name of the friend is an unqualified-id (i.e.,
1735 @samp{friend foo(int)}), the C++ language specification demands that the
1736 friend declare or define an ordinary, nontemplate function.  (Section
1737 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1738 could be interpreted as a particular specialization of a templatized
1739 function.  Because this non-conforming behavior is no longer the default
1740 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1741 check existing code for potential trouble spots and is on by default.
1742 This new compiler behavior can be turned off with
1743 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1744 but disables the helpful warning.
1746 @item -Wold-style-cast @r{(C++ only)}
1747 @opindex Wold-style-cast
1748 Warn if an old-style (C-style) cast to a non-void type is used within
1749 a C++ program.  The new-style casts (@samp{static_cast},
1750 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1751 unintended effects and much easier to search for.
1753 @item -Woverloaded-virtual @r{(C++ only)}
1754 @opindex Woverloaded-virtual
1755 @cindex overloaded virtual fn, warning
1756 @cindex warning for overloaded virtual fn
1757 Warn when a function declaration hides virtual functions from a
1758 base class.  For example, in:
1760 @smallexample
1761 struct A @{
1762   virtual void f();
1765 struct B: public A @{
1766   void f(int);
1768 @end smallexample
1770 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1771 like:
1773 @smallexample
1774 B* b;
1775 b->f();
1776 @end smallexample
1778 will fail to compile.
1780 @item -Wno-pmf-conversions @r{(C++ only)}
1781 @opindex Wno-pmf-conversions
1782 Disable the diagnostic for converting a bound pointer to member function
1783 to a plain pointer.
1785 @item -Wsign-promo @r{(C++ only)}
1786 @opindex Wsign-promo
1787 Warn when overload resolution chooses a promotion from unsigned or
1788 enumerated type to a signed type, over a conversion to an unsigned type of
1789 the same size.  Previous versions of G++ would try to preserve
1790 unsignedness, but the standard mandates the current behavior.
1792 @item -Wsynth @r{(C++ only)}
1793 @opindex Wsynth
1794 @cindex warning for synthesized methods
1795 @cindex synthesized methods, warning
1796 Warn when G++'s synthesis behavior does not match that of cfront.  For
1797 instance:
1799 @smallexample
1800 struct A @{
1801   operator int ();
1802   A& operator = (int);
1805 main ()
1807   A a,b;
1808   a = b;
1810 @end smallexample
1812 In this example, G++ will synthesize a default @samp{A& operator =
1813 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1814 @end table
1816 @node Objective-C and Objective-C++ Dialect Options
1817 @section Options Controlling Objective-C and Objective-C++ Dialects
1819 @cindex compiler options, Objective-C and Objective-C++
1820 @cindex Objective-C and Objective-C++ options, command line
1821 @cindex options, Objective-C and Objective-C++
1822 (NOTE: This manual does not describe the Objective-C and Objective-C++
1823 languages themselves.  See @xref{Standards,,Language Standards
1824 Supported by GCC}, for references.)
1826 This section describes the command-line options that are only meaningful
1827 for Objective-C and Objective-C++ programs, but you can also use most of
1828 the language-independent GNU compiler options.
1829 For example, you might compile a file @code{some_class.m} like this:
1831 @smallexample
1832 gcc -g -fgnu-runtime -O -c some_class.m
1833 @end smallexample
1835 @noindent
1836 In this example, @option{-fgnu-runtime} is an option meant only for
1837 Objective-C and Objective-C++ programs; you can use the other options with
1838 any language supported by GCC@.
1840 Note that since Objective-C is an extension of the C language, Objective-C
1841 compilations may also use options specific to the C front-end (e.g.,
1842 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1843 C++-specific options (e.g., @option{-Wabi}).
1845 Here is a list of options that are @emph{only} for compiling Objective-C
1846 and Objective-C++ programs:
1848 @table @gcctabopt
1849 @item -fconstant-string-class=@var{class-name}
1850 @opindex fconstant-string-class
1851 Use @var{class-name} as the name of the class to instantiate for each
1852 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1853 class name is @code{NXConstantString} if the GNU runtime is being used, and
1854 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1855 @option{-fconstant-cfstrings} option, if also present, will override the
1856 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1857 to be laid out as constant CoreFoundation strings.
1859 @item -fgnu-runtime
1860 @opindex fgnu-runtime
1861 Generate object code compatible with the standard GNU Objective-C
1862 runtime.  This is the default for most types of systems.
1864 @item -fnext-runtime
1865 @opindex fnext-runtime
1866 Generate output compatible with the NeXT runtime.  This is the default
1867 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1868 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1869 used.
1871 @item -fno-nil-receivers
1872 @opindex fno-nil-receivers
1873 Assume that all Objective-C message dispatches (e.g.,
1874 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1875 is not @code{nil}.  This allows for more efficient entry points in the runtime
1876 to be used.  Currently, this option is only available in conjunction with
1877 the NeXT runtime on Mac OS X 10.3 and later.
1879 @item -fobjc-exceptions
1880 @opindex fobjc-exceptions
1881 Enable syntactic support for structured exception handling in Objective-C,
1882 similar to what is offered by C++ and Java.  Currently, this option is only
1883 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1885 @smallexample
1886   @@try @{
1887     @dots{}
1888        @@throw expr;
1889     @dots{}
1890   @}
1891   @@catch (AnObjCClass *exc) @{
1892     @dots{}
1893       @@throw expr;
1894     @dots{}
1895       @@throw;
1896     @dots{}
1897   @}
1898   @@catch (AnotherClass *exc) @{
1899     @dots{}
1900   @}
1901   @@catch (id allOthers) @{
1902     @dots{}
1903   @}
1904   @@finally @{
1905     @dots{}
1906       @@throw expr;
1907     @dots{}
1908   @}
1909 @end smallexample
1911 The @code{@@throw} statement may appear anywhere in an Objective-C or
1912 Objective-C++ program; when used inside of a @code{@@catch} block, the
1913 @code{@@throw} may appear without an argument (as shown above), in which case
1914 the object caught by the @code{@@catch} will be rethrown.
1916 Note that only (pointers to) Objective-C objects may be thrown and
1917 caught using this scheme.  When an object is thrown, it will be caught
1918 by the nearest @code{@@catch} clause capable of handling objects of that type,
1919 analogously to how @code{catch} blocks work in C++ and Java.  A
1920 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1921 any and all Objective-C exceptions not caught by previous @code{@@catch}
1922 clauses (if any).
1924 The @code{@@finally} clause, if present, will be executed upon exit from the
1925 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1926 regardless of whether any exceptions are thrown, caught or rethrown
1927 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1928 of the @code{finally} clause in Java.
1930 There are several caveats to using the new exception mechanism:
1932 @itemize @bullet
1933 @item
1934 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1935 idioms provided by the @code{NSException} class, the new
1936 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1937 systems, due to additional functionality needed in the (NeXT) Objective-C
1938 runtime.
1940 @item
1941 As mentioned above, the new exceptions do not support handling
1942 types other than Objective-C objects.   Furthermore, when used from
1943 Objective-C++, the Objective-C exception model does not interoperate with C++
1944 exceptions at this time.  This means you cannot @code{@@throw} an exception
1945 from Objective-C and @code{catch} it in C++, or vice versa
1946 (i.e., @code{throw @dots{} @@catch}).
1947 @end itemize
1949 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1950 blocks for thread-safe execution:
1952 @smallexample
1953   @@synchronized (ObjCClass *guard) @{
1954     @dots{}
1955   @}
1956 @end smallexample
1958 Upon entering the @code{@@synchronized} block, a thread of execution shall
1959 first check whether a lock has been placed on the corresponding @code{guard}
1960 object by another thread.  If it has, the current thread shall wait until
1961 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1962 the current thread will place its own lock on it, execute the code contained in
1963 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1964 making @code{guard} available to other threads).
1966 Unlike Java, Objective-C does not allow for entire methods to be marked
1967 @code{@@synchronized}.  Note that throwing exceptions out of
1968 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1969 to be unlocked properly.
1971 @item -freplace-objc-classes
1972 @opindex freplace-objc-classes
1973 Emit a special marker instructing @command{ld(1)} not to statically link in
1974 the resulting object file, and allow @command{dyld(1)} to load it in at
1975 run time instead.  This is used in conjunction with the Fix-and-Continue
1976 debugging mode, where the object file in question may be recompiled and
1977 dynamically reloaded in the course of program execution, without the need
1978 to restart the program itself.  Currently, Fix-and-Continue functionality
1979 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1980 and later.
1982 @item -fzero-link
1983 @opindex fzero-link
1984 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1985 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1986 compile time) with static class references that get initialized at load time,
1987 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1988 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1989 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1990 for individual class implementations to be modified during program execution.
1992 @item -gen-decls
1993 @opindex gen-decls
1994 Dump interface declarations for all classes seen in the source file to a
1995 file named @file{@var{sourcename}.decl}.
1997 @item -Wno-protocol
1998 @opindex Wno-protocol
1999 If a class is declared to implement a protocol, a warning is issued for
2000 every method in the protocol that is not implemented by the class.  The
2001 default behavior is to issue a warning for every method not explicitly
2002 implemented in the class, even if a method implementation is inherited
2003 from the superclass.  If you use the @option{-Wno-protocol} option, then
2004 methods inherited from the superclass are considered to be implemented,
2005 and no warning is issued for them.
2007 @item -Wselector
2008 @opindex Wselector
2009 Warn if multiple methods of different types for the same selector are
2010 found during compilation.  The check is performed on the list of methods
2011 in the final stage of compilation.  Additionally, a check is performed
2012 for each selector appearing in a @code{@@selector(@dots{})}
2013 expression, and a corresponding method for that selector has been found
2014 during compilation.  Because these checks scan the method table only at
2015 the end of compilation, these warnings are not produced if the final
2016 stage of compilation is not reached, for example because an error is
2017 found during compilation, or because the @option{-fsyntax-only} option is
2018 being used.
2020 @item -Wundeclared-selector
2021 @opindex Wundeclared-selector
2022 Warn if a @code{@@selector(@dots{})} expression referring to an
2023 undeclared selector is found.  A selector is considered undeclared if no
2024 method with that name has been declared before the
2025 @code{@@selector(@dots{})} expression, either explicitly in an
2026 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2027 an @code{@@implementation} section.  This option always performs its
2028 checks as soon as a @code{@@selector(@dots{})} expression is found,
2029 while @option{-Wselector} only performs its checks in the final stage of
2030 compilation.  This also enforces the coding style convention
2031 that methods and selectors must be declared before being used.
2033 @item -print-objc-runtime-info
2034 @opindex print-objc-runtime-info
2035 Generate C header describing the largest structure that is passed by
2036 value, if any.
2038 @end table
2040 @node Language Independent Options
2041 @section Options to Control Diagnostic Messages Formatting
2042 @cindex options to control diagnostics formatting
2043 @cindex diagnostic messages
2044 @cindex message formatting
2046 Traditionally, diagnostic messages have been formatted irrespective of
2047 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2048 below can be used to control the diagnostic messages formatting
2049 algorithm, e.g.@: how many characters per line, how often source location
2050 information should be reported.  Right now, only the C++ front end can
2051 honor these options.  However it is expected, in the near future, that
2052 the remaining front ends would be able to digest them correctly.
2054 @table @gcctabopt
2055 @item -fmessage-length=@var{n}
2056 @opindex fmessage-length
2057 Try to format error messages so that they fit on lines of about @var{n}
2058 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2059 the front ends supported by GCC@.  If @var{n} is zero, then no
2060 line-wrapping will be done; each error message will appear on a single
2061 line.
2063 @opindex fdiagnostics-show-location
2064 @item -fdiagnostics-show-location=once
2065 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2066 reporter to emit @emph{once} source location information; that is, in
2067 case the message is too long to fit on a single physical line and has to
2068 be wrapped, the source location won't be emitted (as prefix) again,
2069 over and over, in subsequent continuation lines.  This is the default
2070 behavior.
2072 @item -fdiagnostics-show-location=every-line
2073 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2074 messages reporter to emit the same source location information (as
2075 prefix) for physical lines that result from the process of breaking
2076 a message which is too long to fit on a single line.
2078 @end table
2080 @node Warning Options
2081 @section Options to Request or Suppress Warnings
2082 @cindex options to control warnings
2083 @cindex warning messages
2084 @cindex messages, warning
2085 @cindex suppressing warnings
2087 Warnings are diagnostic messages that report constructions which
2088 are not inherently erroneous but which are risky or suggest there
2089 may have been an error.
2091 You can request many specific warnings with options beginning @samp{-W},
2092 for example @option{-Wimplicit} to request warnings on implicit
2093 declarations.  Each of these specific warning options also has a
2094 negative form beginning @samp{-Wno-} to turn off warnings;
2095 for example, @option{-Wno-implicit}.  This manual lists only one of the
2096 two forms, whichever is not the default.
2098 The following options control the amount and kinds of warnings produced
2099 by GCC; for further, language-specific options also refer to
2100 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2101 Options}.
2103 @table @gcctabopt
2104 @cindex syntax checking
2105 @item -fsyntax-only
2106 @opindex fsyntax-only
2107 Check the code for syntax errors, but don't do anything beyond that.
2109 @item -pedantic
2110 @opindex pedantic
2111 Issue all the warnings demanded by strict ISO C and ISO C++;
2112 reject all programs that use forbidden extensions, and some other
2113 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2114 version of the ISO C standard specified by any @option{-std} option used.
2116 Valid ISO C and ISO C++ programs should compile properly with or without
2117 this option (though a rare few will require @option{-ansi} or a
2118 @option{-std} option specifying the required version of ISO C)@.  However,
2119 without this option, certain GNU extensions and traditional C and C++
2120 features are supported as well.  With this option, they are rejected.
2122 @option{-pedantic} does not cause warning messages for use of the
2123 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2124 warnings are also disabled in the expression that follows
2125 @code{__extension__}.  However, only system header files should use
2126 these escape routes; application programs should avoid them.
2127 @xref{Alternate Keywords}.
2129 Some users try to use @option{-pedantic} to check programs for strict ISO
2130 C conformance.  They soon find that it does not do quite what they want:
2131 it finds some non-ISO practices, but not all---only those for which
2132 ISO C @emph{requires} a diagnostic, and some others for which
2133 diagnostics have been added.
2135 A feature to report any failure to conform to ISO C might be useful in
2136 some instances, but would require considerable additional work and would
2137 be quite different from @option{-pedantic}.  We don't have plans to
2138 support such a feature in the near future.
2140 Where the standard specified with @option{-std} represents a GNU
2141 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2142 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2143 extended dialect is based.  Warnings from @option{-pedantic} are given
2144 where they are required by the base standard.  (It would not make sense
2145 for such warnings to be given only for features not in the specified GNU
2146 C dialect, since by definition the GNU dialects of C include all
2147 features the compiler supports with the given option, and there would be
2148 nothing to warn about.)
2150 @item -pedantic-errors
2151 @opindex pedantic-errors
2152 Like @option{-pedantic}, except that errors are produced rather than
2153 warnings.
2155 @item -w
2156 @opindex w
2157 Inhibit all warning messages.
2159 @item -Wno-import
2160 @opindex Wno-import
2161 Inhibit warning messages about the use of @samp{#import}.
2163 @item -Wchar-subscripts
2164 @opindex Wchar-subscripts
2165 Warn if an array subscript has type @code{char}.  This is a common cause
2166 of error, as programmers often forget that this type is signed on some
2167 machines.
2169 @item -Wcomment
2170 @opindex Wcomment
2171 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2172 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2174 @item -Wfatal-errors
2175 @opindex Wfatal-errors
2176 This option causes the compiler to abort compilation on the first error
2177 occurred rather than trying to keep going and printing further error
2178 messages.
2180 @item -Wformat
2181 @opindex Wformat
2182 @opindex ffreestanding
2183 @opindex fno-builtin
2184 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2185 the arguments supplied have types appropriate to the format string
2186 specified, and that the conversions specified in the format string make
2187 sense.  This includes standard functions, and others specified by format
2188 attributes (@pxref{Function Attributes}), in the @code{printf},
2189 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2190 not in the C standard) families (or other target-specific families).
2191 Which functions are checked without format attributes having been
2192 specified depends on the standard version selected, and such checks of
2193 functions without the attribute specified are disabled by
2194 @option{-ffreestanding} or @option{-fno-builtin}.
2196 The formats are checked against the format features supported by GNU
2197 libc version 2.2.  These include all ISO C90 and C99 features, as well
2198 as features from the Single Unix Specification and some BSD and GNU
2199 extensions.  Other library implementations may not support all these
2200 features; GCC does not support warning about features that go beyond a
2201 particular library's limitations.  However, if @option{-pedantic} is used
2202 with @option{-Wformat}, warnings will be given about format features not
2203 in the selected standard version (but not for @code{strfmon} formats,
2204 since those are not in any version of the C standard).  @xref{C Dialect
2205 Options,,Options Controlling C Dialect}.
2207 Since @option{-Wformat} also checks for null format arguments for
2208 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2210 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2211 aspects of format checking, the options @option{-Wformat-y2k},
2212 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2213 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2214 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2216 @item -Wformat-y2k
2217 @opindex Wformat-y2k
2218 If @option{-Wformat} is specified, also warn about @code{strftime}
2219 formats which may yield only a two-digit year.
2221 @item -Wno-format-extra-args
2222 @opindex Wno-format-extra-args
2223 If @option{-Wformat} is specified, do not warn about excess arguments to a
2224 @code{printf} or @code{scanf} format function.  The C standard specifies
2225 that such arguments are ignored.
2227 Where the unused arguments lie between used arguments that are
2228 specified with @samp{$} operand number specifications, normally
2229 warnings are still given, since the implementation could not know what
2230 type to pass to @code{va_arg} to skip the unused arguments.  However,
2231 in the case of @code{scanf} formats, this option will suppress the
2232 warning if the unused arguments are all pointers, since the Single
2233 Unix Specification says that such unused arguments are allowed.
2235 @item -Wno-format-zero-length
2236 @opindex Wno-format-zero-length
2237 If @option{-Wformat} is specified, do not warn about zero-length formats.
2238 The C standard specifies that zero-length formats are allowed.
2240 @item -Wformat-nonliteral
2241 @opindex Wformat-nonliteral
2242 If @option{-Wformat} is specified, also warn if the format string is not a
2243 string literal and so cannot be checked, unless the format function
2244 takes its format arguments as a @code{va_list}.
2246 @item -Wformat-security
2247 @opindex Wformat-security
2248 If @option{-Wformat} is specified, also warn about uses of format
2249 functions that represent possible security problems.  At present, this
2250 warns about calls to @code{printf} and @code{scanf} functions where the
2251 format string is not a string literal and there are no format arguments,
2252 as in @code{printf (foo);}.  This may be a security hole if the format
2253 string came from untrusted input and contains @samp{%n}.  (This is
2254 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2255 in future warnings may be added to @option{-Wformat-security} that are not
2256 included in @option{-Wformat-nonliteral}.)
2258 @item -Wformat=2
2259 @opindex Wformat=2
2260 Enable @option{-Wformat} plus format checks not included in
2261 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2262 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2264 @item -Wnonnull
2265 @opindex Wnonnull
2266 Warn about passing a null pointer for arguments marked as
2267 requiring a non-null value by the @code{nonnull} function attribute.
2269 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2270 can be disabled with the @option{-Wno-nonnull} option.
2272 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2273 @opindex Winit-self
2274 Warn about uninitialized variables which are initialized with themselves.
2275 Note this option can only be used with the @option{-Wuninitialized} option,
2276 which in turn only works with @option{-O1} and above.
2278 For example, GCC will warn about @code{i} being uninitialized in the
2279 following snippet only when @option{-Winit-self} has been specified:
2280 @smallexample
2281 @group
2282 int f()
2284   int i = i;
2285   return i;
2287 @end group
2288 @end smallexample
2290 @item -Wimplicit-int
2291 @opindex Wimplicit-int
2292 Warn when a declaration does not specify a type.
2294 @item -Wimplicit-function-declaration
2295 @itemx -Werror-implicit-function-declaration
2296 @opindex Wimplicit-function-declaration
2297 @opindex Werror-implicit-function-declaration
2298 Give a warning (or error) whenever a function is used before being
2299 declared.  The form @option{-Wno-error-implicit-function-declaration}
2300 is not supported.
2302 @item -Wimplicit
2303 @opindex Wimplicit
2304 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2306 @item -Wmain
2307 @opindex Wmain
2308 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2309 function with external linkage, returning int, taking either zero
2310 arguments, two, or three arguments of appropriate types.
2312 @item -Wmissing-braces
2313 @opindex Wmissing-braces
2314 Warn if an aggregate or union initializer is not fully bracketed.  In
2315 the following example, the initializer for @samp{a} is not fully
2316 bracketed, but that for @samp{b} is fully bracketed.
2318 @smallexample
2319 int a[2][2] = @{ 0, 1, 2, 3 @};
2320 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2321 @end smallexample
2323 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2324 @opindex Wmissing-include-dirs
2325 Warn if a user-supplied include directory does not exist.
2327 @item -Wparentheses
2328 @opindex Wparentheses
2329 Warn if parentheses are omitted in certain contexts, such
2330 as when there is an assignment in a context where a truth value
2331 is expected, or when operators are nested whose precedence people
2332 often get confused about.  Only the warning for an assignment used as
2333 a truth value is supported when compiling C++; the other warnings are
2334 only supported when compiling C@.
2336 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2337 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2338 interpretation from that of ordinary mathematical notation.
2340 Also warn about constructions where there may be confusion to which
2341 @code{if} statement an @code{else} branch belongs.  Here is an example of
2342 such a case:
2344 @smallexample
2345 @group
2347   if (a)
2348     if (b)
2349       foo ();
2350   else
2351     bar ();
2353 @end group
2354 @end smallexample
2356 In C, every @code{else} branch belongs to the innermost possible @code{if}
2357 statement, which in this example is @code{if (b)}.  This is often not
2358 what the programmer expected, as illustrated in the above example by
2359 indentation the programmer chose.  When there is the potential for this
2360 confusion, GCC will issue a warning when this flag is specified.
2361 To eliminate the warning, add explicit braces around the innermost
2362 @code{if} statement so there is no way the @code{else} could belong to
2363 the enclosing @code{if}.  The resulting code would look like this:
2365 @smallexample
2366 @group
2368   if (a)
2369     @{
2370       if (b)
2371         foo ();
2372       else
2373         bar ();
2374     @}
2376 @end group
2377 @end smallexample
2379 @item -Wsequence-point
2380 @opindex Wsequence-point
2381 Warn about code that may have undefined semantics because of violations
2382 of sequence point rules in the C standard.
2384 The C standard defines the order in which expressions in a C program are
2385 evaluated in terms of @dfn{sequence points}, which represent a partial
2386 ordering between the execution of parts of the program: those executed
2387 before the sequence point, and those executed after it.  These occur
2388 after the evaluation of a full expression (one which is not part of a
2389 larger expression), after the evaluation of the first operand of a
2390 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2391 function is called (but after the evaluation of its arguments and the
2392 expression denoting the called function), and in certain other places.
2393 Other than as expressed by the sequence point rules, the order of
2394 evaluation of subexpressions of an expression is not specified.  All
2395 these rules describe only a partial order rather than a total order,
2396 since, for example, if two functions are called within one expression
2397 with no sequence point between them, the order in which the functions
2398 are called is not specified.  However, the standards committee have
2399 ruled that function calls do not overlap.
2401 It is not specified when between sequence points modifications to the
2402 values of objects take effect.  Programs whose behavior depends on this
2403 have undefined behavior; the C standard specifies that ``Between the
2404 previous and next sequence point an object shall have its stored value
2405 modified at most once by the evaluation of an expression.  Furthermore,
2406 the prior value shall be read only to determine the value to be
2407 stored.''.  If a program breaks these rules, the results on any
2408 particular implementation are entirely unpredictable.
2410 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2411 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2412 diagnosed by this option, and it may give an occasional false positive
2413 result, but in general it has been found fairly effective at detecting
2414 this sort of problem in programs.
2416 The present implementation of this option only works for C programs.  A
2417 future implementation may also work for C++ programs.
2419 The C standard is worded confusingly, therefore there is some debate
2420 over the precise meaning of the sequence point rules in subtle cases.
2421 Links to discussions of the problem, including proposed formal
2422 definitions, may be found on the GCC readings page, at
2423 @w{@uref{http://gcc.gnu.org/readings.html}}.
2425 @item -Wreturn-type
2426 @opindex Wreturn-type
2427 Warn whenever a function is defined with a return-type that defaults to
2428 @code{int}.  Also warn about any @code{return} statement with no
2429 return-value in a function whose return-type is not @code{void}.
2431 For C, also warn if the return type of a function has a type qualifier
2432 such as @code{const}.  Such a type qualifier has no effect, since the
2433 value returned by a function is not an lvalue.  ISO C prohibits
2434 qualified @code{void} return types on function definitions, so such
2435 return types always receive a warning even without this option.
2437 For C++, a function without return type always produces a diagnostic
2438 message, even when @option{-Wno-return-type} is specified.  The only
2439 exceptions are @samp{main} and functions defined in system headers.
2441 @item -Wswitch
2442 @opindex Wswitch
2443 Warn whenever a @code{switch} statement has an index of enumerated type
2444 and lacks a @code{case} for one or more of the named codes of that
2445 enumeration.  (The presence of a @code{default} label prevents this
2446 warning.)  @code{case} labels outside the enumeration range also
2447 provoke warnings when this option is used.
2449 @item -Wswitch-default
2450 @opindex Wswitch-switch
2451 Warn whenever a @code{switch} statement does not have a @code{default}
2452 case.
2454 @item -Wswitch-enum
2455 @opindex Wswitch-enum
2456 Warn whenever a @code{switch} statement has an index of enumerated type
2457 and lacks a @code{case} for one or more of the named codes of that
2458 enumeration.  @code{case} labels outside the enumeration range also
2459 provoke warnings when this option is used.
2461 @item -Wtrigraphs
2462 @opindex Wtrigraphs
2463 Warn if any trigraphs are encountered that might change the meaning of
2464 the program (trigraphs within comments are not warned about).
2466 @item -Wunused-function
2467 @opindex Wunused-function
2468 Warn whenever a static function is declared but not defined or a
2469 non\-inline static function is unused.
2471 @item -Wunused-label
2472 @opindex Wunused-label
2473 Warn whenever a label is declared but not used.
2475 To suppress this warning use the @samp{unused} attribute
2476 (@pxref{Variable Attributes}).
2478 @item -Wunused-parameter
2479 @opindex Wunused-parameter
2480 Warn whenever a function parameter is unused aside from its declaration.
2482 To suppress this warning use the @samp{unused} attribute
2483 (@pxref{Variable Attributes}).
2485 @item -Wunused-variable
2486 @opindex Wunused-variable
2487 Warn whenever a local variable or non-constant static variable is unused
2488 aside from its declaration
2490 To suppress this warning use the @samp{unused} attribute
2491 (@pxref{Variable Attributes}).
2493 @item -Wunused-value
2494 @opindex Wunused-value
2495 Warn whenever a statement computes a result that is explicitly not used.
2497 To suppress this warning cast the expression to @samp{void}.
2499 @item -Wunused
2500 @opindex Wunused
2501 All the above @option{-Wunused} options combined.
2503 In order to get a warning about an unused function parameter, you must
2504 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2505 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2507 @item -Wuninitialized
2508 @opindex Wuninitialized
2509 Warn if an automatic variable is used without first being initialized or
2510 if a variable may be clobbered by a @code{setjmp} call.
2512 These warnings are possible only in optimizing compilation,
2513 because they require data flow information that is computed only
2514 when optimizing.  If you don't specify @option{-O}, you simply won't
2515 get these warnings.
2517 If you want to warn about code which uses the uninitialized value of the
2518 variable in its own initializer, use the @option{-Winit-self} option.
2520 These warnings occur only for variables that are candidates for
2521 register allocation.  Therefore, they do not occur for a variable that
2522 is declared @code{volatile}, or whose address is taken, or whose size
2523 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2524 structures, unions or arrays, even when they are in registers.
2526 Note that there may be no warning about a variable that is used only
2527 to compute a value that itself is never used, because such
2528 computations may be deleted by data flow analysis before the warnings
2529 are printed.
2531 These warnings are made optional because GCC is not smart
2532 enough to see all the reasons why the code might be correct
2533 despite appearing to have an error.  Here is one example of how
2534 this can happen:
2536 @smallexample
2537 @group
2539   int x;
2540   switch (y)
2541     @{
2542     case 1: x = 1;
2543       break;
2544     case 2: x = 4;
2545       break;
2546     case 3: x = 5;
2547     @}
2548   foo (x);
2550 @end group
2551 @end smallexample
2553 @noindent
2554 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2555 always initialized, but GCC doesn't know this.  Here is
2556 another common case:
2558 @smallexample
2560   int save_y;
2561   if (change_y) save_y = y, y = new_y;
2562   @dots{}
2563   if (change_y) y = save_y;
2565 @end smallexample
2567 @noindent
2568 This has no bug because @code{save_y} is used only if it is set.
2570 @cindex @code{longjmp} warnings
2571 This option also warns when a non-volatile automatic variable might be
2572 changed by a call to @code{longjmp}.  These warnings as well are possible
2573 only in optimizing compilation.
2575 The compiler sees only the calls to @code{setjmp}.  It cannot know
2576 where @code{longjmp} will be called; in fact, a signal handler could
2577 call it at any point in the code.  As a result, you may get a warning
2578 even when there is in fact no problem because @code{longjmp} cannot
2579 in fact be called at the place which would cause a problem.
2581 Some spurious warnings can be avoided if you declare all the functions
2582 you use that never return as @code{noreturn}.  @xref{Function
2583 Attributes}.
2585 @item -Wunknown-pragmas
2586 @opindex Wunknown-pragmas
2587 @cindex warning for unknown pragmas
2588 @cindex unknown pragmas, warning
2589 @cindex pragmas, warning of unknown
2590 Warn when a #pragma directive is encountered which is not understood by
2591 GCC@.  If this command line option is used, warnings will even be issued
2592 for unknown pragmas in system header files.  This is not the case if
2593 the warnings were only enabled by the @option{-Wall} command line option.
2595 @item -Wstrict-aliasing
2596 @opindex Wstrict-aliasing
2597 This option is only active when @option{-fstrict-aliasing} is active.
2598 It warns about code which might break the strict aliasing rules that the
2599 compiler is using for optimization.  The warning does not catch all
2600 cases, but does attempt to catch the more common pitfalls.  It is
2601 included in @option{-Wall}.
2603 @item -Wstrict-aliasing=2
2604 @opindex Wstrict-aliasing=2
2605 This option is only active when @option{-fstrict-aliasing} is active.
2606 It warns about all code which might break the strict aliasing rules that the
2607 compiler is using for optimization.  This warning catches all cases, but
2608 it will also give a warning for some ambiguous cases that are safe.
2610 @item -Wall
2611 @opindex Wall
2612 All of the above @samp{-W} options combined.  This enables all the
2613 warnings about constructions that some users consider questionable, and
2614 that are easy to avoid (or modify to prevent the warning), even in
2615 conjunction with macros.  This also enables some language-specific
2616 warnings described in @ref{C++ Dialect Options} and
2617 @ref{Objective-C and Objective-C++ Dialect Options}.
2618 @end table
2620 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2621 Some of them warn about constructions that users generally do not
2622 consider questionable, but which occasionally you might wish to check
2623 for; others warn about constructions that are necessary or hard to avoid
2624 in some cases, and there is no simple way to modify the code to suppress
2625 the warning.
2627 @table @gcctabopt
2628 @item -Wextra
2629 @opindex W
2630 @opindex Wextra
2631 (This option used to be called @option{-W}.  The older name is still
2632 supported, but the newer name is more descriptive.)  Print extra warning
2633 messages for these events:
2635 @itemize @bullet
2636 @item
2637 A function can return either with or without a value.  (Falling
2638 off the end of the function body is considered returning without
2639 a value.)  For example, this function would evoke such a
2640 warning:
2642 @smallexample
2643 @group
2644 foo (a)
2646   if (a > 0)
2647     return a;
2649 @end group
2650 @end smallexample
2652 @item
2653 An expression-statement or the left-hand side of a comma expression
2654 contains no side effects.
2655 To suppress the warning, cast the unused expression to void.
2656 For example, an expression such as @samp{x[i,j]} will cause a warning,
2657 but @samp{x[(void)i,j]} will not.
2659 @item
2660 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2662 @item
2663 Storage-class specifiers like @code{static} are not the first things in
2664 a declaration.  According to the C Standard, this usage is obsolescent.
2666 @item
2667 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2668 arguments.
2670 @item
2671 A comparison between signed and unsigned values could produce an
2672 incorrect result when the signed value is converted to unsigned.
2673 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2675 @item
2676 An aggregate has an initializer which does not initialize all members.
2677 This warning can be independently controlled by
2678 @option{-Wmissing-field-initializers}.
2680 @item
2681 A function parameter is declared without a type specifier in K&R-style
2682 functions:
2684 @smallexample
2685 void foo(bar) @{ @}
2686 @end smallexample
2688 @item
2689 An empty body occurs in an @samp{if} or @samp{else} statement.
2691 @item
2692 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2693 @samp{>}, or @samp{>=}.
2695 @item
2696 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2698 @item
2699 Any of several floating-point events that often indicate errors, such as
2700 overflow, underflow, loss of precision, etc.
2702 @item @r{(C++ only)}
2703 An enumerator and a non-enumerator both appear in a conditional expression.
2705 @item @r{(C++ only)}
2706 A non-static reference or non-static @samp{const} member appears in a
2707 class without constructors.
2709 @item @r{(C++ only)}
2710 Ambiguous virtual bases.
2712 @item @r{(C++ only)}
2713 Subscripting an array which has been declared @samp{register}.
2715 @item @r{(C++ only)}
2716 Taking the address of a variable which has been declared @samp{register}.
2718 @item @r{(C++ only)}
2719 A base class is not initialized in a derived class' copy constructor.
2720 @end itemize
2722 @item -Wno-div-by-zero
2723 @opindex Wno-div-by-zero
2724 @opindex Wdiv-by-zero
2725 Do not warn about compile-time integer division by zero.  Floating point
2726 division by zero is not warned about, as it can be a legitimate way of
2727 obtaining infinities and NaNs.
2729 @item -Wsystem-headers
2730 @opindex Wsystem-headers
2731 @cindex warnings from system headers
2732 @cindex system headers, warnings from
2733 Print warning messages for constructs found in system header files.
2734 Warnings from system headers are normally suppressed, on the assumption
2735 that they usually do not indicate real problems and would only make the
2736 compiler output harder to read.  Using this command line option tells
2737 GCC to emit warnings from system headers as if they occurred in user
2738 code.  However, note that using @option{-Wall} in conjunction with this
2739 option will @emph{not} warn about unknown pragmas in system
2740 headers---for that, @option{-Wunknown-pragmas} must also be used.
2742 @item -Wfloat-equal
2743 @opindex Wfloat-equal
2744 Warn if floating point values are used in equality comparisons.
2746 The idea behind this is that sometimes it is convenient (for the
2747 programmer) to consider floating-point values as approximations to
2748 infinitely precise real numbers.  If you are doing this, then you need
2749 to compute (by analyzing the code, or in some other way) the maximum or
2750 likely maximum error that the computation introduces, and allow for it
2751 when performing comparisons (and when producing output, but that's a
2752 different problem).  In particular, instead of testing for equality, you
2753 would check to see whether the two values have ranges that overlap; and
2754 this is done with the relational operators, so equality comparisons are
2755 probably mistaken.
2757 @item -Wtraditional @r{(C only)}
2758 @opindex Wtraditional
2759 Warn about certain constructs that behave differently in traditional and
2760 ISO C@.  Also warn about ISO C constructs that have no traditional C
2761 equivalent, and/or problematic constructs which should be avoided.
2763 @itemize @bullet
2764 @item
2765 Macro parameters that appear within string literals in the macro body.
2766 In traditional C macro replacement takes place within string literals,
2767 but does not in ISO C@.
2769 @item
2770 In traditional C, some preprocessor directives did not exist.
2771 Traditional preprocessors would only consider a line to be a directive
2772 if the @samp{#} appeared in column 1 on the line.  Therefore
2773 @option{-Wtraditional} warns about directives that traditional C
2774 understands but would ignore because the @samp{#} does not appear as the
2775 first character on the line.  It also suggests you hide directives like
2776 @samp{#pragma} not understood by traditional C by indenting them.  Some
2777 traditional implementations would not recognize @samp{#elif}, so it
2778 suggests avoiding it altogether.
2780 @item
2781 A function-like macro that appears without arguments.
2783 @item
2784 The unary plus operator.
2786 @item
2787 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2788 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2789 constants.)  Note, these suffixes appear in macros defined in the system
2790 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2791 Use of these macros in user code might normally lead to spurious
2792 warnings, however GCC's integrated preprocessor has enough context to
2793 avoid warning in these cases.
2795 @item
2796 A function declared external in one block and then used after the end of
2797 the block.
2799 @item
2800 A @code{switch} statement has an operand of type @code{long}.
2802 @item
2803 A non-@code{static} function declaration follows a @code{static} one.
2804 This construct is not accepted by some traditional C compilers.
2806 @item
2807 The ISO type of an integer constant has a different width or
2808 signedness from its traditional type.  This warning is only issued if
2809 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2810 typically represent bit patterns, are not warned about.
2812 @item
2813 Usage of ISO string concatenation is detected.
2815 @item
2816 Initialization of automatic aggregates.
2818 @item
2819 Identifier conflicts with labels.  Traditional C lacks a separate
2820 namespace for labels.
2822 @item
2823 Initialization of unions.  If the initializer is zero, the warning is
2824 omitted.  This is done under the assumption that the zero initializer in
2825 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2826 initializer warnings and relies on default initialization to zero in the
2827 traditional C case.
2829 @item
2830 Conversions by prototypes between fixed/floating point values and vice
2831 versa.  The absence of these prototypes when compiling with traditional
2832 C would cause serious problems.  This is a subset of the possible
2833 conversion warnings, for the full set use @option{-Wconversion}.
2835 @item
2836 Use of ISO C style function definitions.  This warning intentionally is
2837 @emph{not} issued for prototype declarations or variadic functions
2838 because these ISO C features will appear in your code when using
2839 libiberty's traditional C compatibility macros, @code{PARAMS} and
2840 @code{VPARAMS}.  This warning is also bypassed for nested functions
2841 because that feature is already a GCC extension and thus not relevant to
2842 traditional C compatibility.
2843 @end itemize
2845 @item -Wdeclaration-after-statement @r{(C only)}
2846 @opindex Wdeclaration-after-statement
2847 Warn when a declaration is found after a statement in a block.  This
2848 construct, known from C++, was introduced with ISO C99 and is by default
2849 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2850 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2852 @item -Wundef
2853 @opindex Wundef
2854 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2856 @item -Wendif-labels
2857 @opindex Wendif-labels
2858 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2860 @item -Wshadow
2861 @opindex Wshadow
2862 Warn whenever a local variable shadows another local variable, parameter or
2863 global variable or whenever a built-in function is shadowed.
2865 @item -Wlarger-than-@var{len}
2866 @opindex Wlarger-than
2867 Warn whenever an object of larger than @var{len} bytes is defined.
2869 @item -Wpointer-arith
2870 @opindex Wpointer-arith
2871 Warn about anything that depends on the ``size of'' a function type or
2872 of @code{void}.  GNU C assigns these types a size of 1, for
2873 convenience in calculations with @code{void *} pointers and pointers
2874 to functions.
2876 @item -Wbad-function-cast @r{(C only)}
2877 @opindex Wbad-function-cast
2878 Warn whenever a function call is cast to a non-matching type.
2879 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2881 @item -Wcast-qual
2882 @opindex Wcast-qual
2883 Warn whenever a pointer is cast so as to remove a type qualifier from
2884 the target type.  For example, warn if a @code{const char *} is cast
2885 to an ordinary @code{char *}.
2887 @item -Wcast-align
2888 @opindex Wcast-align
2889 Warn whenever a pointer is cast such that the required alignment of the
2890 target is increased.  For example, warn if a @code{char *} is cast to
2891 an @code{int *} on machines where integers can only be accessed at
2892 two- or four-byte boundaries.
2894 @item -Wwrite-strings
2895 @opindex Wwrite-strings
2896 When compiling C, give string constants the type @code{const
2897 char[@var{length}]} so that
2898 copying the address of one into a non-@code{const} @code{char *}
2899 pointer will get a warning; when compiling C++, warn about the
2900 deprecated conversion from string constants to @code{char *}.
2901 These warnings will help you find at
2902 compile time code that can try to write into a string constant, but
2903 only if you have been very careful about using @code{const} in
2904 declarations and prototypes.  Otherwise, it will just be a nuisance;
2905 this is why we did not make @option{-Wall} request these warnings.
2907 @item -Wconversion
2908 @opindex Wconversion
2909 Warn if a prototype causes a type conversion that is different from what
2910 would happen to the same argument in the absence of a prototype.  This
2911 includes conversions of fixed point to floating and vice versa, and
2912 conversions changing the width or signedness of a fixed point argument
2913 except when the same as the default promotion.
2915 Also, warn if a negative integer constant expression is implicitly
2916 converted to an unsigned type.  For example, warn about the assignment
2917 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2918 casts like @code{(unsigned) -1}.
2920 @item -Wsign-compare
2921 @opindex Wsign-compare
2922 @cindex warning for comparison of signed and unsigned values
2923 @cindex comparison of signed and unsigned values, warning
2924 @cindex signed and unsigned values, comparison warning
2925 Warn when a comparison between signed and unsigned values could produce
2926 an incorrect result when the signed value is converted to unsigned.
2927 This warning is also enabled by @option{-Wextra}; to get the other warnings
2928 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2930 @item -Waggregate-return
2931 @opindex Waggregate-return
2932 Warn if any functions that return structures or unions are defined or
2933 called.  (In languages where you can return an array, this also elicits
2934 a warning.)
2936 @item -Wstrict-prototypes @r{(C only)}
2937 @opindex Wstrict-prototypes
2938 Warn if a function is declared or defined without specifying the
2939 argument types.  (An old-style function definition is permitted without
2940 a warning if preceded by a declaration which specifies the argument
2941 types.)
2943 @item -Wold-style-definition @r{(C only)}
2944 @opindex Wold-style-definition
2945 Warn if an old-style function definition is used.  A warning is given
2946 even if there is a previous prototype.
2948 @item -Wmissing-prototypes @r{(C only)}
2949 @opindex Wmissing-prototypes
2950 Warn if a global function is defined without a previous prototype
2951 declaration.  This warning is issued even if the definition itself
2952 provides a prototype.  The aim is to detect global functions that fail
2953 to be declared in header files.
2955 @item -Wmissing-declarations @r{(C only)}
2956 @opindex Wmissing-declarations
2957 Warn if a global function is defined without a previous declaration.
2958 Do so even if the definition itself provides a prototype.
2959 Use this option to detect global functions that are not declared in
2960 header files.
2962 @item -Wmissing-field-initializers
2963 @opindex Wmissing-field-initializers
2964 @opindex W
2965 @opindex Wextra
2966 Warn if a structure's initializer has some fields missing.  For
2967 example, the following code would cause such a warning, because
2968 @code{x.h} is implicitly zero:
2970 @smallexample
2971 struct s @{ int f, g, h; @};
2972 struct s x = @{ 3, 4 @};
2973 @end smallexample
2975 This option does not warn about designated initializers, so the following
2976 modification would not trigger a warning:
2978 @smallexample
2979 struct s @{ int f, g, h; @};
2980 struct s x = @{ .f = 3, .g = 4 @};
2981 @end smallexample
2983 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2984 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2986 @item -Wmissing-noreturn
2987 @opindex Wmissing-noreturn
2988 Warn about functions which might be candidates for attribute @code{noreturn}.
2989 Note these are only possible candidates, not absolute ones.  Care should
2990 be taken to manually verify functions actually do not ever return before
2991 adding the @code{noreturn} attribute, otherwise subtle code generation
2992 bugs could be introduced.  You will not get a warning for @code{main} in
2993 hosted C environments.
2995 @item -Wmissing-format-attribute
2996 @opindex Wmissing-format-attribute
2997 @opindex Wformat
2998 If @option{-Wformat} is enabled, also warn about functions which might be
2999 candidates for @code{format} attributes.  Note these are only possible
3000 candidates, not absolute ones.  GCC will guess that @code{format}
3001 attributes might be appropriate for any function that calls a function
3002 like @code{vprintf} or @code{vscanf}, but this might not always be the
3003 case, and some functions for which @code{format} attributes are
3004 appropriate may not be detected.  This option has no effect unless
3005 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3007 @item -Wno-multichar
3008 @opindex Wno-multichar
3009 @opindex Wmultichar
3010 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3011 Usually they indicate a typo in the user's code, as they have
3012 implementation-defined values, and should not be used in portable code.
3014 @item -Wno-deprecated-declarations
3015 @opindex Wno-deprecated-declarations
3016 Do not warn about uses of functions, variables, and types marked as
3017 deprecated by using the @code{deprecated} attribute.
3018 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3019 @pxref{Type Attributes}.)
3021 @item -Wpacked
3022 @opindex Wpacked
3023 Warn if a structure is given the packed attribute, but the packed
3024 attribute has no effect on the layout or size of the structure.
3025 Such structures may be mis-aligned for little benefit.  For
3026 instance, in this code, the variable @code{f.x} in @code{struct bar}
3027 will be misaligned even though @code{struct bar} does not itself
3028 have the packed attribute:
3030 @smallexample
3031 @group
3032 struct foo @{
3033   int x;
3034   char a, b, c, d;
3035 @} __attribute__((packed));
3036 struct bar @{
3037   char z;
3038   struct foo f;
3040 @end group
3041 @end smallexample
3043 @item -Wpadded
3044 @opindex Wpadded
3045 Warn if padding is included in a structure, either to align an element
3046 of the structure or to align the whole structure.  Sometimes when this
3047 happens it is possible to rearrange the fields of the structure to
3048 reduce the padding and so make the structure smaller.
3050 @item -Wredundant-decls
3051 @opindex Wredundant-decls
3052 Warn if anything is declared more than once in the same scope, even in
3053 cases where multiple declaration is valid and changes nothing.
3055 @item -Wnested-externs @r{(C only)}
3056 @opindex Wnested-externs
3057 Warn if an @code{extern} declaration is encountered within a function.
3059 @item -Wunreachable-code
3060 @opindex Wunreachable-code
3061 Warn if the compiler detects that code will never be executed.
3063 This option is intended to warn when the compiler detects that at
3064 least a whole line of source code will never be executed, because
3065 some condition is never satisfied or because it is after a
3066 procedure that never returns.
3068 It is possible for this option to produce a warning even though there
3069 are circumstances under which part of the affected line can be executed,
3070 so care should be taken when removing apparently-unreachable code.
3072 For instance, when a function is inlined, a warning may mean that the
3073 line is unreachable in only one inlined copy of the function.
3075 This option is not made part of @option{-Wall} because in a debugging
3076 version of a program there is often substantial code which checks
3077 correct functioning of the program and is, hopefully, unreachable
3078 because the program does work.  Another common use of unreachable
3079 code is to provide behavior which is selectable at compile-time.
3081 @item -Winline
3082 @opindex Winline
3083 Warn if a function can not be inlined and it was declared as inline.
3084 Even with this option, the compiler will not warn about failures to
3085 inline functions declared in system headers.
3087 The compiler uses a variety of heuristics to determine whether or not
3088 to inline a function.  For example, the compiler takes into account
3089 the size of the function being inlined and the the amount of inlining
3090 that has already been done in the current function.  Therefore,
3091 seemingly insignificant changes in the source program can cause the
3092 warnings produced by @option{-Winline} to appear or disappear.
3094 @item -Wno-invalid-offsetof @r{(C++ only)}
3095 @opindex Wno-invalid-offsetof
3096 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3097 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3098 to a non-POD type is undefined.  In existing C++ implementations,
3099 however, @samp{offsetof} typically gives meaningful results even when
3100 applied to certain kinds of non-POD types. (Such as a simple
3101 @samp{struct} that fails to be a POD type only by virtue of having a
3102 constructor.)  This flag is for users who are aware that they are
3103 writing nonportable code and who have deliberately chosen to ignore the
3104 warning about it.
3106 The restrictions on @samp{offsetof} may be relaxed in a future version
3107 of the C++ standard.
3109 @item -Winvalid-pch
3110 @opindex Winvalid-pch
3111 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3112 the search path but can't be used.
3114 @item -Wlong-long
3115 @opindex Wlong-long
3116 @opindex Wno-long-long
3117 Warn if @samp{long long} type is used.  This is default.  To inhibit
3118 the warning messages, use @option{-Wno-long-long}.  Flags
3119 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3120 only when @option{-pedantic} flag is used.
3122 @item -Wvariadic-macros
3123 @opindex Wvariadic-macros
3124 @opindex Wno-variadic-macros
3125 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3126 alternate syntax when in pedantic ISO C99 mode.  This is default.
3127 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3129 @item -Wdisabled-optimization
3130 @opindex Wdisabled-optimization
3131 Warn if a requested optimization pass is disabled.  This warning does
3132 not generally indicate that there is anything wrong with your code; it
3133 merely indicates that GCC's optimizers were unable to handle the code
3134 effectively.  Often, the problem is that your code is too big or too
3135 complex; GCC will refuse to optimize programs when the optimization
3136 itself is likely to take inordinate amounts of time.
3138 @item -Wno-pointer-sign
3139 @opindex Wno-pointer-sign
3140 Don't warn for pointer argument passing or assignment with different signedness.
3141 Only useful in the negative form since this warning is enabled by default.
3142 This option is only supported for C and Objective-C@.
3144 @item -Werror
3145 @opindex Werror
3146 Make all warnings into errors.
3147 @end table
3149 @node Debugging Options
3150 @section Options for Debugging Your Program or GCC
3151 @cindex options, debugging
3152 @cindex debugging information options
3154 GCC has various special options that are used for debugging
3155 either your program or GCC:
3157 @table @gcctabopt
3158 @item -g
3159 @opindex g
3160 Produce debugging information in the operating system's native format
3161 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3162 information.
3164 On most systems that use stabs format, @option{-g} enables use of extra
3165 debugging information that only GDB can use; this extra information
3166 makes debugging work better in GDB but will probably make other debuggers
3167 crash or
3168 refuse to read the program.  If you want to control for certain whether
3169 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3170 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3172 GCC allows you to use @option{-g} with
3173 @option{-O}.  The shortcuts taken by optimized code may occasionally
3174 produce surprising results: some variables you declared may not exist
3175 at all; flow of control may briefly move where you did not expect it;
3176 some statements may not be executed because they compute constant
3177 results or their values were already at hand; some statements may
3178 execute in different places because they were moved out of loops.
3180 Nevertheless it proves possible to debug optimized output.  This makes
3181 it reasonable to use the optimizer for programs that might have bugs.
3183 The following options are useful when GCC is generated with the
3184 capability for more than one debugging format.
3186 @item -ggdb
3187 @opindex ggdb
3188 Produce debugging information for use by GDB@.  This means to use the
3189 most expressive format available (DWARF 2, stabs, or the native format
3190 if neither of those are supported), including GDB extensions if at all
3191 possible.
3193 @item -gstabs
3194 @opindex gstabs
3195 Produce debugging information in stabs format (if that is supported),
3196 without GDB extensions.  This is the format used by DBX on most BSD
3197 systems.  On MIPS, Alpha and System V Release 4 systems this option
3198 produces stabs debugging output which is not understood by DBX or SDB@.
3199 On System V Release 4 systems this option requires the GNU assembler.
3201 @item -feliminate-unused-debug-symbols
3202 @opindex feliminate-unused-debug-symbols
3203 Produce debugging information in stabs format (if that is supported),
3204 for only symbols that are actually used.
3206 @item -gstabs+
3207 @opindex gstabs+
3208 Produce debugging information in stabs format (if that is supported),
3209 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3210 use of these extensions is likely to make other debuggers crash or
3211 refuse to read the program.
3213 @item -gcoff
3214 @opindex gcoff
3215 Produce debugging information in COFF format (if that is supported).
3216 This is the format used by SDB on most System V systems prior to
3217 System V Release 4.
3219 @item -gxcoff
3220 @opindex gxcoff
3221 Produce debugging information in XCOFF format (if that is supported).
3222 This is the format used by the DBX debugger on IBM RS/6000 systems.
3224 @item -gxcoff+
3225 @opindex gxcoff+
3226 Produce debugging information in XCOFF format (if that is supported),
3227 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3228 use of these extensions is likely to make other debuggers crash or
3229 refuse to read the program, and may cause assemblers other than the GNU
3230 assembler (GAS) to fail with an error.
3232 @item -gdwarf-2
3233 @opindex gdwarf-2
3234 Produce debugging information in DWARF version 2 format (if that is
3235 supported).  This is the format used by DBX on IRIX 6.  With this
3236 option, GCC uses features of DWARF version 3 when they are useful;
3237 version 3 is upward compatible with version 2, but may still cause
3238 problems for older debuggers.
3240 @item -gvms
3241 @opindex gvms
3242 Produce debugging information in VMS debug format (if that is
3243 supported).  This is the format used by DEBUG on VMS systems.
3245 @item -g@var{level}
3246 @itemx -ggdb@var{level}
3247 @itemx -gstabs@var{level}
3248 @itemx -gcoff@var{level}
3249 @itemx -gxcoff@var{level}
3250 @itemx -gvms@var{level}
3251 Request debugging information and also use @var{level} to specify how
3252 much information.  The default level is 2.
3254 Level 1 produces minimal information, enough for making backtraces in
3255 parts of the program that you don't plan to debug.  This includes
3256 descriptions of functions and external variables, but no information
3257 about local variables and no line numbers.
3259 Level 3 includes extra information, such as all the macro definitions
3260 present in the program.  Some debuggers support macro expansion when
3261 you use @option{-g3}.
3263 @option{-gdwarf-2} does not accept a concatenated debug level, because
3264 GCC used to support an option @option{-gdwarf} that meant to generate
3265 debug information in version 1 of the DWARF format (which is very
3266 different from version 2), and it would have been too confusing.  That
3267 debug format is long obsolete, but the option cannot be changed now.
3268 Instead use an additional @option{-g@var{level}} option to change the
3269 debug level for DWARF2.
3271 @item -feliminate-dwarf2-dups
3272 @opindex feliminate-dwarf2-dups
3273 Compress DWARF2 debugging information by eliminating duplicated
3274 information about each symbol.  This option only makes sense when
3275 generating DWARF2 debugging information with @option{-gdwarf-2}.
3277 @cindex @command{prof}
3278 @item -p
3279 @opindex p
3280 Generate extra code to write profile information suitable for the
3281 analysis program @command{prof}.  You must use this option when compiling
3282 the source files you want data about, and you must also use it when
3283 linking.
3285 @cindex @command{gprof}
3286 @item -pg
3287 @opindex pg
3288 Generate extra code to write profile information suitable for the
3289 analysis program @command{gprof}.  You must use this option when compiling
3290 the source files you want data about, and you must also use it when
3291 linking.
3293 @item -Q
3294 @opindex Q
3295 Makes the compiler print out each function name as it is compiled, and
3296 print some statistics about each pass when it finishes.
3298 @item -ftime-report
3299 @opindex ftime-report
3300 Makes the compiler print some statistics about the time consumed by each
3301 pass when it finishes.
3303 @item -fmem-report
3304 @opindex fmem-report
3305 Makes the compiler print some statistics about permanent memory
3306 allocation when it finishes.
3308 @item -fprofile-arcs
3309 @opindex fprofile-arcs
3310 Add code so that program flow @dfn{arcs} are instrumented.  During
3311 execution the program records how many times each branch and call is
3312 executed and how many times it is taken or returns.  When the compiled
3313 program exits it saves this data to a file called
3314 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3315 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3316 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3317 @var{auxname} is generated from the name of the output file, if
3318 explicitly specified and it is not the final executable, otherwise it is
3319 the basename of the source file.  In both cases any suffix is removed
3320 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3321 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3323 @itemize
3325 @item
3326 Compile the source files with @option{-fprofile-arcs} plus optimization
3327 and code generation options.  For test coverage analysis, use the
3328 additional @option{-ftest-coverage} option.  You do not need to profile
3329 every source file in a program.
3331 @item
3332 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3333 (the latter implies the former).
3335 @item
3336 Run the program on a representative workload to generate the arc profile
3337 information.  This may be repeated any number of times.  You can run
3338 concurrent instances of your program, and provided that the file system
3339 supports locking, the data files will be correctly updated.  Also
3340 @code{fork} calls are detected and correctly handled (double counting
3341 will not happen).
3343 @item
3344 For profile-directed optimizations, compile the source files again with
3345 the same optimization and code generation options plus
3346 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3347 Control Optimization}).
3349 @item
3350 For test coverage analysis, use @command{gcov} to produce human readable
3351 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3352 @command{gcov} documentation for further information.
3354 @end itemize
3356 With @option{-fprofile-arcs}, for each function of your program GCC
3357 creates a program flow graph, then finds a spanning tree for the graph.
3358 Only arcs that are not on the spanning tree have to be instrumented: the
3359 compiler adds code to count the number of times that these arcs are
3360 executed.  When an arc is the only exit or only entrance to a block, the
3361 instrumentation code can be added to the block; otherwise, a new basic
3362 block must be created to hold the instrumentation code.
3364 @item -ftree-based-profiling
3365 @opindex ftree-based-profiling
3366 This option is used in addition to @option{-fprofile-arcs} or
3367 @option{-fbranch-probabilities} to control whether those optimizations
3368 are performed on a tree-based or rtl-based internal representation.
3369 If you use this option when compiling with @option{-fprofile-arcs},
3370 you must also use it when compiling later with @option{-fbranch-probabilities}.
3371 Currently the tree-based optimization is in an early stage of
3372 development, and this option is recommended only for those people
3373 working on improving it.
3375 @need 2000
3376 @item -ftest-coverage
3377 @opindex ftest-coverage
3378 Produce a notes file that the @command{gcov} code-coverage utility
3379 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3380 show program coverage.  Each source file's note file is called
3381 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3382 above for a description of @var{auxname} and instructions on how to
3383 generate test coverage data.  Coverage data will match the source files
3384 more closely, if you do not optimize.
3386 @item -d@var{letters}
3387 @item -fdump-rtl-@var{pass}
3388 @opindex d
3389 Says to make debugging dumps during compilation at times specified by
3390 @var{letters}.    This is used for debugging the RTL-based passes of the
3391 compiler.  The file names for most of the dumps are made by appending a
3392 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3393 from the name of the output file, if explicitly specified and it is not
3394 an executable, otherwise it is the basename of the source file.
3396 Most debug dumps can be enabled either passing a letter to the @option{-d}
3397 option, or with a long @option{-fdump-rtl} switch; here are the possible
3398 letters for use in @var{letters} and @var{pass}, and their meanings:
3400 @table @gcctabopt
3401 @item -dA
3402 @opindex dA
3403 Annotate the assembler output with miscellaneous debugging information.
3405 @item -db
3406 @itemx -fdump-rtl-bp
3407 @opindex db
3408 @opindex fdump-rtl-bp
3409 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3411 @item -dB
3412 @itemx -fdump-rtl-bbro
3413 @opindex dB
3414 @opindex fdump-rtl-bbro
3415 Dump after block reordering, to @file{@var{file}.30.bbro}.
3417 @item -dc
3418 @itemx -fdump-rtl-combine
3419 @opindex dc
3420 @opindex fdump-rtl-combine
3421 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3423 @item -dC
3424 @itemx -fdump-rtl-ce1
3425 @itemx -fdump-rtl-ce2
3426 @opindex dC
3427 @opindex fdump-rtl-ce1
3428 @opindex fdump-rtl-ce2
3429 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3430 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3431 and @option{-fdump-rtl-ce2} enable dumping after the second if
3432 conversion, to the file @file{@var{file}.18.ce2}.
3434 @item -dd
3435 @itemx -fdump-rtl-btl
3436 @itemx -fdump-rtl-dbr
3437 @opindex dd
3438 @opindex fdump-rtl-btl
3439 @opindex fdump-rtl-dbr
3440 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3441 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3442 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3443 scheduling, to @file{@var{file}.36.dbr}.
3445 @item -dD
3446 @opindex dD
3447 Dump all macro definitions, at the end of preprocessing, in addition to
3448 normal output.
3450 @item -dE
3451 @itemx -fdump-rtl-ce3
3452 @opindex dE
3453 @opindex fdump-rtl-ce3
3454 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3456 @item -df
3457 @itemx -fdump-rtl-cfg
3458 @itemx -fdump-rtl-life
3459 @opindex df
3460 @opindex fdump-rtl-cfg
3461 @opindex fdump-rtl-life
3462 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3463 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3464 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3465 to @file{@var{file}.16.life}.
3467 @item -dg
3468 @itemx -fdump-rtl-greg
3469 @opindex dg
3470 @opindex fdump-rtl-greg
3471 Dump after global register allocation, to @file{@var{file}.23.greg}.
3473 @item -dG
3474 @itemx -fdump-rtl-gcse
3475 @itemx -fdump-rtl-bypass
3476 @opindex dG
3477 @opindex fdump-rtl-gcse
3478 @opindex fdump-rtl-bypass
3479 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3480 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3481 enable dumping after jump bypassing and control flow optimizations, to
3482 @file{@var{file}.07.bypass}.
3484 @item -dh
3485 @itemx -fdump-rtl-eh
3486 @opindex dh
3487 @opindex fdump-rtl-eh
3488 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3490 @item -di
3491 @itemx -fdump-rtl-sibling
3492 @opindex di
3493 @opindex fdump-rtl-sibling
3494 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3496 @item -dj
3497 @itemx -fdump-rtl-jump
3498 @opindex dj
3499 @opindex fdump-rtl-jump
3500 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3502 @item -dk
3503 @itemx -fdump-rtl-stack
3504 @opindex dk
3505 @opindex fdump-rtl-stack
3506 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3508 @item -dl
3509 @itemx -fdump-rtl-lreg
3510 @opindex dl
3511 @opindex fdump-rtl-lreg
3512 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3514 @item -dL
3515 @itemx -fdump-rtl-loop
3516 @itemx -fdump-rtl-loop2
3517 @opindex dL
3518 @opindex fdump-rtl-loop
3519 @opindex fdump-rtl-loop2
3520 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3521 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3522 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3523 @file{@var{file}.13.loop2}.
3525 @item -dm
3526 @itemx -fdump-rtl-sms
3527 @opindex dm
3528 @opindex fdump-rtl-sms
3529 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3531 @item -dM
3532 @itemx -fdump-rtl-mach
3533 @opindex dM
3534 @opindex fdump-rtl-mach
3535 Dump after performing the machine dependent reorganization pass, to
3536 @file{@var{file}.35.mach}.
3538 @item -dn
3539 @itemx -fdump-rtl-rnreg
3540 @opindex dn
3541 @opindex fdump-rtl-rnreg
3542 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3544 @item -dN
3545 @itemx -fdump-rtl-regmove
3546 @opindex dN
3547 @opindex fdump-rtl-regmove
3548 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3550 @item -do
3551 @itemx -fdump-rtl-postreload
3552 @opindex do
3553 @opindex fdump-rtl-postreload
3554 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3556 @item -dr
3557 @itemx -fdump-rtl-expand
3558 @opindex dr
3559 @opindex fdump-rtl-expand
3560 Dump after RTL generation, to @file{@var{file}.00.expand}.
3562 @item -dR
3563 @itemx -fdump-rtl-sched2
3564 @opindex dR
3565 @opindex fdump-rtl-sched2
3566 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3568 @item -ds
3569 @itemx -fdump-rtl-cse
3570 @opindex ds
3571 @opindex fdump-rtl-cse
3572 Dump after CSE (including the jump optimization that sometimes follows
3573 CSE), to @file{@var{file}.04.cse}.
3575 @item -dS
3576 @itemx -fdump-rtl-sched
3577 @opindex dS
3578 @opindex fdump-rtl-sched
3579 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3581 @item -dt
3582 @itemx -fdump-rtl-cse2
3583 @opindex dt
3584 @opindex fdump-rtl-cse2
3585 Dump after the second CSE pass (including the jump optimization that
3586 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3588 @item -dT
3589 @itemx -fdump-rtl-tracer
3590 @opindex dT
3591 @opindex fdump-rtl-tracer
3592 Dump after running tracer, to @file{@var{file}.12.tracer}.
3594 @item -dV
3595 @itemx -fdump-rtl-vpt
3596 @itemx -fdump-rtl-vartrack
3597 @opindex dV
3598 @opindex fdump-rtl-vpt
3599 @opindex fdump-rtl-vartrack
3600 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3601 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3602 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3603 to @file{@var{file}.34.vartrack}.
3605 @item -dw
3606 @itemx -fdump-rtl-flow2
3607 @opindex dw
3608 @opindex fdump-rtl-flow2
3609 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3611 @item -dz
3612 @itemx -fdump-rtl-peephole2
3613 @opindex dz
3614 @opindex fdump-rtl-peephole2
3615 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3617 @item -dZ
3618 @itemx -fdump-rtl-web
3619 @opindex dZ
3620 @opindex fdump-rtl-web
3621 Dump after live range splitting, to @file{@var{file}.14.web}.
3623 @item -da
3624 @itemx -fdump-rtl-all
3625 @opindex da
3626 @opindex fdump-rtl-all
3627 Produce all the dumps listed above.
3629 @item -dH
3630 @opindex dH
3631 Produce a core dump whenever an error occurs.
3633 @item -dm
3634 @opindex dm
3635 Print statistics on memory usage, at the end of the run, to
3636 standard error.
3638 @item -dp
3639 @opindex dp
3640 Annotate the assembler output with a comment indicating which
3641 pattern and alternative was used.  The length of each instruction is
3642 also printed.
3644 @item -dP
3645 @opindex dP
3646 Dump the RTL in the assembler output as a comment before each instruction.
3647 Also turns on @option{-dp} annotation.
3649 @item -dv
3650 @opindex dv
3651 For each of the other indicated dump files (either with @option{-d} or
3652 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3653 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3655 @item -dx
3656 @opindex dx
3657 Just generate RTL for a function instead of compiling it.  Usually used
3658 with @samp{r} (@option{-fdump-rtl-expand}).
3660 @item -dy
3661 @opindex dy
3662 Dump debugging information during parsing, to standard error.
3663 @end table
3665 @item -fdump-unnumbered
3666 @opindex fdump-unnumbered
3667 When doing debugging dumps (see @option{-d} option above), suppress instruction
3668 numbers and line number note output.  This makes it more feasible to
3669 use diff on debugging dumps for compiler invocations with different
3670 options, in particular with and without @option{-g}.
3672 @item -fdump-translation-unit @r{(C and C++ only)}
3673 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3674 @opindex fdump-translation-unit
3675 Dump a representation of the tree structure for the entire translation
3676 unit to a file.  The file name is made by appending @file{.tu} to the
3677 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3678 controls the details of the dump as described for the
3679 @option{-fdump-tree} options.
3681 @item -fdump-class-hierarchy @r{(C++ only)}
3682 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3683 @opindex fdump-class-hierarchy
3684 Dump a representation of each class's hierarchy and virtual function
3685 table layout to a file.  The file name is made by appending @file{.class}
3686 to the source file name.  If the @samp{-@var{options}} form is used,
3687 @var{options} controls the details of the dump as described for the
3688 @option{-fdump-tree} options.
3690 @item -fdump-ipa-@var{switch}
3691 @opindex fdump-ipa
3692 Control the dumping at various stages of inter-procedural analysis
3693 language tree to a file.  The file name is generated by appending a switch
3694 specific suffix to the source file name.  The following dumps are possible:
3696 @table @samp
3697 @item all
3698 Enables all inter-procedural analysis dumps; currently the only produced
3699 dump is the @samp{cgraph} dump.
3701 @item cgraph
3702 Dumps information about call-graph optimization, unused function removal,
3703 and inlining decisions.
3704 @end table
3706 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3707 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3708 @opindex fdump-tree
3709 Control the dumping at various stages of processing the intermediate
3710 language tree to a file.  The file name is generated by appending a switch
3711 specific suffix to the source file name.  If the @samp{-@var{options}}
3712 form is used, @var{options} is a list of @samp{-} separated options that
3713 control the details of the dump.  Not all options are applicable to all
3714 dumps, those which are not meaningful will be ignored.  The following
3715 options are available
3717 @table @samp
3718 @item address
3719 Print the address of each node.  Usually this is not meaningful as it
3720 changes according to the environment and source file.  Its primary use
3721 is for tying up a dump file with a debug environment.
3722 @item slim
3723 Inhibit dumping of members of a scope or body of a function merely
3724 because that scope has been reached.  Only dump such items when they
3725 are directly reachable by some other path.  When dumping pretty-printed
3726 trees, this option inhibits dumping the bodies of control structures.
3727 @item raw
3728 Print a raw representation of the tree.  By default, trees are
3729 pretty-printed into a C-like representation.
3730 @item details
3731 Enable more detailed dumps (not honored by every dump option).
3732 @item stats
3733 Enable dumping various statistics about the pass (not honored by every dump
3734 option).
3735 @item blocks
3736 Enable showing basic block boundaries (disabled in raw dumps).
3737 @item vops
3738 Enable showing virtual operands for every statement.
3739 @item lineno
3740 Enable showing line numbers for statements.
3741 @item uid
3742 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3743 @item all
3744 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3745 @end table
3747 The following tree dumps are possible:
3748 @table @samp
3750 @item original
3751 Dump before any tree based optimization, to @file{@var{file}.original}.
3753 @item optimized
3754 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3756 @item inlined
3757 Dump after function inlining, to @file{@var{file}.inlined}.
3759 @item gimple
3760 @opindex fdump-tree-gimple
3761 Dump each function before and after the gimplification pass to a file.  The
3762 file name is made by appending @file{.gimple} to the source file name.
3764 @item cfg
3765 @opindex fdump-tree-cfg
3766 Dump the control flow graph of each function to a file.  The file name is
3767 made by appending @file{.cfg} to the source file name.
3769 @item vcg
3770 @opindex fdump-tree-vcg
3771 Dump the control flow graph of each function to a file in VCG format.  The
3772 file name is made by appending @file{.vcg} to the source file name.  Note
3773 that if the file contains more than one function, the generated file cannot
3774 be used directly by VCG@.  You will need to cut and paste each function's
3775 graph into its own separate file first.
3777 @item ch
3778 @opindex fdump-tree-ch
3779 Dump each function after copying loop headers.  The file name is made by
3780 appending @file{.ch} to the source file name.
3782 @item ssa
3783 @opindex fdump-tree-ssa
3784 Dump SSA related information to a file.  The file name is made by appending
3785 @file{.ssa} to the source file name.
3787 @item alias
3788 @opindex fdump-tree-alias
3789 Dump aliasing information for each function.  The file name is made by
3790 appending @file{.alias} to the source file name.
3792 @item ccp
3793 @opindex fdump-tree-ccp
3794 Dump each function after CCP@.  The file name is made by appending
3795 @file{.ccp} to the source file name.
3797 @item pre
3798 @opindex fdump-tree-pre
3799 Dump trees after partial redundancy elimination.  The file name is made
3800 by appending @file{.pre} to the source file name.
3802 @item fre
3803 @opindex fdump-tree-fre
3804 Dump trees after full redundancy elimination.  The file name is made
3805 by appending @file{.fre} to the source file name.
3807 @item dce
3808 @opindex fdump-tree-dce
3809 Dump each function after dead code elimination.  The file name is made by
3810 appending @file{.dce} to the source file name.
3812 @item mudflap
3813 @opindex fdump-tree-mudflap
3814 Dump each function after adding mudflap instrumentation.  The file name is
3815 made by appending @file{.mudflap} to the source file name.
3817 @item sra
3818 @opindex fdump-tree-sra
3819 Dump each function after performing scalar replacement of aggregates.  The
3820 file name is made by appending @file{.sra} to the source file name.
3822 @item dom
3823 @opindex fdump-tree-dom
3824 Dump each function after applying dominator tree optimizations.  The file
3825 name is made by appending @file{.dom} to the source file name.
3827 @item dse
3828 @opindex fdump-tree-dse
3829 Dump each function after applying dead store elimination.  The file
3830 name is made by appending @file{.dse} to the source file name.
3832 @item phiopt
3833 @opindex fdump-tree-phiopt
3834 Dump each function after optimizing PHI nodes into straightline code.  The file
3835 name is made by appending @file{.phiopt} to the source file name.
3837 @item forwprop
3838 @opindex fdump-tree-forwprop
3839 Dump each function after forward propagating single use variables.  The file
3840 name is made by appending @file{.forwprop} to the source file name.
3842 @item copyrename
3843 @opindex fdump-tree-copyrename
3844 Dump each function after applying the copy rename optimization.  The file
3845 name is made by appending @file{.copyrename} to the source file name.
3847 @item nrv
3848 @opindex fdump-tree-nrv
3849 Dump each function after applying the named return value optimization on
3850 generic trees.  The file name is made by appending @file{.nrv} to the source
3851 file name.
3853 @item vect
3854 @opindex fdump-tree-vect
3855 Dump each function after applying vectorization of loops.  The file name is
3856 made by appending @file{.vect} to the source file name.
3858 @item all
3859 @opindex fdump-tree-all
3860 Enable all the available tree dumps with the flags provided in this option.
3861 @end table
3863 @item -frandom-seed=@var{string}
3864 @opindex frandom-string
3865 This option provides a seed that GCC uses when it would otherwise use
3866 random numbers.  It is used to generate certain symbol names
3867 that have to be different in every compiled file.  It is also used to
3868 place unique stamps in coverage data files and the object files that
3869 produce them.  You can use the @option{-frandom-seed} option to produce
3870 reproducibly identical object files.
3872 The @var{string} should be different for every file you compile.
3874 @item -fsched-verbose=@var{n}
3875 @opindex fsched-verbose
3876 On targets that use instruction scheduling, this option controls the
3877 amount of debugging output the scheduler prints.  This information is
3878 written to standard error, unless @option{-dS} or @option{-dR} is
3879 specified, in which case it is output to the usual dump
3880 listing file, @file{.sched} or @file{.sched2} respectively.  However
3881 for @var{n} greater than nine, the output is always printed to standard
3882 error.
3884 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3885 same information as @option{-dRS}.  For @var{n} greater than one, it
3886 also output basic block probabilities, detailed ready list information
3887 and unit/insn info.  For @var{n} greater than two, it includes RTL
3888 at abort point, control-flow and regions info.  And for @var{n} over
3889 four, @option{-fsched-verbose} also includes dependence info.
3891 @item -save-temps
3892 @opindex save-temps
3893 Store the usual ``temporary'' intermediate files permanently; place them
3894 in the current directory and name them based on the source file.  Thus,
3895 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3896 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3897 preprocessed @file{foo.i} output file even though the compiler now
3898 normally uses an integrated preprocessor.
3900 When used in combination with the @option{-x} command line option,
3901 @option{-save-temps} is sensible enough to avoid over writing an
3902 input source file with the same extension as an intermediate file.
3903 The corresponding intermediate file may be obtained by renaming the
3904 source file before using @option{-save-temps}.
3906 @item -time
3907 @opindex time
3908 Report the CPU time taken by each subprocess in the compilation
3909 sequence.  For C source files, this is the compiler proper and assembler
3910 (plus the linker if linking is done).  The output looks like this:
3912 @smallexample
3913 # cc1 0.12 0.01
3914 # as 0.00 0.01
3915 @end smallexample
3917 The first number on each line is the ``user time'', that is time spent
3918 executing the program itself.  The second number is ``system time'',
3919 time spent executing operating system routines on behalf of the program.
3920 Both numbers are in seconds.
3922 @item -fvar-tracking
3923 @opindex fvar-tracking
3924 Run variable tracking pass.  It computes where variables are stored at each
3925 position in code.  Better debugging information is then generated
3926 (if the debugging information format supports this information).
3928 It is enabled by default when compiling with optimization (@option{-Os},
3929 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3930 the debug info format supports it.
3932 @item -print-file-name=@var{library}
3933 @opindex print-file-name
3934 Print the full absolute name of the library file @var{library} that
3935 would be used when linking---and don't do anything else.  With this
3936 option, GCC does not compile or link anything; it just prints the
3937 file name.
3939 @item -print-multi-directory
3940 @opindex print-multi-directory
3941 Print the directory name corresponding to the multilib selected by any
3942 other switches present in the command line.  This directory is supposed
3943 to exist in @env{GCC_EXEC_PREFIX}.
3945 @item -print-multi-lib
3946 @opindex print-multi-lib
3947 Print the mapping from multilib directory names to compiler switches
3948 that enable them.  The directory name is separated from the switches by
3949 @samp{;}, and each switch starts with an @samp{@@} instead of the
3950 @samp{-}, without spaces between multiple switches.  This is supposed to
3951 ease shell-processing.
3953 @item -print-prog-name=@var{program}
3954 @opindex print-prog-name
3955 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3957 @item -print-libgcc-file-name
3958 @opindex print-libgcc-file-name
3959 Same as @option{-print-file-name=libgcc.a}.
3961 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3962 but you do want to link with @file{libgcc.a}.  You can do
3964 @smallexample
3965 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3966 @end smallexample
3968 @item -print-search-dirs
3969 @opindex print-search-dirs
3970 Print the name of the configured installation directory and a list of
3971 program and library directories @command{gcc} will search---and don't do anything else.
3973 This is useful when @command{gcc} prints the error message
3974 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3975 To resolve this you either need to put @file{cpp0} and the other compiler
3976 components where @command{gcc} expects to find them, or you can set the environment
3977 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3978 Don't forget the trailing @samp{/}.
3979 @xref{Environment Variables}.
3981 @item -dumpmachine
3982 @opindex dumpmachine
3983 Print the compiler's target machine (for example,
3984 @samp{i686-pc-linux-gnu})---and don't do anything else.
3986 @item -dumpversion
3987 @opindex dumpversion
3988 Print the compiler version (for example, @samp{3.0})---and don't do
3989 anything else.
3991 @item -dumpspecs
3992 @opindex dumpspecs
3993 Print the compiler's built-in specs---and don't do anything else.  (This
3994 is used when GCC itself is being built.)  @xref{Spec Files}.
3996 @item -feliminate-unused-debug-types
3997 @opindex feliminate-unused-debug-types
3998 Normally, when producing DWARF2 output, GCC will emit debugging
3999 information for all types declared in a compilation
4000 unit, regardless of whether or not they are actually used
4001 in that compilation unit.  Sometimes this is useful, such as
4002 if, in the debugger, you want to cast a value to a type that is
4003 not actually used in your program (but is declared).  More often,
4004 however, this results in a significant amount of wasted space.
4005 With this option, GCC will avoid producing debug symbol output
4006 for types that are nowhere used in the source file being compiled.
4007 @end table
4009 @node Optimize Options
4010 @section Options That Control Optimization
4011 @cindex optimize options
4012 @cindex options, optimization
4014 These options control various sorts of optimizations.
4016 Without any optimization option, the compiler's goal is to reduce the
4017 cost of compilation and to make debugging produce the expected
4018 results.  Statements are independent: if you stop the program with a
4019 breakpoint between statements, you can then assign a new value to any
4020 variable or change the program counter to any other statement in the
4021 function and get exactly the results you would expect from the source
4022 code.
4024 Turning on optimization flags makes the compiler attempt to improve
4025 the performance and/or code size at the expense of compilation time
4026 and possibly the ability to debug the program.
4028 The compiler performs optimization based on the knowledge it has of
4029 the program.  Optimization levels @option{-O2} and above, in
4030 particular, enable @emph{unit-at-a-time} mode, which allows the
4031 compiler to consider information gained from later functions in
4032 the file when compiling a function.  Compiling multiple files at
4033 once to a single output file in @emph{unit-at-a-time} mode allows
4034 the compiler to use information gained from all of the files when
4035 compiling each of them.
4037 Not all optimizations are controlled directly by a flag.  Only
4038 optimizations that have a flag are listed.
4040 @table @gcctabopt
4041 @item -O
4042 @itemx -O1
4043 @opindex O
4044 @opindex O1
4045 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4046 more memory for a large function.
4048 With @option{-O}, the compiler tries to reduce code size and execution
4049 time, without performing any optimizations that take a great deal of
4050 compilation time.
4052 @option{-O} turns on the following optimization flags:
4053 @gccoptlist{-fdefer-pop @gol
4054 -fmerge-constants @gol
4055 -fthread-jumps @gol
4056 -floop-optimize @gol
4057 -fif-conversion @gol
4058 -fif-conversion2 @gol
4059 -fdelayed-branch @gol
4060 -fguess-branch-probability @gol
4061 -fcprop-registers}
4063 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4064 where doing so does not interfere with debugging.
4066 @item -O2
4067 @opindex O2
4068 Optimize even more.  GCC performs nearly all supported optimizations
4069 that do not involve a space-speed tradeoff.  The compiler does not
4070 perform loop unrolling or function inlining when you specify @option{-O2}.
4071 As compared to @option{-O}, this option increases both compilation time
4072 and the performance of the generated code.
4074 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4075 also turns on the following optimization flags:
4076 @gccoptlist{-fforce-mem @gol
4077 -foptimize-sibling-calls @gol
4078 -fstrength-reduce @gol
4079 -fcse-follow-jumps  -fcse-skip-blocks @gol
4080 -frerun-cse-after-loop  -frerun-loop-opt @gol
4081 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
4082 -fdelete-null-pointer-checks @gol
4083 -fexpensive-optimizations @gol
4084 -fregmove @gol
4085 -fschedule-insns  -fschedule-insns2 @gol
4086 -fsched-interblock  -fsched-spec @gol
4087 -fcaller-saves @gol
4088 -fpeephole2 @gol
4089 -freorder-blocks  -freorder-functions @gol
4090 -fstrict-aliasing @gol
4091 -funit-at-a-time @gol
4092 -falign-functions  -falign-jumps @gol
4093 -falign-loops  -falign-labels @gol
4094 -fcrossjumping}
4096 Please note the warning under @option{-fgcse} about
4097 invoking @option{-O2} on programs that use computed gotos.
4099 @item -O3
4100 @opindex O3
4101 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4102 @option{-O2} and also turns on the @option{-finline-functions},
4103 @option{-fweb} and @option{-fgcse-after-reload} options.
4105 @item -O0
4106 @opindex O0
4107 Do not optimize.  This is the default.
4109 @item -Os
4110 @opindex Os
4111 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4112 do not typically increase code size.  It also performs further
4113 optimizations designed to reduce code size.
4115 @option{-Os} disables the following optimization flags:
4116 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4117 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4119 If you use multiple @option{-O} options, with or without level numbers,
4120 the last such option is the one that is effective.
4121 @end table
4123 Options of the form @option{-f@var{flag}} specify machine-independent
4124 flags.  Most flags have both positive and negative forms; the negative
4125 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4126 below, only one of the forms is listed---the one you typically will
4127 use.  You can figure out the other form by either removing @samp{no-}
4128 or adding it.
4130 The following options control specific optimizations.  They are either
4131 activated by @option{-O} options or are related to ones that are.  You
4132 can use the following flags in the rare cases when ``fine-tuning'' of
4133 optimizations to be performed is desired.
4135 @table @gcctabopt
4136 @item -fno-default-inline
4137 @opindex fno-default-inline
4138 Do not make member functions inline by default merely because they are
4139 defined inside the class scope (C++ only).  Otherwise, when you specify
4140 @w{@option{-O}}, member functions defined inside class scope are compiled
4141 inline by default; i.e., you don't need to add @samp{inline} in front of
4142 the member function name.
4144 @item -fno-defer-pop
4145 @opindex fno-defer-pop
4146 Always pop the arguments to each function call as soon as that function
4147 returns.  For machines which must pop arguments after a function call,
4148 the compiler normally lets arguments accumulate on the stack for several
4149 function calls and pops them all at once.
4151 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4153 @item -fforce-mem
4154 @opindex fforce-mem
4155 Force memory operands to be copied into registers before doing
4156 arithmetic on them.  This produces better code by making all memory
4157 references potential common subexpressions.  When they are not common
4158 subexpressions, instruction combination should eliminate the separate
4159 register-load.
4161 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4163 @item -fforce-addr
4164 @opindex fforce-addr
4165 Force memory address constants to be copied into registers before
4166 doing arithmetic on them.  This may produce better code just as
4167 @option{-fforce-mem} may.
4169 @item -fomit-frame-pointer
4170 @opindex fomit-frame-pointer
4171 Don't keep the frame pointer in a register for functions that
4172 don't need one.  This avoids the instructions to save, set up and
4173 restore frame pointers; it also makes an extra register available
4174 in many functions.  @strong{It also makes debugging impossible on
4175 some machines.}
4177 On some machines, such as the VAX, this flag has no effect, because
4178 the standard calling sequence automatically handles the frame pointer
4179 and nothing is saved by pretending it doesn't exist.  The
4180 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4181 whether a target machine supports this flag.  @xref{Registers,,Register
4182 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4184 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4186 @item -foptimize-sibling-calls
4187 @opindex foptimize-sibling-calls
4188 Optimize sibling and tail recursive calls.
4190 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4192 @item -fno-inline
4193 @opindex fno-inline
4194 Don't pay attention to the @code{inline} keyword.  Normally this option
4195 is used to keep the compiler from expanding any functions inline.
4196 Note that if you are not optimizing, no functions can be expanded inline.
4198 @item -finline-functions
4199 @opindex finline-functions
4200 Integrate all simple functions into their callers.  The compiler
4201 heuristically decides which functions are simple enough to be worth
4202 integrating in this way.
4204 If all calls to a given function are integrated, and the function is
4205 declared @code{static}, then the function is normally not output as
4206 assembler code in its own right.
4208 Enabled at level @option{-O3}.
4210 @item -finline-limit=@var{n}
4211 @opindex finline-limit
4212 By default, GCC limits the size of functions that can be inlined.  This flag
4213 allows the control of this limit for functions that are explicitly marked as
4214 inline (i.e., marked with the inline keyword or defined within the class
4215 definition in c++).  @var{n} is the size of functions that can be inlined in
4216 number of pseudo instructions (not counting parameter handling).  The default
4217 value of @var{n} is 600.
4218 Increasing this value can result in more inlined code at
4219 the cost of compilation time and memory consumption.  Decreasing usually makes
4220 the compilation faster and less code will be inlined (which presumably
4221 means slower programs).  This option is particularly useful for programs that
4222 use inlining heavily such as those based on recursive templates with C++.
4224 Inlining is actually controlled by a number of parameters, which may be
4225 specified individually by using @option{--param @var{name}=@var{value}}.
4226 The @option{-finline-limit=@var{n}} option sets some of these parameters
4227 as follows:
4229 @table @gcctabopt
4230  @item max-inline-insns-single
4231   is set to @var{n}/2.
4232  @item max-inline-insns-auto
4233   is set to @var{n}/2.
4234  @item min-inline-insns
4235   is set to 130 or @var{n}/4, whichever is smaller.
4236  @item max-inline-insns-rtl
4237   is set to @var{n}.
4238 @end table
4240 See below for a documentation of the individual
4241 parameters controlling inlining.
4243 @emph{Note:} pseudo instruction represents, in this particular context, an
4244 abstract measurement of function's size.  In no way, it represents a count
4245 of assembly instructions and as such its exact meaning might change from one
4246 release to an another.
4248 @item -fkeep-inline-functions
4249 @opindex fkeep-inline-functions
4250 In C, emit @code{static} functions that are declared @code{inline}
4251 into the object file, even if the function has been inlined into all
4252 of its callers.  This switch does not affect functions using the
4253 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4254 inline functions into the object file.
4256 @item -fkeep-static-consts
4257 @opindex fkeep-static-consts
4258 Emit variables declared @code{static const} when optimization isn't turned
4259 on, even if the variables aren't referenced.
4261 GCC enables this option by default.  If you want to force the compiler to
4262 check if the variable was referenced, regardless of whether or not
4263 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4265 @item -fmerge-constants
4266 Attempt to merge identical constants (string constants and floating point
4267 constants) across compilation units.
4269 This option is the default for optimized compilation if the assembler and
4270 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4271 behavior.
4273 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4275 @item -fmerge-all-constants
4276 Attempt to merge identical constants and identical variables.
4278 This option implies @option{-fmerge-constants}.  In addition to
4279 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4280 arrays or initialized constant variables with integral or floating point
4281 types.  Languages like C or C++ require each non-automatic variable to
4282 have distinct location, so using this option will result in non-conforming
4283 behavior.
4285 @item -fmodulo-sched
4286 @opindex fmodulo-sched
4287 Perform swing modulo scheduling immediately before the first scheduling
4288 pass.  This pass looks at innermost loops and reorders their
4289 instructions by overlapping different iterations.
4291 @item -fno-branch-count-reg
4292 @opindex fno-branch-count-reg
4293 Do not use ``decrement and branch'' instructions on a count register,
4294 but instead generate a sequence of instructions that decrement a
4295 register, compare it against zero, then branch based upon the result.
4296 This option is only meaningful on architectures that support such
4297 instructions, which include x86, PowerPC, IA-64 and S/390.
4299 The default is @option{-fbranch-count-reg}, enabled when
4300 @option{-fstrength-reduce} is enabled.
4302 @item -fno-function-cse
4303 @opindex fno-function-cse
4304 Do not put function addresses in registers; make each instruction that
4305 calls a constant function contain the function's address explicitly.
4307 This option results in less efficient code, but some strange hacks
4308 that alter the assembler output may be confused by the optimizations
4309 performed when this option is not used.
4311 The default is @option{-ffunction-cse}
4313 @item -fno-zero-initialized-in-bss
4314 @opindex fno-zero-initialized-in-bss
4315 If the target supports a BSS section, GCC by default puts variables that
4316 are initialized to zero into BSS@.  This can save space in the resulting
4317 code.
4319 This option turns off this behavior because some programs explicitly
4320 rely on variables going to the data section.  E.g., so that the
4321 resulting executable can find the beginning of that section and/or make
4322 assumptions based on that.
4324 The default is @option{-fzero-initialized-in-bss}.
4326 @item -fbounds-check
4327 @opindex fbounds-check
4328 For front-ends that support it, generate additional code to check that
4329 indices used to access arrays are within the declared range.  This is
4330 currently only supported by the Java and Fortran front-ends, where
4331 this option defaults to true and false respectively.
4333 @item -fmudflap -fmudflapth -fmudflapir
4334 @opindex fmudflap
4335 @opindex fmudflapth
4336 @opindex fmudflapir
4337 @cindex bounds checking
4338 @cindex mudflap
4339 For front-ends that support it (C and C++), instrument all risky
4340 pointer/array dereferencing operations, some standard library
4341 string/heap functions, and some other associated constructs with
4342 range/validity tests.  Modules so instrumented should be immune to
4343 buffer overflows, invalid heap use, and some other classes of C/C++
4344 programming errors.  The instrumentation relies on a separate runtime
4345 library (@file{libmudflap}), which will be linked into a program if
4346 @option{-fmudflap} is given at link time.  Run-time behavior of the
4347 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4348 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4349 for its options.
4351 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4352 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4353 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4354 instrumentation should ignore pointer reads.  This produces less
4355 instrumentation (and therefore faster execution) and still provides
4356 some protection against outright memory corrupting writes, but allows
4357 erroneously read data to propagate within a program.
4359 @item -fstrength-reduce
4360 @opindex fstrength-reduce
4361 Perform the optimizations of loop strength reduction and
4362 elimination of iteration variables.
4364 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4366 @item -fthread-jumps
4367 @opindex fthread-jumps
4368 Perform optimizations where we check to see if a jump branches to a
4369 location where another comparison subsumed by the first is found.  If
4370 so, the first branch is redirected to either the destination of the
4371 second branch or a point immediately following it, depending on whether
4372 the condition is known to be true or false.
4374 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4376 @item -fcse-follow-jumps
4377 @opindex fcse-follow-jumps
4378 In common subexpression elimination, scan through jump instructions
4379 when the target of the jump is not reached by any other path.  For
4380 example, when CSE encounters an @code{if} statement with an
4381 @code{else} clause, CSE will follow the jump when the condition
4382 tested is false.
4384 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4386 @item -fcse-skip-blocks
4387 @opindex fcse-skip-blocks
4388 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4389 follow jumps which conditionally skip over blocks.  When CSE
4390 encounters a simple @code{if} statement with no else clause,
4391 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4392 body of the @code{if}.
4394 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4396 @item -frerun-cse-after-loop
4397 @opindex frerun-cse-after-loop
4398 Re-run common subexpression elimination after loop optimizations has been
4399 performed.
4401 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4403 @item -frerun-loop-opt
4404 @opindex frerun-loop-opt
4405 Run the loop optimizer twice.
4407 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4409 @item -fgcse
4410 @opindex fgcse
4411 Perform a global common subexpression elimination pass.
4412 This pass also performs global constant and copy propagation.
4414 @emph{Note:} When compiling a program using computed gotos, a GCC
4415 extension, you may get better runtime performance if you disable
4416 the global common subexpression elimination pass by adding
4417 @option{-fno-gcse} to the command line.
4419 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4421 @item -fgcse-lm
4422 @opindex fgcse-lm
4423 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4424 attempt to move loads which are only killed by stores into themselves.  This
4425 allows a loop containing a load/store sequence to be changed to a load outside
4426 the loop, and a copy/store within the loop.
4428 Enabled by default when gcse is enabled.
4430 @item -fgcse-sm
4431 @opindex fgcse-sm
4432 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4433 global common subexpression elimination.  This pass will attempt to move
4434 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4435 loops containing a load/store sequence can be changed to a load before
4436 the loop and a store after the loop.
4438 Enabled by default when gcse is enabled.
4440 @item -fgcse-las
4441 @opindex fgcse-las
4442 When @option{-fgcse-las} is enabled, the global common subexpression
4443 elimination pass eliminates redundant loads that come after stores to the
4444 same memory location (both partial and full redundancies).
4446 Enabled by default when gcse is enabled.
4448 @item -fgcse-after-reload
4449 @opindex fgcse-after-reload
4450 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4451 pass is performed after reload.  The purpose of this pass is to cleanup
4452 redundant spilling.
4454 @item -floop-optimize
4455 @opindex floop-optimize
4456 Perform loop optimizations: move constant expressions out of loops, simplify
4457 exit test conditions and optionally do strength-reduction as well.
4459 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4461 @item -floop-optimize2
4462 @opindex floop-optimize2
4463 Perform loop optimizations using the new loop optimizer.  The optimizations
4464 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4465 by separate flags.
4467 @item -fcrossjumping
4468 @opindex crossjumping
4469 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4470 resulting code may or may not perform better than without cross-jumping.
4472 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4474 @item -fif-conversion
4475 @opindex if-conversion
4476 Attempt to transform conditional jumps into branch-less equivalents.  This
4477 include use of conditional moves, min, max, set flags and abs instructions, and
4478 some tricks doable by standard arithmetics.  The use of conditional execution
4479 on chips where it is available is controlled by @code{if-conversion2}.
4481 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4483 @item -fif-conversion2
4484 @opindex if-conversion2
4485 Use conditional execution (where available) to transform conditional jumps into
4486 branch-less equivalents.
4488 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4490 @item -fdelete-null-pointer-checks
4491 @opindex fdelete-null-pointer-checks
4492 Use global dataflow analysis to identify and eliminate useless checks
4493 for null pointers.  The compiler assumes that dereferencing a null
4494 pointer would have halted the program.  If a pointer is checked after
4495 it has already been dereferenced, it cannot be null.
4497 In some environments, this assumption is not true, and programs can
4498 safely dereference null pointers.  Use
4499 @option{-fno-delete-null-pointer-checks} to disable this optimization
4500 for programs which depend on that behavior.
4502 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4504 @item -fexpensive-optimizations
4505 @opindex fexpensive-optimizations
4506 Perform a number of minor optimizations that are relatively expensive.
4508 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4510 @item -foptimize-register-move
4511 @itemx -fregmove
4512 @opindex foptimize-register-move
4513 @opindex fregmove
4514 Attempt to reassign register numbers in move instructions and as
4515 operands of other simple instructions in order to maximize the amount of
4516 register tying.  This is especially helpful on machines with two-operand
4517 instructions.
4519 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4520 optimization.
4522 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4524 @item -fdelayed-branch
4525 @opindex fdelayed-branch
4526 If supported for the target machine, attempt to reorder instructions
4527 to exploit instruction slots available after delayed branch
4528 instructions.
4530 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4532 @item -fschedule-insns
4533 @opindex fschedule-insns
4534 If supported for the target machine, attempt to reorder instructions to
4535 eliminate execution stalls due to required data being unavailable.  This
4536 helps machines that have slow floating point or memory load instructions
4537 by allowing other instructions to be issued until the result of the load
4538 or floating point instruction is required.
4540 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4542 @item -fschedule-insns2
4543 @opindex fschedule-insns2
4544 Similar to @option{-fschedule-insns}, but requests an additional pass of
4545 instruction scheduling after register allocation has been done.  This is
4546 especially useful on machines with a relatively small number of
4547 registers and where memory load instructions take more than one cycle.
4549 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4551 @item -fno-sched-interblock
4552 @opindex fno-sched-interblock
4553 Don't schedule instructions across basic blocks.  This is normally
4554 enabled by default when scheduling before register allocation, i.e.@:
4555 with @option{-fschedule-insns} or at @option{-O2} or higher.
4557 @item -fno-sched-spec
4558 @opindex fno-sched-spec
4559 Don't allow speculative motion of non-load instructions.  This is normally
4560 enabled by default when scheduling before register allocation, i.e.@:
4561 with @option{-fschedule-insns} or at @option{-O2} or higher.
4563 @item -fsched-spec-load
4564 @opindex fsched-spec-load
4565 Allow speculative motion of some load instructions.  This only makes
4566 sense when scheduling before register allocation, i.e.@: with
4567 @option{-fschedule-insns} or at @option{-O2} or higher.
4569 @item -fsched-spec-load-dangerous
4570 @opindex fsched-spec-load-dangerous
4571 Allow speculative motion of more load instructions.  This only makes
4572 sense when scheduling before register allocation, i.e.@: with
4573 @option{-fschedule-insns} or at @option{-O2} or higher.
4575 @item -fsched-stalled-insns=@var{n}
4576 @opindex fsched-stalled-insns
4577 Define how many insns (if any) can be moved prematurely from the queue
4578 of stalled insns into the ready list, during the second scheduling pass.
4580 @item -fsched-stalled-insns-dep=@var{n}
4581 @opindex fsched-stalled-insns-dep
4582 Define how many insn groups (cycles) will be examined for a dependency
4583 on a stalled insn that is candidate for premature removal from the queue
4584 of stalled insns.  Has an effect only during the second scheduling pass,
4585 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4587 @item -fsched2-use-superblocks
4588 @opindex fsched2-use-superblocks
4589 When scheduling after register allocation, do use superblock scheduling
4590 algorithm.  Superblock scheduling allows motion across basic block boundaries
4591 resulting on faster schedules.  This option is experimental, as not all machine
4592 descriptions used by GCC model the CPU closely enough to avoid unreliable
4593 results from the algorithm.
4595 This only makes sense when scheduling after register allocation, i.e.@: with
4596 @option{-fschedule-insns2} or at @option{-O2} or higher.
4598 @item -fsched2-use-traces
4599 @opindex fsched2-use-traces
4600 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4601 allocation and additionally perform code duplication in order to increase the
4602 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4603 trace formation.
4605 This mode should produce faster but significantly longer programs.  Also
4606 without @option{-fbranch-probabilities} the traces constructed may not
4607 match the reality and hurt the performance.  This only makes
4608 sense when scheduling after register allocation, i.e.@: with
4609 @option{-fschedule-insns2} or at @option{-O2} or higher.
4611 @item -freschedule-modulo-scheduled-loops
4612 @opindex fscheduling-in-modulo-scheduled-loops
4613 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4614 we may want to prevent the later scheduling passes from changing its schedule, we use this
4615 option to control that.
4617 @item -fcaller-saves
4618 @opindex fcaller-saves
4619 Enable values to be allocated in registers that will be clobbered by
4620 function calls, by emitting extra instructions to save and restore the
4621 registers around such calls.  Such allocation is done only when it
4622 seems to result in better code than would otherwise be produced.
4624 This option is always enabled by default on certain machines, usually
4625 those which have no call-preserved registers to use instead.
4627 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4629 @item -ftree-pre
4630 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4631 enabled by default at @option{-O} and higher.
4633 @item -ftree-fre
4634 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4635 between FRE and PRE is that FRE only considers expressions
4636 that are computed on all paths leading to the redundant computation.
4637 This analysis faster than PRE, though it exposes fewer redundancies.
4638 This flag is enabled by default at @option{-O} and higher.
4640 @item -ftree-ccp
4641 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4642 is enabled by default at @option{-O} and higher.
4644 @item -ftree-dce
4645 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4646 default at @option{-O} and higher.
4648 @item -ftree-dominator-opts
4649 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4650 default at @option{-O} and higher.
4652 @item -ftree-ch
4653 Perform loop header copying on trees.  This is beneficial since it increases
4654 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4655 is enabled by default at @option{-O} and higher.  It is not enabled
4656 for @option{-Os}, since it usually increases code size.
4658 @item -ftree-loop-optimize
4659 Perform loop optimizations on trees.  This flag is enabled by default
4660 at @option{-O} and higher.
4662 @item -ftree-loop-linear
4663 Perform linear loop transformations on tree.  This flag can improve cache
4664 performance and allow further loop optimizations to take place.
4666 @item -ftree-lim
4667 Perform loop invariant motion on trees.  This pass moves only invartiants that
4668 would be hard to handle on rtl level (function calls, operations that expand to
4669 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4670 operands of conditions that are invariant out of the loop, so that we can use
4671 just trivial invariantness analysis in loop unswitching.  The pass also includes
4672 store motion.
4674 @item -fivcanon
4675 Create a canonical counter for number of iterations in the loop for that
4676 determining number of iterations requires complicated analysis.  Later
4677 optimizations then may determine the number easily.  Useful especially
4678 in connection with unrolling.
4680 @item -fivopts
4681 Perform induction variable optimizations (strength reduction, induction
4682 variable merging and induction variable elimination) on trees.
4684 @item -ftree-sra
4685 Perform scalar replacement of aggregates.  This pass replaces structure
4686 references with scalars to prevent committing structures to memory too
4687 early.  This flag is enabled by default at @option{-O} and higher.
4689 @item -ftree-copyrename
4690 Perform copy renaming on trees.  This pass attempts to rename compiler
4691 temporaries to other variables at copy locations, usually resulting in
4692 variable names which more closely resemble the original variables.  This flag
4693 is enabled by default at @option{-O} and higher.
4695 @item -ftree-ter
4696 Perform temporary expression replacement during the SSA->normal phase.  Single
4697 use/single def temporaries are replaced at their use location with their
4698 defining expression.  This results in non-GIMPLE code, but gives the expanders
4699 much more complex trees to work on resulting in better RTL generation.  This is
4700 enabled by default at @option{-O} and higher.
4702 @item -ftree-lrs
4703 Perform live range splitting during the SSA->normal phase.  Distinct live
4704 ranges of a variable are split into unique variables, allowing for better
4705 optimization later.  This is enabled by default at @option{-O} and higher.
4707 @item -ftree-vectorize
4708 Perform loop vectorization on trees.
4710 @item -ftracer
4711 @opindex ftracer
4712 Perform tail duplication to enlarge superblock size.  This transformation
4713 simplifies the control flow of the function allowing other optimizations to do
4714 better job.
4716 @item -funroll-loops
4717 @opindex funroll-loops
4718 Unroll loops whose number of iterations can be determined at compile
4719 time or upon entry to the loop.  @option{-funroll-loops} implies both
4720 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4721 option makes code larger, and may or may not make it run faster.
4723 @item -funroll-all-loops
4724 @opindex funroll-all-loops
4725 Unroll all loops, even if their number of iterations is uncertain when
4726 the loop is entered.  This usually makes programs run more slowly.
4727 @option{-funroll-all-loops} implies the same options as
4728 @option{-funroll-loops},
4730 @item -fsplit-ivs-in-unroller
4731 @opindex -fsplit-ivs-in-unroller
4732 Enables expressing of values of induction variables in later iterations
4733 of the unrolled loop using the value in the first iteration.  This breaks
4734 long dependency chains, thus improving efficiency of the scheduling passes
4735 (for best results, @option{-fweb} should be used as well).
4737 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4738 same effect.  However in cases the loop body is more complicated than
4739 a single basic block, this is not reliable.  It also does not work at all
4740 on some of the architectures due to restrictions in the CSE pass.
4742 This optimization is enabled by default.
4744 @item -fvariable-expansion-in-unroller
4745 @opindex -fvariable-expansion-in-unroller
4746 With this option, the compiler will create multiple copies of some
4747 local variables when unrolling a loop which can result in superior code.
4749 @item -fprefetch-loop-arrays
4750 @opindex fprefetch-loop-arrays
4751 If supported by the target machine, generate instructions to prefetch
4752 memory to improve the performance of loops that access large arrays.
4754 These options may generate better or worse code; results are highly
4755 dependent on the structure of loops within the source code.
4757 @item -fno-peephole
4758 @itemx -fno-peephole2
4759 @opindex fno-peephole
4760 @opindex fno-peephole2
4761 Disable any machine-specific peephole optimizations.  The difference
4762 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4763 are implemented in the compiler; some targets use one, some use the
4764 other, a few use both.
4766 @option{-fpeephole} is enabled by default.
4767 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4769 @item -fno-guess-branch-probability
4770 @opindex fno-guess-branch-probability
4771 Do not guess branch probabilities using heuristics.
4773 GCC will use heuristics to guess branch probabilities if they are
4774 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4775 heuristics are based on the control flow graph.  If some branch probabilities
4776 are specified by @samp{__builtin_expect}, then the heuristics will be
4777 used to guess branch probabilities for the rest of the control flow graph,
4778 taking the @samp{__builtin_expect} info into account.  The interactions
4779 between the heuristics and @samp{__builtin_expect} can be complex, and in
4780 some cases, it may be useful to disable the heuristics so that the effects
4781 of @samp{__builtin_expect} are easier to understand.
4783 The default is @option{-fguess-branch-probability} at levels
4784 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4786 @item -freorder-blocks
4787 @opindex freorder-blocks
4788 Reorder basic blocks in the compiled function in order to reduce number of
4789 taken branches and improve code locality.
4791 Enabled at levels @option{-O2}, @option{-O3}.
4793 @item -freorder-blocks-and-partition
4794 @opindex freorder-blocks-and-partition
4795 In addition to reordering basic blocks in the compiled function, in order
4796 to reduce number of taken branches, partitions hot and cold basic blocks
4797 into separate sections of the assembly and .o files, to improve
4798 paging and cache locality performance.
4800 This optimization is automatically turned off in the presence of
4801 exception handling, for linkonce sections, for functions with a user-defined
4802 section attribute and on any architecture that does not support named
4803 sections.
4805 @item -freorder-functions
4806 @opindex freorder-functions
4807 Reorder basic blocks in the compiled function in order to reduce number of
4808 taken branches and improve code locality.  This is implemented by using special
4809 subsections @code{.text.hot} for most frequently executed functions and
4810 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4811 the linker so object file format must support named sections and linker must
4812 place them in a reasonable way.
4814 Also profile feedback must be available in to make this option effective.  See
4815 @option{-fprofile-arcs} for details.
4817 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4819 @item -fstrict-aliasing
4820 @opindex fstrict-aliasing
4821 Allows the compiler to assume the strictest aliasing rules applicable to
4822 the language being compiled.  For C (and C++), this activates
4823 optimizations based on the type of expressions.  In particular, an
4824 object of one type is assumed never to reside at the same address as an
4825 object of a different type, unless the types are almost the same.  For
4826 example, an @code{unsigned int} can alias an @code{int}, but not a
4827 @code{void*} or a @code{double}.  A character type may alias any other
4828 type.
4830 Pay special attention to code like this:
4831 @smallexample
4832 union a_union @{
4833   int i;
4834   double d;
4837 int f() @{
4838   a_union t;
4839   t.d = 3.0;
4840   return t.i;
4842 @end smallexample
4843 The practice of reading from a different union member than the one most
4844 recently written to (called ``type-punning'') is common.  Even with
4845 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4846 is accessed through the union type.  So, the code above will work as
4847 expected.  However, this code might not:
4848 @smallexample
4849 int f() @{
4850   a_union t;
4851   int* ip;
4852   t.d = 3.0;
4853   ip = &t.i;
4854   return *ip;
4856 @end smallexample
4858 Every language that wishes to perform language-specific alias analysis
4859 should define a function that computes, given an @code{tree}
4860 node, an alias set for the node.  Nodes in different alias sets are not
4861 allowed to alias.  For an example, see the C front-end function
4862 @code{c_get_alias_set}.
4864 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4866 @item -falign-functions
4867 @itemx -falign-functions=@var{n}
4868 @opindex falign-functions
4869 Align the start of functions to the next power-of-two greater than
4870 @var{n}, skipping up to @var{n} bytes.  For instance,
4871 @option{-falign-functions=32} aligns functions to the next 32-byte
4872 boundary, but @option{-falign-functions=24} would align to the next
4873 32-byte boundary only if this can be done by skipping 23 bytes or less.
4875 @option{-fno-align-functions} and @option{-falign-functions=1} are
4876 equivalent and mean that functions will not be aligned.
4878 Some assemblers only support this flag when @var{n} is a power of two;
4879 in that case, it is rounded up.
4881 If @var{n} is not specified or is zero, use a machine-dependent default.
4883 Enabled at levels @option{-O2}, @option{-O3}.
4885 @item -falign-labels
4886 @itemx -falign-labels=@var{n}
4887 @opindex falign-labels
4888 Align all branch targets to a power-of-two boundary, skipping up to
4889 @var{n} bytes like @option{-falign-functions}.  This option can easily
4890 make code slower, because it must insert dummy operations for when the
4891 branch target is reached in the usual flow of the code.
4893 @option{-fno-align-labels} and @option{-falign-labels=1} are
4894 equivalent and mean that labels will not be aligned.
4896 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4897 are greater than this value, then their values are used instead.
4899 If @var{n} is not specified or is zero, use a machine-dependent default
4900 which is very likely to be @samp{1}, meaning no alignment.
4902 Enabled at levels @option{-O2}, @option{-O3}.
4904 @item -falign-loops
4905 @itemx -falign-loops=@var{n}
4906 @opindex falign-loops
4907 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4908 like @option{-falign-functions}.  The hope is that the loop will be
4909 executed many times, which will make up for any execution of the dummy
4910 operations.
4912 @option{-fno-align-loops} and @option{-falign-loops=1} are
4913 equivalent and mean that loops will not be aligned.
4915 If @var{n} is not specified or is zero, use a machine-dependent default.
4917 Enabled at levels @option{-O2}, @option{-O3}.
4919 @item -falign-jumps
4920 @itemx -falign-jumps=@var{n}
4921 @opindex falign-jumps
4922 Align branch targets to a power-of-two boundary, for branch targets
4923 where the targets can only be reached by jumping, skipping up to @var{n}
4924 bytes like @option{-falign-functions}.  In this case, no dummy operations
4925 need be executed.
4927 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4928 equivalent and mean that loops will not be aligned.
4930 If @var{n} is not specified or is zero, use a machine-dependent default.
4932 Enabled at levels @option{-O2}, @option{-O3}.
4934 @item -funit-at-a-time
4935 @opindex funit-at-a-time
4936 Parse the whole compilation unit before starting to produce code.
4937 This allows some extra optimizations to take place but consumes
4938 more memory (in general).  There are some compatibility issues
4939 with @emph{unit-at-at-time} mode:
4940 @itemize @bullet
4941 @item
4942 enabling @emph{unit-at-a-time} mode may change the order
4943 in which functions, variables, and top-level @code{asm} statements
4944 are emitted, and will likely break code relying on some particular
4945 ordering.  The majority of such top-level @code{asm} statements,
4946 though, can be replaced by @code{section} attributes.
4948 @item
4949 @emph{unit-at-a-time} mode removes unreferenced static variables
4950 and functions are removed.  This may result in undefined references
4951 when an @code{asm} statement refers directly to variables or functions
4952 that are otherwise unused.  In that case either the variable/function
4953 shall be listed as an operand of the @code{asm} statement operand or,
4954 in the case of top-level @code{asm} statements the attribute @code{used}
4955 shall be used on the declaration.
4957 @item
4958 Static functions now can use non-standard passing conventions that
4959 may break @code{asm} statements calling functions directly.  Again,
4960 attribute @code{used} will prevent this behavior.
4961 @end itemize
4963 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4964 but this scheme may not be supported by future releases of GCC@.
4966 Enabled at levels @option{-O2}, @option{-O3}.
4968 @item -fweb
4969 @opindex fweb
4970 Constructs webs as commonly used for register allocation purposes and assign
4971 each web individual pseudo register.  This allows the register allocation pass
4972 to operate on pseudos directly, but also strengthens several other optimization
4973 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4974 however, make debugging impossible, since variables will no longer stay in a
4975 ``home register''.
4977 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4978 on targets where the default format for debugging information supports
4979 variable tracking.
4981 @item -fno-cprop-registers
4982 @opindex fno-cprop-registers
4983 After register allocation and post-register allocation instruction splitting,
4984 we perform a copy-propagation pass to try to reduce scheduling dependencies
4985 and occasionally eliminate the copy.
4987 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4989 @item -fprofile-generate
4990 @opindex fprofile-generate
4992 Enable options usually used for instrumenting application to produce
4993 profile useful for later recompilation with profile feedback based
4994 optimization.  You must use @option{-fprofile-generate} both when
4995 compiling and when linking your program.
4997 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4999 @item -fprofile-use
5000 @opindex fprofile-use
5001 Enable profile feedback directed optimizations, and optimizations
5002 generally profitable only with profile feedback available.
5004 The following options are enabled: @code{-fbranch-probabilities},
5005 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5007 @end table
5009 The following options control compiler behavior regarding floating
5010 point arithmetic.  These options trade off between speed and
5011 correctness.  All must be specifically enabled.
5013 @table @gcctabopt
5014 @item -ffloat-store
5015 @opindex ffloat-store
5016 Do not store floating point variables in registers, and inhibit other
5017 options that might change whether a floating point value is taken from a
5018 register or memory.
5020 @cindex floating point precision
5021 This option prevents undesirable excess precision on machines such as
5022 the 68000 where the floating registers (of the 68881) keep more
5023 precision than a @code{double} is supposed to have.  Similarly for the
5024 x86 architecture.  For most programs, the excess precision does only
5025 good, but a few programs rely on the precise definition of IEEE floating
5026 point.  Use @option{-ffloat-store} for such programs, after modifying
5027 them to store all pertinent intermediate computations into variables.
5029 @item -ffast-math
5030 @opindex ffast-math
5031 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5032 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5033 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
5035 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5037 This option should never be turned on by any @option{-O} option since
5038 it can result in incorrect output for programs which depend on
5039 an exact implementation of IEEE or ISO rules/specifications for
5040 math functions.
5042 @item -fno-math-errno
5043 @opindex fno-math-errno
5044 Do not set ERRNO after calling math functions that are executed
5045 with a single instruction, e.g., sqrt.  A program that relies on
5046 IEEE exceptions for math error handling may want to use this flag
5047 for speed while maintaining IEEE arithmetic compatibility.
5049 This option should never be turned on by any @option{-O} option since
5050 it can result in incorrect output for programs which depend on
5051 an exact implementation of IEEE or ISO rules/specifications for
5052 math functions.
5054 The default is @option{-fmath-errno}.
5056 @item -funsafe-math-optimizations
5057 @opindex funsafe-math-optimizations
5058 Allow optimizations for floating-point arithmetic that (a) assume
5059 that arguments and results are valid and (b) may violate IEEE or
5060 ANSI standards.  When used at link-time, it may include libraries
5061 or startup files that change the default FPU control word or other
5062 similar optimizations.
5064 This option should never be turned on by any @option{-O} option since
5065 it can result in incorrect output for programs which depend on
5066 an exact implementation of IEEE or ISO rules/specifications for
5067 math functions.
5069 The default is @option{-fno-unsafe-math-optimizations}.
5071 @item -ffinite-math-only
5072 @opindex ffinite-math-only
5073 Allow optimizations for floating-point arithmetic that assume
5074 that arguments and results are not NaNs or +-Infs.
5076 This option should never be turned on by any @option{-O} option since
5077 it can result in incorrect output for programs which depend on
5078 an exact implementation of IEEE or ISO rules/specifications.
5080 The default is @option{-fno-finite-math-only}.
5082 @item -fno-trapping-math
5083 @opindex fno-trapping-math
5084 Compile code assuming that floating-point operations cannot generate
5085 user-visible traps.  These traps include division by zero, overflow,
5086 underflow, inexact result and invalid operation.  This option implies
5087 @option{-fno-signaling-nans}.  Setting this option may allow faster
5088 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5090 This option should never be turned on by any @option{-O} option since
5091 it can result in incorrect output for programs which depend on
5092 an exact implementation of IEEE or ISO rules/specifications for
5093 math functions.
5095 The default is @option{-ftrapping-math}.
5097 @item -frounding-math
5098 @opindex frounding-math
5099 Disable transformations and optimizations that assume default floating
5100 point rounding behavior.  This is round-to-zero for all floating point
5101 to integer conversions, and round-to-nearest for all other arithmetic
5102 truncations.  This option should be specified for programs that change
5103 the FP rounding mode dynamically, or that may be executed with a
5104 non-default rounding mode.  This option disables constant folding of
5105 floating point expressions at compile-time (which may be affected by
5106 rounding mode) and arithmetic transformations that are unsafe in the
5107 presence of sign-dependent rounding modes.
5109 The default is @option{-fno-rounding-math}.
5111 This option is experimental and does not currently guarantee to
5112 disable all GCC optimizations that are affected by rounding mode.
5113 Future versions of GCC may provide finer control of this setting
5114 using C99's @code{FENV_ACCESS} pragma.  This command line option
5115 will be used to specify the default state for @code{FENV_ACCESS}.
5117 @item -fsignaling-nans
5118 @opindex fsignaling-nans
5119 Compile code assuming that IEEE signaling NaNs may generate user-visible
5120 traps during floating-point operations.  Setting this option disables
5121 optimizations that may change the number of exceptions visible with
5122 signaling NaNs.  This option implies @option{-ftrapping-math}.
5124 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5125 be defined.
5127 The default is @option{-fno-signaling-nans}.
5129 This option is experimental and does not currently guarantee to
5130 disable all GCC optimizations that affect signaling NaN behavior.
5132 @item -fsingle-precision-constant
5133 @opindex fsingle-precision-constant
5134 Treat floating point constant as single precision constant instead of
5135 implicitly converting it to double precision constant.
5138 @end table
5140 The following options control optimizations that may improve
5141 performance, but are not enabled by any @option{-O} options.  This
5142 section includes experimental options that may produce broken code.
5144 @table @gcctabopt
5145 @item -fbranch-probabilities
5146 @opindex fbranch-probabilities
5147 After running a program compiled with @option{-fprofile-arcs}
5148 (@pxref{Debugging Options,, Options for Debugging Your Program or
5149 @command{gcc}}), you can compile it a second time using
5150 @option{-fbranch-probabilities}, to improve optimizations based on
5151 the number of times each branch was taken.  When the program
5152 compiled with @option{-fprofile-arcs} exits it saves arc execution
5153 counts to a file called @file{@var{sourcename}.gcda} for each source
5154 file  The information in this data file is very dependent on the
5155 structure of the generated code, so you must use the same source code
5156 and the same optimization options for both compilations.
5158 With @option{-fbranch-probabilities}, GCC puts a
5159 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5160 These can be used to improve optimization.  Currently, they are only
5161 used in one place: in @file{reorg.c}, instead of guessing which path a
5162 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5163 exactly determine which path is taken more often.
5165 @item -fprofile-values
5166 @opindex fprofile-values
5167 If combined with @option{-fprofile-arcs}, it adds code so that some
5168 data about values of expressions in the program is gathered.
5170 With @option{-fbranch-probabilities}, it reads back the data gathered
5171 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5172 notes to instructions for their later usage in optimizations.
5174 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5176 @item -fvpt
5177 @opindex fvpt
5178 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5179 a code to gather information about values of expressions.
5181 With @option{-fbranch-probabilities}, it reads back the data gathered
5182 and actually performs the optimizations based on them.
5183 Currently the optimizations include specialization of division operation
5184 using the knowledge about the value of the denominator.
5186 @item -fspeculative-prefetching
5187 @opindex fspeculative-prefetching
5188 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5189 a code to gather information about addresses of memory references in the
5190 program.
5192 With @option{-fbranch-probabilities}, it reads back the data gathered
5193 and issues prefetch instructions according to them.  In addition to the opportunities
5194 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5195 memory access patterns---for example accesses to the data stored in linked
5196 list whose elements are usually allocated sequentially.
5198 In order to prevent issuing double prefetches, usage of
5199 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5201 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5203 @item -frename-registers
5204 @opindex frename-registers
5205 Attempt to avoid false dependencies in scheduled code by making use
5206 of registers left over after register allocation.  This optimization
5207 will most benefit processors with lots of registers.  Depending on the
5208 debug information format adopted by the target, however, it can
5209 make debugging impossible, since variables will no longer stay in
5210 a ``home register''.
5212 Not enabled by default at any level because it has known bugs.
5214 @item -ftracer
5215 @opindex ftracer
5216 Perform tail duplication to enlarge superblock size.  This transformation
5217 simplifies the control flow of the function allowing other optimizations to do
5218 better job.
5220 Enabled with @option{-fprofile-use}.
5222 @item -funroll-loops
5223 @opindex funroll-loops
5224 Unroll loops whose number of iterations can be determined at compile time or
5225 upon entry to the loop.  @option{-funroll-loops} implies
5226 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5227 (i.e.@: complete removal of loops with small constant number of iterations).
5228 This option makes code larger, and may or may not make it run faster.
5230 Enabled with @option{-fprofile-use}.
5232 @item -funroll-all-loops
5233 @opindex funroll-all-loops
5234 Unroll all loops, even if their number of iterations is uncertain when
5235 the loop is entered.  This usually makes programs run more slowly.
5236 @option{-funroll-all-loops} implies the same options as
5237 @option{-funroll-loops}.
5239 @item -fpeel-loops
5240 @opindex fpeel-loops
5241 Peels the loops for that there is enough information that they do not
5242 roll much (from profile feedback).  It also turns on complete loop peeling
5243 (i.e.@: complete removal of loops with small constant number of iterations).
5245 Enabled with @option{-fprofile-use}.
5247 @item -fmove-loop-invariants
5248 @opindex fmove-loop-invariants
5249 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5250 at level @option{-O1}
5252 @item -funswitch-loops
5253 @opindex funswitch-loops
5254 Move branches with loop invariant conditions out of the loop, with duplicates
5255 of the loop on both branches (modified according to result of the condition).
5257 @item -fprefetch-loop-arrays
5258 @opindex fprefetch-loop-arrays
5259 If supported by the target machine, generate instructions to prefetch
5260 memory to improve the performance of loops that access large arrays.
5262 Disabled at level @option{-Os}.
5264 @item -ffunction-sections
5265 @itemx -fdata-sections
5266 @opindex ffunction-sections
5267 @opindex fdata-sections
5268 Place each function or data item into its own section in the output
5269 file if the target supports arbitrary sections.  The name of the
5270 function or the name of the data item determines the section's name
5271 in the output file.
5273 Use these options on systems where the linker can perform optimizations
5274 to improve locality of reference in the instruction space.  Most systems
5275 using the ELF object format and SPARC processors running Solaris 2 have
5276 linkers with such optimizations.  AIX may have these optimizations in
5277 the future.
5279 Only use these options when there are significant benefits from doing
5280 so.  When you specify these options, the assembler and linker will
5281 create larger object and executable files and will also be slower.
5282 You will not be able to use @code{gprof} on all systems if you
5283 specify this option and you may have problems with debugging if
5284 you specify both this option and @option{-g}.
5286 @item -fbranch-target-load-optimize
5287 @opindex fbranch-target-load-optimize
5288 Perform branch target register load optimization before prologue / epilogue
5289 threading.
5290 The use of target registers can typically be exposed only during reload,
5291 thus hoisting loads out of loops and doing inter-block scheduling needs
5292 a separate optimization pass.
5294 @item -fbranch-target-load-optimize2
5295 @opindex fbranch-target-load-optimize2
5296 Perform branch target register load optimization after prologue / epilogue
5297 threading.
5299 @item -fbtr-bb-exclusive
5300 @opindex fbtr-bb-exclusive
5301 When performing branch target register load optimization, don't reuse
5302 branch target registers in within any basic block.
5304 @item --param @var{name}=@var{value}
5305 @opindex param
5306 In some places, GCC uses various constants to control the amount of
5307 optimization that is done.  For example, GCC will not inline functions
5308 that contain more that a certain number of instructions.  You can
5309 control some of these constants on the command-line using the
5310 @option{--param} option.
5312 The names of specific parameters, and the meaning of the values, are
5313 tied to the internals of the compiler, and are subject to change
5314 without notice in future releases.
5316 In each case, the @var{value} is an integer.  The allowable choices for
5317 @var{name} are given in the following table:
5319 @table @gcctabopt
5320 @item sra-max-structure-size
5321 The maximum structure size, in bytes, at which the scalar replacement
5322 of aggregates (SRA) optimization will perform block copies.  The
5323 default value, 0, implies that GCC will select the most appropriate
5324 size itself.
5326 @item sra-field-structure-ratio
5327 The threshold ratio (as a percentage) between instantiated fields and
5328 the complete structure size.  We say that if the ratio of the number
5329 of bytes in instantiated fields to the number of bytes in the complete
5330 structure exceeds this parameter, then block copies are not used.  The
5331 default is 75.
5333 @item max-crossjump-edges
5334 The maximum number of incoming edges to consider for crossjumping.
5335 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5336 the number of edges incoming to each block.  Increasing values mean
5337 more aggressive optimization, making the compile time increase with
5338 probably small improvement in executable size.
5340 @item min-crossjump-insns
5341 The minimum number of instructions which must be matched at the end
5342 of two blocks before crossjumping will be performed on them.  This
5343 value is ignored in the case where all instructions in the block being
5344 crossjumped from are matched.  The default value is 5.
5346 @item max-delay-slot-insn-search
5347 The maximum number of instructions to consider when looking for an
5348 instruction to fill a delay slot.  If more than this arbitrary number of
5349 instructions is searched, the time savings from filling the delay slot
5350 will be minimal so stop searching.  Increasing values mean more
5351 aggressive optimization, making the compile time increase with probably
5352 small improvement in executable run time.
5354 @item max-delay-slot-live-search
5355 When trying to fill delay slots, the maximum number of instructions to
5356 consider when searching for a block with valid live register
5357 information.  Increasing this arbitrarily chosen value means more
5358 aggressive optimization, increasing the compile time.  This parameter
5359 should be removed when the delay slot code is rewritten to maintain the
5360 control-flow graph.
5362 @item max-gcse-memory
5363 The approximate maximum amount of memory that will be allocated in
5364 order to perform the global common subexpression elimination
5365 optimization.  If more memory than specified is required, the
5366 optimization will not be done.
5368 @item max-gcse-passes
5369 The maximum number of passes of GCSE to run.  The default is 1.
5371 @item max-pending-list-length
5372 The maximum number of pending dependencies scheduling will allow
5373 before flushing the current state and starting over.  Large functions
5374 with few branches or calls can create excessively large lists which
5375 needlessly consume memory and resources.
5377 @item max-inline-insns-single
5378 Several parameters control the tree inliner used in gcc.
5379 This number sets the maximum number of instructions (counted in GCC's
5380 internal representation) in a single function that the tree inliner
5381 will consider for inlining.  This only affects functions declared
5382 inline and methods implemented in a class declaration (C++).
5383 The default value is 500.
5385 @item max-inline-insns-auto
5386 When you use @option{-finline-functions} (included in @option{-O3}),
5387 a lot of functions that would otherwise not be considered for inlining
5388 by the compiler will be investigated.  To those functions, a different
5389 (more restrictive) limit compared to functions declared inline can
5390 be applied.
5391 The default value is 120.
5393 @item large-function-insns
5394 The limit specifying really large functions.  For functions larger than this
5395 limit after inlining inlining is constrained by
5396 @option{--param large-function-growth}.  This parameter is useful primarily
5397 to avoid extreme compilation time caused by non-linear algorithms used by the
5398 backend.
5399 This parameter is ignored when @option{-funit-at-a-time} is not used.
5400 The default value is 3000.
5402 @item large-function-growth
5403 Specifies maximal growth of large function caused by inlining in percents.
5404 This parameter is ignored when @option{-funit-at-a-time} is not used.
5405 The default value is 100 which limits large function growth to 2.0 times
5406 the original size.
5408 @item inline-unit-growth
5409 Specifies maximal overall growth of the compilation unit caused by inlining.
5410 This parameter is ignored when @option{-funit-at-a-time} is not used.
5411 The default value is 50 which limits unit growth to 1.5 times the original
5412 size.
5414 @item max-inline-insns-recursive
5415 @itemx max-inline-insns-recursive-auto
5416 Specifies maximum number of instructions out-of-line copy of self recursive inline
5417 function can grow into by performing recursive inlining.
5419 For functions declared inline @option{--param max-inline-insns-recursive} is
5420 taken into acount.  For function not declared inline, recursive inlining
5421 happens only when @option{-finline-functions} (included in @option{-O3}) is
5422 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5423 default value is 500.
5425 @item max-inline-recursive-depth
5426 @itemx max-inline-recursive-depth-auto
5427 Specifies maximum recursion depth used by the recursive inlining.
5429 For functions declared inline @option{--param max-inline-recursive-depth} is
5430 taken into acount.  For function not declared inline, recursive inlining
5431 happens only when @option{-finline-functions} (included in @option{-O3}) is
5432 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5433 default value is 500.
5435 @item max-unrolled-insns
5436 The maximum number of instructions that a loop should have if that loop
5437 is unrolled, and if the loop is unrolled, it determines how many times
5438 the loop code is unrolled.
5440 @item max-average-unrolled-insns
5441 The maximum number of instructions biased by probabilities of their execution
5442 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5443 it determines how many times the loop code is unrolled.
5445 @item max-unroll-times
5446 The maximum number of unrollings of a single loop.
5448 @item max-peeled-insns
5449 The maximum number of instructions that a loop should have if that loop
5450 is peeled, and if the loop is peeled, it determines how many times
5451 the loop code is peeled.
5453 @item max-peel-times
5454 The maximum number of peelings of a single loop.
5456 @item max-completely-peeled-insns
5457 The maximum number of insns of a completely peeled loop.
5459 @item max-completely-peel-times
5460 The maximum number of iterations of a loop to be suitable for complete peeling.
5462 @item max-unswitch-insns
5463 The maximum number of insns of an unswitched loop.
5465 @item max-unswitch-level
5466 The maximum number of branches unswitched in a single loop.
5468 @item lim-expensive
5469 The minimum cost of an expensive expression in the loop invariant motion.
5471 @item iv-consider-all-candidates-bound
5472 Bound on number of candidates for induction variables below that
5473 all candidates are considered for each use in induction variable
5474 optimizations.  Only the most relevant candidates are considered
5475 if there are more candidates, to avoid quadratic time complexity.
5477 @item iv-max-considered-uses
5478 The induction variable optimizations give up on loops that contain more
5479 induction variable uses.
5481 @item iv-always-prune-cand-set-bound
5482 If number of candidates in the set is smaller than this value,
5483 we always try to remove unnecessary ivs from the set during its
5484 optimization when a new iv is added to the set.
5486 @item max-iterations-to-track
5488 The maximum number of iterations of a loop the brute force algorithm
5489 for analysis of # of iterations of the loop tries to evaluate.
5491 @item hot-bb-count-fraction
5492 Select fraction of the maximal count of repetitions of basic block in program
5493 given basic block needs to have to be considered hot.
5495 @item hot-bb-frequency-fraction
5496 Select fraction of the maximal frequency of executions of basic block in
5497 function given basic block needs to have to be considered hot
5499 @item tracer-dynamic-coverage
5500 @itemx tracer-dynamic-coverage-feedback
5502 This value is used to limit superblock formation once the given percentage of
5503 executed instructions is covered.  This limits unnecessary code size
5504 expansion.
5506 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5507 feedback is available.  The real profiles (as opposed to statically estimated
5508 ones) are much less balanced allowing the threshold to be larger value.
5510 @item tracer-max-code-growth
5511 Stop tail duplication once code growth has reached given percentage.  This is
5512 rather hokey argument, as most of the duplicates will be eliminated later in
5513 cross jumping, so it may be set to much higher values than is the desired code
5514 growth.
5516 @item tracer-min-branch-ratio
5518 Stop reverse growth when the reverse probability of best edge is less than this
5519 threshold (in percent).
5521 @item tracer-min-branch-ratio
5522 @itemx tracer-min-branch-ratio-feedback
5524 Stop forward growth if the best edge do have probability lower than this
5525 threshold.
5527 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5528 compilation for profile feedback and one for compilation without.  The value
5529 for compilation with profile feedback needs to be more conservative (higher) in
5530 order to make tracer effective.
5532 @item max-cse-path-length
5534 Maximum number of basic blocks on path that cse considers.  The default is 10.
5536 @item global-var-threshold
5538 Counts the number of function calls (@var{n}) and the number of
5539 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5540 single artificial variable will be created to represent all the
5541 call-clobbered variables at function call sites.  This artificial
5542 variable will then be made to alias every call-clobbered variable.
5543 (done as @code{int * size_t} on the host machine; beware overflow).
5545 @item max-aliased-vops
5547 Maximum number of virtual operands allowed to represent aliases
5548 before triggering the alias grouping heuristic.  Alias grouping
5549 reduces compile times and memory consumption needed for aliasing at
5550 the expense of precision loss in alias information.
5552 @item ggc-min-expand
5554 GCC uses a garbage collector to manage its own memory allocation.  This
5555 parameter specifies the minimum percentage by which the garbage
5556 collector's heap should be allowed to expand between collections.
5557 Tuning this may improve compilation speed; it has no effect on code
5558 generation.
5560 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5561 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5562 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5563 GCC is not able to calculate RAM on a particular platform, the lower
5564 bound of 30% is used.  Setting this parameter and
5565 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5566 every opportunity.  This is extremely slow, but can be useful for
5567 debugging.
5569 @item ggc-min-heapsize
5571 Minimum size of the garbage collector's heap before it begins bothering
5572 to collect garbage.  The first collection occurs after the heap expands
5573 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5574 tuning this may improve compilation speed, and has no effect on code
5575 generation.
5577 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5578 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5579 with a lower bound of 4096 (four megabytes) and an upper bound of
5580 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5581 particular platform, the lower bound is used.  Setting this parameter
5582 very large effectively disables garbage collection.  Setting this
5583 parameter and @option{ggc-min-expand} to zero causes a full collection
5584 to occur at every opportunity.
5586 @item max-reload-search-insns
5587 The maximum number of instruction reload should look backward for equivalent
5588 register.  Increasing values mean more aggressive optimization, making the
5589 compile time increase with probably slightly better performance.  The default
5590 value is 100.
5592 @item max-cselib-memory-location
5593 The maximum number of memory locations cselib should take into acount.
5594 Increasing values mean more aggressive optimization, making the compile time
5595 increase with probably slightly better performance.  The default value is 500.
5597 @item reorder-blocks-duplicate
5598 @itemx reorder-blocks-duplicate-feedback
5600 Used by basic block reordering pass to decide whether to use unconditional
5601 branch or duplicate the code on its destination.  Code is duplicated when its
5602 estimated size is smaller than this value multiplied by the estimated size of
5603 unconditional jump in the hot spots of the program.
5605 The @option{reorder-block-duplicate-feedback} is used only when profile
5606 feedback is available and may be set to higher values than
5607 @option{reorder-block-duplicate} since information about the hot spots is more
5608 accurate.
5610 @item max-sched-region-blocks
5611 The maximum number of blocks in a region to be considered for
5612 interblock scheduling.  The default value is 10.
5614 @item max-sched-region-insns
5615 The maximum number of insns in a region to be considered for
5616 interblock scheduling.  The default value is 100.
5618 @item max-last-value-rtl
5620 The maximum size measured as number of RTLs that can be recorded in an expression
5621 in combiner for a pseudo register as last known value of that register.  The default
5622 is 10000.
5624 @item integer-share-limit
5625 Small integer constants can use a shared data structure, reducing the
5626 compiler's memory usage and increasing its speed.  This sets the maximum
5627 value of a shared integer constant's.  The default value is 256.
5629 @end table
5630 @end table
5632 @node Preprocessor Options
5633 @section Options Controlling the Preprocessor
5634 @cindex preprocessor options
5635 @cindex options, preprocessor
5637 These options control the C preprocessor, which is run on each C source
5638 file before actual compilation.
5640 If you use the @option{-E} option, nothing is done except preprocessing.
5641 Some of these options make sense only together with @option{-E} because
5642 they cause the preprocessor output to be unsuitable for actual
5643 compilation.
5645 @table @gcctabopt
5646 @opindex Wp
5647 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5648 and pass @var{option} directly through to the preprocessor.  If
5649 @var{option} contains commas, it is split into multiple options at the
5650 commas.  However, many options are modified, translated or interpreted
5651 by the compiler driver before being passed to the preprocessor, and
5652 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5653 interface is undocumented and subject to change, so whenever possible
5654 you should avoid using @option{-Wp} and let the driver handle the
5655 options instead.
5657 @item -Xpreprocessor @var{option}
5658 @opindex preprocessor
5659 Pass @var{option} as an option to the preprocessor.  You can use this to
5660 supply system-specific preprocessor options which GCC does not know how to
5661 recognize.
5663 If you want to pass an option that takes an argument, you must use
5664 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5665 @end table
5667 @include cppopts.texi
5669 @node Assembler Options
5670 @section Passing Options to the Assembler
5672 @c prevent bad page break with this line
5673 You can pass options to the assembler.
5675 @table @gcctabopt
5676 @item -Wa,@var{option}
5677 @opindex Wa
5678 Pass @var{option} as an option to the assembler.  If @var{option}
5679 contains commas, it is split into multiple options at the commas.
5681 @item -Xassembler @var{option}
5682 @opindex Xassembler
5683 Pass @var{option} as an option to the assembler.  You can use this to
5684 supply system-specific assembler options which GCC does not know how to
5685 recognize.
5687 If you want to pass an option that takes an argument, you must use
5688 @option{-Xassembler} twice, once for the option and once for the argument.
5690 @end table
5692 @node Link Options
5693 @section Options for Linking
5694 @cindex link options
5695 @cindex options, linking
5697 These options come into play when the compiler links object files into
5698 an executable output file.  They are meaningless if the compiler is
5699 not doing a link step.
5701 @table @gcctabopt
5702 @cindex file names
5703 @item @var{object-file-name}
5704 A file name that does not end in a special recognized suffix is
5705 considered to name an object file or library.  (Object files are
5706 distinguished from libraries by the linker according to the file
5707 contents.)  If linking is done, these object files are used as input
5708 to the linker.
5710 @item -c
5711 @itemx -S
5712 @itemx -E
5713 @opindex c
5714 @opindex S
5715 @opindex E
5716 If any of these options is used, then the linker is not run, and
5717 object file names should not be used as arguments.  @xref{Overall
5718 Options}.
5720 @cindex Libraries
5721 @item -l@var{library}
5722 @itemx -l @var{library}
5723 @opindex l
5724 Search the library named @var{library} when linking.  (The second
5725 alternative with the library as a separate argument is only for
5726 POSIX compliance and is not recommended.)
5728 It makes a difference where in the command you write this option; the
5729 linker searches and processes libraries and object files in the order they
5730 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5731 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5732 to functions in @samp{z}, those functions may not be loaded.
5734 The linker searches a standard list of directories for the library,
5735 which is actually a file named @file{lib@var{library}.a}.  The linker
5736 then uses this file as if it had been specified precisely by name.
5738 The directories searched include several standard system directories
5739 plus any that you specify with @option{-L}.
5741 Normally the files found this way are library files---archive files
5742 whose members are object files.  The linker handles an archive file by
5743 scanning through it for members which define symbols that have so far
5744 been referenced but not defined.  But if the file that is found is an
5745 ordinary object file, it is linked in the usual fashion.  The only
5746 difference between using an @option{-l} option and specifying a file name
5747 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5748 and searches several directories.
5750 @item -lobjc
5751 @opindex lobjc
5752 You need this special case of the @option{-l} option in order to
5753 link an Objective-C or Objective-C++ program.
5755 @item -nostartfiles
5756 @opindex nostartfiles
5757 Do not use the standard system startup files when linking.
5758 The standard system libraries are used normally, unless @option{-nostdlib}
5759 or @option{-nodefaultlibs} is used.
5761 @item -nodefaultlibs
5762 @opindex nodefaultlibs
5763 Do not use the standard system libraries when linking.
5764 Only the libraries you specify will be passed to the linker.
5765 The standard startup files are used normally, unless @option{-nostartfiles}
5766 is used.  The compiler may generate calls to @code{memcmp},
5767 @code{memset}, @code{memcpy} and @code{memmove}.
5768 These entries are usually resolved by entries in
5769 libc.  These entry points should be supplied through some other
5770 mechanism when this option is specified.
5772 @item -nostdlib
5773 @opindex nostdlib
5774 Do not use the standard system startup files or libraries when linking.
5775 No startup files and only the libraries you specify will be passed to
5776 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5777 @code{memcpy} and @code{memmove}.
5778 These entries are usually resolved by entries in
5779 libc.  These entry points should be supplied through some other
5780 mechanism when this option is specified.
5782 @cindex @option{-lgcc}, use with @option{-nostdlib}
5783 @cindex @option{-nostdlib} and unresolved references
5784 @cindex unresolved references and @option{-nostdlib}
5785 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5786 @cindex @option{-nodefaultlibs} and unresolved references
5787 @cindex unresolved references and @option{-nodefaultlibs}
5788 One of the standard libraries bypassed by @option{-nostdlib} and
5789 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5790 that GCC uses to overcome shortcomings of particular machines, or special
5791 needs for some languages.
5792 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5793 Collection (GCC) Internals},
5794 for more discussion of @file{libgcc.a}.)
5795 In most cases, you need @file{libgcc.a} even when you want to avoid
5796 other standard libraries.  In other words, when you specify @option{-nostdlib}
5797 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5798 This ensures that you have no unresolved references to internal GCC
5799 library subroutines.  (For example, @samp{__main}, used to ensure C++
5800 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5801 GNU Compiler Collection (GCC) Internals}.)
5803 @item -pie
5804 @opindex pie
5805 Produce a position independent executable on targets which support it.
5806 For predictable results, you must also specify the same set of options
5807 that were used to generate code (@option{-fpie}, @option{-fPIE},
5808 or model suboptions) when you specify this option.
5810 @item -s
5811 @opindex s
5812 Remove all symbol table and relocation information from the executable.
5814 @item -static
5815 @opindex static
5816 On systems that support dynamic linking, this prevents linking with the shared
5817 libraries.  On other systems, this option has no effect.
5819 @item -shared
5820 @opindex shared
5821 Produce a shared object which can then be linked with other objects to
5822 form an executable.  Not all systems support this option.  For predictable
5823 results, you must also specify the same set of options that were used to
5824 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5825 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5826 needs to build supplementary stub code for constructors to work.  On
5827 multi-libbed systems, @samp{gcc -shared} must select the correct support
5828 libraries to link against.  Failing to supply the correct flags may lead
5829 to subtle defects.  Supplying them in cases where they are not necessary
5830 is innocuous.}
5832 @item -shared-libgcc
5833 @itemx -static-libgcc
5834 @opindex shared-libgcc
5835 @opindex static-libgcc
5836 On systems that provide @file{libgcc} as a shared library, these options
5837 force the use of either the shared or static version respectively.
5838 If no shared version of @file{libgcc} was built when the compiler was
5839 configured, these options have no effect.
5841 There are several situations in which an application should use the
5842 shared @file{libgcc} instead of the static version.  The most common
5843 of these is when the application wishes to throw and catch exceptions
5844 across different shared libraries.  In that case, each of the libraries
5845 as well as the application itself should use the shared @file{libgcc}.
5847 Therefore, the G++ and GCJ drivers automatically add
5848 @option{-shared-libgcc} whenever you build a shared library or a main
5849 executable, because C++ and Java programs typically use exceptions, so
5850 this is the right thing to do.
5852 If, instead, you use the GCC driver to create shared libraries, you may
5853 find that they will not always be linked with the shared @file{libgcc}.
5854 If GCC finds, at its configuration time, that you have a non-GNU linker
5855 or a GNU linker that does not support option @option{--eh-frame-hdr},
5856 it will link the shared version of @file{libgcc} into shared libraries
5857 by default.  Otherwise, it will take advantage of the linker and optimize
5858 away the linking with the shared version of @file{libgcc}, linking with
5859 the static version of libgcc by default.  This allows exceptions to
5860 propagate through such shared libraries, without incurring relocation
5861 costs at library load time.
5863 However, if a library or main executable is supposed to throw or catch
5864 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5865 for the languages used in the program, or using the option
5866 @option{-shared-libgcc}, such that it is linked with the shared
5867 @file{libgcc}.
5869 @item -symbolic
5870 @opindex symbolic
5871 Bind references to global symbols when building a shared object.  Warn
5872 about any unresolved references (unless overridden by the link editor
5873 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5874 this option.
5876 @item -Xlinker @var{option}
5877 @opindex Xlinker
5878 Pass @var{option} as an option to the linker.  You can use this to
5879 supply system-specific linker options which GCC does not know how to
5880 recognize.
5882 If you want to pass an option that takes an argument, you must use
5883 @option{-Xlinker} twice, once for the option and once for the argument.
5884 For example, to pass @option{-assert definitions}, you must write
5885 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5886 @option{-Xlinker "-assert definitions"}, because this passes the entire
5887 string as a single argument, which is not what the linker expects.
5889 @item -Wl,@var{option}
5890 @opindex Wl
5891 Pass @var{option} as an option to the linker.  If @var{option} contains
5892 commas, it is split into multiple options at the commas.
5894 @item -u @var{symbol}
5895 @opindex u
5896 Pretend the symbol @var{symbol} is undefined, to force linking of
5897 library modules to define it.  You can use @option{-u} multiple times with
5898 different symbols to force loading of additional library modules.
5899 @end table
5901 @node Directory Options
5902 @section Options for Directory Search
5903 @cindex directory options
5904 @cindex options, directory search
5905 @cindex search path
5907 These options specify directories to search for header files, for
5908 libraries and for parts of the compiler:
5910 @table @gcctabopt
5911 @item -I@var{dir}
5912 @opindex I
5913 Add the directory @var{dir} to the head of the list of directories to be
5914 searched for header files.  This can be used to override a system header
5915 file, substituting your own version, since these directories are
5916 searched before the system header file directories.  However, you should
5917 not use this option to add directories that contain vendor-supplied
5918 system header files (use @option{-isystem} for that).  If you use more than
5919 one @option{-I} option, the directories are scanned in left-to-right
5920 order; the standard system directories come after.
5922 If a standard system include directory, or a directory specified with
5923 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5924 option will be ignored.  The directory will still be searched but as a
5925 system directory at its normal position in the system include chain.
5926 This is to ensure that GCC's procedure to fix buggy system headers and
5927 the ordering for the include_next directive are not inadvertently changed.
5928 If you really need to change the search order for system directories,
5929 use the @option{-nostdinc} and/or @option{-isystem} options.
5931 @item -iquote@var{dir}
5932 @opindex iquote
5933 Add the directory @var{dir} to the head of the list of directories to
5934 be searched for header files only for the case of @samp{#include
5935 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5936 otherwise just like @option{-I}.
5938 @item -L@var{dir}
5939 @opindex L
5940 Add directory @var{dir} to the list of directories to be searched
5941 for @option{-l}.
5943 @item -B@var{prefix}
5944 @opindex B
5945 This option specifies where to find the executables, libraries,
5946 include files, and data files of the compiler itself.
5948 The compiler driver program runs one or more of the subprograms
5949 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5950 @var{prefix} as a prefix for each program it tries to run, both with and
5951 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5953 For each subprogram to be run, the compiler driver first tries the
5954 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5955 was not specified, the driver tries two standard prefixes, which are
5956 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5957 those results in a file name that is found, the unmodified program
5958 name is searched for using the directories specified in your
5959 @env{PATH} environment variable.
5961 The compiler will check to see if the path provided by the @option{-B}
5962 refers to a directory, and if necessary it will add a directory
5963 separator character at the end of the path.
5965 @option{-B} prefixes that effectively specify directory names also apply
5966 to libraries in the linker, because the compiler translates these
5967 options into @option{-L} options for the linker.  They also apply to
5968 includes files in the preprocessor, because the compiler translates these
5969 options into @option{-isystem} options for the preprocessor.  In this case,
5970 the compiler appends @samp{include} to the prefix.
5972 The run-time support file @file{libgcc.a} can also be searched for using
5973 the @option{-B} prefix, if needed.  If it is not found there, the two
5974 standard prefixes above are tried, and that is all.  The file is left
5975 out of the link if it is not found by those means.
5977 Another way to specify a prefix much like the @option{-B} prefix is to use
5978 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5979 Variables}.
5981 As a special kludge, if the path provided by @option{-B} is
5982 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5983 9, then it will be replaced by @file{[dir/]include}.  This is to help
5984 with boot-strapping the compiler.
5986 @item -specs=@var{file}
5987 @opindex specs
5988 Process @var{file} after the compiler reads in the standard @file{specs}
5989 file, in order to override the defaults that the @file{gcc} driver
5990 program uses when determining what switches to pass to @file{cc1},
5991 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5992 @option{-specs=@var{file}} can be specified on the command line, and they
5993 are processed in order, from left to right.
5995 @item -I-
5996 @opindex I-
5997 This option has been deprecated.  Please use @option{-iquote} instead for
5998 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5999 Any directories you specify with @option{-I} options before the @option{-I-}
6000 option are searched only for the case of @samp{#include "@var{file}"};
6001 they are not searched for @samp{#include <@var{file}>}.
6003 If additional directories are specified with @option{-I} options after
6004 the @option{-I-}, these directories are searched for all @samp{#include}
6005 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6006 this way.)
6008 In addition, the @option{-I-} option inhibits the use of the current
6009 directory (where the current input file came from) as the first search
6010 directory for @samp{#include "@var{file}"}.  There is no way to
6011 override this effect of @option{-I-}.  With @option{-I.} you can specify
6012 searching the directory which was current when the compiler was
6013 invoked.  That is not exactly the same as what the preprocessor does
6014 by default, but it is often satisfactory.
6016 @option{-I-} does not inhibit the use of the standard system directories
6017 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6018 independent.
6019 @end table
6021 @c man end
6023 @node Spec Files
6024 @section Specifying subprocesses and the switches to pass to them
6025 @cindex Spec Files
6027 @command{gcc} is a driver program.  It performs its job by invoking a
6028 sequence of other programs to do the work of compiling, assembling and
6029 linking.  GCC interprets its command-line parameters and uses these to
6030 deduce which programs it should invoke, and which command-line options
6031 it ought to place on their command lines.  This behavior is controlled
6032 by @dfn{spec strings}.  In most cases there is one spec string for each
6033 program that GCC can invoke, but a few programs have multiple spec
6034 strings to control their behavior.  The spec strings built into GCC can
6035 be overridden by using the @option{-specs=} command-line switch to specify
6036 a spec file.
6038 @dfn{Spec files} are plaintext files that are used to construct spec
6039 strings.  They consist of a sequence of directives separated by blank
6040 lines.  The type of directive is determined by the first non-whitespace
6041 character on the line and it can be one of the following:
6043 @table @code
6044 @item %@var{command}
6045 Issues a @var{command} to the spec file processor.  The commands that can
6046 appear here are:
6048 @table @code
6049 @item %include <@var{file}>
6050 @cindex %include
6051 Search for @var{file} and insert its text at the current point in the
6052 specs file.
6054 @item %include_noerr <@var{file}>
6055 @cindex %include_noerr
6056 Just like @samp{%include}, but do not generate an error message if the include
6057 file cannot be found.
6059 @item %rename @var{old_name} @var{new_name}
6060 @cindex %rename
6061 Rename the spec string @var{old_name} to @var{new_name}.
6063 @end table
6065 @item *[@var{spec_name}]:
6066 This tells the compiler to create, override or delete the named spec
6067 string.  All lines after this directive up to the next directive or
6068 blank line are considered to be the text for the spec string.  If this
6069 results in an empty string then the spec will be deleted.  (Or, if the
6070 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6071 does not currently exist a new spec will be created.  If the spec does
6072 exist then its contents will be overridden by the text of this
6073 directive, unless the first character of that text is the @samp{+}
6074 character, in which case the text will be appended to the spec.
6076 @item [@var{suffix}]:
6077 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6078 and up to the next directive or blank line are considered to make up the
6079 spec string for the indicated suffix.  When the compiler encounters an
6080 input file with the named suffix, it will processes the spec string in
6081 order to work out how to compile that file.  For example:
6083 @smallexample
6084 .ZZ:
6085 z-compile -input %i
6086 @end smallexample
6088 This says that any input file whose name ends in @samp{.ZZ} should be
6089 passed to the program @samp{z-compile}, which should be invoked with the
6090 command-line switch @option{-input} and with the result of performing the
6091 @samp{%i} substitution.  (See below.)
6093 As an alternative to providing a spec string, the text that follows a
6094 suffix directive can be one of the following:
6096 @table @code
6097 @item @@@var{language}
6098 This says that the suffix is an alias for a known @var{language}.  This is
6099 similar to using the @option{-x} command-line switch to GCC to specify a
6100 language explicitly.  For example:
6102 @smallexample
6103 .ZZ:
6104 @@c++
6105 @end smallexample
6107 Says that .ZZ files are, in fact, C++ source files.
6109 @item #@var{name}
6110 This causes an error messages saying:
6112 @smallexample
6113 @var{name} compiler not installed on this system.
6114 @end smallexample
6115 @end table
6117 GCC already has an extensive list of suffixes built into it.
6118 This directive will add an entry to the end of the list of suffixes, but
6119 since the list is searched from the end backwards, it is effectively
6120 possible to override earlier entries using this technique.
6122 @end table
6124 GCC has the following spec strings built into it.  Spec files can
6125 override these strings or create their own.  Note that individual
6126 targets can also add their own spec strings to this list.
6128 @smallexample
6129 asm          Options to pass to the assembler
6130 asm_final    Options to pass to the assembler post-processor
6131 cpp          Options to pass to the C preprocessor
6132 cc1          Options to pass to the C compiler
6133 cc1plus      Options to pass to the C++ compiler
6134 endfile      Object files to include at the end of the link
6135 link         Options to pass to the linker
6136 lib          Libraries to include on the command line to the linker
6137 libgcc       Decides which GCC support library to pass to the linker
6138 linker       Sets the name of the linker
6139 predefines   Defines to be passed to the C preprocessor
6140 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6141              by default
6142 startfile    Object files to include at the start of the link
6143 @end smallexample
6145 Here is a small example of a spec file:
6147 @smallexample
6148 %rename lib                 old_lib
6150 *lib:
6151 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6152 @end smallexample
6154 This example renames the spec called @samp{lib} to @samp{old_lib} and
6155 then overrides the previous definition of @samp{lib} with a new one.
6156 The new definition adds in some extra command-line options before
6157 including the text of the old definition.
6159 @dfn{Spec strings} are a list of command-line options to be passed to their
6160 corresponding program.  In addition, the spec strings can contain
6161 @samp{%}-prefixed sequences to substitute variable text or to
6162 conditionally insert text into the command line.  Using these constructs
6163 it is possible to generate quite complex command lines.
6165 Here is a table of all defined @samp{%}-sequences for spec
6166 strings.  Note that spaces are not generated automatically around the
6167 results of expanding these sequences.  Therefore you can concatenate them
6168 together or combine them with constant text in a single argument.
6170 @table @code
6171 @item %%
6172 Substitute one @samp{%} into the program name or argument.
6174 @item %i
6175 Substitute the name of the input file being processed.
6177 @item %b
6178 Substitute the basename of the input file being processed.
6179 This is the substring up to (and not including) the last period
6180 and not including the directory.
6182 @item %B
6183 This is the same as @samp{%b}, but include the file suffix (text after
6184 the last period).
6186 @item %d
6187 Marks the argument containing or following the @samp{%d} as a
6188 temporary file name, so that that file will be deleted if GCC exits
6189 successfully.  Unlike @samp{%g}, this contributes no text to the
6190 argument.
6192 @item %g@var{suffix}
6193 Substitute a file name that has suffix @var{suffix} and is chosen
6194 once per compilation, and mark the argument in the same way as
6195 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6196 name is now chosen in a way that is hard to predict even when previously
6197 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6198 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6199 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6200 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6201 was simply substituted with a file name chosen once per compilation,
6202 without regard to any appended suffix (which was therefore treated
6203 just like ordinary text), making such attacks more likely to succeed.
6205 @item %u@var{suffix}
6206 Like @samp{%g}, but generates a new temporary file name even if
6207 @samp{%u@var{suffix}} was already seen.
6209 @item %U@var{suffix}
6210 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6211 new one if there is no such last file name.  In the absence of any
6212 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6213 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6214 would involve the generation of two distinct file names, one
6215 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6216 simply substituted with a file name chosen for the previous @samp{%u},
6217 without regard to any appended suffix.
6219 @item %j@var{suffix}
6220 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6221 writable, and if save-temps is off; otherwise, substitute the name
6222 of a temporary file, just like @samp{%u}.  This temporary file is not
6223 meant for communication between processes, but rather as a junk
6224 disposal mechanism.
6226 @item %|@var{suffix}
6227 @itemx %m@var{suffix}
6228 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6229 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6230 all.  These are the two most common ways to instruct a program that it
6231 should read from standard input or write to standard output.  If you
6232 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6233 construct: see for example @file{f/lang-specs.h}.
6235 @item %.@var{SUFFIX}
6236 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6237 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6238 terminated by the next space or %.
6240 @item %w
6241 Marks the argument containing or following the @samp{%w} as the
6242 designated output file of this compilation.  This puts the argument
6243 into the sequence of arguments that @samp{%o} will substitute later.
6245 @item %o
6246 Substitutes the names of all the output files, with spaces
6247 automatically placed around them.  You should write spaces
6248 around the @samp{%o} as well or the results are undefined.
6249 @samp{%o} is for use in the specs for running the linker.
6250 Input files whose names have no recognized suffix are not compiled
6251 at all, but they are included among the output files, so they will
6252 be linked.
6254 @item %O
6255 Substitutes the suffix for object files.  Note that this is
6256 handled specially when it immediately follows @samp{%g, %u, or %U},
6257 because of the need for those to form complete file names.  The
6258 handling is such that @samp{%O} is treated exactly as if it had already
6259 been substituted, except that @samp{%g, %u, and %U} do not currently
6260 support additional @var{suffix} characters following @samp{%O} as they would
6261 following, for example, @samp{.o}.
6263 @item %p
6264 Substitutes the standard macro predefinitions for the
6265 current target machine.  Use this when running @code{cpp}.
6267 @item %P
6268 Like @samp{%p}, but puts @samp{__} before and after the name of each
6269 predefined macro, except for macros that start with @samp{__} or with
6270 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6273 @item %I
6274 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6275 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6276 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6277 as necessary.
6279 @item %s
6280 Current argument is the name of a library or startup file of some sort.
6281 Search for that file in a standard list of directories and substitute
6282 the full name found.
6284 @item %e@var{str}
6285 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6286 Use this when inconsistent options are detected.
6288 @item %(@var{name})
6289 Substitute the contents of spec string @var{name} at this point.
6291 @item %[@var{name}]
6292 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6294 @item %x@{@var{option}@}
6295 Accumulate an option for @samp{%X}.
6297 @item %X
6298 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6299 spec string.
6301 @item %Y
6302 Output the accumulated assembler options specified by @option{-Wa}.
6304 @item %Z
6305 Output the accumulated preprocessor options specified by @option{-Wp}.
6307 @item %a
6308 Process the @code{asm} spec.  This is used to compute the
6309 switches to be passed to the assembler.
6311 @item %A
6312 Process the @code{asm_final} spec.  This is a spec string for
6313 passing switches to an assembler post-processor, if such a program is
6314 needed.
6316 @item %l
6317 Process the @code{link} spec.  This is the spec for computing the
6318 command line passed to the linker.  Typically it will make use of the
6319 @samp{%L %G %S %D and %E} sequences.
6321 @item %D
6322 Dump out a @option{-L} option for each directory that GCC believes might
6323 contain startup files.  If the target supports multilibs then the
6324 current multilib directory will be prepended to each of these paths.
6326 @item %M
6327 Output the multilib directory with directory separators replaced with
6328 @samp{_}.  If multilib directories are not set, or the multilib directory is
6329 @file{.} then this option emits nothing.
6331 @item %L
6332 Process the @code{lib} spec.  This is a spec string for deciding which
6333 libraries should be included on the command line to the linker.
6335 @item %G
6336 Process the @code{libgcc} spec.  This is a spec string for deciding
6337 which GCC support library should be included on the command line to the linker.
6339 @item %S
6340 Process the @code{startfile} spec.  This is a spec for deciding which
6341 object files should be the first ones passed to the linker.  Typically
6342 this might be a file named @file{crt0.o}.
6344 @item %E
6345 Process the @code{endfile} spec.  This is a spec string that specifies
6346 the last object files that will be passed to the linker.
6348 @item %C
6349 Process the @code{cpp} spec.  This is used to construct the arguments
6350 to be passed to the C preprocessor.
6352 @item %1
6353 Process the @code{cc1} spec.  This is used to construct the options to be
6354 passed to the actual C compiler (@samp{cc1}).
6356 @item %2
6357 Process the @code{cc1plus} spec.  This is used to construct the options to be
6358 passed to the actual C++ compiler (@samp{cc1plus}).
6360 @item %*
6361 Substitute the variable part of a matched option.  See below.
6362 Note that each comma in the substituted string is replaced by
6363 a single space.
6365 @item %<@code{S}
6366 Remove all occurrences of @code{-S} from the command line.  Note---this
6367 command is position dependent.  @samp{%} commands in the spec string
6368 before this one will see @code{-S}, @samp{%} commands in the spec string
6369 after this one will not.
6371 @item %:@var{function}(@var{args})
6372 Call the named function @var{function}, passing it @var{args}.
6373 @var{args} is first processed as a nested spec string, then split
6374 into an argument vector in the usual fashion.  The function returns
6375 a string which is processed as if it had appeared literally as part
6376 of the current spec.
6378 The following built-in spec functions are provided:
6380 @table @code
6381 @item @code{if-exists}
6382 The @code{if-exists} spec function takes one argument, an absolute
6383 pathname to a file.  If the file exists, @code{if-exists} returns the
6384 pathname.  Here is a small example of its usage:
6386 @smallexample
6387 *startfile:
6388 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6389 @end smallexample
6391 @item @code{if-exists-else}
6392 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6393 spec function, except that it takes two arguments.  The first argument is
6394 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6395 returns the pathname.  If it does not exist, it returns the second argument.
6396 This way, @code{if-exists-else} can be used to select one file or another,
6397 based on the existence of the first.  Here is a small example of its usage:
6399 @smallexample
6400 *startfile:
6401 crt0%O%s %:if-exists(crti%O%s) \
6402 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6403 @end smallexample
6405 @item @code{replace-outfile}
6406 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6407 first argument in the outfiles array and replaces it with the second argument.  Here
6408 is a small example of its usage:
6410 @smallexample
6411 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6412 @end smallexample
6414 @end table
6416 @item %@{@code{S}@}
6417 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6418 If that switch was not specified, this substitutes nothing.  Note that
6419 the leading dash is omitted when specifying this option, and it is
6420 automatically inserted if the substitution is performed.  Thus the spec
6421 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6422 and would output the command line option @option{-foo}.
6424 @item %W@{@code{S}@}
6425 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6426 deleted on failure.
6428 @item %@{@code{S}*@}
6429 Substitutes all the switches specified to GCC whose names start
6430 with @code{-S}, but which also take an argument.  This is used for
6431 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6432 GCC considers @option{-o foo} as being
6433 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6434 text, including the space.  Thus two arguments would be generated.
6436 @item %@{@code{S}*&@code{T}*@}
6437 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6438 (the order of @code{S} and @code{T} in the spec is not significant).
6439 There can be any number of ampersand-separated variables; for each the
6440 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6442 @item %@{@code{S}:@code{X}@}
6443 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6445 @item %@{!@code{S}:@code{X}@}
6446 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6448 @item %@{@code{S}*:@code{X}@}
6449 Substitutes @code{X} if one or more switches whose names start with
6450 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6451 once, no matter how many such switches appeared.  However, if @code{%*}
6452 appears somewhere in @code{X}, then @code{X} will be substituted once
6453 for each matching switch, with the @code{%*} replaced by the part of
6454 that switch that matched the @code{*}.
6456 @item %@{.@code{S}:@code{X}@}
6457 Substitutes @code{X}, if processing a file with suffix @code{S}.
6459 @item %@{!.@code{S}:@code{X}@}
6460 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6462 @item %@{@code{S}|@code{P}:@code{X}@}
6463 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6464 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6465 although they have a stronger binding than the @samp{|}.  If @code{%*}
6466 appears in @code{X}, all of the alternatives must be starred, and only
6467 the first matching alternative is substituted.
6469 For example, a spec string like this:
6471 @smallexample
6472 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6473 @end smallexample
6475 will output the following command-line options from the following input
6476 command-line options:
6478 @smallexample
6479 fred.c        -foo -baz
6480 jim.d         -bar -boggle
6481 -d fred.c     -foo -baz -boggle
6482 -d jim.d      -bar -baz -boggle
6483 @end smallexample
6485 @item %@{S:X; T:Y; :D@}
6487 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6488 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6489 be as many clauses as you need.  This may be combined with @code{.},
6490 @code{!}, @code{|}, and @code{*} as needed.
6493 @end table
6495 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6496 construct may contain other nested @samp{%} constructs or spaces, or
6497 even newlines.  They are processed as usual, as described above.
6498 Trailing white space in @code{X} is ignored.  White space may also
6499 appear anywhere on the left side of the colon in these constructs,
6500 except between @code{.} or @code{*} and the corresponding word.
6502 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6503 handled specifically in these constructs.  If another value of
6504 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6505 @option{-W} switch is found later in the command line, the earlier
6506 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6507 just one letter, which passes all matching options.
6509 The character @samp{|} at the beginning of the predicate text is used to
6510 indicate that a command should be piped to the following command, but
6511 only if @option{-pipe} is specified.
6513 It is built into GCC which switches take arguments and which do not.
6514 (You might think it would be useful to generalize this to allow each
6515 compiler's spec to say which switches take arguments.  But this cannot
6516 be done in a consistent fashion.  GCC cannot even decide which input
6517 files have been specified without knowing which switches take arguments,
6518 and it must know which input files to compile in order to tell which
6519 compilers to run).
6521 GCC also knows implicitly that arguments starting in @option{-l} are to be
6522 treated as compiler output files, and passed to the linker in their
6523 proper position among the other output files.
6525 @c man begin OPTIONS
6527 @node Target Options
6528 @section Specifying Target Machine and Compiler Version
6529 @cindex target options
6530 @cindex cross compiling
6531 @cindex specifying machine version
6532 @cindex specifying compiler version and target machine
6533 @cindex compiler version, specifying
6534 @cindex target machine, specifying
6536 The usual way to run GCC is to run the executable called @file{gcc}, or
6537 @file{<machine>-gcc} when cross-compiling, or
6538 @file{<machine>-gcc-<version>} to run a version other than the one that
6539 was installed last.  Sometimes this is inconvenient, so GCC provides
6540 options that will switch to another cross-compiler or version.
6542 @table @gcctabopt
6543 @item -b @var{machine}
6544 @opindex b
6545 The argument @var{machine} specifies the target machine for compilation.
6547 The value to use for @var{machine} is the same as was specified as the
6548 machine type when configuring GCC as a cross-compiler.  For
6549 example, if a cross-compiler was configured with @samp{configure
6550 i386v}, meaning to compile for an 80386 running System V, then you
6551 would specify @option{-b i386v} to run that cross compiler.
6553 @item -V @var{version}
6554 @opindex V
6555 The argument @var{version} specifies which version of GCC to run.
6556 This is useful when multiple versions are installed.  For example,
6557 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6558 @end table
6560 The @option{-V} and @option{-b} options work by running the
6561 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6562 use them if you can just run that directly.
6564 @node Submodel Options
6565 @section Hardware Models and Configurations
6566 @cindex submodel options
6567 @cindex specifying hardware config
6568 @cindex hardware models and configurations, specifying
6569 @cindex machine dependent options
6571 Earlier we discussed the standard option @option{-b} which chooses among
6572 different installed compilers for completely different target
6573 machines, such as VAX vs.@: 68000 vs.@: 80386.
6575 In addition, each of these target machine types can have its own
6576 special options, starting with @samp{-m}, to choose among various
6577 hardware models or configurations---for example, 68010 vs 68020,
6578 floating coprocessor or none.  A single installed version of the
6579 compiler can compile for any model or configuration, according to the
6580 options specified.
6582 Some configurations of the compiler also support additional special
6583 options, usually for compatibility with other compilers on the same
6584 platform.
6586 These options are defined by the macro @code{TARGET_SWITCHES} in the
6587 machine description.  The default for the options is also defined by
6588 that macro, which enables you to change the defaults.
6590 @c This list is ordered alphanumerically by subsection name.
6591 @c It should be the same order and spelling as these options are listed
6592 @c in Machine Dependent Options
6594 @menu
6595 * ARC Options::
6596 * ARM Options::
6597 * AVR Options::
6598 * CRIS Options::
6599 * Darwin Options::
6600 * DEC Alpha Options::
6601 * DEC Alpha/VMS Options::
6602 * FRV Options::
6603 * H8/300 Options::
6604 * HPPA Options::
6605 * i386 and x86-64 Options::
6606 * IA-64 Options::
6607 * M32R/D Options::
6608 * M680x0 Options::
6609 * M68hc1x Options::
6610 * MCore Options::
6611 * MIPS Options::
6612 * MMIX Options::
6613 * MN10300 Options::
6614 * NS32K Options::
6615 * PDP-11 Options::
6616 * PowerPC Options::
6617 * RS/6000 and PowerPC Options::
6618 * S/390 and zSeries Options::
6619 * SH Options::
6620 * SPARC Options::
6621 * System V Options::
6622 * TMS320C3x/C4x Options::
6623 * V850 Options::
6624 * VAX Options::
6625 * x86-64 Options::
6626 * Xstormy16 Options::
6627 * Xtensa Options::
6628 * zSeries Options::
6629 @end menu
6631 @node ARC Options
6632 @subsection ARC Options
6633 @cindex ARC Options
6635 These options are defined for ARC implementations:
6637 @table @gcctabopt
6638 @item -EL
6639 @opindex EL
6640 Compile code for little endian mode.  This is the default.
6642 @item -EB
6643 @opindex EB
6644 Compile code for big endian mode.
6646 @item -mmangle-cpu
6647 @opindex mmangle-cpu
6648 Prepend the name of the cpu to all public symbol names.
6649 In multiple-processor systems, there are many ARC variants with different
6650 instruction and register set characteristics.  This flag prevents code
6651 compiled for one cpu to be linked with code compiled for another.
6652 No facility exists for handling variants that are ``almost identical''.
6653 This is an all or nothing option.
6655 @item -mcpu=@var{cpu}
6656 @opindex mcpu
6657 Compile code for ARC variant @var{cpu}.
6658 Which variants are supported depend on the configuration.
6659 All variants support @option{-mcpu=base}, this is the default.
6661 @item -mtext=@var{text-section}
6662 @itemx -mdata=@var{data-section}
6663 @itemx -mrodata=@var{readonly-data-section}
6664 @opindex mtext
6665 @opindex mdata
6666 @opindex mrodata
6667 Put functions, data, and readonly data in @var{text-section},
6668 @var{data-section}, and @var{readonly-data-section} respectively
6669 by default.  This can be overridden with the @code{section} attribute.
6670 @xref{Variable Attributes}.
6672 @end table
6674 @node ARM Options
6675 @subsection ARM Options
6676 @cindex ARM options
6678 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6679 architectures:
6681 @table @gcctabopt
6682 @item -mabi=@var{name}
6683 @opindex mabi
6684 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6685 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6687 @item -mapcs-frame
6688 @opindex mapcs-frame
6689 Generate a stack frame that is compliant with the ARM Procedure Call
6690 Standard for all functions, even if this is not strictly necessary for
6691 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6692 with this option will cause the stack frames not to be generated for
6693 leaf functions.  The default is @option{-mno-apcs-frame}.
6695 @item -mapcs
6696 @opindex mapcs
6697 This is a synonym for @option{-mapcs-frame}.
6699 @ignore
6700 @c not currently implemented
6701 @item -mapcs-stack-check
6702 @opindex mapcs-stack-check
6703 Generate code to check the amount of stack space available upon entry to
6704 every function (that actually uses some stack space).  If there is
6705 insufficient space available then either the function
6706 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6707 called, depending upon the amount of stack space required.  The run time
6708 system is required to provide these functions.  The default is
6709 @option{-mno-apcs-stack-check}, since this produces smaller code.
6711 @c not currently implemented
6712 @item -mapcs-float
6713 @opindex mapcs-float
6714 Pass floating point arguments using the float point registers.  This is
6715 one of the variants of the APCS@.  This option is recommended if the
6716 target hardware has a floating point unit or if a lot of floating point
6717 arithmetic is going to be performed by the code.  The default is
6718 @option{-mno-apcs-float}, since integer only code is slightly increased in
6719 size if @option{-mapcs-float} is used.
6721 @c not currently implemented
6722 @item -mapcs-reentrant
6723 @opindex mapcs-reentrant
6724 Generate reentrant, position independent code.  The default is
6725 @option{-mno-apcs-reentrant}.
6726 @end ignore
6728 @item -mthumb-interwork
6729 @opindex mthumb-interwork
6730 Generate code which supports calling between the ARM and Thumb
6731 instruction sets.  Without this option the two instruction sets cannot
6732 be reliably used inside one program.  The default is
6733 @option{-mno-thumb-interwork}, since slightly larger code is generated
6734 when @option{-mthumb-interwork} is specified.
6736 @item -mno-sched-prolog
6737 @opindex mno-sched-prolog
6738 Prevent the reordering of instructions in the function prolog, or the
6739 merging of those instruction with the instructions in the function's
6740 body.  This means that all functions will start with a recognizable set
6741 of instructions (or in fact one of a choice from a small set of
6742 different function prologues), and this information can be used to
6743 locate the start if functions inside an executable piece of code.  The
6744 default is @option{-msched-prolog}.
6746 @item -mhard-float
6747 @opindex mhard-float
6748 Generate output containing floating point instructions.  This is the
6749 default.
6751 @item -msoft-float
6752 @opindex msoft-float
6753 Generate output containing library calls for floating point.
6754 @strong{Warning:} the requisite libraries are not available for all ARM
6755 targets.  Normally the facilities of the machine's usual C compiler are
6756 used, but this cannot be done directly in cross-compilation.  You must make
6757 your own arrangements to provide suitable library functions for
6758 cross-compilation.
6760 @option{-msoft-float} changes the calling convention in the output file;
6761 therefore, it is only useful if you compile @emph{all} of a program with
6762 this option.  In particular, you need to compile @file{libgcc.a}, the
6763 library that comes with GCC, with @option{-msoft-float} in order for
6764 this to work.
6766 @item -mfloat-abi=@var{name}
6767 @opindex mfloat-abi
6768 Specifies which ABI to use for floating point values.  Permissible values
6769 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6771 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6772 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6773 of floating point instructions, but still uses the soft-float calling
6774 conventions.
6776 @item -mlittle-endian
6777 @opindex mlittle-endian
6778 Generate code for a processor running in little-endian mode.  This is
6779 the default for all standard configurations.
6781 @item -mbig-endian
6782 @opindex mbig-endian
6783 Generate code for a processor running in big-endian mode; the default is
6784 to compile code for a little-endian processor.
6786 @item -mwords-little-endian
6787 @opindex mwords-little-endian
6788 This option only applies when generating code for big-endian processors.
6789 Generate code for a little-endian word order but a big-endian byte
6790 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6791 option should only be used if you require compatibility with code for
6792 big-endian ARM processors generated by versions of the compiler prior to
6793 2.8.
6795 @item -mcpu=@var{name}
6796 @opindex mcpu
6797 This specifies the name of the target ARM processor.  GCC uses this name
6798 to determine what kind of instructions it can emit when generating
6799 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6800 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6801 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6802 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6803 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6804 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6805 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6806 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6807 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6808 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6809 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6810 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6811 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6812 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6813 @samp{ep9312}.
6815 @itemx -mtune=@var{name}
6816 @opindex mtune
6817 This option is very similar to the @option{-mcpu=} option, except that
6818 instead of specifying the actual target processor type, and hence
6819 restricting which instructions can be used, it specifies that GCC should
6820 tune the performance of the code as if the target were of the type
6821 specified in this option, but still choosing the instructions that it
6822 will generate based on the cpu specified by a @option{-mcpu=} option.
6823 For some ARM implementations better performance can be obtained by using
6824 this option.
6826 @item -march=@var{name}
6827 @opindex march
6828 This specifies the name of the target ARM architecture.  GCC uses this
6829 name to determine what kind of instructions it can emit when generating
6830 assembly code.  This option can be used in conjunction with or instead
6831 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6832 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6833 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6834 @samp{iwmmxt}, @samp{ep9312}.
6836 @item -mfpu=@var{name}
6837 @itemx -mfpe=@var{number}
6838 @itemx -mfp=@var{number}
6839 @opindex mfpu
6840 @opindex mfpe
6841 @opindex mfp
6842 This specifies what floating point hardware (or hardware emulation) is
6843 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6844 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6845 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6846 with older versions of GCC@.
6848 If @option{-msoft-float} is specified this specifies the format of
6849 floating point values.
6851 @item -mstructure-size-boundary=@var{n}
6852 @opindex mstructure-size-boundary
6853 The size of all structures and unions will be rounded up to a multiple
6854 of the number of bits set by this option.  Permissible values are 8, 32
6855 and 64.  The default value varies for different toolchains.  For the COFF
6856 targeted toolchain the default value is 8.  A value of 64 is only allowed
6857 if the underlying ABI supports it.
6859 Specifying the larger number can produce faster, more efficient code, but
6860 can also increase the size of the program.  Different values are potentially
6861 incompatible.  Code compiled with one value cannot necessarily expect to
6862 work with code or libraries compiled with another value, if they exchange
6863 information using structures or unions.
6865 @item -mabort-on-noreturn
6866 @opindex mabort-on-noreturn
6867 Generate a call to the function @code{abort} at the end of a
6868 @code{noreturn} function.  It will be executed if the function tries to
6869 return.
6871 @item -mlong-calls
6872 @itemx -mno-long-calls
6873 @opindex mlong-calls
6874 @opindex mno-long-calls
6875 Tells the compiler to perform function calls by first loading the
6876 address of the function into a register and then performing a subroutine
6877 call on this register.  This switch is needed if the target function
6878 will lie outside of the 64 megabyte addressing range of the offset based
6879 version of subroutine call instruction.
6881 Even if this switch is enabled, not all function calls will be turned
6882 into long calls.  The heuristic is that static functions, functions
6883 which have the @samp{short-call} attribute, functions that are inside
6884 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6885 definitions have already been compiled within the current compilation
6886 unit, will not be turned into long calls.  The exception to this rule is
6887 that weak function definitions, functions with the @samp{long-call}
6888 attribute or the @samp{section} attribute, and functions that are within
6889 the scope of a @samp{#pragma long_calls} directive, will always be
6890 turned into long calls.
6892 This feature is not enabled by default.  Specifying
6893 @option{-mno-long-calls} will restore the default behavior, as will
6894 placing the function calls within the scope of a @samp{#pragma
6895 long_calls_off} directive.  Note these switches have no effect on how
6896 the compiler generates code to handle function calls via function
6897 pointers.
6899 @item -mnop-fun-dllimport
6900 @opindex mnop-fun-dllimport
6901 Disable support for the @code{dllimport} attribute.
6903 @item -msingle-pic-base
6904 @opindex msingle-pic-base
6905 Treat the register used for PIC addressing as read-only, rather than
6906 loading it in the prologue for each function.  The run-time system is
6907 responsible for initializing this register with an appropriate value
6908 before execution begins.
6910 @item -mpic-register=@var{reg}
6911 @opindex mpic-register
6912 Specify the register to be used for PIC addressing.  The default is R10
6913 unless stack-checking is enabled, when R9 is used.
6915 @item -mcirrus-fix-invalid-insns
6916 @opindex mcirrus-fix-invalid-insns
6917 @opindex mno-cirrus-fix-invalid-insns
6918 Insert NOPs into the instruction stream to in order to work around
6919 problems with invalid Maverick instruction combinations.  This option
6920 is only valid if the @option{-mcpu=ep9312} option has been used to
6921 enable generation of instructions for the Cirrus Maverick floating
6922 point co-processor.  This option is not enabled by default, since the
6923 problem is only present in older Maverick implementations.  The default
6924 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6925 switch.
6927 @item -mpoke-function-name
6928 @opindex mpoke-function-name
6929 Write the name of each function into the text section, directly
6930 preceding the function prologue.  The generated code is similar to this:
6932 @smallexample
6933      t0
6934          .ascii "arm_poke_function_name", 0
6935          .align
6936      t1
6937          .word 0xff000000 + (t1 - t0)
6938      arm_poke_function_name
6939          mov     ip, sp
6940          stmfd   sp!, @{fp, ip, lr, pc@}
6941          sub     fp, ip, #4
6942 @end smallexample
6944 When performing a stack backtrace, code can inspect the value of
6945 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6946 location @code{pc - 12} and the top 8 bits are set, then we know that
6947 there is a function name embedded immediately preceding this location
6948 and has length @code{((pc[-3]) & 0xff000000)}.
6950 @item -mthumb
6951 @opindex mthumb
6952 Generate code for the 16-bit Thumb instruction set.  The default is to
6953 use the 32-bit ARM instruction set.
6955 @item -mtpcs-frame
6956 @opindex mtpcs-frame
6957 Generate a stack frame that is compliant with the Thumb Procedure Call
6958 Standard for all non-leaf functions.  (A leaf function is one that does
6959 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6961 @item -mtpcs-leaf-frame
6962 @opindex mtpcs-leaf-frame
6963 Generate a stack frame that is compliant with the Thumb Procedure Call
6964 Standard for all leaf functions.  (A leaf function is one that does
6965 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6967 @item -mcallee-super-interworking
6968 @opindex mcallee-super-interworking
6969 Gives all externally visible functions in the file being compiled an ARM
6970 instruction set header which switches to Thumb mode before executing the
6971 rest of the function.  This allows these functions to be called from
6972 non-interworking code.
6974 @item -mcaller-super-interworking
6975 @opindex mcaller-super-interworking
6976 Allows calls via function pointers (including virtual functions) to
6977 execute correctly regardless of whether the target code has been
6978 compiled for interworking or not.  There is a small overhead in the cost
6979 of executing a function pointer if this option is enabled.
6981 @end table
6983 @node AVR Options
6984 @subsection AVR Options
6985 @cindex AVR Options
6987 These options are defined for AVR implementations:
6989 @table @gcctabopt
6990 @item -mmcu=@var{mcu}
6991 @opindex mmcu
6992 Specify ATMEL AVR instruction set or MCU type.
6994 Instruction set avr1 is for the minimal AVR core, not supported by the C
6995 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6996 attiny11, attiny12, attiny15, attiny28).
6998 Instruction set avr2 (default) is for the classic AVR core with up to
6999 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7000 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7001 at90c8534, at90s8535).
7003 Instruction set avr3 is for the classic AVR core with up to 128K program
7004 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7006 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7007 memory space (MCU types: atmega8, atmega83, atmega85).
7009 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7010 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7011 atmega64, atmega128, at43usb355, at94k).
7013 @item -msize
7014 @opindex msize
7015 Output instruction sizes to the asm file.
7017 @item -minit-stack=@var{N}
7018 @opindex minit-stack
7019 Specify the initial stack address, which may be a symbol or numeric value,
7020 @samp{__stack} is the default.
7022 @item -mno-interrupts
7023 @opindex mno-interrupts
7024 Generated code is not compatible with hardware interrupts.
7025 Code size will be smaller.
7027 @item -mcall-prologues
7028 @opindex mcall-prologues
7029 Functions prologues/epilogues expanded as call to appropriate
7030 subroutines.  Code size will be smaller.
7032 @item -mno-tablejump
7033 @opindex mno-tablejump
7034 Do not generate tablejump insns which sometimes increase code size.
7036 @item -mtiny-stack
7037 @opindex mtiny-stack
7038 Change only the low 8 bits of the stack pointer.
7040 @item -mint8
7041 @opindex mint8
7042 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7043 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7044 and long long will be 4 bytes.  Please note that this option does not
7045 comply to the C standards, but it will provide you with smaller code
7046 size.
7047 @end table
7049 @node CRIS Options
7050 @subsection CRIS Options
7051 @cindex CRIS Options
7053 These options are defined specifically for the CRIS ports.
7055 @table @gcctabopt
7056 @item -march=@var{architecture-type}
7057 @itemx -mcpu=@var{architecture-type}
7058 @opindex march
7059 @opindex mcpu
7060 Generate code for the specified architecture.  The choices for
7061 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7062 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7063 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7064 @samp{v10}.
7066 @item -mtune=@var{architecture-type}
7067 @opindex mtune
7068 Tune to @var{architecture-type} everything applicable about the generated
7069 code, except for the ABI and the set of available instructions.  The
7070 choices for @var{architecture-type} are the same as for
7071 @option{-march=@var{architecture-type}}.
7073 @item -mmax-stack-frame=@var{n}
7074 @opindex mmax-stack-frame
7075 Warn when the stack frame of a function exceeds @var{n} bytes.
7077 @item -melinux-stacksize=@var{n}
7078 @opindex melinux-stacksize
7079 Only available with the @samp{cris-axis-aout} target.  Arranges for
7080 indications in the program to the kernel loader that the stack of the
7081 program should be set to @var{n} bytes.
7083 @item -metrax4
7084 @itemx -metrax100
7085 @opindex metrax4
7086 @opindex metrax100
7087 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7088 @option{-march=v3} and @option{-march=v8} respectively.
7090 @item -mmul-bug-workaround
7091 @itemx -mno-mul-bug-workaround
7092 @opindex mmul-bug-workaround
7093 @opindex mno-mul-bug-workaround
7094 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7095 models where it applies.  This option is active by default.
7097 @item -mpdebug
7098 @opindex mpdebug
7099 Enable CRIS-specific verbose debug-related information in the assembly
7100 code.  This option also has the effect to turn off the @samp{#NO_APP}
7101 formatted-code indicator to the assembler at the beginning of the
7102 assembly file.
7104 @item -mcc-init
7105 @opindex mcc-init
7106 Do not use condition-code results from previous instruction; always emit
7107 compare and test instructions before use of condition codes.
7109 @item -mno-side-effects
7110 @opindex mno-side-effects
7111 Do not emit instructions with side-effects in addressing modes other than
7112 post-increment.
7114 @item -mstack-align
7115 @itemx -mno-stack-align
7116 @itemx -mdata-align
7117 @itemx -mno-data-align
7118 @itemx -mconst-align
7119 @itemx -mno-const-align
7120 @opindex mstack-align
7121 @opindex mno-stack-align
7122 @opindex mdata-align
7123 @opindex mno-data-align
7124 @opindex mconst-align
7125 @opindex mno-const-align
7126 These options (no-options) arranges (eliminate arrangements) for the
7127 stack-frame, individual data and constants to be aligned for the maximum
7128 single data access size for the chosen CPU model.  The default is to
7129 arrange for 32-bit alignment.  ABI details such as structure layout are
7130 not affected by these options.
7132 @item -m32-bit
7133 @itemx -m16-bit
7134 @itemx -m8-bit
7135 @opindex m32-bit
7136 @opindex m16-bit
7137 @opindex m8-bit
7138 Similar to the stack- data- and const-align options above, these options
7139 arrange for stack-frame, writable data and constants to all be 32-bit,
7140 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7142 @item -mno-prologue-epilogue
7143 @itemx -mprologue-epilogue
7144 @opindex mno-prologue-epilogue
7145 @opindex mprologue-epilogue
7146 With @option{-mno-prologue-epilogue}, the normal function prologue and
7147 epilogue that sets up the stack-frame are omitted and no return
7148 instructions or return sequences are generated in the code.  Use this
7149 option only together with visual inspection of the compiled code: no
7150 warnings or errors are generated when call-saved registers must be saved,
7151 or storage for local variable needs to be allocated.
7153 @item -mno-gotplt
7154 @itemx -mgotplt
7155 @opindex mno-gotplt
7156 @opindex mgotplt
7157 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7158 instruction sequences that load addresses for functions from the PLT part
7159 of the GOT rather than (traditional on other architectures) calls to the
7160 PLT@.  The default is @option{-mgotplt}.
7162 @item -maout
7163 @opindex maout
7164 Legacy no-op option only recognized with the cris-axis-aout target.
7166 @item -melf
7167 @opindex melf
7168 Legacy no-op option only recognized with the cris-axis-elf and
7169 cris-axis-linux-gnu targets.
7171 @item -melinux
7172 @opindex melinux
7173 Only recognized with the cris-axis-aout target, where it selects a
7174 GNU/linux-like multilib, include files and instruction set for
7175 @option{-march=v8}.
7177 @item -mlinux
7178 @opindex mlinux
7179 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7181 @item -sim
7182 @opindex sim
7183 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7184 to link with input-output functions from a simulator library.  Code,
7185 initialized data and zero-initialized data are allocated consecutively.
7187 @item -sim2
7188 @opindex sim2
7189 Like @option{-sim}, but pass linker options to locate initialized data at
7190 0x40000000 and zero-initialized data at 0x80000000.
7191 @end table
7193 @node Darwin Options
7194 @subsection Darwin Options
7195 @cindex Darwin options
7197 These options are defined for all architectures running the Darwin operating
7198 system.
7200 FSF GCC on Darwin does not create ``fat'' object files; it will create
7201 an object file for the single architecture that it was built to
7202 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7203 @option{-arch} options are used; it does so by running the compiler or
7204 linker multiple times and joining the results together with
7205 @file{lipo}.
7207 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7208 @samp{i686}) is determined by the flags that specify the ISA
7209 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7210 @option{-force_cpusubtype_ALL} option can be used to override this.
7212 The Darwin tools vary in their behaviour when presented with an ISA
7213 mismatch.  The assembler, @file{as}, will only permit instructions to
7214 be used that are valid for the subtype of the file it is generating,
7215 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7216 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7217 and print an error if asked to create a shared library with a less
7218 restrictive subtype than its input files (for instance, trying to put
7219 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7220 for executables, @file{ld}, will quietly give the executable the most
7221 restrictive subtype of any of its input files.
7223 @table @gcctabopt
7224 @item -F@var{dir}
7225 @opindex F
7226 Add the framework directory @var{dir} to the head of the list of
7227 directories to be searched for header files.  These directories are
7228 interleaved with those specified by @option{-I} options and are
7229 scanned in a left-to-right order.
7231 A framework directory is a directory with frameworks in it.  A
7232 framework is a directory with a @samp{"Headers"} and/or
7233 @samp{"PrivateHeaders"} directory contained directly in it that ends
7234 in @samp{".framework"}.  The name of a framework is the name of this
7235 directory excluding the @samp{".framework"}.  Headers associated with
7236 the framework are found in one of those two directories, with
7237 @samp{"Headers"} being searched first.  A subframework is a framework
7238 directory that is in a framework's @samp{"Frameworks"} directory.
7239 Includes of subframework headers can only appear in a header of a
7240 framework that contains the subframework, or in a sibling subframework
7241 header.  Two subframeworks are siblings if they occur in the same
7242 framework.  A subframework should not have the same name as a
7243 framework, a warning will be issued if this is violated.  Currently a
7244 subframework cannot have subframeworks, in the future, the mechanism
7245 may be extended to support this.  The standard frameworks can be found
7246 in @samp{"/System/Library/Frameworks"} and
7247 @samp{"/Library/Frameworks"}.  An example include looks like
7248 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7249 the name of the framework and header.h is found in the
7250 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7252 @item -gused
7253 @opindex -gused
7254 Emit debugging information for symbols that are used.  For STABS
7255 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7256 This is by default ON@.
7258 @item -gfull
7259 @opindex -gfull
7260 Emit debugging information for all symbols and types.
7262 @item -mone-byte-bool
7263 @opindex -mone-byte-bool
7264 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7265 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7266 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7267 option has no effect on x86.
7269 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7270 to generate code that is not binary compatible with code generated
7271 without that switch.  Using this switch may require recompiling all
7272 other modules in a program, including system libraries.  Use this
7273 switch to conform to a non-default data model.
7275 @item -mfix-and-continue
7276 @itemx -ffix-and-continue
7277 @itemx -findirect-data
7278 @opindex mfix-and-continue
7279 @opindex ffix-and-continue
7280 @opindex findirect-data
7281 Generate code suitable for fast turn around development.  Needed to
7282 enable gdb to dynamically load @code{.o} files into already running
7283 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7284 are provided for backwards compatibility.
7286 @item -all_load
7287 @opindex all_load
7288 Loads all members of static archive libraries.
7289 See man ld(1) for more information.
7291 @item -arch_errors_fatal
7292 @opindex arch_errors_fatal
7293 Cause the errors having to do with files that have the wrong architecture
7294 to be fatal.
7296 @item -bind_at_load
7297 @opindex bind_at_load
7298 Causes the output file to be marked such that the dynamic linker will
7299 bind all undefined references when the file is loaded or launched.
7301 @item -bundle
7302 @opindex bundle
7303 Produce a Mach-o bundle format file.
7304 See man ld(1) for more information.
7306 @item -bundle_loader @var{executable}
7307 @opindex bundle_loader
7308 This option specifies the @var{executable} that will be loading the build
7309 output file being linked.  See man ld(1) for more information.
7311 @item -dynamiclib
7312 @opindex -dynamiclib
7313 When passed this option, GCC will produce a dynamic library instead of
7314 an executable when linking, using the Darwin @file{libtool} command.
7316 @item -force_cpusubtype_ALL
7317 @opindex -force_cpusubtype_ALL
7318 This causes GCC's output file to have the @var{ALL} subtype, instead of
7319 one controlled by the @option{-mcpu} or @option{-march} option.
7321 @item -allowable_client  @var{client_name}
7322 @itemx -client_name
7323 @itemx -compatibility_version
7324 @itemx -current_version
7325 @itemx -dead_strip
7326 @itemx -dependency-file
7327 @itemx -dylib_file
7328 @itemx -dylinker_install_name
7329 @itemx -dynamic
7330 @itemx -exported_symbols_list
7331 @itemx -filelist
7332 @itemx -flat_namespace
7333 @itemx -force_flat_namespace
7334 @itemx -headerpad_max_install_names
7335 @itemx -image_base
7336 @itemx -init
7337 @itemx -install_name
7338 @itemx -keep_private_externs
7339 @itemx -multi_module
7340 @itemx -multiply_defined
7341 @itemx -multiply_defined_unused
7342 @itemx -noall_load
7343 @itemx -no_dead_strip_inits_and_terms
7344 @itemx -nofixprebinding
7345 @itemx -nomultidefs
7346 @itemx -noprebind
7347 @itemx -noseglinkedit
7348 @itemx -pagezero_size
7349 @itemx -prebind
7350 @itemx -prebind_all_twolevel_modules
7351 @itemx -private_bundle
7352 @itemx -read_only_relocs
7353 @itemx -sectalign
7354 @itemx -sectobjectsymbols
7355 @itemx -whyload
7356 @itemx -seg1addr
7357 @itemx -sectcreate
7358 @itemx -sectobjectsymbols
7359 @itemx -sectorder
7360 @itemx -segaddr
7361 @itemx -segs_read_only_addr
7362 @itemx -segs_read_write_addr
7363 @itemx -seg_addr_table
7364 @itemx -seg_addr_table_filename
7365 @itemx -seglinkedit
7366 @itemx -segprot
7367 @itemx -segs_read_only_addr
7368 @itemx -segs_read_write_addr
7369 @itemx -single_module
7370 @itemx -static
7371 @itemx -sub_library
7372 @itemx -sub_umbrella
7373 @itemx -twolevel_namespace
7374 @itemx -umbrella
7375 @itemx -undefined
7376 @itemx -unexported_symbols_list
7377 @itemx -weak_reference_mismatches
7378 @itemx -whatsloaded
7380 @opindex allowable_client
7381 @opindex client_name
7382 @opindex compatibility_version
7383 @opindex current_version
7384 @opindex dead_strip
7385 @opindex dependency-file
7386 @opindex dylib_file
7387 @opindex dylinker_install_name
7388 @opindex dynamic
7389 @opindex exported_symbols_list
7390 @opindex filelist
7391 @opindex flat_namespace
7392 @opindex force_flat_namespace
7393 @opindex headerpad_max_install_names
7394 @opindex image_base
7395 @opindex init
7396 @opindex install_name
7397 @opindex keep_private_externs
7398 @opindex multi_module
7399 @opindex multiply_defined
7400 @opindex multiply_defined_unused
7401 @opindex noall_load
7402 @opindex no_dead_strip_inits_and_terms
7403 @opindex nofixprebinding
7404 @opindex nomultidefs
7405 @opindex noprebind
7406 @opindex noseglinkedit
7407 @opindex pagezero_size
7408 @opindex prebind
7409 @opindex prebind_all_twolevel_modules
7410 @opindex private_bundle
7411 @opindex read_only_relocs
7412 @opindex sectalign
7413 @opindex sectobjectsymbols
7414 @opindex whyload
7415 @opindex seg1addr
7416 @opindex sectcreate
7417 @opindex sectobjectsymbols
7418 @opindex sectorder
7419 @opindex segaddr
7420 @opindex segs_read_only_addr
7421 @opindex segs_read_write_addr
7422 @opindex seg_addr_table
7423 @opindex seg_addr_table_filename
7424 @opindex seglinkedit
7425 @opindex segprot
7426 @opindex segs_read_only_addr
7427 @opindex segs_read_write_addr
7428 @opindex single_module
7429 @opindex static
7430 @opindex sub_library
7431 @opindex sub_umbrella
7432 @opindex twolevel_namespace
7433 @opindex umbrella
7434 @opindex undefined
7435 @opindex unexported_symbols_list
7436 @opindex weak_reference_mismatches
7437 @opindex whatsloaded
7439 These options are passed to the Darwin linker.  The Darwin linker man page
7440 describes them in detail.
7441 @end table
7443 @node DEC Alpha Options
7444 @subsection DEC Alpha Options
7446 These @samp{-m} options are defined for the DEC Alpha implementations:
7448 @table @gcctabopt
7449 @item -mno-soft-float
7450 @itemx -msoft-float
7451 @opindex mno-soft-float
7452 @opindex msoft-float
7453 Use (do not use) the hardware floating-point instructions for
7454 floating-point operations.  When @option{-msoft-float} is specified,
7455 functions in @file{libgcc.a} will be used to perform floating-point
7456 operations.  Unless they are replaced by routines that emulate the
7457 floating-point operations, or compiled in such a way as to call such
7458 emulations routines, these routines will issue floating-point
7459 operations.   If you are compiling for an Alpha without floating-point
7460 operations, you must ensure that the library is built so as not to call
7461 them.
7463 Note that Alpha implementations without floating-point operations are
7464 required to have floating-point registers.
7466 @item -mfp-reg
7467 @itemx -mno-fp-regs
7468 @opindex mfp-reg
7469 @opindex mno-fp-regs
7470 Generate code that uses (does not use) the floating-point register set.
7471 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7472 register set is not used, floating point operands are passed in integer
7473 registers as if they were integers and floating-point results are passed
7474 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7475 so any function with a floating-point argument or return value called by code
7476 compiled with @option{-mno-fp-regs} must also be compiled with that
7477 option.
7479 A typical use of this option is building a kernel that does not use,
7480 and hence need not save and restore, any floating-point registers.
7482 @item -mieee
7483 @opindex mieee
7484 The Alpha architecture implements floating-point hardware optimized for
7485 maximum performance.  It is mostly compliant with the IEEE floating
7486 point standard.  However, for full compliance, software assistance is
7487 required.  This option generates code fully IEEE compliant code
7488 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7489 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7490 defined during compilation.  The resulting code is less efficient but is
7491 able to correctly support denormalized numbers and exceptional IEEE
7492 values such as not-a-number and plus/minus infinity.  Other Alpha
7493 compilers call this option @option{-ieee_with_no_inexact}.
7495 @item -mieee-with-inexact
7496 @opindex mieee-with-inexact
7497 This is like @option{-mieee} except the generated code also maintains
7498 the IEEE @var{inexact-flag}.  Turning on this option causes the
7499 generated code to implement fully-compliant IEEE math.  In addition to
7500 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7501 macro.  On some Alpha implementations the resulting code may execute
7502 significantly slower than the code generated by default.  Since there is
7503 very little code that depends on the @var{inexact-flag}, you should
7504 normally not specify this option.  Other Alpha compilers call this
7505 option @option{-ieee_with_inexact}.
7507 @item -mfp-trap-mode=@var{trap-mode}
7508 @opindex mfp-trap-mode
7509 This option controls what floating-point related traps are enabled.
7510 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7511 The trap mode can be set to one of four values:
7513 @table @samp
7514 @item n
7515 This is the default (normal) setting.  The only traps that are enabled
7516 are the ones that cannot be disabled in software (e.g., division by zero
7517 trap).
7519 @item u
7520 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7521 as well.
7523 @item su
7524 Like @samp{su}, but the instructions are marked to be safe for software
7525 completion (see Alpha architecture manual for details).
7527 @item sui
7528 Like @samp{su}, but inexact traps are enabled as well.
7529 @end table
7531 @item -mfp-rounding-mode=@var{rounding-mode}
7532 @opindex mfp-rounding-mode
7533 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7534 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7537 @table @samp
7538 @item n
7539 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7540 the nearest machine number or towards the even machine number in case
7541 of a tie.
7543 @item m
7544 Round towards minus infinity.
7546 @item c
7547 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7549 @item d
7550 Dynamic rounding mode.  A field in the floating point control register
7551 (@var{fpcr}, see Alpha architecture reference manual) controls the
7552 rounding mode in effect.  The C library initializes this register for
7553 rounding towards plus infinity.  Thus, unless your program modifies the
7554 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7555 @end table
7557 @item -mtrap-precision=@var{trap-precision}
7558 @opindex mtrap-precision
7559 In the Alpha architecture, floating point traps are imprecise.  This
7560 means without software assistance it is impossible to recover from a
7561 floating trap and program execution normally needs to be terminated.
7562 GCC can generate code that can assist operating system trap handlers
7563 in determining the exact location that caused a floating point trap.
7564 Depending on the requirements of an application, different levels of
7565 precisions can be selected:
7567 @table @samp
7568 @item p
7569 Program precision.  This option is the default and means a trap handler
7570 can only identify which program caused a floating point exception.
7572 @item f
7573 Function precision.  The trap handler can determine the function that
7574 caused a floating point exception.
7576 @item i
7577 Instruction precision.  The trap handler can determine the exact
7578 instruction that caused a floating point exception.
7579 @end table
7581 Other Alpha compilers provide the equivalent options called
7582 @option{-scope_safe} and @option{-resumption_safe}.
7584 @item -mieee-conformant
7585 @opindex mieee-conformant
7586 This option marks the generated code as IEEE conformant.  You must not
7587 use this option unless you also specify @option{-mtrap-precision=i} and either
7588 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7589 is to emit the line @samp{.eflag 48} in the function prologue of the
7590 generated assembly file.  Under DEC Unix, this has the effect that
7591 IEEE-conformant math library routines will be linked in.
7593 @item -mbuild-constants
7594 @opindex mbuild-constants
7595 Normally GCC examines a 32- or 64-bit integer constant to
7596 see if it can construct it from smaller constants in two or three
7597 instructions.  If it cannot, it will output the constant as a literal and
7598 generate code to load it from the data segment at runtime.
7600 Use this option to require GCC to construct @emph{all} integer constants
7601 using code, even if it takes more instructions (the maximum is six).
7603 You would typically use this option to build a shared library dynamic
7604 loader.  Itself a shared library, it must relocate itself in memory
7605 before it can find the variables and constants in its own data segment.
7607 @item -malpha-as
7608 @itemx -mgas
7609 @opindex malpha-as
7610 @opindex mgas
7611 Select whether to generate code to be assembled by the vendor-supplied
7612 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7614 @item -mbwx
7615 @itemx -mno-bwx
7616 @itemx -mcix
7617 @itemx -mno-cix
7618 @itemx -mfix
7619 @itemx -mno-fix
7620 @itemx -mmax
7621 @itemx -mno-max
7622 @opindex mbwx
7623 @opindex mno-bwx
7624 @opindex mcix
7625 @opindex mno-cix
7626 @opindex mfix
7627 @opindex mno-fix
7628 @opindex mmax
7629 @opindex mno-max
7630 Indicate whether GCC should generate code to use the optional BWX,
7631 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7632 sets supported by the CPU type specified via @option{-mcpu=} option or that
7633 of the CPU on which GCC was built if none was specified.
7635 @item -mfloat-vax
7636 @itemx -mfloat-ieee
7637 @opindex mfloat-vax
7638 @opindex mfloat-ieee
7639 Generate code that uses (does not use) VAX F and G floating point
7640 arithmetic instead of IEEE single and double precision.
7642 @item -mexplicit-relocs
7643 @itemx -mno-explicit-relocs
7644 @opindex mexplicit-relocs
7645 @opindex mno-explicit-relocs
7646 Older Alpha assemblers provided no way to generate symbol relocations
7647 except via assembler macros.  Use of these macros does not allow
7648 optimal instruction scheduling.  GNU binutils as of version 2.12
7649 supports a new syntax that allows the compiler to explicitly mark
7650 which relocations should apply to which instructions.  This option
7651 is mostly useful for debugging, as GCC detects the capabilities of
7652 the assembler when it is built and sets the default accordingly.
7654 @item -msmall-data
7655 @itemx -mlarge-data
7656 @opindex msmall-data
7657 @opindex mlarge-data
7658 When @option{-mexplicit-relocs} is in effect, static data is
7659 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7660 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7661 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7662 16-bit relocations off of the @code{$gp} register.  This limits the
7663 size of the small data area to 64KB, but allows the variables to be
7664 directly accessed via a single instruction.
7666 The default is @option{-mlarge-data}.  With this option the data area
7667 is limited to just below 2GB@.  Programs that require more than 2GB of
7668 data must use @code{malloc} or @code{mmap} to allocate the data in the
7669 heap instead of in the program's data segment.
7671 When generating code for shared libraries, @option{-fpic} implies
7672 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7674 @item -msmall-text
7675 @itemx -mlarge-text
7676 @opindex msmall-text
7677 @opindex mlarge-text
7678 When @option{-msmall-text} is used, the compiler assumes that the
7679 code of the entire program (or shared library) fits in 4MB, and is
7680 thus reachable with a branch instruction.  When @option{-msmall-data}
7681 is used, the compiler can assume that all local symbols share the
7682 same @code{$gp} value, and thus reduce the number of instructions
7683 required for a function call from 4 to 1.
7685 The default is @option{-mlarge-text}.
7687 @item -mcpu=@var{cpu_type}
7688 @opindex mcpu
7689 Set the instruction set and instruction scheduling parameters for
7690 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7691 style name or the corresponding chip number.  GCC supports scheduling
7692 parameters for the EV4, EV5 and EV6 family of processors and will
7693 choose the default values for the instruction set from the processor
7694 you specify.  If you do not specify a processor type, GCC will default
7695 to the processor on which the compiler was built.
7697 Supported values for @var{cpu_type} are
7699 @table @samp
7700 @item ev4
7701 @itemx ev45
7702 @itemx 21064
7703 Schedules as an EV4 and has no instruction set extensions.
7705 @item ev5
7706 @itemx 21164
7707 Schedules as an EV5 and has no instruction set extensions.
7709 @item ev56
7710 @itemx 21164a
7711 Schedules as an EV5 and supports the BWX extension.
7713 @item pca56
7714 @itemx 21164pc
7715 @itemx 21164PC
7716 Schedules as an EV5 and supports the BWX and MAX extensions.
7718 @item ev6
7719 @itemx 21264
7720 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7722 @item ev67
7723 @itemx 21264a
7724 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7725 @end table
7727 @item -mtune=@var{cpu_type}
7728 @opindex mtune
7729 Set only the instruction scheduling parameters for machine type
7730 @var{cpu_type}.  The instruction set is not changed.
7732 @item -mmemory-latency=@var{time}
7733 @opindex mmemory-latency
7734 Sets the latency the scheduler should assume for typical memory
7735 references as seen by the application.  This number is highly
7736 dependent on the memory access patterns used by the application
7737 and the size of the external cache on the machine.
7739 Valid options for @var{time} are
7741 @table @samp
7742 @item @var{number}
7743 A decimal number representing clock cycles.
7745 @item L1
7746 @itemx L2
7747 @itemx L3
7748 @itemx main
7749 The compiler contains estimates of the number of clock cycles for
7750 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7751 (also called Dcache, Scache, and Bcache), as well as to main memory.
7752 Note that L3 is only valid for EV5.
7754 @end table
7755 @end table
7757 @node DEC Alpha/VMS Options
7758 @subsection DEC Alpha/VMS Options
7760 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7762 @table @gcctabopt
7763 @item -mvms-return-codes
7764 @opindex mvms-return-codes
7765 Return VMS condition codes from main.  The default is to return POSIX
7766 style condition (e.g.@ error) codes.
7767 @end table
7769 @node FRV Options
7770 @subsection FRV Options
7771 @cindex FRV Options
7773 @table @gcctabopt
7774 @item -mgpr-32
7775 @opindex mgpr-32
7777 Only use the first 32 general purpose registers.
7779 @item -mgpr-64
7780 @opindex mgpr-64
7782 Use all 64 general purpose registers.
7784 @item -mfpr-32
7785 @opindex mfpr-32
7787 Use only the first 32 floating point registers.
7789 @item -mfpr-64
7790 @opindex mfpr-64
7792 Use all 64 floating point registers
7794 @item -mhard-float
7795 @opindex mhard-float
7797 Use hardware instructions for floating point operations.
7799 @item -msoft-float
7800 @opindex msoft-float
7802 Use library routines for floating point operations.
7804 @item -malloc-cc
7805 @opindex malloc-cc
7807 Dynamically allocate condition code registers.
7809 @item -mfixed-cc
7810 @opindex mfixed-cc
7812 Do not try to dynamically allocate condition code registers, only
7813 use @code{icc0} and @code{fcc0}.
7815 @item -mdword
7816 @opindex mdword
7818 Change ABI to use double word insns.
7820 @item -mno-dword
7821 @opindex mno-dword
7823 Do not use double word instructions.
7825 @item -mdouble
7826 @opindex mdouble
7828 Use floating point double instructions.
7830 @item -mno-double
7831 @opindex mno-double
7833 Do not use floating point double instructions.
7835 @item -mmedia
7836 @opindex mmedia
7838 Use media instructions.
7840 @item -mno-media
7841 @opindex mno-media
7843 Do not use media instructions.
7845 @item -mmuladd
7846 @opindex mmuladd
7848 Use multiply and add/subtract instructions.
7850 @item -mno-muladd
7851 @opindex mno-muladd
7853 Do not use multiply and add/subtract instructions.
7855 @item -mfdpic
7856 @opindex mfdpic
7858 Select the FDPIC ABI, that uses function descriptors to represent
7859 pointers to functions.  Without any PIC/PIE-related options, it
7860 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7861 assumes GOT entries and small data are within a 12-bit range from the
7862 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7863 are computed with 32 bits.
7865 @item -minline-plt
7866 @opindex minline-plt
7868 Enable inlining of PLT entries in function calls to functions that are
7869 not known to bind locally.  It has no effect without @option{-mfdpic}.
7870 It's enabled by default if optimizing for speed and compiling for
7871 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7872 optimization option such as @option{-O3} or above is present in the
7873 command line.
7875 @item -mgprel-ro
7876 @opindex mgprel-ro
7878 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7879 that is known to be in read-only sections.  It's enabled by default,
7880 except for @option{-fpic} or @option{-fpie}: even though it may help
7881 make the global offset table smaller, it trades 1 instruction for 4.
7882 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7883 one of which may be shared by multiple symbols, and it avoids the need
7884 for a GOT entry for the referenced symbol, so it's more likely to be a
7885 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7887 @item -multilib-library-pic
7888 @opindex multilib-library-pic
7890 Link with the (library, not FD) pic libraries.  It's implied by
7891 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7892 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7893 it explicitly.
7895 @item -mlinked-fp
7896 @opindex mlinked-fp
7898 Follow the EABI requirement of always creating a frame pointer whenever
7899 a stack frame is allocated.  This option is enabled by default and can
7900 be disabled with @option{-mno-linked-fp}.
7902 @item -mlong-calls
7903 @opindex mlong-calls
7905 Use indirect addressing to call functions outside the current
7906 compilation unit.  This allows the functions to be placed anywhere
7907 within the 32-bit address space.
7909 @item -malign-labels
7910 @opindex malign-labels
7912 Try to align labels to an 8-byte boundary by inserting nops into the
7913 previous packet.  This option only has an effect when VLIW packing
7914 is enabled.  It doesn't create new packets; it merely adds nops to
7915 existing ones.
7917 @item -mlibrary-pic
7918 @opindex mlibrary-pic
7920 Generate position-independent EABI code.
7922 @item -macc-4
7923 @opindex macc-4
7925 Use only the first four media accumulator registers.
7927 @item -macc-8
7928 @opindex macc-8
7930 Use all eight media accumulator registers.
7932 @item -mpack
7933 @opindex mpack
7935 Pack VLIW instructions.
7937 @item -mno-pack
7938 @opindex mno-pack
7940 Do not pack VLIW instructions.
7942 @item -mno-eflags
7943 @opindex mno-eflags
7945 Do not mark ABI switches in e_flags.
7947 @item -mcond-move
7948 @opindex mcond-move
7950 Enable the use of conditional-move instructions (default).
7952 This switch is mainly for debugging the compiler and will likely be removed
7953 in a future version.
7955 @item -mno-cond-move
7956 @opindex mno-cond-move
7958 Disable the use of conditional-move instructions.
7960 This switch is mainly for debugging the compiler and will likely be removed
7961 in a future version.
7963 @item -mscc
7964 @opindex mscc
7966 Enable the use of conditional set instructions (default).
7968 This switch is mainly for debugging the compiler and will likely be removed
7969 in a future version.
7971 @item -mno-scc
7972 @opindex mno-scc
7974 Disable the use of conditional set instructions.
7976 This switch is mainly for debugging the compiler and will likely be removed
7977 in a future version.
7979 @item -mcond-exec
7980 @opindex mcond-exec
7982 Enable the use of conditional execution (default).
7984 This switch is mainly for debugging the compiler and will likely be removed
7985 in a future version.
7987 @item -mno-cond-exec
7988 @opindex mno-cond-exec
7990 Disable the use of conditional execution.
7992 This switch is mainly for debugging the compiler and will likely be removed
7993 in a future version.
7995 @item -mvliw-branch
7996 @opindex mvliw-branch
7998 Run a pass to pack branches into VLIW instructions (default).
8000 This switch is mainly for debugging the compiler and will likely be removed
8001 in a future version.
8003 @item -mno-vliw-branch
8004 @opindex mno-vliw-branch
8006 Do not run a pass to pack branches into VLIW instructions.
8008 This switch is mainly for debugging the compiler and will likely be removed
8009 in a future version.
8011 @item -mmulti-cond-exec
8012 @opindex mmulti-cond-exec
8014 Enable optimization of @code{&&} and @code{||} in conditional execution
8015 (default).
8017 This switch is mainly for debugging the compiler and will likely be removed
8018 in a future version.
8020 @item -mno-multi-cond-exec
8021 @opindex mno-multi-cond-exec
8023 Disable optimization of @code{&&} and @code{||} in conditional execution.
8025 This switch is mainly for debugging the compiler and will likely be removed
8026 in a future version.
8028 @item -mnested-cond-exec
8029 @opindex mnested-cond-exec
8031 Enable nested conditional execution optimizations (default).
8033 This switch is mainly for debugging the compiler and will likely be removed
8034 in a future version.
8036 @item -mno-nested-cond-exec
8037 @opindex mno-nested-cond-exec
8039 Disable nested conditional execution optimizations.
8041 This switch is mainly for debugging the compiler and will likely be removed
8042 in a future version.
8044 @item -mtomcat-stats
8045 @opindex mtomcat-stats
8047 Cause gas to print out tomcat statistics.
8049 @item -mcpu=@var{cpu}
8050 @opindex mcpu
8052 Select the processor type for which to generate code.  Possible values are
8053 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8054 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8056 @end table
8058 @node H8/300 Options
8059 @subsection H8/300 Options
8061 These @samp{-m} options are defined for the H8/300 implementations:
8063 @table @gcctabopt
8064 @item -mrelax
8065 @opindex mrelax
8066 Shorten some address references at link time, when possible; uses the
8067 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8068 ld, Using ld}, for a fuller description.
8070 @item -mh
8071 @opindex mh
8072 Generate code for the H8/300H@.
8074 @item -ms
8075 @opindex ms
8076 Generate code for the H8S@.
8078 @item -mn
8079 @opindex mn
8080 Generate code for the H8S and H8/300H in the normal mode.  This switch
8081 must be used either with @option{-mh} or @option{-ms}.
8083 @item -ms2600
8084 @opindex ms2600
8085 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8087 @item -mint32
8088 @opindex mint32
8089 Make @code{int} data 32 bits by default.
8091 @item -malign-300
8092 @opindex malign-300
8093 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8094 The default for the H8/300H and H8S is to align longs and floats on 4
8095 byte boundaries.
8096 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8097 This option has no effect on the H8/300.
8098 @end table
8100 @node HPPA Options
8101 @subsection HPPA Options
8102 @cindex HPPA Options
8104 These @samp{-m} options are defined for the HPPA family of computers:
8106 @table @gcctabopt
8107 @item -march=@var{architecture-type}
8108 @opindex march
8109 Generate code for the specified architecture.  The choices for
8110 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8111 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8112 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8113 architecture option for your machine.  Code compiled for lower numbered
8114 architectures will run on higher numbered architectures, but not the
8115 other way around.
8117 @item -mpa-risc-1-0
8118 @itemx -mpa-risc-1-1
8119 @itemx -mpa-risc-2-0
8120 @opindex mpa-risc-1-0
8121 @opindex mpa-risc-1-1
8122 @opindex mpa-risc-2-0
8123 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8125 @item -mbig-switch
8126 @opindex mbig-switch
8127 Generate code suitable for big switch tables.  Use this option only if
8128 the assembler/linker complain about out of range branches within a switch
8129 table.
8131 @item -mjump-in-delay
8132 @opindex mjump-in-delay
8133 Fill delay slots of function calls with unconditional jump instructions
8134 by modifying the return pointer for the function call to be the target
8135 of the conditional jump.
8137 @item -mdisable-fpregs
8138 @opindex mdisable-fpregs
8139 Prevent floating point registers from being used in any manner.  This is
8140 necessary for compiling kernels which perform lazy context switching of
8141 floating point registers.  If you use this option and attempt to perform
8142 floating point operations, the compiler will abort.
8144 @item -mdisable-indexing
8145 @opindex mdisable-indexing
8146 Prevent the compiler from using indexing address modes.  This avoids some
8147 rather obscure problems when compiling MIG generated code under MACH@.
8149 @item -mno-space-regs
8150 @opindex mno-space-regs
8151 Generate code that assumes the target has no space registers.  This allows
8152 GCC to generate faster indirect calls and use unscaled index address modes.
8154 Such code is suitable for level 0 PA systems and kernels.
8156 @item -mfast-indirect-calls
8157 @opindex mfast-indirect-calls
8158 Generate code that assumes calls never cross space boundaries.  This
8159 allows GCC to emit code which performs faster indirect calls.
8161 This option will not work in the presence of shared libraries or nested
8162 functions.
8164 @item -mfixed-range=@var{register-range}
8165 @opindex mfixed-range
8166 Generate code treating the given register range as fixed registers.
8167 A fixed register is one that the register allocator can not use.  This is
8168 useful when compiling kernel code.  A register range is specified as
8169 two registers separated by a dash.  Multiple register ranges can be
8170 specified separated by a comma.
8172 @item -mlong-load-store
8173 @opindex mlong-load-store
8174 Generate 3-instruction load and store sequences as sometimes required by
8175 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8176 the HP compilers.
8178 @item -mportable-runtime
8179 @opindex mportable-runtime
8180 Use the portable calling conventions proposed by HP for ELF systems.
8182 @item -mgas
8183 @opindex mgas
8184 Enable the use of assembler directives only GAS understands.
8186 @item -mschedule=@var{cpu-type}
8187 @opindex mschedule
8188 Schedule code according to the constraints for the machine type
8189 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8190 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8191 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8192 proper scheduling option for your machine.  The default scheduling is
8193 @samp{8000}.
8195 @item -mlinker-opt
8196 @opindex mlinker-opt
8197 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8198 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8199 linkers in which they give bogus error messages when linking some programs.
8201 @item -msoft-float
8202 @opindex msoft-float
8203 Generate output containing library calls for floating point.
8204 @strong{Warning:} the requisite libraries are not available for all HPPA
8205 targets.  Normally the facilities of the machine's usual C compiler are
8206 used, but this cannot be done directly in cross-compilation.  You must make
8207 your own arrangements to provide suitable library functions for
8208 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8209 does provide software floating point support.
8211 @option{-msoft-float} changes the calling convention in the output file;
8212 therefore, it is only useful if you compile @emph{all} of a program with
8213 this option.  In particular, you need to compile @file{libgcc.a}, the
8214 library that comes with GCC, with @option{-msoft-float} in order for
8215 this to work.
8217 @item -msio
8218 @opindex msio
8219 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8220 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8221 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8222 options are available under HP-UX and HI-UX@.
8224 @item -mgnu-ld
8225 @opindex gnu-ld
8226 Use GNU ld specific options.  This passes @option{-shared} to ld when
8227 building a shared library.  It is the default when GCC is configured,
8228 explicitly or implicitly, with the GNU linker.  This option does not
8229 have any affect on which ld is called, it only changes what parameters
8230 are passed to that ld.  The ld that is called is determined by the
8231 @option{--with-ld} configure option, GCC's program search path, and
8232 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8233 using @samp{which `gcc -print-prog-name=ld`}.
8235 @item -mhp-ld
8236 @opindex hp-ld
8237 Use HP ld specific options.  This passes @option{-b} to ld when building
8238 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8239 links.  It is the default when GCC is configured, explicitly or
8240 implicitly, with the HP linker.  This option does not have any affect on
8241 which ld is called, it only changes what parameters are passed to that
8242 ld.  The ld that is called is determined by the @option{--with-ld}
8243 configure option, GCC's program search path, and finally by the user's
8244 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8245 `gcc -print-prog-name=ld`}.
8247 @item -mlong-calls
8248 @opindex mno-long-calls
8249 Generate code that uses long call sequences.  This ensures that a call
8250 is always able to reach linker generated stubs.  The default is to generate
8251 long calls only when the distance from the call site to the beginning
8252 of the function or translation unit, as the case may be, exceeds a
8253 predefined limit set by the branch type being used.  The limits for
8254 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8255 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8256 240,000 bytes.
8258 Distances are measured from the beginning of functions when using the
8259 @option{-ffunction-sections} option, or when using the @option{-mgas}
8260 and @option{-mno-portable-runtime} options together under HP-UX with
8261 the SOM linker.
8263 It is normally not desirable to use this option as it will degrade
8264 performance.  However, it may be useful in large applications,
8265 particularly when partial linking is used to build the application.
8267 The types of long calls used depends on the capabilities of the
8268 assembler and linker, and the type of code being generated.  The
8269 impact on systems that support long absolute calls, and long pic
8270 symbol-difference or pc-relative calls should be relatively small.
8271 However, an indirect call is used on 32-bit ELF systems in pic code
8272 and it is quite long.
8274 @item -munix=@var{unix-std}
8275 @opindex march
8276 Generate compiler predefines and select a startfile for the specified
8277 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8278 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8279 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8280 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8281 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8282 and later.
8284 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8285 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8286 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8287 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8288 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8289 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8291 It is @emph{important} to note that this option changes the interfaces
8292 for various library routines.  It also affects the operational behavior
8293 of the C library.  Thus, @emph{extreme} care is needed in using this
8294 option.
8296 Library code that is intended to operate with more than one UNIX
8297 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8298 as appropriate.  Most GNU software doesn't provide this capability.
8300 @item -nolibdld
8301 @opindex nolibdld
8302 Suppress the generation of link options to search libdld.sl when the
8303 @option{-static} option is specified on HP-UX 10 and later.
8305 @item -static
8306 @opindex static
8307 The HP-UX implementation of setlocale in libc has a dependency on
8308 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8309 when the @option{-static} option is specified, special link options
8310 are needed to resolve this dependency.
8312 On HP-UX 10 and later, the GCC driver adds the necessary options to
8313 link with libdld.sl when the @option{-static} option is specified.
8314 This causes the resulting binary to be dynamic.  On the 64-bit port,
8315 the linkers generate dynamic binaries by default in any case.  The
8316 @option{-nolibdld} option can be used to prevent the GCC driver from
8317 adding these link options.
8319 @item -threads
8320 @opindex threads
8321 Add support for multithreading with the @dfn{dce thread} library
8322 under HP-UX@.  This option sets flags for both the preprocessor and
8323 linker.
8324 @end table
8326 @node i386 and x86-64 Options
8327 @subsection Intel 386 and AMD x86-64 Options
8328 @cindex i386 Options
8329 @cindex x86-64 Options
8330 @cindex Intel 386 Options
8331 @cindex AMD x86-64 Options
8333 These @samp{-m} options are defined for the i386 and x86-64 family of
8334 computers:
8336 @table @gcctabopt
8337 @item -mtune=@var{cpu-type}
8338 @opindex mtune
8339 Tune to @var{cpu-type} everything applicable about the generated code, except
8340 for the ABI and the set of available instructions.  The choices for
8341 @var{cpu-type} are:
8342 @table @emph
8343 @item i386
8344 Original Intel's i386 CPU@.
8345 @item i486
8346 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8347 @item i586, pentium
8348 Intel Pentium CPU with no MMX support.
8349 @item pentium-mmx
8350 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8351 @item i686, pentiumpro
8352 Intel PentiumPro CPU@.
8353 @item pentium2
8354 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8355 @item pentium3, pentium3m
8356 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8357 support.
8358 @item pentium-m
8359 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8360 support.  Used by Centrino notebooks.
8361 @item pentium4, pentium4m
8362 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8363 @item prescott
8364 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8365 set support.
8366 @item nocona
8367 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8368 SSE2 and SSE3 instruction set support.
8369 @item k6
8370 AMD K6 CPU with MMX instruction set support.
8371 @item k6-2, k6-3
8372 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8373 @item athlon, athlon-tbird
8374 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8375 support.
8376 @item athlon-4, athlon-xp, athlon-mp
8377 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8378 instruction set support.
8379 @item k8, opteron, athlon64, athlon-fx
8380 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8381 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8382 @item winchip-c6
8383 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8384 set support.
8385 @item winchip2
8386 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8387 instruction set support.
8388 @item c3
8389 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8390 implemented for this chip.)
8391 @item c3-2
8392 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8393 implemented for this chip.)
8394 @end table
8396 While picking a specific @var{cpu-type} will schedule things appropriately
8397 for that particular chip, the compiler will not generate any code that
8398 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8399 being used.
8401 @item -march=@var{cpu-type}
8402 @opindex march
8403 Generate instructions for the machine type @var{cpu-type}.  The choices
8404 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8405 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8407 @item -mcpu=@var{cpu-type}
8408 @opindex mcpu
8409 A deprecated synonym for @option{-mtune}.
8411 @item -m386
8412 @itemx -m486
8413 @itemx -mpentium
8414 @itemx -mpentiumpro
8415 @opindex m386
8416 @opindex m486
8417 @opindex mpentium
8418 @opindex mpentiumpro
8419 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8420 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8421 These synonyms are deprecated.
8423 @item -mfpmath=@var{unit}
8424 @opindex march
8425 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8426 for @var{unit} are:
8428 @table @samp
8429 @item 387
8430 Use the standard 387 floating point coprocessor present majority of chips and
8431 emulated otherwise.  Code compiled with this option will run almost everywhere.
8432 The temporary results are computed in 80bit precision instead of precision
8433 specified by the type resulting in slightly different results compared to most
8434 of other chips.  See @option{-ffloat-store} for more detailed description.
8436 This is the default choice for i386 compiler.
8438 @item sse
8439 Use scalar floating point instructions present in the SSE instruction set.
8440 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8441 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8442 instruction set supports only single precision arithmetics, thus the double and
8443 extended precision arithmetics is still done using 387.  Later version, present
8444 only in Pentium4 and the future AMD x86-64 chips supports double precision
8445 arithmetics too.
8447 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8448 or @option{-msse2} switches to enable SSE extensions and make this option
8449 effective.  For the x86-64 compiler, these extensions are enabled by default.
8451 The resulting code should be considerably faster in the majority of cases and avoid
8452 the numerical instability problems of 387 code, but may break some existing
8453 code that expects temporaries to be 80bit.
8455 This is the default choice for the x86-64 compiler.
8457 @item sse,387
8458 Attempt to utilize both instruction sets at once.  This effectively double the
8459 amount of available registers and on chips with separate execution units for
8460 387 and SSE the execution resources too.  Use this option with care, as it is
8461 still experimental, because the GCC register allocator does not model separate
8462 functional units well resulting in instable performance.
8463 @end table
8465 @item -masm=@var{dialect}
8466 @opindex masm=@var{dialect}
8467 Output asm instructions using selected @var{dialect}.  Supported choices are
8468 @samp{intel} or @samp{att} (the default one).
8470 @item -mieee-fp
8471 @itemx -mno-ieee-fp
8472 @opindex mieee-fp
8473 @opindex mno-ieee-fp
8474 Control whether or not the compiler uses IEEE floating point
8475 comparisons.  These handle correctly the case where the result of a
8476 comparison is unordered.
8478 @item -msoft-float
8479 @opindex msoft-float
8480 Generate output containing library calls for floating point.
8481 @strong{Warning:} the requisite libraries are not part of GCC@.
8482 Normally the facilities of the machine's usual C compiler are used, but
8483 this can't be done directly in cross-compilation.  You must make your
8484 own arrangements to provide suitable library functions for
8485 cross-compilation.
8487 On machines where a function returns floating point results in the 80387
8488 register stack, some floating point opcodes may be emitted even if
8489 @option{-msoft-float} is used.
8491 @item -mno-fp-ret-in-387
8492 @opindex mno-fp-ret-in-387
8493 Do not use the FPU registers for return values of functions.
8495 The usual calling convention has functions return values of types
8496 @code{float} and @code{double} in an FPU register, even if there
8497 is no FPU@.  The idea is that the operating system should emulate
8498 an FPU@.
8500 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8501 in ordinary CPU registers instead.
8503 @item -mno-fancy-math-387
8504 @opindex mno-fancy-math-387
8505 Some 387 emulators do not support the @code{sin}, @code{cos} and
8506 @code{sqrt} instructions for the 387.  Specify this option to avoid
8507 generating those instructions.  This option is the default on FreeBSD,
8508 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8509 indicates that the target cpu will always have an FPU and so the
8510 instruction will not need emulation.  As of revision 2.6.1, these
8511 instructions are not generated unless you also use the
8512 @option{-funsafe-math-optimizations} switch.
8514 @item -malign-double
8515 @itemx -mno-align-double
8516 @opindex malign-double
8517 @opindex mno-align-double
8518 Control whether GCC aligns @code{double}, @code{long double}, and
8519 @code{long long} variables on a two word boundary or a one word
8520 boundary.  Aligning @code{double} variables on a two word boundary will
8521 produce code that runs somewhat faster on a @samp{Pentium} at the
8522 expense of more memory.
8524 @strong{Warning:} if you use the @option{-malign-double} switch,
8525 structures containing the above types will be aligned differently than
8526 the published application binary interface specifications for the 386
8527 and will not be binary compatible with structures in code compiled
8528 without that switch.
8530 @item -m96bit-long-double
8531 @itemx -m128bit-long-double
8532 @opindex m96bit-long-double
8533 @opindex m128bit-long-double
8534 These switches control the size of @code{long double} type.  The i386
8535 application binary interface specifies the size to be 96 bits,
8536 so @option{-m96bit-long-double} is the default in 32 bit mode.
8538 Modern architectures (Pentium and newer) would prefer @code{long double}
8539 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8540 conforming to the ABI, this would not be possible.  So specifying a
8541 @option{-m128bit-long-double} will align @code{long double}
8542 to a 16 byte boundary by padding the @code{long double} with an additional
8543 32 bit zero.
8545 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8546 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8548 Notice that neither of these options enable any extra precision over the x87
8549 standard of 80 bits for a @code{long double}.
8551 @strong{Warning:} if you override the default value for your target ABI, the
8552 structures and arrays containing @code{long double} variables will change
8553 their size as well as function calling convention for function taking
8554 @code{long double} will be modified.  Hence they will not be binary
8555 compatible with arrays or structures in code compiled without that switch.
8558 @item -msvr3-shlib
8559 @itemx -mno-svr3-shlib
8560 @opindex msvr3-shlib
8561 @opindex mno-svr3-shlib
8562 Control whether GCC places uninitialized local variables into the
8563 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8564 into @code{bss}.  These options are meaningful only on System V Release 3.
8566 @item -mrtd
8567 @opindex mrtd
8568 Use a different function-calling convention, in which functions that
8569 take a fixed number of arguments return with the @code{ret} @var{num}
8570 instruction, which pops their arguments while returning.  This saves one
8571 instruction in the caller since there is no need to pop the arguments
8572 there.
8574 You can specify that an individual function is called with this calling
8575 sequence with the function attribute @samp{stdcall}.  You can also
8576 override the @option{-mrtd} option by using the function attribute
8577 @samp{cdecl}.  @xref{Function Attributes}.
8579 @strong{Warning:} this calling convention is incompatible with the one
8580 normally used on Unix, so you cannot use it if you need to call
8581 libraries compiled with the Unix compiler.
8583 Also, you must provide function prototypes for all functions that
8584 take variable numbers of arguments (including @code{printf});
8585 otherwise incorrect code will be generated for calls to those
8586 functions.
8588 In addition, seriously incorrect code will result if you call a
8589 function with too many arguments.  (Normally, extra arguments are
8590 harmlessly ignored.)
8592 @item -mregparm=@var{num}
8593 @opindex mregparm
8594 Control how many registers are used to pass integer arguments.  By
8595 default, no registers are used to pass arguments, and at most 3
8596 registers can be used.  You can control this behavior for a specific
8597 function by using the function attribute @samp{regparm}.
8598 @xref{Function Attributes}.
8600 @strong{Warning:} if you use this switch, and
8601 @var{num} is nonzero, then you must build all modules with the same
8602 value, including any libraries.  This includes the system libraries and
8603 startup modules.
8605 @item -mpreferred-stack-boundary=@var{num}
8606 @opindex mpreferred-stack-boundary
8607 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8608 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8609 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8610 size (@option{-Os}), in which case the default is the minimum correct
8611 alignment (4 bytes for x86, and 8 bytes for x86-64).
8613 On Pentium and PentiumPro, @code{double} and @code{long double} values
8614 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8615 suffer significant run time performance penalties.  On Pentium III, the
8616 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8617 penalties if it is not 16 byte aligned.
8619 To ensure proper alignment of this values on the stack, the stack boundary
8620 must be as aligned as that required by any value stored on the stack.
8621 Further, every function must be generated such that it keeps the stack
8622 aligned.  Thus calling a function compiled with a higher preferred
8623 stack boundary from a function compiled with a lower preferred stack
8624 boundary will most likely misalign the stack.  It is recommended that
8625 libraries that use callbacks always use the default setting.
8627 This extra alignment does consume extra stack space, and generally
8628 increases code size.  Code that is sensitive to stack space usage, such
8629 as embedded systems and operating system kernels, may want to reduce the
8630 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8632 @item -mmmx
8633 @itemx -mno-mmx
8634 @item -msse
8635 @itemx -mno-sse
8636 @item -msse2
8637 @itemx -mno-sse2
8638 @item -msse3
8639 @itemx -mno-sse3
8640 @item -m3dnow
8641 @itemx -mno-3dnow
8642 @opindex mmmx
8643 @opindex mno-mmx
8644 @opindex msse
8645 @opindex mno-sse
8646 @opindex m3dnow
8647 @opindex mno-3dnow
8648 These switches enable or disable the use of built-in functions that allow
8649 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8650 instruction set.
8652 @xref{X86 Built-in Functions}, for details of the functions enabled
8653 and disabled by these switches.
8655 To have SSE/SSE2 instructions generated automatically from floating-point
8656 code, see @option{-mfpmath=sse}.
8658 @item -mpush-args
8659 @itemx -mno-push-args
8660 @opindex mpush-args
8661 @opindex mno-push-args
8662 Use PUSH operations to store outgoing parameters.  This method is shorter
8663 and usually equally fast as method using SUB/MOV operations and is enabled
8664 by default.  In some cases disabling it may improve performance because of
8665 improved scheduling and reduced dependencies.
8667 @item -maccumulate-outgoing-args
8668 @opindex maccumulate-outgoing-args
8669 If enabled, the maximum amount of space required for outgoing arguments will be
8670 computed in the function prologue.  This is faster on most modern CPUs
8671 because of reduced dependencies, improved scheduling and reduced stack usage
8672 when preferred stack boundary is not equal to 2.  The drawback is a notable
8673 increase in code size.  This switch implies @option{-mno-push-args}.
8675 @item -mthreads
8676 @opindex mthreads
8677 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8678 on thread-safe exception handling must compile and link all code with the
8679 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8680 @option{-D_MT}; when linking, it links in a special thread helper library
8681 @option{-lmingwthrd} which cleans up per thread exception handling data.
8683 @item -mno-align-stringops
8684 @opindex mno-align-stringops
8685 Do not align destination of inlined string operations.  This switch reduces
8686 code size and improves performance in case the destination is already aligned,
8687 but GCC doesn't know about it.
8689 @item -minline-all-stringops
8690 @opindex minline-all-stringops
8691 By default GCC inlines string operations only when destination is known to be
8692 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8693 size, but may improve performance of code that depends on fast memcpy, strlen
8694 and memset for short lengths.
8696 @item -momit-leaf-frame-pointer
8697 @opindex momit-leaf-frame-pointer
8698 Don't keep the frame pointer in a register for leaf functions.  This
8699 avoids the instructions to save, set up and restore frame pointers and
8700 makes an extra register available in leaf functions.  The option
8701 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8702 which might make debugging harder.
8704 @item -mtls-direct-seg-refs
8705 @itemx -mno-tls-direct-seg-refs
8706 @opindex mtls-direct-seg-refs
8707 Controls whether TLS variables may be accessed with offsets from the
8708 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8709 or whether the thread base pointer must be added.  Whether or not this
8710 is legal depends on the operating system, and whether it maps the
8711 segment to cover the entire TLS area.
8713 For systems that use GNU libc, the default is on.
8714 @end table
8716 These @samp{-m} switches are supported in addition to the above
8717 on AMD x86-64 processors in 64-bit environments.
8719 @table @gcctabopt
8720 @item -m32
8721 @itemx -m64
8722 @opindex m32
8723 @opindex m64
8724 Generate code for a 32-bit or 64-bit environment.
8725 The 32-bit environment sets int, long and pointer to 32 bits and
8726 generates code that runs on any i386 system.
8727 The 64-bit environment sets int to 32 bits and long and pointer
8728 to 64 bits and generates code for AMD's x86-64 architecture.
8730 @item -mno-red-zone
8731 @opindex no-red-zone
8732 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8733 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8734 stack pointer that will not be modified by signal or interrupt handlers
8735 and therefore can be used for temporary data without adjusting the stack
8736 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8738 @item -mcmodel=small
8739 @opindex mcmodel=small
8740 Generate code for the small code model: the program and its symbols must
8741 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8742 Programs can be statically or dynamically linked.  This is the default
8743 code model.
8745 @item -mcmodel=kernel
8746 @opindex mcmodel=kernel
8747 Generate code for the kernel code model.  The kernel runs in the
8748 negative 2 GB of the address space.
8749 This model has to be used for Linux kernel code.
8751 @item -mcmodel=medium
8752 @opindex mcmodel=medium
8753 Generate code for the medium model: The program is linked in the lower 2
8754 GB of the address space but symbols can be located anywhere in the
8755 address space.  Programs can be statically or dynamically linked, but
8756 building of shared libraries are not supported with the medium model.
8758 @item -mcmodel=large
8759 @opindex mcmodel=large
8760 Generate code for the large model: This model makes no assumptions
8761 about addresses and sizes of sections.  Currently GCC does not implement
8762 this model.
8763 @end table
8765 @node IA-64 Options
8766 @subsection IA-64 Options
8767 @cindex IA-64 Options
8769 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8771 @table @gcctabopt
8772 @item -mbig-endian
8773 @opindex mbig-endian
8774 Generate code for a big endian target.  This is the default for HP-UX@.
8776 @item -mlittle-endian
8777 @opindex mlittle-endian
8778 Generate code for a little endian target.  This is the default for AIX5
8779 and GNU/Linux.
8781 @item -mgnu-as
8782 @itemx -mno-gnu-as
8783 @opindex mgnu-as
8784 @opindex mno-gnu-as
8785 Generate (or don't) code for the GNU assembler.  This is the default.
8786 @c Also, this is the default if the configure option @option{--with-gnu-as}
8787 @c is used.
8789 @item -mgnu-ld
8790 @itemx -mno-gnu-ld
8791 @opindex mgnu-ld
8792 @opindex mno-gnu-ld
8793 Generate (or don't) code for the GNU linker.  This is the default.
8794 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8795 @c is used.
8797 @item -mno-pic
8798 @opindex mno-pic
8799 Generate code that does not use a global pointer register.  The result
8800 is not position independent code, and violates the IA-64 ABI@.
8802 @item -mvolatile-asm-stop
8803 @itemx -mno-volatile-asm-stop
8804 @opindex mvolatile-asm-stop
8805 @opindex mno-volatile-asm-stop
8806 Generate (or don't) a stop bit immediately before and after volatile asm
8807 statements.
8809 @item -mb-step
8810 @opindex mb-step
8811 Generate code that works around Itanium B step errata.
8813 @item -mregister-names
8814 @itemx -mno-register-names
8815 @opindex mregister-names
8816 @opindex mno-register-names
8817 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8818 the stacked registers.  This may make assembler output more readable.
8820 @item -mno-sdata
8821 @itemx -msdata
8822 @opindex mno-sdata
8823 @opindex msdata
8824 Disable (or enable) optimizations that use the small data section.  This may
8825 be useful for working around optimizer bugs.
8827 @item -mconstant-gp
8828 @opindex mconstant-gp
8829 Generate code that uses a single constant global pointer value.  This is
8830 useful when compiling kernel code.
8832 @item -mauto-pic
8833 @opindex mauto-pic
8834 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8835 This is useful when compiling firmware code.
8837 @item -minline-float-divide-min-latency
8838 @opindex minline-float-divide-min-latency
8839 Generate code for inline divides of floating point values
8840 using the minimum latency algorithm.
8842 @item -minline-float-divide-max-throughput
8843 @opindex minline-float-divide-max-throughput
8844 Generate code for inline divides of floating point values
8845 using the maximum throughput algorithm.
8847 @item -minline-int-divide-min-latency
8848 @opindex minline-int-divide-min-latency
8849 Generate code for inline divides of integer values
8850 using the minimum latency algorithm.
8852 @item -minline-int-divide-max-throughput
8853 @opindex minline-int-divide-max-throughput
8854 Generate code for inline divides of integer values
8855 using the maximum throughput algorithm.
8857 @item -minline-sqrt-min-latency
8858 @opindex minline-sqrt-min-latency
8859 Generate code for inline square roots
8860 using the minimum latency algorithm.
8862 @item -minline-sqrt-max-throughput
8863 @opindex minline-sqrt-max-throughput
8864 Generate code for inline square roots
8865 using the maximum throughput algorithm.
8867 @item -mno-dwarf2-asm
8868 @itemx -mdwarf2-asm
8869 @opindex mno-dwarf2-asm
8870 @opindex mdwarf2-asm
8871 Don't (or do) generate assembler code for the DWARF2 line number debugging
8872 info.  This may be useful when not using the GNU assembler.
8874 @item -mearly-stop-bits
8875 @itemx -mno-early-stop-bits
8876 @opindex mearly-stop-bits
8877 @opindex mno-early-stop-bits
8878 Allow stop bits to be placed earlier than immediately preceding the
8879 instruction that triggered the stop bit.  This can improve instruction
8880 scheduling, but does not always do so.
8882 @item -mfixed-range=@var{register-range}
8883 @opindex mfixed-range
8884 Generate code treating the given register range as fixed registers.
8885 A fixed register is one that the register allocator can not use.  This is
8886 useful when compiling kernel code.  A register range is specified as
8887 two registers separated by a dash.  Multiple register ranges can be
8888 specified separated by a comma.
8890 @item -mtls-size=@var{tls-size}
8891 @opindex mtls-size
8892 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
8895 @item -mtune-arch=@var{cpu-type}
8896 @opindex mtune-arch
8897 Tune the instruction scheduling for a particular CPU, Valid values are
8898 itanium, itanium1, merced, itanium2, and mckinley.
8900 @item -mt
8901 @itemx -pthread
8902 @opindex mt
8903 @opindex pthread
8904 Add support for multithreading using the POSIX threads library.  This
8905 option sets flags for both the preprocessor and linker.  It does
8906 not affect the thread safety of object code produced by the compiler or
8907 that of libraries supplied with it.  These are HP-UX specific flags.
8909 @item -milp32
8910 @itemx -mlp64
8911 @opindex milp32
8912 @opindex mlp64
8913 Generate code for a 32-bit or 64-bit environment.
8914 The 32-bit environment sets int, long and pointer to 32 bits.
8915 The 64-bit environment sets int to 32 bits and long and pointer
8916 to 64 bits.  These are HP-UX specific flags.
8918 @end table
8920 @node M32R/D Options
8921 @subsection M32R/D Options
8922 @cindex M32R/D options
8924 These @option{-m} options are defined for Renesas M32R/D architectures:
8926 @table @gcctabopt
8927 @item -m32r2
8928 @opindex m32r2
8929 Generate code for the M32R/2@.
8931 @item -m32rx
8932 @opindex m32rx
8933 Generate code for the M32R/X@.
8935 @item -m32r
8936 @opindex m32r
8937 Generate code for the M32R@.  This is the default.
8939 @item -mmodel=small
8940 @opindex mmodel=small
8941 Assume all objects live in the lower 16MB of memory (so that their addresses
8942 can be loaded with the @code{ld24} instruction), and assume all subroutines
8943 are reachable with the @code{bl} instruction.
8944 This is the default.
8946 The addressability of a particular object can be set with the
8947 @code{model} attribute.
8949 @item -mmodel=medium
8950 @opindex mmodel=medium
8951 Assume objects may be anywhere in the 32-bit address space (the compiler
8952 will generate @code{seth/add3} instructions to load their addresses), and
8953 assume all subroutines are reachable with the @code{bl} instruction.
8955 @item -mmodel=large
8956 @opindex mmodel=large
8957 Assume objects may be anywhere in the 32-bit address space (the compiler
8958 will generate @code{seth/add3} instructions to load their addresses), and
8959 assume subroutines may not be reachable with the @code{bl} instruction
8960 (the compiler will generate the much slower @code{seth/add3/jl}
8961 instruction sequence).
8963 @item -msdata=none
8964 @opindex msdata=none
8965 Disable use of the small data area.  Variables will be put into
8966 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8967 @code{section} attribute has been specified).
8968 This is the default.
8970 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8971 Objects may be explicitly put in the small data area with the
8972 @code{section} attribute using one of these sections.
8974 @item -msdata=sdata
8975 @opindex msdata=sdata
8976 Put small global and static data in the small data area, but do not
8977 generate special code to reference them.
8979 @item -msdata=use
8980 @opindex msdata=use
8981 Put small global and static data in the small data area, and generate
8982 special instructions to reference them.
8984 @item -G @var{num}
8985 @opindex G
8986 @cindex smaller data references
8987 Put global and static objects less than or equal to @var{num} bytes
8988 into the small data or bss sections instead of the normal data or bss
8989 sections.  The default value of @var{num} is 8.
8990 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8991 for this option to have any effect.
8993 All modules should be compiled with the same @option{-G @var{num}} value.
8994 Compiling with different values of @var{num} may or may not work; if it
8995 doesn't the linker will give an error message---incorrect code will not be
8996 generated.
8998 @item -mdebug
8999 @opindex mdebug
9000 Makes the M32R specific code in the compiler display some statistics
9001 that might help in debugging programs.
9003 @item -malign-loops
9004 @opindex malign-loops
9005 Align all loops to a 32-byte boundary.
9007 @item -mno-align-loops
9008 @opindex mno-align-loops
9009 Do not enforce a 32-byte alignment for loops.  This is the default.
9011 @item -missue-rate=@var{number}
9012 @opindex missue-rate=@var{number}
9013 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9014 or 2.
9016 @item -mbranch-cost=@var{number}
9017 @opindex mbranch-cost=@var{number}
9018 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9019 preferred over conditional code, if it is 2, then the opposite will
9020 apply.
9022 @item -mflush-trap=@var{number}
9023 @opindex mflush-trap=@var{number}
9024 Specifies the trap number to use to flush the cache.  The default is
9025 12.  Valid numbers are between 0 and 15 inclusive.
9027 @item -mno-flush-trap
9028 @opindex mno-flush-trap
9029 Specifies that the cache cannot be flushed by using a trap.
9031 @item -mflush-func=@var{name}
9032 @opindex mflush-func=@var{name}
9033 Specifies the name of the operating system function to call to flush
9034 the cache.  The default is @emph{_flush_cache}, but a function call
9035 will only be used if a trap is not available.
9037 @item -mno-flush-func
9038 @opindex mno-flush-func
9039 Indicates that there is no OS function for flushing the cache.
9041 @end table
9043 @node M680x0 Options
9044 @subsection M680x0 Options
9045 @cindex M680x0 options
9047 These are the @samp{-m} options defined for the 68000 series.  The default
9048 values for these options depends on which style of 68000 was selected when
9049 the compiler was configured; the defaults for the most common choices are
9050 given below.
9052 @table @gcctabopt
9053 @item -m68000
9054 @itemx -mc68000
9055 @opindex m68000
9056 @opindex mc68000
9057 Generate output for a 68000.  This is the default
9058 when the compiler is configured for 68000-based systems.
9060 Use this option for microcontrollers with a 68000 or EC000 core,
9061 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9063 @item -m68020
9064 @itemx -mc68020
9065 @opindex m68020
9066 @opindex mc68020
9067 Generate output for a 68020.  This is the default
9068 when the compiler is configured for 68020-based systems.
9070 @item -m68881
9071 @opindex m68881
9072 Generate output containing 68881 instructions for floating point.
9073 This is the default for most 68020 systems unless @option{--nfp} was
9074 specified when the compiler was configured.
9076 @item -m68030
9077 @opindex m68030
9078 Generate output for a 68030.  This is the default when the compiler is
9079 configured for 68030-based systems.
9081 @item -m68040
9082 @opindex m68040
9083 Generate output for a 68040.  This is the default when the compiler is
9084 configured for 68040-based systems.
9086 This option inhibits the use of 68881/68882 instructions that have to be
9087 emulated by software on the 68040.  Use this option if your 68040 does not
9088 have code to emulate those instructions.
9090 @item -m68060
9091 @opindex m68060
9092 Generate output for a 68060.  This is the default when the compiler is
9093 configured for 68060-based systems.
9095 This option inhibits the use of 68020 and 68881/68882 instructions that
9096 have to be emulated by software on the 68060.  Use this option if your 68060
9097 does not have code to emulate those instructions.
9099 @item -mcpu32
9100 @opindex mcpu32
9101 Generate output for a CPU32.  This is the default
9102 when the compiler is configured for CPU32-based systems.
9104 Use this option for microcontrollers with a
9105 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9106 68336, 68340, 68341, 68349 and 68360.
9108 @item -m5200
9109 @opindex m5200
9110 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9111 when the compiler is configured for 520X-based systems.
9113 Use this option for microcontroller with a 5200 core, including
9114 the MCF5202, MCF5203, MCF5204 and MCF5202.
9117 @item -m68020-40
9118 @opindex m68020-40
9119 Generate output for a 68040, without using any of the new instructions.
9120 This results in code which can run relatively efficiently on either a
9121 68020/68881 or a 68030 or a 68040.  The generated code does use the
9122 68881 instructions that are emulated on the 68040.
9124 @item -m68020-60
9125 @opindex m68020-60
9126 Generate output for a 68060, without using any of the new instructions.
9127 This results in code which can run relatively efficiently on either a
9128 68020/68881 or a 68030 or a 68040.  The generated code does use the
9129 68881 instructions that are emulated on the 68060.
9131 @item -msoft-float
9132 @opindex msoft-float
9133 Generate output containing library calls for floating point.
9134 @strong{Warning:} the requisite libraries are not available for all m68k
9135 targets.  Normally the facilities of the machine's usual C compiler are
9136 used, but this can't be done directly in cross-compilation.  You must
9137 make your own arrangements to provide suitable library functions for
9138 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9139 @samp{m68k-*-coff} do provide software floating point support.
9141 @item -mshort
9142 @opindex mshort
9143 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9144 Additionally, parameters passed on the stack are also aligned to a
9145 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9147 @item -mnobitfield
9148 @opindex mnobitfield
9149 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9150 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9152 @item -mbitfield
9153 @opindex mbitfield
9154 Do use the bit-field instructions.  The @option{-m68020} option implies
9155 @option{-mbitfield}.  This is the default if you use a configuration
9156 designed for a 68020.
9158 @item -mrtd
9159 @opindex mrtd
9160 Use a different function-calling convention, in which functions
9161 that take a fixed number of arguments return with the @code{rtd}
9162 instruction, which pops their arguments while returning.  This
9163 saves one instruction in the caller since there is no need to pop
9164 the arguments there.
9166 This calling convention is incompatible with the one normally
9167 used on Unix, so you cannot use it if you need to call libraries
9168 compiled with the Unix compiler.
9170 Also, you must provide function prototypes for all functions that
9171 take variable numbers of arguments (including @code{printf});
9172 otherwise incorrect code will be generated for calls to those
9173 functions.
9175 In addition, seriously incorrect code will result if you call a
9176 function with too many arguments.  (Normally, extra arguments are
9177 harmlessly ignored.)
9179 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9180 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9182 @item -malign-int
9183 @itemx -mno-align-int
9184 @opindex malign-int
9185 @opindex mno-align-int
9186 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9187 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9188 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9189 Aligning variables on 32-bit boundaries produces code that runs somewhat
9190 faster on processors with 32-bit busses at the expense of more memory.
9192 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9193 align structures containing the above types  differently than
9194 most published application binary interface specifications for the m68k.
9196 @item -mpcrel
9197 @opindex mpcrel
9198 Use the pc-relative addressing mode of the 68000 directly, instead of
9199 using a global offset table.  At present, this option implies @option{-fpic},
9200 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9201 not presently supported with @option{-mpcrel}, though this could be supported for
9202 68020 and higher processors.
9204 @item -mno-strict-align
9205 @itemx -mstrict-align
9206 @opindex mno-strict-align
9207 @opindex mstrict-align
9208 Do not (do) assume that unaligned memory references will be handled by
9209 the system.
9211 @item -msep-data
9212 Generate code that allows the data segment to be located in a different
9213 area of memory from the text segment.  This allows for execute in place in
9214 an environment without virtual memory management.  This option implies
9215 @option{-fPIC}.
9217 @item -mno-sep-data
9218 Generate code that assumes that the data segment follows the text segment.
9219 This is the default.
9221 @item -mid-shared-library
9222 Generate code that supports shared libraries via the library ID method.
9223 This allows for execute in place and shared libraries in an environment
9224 without virtual memory management.  This option implies @option{-fPIC}.
9226 @item -mno-id-shared-library
9227 Generate code that doesn't assume ID based shared libraries are being used.
9228 This is the default.
9230 @item -mshared-library-id=n
9231 Specified the identification number of the ID based shared library being
9232 compiled.  Specifying a value of 0 will generate more compact code, specifying
9233 other values will force the allocation of that number to the current
9234 library but is no more space or time efficient than omitting this option.
9236 @end table
9238 @node M68hc1x Options
9239 @subsection M68hc1x Options
9240 @cindex M68hc1x options
9242 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9243 microcontrollers.  The default values for these options depends on
9244 which style of microcontroller was selected when the compiler was configured;
9245 the defaults for the most common choices are given below.
9247 @table @gcctabopt
9248 @item -m6811
9249 @itemx -m68hc11
9250 @opindex m6811
9251 @opindex m68hc11
9252 Generate output for a 68HC11.  This is the default
9253 when the compiler is configured for 68HC11-based systems.
9255 @item -m6812
9256 @itemx -m68hc12
9257 @opindex m6812
9258 @opindex m68hc12
9259 Generate output for a 68HC12.  This is the default
9260 when the compiler is configured for 68HC12-based systems.
9262 @item -m68S12
9263 @itemx -m68hcs12
9264 @opindex m68S12
9265 @opindex m68hcs12
9266 Generate output for a 68HCS12.
9268 @item -mauto-incdec
9269 @opindex mauto-incdec
9270 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9271 addressing modes.
9273 @item -minmax
9274 @itemx -nominmax
9275 @opindex minmax
9276 @opindex mnominmax
9277 Enable the use of 68HC12 min and max instructions.
9279 @item -mlong-calls
9280 @itemx -mno-long-calls
9281 @opindex mlong-calls
9282 @opindex mno-long-calls
9283 Treat all calls as being far away (near).  If calls are assumed to be
9284 far away, the compiler will use the @code{call} instruction to
9285 call a function and the @code{rtc} instruction for returning.
9287 @item -mshort
9288 @opindex mshort
9289 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9291 @item -msoft-reg-count=@var{count}
9292 @opindex msoft-reg-count
9293 Specify the number of pseudo-soft registers which are used for the
9294 code generation.  The maximum number is 32.  Using more pseudo-soft
9295 register may or may not result in better code depending on the program.
9296 The default is 4 for 68HC11 and 2 for 68HC12.
9298 @end table
9300 @node MCore Options
9301 @subsection MCore Options
9302 @cindex MCore options
9304 These are the @samp{-m} options defined for the Motorola M*Core
9305 processors.
9307 @table @gcctabopt
9309 @item -mhardlit
9310 @itemx -mno-hardlit
9311 @opindex mhardlit
9312 @opindex mno-hardlit
9313 Inline constants into the code stream if it can be done in two
9314 instructions or less.
9316 @item -mdiv
9317 @itemx -mno-div
9318 @opindex mdiv
9319 @opindex mno-div
9320 Use the divide instruction.  (Enabled by default).
9322 @item -mrelax-immediate
9323 @itemx -mno-relax-immediate
9324 @opindex mrelax-immediate
9325 @opindex mno-relax-immediate
9326 Allow arbitrary sized immediates in bit operations.
9328 @item -mwide-bitfields
9329 @itemx -mno-wide-bitfields
9330 @opindex mwide-bitfields
9331 @opindex mno-wide-bitfields
9332 Always treat bit-fields as int-sized.
9334 @item -m4byte-functions
9335 @itemx -mno-4byte-functions
9336 @opindex m4byte-functions
9337 @opindex mno-4byte-functions
9338 Force all functions to be aligned to a four byte boundary.
9340 @item -mcallgraph-data
9341 @itemx -mno-callgraph-data
9342 @opindex mcallgraph-data
9343 @opindex mno-callgraph-data
9344 Emit callgraph information.
9346 @item -mslow-bytes
9347 @itemx -mno-slow-bytes
9348 @opindex mslow-bytes
9349 @opindex mno-slow-bytes
9350 Prefer word access when reading byte quantities.
9352 @item -mlittle-endian
9353 @itemx -mbig-endian
9354 @opindex mlittle-endian
9355 @opindex mbig-endian
9356 Generate code for a little endian target.
9358 @item -m210
9359 @itemx -m340
9360 @opindex m210
9361 @opindex m340
9362 Generate code for the 210 processor.
9363 @end table
9365 @node MIPS Options
9366 @subsection MIPS Options
9367 @cindex MIPS options
9369 @table @gcctabopt
9371 @item -EB
9372 @opindex EB
9373 Generate big-endian code.
9375 @item -EL
9376 @opindex EL
9377 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9378 configurations.
9380 @item -march=@var{arch}
9381 @opindex march
9382 Generate code that will run on @var{arch}, which can be the name of a
9383 generic MIPS ISA, or the name of a particular processor.
9384 The ISA names are:
9385 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9386 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9387 The processor names are:
9388 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9389 @samp{m4k},
9390 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9391 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9392 @samp{rm9000},
9393 @samp{orion},
9394 @samp{sb1},
9395 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9396 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9397 The special value @samp{from-abi} selects the
9398 most compatible architecture for the selected ABI (that is,
9399 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9401 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9402 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9403 @samp{vr} may be written @samp{r}.
9405 GCC defines two macros based on the value of this option.  The first
9406 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9407 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9408 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9409 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9410 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9412 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9413 above.  In other words, it will have the full prefix and will not
9414 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9415 the macro names the resolved architecture (either @samp{"mips1"} or
9416 @samp{"mips3"}).  It names the default architecture when no
9417 @option{-march} option is given.
9419 @item -mtune=@var{arch}
9420 @opindex mtune
9421 Optimize for @var{arch}.  Among other things, this option controls
9422 the way instructions are scheduled, and the perceived cost of arithmetic
9423 operations.  The list of @var{arch} values is the same as for
9424 @option{-march}.
9426 When this option is not used, GCC will optimize for the processor
9427 specified by @option{-march}.  By using @option{-march} and
9428 @option{-mtune} together, it is possible to generate code that will
9429 run on a family of processors, but optimize the code for one
9430 particular member of that family.
9432 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9433 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9434 @samp{-march} ones described above.
9436 @item -mips1
9437 @opindex mips1
9438 Equivalent to @samp{-march=mips1}.
9440 @item -mips2
9441 @opindex mips2
9442 Equivalent to @samp{-march=mips2}.
9444 @item -mips3
9445 @opindex mips3
9446 Equivalent to @samp{-march=mips3}.
9448 @item -mips4
9449 @opindex mips4
9450 Equivalent to @samp{-march=mips4}.
9452 @item -mips32
9453 @opindex mips32
9454 Equivalent to @samp{-march=mips32}.
9456 @item -mips32r2
9457 @opindex mips32r2
9458 Equivalent to @samp{-march=mips32r2}.
9460 @item -mips64
9461 @opindex mips64
9462 Equivalent to @samp{-march=mips64}.
9464 @item -mips16
9465 @itemx -mno-mips16
9466 @opindex mips16
9467 @opindex mno-mips16
9468 Use (do not use) the MIPS16 ISA@.
9470 @item -mabi=32
9471 @itemx -mabi=o64
9472 @itemx -mabi=n32
9473 @itemx -mabi=64
9474 @itemx -mabi=eabi
9475 @opindex mabi=32
9476 @opindex mabi=o64
9477 @opindex mabi=n32
9478 @opindex mabi=64
9479 @opindex mabi=eabi
9480 Generate code for the given ABI@.
9482 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9483 generates 64-bit code when you select a 64-bit architecture, but you
9484 can use @option{-mgp32} to get 32-bit code instead.
9486 For information about the O64 ABI, see
9487 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9489 @item -mabicalls
9490 @itemx -mno-abicalls
9491 @opindex mabicalls
9492 @opindex mno-abicalls
9493 Generate (do not generate) SVR4-style position-independent code.
9494 @option{-mabicalls} is the default for SVR4-based systems.
9496 @item -mxgot
9497 @itemx -mno-xgot
9498 @opindex mxgot
9499 @opindex mno-xgot
9500 Lift (do not lift) the usual restrictions on the size of the global
9501 offset table.
9503 GCC normally uses a single instruction to load values from the GOT@.
9504 While this is relatively efficient, it will only work if the GOT
9505 is smaller than about 64k.  Anything larger will cause the linker
9506 to report an error such as:
9508 @cindex relocation truncated to fit (MIPS)
9509 @smallexample
9510 relocation truncated to fit: R_MIPS_GOT16 foobar
9511 @end smallexample
9513 If this happens, you should recompile your code with @option{-mxgot}.
9514 It should then work with very large GOTs, although it will also be
9515 less efficient, since it will take three instructions to fetch the
9516 value of a global symbol.
9518 Note that some linkers can create multiple GOTs.  If you have such a
9519 linker, you should only need to use @option{-mxgot} when a single object
9520 file accesses more than 64k's worth of GOT entries.  Very few do.
9522 These options have no effect unless GCC is generating position
9523 independent code.
9525 @item -mgp32
9526 @opindex mgp32
9527 Assume that general-purpose registers are 32 bits wide.
9529 @item -mgp64
9530 @opindex mgp64
9531 Assume that general-purpose registers are 64 bits wide.
9533 @item -mfp32
9534 @opindex mfp32
9535 Assume that floating-point registers are 32 bits wide.
9537 @item -mfp64
9538 @opindex mfp64
9539 Assume that floating-point registers are 64 bits wide.
9541 @item -mhard-float
9542 @opindex mhard-float
9543 Use floating-point coprocessor instructions.
9545 @item -msoft-float
9546 @opindex msoft-float
9547 Do not use floating-point coprocessor instructions.  Implement
9548 floating-point calculations using library calls instead.
9550 @item -msingle-float
9551 @opindex msingle-float
9552 Assume that the floating-point coprocessor only supports single-precision
9553 operations.
9555 @itemx -mdouble-float
9556 @opindex mdouble-float
9557 Assume that the floating-point coprocessor supports double-precision
9558 operations.  This is the default.
9560 @itemx -mpaired-single
9561 @itemx -mno-paired-single
9562 @opindex mpaired-single
9563 @opindex mno-paired-single
9564 Use (do not use) paired-single floating-point instructions.
9565 @xref{MIPS Paired-Single Support}.  This option can only be used
9566 when generating 64-bit code and requires hardware floating-point
9567 support to be enabled.
9569 @itemx -mips3d
9570 @itemx -mno-mips3d
9571 @opindex mips3d
9572 @opindex mno-mips3d
9573 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9574 The option @option{-mips3d} implies @option{-mpaired-single}.
9576 @item -mint64
9577 @opindex mint64
9578 Force @code{int} and @code{long} types to be 64 bits wide.  See
9579 @option{-mlong32} for an explanation of the default and the way
9580 that the pointer size is determined.
9582 @item -mlong64
9583 @opindex mlong64
9584 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9585 an explanation of the default and the way that the pointer size is
9586 determined.
9588 @item -mlong32
9589 @opindex mlong32
9590 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9592 The default size of @code{int}s, @code{long}s and pointers depends on
9593 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9594 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9595 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9596 or the same size as integer registers, whichever is smaller.
9598 @item -G @var{num}
9599 @opindex G
9600 @cindex smaller data references (MIPS)
9601 @cindex gp-relative references (MIPS)
9602 Put global and static items less than or equal to @var{num} bytes into
9603 the small data or bss section instead of the normal data or bss section.
9604 This allows the data to be accessed using a single instruction.
9606 All modules should be compiled with the same @option{-G @var{num}}
9607 value.
9609 @item -membedded-data
9610 @itemx -mno-embedded-data
9611 @opindex membedded-data
9612 @opindex mno-embedded-data
9613 Allocate variables to the read-only data section first if possible, then
9614 next in the small data section if possible, otherwise in data.  This gives
9615 slightly slower code than the default, but reduces the amount of RAM required
9616 when executing, and thus may be preferred for some embedded systems.
9618 @item -muninit-const-in-rodata
9619 @itemx -mno-uninit-const-in-rodata
9620 @opindex muninit-const-in-rodata
9621 @opindex mno-uninit-const-in-rodata
9622 Put uninitialized @code{const} variables in the read-only data section.
9623 This option is only meaningful in conjunction with @option{-membedded-data}.
9625 @item -msplit-addresses
9626 @itemx -mno-split-addresses
9627 @opindex msplit-addresses
9628 @opindex mno-split-addresses
9629 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9630 relocation operators.  This option has been superceded by
9631 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9633 @item -mexplicit-relocs
9634 @itemx -mno-explicit-relocs
9635 @opindex mexplicit-relocs
9636 @opindex mno-explicit-relocs
9637 Use (do not use) assembler relocation operators when dealing with symbolic
9638 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9639 is to use assembler macros instead.
9641 @option{-mexplicit-relocs} is the default if GCC was configured
9642 to use an assembler that supports relocation operators.
9644 @item -mcheck-zero-division
9645 @itemx -mno-check-zero-division
9646 @opindex mcheck-zero-division
9647 @opindex mno-check-zero-division
9648 Trap (do not trap) on integer division by zero.  The default is
9649 @option{-mcheck-zero-division}.
9651 @item -mdivide-traps
9652 @itemx -mdivide-breaks
9653 @opindex mdivide-traps
9654 @opindex mdivide-breaks
9655 MIPS systems check for division by zero by generating either a
9656 conditional trap or a break instruction.  Using traps results in
9657 smaller code, but is only supported on MIPS II and later.  Also, some
9658 versions of the Linux kernel have a bug that prevents trap from
9659 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9660 allow conditional traps on architectures that support them and
9661 @option{-mdivide-breaks} to force the use of breaks.
9663 The default is usually @option{-mdivide-traps}, but this can be
9664 overridden at configure time using @option{--with-divide=breaks}.
9665 Divide-by-zero checks can be completely disabled using
9666 @option{-mno-check-zero-division}.
9668 @item -mmemcpy
9669 @itemx -mno-memcpy
9670 @opindex mmemcpy
9671 @opindex mno-memcpy
9672 Force (do not force) the use of @code{memcpy()} for non-trivial block
9673 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9674 most constant-sized copies.
9676 @item -mlong-calls
9677 @itemx -mno-long-calls
9678 @opindex mlong-calls
9679 @opindex mno-long-calls
9680 Disable (do not disable) use of the @code{jal} instruction.  Calling
9681 functions using @code{jal} is more efficient but requires the caller
9682 and callee to be in the same 256 megabyte segment.
9684 This option has no effect on abicalls code.  The default is
9685 @option{-mno-long-calls}.
9687 @item -mmad
9688 @itemx -mno-mad
9689 @opindex mmad
9690 @opindex mno-mad
9691 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9692 instructions, as provided by the R4650 ISA@.
9694 @item -mfused-madd
9695 @itemx -mno-fused-madd
9696 @opindex mfused-madd
9697 @opindex mno-fused-madd
9698 Enable (disable) use of the floating point multiply-accumulate
9699 instructions, when they are available.  The default is
9700 @option{-mfused-madd}.
9702 When multiply-accumulate instructions are used, the intermediate
9703 product is calculated to infinite precision and is not subject to
9704 the FCSR Flush to Zero bit.  This may be undesirable in some
9705 circumstances.
9707 @item -nocpp
9708 @opindex nocpp
9709 Tell the MIPS assembler to not run its preprocessor over user
9710 assembler files (with a @samp{.s} suffix) when assembling them.
9712 @item -mfix-r4000
9713 @itemx -mno-fix-r4000
9714 @opindex mfix-r4000
9715 @opindex mno-fix-r4000
9716 Work around certain R4000 CPU errata:
9717 @itemize @minus
9718 @item
9719 A double-word or a variable shift may give an incorrect result if executed
9720 immediately after starting an integer division.
9721 @item
9722 A double-word or a variable shift may give an incorrect result if executed
9723 while an integer multiplication is in progress.
9724 @item
9725 An integer division may give an incorrect result if started in a delay slot
9726 of a taken branch or a jump.
9727 @end itemize
9729 @item -mfix-r4400
9730 @itemx -mno-fix-r4400
9731 @opindex mfix-r4400
9732 @opindex mno-fix-r4400
9733 Work around certain R4400 CPU errata:
9734 @itemize @minus
9735 @item
9736 A double-word or a variable shift may give an incorrect result if executed
9737 immediately after starting an integer division.
9738 @end itemize
9740 @item -mfix-vr4120
9741 @itemx -mno-fix-vr4120
9742 @opindex mfix-vr4120
9743 Work around certain VR4120 errata:
9744 @itemize @minus
9745 @item
9746 @code{dmultu} does not always produce the correct result.
9747 @item
9748 @code{div} and @code{ddiv} do not always produce the correct result if one
9749 of the operands is negative.
9750 @end itemize
9751 The workarounds for the division errata rely on special functions in
9752 @file{libgcc.a}.  At present, these functions are only provided by
9753 the @code{mips64vr*-elf} configurations.
9755 Other VR4120 errata require a nop to be inserted between certain pairs of
9756 instructions.  These errata are handled by the assembler, not by GCC itself.
9758 @item -mfix-sb1
9759 @itemx -mno-fix-sb1
9760 @opindex mfix-sb1
9761 Work around certain SB-1 CPU core errata.
9762 (This flag currently works around the SB-1 revision 2
9763 ``F1'' and ``F2'' floating point errata.)
9765 @item -mflush-func=@var{func}
9766 @itemx -mno-flush-func
9767 @opindex mflush-func
9768 Specifies the function to call to flush the I and D caches, or to not
9769 call any such function.  If called, the function must take the same
9770 arguments as the common @code{_flush_func()}, that is, the address of the
9771 memory range for which the cache is being flushed, the size of the
9772 memory range, and the number 3 (to flush both caches).  The default
9773 depends on the target GCC was configured for, but commonly is either
9774 @samp{_flush_func} or @samp{__cpu_flush}.
9776 @item -mbranch-likely
9777 @itemx -mno-branch-likely
9778 @opindex mbranch-likely
9779 @opindex mno-branch-likely
9780 Enable or disable use of Branch Likely instructions, regardless of the
9781 default for the selected architecture.  By default, Branch Likely
9782 instructions may be generated if they are supported by the selected
9783 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9784 and processors which implement those architectures; for those, Branch
9785 Likely instructions will not be generated by default because the MIPS32
9786 and MIPS64 architectures specifically deprecate their use.
9788 @item -mfp-exceptions
9789 @itemx -mno-fp-exceptions
9790 @opindex mfp-exceptions
9791 Specifies whether FP exceptions are enabled.  This affects how we schedule
9792 FP instructions for some processors.  The default is that FP exceptions are
9793 enabled.
9795 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9796 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9797 FP pipe.
9799 @item -mvr4130-align
9800 @itemx -mno-vr4130-align
9801 @opindex mvr4130-align
9802 The VR4130 pipeline is two-way superscalar, but can only issue two
9803 instructions together if the first one is 8-byte aligned.  When this
9804 option is enabled, GCC will align pairs of instructions that it
9805 thinks should execute in parallel.
9807 This option only has an effect when optimizing for the VR4130.
9808 It normally makes code faster, but at the expense of making it bigger.
9809 It is enabled by default at optimization level @option{-O3}.
9810 @end table
9812 @node MMIX Options
9813 @subsection MMIX Options
9814 @cindex MMIX Options
9816 These options are defined for the MMIX:
9818 @table @gcctabopt
9819 @item -mlibfuncs
9820 @itemx -mno-libfuncs
9821 @opindex mlibfuncs
9822 @opindex mno-libfuncs
9823 Specify that intrinsic library functions are being compiled, passing all
9824 values in registers, no matter the size.
9826 @item -mepsilon
9827 @itemx -mno-epsilon
9828 @opindex mepsilon
9829 @opindex mno-epsilon
9830 Generate floating-point comparison instructions that compare with respect
9831 to the @code{rE} epsilon register.
9833 @item -mabi=mmixware
9834 @itemx -mabi=gnu
9835 @opindex mabi-mmixware
9836 @opindex mabi=gnu
9837 Generate code that passes function parameters and return values that (in
9838 the called function) are seen as registers @code{$0} and up, as opposed to
9839 the GNU ABI which uses global registers @code{$231} and up.
9841 @item -mzero-extend
9842 @itemx -mno-zero-extend
9843 @opindex mzero-extend
9844 @opindex mno-zero-extend
9845 When reading data from memory in sizes shorter than 64 bits, use (do not
9846 use) zero-extending load instructions by default, rather than
9847 sign-extending ones.
9849 @item -mknuthdiv
9850 @itemx -mno-knuthdiv
9851 @opindex mknuthdiv
9852 @opindex mno-knuthdiv
9853 Make the result of a division yielding a remainder have the same sign as
9854 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9855 remainder follows the sign of the dividend.  Both methods are
9856 arithmetically valid, the latter being almost exclusively used.
9858 @item -mtoplevel-symbols
9859 @itemx -mno-toplevel-symbols
9860 @opindex mtoplevel-symbols
9861 @opindex mno-toplevel-symbols
9862 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9863 code can be used with the @code{PREFIX} assembly directive.
9865 @item -melf
9866 @opindex melf
9867 Generate an executable in the ELF format, rather than the default
9868 @samp{mmo} format used by the @command{mmix} simulator.
9870 @item -mbranch-predict
9871 @itemx -mno-branch-predict
9872 @opindex mbranch-predict
9873 @opindex mno-branch-predict
9874 Use (do not use) the probable-branch instructions, when static branch
9875 prediction indicates a probable branch.
9877 @item -mbase-addresses
9878 @itemx -mno-base-addresses
9879 @opindex mbase-addresses
9880 @opindex mno-base-addresses
9881 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9882 base address automatically generates a request (handled by the assembler
9883 and the linker) for a constant to be set up in a global register.  The
9884 register is used for one or more base address requests within the range 0
9885 to 255 from the value held in the register.  The generally leads to short
9886 and fast code, but the number of different data items that can be
9887 addressed is limited.  This means that a program that uses lots of static
9888 data may require @option{-mno-base-addresses}.
9890 @item -msingle-exit
9891 @itemx -mno-single-exit
9892 @opindex msingle-exit
9893 @opindex mno-single-exit
9894 Force (do not force) generated code to have a single exit point in each
9895 function.
9896 @end table
9898 @node MN10300 Options
9899 @subsection MN10300 Options
9900 @cindex MN10300 options
9902 These @option{-m} options are defined for Matsushita MN10300 architectures:
9904 @table @gcctabopt
9905 @item -mmult-bug
9906 @opindex mmult-bug
9907 Generate code to avoid bugs in the multiply instructions for the MN10300
9908 processors.  This is the default.
9910 @item -mno-mult-bug
9911 @opindex mno-mult-bug
9912 Do not generate code to avoid bugs in the multiply instructions for the
9913 MN10300 processors.
9915 @item -mam33
9916 @opindex mam33
9917 Generate code which uses features specific to the AM33 processor.
9919 @item -mno-am33
9920 @opindex mno-am33
9921 Do not generate code which uses features specific to the AM33 processor.  This
9922 is the default.
9924 @item -mno-crt0
9925 @opindex mno-crt0
9926 Do not link in the C run-time initialization object file.
9928 @item -mrelax
9929 @opindex mrelax
9930 Indicate to the linker that it should perform a relaxation optimization pass
9931 to shorten branches, calls and absolute memory addresses.  This option only
9932 has an effect when used on the command line for the final link step.
9934 This option makes symbolic debugging impossible.
9935 @end table
9937 @node NS32K Options
9938 @subsection NS32K Options
9939 @cindex NS32K options
9941 These are the @samp{-m} options defined for the 32000 series.  The default
9942 values for these options depends on which style of 32000 was selected when
9943 the compiler was configured; the defaults for the most common choices are
9944 given below.
9946 @table @gcctabopt
9947 @item -m32032
9948 @itemx -m32032
9949 @opindex m32032
9950 @opindex m32032
9951 Generate output for a 32032.  This is the default
9952 when the compiler is configured for 32032 and 32016 based systems.
9954 @item -m32332
9955 @itemx -m32332
9956 @opindex m32332
9957 @opindex m32332
9958 Generate output for a 32332.  This is the default
9959 when the compiler is configured for 32332-based systems.
9961 @item -m32532
9962 @itemx -m32532
9963 @opindex m32532
9964 @opindex m32532
9965 Generate output for a 32532.  This is the default
9966 when the compiler is configured for 32532-based systems.
9968 @item -m32081
9969 @opindex m32081
9970 Generate output containing 32081 instructions for floating point.
9971 This is the default for all systems.
9973 @item -m32381
9974 @opindex m32381
9975 Generate output containing 32381 instructions for floating point.  This
9976 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9977 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9979 @item -mmulti-add
9980 @opindex mmulti-add
9981 Try and generate multiply-add floating point instructions @code{polyF}
9982 and @code{dotF}.  This option is only available if the @option{-m32381}
9983 option is in effect.  Using these instructions requires changes to
9984 register allocation which generally has a negative impact on
9985 performance.  This option should only be enabled when compiling code
9986 particularly likely to make heavy use of multiply-add instructions.
9988 @item -mnomulti-add
9989 @opindex mnomulti-add
9990 Do not try and generate multiply-add floating point instructions
9991 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9993 @item -msoft-float
9994 @opindex msoft-float
9995 Generate output containing library calls for floating point.
9996 @strong{Warning:} the requisite libraries may not be available.
9998 @item -mieee-compare
9999 @itemx -mno-ieee-compare
10000 @opindex mieee-compare
10001 @opindex mno-ieee-compare
10002 Control whether or not the compiler uses IEEE floating point
10003 comparisons.  These handle correctly the case where the result of a
10004 comparison is unordered.
10005 @strong{Warning:} the requisite kernel support may not be available.
10007 @item -mnobitfield
10008 @opindex mnobitfield
10009 Do not use the bit-field instructions.  On some machines it is faster to
10010 use shifting and masking operations.  This is the default for the pc532.
10012 @item -mbitfield
10013 @opindex mbitfield
10014 Do use the bit-field instructions.  This is the default for all platforms
10015 except the pc532.
10017 @item -mrtd
10018 @opindex mrtd
10019 Use a different function-calling convention, in which functions
10020 that take a fixed number of arguments return pop their
10021 arguments on return with the @code{ret} instruction.
10023 This calling convention is incompatible with the one normally
10024 used on Unix, so you cannot use it if you need to call libraries
10025 compiled with the Unix compiler.
10027 Also, you must provide function prototypes for all functions that
10028 take variable numbers of arguments (including @code{printf});
10029 otherwise incorrect code will be generated for calls to those
10030 functions.
10032 In addition, seriously incorrect code will result if you call a
10033 function with too many arguments.  (Normally, extra arguments are
10034 harmlessly ignored.)
10036 This option takes its name from the 680x0 @code{rtd} instruction.
10039 @item -mregparam
10040 @opindex mregparam
10041 Use a different function-calling convention where the first two arguments
10042 are passed in registers.
10044 This calling convention is incompatible with the one normally
10045 used on Unix, so you cannot use it if you need to call libraries
10046 compiled with the Unix compiler.
10048 @item -mnoregparam
10049 @opindex mnoregparam
10050 Do not pass any arguments in registers.  This is the default for all
10051 targets.
10053 @item -msb
10054 @opindex msb
10055 It is OK to use the sb as an index register which is always loaded with
10056 zero.  This is the default for the pc532-netbsd target.
10058 @item -mnosb
10059 @opindex mnosb
10060 The sb register is not available for use or has not been initialized to
10061 zero by the run time system.  This is the default for all targets except
10062 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10063 @option{-fpic} is set.
10065 @item -mhimem
10066 @opindex mhimem
10067 Many ns32000 series addressing modes use displacements of up to 512MB@.
10068 If an address is above 512MB then displacements from zero can not be used.
10069 This option causes code to be generated which can be loaded above 512MB@.
10070 This may be useful for operating systems or ROM code.
10072 @item -mnohimem
10073 @opindex mnohimem
10074 Assume code will be loaded in the first 512MB of virtual address space.
10075 This is the default for all platforms.
10077 @end table
10079 @node PDP-11 Options
10080 @subsection PDP-11 Options
10081 @cindex PDP-11 Options
10083 These options are defined for the PDP-11:
10085 @table @gcctabopt
10086 @item -mfpu
10087 @opindex mfpu
10088 Use hardware FPP floating point.  This is the default.  (FIS floating
10089 point on the PDP-11/40 is not supported.)
10091 @item -msoft-float
10092 @opindex msoft-float
10093 Do not use hardware floating point.
10095 @item -mac0
10096 @opindex mac0
10097 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10099 @item -mno-ac0
10100 @opindex mno-ac0
10101 Return floating-point results in memory.  This is the default.
10103 @item -m40
10104 @opindex m40
10105 Generate code for a PDP-11/40.
10107 @item -m45
10108 @opindex m45
10109 Generate code for a PDP-11/45.  This is the default.
10111 @item -m10
10112 @opindex m10
10113 Generate code for a PDP-11/10.
10115 @item -mbcopy-builtin
10116 @opindex bcopy-builtin
10117 Use inline @code{movmemhi} patterns for copying memory.  This is the
10118 default.
10120 @item -mbcopy
10121 @opindex mbcopy
10122 Do not use inline @code{movmemhi} patterns for copying memory.
10124 @item -mint16
10125 @itemx -mno-int32
10126 @opindex mint16
10127 @opindex mno-int32
10128 Use 16-bit @code{int}.  This is the default.
10130 @item -mint32
10131 @itemx -mno-int16
10132 @opindex mint32
10133 @opindex mno-int16
10134 Use 32-bit @code{int}.
10136 @item -mfloat64
10137 @itemx -mno-float32
10138 @opindex mfloat64
10139 @opindex mno-float32
10140 Use 64-bit @code{float}.  This is the default.
10142 @item -mfloat32
10143 @itemx -mno-float64
10144 @opindex mfloat32
10145 @opindex mno-float64
10146 Use 32-bit @code{float}.
10148 @item -mabshi
10149 @opindex mabshi
10150 Use @code{abshi2} pattern.  This is the default.
10152 @item -mno-abshi
10153 @opindex mno-abshi
10154 Do not use @code{abshi2} pattern.
10156 @item -mbranch-expensive
10157 @opindex mbranch-expensive
10158 Pretend that branches are expensive.  This is for experimenting with
10159 code generation only.
10161 @item -mbranch-cheap
10162 @opindex mbranch-cheap
10163 Do not pretend that branches are expensive.  This is the default.
10165 @item -msplit
10166 @opindex msplit
10167 Generate code for a system with split I&D@.
10169 @item -mno-split
10170 @opindex mno-split
10171 Generate code for a system without split I&D@.  This is the default.
10173 @item -munix-asm
10174 @opindex munix-asm
10175 Use Unix assembler syntax.  This is the default when configured for
10176 @samp{pdp11-*-bsd}.
10178 @item -mdec-asm
10179 @opindex mdec-asm
10180 Use DEC assembler syntax.  This is the default when configured for any
10181 PDP-11 target other than @samp{pdp11-*-bsd}.
10182 @end table
10184 @node PowerPC Options
10185 @subsection PowerPC Options
10186 @cindex PowerPC options
10188 These are listed under @xref{RS/6000 and PowerPC Options}.
10190 @node RS/6000 and PowerPC Options
10191 @subsection IBM RS/6000 and PowerPC Options
10192 @cindex RS/6000 and PowerPC Options
10193 @cindex IBM RS/6000 and PowerPC Options
10195 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10196 @table @gcctabopt
10197 @item -mpower
10198 @itemx -mno-power
10199 @itemx -mpower2
10200 @itemx -mno-power2
10201 @itemx -mpowerpc
10202 @itemx -mno-powerpc
10203 @itemx -mpowerpc-gpopt
10204 @itemx -mno-powerpc-gpopt
10205 @itemx -mpowerpc-gfxopt
10206 @itemx -mno-powerpc-gfxopt
10207 @itemx -mpowerpc64
10208 @itemx -mno-powerpc64
10209 @opindex mpower
10210 @opindex mno-power
10211 @opindex mpower2
10212 @opindex mno-power2
10213 @opindex mpowerpc
10214 @opindex mno-powerpc
10215 @opindex mpowerpc-gpopt
10216 @opindex mno-powerpc-gpopt
10217 @opindex mpowerpc-gfxopt
10218 @opindex mno-powerpc-gfxopt
10219 @opindex mpowerpc64
10220 @opindex mno-powerpc64
10221 GCC supports two related instruction set architectures for the
10222 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10223 instructions supported by the @samp{rios} chip set used in the original
10224 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10225 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10226 the IBM 4xx microprocessors.
10228 Neither architecture is a subset of the other.  However there is a
10229 large common subset of instructions supported by both.  An MQ
10230 register is included in processors supporting the POWER architecture.
10232 You use these options to specify which instructions are available on the
10233 processor you are using.  The default value of these options is
10234 determined when configuring GCC@.  Specifying the
10235 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10236 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10237 rather than the options listed above.
10239 The @option{-mpower} option allows GCC to generate instructions that
10240 are found only in the POWER architecture and to use the MQ register.
10241 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10242 to generate instructions that are present in the POWER2 architecture but
10243 not the original POWER architecture.
10245 The @option{-mpowerpc} option allows GCC to generate instructions that
10246 are found only in the 32-bit subset of the PowerPC architecture.
10247 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10248 GCC to use the optional PowerPC architecture instructions in the
10249 General Purpose group, including floating-point square root.  Specifying
10250 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10251 use the optional PowerPC architecture instructions in the Graphics
10252 group, including floating-point select.
10254 The @option{-mpowerpc64} option allows GCC to generate the additional
10255 64-bit instructions that are found in the full PowerPC64 architecture
10256 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10257 @option{-mno-powerpc64}.
10259 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10260 will use only the instructions in the common subset of both
10261 architectures plus some special AIX common-mode calls, and will not use
10262 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10263 permits GCC to use any instruction from either architecture and to
10264 allow use of the MQ register; specify this for the Motorola MPC601.
10266 @item -mnew-mnemonics
10267 @itemx -mold-mnemonics
10268 @opindex mnew-mnemonics
10269 @opindex mold-mnemonics
10270 Select which mnemonics to use in the generated assembler code.  With
10271 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10272 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10273 assembler mnemonics defined for the POWER architecture.  Instructions
10274 defined in only one architecture have only one mnemonic; GCC uses that
10275 mnemonic irrespective of which of these options is specified.
10277 GCC defaults to the mnemonics appropriate for the architecture in
10278 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10279 value of these option.  Unless you are building a cross-compiler, you
10280 should normally not specify either @option{-mnew-mnemonics} or
10281 @option{-mold-mnemonics}, but should instead accept the default.
10283 @item -mcpu=@var{cpu_type}
10284 @opindex mcpu
10285 Set architecture type, register usage, choice of mnemonics, and
10286 instruction scheduling parameters for machine type @var{cpu_type}.
10287 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10288 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10289 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10290 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10291 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10292 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10293 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10294 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10295 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10297 @option{-mcpu=common} selects a completely generic processor.  Code
10298 generated under this option will run on any POWER or PowerPC processor.
10299 GCC will use only the instructions in the common subset of both
10300 architectures, and will not use the MQ register.  GCC assumes a generic
10301 processor model for scheduling purposes.
10303 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10304 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10305 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10306 types, with an appropriate, generic processor model assumed for
10307 scheduling purposes.
10309 The other options specify a specific processor.  Code generated under
10310 those options will run best on that processor, and may not run at all on
10311 others.
10313 The @option{-mcpu} options automatically enable or disable the
10314 following options: @option{-maltivec}, @option{-mhard-float},
10315 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10316 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10317 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10318 @option{-mstring}.  The particular options set for any particular CPU
10319 will vary between compiler versions, depending on what setting seems
10320 to produce optimal code for that CPU; it doesn't necessarily reflect
10321 the actual hardware's capabilities.  If you wish to set an individual
10322 option to a particular value, you may specify it after the
10323 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10325 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10326 not enabled or disabled by the @option{-mcpu} option at present, since
10327 AIX does not have full support for these options.  You may still
10328 enable or disable them individually if you're sure it'll work in your
10329 environment.
10331 @item -mtune=@var{cpu_type}
10332 @opindex mtune
10333 Set the instruction scheduling parameters for machine type
10334 @var{cpu_type}, but do not set the architecture type, register usage, or
10335 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10336 values for @var{cpu_type} are used for @option{-mtune} as for
10337 @option{-mcpu}.  If both are specified, the code generated will use the
10338 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10339 scheduling parameters set by @option{-mtune}.
10341 @item -maltivec
10342 @itemx -mno-altivec
10343 @opindex maltivec
10344 @opindex mno-altivec
10345 Generate code that uses (does not use) AltiVec instructions, and also
10346 enable the use of built-in functions that allow more direct access to
10347 the AltiVec instruction set.  You may also need to set
10348 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10349 enhancements.
10351 @item -mabi=spe
10352 @opindex mabi=spe
10353 Extend the current ABI with SPE ABI extensions.  This does not change
10354 the default ABI, instead it adds the SPE ABI extensions to the current
10355 ABI@.
10357 @item -mabi=no-spe
10358 @opindex mabi=no-spe
10359 Disable Booke SPE ABI extensions for the current ABI@.
10361 @item -misel=@var{yes/no}
10362 @itemx -misel
10363 @opindex misel
10364 This switch enables or disables the generation of ISEL instructions.
10366 @item -mspe=@var{yes/no}
10367 @itemx -mspe
10368 @opindex mspe
10369 This switch enables or disables the generation of SPE simd
10370 instructions.
10372 @item -mfloat-gprs=@var{yes/single/double/no}
10373 @itemx -mfloat-gprs
10374 @opindex mfloat-gprs
10375 This switch enables or disables the generation of floating point
10376 operations on the general purpose registers for architectures that
10377 support it.
10379 The argument @var{yes} or @var{single} enables the use of
10380 single-precision floating point operations.
10382 The argument @var{double} enables the use of single and
10383 double-precision floating point operations.
10385 The argument @var{no} disables floating point operations on the
10386 general purpose registers.
10388 This option is currently only available on the MPC854x.
10390 @item -m32
10391 @itemx -m64
10392 @opindex m32
10393 @opindex m64
10394 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10395 targets (including GNU/Linux).  The 32-bit environment sets int, long
10396 and pointer to 32 bits and generates code that runs on any PowerPC
10397 variant.  The 64-bit environment sets int to 32 bits and long and
10398 pointer to 64 bits, and generates code for PowerPC64, as for
10399 @option{-mpowerpc64}.
10401 @item -mfull-toc
10402 @itemx -mno-fp-in-toc
10403 @itemx -mno-sum-in-toc
10404 @itemx -mminimal-toc
10405 @opindex mfull-toc
10406 @opindex mno-fp-in-toc
10407 @opindex mno-sum-in-toc
10408 @opindex mminimal-toc
10409 Modify generation of the TOC (Table Of Contents), which is created for
10410 every executable file.  The @option{-mfull-toc} option is selected by
10411 default.  In that case, GCC will allocate at least one TOC entry for
10412 each unique non-automatic variable reference in your program.  GCC
10413 will also place floating-point constants in the TOC@.  However, only
10414 16,384 entries are available in the TOC@.
10416 If you receive a linker error message that saying you have overflowed
10417 the available TOC space, you can reduce the amount of TOC space used
10418 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10419 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10420 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10421 generate code to calculate the sum of an address and a constant at
10422 run-time instead of putting that sum into the TOC@.  You may specify one
10423 or both of these options.  Each causes GCC to produce very slightly
10424 slower and larger code at the expense of conserving TOC space.
10426 If you still run out of space in the TOC even when you specify both of
10427 these options, specify @option{-mminimal-toc} instead.  This option causes
10428 GCC to make only one TOC entry for every file.  When you specify this
10429 option, GCC will produce code that is slower and larger but which
10430 uses extremely little TOC space.  You may wish to use this option
10431 only on files that contain less frequently executed code.
10433 @item -maix64
10434 @itemx -maix32
10435 @opindex maix64
10436 @opindex maix32
10437 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10438 @code{long} type, and the infrastructure needed to support them.
10439 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10440 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10441 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10443 @item -mxl-call
10444 @itemx -mno-xl-call
10445 @opindex mxl-call
10446 @opindex mno-xl-call
10447 On AIX, pass floating-point arguments to prototyped functions beyond the
10448 register save area (RSA) on the stack in addition to argument FPRs.  The
10449 AIX calling convention was extended but not initially documented to
10450 handle an obscure K&R C case of calling a function that takes the
10451 address of its arguments with fewer arguments than declared.  AIX XL
10452 compilers access floating point arguments which do not fit in the
10453 RSA from the stack when a subroutine is compiled without
10454 optimization.  Because always storing floating-point arguments on the
10455 stack is inefficient and rarely needed, this option is not enabled by
10456 default and only is necessary when calling subroutines compiled by AIX
10457 XL compilers without optimization.
10459 @item -mpe
10460 @opindex mpe
10461 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10462 application written to use message passing with special startup code to
10463 enable the application to run.  The system must have PE installed in the
10464 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10465 must be overridden with the @option{-specs=} option to specify the
10466 appropriate directory location.  The Parallel Environment does not
10467 support threads, so the @option{-mpe} option and the @option{-pthread}
10468 option are incompatible.
10470 @item -malign-natural
10471 @itemx -malign-power
10472 @opindex malign-natural
10473 @opindex malign-power
10474 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10475 @option{-malign-natural} overrides the ABI-defined alignment of larger
10476 types, such as floating-point doubles, on their natural size-based boundary.
10477 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10478 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10480 @item -msoft-float
10481 @itemx -mhard-float
10482 @opindex msoft-float
10483 @opindex mhard-float
10484 Generate code that does not use (uses) the floating-point register set.
10485 Software floating point emulation is provided if you use the
10486 @option{-msoft-float} option, and pass the option to GCC when linking.
10488 @item -mmultiple
10489 @itemx -mno-multiple
10490 @opindex mmultiple
10491 @opindex mno-multiple
10492 Generate code that uses (does not use) the load multiple word
10493 instructions and the store multiple word instructions.  These
10494 instructions are generated by default on POWER systems, and not
10495 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10496 endian PowerPC systems, since those instructions do not work when the
10497 processor is in little endian mode.  The exceptions are PPC740 and
10498 PPC750 which permit the instructions usage in little endian mode.
10500 @item -mstring
10501 @itemx -mno-string
10502 @opindex mstring
10503 @opindex mno-string
10504 Generate code that uses (does not use) the load string instructions
10505 and the store string word instructions to save multiple registers and
10506 do small block moves.  These instructions are generated by default on
10507 POWER systems, and not generated on PowerPC systems.  Do not use
10508 @option{-mstring} on little endian PowerPC systems, since those
10509 instructions do not work when the processor is in little endian mode.
10510 The exceptions are PPC740 and PPC750 which permit the instructions
10511 usage in little endian mode.
10513 @item -mupdate
10514 @itemx -mno-update
10515 @opindex mupdate
10516 @opindex mno-update
10517 Generate code that uses (does not use) the load or store instructions
10518 that update the base register to the address of the calculated memory
10519 location.  These instructions are generated by default.  If you use
10520 @option{-mno-update}, there is a small window between the time that the
10521 stack pointer is updated and the address of the previous frame is
10522 stored, which means code that walks the stack frame across interrupts or
10523 signals may get corrupted data.
10525 @item -mfused-madd
10526 @itemx -mno-fused-madd
10527 @opindex mfused-madd
10528 @opindex mno-fused-madd
10529 Generate code that uses (does not use) the floating point multiply and
10530 accumulate instructions.  These instructions are generated by default if
10531 hardware floating is used.
10533 @item -mno-bit-align
10534 @itemx -mbit-align
10535 @opindex mno-bit-align
10536 @opindex mbit-align
10537 On System V.4 and embedded PowerPC systems do not (do) force structures
10538 and unions that contain bit-fields to be aligned to the base type of the
10539 bit-field.
10541 For example, by default a structure containing nothing but 8
10542 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10543 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10544 the structure would be aligned to a 1 byte boundary and be one byte in
10545 size.
10547 @item -mno-strict-align
10548 @itemx -mstrict-align
10549 @opindex mno-strict-align
10550 @opindex mstrict-align
10551 On System V.4 and embedded PowerPC systems do not (do) assume that
10552 unaligned memory references will be handled by the system.
10554 @item -mrelocatable
10555 @itemx -mno-relocatable
10556 @opindex mrelocatable
10557 @opindex mno-relocatable
10558 On embedded PowerPC systems generate code that allows (does not allow)
10559 the program to be relocated to a different address at runtime.  If you
10560 use @option{-mrelocatable} on any module, all objects linked together must
10561 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10563 @item -mrelocatable-lib
10564 @itemx -mno-relocatable-lib
10565 @opindex mrelocatable-lib
10566 @opindex mno-relocatable-lib
10567 On embedded PowerPC systems generate code that allows (does not allow)
10568 the program to be relocated to a different address at runtime.  Modules
10569 compiled with @option{-mrelocatable-lib} can be linked with either modules
10570 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10571 with modules compiled with the @option{-mrelocatable} options.
10573 @item -mno-toc
10574 @itemx -mtoc
10575 @opindex mno-toc
10576 @opindex mtoc
10577 On System V.4 and embedded PowerPC systems do not (do) assume that
10578 register 2 contains a pointer to a global area pointing to the addresses
10579 used in the program.
10581 @item -mlittle
10582 @itemx -mlittle-endian
10583 @opindex mlittle
10584 @opindex mlittle-endian
10585 On System V.4 and embedded PowerPC systems compile code for the
10586 processor in little endian mode.  The @option{-mlittle-endian} option is
10587 the same as @option{-mlittle}.
10589 @item -mbig
10590 @itemx -mbig-endian
10591 @opindex mbig
10592 @opindex mbig-endian
10593 On System V.4 and embedded PowerPC systems compile code for the
10594 processor in big endian mode.  The @option{-mbig-endian} option is
10595 the same as @option{-mbig}.
10597 @item -mdynamic-no-pic
10598 @opindex mdynamic-no-pic
10599 On Darwin and Mac OS X systems, compile code so that it is not
10600 relocatable, but that its external references are relocatable.  The
10601 resulting code is suitable for applications, but not shared
10602 libraries.
10604 @item -mprioritize-restricted-insns=@var{priority}
10605 @opindex mprioritize-restricted-insns
10606 This option controls the priority that is assigned to
10607 dispatch-slot restricted instructions during the second scheduling
10608 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10609 @var{no/highest/second-highest} priority to dispatch slot restricted
10610 instructions.
10612 @item -msched-costly-dep=@var{dependence_type}
10613 @opindex msched-costly-dep
10614 This option controls which dependences are considered costly
10615 by the target during instruction scheduling.  The argument
10616 @var{dependence_type} takes one of the following values:
10617 @var{no}: no dependence is costly,
10618 @var{all}: all dependences are costly,
10619 @var{true_store_to_load}: a true dependence from store to load is costly,
10620 @var{store_to_load}: any dependence from store to load is costly,
10621 @var{number}: any dependence which latency >= @var{number} is costly.
10623 @item -minsert-sched-nops=@var{scheme}
10624 @opindex minsert-sched-nops
10625 This option controls which nop insertion scheme will be used during
10626 the second scheduling pass.  The argument @var{scheme} takes one of the
10627 following values:
10628 @var{no}: Don't insert nops.
10629 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10630 according to the scheduler's grouping.
10631 @var{regroup_exact}: Insert nops to force costly dependent insns into
10632 separate groups.  Insert exactly as many nops as needed to force an insn
10633 to a new group, according to the estimated processor grouping.
10634 @var{number}: Insert nops to force costly dependent insns into
10635 separate groups.  Insert @var{number} nops to force an insn to a new group.
10637 @item -mcall-sysv
10638 @opindex mcall-sysv
10639 On System V.4 and embedded PowerPC systems compile code using calling
10640 conventions that adheres to the March 1995 draft of the System V
10641 Application Binary Interface, PowerPC processor supplement.  This is the
10642 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10644 @item -mcall-sysv-eabi
10645 @opindex mcall-sysv-eabi
10646 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10648 @item -mcall-sysv-noeabi
10649 @opindex mcall-sysv-noeabi
10650 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10652 @item -mcall-solaris
10653 @opindex mcall-solaris
10654 On System V.4 and embedded PowerPC systems compile code for the Solaris
10655 operating system.
10657 @item -mcall-linux
10658 @opindex mcall-linux
10659 On System V.4 and embedded PowerPC systems compile code for the
10660 Linux-based GNU system.
10662 @item -mcall-gnu
10663 @opindex mcall-gnu
10664 On System V.4 and embedded PowerPC systems compile code for the
10665 Hurd-based GNU system.
10667 @item -mcall-netbsd
10668 @opindex mcall-netbsd
10669 On System V.4 and embedded PowerPC systems compile code for the
10670 NetBSD operating system.
10672 @item -maix-struct-return
10673 @opindex maix-struct-return
10674 Return all structures in memory (as specified by the AIX ABI)@.
10676 @item -msvr4-struct-return
10677 @opindex msvr4-struct-return
10678 Return structures smaller than 8 bytes in registers (as specified by the
10679 SVR4 ABI)@.
10681 @item -mabi=altivec
10682 @opindex mabi=altivec
10683 Extend the current ABI with AltiVec ABI extensions.  This does not
10684 change the default ABI, instead it adds the AltiVec ABI extensions to
10685 the current ABI@.
10687 @item -mabi=no-altivec
10688 @opindex mabi=no-altivec
10689 Disable AltiVec ABI extensions for the current ABI@.
10691 @item -mprototype
10692 @itemx -mno-prototype
10693 @opindex mprototype
10694 @opindex mno-prototype
10695 On System V.4 and embedded PowerPC systems assume that all calls to
10696 variable argument functions are properly prototyped.  Otherwise, the
10697 compiler must insert an instruction before every non prototyped call to
10698 set or clear bit 6 of the condition code register (@var{CR}) to
10699 indicate whether floating point values were passed in the floating point
10700 registers in case the function takes a variable arguments.  With
10701 @option{-mprototype}, only calls to prototyped variable argument functions
10702 will set or clear the bit.
10704 @item -msim
10705 @opindex msim
10706 On embedded PowerPC systems, assume that the startup module is called
10707 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10708 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10709 configurations.
10711 @item -mmvme
10712 @opindex mmvme
10713 On embedded PowerPC systems, assume that the startup module is called
10714 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10715 @file{libc.a}.
10717 @item -mads
10718 @opindex mads
10719 On embedded PowerPC systems, assume that the startup module is called
10720 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10721 @file{libc.a}.
10723 @item -myellowknife
10724 @opindex myellowknife
10725 On embedded PowerPC systems, assume that the startup module is called
10726 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10727 @file{libc.a}.
10729 @item -mvxworks
10730 @opindex mvxworks
10731 On System V.4 and embedded PowerPC systems, specify that you are
10732 compiling for a VxWorks system.
10734 @item -mwindiss
10735 @opindex mwindiss
10736 Specify that you are compiling for the WindISS simulation environment.
10738 @item -memb
10739 @opindex memb
10740 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10741 header to indicate that @samp{eabi} extended relocations are used.
10743 @item -meabi
10744 @itemx -mno-eabi
10745 @opindex meabi
10746 @opindex mno-eabi
10747 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10748 Embedded Applications Binary Interface (eabi) which is a set of
10749 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10750 means that the stack is aligned to an 8 byte boundary, a function
10751 @code{__eabi} is called to from @code{main} to set up the eabi
10752 environment, and the @option{-msdata} option can use both @code{r2} and
10753 @code{r13} to point to two separate small data areas.  Selecting
10754 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10755 do not call an initialization function from @code{main}, and the
10756 @option{-msdata} option will only use @code{r13} to point to a single
10757 small data area.  The @option{-meabi} option is on by default if you
10758 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10760 @item -msdata=eabi
10761 @opindex msdata=eabi
10762 On System V.4 and embedded PowerPC systems, put small initialized
10763 @code{const} global and static data in the @samp{.sdata2} section, which
10764 is pointed to by register @code{r2}.  Put small initialized
10765 non-@code{const} global and static data in the @samp{.sdata} section,
10766 which is pointed to by register @code{r13}.  Put small uninitialized
10767 global and static data in the @samp{.sbss} section, which is adjacent to
10768 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10769 incompatible with the @option{-mrelocatable} option.  The
10770 @option{-msdata=eabi} option also sets the @option{-memb} option.
10772 @item -msdata=sysv
10773 @opindex msdata=sysv
10774 On System V.4 and embedded PowerPC systems, put small global and static
10775 data in the @samp{.sdata} section, which is pointed to by register
10776 @code{r13}.  Put small uninitialized global and static data in the
10777 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10778 The @option{-msdata=sysv} option is incompatible with the
10779 @option{-mrelocatable} option.
10781 @item -msdata=default
10782 @itemx -msdata
10783 @opindex msdata=default
10784 @opindex msdata
10785 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10786 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10787 same as @option{-msdata=sysv}.
10789 @item -msdata-data
10790 @opindex msdata-data
10791 On System V.4 and embedded PowerPC systems, put small global and static
10792 data in the @samp{.sdata} section.  Put small uninitialized global and
10793 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10794 to address small data however.  This is the default behavior unless
10795 other @option{-msdata} options are used.
10797 @item -msdata=none
10798 @itemx -mno-sdata
10799 @opindex msdata=none
10800 @opindex mno-sdata
10801 On embedded PowerPC systems, put all initialized global and static data
10802 in the @samp{.data} section, and all uninitialized data in the
10803 @samp{.bss} section.
10805 @item -G @var{num}
10806 @opindex G
10807 @cindex smaller data references (PowerPC)
10808 @cindex .sdata/.sdata2 references (PowerPC)
10809 On embedded PowerPC systems, put global and static items less than or
10810 equal to @var{num} bytes into the small data or bss sections instead of
10811 the normal data or bss section.  By default, @var{num} is 8.  The
10812 @option{-G @var{num}} switch is also passed to the linker.
10813 All modules should be compiled with the same @option{-G @var{num}} value.
10815 @item -mregnames
10816 @itemx -mno-regnames
10817 @opindex mregnames
10818 @opindex mno-regnames
10819 On System V.4 and embedded PowerPC systems do (do not) emit register
10820 names in the assembly language output using symbolic forms.
10822 @item -mlongcall
10823 @itemx -mno-longcall
10824 @opindex mlongcall
10825 @opindex mno-longcall
10826 Default to making all function calls indirectly, using a register, so
10827 that functions which reside further than 32 megabytes (33,554,432
10828 bytes) from the current location can be called.  This setting can be
10829 overridden by the @code{shortcall} function attribute, or by
10830 @code{#pragma longcall(0)}.
10832 Some linkers are capable of detecting out-of-range calls and generating
10833 glue code on the fly.  On these systems, long calls are unnecessary and
10834 generate slower code.  As of this writing, the AIX linker can do this,
10835 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10836 to the GNU linker for 32-bit PowerPC systems as well.
10838 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10839 callee, L42'', plus a ``branch island'' (glue code).  The two target
10840 addresses represent the callee and the ``branch island''.  The
10841 Darwin/PPC linker will prefer the first address and generate a ``bl
10842 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10843 otherwise, the linker will generate ``bl L42'' to call the ``branch
10844 island''.  The ``branch island'' is appended to the body of the
10845 calling function; it computes the full 32-bit address of the callee
10846 and jumps to it.
10848 On Mach-O (Darwin) systems, this option directs the compiler emit to
10849 the glue for every direct call, and the Darwin linker decides whether
10850 to use or discard it.
10852 In the future, we may cause GCC to ignore all longcall specifications
10853 when the linker is known to generate glue.
10855 @item -pthread
10856 @opindex pthread
10857 Adds support for multithreading with the @dfn{pthreads} library.
10858 This option sets flags for both the preprocessor and linker.
10860 @end table
10862 @node S/390 and zSeries Options
10863 @subsection S/390 and zSeries Options
10864 @cindex S/390 and zSeries Options
10866 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10868 @table @gcctabopt
10869 @item -mhard-float
10870 @itemx -msoft-float
10871 @opindex mhard-float
10872 @opindex msoft-float
10873 Use (do not use) the hardware floating-point instructions and registers
10874 for floating-point operations.  When @option{-msoft-float} is specified,
10875 functions in @file{libgcc.a} will be used to perform floating-point
10876 operations.  When @option{-mhard-float} is specified, the compiler
10877 generates IEEE floating-point instructions.  This is the default.
10879 @item -mbackchain
10880 @itemx -mno-backchain
10881 @opindex mbackchain
10882 @opindex mno-backchain
10883 Store (do not store) the address of the caller's frame as backchain pointer
10884 into the callee's stack frame.
10885 A backchain may be needed to allow debugging using tools that do not understand
10886 DWARF-2 call frame information.
10887 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
10888 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
10889 the backchain is placed into the topmost word of the 96/160 byte register
10890 save area.
10892 In general, code compiled with @option{-mbackchain} is call-compatible with
10893 code compiled with @option{-mmo-backchain}; however, use of the backchain
10894 for debugging purposes usually requires that the whole binary is built with
10895 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
10896 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10897 to build a linux kernel use @option{-msoft-float}.
10899 The default is to not maintain the backchain.
10901 @item -mpacked-stack
10902 @item -mno-packed-stack
10903 @opindex mpacked-stack
10904 @opindex mno-packed-stack
10905 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
10906 specified, the compiler uses the all fields of the 96/160 byte register save
10907 area only for their default purpose; unused fields still take up stack space.
10908 When @option{-mpacked-stack} is specified, register save slots are densely
10909 packed at the top of the register save area; unused space is reused for other
10910 purposes, allowing for more efficient use of the available stack space.
10911 However, when @option{-mbackchain} is also in effect, the topmost word of
10912 the save area is always used to store the backchain, and the return address
10913 register is always saved two words below the backchain.
10915 As long as the stack frame backchain is not used, code generated with
10916 @option{-mpacked-stack} is call-compatible with code generated with
10917 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
10918 S/390 or zSeries generated code that uses the stack frame backchain at run
10919 time, not just for debugging purposes.  Such code is not call-compatible
10920 with code compiled with @option{-mpacked-stack}.  Also, note that the
10921 combination of @option{-mbackchain},
10922 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10923 to build a linux kernel use @option{-msoft-float}.
10925 The default is to not use the packed stack layout.
10927 @item -msmall-exec
10928 @itemx -mno-small-exec
10929 @opindex msmall-exec
10930 @opindex mno-small-exec
10931 Generate (or do not generate) code using the @code{bras} instruction
10932 to do subroutine calls.
10933 This only works reliably if the total executable size does not
10934 exceed 64k.  The default is to use the @code{basr} instruction instead,
10935 which does not have this limitation.
10937 @item -m64
10938 @itemx -m31
10939 @opindex m64
10940 @opindex m31
10941 When @option{-m31} is specified, generate code compliant to the
10942 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10943 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10944 particular to generate 64-bit instructions.  For the @samp{s390}
10945 targets, the default is @option{-m31}, while the @samp{s390x}
10946 targets default to @option{-m64}.
10948 @item -mzarch
10949 @itemx -mesa
10950 @opindex mzarch
10951 @opindex mesa
10952 When @option{-mzarch} is specified, generate code using the
10953 instructions available on z/Architecture.
10954 When @option{-mesa} is specified, generate code using the
10955 instructions available on ESA/390.  Note that @option{-mesa} is
10956 not possible with @option{-m64}.
10957 When generating code compliant to the GNU/Linux for S/390 ABI,
10958 the default is @option{-mesa}.  When generating code compliant
10959 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10961 @item -mmvcle
10962 @itemx -mno-mvcle
10963 @opindex mmvcle
10964 @opindex mno-mvcle
10965 Generate (or do not generate) code using the @code{mvcle} instruction
10966 to perform block moves.  When @option{-mno-mvcle} is specified,
10967 use a @code{mvc} loop instead.  This is the default.
10969 @item -mdebug
10970 @itemx -mno-debug
10971 @opindex mdebug
10972 @opindex mno-debug
10973 Print (or do not print) additional debug information when compiling.
10974 The default is to not print debug information.
10976 @item -march=@var{cpu-type}
10977 @opindex march
10978 Generate code that will run on @var{cpu-type}, which is the name of a system
10979 representing a certain processor type.  Possible values for
10980 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10981 When generating code using the instructions available on z/Architecture,
10982 the default is @option{-march=z900}.  Otherwise, the default is
10983 @option{-march=g5}.
10985 @item -mtune=@var{cpu-type}
10986 @opindex mtune
10987 Tune to @var{cpu-type} everything applicable about the generated code,
10988 except for the ABI and the set of available instructions.
10989 The list of @var{cpu-type} values is the same as for @option{-march}.
10990 The default is the value used for @option{-march}.
10992 @item -mtpf-trace
10993 @itemx -mno-tpf-trace
10994 @opindex mtpf-trace
10995 @opindex mno-tpf-trace
10996 Generate code that adds (does not add) in TPF OS specific branches to trace
10997 routines in the operating system.  This option is off by default, even
10998 when compiling for the TPF OS@.
11000 @item -mfused-madd
11001 @itemx -mno-fused-madd
11002 @opindex mfused-madd
11003 @opindex mno-fused-madd
11004 Generate code that uses (does not use) the floating point multiply and
11005 accumulate instructions.  These instructions are generated by default if
11006 hardware floating point is used.
11008 @item -mwarn-framesize=@var{framesize}
11009 @opindex mwarn-framesize
11010 Emit a warning if the current function exceeds the given frame size.  Because
11011 this is a compile time check it doesn't need to be a real problem when the program
11012 runs.  It is intended to identify functions which most probably cause
11013 a stack overflow.  It is useful to be used in an environment with limited stack
11014 size e.g.@: the linux kernel.
11016 @item -mwarn-dynamicstack
11017 @opindex mwarn-dynamicstack
11018 Emit a warning if the function calls alloca or uses dynamically
11019 sized arrays.  This is generally a bad idea with a limited stack size.
11021 @item -mstack-guard=@var{stack-guard}
11022 @item -mstack-size=@var{stack-size}
11023 @opindex mstack-guard
11024 @opindex mstack-size
11025 These arguments always have to be used in conjunction.  If they are present the s390
11026 back end emits additional instructions in the function prologue which trigger a trap
11027 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11028 (remember that the stack on s390 grows downward).  These options are intended to
11029 be used to help debugging stack overflow problems.  The additionally emitted code
11030 cause only little overhead and hence can also be used in production like systems
11031 without greater performance degradation.  The given values have to be exact
11032 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11033 In order to be efficient the extra code makes the assumption that the stack starts
11034 at an address aligned to the value given by @var{stack-size}.
11035 @end table
11037 @node SH Options
11038 @subsection SH Options
11040 These @samp{-m} options are defined for the SH implementations:
11042 @table @gcctabopt
11043 @item -m1
11044 @opindex m1
11045 Generate code for the SH1.
11047 @item -m2
11048 @opindex m2
11049 Generate code for the SH2.
11051 @item -m2e
11052 Generate code for the SH2e.
11054 @item -m3
11055 @opindex m3
11056 Generate code for the SH3.
11058 @item -m3e
11059 @opindex m3e
11060 Generate code for the SH3e.
11062 @item -m4-nofpu
11063 @opindex m4-nofpu
11064 Generate code for the SH4 without a floating-point unit.
11066 @item -m4-single-only
11067 @opindex m4-single-only
11068 Generate code for the SH4 with a floating-point unit that only
11069 supports single-precision arithmetic.
11071 @item -m4-single
11072 @opindex m4-single
11073 Generate code for the SH4 assuming the floating-point unit is in
11074 single-precision mode by default.
11076 @item -m4
11077 @opindex m4
11078 Generate code for the SH4.
11080 @item -m4a-nofpu
11081 @opindex m4a-nofpu
11082 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11083 floating-point unit is not used.
11085 @item -m4a-single-only
11086 @opindex m4a-single-only
11087 Generate code for the SH4a, in such a way that no double-precision
11088 floating point operations are used.
11090 @item -m4a-single
11091 @opindex m4a-single
11092 Generate code for the SH4a assuming the floating-point unit is in
11093 single-precision mode by default.
11095 @item -m4a
11096 @opindex m4a
11097 Generate code for the SH4a.
11099 @item -m4al
11100 @opindex m4al
11101 Same as @option{-m4a-nofpu}, except that it implicitly passes
11102 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11103 instructions at the moment.
11105 @item -mb
11106 @opindex mb
11107 Compile code for the processor in big endian mode.
11109 @item -ml
11110 @opindex ml
11111 Compile code for the processor in little endian mode.
11113 @item -mdalign
11114 @opindex mdalign
11115 Align doubles at 64-bit boundaries.  Note that this changes the calling
11116 conventions, and thus some functions from the standard C library will
11117 not work unless you recompile it first with @option{-mdalign}.
11119 @item -mrelax
11120 @opindex mrelax
11121 Shorten some address references at link time, when possible; uses the
11122 linker option @option{-relax}.
11124 @item -mbigtable
11125 @opindex mbigtable
11126 Use 32-bit offsets in @code{switch} tables.  The default is to use
11127 16-bit offsets.
11129 @item -mfmovd
11130 @opindex mfmovd
11131 Enable the use of the instruction @code{fmovd}.
11133 @item -mhitachi
11134 @opindex mhitachi
11135 Comply with the calling conventions defined by Renesas.
11137 @item -mrenesas
11138 @opindex mhitachi
11139 Comply with the calling conventions defined by Renesas.
11141 @item -mno-renesas
11142 @opindex mhitachi
11143 Comply with the calling conventions defined for GCC before the Renesas
11144 conventions were available.  This option is the default for all
11145 targets of the SH toolchain except for @samp{sh-symbianelf}.
11147 @item -mnomacsave
11148 @opindex mnomacsave
11149 Mark the @code{MAC} register as call-clobbered, even if
11150 @option{-mhitachi} is given.
11152 @item -mieee
11153 @opindex mieee
11154 Increase IEEE-compliance of floating-point code.
11156 @item -misize
11157 @opindex misize
11158 Dump instruction size and location in the assembly code.
11160 @item -mpadstruct
11161 @opindex mpadstruct
11162 This option is deprecated.  It pads structures to multiple of 4 bytes,
11163 which is incompatible with the SH ABI@.
11165 @item -mspace
11166 @opindex mspace
11167 Optimize for space instead of speed.  Implied by @option{-Os}.
11169 @item -mprefergot
11170 @opindex mprefergot
11171 When generating position-independent code, emit function calls using
11172 the Global Offset Table instead of the Procedure Linkage Table.
11174 @item -musermode
11175 @opindex musermode
11176 Generate a library function call to invalidate instruction cache
11177 entries, after fixing up a trampoline.  This library function call
11178 doesn't assume it can write to the whole memory address space.  This
11179 is the default when the target is @code{sh-*-linux*}.
11180 @end table
11182 @node SPARC Options
11183 @subsection SPARC Options
11184 @cindex SPARC options
11186 These @samp{-m} options are supported on the SPARC:
11188 @table @gcctabopt
11189 @item -mno-app-regs
11190 @itemx -mapp-regs
11191 @opindex mno-app-regs
11192 @opindex mapp-regs
11193 Specify @option{-mapp-regs} to generate output using the global registers
11194 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11195 is the default.
11197 To be fully SVR4 ABI compliant at the cost of some performance loss,
11198 specify @option{-mno-app-regs}.  You should compile libraries and system
11199 software with this option.
11201 @item -mfpu
11202 @itemx -mhard-float
11203 @opindex mfpu
11204 @opindex mhard-float
11205 Generate output containing floating point instructions.  This is the
11206 default.
11208 @item -mno-fpu
11209 @itemx -msoft-float
11210 @opindex mno-fpu
11211 @opindex msoft-float
11212 Generate output containing library calls for floating point.
11213 @strong{Warning:} the requisite libraries are not available for all SPARC
11214 targets.  Normally the facilities of the machine's usual C compiler are
11215 used, but this cannot be done directly in cross-compilation.  You must make
11216 your own arrangements to provide suitable library functions for
11217 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11218 @samp{sparclite-*-*} do provide software floating point support.
11220 @option{-msoft-float} changes the calling convention in the output file;
11221 therefore, it is only useful if you compile @emph{all} of a program with
11222 this option.  In particular, you need to compile @file{libgcc.a}, the
11223 library that comes with GCC, with @option{-msoft-float} in order for
11224 this to work.
11226 @item -mhard-quad-float
11227 @opindex mhard-quad-float
11228 Generate output containing quad-word (long double) floating point
11229 instructions.
11231 @item -msoft-quad-float
11232 @opindex msoft-quad-float
11233 Generate output containing library calls for quad-word (long double)
11234 floating point instructions.  The functions called are those specified
11235 in the SPARC ABI@.  This is the default.
11237 As of this writing, there are no SPARC implementations that have hardware
11238 support for the quad-word floating point instructions.  They all invoke
11239 a trap handler for one of these instructions, and then the trap handler
11240 emulates the effect of the instruction.  Because of the trap handler overhead,
11241 this is much slower than calling the ABI library routines.  Thus the
11242 @option{-msoft-quad-float} option is the default.
11244 @item -mno-unaligned-doubles
11245 @itemx -munaligned-doubles
11246 @opindex mno-unaligned-doubles
11247 @opindex munaligned-doubles
11248 Assume that doubles have 8 byte alignment.  This is the default.
11250 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11251 alignment only if they are contained in another type, or if they have an
11252 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11253 Specifying this option avoids some rare compatibility problems with code
11254 generated by other compilers.  It is not the default because it results
11255 in a performance loss, especially for floating point code.
11257 @item -mno-faster-structs
11258 @itemx -mfaster-structs
11259 @opindex mno-faster-structs
11260 @opindex mfaster-structs
11261 With @option{-mfaster-structs}, the compiler assumes that structures
11262 should have 8 byte alignment.  This enables the use of pairs of
11263 @code{ldd} and @code{std} instructions for copies in structure
11264 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11265 However, the use of this changed alignment directly violates the SPARC
11266 ABI@.  Thus, it's intended only for use on targets where the developer
11267 acknowledges that their resulting code will not be directly in line with
11268 the rules of the ABI@.
11270 @item -mimpure-text
11271 @opindex mimpure-text
11272 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11273 the compiler to not pass @option{-z text} to the linker when linking a
11274 shared object.  Using this option, you can link position-dependent
11275 code into a shared object.
11277 @option{-mimpure-text} suppresses the ``relocations remain against
11278 allocatable but non-writable sections'' linker error message.
11279 However, the necessary relocations will trigger copy-on-write, and the
11280 shared object is not actually shared across processes.  Instead of
11281 using @option{-mimpure-text}, you should compile all source code with
11282 @option{-fpic} or @option{-fPIC}.
11284 This option is only available on SunOS and Solaris.
11286 @item -mcpu=@var{cpu_type}
11287 @opindex mcpu
11288 Set the instruction set, register set, and instruction scheduling parameters
11289 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11290 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11291 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11292 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11293 @samp{ultrasparc3}.
11295 Default instruction scheduling parameters are used for values that select
11296 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11297 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11299 Here is a list of each supported architecture and their supported
11300 implementations.
11302 @smallexample
11303     v7:             cypress
11304     v8:             supersparc, hypersparc
11305     sparclite:      f930, f934, sparclite86x
11306     sparclet:       tsc701
11307     v9:             ultrasparc, ultrasparc3
11308 @end smallexample
11310 By default (unless configured otherwise), GCC generates code for the V7
11311 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11312 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11313 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11314 SPARCStation 1, 2, IPX etc.
11316 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11317 architecture.  The only difference from V7 code is that the compiler emits
11318 the integer multiply and integer divide instructions which exist in SPARC-V8
11319 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11320 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11321 2000 series.
11323 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11324 the SPARC architecture.  This adds the integer multiply, integer divide step
11325 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11326 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11327 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11328 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11329 MB86934 chip, which is the more recent SPARClite with FPU@.
11331 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11332 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11333 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11334 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11335 optimizes it for the TEMIC SPARClet chip.
11337 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11338 architecture.  This adds 64-bit integer and floating-point move instructions,
11339 3 additional floating-point condition code registers and conditional move
11340 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11341 optimizes it for the Sun UltraSPARC I/II chips.  With
11342 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11343 Sun UltraSPARC III chip.
11345 @item -mtune=@var{cpu_type}
11346 @opindex mtune
11347 Set the instruction scheduling parameters for machine type
11348 @var{cpu_type}, but do not set the instruction set or register set that the
11349 option @option{-mcpu=@var{cpu_type}} would.
11351 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11352 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11353 that select a particular cpu implementation.  Those are @samp{cypress},
11354 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11355 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11356 @samp{ultrasparc3}.
11358 @item -mv8plus
11359 @itemx -mno-v8plus
11360 @opindex mv8plus
11361 @opindex mno-v8plus
11362 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11363 difference from the V8 ABI is that the global and out registers are
11364 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11365 mode for all SPARC-V9 processors.
11367 @item -mvis
11368 @itemx -mno-vis
11369 @opindex mvis
11370 @opindex mno-vis
11371 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11372 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11373 @end table
11375 These @samp{-m} options are supported in addition to the above
11376 on SPARC-V9 processors in 64-bit environments:
11378 @table @gcctabopt
11379 @item -mlittle-endian
11380 @opindex mlittle-endian
11381 Generate code for a processor running in little-endian mode.  It is only
11382 available for a few configurations and most notably not on Solaris.
11384 @item -m32
11385 @itemx -m64
11386 @opindex m32
11387 @opindex m64
11388 Generate code for a 32-bit or 64-bit environment.
11389 The 32-bit environment sets int, long and pointer to 32 bits.
11390 The 64-bit environment sets int to 32 bits and long and pointer
11391 to 64 bits.
11393 @item -mcmodel=medlow
11394 @opindex mcmodel=medlow
11395 Generate code for the Medium/Low code model: 64-bit addresses, programs
11396 must be linked in the low 32 bits of memory.  Programs can be statically
11397 or dynamically linked.
11399 @item -mcmodel=medmid
11400 @opindex mcmodel=medmid
11401 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11402 must be linked in the low 44 bits of memory, the text and data segments must
11403 be less than 2GB in size and the data segment must be located within 2GB of
11404 the text segment.
11406 @item -mcmodel=medany
11407 @opindex mcmodel=medany
11408 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11409 may be linked anywhere in memory, the text and data segments must be less
11410 than 2GB in size and the data segment must be located within 2GB of the
11411 text segment.
11413 @item -mcmodel=embmedany
11414 @opindex mcmodel=embmedany
11415 Generate code for the Medium/Anywhere code model for embedded systems:
11416 64-bit addresses, the text and data segments must be less than 2GB in
11417 size, both starting anywhere in memory (determined at link time).  The
11418 global register %g4 points to the base of the data segment.  Programs
11419 are statically linked and PIC is not supported.
11421 @item -mstack-bias
11422 @itemx -mno-stack-bias
11423 @opindex mstack-bias
11424 @opindex mno-stack-bias
11425 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11426 frame pointer if present, are offset by @minus{}2047 which must be added back
11427 when making stack frame references.  This is the default in 64-bit mode.
11428 Otherwise, assume no such offset is present.
11429 @end table
11431 These switches are supported in addition to the above on Solaris:
11433 @table @gcctabopt
11434 @item -threads
11435 @opindex threads
11436 Add support for multithreading using the Solaris threads library.  This
11437 option sets flags for both the preprocessor and linker.  This option does
11438 not affect the thread safety of object code produced by the compiler or
11439 that of libraries supplied with it.
11441 @item -pthreads
11442 @opindex pthreads
11443 Add support for multithreading using the POSIX threads library.  This
11444 option sets flags for both the preprocessor and linker.  This option does
11445 not affect the thread safety of object code produced  by the compiler or
11446 that of libraries supplied with it.
11447 @end table
11449 @node System V Options
11450 @subsection Options for System V
11452 These additional options are available on System V Release 4 for
11453 compatibility with other compilers on those systems:
11455 @table @gcctabopt
11456 @item -G
11457 @opindex G
11458 Create a shared object.
11459 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11461 @item -Qy
11462 @opindex Qy
11463 Identify the versions of each tool used by the compiler, in a
11464 @code{.ident} assembler directive in the output.
11466 @item -Qn
11467 @opindex Qn
11468 Refrain from adding @code{.ident} directives to the output file (this is
11469 the default).
11471 @item -YP,@var{dirs}
11472 @opindex YP
11473 Search the directories @var{dirs}, and no others, for libraries
11474 specified with @option{-l}.
11476 @item -Ym,@var{dir}
11477 @opindex Ym
11478 Look in the directory @var{dir} to find the M4 preprocessor.
11479 The assembler uses this option.
11480 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11481 @c the generic assembler that comes with Solaris takes just -Ym.
11482 @end table
11484 @node TMS320C3x/C4x Options
11485 @subsection TMS320C3x/C4x Options
11486 @cindex TMS320C3x/C4x Options
11488 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11490 @table @gcctabopt
11492 @item -mcpu=@var{cpu_type}
11493 @opindex mcpu
11494 Set the instruction set, register set, and instruction scheduling
11495 parameters for machine type @var{cpu_type}.  Supported values for
11496 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11497 @samp{c44}.  The default is @samp{c40} to generate code for the
11498 TMS320C40.
11500 @item -mbig-memory
11501 @itemx -mbig
11502 @itemx -msmall-memory
11503 @itemx -msmall
11504 @opindex mbig-memory
11505 @opindex mbig
11506 @opindex msmall-memory
11507 @opindex msmall
11508 Generates code for the big or small memory model.  The small memory
11509 model assumed that all data fits into one 64K word page.  At run-time
11510 the data page (DP) register must be set to point to the 64K page
11511 containing the .bss and .data program sections.  The big memory model is
11512 the default and requires reloading of the DP register for every direct
11513 memory access.
11515 @item -mbk
11516 @itemx -mno-bk
11517 @opindex mbk
11518 @opindex mno-bk
11519 Allow (disallow) allocation of general integer operands into the block
11520 count register BK@.
11522 @item -mdb
11523 @itemx -mno-db
11524 @opindex mdb
11525 @opindex mno-db
11526 Enable (disable) generation of code using decrement and branch,
11527 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11528 on the safe side, this is disabled for the C3x, since the maximum
11529 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11530 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11531 that it can utilize the decrement and branch instruction, but will give
11532 up if there is more than one memory reference in the loop.  Thus a loop
11533 where the loop counter is decremented can generate slightly more
11534 efficient code, in cases where the RPTB instruction cannot be utilized.
11536 @item -mdp-isr-reload
11537 @itemx -mparanoid
11538 @opindex mdp-isr-reload
11539 @opindex mparanoid
11540 Force the DP register to be saved on entry to an interrupt service
11541 routine (ISR), reloaded to point to the data section, and restored on
11542 exit from the ISR@.  This should not be required unless someone has
11543 violated the small memory model by modifying the DP register, say within
11544 an object library.
11546 @item -mmpyi
11547 @itemx -mno-mpyi
11548 @opindex mmpyi
11549 @opindex mno-mpyi
11550 For the C3x use the 24-bit MPYI instruction for integer multiplies
11551 instead of a library call to guarantee 32-bit results.  Note that if one
11552 of the operands is a constant, then the multiplication will be performed
11553 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11554 then squaring operations are performed inline instead of a library call.
11556 @item -mfast-fix
11557 @itemx -mno-fast-fix
11558 @opindex mfast-fix
11559 @opindex mno-fast-fix
11560 The C3x/C4x FIX instruction to convert a floating point value to an
11561 integer value chooses the nearest integer less than or equal to the
11562 floating point value rather than to the nearest integer.  Thus if the
11563 floating point number is negative, the result will be incorrectly
11564 truncated an additional code is necessary to detect and correct this
11565 case.  This option can be used to disable generation of the additional
11566 code required to correct the result.
11568 @item -mrptb
11569 @itemx -mno-rptb
11570 @opindex mrptb
11571 @opindex mno-rptb
11572 Enable (disable) generation of repeat block sequences using the RPTB
11573 instruction for zero overhead looping.  The RPTB construct is only used
11574 for innermost loops that do not call functions or jump across the loop
11575 boundaries.  There is no advantage having nested RPTB loops due to the
11576 overhead required to save and restore the RC, RS, and RE registers.
11577 This is enabled by default with @option{-O2}.
11579 @item -mrpts=@var{count}
11580 @itemx -mno-rpts
11581 @opindex mrpts
11582 @opindex mno-rpts
11583 Enable (disable) the use of the single instruction repeat instruction
11584 RPTS@.  If a repeat block contains a single instruction, and the loop
11585 count can be guaranteed to be less than the value @var{count}, GCC will
11586 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11587 then a RPTS will be emitted even if the loop count cannot be determined
11588 at compile time.  Note that the repeated instruction following RPTS does
11589 not have to be reloaded from memory each iteration, thus freeing up the
11590 CPU buses for operands.  However, since interrupts are blocked by this
11591 instruction, it is disabled by default.
11593 @item -mloop-unsigned
11594 @itemx -mno-loop-unsigned
11595 @opindex mloop-unsigned
11596 @opindex mno-loop-unsigned
11597 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11598 is @math{2^{31} + 1} since these instructions test if the iteration count is
11599 negative to terminate the loop.  If the iteration count is unsigned
11600 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11601 exceeded.  This switch allows an unsigned iteration count.
11603 @item -mti
11604 @opindex mti
11605 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11606 with.  This also enforces compatibility with the API employed by the TI
11607 C3x C compiler.  For example, long doubles are passed as structures
11608 rather than in floating point registers.
11610 @item -mregparm
11611 @itemx -mmemparm
11612 @opindex mregparm
11613 @opindex mmemparm
11614 Generate code that uses registers (stack) for passing arguments to functions.
11615 By default, arguments are passed in registers where possible rather
11616 than by pushing arguments on to the stack.
11618 @item -mparallel-insns
11619 @itemx -mno-parallel-insns
11620 @opindex mparallel-insns
11621 @opindex mno-parallel-insns
11622 Allow the generation of parallel instructions.  This is enabled by
11623 default with @option{-O2}.
11625 @item -mparallel-mpy
11626 @itemx -mno-parallel-mpy
11627 @opindex mparallel-mpy
11628 @opindex mno-parallel-mpy
11629 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11630 provided @option{-mparallel-insns} is also specified.  These instructions have
11631 tight register constraints which can pessimize the code generation
11632 of large functions.
11634 @end table
11636 @node V850 Options
11637 @subsection V850 Options
11638 @cindex V850 Options
11640 These @samp{-m} options are defined for V850 implementations:
11642 @table @gcctabopt
11643 @item -mlong-calls
11644 @itemx -mno-long-calls
11645 @opindex mlong-calls
11646 @opindex mno-long-calls
11647 Treat all calls as being far away (near).  If calls are assumed to be
11648 far away, the compiler will always load the functions address up into a
11649 register, and call indirect through the pointer.
11651 @item -mno-ep
11652 @itemx -mep
11653 @opindex mno-ep
11654 @opindex mep
11655 Do not optimize (do optimize) basic blocks that use the same index
11656 pointer 4 or more times to copy pointer into the @code{ep} register, and
11657 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11658 option is on by default if you optimize.
11660 @item -mno-prolog-function
11661 @itemx -mprolog-function
11662 @opindex mno-prolog-function
11663 @opindex mprolog-function
11664 Do not use (do use) external functions to save and restore registers
11665 at the prologue and epilogue of a function.  The external functions
11666 are slower, but use less code space if more than one function saves
11667 the same number of registers.  The @option{-mprolog-function} option
11668 is on by default if you optimize.
11670 @item -mspace
11671 @opindex mspace
11672 Try to make the code as small as possible.  At present, this just turns
11673 on the @option{-mep} and @option{-mprolog-function} options.
11675 @item -mtda=@var{n}
11676 @opindex mtda
11677 Put static or global variables whose size is @var{n} bytes or less into
11678 the tiny data area that register @code{ep} points to.  The tiny data
11679 area can hold up to 256 bytes in total (128 bytes for byte references).
11681 @item -msda=@var{n}
11682 @opindex msda
11683 Put static or global variables whose size is @var{n} bytes or less into
11684 the small data area that register @code{gp} points to.  The small data
11685 area can hold up to 64 kilobytes.
11687 @item -mzda=@var{n}
11688 @opindex mzda
11689 Put static or global variables whose size is @var{n} bytes or less into
11690 the first 32 kilobytes of memory.
11692 @item -mv850
11693 @opindex mv850
11694 Specify that the target processor is the V850.
11696 @item -mbig-switch
11697 @opindex mbig-switch
11698 Generate code suitable for big switch tables.  Use this option only if
11699 the assembler/linker complain about out of range branches within a switch
11700 table.
11702 @item -mapp-regs
11703 @opindex mapp-regs
11704 This option will cause r2 and r5 to be used in the code generated by
11705 the compiler.  This setting is the default.
11707 @item -mno-app-regs
11708 @opindex mno-app-regs
11709 This option will cause r2 and r5 to be treated as fixed registers.
11711 @item -mv850e1
11712 @opindex mv850e1
11713 Specify that the target processor is the V850E1.  The preprocessor
11714 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11715 this option is used.
11717 @item -mv850e
11718 @opindex mv850e
11719 Specify that the target processor is the V850E@.  The preprocessor
11720 constant @samp{__v850e__} will be defined if this option is used.
11722 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11723 are defined then a default target processor will be chosen and the
11724 relevant @samp{__v850*__} preprocessor constant will be defined.
11726 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11727 defined, regardless of which processor variant is the target.
11729 @item -mdisable-callt
11730 @opindex mdisable-callt
11731 This option will suppress generation of the CALLT instruction for the
11732 v850e and v850e1 flavors of the v850 architecture.  The default is
11733 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11735 @end table
11737 @node VAX Options
11738 @subsection VAX Options
11739 @cindex VAX options
11741 These @samp{-m} options are defined for the VAX:
11743 @table @gcctabopt
11744 @item -munix
11745 @opindex munix
11746 Do not output certain jump instructions (@code{aobleq} and so on)
11747 that the Unix assembler for the VAX cannot handle across long
11748 ranges.
11750 @item -mgnu
11751 @opindex mgnu
11752 Do output those jump instructions, on the assumption that you
11753 will assemble with the GNU assembler.
11755 @item -mg
11756 @opindex mg
11757 Output code for g-format floating point numbers instead of d-format.
11758 @end table
11760 @node x86-64 Options
11761 @subsection x86-64 Options
11762 @cindex x86-64 options
11764 These are listed under @xref{i386 and x86-64 Options}.
11766 @node Xstormy16 Options
11767 @subsection Xstormy16 Options
11768 @cindex Xstormy16 Options
11770 These options are defined for Xstormy16:
11772 @table @gcctabopt
11773 @item -msim
11774 @opindex msim
11775 Choose startup files and linker script suitable for the simulator.
11776 @end table
11778 @node Xtensa Options
11779 @subsection Xtensa Options
11780 @cindex Xtensa Options
11782 These options are supported for Xtensa targets:
11784 @table @gcctabopt
11785 @item -mconst16
11786 @itemx -mno-const16
11787 @opindex mconst16
11788 @opindex mno-const16
11789 Enable or disable use of @code{CONST16} instructions for loading
11790 constant values.  The @code{CONST16} instruction is currently not a
11791 standard option from Tensilica.  When enabled, @code{CONST16}
11792 instructions are always used in place of the standard @code{L32R}
11793 instructions.  The use of @code{CONST16} is enabled by default only if
11794 the @code{L32R} instruction is not available.
11796 @item -mfused-madd
11797 @itemx -mno-fused-madd
11798 @opindex mfused-madd
11799 @opindex mno-fused-madd
11800 Enable or disable use of fused multiply/add and multiply/subtract
11801 instructions in the floating-point option.  This has no effect if the
11802 floating-point option is not also enabled.  Disabling fused multiply/add
11803 and multiply/subtract instructions forces the compiler to use separate
11804 instructions for the multiply and add/subtract operations.  This may be
11805 desirable in some cases where strict IEEE 754-compliant results are
11806 required: the fused multiply add/subtract instructions do not round the
11807 intermediate result, thereby producing results with @emph{more} bits of
11808 precision than specified by the IEEE standard.  Disabling fused multiply
11809 add/subtract instructions also ensures that the program output is not
11810 sensitive to the compiler's ability to combine multiply and add/subtract
11811 operations.
11813 @item -mtext-section-literals
11814 @itemx -mno-text-section-literals
11815 @opindex mtext-section-literals
11816 @opindex mno-text-section-literals
11817 Control the treatment of literal pools.  The default is
11818 @option{-mno-text-section-literals}, which places literals in a separate
11819 section in the output file.  This allows the literal pool to be placed
11820 in a data RAM/ROM, and it also allows the linker to combine literal
11821 pools from separate object files to remove redundant literals and
11822 improve code size.  With @option{-mtext-section-literals}, the literals
11823 are interspersed in the text section in order to keep them as close as
11824 possible to their references.  This may be necessary for large assembly
11825 files.
11827 @item -mtarget-align
11828 @itemx -mno-target-align
11829 @opindex mtarget-align
11830 @opindex mno-target-align
11831 When this option is enabled, GCC instructs the assembler to
11832 automatically align instructions to reduce branch penalties at the
11833 expense of some code density.  The assembler attempts to widen density
11834 instructions to align branch targets and the instructions following call
11835 instructions.  If there are not enough preceding safe density
11836 instructions to align a target, no widening will be performed.  The
11837 default is @option{-mtarget-align}.  These options do not affect the
11838 treatment of auto-aligned instructions like @code{LOOP}, which the
11839 assembler will always align, either by widening density instructions or
11840 by inserting no-op instructions.
11842 @item -mlongcalls
11843 @itemx -mno-longcalls
11844 @opindex mlongcalls
11845 @opindex mno-longcalls
11846 When this option is enabled, GCC instructs the assembler to translate
11847 direct calls to indirect calls unless it can determine that the target
11848 of a direct call is in the range allowed by the call instruction.  This
11849 translation typically occurs for calls to functions in other source
11850 files.  Specifically, the assembler translates a direct @code{CALL}
11851 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11852 The default is @option{-mno-longcalls}.  This option should be used in
11853 programs where the call target can potentially be out of range.  This
11854 option is implemented in the assembler, not the compiler, so the
11855 assembly code generated by GCC will still show direct call
11856 instructions---look at the disassembled object code to see the actual
11857 instructions.  Note that the assembler will use an indirect call for
11858 every cross-file call, not just those that really will be out of range.
11859 @end table
11861 @node zSeries Options
11862 @subsection zSeries Options
11863 @cindex zSeries options
11865 These are listed under @xref{S/390 and zSeries Options}.
11867 @node Code Gen Options
11868 @section Options for Code Generation Conventions
11869 @cindex code generation conventions
11870 @cindex options, code generation
11871 @cindex run-time options
11873 These machine-independent options control the interface conventions
11874 used in code generation.
11876 Most of them have both positive and negative forms; the negative form
11877 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11878 one of the forms is listed---the one which is not the default.  You
11879 can figure out the other form by either removing @samp{no-} or adding
11882 @table @gcctabopt
11883 @item -fbounds-check
11884 @opindex fbounds-check
11885 For front-ends that support it, generate additional code to check that
11886 indices used to access arrays are within the declared range.  This is
11887 currently only supported by the Java and Fortran 77 front-ends, where
11888 this option defaults to true and false respectively.
11890 @item -ftrapv
11891 @opindex ftrapv
11892 This option generates traps for signed overflow on addition, subtraction,
11893 multiplication operations.
11895 @item -fwrapv
11896 @opindex fwrapv
11897 This option instructs the compiler to assume that signed arithmetic
11898 overflow of addition, subtraction and multiplication wraps around
11899 using twos-complement representation.  This flag enables some optimizations
11900 and disables other.  This option is enabled by default for the Java
11901 front-end, as required by the Java language specification.
11903 @item -fexceptions
11904 @opindex fexceptions
11905 Enable exception handling.  Generates extra code needed to propagate
11906 exceptions.  For some targets, this implies GCC will generate frame
11907 unwind information for all functions, which can produce significant data
11908 size overhead, although it does not affect execution.  If you do not
11909 specify this option, GCC will enable it by default for languages like
11910 C++ which normally require exception handling, and disable it for
11911 languages like C that do not normally require it.  However, you may need
11912 to enable this option when compiling C code that needs to interoperate
11913 properly with exception handlers written in C++.  You may also wish to
11914 disable this option if you are compiling older C++ programs that don't
11915 use exception handling.
11917 @item -fnon-call-exceptions
11918 @opindex fnon-call-exceptions
11919 Generate code that allows trapping instructions to throw exceptions.
11920 Note that this requires platform-specific runtime support that does
11921 not exist everywhere.  Moreover, it only allows @emph{trapping}
11922 instructions to throw exceptions, i.e.@: memory references or floating
11923 point instructions.  It does not allow exceptions to be thrown from
11924 arbitrary signal handlers such as @code{SIGALRM}.
11926 @item -funwind-tables
11927 @opindex funwind-tables
11928 Similar to @option{-fexceptions}, except that it will just generate any needed
11929 static data, but will not affect the generated code in any other way.
11930 You will normally not enable this option; instead, a language processor
11931 that needs this handling would enable it on your behalf.
11933 @item -fasynchronous-unwind-tables
11934 @opindex fasynchronous-unwind-tables
11935 Generate unwind table in dwarf2 format, if supported by target machine.  The
11936 table is exact at each instruction boundary, so it can be used for stack
11937 unwinding from asynchronous events (such as debugger or garbage collector).
11939 @item -fpcc-struct-return
11940 @opindex fpcc-struct-return
11941 Return ``short'' @code{struct} and @code{union} values in memory like
11942 longer ones, rather than in registers.  This convention is less
11943 efficient, but it has the advantage of allowing intercallability between
11944 GCC-compiled files and files compiled with other compilers, particularly
11945 the Portable C Compiler (pcc).
11947 The precise convention for returning structures in memory depends
11948 on the target configuration macros.
11950 Short structures and unions are those whose size and alignment match
11951 that of some integer type.
11953 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11954 switch is not binary compatible with code compiled with the
11955 @option{-freg-struct-return} switch.
11956 Use it to conform to a non-default application binary interface.
11958 @item -freg-struct-return
11959 @opindex freg-struct-return
11960 Return @code{struct} and @code{union} values in registers when possible.
11961 This is more efficient for small structures than
11962 @option{-fpcc-struct-return}.
11964 If you specify neither @option{-fpcc-struct-return} nor
11965 @option{-freg-struct-return}, GCC defaults to whichever convention is
11966 standard for the target.  If there is no standard convention, GCC
11967 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11968 the principal compiler.  In those cases, we can choose the standard, and
11969 we chose the more efficient register return alternative.
11971 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11972 switch is not binary compatible with code compiled with the
11973 @option{-fpcc-struct-return} switch.
11974 Use it to conform to a non-default application binary interface.
11976 @item -fshort-enums
11977 @opindex fshort-enums
11978 Allocate to an @code{enum} type only as many bytes as it needs for the
11979 declared range of possible values.  Specifically, the @code{enum} type
11980 will be equivalent to the smallest integer type which has enough room.
11982 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11983 code that is not binary compatible with code generated without that switch.
11984 Use it to conform to a non-default application binary interface.
11986 @item -fshort-double
11987 @opindex fshort-double
11988 Use the same size for @code{double} as for @code{float}.
11990 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11991 code that is not binary compatible with code generated without that switch.
11992 Use it to conform to a non-default application binary interface.
11994 @item -fshort-wchar
11995 @opindex fshort-wchar
11996 Override the underlying type for @samp{wchar_t} to be @samp{short
11997 unsigned int} instead of the default for the target.  This option is
11998 useful for building programs to run under WINE@.
12000 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12001 code that is not binary compatible with code generated without that switch.
12002 Use it to conform to a non-default application binary interface.
12004 @item -fshared-data
12005 @opindex fshared-data
12006 Requests that the data and non-@code{const} variables of this
12007 compilation be shared data rather than private data.  The distinction
12008 makes sense only on certain operating systems, where shared data is
12009 shared between processes running the same program, while private data
12010 exists in one copy per process.
12012 @item -fno-common
12013 @opindex fno-common
12014 In C, allocate even uninitialized global variables in the data section of the
12015 object file, rather than generating them as common blocks.  This has the
12016 effect that if the same variable is declared (without @code{extern}) in
12017 two different compilations, you will get an error when you link them.
12018 The only reason this might be useful is if you wish to verify that the
12019 program will work on other systems which always work this way.
12021 @item -fno-ident
12022 @opindex fno-ident
12023 Ignore the @samp{#ident} directive.
12025 @item -finhibit-size-directive
12026 @opindex finhibit-size-directive
12027 Don't output a @code{.size} assembler directive, or anything else that
12028 would cause trouble if the function is split in the middle, and the
12029 two halves are placed at locations far apart in memory.  This option is
12030 used when compiling @file{crtstuff.c}; you should not need to use it
12031 for anything else.
12033 @item -fverbose-asm
12034 @opindex fverbose-asm
12035 Put extra commentary information in the generated assembly code to
12036 make it more readable.  This option is generally only of use to those
12037 who actually need to read the generated assembly code (perhaps while
12038 debugging the compiler itself).
12040 @option{-fno-verbose-asm}, the default, causes the
12041 extra information to be omitted and is useful when comparing two assembler
12042 files.
12044 @item -fpic
12045 @opindex fpic
12046 @cindex global offset table
12047 @cindex PIC
12048 Generate position-independent code (PIC) suitable for use in a shared
12049 library, if supported for the target machine.  Such code accesses all
12050 constant addresses through a global offset table (GOT)@.  The dynamic
12051 loader resolves the GOT entries when the program starts (the dynamic
12052 loader is not part of GCC; it is part of the operating system).  If
12053 the GOT size for the linked executable exceeds a machine-specific
12054 maximum size, you get an error message from the linker indicating that
12055 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12056 instead.  (These maximums are 8k on the SPARC and 32k
12057 on the m68k and RS/6000.  The 386 has no such limit.)
12059 Position-independent code requires special support, and therefore works
12060 only on certain machines.  For the 386, GCC supports PIC for System V
12061 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12062 position-independent.
12064 @item -fPIC
12065 @opindex fPIC
12066 If supported for the target machine, emit position-independent code,
12067 suitable for dynamic linking and avoiding any limit on the size of the
12068 global offset table.  This option makes a difference on the m68k,
12069 PowerPC and SPARC@.
12071 Position-independent code requires special support, and therefore works
12072 only on certain machines.
12074 @item -fpie
12075 @itemx -fPIE
12076 @opindex fpie
12077 @opindex fPIE
12078 These options are similar to @option{-fpic} and @option{-fPIC}, but
12079 generated position independent code can be only linked into executables.
12080 Usually these options are used when @option{-pie} GCC option will be
12081 used during linking.
12083 @item -ffixed-@var{reg}
12084 @opindex ffixed
12085 Treat the register named @var{reg} as a fixed register; generated code
12086 should never refer to it (except perhaps as a stack pointer, frame
12087 pointer or in some other fixed role).
12089 @var{reg} must be the name of a register.  The register names accepted
12090 are machine-specific and are defined in the @code{REGISTER_NAMES}
12091 macro in the machine description macro file.
12093 This flag does not have a negative form, because it specifies a
12094 three-way choice.
12096 @item -fcall-used-@var{reg}
12097 @opindex fcall-used
12098 Treat the register named @var{reg} as an allocable register that is
12099 clobbered by function calls.  It may be allocated for temporaries or
12100 variables that do not live across a call.  Functions compiled this way
12101 will not save and restore the register @var{reg}.
12103 It is an error to used this flag with the frame pointer or stack pointer.
12104 Use of this flag for other registers that have fixed pervasive roles in
12105 the machine's execution model will produce disastrous results.
12107 This flag does not have a negative form, because it specifies a
12108 three-way choice.
12110 @item -fcall-saved-@var{reg}
12111 @opindex fcall-saved
12112 Treat the register named @var{reg} as an allocable register saved by
12113 functions.  It may be allocated even for temporaries or variables that
12114 live across a call.  Functions compiled this way will save and restore
12115 the register @var{reg} if they use it.
12117 It is an error to used this flag with the frame pointer or stack pointer.
12118 Use of this flag for other registers that have fixed pervasive roles in
12119 the machine's execution model will produce disastrous results.
12121 A different sort of disaster will result from the use of this flag for
12122 a register in which function values may be returned.
12124 This flag does not have a negative form, because it specifies a
12125 three-way choice.
12127 @item -fpack-struct[=@var{n}]
12128 @opindex fpack-struct
12129 Without a value specified, pack all structure members together without
12130 holes.  When a value is specified (which must be a small power of two), pack
12131 structure members according to this value, representing the maximum
12132 alignment (that is, objects with default alignment requirements larger than
12133 this will be output potentially unaligned at the next fitting location.
12135 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12136 code that is not binary compatible with code generated without that switch.
12137 Additionally, it makes the code suboptimal.
12138 Use it to conform to a non-default application binary interface.
12140 @item -finstrument-functions
12141 @opindex finstrument-functions
12142 Generate instrumentation calls for entry and exit to functions.  Just
12143 after function entry and just before function exit, the following
12144 profiling functions will be called with the address of the current
12145 function and its call site.  (On some platforms,
12146 @code{__builtin_return_address} does not work beyond the current
12147 function, so the call site information may not be available to the
12148 profiling functions otherwise.)
12150 @smallexample
12151 void __cyg_profile_func_enter (void *this_fn,
12152                                void *call_site);
12153 void __cyg_profile_func_exit  (void *this_fn,
12154                                void *call_site);
12155 @end smallexample
12157 The first argument is the address of the start of the current function,
12158 which may be looked up exactly in the symbol table.
12160 This instrumentation is also done for functions expanded inline in other
12161 functions.  The profiling calls will indicate where, conceptually, the
12162 inline function is entered and exited.  This means that addressable
12163 versions of such functions must be available.  If all your uses of a
12164 function are expanded inline, this may mean an additional expansion of
12165 code size.  If you use @samp{extern inline} in your C code, an
12166 addressable version of such functions must be provided.  (This is
12167 normally the case anyways, but if you get lucky and the optimizer always
12168 expands the functions inline, you might have gotten away without
12169 providing static copies.)
12171 A function may be given the attribute @code{no_instrument_function}, in
12172 which case this instrumentation will not be done.  This can be used, for
12173 example, for the profiling functions listed above, high-priority
12174 interrupt routines, and any functions from which the profiling functions
12175 cannot safely be called (perhaps signal handlers, if the profiling
12176 routines generate output or allocate memory).
12178 @item -fstack-check
12179 @opindex fstack-check
12180 Generate code to verify that you do not go beyond the boundary of the
12181 stack.  You should specify this flag if you are running in an
12182 environment with multiple threads, but only rarely need to specify it in
12183 a single-threaded environment since stack overflow is automatically
12184 detected on nearly all systems if there is only one stack.
12186 Note that this switch does not actually cause checking to be done; the
12187 operating system must do that.  The switch causes generation of code
12188 to ensure that the operating system sees the stack being extended.
12190 @item -fstack-limit-register=@var{reg}
12191 @itemx -fstack-limit-symbol=@var{sym}
12192 @itemx -fno-stack-limit
12193 @opindex fstack-limit-register
12194 @opindex fstack-limit-symbol
12195 @opindex fno-stack-limit
12196 Generate code to ensure that the stack does not grow beyond a certain value,
12197 either the value of a register or the address of a symbol.  If the stack
12198 would grow beyond the value, a signal is raised.  For most targets,
12199 the signal is raised before the stack overruns the boundary, so
12200 it is possible to catch the signal without taking special precautions.
12202 For instance, if the stack starts at absolute address @samp{0x80000000}
12203 and grows downwards, you can use the flags
12204 @option{-fstack-limit-symbol=__stack_limit} and
12205 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12206 of 128KB@.  Note that this may only work with the GNU linker.
12208 @cindex aliasing of parameters
12209 @cindex parameters, aliased
12210 @item -fargument-alias
12211 @itemx -fargument-noalias
12212 @itemx -fargument-noalias-global
12213 @opindex fargument-alias
12214 @opindex fargument-noalias
12215 @opindex fargument-noalias-global
12216 Specify the possible relationships among parameters and between
12217 parameters and global data.
12219 @option{-fargument-alias} specifies that arguments (parameters) may
12220 alias each other and may alias global storage.@*
12221 @option{-fargument-noalias} specifies that arguments do not alias
12222 each other, but may alias global storage.@*
12223 @option{-fargument-noalias-global} specifies that arguments do not
12224 alias each other and do not alias global storage.
12226 Each language will automatically use whatever option is required by
12227 the language standard.  You should not need to use these options yourself.
12229 @item -fleading-underscore
12230 @opindex fleading-underscore
12231 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12232 change the way C symbols are represented in the object file.  One use
12233 is to help link with legacy assembly code.
12235 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12236 generate code that is not binary compatible with code generated without that
12237 switch.  Use it to conform to a non-default application binary interface.
12238 Not all targets provide complete support for this switch.
12240 @item -ftls-model=@var{model}
12241 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12242 The @var{model} argument should be one of @code{global-dynamic},
12243 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12245 The default without @option{-fpic} is @code{initial-exec}; with
12246 @option{-fpic} the default is @code{global-dynamic}.
12248 @item -fvisibility=@var{default|internal|hidden|protected}
12249 @opindex fvisibility
12250 Set the default ELF image symbol visibility to the specified option---all
12251 symbols will be marked with this unless overridden within the code.
12252 Using this feature can very substantially improve linking and
12253 load times of shared object libraries, produce more optimized
12254 code, provide near-perfect API export and prevent symbol clashes.
12255 It is @strong{strongly} recommended that you use this in any shared objects
12256 you distribute.
12258 Despite the nomenclature, @code{default} always means public ie;
12259 available to be linked against from outside the shared object.
12260 @code{protected} and @code{internal} are pretty useless in real-world
12261 usage so the only other commonly used option will be @code{hidden}.
12262 The default if @option{-fvisibility} isn't specified is
12263 @code{default}, i.e., make every
12264 symbol public---this causes the same behavior as previous versions of
12265 GCC@.
12267 A good explanation of the benefits offered by ensuring ELF
12268 symbols have the correct visibility is given by ``How To Write
12269 Shared Libraries'' by Ulrich Drepper (which can be found at
12270 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12271 solution made possible by this option to marking things hidden when
12272 the default is public is to make the default hidden and mark things
12273 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12274 and @code{__attribute__ ((visibility("default")))} instead of
12275 @code{__declspec(dllexport)} you get almost identical semantics with
12276 identical syntax.  This is a great boon to those working with
12277 cross-platform projects.
12279 For those adding visibility support to existing code, you may find
12280 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12281 the declarations you wish to set visibility for with (for example)
12282 @samp{#pragma GCC visibility push(hidden)} and
12283 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12284 times.  Bear in mind that symbol visibility should be viewed @strong{as
12285 part of the API interface contract} and thus all new code should
12286 always specify visibility when it is not the default ie; declarations
12287 only for use within the local DSO should @strong{always} be marked explicitly
12288 as hidden as so to avoid PLT indirection overheads---making this
12289 abundantly clear also aids readability and self-documentation of the code.
12290 Note that due to ISO C++ specification requirements, operator new and
12291 operator delete must always be of default visibility.
12293 An overview of these techniques, their benefits and how to use them
12294 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
12296 @end table
12298 @c man end
12300 @node Environment Variables
12301 @section Environment Variables Affecting GCC
12302 @cindex environment variables
12304 @c man begin ENVIRONMENT
12305 This section describes several environment variables that affect how GCC
12306 operates.  Some of them work by specifying directories or prefixes to use
12307 when searching for various kinds of files.  Some are used to specify other
12308 aspects of the compilation environment.
12310 Note that you can also specify places to search using options such as
12311 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12312 take precedence over places specified using environment variables, which
12313 in turn take precedence over those specified by the configuration of GCC@.
12314 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12315 GNU Compiler Collection (GCC) Internals}.
12317 @table @env
12318 @item LANG
12319 @itemx LC_CTYPE
12320 @c @itemx LC_COLLATE
12321 @itemx LC_MESSAGES
12322 @c @itemx LC_MONETARY
12323 @c @itemx LC_NUMERIC
12324 @c @itemx LC_TIME
12325 @itemx LC_ALL
12326 @findex LANG
12327 @findex LC_CTYPE
12328 @c @findex LC_COLLATE
12329 @findex LC_MESSAGES
12330 @c @findex LC_MONETARY
12331 @c @findex LC_NUMERIC
12332 @c @findex LC_TIME
12333 @findex LC_ALL
12334 @cindex locale
12335 These environment variables control the way that GCC uses
12336 localization information that allow GCC to work with different
12337 national conventions.  GCC inspects the locale categories
12338 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12339 so.  These locale categories can be set to any value supported by your
12340 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12341 Kingdom encoded in UTF-8.
12343 The @env{LC_CTYPE} environment variable specifies character
12344 classification.  GCC uses it to determine the character boundaries in
12345 a string; this is needed for some multibyte encodings that contain quote
12346 and escape characters that would otherwise be interpreted as a string
12347 end or escape.
12349 The @env{LC_MESSAGES} environment variable specifies the language to
12350 use in diagnostic messages.
12352 If the @env{LC_ALL} environment variable is set, it overrides the value
12353 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12354 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12355 environment variable.  If none of these variables are set, GCC
12356 defaults to traditional C English behavior.
12358 @item TMPDIR
12359 @findex TMPDIR
12360 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12361 files.  GCC uses temporary files to hold the output of one stage of
12362 compilation which is to be used as input to the next stage: for example,
12363 the output of the preprocessor, which is the input to the compiler
12364 proper.
12366 @item GCC_EXEC_PREFIX
12367 @findex GCC_EXEC_PREFIX
12368 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12369 names of the subprograms executed by the compiler.  No slash is added
12370 when this prefix is combined with the name of a subprogram, but you can
12371 specify a prefix that ends with a slash if you wish.
12373 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12374 an appropriate prefix to use based on the pathname it was invoked with.
12376 If GCC cannot find the subprogram using the specified prefix, it
12377 tries looking in the usual places for the subprogram.
12379 The default value of @env{GCC_EXEC_PREFIX} is
12380 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12381 of @code{prefix} when you ran the @file{configure} script.
12383 Other prefixes specified with @option{-B} take precedence over this prefix.
12385 This prefix is also used for finding files such as @file{crt0.o} that are
12386 used for linking.
12388 In addition, the prefix is used in an unusual way in finding the
12389 directories to search for header files.  For each of the standard
12390 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12391 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12392 replacing that beginning with the specified prefix to produce an
12393 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12394 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12395 These alternate directories are searched first; the standard directories
12396 come next.
12398 @item COMPILER_PATH
12399 @findex COMPILER_PATH
12400 The value of @env{COMPILER_PATH} is a colon-separated list of
12401 directories, much like @env{PATH}.  GCC tries the directories thus
12402 specified when searching for subprograms, if it can't find the
12403 subprograms using @env{GCC_EXEC_PREFIX}.
12405 @item LIBRARY_PATH
12406 @findex LIBRARY_PATH
12407 The value of @env{LIBRARY_PATH} is a colon-separated list of
12408 directories, much like @env{PATH}.  When configured as a native compiler,
12409 GCC tries the directories thus specified when searching for special
12410 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12411 using GCC also uses these directories when searching for ordinary
12412 libraries for the @option{-l} option (but directories specified with
12413 @option{-L} come first).
12415 @item LANG
12416 @findex LANG
12417 @cindex locale definition
12418 This variable is used to pass locale information to the compiler.  One way in
12419 which this information is used is to determine the character set to be used
12420 when character literals, string literals and comments are parsed in C and C++.
12421 When the compiler is configured to allow multibyte characters,
12422 the following values for @env{LANG} are recognized:
12424 @table @samp
12425 @item C-JIS
12426 Recognize JIS characters.
12427 @item C-SJIS
12428 Recognize SJIS characters.
12429 @item C-EUCJP
12430 Recognize EUCJP characters.
12431 @end table
12433 If @env{LANG} is not defined, or if it has some other value, then the
12434 compiler will use mblen and mbtowc as defined by the default locale to
12435 recognize and translate multibyte characters.
12436 @end table
12438 @noindent
12439 Some additional environments variables affect the behavior of the
12440 preprocessor.
12442 @include cppenv.texi
12444 @c man end
12446 @node Precompiled Headers
12447 @section Using Precompiled Headers
12448 @cindex precompiled headers
12449 @cindex speed of compilation
12451 Often large projects have many header files that are included in every
12452 source file.  The time the compiler takes to process these header files
12453 over and over again can account for nearly all of the time required to
12454 build the project.  To make builds faster, GCC allows users to
12455 `precompile' a header file; then, if builds can use the precompiled
12456 header file they will be much faster.
12458 @strong{Caution:} There are a few known situations where GCC will
12459 crash when trying to use a precompiled header.  If you have trouble
12460 with a precompiled header, you should remove the precompiled header
12461 and compile without it.  In addition, please use GCC's on-line
12462 defect-tracking system to report any problems you encounter with
12463 precompiled headers.  @xref{Bugs}.
12465 To create a precompiled header file, simply compile it as you would any
12466 other file, if necessary using the @option{-x} option to make the driver
12467 treat it as a C or C++ header file.  You will probably want to use a
12468 tool like @command{make} to keep the precompiled header up-to-date when
12469 the headers it contains change.
12471 A precompiled header file will be searched for when @code{#include} is
12472 seen in the compilation.  As it searches for the included file
12473 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12474 compiler looks for a precompiled header in each directory just before it
12475 looks for the include file in that directory.  The name searched for is
12476 the name specified in the @code{#include} with @samp{.gch} appended.  If
12477 the precompiled header file can't be used, it is ignored.
12479 For instance, if you have @code{#include "all.h"}, and you have
12480 @file{all.h.gch} in the same directory as @file{all.h}, then the
12481 precompiled header file will be used if possible, and the original
12482 header will be used otherwise.
12484 Alternatively, you might decide to put the precompiled header file in a
12485 directory and use @option{-I} to ensure that directory is searched
12486 before (or instead of) the directory containing the original header.
12487 Then, if you want to check that the precompiled header file is always
12488 used, you can put a file of the same name as the original header in this
12489 directory containing an @code{#error} command.
12491 This also works with @option{-include}.  So yet another way to use
12492 precompiled headers, good for projects not designed with precompiled
12493 header files in mind, is to simply take most of the header files used by
12494 a project, include them from another header file, precompile that header
12495 file, and @option{-include} the precompiled header.  If the header files
12496 have guards against multiple inclusion, they will be skipped because
12497 they've already been included (in the precompiled header).
12499 If you need to precompile the same header file for different
12500 languages, targets, or compiler options, you can instead make a
12501 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12502 header in the directory, perhaps using @option{-o}.  It doesn't matter
12503 what you call the files in the directory, every precompiled header in
12504 the directory will be considered.  The first precompiled header
12505 encountered in the directory that is valid for this compilation will
12506 be used; they're searched in no particular order.
12508 There are many other possibilities, limited only by your imagination,
12509 good sense, and the constraints of your build system.
12511 A precompiled header file can be used only when these conditions apply:
12513 @itemize
12514 @item
12515 Only one precompiled header can be used in a particular compilation.
12517 @item
12518 A precompiled header can't be used once the first C token is seen.  You
12519 can have preprocessor directives before a precompiled header; you can
12520 even include a precompiled header from inside another header, so long as
12521 there are no C tokens before the @code{#include}.
12523 @item
12524 The precompiled header file must be produced for the same language as
12525 the current compilation.  You can't use a C precompiled header for a C++
12526 compilation.
12528 @item
12529 The precompiled header file must be produced by the same compiler
12530 version and configuration as the current compilation is using.
12531 The easiest way to guarantee this is to use the same compiler binary
12532 for creating and using precompiled headers.
12534 @item
12535 Any macros defined before the precompiled header is included must
12536 either be defined in the same way as when the precompiled header was
12537 generated, or must not affect the precompiled header, which usually
12538 means that the they don't appear in the precompiled header at all.
12540 The @option{-D} option is one way to define a macro before a
12541 precompiled header is included; using a @code{#define} can also do it.
12542 There are also some options that define macros implicitly, like
12543 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12544 defined this way.
12546 @item If debugging information is output when using the precompiled
12547 header, using @option{-g} or similar, the same kind of debugging information
12548 must have been output when building the precompiled header.  However,
12549 a precompiled header built using @option{-g} can be used in a compilation
12550 when no debugging information is being output.
12552 @item The same @option{-m} options must generally be used when building
12553 and using the precompiled header.  @xref{Submodel Options},
12554 for any cases where this rule is relaxed.
12556 @item Each of the following options must be the same when building and using
12557 the precompiled header:
12559 @gccoptlist{-fexceptions -funit-at-a-time}
12561 @item
12562 Some other command-line options starting with @option{-f},
12563 @option{-p}, or @option{-O} must be defined in the same way as when
12564 the precompiled header was generated.  At present, it's not clear
12565 which options are safe to change and which are not; the safest choice
12566 is to use exactly the same options when generating and using the
12567 precompiled header.  The following are known to be safe:
12569 @gccoptlist{-fpreprocessed -pedantic-errors}
12571 @end itemize
12573 For all of these except the last, the compiler will automatically
12574 ignore the precompiled header if the conditions aren't met.  If you
12575 find an option combination that doesn't work and doesn't cause the
12576 precompiled header to be ignored, please consider filing a bug report,
12577 see @ref{Bugs}.
12579 If you do use differing options when generating and using the
12580 precompiled header, the actual behavior will be a mixture of the
12581 behavior for the options.  For instance, if you use @option{-g} to
12582 generate the precompiled header but not when using it, you may or may
12583 not get debugging information for routines in the precompiled header.
12585 @node Running Protoize
12586 @section Running Protoize
12588 The program @code{protoize} is an optional part of GCC@.  You can use
12589 it to add prototypes to a program, thus converting the program to ISO
12590 C in one respect.  The companion program @code{unprotoize} does the
12591 reverse: it removes argument types from any prototypes that are found.
12593 When you run these programs, you must specify a set of source files as
12594 command line arguments.  The conversion programs start out by compiling
12595 these files to see what functions they define.  The information gathered
12596 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12598 After scanning comes actual conversion.  The specified files are all
12599 eligible to be converted; any files they include (whether sources or
12600 just headers) are eligible as well.
12602 But not all the eligible files are converted.  By default,
12603 @code{protoize} and @code{unprotoize} convert only source and header
12604 files in the current directory.  You can specify additional directories
12605 whose files should be converted with the @option{-d @var{directory}}
12606 option.  You can also specify particular files to exclude with the
12607 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12608 directory name matches one of the specified directory names, and its
12609 name within the directory has not been excluded.
12611 Basic conversion with @code{protoize} consists of rewriting most
12612 function definitions and function declarations to specify the types of
12613 the arguments.  The only ones not rewritten are those for varargs
12614 functions.
12616 @code{protoize} optionally inserts prototype declarations at the
12617 beginning of the source file, to make them available for any calls that
12618 precede the function's definition.  Or it can insert prototype
12619 declarations with block scope in the blocks where undeclared functions
12620 are called.
12622 Basic conversion with @code{unprotoize} consists of rewriting most
12623 function declarations to remove any argument types, and rewriting
12624 function definitions to the old-style pre-ISO form.
12626 Both conversion programs print a warning for any function declaration or
12627 definition that they can't convert.  You can suppress these warnings
12628 with @option{-q}.
12630 The output from @code{protoize} or @code{unprotoize} replaces the
12631 original source file.  The original file is renamed to a name ending
12632 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12633 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12634 for DOS) file already exists, then the source file is simply discarded.
12636 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12637 scan the program and collect information about the functions it uses.
12638 So neither of these programs will work until GCC is installed.
12640 Here is a table of the options you can use with @code{protoize} and
12641 @code{unprotoize}.  Each option works with both programs unless
12642 otherwise stated.
12644 @table @code
12645 @item -B @var{directory}
12646 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12647 usual directory (normally @file{/usr/local/lib}).  This file contains
12648 prototype information about standard system functions.  This option
12649 applies only to @code{protoize}.
12651 @item -c @var{compilation-options}
12652 Use @var{compilation-options} as the options when running @command{gcc} to
12653 produce the @samp{.X} files.  The special option @option{-aux-info} is
12654 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12656 Note that the compilation options must be given as a single argument to
12657 @code{protoize} or @code{unprotoize}.  If you want to specify several
12658 @command{gcc} options, you must quote the entire set of compilation options
12659 to make them a single word in the shell.
12661 There are certain @command{gcc} arguments that you cannot use, because they
12662 would produce the wrong kind of output.  These include @option{-g},
12663 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12664 the @var{compilation-options}, they are ignored.
12666 @item -C
12667 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12668 systems) instead of @samp{.c}.  This is convenient if you are converting
12669 a C program to C++.  This option applies only to @code{protoize}.
12671 @item -g
12672 Add explicit global declarations.  This means inserting explicit
12673 declarations at the beginning of each source file for each function
12674 that is called in the file and was not declared.  These declarations
12675 precede the first function definition that contains a call to an
12676 undeclared function.  This option applies only to @code{protoize}.
12678 @item -i @var{string}
12679 Indent old-style parameter declarations with the string @var{string}.
12680 This option applies only to @code{protoize}.
12682 @code{unprotoize} converts prototyped function definitions to old-style
12683 function definitions, where the arguments are declared between the
12684 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12685 uses five spaces as the indentation.  If you want to indent with just
12686 one space instead, use @option{-i " "}.
12688 @item -k
12689 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12690 is finished.
12692 @item -l
12693 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12694 a prototype declaration for each function in each block which calls the
12695 function without any declaration.  This option applies only to
12696 @code{protoize}.
12698 @item -n
12699 Make no real changes.  This mode just prints information about the conversions
12700 that would have been done without @option{-n}.
12702 @item -N
12703 Make no @samp{.save} files.  The original files are simply deleted.
12704 Use this option with caution.
12706 @item -p @var{program}
12707 Use the program @var{program} as the compiler.  Normally, the name
12708 @file{gcc} is used.
12710 @item -q
12711 Work quietly.  Most warnings are suppressed.
12713 @item -v
12714 Print the version number, just like @option{-v} for @command{gcc}.
12715 @end table
12717 If you need special compiler options to compile one of your program's
12718 source files, then you should generate that file's @samp{.X} file
12719 specially, by running @command{gcc} on that source file with the
12720 appropriate options and the option @option{-aux-info}.  Then run
12721 @code{protoize} on the entire set of files.  @code{protoize} will use
12722 the existing @samp{.X} file because it is newer than the source file.
12723 For example:
12725 @smallexample
12726 gcc -Dfoo=bar file1.c -aux-info file1.X
12727 protoize *.c
12728 @end smallexample
12730 @noindent
12731 You need to include the special files along with the rest in the
12732 @code{protoize} command, even though their @samp{.X} files already
12733 exist, because otherwise they won't get converted.
12735 @xref{Protoize Caveats}, for more information on how to use
12736 @code{protoize} successfully.