doc/
[official-gcc.git] / gcc / doc / invoke.texi
blob2f8c7ac3d43fb257a6c0472e2a8e40626597cff7
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below).  A copy of the license is
17 included in the gfdl(7) man page.
19 (a) The FSF's Front-Cover Text is:
21      A GNU Manual
23 (b) The FSF's Back-Cover Text is:
25      You have freedom to copy and modify this GNU Manual, like GNU
26      software.  Copies published by the Free Software Foundation raise
27      funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34     [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35     [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36     [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37     [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38     [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39     [@option{-o} @var{outfile}] @var{infile}@dots{}
41 Only the most useful options are listed here; see below for the
42 remainder.  @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking.  The ``overall options'' allow you to stop this
70 process at an intermediate stage.  For example, the @option{-c} option
71 says not to run the linker.  Then the output consists of object files
72 output by the assembler.
74 Other options are passed on to one stage of processing.  Some options
75 control the preprocessor and others the compiler itself.  Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly.  If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands.  Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments.  For the most part, the order
100 you use doesn't matter.  Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example, @option{-fforce-mem},
106 @option{-fstrength-reduce}, @option{-Wformat} and so on.  Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}.  This manual documents
109 only one of these two forms, whichever one is not the default.
111 @c man end
113 @xref{Option Index}, for an index to GCC's options.
115 @menu
116 * Option Summary::      Brief list of all options, without explanations.
117 * Overall Options::     Controlling the kind of output:
118                         an executable, object files, assembler files,
119                         or preprocessed source.
120 * Invoking G++::        Compiling C++ programs.
121 * C Dialect Options::   Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124                         and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126                         formatted.
127 * Warning Options::     How picky should the compiler be?
128 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
129 * Optimize Options::    How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131                          Also, getting dependency information for Make.
132 * Assembler Options::   Passing options to the assembler.
133 * Link Options::        Specifying libraries and so on.
134 * Directory Options::   Where to find header files and libraries.
135                         Where to find the compiler executable files.
136 * Spec Files::          How to pass switches to sub-processes.
137 * Target Options::      Running a cross-compiler, or an old version of GCC.
138 * Submodel Options::    Specifying minor hardware or convention variations,
139                         such as 68010 vs 68020.
140 * Code Gen Options::    Specifying conventions for function calls, data layout
141                         and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize::    Automatically adding or removing function prototypes.
145 @end menu
147 @c man begin OPTIONS
149 @node Option Summary
150 @section Option Summary
152 Here is a summary of all the options, grouped by type.  Explanations are
153 in the following sections.
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c  -S  -E  -o @var{file}  -combine -pipe  -pass-exit-codes  @gol
159 -x @var{language}  -v  -###  --help  --target-help  --version}
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi  -std=@var{standard}  -aux-info @var{filename} @gol
164 -fno-asm  -fno-builtin  -fno-builtin-@var{function} @gol
165 -fhosted  -ffreestanding  -fms-extensions @gol
166 -trigraphs  -no-integrated-cpp  -traditional  -traditional-cpp @gol
167 -fallow-single-precision  -fcond-mismatch @gol
168 -fsigned-bitfields  -fsigned-char @gol
169 -funsigned-bitfields  -funsigned-char}
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
174 -fconserve-space  -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines  -fms-extensions @gol
181 -fno-nonansi-builtins  -fno-operator-names @gol
182 -fno-optional-diags  -fpermissive @gol
183 -frepo  -fno-rtti  -fstats  -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
185 -fno-default-inline  -fvisibility-inlines-hidden @gol
186 -Wabi  -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor  -Wreorder @gol
188 -Weffc++  -Wno-deprecated @gol
189 -Wno-non-template-friend  -Wold-style-cast @gol
190 -Woverloaded-virtual  -Wno-pmf-conversions @gol
191 -Wsign-promo}
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime  -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol  -Wselector -Wundeclared-selector}
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-fmessage-length=@var{n}  @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{-fsyntax-only  -pedantic  -pedantic-errors @gol
214 -w  -Wextra  -Wall  -Waggregate-return @gol
215 -Wcast-align  -Wcast-qual  -Wchar-subscripts  -Wcomment @gol
216 -Wconversion  -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization  -Wno-div-by-zero  -Wno-endif-labels @gol
218 -Werror  -Werror-implicit-function-declaration @gol
219 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
220 -Wno-format-extra-args -Wformat-nonliteral @gol
221 -Wformat-security  -Wformat-y2k @gol
222 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
223 -Wimport  -Wno-import  -Winit-self  -Winline @gol
224 -Wno-invalid-offsetof  -Winvalid-pch @gol
225 -Wlarger-than-@var{len}  -Wlong-long @gol
226 -Wmain  -Wmissing-braces  -Wmissing-field-initializers @gol
227 -Wmissing-format-attribute  -Wmissing-include-dirs @gol
228 -Wmissing-noreturn @gol
229 -Wno-multichar  -Wnonnull  -Wpacked  -Wpadded @gol
230 -Wparentheses  -Wpointer-arith  -Wredundant-decls @gol
231 -Wreturn-type  -Wsequence-point  -Wshadow @gol
232 -Wsign-compare  -Wstrict-aliasing -Wstrict-aliasing=2 @gol
233 -Wswitch  -Wswitch-default  -Wswitch-enum @gol
234 -Wsystem-headers  -Wtrigraphs  -Wundef  -Wuninitialized @gol
235 -Wunknown-pragmas  -Wunreachable-code @gol
236 -Wunused  -Wunused-function  -Wunused-label  -Wunused-parameter @gol
237 -Wunused-value  -Wunused-variable  -Wwrite-strings @gol
238 -Wvariadic-macros}
240 @item C-only Warning Options
241 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
242 -Wmissing-prototypes  -Wnested-externs  -Wold-style-definition @gol
243 -Wstrict-prototypes  -Wtraditional @gol
244 -Wdeclaration-after-statement -Wno-pointer-sign}
246 @item Debugging Options
247 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
248 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
249 -fdump-unnumbered  -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
250 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
251 -fdump-ipa-all -fdump-ipa-cgraph @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-sink @gol
268 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-salias @gol
270 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
271 -ftree-vectorizer-verbose=@var{n} @gol
272 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
273 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
274 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
275 -ftest-coverage  -ftime-report -fvar-tracking @gol
276 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
277 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
278 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
279 -print-multi-directory  -print-multi-lib @gol
280 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
281 -save-temps  -time}
283 @item Optimization Options
284 @xref{Optimize Options,,Options that Control Optimization}.
285 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
286 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
287 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
288 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
289 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
290 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
291 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
292 -fdelayed-branch  -fdelete-null-pointer-checks @gol
293 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
294 -fforce-addr  -fforce-mem  -ffunction-sections @gol
295 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
296 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
297 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
298 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
299 -fmodulo-sched -fno-branch-count-reg @gol
300 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
301 -fno-function-cse  -fno-guess-branch-probability @gol
302 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
303 -funsafe-math-optimizations  -ffinite-math-only @gol
304 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
305 -fomit-frame-pointer  -foptimize-register-move @gol
306 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
307 -fprofile-generate -fprofile-use @gol
308 -fregmove  -frename-registers @gol
309 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
310 -frerun-cse-after-loop  -frerun-loop-opt @gol
311 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
312 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
313 -fsched-spec-load-dangerous  @gol
314 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
315 -fsched2-use-superblocks @gol
316 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
317 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
318 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
319 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
320 -fsplit-ivs-in-unroller -funswitch-loops @gol
321 -fvariable-expansion-in-unroller @gol
322 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
323 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
324 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
325 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
326 -ftree-salias @gol
327 --param @var{name}=@var{value}
328 -O  -O0  -O1  -O2  -O3  -Os}
330 @item Preprocessor Options
331 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
332 @gccoptlist{-A@var{question}=@var{answer} @gol
333 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
334 -C  -dD  -dI  -dM  -dN @gol
335 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
336 -idirafter @var{dir} @gol
337 -include @var{file}  -imacros @var{file} @gol
338 -iprefix @var{file}  -iwithprefix @var{dir} @gol
339 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
340 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
341 -P  -fworking-directory  -remap @gol
342 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
343 -Xpreprocessor @var{option}}
345 @item Assembler Option
346 @xref{Assembler Options,,Passing Options to the Assembler}.
347 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
349 @item Linker Options
350 @xref{Link Options,,Options for Linking}.
351 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
352 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
353 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
354 -Wl,@var{option}  -Xlinker @var{option} @gol
355 -u @var{symbol}}
357 @item Directory Options
358 @xref{Directory Options,,Options for Directory Search}.
359 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
361 @item Target Options
362 @c I wrote this xref this way to avoid overfull hbox. -- rms
363 @xref{Target Options}.
364 @gccoptlist{-V @var{version}  -b @var{machine}}
366 @item Machine Dependent Options
367 @xref{Submodel Options,,Hardware Models and Configurations}.
368 @c This list is ordered alphanumerically by subsection name.
369 @c Try and put the significant identifier (CPU or system) first,
370 @c so users have a clue at guessing where the ones they want will be.
372 @emph{ARC Options}
373 @gccoptlist{-EB  -EL @gol
374 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
375 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
377 @emph{ARM Options}
378 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
379 -mabi=@var{name} @gol
380 -mapcs-stack-check  -mno-apcs-stack-check @gol
381 -mapcs-float  -mno-apcs-float @gol
382 -mapcs-reentrant  -mno-apcs-reentrant @gol
383 -msched-prolog  -mno-sched-prolog @gol
384 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
385 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
386 -mthumb-interwork  -mno-thumb-interwork @gol
387 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
388 -mstructure-size-boundary=@var{n} @gol
389 -mabort-on-noreturn @gol
390 -mlong-calls  -mno-long-calls @gol
391 -msingle-pic-base  -mno-single-pic-base @gol
392 -mpic-register=@var{reg} @gol
393 -mnop-fun-dllimport @gol
394 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
395 -mpoke-function-name @gol
396 -mthumb  -marm @gol
397 -mtpcs-frame  -mtpcs-leaf-frame @gol
398 -mcaller-super-interworking  -mcallee-super-interworking}
400 @emph{AVR Options}
401 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
402 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
404 @emph{CRIS Options}
405 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
406 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
407 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
408 -mstack-align  -mdata-align  -mconst-align @gol
409 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
410 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
411 -mmul-bug-workaround  -mno-mul-bug-workaround}
413 @emph{Darwin Options}
414 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
415 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
416 -client_name  -compatibility_version  -current_version @gol
417 -dead_strip @gol
418 -dependency-file  -dylib_file  -dylinker_install_name @gol
419 -dynamic  -dynamiclib  -exported_symbols_list @gol
420 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
421 -force_flat_namespace  -headerpad_max_install_names @gol
422 -image_base  -init  -install_name  -keep_private_externs @gol
423 -multi_module  -multiply_defined  -multiply_defined_unused @gol
424 -noall_load   -no_dead_strip_inits_and_terms @gol
425 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
426 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
427 -private_bundle  -read_only_relocs  -sectalign @gol
428 -sectobjectsymbols  -whyload  -seg1addr @gol
429 -sectcreate  -sectobjectsymbols  -sectorder @gol
430 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
431 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
432 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
433 -single_module  -static  -sub_library  -sub_umbrella @gol
434 -twolevel_namespace  -umbrella  -undefined @gol
435 -unexported_symbols_list  -weak_reference_mismatches @gol
436 -whatsloaded -F -gused -gfull -mone-byte-bool}
438 @emph{DEC Alpha Options}
439 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
440 -mieee  -mieee-with-inexact  -mieee-conformant @gol
441 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
442 -mtrap-precision=@var{mode}  -mbuild-constants @gol
443 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
444 -mbwx  -mmax  -mfix  -mcix @gol
445 -mfloat-vax  -mfloat-ieee @gol
446 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
447 -msmall-text  -mlarge-text @gol
448 -mmemory-latency=@var{time}}
450 @emph{DEC Alpha/VMS Options}
451 @gccoptlist{-mvms-return-codes}
453 @emph{FRV Options}
454 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
455 -mhard-float  -msoft-float @gol
456 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
457 -mdouble  -mno-double @gol
458 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
459 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
460 -mlinked-fp  -mlong-calls  -malign-labels @gol
461 -mlibrary-pic  -macc-4  -macc-8 @gol
462 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
463 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
464 -mvliw-branch  -mno-vliw-branch @gol
465 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
466 -mno-nested-cond-exec  -mtomcat-stats @gol
467 -mTLS -mtls @gol
468 -mcpu=@var{cpu}}
470 @emph{H8/300 Options}
471 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
473 @emph{HPPA Options}
474 @gccoptlist{-march=@var{architecture-type} @gol
475 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
476 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
477 -mfixed-range=@var{register-range} @gol
478 -mjump-in-delay -mlinker-opt -mlong-calls @gol
479 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
480 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
481 -mno-jump-in-delay  -mno-long-load-store @gol
482 -mno-portable-runtime  -mno-soft-float @gol
483 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
484 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
485 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
486 -munix=@var{unix-std}  -nolibdld  -static  -threads}
488 @emph{i386 and x86-64 Options}
489 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
490 -mfpmath=@var{unit} @gol
491 -masm=@var{dialect}  -mno-fancy-math-387 @gol
492 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
493 -mno-wide-multiply  -mrtd  -malign-double @gol
494 -mpreferred-stack-boundary=@var{num} @gol
495 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
496 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
497 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
498 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
499 -mno-red-zone -mno-tls-direct-seg-refs @gol
500 -mcmodel=@var{code-model} @gol
501 -m32  -m64}
503 @emph{IA-64 Options}
504 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
505 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
506 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
507 -minline-float-divide-max-throughput @gol
508 -minline-int-divide-min-latency @gol
509 -minline-int-divide-max-throughput  @gol
510 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
511 -mno-dwarf2-asm -mearly-stop-bits @gol
512 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
513 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
515 @emph{M32R/D Options}
516 @gccoptlist{-m32r2 -m32rx -m32r @gol
517 -mdebug @gol
518 -malign-loops -mno-align-loops @gol
519 -missue-rate=@var{number} @gol
520 -mbranch-cost=@var{number} @gol
521 -mmodel=@var{code-size-model-type} @gol
522 -msdata=@var{sdata-type} @gol
523 -mno-flush-func -mflush-func=@var{name} @gol
524 -mno-flush-trap -mflush-trap=@var{number} @gol
525 -G @var{num}}
527 @emph{M680x0 Options}
528 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
529 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
530 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
531 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
532 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
534 @emph{M68hc1x Options}
535 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
536 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
537 -msoft-reg-count=@var{count}}
539 @emph{MCore Options}
540 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
541 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
542 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
543 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
544 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
546 @emph{MIPS Options}
547 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
548 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
549 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
550 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
551 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
552 -mpaired-single  -mips3d @gol
553 -mint64  -mlong64  -mlong32  -msym32  -mno-sym32 @gol
554 -G@var{num}  -membedded-data  -mno-embedded-data @gol
555 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
556 -msplit-addresses  -mno-split-addresses  @gol
557 -mexplicit-relocs  -mno-explicit-relocs  @gol
558 -mcheck-zero-division  -mno-check-zero-division @gol
559 -mdivide-traps  -mdivide-breaks @gol
560 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
561 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
562 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
563 -mfix-vr4120  -mno-fix-vr4120  -mfix-vr4130 @gol
564 -mfix-sb1  -mno-fix-sb1 @gol
565 -mflush-func=@var{func}  -mno-flush-func @gol
566 -mbranch-likely  -mno-branch-likely @gol
567 -mfp-exceptions -mno-fp-exceptions @gol
568 -mvr4130-align -mno-vr4130-align}
570 @emph{MMIX Options}
571 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
572 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
573 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
574 -mno-base-addresses  -msingle-exit  -mno-single-exit}
576 @emph{MN10300 Options}
577 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
578 -mam33  -mno-am33 @gol
579 -mam33-2  -mno-am33-2 @gol
580 -mno-crt0  -mrelax}
582 @emph{NS32K Options}
583 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
584 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
585 -mregparam  -mnoregparam  -msb  -mnosb @gol
586 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
588 @emph{PDP-11 Options}
589 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
590 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
591 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
592 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
593 -mbranch-expensive  -mbranch-cheap @gol
594 -msplit  -mno-split  -munix-asm  -mdec-asm}
596 @emph{PowerPC Options}
597 See RS/6000 and PowerPC Options.
599 @emph{RS/6000 and PowerPC Options}
600 @gccoptlist{-mcpu=@var{cpu-type} @gol
601 -mtune=@var{cpu-type} @gol
602 -mpower  -mno-power  -mpower2  -mno-power2 @gol
603 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
604 -maltivec  -mno-altivec @gol
605 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
606 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
607 -mnew-mnemonics  -mold-mnemonics @gol
608 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
609 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
610 -malign-power  -malign-natural @gol
611 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
612 -mstring  -mno-string  -mupdate  -mno-update @gol
613 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
614 -mstrict-align  -mno-strict-align  -mrelocatable @gol
615 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
616 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
617 -mdynamic-no-pic @gol
618 -mprioritize-restricted-insns=@var{priority} @gol
619 -msched-costly-dep=@var{dependence_type} @gol
620 -minsert-sched-nops=@var{scheme} @gol
621 -mcall-sysv  -mcall-netbsd @gol
622 -maix-struct-return  -msvr4-struct-return @gol
623 -mabi=altivec  -mabi=no-altivec @gol
624 -mabi=spe  -mabi=no-spe @gol
625 -misel=yes  -misel=no @gol
626 -mspe=yes  -mspe=no @gol
627 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
628 -mprototype  -mno-prototype @gol
629 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
630 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
632 @emph{S/390 and zSeries Options}
633 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
634 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
635 -mpacked-stack  -mno-packed-stack @gol
636 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
637 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
638 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
639 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
641 @emph{SH Options}
642 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
643 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
644 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
645 -m5-64media  -m5-64media-nofpu @gol
646 -m5-32media  -m5-32media-nofpu @gol
647 -m5-compact  -m5-compact-nofpu @gol
648 -mb  -ml  -mdalign  -mrelax @gol
649 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
650 -mieee  -misize  -mpadstruct  -mspace @gol
651 -mprefergot  -musermode}
653 @emph{SPARC Options}
654 @gccoptlist{-mcpu=@var{cpu-type} @gol
655 -mtune=@var{cpu-type} @gol
656 -mcmodel=@var{code-model} @gol
657 -m32  -m64  -mapp-regs  -mno-app-regs @gol
658 -mfaster-structs  -mno-faster-structs @gol
659 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
660 -mhard-quad-float  -msoft-quad-float @gol
661 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
662 -mstack-bias  -mno-stack-bias @gol
663 -munaligned-doubles  -mno-unaligned-doubles @gol
664 -mv8plus  -mno-v8plus  -mvis  -mno-vis
665 -threads -pthreads}
667 @emph{System V Options}
668 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
670 @emph{TMS320C3x/C4x Options}
671 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
672 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
673 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
674 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
676 @emph{V850 Options}
677 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
678 -mprolog-function  -mno-prolog-function  -mspace @gol
679 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
680 -mapp-regs  -mno-app-regs @gol
681 -mdisable-callt  -mno-disable-callt @gol
682 -mv850e1 @gol
683 -mv850e @gol
684 -mv850  -mbig-switch}
686 @emph{VAX Options}
687 @gccoptlist{-mg  -mgnu  -munix}
689 @emph{x86-64 Options}
690 See i386 and x86-64 Options.
692 @emph{Xstormy16 Options}
693 @gccoptlist{-msim}
695 @emph{Xtensa Options}
696 @gccoptlist{-mconst16 -mno-const16 @gol
697 -mfused-madd  -mno-fused-madd @gol
698 -mtext-section-literals  -mno-text-section-literals @gol
699 -mtarget-align  -mno-target-align @gol
700 -mlongcalls  -mno-longcalls}
702 @emph{zSeries Options}
703 See S/390 and zSeries Options.
705 @item Code Generation Options
706 @xref{Code Gen Options,,Options for Code Generation Conventions}.
707 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
708 -ffixed-@var{reg}  -fexceptions @gol
709 -fnon-call-exceptions  -funwind-tables @gol
710 -fasynchronous-unwind-tables @gol
711 -finhibit-size-directive  -finstrument-functions @gol
712 -fno-common  -fno-ident @gol
713 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
714 -freg-struct-return  -fshared-data  -fshort-enums @gol
715 -fshort-double  -fshort-wchar @gol
716 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
717 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
718 -fargument-alias  -fargument-noalias @gol
719 -fargument-noalias-global  -fleading-underscore @gol
720 -ftls-model=@var{model} @gol
721 -ftrapv  -fwrapv  -fbounds-check @gol
722 -fvisibility}
723 @end table
725 @menu
726 * Overall Options::     Controlling the kind of output:
727                         an executable, object files, assembler files,
728                         or preprocessed source.
729 * C Dialect Options::   Controlling the variant of C language compiled.
730 * C++ Dialect Options:: Variations on C++.
731 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
732                         and Objective-C++.
733 * Language Independent Options:: Controlling how diagnostics should be
734                         formatted.
735 * Warning Options::     How picky should the compiler be?
736 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
737 * Optimize Options::    How much optimization?
738 * Preprocessor Options:: Controlling header files and macro definitions.
739                          Also, getting dependency information for Make.
740 * Assembler Options::   Passing options to the assembler.
741 * Link Options::        Specifying libraries and so on.
742 * Directory Options::   Where to find header files and libraries.
743                         Where to find the compiler executable files.
744 * Spec Files::          How to pass switches to sub-processes.
745 * Target Options::      Running a cross-compiler, or an old version of GCC.
746 @end menu
748 @node Overall Options
749 @section Options Controlling the Kind of Output
751 Compilation can involve up to four stages: preprocessing, compilation
752 proper, assembly and linking, always in that order.  GCC is capable of
753 preprocessing and compiling several files either into several
754 assembler input files, or into one assembler input file; then each
755 assembler input file produces an object file, and linking combines all
756 the object files (those newly compiled, and those specified as input)
757 into an executable file.
759 @cindex file name suffix
760 For any given input file, the file name suffix determines what kind of
761 compilation is done:
763 @table @gcctabopt
764 @item @var{file}.c
765 C source code which must be preprocessed.
767 @item @var{file}.i
768 C source code which should not be preprocessed.
770 @item @var{file}.ii
771 C++ source code which should not be preprocessed.
773 @item @var{file}.m
774 Objective-C source code.  Note that you must link with the @file{libobjc}
775 library to make an Objective-C program work.
777 @item @var{file}.mi
778 Objective-C source code which should not be preprocessed.
780 @item @var{file}.mm
781 @itemx @var{file}.M
782 Objective-C++ source code.  Note that you must link with the @file{libobjc}
783 library to make an Objective-C++ program work.  Note that @samp{.M} refers
784 to a literal capital M@.
786 @item @var{file}.mii
787 Objective-C++ source code which should not be preprocessed.
789 @item @var{file}.h
790 C, C++, Objective-C or Objective-C++ header file to be turned into a
791 precompiled header.
793 @item @var{file}.cc
794 @itemx @var{file}.cp
795 @itemx @var{file}.cxx
796 @itemx @var{file}.cpp
797 @itemx @var{file}.CPP
798 @itemx @var{file}.c++
799 @itemx @var{file}.C
800 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
801 the last two letters must both be literally @samp{x}.  Likewise,
802 @samp{.C} refers to a literal capital C@.
804 @item @var{file}.hh
805 @itemx @var{file}.H
806 C++ header file to be turned into a precompiled header.
808 @item @var{file}.f
809 @itemx @var{file}.for
810 @itemx @var{file}.FOR
811 Fortran source code which should not be preprocessed.
813 @item @var{file}.F
814 @itemx @var{file}.fpp
815 @itemx @var{file}.FPP
816 Fortran source code which must be preprocessed (with the traditional
817 preprocessor).
819 @item @var{file}.r
820 Fortran source code which must be preprocessed with a RATFOR
821 preprocessor (not included with GCC)@.
823 @item @var{file}.f90
824 @itemx @var{file}.f95
825 Fortran 90/95 source code which should not be preprocessed.
827 @c FIXME: Descriptions of Java file types.
828 @c @var{file}.java
829 @c @var{file}.class
830 @c @var{file}.zip
831 @c @var{file}.jar
833 @item @var{file}.ads
834 Ada source code file which contains a library unit declaration (a
835 declaration of a package, subprogram, or generic, or a generic
836 instantiation), or a library unit renaming declaration (a package,
837 generic, or subprogram renaming declaration).  Such files are also
838 called @dfn{specs}.
840 @itemx @var{file}.adb
841 Ada source code file containing a library unit body (a subprogram or
842 package body).  Such files are also called @dfn{bodies}.
844 @c GCC also knows about some suffixes for languages not yet included:
845 @c Pascal:
846 @c @var{file}.p
847 @c @var{file}.pas
849 @item @var{file}.s
850 Assembler code.
852 @item @var{file}.S
853 Assembler code which must be preprocessed.
855 @item @var{other}
856 An object file to be fed straight into linking.
857 Any file name with no recognized suffix is treated this way.
858 @end table
860 @opindex x
861 You can specify the input language explicitly with the @option{-x} option:
863 @table @gcctabopt
864 @item -x @var{language}
865 Specify explicitly the @var{language} for the following input files
866 (rather than letting the compiler choose a default based on the file
867 name suffix).  This option applies to all following input files until
868 the next @option{-x} option.  Possible values for @var{language} are:
869 @smallexample
870 c  c-header  c-cpp-output
871 c++  c++-header  c++-cpp-output
872 objective-c  objective-c-header  objective-c-cpp-output
873 objective-c++ objective-c++-header objective-c++-cpp-output
874 assembler  assembler-with-cpp
876 f77  f77-cpp-input  ratfor
878 java
879 treelang
880 @end smallexample
882 @item -x none
883 Turn off any specification of a language, so that subsequent files are
884 handled according to their file name suffixes (as they are if @option{-x}
885 has not been used at all).
887 @item -pass-exit-codes
888 @opindex pass-exit-codes
889 Normally the @command{gcc} program will exit with the code of 1 if any
890 phase of the compiler returns a non-success return code.  If you specify
891 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
892 numerically highest error produced by any phase that returned an error
893 indication.
894 @end table
896 If you only want some of the stages of compilation, you can use
897 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
898 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
899 @command{gcc} is to stop.  Note that some combinations (for example,
900 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
902 @table @gcctabopt
903 @item -c
904 @opindex c
905 Compile or assemble the source files, but do not link.  The linking
906 stage simply is not done.  The ultimate output is in the form of an
907 object file for each source file.
909 By default, the object file name for a source file is made by replacing
910 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
912 Unrecognized input files, not requiring compilation or assembly, are
913 ignored.
915 @item -S
916 @opindex S
917 Stop after the stage of compilation proper; do not assemble.  The output
918 is in the form of an assembler code file for each non-assembler input
919 file specified.
921 By default, the assembler file name for a source file is made by
922 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
924 Input files that don't require compilation are ignored.
926 @item -E
927 @opindex E
928 Stop after the preprocessing stage; do not run the compiler proper.  The
929 output is in the form of preprocessed source code, which is sent to the
930 standard output.
932 Input files which don't require preprocessing are ignored.
934 @cindex output file option
935 @item -o @var{file}
936 @opindex o
937 Place output in file @var{file}.  This applies regardless to whatever
938 sort of output is being produced, whether it be an executable file,
939 an object file, an assembler file or preprocessed C code.
941 If @option{-o} is not specified, the default is to put an executable
942 file in @file{a.out}, the object file for
943 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
944 assembler file in @file{@var{source}.s}, a precompiled header file in
945 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
946 standard output.
948 @item -v
949 @opindex v
950 Print (on standard error output) the commands executed to run the stages
951 of compilation.  Also print the version number of the compiler driver
952 program and of the preprocessor and the compiler proper.
954 @item -###
955 @opindex ###
956 Like @option{-v} except the commands are not executed and all command
957 arguments are quoted.  This is useful for shell scripts to capture the
958 driver-generated command lines.
960 @item -pipe
961 @opindex pipe
962 Use pipes rather than temporary files for communication between the
963 various stages of compilation.  This fails to work on some systems where
964 the assembler is unable to read from a pipe; but the GNU assembler has
965 no trouble.
967 @item -combine
968 @opindex combine
969 If you are compiling multiple source files, this option tells the driver
970 to pass all the source files to the compiler at once (for those
971 languages for which the compiler can handle this).  This will allow
972 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
973 language for which this is supported is C@.  If you pass source files for
974 multiple languages to the driver, using this option, the driver will invoke
975 the compiler(s) that support IMA once each, passing each compiler all the
976 source files appropriate for it.  For those languages that do not support
977 IMA this option will be ignored, and the compiler will be invoked once for
978 each source file in that language.  If you use this option in conjunction
979 with @option{-save-temps}, the compiler will generate multiple
980 pre-processed files
981 (one for each source file), but only one (combined) @file{.o} or
982 @file{.s} file.
984 @item --help
985 @opindex help
986 Print (on the standard output) a description of the command line options
987 understood by @command{gcc}.  If the @option{-v} option is also specified
988 then @option{--help} will also be passed on to the various processes
989 invoked by @command{gcc}, so that they can display the command line options
990 they accept.  If the @option{-Wextra} option is also specified then command
991 line options which have no documentation associated with them will also
992 be displayed.
994 @item --target-help
995 @opindex target-help
996 Print (on the standard output) a description of target specific command
997 line options for each tool.
999 @item --version
1000 @opindex version
1001 Display the version number and copyrights of the invoked GCC@.
1002 @end table
1004 @node Invoking G++
1005 @section Compiling C++ Programs
1007 @cindex suffixes for C++ source
1008 @cindex C++ source file suffixes
1009 C++ source files conventionally use one of the suffixes @samp{.C},
1010 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1011 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1012 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1013 files with these names and compiles them as C++ programs even if you
1014 call the compiler the same way as for compiling C programs (usually
1015 with the name @command{gcc}).
1017 @findex g++
1018 @findex c++
1019 However, C++ programs often require class libraries as well as a
1020 compiler that understands the C++ language---and under some
1021 circumstances, you might want to compile programs or header files from
1022 standard input, or otherwise without a suffix that flags them as C++
1023 programs.  You might also like to precompile a C header file with a
1024 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1025 program that calls GCC with the default language set to C++, and
1026 automatically specifies linking against the C++ library.  On many
1027 systems, @command{g++} is also installed with the name @command{c++}.
1029 @cindex invoking @command{g++}
1030 When you compile C++ programs, you may specify many of the same
1031 command-line options that you use for compiling programs in any
1032 language; or command-line options meaningful for C and related
1033 languages; or options that are meaningful only for C++ programs.
1034 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1035 explanations of options for languages related to C@.
1036 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1037 explanations of options that are meaningful only for C++ programs.
1039 @node C Dialect Options
1040 @section Options Controlling C Dialect
1041 @cindex dialect options
1042 @cindex language dialect options
1043 @cindex options, dialect
1045 The following options control the dialect of C (or languages derived
1046 from C, such as C++, Objective-C and Objective-C++) that the compiler
1047 accepts:
1049 @table @gcctabopt
1050 @cindex ANSI support
1051 @cindex ISO support
1052 @item -ansi
1053 @opindex ansi
1054 In C mode, support all ISO C90 programs.  In C++ mode,
1055 remove GNU extensions that conflict with ISO C++.
1057 This turns off certain features of GCC that are incompatible with ISO
1058 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1059 such as the @code{asm} and @code{typeof} keywords, and
1060 predefined macros such as @code{unix} and @code{vax} that identify the
1061 type of system you are using.  It also enables the undesirable and
1062 rarely used ISO trigraph feature.  For the C compiler,
1063 it disables recognition of C++ style @samp{//} comments as well as
1064 the @code{inline} keyword.
1066 The alternate keywords @code{__asm__}, @code{__extension__},
1067 @code{__inline__} and @code{__typeof__} continue to work despite
1068 @option{-ansi}.  You would not want to use them in an ISO C program, of
1069 course, but it is useful to put them in header files that might be included
1070 in compilations done with @option{-ansi}.  Alternate predefined macros
1071 such as @code{__unix__} and @code{__vax__} are also available, with or
1072 without @option{-ansi}.
1074 The @option{-ansi} option does not cause non-ISO programs to be
1075 rejected gratuitously.  For that, @option{-pedantic} is required in
1076 addition to @option{-ansi}.  @xref{Warning Options}.
1078 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1079 option is used.  Some header files may notice this macro and refrain
1080 from declaring certain functions or defining certain macros that the
1081 ISO standard doesn't call for; this is to avoid interfering with any
1082 programs that might use these names for other things.
1084 Functions which would normally be built in but do not have semantics
1085 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1086 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1087 built-in functions provided by GCC}, for details of the functions
1088 affected.
1090 @item -std=
1091 @opindex std
1092 Determine the language standard.  This option is currently only
1093 supported when compiling C or C++.  A value for this option must be
1094 provided; possible values are
1096 @table @samp
1097 @item c89
1098 @itemx iso9899:1990
1099 ISO C90 (same as @option{-ansi}).
1101 @item iso9899:199409
1102 ISO C90 as modified in amendment 1.
1104 @item c99
1105 @itemx c9x
1106 @itemx iso9899:1999
1107 @itemx iso9899:199x
1108 ISO C99.  Note that this standard is not yet fully supported; see
1109 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1110 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1112 @item gnu89
1113 Default, ISO C90 plus GNU extensions (including some C99 features).
1115 @item gnu99
1116 @itemx gnu9x
1117 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1118 this will become the default.  The name @samp{gnu9x} is deprecated.
1120 @item c++98
1121 The 1998 ISO C++ standard plus amendments.
1123 @item gnu++98
1124 The same as @option{-std=c++98} plus GNU extensions.  This is the
1125 default for C++ code.
1126 @end table
1128 Even when this option is not specified, you can still use some of the
1129 features of newer standards in so far as they do not conflict with
1130 previous C standards.  For example, you may use @code{__restrict__} even
1131 when @option{-std=c99} is not specified.
1133 The @option{-std} options specifying some version of ISO C have the same
1134 effects as @option{-ansi}, except that features that were not in ISO C90
1135 but are in the specified version (for example, @samp{//} comments and
1136 the @code{inline} keyword in ISO C99) are not disabled.
1138 @xref{Standards,,Language Standards Supported by GCC}, for details of
1139 these standard versions.
1141 @item -aux-info @var{filename}
1142 @opindex aux-info
1143 Output to the given filename prototyped declarations for all functions
1144 declared and/or defined in a translation unit, including those in header
1145 files.  This option is silently ignored in any language other than C@.
1147 Besides declarations, the file indicates, in comments, the origin of
1148 each declaration (source file and line), whether the declaration was
1149 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1150 @samp{O} for old, respectively, in the first character after the line
1151 number and the colon), and whether it came from a declaration or a
1152 definition (@samp{C} or @samp{F}, respectively, in the following
1153 character).  In the case of function definitions, a K&R-style list of
1154 arguments followed by their declarations is also provided, inside
1155 comments, after the declaration.
1157 @item -fno-asm
1158 @opindex fno-asm
1159 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1160 keyword, so that code can use these words as identifiers.  You can use
1161 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1162 instead.  @option{-ansi} implies @option{-fno-asm}.
1164 In C++, this switch only affects the @code{typeof} keyword, since
1165 @code{asm} and @code{inline} are standard keywords.  You may want to
1166 use the @option{-fno-gnu-keywords} flag instead, which has the same
1167 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1168 switch only affects the @code{asm} and @code{typeof} keywords, since
1169 @code{inline} is a standard keyword in ISO C99.
1171 @item -fno-builtin
1172 @itemx -fno-builtin-@var{function}
1173 @opindex fno-builtin
1174 @cindex built-in functions
1175 Don't recognize built-in functions that do not begin with
1176 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1177 functions provided by GCC}, for details of the functions affected,
1178 including those which are not built-in functions when @option{-ansi} or
1179 @option{-std} options for strict ISO C conformance are used because they
1180 do not have an ISO standard meaning.
1182 GCC normally generates special code to handle certain built-in functions
1183 more efficiently; for instance, calls to @code{alloca} may become single
1184 instructions that adjust the stack directly, and calls to @code{memcpy}
1185 may become inline copy loops.  The resulting code is often both smaller
1186 and faster, but since the function calls no longer appear as such, you
1187 cannot set a breakpoint on those calls, nor can you change the behavior
1188 of the functions by linking with a different library.  In addition,
1189 when a function is recognized as a built-in function, GCC may use
1190 information about that function to warn about problems with calls to
1191 that function, or to generate more efficient code, even if the
1192 resulting code still contains calls to that function.  For example,
1193 warnings are given with @option{-Wformat} for bad calls to
1194 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1195 known not to modify global memory.
1197 With the @option{-fno-builtin-@var{function}} option
1198 only the built-in function @var{function} is
1199 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1200 function is named this is not built-in in this version of GCC, this
1201 option is ignored.  There is no corresponding
1202 @option{-fbuiltin-@var{function}} option; if you wish to enable
1203 built-in functions selectively when using @option{-fno-builtin} or
1204 @option{-ffreestanding}, you may define macros such as:
1206 @smallexample
1207 #define abs(n)          __builtin_abs ((n))
1208 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1209 @end smallexample
1211 @item -fhosted
1212 @opindex fhosted
1213 @cindex hosted environment
1215 Assert that compilation takes place in a hosted environment.  This implies
1216 @option{-fbuiltin}.  A hosted environment is one in which the
1217 entire standard library is available, and in which @code{main} has a return
1218 type of @code{int}.  Examples are nearly everything except a kernel.
1219 This is equivalent to @option{-fno-freestanding}.
1221 @item -ffreestanding
1222 @opindex ffreestanding
1223 @cindex hosted environment
1225 Assert that compilation takes place in a freestanding environment.  This
1226 implies @option{-fno-builtin}.  A freestanding environment
1227 is one in which the standard library may not exist, and program startup may
1228 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1229 This is equivalent to @option{-fno-hosted}.
1231 @xref{Standards,,Language Standards Supported by GCC}, for details of
1232 freestanding and hosted environments.
1234 @item -fms-extensions
1235 @opindex fms-extensions
1236 Accept some non-standard constructs used in Microsoft header files.
1238 Some cases of unnamed fields in structures and unions are only
1239 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1240 fields within structs/unions}, for details.
1242 @item -trigraphs
1243 @opindex trigraphs
1244 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1245 options for strict ISO C conformance) implies @option{-trigraphs}.
1247 @item -no-integrated-cpp
1248 @opindex no-integrated-cpp
1249 Performs a compilation in two passes: preprocessing and compiling.  This
1250 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1251 @option{-B} option.  The user supplied compilation step can then add in
1252 an additional preprocessing step after normal preprocessing but before
1253 compiling.  The default is to use the integrated cpp (internal cpp)
1255 The semantics of this option will change if "cc1", "cc1plus", and
1256 "cc1obj" are merged.
1258 @cindex traditional C language
1259 @cindex C language, traditional
1260 @item -traditional
1261 @itemx -traditional-cpp
1262 @opindex traditional-cpp
1263 @opindex traditional
1264 Formerly, these options caused GCC to attempt to emulate a pre-standard
1265 C compiler.  They are now only supported with the @option{-E} switch.
1266 The preprocessor continues to support a pre-standard mode.  See the GNU
1267 CPP manual for details.
1269 @item -fcond-mismatch
1270 @opindex fcond-mismatch
1271 Allow conditional expressions with mismatched types in the second and
1272 third arguments.  The value of such an expression is void.  This option
1273 is not supported for C++.
1275 @item -funsigned-char
1276 @opindex funsigned-char
1277 Let the type @code{char} be unsigned, like @code{unsigned char}.
1279 Each kind of machine has a default for what @code{char} should
1280 be.  It is either like @code{unsigned char} by default or like
1281 @code{signed char} by default.
1283 Ideally, a portable program should always use @code{signed char} or
1284 @code{unsigned char} when it depends on the signedness of an object.
1285 But many programs have been written to use plain @code{char} and
1286 expect it to be signed, or expect it to be unsigned, depending on the
1287 machines they were written for.  This option, and its inverse, let you
1288 make such a program work with the opposite default.
1290 The type @code{char} is always a distinct type from each of
1291 @code{signed char} or @code{unsigned char}, even though its behavior
1292 is always just like one of those two.
1294 @item -fsigned-char
1295 @opindex fsigned-char
1296 Let the type @code{char} be signed, like @code{signed char}.
1298 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1299 the negative form of @option{-funsigned-char}.  Likewise, the option
1300 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1302 @item -fsigned-bitfields
1303 @itemx -funsigned-bitfields
1304 @itemx -fno-signed-bitfields
1305 @itemx -fno-unsigned-bitfields
1306 @opindex fsigned-bitfields
1307 @opindex funsigned-bitfields
1308 @opindex fno-signed-bitfields
1309 @opindex fno-unsigned-bitfields
1310 These options control whether a bit-field is signed or unsigned, when the
1311 declaration does not use either @code{signed} or @code{unsigned}.  By
1312 default, such a bit-field is signed, because this is consistent: the
1313 basic integer types such as @code{int} are signed types.
1314 @end table
1316 @node C++ Dialect Options
1317 @section Options Controlling C++ Dialect
1319 @cindex compiler options, C++
1320 @cindex C++ options, command line
1321 @cindex options, C++
1322 This section describes the command-line options that are only meaningful
1323 for C++ programs; but you can also use most of the GNU compiler options
1324 regardless of what language your program is in.  For example, you
1325 might compile a file @code{firstClass.C} like this:
1327 @smallexample
1328 g++ -g -frepo -O -c firstClass.C
1329 @end smallexample
1331 @noindent
1332 In this example, only @option{-frepo} is an option meant
1333 only for C++ programs; you can use the other options with any
1334 language supported by GCC@.
1336 Here is a list of options that are @emph{only} for compiling C++ programs:
1338 @table @gcctabopt
1340 @item -fabi-version=@var{n}
1341 @opindex fabi-version
1342 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1343 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1344 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1345 the version that conforms most closely to the C++ ABI specification.
1346 Therefore, the ABI obtained using version 0 will change as ABI bugs
1347 are fixed.
1349 The default is version 2.
1351 @item -fno-access-control
1352 @opindex fno-access-control
1353 Turn off all access checking.  This switch is mainly useful for working
1354 around bugs in the access control code.
1356 @item -fcheck-new
1357 @opindex fcheck-new
1358 Check that the pointer returned by @code{operator new} is non-null
1359 before attempting to modify the storage allocated.  This check is
1360 normally unnecessary because the C++ standard specifies that
1361 @code{operator new} will only return @code{0} if it is declared
1362 @samp{throw()}, in which case the compiler will always check the
1363 return value even without this option.  In all other cases, when
1364 @code{operator new} has a non-empty exception specification, memory
1365 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1366 @samp{new (nothrow)}.
1368 @item -fconserve-space
1369 @opindex fconserve-space
1370 Put uninitialized or runtime-initialized global variables into the
1371 common segment, as C does.  This saves space in the executable at the
1372 cost of not diagnosing duplicate definitions.  If you compile with this
1373 flag and your program mysteriously crashes after @code{main()} has
1374 completed, you may have an object that is being destroyed twice because
1375 two definitions were merged.
1377 This option is no longer useful on most targets, now that support has
1378 been added for putting variables into BSS without making them common.
1380 @item -fno-const-strings
1381 @opindex fno-const-strings
1382 Give string constants type @code{char *} instead of type @code{const
1383 char *}.  By default, G++ uses type @code{const char *} as required by
1384 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1385 actually modify the value of a string constant.
1387 This option might be removed in a future release of G++.  For maximum
1388 portability, you should structure your code so that it works with
1389 string constants that have type @code{const char *}.
1391 @item -fno-elide-constructors
1392 @opindex fno-elide-constructors
1393 The C++ standard allows an implementation to omit creating a temporary
1394 which is only used to initialize another object of the same type.
1395 Specifying this option disables that optimization, and forces G++ to
1396 call the copy constructor in all cases.
1398 @item -fno-enforce-eh-specs
1399 @opindex fno-enforce-eh-specs
1400 Don't check for violation of exception specifications at runtime.  This
1401 option violates the C++ standard, but may be useful for reducing code
1402 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1403 will still optimize based on the exception specifications.
1405 @item -ffor-scope
1406 @itemx -fno-for-scope
1407 @opindex ffor-scope
1408 @opindex fno-for-scope
1409 If @option{-ffor-scope} is specified, the scope of variables declared in
1410 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1411 as specified by the C++ standard.
1412 If @option{-fno-for-scope} is specified, the scope of variables declared in
1413 a @i{for-init-statement} extends to the end of the enclosing scope,
1414 as was the case in old versions of G++, and other (traditional)
1415 implementations of C++.
1417 The default if neither flag is given to follow the standard,
1418 but to allow and give a warning for old-style code that would
1419 otherwise be invalid, or have different behavior.
1421 @item -fno-gnu-keywords
1422 @opindex fno-gnu-keywords
1423 Do not recognize @code{typeof} as a keyword, so that code can use this
1424 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1425 @option{-ansi} implies @option{-fno-gnu-keywords}.
1427 @item -fno-implicit-templates
1428 @opindex fno-implicit-templates
1429 Never emit code for non-inline templates which are instantiated
1430 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1431 @xref{Template Instantiation}, for more information.
1433 @item -fno-implicit-inline-templates
1434 @opindex fno-implicit-inline-templates
1435 Don't emit code for implicit instantiations of inline templates, either.
1436 The default is to handle inlines differently so that compiles with and
1437 without optimization will need the same set of explicit instantiations.
1439 @item -fno-implement-inlines
1440 @opindex fno-implement-inlines
1441 To save space, do not emit out-of-line copies of inline functions
1442 controlled by @samp{#pragma implementation}.  This will cause linker
1443 errors if these functions are not inlined everywhere they are called.
1445 @item -fms-extensions
1446 @opindex fms-extensions
1447 Disable pedantic warnings about constructs used in MFC, such as implicit
1448 int and getting a pointer to member function via non-standard syntax.
1450 @item -fno-nonansi-builtins
1451 @opindex fno-nonansi-builtins
1452 Disable built-in declarations of functions that are not mandated by
1453 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1454 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1456 @item -fno-operator-names
1457 @opindex fno-operator-names
1458 Do not treat the operator name keywords @code{and}, @code{bitand},
1459 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1460 synonyms as keywords.
1462 @item -fno-optional-diags
1463 @opindex fno-optional-diags
1464 Disable diagnostics that the standard says a compiler does not need to
1465 issue.  Currently, the only such diagnostic issued by G++ is the one for
1466 a name having multiple meanings within a class.
1468 @item -fpermissive
1469 @opindex fpermissive
1470 Downgrade some diagnostics about nonconformant code from errors to
1471 warnings.  Thus, using @option{-fpermissive} will allow some
1472 nonconforming code to compile.
1474 @item -frepo
1475 @opindex frepo
1476 Enable automatic template instantiation at link time.  This option also
1477 implies @option{-fno-implicit-templates}.  @xref{Template
1478 Instantiation}, for more information.
1480 @item -fno-rtti
1481 @opindex fno-rtti
1482 Disable generation of information about every class with virtual
1483 functions for use by the C++ runtime type identification features
1484 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1485 of the language, you can save some space by using this flag.  Note that
1486 exception handling uses the same information, but it will generate it as
1487 needed.
1489 @item -fstats
1490 @opindex fstats
1491 Emit statistics about front-end processing at the end of the compilation.
1492 This information is generally only useful to the G++ development team.
1494 @item -ftemplate-depth-@var{n}
1495 @opindex ftemplate-depth
1496 Set the maximum instantiation depth for template classes to @var{n}.
1497 A limit on the template instantiation depth is needed to detect
1498 endless recursions during template class instantiation.  ANSI/ISO C++
1499 conforming programs must not rely on a maximum depth greater than 17.
1501 @item -fno-threadsafe-statics
1502 @opindex fno-threadsafe-statics
1503 Do not emit the extra code to use the routines specified in the C++
1504 ABI for thread-safe initialization of local statics.  You can use this
1505 option to reduce code size slightly in code that doesn't need to be
1506 thread-safe.
1508 @item -fuse-cxa-atexit
1509 @opindex fuse-cxa-atexit
1510 Register destructors for objects with static storage duration with the
1511 @code{__cxa_atexit} function rather than the @code{atexit} function.
1512 This option is required for fully standards-compliant handling of static
1513 destructors, but will only work if your C library supports
1514 @code{__cxa_atexit}.
1516 @item -fvisibility-inlines-hidden
1517 @opindex fvisibility-inlines-hidden
1518 Causes all inlined methods to be marked with
1519 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1520 appear in the export table of a DSO and do not require a PLT indirection
1521 when used within the DSO@.  Enabling this option can have a dramatic effect
1522 on load and link times of a DSO as it massively reduces the size of the
1523 dynamic export table when the library makes heavy use of templates.  While
1524 it can cause bloating through duplication of code within each DSO where
1525 it is used, often the wastage is less than the considerable space occupied
1526 by a long symbol name in the export table which is typical when using
1527 templates and namespaces.  For even more savings, combine with the
1528 @option{-fvisibility=hidden} switch.
1530 @item -fno-weak
1531 @opindex fno-weak
1532 Do not use weak symbol support, even if it is provided by the linker.
1533 By default, G++ will use weak symbols if they are available.  This
1534 option exists only for testing, and should not be used by end-users;
1535 it will result in inferior code and has no benefits.  This option may
1536 be removed in a future release of G++.
1538 @item -nostdinc++
1539 @opindex nostdinc++
1540 Do not search for header files in the standard directories specific to
1541 C++, but do still search the other standard directories.  (This option
1542 is used when building the C++ library.)
1543 @end table
1545 In addition, these optimization, warning, and code generation options
1546 have meanings only for C++ programs:
1548 @table @gcctabopt
1549 @item -fno-default-inline
1550 @opindex fno-default-inline
1551 Do not assume @samp{inline} for functions defined inside a class scope.
1552 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1553 functions will have linkage like inline functions; they just won't be
1554 inlined by default.
1556 @item -Wabi @r{(C++ only)}
1557 @opindex Wabi
1558 Warn when G++ generates code that is probably not compatible with the
1559 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1560 all such cases, there are probably some cases that are not warned about,
1561 even though G++ is generating incompatible code.  There may also be
1562 cases where warnings are emitted even though the code that is generated
1563 will be compatible.
1565 You should rewrite your code to avoid these warnings if you are
1566 concerned about the fact that code generated by G++ may not be binary
1567 compatible with code generated by other compilers.
1569 The known incompatibilities at this point include:
1571 @itemize @bullet
1573 @item
1574 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1575 pack data into the same byte as a base class.  For example:
1577 @smallexample
1578 struct A @{ virtual void f(); int f1 : 1; @};
1579 struct B : public A @{ int f2 : 1; @};
1580 @end smallexample
1582 @noindent
1583 In this case, G++ will place @code{B::f2} into the same byte
1584 as@code{A::f1}; other compilers will not.  You can avoid this problem
1585 by explicitly padding @code{A} so that its size is a multiple of the
1586 byte size on your platform; that will cause G++ and other compilers to
1587 layout @code{B} identically.
1589 @item
1590 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1591 tail padding when laying out virtual bases.  For example:
1593 @smallexample
1594 struct A @{ virtual void f(); char c1; @};
1595 struct B @{ B(); char c2; @};
1596 struct C : public A, public virtual B @{@};
1597 @end smallexample
1599 @noindent
1600 In this case, G++ will not place @code{B} into the tail-padding for
1601 @code{A}; other compilers will.  You can avoid this problem by
1602 explicitly padding @code{A} so that its size is a multiple of its
1603 alignment (ignoring virtual base classes); that will cause G++ and other
1604 compilers to layout @code{C} identically.
1606 @item
1607 Incorrect handling of bit-fields with declared widths greater than that
1608 of their underlying types, when the bit-fields appear in a union.  For
1609 example:
1611 @smallexample
1612 union U @{ int i : 4096; @};
1613 @end smallexample
1615 @noindent
1616 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1617 union too small by the number of bits in an @code{int}.
1619 @item
1620 Empty classes can be placed at incorrect offsets.  For example:
1622 @smallexample
1623 struct A @{@};
1625 struct B @{
1626   A a;
1627   virtual void f ();
1630 struct C : public B, public A @{@};
1631 @end smallexample
1633 @noindent
1634 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1635 it should be placed at offset zero.  G++ mistakenly believes that the
1636 @code{A} data member of @code{B} is already at offset zero.
1638 @item
1639 Names of template functions whose types involve @code{typename} or
1640 template template parameters can be mangled incorrectly.
1642 @smallexample
1643 template <typename Q>
1644 void f(typename Q::X) @{@}
1646 template <template <typename> class Q>
1647 void f(typename Q<int>::X) @{@}
1648 @end smallexample
1650 @noindent
1651 Instantiations of these templates may be mangled incorrectly.
1653 @end itemize
1655 @item -Wctor-dtor-privacy @r{(C++ only)}
1656 @opindex Wctor-dtor-privacy
1657 Warn when a class seems unusable because all the constructors or
1658 destructors in that class are private, and it has neither friends nor
1659 public static member functions.
1661 @item -Wnon-virtual-dtor @r{(C++ only)}
1662 @opindex Wnon-virtual-dtor
1663 Warn when a class appears to be polymorphic, thereby requiring a virtual
1664 destructor, yet it declares a non-virtual one.
1665 This warning is enabled by @option{-Wall}.
1667 @item -Wreorder @r{(C++ only)}
1668 @opindex Wreorder
1669 @cindex reordering, warning
1670 @cindex warning for reordering of member initializers
1671 Warn when the order of member initializers given in the code does not
1672 match the order in which they must be executed.  For instance:
1674 @smallexample
1675 struct A @{
1676   int i;
1677   int j;
1678   A(): j (0), i (1) @{ @}
1680 @end smallexample
1682 The compiler will rearrange the member initializers for @samp{i}
1683 and @samp{j} to match the declaration order of the members, emitting
1684 a warning to that effect.  This warning is enabled by @option{-Wall}.
1685 @end table
1687 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1689 @table @gcctabopt
1690 @item -Weffc++ @r{(C++ only)}
1691 @opindex Weffc++
1692 Warn about violations of the following style guidelines from Scott Meyers'
1693 @cite{Effective C++} book:
1695 @itemize @bullet
1696 @item
1697 Item 11:  Define a copy constructor and an assignment operator for classes
1698 with dynamically allocated memory.
1700 @item
1701 Item 12:  Prefer initialization to assignment in constructors.
1703 @item
1704 Item 14:  Make destructors virtual in base classes.
1706 @item
1707 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1709 @item
1710 Item 23:  Don't try to return a reference when you must return an object.
1712 @end itemize
1714 Also warn about violations of the following style guidelines from
1715 Scott Meyers' @cite{More Effective C++} book:
1717 @itemize @bullet
1718 @item
1719 Item 6:  Distinguish between prefix and postfix forms of increment and
1720 decrement operators.
1722 @item
1723 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1725 @end itemize
1727 When selecting this option, be aware that the standard library
1728 headers do not obey all of these guidelines; use @samp{grep -v}
1729 to filter out those warnings.
1731 @item -Wno-deprecated @r{(C++ only)}
1732 @opindex Wno-deprecated
1733 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1735 @item -Wno-non-template-friend @r{(C++ only)}
1736 @opindex Wno-non-template-friend
1737 Disable warnings when non-templatized friend functions are declared
1738 within a template.  Since the advent of explicit template specification
1739 support in G++, if the name of the friend is an unqualified-id (i.e.,
1740 @samp{friend foo(int)}), the C++ language specification demands that the
1741 friend declare or define an ordinary, nontemplate function.  (Section
1742 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1743 could be interpreted as a particular specialization of a templatized
1744 function.  Because this non-conforming behavior is no longer the default
1745 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1746 check existing code for potential trouble spots and is on by default.
1747 This new compiler behavior can be turned off with
1748 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1749 but disables the helpful warning.
1751 @item -Wold-style-cast @r{(C++ only)}
1752 @opindex Wold-style-cast
1753 Warn if an old-style (C-style) cast to a non-void type is used within
1754 a C++ program.  The new-style casts (@samp{static_cast},
1755 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1756 unintended effects and much easier to search for.
1758 @item -Woverloaded-virtual @r{(C++ only)}
1759 @opindex Woverloaded-virtual
1760 @cindex overloaded virtual fn, warning
1761 @cindex warning for overloaded virtual fn
1762 Warn when a function declaration hides virtual functions from a
1763 base class.  For example, in:
1765 @smallexample
1766 struct A @{
1767   virtual void f();
1770 struct B: public A @{
1771   void f(int);
1773 @end smallexample
1775 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1776 like:
1778 @smallexample
1779 B* b;
1780 b->f();
1781 @end smallexample
1783 will fail to compile.
1785 @item -Wno-pmf-conversions @r{(C++ only)}
1786 @opindex Wno-pmf-conversions
1787 Disable the diagnostic for converting a bound pointer to member function
1788 to a plain pointer.
1790 @item -Wsign-promo @r{(C++ only)}
1791 @opindex Wsign-promo
1792 Warn when overload resolution chooses a promotion from unsigned or
1793 enumerated type to a signed type, over a conversion to an unsigned type of
1794 the same size.  Previous versions of G++ would try to preserve
1795 unsignedness, but the standard mandates the current behavior.
1797 @smallexample
1798 struct A @{
1799   operator int ();
1800   A& operator = (int);
1803 main ()
1805   A a,b;
1806   a = b;
1808 @end smallexample
1810 In this example, G++ will synthesize a default @samp{A& operator =
1811 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1812 @end table
1814 @node Objective-C and Objective-C++ Dialect Options
1815 @section Options Controlling Objective-C and Objective-C++ Dialects
1817 @cindex compiler options, Objective-C and Objective-C++
1818 @cindex Objective-C and Objective-C++ options, command line
1819 @cindex options, Objective-C and Objective-C++
1820 (NOTE: This manual does not describe the Objective-C and Objective-C++
1821 languages themselves.  See @xref{Standards,,Language Standards
1822 Supported by GCC}, for references.)
1824 This section describes the command-line options that are only meaningful
1825 for Objective-C and Objective-C++ programs, but you can also use most of
1826 the language-independent GNU compiler options.
1827 For example, you might compile a file @code{some_class.m} like this:
1829 @smallexample
1830 gcc -g -fgnu-runtime -O -c some_class.m
1831 @end smallexample
1833 @noindent
1834 In this example, @option{-fgnu-runtime} is an option meant only for
1835 Objective-C and Objective-C++ programs; you can use the other options with
1836 any language supported by GCC@.
1838 Note that since Objective-C is an extension of the C language, Objective-C
1839 compilations may also use options specific to the C front-end (e.g.,
1840 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1841 C++-specific options (e.g., @option{-Wabi}).
1843 Here is a list of options that are @emph{only} for compiling Objective-C
1844 and Objective-C++ programs:
1846 @table @gcctabopt
1847 @item -fconstant-string-class=@var{class-name}
1848 @opindex fconstant-string-class
1849 Use @var{class-name} as the name of the class to instantiate for each
1850 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1851 class name is @code{NXConstantString} if the GNU runtime is being used, and
1852 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1853 @option{-fconstant-cfstrings} option, if also present, will override the
1854 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1855 to be laid out as constant CoreFoundation strings.
1857 @item -fgnu-runtime
1858 @opindex fgnu-runtime
1859 Generate object code compatible with the standard GNU Objective-C
1860 runtime.  This is the default for most types of systems.
1862 @item -fnext-runtime
1863 @opindex fnext-runtime
1864 Generate output compatible with the NeXT runtime.  This is the default
1865 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1866 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1867 used.
1869 @item -fno-nil-receivers
1870 @opindex fno-nil-receivers
1871 Assume that all Objective-C message dispatches (e.g.,
1872 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1873 is not @code{nil}.  This allows for more efficient entry points in the runtime
1874 to be used.  Currently, this option is only available in conjunction with
1875 the NeXT runtime on Mac OS X 10.3 and later.
1877 @item -fobjc-exceptions
1878 @opindex fobjc-exceptions
1879 Enable syntactic support for structured exception handling in Objective-C,
1880 similar to what is offered by C++ and Java.  Currently, this option is only
1881 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1883 @smallexample
1884   @@try @{
1885     @dots{}
1886        @@throw expr;
1887     @dots{}
1888   @}
1889   @@catch (AnObjCClass *exc) @{
1890     @dots{}
1891       @@throw expr;
1892     @dots{}
1893       @@throw;
1894     @dots{}
1895   @}
1896   @@catch (AnotherClass *exc) @{
1897     @dots{}
1898   @}
1899   @@catch (id allOthers) @{
1900     @dots{}
1901   @}
1902   @@finally @{
1903     @dots{}
1904       @@throw expr;
1905     @dots{}
1906   @}
1907 @end smallexample
1909 The @code{@@throw} statement may appear anywhere in an Objective-C or
1910 Objective-C++ program; when used inside of a @code{@@catch} block, the
1911 @code{@@throw} may appear without an argument (as shown above), in which case
1912 the object caught by the @code{@@catch} will be rethrown.
1914 Note that only (pointers to) Objective-C objects may be thrown and
1915 caught using this scheme.  When an object is thrown, it will be caught
1916 by the nearest @code{@@catch} clause capable of handling objects of that type,
1917 analogously to how @code{catch} blocks work in C++ and Java.  A
1918 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1919 any and all Objective-C exceptions not caught by previous @code{@@catch}
1920 clauses (if any).
1922 The @code{@@finally} clause, if present, will be executed upon exit from the
1923 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1924 regardless of whether any exceptions are thrown, caught or rethrown
1925 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1926 of the @code{finally} clause in Java.
1928 There are several caveats to using the new exception mechanism:
1930 @itemize @bullet
1931 @item
1932 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1933 idioms provided by the @code{NSException} class, the new
1934 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1935 systems, due to additional functionality needed in the (NeXT) Objective-C
1936 runtime.
1938 @item
1939 As mentioned above, the new exceptions do not support handling
1940 types other than Objective-C objects.   Furthermore, when used from
1941 Objective-C++, the Objective-C exception model does not interoperate with C++
1942 exceptions at this time.  This means you cannot @code{@@throw} an exception
1943 from Objective-C and @code{catch} it in C++, or vice versa
1944 (i.e., @code{throw @dots{} @@catch}).
1945 @end itemize
1947 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1948 blocks for thread-safe execution:
1950 @smallexample
1951   @@synchronized (ObjCClass *guard) @{
1952     @dots{}
1953   @}
1954 @end smallexample
1956 Upon entering the @code{@@synchronized} block, a thread of execution shall
1957 first check whether a lock has been placed on the corresponding @code{guard}
1958 object by another thread.  If it has, the current thread shall wait until
1959 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1960 the current thread will place its own lock on it, execute the code contained in
1961 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1962 making @code{guard} available to other threads).
1964 Unlike Java, Objective-C does not allow for entire methods to be marked
1965 @code{@@synchronized}.  Note that throwing exceptions out of
1966 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1967 to be unlocked properly.
1969 @item -freplace-objc-classes
1970 @opindex freplace-objc-classes
1971 Emit a special marker instructing @command{ld(1)} not to statically link in
1972 the resulting object file, and allow @command{dyld(1)} to load it in at
1973 run time instead.  This is used in conjunction with the Fix-and-Continue
1974 debugging mode, where the object file in question may be recompiled and
1975 dynamically reloaded in the course of program execution, without the need
1976 to restart the program itself.  Currently, Fix-and-Continue functionality
1977 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1978 and later.
1980 @item -fzero-link
1981 @opindex fzero-link
1982 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1983 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1984 compile time) with static class references that get initialized at load time,
1985 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1986 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1987 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1988 for individual class implementations to be modified during program execution.
1990 @item -gen-decls
1991 @opindex gen-decls
1992 Dump interface declarations for all classes seen in the source file to a
1993 file named @file{@var{sourcename}.decl}.
1995 @item -Wno-protocol
1996 @opindex Wno-protocol
1997 If a class is declared to implement a protocol, a warning is issued for
1998 every method in the protocol that is not implemented by the class.  The
1999 default behavior is to issue a warning for every method not explicitly
2000 implemented in the class, even if a method implementation is inherited
2001 from the superclass.  If you use the @option{-Wno-protocol} option, then
2002 methods inherited from the superclass are considered to be implemented,
2003 and no warning is issued for them.
2005 @item -Wselector
2006 @opindex Wselector
2007 Warn if multiple methods of different types for the same selector are
2008 found during compilation.  The check is performed on the list of methods
2009 in the final stage of compilation.  Additionally, a check is performed
2010 for each selector appearing in a @code{@@selector(@dots{})}
2011 expression, and a corresponding method for that selector has been found
2012 during compilation.  Because these checks scan the method table only at
2013 the end of compilation, these warnings are not produced if the final
2014 stage of compilation is not reached, for example because an error is
2015 found during compilation, or because the @option{-fsyntax-only} option is
2016 being used.
2018 @item -Wundeclared-selector
2019 @opindex Wundeclared-selector
2020 Warn if a @code{@@selector(@dots{})} expression referring to an
2021 undeclared selector is found.  A selector is considered undeclared if no
2022 method with that name has been declared before the
2023 @code{@@selector(@dots{})} expression, either explicitly in an
2024 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2025 an @code{@@implementation} section.  This option always performs its
2026 checks as soon as a @code{@@selector(@dots{})} expression is found,
2027 while @option{-Wselector} only performs its checks in the final stage of
2028 compilation.  This also enforces the coding style convention
2029 that methods and selectors must be declared before being used.
2031 @item -print-objc-runtime-info
2032 @opindex print-objc-runtime-info
2033 Generate C header describing the largest structure that is passed by
2034 value, if any.
2036 @end table
2038 @node Language Independent Options
2039 @section Options to Control Diagnostic Messages Formatting
2040 @cindex options to control diagnostics formatting
2041 @cindex diagnostic messages
2042 @cindex message formatting
2044 Traditionally, diagnostic messages have been formatted irrespective of
2045 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2046 below can be used to control the diagnostic messages formatting
2047 algorithm, e.g.@: how many characters per line, how often source location
2048 information should be reported.  Right now, only the C++ front end can
2049 honor these options.  However it is expected, in the near future, that
2050 the remaining front ends would be able to digest them correctly.
2052 @table @gcctabopt
2053 @item -fmessage-length=@var{n}
2054 @opindex fmessage-length
2055 Try to format error messages so that they fit on lines of about @var{n}
2056 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2057 the front ends supported by GCC@.  If @var{n} is zero, then no
2058 line-wrapping will be done; each error message will appear on a single
2059 line.
2061 @opindex fdiagnostics-show-location
2062 @item -fdiagnostics-show-location=once
2063 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2064 reporter to emit @emph{once} source location information; that is, in
2065 case the message is too long to fit on a single physical line and has to
2066 be wrapped, the source location won't be emitted (as prefix) again,
2067 over and over, in subsequent continuation lines.  This is the default
2068 behavior.
2070 @item -fdiagnostics-show-location=every-line
2071 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2072 messages reporter to emit the same source location information (as
2073 prefix) for physical lines that result from the process of breaking
2074 a message which is too long to fit on a single line.
2076 @end table
2078 @node Warning Options
2079 @section Options to Request or Suppress Warnings
2080 @cindex options to control warnings
2081 @cindex warning messages
2082 @cindex messages, warning
2083 @cindex suppressing warnings
2085 Warnings are diagnostic messages that report constructions which
2086 are not inherently erroneous but which are risky or suggest there
2087 may have been an error.
2089 You can request many specific warnings with options beginning @samp{-W},
2090 for example @option{-Wimplicit} to request warnings on implicit
2091 declarations.  Each of these specific warning options also has a
2092 negative form beginning @samp{-Wno-} to turn off warnings;
2093 for example, @option{-Wno-implicit}.  This manual lists only one of the
2094 two forms, whichever is not the default.
2096 The following options control the amount and kinds of warnings produced
2097 by GCC; for further, language-specific options also refer to
2098 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2099 Options}.
2101 @table @gcctabopt
2102 @cindex syntax checking
2103 @item -fsyntax-only
2104 @opindex fsyntax-only
2105 Check the code for syntax errors, but don't do anything beyond that.
2107 @item -pedantic
2108 @opindex pedantic
2109 Issue all the warnings demanded by strict ISO C and ISO C++;
2110 reject all programs that use forbidden extensions, and some other
2111 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2112 version of the ISO C standard specified by any @option{-std} option used.
2114 Valid ISO C and ISO C++ programs should compile properly with or without
2115 this option (though a rare few will require @option{-ansi} or a
2116 @option{-std} option specifying the required version of ISO C)@.  However,
2117 without this option, certain GNU extensions and traditional C and C++
2118 features are supported as well.  With this option, they are rejected.
2120 @option{-pedantic} does not cause warning messages for use of the
2121 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2122 warnings are also disabled in the expression that follows
2123 @code{__extension__}.  However, only system header files should use
2124 these escape routes; application programs should avoid them.
2125 @xref{Alternate Keywords}.
2127 Some users try to use @option{-pedantic} to check programs for strict ISO
2128 C conformance.  They soon find that it does not do quite what they want:
2129 it finds some non-ISO practices, but not all---only those for which
2130 ISO C @emph{requires} a diagnostic, and some others for which
2131 diagnostics have been added.
2133 A feature to report any failure to conform to ISO C might be useful in
2134 some instances, but would require considerable additional work and would
2135 be quite different from @option{-pedantic}.  We don't have plans to
2136 support such a feature in the near future.
2138 Where the standard specified with @option{-std} represents a GNU
2139 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2140 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2141 extended dialect is based.  Warnings from @option{-pedantic} are given
2142 where they are required by the base standard.  (It would not make sense
2143 for such warnings to be given only for features not in the specified GNU
2144 C dialect, since by definition the GNU dialects of C include all
2145 features the compiler supports with the given option, and there would be
2146 nothing to warn about.)
2148 @item -pedantic-errors
2149 @opindex pedantic-errors
2150 Like @option{-pedantic}, except that errors are produced rather than
2151 warnings.
2153 @item -w
2154 @opindex w
2155 Inhibit all warning messages.
2157 @item -Wno-import
2158 @opindex Wno-import
2159 Inhibit warning messages about the use of @samp{#import}.
2161 @item -Wchar-subscripts
2162 @opindex Wchar-subscripts
2163 Warn if an array subscript has type @code{char}.  This is a common cause
2164 of error, as programmers often forget that this type is signed on some
2165 machines.
2166 This warning is enabled by @option{-Wall}.
2168 @item -Wcomment
2169 @opindex Wcomment
2170 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2171 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2172 This warning is enabled by @option{-Wall}.
2174 @item -Wfatal-errors
2175 @opindex Wfatal-errors
2176 This option causes the compiler to abort compilation on the first error
2177 occurred rather than trying to keep going and printing further error
2178 messages.
2180 @item -Wformat
2181 @opindex Wformat
2182 @opindex ffreestanding
2183 @opindex fno-builtin
2184 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2185 the arguments supplied have types appropriate to the format string
2186 specified, and that the conversions specified in the format string make
2187 sense.  This includes standard functions, and others specified by format
2188 attributes (@pxref{Function Attributes}), in the @code{printf},
2189 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2190 not in the C standard) families (or other target-specific families).
2191 Which functions are checked without format attributes having been
2192 specified depends on the standard version selected, and such checks of
2193 functions without the attribute specified are disabled by
2194 @option{-ffreestanding} or @option{-fno-builtin}.
2196 The formats are checked against the format features supported by GNU
2197 libc version 2.2.  These include all ISO C90 and C99 features, as well
2198 as features from the Single Unix Specification and some BSD and GNU
2199 extensions.  Other library implementations may not support all these
2200 features; GCC does not support warning about features that go beyond a
2201 particular library's limitations.  However, if @option{-pedantic} is used
2202 with @option{-Wformat}, warnings will be given about format features not
2203 in the selected standard version (but not for @code{strfmon} formats,
2204 since those are not in any version of the C standard).  @xref{C Dialect
2205 Options,,Options Controlling C Dialect}.
2207 Since @option{-Wformat} also checks for null format arguments for
2208 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2210 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2211 aspects of format checking, the options @option{-Wformat-y2k},
2212 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2213 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2214 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2216 @item -Wformat-y2k
2217 @opindex Wformat-y2k
2218 If @option{-Wformat} is specified, also warn about @code{strftime}
2219 formats which may yield only a two-digit year.
2221 @item -Wno-format-extra-args
2222 @opindex Wno-format-extra-args
2223 If @option{-Wformat} is specified, do not warn about excess arguments to a
2224 @code{printf} or @code{scanf} format function.  The C standard specifies
2225 that such arguments are ignored.
2227 Where the unused arguments lie between used arguments that are
2228 specified with @samp{$} operand number specifications, normally
2229 warnings are still given, since the implementation could not know what
2230 type to pass to @code{va_arg} to skip the unused arguments.  However,
2231 in the case of @code{scanf} formats, this option will suppress the
2232 warning if the unused arguments are all pointers, since the Single
2233 Unix Specification says that such unused arguments are allowed.
2235 @item -Wno-format-zero-length
2236 @opindex Wno-format-zero-length
2237 If @option{-Wformat} is specified, do not warn about zero-length formats.
2238 The C standard specifies that zero-length formats are allowed.
2240 @item -Wformat-nonliteral
2241 @opindex Wformat-nonliteral
2242 If @option{-Wformat} is specified, also warn if the format string is not a
2243 string literal and so cannot be checked, unless the format function
2244 takes its format arguments as a @code{va_list}.
2246 @item -Wformat-security
2247 @opindex Wformat-security
2248 If @option{-Wformat} is specified, also warn about uses of format
2249 functions that represent possible security problems.  At present, this
2250 warns about calls to @code{printf} and @code{scanf} functions where the
2251 format string is not a string literal and there are no format arguments,
2252 as in @code{printf (foo);}.  This may be a security hole if the format
2253 string came from untrusted input and contains @samp{%n}.  (This is
2254 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2255 in future warnings may be added to @option{-Wformat-security} that are not
2256 included in @option{-Wformat-nonliteral}.)
2258 @item -Wformat=2
2259 @opindex Wformat=2
2260 Enable @option{-Wformat} plus format checks not included in
2261 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2262 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2264 @item -Wnonnull
2265 @opindex Wnonnull
2266 Warn about passing a null pointer for arguments marked as
2267 requiring a non-null value by the @code{nonnull} function attribute.
2269 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2270 can be disabled with the @option{-Wno-nonnull} option.
2272 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2273 @opindex Winit-self
2274 Warn about uninitialized variables which are initialized with themselves.
2275 Note this option can only be used with the @option{-Wuninitialized} option,
2276 which in turn only works with @option{-O1} and above.
2278 For example, GCC will warn about @code{i} being uninitialized in the
2279 following snippet only when @option{-Winit-self} has been specified:
2280 @smallexample
2281 @group
2282 int f()
2284   int i = i;
2285   return i;
2287 @end group
2288 @end smallexample
2290 @item -Wimplicit-int
2291 @opindex Wimplicit-int
2292 Warn when a declaration does not specify a type.
2293 This warning is enabled by @option{-Wall}.
2295 @item -Wimplicit-function-declaration
2296 @itemx -Werror-implicit-function-declaration
2297 @opindex Wimplicit-function-declaration
2298 @opindex Werror-implicit-function-declaration
2299 Give a warning (or error) whenever a function is used before being
2300 declared.  The form @option{-Wno-error-implicit-function-declaration}
2301 is not supported.
2302 This warning is enabled by @option{-Wall} (as a warning, not an error).
2304 @item -Wimplicit
2305 @opindex Wimplicit
2306 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2307 This warning is enabled by @option{-Wall}.
2309 @item -Wmain
2310 @opindex Wmain
2311 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2312 function with external linkage, returning int, taking either zero
2313 arguments, two, or three arguments of appropriate types.
2314 This warning is enabled by @option{-Wall}.
2316 @item -Wmissing-braces
2317 @opindex Wmissing-braces
2318 Warn if an aggregate or union initializer is not fully bracketed.  In
2319 the following example, the initializer for @samp{a} is not fully
2320 bracketed, but that for @samp{b} is fully bracketed.
2322 @smallexample
2323 int a[2][2] = @{ 0, 1, 2, 3 @};
2324 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2325 @end smallexample
2327 This warning is enabled by @option{-Wall}.
2329 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2330 @opindex Wmissing-include-dirs
2331 Warn if a user-supplied include directory does not exist.
2333 @item -Wparentheses
2334 @opindex Wparentheses
2335 Warn if parentheses are omitted in certain contexts, such
2336 as when there is an assignment in a context where a truth value
2337 is expected, or when operators are nested whose precedence people
2338 often get confused about.  Only the warning for an assignment used as
2339 a truth value is supported when compiling C++; the other warnings are
2340 only supported when compiling C@.
2342 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2343 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2344 interpretation from that of ordinary mathematical notation.
2346 Also warn about constructions where there may be confusion to which
2347 @code{if} statement an @code{else} branch belongs.  Here is an example of
2348 such a case:
2350 @smallexample
2351 @group
2353   if (a)
2354     if (b)
2355       foo ();
2356   else
2357     bar ();
2359 @end group
2360 @end smallexample
2362 In C, every @code{else} branch belongs to the innermost possible @code{if}
2363 statement, which in this example is @code{if (b)}.  This is often not
2364 what the programmer expected, as illustrated in the above example by
2365 indentation the programmer chose.  When there is the potential for this
2366 confusion, GCC will issue a warning when this flag is specified.
2367 To eliminate the warning, add explicit braces around the innermost
2368 @code{if} statement so there is no way the @code{else} could belong to
2369 the enclosing @code{if}.  The resulting code would look like this:
2371 @smallexample
2372 @group
2374   if (a)
2375     @{
2376       if (b)
2377         foo ();
2378       else
2379         bar ();
2380     @}
2382 @end group
2383 @end smallexample
2385 This warning is enabled by @option{-Wall}.
2387 @item -Wsequence-point
2388 @opindex Wsequence-point
2389 Warn about code that may have undefined semantics because of violations
2390 of sequence point rules in the C standard.
2392 The C standard defines the order in which expressions in a C program are
2393 evaluated in terms of @dfn{sequence points}, which represent a partial
2394 ordering between the execution of parts of the program: those executed
2395 before the sequence point, and those executed after it.  These occur
2396 after the evaluation of a full expression (one which is not part of a
2397 larger expression), after the evaluation of the first operand of a
2398 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2399 function is called (but after the evaluation of its arguments and the
2400 expression denoting the called function), and in certain other places.
2401 Other than as expressed by the sequence point rules, the order of
2402 evaluation of subexpressions of an expression is not specified.  All
2403 these rules describe only a partial order rather than a total order,
2404 since, for example, if two functions are called within one expression
2405 with no sequence point between them, the order in which the functions
2406 are called is not specified.  However, the standards committee have
2407 ruled that function calls do not overlap.
2409 It is not specified when between sequence points modifications to the
2410 values of objects take effect.  Programs whose behavior depends on this
2411 have undefined behavior; the C standard specifies that ``Between the
2412 previous and next sequence point an object shall have its stored value
2413 modified at most once by the evaluation of an expression.  Furthermore,
2414 the prior value shall be read only to determine the value to be
2415 stored.''.  If a program breaks these rules, the results on any
2416 particular implementation are entirely unpredictable.
2418 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2419 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2420 diagnosed by this option, and it may give an occasional false positive
2421 result, but in general it has been found fairly effective at detecting
2422 this sort of problem in programs.
2424 The present implementation of this option only works for C programs.  A
2425 future implementation may also work for C++ programs.
2427 The C standard is worded confusingly, therefore there is some debate
2428 over the precise meaning of the sequence point rules in subtle cases.
2429 Links to discussions of the problem, including proposed formal
2430 definitions, may be found on the GCC readings page, at
2431 @w{@uref{http://gcc.gnu.org/readings.html}}.
2433 This warning is enabled by @option{-Wall}.
2435 @item -Wreturn-type
2436 @opindex Wreturn-type
2437 Warn whenever a function is defined with a return-type that defaults to
2438 @code{int}.  Also warn about any @code{return} statement with no
2439 return-value in a function whose return-type is not @code{void}.
2441 For C, also warn if the return type of a function has a type qualifier
2442 such as @code{const}.  Such a type qualifier has no effect, since the
2443 value returned by a function is not an lvalue.  ISO C prohibits
2444 qualified @code{void} return types on function definitions, so such
2445 return types always receive a warning even without this option.
2447 For C++, a function without return type always produces a diagnostic
2448 message, even when @option{-Wno-return-type} is specified.  The only
2449 exceptions are @samp{main} and functions defined in system headers.
2451 This warning is enabled by @option{-Wall}.
2453 @item -Wswitch
2454 @opindex Wswitch
2455 Warn whenever a @code{switch} statement has an index of enumerated type
2456 and lacks a @code{case} for one or more of the named codes of that
2457 enumeration.  (The presence of a @code{default} label prevents this
2458 warning.)  @code{case} labels outside the enumeration range also
2459 provoke warnings when this option is used.
2460 This warning is enabled by @option{-Wall}.
2462 @item -Wswitch-default
2463 @opindex Wswitch-switch
2464 Warn whenever a @code{switch} statement does not have a @code{default}
2465 case.
2467 @item -Wswitch-enum
2468 @opindex Wswitch-enum
2469 Warn whenever a @code{switch} statement has an index of enumerated type
2470 and lacks a @code{case} for one or more of the named codes of that
2471 enumeration.  @code{case} labels outside the enumeration range also
2472 provoke warnings when this option is used.
2474 @item -Wtrigraphs
2475 @opindex Wtrigraphs
2476 Warn if any trigraphs are encountered that might change the meaning of
2477 the program (trigraphs within comments are not warned about).
2478 This warning is enabled by @option{-Wall}.
2480 @item -Wunused-function
2481 @opindex Wunused-function
2482 Warn whenever a static function is declared but not defined or a
2483 non\-inline static function is unused.
2484 This warning is enabled by @option{-Wall}.
2486 @item -Wunused-label
2487 @opindex Wunused-label
2488 Warn whenever a label is declared but not used.
2489 This warning is enabled by @option{-Wall}.
2491 To suppress this warning use the @samp{unused} attribute
2492 (@pxref{Variable Attributes}).
2494 @item -Wunused-parameter
2495 @opindex Wunused-parameter
2496 Warn whenever a function parameter is unused aside from its declaration.
2498 To suppress this warning use the @samp{unused} attribute
2499 (@pxref{Variable Attributes}).
2501 @item -Wunused-variable
2502 @opindex Wunused-variable
2503 Warn whenever a local variable or non-constant static variable is unused
2504 aside from its declaration
2505 This warning is enabled by @option{-Wall}.
2507 To suppress this warning use the @samp{unused} attribute
2508 (@pxref{Variable Attributes}).
2510 @item -Wunused-value
2511 @opindex Wunused-value
2512 Warn whenever a statement computes a result that is explicitly not used.
2513 This warning is enabled by @option{-Wall}.
2515 To suppress this warning cast the expression to @samp{void}.
2517 @item -Wunused
2518 @opindex Wunused
2519 All the above @option{-Wunused} options combined.
2521 In order to get a warning about an unused function parameter, you must
2522 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2523 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2525 @item -Wuninitialized
2526 @opindex Wuninitialized
2527 Warn if an automatic variable is used without first being initialized or
2528 if a variable may be clobbered by a @code{setjmp} call.
2530 These warnings are possible only in optimizing compilation,
2531 because they require data flow information that is computed only
2532 when optimizing.  If you don't specify @option{-O}, you simply won't
2533 get these warnings.
2535 If you want to warn about code which uses the uninitialized value of the
2536 variable in its own initializer, use the @option{-Winit-self} option.
2538 These warnings occur only for variables that are candidates for
2539 register allocation.  Therefore, they do not occur for a variable that
2540 is declared @code{volatile}, or whose address is taken, or whose size
2541 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2542 structures, unions or arrays, even when they are in registers.
2544 Note that there may be no warning about a variable that is used only
2545 to compute a value that itself is never used, because such
2546 computations may be deleted by data flow analysis before the warnings
2547 are printed.
2549 These warnings are made optional because GCC is not smart
2550 enough to see all the reasons why the code might be correct
2551 despite appearing to have an error.  Here is one example of how
2552 this can happen:
2554 @smallexample
2555 @group
2557   int x;
2558   switch (y)
2559     @{
2560     case 1: x = 1;
2561       break;
2562     case 2: x = 4;
2563       break;
2564     case 3: x = 5;
2565     @}
2566   foo (x);
2568 @end group
2569 @end smallexample
2571 @noindent
2572 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2573 always initialized, but GCC doesn't know this.  Here is
2574 another common case:
2576 @smallexample
2578   int save_y;
2579   if (change_y) save_y = y, y = new_y;
2580   @dots{}
2581   if (change_y) y = save_y;
2583 @end smallexample
2585 @noindent
2586 This has no bug because @code{save_y} is used only if it is set.
2588 @cindex @code{longjmp} warnings
2589 This option also warns when a non-volatile automatic variable might be
2590 changed by a call to @code{longjmp}.  These warnings as well are possible
2591 only in optimizing compilation.
2593 The compiler sees only the calls to @code{setjmp}.  It cannot know
2594 where @code{longjmp} will be called; in fact, a signal handler could
2595 call it at any point in the code.  As a result, you may get a warning
2596 even when there is in fact no problem because @code{longjmp} cannot
2597 in fact be called at the place which would cause a problem.
2599 Some spurious warnings can be avoided if you declare all the functions
2600 you use that never return as @code{noreturn}.  @xref{Function
2601 Attributes}.
2603 This warning is enabled by @option{-Wall}.
2605 @item -Wunknown-pragmas
2606 @opindex Wunknown-pragmas
2607 @cindex warning for unknown pragmas
2608 @cindex unknown pragmas, warning
2609 @cindex pragmas, warning of unknown
2610 Warn when a #pragma directive is encountered which is not understood by
2611 GCC@.  If this command line option is used, warnings will even be issued
2612 for unknown pragmas in system header files.  This is not the case if
2613 the warnings were only enabled by the @option{-Wall} command line option.
2615 @item -Wstrict-aliasing
2616 @opindex Wstrict-aliasing
2617 This option is only active when @option{-fstrict-aliasing} is active.
2618 It warns about code which might break the strict aliasing rules that the
2619 compiler is using for optimization.  The warning does not catch all
2620 cases, but does attempt to catch the more common pitfalls.  It is
2621 included in @option{-Wall}.
2623 @item -Wstrict-aliasing=2
2624 @opindex Wstrict-aliasing=2
2625 This option is only active when @option{-fstrict-aliasing} is active.
2626 It warns about all code which might break the strict aliasing rules that the
2627 compiler is using for optimization.  This warning catches all cases, but
2628 it will also give a warning for some ambiguous cases that are safe.
2630 @item -Wall
2631 @opindex Wall
2632 All of the above @samp{-W} options combined.  This enables all the
2633 warnings about constructions that some users consider questionable, and
2634 that are easy to avoid (or modify to prevent the warning), even in
2635 conjunction with macros.  This also enables some language-specific
2636 warnings described in @ref{C++ Dialect Options} and
2637 @ref{Objective-C and Objective-C++ Dialect Options}.
2638 @end table
2640 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2641 Some of them warn about constructions that users generally do not
2642 consider questionable, but which occasionally you might wish to check
2643 for; others warn about constructions that are necessary or hard to avoid
2644 in some cases, and there is no simple way to modify the code to suppress
2645 the warning.
2647 @table @gcctabopt
2648 @item -Wextra
2649 @opindex W
2650 @opindex Wextra
2651 (This option used to be called @option{-W}.  The older name is still
2652 supported, but the newer name is more descriptive.)  Print extra warning
2653 messages for these events:
2655 @itemize @bullet
2656 @item
2657 A function can return either with or without a value.  (Falling
2658 off the end of the function body is considered returning without
2659 a value.)  For example, this function would evoke such a
2660 warning:
2662 @smallexample
2663 @group
2664 foo (a)
2666   if (a > 0)
2667     return a;
2669 @end group
2670 @end smallexample
2672 @item
2673 An expression-statement or the left-hand side of a comma expression
2674 contains no side effects.
2675 To suppress the warning, cast the unused expression to void.
2676 For example, an expression such as @samp{x[i,j]} will cause a warning,
2677 but @samp{x[(void)i,j]} will not.
2679 @item
2680 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2682 @item
2683 Storage-class specifiers like @code{static} are not the first things in
2684 a declaration.  According to the C Standard, this usage is obsolescent.
2686 @item
2687 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2688 arguments.
2690 @item
2691 A comparison between signed and unsigned values could produce an
2692 incorrect result when the signed value is converted to unsigned.
2693 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2695 @item
2696 An aggregate has an initializer which does not initialize all members.
2697 This warning can be independently controlled by
2698 @option{-Wmissing-field-initializers}.
2700 @item
2701 A function parameter is declared without a type specifier in K&R-style
2702 functions:
2704 @smallexample
2705 void foo(bar) @{ @}
2706 @end smallexample
2708 @item
2709 An empty body occurs in an @samp{if} or @samp{else} statement.
2711 @item
2712 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2713 @samp{>}, or @samp{>=}.
2715 @item
2716 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2718 @item
2719 Any of several floating-point events that often indicate errors, such as
2720 overflow, underflow, loss of precision, etc.
2722 @item @r{(C++ only)}
2723 An enumerator and a non-enumerator both appear in a conditional expression.
2725 @item @r{(C++ only)}
2726 A non-static reference or non-static @samp{const} member appears in a
2727 class without constructors.
2729 @item @r{(C++ only)}
2730 Ambiguous virtual bases.
2732 @item @r{(C++ only)}
2733 Subscripting an array which has been declared @samp{register}.
2735 @item @r{(C++ only)}
2736 Taking the address of a variable which has been declared @samp{register}.
2738 @item @r{(C++ only)}
2739 A base class is not initialized in a derived class' copy constructor.
2740 @end itemize
2742 @item -Wno-div-by-zero
2743 @opindex Wno-div-by-zero
2744 @opindex Wdiv-by-zero
2745 Do not warn about compile-time integer division by zero.  Floating point
2746 division by zero is not warned about, as it can be a legitimate way of
2747 obtaining infinities and NaNs.
2749 @item -Wsystem-headers
2750 @opindex Wsystem-headers
2751 @cindex warnings from system headers
2752 @cindex system headers, warnings from
2753 Print warning messages for constructs found in system header files.
2754 Warnings from system headers are normally suppressed, on the assumption
2755 that they usually do not indicate real problems and would only make the
2756 compiler output harder to read.  Using this command line option tells
2757 GCC to emit warnings from system headers as if they occurred in user
2758 code.  However, note that using @option{-Wall} in conjunction with this
2759 option will @emph{not} warn about unknown pragmas in system
2760 headers---for that, @option{-Wunknown-pragmas} must also be used.
2762 @item -Wfloat-equal
2763 @opindex Wfloat-equal
2764 Warn if floating point values are used in equality comparisons.
2766 The idea behind this is that sometimes it is convenient (for the
2767 programmer) to consider floating-point values as approximations to
2768 infinitely precise real numbers.  If you are doing this, then you need
2769 to compute (by analyzing the code, or in some other way) the maximum or
2770 likely maximum error that the computation introduces, and allow for it
2771 when performing comparisons (and when producing output, but that's a
2772 different problem).  In particular, instead of testing for equality, you
2773 would check to see whether the two values have ranges that overlap; and
2774 this is done with the relational operators, so equality comparisons are
2775 probably mistaken.
2777 @item -Wtraditional @r{(C only)}
2778 @opindex Wtraditional
2779 Warn about certain constructs that behave differently in traditional and
2780 ISO C@.  Also warn about ISO C constructs that have no traditional C
2781 equivalent, and/or problematic constructs which should be avoided.
2783 @itemize @bullet
2784 @item
2785 Macro parameters that appear within string literals in the macro body.
2786 In traditional C macro replacement takes place within string literals,
2787 but does not in ISO C@.
2789 @item
2790 In traditional C, some preprocessor directives did not exist.
2791 Traditional preprocessors would only consider a line to be a directive
2792 if the @samp{#} appeared in column 1 on the line.  Therefore
2793 @option{-Wtraditional} warns about directives that traditional C
2794 understands but would ignore because the @samp{#} does not appear as the
2795 first character on the line.  It also suggests you hide directives like
2796 @samp{#pragma} not understood by traditional C by indenting them.  Some
2797 traditional implementations would not recognize @samp{#elif}, so it
2798 suggests avoiding it altogether.
2800 @item
2801 A function-like macro that appears without arguments.
2803 @item
2804 The unary plus operator.
2806 @item
2807 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2808 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2809 constants.)  Note, these suffixes appear in macros defined in the system
2810 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2811 Use of these macros in user code might normally lead to spurious
2812 warnings, however GCC's integrated preprocessor has enough context to
2813 avoid warning in these cases.
2815 @item
2816 A function declared external in one block and then used after the end of
2817 the block.
2819 @item
2820 A @code{switch} statement has an operand of type @code{long}.
2822 @item
2823 A non-@code{static} function declaration follows a @code{static} one.
2824 This construct is not accepted by some traditional C compilers.
2826 @item
2827 The ISO type of an integer constant has a different width or
2828 signedness from its traditional type.  This warning is only issued if
2829 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2830 typically represent bit patterns, are not warned about.
2832 @item
2833 Usage of ISO string concatenation is detected.
2835 @item
2836 Initialization of automatic aggregates.
2838 @item
2839 Identifier conflicts with labels.  Traditional C lacks a separate
2840 namespace for labels.
2842 @item
2843 Initialization of unions.  If the initializer is zero, the warning is
2844 omitted.  This is done under the assumption that the zero initializer in
2845 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2846 initializer warnings and relies on default initialization to zero in the
2847 traditional C case.
2849 @item
2850 Conversions by prototypes between fixed/floating point values and vice
2851 versa.  The absence of these prototypes when compiling with traditional
2852 C would cause serious problems.  This is a subset of the possible
2853 conversion warnings, for the full set use @option{-Wconversion}.
2855 @item
2856 Use of ISO C style function definitions.  This warning intentionally is
2857 @emph{not} issued for prototype declarations or variadic functions
2858 because these ISO C features will appear in your code when using
2859 libiberty's traditional C compatibility macros, @code{PARAMS} and
2860 @code{VPARAMS}.  This warning is also bypassed for nested functions
2861 because that feature is already a GCC extension and thus not relevant to
2862 traditional C compatibility.
2863 @end itemize
2865 @item -Wdeclaration-after-statement @r{(C only)}
2866 @opindex Wdeclaration-after-statement
2867 Warn when a declaration is found after a statement in a block.  This
2868 construct, known from C++, was introduced with ISO C99 and is by default
2869 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2870 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2872 @item -Wundef
2873 @opindex Wundef
2874 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2876 @item -Wno-endif-labels
2877 @opindex Wno-endif-labels
2878 @opindex Wendif-labels
2879 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2881 @item -Wshadow
2882 @opindex Wshadow
2883 Warn whenever a local variable shadows another local variable, parameter or
2884 global variable or whenever a built-in function is shadowed.
2886 @item -Wlarger-than-@var{len}
2887 @opindex Wlarger-than
2888 Warn whenever an object of larger than @var{len} bytes is defined.
2890 @item -Wpointer-arith
2891 @opindex Wpointer-arith
2892 Warn about anything that depends on the ``size of'' a function type or
2893 of @code{void}.  GNU C assigns these types a size of 1, for
2894 convenience in calculations with @code{void *} pointers and pointers
2895 to functions.
2897 @item -Wbad-function-cast @r{(C only)}
2898 @opindex Wbad-function-cast
2899 Warn whenever a function call is cast to a non-matching type.
2900 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2902 @item -Wcast-qual
2903 @opindex Wcast-qual
2904 Warn whenever a pointer is cast so as to remove a type qualifier from
2905 the target type.  For example, warn if a @code{const char *} is cast
2906 to an ordinary @code{char *}.
2908 @item -Wcast-align
2909 @opindex Wcast-align
2910 Warn whenever a pointer is cast such that the required alignment of the
2911 target is increased.  For example, warn if a @code{char *} is cast to
2912 an @code{int *} on machines where integers can only be accessed at
2913 two- or four-byte boundaries.
2915 @item -Wwrite-strings
2916 @opindex Wwrite-strings
2917 When compiling C, give string constants the type @code{const
2918 char[@var{length}]} so that
2919 copying the address of one into a non-@code{const} @code{char *}
2920 pointer will get a warning; when compiling C++, warn about the
2921 deprecated conversion from string constants to @code{char *}.
2922 These warnings will help you find at
2923 compile time code that can try to write into a string constant, but
2924 only if you have been very careful about using @code{const} in
2925 declarations and prototypes.  Otherwise, it will just be a nuisance;
2926 this is why we did not make @option{-Wall} request these warnings.
2928 @item -Wconversion
2929 @opindex Wconversion
2930 Warn if a prototype causes a type conversion that is different from what
2931 would happen to the same argument in the absence of a prototype.  This
2932 includes conversions of fixed point to floating and vice versa, and
2933 conversions changing the width or signedness of a fixed point argument
2934 except when the same as the default promotion.
2936 Also, warn if a negative integer constant expression is implicitly
2937 converted to an unsigned type.  For example, warn about the assignment
2938 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2939 casts like @code{(unsigned) -1}.
2941 @item -Wsign-compare
2942 @opindex Wsign-compare
2943 @cindex warning for comparison of signed and unsigned values
2944 @cindex comparison of signed and unsigned values, warning
2945 @cindex signed and unsigned values, comparison warning
2946 Warn when a comparison between signed and unsigned values could produce
2947 an incorrect result when the signed value is converted to unsigned.
2948 This warning is also enabled by @option{-Wextra}; to get the other warnings
2949 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2951 @item -Waggregate-return
2952 @opindex Waggregate-return
2953 Warn if any functions that return structures or unions are defined or
2954 called.  (In languages where you can return an array, this also elicits
2955 a warning.)
2957 @item -Wstrict-prototypes @r{(C only)}
2958 @opindex Wstrict-prototypes
2959 Warn if a function is declared or defined without specifying the
2960 argument types.  (An old-style function definition is permitted without
2961 a warning if preceded by a declaration which specifies the argument
2962 types.)
2964 @item -Wold-style-definition @r{(C only)}
2965 @opindex Wold-style-definition
2966 Warn if an old-style function definition is used.  A warning is given
2967 even if there is a previous prototype.
2969 @item -Wmissing-prototypes @r{(C only)}
2970 @opindex Wmissing-prototypes
2971 Warn if a global function is defined without a previous prototype
2972 declaration.  This warning is issued even if the definition itself
2973 provides a prototype.  The aim is to detect global functions that fail
2974 to be declared in header files.
2976 @item -Wmissing-declarations @r{(C only)}
2977 @opindex Wmissing-declarations
2978 Warn if a global function is defined without a previous declaration.
2979 Do so even if the definition itself provides a prototype.
2980 Use this option to detect global functions that are not declared in
2981 header files.
2983 @item -Wmissing-field-initializers
2984 @opindex Wmissing-field-initializers
2985 @opindex W
2986 @opindex Wextra
2987 Warn if a structure's initializer has some fields missing.  For
2988 example, the following code would cause such a warning, because
2989 @code{x.h} is implicitly zero:
2991 @smallexample
2992 struct s @{ int f, g, h; @};
2993 struct s x = @{ 3, 4 @};
2994 @end smallexample
2996 This option does not warn about designated initializers, so the following
2997 modification would not trigger a warning:
2999 @smallexample
3000 struct s @{ int f, g, h; @};
3001 struct s x = @{ .f = 3, .g = 4 @};
3002 @end smallexample
3004 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3005 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3007 @item -Wmissing-noreturn
3008 @opindex Wmissing-noreturn
3009 Warn about functions which might be candidates for attribute @code{noreturn}.
3010 Note these are only possible candidates, not absolute ones.  Care should
3011 be taken to manually verify functions actually do not ever return before
3012 adding the @code{noreturn} attribute, otherwise subtle code generation
3013 bugs could be introduced.  You will not get a warning for @code{main} in
3014 hosted C environments.
3016 @item -Wmissing-format-attribute
3017 @opindex Wmissing-format-attribute
3018 @opindex Wformat
3019 If @option{-Wformat} is enabled, also warn about functions which might be
3020 candidates for @code{format} attributes.  Note these are only possible
3021 candidates, not absolute ones.  GCC will guess that @code{format}
3022 attributes might be appropriate for any function that calls a function
3023 like @code{vprintf} or @code{vscanf}, but this might not always be the
3024 case, and some functions for which @code{format} attributes are
3025 appropriate may not be detected.  This option has no effect unless
3026 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3028 @item -Wno-multichar
3029 @opindex Wno-multichar
3030 @opindex Wmultichar
3031 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3032 Usually they indicate a typo in the user's code, as they have
3033 implementation-defined values, and should not be used in portable code.
3035 @item -Wnormalized=<none|id|nfc|nfkc>
3036 @opindex Wnormalized
3037 @cindex NFC
3038 @cindex NFKC
3039 @cindex character set, input normalization
3040 In ISO C and ISO C++, two identifiers are different if they are
3041 different sequences of characters.  However, sometimes when characters
3042 outside the basic ASCII character set are used, you can have two
3043 different character sequences that look the same.  To avoid confusion,
3044 the ISO 10646 standard sets out some @dfn{normalization rules} which
3045 when applied ensure that two sequences that look the same are turned into
3046 the same sequence.  GCC can warn you if you are using identifiers which
3047 have not been normalized; this option controls that warning.
3049 There are four levels of warning that GCC supports.  The default is
3050 @option{-Wnormalized=nfc}, which warns about any identifier which is
3051 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
3052 recommended form for most uses.
3054 Unfortunately, there are some characters which ISO C and ISO C++ allow
3055 in identifiers that when turned into NFC aren't allowable as
3056 identifiers.  That is, there's no way to use these symbols in portable
3057 ISO C or C++ and have all your identifiers in NFC.
3058 @option{-Wnormalized=id} suppresses the warning for these characters.
3059 It is hoped that future versions of the standards involved will correct
3060 this, which is why this option is not the default.
3062 You can switch the warning off for all characters by writing
3063 @option{-Wnormalized=none}.  You would only want to do this if you
3064 were using some other normalization scheme (like ``D''), because
3065 otherwise you can easily create bugs that are literally impossible to see.
3067 Some characters in ISO 10646 have distinct meanings but look identical
3068 in some fonts or display methodologies, especially once formatting has
3069 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3070 LETTER N'', will display just like a regular @code{n} which has been
3071 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
3072 normalisation scheme to convert all these into a standard form as
3073 well, and GCC will warn if your code is not in NFKC if you use
3074 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
3075 about every identifier that contains the letter O because it might be
3076 confused with the digit 0, and so is not the default, but may be
3077 useful as a local coding convention if the programming environment is
3078 unable to be fixed to display these characters distinctly.
3080 @item -Wno-deprecated-declarations
3081 @opindex Wno-deprecated-declarations
3082 Do not warn about uses of functions, variables, and types marked as
3083 deprecated by using the @code{deprecated} attribute.
3084 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3085 @pxref{Type Attributes}.)
3087 @item -Wpacked
3088 @opindex Wpacked
3089 Warn if a structure is given the packed attribute, but the packed
3090 attribute has no effect on the layout or size of the structure.
3091 Such structures may be mis-aligned for little benefit.  For
3092 instance, in this code, the variable @code{f.x} in @code{struct bar}
3093 will be misaligned even though @code{struct bar} does not itself
3094 have the packed attribute:
3096 @smallexample
3097 @group
3098 struct foo @{
3099   int x;
3100   char a, b, c, d;
3101 @} __attribute__((packed));
3102 struct bar @{
3103   char z;
3104   struct foo f;
3106 @end group
3107 @end smallexample
3109 @item -Wpadded
3110 @opindex Wpadded
3111 Warn if padding is included in a structure, either to align an element
3112 of the structure or to align the whole structure.  Sometimes when this
3113 happens it is possible to rearrange the fields of the structure to
3114 reduce the padding and so make the structure smaller.
3116 @item -Wredundant-decls
3117 @opindex Wredundant-decls
3118 Warn if anything is declared more than once in the same scope, even in
3119 cases where multiple declaration is valid and changes nothing.
3121 @item -Wnested-externs @r{(C only)}
3122 @opindex Wnested-externs
3123 Warn if an @code{extern} declaration is encountered within a function.
3125 @item -Wunreachable-code
3126 @opindex Wunreachable-code
3127 Warn if the compiler detects that code will never be executed.
3129 This option is intended to warn when the compiler detects that at
3130 least a whole line of source code will never be executed, because
3131 some condition is never satisfied or because it is after a
3132 procedure that never returns.
3134 It is possible for this option to produce a warning even though there
3135 are circumstances under which part of the affected line can be executed,
3136 so care should be taken when removing apparently-unreachable code.
3138 For instance, when a function is inlined, a warning may mean that the
3139 line is unreachable in only one inlined copy of the function.
3141 This option is not made part of @option{-Wall} because in a debugging
3142 version of a program there is often substantial code which checks
3143 correct functioning of the program and is, hopefully, unreachable
3144 because the program does work.  Another common use of unreachable
3145 code is to provide behavior which is selectable at compile-time.
3147 @item -Winline
3148 @opindex Winline
3149 Warn if a function can not be inlined and it was declared as inline.
3150 Even with this option, the compiler will not warn about failures to
3151 inline functions declared in system headers.
3153 The compiler uses a variety of heuristics to determine whether or not
3154 to inline a function.  For example, the compiler takes into account
3155 the size of the function being inlined and the the amount of inlining
3156 that has already been done in the current function.  Therefore,
3157 seemingly insignificant changes in the source program can cause the
3158 warnings produced by @option{-Winline} to appear or disappear.
3160 @item -Wno-invalid-offsetof @r{(C++ only)}
3161 @opindex Wno-invalid-offsetof
3162 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3163 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3164 to a non-POD type is undefined.  In existing C++ implementations,
3165 however, @samp{offsetof} typically gives meaningful results even when
3166 applied to certain kinds of non-POD types. (Such as a simple
3167 @samp{struct} that fails to be a POD type only by virtue of having a
3168 constructor.)  This flag is for users who are aware that they are
3169 writing nonportable code and who have deliberately chosen to ignore the
3170 warning about it.
3172 The restrictions on @samp{offsetof} may be relaxed in a future version
3173 of the C++ standard.
3175 @item -Winvalid-pch
3176 @opindex Winvalid-pch
3177 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3178 the search path but can't be used.
3180 @item -Wlong-long
3181 @opindex Wlong-long
3182 @opindex Wno-long-long
3183 Warn if @samp{long long} type is used.  This is default.  To inhibit
3184 the warning messages, use @option{-Wno-long-long}.  Flags
3185 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3186 only when @option{-pedantic} flag is used.
3188 @item -Wvariadic-macros
3189 @opindex Wvariadic-macros
3190 @opindex Wno-variadic-macros
3191 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3192 alternate syntax when in pedantic ISO C99 mode.  This is default.
3193 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3195 @item -Wdisabled-optimization
3196 @opindex Wdisabled-optimization
3197 Warn if a requested optimization pass is disabled.  This warning does
3198 not generally indicate that there is anything wrong with your code; it
3199 merely indicates that GCC's optimizers were unable to handle the code
3200 effectively.  Often, the problem is that your code is too big or too
3201 complex; GCC will refuse to optimize programs when the optimization
3202 itself is likely to take inordinate amounts of time.
3204 @item -Wno-pointer-sign
3205 @opindex Wno-pointer-sign
3206 Don't warn for pointer argument passing or assignment with different signedness.
3207 Only useful in the negative form since this warning is enabled by default.
3208 This option is only supported for C and Objective-C@.
3210 @item -Werror
3211 @opindex Werror
3212 Make all warnings into errors.
3213 @end table
3215 @node Debugging Options
3216 @section Options for Debugging Your Program or GCC
3217 @cindex options, debugging
3218 @cindex debugging information options
3220 GCC has various special options that are used for debugging
3221 either your program or GCC:
3223 @table @gcctabopt
3224 @item -g
3225 @opindex g
3226 Produce debugging information in the operating system's native format
3227 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3228 information.
3230 On most systems that use stabs format, @option{-g} enables use of extra
3231 debugging information that only GDB can use; this extra information
3232 makes debugging work better in GDB but will probably make other debuggers
3233 crash or
3234 refuse to read the program.  If you want to control for certain whether
3235 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3236 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3238 GCC allows you to use @option{-g} with
3239 @option{-O}.  The shortcuts taken by optimized code may occasionally
3240 produce surprising results: some variables you declared may not exist
3241 at all; flow of control may briefly move where you did not expect it;
3242 some statements may not be executed because they compute constant
3243 results or their values were already at hand; some statements may
3244 execute in different places because they were moved out of loops.
3246 Nevertheless it proves possible to debug optimized output.  This makes
3247 it reasonable to use the optimizer for programs that might have bugs.
3249 The following options are useful when GCC is generated with the
3250 capability for more than one debugging format.
3252 @item -ggdb
3253 @opindex ggdb
3254 Produce debugging information for use by GDB@.  This means to use the
3255 most expressive format available (DWARF 2, stabs, or the native format
3256 if neither of those are supported), including GDB extensions if at all
3257 possible.
3259 @item -gstabs
3260 @opindex gstabs
3261 Produce debugging information in stabs format (if that is supported),
3262 without GDB extensions.  This is the format used by DBX on most BSD
3263 systems.  On MIPS, Alpha and System V Release 4 systems this option
3264 produces stabs debugging output which is not understood by DBX or SDB@.
3265 On System V Release 4 systems this option requires the GNU assembler.
3267 @item -feliminate-unused-debug-symbols
3268 @opindex feliminate-unused-debug-symbols
3269 Produce debugging information in stabs format (if that is supported),
3270 for only symbols that are actually used.
3272 @item -gstabs+
3273 @opindex gstabs+
3274 Produce debugging information in stabs format (if that is supported),
3275 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3276 use of these extensions is likely to make other debuggers crash or
3277 refuse to read the program.
3279 @item -gcoff
3280 @opindex gcoff
3281 Produce debugging information in COFF format (if that is supported).
3282 This is the format used by SDB on most System V systems prior to
3283 System V Release 4.
3285 @item -gxcoff
3286 @opindex gxcoff
3287 Produce debugging information in XCOFF format (if that is supported).
3288 This is the format used by the DBX debugger on IBM RS/6000 systems.
3290 @item -gxcoff+
3291 @opindex gxcoff+
3292 Produce debugging information in XCOFF format (if that is supported),
3293 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3294 use of these extensions is likely to make other debuggers crash or
3295 refuse to read the program, and may cause assemblers other than the GNU
3296 assembler (GAS) to fail with an error.
3298 @item -gdwarf-2
3299 @opindex gdwarf-2
3300 Produce debugging information in DWARF version 2 format (if that is
3301 supported).  This is the format used by DBX on IRIX 6.  With this
3302 option, GCC uses features of DWARF version 3 when they are useful;
3303 version 3 is upward compatible with version 2, but may still cause
3304 problems for older debuggers.
3306 @item -gvms
3307 @opindex gvms
3308 Produce debugging information in VMS debug format (if that is
3309 supported).  This is the format used by DEBUG on VMS systems.
3311 @item -g@var{level}
3312 @itemx -ggdb@var{level}
3313 @itemx -gstabs@var{level}
3314 @itemx -gcoff@var{level}
3315 @itemx -gxcoff@var{level}
3316 @itemx -gvms@var{level}
3317 Request debugging information and also use @var{level} to specify how
3318 much information.  The default level is 2.
3320 Level 1 produces minimal information, enough for making backtraces in
3321 parts of the program that you don't plan to debug.  This includes
3322 descriptions of functions and external variables, but no information
3323 about local variables and no line numbers.
3325 Level 3 includes extra information, such as all the macro definitions
3326 present in the program.  Some debuggers support macro expansion when
3327 you use @option{-g3}.
3329 @option{-gdwarf-2} does not accept a concatenated debug level, because
3330 GCC used to support an option @option{-gdwarf} that meant to generate
3331 debug information in version 1 of the DWARF format (which is very
3332 different from version 2), and it would have been too confusing.  That
3333 debug format is long obsolete, but the option cannot be changed now.
3334 Instead use an additional @option{-g@var{level}} option to change the
3335 debug level for DWARF2.
3337 @item -feliminate-dwarf2-dups
3338 @opindex feliminate-dwarf2-dups
3339 Compress DWARF2 debugging information by eliminating duplicated
3340 information about each symbol.  This option only makes sense when
3341 generating DWARF2 debugging information with @option{-gdwarf-2}.
3343 @cindex @command{prof}
3344 @item -p
3345 @opindex p
3346 Generate extra code to write profile information suitable for the
3347 analysis program @command{prof}.  You must use this option when compiling
3348 the source files you want data about, and you must also use it when
3349 linking.
3351 @cindex @command{gprof}
3352 @item -pg
3353 @opindex pg
3354 Generate extra code to write profile information suitable for the
3355 analysis program @command{gprof}.  You must use this option when compiling
3356 the source files you want data about, and you must also use it when
3357 linking.
3359 @item -Q
3360 @opindex Q
3361 Makes the compiler print out each function name as it is compiled, and
3362 print some statistics about each pass when it finishes.
3364 @item -ftime-report
3365 @opindex ftime-report
3366 Makes the compiler print some statistics about the time consumed by each
3367 pass when it finishes.
3369 @item -fmem-report
3370 @opindex fmem-report
3371 Makes the compiler print some statistics about permanent memory
3372 allocation when it finishes.
3374 @item -fprofile-arcs
3375 @opindex fprofile-arcs
3376 Add code so that program flow @dfn{arcs} are instrumented.  During
3377 execution the program records how many times each branch and call is
3378 executed and how many times it is taken or returns.  When the compiled
3379 program exits it saves this data to a file called
3380 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3381 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3382 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3383 @var{auxname} is generated from the name of the output file, if
3384 explicitly specified and it is not the final executable, otherwise it is
3385 the basename of the source file.  In both cases any suffix is removed
3386 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3387 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3389 @cindex @command{gcov}
3390 @item --coverage
3391 @opindex coverage
3393 This option is used to compile and link code instrumented for coverage
3394 analysis.  The option is a synonym for @option{-fprofile-arcs}
3395 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3396 linking).  See the documentation for those options for more details.
3398 @itemize
3400 @item
3401 Compile the source files with @option{-fprofile-arcs} plus optimization
3402 and code generation options.  For test coverage analysis, use the
3403 additional @option{-ftest-coverage} option.  You do not need to profile
3404 every source file in a program.
3406 @item
3407 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3408 (the latter implies the former).
3410 @item
3411 Run the program on a representative workload to generate the arc profile
3412 information.  This may be repeated any number of times.  You can run
3413 concurrent instances of your program, and provided that the file system
3414 supports locking, the data files will be correctly updated.  Also
3415 @code{fork} calls are detected and correctly handled (double counting
3416 will not happen).
3418 @item
3419 For profile-directed optimizations, compile the source files again with
3420 the same optimization and code generation options plus
3421 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3422 Control Optimization}).
3424 @item
3425 For test coverage analysis, use @command{gcov} to produce human readable
3426 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3427 @command{gcov} documentation for further information.
3429 @end itemize
3431 With @option{-fprofile-arcs}, for each function of your program GCC
3432 creates a program flow graph, then finds a spanning tree for the graph.
3433 Only arcs that are not on the spanning tree have to be instrumented: the
3434 compiler adds code to count the number of times that these arcs are
3435 executed.  When an arc is the only exit or only entrance to a block, the
3436 instrumentation code can be added to the block; otherwise, a new basic
3437 block must be created to hold the instrumentation code.
3439 @item -ftree-based-profiling
3440 @opindex ftree-based-profiling
3441 This option is used in addition to @option{-fprofile-arcs} or
3442 @option{-fbranch-probabilities} to control whether those optimizations
3443 are performed on a tree-based or rtl-based internal representation.
3444 If you use this option when compiling with @option{-fprofile-arcs},
3445 you must also use it when compiling later with @option{-fbranch-probabilities}.
3446 Currently the tree-based optimization is in an early stage of
3447 development, and this option is recommended only for those people
3448 working on improving it.
3450 @need 2000
3451 @item -ftest-coverage
3452 @opindex ftest-coverage
3453 Produce a notes file that the @command{gcov} code-coverage utility
3454 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3455 show program coverage.  Each source file's note file is called
3456 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3457 above for a description of @var{auxname} and instructions on how to
3458 generate test coverage data.  Coverage data will match the source files
3459 more closely, if you do not optimize.
3461 @item -d@var{letters}
3462 @item -fdump-rtl-@var{pass}
3463 @opindex d
3464 Says to make debugging dumps during compilation at times specified by
3465 @var{letters}.    This is used for debugging the RTL-based passes of the
3466 compiler.  The file names for most of the dumps are made by appending a
3467 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3468 from the name of the output file, if explicitly specified and it is not
3469 an executable, otherwise it is the basename of the source file.
3471 Most debug dumps can be enabled either passing a letter to the @option{-d}
3472 option, or with a long @option{-fdump-rtl} switch; here are the possible
3473 letters for use in @var{letters} and @var{pass}, and their meanings:
3475 @table @gcctabopt
3476 @item -dA
3477 @opindex dA
3478 Annotate the assembler output with miscellaneous debugging information.
3480 @item -db
3481 @itemx -fdump-rtl-bp
3482 @opindex db
3483 @opindex fdump-rtl-bp
3484 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3486 @item -dB
3487 @itemx -fdump-rtl-bbro
3488 @opindex dB
3489 @opindex fdump-rtl-bbro
3490 Dump after block reordering, to @file{@var{file}.30.bbro}.
3492 @item -dc
3493 @itemx -fdump-rtl-combine
3494 @opindex dc
3495 @opindex fdump-rtl-combine
3496 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3498 @item -dC
3499 @itemx -fdump-rtl-ce1
3500 @itemx -fdump-rtl-ce2
3501 @opindex dC
3502 @opindex fdump-rtl-ce1
3503 @opindex fdump-rtl-ce2
3504 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3505 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3506 and @option{-fdump-rtl-ce2} enable dumping after the second if
3507 conversion, to the file @file{@var{file}.18.ce2}.
3509 @item -dd
3510 @itemx -fdump-rtl-btl
3511 @itemx -fdump-rtl-dbr
3512 @opindex dd
3513 @opindex fdump-rtl-btl
3514 @opindex fdump-rtl-dbr
3515 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3516 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3517 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3518 scheduling, to @file{@var{file}.36.dbr}.
3520 @item -dD
3521 @opindex dD
3522 Dump all macro definitions, at the end of preprocessing, in addition to
3523 normal output.
3525 @item -dE
3526 @itemx -fdump-rtl-ce3
3527 @opindex dE
3528 @opindex fdump-rtl-ce3
3529 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3531 @item -df
3532 @itemx -fdump-rtl-cfg
3533 @itemx -fdump-rtl-life
3534 @opindex df
3535 @opindex fdump-rtl-cfg
3536 @opindex fdump-rtl-life
3537 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3538 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3539 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3540 to @file{@var{file}.16.life}.
3542 @item -dg
3543 @itemx -fdump-rtl-greg
3544 @opindex dg
3545 @opindex fdump-rtl-greg
3546 Dump after global register allocation, to @file{@var{file}.23.greg}.
3548 @item -dG
3549 @itemx -fdump-rtl-gcse
3550 @itemx -fdump-rtl-bypass
3551 @opindex dG
3552 @opindex fdump-rtl-gcse
3553 @opindex fdump-rtl-bypass
3554 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3555 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3556 enable dumping after jump bypassing and control flow optimizations, to
3557 @file{@var{file}.07.bypass}.
3559 @item -dh
3560 @itemx -fdump-rtl-eh
3561 @opindex dh
3562 @opindex fdump-rtl-eh
3563 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3565 @item -di
3566 @itemx -fdump-rtl-sibling
3567 @opindex di
3568 @opindex fdump-rtl-sibling
3569 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3571 @item -dj
3572 @itemx -fdump-rtl-jump
3573 @opindex dj
3574 @opindex fdump-rtl-jump
3575 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3577 @item -dk
3578 @itemx -fdump-rtl-stack
3579 @opindex dk
3580 @opindex fdump-rtl-stack
3581 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3583 @item -dl
3584 @itemx -fdump-rtl-lreg
3585 @opindex dl
3586 @opindex fdump-rtl-lreg
3587 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3589 @item -dL
3590 @itemx -fdump-rtl-loop
3591 @itemx -fdump-rtl-loop2
3592 @opindex dL
3593 @opindex fdump-rtl-loop
3594 @opindex fdump-rtl-loop2
3595 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3596 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3597 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3598 @file{@var{file}.13.loop2}.
3600 @item -dm
3601 @itemx -fdump-rtl-sms
3602 @opindex dm
3603 @opindex fdump-rtl-sms
3604 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3606 @item -dM
3607 @itemx -fdump-rtl-mach
3608 @opindex dM
3609 @opindex fdump-rtl-mach
3610 Dump after performing the machine dependent reorganization pass, to
3611 @file{@var{file}.35.mach}.
3613 @item -dn
3614 @itemx -fdump-rtl-rnreg
3615 @opindex dn
3616 @opindex fdump-rtl-rnreg
3617 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3619 @item -dN
3620 @itemx -fdump-rtl-regmove
3621 @opindex dN
3622 @opindex fdump-rtl-regmove
3623 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3625 @item -do
3626 @itemx -fdump-rtl-postreload
3627 @opindex do
3628 @opindex fdump-rtl-postreload
3629 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3631 @item -dr
3632 @itemx -fdump-rtl-expand
3633 @opindex dr
3634 @opindex fdump-rtl-expand
3635 Dump after RTL generation, to @file{@var{file}.00.expand}.
3637 @item -dR
3638 @itemx -fdump-rtl-sched2
3639 @opindex dR
3640 @opindex fdump-rtl-sched2
3641 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3643 @item -ds
3644 @itemx -fdump-rtl-cse
3645 @opindex ds
3646 @opindex fdump-rtl-cse
3647 Dump after CSE (including the jump optimization that sometimes follows
3648 CSE), to @file{@var{file}.04.cse}.
3650 @item -dS
3651 @itemx -fdump-rtl-sched
3652 @opindex dS
3653 @opindex fdump-rtl-sched
3654 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3656 @item -dt
3657 @itemx -fdump-rtl-cse2
3658 @opindex dt
3659 @opindex fdump-rtl-cse2
3660 Dump after the second CSE pass (including the jump optimization that
3661 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3663 @item -dT
3664 @itemx -fdump-rtl-tracer
3665 @opindex dT
3666 @opindex fdump-rtl-tracer
3667 Dump after running tracer, to @file{@var{file}.12.tracer}.
3669 @item -dV
3670 @itemx -fdump-rtl-vpt
3671 @itemx -fdump-rtl-vartrack
3672 @opindex dV
3673 @opindex fdump-rtl-vpt
3674 @opindex fdump-rtl-vartrack
3675 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3676 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3677 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3678 to @file{@var{file}.34.vartrack}.
3680 @item -dw
3681 @itemx -fdump-rtl-flow2
3682 @opindex dw
3683 @opindex fdump-rtl-flow2
3684 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3686 @item -dz
3687 @itemx -fdump-rtl-peephole2
3688 @opindex dz
3689 @opindex fdump-rtl-peephole2
3690 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3692 @item -dZ
3693 @itemx -fdump-rtl-web
3694 @opindex dZ
3695 @opindex fdump-rtl-web
3696 Dump after live range splitting, to @file{@var{file}.14.web}.
3698 @item -da
3699 @itemx -fdump-rtl-all
3700 @opindex da
3701 @opindex fdump-rtl-all
3702 Produce all the dumps listed above.
3704 @item -dH
3705 @opindex dH
3706 Produce a core dump whenever an error occurs.
3708 @item -dm
3709 @opindex dm
3710 Print statistics on memory usage, at the end of the run, to
3711 standard error.
3713 @item -dp
3714 @opindex dp
3715 Annotate the assembler output with a comment indicating which
3716 pattern and alternative was used.  The length of each instruction is
3717 also printed.
3719 @item -dP
3720 @opindex dP
3721 Dump the RTL in the assembler output as a comment before each instruction.
3722 Also turns on @option{-dp} annotation.
3724 @item -dv
3725 @opindex dv
3726 For each of the other indicated dump files (either with @option{-d} or
3727 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3728 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3730 @item -dx
3731 @opindex dx
3732 Just generate RTL for a function instead of compiling it.  Usually used
3733 with @samp{r} (@option{-fdump-rtl-expand}).
3735 @item -dy
3736 @opindex dy
3737 Dump debugging information during parsing, to standard error.
3738 @end table
3740 @item -fdump-unnumbered
3741 @opindex fdump-unnumbered
3742 When doing debugging dumps (see @option{-d} option above), suppress instruction
3743 numbers and line number note output.  This makes it more feasible to
3744 use diff on debugging dumps for compiler invocations with different
3745 options, in particular with and without @option{-g}.
3747 @item -fdump-translation-unit @r{(C and C++ only)}
3748 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3749 @opindex fdump-translation-unit
3750 Dump a representation of the tree structure for the entire translation
3751 unit to a file.  The file name is made by appending @file{.tu} to the
3752 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3753 controls the details of the dump as described for the
3754 @option{-fdump-tree} options.
3756 @item -fdump-class-hierarchy @r{(C++ only)}
3757 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3758 @opindex fdump-class-hierarchy
3759 Dump a representation of each class's hierarchy and virtual function
3760 table layout to a file.  The file name is made by appending @file{.class}
3761 to the source file name.  If the @samp{-@var{options}} form is used,
3762 @var{options} controls the details of the dump as described for the
3763 @option{-fdump-tree} options.
3765 @item -fdump-ipa-@var{switch}
3766 @opindex fdump-ipa
3767 Control the dumping at various stages of inter-procedural analysis
3768 language tree to a file.  The file name is generated by appending a switch
3769 specific suffix to the source file name.  The following dumps are possible:
3771 @table @samp
3772 @item all
3773 Enables all inter-procedural analysis dumps; currently the only produced
3774 dump is the @samp{cgraph} dump.
3776 @item cgraph
3777 Dumps information about call-graph optimization, unused function removal,
3778 and inlining decisions.
3779 @end table
3781 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3782 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3783 @opindex fdump-tree
3784 Control the dumping at various stages of processing the intermediate
3785 language tree to a file.  The file name is generated by appending a switch
3786 specific suffix to the source file name.  If the @samp{-@var{options}}
3787 form is used, @var{options} is a list of @samp{-} separated options that
3788 control the details of the dump.  Not all options are applicable to all
3789 dumps, those which are not meaningful will be ignored.  The following
3790 options are available
3792 @table @samp
3793 @item address
3794 Print the address of each node.  Usually this is not meaningful as it
3795 changes according to the environment and source file.  Its primary use
3796 is for tying up a dump file with a debug environment.
3797 @item slim
3798 Inhibit dumping of members of a scope or body of a function merely
3799 because that scope has been reached.  Only dump such items when they
3800 are directly reachable by some other path.  When dumping pretty-printed
3801 trees, this option inhibits dumping the bodies of control structures.
3802 @item raw
3803 Print a raw representation of the tree.  By default, trees are
3804 pretty-printed into a C-like representation.
3805 @item details
3806 Enable more detailed dumps (not honored by every dump option).
3807 @item stats
3808 Enable dumping various statistics about the pass (not honored by every dump
3809 option).
3810 @item blocks
3811 Enable showing basic block boundaries (disabled in raw dumps).
3812 @item vops
3813 Enable showing virtual operands for every statement.
3814 @item lineno
3815 Enable showing line numbers for statements.
3816 @item uid
3817 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3818 @item all
3819 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3820 @end table
3822 The following tree dumps are possible:
3823 @table @samp
3825 @item original
3826 Dump before any tree based optimization, to @file{@var{file}.original}.
3828 @item optimized
3829 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3831 @item inlined
3832 Dump after function inlining, to @file{@var{file}.inlined}.
3834 @item gimple
3835 @opindex fdump-tree-gimple
3836 Dump each function before and after the gimplification pass to a file.  The
3837 file name is made by appending @file{.gimple} to the source file name.
3839 @item cfg
3840 @opindex fdump-tree-cfg
3841 Dump the control flow graph of each function to a file.  The file name is
3842 made by appending @file{.cfg} to the source file name.
3844 @item vcg
3845 @opindex fdump-tree-vcg
3846 Dump the control flow graph of each function to a file in VCG format.  The
3847 file name is made by appending @file{.vcg} to the source file name.  Note
3848 that if the file contains more than one function, the generated file cannot
3849 be used directly by VCG@.  You will need to cut and paste each function's
3850 graph into its own separate file first.
3852 @item ch
3853 @opindex fdump-tree-ch
3854 Dump each function after copying loop headers.  The file name is made by
3855 appending @file{.ch} to the source file name.
3857 @item ssa
3858 @opindex fdump-tree-ssa
3859 Dump SSA related information to a file.  The file name is made by appending
3860 @file{.ssa} to the source file name.
3862 @item salias
3863 @opindex fdump-tree-salias
3864 Dump structure aliasing variable information to a file.  This file name
3865 is made by appending @file{.salias} to the source file name.
3867 @item alias
3868 @opindex fdump-tree-alias
3869 Dump aliasing information for each function.  The file name is made by
3870 appending @file{.alias} to the source file name.
3872 @item ccp
3873 @opindex fdump-tree-ccp
3874 Dump each function after CCP@.  The file name is made by appending
3875 @file{.ccp} to the source file name.
3877 @item pre
3878 @opindex fdump-tree-pre
3879 Dump trees after partial redundancy elimination.  The file name is made
3880 by appending @file{.pre} to the source file name.
3882 @item fre
3883 @opindex fdump-tree-fre
3884 Dump trees after full redundancy elimination.  The file name is made
3885 by appending @file{.fre} to the source file name.
3887 @item dce
3888 @opindex fdump-tree-dce
3889 Dump each function after dead code elimination.  The file name is made by
3890 appending @file{.dce} to the source file name.
3892 @item mudflap
3893 @opindex fdump-tree-mudflap
3894 Dump each function after adding mudflap instrumentation.  The file name is
3895 made by appending @file{.mudflap} to the source file name.
3897 @item sra
3898 @opindex fdump-tree-sra
3899 Dump each function after performing scalar replacement of aggregates.  The
3900 file name is made by appending @file{.sra} to the source file name.
3902 @item sink
3903 @opindex fdump-tree-sink
3904 Dump each function after performing code sinking.  The file name is made
3905 by appending @file{.sink} to the source file name. 
3907 @item dom
3908 @opindex fdump-tree-dom
3909 Dump each function after applying dominator tree optimizations.  The file
3910 name is made by appending @file{.dom} to the source file name.
3912 @item dse
3913 @opindex fdump-tree-dse
3914 Dump each function after applying dead store elimination.  The file
3915 name is made by appending @file{.dse} to the source file name.
3917 @item phiopt
3918 @opindex fdump-tree-phiopt
3919 Dump each function after optimizing PHI nodes into straightline code.  The file
3920 name is made by appending @file{.phiopt} to the source file name.
3922 @item forwprop
3923 @opindex fdump-tree-forwprop
3924 Dump each function after forward propagating single use variables.  The file
3925 name is made by appending @file{.forwprop} to the source file name.
3927 @item copyrename
3928 @opindex fdump-tree-copyrename
3929 Dump each function after applying the copy rename optimization.  The file
3930 name is made by appending @file{.copyrename} to the source file name.
3932 @item nrv
3933 @opindex fdump-tree-nrv
3934 Dump each function after applying the named return value optimization on
3935 generic trees.  The file name is made by appending @file{.nrv} to the source
3936 file name.
3938 @item vect
3939 @opindex fdump-tree-vect
3940 Dump each function after applying vectorization of loops.  The file name is
3941 made by appending @file{.vect} to the source file name.
3943 @item all
3944 @opindex fdump-tree-all
3945 Enable all the available tree dumps with the flags provided in this option.
3946 @end table
3948 @item -ftree-vectorizer-verbose=@var{n}
3949 @opindex ftree-vectorizer-verbose
3950 This option controls the amount of debugging output the vectorizer prints.
3951 This information is written to standard error, unless @option{-fdump-tree-all}
3952 or @option{-fdump-tree-vect} is specified, in which case it is output to the
3953 usual dump listing file, @file{.vect}.
3955 @item -frandom-seed=@var{string}
3956 @opindex frandom-string
3957 This option provides a seed that GCC uses when it would otherwise use
3958 random numbers.  It is used to generate certain symbol names
3959 that have to be different in every compiled file.  It is also used to
3960 place unique stamps in coverage data files and the object files that
3961 produce them.  You can use the @option{-frandom-seed} option to produce
3962 reproducibly identical object files.
3964 The @var{string} should be different for every file you compile.
3966 @item -fsched-verbose=@var{n}
3967 @opindex fsched-verbose
3968 On targets that use instruction scheduling, this option controls the
3969 amount of debugging output the scheduler prints.  This information is
3970 written to standard error, unless @option{-dS} or @option{-dR} is
3971 specified, in which case it is output to the usual dump
3972 listing file, @file{.sched} or @file{.sched2} respectively.  However
3973 for @var{n} greater than nine, the output is always printed to standard
3974 error.
3976 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3977 same information as @option{-dRS}.  For @var{n} greater than one, it
3978 also output basic block probabilities, detailed ready list information
3979 and unit/insn info.  For @var{n} greater than two, it includes RTL
3980 at abort point, control-flow and regions info.  And for @var{n} over
3981 four, @option{-fsched-verbose} also includes dependence info.
3983 @item -save-temps
3984 @opindex save-temps
3985 Store the usual ``temporary'' intermediate files permanently; place them
3986 in the current directory and name them based on the source file.  Thus,
3987 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3988 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3989 preprocessed @file{foo.i} output file even though the compiler now
3990 normally uses an integrated preprocessor.
3992 When used in combination with the @option{-x} command line option,
3993 @option{-save-temps} is sensible enough to avoid over writing an
3994 input source file with the same extension as an intermediate file.
3995 The corresponding intermediate file may be obtained by renaming the
3996 source file before using @option{-save-temps}.
3998 @item -time
3999 @opindex time
4000 Report the CPU time taken by each subprocess in the compilation
4001 sequence.  For C source files, this is the compiler proper and assembler
4002 (plus the linker if linking is done).  The output looks like this:
4004 @smallexample
4005 # cc1 0.12 0.01
4006 # as 0.00 0.01
4007 @end smallexample
4009 The first number on each line is the ``user time'', that is time spent
4010 executing the program itself.  The second number is ``system time'',
4011 time spent executing operating system routines on behalf of the program.
4012 Both numbers are in seconds.
4014 @item -fvar-tracking
4015 @opindex fvar-tracking
4016 Run variable tracking pass.  It computes where variables are stored at each
4017 position in code.  Better debugging information is then generated
4018 (if the debugging information format supports this information).
4020 It is enabled by default when compiling with optimization (@option{-Os},
4021 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4022 the debug info format supports it.
4024 @item -print-file-name=@var{library}
4025 @opindex print-file-name
4026 Print the full absolute name of the library file @var{library} that
4027 would be used when linking---and don't do anything else.  With this
4028 option, GCC does not compile or link anything; it just prints the
4029 file name.
4031 @item -print-multi-directory
4032 @opindex print-multi-directory
4033 Print the directory name corresponding to the multilib selected by any
4034 other switches present in the command line.  This directory is supposed
4035 to exist in @env{GCC_EXEC_PREFIX}.
4037 @item -print-multi-lib
4038 @opindex print-multi-lib
4039 Print the mapping from multilib directory names to compiler switches
4040 that enable them.  The directory name is separated from the switches by
4041 @samp{;}, and each switch starts with an @samp{@@} instead of the
4042 @samp{-}, without spaces between multiple switches.  This is supposed to
4043 ease shell-processing.
4045 @item -print-prog-name=@var{program}
4046 @opindex print-prog-name
4047 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4049 @item -print-libgcc-file-name
4050 @opindex print-libgcc-file-name
4051 Same as @option{-print-file-name=libgcc.a}.
4053 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4054 but you do want to link with @file{libgcc.a}.  You can do
4056 @smallexample
4057 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4058 @end smallexample
4060 @item -print-search-dirs
4061 @opindex print-search-dirs
4062 Print the name of the configured installation directory and a list of
4063 program and library directories @command{gcc} will search---and don't do anything else.
4065 This is useful when @command{gcc} prints the error message
4066 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4067 To resolve this you either need to put @file{cpp0} and the other compiler
4068 components where @command{gcc} expects to find them, or you can set the environment
4069 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4070 Don't forget the trailing @samp{/}.
4071 @xref{Environment Variables}.
4073 @item -dumpmachine
4074 @opindex dumpmachine
4075 Print the compiler's target machine (for example,
4076 @samp{i686-pc-linux-gnu})---and don't do anything else.
4078 @item -dumpversion
4079 @opindex dumpversion
4080 Print the compiler version (for example, @samp{3.0})---and don't do
4081 anything else.
4083 @item -dumpspecs
4084 @opindex dumpspecs
4085 Print the compiler's built-in specs---and don't do anything else.  (This
4086 is used when GCC itself is being built.)  @xref{Spec Files}.
4088 @item -feliminate-unused-debug-types
4089 @opindex feliminate-unused-debug-types
4090 Normally, when producing DWARF2 output, GCC will emit debugging
4091 information for all types declared in a compilation
4092 unit, regardless of whether or not they are actually used
4093 in that compilation unit.  Sometimes this is useful, such as
4094 if, in the debugger, you want to cast a value to a type that is
4095 not actually used in your program (but is declared).  More often,
4096 however, this results in a significant amount of wasted space.
4097 With this option, GCC will avoid producing debug symbol output
4098 for types that are nowhere used in the source file being compiled.
4099 @end table
4101 @node Optimize Options
4102 @section Options That Control Optimization
4103 @cindex optimize options
4104 @cindex options, optimization
4106 These options control various sorts of optimizations.
4108 Without any optimization option, the compiler's goal is to reduce the
4109 cost of compilation and to make debugging produce the expected
4110 results.  Statements are independent: if you stop the program with a
4111 breakpoint between statements, you can then assign a new value to any
4112 variable or change the program counter to any other statement in the
4113 function and get exactly the results you would expect from the source
4114 code.
4116 Turning on optimization flags makes the compiler attempt to improve
4117 the performance and/or code size at the expense of compilation time
4118 and possibly the ability to debug the program.
4120 The compiler performs optimization based on the knowledge it has of
4121 the program.  Optimization levels @option{-O2} and above, in
4122 particular, enable @emph{unit-at-a-time} mode, which allows the
4123 compiler to consider information gained from later functions in
4124 the file when compiling a function.  Compiling multiple files at
4125 once to a single output file in @emph{unit-at-a-time} mode allows
4126 the compiler to use information gained from all of the files when
4127 compiling each of them.
4129 Not all optimizations are controlled directly by a flag.  Only
4130 optimizations that have a flag are listed.
4132 @table @gcctabopt
4133 @item -O
4134 @itemx -O1
4135 @opindex O
4136 @opindex O1
4137 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4138 more memory for a large function.
4140 With @option{-O}, the compiler tries to reduce code size and execution
4141 time, without performing any optimizations that take a great deal of
4142 compilation time.
4144 @option{-O} turns on the following optimization flags:
4145 @gccoptlist{-fdefer-pop @gol
4146 -fdelayed-branch @gol
4147 -fguess-branch-probability @gol
4148 -fcprop-registers @gol
4149 -floop-optimize @gol
4150 -fif-conversion @gol
4151 -fif-conversion2 @gol
4152 -ftree-ccp @gol
4153 -ftree-dce @gol
4154 -ftree-dom @gol
4155 -ftree-dse @gol
4156 -ftree-ter @gol
4157 -ftree-live_range_split @gol
4158 -ftree-sra @gol
4159 -ftree-copyrename @gol
4160 -ftree-fre @gol
4161 -ftree-ch @gol
4162 -fmerge-constants}
4164 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4165 where doing so does not interfere with debugging.
4167 @item -O2
4168 @opindex O2
4169 Optimize even more.  GCC performs nearly all supported optimizations
4170 that do not involve a space-speed tradeoff.  The compiler does not
4171 perform loop unrolling or function inlining when you specify @option{-O2}.
4172 As compared to @option{-O}, this option increases both compilation time
4173 and the performance of the generated code.
4175 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4176 also turns on the following optimization flags:
4177 @gccoptlist{-fthread-jumps @gol
4178 -fcrossjumping @gol
4179 -foptimize-sibling-calls @gol
4180 -fcse-follow-jumps  -fcse-skip-blocks @gol
4181 -fgcse  -fgcse-lm  @gol
4182 -fexpensive-optimizations @gol
4183 -fstrength-reduce @gol
4184 -frerun-cse-after-loop  -frerun-loop-opt @gol
4185 -fcaller-saves @gol
4186 -fforce-mem @gol
4187 -fpeephole2 @gol
4188 -fschedule-insns  -fschedule-insns2 @gol
4189 -fsched-interblock  -fsched-spec @gol
4190 -fregmove @gol
4191 -fstrict-aliasing @gol
4192 -fdelete-null-pointer-checks @gol
4193 -freorder-blocks  -freorder-functions @gol
4194 -funit-at-a-time @gol
4195 -falign-functions  -falign-jumps @gol
4196 -falign-loops  -falign-labels @gol
4197 -ftree-pre}
4199 Please note the warning under @option{-fgcse} about
4200 invoking @option{-O2} on programs that use computed gotos.
4202 @item -O3
4203 @opindex O3
4204 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4205 @option{-O2} and also turns on the @option{-finline-functions},
4206 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4208 @item -O0
4209 @opindex O0
4210 Do not optimize.  This is the default.
4212 @item -Os
4213 @opindex Os
4214 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4215 do not typically increase code size.  It also performs further
4216 optimizations designed to reduce code size.
4218 @option{-Os} disables the following optimization flags:
4219 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4220 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4222 If you use multiple @option{-O} options, with or without level numbers,
4223 the last such option is the one that is effective.
4224 @end table
4226 Options of the form @option{-f@var{flag}} specify machine-independent
4227 flags.  Most flags have both positive and negative forms; the negative
4228 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4229 below, only one of the forms is listed---the one you typically will
4230 use.  You can figure out the other form by either removing @samp{no-}
4231 or adding it.
4233 The following options control specific optimizations.  They are either
4234 activated by @option{-O} options or are related to ones that are.  You
4235 can use the following flags in the rare cases when ``fine-tuning'' of
4236 optimizations to be performed is desired.
4238 @table @gcctabopt
4239 @item -fno-default-inline
4240 @opindex fno-default-inline
4241 Do not make member functions inline by default merely because they are
4242 defined inside the class scope (C++ only).  Otherwise, when you specify
4243 @w{@option{-O}}, member functions defined inside class scope are compiled
4244 inline by default; i.e., you don't need to add @samp{inline} in front of
4245 the member function name.
4247 @item -fno-defer-pop
4248 @opindex fno-defer-pop
4249 Always pop the arguments to each function call as soon as that function
4250 returns.  For machines which must pop arguments after a function call,
4251 the compiler normally lets arguments accumulate on the stack for several
4252 function calls and pops them all at once.
4254 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4256 @item -fforce-mem
4257 @opindex fforce-mem
4258 Force memory operands to be copied into registers before doing
4259 arithmetic on them.  This produces better code by making all memory
4260 references potential common subexpressions.  When they are not common
4261 subexpressions, instruction combination should eliminate the separate
4262 register-load.
4264 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4266 @item -fforce-addr
4267 @opindex fforce-addr
4268 Force memory address constants to be copied into registers before
4269 doing arithmetic on them.  This may produce better code just as
4270 @option{-fforce-mem} may.
4272 @item -fomit-frame-pointer
4273 @opindex fomit-frame-pointer
4274 Don't keep the frame pointer in a register for functions that
4275 don't need one.  This avoids the instructions to save, set up and
4276 restore frame pointers; it also makes an extra register available
4277 in many functions.  @strong{It also makes debugging impossible on
4278 some machines.}
4280 On some machines, such as the VAX, this flag has no effect, because
4281 the standard calling sequence automatically handles the frame pointer
4282 and nothing is saved by pretending it doesn't exist.  The
4283 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4284 whether a target machine supports this flag.  @xref{Registers,,Register
4285 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4287 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4289 @item -foptimize-sibling-calls
4290 @opindex foptimize-sibling-calls
4291 Optimize sibling and tail recursive calls.
4293 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4295 @item -fno-inline
4296 @opindex fno-inline
4297 Don't pay attention to the @code{inline} keyword.  Normally this option
4298 is used to keep the compiler from expanding any functions inline.
4299 Note that if you are not optimizing, no functions can be expanded inline.
4301 @item -finline-functions
4302 @opindex finline-functions
4303 Integrate all simple functions into their callers.  The compiler
4304 heuristically decides which functions are simple enough to be worth
4305 integrating in this way.
4307 If all calls to a given function are integrated, and the function is
4308 declared @code{static}, then the function is normally not output as
4309 assembler code in its own right.
4311 Enabled at level @option{-O3}.
4313 @item -finline-limit=@var{n}
4314 @opindex finline-limit
4315 By default, GCC limits the size of functions that can be inlined.  This flag
4316 allows the control of this limit for functions that are explicitly marked as
4317 inline (i.e., marked with the inline keyword or defined within the class
4318 definition in c++).  @var{n} is the size of functions that can be inlined in
4319 number of pseudo instructions (not counting parameter handling).  The default
4320 value of @var{n} is 600.
4321 Increasing this value can result in more inlined code at
4322 the cost of compilation time and memory consumption.  Decreasing usually makes
4323 the compilation faster and less code will be inlined (which presumably
4324 means slower programs).  This option is particularly useful for programs that
4325 use inlining heavily such as those based on recursive templates with C++.
4327 Inlining is actually controlled by a number of parameters, which may be
4328 specified individually by using @option{--param @var{name}=@var{value}}.
4329 The @option{-finline-limit=@var{n}} option sets some of these parameters
4330 as follows:
4332 @table @gcctabopt
4333  @item max-inline-insns-single
4334   is set to @var{n}/2.
4335  @item max-inline-insns-auto
4336   is set to @var{n}/2.
4337  @item min-inline-insns
4338   is set to 130 or @var{n}/4, whichever is smaller.
4339  @item max-inline-insns-rtl
4340   is set to @var{n}.
4341 @end table
4343 See below for a documentation of the individual
4344 parameters controlling inlining.
4346 @emph{Note:} pseudo instruction represents, in this particular context, an
4347 abstract measurement of function's size.  In no way, it represents a count
4348 of assembly instructions and as such its exact meaning might change from one
4349 release to an another.
4351 @item -fkeep-inline-functions
4352 @opindex fkeep-inline-functions
4353 In C, emit @code{static} functions that are declared @code{inline}
4354 into the object file, even if the function has been inlined into all
4355 of its callers.  This switch does not affect functions using the
4356 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4357 inline functions into the object file.
4359 @item -fkeep-static-consts
4360 @opindex fkeep-static-consts
4361 Emit variables declared @code{static const} when optimization isn't turned
4362 on, even if the variables aren't referenced.
4364 GCC enables this option by default.  If you want to force the compiler to
4365 check if the variable was referenced, regardless of whether or not
4366 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4368 @item -fmerge-constants
4369 Attempt to merge identical constants (string constants and floating point
4370 constants) across compilation units.
4372 This option is the default for optimized compilation if the assembler and
4373 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4374 behavior.
4376 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4378 @item -fmerge-all-constants
4379 Attempt to merge identical constants and identical variables.
4381 This option implies @option{-fmerge-constants}.  In addition to
4382 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4383 arrays or initialized constant variables with integral or floating point
4384 types.  Languages like C or C++ require each non-automatic variable to
4385 have distinct location, so using this option will result in non-conforming
4386 behavior.
4388 @item -fmodulo-sched
4389 @opindex fmodulo-sched
4390 Perform swing modulo scheduling immediately before the first scheduling
4391 pass.  This pass looks at innermost loops and reorders their
4392 instructions by overlapping different iterations.
4394 @item -fno-branch-count-reg
4395 @opindex fno-branch-count-reg
4396 Do not use ``decrement and branch'' instructions on a count register,
4397 but instead generate a sequence of instructions that decrement a
4398 register, compare it against zero, then branch based upon the result.
4399 This option is only meaningful on architectures that support such
4400 instructions, which include x86, PowerPC, IA-64 and S/390.
4402 The default is @option{-fbranch-count-reg}, enabled when
4403 @option{-fstrength-reduce} is enabled.
4405 @item -fno-function-cse
4406 @opindex fno-function-cse
4407 Do not put function addresses in registers; make each instruction that
4408 calls a constant function contain the function's address explicitly.
4410 This option results in less efficient code, but some strange hacks
4411 that alter the assembler output may be confused by the optimizations
4412 performed when this option is not used.
4414 The default is @option{-ffunction-cse}
4416 @item -fno-zero-initialized-in-bss
4417 @opindex fno-zero-initialized-in-bss
4418 If the target supports a BSS section, GCC by default puts variables that
4419 are initialized to zero into BSS@.  This can save space in the resulting
4420 code.
4422 This option turns off this behavior because some programs explicitly
4423 rely on variables going to the data section.  E.g., so that the
4424 resulting executable can find the beginning of that section and/or make
4425 assumptions based on that.
4427 The default is @option{-fzero-initialized-in-bss}.
4429 @item -fbounds-check
4430 @opindex fbounds-check
4431 For front-ends that support it, generate additional code to check that
4432 indices used to access arrays are within the declared range.  This is
4433 currently only supported by the Java and Fortran front-ends, where
4434 this option defaults to true and false respectively.
4436 @item -fmudflap -fmudflapth -fmudflapir
4437 @opindex fmudflap
4438 @opindex fmudflapth
4439 @opindex fmudflapir
4440 @cindex bounds checking
4441 @cindex mudflap
4442 For front-ends that support it (C and C++), instrument all risky
4443 pointer/array dereferencing operations, some standard library
4444 string/heap functions, and some other associated constructs with
4445 range/validity tests.  Modules so instrumented should be immune to
4446 buffer overflows, invalid heap use, and some other classes of C/C++
4447 programming errors.  The instrumentation relies on a separate runtime
4448 library (@file{libmudflap}), which will be linked into a program if
4449 @option{-fmudflap} is given at link time.  Run-time behavior of the
4450 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4451 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4452 for its options.
4454 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4455 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4456 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4457 instrumentation should ignore pointer reads.  This produces less
4458 instrumentation (and therefore faster execution) and still provides
4459 some protection against outright memory corrupting writes, but allows
4460 erroneously read data to propagate within a program.
4462 @item -fstrength-reduce
4463 @opindex fstrength-reduce
4464 Perform the optimizations of loop strength reduction and
4465 elimination of iteration variables.
4467 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4469 @item -fthread-jumps
4470 @opindex fthread-jumps
4471 Perform optimizations where we check to see if a jump branches to a
4472 location where another comparison subsumed by the first is found.  If
4473 so, the first branch is redirected to either the destination of the
4474 second branch or a point immediately following it, depending on whether
4475 the condition is known to be true or false.
4477 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4479 @item -fcse-follow-jumps
4480 @opindex fcse-follow-jumps
4481 In common subexpression elimination, scan through jump instructions
4482 when the target of the jump is not reached by any other path.  For
4483 example, when CSE encounters an @code{if} statement with an
4484 @code{else} clause, CSE will follow the jump when the condition
4485 tested is false.
4487 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4489 @item -fcse-skip-blocks
4490 @opindex fcse-skip-blocks
4491 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4492 follow jumps which conditionally skip over blocks.  When CSE
4493 encounters a simple @code{if} statement with no else clause,
4494 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4495 body of the @code{if}.
4497 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4499 @item -frerun-cse-after-loop
4500 @opindex frerun-cse-after-loop
4501 Re-run common subexpression elimination after loop optimizations has been
4502 performed.
4504 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4506 @item -frerun-loop-opt
4507 @opindex frerun-loop-opt
4508 Run the loop optimizer twice.
4510 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4512 @item -fgcse
4513 @opindex fgcse
4514 Perform a global common subexpression elimination pass.
4515 This pass also performs global constant and copy propagation.
4517 @emph{Note:} When compiling a program using computed gotos, a GCC
4518 extension, you may get better runtime performance if you disable
4519 the global common subexpression elimination pass by adding
4520 @option{-fno-gcse} to the command line.
4522 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4524 @item -fgcse-lm
4525 @opindex fgcse-lm
4526 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4527 attempt to move loads which are only killed by stores into themselves.  This
4528 allows a loop containing a load/store sequence to be changed to a load outside
4529 the loop, and a copy/store within the loop.
4531 Enabled by default when gcse is enabled.
4533 @item -fgcse-sm
4534 @opindex fgcse-sm
4535 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4536 global common subexpression elimination.  This pass will attempt to move
4537 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4538 loops containing a load/store sequence can be changed to a load before
4539 the loop and a store after the loop.
4541 Not enabled at any optimization level.
4543 @item -fgcse-las
4544 @opindex fgcse-las
4545 When @option{-fgcse-las} is enabled, the global common subexpression
4546 elimination pass eliminates redundant loads that come after stores to the
4547 same memory location (both partial and full redundancies).
4549 Not enabled at any optimization level.
4551 @item -fgcse-after-reload
4552 @opindex fgcse-after-reload
4553 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4554 pass is performed after reload.  The purpose of this pass is to cleanup
4555 redundant spilling.
4557 @item -floop-optimize
4558 @opindex floop-optimize
4559 Perform loop optimizations: move constant expressions out of loops, simplify
4560 exit test conditions and optionally do strength-reduction as well.
4562 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4564 @item -floop-optimize2
4565 @opindex floop-optimize2
4566 Perform loop optimizations using the new loop optimizer.  The optimizations
4567 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4568 by separate flags.
4570 @item -fcrossjumping
4571 @opindex crossjumping
4572 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4573 resulting code may or may not perform better than without cross-jumping.
4575 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4577 @item -fif-conversion
4578 @opindex if-conversion
4579 Attempt to transform conditional jumps into branch-less equivalents.  This
4580 include use of conditional moves, min, max, set flags and abs instructions, and
4581 some tricks doable by standard arithmetics.  The use of conditional execution
4582 on chips where it is available is controlled by @code{if-conversion2}.
4584 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4586 @item -fif-conversion2
4587 @opindex if-conversion2
4588 Use conditional execution (where available) to transform conditional jumps into
4589 branch-less equivalents.
4591 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4593 @item -fdelete-null-pointer-checks
4594 @opindex fdelete-null-pointer-checks
4595 Use global dataflow analysis to identify and eliminate useless checks
4596 for null pointers.  The compiler assumes that dereferencing a null
4597 pointer would have halted the program.  If a pointer is checked after
4598 it has already been dereferenced, it cannot be null.
4600 In some environments, this assumption is not true, and programs can
4601 safely dereference null pointers.  Use
4602 @option{-fno-delete-null-pointer-checks} to disable this optimization
4603 for programs which depend on that behavior.
4605 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4607 @item -fexpensive-optimizations
4608 @opindex fexpensive-optimizations
4609 Perform a number of minor optimizations that are relatively expensive.
4611 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4613 @item -foptimize-register-move
4614 @itemx -fregmove
4615 @opindex foptimize-register-move
4616 @opindex fregmove
4617 Attempt to reassign register numbers in move instructions and as
4618 operands of other simple instructions in order to maximize the amount of
4619 register tying.  This is especially helpful on machines with two-operand
4620 instructions.
4622 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4623 optimization.
4625 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4627 @item -fdelayed-branch
4628 @opindex fdelayed-branch
4629 If supported for the target machine, attempt to reorder instructions
4630 to exploit instruction slots available after delayed branch
4631 instructions.
4633 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4635 @item -fschedule-insns
4636 @opindex fschedule-insns
4637 If supported for the target machine, attempt to reorder instructions to
4638 eliminate execution stalls due to required data being unavailable.  This
4639 helps machines that have slow floating point or memory load instructions
4640 by allowing other instructions to be issued until the result of the load
4641 or floating point instruction is required.
4643 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4645 @item -fschedule-insns2
4646 @opindex fschedule-insns2
4647 Similar to @option{-fschedule-insns}, but requests an additional pass of
4648 instruction scheduling after register allocation has been done.  This is
4649 especially useful on machines with a relatively small number of
4650 registers and where memory load instructions take more than one cycle.
4652 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4654 @item -fno-sched-interblock
4655 @opindex fno-sched-interblock
4656 Don't schedule instructions across basic blocks.  This is normally
4657 enabled by default when scheduling before register allocation, i.e.@:
4658 with @option{-fschedule-insns} or at @option{-O2} or higher.
4660 @item -fno-sched-spec
4661 @opindex fno-sched-spec
4662 Don't allow speculative motion of non-load instructions.  This is normally
4663 enabled by default when scheduling before register allocation, i.e.@:
4664 with @option{-fschedule-insns} or at @option{-O2} or higher.
4666 @item -fsched-spec-load
4667 @opindex fsched-spec-load
4668 Allow speculative motion of some load instructions.  This only makes
4669 sense when scheduling before register allocation, i.e.@: with
4670 @option{-fschedule-insns} or at @option{-O2} or higher.
4672 @item -fsched-spec-load-dangerous
4673 @opindex fsched-spec-load-dangerous
4674 Allow speculative motion of more load instructions.  This only makes
4675 sense when scheduling before register allocation, i.e.@: with
4676 @option{-fschedule-insns} or at @option{-O2} or higher.
4678 @item -fsched-stalled-insns=@var{n}
4679 @opindex fsched-stalled-insns
4680 Define how many insns (if any) can be moved prematurely from the queue
4681 of stalled insns into the ready list, during the second scheduling pass.
4683 @item -fsched-stalled-insns-dep=@var{n}
4684 @opindex fsched-stalled-insns-dep
4685 Define how many insn groups (cycles) will be examined for a dependency
4686 on a stalled insn that is candidate for premature removal from the queue
4687 of stalled insns.  Has an effect only during the second scheduling pass,
4688 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4690 @item -fsched2-use-superblocks
4691 @opindex fsched2-use-superblocks
4692 When scheduling after register allocation, do use superblock scheduling
4693 algorithm.  Superblock scheduling allows motion across basic block boundaries
4694 resulting on faster schedules.  This option is experimental, as not all machine
4695 descriptions used by GCC model the CPU closely enough to avoid unreliable
4696 results from the algorithm.
4698 This only makes sense when scheduling after register allocation, i.e.@: with
4699 @option{-fschedule-insns2} or at @option{-O2} or higher.
4701 @item -fsched2-use-traces
4702 @opindex fsched2-use-traces
4703 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4704 allocation and additionally perform code duplication in order to increase the
4705 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4706 trace formation.
4708 This mode should produce faster but significantly longer programs.  Also
4709 without @option{-fbranch-probabilities} the traces constructed may not
4710 match the reality and hurt the performance.  This only makes
4711 sense when scheduling after register allocation, i.e.@: with
4712 @option{-fschedule-insns2} or at @option{-O2} or higher.
4714 @item -freschedule-modulo-scheduled-loops
4715 @opindex fscheduling-in-modulo-scheduled-loops
4716 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4717 we may want to prevent the later scheduling passes from changing its schedule, we use this
4718 option to control that.
4720 @item -fcaller-saves
4721 @opindex fcaller-saves
4722 Enable values to be allocated in registers that will be clobbered by
4723 function calls, by emitting extra instructions to save and restore the
4724 registers around such calls.  Such allocation is done only when it
4725 seems to result in better code than would otherwise be produced.
4727 This option is always enabled by default on certain machines, usually
4728 those which have no call-preserved registers to use instead.
4730 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4732 @item -ftree-pre
4733 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4734 enabled by default at @option{-O2} and @option{-O3}.
4736 @item -ftree-fre
4737 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4738 between FRE and PRE is that FRE only considers expressions
4739 that are computed on all paths leading to the redundant computation.
4740 This analysis faster than PRE, though it exposes fewer redundancies.
4741 This flag is enabled by default at @option{-O} and higher.
4743 @item -ftree-salias
4744 Perform structural alias analysis on trees.  This flag
4745 is enabled by default at @option{-O} and higher.
4747 @item -ftree-sink
4748 Perform forward store motion  on trees.  This flag is
4749 enabled by default at @option{-O} and higher.
4751 @item -ftree-ccp
4752 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4753 is enabled by default at @option{-O} and higher.
4755 @item -ftree-dce
4756 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4757 default at @option{-O} and higher.
4759 @item -ftree-dominator-opts
4760 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4761 default at @option{-O} and higher.
4763 @item -ftree-ch
4764 Perform loop header copying on trees.  This is beneficial since it increases
4765 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4766 is enabled by default at @option{-O} and higher.  It is not enabled
4767 for @option{-Os}, since it usually increases code size.
4769 @item -ftree-loop-optimize
4770 Perform loop optimizations on trees.  This flag is enabled by default
4771 at @option{-O} and higher.
4773 @item -ftree-loop-linear
4774 Perform linear loop transformations on tree.  This flag can improve cache
4775 performance and allow further loop optimizations to take place.
4777 @item -ftree-lim
4778 Perform loop invariant motion on trees.  This pass moves only invartiants that
4779 would be hard to handle on rtl level (function calls, operations that expand to
4780 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4781 operands of conditions that are invariant out of the loop, so that we can use
4782 just trivial invariantness analysis in loop unswitching.  The pass also includes
4783 store motion.
4785 @item -fivcanon
4786 Create a canonical counter for number of iterations in the loop for that
4787 determining number of iterations requires complicated analysis.  Later
4788 optimizations then may determine the number easily.  Useful especially
4789 in connection with unrolling.
4791 @item -fivopts
4792 Perform induction variable optimizations (strength reduction, induction
4793 variable merging and induction variable elimination) on trees.
4795 @item -ftree-sra
4796 Perform scalar replacement of aggregates.  This pass replaces structure
4797 references with scalars to prevent committing structures to memory too
4798 early.  This flag is enabled by default at @option{-O} and higher.
4800 @item -ftree-copyrename
4801 Perform copy renaming on trees.  This pass attempts to rename compiler
4802 temporaries to other variables at copy locations, usually resulting in
4803 variable names which more closely resemble the original variables.  This flag
4804 is enabled by default at @option{-O} and higher.
4806 @item -ftree-ter
4807 Perform temporary expression replacement during the SSA->normal phase.  Single
4808 use/single def temporaries are replaced at their use location with their
4809 defining expression.  This results in non-GIMPLE code, but gives the expanders
4810 much more complex trees to work on resulting in better RTL generation.  This is
4811 enabled by default at @option{-O} and higher.
4813 @item -ftree-lrs
4814 Perform live range splitting during the SSA->normal phase.  Distinct live
4815 ranges of a variable are split into unique variables, allowing for better
4816 optimization later.  This is enabled by default at @option{-O} and higher.
4818 @item -ftree-vectorize
4819 Perform loop vectorization on trees.
4821 @item -ftracer
4822 @opindex ftracer
4823 Perform tail duplication to enlarge superblock size.  This transformation
4824 simplifies the control flow of the function allowing other optimizations to do
4825 better job.
4827 @item -funroll-loops
4828 @opindex funroll-loops
4829 Unroll loops whose number of iterations can be determined at compile
4830 time or upon entry to the loop.  @option{-funroll-loops} implies both
4831 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4832 option makes code larger, and may or may not make it run faster.
4834 @item -funroll-all-loops
4835 @opindex funroll-all-loops
4836 Unroll all loops, even if their number of iterations is uncertain when
4837 the loop is entered.  This usually makes programs run more slowly.
4838 @option{-funroll-all-loops} implies the same options as
4839 @option{-funroll-loops},
4841 @item -fsplit-ivs-in-unroller
4842 @opindex -fsplit-ivs-in-unroller
4843 Enables expressing of values of induction variables in later iterations
4844 of the unrolled loop using the value in the first iteration.  This breaks
4845 long dependency chains, thus improving efficiency of the scheduling passes
4846 (for best results, @option{-fweb} should be used as well).
4848 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4849 same effect.  However in cases the loop body is more complicated than
4850 a single basic block, this is not reliable.  It also does not work at all
4851 on some of the architectures due to restrictions in the CSE pass.
4853 This optimization is enabled by default.
4855 @item -fvariable-expansion-in-unroller
4856 @opindex -fvariable-expansion-in-unroller
4857 With this option, the compiler will create multiple copies of some
4858 local variables when unrolling a loop which can result in superior code.
4860 @item -fprefetch-loop-arrays
4861 @opindex fprefetch-loop-arrays
4862 If supported by the target machine, generate instructions to prefetch
4863 memory to improve the performance of loops that access large arrays.
4865 These options may generate better or worse code; results are highly
4866 dependent on the structure of loops within the source code.
4868 @item -fno-peephole
4869 @itemx -fno-peephole2
4870 @opindex fno-peephole
4871 @opindex fno-peephole2
4872 Disable any machine-specific peephole optimizations.  The difference
4873 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4874 are implemented in the compiler; some targets use one, some use the
4875 other, a few use both.
4877 @option{-fpeephole} is enabled by default.
4878 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4880 @item -fno-guess-branch-probability
4881 @opindex fno-guess-branch-probability
4882 Do not guess branch probabilities using heuristics.
4884 GCC will use heuristics to guess branch probabilities if they are
4885 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4886 heuristics are based on the control flow graph.  If some branch probabilities
4887 are specified by @samp{__builtin_expect}, then the heuristics will be
4888 used to guess branch probabilities for the rest of the control flow graph,
4889 taking the @samp{__builtin_expect} info into account.  The interactions
4890 between the heuristics and @samp{__builtin_expect} can be complex, and in
4891 some cases, it may be useful to disable the heuristics so that the effects
4892 of @samp{__builtin_expect} are easier to understand.
4894 The default is @option{-fguess-branch-probability} at levels
4895 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4897 @item -freorder-blocks
4898 @opindex freorder-blocks
4899 Reorder basic blocks in the compiled function in order to reduce number of
4900 taken branches and improve code locality.
4902 Enabled at levels @option{-O2}, @option{-O3}.
4904 @item -freorder-blocks-and-partition
4905 @opindex freorder-blocks-and-partition
4906 In addition to reordering basic blocks in the compiled function, in order
4907 to reduce number of taken branches, partitions hot and cold basic blocks
4908 into separate sections of the assembly and .o files, to improve
4909 paging and cache locality performance.
4911 This optimization is automatically turned off in the presence of
4912 exception handling, for linkonce sections, for functions with a user-defined
4913 section attribute and on any architecture that does not support named
4914 sections.
4916 @item -freorder-functions
4917 @opindex freorder-functions
4918 Reorder functions in the object file in order to
4919 improve code locality.  This is implemented by using special
4920 subsections @code{.text.hot} for most frequently executed functions and
4921 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4922 the linker so object file format must support named sections and linker must
4923 place them in a reasonable way.
4925 Also profile feedback must be available in to make this option effective.  See
4926 @option{-fprofile-arcs} for details.
4928 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4930 @item -fstrict-aliasing
4931 @opindex fstrict-aliasing
4932 Allows the compiler to assume the strictest aliasing rules applicable to
4933 the language being compiled.  For C (and C++), this activates
4934 optimizations based on the type of expressions.  In particular, an
4935 object of one type is assumed never to reside at the same address as an
4936 object of a different type, unless the types are almost the same.  For
4937 example, an @code{unsigned int} can alias an @code{int}, but not a
4938 @code{void*} or a @code{double}.  A character type may alias any other
4939 type.
4941 Pay special attention to code like this:
4942 @smallexample
4943 union a_union @{
4944   int i;
4945   double d;
4948 int f() @{
4949   a_union t;
4950   t.d = 3.0;
4951   return t.i;
4953 @end smallexample
4954 The practice of reading from a different union member than the one most
4955 recently written to (called ``type-punning'') is common.  Even with
4956 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4957 is accessed through the union type.  So, the code above will work as
4958 expected.  However, this code might not:
4959 @smallexample
4960 int f() @{
4961   a_union t;
4962   int* ip;
4963   t.d = 3.0;
4964   ip = &t.i;
4965   return *ip;
4967 @end smallexample
4969 Every language that wishes to perform language-specific alias analysis
4970 should define a function that computes, given an @code{tree}
4971 node, an alias set for the node.  Nodes in different alias sets are not
4972 allowed to alias.  For an example, see the C front-end function
4973 @code{c_get_alias_set}.
4975 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4977 @item -falign-functions
4978 @itemx -falign-functions=@var{n}
4979 @opindex falign-functions
4980 Align the start of functions to the next power-of-two greater than
4981 @var{n}, skipping up to @var{n} bytes.  For instance,
4982 @option{-falign-functions=32} aligns functions to the next 32-byte
4983 boundary, but @option{-falign-functions=24} would align to the next
4984 32-byte boundary only if this can be done by skipping 23 bytes or less.
4986 @option{-fno-align-functions} and @option{-falign-functions=1} are
4987 equivalent and mean that functions will not be aligned.
4989 Some assemblers only support this flag when @var{n} is a power of two;
4990 in that case, it is rounded up.
4992 If @var{n} is not specified or is zero, use a machine-dependent default.
4994 Enabled at levels @option{-O2}, @option{-O3}.
4996 @item -falign-labels
4997 @itemx -falign-labels=@var{n}
4998 @opindex falign-labels
4999 Align all branch targets to a power-of-two boundary, skipping up to
5000 @var{n} bytes like @option{-falign-functions}.  This option can easily
5001 make code slower, because it must insert dummy operations for when the
5002 branch target is reached in the usual flow of the code.
5004 @option{-fno-align-labels} and @option{-falign-labels=1} are
5005 equivalent and mean that labels will not be aligned.
5007 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5008 are greater than this value, then their values are used instead.
5010 If @var{n} is not specified or is zero, use a machine-dependent default
5011 which is very likely to be @samp{1}, meaning no alignment.
5013 Enabled at levels @option{-O2}, @option{-O3}.
5015 @item -falign-loops
5016 @itemx -falign-loops=@var{n}
5017 @opindex falign-loops
5018 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5019 like @option{-falign-functions}.  The hope is that the loop will be
5020 executed many times, which will make up for any execution of the dummy
5021 operations.
5023 @option{-fno-align-loops} and @option{-falign-loops=1} are
5024 equivalent and mean that loops will not be aligned.
5026 If @var{n} is not specified or is zero, use a machine-dependent default.
5028 Enabled at levels @option{-O2}, @option{-O3}.
5030 @item -falign-jumps
5031 @itemx -falign-jumps=@var{n}
5032 @opindex falign-jumps
5033 Align branch targets to a power-of-two boundary, for branch targets
5034 where the targets can only be reached by jumping, skipping up to @var{n}
5035 bytes like @option{-falign-functions}.  In this case, no dummy operations
5036 need be executed.
5038 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5039 equivalent and mean that loops will not be aligned.
5041 If @var{n} is not specified or is zero, use a machine-dependent default.
5043 Enabled at levels @option{-O2}, @option{-O3}.
5045 @item -funit-at-a-time
5046 @opindex funit-at-a-time
5047 Parse the whole compilation unit before starting to produce code.
5048 This allows some extra optimizations to take place but consumes
5049 more memory (in general).  There are some compatibility issues
5050 with @emph{unit-at-at-time} mode:
5051 @itemize @bullet
5052 @item
5053 enabling @emph{unit-at-a-time} mode may change the order
5054 in which functions, variables, and top-level @code{asm} statements
5055 are emitted, and will likely break code relying on some particular
5056 ordering.  The majority of such top-level @code{asm} statements,
5057 though, can be replaced by @code{section} attributes.
5059 @item
5060 @emph{unit-at-a-time} mode removes unreferenced static variables
5061 and functions are removed.  This may result in undefined references
5062 when an @code{asm} statement refers directly to variables or functions
5063 that are otherwise unused.  In that case either the variable/function
5064 shall be listed as an operand of the @code{asm} statement operand or,
5065 in the case of top-level @code{asm} statements the attribute @code{used}
5066 shall be used on the declaration.
5068 @item
5069 Static functions now can use non-standard passing conventions that
5070 may break @code{asm} statements calling functions directly.  Again,
5071 attribute @code{used} will prevent this behavior.
5072 @end itemize
5074 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5075 but this scheme may not be supported by future releases of GCC@.
5077 Enabled at levels @option{-O2}, @option{-O3}.
5079 @item -fweb
5080 @opindex fweb
5081 Constructs webs as commonly used for register allocation purposes and assign
5082 each web individual pseudo register.  This allows the register allocation pass
5083 to operate on pseudos directly, but also strengthens several other optimization
5084 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5085 however, make debugging impossible, since variables will no longer stay in a
5086 ``home register''.
5088 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5089 on targets where the default format for debugging information supports
5090 variable tracking.
5092 @item -fno-cprop-registers
5093 @opindex fno-cprop-registers
5094 After register allocation and post-register allocation instruction splitting,
5095 we perform a copy-propagation pass to try to reduce scheduling dependencies
5096 and occasionally eliminate the copy.
5098 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5100 @item -fprofile-generate
5101 @opindex fprofile-generate
5103 Enable options usually used for instrumenting application to produce
5104 profile useful for later recompilation with profile feedback based
5105 optimization.  You must use @option{-fprofile-generate} both when
5106 compiling and when linking your program.
5108 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5110 @item -fprofile-use
5111 @opindex fprofile-use
5112 Enable profile feedback directed optimizations, and optimizations
5113 generally profitable only with profile feedback available.
5115 The following options are enabled: @code{-fbranch-probabilities},
5116 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5118 @end table
5120 The following options control compiler behavior regarding floating
5121 point arithmetic.  These options trade off between speed and
5122 correctness.  All must be specifically enabled.
5124 @table @gcctabopt
5125 @item -ffloat-store
5126 @opindex ffloat-store
5127 Do not store floating point variables in registers, and inhibit other
5128 options that might change whether a floating point value is taken from a
5129 register or memory.
5131 @cindex floating point precision
5132 This option prevents undesirable excess precision on machines such as
5133 the 68000 where the floating registers (of the 68881) keep more
5134 precision than a @code{double} is supposed to have.  Similarly for the
5135 x86 architecture.  For most programs, the excess precision does only
5136 good, but a few programs rely on the precise definition of IEEE floating
5137 point.  Use @option{-ffloat-store} for such programs, after modifying
5138 them to store all pertinent intermediate computations into variables.
5140 @item -ffast-math
5141 @opindex ffast-math
5142 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5143 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5144 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5145 and @option{fcx-limited-range}.
5147 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5149 This option should never be turned on by any @option{-O} option since
5150 it can result in incorrect output for programs which depend on
5151 an exact implementation of IEEE or ISO rules/specifications for
5152 math functions.
5154 @item -fno-math-errno
5155 @opindex fno-math-errno
5156 Do not set ERRNO after calling math functions that are executed
5157 with a single instruction, e.g., sqrt.  A program that relies on
5158 IEEE exceptions for math error handling may want to use this flag
5159 for speed while maintaining IEEE arithmetic compatibility.
5161 This option should never be turned on by any @option{-O} option since
5162 it can result in incorrect output for programs which depend on
5163 an exact implementation of IEEE or ISO rules/specifications for
5164 math functions.
5166 The default is @option{-fmath-errno}.
5168 @item -funsafe-math-optimizations
5169 @opindex funsafe-math-optimizations
5170 Allow optimizations for floating-point arithmetic that (a) assume
5171 that arguments and results are valid and (b) may violate IEEE or
5172 ANSI standards.  When used at link-time, it may include libraries
5173 or startup files that change the default FPU control word or other
5174 similar optimizations.
5176 This option should never be turned on by any @option{-O} option since
5177 it can result in incorrect output for programs which depend on
5178 an exact implementation of IEEE or ISO rules/specifications for
5179 math functions.
5181 The default is @option{-fno-unsafe-math-optimizations}.
5183 @item -ffinite-math-only
5184 @opindex ffinite-math-only
5185 Allow optimizations for floating-point arithmetic that assume
5186 that arguments and results are not NaNs or +-Infs.
5188 This option should never be turned on by any @option{-O} option since
5189 it can result in incorrect output for programs which depend on
5190 an exact implementation of IEEE or ISO rules/specifications.
5192 The default is @option{-fno-finite-math-only}.
5194 @item -fno-trapping-math
5195 @opindex fno-trapping-math
5196 Compile code assuming that floating-point operations cannot generate
5197 user-visible traps.  These traps include division by zero, overflow,
5198 underflow, inexact result and invalid operation.  This option implies
5199 @option{-fno-signaling-nans}.  Setting this option may allow faster
5200 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5202 This option should never be turned on by any @option{-O} option since
5203 it can result in incorrect output for programs which depend on
5204 an exact implementation of IEEE or ISO rules/specifications for
5205 math functions.
5207 The default is @option{-ftrapping-math}.
5209 @item -frounding-math
5210 @opindex frounding-math
5211 Disable transformations and optimizations that assume default floating
5212 point rounding behavior.  This is round-to-zero for all floating point
5213 to integer conversions, and round-to-nearest for all other arithmetic
5214 truncations.  This option should be specified for programs that change
5215 the FP rounding mode dynamically, or that may be executed with a
5216 non-default rounding mode.  This option disables constant folding of
5217 floating point expressions at compile-time (which may be affected by
5218 rounding mode) and arithmetic transformations that are unsafe in the
5219 presence of sign-dependent rounding modes.
5221 The default is @option{-fno-rounding-math}.
5223 This option is experimental and does not currently guarantee to
5224 disable all GCC optimizations that are affected by rounding mode.
5225 Future versions of GCC may provide finer control of this setting
5226 using C99's @code{FENV_ACCESS} pragma.  This command line option
5227 will be used to specify the default state for @code{FENV_ACCESS}.
5229 @item -fsignaling-nans
5230 @opindex fsignaling-nans
5231 Compile code assuming that IEEE signaling NaNs may generate user-visible
5232 traps during floating-point operations.  Setting this option disables
5233 optimizations that may change the number of exceptions visible with
5234 signaling NaNs.  This option implies @option{-ftrapping-math}.
5236 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5237 be defined.
5239 The default is @option{-fno-signaling-nans}.
5241 This option is experimental and does not currently guarantee to
5242 disable all GCC optimizations that affect signaling NaN behavior.
5244 @item -fsingle-precision-constant
5245 @opindex fsingle-precision-constant
5246 Treat floating point constant as single precision constant instead of
5247 implicitly converting it to double precision constant.
5249 @item -fcx-limited-range
5250 @itemx -fno-cx-limited-range
5251 @opindex fcx-limited-range
5252 @opindex fno-cx-limited-range
5253 When enabled, this option states that a range reduction step is not
5254 needed when performing complex division.  The default is
5255 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5257 This option controls the default setting of the ISO C99 
5258 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5259 all languages.
5261 @end table
5263 The following options control optimizations that may improve
5264 performance, but are not enabled by any @option{-O} options.  This
5265 section includes experimental options that may produce broken code.
5267 @table @gcctabopt
5268 @item -fbranch-probabilities
5269 @opindex fbranch-probabilities
5270 After running a program compiled with @option{-fprofile-arcs}
5271 (@pxref{Debugging Options,, Options for Debugging Your Program or
5272 @command{gcc}}), you can compile it a second time using
5273 @option{-fbranch-probabilities}, to improve optimizations based on
5274 the number of times each branch was taken.  When the program
5275 compiled with @option{-fprofile-arcs} exits it saves arc execution
5276 counts to a file called @file{@var{sourcename}.gcda} for each source
5277 file  The information in this data file is very dependent on the
5278 structure of the generated code, so you must use the same source code
5279 and the same optimization options for both compilations.
5281 With @option{-fbranch-probabilities}, GCC puts a
5282 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5283 These can be used to improve optimization.  Currently, they are only
5284 used in one place: in @file{reorg.c}, instead of guessing which path a
5285 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5286 exactly determine which path is taken more often.
5288 @item -fprofile-values
5289 @opindex fprofile-values
5290 If combined with @option{-fprofile-arcs}, it adds code so that some
5291 data about values of expressions in the program is gathered.
5293 With @option{-fbranch-probabilities}, it reads back the data gathered
5294 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5295 notes to instructions for their later usage in optimizations.
5297 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5299 @item -fvpt
5300 @opindex fvpt
5301 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5302 a code to gather information about values of expressions.
5304 With @option{-fbranch-probabilities}, it reads back the data gathered
5305 and actually performs the optimizations based on them.
5306 Currently the optimizations include specialization of division operation
5307 using the knowledge about the value of the denominator.
5309 @item -fspeculative-prefetching
5310 @opindex fspeculative-prefetching
5311 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5312 a code to gather information about addresses of memory references in the
5313 program.
5315 With @option{-fbranch-probabilities}, it reads back the data gathered
5316 and issues prefetch instructions according to them.  In addition to the opportunities
5317 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5318 memory access patterns---for example accesses to the data stored in linked
5319 list whose elements are usually allocated sequentially.
5321 In order to prevent issuing double prefetches, usage of
5322 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5324 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5326 @item -frename-registers
5327 @opindex frename-registers
5328 Attempt to avoid false dependencies in scheduled code by making use
5329 of registers left over after register allocation.  This optimization
5330 will most benefit processors with lots of registers.  Depending on the
5331 debug information format adopted by the target, however, it can
5332 make debugging impossible, since variables will no longer stay in
5333 a ``home register''.
5335 Not enabled by default at any level because it has known bugs.
5337 @item -ftracer
5338 @opindex ftracer
5339 Perform tail duplication to enlarge superblock size.  This transformation
5340 simplifies the control flow of the function allowing other optimizations to do
5341 better job.
5343 Enabled with @option{-fprofile-use}.
5345 @item -funroll-loops
5346 @opindex funroll-loops
5347 Unroll loops whose number of iterations can be determined at compile time or
5348 upon entry to the loop.  @option{-funroll-loops} implies
5349 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5350 (i.e.@: complete removal of loops with small constant number of iterations).
5351 This option makes code larger, and may or may not make it run faster.
5353 Enabled with @option{-fprofile-use}.
5355 @item -funroll-all-loops
5356 @opindex funroll-all-loops
5357 Unroll all loops, even if their number of iterations is uncertain when
5358 the loop is entered.  This usually makes programs run more slowly.
5359 @option{-funroll-all-loops} implies the same options as
5360 @option{-funroll-loops}.
5362 @item -fpeel-loops
5363 @opindex fpeel-loops
5364 Peels the loops for that there is enough information that they do not
5365 roll much (from profile feedback).  It also turns on complete loop peeling
5366 (i.e.@: complete removal of loops with small constant number of iterations).
5368 Enabled with @option{-fprofile-use}.
5370 @item -fmove-loop-invariants
5371 @opindex fmove-loop-invariants
5372 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5373 at level @option{-O1}
5375 @item -funswitch-loops
5376 @opindex funswitch-loops
5377 Move branches with loop invariant conditions out of the loop, with duplicates
5378 of the loop on both branches (modified according to result of the condition).
5380 @item -fprefetch-loop-arrays
5381 @opindex fprefetch-loop-arrays
5382 If supported by the target machine, generate instructions to prefetch
5383 memory to improve the performance of loops that access large arrays.
5385 Disabled at level @option{-Os}.
5387 @item -ffunction-sections
5388 @itemx -fdata-sections
5389 @opindex ffunction-sections
5390 @opindex fdata-sections
5391 Place each function or data item into its own section in the output
5392 file if the target supports arbitrary sections.  The name of the
5393 function or the name of the data item determines the section's name
5394 in the output file.
5396 Use these options on systems where the linker can perform optimizations
5397 to improve locality of reference in the instruction space.  Most systems
5398 using the ELF object format and SPARC processors running Solaris 2 have
5399 linkers with such optimizations.  AIX may have these optimizations in
5400 the future.
5402 Only use these options when there are significant benefits from doing
5403 so.  When you specify these options, the assembler and linker will
5404 create larger object and executable files and will also be slower.
5405 You will not be able to use @code{gprof} on all systems if you
5406 specify this option and you may have problems with debugging if
5407 you specify both this option and @option{-g}.
5409 @item -fbranch-target-load-optimize
5410 @opindex fbranch-target-load-optimize
5411 Perform branch target register load optimization before prologue / epilogue
5412 threading.
5413 The use of target registers can typically be exposed only during reload,
5414 thus hoisting loads out of loops and doing inter-block scheduling needs
5415 a separate optimization pass.
5417 @item -fbranch-target-load-optimize2
5418 @opindex fbranch-target-load-optimize2
5419 Perform branch target register load optimization after prologue / epilogue
5420 threading.
5422 @item -fbtr-bb-exclusive
5423 @opindex fbtr-bb-exclusive
5424 When performing branch target register load optimization, don't reuse
5425 branch target registers in within any basic block.
5427 @item --param @var{name}=@var{value}
5428 @opindex param
5429 In some places, GCC uses various constants to control the amount of
5430 optimization that is done.  For example, GCC will not inline functions
5431 that contain more that a certain number of instructions.  You can
5432 control some of these constants on the command-line using the
5433 @option{--param} option.
5435 The names of specific parameters, and the meaning of the values, are
5436 tied to the internals of the compiler, and are subject to change
5437 without notice in future releases.
5439 In each case, the @var{value} is an integer.  The allowable choices for
5440 @var{name} are given in the following table:
5442 @table @gcctabopt
5443 @item sra-max-structure-size
5444 The maximum structure size, in bytes, at which the scalar replacement
5445 of aggregates (SRA) optimization will perform block copies.  The
5446 default value, 0, implies that GCC will select the most appropriate
5447 size itself.
5449 @item sra-field-structure-ratio
5450 The threshold ratio (as a percentage) between instantiated fields and
5451 the complete structure size.  We say that if the ratio of the number
5452 of bytes in instantiated fields to the number of bytes in the complete
5453 structure exceeds this parameter, then block copies are not used.  The
5454 default is 75.
5456 @item max-crossjump-edges
5457 The maximum number of incoming edges to consider for crossjumping.
5458 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5459 the number of edges incoming to each block.  Increasing values mean
5460 more aggressive optimization, making the compile time increase with
5461 probably small improvement in executable size.
5463 @item min-crossjump-insns
5464 The minimum number of instructions which must be matched at the end
5465 of two blocks before crossjumping will be performed on them.  This
5466 value is ignored in the case where all instructions in the block being
5467 crossjumped from are matched.  The default value is 5.
5469 @item max-goto-duplication-insns
5470 The maximum number of instructions to duplicate to a block that jumps
5471 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5472 passes, GCC factors computed gotos early in the compilation process,
5473 and unfactors them as late as possible.  Only computed jumps at the
5474 end of a basic blocks with no more than max-goto-duplication-insns are
5475 unfactored.  The default value is 8.
5477 @item max-delay-slot-insn-search
5478 The maximum number of instructions to consider when looking for an
5479 instruction to fill a delay slot.  If more than this arbitrary number of
5480 instructions is searched, the time savings from filling the delay slot
5481 will be minimal so stop searching.  Increasing values mean more
5482 aggressive optimization, making the compile time increase with probably
5483 small improvement in executable run time.
5485 @item max-delay-slot-live-search
5486 When trying to fill delay slots, the maximum number of instructions to
5487 consider when searching for a block with valid live register
5488 information.  Increasing this arbitrarily chosen value means more
5489 aggressive optimization, increasing the compile time.  This parameter
5490 should be removed when the delay slot code is rewritten to maintain the
5491 control-flow graph.
5493 @item max-gcse-memory
5494 The approximate maximum amount of memory that will be allocated in
5495 order to perform the global common subexpression elimination
5496 optimization.  If more memory than specified is required, the
5497 optimization will not be done.
5499 @item max-gcse-passes
5500 The maximum number of passes of GCSE to run.  The default is 1.
5502 @item max-pending-list-length
5503 The maximum number of pending dependencies scheduling will allow
5504 before flushing the current state and starting over.  Large functions
5505 with few branches or calls can create excessively large lists which
5506 needlessly consume memory and resources.
5508 @item max-inline-insns-single
5509 Several parameters control the tree inliner used in gcc.
5510 This number sets the maximum number of instructions (counted in GCC's
5511 internal representation) in a single function that the tree inliner
5512 will consider for inlining.  This only affects functions declared
5513 inline and methods implemented in a class declaration (C++).
5514 The default value is 450.
5516 @item max-inline-insns-auto
5517 When you use @option{-finline-functions} (included in @option{-O3}),
5518 a lot of functions that would otherwise not be considered for inlining
5519 by the compiler will be investigated.  To those functions, a different
5520 (more restrictive) limit compared to functions declared inline can
5521 be applied.
5522 The default value is 90.
5524 @item large-function-insns
5525 The limit specifying really large functions.  For functions larger than this
5526 limit after inlining inlining is constrained by
5527 @option{--param large-function-growth}.  This parameter is useful primarily
5528 to avoid extreme compilation time caused by non-linear algorithms used by the
5529 backend.
5530 This parameter is ignored when @option{-funit-at-a-time} is not used.
5531 The default value is 2700.
5533 @item large-function-growth
5534 Specifies maximal growth of large function caused by inlining in percents.
5535 This parameter is ignored when @option{-funit-at-a-time} is not used.
5536 The default value is 100 which limits large function growth to 2.0 times
5537 the original size.
5539 @item inline-unit-growth
5540 Specifies maximal overall growth of the compilation unit caused by inlining.
5541 This parameter is ignored when @option{-funit-at-a-time} is not used.
5542 The default value is 50 which limits unit growth to 1.5 times the original
5543 size.
5545 @item max-inline-insns-recursive
5546 @itemx max-inline-insns-recursive-auto
5547 Specifies maximum number of instructions out-of-line copy of self recursive inline
5548 function can grow into by performing recursive inlining.
5550 For functions declared inline @option{--param max-inline-insns-recursive} is
5551 taken into acount.  For function not declared inline, recursive inlining
5552 happens only when @option{-finline-functions} (included in @option{-O3}) is
5553 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5554 default value is 450.
5556 @item max-inline-recursive-depth
5557 @itemx max-inline-recursive-depth-auto
5558 Specifies maximum recursion depth used by the recursive inlining.
5560 For functions declared inline @option{--param max-inline-recursive-depth} is
5561 taken into acount.  For function not declared inline, recursive inlining
5562 happens only when @option{-finline-functions} (included in @option{-O3}) is
5563 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5564 default value is 450.
5566 @item inline-call-cost
5567 Specify cost of call instruction relative to simple arithmetics operations
5568 (having cost of 1).  Increasing this cost disqualifies inlining of non-leaf
5569 functions and at the same time increases size of leaf function that is believed to
5570 reduce function size by being inlined.  In effect it increases amount of
5571 inlining for code having large abstraction penalty (many functions that just
5572 pass the arguments to other functions) and decrease inlining for code with low
5573 abstraction penalty.  The default value is 16.
5575 @item max-unrolled-insns
5576 The maximum number of instructions that a loop should have if that loop
5577 is unrolled, and if the loop is unrolled, it determines how many times
5578 the loop code is unrolled.
5580 @item max-average-unrolled-insns
5581 The maximum number of instructions biased by probabilities of their execution
5582 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5583 it determines how many times the loop code is unrolled.
5585 @item max-unroll-times
5586 The maximum number of unrollings of a single loop.
5588 @item max-peeled-insns
5589 The maximum number of instructions that a loop should have if that loop
5590 is peeled, and if the loop is peeled, it determines how many times
5591 the loop code is peeled.
5593 @item max-peel-times
5594 The maximum number of peelings of a single loop.
5596 @item max-completely-peeled-insns
5597 The maximum number of insns of a completely peeled loop.
5599 @item max-completely-peel-times
5600 The maximum number of iterations of a loop to be suitable for complete peeling.
5602 @item max-unswitch-insns
5603 The maximum number of insns of an unswitched loop.
5605 @item max-unswitch-level
5606 The maximum number of branches unswitched in a single loop.
5608 @item lim-expensive
5609 The minimum cost of an expensive expression in the loop invariant motion.
5611 @item iv-consider-all-candidates-bound
5612 Bound on number of candidates for induction variables below that
5613 all candidates are considered for each use in induction variable
5614 optimizations.  Only the most relevant candidates are considered
5615 if there are more candidates, to avoid quadratic time complexity.
5617 @item iv-max-considered-uses
5618 The induction variable optimizations give up on loops that contain more
5619 induction variable uses.
5621 @item iv-always-prune-cand-set-bound
5622 If number of candidates in the set is smaller than this value,
5623 we always try to remove unnecessary ivs from the set during its
5624 optimization when a new iv is added to the set.
5626 @item max-iterations-to-track
5628 The maximum number of iterations of a loop the brute force algorithm
5629 for analysis of # of iterations of the loop tries to evaluate.
5631 @item hot-bb-count-fraction
5632 Select fraction of the maximal count of repetitions of basic block in program
5633 given basic block needs to have to be considered hot.
5635 @item hot-bb-frequency-fraction
5636 Select fraction of the maximal frequency of executions of basic block in
5637 function given basic block needs to have to be considered hot
5639 @item tracer-dynamic-coverage
5640 @itemx tracer-dynamic-coverage-feedback
5642 This value is used to limit superblock formation once the given percentage of
5643 executed instructions is covered.  This limits unnecessary code size
5644 expansion.
5646 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5647 feedback is available.  The real profiles (as opposed to statically estimated
5648 ones) are much less balanced allowing the threshold to be larger value.
5650 @item tracer-max-code-growth
5651 Stop tail duplication once code growth has reached given percentage.  This is
5652 rather hokey argument, as most of the duplicates will be eliminated later in
5653 cross jumping, so it may be set to much higher values than is the desired code
5654 growth.
5656 @item tracer-min-branch-ratio
5658 Stop reverse growth when the reverse probability of best edge is less than this
5659 threshold (in percent).
5661 @item tracer-min-branch-ratio
5662 @itemx tracer-min-branch-ratio-feedback
5664 Stop forward growth if the best edge do have probability lower than this
5665 threshold.
5667 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5668 compilation for profile feedback and one for compilation without.  The value
5669 for compilation with profile feedback needs to be more conservative (higher) in
5670 order to make tracer effective.
5672 @item max-cse-path-length
5674 Maximum number of basic blocks on path that cse considers.  The default is 10.
5676 @item global-var-threshold
5678 Counts the number of function calls (@var{n}) and the number of
5679 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5680 single artificial variable will be created to represent all the
5681 call-clobbered variables at function call sites.  This artificial
5682 variable will then be made to alias every call-clobbered variable.
5683 (done as @code{int * size_t} on the host machine; beware overflow).
5685 @item max-aliased-vops
5687 Maximum number of virtual operands allowed to represent aliases
5688 before triggering the alias grouping heuristic.  Alias grouping
5689 reduces compile times and memory consumption needed for aliasing at
5690 the expense of precision loss in alias information.
5692 @item ggc-min-expand
5694 GCC uses a garbage collector to manage its own memory allocation.  This
5695 parameter specifies the minimum percentage by which the garbage
5696 collector's heap should be allowed to expand between collections.
5697 Tuning this may improve compilation speed; it has no effect on code
5698 generation.
5700 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5701 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5702 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5703 GCC is not able to calculate RAM on a particular platform, the lower
5704 bound of 30% is used.  Setting this parameter and
5705 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5706 every opportunity.  This is extremely slow, but can be useful for
5707 debugging.
5709 @item ggc-min-heapsize
5711 Minimum size of the garbage collector's heap before it begins bothering
5712 to collect garbage.  The first collection occurs after the heap expands
5713 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5714 tuning this may improve compilation speed, and has no effect on code
5715 generation.
5717 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5718 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5719 with a lower bound of 4096 (four megabytes) and an upper bound of
5720 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5721 particular platform, the lower bound is used.  Setting this parameter
5722 very large effectively disables garbage collection.  Setting this
5723 parameter and @option{ggc-min-expand} to zero causes a full collection
5724 to occur at every opportunity.
5726 @item max-reload-search-insns
5727 The maximum number of instruction reload should look backward for equivalent
5728 register.  Increasing values mean more aggressive optimization, making the
5729 compile time increase with probably slightly better performance.  The default
5730 value is 100.
5732 @item max-cselib-memory-location
5733 The maximum number of memory locations cselib should take into acount.
5734 Increasing values mean more aggressive optimization, making the compile time
5735 increase with probably slightly better performance.  The default value is 500.
5737 @item reorder-blocks-duplicate
5738 @itemx reorder-blocks-duplicate-feedback
5740 Used by basic block reordering pass to decide whether to use unconditional
5741 branch or duplicate the code on its destination.  Code is duplicated when its
5742 estimated size is smaller than this value multiplied by the estimated size of
5743 unconditional jump in the hot spots of the program.
5745 The @option{reorder-block-duplicate-feedback} is used only when profile
5746 feedback is available and may be set to higher values than
5747 @option{reorder-block-duplicate} since information about the hot spots is more
5748 accurate.
5750 @item max-sched-region-blocks
5751 The maximum number of blocks in a region to be considered for
5752 interblock scheduling.  The default value is 10.
5754 @item max-sched-region-insns
5755 The maximum number of insns in a region to be considered for
5756 interblock scheduling.  The default value is 100.
5758 @item max-last-value-rtl
5760 The maximum size measured as number of RTLs that can be recorded in an expression
5761 in combiner for a pseudo register as last known value of that register.  The default
5762 is 10000.
5764 @item integer-share-limit
5765 Small integer constants can use a shared data structure, reducing the
5766 compiler's memory usage and increasing its speed.  This sets the maximum
5767 value of a shared integer constant's.  The default value is 256.
5769 @end table
5770 @end table
5772 @node Preprocessor Options
5773 @section Options Controlling the Preprocessor
5774 @cindex preprocessor options
5775 @cindex options, preprocessor
5777 These options control the C preprocessor, which is run on each C source
5778 file before actual compilation.
5780 If you use the @option{-E} option, nothing is done except preprocessing.
5781 Some of these options make sense only together with @option{-E} because
5782 they cause the preprocessor output to be unsuitable for actual
5783 compilation.
5785 @table @gcctabopt
5786 @opindex Wp
5787 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5788 and pass @var{option} directly through to the preprocessor.  If
5789 @var{option} contains commas, it is split into multiple options at the
5790 commas.  However, many options are modified, translated or interpreted
5791 by the compiler driver before being passed to the preprocessor, and
5792 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5793 interface is undocumented and subject to change, so whenever possible
5794 you should avoid using @option{-Wp} and let the driver handle the
5795 options instead.
5797 @item -Xpreprocessor @var{option}
5798 @opindex preprocessor
5799 Pass @var{option} as an option to the preprocessor.  You can use this to
5800 supply system-specific preprocessor options which GCC does not know how to
5801 recognize.
5803 If you want to pass an option that takes an argument, you must use
5804 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5805 @end table
5807 @include cppopts.texi
5809 @node Assembler Options
5810 @section Passing Options to the Assembler
5812 @c prevent bad page break with this line
5813 You can pass options to the assembler.
5815 @table @gcctabopt
5816 @item -Wa,@var{option}
5817 @opindex Wa
5818 Pass @var{option} as an option to the assembler.  If @var{option}
5819 contains commas, it is split into multiple options at the commas.
5821 @item -Xassembler @var{option}
5822 @opindex Xassembler
5823 Pass @var{option} as an option to the assembler.  You can use this to
5824 supply system-specific assembler options which GCC does not know how to
5825 recognize.
5827 If you want to pass an option that takes an argument, you must use
5828 @option{-Xassembler} twice, once for the option and once for the argument.
5830 @end table
5832 @node Link Options
5833 @section Options for Linking
5834 @cindex link options
5835 @cindex options, linking
5837 These options come into play when the compiler links object files into
5838 an executable output file.  They are meaningless if the compiler is
5839 not doing a link step.
5841 @table @gcctabopt
5842 @cindex file names
5843 @item @var{object-file-name}
5844 A file name that does not end in a special recognized suffix is
5845 considered to name an object file or library.  (Object files are
5846 distinguished from libraries by the linker according to the file
5847 contents.)  If linking is done, these object files are used as input
5848 to the linker.
5850 @item -c
5851 @itemx -S
5852 @itemx -E
5853 @opindex c
5854 @opindex S
5855 @opindex E
5856 If any of these options is used, then the linker is not run, and
5857 object file names should not be used as arguments.  @xref{Overall
5858 Options}.
5860 @cindex Libraries
5861 @item -l@var{library}
5862 @itemx -l @var{library}
5863 @opindex l
5864 Search the library named @var{library} when linking.  (The second
5865 alternative with the library as a separate argument is only for
5866 POSIX compliance and is not recommended.)
5868 It makes a difference where in the command you write this option; the
5869 linker searches and processes libraries and object files in the order they
5870 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5871 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5872 to functions in @samp{z}, those functions may not be loaded.
5874 The linker searches a standard list of directories for the library,
5875 which is actually a file named @file{lib@var{library}.a}.  The linker
5876 then uses this file as if it had been specified precisely by name.
5878 The directories searched include several standard system directories
5879 plus any that you specify with @option{-L}.
5881 Normally the files found this way are library files---archive files
5882 whose members are object files.  The linker handles an archive file by
5883 scanning through it for members which define symbols that have so far
5884 been referenced but not defined.  But if the file that is found is an
5885 ordinary object file, it is linked in the usual fashion.  The only
5886 difference between using an @option{-l} option and specifying a file name
5887 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5888 and searches several directories.
5890 @item -lobjc
5891 @opindex lobjc
5892 You need this special case of the @option{-l} option in order to
5893 link an Objective-C or Objective-C++ program.
5895 @item -nostartfiles
5896 @opindex nostartfiles
5897 Do not use the standard system startup files when linking.
5898 The standard system libraries are used normally, unless @option{-nostdlib}
5899 or @option{-nodefaultlibs} is used.
5901 @item -nodefaultlibs
5902 @opindex nodefaultlibs
5903 Do not use the standard system libraries when linking.
5904 Only the libraries you specify will be passed to the linker.
5905 The standard startup files are used normally, unless @option{-nostartfiles}
5906 is used.  The compiler may generate calls to @code{memcmp},
5907 @code{memset}, @code{memcpy} and @code{memmove}.
5908 These entries are usually resolved by entries in
5909 libc.  These entry points should be supplied through some other
5910 mechanism when this option is specified.
5912 @item -nostdlib
5913 @opindex nostdlib
5914 Do not use the standard system startup files or libraries when linking.
5915 No startup files and only the libraries you specify will be passed to
5916 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5917 @code{memcpy} and @code{memmove}.
5918 These entries are usually resolved by entries in
5919 libc.  These entry points should be supplied through some other
5920 mechanism when this option is specified.
5922 @cindex @option{-lgcc}, use with @option{-nostdlib}
5923 @cindex @option{-nostdlib} and unresolved references
5924 @cindex unresolved references and @option{-nostdlib}
5925 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5926 @cindex @option{-nodefaultlibs} and unresolved references
5927 @cindex unresolved references and @option{-nodefaultlibs}
5928 One of the standard libraries bypassed by @option{-nostdlib} and
5929 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5930 that GCC uses to overcome shortcomings of particular machines, or special
5931 needs for some languages.
5932 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5933 Collection (GCC) Internals},
5934 for more discussion of @file{libgcc.a}.)
5935 In most cases, you need @file{libgcc.a} even when you want to avoid
5936 other standard libraries.  In other words, when you specify @option{-nostdlib}
5937 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5938 This ensures that you have no unresolved references to internal GCC
5939 library subroutines.  (For example, @samp{__main}, used to ensure C++
5940 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5941 GNU Compiler Collection (GCC) Internals}.)
5943 @item -pie
5944 @opindex pie
5945 Produce a position independent executable on targets which support it.
5946 For predictable results, you must also specify the same set of options
5947 that were used to generate code (@option{-fpie}, @option{-fPIE},
5948 or model suboptions) when you specify this option.
5950 @item -s
5951 @opindex s
5952 Remove all symbol table and relocation information from the executable.
5954 @item -static
5955 @opindex static
5956 On systems that support dynamic linking, this prevents linking with the shared
5957 libraries.  On other systems, this option has no effect.
5959 @item -shared
5960 @opindex shared
5961 Produce a shared object which can then be linked with other objects to
5962 form an executable.  Not all systems support this option.  For predictable
5963 results, you must also specify the same set of options that were used to
5964 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5965 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5966 needs to build supplementary stub code for constructors to work.  On
5967 multi-libbed systems, @samp{gcc -shared} must select the correct support
5968 libraries to link against.  Failing to supply the correct flags may lead
5969 to subtle defects.  Supplying them in cases where they are not necessary
5970 is innocuous.}
5972 @item -shared-libgcc
5973 @itemx -static-libgcc
5974 @opindex shared-libgcc
5975 @opindex static-libgcc
5976 On systems that provide @file{libgcc} as a shared library, these options
5977 force the use of either the shared or static version respectively.
5978 If no shared version of @file{libgcc} was built when the compiler was
5979 configured, these options have no effect.
5981 There are several situations in which an application should use the
5982 shared @file{libgcc} instead of the static version.  The most common
5983 of these is when the application wishes to throw and catch exceptions
5984 across different shared libraries.  In that case, each of the libraries
5985 as well as the application itself should use the shared @file{libgcc}.
5987 Therefore, the G++ and GCJ drivers automatically add
5988 @option{-shared-libgcc} whenever you build a shared library or a main
5989 executable, because C++ and Java programs typically use exceptions, so
5990 this is the right thing to do.
5992 If, instead, you use the GCC driver to create shared libraries, you may
5993 find that they will not always be linked with the shared @file{libgcc}.
5994 If GCC finds, at its configuration time, that you have a non-GNU linker
5995 or a GNU linker that does not support option @option{--eh-frame-hdr},
5996 it will link the shared version of @file{libgcc} into shared libraries
5997 by default.  Otherwise, it will take advantage of the linker and optimize
5998 away the linking with the shared version of @file{libgcc}, linking with
5999 the static version of libgcc by default.  This allows exceptions to
6000 propagate through such shared libraries, without incurring relocation
6001 costs at library load time.
6003 However, if a library or main executable is supposed to throw or catch
6004 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6005 for the languages used in the program, or using the option
6006 @option{-shared-libgcc}, such that it is linked with the shared
6007 @file{libgcc}.
6009 @item -symbolic
6010 @opindex symbolic
6011 Bind references to global symbols when building a shared object.  Warn
6012 about any unresolved references (unless overridden by the link editor
6013 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
6014 this option.
6016 @item -Xlinker @var{option}
6017 @opindex Xlinker
6018 Pass @var{option} as an option to the linker.  You can use this to
6019 supply system-specific linker options which GCC does not know how to
6020 recognize.
6022 If you want to pass an option that takes an argument, you must use
6023 @option{-Xlinker} twice, once for the option and once for the argument.
6024 For example, to pass @option{-assert definitions}, you must write
6025 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
6026 @option{-Xlinker "-assert definitions"}, because this passes the entire
6027 string as a single argument, which is not what the linker expects.
6029 @item -Wl,@var{option}
6030 @opindex Wl
6031 Pass @var{option} as an option to the linker.  If @var{option} contains
6032 commas, it is split into multiple options at the commas.
6034 @item -u @var{symbol}
6035 @opindex u
6036 Pretend the symbol @var{symbol} is undefined, to force linking of
6037 library modules to define it.  You can use @option{-u} multiple times with
6038 different symbols to force loading of additional library modules.
6039 @end table
6041 @node Directory Options
6042 @section Options for Directory Search
6043 @cindex directory options
6044 @cindex options, directory search
6045 @cindex search path
6047 These options specify directories to search for header files, for
6048 libraries and for parts of the compiler:
6050 @table @gcctabopt
6051 @item -I@var{dir}
6052 @opindex I
6053 Add the directory @var{dir} to the head of the list of directories to be
6054 searched for header files.  This can be used to override a system header
6055 file, substituting your own version, since these directories are
6056 searched before the system header file directories.  However, you should
6057 not use this option to add directories that contain vendor-supplied
6058 system header files (use @option{-isystem} for that).  If you use more than
6059 one @option{-I} option, the directories are scanned in left-to-right
6060 order; the standard system directories come after.
6062 If a standard system include directory, or a directory specified with
6063 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6064 option will be ignored.  The directory will still be searched but as a
6065 system directory at its normal position in the system include chain.
6066 This is to ensure that GCC's procedure to fix buggy system headers and
6067 the ordering for the include_next directive are not inadvertently changed.
6068 If you really need to change the search order for system directories,
6069 use the @option{-nostdinc} and/or @option{-isystem} options.
6071 @item -iquote@var{dir}
6072 @opindex iquote
6073 Add the directory @var{dir} to the head of the list of directories to
6074 be searched for header files only for the case of @samp{#include
6075 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6076 otherwise just like @option{-I}.
6078 @item -L@var{dir}
6079 @opindex L
6080 Add directory @var{dir} to the list of directories to be searched
6081 for @option{-l}.
6083 @item -B@var{prefix}
6084 @opindex B
6085 This option specifies where to find the executables, libraries,
6086 include files, and data files of the compiler itself.
6088 The compiler driver program runs one or more of the subprograms
6089 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6090 @var{prefix} as a prefix for each program it tries to run, both with and
6091 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6093 For each subprogram to be run, the compiler driver first tries the
6094 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6095 was not specified, the driver tries two standard prefixes, which are
6096 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6097 those results in a file name that is found, the unmodified program
6098 name is searched for using the directories specified in your
6099 @env{PATH} environment variable.
6101 The compiler will check to see if the path provided by the @option{-B}
6102 refers to a directory, and if necessary it will add a directory
6103 separator character at the end of the path.
6105 @option{-B} prefixes that effectively specify directory names also apply
6106 to libraries in the linker, because the compiler translates these
6107 options into @option{-L} options for the linker.  They also apply to
6108 includes files in the preprocessor, because the compiler translates these
6109 options into @option{-isystem} options for the preprocessor.  In this case,
6110 the compiler appends @samp{include} to the prefix.
6112 The run-time support file @file{libgcc.a} can also be searched for using
6113 the @option{-B} prefix, if needed.  If it is not found there, the two
6114 standard prefixes above are tried, and that is all.  The file is left
6115 out of the link if it is not found by those means.
6117 Another way to specify a prefix much like the @option{-B} prefix is to use
6118 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6119 Variables}.
6121 As a special kludge, if the path provided by @option{-B} is
6122 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6123 9, then it will be replaced by @file{[dir/]include}.  This is to help
6124 with boot-strapping the compiler.
6126 @item -specs=@var{file}
6127 @opindex specs
6128 Process @var{file} after the compiler reads in the standard @file{specs}
6129 file, in order to override the defaults that the @file{gcc} driver
6130 program uses when determining what switches to pass to @file{cc1},
6131 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6132 @option{-specs=@var{file}} can be specified on the command line, and they
6133 are processed in order, from left to right.
6135 @item -I-
6136 @opindex I-
6137 This option has been deprecated.  Please use @option{-iquote} instead for
6138 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6139 Any directories you specify with @option{-I} options before the @option{-I-}
6140 option are searched only for the case of @samp{#include "@var{file}"};
6141 they are not searched for @samp{#include <@var{file}>}.
6143 If additional directories are specified with @option{-I} options after
6144 the @option{-I-}, these directories are searched for all @samp{#include}
6145 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6146 this way.)
6148 In addition, the @option{-I-} option inhibits the use of the current
6149 directory (where the current input file came from) as the first search
6150 directory for @samp{#include "@var{file}"}.  There is no way to
6151 override this effect of @option{-I-}.  With @option{-I.} you can specify
6152 searching the directory which was current when the compiler was
6153 invoked.  That is not exactly the same as what the preprocessor does
6154 by default, but it is often satisfactory.
6156 @option{-I-} does not inhibit the use of the standard system directories
6157 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6158 independent.
6159 @end table
6161 @c man end
6163 @node Spec Files
6164 @section Specifying subprocesses and the switches to pass to them
6165 @cindex Spec Files
6167 @command{gcc} is a driver program.  It performs its job by invoking a
6168 sequence of other programs to do the work of compiling, assembling and
6169 linking.  GCC interprets its command-line parameters and uses these to
6170 deduce which programs it should invoke, and which command-line options
6171 it ought to place on their command lines.  This behavior is controlled
6172 by @dfn{spec strings}.  In most cases there is one spec string for each
6173 program that GCC can invoke, but a few programs have multiple spec
6174 strings to control their behavior.  The spec strings built into GCC can
6175 be overridden by using the @option{-specs=} command-line switch to specify
6176 a spec file.
6178 @dfn{Spec files} are plaintext files that are used to construct spec
6179 strings.  They consist of a sequence of directives separated by blank
6180 lines.  The type of directive is determined by the first non-whitespace
6181 character on the line and it can be one of the following:
6183 @table @code
6184 @item %@var{command}
6185 Issues a @var{command} to the spec file processor.  The commands that can
6186 appear here are:
6188 @table @code
6189 @item %include <@var{file}>
6190 @cindex %include
6191 Search for @var{file} and insert its text at the current point in the
6192 specs file.
6194 @item %include_noerr <@var{file}>
6195 @cindex %include_noerr
6196 Just like @samp{%include}, but do not generate an error message if the include
6197 file cannot be found.
6199 @item %rename @var{old_name} @var{new_name}
6200 @cindex %rename
6201 Rename the spec string @var{old_name} to @var{new_name}.
6203 @end table
6205 @item *[@var{spec_name}]:
6206 This tells the compiler to create, override or delete the named spec
6207 string.  All lines after this directive up to the next directive or
6208 blank line are considered to be the text for the spec string.  If this
6209 results in an empty string then the spec will be deleted.  (Or, if the
6210 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6211 does not currently exist a new spec will be created.  If the spec does
6212 exist then its contents will be overridden by the text of this
6213 directive, unless the first character of that text is the @samp{+}
6214 character, in which case the text will be appended to the spec.
6216 @item [@var{suffix}]:
6217 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6218 and up to the next directive or blank line are considered to make up the
6219 spec string for the indicated suffix.  When the compiler encounters an
6220 input file with the named suffix, it will processes the spec string in
6221 order to work out how to compile that file.  For example:
6223 @smallexample
6224 .ZZ:
6225 z-compile -input %i
6226 @end smallexample
6228 This says that any input file whose name ends in @samp{.ZZ} should be
6229 passed to the program @samp{z-compile}, which should be invoked with the
6230 command-line switch @option{-input} and with the result of performing the
6231 @samp{%i} substitution.  (See below.)
6233 As an alternative to providing a spec string, the text that follows a
6234 suffix directive can be one of the following:
6236 @table @code
6237 @item @@@var{language}
6238 This says that the suffix is an alias for a known @var{language}.  This is
6239 similar to using the @option{-x} command-line switch to GCC to specify a
6240 language explicitly.  For example:
6242 @smallexample
6243 .ZZ:
6244 @@c++
6245 @end smallexample
6247 Says that .ZZ files are, in fact, C++ source files.
6249 @item #@var{name}
6250 This causes an error messages saying:
6252 @smallexample
6253 @var{name} compiler not installed on this system.
6254 @end smallexample
6255 @end table
6257 GCC already has an extensive list of suffixes built into it.
6258 This directive will add an entry to the end of the list of suffixes, but
6259 since the list is searched from the end backwards, it is effectively
6260 possible to override earlier entries using this technique.
6262 @end table
6264 GCC has the following spec strings built into it.  Spec files can
6265 override these strings or create their own.  Note that individual
6266 targets can also add their own spec strings to this list.
6268 @smallexample
6269 asm          Options to pass to the assembler
6270 asm_final    Options to pass to the assembler post-processor
6271 cpp          Options to pass to the C preprocessor
6272 cc1          Options to pass to the C compiler
6273 cc1plus      Options to pass to the C++ compiler
6274 endfile      Object files to include at the end of the link
6275 link         Options to pass to the linker
6276 lib          Libraries to include on the command line to the linker
6277 libgcc       Decides which GCC support library to pass to the linker
6278 linker       Sets the name of the linker
6279 predefines   Defines to be passed to the C preprocessor
6280 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6281              by default
6282 startfile    Object files to include at the start of the link
6283 @end smallexample
6285 Here is a small example of a spec file:
6287 @smallexample
6288 %rename lib                 old_lib
6290 *lib:
6291 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6292 @end smallexample
6294 This example renames the spec called @samp{lib} to @samp{old_lib} and
6295 then overrides the previous definition of @samp{lib} with a new one.
6296 The new definition adds in some extra command-line options before
6297 including the text of the old definition.
6299 @dfn{Spec strings} are a list of command-line options to be passed to their
6300 corresponding program.  In addition, the spec strings can contain
6301 @samp{%}-prefixed sequences to substitute variable text or to
6302 conditionally insert text into the command line.  Using these constructs
6303 it is possible to generate quite complex command lines.
6305 Here is a table of all defined @samp{%}-sequences for spec
6306 strings.  Note that spaces are not generated automatically around the
6307 results of expanding these sequences.  Therefore you can concatenate them
6308 together or combine them with constant text in a single argument.
6310 @table @code
6311 @item %%
6312 Substitute one @samp{%} into the program name or argument.
6314 @item %i
6315 Substitute the name of the input file being processed.
6317 @item %b
6318 Substitute the basename of the input file being processed.
6319 This is the substring up to (and not including) the last period
6320 and not including the directory.
6322 @item %B
6323 This is the same as @samp{%b}, but include the file suffix (text after
6324 the last period).
6326 @item %d
6327 Marks the argument containing or following the @samp{%d} as a
6328 temporary file name, so that that file will be deleted if GCC exits
6329 successfully.  Unlike @samp{%g}, this contributes no text to the
6330 argument.
6332 @item %g@var{suffix}
6333 Substitute a file name that has suffix @var{suffix} and is chosen
6334 once per compilation, and mark the argument in the same way as
6335 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6336 name is now chosen in a way that is hard to predict even when previously
6337 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6338 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6339 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6340 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6341 was simply substituted with a file name chosen once per compilation,
6342 without regard to any appended suffix (which was therefore treated
6343 just like ordinary text), making such attacks more likely to succeed.
6345 @item %u@var{suffix}
6346 Like @samp{%g}, but generates a new temporary file name even if
6347 @samp{%u@var{suffix}} was already seen.
6349 @item %U@var{suffix}
6350 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6351 new one if there is no such last file name.  In the absence of any
6352 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6353 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6354 would involve the generation of two distinct file names, one
6355 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6356 simply substituted with a file name chosen for the previous @samp{%u},
6357 without regard to any appended suffix.
6359 @item %j@var{suffix}
6360 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6361 writable, and if save-temps is off; otherwise, substitute the name
6362 of a temporary file, just like @samp{%u}.  This temporary file is not
6363 meant for communication between processes, but rather as a junk
6364 disposal mechanism.
6366 @item %|@var{suffix}
6367 @itemx %m@var{suffix}
6368 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6369 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6370 all.  These are the two most common ways to instruct a program that it
6371 should read from standard input or write to standard output.  If you
6372 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6373 construct: see for example @file{f/lang-specs.h}.
6375 @item %.@var{SUFFIX}
6376 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6377 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6378 terminated by the next space or %.
6380 @item %w
6381 Marks the argument containing or following the @samp{%w} as the
6382 designated output file of this compilation.  This puts the argument
6383 into the sequence of arguments that @samp{%o} will substitute later.
6385 @item %o
6386 Substitutes the names of all the output files, with spaces
6387 automatically placed around them.  You should write spaces
6388 around the @samp{%o} as well or the results are undefined.
6389 @samp{%o} is for use in the specs for running the linker.
6390 Input files whose names have no recognized suffix are not compiled
6391 at all, but they are included among the output files, so they will
6392 be linked.
6394 @item %O
6395 Substitutes the suffix for object files.  Note that this is
6396 handled specially when it immediately follows @samp{%g, %u, or %U},
6397 because of the need for those to form complete file names.  The
6398 handling is such that @samp{%O} is treated exactly as if it had already
6399 been substituted, except that @samp{%g, %u, and %U} do not currently
6400 support additional @var{suffix} characters following @samp{%O} as they would
6401 following, for example, @samp{.o}.
6403 @item %p
6404 Substitutes the standard macro predefinitions for the
6405 current target machine.  Use this when running @code{cpp}.
6407 @item %P
6408 Like @samp{%p}, but puts @samp{__} before and after the name of each
6409 predefined macro, except for macros that start with @samp{__} or with
6410 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6413 @item %I
6414 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6415 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6416 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6417 as necessary.
6419 @item %s
6420 Current argument is the name of a library or startup file of some sort.
6421 Search for that file in a standard list of directories and substitute
6422 the full name found.
6424 @item %e@var{str}
6425 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6426 Use this when inconsistent options are detected.
6428 @item %(@var{name})
6429 Substitute the contents of spec string @var{name} at this point.
6431 @item %[@var{name}]
6432 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6434 @item %x@{@var{option}@}
6435 Accumulate an option for @samp{%X}.
6437 @item %X
6438 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6439 spec string.
6441 @item %Y
6442 Output the accumulated assembler options specified by @option{-Wa}.
6444 @item %Z
6445 Output the accumulated preprocessor options specified by @option{-Wp}.
6447 @item %a
6448 Process the @code{asm} spec.  This is used to compute the
6449 switches to be passed to the assembler.
6451 @item %A
6452 Process the @code{asm_final} spec.  This is a spec string for
6453 passing switches to an assembler post-processor, if such a program is
6454 needed.
6456 @item %l
6457 Process the @code{link} spec.  This is the spec for computing the
6458 command line passed to the linker.  Typically it will make use of the
6459 @samp{%L %G %S %D and %E} sequences.
6461 @item %D
6462 Dump out a @option{-L} option for each directory that GCC believes might
6463 contain startup files.  If the target supports multilibs then the
6464 current multilib directory will be prepended to each of these paths.
6466 @item %L
6467 Process the @code{lib} spec.  This is a spec string for deciding which
6468 libraries should be included on the command line to the linker.
6470 @item %G
6471 Process the @code{libgcc} spec.  This is a spec string for deciding
6472 which GCC support library should be included on the command line to the linker.
6474 @item %S
6475 Process the @code{startfile} spec.  This is a spec for deciding which
6476 object files should be the first ones passed to the linker.  Typically
6477 this might be a file named @file{crt0.o}.
6479 @item %E
6480 Process the @code{endfile} spec.  This is a spec string that specifies
6481 the last object files that will be passed to the linker.
6483 @item %C
6484 Process the @code{cpp} spec.  This is used to construct the arguments
6485 to be passed to the C preprocessor.
6487 @item %1
6488 Process the @code{cc1} spec.  This is used to construct the options to be
6489 passed to the actual C compiler (@samp{cc1}).
6491 @item %2
6492 Process the @code{cc1plus} spec.  This is used to construct the options to be
6493 passed to the actual C++ compiler (@samp{cc1plus}).
6495 @item %*
6496 Substitute the variable part of a matched option.  See below.
6497 Note that each comma in the substituted string is replaced by
6498 a single space.
6500 @item %<@code{S}
6501 Remove all occurrences of @code{-S} from the command line.  Note---this
6502 command is position dependent.  @samp{%} commands in the spec string
6503 before this one will see @code{-S}, @samp{%} commands in the spec string
6504 after this one will not.
6506 @item %:@var{function}(@var{args})
6507 Call the named function @var{function}, passing it @var{args}.
6508 @var{args} is first processed as a nested spec string, then split
6509 into an argument vector in the usual fashion.  The function returns
6510 a string which is processed as if it had appeared literally as part
6511 of the current spec.
6513 The following built-in spec functions are provided:
6515 @table @code
6516 @item @code{if-exists}
6517 The @code{if-exists} spec function takes one argument, an absolute
6518 pathname to a file.  If the file exists, @code{if-exists} returns the
6519 pathname.  Here is a small example of its usage:
6521 @smallexample
6522 *startfile:
6523 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6524 @end smallexample
6526 @item @code{if-exists-else}
6527 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6528 spec function, except that it takes two arguments.  The first argument is
6529 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6530 returns the pathname.  If it does not exist, it returns the second argument.
6531 This way, @code{if-exists-else} can be used to select one file or another,
6532 based on the existence of the first.  Here is a small example of its usage:
6534 @smallexample
6535 *startfile:
6536 crt0%O%s %:if-exists(crti%O%s) \
6537 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6538 @end smallexample
6540 @item @code{replace-outfile}
6541 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6542 first argument in the outfiles array and replaces it with the second argument.  Here
6543 is a small example of its usage:
6545 @smallexample
6546 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6547 @end smallexample
6549 @end table
6551 @item %@{@code{S}@}
6552 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6553 If that switch was not specified, this substitutes nothing.  Note that
6554 the leading dash is omitted when specifying this option, and it is
6555 automatically inserted if the substitution is performed.  Thus the spec
6556 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6557 and would output the command line option @option{-foo}.
6559 @item %W@{@code{S}@}
6560 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6561 deleted on failure.
6563 @item %@{@code{S}*@}
6564 Substitutes all the switches specified to GCC whose names start
6565 with @code{-S}, but which also take an argument.  This is used for
6566 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6567 GCC considers @option{-o foo} as being
6568 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6569 text, including the space.  Thus two arguments would be generated.
6571 @item %@{@code{S}*&@code{T}*@}
6572 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6573 (the order of @code{S} and @code{T} in the spec is not significant).
6574 There can be any number of ampersand-separated variables; for each the
6575 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6577 @item %@{@code{S}:@code{X}@}
6578 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6580 @item %@{!@code{S}:@code{X}@}
6581 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6583 @item %@{@code{S}*:@code{X}@}
6584 Substitutes @code{X} if one or more switches whose names start with
6585 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6586 once, no matter how many such switches appeared.  However, if @code{%*}
6587 appears somewhere in @code{X}, then @code{X} will be substituted once
6588 for each matching switch, with the @code{%*} replaced by the part of
6589 that switch that matched the @code{*}.
6591 @item %@{.@code{S}:@code{X}@}
6592 Substitutes @code{X}, if processing a file with suffix @code{S}.
6594 @item %@{!.@code{S}:@code{X}@}
6595 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6597 @item %@{@code{S}|@code{P}:@code{X}@}
6598 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6599 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6600 although they have a stronger binding than the @samp{|}.  If @code{%*}
6601 appears in @code{X}, all of the alternatives must be starred, and only
6602 the first matching alternative is substituted.
6604 For example, a spec string like this:
6606 @smallexample
6607 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6608 @end smallexample
6610 will output the following command-line options from the following input
6611 command-line options:
6613 @smallexample
6614 fred.c        -foo -baz
6615 jim.d         -bar -boggle
6616 -d fred.c     -foo -baz -boggle
6617 -d jim.d      -bar -baz -boggle
6618 @end smallexample
6620 @item %@{S:X; T:Y; :D@}
6622 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6623 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6624 be as many clauses as you need.  This may be combined with @code{.},
6625 @code{!}, @code{|}, and @code{*} as needed.
6628 @end table
6630 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6631 construct may contain other nested @samp{%} constructs or spaces, or
6632 even newlines.  They are processed as usual, as described above.
6633 Trailing white space in @code{X} is ignored.  White space may also
6634 appear anywhere on the left side of the colon in these constructs,
6635 except between @code{.} or @code{*} and the corresponding word.
6637 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6638 handled specifically in these constructs.  If another value of
6639 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6640 @option{-W} switch is found later in the command line, the earlier
6641 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6642 just one letter, which passes all matching options.
6644 The character @samp{|} at the beginning of the predicate text is used to
6645 indicate that a command should be piped to the following command, but
6646 only if @option{-pipe} is specified.
6648 It is built into GCC which switches take arguments and which do not.
6649 (You might think it would be useful to generalize this to allow each
6650 compiler's spec to say which switches take arguments.  But this cannot
6651 be done in a consistent fashion.  GCC cannot even decide which input
6652 files have been specified without knowing which switches take arguments,
6653 and it must know which input files to compile in order to tell which
6654 compilers to run).
6656 GCC also knows implicitly that arguments starting in @option{-l} are to be
6657 treated as compiler output files, and passed to the linker in their
6658 proper position among the other output files.
6660 @c man begin OPTIONS
6662 @node Target Options
6663 @section Specifying Target Machine and Compiler Version
6664 @cindex target options
6665 @cindex cross compiling
6666 @cindex specifying machine version
6667 @cindex specifying compiler version and target machine
6668 @cindex compiler version, specifying
6669 @cindex target machine, specifying
6671 The usual way to run GCC is to run the executable called @file{gcc}, or
6672 @file{<machine>-gcc} when cross-compiling, or
6673 @file{<machine>-gcc-<version>} to run a version other than the one that
6674 was installed last.  Sometimes this is inconvenient, so GCC provides
6675 options that will switch to another cross-compiler or version.
6677 @table @gcctabopt
6678 @item -b @var{machine}
6679 @opindex b
6680 The argument @var{machine} specifies the target machine for compilation.
6682 The value to use for @var{machine} is the same as was specified as the
6683 machine type when configuring GCC as a cross-compiler.  For
6684 example, if a cross-compiler was configured with @samp{configure
6685 i386v}, meaning to compile for an 80386 running System V, then you
6686 would specify @option{-b i386v} to run that cross compiler.
6688 @item -V @var{version}
6689 @opindex V
6690 The argument @var{version} specifies which version of GCC to run.
6691 This is useful when multiple versions are installed.  For example,
6692 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6693 @end table
6695 The @option{-V} and @option{-b} options work by running the
6696 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6697 use them if you can just run that directly.
6699 @node Submodel Options
6700 @section Hardware Models and Configurations
6701 @cindex submodel options
6702 @cindex specifying hardware config
6703 @cindex hardware models and configurations, specifying
6704 @cindex machine dependent options
6706 Earlier we discussed the standard option @option{-b} which chooses among
6707 different installed compilers for completely different target
6708 machines, such as VAX vs.@: 68000 vs.@: 80386.
6710 In addition, each of these target machine types can have its own
6711 special options, starting with @samp{-m}, to choose among various
6712 hardware models or configurations---for example, 68010 vs 68020,
6713 floating coprocessor or none.  A single installed version of the
6714 compiler can compile for any model or configuration, according to the
6715 options specified.
6717 Some configurations of the compiler also support additional special
6718 options, usually for compatibility with other compilers on the same
6719 platform.
6721 These options are defined by the macro @code{TARGET_SWITCHES} in the
6722 machine description.  The default for the options is also defined by
6723 that macro, which enables you to change the defaults.
6725 @c This list is ordered alphanumerically by subsection name.
6726 @c It should be the same order and spelling as these options are listed
6727 @c in Machine Dependent Options
6729 @menu
6730 * ARC Options::
6731 * ARM Options::
6732 * AVR Options::
6733 * CRIS Options::
6734 * Darwin Options::
6735 * DEC Alpha Options::
6736 * DEC Alpha/VMS Options::
6737 * FRV Options::
6738 * H8/300 Options::
6739 * HPPA Options::
6740 * i386 and x86-64 Options::
6741 * IA-64 Options::
6742 * M32R/D Options::
6743 * M680x0 Options::
6744 * M68hc1x Options::
6745 * MCore Options::
6746 * MIPS Options::
6747 * MMIX Options::
6748 * MN10300 Options::
6749 * NS32K Options::
6750 * PDP-11 Options::
6751 * PowerPC Options::
6752 * RS/6000 and PowerPC Options::
6753 * S/390 and zSeries Options::
6754 * SH Options::
6755 * SPARC Options::
6756 * System V Options::
6757 * TMS320C3x/C4x Options::
6758 * V850 Options::
6759 * VAX Options::
6760 * x86-64 Options::
6761 * Xstormy16 Options::
6762 * Xtensa Options::
6763 * zSeries Options::
6764 @end menu
6766 @node ARC Options
6767 @subsection ARC Options
6768 @cindex ARC Options
6770 These options are defined for ARC implementations:
6772 @table @gcctabopt
6773 @item -EL
6774 @opindex EL
6775 Compile code for little endian mode.  This is the default.
6777 @item -EB
6778 @opindex EB
6779 Compile code for big endian mode.
6781 @item -mmangle-cpu
6782 @opindex mmangle-cpu
6783 Prepend the name of the cpu to all public symbol names.
6784 In multiple-processor systems, there are many ARC variants with different
6785 instruction and register set characteristics.  This flag prevents code
6786 compiled for one cpu to be linked with code compiled for another.
6787 No facility exists for handling variants that are ``almost identical''.
6788 This is an all or nothing option.
6790 @item -mcpu=@var{cpu}
6791 @opindex mcpu
6792 Compile code for ARC variant @var{cpu}.
6793 Which variants are supported depend on the configuration.
6794 All variants support @option{-mcpu=base}, this is the default.
6796 @item -mtext=@var{text-section}
6797 @itemx -mdata=@var{data-section}
6798 @itemx -mrodata=@var{readonly-data-section}
6799 @opindex mtext
6800 @opindex mdata
6801 @opindex mrodata
6802 Put functions, data, and readonly data in @var{text-section},
6803 @var{data-section}, and @var{readonly-data-section} respectively
6804 by default.  This can be overridden with the @code{section} attribute.
6805 @xref{Variable Attributes}.
6807 @end table
6809 @node ARM Options
6810 @subsection ARM Options
6811 @cindex ARM options
6813 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6814 architectures:
6816 @table @gcctabopt
6817 @item -mabi=@var{name}
6818 @opindex mabi
6819 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6820 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6822 @item -mapcs-frame
6823 @opindex mapcs-frame
6824 Generate a stack frame that is compliant with the ARM Procedure Call
6825 Standard for all functions, even if this is not strictly necessary for
6826 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6827 with this option will cause the stack frames not to be generated for
6828 leaf functions.  The default is @option{-mno-apcs-frame}.
6830 @item -mapcs
6831 @opindex mapcs
6832 This is a synonym for @option{-mapcs-frame}.
6834 @ignore
6835 @c not currently implemented
6836 @item -mapcs-stack-check
6837 @opindex mapcs-stack-check
6838 Generate code to check the amount of stack space available upon entry to
6839 every function (that actually uses some stack space).  If there is
6840 insufficient space available then either the function
6841 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6842 called, depending upon the amount of stack space required.  The run time
6843 system is required to provide these functions.  The default is
6844 @option{-mno-apcs-stack-check}, since this produces smaller code.
6846 @c not currently implemented
6847 @item -mapcs-float
6848 @opindex mapcs-float
6849 Pass floating point arguments using the float point registers.  This is
6850 one of the variants of the APCS@.  This option is recommended if the
6851 target hardware has a floating point unit or if a lot of floating point
6852 arithmetic is going to be performed by the code.  The default is
6853 @option{-mno-apcs-float}, since integer only code is slightly increased in
6854 size if @option{-mapcs-float} is used.
6856 @c not currently implemented
6857 @item -mapcs-reentrant
6858 @opindex mapcs-reentrant
6859 Generate reentrant, position independent code.  The default is
6860 @option{-mno-apcs-reentrant}.
6861 @end ignore
6863 @item -mthumb-interwork
6864 @opindex mthumb-interwork
6865 Generate code which supports calling between the ARM and Thumb
6866 instruction sets.  Without this option the two instruction sets cannot
6867 be reliably used inside one program.  The default is
6868 @option{-mno-thumb-interwork}, since slightly larger code is generated
6869 when @option{-mthumb-interwork} is specified.
6871 @item -mno-sched-prolog
6872 @opindex mno-sched-prolog
6873 Prevent the reordering of instructions in the function prolog, or the
6874 merging of those instruction with the instructions in the function's
6875 body.  This means that all functions will start with a recognizable set
6876 of instructions (or in fact one of a choice from a small set of
6877 different function prologues), and this information can be used to
6878 locate the start if functions inside an executable piece of code.  The
6879 default is @option{-msched-prolog}.
6881 @item -mhard-float
6882 @opindex mhard-float
6883 Generate output containing floating point instructions.  This is the
6884 default.
6886 @item -msoft-float
6887 @opindex msoft-float
6888 Generate output containing library calls for floating point.
6889 @strong{Warning:} the requisite libraries are not available for all ARM
6890 targets.  Normally the facilities of the machine's usual C compiler are
6891 used, but this cannot be done directly in cross-compilation.  You must make
6892 your own arrangements to provide suitable library functions for
6893 cross-compilation.
6895 @option{-msoft-float} changes the calling convention in the output file;
6896 therefore, it is only useful if you compile @emph{all} of a program with
6897 this option.  In particular, you need to compile @file{libgcc.a}, the
6898 library that comes with GCC, with @option{-msoft-float} in order for
6899 this to work.
6901 @item -mfloat-abi=@var{name}
6902 @opindex mfloat-abi
6903 Specifies which ABI to use for floating point values.  Permissible values
6904 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6906 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6907 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6908 of floating point instructions, but still uses the soft-float calling
6909 conventions.
6911 @item -mlittle-endian
6912 @opindex mlittle-endian
6913 Generate code for a processor running in little-endian mode.  This is
6914 the default for all standard configurations.
6916 @item -mbig-endian
6917 @opindex mbig-endian
6918 Generate code for a processor running in big-endian mode; the default is
6919 to compile code for a little-endian processor.
6921 @item -mwords-little-endian
6922 @opindex mwords-little-endian
6923 This option only applies when generating code for big-endian processors.
6924 Generate code for a little-endian word order but a big-endian byte
6925 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6926 option should only be used if you require compatibility with code for
6927 big-endian ARM processors generated by versions of the compiler prior to
6928 2.8.
6930 @item -mcpu=@var{name}
6931 @opindex mcpu
6932 This specifies the name of the target ARM processor.  GCC uses this name
6933 to determine what kind of instructions it can emit when generating
6934 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6935 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6936 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6937 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6938 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6939 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6940 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6941 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6942 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6943 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6944 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6945 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6946 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6947 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6948 @samp{ep9312}.
6950 @itemx -mtune=@var{name}
6951 @opindex mtune
6952 This option is very similar to the @option{-mcpu=} option, except that
6953 instead of specifying the actual target processor type, and hence
6954 restricting which instructions can be used, it specifies that GCC should
6955 tune the performance of the code as if the target were of the type
6956 specified in this option, but still choosing the instructions that it
6957 will generate based on the cpu specified by a @option{-mcpu=} option.
6958 For some ARM implementations better performance can be obtained by using
6959 this option.
6961 @item -march=@var{name}
6962 @opindex march
6963 This specifies the name of the target ARM architecture.  GCC uses this
6964 name to determine what kind of instructions it can emit when generating
6965 assembly code.  This option can be used in conjunction with or instead
6966 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6967 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6968 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6969 @samp{iwmmxt}, @samp{ep9312}.
6971 @item -mfpu=@var{name}
6972 @itemx -mfpe=@var{number}
6973 @itemx -mfp=@var{number}
6974 @opindex mfpu
6975 @opindex mfpe
6976 @opindex mfp
6977 This specifies what floating point hardware (or hardware emulation) is
6978 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6979 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6980 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6981 with older versions of GCC@.
6983 If @option{-msoft-float} is specified this specifies the format of
6984 floating point values.
6986 @item -mstructure-size-boundary=@var{n}
6987 @opindex mstructure-size-boundary
6988 The size of all structures and unions will be rounded up to a multiple
6989 of the number of bits set by this option.  Permissible values are 8, 32
6990 and 64.  The default value varies for different toolchains.  For the COFF
6991 targeted toolchain the default value is 8.  A value of 64 is only allowed
6992 if the underlying ABI supports it.
6994 Specifying the larger number can produce faster, more efficient code, but
6995 can also increase the size of the program.  Different values are potentially
6996 incompatible.  Code compiled with one value cannot necessarily expect to
6997 work with code or libraries compiled with another value, if they exchange
6998 information using structures or unions.
7000 @item -mabort-on-noreturn
7001 @opindex mabort-on-noreturn
7002 Generate a call to the function @code{abort} at the end of a
7003 @code{noreturn} function.  It will be executed if the function tries to
7004 return.
7006 @item -mlong-calls
7007 @itemx -mno-long-calls
7008 @opindex mlong-calls
7009 @opindex mno-long-calls
7010 Tells the compiler to perform function calls by first loading the
7011 address of the function into a register and then performing a subroutine
7012 call on this register.  This switch is needed if the target function
7013 will lie outside of the 64 megabyte addressing range of the offset based
7014 version of subroutine call instruction.
7016 Even if this switch is enabled, not all function calls will be turned
7017 into long calls.  The heuristic is that static functions, functions
7018 which have the @samp{short-call} attribute, functions that are inside
7019 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7020 definitions have already been compiled within the current compilation
7021 unit, will not be turned into long calls.  The exception to this rule is
7022 that weak function definitions, functions with the @samp{long-call}
7023 attribute or the @samp{section} attribute, and functions that are within
7024 the scope of a @samp{#pragma long_calls} directive, will always be
7025 turned into long calls.
7027 This feature is not enabled by default.  Specifying
7028 @option{-mno-long-calls} will restore the default behavior, as will
7029 placing the function calls within the scope of a @samp{#pragma
7030 long_calls_off} directive.  Note these switches have no effect on how
7031 the compiler generates code to handle function calls via function
7032 pointers.
7034 @item -mnop-fun-dllimport
7035 @opindex mnop-fun-dllimport
7036 Disable support for the @code{dllimport} attribute.
7038 @item -msingle-pic-base
7039 @opindex msingle-pic-base
7040 Treat the register used for PIC addressing as read-only, rather than
7041 loading it in the prologue for each function.  The run-time system is
7042 responsible for initializing this register with an appropriate value
7043 before execution begins.
7045 @item -mpic-register=@var{reg}
7046 @opindex mpic-register
7047 Specify the register to be used for PIC addressing.  The default is R10
7048 unless stack-checking is enabled, when R9 is used.
7050 @item -mcirrus-fix-invalid-insns
7051 @opindex mcirrus-fix-invalid-insns
7052 @opindex mno-cirrus-fix-invalid-insns
7053 Insert NOPs into the instruction stream to in order to work around
7054 problems with invalid Maverick instruction combinations.  This option
7055 is only valid if the @option{-mcpu=ep9312} option has been used to
7056 enable generation of instructions for the Cirrus Maverick floating
7057 point co-processor.  This option is not enabled by default, since the
7058 problem is only present in older Maverick implementations.  The default
7059 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7060 switch.
7062 @item -mpoke-function-name
7063 @opindex mpoke-function-name
7064 Write the name of each function into the text section, directly
7065 preceding the function prologue.  The generated code is similar to this:
7067 @smallexample
7068      t0
7069          .ascii "arm_poke_function_name", 0
7070          .align
7071      t1
7072          .word 0xff000000 + (t1 - t0)
7073      arm_poke_function_name
7074          mov     ip, sp
7075          stmfd   sp!, @{fp, ip, lr, pc@}
7076          sub     fp, ip, #4
7077 @end smallexample
7079 When performing a stack backtrace, code can inspect the value of
7080 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7081 location @code{pc - 12} and the top 8 bits are set, then we know that
7082 there is a function name embedded immediately preceding this location
7083 and has length @code{((pc[-3]) & 0xff000000)}.
7085 @item -mthumb
7086 @opindex mthumb
7087 Generate code for the 16-bit Thumb instruction set.  The default is to
7088 use the 32-bit ARM instruction set.
7090 @item -mtpcs-frame
7091 @opindex mtpcs-frame
7092 Generate a stack frame that is compliant with the Thumb Procedure Call
7093 Standard for all non-leaf functions.  (A leaf function is one that does
7094 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7096 @item -mtpcs-leaf-frame
7097 @opindex mtpcs-leaf-frame
7098 Generate a stack frame that is compliant with the Thumb Procedure Call
7099 Standard for all leaf functions.  (A leaf function is one that does
7100 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7102 @item -mcallee-super-interworking
7103 @opindex mcallee-super-interworking
7104 Gives all externally visible functions in the file being compiled an ARM
7105 instruction set header which switches to Thumb mode before executing the
7106 rest of the function.  This allows these functions to be called from
7107 non-interworking code.
7109 @item -mcaller-super-interworking
7110 @opindex mcaller-super-interworking
7111 Allows calls via function pointers (including virtual functions) to
7112 execute correctly regardless of whether the target code has been
7113 compiled for interworking or not.  There is a small overhead in the cost
7114 of executing a function pointer if this option is enabled.
7116 @end table
7118 @node AVR Options
7119 @subsection AVR Options
7120 @cindex AVR Options
7122 These options are defined for AVR implementations:
7124 @table @gcctabopt
7125 @item -mmcu=@var{mcu}
7126 @opindex mmcu
7127 Specify ATMEL AVR instruction set or MCU type.
7129 Instruction set avr1 is for the minimal AVR core, not supported by the C
7130 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7131 attiny11, attiny12, attiny15, attiny28).
7133 Instruction set avr2 (default) is for the classic AVR core with up to
7134 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7135 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7136 at90c8534, at90s8535).
7138 Instruction set avr3 is for the classic AVR core with up to 128K program
7139 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7141 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7142 memory space (MCU types: atmega8, atmega83, atmega85).
7144 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7145 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7146 atmega64, atmega128, at43usb355, at94k).
7148 @item -msize
7149 @opindex msize
7150 Output instruction sizes to the asm file.
7152 @item -minit-stack=@var{N}
7153 @opindex minit-stack
7154 Specify the initial stack address, which may be a symbol or numeric value,
7155 @samp{__stack} is the default.
7157 @item -mno-interrupts
7158 @opindex mno-interrupts
7159 Generated code is not compatible with hardware interrupts.
7160 Code size will be smaller.
7162 @item -mcall-prologues
7163 @opindex mcall-prologues
7164 Functions prologues/epilogues expanded as call to appropriate
7165 subroutines.  Code size will be smaller.
7167 @item -mno-tablejump
7168 @opindex mno-tablejump
7169 Do not generate tablejump insns which sometimes increase code size.
7171 @item -mtiny-stack
7172 @opindex mtiny-stack
7173 Change only the low 8 bits of the stack pointer.
7175 @item -mint8
7176 @opindex mint8
7177 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7178 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7179 and long long will be 4 bytes.  Please note that this option does not
7180 comply to the C standards, but it will provide you with smaller code
7181 size.
7182 @end table
7184 @node CRIS Options
7185 @subsection CRIS Options
7186 @cindex CRIS Options
7188 These options are defined specifically for the CRIS ports.
7190 @table @gcctabopt
7191 @item -march=@var{architecture-type}
7192 @itemx -mcpu=@var{architecture-type}
7193 @opindex march
7194 @opindex mcpu
7195 Generate code for the specified architecture.  The choices for
7196 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7197 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7198 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7199 @samp{v10}.
7201 @item -mtune=@var{architecture-type}
7202 @opindex mtune
7203 Tune to @var{architecture-type} everything applicable about the generated
7204 code, except for the ABI and the set of available instructions.  The
7205 choices for @var{architecture-type} are the same as for
7206 @option{-march=@var{architecture-type}}.
7208 @item -mmax-stack-frame=@var{n}
7209 @opindex mmax-stack-frame
7210 Warn when the stack frame of a function exceeds @var{n} bytes.
7212 @item -melinux-stacksize=@var{n}
7213 @opindex melinux-stacksize
7214 Only available with the @samp{cris-axis-aout} target.  Arranges for
7215 indications in the program to the kernel loader that the stack of the
7216 program should be set to @var{n} bytes.
7218 @item -metrax4
7219 @itemx -metrax100
7220 @opindex metrax4
7221 @opindex metrax100
7222 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7223 @option{-march=v3} and @option{-march=v8} respectively.
7225 @item -mmul-bug-workaround
7226 @itemx -mno-mul-bug-workaround
7227 @opindex mmul-bug-workaround
7228 @opindex mno-mul-bug-workaround
7229 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7230 models where it applies.  This option is active by default.
7232 @item -mpdebug
7233 @opindex mpdebug
7234 Enable CRIS-specific verbose debug-related information in the assembly
7235 code.  This option also has the effect to turn off the @samp{#NO_APP}
7236 formatted-code indicator to the assembler at the beginning of the
7237 assembly file.
7239 @item -mcc-init
7240 @opindex mcc-init
7241 Do not use condition-code results from previous instruction; always emit
7242 compare and test instructions before use of condition codes.
7244 @item -mno-side-effects
7245 @opindex mno-side-effects
7246 Do not emit instructions with side-effects in addressing modes other than
7247 post-increment.
7249 @item -mstack-align
7250 @itemx -mno-stack-align
7251 @itemx -mdata-align
7252 @itemx -mno-data-align
7253 @itemx -mconst-align
7254 @itemx -mno-const-align
7255 @opindex mstack-align
7256 @opindex mno-stack-align
7257 @opindex mdata-align
7258 @opindex mno-data-align
7259 @opindex mconst-align
7260 @opindex mno-const-align
7261 These options (no-options) arranges (eliminate arrangements) for the
7262 stack-frame, individual data and constants to be aligned for the maximum
7263 single data access size for the chosen CPU model.  The default is to
7264 arrange for 32-bit alignment.  ABI details such as structure layout are
7265 not affected by these options.
7267 @item -m32-bit
7268 @itemx -m16-bit
7269 @itemx -m8-bit
7270 @opindex m32-bit
7271 @opindex m16-bit
7272 @opindex m8-bit
7273 Similar to the stack- data- and const-align options above, these options
7274 arrange for stack-frame, writable data and constants to all be 32-bit,
7275 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7277 @item -mno-prologue-epilogue
7278 @itemx -mprologue-epilogue
7279 @opindex mno-prologue-epilogue
7280 @opindex mprologue-epilogue
7281 With @option{-mno-prologue-epilogue}, the normal function prologue and
7282 epilogue that sets up the stack-frame are omitted and no return
7283 instructions or return sequences are generated in the code.  Use this
7284 option only together with visual inspection of the compiled code: no
7285 warnings or errors are generated when call-saved registers must be saved,
7286 or storage for local variable needs to be allocated.
7288 @item -mno-gotplt
7289 @itemx -mgotplt
7290 @opindex mno-gotplt
7291 @opindex mgotplt
7292 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7293 instruction sequences that load addresses for functions from the PLT part
7294 of the GOT rather than (traditional on other architectures) calls to the
7295 PLT@.  The default is @option{-mgotplt}.
7297 @item -maout
7298 @opindex maout
7299 Legacy no-op option only recognized with the cris-axis-aout target.
7301 @item -melf
7302 @opindex melf
7303 Legacy no-op option only recognized with the cris-axis-elf and
7304 cris-axis-linux-gnu targets.
7306 @item -melinux
7307 @opindex melinux
7308 Only recognized with the cris-axis-aout target, where it selects a
7309 GNU/linux-like multilib, include files and instruction set for
7310 @option{-march=v8}.
7312 @item -mlinux
7313 @opindex mlinux
7314 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7316 @item -sim
7317 @opindex sim
7318 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7319 to link with input-output functions from a simulator library.  Code,
7320 initialized data and zero-initialized data are allocated consecutively.
7322 @item -sim2
7323 @opindex sim2
7324 Like @option{-sim}, but pass linker options to locate initialized data at
7325 0x40000000 and zero-initialized data at 0x80000000.
7326 @end table
7328 @node Darwin Options
7329 @subsection Darwin Options
7330 @cindex Darwin options
7332 These options are defined for all architectures running the Darwin operating
7333 system.
7335 FSF GCC on Darwin does not create ``fat'' object files; it will create
7336 an object file for the single architecture that it was built to
7337 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7338 @option{-arch} options are used; it does so by running the compiler or
7339 linker multiple times and joining the results together with
7340 @file{lipo}.
7342 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7343 @samp{i686}) is determined by the flags that specify the ISA
7344 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7345 @option{-force_cpusubtype_ALL} option can be used to override this.
7347 The Darwin tools vary in their behaviour when presented with an ISA
7348 mismatch.  The assembler, @file{as}, will only permit instructions to
7349 be used that are valid for the subtype of the file it is generating,
7350 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7351 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7352 and print an error if asked to create a shared library with a less
7353 restrictive subtype than its input files (for instance, trying to put
7354 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7355 for executables, @file{ld}, will quietly give the executable the most
7356 restrictive subtype of any of its input files.
7358 @table @gcctabopt
7359 @item -F@var{dir}
7360 @opindex F
7361 Add the framework directory @var{dir} to the head of the list of
7362 directories to be searched for header files.  These directories are
7363 interleaved with those specified by @option{-I} options and are
7364 scanned in a left-to-right order.
7366 A framework directory is a directory with frameworks in it.  A
7367 framework is a directory with a @samp{"Headers"} and/or
7368 @samp{"PrivateHeaders"} directory contained directly in it that ends
7369 in @samp{".framework"}.  The name of a framework is the name of this
7370 directory excluding the @samp{".framework"}.  Headers associated with
7371 the framework are found in one of those two directories, with
7372 @samp{"Headers"} being searched first.  A subframework is a framework
7373 directory that is in a framework's @samp{"Frameworks"} directory.
7374 Includes of subframework headers can only appear in a header of a
7375 framework that contains the subframework, or in a sibling subframework
7376 header.  Two subframeworks are siblings if they occur in the same
7377 framework.  A subframework should not have the same name as a
7378 framework, a warning will be issued if this is violated.  Currently a
7379 subframework cannot have subframeworks, in the future, the mechanism
7380 may be extended to support this.  The standard frameworks can be found
7381 in @samp{"/System/Library/Frameworks"} and
7382 @samp{"/Library/Frameworks"}.  An example include looks like
7383 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7384 the name of the framework and header.h is found in the
7385 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7387 @item -gused
7388 @opindex -gused
7389 Emit debugging information for symbols that are used.  For STABS
7390 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7391 This is by default ON@.
7393 @item -gfull
7394 @opindex -gfull
7395 Emit debugging information for all symbols and types.
7397 @item -mone-byte-bool
7398 @opindex -mone-byte-bool
7399 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7400 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7401 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7402 option has no effect on x86.
7404 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7405 to generate code that is not binary compatible with code generated
7406 without that switch.  Using this switch may require recompiling all
7407 other modules in a program, including system libraries.  Use this
7408 switch to conform to a non-default data model.
7410 @item -mfix-and-continue
7411 @itemx -ffix-and-continue
7412 @itemx -findirect-data
7413 @opindex mfix-and-continue
7414 @opindex ffix-and-continue
7415 @opindex findirect-data
7416 Generate code suitable for fast turn around development.  Needed to
7417 enable gdb to dynamically load @code{.o} files into already running
7418 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7419 are provided for backwards compatibility.
7421 @item -all_load
7422 @opindex all_load
7423 Loads all members of static archive libraries.
7424 See man ld(1) for more information.
7426 @item -arch_errors_fatal
7427 @opindex arch_errors_fatal
7428 Cause the errors having to do with files that have the wrong architecture
7429 to be fatal.
7431 @item -bind_at_load
7432 @opindex bind_at_load
7433 Causes the output file to be marked such that the dynamic linker will
7434 bind all undefined references when the file is loaded or launched.
7436 @item -bundle
7437 @opindex bundle
7438 Produce a Mach-o bundle format file.
7439 See man ld(1) for more information.
7441 @item -bundle_loader @var{executable}
7442 @opindex bundle_loader
7443 This option specifies the @var{executable} that will be loading the build
7444 output file being linked.  See man ld(1) for more information.
7446 @item -dynamiclib
7447 @opindex -dynamiclib
7448 When passed this option, GCC will produce a dynamic library instead of
7449 an executable when linking, using the Darwin @file{libtool} command.
7451 @item -force_cpusubtype_ALL
7452 @opindex -force_cpusubtype_ALL
7453 This causes GCC's output file to have the @var{ALL} subtype, instead of
7454 one controlled by the @option{-mcpu} or @option{-march} option.
7456 @item -allowable_client  @var{client_name}
7457 @itemx -client_name
7458 @itemx -compatibility_version
7459 @itemx -current_version
7460 @itemx -dead_strip
7461 @itemx -dependency-file
7462 @itemx -dylib_file
7463 @itemx -dylinker_install_name
7464 @itemx -dynamic
7465 @itemx -exported_symbols_list
7466 @itemx -filelist
7467 @itemx -flat_namespace
7468 @itemx -force_flat_namespace
7469 @itemx -headerpad_max_install_names
7470 @itemx -image_base
7471 @itemx -init
7472 @itemx -install_name
7473 @itemx -keep_private_externs
7474 @itemx -multi_module
7475 @itemx -multiply_defined
7476 @itemx -multiply_defined_unused
7477 @itemx -noall_load
7478 @itemx -no_dead_strip_inits_and_terms
7479 @itemx -nofixprebinding
7480 @itemx -nomultidefs
7481 @itemx -noprebind
7482 @itemx -noseglinkedit
7483 @itemx -pagezero_size
7484 @itemx -prebind
7485 @itemx -prebind_all_twolevel_modules
7486 @itemx -private_bundle
7487 @itemx -read_only_relocs
7488 @itemx -sectalign
7489 @itemx -sectobjectsymbols
7490 @itemx -whyload
7491 @itemx -seg1addr
7492 @itemx -sectcreate
7493 @itemx -sectobjectsymbols
7494 @itemx -sectorder
7495 @itemx -segaddr
7496 @itemx -segs_read_only_addr
7497 @itemx -segs_read_write_addr
7498 @itemx -seg_addr_table
7499 @itemx -seg_addr_table_filename
7500 @itemx -seglinkedit
7501 @itemx -segprot
7502 @itemx -segs_read_only_addr
7503 @itemx -segs_read_write_addr
7504 @itemx -single_module
7505 @itemx -static
7506 @itemx -sub_library
7507 @itemx -sub_umbrella
7508 @itemx -twolevel_namespace
7509 @itemx -umbrella
7510 @itemx -undefined
7511 @itemx -unexported_symbols_list
7512 @itemx -weak_reference_mismatches
7513 @itemx -whatsloaded
7515 @opindex allowable_client
7516 @opindex client_name
7517 @opindex compatibility_version
7518 @opindex current_version
7519 @opindex dead_strip
7520 @opindex dependency-file
7521 @opindex dylib_file
7522 @opindex dylinker_install_name
7523 @opindex dynamic
7524 @opindex exported_symbols_list
7525 @opindex filelist
7526 @opindex flat_namespace
7527 @opindex force_flat_namespace
7528 @opindex headerpad_max_install_names
7529 @opindex image_base
7530 @opindex init
7531 @opindex install_name
7532 @opindex keep_private_externs
7533 @opindex multi_module
7534 @opindex multiply_defined
7535 @opindex multiply_defined_unused
7536 @opindex noall_load
7537 @opindex no_dead_strip_inits_and_terms
7538 @opindex nofixprebinding
7539 @opindex nomultidefs
7540 @opindex noprebind
7541 @opindex noseglinkedit
7542 @opindex pagezero_size
7543 @opindex prebind
7544 @opindex prebind_all_twolevel_modules
7545 @opindex private_bundle
7546 @opindex read_only_relocs
7547 @opindex sectalign
7548 @opindex sectobjectsymbols
7549 @opindex whyload
7550 @opindex seg1addr
7551 @opindex sectcreate
7552 @opindex sectobjectsymbols
7553 @opindex sectorder
7554 @opindex segaddr
7555 @opindex segs_read_only_addr
7556 @opindex segs_read_write_addr
7557 @opindex seg_addr_table
7558 @opindex seg_addr_table_filename
7559 @opindex seglinkedit
7560 @opindex segprot
7561 @opindex segs_read_only_addr
7562 @opindex segs_read_write_addr
7563 @opindex single_module
7564 @opindex static
7565 @opindex sub_library
7566 @opindex sub_umbrella
7567 @opindex twolevel_namespace
7568 @opindex umbrella
7569 @opindex undefined
7570 @opindex unexported_symbols_list
7571 @opindex weak_reference_mismatches
7572 @opindex whatsloaded
7574 These options are passed to the Darwin linker.  The Darwin linker man page
7575 describes them in detail.
7576 @end table
7578 @node DEC Alpha Options
7579 @subsection DEC Alpha Options
7581 These @samp{-m} options are defined for the DEC Alpha implementations:
7583 @table @gcctabopt
7584 @item -mno-soft-float
7585 @itemx -msoft-float
7586 @opindex mno-soft-float
7587 @opindex msoft-float
7588 Use (do not use) the hardware floating-point instructions for
7589 floating-point operations.  When @option{-msoft-float} is specified,
7590 functions in @file{libgcc.a} will be used to perform floating-point
7591 operations.  Unless they are replaced by routines that emulate the
7592 floating-point operations, or compiled in such a way as to call such
7593 emulations routines, these routines will issue floating-point
7594 operations.   If you are compiling for an Alpha without floating-point
7595 operations, you must ensure that the library is built so as not to call
7596 them.
7598 Note that Alpha implementations without floating-point operations are
7599 required to have floating-point registers.
7601 @item -mfp-reg
7602 @itemx -mno-fp-regs
7603 @opindex mfp-reg
7604 @opindex mno-fp-regs
7605 Generate code that uses (does not use) the floating-point register set.
7606 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7607 register set is not used, floating point operands are passed in integer
7608 registers as if they were integers and floating-point results are passed
7609 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7610 so any function with a floating-point argument or return value called by code
7611 compiled with @option{-mno-fp-regs} must also be compiled with that
7612 option.
7614 A typical use of this option is building a kernel that does not use,
7615 and hence need not save and restore, any floating-point registers.
7617 @item -mieee
7618 @opindex mieee
7619 The Alpha architecture implements floating-point hardware optimized for
7620 maximum performance.  It is mostly compliant with the IEEE floating
7621 point standard.  However, for full compliance, software assistance is
7622 required.  This option generates code fully IEEE compliant code
7623 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7624 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7625 defined during compilation.  The resulting code is less efficient but is
7626 able to correctly support denormalized numbers and exceptional IEEE
7627 values such as not-a-number and plus/minus infinity.  Other Alpha
7628 compilers call this option @option{-ieee_with_no_inexact}.
7630 @item -mieee-with-inexact
7631 @opindex mieee-with-inexact
7632 This is like @option{-mieee} except the generated code also maintains
7633 the IEEE @var{inexact-flag}.  Turning on this option causes the
7634 generated code to implement fully-compliant IEEE math.  In addition to
7635 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7636 macro.  On some Alpha implementations the resulting code may execute
7637 significantly slower than the code generated by default.  Since there is
7638 very little code that depends on the @var{inexact-flag}, you should
7639 normally not specify this option.  Other Alpha compilers call this
7640 option @option{-ieee_with_inexact}.
7642 @item -mfp-trap-mode=@var{trap-mode}
7643 @opindex mfp-trap-mode
7644 This option controls what floating-point related traps are enabled.
7645 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7646 The trap mode can be set to one of four values:
7648 @table @samp
7649 @item n
7650 This is the default (normal) setting.  The only traps that are enabled
7651 are the ones that cannot be disabled in software (e.g., division by zero
7652 trap).
7654 @item u
7655 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7656 as well.
7658 @item su
7659 Like @samp{su}, but the instructions are marked to be safe for software
7660 completion (see Alpha architecture manual for details).
7662 @item sui
7663 Like @samp{su}, but inexact traps are enabled as well.
7664 @end table
7666 @item -mfp-rounding-mode=@var{rounding-mode}
7667 @opindex mfp-rounding-mode
7668 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7669 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7672 @table @samp
7673 @item n
7674 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7675 the nearest machine number or towards the even machine number in case
7676 of a tie.
7678 @item m
7679 Round towards minus infinity.
7681 @item c
7682 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7684 @item d
7685 Dynamic rounding mode.  A field in the floating point control register
7686 (@var{fpcr}, see Alpha architecture reference manual) controls the
7687 rounding mode in effect.  The C library initializes this register for
7688 rounding towards plus infinity.  Thus, unless your program modifies the
7689 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7690 @end table
7692 @item -mtrap-precision=@var{trap-precision}
7693 @opindex mtrap-precision
7694 In the Alpha architecture, floating point traps are imprecise.  This
7695 means without software assistance it is impossible to recover from a
7696 floating trap and program execution normally needs to be terminated.
7697 GCC can generate code that can assist operating system trap handlers
7698 in determining the exact location that caused a floating point trap.
7699 Depending on the requirements of an application, different levels of
7700 precisions can be selected:
7702 @table @samp
7703 @item p
7704 Program precision.  This option is the default and means a trap handler
7705 can only identify which program caused a floating point exception.
7707 @item f
7708 Function precision.  The trap handler can determine the function that
7709 caused a floating point exception.
7711 @item i
7712 Instruction precision.  The trap handler can determine the exact
7713 instruction that caused a floating point exception.
7714 @end table
7716 Other Alpha compilers provide the equivalent options called
7717 @option{-scope_safe} and @option{-resumption_safe}.
7719 @item -mieee-conformant
7720 @opindex mieee-conformant
7721 This option marks the generated code as IEEE conformant.  You must not
7722 use this option unless you also specify @option{-mtrap-precision=i} and either
7723 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7724 is to emit the line @samp{.eflag 48} in the function prologue of the
7725 generated assembly file.  Under DEC Unix, this has the effect that
7726 IEEE-conformant math library routines will be linked in.
7728 @item -mbuild-constants
7729 @opindex mbuild-constants
7730 Normally GCC examines a 32- or 64-bit integer constant to
7731 see if it can construct it from smaller constants in two or three
7732 instructions.  If it cannot, it will output the constant as a literal and
7733 generate code to load it from the data segment at runtime.
7735 Use this option to require GCC to construct @emph{all} integer constants
7736 using code, even if it takes more instructions (the maximum is six).
7738 You would typically use this option to build a shared library dynamic
7739 loader.  Itself a shared library, it must relocate itself in memory
7740 before it can find the variables and constants in its own data segment.
7742 @item -malpha-as
7743 @itemx -mgas
7744 @opindex malpha-as
7745 @opindex mgas
7746 Select whether to generate code to be assembled by the vendor-supplied
7747 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7749 @item -mbwx
7750 @itemx -mno-bwx
7751 @itemx -mcix
7752 @itemx -mno-cix
7753 @itemx -mfix
7754 @itemx -mno-fix
7755 @itemx -mmax
7756 @itemx -mno-max
7757 @opindex mbwx
7758 @opindex mno-bwx
7759 @opindex mcix
7760 @opindex mno-cix
7761 @opindex mfix
7762 @opindex mno-fix
7763 @opindex mmax
7764 @opindex mno-max
7765 Indicate whether GCC should generate code to use the optional BWX,
7766 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7767 sets supported by the CPU type specified via @option{-mcpu=} option or that
7768 of the CPU on which GCC was built if none was specified.
7770 @item -mfloat-vax
7771 @itemx -mfloat-ieee
7772 @opindex mfloat-vax
7773 @opindex mfloat-ieee
7774 Generate code that uses (does not use) VAX F and G floating point
7775 arithmetic instead of IEEE single and double precision.
7777 @item -mexplicit-relocs
7778 @itemx -mno-explicit-relocs
7779 @opindex mexplicit-relocs
7780 @opindex mno-explicit-relocs
7781 Older Alpha assemblers provided no way to generate symbol relocations
7782 except via assembler macros.  Use of these macros does not allow
7783 optimal instruction scheduling.  GNU binutils as of version 2.12
7784 supports a new syntax that allows the compiler to explicitly mark
7785 which relocations should apply to which instructions.  This option
7786 is mostly useful for debugging, as GCC detects the capabilities of
7787 the assembler when it is built and sets the default accordingly.
7789 @item -msmall-data
7790 @itemx -mlarge-data
7791 @opindex msmall-data
7792 @opindex mlarge-data
7793 When @option{-mexplicit-relocs} is in effect, static data is
7794 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7795 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7796 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7797 16-bit relocations off of the @code{$gp} register.  This limits the
7798 size of the small data area to 64KB, but allows the variables to be
7799 directly accessed via a single instruction.
7801 The default is @option{-mlarge-data}.  With this option the data area
7802 is limited to just below 2GB@.  Programs that require more than 2GB of
7803 data must use @code{malloc} or @code{mmap} to allocate the data in the
7804 heap instead of in the program's data segment.
7806 When generating code for shared libraries, @option{-fpic} implies
7807 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7809 @item -msmall-text
7810 @itemx -mlarge-text
7811 @opindex msmall-text
7812 @opindex mlarge-text
7813 When @option{-msmall-text} is used, the compiler assumes that the
7814 code of the entire program (or shared library) fits in 4MB, and is
7815 thus reachable with a branch instruction.  When @option{-msmall-data}
7816 is used, the compiler can assume that all local symbols share the
7817 same @code{$gp} value, and thus reduce the number of instructions
7818 required for a function call from 4 to 1.
7820 The default is @option{-mlarge-text}.
7822 @item -mcpu=@var{cpu_type}
7823 @opindex mcpu
7824 Set the instruction set and instruction scheduling parameters for
7825 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7826 style name or the corresponding chip number.  GCC supports scheduling
7827 parameters for the EV4, EV5 and EV6 family of processors and will
7828 choose the default values for the instruction set from the processor
7829 you specify.  If you do not specify a processor type, GCC will default
7830 to the processor on which the compiler was built.
7832 Supported values for @var{cpu_type} are
7834 @table @samp
7835 @item ev4
7836 @itemx ev45
7837 @itemx 21064
7838 Schedules as an EV4 and has no instruction set extensions.
7840 @item ev5
7841 @itemx 21164
7842 Schedules as an EV5 and has no instruction set extensions.
7844 @item ev56
7845 @itemx 21164a
7846 Schedules as an EV5 and supports the BWX extension.
7848 @item pca56
7849 @itemx 21164pc
7850 @itemx 21164PC
7851 Schedules as an EV5 and supports the BWX and MAX extensions.
7853 @item ev6
7854 @itemx 21264
7855 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7857 @item ev67
7858 @itemx 21264a
7859 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7860 @end table
7862 @item -mtune=@var{cpu_type}
7863 @opindex mtune
7864 Set only the instruction scheduling parameters for machine type
7865 @var{cpu_type}.  The instruction set is not changed.
7867 @item -mmemory-latency=@var{time}
7868 @opindex mmemory-latency
7869 Sets the latency the scheduler should assume for typical memory
7870 references as seen by the application.  This number is highly
7871 dependent on the memory access patterns used by the application
7872 and the size of the external cache on the machine.
7874 Valid options for @var{time} are
7876 @table @samp
7877 @item @var{number}
7878 A decimal number representing clock cycles.
7880 @item L1
7881 @itemx L2
7882 @itemx L3
7883 @itemx main
7884 The compiler contains estimates of the number of clock cycles for
7885 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7886 (also called Dcache, Scache, and Bcache), as well as to main memory.
7887 Note that L3 is only valid for EV5.
7889 @end table
7890 @end table
7892 @node DEC Alpha/VMS Options
7893 @subsection DEC Alpha/VMS Options
7895 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7897 @table @gcctabopt
7898 @item -mvms-return-codes
7899 @opindex mvms-return-codes
7900 Return VMS condition codes from main.  The default is to return POSIX
7901 style condition (e.g.@ error) codes.
7902 @end table
7904 @node FRV Options
7905 @subsection FRV Options
7906 @cindex FRV Options
7908 @table @gcctabopt
7909 @item -mgpr-32
7910 @opindex mgpr-32
7912 Only use the first 32 general purpose registers.
7914 @item -mgpr-64
7915 @opindex mgpr-64
7917 Use all 64 general purpose registers.
7919 @item -mfpr-32
7920 @opindex mfpr-32
7922 Use only the first 32 floating point registers.
7924 @item -mfpr-64
7925 @opindex mfpr-64
7927 Use all 64 floating point registers
7929 @item -mhard-float
7930 @opindex mhard-float
7932 Use hardware instructions for floating point operations.
7934 @item -msoft-float
7935 @opindex msoft-float
7937 Use library routines for floating point operations.
7939 @item -malloc-cc
7940 @opindex malloc-cc
7942 Dynamically allocate condition code registers.
7944 @item -mfixed-cc
7945 @opindex mfixed-cc
7947 Do not try to dynamically allocate condition code registers, only
7948 use @code{icc0} and @code{fcc0}.
7950 @item -mdword
7951 @opindex mdword
7953 Change ABI to use double word insns.
7955 @item -mno-dword
7956 @opindex mno-dword
7958 Do not use double word instructions.
7960 @item -mdouble
7961 @opindex mdouble
7963 Use floating point double instructions.
7965 @item -mno-double
7966 @opindex mno-double
7968 Do not use floating point double instructions.
7970 @item -mmedia
7971 @opindex mmedia
7973 Use media instructions.
7975 @item -mno-media
7976 @opindex mno-media
7978 Do not use media instructions.
7980 @item -mmuladd
7981 @opindex mmuladd
7983 Use multiply and add/subtract instructions.
7985 @item -mno-muladd
7986 @opindex mno-muladd
7988 Do not use multiply and add/subtract instructions.
7990 @item -mfdpic
7991 @opindex mfdpic
7993 Select the FDPIC ABI, that uses function descriptors to represent
7994 pointers to functions.  Without any PIC/PIE-related options, it
7995 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7996 assumes GOT entries and small data are within a 12-bit range from the
7997 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7998 are computed with 32 bits.
8000 @item -minline-plt
8001 @opindex minline-plt
8003 Enable inlining of PLT entries in function calls to functions that are
8004 not known to bind locally.  It has no effect without @option{-mfdpic}.
8005 It's enabled by default if optimizing for speed and compiling for
8006 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8007 optimization option such as @option{-O3} or above is present in the
8008 command line.
8010 @item -mTLS
8011 @opindex TLS
8013 Assume a large TLS segment when generating thread-local code.
8015 @item -mtls
8016 @opindex tls
8018 Do not assume a large TLS segment when generating thread-local code.
8020 @item -mgprel-ro
8021 @opindex mgprel-ro
8023 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8024 that is known to be in read-only sections.  It's enabled by default,
8025 except for @option{-fpic} or @option{-fpie}: even though it may help
8026 make the global offset table smaller, it trades 1 instruction for 4.
8027 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8028 one of which may be shared by multiple symbols, and it avoids the need
8029 for a GOT entry for the referenced symbol, so it's more likely to be a
8030 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
8032 @item -multilib-library-pic
8033 @opindex multilib-library-pic
8035 Link with the (library, not FD) pic libraries.  It's implied by
8036 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8037 @option{-fpic} without @option{-mfdpic}.  You should never have to use
8038 it explicitly.
8040 @item -mlinked-fp
8041 @opindex mlinked-fp
8043 Follow the EABI requirement of always creating a frame pointer whenever
8044 a stack frame is allocated.  This option is enabled by default and can
8045 be disabled with @option{-mno-linked-fp}.
8047 @item -mlong-calls
8048 @opindex mlong-calls
8050 Use indirect addressing to call functions outside the current
8051 compilation unit.  This allows the functions to be placed anywhere
8052 within the 32-bit address space.
8054 @item -malign-labels
8055 @opindex malign-labels
8057 Try to align labels to an 8-byte boundary by inserting nops into the
8058 previous packet.  This option only has an effect when VLIW packing
8059 is enabled.  It doesn't create new packets; it merely adds nops to
8060 existing ones.
8062 @item -mlibrary-pic
8063 @opindex mlibrary-pic
8065 Generate position-independent EABI code.
8067 @item -macc-4
8068 @opindex macc-4
8070 Use only the first four media accumulator registers.
8072 @item -macc-8
8073 @opindex macc-8
8075 Use all eight media accumulator registers.
8077 @item -mpack
8078 @opindex mpack
8080 Pack VLIW instructions.
8082 @item -mno-pack
8083 @opindex mno-pack
8085 Do not pack VLIW instructions.
8087 @item -mno-eflags
8088 @opindex mno-eflags
8090 Do not mark ABI switches in e_flags.
8092 @item -mcond-move
8093 @opindex mcond-move
8095 Enable the use of conditional-move instructions (default).
8097 This switch is mainly for debugging the compiler and will likely be removed
8098 in a future version.
8100 @item -mno-cond-move
8101 @opindex mno-cond-move
8103 Disable the use of conditional-move instructions.
8105 This switch is mainly for debugging the compiler and will likely be removed
8106 in a future version.
8108 @item -mscc
8109 @opindex mscc
8111 Enable the use of conditional set instructions (default).
8113 This switch is mainly for debugging the compiler and will likely be removed
8114 in a future version.
8116 @item -mno-scc
8117 @opindex mno-scc
8119 Disable the use of conditional set instructions.
8121 This switch is mainly for debugging the compiler and will likely be removed
8122 in a future version.
8124 @item -mcond-exec
8125 @opindex mcond-exec
8127 Enable the use of conditional execution (default).
8129 This switch is mainly for debugging the compiler and will likely be removed
8130 in a future version.
8132 @item -mno-cond-exec
8133 @opindex mno-cond-exec
8135 Disable the use of conditional execution.
8137 This switch is mainly for debugging the compiler and will likely be removed
8138 in a future version.
8140 @item -mvliw-branch
8141 @opindex mvliw-branch
8143 Run a pass to pack branches into VLIW instructions (default).
8145 This switch is mainly for debugging the compiler and will likely be removed
8146 in a future version.
8148 @item -mno-vliw-branch
8149 @opindex mno-vliw-branch
8151 Do not run a pass to pack branches into VLIW instructions.
8153 This switch is mainly for debugging the compiler and will likely be removed
8154 in a future version.
8156 @item -mmulti-cond-exec
8157 @opindex mmulti-cond-exec
8159 Enable optimization of @code{&&} and @code{||} in conditional execution
8160 (default).
8162 This switch is mainly for debugging the compiler and will likely be removed
8163 in a future version.
8165 @item -mno-multi-cond-exec
8166 @opindex mno-multi-cond-exec
8168 Disable optimization of @code{&&} and @code{||} in conditional execution.
8170 This switch is mainly for debugging the compiler and will likely be removed
8171 in a future version.
8173 @item -mnested-cond-exec
8174 @opindex mnested-cond-exec
8176 Enable nested conditional execution optimizations (default).
8178 This switch is mainly for debugging the compiler and will likely be removed
8179 in a future version.
8181 @item -mno-nested-cond-exec
8182 @opindex mno-nested-cond-exec
8184 Disable nested conditional execution optimizations.
8186 This switch is mainly for debugging the compiler and will likely be removed
8187 in a future version.
8189 @item -mtomcat-stats
8190 @opindex mtomcat-stats
8192 Cause gas to print out tomcat statistics.
8194 @item -mcpu=@var{cpu}
8195 @opindex mcpu
8197 Select the processor type for which to generate code.  Possible values are
8198 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8199 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8201 @end table
8203 @node H8/300 Options
8204 @subsection H8/300 Options
8206 These @samp{-m} options are defined for the H8/300 implementations:
8208 @table @gcctabopt
8209 @item -mrelax
8210 @opindex mrelax
8211 Shorten some address references at link time, when possible; uses the
8212 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8213 ld, Using ld}, for a fuller description.
8215 @item -mh
8216 @opindex mh
8217 Generate code for the H8/300H@.
8219 @item -ms
8220 @opindex ms
8221 Generate code for the H8S@.
8223 @item -mn
8224 @opindex mn
8225 Generate code for the H8S and H8/300H in the normal mode.  This switch
8226 must be used either with @option{-mh} or @option{-ms}.
8228 @item -ms2600
8229 @opindex ms2600
8230 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8232 @item -mint32
8233 @opindex mint32
8234 Make @code{int} data 32 bits by default.
8236 @item -malign-300
8237 @opindex malign-300
8238 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8239 The default for the H8/300H and H8S is to align longs and floats on 4
8240 byte boundaries.
8241 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8242 This option has no effect on the H8/300.
8243 @end table
8245 @node HPPA Options
8246 @subsection HPPA Options
8247 @cindex HPPA Options
8249 These @samp{-m} options are defined for the HPPA family of computers:
8251 @table @gcctabopt
8252 @item -march=@var{architecture-type}
8253 @opindex march
8254 Generate code for the specified architecture.  The choices for
8255 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8256 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8257 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8258 architecture option for your machine.  Code compiled for lower numbered
8259 architectures will run on higher numbered architectures, but not the
8260 other way around.
8262 @item -mpa-risc-1-0
8263 @itemx -mpa-risc-1-1
8264 @itemx -mpa-risc-2-0
8265 @opindex mpa-risc-1-0
8266 @opindex mpa-risc-1-1
8267 @opindex mpa-risc-2-0
8268 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8270 @item -mbig-switch
8271 @opindex mbig-switch
8272 Generate code suitable for big switch tables.  Use this option only if
8273 the assembler/linker complain about out of range branches within a switch
8274 table.
8276 @item -mjump-in-delay
8277 @opindex mjump-in-delay
8278 Fill delay slots of function calls with unconditional jump instructions
8279 by modifying the return pointer for the function call to be the target
8280 of the conditional jump.
8282 @item -mdisable-fpregs
8283 @opindex mdisable-fpregs
8284 Prevent floating point registers from being used in any manner.  This is
8285 necessary for compiling kernels which perform lazy context switching of
8286 floating point registers.  If you use this option and attempt to perform
8287 floating point operations, the compiler will abort.
8289 @item -mdisable-indexing
8290 @opindex mdisable-indexing
8291 Prevent the compiler from using indexing address modes.  This avoids some
8292 rather obscure problems when compiling MIG generated code under MACH@.
8294 @item -mno-space-regs
8295 @opindex mno-space-regs
8296 Generate code that assumes the target has no space registers.  This allows
8297 GCC to generate faster indirect calls and use unscaled index address modes.
8299 Such code is suitable for level 0 PA systems and kernels.
8301 @item -mfast-indirect-calls
8302 @opindex mfast-indirect-calls
8303 Generate code that assumes calls never cross space boundaries.  This
8304 allows GCC to emit code which performs faster indirect calls.
8306 This option will not work in the presence of shared libraries or nested
8307 functions.
8309 @item -mfixed-range=@var{register-range}
8310 @opindex mfixed-range
8311 Generate code treating the given register range as fixed registers.
8312 A fixed register is one that the register allocator can not use.  This is
8313 useful when compiling kernel code.  A register range is specified as
8314 two registers separated by a dash.  Multiple register ranges can be
8315 specified separated by a comma.
8317 @item -mlong-load-store
8318 @opindex mlong-load-store
8319 Generate 3-instruction load and store sequences as sometimes required by
8320 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8321 the HP compilers.
8323 @item -mportable-runtime
8324 @opindex mportable-runtime
8325 Use the portable calling conventions proposed by HP for ELF systems.
8327 @item -mgas
8328 @opindex mgas
8329 Enable the use of assembler directives only GAS understands.
8331 @item -mschedule=@var{cpu-type}
8332 @opindex mschedule
8333 Schedule code according to the constraints for the machine type
8334 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8335 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8336 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8337 proper scheduling option for your machine.  The default scheduling is
8338 @samp{8000}.
8340 @item -mlinker-opt
8341 @opindex mlinker-opt
8342 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8343 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8344 linkers in which they give bogus error messages when linking some programs.
8346 @item -msoft-float
8347 @opindex msoft-float
8348 Generate output containing library calls for floating point.
8349 @strong{Warning:} the requisite libraries are not available for all HPPA
8350 targets.  Normally the facilities of the machine's usual C compiler are
8351 used, but this cannot be done directly in cross-compilation.  You must make
8352 your own arrangements to provide suitable library functions for
8353 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8354 does provide software floating point support.
8356 @option{-msoft-float} changes the calling convention in the output file;
8357 therefore, it is only useful if you compile @emph{all} of a program with
8358 this option.  In particular, you need to compile @file{libgcc.a}, the
8359 library that comes with GCC, with @option{-msoft-float} in order for
8360 this to work.
8362 @item -msio
8363 @opindex msio
8364 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8365 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8366 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8367 options are available under HP-UX and HI-UX@.
8369 @item -mgnu-ld
8370 @opindex gnu-ld
8371 Use GNU ld specific options.  This passes @option{-shared} to ld when
8372 building a shared library.  It is the default when GCC is configured,
8373 explicitly or implicitly, with the GNU linker.  This option does not
8374 have any affect on which ld is called, it only changes what parameters
8375 are passed to that ld.  The ld that is called is determined by the
8376 @option{--with-ld} configure option, GCC's program search path, and
8377 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8378 using @samp{which `gcc -print-prog-name=ld`}.
8380 @item -mhp-ld
8381 @opindex hp-ld
8382 Use HP ld specific options.  This passes @option{-b} to ld when building
8383 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8384 links.  It is the default when GCC is configured, explicitly or
8385 implicitly, with the HP linker.  This option does not have any affect on
8386 which ld is called, it only changes what parameters are passed to that
8387 ld.  The ld that is called is determined by the @option{--with-ld}
8388 configure option, GCC's program search path, and finally by the user's
8389 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8390 `gcc -print-prog-name=ld`}.
8392 @item -mlong-calls
8393 @opindex mno-long-calls
8394 Generate code that uses long call sequences.  This ensures that a call
8395 is always able to reach linker generated stubs.  The default is to generate
8396 long calls only when the distance from the call site to the beginning
8397 of the function or translation unit, as the case may be, exceeds a
8398 predefined limit set by the branch type being used.  The limits for
8399 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8400 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8401 240,000 bytes.
8403 Distances are measured from the beginning of functions when using the
8404 @option{-ffunction-sections} option, or when using the @option{-mgas}
8405 and @option{-mno-portable-runtime} options together under HP-UX with
8406 the SOM linker.
8408 It is normally not desirable to use this option as it will degrade
8409 performance.  However, it may be useful in large applications,
8410 particularly when partial linking is used to build the application.
8412 The types of long calls used depends on the capabilities of the
8413 assembler and linker, and the type of code being generated.  The
8414 impact on systems that support long absolute calls, and long pic
8415 symbol-difference or pc-relative calls should be relatively small.
8416 However, an indirect call is used on 32-bit ELF systems in pic code
8417 and it is quite long.
8419 @item -munix=@var{unix-std}
8420 @opindex march
8421 Generate compiler predefines and select a startfile for the specified
8422 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8423 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8424 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8425 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8426 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8427 and later.
8429 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8430 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8431 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8432 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8433 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8434 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8436 It is @emph{important} to note that this option changes the interfaces
8437 for various library routines.  It also affects the operational behavior
8438 of the C library.  Thus, @emph{extreme} care is needed in using this
8439 option.
8441 Library code that is intended to operate with more than one UNIX
8442 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8443 as appropriate.  Most GNU software doesn't provide this capability.
8445 @item -nolibdld
8446 @opindex nolibdld
8447 Suppress the generation of link options to search libdld.sl when the
8448 @option{-static} option is specified on HP-UX 10 and later.
8450 @item -static
8451 @opindex static
8452 The HP-UX implementation of setlocale in libc has a dependency on
8453 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8454 when the @option{-static} option is specified, special link options
8455 are needed to resolve this dependency.
8457 On HP-UX 10 and later, the GCC driver adds the necessary options to
8458 link with libdld.sl when the @option{-static} option is specified.
8459 This causes the resulting binary to be dynamic.  On the 64-bit port,
8460 the linkers generate dynamic binaries by default in any case.  The
8461 @option{-nolibdld} option can be used to prevent the GCC driver from
8462 adding these link options.
8464 @item -threads
8465 @opindex threads
8466 Add support for multithreading with the @dfn{dce thread} library
8467 under HP-UX@.  This option sets flags for both the preprocessor and
8468 linker.
8469 @end table
8471 @node i386 and x86-64 Options
8472 @subsection Intel 386 and AMD x86-64 Options
8473 @cindex i386 Options
8474 @cindex x86-64 Options
8475 @cindex Intel 386 Options
8476 @cindex AMD x86-64 Options
8478 These @samp{-m} options are defined for the i386 and x86-64 family of
8479 computers:
8481 @table @gcctabopt
8482 @item -mtune=@var{cpu-type}
8483 @opindex mtune
8484 Tune to @var{cpu-type} everything applicable about the generated code, except
8485 for the ABI and the set of available instructions.  The choices for
8486 @var{cpu-type} are:
8487 @table @emph
8488 @item i386
8489 Original Intel's i386 CPU@.
8490 @item i486
8491 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8492 @item i586, pentium
8493 Intel Pentium CPU with no MMX support.
8494 @item pentium-mmx
8495 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8496 @item i686, pentiumpro
8497 Intel PentiumPro CPU@.
8498 @item pentium2
8499 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8500 @item pentium3, pentium3m
8501 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8502 support.
8503 @item pentium-m
8504 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8505 support.  Used by Centrino notebooks.
8506 @item pentium4, pentium4m
8507 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8508 @item prescott
8509 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8510 set support.
8511 @item nocona
8512 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8513 SSE2 and SSE3 instruction set support.
8514 @item k6
8515 AMD K6 CPU with MMX instruction set support.
8516 @item k6-2, k6-3
8517 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8518 @item athlon, athlon-tbird
8519 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8520 support.
8521 @item athlon-4, athlon-xp, athlon-mp
8522 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8523 instruction set support.
8524 @item k8, opteron, athlon64, athlon-fx
8525 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8526 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8527 @item winchip-c6
8528 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8529 set support.
8530 @item winchip2
8531 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8532 instruction set support.
8533 @item c3
8534 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8535 implemented for this chip.)
8536 @item c3-2
8537 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8538 implemented for this chip.)
8539 @end table
8541 While picking a specific @var{cpu-type} will schedule things appropriately
8542 for that particular chip, the compiler will not generate any code that
8543 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8544 being used.
8546 @item -march=@var{cpu-type}
8547 @opindex march
8548 Generate instructions for the machine type @var{cpu-type}.  The choices
8549 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8550 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8552 @item -mcpu=@var{cpu-type}
8553 @opindex mcpu
8554 A deprecated synonym for @option{-mtune}.
8556 @item -m386
8557 @itemx -m486
8558 @itemx -mpentium
8559 @itemx -mpentiumpro
8560 @opindex m386
8561 @opindex m486
8562 @opindex mpentium
8563 @opindex mpentiumpro
8564 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8565 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8566 These synonyms are deprecated.
8568 @item -mfpmath=@var{unit}
8569 @opindex march
8570 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8571 for @var{unit} are:
8573 @table @samp
8574 @item 387
8575 Use the standard 387 floating point coprocessor present majority of chips and
8576 emulated otherwise.  Code compiled with this option will run almost everywhere.
8577 The temporary results are computed in 80bit precision instead of precision
8578 specified by the type resulting in slightly different results compared to most
8579 of other chips.  See @option{-ffloat-store} for more detailed description.
8581 This is the default choice for i386 compiler.
8583 @item sse
8584 Use scalar floating point instructions present in the SSE instruction set.
8585 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8586 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8587 instruction set supports only single precision arithmetics, thus the double and
8588 extended precision arithmetics is still done using 387.  Later version, present
8589 only in Pentium4 and the future AMD x86-64 chips supports double precision
8590 arithmetics too.
8592 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8593 or @option{-msse2} switches to enable SSE extensions and make this option
8594 effective.  For the x86-64 compiler, these extensions are enabled by default.
8596 The resulting code should be considerably faster in the majority of cases and avoid
8597 the numerical instability problems of 387 code, but may break some existing
8598 code that expects temporaries to be 80bit.
8600 This is the default choice for the x86-64 compiler.
8602 @item sse,387
8603 Attempt to utilize both instruction sets at once.  This effectively double the
8604 amount of available registers and on chips with separate execution units for
8605 387 and SSE the execution resources too.  Use this option with care, as it is
8606 still experimental, because the GCC register allocator does not model separate
8607 functional units well resulting in instable performance.
8608 @end table
8610 @item -masm=@var{dialect}
8611 @opindex masm=@var{dialect}
8612 Output asm instructions using selected @var{dialect}.  Supported choices are
8613 @samp{intel} or @samp{att} (the default one).
8615 @item -mieee-fp
8616 @itemx -mno-ieee-fp
8617 @opindex mieee-fp
8618 @opindex mno-ieee-fp
8619 Control whether or not the compiler uses IEEE floating point
8620 comparisons.  These handle correctly the case where the result of a
8621 comparison is unordered.
8623 @item -msoft-float
8624 @opindex msoft-float
8625 Generate output containing library calls for floating point.
8626 @strong{Warning:} the requisite libraries are not part of GCC@.
8627 Normally the facilities of the machine's usual C compiler are used, but
8628 this can't be done directly in cross-compilation.  You must make your
8629 own arrangements to provide suitable library functions for
8630 cross-compilation.
8632 On machines where a function returns floating point results in the 80387
8633 register stack, some floating point opcodes may be emitted even if
8634 @option{-msoft-float} is used.
8636 @item -mno-fp-ret-in-387
8637 @opindex mno-fp-ret-in-387
8638 Do not use the FPU registers for return values of functions.
8640 The usual calling convention has functions return values of types
8641 @code{float} and @code{double} in an FPU register, even if there
8642 is no FPU@.  The idea is that the operating system should emulate
8643 an FPU@.
8645 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8646 in ordinary CPU registers instead.
8648 @item -mno-fancy-math-387
8649 @opindex mno-fancy-math-387
8650 Some 387 emulators do not support the @code{sin}, @code{cos} and
8651 @code{sqrt} instructions for the 387.  Specify this option to avoid
8652 generating those instructions.  This option is the default on FreeBSD,
8653 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8654 indicates that the target cpu will always have an FPU and so the
8655 instruction will not need emulation.  As of revision 2.6.1, these
8656 instructions are not generated unless you also use the
8657 @option{-funsafe-math-optimizations} switch.
8659 @item -malign-double
8660 @itemx -mno-align-double
8661 @opindex malign-double
8662 @opindex mno-align-double
8663 Control whether GCC aligns @code{double}, @code{long double}, and
8664 @code{long long} variables on a two word boundary or a one word
8665 boundary.  Aligning @code{double} variables on a two word boundary will
8666 produce code that runs somewhat faster on a @samp{Pentium} at the
8667 expense of more memory.
8669 @strong{Warning:} if you use the @option{-malign-double} switch,
8670 structures containing the above types will be aligned differently than
8671 the published application binary interface specifications for the 386
8672 and will not be binary compatible with structures in code compiled
8673 without that switch.
8675 @item -m96bit-long-double
8676 @itemx -m128bit-long-double
8677 @opindex m96bit-long-double
8678 @opindex m128bit-long-double
8679 These switches control the size of @code{long double} type.  The i386
8680 application binary interface specifies the size to be 96 bits,
8681 so @option{-m96bit-long-double} is the default in 32 bit mode.
8683 Modern architectures (Pentium and newer) would prefer @code{long double}
8684 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8685 conforming to the ABI, this would not be possible.  So specifying a
8686 @option{-m128bit-long-double} will align @code{long double}
8687 to a 16 byte boundary by padding the @code{long double} with an additional
8688 32 bit zero.
8690 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8691 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8693 Notice that neither of these options enable any extra precision over the x87
8694 standard of 80 bits for a @code{long double}.
8696 @strong{Warning:} if you override the default value for your target ABI, the
8697 structures and arrays containing @code{long double} variables will change
8698 their size as well as function calling convention for function taking
8699 @code{long double} will be modified.  Hence they will not be binary
8700 compatible with arrays or structures in code compiled without that switch.
8703 @item -msvr3-shlib
8704 @itemx -mno-svr3-shlib
8705 @opindex msvr3-shlib
8706 @opindex mno-svr3-shlib
8707 Control whether GCC places uninitialized local variables into the
8708 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8709 into @code{bss}.  These options are meaningful only on System V Release 3.
8711 @item -mrtd
8712 @opindex mrtd
8713 Use a different function-calling convention, in which functions that
8714 take a fixed number of arguments return with the @code{ret} @var{num}
8715 instruction, which pops their arguments while returning.  This saves one
8716 instruction in the caller since there is no need to pop the arguments
8717 there.
8719 You can specify that an individual function is called with this calling
8720 sequence with the function attribute @samp{stdcall}.  You can also
8721 override the @option{-mrtd} option by using the function attribute
8722 @samp{cdecl}.  @xref{Function Attributes}.
8724 @strong{Warning:} this calling convention is incompatible with the one
8725 normally used on Unix, so you cannot use it if you need to call
8726 libraries compiled with the Unix compiler.
8728 Also, you must provide function prototypes for all functions that
8729 take variable numbers of arguments (including @code{printf});
8730 otherwise incorrect code will be generated for calls to those
8731 functions.
8733 In addition, seriously incorrect code will result if you call a
8734 function with too many arguments.  (Normally, extra arguments are
8735 harmlessly ignored.)
8737 @item -mregparm=@var{num}
8738 @opindex mregparm
8739 Control how many registers are used to pass integer arguments.  By
8740 default, no registers are used to pass arguments, and at most 3
8741 registers can be used.  You can control this behavior for a specific
8742 function by using the function attribute @samp{regparm}.
8743 @xref{Function Attributes}.
8745 @strong{Warning:} if you use this switch, and
8746 @var{num} is nonzero, then you must build all modules with the same
8747 value, including any libraries.  This includes the system libraries and
8748 startup modules.
8750 @item -mpreferred-stack-boundary=@var{num}
8751 @opindex mpreferred-stack-boundary
8752 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8753 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8754 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8755 size (@option{-Os}), in which case the default is the minimum correct
8756 alignment (4 bytes for x86, and 8 bytes for x86-64).
8758 On Pentium and PentiumPro, @code{double} and @code{long double} values
8759 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8760 suffer significant run time performance penalties.  On Pentium III, the
8761 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8762 penalties if it is not 16 byte aligned.
8764 To ensure proper alignment of this values on the stack, the stack boundary
8765 must be as aligned as that required by any value stored on the stack.
8766 Further, every function must be generated such that it keeps the stack
8767 aligned.  Thus calling a function compiled with a higher preferred
8768 stack boundary from a function compiled with a lower preferred stack
8769 boundary will most likely misalign the stack.  It is recommended that
8770 libraries that use callbacks always use the default setting.
8772 This extra alignment does consume extra stack space, and generally
8773 increases code size.  Code that is sensitive to stack space usage, such
8774 as embedded systems and operating system kernels, may want to reduce the
8775 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8777 @item -mmmx
8778 @itemx -mno-mmx
8779 @item -msse
8780 @itemx -mno-sse
8781 @item -msse2
8782 @itemx -mno-sse2
8783 @item -msse3
8784 @itemx -mno-sse3
8785 @item -m3dnow
8786 @itemx -mno-3dnow
8787 @opindex mmmx
8788 @opindex mno-mmx
8789 @opindex msse
8790 @opindex mno-sse
8791 @opindex m3dnow
8792 @opindex mno-3dnow
8793 These switches enable or disable the use of built-in functions that allow
8794 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8795 instruction set.
8797 @xref{X86 Built-in Functions}, for details of the functions enabled
8798 and disabled by these switches.
8800 To have SSE/SSE2 instructions generated automatically from floating-point
8801 code, see @option{-mfpmath=sse}.
8803 @item -mpush-args
8804 @itemx -mno-push-args
8805 @opindex mpush-args
8806 @opindex mno-push-args
8807 Use PUSH operations to store outgoing parameters.  This method is shorter
8808 and usually equally fast as method using SUB/MOV operations and is enabled
8809 by default.  In some cases disabling it may improve performance because of
8810 improved scheduling and reduced dependencies.
8812 @item -maccumulate-outgoing-args
8813 @opindex maccumulate-outgoing-args
8814 If enabled, the maximum amount of space required for outgoing arguments will be
8815 computed in the function prologue.  This is faster on most modern CPUs
8816 because of reduced dependencies, improved scheduling and reduced stack usage
8817 when preferred stack boundary is not equal to 2.  The drawback is a notable
8818 increase in code size.  This switch implies @option{-mno-push-args}.
8820 @item -mthreads
8821 @opindex mthreads
8822 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8823 on thread-safe exception handling must compile and link all code with the
8824 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8825 @option{-D_MT}; when linking, it links in a special thread helper library
8826 @option{-lmingwthrd} which cleans up per thread exception handling data.
8828 @item -mno-align-stringops
8829 @opindex mno-align-stringops
8830 Do not align destination of inlined string operations.  This switch reduces
8831 code size and improves performance in case the destination is already aligned,
8832 but GCC doesn't know about it.
8834 @item -minline-all-stringops
8835 @opindex minline-all-stringops
8836 By default GCC inlines string operations only when destination is known to be
8837 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8838 size, but may improve performance of code that depends on fast memcpy, strlen
8839 and memset for short lengths.
8841 @item -momit-leaf-frame-pointer
8842 @opindex momit-leaf-frame-pointer
8843 Don't keep the frame pointer in a register for leaf functions.  This
8844 avoids the instructions to save, set up and restore frame pointers and
8845 makes an extra register available in leaf functions.  The option
8846 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8847 which might make debugging harder.
8849 @item -mtls-direct-seg-refs
8850 @itemx -mno-tls-direct-seg-refs
8851 @opindex mtls-direct-seg-refs
8852 Controls whether TLS variables may be accessed with offsets from the
8853 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8854 or whether the thread base pointer must be added.  Whether or not this
8855 is legal depends on the operating system, and whether it maps the
8856 segment to cover the entire TLS area.
8858 For systems that use GNU libc, the default is on.
8859 @end table
8861 These @samp{-m} switches are supported in addition to the above
8862 on AMD x86-64 processors in 64-bit environments.
8864 @table @gcctabopt
8865 @item -m32
8866 @itemx -m64
8867 @opindex m32
8868 @opindex m64
8869 Generate code for a 32-bit or 64-bit environment.
8870 The 32-bit environment sets int, long and pointer to 32 bits and
8871 generates code that runs on any i386 system.
8872 The 64-bit environment sets int to 32 bits and long and pointer
8873 to 64 bits and generates code for AMD's x86-64 architecture.
8875 @item -mno-red-zone
8876 @opindex no-red-zone
8877 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8878 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8879 stack pointer that will not be modified by signal or interrupt handlers
8880 and therefore can be used for temporary data without adjusting the stack
8881 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8883 @item -mcmodel=small
8884 @opindex mcmodel=small
8885 Generate code for the small code model: the program and its symbols must
8886 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8887 Programs can be statically or dynamically linked.  This is the default
8888 code model.
8890 @item -mcmodel=kernel
8891 @opindex mcmodel=kernel
8892 Generate code for the kernel code model.  The kernel runs in the
8893 negative 2 GB of the address space.
8894 This model has to be used for Linux kernel code.
8896 @item -mcmodel=medium
8897 @opindex mcmodel=medium
8898 Generate code for the medium model: The program is linked in the lower 2
8899 GB of the address space but symbols can be located anywhere in the
8900 address space.  Programs can be statically or dynamically linked, but
8901 building of shared libraries are not supported with the medium model.
8903 @item -mcmodel=large
8904 @opindex mcmodel=large
8905 Generate code for the large model: This model makes no assumptions
8906 about addresses and sizes of sections.  Currently GCC does not implement
8907 this model.
8908 @end table
8910 @node IA-64 Options
8911 @subsection IA-64 Options
8912 @cindex IA-64 Options
8914 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8916 @table @gcctabopt
8917 @item -mbig-endian
8918 @opindex mbig-endian
8919 Generate code for a big endian target.  This is the default for HP-UX@.
8921 @item -mlittle-endian
8922 @opindex mlittle-endian
8923 Generate code for a little endian target.  This is the default for AIX5
8924 and GNU/Linux.
8926 @item -mgnu-as
8927 @itemx -mno-gnu-as
8928 @opindex mgnu-as
8929 @opindex mno-gnu-as
8930 Generate (or don't) code for the GNU assembler.  This is the default.
8931 @c Also, this is the default if the configure option @option{--with-gnu-as}
8932 @c is used.
8934 @item -mgnu-ld
8935 @itemx -mno-gnu-ld
8936 @opindex mgnu-ld
8937 @opindex mno-gnu-ld
8938 Generate (or don't) code for the GNU linker.  This is the default.
8939 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8940 @c is used.
8942 @item -mno-pic
8943 @opindex mno-pic
8944 Generate code that does not use a global pointer register.  The result
8945 is not position independent code, and violates the IA-64 ABI@.
8947 @item -mvolatile-asm-stop
8948 @itemx -mno-volatile-asm-stop
8949 @opindex mvolatile-asm-stop
8950 @opindex mno-volatile-asm-stop
8951 Generate (or don't) a stop bit immediately before and after volatile asm
8952 statements.
8954 @item -mregister-names
8955 @itemx -mno-register-names
8956 @opindex mregister-names
8957 @opindex mno-register-names
8958 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8959 the stacked registers.  This may make assembler output more readable.
8961 @item -mno-sdata
8962 @itemx -msdata
8963 @opindex mno-sdata
8964 @opindex msdata
8965 Disable (or enable) optimizations that use the small data section.  This may
8966 be useful for working around optimizer bugs.
8968 @item -mconstant-gp
8969 @opindex mconstant-gp
8970 Generate code that uses a single constant global pointer value.  This is
8971 useful when compiling kernel code.
8973 @item -mauto-pic
8974 @opindex mauto-pic
8975 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8976 This is useful when compiling firmware code.
8978 @item -minline-float-divide-min-latency
8979 @opindex minline-float-divide-min-latency
8980 Generate code for inline divides of floating point values
8981 using the minimum latency algorithm.
8983 @item -minline-float-divide-max-throughput
8984 @opindex minline-float-divide-max-throughput
8985 Generate code for inline divides of floating point values
8986 using the maximum throughput algorithm.
8988 @item -minline-int-divide-min-latency
8989 @opindex minline-int-divide-min-latency
8990 Generate code for inline divides of integer values
8991 using the minimum latency algorithm.
8993 @item -minline-int-divide-max-throughput
8994 @opindex minline-int-divide-max-throughput
8995 Generate code for inline divides of integer values
8996 using the maximum throughput algorithm.
8998 @item -minline-sqrt-min-latency
8999 @opindex minline-sqrt-min-latency
9000 Generate code for inline square roots
9001 using the minimum latency algorithm.
9003 @item -minline-sqrt-max-throughput
9004 @opindex minline-sqrt-max-throughput
9005 Generate code for inline square roots
9006 using the maximum throughput algorithm.
9008 @item -mno-dwarf2-asm
9009 @itemx -mdwarf2-asm
9010 @opindex mno-dwarf2-asm
9011 @opindex mdwarf2-asm
9012 Don't (or do) generate assembler code for the DWARF2 line number debugging
9013 info.  This may be useful when not using the GNU assembler.
9015 @item -mearly-stop-bits
9016 @itemx -mno-early-stop-bits
9017 @opindex mearly-stop-bits
9018 @opindex mno-early-stop-bits
9019 Allow stop bits to be placed earlier than immediately preceding the
9020 instruction that triggered the stop bit.  This can improve instruction
9021 scheduling, but does not always do so.
9023 @item -mfixed-range=@var{register-range}
9024 @opindex mfixed-range
9025 Generate code treating the given register range as fixed registers.
9026 A fixed register is one that the register allocator can not use.  This is
9027 useful when compiling kernel code.  A register range is specified as
9028 two registers separated by a dash.  Multiple register ranges can be
9029 specified separated by a comma.
9031 @item -mtls-size=@var{tls-size}
9032 @opindex mtls-size
9033 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
9036 @item -mtune-arch=@var{cpu-type}
9037 @opindex mtune-arch
9038 Tune the instruction scheduling for a particular CPU, Valid values are
9039 itanium, itanium1, merced, itanium2, and mckinley.
9041 @item -mt
9042 @itemx -pthread
9043 @opindex mt
9044 @opindex pthread
9045 Add support for multithreading using the POSIX threads library.  This
9046 option sets flags for both the preprocessor and linker.  It does
9047 not affect the thread safety of object code produced by the compiler or
9048 that of libraries supplied with it.  These are HP-UX specific flags.
9050 @item -milp32
9051 @itemx -mlp64
9052 @opindex milp32
9053 @opindex mlp64
9054 Generate code for a 32-bit or 64-bit environment.
9055 The 32-bit environment sets int, long and pointer to 32 bits.
9056 The 64-bit environment sets int to 32 bits and long and pointer
9057 to 64 bits.  These are HP-UX specific flags.
9059 @end table
9061 @node M32R/D Options
9062 @subsection M32R/D Options
9063 @cindex M32R/D options
9065 These @option{-m} options are defined for Renesas M32R/D architectures:
9067 @table @gcctabopt
9068 @item -m32r2
9069 @opindex m32r2
9070 Generate code for the M32R/2@.
9072 @item -m32rx
9073 @opindex m32rx
9074 Generate code for the M32R/X@.
9076 @item -m32r
9077 @opindex m32r
9078 Generate code for the M32R@.  This is the default.
9080 @item -mmodel=small
9081 @opindex mmodel=small
9082 Assume all objects live in the lower 16MB of memory (so that their addresses
9083 can be loaded with the @code{ld24} instruction), and assume all subroutines
9084 are reachable with the @code{bl} instruction.
9085 This is the default.
9087 The addressability of a particular object can be set with the
9088 @code{model} attribute.
9090 @item -mmodel=medium
9091 @opindex mmodel=medium
9092 Assume objects may be anywhere in the 32-bit address space (the compiler
9093 will generate @code{seth/add3} instructions to load their addresses), and
9094 assume all subroutines are reachable with the @code{bl} instruction.
9096 @item -mmodel=large
9097 @opindex mmodel=large
9098 Assume objects may be anywhere in the 32-bit address space (the compiler
9099 will generate @code{seth/add3} instructions to load their addresses), and
9100 assume subroutines may not be reachable with the @code{bl} instruction
9101 (the compiler will generate the much slower @code{seth/add3/jl}
9102 instruction sequence).
9104 @item -msdata=none
9105 @opindex msdata=none
9106 Disable use of the small data area.  Variables will be put into
9107 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9108 @code{section} attribute has been specified).
9109 This is the default.
9111 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9112 Objects may be explicitly put in the small data area with the
9113 @code{section} attribute using one of these sections.
9115 @item -msdata=sdata
9116 @opindex msdata=sdata
9117 Put small global and static data in the small data area, but do not
9118 generate special code to reference them.
9120 @item -msdata=use
9121 @opindex msdata=use
9122 Put small global and static data in the small data area, and generate
9123 special instructions to reference them.
9125 @item -G @var{num}
9126 @opindex G
9127 @cindex smaller data references
9128 Put global and static objects less than or equal to @var{num} bytes
9129 into the small data or bss sections instead of the normal data or bss
9130 sections.  The default value of @var{num} is 8.
9131 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9132 for this option to have any effect.
9134 All modules should be compiled with the same @option{-G @var{num}} value.
9135 Compiling with different values of @var{num} may or may not work; if it
9136 doesn't the linker will give an error message---incorrect code will not be
9137 generated.
9139 @item -mdebug
9140 @opindex mdebug
9141 Makes the M32R specific code in the compiler display some statistics
9142 that might help in debugging programs.
9144 @item -malign-loops
9145 @opindex malign-loops
9146 Align all loops to a 32-byte boundary.
9148 @item -mno-align-loops
9149 @opindex mno-align-loops
9150 Do not enforce a 32-byte alignment for loops.  This is the default.
9152 @item -missue-rate=@var{number}
9153 @opindex missue-rate=@var{number}
9154 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9155 or 2.
9157 @item -mbranch-cost=@var{number}
9158 @opindex mbranch-cost=@var{number}
9159 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9160 preferred over conditional code, if it is 2, then the opposite will
9161 apply.
9163 @item -mflush-trap=@var{number}
9164 @opindex mflush-trap=@var{number}
9165 Specifies the trap number to use to flush the cache.  The default is
9166 12.  Valid numbers are between 0 and 15 inclusive.
9168 @item -mno-flush-trap
9169 @opindex mno-flush-trap
9170 Specifies that the cache cannot be flushed by using a trap.
9172 @item -mflush-func=@var{name}
9173 @opindex mflush-func=@var{name}
9174 Specifies the name of the operating system function to call to flush
9175 the cache.  The default is @emph{_flush_cache}, but a function call
9176 will only be used if a trap is not available.
9178 @item -mno-flush-func
9179 @opindex mno-flush-func
9180 Indicates that there is no OS function for flushing the cache.
9182 @end table
9184 @node M680x0 Options
9185 @subsection M680x0 Options
9186 @cindex M680x0 options
9188 These are the @samp{-m} options defined for the 68000 series.  The default
9189 values for these options depends on which style of 68000 was selected when
9190 the compiler was configured; the defaults for the most common choices are
9191 given below.
9193 @table @gcctabopt
9194 @item -m68000
9195 @itemx -mc68000
9196 @opindex m68000
9197 @opindex mc68000
9198 Generate output for a 68000.  This is the default
9199 when the compiler is configured for 68000-based systems.
9201 Use this option for microcontrollers with a 68000 or EC000 core,
9202 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9204 @item -m68020
9205 @itemx -mc68020
9206 @opindex m68020
9207 @opindex mc68020
9208 Generate output for a 68020.  This is the default
9209 when the compiler is configured for 68020-based systems.
9211 @item -m68881
9212 @opindex m68881
9213 Generate output containing 68881 instructions for floating point.
9214 This is the default for most 68020 systems unless @option{--nfp} was
9215 specified when the compiler was configured.
9217 @item -m68030
9218 @opindex m68030
9219 Generate output for a 68030.  This is the default when the compiler is
9220 configured for 68030-based systems.
9222 @item -m68040
9223 @opindex m68040
9224 Generate output for a 68040.  This is the default when the compiler is
9225 configured for 68040-based systems.
9227 This option inhibits the use of 68881/68882 instructions that have to be
9228 emulated by software on the 68040.  Use this option if your 68040 does not
9229 have code to emulate those instructions.
9231 @item -m68060
9232 @opindex m68060
9233 Generate output for a 68060.  This is the default when the compiler is
9234 configured for 68060-based systems.
9236 This option inhibits the use of 68020 and 68881/68882 instructions that
9237 have to be emulated by software on the 68060.  Use this option if your 68060
9238 does not have code to emulate those instructions.
9240 @item -mcpu32
9241 @opindex mcpu32
9242 Generate output for a CPU32.  This is the default
9243 when the compiler is configured for CPU32-based systems.
9245 Use this option for microcontrollers with a
9246 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9247 68336, 68340, 68341, 68349 and 68360.
9249 @item -m5200
9250 @opindex m5200
9251 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9252 when the compiler is configured for 520X-based systems.
9254 Use this option for microcontroller with a 5200 core, including
9255 the MCF5202, MCF5203, MCF5204 and MCF5202.
9258 @item -m68020-40
9259 @opindex m68020-40
9260 Generate output for a 68040, without using any of the new instructions.
9261 This results in code which can run relatively efficiently on either a
9262 68020/68881 or a 68030 or a 68040.  The generated code does use the
9263 68881 instructions that are emulated on the 68040.
9265 @item -m68020-60
9266 @opindex m68020-60
9267 Generate output for a 68060, without using any of the new instructions.
9268 This results in code which can run relatively efficiently on either a
9269 68020/68881 or a 68030 or a 68040.  The generated code does use the
9270 68881 instructions that are emulated on the 68060.
9272 @item -msoft-float
9273 @opindex msoft-float
9274 Generate output containing library calls for floating point.
9275 @strong{Warning:} the requisite libraries are not available for all m68k
9276 targets.  Normally the facilities of the machine's usual C compiler are
9277 used, but this can't be done directly in cross-compilation.  You must
9278 make your own arrangements to provide suitable library functions for
9279 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9280 @samp{m68k-*-coff} do provide software floating point support.
9282 @item -mshort
9283 @opindex mshort
9284 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9285 Additionally, parameters passed on the stack are also aligned to a
9286 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9288 @item -mnobitfield
9289 @opindex mnobitfield
9290 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9291 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9293 @item -mbitfield
9294 @opindex mbitfield
9295 Do use the bit-field instructions.  The @option{-m68020} option implies
9296 @option{-mbitfield}.  This is the default if you use a configuration
9297 designed for a 68020.
9299 @item -mrtd
9300 @opindex mrtd
9301 Use a different function-calling convention, in which functions
9302 that take a fixed number of arguments return with the @code{rtd}
9303 instruction, which pops their arguments while returning.  This
9304 saves one instruction in the caller since there is no need to pop
9305 the arguments there.
9307 This calling convention is incompatible with the one normally
9308 used on Unix, so you cannot use it if you need to call libraries
9309 compiled with the Unix compiler.
9311 Also, you must provide function prototypes for all functions that
9312 take variable numbers of arguments (including @code{printf});
9313 otherwise incorrect code will be generated for calls to those
9314 functions.
9316 In addition, seriously incorrect code will result if you call a
9317 function with too many arguments.  (Normally, extra arguments are
9318 harmlessly ignored.)
9320 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9321 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9323 @item -malign-int
9324 @itemx -mno-align-int
9325 @opindex malign-int
9326 @opindex mno-align-int
9327 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9328 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9329 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9330 Aligning variables on 32-bit boundaries produces code that runs somewhat
9331 faster on processors with 32-bit busses at the expense of more memory.
9333 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9334 align structures containing the above types  differently than
9335 most published application binary interface specifications for the m68k.
9337 @item -mpcrel
9338 @opindex mpcrel
9339 Use the pc-relative addressing mode of the 68000 directly, instead of
9340 using a global offset table.  At present, this option implies @option{-fpic},
9341 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9342 not presently supported with @option{-mpcrel}, though this could be supported for
9343 68020 and higher processors.
9345 @item -mno-strict-align
9346 @itemx -mstrict-align
9347 @opindex mno-strict-align
9348 @opindex mstrict-align
9349 Do not (do) assume that unaligned memory references will be handled by
9350 the system.
9352 @item -msep-data
9353 Generate code that allows the data segment to be located in a different
9354 area of memory from the text segment.  This allows for execute in place in
9355 an environment without virtual memory management.  This option implies
9356 @option{-fPIC}.
9358 @item -mno-sep-data
9359 Generate code that assumes that the data segment follows the text segment.
9360 This is the default.
9362 @item -mid-shared-library
9363 Generate code that supports shared libraries via the library ID method.
9364 This allows for execute in place and shared libraries in an environment
9365 without virtual memory management.  This option implies @option{-fPIC}.
9367 @item -mno-id-shared-library
9368 Generate code that doesn't assume ID based shared libraries are being used.
9369 This is the default.
9371 @item -mshared-library-id=n
9372 Specified the identification number of the ID based shared library being
9373 compiled.  Specifying a value of 0 will generate more compact code, specifying
9374 other values will force the allocation of that number to the current
9375 library but is no more space or time efficient than omitting this option.
9377 @end table
9379 @node M68hc1x Options
9380 @subsection M68hc1x Options
9381 @cindex M68hc1x options
9383 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9384 microcontrollers.  The default values for these options depends on
9385 which style of microcontroller was selected when the compiler was configured;
9386 the defaults for the most common choices are given below.
9388 @table @gcctabopt
9389 @item -m6811
9390 @itemx -m68hc11
9391 @opindex m6811
9392 @opindex m68hc11
9393 Generate output for a 68HC11.  This is the default
9394 when the compiler is configured for 68HC11-based systems.
9396 @item -m6812
9397 @itemx -m68hc12
9398 @opindex m6812
9399 @opindex m68hc12
9400 Generate output for a 68HC12.  This is the default
9401 when the compiler is configured for 68HC12-based systems.
9403 @item -m68S12
9404 @itemx -m68hcs12
9405 @opindex m68S12
9406 @opindex m68hcs12
9407 Generate output for a 68HCS12.
9409 @item -mauto-incdec
9410 @opindex mauto-incdec
9411 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9412 addressing modes.
9414 @item -minmax
9415 @itemx -nominmax
9416 @opindex minmax
9417 @opindex mnominmax
9418 Enable the use of 68HC12 min and max instructions.
9420 @item -mlong-calls
9421 @itemx -mno-long-calls
9422 @opindex mlong-calls
9423 @opindex mno-long-calls
9424 Treat all calls as being far away (near).  If calls are assumed to be
9425 far away, the compiler will use the @code{call} instruction to
9426 call a function and the @code{rtc} instruction for returning.
9428 @item -mshort
9429 @opindex mshort
9430 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9432 @item -msoft-reg-count=@var{count}
9433 @opindex msoft-reg-count
9434 Specify the number of pseudo-soft registers which are used for the
9435 code generation.  The maximum number is 32.  Using more pseudo-soft
9436 register may or may not result in better code depending on the program.
9437 The default is 4 for 68HC11 and 2 for 68HC12.
9439 @end table
9441 @node MCore Options
9442 @subsection MCore Options
9443 @cindex MCore options
9445 These are the @samp{-m} options defined for the Motorola M*Core
9446 processors.
9448 @table @gcctabopt
9450 @item -mhardlit
9451 @itemx -mno-hardlit
9452 @opindex mhardlit
9453 @opindex mno-hardlit
9454 Inline constants into the code stream if it can be done in two
9455 instructions or less.
9457 @item -mdiv
9458 @itemx -mno-div
9459 @opindex mdiv
9460 @opindex mno-div
9461 Use the divide instruction.  (Enabled by default).
9463 @item -mrelax-immediate
9464 @itemx -mno-relax-immediate
9465 @opindex mrelax-immediate
9466 @opindex mno-relax-immediate
9467 Allow arbitrary sized immediates in bit operations.
9469 @item -mwide-bitfields
9470 @itemx -mno-wide-bitfields
9471 @opindex mwide-bitfields
9472 @opindex mno-wide-bitfields
9473 Always treat bit-fields as int-sized.
9475 @item -m4byte-functions
9476 @itemx -mno-4byte-functions
9477 @opindex m4byte-functions
9478 @opindex mno-4byte-functions
9479 Force all functions to be aligned to a four byte boundary.
9481 @item -mcallgraph-data
9482 @itemx -mno-callgraph-data
9483 @opindex mcallgraph-data
9484 @opindex mno-callgraph-data
9485 Emit callgraph information.
9487 @item -mslow-bytes
9488 @itemx -mno-slow-bytes
9489 @opindex mslow-bytes
9490 @opindex mno-slow-bytes
9491 Prefer word access when reading byte quantities.
9493 @item -mlittle-endian
9494 @itemx -mbig-endian
9495 @opindex mlittle-endian
9496 @opindex mbig-endian
9497 Generate code for a little endian target.
9499 @item -m210
9500 @itemx -m340
9501 @opindex m210
9502 @opindex m340
9503 Generate code for the 210 processor.
9504 @end table
9506 @node MIPS Options
9507 @subsection MIPS Options
9508 @cindex MIPS options
9510 @table @gcctabopt
9512 @item -EB
9513 @opindex EB
9514 Generate big-endian code.
9516 @item -EL
9517 @opindex EL
9518 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9519 configurations.
9521 @item -march=@var{arch}
9522 @opindex march
9523 Generate code that will run on @var{arch}, which can be the name of a
9524 generic MIPS ISA, or the name of a particular processor.
9525 The ISA names are:
9526 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9527 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9528 The processor names are:
9529 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9530 @samp{m4k},
9531 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9532 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9533 @samp{rm9000},
9534 @samp{orion},
9535 @samp{sb1},
9536 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9537 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9538 The special value @samp{from-abi} selects the
9539 most compatible architecture for the selected ABI (that is,
9540 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9542 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9543 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9544 @samp{vr} may be written @samp{r}.
9546 GCC defines two macros based on the value of this option.  The first
9547 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9548 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9549 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9550 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9551 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9553 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9554 above.  In other words, it will have the full prefix and will not
9555 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9556 the macro names the resolved architecture (either @samp{"mips1"} or
9557 @samp{"mips3"}).  It names the default architecture when no
9558 @option{-march} option is given.
9560 @item -mtune=@var{arch}
9561 @opindex mtune
9562 Optimize for @var{arch}.  Among other things, this option controls
9563 the way instructions are scheduled, and the perceived cost of arithmetic
9564 operations.  The list of @var{arch} values is the same as for
9565 @option{-march}.
9567 When this option is not used, GCC will optimize for the processor
9568 specified by @option{-march}.  By using @option{-march} and
9569 @option{-mtune} together, it is possible to generate code that will
9570 run on a family of processors, but optimize the code for one
9571 particular member of that family.
9573 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9574 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9575 @samp{-march} ones described above.
9577 @item -mips1
9578 @opindex mips1
9579 Equivalent to @samp{-march=mips1}.
9581 @item -mips2
9582 @opindex mips2
9583 Equivalent to @samp{-march=mips2}.
9585 @item -mips3
9586 @opindex mips3
9587 Equivalent to @samp{-march=mips3}.
9589 @item -mips4
9590 @opindex mips4
9591 Equivalent to @samp{-march=mips4}.
9593 @item -mips32
9594 @opindex mips32
9595 Equivalent to @samp{-march=mips32}.
9597 @item -mips32r2
9598 @opindex mips32r2
9599 Equivalent to @samp{-march=mips32r2}.
9601 @item -mips64
9602 @opindex mips64
9603 Equivalent to @samp{-march=mips64}.
9605 @item -mips16
9606 @itemx -mno-mips16
9607 @opindex mips16
9608 @opindex mno-mips16
9609 Use (do not use) the MIPS16 ISA@.
9611 @item -mabi=32
9612 @itemx -mabi=o64
9613 @itemx -mabi=n32
9614 @itemx -mabi=64
9615 @itemx -mabi=eabi
9616 @opindex mabi=32
9617 @opindex mabi=o64
9618 @opindex mabi=n32
9619 @opindex mabi=64
9620 @opindex mabi=eabi
9621 Generate code for the given ABI@.
9623 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9624 generates 64-bit code when you select a 64-bit architecture, but you
9625 can use @option{-mgp32} to get 32-bit code instead.
9627 For information about the O64 ABI, see
9628 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9630 @item -mabicalls
9631 @itemx -mno-abicalls
9632 @opindex mabicalls
9633 @opindex mno-abicalls
9634 Generate (do not generate) SVR4-style position-independent code.
9635 @option{-mabicalls} is the default for SVR4-based systems.
9637 @item -mxgot
9638 @itemx -mno-xgot
9639 @opindex mxgot
9640 @opindex mno-xgot
9641 Lift (do not lift) the usual restrictions on the size of the global
9642 offset table.
9644 GCC normally uses a single instruction to load values from the GOT@.
9645 While this is relatively efficient, it will only work if the GOT
9646 is smaller than about 64k.  Anything larger will cause the linker
9647 to report an error such as:
9649 @cindex relocation truncated to fit (MIPS)
9650 @smallexample
9651 relocation truncated to fit: R_MIPS_GOT16 foobar
9652 @end smallexample
9654 If this happens, you should recompile your code with @option{-mxgot}.
9655 It should then work with very large GOTs, although it will also be
9656 less efficient, since it will take three instructions to fetch the
9657 value of a global symbol.
9659 Note that some linkers can create multiple GOTs.  If you have such a
9660 linker, you should only need to use @option{-mxgot} when a single object
9661 file accesses more than 64k's worth of GOT entries.  Very few do.
9663 These options have no effect unless GCC is generating position
9664 independent code.
9666 @item -mgp32
9667 @opindex mgp32
9668 Assume that general-purpose registers are 32 bits wide.
9670 @item -mgp64
9671 @opindex mgp64
9672 Assume that general-purpose registers are 64 bits wide.
9674 @item -mfp32
9675 @opindex mfp32
9676 Assume that floating-point registers are 32 bits wide.
9678 @item -mfp64
9679 @opindex mfp64
9680 Assume that floating-point registers are 64 bits wide.
9682 @item -mhard-float
9683 @opindex mhard-float
9684 Use floating-point coprocessor instructions.
9686 @item -msoft-float
9687 @opindex msoft-float
9688 Do not use floating-point coprocessor instructions.  Implement
9689 floating-point calculations using library calls instead.
9691 @item -msingle-float
9692 @opindex msingle-float
9693 Assume that the floating-point coprocessor only supports single-precision
9694 operations.
9696 @itemx -mdouble-float
9697 @opindex mdouble-float
9698 Assume that the floating-point coprocessor supports double-precision
9699 operations.  This is the default.
9701 @itemx -mpaired-single
9702 @itemx -mno-paired-single
9703 @opindex mpaired-single
9704 @opindex mno-paired-single
9705 Use (do not use) paired-single floating-point instructions.
9706 @xref{MIPS Paired-Single Support}.  This option can only be used
9707 when generating 64-bit code and requires hardware floating-point
9708 support to be enabled.
9710 @itemx -mips3d
9711 @itemx -mno-mips3d
9712 @opindex mips3d
9713 @opindex mno-mips3d
9714 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9715 The option @option{-mips3d} implies @option{-mpaired-single}.
9717 @item -mint64
9718 @opindex mint64
9719 Force @code{int} and @code{long} types to be 64 bits wide.  See
9720 @option{-mlong32} for an explanation of the default and the way
9721 that the pointer size is determined.
9723 This option has been deprecated and will be removed in a future release.
9725 @item -mlong64
9726 @opindex mlong64
9727 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9728 an explanation of the default and the way that the pointer size is
9729 determined.
9731 @item -mlong32
9732 @opindex mlong32
9733 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9735 The default size of @code{int}s, @code{long}s and pointers depends on
9736 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9737 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9738 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9739 or the same size as integer registers, whichever is smaller.
9741 @item -msym32
9742 @itemx -mno-sym32
9743 @opindex msym32
9744 @opindex mno-sym32
9745 Assume (do not assume) that all symbols have 32-bit values, regardless
9746 of the selected ABI@.  This option is useful in combination with
9747 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9748 to generate shorter and faster references to symbolic addresses.
9750 @item -G @var{num}
9751 @opindex G
9752 @cindex smaller data references (MIPS)
9753 @cindex gp-relative references (MIPS)
9754 Put global and static items less than or equal to @var{num} bytes into
9755 the small data or bss section instead of the normal data or bss section.
9756 This allows the data to be accessed using a single instruction.
9758 All modules should be compiled with the same @option{-G @var{num}}
9759 value.
9761 @item -membedded-data
9762 @itemx -mno-embedded-data
9763 @opindex membedded-data
9764 @opindex mno-embedded-data
9765 Allocate variables to the read-only data section first if possible, then
9766 next in the small data section if possible, otherwise in data.  This gives
9767 slightly slower code than the default, but reduces the amount of RAM required
9768 when executing, and thus may be preferred for some embedded systems.
9770 @item -muninit-const-in-rodata
9771 @itemx -mno-uninit-const-in-rodata
9772 @opindex muninit-const-in-rodata
9773 @opindex mno-uninit-const-in-rodata
9774 Put uninitialized @code{const} variables in the read-only data section.
9775 This option is only meaningful in conjunction with @option{-membedded-data}.
9777 @item -msplit-addresses
9778 @itemx -mno-split-addresses
9779 @opindex msplit-addresses
9780 @opindex mno-split-addresses
9781 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9782 relocation operators.  This option has been superceded by
9783 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9785 @item -mexplicit-relocs
9786 @itemx -mno-explicit-relocs
9787 @opindex mexplicit-relocs
9788 @opindex mno-explicit-relocs
9789 Use (do not use) assembler relocation operators when dealing with symbolic
9790 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9791 is to use assembler macros instead.
9793 @option{-mexplicit-relocs} is the default if GCC was configured
9794 to use an assembler that supports relocation operators.
9796 @item -mcheck-zero-division
9797 @itemx -mno-check-zero-division
9798 @opindex mcheck-zero-division
9799 @opindex mno-check-zero-division
9800 Trap (do not trap) on integer division by zero.  The default is
9801 @option{-mcheck-zero-division}.
9803 @item -mdivide-traps
9804 @itemx -mdivide-breaks
9805 @opindex mdivide-traps
9806 @opindex mdivide-breaks
9807 MIPS systems check for division by zero by generating either a
9808 conditional trap or a break instruction.  Using traps results in
9809 smaller code, but is only supported on MIPS II and later.  Also, some
9810 versions of the Linux kernel have a bug that prevents trap from
9811 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9812 allow conditional traps on architectures that support them and
9813 @option{-mdivide-breaks} to force the use of breaks.
9815 The default is usually @option{-mdivide-traps}, but this can be
9816 overridden at configure time using @option{--with-divide=breaks}.
9817 Divide-by-zero checks can be completely disabled using
9818 @option{-mno-check-zero-division}.
9820 @item -mmemcpy
9821 @itemx -mno-memcpy
9822 @opindex mmemcpy
9823 @opindex mno-memcpy
9824 Force (do not force) the use of @code{memcpy()} for non-trivial block
9825 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9826 most constant-sized copies.
9828 @item -mlong-calls
9829 @itemx -mno-long-calls
9830 @opindex mlong-calls
9831 @opindex mno-long-calls
9832 Disable (do not disable) use of the @code{jal} instruction.  Calling
9833 functions using @code{jal} is more efficient but requires the caller
9834 and callee to be in the same 256 megabyte segment.
9836 This option has no effect on abicalls code.  The default is
9837 @option{-mno-long-calls}.
9839 @item -mmad
9840 @itemx -mno-mad
9841 @opindex mmad
9842 @opindex mno-mad
9843 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9844 instructions, as provided by the R4650 ISA@.
9846 @item -mfused-madd
9847 @itemx -mno-fused-madd
9848 @opindex mfused-madd
9849 @opindex mno-fused-madd
9850 Enable (disable) use of the floating point multiply-accumulate
9851 instructions, when they are available.  The default is
9852 @option{-mfused-madd}.
9854 When multiply-accumulate instructions are used, the intermediate
9855 product is calculated to infinite precision and is not subject to
9856 the FCSR Flush to Zero bit.  This may be undesirable in some
9857 circumstances.
9859 @item -nocpp
9860 @opindex nocpp
9861 Tell the MIPS assembler to not run its preprocessor over user
9862 assembler files (with a @samp{.s} suffix) when assembling them.
9864 @item -mfix-r4000
9865 @itemx -mno-fix-r4000
9866 @opindex mfix-r4000
9867 @opindex mno-fix-r4000
9868 Work around certain R4000 CPU errata:
9869 @itemize @minus
9870 @item
9871 A double-word or a variable shift may give an incorrect result if executed
9872 immediately after starting an integer division.
9873 @item
9874 A double-word or a variable shift may give an incorrect result if executed
9875 while an integer multiplication is in progress.
9876 @item
9877 An integer division may give an incorrect result if started in a delay slot
9878 of a taken branch or a jump.
9879 @end itemize
9881 @item -mfix-r4400
9882 @itemx -mno-fix-r4400
9883 @opindex mfix-r4400
9884 @opindex mno-fix-r4400
9885 Work around certain R4400 CPU errata:
9886 @itemize @minus
9887 @item
9888 A double-word or a variable shift may give an incorrect result if executed
9889 immediately after starting an integer division.
9890 @end itemize
9892 @item -mfix-vr4120
9893 @itemx -mno-fix-vr4120
9894 @opindex mfix-vr4120
9895 Work around certain VR4120 errata:
9896 @itemize @minus
9897 @item
9898 @code{dmultu} does not always produce the correct result.
9899 @item
9900 @code{div} and @code{ddiv} do not always produce the correct result if one
9901 of the operands is negative.
9902 @end itemize
9903 The workarounds for the division errata rely on special functions in
9904 @file{libgcc.a}.  At present, these functions are only provided by
9905 the @code{mips64vr*-elf} configurations.
9907 Other VR4120 errata require a nop to be inserted between certain pairs of
9908 instructions.  These errata are handled by the assembler, not by GCC itself.
9910 @item -mfix-vr4130
9911 @opindex mfix-vr4130
9912 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
9913 workarounds are implemented by the assembler rather than by GCC,
9914 although GCC will avoid using @code{mflo} and @code{mfhi} if the
9915 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
9916 instructions are available instead.
9918 @item -mfix-sb1
9919 @itemx -mno-fix-sb1
9920 @opindex mfix-sb1
9921 Work around certain SB-1 CPU core errata.
9922 (This flag currently works around the SB-1 revision 2
9923 ``F1'' and ``F2'' floating point errata.)
9925 @item -mflush-func=@var{func}
9926 @itemx -mno-flush-func
9927 @opindex mflush-func
9928 Specifies the function to call to flush the I and D caches, or to not
9929 call any such function.  If called, the function must take the same
9930 arguments as the common @code{_flush_func()}, that is, the address of the
9931 memory range for which the cache is being flushed, the size of the
9932 memory range, and the number 3 (to flush both caches).  The default
9933 depends on the target GCC was configured for, but commonly is either
9934 @samp{_flush_func} or @samp{__cpu_flush}.
9936 @item -mbranch-likely
9937 @itemx -mno-branch-likely
9938 @opindex mbranch-likely
9939 @opindex mno-branch-likely
9940 Enable or disable use of Branch Likely instructions, regardless of the
9941 default for the selected architecture.  By default, Branch Likely
9942 instructions may be generated if they are supported by the selected
9943 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9944 and processors which implement those architectures; for those, Branch
9945 Likely instructions will not be generated by default because the MIPS32
9946 and MIPS64 architectures specifically deprecate their use.
9948 @item -mfp-exceptions
9949 @itemx -mno-fp-exceptions
9950 @opindex mfp-exceptions
9951 Specifies whether FP exceptions are enabled.  This affects how we schedule
9952 FP instructions for some processors.  The default is that FP exceptions are
9953 enabled.
9955 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9956 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9957 FP pipe.
9959 @item -mvr4130-align
9960 @itemx -mno-vr4130-align
9961 @opindex mvr4130-align
9962 The VR4130 pipeline is two-way superscalar, but can only issue two
9963 instructions together if the first one is 8-byte aligned.  When this
9964 option is enabled, GCC will align pairs of instructions that it
9965 thinks should execute in parallel.
9967 This option only has an effect when optimizing for the VR4130.
9968 It normally makes code faster, but at the expense of making it bigger.
9969 It is enabled by default at optimization level @option{-O3}.
9970 @end table
9972 @node MMIX Options
9973 @subsection MMIX Options
9974 @cindex MMIX Options
9976 These options are defined for the MMIX:
9978 @table @gcctabopt
9979 @item -mlibfuncs
9980 @itemx -mno-libfuncs
9981 @opindex mlibfuncs
9982 @opindex mno-libfuncs
9983 Specify that intrinsic library functions are being compiled, passing all
9984 values in registers, no matter the size.
9986 @item -mepsilon
9987 @itemx -mno-epsilon
9988 @opindex mepsilon
9989 @opindex mno-epsilon
9990 Generate floating-point comparison instructions that compare with respect
9991 to the @code{rE} epsilon register.
9993 @item -mabi=mmixware
9994 @itemx -mabi=gnu
9995 @opindex mabi-mmixware
9996 @opindex mabi=gnu
9997 Generate code that passes function parameters and return values that (in
9998 the called function) are seen as registers @code{$0} and up, as opposed to
9999 the GNU ABI which uses global registers @code{$231} and up.
10001 @item -mzero-extend
10002 @itemx -mno-zero-extend
10003 @opindex mzero-extend
10004 @opindex mno-zero-extend
10005 When reading data from memory in sizes shorter than 64 bits, use (do not
10006 use) zero-extending load instructions by default, rather than
10007 sign-extending ones.
10009 @item -mknuthdiv
10010 @itemx -mno-knuthdiv
10011 @opindex mknuthdiv
10012 @opindex mno-knuthdiv
10013 Make the result of a division yielding a remainder have the same sign as
10014 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
10015 remainder follows the sign of the dividend.  Both methods are
10016 arithmetically valid, the latter being almost exclusively used.
10018 @item -mtoplevel-symbols
10019 @itemx -mno-toplevel-symbols
10020 @opindex mtoplevel-symbols
10021 @opindex mno-toplevel-symbols
10022 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10023 code can be used with the @code{PREFIX} assembly directive.
10025 @item -melf
10026 @opindex melf
10027 Generate an executable in the ELF format, rather than the default
10028 @samp{mmo} format used by the @command{mmix} simulator.
10030 @item -mbranch-predict
10031 @itemx -mno-branch-predict
10032 @opindex mbranch-predict
10033 @opindex mno-branch-predict
10034 Use (do not use) the probable-branch instructions, when static branch
10035 prediction indicates a probable branch.
10037 @item -mbase-addresses
10038 @itemx -mno-base-addresses
10039 @opindex mbase-addresses
10040 @opindex mno-base-addresses
10041 Generate (do not generate) code that uses @emph{base addresses}.  Using a
10042 base address automatically generates a request (handled by the assembler
10043 and the linker) for a constant to be set up in a global register.  The
10044 register is used for one or more base address requests within the range 0
10045 to 255 from the value held in the register.  The generally leads to short
10046 and fast code, but the number of different data items that can be
10047 addressed is limited.  This means that a program that uses lots of static
10048 data may require @option{-mno-base-addresses}.
10050 @item -msingle-exit
10051 @itemx -mno-single-exit
10052 @opindex msingle-exit
10053 @opindex mno-single-exit
10054 Force (do not force) generated code to have a single exit point in each
10055 function.
10056 @end table
10058 @node MN10300 Options
10059 @subsection MN10300 Options
10060 @cindex MN10300 options
10062 These @option{-m} options are defined for Matsushita MN10300 architectures:
10064 @table @gcctabopt
10065 @item -mmult-bug
10066 @opindex mmult-bug
10067 Generate code to avoid bugs in the multiply instructions for the MN10300
10068 processors.  This is the default.
10070 @item -mno-mult-bug
10071 @opindex mno-mult-bug
10072 Do not generate code to avoid bugs in the multiply instructions for the
10073 MN10300 processors.
10075 @item -mam33
10076 @opindex mam33
10077 Generate code which uses features specific to the AM33 processor.
10079 @item -mno-am33
10080 @opindex mno-am33
10081 Do not generate code which uses features specific to the AM33 processor.  This
10082 is the default.
10084 @item -mno-crt0
10085 @opindex mno-crt0
10086 Do not link in the C run-time initialization object file.
10088 @item -mrelax
10089 @opindex mrelax
10090 Indicate to the linker that it should perform a relaxation optimization pass
10091 to shorten branches, calls and absolute memory addresses.  This option only
10092 has an effect when used on the command line for the final link step.
10094 This option makes symbolic debugging impossible.
10095 @end table
10097 @node NS32K Options
10098 @subsection NS32K Options
10099 @cindex NS32K options
10101 These are the @samp{-m} options defined for the 32000 series.  The default
10102 values for these options depends on which style of 32000 was selected when
10103 the compiler was configured; the defaults for the most common choices are
10104 given below.
10106 @table @gcctabopt
10107 @item -m32032
10108 @itemx -m32032
10109 @opindex m32032
10110 @opindex m32032
10111 Generate output for a 32032.  This is the default
10112 when the compiler is configured for 32032 and 32016 based systems.
10114 @item -m32332
10115 @itemx -m32332
10116 @opindex m32332
10117 @opindex m32332
10118 Generate output for a 32332.  This is the default
10119 when the compiler is configured for 32332-based systems.
10121 @item -m32532
10122 @itemx -m32532
10123 @opindex m32532
10124 @opindex m32532
10125 Generate output for a 32532.  This is the default
10126 when the compiler is configured for 32532-based systems.
10128 @item -m32081
10129 @opindex m32081
10130 Generate output containing 32081 instructions for floating point.
10131 This is the default for all systems.
10133 @item -m32381
10134 @opindex m32381
10135 Generate output containing 32381 instructions for floating point.  This
10136 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10137 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10139 @item -mmulti-add
10140 @opindex mmulti-add
10141 Try and generate multiply-add floating point instructions @code{polyF}
10142 and @code{dotF}.  This option is only available if the @option{-m32381}
10143 option is in effect.  Using these instructions requires changes to
10144 register allocation which generally has a negative impact on
10145 performance.  This option should only be enabled when compiling code
10146 particularly likely to make heavy use of multiply-add instructions.
10148 @item -mnomulti-add
10149 @opindex mnomulti-add
10150 Do not try and generate multiply-add floating point instructions
10151 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10153 @item -msoft-float
10154 @opindex msoft-float
10155 Generate output containing library calls for floating point.
10156 @strong{Warning:} the requisite libraries may not be available.
10158 @item -mieee-compare
10159 @itemx -mno-ieee-compare
10160 @opindex mieee-compare
10161 @opindex mno-ieee-compare
10162 Control whether or not the compiler uses IEEE floating point
10163 comparisons.  These handle correctly the case where the result of a
10164 comparison is unordered.
10165 @strong{Warning:} the requisite kernel support may not be available.
10167 @item -mnobitfield
10168 @opindex mnobitfield
10169 Do not use the bit-field instructions.  On some machines it is faster to
10170 use shifting and masking operations.  This is the default for the pc532.
10172 @item -mbitfield
10173 @opindex mbitfield
10174 Do use the bit-field instructions.  This is the default for all platforms
10175 except the pc532.
10177 @item -mrtd
10178 @opindex mrtd
10179 Use a different function-calling convention, in which functions
10180 that take a fixed number of arguments return pop their
10181 arguments on return with the @code{ret} instruction.
10183 This calling convention is incompatible with the one normally
10184 used on Unix, so you cannot use it if you need to call libraries
10185 compiled with the Unix compiler.
10187 Also, you must provide function prototypes for all functions that
10188 take variable numbers of arguments (including @code{printf});
10189 otherwise incorrect code will be generated for calls to those
10190 functions.
10192 In addition, seriously incorrect code will result if you call a
10193 function with too many arguments.  (Normally, extra arguments are
10194 harmlessly ignored.)
10196 This option takes its name from the 680x0 @code{rtd} instruction.
10199 @item -mregparam
10200 @opindex mregparam
10201 Use a different function-calling convention where the first two arguments
10202 are passed in registers.
10204 This calling convention is incompatible with the one normally
10205 used on Unix, so you cannot use it if you need to call libraries
10206 compiled with the Unix compiler.
10208 @item -mnoregparam
10209 @opindex mnoregparam
10210 Do not pass any arguments in registers.  This is the default for all
10211 targets.
10213 @item -msb
10214 @opindex msb
10215 It is OK to use the sb as an index register which is always loaded with
10216 zero.  This is the default for the pc532-netbsd target.
10218 @item -mnosb
10219 @opindex mnosb
10220 The sb register is not available for use or has not been initialized to
10221 zero by the run time system.  This is the default for all targets except
10222 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10223 @option{-fpic} is set.
10225 @item -mhimem
10226 @opindex mhimem
10227 Many ns32000 series addressing modes use displacements of up to 512MB@.
10228 If an address is above 512MB then displacements from zero can not be used.
10229 This option causes code to be generated which can be loaded above 512MB@.
10230 This may be useful for operating systems or ROM code.
10232 @item -mnohimem
10233 @opindex mnohimem
10234 Assume code will be loaded in the first 512MB of virtual address space.
10235 This is the default for all platforms.
10237 @end table
10239 @node PDP-11 Options
10240 @subsection PDP-11 Options
10241 @cindex PDP-11 Options
10243 These options are defined for the PDP-11:
10245 @table @gcctabopt
10246 @item -mfpu
10247 @opindex mfpu
10248 Use hardware FPP floating point.  This is the default.  (FIS floating
10249 point on the PDP-11/40 is not supported.)
10251 @item -msoft-float
10252 @opindex msoft-float
10253 Do not use hardware floating point.
10255 @item -mac0
10256 @opindex mac0
10257 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10259 @item -mno-ac0
10260 @opindex mno-ac0
10261 Return floating-point results in memory.  This is the default.
10263 @item -m40
10264 @opindex m40
10265 Generate code for a PDP-11/40.
10267 @item -m45
10268 @opindex m45
10269 Generate code for a PDP-11/45.  This is the default.
10271 @item -m10
10272 @opindex m10
10273 Generate code for a PDP-11/10.
10275 @item -mbcopy-builtin
10276 @opindex bcopy-builtin
10277 Use inline @code{movmemhi} patterns for copying memory.  This is the
10278 default.
10280 @item -mbcopy
10281 @opindex mbcopy
10282 Do not use inline @code{movmemhi} patterns for copying memory.
10284 @item -mint16
10285 @itemx -mno-int32
10286 @opindex mint16
10287 @opindex mno-int32
10288 Use 16-bit @code{int}.  This is the default.
10290 @item -mint32
10291 @itemx -mno-int16
10292 @opindex mint32
10293 @opindex mno-int16
10294 Use 32-bit @code{int}.
10296 @item -mfloat64
10297 @itemx -mno-float32
10298 @opindex mfloat64
10299 @opindex mno-float32
10300 Use 64-bit @code{float}.  This is the default.
10302 @item -mfloat32
10303 @itemx -mno-float64
10304 @opindex mfloat32
10305 @opindex mno-float64
10306 Use 32-bit @code{float}.
10308 @item -mabshi
10309 @opindex mabshi
10310 Use @code{abshi2} pattern.  This is the default.
10312 @item -mno-abshi
10313 @opindex mno-abshi
10314 Do not use @code{abshi2} pattern.
10316 @item -mbranch-expensive
10317 @opindex mbranch-expensive
10318 Pretend that branches are expensive.  This is for experimenting with
10319 code generation only.
10321 @item -mbranch-cheap
10322 @opindex mbranch-cheap
10323 Do not pretend that branches are expensive.  This is the default.
10325 @item -msplit
10326 @opindex msplit
10327 Generate code for a system with split I&D@.
10329 @item -mno-split
10330 @opindex mno-split
10331 Generate code for a system without split I&D@.  This is the default.
10333 @item -munix-asm
10334 @opindex munix-asm
10335 Use Unix assembler syntax.  This is the default when configured for
10336 @samp{pdp11-*-bsd}.
10338 @item -mdec-asm
10339 @opindex mdec-asm
10340 Use DEC assembler syntax.  This is the default when configured for any
10341 PDP-11 target other than @samp{pdp11-*-bsd}.
10342 @end table
10344 @node PowerPC Options
10345 @subsection PowerPC Options
10346 @cindex PowerPC options
10348 These are listed under @xref{RS/6000 and PowerPC Options}.
10350 @node RS/6000 and PowerPC Options
10351 @subsection IBM RS/6000 and PowerPC Options
10352 @cindex RS/6000 and PowerPC Options
10353 @cindex IBM RS/6000 and PowerPC Options
10355 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10356 @table @gcctabopt
10357 @item -mpower
10358 @itemx -mno-power
10359 @itemx -mpower2
10360 @itemx -mno-power2
10361 @itemx -mpowerpc
10362 @itemx -mno-powerpc
10363 @itemx -mpowerpc-gpopt
10364 @itemx -mno-powerpc-gpopt
10365 @itemx -mpowerpc-gfxopt
10366 @itemx -mno-powerpc-gfxopt
10367 @itemx -mpowerpc64
10368 @itemx -mno-powerpc64
10369 @opindex mpower
10370 @opindex mno-power
10371 @opindex mpower2
10372 @opindex mno-power2
10373 @opindex mpowerpc
10374 @opindex mno-powerpc
10375 @opindex mpowerpc-gpopt
10376 @opindex mno-powerpc-gpopt
10377 @opindex mpowerpc-gfxopt
10378 @opindex mno-powerpc-gfxopt
10379 @opindex mpowerpc64
10380 @opindex mno-powerpc64
10381 GCC supports two related instruction set architectures for the
10382 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10383 instructions supported by the @samp{rios} chip set used in the original
10384 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10385 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10386 the IBM 4xx microprocessors.
10388 Neither architecture is a subset of the other.  However there is a
10389 large common subset of instructions supported by both.  An MQ
10390 register is included in processors supporting the POWER architecture.
10392 You use these options to specify which instructions are available on the
10393 processor you are using.  The default value of these options is
10394 determined when configuring GCC@.  Specifying the
10395 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10396 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10397 rather than the options listed above.
10399 The @option{-mpower} option allows GCC to generate instructions that
10400 are found only in the POWER architecture and to use the MQ register.
10401 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10402 to generate instructions that are present in the POWER2 architecture but
10403 not the original POWER architecture.
10405 The @option{-mpowerpc} option allows GCC to generate instructions that
10406 are found only in the 32-bit subset of the PowerPC architecture.
10407 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10408 GCC to use the optional PowerPC architecture instructions in the
10409 General Purpose group, including floating-point square root.  Specifying
10410 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10411 use the optional PowerPC architecture instructions in the Graphics
10412 group, including floating-point select.
10414 The @option{-mpowerpc64} option allows GCC to generate the additional
10415 64-bit instructions that are found in the full PowerPC64 architecture
10416 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10417 @option{-mno-powerpc64}.
10419 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10420 will use only the instructions in the common subset of both
10421 architectures plus some special AIX common-mode calls, and will not use
10422 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10423 permits GCC to use any instruction from either architecture and to
10424 allow use of the MQ register; specify this for the Motorola MPC601.
10426 @item -mnew-mnemonics
10427 @itemx -mold-mnemonics
10428 @opindex mnew-mnemonics
10429 @opindex mold-mnemonics
10430 Select which mnemonics to use in the generated assembler code.  With
10431 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10432 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10433 assembler mnemonics defined for the POWER architecture.  Instructions
10434 defined in only one architecture have only one mnemonic; GCC uses that
10435 mnemonic irrespective of which of these options is specified.
10437 GCC defaults to the mnemonics appropriate for the architecture in
10438 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10439 value of these option.  Unless you are building a cross-compiler, you
10440 should normally not specify either @option{-mnew-mnemonics} or
10441 @option{-mold-mnemonics}, but should instead accept the default.
10443 @item -mcpu=@var{cpu_type}
10444 @opindex mcpu
10445 Set architecture type, register usage, choice of mnemonics, and
10446 instruction scheduling parameters for machine type @var{cpu_type}.
10447 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10448 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10449 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10450 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10451 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10452 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10453 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10454 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10455 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10457 @option{-mcpu=common} selects a completely generic processor.  Code
10458 generated under this option will run on any POWER or PowerPC processor.
10459 GCC will use only the instructions in the common subset of both
10460 architectures, and will not use the MQ register.  GCC assumes a generic
10461 processor model for scheduling purposes.
10463 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10464 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10465 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10466 types, with an appropriate, generic processor model assumed for
10467 scheduling purposes.
10469 The other options specify a specific processor.  Code generated under
10470 those options will run best on that processor, and may not run at all on
10471 others.
10473 The @option{-mcpu} options automatically enable or disable the
10474 following options: @option{-maltivec}, @option{-mhard-float},
10475 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10476 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10477 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10478 @option{-mstring}.  The particular options set for any particular CPU
10479 will vary between compiler versions, depending on what setting seems
10480 to produce optimal code for that CPU; it doesn't necessarily reflect
10481 the actual hardware's capabilities.  If you wish to set an individual
10482 option to a particular value, you may specify it after the
10483 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10485 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10486 not enabled or disabled by the @option{-mcpu} option at present, since
10487 AIX does not have full support for these options.  You may still
10488 enable or disable them individually if you're sure it'll work in your
10489 environment.
10491 @item -mtune=@var{cpu_type}
10492 @opindex mtune
10493 Set the instruction scheduling parameters for machine type
10494 @var{cpu_type}, but do not set the architecture type, register usage, or
10495 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10496 values for @var{cpu_type} are used for @option{-mtune} as for
10497 @option{-mcpu}.  If both are specified, the code generated will use the
10498 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10499 scheduling parameters set by @option{-mtune}.
10501 @item -maltivec
10502 @itemx -mno-altivec
10503 @opindex maltivec
10504 @opindex mno-altivec
10505 Generate code that uses (does not use) AltiVec instructions, and also
10506 enable the use of built-in functions that allow more direct access to
10507 the AltiVec instruction set.  You may also need to set
10508 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10509 enhancements.
10511 @item -mabi=spe
10512 @opindex mabi=spe
10513 Extend the current ABI with SPE ABI extensions.  This does not change
10514 the default ABI, instead it adds the SPE ABI extensions to the current
10515 ABI@.
10517 @item -mabi=no-spe
10518 @opindex mabi=no-spe
10519 Disable Booke SPE ABI extensions for the current ABI@.
10521 @item -misel=@var{yes/no}
10522 @itemx -misel
10523 @opindex misel
10524 This switch enables or disables the generation of ISEL instructions.
10526 @item -mspe=@var{yes/no}
10527 @itemx -mspe
10528 @opindex mspe
10529 This switch enables or disables the generation of SPE simd
10530 instructions.
10532 @item -mfloat-gprs=@var{yes/single/double/no}
10533 @itemx -mfloat-gprs
10534 @opindex mfloat-gprs
10535 This switch enables or disables the generation of floating point
10536 operations on the general purpose registers for architectures that
10537 support it.
10539 The argument @var{yes} or @var{single} enables the use of
10540 single-precision floating point operations.
10542 The argument @var{double} enables the use of single and
10543 double-precision floating point operations.
10545 The argument @var{no} disables floating point operations on the
10546 general purpose registers.
10548 This option is currently only available on the MPC854x.
10550 @item -m32
10551 @itemx -m64
10552 @opindex m32
10553 @opindex m64
10554 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10555 targets (including GNU/Linux).  The 32-bit environment sets int, long
10556 and pointer to 32 bits and generates code that runs on any PowerPC
10557 variant.  The 64-bit environment sets int to 32 bits and long and
10558 pointer to 64 bits, and generates code for PowerPC64, as for
10559 @option{-mpowerpc64}.
10561 @item -mfull-toc
10562 @itemx -mno-fp-in-toc
10563 @itemx -mno-sum-in-toc
10564 @itemx -mminimal-toc
10565 @opindex mfull-toc
10566 @opindex mno-fp-in-toc
10567 @opindex mno-sum-in-toc
10568 @opindex mminimal-toc
10569 Modify generation of the TOC (Table Of Contents), which is created for
10570 every executable file.  The @option{-mfull-toc} option is selected by
10571 default.  In that case, GCC will allocate at least one TOC entry for
10572 each unique non-automatic variable reference in your program.  GCC
10573 will also place floating-point constants in the TOC@.  However, only
10574 16,384 entries are available in the TOC@.
10576 If you receive a linker error message that saying you have overflowed
10577 the available TOC space, you can reduce the amount of TOC space used
10578 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10579 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10580 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10581 generate code to calculate the sum of an address and a constant at
10582 run-time instead of putting that sum into the TOC@.  You may specify one
10583 or both of these options.  Each causes GCC to produce very slightly
10584 slower and larger code at the expense of conserving TOC space.
10586 If you still run out of space in the TOC even when you specify both of
10587 these options, specify @option{-mminimal-toc} instead.  This option causes
10588 GCC to make only one TOC entry for every file.  When you specify this
10589 option, GCC will produce code that is slower and larger but which
10590 uses extremely little TOC space.  You may wish to use this option
10591 only on files that contain less frequently executed code.
10593 @item -maix64
10594 @itemx -maix32
10595 @opindex maix64
10596 @opindex maix32
10597 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10598 @code{long} type, and the infrastructure needed to support them.
10599 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10600 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10601 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10603 @item -mxl-compat
10604 @itemx -mno-xl-compat
10605 @opindex mxl-compat
10606 @opindex mno-xl-compat
10607 Produce code that conforms more closely to IBM XLC semantics when using
10608 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10609 functions beyond the register save area (RSA) on the stack in addition
10610 to argument FPRs.  Do not assume that most significant double in 128
10611 bit long double value is properly rounded when comparing values.
10613 The AIX calling convention was extended but not initially documented to
10614 handle an obscure K&R C case of calling a function that takes the
10615 address of its arguments with fewer arguments than declared.  AIX XL
10616 compilers access floating point arguments which do not fit in the
10617 RSA from the stack when a subroutine is compiled without
10618 optimization.  Because always storing floating-point arguments on the
10619 stack is inefficient and rarely needed, this option is not enabled by
10620 default and only is necessary when calling subroutines compiled by AIX
10621 XL compilers without optimization.
10623 @item -mpe
10624 @opindex mpe
10625 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10626 application written to use message passing with special startup code to
10627 enable the application to run.  The system must have PE installed in the
10628 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10629 must be overridden with the @option{-specs=} option to specify the
10630 appropriate directory location.  The Parallel Environment does not
10631 support threads, so the @option{-mpe} option and the @option{-pthread}
10632 option are incompatible.
10634 @item -malign-natural
10635 @itemx -malign-power
10636 @opindex malign-natural
10637 @opindex malign-power
10638 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10639 @option{-malign-natural} overrides the ABI-defined alignment of larger
10640 types, such as floating-point doubles, on their natural size-based boundary.
10641 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10642 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10644 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10645 is not supported.
10647 @item -msoft-float
10648 @itemx -mhard-float
10649 @opindex msoft-float
10650 @opindex mhard-float
10651 Generate code that does not use (uses) the floating-point register set.
10652 Software floating point emulation is provided if you use the
10653 @option{-msoft-float} option, and pass the option to GCC when linking.
10655 @item -mmultiple
10656 @itemx -mno-multiple
10657 @opindex mmultiple
10658 @opindex mno-multiple
10659 Generate code that uses (does not use) the load multiple word
10660 instructions and the store multiple word instructions.  These
10661 instructions are generated by default on POWER systems, and not
10662 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10663 endian PowerPC systems, since those instructions do not work when the
10664 processor is in little endian mode.  The exceptions are PPC740 and
10665 PPC750 which permit the instructions usage in little endian mode.
10667 @item -mstring
10668 @itemx -mno-string
10669 @opindex mstring
10670 @opindex mno-string
10671 Generate code that uses (does not use) the load string instructions
10672 and the store string word instructions to save multiple registers and
10673 do small block moves.  These instructions are generated by default on
10674 POWER systems, and not generated on PowerPC systems.  Do not use
10675 @option{-mstring} on little endian PowerPC systems, since those
10676 instructions do not work when the processor is in little endian mode.
10677 The exceptions are PPC740 and PPC750 which permit the instructions
10678 usage in little endian mode.
10680 @item -mupdate
10681 @itemx -mno-update
10682 @opindex mupdate
10683 @opindex mno-update
10684 Generate code that uses (does not use) the load or store instructions
10685 that update the base register to the address of the calculated memory
10686 location.  These instructions are generated by default.  If you use
10687 @option{-mno-update}, there is a small window between the time that the
10688 stack pointer is updated and the address of the previous frame is
10689 stored, which means code that walks the stack frame across interrupts or
10690 signals may get corrupted data.
10692 @item -mfused-madd
10693 @itemx -mno-fused-madd
10694 @opindex mfused-madd
10695 @opindex mno-fused-madd
10696 Generate code that uses (does not use) the floating point multiply and
10697 accumulate instructions.  These instructions are generated by default if
10698 hardware floating is used.
10700 @item -mno-bit-align
10701 @itemx -mbit-align
10702 @opindex mno-bit-align
10703 @opindex mbit-align
10704 On System V.4 and embedded PowerPC systems do not (do) force structures
10705 and unions that contain bit-fields to be aligned to the base type of the
10706 bit-field.
10708 For example, by default a structure containing nothing but 8
10709 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10710 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10711 the structure would be aligned to a 1 byte boundary and be one byte in
10712 size.
10714 @item -mno-strict-align
10715 @itemx -mstrict-align
10716 @opindex mno-strict-align
10717 @opindex mstrict-align
10718 On System V.4 and embedded PowerPC systems do not (do) assume that
10719 unaligned memory references will be handled by the system.
10721 @item -mrelocatable
10722 @itemx -mno-relocatable
10723 @opindex mrelocatable
10724 @opindex mno-relocatable
10725 On embedded PowerPC systems generate code that allows (does not allow)
10726 the program to be relocated to a different address at runtime.  If you
10727 use @option{-mrelocatable} on any module, all objects linked together must
10728 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10730 @item -mrelocatable-lib
10731 @itemx -mno-relocatable-lib
10732 @opindex mrelocatable-lib
10733 @opindex mno-relocatable-lib
10734 On embedded PowerPC systems generate code that allows (does not allow)
10735 the program to be relocated to a different address at runtime.  Modules
10736 compiled with @option{-mrelocatable-lib} can be linked with either modules
10737 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10738 with modules compiled with the @option{-mrelocatable} options.
10740 @item -mno-toc
10741 @itemx -mtoc
10742 @opindex mno-toc
10743 @opindex mtoc
10744 On System V.4 and embedded PowerPC systems do not (do) assume that
10745 register 2 contains a pointer to a global area pointing to the addresses
10746 used in the program.
10748 @item -mlittle
10749 @itemx -mlittle-endian
10750 @opindex mlittle
10751 @opindex mlittle-endian
10752 On System V.4 and embedded PowerPC systems compile code for the
10753 processor in little endian mode.  The @option{-mlittle-endian} option is
10754 the same as @option{-mlittle}.
10756 @item -mbig
10757 @itemx -mbig-endian
10758 @opindex mbig
10759 @opindex mbig-endian
10760 On System V.4 and embedded PowerPC systems compile code for the
10761 processor in big endian mode.  The @option{-mbig-endian} option is
10762 the same as @option{-mbig}.
10764 @item -mdynamic-no-pic
10765 @opindex mdynamic-no-pic
10766 On Darwin and Mac OS X systems, compile code so that it is not
10767 relocatable, but that its external references are relocatable.  The
10768 resulting code is suitable for applications, but not shared
10769 libraries.
10771 @item -mprioritize-restricted-insns=@var{priority}
10772 @opindex mprioritize-restricted-insns
10773 This option controls the priority that is assigned to
10774 dispatch-slot restricted instructions during the second scheduling
10775 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10776 @var{no/highest/second-highest} priority to dispatch slot restricted
10777 instructions.
10779 @item -msched-costly-dep=@var{dependence_type}
10780 @opindex msched-costly-dep
10781 This option controls which dependences are considered costly
10782 by the target during instruction scheduling.  The argument
10783 @var{dependence_type} takes one of the following values:
10784 @var{no}: no dependence is costly,
10785 @var{all}: all dependences are costly,
10786 @var{true_store_to_load}: a true dependence from store to load is costly,
10787 @var{store_to_load}: any dependence from store to load is costly,
10788 @var{number}: any dependence which latency >= @var{number} is costly.
10790 @item -minsert-sched-nops=@var{scheme}
10791 @opindex minsert-sched-nops
10792 This option controls which nop insertion scheme will be used during
10793 the second scheduling pass.  The argument @var{scheme} takes one of the
10794 following values:
10795 @var{no}: Don't insert nops.
10796 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10797 according to the scheduler's grouping.
10798 @var{regroup_exact}: Insert nops to force costly dependent insns into
10799 separate groups.  Insert exactly as many nops as needed to force an insn
10800 to a new group, according to the estimated processor grouping.
10801 @var{number}: Insert nops to force costly dependent insns into
10802 separate groups.  Insert @var{number} nops to force an insn to a new group.
10804 @item -mcall-sysv
10805 @opindex mcall-sysv
10806 On System V.4 and embedded PowerPC systems compile code using calling
10807 conventions that adheres to the March 1995 draft of the System V
10808 Application Binary Interface, PowerPC processor supplement.  This is the
10809 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10811 @item -mcall-sysv-eabi
10812 @opindex mcall-sysv-eabi
10813 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10815 @item -mcall-sysv-noeabi
10816 @opindex mcall-sysv-noeabi
10817 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10819 @item -mcall-solaris
10820 @opindex mcall-solaris
10821 On System V.4 and embedded PowerPC systems compile code for the Solaris
10822 operating system.
10824 @item -mcall-linux
10825 @opindex mcall-linux
10826 On System V.4 and embedded PowerPC systems compile code for the
10827 Linux-based GNU system.
10829 @item -mcall-gnu
10830 @opindex mcall-gnu
10831 On System V.4 and embedded PowerPC systems compile code for the
10832 Hurd-based GNU system.
10834 @item -mcall-netbsd
10835 @opindex mcall-netbsd
10836 On System V.4 and embedded PowerPC systems compile code for the
10837 NetBSD operating system.
10839 @item -maix-struct-return
10840 @opindex maix-struct-return
10841 Return all structures in memory (as specified by the AIX ABI)@.
10843 @item -msvr4-struct-return
10844 @opindex msvr4-struct-return
10845 Return structures smaller than 8 bytes in registers (as specified by the
10846 SVR4 ABI)@.
10848 @item -mabi=altivec
10849 @opindex mabi=altivec
10850 Extend the current ABI with AltiVec ABI extensions.  This does not
10851 change the default ABI, instead it adds the AltiVec ABI extensions to
10852 the current ABI@.
10854 @item -mabi=no-altivec
10855 @opindex mabi=no-altivec
10856 Disable AltiVec ABI extensions for the current ABI@.
10858 @item -mprototype
10859 @itemx -mno-prototype
10860 @opindex mprototype
10861 @opindex mno-prototype
10862 On System V.4 and embedded PowerPC systems assume that all calls to
10863 variable argument functions are properly prototyped.  Otherwise, the
10864 compiler must insert an instruction before every non prototyped call to
10865 set or clear bit 6 of the condition code register (@var{CR}) to
10866 indicate whether floating point values were passed in the floating point
10867 registers in case the function takes a variable arguments.  With
10868 @option{-mprototype}, only calls to prototyped variable argument functions
10869 will set or clear the bit.
10871 @item -msim
10872 @opindex msim
10873 On embedded PowerPC systems, assume that the startup module is called
10874 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10875 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10876 configurations.
10878 @item -mmvme
10879 @opindex mmvme
10880 On embedded PowerPC systems, assume that the startup module is called
10881 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10882 @file{libc.a}.
10884 @item -mads
10885 @opindex mads
10886 On embedded PowerPC systems, assume that the startup module is called
10887 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10888 @file{libc.a}.
10890 @item -myellowknife
10891 @opindex myellowknife
10892 On embedded PowerPC systems, assume that the startup module is called
10893 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10894 @file{libc.a}.
10896 @item -mvxworks
10897 @opindex mvxworks
10898 On System V.4 and embedded PowerPC systems, specify that you are
10899 compiling for a VxWorks system.
10901 @item -mwindiss
10902 @opindex mwindiss
10903 Specify that you are compiling for the WindISS simulation environment.
10905 @item -memb
10906 @opindex memb
10907 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10908 header to indicate that @samp{eabi} extended relocations are used.
10910 @item -meabi
10911 @itemx -mno-eabi
10912 @opindex meabi
10913 @opindex mno-eabi
10914 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10915 Embedded Applications Binary Interface (eabi) which is a set of
10916 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10917 means that the stack is aligned to an 8 byte boundary, a function
10918 @code{__eabi} is called to from @code{main} to set up the eabi
10919 environment, and the @option{-msdata} option can use both @code{r2} and
10920 @code{r13} to point to two separate small data areas.  Selecting
10921 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10922 do not call an initialization function from @code{main}, and the
10923 @option{-msdata} option will only use @code{r13} to point to a single
10924 small data area.  The @option{-meabi} option is on by default if you
10925 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10927 @item -msdata=eabi
10928 @opindex msdata=eabi
10929 On System V.4 and embedded PowerPC systems, put small initialized
10930 @code{const} global and static data in the @samp{.sdata2} section, which
10931 is pointed to by register @code{r2}.  Put small initialized
10932 non-@code{const} global and static data in the @samp{.sdata} section,
10933 which is pointed to by register @code{r13}.  Put small uninitialized
10934 global and static data in the @samp{.sbss} section, which is adjacent to
10935 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10936 incompatible with the @option{-mrelocatable} option.  The
10937 @option{-msdata=eabi} option also sets the @option{-memb} option.
10939 @item -msdata=sysv
10940 @opindex msdata=sysv
10941 On System V.4 and embedded PowerPC systems, put small global and static
10942 data in the @samp{.sdata} section, which is pointed to by register
10943 @code{r13}.  Put small uninitialized global and static data in the
10944 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10945 The @option{-msdata=sysv} option is incompatible with the
10946 @option{-mrelocatable} option.
10948 @item -msdata=default
10949 @itemx -msdata
10950 @opindex msdata=default
10951 @opindex msdata
10952 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10953 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10954 same as @option{-msdata=sysv}.
10956 @item -msdata-data
10957 @opindex msdata-data
10958 On System V.4 and embedded PowerPC systems, put small global and static
10959 data in the @samp{.sdata} section.  Put small uninitialized global and
10960 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10961 to address small data however.  This is the default behavior unless
10962 other @option{-msdata} options are used.
10964 @item -msdata=none
10965 @itemx -mno-sdata
10966 @opindex msdata=none
10967 @opindex mno-sdata
10968 On embedded PowerPC systems, put all initialized global and static data
10969 in the @samp{.data} section, and all uninitialized data in the
10970 @samp{.bss} section.
10972 @item -G @var{num}
10973 @opindex G
10974 @cindex smaller data references (PowerPC)
10975 @cindex .sdata/.sdata2 references (PowerPC)
10976 On embedded PowerPC systems, put global and static items less than or
10977 equal to @var{num} bytes into the small data or bss sections instead of
10978 the normal data or bss section.  By default, @var{num} is 8.  The
10979 @option{-G @var{num}} switch is also passed to the linker.
10980 All modules should be compiled with the same @option{-G @var{num}} value.
10982 @item -mregnames
10983 @itemx -mno-regnames
10984 @opindex mregnames
10985 @opindex mno-regnames
10986 On System V.4 and embedded PowerPC systems do (do not) emit register
10987 names in the assembly language output using symbolic forms.
10989 @item -mlongcall
10990 @itemx -mno-longcall
10991 @opindex mlongcall
10992 @opindex mno-longcall
10993 Default to making all function calls indirectly, using a register, so
10994 that functions which reside further than 32 megabytes (33,554,432
10995 bytes) from the current location can be called.  This setting can be
10996 overridden by the @code{shortcall} function attribute, or by
10997 @code{#pragma longcall(0)}.
10999 Some linkers are capable of detecting out-of-range calls and generating
11000 glue code on the fly.  On these systems, long calls are unnecessary and
11001 generate slower code.  As of this writing, the AIX linker can do this,
11002 as can the GNU linker for PowerPC/64.  It is planned to add this feature
11003 to the GNU linker for 32-bit PowerPC systems as well.
11005 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11006 callee, L42'', plus a ``branch island'' (glue code).  The two target
11007 addresses represent the callee and the ``branch island''.  The
11008 Darwin/PPC linker will prefer the first address and generate a ``bl
11009 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11010 otherwise, the linker will generate ``bl L42'' to call the ``branch
11011 island''.  The ``branch island'' is appended to the body of the
11012 calling function; it computes the full 32-bit address of the callee
11013 and jumps to it.
11015 On Mach-O (Darwin) systems, this option directs the compiler emit to
11016 the glue for every direct call, and the Darwin linker decides whether
11017 to use or discard it.
11019 In the future, we may cause GCC to ignore all longcall specifications
11020 when the linker is known to generate glue.
11022 @item -pthread
11023 @opindex pthread
11024 Adds support for multithreading with the @dfn{pthreads} library.
11025 This option sets flags for both the preprocessor and linker.
11027 @end table
11029 @node S/390 and zSeries Options
11030 @subsection S/390 and zSeries Options
11031 @cindex S/390 and zSeries Options
11033 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11035 @table @gcctabopt
11036 @item -mhard-float
11037 @itemx -msoft-float
11038 @opindex mhard-float
11039 @opindex msoft-float
11040 Use (do not use) the hardware floating-point instructions and registers
11041 for floating-point operations.  When @option{-msoft-float} is specified,
11042 functions in @file{libgcc.a} will be used to perform floating-point
11043 operations.  When @option{-mhard-float} is specified, the compiler
11044 generates IEEE floating-point instructions.  This is the default.
11046 @item -mbackchain
11047 @itemx -mno-backchain
11048 @opindex mbackchain
11049 @opindex mno-backchain
11050 Store (do not store) the address of the caller's frame as backchain pointer
11051 into the callee's stack frame.
11052 A backchain may be needed to allow debugging using tools that do not understand
11053 DWARF-2 call frame information.
11054 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11055 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11056 the backchain is placed into the topmost word of the 96/160 byte register
11057 save area.
11059 In general, code compiled with @option{-mbackchain} is call-compatible with
11060 code compiled with @option{-mmo-backchain}; however, use of the backchain
11061 for debugging purposes usually requires that the whole binary is built with
11062 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
11063 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11064 to build a linux kernel use @option{-msoft-float}.
11066 The default is to not maintain the backchain.
11068 @item -mpacked-stack
11069 @item -mno-packed-stack
11070 @opindex mpacked-stack
11071 @opindex mno-packed-stack
11072 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11073 specified, the compiler uses the all fields of the 96/160 byte register save
11074 area only for their default purpose; unused fields still take up stack space.
11075 When @option{-mpacked-stack} is specified, register save slots are densely
11076 packed at the top of the register save area; unused space is reused for other
11077 purposes, allowing for more efficient use of the available stack space.
11078 However, when @option{-mbackchain} is also in effect, the topmost word of
11079 the save area is always used to store the backchain, and the return address
11080 register is always saved two words below the backchain.
11082 As long as the stack frame backchain is not used, code generated with
11083 @option{-mpacked-stack} is call-compatible with code generated with
11084 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11085 S/390 or zSeries generated code that uses the stack frame backchain at run
11086 time, not just for debugging purposes.  Such code is not call-compatible
11087 with code compiled with @option{-mpacked-stack}.  Also, note that the
11088 combination of @option{-mbackchain},
11089 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11090 to build a linux kernel use @option{-msoft-float}.
11092 The default is to not use the packed stack layout.
11094 @item -msmall-exec
11095 @itemx -mno-small-exec
11096 @opindex msmall-exec
11097 @opindex mno-small-exec
11098 Generate (or do not generate) code using the @code{bras} instruction
11099 to do subroutine calls.
11100 This only works reliably if the total executable size does not
11101 exceed 64k.  The default is to use the @code{basr} instruction instead,
11102 which does not have this limitation.
11104 @item -m64
11105 @itemx -m31
11106 @opindex m64
11107 @opindex m31
11108 When @option{-m31} is specified, generate code compliant to the
11109 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11110 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11111 particular to generate 64-bit instructions.  For the @samp{s390}
11112 targets, the default is @option{-m31}, while the @samp{s390x}
11113 targets default to @option{-m64}.
11115 @item -mzarch
11116 @itemx -mesa
11117 @opindex mzarch
11118 @opindex mesa
11119 When @option{-mzarch} is specified, generate code using the
11120 instructions available on z/Architecture.
11121 When @option{-mesa} is specified, generate code using the
11122 instructions available on ESA/390.  Note that @option{-mesa} is
11123 not possible with @option{-m64}.
11124 When generating code compliant to the GNU/Linux for S/390 ABI,
11125 the default is @option{-mesa}.  When generating code compliant
11126 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11128 @item -mmvcle
11129 @itemx -mno-mvcle
11130 @opindex mmvcle
11131 @opindex mno-mvcle
11132 Generate (or do not generate) code using the @code{mvcle} instruction
11133 to perform block moves.  When @option{-mno-mvcle} is specified,
11134 use a @code{mvc} loop instead.  This is the default.
11136 @item -mdebug
11137 @itemx -mno-debug
11138 @opindex mdebug
11139 @opindex mno-debug
11140 Print (or do not print) additional debug information when compiling.
11141 The default is to not print debug information.
11143 @item -march=@var{cpu-type}
11144 @opindex march
11145 Generate code that will run on @var{cpu-type}, which is the name of a system
11146 representing a certain processor type.  Possible values for
11147 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11148 When generating code using the instructions available on z/Architecture,
11149 the default is @option{-march=z900}.  Otherwise, the default is
11150 @option{-march=g5}.
11152 @item -mtune=@var{cpu-type}
11153 @opindex mtune
11154 Tune to @var{cpu-type} everything applicable about the generated code,
11155 except for the ABI and the set of available instructions.
11156 The list of @var{cpu-type} values is the same as for @option{-march}.
11157 The default is the value used for @option{-march}.
11159 @item -mtpf-trace
11160 @itemx -mno-tpf-trace
11161 @opindex mtpf-trace
11162 @opindex mno-tpf-trace
11163 Generate code that adds (does not add) in TPF OS specific branches to trace
11164 routines in the operating system.  This option is off by default, even
11165 when compiling for the TPF OS@.
11167 @item -mfused-madd
11168 @itemx -mno-fused-madd
11169 @opindex mfused-madd
11170 @opindex mno-fused-madd
11171 Generate code that uses (does not use) the floating point multiply and
11172 accumulate instructions.  These instructions are generated by default if
11173 hardware floating point is used.
11175 @item -mwarn-framesize=@var{framesize}
11176 @opindex mwarn-framesize
11177 Emit a warning if the current function exceeds the given frame size.  Because
11178 this is a compile time check it doesn't need to be a real problem when the program
11179 runs.  It is intended to identify functions which most probably cause
11180 a stack overflow.  It is useful to be used in an environment with limited stack
11181 size e.g.@: the linux kernel.
11183 @item -mwarn-dynamicstack
11184 @opindex mwarn-dynamicstack
11185 Emit a warning if the function calls alloca or uses dynamically
11186 sized arrays.  This is generally a bad idea with a limited stack size.
11188 @item -mstack-guard=@var{stack-guard}
11189 @item -mstack-size=@var{stack-size}
11190 @opindex mstack-guard
11191 @opindex mstack-size
11192 These arguments always have to be used in conjunction.  If they are present the s390
11193 back end emits additional instructions in the function prologue which trigger a trap
11194 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11195 (remember that the stack on s390 grows downward).  These options are intended to
11196 be used to help debugging stack overflow problems.  The additionally emitted code
11197 cause only little overhead and hence can also be used in production like systems
11198 without greater performance degradation.  The given values have to be exact
11199 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11200 In order to be efficient the extra code makes the assumption that the stack starts
11201 at an address aligned to the value given by @var{stack-size}.
11202 @end table
11204 @node SH Options
11205 @subsection SH Options
11207 These @samp{-m} options are defined for the SH implementations:
11209 @table @gcctabopt
11210 @item -m1
11211 @opindex m1
11212 Generate code for the SH1.
11214 @item -m2
11215 @opindex m2
11216 Generate code for the SH2.
11218 @item -m2e
11219 Generate code for the SH2e.
11221 @item -m3
11222 @opindex m3
11223 Generate code for the SH3.
11225 @item -m3e
11226 @opindex m3e
11227 Generate code for the SH3e.
11229 @item -m4-nofpu
11230 @opindex m4-nofpu
11231 Generate code for the SH4 without a floating-point unit.
11233 @item -m4-single-only
11234 @opindex m4-single-only
11235 Generate code for the SH4 with a floating-point unit that only
11236 supports single-precision arithmetic.
11238 @item -m4-single
11239 @opindex m4-single
11240 Generate code for the SH4 assuming the floating-point unit is in
11241 single-precision mode by default.
11243 @item -m4
11244 @opindex m4
11245 Generate code for the SH4.
11247 @item -m4a-nofpu
11248 @opindex m4a-nofpu
11249 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11250 floating-point unit is not used.
11252 @item -m4a-single-only
11253 @opindex m4a-single-only
11254 Generate code for the SH4a, in such a way that no double-precision
11255 floating point operations are used.
11257 @item -m4a-single
11258 @opindex m4a-single
11259 Generate code for the SH4a assuming the floating-point unit is in
11260 single-precision mode by default.
11262 @item -m4a
11263 @opindex m4a
11264 Generate code for the SH4a.
11266 @item -m4al
11267 @opindex m4al
11268 Same as @option{-m4a-nofpu}, except that it implicitly passes
11269 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11270 instructions at the moment.
11272 @item -mb
11273 @opindex mb
11274 Compile code for the processor in big endian mode.
11276 @item -ml
11277 @opindex ml
11278 Compile code for the processor in little endian mode.
11280 @item -mdalign
11281 @opindex mdalign
11282 Align doubles at 64-bit boundaries.  Note that this changes the calling
11283 conventions, and thus some functions from the standard C library will
11284 not work unless you recompile it first with @option{-mdalign}.
11286 @item -mrelax
11287 @opindex mrelax
11288 Shorten some address references at link time, when possible; uses the
11289 linker option @option{-relax}.
11291 @item -mbigtable
11292 @opindex mbigtable
11293 Use 32-bit offsets in @code{switch} tables.  The default is to use
11294 16-bit offsets.
11296 @item -mfmovd
11297 @opindex mfmovd
11298 Enable the use of the instruction @code{fmovd}.
11300 @item -mhitachi
11301 @opindex mhitachi
11302 Comply with the calling conventions defined by Renesas.
11304 @item -mrenesas
11305 @opindex mhitachi
11306 Comply with the calling conventions defined by Renesas.
11308 @item -mno-renesas
11309 @opindex mhitachi
11310 Comply with the calling conventions defined for GCC before the Renesas
11311 conventions were available.  This option is the default for all
11312 targets of the SH toolchain except for @samp{sh-symbianelf}.
11314 @item -mnomacsave
11315 @opindex mnomacsave
11316 Mark the @code{MAC} register as call-clobbered, even if
11317 @option{-mhitachi} is given.
11319 @item -mieee
11320 @opindex mieee
11321 Increase IEEE-compliance of floating-point code.
11323 @item -misize
11324 @opindex misize
11325 Dump instruction size and location in the assembly code.
11327 @item -mpadstruct
11328 @opindex mpadstruct
11329 This option is deprecated.  It pads structures to multiple of 4 bytes,
11330 which is incompatible with the SH ABI@.
11332 @item -mspace
11333 @opindex mspace
11334 Optimize for space instead of speed.  Implied by @option{-Os}.
11336 @item -mprefergot
11337 @opindex mprefergot
11338 When generating position-independent code, emit function calls using
11339 the Global Offset Table instead of the Procedure Linkage Table.
11341 @item -musermode
11342 @opindex musermode
11343 Generate a library function call to invalidate instruction cache
11344 entries, after fixing up a trampoline.  This library function call
11345 doesn't assume it can write to the whole memory address space.  This
11346 is the default when the target is @code{sh-*-linux*}.
11347 @end table
11349 @node SPARC Options
11350 @subsection SPARC Options
11351 @cindex SPARC options
11353 These @samp{-m} options are supported on the SPARC:
11355 @table @gcctabopt
11356 @item -mno-app-regs
11357 @itemx -mapp-regs
11358 @opindex mno-app-regs
11359 @opindex mapp-regs
11360 Specify @option{-mapp-regs} to generate output using the global registers
11361 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11362 is the default.
11364 To be fully SVR4 ABI compliant at the cost of some performance loss,
11365 specify @option{-mno-app-regs}.  You should compile libraries and system
11366 software with this option.
11368 @item -mfpu
11369 @itemx -mhard-float
11370 @opindex mfpu
11371 @opindex mhard-float
11372 Generate output containing floating point instructions.  This is the
11373 default.
11375 @item -mno-fpu
11376 @itemx -msoft-float
11377 @opindex mno-fpu
11378 @opindex msoft-float
11379 Generate output containing library calls for floating point.
11380 @strong{Warning:} the requisite libraries are not available for all SPARC
11381 targets.  Normally the facilities of the machine's usual C compiler are
11382 used, but this cannot be done directly in cross-compilation.  You must make
11383 your own arrangements to provide suitable library functions for
11384 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11385 @samp{sparclite-*-*} do provide software floating point support.
11387 @option{-msoft-float} changes the calling convention in the output file;
11388 therefore, it is only useful if you compile @emph{all} of a program with
11389 this option.  In particular, you need to compile @file{libgcc.a}, the
11390 library that comes with GCC, with @option{-msoft-float} in order for
11391 this to work.
11393 @item -mhard-quad-float
11394 @opindex mhard-quad-float
11395 Generate output containing quad-word (long double) floating point
11396 instructions.
11398 @item -msoft-quad-float
11399 @opindex msoft-quad-float
11400 Generate output containing library calls for quad-word (long double)
11401 floating point instructions.  The functions called are those specified
11402 in the SPARC ABI@.  This is the default.
11404 As of this writing, there are no SPARC implementations that have hardware
11405 support for the quad-word floating point instructions.  They all invoke
11406 a trap handler for one of these instructions, and then the trap handler
11407 emulates the effect of the instruction.  Because of the trap handler overhead,
11408 this is much slower than calling the ABI library routines.  Thus the
11409 @option{-msoft-quad-float} option is the default.
11411 @item -mno-unaligned-doubles
11412 @itemx -munaligned-doubles
11413 @opindex mno-unaligned-doubles
11414 @opindex munaligned-doubles
11415 Assume that doubles have 8 byte alignment.  This is the default.
11417 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11418 alignment only if they are contained in another type, or if they have an
11419 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11420 Specifying this option avoids some rare compatibility problems with code
11421 generated by other compilers.  It is not the default because it results
11422 in a performance loss, especially for floating point code.
11424 @item -mno-faster-structs
11425 @itemx -mfaster-structs
11426 @opindex mno-faster-structs
11427 @opindex mfaster-structs
11428 With @option{-mfaster-structs}, the compiler assumes that structures
11429 should have 8 byte alignment.  This enables the use of pairs of
11430 @code{ldd} and @code{std} instructions for copies in structure
11431 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11432 However, the use of this changed alignment directly violates the SPARC
11433 ABI@.  Thus, it's intended only for use on targets where the developer
11434 acknowledges that their resulting code will not be directly in line with
11435 the rules of the ABI@.
11437 @item -mimpure-text
11438 @opindex mimpure-text
11439 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11440 the compiler to not pass @option{-z text} to the linker when linking a
11441 shared object.  Using this option, you can link position-dependent
11442 code into a shared object.
11444 @option{-mimpure-text} suppresses the ``relocations remain against
11445 allocatable but non-writable sections'' linker error message.
11446 However, the necessary relocations will trigger copy-on-write, and the
11447 shared object is not actually shared across processes.  Instead of
11448 using @option{-mimpure-text}, you should compile all source code with
11449 @option{-fpic} or @option{-fPIC}.
11451 This option is only available on SunOS and Solaris.
11453 @item -mcpu=@var{cpu_type}
11454 @opindex mcpu
11455 Set the instruction set, register set, and instruction scheduling parameters
11456 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11457 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11458 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11459 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11460 @samp{ultrasparc3}.
11462 Default instruction scheduling parameters are used for values that select
11463 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11464 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11466 Here is a list of each supported architecture and their supported
11467 implementations.
11469 @smallexample
11470     v7:             cypress
11471     v8:             supersparc, hypersparc
11472     sparclite:      f930, f934, sparclite86x
11473     sparclet:       tsc701
11474     v9:             ultrasparc, ultrasparc3
11475 @end smallexample
11477 By default (unless configured otherwise), GCC generates code for the V7
11478 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11479 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11480 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11481 SPARCStation 1, 2, IPX etc.
11483 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11484 architecture.  The only difference from V7 code is that the compiler emits
11485 the integer multiply and integer divide instructions which exist in SPARC-V8
11486 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11487 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11488 2000 series.
11490 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11491 the SPARC architecture.  This adds the integer multiply, integer divide step
11492 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11493 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11494 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11495 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11496 MB86934 chip, which is the more recent SPARClite with FPU@.
11498 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11499 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11500 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11501 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11502 optimizes it for the TEMIC SPARClet chip.
11504 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11505 architecture.  This adds 64-bit integer and floating-point move instructions,
11506 3 additional floating-point condition code registers and conditional move
11507 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11508 optimizes it for the Sun UltraSPARC I/II chips.  With
11509 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11510 Sun UltraSPARC III chip.
11512 @item -mtune=@var{cpu_type}
11513 @opindex mtune
11514 Set the instruction scheduling parameters for machine type
11515 @var{cpu_type}, but do not set the instruction set or register set that the
11516 option @option{-mcpu=@var{cpu_type}} would.
11518 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11519 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11520 that select a particular cpu implementation.  Those are @samp{cypress},
11521 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11522 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11523 @samp{ultrasparc3}.
11525 @item -mv8plus
11526 @itemx -mno-v8plus
11527 @opindex mv8plus
11528 @opindex mno-v8plus
11529 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11530 difference from the V8 ABI is that the global and out registers are
11531 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11532 mode for all SPARC-V9 processors.
11534 @item -mvis
11535 @itemx -mno-vis
11536 @opindex mvis
11537 @opindex mno-vis
11538 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11539 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11540 @end table
11542 These @samp{-m} options are supported in addition to the above
11543 on SPARC-V9 processors in 64-bit environments:
11545 @table @gcctabopt
11546 @item -mlittle-endian
11547 @opindex mlittle-endian
11548 Generate code for a processor running in little-endian mode.  It is only
11549 available for a few configurations and most notably not on Solaris.
11551 @item -m32
11552 @itemx -m64
11553 @opindex m32
11554 @opindex m64
11555 Generate code for a 32-bit or 64-bit environment.
11556 The 32-bit environment sets int, long and pointer to 32 bits.
11557 The 64-bit environment sets int to 32 bits and long and pointer
11558 to 64 bits.
11560 @item -mcmodel=medlow
11561 @opindex mcmodel=medlow
11562 Generate code for the Medium/Low code model: 64-bit addresses, programs
11563 must be linked in the low 32 bits of memory.  Programs can be statically
11564 or dynamically linked.
11566 @item -mcmodel=medmid
11567 @opindex mcmodel=medmid
11568 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11569 must be linked in the low 44 bits of memory, the text and data segments must
11570 be less than 2GB in size and the data segment must be located within 2GB of
11571 the text segment.
11573 @item -mcmodel=medany
11574 @opindex mcmodel=medany
11575 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11576 may be linked anywhere in memory, the text and data segments must be less
11577 than 2GB in size and the data segment must be located within 2GB of the
11578 text segment.
11580 @item -mcmodel=embmedany
11581 @opindex mcmodel=embmedany
11582 Generate code for the Medium/Anywhere code model for embedded systems:
11583 64-bit addresses, the text and data segments must be less than 2GB in
11584 size, both starting anywhere in memory (determined at link time).  The
11585 global register %g4 points to the base of the data segment.  Programs
11586 are statically linked and PIC is not supported.
11588 @item -mstack-bias
11589 @itemx -mno-stack-bias
11590 @opindex mstack-bias
11591 @opindex mno-stack-bias
11592 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11593 frame pointer if present, are offset by @minus{}2047 which must be added back
11594 when making stack frame references.  This is the default in 64-bit mode.
11595 Otherwise, assume no such offset is present.
11596 @end table
11598 These switches are supported in addition to the above on Solaris:
11600 @table @gcctabopt
11601 @item -threads
11602 @opindex threads
11603 Add support for multithreading using the Solaris threads library.  This
11604 option sets flags for both the preprocessor and linker.  This option does
11605 not affect the thread safety of object code produced by the compiler or
11606 that of libraries supplied with it.
11608 @item -pthreads
11609 @opindex pthreads
11610 Add support for multithreading using the POSIX threads library.  This
11611 option sets flags for both the preprocessor and linker.  This option does
11612 not affect the thread safety of object code produced  by the compiler or
11613 that of libraries supplied with it.
11614 @end table
11616 @node System V Options
11617 @subsection Options for System V
11619 These additional options are available on System V Release 4 for
11620 compatibility with other compilers on those systems:
11622 @table @gcctabopt
11623 @item -G
11624 @opindex G
11625 Create a shared object.
11626 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11628 @item -Qy
11629 @opindex Qy
11630 Identify the versions of each tool used by the compiler, in a
11631 @code{.ident} assembler directive in the output.
11633 @item -Qn
11634 @opindex Qn
11635 Refrain from adding @code{.ident} directives to the output file (this is
11636 the default).
11638 @item -YP,@var{dirs}
11639 @opindex YP
11640 Search the directories @var{dirs}, and no others, for libraries
11641 specified with @option{-l}.
11643 @item -Ym,@var{dir}
11644 @opindex Ym
11645 Look in the directory @var{dir} to find the M4 preprocessor.
11646 The assembler uses this option.
11647 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11648 @c the generic assembler that comes with Solaris takes just -Ym.
11649 @end table
11651 @node TMS320C3x/C4x Options
11652 @subsection TMS320C3x/C4x Options
11653 @cindex TMS320C3x/C4x Options
11655 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11657 @table @gcctabopt
11659 @item -mcpu=@var{cpu_type}
11660 @opindex mcpu
11661 Set the instruction set, register set, and instruction scheduling
11662 parameters for machine type @var{cpu_type}.  Supported values for
11663 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11664 @samp{c44}.  The default is @samp{c40} to generate code for the
11665 TMS320C40.
11667 @item -mbig-memory
11668 @itemx -mbig
11669 @itemx -msmall-memory
11670 @itemx -msmall
11671 @opindex mbig-memory
11672 @opindex mbig
11673 @opindex msmall-memory
11674 @opindex msmall
11675 Generates code for the big or small memory model.  The small memory
11676 model assumed that all data fits into one 64K word page.  At run-time
11677 the data page (DP) register must be set to point to the 64K page
11678 containing the .bss and .data program sections.  The big memory model is
11679 the default and requires reloading of the DP register for every direct
11680 memory access.
11682 @item -mbk
11683 @itemx -mno-bk
11684 @opindex mbk
11685 @opindex mno-bk
11686 Allow (disallow) allocation of general integer operands into the block
11687 count register BK@.
11689 @item -mdb
11690 @itemx -mno-db
11691 @opindex mdb
11692 @opindex mno-db
11693 Enable (disable) generation of code using decrement and branch,
11694 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11695 on the safe side, this is disabled for the C3x, since the maximum
11696 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11697 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11698 that it can utilize the decrement and branch instruction, but will give
11699 up if there is more than one memory reference in the loop.  Thus a loop
11700 where the loop counter is decremented can generate slightly more
11701 efficient code, in cases where the RPTB instruction cannot be utilized.
11703 @item -mdp-isr-reload
11704 @itemx -mparanoid
11705 @opindex mdp-isr-reload
11706 @opindex mparanoid
11707 Force the DP register to be saved on entry to an interrupt service
11708 routine (ISR), reloaded to point to the data section, and restored on
11709 exit from the ISR@.  This should not be required unless someone has
11710 violated the small memory model by modifying the DP register, say within
11711 an object library.
11713 @item -mmpyi
11714 @itemx -mno-mpyi
11715 @opindex mmpyi
11716 @opindex mno-mpyi
11717 For the C3x use the 24-bit MPYI instruction for integer multiplies
11718 instead of a library call to guarantee 32-bit results.  Note that if one
11719 of the operands is a constant, then the multiplication will be performed
11720 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11721 then squaring operations are performed inline instead of a library call.
11723 @item -mfast-fix
11724 @itemx -mno-fast-fix
11725 @opindex mfast-fix
11726 @opindex mno-fast-fix
11727 The C3x/C4x FIX instruction to convert a floating point value to an
11728 integer value chooses the nearest integer less than or equal to the
11729 floating point value rather than to the nearest integer.  Thus if the
11730 floating point number is negative, the result will be incorrectly
11731 truncated an additional code is necessary to detect and correct this
11732 case.  This option can be used to disable generation of the additional
11733 code required to correct the result.
11735 @item -mrptb
11736 @itemx -mno-rptb
11737 @opindex mrptb
11738 @opindex mno-rptb
11739 Enable (disable) generation of repeat block sequences using the RPTB
11740 instruction for zero overhead looping.  The RPTB construct is only used
11741 for innermost loops that do not call functions or jump across the loop
11742 boundaries.  There is no advantage having nested RPTB loops due to the
11743 overhead required to save and restore the RC, RS, and RE registers.
11744 This is enabled by default with @option{-O2}.
11746 @item -mrpts=@var{count}
11747 @itemx -mno-rpts
11748 @opindex mrpts
11749 @opindex mno-rpts
11750 Enable (disable) the use of the single instruction repeat instruction
11751 RPTS@.  If a repeat block contains a single instruction, and the loop
11752 count can be guaranteed to be less than the value @var{count}, GCC will
11753 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11754 then a RPTS will be emitted even if the loop count cannot be determined
11755 at compile time.  Note that the repeated instruction following RPTS does
11756 not have to be reloaded from memory each iteration, thus freeing up the
11757 CPU buses for operands.  However, since interrupts are blocked by this
11758 instruction, it is disabled by default.
11760 @item -mloop-unsigned
11761 @itemx -mno-loop-unsigned
11762 @opindex mloop-unsigned
11763 @opindex mno-loop-unsigned
11764 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11765 is @math{2^{31} + 1} since these instructions test if the iteration count is
11766 negative to terminate the loop.  If the iteration count is unsigned
11767 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11768 exceeded.  This switch allows an unsigned iteration count.
11770 @item -mti
11771 @opindex mti
11772 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11773 with.  This also enforces compatibility with the API employed by the TI
11774 C3x C compiler.  For example, long doubles are passed as structures
11775 rather than in floating point registers.
11777 @item -mregparm
11778 @itemx -mmemparm
11779 @opindex mregparm
11780 @opindex mmemparm
11781 Generate code that uses registers (stack) for passing arguments to functions.
11782 By default, arguments are passed in registers where possible rather
11783 than by pushing arguments on to the stack.
11785 @item -mparallel-insns
11786 @itemx -mno-parallel-insns
11787 @opindex mparallel-insns
11788 @opindex mno-parallel-insns
11789 Allow the generation of parallel instructions.  This is enabled by
11790 default with @option{-O2}.
11792 @item -mparallel-mpy
11793 @itemx -mno-parallel-mpy
11794 @opindex mparallel-mpy
11795 @opindex mno-parallel-mpy
11796 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11797 provided @option{-mparallel-insns} is also specified.  These instructions have
11798 tight register constraints which can pessimize the code generation
11799 of large functions.
11801 @end table
11803 @node V850 Options
11804 @subsection V850 Options
11805 @cindex V850 Options
11807 These @samp{-m} options are defined for V850 implementations:
11809 @table @gcctabopt
11810 @item -mlong-calls
11811 @itemx -mno-long-calls
11812 @opindex mlong-calls
11813 @opindex mno-long-calls
11814 Treat all calls as being far away (near).  If calls are assumed to be
11815 far away, the compiler will always load the functions address up into a
11816 register, and call indirect through the pointer.
11818 @item -mno-ep
11819 @itemx -mep
11820 @opindex mno-ep
11821 @opindex mep
11822 Do not optimize (do optimize) basic blocks that use the same index
11823 pointer 4 or more times to copy pointer into the @code{ep} register, and
11824 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11825 option is on by default if you optimize.
11827 @item -mno-prolog-function
11828 @itemx -mprolog-function
11829 @opindex mno-prolog-function
11830 @opindex mprolog-function
11831 Do not use (do use) external functions to save and restore registers
11832 at the prologue and epilogue of a function.  The external functions
11833 are slower, but use less code space if more than one function saves
11834 the same number of registers.  The @option{-mprolog-function} option
11835 is on by default if you optimize.
11837 @item -mspace
11838 @opindex mspace
11839 Try to make the code as small as possible.  At present, this just turns
11840 on the @option{-mep} and @option{-mprolog-function} options.
11842 @item -mtda=@var{n}
11843 @opindex mtda
11844 Put static or global variables whose size is @var{n} bytes or less into
11845 the tiny data area that register @code{ep} points to.  The tiny data
11846 area can hold up to 256 bytes in total (128 bytes for byte references).
11848 @item -msda=@var{n}
11849 @opindex msda
11850 Put static or global variables whose size is @var{n} bytes or less into
11851 the small data area that register @code{gp} points to.  The small data
11852 area can hold up to 64 kilobytes.
11854 @item -mzda=@var{n}
11855 @opindex mzda
11856 Put static or global variables whose size is @var{n} bytes or less into
11857 the first 32 kilobytes of memory.
11859 @item -mv850
11860 @opindex mv850
11861 Specify that the target processor is the V850.
11863 @item -mbig-switch
11864 @opindex mbig-switch
11865 Generate code suitable for big switch tables.  Use this option only if
11866 the assembler/linker complain about out of range branches within a switch
11867 table.
11869 @item -mapp-regs
11870 @opindex mapp-regs
11871 This option will cause r2 and r5 to be used in the code generated by
11872 the compiler.  This setting is the default.
11874 @item -mno-app-regs
11875 @opindex mno-app-regs
11876 This option will cause r2 and r5 to be treated as fixed registers.
11878 @item -mv850e1
11879 @opindex mv850e1
11880 Specify that the target processor is the V850E1.  The preprocessor
11881 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11882 this option is used.
11884 @item -mv850e
11885 @opindex mv850e
11886 Specify that the target processor is the V850E@.  The preprocessor
11887 constant @samp{__v850e__} will be defined if this option is used.
11889 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11890 are defined then a default target processor will be chosen and the
11891 relevant @samp{__v850*__} preprocessor constant will be defined.
11893 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11894 defined, regardless of which processor variant is the target.
11896 @item -mdisable-callt
11897 @opindex mdisable-callt
11898 This option will suppress generation of the CALLT instruction for the
11899 v850e and v850e1 flavors of the v850 architecture.  The default is
11900 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11902 @end table
11904 @node VAX Options
11905 @subsection VAX Options
11906 @cindex VAX options
11908 These @samp{-m} options are defined for the VAX:
11910 @table @gcctabopt
11911 @item -munix
11912 @opindex munix
11913 Do not output certain jump instructions (@code{aobleq} and so on)
11914 that the Unix assembler for the VAX cannot handle across long
11915 ranges.
11917 @item -mgnu
11918 @opindex mgnu
11919 Do output those jump instructions, on the assumption that you
11920 will assemble with the GNU assembler.
11922 @item -mg
11923 @opindex mg
11924 Output code for g-format floating point numbers instead of d-format.
11925 @end table
11927 @node x86-64 Options
11928 @subsection x86-64 Options
11929 @cindex x86-64 options
11931 These are listed under @xref{i386 and x86-64 Options}.
11933 @node Xstormy16 Options
11934 @subsection Xstormy16 Options
11935 @cindex Xstormy16 Options
11937 These options are defined for Xstormy16:
11939 @table @gcctabopt
11940 @item -msim
11941 @opindex msim
11942 Choose startup files and linker script suitable for the simulator.
11943 @end table
11945 @node Xtensa Options
11946 @subsection Xtensa Options
11947 @cindex Xtensa Options
11949 These options are supported for Xtensa targets:
11951 @table @gcctabopt
11952 @item -mconst16
11953 @itemx -mno-const16
11954 @opindex mconst16
11955 @opindex mno-const16
11956 Enable or disable use of @code{CONST16} instructions for loading
11957 constant values.  The @code{CONST16} instruction is currently not a
11958 standard option from Tensilica.  When enabled, @code{CONST16}
11959 instructions are always used in place of the standard @code{L32R}
11960 instructions.  The use of @code{CONST16} is enabled by default only if
11961 the @code{L32R} instruction is not available.
11963 @item -mfused-madd
11964 @itemx -mno-fused-madd
11965 @opindex mfused-madd
11966 @opindex mno-fused-madd
11967 Enable or disable use of fused multiply/add and multiply/subtract
11968 instructions in the floating-point option.  This has no effect if the
11969 floating-point option is not also enabled.  Disabling fused multiply/add
11970 and multiply/subtract instructions forces the compiler to use separate
11971 instructions for the multiply and add/subtract operations.  This may be
11972 desirable in some cases where strict IEEE 754-compliant results are
11973 required: the fused multiply add/subtract instructions do not round the
11974 intermediate result, thereby producing results with @emph{more} bits of
11975 precision than specified by the IEEE standard.  Disabling fused multiply
11976 add/subtract instructions also ensures that the program output is not
11977 sensitive to the compiler's ability to combine multiply and add/subtract
11978 operations.
11980 @item -mtext-section-literals
11981 @itemx -mno-text-section-literals
11982 @opindex mtext-section-literals
11983 @opindex mno-text-section-literals
11984 Control the treatment of literal pools.  The default is
11985 @option{-mno-text-section-literals}, which places literals in a separate
11986 section in the output file.  This allows the literal pool to be placed
11987 in a data RAM/ROM, and it also allows the linker to combine literal
11988 pools from separate object files to remove redundant literals and
11989 improve code size.  With @option{-mtext-section-literals}, the literals
11990 are interspersed in the text section in order to keep them as close as
11991 possible to their references.  This may be necessary for large assembly
11992 files.
11994 @item -mtarget-align
11995 @itemx -mno-target-align
11996 @opindex mtarget-align
11997 @opindex mno-target-align
11998 When this option is enabled, GCC instructs the assembler to
11999 automatically align instructions to reduce branch penalties at the
12000 expense of some code density.  The assembler attempts to widen density
12001 instructions to align branch targets and the instructions following call
12002 instructions.  If there are not enough preceding safe density
12003 instructions to align a target, no widening will be performed.  The
12004 default is @option{-mtarget-align}.  These options do not affect the
12005 treatment of auto-aligned instructions like @code{LOOP}, which the
12006 assembler will always align, either by widening density instructions or
12007 by inserting no-op instructions.
12009 @item -mlongcalls
12010 @itemx -mno-longcalls
12011 @opindex mlongcalls
12012 @opindex mno-longcalls
12013 When this option is enabled, GCC instructs the assembler to translate
12014 direct calls to indirect calls unless it can determine that the target
12015 of a direct call is in the range allowed by the call instruction.  This
12016 translation typically occurs for calls to functions in other source
12017 files.  Specifically, the assembler translates a direct @code{CALL}
12018 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12019 The default is @option{-mno-longcalls}.  This option should be used in
12020 programs where the call target can potentially be out of range.  This
12021 option is implemented in the assembler, not the compiler, so the
12022 assembly code generated by GCC will still show direct call
12023 instructions---look at the disassembled object code to see the actual
12024 instructions.  Note that the assembler will use an indirect call for
12025 every cross-file call, not just those that really will be out of range.
12026 @end table
12028 @node zSeries Options
12029 @subsection zSeries Options
12030 @cindex zSeries options
12032 These are listed under @xref{S/390 and zSeries Options}.
12034 @node Code Gen Options
12035 @section Options for Code Generation Conventions
12036 @cindex code generation conventions
12037 @cindex options, code generation
12038 @cindex run-time options
12040 These machine-independent options control the interface conventions
12041 used in code generation.
12043 Most of them have both positive and negative forms; the negative form
12044 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
12045 one of the forms is listed---the one which is not the default.  You
12046 can figure out the other form by either removing @samp{no-} or adding
12049 @table @gcctabopt
12050 @item -fbounds-check
12051 @opindex fbounds-check
12052 For front-ends that support it, generate additional code to check that
12053 indices used to access arrays are within the declared range.  This is
12054 currently only supported by the Java and Fortran 77 front-ends, where
12055 this option defaults to true and false respectively.
12057 @item -ftrapv
12058 @opindex ftrapv
12059 This option generates traps for signed overflow on addition, subtraction,
12060 multiplication operations.
12062 @item -fwrapv
12063 @opindex fwrapv
12064 This option instructs the compiler to assume that signed arithmetic
12065 overflow of addition, subtraction and multiplication wraps around
12066 using twos-complement representation.  This flag enables some optimizations
12067 and disables other.  This option is enabled by default for the Java
12068 front-end, as required by the Java language specification.
12070 @item -fexceptions
12071 @opindex fexceptions
12072 Enable exception handling.  Generates extra code needed to propagate
12073 exceptions.  For some targets, this implies GCC will generate frame
12074 unwind information for all functions, which can produce significant data
12075 size overhead, although it does not affect execution.  If you do not
12076 specify this option, GCC will enable it by default for languages like
12077 C++ which normally require exception handling, and disable it for
12078 languages like C that do not normally require it.  However, you may need
12079 to enable this option when compiling C code that needs to interoperate
12080 properly with exception handlers written in C++.  You may also wish to
12081 disable this option if you are compiling older C++ programs that don't
12082 use exception handling.
12084 @item -fnon-call-exceptions
12085 @opindex fnon-call-exceptions
12086 Generate code that allows trapping instructions to throw exceptions.
12087 Note that this requires platform-specific runtime support that does
12088 not exist everywhere.  Moreover, it only allows @emph{trapping}
12089 instructions to throw exceptions, i.e.@: memory references or floating
12090 point instructions.  It does not allow exceptions to be thrown from
12091 arbitrary signal handlers such as @code{SIGALRM}.
12093 @item -funwind-tables
12094 @opindex funwind-tables
12095 Similar to @option{-fexceptions}, except that it will just generate any needed
12096 static data, but will not affect the generated code in any other way.
12097 You will normally not enable this option; instead, a language processor
12098 that needs this handling would enable it on your behalf.
12100 @item -fasynchronous-unwind-tables
12101 @opindex fasynchronous-unwind-tables
12102 Generate unwind table in dwarf2 format, if supported by target machine.  The
12103 table is exact at each instruction boundary, so it can be used for stack
12104 unwinding from asynchronous events (such as debugger or garbage collector).
12106 @item -fpcc-struct-return
12107 @opindex fpcc-struct-return
12108 Return ``short'' @code{struct} and @code{union} values in memory like
12109 longer ones, rather than in registers.  This convention is less
12110 efficient, but it has the advantage of allowing intercallability between
12111 GCC-compiled files and files compiled with other compilers, particularly
12112 the Portable C Compiler (pcc).
12114 The precise convention for returning structures in memory depends
12115 on the target configuration macros.
12117 Short structures and unions are those whose size and alignment match
12118 that of some integer type.
12120 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12121 switch is not binary compatible with code compiled with the
12122 @option{-freg-struct-return} switch.
12123 Use it to conform to a non-default application binary interface.
12125 @item -freg-struct-return
12126 @opindex freg-struct-return
12127 Return @code{struct} and @code{union} values in registers when possible.
12128 This is more efficient for small structures than
12129 @option{-fpcc-struct-return}.
12131 If you specify neither @option{-fpcc-struct-return} nor
12132 @option{-freg-struct-return}, GCC defaults to whichever convention is
12133 standard for the target.  If there is no standard convention, GCC
12134 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12135 the principal compiler.  In those cases, we can choose the standard, and
12136 we chose the more efficient register return alternative.
12138 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12139 switch is not binary compatible with code compiled with the
12140 @option{-fpcc-struct-return} switch.
12141 Use it to conform to a non-default application binary interface.
12143 @item -fshort-enums
12144 @opindex fshort-enums
12145 Allocate to an @code{enum} type only as many bytes as it needs for the
12146 declared range of possible values.  Specifically, the @code{enum} type
12147 will be equivalent to the smallest integer type which has enough room.
12149 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12150 code that is not binary compatible with code generated without that switch.
12151 Use it to conform to a non-default application binary interface.
12153 @item -fshort-double
12154 @opindex fshort-double
12155 Use the same size for @code{double} as for @code{float}.
12157 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12158 code that is not binary compatible with code generated without that switch.
12159 Use it to conform to a non-default application binary interface.
12161 @item -fshort-wchar
12162 @opindex fshort-wchar
12163 Override the underlying type for @samp{wchar_t} to be @samp{short
12164 unsigned int} instead of the default for the target.  This option is
12165 useful for building programs to run under WINE@.
12167 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12168 code that is not binary compatible with code generated without that switch.
12169 Use it to conform to a non-default application binary interface.
12171 @item -fshared-data
12172 @opindex fshared-data
12173 Requests that the data and non-@code{const} variables of this
12174 compilation be shared data rather than private data.  The distinction
12175 makes sense only on certain operating systems, where shared data is
12176 shared between processes running the same program, while private data
12177 exists in one copy per process.
12179 @item -fno-common
12180 @opindex fno-common
12181 In C, allocate even uninitialized global variables in the data section of the
12182 object file, rather than generating them as common blocks.  This has the
12183 effect that if the same variable is declared (without @code{extern}) in
12184 two different compilations, you will get an error when you link them.
12185 The only reason this might be useful is if you wish to verify that the
12186 program will work on other systems which always work this way.
12188 @item -fno-ident
12189 @opindex fno-ident
12190 Ignore the @samp{#ident} directive.
12192 @item -finhibit-size-directive
12193 @opindex finhibit-size-directive
12194 Don't output a @code{.size} assembler directive, or anything else that
12195 would cause trouble if the function is split in the middle, and the
12196 two halves are placed at locations far apart in memory.  This option is
12197 used when compiling @file{crtstuff.c}; you should not need to use it
12198 for anything else.
12200 @item -fverbose-asm
12201 @opindex fverbose-asm
12202 Put extra commentary information in the generated assembly code to
12203 make it more readable.  This option is generally only of use to those
12204 who actually need to read the generated assembly code (perhaps while
12205 debugging the compiler itself).
12207 @option{-fno-verbose-asm}, the default, causes the
12208 extra information to be omitted and is useful when comparing two assembler
12209 files.
12211 @item -fpic
12212 @opindex fpic
12213 @cindex global offset table
12214 @cindex PIC
12215 Generate position-independent code (PIC) suitable for use in a shared
12216 library, if supported for the target machine.  Such code accesses all
12217 constant addresses through a global offset table (GOT)@.  The dynamic
12218 loader resolves the GOT entries when the program starts (the dynamic
12219 loader is not part of GCC; it is part of the operating system).  If
12220 the GOT size for the linked executable exceeds a machine-specific
12221 maximum size, you get an error message from the linker indicating that
12222 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12223 instead.  (These maximums are 8k on the SPARC and 32k
12224 on the m68k and RS/6000.  The 386 has no such limit.)
12226 Position-independent code requires special support, and therefore works
12227 only on certain machines.  For the 386, GCC supports PIC for System V
12228 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12229 position-independent.
12231 @item -fPIC
12232 @opindex fPIC
12233 If supported for the target machine, emit position-independent code,
12234 suitable for dynamic linking and avoiding any limit on the size of the
12235 global offset table.  This option makes a difference on the m68k,
12236 PowerPC and SPARC@.
12238 Position-independent code requires special support, and therefore works
12239 only on certain machines.
12241 @item -fpie
12242 @itemx -fPIE
12243 @opindex fpie
12244 @opindex fPIE
12245 These options are similar to @option{-fpic} and @option{-fPIC}, but
12246 generated position independent code can be only linked into executables.
12247 Usually these options are used when @option{-pie} GCC option will be
12248 used during linking.
12250 @item -ffixed-@var{reg}
12251 @opindex ffixed
12252 Treat the register named @var{reg} as a fixed register; generated code
12253 should never refer to it (except perhaps as a stack pointer, frame
12254 pointer or in some other fixed role).
12256 @var{reg} must be the name of a register.  The register names accepted
12257 are machine-specific and are defined in the @code{REGISTER_NAMES}
12258 macro in the machine description macro file.
12260 This flag does not have a negative form, because it specifies a
12261 three-way choice.
12263 @item -fcall-used-@var{reg}
12264 @opindex fcall-used
12265 Treat the register named @var{reg} as an allocable register that is
12266 clobbered by function calls.  It may be allocated for temporaries or
12267 variables that do not live across a call.  Functions compiled this way
12268 will not save and restore the register @var{reg}.
12270 It is an error to used this flag with the frame pointer or stack pointer.
12271 Use of this flag for other registers that have fixed pervasive roles in
12272 the machine's execution model will produce disastrous results.
12274 This flag does not have a negative form, because it specifies a
12275 three-way choice.
12277 @item -fcall-saved-@var{reg}
12278 @opindex fcall-saved
12279 Treat the register named @var{reg} as an allocable register saved by
12280 functions.  It may be allocated even for temporaries or variables that
12281 live across a call.  Functions compiled this way will save and restore
12282 the register @var{reg} if they use it.
12284 It is an error to used this flag with the frame pointer or stack pointer.
12285 Use of this flag for other registers that have fixed pervasive roles in
12286 the machine's execution model will produce disastrous results.
12288 A different sort of disaster will result from the use of this flag for
12289 a register in which function values may be returned.
12291 This flag does not have a negative form, because it specifies a
12292 three-way choice.
12294 @item -fpack-struct[=@var{n}]
12295 @opindex fpack-struct
12296 Without a value specified, pack all structure members together without
12297 holes.  When a value is specified (which must be a small power of two), pack
12298 structure members according to this value, representing the maximum
12299 alignment (that is, objects with default alignment requirements larger than
12300 this will be output potentially unaligned at the next fitting location.
12302 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12303 code that is not binary compatible with code generated without that switch.
12304 Additionally, it makes the code suboptimal.
12305 Use it to conform to a non-default application binary interface.
12307 @item -finstrument-functions
12308 @opindex finstrument-functions
12309 Generate instrumentation calls for entry and exit to functions.  Just
12310 after function entry and just before function exit, the following
12311 profiling functions will be called with the address of the current
12312 function and its call site.  (On some platforms,
12313 @code{__builtin_return_address} does not work beyond the current
12314 function, so the call site information may not be available to the
12315 profiling functions otherwise.)
12317 @smallexample
12318 void __cyg_profile_func_enter (void *this_fn,
12319                                void *call_site);
12320 void __cyg_profile_func_exit  (void *this_fn,
12321                                void *call_site);
12322 @end smallexample
12324 The first argument is the address of the start of the current function,
12325 which may be looked up exactly in the symbol table.
12327 This instrumentation is also done for functions expanded inline in other
12328 functions.  The profiling calls will indicate where, conceptually, the
12329 inline function is entered and exited.  This means that addressable
12330 versions of such functions must be available.  If all your uses of a
12331 function are expanded inline, this may mean an additional expansion of
12332 code size.  If you use @samp{extern inline} in your C code, an
12333 addressable version of such functions must be provided.  (This is
12334 normally the case anyways, but if you get lucky and the optimizer always
12335 expands the functions inline, you might have gotten away without
12336 providing static copies.)
12338 A function may be given the attribute @code{no_instrument_function}, in
12339 which case this instrumentation will not be done.  This can be used, for
12340 example, for the profiling functions listed above, high-priority
12341 interrupt routines, and any functions from which the profiling functions
12342 cannot safely be called (perhaps signal handlers, if the profiling
12343 routines generate output or allocate memory).
12345 @item -fstack-check
12346 @opindex fstack-check
12347 Generate code to verify that you do not go beyond the boundary of the
12348 stack.  You should specify this flag if you are running in an
12349 environment with multiple threads, but only rarely need to specify it in
12350 a single-threaded environment since stack overflow is automatically
12351 detected on nearly all systems if there is only one stack.
12353 Note that this switch does not actually cause checking to be done; the
12354 operating system must do that.  The switch causes generation of code
12355 to ensure that the operating system sees the stack being extended.
12357 @item -fstack-limit-register=@var{reg}
12358 @itemx -fstack-limit-symbol=@var{sym}
12359 @itemx -fno-stack-limit
12360 @opindex fstack-limit-register
12361 @opindex fstack-limit-symbol
12362 @opindex fno-stack-limit
12363 Generate code to ensure that the stack does not grow beyond a certain value,
12364 either the value of a register or the address of a symbol.  If the stack
12365 would grow beyond the value, a signal is raised.  For most targets,
12366 the signal is raised before the stack overruns the boundary, so
12367 it is possible to catch the signal without taking special precautions.
12369 For instance, if the stack starts at absolute address @samp{0x80000000}
12370 and grows downwards, you can use the flags
12371 @option{-fstack-limit-symbol=__stack_limit} and
12372 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12373 of 128KB@.  Note that this may only work with the GNU linker.
12375 @cindex aliasing of parameters
12376 @cindex parameters, aliased
12377 @item -fargument-alias
12378 @itemx -fargument-noalias
12379 @itemx -fargument-noalias-global
12380 @opindex fargument-alias
12381 @opindex fargument-noalias
12382 @opindex fargument-noalias-global
12383 Specify the possible relationships among parameters and between
12384 parameters and global data.
12386 @option{-fargument-alias} specifies that arguments (parameters) may
12387 alias each other and may alias global storage.@*
12388 @option{-fargument-noalias} specifies that arguments do not alias
12389 each other, but may alias global storage.@*
12390 @option{-fargument-noalias-global} specifies that arguments do not
12391 alias each other and do not alias global storage.
12393 Each language will automatically use whatever option is required by
12394 the language standard.  You should not need to use these options yourself.
12396 @item -fleading-underscore
12397 @opindex fleading-underscore
12398 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12399 change the way C symbols are represented in the object file.  One use
12400 is to help link with legacy assembly code.
12402 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12403 generate code that is not binary compatible with code generated without that
12404 switch.  Use it to conform to a non-default application binary interface.
12405 Not all targets provide complete support for this switch.
12407 @item -ftls-model=@var{model}
12408 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12409 The @var{model} argument should be one of @code{global-dynamic},
12410 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12412 The default without @option{-fpic} is @code{initial-exec}; with
12413 @option{-fpic} the default is @code{global-dynamic}.
12415 @item -fvisibility=@var{default|internal|hidden|protected}
12416 @opindex fvisibility
12417 Set the default ELF image symbol visibility to the specified option---all
12418 symbols will be marked with this unless overridden within the code.
12419 Using this feature can very substantially improve linking and
12420 load times of shared object libraries, produce more optimized
12421 code, provide near-perfect API export and prevent symbol clashes.
12422 It is @strong{strongly} recommended that you use this in any shared objects
12423 you distribute.
12425 Despite the nomenclature, @code{default} always means public ie;
12426 available to be linked against from outside the shared object.
12427 @code{protected} and @code{internal} are pretty useless in real-world
12428 usage so the only other commonly used option will be @code{hidden}.
12429 The default if @option{-fvisibility} isn't specified is
12430 @code{default}, i.e., make every
12431 symbol public---this causes the same behavior as previous versions of
12432 GCC@.
12434 A good explanation of the benefits offered by ensuring ELF
12435 symbols have the correct visibility is given by ``How To Write
12436 Shared Libraries'' by Ulrich Drepper (which can be found at
12437 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12438 solution made possible by this option to marking things hidden when
12439 the default is public is to make the default hidden and mark things
12440 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12441 and @code{__attribute__ ((visibility("default")))} instead of
12442 @code{__declspec(dllexport)} you get almost identical semantics with
12443 identical syntax.  This is a great boon to those working with
12444 cross-platform projects.
12446 For those adding visibility support to existing code, you may find
12447 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12448 the declarations you wish to set visibility for with (for example)
12449 @samp{#pragma GCC visibility push(hidden)} and
12450 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12451 times.  Bear in mind that symbol visibility should be viewed @strong{as
12452 part of the API interface contract} and thus all new code should
12453 always specify visibility when it is not the default ie; declarations
12454 only for use within the local DSO should @strong{always} be marked explicitly
12455 as hidden as so to avoid PLT indirection overheads---making this
12456 abundantly clear also aids readability and self-documentation of the code.
12457 Note that due to ISO C++ specification requirements, operator new and
12458 operator delete must always be of default visibility.
12460 An overview of these techniques, their benefits and how to use them
12461 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12463 @end table
12465 @c man end
12467 @node Environment Variables
12468 @section Environment Variables Affecting GCC
12469 @cindex environment variables
12471 @c man begin ENVIRONMENT
12472 This section describes several environment variables that affect how GCC
12473 operates.  Some of them work by specifying directories or prefixes to use
12474 when searching for various kinds of files.  Some are used to specify other
12475 aspects of the compilation environment.
12477 Note that you can also specify places to search using options such as
12478 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12479 take precedence over places specified using environment variables, which
12480 in turn take precedence over those specified by the configuration of GCC@.
12481 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12482 GNU Compiler Collection (GCC) Internals}.
12484 @table @env
12485 @item LANG
12486 @itemx LC_CTYPE
12487 @c @itemx LC_COLLATE
12488 @itemx LC_MESSAGES
12489 @c @itemx LC_MONETARY
12490 @c @itemx LC_NUMERIC
12491 @c @itemx LC_TIME
12492 @itemx LC_ALL
12493 @findex LANG
12494 @findex LC_CTYPE
12495 @c @findex LC_COLLATE
12496 @findex LC_MESSAGES
12497 @c @findex LC_MONETARY
12498 @c @findex LC_NUMERIC
12499 @c @findex LC_TIME
12500 @findex LC_ALL
12501 @cindex locale
12502 These environment variables control the way that GCC uses
12503 localization information that allow GCC to work with different
12504 national conventions.  GCC inspects the locale categories
12505 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12506 so.  These locale categories can be set to any value supported by your
12507 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12508 Kingdom encoded in UTF-8.
12510 The @env{LC_CTYPE} environment variable specifies character
12511 classification.  GCC uses it to determine the character boundaries in
12512 a string; this is needed for some multibyte encodings that contain quote
12513 and escape characters that would otherwise be interpreted as a string
12514 end or escape.
12516 The @env{LC_MESSAGES} environment variable specifies the language to
12517 use in diagnostic messages.
12519 If the @env{LC_ALL} environment variable is set, it overrides the value
12520 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12521 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12522 environment variable.  If none of these variables are set, GCC
12523 defaults to traditional C English behavior.
12525 @item TMPDIR
12526 @findex TMPDIR
12527 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12528 files.  GCC uses temporary files to hold the output of one stage of
12529 compilation which is to be used as input to the next stage: for example,
12530 the output of the preprocessor, which is the input to the compiler
12531 proper.
12533 @item GCC_EXEC_PREFIX
12534 @findex GCC_EXEC_PREFIX
12535 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12536 names of the subprograms executed by the compiler.  No slash is added
12537 when this prefix is combined with the name of a subprogram, but you can
12538 specify a prefix that ends with a slash if you wish.
12540 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12541 an appropriate prefix to use based on the pathname it was invoked with.
12543 If GCC cannot find the subprogram using the specified prefix, it
12544 tries looking in the usual places for the subprogram.
12546 The default value of @env{GCC_EXEC_PREFIX} is
12547 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12548 of @code{prefix} when you ran the @file{configure} script.
12550 Other prefixes specified with @option{-B} take precedence over this prefix.
12552 This prefix is also used for finding files such as @file{crt0.o} that are
12553 used for linking.
12555 In addition, the prefix is used in an unusual way in finding the
12556 directories to search for header files.  For each of the standard
12557 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12558 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12559 replacing that beginning with the specified prefix to produce an
12560 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12561 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12562 These alternate directories are searched first; the standard directories
12563 come next.
12565 @item COMPILER_PATH
12566 @findex COMPILER_PATH
12567 The value of @env{COMPILER_PATH} is a colon-separated list of
12568 directories, much like @env{PATH}.  GCC tries the directories thus
12569 specified when searching for subprograms, if it can't find the
12570 subprograms using @env{GCC_EXEC_PREFIX}.
12572 @item LIBRARY_PATH
12573 @findex LIBRARY_PATH
12574 The value of @env{LIBRARY_PATH} is a colon-separated list of
12575 directories, much like @env{PATH}.  When configured as a native compiler,
12576 GCC tries the directories thus specified when searching for special
12577 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12578 using GCC also uses these directories when searching for ordinary
12579 libraries for the @option{-l} option (but directories specified with
12580 @option{-L} come first).
12582 @item LANG
12583 @findex LANG
12584 @cindex locale definition
12585 This variable is used to pass locale information to the compiler.  One way in
12586 which this information is used is to determine the character set to be used
12587 when character literals, string literals and comments are parsed in C and C++.
12588 When the compiler is configured to allow multibyte characters,
12589 the following values for @env{LANG} are recognized:
12591 @table @samp
12592 @item C-JIS
12593 Recognize JIS characters.
12594 @item C-SJIS
12595 Recognize SJIS characters.
12596 @item C-EUCJP
12597 Recognize EUCJP characters.
12598 @end table
12600 If @env{LANG} is not defined, or if it has some other value, then the
12601 compiler will use mblen and mbtowc as defined by the default locale to
12602 recognize and translate multibyte characters.
12603 @end table
12605 @noindent
12606 Some additional environments variables affect the behavior of the
12607 preprocessor.
12609 @include cppenv.texi
12611 @c man end
12613 @node Precompiled Headers
12614 @section Using Precompiled Headers
12615 @cindex precompiled headers
12616 @cindex speed of compilation
12618 Often large projects have many header files that are included in every
12619 source file.  The time the compiler takes to process these header files
12620 over and over again can account for nearly all of the time required to
12621 build the project.  To make builds faster, GCC allows users to
12622 `precompile' a header file; then, if builds can use the precompiled
12623 header file they will be much faster.
12625 @strong{Caution:} There are a few known situations where GCC will
12626 crash when trying to use a precompiled header.  If you have trouble
12627 with a precompiled header, you should remove the precompiled header
12628 and compile without it.  In addition, please use GCC's on-line
12629 defect-tracking system to report any problems you encounter with
12630 precompiled headers.  @xref{Bugs}.
12632 To create a precompiled header file, simply compile it as you would any
12633 other file, if necessary using the @option{-x} option to make the driver
12634 treat it as a C or C++ header file.  You will probably want to use a
12635 tool like @command{make} to keep the precompiled header up-to-date when
12636 the headers it contains change.
12638 A precompiled header file will be searched for when @code{#include} is
12639 seen in the compilation.  As it searches for the included file
12640 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12641 compiler looks for a precompiled header in each directory just before it
12642 looks for the include file in that directory.  The name searched for is
12643 the name specified in the @code{#include} with @samp{.gch} appended.  If
12644 the precompiled header file can't be used, it is ignored.
12646 For instance, if you have @code{#include "all.h"}, and you have
12647 @file{all.h.gch} in the same directory as @file{all.h}, then the
12648 precompiled header file will be used if possible, and the original
12649 header will be used otherwise.
12651 Alternatively, you might decide to put the precompiled header file in a
12652 directory and use @option{-I} to ensure that directory is searched
12653 before (or instead of) the directory containing the original header.
12654 Then, if you want to check that the precompiled header file is always
12655 used, you can put a file of the same name as the original header in this
12656 directory containing an @code{#error} command.
12658 This also works with @option{-include}.  So yet another way to use
12659 precompiled headers, good for projects not designed with precompiled
12660 header files in mind, is to simply take most of the header files used by
12661 a project, include them from another header file, precompile that header
12662 file, and @option{-include} the precompiled header.  If the header files
12663 have guards against multiple inclusion, they will be skipped because
12664 they've already been included (in the precompiled header).
12666 If you need to precompile the same header file for different
12667 languages, targets, or compiler options, you can instead make a
12668 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12669 header in the directory, perhaps using @option{-o}.  It doesn't matter
12670 what you call the files in the directory, every precompiled header in
12671 the directory will be considered.  The first precompiled header
12672 encountered in the directory that is valid for this compilation will
12673 be used; they're searched in no particular order.
12675 There are many other possibilities, limited only by your imagination,
12676 good sense, and the constraints of your build system.
12678 A precompiled header file can be used only when these conditions apply:
12680 @itemize
12681 @item
12682 Only one precompiled header can be used in a particular compilation.
12684 @item
12685 A precompiled header can't be used once the first C token is seen.  You
12686 can have preprocessor directives before a precompiled header; you can
12687 even include a precompiled header from inside another header, so long as
12688 there are no C tokens before the @code{#include}.
12690 @item
12691 The precompiled header file must be produced for the same language as
12692 the current compilation.  You can't use a C precompiled header for a C++
12693 compilation.
12695 @item
12696 The precompiled header file must be produced by the same compiler
12697 version and configuration as the current compilation is using.
12698 The easiest way to guarantee this is to use the same compiler binary
12699 for creating and using precompiled headers.
12701 @item
12702 Any macros defined before the precompiled header is included must
12703 either be defined in the same way as when the precompiled header was
12704 generated, or must not affect the precompiled header, which usually
12705 means that the they don't appear in the precompiled header at all.
12707 The @option{-D} option is one way to define a macro before a
12708 precompiled header is included; using a @code{#define} can also do it.
12709 There are also some options that define macros implicitly, like
12710 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12711 defined this way.
12713 @item If debugging information is output when using the precompiled
12714 header, using @option{-g} or similar, the same kind of debugging information
12715 must have been output when building the precompiled header.  However,
12716 a precompiled header built using @option{-g} can be used in a compilation
12717 when no debugging information is being output.
12719 @item The same @option{-m} options must generally be used when building
12720 and using the precompiled header.  @xref{Submodel Options},
12721 for any cases where this rule is relaxed.
12723 @item Each of the following options must be the same when building and using
12724 the precompiled header:
12726 @gccoptlist{-fexceptions -funit-at-a-time}
12728 @item
12729 Some other command-line options starting with @option{-f},
12730 @option{-p}, or @option{-O} must be defined in the same way as when
12731 the precompiled header was generated.  At present, it's not clear
12732 which options are safe to change and which are not; the safest choice
12733 is to use exactly the same options when generating and using the
12734 precompiled header.  The following are known to be safe:
12736 @gccoptlist{-fpreprocessed -pedantic-errors}
12738 @end itemize
12740 For all of these except the last, the compiler will automatically
12741 ignore the precompiled header if the conditions aren't met.  If you
12742 find an option combination that doesn't work and doesn't cause the
12743 precompiled header to be ignored, please consider filing a bug report,
12744 see @ref{Bugs}.
12746 If you do use differing options when generating and using the
12747 precompiled header, the actual behavior will be a mixture of the
12748 behavior for the options.  For instance, if you use @option{-g} to
12749 generate the precompiled header but not when using it, you may or may
12750 not get debugging information for routines in the precompiled header.
12752 @node Running Protoize
12753 @section Running Protoize
12755 The program @code{protoize} is an optional part of GCC@.  You can use
12756 it to add prototypes to a program, thus converting the program to ISO
12757 C in one respect.  The companion program @code{unprotoize} does the
12758 reverse: it removes argument types from any prototypes that are found.
12760 When you run these programs, you must specify a set of source files as
12761 command line arguments.  The conversion programs start out by compiling
12762 these files to see what functions they define.  The information gathered
12763 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12765 After scanning comes actual conversion.  The specified files are all
12766 eligible to be converted; any files they include (whether sources or
12767 just headers) are eligible as well.
12769 But not all the eligible files are converted.  By default,
12770 @code{protoize} and @code{unprotoize} convert only source and header
12771 files in the current directory.  You can specify additional directories
12772 whose files should be converted with the @option{-d @var{directory}}
12773 option.  You can also specify particular files to exclude with the
12774 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12775 directory name matches one of the specified directory names, and its
12776 name within the directory has not been excluded.
12778 Basic conversion with @code{protoize} consists of rewriting most
12779 function definitions and function declarations to specify the types of
12780 the arguments.  The only ones not rewritten are those for varargs
12781 functions.
12783 @code{protoize} optionally inserts prototype declarations at the
12784 beginning of the source file, to make them available for any calls that
12785 precede the function's definition.  Or it can insert prototype
12786 declarations with block scope in the blocks where undeclared functions
12787 are called.
12789 Basic conversion with @code{unprotoize} consists of rewriting most
12790 function declarations to remove any argument types, and rewriting
12791 function definitions to the old-style pre-ISO form.
12793 Both conversion programs print a warning for any function declaration or
12794 definition that they can't convert.  You can suppress these warnings
12795 with @option{-q}.
12797 The output from @code{protoize} or @code{unprotoize} replaces the
12798 original source file.  The original file is renamed to a name ending
12799 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12800 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12801 for DOS) file already exists, then the source file is simply discarded.
12803 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12804 scan the program and collect information about the functions it uses.
12805 So neither of these programs will work until GCC is installed.
12807 Here is a table of the options you can use with @code{protoize} and
12808 @code{unprotoize}.  Each option works with both programs unless
12809 otherwise stated.
12811 @table @code
12812 @item -B @var{directory}
12813 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12814 usual directory (normally @file{/usr/local/lib}).  This file contains
12815 prototype information about standard system functions.  This option
12816 applies only to @code{protoize}.
12818 @item -c @var{compilation-options}
12819 Use @var{compilation-options} as the options when running @command{gcc} to
12820 produce the @samp{.X} files.  The special option @option{-aux-info} is
12821 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12823 Note that the compilation options must be given as a single argument to
12824 @code{protoize} or @code{unprotoize}.  If you want to specify several
12825 @command{gcc} options, you must quote the entire set of compilation options
12826 to make them a single word in the shell.
12828 There are certain @command{gcc} arguments that you cannot use, because they
12829 would produce the wrong kind of output.  These include @option{-g},
12830 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12831 the @var{compilation-options}, they are ignored.
12833 @item -C
12834 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12835 systems) instead of @samp{.c}.  This is convenient if you are converting
12836 a C program to C++.  This option applies only to @code{protoize}.
12838 @item -g
12839 Add explicit global declarations.  This means inserting explicit
12840 declarations at the beginning of each source file for each function
12841 that is called in the file and was not declared.  These declarations
12842 precede the first function definition that contains a call to an
12843 undeclared function.  This option applies only to @code{protoize}.
12845 @item -i @var{string}
12846 Indent old-style parameter declarations with the string @var{string}.
12847 This option applies only to @code{protoize}.
12849 @code{unprotoize} converts prototyped function definitions to old-style
12850 function definitions, where the arguments are declared between the
12851 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12852 uses five spaces as the indentation.  If you want to indent with just
12853 one space instead, use @option{-i " "}.
12855 @item -k
12856 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12857 is finished.
12859 @item -l
12860 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12861 a prototype declaration for each function in each block which calls the
12862 function without any declaration.  This option applies only to
12863 @code{protoize}.
12865 @item -n
12866 Make no real changes.  This mode just prints information about the conversions
12867 that would have been done without @option{-n}.
12869 @item -N
12870 Make no @samp{.save} files.  The original files are simply deleted.
12871 Use this option with caution.
12873 @item -p @var{program}
12874 Use the program @var{program} as the compiler.  Normally, the name
12875 @file{gcc} is used.
12877 @item -q
12878 Work quietly.  Most warnings are suppressed.
12880 @item -v
12881 Print the version number, just like @option{-v} for @command{gcc}.
12882 @end table
12884 If you need special compiler options to compile one of your program's
12885 source files, then you should generate that file's @samp{.X} file
12886 specially, by running @command{gcc} on that source file with the
12887 appropriate options and the option @option{-aux-info}.  Then run
12888 @code{protoize} on the entire set of files.  @code{protoize} will use
12889 the existing @samp{.X} file because it is newer than the source file.
12890 For example:
12892 @smallexample
12893 gcc -Dfoo=bar file1.c -aux-info file1.X
12894 protoize *.c
12895 @end smallexample
12897 @noindent
12898 You need to include the special files along with the rest in the
12899 @code{protoize} command, even though their @samp{.X} files already
12900 exist, because otherwise they won't get converted.
12902 @xref{Protoize Caveats}, for more information on how to use
12903 @code{protoize} successfully.