* arm.h (REVERSE_CONDITION): Define.
[official-gcc.git] / gcc / doc / invoke.texi
blob33b67b7802115a3e836d23425e498d46d8f79fbb
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.  Use of the @command{gccbug}
53 script to report bugs is recommended.
54 @c man end
55 @c man begin AUTHOR
56 See the Info entry for @command{gcc}, or
57 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
58 for contributors to GCC@.
59 @c man end
60 @end ignore
62 @node Invoking GCC
63 @chapter GCC Command Options
64 @cindex GCC command options
65 @cindex command options
66 @cindex options, GCC command
68 @c man begin DESCRIPTION
69 When you invoke GCC, it normally does preprocessing, compilation,
70 assembly and linking.  The ``overall options'' allow you to stop this
71 process at an intermediate stage.  For example, the @option{-c} option
72 says not to run the linker.  Then the output consists of object files
73 output by the assembler.
75 Other options are passed on to one stage of processing.  Some options
76 control the preprocessor and others the compiler itself.  Yet other
77 options control the assembler and linker; most of these are not
78 documented here, since you rarely need to use any of them.
80 @cindex C compilation options
81 Most of the command line options that you can use with GCC are useful
82 for C programs; when an option is only useful with another language
83 (usually C++), the explanation says so explicitly.  If the description
84 for a particular option does not mention a source language, you can use
85 that option with all supported languages.
87 @cindex C++ compilation options
88 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
89 options for compiling C++ programs.
91 @cindex grouping options
92 @cindex options, grouping
93 The @command{gcc} program accepts options and file names as operands.  Many
94 options have multi-letter names; therefore multiple single-letter options
95 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
96 -r}}.
98 @cindex order of options
99 @cindex options, order
100 You can mix options and other arguments.  For the most part, the order
101 you use doesn't matter.  Order does matter when you use several options
102 of the same kind; for example, if you specify @option{-L} more than once,
103 the directories are searched in the order specified.
105 Many options have long names starting with @samp{-f} or with
106 @samp{-W}---for example, @option{-fforce-mem},
107 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
108 these have both positive and negative forms; the negative form of
109 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
110 only one of these two forms, whichever one is not the default.
112 @c man end
114 @xref{Option Index}, for an index to GCC's options.
116 @menu
117 * Option Summary::      Brief list of all options, without explanations.
118 * Overall Options::     Controlling the kind of output:
119                         an executable, object files, assembler files,
120                         or preprocessed source.
121 * Invoking G++::        Compiling C++ programs.
122 * C Dialect Options::   Controlling the variant of C language compiled.
123 * C++ Dialect Options:: Variations on C++.
124 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
125                         and Objective-C++.
126 * Language Independent Options:: Controlling how diagnostics should be
127                         formatted.
128 * Warning Options::     How picky should the compiler be?
129 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
130 * Optimize Options::    How much optimization?
131 * Preprocessor Options:: Controlling header files and macro definitions.
132                          Also, getting dependency information for Make.
133 * Assembler Options::   Passing options to the assembler.
134 * Link Options::        Specifying libraries and so on.
135 * Directory Options::   Where to find header files and libraries.
136                         Where to find the compiler executable files.
137 * Spec Files::          How to pass switches to sub-processes.
138 * Target Options::      Running a cross-compiler, or an old version of GCC.
139 * Submodel Options::    Specifying minor hardware or convention variations,
140                         such as 68010 vs 68020.
141 * Code Gen Options::    Specifying conventions for function calls, data layout
142                         and register usage.
143 * Environment Variables:: Env vars that affect GCC.
144 * Precompiled Headers:: Compiling a header once, and using it many times.
145 * Running Protoize::    Automatically adding or removing function prototypes.
146 @end menu
148 @c man begin OPTIONS
150 @node Option Summary
151 @section Option Summary
153 Here is a summary of all the options, grouped by type.  Explanations are
154 in the following sections.
156 @table @emph
157 @item Overall Options
158 @xref{Overall Options,,Options Controlling the Kind of Output}.
159 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
160 -x @var{language}  -v  -###  --help  --target-help  --version}
162 @item C Language Options
163 @xref{C Dialect Options,,Options Controlling C Dialect}.
164 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
165 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
166 -fhosted  -ffreestanding  -fms-extensions @gol
167 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
168 -fallow-single-precision  -fcond-mismatch @gol
169 -fsigned-bitfields  -fsigned-char @gol
170 -funsigned-bitfields  -funsigned-char}
172 @item C++ Language Options
173 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
174 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
175 -fconserve-space  -fno-const-strings @gol
176 -fno-elide-constructors @gol
177 -fno-enforce-eh-specs @gol
178 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
179 -fno-implicit-templates @gol
180 -fno-implicit-inline-templates @gol
181 -fno-implement-inlines  -fms-extensions @gol
182 -fno-nonansi-builtins  -fno-operator-names @gol
183 -fno-optional-diags  -fpermissive @gol
184 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
185 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
186 -fno-default-inline  -fvisibility-inlines-hidden @gol
187 -Wabi  -Wctor-dtor-privacy @gol
188 -Wnon-virtual-dtor  -Wreorder @gol
189 -Weffc++  -Wno-deprecated @gol
190 -Wno-non-template-friend  -Wold-style-cast @gol
191 -Woverloaded-virtual  -Wno-pmf-conversions @gol
192 -Wsign-promo  -Wsynth}
194 @item Objective-C and Objective-C++ Language Options
195 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
196 Objective-C and Objective-C++ Dialects}.
197 @gccoptlist{
198 -fconstant-string-class=@var{class-name} @gol
199 -fgnu-runtime  -fnext-runtime @gol
200 -fno-nil-receivers @gol
201 -fobjc-exceptions @gol
202 -freplace-objc-classes @gol
203 -fzero-link @gol
204 -gen-decls @gol
205 -Wno-protocol  -Wselector -Wundeclared-selector}
207 @item Language Independent Options
208 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
209 @gccoptlist{-fmessage-length=@var{n}  @gol
210 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
212 @item Warning Options
213 @xref{Warning Options,,Options to Request or Suppress Warnings}.
214 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
215 -w  -Wextra  -Wall  -Waggregate-return @gol
216 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
217 -Wconversion  -Wno-deprecated-declarations @gol
218 -Wdisabled-optimization  -Wno-div-by-zero  -Wendif-labels @gol
219 -Werror  -Werror-implicit-function-declaration @gol
220 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
221 -Wno-format-extra-args -Wformat-nonliteral @gol
222 -Wformat-security  -Wformat-y2k @gol
223 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
224 -Wimport  -Wno-import  -Winit-self  -Winline @gol
225 -Wno-invalid-offsetof  -Winvalid-pch @gol
226 -Wlarger-than-@var{len}  -Wlong-long @gol
227 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
231 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
232 -Wreturn-type  -Wsequence-point  -Wshadow @gol
233 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
234 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
235 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
236 -Wunknown-pragmas  -Wunreachable-code @gol
237 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
238 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
239 -Wvariadic-macros}
241 @item C-only Warning Options
242 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
243 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
244 -Wstrict-prototypes  -Wtraditional @gol
245 -Wdeclaration-after-statement}
247 @item Debugging Options
248 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
249 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
250 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
251 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
252 -fdump-tree-all @gol
253 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
254 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
255 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
257 -fdump-tree-ch @gol
258 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
259 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
260 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-nrv -fdump-tree-vect @gol
267 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
269 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
270 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
271 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
272 -ftest-coverage  -ftime-report -fvar-tracking @gol
273 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
274 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
275 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
276 -print-multi-directory  -print-multi-lib @gol
277 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
278 -save-temps  -time}
280 @item Optimization Options
281 @xref{Optimize Options,,Options that Control Optimization}.
282 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
283 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
284 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
285 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
286 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
287 -fcaller-saves  -fcprop-registers @gol
288 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
289 -fdelayed-branch  -fdelete-null-pointer-checks @gol
290 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
291 -fforce-addr  -fforce-mem  -ffunction-sections @gol
292 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
293 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
294 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
295 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
296 -fmodulo-sched -fmove-all-movables  -fnew-ra  -fno-branch-count-reg @gol
297 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
298 -fno-function-cse  -fno-guess-branch-probability @gol
299 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
300 -funsafe-math-optimizations  -ffinite-math-only @gol
301 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
302 -fomit-frame-pointer  -foptimize-register-move @gol
303 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
304 -fprofile-generate -fprofile-use @gol
305 -freduce-all-givs  -fregmove  -frename-registers @gol
306 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
307 -frerun-cse-after-loop  -frerun-loop-opt @gol
308 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
309 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
310 -fsched-spec-load-dangerous  @gol
311 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
312 -fsched2-use-superblocks @gol
313 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
314 -fsignaling-nans -fsingle-precision-constant  @gol
315 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
316 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
317 -funswitch-loops  -fold-unroll-loops  -fold-unroll-all-loops @gol
318 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
319 -ftree-lim -fivcanon @gol
320 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
321 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
322 --param @var{name}=@var{value}
323 -O  -O0  -O1  -O2  -O3  -Os}
325 @item Preprocessor Options
326 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
327 @gccoptlist{-A@var{question}=@var{answer} @gol
328 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
329 -C  -dD  -dI  -dM  -dN @gol
330 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
331 -idirafter @var{dir} @gol
332 -include @var{file}  -imacros @var{file} @gol
333 -iprefix @var{file}  -iwithprefix @var{dir} @gol
334 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
335 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
336 -P  -fworking-directory  -remap @gol
337 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
338 -Xpreprocessor @var{option}}
340 @item Assembler Option
341 @xref{Assembler Options,,Passing Options to the Assembler}.
342 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
344 @item Linker Options
345 @xref{Link Options,,Options for Linking}.
346 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
347 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
348 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
349 -Wl,@var{option}  -Xlinker @var{option} @gol
350 -u @var{symbol}}
352 @item Directory Options
353 @xref{Directory Options,,Options for Directory Search}.
354 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
356 @item Target Options
357 @c I wrote this xref this way to avoid overfull hbox. -- rms
358 @xref{Target Options}.
359 @gccoptlist{-V @var{version}  -b @var{machine}}
361 @item Machine Dependent Options
362 @xref{Submodel Options,,Hardware Models and Configurations}.
363 @c This list is ordered alphanumerically by subsection name.
364 @c Try and put the significant identifier (CPU or system) first,
365 @c so users have a clue at guessing where the ones they want will be.
367 @emph{ARC Options}
368 @gccoptlist{-EB  -EL @gol
369 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
370 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
372 @emph{ARM Options}
373 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
374 -mabi=@var{name} @gol
375 -mapcs-stack-check  -mno-apcs-stack-check @gol
376 -mapcs-float  -mno-apcs-float @gol
377 -mapcs-reentrant  -mno-apcs-reentrant @gol
378 -msched-prolog  -mno-sched-prolog @gol
379 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
380 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
381 -mthumb-interwork  -mno-thumb-interwork @gol
382 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
383 -mstructure-size-boundary=@var{n} @gol
384 -mabort-on-noreturn @gol
385 -mlong-calls  -mno-long-calls @gol
386 -msingle-pic-base  -mno-single-pic-base @gol
387 -mpic-register=@var{reg} @gol
388 -mnop-fun-dllimport @gol
389 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
390 -mpoke-function-name @gol
391 -mthumb  -marm @gol
392 -mtpcs-frame  -mtpcs-leaf-frame @gol
393 -mcaller-super-interworking  -mcallee-super-interworking}
395 @emph{AVR Options}
396 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
397 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
399 @emph{CRIS Options}
400 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
401 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
402 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
403 -mstack-align  -mdata-align  -mconst-align @gol
404 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
405 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
406 -mmul-bug-workaround  -mno-mul-bug-workaround}
408 @emph{Darwin Options}
409 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
410 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
411 -client_name  -compatibility_version  -current_version @gol
412 -dead_strip @gol
413 -dependency-file  -dylib_file  -dylinker_install_name @gol
414 -dynamic  -dynamiclib  -exported_symbols_list @gol
415 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
416 -force_flat_namespace  -headerpad_max_install_names @gol
417 -image_base  -init  -install_name  -keep_private_externs @gol
418 -multi_module  -multiply_defined  -multiply_defined_unused @gol
419 -noall_load   -no_dead_strip_inits_and_terms @gol
420 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
421 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
422 -private_bundle  -read_only_relocs  -sectalign @gol
423 -sectobjectsymbols  -whyload  -seg1addr @gol
424 -sectcreate  -sectobjectsymbols  -sectorder @gol
425 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
426 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
427 -single_module  -static  -sub_library  -sub_umbrella @gol
428 -twolevel_namespace  -umbrella  -undefined @gol
429 -unexported_symbols_list  -weak_reference_mismatches @gol
430 -whatsloaded -F -gused -gfull -mone-byte-bool}
432 @emph{DEC Alpha Options}
433 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
434 -mieee  -mieee-with-inexact  -mieee-conformant @gol
435 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
436 -mtrap-precision=@var{mode}  -mbuild-constants @gol
437 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
438 -mbwx  -mmax  -mfix  -mcix @gol
439 -mfloat-vax  -mfloat-ieee @gol
440 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
441 -msmall-text  -mlarge-text @gol
442 -mmemory-latency=@var{time}}
444 @emph{DEC Alpha/VMS Options}
445 @gccoptlist{-mvms-return-codes}
447 @emph{FRV Options}
448 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
449 -mhard-float  -msoft-float @gol
450 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
451 -mdouble  -mno-double @gol
452 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
453 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic -mlinked-fp @gol
454 -mlibrary-pic  -macc-4 -macc-8 @gol
455 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
456 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
457 -mvliw-branch  -mno-vliw-branch @gol
458 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
459 -mno-nested-cond-exec  -mtomcat-stats @gol
460 -mcpu=@var{cpu}}
462 @emph{H8/300 Options}
463 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
465 @emph{HPPA Options}
466 @gccoptlist{-march=@var{architecture-type} @gol
467 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
468 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
469 -mfixed-range=@var{register-range} @gol
470 -mjump-in-delay -mlinker-opt -mlong-calls @gol
471 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
472 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
473 -mno-jump-in-delay  -mno-long-load-store @gol
474 -mno-portable-runtime  -mno-soft-float @gol
475 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
476 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
477 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
478 -munix=@var{unix-std}  -nolibdld  -static  -threads}
480 @emph{i386 and x86-64 Options}
481 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
482 -mfpmath=@var{unit} @gol
483 -masm=@var{dialect}  -mno-fancy-math-387 @gol
484 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
485 -mno-wide-multiply  -mrtd  -malign-double @gol
486 -mpreferred-stack-boundary=@var{num} @gol
487 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
488 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
489 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
490 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
491 -mno-red-zone -mno-tls-direct-seg-refs @gol
492 -mcmodel=@var{code-model} @gol
493 -m32  -m64}
495 @emph{IA-64 Options}
496 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
497 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
498 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
499 -minline-float-divide-max-throughput @gol
500 -minline-int-divide-min-latency @gol
501 -minline-int-divide-max-throughput  -mno-dwarf2-asm @gol
502 -mfixed-range=@var{register-range}}
504 @emph{M32R/D Options}
505 @gccoptlist{-m32r2 -m32rx -m32r @gol
506 -mdebug @gol
507 -malign-loops -mno-align-loops @gol
508 -missue-rate=@var{number} @gol
509 -mbranch-cost=@var{number} @gol
510 -mmodel=@var{code-size-model-type} @gol
511 -msdata=@var{sdata-type} @gol
512 -mno-flush-func -mflush-func=@var{name} @gol
513 -mno-flush-trap -mflush-trap=@var{number} @gol
514 -G @var{num}}
516 @emph{M680x0 Options}
517 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
518 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
519 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
520 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
521 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
523 @emph{M68hc1x Options}
524 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
525 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
526 -msoft-reg-count=@var{count}}
528 @emph{MCore Options}
529 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
530 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
531 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
532 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
533 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
535 @emph{MIPS Options}
536 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
537 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
538 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
539 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
540 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
541 -mpaired-single  -mips3d @gol
542 -mint64  -mlong64  -mlong32 @gol
543 -G@var{num}  -membedded-data  -mno-embedded-data @gol
544 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
545 -msplit-addresses  -mno-split-addresses  @gol
546 -mexplicit-relocs  -mno-explicit-relocs  @gol
547 -mcheck-zero-division  -mno-check-zero-division @gol
548 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
549 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
550 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
551 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
552 -mflush-func=@var{func}  -mno-flush-func @gol
553 -mbranch-likely  -mno-branch-likely @gol
554 -mfp-exceptions -mno-fp-exceptions @gol
555 -mvr4130-align -mno-vr4130-align}
557 @emph{MMIX Options}
558 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
559 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
560 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
561 -mno-base-addresses  -msingle-exit  -mno-single-exit}
563 @emph{MN10300 Options}
564 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
565 -mam33  -mno-am33 @gol
566 -mam33-2  -mno-am33-2 @gol
567 -mno-crt0  -mrelax}
569 @emph{NS32K Options}
570 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
571 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
572 -mregparam  -mnoregparam  -msb  -mnosb @gol
573 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
575 @emph{PDP-11 Options}
576 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
577 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
578 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
579 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
580 -mbranch-expensive  -mbranch-cheap @gol
581 -msplit  -mno-split  -munix-asm  -mdec-asm}
583 @emph{PowerPC Options}
584 See RS/6000 and PowerPC Options.
586 @emph{RS/6000 and PowerPC Options}
587 @gccoptlist{-mcpu=@var{cpu-type} @gol
588 -mtune=@var{cpu-type} @gol
589 -mpower  -mno-power  -mpower2  -mno-power2 @gol
590 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
591 -maltivec  -mno-altivec @gol
592 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
593 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
594 -mnew-mnemonics  -mold-mnemonics @gol
595 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
596 -m64  -m32  -mxl-call  -mno-xl-call  -mpe @gol
597 -malign-power  -malign-natural @gol
598 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
599 -mstring  -mno-string  -mupdate  -mno-update @gol
600 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
601 -mstrict-align  -mno-strict-align  -mrelocatable @gol
602 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
603 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
604 -mdynamic-no-pic @gol
605 -mprioritize-restricted-insns=@var{priority} @gol
606 -msched-costly-dep=@var{dependence_type} @gol
607 -minsert-sched-nops=@var{scheme} @gol
608 -mcall-sysv  -mcall-netbsd @gol
609 -maix-struct-return  -msvr4-struct-return @gol
610 -mabi=altivec  -mabi=no-altivec @gol
611 -mabi=spe  -mabi=no-spe @gol
612 -misel=yes  -misel=no @gol
613 -mspe=yes  -mspe=no @gol
614 -mfloat-gprs=yes  -mfloat-gprs=no @gol
615 -mprototype  -mno-prototype @gol
616 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
617 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
619 @emph{S/390 and zSeries Options}
620 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
621 -mhard-float  -msoft-float  -mbackchain  -mno-backchain -mkernel-backchain @gol
622 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
623 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
624 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
625 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
627 @emph{SH Options}
628 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
629 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
630 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
631 -m5-64media  -m5-64media-nofpu @gol
632 -m5-32media  -m5-32media-nofpu @gol
633 -m5-compact  -m5-compact-nofpu @gol
634 -mb  -ml  -mdalign  -mrelax @gol
635 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
636 -mieee  -misize  -mpadstruct  -mspace @gol
637 -mprefergot  -musermode}
639 @emph{SPARC Options}
640 @gccoptlist{-mcpu=@var{cpu-type} @gol
641 -mtune=@var{cpu-type} @gol
642 -mcmodel=@var{code-model} @gol
643 -m32  -m64  -mapp-regs  -mno-app-regs @gol
644 -mfaster-structs  -mno-faster-structs @gol
645 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
646 -mhard-quad-float  -msoft-quad-float @gol
647 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
648 -mstack-bias  -mno-stack-bias @gol
649 -munaligned-doubles  -mno-unaligned-doubles @gol
650 -mv8plus  -mno-v8plus  -mvis  -mno-vis
651 -threads -pthreads}
653 @emph{System V Options}
654 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
656 @emph{TMS320C3x/C4x Options}
657 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
658 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
659 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
660 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
662 @emph{V850 Options}
663 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
664 -mprolog-function  -mno-prolog-function  -mspace @gol
665 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
666 -mapp-regs  -mno-app-regs @gol
667 -mdisable-callt  -mno-disable-callt @gol
668 -mv850e1 @gol
669 -mv850e @gol
670 -mv850  -mbig-switch}
672 @emph{VAX Options}
673 @gccoptlist{-mg  -mgnu  -munix}
675 @emph{x86-64 Options}
676 See i386 and x86-64 Options.
678 @emph{Xstormy16 Options}
679 @gccoptlist{-msim}
681 @emph{Xtensa Options}
682 @gccoptlist{-mconst16 -mno-const16 @gol
683 -mfused-madd  -mno-fused-madd @gol
684 -mtext-section-literals  -mno-text-section-literals @gol
685 -mtarget-align  -mno-target-align @gol
686 -mlongcalls  -mno-longcalls}
688 @emph{zSeries Options}
689 See S/390 and zSeries Options.
691 @item Code Generation Options
692 @xref{Code Gen Options,,Options for Code Generation Conventions}.
693 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
694 -ffixed-@var{reg}  -fexceptions @gol
695 -fnon-call-exceptions  -funwind-tables @gol
696 -fasynchronous-unwind-tables @gol
697 -finhibit-size-directive  -finstrument-functions @gol
698 -fno-common  -fno-ident @gol
699 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
700 -freg-struct-return  -fshared-data  -fshort-enums @gol
701 -fshort-double  -fshort-wchar @gol
702 -fverbose-asm  -fpack-struct  -fstack-check @gol
703 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
704 -fargument-alias  -fargument-noalias @gol
705 -fargument-noalias-global  -fleading-underscore @gol
706 -ftls-model=@var{model} @gol
707 -ftrapv  -fwrapv  -fbounds-check @gol
708 -fvisibility}
709 @end table
711 @menu
712 * Overall Options::     Controlling the kind of output:
713                         an executable, object files, assembler files,
714                         or preprocessed source.
715 * C Dialect Options::   Controlling the variant of C language compiled.
716 * C++ Dialect Options:: Variations on C++.
717 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
718                         and Objective-C++.
719 * Language Independent Options:: Controlling how diagnostics should be
720                         formatted.
721 * Warning Options::     How picky should the compiler be?
722 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
723 * Optimize Options::    How much optimization?
724 * Preprocessor Options:: Controlling header files and macro definitions.
725                          Also, getting dependency information for Make.
726 * Assembler Options::   Passing options to the assembler.
727 * Link Options::        Specifying libraries and so on.
728 * Directory Options::   Where to find header files and libraries.
729                         Where to find the compiler executable files.
730 * Spec Files::          How to pass switches to sub-processes.
731 * Target Options::      Running a cross-compiler, or an old version of GCC.
732 @end menu
734 @node Overall Options
735 @section Options Controlling the Kind of Output
737 Compilation can involve up to four stages: preprocessing, compilation
738 proper, assembly and linking, always in that order.  GCC is capable of
739 preprocessing and compiling several files either into several
740 assembler input files, or into one assembler input file; then each
741 assembler input file produces an object file, and linking combines all
742 the object files (those newly compiled, and those specified as input)
743 into an executable file.
745 @cindex file name suffix
746 For any given input file, the file name suffix determines what kind of
747 compilation is done:
749 @table @gcctabopt
750 @item @var{file}.c
751 C source code which must be preprocessed.
753 @item @var{file}.i
754 C source code which should not be preprocessed.
756 @item @var{file}.ii
757 C++ source code which should not be preprocessed.
759 @item @var{file}.m
760 Objective-C source code.  Note that you must link with the @file{libobjc}
761 library to make an Objective-C program work.
763 @item @var{file}.mi
764 Objective-C source code which should not be preprocessed.
766 @item @var{file}.mm
767 @itemx @var{file}.M
768 Objective-C++ source code.  Note that you must link with the @file{libobjc}
769 library to make an Objective-C++ program work.  Note that @samp{.M} refers
770 to a literal capital M@.
772 @item @var{file}.mii
773 Objective-C++ source code which should not be preprocessed.
775 @item @var{file}.h
776 C, C++, Objective-C or Objective-C++ header file to be turned into a
777 precompiled header.
779 @item @var{file}.cc
780 @itemx @var{file}.cp
781 @itemx @var{file}.cxx
782 @itemx @var{file}.cpp
783 @itemx @var{file}.CPP
784 @itemx @var{file}.c++
785 @itemx @var{file}.C
786 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
787 the last two letters must both be literally @samp{x}.  Likewise,
788 @samp{.C} refers to a literal capital C@.
790 @item @var{file}.hh
791 @itemx @var{file}.H
792 C++ header file to be turned into a precompiled header.
794 @item @var{file}.f
795 @itemx @var{file}.for
796 @itemx @var{file}.FOR
797 Fortran source code which should not be preprocessed.
799 @item @var{file}.F
800 @itemx @var{file}.fpp
801 @itemx @var{file}.FPP
802 Fortran source code which must be preprocessed (with the traditional
803 preprocessor).
805 @item @var{file}.r
806 Fortran source code which must be preprocessed with a RATFOR
807 preprocessor (not included with GCC)@.
809 @item @var{file}.f90
810 @itemx @var{file}.f95
811 Fortran 90/95 source code which should not be preprocessed.
813 @c FIXME: Descriptions of Java file types.
814 @c @var{file}.java
815 @c @var{file}.class
816 @c @var{file}.zip
817 @c @var{file}.jar
819 @item @var{file}.ads
820 Ada source code file which contains a library unit declaration (a
821 declaration of a package, subprogram, or generic, or a generic
822 instantiation), or a library unit renaming declaration (a package,
823 generic, or subprogram renaming declaration).  Such files are also
824 called @dfn{specs}.
826 @itemx @var{file}.adb
827 Ada source code file containing a library unit body (a subprogram or
828 package body).  Such files are also called @dfn{bodies}.
830 @c GCC also knows about some suffixes for languages not yet included:
831 @c Pascal:
832 @c @var{file}.p
833 @c @var{file}.pas
835 @item @var{file}.s
836 Assembler code.
838 @item @var{file}.S
839 Assembler code which must be preprocessed.
841 @item @var{other}
842 An object file to be fed straight into linking.
843 Any file name with no recognized suffix is treated this way.
844 @end table
846 @opindex x
847 You can specify the input language explicitly with the @option{-x} option:
849 @table @gcctabopt
850 @item -x @var{language}
851 Specify explicitly the @var{language} for the following input files
852 (rather than letting the compiler choose a default based on the file
853 name suffix).  This option applies to all following input files until
854 the next @option{-x} option.  Possible values for @var{language} are:
855 @smallexample
856 c  c-header  c-cpp-output
857 c++  c++-header  c++-cpp-output
858 objective-c  objective-c-header  objective-c-cpp-output
859 objective-c++ objective-c++-header objective-c++-cpp-output
860 assembler  assembler-with-cpp
862 f77  f77-cpp-input  ratfor
864 java
865 treelang
866 @end smallexample
868 @item -x none
869 Turn off any specification of a language, so that subsequent files are
870 handled according to their file name suffixes (as they are if @option{-x}
871 has not been used at all).
873 @item -pass-exit-codes
874 @opindex pass-exit-codes
875 Normally the @command{gcc} program will exit with the code of 1 if any
876 phase of the compiler returns a non-success return code.  If you specify
877 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
878 numerically highest error produced by any phase that returned an error
879 indication.
880 @end table
882 If you only want some of the stages of compilation, you can use
883 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
884 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
885 @command{gcc} is to stop.  Note that some combinations (for example,
886 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
888 @table @gcctabopt
889 @item -c
890 @opindex c
891 Compile or assemble the source files, but do not link.  The linking
892 stage simply is not done.  The ultimate output is in the form of an
893 object file for each source file.
895 By default, the object file name for a source file is made by replacing
896 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
898 Unrecognized input files, not requiring compilation or assembly, are
899 ignored.
901 @item -S
902 @opindex S
903 Stop after the stage of compilation proper; do not assemble.  The output
904 is in the form of an assembler code file for each non-assembler input
905 file specified.
907 By default, the assembler file name for a source file is made by
908 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
910 Input files that don't require compilation are ignored.
912 @item -E
913 @opindex E
914 Stop after the preprocessing stage; do not run the compiler proper.  The
915 output is in the form of preprocessed source code, which is sent to the
916 standard output.
918 Input files which don't require preprocessing are ignored.
920 @cindex output file option
921 @item -o @var{file}
922 @opindex o
923 Place output in file @var{file}.  This applies regardless to whatever
924 sort of output is being produced, whether it be an executable file,
925 an object file, an assembler file or preprocessed C code.
927 If @option{-o} is not specified, the default is to put an executable
928 file in @file{a.out}, the object file for
929 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
930 assembler file in @file{@var{source}.s}, a precompiled header file in
931 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
932 standard output.
934 @item -v
935 @opindex v
936 Print (on standard error output) the commands executed to run the stages
937 of compilation.  Also print the version number of the compiler driver
938 program and of the preprocessor and the compiler proper.
940 @item -###
941 @opindex ###
942 Like @option{-v} except the commands are not executed and all command
943 arguments are quoted.  This is useful for shell scripts to capture the
944 driver-generated command lines.
946 @item -pipe
947 @opindex pipe
948 Use pipes rather than temporary files for communication between the
949 various stages of compilation.  This fails to work on some systems where
950 the assembler is unable to read from a pipe; but the GNU assembler has
951 no trouble.
953 @item -combine
954 @opindex combine
955 If you are compiling multiple source files, this option tells the driver
956 to pass all the source files to the compiler at once (for those
957 languages for which the compiler can handle this).  This will allow
958 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
959 language for which this is supported is C.  If you pass source files for
960 multiple languages to the driver, using this option, the driver will invoke
961 the compiler(s) that support IMA once each, passing each compiler all the
962 source files appropriate for it.  For those languages that do not support
963 IMA this option will be ignored, and the compiler will be invoked once for
964 each source file in that language.  If you use this option in conjunction
965 with -save-temps, the compiler will generate multiple pre-processed files
966 (one for each source file), but only one (combined) .o or .s file.
968 @item --help
969 @opindex help
970 Print (on the standard output) a description of the command line options
971 understood by @command{gcc}.  If the @option{-v} option is also specified
972 then @option{--help} will also be passed on to the various processes
973 invoked by @command{gcc}, so that they can display the command line options
974 they accept.  If the @option{-Wextra} option is also specified then command
975 line options which have no documentation associated with them will also
976 be displayed.
978 @item --target-help
979 @opindex target-help
980 Print (on the standard output) a description of target specific command
981 line options for each tool.
983 @item --version
984 @opindex version
985 Display the version number and copyrights of the invoked GCC.
986 @end table
988 @node Invoking G++
989 @section Compiling C++ Programs
991 @cindex suffixes for C++ source
992 @cindex C++ source file suffixes
993 C++ source files conventionally use one of the suffixes @samp{.C},
994 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
995 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
996 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
997 files with these names and compiles them as C++ programs even if you
998 call the compiler the same way as for compiling C programs (usually
999 with the name @command{gcc}).
1001 @findex g++
1002 @findex c++
1003 However, C++ programs often require class libraries as well as a
1004 compiler that understands the C++ language---and under some
1005 circumstances, you might want to compile programs or header files from
1006 standard input, or otherwise without a suffix that flags them as C++
1007 programs.  You might also like to precompile a C header file with a
1008 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1009 program that calls GCC with the default language set to C++, and
1010 automatically specifies linking against the C++ library.  On many
1011 systems, @command{g++} is also installed with the name @command{c++}.
1013 @cindex invoking @command{g++}
1014 When you compile C++ programs, you may specify many of the same
1015 command-line options that you use for compiling programs in any
1016 language; or command-line options meaningful for C and related
1017 languages; or options that are meaningful only for C++ programs.
1018 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1019 explanations of options for languages related to C@.
1020 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1021 explanations of options that are meaningful only for C++ programs.
1023 @node C Dialect Options
1024 @section Options Controlling C Dialect
1025 @cindex dialect options
1026 @cindex language dialect options
1027 @cindex options, dialect
1029 The following options control the dialect of C (or languages derived
1030 from C, such as C++, Objective-C and Objective-C++) that the compiler
1031 accepts:
1033 @table @gcctabopt
1034 @cindex ANSI support
1035 @cindex ISO support
1036 @item -ansi
1037 @opindex ansi
1038 In C mode, support all ISO C90 programs.  In C++ mode,
1039 remove GNU extensions that conflict with ISO C++.
1041 This turns off certain features of GCC that are incompatible with ISO
1042 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1043 such as the @code{asm} and @code{typeof} keywords, and
1044 predefined macros such as @code{unix} and @code{vax} that identify the
1045 type of system you are using.  It also enables the undesirable and
1046 rarely used ISO trigraph feature.  For the C compiler,
1047 it disables recognition of C++ style @samp{//} comments as well as
1048 the @code{inline} keyword.
1050 The alternate keywords @code{__asm__}, @code{__extension__},
1051 @code{__inline__} and @code{__typeof__} continue to work despite
1052 @option{-ansi}.  You would not want to use them in an ISO C program, of
1053 course, but it is useful to put them in header files that might be included
1054 in compilations done with @option{-ansi}.  Alternate predefined macros
1055 such as @code{__unix__} and @code{__vax__} are also available, with or
1056 without @option{-ansi}.
1058 The @option{-ansi} option does not cause non-ISO programs to be
1059 rejected gratuitously.  For that, @option{-pedantic} is required in
1060 addition to @option{-ansi}.  @xref{Warning Options}.
1062 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1063 option is used.  Some header files may notice this macro and refrain
1064 from declaring certain functions or defining certain macros that the
1065 ISO standard doesn't call for; this is to avoid interfering with any
1066 programs that might use these names for other things.
1068 Functions which would normally be built in but do not have semantics
1069 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1070 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1071 built-in functions provided by GCC}, for details of the functions
1072 affected.
1074 @item -std=
1075 @opindex std
1076 Determine the language standard.  This option is currently only
1077 supported when compiling C or C++.  A value for this option must be
1078 provided; possible values are
1080 @table @samp
1081 @item c89
1082 @itemx iso9899:1990
1083 ISO C90 (same as @option{-ansi}).
1085 @item iso9899:199409
1086 ISO C90 as modified in amendment 1.
1088 @item c99
1089 @itemx c9x
1090 @itemx iso9899:1999
1091 @itemx iso9899:199x
1092 ISO C99.  Note that this standard is not yet fully supported; see
1093 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1094 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1096 @item gnu89
1097 Default, ISO C90 plus GNU extensions (including some C99 features).
1099 @item gnu99
1100 @itemx gnu9x
1101 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1102 this will become the default.  The name @samp{gnu9x} is deprecated.
1104 @item c++98
1105 The 1998 ISO C++ standard plus amendments.
1107 @item gnu++98
1108 The same as @option{-std=c++98} plus GNU extensions.  This is the
1109 default for C++ code.
1110 @end table
1112 Even when this option is not specified, you can still use some of the
1113 features of newer standards in so far as they do not conflict with
1114 previous C standards.  For example, you may use @code{__restrict__} even
1115 when @option{-std=c99} is not specified.
1117 The @option{-std} options specifying some version of ISO C have the same
1118 effects as @option{-ansi}, except that features that were not in ISO C90
1119 but are in the specified version (for example, @samp{//} comments and
1120 the @code{inline} keyword in ISO C99) are not disabled.
1122 @xref{Standards,,Language Standards Supported by GCC}, for details of
1123 these standard versions.
1125 @item -aux-info @var{filename}
1126 @opindex aux-info
1127 Output to the given filename prototyped declarations for all functions
1128 declared and/or defined in a translation unit, including those in header
1129 files.  This option is silently ignored in any language other than C@.
1131 Besides declarations, the file indicates, in comments, the origin of
1132 each declaration (source file and line), whether the declaration was
1133 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1134 @samp{O} for old, respectively, in the first character after the line
1135 number and the colon), and whether it came from a declaration or a
1136 definition (@samp{C} or @samp{F}, respectively, in the following
1137 character).  In the case of function definitions, a K&R-style list of
1138 arguments followed by their declarations is also provided, inside
1139 comments, after the declaration.
1141 @item -fno-asm
1142 @opindex fno-asm
1143 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1144 keyword, so that code can use these words as identifiers.  You can use
1145 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1146 instead.  @option{-ansi} implies @option{-fno-asm}.
1148 In C++, this switch only affects the @code{typeof} keyword, since
1149 @code{asm} and @code{inline} are standard keywords.  You may want to
1150 use the @option{-fno-gnu-keywords} flag instead, which has the same
1151 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1152 switch only affects the @code{asm} and @code{typeof} keywords, since
1153 @code{inline} is a standard keyword in ISO C99.
1155 @item -fno-builtin
1156 @itemx -fno-builtin-@var{function}
1157 @opindex fno-builtin
1158 @cindex built-in functions
1159 Don't recognize built-in functions that do not begin with
1160 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1161 functions provided by GCC}, for details of the functions affected,
1162 including those which are not built-in functions when @option{-ansi} or
1163 @option{-std} options for strict ISO C conformance are used because they
1164 do not have an ISO standard meaning.
1166 GCC normally generates special code to handle certain built-in functions
1167 more efficiently; for instance, calls to @code{alloca} may become single
1168 instructions that adjust the stack directly, and calls to @code{memcpy}
1169 may become inline copy loops.  The resulting code is often both smaller
1170 and faster, but since the function calls no longer appear as such, you
1171 cannot set a breakpoint on those calls, nor can you change the behavior
1172 of the functions by linking with a different library.
1174 With the @option{-fno-builtin-@var{function}} option
1175 only the built-in function @var{function} is
1176 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1177 function is named this is not built-in in this version of GCC, this
1178 option is ignored.  There is no corresponding
1179 @option{-fbuiltin-@var{function}} option; if you wish to enable
1180 built-in functions selectively when using @option{-fno-builtin} or
1181 @option{-ffreestanding}, you may define macros such as:
1183 @smallexample
1184 #define abs(n)          __builtin_abs ((n))
1185 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1186 @end smallexample
1188 @item -fhosted
1189 @opindex fhosted
1190 @cindex hosted environment
1192 Assert that compilation takes place in a hosted environment.  This implies
1193 @option{-fbuiltin}.  A hosted environment is one in which the
1194 entire standard library is available, and in which @code{main} has a return
1195 type of @code{int}.  Examples are nearly everything except a kernel.
1196 This is equivalent to @option{-fno-freestanding}.
1198 @item -ffreestanding
1199 @opindex ffreestanding
1200 @cindex hosted environment
1202 Assert that compilation takes place in a freestanding environment.  This
1203 implies @option{-fno-builtin}.  A freestanding environment
1204 is one in which the standard library may not exist, and program startup may
1205 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1206 This is equivalent to @option{-fno-hosted}.
1208 @xref{Standards,,Language Standards Supported by GCC}, for details of
1209 freestanding and hosted environments.
1211 @item -fms-extensions
1212 @opindex fms-extensions
1213 Accept some non-standard constructs used in Microsoft header files.
1215 @item -trigraphs
1216 @opindex trigraphs
1217 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1218 options for strict ISO C conformance) implies @option{-trigraphs}.
1220 @item -no-integrated-cpp
1221 @opindex no-integrated-cpp
1222 Performs a compilation in two passes: preprocessing and compiling.  This
1223 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1224 @option{-B} option. The user supplied compilation step can then add in
1225 an additional preprocessing step after normal preprocessing but before
1226 compiling. The default is to use the integrated cpp (internal cpp)
1228 The semantics of this option will change if "cc1", "cc1plus", and
1229 "cc1obj" are merged.
1231 @cindex traditional C language
1232 @cindex C language, traditional
1233 @item -traditional
1234 @itemx -traditional-cpp
1235 @opindex traditional-cpp
1236 @opindex traditional
1237 Formerly, these options caused GCC to attempt to emulate a pre-standard
1238 C compiler.  They are now only supported with the @option{-E} switch.
1239 The preprocessor continues to support a pre-standard mode.  See the GNU
1240 CPP manual for details.
1242 @item -fcond-mismatch
1243 @opindex fcond-mismatch
1244 Allow conditional expressions with mismatched types in the second and
1245 third arguments.  The value of such an expression is void.  This option
1246 is not supported for C++.
1248 @item -funsigned-char
1249 @opindex funsigned-char
1250 Let the type @code{char} be unsigned, like @code{unsigned char}.
1252 Each kind of machine has a default for what @code{char} should
1253 be.  It is either like @code{unsigned char} by default or like
1254 @code{signed char} by default.
1256 Ideally, a portable program should always use @code{signed char} or
1257 @code{unsigned char} when it depends on the signedness of an object.
1258 But many programs have been written to use plain @code{char} and
1259 expect it to be signed, or expect it to be unsigned, depending on the
1260 machines they were written for.  This option, and its inverse, let you
1261 make such a program work with the opposite default.
1263 The type @code{char} is always a distinct type from each of
1264 @code{signed char} or @code{unsigned char}, even though its behavior
1265 is always just like one of those two.
1267 @item -fsigned-char
1268 @opindex fsigned-char
1269 Let the type @code{char} be signed, like @code{signed char}.
1271 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1272 the negative form of @option{-funsigned-char}.  Likewise, the option
1273 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1275 @item -fsigned-bitfields
1276 @itemx -funsigned-bitfields
1277 @itemx -fno-signed-bitfields
1278 @itemx -fno-unsigned-bitfields
1279 @opindex fsigned-bitfields
1280 @opindex funsigned-bitfields
1281 @opindex fno-signed-bitfields
1282 @opindex fno-unsigned-bitfields
1283 These options control whether a bit-field is signed or unsigned, when the
1284 declaration does not use either @code{signed} or @code{unsigned}.  By
1285 default, such a bit-field is signed, because this is consistent: the
1286 basic integer types such as @code{int} are signed types.
1287 @end table
1289 @node C++ Dialect Options
1290 @section Options Controlling C++ Dialect
1292 @cindex compiler options, C++
1293 @cindex C++ options, command line
1294 @cindex options, C++
1295 This section describes the command-line options that are only meaningful
1296 for C++ programs; but you can also use most of the GNU compiler options
1297 regardless of what language your program is in.  For example, you
1298 might compile a file @code{firstClass.C} like this:
1300 @smallexample
1301 g++ -g -frepo -O -c firstClass.C
1302 @end smallexample
1304 @noindent
1305 In this example, only @option{-frepo} is an option meant
1306 only for C++ programs; you can use the other options with any
1307 language supported by GCC@.
1309 Here is a list of options that are @emph{only} for compiling C++ programs:
1311 @table @gcctabopt
1313 @item -fabi-version=@var{n}
1314 @opindex fabi-version
1315 Use version @var{n} of the C++ ABI.  Version 2 is the version of the
1316 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1317 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1318 the version that conforms most closely to the C++ ABI specification.
1319 Therefore, the ABI obtained using version 0 will change as ABI bugs
1320 are fixed.
1322 The default is version 2.
1324 @item -fno-access-control
1325 @opindex fno-access-control
1326 Turn off all access checking.  This switch is mainly useful for working
1327 around bugs in the access control code.
1329 @item -fcheck-new
1330 @opindex fcheck-new
1331 Check that the pointer returned by @code{operator new} is non-null
1332 before attempting to modify the storage allocated.  This check is
1333 normally unnecessary because the C++ standard specifies that
1334 @code{operator new} will only return @code{0} if it is declared
1335 @samp{throw()}, in which case the compiler will always check the
1336 return value even without this option.  In all other cases, when
1337 @code{operator new} has a non-empty exception specification, memory
1338 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1339 @samp{new (nothrow)}.
1341 @item -fconserve-space
1342 @opindex fconserve-space
1343 Put uninitialized or runtime-initialized global variables into the
1344 common segment, as C does.  This saves space in the executable at the
1345 cost of not diagnosing duplicate definitions.  If you compile with this
1346 flag and your program mysteriously crashes after @code{main()} has
1347 completed, you may have an object that is being destroyed twice because
1348 two definitions were merged.
1350 This option is no longer useful on most targets, now that support has
1351 been added for putting variables into BSS without making them common.
1353 @item -fno-const-strings
1354 @opindex fno-const-strings
1355 Give string constants type @code{char *} instead of type @code{const
1356 char *}.  By default, G++ uses type @code{const char *} as required by
1357 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1358 actually modify the value of a string constant.
1360 This option might be removed in a future release of G++.  For maximum
1361 portability, you should structure your code so that it works with
1362 string constants that have type @code{const char *}.
1364 @item -fno-elide-constructors
1365 @opindex fno-elide-constructors
1366 The C++ standard allows an implementation to omit creating a temporary
1367 which is only used to initialize another object of the same type.
1368 Specifying this option disables that optimization, and forces G++ to
1369 call the copy constructor in all cases.
1371 @item -fno-enforce-eh-specs
1372 @opindex fno-enforce-eh-specs
1373 Don't check for violation of exception specifications at runtime.  This
1374 option violates the C++ standard, but may be useful for reducing code
1375 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1376 will still optimize based on the exception specifications.
1378 @item -ffor-scope
1379 @itemx -fno-for-scope
1380 @opindex ffor-scope
1381 @opindex fno-for-scope
1382 If @option{-ffor-scope} is specified, the scope of variables declared in
1383 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1384 as specified by the C++ standard.
1385 If @option{-fno-for-scope} is specified, the scope of variables declared in
1386 a @i{for-init-statement} extends to the end of the enclosing scope,
1387 as was the case in old versions of G++, and other (traditional)
1388 implementations of C++.
1390 The default if neither flag is given to follow the standard,
1391 but to allow and give a warning for old-style code that would
1392 otherwise be invalid, or have different behavior.
1394 @item -fno-gnu-keywords
1395 @opindex fno-gnu-keywords
1396 Do not recognize @code{typeof} as a keyword, so that code can use this
1397 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1398 @option{-ansi} implies @option{-fno-gnu-keywords}.
1400 @item -fno-implicit-templates
1401 @opindex fno-implicit-templates
1402 Never emit code for non-inline templates which are instantiated
1403 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1404 @xref{Template Instantiation}, for more information.
1406 @item -fno-implicit-inline-templates
1407 @opindex fno-implicit-inline-templates
1408 Don't emit code for implicit instantiations of inline templates, either.
1409 The default is to handle inlines differently so that compiles with and
1410 without optimization will need the same set of explicit instantiations.
1412 @item -fno-implement-inlines
1413 @opindex fno-implement-inlines
1414 To save space, do not emit out-of-line copies of inline functions
1415 controlled by @samp{#pragma implementation}.  This will cause linker
1416 errors if these functions are not inlined everywhere they are called.
1418 @item -fms-extensions
1419 @opindex fms-extensions
1420 Disable pedantic warnings about constructs used in MFC, such as implicit
1421 int and getting a pointer to member function via non-standard syntax.
1423 @item -fno-nonansi-builtins
1424 @opindex fno-nonansi-builtins
1425 Disable built-in declarations of functions that are not mandated by
1426 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1427 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1429 @item -fno-operator-names
1430 @opindex fno-operator-names
1431 Do not treat the operator name keywords @code{and}, @code{bitand},
1432 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1433 synonyms as keywords.
1435 @item -fno-optional-diags
1436 @opindex fno-optional-diags
1437 Disable diagnostics that the standard says a compiler does not need to
1438 issue.  Currently, the only such diagnostic issued by G++ is the one for
1439 a name having multiple meanings within a class.
1441 @item -fpermissive
1442 @opindex fpermissive
1443 Downgrade some diagnostics about nonconformant code from errors to
1444 warnings.  Thus, using @option{-fpermissive} will allow some
1445 nonconforming code to compile.
1447 @item -frepo
1448 @opindex frepo
1449 Enable automatic template instantiation at link time.  This option also
1450 implies @option{-fno-implicit-templates}.  @xref{Template
1451 Instantiation}, for more information.
1453 @item -fno-rtti
1454 @opindex fno-rtti
1455 Disable generation of information about every class with virtual
1456 functions for use by the C++ runtime type identification features
1457 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1458 of the language, you can save some space by using this flag.  Note that
1459 exception handling uses the same information, but it will generate it as
1460 needed.
1462 @item -fstats
1463 @opindex fstats
1464 Emit statistics about front-end processing at the end of the compilation.
1465 This information is generally only useful to the G++ development team.
1467 @item -ftemplate-depth-@var{n}
1468 @opindex ftemplate-depth
1469 Set the maximum instantiation depth for template classes to @var{n}.
1470 A limit on the template instantiation depth is needed to detect
1471 endless recursions during template class instantiation.  ANSI/ISO C++
1472 conforming programs must not rely on a maximum depth greater than 17.
1474 @item -fno-threadsafe-statics
1475 @opindex fno-threadsafe-statics
1476 Do not emit the extra code to use the routines specified in the C++
1477 ABI for thread-safe initialization of local statics.  You can use this
1478 option to reduce code size slightly in code that doesn't need to be
1479 thread-safe.
1481 @item -fuse-cxa-atexit
1482 @opindex fuse-cxa-atexit
1483 Register destructors for objects with static storage duration with the
1484 @code{__cxa_atexit} function rather than the @code{atexit} function.
1485 This option is required for fully standards-compliant handling of static
1486 destructors, but will only work if your C library supports
1487 @code{__cxa_atexit}.
1489 @item -fvisibility-inlines-hidden
1490 @opindex fvisibility-inlines-hidden
1491 Causes all inlined methods to be marked with
1492 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1493 appear in the export table of a DSO and do not require a PLT indirection
1494 when used within the DSO. Enabling this option can have a dramatic effect
1495 on load and link times of a DSO as it massively reduces the size of the
1496 dynamic export table when the library makes heavy use of templates. While
1497 it can cause bloating through duplication of code within each DSO where
1498 it is used, often the wastage is less than the considerable space occupied
1499 by a long symbol name in the export table which is typical when using
1500 templates and namespaces. For even more savings, combine with the
1501 @code{-fvisibility=hidden} switch.
1503 @item -fno-weak
1504 @opindex fno-weak
1505 Do not use weak symbol support, even if it is provided by the linker.
1506 By default, G++ will use weak symbols if they are available.  This
1507 option exists only for testing, and should not be used by end-users;
1508 it will result in inferior code and has no benefits.  This option may
1509 be removed in a future release of G++.
1511 @item -nostdinc++
1512 @opindex nostdinc++
1513 Do not search for header files in the standard directories specific to
1514 C++, but do still search the other standard directories.  (This option
1515 is used when building the C++ library.)
1516 @end table
1518 In addition, these optimization, warning, and code generation options
1519 have meanings only for C++ programs:
1521 @table @gcctabopt
1522 @item -fno-default-inline
1523 @opindex fno-default-inline
1524 Do not assume @samp{inline} for functions defined inside a class scope.
1525 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1526 functions will have linkage like inline functions; they just won't be
1527 inlined by default.
1529 @item -Wabi @r{(C++ only)}
1530 @opindex Wabi
1531 Warn when G++ generates code that is probably not compatible with the
1532 vendor-neutral C++ ABI.  Although an effort has been made to warn about
1533 all such cases, there are probably some cases that are not warned about,
1534 even though G++ is generating incompatible code.  There may also be
1535 cases where warnings are emitted even though the code that is generated
1536 will be compatible.
1538 You should rewrite your code to avoid these warnings if you are
1539 concerned about the fact that code generated by G++ may not be binary
1540 compatible with code generated by other compilers.
1542 The known incompatibilities at this point include:
1544 @itemize @bullet
1546 @item
1547 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1548 pack data into the same byte as a base class.  For example:
1550 @smallexample
1551 struct A @{ virtual void f(); int f1 : 1; @};
1552 struct B : public A @{ int f2 : 1; @};
1553 @end smallexample
1555 @noindent
1556 In this case, G++ will place @code{B::f2} into the same byte
1557 as@code{A::f1}; other compilers will not.  You can avoid this problem
1558 by explicitly padding @code{A} so that its size is a multiple of the
1559 byte size on your platform; that will cause G++ and other compilers to
1560 layout @code{B} identically.
1562 @item
1563 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1564 tail padding when laying out virtual bases.  For example:
1566 @smallexample
1567 struct A @{ virtual void f(); char c1; @};
1568 struct B @{ B(); char c2; @};
1569 struct C : public A, public virtual B @{@};
1570 @end smallexample
1572 @noindent
1573 In this case, G++ will not place @code{B} into the tail-padding for
1574 @code{A}; other compilers will.  You can avoid this problem by
1575 explicitly padding @code{A} so that its size is a multiple of its
1576 alignment (ignoring virtual base classes); that will cause G++ and other
1577 compilers to layout @code{C} identically.
1579 @item
1580 Incorrect handling of bit-fields with declared widths greater than that
1581 of their underlying types, when the bit-fields appear in a union.  For
1582 example:
1584 @smallexample
1585 union U @{ int i : 4096; @};
1586 @end smallexample
1588 @noindent
1589 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1590 union too small by the number of bits in an @code{int}.
1592 @item
1593 Empty classes can be placed at incorrect offsets.  For example:
1595 @smallexample
1596 struct A @{@};
1598 struct B @{
1599   A a;
1600   virtual void f ();
1603 struct C : public B, public A @{@};
1604 @end smallexample
1606 @noindent
1607 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1608 it should be placed at offset zero.  G++ mistakenly believes that the
1609 @code{A} data member of @code{B} is already at offset zero.
1611 @item
1612 Names of template functions whose types involve @code{typename} or
1613 template template parameters can be mangled incorrectly.
1615 @smallexample
1616 template <typename Q>
1617 void f(typename Q::X) @{@}
1619 template <template <typename> class Q>
1620 void f(typename Q<int>::X) @{@}
1621 @end smallexample
1623 @noindent
1624 Instantiations of these templates may be mangled incorrectly.
1626 @end itemize
1628 @item -Wctor-dtor-privacy @r{(C++ only)}
1629 @opindex Wctor-dtor-privacy
1630 Warn when a class seems unusable because all the constructors or
1631 destructors in that class are private, and it has neither friends nor
1632 public static member functions.
1634 @item -Wnon-virtual-dtor @r{(C++ only)}
1635 @opindex Wnon-virtual-dtor
1636 Warn when a class appears to be polymorphic, thereby requiring a virtual
1637 destructor, yet it declares a non-virtual one.
1638 This warning is enabled by @option{-Wall}.
1640 @item -Wreorder @r{(C++ only)}
1641 @opindex Wreorder
1642 @cindex reordering, warning
1643 @cindex warning for reordering of member initializers
1644 Warn when the order of member initializers given in the code does not
1645 match the order in which they must be executed.  For instance:
1647 @smallexample
1648 struct A @{
1649   int i;
1650   int j;
1651   A(): j (0), i (1) @{ @}
1653 @end smallexample
1655 The compiler will rearrange the member initializers for @samp{i}
1656 and @samp{j} to match the declaration order of the members, emitting
1657 a warning to that effect.  This warning is enabled by @option{-Wall}.
1658 @end table
1660 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1662 @table @gcctabopt
1663 @item -Weffc++ @r{(C++ only)}
1664 @opindex Weffc++
1665 Warn about violations of the following style guidelines from Scott Meyers'
1666 @cite{Effective C++} book:
1668 @itemize @bullet
1669 @item
1670 Item 11:  Define a copy constructor and an assignment operator for classes
1671 with dynamically allocated memory.
1673 @item
1674 Item 12:  Prefer initialization to assignment in constructors.
1676 @item
1677 Item 14:  Make destructors virtual in base classes.
1679 @item
1680 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1682 @item
1683 Item 23:  Don't try to return a reference when you must return an object.
1685 @end itemize
1687 Also warn about violations of the following style guidelines from
1688 Scott Meyers' @cite{More Effective C++} book:
1690 @itemize @bullet
1691 @item
1692 Item 6:  Distinguish between prefix and postfix forms of increment and
1693 decrement operators.
1695 @item
1696 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1698 @end itemize
1700 When selecting this option, be aware that the standard library
1701 headers do not obey all of these guidelines; use @samp{grep -v}
1702 to filter out those warnings.
1704 @item -Wno-deprecated @r{(C++ only)}
1705 @opindex Wno-deprecated
1706 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1708 @item -Wno-non-template-friend @r{(C++ only)}
1709 @opindex Wno-non-template-friend
1710 Disable warnings when non-templatized friend functions are declared
1711 within a template.  Since the advent of explicit template specification
1712 support in G++, if the name of the friend is an unqualified-id (i.e.,
1713 @samp{friend foo(int)}), the C++ language specification demands that the
1714 friend declare or define an ordinary, nontemplate function.  (Section
1715 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1716 could be interpreted as a particular specialization of a templatized
1717 function.  Because this non-conforming behavior is no longer the default
1718 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1719 check existing code for potential trouble spots and is on by default.
1720 This new compiler behavior can be turned off with
1721 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1722 but disables the helpful warning.
1724 @item -Wold-style-cast @r{(C++ only)}
1725 @opindex Wold-style-cast
1726 Warn if an old-style (C-style) cast to a non-void type is used within
1727 a C++ program.  The new-style casts (@samp{static_cast},
1728 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1729 unintended effects and much easier to search for.
1731 @item -Woverloaded-virtual @r{(C++ only)}
1732 @opindex Woverloaded-virtual
1733 @cindex overloaded virtual fn, warning
1734 @cindex warning for overloaded virtual fn
1735 Warn when a function declaration hides virtual functions from a
1736 base class.  For example, in:
1738 @smallexample
1739 struct A @{
1740   virtual void f();
1743 struct B: public A @{
1744   void f(int);
1746 @end smallexample
1748 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1749 like:
1751 @smallexample
1752 B* b;
1753 b->f();
1754 @end smallexample
1756 will fail to compile.
1758 @item -Wno-pmf-conversions @r{(C++ only)}
1759 @opindex Wno-pmf-conversions
1760 Disable the diagnostic for converting a bound pointer to member function
1761 to a plain pointer.
1763 @item -Wsign-promo @r{(C++ only)}
1764 @opindex Wsign-promo
1765 Warn when overload resolution chooses a promotion from unsigned or
1766 enumerated type to a signed type, over a conversion to an unsigned type of
1767 the same size.  Previous versions of G++ would try to preserve
1768 unsignedness, but the standard mandates the current behavior.
1770 @item -Wsynth @r{(C++ only)}
1771 @opindex Wsynth
1772 @cindex warning for synthesized methods
1773 @cindex synthesized methods, warning
1774 Warn when G++'s synthesis behavior does not match that of cfront.  For
1775 instance:
1777 @smallexample
1778 struct A @{
1779   operator int ();
1780   A& operator = (int);
1783 main ()
1785   A a,b;
1786   a = b;
1788 @end smallexample
1790 In this example, G++ will synthesize a default @samp{A& operator =
1791 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1792 @end table
1794 @node Objective-C and Objective-C++ Dialect Options
1795 @section Options Controlling Objective-C and Objective-C++ Dialects
1797 @cindex compiler options, Objective-C and Objective-C++
1798 @cindex Objective-C and Objective-C++ options, command line
1799 @cindex options, Objective-C and Objective-C++
1800 (NOTE: This manual does not describe the Objective-C and Objective-C++
1801 languages themselves.  See @xref{Standards,,Language Standards
1802 Supported by GCC}, for references.)
1804 This section describes the command-line options that are only meaningful
1805 for Objective-C and Objective-C++ programs, but you can also use most of
1806 the language-independent GNU compiler options.
1807 For example, you might compile a file @code{some_class.m} like this:
1809 @smallexample
1810 gcc -g -fgnu-runtime -O -c some_class.m
1811 @end smallexample
1813 @noindent
1814 In this example, @option{-fgnu-runtime} is an option meant only for
1815 Objective-C and Objective-C++ programs; you can use the other options with
1816 any language supported by GCC@.
1818 Note that since Objective-C is an extension of the C language, Objective-C
1819 compilations may also use options specific to the C front-end (e.g., 
1820 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1821 C++-specific options (e.g., @option{-Wabi}).
1823 Here is a list of options that are @emph{only} for compiling Objective-C
1824 and Objective-C++ programs:
1826 @table @gcctabopt
1827 @item -fconstant-string-class=@var{class-name}
1828 @opindex fconstant-string-class
1829 Use @var{class-name} as the name of the class to instantiate for each
1830 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1831 class name is @code{NXConstantString} if the GNU runtime is being used, and
1832 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1833 @option{-fconstant-cfstrings} option, if also present, will override the
1834 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1835 to be laid out as constant CoreFoundation strings.
1837 @item -fgnu-runtime
1838 @opindex fgnu-runtime
1839 Generate object code compatible with the standard GNU Objective-C
1840 runtime.  This is the default for most types of systems.
1842 @item -fnext-runtime
1843 @opindex fnext-runtime
1844 Generate output compatible with the NeXT runtime.  This is the default
1845 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1846 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1847 used.
1849 @item -fno-nil-receivers
1850 @opindex fno-nil-receivers
1851 Assume that all Objective-C message dispatches (e.g.,
1852 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1853 is not @code{nil}.  This allows for more efficient entry points in the runtime
1854 to be used.  Currently, this option is only available in conjunction with
1855 the NeXT runtime on Mac OS X 10.3 and later.
1857 @item -fobjc-exceptions
1858 @opindex fobjc-exceptions
1859 Enable syntactic support for structured exception handling in Objective-C,
1860 similar to what is offered by C++ and Java.  Currently, this option is only
1861 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1863 @smallexample
1864   @@try @{
1865     @dots{}
1866        @@throw expr;
1867     @dots{}
1868   @}
1869   @@catch (AnObjCClass *exc) @{
1870     @dots{}
1871       @@throw expr;
1872     @dots{}
1873       @@throw;
1874     @dots{}
1875   @}
1876   @@catch (AnotherClass *exc) @{
1877     @dots{}
1878   @}
1879   @@catch (id allOthers) @{
1880     @dots{}
1881   @}
1882   @@finally @{
1883     @dots{}
1884       @@throw expr;
1885     @dots{}
1886   @}
1887 @end smallexample
1889 The @code{@@throw} statement may appear anywhere in an Objective-C or
1890 Objective-C++ program; when used inside of a @code{@@catch} block, the
1891 @code{@@throw} may appear without an argument (as shown above), in which case
1892 the object caught by the @code{@@catch} will be rethrown.
1894 Note that only (pointers to) Objective-C objects may be thrown and
1895 caught using this scheme.  When an object is thrown, it will be caught
1896 by the nearest @code{@@catch} clause capable of handling objects of that type,
1897 analogously to how @code{catch} blocks work in C++ and Java.  A
1898 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1899 any and all Objective-C exceptions not caught by previous @code{@@catch}
1900 clauses (if any).
1902 The @code{@@finally} clause, if present, will be executed upon exit from the
1903 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1904 regardless of whether any exceptions are thrown, caught or rethrown
1905 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1906 of the @code{finally} clause in Java.
1908 There are several caveats to using the new exception mechanism:
1910 @itemize @bullet
1911 @item
1912 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1913 idioms provided by the @code{NSException} class, the new
1914 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1915 systems, due to additional functionality needed in the (NeXT) Objective-C
1916 runtime.
1918 @item
1919 As mentioned above, the new exceptions do not support handling
1920 types other than Objective-C objects.   Furthermore, when used from
1921 Objective-C++, the Objective-C exception model does not interoperate with C++
1922 exceptions at this time.  This means you cannot @code{@@throw} an exception
1923 from Objective-C and @code{catch} it in C++, or vice versa
1924 (i.e., @code{throw @dots{} @@catch}).
1925 @end itemize
1927 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1928 blocks for thread-safe execution:
1930 @smallexample
1931   @@synchronized (ObjCClass *guard) @{
1932     @dots{}
1933   @}
1934 @end smallexample
1936 Upon entering the @code{@@synchronized} block, a thread of execution shall
1937 first check whether a lock has been placed on the corresponding @code{guard}
1938 object by another thread.  If it has, the current thread shall wait until
1939 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1940 the current thread will place its own lock on it, execute the code contained in
1941 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1942 making @code{guard} available to other threads).
1944 Unlike Java, Objective-C does not allow for entire methods to be marked
1945 @code{@@synchronized}.  Note that throwing exceptions out of
1946 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1947 to be unlocked properly.
1949 @item -freplace-objc-classes
1950 @opindex freplace-objc-classes
1951 Emit a special marker instructing @command{ld(1)} not to statically link in
1952 the resulting object file, and allow @command{dyld(1)} to load it in at
1953 run time instead.  This is used in conjunction with the Fix-and-Continue
1954 debugging mode, where the object file in question may be recompiled and
1955 dynamically reloaded in the course of program execution, without the need
1956 to restart the program itself.  Currently, Fix-and-Continue functionality
1957 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1958 and later.
1960 @item -fzero-link
1961 @opindex fzero-link
1962 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1963 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1964 compile time) with static class references that get initialized at load time,
1965 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1966 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1967 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1968 for individual class implementations to be modified during program execution.
1970 @item -gen-decls
1971 @opindex gen-decls
1972 Dump interface declarations for all classes seen in the source file to a
1973 file named @file{@var{sourcename}.decl}.
1975 @item -Wno-protocol
1976 @opindex Wno-protocol
1977 If a class is declared to implement a protocol, a warning is issued for
1978 every method in the protocol that is not implemented by the class.  The
1979 default behavior is to issue a warning for every method not explicitly
1980 implemented in the class, even if a method implementation is inherited
1981 from the superclass.  If you use the @code{-Wno-protocol} option, then
1982 methods inherited from the superclass are considered to be implemented,
1983 and no warning is issued for them.
1985 @item -Wselector
1986 @opindex Wselector
1987 Warn if multiple methods of different types for the same selector are
1988 found during compilation.  The check is performed on the list of methods
1989 in the final stage of compilation.  Additionally, a check is performed
1990 for each selector appearing in a @code{@@selector(@dots{})}
1991 expression, and a corresponding method for that selector has been found
1992 during compilation.  Because these checks scan the method table only at
1993 the end of compilation, these warnings are not produced if the final
1994 stage of compilation is not reached, for example because an error is
1995 found during compilation, or because the @code{-fsyntax-only} option is
1996 being used.
1998 @item -Wundeclared-selector
1999 @opindex Wundeclared-selector
2000 Warn if a @code{@@selector(@dots{})} expression referring to an
2001 undeclared selector is found.  A selector is considered undeclared if no
2002 method with that name has been declared before the
2003 @code{@@selector(@dots{})} expression, either explicitly in an
2004 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2005 an @code{@@implementation} section.  This option always performs its
2006 checks as soon as a @code{@@selector(@dots{})} expression is found,
2007 while @code{-Wselector} only performs its checks in the final stage of
2008 compilation.  This also enforces the coding style convention
2009 that methods and selectors must be declared before being used.
2011 @item -print-objc-runtime-info
2012 @opindex print-objc-runtime-info
2013 Generate C header describing the largest structure that is passed by
2014 value, if any.
2016 @end table
2018 @node Language Independent Options
2019 @section Options to Control Diagnostic Messages Formatting
2020 @cindex options to control diagnostics formatting
2021 @cindex diagnostic messages
2022 @cindex message formatting
2024 Traditionally, diagnostic messages have been formatted irrespective of
2025 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2026 below can be used to control the diagnostic messages formatting
2027 algorithm, e.g.@: how many characters per line, how often source location
2028 information should be reported.  Right now, only the C++ front end can
2029 honor these options.  However it is expected, in the near future, that
2030 the remaining front ends would be able to digest them correctly.
2032 @table @gcctabopt
2033 @item -fmessage-length=@var{n}
2034 @opindex fmessage-length
2035 Try to format error messages so that they fit on lines of about @var{n}
2036 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2037 the front ends supported by GCC@.  If @var{n} is zero, then no
2038 line-wrapping will be done; each error message will appear on a single
2039 line.
2041 @opindex fdiagnostics-show-location
2042 @item -fdiagnostics-show-location=once
2043 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2044 reporter to emit @emph{once} source location information; that is, in
2045 case the message is too long to fit on a single physical line and has to
2046 be wrapped, the source location won't be emitted (as prefix) again,
2047 over and over, in subsequent continuation lines.  This is the default
2048 behavior.
2050 @item -fdiagnostics-show-location=every-line
2051 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2052 messages reporter to emit the same source location information (as
2053 prefix) for physical lines that result from the process of breaking
2054 a message which is too long to fit on a single line.
2056 @end table
2058 @node Warning Options
2059 @section Options to Request or Suppress Warnings
2060 @cindex options to control warnings
2061 @cindex warning messages
2062 @cindex messages, warning
2063 @cindex suppressing warnings
2065 Warnings are diagnostic messages that report constructions which
2066 are not inherently erroneous but which are risky or suggest there
2067 may have been an error.
2069 You can request many specific warnings with options beginning @samp{-W},
2070 for example @option{-Wimplicit} to request warnings on implicit
2071 declarations.  Each of these specific warning options also has a
2072 negative form beginning @samp{-Wno-} to turn off warnings;
2073 for example, @option{-Wno-implicit}.  This manual lists only one of the
2074 two forms, whichever is not the default.
2076 The following options control the amount and kinds of warnings produced
2077 by GCC; for further, language-specific options also refer to
2078 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2079 Options}.
2081 @table @gcctabopt
2082 @cindex syntax checking
2083 @item -fsyntax-only
2084 @opindex fsyntax-only
2085 Check the code for syntax errors, but don't do anything beyond that.
2087 @item -pedantic
2088 @opindex pedantic
2089 Issue all the warnings demanded by strict ISO C and ISO C++;
2090 reject all programs that use forbidden extensions, and some other
2091 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2092 version of the ISO C standard specified by any @option{-std} option used.
2094 Valid ISO C and ISO C++ programs should compile properly with or without
2095 this option (though a rare few will require @option{-ansi} or a
2096 @option{-std} option specifying the required version of ISO C)@.  However,
2097 without this option, certain GNU extensions and traditional C and C++
2098 features are supported as well.  With this option, they are rejected.
2100 @option{-pedantic} does not cause warning messages for use of the
2101 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2102 warnings are also disabled in the expression that follows
2103 @code{__extension__}.  However, only system header files should use
2104 these escape routes; application programs should avoid them.
2105 @xref{Alternate Keywords}.
2107 Some users try to use @option{-pedantic} to check programs for strict ISO
2108 C conformance.  They soon find that it does not do quite what they want:
2109 it finds some non-ISO practices, but not all---only those for which
2110 ISO C @emph{requires} a diagnostic, and some others for which
2111 diagnostics have been added.
2113 A feature to report any failure to conform to ISO C might be useful in
2114 some instances, but would require considerable additional work and would
2115 be quite different from @option{-pedantic}.  We don't have plans to
2116 support such a feature in the near future.
2118 Where the standard specified with @option{-std} represents a GNU
2119 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2120 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2121 extended dialect is based.  Warnings from @option{-pedantic} are given
2122 where they are required by the base standard.  (It would not make sense
2123 for such warnings to be given only for features not in the specified GNU
2124 C dialect, since by definition the GNU dialects of C include all
2125 features the compiler supports with the given option, and there would be
2126 nothing to warn about.)
2128 @item -pedantic-errors
2129 @opindex pedantic-errors
2130 Like @option{-pedantic}, except that errors are produced rather than
2131 warnings.
2133 @item -w
2134 @opindex w
2135 Inhibit all warning messages.
2137 @item -Wno-import
2138 @opindex Wno-import
2139 Inhibit warning messages about the use of @samp{#import}.
2141 @item -Wchar-subscripts
2142 @opindex Wchar-subscripts
2143 Warn if an array subscript has type @code{char}.  This is a common cause
2144 of error, as programmers often forget that this type is signed on some
2145 machines.
2147 @item -Wcomment
2148 @opindex Wcomment
2149 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2150 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2152 @item -Wfatal-errors
2153 @opindex Wfatal-errors
2154 This option causes the compiler to abort compilation on the first error
2155 occurred rather than trying to keep going and printing further error
2156 messages.
2158 @item -Wformat
2159 @opindex Wformat
2160 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2161 the arguments supplied have types appropriate to the format string
2162 specified, and that the conversions specified in the format string make
2163 sense.  This includes standard functions, and others specified by format
2164 attributes (@pxref{Function Attributes}), in the @code{printf},
2165 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2166 not in the C standard) families (or other target-specific families).
2168 The formats are checked against the format features supported by GNU
2169 libc version 2.2.  These include all ISO C90 and C99 features, as well
2170 as features from the Single Unix Specification and some BSD and GNU
2171 extensions.  Other library implementations may not support all these
2172 features; GCC does not support warning about features that go beyond a
2173 particular library's limitations.  However, if @option{-pedantic} is used
2174 with @option{-Wformat}, warnings will be given about format features not
2175 in the selected standard version (but not for @code{strfmon} formats,
2176 since those are not in any version of the C standard).  @xref{C Dialect
2177 Options,,Options Controlling C Dialect}.
2179 Since @option{-Wformat} also checks for null format arguments for
2180 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2182 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2183 aspects of format checking, the options @option{-Wformat-y2k},
2184 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2185 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2186 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2188 @item -Wformat-y2k
2189 @opindex Wformat-y2k
2190 If @option{-Wformat} is specified, also warn about @code{strftime}
2191 formats which may yield only a two-digit year.
2193 @item -Wno-format-extra-args
2194 @opindex Wno-format-extra-args
2195 If @option{-Wformat} is specified, do not warn about excess arguments to a
2196 @code{printf} or @code{scanf} format function.  The C standard specifies
2197 that such arguments are ignored.
2199 Where the unused arguments lie between used arguments that are
2200 specified with @samp{$} operand number specifications, normally
2201 warnings are still given, since the implementation could not know what
2202 type to pass to @code{va_arg} to skip the unused arguments.  However,
2203 in the case of @code{scanf} formats, this option will suppress the
2204 warning if the unused arguments are all pointers, since the Single
2205 Unix Specification says that such unused arguments are allowed.
2207 @item -Wno-format-zero-length
2208 @opindex Wno-format-zero-length
2209 If @option{-Wformat} is specified, do not warn about zero-length formats.
2210 The C standard specifies that zero-length formats are allowed.
2212 @item -Wformat-nonliteral
2213 @opindex Wformat-nonliteral
2214 If @option{-Wformat} is specified, also warn if the format string is not a
2215 string literal and so cannot be checked, unless the format function
2216 takes its format arguments as a @code{va_list}.
2218 @item -Wformat-security
2219 @opindex Wformat-security
2220 If @option{-Wformat} is specified, also warn about uses of format
2221 functions that represent possible security problems.  At present, this
2222 warns about calls to @code{printf} and @code{scanf} functions where the
2223 format string is not a string literal and there are no format arguments,
2224 as in @code{printf (foo);}.  This may be a security hole if the format
2225 string came from untrusted input and contains @samp{%n}.  (This is
2226 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2227 in future warnings may be added to @option{-Wformat-security} that are not
2228 included in @option{-Wformat-nonliteral}.)
2230 @item -Wformat=2
2231 @opindex Wformat=2
2232 Enable @option{-Wformat} plus format checks not included in
2233 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2234 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2236 @item -Wnonnull
2237 @opindex Wnonnull
2238 Warn about passing a null pointer for arguments marked as
2239 requiring a non-null value by the @code{nonnull} function attribute.
2241 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2242 can be disabled with the @option{-Wno-nonnull} option.
2244 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2245 @opindex Winit-self
2246 Warn about uninitialized variables which are initialized with themselves.
2247 Note this option can only be used with the @option{-Wuninitialized} option,
2248 which in turn only works with @option{-O1} and above.
2250 For example, GCC will warn about @code{i} being uninitialized in the
2251 following snippet only when @option{-Winit-self} has been specified:
2252 @smallexample
2253 @group
2254 int f()
2256   int i = i;
2257   return i;
2259 @end group
2260 @end smallexample
2262 @item -Wimplicit-int
2263 @opindex Wimplicit-int
2264 Warn when a declaration does not specify a type.
2266 @item -Wimplicit-function-declaration
2267 @itemx -Werror-implicit-function-declaration
2268 @opindex Wimplicit-function-declaration
2269 @opindex Werror-implicit-function-declaration
2270 Give a warning (or error) whenever a function is used before being
2271 declared.
2273 @item -Wimplicit
2274 @opindex Wimplicit
2275 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2277 @item -Wmain
2278 @opindex Wmain
2279 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2280 function with external linkage, returning int, taking either zero
2281 arguments, two, or three arguments of appropriate types.
2283 @item -Wmissing-braces
2284 @opindex Wmissing-braces
2285 Warn if an aggregate or union initializer is not fully bracketed.  In
2286 the following example, the initializer for @samp{a} is not fully
2287 bracketed, but that for @samp{b} is fully bracketed.
2289 @smallexample
2290 int a[2][2] = @{ 0, 1, 2, 3 @};
2291 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2292 @end smallexample
2294 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2295 @opindex Wmissing-include-dirs
2296 Warn if a user-supplied include directory does not exist.
2298 @item -Wparentheses
2299 @opindex Wparentheses
2300 Warn if parentheses are omitted in certain contexts, such
2301 as when there is an assignment in a context where a truth value
2302 is expected, or when operators are nested whose precedence people
2303 often get confused about.  Only the warning for an assignment used as
2304 a truth value is supported when compiling C++; the other warnings are
2305 only supported when compiling C@.
2307 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2308 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2309 interpretation from that of ordinary mathematical notation.
2311 Also warn about constructions where there may be confusion to which
2312 @code{if} statement an @code{else} branch belongs.  Here is an example of
2313 such a case:
2315 @smallexample
2316 @group
2318   if (a)
2319     if (b)
2320       foo ();
2321   else
2322     bar ();
2324 @end group
2325 @end smallexample
2327 In C, every @code{else} branch belongs to the innermost possible @code{if}
2328 statement, which in this example is @code{if (b)}.  This is often not
2329 what the programmer expected, as illustrated in the above example by
2330 indentation the programmer chose.  When there is the potential for this
2331 confusion, GCC will issue a warning when this flag is specified.
2332 To eliminate the warning, add explicit braces around the innermost
2333 @code{if} statement so there is no way the @code{else} could belong to
2334 the enclosing @code{if}.  The resulting code would look like this:
2336 @smallexample
2337 @group
2339   if (a)
2340     @{
2341       if (b)
2342         foo ();
2343       else
2344         bar ();
2345     @}
2347 @end group
2348 @end smallexample
2350 @item -Wsequence-point
2351 @opindex Wsequence-point
2352 Warn about code that may have undefined semantics because of violations
2353 of sequence point rules in the C standard.
2355 The C standard defines the order in which expressions in a C program are
2356 evaluated in terms of @dfn{sequence points}, which represent a partial
2357 ordering between the execution of parts of the program: those executed
2358 before the sequence point, and those executed after it.  These occur
2359 after the evaluation of a full expression (one which is not part of a
2360 larger expression), after the evaluation of the first operand of a
2361 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2362 function is called (but after the evaluation of its arguments and the
2363 expression denoting the called function), and in certain other places.
2364 Other than as expressed by the sequence point rules, the order of
2365 evaluation of subexpressions of an expression is not specified.  All
2366 these rules describe only a partial order rather than a total order,
2367 since, for example, if two functions are called within one expression
2368 with no sequence point between them, the order in which the functions
2369 are called is not specified.  However, the standards committee have
2370 ruled that function calls do not overlap.
2372 It is not specified when between sequence points modifications to the
2373 values of objects take effect.  Programs whose behavior depends on this
2374 have undefined behavior; the C standard specifies that ``Between the
2375 previous and next sequence point an object shall have its stored value
2376 modified at most once by the evaluation of an expression.  Furthermore,
2377 the prior value shall be read only to determine the value to be
2378 stored.''.  If a program breaks these rules, the results on any
2379 particular implementation are entirely unpredictable.
2381 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2382 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2383 diagnosed by this option, and it may give an occasional false positive
2384 result, but in general it has been found fairly effective at detecting
2385 this sort of problem in programs.
2387 The present implementation of this option only works for C programs.  A
2388 future implementation may also work for C++ programs.
2390 The C standard is worded confusingly, therefore there is some debate
2391 over the precise meaning of the sequence point rules in subtle cases.
2392 Links to discussions of the problem, including proposed formal
2393 definitions, may be found on the GCC readings page, at
2394 @w{@uref{http://gcc.gnu.org/readings.html}}.
2396 @item -Wreturn-type
2397 @opindex Wreturn-type
2398 Warn whenever a function is defined with a return-type that defaults to
2399 @code{int}.  Also warn about any @code{return} statement with no
2400 return-value in a function whose return-type is not @code{void}.
2402 For C, also warn if the return type of a function has a type qualifier
2403 such as @code{const}.  Such a type qualifier has no effect, since the
2404 value returned by a function is not an lvalue.  ISO C prohibits
2405 qualified @code{void} return types on function definitions, so such
2406 return types always receive a warning even without this option.
2408 For C++, a function without return type always produces a diagnostic
2409 message, even when @option{-Wno-return-type} is specified.  The only
2410 exceptions are @samp{main} and functions defined in system headers.
2412 @item -Wswitch
2413 @opindex Wswitch
2414 Warn whenever a @code{switch} statement has an index of enumerated type
2415 and lacks a @code{case} for one or more of the named codes of that
2416 enumeration.  (The presence of a @code{default} label prevents this
2417 warning.)  @code{case} labels outside the enumeration range also
2418 provoke warnings when this option is used.
2420 @item -Wswitch-default
2421 @opindex Wswitch-switch
2422 Warn whenever a @code{switch} statement does not have a @code{default}
2423 case.
2425 @item -Wswitch-enum
2426 @opindex Wswitch-enum
2427 Warn whenever a @code{switch} statement has an index of enumerated type
2428 and lacks a @code{case} for one or more of the named codes of that
2429 enumeration.  @code{case} labels outside the enumeration range also
2430 provoke warnings when this option is used.
2432 @item -Wtrigraphs
2433 @opindex Wtrigraphs
2434 Warn if any trigraphs are encountered that might change the meaning of
2435 the program (trigraphs within comments are not warned about).
2437 @item -Wunused-function
2438 @opindex Wunused-function
2439 Warn whenever a static function is declared but not defined or a
2440 non\-inline static function is unused.
2442 @item -Wunused-label
2443 @opindex Wunused-label
2444 Warn whenever a label is declared but not used.
2446 To suppress this warning use the @samp{unused} attribute
2447 (@pxref{Variable Attributes}).
2449 @item -Wunused-parameter
2450 @opindex Wunused-parameter
2451 Warn whenever a function parameter is unused aside from its declaration.
2453 To suppress this warning use the @samp{unused} attribute
2454 (@pxref{Variable Attributes}).
2456 @item -Wunused-variable
2457 @opindex Wunused-variable
2458 Warn whenever a local variable or non-constant static variable is unused
2459 aside from its declaration
2461 To suppress this warning use the @samp{unused} attribute
2462 (@pxref{Variable Attributes}).
2464 @item -Wunused-value
2465 @opindex Wunused-value
2466 Warn whenever a statement computes a result that is explicitly not used.
2468 To suppress this warning cast the expression to @samp{void}.
2470 @item -Wunused
2471 @opindex Wunused
2472 All the above @option{-Wunused} options combined.
2474 In order to get a warning about an unused function parameter, you must
2475 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2476 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2478 @item -Wuninitialized
2479 @opindex Wuninitialized
2480 Warn if an automatic variable is used without first being initialized or
2481 if a variable may be clobbered by a @code{setjmp} call.
2483 These warnings are possible only in optimizing compilation,
2484 because they require data flow information that is computed only
2485 when optimizing.  If you don't specify @option{-O}, you simply won't
2486 get these warnings.
2488 If you want to warn about code which uses the uninitialized value of the
2489 variable in its own initializer, use the @option{-Winit-self} option.
2491 These warnings occur only for variables that are candidates for
2492 register allocation.  Therefore, they do not occur for a variable that
2493 is declared @code{volatile}, or whose address is taken, or whose size
2494 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2495 structures, unions or arrays, even when they are in registers.
2497 Note that there may be no warning about a variable that is used only
2498 to compute a value that itself is never used, because such
2499 computations may be deleted by data flow analysis before the warnings
2500 are printed.
2502 These warnings are made optional because GCC is not smart
2503 enough to see all the reasons why the code might be correct
2504 despite appearing to have an error.  Here is one example of how
2505 this can happen:
2507 @smallexample
2508 @group
2510   int x;
2511   switch (y)
2512     @{
2513     case 1: x = 1;
2514       break;
2515     case 2: x = 4;
2516       break;
2517     case 3: x = 5;
2518     @}
2519   foo (x);
2521 @end group
2522 @end smallexample
2524 @noindent
2525 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2526 always initialized, but GCC doesn't know this.  Here is
2527 another common case:
2529 @smallexample
2531   int save_y;
2532   if (change_y) save_y = y, y = new_y;
2533   @dots{}
2534   if (change_y) y = save_y;
2536 @end smallexample
2538 @noindent
2539 This has no bug because @code{save_y} is used only if it is set.
2541 @cindex @code{longjmp} warnings
2542 This option also warns when a non-volatile automatic variable might be
2543 changed by a call to @code{longjmp}.  These warnings as well are possible
2544 only in optimizing compilation.
2546 The compiler sees only the calls to @code{setjmp}.  It cannot know
2547 where @code{longjmp} will be called; in fact, a signal handler could
2548 call it at any point in the code.  As a result, you may get a warning
2549 even when there is in fact no problem because @code{longjmp} cannot
2550 in fact be called at the place which would cause a problem.
2552 Some spurious warnings can be avoided if you declare all the functions
2553 you use that never return as @code{noreturn}.  @xref{Function
2554 Attributes}.
2556 @item -Wunknown-pragmas
2557 @opindex Wunknown-pragmas
2558 @cindex warning for unknown pragmas
2559 @cindex unknown pragmas, warning
2560 @cindex pragmas, warning of unknown
2561 Warn when a #pragma directive is encountered which is not understood by
2562 GCC@.  If this command line option is used, warnings will even be issued
2563 for unknown pragmas in system header files.  This is not the case if
2564 the warnings were only enabled by the @option{-Wall} command line option.
2566 @item -Wstrict-aliasing
2567 @opindex Wstrict-aliasing
2568 This option is only active when @option{-fstrict-aliasing} is active.
2569 It warns about code which might break the strict aliasing rules that the
2570 compiler is using for optimization. The warning does not catch all
2571 cases, but does attempt to catch the more common pitfalls. It is
2572 included in @option{-Wall}.
2574 @item -Wstrict-aliasing=2
2575 @opindex Wstrict-aliasing=2
2576 This option is only active when @option{-fstrict-aliasing} is active.
2577 It warns about all code which might break the strict aliasing rules that the
2578 compiler is using for optimization.  This warning catches all cases, but
2579 it will also give a warning for some ambiguous cases that are safe.
2581 @item -Wall
2582 @opindex Wall
2583 All of the above @samp{-W} options combined.  This enables all the
2584 warnings about constructions that some users consider questionable, and
2585 that are easy to avoid (or modify to prevent the warning), even in
2586 conjunction with macros.  This also enables some language-specific
2587 warnings described in @ref{C++ Dialect Options} and
2588 @ref{Objective-C and Objective-C++ Dialect Options}.
2589 @end table
2591 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2592 Some of them warn about constructions that users generally do not
2593 consider questionable, but which occasionally you might wish to check
2594 for; others warn about constructions that are necessary or hard to avoid
2595 in some cases, and there is no simple way to modify the code to suppress
2596 the warning.
2598 @table @gcctabopt
2599 @item -Wextra
2600 @opindex W
2601 @opindex Wextra
2602 (This option used to be called @option{-W}.  The older name is still
2603 supported, but the newer name is more descriptive.)  Print extra warning
2604 messages for these events:
2606 @itemize @bullet
2607 @item
2608 A function can return either with or without a value.  (Falling
2609 off the end of the function body is considered returning without
2610 a value.)  For example, this function would evoke such a
2611 warning:
2613 @smallexample
2614 @group
2615 foo (a)
2617   if (a > 0)
2618     return a;
2620 @end group
2621 @end smallexample
2623 @item
2624 An expression-statement or the left-hand side of a comma expression
2625 contains no side effects.
2626 To suppress the warning, cast the unused expression to void.
2627 For example, an expression such as @samp{x[i,j]} will cause a warning,
2628 but @samp{x[(void)i,j]} will not.
2630 @item
2631 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2633 @item
2634 Storage-class specifiers like @code{static} are not the first things in
2635 a declaration.  According to the C Standard, this usage is obsolescent.
2637 @item
2638 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2639 arguments.
2641 @item
2642 A comparison between signed and unsigned values could produce an
2643 incorrect result when the signed value is converted to unsigned.
2644 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2646 @item
2647 An aggregate has an initializer which does not initialize all members.
2648 This warning can be independently controlled by
2649 @option{-Wmissing-field-initializers}.
2651 @item
2652 A function parameter is declared without a type specifier in K&R-style
2653 functions:
2655 @smallexample
2656 void foo(bar) @{ @}
2657 @end smallexample
2659 @item
2660 An empty body occurs in an @samp{if} or @samp{else} statement.
2662 @item
2663 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2664 @samp{>}, or @samp{>=}.
2666 @item
2667 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2669 @item
2670 Any of several floating-point events that often indicate errors, such as
2671 overflow, underflow, loss of precision, etc.
2673 @item @r{(C++ only)}
2674 An enumerator and a non-enumerator both appear in a conditional expression.
2676 @item @r{(C++ only)}
2677 A non-static reference or non-static @samp{const} member appears in a
2678 class without constructors.
2680 @item @r{(C++ only)}
2681 Ambiguous virtual bases.
2683 @item @r{(C++ only)}
2684 Subscripting an array which has been declared @samp{register}.
2686 @item @r{(C++ only)}
2687 Taking the address of a variable which has been declared @samp{register}.
2689 @item @r{(C++ only)}
2690 A base class is not initialized in a derived class' copy constructor.
2691 @end itemize
2693 @item -Wno-div-by-zero
2694 @opindex Wno-div-by-zero
2695 @opindex Wdiv-by-zero
2696 Do not warn about compile-time integer division by zero.  Floating point
2697 division by zero is not warned about, as it can be a legitimate way of
2698 obtaining infinities and NaNs.
2700 @item -Wsystem-headers
2701 @opindex Wsystem-headers
2702 @cindex warnings from system headers
2703 @cindex system headers, warnings from
2704 Print warning messages for constructs found in system header files.
2705 Warnings from system headers are normally suppressed, on the assumption
2706 that they usually do not indicate real problems and would only make the
2707 compiler output harder to read.  Using this command line option tells
2708 GCC to emit warnings from system headers as if they occurred in user
2709 code.  However, note that using @option{-Wall} in conjunction with this
2710 option will @emph{not} warn about unknown pragmas in system
2711 headers---for that, @option{-Wunknown-pragmas} must also be used.
2713 @item -Wfloat-equal
2714 @opindex Wfloat-equal
2715 Warn if floating point values are used in equality comparisons.
2717 The idea behind this is that sometimes it is convenient (for the
2718 programmer) to consider floating-point values as approximations to
2719 infinitely precise real numbers.  If you are doing this, then you need
2720 to compute (by analyzing the code, or in some other way) the maximum or
2721 likely maximum error that the computation introduces, and allow for it
2722 when performing comparisons (and when producing output, but that's a
2723 different problem).  In particular, instead of testing for equality, you
2724 would check to see whether the two values have ranges that overlap; and
2725 this is done with the relational operators, so equality comparisons are
2726 probably mistaken.
2728 @item -Wtraditional @r{(C only)}
2729 @opindex Wtraditional
2730 Warn about certain constructs that behave differently in traditional and
2731 ISO C@.  Also warn about ISO C constructs that have no traditional C
2732 equivalent, and/or problematic constructs which should be avoided.
2734 @itemize @bullet
2735 @item
2736 Macro parameters that appear within string literals in the macro body.
2737 In traditional C macro replacement takes place within string literals,
2738 but does not in ISO C@.
2740 @item
2741 In traditional C, some preprocessor directives did not exist.
2742 Traditional preprocessors would only consider a line to be a directive
2743 if the @samp{#} appeared in column 1 on the line.  Therefore
2744 @option{-Wtraditional} warns about directives that traditional C
2745 understands but would ignore because the @samp{#} does not appear as the
2746 first character on the line.  It also suggests you hide directives like
2747 @samp{#pragma} not understood by traditional C by indenting them.  Some
2748 traditional implementations would not recognize @samp{#elif}, so it
2749 suggests avoiding it altogether.
2751 @item
2752 A function-like macro that appears without arguments.
2754 @item
2755 The unary plus operator.
2757 @item
2758 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2759 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2760 constants.)  Note, these suffixes appear in macros defined in the system
2761 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2762 Use of these macros in user code might normally lead to spurious
2763 warnings, however GCC's integrated preprocessor has enough context to
2764 avoid warning in these cases.
2766 @item
2767 A function declared external in one block and then used after the end of
2768 the block.
2770 @item
2771 A @code{switch} statement has an operand of type @code{long}.
2773 @item
2774 A non-@code{static} function declaration follows a @code{static} one.
2775 This construct is not accepted by some traditional C compilers.
2777 @item
2778 The ISO type of an integer constant has a different width or
2779 signedness from its traditional type.  This warning is only issued if
2780 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2781 typically represent bit patterns, are not warned about.
2783 @item
2784 Usage of ISO string concatenation is detected.
2786 @item
2787 Initialization of automatic aggregates.
2789 @item
2790 Identifier conflicts with labels.  Traditional C lacks a separate
2791 namespace for labels.
2793 @item
2794 Initialization of unions.  If the initializer is zero, the warning is
2795 omitted.  This is done under the assumption that the zero initializer in
2796 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2797 initializer warnings and relies on default initialization to zero in the
2798 traditional C case.
2800 @item
2801 Conversions by prototypes between fixed/floating point values and vice
2802 versa.  The absence of these prototypes when compiling with traditional
2803 C would cause serious problems.  This is a subset of the possible
2804 conversion warnings, for the full set use @option{-Wconversion}.
2806 @item
2807 Use of ISO C style function definitions.  This warning intentionally is
2808 @emph{not} issued for prototype declarations or variadic functions
2809 because these ISO C features will appear in your code when using
2810 libiberty's traditional C compatibility macros, @code{PARAMS} and
2811 @code{VPARAMS}.  This warning is also bypassed for nested functions
2812 because that feature is already a GCC extension and thus not relevant to
2813 traditional C compatibility.
2814 @end itemize
2816 @item -Wdeclaration-after-statement @r{(C only)}
2817 @opindex Wdeclaration-after-statement
2818 Warn when a declaration is found after a statement in a block.  This
2819 construct, known from C++, was introduced with ISO C99 and is by default
2820 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2821 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2823 @item -Wundef
2824 @opindex Wundef
2825 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2827 @item -Wendif-labels
2828 @opindex Wendif-labels
2829 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2831 @item -Wshadow
2832 @opindex Wshadow
2833 Warn whenever a local variable shadows another local variable, parameter or
2834 global variable or whenever a built-in function is shadowed.
2836 @item -Wlarger-than-@var{len}
2837 @opindex Wlarger-than
2838 Warn whenever an object of larger than @var{len} bytes is defined.
2840 @item -Wpointer-arith
2841 @opindex Wpointer-arith
2842 Warn about anything that depends on the ``size of'' a function type or
2843 of @code{void}.  GNU C assigns these types a size of 1, for
2844 convenience in calculations with @code{void *} pointers and pointers
2845 to functions.
2847 @item -Wbad-function-cast @r{(C only)}
2848 @opindex Wbad-function-cast
2849 Warn whenever a function call is cast to a non-matching type.
2850 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2852 @item -Wcast-qual
2853 @opindex Wcast-qual
2854 Warn whenever a pointer is cast so as to remove a type qualifier from
2855 the target type.  For example, warn if a @code{const char *} is cast
2856 to an ordinary @code{char *}.
2858 @item -Wcast-align
2859 @opindex Wcast-align
2860 Warn whenever a pointer is cast such that the required alignment of the
2861 target is increased.  For example, warn if a @code{char *} is cast to
2862 an @code{int *} on machines where integers can only be accessed at
2863 two- or four-byte boundaries.
2865 @item -Wwrite-strings
2866 @opindex Wwrite-strings
2867 When compiling C, give string constants the type @code{const
2868 char[@var{length}]} so that
2869 copying the address of one into a non-@code{const} @code{char *}
2870 pointer will get a warning; when compiling C++, warn about the
2871 deprecated conversion from string constants to @code{char *}.
2872 These warnings will help you find at
2873 compile time code that can try to write into a string constant, but
2874 only if you have been very careful about using @code{const} in
2875 declarations and prototypes.  Otherwise, it will just be a nuisance;
2876 this is why we did not make @option{-Wall} request these warnings.
2878 @item -Wconversion
2879 @opindex Wconversion
2880 Warn if a prototype causes a type conversion that is different from what
2881 would happen to the same argument in the absence of a prototype.  This
2882 includes conversions of fixed point to floating and vice versa, and
2883 conversions changing the width or signedness of a fixed point argument
2884 except when the same as the default promotion.
2886 Also, warn if a negative integer constant expression is implicitly
2887 converted to an unsigned type.  For example, warn about the assignment
2888 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2889 casts like @code{(unsigned) -1}.
2891 @item -Wsign-compare
2892 @opindex Wsign-compare
2893 @cindex warning for comparison of signed and unsigned values
2894 @cindex comparison of signed and unsigned values, warning
2895 @cindex signed and unsigned values, comparison warning
2896 Warn when a comparison between signed and unsigned values could produce
2897 an incorrect result when the signed value is converted to unsigned.
2898 This warning is also enabled by @option{-Wextra}; to get the other warnings
2899 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2901 @item -Waggregate-return
2902 @opindex Waggregate-return
2903 Warn if any functions that return structures or unions are defined or
2904 called.  (In languages where you can return an array, this also elicits
2905 a warning.)
2907 @item -Wstrict-prototypes @r{(C only)}
2908 @opindex Wstrict-prototypes
2909 Warn if a function is declared or defined without specifying the
2910 argument types.  (An old-style function definition is permitted without
2911 a warning if preceded by a declaration which specifies the argument
2912 types.)
2914 @item -Wold-style-definition @r{(C only)}
2915 @opindex Wold-style-definition
2916 Warn if an old-style function definition is used.  A warning is given
2917 even if there is a previous prototype.
2919 @item -Wmissing-prototypes @r{(C only)}
2920 @opindex Wmissing-prototypes
2921 Warn if a global function is defined without a previous prototype
2922 declaration.  This warning is issued even if the definition itself
2923 provides a prototype.  The aim is to detect global functions that fail
2924 to be declared in header files.
2926 @item -Wmissing-declarations @r{(C only)}
2927 @opindex Wmissing-declarations
2928 Warn if a global function is defined without a previous declaration.
2929 Do so even if the definition itself provides a prototype.
2930 Use this option to detect global functions that are not declared in
2931 header files.
2933 @item -Wmissing-field-initializers
2934 @opindex Wmissing-field-initializers
2935 @opindex W
2936 @opindex Wextra
2937 Warn if a structure's initializer has some fields missing.  For
2938 example, the following code would cause such a warning, because
2939 @code{x.h} is implicitly zero:
2941 @smallexample
2942 struct s @{ int f, g, h; @};
2943 struct s x = @{ 3, 4 @};
2944 @end smallexample
2946 This option does not warn about designated initializers, so the following
2947 modification would not trigger a warning:
2949 @smallexample
2950 struct s @{ int f, g, h; @};
2951 struct s x = @{ .f = 3, .g = 4 @};
2952 @end smallexample
2954 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
2955 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
2957 @item -Wmissing-noreturn
2958 @opindex Wmissing-noreturn
2959 Warn about functions which might be candidates for attribute @code{noreturn}.
2960 Note these are only possible candidates, not absolute ones.  Care should
2961 be taken to manually verify functions actually do not ever return before
2962 adding the @code{noreturn} attribute, otherwise subtle code generation
2963 bugs could be introduced.  You will not get a warning for @code{main} in
2964 hosted C environments.
2966 @item -Wmissing-format-attribute
2967 @opindex Wmissing-format-attribute
2968 @opindex Wformat
2969 If @option{-Wformat} is enabled, also warn about functions which might be
2970 candidates for @code{format} attributes.  Note these are only possible
2971 candidates, not absolute ones.  GCC will guess that @code{format}
2972 attributes might be appropriate for any function that calls a function
2973 like @code{vprintf} or @code{vscanf}, but this might not always be the
2974 case, and some functions for which @code{format} attributes are
2975 appropriate may not be detected.  This option has no effect unless
2976 @option{-Wformat} is enabled (possibly by @option{-Wall}).
2978 @item -Wno-multichar
2979 @opindex Wno-multichar
2980 @opindex Wmultichar
2981 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
2982 Usually they indicate a typo in the user's code, as they have
2983 implementation-defined values, and should not be used in portable code.
2985 @item -Wno-deprecated-declarations
2986 @opindex Wno-deprecated-declarations
2987 Do not warn about uses of functions, variables, and types marked as
2988 deprecated by using the @code{deprecated} attribute.
2989 (@pxref{Function Attributes}, @pxref{Variable Attributes},
2990 @pxref{Type Attributes}.)
2992 @item -Wpacked
2993 @opindex Wpacked
2994 Warn if a structure is given the packed attribute, but the packed
2995 attribute has no effect on the layout or size of the structure.
2996 Such structures may be mis-aligned for little benefit.  For
2997 instance, in this code, the variable @code{f.x} in @code{struct bar}
2998 will be misaligned even though @code{struct bar} does not itself
2999 have the packed attribute:
3001 @smallexample
3002 @group
3003 struct foo @{
3004   int x;
3005   char a, b, c, d;
3006 @} __attribute__((packed));
3007 struct bar @{
3008   char z;
3009   struct foo f;
3011 @end group
3012 @end smallexample
3014 @item -Wpadded
3015 @opindex Wpadded
3016 Warn if padding is included in a structure, either to align an element
3017 of the structure or to align the whole structure.  Sometimes when this
3018 happens it is possible to rearrange the fields of the structure to
3019 reduce the padding and so make the structure smaller.
3021 @item -Wredundant-decls
3022 @opindex Wredundant-decls
3023 Warn if anything is declared more than once in the same scope, even in
3024 cases where multiple declaration is valid and changes nothing.
3026 @item -Wnested-externs @r{(C only)}
3027 @opindex Wnested-externs
3028 Warn if an @code{extern} declaration is encountered within a function.
3030 @item -Wunreachable-code
3031 @opindex Wunreachable-code
3032 Warn if the compiler detects that code will never be executed.
3034 This option is intended to warn when the compiler detects that at
3035 least a whole line of source code will never be executed, because
3036 some condition is never satisfied or because it is after a
3037 procedure that never returns.
3039 It is possible for this option to produce a warning even though there
3040 are circumstances under which part of the affected line can be executed,
3041 so care should be taken when removing apparently-unreachable code.
3043 For instance, when a function is inlined, a warning may mean that the
3044 line is unreachable in only one inlined copy of the function.
3046 This option is not made part of @option{-Wall} because in a debugging
3047 version of a program there is often substantial code which checks
3048 correct functioning of the program and is, hopefully, unreachable
3049 because the program does work.  Another common use of unreachable
3050 code is to provide behavior which is selectable at compile-time.
3052 @item -Winline
3053 @opindex Winline
3054 Warn if a function can not be inlined and it was declared as inline.
3055 Even with this option, the compiler will not warn about failures to
3056 inline functions declared in system headers.
3058 The compiler uses a variety of heuristics to determine whether or not
3059 to inline a function.  For example, the compiler takes into account
3060 the size of the function being inlined and the the amount of inlining
3061 that has already been done in the current function.  Therefore,
3062 seemingly insignificant changes in the source program can cause the
3063 warnings produced by @option{-Winline} to appear or disappear.
3065 @item -Wno-invalid-offsetof @r{(C++ only)}
3066 @opindex Wno-invalid-offsetof
3067 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3068 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3069 to a non-POD type is undefined.  In existing C++ implementations,
3070 however, @samp{offsetof} typically gives meaningful results even when
3071 applied to certain kinds of non-POD types. (Such as a simple
3072 @samp{struct} that fails to be a POD type only by virtue of having a
3073 constructor.)  This flag is for users who are aware that they are
3074 writing nonportable code and who have deliberately chosen to ignore the
3075 warning about it.
3077 The restrictions on @samp{offsetof} may be relaxed in a future version
3078 of the C++ standard.
3080 @item -Winvalid-pch
3081 @opindex Winvalid-pch
3082 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3083 the search path but can't be used.
3085 @item -Wlong-long
3086 @opindex Wlong-long
3087 @opindex Wno-long-long
3088 Warn if @samp{long long} type is used.  This is default.  To inhibit
3089 the warning messages, use @option{-Wno-long-long}.  Flags
3090 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3091 only when @option{-pedantic} flag is used.
3093 @item -Wvariadic-macros
3094 @opindex Wvariadic-macros
3095 @opindex Wno-variadic-macros
3096 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3097 alternate syntax when in pedantic ISO C99 mode.  This is default.
3098 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3100 @item -Wdisabled-optimization
3101 @opindex Wdisabled-optimization
3102 Warn if a requested optimization pass is disabled.  This warning does
3103 not generally indicate that there is anything wrong with your code; it
3104 merely indicates that GCC's optimizers were unable to handle the code
3105 effectively.  Often, the problem is that your code is too big or too
3106 complex; GCC will refuse to optimize programs when the optimization
3107 itself is likely to take inordinate amounts of time.
3109 @item -Werror
3110 @opindex Werror
3111 Make all warnings into errors.
3112 @end table
3114 @node Debugging Options
3115 @section Options for Debugging Your Program or GCC
3116 @cindex options, debugging
3117 @cindex debugging information options
3119 GCC has various special options that are used for debugging
3120 either your program or GCC:
3122 @table @gcctabopt
3123 @item -g
3124 @opindex g
3125 Produce debugging information in the operating system's native format
3126 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3127 information.
3129 On most systems that use stabs format, @option{-g} enables use of extra
3130 debugging information that only GDB can use; this extra information
3131 makes debugging work better in GDB but will probably make other debuggers
3132 crash or
3133 refuse to read the program.  If you want to control for certain whether
3134 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3135 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3137 GCC allows you to use @option{-g} with
3138 @option{-O}.  The shortcuts taken by optimized code may occasionally
3139 produce surprising results: some variables you declared may not exist
3140 at all; flow of control may briefly move where you did not expect it;
3141 some statements may not be executed because they compute constant
3142 results or their values were already at hand; some statements may
3143 execute in different places because they were moved out of loops.
3145 Nevertheless it proves possible to debug optimized output.  This makes
3146 it reasonable to use the optimizer for programs that might have bugs.
3148 The following options are useful when GCC is generated with the
3149 capability for more than one debugging format.
3151 @item -ggdb
3152 @opindex ggdb
3153 Produce debugging information for use by GDB@.  This means to use the
3154 most expressive format available (DWARF 2, stabs, or the native format
3155 if neither of those are supported), including GDB extensions if at all
3156 possible.
3158 @item -gstabs
3159 @opindex gstabs
3160 Produce debugging information in stabs format (if that is supported),
3161 without GDB extensions.  This is the format used by DBX on most BSD
3162 systems.  On MIPS, Alpha and System V Release 4 systems this option
3163 produces stabs debugging output which is not understood by DBX or SDB@.
3164 On System V Release 4 systems this option requires the GNU assembler.
3166 @item -feliminate-unused-debug-symbols
3167 @opindex feliminate-unused-debug-symbols
3168 Produce debugging information in stabs format (if that is supported),
3169 for only symbols that are actually used.
3171 @item -gstabs+
3172 @opindex gstabs+
3173 Produce debugging information in stabs format (if that is supported),
3174 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3175 use of these extensions is likely to make other debuggers crash or
3176 refuse to read the program.
3178 @item -gcoff
3179 @opindex gcoff
3180 Produce debugging information in COFF format (if that is supported).
3181 This is the format used by SDB on most System V systems prior to
3182 System V Release 4.
3184 @item -gxcoff
3185 @opindex gxcoff
3186 Produce debugging information in XCOFF format (if that is supported).
3187 This is the format used by the DBX debugger on IBM RS/6000 systems.
3189 @item -gxcoff+
3190 @opindex gxcoff+
3191 Produce debugging information in XCOFF format (if that is supported),
3192 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3193 use of these extensions is likely to make other debuggers crash or
3194 refuse to read the program, and may cause assemblers other than the GNU
3195 assembler (GAS) to fail with an error.
3197 @item -gdwarf-2
3198 @opindex gdwarf-2
3199 Produce debugging information in DWARF version 2 format (if that is
3200 supported).  This is the format used by DBX on IRIX 6.  With this
3201 option, GCC uses features of DWARF version 3 when they are useful;
3202 version 3 is upward compatible with version 2, but may still cause
3203 problems for older debuggers.
3205 @item -gvms
3206 @opindex gvms
3207 Produce debugging information in VMS debug format (if that is
3208 supported).  This is the format used by DEBUG on VMS systems.
3210 @item -g@var{level}
3211 @itemx -ggdb@var{level}
3212 @itemx -gstabs@var{level}
3213 @itemx -gcoff@var{level}
3214 @itemx -gxcoff@var{level}
3215 @itemx -gvms@var{level}
3216 Request debugging information and also use @var{level} to specify how
3217 much information.  The default level is 2.
3219 Level 1 produces minimal information, enough for making backtraces in
3220 parts of the program that you don't plan to debug.  This includes
3221 descriptions of functions and external variables, but no information
3222 about local variables and no line numbers.
3224 Level 3 includes extra information, such as all the macro definitions
3225 present in the program.  Some debuggers support macro expansion when
3226 you use @option{-g3}.
3228 @option{-gdwarf-2} does not accept a concatenated debug level, because
3229 GCC used to support an option @option{-gdwarf} that meant to generate
3230 debug information in version 1 of the DWARF format (which is very
3231 different from version 2), and it would have been too confusing.  That
3232 debug format is long obsolete, but the option cannot be changed now.
3233 Instead use an additional @option{-g@var{level}} option to change the
3234 debug level for DWARF2.
3236 @item -feliminate-dwarf2-dups
3237 @opindex feliminate-dwarf2-dups
3238 Compress DWARF2 debugging information by eliminating duplicated
3239 information about each symbol.  This option only makes sense when
3240 generating DWARF2 debugging information with @option{-gdwarf-2}.
3242 @cindex @command{prof}
3243 @item -p
3244 @opindex p
3245 Generate extra code to write profile information suitable for the
3246 analysis program @command{prof}.  You must use this option when compiling
3247 the source files you want data about, and you must also use it when
3248 linking.
3250 @cindex @command{gprof}
3251 @item -pg
3252 @opindex pg
3253 Generate extra code to write profile information suitable for the
3254 analysis program @command{gprof}.  You must use this option when compiling
3255 the source files you want data about, and you must also use it when
3256 linking.
3258 @item -Q
3259 @opindex Q
3260 Makes the compiler print out each function name as it is compiled, and
3261 print some statistics about each pass when it finishes.
3263 @item -ftime-report
3264 @opindex ftime-report
3265 Makes the compiler print some statistics about the time consumed by each
3266 pass when it finishes.
3268 @item -fmem-report
3269 @opindex fmem-report
3270 Makes the compiler print some statistics about permanent memory
3271 allocation when it finishes.
3273 @item -fprofile-arcs
3274 @opindex fprofile-arcs
3275 Add code so that program flow @dfn{arcs} are instrumented.  During
3276 execution the program records how many times each branch and call is
3277 executed and how many times it is taken or returns.  When the compiled
3278 program exits it saves this data to a file called
3279 @file{@var{auxname}.gcda} for each source file. The data may be used for
3280 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3281 test coverage analysis (@option{-ftest-coverage}). Each object file's
3282 @var{auxname} is generated from the name of the output file, if
3283 explicitly specified and it is not the final executable, otherwise it is
3284 the basename of the source file. In both cases any suffix is removed
3285 (e.g.  @file{foo.gcda} for input file @file{dir/foo.c}, or
3286 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3288 @itemize
3290 @item
3291 Compile the source files with @option{-fprofile-arcs} plus optimization
3292 and code generation options. For test coverage analysis, use the
3293 additional @option{-ftest-coverage} option. You do not need to profile
3294 every source file in a program.
3296 @item
3297 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3298 (the latter implies the former).
3300 @item
3301 Run the program on a representative workload to generate the arc profile
3302 information. This may be repeated any number of times. You can run
3303 concurrent instances of your program, and provided that the file system
3304 supports locking, the data files will be correctly updated. Also
3305 @code{fork} calls are detected and correctly handled (double counting
3306 will not happen).
3308 @item
3309 For profile-directed optimizations, compile the source files again with
3310 the same optimization and code generation options plus
3311 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3312 Control Optimization}).
3314 @item
3315 For test coverage analysis, use @command{gcov} to produce human readable
3316 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3317 @command{gcov} documentation for further information.
3319 @end itemize
3321 With @option{-fprofile-arcs}, for each function of your program GCC
3322 creates a program flow graph, then finds a spanning tree for the graph.
3323 Only arcs that are not on the spanning tree have to be instrumented: the
3324 compiler adds code to count the number of times that these arcs are
3325 executed.  When an arc is the only exit or only entrance to a block, the
3326 instrumentation code can be added to the block; otherwise, a new basic
3327 block must be created to hold the instrumentation code.
3329 @item -ftree-based-profiling
3330 @opindex ftree-based-profiling
3331 This option is used in addition to @option{-fprofile-arcs} or
3332 @option{-fbranch-probabilities} to control whether those optimizations
3333 are performed on a tree-based or rtl-based internal representation.
3334 If you use this option when compiling with @option{-fprofile-arcs},
3335 you must also use it when compiling later with @option{-fbranch-probabilities}.
3336 Currently the tree-based optimization is in an early stage of
3337 development, and this option is recommended only for those people
3338 working on improving it.
3340 @need 2000
3341 @item -ftest-coverage
3342 @opindex ftest-coverage
3343 Produce a notes file that the @command{gcov} code-coverage utility
3344 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3345 show program coverage. Each source file's note file is called
3346 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3347 above for a description of @var{auxname} and instructions on how to
3348 generate test coverage data. Coverage data will match the source files
3349 more closely, if you do not optimize.
3351 @item -d@var{letters}
3352 @opindex d
3353 Says to make debugging dumps during compilation at times specified by
3354 @var{letters}.  This is used for debugging the compiler.  The file names
3355 for most of the dumps are made by appending a pass number and a word to
3356 the @var{dumpname}. @var{dumpname} is generated from the name of the
3357 output file, if explicitly specified and it is not an executable,
3358 otherwise it is the basename of the source file. In both cases any
3359 suffix is removed (e.g.  @file{foo.01.rtl} or @file{foo.02.sibling}).
3360 Here are the possible letters for use in @var{letters}, and their
3361 meanings:
3363 @table @samp
3364 @item A
3365 @opindex dA
3366 Annotate the assembler output with miscellaneous debugging information.
3367 @item b
3368 @opindex db
3369 Dump after computing branch probabilities, to @file{@var{file}.12.bp}.
3370 @item B
3371 @opindex dB
3372 Dump after block reordering, to @file{@var{file}.32.bbro}.
3373 @item c
3374 @opindex dc
3375 Dump after instruction combination, to the file @file{@var{file}.20.combine}.
3376 @item C
3377 @opindex dC
3378 Dump after the first if conversion, to the file @file{@var{file}.14.ce1}.
3379 Also dump after the second if conversion, to the file @file{@var{file}.21.ce2}.
3380 @item d
3381 @opindex dd
3382 Dump after branch target load optimization, to to @file{@var{file}.33.btl}.
3383 Also dump after delayed branch scheduling, to @file{@var{file}.37.dbr}.
3384 @item D
3385 @opindex dD
3386 Dump all macro definitions, at the end of preprocessing, in addition to
3387 normal output.
3388 @item E
3389 @opindex dE
3390 Dump after the third if conversion, to @file{@var{file}.31.ce3}.
3391 @item f
3392 @opindex df
3393 Dump after control and data flow analysis, to @file{@var{file}.11.cfg}.
3394 Also dump after life analysis, to @file{@var{file}.19.life}.
3395 @item g
3396 @opindex dg
3397 Dump after global register allocation, to @file{@var{file}.26.greg}.
3398 @item G
3399 @opindex dG
3400 Dump after GCSE, to @file{@var{file}.08.gcse}.
3401 Also dump after jump bypassing and control flow optimizations, to
3402 @file{@var{file}.10.bypass}.
3403 @item h
3404 @opindex dh
3405 Dump after finalization of EH handling code, to @file{@var{file}.03.eh}.
3406 @item i
3407 @opindex di
3408 Dump after sibling call optimizations, to @file{@var{file}.02.sibling}.
3409 @item j
3410 @opindex dj
3411 Dump after the first jump optimization, to @file{@var{file}.04.jump}.
3412 @item k
3413 @opindex dk
3414 Dump after conversion from registers to stack, to @file{@var{file}.35.stack}.
3415 @item l
3416 @opindex dl
3417 Dump after local register allocation, to @file{@var{file}.25.lreg}.
3418 @item L
3419 @opindex dL
3420 Dump after loop optimization passes, to @file{@var{file}.09.loop} and
3421 @file{@var{file}.16.loop2}.
3422 @item m
3423 @opindex dm
3424 Dump after modulo scheduling, to @file{@var{file}.23.sms}.
3425 @item M
3426 @opindex dM
3427 Dump after performing the machine dependent reorganization pass, to
3428 @file{@var{file}.36.mach}.
3429 @item n
3430 @opindex dn
3431 Dump after register renumbering, to @file{@var{file}.30.rnreg}.
3432 @item N
3433 @opindex dN
3434 Dump after the register move pass, to @file{@var{file}.22.regmove}.
3435 @item o
3436 @opindex do
3437 Dump after post-reload optimizations, to @file{@var{file}.27.postreload}.
3438 @item r
3439 @opindex dr
3440 Dump after RTL generation, to @file{@var{file}.01.rtl}.
3441 @item R
3442 @opindex dR
3443 Dump after the second scheduling pass, to @file{@var{file}.34.sched2}.
3444 @item s
3445 @opindex ds
3446 Dump after CSE (including the jump optimization that sometimes follows
3447 CSE), to @file{@var{file}.06.cse}.
3448 @item S
3449 @opindex dS
3450 Dump after the first scheduling pass, to @file{@var{file}.24.sched}.
3451 @item t
3452 @opindex dt
3453 Dump after the second CSE pass (including the jump optimization that
3454 sometimes follows CSE), to @file{@var{file}.18.cse2}.
3455 @item T
3456 @opindex dT
3457 Dump after running tracer, to @file{@var{file}.15.tracer}.
3458 @item u
3459 @opindex du
3460 Dump after null pointer elimination pass to @file{@var{file}.05.null}.
3461 @item U
3462 @opindex dU
3463 Dump callgraph and unit-at-a-time optimization @file{@var{file}.00.unit}.
3464 @item V
3465 @opindex dV
3466 Dump after the value profile transformations, to @file{@var{file}.13.vpt}.
3467 Also dump after variable tracking, to @file{@var{file}.35.vartrack}.
3468 @item w
3469 @opindex dw
3470 Dump after the second flow pass, to @file{@var{file}.28.flow2}.
3471 @item z
3472 @opindex dz
3473 Dump after the peephole pass, to @file{@var{file}.29.peephole2}.
3474 @item Z
3475 @opindex dZ
3476 Dump after constructing the web, to @file{@var{file}.17.web}.
3477 @item a
3478 @opindex da
3479 Produce all the dumps listed above.
3480 @item H
3481 @opindex dH
3482 Produce a core dump whenever an error occurs.
3483 @item m
3484 @opindex dm
3485 Print statistics on memory usage, at the end of the run, to
3486 standard error.
3487 @item p
3488 @opindex dp
3489 Annotate the assembler output with a comment indicating which
3490 pattern and alternative was used.  The length of each instruction is
3491 also printed.
3492 @item P
3493 @opindex dP
3494 Dump the RTL in the assembler output as a comment before each instruction.
3495 Also turns on @option{-dp} annotation.
3496 @item v
3497 @opindex dv
3498 For each of the other indicated dump files (except for
3499 @file{@var{file}.01.rtl}), dump a representation of the control flow graph
3500 suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3501 @item x
3502 @opindex dx
3503 Just generate RTL for a function instead of compiling it.  Usually used
3504 with @samp{r}.
3505 @item y
3506 @opindex dy
3507 Dump debugging information during parsing, to standard error.
3508 @end table
3510 @item -fdump-unnumbered
3511 @opindex fdump-unnumbered
3512 When doing debugging dumps (see @option{-d} option above), suppress instruction
3513 numbers and line number note output.  This makes it more feasible to
3514 use diff on debugging dumps for compiler invocations with different
3515 options, in particular with and without @option{-g}.
3517 @item -fdump-translation-unit @r{(C and C++ only)}
3518 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3519 @opindex fdump-translation-unit
3520 Dump a representation of the tree structure for the entire translation
3521 unit to a file.  The file name is made by appending @file{.tu} to the
3522 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3523 controls the details of the dump as described for the
3524 @option{-fdump-tree} options.
3526 @item -fdump-class-hierarchy @r{(C++ only)}
3527 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3528 @opindex fdump-class-hierarchy
3529 Dump a representation of each class's hierarchy and virtual function
3530 table layout to a file.  The file name is made by appending @file{.class}
3531 to the source file name.  If the @samp{-@var{options}} form is used,
3532 @var{options} controls the details of the dump as described for the
3533 @option{-fdump-tree} options.
3535 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3536 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3537 @opindex fdump-tree
3538 Control the dumping at various stages of processing the intermediate
3539 language tree to a file.  The file name is generated by appending a switch
3540 specific suffix to the source file name.  If the @samp{-@var{options}}
3541 form is used, @var{options} is a list of @samp{-} separated options that
3542 control the details of the dump. Not all options are applicable to all
3543 dumps, those which are not meaningful will be ignored. The following
3544 options are available
3546 @table @samp
3547 @item address
3548 Print the address of each node.  Usually this is not meaningful as it
3549 changes according to the environment and source file. Its primary use
3550 is for tying up a dump file with a debug environment.
3551 @item slim
3552 Inhibit dumping of members of a scope or body of a function merely
3553 because that scope has been reached.  Only dump such items when they
3554 are directly reachable by some other path.  When dumping pretty-printed
3555 trees, this option inhibits dumping the bodies of control structures.
3556 @item raw
3557 Print a raw representation of the tree.  By default, trees are
3558 pretty-printed into a C-like representation.
3559 @item details
3560 Enable more detailed dumps (not honored by every dump option).
3561 @item stats
3562 Enable dumping various statistics about the pass (not honored by every dump
3563 option).
3564 @item blocks
3565 Enable showing basic block boundaries (disabled in raw dumps).
3566 @item vops
3567 Enable showing virtual operands for every statement.
3568 @item lineno
3569 Enable showing line numbers for statements.
3570 @item uid
3571 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3572 @item all
3573 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3574 @end table
3576 The following tree dumps are possible:
3577 @table @samp
3579 @item original
3580 Dump before any tree based optimization, to @file{@var{file}.original}.
3582 @item optimized
3583 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3585 @item inlined
3586 Dump after function inlining, to @file{@var{file}.inlined}.
3588 @item gimple
3589 @opindex fdump-tree-gimple
3590 Dump each function before and after the gimplification pass to a file.  The
3591 file name is made by appending @file{.gimple} to the source file name.
3593 @item cfg
3594 @opindex fdump-tree-cfg
3595 Dump the control flow graph of each function to a file.  The file name is
3596 made by appending @file{.cfg} to the source file name.
3598 @item vcg
3599 @opindex fdump-tree-vcg
3600 Dump the control flow graph of each function to a file in VCG format.  The
3601 file name is made by appending @file{.vcg} to the source file name.  Note
3602 that if the file contains more than one function, the generated file cannot
3603 be used directly by VCG.  You will need to cut and paste each function's
3604 graph into its own separate file first.
3606 @item ch
3607 @opindex fdump-tree-ch
3608 Dump each function after copying loop headers.  The file name is made by
3609 appending @file{.ch} to the source file name.
3611 @item ssa
3612 @opindex fdump-tree-ssa
3613 Dump SSA related information to a file.  The file name is made by appending
3614 @file{.ssa} to the source file name.
3616 @item alias
3617 @opindex fdump-tree-alias
3618 Dump aliasing information for each function.  The file name is made by
3619 appending @file{.alias} to the source file name.
3621 @item ccp
3622 @opindex fdump-tree-ccp
3623 Dump each function after CCP.  The file name is made by appending
3624 @file{.ccp} to the source file name.
3626 @item pre
3627 @opindex fdump-tree-pre
3628 Dump trees after partial redundancy elimination.  The file name is made
3629 by appending @file{.pre} to the source file name.
3631 @item fre
3632 @opindex fdump-tree-fre
3633 Dump trees after full redundancy elimination.  The file name is made
3634 by appending @file{.fre} to the source file name.
3636 @item dce
3637 @opindex fdump-tree-dce
3638 Dump each function after dead code elimination.  The file name is made by
3639 appending @file{.dce} to the source file name.
3641 @item mudflap
3642 @opindex fdump-tree-mudflap
3643 Dump each function after adding mudflap instrumentation.  The file name is
3644 made by appending @file{.mudflap} to the source file name.
3646 @item sra
3647 @opindex fdump-tree-sra
3648 Dump each function after performing scalar replacement of aggregates.  The
3649 file name is made by appending @file{.sra} to the source file name.
3651 @item dom
3652 @opindex fdump-tree-dom
3653 Dump each function after applying dominator tree optimizations.  The file
3654 name is made by appending @file{.dom} to the source file name.
3656 @item dse
3657 @opindex fdump-tree-dse
3658 Dump each function after applying dead store elimination.  The file
3659 name is made by appending @file{.dse} to the source file name.
3661 @item phiopt
3662 @opindex fdump-tree-phiopt
3663 Dump each function after optimizing PHI nodes into straightline code.  The file
3664 name is made by appending @file{.phiopt} to the source file name.
3666 @item forwprop
3667 @opindex fdump-tree-forwprop
3668 Dump each function after forward propagating single use variables.  The file
3669 name is made by appending @file{.forwprop} to the source file name.
3671 @item copyrename
3672 @opindex fdump-tree-copyrename
3673 Dump each function after applying the copy rename optimization.  The file
3674 name is made by appending @file{.copyrename} to the source file name.
3676 @item nrv
3677 @opindex fdump-tree-nrv
3678 Dump each function after applying the named return value optimization on
3679 generic trees.  The file name is made by appending @file{.nrv} to the source
3680 file name.
3682 @item vect
3683 @opindex fdump-tree-vect
3684 Dump each function after applying vectorization of loops.  The file name is 
3685 made by appending @file{.vect} to the source file name.
3687 @item all
3688 @opindex fdump-tree-all
3689 Enable all the available tree dumps with the flags provided in this option.
3690 @end table
3692 @item -frandom-seed=@var{string}
3693 @opindex frandom-string
3694 This option provides a seed that GCC uses when it would otherwise use
3695 random numbers.  It is used to generate certain symbol names
3696 that have to be different in every compiled file. It is also used to
3697 place unique stamps in coverage data files and the object files that
3698 produce them. You can use the @option{-frandom-seed} option to produce
3699 reproducibly identical object files.
3701 The @var{string} should be different for every file you compile.
3703 @item -fsched-verbose=@var{n}
3704 @opindex fsched-verbose
3705 On targets that use instruction scheduling, this option controls the
3706 amount of debugging output the scheduler prints.  This information is
3707 written to standard error, unless @option{-dS} or @option{-dR} is
3708 specified, in which case it is output to the usual dump
3709 listing file, @file{.sched} or @file{.sched2} respectively.  However
3710 for @var{n} greater than nine, the output is always printed to standard
3711 error.
3713 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3714 same information as @option{-dRS}.  For @var{n} greater than one, it
3715 also output basic block probabilities, detailed ready list information
3716 and unit/insn info.  For @var{n} greater than two, it includes RTL
3717 at abort point, control-flow and regions info.  And for @var{n} over
3718 four, @option{-fsched-verbose} also includes dependence info.
3720 @item -save-temps
3721 @opindex save-temps
3722 Store the usual ``temporary'' intermediate files permanently; place them
3723 in the current directory and name them based on the source file.  Thus,
3724 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3725 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3726 preprocessed @file{foo.i} output file even though the compiler now
3727 normally uses an integrated preprocessor.
3729 @item -time
3730 @opindex time
3731 Report the CPU time taken by each subprocess in the compilation
3732 sequence.  For C source files, this is the compiler proper and assembler
3733 (plus the linker if linking is done).  The output looks like this:
3735 @smallexample
3736 # cc1 0.12 0.01
3737 # as 0.00 0.01
3738 @end smallexample
3740 The first number on each line is the ``user time,'' that is time spent
3741 executing the program itself.  The second number is ``system time,''
3742 time spent executing operating system routines on behalf of the program.
3743 Both numbers are in seconds.
3745 @item -fvar-tracking
3746 @opindex fvar-tracking
3747 Run variable tracking pass. It computes where variables are stored at each
3748 position in code. Better debugging information is then generated
3749 (if the debugging information format supports this information).
3751 It is enabled by default when compiling with optimization (@option{-Os},
3752 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3753 the debug info format supports it.
3755 @item -print-file-name=@var{library}
3756 @opindex print-file-name
3757 Print the full absolute name of the library file @var{library} that
3758 would be used when linking---and don't do anything else.  With this
3759 option, GCC does not compile or link anything; it just prints the
3760 file name.
3762 @item -print-multi-directory
3763 @opindex print-multi-directory
3764 Print the directory name corresponding to the multilib selected by any
3765 other switches present in the command line.  This directory is supposed
3766 to exist in @env{GCC_EXEC_PREFIX}.
3768 @item -print-multi-lib
3769 @opindex print-multi-lib
3770 Print the mapping from multilib directory names to compiler switches
3771 that enable them.  The directory name is separated from the switches by
3772 @samp{;}, and each switch starts with an @samp{@@} instead of the
3773 @samp{-}, without spaces between multiple switches.  This is supposed to
3774 ease shell-processing.
3776 @item -print-prog-name=@var{program}
3777 @opindex print-prog-name
3778 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3780 @item -print-libgcc-file-name
3781 @opindex print-libgcc-file-name
3782 Same as @option{-print-file-name=libgcc.a}.
3784 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3785 but you do want to link with @file{libgcc.a}.  You can do
3787 @smallexample
3788 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3789 @end smallexample
3791 @item -print-search-dirs
3792 @opindex print-search-dirs
3793 Print the name of the configured installation directory and a list of
3794 program and library directories @command{gcc} will search---and don't do anything else.
3796 This is useful when @command{gcc} prints the error message
3797 @samp{installation problem, cannot exec cpp0: No such file or directory}.
3798 To resolve this you either need to put @file{cpp0} and the other compiler
3799 components where @command{gcc} expects to find them, or you can set the environment
3800 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
3801 Don't forget the trailing '/'.
3802 @xref{Environment Variables}.
3804 @item -dumpmachine
3805 @opindex dumpmachine
3806 Print the compiler's target machine (for example,
3807 @samp{i686-pc-linux-gnu})---and don't do anything else.
3809 @item -dumpversion
3810 @opindex dumpversion
3811 Print the compiler version (for example, @samp{3.0})---and don't do
3812 anything else.
3814 @item -dumpspecs
3815 @opindex dumpspecs
3816 Print the compiler's built-in specs---and don't do anything else.  (This
3817 is used when GCC itself is being built.)  @xref{Spec Files}.
3819 @item -feliminate-unused-debug-types
3820 @opindex feliminate-unused-debug-types
3821 Normally, when producing DWARF2 output, GCC will emit debugging
3822 information for all types declared in a compilation
3823 unit, regardless of whether or not they are actually used
3824 in that compilation unit.  Sometimes this is useful, such as
3825 if, in the debugger, you want to cast a value to a type that is
3826 not actually used in your program (but is declared).  More often,
3827 however, this results in a significant amount of wasted space.
3828 With this option, GCC will avoid producing debug symbol output
3829 for types that are nowhere used in the source file being compiled.
3830 @end table
3832 @node Optimize Options
3833 @section Options That Control Optimization
3834 @cindex optimize options
3835 @cindex options, optimization
3837 These options control various sorts of optimizations.
3839 Without any optimization option, the compiler's goal is to reduce the
3840 cost of compilation and to make debugging produce the expected
3841 results.  Statements are independent: if you stop the program with a
3842 breakpoint between statements, you can then assign a new value to any
3843 variable or change the program counter to any other statement in the
3844 function and get exactly the results you would expect from the source
3845 code.
3847 Turning on optimization flags makes the compiler attempt to improve
3848 the performance and/or code size at the expense of compilation time
3849 and possibly the ability to debug the program.
3851 The compiler performs optimization based on the knowledge it has of
3852 the program.  Optimization levels @option{-O2} and above, in
3853 particular, enable @emph{unit-at-a-time} mode, which allows the
3854 compiler to consider information gained from later functions in
3855 the file when compiling a function.  Compiling multiple files at
3856 once to a single output file in @emph{unit-at-a-time} mode allows
3857 the compiler to use information gained from all of the files when
3858 compiling each of them.
3860 Not all optimizations are controlled directly by a flag.  Only
3861 optimizations that have a flag are listed.
3863 @table @gcctabopt
3864 @item -O
3865 @itemx -O1
3866 @opindex O
3867 @opindex O1
3868 Optimize.  Optimizing compilation takes somewhat more time, and a lot
3869 more memory for a large function.
3871 With @option{-O}, the compiler tries to reduce code size and execution
3872 time, without performing any optimizations that take a great deal of
3873 compilation time.
3875 @option{-O} turns on the following optimization flags:
3876 @gccoptlist{-fdefer-pop @gol
3877 -fmerge-constants @gol
3878 -fthread-jumps @gol
3879 -floop-optimize @gol
3880 -fif-conversion @gol
3881 -fif-conversion2 @gol
3882 -fdelayed-branch @gol
3883 -fguess-branch-probability @gol
3884 -fcprop-registers}
3886 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
3887 where doing so does not interfere with debugging.
3889 @item -O2
3890 @opindex O2
3891 Optimize even more.  GCC performs nearly all supported optimizations
3892 that do not involve a space-speed tradeoff.  The compiler does not
3893 perform loop unrolling or function inlining when you specify @option{-O2}.
3894 As compared to @option{-O}, this option increases both compilation time
3895 and the performance of the generated code.
3897 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
3898 also turns on the following optimization flags:
3899 @gccoptlist{-fforce-mem @gol
3900 -foptimize-sibling-calls @gol
3901 -fstrength-reduce @gol
3902 -fcse-follow-jumps  -fcse-skip-blocks @gol
3903 -frerun-cse-after-loop  -frerun-loop-opt @gol
3904 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las @gol
3905 -fdelete-null-pointer-checks @gol
3906 -fexpensive-optimizations @gol
3907 -fregmove @gol
3908 -fschedule-insns  -fschedule-insns2 @gol
3909 -fsched-interblock  -fsched-spec @gol
3910 -fcaller-saves @gol
3911 -fpeephole2 @gol
3912 -freorder-blocks  -freorder-functions @gol
3913 -fstrict-aliasing @gol
3914 -funit-at-a-time @gol
3915 -falign-functions  -falign-jumps @gol
3916 -falign-loops  -falign-labels @gol
3917 -fcrossjumping}
3919 Please note the warning under @option{-fgcse} about
3920 invoking @option{-O2} on programs that use computed gotos.
3922 @item -O3
3923 @opindex O3
3924 Optimize yet more.  @option{-O3} turns on all optimizations specified by
3925 @option{-O2} and also turns on the @option{-finline-functions},
3926 @option{-fweb} and @option{-fgcse-after-reload} options.
3928 @item -O0
3929 @opindex O0
3930 Do not optimize.  This is the default.
3932 @item -Os
3933 @opindex Os
3934 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
3935 do not typically increase code size.  It also performs further
3936 optimizations designed to reduce code size.
3938 @option{-Os} disables the following optimization flags:
3939 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
3940 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
3942 If you use multiple @option{-O} options, with or without level numbers,
3943 the last such option is the one that is effective.
3944 @end table
3946 Options of the form @option{-f@var{flag}} specify machine-independent
3947 flags.  Most flags have both positive and negative forms; the negative
3948 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
3949 below, only one of the forms is listed---the one you typically will
3950 use.  You can figure out the other form by either removing @samp{no-}
3951 or adding it.
3953 The following options control specific optimizations.  They are either
3954 activated by @option{-O} options or are related to ones that are.  You
3955 can use the following flags in the rare cases when ``fine-tuning'' of
3956 optimizations to be performed is desired.
3958 @table @gcctabopt
3959 @item -fno-default-inline
3960 @opindex fno-default-inline
3961 Do not make member functions inline by default merely because they are
3962 defined inside the class scope (C++ only).  Otherwise, when you specify
3963 @w{@option{-O}}, member functions defined inside class scope are compiled
3964 inline by default; i.e., you don't need to add @samp{inline} in front of
3965 the member function name.
3967 @item -fno-defer-pop
3968 @opindex fno-defer-pop
3969 Always pop the arguments to each function call as soon as that function
3970 returns.  For machines which must pop arguments after a function call,
3971 the compiler normally lets arguments accumulate on the stack for several
3972 function calls and pops them all at once.
3974 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
3976 @item -fforce-mem
3977 @opindex fforce-mem
3978 Force memory operands to be copied into registers before doing
3979 arithmetic on them.  This produces better code by making all memory
3980 references potential common subexpressions.  When they are not common
3981 subexpressions, instruction combination should eliminate the separate
3982 register-load.
3984 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
3986 @item -fforce-addr
3987 @opindex fforce-addr
3988 Force memory address constants to be copied into registers before
3989 doing arithmetic on them.  This may produce better code just as
3990 @option{-fforce-mem} may.
3992 @item -fomit-frame-pointer
3993 @opindex fomit-frame-pointer
3994 Don't keep the frame pointer in a register for functions that
3995 don't need one.  This avoids the instructions to save, set up and
3996 restore frame pointers; it also makes an extra register available
3997 in many functions.  @strong{It also makes debugging impossible on
3998 some machines.}
4000 On some machines, such as the VAX, this flag has no effect, because
4001 the standard calling sequence automatically handles the frame pointer
4002 and nothing is saved by pretending it doesn't exist.  The
4003 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4004 whether a target machine supports this flag.  @xref{Registers,,Register
4005 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4007 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4009 @item -foptimize-sibling-calls
4010 @opindex foptimize-sibling-calls
4011 Optimize sibling and tail recursive calls.
4013 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4015 @item -fno-inline
4016 @opindex fno-inline
4017 Don't pay attention to the @code{inline} keyword.  Normally this option
4018 is used to keep the compiler from expanding any functions inline.
4019 Note that if you are not optimizing, no functions can be expanded inline.
4021 @item -finline-functions
4022 @opindex finline-functions
4023 Integrate all simple functions into their callers.  The compiler
4024 heuristically decides which functions are simple enough to be worth
4025 integrating in this way.
4027 If all calls to a given function are integrated, and the function is
4028 declared @code{static}, then the function is normally not output as
4029 assembler code in its own right.
4031 Enabled at level @option{-O3}.
4033 @item -finline-limit=@var{n}
4034 @opindex finline-limit
4035 By default, GCC limits the size of functions that can be inlined.  This flag
4036 allows the control of this limit for functions that are explicitly marked as
4037 inline (i.e., marked with the inline keyword or defined within the class
4038 definition in c++).  @var{n} is the size of functions that can be inlined in
4039 number of pseudo instructions (not counting parameter handling).  The default
4040 value of @var{n} is 600.
4041 Increasing this value can result in more inlined code at
4042 the cost of compilation time and memory consumption.  Decreasing usually makes
4043 the compilation faster and less code will be inlined (which presumably
4044 means slower programs).  This option is particularly useful for programs that
4045 use inlining heavily such as those based on recursive templates with C++.
4047 Inlining is actually controlled by a number of parameters, which may be
4048 specified individually by using @option{--param @var{name}=@var{value}}.
4049 The @option{-finline-limit=@var{n}} option sets some of these parameters
4050 as follows:
4052 @table @gcctabopt
4053  @item max-inline-insns-single
4054   is set to @var{n}/2.
4055  @item max-inline-insns-auto
4056   is set to @var{n}/2.
4057  @item min-inline-insns
4058   is set to 130 or @var{n}/4, whichever is smaller.
4059  @item max-inline-insns-rtl
4060   is set to @var{n}.
4061 @end table
4063 See below for a documentation of the individual
4064 parameters controlling inlining.
4066 @emph{Note:} pseudo instruction represents, in this particular context, an
4067 abstract measurement of function's size.  In no way, it represents a count
4068 of assembly instructions and as such its exact meaning might change from one
4069 release to an another.
4071 @item -fkeep-inline-functions
4072 @opindex fkeep-inline-functions
4073 In C, emit @code{static} functions that are declared @code{inline}
4074 into the object file, even if the function has been inlined into all
4075 of its callers.  This switch does not affect functions using the
4076 @code{extern inline} extension in GNU C.  In C++, emit any and all
4077 inline functions into the object file.
4079 @item -fkeep-static-consts
4080 @opindex fkeep-static-consts
4081 Emit variables declared @code{static const} when optimization isn't turned
4082 on, even if the variables aren't referenced.
4084 GCC enables this option by default.  If you want to force the compiler to
4085 check if the variable was referenced, regardless of whether or not
4086 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4088 @item -fmerge-constants
4089 Attempt to merge identical constants (string constants and floating point
4090 constants) across compilation units.
4092 This option is the default for optimized compilation if the assembler and
4093 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4094 behavior.
4096 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4098 @item -fmerge-all-constants
4099 Attempt to merge identical constants and identical variables.
4101 This option implies @option{-fmerge-constants}.  In addition to
4102 @option{-fmerge-constants} this considers e.g. even constant initialized
4103 arrays or initialized constant variables with integral or floating point
4104 types.  Languages like C or C++ require each non-automatic variable to
4105 have distinct location, so using this option will result in non-conforming
4106 behavior.
4108 @item -fmodulo-sched
4109 @opindex fmodulo-sched
4110 Perform swing modulo scheduling immediately before the first scheduling
4111 pass.  This pass looks at innermost loops and reorders their
4112 instructions by overlapping different iterations.
4114 @item -fnew-ra
4115 @opindex fnew-ra
4116 Use a graph coloring register allocator.  Currently this option is meant
4117 only for testing.  Users should not specify this option, since it is not
4118 yet ready for production use.
4120 @item -fno-branch-count-reg
4121 @opindex fno-branch-count-reg
4122 Do not use ``decrement and branch'' instructions on a count register,
4123 but instead generate a sequence of instructions that decrement a
4124 register, compare it against zero, then branch based upon the result.
4125 This option is only meaningful on architectures that support such
4126 instructions, which include x86, PowerPC, IA-64 and S/390.
4128 The default is @option{-fbranch-count-reg}, enabled when
4129 @option{-fstrength-reduce} is enabled.
4131 @item -fno-function-cse
4132 @opindex fno-function-cse
4133 Do not put function addresses in registers; make each instruction that
4134 calls a constant function contain the function's address explicitly.
4136 This option results in less efficient code, but some strange hacks
4137 that alter the assembler output may be confused by the optimizations
4138 performed when this option is not used.
4140 The default is @option{-ffunction-cse}
4142 @item -fno-zero-initialized-in-bss
4143 @opindex fno-zero-initialized-in-bss
4144 If the target supports a BSS section, GCC by default puts variables that
4145 are initialized to zero into BSS@.  This can save space in the resulting
4146 code.
4148 This option turns off this behavior because some programs explicitly
4149 rely on variables going to the data section.  E.g., so that the
4150 resulting executable can find the beginning of that section and/or make
4151 assumptions based on that.
4153 The default is @option{-fzero-initialized-in-bss}.
4155 @item -fbounds-check
4156 @opindex fbounds-check
4157 For front-ends that support it, generate additional code to check that
4158 indices used to access arrays are within the declared range.  This is
4159 currently only supported by the Java and Fortran front-ends, where
4160 this option defaults to true and false respectively.
4162 @item -fmudflap -fmudflapth -fmudflapir
4163 @opindex fmudflap
4164 @opindex fmudflapth
4165 @opindex fmudflapir
4166 @cindex bounds checking
4167 @cindex mudflap
4168 For front-ends that support it (C and C++), instrument all risky
4169 pointer/array dereferencing operations, some standard library
4170 string/heap functions, and some other associated constructs with
4171 range/validity tests.  Modules so instrumented should be immune to
4172 buffer overflows, invalid heap use, and some other classes of C/C++
4173 programming errors.  The instrumentation relies on a separate runtime
4174 library (@file{libmudflap}), which will be linked into a program if
4175 @option{-fmudflap} is given at link time.  Run-time behavior of the
4176 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4177 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4178 for its options.
4180 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4181 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4182 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4183 instrumentation should ignore pointer reads.  This produces less
4184 instrumentation (and therefore faster execution) and still provides
4185 some protection against outright memory corrupting writes, but allows
4186 erroneously read data to propagate within a program.
4188 @item -fstrength-reduce
4189 @opindex fstrength-reduce
4190 Perform the optimizations of loop strength reduction and
4191 elimination of iteration variables.
4193 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4195 @item -fthread-jumps
4196 @opindex fthread-jumps
4197 Perform optimizations where we check to see if a jump branches to a
4198 location where another comparison subsumed by the first is found.  If
4199 so, the first branch is redirected to either the destination of the
4200 second branch or a point immediately following it, depending on whether
4201 the condition is known to be true or false.
4203 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4205 @item -fcse-follow-jumps
4206 @opindex fcse-follow-jumps
4207 In common subexpression elimination, scan through jump instructions
4208 when the target of the jump is not reached by any other path.  For
4209 example, when CSE encounters an @code{if} statement with an
4210 @code{else} clause, CSE will follow the jump when the condition
4211 tested is false.
4213 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4215 @item -fcse-skip-blocks
4216 @opindex fcse-skip-blocks
4217 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4218 follow jumps which conditionally skip over blocks.  When CSE
4219 encounters a simple @code{if} statement with no else clause,
4220 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4221 body of the @code{if}.
4223 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4225 @item -frerun-cse-after-loop
4226 @opindex frerun-cse-after-loop
4227 Re-run common subexpression elimination after loop optimizations has been
4228 performed.
4230 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4232 @item -frerun-loop-opt
4233 @opindex frerun-loop-opt
4234 Run the loop optimizer twice.
4236 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4238 @item -fgcse
4239 @opindex fgcse
4240 Perform a global common subexpression elimination pass.
4241 This pass also performs global constant and copy propagation.
4243 @emph{Note:} When compiling a program using computed gotos, a GCC
4244 extension, you may get better runtime performance if you disable
4245 the global common subexpression elimination pass by adding
4246 @option{-fno-gcse} to the command line.
4248 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4250 @item -fgcse-lm
4251 @opindex fgcse-lm
4252 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4253 attempt to move loads which are only killed by stores into themselves.  This
4254 allows a loop containing a load/store sequence to be changed to a load outside
4255 the loop, and a copy/store within the loop.
4257 Enabled by default when gcse is enabled.
4259 @item -fgcse-sm
4260 @opindex fgcse-sm
4261 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4262 global common subexpression elimination.  This pass will attempt to move
4263 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4264 loops containing a load/store sequence can be changed to a load before
4265 the loop and a store after the loop.
4267 Enabled by default when gcse is enabled.
4269 @item -fgcse-las
4270 @opindex fgcse-las
4271 When @option{-fgcse-las} is enabled, the global common subexpression
4272 elimination pass eliminates redundant loads that come after stores to the
4273 same memory location (both partial and full redundancies).
4275 Enabled by default when gcse is enabled.
4277 @item -fgcse-after-reload
4278 @opindex fgcse-after-reload
4279 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4280 pass is performed after reload. The purpose of this pass is to cleanup
4281 redundant spilling.
4283 @item -floop-optimize
4284 @opindex floop-optimize
4285 Perform loop optimizations: move constant expressions out of loops, simplify
4286 exit test conditions and optionally do strength-reduction and loop unrolling as
4287 well.
4289 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4291 @item -floop-optimize2
4292 @opindex floop-optimize2
4293 Perform loop optimizations using the new loop optimizer.  The optimizations
4294 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4295 by separate flags.
4297 @item -fcrossjumping
4298 @opindex crossjumping
4299 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4300 resulting code may or may not perform better than without cross-jumping.
4302 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4304 @item -fif-conversion
4305 @opindex if-conversion
4306 Attempt to transform conditional jumps into branch-less equivalents.  This
4307 include use of conditional moves, min, max, set flags and abs instructions, and
4308 some tricks doable by standard arithmetics.  The use of conditional execution
4309 on chips where it is available is controlled by @code{if-conversion2}.
4311 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4313 @item -fif-conversion2
4314 @opindex if-conversion2
4315 Use conditional execution (where available) to transform conditional jumps into
4316 branch-less equivalents.
4318 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4320 @item -fdelete-null-pointer-checks
4321 @opindex fdelete-null-pointer-checks
4322 Use global dataflow analysis to identify and eliminate useless checks
4323 for null pointers.  The compiler assumes that dereferencing a null
4324 pointer would have halted the program.  If a pointer is checked after
4325 it has already been dereferenced, it cannot be null.
4327 In some environments, this assumption is not true, and programs can
4328 safely dereference null pointers.  Use
4329 @option{-fno-delete-null-pointer-checks} to disable this optimization
4330 for programs which depend on that behavior.
4332 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4334 @item -fexpensive-optimizations
4335 @opindex fexpensive-optimizations
4336 Perform a number of minor optimizations that are relatively expensive.
4338 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4340 @item -foptimize-register-move
4341 @itemx -fregmove
4342 @opindex foptimize-register-move
4343 @opindex fregmove
4344 Attempt to reassign register numbers in move instructions and as
4345 operands of other simple instructions in order to maximize the amount of
4346 register tying.  This is especially helpful on machines with two-operand
4347 instructions.
4349 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4350 optimization.
4352 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4354 @item -fdelayed-branch
4355 @opindex fdelayed-branch
4356 If supported for the target machine, attempt to reorder instructions
4357 to exploit instruction slots available after delayed branch
4358 instructions.
4360 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4362 @item -fschedule-insns
4363 @opindex fschedule-insns
4364 If supported for the target machine, attempt to reorder instructions to
4365 eliminate execution stalls due to required data being unavailable.  This
4366 helps machines that have slow floating point or memory load instructions
4367 by allowing other instructions to be issued until the result of the load
4368 or floating point instruction is required.
4370 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4372 @item -fschedule-insns2
4373 @opindex fschedule-insns2
4374 Similar to @option{-fschedule-insns}, but requests an additional pass of
4375 instruction scheduling after register allocation has been done.  This is
4376 especially useful on machines with a relatively small number of
4377 registers and where memory load instructions take more than one cycle.
4379 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4381 @item -fno-sched-interblock
4382 @opindex fno-sched-interblock
4383 Don't schedule instructions across basic blocks.  This is normally
4384 enabled by default when scheduling before register allocation, i.e.@:
4385 with @option{-fschedule-insns} or at @option{-O2} or higher.
4387 @item -fno-sched-spec
4388 @opindex fno-sched-spec
4389 Don't allow speculative motion of non-load instructions.  This is normally
4390 enabled by default when scheduling before register allocation, i.e.@:
4391 with @option{-fschedule-insns} or at @option{-O2} or higher.
4393 @item -fsched-spec-load
4394 @opindex fsched-spec-load
4395 Allow speculative motion of some load instructions.  This only makes
4396 sense when scheduling before register allocation, i.e.@: with
4397 @option{-fschedule-insns} or at @option{-O2} or higher.
4399 @item -fsched-spec-load-dangerous
4400 @opindex fsched-spec-load-dangerous
4401 Allow speculative motion of more load instructions.  This only makes
4402 sense when scheduling before register allocation, i.e.@: with
4403 @option{-fschedule-insns} or at @option{-O2} or higher.
4405 @item -fsched-stalled-insns=@var{n}
4406 @opindex fsched-stalled-insns
4407 Define how many insns (if any) can be moved prematurely from the queue
4408 of stalled insns into the ready list, during the second scheduling pass.
4410 @item -fsched-stalled-insns-dep=@var{n}
4411 @opindex fsched-stalled-insns-dep
4412 Define how many insn groups (cycles) will be examined for a dependency
4413 on a stalled insn that is candidate for premature removal from the queue
4414 of stalled insns.  Has an effect only during the second scheduling pass,
4415 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4417 @item -fsched2-use-superblocks
4418 @opindex fsched2-use-superblocks
4419 When scheduling after register allocation, do use superblock scheduling
4420 algorithm.  Superblock scheduling allows motion across basic block boundaries
4421 resulting on faster schedules.  This option is experimental, as not all machine
4422 descriptions used by GCC model the CPU closely enough to avoid unreliable
4423 results from the algorithm.
4425 This only makes sense when scheduling after register allocation, i.e.@: with
4426 @option{-fschedule-insns2} or at @option{-O2} or higher.
4428 @item -fsched2-use-traces
4429 @opindex fsched2-use-traces
4430 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4431 allocation and additionally perform code duplication in order to increase the
4432 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4433 trace formation.
4435 This mode should produce faster but significantly longer programs.  Also
4436 without @code{-fbranch-probabilities} the traces constructed may not match the
4437 reality and hurt the performance.  This only makes
4438 sense when scheduling after register allocation, i.e.@: with
4439 @option{-fschedule-insns2} or at @option{-O2} or higher.
4441 @item -freschedule-modulo-scheduled-loops
4442 @opindex fscheduling-in-modulo-scheduled-loops
4443 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4444 we may want to prevent the later scheduling passes from changing its schedule, we use this
4445 option to control that.
4447 @item -fcaller-saves
4448 @opindex fcaller-saves
4449 Enable values to be allocated in registers that will be clobbered by
4450 function calls, by emitting extra instructions to save and restore the
4451 registers around such calls.  Such allocation is done only when it
4452 seems to result in better code than would otherwise be produced.
4454 This option is always enabled by default on certain machines, usually
4455 those which have no call-preserved registers to use instead.
4457 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4459 @item -ftree-pre
4460 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4461 enabled by default at -O and higher.
4463 @item -ftree-fre
4464 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4465 between FRE and PRE is that FRE only considers expressions
4466 that are computed on all paths leading to the redundant computation.
4467 This analysis faster than PRE, though it exposes fewer redundancies.
4468 This flag is enabled by default at -O and higher.
4470 @item -ftree-ccp
4471 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4472 is enabled by default at -O and higher.
4474 @item -ftree-dce
4475 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4476 default at -O and higher.
4478 @item -ftree-dominator-opts
4479 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4480 default at -O and higher.
4482 @item -ftree-ch
4483 Perform loop header copying on trees.  This is beneficial since it increases
4484 effectivity of code motion optimizations.  It also saves one jump.  This flag
4485 is enabled by default at -O and higher.  It is not enabled for -Os, since it
4486 usually increases code size.
4488 @item -ftree-loop-optimize
4489 Perform loop optimizations on trees.  This flag is enabled by default at -O
4490 and higher.
4492 @item -ftree-lim
4493 Perform loop invariant motion on trees.  This pass moves only invartiants that
4494 would be hard to handle on rtl level (function calls, operations that expand to
4495 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4496 operands of conditions that are invariant out of the loop, so that we can use
4497 just trivial invariantness analysis in loop unswitching.  The pass also includes
4498 store motion.
4500 @item -fivcanon
4501 Create a canonical counter for number of iterations in the loop for that
4502 determining number of iterations requires complicated analysis.  Later
4503 optimizations then may determine the number easily.  Useful especially
4504 in connection with unrolling.
4506 @item -ftree-sra
4507 Perform scalar replacement of aggregates.  This pass replaces structure
4508 references with scalars to prevent committing structures to memory too
4509 early.  This flag is enabled by default at -O and higher.
4511 @item -ftree-copyrename
4512 Perform copy renaming on trees.  This pass attempts to rename compiler
4513 temporaries to other variables at copy locations, usually resulting in
4514 variable names which more closely resemble the original variables.  This flag
4515 is enabled by default at -O and higher.
4517 @item -ftree-ter
4518 Perform temporary expression replacement during the SSA->normal phase.  Single
4519 use/single def temporaries are replaced at their use location with their
4520 defining expression.  This results in non-GIMPLE code, but gives the expanders
4521 much more complex trees to work on resulting in better RTL generation.  This is
4522 enabled by default at -O and higher.
4524 @item -ftree-lrs
4525 Perform live range splitting during the SSA->normal phase.  Distinct live
4526 ranges of a variable are split into unique variables, allowing for better
4527 optimization later.  This is enabled by default at -O and higher.
4529 @item -ftree-vectorize
4530 Perform loop vectorization on trees.
4532 @item -ftracer
4533 @opindex ftracer
4534 Perform tail duplication to enlarge superblock size. This transformation
4535 simplifies the control flow of the function allowing other optimizations to do
4536 better job.
4538 @item -funroll-loops
4539 @opindex funroll-loops
4540 Unroll loops whose number of iterations can be determined at compile
4541 time or upon entry to the loop.  @option{-funroll-loops} implies both
4542 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4543 option makes code larger, and may or may not make it run faster.
4545 @item -funroll-all-loops
4546 @opindex funroll-all-loops
4547 Unroll all loops, even if their number of iterations is uncertain when
4548 the loop is entered.  This usually makes programs run more slowly.
4549 @option{-funroll-all-loops} implies the same options as
4550 @option{-funroll-loops},
4552 @item -fprefetch-loop-arrays
4553 @opindex fprefetch-loop-arrays
4554 If supported by the target machine, generate instructions to prefetch
4555 memory to improve the performance of loops that access large arrays.
4557 @item -fmove-all-movables
4558 @opindex fmove-all-movables
4559 Forces all invariant computations in loops to be moved
4560 outside the loop.
4562 @item -freduce-all-givs
4563 @opindex freduce-all-givs
4564 Forces all general-induction variables in loops to be
4565 strength-reduced.
4567 @emph{Note:} When compiling programs written in Fortran,
4568 @option{-fmove-all-movables} and @option{-freduce-all-givs} are enabled
4569 by default when you use the optimizer.
4571 These options may generate better or worse code; results are highly
4572 dependent on the structure of loops within the source code.
4574 These two options are intended to be removed someday, once
4575 they have helped determine the efficacy of various
4576 approaches to improving loop optimizations.
4578 Please contact @w{@email{gcc@@gcc.gnu.org}}, and describe how use of
4579 these options affects the performance of your production code.
4580 Examples of code that runs @emph{slower} when these options are
4581 @emph{enabled} are very valuable.
4583 @item -fno-peephole
4584 @itemx -fno-peephole2
4585 @opindex fno-peephole
4586 @opindex fno-peephole2
4587 Disable any machine-specific peephole optimizations.  The difference
4588 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4589 are implemented in the compiler; some targets use one, some use the
4590 other, a few use both.
4592 @option{-fpeephole} is enabled by default.
4593 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4595 @item -fno-guess-branch-probability
4596 @opindex fno-guess-branch-probability
4597 Do not guess branch probabilities using a randomized model.
4599 Sometimes GCC will opt to use a randomized model to guess branch
4600 probabilities, when none are available from either profiling feedback
4601 (@option{-fprofile-arcs}) or @samp{__builtin_expect}.  This means that
4602 different runs of the compiler on the same program may produce different
4603 object code.
4605 In a hard real-time system, people don't want different runs of the
4606 compiler to produce code that has different behavior; minimizing
4607 non-determinism is of paramount import.  This switch allows users to
4608 reduce non-determinism, possibly at the expense of inferior
4609 optimization.
4611 The default is @option{-fguess-branch-probability} at levels
4612 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4614 @item -freorder-blocks
4615 @opindex freorder-blocks
4616 Reorder basic blocks in the compiled function in order to reduce number of
4617 taken branches and improve code locality.
4619 Enabled at levels @option{-O2}, @option{-O3}.
4621 @item -freorder-blocks-and-partition
4622 @opindex freorder-blocks-and-partition
4623 In addition to reordering basic blocks in the compiled function, in order
4624 to reduce number of taken branches, partitions hot and cold basic blocks
4625 into separate sections of the assembly and .o files, to improve
4626 paging and cache locality performance.
4628 This optimization is automatically turned off in the presence of
4629 exception handling, for linkonce sections, for functions with a user-defined
4630 section attribute and on any architecture that does not support named
4631 sections.
4633 @item -freorder-functions
4634 @opindex freorder-functions
4635 Reorder basic blocks in the compiled function in order to reduce number of
4636 taken branches and improve code locality. This is implemented by using special
4637 subsections @code{.text.hot} for most frequently executed functions and
4638 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4639 the linker so object file format must support named sections and linker must
4640 place them in a reasonable way.
4642 Also profile feedback must be available in to make this option effective.  See
4643 @option{-fprofile-arcs} for details.
4645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4647 @item -fstrict-aliasing
4648 @opindex fstrict-aliasing
4649 Allows the compiler to assume the strictest aliasing rules applicable to
4650 the language being compiled.  For C (and C++), this activates
4651 optimizations based on the type of expressions.  In particular, an
4652 object of one type is assumed never to reside at the same address as an
4653 object of a different type, unless the types are almost the same.  For
4654 example, an @code{unsigned int} can alias an @code{int}, but not a
4655 @code{void*} or a @code{double}.  A character type may alias any other
4656 type.
4658 Pay special attention to code like this:
4659 @smallexample
4660 union a_union @{
4661   int i;
4662   double d;
4665 int f() @{
4666   a_union t;
4667   t.d = 3.0;
4668   return t.i;
4670 @end smallexample
4671 The practice of reading from a different union member than the one most
4672 recently written to (called ``type-punning'') is common.  Even with
4673 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4674 is accessed through the union type.  So, the code above will work as
4675 expected.  However, this code might not:
4676 @smallexample
4677 int f() @{
4678   a_union t;
4679   int* ip;
4680   t.d = 3.0;
4681   ip = &t.i;
4682   return *ip;
4684 @end smallexample
4686 Every language that wishes to perform language-specific alias analysis
4687 should define a function that computes, given an @code{tree}
4688 node, an alias set for the node.  Nodes in different alias sets are not
4689 allowed to alias.  For an example, see the C front-end function
4690 @code{c_get_alias_set}.
4692 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4694 @item -falign-functions
4695 @itemx -falign-functions=@var{n}
4696 @opindex falign-functions
4697 Align the start of functions to the next power-of-two greater than
4698 @var{n}, skipping up to @var{n} bytes.  For instance,
4699 @option{-falign-functions=32} aligns functions to the next 32-byte
4700 boundary, but @option{-falign-functions=24} would align to the next
4701 32-byte boundary only if this can be done by skipping 23 bytes or less.
4703 @option{-fno-align-functions} and @option{-falign-functions=1} are
4704 equivalent and mean that functions will not be aligned.
4706 Some assemblers only support this flag when @var{n} is a power of two;
4707 in that case, it is rounded up.
4709 If @var{n} is not specified or is zero, use a machine-dependent default.
4711 Enabled at levels @option{-O2}, @option{-O3}.
4713 @item -falign-labels
4714 @itemx -falign-labels=@var{n}
4715 @opindex falign-labels
4716 Align all branch targets to a power-of-two boundary, skipping up to
4717 @var{n} bytes like @option{-falign-functions}.  This option can easily
4718 make code slower, because it must insert dummy operations for when the
4719 branch target is reached in the usual flow of the code.
4721 @option{-fno-align-labels} and @option{-falign-labels=1} are
4722 equivalent and mean that labels will not be aligned.
4724 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4725 are greater than this value, then their values are used instead.
4727 If @var{n} is not specified or is zero, use a machine-dependent default
4728 which is very likely to be @samp{1}, meaning no alignment.
4730 Enabled at levels @option{-O2}, @option{-O3}.
4732 @item -falign-loops
4733 @itemx -falign-loops=@var{n}
4734 @opindex falign-loops
4735 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4736 like @option{-falign-functions}.  The hope is that the loop will be
4737 executed many times, which will make up for any execution of the dummy
4738 operations.
4740 @option{-fno-align-loops} and @option{-falign-loops=1} are
4741 equivalent and mean that loops will not be aligned.
4743 If @var{n} is not specified or is zero, use a machine-dependent default.
4745 Enabled at levels @option{-O2}, @option{-O3}.
4747 @item -falign-jumps
4748 @itemx -falign-jumps=@var{n}
4749 @opindex falign-jumps
4750 Align branch targets to a power-of-two boundary, for branch targets
4751 where the targets can only be reached by jumping, skipping up to @var{n}
4752 bytes like @option{-falign-functions}.  In this case, no dummy operations
4753 need be executed.
4755 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4756 equivalent and mean that loops will not be aligned.
4758 If @var{n} is not specified or is zero, use a machine-dependent default.
4760 Enabled at levels @option{-O2}, @option{-O3}.
4762 @item -funit-at-a-time
4763 @opindex funit-at-a-time
4764 Parse the whole compilation unit before starting to produce code.
4765 This allows some extra optimizations to take place but consumes
4766 more memory (in general).  There are some compatibility issues
4767 with @emph{unit-at-at-time} mode:
4768 @itemize @bullet
4769 @item
4770 enabling @emph{unit-at-a-time} mode may change the order
4771 in which functions, variables, and top-level @code{asm} statements
4772 are emitted, and will likely break code relying on some particular
4773 ordering.  The majority of such top-level @code{asm} statements,
4774 though, can be replaced by @code{section} attributes.
4776 @item
4777 @emph{unit-at-a-time} mode removes unreferenced static variables
4778 and functions are removed.  This may result in undefined references
4779 when an @code{asm} statement refers directly to variables or functions
4780 that are otherwise unused.  In that case either the variable/function
4781 shall be listed as an operand of the @code{asm} statement operand or,
4782 in the case of top-level @code{asm} statements the attribute @code{used}
4783 shall be used on the declaration.
4785 @item
4786 Static functions now can use non-standard passing conventions that
4787 may break @code{asm} statements calling functions directly. Again,
4788 attribute @code{used} will prevent this behavior.
4789 @end itemize
4791 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
4792 but this scheme may not be supported by future releases of GCC.
4794 Enabled at levels @option{-O2}, @option{-O3}.
4796 @item -fweb
4797 @opindex fweb
4798 Constructs webs as commonly used for register allocation purposes and assign
4799 each web individual pseudo register.  This allows the register allocation pass
4800 to operate on pseudos directly, but also strengthens several other optimization
4801 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
4802 however, make debugging impossible, since variables will no longer stay in a
4803 ``home register''.
4805 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
4806 on targets where the default format for debugging information supports
4807 variable tracking.
4809 @item -fno-cprop-registers
4810 @opindex fno-cprop-registers
4811 After register allocation and post-register allocation instruction splitting,
4812 we perform a copy-propagation pass to try to reduce scheduling dependencies
4813 and occasionally eliminate the copy.
4815 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4817 @item -fprofile-generate
4818 @opindex fprofile-generate
4820 Enable options usually used for instrumenting application to produce
4821 profile useful for later recompilation with profile feedback based
4822 optimization.  You must use @code{-fprofile-generate} both when
4823 compiling and when linking your program.
4825 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
4827 @item -fprofile-use
4828 @opindex fprofile-use
4829 Enable profile feedback directed optimizations, and optimizations
4830 generally profitable only with profile feedback available.
4832 The following options are enabled: @code{-fbranch-probabilities},
4833 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
4835 @end table
4837 The following options control compiler behavior regarding floating
4838 point arithmetic.  These options trade off between speed and
4839 correctness.  All must be specifically enabled.
4841 @table @gcctabopt
4842 @item -ffloat-store
4843 @opindex ffloat-store
4844 Do not store floating point variables in registers, and inhibit other
4845 options that might change whether a floating point value is taken from a
4846 register or memory.
4848 @cindex floating point precision
4849 This option prevents undesirable excess precision on machines such as
4850 the 68000 where the floating registers (of the 68881) keep more
4851 precision than a @code{double} is supposed to have.  Similarly for the
4852 x86 architecture.  For most programs, the excess precision does only
4853 good, but a few programs rely on the precise definition of IEEE floating
4854 point.  Use @option{-ffloat-store} for such programs, after modifying
4855 them to store all pertinent intermediate computations into variables.
4857 @item -ffast-math
4858 @opindex ffast-math
4859 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
4860 @option{-fno-trapping-math}, @option{-ffinite-math-only},
4861 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
4863 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
4865 This option should never be turned on by any @option{-O} option since
4866 it can result in incorrect output for programs which depend on
4867 an exact implementation of IEEE or ISO rules/specifications for
4868 math functions.
4870 @item -fno-math-errno
4871 @opindex fno-math-errno
4872 Do not set ERRNO after calling math functions that are executed
4873 with a single instruction, e.g., sqrt.  A program that relies on
4874 IEEE exceptions for math error handling may want to use this flag
4875 for speed while maintaining IEEE arithmetic compatibility.
4877 This option should never be turned on by any @option{-O} option since
4878 it can result in incorrect output for programs which depend on
4879 an exact implementation of IEEE or ISO rules/specifications for
4880 math functions.
4882 The default is @option{-fmath-errno}.
4884 @item -funsafe-math-optimizations
4885 @opindex funsafe-math-optimizations
4886 Allow optimizations for floating-point arithmetic that (a) assume
4887 that arguments and results are valid and (b) may violate IEEE or
4888 ANSI standards.  When used at link-time, it may include libraries
4889 or startup files that change the default FPU control word or other
4890 similar optimizations.
4892 This option should never be turned on by any @option{-O} option since
4893 it can result in incorrect output for programs which depend on
4894 an exact implementation of IEEE or ISO rules/specifications for
4895 math functions.
4897 The default is @option{-fno-unsafe-math-optimizations}.
4899 @item -ffinite-math-only
4900 @opindex ffinite-math-only
4901 Allow optimizations for floating-point arithmetic that assume
4902 that arguments and results are not NaNs or +-Infs.
4904 This option should never be turned on by any @option{-O} option since
4905 it can result in incorrect output for programs which depend on
4906 an exact implementation of IEEE or ISO rules/specifications.
4908 The default is @option{-fno-finite-math-only}.
4910 @item -fno-trapping-math
4911 @opindex fno-trapping-math
4912 Compile code assuming that floating-point operations cannot generate
4913 user-visible traps.  These traps include division by zero, overflow,
4914 underflow, inexact result and invalid operation.  This option implies
4915 @option{-fno-signaling-nans}.  Setting this option may allow faster
4916 code if one relies on ``non-stop'' IEEE arithmetic, for example.
4918 This option should never be turned on by any @option{-O} option since
4919 it can result in incorrect output for programs which depend on
4920 an exact implementation of IEEE or ISO rules/specifications for
4921 math functions.
4923 The default is @option{-ftrapping-math}.
4925 @item -frounding-math
4926 @opindex frounding-math
4927 Disable transformations and optimizations that assume default floating
4928 point rounding behavior.  This is round-to-zero for all floating point
4929 to integer conversions, and round-to-nearest for all other arithmetic
4930 truncations.  This option should be specified for programs that change
4931 the FP rounding mode dynamically, or that may be executed with a
4932 non-default rounding mode.  This option disables constant folding of
4933 floating point expressions at compile-time (which may be affected by
4934 rounding mode) and arithmetic transformations that are unsafe in the
4935 presence of sign-dependent rounding modes.
4937 The default is @option{-fno-rounding-math}.
4939 This option is experimental and does not currently guarantee to
4940 disable all GCC optimizations that are affected by rounding mode.
4941 Future versions of GCC may provide finer control of this setting
4942 using C99's @code{FENV_ACCESS} pragma.  This command line option
4943 will be used to specify the default state for @code{FENV_ACCESS}.
4945 @item -fsignaling-nans
4946 @opindex fsignaling-nans
4947 Compile code assuming that IEEE signaling NaNs may generate user-visible
4948 traps during floating-point operations.  Setting this option disables
4949 optimizations that may change the number of exceptions visible with
4950 signaling NaNs.  This option implies @option{-ftrapping-math}.
4952 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
4953 be defined.
4955 The default is @option{-fno-signaling-nans}.
4957 This option is experimental and does not currently guarantee to
4958 disable all GCC optimizations that affect signaling NaN behavior.
4960 @item -fsingle-precision-constant
4961 @opindex fsingle-precision-constant
4962 Treat floating point constant as single precision constant instead of
4963 implicitly converting it to double precision constant.
4966 @end table
4968 The following options control optimizations that may improve
4969 performance, but are not enabled by any @option{-O} options.  This
4970 section includes experimental options that may produce broken code.
4972 @table @gcctabopt
4973 @item -fbranch-probabilities
4974 @opindex fbranch-probabilities
4975 After running a program compiled with @option{-fprofile-arcs}
4976 (@pxref{Debugging Options,, Options for Debugging Your Program or
4977 @command{gcc}}), you can compile it a second time using
4978 @option{-fbranch-probabilities}, to improve optimizations based on
4979 the number of times each branch was taken.  When the program
4980 compiled with @option{-fprofile-arcs} exits it saves arc execution
4981 counts to a file called @file{@var{sourcename}.gcda} for each source
4982 file  The information in this data file is very dependent on the
4983 structure of the generated code, so you must use the same source code
4984 and the same optimization options for both compilations.
4986 With @option{-fbranch-probabilities}, GCC puts a
4987 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
4988 These can be used to improve optimization.  Currently, they are only
4989 used in one place: in @file{reorg.c}, instead of guessing which path a
4990 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
4991 exactly determine which path is taken more often.
4993 @item -fprofile-values
4994 @opindex fprofile-values
4995 If combined with @option{-fprofile-arcs}, it adds code so that some
4996 data about values of expressions in the program is gathered.
4998 With @option{-fbranch-probabilities}, it reads back the data gathered
4999 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5000 notes to instructions for their later usage in optimizations.
5002 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5004 @item -fvpt
5005 @opindex fvpt
5006 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5007 a code to gather information about values of expressions.
5009 With @option{-fbranch-probabilities}, it reads back the data gathered
5010 and actually performs the optimizations based on them.
5011 Currently the optimizations include specialization of division operation
5012 using the knowledge about the value of the denominator.
5014 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5016 @item -frename-registers
5017 @opindex frename-registers
5018 Attempt to avoid false dependencies in scheduled code by making use
5019 of registers left over after register allocation.  This optimization
5020 will most benefit processors with lots of registers.  Depending on the
5021 debug information format adopted by the target, however, it can
5022 make debugging impossible, since variables will no longer stay in
5023 a ``home register''.
5025 Not enabled by default at any level because it has known bugs.
5027 @item -fnew-ra
5028 @opindex fnew-ra
5029 Use a graph coloring register allocator.  Currently this option is meant
5030 for testing, so we are interested to hear about miscompilations with
5031 @option{-fnew-ra}.
5033 @item -ftracer
5034 @opindex ftracer
5035 Perform tail duplication to enlarge superblock size. This transformation
5036 simplifies the control flow of the function allowing other optimizations to do
5037 better job.
5039 Enabled with @option{-fprofile-use}.
5041 @item -funroll-loops
5042 @opindex funroll-loops
5043 Unroll loops whose number of iterations can be determined at compile time or
5044 upon entry to the loop.  @option{-funroll-loops} implies
5045 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5046 (i.e. complete removal of loops with small constant number of iterations).
5047 This option makes code larger, and may or may not make it run faster.
5049 Enabled with @option{-fprofile-use}.
5051 @item -funroll-all-loops
5052 @opindex funroll-all-loops
5053 Unroll all loops, even if their number of iterations is uncertain when
5054 the loop is entered.  This usually makes programs run more slowly.
5055 @option{-funroll-all-loops} implies the same options as
5056 @option{-funroll-loops}.
5058 @item -fpeel-loops
5059 @opindex fpeel-loops
5060 Peels the loops for that there is enough information that they do not
5061 roll much (from profile feedback).  It also turns on complete loop peeling
5062 (i.e. complete removal of loops with small constant number of iterations).
5064 Enabled with @option{-fprofile-use}.
5066 @item -fmove-loop-invariants
5067 @opindex fmove-loop-invariants
5068 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5069 at level @option{-O1}
5071 @item -funswitch-loops
5072 @opindex funswitch-loops
5073 Move branches with loop invariant conditions out of the loop, with duplicates
5074 of the loop on both branches (modified according to result of the condition).
5076 @item -fold-unroll-loops
5077 @opindex fold-unroll-loops
5078 Unroll loops whose number of iterations can be determined at compile
5079 time or upon entry to the loop, using the old loop unroller whose loop
5080 recognition is based on notes from frontend.  @option{-fold-unroll-loops} implies
5081 both @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
5082 option makes code larger, and may or may not make it run faster.
5084 @item -fold-unroll-all-loops
5085 @opindex fold-unroll-all-loops
5086 Unroll all loops, even if their number of iterations is uncertain when
5087 the loop is entered. This is done using the old loop unroller whose loop
5088 recognition is based on notes from frontend.  This usually makes programs run more slowly.
5089 @option{-fold-unroll-all-loops} implies the same options as
5090 @option{-fold-unroll-loops}.
5092 @item -fprefetch-loop-arrays
5093 @opindex fprefetch-loop-arrays
5094 If supported by the target machine, generate instructions to prefetch
5095 memory to improve the performance of loops that access large arrays.
5097 Disabled at level @option{-Os}.
5099 @item -ffunction-sections
5100 @itemx -fdata-sections
5101 @opindex ffunction-sections
5102 @opindex fdata-sections
5103 Place each function or data item into its own section in the output
5104 file if the target supports arbitrary sections.  The name of the
5105 function or the name of the data item determines the section's name
5106 in the output file.
5108 Use these options on systems where the linker can perform optimizations
5109 to improve locality of reference in the instruction space.  Most systems
5110 using the ELF object format and SPARC processors running Solaris 2 have
5111 linkers with such optimizations.  AIX may have these optimizations in
5112 the future.
5114 Only use these options when there are significant benefits from doing
5115 so.  When you specify these options, the assembler and linker will
5116 create larger object and executable files and will also be slower.
5117 You will not be able to use @code{gprof} on all systems if you
5118 specify this option and you may have problems with debugging if
5119 you specify both this option and @option{-g}.
5121 @item -fbranch-target-load-optimize
5122 @opindex fbranch-target-load-optimize
5123 Perform branch target register load optimization before prologue / epilogue
5124 threading.
5125 The use of target registers can typically be exposed only during reload,
5126 thus hoisting loads out of loops and doing inter-block scheduling needs
5127 a separate optimization pass.
5129 @item -fbranch-target-load-optimize2
5130 @opindex fbranch-target-load-optimize2
5131 Perform branch target register load optimization after prologue / epilogue
5132 threading.
5134 @item -fbtr-bb-exclusive
5135 @opindex fbtr-bb-exclusive
5136 When performing branch target register load optimization, don't reuse
5137 branch target registers in within any basic block.
5139 @item --param @var{name}=@var{value}
5140 @opindex param
5141 In some places, GCC uses various constants to control the amount of
5142 optimization that is done.  For example, GCC will not inline functions
5143 that contain more that a certain number of instructions.  You can
5144 control some of these constants on the command-line using the
5145 @option{--param} option.
5147 The names of specific parameters, and the meaning of the values, are
5148 tied to the internals of the compiler, and are subject to change
5149 without notice in future releases.
5151 In each case, the @var{value} is an integer.  The allowable choices for
5152 @var{name} are given in the following table:
5154 @table @gcctabopt
5155 @item max-crossjump-edges
5156 The maximum number of incoming edges to consider for crossjumping.
5157 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5158 the number of edges incoming to each block.  Increasing values mean
5159 more aggressive optimization, making the compile time increase with
5160 probably small improvement in executable size.
5162 @item min-crossjump-insns
5163 The minimum number of instructions which must be matched at the end
5164 of two blocks before crossjumping will be performed on them.  This
5165 value is ignored in the case where all instructions in the block being
5166 crossjumped from are matched.  The default value is 5.
5168 @item max-delay-slot-insn-search
5169 The maximum number of instructions to consider when looking for an
5170 instruction to fill a delay slot.  If more than this arbitrary number of
5171 instructions is searched, the time savings from filling the delay slot
5172 will be minimal so stop searching.  Increasing values mean more
5173 aggressive optimization, making the compile time increase with probably
5174 small improvement in executable run time.
5176 @item max-delay-slot-live-search
5177 When trying to fill delay slots, the maximum number of instructions to
5178 consider when searching for a block with valid live register
5179 information.  Increasing this arbitrarily chosen value means more
5180 aggressive optimization, increasing the compile time.  This parameter
5181 should be removed when the delay slot code is rewritten to maintain the
5182 control-flow graph.
5184 @item max-gcse-memory
5185 The approximate maximum amount of memory that will be allocated in
5186 order to perform the global common subexpression elimination
5187 optimization.  If more memory than specified is required, the
5188 optimization will not be done.
5190 @item max-gcse-passes
5191 The maximum number of passes of GCSE to run.  The default is 1.
5193 @item max-pending-list-length
5194 The maximum number of pending dependencies scheduling will allow
5195 before flushing the current state and starting over.  Large functions
5196 with few branches or calls can create excessively large lists which
5197 needlessly consume memory and resources.
5199 @item max-inline-insns-single
5200 Several parameters control the tree inliner used in gcc.
5201 This number sets the maximum number of instructions (counted in GCC's
5202 internal representation) in a single function that the tree inliner
5203 will consider for inlining.  This only affects functions declared
5204 inline and methods implemented in a class declaration (C++).
5205 The default value is 500.
5207 @item max-inline-insns-auto
5208 When you use @option{-finline-functions} (included in @option{-O3}),
5209 a lot of functions that would otherwise not be considered for inlining
5210 by the compiler will be investigated.  To those functions, a different
5211 (more restrictive) limit compared to functions declared inline can
5212 be applied.
5213 The default value is 120.
5215 @item large-function-insns
5216 The limit specifying really large functions.  For functions greater than this
5217 limit inlining is constrained by @option{--param large-function-growth}.
5218 This parameter is useful primarily to avoid extreme compilation time caused by non-linear
5219 algorithms used by the backend.
5220 This parameter is ignored when @option{-funit-at-a-time} is not used.
5221 The default value is 3000.
5223 @item large-function-growth
5224 Specifies maximal growth of large function caused by inlining in percents.
5225 This parameter is ignored when @option{-funit-at-a-time} is not used.
5226 The default value is 200.
5228 @item inline-unit-growth
5229 Specifies maximal overall growth of the compilation unit caused by inlining.
5230 This parameter is ignored when @option{-funit-at-a-time} is not used.
5231 The default value is 150.
5233 @item max-inline-insns-recursive
5234 @itemx max-inline-insns-recursive-auto
5235 Specifies maximum number of instructions out-of-line copy of self recursive inline
5236 function can grow into by performing recursive inlining.
5238 For functions declared inline @option{--param max-inline-insns-recursive} is
5239 taken into acount.  For function not declared inline, recursive inlining
5240 happens only when @option{-finline-functions} (included in @option{-O3}) is
5241 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5242 default value is 500.
5244 @item max-inline-recursive-depth
5245 @itemx max-inline-recursive-depth-auto
5246 Specifies maximum recursion depth used by the recursive inlining.
5248 For functions declared inline @option{--param max-inline-recursive-depth} is
5249 taken into acount.  For function not declared inline, recursive inlining
5250 happens only when @option{-finline-functions} (included in @option{-O3}) is
5251 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5252 default value is 500.
5254 @item max-inline-insns-rtl
5255 For languages that use the RTL inliner (this happens at a later stage
5256 than tree inlining), you can set the maximum allowable size (counted
5257 in RTL instructions) for the RTL inliner with this parameter.
5258 The default value is 600.
5260 @item max-unrolled-insns
5261 The maximum number of instructions that a loop should have if that loop
5262 is unrolled, and if the loop is unrolled, it determines how many times
5263 the loop code is unrolled.
5265 @item max-average-unrolled-insns
5266 The maximum number of instructions biased by probabilities of their execution
5267 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5268 it determines how many times the loop code is unrolled.
5270 @item max-unroll-times
5271 The maximum number of unrollings of a single loop.
5273 @item max-peeled-insns
5274 The maximum number of instructions that a loop should have if that loop
5275 is peeled, and if the loop is peeled, it determines how many times
5276 the loop code is peeled.
5278 @item max-peel-times
5279 The maximum number of peelings of a single loop.
5281 @item max-completely-peeled-insns
5282 The maximum number of insns of a completely peeled loop.
5284 @item max-completely-peel-times
5285 The maximum number of iterations of a loop to be suitable for complete peeling.
5287 @item max-unswitch-insns
5288 The maximum number of insns of an unswitched loop.
5290 @item max-unswitch-level
5291 The maximum number of branches unswitched in a single loop.
5293 @item lim-expensive
5294 The minimum cost of an expensive expression in the loop invariant motion.
5296 @item max-iterations-to-track
5298 The maximum number of iterations of a loop the brute force algorithm
5299 for analysis of # of iterations of the loop tries to evaluate.
5301 @item hot-bb-count-fraction
5302 Select fraction of the maximal count of repetitions of basic block in program
5303 given basic block needs to have to be considered hot.
5305 @item hot-bb-frequency-fraction
5306 Select fraction of the maximal frequency of executions of basic block in
5307 function given basic block needs to have to be considered hot
5309 @item tracer-dynamic-coverage
5310 @itemx tracer-dynamic-coverage-feedback
5312 This value is used to limit superblock formation once the given percentage of
5313 executed instructions is covered.  This limits unnecessary code size
5314 expansion.
5316 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5317 feedback is available.  The real profiles (as opposed to statically estimated
5318 ones) are much less balanced allowing the threshold to be larger value.
5320 @item tracer-max-code-growth
5321 Stop tail duplication once code growth has reached given percentage.  This is
5322 rather hokey argument, as most of the duplicates will be eliminated later in
5323 cross jumping, so it may be set to much higher values than is the desired code
5324 growth.
5326 @item tracer-min-branch-ratio
5328 Stop reverse growth when the reverse probability of best edge is less than this
5329 threshold (in percent).
5331 @item tracer-min-branch-ratio
5332 @itemx tracer-min-branch-ratio-feedback
5334 Stop forward growth if the best edge do have probability lower than this
5335 threshold.
5337 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5338 compilation for profile feedback and one for compilation without.  The value
5339 for compilation with profile feedback needs to be more conservative (higher) in
5340 order to make tracer effective.
5342 @item max-cse-path-length
5344 Maximum number of basic blocks on path that cse considers.  The default is 10.
5346 @item global-var-threshold
5348 Counts the number of function calls (N) and the number of
5349 call-clobbered variables (V).  If NxV is larger than this limit, a
5350 single artificial variable will be created to represent all the
5351 call-clobbered variables at function call sites.  This artificial
5352 variable will then be made to alias every call-clobbered variable.
5353 (done as int * size_t on the host machine; beware overflow).
5355 @item max-aliased-vops
5357 Maxiumum number of virtual operands allowed to represent aliases
5358 before triggering the alias grouping heuristic.  Alias grouping
5359 reduces compile times and memory consumption needed for aliasing at
5360 the expense of precision loss in alias information.
5362 @item ggc-min-expand
5364 GCC uses a garbage collector to manage its own memory allocation.  This
5365 parameter specifies the minimum percentage by which the garbage
5366 collector's heap should be allowed to expand between collections.
5367 Tuning this may improve compilation speed; it has no effect on code
5368 generation.
5370 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5371 RAM >= 1GB.  If @code{getrlimit} is available, the notion of "RAM" is
5372 the smallest of actual RAM and RLIMIT_DATA or RLIMIT_AS.  If
5373 GCC is not able to calculate RAM on a particular platform, the lower
5374 bound of 30% is used.  Setting this parameter and
5375 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5376 every opportunity.  This is extremely slow, but can be useful for
5377 debugging.
5379 @item ggc-min-heapsize
5381 Minimum size of the garbage collector's heap before it begins bothering
5382 to collect garbage.  The first collection occurs after the heap expands
5383 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5384 tuning this may improve compilation speed, and has no effect on code
5385 generation.
5387 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5388 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5389 with a lower bound of 4096 (four megabytes) and an upper bound of
5390 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5391 particular platform, the lower bound is used.  Setting this parameter
5392 very large effectively disables garbage collection.  Setting this
5393 parameter and @option{ggc-min-expand} to zero causes a full collection
5394 to occur at every opportunity.
5396 @item max-reload-search-insns
5397 The maximum number of instruction reload should look backward for equivalent
5398 register.  Increasing values mean more aggressive optimization, making the
5399 compile time increase with probably slightly better performance.  The default
5400 value is 100.
5402 @item max-cselib-memory-location
5403 The maximum number of memory locations cselib should take into acount.
5404 Increasing values mean more aggressive optimization, making the compile time
5405 increase with probably slightly better performance.  The default value is 500.
5407 @item reorder-blocks-duplicate
5408 @itemx reorder-blocks-duplicate-feedback
5410 Used by basic block reordering pass to decide whether to use unconditional
5411 branch or duplicate the code on its destination.  Code is duplicated when its
5412 estimated size is smaller than this value multiplied by the estimated size of
5413 unconditional jump in the hot spots of the program.
5415 The @option{reorder-block-duplicate-feedback} is used only when profile
5416 feedback is available and may be set to higher values than
5417 @option{reorder-block-duplicate} since information about the hot spots is more
5418 accurate.
5420 @item max-sched-region-blocks
5421 The maximum number of blocks in a region to be considered for
5422 interblock scheduling.  The default value is 10.
5424 @item max-sched-region-insns
5425 The maximum number of insns in a region to be considered for
5426 interblock scheduling.  The default value is 100.
5428 @item integer-share-limit
5429 Small integer constants can use a shared data structure, reducing the
5430 compiler's memory usage and increasing its speed.  This sets the maximum
5431 value of a shared integer constant's.  The default value is 256.
5433 @end table
5434 @end table
5436 @node Preprocessor Options
5437 @section Options Controlling the Preprocessor
5438 @cindex preprocessor options
5439 @cindex options, preprocessor
5441 These options control the C preprocessor, which is run on each C source
5442 file before actual compilation.
5444 If you use the @option{-E} option, nothing is done except preprocessing.
5445 Some of these options make sense only together with @option{-E} because
5446 they cause the preprocessor output to be unsuitable for actual
5447 compilation.
5449 @table @gcctabopt
5450 @opindex Wp
5451 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5452 and pass @var{option} directly through to the preprocessor.  If
5453 @var{option} contains commas, it is split into multiple options at the
5454 commas.  However, many options are modified, translated or interpreted
5455 by the compiler driver before being passed to the preprocessor, and
5456 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5457 interface is undocumented and subject to change, so whenever possible
5458 you should avoid using @option{-Wp} and let the driver handle the
5459 options instead.
5461 @item -Xpreprocessor @var{option}
5462 @opindex preprocessor
5463 Pass @var{option} as an option to the preprocessor.  You can use this to
5464 supply system-specific preprocessor options which GCC does not know how to
5465 recognize.
5467 If you want to pass an option that takes an argument, you must use
5468 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5469 @end table
5471 @include cppopts.texi
5473 @node Assembler Options
5474 @section Passing Options to the Assembler
5476 @c prevent bad page break with this line
5477 You can pass options to the assembler.
5479 @table @gcctabopt
5480 @item -Wa,@var{option}
5481 @opindex Wa
5482 Pass @var{option} as an option to the assembler.  If @var{option}
5483 contains commas, it is split into multiple options at the commas.
5485 @item -Xassembler @var{option}
5486 @opindex Xassembler
5487 Pass @var{option} as an option to the assembler.  You can use this to
5488 supply system-specific assembler options which GCC does not know how to
5489 recognize.
5491 If you want to pass an option that takes an argument, you must use
5492 @option{-Xassembler} twice, once for the option and once for the argument.
5494 @end table
5496 @node Link Options
5497 @section Options for Linking
5498 @cindex link options
5499 @cindex options, linking
5501 These options come into play when the compiler links object files into
5502 an executable output file.  They are meaningless if the compiler is
5503 not doing a link step.
5505 @table @gcctabopt
5506 @cindex file names
5507 @item @var{object-file-name}
5508 A file name that does not end in a special recognized suffix is
5509 considered to name an object file or library.  (Object files are
5510 distinguished from libraries by the linker according to the file
5511 contents.)  If linking is done, these object files are used as input
5512 to the linker.
5514 @item -c
5515 @itemx -S
5516 @itemx -E
5517 @opindex c
5518 @opindex S
5519 @opindex E
5520 If any of these options is used, then the linker is not run, and
5521 object file names should not be used as arguments.  @xref{Overall
5522 Options}.
5524 @cindex Libraries
5525 @item -l@var{library}
5526 @itemx -l @var{library}
5527 @opindex l
5528 Search the library named @var{library} when linking.  (The second
5529 alternative with the library as a separate argument is only for
5530 POSIX compliance and is not recommended.)
5532 It makes a difference where in the command you write this option; the
5533 linker searches and processes libraries and object files in the order they
5534 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5535 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5536 to functions in @samp{z}, those functions may not be loaded.
5538 The linker searches a standard list of directories for the library,
5539 which is actually a file named @file{lib@var{library}.a}.  The linker
5540 then uses this file as if it had been specified precisely by name.
5542 The directories searched include several standard system directories
5543 plus any that you specify with @option{-L}.
5545 Normally the files found this way are library files---archive files
5546 whose members are object files.  The linker handles an archive file by
5547 scanning through it for members which define symbols that have so far
5548 been referenced but not defined.  But if the file that is found is an
5549 ordinary object file, it is linked in the usual fashion.  The only
5550 difference between using an @option{-l} option and specifying a file name
5551 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5552 and searches several directories.
5554 @item -lobjc
5555 @opindex lobjc
5556 You need this special case of the @option{-l} option in order to
5557 link an Objective-C or Objective-C++ program.
5559 @item -nostartfiles
5560 @opindex nostartfiles
5561 Do not use the standard system startup files when linking.
5562 The standard system libraries are used normally, unless @option{-nostdlib}
5563 or @option{-nodefaultlibs} is used.
5565 @item -nodefaultlibs
5566 @opindex nodefaultlibs
5567 Do not use the standard system libraries when linking.
5568 Only the libraries you specify will be passed to the linker.
5569 The standard startup files are used normally, unless @option{-nostartfiles}
5570 is used.  The compiler may generate calls to @code{memcmp},
5571 @code{memset}, @code{memcpy} and @code{memmove}.
5572 These entries are usually resolved by entries in
5573 libc.  These entry points should be supplied through some other
5574 mechanism when this option is specified.
5576 @item -nostdlib
5577 @opindex nostdlib
5578 Do not use the standard system startup files or libraries when linking.
5579 No startup files and only the libraries you specify will be passed to
5580 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5581 @code{memcpy} and @code{memmove}.
5582 These entries are usually resolved by entries in
5583 libc.  These entry points should be supplied through some other
5584 mechanism when this option is specified.
5586 @cindex @option{-lgcc}, use with @option{-nostdlib}
5587 @cindex @option{-nostdlib} and unresolved references
5588 @cindex unresolved references and @option{-nostdlib}
5589 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5590 @cindex @option{-nodefaultlibs} and unresolved references
5591 @cindex unresolved references and @option{-nodefaultlibs}
5592 One of the standard libraries bypassed by @option{-nostdlib} and
5593 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5594 that GCC uses to overcome shortcomings of particular machines, or special
5595 needs for some languages.
5596 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5597 Collection (GCC) Internals},
5598 for more discussion of @file{libgcc.a}.)
5599 In most cases, you need @file{libgcc.a} even when you want to avoid
5600 other standard libraries.  In other words, when you specify @option{-nostdlib}
5601 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5602 This ensures that you have no unresolved references to internal GCC
5603 library subroutines.  (For example, @samp{__main}, used to ensure C++
5604 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5605 GNU Compiler Collection (GCC) Internals}.)
5607 @item -pie
5608 @opindex pie
5609 Produce a position independent executable on targets which support it.
5610 For predictable results, you must also specify the same set of options
5611 that were used to generate code (@option{-fpie}, @option{-fPIE},
5612 or model suboptions) when you specify this option.
5614 @item -s
5615 @opindex s
5616 Remove all symbol table and relocation information from the executable.
5618 @item -static
5619 @opindex static
5620 On systems that support dynamic linking, this prevents linking with the shared
5621 libraries.  On other systems, this option has no effect.
5623 @item -shared
5624 @opindex shared
5625 Produce a shared object which can then be linked with other objects to
5626 form an executable.  Not all systems support this option.  For predictable
5627 results, you must also specify the same set of options that were used to
5628 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5629 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5630 needs to build supplementary stub code for constructors to work.  On
5631 multi-libbed systems, @samp{gcc -shared} must select the correct support
5632 libraries to link against.  Failing to supply the correct flags may lead
5633 to subtle defects.  Supplying them in cases where they are not necessary
5634 is innocuous.}
5636 @item -shared-libgcc
5637 @itemx -static-libgcc
5638 @opindex shared-libgcc
5639 @opindex static-libgcc
5640 On systems that provide @file{libgcc} as a shared library, these options
5641 force the use of either the shared or static version respectively.
5642 If no shared version of @file{libgcc} was built when the compiler was
5643 configured, these options have no effect.
5645 There are several situations in which an application should use the
5646 shared @file{libgcc} instead of the static version.  The most common
5647 of these is when the application wishes to throw and catch exceptions
5648 across different shared libraries.  In that case, each of the libraries
5649 as well as the application itself should use the shared @file{libgcc}.
5651 Therefore, the G++ and GCJ drivers automatically add
5652 @option{-shared-libgcc} whenever you build a shared library or a main
5653 executable, because C++ and Java programs typically use exceptions, so
5654 this is the right thing to do.
5656 If, instead, you use the GCC driver to create shared libraries, you may
5657 find that they will not always be linked with the shared @file{libgcc}.
5658 If GCC finds, at its configuration time, that you have a non-GNU linker
5659 or a GNU linker that does not support option @option{--eh-frame-hdr},
5660 it will link the shared version of @file{libgcc} into shared libraries
5661 by default.  Otherwise, it will take advantage of the linker and optimize
5662 away the linking with the shared version of @file{libgcc}, linking with
5663 the static version of libgcc by default.  This allows exceptions to
5664 propagate through such shared libraries, without incurring relocation
5665 costs at library load time.
5667 However, if a library or main executable is supposed to throw or catch
5668 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5669 for the languages used in the program, or using the option
5670 @option{-shared-libgcc}, such that it is linked with the shared
5671 @file{libgcc}.
5673 @item -symbolic
5674 @opindex symbolic
5675 Bind references to global symbols when building a shared object.  Warn
5676 about any unresolved references (unless overridden by the link editor
5677 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5678 this option.
5680 @item -Xlinker @var{option}
5681 @opindex Xlinker
5682 Pass @var{option} as an option to the linker.  You can use this to
5683 supply system-specific linker options which GCC does not know how to
5684 recognize.
5686 If you want to pass an option that takes an argument, you must use
5687 @option{-Xlinker} twice, once for the option and once for the argument.
5688 For example, to pass @option{-assert definitions}, you must write
5689 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5690 @option{-Xlinker "-assert definitions"}, because this passes the entire
5691 string as a single argument, which is not what the linker expects.
5693 @item -Wl,@var{option}
5694 @opindex Wl
5695 Pass @var{option} as an option to the linker.  If @var{option} contains
5696 commas, it is split into multiple options at the commas.
5698 @item -u @var{symbol}
5699 @opindex u
5700 Pretend the symbol @var{symbol} is undefined, to force linking of
5701 library modules to define it.  You can use @option{-u} multiple times with
5702 different symbols to force loading of additional library modules.
5703 @end table
5705 @node Directory Options
5706 @section Options for Directory Search
5707 @cindex directory options
5708 @cindex options, directory search
5709 @cindex search path
5711 These options specify directories to search for header files, for
5712 libraries and for parts of the compiler:
5714 @table @gcctabopt
5715 @item -I@var{dir}
5716 @opindex I
5717 Add the directory @var{dir} to the head of the list of directories to be
5718 searched for header files.  This can be used to override a system header
5719 file, substituting your own version, since these directories are
5720 searched before the system header file directories.  However, you should
5721 not use this option to add directories that contain vendor-supplied
5722 system header files (use @option{-isystem} for that).  If you use more than
5723 one @option{-I} option, the directories are scanned in left-to-right
5724 order; the standard system directories come after.
5726 If a standard system include directory, or a directory specified with
5727 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5728 option will be ignored.  The directory will still be searched but as a
5729 system directory at its normal position in the system include chain.
5730 This is to ensure that GCC's procedure to fix buggy system headers and
5731 the ordering for the include_next directive are not inadvertently changed.
5732 If you really need to change the search order for system directories,
5733 use the @option{-nostdinc} and/or @option{-isystem} options.
5735 @item -iquote@var{dir}
5736 @opindex iquote
5737 Add the directory @var{dir} to the head of the list of directories to
5738 be searched for header files only for the case of @samp{#include
5739 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5740 otherwise just like @option{-I}.
5742 @item -L@var{dir}
5743 @opindex L
5744 Add directory @var{dir} to the list of directories to be searched
5745 for @option{-l}.
5747 @item -B@var{prefix}
5748 @opindex B
5749 This option specifies where to find the executables, libraries,
5750 include files, and data files of the compiler itself.
5752 The compiler driver program runs one or more of the subprograms
5753 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5754 @var{prefix} as a prefix for each program it tries to run, both with and
5755 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
5757 For each subprogram to be run, the compiler driver first tries the
5758 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
5759 was not specified, the driver tries two standard prefixes, which are
5760 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
5761 those results in a file name that is found, the unmodified program
5762 name is searched for using the directories specified in your
5763 @env{PATH} environment variable.
5765 The compiler will check to see if the path provided by the @option{-B}
5766 refers to a directory, and if necessary it will add a directory
5767 separator character at the end of the path.
5769 @option{-B} prefixes that effectively specify directory names also apply
5770 to libraries in the linker, because the compiler translates these
5771 options into @option{-L} options for the linker.  They also apply to
5772 includes files in the preprocessor, because the compiler translates these
5773 options into @option{-isystem} options for the preprocessor.  In this case,
5774 the compiler appends @samp{include} to the prefix.
5776 The run-time support file @file{libgcc.a} can also be searched for using
5777 the @option{-B} prefix, if needed.  If it is not found there, the two
5778 standard prefixes above are tried, and that is all.  The file is left
5779 out of the link if it is not found by those means.
5781 Another way to specify a prefix much like the @option{-B} prefix is to use
5782 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
5783 Variables}.
5785 As a special kludge, if the path provided by @option{-B} is
5786 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
5787 9, then it will be replaced by @file{[dir/]include}.  This is to help
5788 with boot-strapping the compiler.
5790 @item -specs=@var{file}
5791 @opindex specs
5792 Process @var{file} after the compiler reads in the standard @file{specs}
5793 file, in order to override the defaults that the @file{gcc} driver
5794 program uses when determining what switches to pass to @file{cc1},
5795 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
5796 @option{-specs=@var{file}} can be specified on the command line, and they
5797 are processed in order, from left to right.
5799 @item -I-
5800 @opindex I-
5801 This option has been deprecated.  Please use @option{-iquote} instead for
5802 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
5803 Any directories you specify with @option{-I} options before the @option{-I-}
5804 option are searched only for the case of @samp{#include "@var{file}"};
5805 they are not searched for @samp{#include <@var{file}>}.
5807 If additional directories are specified with @option{-I} options after
5808 the @option{-I-}, these directories are searched for all @samp{#include}
5809 directives.  (Ordinarily @emph{all} @option{-I} directories are used
5810 this way.)
5812 In addition, the @option{-I-} option inhibits the use of the current
5813 directory (where the current input file came from) as the first search
5814 directory for @samp{#include "@var{file}"}.  There is no way to
5815 override this effect of @option{-I-}.  With @option{-I.} you can specify
5816 searching the directory which was current when the compiler was
5817 invoked.  That is not exactly the same as what the preprocessor does
5818 by default, but it is often satisfactory.
5820 @option{-I-} does not inhibit the use of the standard system directories
5821 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
5822 independent.
5823 @end table
5825 @c man end
5827 @node Spec Files
5828 @section Specifying subprocesses and the switches to pass to them
5829 @cindex Spec Files
5831 @command{gcc} is a driver program.  It performs its job by invoking a
5832 sequence of other programs to do the work of compiling, assembling and
5833 linking.  GCC interprets its command-line parameters and uses these to
5834 deduce which programs it should invoke, and which command-line options
5835 it ought to place on their command lines.  This behavior is controlled
5836 by @dfn{spec strings}.  In most cases there is one spec string for each
5837 program that GCC can invoke, but a few programs have multiple spec
5838 strings to control their behavior.  The spec strings built into GCC can
5839 be overridden by using the @option{-specs=} command-line switch to specify
5840 a spec file.
5842 @dfn{Spec files} are plaintext files that are used to construct spec
5843 strings.  They consist of a sequence of directives separated by blank
5844 lines.  The type of directive is determined by the first non-whitespace
5845 character on the line and it can be one of the following:
5847 @table @code
5848 @item %@var{command}
5849 Issues a @var{command} to the spec file processor.  The commands that can
5850 appear here are:
5852 @table @code
5853 @item %include <@var{file}>
5854 @cindex %include
5855 Search for @var{file} and insert its text at the current point in the
5856 specs file.
5858 @item %include_noerr <@var{file}>
5859 @cindex %include_noerr
5860 Just like @samp{%include}, but do not generate an error message if the include
5861 file cannot be found.
5863 @item %rename @var{old_name} @var{new_name}
5864 @cindex %rename
5865 Rename the spec string @var{old_name} to @var{new_name}.
5867 @end table
5869 @item *[@var{spec_name}]:
5870 This tells the compiler to create, override or delete the named spec
5871 string.  All lines after this directive up to the next directive or
5872 blank line are considered to be the text for the spec string.  If this
5873 results in an empty string then the spec will be deleted.  (Or, if the
5874 spec did not exist, then nothing will happened.)  Otherwise, if the spec
5875 does not currently exist a new spec will be created.  If the spec does
5876 exist then its contents will be overridden by the text of this
5877 directive, unless the first character of that text is the @samp{+}
5878 character, in which case the text will be appended to the spec.
5880 @item [@var{suffix}]:
5881 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
5882 and up to the next directive or blank line are considered to make up the
5883 spec string for the indicated suffix.  When the compiler encounters an
5884 input file with the named suffix, it will processes the spec string in
5885 order to work out how to compile that file.  For example:
5887 @smallexample
5888 .ZZ:
5889 z-compile -input %i
5890 @end smallexample
5892 This says that any input file whose name ends in @samp{.ZZ} should be
5893 passed to the program @samp{z-compile}, which should be invoked with the
5894 command-line switch @option{-input} and with the result of performing the
5895 @samp{%i} substitution.  (See below.)
5897 As an alternative to providing a spec string, the text that follows a
5898 suffix directive can be one of the following:
5900 @table @code
5901 @item @@@var{language}
5902 This says that the suffix is an alias for a known @var{language}.  This is
5903 similar to using the @option{-x} command-line switch to GCC to specify a
5904 language explicitly.  For example:
5906 @smallexample
5907 .ZZ:
5908 @@c++
5909 @end smallexample
5911 Says that .ZZ files are, in fact, C++ source files.
5913 @item #@var{name}
5914 This causes an error messages saying:
5916 @smallexample
5917 @var{name} compiler not installed on this system.
5918 @end smallexample
5919 @end table
5921 GCC already has an extensive list of suffixes built into it.
5922 This directive will add an entry to the end of the list of suffixes, but
5923 since the list is searched from the end backwards, it is effectively
5924 possible to override earlier entries using this technique.
5926 @end table
5928 GCC has the following spec strings built into it.  Spec files can
5929 override these strings or create their own.  Note that individual
5930 targets can also add their own spec strings to this list.
5932 @smallexample
5933 asm          Options to pass to the assembler
5934 asm_final    Options to pass to the assembler post-processor
5935 cpp          Options to pass to the C preprocessor
5936 cc1          Options to pass to the C compiler
5937 cc1plus      Options to pass to the C++ compiler
5938 endfile      Object files to include at the end of the link
5939 link         Options to pass to the linker
5940 lib          Libraries to include on the command line to the linker
5941 libgcc       Decides which GCC support library to pass to the linker
5942 linker       Sets the name of the linker
5943 predefines   Defines to be passed to the C preprocessor
5944 signed_char  Defines to pass to CPP to say whether @code{char} is signed
5945              by default
5946 startfile    Object files to include at the start of the link
5947 @end smallexample
5949 Here is a small example of a spec file:
5951 @smallexample
5952 %rename lib                 old_lib
5954 *lib:
5955 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
5956 @end smallexample
5958 This example renames the spec called @samp{lib} to @samp{old_lib} and
5959 then overrides the previous definition of @samp{lib} with a new one.
5960 The new definition adds in some extra command-line options before
5961 including the text of the old definition.
5963 @dfn{Spec strings} are a list of command-line options to be passed to their
5964 corresponding program.  In addition, the spec strings can contain
5965 @samp{%}-prefixed sequences to substitute variable text or to
5966 conditionally insert text into the command line.  Using these constructs
5967 it is possible to generate quite complex command lines.
5969 Here is a table of all defined @samp{%}-sequences for spec
5970 strings.  Note that spaces are not generated automatically around the
5971 results of expanding these sequences.  Therefore you can concatenate them
5972 together or combine them with constant text in a single argument.
5974 @table @code
5975 @item %%
5976 Substitute one @samp{%} into the program name or argument.
5978 @item %i
5979 Substitute the name of the input file being processed.
5981 @item %b
5982 Substitute the basename of the input file being processed.
5983 This is the substring up to (and not including) the last period
5984 and not including the directory.
5986 @item %B
5987 This is the same as @samp{%b}, but include the file suffix (text after
5988 the last period).
5990 @item %d
5991 Marks the argument containing or following the @samp{%d} as a
5992 temporary file name, so that that file will be deleted if GCC exits
5993 successfully.  Unlike @samp{%g}, this contributes no text to the
5994 argument.
5996 @item %g@var{suffix}
5997 Substitute a file name that has suffix @var{suffix} and is chosen
5998 once per compilation, and mark the argument in the same way as
5999 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6000 name is now chosen in a way that is hard to predict even when previously
6001 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6002 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6003 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6004 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6005 was simply substituted with a file name chosen once per compilation,
6006 without regard to any appended suffix (which was therefore treated
6007 just like ordinary text), making such attacks more likely to succeed.
6009 @item %u@var{suffix}
6010 Like @samp{%g}, but generates a new temporary file name even if
6011 @samp{%u@var{suffix}} was already seen.
6013 @item %U@var{suffix}
6014 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6015 new one if there is no such last file name.  In the absence of any
6016 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6017 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6018 would involve the generation of two distinct file names, one
6019 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6020 simply substituted with a file name chosen for the previous @samp{%u},
6021 without regard to any appended suffix.
6023 @item %j@var{suffix}
6024 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6025 writable, and if save-temps is off; otherwise, substitute the name
6026 of a temporary file, just like @samp{%u}.  This temporary file is not
6027 meant for communication between processes, but rather as a junk
6028 disposal mechanism.
6030 @item %|@var{suffix}
6031 @itemx %m@var{suffix}
6032 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6033 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6034 all.  These are the two most common ways to instruct a program that it
6035 should read from standard input or write to standard output.  If you
6036 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6037 construct: see for example @file{f/lang-specs.h}.
6039 @item %.@var{SUFFIX}
6040 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6041 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6042 terminated by the next space or %.
6044 @item %w
6045 Marks the argument containing or following the @samp{%w} as the
6046 designated output file of this compilation.  This puts the argument
6047 into the sequence of arguments that @samp{%o} will substitute later.
6049 @item %o
6050 Substitutes the names of all the output files, with spaces
6051 automatically placed around them.  You should write spaces
6052 around the @samp{%o} as well or the results are undefined.
6053 @samp{%o} is for use in the specs for running the linker.
6054 Input files whose names have no recognized suffix are not compiled
6055 at all, but they are included among the output files, so they will
6056 be linked.
6058 @item %O
6059 Substitutes the suffix for object files.  Note that this is
6060 handled specially when it immediately follows @samp{%g, %u, or %U},
6061 because of the need for those to form complete file names.  The
6062 handling is such that @samp{%O} is treated exactly as if it had already
6063 been substituted, except that @samp{%g, %u, and %U} do not currently
6064 support additional @var{suffix} characters following @samp{%O} as they would
6065 following, for example, @samp{.o}.
6067 @item %p
6068 Substitutes the standard macro predefinitions for the
6069 current target machine.  Use this when running @code{cpp}.
6071 @item %P
6072 Like @samp{%p}, but puts @samp{__} before and after the name of each
6073 predefined macro, except for macros that start with @samp{__} or with
6074 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6077 @item %I
6078 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6079 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6080 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6081 as necessary.
6083 @item %s
6084 Current argument is the name of a library or startup file of some sort.
6085 Search for that file in a standard list of directories and substitute
6086 the full name found.
6088 @item %e@var{str}
6089 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6090 Use this when inconsistent options are detected.
6092 @item %(@var{name})
6093 Substitute the contents of spec string @var{name} at this point.
6095 @item %[@var{name}]
6096 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6098 @item %x@{@var{option}@}
6099 Accumulate an option for @samp{%X}.
6101 @item %X
6102 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6103 spec string.
6105 @item %Y
6106 Output the accumulated assembler options specified by @option{-Wa}.
6108 @item %Z
6109 Output the accumulated preprocessor options specified by @option{-Wp}.
6111 @item %a
6112 Process the @code{asm} spec.  This is used to compute the
6113 switches to be passed to the assembler.
6115 @item %A
6116 Process the @code{asm_final} spec.  This is a spec string for
6117 passing switches to an assembler post-processor, if such a program is
6118 needed.
6120 @item %l
6121 Process the @code{link} spec.  This is the spec for computing the
6122 command line passed to the linker.  Typically it will make use of the
6123 @samp{%L %G %S %D and %E} sequences.
6125 @item %D
6126 Dump out a @option{-L} option for each directory that GCC believes might
6127 contain startup files.  If the target supports multilibs then the
6128 current multilib directory will be prepended to each of these paths.
6130 @item %M
6131 Output the multilib directory with directory separators replaced with
6132 @samp{_}.  If multilib directories are not set, or the multilib directory is
6133 @file{.} then this option emits nothing.
6135 @item %L
6136 Process the @code{lib} spec.  This is a spec string for deciding which
6137 libraries should be included on the command line to the linker.
6139 @item %G
6140 Process the @code{libgcc} spec.  This is a spec string for deciding
6141 which GCC support library should be included on the command line to the linker.
6143 @item %S
6144 Process the @code{startfile} spec.  This is a spec for deciding which
6145 object files should be the first ones passed to the linker.  Typically
6146 this might be a file named @file{crt0.o}.
6148 @item %E
6149 Process the @code{endfile} spec.  This is a spec string that specifies
6150 the last object files that will be passed to the linker.
6152 @item %C
6153 Process the @code{cpp} spec.  This is used to construct the arguments
6154 to be passed to the C preprocessor.
6156 @item %1
6157 Process the @code{cc1} spec.  This is used to construct the options to be
6158 passed to the actual C compiler (@samp{cc1}).
6160 @item %2
6161 Process the @code{cc1plus} spec.  This is used to construct the options to be
6162 passed to the actual C++ compiler (@samp{cc1plus}).
6164 @item %*
6165 Substitute the variable part of a matched option.  See below.
6166 Note that each comma in the substituted string is replaced by
6167 a single space.
6169 @item %<@code{S}
6170 Remove all occurrences of @code{-S} from the command line.  Note---this
6171 command is position dependent.  @samp{%} commands in the spec string
6172 before this one will see @code{-S}, @samp{%} commands in the spec string
6173 after this one will not.
6175 @item %:@var{function}(@var{args})
6176 Call the named function @var{function}, passing it @var{args}.
6177 @var{args} is first processed as a nested spec string, then split
6178 into an argument vector in the usual fashion.  The function returns
6179 a string which is processed as if it had appeared literally as part
6180 of the current spec.
6182 The following built-in spec functions are provided:
6184 @table @code
6185 @item @code{if-exists}
6186 The @code{if-exists} spec function takes one argument, an absolute
6187 pathname to a file.  If the file exists, @code{if-exists} returns the
6188 pathname.  Here is a small example of its usage:
6190 @smallexample
6191 *startfile:
6192 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6193 @end smallexample
6195 @item @code{if-exists-else}
6196 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6197 spec function, except that it takes two arguments.  The first argument is
6198 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6199 returns the pathname.  If it does not exist, it returns the second argument.
6200 This way, @code{if-exists-else} can be used to select one file or another,
6201 based on the existence of the first.  Here is a small example of its usage:
6203 @smallexample
6204 *startfile:
6205 crt0%O%s %:if-exists(crti%O%s) \
6206 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6207 @end smallexample
6208 @end table
6210 @item %@{@code{S}@}
6211 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6212 If that switch was not specified, this substitutes nothing.  Note that
6213 the leading dash is omitted when specifying this option, and it is
6214 automatically inserted if the substitution is performed.  Thus the spec
6215 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6216 and would output the command line option @option{-foo}.
6218 @item %W@{@code{S}@}
6219 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6220 deleted on failure.
6222 @item %@{@code{S}*@}
6223 Substitutes all the switches specified to GCC whose names start
6224 with @code{-S}, but which also take an argument.  This is used for
6225 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6226 GCC considers @option{-o foo} as being
6227 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6228 text, including the space.  Thus two arguments would be generated.
6230 @item %@{@code{S}*&@code{T}*@}
6231 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6232 (the order of @code{S} and @code{T} in the spec is not significant).
6233 There can be any number of ampersand-separated variables; for each the
6234 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6236 @item %@{@code{S}:@code{X}@}
6237 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6239 @item %@{!@code{S}:@code{X}@}
6240 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6242 @item %@{@code{S}*:@code{X}@}
6243 Substitutes @code{X} if one or more switches whose names start with
6244 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6245 once, no matter how many such switches appeared.  However, if @code{%*}
6246 appears somewhere in @code{X}, then @code{X} will be substituted once
6247 for each matching switch, with the @code{%*} replaced by the part of
6248 that switch that matched the @code{*}.
6250 @item %@{.@code{S}:@code{X}@}
6251 Substitutes @code{X}, if processing a file with suffix @code{S}.
6253 @item %@{!.@code{S}:@code{X}@}
6254 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6256 @item %@{@code{S}|@code{P}:@code{X}@}
6257 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6258 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6259 although they have a stronger binding than the @samp{|}.  If @code{%*}
6260 appears in @code{X}, all of the alternatives must be starred, and only
6261 the first matching alternative is substituted.
6263 For example, a spec string like this:
6265 @smallexample
6266 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6267 @end smallexample
6269 will output the following command-line options from the following input
6270 command-line options:
6272 @smallexample
6273 fred.c        -foo -baz
6274 jim.d         -bar -boggle
6275 -d fred.c     -foo -baz -boggle
6276 -d jim.d      -bar -baz -boggle
6277 @end smallexample
6279 @item %@{S:X; T:Y; :D@}
6281 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6282 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6283 be as many clauses as you need.  This may be combined with @code{.},
6284 @code{!}, @code{|}, and @code{*} as needed.
6287 @end table
6289 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6290 construct may contain other nested @samp{%} constructs or spaces, or
6291 even newlines.  They are processed as usual, as described above.
6292 Trailing white space in @code{X} is ignored.  White space may also
6293 appear anywhere on the left side of the colon in these constructs,
6294 except between @code{.} or @code{*} and the corresponding word.
6296 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6297 handled specifically in these constructs.  If another value of
6298 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6299 @option{-W} switch is found later in the command line, the earlier
6300 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6301 just one letter, which passes all matching options.
6303 The character @samp{|} at the beginning of the predicate text is used to
6304 indicate that a command should be piped to the following command, but
6305 only if @option{-pipe} is specified.
6307 It is built into GCC which switches take arguments and which do not.
6308 (You might think it would be useful to generalize this to allow each
6309 compiler's spec to say which switches take arguments.  But this cannot
6310 be done in a consistent fashion.  GCC cannot even decide which input
6311 files have been specified without knowing which switches take arguments,
6312 and it must know which input files to compile in order to tell which
6313 compilers to run).
6315 GCC also knows implicitly that arguments starting in @option{-l} are to be
6316 treated as compiler output files, and passed to the linker in their
6317 proper position among the other output files.
6319 @c man begin OPTIONS
6321 @node Target Options
6322 @section Specifying Target Machine and Compiler Version
6323 @cindex target options
6324 @cindex cross compiling
6325 @cindex specifying machine version
6326 @cindex specifying compiler version and target machine
6327 @cindex compiler version, specifying
6328 @cindex target machine, specifying
6330 The usual way to run GCC is to run the executable called @file{gcc}, or
6331 @file{<machine>-gcc} when cross-compiling, or
6332 @file{<machine>-gcc-<version>} to run a version other than the one that
6333 was installed last.  Sometimes this is inconvenient, so GCC provides
6334 options that will switch to another cross-compiler or version.
6336 @table @gcctabopt
6337 @item -b @var{machine}
6338 @opindex b
6339 The argument @var{machine} specifies the target machine for compilation.
6341 The value to use for @var{machine} is the same as was specified as the
6342 machine type when configuring GCC as a cross-compiler.  For
6343 example, if a cross-compiler was configured with @samp{configure
6344 i386v}, meaning to compile for an 80386 running System V, then you
6345 would specify @option{-b i386v} to run that cross compiler.
6347 @item -V @var{version}
6348 @opindex V
6349 The argument @var{version} specifies which version of GCC to run.
6350 This is useful when multiple versions are installed.  For example,
6351 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6352 @end table
6354 The @option{-V} and @option{-b} options work by running the
6355 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6356 use them if you can just run that directly.
6358 @node Submodel Options
6359 @section Hardware Models and Configurations
6360 @cindex submodel options
6361 @cindex specifying hardware config
6362 @cindex hardware models and configurations, specifying
6363 @cindex machine dependent options
6365 Earlier we discussed the standard option @option{-b} which chooses among
6366 different installed compilers for completely different target
6367 machines, such as VAX vs.@: 68000 vs.@: 80386.
6369 In addition, each of these target machine types can have its own
6370 special options, starting with @samp{-m}, to choose among various
6371 hardware models or configurations---for example, 68010 vs 68020,
6372 floating coprocessor or none.  A single installed version of the
6373 compiler can compile for any model or configuration, according to the
6374 options specified.
6376 Some configurations of the compiler also support additional special
6377 options, usually for compatibility with other compilers on the same
6378 platform.
6380 These options are defined by the macro @code{TARGET_SWITCHES} in the
6381 machine description.  The default for the options is also defined by
6382 that macro, which enables you to change the defaults.
6384 @c This list is ordered alphanumerically by subsection name.
6385 @c It should be the same order and spelling as these options are listed
6386 @c in Machine Dependent Options
6388 @menu
6389 * ARC Options::
6390 * ARM Options::
6391 * AVR Options::
6392 * CRIS Options::
6393 * Darwin Options::
6394 * DEC Alpha Options::
6395 * DEC Alpha/VMS Options::
6396 * FRV Options::
6397 * H8/300 Options::
6398 * HPPA Options::
6399 * i386 and x86-64 Options::
6400 * IA-64 Options::
6401 * M32R/D Options::
6402 * M680x0 Options::
6403 * M68hc1x Options::
6404 * MCore Options::
6405 * MIPS Options::
6406 * MMIX Options::
6407 * MN10300 Options::
6408 * NS32K Options::
6409 * PDP-11 Options::
6410 * PowerPC Options::
6411 * RS/6000 and PowerPC Options::
6412 * S/390 and zSeries Options::
6413 * SH Options::
6414 * SPARC Options::
6415 * System V Options::
6416 * TMS320C3x/C4x Options::
6417 * V850 Options::
6418 * VAX Options::
6419 * x86-64 Options::
6420 * Xstormy16 Options::
6421 * Xtensa Options::
6422 * zSeries Options::
6423 @end menu
6425 @node ARC Options
6426 @subsection ARC Options
6427 @cindex ARC Options
6429 These options are defined for ARC implementations:
6431 @table @gcctabopt
6432 @item -EL
6433 @opindex EL
6434 Compile code for little endian mode.  This is the default.
6436 @item -EB
6437 @opindex EB
6438 Compile code for big endian mode.
6440 @item -mmangle-cpu
6441 @opindex mmangle-cpu
6442 Prepend the name of the cpu to all public symbol names.
6443 In multiple-processor systems, there are many ARC variants with different
6444 instruction and register set characteristics.  This flag prevents code
6445 compiled for one cpu to be linked with code compiled for another.
6446 No facility exists for handling variants that are ``almost identical''.
6447 This is an all or nothing option.
6449 @item -mcpu=@var{cpu}
6450 @opindex mcpu
6451 Compile code for ARC variant @var{cpu}.
6452 Which variants are supported depend on the configuration.
6453 All variants support @option{-mcpu=base}, this is the default.
6455 @item -mtext=@var{text-section}
6456 @itemx -mdata=@var{data-section}
6457 @itemx -mrodata=@var{readonly-data-section}
6458 @opindex mtext
6459 @opindex mdata
6460 @opindex mrodata
6461 Put functions, data, and readonly data in @var{text-section},
6462 @var{data-section}, and @var{readonly-data-section} respectively
6463 by default.  This can be overridden with the @code{section} attribute.
6464 @xref{Variable Attributes}.
6466 @end table
6468 @node ARM Options
6469 @subsection ARM Options
6470 @cindex ARM options
6472 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6473 architectures:
6475 @table @gcctabopt
6476 @item -mabi=@var{name}
6477 @opindex mabi
6478 Generate code for the specified ABI.  Permissible values are: @samp{apcs-gnu},
6479 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6481 @item -mapcs-frame
6482 @opindex mapcs-frame
6483 Generate a stack frame that is compliant with the ARM Procedure Call
6484 Standard for all functions, even if this is not strictly necessary for
6485 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6486 with this option will cause the stack frames not to be generated for
6487 leaf functions.  The default is @option{-mno-apcs-frame}.
6489 @item -mapcs
6490 @opindex mapcs
6491 This is a synonym for @option{-mapcs-frame}.
6493 @ignore
6494 @c not currently implemented
6495 @item -mapcs-stack-check
6496 @opindex mapcs-stack-check
6497 Generate code to check the amount of stack space available upon entry to
6498 every function (that actually uses some stack space).  If there is
6499 insufficient space available then either the function
6500 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6501 called, depending upon the amount of stack space required.  The run time
6502 system is required to provide these functions.  The default is
6503 @option{-mno-apcs-stack-check}, since this produces smaller code.
6505 @c not currently implemented
6506 @item -mapcs-float
6507 @opindex mapcs-float
6508 Pass floating point arguments using the float point registers.  This is
6509 one of the variants of the APCS@.  This option is recommended if the
6510 target hardware has a floating point unit or if a lot of floating point
6511 arithmetic is going to be performed by the code.  The default is
6512 @option{-mno-apcs-float}, since integer only code is slightly increased in
6513 size if @option{-mapcs-float} is used.
6515 @c not currently implemented
6516 @item -mapcs-reentrant
6517 @opindex mapcs-reentrant
6518 Generate reentrant, position independent code.  The default is
6519 @option{-mno-apcs-reentrant}.
6520 @end ignore
6522 @item -mthumb-interwork
6523 @opindex mthumb-interwork
6524 Generate code which supports calling between the ARM and Thumb
6525 instruction sets.  Without this option the two instruction sets cannot
6526 be reliably used inside one program.  The default is
6527 @option{-mno-thumb-interwork}, since slightly larger code is generated
6528 when @option{-mthumb-interwork} is specified.
6530 @item -mno-sched-prolog
6531 @opindex mno-sched-prolog
6532 Prevent the reordering of instructions in the function prolog, or the
6533 merging of those instruction with the instructions in the function's
6534 body.  This means that all functions will start with a recognizable set
6535 of instructions (or in fact one of a choice from a small set of
6536 different function prologues), and this information can be used to
6537 locate the start if functions inside an executable piece of code.  The
6538 default is @option{-msched-prolog}.
6540 @item -mhard-float
6541 @opindex mhard-float
6542 Generate output containing floating point instructions.  This is the
6543 default.
6545 @item -msoft-float
6546 @opindex msoft-float
6547 Generate output containing library calls for floating point.
6548 @strong{Warning:} the requisite libraries are not available for all ARM
6549 targets.  Normally the facilities of the machine's usual C compiler are
6550 used, but this cannot be done directly in cross-compilation.  You must make
6551 your own arrangements to provide suitable library functions for
6552 cross-compilation.
6554 @option{-msoft-float} changes the calling convention in the output file;
6555 therefore, it is only useful if you compile @emph{all} of a program with
6556 this option.  In particular, you need to compile @file{libgcc.a}, the
6557 library that comes with GCC, with @option{-msoft-float} in order for
6558 this to work.
6560 @item -mfloat-abi=@var{name}
6561 @opindex mfloat-abi
6562 Specifies which ABI to use for floating point values.  Permissible values
6563 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6565 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6566 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6567 of floating point instructions, but still uses the soft-float calling
6568 conventions.
6570 @item -mlittle-endian
6571 @opindex mlittle-endian
6572 Generate code for a processor running in little-endian mode.  This is
6573 the default for all standard configurations.
6575 @item -mbig-endian
6576 @opindex mbig-endian
6577 Generate code for a processor running in big-endian mode; the default is
6578 to compile code for a little-endian processor.
6580 @item -mwords-little-endian
6581 @opindex mwords-little-endian
6582 This option only applies when generating code for big-endian processors.
6583 Generate code for a little-endian word order but a big-endian byte
6584 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6585 option should only be used if you require compatibility with code for
6586 big-endian ARM processors generated by versions of the compiler prior to
6587 2.8.
6589 @item -mcpu=@var{name}
6590 @opindex mcpu
6591 This specifies the name of the target ARM processor.  GCC uses this name
6592 to determine what kind of instructions it can emit when generating
6593 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6594 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6595 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6596 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6597 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6598 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm8},
6599 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6600 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6601 @samp{arm920t}, @samp{arm922t}, @samp{arm946es}, @samp{arm966es},
6602 @samp{arm968es}, @samp{arm926ejs}, @samp{arm940t}, @samp{arm9tdmi},
6603 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ejs},
6604 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6605 @samp{arm1136js}, @samp{arm1136jfs} ,@samp{xscale}, @samp{iwmmxt},
6606 @samp{ep9312}.
6608 @itemx -mtune=@var{name}
6609 @opindex mtune
6610 This option is very similar to the @option{-mcpu=} option, except that
6611 instead of specifying the actual target processor type, and hence
6612 restricting which instructions can be used, it specifies that GCC should
6613 tune the performance of the code as if the target were of the type
6614 specified in this option, but still choosing the instructions that it
6615 will generate based on the cpu specified by a @option{-mcpu=} option.
6616 For some ARM implementations better performance can be obtained by using
6617 this option.
6619 @item -march=@var{name}
6620 @opindex march
6621 This specifies the name of the target ARM architecture.  GCC uses this
6622 name to determine what kind of instructions it can emit when generating
6623 assembly code.  This option can be used in conjunction with or instead
6624 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6625 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6626 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6627 @samp{iwmmxt}, @samp{ep9312}.
6629 @item -mfpu=@var{name}
6630 @itemx -mfpe=@var{number}
6631 @itemx -mfp=@var{number}
6632 @opindex mfpu
6633 @opindex mfpe
6634 @opindex mfp
6635 This specifies what floating point hardware (or hardware emulation) is
6636 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6637 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6638 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6639 with older versions of GCC@.
6641 If @option{-msoft-float} is specified this specifies the format of
6642 floating point values.
6644 @item -mstructure-size-boundary=@var{n}
6645 @opindex mstructure-size-boundary
6646 The size of all structures and unions will be rounded up to a multiple
6647 of the number of bits set by this option.  Permissible values are 8, 32
6648 and 64.  The default value varies for different toolchains.  For the COFF
6649 targeted toolchain the default value is 8.  A value of 64 is only allowed
6650 if the underlying ABI supports it.
6652 Specifying the larger number can produce faster, more efficient code, but
6653 can also increase the size of the program.  Different values are potentially
6654 incompatible.  Code compiled with one value cannot necessarily expect to
6655 work with code or libraries compiled with another value, if they exchange
6656 information using structures or unions.
6658 @item -mabort-on-noreturn
6659 @opindex mabort-on-noreturn
6660 Generate a call to the function @code{abort} at the end of a
6661 @code{noreturn} function.  It will be executed if the function tries to
6662 return.
6664 @item -mlong-calls
6665 @itemx -mno-long-calls
6666 @opindex mlong-calls
6667 @opindex mno-long-calls
6668 Tells the compiler to perform function calls by first loading the
6669 address of the function into a register and then performing a subroutine
6670 call on this register.  This switch is needed if the target function
6671 will lie outside of the 64 megabyte addressing range of the offset based
6672 version of subroutine call instruction.
6674 Even if this switch is enabled, not all function calls will be turned
6675 into long calls.  The heuristic is that static functions, functions
6676 which have the @samp{short-call} attribute, functions that are inside
6677 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6678 definitions have already been compiled within the current compilation
6679 unit, will not be turned into long calls.  The exception to this rule is
6680 that weak function definitions, functions with the @samp{long-call}
6681 attribute or the @samp{section} attribute, and functions that are within
6682 the scope of a @samp{#pragma long_calls} directive, will always be
6683 turned into long calls.
6685 This feature is not enabled by default.  Specifying
6686 @option{-mno-long-calls} will restore the default behavior, as will
6687 placing the function calls within the scope of a @samp{#pragma
6688 long_calls_off} directive.  Note these switches have no effect on how
6689 the compiler generates code to handle function calls via function
6690 pointers.
6692 @item -mnop-fun-dllimport
6693 @opindex mnop-fun-dllimport
6694 Disable support for the @code{dllimport} attribute.
6696 @item -msingle-pic-base
6697 @opindex msingle-pic-base
6698 Treat the register used for PIC addressing as read-only, rather than
6699 loading it in the prologue for each function.  The run-time system is
6700 responsible for initializing this register with an appropriate value
6701 before execution begins.
6703 @item -mpic-register=@var{reg}
6704 @opindex mpic-register
6705 Specify the register to be used for PIC addressing.  The default is R10
6706 unless stack-checking is enabled, when R9 is used.
6708 @item -mcirrus-fix-invalid-insns
6709 @opindex mcirrus-fix-invalid-insns
6710 @opindex mno-cirrus-fix-invalid-insns
6711 Insert NOPs into the instruction stream to in order to work around
6712 problems with invalid Maverick instruction combinations.  This option
6713 is only valid if the @option{-mcpu=ep9312} option has been used to
6714 enable generation of instructions for the Cirrus Maverick floating
6715 point co-processor.  This option is not enabled by default, since the
6716 problem is only present in older Maverick implementations.  The default
6717 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6718 switch.
6720 @item -mpoke-function-name
6721 @opindex mpoke-function-name
6722 Write the name of each function into the text section, directly
6723 preceding the function prologue.  The generated code is similar to this:
6725 @smallexample
6726      t0
6727          .ascii "arm_poke_function_name", 0
6728          .align
6729      t1
6730          .word 0xff000000 + (t1 - t0)
6731      arm_poke_function_name
6732          mov     ip, sp
6733          stmfd   sp!, @{fp, ip, lr, pc@}
6734          sub     fp, ip, #4
6735 @end smallexample
6737 When performing a stack backtrace, code can inspect the value of
6738 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6739 location @code{pc - 12} and the top 8 bits are set, then we know that
6740 there is a function name embedded immediately preceding this location
6741 and has length @code{((pc[-3]) & 0xff000000)}.
6743 @item -mthumb
6744 @opindex mthumb
6745 Generate code for the 16-bit Thumb instruction set.  The default is to
6746 use the 32-bit ARM instruction set.
6748 @item -mtpcs-frame
6749 @opindex mtpcs-frame
6750 Generate a stack frame that is compliant with the Thumb Procedure Call
6751 Standard for all non-leaf functions.  (A leaf function is one that does
6752 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
6754 @item -mtpcs-leaf-frame
6755 @opindex mtpcs-leaf-frame
6756 Generate a stack frame that is compliant with the Thumb Procedure Call
6757 Standard for all leaf functions.  (A leaf function is one that does
6758 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
6760 @item -mcallee-super-interworking
6761 @opindex mcallee-super-interworking
6762 Gives all externally visible functions in the file being compiled an ARM
6763 instruction set header which switches to Thumb mode before executing the
6764 rest of the function.  This allows these functions to be called from
6765 non-interworking code.
6767 @item -mcaller-super-interworking
6768 @opindex mcaller-super-interworking
6769 Allows calls via function pointers (including virtual functions) to
6770 execute correctly regardless of whether the target code has been
6771 compiled for interworking or not.  There is a small overhead in the cost
6772 of executing a function pointer if this option is enabled.
6774 @end table
6776 @node AVR Options
6777 @subsection AVR Options
6778 @cindex AVR Options
6780 These options are defined for AVR implementations:
6782 @table @gcctabopt
6783 @item -mmcu=@var{mcu}
6784 @opindex mmcu
6785 Specify ATMEL AVR instruction set or MCU type.
6787 Instruction set avr1 is for the minimal AVR core, not supported by the C
6788 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
6789 attiny11, attiny12, attiny15, attiny28).
6791 Instruction set avr2 (default) is for the classic AVR core with up to
6792 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
6793 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
6794 at90c8534, at90s8535).
6796 Instruction set avr3 is for the classic AVR core with up to 128K program
6797 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
6799 Instruction set avr4 is for the enhanced AVR core with up to 8K program
6800 memory space (MCU types: atmega8, atmega83, atmega85).
6802 Instruction set avr5 is for the enhanced AVR core with up to 128K program
6803 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
6804 atmega64, atmega128, at43usb355, at94k).
6806 @item -msize
6807 @opindex msize
6808 Output instruction sizes to the asm file.
6810 @item -minit-stack=@var{N}
6811 @opindex minit-stack
6812 Specify the initial stack address, which may be a symbol or numeric value,
6813 @samp{__stack} is the default.
6815 @item -mno-interrupts
6816 @opindex mno-interrupts
6817 Generated code is not compatible with hardware interrupts.
6818 Code size will be smaller.
6820 @item -mcall-prologues
6821 @opindex mcall-prologues
6822 Functions prologues/epilogues expanded as call to appropriate
6823 subroutines.  Code size will be smaller.
6825 @item -mno-tablejump
6826 @opindex mno-tablejump
6827 Do not generate tablejump insns which sometimes increase code size.
6829 @item -mtiny-stack
6830 @opindex mtiny-stack
6831 Change only the low 8 bits of the stack pointer.
6833 @item -mint8
6834 @opindex mint8
6835 Assume int to be 8 bit integer. This affects the sizes of all types: A
6836 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
6837 and long long will be 4 bytes. Please note that this option does not
6838 comply to the C standards, but it will provide you with smaller code
6839 size.
6840 @end table
6842 @node CRIS Options
6843 @subsection CRIS Options
6844 @cindex CRIS Options
6846 These options are defined specifically for the CRIS ports.
6848 @table @gcctabopt
6849 @item -march=@var{architecture-type}
6850 @itemx -mcpu=@var{architecture-type}
6851 @opindex march
6852 @opindex mcpu
6853 Generate code for the specified architecture.  The choices for
6854 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
6855 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX.
6856 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
6857 @samp{v10}.
6859 @item -mtune=@var{architecture-type}
6860 @opindex mtune
6861 Tune to @var{architecture-type} everything applicable about the generated
6862 code, except for the ABI and the set of available instructions.  The
6863 choices for @var{architecture-type} are the same as for
6864 @option{-march=@var{architecture-type}}.
6866 @item -mmax-stack-frame=@var{n}
6867 @opindex mmax-stack-frame
6868 Warn when the stack frame of a function exceeds @var{n} bytes.
6870 @item -melinux-stacksize=@var{n}
6871 @opindex melinux-stacksize
6872 Only available with the @samp{cris-axis-aout} target.  Arranges for
6873 indications in the program to the kernel loader that the stack of the
6874 program should be set to @var{n} bytes.
6876 @item -metrax4
6877 @itemx -metrax100
6878 @opindex metrax4
6879 @opindex metrax100
6880 The options @option{-metrax4} and @option{-metrax100} are synonyms for
6881 @option{-march=v3} and @option{-march=v8} respectively.
6883 @item -mmul-bug-workaround
6884 @itemx -mno-mul-bug-workaround
6885 @opindex mmul-bug-workaround
6886 @opindex mno-mul-bug-workaround
6887 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
6888 models where it applies.  This option is active by default.
6890 @item -mpdebug
6891 @opindex mpdebug
6892 Enable CRIS-specific verbose debug-related information in the assembly
6893 code.  This option also has the effect to turn off the @samp{#NO_APP}
6894 formatted-code indicator to the assembler at the beginning of the
6895 assembly file.
6897 @item -mcc-init
6898 @opindex mcc-init
6899 Do not use condition-code results from previous instruction; always emit
6900 compare and test instructions before use of condition codes.
6902 @item -mno-side-effects
6903 @opindex mno-side-effects
6904 Do not emit instructions with side-effects in addressing modes other than
6905 post-increment.
6907 @item -mstack-align
6908 @itemx -mno-stack-align
6909 @itemx -mdata-align
6910 @itemx -mno-data-align
6911 @itemx -mconst-align
6912 @itemx -mno-const-align
6913 @opindex mstack-align
6914 @opindex mno-stack-align
6915 @opindex mdata-align
6916 @opindex mno-data-align
6917 @opindex mconst-align
6918 @opindex mno-const-align
6919 These options (no-options) arranges (eliminate arrangements) for the
6920 stack-frame, individual data and constants to be aligned for the maximum
6921 single data access size for the chosen CPU model.  The default is to
6922 arrange for 32-bit alignment.  ABI details such as structure layout are
6923 not affected by these options.
6925 @item -m32-bit
6926 @itemx -m16-bit
6927 @itemx -m8-bit
6928 @opindex m32-bit
6929 @opindex m16-bit
6930 @opindex m8-bit
6931 Similar to the stack- data- and const-align options above, these options
6932 arrange for stack-frame, writable data and constants to all be 32-bit,
6933 16-bit or 8-bit aligned.  The default is 32-bit alignment.
6935 @item -mno-prologue-epilogue
6936 @itemx -mprologue-epilogue
6937 @opindex mno-prologue-epilogue
6938 @opindex mprologue-epilogue
6939 With @option{-mno-prologue-epilogue}, the normal function prologue and
6940 epilogue that sets up the stack-frame are omitted and no return
6941 instructions or return sequences are generated in the code.  Use this
6942 option only together with visual inspection of the compiled code: no
6943 warnings or errors are generated when call-saved registers must be saved,
6944 or storage for local variable needs to be allocated.
6946 @item -mno-gotplt
6947 @itemx -mgotplt
6948 @opindex mno-gotplt
6949 @opindex mgotplt
6950 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
6951 instruction sequences that load addresses for functions from the PLT part
6952 of the GOT rather than (traditional on other architectures) calls to the
6953 PLT.  The default is @option{-mgotplt}.
6955 @item -maout
6956 @opindex maout
6957 Legacy no-op option only recognized with the cris-axis-aout target.
6959 @item -melf
6960 @opindex melf
6961 Legacy no-op option only recognized with the cris-axis-elf and
6962 cris-axis-linux-gnu targets.
6964 @item -melinux
6965 @opindex melinux
6966 Only recognized with the cris-axis-aout target, where it selects a
6967 GNU/linux-like multilib, include files and instruction set for
6968 @option{-march=v8}.
6970 @item -mlinux
6971 @opindex mlinux
6972 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
6974 @item -sim
6975 @opindex sim
6976 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
6977 to link with input-output functions from a simulator library.  Code,
6978 initialized data and zero-initialized data are allocated consecutively.
6980 @item -sim2
6981 @opindex sim2
6982 Like @option{-sim}, but pass linker options to locate initialized data at
6983 0x40000000 and zero-initialized data at 0x80000000.
6984 @end table
6986 @node Darwin Options
6987 @subsection Darwin Options
6988 @cindex Darwin options
6990 These options are defined for all architectures running the Darwin operating
6991 system.  They are useful for compatibility with other Mac OS compilers.
6993 @table @gcctabopt
6994 @item -F@var{dir}
6995 @opindex F
6996 Add the framework directory @var{dir} to the head of the list of
6997 directories to be searched for header files.  These directories are
6998 interleaved with those specified by @option{-I} options and are
6999 scanned in a left-to-right order.
7001 A framework directory is a directory with frameworks in it.  A
7002 framework is a directory with a @samp{"Headers"} and/or
7003 @samp{"PrivateHeaders"} directory contained directly in it that ends
7004 in @samp{".framework"}.  The name of a framework is the name of this
7005 directory excluding the @samp{".framework"}.  Headers associated with
7006 the framework are found in one of those two directories, with
7007 @samp{"Headers"} being searched first.  A subframework is a framework
7008 directory that is in a framework's @samp{"Frameworks"} directory.
7009 Includes of subframework headers can only appear in a header of a
7010 framework that contains the subframework, or in a sibling subframework
7011 header.  Two subframeworks are siblings if they occur in the same
7012 framework.  A subframework should not have the same name as a
7013 framework, a warning will be issued if this is violated.  Currently a
7014 subframework cannot have subframeworks, in the future, the mechanism
7015 may be extended to support this.  The standard frameworks can be found
7016 in @samp{"/System/Library/Frameworks"} and
7017 @samp{"/Library/Frameworks"}.  An example include looks like
7018 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7019 the name of the framework and header.h is found in the
7020 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7022 @item -gused
7023 @opindex -gused
7024 Emit debugging information for symbols that are used. For STABS
7025 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7026 This is by default ON.
7028 @item -gfull
7029 @opindex -gfull
7030 Emit debugging information for all symbols and types.
7032 @item -mone-byte-bool
7033 @opindex -mone-byte-bool
7034 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7035 By default @samp{sizeof(bool)} is @samp{4} when compiling for 
7036 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7037 option has no effect on x86.
7039 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7040 to generate code that is not binary compatible with code generated
7041 without that switch.  Using this switch may require recompiling all
7042 other modules in a program, including system libraries.  Use this 
7043 switch to conform to a non-default data model.
7045 @item -mfix-and-continue
7046 @itemx -ffix-and-continue
7047 @itemx -findirect-data
7048 @opindex mfix-and-continue
7049 @opindex ffix-and-continue
7050 @opindex findirect-data
7051 Generate code suitable for fast turn around development.  Needed to
7052 enable gdb to dynamically load @code{.o} files into already running
7053 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7054 are provided for backwards compatibility.
7056 @item -all_load
7057 @opindex all_load
7058 Loads all members of static archive libraries.
7059 See man ld(1) for more information.
7061 @item -arch_errors_fatal
7062 @opindex arch_errors_fatal
7063 Cause the errors having to do with files that have the wrong architecture
7064 to be fatal.
7066 @item -bind_at_load
7067 @opindex bind_at_load
7068 Causes the output file to be marked such that the dynamic linker will
7069 bind all undefined references when the file is loaded or launched.
7071 @item -bundle
7072 @opindex bundle
7073 Produce a Mach-o bundle format file.
7074 See man ld(1) for more information.
7076 @item -bundle_loader @var{executable}
7077 @opindex bundle_loader
7078 This specifies the @var{executable} that will be loading the build
7079 output file being linked. See man ld(1) for more information.
7081 @item -allowable_client  @var{client_name}
7082 @itemx -arch_only
7084 @itemx -client_name
7085 @itemx -compatibility_version
7086 @itemx -current_version
7087 @itemx -dead_strip
7088 @itemx -dependency-file
7089 @itemx -dylib_file
7090 @itemx -dylinker_install_name
7091 @itemx -dynamic
7092 @itemx -dynamiclib
7093 @itemx -exported_symbols_list
7094 @itemx -filelist
7095 @itemx -flat_namespace
7096 @itemx -force_cpusubtype_ALL
7097 @itemx -force_flat_namespace
7098 @itemx -headerpad_max_install_names
7099 @itemx -image_base
7100 @itemx -init
7101 @itemx -install_name
7102 @itemx -keep_private_externs
7103 @itemx -multi_module
7104 @itemx -multiply_defined
7105 @itemx -multiply_defined_unused
7106 @itemx -noall_load
7107 @itemx -no_dead_strip_inits_and_terms
7108 @itemx -nofixprebinding
7109 @itemx -nomultidefs
7110 @itemx -noprebind
7111 @itemx -noseglinkedit
7112 @itemx -pagezero_size
7113 @itemx -prebind
7114 @itemx -prebind_all_twolevel_modules
7115 @itemx -private_bundle
7116 @itemx -read_only_relocs
7117 @itemx -sectalign
7118 @itemx -sectobjectsymbols
7119 @itemx -whyload
7120 @itemx -seg1addr
7121 @itemx -sectcreate
7122 @itemx -sectobjectsymbols
7123 @itemx -sectorder
7124 @itemx -seg_addr_table
7125 @itemx -seg_addr_table_filename
7126 @itemx -seglinkedit
7127 @itemx -segprot
7128 @itemx -segs_read_only_addr
7129 @itemx -segs_read_write_addr
7130 @itemx -single_module
7131 @itemx -static
7132 @itemx -sub_library
7133 @itemx -sub_umbrella
7134 @itemx -twolevel_namespace
7135 @itemx -umbrella
7136 @itemx -undefined
7137 @itemx -unexported_symbols_list
7138 @itemx -weak_reference_mismatches
7139 @itemx -whatsloaded
7141 @opindex allowable_client
7142 @opindex arch_only
7143 @opindex client_name
7144 @opindex compatibility_version
7145 @opindex current_version
7146 @opindex dead_strip
7147 @opindex dependency-file
7148 @opindex dylib_file
7149 @opindex dylinker_install_name
7150 @opindex dynamic
7151 @opindex dynamiclib
7152 @opindex exported_symbols_list
7153 @opindex filelist
7154 @opindex flat_namespace
7155 @opindex force_cpusubtype_ALL
7156 @opindex force_flat_namespace
7157 @opindex headerpad_max_install_names
7158 @opindex image_base
7159 @opindex init
7160 @opindex install_name
7161 @opindex keep_private_externs
7162 @opindex multi_module
7163 @opindex multiply_defined
7164 @opindex multiply_defined_unused
7165 @opindex noall_load
7166 @opindex no_dead_strip_inits_and_terms
7167 @opindex nofixprebinding
7168 @opindex nomultidefs
7169 @opindex noprebind
7170 @opindex noseglinkedit
7171 @opindex pagezero_size
7172 @opindex prebind
7173 @opindex prebind_all_twolevel_modules
7174 @opindex private_bundle
7175 @opindex read_only_relocs
7176 @opindex sectalign
7177 @opindex sectobjectsymbols
7178 @opindex whyload
7179 @opindex seg1addr
7180 @opindex sectcreate
7181 @opindex sectobjectsymbols
7182 @opindex sectorder
7183 @opindex seg_addr_table
7184 @opindex seg_addr_table_filename
7185 @opindex seglinkedit
7186 @opindex segprot
7187 @opindex segs_read_only_addr
7188 @opindex segs_read_write_addr
7189 @opindex single_module
7190 @opindex static
7191 @opindex sub_library
7192 @opindex sub_umbrella
7193 @opindex twolevel_namespace
7194 @opindex umbrella
7195 @opindex undefined
7196 @opindex unexported_symbols_list
7197 @opindex weak_reference_mismatches
7198 @opindex whatsloaded
7200 These options are available for Darwin linker. Darwin linker man page
7201 describes them in detail.
7202 @end table
7204 @node DEC Alpha Options
7205 @subsection DEC Alpha Options
7207 These @samp{-m} options are defined for the DEC Alpha implementations:
7209 @table @gcctabopt
7210 @item -mno-soft-float
7211 @itemx -msoft-float
7212 @opindex mno-soft-float
7213 @opindex msoft-float
7214 Use (do not use) the hardware floating-point instructions for
7215 floating-point operations.  When @option{-msoft-float} is specified,
7216 functions in @file{libgcc.a} will be used to perform floating-point
7217 operations.  Unless they are replaced by routines that emulate the
7218 floating-point operations, or compiled in such a way as to call such
7219 emulations routines, these routines will issue floating-point
7220 operations.   If you are compiling for an Alpha without floating-point
7221 operations, you must ensure that the library is built so as not to call
7222 them.
7224 Note that Alpha implementations without floating-point operations are
7225 required to have floating-point registers.
7227 @item -mfp-reg
7228 @itemx -mno-fp-regs
7229 @opindex mfp-reg
7230 @opindex mno-fp-regs
7231 Generate code that uses (does not use) the floating-point register set.
7232 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7233 register set is not used, floating point operands are passed in integer
7234 registers as if they were integers and floating-point results are passed
7235 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7236 so any function with a floating-point argument or return value called by code
7237 compiled with @option{-mno-fp-regs} must also be compiled with that
7238 option.
7240 A typical use of this option is building a kernel that does not use,
7241 and hence need not save and restore, any floating-point registers.
7243 @item -mieee
7244 @opindex mieee
7245 The Alpha architecture implements floating-point hardware optimized for
7246 maximum performance.  It is mostly compliant with the IEEE floating
7247 point standard.  However, for full compliance, software assistance is
7248 required.  This option generates code fully IEEE compliant code
7249 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7250 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7251 defined during compilation.  The resulting code is less efficient but is
7252 able to correctly support denormalized numbers and exceptional IEEE
7253 values such as not-a-number and plus/minus infinity.  Other Alpha
7254 compilers call this option @option{-ieee_with_no_inexact}.
7256 @item -mieee-with-inexact
7257 @opindex mieee-with-inexact
7258 This is like @option{-mieee} except the generated code also maintains
7259 the IEEE @var{inexact-flag}.  Turning on this option causes the
7260 generated code to implement fully-compliant IEEE math.  In addition to
7261 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7262 macro.  On some Alpha implementations the resulting code may execute
7263 significantly slower than the code generated by default.  Since there is
7264 very little code that depends on the @var{inexact-flag}, you should
7265 normally not specify this option.  Other Alpha compilers call this
7266 option @option{-ieee_with_inexact}.
7268 @item -mfp-trap-mode=@var{trap-mode}
7269 @opindex mfp-trap-mode
7270 This option controls what floating-point related traps are enabled.
7271 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7272 The trap mode can be set to one of four values:
7274 @table @samp
7275 @item n
7276 This is the default (normal) setting.  The only traps that are enabled
7277 are the ones that cannot be disabled in software (e.g., division by zero
7278 trap).
7280 @item u
7281 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7282 as well.
7284 @item su
7285 Like @samp{su}, but the instructions are marked to be safe for software
7286 completion (see Alpha architecture manual for details).
7288 @item sui
7289 Like @samp{su}, but inexact traps are enabled as well.
7290 @end table
7292 @item -mfp-rounding-mode=@var{rounding-mode}
7293 @opindex mfp-rounding-mode
7294 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7295 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7298 @table @samp
7299 @item n
7300 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7301 the nearest machine number or towards the even machine number in case
7302 of a tie.
7304 @item m
7305 Round towards minus infinity.
7307 @item c
7308 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7310 @item d
7311 Dynamic rounding mode.  A field in the floating point control register
7312 (@var{fpcr}, see Alpha architecture reference manual) controls the
7313 rounding mode in effect.  The C library initializes this register for
7314 rounding towards plus infinity.  Thus, unless your program modifies the
7315 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7316 @end table
7318 @item -mtrap-precision=@var{trap-precision}
7319 @opindex mtrap-precision
7320 In the Alpha architecture, floating point traps are imprecise.  This
7321 means without software assistance it is impossible to recover from a
7322 floating trap and program execution normally needs to be terminated.
7323 GCC can generate code that can assist operating system trap handlers
7324 in determining the exact location that caused a floating point trap.
7325 Depending on the requirements of an application, different levels of
7326 precisions can be selected:
7328 @table @samp
7329 @item p
7330 Program precision.  This option is the default and means a trap handler
7331 can only identify which program caused a floating point exception.
7333 @item f
7334 Function precision.  The trap handler can determine the function that
7335 caused a floating point exception.
7337 @item i
7338 Instruction precision.  The trap handler can determine the exact
7339 instruction that caused a floating point exception.
7340 @end table
7342 Other Alpha compilers provide the equivalent options called
7343 @option{-scope_safe} and @option{-resumption_safe}.
7345 @item -mieee-conformant
7346 @opindex mieee-conformant
7347 This option marks the generated code as IEEE conformant.  You must not
7348 use this option unless you also specify @option{-mtrap-precision=i} and either
7349 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7350 is to emit the line @samp{.eflag 48} in the function prologue of the
7351 generated assembly file.  Under DEC Unix, this has the effect that
7352 IEEE-conformant math library routines will be linked in.
7354 @item -mbuild-constants
7355 @opindex mbuild-constants
7356 Normally GCC examines a 32- or 64-bit integer constant to
7357 see if it can construct it from smaller constants in two or three
7358 instructions.  If it cannot, it will output the constant as a literal and
7359 generate code to load it from the data segment at runtime.
7361 Use this option to require GCC to construct @emph{all} integer constants
7362 using code, even if it takes more instructions (the maximum is six).
7364 You would typically use this option to build a shared library dynamic
7365 loader.  Itself a shared library, it must relocate itself in memory
7366 before it can find the variables and constants in its own data segment.
7368 @item -malpha-as
7369 @itemx -mgas
7370 @opindex malpha-as
7371 @opindex mgas
7372 Select whether to generate code to be assembled by the vendor-supplied
7373 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7375 @item -mbwx
7376 @itemx -mno-bwx
7377 @itemx -mcix
7378 @itemx -mno-cix
7379 @itemx -mfix
7380 @itemx -mno-fix
7381 @itemx -mmax
7382 @itemx -mno-max
7383 @opindex mbwx
7384 @opindex mno-bwx
7385 @opindex mcix
7386 @opindex mno-cix
7387 @opindex mfix
7388 @opindex mno-fix
7389 @opindex mmax
7390 @opindex mno-max
7391 Indicate whether GCC should generate code to use the optional BWX,
7392 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7393 sets supported by the CPU type specified via @option{-mcpu=} option or that
7394 of the CPU on which GCC was built if none was specified.
7396 @item -mfloat-vax
7397 @itemx -mfloat-ieee
7398 @opindex mfloat-vax
7399 @opindex mfloat-ieee
7400 Generate code that uses (does not use) VAX F and G floating point
7401 arithmetic instead of IEEE single and double precision.
7403 @item -mexplicit-relocs
7404 @itemx -mno-explicit-relocs
7405 @opindex mexplicit-relocs
7406 @opindex mno-explicit-relocs
7407 Older Alpha assemblers provided no way to generate symbol relocations
7408 except via assembler macros.  Use of these macros does not allow
7409 optimal instruction scheduling.  GNU binutils as of version 2.12
7410 supports a new syntax that allows the compiler to explicitly mark
7411 which relocations should apply to which instructions.  This option
7412 is mostly useful for debugging, as GCC detects the capabilities of
7413 the assembler when it is built and sets the default accordingly.
7415 @item -msmall-data
7416 @itemx -mlarge-data
7417 @opindex msmall-data
7418 @opindex mlarge-data
7419 When @option{-mexplicit-relocs} is in effect, static data is
7420 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7421 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7422 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7423 16-bit relocations off of the @code{$gp} register.  This limits the
7424 size of the small data area to 64KB, but allows the variables to be
7425 directly accessed via a single instruction.
7427 The default is @option{-mlarge-data}.  With this option the data area
7428 is limited to just below 2GB.  Programs that require more than 2GB of
7429 data must use @code{malloc} or @code{mmap} to allocate the data in the
7430 heap instead of in the program's data segment.
7432 When generating code for shared libraries, @option{-fpic} implies
7433 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7435 @item -msmall-text
7436 @itemx -mlarge-text
7437 @opindex msmall-text
7438 @opindex mlarge-text
7439 When @option{-msmall-text} is used, the compiler assumes that the
7440 code of the entire program (or shared library) fits in 4MB, and is
7441 thus reachable with a branch instruction.  When @option{-msmall-data}
7442 is used, the compiler can assume that all local symbols share the
7443 same @code{$gp} value, and thus reduce the number of instructions
7444 required for a function call from 4 to 1.
7446 The default is @option{-mlarge-text}.
7448 @item -mcpu=@var{cpu_type}
7449 @opindex mcpu
7450 Set the instruction set and instruction scheduling parameters for
7451 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7452 style name or the corresponding chip number.  GCC supports scheduling
7453 parameters for the EV4, EV5 and EV6 family of processors and will
7454 choose the default values for the instruction set from the processor
7455 you specify.  If you do not specify a processor type, GCC will default
7456 to the processor on which the compiler was built.
7458 Supported values for @var{cpu_type} are
7460 @table @samp
7461 @item ev4
7462 @itemx ev45
7463 @itemx 21064
7464 Schedules as an EV4 and has no instruction set extensions.
7466 @item ev5
7467 @itemx 21164
7468 Schedules as an EV5 and has no instruction set extensions.
7470 @item ev56
7471 @itemx 21164a
7472 Schedules as an EV5 and supports the BWX extension.
7474 @item pca56
7475 @itemx 21164pc
7476 @itemx 21164PC
7477 Schedules as an EV5 and supports the BWX and MAX extensions.
7479 @item ev6
7480 @itemx 21264
7481 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7483 @item ev67
7484 @itemx 21264a
7485 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7486 @end table
7488 @item -mtune=@var{cpu_type}
7489 @opindex mtune
7490 Set only the instruction scheduling parameters for machine type
7491 @var{cpu_type}.  The instruction set is not changed.
7493 @item -mmemory-latency=@var{time}
7494 @opindex mmemory-latency
7495 Sets the latency the scheduler should assume for typical memory
7496 references as seen by the application.  This number is highly
7497 dependent on the memory access patterns used by the application
7498 and the size of the external cache on the machine.
7500 Valid options for @var{time} are
7502 @table @samp
7503 @item @var{number}
7504 A decimal number representing clock cycles.
7506 @item L1
7507 @itemx L2
7508 @itemx L3
7509 @itemx main
7510 The compiler contains estimates of the number of clock cycles for
7511 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7512 (also called Dcache, Scache, and Bcache), as well as to main memory.
7513 Note that L3 is only valid for EV5.
7515 @end table
7516 @end table
7518 @node DEC Alpha/VMS Options
7519 @subsection DEC Alpha/VMS Options
7521 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7523 @table @gcctabopt
7524 @item -mvms-return-codes
7525 @opindex mvms-return-codes
7526 Return VMS condition codes from main.  The default is to return POSIX
7527 style condition (e.g.@ error) codes.
7528 @end table
7530 @node FRV Options
7531 @subsection FRV Options
7532 @cindex FRV Options
7534 @table @gcctabopt
7535 @item -mgpr-32
7536 @opindex mgpr-32
7538 Only use the first 32 general purpose registers.
7540 @item -mgpr-64
7541 @opindex mgpr-64
7543 Use all 64 general purpose registers.
7545 @item -mfpr-32
7546 @opindex mfpr-32
7548 Use only the first 32 floating point registers.
7550 @item -mfpr-64
7551 @opindex mfpr-64
7553 Use all 64 floating point registers
7555 @item -mhard-float
7556 @opindex mhard-float
7558 Use hardware instructions for floating point operations.
7560 @item -msoft-float
7561 @opindex msoft-float
7563 Use library routines for floating point operations.
7565 @item -malloc-cc
7566 @opindex malloc-cc
7568 Dynamically allocate condition code registers.
7570 @item -mfixed-cc
7571 @opindex mfixed-cc
7573 Do not try to dynamically allocate condition code registers, only
7574 use @code{icc0} and @code{fcc0}.
7576 @item -mdword
7577 @opindex mdword
7579 Change ABI to use double word insns.
7581 @item -mno-dword
7582 @opindex mno-dword
7584 Do not use double word instructions.
7586 @item -mdouble
7587 @opindex mdouble
7589 Use floating point double instructions.
7591 @item -mno-double
7592 @opindex mno-double
7594 Do not use floating point double instructions.
7596 @item -mmedia
7597 @opindex mmedia
7599 Use media instructions.
7601 @item -mno-media
7602 @opindex mno-media
7604 Do not use media instructions.
7606 @item -mmuladd
7607 @opindex mmuladd
7609 Use multiply and add/subtract instructions.
7611 @item -mno-muladd
7612 @opindex mno-muladd
7614 Do not use multiply and add/subtract instructions.
7616 @item -mfdpic
7617 @opindex mfdpic
7619 Select the FDPIC ABI, that uses function descriptors to represent
7620 pointers to functions.  Without any PIC/PIE-related options, it
7621 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7622 assumes GOT entries and small data are within a 12-bit range from the
7623 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7624 are computed with 32 bits.
7626 @item -minline-plt
7627 @opindex minline-plt
7629 Enable inlining of PLT entries in function calls to functions that are
7630 not known to bind locally.  It has no effect without @option{-mfdpic}.
7631 It's enabled by default if optimizing for speed and compiling for
7632 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7633 optimization option such as @option{-O3} or above is present in the
7634 command line.
7636 @item -mgprel-ro
7637 @opindex mgprel-ro
7639 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7640 that is known to be in read-only sections.  It's enabled by default,
7641 except for @option{-fpic} or @option{-fpie}: even though it may help
7642 make the global offset table smaller, it trades 1 instruction for 4.
7643 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7644 one of which may be shared by multiple symbols, and it avoids the need
7645 for a GOT entry for the referenced symbol, so it's more likely to be a
7646 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7648 @item -multilib-library-pic
7649 @opindex multilib-library-pic
7651 Link with the (library, not FD) pic libraries.  It's implied by
7652 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7653 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7654 it explicitly.
7656 @item -mlinked-fp
7657 @opindex mlinked-fp
7659 Follow the EABI requirement of always creating a frame pointer whenever
7660 a stack frame is allocated.  This option is enabled by default and can
7661 be disabled with @option{-mno-linked-fp}.
7663 @item -mlibrary-pic
7664 @opindex mlibrary-pic
7666 Generate position-independent EABI code.
7668 @item -macc-4
7669 @opindex macc-4
7671 Use only the first four media accumulator registers.
7673 @item -macc-8
7674 @opindex macc-8
7676 Use all eight media accumulator registers.
7678 @item -mpack
7679 @opindex mpack
7681 Pack VLIW instructions.
7683 @item -mno-pack
7684 @opindex mno-pack
7686 Do not pack VLIW instructions.
7688 @item -mno-eflags
7689 @opindex mno-eflags
7691 Do not mark ABI switches in e_flags.
7693 @item -mcond-move
7694 @opindex mcond-move
7696 Enable the use of conditional-move instructions (default).
7698 This switch is mainly for debugging the compiler and will likely be removed
7699 in a future version.
7701 @item -mno-cond-move
7702 @opindex mno-cond-move
7704 Disable the use of conditional-move instructions.
7706 This switch is mainly for debugging the compiler and will likely be removed
7707 in a future version.
7709 @item -mscc
7710 @opindex mscc
7712 Enable the use of conditional set instructions (default).
7714 This switch is mainly for debugging the compiler and will likely be removed
7715 in a future version.
7717 @item -mno-scc
7718 @opindex mno-scc
7720 Disable the use of conditional set instructions.
7722 This switch is mainly for debugging the compiler and will likely be removed
7723 in a future version.
7725 @item -mcond-exec
7726 @opindex mcond-exec
7728 Enable the use of conditional execution (default).
7730 This switch is mainly for debugging the compiler and will likely be removed
7731 in a future version.
7733 @item -mno-cond-exec
7734 @opindex mno-cond-exec
7736 Disable the use of conditional execution.
7738 This switch is mainly for debugging the compiler and will likely be removed
7739 in a future version.
7741 @item -mvliw-branch
7742 @opindex mvliw-branch
7744 Run a pass to pack branches into VLIW instructions (default).
7746 This switch is mainly for debugging the compiler and will likely be removed
7747 in a future version.
7749 @item -mno-vliw-branch
7750 @opindex mno-vliw-branch
7752 Do not run a pass to pack branches into VLIW instructions.
7754 This switch is mainly for debugging the compiler and will likely be removed
7755 in a future version.
7757 @item -mmulti-cond-exec
7758 @opindex mmulti-cond-exec
7760 Enable optimization of @code{&&} and @code{||} in conditional execution
7761 (default).
7763 This switch is mainly for debugging the compiler and will likely be removed
7764 in a future version.
7766 @item -mno-multi-cond-exec
7767 @opindex mno-multi-cond-exec
7769 Disable optimization of @code{&&} and @code{||} in conditional execution.
7771 This switch is mainly for debugging the compiler and will likely be removed
7772 in a future version.
7774 @item -mnested-cond-exec
7775 @opindex mnested-cond-exec
7777 Enable nested conditional execution optimizations (default).
7779 This switch is mainly for debugging the compiler and will likely be removed
7780 in a future version.
7782 @item -mno-nested-cond-exec
7783 @opindex mno-nested-cond-exec
7785 Disable nested conditional execution optimizations.
7787 This switch is mainly for debugging the compiler and will likely be removed
7788 in a future version.
7790 @item -mtomcat-stats
7791 @opindex mtomcat-stats
7793 Cause gas to print out tomcat statistics.
7795 @item -mcpu=@var{cpu}
7796 @opindex mcpu
7798 Select the processor type for which to generate code.  Possible values are
7799 @samp{simple}, @samp{tomcat}, @samp{fr500}, @samp{fr400}, @samp{fr300},
7800 @samp{frv}.
7802 @end table
7804 @node H8/300 Options
7805 @subsection H8/300 Options
7807 These @samp{-m} options are defined for the H8/300 implementations:
7809 @table @gcctabopt
7810 @item -mrelax
7811 @opindex mrelax
7812 Shorten some address references at link time, when possible; uses the
7813 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
7814 ld, Using ld}, for a fuller description.
7816 @item -mh
7817 @opindex mh
7818 Generate code for the H8/300H@.
7820 @item -ms
7821 @opindex ms
7822 Generate code for the H8S@.
7824 @item -mn
7825 @opindex mn
7826 Generate code for the H8S and H8/300H in the normal mode.  This switch
7827 must be used either with -mh or -ms.
7829 @item -ms2600
7830 @opindex ms2600
7831 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
7833 @item -mint32
7834 @opindex mint32
7835 Make @code{int} data 32 bits by default.
7837 @item -malign-300
7838 @opindex malign-300
7839 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
7840 The default for the H8/300H and H8S is to align longs and floats on 4
7841 byte boundaries.
7842 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
7843 This option has no effect on the H8/300.
7844 @end table
7846 @node HPPA Options
7847 @subsection HPPA Options
7848 @cindex HPPA Options
7850 These @samp{-m} options are defined for the HPPA family of computers:
7852 @table @gcctabopt
7853 @item -march=@var{architecture-type}
7854 @opindex march
7855 Generate code for the specified architecture.  The choices for
7856 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
7857 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
7858 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
7859 architecture option for your machine.  Code compiled for lower numbered
7860 architectures will run on higher numbered architectures, but not the
7861 other way around.
7863 @item -mpa-risc-1-0
7864 @itemx -mpa-risc-1-1
7865 @itemx -mpa-risc-2-0
7866 @opindex mpa-risc-1-0
7867 @opindex mpa-risc-1-1
7868 @opindex mpa-risc-2-0
7869 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
7871 @item -mbig-switch
7872 @opindex mbig-switch
7873 Generate code suitable for big switch tables.  Use this option only if
7874 the assembler/linker complain about out of range branches within a switch
7875 table.
7877 @item -mjump-in-delay
7878 @opindex mjump-in-delay
7879 Fill delay slots of function calls with unconditional jump instructions
7880 by modifying the return pointer for the function call to be the target
7881 of the conditional jump.
7883 @item -mdisable-fpregs
7884 @opindex mdisable-fpregs
7885 Prevent floating point registers from being used in any manner.  This is
7886 necessary for compiling kernels which perform lazy context switching of
7887 floating point registers.  If you use this option and attempt to perform
7888 floating point operations, the compiler will abort.
7890 @item -mdisable-indexing
7891 @opindex mdisable-indexing
7892 Prevent the compiler from using indexing address modes.  This avoids some
7893 rather obscure problems when compiling MIG generated code under MACH@.
7895 @item -mno-space-regs
7896 @opindex mno-space-regs
7897 Generate code that assumes the target has no space registers.  This allows
7898 GCC to generate faster indirect calls and use unscaled index address modes.
7900 Such code is suitable for level 0 PA systems and kernels.
7902 @item -mfast-indirect-calls
7903 @opindex mfast-indirect-calls
7904 Generate code that assumes calls never cross space boundaries.  This
7905 allows GCC to emit code which performs faster indirect calls.
7907 This option will not work in the presence of shared libraries or nested
7908 functions.
7910 @item -mfixed-range=@var{register-range}
7911 @opindex mfixed-range
7912 Generate code treating the given register range as fixed registers.
7913 A fixed register is one that the register allocator can not use.  This is
7914 useful when compiling kernel code.  A register range is specified as
7915 two registers separated by a dash.  Multiple register ranges can be
7916 specified separated by a comma.
7918 @item -mlong-load-store
7919 @opindex mlong-load-store
7920 Generate 3-instruction load and store sequences as sometimes required by
7921 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
7922 the HP compilers.
7924 @item -mportable-runtime
7925 @opindex mportable-runtime
7926 Use the portable calling conventions proposed by HP for ELF systems.
7928 @item -mgas
7929 @opindex mgas
7930 Enable the use of assembler directives only GAS understands.
7932 @item -mschedule=@var{cpu-type}
7933 @opindex mschedule
7934 Schedule code according to the constraints for the machine type
7935 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
7936 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
7937 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
7938 proper scheduling option for your machine.  The default scheduling is
7939 @samp{8000}.
7941 @item -mlinker-opt
7942 @opindex mlinker-opt
7943 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
7944 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
7945 linkers in which they give bogus error messages when linking some programs.
7947 @item -msoft-float
7948 @opindex msoft-float
7949 Generate output containing library calls for floating point.
7950 @strong{Warning:} the requisite libraries are not available for all HPPA
7951 targets.  Normally the facilities of the machine's usual C compiler are
7952 used, but this cannot be done directly in cross-compilation.  You must make
7953 your own arrangements to provide suitable library functions for
7954 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
7955 does provide software floating point support.
7957 @option{-msoft-float} changes the calling convention in the output file;
7958 therefore, it is only useful if you compile @emph{all} of a program with
7959 this option.  In particular, you need to compile @file{libgcc.a}, the
7960 library that comes with GCC, with @option{-msoft-float} in order for
7961 this to work.
7963 @item -msio
7964 @opindex msio
7965 Generate the predefine, @code{_SIO}, for server IO.  The default is
7966 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
7967 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO.  These
7968 options are available under HP-UX and HI-UX.
7970 @item -mgnu-ld
7971 @opindex gnu-ld
7972 Use GNU ld specific options.  This passes @option{-shared} to ld when
7973 building a shared library.  It is the default when GCC is configured,
7974 explicitly or implicitly, with the GNU linker.  This option does not
7975 have any affect on which ld is called, it only changes what parameters
7976 are passed to that ld.  The ld that is called is determined by the
7977 @option{--with-ld} configure option, GCC's program search path, and
7978 finally by the user's @env{PATH}.  The linker used by GCC can be printed
7979 using @samp{which `gcc -print-prog-name=ld`}.
7981 @item -mhp-ld
7982 @opindex hp-ld
7983 Use HP ld specific options.  This passes @option{-b} to ld when building
7984 a shared library and passes @option{+Accept TypeMismatch} to ld on all
7985 links.  It is the default when GCC is configured, explicitly or
7986 implicitly, with the HP linker.  This option does not have any affect on
7987 which ld is called, it only changes what parameters are passed to that
7988 ld.  The ld that is called is determined by the @option{--with-ld}
7989 configure option, GCC's program search path, and finally by the user's
7990 @env{PATH}.  The linker used by GCC can be printed using @samp{which
7991 `gcc -print-prog-name=ld`}.
7993 @item -mlong-calls
7994 @opindex mno-long-calls
7995 Generate code that uses long call sequences.  This ensures that a call
7996 is always able to reach linker generated stubs.  The default is to generate
7997 long calls only when the distance from the call site to the beginning
7998 of the function or translation unit, as the case may be, exceeds a
7999 predefined limit set by the branch type being used.  The limits for
8000 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8001 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8002 240,000 bytes.
8004 Distances are measured from the beginning of functions when using the
8005 @option{-ffunction-sections} option, or when using the @option{-mgas}
8006 and @option{-mno-portable-runtime} options together under HP-UX with
8007 the SOM linker.
8009 It is normally not desirable to use this option as it will degrade
8010 performance.  However, it may be useful in large applications,
8011 particularly when partial linking is used to build the application.
8013 The types of long calls used depends on the capabilities of the
8014 assembler and linker, and the type of code being generated.  The
8015 impact on systems that support long absolute calls, and long pic
8016 symbol-difference or pc-relative calls should be relatively small.
8017 However, an indirect call is used on 32-bit ELF systems in pic code
8018 and it is quite long.
8020 @item -munix=@var{unix-std}
8021 @opindex march
8022 Generate compiler predefines and select a startfile for the specified
8023 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8024 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8025 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8026 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8027 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8028 and later.
8030 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8031 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8032 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8033 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8034 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8035 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8037 It is @emph{important} to note that this option changes the interfaces
8038 for various library routines.  It also affects the operational behavior
8039 of the C library.  Thus, @emph{extreme} care is needed in using this
8040 option.
8042 Library code that is intended to operate with more than one UNIX
8043 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8044 as appropriate.  Most GNU software doesn't provide this capability.
8046 @item -nolibdld
8047 @opindex nolibdld
8048 Suppress the generation of link options to search libdld.sl when the
8049 @option{-static} option is specified on HP-UX 10 and later.
8051 @item -static
8052 @opindex static
8053 The HP-UX implementation of setlocale in libc has a dependency on
8054 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8055 when the @option{-static} option is specified, special link options
8056 are needed to resolve this dependency.
8058 On HP-UX 10 and later, the GCC driver adds the necessary options to
8059 link with libdld.sl when the @option{-static} option is specified.
8060 This causes the resulting binary to be dynamic.  On the 64-bit port,
8061 the linkers generate dynamic binaries by default in any case.  The
8062 @option{-nolibdld} option can be used to prevent the GCC driver from
8063 adding these link options.
8065 @item -threads
8066 @opindex threads
8067 Add support for multithreading with the @dfn{dce thread} library
8068 under HP-UX.  This option sets flags for both the preprocessor and
8069 linker.
8070 @end table
8072 @node i386 and x86-64 Options
8073 @subsection Intel 386 and AMD x86-64 Options
8074 @cindex i386 Options
8075 @cindex x86-64 Options
8076 @cindex Intel 386 Options
8077 @cindex AMD x86-64 Options
8079 These @samp{-m} options are defined for the i386 and x86-64 family of
8080 computers:
8082 @table @gcctabopt
8083 @item -mtune=@var{cpu-type}
8084 @opindex mtune
8085 Tune to @var{cpu-type} everything applicable about the generated code, except
8086 for the ABI and the set of available instructions.  The choices for
8087 @var{cpu-type} are:
8088 @table @emph
8089 @item i386
8090 Original Intel's i386 CPU.
8091 @item i486
8092 Intel's i486 CPU.  (No scheduling is implemented for this chip.)
8093 @item i586, pentium
8094 Intel Pentium CPU with no MMX support.
8095 @item pentium-mmx
8096 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8097 @item i686, pentiumpro
8098 Intel PentiumPro CPU.
8099 @item pentium2
8100 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8101 @item pentium3, pentium3m
8102 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8103 support.
8104 @item pentium-m
8105 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8106 support.  Used by Centrino notebooks.
8107 @item pentium4, pentium4m
8108 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8109 @item prescott
8110 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8111 set support.
8112 @item nocona
8113 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8114 SSE2 and SSE3 instruction set support.
8115 @item k6
8116 AMD K6 CPU with MMX instruction set support.
8117 @item k6-2, k6-3
8118 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8119 @item athlon, athlon-tbird
8120 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8121 support.
8122 @item athlon-4, athlon-xp, athlon-mp
8123 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8124 instruction set support.
8125 @item k8, opteron, athlon64, athlon-fx
8126 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8127 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8128 @item winchip-c6
8129 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8130 set support.
8131 @item winchip2
8132 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8133 instruction set support.
8134 @item c3
8135 Via C3 CPU with MMX and 3dNOW!  instruction set support.  (No scheduling is
8136 implemented for this chip.)
8137 @item c3-2
8138 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8139 implemented for this chip.)
8140 @end table
8142 While picking a specific @var{cpu-type} will schedule things appropriately
8143 for that particular chip, the compiler will not generate any code that
8144 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8145 being used.
8147 @item -march=@var{cpu-type}
8148 @opindex march
8149 Generate instructions for the machine type @var{cpu-type}.  The choices
8150 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8151 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8153 @item -mcpu=@var{cpu-type}
8154 @opindex mcpu
8155 A deprecated synonym for @option{-mtune}.
8157 @item -m386
8158 @itemx -m486
8159 @itemx -mpentium
8160 @itemx -mpentiumpro
8161 @opindex m386
8162 @opindex m486
8163 @opindex mpentium
8164 @opindex mpentiumpro
8165 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8166 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8167 These synonyms are deprecated.
8169 @item -mfpmath=@var{unit}
8170 @opindex march
8171 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8172 for @var{unit} are:
8174 @table @samp
8175 @item 387
8176 Use the standard 387 floating point coprocessor present majority of chips and
8177 emulated otherwise.  Code compiled with this option will run almost everywhere.
8178 The temporary results are computed in 80bit precision instead of precision
8179 specified by the type resulting in slightly different results compared to most
8180 of other chips. See @option{-ffloat-store} for more detailed description.
8182 This is the default choice for i386 compiler.
8184 @item sse
8185 Use scalar floating point instructions present in the SSE instruction set.
8186 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8187 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8188 instruction set supports only single precision arithmetics, thus the double and
8189 extended precision arithmetics is still done using 387.  Later version, present
8190 only in Pentium4 and the future AMD x86-64 chips supports double precision
8191 arithmetics too.
8193 For i387 you need to use @option{-march=@var{cpu-type}}, @option{-msse} or
8194 @option{-msse2} switches to enable SSE extensions and make this option
8195 effective.  For x86-64 compiler, these extensions are enabled by default.
8197 The resulting code should be considerably faster in the majority of cases and avoid
8198 the numerical instability problems of 387 code, but may break some existing
8199 code that expects temporaries to be 80bit.
8201 This is the default choice for the x86-64 compiler.
8203 @item sse,387
8204 Attempt to utilize both instruction sets at once.  This effectively double the
8205 amount of available registers and on chips with separate execution units for
8206 387 and SSE the execution resources too.  Use this option with care, as it is
8207 still experimental, because the GCC register allocator does not model separate
8208 functional units well resulting in instable performance.
8209 @end table
8211 @item -masm=@var{dialect}
8212 @opindex masm=@var{dialect}
8213 Output asm instructions using selected @var{dialect}. Supported choices are
8214 @samp{intel} or @samp{att} (the default one).
8216 @item -mieee-fp
8217 @itemx -mno-ieee-fp
8218 @opindex mieee-fp
8219 @opindex mno-ieee-fp
8220 Control whether or not the compiler uses IEEE floating point
8221 comparisons.  These handle correctly the case where the result of a
8222 comparison is unordered.
8224 @item -msoft-float
8225 @opindex msoft-float
8226 Generate output containing library calls for floating point.
8227 @strong{Warning:} the requisite libraries are not part of GCC@.
8228 Normally the facilities of the machine's usual C compiler are used, but
8229 this can't be done directly in cross-compilation.  You must make your
8230 own arrangements to provide suitable library functions for
8231 cross-compilation.
8233 On machines where a function returns floating point results in the 80387
8234 register stack, some floating point opcodes may be emitted even if
8235 @option{-msoft-float} is used.
8237 @item -mno-fp-ret-in-387
8238 @opindex mno-fp-ret-in-387
8239 Do not use the FPU registers for return values of functions.
8241 The usual calling convention has functions return values of types
8242 @code{float} and @code{double} in an FPU register, even if there
8243 is no FPU@.  The idea is that the operating system should emulate
8244 an FPU@.
8246 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8247 in ordinary CPU registers instead.
8249 @item -mno-fancy-math-387
8250 @opindex mno-fancy-math-387
8251 Some 387 emulators do not support the @code{sin}, @code{cos} and
8252 @code{sqrt} instructions for the 387.  Specify this option to avoid
8253 generating those instructions.  This option is the default on FreeBSD,
8254 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8255 indicates that the target cpu will always have an FPU and so the
8256 instruction will not need emulation.  As of revision 2.6.1, these
8257 instructions are not generated unless you also use the
8258 @option{-funsafe-math-optimizations} switch.
8260 @item -malign-double
8261 @itemx -mno-align-double
8262 @opindex malign-double
8263 @opindex mno-align-double
8264 Control whether GCC aligns @code{double}, @code{long double}, and
8265 @code{long long} variables on a two word boundary or a one word
8266 boundary.  Aligning @code{double} variables on a two word boundary will
8267 produce code that runs somewhat faster on a @samp{Pentium} at the
8268 expense of more memory.
8270 @strong{Warning:} if you use the @option{-malign-double} switch,
8271 structures containing the above types will be aligned differently than
8272 the published application binary interface specifications for the 386
8273 and will not be binary compatible with structures in code compiled
8274 without that switch.
8276 @item -m96bit-long-double
8277 @itemx -m128bit-long-double
8278 @opindex m96bit-long-double
8279 @opindex m128bit-long-double
8280 These switches control the size of @code{long double} type. The i386
8281 application binary interface specifies the size to be 96 bits,
8282 so @option{-m96bit-long-double} is the default in 32 bit mode.
8284 Modern architectures (Pentium and newer) would prefer @code{long double}
8285 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8286 conforming to the ABI, this would not be possible.  So specifying a
8287 @option{-m128bit-long-double} will align @code{long double}
8288 to a 16 byte boundary by padding the @code{long double} with an additional
8289 32 bit zero.
8291 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8292 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8294 Notice that neither of these options enable any extra precision over the x87
8295 standard of 80 bits for a @code{long double}.
8297 @strong{Warning:} if you override the default value for your target ABI, the
8298 structures and arrays containing @code{long double} variables will change
8299 their size as well as function calling convention for function taking
8300 @code{long double} will be modified.  Hence they will not be binary
8301 compatible with arrays or structures in code compiled without that switch.
8304 @item -msvr3-shlib
8305 @itemx -mno-svr3-shlib
8306 @opindex msvr3-shlib
8307 @opindex mno-svr3-shlib
8308 Control whether GCC places uninitialized local variables into the
8309 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8310 into @code{bss}.  These options are meaningful only on System V Release 3.
8312 @item -mrtd
8313 @opindex mrtd
8314 Use a different function-calling convention, in which functions that
8315 take a fixed number of arguments return with the @code{ret} @var{num}
8316 instruction, which pops their arguments while returning.  This saves one
8317 instruction in the caller since there is no need to pop the arguments
8318 there.
8320 You can specify that an individual function is called with this calling
8321 sequence with the function attribute @samp{stdcall}.  You can also
8322 override the @option{-mrtd} option by using the function attribute
8323 @samp{cdecl}.  @xref{Function Attributes}.
8325 @strong{Warning:} this calling convention is incompatible with the one
8326 normally used on Unix, so you cannot use it if you need to call
8327 libraries compiled with the Unix compiler.
8329 Also, you must provide function prototypes for all functions that
8330 take variable numbers of arguments (including @code{printf});
8331 otherwise incorrect code will be generated for calls to those
8332 functions.
8334 In addition, seriously incorrect code will result if you call a
8335 function with too many arguments.  (Normally, extra arguments are
8336 harmlessly ignored.)
8338 @item -mregparm=@var{num}
8339 @opindex mregparm
8340 Control how many registers are used to pass integer arguments.  By
8341 default, no registers are used to pass arguments, and at most 3
8342 registers can be used.  You can control this behavior for a specific
8343 function by using the function attribute @samp{regparm}.
8344 @xref{Function Attributes}.
8346 @strong{Warning:} if you use this switch, and
8347 @var{num} is nonzero, then you must build all modules with the same
8348 value, including any libraries.  This includes the system libraries and
8349 startup modules.
8351 @item -mpreferred-stack-boundary=@var{num}
8352 @opindex mpreferred-stack-boundary
8353 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8354 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8355 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8356 size (@option{-Os}), in which case the default is the minimum correct
8357 alignment (4 bytes for x86, and 8 bytes for x86-64).
8359 On Pentium and PentiumPro, @code{double} and @code{long double} values
8360 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8361 suffer significant run time performance penalties.  On Pentium III, the
8362 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8363 penalties if it is not 16 byte aligned.
8365 To ensure proper alignment of this values on the stack, the stack boundary
8366 must be as aligned as that required by any value stored on the stack.
8367 Further, every function must be generated such that it keeps the stack
8368 aligned.  Thus calling a function compiled with a higher preferred
8369 stack boundary from a function compiled with a lower preferred stack
8370 boundary will most likely misalign the stack.  It is recommended that
8371 libraries that use callbacks always use the default setting.
8373 This extra alignment does consume extra stack space, and generally
8374 increases code size.  Code that is sensitive to stack space usage, such
8375 as embedded systems and operating system kernels, may want to reduce the
8376 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8378 @item -mmmx
8379 @itemx -mno-mmx
8380 @item -msse
8381 @itemx -mno-sse
8382 @item -msse2
8383 @itemx -mno-sse2
8384 @item -msse3
8385 @itemx -mno-sse3
8386 @item -m3dnow
8387 @itemx -mno-3dnow
8388 @opindex mmmx
8389 @opindex mno-mmx
8390 @opindex msse
8391 @opindex mno-sse
8392 @opindex m3dnow
8393 @opindex mno-3dnow
8394 These switches enable or disable the use of built-in functions that allow
8395 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8396 instruction set.
8398 @xref{X86 Built-in Functions}, for details of the functions enabled
8399 and disabled by these switches.
8401 To have SSE/SSE2 instructions generated automatically from floating-point
8402 code, see @option{-mfpmath=sse}.
8404 @item -mpush-args
8405 @itemx -mno-push-args
8406 @opindex mpush-args
8407 @opindex mno-push-args
8408 Use PUSH operations to store outgoing parameters.  This method is shorter
8409 and usually equally fast as method using SUB/MOV operations and is enabled
8410 by default.  In some cases disabling it may improve performance because of
8411 improved scheduling and reduced dependencies.
8413 @item -maccumulate-outgoing-args
8414 @opindex maccumulate-outgoing-args
8415 If enabled, the maximum amount of space required for outgoing arguments will be
8416 computed in the function prologue.  This is faster on most modern CPUs
8417 because of reduced dependencies, improved scheduling and reduced stack usage
8418 when preferred stack boundary is not equal to 2.  The drawback is a notable
8419 increase in code size.  This switch implies @option{-mno-push-args}.
8421 @item -mthreads
8422 @opindex mthreads
8423 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8424 on thread-safe exception handling must compile and link all code with the
8425 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8426 @option{-D_MT}; when linking, it links in a special thread helper library
8427 @option{-lmingwthrd} which cleans up per thread exception handling data.
8429 @item -mno-align-stringops
8430 @opindex mno-align-stringops
8431 Do not align destination of inlined string operations.  This switch reduces
8432 code size and improves performance in case the destination is already aligned,
8433 but GCC doesn't know about it.
8435 @item -minline-all-stringops
8436 @opindex minline-all-stringops
8437 By default GCC inlines string operations only when destination is known to be
8438 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8439 size, but may improve performance of code that depends on fast memcpy, strlen
8440 and memset for short lengths.
8442 @item -momit-leaf-frame-pointer
8443 @opindex momit-leaf-frame-pointer
8444 Don't keep the frame pointer in a register for leaf functions.  This
8445 avoids the instructions to save, set up and restore frame pointers and
8446 makes an extra register available in leaf functions.  The option
8447 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8448 which might make debugging harder.
8450 @item -mtls-direct-seg-refs
8451 @itemx -mno-tls-direct-seg-refs
8452 @opindex mtls-direct-seg-refs
8453 Controls whether TLS variables may be accessed with offsets from the
8454 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8455 or whether the thread base pointer must be added.  Whether or not this
8456 is legal depends on the operating system, and whether it maps the
8457 segment to cover the entire TLS area.
8459 For systems that use GNU libc, the default is on.
8460 @end table
8462 These @samp{-m} switches are supported in addition to the above
8463 on AMD x86-64 processors in 64-bit environments.
8465 @table @gcctabopt
8466 @item -m32
8467 @itemx -m64
8468 @opindex m32
8469 @opindex m64
8470 Generate code for a 32-bit or 64-bit environment.
8471 The 32-bit environment sets int, long and pointer to 32 bits and
8472 generates code that runs on any i386 system.
8473 The 64-bit environment sets int to 32 bits and long and pointer
8474 to 64 bits and generates code for AMD's x86-64 architecture.
8476 @item -mno-red-zone
8477 @opindex no-red-zone
8478 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8479 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8480 stack pointer that will not be modified by signal or interrupt handlers
8481 and therefore can be used for temporary data without adjusting the stack
8482 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8484 @item -mcmodel=small
8485 @opindex mcmodel=small
8486 Generate code for the small code model: the program and its symbols must
8487 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8488 Programs can be statically or dynamically linked.  This is the default
8489 code model.
8491 @item -mcmodel=kernel
8492 @opindex mcmodel=kernel
8493 Generate code for the kernel code model.  The kernel runs in the
8494 negative 2 GB of the address space.
8495 This model has to be used for Linux kernel code.
8497 @item -mcmodel=medium
8498 @opindex mcmodel=medium
8499 Generate code for the medium model: The program is linked in the lower 2
8500 GB of the address space but symbols can be located anywhere in the
8501 address space.  Programs can be statically or dynamically linked, but
8502 building of shared libraries are not supported with the medium model.
8504 @item -mcmodel=large
8505 @opindex mcmodel=large
8506 Generate code for the large model: This model makes no assumptions
8507 about addresses and sizes of sections.  Currently GCC does not implement
8508 this model.
8509 @end table
8511 @node IA-64 Options
8512 @subsection IA-64 Options
8513 @cindex IA-64 Options
8515 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8517 @table @gcctabopt
8518 @item -mbig-endian
8519 @opindex mbig-endian
8520 Generate code for a big endian target.  This is the default for HP-UX@.
8522 @item -mlittle-endian
8523 @opindex mlittle-endian
8524 Generate code for a little endian target.  This is the default for AIX5
8525 and GNU/Linux.
8527 @item -mgnu-as
8528 @itemx -mno-gnu-as
8529 @opindex mgnu-as
8530 @opindex mno-gnu-as
8531 Generate (or don't) code for the GNU assembler.  This is the default.
8532 @c Also, this is the default if the configure option @option{--with-gnu-as}
8533 @c is used.
8535 @item -mgnu-ld
8536 @itemx -mno-gnu-ld
8537 @opindex mgnu-ld
8538 @opindex mno-gnu-ld
8539 Generate (or don't) code for the GNU linker.  This is the default.
8540 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8541 @c is used.
8543 @item -mno-pic
8544 @opindex mno-pic
8545 Generate code that does not use a global pointer register.  The result
8546 is not position independent code, and violates the IA-64 ABI@.
8548 @item -mvolatile-asm-stop
8549 @itemx -mno-volatile-asm-stop
8550 @opindex mvolatile-asm-stop
8551 @opindex mno-volatile-asm-stop
8552 Generate (or don't) a stop bit immediately before and after volatile asm
8553 statements.
8555 @item -mb-step
8556 @opindex mb-step
8557 Generate code that works around Itanium B step errata.
8559 @item -mregister-names
8560 @itemx -mno-register-names
8561 @opindex mregister-names
8562 @opindex mno-register-names
8563 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8564 the stacked registers.  This may make assembler output more readable.
8566 @item -mno-sdata
8567 @itemx -msdata
8568 @opindex mno-sdata
8569 @opindex msdata
8570 Disable (or enable) optimizations that use the small data section.  This may
8571 be useful for working around optimizer bugs.
8573 @item -mconstant-gp
8574 @opindex mconstant-gp
8575 Generate code that uses a single constant global pointer value.  This is
8576 useful when compiling kernel code.
8578 @item -mauto-pic
8579 @opindex mauto-pic
8580 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8581 This is useful when compiling firmware code.
8583 @item -minline-float-divide-min-latency
8584 @opindex minline-float-divide-min-latency
8585 Generate code for inline divides of floating point values
8586 using the minimum latency algorithm.
8588 @item -minline-float-divide-max-throughput
8589 @opindex minline-float-divide-max-throughput
8590 Generate code for inline divides of floating point values
8591 using the maximum throughput algorithm.
8593 @item -minline-int-divide-min-latency
8594 @opindex minline-int-divide-min-latency
8595 Generate code for inline divides of integer values
8596 using the minimum latency algorithm.
8598 @item -minline-int-divide-max-throughput
8599 @opindex minline-int-divide-max-throughput
8600 Generate code for inline divides of integer values
8601 using the maximum throughput algorithm.
8603 @item -mno-dwarf2-asm
8604 @itemx -mdwarf2-asm
8605 @opindex mno-dwarf2-asm
8606 @opindex mdwarf2-asm
8607 Don't (or do) generate assembler code for the DWARF2 line number debugging
8608 info.  This may be useful when not using the GNU assembler.
8610 @item -mfixed-range=@var{register-range}
8611 @opindex mfixed-range
8612 Generate code treating the given register range as fixed registers.
8613 A fixed register is one that the register allocator can not use.  This is
8614 useful when compiling kernel code.  A register range is specified as
8615 two registers separated by a dash.  Multiple register ranges can be
8616 specified separated by a comma.
8618 @item -mearly-stop-bits
8619 @itemx -mno-early-stop-bits
8620 @opindex mearly-stop-bits
8621 @opindex mno-early-stop-bits
8622 Allow stop bits to be placed earlier than immediately preceding the
8623 instruction that triggered the stop bit.  This can improve instruction
8624 scheduling, but does not always do so.
8625 @end table
8627 @node M32R/D Options
8628 @subsection M32R/D Options
8629 @cindex M32R/D options
8631 These @option{-m} options are defined for Renesas M32R/D architectures:
8633 @table @gcctabopt
8634 @item -m32r2
8635 @opindex m32r2
8636 Generate code for the M32R/2@.
8638 @item -m32rx
8639 @opindex m32rx
8640 Generate code for the M32R/X@.
8642 @item -m32r
8643 @opindex m32r
8644 Generate code for the M32R@.  This is the default.
8646 @item -mmodel=small
8647 @opindex mmodel=small
8648 Assume all objects live in the lower 16MB of memory (so that their addresses
8649 can be loaded with the @code{ld24} instruction), and assume all subroutines
8650 are reachable with the @code{bl} instruction.
8651 This is the default.
8653 The addressability of a particular object can be set with the
8654 @code{model} attribute.
8656 @item -mmodel=medium
8657 @opindex mmodel=medium
8658 Assume objects may be anywhere in the 32-bit address space (the compiler
8659 will generate @code{seth/add3} instructions to load their addresses), and
8660 assume all subroutines are reachable with the @code{bl} instruction.
8662 @item -mmodel=large
8663 @opindex mmodel=large
8664 Assume objects may be anywhere in the 32-bit address space (the compiler
8665 will generate @code{seth/add3} instructions to load their addresses), and
8666 assume subroutines may not be reachable with the @code{bl} instruction
8667 (the compiler will generate the much slower @code{seth/add3/jl}
8668 instruction sequence).
8670 @item -msdata=none
8671 @opindex msdata=none
8672 Disable use of the small data area.  Variables will be put into
8673 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
8674 @code{section} attribute has been specified).
8675 This is the default.
8677 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
8678 Objects may be explicitly put in the small data area with the
8679 @code{section} attribute using one of these sections.
8681 @item -msdata=sdata
8682 @opindex msdata=sdata
8683 Put small global and static data in the small data area, but do not
8684 generate special code to reference them.
8686 @item -msdata=use
8687 @opindex msdata=use
8688 Put small global and static data in the small data area, and generate
8689 special instructions to reference them.
8691 @item -G @var{num}
8692 @opindex G
8693 @cindex smaller data references
8694 Put global and static objects less than or equal to @var{num} bytes
8695 into the small data or bss sections instead of the normal data or bss
8696 sections.  The default value of @var{num} is 8.
8697 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
8698 for this option to have any effect.
8700 All modules should be compiled with the same @option{-G @var{num}} value.
8701 Compiling with different values of @var{num} may or may not work; if it
8702 doesn't the linker will give an error message---incorrect code will not be
8703 generated.
8705 @item -mdebug
8706 @opindex mdebug
8707 Makes the M32R specific code in the compiler display some statistics
8708 that might help in debugging programs.
8710 @item -malign-loops
8711 @opindex malign-loops
8712 Align all loops to a 32-byte boundary.
8714 @item -mno-align-loops
8715 @opindex mno-align-loops
8716 Do not enforce a 32-byte alignment for loops.  This is the default.
8718 @item -missue-rate=@var{number}
8719 @opindex missue-rate=@var{number}
8720 Issue @var{number} instructions per cycle.  @var{number} can only be 1
8721 or 2.
8723 @item -mbranch-cost=@var{number}
8724 @opindex mbranch-cost=@var{number}
8725 @var{number} can only be 1 or 2.  If it is 1 then branches will be
8726 preferred over conditional code, if it is 2, then the opposite will
8727 apply.
8729 @item -mflush-trap=@var{number}
8730 @opindex mflush-trap=@var{number}
8731 Specifies the trap number to use to flush the cache.  The default is
8732 12.  Valid numbers are between 0 and 15 inclusive.
8734 @item -mno-flush-trap
8735 @opindex mno-flush-trap
8736 Specifies that the cache cannot be flushed by using a trap.
8738 @item -mflush-func=@var{name}
8739 @opindex mflush-func=@var{name}
8740 Specifies the name of the operating system function to call to flush
8741 the cache.  The default is @emph{_flush_cache}, but a function call
8742 will only be used if a trap is not available.
8744 @item -mno-flush-func
8745 @opindex mno-flush-func
8746 Indicates that there is no OS function for flushing the cache.
8748 @end table
8750 @node M680x0 Options
8751 @subsection M680x0 Options
8752 @cindex M680x0 options
8754 These are the @samp{-m} options defined for the 68000 series.  The default
8755 values for these options depends on which style of 68000 was selected when
8756 the compiler was configured; the defaults for the most common choices are
8757 given below.
8759 @table @gcctabopt
8760 @item -m68000
8761 @itemx -mc68000
8762 @opindex m68000
8763 @opindex mc68000
8764 Generate output for a 68000.  This is the default
8765 when the compiler is configured for 68000-based systems.
8767 Use this option for microcontrollers with a 68000 or EC000 core,
8768 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
8770 @item -m68020
8771 @itemx -mc68020
8772 @opindex m68020
8773 @opindex mc68020
8774 Generate output for a 68020.  This is the default
8775 when the compiler is configured for 68020-based systems.
8777 @item -m68881
8778 @opindex m68881
8779 Generate output containing 68881 instructions for floating point.
8780 This is the default for most 68020 systems unless @option{--nfp} was
8781 specified when the compiler was configured.
8783 @item -m68030
8784 @opindex m68030
8785 Generate output for a 68030.  This is the default when the compiler is
8786 configured for 68030-based systems.
8788 @item -m68040
8789 @opindex m68040
8790 Generate output for a 68040.  This is the default when the compiler is
8791 configured for 68040-based systems.
8793 This option inhibits the use of 68881/68882 instructions that have to be
8794 emulated by software on the 68040.  Use this option if your 68040 does not
8795 have code to emulate those instructions.
8797 @item -m68060
8798 @opindex m68060
8799 Generate output for a 68060.  This is the default when the compiler is
8800 configured for 68060-based systems.
8802 This option inhibits the use of 68020 and 68881/68882 instructions that
8803 have to be emulated by software on the 68060.  Use this option if your 68060
8804 does not have code to emulate those instructions.
8806 @item -mcpu32
8807 @opindex mcpu32
8808 Generate output for a CPU32.  This is the default
8809 when the compiler is configured for CPU32-based systems.
8811 Use this option for microcontrollers with a
8812 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
8813 68336, 68340, 68341, 68349 and 68360.
8815 @item -m5200
8816 @opindex m5200
8817 Generate output for a 520X ``coldfire'' family cpu.  This is the default
8818 when the compiler is configured for 520X-based systems.
8820 Use this option for microcontroller with a 5200 core, including
8821 the MCF5202, MCF5203, MCF5204 and MCF5202.
8824 @item -m68020-40
8825 @opindex m68020-40
8826 Generate output for a 68040, without using any of the new instructions.
8827 This results in code which can run relatively efficiently on either a
8828 68020/68881 or a 68030 or a 68040.  The generated code does use the
8829 68881 instructions that are emulated on the 68040.
8831 @item -m68020-60
8832 @opindex m68020-60
8833 Generate output for a 68060, without using any of the new instructions.
8834 This results in code which can run relatively efficiently on either a
8835 68020/68881 or a 68030 or a 68040.  The generated code does use the
8836 68881 instructions that are emulated on the 68060.
8838 @item -msoft-float
8839 @opindex msoft-float
8840 Generate output containing library calls for floating point.
8841 @strong{Warning:} the requisite libraries are not available for all m68k
8842 targets.  Normally the facilities of the machine's usual C compiler are
8843 used, but this can't be done directly in cross-compilation.  You must
8844 make your own arrangements to provide suitable library functions for
8845 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
8846 @samp{m68k-*-coff} do provide software floating point support.
8848 @item -mshort
8849 @opindex mshort
8850 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8851 Additionally, parameters passed on the stack are also aligned to a
8852 16-bit boundary even on targets whose API mandates promotion to 32-bit.
8854 @item -mnobitfield
8855 @opindex mnobitfield
8856 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
8857 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
8859 @item -mbitfield
8860 @opindex mbitfield
8861 Do use the bit-field instructions.  The @option{-m68020} option implies
8862 @option{-mbitfield}.  This is the default if you use a configuration
8863 designed for a 68020.
8865 @item -mrtd
8866 @opindex mrtd
8867 Use a different function-calling convention, in which functions
8868 that take a fixed number of arguments return with the @code{rtd}
8869 instruction, which pops their arguments while returning.  This
8870 saves one instruction in the caller since there is no need to pop
8871 the arguments there.
8873 This calling convention is incompatible with the one normally
8874 used on Unix, so you cannot use it if you need to call libraries
8875 compiled with the Unix compiler.
8877 Also, you must provide function prototypes for all functions that
8878 take variable numbers of arguments (including @code{printf});
8879 otherwise incorrect code will be generated for calls to those
8880 functions.
8882 In addition, seriously incorrect code will result if you call a
8883 function with too many arguments.  (Normally, extra arguments are
8884 harmlessly ignored.)
8886 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
8887 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
8889 @item -malign-int
8890 @itemx -mno-align-int
8891 @opindex malign-int
8892 @opindex mno-align-int
8893 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
8894 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
8895 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
8896 Aligning variables on 32-bit boundaries produces code that runs somewhat
8897 faster on processors with 32-bit busses at the expense of more memory.
8899 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
8900 align structures containing the above types  differently than
8901 most published application binary interface specifications for the m68k.
8903 @item -mpcrel
8904 @opindex mpcrel
8905 Use the pc-relative addressing mode of the 68000 directly, instead of
8906 using a global offset table.  At present, this option implies @option{-fpic},
8907 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
8908 not presently supported with @option{-mpcrel}, though this could be supported for
8909 68020 and higher processors.
8911 @item -mno-strict-align
8912 @itemx -mstrict-align
8913 @opindex mno-strict-align
8914 @opindex mstrict-align
8915 Do not (do) assume that unaligned memory references will be handled by
8916 the system.
8918 @item -msep-data
8919 Generate code that allows the data segment to be located in a different
8920 area of memory from the text segment.  This allows for execute in place in
8921 an environment without virtual memory management.  This option implies -fPIC.
8923 @item -mno-sep-data
8924 Generate code that assumes that the data segment follows the text segment.
8925 This is the default.
8927 @item -mid-shared-library
8928 Generate code that supports shared libraries via the library ID method.
8929 This allows for execute in place and shared libraries in an environment
8930 without virtual memory management.  This option implies -fPIC.
8932 @item -mno-id-shared-library
8933 Generate code that doesn't assume ID based shared libraries are being used.
8934 This is the default.
8936 @item -mshared-library-id=n
8937 Specified the identification number of the ID based shared library being
8938 compiled.  Specifying a value of 0 will generate more compact code, specifying
8939 other values will force the allocation of that number to the current
8940 library but is no more space or time efficient than omitting this option.
8942 @end table
8944 @node M68hc1x Options
8945 @subsection M68hc1x Options
8946 @cindex M68hc1x options
8948 These are the @samp{-m} options defined for the 68hc11 and 68hc12
8949 microcontrollers.  The default values for these options depends on
8950 which style of microcontroller was selected when the compiler was configured;
8951 the defaults for the most common choices are given below.
8953 @table @gcctabopt
8954 @item -m6811
8955 @itemx -m68hc11
8956 @opindex m6811
8957 @opindex m68hc11
8958 Generate output for a 68HC11.  This is the default
8959 when the compiler is configured for 68HC11-based systems.
8961 @item -m6812
8962 @itemx -m68hc12
8963 @opindex m6812
8964 @opindex m68hc12
8965 Generate output for a 68HC12.  This is the default
8966 when the compiler is configured for 68HC12-based systems.
8968 @item -m68S12
8969 @itemx -m68hcs12
8970 @opindex m68S12
8971 @opindex m68hcs12
8972 Generate output for a 68HCS12.
8974 @item -mauto-incdec
8975 @opindex mauto-incdec
8976 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
8977 addressing modes.
8979 @item -minmax
8980 @itemx -nominmax
8981 @opindex minmax
8982 @opindex mnominmax
8983 Enable the use of 68HC12 min and max instructions.
8985 @item -mlong-calls
8986 @itemx -mno-long-calls
8987 @opindex mlong-calls
8988 @opindex mno-long-calls
8989 Treat all calls as being far away (near).  If calls are assumed to be
8990 far away, the compiler will use the @code{call} instruction to
8991 call a function and the @code{rtc} instruction for returning.
8993 @item -mshort
8994 @opindex mshort
8995 Consider type @code{int} to be 16 bits wide, like @code{short int}.
8997 @item -msoft-reg-count=@var{count}
8998 @opindex msoft-reg-count
8999 Specify the number of pseudo-soft registers which are used for the
9000 code generation.  The maximum number is 32.  Using more pseudo-soft
9001 register may or may not result in better code depending on the program.
9002 The default is 4 for 68HC11 and 2 for 68HC12.
9004 @end table
9006 @node MCore Options
9007 @subsection MCore Options
9008 @cindex MCore options
9010 These are the @samp{-m} options defined for the Motorola M*Core
9011 processors.
9013 @table @gcctabopt
9015 @item -mhardlit
9016 @itemx -mno-hardlit
9017 @opindex mhardlit
9018 @opindex mno-hardlit
9019 Inline constants into the code stream if it can be done in two
9020 instructions or less.
9022 @item -mdiv
9023 @itemx -mno-div
9024 @opindex mdiv
9025 @opindex mno-div
9026 Use the divide instruction.  (Enabled by default).
9028 @item -mrelax-immediate
9029 @itemx -mno-relax-immediate
9030 @opindex mrelax-immediate
9031 @opindex mno-relax-immediate
9032 Allow arbitrary sized immediates in bit operations.
9034 @item -mwide-bitfields
9035 @itemx -mno-wide-bitfields
9036 @opindex mwide-bitfields
9037 @opindex mno-wide-bitfields
9038 Always treat bit-fields as int-sized.
9040 @item -m4byte-functions
9041 @itemx -mno-4byte-functions
9042 @opindex m4byte-functions
9043 @opindex mno-4byte-functions
9044 Force all functions to be aligned to a four byte boundary.
9046 @item -mcallgraph-data
9047 @itemx -mno-callgraph-data
9048 @opindex mcallgraph-data
9049 @opindex mno-callgraph-data
9050 Emit callgraph information.
9052 @item -mslow-bytes
9053 @itemx -mno-slow-bytes
9054 @opindex mslow-bytes
9055 @opindex mno-slow-bytes
9056 Prefer word access when reading byte quantities.
9058 @item -mlittle-endian
9059 @itemx -mbig-endian
9060 @opindex mlittle-endian
9061 @opindex mbig-endian
9062 Generate code for a little endian target.
9064 @item -m210
9065 @itemx -m340
9066 @opindex m210
9067 @opindex m340
9068 Generate code for the 210 processor.
9069 @end table
9071 @node MIPS Options
9072 @subsection MIPS Options
9073 @cindex MIPS options
9075 @table @gcctabopt
9077 @item -EB
9078 @opindex EB
9079 Generate big-endian code.
9081 @item -EL
9082 @opindex EL
9083 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9084 configurations.
9086 @item -march=@var{arch}
9087 @opindex march
9088 Generate code that will run on @var{arch}, which can be the name of a
9089 generic MIPS ISA, or the name of a particular processor.
9090 The ISA names are:
9091 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9092 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9093 The processor names are:
9094 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9095 @samp{m4k},
9096 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9097 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9098 @samp{rm9000},
9099 @samp{orion},
9100 @samp{sb1},
9101 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9102 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9103 The special value @samp{from-abi} selects the
9104 most compatible architecture for the selected ABI (that is,
9105 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9107 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9108 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9109 @samp{vr} may be written @samp{r}.
9111 GCC defines two macros based on the value of this option.  The first
9112 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9113 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9114 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9115 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9116 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9118 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9119 above.  In other words, it will have the full prefix and will not
9120 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9121 the macro names the resolved architecture (either @samp{"mips1"} or
9122 @samp{"mips3"}).  It names the default architecture when no
9123 @option{-march} option is given.
9125 @item -mtune=@var{arch}
9126 @opindex mtune
9127 Optimize for @var{arch}.  Among other things, this option controls
9128 the way instructions are scheduled, and the perceived cost of arithmetic
9129 operations.  The list of @var{arch} values is the same as for
9130 @option{-march}.
9132 When this option is not used, GCC will optimize for the processor
9133 specified by @option{-march}.  By using @option{-march} and
9134 @option{-mtune} together, it is possible to generate code that will
9135 run on a family of processors, but optimize the code for one
9136 particular member of that family.
9138 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9139 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9140 @samp{-march} ones described above.
9142 @item -mips1
9143 @opindex mips1
9144 Equivalent to @samp{-march=mips1}.
9146 @item -mips2
9147 @opindex mips2
9148 Equivalent to @samp{-march=mips2}.
9150 @item -mips3
9151 @opindex mips3
9152 Equivalent to @samp{-march=mips3}.
9154 @item -mips4
9155 @opindex mips4
9156 Equivalent to @samp{-march=mips4}.
9158 @item -mips32
9159 @opindex mips32
9160 Equivalent to @samp{-march=mips32}.
9162 @item -mips32r2
9163 @opindex mips32r2
9164 Equivalent to @samp{-march=mips32r2}.
9166 @item -mips64
9167 @opindex mips64
9168 Equivalent to @samp{-march=mips64}.
9170 @item -mips16
9171 @itemx -mno-mips16
9172 @opindex mips16
9173 @opindex mno-mips16
9174 Use (do not use) the MIPS16 ISA.
9176 @item -mabi=32
9177 @itemx -mabi=o64
9178 @itemx -mabi=n32
9179 @itemx -mabi=64
9180 @itemx -mabi=eabi
9181 @opindex mabi=32
9182 @opindex mabi=o64
9183 @opindex mabi=n32
9184 @opindex mabi=64
9185 @opindex mabi=eabi
9186 Generate code for the given ABI@.
9188 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9189 generates 64-bit code when you select a 64-bit architecture, but you
9190 can use @option{-mgp32} to get 32-bit code instead.
9192 For information about the O64 ABI, see
9193 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9195 @item -mabicalls
9196 @itemx -mno-abicalls
9197 @opindex mabicalls
9198 @opindex mno-abicalls
9199 Generate (do not generate) SVR4-style position-independent code.
9200 @option{-mabicalls} is the default for SVR4-based systems.
9202 @item -mxgot
9203 @itemx -mno-xgot
9204 @opindex mxgot
9205 @opindex mno-xgot
9206 Lift (do not lift) the usual restrictions on the size of the global
9207 offset table.
9209 GCC normally uses a single instruction to load values from the GOT.
9210 While this is relatively efficient, it will only work if the GOT
9211 is smaller than about 64k.  Anything larger will cause the linker
9212 to report an error such as:
9214 @cindex relocation truncated to fit (MIPS)
9215 @smallexample
9216 relocation truncated to fit: R_MIPS_GOT16 foobar
9217 @end smallexample
9219 If this happens, you should recompile your code with @option{-mxgot}.
9220 It should then work with very large GOTs, although it will also be
9221 less efficient, since it will take three instructions to fetch the
9222 value of a global symbol.
9224 Note that some linkers can create multiple GOTs.  If you have such a
9225 linker, you should only need to use @option{-mxgot} when a single object
9226 file accesses more than 64k's worth of GOT entries.  Very few do.
9228 These options have no effect unless GCC is generating position
9229 independent code.
9231 @item -mgp32
9232 @opindex mgp32
9233 Assume that general-purpose registers are 32 bits wide.
9235 @item -mgp64
9236 @opindex mgp64
9237 Assume that general-purpose registers are 64 bits wide.
9239 @item -mfp32
9240 @opindex mfp32
9241 Assume that floating-point registers are 32 bits wide.
9243 @item -mfp64
9244 @opindex mfp64
9245 Assume that floating-point registers are 64 bits wide.
9247 @item -mhard-float
9248 @opindex mhard-float
9249 Use floating-point coprocessor instructions.
9251 @item -msoft-float
9252 @opindex msoft-float
9253 Do not use floating-point coprocessor instructions.  Implement
9254 floating-point calculations using library calls instead.
9256 @item -msingle-float
9257 @opindex msingle-float
9258 Assume that the floating-point coprocessor only supports single-precision
9259 operations.
9261 @itemx -mdouble-float
9262 @opindex mdouble-float
9263 Assume that the floating-point coprocessor supports double-precision
9264 operations.  This is the default.
9266 @itemx -mpaired-single
9267 @itemx -mno-paired-single
9268 @opindex mpaired-single
9269 @opindex mno-paired-single
9270 Use (do not use) the paired single instructions.
9272 @itemx -mips3d
9273 @itemx -mno-mips3d
9274 @opindex mips3d
9275 @opindex mno-mips3d
9276 Use (do not use) the MIPS-3D ASE.  The option @option{-mips3d} implies
9277 @option{-mpaired-single}.
9279 @item -mint64
9280 @opindex mint64
9281 Force @code{int} and @code{long} types to be 64 bits wide.  See
9282 @option{-mlong32} for an explanation of the default and the way
9283 that the pointer size is determined.
9285 @item -mlong64
9286 @opindex mlong64
9287 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9288 an explanation of the default and the way that the pointer size is
9289 determined.
9291 @item -mlong32
9292 @opindex mlong32
9293 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9295 The default size of @code{int}s, @code{long}s and pointers depends on
9296 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9297 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9298 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9299 or the same size as integer registers, whichever is smaller.
9301 @item -G @var{num}
9302 @opindex G
9303 @cindex smaller data references (MIPS)
9304 @cindex gp-relative references (MIPS)
9305 Put global and static items less than or equal to @var{num} bytes into
9306 the small data or bss section instead of the normal data or bss section.
9307 This allows the data to be accessed using a single instruction.
9309 All modules should be compiled with the same @option{-G @var{num}}
9310 value.
9312 @item -membedded-data
9313 @itemx -mno-embedded-data
9314 @opindex membedded-data
9315 @opindex mno-embedded-data
9316 Allocate variables to the read-only data section first if possible, then
9317 next in the small data section if possible, otherwise in data.  This gives
9318 slightly slower code than the default, but reduces the amount of RAM required
9319 when executing, and thus may be preferred for some embedded systems.
9321 @item -muninit-const-in-rodata
9322 @itemx -mno-uninit-const-in-rodata
9323 @opindex muninit-const-in-rodata
9324 @opindex mno-uninit-const-in-rodata
9325 Put uninitialized @code{const} variables in the read-only data section.
9326 This option is only meaningful in conjunction with @option{-membedded-data}.
9328 @item -msplit-addresses
9329 @itemx -mno-split-addresses
9330 @opindex msplit-addresses
9331 @opindex mno-split-addresses
9332 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9333 relocation operators.  This option has been superceded by
9334 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9336 @item -mexplicit-relocs
9337 @itemx -mno-explicit-relocs
9338 @opindex mexplicit-relocs
9339 @opindex mno-explicit-relocs
9340 Use (do not use) assembler relocation operators when dealing with symbolic
9341 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9342 is to use assembler macros instead.
9344 @option{-mexplicit-relocs} is the default if GCC was configured
9345 to use an assembler that supports relocation operators.
9347 @item -mcheck-zero-division
9348 @itemx -mno-check-zero-division
9349 @opindex mcheck-zero-division
9350 @opindex mno-check-zero-division
9351 Trap (do not trap) on integer division by zero.  The default is
9352 @option{-mcheck-zero-division}.
9354 @item -mmemcpy
9355 @itemx -mno-memcpy
9356 @opindex mmemcpy
9357 @opindex mno-memcpy
9358 Force (do not force) the use of @code{memcpy()} for non-trivial block
9359 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9360 most constant-sized copies.
9362 @item -mlong-calls
9363 @itemx -mno-long-calls
9364 @opindex mlong-calls
9365 @opindex mno-long-calls
9366 Disable (do not disable) use of the @code{jal} instruction.  Calling
9367 functions using @code{jal} is more efficient but requires the caller
9368 and callee to be in the same 256 megabyte segment.
9370 This option has no effect on abicalls code.  The default is
9371 @option{-mno-long-calls}.
9373 @item -mmad
9374 @itemx -mno-mad
9375 @opindex mmad
9376 @opindex mno-mad
9377 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9378 instructions, as provided by the R4650 ISA.
9380 @item -mfused-madd
9381 @itemx -mno-fused-madd
9382 @opindex mfused-madd
9383 @opindex mno-fused-madd
9384 Enable (disable) use of the floating point multiply-accumulate
9385 instructions, when they are available.  The default is
9386 @option{-mfused-madd}.
9388 When multiply-accumulate instructions are used, the intermediate
9389 product is calculated to infinite precision and is not subject to
9390 the FCSR Flush to Zero bit.  This may be undesirable in some
9391 circumstances.
9393 @item -nocpp
9394 @opindex nocpp
9395 Tell the MIPS assembler to not run its preprocessor over user
9396 assembler files (with a @samp{.s} suffix) when assembling them.
9398 @item -mfix-r4000
9399 @itemx -mno-fix-r4000
9400 @opindex mfix-r4000
9401 @opindex mno-fix-r4000
9402 Work around certain R4000 CPU errata:
9403 @itemize @minus
9404 @item
9405 A double-word or a variable shift may give an incorrect result if executed
9406 immediately after starting an integer division.
9407 @item
9408 A double-word or a variable shift may give an incorrect result if executed
9409 while an integer multiplication is in progress.
9410 @item
9411 An integer division may give an incorrect result if started in a delay slot
9412 of a taken branch or a jump.
9413 @end itemize
9415 @item -mfix-r4400
9416 @itemx -mno-fix-r4400
9417 @opindex mfix-r4400
9418 @opindex mno-fix-r4400
9419 Work around certain R4400 CPU errata:
9420 @itemize @minus
9421 @item
9422 A double-word or a variable shift may give an incorrect result if executed
9423 immediately after starting an integer division.
9424 @end itemize
9426 @item -mfix-vr4120
9427 @itemx -mno-fix-vr4120
9428 @opindex mfix-vr4120
9429 Work around certain VR4120 errata:
9430 @itemize @minus
9431 @item
9432 @code{dmultu} does not always produce the correct result.
9433 @item
9434 @code{div} and @code{ddiv} do not always produce the correct result if one
9435 of the operands is negative.
9436 @end itemize
9437 The workarounds for the division errata rely on special functions in
9438 @file{libgcc.a}.  At present, these functions are only provided by
9439 the @code{mips64vr*-elf} configurations.
9441 Other VR4120 errata require a nop to be inserted between certain pairs of
9442 instructions.  These errata are handled by the assembler, not by GCC itself.
9444 @item -mfix-sb1
9445 @itemx -mno-fix-sb1
9446 @opindex mfix-sb1
9447 Work around certain SB-1 CPU core errata.
9448 (This flag currently works around the SB-1 revision 2
9449 ``F1'' and ``F2'' floating point errata.)
9451 @item -mflush-func=@var{func}
9452 @itemx -mno-flush-func
9453 @opindex mflush-func
9454 Specifies the function to call to flush the I and D caches, or to not
9455 call any such function.  If called, the function must take the same
9456 arguments as the common @code{_flush_func()}, that is, the address of the
9457 memory range for which the cache is being flushed, the size of the
9458 memory range, and the number 3 (to flush both caches).  The default
9459 depends on the target GCC was configured for, but commonly is either
9460 @samp{_flush_func} or @samp{__cpu_flush}.
9462 @item -mbranch-likely
9463 @itemx -mno-branch-likely
9464 @opindex mbranch-likely
9465 @opindex mno-branch-likely
9466 Enable or disable use of Branch Likely instructions, regardless of the
9467 default for the selected architecture.  By default, Branch Likely
9468 instructions may be generated if they are supported by the selected
9469 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9470 and processors which implement those architectures; for those, Branch
9471 Likely instructions will not be generated by default because the MIPS32
9472 and MIPS64 architectures specifically deprecate their use.
9474 @item -mfp-exceptions
9475 @itemx -mno-fp-exceptions
9476 @opindex mfp-exceptions
9477 Specifies whether FP exceptions are enabled.  This affects how we schedule
9478 FP instructions for some processors.  The default is that FP exceptions are
9479 enabled.
9481 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9482 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9483 FP pipe.
9485 @item -mvr4130-align
9486 @itemx -mno-vr4130-align
9487 @opindex mvr4130-align
9488 The VR4130 pipeline is two-way superscalar, but can only issue two
9489 instructions together if the first one is 8-byte aligned.  When this
9490 option is enabled, GCC will align pairs of instructions that it
9491 thinks should execute in parallel.
9493 This option only has an effect when optimizing for the VR4130.
9494 It normally makes code faster, but at the expense of making it bigger.
9495 It is enabled by default at optimization level @option{-O3}.
9496 @end table
9498 @node MMIX Options
9499 @subsection MMIX Options
9500 @cindex MMIX Options
9502 These options are defined for the MMIX:
9504 @table @gcctabopt
9505 @item -mlibfuncs
9506 @itemx -mno-libfuncs
9507 @opindex mlibfuncs
9508 @opindex mno-libfuncs
9509 Specify that intrinsic library functions are being compiled, passing all
9510 values in registers, no matter the size.
9512 @item -mepsilon
9513 @itemx -mno-epsilon
9514 @opindex mepsilon
9515 @opindex mno-epsilon
9516 Generate floating-point comparison instructions that compare with respect
9517 to the @code{rE} epsilon register.
9519 @item -mabi=mmixware
9520 @itemx -mabi=gnu
9521 @opindex mabi-mmixware
9522 @opindex mabi=gnu
9523 Generate code that passes function parameters and return values that (in
9524 the called function) are seen as registers @code{$0} and up, as opposed to
9525 the GNU ABI which uses global registers @code{$231} and up.
9527 @item -mzero-extend
9528 @itemx -mno-zero-extend
9529 @opindex mzero-extend
9530 @opindex mno-zero-extend
9531 When reading data from memory in sizes shorter than 64 bits, use (do not
9532 use) zero-extending load instructions by default, rather than
9533 sign-extending ones.
9535 @item -mknuthdiv
9536 @itemx -mno-knuthdiv
9537 @opindex mknuthdiv
9538 @opindex mno-knuthdiv
9539 Make the result of a division yielding a remainder have the same sign as
9540 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9541 remainder follows the sign of the dividend.  Both methods are
9542 arithmetically valid, the latter being almost exclusively used.
9544 @item -mtoplevel-symbols
9545 @itemx -mno-toplevel-symbols
9546 @opindex mtoplevel-symbols
9547 @opindex mno-toplevel-symbols
9548 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9549 code can be used with the @code{PREFIX} assembly directive.
9551 @item -melf
9552 @opindex melf
9553 Generate an executable in the ELF format, rather than the default
9554 @samp{mmo} format used by the @command{mmix} simulator.
9556 @item -mbranch-predict
9557 @itemx -mno-branch-predict
9558 @opindex mbranch-predict
9559 @opindex mno-branch-predict
9560 Use (do not use) the probable-branch instructions, when static branch
9561 prediction indicates a probable branch.
9563 @item -mbase-addresses
9564 @itemx -mno-base-addresses
9565 @opindex mbase-addresses
9566 @opindex mno-base-addresses
9567 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9568 base address automatically generates a request (handled by the assembler
9569 and the linker) for a constant to be set up in a global register.  The
9570 register is used for one or more base address requests within the range 0
9571 to 255 from the value held in the register.  The generally leads to short
9572 and fast code, but the number of different data items that can be
9573 addressed is limited.  This means that a program that uses lots of static
9574 data may require @option{-mno-base-addresses}.
9576 @item -msingle-exit
9577 @itemx -mno-single-exit
9578 @opindex msingle-exit
9579 @opindex mno-single-exit
9580 Force (do not force) generated code to have a single exit point in each
9581 function.
9582 @end table
9584 @node MN10300 Options
9585 @subsection MN10300 Options
9586 @cindex MN10300 options
9588 These @option{-m} options are defined for Matsushita MN10300 architectures:
9590 @table @gcctabopt
9591 @item -mmult-bug
9592 @opindex mmult-bug
9593 Generate code to avoid bugs in the multiply instructions for the MN10300
9594 processors.  This is the default.
9596 @item -mno-mult-bug
9597 @opindex mno-mult-bug
9598 Do not generate code to avoid bugs in the multiply instructions for the
9599 MN10300 processors.
9601 @item -mam33
9602 @opindex mam33
9603 Generate code which uses features specific to the AM33 processor.
9605 @item -mno-am33
9606 @opindex mno-am33
9607 Do not generate code which uses features specific to the AM33 processor.  This
9608 is the default.
9610 @item -mno-crt0
9611 @opindex mno-crt0
9612 Do not link in the C run-time initialization object file.
9614 @item -mrelax
9615 @opindex mrelax
9616 Indicate to the linker that it should perform a relaxation optimization pass
9617 to shorten branches, calls and absolute memory addresses.  This option only
9618 has an effect when used on the command line for the final link step.
9620 This option makes symbolic debugging impossible.
9621 @end table
9623 @node NS32K Options
9624 @subsection NS32K Options
9625 @cindex NS32K options
9627 These are the @samp{-m} options defined for the 32000 series.  The default
9628 values for these options depends on which style of 32000 was selected when
9629 the compiler was configured; the defaults for the most common choices are
9630 given below.
9632 @table @gcctabopt
9633 @item -m32032
9634 @itemx -m32032
9635 @opindex m32032
9636 @opindex m32032
9637 Generate output for a 32032.  This is the default
9638 when the compiler is configured for 32032 and 32016 based systems.
9640 @item -m32332
9641 @itemx -m32332
9642 @opindex m32332
9643 @opindex m32332
9644 Generate output for a 32332.  This is the default
9645 when the compiler is configured for 32332-based systems.
9647 @item -m32532
9648 @itemx -m32532
9649 @opindex m32532
9650 @opindex m32532
9651 Generate output for a 32532.  This is the default
9652 when the compiler is configured for 32532-based systems.
9654 @item -m32081
9655 @opindex m32081
9656 Generate output containing 32081 instructions for floating point.
9657 This is the default for all systems.
9659 @item -m32381
9660 @opindex m32381
9661 Generate output containing 32381 instructions for floating point.  This
9662 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
9663 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
9665 @item -mmulti-add
9666 @opindex mmulti-add
9667 Try and generate multiply-add floating point instructions @code{polyF}
9668 and @code{dotF}.  This option is only available if the @option{-m32381}
9669 option is in effect.  Using these instructions requires changes to
9670 register allocation which generally has a negative impact on
9671 performance.  This option should only be enabled when compiling code
9672 particularly likely to make heavy use of multiply-add instructions.
9674 @item -mnomulti-add
9675 @opindex mnomulti-add
9676 Do not try and generate multiply-add floating point instructions
9677 @code{polyF} and @code{dotF}.  This is the default on all platforms.
9679 @item -msoft-float
9680 @opindex msoft-float
9681 Generate output containing library calls for floating point.
9682 @strong{Warning:} the requisite libraries may not be available.
9684 @item -mieee-compare
9685 @itemx -mno-ieee-compare
9686 @opindex mieee-compare
9687 @opindex mno-ieee-compare
9688 Control whether or not the compiler uses IEEE floating point
9689 comparisons.  These handle correctly the case where the result of a
9690 comparison is unordered.
9691 @strong{Warning:} the requisite kernel support may not be available.
9693 @item -mnobitfield
9694 @opindex mnobitfield
9695 Do not use the bit-field instructions.  On some machines it is faster to
9696 use shifting and masking operations.  This is the default for the pc532.
9698 @item -mbitfield
9699 @opindex mbitfield
9700 Do use the bit-field instructions.  This is the default for all platforms
9701 except the pc532.
9703 @item -mrtd
9704 @opindex mrtd
9705 Use a different function-calling convention, in which functions
9706 that take a fixed number of arguments return pop their
9707 arguments on return with the @code{ret} instruction.
9709 This calling convention is incompatible with the one normally
9710 used on Unix, so you cannot use it if you need to call libraries
9711 compiled with the Unix compiler.
9713 Also, you must provide function prototypes for all functions that
9714 take variable numbers of arguments (including @code{printf});
9715 otherwise incorrect code will be generated for calls to those
9716 functions.
9718 In addition, seriously incorrect code will result if you call a
9719 function with too many arguments.  (Normally, extra arguments are
9720 harmlessly ignored.)
9722 This option takes its name from the 680x0 @code{rtd} instruction.
9725 @item -mregparam
9726 @opindex mregparam
9727 Use a different function-calling convention where the first two arguments
9728 are passed in registers.
9730 This calling convention is incompatible with the one normally
9731 used on Unix, so you cannot use it if you need to call libraries
9732 compiled with the Unix compiler.
9734 @item -mnoregparam
9735 @opindex mnoregparam
9736 Do not pass any arguments in registers.  This is the default for all
9737 targets.
9739 @item -msb
9740 @opindex msb
9741 It is OK to use the sb as an index register which is always loaded with
9742 zero.  This is the default for the pc532-netbsd target.
9744 @item -mnosb
9745 @opindex mnosb
9746 The sb register is not available for use or has not been initialized to
9747 zero by the run time system.  This is the default for all targets except
9748 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
9749 @option{-fpic} is set.
9751 @item -mhimem
9752 @opindex mhimem
9753 Many ns32000 series addressing modes use displacements of up to 512MB@.
9754 If an address is above 512MB then displacements from zero can not be used.
9755 This option causes code to be generated which can be loaded above 512MB@.
9756 This may be useful for operating systems or ROM code.
9758 @item -mnohimem
9759 @opindex mnohimem
9760 Assume code will be loaded in the first 512MB of virtual address space.
9761 This is the default for all platforms.
9763 @end table
9765 @node PDP-11 Options
9766 @subsection PDP-11 Options
9767 @cindex PDP-11 Options
9769 These options are defined for the PDP-11:
9771 @table @gcctabopt
9772 @item -mfpu
9773 @opindex mfpu
9774 Use hardware FPP floating point.  This is the default.  (FIS floating
9775 point on the PDP-11/40 is not supported.)
9777 @item -msoft-float
9778 @opindex msoft-float
9779 Do not use hardware floating point.
9781 @item -mac0
9782 @opindex mac0
9783 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
9785 @item -mno-ac0
9786 @opindex mno-ac0
9787 Return floating-point results in memory.  This is the default.
9789 @item -m40
9790 @opindex m40
9791 Generate code for a PDP-11/40.
9793 @item -m45
9794 @opindex m45
9795 Generate code for a PDP-11/45.  This is the default.
9797 @item -m10
9798 @opindex m10
9799 Generate code for a PDP-11/10.
9801 @item -mbcopy-builtin
9802 @opindex bcopy-builtin
9803 Use inline @code{movmemhi} patterns for copying memory.  This is the
9804 default.
9806 @item -mbcopy
9807 @opindex mbcopy
9808 Do not use inline @code{movmemhi} patterns for copying memory.
9810 @item -mint16
9811 @itemx -mno-int32
9812 @opindex mint16
9813 @opindex mno-int32
9814 Use 16-bit @code{int}.  This is the default.
9816 @item -mint32
9817 @itemx -mno-int16
9818 @opindex mint32
9819 @opindex mno-int16
9820 Use 32-bit @code{int}.
9822 @item -mfloat64
9823 @itemx -mno-float32
9824 @opindex mfloat64
9825 @opindex mno-float32
9826 Use 64-bit @code{float}.  This is the default.
9828 @item -mfloat32
9829 @itemx -mno-float64
9830 @opindex mfloat32
9831 @opindex mno-float64
9832 Use 32-bit @code{float}.
9834 @item -mabshi
9835 @opindex mabshi
9836 Use @code{abshi2} pattern.  This is the default.
9838 @item -mno-abshi
9839 @opindex mno-abshi
9840 Do not use @code{abshi2} pattern.
9842 @item -mbranch-expensive
9843 @opindex mbranch-expensive
9844 Pretend that branches are expensive.  This is for experimenting with
9845 code generation only.
9847 @item -mbranch-cheap
9848 @opindex mbranch-cheap
9849 Do not pretend that branches are expensive.  This is the default.
9851 @item -msplit
9852 @opindex msplit
9853 Generate code for a system with split I&D.
9855 @item -mno-split
9856 @opindex mno-split
9857 Generate code for a system without split I&D.  This is the default.
9859 @item -munix-asm
9860 @opindex munix-asm
9861 Use Unix assembler syntax.  This is the default when configured for
9862 @samp{pdp11-*-bsd}.
9864 @item -mdec-asm
9865 @opindex mdec-asm
9866 Use DEC assembler syntax.  This is the default when configured for any
9867 PDP-11 target other than @samp{pdp11-*-bsd}.
9868 @end table
9870 @node PowerPC Options
9871 @subsection PowerPC Options
9872 @cindex PowerPC options
9874 These are listed under @xref{RS/6000 and PowerPC Options}.
9876 @node RS/6000 and PowerPC Options
9877 @subsection IBM RS/6000 and PowerPC Options
9878 @cindex RS/6000 and PowerPC Options
9879 @cindex IBM RS/6000 and PowerPC Options
9881 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
9882 @table @gcctabopt
9883 @item -mpower
9884 @itemx -mno-power
9885 @itemx -mpower2
9886 @itemx -mno-power2
9887 @itemx -mpowerpc
9888 @itemx -mno-powerpc
9889 @itemx -mpowerpc-gpopt
9890 @itemx -mno-powerpc-gpopt
9891 @itemx -mpowerpc-gfxopt
9892 @itemx -mno-powerpc-gfxopt
9893 @itemx -mpowerpc64
9894 @itemx -mno-powerpc64
9895 @opindex mpower
9896 @opindex mno-power
9897 @opindex mpower2
9898 @opindex mno-power2
9899 @opindex mpowerpc
9900 @opindex mno-powerpc
9901 @opindex mpowerpc-gpopt
9902 @opindex mno-powerpc-gpopt
9903 @opindex mpowerpc-gfxopt
9904 @opindex mno-powerpc-gfxopt
9905 @opindex mpowerpc64
9906 @opindex mno-powerpc64
9907 GCC supports two related instruction set architectures for the
9908 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
9909 instructions supported by the @samp{rios} chip set used in the original
9910 RS/6000 systems and the @dfn{PowerPC} instruction set is the
9911 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
9912 the IBM 4xx microprocessors.
9914 Neither architecture is a subset of the other.  However there is a
9915 large common subset of instructions supported by both.  An MQ
9916 register is included in processors supporting the POWER architecture.
9918 You use these options to specify which instructions are available on the
9919 processor you are using.  The default value of these options is
9920 determined when configuring GCC@.  Specifying the
9921 @option{-mcpu=@var{cpu_type}} overrides the specification of these
9922 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
9923 rather than the options listed above.
9925 The @option{-mpower} option allows GCC to generate instructions that
9926 are found only in the POWER architecture and to use the MQ register.
9927 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
9928 to generate instructions that are present in the POWER2 architecture but
9929 not the original POWER architecture.
9931 The @option{-mpowerpc} option allows GCC to generate instructions that
9932 are found only in the 32-bit subset of the PowerPC architecture.
9933 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
9934 GCC to use the optional PowerPC architecture instructions in the
9935 General Purpose group, including floating-point square root.  Specifying
9936 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
9937 use the optional PowerPC architecture instructions in the Graphics
9938 group, including floating-point select.
9940 The @option{-mpowerpc64} option allows GCC to generate the additional
9941 64-bit instructions that are found in the full PowerPC64 architecture
9942 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
9943 @option{-mno-powerpc64}.
9945 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
9946 will use only the instructions in the common subset of both
9947 architectures plus some special AIX common-mode calls, and will not use
9948 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
9949 permits GCC to use any instruction from either architecture and to
9950 allow use of the MQ register; specify this for the Motorola MPC601.
9952 @item -mnew-mnemonics
9953 @itemx -mold-mnemonics
9954 @opindex mnew-mnemonics
9955 @opindex mold-mnemonics
9956 Select which mnemonics to use in the generated assembler code.  With
9957 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
9958 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
9959 assembler mnemonics defined for the POWER architecture.  Instructions
9960 defined in only one architecture have only one mnemonic; GCC uses that
9961 mnemonic irrespective of which of these options is specified.
9963 GCC defaults to the mnemonics appropriate for the architecture in
9964 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
9965 value of these option.  Unless you are building a cross-compiler, you
9966 should normally not specify either @option{-mnew-mnemonics} or
9967 @option{-mold-mnemonics}, but should instead accept the default.
9969 @item -mcpu=@var{cpu_type}
9970 @opindex mcpu
9971 Set architecture type, register usage, choice of mnemonics, and
9972 instruction scheduling parameters for machine type @var{cpu_type}.
9973 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
9974 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
9975 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
9976 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
9977 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
9978 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
9979 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
9980 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
9981 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
9983 @option{-mcpu=common} selects a completely generic processor.  Code
9984 generated under this option will run on any POWER or PowerPC processor.
9985 GCC will use only the instructions in the common subset of both
9986 architectures, and will not use the MQ register.  GCC assumes a generic
9987 processor model for scheduling purposes.
9989 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
9990 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
9991 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
9992 types, with an appropriate, generic processor model assumed for
9993 scheduling purposes.
9995 The other options specify a specific processor.  Code generated under
9996 those options will run best on that processor, and may not run at all on
9997 others.
9999 The @option{-mcpu} options automatically enable or disable the
10000 following options: @option{-maltivec}, @option{-mhard-float},
10001 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10002 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10003 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10004 @option{-mstring}.  The particular options set for any particular CPU
10005 will vary between compiler versions, depending on what setting seems
10006 to produce optimal code for that CPU; it doesn't necessarily reflect
10007 the actual hardware's capabilities.  If you wish to set an individual
10008 option to a particular value, you may specify it after the
10009 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10011 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10012 not enabled or disabled by the @option{-mcpu} option at present, since
10013 AIX does not have full support for these options.  You may still
10014 enable or disable them individually if you're sure it'll work in your
10015 environment.
10017 @item -mtune=@var{cpu_type}
10018 @opindex mtune
10019 Set the instruction scheduling parameters for machine type
10020 @var{cpu_type}, but do not set the architecture type, register usage, or
10021 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10022 values for @var{cpu_type} are used for @option{-mtune} as for
10023 @option{-mcpu}.  If both are specified, the code generated will use the
10024 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10025 scheduling parameters set by @option{-mtune}.
10027 @item -maltivec
10028 @itemx -mno-altivec
10029 @opindex maltivec
10030 @opindex mno-altivec
10031 These switches enable or disable the use of built-in functions that
10032 allow access to the AltiVec instruction set.  You may also need to set
10033 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10034 enhancements.
10036 @item -mabi=spe
10037 @opindex mabi=spe
10038 Extend the current ABI with SPE ABI extensions.  This does not change
10039 the default ABI, instead it adds the SPE ABI extensions to the current
10040 ABI@.
10042 @item -mabi=no-spe
10043 @opindex mabi=no-spe
10044 Disable Booke SPE ABI extensions for the current ABI.
10046 @item -misel=@var{yes/no}
10047 @itemx -misel
10048 @opindex misel
10049 This switch enables or disables the generation of ISEL instructions.
10051 @item -mspe=@var{yes/no}
10052 @itemx -mspe
10053 @opindex mspe
10054 This switch enables or disables the generation of SPE simd
10055 instructions.
10057 @item -mfloat-gprs=@var{yes/no}
10058 @itemx -mfloat-gprs
10059 @opindex mfloat-gprs
10060 This switch enables or disables the generation of floating point
10061 operations on the general purpose registers for architectures that
10062 support it.  This option is currently only available on the MPC8540.
10064 @item -m32
10065 @itemx -m64
10066 @opindex m32
10067 @opindex m64
10068 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10069 targets (including GNU/Linux).  The 32-bit environment sets int, long
10070 and pointer to 32 bits and generates code that runs on any PowerPC
10071 variant.  The 64-bit environment sets int to 32 bits and long and
10072 pointer to 64 bits, and generates code for PowerPC64, as for
10073 @option{-mpowerpc64}.
10075 @item -mfull-toc
10076 @itemx -mno-fp-in-toc
10077 @itemx -mno-sum-in-toc
10078 @itemx -mminimal-toc
10079 @opindex mfull-toc
10080 @opindex mno-fp-in-toc
10081 @opindex mno-sum-in-toc
10082 @opindex mminimal-toc
10083 Modify generation of the TOC (Table Of Contents), which is created for
10084 every executable file.  The @option{-mfull-toc} option is selected by
10085 default.  In that case, GCC will allocate at least one TOC entry for
10086 each unique non-automatic variable reference in your program.  GCC
10087 will also place floating-point constants in the TOC@.  However, only
10088 16,384 entries are available in the TOC@.
10090 If you receive a linker error message that saying you have overflowed
10091 the available TOC space, you can reduce the amount of TOC space used
10092 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10093 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10094 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10095 generate code to calculate the sum of an address and a constant at
10096 run-time instead of putting that sum into the TOC@.  You may specify one
10097 or both of these options.  Each causes GCC to produce very slightly
10098 slower and larger code at the expense of conserving TOC space.
10100 If you still run out of space in the TOC even when you specify both of
10101 these options, specify @option{-mminimal-toc} instead.  This option causes
10102 GCC to make only one TOC entry for every file.  When you specify this
10103 option, GCC will produce code that is slower and larger but which
10104 uses extremely little TOC space.  You may wish to use this option
10105 only on files that contain less frequently executed code.
10107 @item -maix64
10108 @itemx -maix32
10109 @opindex maix64
10110 @opindex maix32
10111 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10112 @code{long} type, and the infrastructure needed to support them.
10113 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10114 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10115 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10117 @item -mxl-call
10118 @itemx -mno-xl-call
10119 @opindex mxl-call
10120 @opindex mno-xl-call
10121 On AIX, pass floating-point arguments to prototyped functions beyond the
10122 register save area (RSA) on the stack in addition to argument FPRs.  The
10123 AIX calling convention was extended but not initially documented to
10124 handle an obscure K&R C case of calling a function that takes the
10125 address of its arguments with fewer arguments than declared.  AIX XL
10126 compilers access floating point arguments which do not fit in the
10127 RSA from the stack when a subroutine is compiled without
10128 optimization.  Because always storing floating-point arguments on the
10129 stack is inefficient and rarely needed, this option is not enabled by
10130 default and only is necessary when calling subroutines compiled by AIX
10131 XL compilers without optimization.
10133 @item -mpe
10134 @opindex mpe
10135 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10136 application written to use message passing with special startup code to
10137 enable the application to run.  The system must have PE installed in the
10138 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10139 must be overridden with the @option{-specs=} option to specify the
10140 appropriate directory location.  The Parallel Environment does not
10141 support threads, so the @option{-mpe} option and the @option{-pthread}
10142 option are incompatible.
10144 @item -malign-natural
10145 @itemx -malign-power
10146 @opindex malign-natural
10147 @opindex malign-power
10148 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10149 @option{-malign-natural} overrides the ABI-defined alignment of larger
10150 types, such as floating-point doubles, on their natural size-based boundary.
10151 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10152 alignment rules.  GCC defaults to the standard alignment defined in the ABI.
10154 @item -msoft-float
10155 @itemx -mhard-float
10156 @opindex msoft-float
10157 @opindex mhard-float
10158 Generate code that does not use (uses) the floating-point register set.
10159 Software floating point emulation is provided if you use the
10160 @option{-msoft-float} option, and pass the option to GCC when linking.
10162 @item -mmultiple
10163 @itemx -mno-multiple
10164 @opindex mmultiple
10165 @opindex mno-multiple
10166 Generate code that uses (does not use) the load multiple word
10167 instructions and the store multiple word instructions.  These
10168 instructions are generated by default on POWER systems, and not
10169 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10170 endian PowerPC systems, since those instructions do not work when the
10171 processor is in little endian mode.  The exceptions are PPC740 and
10172 PPC750 which permit the instructions usage in little endian mode.
10174 @item -mstring
10175 @itemx -mno-string
10176 @opindex mstring
10177 @opindex mno-string
10178 Generate code that uses (does not use) the load string instructions
10179 and the store string word instructions to save multiple registers and
10180 do small block moves.  These instructions are generated by default on
10181 POWER systems, and not generated on PowerPC systems.  Do not use
10182 @option{-mstring} on little endian PowerPC systems, since those
10183 instructions do not work when the processor is in little endian mode.
10184 The exceptions are PPC740 and PPC750 which permit the instructions
10185 usage in little endian mode.
10187 @item -mupdate
10188 @itemx -mno-update
10189 @opindex mupdate
10190 @opindex mno-update
10191 Generate code that uses (does not use) the load or store instructions
10192 that update the base register to the address of the calculated memory
10193 location.  These instructions are generated by default.  If you use
10194 @option{-mno-update}, there is a small window between the time that the
10195 stack pointer is updated and the address of the previous frame is
10196 stored, which means code that walks the stack frame across interrupts or
10197 signals may get corrupted data.
10199 @item -mfused-madd
10200 @itemx -mno-fused-madd
10201 @opindex mfused-madd
10202 @opindex mno-fused-madd
10203 Generate code that uses (does not use) the floating point multiply and
10204 accumulate instructions.  These instructions are generated by default if
10205 hardware floating is used.
10207 @item -mno-bit-align
10208 @itemx -mbit-align
10209 @opindex mno-bit-align
10210 @opindex mbit-align
10211 On System V.4 and embedded PowerPC systems do not (do) force structures
10212 and unions that contain bit-fields to be aligned to the base type of the
10213 bit-field.
10215 For example, by default a structure containing nothing but 8
10216 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10217 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10218 the structure would be aligned to a 1 byte boundary and be one byte in
10219 size.
10221 @item -mno-strict-align
10222 @itemx -mstrict-align
10223 @opindex mno-strict-align
10224 @opindex mstrict-align
10225 On System V.4 and embedded PowerPC systems do not (do) assume that
10226 unaligned memory references will be handled by the system.
10228 @item -mrelocatable
10229 @itemx -mno-relocatable
10230 @opindex mrelocatable
10231 @opindex mno-relocatable
10232 On embedded PowerPC systems generate code that allows (does not allow)
10233 the program to be relocated to a different address at runtime.  If you
10234 use @option{-mrelocatable} on any module, all objects linked together must
10235 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10237 @item -mrelocatable-lib
10238 @itemx -mno-relocatable-lib
10239 @opindex mrelocatable-lib
10240 @opindex mno-relocatable-lib
10241 On embedded PowerPC systems generate code that allows (does not allow)
10242 the program to be relocated to a different address at runtime.  Modules
10243 compiled with @option{-mrelocatable-lib} can be linked with either modules
10244 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10245 with modules compiled with the @option{-mrelocatable} options.
10247 @item -mno-toc
10248 @itemx -mtoc
10249 @opindex mno-toc
10250 @opindex mtoc
10251 On System V.4 and embedded PowerPC systems do not (do) assume that
10252 register 2 contains a pointer to a global area pointing to the addresses
10253 used in the program.
10255 @item -mlittle
10256 @itemx -mlittle-endian
10257 @opindex mlittle
10258 @opindex mlittle-endian
10259 On System V.4 and embedded PowerPC systems compile code for the
10260 processor in little endian mode.  The @option{-mlittle-endian} option is
10261 the same as @option{-mlittle}.
10263 @item -mbig
10264 @itemx -mbig-endian
10265 @opindex mbig
10266 @opindex mbig-endian
10267 On System V.4 and embedded PowerPC systems compile code for the
10268 processor in big endian mode.  The @option{-mbig-endian} option is
10269 the same as @option{-mbig}.
10271 @item -mdynamic-no-pic
10272 @opindex mdynamic-no-pic
10273 On Darwin and Mac OS X systems, compile code so that it is not
10274 relocatable, but that its external references are relocatable.  The
10275 resulting code is suitable for applications, but not shared
10276 libraries.
10278 @item -mprioritize-restricted-insns=@var{priority}
10279 @opindex mprioritize-restricted-insns
10280 This option controls the priority that is assigned to
10281 dispatch-slot restricted instructions during the second scheduling
10282 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10283 @var{no/highest/second-highest} priority to dispatch slot restricted
10284 instructions.
10286 @item -msched-costly-dep=@var{dependence_type}
10287 @opindex msched-costly-dep
10288 This option controls which dependences are considered costly
10289 by the target during instruction scheduling.  The argument
10290 @var{dependence_type} takes one of the following values:
10291 @var{no}: no dependence is costly,
10292 @var{all}: all dependences are costly,
10293 @var{true_store_to_load}: a true dependence from store to load is costly,
10294 @var{store_to_load}: any dependence from store to load is costly,
10295 @var{number}: any dependence which latency >= @var{number} is costly.
10297 @item -minsert-sched-nops=@var{scheme}
10298 @opindex minsert-sched-nops
10299 This option controls which nop insertion scheme will be used during
10300 the second scheduling pass. The argument @var{scheme} takes one of the
10301 following values:
10302 @var{no}: Don't insert nops.
10303 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10304 according to the scheduler's grouping.
10305 @var{regroup_exact}: Insert nops to force costly dependent insns into
10306 separate groups.  Insert exactly as many nops as needed to force an insn
10307 to a new group, according to the estimated processor grouping.
10308 @var{number}: Insert nops to force costly dependent insns into
10309 separate groups.  Insert @var{number} nops to force an insn to a new group.
10311 @item -mcall-sysv
10312 @opindex mcall-sysv
10313 On System V.4 and embedded PowerPC systems compile code using calling
10314 conventions that adheres to the March 1995 draft of the System V
10315 Application Binary Interface, PowerPC processor supplement.  This is the
10316 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10318 @item -mcall-sysv-eabi
10319 @opindex mcall-sysv-eabi
10320 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10322 @item -mcall-sysv-noeabi
10323 @opindex mcall-sysv-noeabi
10324 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10326 @item -mcall-solaris
10327 @opindex mcall-solaris
10328 On System V.4 and embedded PowerPC systems compile code for the Solaris
10329 operating system.
10331 @item -mcall-linux
10332 @opindex mcall-linux
10333 On System V.4 and embedded PowerPC systems compile code for the
10334 Linux-based GNU system.
10336 @item -mcall-gnu
10337 @opindex mcall-gnu
10338 On System V.4 and embedded PowerPC systems compile code for the
10339 Hurd-based GNU system.
10341 @item -mcall-netbsd
10342 @opindex mcall-netbsd
10343 On System V.4 and embedded PowerPC systems compile code for the
10344 NetBSD operating system.
10346 @item -maix-struct-return
10347 @opindex maix-struct-return
10348 Return all structures in memory (as specified by the AIX ABI)@.
10350 @item -msvr4-struct-return
10351 @opindex msvr4-struct-return
10352 Return structures smaller than 8 bytes in registers (as specified by the
10353 SVR4 ABI)@.
10355 @item -mabi=altivec
10356 @opindex mabi=altivec
10357 Extend the current ABI with AltiVec ABI extensions.  This does not
10358 change the default ABI, instead it adds the AltiVec ABI extensions to
10359 the current ABI@.
10361 @item -mabi=no-altivec
10362 @opindex mabi=no-altivec
10363 Disable AltiVec ABI extensions for the current ABI.
10365 @item -mprototype
10366 @itemx -mno-prototype
10367 @opindex mprototype
10368 @opindex mno-prototype
10369 On System V.4 and embedded PowerPC systems assume that all calls to
10370 variable argument functions are properly prototyped.  Otherwise, the
10371 compiler must insert an instruction before every non prototyped call to
10372 set or clear bit 6 of the condition code register (@var{CR}) to
10373 indicate whether floating point values were passed in the floating point
10374 registers in case the function takes a variable arguments.  With
10375 @option{-mprototype}, only calls to prototyped variable argument functions
10376 will set or clear the bit.
10378 @item -msim
10379 @opindex msim
10380 On embedded PowerPC systems, assume that the startup module is called
10381 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10382 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10383 configurations.
10385 @item -mmvme
10386 @opindex mmvme
10387 On embedded PowerPC systems, assume that the startup module is called
10388 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10389 @file{libc.a}.
10391 @item -mads
10392 @opindex mads
10393 On embedded PowerPC systems, assume that the startup module is called
10394 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10395 @file{libc.a}.
10397 @item -myellowknife
10398 @opindex myellowknife
10399 On embedded PowerPC systems, assume that the startup module is called
10400 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10401 @file{libc.a}.
10403 @item -mvxworks
10404 @opindex mvxworks
10405 On System V.4 and embedded PowerPC systems, specify that you are
10406 compiling for a VxWorks system.
10408 @item -mwindiss
10409 @opindex mwindiss
10410 Specify that you are compiling for the WindISS simulation environment.
10412 @item -memb
10413 @opindex memb
10414 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10415 header to indicate that @samp{eabi} extended relocations are used.
10417 @item -meabi
10418 @itemx -mno-eabi
10419 @opindex meabi
10420 @opindex mno-eabi
10421 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10422 Embedded Applications Binary Interface (eabi) which is a set of
10423 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10424 means that the stack is aligned to an 8 byte boundary, a function
10425 @code{__eabi} is called to from @code{main} to set up the eabi
10426 environment, and the @option{-msdata} option can use both @code{r2} and
10427 @code{r13} to point to two separate small data areas.  Selecting
10428 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10429 do not call an initialization function from @code{main}, and the
10430 @option{-msdata} option will only use @code{r13} to point to a single
10431 small data area.  The @option{-meabi} option is on by default if you
10432 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10434 @item -msdata=eabi
10435 @opindex msdata=eabi
10436 On System V.4 and embedded PowerPC systems, put small initialized
10437 @code{const} global and static data in the @samp{.sdata2} section, which
10438 is pointed to by register @code{r2}.  Put small initialized
10439 non-@code{const} global and static data in the @samp{.sdata} section,
10440 which is pointed to by register @code{r13}.  Put small uninitialized
10441 global and static data in the @samp{.sbss} section, which is adjacent to
10442 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10443 incompatible with the @option{-mrelocatable} option.  The
10444 @option{-msdata=eabi} option also sets the @option{-memb} option.
10446 @item -msdata=sysv
10447 @opindex msdata=sysv
10448 On System V.4 and embedded PowerPC systems, put small global and static
10449 data in the @samp{.sdata} section, which is pointed to by register
10450 @code{r13}.  Put small uninitialized global and static data in the
10451 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10452 The @option{-msdata=sysv} option is incompatible with the
10453 @option{-mrelocatable} option.
10455 @item -msdata=default
10456 @itemx -msdata
10457 @opindex msdata=default
10458 @opindex msdata
10459 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10460 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10461 same as @option{-msdata=sysv}.
10463 @item -msdata-data
10464 @opindex msdata-data
10465 On System V.4 and embedded PowerPC systems, put small global and static
10466 data in the @samp{.sdata} section.  Put small uninitialized global and
10467 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10468 to address small data however.  This is the default behavior unless
10469 other @option{-msdata} options are used.
10471 @item -msdata=none
10472 @itemx -mno-sdata
10473 @opindex msdata=none
10474 @opindex mno-sdata
10475 On embedded PowerPC systems, put all initialized global and static data
10476 in the @samp{.data} section, and all uninitialized data in the
10477 @samp{.bss} section.
10479 @item -G @var{num}
10480 @opindex G
10481 @cindex smaller data references (PowerPC)
10482 @cindex .sdata/.sdata2 references (PowerPC)
10483 On embedded PowerPC systems, put global and static items less than or
10484 equal to @var{num} bytes into the small data or bss sections instead of
10485 the normal data or bss section.  By default, @var{num} is 8.  The
10486 @option{-G @var{num}} switch is also passed to the linker.
10487 All modules should be compiled with the same @option{-G @var{num}} value.
10489 @item -mregnames
10490 @itemx -mno-regnames
10491 @opindex mregnames
10492 @opindex mno-regnames
10493 On System V.4 and embedded PowerPC systems do (do not) emit register
10494 names in the assembly language output using symbolic forms.
10496 @item -mlongcall
10497 @itemx -mno-longcall
10498 @opindex mlongcall
10499 @opindex mno-longcall
10500 Default to making all function calls indirectly, using a register, so
10501 that functions which reside further than 32 megabytes (33,554,432
10502 bytes) from the current location can be called.  This setting can be
10503 overridden by the @code{shortcall} function attribute, or by
10504 @code{#pragma longcall(0)}.
10506 Some linkers are capable of detecting out-of-range calls and generating
10507 glue code on the fly.  On these systems, long calls are unnecessary and
10508 generate slower code.  As of this writing, the AIX linker can do this,
10509 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10510 to the GNU linker for 32-bit PowerPC systems as well.
10512 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10513 callee, L42'', plus a ``branch island'' (glue code).  The two target
10514 addresses represent the callee and the ``branch island.'' The
10515 Darwin/PPC linker will prefer the first address and generate a ``bl
10516 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10517 otherwise, the linker will generate ``bl L42'' to call the ``branch
10518 island.''  The ``branch island'' is appended to the body of the
10519 calling function; it computes the full 32-bit address of the callee
10520 and jumps to it.
10522 On Mach-O (Darwin) systems, this option directs the compiler emit to
10523 the glue for every direct call, and the Darwin linker decides whether
10524 to use or discard it.
10526 In the future, we may cause GCC to ignore all longcall specifications
10527 when the linker is known to generate glue.
10529 @item -pthread
10530 @opindex pthread
10531 Adds support for multithreading with the @dfn{pthreads} library.
10532 This option sets flags for both the preprocessor and linker.
10534 @end table
10536 @node S/390 and zSeries Options
10537 @subsection S/390 and zSeries Options
10538 @cindex S/390 and zSeries Options
10540 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10542 @table @gcctabopt
10543 @item -mhard-float
10544 @itemx -msoft-float
10545 @opindex mhard-float
10546 @opindex msoft-float
10547 Use (do not use) the hardware floating-point instructions and registers
10548 for floating-point operations.  When @option{-msoft-float} is specified,
10549 functions in @file{libgcc.a} will be used to perform floating-point
10550 operations.  When @option{-mhard-float} is specified, the compiler
10551 generates IEEE floating-point instructions.  This is the default.
10553 @item -mbackchain
10554 @itemx -mno-backchain
10555 @itemx -mkernel-backchain
10556 @opindex mbackchain
10557 @opindex mno-backchain
10558 @opindex mkernel-backchain
10559 In order to provide a backchain the address of the caller's frame
10560 is stored within the callee's stack frame.
10561 A backchain may be needed to allow debugging using tools that do not understand
10562 DWARF-2 call frame information.
10563 For @option{-mno-backchain} no backchain is maintained at all which is the 
10564 default. 
10565 If one of the other options is present the backchain pointer is placed either 
10566 on top of the stack frame  (@option{-mkernel-backchain}) or on
10567 the bottom (@option{-mbackchain}).
10568 Beside the different backchain location @option{-mkernel-backchain}
10569 also changes stack frame layout breaking the ABI. This option
10570 is intended to be used for code which internally needs a backchain but has
10571 to get by with a limited stack size e.g. the linux kernel. 
10572 Internal unwinding code not using DWARF-2 info has to be able to locate the
10573 return address of a function. That will be eased be the fact that
10574 the return address of a function is placed two words below the backchain 
10575 pointer.
10577 @item -msmall-exec
10578 @itemx -mno-small-exec
10579 @opindex msmall-exec
10580 @opindex mno-small-exec
10581 Generate (or do not generate) code using the @code{bras} instruction
10582 to do subroutine calls.
10583 This only works reliably if the total executable size does not
10584 exceed 64k.  The default is to use the @code{basr} instruction instead,
10585 which does not have this limitation.
10587 @item -m64
10588 @itemx -m31
10589 @opindex m64
10590 @opindex m31
10591 When @option{-m31} is specified, generate code compliant to the
10592 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
10593 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
10594 particular to generate 64-bit instructions.  For the @samp{s390}
10595 targets, the default is @option{-m31}, while the @samp{s390x}
10596 targets default to @option{-m64}.
10598 @item -mzarch
10599 @itemx -mesa
10600 @opindex mzarch
10601 @opindex mesa
10602 When @option{-mzarch} is specified, generate code using the
10603 instructions available on z/Architecture.
10604 When @option{-mesa} is specified, generate code using the
10605 instructions available on ESA/390. Note that @option{-mesa} is
10606 not possible with @option{-m64}.
10607 When generating code compliant to the GNU/Linux for S/390 ABI,
10608 the default is @option{-mesa}.  When generating code compliant
10609 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
10611 @item -mmvcle
10612 @itemx -mno-mvcle
10613 @opindex mmvcle
10614 @opindex mno-mvcle
10615 Generate (or do not generate) code using the @code{mvcle} instruction
10616 to perform block moves.  When @option{-mno-mvcle} is specified,
10617 use a @code{mvc} loop instead.  This is the default.
10619 @item -mdebug
10620 @itemx -mno-debug
10621 @opindex mdebug
10622 @opindex mno-debug
10623 Print (or do not print) additional debug information when compiling.
10624 The default is to not print debug information.
10626 @item -march=@var{cpu-type}
10627 @opindex march
10628 Generate code that will run on @var{cpu-type}, which is the name of a system
10629 representing a certain processor type. Possible values for
10630 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
10631 When generating code using the instructions available on z/Architecture,
10632 the default is @option{-march=z900}.  Otherwise, the default is
10633 @option{-march=g5}.
10635 @item -mtune=@var{cpu-type}
10636 @opindex mtune
10637 Tune to @var{cpu-type} everything applicable about the generated code,
10638 except for the ABI and the set of available instructions.
10639 The list of @var{cpu-type} values is the same as for @option{-march}.
10640 The default is the value used for @option{-march}.
10642 @item -mtpf-trace
10643 @itemx -mno-tpf-trace
10644 @opindex mtpf-trace
10645 @opindex mno-tpf-trace
10646 Generate code that adds (does not add) in TPF OS specific branches to trace
10647 routines in the operating system.  This option is off by default, even
10648 when compiling for the TPF OS.
10650 @item -mfused-madd
10651 @itemx -mno-fused-madd
10652 @opindex mfused-madd
10653 @opindex mno-fused-madd
10654 Generate code that uses (does not use) the floating point multiply and
10655 accumulate instructions.  These instructions are generated by default if
10656 hardware floating point is used.
10658 @item -mwarn-framesize=@var{framesize}
10659 @opindex mwarn-framesize
10660 Emit a warning if the current function exceeds the given frame size.  Because
10661 this is a compile time check it doesn't need to be a real problem when the program
10662 runs.  It is intended to identify functions which most probably cause 
10663 a stack overflow.  It is useful to be used in an environment with limited stack 
10664 size e.g. the linux kernel.
10666 @item -mwarn-dynamicstack
10667 @opindex mwarn-dynamicstack
10668 Emit a warning if the function calls alloca or uses dynamically
10669 sized arrays.  This is generally a bad idea with a limited stack size.
10671 @item -mstack-guard=@var{stack-guard}
10672 @item -mstack-size=@var{stack-size}
10673 @opindex mstack-guard
10674 @opindex mstack-size
10675 These arguments always have to be used in conjunction.  If they are present the s390
10676 back end emits additional instructions in the function prologue which trigger a trap
10677 if the stack size is @var{stack-guard} bytes above the @var{stack-size} 
10678 (remember that the stack on s390 grows downward).  These options are intended to 
10679 be used to help debugging stack overflow problems.  The additionally emitted code 
10680 cause only little overhead and hence can also be used in production like systems 
10681 without greater performance degradation.  The given values have to be exact 
10682 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
10683 In order to be efficient the extra code makes the assumption that the stack starts
10684 at an address aligned to the value given by @var{stack-size}.
10685 @end table
10687 @node SH Options
10688 @subsection SH Options
10690 These @samp{-m} options are defined for the SH implementations:
10692 @table @gcctabopt
10693 @item -m1
10694 @opindex m1
10695 Generate code for the SH1.
10697 @item -m2
10698 @opindex m2
10699 Generate code for the SH2.
10701 @item -m2e
10702 Generate code for the SH2e.
10704 @item -m3
10705 @opindex m3
10706 Generate code for the SH3.
10708 @item -m3e
10709 @opindex m3e
10710 Generate code for the SH3e.
10712 @item -m4-nofpu
10713 @opindex m4-nofpu
10714 Generate code for the SH4 without a floating-point unit.
10716 @item -m4-single-only
10717 @opindex m4-single-only
10718 Generate code for the SH4 with a floating-point unit that only
10719 supports single-precision arithmetic.
10721 @item -m4-single
10722 @opindex m4-single
10723 Generate code for the SH4 assuming the floating-point unit is in
10724 single-precision mode by default.
10726 @item -m4
10727 @opindex m4
10728 Generate code for the SH4.
10730 @item -m4a-nofpu
10731 @opindex m4a-nofpu
10732 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
10733 floating-point unit is not used.
10735 @item -m4a-single-only
10736 @opindex m4a-single-only
10737 Generate code for the SH4a, in such a way that no double-precision
10738 floating point operations are used.
10740 @item -m4a-single
10741 @opindex m4a-single
10742 Generate code for the SH4a assuming the floating-point unit is in
10743 single-precision mode by default.
10745 @item -m4a
10746 @opindex m4a
10747 Generate code for the SH4a.
10749 @item -m4al
10750 @opindex m4al
10751 Same as @option{-m4a-nofpu}, except that it implicitly passes
10752 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
10753 instructions at the moment.
10755 @item -mb
10756 @opindex mb
10757 Compile code for the processor in big endian mode.
10759 @item -ml
10760 @opindex ml
10761 Compile code for the processor in little endian mode.
10763 @item -mdalign
10764 @opindex mdalign
10765 Align doubles at 64-bit boundaries.  Note that this changes the calling
10766 conventions, and thus some functions from the standard C library will
10767 not work unless you recompile it first with @option{-mdalign}.
10769 @item -mrelax
10770 @opindex mrelax
10771 Shorten some address references at link time, when possible; uses the
10772 linker option @option{-relax}.
10774 @item -mbigtable
10775 @opindex mbigtable
10776 Use 32-bit offsets in @code{switch} tables.  The default is to use
10777 16-bit offsets.
10779 @item -mfmovd
10780 @opindex mfmovd
10781 Enable the use of the instruction @code{fmovd}.
10783 @item -mhitachi
10784 @opindex mhitachi
10785 Comply with the calling conventions defined by Renesas.
10787 @item -mrenesas
10788 @opindex mhitachi
10789 Comply with the calling conventions defined by Renesas.
10791 @item -mno-renesas
10792 @opindex mhitachi
10793 Comply with the calling conventions defined for GCC before the Renesas
10794 conventions were available.  This option is the default for all
10795 targets of the SH toolchain except for @samp{sh-symbianelf}.
10797 @item -mnomacsave
10798 @opindex mnomacsave
10799 Mark the @code{MAC} register as call-clobbered, even if
10800 @option{-mhitachi} is given.
10802 @item -mieee
10803 @opindex mieee
10804 Increase IEEE-compliance of floating-point code.
10806 @item -misize
10807 @opindex misize
10808 Dump instruction size and location in the assembly code.
10810 @item -mpadstruct
10811 @opindex mpadstruct
10812 This option is deprecated.  It pads structures to multiple of 4 bytes,
10813 which is incompatible with the SH ABI@.
10815 @item -mspace
10816 @opindex mspace
10817 Optimize for space instead of speed.  Implied by @option{-Os}.
10819 @item -mprefergot
10820 @opindex mprefergot
10821 When generating position-independent code, emit function calls using
10822 the Global Offset Table instead of the Procedure Linkage Table.
10824 @item -musermode
10825 @opindex musermode
10826 Generate a library function call to invalidate instruction cache
10827 entries, after fixing up a trampoline.  This library function call
10828 doesn't assume it can write to the whole memory address space.  This
10829 is the default when the target is @code{sh-*-linux*}.
10830 @end table
10832 @node SPARC Options
10833 @subsection SPARC Options
10834 @cindex SPARC options
10836 These @samp{-m} options are supported on the SPARC:
10838 @table @gcctabopt
10839 @item -mno-app-regs
10840 @itemx -mapp-regs
10841 @opindex mno-app-regs
10842 @opindex mapp-regs
10843 Specify @option{-mapp-regs} to generate output using the global registers
10844 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
10845 is the default.
10847 To be fully SVR4 ABI compliant at the cost of some performance loss,
10848 specify @option{-mno-app-regs}.  You should compile libraries and system
10849 software with this option.
10851 @item -mfpu
10852 @itemx -mhard-float
10853 @opindex mfpu
10854 @opindex mhard-float
10855 Generate output containing floating point instructions.  This is the
10856 default.
10858 @item -mno-fpu
10859 @itemx -msoft-float
10860 @opindex mno-fpu
10861 @opindex msoft-float
10862 Generate output containing library calls for floating point.
10863 @strong{Warning:} the requisite libraries are not available for all SPARC
10864 targets.  Normally the facilities of the machine's usual C compiler are
10865 used, but this cannot be done directly in cross-compilation.  You must make
10866 your own arrangements to provide suitable library functions for
10867 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
10868 @samp{sparclite-*-*} do provide software floating point support.
10870 @option{-msoft-float} changes the calling convention in the output file;
10871 therefore, it is only useful if you compile @emph{all} of a program with
10872 this option.  In particular, you need to compile @file{libgcc.a}, the
10873 library that comes with GCC, with @option{-msoft-float} in order for
10874 this to work.
10876 @item -mhard-quad-float
10877 @opindex mhard-quad-float
10878 Generate output containing quad-word (long double) floating point
10879 instructions.
10881 @item -msoft-quad-float
10882 @opindex msoft-quad-float
10883 Generate output containing library calls for quad-word (long double)
10884 floating point instructions.  The functions called are those specified
10885 in the SPARC ABI@.  This is the default.
10887 As of this writing, there are no SPARC implementations that have hardware
10888 support for the quad-word floating point instructions.  They all invoke
10889 a trap handler for one of these instructions, and then the trap handler
10890 emulates the effect of the instruction.  Because of the trap handler overhead,
10891 this is much slower than calling the ABI library routines.  Thus the
10892 @option{-msoft-quad-float} option is the default.
10894 @item -mno-unaligned-doubles
10895 @itemx -munaligned-doubles
10896 @opindex mno-unaligned-doubles
10897 @opindex munaligned-doubles
10898 Assume that doubles have 8 byte alignment.  This is the default.
10900 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
10901 alignment only if they are contained in another type, or if they have an
10902 absolute address.  Otherwise, it assumes they have 4 byte alignment.
10903 Specifying this option avoids some rare compatibility problems with code
10904 generated by other compilers.  It is not the default because it results
10905 in a performance loss, especially for floating point code.
10907 @item -mno-faster-structs
10908 @itemx -mfaster-structs
10909 @opindex mno-faster-structs
10910 @opindex mfaster-structs
10911 With @option{-mfaster-structs}, the compiler assumes that structures
10912 should have 8 byte alignment.  This enables the use of pairs of
10913 @code{ldd} and @code{std} instructions for copies in structure
10914 assignment, in place of twice as many @code{ld} and @code{st} pairs.
10915 However, the use of this changed alignment directly violates the SPARC
10916 ABI@.  Thus, it's intended only for use on targets where the developer
10917 acknowledges that their resulting code will not be directly in line with
10918 the rules of the ABI@.
10920 @item -mimpure-text
10921 @opindex mimpure-text
10922 @option{-mimpure-text}, used in addition to @option{-shared}, tells
10923 the compiler to not pass @option{-z text} to the linker when linking a
10924 shared object.  Using this option, you can link position-dependent
10925 code into a shared object.
10927 @option{-mimpure-text} suppresses the ``relocations remain against
10928 allocatable but non-writable sections'' linker error message.
10929 However, the necessary relocations will trigger copy-on-write, and the
10930 shared object is not actually shared across processes.  Instead of
10931 using @option{-mimpure-text}, you should compile all source code with
10932 @option{-fpic} or @option{-fPIC}.
10934 This option is only available on SunOS and Solaris.
10936 @item -mcpu=@var{cpu_type}
10937 @opindex mcpu
10938 Set the instruction set, register set, and instruction scheduling parameters
10939 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
10940 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
10941 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
10942 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
10943 @samp{ultrasparc3}.
10945 Default instruction scheduling parameters are used for values that select
10946 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
10947 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
10949 Here is a list of each supported architecture and their supported
10950 implementations.
10952 @smallexample
10953     v7:             cypress
10954     v8:             supersparc, hypersparc
10955     sparclite:      f930, f934, sparclite86x
10956     sparclet:       tsc701
10957     v9:             ultrasparc, ultrasparc3
10958 @end smallexample
10960 By default (unless configured otherwise), GCC generates code for the V7
10961 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
10962 additionally optimizes it for the Cypress CY7C602 chip, as used in the
10963 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
10964 SPARCStation 1, 2, IPX etc.
10966 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
10967 architecture.  The only difference from V7 code is that the compiler emits
10968 the integer multiply and integer divide instructions which exist in SPARC-V8
10969 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
10970 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
10971 2000 series.
10973 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
10974 the SPARC architecture.  This adds the integer multiply, integer divide step
10975 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
10976 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
10977 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU.  With
10978 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
10979 MB86934 chip, which is the more recent SPARClite with FPU.
10981 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
10982 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
10983 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
10984 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
10985 optimizes it for the TEMIC SPARClet chip.
10987 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
10988 architecture.  This adds 64-bit integer and floating-point move instructions,
10989 3 additional floating-point condition code registers and conditional move
10990 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
10991 optimizes it for the Sun UltraSPARC I/II chips.  With
10992 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
10993 Sun UltraSPARC III chip.
10995 @item -mtune=@var{cpu_type}
10996 @opindex mtune
10997 Set the instruction scheduling parameters for machine type
10998 @var{cpu_type}, but do not set the instruction set or register set that the
10999 option @option{-mcpu=@var{cpu_type}} would.
11001 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11002 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11003 that select a particular cpu implementation.  Those are @samp{cypress},
11004 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11005 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11006 @samp{ultrasparc3}.
11008 @item -mv8plus
11009 @itemx -mno-v8plus
11010 @opindex mv8plus
11011 @opindex mno-v8plus
11012 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI.  The
11013 difference from the V8 ABI is that the global and out registers are
11014 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11015 mode for all SPARC-V9 processors.
11017 @item -mvis
11018 @itemx -mno-vis
11019 @opindex mvis
11020 @opindex mno-vis
11021 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11022 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11023 @end table
11025 These @samp{-m} options are supported in addition to the above
11026 on SPARC-V9 processors in 64-bit environments:
11028 @table @gcctabopt
11029 @item -mlittle-endian
11030 @opindex mlittle-endian
11031 Generate code for a processor running in little-endian mode. It is only
11032 available for a few configurations and most notably not on Solaris.
11034 @item -m32
11035 @itemx -m64
11036 @opindex m32
11037 @opindex m64
11038 Generate code for a 32-bit or 64-bit environment.
11039 The 32-bit environment sets int, long and pointer to 32 bits.
11040 The 64-bit environment sets int to 32 bits and long and pointer
11041 to 64 bits.
11043 @item -mcmodel=medlow
11044 @opindex mcmodel=medlow
11045 Generate code for the Medium/Low code model: 64-bit addresses, programs
11046 must be linked in the low 32 bits of memory.  Programs can be statically
11047 or dynamically linked.
11049 @item -mcmodel=medmid
11050 @opindex mcmodel=medmid
11051 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11052 must be linked in the low 44 bits of memory, the text and data segments must
11053 be less than 2GB in size and the data segment must be located within 2GB of
11054 the text segment.
11056 @item -mcmodel=medany
11057 @opindex mcmodel=medany
11058 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11059 may be linked anywhere in memory, the text and data segments must be less
11060 than 2GB in size and the data segment must be located within 2GB of the
11061 text segment.
11063 @item -mcmodel=embmedany
11064 @opindex mcmodel=embmedany
11065 Generate code for the Medium/Anywhere code model for embedded systems:
11066 64-bit addresses, the text and data segments must be less than 2GB in
11067 size, both starting anywhere in memory (determined at link time).  The
11068 global register %g4 points to the base of the data segment.  Programs
11069 are statically linked and PIC is not supported.
11071 @item -mstack-bias
11072 @itemx -mno-stack-bias
11073 @opindex mstack-bias
11074 @opindex mno-stack-bias
11075 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11076 frame pointer if present, are offset by @minus{}2047 which must be added back
11077 when making stack frame references.  This is the default in 64-bit mode.
11078 Otherwise, assume no such offset is present.
11079 @end table
11081 These switches are supported in addition to the above on Solaris:
11083 @table @gcctabopt
11084 @item -threads
11085 @opindex threads
11086 Add support for multithreading using the Solaris threads library.  This
11087 option sets flags for both the preprocessor and linker.  This option does
11088 not affect the thread safety of object code produced by the compiler or
11089 that of libraries supplied with it.
11091 @item -pthreads
11092 @opindex pthreads
11093 Add support for multithreading using the POSIX threads library.  This
11094 option sets flags for both the preprocessor and linker.  This option does
11095 not affect the thread safety of object code produced  by the compiler or
11096 that of libraries supplied with it.
11097 @end table
11099 @node System V Options
11100 @subsection Options for System V
11102 These additional options are available on System V Release 4 for
11103 compatibility with other compilers on those systems:
11105 @table @gcctabopt
11106 @item -G
11107 @opindex G
11108 Create a shared object.
11109 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11111 @item -Qy
11112 @opindex Qy
11113 Identify the versions of each tool used by the compiler, in a
11114 @code{.ident} assembler directive in the output.
11116 @item -Qn
11117 @opindex Qn
11118 Refrain from adding @code{.ident} directives to the output file (this is
11119 the default).
11121 @item -YP,@var{dirs}
11122 @opindex YP
11123 Search the directories @var{dirs}, and no others, for libraries
11124 specified with @option{-l}.
11126 @item -Ym,@var{dir}
11127 @opindex Ym
11128 Look in the directory @var{dir} to find the M4 preprocessor.
11129 The assembler uses this option.
11130 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11131 @c the generic assembler that comes with Solaris takes just -Ym.
11132 @end table
11134 @node TMS320C3x/C4x Options
11135 @subsection TMS320C3x/C4x Options
11136 @cindex TMS320C3x/C4x Options
11138 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11140 @table @gcctabopt
11142 @item -mcpu=@var{cpu_type}
11143 @opindex mcpu
11144 Set the instruction set, register set, and instruction scheduling
11145 parameters for machine type @var{cpu_type}.  Supported values for
11146 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11147 @samp{c44}.  The default is @samp{c40} to generate code for the
11148 TMS320C40.
11150 @item -mbig-memory
11151 @itemx -mbig
11152 @itemx -msmall-memory
11153 @itemx -msmall
11154 @opindex mbig-memory
11155 @opindex mbig
11156 @opindex msmall-memory
11157 @opindex msmall
11158 Generates code for the big or small memory model.  The small memory
11159 model assumed that all data fits into one 64K word page.  At run-time
11160 the data page (DP) register must be set to point to the 64K page
11161 containing the .bss and .data program sections.  The big memory model is
11162 the default and requires reloading of the DP register for every direct
11163 memory access.
11165 @item -mbk
11166 @itemx -mno-bk
11167 @opindex mbk
11168 @opindex mno-bk
11169 Allow (disallow) allocation of general integer operands into the block
11170 count register BK@.
11172 @item -mdb
11173 @itemx -mno-db
11174 @opindex mdb
11175 @opindex mno-db
11176 Enable (disable) generation of code using decrement and branch,
11177 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11178 on the safe side, this is disabled for the C3x, since the maximum
11179 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11180 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11181 that it can utilize the decrement and branch instruction, but will give
11182 up if there is more than one memory reference in the loop.  Thus a loop
11183 where the loop counter is decremented can generate slightly more
11184 efficient code, in cases where the RPTB instruction cannot be utilized.
11186 @item -mdp-isr-reload
11187 @itemx -mparanoid
11188 @opindex mdp-isr-reload
11189 @opindex mparanoid
11190 Force the DP register to be saved on entry to an interrupt service
11191 routine (ISR), reloaded to point to the data section, and restored on
11192 exit from the ISR@.  This should not be required unless someone has
11193 violated the small memory model by modifying the DP register, say within
11194 an object library.
11196 @item -mmpyi
11197 @itemx -mno-mpyi
11198 @opindex mmpyi
11199 @opindex mno-mpyi
11200 For the C3x use the 24-bit MPYI instruction for integer multiplies
11201 instead of a library call to guarantee 32-bit results.  Note that if one
11202 of the operands is a constant, then the multiplication will be performed
11203 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11204 then squaring operations are performed inline instead of a library call.
11206 @item -mfast-fix
11207 @itemx -mno-fast-fix
11208 @opindex mfast-fix
11209 @opindex mno-fast-fix
11210 The C3x/C4x FIX instruction to convert a floating point value to an
11211 integer value chooses the nearest integer less than or equal to the
11212 floating point value rather than to the nearest integer.  Thus if the
11213 floating point number is negative, the result will be incorrectly
11214 truncated an additional code is necessary to detect and correct this
11215 case.  This option can be used to disable generation of the additional
11216 code required to correct the result.
11218 @item -mrptb
11219 @itemx -mno-rptb
11220 @opindex mrptb
11221 @opindex mno-rptb
11222 Enable (disable) generation of repeat block sequences using the RPTB
11223 instruction for zero overhead looping.  The RPTB construct is only used
11224 for innermost loops that do not call functions or jump across the loop
11225 boundaries.  There is no advantage having nested RPTB loops due to the
11226 overhead required to save and restore the RC, RS, and RE registers.
11227 This is enabled by default with @option{-O2}.
11229 @item -mrpts=@var{count}
11230 @itemx -mno-rpts
11231 @opindex mrpts
11232 @opindex mno-rpts
11233 Enable (disable) the use of the single instruction repeat instruction
11234 RPTS@.  If a repeat block contains a single instruction, and the loop
11235 count can be guaranteed to be less than the value @var{count}, GCC will
11236 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11237 then a RPTS will be emitted even if the loop count cannot be determined
11238 at compile time.  Note that the repeated instruction following RPTS does
11239 not have to be reloaded from memory each iteration, thus freeing up the
11240 CPU buses for operands.  However, since interrupts are blocked by this
11241 instruction, it is disabled by default.
11243 @item -mloop-unsigned
11244 @itemx -mno-loop-unsigned
11245 @opindex mloop-unsigned
11246 @opindex mno-loop-unsigned
11247 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11248 is @math{2^{31} + 1} since these instructions test if the iteration count is
11249 negative to terminate the loop.  If the iteration count is unsigned
11250 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11251 exceeded.  This switch allows an unsigned iteration count.
11253 @item -mti
11254 @opindex mti
11255 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11256 with.  This also enforces compatibility with the API employed by the TI
11257 C3x C compiler.  For example, long doubles are passed as structures
11258 rather than in floating point registers.
11260 @item -mregparm
11261 @itemx -mmemparm
11262 @opindex mregparm
11263 @opindex mmemparm
11264 Generate code that uses registers (stack) for passing arguments to functions.
11265 By default, arguments are passed in registers where possible rather
11266 than by pushing arguments on to the stack.
11268 @item -mparallel-insns
11269 @itemx -mno-parallel-insns
11270 @opindex mparallel-insns
11271 @opindex mno-parallel-insns
11272 Allow the generation of parallel instructions.  This is enabled by
11273 default with @option{-O2}.
11275 @item -mparallel-mpy
11276 @itemx -mno-parallel-mpy
11277 @opindex mparallel-mpy
11278 @opindex mno-parallel-mpy
11279 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11280 provided @option{-mparallel-insns} is also specified.  These instructions have
11281 tight register constraints which can pessimize the code generation
11282 of large functions.
11284 @end table
11286 @node V850 Options
11287 @subsection V850 Options
11288 @cindex V850 Options
11290 These @samp{-m} options are defined for V850 implementations:
11292 @table @gcctabopt
11293 @item -mlong-calls
11294 @itemx -mno-long-calls
11295 @opindex mlong-calls
11296 @opindex mno-long-calls
11297 Treat all calls as being far away (near).  If calls are assumed to be
11298 far away, the compiler will always load the functions address up into a
11299 register, and call indirect through the pointer.
11301 @item -mno-ep
11302 @itemx -mep
11303 @opindex mno-ep
11304 @opindex mep
11305 Do not optimize (do optimize) basic blocks that use the same index
11306 pointer 4 or more times to copy pointer into the @code{ep} register, and
11307 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11308 option is on by default if you optimize.
11310 @item -mno-prolog-function
11311 @itemx -mprolog-function
11312 @opindex mno-prolog-function
11313 @opindex mprolog-function
11314 Do not use (do use) external functions to save and restore registers
11315 at the prologue and epilogue of a function.  The external functions
11316 are slower, but use less code space if more than one function saves
11317 the same number of registers.  The @option{-mprolog-function} option
11318 is on by default if you optimize.
11320 @item -mspace
11321 @opindex mspace
11322 Try to make the code as small as possible.  At present, this just turns
11323 on the @option{-mep} and @option{-mprolog-function} options.
11325 @item -mtda=@var{n}
11326 @opindex mtda
11327 Put static or global variables whose size is @var{n} bytes or less into
11328 the tiny data area that register @code{ep} points to.  The tiny data
11329 area can hold up to 256 bytes in total (128 bytes for byte references).
11331 @item -msda=@var{n}
11332 @opindex msda
11333 Put static or global variables whose size is @var{n} bytes or less into
11334 the small data area that register @code{gp} points to.  The small data
11335 area can hold up to 64 kilobytes.
11337 @item -mzda=@var{n}
11338 @opindex mzda
11339 Put static or global variables whose size is @var{n} bytes or less into
11340 the first 32 kilobytes of memory.
11342 @item -mv850
11343 @opindex mv850
11344 Specify that the target processor is the V850.
11346 @item -mbig-switch
11347 @opindex mbig-switch
11348 Generate code suitable for big switch tables.  Use this option only if
11349 the assembler/linker complain about out of range branches within a switch
11350 table.
11352 @item -mapp-regs
11353 @opindex mapp-regs
11354 This option will cause r2 and r5 to be used in the code generated by
11355 the compiler.  This setting is the default.
11357 @item -mno-app-regs
11358 @opindex mno-app-regs
11359 This option will cause r2 and r5 to be treated as fixed registers.
11361 @item -mv850e1
11362 @opindex mv850e1
11363 Specify that the target processor is the V850E1.  The preprocessor
11364 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11365 this option is used.
11367 @item -mv850e
11368 @opindex mv850e
11369 Specify that the target processor is the V850E.  The preprocessor
11370 constant @samp{__v850e__} will be defined if this option is used.
11372 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11373 are defined then a default target processor will be chosen and the
11374 relevant @samp{__v850*__} preprocessor constant will be defined.
11376 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11377 defined, regardless of which processor variant is the target.
11379 @item -mdisable-callt
11380 @opindex mdisable-callt
11381 This option will suppress generation of the CALLT instruction for the
11382 v850e and v850e1 flavors of the v850 architecture.  The default is
11383 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11385 @end table
11387 @node VAX Options
11388 @subsection VAX Options
11389 @cindex VAX options
11391 These @samp{-m} options are defined for the VAX:
11393 @table @gcctabopt
11394 @item -munix
11395 @opindex munix
11396 Do not output certain jump instructions (@code{aobleq} and so on)
11397 that the Unix assembler for the VAX cannot handle across long
11398 ranges.
11400 @item -mgnu
11401 @opindex mgnu
11402 Do output those jump instructions, on the assumption that you
11403 will assemble with the GNU assembler.
11405 @item -mg
11406 @opindex mg
11407 Output code for g-format floating point numbers instead of d-format.
11408 @end table
11410 @node x86-64 Options
11411 @subsection x86-64 Options
11412 @cindex x86-64 options
11414 These are listed under @xref{i386 and x86-64 Options}.
11416 @node Xstormy16 Options
11417 @subsection Xstormy16 Options
11418 @cindex Xstormy16 Options
11420 These options are defined for Xstormy16:
11422 @table @gcctabopt
11423 @item -msim
11424 @opindex msim
11425 Choose startup files and linker script suitable for the simulator.
11426 @end table
11428 @node Xtensa Options
11429 @subsection Xtensa Options
11430 @cindex Xtensa Options
11432 These options are supported for Xtensa targets:
11434 @table @gcctabopt
11435 @item -mconst16
11436 @itemx -mno-const16
11437 @opindex mconst16
11438 @opindex mno-const16
11439 Enable or disable use of @code{CONST16} instructions for loading
11440 constant values.  The @code{CONST16} instruction is currently not a
11441 standard option from Tensilica.  When enabled, @code{CONST16}
11442 instructions are always used in place of the standard @code{L32R}
11443 instructions.  The use of @code{CONST16} is enabled by default only if
11444 the @code{L32R} instruction is not available.
11446 @item -mfused-madd
11447 @itemx -mno-fused-madd
11448 @opindex mfused-madd
11449 @opindex mno-fused-madd
11450 Enable or disable use of fused multiply/add and multiply/subtract
11451 instructions in the floating-point option.  This has no effect if the
11452 floating-point option is not also enabled.  Disabling fused multiply/add
11453 and multiply/subtract instructions forces the compiler to use separate
11454 instructions for the multiply and add/subtract operations.  This may be
11455 desirable in some cases where strict IEEE 754-compliant results are
11456 required: the fused multiply add/subtract instructions do not round the
11457 intermediate result, thereby producing results with @emph{more} bits of
11458 precision than specified by the IEEE standard.  Disabling fused multiply
11459 add/subtract instructions also ensures that the program output is not
11460 sensitive to the compiler's ability to combine multiply and add/subtract
11461 operations.
11463 @item -mtext-section-literals
11464 @itemx -mno-text-section-literals
11465 @opindex mtext-section-literals
11466 @opindex mno-text-section-literals
11467 Control the treatment of literal pools.  The default is
11468 @option{-mno-text-section-literals}, which places literals in a separate
11469 section in the output file.  This allows the literal pool to be placed
11470 in a data RAM/ROM, and it also allows the linker to combine literal
11471 pools from separate object files to remove redundant literals and
11472 improve code size.  With @option{-mtext-section-literals}, the literals
11473 are interspersed in the text section in order to keep them as close as
11474 possible to their references.  This may be necessary for large assembly
11475 files.
11477 @item -mtarget-align
11478 @itemx -mno-target-align
11479 @opindex mtarget-align
11480 @opindex mno-target-align
11481 When this option is enabled, GCC instructs the assembler to
11482 automatically align instructions to reduce branch penalties at the
11483 expense of some code density.  The assembler attempts to widen density
11484 instructions to align branch targets and the instructions following call
11485 instructions.  If there are not enough preceding safe density
11486 instructions to align a target, no widening will be performed.  The
11487 default is @option{-mtarget-align}.  These options do not affect the
11488 treatment of auto-aligned instructions like @code{LOOP}, which the
11489 assembler will always align, either by widening density instructions or
11490 by inserting no-op instructions.
11492 @item -mlongcalls
11493 @itemx -mno-longcalls
11494 @opindex mlongcalls
11495 @opindex mno-longcalls
11496 When this option is enabled, GCC instructs the assembler to translate
11497 direct calls to indirect calls unless it can determine that the target
11498 of a direct call is in the range allowed by the call instruction.  This
11499 translation typically occurs for calls to functions in other source
11500 files.  Specifically, the assembler translates a direct @code{CALL}
11501 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11502 The default is @option{-mno-longcalls}.  This option should be used in
11503 programs where the call target can potentially be out of range.  This
11504 option is implemented in the assembler, not the compiler, so the
11505 assembly code generated by GCC will still show direct call
11506 instructions---look at the disassembled object code to see the actual
11507 instructions.  Note that the assembler will use an indirect call for
11508 every cross-file call, not just those that really will be out of range.
11509 @end table
11511 @node zSeries Options
11512 @subsection zSeries Options
11513 @cindex zSeries options
11515 These are listed under @xref{S/390 and zSeries Options}.
11517 @node Code Gen Options
11518 @section Options for Code Generation Conventions
11519 @cindex code generation conventions
11520 @cindex options, code generation
11521 @cindex run-time options
11523 These machine-independent options control the interface conventions
11524 used in code generation.
11526 Most of them have both positive and negative forms; the negative form
11527 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11528 one of the forms is listed---the one which is not the default.  You
11529 can figure out the other form by either removing @samp{no-} or adding
11532 @table @gcctabopt
11533 @item -fbounds-check
11534 @opindex fbounds-check
11535 For front-ends that support it, generate additional code to check that
11536 indices used to access arrays are within the declared range.  This is
11537 currently only supported by the Java and Fortran 77 front-ends, where
11538 this option defaults to true and false respectively.
11540 @item -ftrapv
11541 @opindex ftrapv
11542 This option generates traps for signed overflow on addition, subtraction,
11543 multiplication operations.
11545 @item -fwrapv
11546 @opindex fwrapv
11547 This option instructs the compiler to assume that signed arithmetic
11548 overflow of addition, subtraction and multiplication wraps around
11549 using twos-complement representation.  This flag enables some optimizations
11550 and disables other.  This option is enabled by default for the Java
11551 front-end, as required by the Java language specification.
11553 @item -fexceptions
11554 @opindex fexceptions
11555 Enable exception handling.  Generates extra code needed to propagate
11556 exceptions.  For some targets, this implies GCC will generate frame
11557 unwind information for all functions, which can produce significant data
11558 size overhead, although it does not affect execution.  If you do not
11559 specify this option, GCC will enable it by default for languages like
11560 C++ which normally require exception handling, and disable it for
11561 languages like C that do not normally require it.  However, you may need
11562 to enable this option when compiling C code that needs to interoperate
11563 properly with exception handlers written in C++.  You may also wish to
11564 disable this option if you are compiling older C++ programs that don't
11565 use exception handling.
11567 @item -fnon-call-exceptions
11568 @opindex fnon-call-exceptions
11569 Generate code that allows trapping instructions to throw exceptions.
11570 Note that this requires platform-specific runtime support that does
11571 not exist everywhere.  Moreover, it only allows @emph{trapping}
11572 instructions to throw exceptions, i.e.@: memory references or floating
11573 point instructions.  It does not allow exceptions to be thrown from
11574 arbitrary signal handlers such as @code{SIGALRM}.
11576 @item -funwind-tables
11577 @opindex funwind-tables
11578 Similar to @option{-fexceptions}, except that it will just generate any needed
11579 static data, but will not affect the generated code in any other way.
11580 You will normally not enable this option; instead, a language processor
11581 that needs this handling would enable it on your behalf.
11583 @item -fasynchronous-unwind-tables
11584 @opindex fasynchronous-unwind-tables
11585 Generate unwind table in dwarf2 format, if supported by target machine.  The
11586 table is exact at each instruction boundary, so it can be used for stack
11587 unwinding from asynchronous events (such as debugger or garbage collector).
11589 @item -fpcc-struct-return
11590 @opindex fpcc-struct-return
11591 Return ``short'' @code{struct} and @code{union} values in memory like
11592 longer ones, rather than in registers.  This convention is less
11593 efficient, but it has the advantage of allowing intercallability between
11594 GCC-compiled files and files compiled with other compilers, particularly
11595 the Portable C Compiler (pcc).
11597 The precise convention for returning structures in memory depends
11598 on the target configuration macros.
11600 Short structures and unions are those whose size and alignment match
11601 that of some integer type.
11603 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
11604 switch is not binary compatible with code compiled with the
11605 @option{-freg-struct-return} switch.
11606 Use it to conform to a non-default application binary interface.
11608 @item -freg-struct-return
11609 @opindex freg-struct-return
11610 Return @code{struct} and @code{union} values in registers when possible.
11611 This is more efficient for small structures than
11612 @option{-fpcc-struct-return}.
11614 If you specify neither @option{-fpcc-struct-return} nor
11615 @option{-freg-struct-return}, GCC defaults to whichever convention is
11616 standard for the target.  If there is no standard convention, GCC
11617 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
11618 the principal compiler.  In those cases, we can choose the standard, and
11619 we chose the more efficient register return alternative.
11621 @strong{Warning:} code compiled with the @option{-freg-struct-return}
11622 switch is not binary compatible with code compiled with the
11623 @option{-fpcc-struct-return} switch.
11624 Use it to conform to a non-default application binary interface.
11626 @item -fshort-enums
11627 @opindex fshort-enums
11628 Allocate to an @code{enum} type only as many bytes as it needs for the
11629 declared range of possible values.  Specifically, the @code{enum} type
11630 will be equivalent to the smallest integer type which has enough room.
11632 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
11633 code that is not binary compatible with code generated without that switch.
11634 Use it to conform to a non-default application binary interface.
11636 @item -fshort-double
11637 @opindex fshort-double
11638 Use the same size for @code{double} as for @code{float}.
11640 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
11641 code that is not binary compatible with code generated without that switch.
11642 Use it to conform to a non-default application binary interface.
11644 @item -fshort-wchar
11645 @opindex fshort-wchar
11646 Override the underlying type for @samp{wchar_t} to be @samp{short
11647 unsigned int} instead of the default for the target.  This option is
11648 useful for building programs to run under WINE@.
11650 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
11651 code that is not binary compatible with code generated without that switch.
11652 Use it to conform to a non-default application binary interface.
11654 @item -fshared-data
11655 @opindex fshared-data
11656 Requests that the data and non-@code{const} variables of this
11657 compilation be shared data rather than private data.  The distinction
11658 makes sense only on certain operating systems, where shared data is
11659 shared between processes running the same program, while private data
11660 exists in one copy per process.
11662 @item -fno-common
11663 @opindex fno-common
11664 In C, allocate even uninitialized global variables in the data section of the
11665 object file, rather than generating them as common blocks.  This has the
11666 effect that if the same variable is declared (without @code{extern}) in
11667 two different compilations, you will get an error when you link them.
11668 The only reason this might be useful is if you wish to verify that the
11669 program will work on other systems which always work this way.
11671 @item -fno-ident
11672 @opindex fno-ident
11673 Ignore the @samp{#ident} directive.
11675 @item -finhibit-size-directive
11676 @opindex finhibit-size-directive
11677 Don't output a @code{.size} assembler directive, or anything else that
11678 would cause trouble if the function is split in the middle, and the
11679 two halves are placed at locations far apart in memory.  This option is
11680 used when compiling @file{crtstuff.c}; you should not need to use it
11681 for anything else.
11683 @item -fverbose-asm
11684 @opindex fverbose-asm
11685 Put extra commentary information in the generated assembly code to
11686 make it more readable.  This option is generally only of use to those
11687 who actually need to read the generated assembly code (perhaps while
11688 debugging the compiler itself).
11690 @option{-fno-verbose-asm}, the default, causes the
11691 extra information to be omitted and is useful when comparing two assembler
11692 files.
11694 @item -fpic
11695 @opindex fpic
11696 @cindex global offset table
11697 @cindex PIC
11698 Generate position-independent code (PIC) suitable for use in a shared
11699 library, if supported for the target machine.  Such code accesses all
11700 constant addresses through a global offset table (GOT)@.  The dynamic
11701 loader resolves the GOT entries when the program starts (the dynamic
11702 loader is not part of GCC; it is part of the operating system).  If
11703 the GOT size for the linked executable exceeds a machine-specific
11704 maximum size, you get an error message from the linker indicating that
11705 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
11706 instead.  (These maximums are 8k on the SPARC and 32k
11707 on the m68k and RS/6000.  The 386 has no such limit.)
11709 Position-independent code requires special support, and therefore works
11710 only on certain machines.  For the 386, GCC supports PIC for System V
11711 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
11712 position-independent.
11714 @item -fPIC
11715 @opindex fPIC
11716 If supported for the target machine, emit position-independent code,
11717 suitable for dynamic linking and avoiding any limit on the size of the
11718 global offset table.  This option makes a difference on the m68k
11719 and the SPARC.
11721 Position-independent code requires special support, and therefore works
11722 only on certain machines.
11724 @item -fpie
11725 @itemx -fPIE
11726 @opindex fpie
11727 @opindex fPIE
11728 These options are similar to @option{-fpic} and @option{-fPIC}, but
11729 generated position independent code can be only linked into executables.
11730 Usually these options are used when @option{-pie} GCC option will be
11731 used during linking.
11733 @item -ffixed-@var{reg}
11734 @opindex ffixed
11735 Treat the register named @var{reg} as a fixed register; generated code
11736 should never refer to it (except perhaps as a stack pointer, frame
11737 pointer or in some other fixed role).
11739 @var{reg} must be the name of a register.  The register names accepted
11740 are machine-specific and are defined in the @code{REGISTER_NAMES}
11741 macro in the machine description macro file.
11743 This flag does not have a negative form, because it specifies a
11744 three-way choice.
11746 @item -fcall-used-@var{reg}
11747 @opindex fcall-used
11748 Treat the register named @var{reg} as an allocable register that is
11749 clobbered by function calls.  It may be allocated for temporaries or
11750 variables that do not live across a call.  Functions compiled this way
11751 will not save and restore the register @var{reg}.
11753 It is an error to used this flag with the frame pointer or stack pointer.
11754 Use of this flag for other registers that have fixed pervasive roles in
11755 the machine's execution model will produce disastrous results.
11757 This flag does not have a negative form, because it specifies a
11758 three-way choice.
11760 @item -fcall-saved-@var{reg}
11761 @opindex fcall-saved
11762 Treat the register named @var{reg} as an allocable register saved by
11763 functions.  It may be allocated even for temporaries or variables that
11764 live across a call.  Functions compiled this way will save and restore
11765 the register @var{reg} if they use it.
11767 It is an error to used this flag with the frame pointer or stack pointer.
11768 Use of this flag for other registers that have fixed pervasive roles in
11769 the machine's execution model will produce disastrous results.
11771 A different sort of disaster will result from the use of this flag for
11772 a register in which function values may be returned.
11774 This flag does not have a negative form, because it specifies a
11775 three-way choice.
11777 @item -fpack-struct
11778 @opindex fpack-struct
11779 Pack all structure members together without holes.
11781 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
11782 code that is not binary compatible with code generated without that switch.
11783 Additionally, it makes the code suboptimal.
11784 Use it to conform to a non-default application binary interface.
11786 @item -finstrument-functions
11787 @opindex finstrument-functions
11788 Generate instrumentation calls for entry and exit to functions.  Just
11789 after function entry and just before function exit, the following
11790 profiling functions will be called with the address of the current
11791 function and its call site.  (On some platforms,
11792 @code{__builtin_return_address} does not work beyond the current
11793 function, so the call site information may not be available to the
11794 profiling functions otherwise.)
11796 @smallexample
11797 void __cyg_profile_func_enter (void *this_fn,
11798                                void *call_site);
11799 void __cyg_profile_func_exit  (void *this_fn,
11800                                void *call_site);
11801 @end smallexample
11803 The first argument is the address of the start of the current function,
11804 which may be looked up exactly in the symbol table.
11806 This instrumentation is also done for functions expanded inline in other
11807 functions.  The profiling calls will indicate where, conceptually, the
11808 inline function is entered and exited.  This means that addressable
11809 versions of such functions must be available.  If all your uses of a
11810 function are expanded inline, this may mean an additional expansion of
11811 code size.  If you use @samp{extern inline} in your C code, an
11812 addressable version of such functions must be provided.  (This is
11813 normally the case anyways, but if you get lucky and the optimizer always
11814 expands the functions inline, you might have gotten away without
11815 providing static copies.)
11817 A function may be given the attribute @code{no_instrument_function}, in
11818 which case this instrumentation will not be done.  This can be used, for
11819 example, for the profiling functions listed above, high-priority
11820 interrupt routines, and any functions from which the profiling functions
11821 cannot safely be called (perhaps signal handlers, if the profiling
11822 routines generate output or allocate memory).
11824 @item -fstack-check
11825 @opindex fstack-check
11826 Generate code to verify that you do not go beyond the boundary of the
11827 stack.  You should specify this flag if you are running in an
11828 environment with multiple threads, but only rarely need to specify it in
11829 a single-threaded environment since stack overflow is automatically
11830 detected on nearly all systems if there is only one stack.
11832 Note that this switch does not actually cause checking to be done; the
11833 operating system must do that.  The switch causes generation of code
11834 to ensure that the operating system sees the stack being extended.
11836 @item -fstack-limit-register=@var{reg}
11837 @itemx -fstack-limit-symbol=@var{sym}
11838 @itemx -fno-stack-limit
11839 @opindex fstack-limit-register
11840 @opindex fstack-limit-symbol
11841 @opindex fno-stack-limit
11842 Generate code to ensure that the stack does not grow beyond a certain value,
11843 either the value of a register or the address of a symbol.  If the stack
11844 would grow beyond the value, a signal is raised.  For most targets,
11845 the signal is raised before the stack overruns the boundary, so
11846 it is possible to catch the signal without taking special precautions.
11848 For instance, if the stack starts at absolute address @samp{0x80000000}
11849 and grows downwards, you can use the flags
11850 @option{-fstack-limit-symbol=__stack_limit} and
11851 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
11852 of 128KB@.  Note that this may only work with the GNU linker.
11854 @cindex aliasing of parameters
11855 @cindex parameters, aliased
11856 @item -fargument-alias
11857 @itemx -fargument-noalias
11858 @itemx -fargument-noalias-global
11859 @opindex fargument-alias
11860 @opindex fargument-noalias
11861 @opindex fargument-noalias-global
11862 Specify the possible relationships among parameters and between
11863 parameters and global data.
11865 @option{-fargument-alias} specifies that arguments (parameters) may
11866 alias each other and may alias global storage.@*
11867 @option{-fargument-noalias} specifies that arguments do not alias
11868 each other, but may alias global storage.@*
11869 @option{-fargument-noalias-global} specifies that arguments do not
11870 alias each other and do not alias global storage.
11872 Each language will automatically use whatever option is required by
11873 the language standard.  You should not need to use these options yourself.
11875 @item -fleading-underscore
11876 @opindex fleading-underscore
11877 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
11878 change the way C symbols are represented in the object file.  One use
11879 is to help link with legacy assembly code.
11881 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
11882 generate code that is not binary compatible with code generated without that
11883 switch.  Use it to conform to a non-default application binary interface.
11884 Not all targets provide complete support for this switch.
11886 @item -ftls-model=@var{model}
11887 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
11888 The @var{model} argument should be one of @code{global-dynamic},
11889 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
11891 The default without @option{-fpic} is @code{initial-exec}; with
11892 @option{-fpic} the default is @code{global-dynamic}.
11894 @item -fvisibility=@var{default|internal|hidden|protected}
11895 @opindex fvisibility
11896 Set the default ELF image symbol visibility to the specified option - all
11897 symbols will be marked with this unless overrided within the code.
11898 Using this feature can very substantially improve linking and
11899 load times of shared object libraries, produce more optimised
11900 code, provide near-perfect API export and prevent symbol clashes.
11901 It is @strong{strongly} recommended that you use this in any shared objects
11902 you distribute.
11903      
11904 Despite the nomenclature, @code{default} always means public ie;
11905 available to be linked against from outside the shared object.
11906 @code{protected} and @code{internal} are pretty useless in real-world
11907 usage so the only other commonly used option will be @code{hidden}.
11908 The default if -fvisibility isn't specified is @code{default} ie; make every
11909 symbol public - this causes the same behaviour as previous versions of
11910 GCC.
11911      
11912 A good explanation of the benefits offered by ensuring ELF
11913 symbols have the correct visibility is given by ``How To Write
11914 Shared Libraries'' by Ulrich Drepper (which can be found at
11915 @w{@uref{http://people.redhat.com/~drepper/}}) - however a superior
11916 solution made possible by this option to marking things hidden when
11917 the default is public is to make the default hidden and mark things
11918 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
11919 and @code{__attribute__ ((visibility("default")))} instead of
11920 @code{__declspec(dllexport)} you get almost identical semantics with
11921 identical syntax. This is a great boon to those working with
11922 cross-platform projects.
11924 For those adding visibility support to existing code, you may find
11925 @samp{#pragma GCC visibility} of use. This works by you enclosing
11926 the declarations you wish to set visibility for with (for example)
11927 @samp{#pragma GCC visibility push(hidden)} and
11928 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
11929 times. Bear in mind that symbol visibility should be viewed @strong{as
11930 part of the API interface contract} and thus all new code should
11931 always specify visibility when it is not the default ie; declarations
11932 only for use within the local DSO should @strong{always} be marked explicitly
11933 as hidden as so to avoid PLT indirection overheads - making this
11934 abundantly clear also aids readability and self-documentation of the code.
11935 Note that due to ISO C++ specification requirements, operator new and
11936 operator delete must always be of default visibility.
11938 An overview of these techniques, their benefits and how to use them
11939 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
11941 @end table
11943 @c man end
11945 @node Environment Variables
11946 @section Environment Variables Affecting GCC
11947 @cindex environment variables
11949 @c man begin ENVIRONMENT
11950 This section describes several environment variables that affect how GCC
11951 operates.  Some of them work by specifying directories or prefixes to use
11952 when searching for various kinds of files.  Some are used to specify other
11953 aspects of the compilation environment.
11955 Note that you can also specify places to search using options such as
11956 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
11957 take precedence over places specified using environment variables, which
11958 in turn take precedence over those specified by the configuration of GCC@.
11959 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
11960 GNU Compiler Collection (GCC) Internals}.
11962 @table @env
11963 @item LANG
11964 @itemx LC_CTYPE
11965 @c @itemx LC_COLLATE
11966 @itemx LC_MESSAGES
11967 @c @itemx LC_MONETARY
11968 @c @itemx LC_NUMERIC
11969 @c @itemx LC_TIME
11970 @itemx LC_ALL
11971 @findex LANG
11972 @findex LC_CTYPE
11973 @c @findex LC_COLLATE
11974 @findex LC_MESSAGES
11975 @c @findex LC_MONETARY
11976 @c @findex LC_NUMERIC
11977 @c @findex LC_TIME
11978 @findex LC_ALL
11979 @cindex locale
11980 These environment variables control the way that GCC uses
11981 localization information that allow GCC to work with different
11982 national conventions.  GCC inspects the locale categories
11983 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
11984 so.  These locale categories can be set to any value supported by your
11985 installation.  A typical value is @samp{en_UK} for English in the United
11986 Kingdom.
11988 The @env{LC_CTYPE} environment variable specifies character
11989 classification.  GCC uses it to determine the character boundaries in
11990 a string; this is needed for some multibyte encodings that contain quote
11991 and escape characters that would otherwise be interpreted as a string
11992 end or escape.
11994 The @env{LC_MESSAGES} environment variable specifies the language to
11995 use in diagnostic messages.
11997 If the @env{LC_ALL} environment variable is set, it overrides the value
11998 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
11999 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12000 environment variable.  If none of these variables are set, GCC
12001 defaults to traditional C English behavior.
12003 @item TMPDIR
12004 @findex TMPDIR
12005 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12006 files.  GCC uses temporary files to hold the output of one stage of
12007 compilation which is to be used as input to the next stage: for example,
12008 the output of the preprocessor, which is the input to the compiler
12009 proper.
12011 @item GCC_EXEC_PREFIX
12012 @findex GCC_EXEC_PREFIX
12013 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12014 names of the subprograms executed by the compiler.  No slash is added
12015 when this prefix is combined with the name of a subprogram, but you can
12016 specify a prefix that ends with a slash if you wish.
12018 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12019 an appropriate prefix to use based on the pathname it was invoked with.
12021 If GCC cannot find the subprogram using the specified prefix, it
12022 tries looking in the usual places for the subprogram.
12024 The default value of @env{GCC_EXEC_PREFIX} is
12025 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12026 of @code{prefix} when you ran the @file{configure} script.
12028 Other prefixes specified with @option{-B} take precedence over this prefix.
12030 This prefix is also used for finding files such as @file{crt0.o} that are
12031 used for linking.
12033 In addition, the prefix is used in an unusual way in finding the
12034 directories to search for header files.  For each of the standard
12035 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12036 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12037 replacing that beginning with the specified prefix to produce an
12038 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12039 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12040 These alternate directories are searched first; the standard directories
12041 come next.
12043 @item COMPILER_PATH
12044 @findex COMPILER_PATH
12045 The value of @env{COMPILER_PATH} is a colon-separated list of
12046 directories, much like @env{PATH}.  GCC tries the directories thus
12047 specified when searching for subprograms, if it can't find the
12048 subprograms using @env{GCC_EXEC_PREFIX}.
12050 @item LIBRARY_PATH
12051 @findex LIBRARY_PATH
12052 The value of @env{LIBRARY_PATH} is a colon-separated list of
12053 directories, much like @env{PATH}.  When configured as a native compiler,
12054 GCC tries the directories thus specified when searching for special
12055 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12056 using GCC also uses these directories when searching for ordinary
12057 libraries for the @option{-l} option (but directories specified with
12058 @option{-L} come first).
12060 @item LANG
12061 @findex LANG
12062 @cindex locale definition
12063 This variable is used to pass locale information to the compiler.  One way in
12064 which this information is used is to determine the character set to be used
12065 when character literals, string literals and comments are parsed in C and C++.
12066 When the compiler is configured to allow multibyte characters,
12067 the following values for @env{LANG} are recognized:
12069 @table @samp
12070 @item C-JIS
12071 Recognize JIS characters.
12072 @item C-SJIS
12073 Recognize SJIS characters.
12074 @item C-EUCJP
12075 Recognize EUCJP characters.
12076 @end table
12078 If @env{LANG} is not defined, or if it has some other value, then the
12079 compiler will use mblen and mbtowc as defined by the default locale to
12080 recognize and translate multibyte characters.
12081 @end table
12083 @noindent
12084 Some additional environments variables affect the behavior of the
12085 preprocessor.
12087 @include cppenv.texi
12089 @c man end
12091 @node Precompiled Headers
12092 @section Using Precompiled Headers
12093 @cindex precompiled headers
12094 @cindex speed of compilation
12096 Often large projects have many header files that are included in every
12097 source file.  The time the compiler takes to process these header files
12098 over and over again can account for nearly all of the time required to
12099 build the project.  To make builds faster, GCC allows users to
12100 `precompile' a header file; then, if builds can use the precompiled
12101 header file they will be much faster.
12103 @strong{Caution:} There are a few known situations where GCC will
12104 crash when trying to use a precompiled header.  If you have trouble
12105 with a precompiled header, you should remove the precompiled header
12106 and compile without it.  In addition, please use GCC's on-line
12107 defect-tracking system to report any problems you encounter with
12108 precompiled headers.  @xref{Bugs}.
12110 To create a precompiled header file, simply compile it as you would any
12111 other file, if necessary using the @option{-x} option to make the driver
12112 treat it as a C or C++ header file.  You will probably want to use a
12113 tool like @command{make} to keep the precompiled header up-to-date when
12114 the headers it contains change.
12116 A precompiled header file will be searched for when @code{#include} is
12117 seen in the compilation.  As it searches for the included file
12118 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12119 compiler looks for a precompiled header in each directory just before it
12120 looks for the include file in that directory.  The name searched for is
12121 the name specified in the @code{#include} with @samp{.gch} appended.  If
12122 the precompiled header file can't be used, it is ignored.
12124 For instance, if you have @code{#include "all.h"}, and you have
12125 @file{all.h.gch} in the same directory as @file{all.h}, then the
12126 precompiled header file will be used if possible, and the original
12127 header will be used otherwise.
12129 Alternatively, you might decide to put the precompiled header file in a
12130 directory and use @option{-I} to ensure that directory is searched
12131 before (or instead of) the directory containing the original header.
12132 Then, if you want to check that the precompiled header file is always
12133 used, you can put a file of the same name as the original header in this
12134 directory containing an @code{#error} command.
12136 This also works with @option{-include}.  So yet another way to use
12137 precompiled headers, good for projects not designed with precompiled
12138 header files in mind, is to simply take most of the header files used by
12139 a project, include them from another header file, precompile that header
12140 file, and @option{-include} the precompiled header.  If the header files
12141 have guards against multiple inclusion, they will be skipped because
12142 they've already been included (in the precompiled header).
12144 If you need to precompile the same header file for different
12145 languages, targets, or compiler options, you can instead make a
12146 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12147 header in the directory, perhaps using @option{-o}.  It doesn't matter
12148 what you call the files in the directory, every precompiled header in
12149 the directory will be considered.  The first precompiled header
12150 encountered in the directory that is valid for this compilation will
12151 be used; they're searched in no particular order.
12153 There are many other possibilities, limited only by your imagination,
12154 good sense, and the constraints of your build system.
12156 A precompiled header file can be used only when these conditions apply:
12158 @itemize
12159 @item
12160 Only one precompiled header can be used in a particular compilation.
12162 @item
12163 A precompiled header can't be used once the first C token is seen.  You
12164 can have preprocessor directives before a precompiled header; you can
12165 even include a precompiled header from inside another header, so long as
12166 there are no C tokens before the @code{#include}.
12168 @item
12169 The precompiled header file must be produced for the same language as
12170 the current compilation.  You can't use a C precompiled header for a C++
12171 compilation.
12173 @item
12174 The precompiled header file must be produced by the same compiler
12175 version and configuration as the current compilation is using.
12176 The easiest way to guarantee this is to use the same compiler binary
12177 for creating and using precompiled headers.
12179 @item
12180 Any macros defined before the precompiled header is included must
12181 either be defined in the same way as when the precompiled header was
12182 generated, or must not affect the precompiled header, which usually
12183 means that the they don't appear in the precompiled header at all.
12185 The @option{-D} option is one way to define a macro before a
12186 precompiled header is included; using a @code{#define} can also do it.
12187 There are also some options that define macros implicitly, like
12188 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12189 defined this way.
12191 @item If debugging information is output when using the precompiled
12192 header, using @option{-g} or similar, the same kind of debugging information
12193 must have been output when building the precompiled header.  However,
12194 a precompiled header built using @option{-g} can be used in a compilation
12195 when no debugging information is being output.
12197 @item The same @option{-m} options must generally be used when building
12198 and using the precompiled header.  @xref{Submodel Options},
12199 for any cases where this rule is relaxed.
12201 @item Each of the following options must be the same when building and using
12202 the precompiled header:
12204 @gccoptlist{-fexceptions -funit-at-a-time}
12206 @item
12207 Some other command-line options starting with @option{-f},
12208 @option{-p}, or @option{-O} must be defined in the same way as when
12209 the precompiled header was generated.  At present, it's not clear
12210 which options are safe to change and which are not; the safest choice
12211 is to use exactly the same options when generating and using the
12212 precompiled header.  The following are known to be safe:
12214 @gccoptlist{-fpreprocessed -pedantic-errors}
12216 @end itemize
12218 For all of these except the last, the compiler will automatically
12219 ignore the precompiled header if the conditions aren't met.  If you
12220 find an option combination that doesn't work and doesn't cause the
12221 precompiled header to be ignored, please consider filing a bug report,
12222 see @ref{Bugs}.
12224 If you do use differing options when generating and using the
12225 precompiled header, the actual behaviour will be a mixture of the
12226 behaviour for the options.  For instance, if you use @option{-g} to
12227 generate the precompiled header but not when using it, you may or may
12228 not get debugging information for routines in the precompiled header.
12230 @node Running Protoize
12231 @section Running Protoize
12233 The program @code{protoize} is an optional part of GCC@.  You can use
12234 it to add prototypes to a program, thus converting the program to ISO
12235 C in one respect.  The companion program @code{unprotoize} does the
12236 reverse: it removes argument types from any prototypes that are found.
12238 When you run these programs, you must specify a set of source files as
12239 command line arguments.  The conversion programs start out by compiling
12240 these files to see what functions they define.  The information gathered
12241 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12243 After scanning comes actual conversion.  The specified files are all
12244 eligible to be converted; any files they include (whether sources or
12245 just headers) are eligible as well.
12247 But not all the eligible files are converted.  By default,
12248 @code{protoize} and @code{unprotoize} convert only source and header
12249 files in the current directory.  You can specify additional directories
12250 whose files should be converted with the @option{-d @var{directory}}
12251 option.  You can also specify particular files to exclude with the
12252 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12253 directory name matches one of the specified directory names, and its
12254 name within the directory has not been excluded.
12256 Basic conversion with @code{protoize} consists of rewriting most
12257 function definitions and function declarations to specify the types of
12258 the arguments.  The only ones not rewritten are those for varargs
12259 functions.
12261 @code{protoize} optionally inserts prototype declarations at the
12262 beginning of the source file, to make them available for any calls that
12263 precede the function's definition.  Or it can insert prototype
12264 declarations with block scope in the blocks where undeclared functions
12265 are called.
12267 Basic conversion with @code{unprotoize} consists of rewriting most
12268 function declarations to remove any argument types, and rewriting
12269 function definitions to the old-style pre-ISO form.
12271 Both conversion programs print a warning for any function declaration or
12272 definition that they can't convert.  You can suppress these warnings
12273 with @option{-q}.
12275 The output from @code{protoize} or @code{unprotoize} replaces the
12276 original source file.  The original file is renamed to a name ending
12277 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12278 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12279 for DOS) file already exists, then the source file is simply discarded.
12281 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12282 scan the program and collect information about the functions it uses.
12283 So neither of these programs will work until GCC is installed.
12285 Here is a table of the options you can use with @code{protoize} and
12286 @code{unprotoize}.  Each option works with both programs unless
12287 otherwise stated.
12289 @table @code
12290 @item -B @var{directory}
12291 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12292 usual directory (normally @file{/usr/local/lib}).  This file contains
12293 prototype information about standard system functions.  This option
12294 applies only to @code{protoize}.
12296 @item -c @var{compilation-options}
12297 Use @var{compilation-options} as the options when running @command{gcc} to
12298 produce the @samp{.X} files.  The special option @option{-aux-info} is
12299 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12301 Note that the compilation options must be given as a single argument to
12302 @code{protoize} or @code{unprotoize}.  If you want to specify several
12303 @command{gcc} options, you must quote the entire set of compilation options
12304 to make them a single word in the shell.
12306 There are certain @command{gcc} arguments that you cannot use, because they
12307 would produce the wrong kind of output.  These include @option{-g},
12308 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12309 the @var{compilation-options}, they are ignored.
12311 @item -C
12312 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12313 systems) instead of @samp{.c}.  This is convenient if you are converting
12314 a C program to C++.  This option applies only to @code{protoize}.
12316 @item -g
12317 Add explicit global declarations.  This means inserting explicit
12318 declarations at the beginning of each source file for each function
12319 that is called in the file and was not declared.  These declarations
12320 precede the first function definition that contains a call to an
12321 undeclared function.  This option applies only to @code{protoize}.
12323 @item -i @var{string}
12324 Indent old-style parameter declarations with the string @var{string}.
12325 This option applies only to @code{protoize}.
12327 @code{unprotoize} converts prototyped function definitions to old-style
12328 function definitions, where the arguments are declared between the
12329 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12330 uses five spaces as the indentation.  If you want to indent with just
12331 one space instead, use @option{-i " "}.
12333 @item -k
12334 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12335 is finished.
12337 @item -l
12338 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12339 a prototype declaration for each function in each block which calls the
12340 function without any declaration.  This option applies only to
12341 @code{protoize}.
12343 @item -n
12344 Make no real changes.  This mode just prints information about the conversions
12345 that would have been done without @option{-n}.
12347 @item -N
12348 Make no @samp{.save} files.  The original files are simply deleted.
12349 Use this option with caution.
12351 @item -p @var{program}
12352 Use the program @var{program} as the compiler.  Normally, the name
12353 @file{gcc} is used.
12355 @item -q
12356 Work quietly.  Most warnings are suppressed.
12358 @item -v
12359 Print the version number, just like @option{-v} for @command{gcc}.
12360 @end table
12362 If you need special compiler options to compile one of your program's
12363 source files, then you should generate that file's @samp{.X} file
12364 specially, by running @command{gcc} on that source file with the
12365 appropriate options and the option @option{-aux-info}.  Then run
12366 @code{protoize} on the entire set of files.  @code{protoize} will use
12367 the existing @samp{.X} file because it is newer than the source file.
12368 For example:
12370 @smallexample
12371 gcc -Dfoo=bar file1.c -aux-info file1.X
12372 protoize *.c
12373 @end smallexample
12375 @noindent
12376 You need to include the special files along with the rest in the
12377 @code{protoize} command, even though their @samp{.X} files already
12378 exist, because otherwise they won't get converted.
12380 @xref{Protoize Caveats}, for more information on how to use
12381 @code{protoize} successfully.