* lib/target-supports.exp (check_iconv_available): Fix comment.
[official-gcc.git] / gcc / doc / invoke.texi
blobd40806aac9e5129f94d00f8aba84710c74bae870
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  -Wsynth}
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-fre@r{[}-@var{n}@r{]} @gol
270 -ftree-vectorizer-verbose=@var{n} @gol
271 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
272 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
273 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
274 -ftest-coverage  -ftime-report -fvar-tracking @gol
275 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
276 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
277 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
278 -print-multi-directory  -print-multi-lib @gol
279 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
280 -save-temps  -time}
282 @item Optimization Options
283 @xref{Optimize Options,,Options that Control Optimization}.
284 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
285 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
286 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
287 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
288 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
289 -fcaller-saves  -fcprop-registers  -fcse-follow-jumps @gol
290 -fcse-follow-jumps  -fcse-skip-blocks  -fcx-limited-range  -fdata-sections @gol
291 -fdelayed-branch  -fdelete-null-pointer-checks @gol
292 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
293 -fforce-addr  -fforce-mem  -ffunction-sections @gol
294 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
295 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
296 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
297 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
298 -fmodulo-sched -fno-branch-count-reg @gol
299 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
300 -fno-function-cse  -fno-guess-branch-probability @gol
301 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
302 -funsafe-math-optimizations  -ffinite-math-only @gol
303 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
304 -fomit-frame-pointer  -foptimize-register-move @gol
305 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
306 -fprofile-generate -fprofile-use @gol
307 -fregmove  -frename-registers @gol
308 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
309 -frerun-cse-after-loop  -frerun-loop-opt @gol
310 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
311 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
312 -fsched-spec-load-dangerous  @gol
313 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
314 -fsched2-use-superblocks @gol
315 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
316 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
317 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
318 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
319 -fsplit-ivs-in-unroller -funswitch-loops @gol
320 -fvariable-expansion-in-unroller @gol
321 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
322 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
323 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
324 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
325 --param @var{name}=@var{value}
326 -O  -O0  -O1  -O2  -O3  -Os}
328 @item Preprocessor Options
329 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
330 @gccoptlist{-A@var{question}=@var{answer} @gol
331 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
332 -C  -dD  -dI  -dM  -dN @gol
333 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
334 -idirafter @var{dir} @gol
335 -include @var{file}  -imacros @var{file} @gol
336 -iprefix @var{file}  -iwithprefix @var{dir} @gol
337 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
338 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
339 -P  -fworking-directory  -remap @gol
340 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
341 -Xpreprocessor @var{option}}
343 @item Assembler Option
344 @xref{Assembler Options,,Passing Options to the Assembler}.
345 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
347 @item Linker Options
348 @xref{Link Options,,Options for Linking}.
349 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
350 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
351 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
352 -Wl,@var{option}  -Xlinker @var{option} @gol
353 -u @var{symbol}}
355 @item Directory Options
356 @xref{Directory Options,,Options for Directory Search}.
357 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
359 @item Target Options
360 @c I wrote this xref this way to avoid overfull hbox. -- rms
361 @xref{Target Options}.
362 @gccoptlist{-V @var{version}  -b @var{machine}}
364 @item Machine Dependent Options
365 @xref{Submodel Options,,Hardware Models and Configurations}.
366 @c This list is ordered alphanumerically by subsection name.
367 @c Try and put the significant identifier (CPU or system) first,
368 @c so users have a clue at guessing where the ones they want will be.
370 @emph{ARC Options}
371 @gccoptlist{-EB  -EL @gol
372 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
373 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
375 @emph{ARM Options}
376 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
377 -mabi=@var{name} @gol
378 -mapcs-stack-check  -mno-apcs-stack-check @gol
379 -mapcs-float  -mno-apcs-float @gol
380 -mapcs-reentrant  -mno-apcs-reentrant @gol
381 -msched-prolog  -mno-sched-prolog @gol
382 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
383 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
384 -mthumb-interwork  -mno-thumb-interwork @gol
385 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
386 -mstructure-size-boundary=@var{n} @gol
387 -mabort-on-noreturn @gol
388 -mlong-calls  -mno-long-calls @gol
389 -msingle-pic-base  -mno-single-pic-base @gol
390 -mpic-register=@var{reg} @gol
391 -mnop-fun-dllimport @gol
392 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
393 -mpoke-function-name @gol
394 -mthumb  -marm @gol
395 -mtpcs-frame  -mtpcs-leaf-frame @gol
396 -mcaller-super-interworking  -mcallee-super-interworking}
398 @emph{AVR Options}
399 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
400 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
402 @emph{CRIS Options}
403 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
404 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
405 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
406 -mstack-align  -mdata-align  -mconst-align @gol
407 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
408 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
409 -mmul-bug-workaround  -mno-mul-bug-workaround}
411 @emph{Darwin Options}
412 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
413 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
414 -client_name  -compatibility_version  -current_version @gol
415 -dead_strip @gol
416 -dependency-file  -dylib_file  -dylinker_install_name @gol
417 -dynamic  -dynamiclib  -exported_symbols_list @gol
418 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
419 -force_flat_namespace  -headerpad_max_install_names @gol
420 -image_base  -init  -install_name  -keep_private_externs @gol
421 -multi_module  -multiply_defined  -multiply_defined_unused @gol
422 -noall_load   -no_dead_strip_inits_and_terms @gol
423 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
424 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
425 -private_bundle  -read_only_relocs  -sectalign @gol
426 -sectobjectsymbols  -whyload  -seg1addr @gol
427 -sectcreate  -sectobjectsymbols  -sectorder @gol
428 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
429 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
430 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
431 -single_module  -static  -sub_library  -sub_umbrella @gol
432 -twolevel_namespace  -umbrella  -undefined @gol
433 -unexported_symbols_list  -weak_reference_mismatches @gol
434 -whatsloaded -F -gused -gfull -mone-byte-bool}
436 @emph{DEC Alpha Options}
437 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
438 -mieee  -mieee-with-inexact  -mieee-conformant @gol
439 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
440 -mtrap-precision=@var{mode}  -mbuild-constants @gol
441 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
442 -mbwx  -mmax  -mfix  -mcix @gol
443 -mfloat-vax  -mfloat-ieee @gol
444 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
445 -msmall-text  -mlarge-text @gol
446 -mmemory-latency=@var{time}}
448 @emph{DEC Alpha/VMS Options}
449 @gccoptlist{-mvms-return-codes}
451 @emph{FRV Options}
452 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
453 -mhard-float  -msoft-float @gol
454 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
455 -mdouble  -mno-double @gol
456 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
457 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
458 -mlinked-fp  -mlong-calls  -malign-labels @gol
459 -mlibrary-pic  -macc-4  -macc-8 @gol
460 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
461 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
462 -mvliw-branch  -mno-vliw-branch @gol
463 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
464 -mno-nested-cond-exec  -mtomcat-stats @gol
465 -mTLS -mtls @gol
466 -mcpu=@var{cpu}}
468 @emph{H8/300 Options}
469 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
471 @emph{HPPA Options}
472 @gccoptlist{-march=@var{architecture-type} @gol
473 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
474 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
475 -mfixed-range=@var{register-range} @gol
476 -mjump-in-delay -mlinker-opt -mlong-calls @gol
477 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
478 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
479 -mno-jump-in-delay  -mno-long-load-store @gol
480 -mno-portable-runtime  -mno-soft-float @gol
481 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
482 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
483 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
484 -munix=@var{unix-std}  -nolibdld  -static  -threads}
486 @emph{i386 and x86-64 Options}
487 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
488 -mfpmath=@var{unit} @gol
489 -masm=@var{dialect}  -mno-fancy-math-387 @gol
490 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
491 -mno-wide-multiply  -mrtd  -malign-double @gol
492 -mpreferred-stack-boundary=@var{num} @gol
493 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
494 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
495 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
496 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
497 -mno-red-zone -mno-tls-direct-seg-refs @gol
498 -mcmodel=@var{code-model} @gol
499 -m32  -m64}
501 @emph{IA-64 Options}
502 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
503 -mvolatile-asm-stop  -mregister-names  -mno-sdata @gol
504 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
505 -minline-float-divide-max-throughput @gol
506 -minline-int-divide-min-latency @gol
507 -minline-int-divide-max-throughput  @gol
508 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
509 -mno-dwarf2-asm -mearly-stop-bits @gol
510 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
511 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
513 @emph{M32R/D Options}
514 @gccoptlist{-m32r2 -m32rx -m32r @gol
515 -mdebug @gol
516 -malign-loops -mno-align-loops @gol
517 -missue-rate=@var{number} @gol
518 -mbranch-cost=@var{number} @gol
519 -mmodel=@var{code-size-model-type} @gol
520 -msdata=@var{sdata-type} @gol
521 -mno-flush-func -mflush-func=@var{name} @gol
522 -mno-flush-trap -mflush-trap=@var{number} @gol
523 -G @var{num}}
525 @emph{M680x0 Options}
526 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
527 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
528 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
529 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
530 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
532 @emph{M68hc1x Options}
533 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
534 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
535 -msoft-reg-count=@var{count}}
537 @emph{MCore Options}
538 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
539 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
540 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
541 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
542 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
544 @emph{MIPS Options}
545 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
546 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
547 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
548 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
549 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
550 -mpaired-single  -mips3d @gol
551 -mint64  -mlong64  -mlong32  -msym32  -mno-sym32 @gol
552 -G@var{num}  -membedded-data  -mno-embedded-data @gol
553 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
554 -msplit-addresses  -mno-split-addresses  @gol
555 -mexplicit-relocs  -mno-explicit-relocs  @gol
556 -mcheck-zero-division  -mno-check-zero-division @gol
557 -mdivide-traps  -mdivide-breaks @gol
558 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
559 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
560 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
561 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
562 -mflush-func=@var{func}  -mno-flush-func @gol
563 -mbranch-likely  -mno-branch-likely @gol
564 -mfp-exceptions -mno-fp-exceptions @gol
565 -mvr4130-align -mno-vr4130-align}
567 @emph{MMIX Options}
568 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
569 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
570 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
571 -mno-base-addresses  -msingle-exit  -mno-single-exit}
573 @emph{MN10300 Options}
574 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
575 -mam33  -mno-am33 @gol
576 -mam33-2  -mno-am33-2 @gol
577 -mno-crt0  -mrelax}
579 @emph{NS32K Options}
580 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
581 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
582 -mregparam  -mnoregparam  -msb  -mnosb @gol
583 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
585 @emph{PDP-11 Options}
586 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
587 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
588 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
589 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
590 -mbranch-expensive  -mbranch-cheap @gol
591 -msplit  -mno-split  -munix-asm  -mdec-asm}
593 @emph{PowerPC Options}
594 See RS/6000 and PowerPC Options.
596 @emph{RS/6000 and PowerPC Options}
597 @gccoptlist{-mcpu=@var{cpu-type} @gol
598 -mtune=@var{cpu-type} @gol
599 -mpower  -mno-power  -mpower2  -mno-power2 @gol
600 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
601 -maltivec  -mno-altivec @gol
602 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
603 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
604 -mnew-mnemonics  -mold-mnemonics @gol
605 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
606 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
607 -malign-power  -malign-natural @gol
608 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
609 -mstring  -mno-string  -mupdate  -mno-update @gol
610 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
611 -mstrict-align  -mno-strict-align  -mrelocatable @gol
612 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
613 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
614 -mdynamic-no-pic @gol
615 -mprioritize-restricted-insns=@var{priority} @gol
616 -msched-costly-dep=@var{dependence_type} @gol
617 -minsert-sched-nops=@var{scheme} @gol
618 -mcall-sysv  -mcall-netbsd @gol
619 -maix-struct-return  -msvr4-struct-return @gol
620 -mabi=altivec  -mabi=no-altivec @gol
621 -mabi=spe  -mabi=no-spe @gol
622 -misel=yes  -misel=no @gol
623 -mspe=yes  -mspe=no @gol
624 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
625 -mprototype  -mno-prototype @gol
626 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
627 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
629 @emph{S/390 and zSeries Options}
630 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
631 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
632 -mpacked-stack  -mno-packed-stack @gol
633 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
634 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
635 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
636 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
638 @emph{SH Options}
639 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
640 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
641 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
642 -m5-64media  -m5-64media-nofpu @gol
643 -m5-32media  -m5-32media-nofpu @gol
644 -m5-compact  -m5-compact-nofpu @gol
645 -mb  -ml  -mdalign  -mrelax @gol
646 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
647 -mieee  -misize  -mpadstruct  -mspace @gol
648 -mprefergot  -musermode}
650 @emph{SPARC Options}
651 @gccoptlist{-mcpu=@var{cpu-type} @gol
652 -mtune=@var{cpu-type} @gol
653 -mcmodel=@var{code-model} @gol
654 -m32  -m64  -mapp-regs  -mno-app-regs @gol
655 -mfaster-structs  -mno-faster-structs @gol
656 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
657 -mhard-quad-float  -msoft-quad-float @gol
658 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
659 -mstack-bias  -mno-stack-bias @gol
660 -munaligned-doubles  -mno-unaligned-doubles @gol
661 -mv8plus  -mno-v8plus  -mvis  -mno-vis
662 -threads -pthreads}
664 @emph{System V Options}
665 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
667 @emph{TMS320C3x/C4x Options}
668 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
669 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
670 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
671 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
673 @emph{V850 Options}
674 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
675 -mprolog-function  -mno-prolog-function  -mspace @gol
676 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
677 -mapp-regs  -mno-app-regs @gol
678 -mdisable-callt  -mno-disable-callt @gol
679 -mv850e1 @gol
680 -mv850e @gol
681 -mv850  -mbig-switch}
683 @emph{VAX Options}
684 @gccoptlist{-mg  -mgnu  -munix}
686 @emph{x86-64 Options}
687 See i386 and x86-64 Options.
689 @emph{Xstormy16 Options}
690 @gccoptlist{-msim}
692 @emph{Xtensa Options}
693 @gccoptlist{-mconst16 -mno-const16 @gol
694 -mfused-madd  -mno-fused-madd @gol
695 -mtext-section-literals  -mno-text-section-literals @gol
696 -mtarget-align  -mno-target-align @gol
697 -mlongcalls  -mno-longcalls}
699 @emph{zSeries Options}
700 See S/390 and zSeries Options.
702 @item Code Generation Options
703 @xref{Code Gen Options,,Options for Code Generation Conventions}.
704 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
705 -ffixed-@var{reg}  -fexceptions @gol
706 -fnon-call-exceptions  -funwind-tables @gol
707 -fasynchronous-unwind-tables @gol
708 -finhibit-size-directive  -finstrument-functions @gol
709 -fno-common  -fno-ident @gol
710 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
711 -freg-struct-return  -fshared-data  -fshort-enums @gol
712 -fshort-double  -fshort-wchar @gol
713 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
714 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
715 -fargument-alias  -fargument-noalias @gol
716 -fargument-noalias-global  -fleading-underscore @gol
717 -ftls-model=@var{model} @gol
718 -ftrapv  -fwrapv  -fbounds-check @gol
719 -fvisibility}
720 @end table
722 @menu
723 * Overall Options::     Controlling the kind of output:
724                         an executable, object files, assembler files,
725                         or preprocessed source.
726 * C Dialect Options::   Controlling the variant of C language compiled.
727 * C++ Dialect Options:: Variations on C++.
728 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
729                         and Objective-C++.
730 * Language Independent Options:: Controlling how diagnostics should be
731                         formatted.
732 * Warning Options::     How picky should the compiler be?
733 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
734 * Optimize Options::    How much optimization?
735 * Preprocessor Options:: Controlling header files and macro definitions.
736                          Also, getting dependency information for Make.
737 * Assembler Options::   Passing options to the assembler.
738 * Link Options::        Specifying libraries and so on.
739 * Directory Options::   Where to find header files and libraries.
740                         Where to find the compiler executable files.
741 * Spec Files::          How to pass switches to sub-processes.
742 * Target Options::      Running a cross-compiler, or an old version of GCC.
743 @end menu
745 @node Overall Options
746 @section Options Controlling the Kind of Output
748 Compilation can involve up to four stages: preprocessing, compilation
749 proper, assembly and linking, always in that order.  GCC is capable of
750 preprocessing and compiling several files either into several
751 assembler input files, or into one assembler input file; then each
752 assembler input file produces an object file, and linking combines all
753 the object files (those newly compiled, and those specified as input)
754 into an executable file.
756 @cindex file name suffix
757 For any given input file, the file name suffix determines what kind of
758 compilation is done:
760 @table @gcctabopt
761 @item @var{file}.c
762 C source code which must be preprocessed.
764 @item @var{file}.i
765 C source code which should not be preprocessed.
767 @item @var{file}.ii
768 C++ source code which should not be preprocessed.
770 @item @var{file}.m
771 Objective-C source code.  Note that you must link with the @file{libobjc}
772 library to make an Objective-C program work.
774 @item @var{file}.mi
775 Objective-C source code which should not be preprocessed.
777 @item @var{file}.mm
778 @itemx @var{file}.M
779 Objective-C++ source code.  Note that you must link with the @file{libobjc}
780 library to make an Objective-C++ program work.  Note that @samp{.M} refers
781 to a literal capital M@.
783 @item @var{file}.mii
784 Objective-C++ source code which should not be preprocessed.
786 @item @var{file}.h
787 C, C++, Objective-C or Objective-C++ header file to be turned into a
788 precompiled header.
790 @item @var{file}.cc
791 @itemx @var{file}.cp
792 @itemx @var{file}.cxx
793 @itemx @var{file}.cpp
794 @itemx @var{file}.CPP
795 @itemx @var{file}.c++
796 @itemx @var{file}.C
797 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
798 the last two letters must both be literally @samp{x}.  Likewise,
799 @samp{.C} refers to a literal capital C@.
801 @item @var{file}.hh
802 @itemx @var{file}.H
803 C++ header file to be turned into a precompiled header.
805 @item @var{file}.f
806 @itemx @var{file}.for
807 @itemx @var{file}.FOR
808 Fortran source code which should not be preprocessed.
810 @item @var{file}.F
811 @itemx @var{file}.fpp
812 @itemx @var{file}.FPP
813 Fortran source code which must be preprocessed (with the traditional
814 preprocessor).
816 @item @var{file}.r
817 Fortran source code which must be preprocessed with a RATFOR
818 preprocessor (not included with GCC)@.
820 @item @var{file}.f90
821 @itemx @var{file}.f95
822 Fortran 90/95 source code which should not be preprocessed.
824 @c FIXME: Descriptions of Java file types.
825 @c @var{file}.java
826 @c @var{file}.class
827 @c @var{file}.zip
828 @c @var{file}.jar
830 @item @var{file}.ads
831 Ada source code file which contains a library unit declaration (a
832 declaration of a package, subprogram, or generic, or a generic
833 instantiation), or a library unit renaming declaration (a package,
834 generic, or subprogram renaming declaration).  Such files are also
835 called @dfn{specs}.
837 @itemx @var{file}.adb
838 Ada source code file containing a library unit body (a subprogram or
839 package body).  Such files are also called @dfn{bodies}.
841 @c GCC also knows about some suffixes for languages not yet included:
842 @c Pascal:
843 @c @var{file}.p
844 @c @var{file}.pas
846 @item @var{file}.s
847 Assembler code.
849 @item @var{file}.S
850 Assembler code which must be preprocessed.
852 @item @var{other}
853 An object file to be fed straight into linking.
854 Any file name with no recognized suffix is treated this way.
855 @end table
857 @opindex x
858 You can specify the input language explicitly with the @option{-x} option:
860 @table @gcctabopt
861 @item -x @var{language}
862 Specify explicitly the @var{language} for the following input files
863 (rather than letting the compiler choose a default based on the file
864 name suffix).  This option applies to all following input files until
865 the next @option{-x} option.  Possible values for @var{language} are:
866 @smallexample
867 c  c-header  c-cpp-output
868 c++  c++-header  c++-cpp-output
869 objective-c  objective-c-header  objective-c-cpp-output
870 objective-c++ objective-c++-header objective-c++-cpp-output
871 assembler  assembler-with-cpp
873 f77  f77-cpp-input  ratfor
875 java
876 treelang
877 @end smallexample
879 @item -x none
880 Turn off any specification of a language, so that subsequent files are
881 handled according to their file name suffixes (as they are if @option{-x}
882 has not been used at all).
884 @item -pass-exit-codes
885 @opindex pass-exit-codes
886 Normally the @command{gcc} program will exit with the code of 1 if any
887 phase of the compiler returns a non-success return code.  If you specify
888 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
889 numerically highest error produced by any phase that returned an error
890 indication.
891 @end table
893 If you only want some of the stages of compilation, you can use
894 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
895 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
896 @command{gcc} is to stop.  Note that some combinations (for example,
897 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
899 @table @gcctabopt
900 @item -c
901 @opindex c
902 Compile or assemble the source files, but do not link.  The linking
903 stage simply is not done.  The ultimate output is in the form of an
904 object file for each source file.
906 By default, the object file name for a source file is made by replacing
907 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
909 Unrecognized input files, not requiring compilation or assembly, are
910 ignored.
912 @item -S
913 @opindex S
914 Stop after the stage of compilation proper; do not assemble.  The output
915 is in the form of an assembler code file for each non-assembler input
916 file specified.
918 By default, the assembler file name for a source file is made by
919 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
921 Input files that don't require compilation are ignored.
923 @item -E
924 @opindex E
925 Stop after the preprocessing stage; do not run the compiler proper.  The
926 output is in the form of preprocessed source code, which is sent to the
927 standard output.
929 Input files which don't require preprocessing are ignored.
931 @cindex output file option
932 @item -o @var{file}
933 @opindex o
934 Place output in file @var{file}.  This applies regardless to whatever
935 sort of output is being produced, whether it be an executable file,
936 an object file, an assembler file or preprocessed C code.
938 If @option{-o} is not specified, the default is to put an executable
939 file in @file{a.out}, the object file for
940 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
941 assembler file in @file{@var{source}.s}, a precompiled header file in
942 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
943 standard output.
945 @item -v
946 @opindex v
947 Print (on standard error output) the commands executed to run the stages
948 of compilation.  Also print the version number of the compiler driver
949 program and of the preprocessor and the compiler proper.
951 @item -###
952 @opindex ###
953 Like @option{-v} except the commands are not executed and all command
954 arguments are quoted.  This is useful for shell scripts to capture the
955 driver-generated command lines.
957 @item -pipe
958 @opindex pipe
959 Use pipes rather than temporary files for communication between the
960 various stages of compilation.  This fails to work on some systems where
961 the assembler is unable to read from a pipe; but the GNU assembler has
962 no trouble.
964 @item -combine
965 @opindex combine
966 If you are compiling multiple source files, this option tells the driver
967 to pass all the source files to the compiler at once (for those
968 languages for which the compiler can handle this).  This will allow
969 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
970 language for which this is supported is C@.  If you pass source files for
971 multiple languages to the driver, using this option, the driver will invoke
972 the compiler(s) that support IMA once each, passing each compiler all the
973 source files appropriate for it.  For those languages that do not support
974 IMA this option will be ignored, and the compiler will be invoked once for
975 each source file in that language.  If you use this option in conjunction
976 with @option{-save-temps}, the compiler will generate multiple
977 pre-processed files
978 (one for each source file), but only one (combined) @file{.o} or
979 @file{.s} file.
981 @item --help
982 @opindex help
983 Print (on the standard output) a description of the command line options
984 understood by @command{gcc}.  If the @option{-v} option is also specified
985 then @option{--help} will also be passed on to the various processes
986 invoked by @command{gcc}, so that they can display the command line options
987 they accept.  If the @option{-Wextra} option is also specified then command
988 line options which have no documentation associated with them will also
989 be displayed.
991 @item --target-help
992 @opindex target-help
993 Print (on the standard output) a description of target specific command
994 line options for each tool.
996 @item --version
997 @opindex version
998 Display the version number and copyrights of the invoked GCC@.
999 @end table
1001 @node Invoking G++
1002 @section Compiling C++ Programs
1004 @cindex suffixes for C++ source
1005 @cindex C++ source file suffixes
1006 C++ source files conventionally use one of the suffixes @samp{.C},
1007 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1008 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1009 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1010 files with these names and compiles them as C++ programs even if you
1011 call the compiler the same way as for compiling C programs (usually
1012 with the name @command{gcc}).
1014 @findex g++
1015 @findex c++
1016 However, C++ programs often require class libraries as well as a
1017 compiler that understands the C++ language---and under some
1018 circumstances, you might want to compile programs or header files from
1019 standard input, or otherwise without a suffix that flags them as C++
1020 programs.  You might also like to precompile a C header file with a
1021 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1022 program that calls GCC with the default language set to C++, and
1023 automatically specifies linking against the C++ library.  On many
1024 systems, @command{g++} is also installed with the name @command{c++}.
1026 @cindex invoking @command{g++}
1027 When you compile C++ programs, you may specify many of the same
1028 command-line options that you use for compiling programs in any
1029 language; or command-line options meaningful for C and related
1030 languages; or options that are meaningful only for C++ programs.
1031 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1032 explanations of options for languages related to C@.
1033 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1034 explanations of options that are meaningful only for C++ programs.
1036 @node C Dialect Options
1037 @section Options Controlling C Dialect
1038 @cindex dialect options
1039 @cindex language dialect options
1040 @cindex options, dialect
1042 The following options control the dialect of C (or languages derived
1043 from C, such as C++, Objective-C and Objective-C++) that the compiler
1044 accepts:
1046 @table @gcctabopt
1047 @cindex ANSI support
1048 @cindex ISO support
1049 @item -ansi
1050 @opindex ansi
1051 In C mode, support all ISO C90 programs.  In C++ mode,
1052 remove GNU extensions that conflict with ISO C++.
1054 This turns off certain features of GCC that are incompatible with ISO
1055 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1056 such as the @code{asm} and @code{typeof} keywords, and
1057 predefined macros such as @code{unix} and @code{vax} that identify the
1058 type of system you are using.  It also enables the undesirable and
1059 rarely used ISO trigraph feature.  For the C compiler,
1060 it disables recognition of C++ style @samp{//} comments as well as
1061 the @code{inline} keyword.
1063 The alternate keywords @code{__asm__}, @code{__extension__},
1064 @code{__inline__} and @code{__typeof__} continue to work despite
1065 @option{-ansi}.  You would not want to use them in an ISO C program, of
1066 course, but it is useful to put them in header files that might be included
1067 in compilations done with @option{-ansi}.  Alternate predefined macros
1068 such as @code{__unix__} and @code{__vax__} are also available, with or
1069 without @option{-ansi}.
1071 The @option{-ansi} option does not cause non-ISO programs to be
1072 rejected gratuitously.  For that, @option{-pedantic} is required in
1073 addition to @option{-ansi}.  @xref{Warning Options}.
1075 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1076 option is used.  Some header files may notice this macro and refrain
1077 from declaring certain functions or defining certain macros that the
1078 ISO standard doesn't call for; this is to avoid interfering with any
1079 programs that might use these names for other things.
1081 Functions which would normally be built in but do not have semantics
1082 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1083 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1084 built-in functions provided by GCC}, for details of the functions
1085 affected.
1087 @item -std=
1088 @opindex std
1089 Determine the language standard.  This option is currently only
1090 supported when compiling C or C++.  A value for this option must be
1091 provided; possible values are
1093 @table @samp
1094 @item c89
1095 @itemx iso9899:1990
1096 ISO C90 (same as @option{-ansi}).
1098 @item iso9899:199409
1099 ISO C90 as modified in amendment 1.
1101 @item c99
1102 @itemx c9x
1103 @itemx iso9899:1999
1104 @itemx iso9899:199x
1105 ISO C99.  Note that this standard is not yet fully supported; see
1106 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1107 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1109 @item gnu89
1110 Default, ISO C90 plus GNU extensions (including some C99 features).
1112 @item gnu99
1113 @itemx gnu9x
1114 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1115 this will become the default.  The name @samp{gnu9x} is deprecated.
1117 @item c++98
1118 The 1998 ISO C++ standard plus amendments.
1120 @item gnu++98
1121 The same as @option{-std=c++98} plus GNU extensions.  This is the
1122 default for C++ code.
1123 @end table
1125 Even when this option is not specified, you can still use some of the
1126 features of newer standards in so far as they do not conflict with
1127 previous C standards.  For example, you may use @code{__restrict__} even
1128 when @option{-std=c99} is not specified.
1130 The @option{-std} options specifying some version of ISO C have the same
1131 effects as @option{-ansi}, except that features that were not in ISO C90
1132 but are in the specified version (for example, @samp{//} comments and
1133 the @code{inline} keyword in ISO C99) are not disabled.
1135 @xref{Standards,,Language Standards Supported by GCC}, for details of
1136 these standard versions.
1138 @item -aux-info @var{filename}
1139 @opindex aux-info
1140 Output to the given filename prototyped declarations for all functions
1141 declared and/or defined in a translation unit, including those in header
1142 files.  This option is silently ignored in any language other than C@.
1144 Besides declarations, the file indicates, in comments, the origin of
1145 each declaration (source file and line), whether the declaration was
1146 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1147 @samp{O} for old, respectively, in the first character after the line
1148 number and the colon), and whether it came from a declaration or a
1149 definition (@samp{C} or @samp{F}, respectively, in the following
1150 character).  In the case of function definitions, a K&R-style list of
1151 arguments followed by their declarations is also provided, inside
1152 comments, after the declaration.
1154 @item -fno-asm
1155 @opindex fno-asm
1156 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1157 keyword, so that code can use these words as identifiers.  You can use
1158 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1159 instead.  @option{-ansi} implies @option{-fno-asm}.
1161 In C++, this switch only affects the @code{typeof} keyword, since
1162 @code{asm} and @code{inline} are standard keywords.  You may want to
1163 use the @option{-fno-gnu-keywords} flag instead, which has the same
1164 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1165 switch only affects the @code{asm} and @code{typeof} keywords, since
1166 @code{inline} is a standard keyword in ISO C99.
1168 @item -fno-builtin
1169 @itemx -fno-builtin-@var{function}
1170 @opindex fno-builtin
1171 @cindex built-in functions
1172 Don't recognize built-in functions that do not begin with
1173 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1174 functions provided by GCC}, for details of the functions affected,
1175 including those which are not built-in functions when @option{-ansi} or
1176 @option{-std} options for strict ISO C conformance are used because they
1177 do not have an ISO standard meaning.
1179 GCC normally generates special code to handle certain built-in functions
1180 more efficiently; for instance, calls to @code{alloca} may become single
1181 instructions that adjust the stack directly, and calls to @code{memcpy}
1182 may become inline copy loops.  The resulting code is often both smaller
1183 and faster, but since the function calls no longer appear as such, you
1184 cannot set a breakpoint on those calls, nor can you change the behavior
1185 of the functions by linking with a different library.  In addition,
1186 when a function is recognized as a built-in function, GCC may use
1187 information about that function to warn about problems with calls to
1188 that function, or to generate more efficient code, even if the
1189 resulting code still contains calls to that function.  For example,
1190 warnings are given with @option{-Wformat} for bad calls to
1191 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1192 known not to modify global memory.
1194 With the @option{-fno-builtin-@var{function}} option
1195 only the built-in function @var{function} is
1196 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1197 function is named this is not built-in in this version of GCC, this
1198 option is ignored.  There is no corresponding
1199 @option{-fbuiltin-@var{function}} option; if you wish to enable
1200 built-in functions selectively when using @option{-fno-builtin} or
1201 @option{-ffreestanding}, you may define macros such as:
1203 @smallexample
1204 #define abs(n)          __builtin_abs ((n))
1205 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1206 @end smallexample
1208 @item -fhosted
1209 @opindex fhosted
1210 @cindex hosted environment
1212 Assert that compilation takes place in a hosted environment.  This implies
1213 @option{-fbuiltin}.  A hosted environment is one in which the
1214 entire standard library is available, and in which @code{main} has a return
1215 type of @code{int}.  Examples are nearly everything except a kernel.
1216 This is equivalent to @option{-fno-freestanding}.
1218 @item -ffreestanding
1219 @opindex ffreestanding
1220 @cindex hosted environment
1222 Assert that compilation takes place in a freestanding environment.  This
1223 implies @option{-fno-builtin}.  A freestanding environment
1224 is one in which the standard library may not exist, and program startup may
1225 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1226 This is equivalent to @option{-fno-hosted}.
1228 @xref{Standards,,Language Standards Supported by GCC}, for details of
1229 freestanding and hosted environments.
1231 @item -fms-extensions
1232 @opindex fms-extensions
1233 Accept some non-standard constructs used in Microsoft header files.
1235 Some cases of unnamed fields in structures and unions are only
1236 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1237 fields within structs/unions}, for details.
1239 @item -trigraphs
1240 @opindex trigraphs
1241 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1242 options for strict ISO C conformance) implies @option{-trigraphs}.
1244 @item -no-integrated-cpp
1245 @opindex no-integrated-cpp
1246 Performs a compilation in two passes: preprocessing and compiling.  This
1247 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1248 @option{-B} option.  The user supplied compilation step can then add in
1249 an additional preprocessing step after normal preprocessing but before
1250 compiling.  The default is to use the integrated cpp (internal cpp)
1252 The semantics of this option will change if "cc1", "cc1plus", and
1253 "cc1obj" are merged.
1255 @cindex traditional C language
1256 @cindex C language, traditional
1257 @item -traditional
1258 @itemx -traditional-cpp
1259 @opindex traditional-cpp
1260 @opindex traditional
1261 Formerly, these options caused GCC to attempt to emulate a pre-standard
1262 C compiler.  They are now only supported with the @option{-E} switch.
1263 The preprocessor continues to support a pre-standard mode.  See the GNU
1264 CPP manual for details.
1266 @item -fcond-mismatch
1267 @opindex fcond-mismatch
1268 Allow conditional expressions with mismatched types in the second and
1269 third arguments.  The value of such an expression is void.  This option
1270 is not supported for C++.
1272 @item -funsigned-char
1273 @opindex funsigned-char
1274 Let the type @code{char} be unsigned, like @code{unsigned char}.
1276 Each kind of machine has a default for what @code{char} should
1277 be.  It is either like @code{unsigned char} by default or like
1278 @code{signed char} by default.
1280 Ideally, a portable program should always use @code{signed char} or
1281 @code{unsigned char} when it depends on the signedness of an object.
1282 But many programs have been written to use plain @code{char} and
1283 expect it to be signed, or expect it to be unsigned, depending on the
1284 machines they were written for.  This option, and its inverse, let you
1285 make such a program work with the opposite default.
1287 The type @code{char} is always a distinct type from each of
1288 @code{signed char} or @code{unsigned char}, even though its behavior
1289 is always just like one of those two.
1291 @item -fsigned-char
1292 @opindex fsigned-char
1293 Let the type @code{char} be signed, like @code{signed char}.
1295 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1296 the negative form of @option{-funsigned-char}.  Likewise, the option
1297 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1299 @item -fsigned-bitfields
1300 @itemx -funsigned-bitfields
1301 @itemx -fno-signed-bitfields
1302 @itemx -fno-unsigned-bitfields
1303 @opindex fsigned-bitfields
1304 @opindex funsigned-bitfields
1305 @opindex fno-signed-bitfields
1306 @opindex fno-unsigned-bitfields
1307 These options control whether a bit-field is signed or unsigned, when the
1308 declaration does not use either @code{signed} or @code{unsigned}.  By
1309 default, such a bit-field is signed, because this is consistent: the
1310 basic integer types such as @code{int} are signed types.
1311 @end table
1313 @node C++ Dialect Options
1314 @section Options Controlling C++ Dialect
1316 @cindex compiler options, C++
1317 @cindex C++ options, command line
1318 @cindex options, C++
1319 This section describes the command-line options that are only meaningful
1320 for C++ programs; but you can also use most of the GNU compiler options
1321 regardless of what language your program is in.  For example, you
1322 might compile a file @code{firstClass.C} like this:
1324 @smallexample
1325 g++ -g -frepo -O -c firstClass.C
1326 @end smallexample
1328 @noindent
1329 In this example, only @option{-frepo} is an option meant
1330 only for C++ programs; you can use the other options with any
1331 language supported by GCC@.
1333 Here is a list of options that are @emph{only} for compiling C++ programs:
1335 @table @gcctabopt
1337 @item -fabi-version=@var{n}
1338 @opindex fabi-version
1339 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1340 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1341 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1342 the version that conforms most closely to the C++ ABI specification.
1343 Therefore, the ABI obtained using version 0 will change as ABI bugs
1344 are fixed.
1346 The default is version 2.
1348 @item -fno-access-control
1349 @opindex fno-access-control
1350 Turn off all access checking.  This switch is mainly useful for working
1351 around bugs in the access control code.
1353 @item -fcheck-new
1354 @opindex fcheck-new
1355 Check that the pointer returned by @code{operator new} is non-null
1356 before attempting to modify the storage allocated.  This check is
1357 normally unnecessary because the C++ standard specifies that
1358 @code{operator new} will only return @code{0} if it is declared
1359 @samp{throw()}, in which case the compiler will always check the
1360 return value even without this option.  In all other cases, when
1361 @code{operator new} has a non-empty exception specification, memory
1362 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1363 @samp{new (nothrow)}.
1365 @item -fconserve-space
1366 @opindex fconserve-space
1367 Put uninitialized or runtime-initialized global variables into the
1368 common segment, as C does.  This saves space in the executable at the
1369 cost of not diagnosing duplicate definitions.  If you compile with this
1370 flag and your program mysteriously crashes after @code{main()} has
1371 completed, you may have an object that is being destroyed twice because
1372 two definitions were merged.
1374 This option is no longer useful on most targets, now that support has
1375 been added for putting variables into BSS without making them common.
1377 @item -fno-const-strings
1378 @opindex fno-const-strings
1379 Give string constants type @code{char *} instead of type @code{const
1380 char *}.  By default, G++ uses type @code{const char *} as required by
1381 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1382 actually modify the value of a string constant.
1384 This option might be removed in a future release of G++.  For maximum
1385 portability, you should structure your code so that it works with
1386 string constants that have type @code{const char *}.
1388 @item -fno-elide-constructors
1389 @opindex fno-elide-constructors
1390 The C++ standard allows an implementation to omit creating a temporary
1391 which is only used to initialize another object of the same type.
1392 Specifying this option disables that optimization, and forces G++ to
1393 call the copy constructor in all cases.
1395 @item -fno-enforce-eh-specs
1396 @opindex fno-enforce-eh-specs
1397 Don't check for violation of exception specifications at runtime.  This
1398 option violates the C++ standard, but may be useful for reducing code
1399 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1400 will still optimize based on the exception specifications.
1402 @item -ffor-scope
1403 @itemx -fno-for-scope
1404 @opindex ffor-scope
1405 @opindex fno-for-scope
1406 If @option{-ffor-scope} is specified, the scope of variables declared in
1407 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1408 as specified by the C++ standard.
1409 If @option{-fno-for-scope} is specified, the scope of variables declared in
1410 a @i{for-init-statement} extends to the end of the enclosing scope,
1411 as was the case in old versions of G++, and other (traditional)
1412 implementations of C++.
1414 The default if neither flag is given to follow the standard,
1415 but to allow and give a warning for old-style code that would
1416 otherwise be invalid, or have different behavior.
1418 @item -fno-gnu-keywords
1419 @opindex fno-gnu-keywords
1420 Do not recognize @code{typeof} as a keyword, so that code can use this
1421 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1422 @option{-ansi} implies @option{-fno-gnu-keywords}.
1424 @item -fno-implicit-templates
1425 @opindex fno-implicit-templates
1426 Never emit code for non-inline templates which are instantiated
1427 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1428 @xref{Template Instantiation}, for more information.
1430 @item -fno-implicit-inline-templates
1431 @opindex fno-implicit-inline-templates
1432 Don't emit code for implicit instantiations of inline templates, either.
1433 The default is to handle inlines differently so that compiles with and
1434 without optimization will need the same set of explicit instantiations.
1436 @item -fno-implement-inlines
1437 @opindex fno-implement-inlines
1438 To save space, do not emit out-of-line copies of inline functions
1439 controlled by @samp{#pragma implementation}.  This will cause linker
1440 errors if these functions are not inlined everywhere they are called.
1442 @item -fms-extensions
1443 @opindex fms-extensions
1444 Disable pedantic warnings about constructs used in MFC, such as implicit
1445 int and getting a pointer to member function via non-standard syntax.
1447 @item -fno-nonansi-builtins
1448 @opindex fno-nonansi-builtins
1449 Disable built-in declarations of functions that are not mandated by
1450 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1451 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1453 @item -fno-operator-names
1454 @opindex fno-operator-names
1455 Do not treat the operator name keywords @code{and}, @code{bitand},
1456 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1457 synonyms as keywords.
1459 @item -fno-optional-diags
1460 @opindex fno-optional-diags
1461 Disable diagnostics that the standard says a compiler does not need to
1462 issue.  Currently, the only such diagnostic issued by G++ is the one for
1463 a name having multiple meanings within a class.
1465 @item -fpermissive
1466 @opindex fpermissive
1467 Downgrade some diagnostics about nonconformant code from errors to
1468 warnings.  Thus, using @option{-fpermissive} will allow some
1469 nonconforming code to compile.
1471 @item -frepo
1472 @opindex frepo
1473 Enable automatic template instantiation at link time.  This option also
1474 implies @option{-fno-implicit-templates}.  @xref{Template
1475 Instantiation}, for more information.
1477 @item -fno-rtti
1478 @opindex fno-rtti
1479 Disable generation of information about every class with virtual
1480 functions for use by the C++ runtime type identification features
1481 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1482 of the language, you can save some space by using this flag.  Note that
1483 exception handling uses the same information, but it will generate it as
1484 needed.
1486 @item -fstats
1487 @opindex fstats
1488 Emit statistics about front-end processing at the end of the compilation.
1489 This information is generally only useful to the G++ development team.
1491 @item -ftemplate-depth-@var{n}
1492 @opindex ftemplate-depth
1493 Set the maximum instantiation depth for template classes to @var{n}.
1494 A limit on the template instantiation depth is needed to detect
1495 endless recursions during template class instantiation.  ANSI/ISO C++
1496 conforming programs must not rely on a maximum depth greater than 17.
1498 @item -fno-threadsafe-statics
1499 @opindex fno-threadsafe-statics
1500 Do not emit the extra code to use the routines specified in the C++
1501 ABI for thread-safe initialization of local statics.  You can use this
1502 option to reduce code size slightly in code that doesn't need to be
1503 thread-safe.
1505 @item -fuse-cxa-atexit
1506 @opindex fuse-cxa-atexit
1507 Register destructors for objects with static storage duration with the
1508 @code{__cxa_atexit} function rather than the @code{atexit} function.
1509 This option is required for fully standards-compliant handling of static
1510 destructors, but will only work if your C library supports
1511 @code{__cxa_atexit}.
1513 @item -fvisibility-inlines-hidden
1514 @opindex fvisibility-inlines-hidden
1515 Causes all inlined methods to be marked with
1516 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1517 appear in the export table of a DSO and do not require a PLT indirection
1518 when used within the DSO@.  Enabling this option can have a dramatic effect
1519 on load and link times of a DSO as it massively reduces the size of the
1520 dynamic export table when the library makes heavy use of templates.  While
1521 it can cause bloating through duplication of code within each DSO where
1522 it is used, often the wastage is less than the considerable space occupied
1523 by a long symbol name in the export table which is typical when using
1524 templates and namespaces.  For even more savings, combine with the
1525 @option{-fvisibility=hidden} switch.
1527 @item -fno-weak
1528 @opindex fno-weak
1529 Do not use weak symbol support, even if it is provided by the linker.
1530 By default, G++ will use weak symbols if they are available.  This
1531 option exists only for testing, and should not be used by end-users;
1532 it will result in inferior code and has no benefits.  This option may
1533 be removed in a future release of G++.
1535 @item -nostdinc++
1536 @opindex nostdinc++
1537 Do not search for header files in the standard directories specific to
1538 C++, but do still search the other standard directories.  (This option
1539 is used when building the C++ library.)
1540 @end table
1542 In addition, these optimization, warning, and code generation options
1543 have meanings only for C++ programs:
1545 @table @gcctabopt
1546 @item -fno-default-inline
1547 @opindex fno-default-inline
1548 Do not assume @samp{inline} for functions defined inside a class scope.
1549 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1550 functions will have linkage like inline functions; they just won't be
1551 inlined by default.
1553 @item -Wabi @r{(C++ only)}
1554 @opindex Wabi
1555 Warn when G++ generates code that is probably not compatible with the
1556 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1557 all such cases, there are probably some cases that are not warned about,
1558 even though G++ is generating incompatible code.  There may also be
1559 cases where warnings are emitted even though the code that is generated
1560 will be compatible.
1562 You should rewrite your code to avoid these warnings if you are
1563 concerned about the fact that code generated by G++ may not be binary
1564 compatible with code generated by other compilers.
1566 The known incompatibilities at this point include:
1568 @itemize @bullet
1570 @item
1571 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1572 pack data into the same byte as a base class.  For example:
1574 @smallexample
1575 struct A @{ virtual void f(); int f1 : 1; @};
1576 struct B : public A @{ int f2 : 1; @};
1577 @end smallexample
1579 @noindent
1580 In this case, G++ will place @code{B::f2} into the same byte
1581 as@code{A::f1}; other compilers will not.  You can avoid this problem
1582 by explicitly padding @code{A} so that its size is a multiple of the
1583 byte size on your platform; that will cause G++ and other compilers to
1584 layout @code{B} identically.
1586 @item
1587 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1588 tail padding when laying out virtual bases.  For example:
1590 @smallexample
1591 struct A @{ virtual void f(); char c1; @};
1592 struct B @{ B(); char c2; @};
1593 struct C : public A, public virtual B @{@};
1594 @end smallexample
1596 @noindent
1597 In this case, G++ will not place @code{B} into the tail-padding for
1598 @code{A}; other compilers will.  You can avoid this problem by
1599 explicitly padding @code{A} so that its size is a multiple of its
1600 alignment (ignoring virtual base classes); that will cause G++ and other
1601 compilers to layout @code{C} identically.
1603 @item
1604 Incorrect handling of bit-fields with declared widths greater than that
1605 of their underlying types, when the bit-fields appear in a union.  For
1606 example:
1608 @smallexample
1609 union U @{ int i : 4096; @};
1610 @end smallexample
1612 @noindent
1613 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1614 union too small by the number of bits in an @code{int}.
1616 @item
1617 Empty classes can be placed at incorrect offsets.  For example:
1619 @smallexample
1620 struct A @{@};
1622 struct B @{
1623   A a;
1624   virtual void f ();
1627 struct C : public B, public A @{@};
1628 @end smallexample
1630 @noindent
1631 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1632 it should be placed at offset zero.  G++ mistakenly believes that the
1633 @code{A} data member of @code{B} is already at offset zero.
1635 @item
1636 Names of template functions whose types involve @code{typename} or
1637 template template parameters can be mangled incorrectly.
1639 @smallexample
1640 template <typename Q>
1641 void f(typename Q::X) @{@}
1643 template <template <typename> class Q>
1644 void f(typename Q<int>::X) @{@}
1645 @end smallexample
1647 @noindent
1648 Instantiations of these templates may be mangled incorrectly.
1650 @end itemize
1652 @item -Wctor-dtor-privacy @r{(C++ only)}
1653 @opindex Wctor-dtor-privacy
1654 Warn when a class seems unusable because all the constructors or
1655 destructors in that class are private, and it has neither friends nor
1656 public static member functions.
1658 @item -Wnon-virtual-dtor @r{(C++ only)}
1659 @opindex Wnon-virtual-dtor
1660 Warn when a class appears to be polymorphic, thereby requiring a virtual
1661 destructor, yet it declares a non-virtual one.
1662 This warning is enabled by @option{-Wall}.
1664 @item -Wreorder @r{(C++ only)}
1665 @opindex Wreorder
1666 @cindex reordering, warning
1667 @cindex warning for reordering of member initializers
1668 Warn when the order of member initializers given in the code does not
1669 match the order in which they must be executed.  For instance:
1671 @smallexample
1672 struct A @{
1673   int i;
1674   int j;
1675   A(): j (0), i (1) @{ @}
1677 @end smallexample
1679 The compiler will rearrange the member initializers for @samp{i}
1680 and @samp{j} to match the declaration order of the members, emitting
1681 a warning to that effect.  This warning is enabled by @option{-Wall}.
1682 @end table
1684 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1686 @table @gcctabopt
1687 @item -Weffc++ @r{(C++ only)}
1688 @opindex Weffc++
1689 Warn about violations of the following style guidelines from Scott Meyers'
1690 @cite{Effective C++} book:
1692 @itemize @bullet
1693 @item
1694 Item 11:  Define a copy constructor and an assignment operator for classes
1695 with dynamically allocated memory.
1697 @item
1698 Item 12:  Prefer initialization to assignment in constructors.
1700 @item
1701 Item 14:  Make destructors virtual in base classes.
1703 @item
1704 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1706 @item
1707 Item 23:  Don't try to return a reference when you must return an object.
1709 @end itemize
1711 Also warn about violations of the following style guidelines from
1712 Scott Meyers' @cite{More Effective C++} book:
1714 @itemize @bullet
1715 @item
1716 Item 6:  Distinguish between prefix and postfix forms of increment and
1717 decrement operators.
1719 @item
1720 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1722 @end itemize
1724 When selecting this option, be aware that the standard library
1725 headers do not obey all of these guidelines; use @samp{grep -v}
1726 to filter out those warnings.
1728 @item -Wno-deprecated @r{(C++ only)}
1729 @opindex Wno-deprecated
1730 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1732 @item -Wno-non-template-friend @r{(C++ only)}
1733 @opindex Wno-non-template-friend
1734 Disable warnings when non-templatized friend functions are declared
1735 within a template.  Since the advent of explicit template specification
1736 support in G++, if the name of the friend is an unqualified-id (i.e.,
1737 @samp{friend foo(int)}), the C++ language specification demands that the
1738 friend declare or define an ordinary, nontemplate function.  (Section
1739 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1740 could be interpreted as a particular specialization of a templatized
1741 function.  Because this non-conforming behavior is no longer the default
1742 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1743 check existing code for potential trouble spots and is on by default.
1744 This new compiler behavior can be turned off with
1745 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1746 but disables the helpful warning.
1748 @item -Wold-style-cast @r{(C++ only)}
1749 @opindex Wold-style-cast
1750 Warn if an old-style (C-style) cast to a non-void type is used within
1751 a C++ program.  The new-style casts (@samp{static_cast},
1752 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1753 unintended effects and much easier to search for.
1755 @item -Woverloaded-virtual @r{(C++ only)}
1756 @opindex Woverloaded-virtual
1757 @cindex overloaded virtual fn, warning
1758 @cindex warning for overloaded virtual fn
1759 Warn when a function declaration hides virtual functions from a
1760 base class.  For example, in:
1762 @smallexample
1763 struct A @{
1764   virtual void f();
1767 struct B: public A @{
1768   void f(int);
1770 @end smallexample
1772 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1773 like:
1775 @smallexample
1776 B* b;
1777 b->f();
1778 @end smallexample
1780 will fail to compile.
1782 @item -Wno-pmf-conversions @r{(C++ only)}
1783 @opindex Wno-pmf-conversions
1784 Disable the diagnostic for converting a bound pointer to member function
1785 to a plain pointer.
1787 @item -Wsign-promo @r{(C++ only)}
1788 @opindex Wsign-promo
1789 Warn when overload resolution chooses a promotion from unsigned or
1790 enumerated type to a signed type, over a conversion to an unsigned type of
1791 the same size.  Previous versions of G++ would try to preserve
1792 unsignedness, but the standard mandates the current behavior.
1794 @item -Wsynth @r{(C++ only)}
1795 @opindex Wsynth
1796 @cindex warning for synthesized methods
1797 @cindex synthesized methods, warning
1798 Warn when G++'s synthesis behavior does not match that of cfront.  For
1799 instance:
1801 @smallexample
1802 struct A @{
1803   operator int ();
1804   A& operator = (int);
1807 main ()
1809   A a,b;
1810   a = b;
1812 @end smallexample
1814 In this example, G++ will synthesize a default @samp{A& operator =
1815 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1816 @end table
1818 @node Objective-C and Objective-C++ Dialect Options
1819 @section Options Controlling Objective-C and Objective-C++ Dialects
1821 @cindex compiler options, Objective-C and Objective-C++
1822 @cindex Objective-C and Objective-C++ options, command line
1823 @cindex options, Objective-C and Objective-C++
1824 (NOTE: This manual does not describe the Objective-C and Objective-C++
1825 languages themselves.  See @xref{Standards,,Language Standards
1826 Supported by GCC}, for references.)
1828 This section describes the command-line options that are only meaningful
1829 for Objective-C and Objective-C++ programs, but you can also use most of
1830 the language-independent GNU compiler options.
1831 For example, you might compile a file @code{some_class.m} like this:
1833 @smallexample
1834 gcc -g -fgnu-runtime -O -c some_class.m
1835 @end smallexample
1837 @noindent
1838 In this example, @option{-fgnu-runtime} is an option meant only for
1839 Objective-C and Objective-C++ programs; you can use the other options with
1840 any language supported by GCC@.
1842 Note that since Objective-C is an extension of the C language, Objective-C
1843 compilations may also use options specific to the C front-end (e.g.,
1844 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1845 C++-specific options (e.g., @option{-Wabi}).
1847 Here is a list of options that are @emph{only} for compiling Objective-C
1848 and Objective-C++ programs:
1850 @table @gcctabopt
1851 @item -fconstant-string-class=@var{class-name}
1852 @opindex fconstant-string-class
1853 Use @var{class-name} as the name of the class to instantiate for each
1854 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1855 class name is @code{NXConstantString} if the GNU runtime is being used, and
1856 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1857 @option{-fconstant-cfstrings} option, if also present, will override the
1858 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1859 to be laid out as constant CoreFoundation strings.
1861 @item -fgnu-runtime
1862 @opindex fgnu-runtime
1863 Generate object code compatible with the standard GNU Objective-C
1864 runtime.  This is the default for most types of systems.
1866 @item -fnext-runtime
1867 @opindex fnext-runtime
1868 Generate output compatible with the NeXT runtime.  This is the default
1869 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1870 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1871 used.
1873 @item -fno-nil-receivers
1874 @opindex fno-nil-receivers
1875 Assume that all Objective-C message dispatches (e.g.,
1876 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1877 is not @code{nil}.  This allows for more efficient entry points in the runtime
1878 to be used.  Currently, this option is only available in conjunction with
1879 the NeXT runtime on Mac OS X 10.3 and later.
1881 @item -fobjc-exceptions
1882 @opindex fobjc-exceptions
1883 Enable syntactic support for structured exception handling in Objective-C,
1884 similar to what is offered by C++ and Java.  Currently, this option is only
1885 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1887 @smallexample
1888   @@try @{
1889     @dots{}
1890        @@throw expr;
1891     @dots{}
1892   @}
1893   @@catch (AnObjCClass *exc) @{
1894     @dots{}
1895       @@throw expr;
1896     @dots{}
1897       @@throw;
1898     @dots{}
1899   @}
1900   @@catch (AnotherClass *exc) @{
1901     @dots{}
1902   @}
1903   @@catch (id allOthers) @{
1904     @dots{}
1905   @}
1906   @@finally @{
1907     @dots{}
1908       @@throw expr;
1909     @dots{}
1910   @}
1911 @end smallexample
1913 The @code{@@throw} statement may appear anywhere in an Objective-C or
1914 Objective-C++ program; when used inside of a @code{@@catch} block, the
1915 @code{@@throw} may appear without an argument (as shown above), in which case
1916 the object caught by the @code{@@catch} will be rethrown.
1918 Note that only (pointers to) Objective-C objects may be thrown and
1919 caught using this scheme.  When an object is thrown, it will be caught
1920 by the nearest @code{@@catch} clause capable of handling objects of that type,
1921 analogously to how @code{catch} blocks work in C++ and Java.  A
1922 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1923 any and all Objective-C exceptions not caught by previous @code{@@catch}
1924 clauses (if any).
1926 The @code{@@finally} clause, if present, will be executed upon exit from the
1927 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1928 regardless of whether any exceptions are thrown, caught or rethrown
1929 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1930 of the @code{finally} clause in Java.
1932 There are several caveats to using the new exception mechanism:
1934 @itemize @bullet
1935 @item
1936 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1937 idioms provided by the @code{NSException} class, the new
1938 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1939 systems, due to additional functionality needed in the (NeXT) Objective-C
1940 runtime.
1942 @item
1943 As mentioned above, the new exceptions do not support handling
1944 types other than Objective-C objects.   Furthermore, when used from
1945 Objective-C++, the Objective-C exception model does not interoperate with C++
1946 exceptions at this time.  This means you cannot @code{@@throw} an exception
1947 from Objective-C and @code{catch} it in C++, or vice versa
1948 (i.e., @code{throw @dots{} @@catch}).
1949 @end itemize
1951 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1952 blocks for thread-safe execution:
1954 @smallexample
1955   @@synchronized (ObjCClass *guard) @{
1956     @dots{}
1957   @}
1958 @end smallexample
1960 Upon entering the @code{@@synchronized} block, a thread of execution shall
1961 first check whether a lock has been placed on the corresponding @code{guard}
1962 object by another thread.  If it has, the current thread shall wait until
1963 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1964 the current thread will place its own lock on it, execute the code contained in
1965 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1966 making @code{guard} available to other threads).
1968 Unlike Java, Objective-C does not allow for entire methods to be marked
1969 @code{@@synchronized}.  Note that throwing exceptions out of
1970 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1971 to be unlocked properly.
1973 @item -freplace-objc-classes
1974 @opindex freplace-objc-classes
1975 Emit a special marker instructing @command{ld(1)} not to statically link in
1976 the resulting object file, and allow @command{dyld(1)} to load it in at
1977 run time instead.  This is used in conjunction with the Fix-and-Continue
1978 debugging mode, where the object file in question may be recompiled and
1979 dynamically reloaded in the course of program execution, without the need
1980 to restart the program itself.  Currently, Fix-and-Continue functionality
1981 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1982 and later.
1984 @item -fzero-link
1985 @opindex fzero-link
1986 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1987 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1988 compile time) with static class references that get initialized at load time,
1989 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1990 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1991 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1992 for individual class implementations to be modified during program execution.
1994 @item -gen-decls
1995 @opindex gen-decls
1996 Dump interface declarations for all classes seen in the source file to a
1997 file named @file{@var{sourcename}.decl}.
1999 @item -Wno-protocol
2000 @opindex Wno-protocol
2001 If a class is declared to implement a protocol, a warning is issued for
2002 every method in the protocol that is not implemented by the class.  The
2003 default behavior is to issue a warning for every method not explicitly
2004 implemented in the class, even if a method implementation is inherited
2005 from the superclass.  If you use the @option{-Wno-protocol} option, then
2006 methods inherited from the superclass are considered to be implemented,
2007 and no warning is issued for them.
2009 @item -Wselector
2010 @opindex Wselector
2011 Warn if multiple methods of different types for the same selector are
2012 found during compilation.  The check is performed on the list of methods
2013 in the final stage of compilation.  Additionally, a check is performed
2014 for each selector appearing in a @code{@@selector(@dots{})}
2015 expression, and a corresponding method for that selector has been found
2016 during compilation.  Because these checks scan the method table only at
2017 the end of compilation, these warnings are not produced if the final
2018 stage of compilation is not reached, for example because an error is
2019 found during compilation, or because the @option{-fsyntax-only} option is
2020 being used.
2022 @item -Wundeclared-selector
2023 @opindex Wundeclared-selector
2024 Warn if a @code{@@selector(@dots{})} expression referring to an
2025 undeclared selector is found.  A selector is considered undeclared if no
2026 method with that name has been declared before the
2027 @code{@@selector(@dots{})} expression, either explicitly in an
2028 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2029 an @code{@@implementation} section.  This option always performs its
2030 checks as soon as a @code{@@selector(@dots{})} expression is found,
2031 while @option{-Wselector} only performs its checks in the final stage of
2032 compilation.  This also enforces the coding style convention
2033 that methods and selectors must be declared before being used.
2035 @item -print-objc-runtime-info
2036 @opindex print-objc-runtime-info
2037 Generate C header describing the largest structure that is passed by
2038 value, if any.
2040 @end table
2042 @node Language Independent Options
2043 @section Options to Control Diagnostic Messages Formatting
2044 @cindex options to control diagnostics formatting
2045 @cindex diagnostic messages
2046 @cindex message formatting
2048 Traditionally, diagnostic messages have been formatted irrespective of
2049 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2050 below can be used to control the diagnostic messages formatting
2051 algorithm, e.g.@: how many characters per line, how often source location
2052 information should be reported.  Right now, only the C++ front end can
2053 honor these options.  However it is expected, in the near future, that
2054 the remaining front ends would be able to digest them correctly.
2056 @table @gcctabopt
2057 @item -fmessage-length=@var{n}
2058 @opindex fmessage-length
2059 Try to format error messages so that they fit on lines of about @var{n}
2060 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2061 the front ends supported by GCC@.  If @var{n} is zero, then no
2062 line-wrapping will be done; each error message will appear on a single
2063 line.
2065 @opindex fdiagnostics-show-location
2066 @item -fdiagnostics-show-location=once
2067 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2068 reporter to emit @emph{once} source location information; that is, in
2069 case the message is too long to fit on a single physical line and has to
2070 be wrapped, the source location won't be emitted (as prefix) again,
2071 over and over, in subsequent continuation lines.  This is the default
2072 behavior.
2074 @item -fdiagnostics-show-location=every-line
2075 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2076 messages reporter to emit the same source location information (as
2077 prefix) for physical lines that result from the process of breaking
2078 a message which is too long to fit on a single line.
2080 @end table
2082 @node Warning Options
2083 @section Options to Request or Suppress Warnings
2084 @cindex options to control warnings
2085 @cindex warning messages
2086 @cindex messages, warning
2087 @cindex suppressing warnings
2089 Warnings are diagnostic messages that report constructions which
2090 are not inherently erroneous but which are risky or suggest there
2091 may have been an error.
2093 You can request many specific warnings with options beginning @samp{-W},
2094 for example @option{-Wimplicit} to request warnings on implicit
2095 declarations.  Each of these specific warning options also has a
2096 negative form beginning @samp{-Wno-} to turn off warnings;
2097 for example, @option{-Wno-implicit}.  This manual lists only one of the
2098 two forms, whichever is not the default.
2100 The following options control the amount and kinds of warnings produced
2101 by GCC; for further, language-specific options also refer to
2102 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2103 Options}.
2105 @table @gcctabopt
2106 @cindex syntax checking
2107 @item -fsyntax-only
2108 @opindex fsyntax-only
2109 Check the code for syntax errors, but don't do anything beyond that.
2111 @item -pedantic
2112 @opindex pedantic
2113 Issue all the warnings demanded by strict ISO C and ISO C++;
2114 reject all programs that use forbidden extensions, and some other
2115 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2116 version of the ISO C standard specified by any @option{-std} option used.
2118 Valid ISO C and ISO C++ programs should compile properly with or without
2119 this option (though a rare few will require @option{-ansi} or a
2120 @option{-std} option specifying the required version of ISO C)@.  However,
2121 without this option, certain GNU extensions and traditional C and C++
2122 features are supported as well.  With this option, they are rejected.
2124 @option{-pedantic} does not cause warning messages for use of the
2125 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2126 warnings are also disabled in the expression that follows
2127 @code{__extension__}.  However, only system header files should use
2128 these escape routes; application programs should avoid them.
2129 @xref{Alternate Keywords}.
2131 Some users try to use @option{-pedantic} to check programs for strict ISO
2132 C conformance.  They soon find that it does not do quite what they want:
2133 it finds some non-ISO practices, but not all---only those for which
2134 ISO C @emph{requires} a diagnostic, and some others for which
2135 diagnostics have been added.
2137 A feature to report any failure to conform to ISO C might be useful in
2138 some instances, but would require considerable additional work and would
2139 be quite different from @option{-pedantic}.  We don't have plans to
2140 support such a feature in the near future.
2142 Where the standard specified with @option{-std} represents a GNU
2143 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2144 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2145 extended dialect is based.  Warnings from @option{-pedantic} are given
2146 where they are required by the base standard.  (It would not make sense
2147 for such warnings to be given only for features not in the specified GNU
2148 C dialect, since by definition the GNU dialects of C include all
2149 features the compiler supports with the given option, and there would be
2150 nothing to warn about.)
2152 @item -pedantic-errors
2153 @opindex pedantic-errors
2154 Like @option{-pedantic}, except that errors are produced rather than
2155 warnings.
2157 @item -w
2158 @opindex w
2159 Inhibit all warning messages.
2161 @item -Wno-import
2162 @opindex Wno-import
2163 Inhibit warning messages about the use of @samp{#import}.
2165 @item -Wchar-subscripts
2166 @opindex Wchar-subscripts
2167 Warn if an array subscript has type @code{char}.  This is a common cause
2168 of error, as programmers often forget that this type is signed on some
2169 machines.
2170 This warning is enabled by @option{-Wall}.
2172 @item -Wcomment
2173 @opindex Wcomment
2174 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2175 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2176 This warning is enabled by @option{-Wall}.
2178 @item -Wfatal-errors
2179 @opindex Wfatal-errors
2180 This option causes the compiler to abort compilation on the first error
2181 occurred rather than trying to keep going and printing further error
2182 messages.
2184 @item -Wformat
2185 @opindex Wformat
2186 @opindex ffreestanding
2187 @opindex fno-builtin
2188 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2189 the arguments supplied have types appropriate to the format string
2190 specified, and that the conversions specified in the format string make
2191 sense.  This includes standard functions, and others specified by format
2192 attributes (@pxref{Function Attributes}), in the @code{printf},
2193 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2194 not in the C standard) families (or other target-specific families).
2195 Which functions are checked without format attributes having been
2196 specified depends on the standard version selected, and such checks of
2197 functions without the attribute specified are disabled by
2198 @option{-ffreestanding} or @option{-fno-builtin}.
2200 The formats are checked against the format features supported by GNU
2201 libc version 2.2.  These include all ISO C90 and C99 features, as well
2202 as features from the Single Unix Specification and some BSD and GNU
2203 extensions.  Other library implementations may not support all these
2204 features; GCC does not support warning about features that go beyond a
2205 particular library's limitations.  However, if @option{-pedantic} is used
2206 with @option{-Wformat}, warnings will be given about format features not
2207 in the selected standard version (but not for @code{strfmon} formats,
2208 since those are not in any version of the C standard).  @xref{C Dialect
2209 Options,,Options Controlling C Dialect}.
2211 Since @option{-Wformat} also checks for null format arguments for
2212 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2214 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2215 aspects of format checking, the options @option{-Wformat-y2k},
2216 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2217 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2218 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2220 @item -Wformat-y2k
2221 @opindex Wformat-y2k
2222 If @option{-Wformat} is specified, also warn about @code{strftime}
2223 formats which may yield only a two-digit year.
2225 @item -Wno-format-extra-args
2226 @opindex Wno-format-extra-args
2227 If @option{-Wformat} is specified, do not warn about excess arguments to a
2228 @code{printf} or @code{scanf} format function.  The C standard specifies
2229 that such arguments are ignored.
2231 Where the unused arguments lie between used arguments that are
2232 specified with @samp{$} operand number specifications, normally
2233 warnings are still given, since the implementation could not know what
2234 type to pass to @code{va_arg} to skip the unused arguments.  However,
2235 in the case of @code{scanf} formats, this option will suppress the
2236 warning if the unused arguments are all pointers, since the Single
2237 Unix Specification says that such unused arguments are allowed.
2239 @item -Wno-format-zero-length
2240 @opindex Wno-format-zero-length
2241 If @option{-Wformat} is specified, do not warn about zero-length formats.
2242 The C standard specifies that zero-length formats are allowed.
2244 @item -Wformat-nonliteral
2245 @opindex Wformat-nonliteral
2246 If @option{-Wformat} is specified, also warn if the format string is not a
2247 string literal and so cannot be checked, unless the format function
2248 takes its format arguments as a @code{va_list}.
2250 @item -Wformat-security
2251 @opindex Wformat-security
2252 If @option{-Wformat} is specified, also warn about uses of format
2253 functions that represent possible security problems.  At present, this
2254 warns about calls to @code{printf} and @code{scanf} functions where the
2255 format string is not a string literal and there are no format arguments,
2256 as in @code{printf (foo);}.  This may be a security hole if the format
2257 string came from untrusted input and contains @samp{%n}.  (This is
2258 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2259 in future warnings may be added to @option{-Wformat-security} that are not
2260 included in @option{-Wformat-nonliteral}.)
2262 @item -Wformat=2
2263 @opindex Wformat=2
2264 Enable @option{-Wformat} plus format checks not included in
2265 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2266 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2268 @item -Wnonnull
2269 @opindex Wnonnull
2270 Warn about passing a null pointer for arguments marked as
2271 requiring a non-null value by the @code{nonnull} function attribute.
2273 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2274 can be disabled with the @option{-Wno-nonnull} option.
2276 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2277 @opindex Winit-self
2278 Warn about uninitialized variables which are initialized with themselves.
2279 Note this option can only be used with the @option{-Wuninitialized} option,
2280 which in turn only works with @option{-O1} and above.
2282 For example, GCC will warn about @code{i} being uninitialized in the
2283 following snippet only when @option{-Winit-self} has been specified:
2284 @smallexample
2285 @group
2286 int f()
2288   int i = i;
2289   return i;
2291 @end group
2292 @end smallexample
2294 @item -Wimplicit-int
2295 @opindex Wimplicit-int
2296 Warn when a declaration does not specify a type.
2297 This warning is enabled by @option{-Wall}.
2299 @item -Wimplicit-function-declaration
2300 @itemx -Werror-implicit-function-declaration
2301 @opindex Wimplicit-function-declaration
2302 @opindex Werror-implicit-function-declaration
2303 Give a warning (or error) whenever a function is used before being
2304 declared.  The form @option{-Wno-error-implicit-function-declaration}
2305 is not supported.
2306 This warning is enabled by @option{-Wall} (as a warning, not an error).
2308 @item -Wimplicit
2309 @opindex Wimplicit
2310 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2311 This warning is enabled by @option{-Wall}.
2313 @item -Wmain
2314 @opindex Wmain
2315 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2316 function with external linkage, returning int, taking either zero
2317 arguments, two, or three arguments of appropriate types.
2318 This warning is enabled by @option{-Wall}.
2320 @item -Wmissing-braces
2321 @opindex Wmissing-braces
2322 Warn if an aggregate or union initializer is not fully bracketed.  In
2323 the following example, the initializer for @samp{a} is not fully
2324 bracketed, but that for @samp{b} is fully bracketed.
2326 @smallexample
2327 int a[2][2] = @{ 0, 1, 2, 3 @};
2328 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2329 @end smallexample
2331 This warning is enabled by @option{-Wall}.
2333 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2334 @opindex Wmissing-include-dirs
2335 Warn if a user-supplied include directory does not exist.
2337 @item -Wparentheses
2338 @opindex Wparentheses
2339 Warn if parentheses are omitted in certain contexts, such
2340 as when there is an assignment in a context where a truth value
2341 is expected, or when operators are nested whose precedence people
2342 often get confused about.  Only the warning for an assignment used as
2343 a truth value is supported when compiling C++; the other warnings are
2344 only supported when compiling C@.
2346 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2347 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2348 interpretation from that of ordinary mathematical notation.
2350 Also warn about constructions where there may be confusion to which
2351 @code{if} statement an @code{else} branch belongs.  Here is an example of
2352 such a case:
2354 @smallexample
2355 @group
2357   if (a)
2358     if (b)
2359       foo ();
2360   else
2361     bar ();
2363 @end group
2364 @end smallexample
2366 In C, every @code{else} branch belongs to the innermost possible @code{if}
2367 statement, which in this example is @code{if (b)}.  This is often not
2368 what the programmer expected, as illustrated in the above example by
2369 indentation the programmer chose.  When there is the potential for this
2370 confusion, GCC will issue a warning when this flag is specified.
2371 To eliminate the warning, add explicit braces around the innermost
2372 @code{if} statement so there is no way the @code{else} could belong to
2373 the enclosing @code{if}.  The resulting code would look like this:
2375 @smallexample
2376 @group
2378   if (a)
2379     @{
2380       if (b)
2381         foo ();
2382       else
2383         bar ();
2384     @}
2386 @end group
2387 @end smallexample
2389 This warning is enabled by @option{-Wall}.
2391 @item -Wsequence-point
2392 @opindex Wsequence-point
2393 Warn about code that may have undefined semantics because of violations
2394 of sequence point rules in the C standard.
2396 The C standard defines the order in which expressions in a C program are
2397 evaluated in terms of @dfn{sequence points}, which represent a partial
2398 ordering between the execution of parts of the program: those executed
2399 before the sequence point, and those executed after it.  These occur
2400 after the evaluation of a full expression (one which is not part of a
2401 larger expression), after the evaluation of the first operand of a
2402 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2403 function is called (but after the evaluation of its arguments and the
2404 expression denoting the called function), and in certain other places.
2405 Other than as expressed by the sequence point rules, the order of
2406 evaluation of subexpressions of an expression is not specified.  All
2407 these rules describe only a partial order rather than a total order,
2408 since, for example, if two functions are called within one expression
2409 with no sequence point between them, the order in which the functions
2410 are called is not specified.  However, the standards committee have
2411 ruled that function calls do not overlap.
2413 It is not specified when between sequence points modifications to the
2414 values of objects take effect.  Programs whose behavior depends on this
2415 have undefined behavior; the C standard specifies that ``Between the
2416 previous and next sequence point an object shall have its stored value
2417 modified at most once by the evaluation of an expression.  Furthermore,
2418 the prior value shall be read only to determine the value to be
2419 stored.''.  If a program breaks these rules, the results on any
2420 particular implementation are entirely unpredictable.
2422 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2423 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2424 diagnosed by this option, and it may give an occasional false positive
2425 result, but in general it has been found fairly effective at detecting
2426 this sort of problem in programs.
2428 The present implementation of this option only works for C programs.  A
2429 future implementation may also work for C++ programs.
2431 The C standard is worded confusingly, therefore there is some debate
2432 over the precise meaning of the sequence point rules in subtle cases.
2433 Links to discussions of the problem, including proposed formal
2434 definitions, may be found on the GCC readings page, at
2435 @w{@uref{http://gcc.gnu.org/readings.html}}.
2437 This warning is enabled by @option{-Wall}.
2439 @item -Wreturn-type
2440 @opindex Wreturn-type
2441 Warn whenever a function is defined with a return-type that defaults to
2442 @code{int}.  Also warn about any @code{return} statement with no
2443 return-value in a function whose return-type is not @code{void}.
2445 For C, also warn if the return type of a function has a type qualifier
2446 such as @code{const}.  Such a type qualifier has no effect, since the
2447 value returned by a function is not an lvalue.  ISO C prohibits
2448 qualified @code{void} return types on function definitions, so such
2449 return types always receive a warning even without this option.
2451 For C++, a function without return type always produces a diagnostic
2452 message, even when @option{-Wno-return-type} is specified.  The only
2453 exceptions are @samp{main} and functions defined in system headers.
2455 This warning is enabled by @option{-Wall}.
2457 @item -Wswitch
2458 @opindex Wswitch
2459 Warn whenever a @code{switch} statement has an index of enumerated type
2460 and lacks a @code{case} for one or more of the named codes of that
2461 enumeration.  (The presence of a @code{default} label prevents this
2462 warning.)  @code{case} labels outside the enumeration range also
2463 provoke warnings when this option is used.
2464 This warning is enabled by @option{-Wall}.
2466 @item -Wswitch-default
2467 @opindex Wswitch-switch
2468 Warn whenever a @code{switch} statement does not have a @code{default}
2469 case.
2471 @item -Wswitch-enum
2472 @opindex Wswitch-enum
2473 Warn whenever a @code{switch} statement has an index of enumerated type
2474 and lacks a @code{case} for one or more of the named codes of that
2475 enumeration.  @code{case} labels outside the enumeration range also
2476 provoke warnings when this option is used.
2478 @item -Wtrigraphs
2479 @opindex Wtrigraphs
2480 Warn if any trigraphs are encountered that might change the meaning of
2481 the program (trigraphs within comments are not warned about).
2482 This warning is enabled by @option{-Wall}.
2484 @item -Wunused-function
2485 @opindex Wunused-function
2486 Warn whenever a static function is declared but not defined or a
2487 non\-inline static function is unused.
2488 This warning is enabled by @option{-Wall}.
2490 @item -Wunused-label
2491 @opindex Wunused-label
2492 Warn whenever a label is declared but not used.
2493 This warning is enabled by @option{-Wall}.
2495 To suppress this warning use the @samp{unused} attribute
2496 (@pxref{Variable Attributes}).
2498 @item -Wunused-parameter
2499 @opindex Wunused-parameter
2500 Warn whenever a function parameter is unused aside from its declaration.
2502 To suppress this warning use the @samp{unused} attribute
2503 (@pxref{Variable Attributes}).
2505 @item -Wunused-variable
2506 @opindex Wunused-variable
2507 Warn whenever a local variable or non-constant static variable is unused
2508 aside from its declaration
2509 This warning is enabled by @option{-Wall}.
2511 To suppress this warning use the @samp{unused} attribute
2512 (@pxref{Variable Attributes}).
2514 @item -Wunused-value
2515 @opindex Wunused-value
2516 Warn whenever a statement computes a result that is explicitly not used.
2517 This warning is enabled by @option{-Wall}.
2519 To suppress this warning cast the expression to @samp{void}.
2521 @item -Wunused
2522 @opindex Wunused
2523 All the above @option{-Wunused} options combined.
2525 In order to get a warning about an unused function parameter, you must
2526 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2527 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2529 @item -Wuninitialized
2530 @opindex Wuninitialized
2531 Warn if an automatic variable is used without first being initialized or
2532 if a variable may be clobbered by a @code{setjmp} call.
2534 These warnings are possible only in optimizing compilation,
2535 because they require data flow information that is computed only
2536 when optimizing.  If you don't specify @option{-O}, you simply won't
2537 get these warnings.
2539 If you want to warn about code which uses the uninitialized value of the
2540 variable in its own initializer, use the @option{-Winit-self} option.
2542 These warnings occur only for variables that are candidates for
2543 register allocation.  Therefore, they do not occur for a variable that
2544 is declared @code{volatile}, or whose address is taken, or whose size
2545 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2546 structures, unions or arrays, even when they are in registers.
2548 Note that there may be no warning about a variable that is used only
2549 to compute a value that itself is never used, because such
2550 computations may be deleted by data flow analysis before the warnings
2551 are printed.
2553 These warnings are made optional because GCC is not smart
2554 enough to see all the reasons why the code might be correct
2555 despite appearing to have an error.  Here is one example of how
2556 this can happen:
2558 @smallexample
2559 @group
2561   int x;
2562   switch (y)
2563     @{
2564     case 1: x = 1;
2565       break;
2566     case 2: x = 4;
2567       break;
2568     case 3: x = 5;
2569     @}
2570   foo (x);
2572 @end group
2573 @end smallexample
2575 @noindent
2576 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2577 always initialized, but GCC doesn't know this.  Here is
2578 another common case:
2580 @smallexample
2582   int save_y;
2583   if (change_y) save_y = y, y = new_y;
2584   @dots{}
2585   if (change_y) y = save_y;
2587 @end smallexample
2589 @noindent
2590 This has no bug because @code{save_y} is used only if it is set.
2592 @cindex @code{longjmp} warnings
2593 This option also warns when a non-volatile automatic variable might be
2594 changed by a call to @code{longjmp}.  These warnings as well are possible
2595 only in optimizing compilation.
2597 The compiler sees only the calls to @code{setjmp}.  It cannot know
2598 where @code{longjmp} will be called; in fact, a signal handler could
2599 call it at any point in the code.  As a result, you may get a warning
2600 even when there is in fact no problem because @code{longjmp} cannot
2601 in fact be called at the place which would cause a problem.
2603 Some spurious warnings can be avoided if you declare all the functions
2604 you use that never return as @code{noreturn}.  @xref{Function
2605 Attributes}.
2607 This warning is enabled by @option{-Wall}.
2609 @item -Wunknown-pragmas
2610 @opindex Wunknown-pragmas
2611 @cindex warning for unknown pragmas
2612 @cindex unknown pragmas, warning
2613 @cindex pragmas, warning of unknown
2614 Warn when a #pragma directive is encountered which is not understood by
2615 GCC@.  If this command line option is used, warnings will even be issued
2616 for unknown pragmas in system header files.  This is not the case if
2617 the warnings were only enabled by the @option{-Wall} command line option.
2619 @item -Wstrict-aliasing
2620 @opindex Wstrict-aliasing
2621 This option is only active when @option{-fstrict-aliasing} is active.
2622 It warns about code which might break the strict aliasing rules that the
2623 compiler is using for optimization.  The warning does not catch all
2624 cases, but does attempt to catch the more common pitfalls.  It is
2625 included in @option{-Wall}.
2627 @item -Wstrict-aliasing=2
2628 @opindex Wstrict-aliasing=2
2629 This option is only active when @option{-fstrict-aliasing} is active.
2630 It warns about all code which might break the strict aliasing rules that the
2631 compiler is using for optimization.  This warning catches all cases, but
2632 it will also give a warning for some ambiguous cases that are safe.
2634 @item -Wall
2635 @opindex Wall
2636 All of the above @samp{-W} options combined.  This enables all the
2637 warnings about constructions that some users consider questionable, and
2638 that are easy to avoid (or modify to prevent the warning), even in
2639 conjunction with macros.  This also enables some language-specific
2640 warnings described in @ref{C++ Dialect Options} and
2641 @ref{Objective-C and Objective-C++ Dialect Options}.
2642 @end table
2644 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2645 Some of them warn about constructions that users generally do not
2646 consider questionable, but which occasionally you might wish to check
2647 for; others warn about constructions that are necessary or hard to avoid
2648 in some cases, and there is no simple way to modify the code to suppress
2649 the warning.
2651 @table @gcctabopt
2652 @item -Wextra
2653 @opindex W
2654 @opindex Wextra
2655 (This option used to be called @option{-W}.  The older name is still
2656 supported, but the newer name is more descriptive.)  Print extra warning
2657 messages for these events:
2659 @itemize @bullet
2660 @item
2661 A function can return either with or without a value.  (Falling
2662 off the end of the function body is considered returning without
2663 a value.)  For example, this function would evoke such a
2664 warning:
2666 @smallexample
2667 @group
2668 foo (a)
2670   if (a > 0)
2671     return a;
2673 @end group
2674 @end smallexample
2676 @item
2677 An expression-statement or the left-hand side of a comma expression
2678 contains no side effects.
2679 To suppress the warning, cast the unused expression to void.
2680 For example, an expression such as @samp{x[i,j]} will cause a warning,
2681 but @samp{x[(void)i,j]} will not.
2683 @item
2684 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2686 @item
2687 Storage-class specifiers like @code{static} are not the first things in
2688 a declaration.  According to the C Standard, this usage is obsolescent.
2690 @item
2691 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2692 arguments.
2694 @item
2695 A comparison between signed and unsigned values could produce an
2696 incorrect result when the signed value is converted to unsigned.
2697 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2699 @item
2700 An aggregate has an initializer which does not initialize all members.
2701 This warning can be independently controlled by
2702 @option{-Wmissing-field-initializers}.
2704 @item
2705 A function parameter is declared without a type specifier in K&R-style
2706 functions:
2708 @smallexample
2709 void foo(bar) @{ @}
2710 @end smallexample
2712 @item
2713 An empty body occurs in an @samp{if} or @samp{else} statement.
2715 @item
2716 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2717 @samp{>}, or @samp{>=}.
2719 @item
2720 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2722 @item
2723 Any of several floating-point events that often indicate errors, such as
2724 overflow, underflow, loss of precision, etc.
2726 @item @r{(C++ only)}
2727 An enumerator and a non-enumerator both appear in a conditional expression.
2729 @item @r{(C++ only)}
2730 A non-static reference or non-static @samp{const} member appears in a
2731 class without constructors.
2733 @item @r{(C++ only)}
2734 Ambiguous virtual bases.
2736 @item @r{(C++ only)}
2737 Subscripting an array which has been declared @samp{register}.
2739 @item @r{(C++ only)}
2740 Taking the address of a variable which has been declared @samp{register}.
2742 @item @r{(C++ only)}
2743 A base class is not initialized in a derived class' copy constructor.
2744 @end itemize
2746 @item -Wno-div-by-zero
2747 @opindex Wno-div-by-zero
2748 @opindex Wdiv-by-zero
2749 Do not warn about compile-time integer division by zero.  Floating point
2750 division by zero is not warned about, as it can be a legitimate way of
2751 obtaining infinities and NaNs.
2753 @item -Wsystem-headers
2754 @opindex Wsystem-headers
2755 @cindex warnings from system headers
2756 @cindex system headers, warnings from
2757 Print warning messages for constructs found in system header files.
2758 Warnings from system headers are normally suppressed, on the assumption
2759 that they usually do not indicate real problems and would only make the
2760 compiler output harder to read.  Using this command line option tells
2761 GCC to emit warnings from system headers as if they occurred in user
2762 code.  However, note that using @option{-Wall} in conjunction with this
2763 option will @emph{not} warn about unknown pragmas in system
2764 headers---for that, @option{-Wunknown-pragmas} must also be used.
2766 @item -Wfloat-equal
2767 @opindex Wfloat-equal
2768 Warn if floating point values are used in equality comparisons.
2770 The idea behind this is that sometimes it is convenient (for the
2771 programmer) to consider floating-point values as approximations to
2772 infinitely precise real numbers.  If you are doing this, then you need
2773 to compute (by analyzing the code, or in some other way) the maximum or
2774 likely maximum error that the computation introduces, and allow for it
2775 when performing comparisons (and when producing output, but that's a
2776 different problem).  In particular, instead of testing for equality, you
2777 would check to see whether the two values have ranges that overlap; and
2778 this is done with the relational operators, so equality comparisons are
2779 probably mistaken.
2781 @item -Wtraditional @r{(C only)}
2782 @opindex Wtraditional
2783 Warn about certain constructs that behave differently in traditional and
2784 ISO C@.  Also warn about ISO C constructs that have no traditional C
2785 equivalent, and/or problematic constructs which should be avoided.
2787 @itemize @bullet
2788 @item
2789 Macro parameters that appear within string literals in the macro body.
2790 In traditional C macro replacement takes place within string literals,
2791 but does not in ISO C@.
2793 @item
2794 In traditional C, some preprocessor directives did not exist.
2795 Traditional preprocessors would only consider a line to be a directive
2796 if the @samp{#} appeared in column 1 on the line.  Therefore
2797 @option{-Wtraditional} warns about directives that traditional C
2798 understands but would ignore because the @samp{#} does not appear as the
2799 first character on the line.  It also suggests you hide directives like
2800 @samp{#pragma} not understood by traditional C by indenting them.  Some
2801 traditional implementations would not recognize @samp{#elif}, so it
2802 suggests avoiding it altogether.
2804 @item
2805 A function-like macro that appears without arguments.
2807 @item
2808 The unary plus operator.
2810 @item
2811 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2812 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2813 constants.)  Note, these suffixes appear in macros defined in the system
2814 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2815 Use of these macros in user code might normally lead to spurious
2816 warnings, however GCC's integrated preprocessor has enough context to
2817 avoid warning in these cases.
2819 @item
2820 A function declared external in one block and then used after the end of
2821 the block.
2823 @item
2824 A @code{switch} statement has an operand of type @code{long}.
2826 @item
2827 A non-@code{static} function declaration follows a @code{static} one.
2828 This construct is not accepted by some traditional C compilers.
2830 @item
2831 The ISO type of an integer constant has a different width or
2832 signedness from its traditional type.  This warning is only issued if
2833 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2834 typically represent bit patterns, are not warned about.
2836 @item
2837 Usage of ISO string concatenation is detected.
2839 @item
2840 Initialization of automatic aggregates.
2842 @item
2843 Identifier conflicts with labels.  Traditional C lacks a separate
2844 namespace for labels.
2846 @item
2847 Initialization of unions.  If the initializer is zero, the warning is
2848 omitted.  This is done under the assumption that the zero initializer in
2849 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2850 initializer warnings and relies on default initialization to zero in the
2851 traditional C case.
2853 @item
2854 Conversions by prototypes between fixed/floating point values and vice
2855 versa.  The absence of these prototypes when compiling with traditional
2856 C would cause serious problems.  This is a subset of the possible
2857 conversion warnings, for the full set use @option{-Wconversion}.
2859 @item
2860 Use of ISO C style function definitions.  This warning intentionally is
2861 @emph{not} issued for prototype declarations or variadic functions
2862 because these ISO C features will appear in your code when using
2863 libiberty's traditional C compatibility macros, @code{PARAMS} and
2864 @code{VPARAMS}.  This warning is also bypassed for nested functions
2865 because that feature is already a GCC extension and thus not relevant to
2866 traditional C compatibility.
2867 @end itemize
2869 @item -Wdeclaration-after-statement @r{(C only)}
2870 @opindex Wdeclaration-after-statement
2871 Warn when a declaration is found after a statement in a block.  This
2872 construct, known from C++, was introduced with ISO C99 and is by default
2873 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2874 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2876 @item -Wundef
2877 @opindex Wundef
2878 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2880 @item -Wno-endif-labels
2881 @opindex Wno-endif-labels
2882 @opindex Wendif-labels
2883 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2885 @item -Wshadow
2886 @opindex Wshadow
2887 Warn whenever a local variable shadows another local variable, parameter or
2888 global variable or whenever a built-in function is shadowed.
2890 @item -Wlarger-than-@var{len}
2891 @opindex Wlarger-than
2892 Warn whenever an object of larger than @var{len} bytes is defined.
2894 @item -Wpointer-arith
2895 @opindex Wpointer-arith
2896 Warn about anything that depends on the ``size of'' a function type or
2897 of @code{void}.  GNU C assigns these types a size of 1, for
2898 convenience in calculations with @code{void *} pointers and pointers
2899 to functions.
2901 @item -Wbad-function-cast @r{(C only)}
2902 @opindex Wbad-function-cast
2903 Warn whenever a function call is cast to a non-matching type.
2904 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2906 @item -Wcast-qual
2907 @opindex Wcast-qual
2908 Warn whenever a pointer is cast so as to remove a type qualifier from
2909 the target type.  For example, warn if a @code{const char *} is cast
2910 to an ordinary @code{char *}.
2912 @item -Wcast-align
2913 @opindex Wcast-align
2914 Warn whenever a pointer is cast such that the required alignment of the
2915 target is increased.  For example, warn if a @code{char *} is cast to
2916 an @code{int *} on machines where integers can only be accessed at
2917 two- or four-byte boundaries.
2919 @item -Wwrite-strings
2920 @opindex Wwrite-strings
2921 When compiling C, give string constants the type @code{const
2922 char[@var{length}]} so that
2923 copying the address of one into a non-@code{const} @code{char *}
2924 pointer will get a warning; when compiling C++, warn about the
2925 deprecated conversion from string constants to @code{char *}.
2926 These warnings will help you find at
2927 compile time code that can try to write into a string constant, but
2928 only if you have been very careful about using @code{const} in
2929 declarations and prototypes.  Otherwise, it will just be a nuisance;
2930 this is why we did not make @option{-Wall} request these warnings.
2932 @item -Wconversion
2933 @opindex Wconversion
2934 Warn if a prototype causes a type conversion that is different from what
2935 would happen to the same argument in the absence of a prototype.  This
2936 includes conversions of fixed point to floating and vice versa, and
2937 conversions changing the width or signedness of a fixed point argument
2938 except when the same as the default promotion.
2940 Also, warn if a negative integer constant expression is implicitly
2941 converted to an unsigned type.  For example, warn about the assignment
2942 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2943 casts like @code{(unsigned) -1}.
2945 @item -Wsign-compare
2946 @opindex Wsign-compare
2947 @cindex warning for comparison of signed and unsigned values
2948 @cindex comparison of signed and unsigned values, warning
2949 @cindex signed and unsigned values, comparison warning
2950 Warn when a comparison between signed and unsigned values could produce
2951 an incorrect result when the signed value is converted to unsigned.
2952 This warning is also enabled by @option{-Wextra}; to get the other warnings
2953 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2955 @item -Waggregate-return
2956 @opindex Waggregate-return
2957 Warn if any functions that return structures or unions are defined or
2958 called.  (In languages where you can return an array, this also elicits
2959 a warning.)
2961 @item -Wstrict-prototypes @r{(C only)}
2962 @opindex Wstrict-prototypes
2963 Warn if a function is declared or defined without specifying the
2964 argument types.  (An old-style function definition is permitted without
2965 a warning if preceded by a declaration which specifies the argument
2966 types.)
2968 @item -Wold-style-definition @r{(C only)}
2969 @opindex Wold-style-definition
2970 Warn if an old-style function definition is used.  A warning is given
2971 even if there is a previous prototype.
2973 @item -Wmissing-prototypes @r{(C only)}
2974 @opindex Wmissing-prototypes
2975 Warn if a global function is defined without a previous prototype
2976 declaration.  This warning is issued even if the definition itself
2977 provides a prototype.  The aim is to detect global functions that fail
2978 to be declared in header files.
2980 @item -Wmissing-declarations @r{(C only)}
2981 @opindex Wmissing-declarations
2982 Warn if a global function is defined without a previous declaration.
2983 Do so even if the definition itself provides a prototype.
2984 Use this option to detect global functions that are not declared in
2985 header files.
2987 @item -Wmissing-field-initializers
2988 @opindex Wmissing-field-initializers
2989 @opindex W
2990 @opindex Wextra
2991 Warn if a structure's initializer has some fields missing.  For
2992 example, the following code would cause such a warning, because
2993 @code{x.h} is implicitly zero:
2995 @smallexample
2996 struct s @{ int f, g, h; @};
2997 struct s x = @{ 3, 4 @};
2998 @end smallexample
3000 This option does not warn about designated initializers, so the following
3001 modification would not trigger a warning:
3003 @smallexample
3004 struct s @{ int f, g, h; @};
3005 struct s x = @{ .f = 3, .g = 4 @};
3006 @end smallexample
3008 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3009 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3011 @item -Wmissing-noreturn
3012 @opindex Wmissing-noreturn
3013 Warn about functions which might be candidates for attribute @code{noreturn}.
3014 Note these are only possible candidates, not absolute ones.  Care should
3015 be taken to manually verify functions actually do not ever return before
3016 adding the @code{noreturn} attribute, otherwise subtle code generation
3017 bugs could be introduced.  You will not get a warning for @code{main} in
3018 hosted C environments.
3020 @item -Wmissing-format-attribute
3021 @opindex Wmissing-format-attribute
3022 @opindex Wformat
3023 If @option{-Wformat} is enabled, also warn about functions which might be
3024 candidates for @code{format} attributes.  Note these are only possible
3025 candidates, not absolute ones.  GCC will guess that @code{format}
3026 attributes might be appropriate for any function that calls a function
3027 like @code{vprintf} or @code{vscanf}, but this might not always be the
3028 case, and some functions for which @code{format} attributes are
3029 appropriate may not be detected.  This option has no effect unless
3030 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3032 @item -Wno-multichar
3033 @opindex Wno-multichar
3034 @opindex Wmultichar
3035 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3036 Usually they indicate a typo in the user's code, as they have
3037 implementation-defined values, and should not be used in portable code.
3039 @item -Wno-deprecated-declarations
3040 @opindex Wno-deprecated-declarations
3041 Do not warn about uses of functions, variables, and types marked as
3042 deprecated by using the @code{deprecated} attribute.
3043 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3044 @pxref{Type Attributes}.)
3046 @item -Wpacked
3047 @opindex Wpacked
3048 Warn if a structure is given the packed attribute, but the packed
3049 attribute has no effect on the layout or size of the structure.
3050 Such structures may be mis-aligned for little benefit.  For
3051 instance, in this code, the variable @code{f.x} in @code{struct bar}
3052 will be misaligned even though @code{struct bar} does not itself
3053 have the packed attribute:
3055 @smallexample
3056 @group
3057 struct foo @{
3058   int x;
3059   char a, b, c, d;
3060 @} __attribute__((packed));
3061 struct bar @{
3062   char z;
3063   struct foo f;
3065 @end group
3066 @end smallexample
3068 @item -Wpadded
3069 @opindex Wpadded
3070 Warn if padding is included in a structure, either to align an element
3071 of the structure or to align the whole structure.  Sometimes when this
3072 happens it is possible to rearrange the fields of the structure to
3073 reduce the padding and so make the structure smaller.
3075 @item -Wredundant-decls
3076 @opindex Wredundant-decls
3077 Warn if anything is declared more than once in the same scope, even in
3078 cases where multiple declaration is valid and changes nothing.
3080 @item -Wnested-externs @r{(C only)}
3081 @opindex Wnested-externs
3082 Warn if an @code{extern} declaration is encountered within a function.
3084 @item -Wunreachable-code
3085 @opindex Wunreachable-code
3086 Warn if the compiler detects that code will never be executed.
3088 This option is intended to warn when the compiler detects that at
3089 least a whole line of source code will never be executed, because
3090 some condition is never satisfied or because it is after a
3091 procedure that never returns.
3093 It is possible for this option to produce a warning even though there
3094 are circumstances under which part of the affected line can be executed,
3095 so care should be taken when removing apparently-unreachable code.
3097 For instance, when a function is inlined, a warning may mean that the
3098 line is unreachable in only one inlined copy of the function.
3100 This option is not made part of @option{-Wall} because in a debugging
3101 version of a program there is often substantial code which checks
3102 correct functioning of the program and is, hopefully, unreachable
3103 because the program does work.  Another common use of unreachable
3104 code is to provide behavior which is selectable at compile-time.
3106 @item -Winline
3107 @opindex Winline
3108 Warn if a function can not be inlined and it was declared as inline.
3109 Even with this option, the compiler will not warn about failures to
3110 inline functions declared in system headers.
3112 The compiler uses a variety of heuristics to determine whether or not
3113 to inline a function.  For example, the compiler takes into account
3114 the size of the function being inlined and the the amount of inlining
3115 that has already been done in the current function.  Therefore,
3116 seemingly insignificant changes in the source program can cause the
3117 warnings produced by @option{-Winline} to appear or disappear.
3119 @item -Wno-invalid-offsetof @r{(C++ only)}
3120 @opindex Wno-invalid-offsetof
3121 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3122 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3123 to a non-POD type is undefined.  In existing C++ implementations,
3124 however, @samp{offsetof} typically gives meaningful results even when
3125 applied to certain kinds of non-POD types. (Such as a simple
3126 @samp{struct} that fails to be a POD type only by virtue of having a
3127 constructor.)  This flag is for users who are aware that they are
3128 writing nonportable code and who have deliberately chosen to ignore the
3129 warning about it.
3131 The restrictions on @samp{offsetof} may be relaxed in a future version
3132 of the C++ standard.
3134 @item -Winvalid-pch
3135 @opindex Winvalid-pch
3136 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3137 the search path but can't be used.
3139 @item -Wlong-long
3140 @opindex Wlong-long
3141 @opindex Wno-long-long
3142 Warn if @samp{long long} type is used.  This is default.  To inhibit
3143 the warning messages, use @option{-Wno-long-long}.  Flags
3144 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3145 only when @option{-pedantic} flag is used.
3147 @item -Wvariadic-macros
3148 @opindex Wvariadic-macros
3149 @opindex Wno-variadic-macros
3150 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3151 alternate syntax when in pedantic ISO C99 mode.  This is default.
3152 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3154 @item -Wdisabled-optimization
3155 @opindex Wdisabled-optimization
3156 Warn if a requested optimization pass is disabled.  This warning does
3157 not generally indicate that there is anything wrong with your code; it
3158 merely indicates that GCC's optimizers were unable to handle the code
3159 effectively.  Often, the problem is that your code is too big or too
3160 complex; GCC will refuse to optimize programs when the optimization
3161 itself is likely to take inordinate amounts of time.
3163 @item -Wno-pointer-sign
3164 @opindex Wno-pointer-sign
3165 Don't warn for pointer argument passing or assignment with different signedness.
3166 Only useful in the negative form since this warning is enabled by default.
3167 This option is only supported for C and Objective-C@.
3169 @item -Werror
3170 @opindex Werror
3171 Make all warnings into errors.
3172 @end table
3174 @node Debugging Options
3175 @section Options for Debugging Your Program or GCC
3176 @cindex options, debugging
3177 @cindex debugging information options
3179 GCC has various special options that are used for debugging
3180 either your program or GCC:
3182 @table @gcctabopt
3183 @item -g
3184 @opindex g
3185 Produce debugging information in the operating system's native format
3186 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3187 information.
3189 On most systems that use stabs format, @option{-g} enables use of extra
3190 debugging information that only GDB can use; this extra information
3191 makes debugging work better in GDB but will probably make other debuggers
3192 crash or
3193 refuse to read the program.  If you want to control for certain whether
3194 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3195 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3197 GCC allows you to use @option{-g} with
3198 @option{-O}.  The shortcuts taken by optimized code may occasionally
3199 produce surprising results: some variables you declared may not exist
3200 at all; flow of control may briefly move where you did not expect it;
3201 some statements may not be executed because they compute constant
3202 results or their values were already at hand; some statements may
3203 execute in different places because they were moved out of loops.
3205 Nevertheless it proves possible to debug optimized output.  This makes
3206 it reasonable to use the optimizer for programs that might have bugs.
3208 The following options are useful when GCC is generated with the
3209 capability for more than one debugging format.
3211 @item -ggdb
3212 @opindex ggdb
3213 Produce debugging information for use by GDB@.  This means to use the
3214 most expressive format available (DWARF 2, stabs, or the native format
3215 if neither of those are supported), including GDB extensions if at all
3216 possible.
3218 @item -gstabs
3219 @opindex gstabs
3220 Produce debugging information in stabs format (if that is supported),
3221 without GDB extensions.  This is the format used by DBX on most BSD
3222 systems.  On MIPS, Alpha and System V Release 4 systems this option
3223 produces stabs debugging output which is not understood by DBX or SDB@.
3224 On System V Release 4 systems this option requires the GNU assembler.
3226 @item -feliminate-unused-debug-symbols
3227 @opindex feliminate-unused-debug-symbols
3228 Produce debugging information in stabs format (if that is supported),
3229 for only symbols that are actually used.
3231 @item -gstabs+
3232 @opindex gstabs+
3233 Produce debugging information in stabs format (if that is supported),
3234 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3235 use of these extensions is likely to make other debuggers crash or
3236 refuse to read the program.
3238 @item -gcoff
3239 @opindex gcoff
3240 Produce debugging information in COFF format (if that is supported).
3241 This is the format used by SDB on most System V systems prior to
3242 System V Release 4.
3244 @item -gxcoff
3245 @opindex gxcoff
3246 Produce debugging information in XCOFF format (if that is supported).
3247 This is the format used by the DBX debugger on IBM RS/6000 systems.
3249 @item -gxcoff+
3250 @opindex gxcoff+
3251 Produce debugging information in XCOFF format (if that is supported),
3252 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3253 use of these extensions is likely to make other debuggers crash or
3254 refuse to read the program, and may cause assemblers other than the GNU
3255 assembler (GAS) to fail with an error.
3257 @item -gdwarf-2
3258 @opindex gdwarf-2
3259 Produce debugging information in DWARF version 2 format (if that is
3260 supported).  This is the format used by DBX on IRIX 6.  With this
3261 option, GCC uses features of DWARF version 3 when they are useful;
3262 version 3 is upward compatible with version 2, but may still cause
3263 problems for older debuggers.
3265 @item -gvms
3266 @opindex gvms
3267 Produce debugging information in VMS debug format (if that is
3268 supported).  This is the format used by DEBUG on VMS systems.
3270 @item -g@var{level}
3271 @itemx -ggdb@var{level}
3272 @itemx -gstabs@var{level}
3273 @itemx -gcoff@var{level}
3274 @itemx -gxcoff@var{level}
3275 @itemx -gvms@var{level}
3276 Request debugging information and also use @var{level} to specify how
3277 much information.  The default level is 2.
3279 Level 1 produces minimal information, enough for making backtraces in
3280 parts of the program that you don't plan to debug.  This includes
3281 descriptions of functions and external variables, but no information
3282 about local variables and no line numbers.
3284 Level 3 includes extra information, such as all the macro definitions
3285 present in the program.  Some debuggers support macro expansion when
3286 you use @option{-g3}.
3288 @option{-gdwarf-2} does not accept a concatenated debug level, because
3289 GCC used to support an option @option{-gdwarf} that meant to generate
3290 debug information in version 1 of the DWARF format (which is very
3291 different from version 2), and it would have been too confusing.  That
3292 debug format is long obsolete, but the option cannot be changed now.
3293 Instead use an additional @option{-g@var{level}} option to change the
3294 debug level for DWARF2.
3296 @item -feliminate-dwarf2-dups
3297 @opindex feliminate-dwarf2-dups
3298 Compress DWARF2 debugging information by eliminating duplicated
3299 information about each symbol.  This option only makes sense when
3300 generating DWARF2 debugging information with @option{-gdwarf-2}.
3302 @cindex @command{prof}
3303 @item -p
3304 @opindex p
3305 Generate extra code to write profile information suitable for the
3306 analysis program @command{prof}.  You must use this option when compiling
3307 the source files you want data about, and you must also use it when
3308 linking.
3310 @cindex @command{gprof}
3311 @item -pg
3312 @opindex pg
3313 Generate extra code to write profile information suitable for the
3314 analysis program @command{gprof}.  You must use this option when compiling
3315 the source files you want data about, and you must also use it when
3316 linking.
3318 @item -Q
3319 @opindex Q
3320 Makes the compiler print out each function name as it is compiled, and
3321 print some statistics about each pass when it finishes.
3323 @item -ftime-report
3324 @opindex ftime-report
3325 Makes the compiler print some statistics about the time consumed by each
3326 pass when it finishes.
3328 @item -fmem-report
3329 @opindex fmem-report
3330 Makes the compiler print some statistics about permanent memory
3331 allocation when it finishes.
3333 @item -fprofile-arcs
3334 @opindex fprofile-arcs
3335 Add code so that program flow @dfn{arcs} are instrumented.  During
3336 execution the program records how many times each branch and call is
3337 executed and how many times it is taken or returns.  When the compiled
3338 program exits it saves this data to a file called
3339 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3340 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3341 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3342 @var{auxname} is generated from the name of the output file, if
3343 explicitly specified and it is not the final executable, otherwise it is
3344 the basename of the source file.  In both cases any suffix is removed
3345 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3346 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3348 @cindex @command{gcov}
3349 @item --coverage
3350 @opindex coverage
3352 This option is used to compile and link code instrumented for coverage
3353 analysis.  The option is a synonym for @option{-fprofile-arcs}
3354 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3355 linking).  See the documentation for those options for more details.
3357 @itemize
3359 @item
3360 Compile the source files with @option{-fprofile-arcs} plus optimization
3361 and code generation options.  For test coverage analysis, use the
3362 additional @option{-ftest-coverage} option.  You do not need to profile
3363 every source file in a program.
3365 @item
3366 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3367 (the latter implies the former).
3369 @item
3370 Run the program on a representative workload to generate the arc profile
3371 information.  This may be repeated any number of times.  You can run
3372 concurrent instances of your program, and provided that the file system
3373 supports locking, the data files will be correctly updated.  Also
3374 @code{fork} calls are detected and correctly handled (double counting
3375 will not happen).
3377 @item
3378 For profile-directed optimizations, compile the source files again with
3379 the same optimization and code generation options plus
3380 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3381 Control Optimization}).
3383 @item
3384 For test coverage analysis, use @command{gcov} to produce human readable
3385 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3386 @command{gcov} documentation for further information.
3388 @end itemize
3390 With @option{-fprofile-arcs}, for each function of your program GCC
3391 creates a program flow graph, then finds a spanning tree for the graph.
3392 Only arcs that are not on the spanning tree have to be instrumented: the
3393 compiler adds code to count the number of times that these arcs are
3394 executed.  When an arc is the only exit or only entrance to a block, the
3395 instrumentation code can be added to the block; otherwise, a new basic
3396 block must be created to hold the instrumentation code.
3398 @item -ftree-based-profiling
3399 @opindex ftree-based-profiling
3400 This option is used in addition to @option{-fprofile-arcs} or
3401 @option{-fbranch-probabilities} to control whether those optimizations
3402 are performed on a tree-based or rtl-based internal representation.
3403 If you use this option when compiling with @option{-fprofile-arcs},
3404 you must also use it when compiling later with @option{-fbranch-probabilities}.
3405 Currently the tree-based optimization is in an early stage of
3406 development, and this option is recommended only for those people
3407 working on improving it.
3409 @need 2000
3410 @item -ftest-coverage
3411 @opindex ftest-coverage
3412 Produce a notes file that the @command{gcov} code-coverage utility
3413 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3414 show program coverage.  Each source file's note file is called
3415 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3416 above for a description of @var{auxname} and instructions on how to
3417 generate test coverage data.  Coverage data will match the source files
3418 more closely, if you do not optimize.
3420 @item -d@var{letters}
3421 @item -fdump-rtl-@var{pass}
3422 @opindex d
3423 Says to make debugging dumps during compilation at times specified by
3424 @var{letters}.    This is used for debugging the RTL-based passes of the
3425 compiler.  The file names for most of the dumps are made by appending a
3426 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3427 from the name of the output file, if explicitly specified and it is not
3428 an executable, otherwise it is the basename of the source file.
3430 Most debug dumps can be enabled either passing a letter to the @option{-d}
3431 option, or with a long @option{-fdump-rtl} switch; here are the possible
3432 letters for use in @var{letters} and @var{pass}, and their meanings:
3434 @table @gcctabopt
3435 @item -dA
3436 @opindex dA
3437 Annotate the assembler output with miscellaneous debugging information.
3439 @item -db
3440 @itemx -fdump-rtl-bp
3441 @opindex db
3442 @opindex fdump-rtl-bp
3443 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3445 @item -dB
3446 @itemx -fdump-rtl-bbro
3447 @opindex dB
3448 @opindex fdump-rtl-bbro
3449 Dump after block reordering, to @file{@var{file}.30.bbro}.
3451 @item -dc
3452 @itemx -fdump-rtl-combine
3453 @opindex dc
3454 @opindex fdump-rtl-combine
3455 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3457 @item -dC
3458 @itemx -fdump-rtl-ce1
3459 @itemx -fdump-rtl-ce2
3460 @opindex dC
3461 @opindex fdump-rtl-ce1
3462 @opindex fdump-rtl-ce2
3463 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3464 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3465 and @option{-fdump-rtl-ce2} enable dumping after the second if
3466 conversion, to the file @file{@var{file}.18.ce2}.
3468 @item -dd
3469 @itemx -fdump-rtl-btl
3470 @itemx -fdump-rtl-dbr
3471 @opindex dd
3472 @opindex fdump-rtl-btl
3473 @opindex fdump-rtl-dbr
3474 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3475 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3476 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3477 scheduling, to @file{@var{file}.36.dbr}.
3479 @item -dD
3480 @opindex dD
3481 Dump all macro definitions, at the end of preprocessing, in addition to
3482 normal output.
3484 @item -dE
3485 @itemx -fdump-rtl-ce3
3486 @opindex dE
3487 @opindex fdump-rtl-ce3
3488 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3490 @item -df
3491 @itemx -fdump-rtl-cfg
3492 @itemx -fdump-rtl-life
3493 @opindex df
3494 @opindex fdump-rtl-cfg
3495 @opindex fdump-rtl-life
3496 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3497 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3498 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3499 to @file{@var{file}.16.life}.
3501 @item -dg
3502 @itemx -fdump-rtl-greg
3503 @opindex dg
3504 @opindex fdump-rtl-greg
3505 Dump after global register allocation, to @file{@var{file}.23.greg}.
3507 @item -dG
3508 @itemx -fdump-rtl-gcse
3509 @itemx -fdump-rtl-bypass
3510 @opindex dG
3511 @opindex fdump-rtl-gcse
3512 @opindex fdump-rtl-bypass
3513 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3514 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3515 enable dumping after jump bypassing and control flow optimizations, to
3516 @file{@var{file}.07.bypass}.
3518 @item -dh
3519 @itemx -fdump-rtl-eh
3520 @opindex dh
3521 @opindex fdump-rtl-eh
3522 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3524 @item -di
3525 @itemx -fdump-rtl-sibling
3526 @opindex di
3527 @opindex fdump-rtl-sibling
3528 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3530 @item -dj
3531 @itemx -fdump-rtl-jump
3532 @opindex dj
3533 @opindex fdump-rtl-jump
3534 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3536 @item -dk
3537 @itemx -fdump-rtl-stack
3538 @opindex dk
3539 @opindex fdump-rtl-stack
3540 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3542 @item -dl
3543 @itemx -fdump-rtl-lreg
3544 @opindex dl
3545 @opindex fdump-rtl-lreg
3546 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3548 @item -dL
3549 @itemx -fdump-rtl-loop
3550 @itemx -fdump-rtl-loop2
3551 @opindex dL
3552 @opindex fdump-rtl-loop
3553 @opindex fdump-rtl-loop2
3554 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3555 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3556 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3557 @file{@var{file}.13.loop2}.
3559 @item -dm
3560 @itemx -fdump-rtl-sms
3561 @opindex dm
3562 @opindex fdump-rtl-sms
3563 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3565 @item -dM
3566 @itemx -fdump-rtl-mach
3567 @opindex dM
3568 @opindex fdump-rtl-mach
3569 Dump after performing the machine dependent reorganization pass, to
3570 @file{@var{file}.35.mach}.
3572 @item -dn
3573 @itemx -fdump-rtl-rnreg
3574 @opindex dn
3575 @opindex fdump-rtl-rnreg
3576 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3578 @item -dN
3579 @itemx -fdump-rtl-regmove
3580 @opindex dN
3581 @opindex fdump-rtl-regmove
3582 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3584 @item -do
3585 @itemx -fdump-rtl-postreload
3586 @opindex do
3587 @opindex fdump-rtl-postreload
3588 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3590 @item -dr
3591 @itemx -fdump-rtl-expand
3592 @opindex dr
3593 @opindex fdump-rtl-expand
3594 Dump after RTL generation, to @file{@var{file}.00.expand}.
3596 @item -dR
3597 @itemx -fdump-rtl-sched2
3598 @opindex dR
3599 @opindex fdump-rtl-sched2
3600 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3602 @item -ds
3603 @itemx -fdump-rtl-cse
3604 @opindex ds
3605 @opindex fdump-rtl-cse
3606 Dump after CSE (including the jump optimization that sometimes follows
3607 CSE), to @file{@var{file}.04.cse}.
3609 @item -dS
3610 @itemx -fdump-rtl-sched
3611 @opindex dS
3612 @opindex fdump-rtl-sched
3613 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3615 @item -dt
3616 @itemx -fdump-rtl-cse2
3617 @opindex dt
3618 @opindex fdump-rtl-cse2
3619 Dump after the second CSE pass (including the jump optimization that
3620 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3622 @item -dT
3623 @itemx -fdump-rtl-tracer
3624 @opindex dT
3625 @opindex fdump-rtl-tracer
3626 Dump after running tracer, to @file{@var{file}.12.tracer}.
3628 @item -dV
3629 @itemx -fdump-rtl-vpt
3630 @itemx -fdump-rtl-vartrack
3631 @opindex dV
3632 @opindex fdump-rtl-vpt
3633 @opindex fdump-rtl-vartrack
3634 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3635 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3636 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3637 to @file{@var{file}.34.vartrack}.
3639 @item -dw
3640 @itemx -fdump-rtl-flow2
3641 @opindex dw
3642 @opindex fdump-rtl-flow2
3643 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3645 @item -dz
3646 @itemx -fdump-rtl-peephole2
3647 @opindex dz
3648 @opindex fdump-rtl-peephole2
3649 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3651 @item -dZ
3652 @itemx -fdump-rtl-web
3653 @opindex dZ
3654 @opindex fdump-rtl-web
3655 Dump after live range splitting, to @file{@var{file}.14.web}.
3657 @item -da
3658 @itemx -fdump-rtl-all
3659 @opindex da
3660 @opindex fdump-rtl-all
3661 Produce all the dumps listed above.
3663 @item -dH
3664 @opindex dH
3665 Produce a core dump whenever an error occurs.
3667 @item -dm
3668 @opindex dm
3669 Print statistics on memory usage, at the end of the run, to
3670 standard error.
3672 @item -dp
3673 @opindex dp
3674 Annotate the assembler output with a comment indicating which
3675 pattern and alternative was used.  The length of each instruction is
3676 also printed.
3678 @item -dP
3679 @opindex dP
3680 Dump the RTL in the assembler output as a comment before each instruction.
3681 Also turns on @option{-dp} annotation.
3683 @item -dv
3684 @opindex dv
3685 For each of the other indicated dump files (either with @option{-d} or
3686 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3687 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3689 @item -dx
3690 @opindex dx
3691 Just generate RTL for a function instead of compiling it.  Usually used
3692 with @samp{r} (@option{-fdump-rtl-expand}).
3694 @item -dy
3695 @opindex dy
3696 Dump debugging information during parsing, to standard error.
3697 @end table
3699 @item -fdump-unnumbered
3700 @opindex fdump-unnumbered
3701 When doing debugging dumps (see @option{-d} option above), suppress instruction
3702 numbers and line number note output.  This makes it more feasible to
3703 use diff on debugging dumps for compiler invocations with different
3704 options, in particular with and without @option{-g}.
3706 @item -fdump-translation-unit @r{(C and C++ only)}
3707 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3708 @opindex fdump-translation-unit
3709 Dump a representation of the tree structure for the entire translation
3710 unit to a file.  The file name is made by appending @file{.tu} to the
3711 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3712 controls the details of the dump as described for the
3713 @option{-fdump-tree} options.
3715 @item -fdump-class-hierarchy @r{(C++ only)}
3716 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3717 @opindex fdump-class-hierarchy
3718 Dump a representation of each class's hierarchy and virtual function
3719 table layout to a file.  The file name is made by appending @file{.class}
3720 to the source file name.  If the @samp{-@var{options}} form is used,
3721 @var{options} controls the details of the dump as described for the
3722 @option{-fdump-tree} options.
3724 @item -fdump-ipa-@var{switch}
3725 @opindex fdump-ipa
3726 Control the dumping at various stages of inter-procedural analysis
3727 language tree to a file.  The file name is generated by appending a switch
3728 specific suffix to the source file name.  The following dumps are possible:
3730 @table @samp
3731 @item all
3732 Enables all inter-procedural analysis dumps; currently the only produced
3733 dump is the @samp{cgraph} dump.
3735 @item cgraph
3736 Dumps information about call-graph optimization, unused function removal,
3737 and inlining decisions.
3738 @end table
3740 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3741 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3742 @opindex fdump-tree
3743 Control the dumping at various stages of processing the intermediate
3744 language tree to a file.  The file name is generated by appending a switch
3745 specific suffix to the source file name.  If the @samp{-@var{options}}
3746 form is used, @var{options} is a list of @samp{-} separated options that
3747 control the details of the dump.  Not all options are applicable to all
3748 dumps, those which are not meaningful will be ignored.  The following
3749 options are available
3751 @table @samp
3752 @item address
3753 Print the address of each node.  Usually this is not meaningful as it
3754 changes according to the environment and source file.  Its primary use
3755 is for tying up a dump file with a debug environment.
3756 @item slim
3757 Inhibit dumping of members of a scope or body of a function merely
3758 because that scope has been reached.  Only dump such items when they
3759 are directly reachable by some other path.  When dumping pretty-printed
3760 trees, this option inhibits dumping the bodies of control structures.
3761 @item raw
3762 Print a raw representation of the tree.  By default, trees are
3763 pretty-printed into a C-like representation.
3764 @item details
3765 Enable more detailed dumps (not honored by every dump option).
3766 @item stats
3767 Enable dumping various statistics about the pass (not honored by every dump
3768 option).
3769 @item blocks
3770 Enable showing basic block boundaries (disabled in raw dumps).
3771 @item vops
3772 Enable showing virtual operands for every statement.
3773 @item lineno
3774 Enable showing line numbers for statements.
3775 @item uid
3776 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3777 @item all
3778 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3779 @end table
3781 The following tree dumps are possible:
3782 @table @samp
3784 @item original
3785 Dump before any tree based optimization, to @file{@var{file}.original}.
3787 @item optimized
3788 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3790 @item inlined
3791 Dump after function inlining, to @file{@var{file}.inlined}.
3793 @item gimple
3794 @opindex fdump-tree-gimple
3795 Dump each function before and after the gimplification pass to a file.  The
3796 file name is made by appending @file{.gimple} to the source file name.
3798 @item cfg
3799 @opindex fdump-tree-cfg
3800 Dump the control flow graph of each function to a file.  The file name is
3801 made by appending @file{.cfg} to the source file name.
3803 @item vcg
3804 @opindex fdump-tree-vcg
3805 Dump the control flow graph of each function to a file in VCG format.  The
3806 file name is made by appending @file{.vcg} to the source file name.  Note
3807 that if the file contains more than one function, the generated file cannot
3808 be used directly by VCG@.  You will need to cut and paste each function's
3809 graph into its own separate file first.
3811 @item ch
3812 @opindex fdump-tree-ch
3813 Dump each function after copying loop headers.  The file name is made by
3814 appending @file{.ch} to the source file name.
3816 @item ssa
3817 @opindex fdump-tree-ssa
3818 Dump SSA related information to a file.  The file name is made by appending
3819 @file{.ssa} to the source file name.
3821 @item alias
3822 @opindex fdump-tree-alias
3823 Dump aliasing information for each function.  The file name is made by
3824 appending @file{.alias} to the source file name.
3826 @item ccp
3827 @opindex fdump-tree-ccp
3828 Dump each function after CCP@.  The file name is made by appending
3829 @file{.ccp} to the source file name.
3831 @item pre
3832 @opindex fdump-tree-pre
3833 Dump trees after partial redundancy elimination.  The file name is made
3834 by appending @file{.pre} to the source file name.
3836 @item fre
3837 @opindex fdump-tree-fre
3838 Dump trees after full redundancy elimination.  The file name is made
3839 by appending @file{.fre} to the source file name.
3841 @item dce
3842 @opindex fdump-tree-dce
3843 Dump each function after dead code elimination.  The file name is made by
3844 appending @file{.dce} to the source file name.
3846 @item mudflap
3847 @opindex fdump-tree-mudflap
3848 Dump each function after adding mudflap instrumentation.  The file name is
3849 made by appending @file{.mudflap} to the source file name.
3851 @item sra
3852 @opindex fdump-tree-sra
3853 Dump each function after performing scalar replacement of aggregates.  The
3854 file name is made by appending @file{.sra} to the source file name.
3856 @item sink
3857 @opindex fdump-tree-sink
3858 Dump each function after performing code sinking.  The file name is made
3859 by appending @file{.sink} to the source file name. 
3861 @item dom
3862 @opindex fdump-tree-dom
3863 Dump each function after applying dominator tree optimizations.  The file
3864 name is made by appending @file{.dom} to the source file name.
3866 @item dse
3867 @opindex fdump-tree-dse
3868 Dump each function after applying dead store elimination.  The file
3869 name is made by appending @file{.dse} to the source file name.
3871 @item phiopt
3872 @opindex fdump-tree-phiopt
3873 Dump each function after optimizing PHI nodes into straightline code.  The file
3874 name is made by appending @file{.phiopt} to the source file name.
3876 @item forwprop
3877 @opindex fdump-tree-forwprop
3878 Dump each function after forward propagating single use variables.  The file
3879 name is made by appending @file{.forwprop} to the source file name.
3881 @item copyrename
3882 @opindex fdump-tree-copyrename
3883 Dump each function after applying the copy rename optimization.  The file
3884 name is made by appending @file{.copyrename} to the source file name.
3886 @item nrv
3887 @opindex fdump-tree-nrv
3888 Dump each function after applying the named return value optimization on
3889 generic trees.  The file name is made by appending @file{.nrv} to the source
3890 file name.
3892 @item vect
3893 @opindex fdump-tree-vect
3894 Dump each function after applying vectorization of loops.  The file name is
3895 made by appending @file{.vect} to the source file name.
3897 @item all
3898 @opindex fdump-tree-all
3899 Enable all the available tree dumps with the flags provided in this option.
3900 @end table
3902 @item -ftree-vectorizer-verbose=@var{n}
3903 @opindex ftree-vectorizer-verbose
3904 This option controls the amount of debugging output the vectorizer prints.
3905 This information is written to standard error, unless @option{-fdump-tree-all}
3906 or @option{-fdump-tree-vect} is specified, in which case it is output to the
3907 usual dump listing file, @file{.vect}.
3909 @item -frandom-seed=@var{string}
3910 @opindex frandom-string
3911 This option provides a seed that GCC uses when it would otherwise use
3912 random numbers.  It is used to generate certain symbol names
3913 that have to be different in every compiled file.  It is also used to
3914 place unique stamps in coverage data files and the object files that
3915 produce them.  You can use the @option{-frandom-seed} option to produce
3916 reproducibly identical object files.
3918 The @var{string} should be different for every file you compile.
3920 @item -fsched-verbose=@var{n}
3921 @opindex fsched-verbose
3922 On targets that use instruction scheduling, this option controls the
3923 amount of debugging output the scheduler prints.  This information is
3924 written to standard error, unless @option{-dS} or @option{-dR} is
3925 specified, in which case it is output to the usual dump
3926 listing file, @file{.sched} or @file{.sched2} respectively.  However
3927 for @var{n} greater than nine, the output is always printed to standard
3928 error.
3930 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3931 same information as @option{-dRS}.  For @var{n} greater than one, it
3932 also output basic block probabilities, detailed ready list information
3933 and unit/insn info.  For @var{n} greater than two, it includes RTL
3934 at abort point, control-flow and regions info.  And for @var{n} over
3935 four, @option{-fsched-verbose} also includes dependence info.
3937 @item -save-temps
3938 @opindex save-temps
3939 Store the usual ``temporary'' intermediate files permanently; place them
3940 in the current directory and name them based on the source file.  Thus,
3941 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3942 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3943 preprocessed @file{foo.i} output file even though the compiler now
3944 normally uses an integrated preprocessor.
3946 When used in combination with the @option{-x} command line option,
3947 @option{-save-temps} is sensible enough to avoid over writing an
3948 input source file with the same extension as an intermediate file.
3949 The corresponding intermediate file may be obtained by renaming the
3950 source file before using @option{-save-temps}.
3952 @item -time
3953 @opindex time
3954 Report the CPU time taken by each subprocess in the compilation
3955 sequence.  For C source files, this is the compiler proper and assembler
3956 (plus the linker if linking is done).  The output looks like this:
3958 @smallexample
3959 # cc1 0.12 0.01
3960 # as 0.00 0.01
3961 @end smallexample
3963 The first number on each line is the ``user time'', that is time spent
3964 executing the program itself.  The second number is ``system time'',
3965 time spent executing operating system routines on behalf of the program.
3966 Both numbers are in seconds.
3968 @item -fvar-tracking
3969 @opindex fvar-tracking
3970 Run variable tracking pass.  It computes where variables are stored at each
3971 position in code.  Better debugging information is then generated
3972 (if the debugging information format supports this information).
3974 It is enabled by default when compiling with optimization (@option{-Os},
3975 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3976 the debug info format supports it.
3978 @item -print-file-name=@var{library}
3979 @opindex print-file-name
3980 Print the full absolute name of the library file @var{library} that
3981 would be used when linking---and don't do anything else.  With this
3982 option, GCC does not compile or link anything; it just prints the
3983 file name.
3985 @item -print-multi-directory
3986 @opindex print-multi-directory
3987 Print the directory name corresponding to the multilib selected by any
3988 other switches present in the command line.  This directory is supposed
3989 to exist in @env{GCC_EXEC_PREFIX}.
3991 @item -print-multi-lib
3992 @opindex print-multi-lib
3993 Print the mapping from multilib directory names to compiler switches
3994 that enable them.  The directory name is separated from the switches by
3995 @samp{;}, and each switch starts with an @samp{@@} instead of the
3996 @samp{-}, without spaces between multiple switches.  This is supposed to
3997 ease shell-processing.
3999 @item -print-prog-name=@var{program}
4000 @opindex print-prog-name
4001 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4003 @item -print-libgcc-file-name
4004 @opindex print-libgcc-file-name
4005 Same as @option{-print-file-name=libgcc.a}.
4007 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4008 but you do want to link with @file{libgcc.a}.  You can do
4010 @smallexample
4011 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4012 @end smallexample
4014 @item -print-search-dirs
4015 @opindex print-search-dirs
4016 Print the name of the configured installation directory and a list of
4017 program and library directories @command{gcc} will search---and don't do anything else.
4019 This is useful when @command{gcc} prints the error message
4020 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4021 To resolve this you either need to put @file{cpp0} and the other compiler
4022 components where @command{gcc} expects to find them, or you can set the environment
4023 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4024 Don't forget the trailing @samp{/}.
4025 @xref{Environment Variables}.
4027 @item -dumpmachine
4028 @opindex dumpmachine
4029 Print the compiler's target machine (for example,
4030 @samp{i686-pc-linux-gnu})---and don't do anything else.
4032 @item -dumpversion
4033 @opindex dumpversion
4034 Print the compiler version (for example, @samp{3.0})---and don't do
4035 anything else.
4037 @item -dumpspecs
4038 @opindex dumpspecs
4039 Print the compiler's built-in specs---and don't do anything else.  (This
4040 is used when GCC itself is being built.)  @xref{Spec Files}.
4042 @item -feliminate-unused-debug-types
4043 @opindex feliminate-unused-debug-types
4044 Normally, when producing DWARF2 output, GCC will emit debugging
4045 information for all types declared in a compilation
4046 unit, regardless of whether or not they are actually used
4047 in that compilation unit.  Sometimes this is useful, such as
4048 if, in the debugger, you want to cast a value to a type that is
4049 not actually used in your program (but is declared).  More often,
4050 however, this results in a significant amount of wasted space.
4051 With this option, GCC will avoid producing debug symbol output
4052 for types that are nowhere used in the source file being compiled.
4053 @end table
4055 @node Optimize Options
4056 @section Options That Control Optimization
4057 @cindex optimize options
4058 @cindex options, optimization
4060 These options control various sorts of optimizations.
4062 Without any optimization option, the compiler's goal is to reduce the
4063 cost of compilation and to make debugging produce the expected
4064 results.  Statements are independent: if you stop the program with a
4065 breakpoint between statements, you can then assign a new value to any
4066 variable or change the program counter to any other statement in the
4067 function and get exactly the results you would expect from the source
4068 code.
4070 Turning on optimization flags makes the compiler attempt to improve
4071 the performance and/or code size at the expense of compilation time
4072 and possibly the ability to debug the program.
4074 The compiler performs optimization based on the knowledge it has of
4075 the program.  Optimization levels @option{-O2} and above, in
4076 particular, enable @emph{unit-at-a-time} mode, which allows the
4077 compiler to consider information gained from later functions in
4078 the file when compiling a function.  Compiling multiple files at
4079 once to a single output file in @emph{unit-at-a-time} mode allows
4080 the compiler to use information gained from all of the files when
4081 compiling each of them.
4083 Not all optimizations are controlled directly by a flag.  Only
4084 optimizations that have a flag are listed.
4086 @table @gcctabopt
4087 @item -O
4088 @itemx -O1
4089 @opindex O
4090 @opindex O1
4091 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4092 more memory for a large function.
4094 With @option{-O}, the compiler tries to reduce code size and execution
4095 time, without performing any optimizations that take a great deal of
4096 compilation time.
4098 @option{-O} turns on the following optimization flags:
4099 @gccoptlist{-fdefer-pop @gol
4100 -fdelayed-branch @gol
4101 -fguess-branch-probability @gol
4102 -fcprop-registers @gol
4103 -floop-optimize @gol
4104 -fif-conversion @gol
4105 -fif-conversion2 @gol
4106 -ftree-ccp @gol
4107 -ftree-dce @gol
4108 -ftree-dom @gol
4109 -ftree-dse @gol
4110 -ftree-ter @gol
4111 -ftree-live_range_split @gol
4112 -ftree-sra @gol
4113 -ftree-copyrename @gol
4114 -ftree-fre @gol
4115 -ftree-ch @gol
4116 -fmerge-constants}
4118 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4119 where doing so does not interfere with debugging.
4121 @item -O2
4122 @opindex O2
4123 Optimize even more.  GCC performs nearly all supported optimizations
4124 that do not involve a space-speed tradeoff.  The compiler does not
4125 perform loop unrolling or function inlining when you specify @option{-O2}.
4126 As compared to @option{-O}, this option increases both compilation time
4127 and the performance of the generated code.
4129 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4130 also turns on the following optimization flags:
4131 @gccoptlist{-fthread-jumps @gol
4132 -fcrossjumping @gol
4133 -foptimize-sibling-calls @gol
4134 -fcse-follow-jumps  -fcse-skip-blocks @gol
4135 -fgcse  -fgcse-lm  @gol
4136 -fexpensive-optimizations @gol
4137 -fstrength-reduce @gol
4138 -frerun-cse-after-loop  -frerun-loop-opt @gol
4139 -fcaller-saves @gol
4140 -fforce-mem @gol
4141 -fpeephole2 @gol
4142 -fschedule-insns  -fschedule-insns2 @gol
4143 -fsched-interblock  -fsched-spec @gol
4144 -fregmove @gol
4145 -fstrict-aliasing @gol
4146 -fdelete-null-pointer-checks @gol
4147 -freorder-blocks  -freorder-functions @gol
4148 -funit-at-a-time @gol
4149 -falign-functions  -falign-jumps @gol
4150 -falign-loops  -falign-labels @gol
4151 -ftree-pre}
4153 Please note the warning under @option{-fgcse} about
4154 invoking @option{-O2} on programs that use computed gotos.
4156 @item -O3
4157 @opindex O3
4158 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4159 @option{-O2} and also turns on the @option{-finline-functions},
4160 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4162 @item -O0
4163 @opindex O0
4164 Do not optimize.  This is the default.
4166 @item -Os
4167 @opindex Os
4168 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4169 do not typically increase code size.  It also performs further
4170 optimizations designed to reduce code size.
4172 @option{-Os} disables the following optimization flags:
4173 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4174 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4176 If you use multiple @option{-O} options, with or without level numbers,
4177 the last such option is the one that is effective.
4178 @end table
4180 Options of the form @option{-f@var{flag}} specify machine-independent
4181 flags.  Most flags have both positive and negative forms; the negative
4182 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4183 below, only one of the forms is listed---the one you typically will
4184 use.  You can figure out the other form by either removing @samp{no-}
4185 or adding it.
4187 The following options control specific optimizations.  They are either
4188 activated by @option{-O} options or are related to ones that are.  You
4189 can use the following flags in the rare cases when ``fine-tuning'' of
4190 optimizations to be performed is desired.
4192 @table @gcctabopt
4193 @item -fno-default-inline
4194 @opindex fno-default-inline
4195 Do not make member functions inline by default merely because they are
4196 defined inside the class scope (C++ only).  Otherwise, when you specify
4197 @w{@option{-O}}, member functions defined inside class scope are compiled
4198 inline by default; i.e., you don't need to add @samp{inline} in front of
4199 the member function name.
4201 @item -fno-defer-pop
4202 @opindex fno-defer-pop
4203 Always pop the arguments to each function call as soon as that function
4204 returns.  For machines which must pop arguments after a function call,
4205 the compiler normally lets arguments accumulate on the stack for several
4206 function calls and pops them all at once.
4208 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4210 @item -fforce-mem
4211 @opindex fforce-mem
4212 Force memory operands to be copied into registers before doing
4213 arithmetic on them.  This produces better code by making all memory
4214 references potential common subexpressions.  When they are not common
4215 subexpressions, instruction combination should eliminate the separate
4216 register-load.
4218 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4220 @item -fforce-addr
4221 @opindex fforce-addr
4222 Force memory address constants to be copied into registers before
4223 doing arithmetic on them.  This may produce better code just as
4224 @option{-fforce-mem} may.
4226 @item -fomit-frame-pointer
4227 @opindex fomit-frame-pointer
4228 Don't keep the frame pointer in a register for functions that
4229 don't need one.  This avoids the instructions to save, set up and
4230 restore frame pointers; it also makes an extra register available
4231 in many functions.  @strong{It also makes debugging impossible on
4232 some machines.}
4234 On some machines, such as the VAX, this flag has no effect, because
4235 the standard calling sequence automatically handles the frame pointer
4236 and nothing is saved by pretending it doesn't exist.  The
4237 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4238 whether a target machine supports this flag.  @xref{Registers,,Register
4239 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4241 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4243 @item -foptimize-sibling-calls
4244 @opindex foptimize-sibling-calls
4245 Optimize sibling and tail recursive calls.
4247 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4249 @item -fno-inline
4250 @opindex fno-inline
4251 Don't pay attention to the @code{inline} keyword.  Normally this option
4252 is used to keep the compiler from expanding any functions inline.
4253 Note that if you are not optimizing, no functions can be expanded inline.
4255 @item -finline-functions
4256 @opindex finline-functions
4257 Integrate all simple functions into their callers.  The compiler
4258 heuristically decides which functions are simple enough to be worth
4259 integrating in this way.
4261 If all calls to a given function are integrated, and the function is
4262 declared @code{static}, then the function is normally not output as
4263 assembler code in its own right.
4265 Enabled at level @option{-O3}.
4267 @item -finline-limit=@var{n}
4268 @opindex finline-limit
4269 By default, GCC limits the size of functions that can be inlined.  This flag
4270 allows the control of this limit for functions that are explicitly marked as
4271 inline (i.e., marked with the inline keyword or defined within the class
4272 definition in c++).  @var{n} is the size of functions that can be inlined in
4273 number of pseudo instructions (not counting parameter handling).  The default
4274 value of @var{n} is 600.
4275 Increasing this value can result in more inlined code at
4276 the cost of compilation time and memory consumption.  Decreasing usually makes
4277 the compilation faster and less code will be inlined (which presumably
4278 means slower programs).  This option is particularly useful for programs that
4279 use inlining heavily such as those based on recursive templates with C++.
4281 Inlining is actually controlled by a number of parameters, which may be
4282 specified individually by using @option{--param @var{name}=@var{value}}.
4283 The @option{-finline-limit=@var{n}} option sets some of these parameters
4284 as follows:
4286 @table @gcctabopt
4287  @item max-inline-insns-single
4288   is set to @var{n}/2.
4289  @item max-inline-insns-auto
4290   is set to @var{n}/2.
4291  @item min-inline-insns
4292   is set to 130 or @var{n}/4, whichever is smaller.
4293  @item max-inline-insns-rtl
4294   is set to @var{n}.
4295 @end table
4297 See below for a documentation of the individual
4298 parameters controlling inlining.
4300 @emph{Note:} pseudo instruction represents, in this particular context, an
4301 abstract measurement of function's size.  In no way, it represents a count
4302 of assembly instructions and as such its exact meaning might change from one
4303 release to an another.
4305 @item -fkeep-inline-functions
4306 @opindex fkeep-inline-functions
4307 In C, emit @code{static} functions that are declared @code{inline}
4308 into the object file, even if the function has been inlined into all
4309 of its callers.  This switch does not affect functions using the
4310 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4311 inline functions into the object file.
4313 @item -fkeep-static-consts
4314 @opindex fkeep-static-consts
4315 Emit variables declared @code{static const} when optimization isn't turned
4316 on, even if the variables aren't referenced.
4318 GCC enables this option by default.  If you want to force the compiler to
4319 check if the variable was referenced, regardless of whether or not
4320 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4322 @item -fmerge-constants
4323 Attempt to merge identical constants (string constants and floating point
4324 constants) across compilation units.
4326 This option is the default for optimized compilation if the assembler and
4327 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4328 behavior.
4330 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4332 @item -fmerge-all-constants
4333 Attempt to merge identical constants and identical variables.
4335 This option implies @option{-fmerge-constants}.  In addition to
4336 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4337 arrays or initialized constant variables with integral or floating point
4338 types.  Languages like C or C++ require each non-automatic variable to
4339 have distinct location, so using this option will result in non-conforming
4340 behavior.
4342 @item -fmodulo-sched
4343 @opindex fmodulo-sched
4344 Perform swing modulo scheduling immediately before the first scheduling
4345 pass.  This pass looks at innermost loops and reorders their
4346 instructions by overlapping different iterations.
4348 @item -fno-branch-count-reg
4349 @opindex fno-branch-count-reg
4350 Do not use ``decrement and branch'' instructions on a count register,
4351 but instead generate a sequence of instructions that decrement a
4352 register, compare it against zero, then branch based upon the result.
4353 This option is only meaningful on architectures that support such
4354 instructions, which include x86, PowerPC, IA-64 and S/390.
4356 The default is @option{-fbranch-count-reg}, enabled when
4357 @option{-fstrength-reduce} is enabled.
4359 @item -fno-function-cse
4360 @opindex fno-function-cse
4361 Do not put function addresses in registers; make each instruction that
4362 calls a constant function contain the function's address explicitly.
4364 This option results in less efficient code, but some strange hacks
4365 that alter the assembler output may be confused by the optimizations
4366 performed when this option is not used.
4368 The default is @option{-ffunction-cse}
4370 @item -fno-zero-initialized-in-bss
4371 @opindex fno-zero-initialized-in-bss
4372 If the target supports a BSS section, GCC by default puts variables that
4373 are initialized to zero into BSS@.  This can save space in the resulting
4374 code.
4376 This option turns off this behavior because some programs explicitly
4377 rely on variables going to the data section.  E.g., so that the
4378 resulting executable can find the beginning of that section and/or make
4379 assumptions based on that.
4381 The default is @option{-fzero-initialized-in-bss}.
4383 @item -fbounds-check
4384 @opindex fbounds-check
4385 For front-ends that support it, generate additional code to check that
4386 indices used to access arrays are within the declared range.  This is
4387 currently only supported by the Java and Fortran front-ends, where
4388 this option defaults to true and false respectively.
4390 @item -fmudflap -fmudflapth -fmudflapir
4391 @opindex fmudflap
4392 @opindex fmudflapth
4393 @opindex fmudflapir
4394 @cindex bounds checking
4395 @cindex mudflap
4396 For front-ends that support it (C and C++), instrument all risky
4397 pointer/array dereferencing operations, some standard library
4398 string/heap functions, and some other associated constructs with
4399 range/validity tests.  Modules so instrumented should be immune to
4400 buffer overflows, invalid heap use, and some other classes of C/C++
4401 programming errors.  The instrumentation relies on a separate runtime
4402 library (@file{libmudflap}), which will be linked into a program if
4403 @option{-fmudflap} is given at link time.  Run-time behavior of the
4404 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4405 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4406 for its options.
4408 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4409 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4410 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4411 instrumentation should ignore pointer reads.  This produces less
4412 instrumentation (and therefore faster execution) and still provides
4413 some protection against outright memory corrupting writes, but allows
4414 erroneously read data to propagate within a program.
4416 @item -fstrength-reduce
4417 @opindex fstrength-reduce
4418 Perform the optimizations of loop strength reduction and
4419 elimination of iteration variables.
4421 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4423 @item -fthread-jumps
4424 @opindex fthread-jumps
4425 Perform optimizations where we check to see if a jump branches to a
4426 location where another comparison subsumed by the first is found.  If
4427 so, the first branch is redirected to either the destination of the
4428 second branch or a point immediately following it, depending on whether
4429 the condition is known to be true or false.
4431 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4433 @item -fcse-follow-jumps
4434 @opindex fcse-follow-jumps
4435 In common subexpression elimination, scan through jump instructions
4436 when the target of the jump is not reached by any other path.  For
4437 example, when CSE encounters an @code{if} statement with an
4438 @code{else} clause, CSE will follow the jump when the condition
4439 tested is false.
4441 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4443 @item -fcse-skip-blocks
4444 @opindex fcse-skip-blocks
4445 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4446 follow jumps which conditionally skip over blocks.  When CSE
4447 encounters a simple @code{if} statement with no else clause,
4448 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4449 body of the @code{if}.
4451 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4453 @item -frerun-cse-after-loop
4454 @opindex frerun-cse-after-loop
4455 Re-run common subexpression elimination after loop optimizations has been
4456 performed.
4458 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4460 @item -frerun-loop-opt
4461 @opindex frerun-loop-opt
4462 Run the loop optimizer twice.
4464 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4466 @item -fgcse
4467 @opindex fgcse
4468 Perform a global common subexpression elimination pass.
4469 This pass also performs global constant and copy propagation.
4471 @emph{Note:} When compiling a program using computed gotos, a GCC
4472 extension, you may get better runtime performance if you disable
4473 the global common subexpression elimination pass by adding
4474 @option{-fno-gcse} to the command line.
4476 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4478 @item -fgcse-lm
4479 @opindex fgcse-lm
4480 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4481 attempt to move loads which are only killed by stores into themselves.  This
4482 allows a loop containing a load/store sequence to be changed to a load outside
4483 the loop, and a copy/store within the loop.
4485 Enabled by default when gcse is enabled.
4487 @item -fgcse-sm
4488 @opindex fgcse-sm
4489 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4490 global common subexpression elimination.  This pass will attempt to move
4491 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4492 loops containing a load/store sequence can be changed to a load before
4493 the loop and a store after the loop.
4495 Not enabled at any optimization level.
4497 @item -fgcse-las
4498 @opindex fgcse-las
4499 When @option{-fgcse-las} is enabled, the global common subexpression
4500 elimination pass eliminates redundant loads that come after stores to the
4501 same memory location (both partial and full redundancies).
4503 Not enabled at any optimization level.
4505 @item -fgcse-after-reload
4506 @opindex fgcse-after-reload
4507 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4508 pass is performed after reload.  The purpose of this pass is to cleanup
4509 redundant spilling.
4511 @item -floop-optimize
4512 @opindex floop-optimize
4513 Perform loop optimizations: move constant expressions out of loops, simplify
4514 exit test conditions and optionally do strength-reduction as well.
4516 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4518 @item -floop-optimize2
4519 @opindex floop-optimize2
4520 Perform loop optimizations using the new loop optimizer.  The optimizations
4521 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4522 by separate flags.
4524 @item -fcrossjumping
4525 @opindex crossjumping
4526 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4527 resulting code may or may not perform better than without cross-jumping.
4529 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4531 @item -fif-conversion
4532 @opindex if-conversion
4533 Attempt to transform conditional jumps into branch-less equivalents.  This
4534 include use of conditional moves, min, max, set flags and abs instructions, and
4535 some tricks doable by standard arithmetics.  The use of conditional execution
4536 on chips where it is available is controlled by @code{if-conversion2}.
4538 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4540 @item -fif-conversion2
4541 @opindex if-conversion2
4542 Use conditional execution (where available) to transform conditional jumps into
4543 branch-less equivalents.
4545 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4547 @item -fdelete-null-pointer-checks
4548 @opindex fdelete-null-pointer-checks
4549 Use global dataflow analysis to identify and eliminate useless checks
4550 for null pointers.  The compiler assumes that dereferencing a null
4551 pointer would have halted the program.  If a pointer is checked after
4552 it has already been dereferenced, it cannot be null.
4554 In some environments, this assumption is not true, and programs can
4555 safely dereference null pointers.  Use
4556 @option{-fno-delete-null-pointer-checks} to disable this optimization
4557 for programs which depend on that behavior.
4559 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4561 @item -fexpensive-optimizations
4562 @opindex fexpensive-optimizations
4563 Perform a number of minor optimizations that are relatively expensive.
4565 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4567 @item -foptimize-register-move
4568 @itemx -fregmove
4569 @opindex foptimize-register-move
4570 @opindex fregmove
4571 Attempt to reassign register numbers in move instructions and as
4572 operands of other simple instructions in order to maximize the amount of
4573 register tying.  This is especially helpful on machines with two-operand
4574 instructions.
4576 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4577 optimization.
4579 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4581 @item -fdelayed-branch
4582 @opindex fdelayed-branch
4583 If supported for the target machine, attempt to reorder instructions
4584 to exploit instruction slots available after delayed branch
4585 instructions.
4587 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4589 @item -fschedule-insns
4590 @opindex fschedule-insns
4591 If supported for the target machine, attempt to reorder instructions to
4592 eliminate execution stalls due to required data being unavailable.  This
4593 helps machines that have slow floating point or memory load instructions
4594 by allowing other instructions to be issued until the result of the load
4595 or floating point instruction is required.
4597 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4599 @item -fschedule-insns2
4600 @opindex fschedule-insns2
4601 Similar to @option{-fschedule-insns}, but requests an additional pass of
4602 instruction scheduling after register allocation has been done.  This is
4603 especially useful on machines with a relatively small number of
4604 registers and where memory load instructions take more than one cycle.
4606 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4608 @item -fno-sched-interblock
4609 @opindex fno-sched-interblock
4610 Don't schedule instructions across basic blocks.  This is normally
4611 enabled by default when scheduling before register allocation, i.e.@:
4612 with @option{-fschedule-insns} or at @option{-O2} or higher.
4614 @item -fno-sched-spec
4615 @opindex fno-sched-spec
4616 Don't allow speculative motion of non-load instructions.  This is normally
4617 enabled by default when scheduling before register allocation, i.e.@:
4618 with @option{-fschedule-insns} or at @option{-O2} or higher.
4620 @item -fsched-spec-load
4621 @opindex fsched-spec-load
4622 Allow speculative motion of some load instructions.  This only makes
4623 sense when scheduling before register allocation, i.e.@: with
4624 @option{-fschedule-insns} or at @option{-O2} or higher.
4626 @item -fsched-spec-load-dangerous
4627 @opindex fsched-spec-load-dangerous
4628 Allow speculative motion of more load instructions.  This only makes
4629 sense when scheduling before register allocation, i.e.@: with
4630 @option{-fschedule-insns} or at @option{-O2} or higher.
4632 @item -fsched-stalled-insns=@var{n}
4633 @opindex fsched-stalled-insns
4634 Define how many insns (if any) can be moved prematurely from the queue
4635 of stalled insns into the ready list, during the second scheduling pass.
4637 @item -fsched-stalled-insns-dep=@var{n}
4638 @opindex fsched-stalled-insns-dep
4639 Define how many insn groups (cycles) will be examined for a dependency
4640 on a stalled insn that is candidate for premature removal from the queue
4641 of stalled insns.  Has an effect only during the second scheduling pass,
4642 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4644 @item -fsched2-use-superblocks
4645 @opindex fsched2-use-superblocks
4646 When scheduling after register allocation, do use superblock scheduling
4647 algorithm.  Superblock scheduling allows motion across basic block boundaries
4648 resulting on faster schedules.  This option is experimental, as not all machine
4649 descriptions used by GCC model the CPU closely enough to avoid unreliable
4650 results from the algorithm.
4652 This only makes sense when scheduling after register allocation, i.e.@: with
4653 @option{-fschedule-insns2} or at @option{-O2} or higher.
4655 @item -fsched2-use-traces
4656 @opindex fsched2-use-traces
4657 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4658 allocation and additionally perform code duplication in order to increase the
4659 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4660 trace formation.
4662 This mode should produce faster but significantly longer programs.  Also
4663 without @option{-fbranch-probabilities} the traces constructed may not
4664 match the reality and hurt the performance.  This only makes
4665 sense when scheduling after register allocation, i.e.@: with
4666 @option{-fschedule-insns2} or at @option{-O2} or higher.
4668 @item -freschedule-modulo-scheduled-loops
4669 @opindex fscheduling-in-modulo-scheduled-loops
4670 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4671 we may want to prevent the later scheduling passes from changing its schedule, we use this
4672 option to control that.
4674 @item -fcaller-saves
4675 @opindex fcaller-saves
4676 Enable values to be allocated in registers that will be clobbered by
4677 function calls, by emitting extra instructions to save and restore the
4678 registers around such calls.  Such allocation is done only when it
4679 seems to result in better code than would otherwise be produced.
4681 This option is always enabled by default on certain machines, usually
4682 those which have no call-preserved registers to use instead.
4684 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4686 @item -ftree-pre
4687 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4688 enabled by default at @option{-O2} and @option{-O3}.
4690 @item -ftree-fre
4691 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4692 between FRE and PRE is that FRE only considers expressions
4693 that are computed on all paths leading to the redundant computation.
4694 This analysis faster than PRE, though it exposes fewer redundancies.
4695 This flag is enabled by default at @option{-O} and higher.
4697 @item -ftree-sink
4698 Perform forward store motion  on trees.  This flag is
4699 enabled by default at @option{-O} and higher.
4701 @item -ftree-ccp
4702 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4703 is enabled by default at @option{-O} and higher.
4705 @item -ftree-dce
4706 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4707 default at @option{-O} and higher.
4709 @item -ftree-dominator-opts
4710 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4711 default at @option{-O} and higher.
4713 @item -ftree-ch
4714 Perform loop header copying on trees.  This is beneficial since it increases
4715 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4716 is enabled by default at @option{-O} and higher.  It is not enabled
4717 for @option{-Os}, since it usually increases code size.
4719 @item -ftree-loop-optimize
4720 Perform loop optimizations on trees.  This flag is enabled by default
4721 at @option{-O} and higher.
4723 @item -ftree-loop-linear
4724 Perform linear loop transformations on tree.  This flag can improve cache
4725 performance and allow further loop optimizations to take place.
4727 @item -ftree-lim
4728 Perform loop invariant motion on trees.  This pass moves only invartiants that
4729 would be hard to handle on rtl level (function calls, operations that expand to
4730 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4731 operands of conditions that are invariant out of the loop, so that we can use
4732 just trivial invariantness analysis in loop unswitching.  The pass also includes
4733 store motion.
4735 @item -fivcanon
4736 Create a canonical counter for number of iterations in the loop for that
4737 determining number of iterations requires complicated analysis.  Later
4738 optimizations then may determine the number easily.  Useful especially
4739 in connection with unrolling.
4741 @item -fivopts
4742 Perform induction variable optimizations (strength reduction, induction
4743 variable merging and induction variable elimination) on trees.
4745 @item -ftree-sra
4746 Perform scalar replacement of aggregates.  This pass replaces structure
4747 references with scalars to prevent committing structures to memory too
4748 early.  This flag is enabled by default at @option{-O} and higher.
4750 @item -ftree-copyrename
4751 Perform copy renaming on trees.  This pass attempts to rename compiler
4752 temporaries to other variables at copy locations, usually resulting in
4753 variable names which more closely resemble the original variables.  This flag
4754 is enabled by default at @option{-O} and higher.
4756 @item -ftree-ter
4757 Perform temporary expression replacement during the SSA->normal phase.  Single
4758 use/single def temporaries are replaced at their use location with their
4759 defining expression.  This results in non-GIMPLE code, but gives the expanders
4760 much more complex trees to work on resulting in better RTL generation.  This is
4761 enabled by default at @option{-O} and higher.
4763 @item -ftree-lrs
4764 Perform live range splitting during the SSA->normal phase.  Distinct live
4765 ranges of a variable are split into unique variables, allowing for better
4766 optimization later.  This is enabled by default at @option{-O} and higher.
4768 @item -ftree-vectorize
4769 Perform loop vectorization on trees.
4771 @item -ftracer
4772 @opindex ftracer
4773 Perform tail duplication to enlarge superblock size.  This transformation
4774 simplifies the control flow of the function allowing other optimizations to do
4775 better job.
4777 @item -funroll-loops
4778 @opindex funroll-loops
4779 Unroll loops whose number of iterations can be determined at compile
4780 time or upon entry to the loop.  @option{-funroll-loops} implies both
4781 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4782 option makes code larger, and may or may not make it run faster.
4784 @item -funroll-all-loops
4785 @opindex funroll-all-loops
4786 Unroll all loops, even if their number of iterations is uncertain when
4787 the loop is entered.  This usually makes programs run more slowly.
4788 @option{-funroll-all-loops} implies the same options as
4789 @option{-funroll-loops},
4791 @item -fsplit-ivs-in-unroller
4792 @opindex -fsplit-ivs-in-unroller
4793 Enables expressing of values of induction variables in later iterations
4794 of the unrolled loop using the value in the first iteration.  This breaks
4795 long dependency chains, thus improving efficiency of the scheduling passes
4796 (for best results, @option{-fweb} should be used as well).
4798 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4799 same effect.  However in cases the loop body is more complicated than
4800 a single basic block, this is not reliable.  It also does not work at all
4801 on some of the architectures due to restrictions in the CSE pass.
4803 This optimization is enabled by default.
4805 @item -fvariable-expansion-in-unroller
4806 @opindex -fvariable-expansion-in-unroller
4807 With this option, the compiler will create multiple copies of some
4808 local variables when unrolling a loop which can result in superior code.
4810 @item -fprefetch-loop-arrays
4811 @opindex fprefetch-loop-arrays
4812 If supported by the target machine, generate instructions to prefetch
4813 memory to improve the performance of loops that access large arrays.
4815 These options may generate better or worse code; results are highly
4816 dependent on the structure of loops within the source code.
4818 @item -fno-peephole
4819 @itemx -fno-peephole2
4820 @opindex fno-peephole
4821 @opindex fno-peephole2
4822 Disable any machine-specific peephole optimizations.  The difference
4823 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4824 are implemented in the compiler; some targets use one, some use the
4825 other, a few use both.
4827 @option{-fpeephole} is enabled by default.
4828 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4830 @item -fno-guess-branch-probability
4831 @opindex fno-guess-branch-probability
4832 Do not guess branch probabilities using heuristics.
4834 GCC will use heuristics to guess branch probabilities if they are
4835 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4836 heuristics are based on the control flow graph.  If some branch probabilities
4837 are specified by @samp{__builtin_expect}, then the heuristics will be
4838 used to guess branch probabilities for the rest of the control flow graph,
4839 taking the @samp{__builtin_expect} info into account.  The interactions
4840 between the heuristics and @samp{__builtin_expect} can be complex, and in
4841 some cases, it may be useful to disable the heuristics so that the effects
4842 of @samp{__builtin_expect} are easier to understand.
4844 The default is @option{-fguess-branch-probability} at levels
4845 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4847 @item -freorder-blocks
4848 @opindex freorder-blocks
4849 Reorder basic blocks in the compiled function in order to reduce number of
4850 taken branches and improve code locality.
4852 Enabled at levels @option{-O2}, @option{-O3}.
4854 @item -freorder-blocks-and-partition
4855 @opindex freorder-blocks-and-partition
4856 In addition to reordering basic blocks in the compiled function, in order
4857 to reduce number of taken branches, partitions hot and cold basic blocks
4858 into separate sections of the assembly and .o files, to improve
4859 paging and cache locality performance.
4861 This optimization is automatically turned off in the presence of
4862 exception handling, for linkonce sections, for functions with a user-defined
4863 section attribute and on any architecture that does not support named
4864 sections.
4866 @item -freorder-functions
4867 @opindex freorder-functions
4868 Reorder functions in the object file in order to
4869 improve code locality.  This is implemented by using special
4870 subsections @code{.text.hot} for most frequently executed functions and
4871 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4872 the linker so object file format must support named sections and linker must
4873 place them in a reasonable way.
4875 Also profile feedback must be available in to make this option effective.  See
4876 @option{-fprofile-arcs} for details.
4878 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4880 @item -fstrict-aliasing
4881 @opindex fstrict-aliasing
4882 Allows the compiler to assume the strictest aliasing rules applicable to
4883 the language being compiled.  For C (and C++), this activates
4884 optimizations based on the type of expressions.  In particular, an
4885 object of one type is assumed never to reside at the same address as an
4886 object of a different type, unless the types are almost the same.  For
4887 example, an @code{unsigned int} can alias an @code{int}, but not a
4888 @code{void*} or a @code{double}.  A character type may alias any other
4889 type.
4891 Pay special attention to code like this:
4892 @smallexample
4893 union a_union @{
4894   int i;
4895   double d;
4898 int f() @{
4899   a_union t;
4900   t.d = 3.0;
4901   return t.i;
4903 @end smallexample
4904 The practice of reading from a different union member than the one most
4905 recently written to (called ``type-punning'') is common.  Even with
4906 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4907 is accessed through the union type.  So, the code above will work as
4908 expected.  However, this code might not:
4909 @smallexample
4910 int f() @{
4911   a_union t;
4912   int* ip;
4913   t.d = 3.0;
4914   ip = &t.i;
4915   return *ip;
4917 @end smallexample
4919 Every language that wishes to perform language-specific alias analysis
4920 should define a function that computes, given an @code{tree}
4921 node, an alias set for the node.  Nodes in different alias sets are not
4922 allowed to alias.  For an example, see the C front-end function
4923 @code{c_get_alias_set}.
4925 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4927 @item -falign-functions
4928 @itemx -falign-functions=@var{n}
4929 @opindex falign-functions
4930 Align the start of functions to the next power-of-two greater than
4931 @var{n}, skipping up to @var{n} bytes.  For instance,
4932 @option{-falign-functions=32} aligns functions to the next 32-byte
4933 boundary, but @option{-falign-functions=24} would align to the next
4934 32-byte boundary only if this can be done by skipping 23 bytes or less.
4936 @option{-fno-align-functions} and @option{-falign-functions=1} are
4937 equivalent and mean that functions will not be aligned.
4939 Some assemblers only support this flag when @var{n} is a power of two;
4940 in that case, it is rounded up.
4942 If @var{n} is not specified or is zero, use a machine-dependent default.
4944 Enabled at levels @option{-O2}, @option{-O3}.
4946 @item -falign-labels
4947 @itemx -falign-labels=@var{n}
4948 @opindex falign-labels
4949 Align all branch targets to a power-of-two boundary, skipping up to
4950 @var{n} bytes like @option{-falign-functions}.  This option can easily
4951 make code slower, because it must insert dummy operations for when the
4952 branch target is reached in the usual flow of the code.
4954 @option{-fno-align-labels} and @option{-falign-labels=1} are
4955 equivalent and mean that labels will not be aligned.
4957 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4958 are greater than this value, then their values are used instead.
4960 If @var{n} is not specified or is zero, use a machine-dependent default
4961 which is very likely to be @samp{1}, meaning no alignment.
4963 Enabled at levels @option{-O2}, @option{-O3}.
4965 @item -falign-loops
4966 @itemx -falign-loops=@var{n}
4967 @opindex falign-loops
4968 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4969 like @option{-falign-functions}.  The hope is that the loop will be
4970 executed many times, which will make up for any execution of the dummy
4971 operations.
4973 @option{-fno-align-loops} and @option{-falign-loops=1} are
4974 equivalent and mean that loops will not be aligned.
4976 If @var{n} is not specified or is zero, use a machine-dependent default.
4978 Enabled at levels @option{-O2}, @option{-O3}.
4980 @item -falign-jumps
4981 @itemx -falign-jumps=@var{n}
4982 @opindex falign-jumps
4983 Align branch targets to a power-of-two boundary, for branch targets
4984 where the targets can only be reached by jumping, skipping up to @var{n}
4985 bytes like @option{-falign-functions}.  In this case, no dummy operations
4986 need be executed.
4988 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4989 equivalent and mean that loops will not be aligned.
4991 If @var{n} is not specified or is zero, use a machine-dependent default.
4993 Enabled at levels @option{-O2}, @option{-O3}.
4995 @item -funit-at-a-time
4996 @opindex funit-at-a-time
4997 Parse the whole compilation unit before starting to produce code.
4998 This allows some extra optimizations to take place but consumes
4999 more memory (in general).  There are some compatibility issues
5000 with @emph{unit-at-at-time} mode:
5001 @itemize @bullet
5002 @item
5003 enabling @emph{unit-at-a-time} mode may change the order
5004 in which functions, variables, and top-level @code{asm} statements
5005 are emitted, and will likely break code relying on some particular
5006 ordering.  The majority of such top-level @code{asm} statements,
5007 though, can be replaced by @code{section} attributes.
5009 @item
5010 @emph{unit-at-a-time} mode removes unreferenced static variables
5011 and functions are removed.  This may result in undefined references
5012 when an @code{asm} statement refers directly to variables or functions
5013 that are otherwise unused.  In that case either the variable/function
5014 shall be listed as an operand of the @code{asm} statement operand or,
5015 in the case of top-level @code{asm} statements the attribute @code{used}
5016 shall be used on the declaration.
5018 @item
5019 Static functions now can use non-standard passing conventions that
5020 may break @code{asm} statements calling functions directly.  Again,
5021 attribute @code{used} will prevent this behavior.
5022 @end itemize
5024 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5025 but this scheme may not be supported by future releases of GCC@.
5027 Enabled at levels @option{-O2}, @option{-O3}.
5029 @item -fweb
5030 @opindex fweb
5031 Constructs webs as commonly used for register allocation purposes and assign
5032 each web individual pseudo register.  This allows the register allocation pass
5033 to operate on pseudos directly, but also strengthens several other optimization
5034 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5035 however, make debugging impossible, since variables will no longer stay in a
5036 ``home register''.
5038 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5039 on targets where the default format for debugging information supports
5040 variable tracking.
5042 @item -fno-cprop-registers
5043 @opindex fno-cprop-registers
5044 After register allocation and post-register allocation instruction splitting,
5045 we perform a copy-propagation pass to try to reduce scheduling dependencies
5046 and occasionally eliminate the copy.
5048 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5050 @item -fprofile-generate
5051 @opindex fprofile-generate
5053 Enable options usually used for instrumenting application to produce
5054 profile useful for later recompilation with profile feedback based
5055 optimization.  You must use @option{-fprofile-generate} both when
5056 compiling and when linking your program.
5058 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5060 @item -fprofile-use
5061 @opindex fprofile-use
5062 Enable profile feedback directed optimizations, and optimizations
5063 generally profitable only with profile feedback available.
5065 The following options are enabled: @code{-fbranch-probabilities},
5066 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5068 @end table
5070 The following options control compiler behavior regarding floating
5071 point arithmetic.  These options trade off between speed and
5072 correctness.  All must be specifically enabled.
5074 @table @gcctabopt
5075 @item -ffloat-store
5076 @opindex ffloat-store
5077 Do not store floating point variables in registers, and inhibit other
5078 options that might change whether a floating point value is taken from a
5079 register or memory.
5081 @cindex floating point precision
5082 This option prevents undesirable excess precision on machines such as
5083 the 68000 where the floating registers (of the 68881) keep more
5084 precision than a @code{double} is supposed to have.  Similarly for the
5085 x86 architecture.  For most programs, the excess precision does only
5086 good, but a few programs rely on the precise definition of IEEE floating
5087 point.  Use @option{-ffloat-store} for such programs, after modifying
5088 them to store all pertinent intermediate computations into variables.
5090 @item -ffast-math
5091 @opindex ffast-math
5092 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5093 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5094 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5095 and @option{fcx-limited-range}.
5097 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5099 This option should never be turned on by any @option{-O} option since
5100 it can result in incorrect output for programs which depend on
5101 an exact implementation of IEEE or ISO rules/specifications for
5102 math functions.
5104 @item -fno-math-errno
5105 @opindex fno-math-errno
5106 Do not set ERRNO after calling math functions that are executed
5107 with a single instruction, e.g., sqrt.  A program that relies on
5108 IEEE exceptions for math error handling may want to use this flag
5109 for speed while maintaining IEEE arithmetic compatibility.
5111 This option should never be turned on by any @option{-O} option since
5112 it can result in incorrect output for programs which depend on
5113 an exact implementation of IEEE or ISO rules/specifications for
5114 math functions.
5116 The default is @option{-fmath-errno}.
5118 @item -funsafe-math-optimizations
5119 @opindex funsafe-math-optimizations
5120 Allow optimizations for floating-point arithmetic that (a) assume
5121 that arguments and results are valid and (b) may violate IEEE or
5122 ANSI standards.  When used at link-time, it may include libraries
5123 or startup files that change the default FPU control word or other
5124 similar optimizations.
5126 This option should never be turned on by any @option{-O} option since
5127 it can result in incorrect output for programs which depend on
5128 an exact implementation of IEEE or ISO rules/specifications for
5129 math functions.
5131 The default is @option{-fno-unsafe-math-optimizations}.
5133 @item -ffinite-math-only
5134 @opindex ffinite-math-only
5135 Allow optimizations for floating-point arithmetic that assume
5136 that arguments and results are not NaNs or +-Infs.
5138 This option should never be turned on by any @option{-O} option since
5139 it can result in incorrect output for programs which depend on
5140 an exact implementation of IEEE or ISO rules/specifications.
5142 The default is @option{-fno-finite-math-only}.
5144 @item -fno-trapping-math
5145 @opindex fno-trapping-math
5146 Compile code assuming that floating-point operations cannot generate
5147 user-visible traps.  These traps include division by zero, overflow,
5148 underflow, inexact result and invalid operation.  This option implies
5149 @option{-fno-signaling-nans}.  Setting this option may allow faster
5150 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5152 This option should never be turned on by any @option{-O} option since
5153 it can result in incorrect output for programs which depend on
5154 an exact implementation of IEEE or ISO rules/specifications for
5155 math functions.
5157 The default is @option{-ftrapping-math}.
5159 @item -frounding-math
5160 @opindex frounding-math
5161 Disable transformations and optimizations that assume default floating
5162 point rounding behavior.  This is round-to-zero for all floating point
5163 to integer conversions, and round-to-nearest for all other arithmetic
5164 truncations.  This option should be specified for programs that change
5165 the FP rounding mode dynamically, or that may be executed with a
5166 non-default rounding mode.  This option disables constant folding of
5167 floating point expressions at compile-time (which may be affected by
5168 rounding mode) and arithmetic transformations that are unsafe in the
5169 presence of sign-dependent rounding modes.
5171 The default is @option{-fno-rounding-math}.
5173 This option is experimental and does not currently guarantee to
5174 disable all GCC optimizations that are affected by rounding mode.
5175 Future versions of GCC may provide finer control of this setting
5176 using C99's @code{FENV_ACCESS} pragma.  This command line option
5177 will be used to specify the default state for @code{FENV_ACCESS}.
5179 @item -fsignaling-nans
5180 @opindex fsignaling-nans
5181 Compile code assuming that IEEE signaling NaNs may generate user-visible
5182 traps during floating-point operations.  Setting this option disables
5183 optimizations that may change the number of exceptions visible with
5184 signaling NaNs.  This option implies @option{-ftrapping-math}.
5186 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5187 be defined.
5189 The default is @option{-fno-signaling-nans}.
5191 This option is experimental and does not currently guarantee to
5192 disable all GCC optimizations that affect signaling NaN behavior.
5194 @item -fsingle-precision-constant
5195 @opindex fsingle-precision-constant
5196 Treat floating point constant as single precision constant instead of
5197 implicitly converting it to double precision constant.
5199 @item -fcx-limited-range
5200 @itemx -fno-cx-limited-range
5201 @opindex fcx-limited-range
5202 @opindex fno-cx-limited-range
5203 When enabled, this option states that a range reduction step is not
5204 needed when performing complex division.  The default is
5205 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5207 This option controls the default setting of the ISO C99 
5208 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
5209 all languages.
5211 @end table
5213 The following options control optimizations that may improve
5214 performance, but are not enabled by any @option{-O} options.  This
5215 section includes experimental options that may produce broken code.
5217 @table @gcctabopt
5218 @item -fbranch-probabilities
5219 @opindex fbranch-probabilities
5220 After running a program compiled with @option{-fprofile-arcs}
5221 (@pxref{Debugging Options,, Options for Debugging Your Program or
5222 @command{gcc}}), you can compile it a second time using
5223 @option{-fbranch-probabilities}, to improve optimizations based on
5224 the number of times each branch was taken.  When the program
5225 compiled with @option{-fprofile-arcs} exits it saves arc execution
5226 counts to a file called @file{@var{sourcename}.gcda} for each source
5227 file  The information in this data file is very dependent on the
5228 structure of the generated code, so you must use the same source code
5229 and the same optimization options for both compilations.
5231 With @option{-fbranch-probabilities}, GCC puts a
5232 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5233 These can be used to improve optimization.  Currently, they are only
5234 used in one place: in @file{reorg.c}, instead of guessing which path a
5235 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5236 exactly determine which path is taken more often.
5238 @item -fprofile-values
5239 @opindex fprofile-values
5240 If combined with @option{-fprofile-arcs}, it adds code so that some
5241 data about values of expressions in the program is gathered.
5243 With @option{-fbranch-probabilities}, it reads back the data gathered
5244 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5245 notes to instructions for their later usage in optimizations.
5247 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5249 @item -fvpt
5250 @opindex fvpt
5251 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5252 a code to gather information about values of expressions.
5254 With @option{-fbranch-probabilities}, it reads back the data gathered
5255 and actually performs the optimizations based on them.
5256 Currently the optimizations include specialization of division operation
5257 using the knowledge about the value of the denominator.
5259 @item -fspeculative-prefetching
5260 @opindex fspeculative-prefetching
5261 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5262 a code to gather information about addresses of memory references in the
5263 program.
5265 With @option{-fbranch-probabilities}, it reads back the data gathered
5266 and issues prefetch instructions according to them.  In addition to the opportunities
5267 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5268 memory access patterns---for example accesses to the data stored in linked
5269 list whose elements are usually allocated sequentially.
5271 In order to prevent issuing double prefetches, usage of
5272 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5274 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5276 @item -frename-registers
5277 @opindex frename-registers
5278 Attempt to avoid false dependencies in scheduled code by making use
5279 of registers left over after register allocation.  This optimization
5280 will most benefit processors with lots of registers.  Depending on the
5281 debug information format adopted by the target, however, it can
5282 make debugging impossible, since variables will no longer stay in
5283 a ``home register''.
5285 Not enabled by default at any level because it has known bugs.
5287 @item -ftracer
5288 @opindex ftracer
5289 Perform tail duplication to enlarge superblock size.  This transformation
5290 simplifies the control flow of the function allowing other optimizations to do
5291 better job.
5293 Enabled with @option{-fprofile-use}.
5295 @item -funroll-loops
5296 @opindex funroll-loops
5297 Unroll loops whose number of iterations can be determined at compile time or
5298 upon entry to the loop.  @option{-funroll-loops} implies
5299 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5300 (i.e.@: complete removal of loops with small constant number of iterations).
5301 This option makes code larger, and may or may not make it run faster.
5303 Enabled with @option{-fprofile-use}.
5305 @item -funroll-all-loops
5306 @opindex funroll-all-loops
5307 Unroll all loops, even if their number of iterations is uncertain when
5308 the loop is entered.  This usually makes programs run more slowly.
5309 @option{-funroll-all-loops} implies the same options as
5310 @option{-funroll-loops}.
5312 @item -fpeel-loops
5313 @opindex fpeel-loops
5314 Peels the loops for that there is enough information that they do not
5315 roll much (from profile feedback).  It also turns on complete loop peeling
5316 (i.e.@: complete removal of loops with small constant number of iterations).
5318 Enabled with @option{-fprofile-use}.
5320 @item -fmove-loop-invariants
5321 @opindex fmove-loop-invariants
5322 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5323 at level @option{-O1}
5325 @item -funswitch-loops
5326 @opindex funswitch-loops
5327 Move branches with loop invariant conditions out of the loop, with duplicates
5328 of the loop on both branches (modified according to result of the condition).
5330 @item -fprefetch-loop-arrays
5331 @opindex fprefetch-loop-arrays
5332 If supported by the target machine, generate instructions to prefetch
5333 memory to improve the performance of loops that access large arrays.
5335 Disabled at level @option{-Os}.
5337 @item -ffunction-sections
5338 @itemx -fdata-sections
5339 @opindex ffunction-sections
5340 @opindex fdata-sections
5341 Place each function or data item into its own section in the output
5342 file if the target supports arbitrary sections.  The name of the
5343 function or the name of the data item determines the section's name
5344 in the output file.
5346 Use these options on systems where the linker can perform optimizations
5347 to improve locality of reference in the instruction space.  Most systems
5348 using the ELF object format and SPARC processors running Solaris 2 have
5349 linkers with such optimizations.  AIX may have these optimizations in
5350 the future.
5352 Only use these options when there are significant benefits from doing
5353 so.  When you specify these options, the assembler and linker will
5354 create larger object and executable files and will also be slower.
5355 You will not be able to use @code{gprof} on all systems if you
5356 specify this option and you may have problems with debugging if
5357 you specify both this option and @option{-g}.
5359 @item -fbranch-target-load-optimize
5360 @opindex fbranch-target-load-optimize
5361 Perform branch target register load optimization before prologue / epilogue
5362 threading.
5363 The use of target registers can typically be exposed only during reload,
5364 thus hoisting loads out of loops and doing inter-block scheduling needs
5365 a separate optimization pass.
5367 @item -fbranch-target-load-optimize2
5368 @opindex fbranch-target-load-optimize2
5369 Perform branch target register load optimization after prologue / epilogue
5370 threading.
5372 @item -fbtr-bb-exclusive
5373 @opindex fbtr-bb-exclusive
5374 When performing branch target register load optimization, don't reuse
5375 branch target registers in within any basic block.
5377 @item --param @var{name}=@var{value}
5378 @opindex param
5379 In some places, GCC uses various constants to control the amount of
5380 optimization that is done.  For example, GCC will not inline functions
5381 that contain more that a certain number of instructions.  You can
5382 control some of these constants on the command-line using the
5383 @option{--param} option.
5385 The names of specific parameters, and the meaning of the values, are
5386 tied to the internals of the compiler, and are subject to change
5387 without notice in future releases.
5389 In each case, the @var{value} is an integer.  The allowable choices for
5390 @var{name} are given in the following table:
5392 @table @gcctabopt
5393 @item sra-max-structure-size
5394 The maximum structure size, in bytes, at which the scalar replacement
5395 of aggregates (SRA) optimization will perform block copies.  The
5396 default value, 0, implies that GCC will select the most appropriate
5397 size itself.
5399 @item sra-field-structure-ratio
5400 The threshold ratio (as a percentage) between instantiated fields and
5401 the complete structure size.  We say that if the ratio of the number
5402 of bytes in instantiated fields to the number of bytes in the complete
5403 structure exceeds this parameter, then block copies are not used.  The
5404 default is 75.
5406 @item max-crossjump-edges
5407 The maximum number of incoming edges to consider for crossjumping.
5408 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5409 the number of edges incoming to each block.  Increasing values mean
5410 more aggressive optimization, making the compile time increase with
5411 probably small improvement in executable size.
5413 @item min-crossjump-insns
5414 The minimum number of instructions which must be matched at the end
5415 of two blocks before crossjumping will be performed on them.  This
5416 value is ignored in the case where all instructions in the block being
5417 crossjumped from are matched.  The default value is 5.
5419 @item max-goto-duplication-insns
5420 The maximum number of instructions to duplicate to a block that jumps
5421 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5422 passes, GCC factors computed gotos early in the compilation process,
5423 and unfactors them as late as possible.  Only computed jumps at the
5424 end of a basic blocks with no more than max-goto-duplication-insns are
5425 unfactored.  The default value is 8.
5427 @item max-delay-slot-insn-search
5428 The maximum number of instructions to consider when looking for an
5429 instruction to fill a delay slot.  If more than this arbitrary number of
5430 instructions is searched, the time savings from filling the delay slot
5431 will be minimal so stop searching.  Increasing values mean more
5432 aggressive optimization, making the compile time increase with probably
5433 small improvement in executable run time.
5435 @item max-delay-slot-live-search
5436 When trying to fill delay slots, the maximum number of instructions to
5437 consider when searching for a block with valid live register
5438 information.  Increasing this arbitrarily chosen value means more
5439 aggressive optimization, increasing the compile time.  This parameter
5440 should be removed when the delay slot code is rewritten to maintain the
5441 control-flow graph.
5443 @item max-gcse-memory
5444 The approximate maximum amount of memory that will be allocated in
5445 order to perform the global common subexpression elimination
5446 optimization.  If more memory than specified is required, the
5447 optimization will not be done.
5449 @item max-gcse-passes
5450 The maximum number of passes of GCSE to run.  The default is 1.
5452 @item max-pending-list-length
5453 The maximum number of pending dependencies scheduling will allow
5454 before flushing the current state and starting over.  Large functions
5455 with few branches or calls can create excessively large lists which
5456 needlessly consume memory and resources.
5458 @item max-inline-insns-single
5459 Several parameters control the tree inliner used in gcc.
5460 This number sets the maximum number of instructions (counted in GCC's
5461 internal representation) in a single function that the tree inliner
5462 will consider for inlining.  This only affects functions declared
5463 inline and methods implemented in a class declaration (C++).
5464 The default value is 500.
5466 @item max-inline-insns-auto
5467 When you use @option{-finline-functions} (included in @option{-O3}),
5468 a lot of functions that would otherwise not be considered for inlining
5469 by the compiler will be investigated.  To those functions, a different
5470 (more restrictive) limit compared to functions declared inline can
5471 be applied.
5472 The default value is 120.
5474 @item large-function-insns
5475 The limit specifying really large functions.  For functions larger than this
5476 limit after inlining inlining is constrained by
5477 @option{--param large-function-growth}.  This parameter is useful primarily
5478 to avoid extreme compilation time caused by non-linear algorithms used by the
5479 backend.
5480 This parameter is ignored when @option{-funit-at-a-time} is not used.
5481 The default value is 3000.
5483 @item large-function-growth
5484 Specifies maximal growth of large function caused by inlining in percents.
5485 This parameter is ignored when @option{-funit-at-a-time} is not used.
5486 The default value is 100 which limits large function growth to 2.0 times
5487 the original size.
5489 @item inline-unit-growth
5490 Specifies maximal overall growth of the compilation unit caused by inlining.
5491 This parameter is ignored when @option{-funit-at-a-time} is not used.
5492 The default value is 50 which limits unit growth to 1.5 times the original
5493 size.
5495 @item max-inline-insns-recursive
5496 @itemx max-inline-insns-recursive-auto
5497 Specifies maximum number of instructions out-of-line copy of self recursive inline
5498 function can grow into by performing recursive inlining.
5500 For functions declared inline @option{--param max-inline-insns-recursive} is
5501 taken into acount.  For function not declared inline, recursive inlining
5502 happens only when @option{-finline-functions} (included in @option{-O3}) is
5503 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5504 default value is 500.
5506 @item max-inline-recursive-depth
5507 @itemx max-inline-recursive-depth-auto
5508 Specifies maximum recursion depth used by the recursive inlining.
5510 For functions declared inline @option{--param max-inline-recursive-depth} is
5511 taken into acount.  For function not declared inline, recursive inlining
5512 happens only when @option{-finline-functions} (included in @option{-O3}) is
5513 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5514 default value is 500.
5516 @item max-unrolled-insns
5517 The maximum number of instructions that a loop should have if that loop
5518 is unrolled, and if the loop is unrolled, it determines how many times
5519 the loop code is unrolled.
5521 @item max-average-unrolled-insns
5522 The maximum number of instructions biased by probabilities of their execution
5523 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5524 it determines how many times the loop code is unrolled.
5526 @item max-unroll-times
5527 The maximum number of unrollings of a single loop.
5529 @item max-peeled-insns
5530 The maximum number of instructions that a loop should have if that loop
5531 is peeled, and if the loop is peeled, it determines how many times
5532 the loop code is peeled.
5534 @item max-peel-times
5535 The maximum number of peelings of a single loop.
5537 @item max-completely-peeled-insns
5538 The maximum number of insns of a completely peeled loop.
5540 @item max-completely-peel-times
5541 The maximum number of iterations of a loop to be suitable for complete peeling.
5543 @item max-unswitch-insns
5544 The maximum number of insns of an unswitched loop.
5546 @item max-unswitch-level
5547 The maximum number of branches unswitched in a single loop.
5549 @item lim-expensive
5550 The minimum cost of an expensive expression in the loop invariant motion.
5552 @item iv-consider-all-candidates-bound
5553 Bound on number of candidates for induction variables below that
5554 all candidates are considered for each use in induction variable
5555 optimizations.  Only the most relevant candidates are considered
5556 if there are more candidates, to avoid quadratic time complexity.
5558 @item iv-max-considered-uses
5559 The induction variable optimizations give up on loops that contain more
5560 induction variable uses.
5562 @item iv-always-prune-cand-set-bound
5563 If number of candidates in the set is smaller than this value,
5564 we always try to remove unnecessary ivs from the set during its
5565 optimization when a new iv is added to the set.
5567 @item max-iterations-to-track
5569 The maximum number of iterations of a loop the brute force algorithm
5570 for analysis of # of iterations of the loop tries to evaluate.
5572 @item hot-bb-count-fraction
5573 Select fraction of the maximal count of repetitions of basic block in program
5574 given basic block needs to have to be considered hot.
5576 @item hot-bb-frequency-fraction
5577 Select fraction of the maximal frequency of executions of basic block in
5578 function given basic block needs to have to be considered hot
5580 @item tracer-dynamic-coverage
5581 @itemx tracer-dynamic-coverage-feedback
5583 This value is used to limit superblock formation once the given percentage of
5584 executed instructions is covered.  This limits unnecessary code size
5585 expansion.
5587 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5588 feedback is available.  The real profiles (as opposed to statically estimated
5589 ones) are much less balanced allowing the threshold to be larger value.
5591 @item tracer-max-code-growth
5592 Stop tail duplication once code growth has reached given percentage.  This is
5593 rather hokey argument, as most of the duplicates will be eliminated later in
5594 cross jumping, so it may be set to much higher values than is the desired code
5595 growth.
5597 @item tracer-min-branch-ratio
5599 Stop reverse growth when the reverse probability of best edge is less than this
5600 threshold (in percent).
5602 @item tracer-min-branch-ratio
5603 @itemx tracer-min-branch-ratio-feedback
5605 Stop forward growth if the best edge do have probability lower than this
5606 threshold.
5608 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5609 compilation for profile feedback and one for compilation without.  The value
5610 for compilation with profile feedback needs to be more conservative (higher) in
5611 order to make tracer effective.
5613 @item max-cse-path-length
5615 Maximum number of basic blocks on path that cse considers.  The default is 10.
5617 @item global-var-threshold
5619 Counts the number of function calls (@var{n}) and the number of
5620 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5621 single artificial variable will be created to represent all the
5622 call-clobbered variables at function call sites.  This artificial
5623 variable will then be made to alias every call-clobbered variable.
5624 (done as @code{int * size_t} on the host machine; beware overflow).
5626 @item max-aliased-vops
5628 Maximum number of virtual operands allowed to represent aliases
5629 before triggering the alias grouping heuristic.  Alias grouping
5630 reduces compile times and memory consumption needed for aliasing at
5631 the expense of precision loss in alias information.
5633 @item ggc-min-expand
5635 GCC uses a garbage collector to manage its own memory allocation.  This
5636 parameter specifies the minimum percentage by which the garbage
5637 collector's heap should be allowed to expand between collections.
5638 Tuning this may improve compilation speed; it has no effect on code
5639 generation.
5641 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5642 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5643 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5644 GCC is not able to calculate RAM on a particular platform, the lower
5645 bound of 30% is used.  Setting this parameter and
5646 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5647 every opportunity.  This is extremely slow, but can be useful for
5648 debugging.
5650 @item ggc-min-heapsize
5652 Minimum size of the garbage collector's heap before it begins bothering
5653 to collect garbage.  The first collection occurs after the heap expands
5654 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5655 tuning this may improve compilation speed, and has no effect on code
5656 generation.
5658 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5659 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5660 with a lower bound of 4096 (four megabytes) and an upper bound of
5661 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5662 particular platform, the lower bound is used.  Setting this parameter
5663 very large effectively disables garbage collection.  Setting this
5664 parameter and @option{ggc-min-expand} to zero causes a full collection
5665 to occur at every opportunity.
5667 @item max-reload-search-insns
5668 The maximum number of instruction reload should look backward for equivalent
5669 register.  Increasing values mean more aggressive optimization, making the
5670 compile time increase with probably slightly better performance.  The default
5671 value is 100.
5673 @item max-cselib-memory-location
5674 The maximum number of memory locations cselib should take into acount.
5675 Increasing values mean more aggressive optimization, making the compile time
5676 increase with probably slightly better performance.  The default value is 500.
5678 @item reorder-blocks-duplicate
5679 @itemx reorder-blocks-duplicate-feedback
5681 Used by basic block reordering pass to decide whether to use unconditional
5682 branch or duplicate the code on its destination.  Code is duplicated when its
5683 estimated size is smaller than this value multiplied by the estimated size of
5684 unconditional jump in the hot spots of the program.
5686 The @option{reorder-block-duplicate-feedback} is used only when profile
5687 feedback is available and may be set to higher values than
5688 @option{reorder-block-duplicate} since information about the hot spots is more
5689 accurate.
5691 @item max-sched-region-blocks
5692 The maximum number of blocks in a region to be considered for
5693 interblock scheduling.  The default value is 10.
5695 @item max-sched-region-insns
5696 The maximum number of insns in a region to be considered for
5697 interblock scheduling.  The default value is 100.
5699 @item max-last-value-rtl
5701 The maximum size measured as number of RTLs that can be recorded in an expression
5702 in combiner for a pseudo register as last known value of that register.  The default
5703 is 10000.
5705 @item integer-share-limit
5706 Small integer constants can use a shared data structure, reducing the
5707 compiler's memory usage and increasing its speed.  This sets the maximum
5708 value of a shared integer constant's.  The default value is 256.
5710 @end table
5711 @end table
5713 @node Preprocessor Options
5714 @section Options Controlling the Preprocessor
5715 @cindex preprocessor options
5716 @cindex options, preprocessor
5718 These options control the C preprocessor, which is run on each C source
5719 file before actual compilation.
5721 If you use the @option{-E} option, nothing is done except preprocessing.
5722 Some of these options make sense only together with @option{-E} because
5723 they cause the preprocessor output to be unsuitable for actual
5724 compilation.
5726 @table @gcctabopt
5727 @opindex Wp
5728 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5729 and pass @var{option} directly through to the preprocessor.  If
5730 @var{option} contains commas, it is split into multiple options at the
5731 commas.  However, many options are modified, translated or interpreted
5732 by the compiler driver before being passed to the preprocessor, and
5733 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5734 interface is undocumented and subject to change, so whenever possible
5735 you should avoid using @option{-Wp} and let the driver handle the
5736 options instead.
5738 @item -Xpreprocessor @var{option}
5739 @opindex preprocessor
5740 Pass @var{option} as an option to the preprocessor.  You can use this to
5741 supply system-specific preprocessor options which GCC does not know how to
5742 recognize.
5744 If you want to pass an option that takes an argument, you must use
5745 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5746 @end table
5748 @include cppopts.texi
5750 @node Assembler Options
5751 @section Passing Options to the Assembler
5753 @c prevent bad page break with this line
5754 You can pass options to the assembler.
5756 @table @gcctabopt
5757 @item -Wa,@var{option}
5758 @opindex Wa
5759 Pass @var{option} as an option to the assembler.  If @var{option}
5760 contains commas, it is split into multiple options at the commas.
5762 @item -Xassembler @var{option}
5763 @opindex Xassembler
5764 Pass @var{option} as an option to the assembler.  You can use this to
5765 supply system-specific assembler options which GCC does not know how to
5766 recognize.
5768 If you want to pass an option that takes an argument, you must use
5769 @option{-Xassembler} twice, once for the option and once for the argument.
5771 @end table
5773 @node Link Options
5774 @section Options for Linking
5775 @cindex link options
5776 @cindex options, linking
5778 These options come into play when the compiler links object files into
5779 an executable output file.  They are meaningless if the compiler is
5780 not doing a link step.
5782 @table @gcctabopt
5783 @cindex file names
5784 @item @var{object-file-name}
5785 A file name that does not end in a special recognized suffix is
5786 considered to name an object file or library.  (Object files are
5787 distinguished from libraries by the linker according to the file
5788 contents.)  If linking is done, these object files are used as input
5789 to the linker.
5791 @item -c
5792 @itemx -S
5793 @itemx -E
5794 @opindex c
5795 @opindex S
5796 @opindex E
5797 If any of these options is used, then the linker is not run, and
5798 object file names should not be used as arguments.  @xref{Overall
5799 Options}.
5801 @cindex Libraries
5802 @item -l@var{library}
5803 @itemx -l @var{library}
5804 @opindex l
5805 Search the library named @var{library} when linking.  (The second
5806 alternative with the library as a separate argument is only for
5807 POSIX compliance and is not recommended.)
5809 It makes a difference where in the command you write this option; the
5810 linker searches and processes libraries and object files in the order they
5811 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5812 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5813 to functions in @samp{z}, those functions may not be loaded.
5815 The linker searches a standard list of directories for the library,
5816 which is actually a file named @file{lib@var{library}.a}.  The linker
5817 then uses this file as if it had been specified precisely by name.
5819 The directories searched include several standard system directories
5820 plus any that you specify with @option{-L}.
5822 Normally the files found this way are library files---archive files
5823 whose members are object files.  The linker handles an archive file by
5824 scanning through it for members which define symbols that have so far
5825 been referenced but not defined.  But if the file that is found is an
5826 ordinary object file, it is linked in the usual fashion.  The only
5827 difference between using an @option{-l} option and specifying a file name
5828 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5829 and searches several directories.
5831 @item -lobjc
5832 @opindex lobjc
5833 You need this special case of the @option{-l} option in order to
5834 link an Objective-C or Objective-C++ program.
5836 @item -nostartfiles
5837 @opindex nostartfiles
5838 Do not use the standard system startup files when linking.
5839 The standard system libraries are used normally, unless @option{-nostdlib}
5840 or @option{-nodefaultlibs} is used.
5842 @item -nodefaultlibs
5843 @opindex nodefaultlibs
5844 Do not use the standard system libraries when linking.
5845 Only the libraries you specify will be passed to the linker.
5846 The standard startup files are used normally, unless @option{-nostartfiles}
5847 is used.  The compiler may generate calls to @code{memcmp},
5848 @code{memset}, @code{memcpy} and @code{memmove}.
5849 These entries are usually resolved by entries in
5850 libc.  These entry points should be supplied through some other
5851 mechanism when this option is specified.
5853 @item -nostdlib
5854 @opindex nostdlib
5855 Do not use the standard system startup files or libraries when linking.
5856 No startup files and only the libraries you specify will be passed to
5857 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5858 @code{memcpy} and @code{memmove}.
5859 These entries are usually resolved by entries in
5860 libc.  These entry points should be supplied through some other
5861 mechanism when this option is specified.
5863 @cindex @option{-lgcc}, use with @option{-nostdlib}
5864 @cindex @option{-nostdlib} and unresolved references
5865 @cindex unresolved references and @option{-nostdlib}
5866 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5867 @cindex @option{-nodefaultlibs} and unresolved references
5868 @cindex unresolved references and @option{-nodefaultlibs}
5869 One of the standard libraries bypassed by @option{-nostdlib} and
5870 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5871 that GCC uses to overcome shortcomings of particular machines, or special
5872 needs for some languages.
5873 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5874 Collection (GCC) Internals},
5875 for more discussion of @file{libgcc.a}.)
5876 In most cases, you need @file{libgcc.a} even when you want to avoid
5877 other standard libraries.  In other words, when you specify @option{-nostdlib}
5878 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5879 This ensures that you have no unresolved references to internal GCC
5880 library subroutines.  (For example, @samp{__main}, used to ensure C++
5881 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5882 GNU Compiler Collection (GCC) Internals}.)
5884 @item -pie
5885 @opindex pie
5886 Produce a position independent executable on targets which support it.
5887 For predictable results, you must also specify the same set of options
5888 that were used to generate code (@option{-fpie}, @option{-fPIE},
5889 or model suboptions) when you specify this option.
5891 @item -s
5892 @opindex s
5893 Remove all symbol table and relocation information from the executable.
5895 @item -static
5896 @opindex static
5897 On systems that support dynamic linking, this prevents linking with the shared
5898 libraries.  On other systems, this option has no effect.
5900 @item -shared
5901 @opindex shared
5902 Produce a shared object which can then be linked with other objects to
5903 form an executable.  Not all systems support this option.  For predictable
5904 results, you must also specify the same set of options that were used to
5905 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5906 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5907 needs to build supplementary stub code for constructors to work.  On
5908 multi-libbed systems, @samp{gcc -shared} must select the correct support
5909 libraries to link against.  Failing to supply the correct flags may lead
5910 to subtle defects.  Supplying them in cases where they are not necessary
5911 is innocuous.}
5913 @item -shared-libgcc
5914 @itemx -static-libgcc
5915 @opindex shared-libgcc
5916 @opindex static-libgcc
5917 On systems that provide @file{libgcc} as a shared library, these options
5918 force the use of either the shared or static version respectively.
5919 If no shared version of @file{libgcc} was built when the compiler was
5920 configured, these options have no effect.
5922 There are several situations in which an application should use the
5923 shared @file{libgcc} instead of the static version.  The most common
5924 of these is when the application wishes to throw and catch exceptions
5925 across different shared libraries.  In that case, each of the libraries
5926 as well as the application itself should use the shared @file{libgcc}.
5928 Therefore, the G++ and GCJ drivers automatically add
5929 @option{-shared-libgcc} whenever you build a shared library or a main
5930 executable, because C++ and Java programs typically use exceptions, so
5931 this is the right thing to do.
5933 If, instead, you use the GCC driver to create shared libraries, you may
5934 find that they will not always be linked with the shared @file{libgcc}.
5935 If GCC finds, at its configuration time, that you have a non-GNU linker
5936 or a GNU linker that does not support option @option{--eh-frame-hdr},
5937 it will link the shared version of @file{libgcc} into shared libraries
5938 by default.  Otherwise, it will take advantage of the linker and optimize
5939 away the linking with the shared version of @file{libgcc}, linking with
5940 the static version of libgcc by default.  This allows exceptions to
5941 propagate through such shared libraries, without incurring relocation
5942 costs at library load time.
5944 However, if a library or main executable is supposed to throw or catch
5945 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5946 for the languages used in the program, or using the option
5947 @option{-shared-libgcc}, such that it is linked with the shared
5948 @file{libgcc}.
5950 @item -symbolic
5951 @opindex symbolic
5952 Bind references to global symbols when building a shared object.  Warn
5953 about any unresolved references (unless overridden by the link editor
5954 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5955 this option.
5957 @item -Xlinker @var{option}
5958 @opindex Xlinker
5959 Pass @var{option} as an option to the linker.  You can use this to
5960 supply system-specific linker options which GCC does not know how to
5961 recognize.
5963 If you want to pass an option that takes an argument, you must use
5964 @option{-Xlinker} twice, once for the option and once for the argument.
5965 For example, to pass @option{-assert definitions}, you must write
5966 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5967 @option{-Xlinker "-assert definitions"}, because this passes the entire
5968 string as a single argument, which is not what the linker expects.
5970 @item -Wl,@var{option}
5971 @opindex Wl
5972 Pass @var{option} as an option to the linker.  If @var{option} contains
5973 commas, it is split into multiple options at the commas.
5975 @item -u @var{symbol}
5976 @opindex u
5977 Pretend the symbol @var{symbol} is undefined, to force linking of
5978 library modules to define it.  You can use @option{-u} multiple times with
5979 different symbols to force loading of additional library modules.
5980 @end table
5982 @node Directory Options
5983 @section Options for Directory Search
5984 @cindex directory options
5985 @cindex options, directory search
5986 @cindex search path
5988 These options specify directories to search for header files, for
5989 libraries and for parts of the compiler:
5991 @table @gcctabopt
5992 @item -I@var{dir}
5993 @opindex I
5994 Add the directory @var{dir} to the head of the list of directories to be
5995 searched for header files.  This can be used to override a system header
5996 file, substituting your own version, since these directories are
5997 searched before the system header file directories.  However, you should
5998 not use this option to add directories that contain vendor-supplied
5999 system header files (use @option{-isystem} for that).  If you use more than
6000 one @option{-I} option, the directories are scanned in left-to-right
6001 order; the standard system directories come after.
6003 If a standard system include directory, or a directory specified with
6004 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6005 option will be ignored.  The directory will still be searched but as a
6006 system directory at its normal position in the system include chain.
6007 This is to ensure that GCC's procedure to fix buggy system headers and
6008 the ordering for the include_next directive are not inadvertently changed.
6009 If you really need to change the search order for system directories,
6010 use the @option{-nostdinc} and/or @option{-isystem} options.
6012 @item -iquote@var{dir}
6013 @opindex iquote
6014 Add the directory @var{dir} to the head of the list of directories to
6015 be searched for header files only for the case of @samp{#include
6016 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6017 otherwise just like @option{-I}.
6019 @item -L@var{dir}
6020 @opindex L
6021 Add directory @var{dir} to the list of directories to be searched
6022 for @option{-l}.
6024 @item -B@var{prefix}
6025 @opindex B
6026 This option specifies where to find the executables, libraries,
6027 include files, and data files of the compiler itself.
6029 The compiler driver program runs one or more of the subprograms
6030 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
6031 @var{prefix} as a prefix for each program it tries to run, both with and
6032 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6034 For each subprogram to be run, the compiler driver first tries the
6035 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6036 was not specified, the driver tries two standard prefixes, which are
6037 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6038 those results in a file name that is found, the unmodified program
6039 name is searched for using the directories specified in your
6040 @env{PATH} environment variable.
6042 The compiler will check to see if the path provided by the @option{-B}
6043 refers to a directory, and if necessary it will add a directory
6044 separator character at the end of the path.
6046 @option{-B} prefixes that effectively specify directory names also apply
6047 to libraries in the linker, because the compiler translates these
6048 options into @option{-L} options for the linker.  They also apply to
6049 includes files in the preprocessor, because the compiler translates these
6050 options into @option{-isystem} options for the preprocessor.  In this case,
6051 the compiler appends @samp{include} to the prefix.
6053 The run-time support file @file{libgcc.a} can also be searched for using
6054 the @option{-B} prefix, if needed.  If it is not found there, the two
6055 standard prefixes above are tried, and that is all.  The file is left
6056 out of the link if it is not found by those means.
6058 Another way to specify a prefix much like the @option{-B} prefix is to use
6059 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6060 Variables}.
6062 As a special kludge, if the path provided by @option{-B} is
6063 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6064 9, then it will be replaced by @file{[dir/]include}.  This is to help
6065 with boot-strapping the compiler.
6067 @item -specs=@var{file}
6068 @opindex specs
6069 Process @var{file} after the compiler reads in the standard @file{specs}
6070 file, in order to override the defaults that the @file{gcc} driver
6071 program uses when determining what switches to pass to @file{cc1},
6072 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6073 @option{-specs=@var{file}} can be specified on the command line, and they
6074 are processed in order, from left to right.
6076 @item -I-
6077 @opindex I-
6078 This option has been deprecated.  Please use @option{-iquote} instead for
6079 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6080 Any directories you specify with @option{-I} options before the @option{-I-}
6081 option are searched only for the case of @samp{#include "@var{file}"};
6082 they are not searched for @samp{#include <@var{file}>}.
6084 If additional directories are specified with @option{-I} options after
6085 the @option{-I-}, these directories are searched for all @samp{#include}
6086 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6087 this way.)
6089 In addition, the @option{-I-} option inhibits the use of the current
6090 directory (where the current input file came from) as the first search
6091 directory for @samp{#include "@var{file}"}.  There is no way to
6092 override this effect of @option{-I-}.  With @option{-I.} you can specify
6093 searching the directory which was current when the compiler was
6094 invoked.  That is not exactly the same as what the preprocessor does
6095 by default, but it is often satisfactory.
6097 @option{-I-} does not inhibit the use of the standard system directories
6098 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6099 independent.
6100 @end table
6102 @c man end
6104 @node Spec Files
6105 @section Specifying subprocesses and the switches to pass to them
6106 @cindex Spec Files
6108 @command{gcc} is a driver program.  It performs its job by invoking a
6109 sequence of other programs to do the work of compiling, assembling and
6110 linking.  GCC interprets its command-line parameters and uses these to
6111 deduce which programs it should invoke, and which command-line options
6112 it ought to place on their command lines.  This behavior is controlled
6113 by @dfn{spec strings}.  In most cases there is one spec string for each
6114 program that GCC can invoke, but a few programs have multiple spec
6115 strings to control their behavior.  The spec strings built into GCC can
6116 be overridden by using the @option{-specs=} command-line switch to specify
6117 a spec file.
6119 @dfn{Spec files} are plaintext files that are used to construct spec
6120 strings.  They consist of a sequence of directives separated by blank
6121 lines.  The type of directive is determined by the first non-whitespace
6122 character on the line and it can be one of the following:
6124 @table @code
6125 @item %@var{command}
6126 Issues a @var{command} to the spec file processor.  The commands that can
6127 appear here are:
6129 @table @code
6130 @item %include <@var{file}>
6131 @cindex %include
6132 Search for @var{file} and insert its text at the current point in the
6133 specs file.
6135 @item %include_noerr <@var{file}>
6136 @cindex %include_noerr
6137 Just like @samp{%include}, but do not generate an error message if the include
6138 file cannot be found.
6140 @item %rename @var{old_name} @var{new_name}
6141 @cindex %rename
6142 Rename the spec string @var{old_name} to @var{new_name}.
6144 @end table
6146 @item *[@var{spec_name}]:
6147 This tells the compiler to create, override or delete the named spec
6148 string.  All lines after this directive up to the next directive or
6149 blank line are considered to be the text for the spec string.  If this
6150 results in an empty string then the spec will be deleted.  (Or, if the
6151 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6152 does not currently exist a new spec will be created.  If the spec does
6153 exist then its contents will be overridden by the text of this
6154 directive, unless the first character of that text is the @samp{+}
6155 character, in which case the text will be appended to the spec.
6157 @item [@var{suffix}]:
6158 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6159 and up to the next directive or blank line are considered to make up the
6160 spec string for the indicated suffix.  When the compiler encounters an
6161 input file with the named suffix, it will processes the spec string in
6162 order to work out how to compile that file.  For example:
6164 @smallexample
6165 .ZZ:
6166 z-compile -input %i
6167 @end smallexample
6169 This says that any input file whose name ends in @samp{.ZZ} should be
6170 passed to the program @samp{z-compile}, which should be invoked with the
6171 command-line switch @option{-input} and with the result of performing the
6172 @samp{%i} substitution.  (See below.)
6174 As an alternative to providing a spec string, the text that follows a
6175 suffix directive can be one of the following:
6177 @table @code
6178 @item @@@var{language}
6179 This says that the suffix is an alias for a known @var{language}.  This is
6180 similar to using the @option{-x} command-line switch to GCC to specify a
6181 language explicitly.  For example:
6183 @smallexample
6184 .ZZ:
6185 @@c++
6186 @end smallexample
6188 Says that .ZZ files are, in fact, C++ source files.
6190 @item #@var{name}
6191 This causes an error messages saying:
6193 @smallexample
6194 @var{name} compiler not installed on this system.
6195 @end smallexample
6196 @end table
6198 GCC already has an extensive list of suffixes built into it.
6199 This directive will add an entry to the end of the list of suffixes, but
6200 since the list is searched from the end backwards, it is effectively
6201 possible to override earlier entries using this technique.
6203 @end table
6205 GCC has the following spec strings built into it.  Spec files can
6206 override these strings or create their own.  Note that individual
6207 targets can also add their own spec strings to this list.
6209 @smallexample
6210 asm          Options to pass to the assembler
6211 asm_final    Options to pass to the assembler post-processor
6212 cpp          Options to pass to the C preprocessor
6213 cc1          Options to pass to the C compiler
6214 cc1plus      Options to pass to the C++ compiler
6215 endfile      Object files to include at the end of the link
6216 link         Options to pass to the linker
6217 lib          Libraries to include on the command line to the linker
6218 libgcc       Decides which GCC support library to pass to the linker
6219 linker       Sets the name of the linker
6220 predefines   Defines to be passed to the C preprocessor
6221 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6222              by default
6223 startfile    Object files to include at the start of the link
6224 @end smallexample
6226 Here is a small example of a spec file:
6228 @smallexample
6229 %rename lib                 old_lib
6231 *lib:
6232 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6233 @end smallexample
6235 This example renames the spec called @samp{lib} to @samp{old_lib} and
6236 then overrides the previous definition of @samp{lib} with a new one.
6237 The new definition adds in some extra command-line options before
6238 including the text of the old definition.
6240 @dfn{Spec strings} are a list of command-line options to be passed to their
6241 corresponding program.  In addition, the spec strings can contain
6242 @samp{%}-prefixed sequences to substitute variable text or to
6243 conditionally insert text into the command line.  Using these constructs
6244 it is possible to generate quite complex command lines.
6246 Here is a table of all defined @samp{%}-sequences for spec
6247 strings.  Note that spaces are not generated automatically around the
6248 results of expanding these sequences.  Therefore you can concatenate them
6249 together or combine them with constant text in a single argument.
6251 @table @code
6252 @item %%
6253 Substitute one @samp{%} into the program name or argument.
6255 @item %i
6256 Substitute the name of the input file being processed.
6258 @item %b
6259 Substitute the basename of the input file being processed.
6260 This is the substring up to (and not including) the last period
6261 and not including the directory.
6263 @item %B
6264 This is the same as @samp{%b}, but include the file suffix (text after
6265 the last period).
6267 @item %d
6268 Marks the argument containing or following the @samp{%d} as a
6269 temporary file name, so that that file will be deleted if GCC exits
6270 successfully.  Unlike @samp{%g}, this contributes no text to the
6271 argument.
6273 @item %g@var{suffix}
6274 Substitute a file name that has suffix @var{suffix} and is chosen
6275 once per compilation, and mark the argument in the same way as
6276 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6277 name is now chosen in a way that is hard to predict even when previously
6278 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6279 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6280 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6281 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6282 was simply substituted with a file name chosen once per compilation,
6283 without regard to any appended suffix (which was therefore treated
6284 just like ordinary text), making such attacks more likely to succeed.
6286 @item %u@var{suffix}
6287 Like @samp{%g}, but generates a new temporary file name even if
6288 @samp{%u@var{suffix}} was already seen.
6290 @item %U@var{suffix}
6291 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6292 new one if there is no such last file name.  In the absence of any
6293 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6294 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6295 would involve the generation of two distinct file names, one
6296 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6297 simply substituted with a file name chosen for the previous @samp{%u},
6298 without regard to any appended suffix.
6300 @item %j@var{suffix}
6301 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6302 writable, and if save-temps is off; otherwise, substitute the name
6303 of a temporary file, just like @samp{%u}.  This temporary file is not
6304 meant for communication between processes, but rather as a junk
6305 disposal mechanism.
6307 @item %|@var{suffix}
6308 @itemx %m@var{suffix}
6309 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6310 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6311 all.  These are the two most common ways to instruct a program that it
6312 should read from standard input or write to standard output.  If you
6313 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6314 construct: see for example @file{f/lang-specs.h}.
6316 @item %.@var{SUFFIX}
6317 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6318 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6319 terminated by the next space or %.
6321 @item %w
6322 Marks the argument containing or following the @samp{%w} as the
6323 designated output file of this compilation.  This puts the argument
6324 into the sequence of arguments that @samp{%o} will substitute later.
6326 @item %o
6327 Substitutes the names of all the output files, with spaces
6328 automatically placed around them.  You should write spaces
6329 around the @samp{%o} as well or the results are undefined.
6330 @samp{%o} is for use in the specs for running the linker.
6331 Input files whose names have no recognized suffix are not compiled
6332 at all, but they are included among the output files, so they will
6333 be linked.
6335 @item %O
6336 Substitutes the suffix for object files.  Note that this is
6337 handled specially when it immediately follows @samp{%g, %u, or %U},
6338 because of the need for those to form complete file names.  The
6339 handling is such that @samp{%O} is treated exactly as if it had already
6340 been substituted, except that @samp{%g, %u, and %U} do not currently
6341 support additional @var{suffix} characters following @samp{%O} as they would
6342 following, for example, @samp{.o}.
6344 @item %p
6345 Substitutes the standard macro predefinitions for the
6346 current target machine.  Use this when running @code{cpp}.
6348 @item %P
6349 Like @samp{%p}, but puts @samp{__} before and after the name of each
6350 predefined macro, except for macros that start with @samp{__} or with
6351 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6354 @item %I
6355 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6356 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6357 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6358 as necessary.
6360 @item %s
6361 Current argument is the name of a library or startup file of some sort.
6362 Search for that file in a standard list of directories and substitute
6363 the full name found.
6365 @item %e@var{str}
6366 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6367 Use this when inconsistent options are detected.
6369 @item %(@var{name})
6370 Substitute the contents of spec string @var{name} at this point.
6372 @item %[@var{name}]
6373 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6375 @item %x@{@var{option}@}
6376 Accumulate an option for @samp{%X}.
6378 @item %X
6379 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6380 spec string.
6382 @item %Y
6383 Output the accumulated assembler options specified by @option{-Wa}.
6385 @item %Z
6386 Output the accumulated preprocessor options specified by @option{-Wp}.
6388 @item %a
6389 Process the @code{asm} spec.  This is used to compute the
6390 switches to be passed to the assembler.
6392 @item %A
6393 Process the @code{asm_final} spec.  This is a spec string for
6394 passing switches to an assembler post-processor, if such a program is
6395 needed.
6397 @item %l
6398 Process the @code{link} spec.  This is the spec for computing the
6399 command line passed to the linker.  Typically it will make use of the
6400 @samp{%L %G %S %D and %E} sequences.
6402 @item %D
6403 Dump out a @option{-L} option for each directory that GCC believes might
6404 contain startup files.  If the target supports multilibs then the
6405 current multilib directory will be prepended to each of these paths.
6407 @item %L
6408 Process the @code{lib} spec.  This is a spec string for deciding which
6409 libraries should be included on the command line to the linker.
6411 @item %G
6412 Process the @code{libgcc} spec.  This is a spec string for deciding
6413 which GCC support library should be included on the command line to the linker.
6415 @item %S
6416 Process the @code{startfile} spec.  This is a spec for deciding which
6417 object files should be the first ones passed to the linker.  Typically
6418 this might be a file named @file{crt0.o}.
6420 @item %E
6421 Process the @code{endfile} spec.  This is a spec string that specifies
6422 the last object files that will be passed to the linker.
6424 @item %C
6425 Process the @code{cpp} spec.  This is used to construct the arguments
6426 to be passed to the C preprocessor.
6428 @item %1
6429 Process the @code{cc1} spec.  This is used to construct the options to be
6430 passed to the actual C compiler (@samp{cc1}).
6432 @item %2
6433 Process the @code{cc1plus} spec.  This is used to construct the options to be
6434 passed to the actual C++ compiler (@samp{cc1plus}).
6436 @item %*
6437 Substitute the variable part of a matched option.  See below.
6438 Note that each comma in the substituted string is replaced by
6439 a single space.
6441 @item %<@code{S}
6442 Remove all occurrences of @code{-S} from the command line.  Note---this
6443 command is position dependent.  @samp{%} commands in the spec string
6444 before this one will see @code{-S}, @samp{%} commands in the spec string
6445 after this one will not.
6447 @item %:@var{function}(@var{args})
6448 Call the named function @var{function}, passing it @var{args}.
6449 @var{args} is first processed as a nested spec string, then split
6450 into an argument vector in the usual fashion.  The function returns
6451 a string which is processed as if it had appeared literally as part
6452 of the current spec.
6454 The following built-in spec functions are provided:
6456 @table @code
6457 @item @code{if-exists}
6458 The @code{if-exists} spec function takes one argument, an absolute
6459 pathname to a file.  If the file exists, @code{if-exists} returns the
6460 pathname.  Here is a small example of its usage:
6462 @smallexample
6463 *startfile:
6464 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6465 @end smallexample
6467 @item @code{if-exists-else}
6468 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6469 spec function, except that it takes two arguments.  The first argument is
6470 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6471 returns the pathname.  If it does not exist, it returns the second argument.
6472 This way, @code{if-exists-else} can be used to select one file or another,
6473 based on the existence of the first.  Here is a small example of its usage:
6475 @smallexample
6476 *startfile:
6477 crt0%O%s %:if-exists(crti%O%s) \
6478 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6479 @end smallexample
6481 @item @code{replace-outfile}
6482 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6483 first argument in the outfiles array and replaces it with the second argument.  Here
6484 is a small example of its usage:
6486 @smallexample
6487 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6488 @end smallexample
6490 @end table
6492 @item %@{@code{S}@}
6493 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6494 If that switch was not specified, this substitutes nothing.  Note that
6495 the leading dash is omitted when specifying this option, and it is
6496 automatically inserted if the substitution is performed.  Thus the spec
6497 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6498 and would output the command line option @option{-foo}.
6500 @item %W@{@code{S}@}
6501 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6502 deleted on failure.
6504 @item %@{@code{S}*@}
6505 Substitutes all the switches specified to GCC whose names start
6506 with @code{-S}, but which also take an argument.  This is used for
6507 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6508 GCC considers @option{-o foo} as being
6509 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6510 text, including the space.  Thus two arguments would be generated.
6512 @item %@{@code{S}*&@code{T}*@}
6513 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6514 (the order of @code{S} and @code{T} in the spec is not significant).
6515 There can be any number of ampersand-separated variables; for each the
6516 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6518 @item %@{@code{S}:@code{X}@}
6519 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6521 @item %@{!@code{S}:@code{X}@}
6522 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6524 @item %@{@code{S}*:@code{X}@}
6525 Substitutes @code{X} if one or more switches whose names start with
6526 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6527 once, no matter how many such switches appeared.  However, if @code{%*}
6528 appears somewhere in @code{X}, then @code{X} will be substituted once
6529 for each matching switch, with the @code{%*} replaced by the part of
6530 that switch that matched the @code{*}.
6532 @item %@{.@code{S}:@code{X}@}
6533 Substitutes @code{X}, if processing a file with suffix @code{S}.
6535 @item %@{!.@code{S}:@code{X}@}
6536 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6538 @item %@{@code{S}|@code{P}:@code{X}@}
6539 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6540 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6541 although they have a stronger binding than the @samp{|}.  If @code{%*}
6542 appears in @code{X}, all of the alternatives must be starred, and only
6543 the first matching alternative is substituted.
6545 For example, a spec string like this:
6547 @smallexample
6548 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6549 @end smallexample
6551 will output the following command-line options from the following input
6552 command-line options:
6554 @smallexample
6555 fred.c        -foo -baz
6556 jim.d         -bar -boggle
6557 -d fred.c     -foo -baz -boggle
6558 -d jim.d      -bar -baz -boggle
6559 @end smallexample
6561 @item %@{S:X; T:Y; :D@}
6563 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6564 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6565 be as many clauses as you need.  This may be combined with @code{.},
6566 @code{!}, @code{|}, and @code{*} as needed.
6569 @end table
6571 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6572 construct may contain other nested @samp{%} constructs or spaces, or
6573 even newlines.  They are processed as usual, as described above.
6574 Trailing white space in @code{X} is ignored.  White space may also
6575 appear anywhere on the left side of the colon in these constructs,
6576 except between @code{.} or @code{*} and the corresponding word.
6578 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6579 handled specifically in these constructs.  If another value of
6580 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6581 @option{-W} switch is found later in the command line, the earlier
6582 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6583 just one letter, which passes all matching options.
6585 The character @samp{|} at the beginning of the predicate text is used to
6586 indicate that a command should be piped to the following command, but
6587 only if @option{-pipe} is specified.
6589 It is built into GCC which switches take arguments and which do not.
6590 (You might think it would be useful to generalize this to allow each
6591 compiler's spec to say which switches take arguments.  But this cannot
6592 be done in a consistent fashion.  GCC cannot even decide which input
6593 files have been specified without knowing which switches take arguments,
6594 and it must know which input files to compile in order to tell which
6595 compilers to run).
6597 GCC also knows implicitly that arguments starting in @option{-l} are to be
6598 treated as compiler output files, and passed to the linker in their
6599 proper position among the other output files.
6601 @c man begin OPTIONS
6603 @node Target Options
6604 @section Specifying Target Machine and Compiler Version
6605 @cindex target options
6606 @cindex cross compiling
6607 @cindex specifying machine version
6608 @cindex specifying compiler version and target machine
6609 @cindex compiler version, specifying
6610 @cindex target machine, specifying
6612 The usual way to run GCC is to run the executable called @file{gcc}, or
6613 @file{<machine>-gcc} when cross-compiling, or
6614 @file{<machine>-gcc-<version>} to run a version other than the one that
6615 was installed last.  Sometimes this is inconvenient, so GCC provides
6616 options that will switch to another cross-compiler or version.
6618 @table @gcctabopt
6619 @item -b @var{machine}
6620 @opindex b
6621 The argument @var{machine} specifies the target machine for compilation.
6623 The value to use for @var{machine} is the same as was specified as the
6624 machine type when configuring GCC as a cross-compiler.  For
6625 example, if a cross-compiler was configured with @samp{configure
6626 i386v}, meaning to compile for an 80386 running System V, then you
6627 would specify @option{-b i386v} to run that cross compiler.
6629 @item -V @var{version}
6630 @opindex V
6631 The argument @var{version} specifies which version of GCC to run.
6632 This is useful when multiple versions are installed.  For example,
6633 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6634 @end table
6636 The @option{-V} and @option{-b} options work by running the
6637 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6638 use them if you can just run that directly.
6640 @node Submodel Options
6641 @section Hardware Models and Configurations
6642 @cindex submodel options
6643 @cindex specifying hardware config
6644 @cindex hardware models and configurations, specifying
6645 @cindex machine dependent options
6647 Earlier we discussed the standard option @option{-b} which chooses among
6648 different installed compilers for completely different target
6649 machines, such as VAX vs.@: 68000 vs.@: 80386.
6651 In addition, each of these target machine types can have its own
6652 special options, starting with @samp{-m}, to choose among various
6653 hardware models or configurations---for example, 68010 vs 68020,
6654 floating coprocessor or none.  A single installed version of the
6655 compiler can compile for any model or configuration, according to the
6656 options specified.
6658 Some configurations of the compiler also support additional special
6659 options, usually for compatibility with other compilers on the same
6660 platform.
6662 These options are defined by the macro @code{TARGET_SWITCHES} in the
6663 machine description.  The default for the options is also defined by
6664 that macro, which enables you to change the defaults.
6666 @c This list is ordered alphanumerically by subsection name.
6667 @c It should be the same order and spelling as these options are listed
6668 @c in Machine Dependent Options
6670 @menu
6671 * ARC Options::
6672 * ARM Options::
6673 * AVR Options::
6674 * CRIS Options::
6675 * Darwin Options::
6676 * DEC Alpha Options::
6677 * DEC Alpha/VMS Options::
6678 * FRV Options::
6679 * H8/300 Options::
6680 * HPPA Options::
6681 * i386 and x86-64 Options::
6682 * IA-64 Options::
6683 * M32R/D Options::
6684 * M680x0 Options::
6685 * M68hc1x Options::
6686 * MCore Options::
6687 * MIPS Options::
6688 * MMIX Options::
6689 * MN10300 Options::
6690 * NS32K Options::
6691 * PDP-11 Options::
6692 * PowerPC Options::
6693 * RS/6000 and PowerPC Options::
6694 * S/390 and zSeries Options::
6695 * SH Options::
6696 * SPARC Options::
6697 * System V Options::
6698 * TMS320C3x/C4x Options::
6699 * V850 Options::
6700 * VAX Options::
6701 * x86-64 Options::
6702 * Xstormy16 Options::
6703 * Xtensa Options::
6704 * zSeries Options::
6705 @end menu
6707 @node ARC Options
6708 @subsection ARC Options
6709 @cindex ARC Options
6711 These options are defined for ARC implementations:
6713 @table @gcctabopt
6714 @item -EL
6715 @opindex EL
6716 Compile code for little endian mode.  This is the default.
6718 @item -EB
6719 @opindex EB
6720 Compile code for big endian mode.
6722 @item -mmangle-cpu
6723 @opindex mmangle-cpu
6724 Prepend the name of the cpu to all public symbol names.
6725 In multiple-processor systems, there are many ARC variants with different
6726 instruction and register set characteristics.  This flag prevents code
6727 compiled for one cpu to be linked with code compiled for another.
6728 No facility exists for handling variants that are ``almost identical''.
6729 This is an all or nothing option.
6731 @item -mcpu=@var{cpu}
6732 @opindex mcpu
6733 Compile code for ARC variant @var{cpu}.
6734 Which variants are supported depend on the configuration.
6735 All variants support @option{-mcpu=base}, this is the default.
6737 @item -mtext=@var{text-section}
6738 @itemx -mdata=@var{data-section}
6739 @itemx -mrodata=@var{readonly-data-section}
6740 @opindex mtext
6741 @opindex mdata
6742 @opindex mrodata
6743 Put functions, data, and readonly data in @var{text-section},
6744 @var{data-section}, and @var{readonly-data-section} respectively
6745 by default.  This can be overridden with the @code{section} attribute.
6746 @xref{Variable Attributes}.
6748 @end table
6750 @node ARM Options
6751 @subsection ARM Options
6752 @cindex ARM options
6754 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6755 architectures:
6757 @table @gcctabopt
6758 @item -mabi=@var{name}
6759 @opindex mabi
6760 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6761 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6763 @item -mapcs-frame
6764 @opindex mapcs-frame
6765 Generate a stack frame that is compliant with the ARM Procedure Call
6766 Standard for all functions, even if this is not strictly necessary for
6767 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6768 with this option will cause the stack frames not to be generated for
6769 leaf functions.  The default is @option{-mno-apcs-frame}.
6771 @item -mapcs
6772 @opindex mapcs
6773 This is a synonym for @option{-mapcs-frame}.
6775 @ignore
6776 @c not currently implemented
6777 @item -mapcs-stack-check
6778 @opindex mapcs-stack-check
6779 Generate code to check the amount of stack space available upon entry to
6780 every function (that actually uses some stack space).  If there is
6781 insufficient space available then either the function
6782 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6783 called, depending upon the amount of stack space required.  The run time
6784 system is required to provide these functions.  The default is
6785 @option{-mno-apcs-stack-check}, since this produces smaller code.
6787 @c not currently implemented
6788 @item -mapcs-float
6789 @opindex mapcs-float
6790 Pass floating point arguments using the float point registers.  This is
6791 one of the variants of the APCS@.  This option is recommended if the
6792 target hardware has a floating point unit or if a lot of floating point
6793 arithmetic is going to be performed by the code.  The default is
6794 @option{-mno-apcs-float}, since integer only code is slightly increased in
6795 size if @option{-mapcs-float} is used.
6797 @c not currently implemented
6798 @item -mapcs-reentrant
6799 @opindex mapcs-reentrant
6800 Generate reentrant, position independent code.  The default is
6801 @option{-mno-apcs-reentrant}.
6802 @end ignore
6804 @item -mthumb-interwork
6805 @opindex mthumb-interwork
6806 Generate code which supports calling between the ARM and Thumb
6807 instruction sets.  Without this option the two instruction sets cannot
6808 be reliably used inside one program.  The default is
6809 @option{-mno-thumb-interwork}, since slightly larger code is generated
6810 when @option{-mthumb-interwork} is specified.
6812 @item -mno-sched-prolog
6813 @opindex mno-sched-prolog
6814 Prevent the reordering of instructions in the function prolog, or the
6815 merging of those instruction with the instructions in the function's
6816 body.  This means that all functions will start with a recognizable set
6817 of instructions (or in fact one of a choice from a small set of
6818 different function prologues), and this information can be used to
6819 locate the start if functions inside an executable piece of code.  The
6820 default is @option{-msched-prolog}.
6822 @item -mhard-float
6823 @opindex mhard-float
6824 Generate output containing floating point instructions.  This is the
6825 default.
6827 @item -msoft-float
6828 @opindex msoft-float
6829 Generate output containing library calls for floating point.
6830 @strong{Warning:} the requisite libraries are not available for all ARM
6831 targets.  Normally the facilities of the machine's usual C compiler are
6832 used, but this cannot be done directly in cross-compilation.  You must make
6833 your own arrangements to provide suitable library functions for
6834 cross-compilation.
6836 @option{-msoft-float} changes the calling convention in the output file;
6837 therefore, it is only useful if you compile @emph{all} of a program with
6838 this option.  In particular, you need to compile @file{libgcc.a}, the
6839 library that comes with GCC, with @option{-msoft-float} in order for
6840 this to work.
6842 @item -mfloat-abi=@var{name}
6843 @opindex mfloat-abi
6844 Specifies which ABI to use for floating point values.  Permissible values
6845 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6847 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6848 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6849 of floating point instructions, but still uses the soft-float calling
6850 conventions.
6852 @item -mlittle-endian
6853 @opindex mlittle-endian
6854 Generate code for a processor running in little-endian mode.  This is
6855 the default for all standard configurations.
6857 @item -mbig-endian
6858 @opindex mbig-endian
6859 Generate code for a processor running in big-endian mode; the default is
6860 to compile code for a little-endian processor.
6862 @item -mwords-little-endian
6863 @opindex mwords-little-endian
6864 This option only applies when generating code for big-endian processors.
6865 Generate code for a little-endian word order but a big-endian byte
6866 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6867 option should only be used if you require compatibility with code for
6868 big-endian ARM processors generated by versions of the compiler prior to
6869 2.8.
6871 @item -mcpu=@var{name}
6872 @opindex mcpu
6873 This specifies the name of the target ARM processor.  GCC uses this name
6874 to determine what kind of instructions it can emit when generating
6875 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6876 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6877 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6878 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6879 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6880 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6881 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6882 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6883 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6884 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6885 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6886 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6887 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6888 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6889 @samp{ep9312}.
6891 @itemx -mtune=@var{name}
6892 @opindex mtune
6893 This option is very similar to the @option{-mcpu=} option, except that
6894 instead of specifying the actual target processor type, and hence
6895 restricting which instructions can be used, it specifies that GCC should
6896 tune the performance of the code as if the target were of the type
6897 specified in this option, but still choosing the instructions that it
6898 will generate based on the cpu specified by a @option{-mcpu=} option.
6899 For some ARM implementations better performance can be obtained by using
6900 this option.
6902 @item -march=@var{name}
6903 @opindex march
6904 This specifies the name of the target ARM architecture.  GCC uses this
6905 name to determine what kind of instructions it can emit when generating
6906 assembly code.  This option can be used in conjunction with or instead
6907 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6908 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6909 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6910 @samp{iwmmxt}, @samp{ep9312}.
6912 @item -mfpu=@var{name}
6913 @itemx -mfpe=@var{number}
6914 @itemx -mfp=@var{number}
6915 @opindex mfpu
6916 @opindex mfpe
6917 @opindex mfp
6918 This specifies what floating point hardware (or hardware emulation) is
6919 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6920 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6921 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6922 with older versions of GCC@.
6924 If @option{-msoft-float} is specified this specifies the format of
6925 floating point values.
6927 @item -mstructure-size-boundary=@var{n}
6928 @opindex mstructure-size-boundary
6929 The size of all structures and unions will be rounded up to a multiple
6930 of the number of bits set by this option.  Permissible values are 8, 32
6931 and 64.  The default value varies for different toolchains.  For the COFF
6932 targeted toolchain the default value is 8.  A value of 64 is only allowed
6933 if the underlying ABI supports it.
6935 Specifying the larger number can produce faster, more efficient code, but
6936 can also increase the size of the program.  Different values are potentially
6937 incompatible.  Code compiled with one value cannot necessarily expect to
6938 work with code or libraries compiled with another value, if they exchange
6939 information using structures or unions.
6941 @item -mabort-on-noreturn
6942 @opindex mabort-on-noreturn
6943 Generate a call to the function @code{abort} at the end of a
6944 @code{noreturn} function.  It will be executed if the function tries to
6945 return.
6947 @item -mlong-calls
6948 @itemx -mno-long-calls
6949 @opindex mlong-calls
6950 @opindex mno-long-calls
6951 Tells the compiler to perform function calls by first loading the
6952 address of the function into a register and then performing a subroutine
6953 call on this register.  This switch is needed if the target function
6954 will lie outside of the 64 megabyte addressing range of the offset based
6955 version of subroutine call instruction.
6957 Even if this switch is enabled, not all function calls will be turned
6958 into long calls.  The heuristic is that static functions, functions
6959 which have the @samp{short-call} attribute, functions that are inside
6960 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6961 definitions have already been compiled within the current compilation
6962 unit, will not be turned into long calls.  The exception to this rule is
6963 that weak function definitions, functions with the @samp{long-call}
6964 attribute or the @samp{section} attribute, and functions that are within
6965 the scope of a @samp{#pragma long_calls} directive, will always be
6966 turned into long calls.
6968 This feature is not enabled by default.  Specifying
6969 @option{-mno-long-calls} will restore the default behavior, as will
6970 placing the function calls within the scope of a @samp{#pragma
6971 long_calls_off} directive.  Note these switches have no effect on how
6972 the compiler generates code to handle function calls via function
6973 pointers.
6975 @item -mnop-fun-dllimport
6976 @opindex mnop-fun-dllimport
6977 Disable support for the @code{dllimport} attribute.
6979 @item -msingle-pic-base
6980 @opindex msingle-pic-base
6981 Treat the register used for PIC addressing as read-only, rather than
6982 loading it in the prologue for each function.  The run-time system is
6983 responsible for initializing this register with an appropriate value
6984 before execution begins.
6986 @item -mpic-register=@var{reg}
6987 @opindex mpic-register
6988 Specify the register to be used for PIC addressing.  The default is R10
6989 unless stack-checking is enabled, when R9 is used.
6991 @item -mcirrus-fix-invalid-insns
6992 @opindex mcirrus-fix-invalid-insns
6993 @opindex mno-cirrus-fix-invalid-insns
6994 Insert NOPs into the instruction stream to in order to work around
6995 problems with invalid Maverick instruction combinations.  This option
6996 is only valid if the @option{-mcpu=ep9312} option has been used to
6997 enable generation of instructions for the Cirrus Maverick floating
6998 point co-processor.  This option is not enabled by default, since the
6999 problem is only present in older Maverick implementations.  The default
7000 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7001 switch.
7003 @item -mpoke-function-name
7004 @opindex mpoke-function-name
7005 Write the name of each function into the text section, directly
7006 preceding the function prologue.  The generated code is similar to this:
7008 @smallexample
7009      t0
7010          .ascii "arm_poke_function_name", 0
7011          .align
7012      t1
7013          .word 0xff000000 + (t1 - t0)
7014      arm_poke_function_name
7015          mov     ip, sp
7016          stmfd   sp!, @{fp, ip, lr, pc@}
7017          sub     fp, ip, #4
7018 @end smallexample
7020 When performing a stack backtrace, code can inspect the value of
7021 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
7022 location @code{pc - 12} and the top 8 bits are set, then we know that
7023 there is a function name embedded immediately preceding this location
7024 and has length @code{((pc[-3]) & 0xff000000)}.
7026 @item -mthumb
7027 @opindex mthumb
7028 Generate code for the 16-bit Thumb instruction set.  The default is to
7029 use the 32-bit ARM instruction set.
7031 @item -mtpcs-frame
7032 @opindex mtpcs-frame
7033 Generate a stack frame that is compliant with the Thumb Procedure Call
7034 Standard for all non-leaf functions.  (A leaf function is one that does
7035 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7037 @item -mtpcs-leaf-frame
7038 @opindex mtpcs-leaf-frame
7039 Generate a stack frame that is compliant with the Thumb Procedure Call
7040 Standard for all leaf functions.  (A leaf function is one that does
7041 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7043 @item -mcallee-super-interworking
7044 @opindex mcallee-super-interworking
7045 Gives all externally visible functions in the file being compiled an ARM
7046 instruction set header which switches to Thumb mode before executing the
7047 rest of the function.  This allows these functions to be called from
7048 non-interworking code.
7050 @item -mcaller-super-interworking
7051 @opindex mcaller-super-interworking
7052 Allows calls via function pointers (including virtual functions) to
7053 execute correctly regardless of whether the target code has been
7054 compiled for interworking or not.  There is a small overhead in the cost
7055 of executing a function pointer if this option is enabled.
7057 @end table
7059 @node AVR Options
7060 @subsection AVR Options
7061 @cindex AVR Options
7063 These options are defined for AVR implementations:
7065 @table @gcctabopt
7066 @item -mmcu=@var{mcu}
7067 @opindex mmcu
7068 Specify ATMEL AVR instruction set or MCU type.
7070 Instruction set avr1 is for the minimal AVR core, not supported by the C
7071 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7072 attiny11, attiny12, attiny15, attiny28).
7074 Instruction set avr2 (default) is for the classic AVR core with up to
7075 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7076 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7077 at90c8534, at90s8535).
7079 Instruction set avr3 is for the classic AVR core with up to 128K program
7080 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7082 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7083 memory space (MCU types: atmega8, atmega83, atmega85).
7085 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7086 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7087 atmega64, atmega128, at43usb355, at94k).
7089 @item -msize
7090 @opindex msize
7091 Output instruction sizes to the asm file.
7093 @item -minit-stack=@var{N}
7094 @opindex minit-stack
7095 Specify the initial stack address, which may be a symbol or numeric value,
7096 @samp{__stack} is the default.
7098 @item -mno-interrupts
7099 @opindex mno-interrupts
7100 Generated code is not compatible with hardware interrupts.
7101 Code size will be smaller.
7103 @item -mcall-prologues
7104 @opindex mcall-prologues
7105 Functions prologues/epilogues expanded as call to appropriate
7106 subroutines.  Code size will be smaller.
7108 @item -mno-tablejump
7109 @opindex mno-tablejump
7110 Do not generate tablejump insns which sometimes increase code size.
7112 @item -mtiny-stack
7113 @opindex mtiny-stack
7114 Change only the low 8 bits of the stack pointer.
7116 @item -mint8
7117 @opindex mint8
7118 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7119 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7120 and long long will be 4 bytes.  Please note that this option does not
7121 comply to the C standards, but it will provide you with smaller code
7122 size.
7123 @end table
7125 @node CRIS Options
7126 @subsection CRIS Options
7127 @cindex CRIS Options
7129 These options are defined specifically for the CRIS ports.
7131 @table @gcctabopt
7132 @item -march=@var{architecture-type}
7133 @itemx -mcpu=@var{architecture-type}
7134 @opindex march
7135 @opindex mcpu
7136 Generate code for the specified architecture.  The choices for
7137 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7138 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7139 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7140 @samp{v10}.
7142 @item -mtune=@var{architecture-type}
7143 @opindex mtune
7144 Tune to @var{architecture-type} everything applicable about the generated
7145 code, except for the ABI and the set of available instructions.  The
7146 choices for @var{architecture-type} are the same as for
7147 @option{-march=@var{architecture-type}}.
7149 @item -mmax-stack-frame=@var{n}
7150 @opindex mmax-stack-frame
7151 Warn when the stack frame of a function exceeds @var{n} bytes.
7153 @item -melinux-stacksize=@var{n}
7154 @opindex melinux-stacksize
7155 Only available with the @samp{cris-axis-aout} target.  Arranges for
7156 indications in the program to the kernel loader that the stack of the
7157 program should be set to @var{n} bytes.
7159 @item -metrax4
7160 @itemx -metrax100
7161 @opindex metrax4
7162 @opindex metrax100
7163 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7164 @option{-march=v3} and @option{-march=v8} respectively.
7166 @item -mmul-bug-workaround
7167 @itemx -mno-mul-bug-workaround
7168 @opindex mmul-bug-workaround
7169 @opindex mno-mul-bug-workaround
7170 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7171 models where it applies.  This option is active by default.
7173 @item -mpdebug
7174 @opindex mpdebug
7175 Enable CRIS-specific verbose debug-related information in the assembly
7176 code.  This option also has the effect to turn off the @samp{#NO_APP}
7177 formatted-code indicator to the assembler at the beginning of the
7178 assembly file.
7180 @item -mcc-init
7181 @opindex mcc-init
7182 Do not use condition-code results from previous instruction; always emit
7183 compare and test instructions before use of condition codes.
7185 @item -mno-side-effects
7186 @opindex mno-side-effects
7187 Do not emit instructions with side-effects in addressing modes other than
7188 post-increment.
7190 @item -mstack-align
7191 @itemx -mno-stack-align
7192 @itemx -mdata-align
7193 @itemx -mno-data-align
7194 @itemx -mconst-align
7195 @itemx -mno-const-align
7196 @opindex mstack-align
7197 @opindex mno-stack-align
7198 @opindex mdata-align
7199 @opindex mno-data-align
7200 @opindex mconst-align
7201 @opindex mno-const-align
7202 These options (no-options) arranges (eliminate arrangements) for the
7203 stack-frame, individual data and constants to be aligned for the maximum
7204 single data access size for the chosen CPU model.  The default is to
7205 arrange for 32-bit alignment.  ABI details such as structure layout are
7206 not affected by these options.
7208 @item -m32-bit
7209 @itemx -m16-bit
7210 @itemx -m8-bit
7211 @opindex m32-bit
7212 @opindex m16-bit
7213 @opindex m8-bit
7214 Similar to the stack- data- and const-align options above, these options
7215 arrange for stack-frame, writable data and constants to all be 32-bit,
7216 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7218 @item -mno-prologue-epilogue
7219 @itemx -mprologue-epilogue
7220 @opindex mno-prologue-epilogue
7221 @opindex mprologue-epilogue
7222 With @option{-mno-prologue-epilogue}, the normal function prologue and
7223 epilogue that sets up the stack-frame are omitted and no return
7224 instructions or return sequences are generated in the code.  Use this
7225 option only together with visual inspection of the compiled code: no
7226 warnings or errors are generated when call-saved registers must be saved,
7227 or storage for local variable needs to be allocated.
7229 @item -mno-gotplt
7230 @itemx -mgotplt
7231 @opindex mno-gotplt
7232 @opindex mgotplt
7233 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7234 instruction sequences that load addresses for functions from the PLT part
7235 of the GOT rather than (traditional on other architectures) calls to the
7236 PLT@.  The default is @option{-mgotplt}.
7238 @item -maout
7239 @opindex maout
7240 Legacy no-op option only recognized with the cris-axis-aout target.
7242 @item -melf
7243 @opindex melf
7244 Legacy no-op option only recognized with the cris-axis-elf and
7245 cris-axis-linux-gnu targets.
7247 @item -melinux
7248 @opindex melinux
7249 Only recognized with the cris-axis-aout target, where it selects a
7250 GNU/linux-like multilib, include files and instruction set for
7251 @option{-march=v8}.
7253 @item -mlinux
7254 @opindex mlinux
7255 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7257 @item -sim
7258 @opindex sim
7259 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7260 to link with input-output functions from a simulator library.  Code,
7261 initialized data and zero-initialized data are allocated consecutively.
7263 @item -sim2
7264 @opindex sim2
7265 Like @option{-sim}, but pass linker options to locate initialized data at
7266 0x40000000 and zero-initialized data at 0x80000000.
7267 @end table
7269 @node Darwin Options
7270 @subsection Darwin Options
7271 @cindex Darwin options
7273 These options are defined for all architectures running the Darwin operating
7274 system.
7276 FSF GCC on Darwin does not create ``fat'' object files; it will create
7277 an object file for the single architecture that it was built to
7278 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7279 @option{-arch} options are used; it does so by running the compiler or
7280 linker multiple times and joining the results together with
7281 @file{lipo}.
7283 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7284 @samp{i686}) is determined by the flags that specify the ISA
7285 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7286 @option{-force_cpusubtype_ALL} option can be used to override this.
7288 The Darwin tools vary in their behaviour when presented with an ISA
7289 mismatch.  The assembler, @file{as}, will only permit instructions to
7290 be used that are valid for the subtype of the file it is generating,
7291 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7292 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7293 and print an error if asked to create a shared library with a less
7294 restrictive subtype than its input files (for instance, trying to put
7295 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7296 for executables, @file{ld}, will quietly give the executable the most
7297 restrictive subtype of any of its input files.
7299 @table @gcctabopt
7300 @item -F@var{dir}
7301 @opindex F
7302 Add the framework directory @var{dir} to the head of the list of
7303 directories to be searched for header files.  These directories are
7304 interleaved with those specified by @option{-I} options and are
7305 scanned in a left-to-right order.
7307 A framework directory is a directory with frameworks in it.  A
7308 framework is a directory with a @samp{"Headers"} and/or
7309 @samp{"PrivateHeaders"} directory contained directly in it that ends
7310 in @samp{".framework"}.  The name of a framework is the name of this
7311 directory excluding the @samp{".framework"}.  Headers associated with
7312 the framework are found in one of those two directories, with
7313 @samp{"Headers"} being searched first.  A subframework is a framework
7314 directory that is in a framework's @samp{"Frameworks"} directory.
7315 Includes of subframework headers can only appear in a header of a
7316 framework that contains the subframework, or in a sibling subframework
7317 header.  Two subframeworks are siblings if they occur in the same
7318 framework.  A subframework should not have the same name as a
7319 framework, a warning will be issued if this is violated.  Currently a
7320 subframework cannot have subframeworks, in the future, the mechanism
7321 may be extended to support this.  The standard frameworks can be found
7322 in @samp{"/System/Library/Frameworks"} and
7323 @samp{"/Library/Frameworks"}.  An example include looks like
7324 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7325 the name of the framework and header.h is found in the
7326 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7328 @item -gused
7329 @opindex -gused
7330 Emit debugging information for symbols that are used.  For STABS
7331 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7332 This is by default ON@.
7334 @item -gfull
7335 @opindex -gfull
7336 Emit debugging information for all symbols and types.
7338 @item -mone-byte-bool
7339 @opindex -mone-byte-bool
7340 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7341 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7342 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7343 option has no effect on x86.
7345 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7346 to generate code that is not binary compatible with code generated
7347 without that switch.  Using this switch may require recompiling all
7348 other modules in a program, including system libraries.  Use this
7349 switch to conform to a non-default data model.
7351 @item -mfix-and-continue
7352 @itemx -ffix-and-continue
7353 @itemx -findirect-data
7354 @opindex mfix-and-continue
7355 @opindex ffix-and-continue
7356 @opindex findirect-data
7357 Generate code suitable for fast turn around development.  Needed to
7358 enable gdb to dynamically load @code{.o} files into already running
7359 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7360 are provided for backwards compatibility.
7362 @item -all_load
7363 @opindex all_load
7364 Loads all members of static archive libraries.
7365 See man ld(1) for more information.
7367 @item -arch_errors_fatal
7368 @opindex arch_errors_fatal
7369 Cause the errors having to do with files that have the wrong architecture
7370 to be fatal.
7372 @item -bind_at_load
7373 @opindex bind_at_load
7374 Causes the output file to be marked such that the dynamic linker will
7375 bind all undefined references when the file is loaded or launched.
7377 @item -bundle
7378 @opindex bundle
7379 Produce a Mach-o bundle format file.
7380 See man ld(1) for more information.
7382 @item -bundle_loader @var{executable}
7383 @opindex bundle_loader
7384 This option specifies the @var{executable} that will be loading the build
7385 output file being linked.  See man ld(1) for more information.
7387 @item -dynamiclib
7388 @opindex -dynamiclib
7389 When passed this option, GCC will produce a dynamic library instead of
7390 an executable when linking, using the Darwin @file{libtool} command.
7392 @item -force_cpusubtype_ALL
7393 @opindex -force_cpusubtype_ALL
7394 This causes GCC's output file to have the @var{ALL} subtype, instead of
7395 one controlled by the @option{-mcpu} or @option{-march} option.
7397 @item -allowable_client  @var{client_name}
7398 @itemx -client_name
7399 @itemx -compatibility_version
7400 @itemx -current_version
7401 @itemx -dead_strip
7402 @itemx -dependency-file
7403 @itemx -dylib_file
7404 @itemx -dylinker_install_name
7405 @itemx -dynamic
7406 @itemx -exported_symbols_list
7407 @itemx -filelist
7408 @itemx -flat_namespace
7409 @itemx -force_flat_namespace
7410 @itemx -headerpad_max_install_names
7411 @itemx -image_base
7412 @itemx -init
7413 @itemx -install_name
7414 @itemx -keep_private_externs
7415 @itemx -multi_module
7416 @itemx -multiply_defined
7417 @itemx -multiply_defined_unused
7418 @itemx -noall_load
7419 @itemx -no_dead_strip_inits_and_terms
7420 @itemx -nofixprebinding
7421 @itemx -nomultidefs
7422 @itemx -noprebind
7423 @itemx -noseglinkedit
7424 @itemx -pagezero_size
7425 @itemx -prebind
7426 @itemx -prebind_all_twolevel_modules
7427 @itemx -private_bundle
7428 @itemx -read_only_relocs
7429 @itemx -sectalign
7430 @itemx -sectobjectsymbols
7431 @itemx -whyload
7432 @itemx -seg1addr
7433 @itemx -sectcreate
7434 @itemx -sectobjectsymbols
7435 @itemx -sectorder
7436 @itemx -segaddr
7437 @itemx -segs_read_only_addr
7438 @itemx -segs_read_write_addr
7439 @itemx -seg_addr_table
7440 @itemx -seg_addr_table_filename
7441 @itemx -seglinkedit
7442 @itemx -segprot
7443 @itemx -segs_read_only_addr
7444 @itemx -segs_read_write_addr
7445 @itemx -single_module
7446 @itemx -static
7447 @itemx -sub_library
7448 @itemx -sub_umbrella
7449 @itemx -twolevel_namespace
7450 @itemx -umbrella
7451 @itemx -undefined
7452 @itemx -unexported_symbols_list
7453 @itemx -weak_reference_mismatches
7454 @itemx -whatsloaded
7456 @opindex allowable_client
7457 @opindex client_name
7458 @opindex compatibility_version
7459 @opindex current_version
7460 @opindex dead_strip
7461 @opindex dependency-file
7462 @opindex dylib_file
7463 @opindex dylinker_install_name
7464 @opindex dynamic
7465 @opindex exported_symbols_list
7466 @opindex filelist
7467 @opindex flat_namespace
7468 @opindex force_flat_namespace
7469 @opindex headerpad_max_install_names
7470 @opindex image_base
7471 @opindex init
7472 @opindex install_name
7473 @opindex keep_private_externs
7474 @opindex multi_module
7475 @opindex multiply_defined
7476 @opindex multiply_defined_unused
7477 @opindex noall_load
7478 @opindex no_dead_strip_inits_and_terms
7479 @opindex nofixprebinding
7480 @opindex nomultidefs
7481 @opindex noprebind
7482 @opindex noseglinkedit
7483 @opindex pagezero_size
7484 @opindex prebind
7485 @opindex prebind_all_twolevel_modules
7486 @opindex private_bundle
7487 @opindex read_only_relocs
7488 @opindex sectalign
7489 @opindex sectobjectsymbols
7490 @opindex whyload
7491 @opindex seg1addr
7492 @opindex sectcreate
7493 @opindex sectobjectsymbols
7494 @opindex sectorder
7495 @opindex segaddr
7496 @opindex segs_read_only_addr
7497 @opindex segs_read_write_addr
7498 @opindex seg_addr_table
7499 @opindex seg_addr_table_filename
7500 @opindex seglinkedit
7501 @opindex segprot
7502 @opindex segs_read_only_addr
7503 @opindex segs_read_write_addr
7504 @opindex single_module
7505 @opindex static
7506 @opindex sub_library
7507 @opindex sub_umbrella
7508 @opindex twolevel_namespace
7509 @opindex umbrella
7510 @opindex undefined
7511 @opindex unexported_symbols_list
7512 @opindex weak_reference_mismatches
7513 @opindex whatsloaded
7515 These options are passed to the Darwin linker.  The Darwin linker man page
7516 describes them in detail.
7517 @end table
7519 @node DEC Alpha Options
7520 @subsection DEC Alpha Options
7522 These @samp{-m} options are defined for the DEC Alpha implementations:
7524 @table @gcctabopt
7525 @item -mno-soft-float
7526 @itemx -msoft-float
7527 @opindex mno-soft-float
7528 @opindex msoft-float
7529 Use (do not use) the hardware floating-point instructions for
7530 floating-point operations.  When @option{-msoft-float} is specified,
7531 functions in @file{libgcc.a} will be used to perform floating-point
7532 operations.  Unless they are replaced by routines that emulate the
7533 floating-point operations, or compiled in such a way as to call such
7534 emulations routines, these routines will issue floating-point
7535 operations.   If you are compiling for an Alpha without floating-point
7536 operations, you must ensure that the library is built so as not to call
7537 them.
7539 Note that Alpha implementations without floating-point operations are
7540 required to have floating-point registers.
7542 @item -mfp-reg
7543 @itemx -mno-fp-regs
7544 @opindex mfp-reg
7545 @opindex mno-fp-regs
7546 Generate code that uses (does not use) the floating-point register set.
7547 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7548 register set is not used, floating point operands are passed in integer
7549 registers as if they were integers and floating-point results are passed
7550 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7551 so any function with a floating-point argument or return value called by code
7552 compiled with @option{-mno-fp-regs} must also be compiled with that
7553 option.
7555 A typical use of this option is building a kernel that does not use,
7556 and hence need not save and restore, any floating-point registers.
7558 @item -mieee
7559 @opindex mieee
7560 The Alpha architecture implements floating-point hardware optimized for
7561 maximum performance.  It is mostly compliant with the IEEE floating
7562 point standard.  However, for full compliance, software assistance is
7563 required.  This option generates code fully IEEE compliant code
7564 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7565 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7566 defined during compilation.  The resulting code is less efficient but is
7567 able to correctly support denormalized numbers and exceptional IEEE
7568 values such as not-a-number and plus/minus infinity.  Other Alpha
7569 compilers call this option @option{-ieee_with_no_inexact}.
7571 @item -mieee-with-inexact
7572 @opindex mieee-with-inexact
7573 This is like @option{-mieee} except the generated code also maintains
7574 the IEEE @var{inexact-flag}.  Turning on this option causes the
7575 generated code to implement fully-compliant IEEE math.  In addition to
7576 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7577 macro.  On some Alpha implementations the resulting code may execute
7578 significantly slower than the code generated by default.  Since there is
7579 very little code that depends on the @var{inexact-flag}, you should
7580 normally not specify this option.  Other Alpha compilers call this
7581 option @option{-ieee_with_inexact}.
7583 @item -mfp-trap-mode=@var{trap-mode}
7584 @opindex mfp-trap-mode
7585 This option controls what floating-point related traps are enabled.
7586 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7587 The trap mode can be set to one of four values:
7589 @table @samp
7590 @item n
7591 This is the default (normal) setting.  The only traps that are enabled
7592 are the ones that cannot be disabled in software (e.g., division by zero
7593 trap).
7595 @item u
7596 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7597 as well.
7599 @item su
7600 Like @samp{su}, but the instructions are marked to be safe for software
7601 completion (see Alpha architecture manual for details).
7603 @item sui
7604 Like @samp{su}, but inexact traps are enabled as well.
7605 @end table
7607 @item -mfp-rounding-mode=@var{rounding-mode}
7608 @opindex mfp-rounding-mode
7609 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7610 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7613 @table @samp
7614 @item n
7615 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7616 the nearest machine number or towards the even machine number in case
7617 of a tie.
7619 @item m
7620 Round towards minus infinity.
7622 @item c
7623 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7625 @item d
7626 Dynamic rounding mode.  A field in the floating point control register
7627 (@var{fpcr}, see Alpha architecture reference manual) controls the
7628 rounding mode in effect.  The C library initializes this register for
7629 rounding towards plus infinity.  Thus, unless your program modifies the
7630 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7631 @end table
7633 @item -mtrap-precision=@var{trap-precision}
7634 @opindex mtrap-precision
7635 In the Alpha architecture, floating point traps are imprecise.  This
7636 means without software assistance it is impossible to recover from a
7637 floating trap and program execution normally needs to be terminated.
7638 GCC can generate code that can assist operating system trap handlers
7639 in determining the exact location that caused a floating point trap.
7640 Depending on the requirements of an application, different levels of
7641 precisions can be selected:
7643 @table @samp
7644 @item p
7645 Program precision.  This option is the default and means a trap handler
7646 can only identify which program caused a floating point exception.
7648 @item f
7649 Function precision.  The trap handler can determine the function that
7650 caused a floating point exception.
7652 @item i
7653 Instruction precision.  The trap handler can determine the exact
7654 instruction that caused a floating point exception.
7655 @end table
7657 Other Alpha compilers provide the equivalent options called
7658 @option{-scope_safe} and @option{-resumption_safe}.
7660 @item -mieee-conformant
7661 @opindex mieee-conformant
7662 This option marks the generated code as IEEE conformant.  You must not
7663 use this option unless you also specify @option{-mtrap-precision=i} and either
7664 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7665 is to emit the line @samp{.eflag 48} in the function prologue of the
7666 generated assembly file.  Under DEC Unix, this has the effect that
7667 IEEE-conformant math library routines will be linked in.
7669 @item -mbuild-constants
7670 @opindex mbuild-constants
7671 Normally GCC examines a 32- or 64-bit integer constant to
7672 see if it can construct it from smaller constants in two or three
7673 instructions.  If it cannot, it will output the constant as a literal and
7674 generate code to load it from the data segment at runtime.
7676 Use this option to require GCC to construct @emph{all} integer constants
7677 using code, even if it takes more instructions (the maximum is six).
7679 You would typically use this option to build a shared library dynamic
7680 loader.  Itself a shared library, it must relocate itself in memory
7681 before it can find the variables and constants in its own data segment.
7683 @item -malpha-as
7684 @itemx -mgas
7685 @opindex malpha-as
7686 @opindex mgas
7687 Select whether to generate code to be assembled by the vendor-supplied
7688 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7690 @item -mbwx
7691 @itemx -mno-bwx
7692 @itemx -mcix
7693 @itemx -mno-cix
7694 @itemx -mfix
7695 @itemx -mno-fix
7696 @itemx -mmax
7697 @itemx -mno-max
7698 @opindex mbwx
7699 @opindex mno-bwx
7700 @opindex mcix
7701 @opindex mno-cix
7702 @opindex mfix
7703 @opindex mno-fix
7704 @opindex mmax
7705 @opindex mno-max
7706 Indicate whether GCC should generate code to use the optional BWX,
7707 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7708 sets supported by the CPU type specified via @option{-mcpu=} option or that
7709 of the CPU on which GCC was built if none was specified.
7711 @item -mfloat-vax
7712 @itemx -mfloat-ieee
7713 @opindex mfloat-vax
7714 @opindex mfloat-ieee
7715 Generate code that uses (does not use) VAX F and G floating point
7716 arithmetic instead of IEEE single and double precision.
7718 @item -mexplicit-relocs
7719 @itemx -mno-explicit-relocs
7720 @opindex mexplicit-relocs
7721 @opindex mno-explicit-relocs
7722 Older Alpha assemblers provided no way to generate symbol relocations
7723 except via assembler macros.  Use of these macros does not allow
7724 optimal instruction scheduling.  GNU binutils as of version 2.12
7725 supports a new syntax that allows the compiler to explicitly mark
7726 which relocations should apply to which instructions.  This option
7727 is mostly useful for debugging, as GCC detects the capabilities of
7728 the assembler when it is built and sets the default accordingly.
7730 @item -msmall-data
7731 @itemx -mlarge-data
7732 @opindex msmall-data
7733 @opindex mlarge-data
7734 When @option{-mexplicit-relocs} is in effect, static data is
7735 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7736 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7737 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7738 16-bit relocations off of the @code{$gp} register.  This limits the
7739 size of the small data area to 64KB, but allows the variables to be
7740 directly accessed via a single instruction.
7742 The default is @option{-mlarge-data}.  With this option the data area
7743 is limited to just below 2GB@.  Programs that require more than 2GB of
7744 data must use @code{malloc} or @code{mmap} to allocate the data in the
7745 heap instead of in the program's data segment.
7747 When generating code for shared libraries, @option{-fpic} implies
7748 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7750 @item -msmall-text
7751 @itemx -mlarge-text
7752 @opindex msmall-text
7753 @opindex mlarge-text
7754 When @option{-msmall-text} is used, the compiler assumes that the
7755 code of the entire program (or shared library) fits in 4MB, and is
7756 thus reachable with a branch instruction.  When @option{-msmall-data}
7757 is used, the compiler can assume that all local symbols share the
7758 same @code{$gp} value, and thus reduce the number of instructions
7759 required for a function call from 4 to 1.
7761 The default is @option{-mlarge-text}.
7763 @item -mcpu=@var{cpu_type}
7764 @opindex mcpu
7765 Set the instruction set and instruction scheduling parameters for
7766 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7767 style name or the corresponding chip number.  GCC supports scheduling
7768 parameters for the EV4, EV5 and EV6 family of processors and will
7769 choose the default values for the instruction set from the processor
7770 you specify.  If you do not specify a processor type, GCC will default
7771 to the processor on which the compiler was built.
7773 Supported values for @var{cpu_type} are
7775 @table @samp
7776 @item ev4
7777 @itemx ev45
7778 @itemx 21064
7779 Schedules as an EV4 and has no instruction set extensions.
7781 @item ev5
7782 @itemx 21164
7783 Schedules as an EV5 and has no instruction set extensions.
7785 @item ev56
7786 @itemx 21164a
7787 Schedules as an EV5 and supports the BWX extension.
7789 @item pca56
7790 @itemx 21164pc
7791 @itemx 21164PC
7792 Schedules as an EV5 and supports the BWX and MAX extensions.
7794 @item ev6
7795 @itemx 21264
7796 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7798 @item ev67
7799 @itemx 21264a
7800 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7801 @end table
7803 @item -mtune=@var{cpu_type}
7804 @opindex mtune
7805 Set only the instruction scheduling parameters for machine type
7806 @var{cpu_type}.  The instruction set is not changed.
7808 @item -mmemory-latency=@var{time}
7809 @opindex mmemory-latency
7810 Sets the latency the scheduler should assume for typical memory
7811 references as seen by the application.  This number is highly
7812 dependent on the memory access patterns used by the application
7813 and the size of the external cache on the machine.
7815 Valid options for @var{time} are
7817 @table @samp
7818 @item @var{number}
7819 A decimal number representing clock cycles.
7821 @item L1
7822 @itemx L2
7823 @itemx L3
7824 @itemx main
7825 The compiler contains estimates of the number of clock cycles for
7826 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7827 (also called Dcache, Scache, and Bcache), as well as to main memory.
7828 Note that L3 is only valid for EV5.
7830 @end table
7831 @end table
7833 @node DEC Alpha/VMS Options
7834 @subsection DEC Alpha/VMS Options
7836 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7838 @table @gcctabopt
7839 @item -mvms-return-codes
7840 @opindex mvms-return-codes
7841 Return VMS condition codes from main.  The default is to return POSIX
7842 style condition (e.g.@ error) codes.
7843 @end table
7845 @node FRV Options
7846 @subsection FRV Options
7847 @cindex FRV Options
7849 @table @gcctabopt
7850 @item -mgpr-32
7851 @opindex mgpr-32
7853 Only use the first 32 general purpose registers.
7855 @item -mgpr-64
7856 @opindex mgpr-64
7858 Use all 64 general purpose registers.
7860 @item -mfpr-32
7861 @opindex mfpr-32
7863 Use only the first 32 floating point registers.
7865 @item -mfpr-64
7866 @opindex mfpr-64
7868 Use all 64 floating point registers
7870 @item -mhard-float
7871 @opindex mhard-float
7873 Use hardware instructions for floating point operations.
7875 @item -msoft-float
7876 @opindex msoft-float
7878 Use library routines for floating point operations.
7880 @item -malloc-cc
7881 @opindex malloc-cc
7883 Dynamically allocate condition code registers.
7885 @item -mfixed-cc
7886 @opindex mfixed-cc
7888 Do not try to dynamically allocate condition code registers, only
7889 use @code{icc0} and @code{fcc0}.
7891 @item -mdword
7892 @opindex mdword
7894 Change ABI to use double word insns.
7896 @item -mno-dword
7897 @opindex mno-dword
7899 Do not use double word instructions.
7901 @item -mdouble
7902 @opindex mdouble
7904 Use floating point double instructions.
7906 @item -mno-double
7907 @opindex mno-double
7909 Do not use floating point double instructions.
7911 @item -mmedia
7912 @opindex mmedia
7914 Use media instructions.
7916 @item -mno-media
7917 @opindex mno-media
7919 Do not use media instructions.
7921 @item -mmuladd
7922 @opindex mmuladd
7924 Use multiply and add/subtract instructions.
7926 @item -mno-muladd
7927 @opindex mno-muladd
7929 Do not use multiply and add/subtract instructions.
7931 @item -mfdpic
7932 @opindex mfdpic
7934 Select the FDPIC ABI, that uses function descriptors to represent
7935 pointers to functions.  Without any PIC/PIE-related options, it
7936 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7937 assumes GOT entries and small data are within a 12-bit range from the
7938 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7939 are computed with 32 bits.
7941 @item -minline-plt
7942 @opindex minline-plt
7944 Enable inlining of PLT entries in function calls to functions that are
7945 not known to bind locally.  It has no effect without @option{-mfdpic}.
7946 It's enabled by default if optimizing for speed and compiling for
7947 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7948 optimization option such as @option{-O3} or above is present in the
7949 command line.
7951 @item -mTLS
7952 @opindex TLS
7954 Assume a large TLS segment when generating thread-local code.
7956 @item -mtls
7957 @opindex tls
7959 Do not assume a large TLS segment when generating thread-local code.
7961 @item -mgprel-ro
7962 @opindex mgprel-ro
7964 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7965 that is known to be in read-only sections.  It's enabled by default,
7966 except for @option{-fpic} or @option{-fpie}: even though it may help
7967 make the global offset table smaller, it trades 1 instruction for 4.
7968 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7969 one of which may be shared by multiple symbols, and it avoids the need
7970 for a GOT entry for the referenced symbol, so it's more likely to be a
7971 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7973 @item -multilib-library-pic
7974 @opindex multilib-library-pic
7976 Link with the (library, not FD) pic libraries.  It's implied by
7977 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7978 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7979 it explicitly.
7981 @item -mlinked-fp
7982 @opindex mlinked-fp
7984 Follow the EABI requirement of always creating a frame pointer whenever
7985 a stack frame is allocated.  This option is enabled by default and can
7986 be disabled with @option{-mno-linked-fp}.
7988 @item -mlong-calls
7989 @opindex mlong-calls
7991 Use indirect addressing to call functions outside the current
7992 compilation unit.  This allows the functions to be placed anywhere
7993 within the 32-bit address space.
7995 @item -malign-labels
7996 @opindex malign-labels
7998 Try to align labels to an 8-byte boundary by inserting nops into the
7999 previous packet.  This option only has an effect when VLIW packing
8000 is enabled.  It doesn't create new packets; it merely adds nops to
8001 existing ones.
8003 @item -mlibrary-pic
8004 @opindex mlibrary-pic
8006 Generate position-independent EABI code.
8008 @item -macc-4
8009 @opindex macc-4
8011 Use only the first four media accumulator registers.
8013 @item -macc-8
8014 @opindex macc-8
8016 Use all eight media accumulator registers.
8018 @item -mpack
8019 @opindex mpack
8021 Pack VLIW instructions.
8023 @item -mno-pack
8024 @opindex mno-pack
8026 Do not pack VLIW instructions.
8028 @item -mno-eflags
8029 @opindex mno-eflags
8031 Do not mark ABI switches in e_flags.
8033 @item -mcond-move
8034 @opindex mcond-move
8036 Enable the use of conditional-move instructions (default).
8038 This switch is mainly for debugging the compiler and will likely be removed
8039 in a future version.
8041 @item -mno-cond-move
8042 @opindex mno-cond-move
8044 Disable the use of conditional-move instructions.
8046 This switch is mainly for debugging the compiler and will likely be removed
8047 in a future version.
8049 @item -mscc
8050 @opindex mscc
8052 Enable the use of conditional set instructions (default).
8054 This switch is mainly for debugging the compiler and will likely be removed
8055 in a future version.
8057 @item -mno-scc
8058 @opindex mno-scc
8060 Disable the use of conditional set instructions.
8062 This switch is mainly for debugging the compiler and will likely be removed
8063 in a future version.
8065 @item -mcond-exec
8066 @opindex mcond-exec
8068 Enable the use of conditional execution (default).
8070 This switch is mainly for debugging the compiler and will likely be removed
8071 in a future version.
8073 @item -mno-cond-exec
8074 @opindex mno-cond-exec
8076 Disable the use of conditional execution.
8078 This switch is mainly for debugging the compiler and will likely be removed
8079 in a future version.
8081 @item -mvliw-branch
8082 @opindex mvliw-branch
8084 Run a pass to pack branches into VLIW instructions (default).
8086 This switch is mainly for debugging the compiler and will likely be removed
8087 in a future version.
8089 @item -mno-vliw-branch
8090 @opindex mno-vliw-branch
8092 Do not run a pass to pack branches into VLIW instructions.
8094 This switch is mainly for debugging the compiler and will likely be removed
8095 in a future version.
8097 @item -mmulti-cond-exec
8098 @opindex mmulti-cond-exec
8100 Enable optimization of @code{&&} and @code{||} in conditional execution
8101 (default).
8103 This switch is mainly for debugging the compiler and will likely be removed
8104 in a future version.
8106 @item -mno-multi-cond-exec
8107 @opindex mno-multi-cond-exec
8109 Disable optimization of @code{&&} and @code{||} in conditional execution.
8111 This switch is mainly for debugging the compiler and will likely be removed
8112 in a future version.
8114 @item -mnested-cond-exec
8115 @opindex mnested-cond-exec
8117 Enable nested conditional execution optimizations (default).
8119 This switch is mainly for debugging the compiler and will likely be removed
8120 in a future version.
8122 @item -mno-nested-cond-exec
8123 @opindex mno-nested-cond-exec
8125 Disable nested conditional execution optimizations.
8127 This switch is mainly for debugging the compiler and will likely be removed
8128 in a future version.
8130 @item -mtomcat-stats
8131 @opindex mtomcat-stats
8133 Cause gas to print out tomcat statistics.
8135 @item -mcpu=@var{cpu}
8136 @opindex mcpu
8138 Select the processor type for which to generate code.  Possible values are
8139 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8140 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8142 @end table
8144 @node H8/300 Options
8145 @subsection H8/300 Options
8147 These @samp{-m} options are defined for the H8/300 implementations:
8149 @table @gcctabopt
8150 @item -mrelax
8151 @opindex mrelax
8152 Shorten some address references at link time, when possible; uses the
8153 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8154 ld, Using ld}, for a fuller description.
8156 @item -mh
8157 @opindex mh
8158 Generate code for the H8/300H@.
8160 @item -ms
8161 @opindex ms
8162 Generate code for the H8S@.
8164 @item -mn
8165 @opindex mn
8166 Generate code for the H8S and H8/300H in the normal mode.  This switch
8167 must be used either with @option{-mh} or @option{-ms}.
8169 @item -ms2600
8170 @opindex ms2600
8171 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8173 @item -mint32
8174 @opindex mint32
8175 Make @code{int} data 32 bits by default.
8177 @item -malign-300
8178 @opindex malign-300
8179 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8180 The default for the H8/300H and H8S is to align longs and floats on 4
8181 byte boundaries.
8182 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8183 This option has no effect on the H8/300.
8184 @end table
8186 @node HPPA Options
8187 @subsection HPPA Options
8188 @cindex HPPA Options
8190 These @samp{-m} options are defined for the HPPA family of computers:
8192 @table @gcctabopt
8193 @item -march=@var{architecture-type}
8194 @opindex march
8195 Generate code for the specified architecture.  The choices for
8196 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8197 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8198 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8199 architecture option for your machine.  Code compiled for lower numbered
8200 architectures will run on higher numbered architectures, but not the
8201 other way around.
8203 @item -mpa-risc-1-0
8204 @itemx -mpa-risc-1-1
8205 @itemx -mpa-risc-2-0
8206 @opindex mpa-risc-1-0
8207 @opindex mpa-risc-1-1
8208 @opindex mpa-risc-2-0
8209 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8211 @item -mbig-switch
8212 @opindex mbig-switch
8213 Generate code suitable for big switch tables.  Use this option only if
8214 the assembler/linker complain about out of range branches within a switch
8215 table.
8217 @item -mjump-in-delay
8218 @opindex mjump-in-delay
8219 Fill delay slots of function calls with unconditional jump instructions
8220 by modifying the return pointer for the function call to be the target
8221 of the conditional jump.
8223 @item -mdisable-fpregs
8224 @opindex mdisable-fpregs
8225 Prevent floating point registers from being used in any manner.  This is
8226 necessary for compiling kernels which perform lazy context switching of
8227 floating point registers.  If you use this option and attempt to perform
8228 floating point operations, the compiler will abort.
8230 @item -mdisable-indexing
8231 @opindex mdisable-indexing
8232 Prevent the compiler from using indexing address modes.  This avoids some
8233 rather obscure problems when compiling MIG generated code under MACH@.
8235 @item -mno-space-regs
8236 @opindex mno-space-regs
8237 Generate code that assumes the target has no space registers.  This allows
8238 GCC to generate faster indirect calls and use unscaled index address modes.
8240 Such code is suitable for level 0 PA systems and kernels.
8242 @item -mfast-indirect-calls
8243 @opindex mfast-indirect-calls
8244 Generate code that assumes calls never cross space boundaries.  This
8245 allows GCC to emit code which performs faster indirect calls.
8247 This option will not work in the presence of shared libraries or nested
8248 functions.
8250 @item -mfixed-range=@var{register-range}
8251 @opindex mfixed-range
8252 Generate code treating the given register range as fixed registers.
8253 A fixed register is one that the register allocator can not use.  This is
8254 useful when compiling kernel code.  A register range is specified as
8255 two registers separated by a dash.  Multiple register ranges can be
8256 specified separated by a comma.
8258 @item -mlong-load-store
8259 @opindex mlong-load-store
8260 Generate 3-instruction load and store sequences as sometimes required by
8261 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8262 the HP compilers.
8264 @item -mportable-runtime
8265 @opindex mportable-runtime
8266 Use the portable calling conventions proposed by HP for ELF systems.
8268 @item -mgas
8269 @opindex mgas
8270 Enable the use of assembler directives only GAS understands.
8272 @item -mschedule=@var{cpu-type}
8273 @opindex mschedule
8274 Schedule code according to the constraints for the machine type
8275 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8276 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8277 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8278 proper scheduling option for your machine.  The default scheduling is
8279 @samp{8000}.
8281 @item -mlinker-opt
8282 @opindex mlinker-opt
8283 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8284 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8285 linkers in which they give bogus error messages when linking some programs.
8287 @item -msoft-float
8288 @opindex msoft-float
8289 Generate output containing library calls for floating point.
8290 @strong{Warning:} the requisite libraries are not available for all HPPA
8291 targets.  Normally the facilities of the machine's usual C compiler are
8292 used, but this cannot be done directly in cross-compilation.  You must make
8293 your own arrangements to provide suitable library functions for
8294 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8295 does provide software floating point support.
8297 @option{-msoft-float} changes the calling convention in the output file;
8298 therefore, it is only useful if you compile @emph{all} of a program with
8299 this option.  In particular, you need to compile @file{libgcc.a}, the
8300 library that comes with GCC, with @option{-msoft-float} in order for
8301 this to work.
8303 @item -msio
8304 @opindex msio
8305 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8306 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8307 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8308 options are available under HP-UX and HI-UX@.
8310 @item -mgnu-ld
8311 @opindex gnu-ld
8312 Use GNU ld specific options.  This passes @option{-shared} to ld when
8313 building a shared library.  It is the default when GCC is configured,
8314 explicitly or implicitly, with the GNU linker.  This option does not
8315 have any affect on which ld is called, it only changes what parameters
8316 are passed to that ld.  The ld that is called is determined by the
8317 @option{--with-ld} configure option, GCC's program search path, and
8318 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8319 using @samp{which `gcc -print-prog-name=ld`}.
8321 @item -mhp-ld
8322 @opindex hp-ld
8323 Use HP ld specific options.  This passes @option{-b} to ld when building
8324 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8325 links.  It is the default when GCC is configured, explicitly or
8326 implicitly, with the HP linker.  This option does not have any affect on
8327 which ld is called, it only changes what parameters are passed to that
8328 ld.  The ld that is called is determined by the @option{--with-ld}
8329 configure option, GCC's program search path, and finally by the user's
8330 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8331 `gcc -print-prog-name=ld`}.
8333 @item -mlong-calls
8334 @opindex mno-long-calls
8335 Generate code that uses long call sequences.  This ensures that a call
8336 is always able to reach linker generated stubs.  The default is to generate
8337 long calls only when the distance from the call site to the beginning
8338 of the function or translation unit, as the case may be, exceeds a
8339 predefined limit set by the branch type being used.  The limits for
8340 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8341 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8342 240,000 bytes.
8344 Distances are measured from the beginning of functions when using the
8345 @option{-ffunction-sections} option, or when using the @option{-mgas}
8346 and @option{-mno-portable-runtime} options together under HP-UX with
8347 the SOM linker.
8349 It is normally not desirable to use this option as it will degrade
8350 performance.  However, it may be useful in large applications,
8351 particularly when partial linking is used to build the application.
8353 The types of long calls used depends on the capabilities of the
8354 assembler and linker, and the type of code being generated.  The
8355 impact on systems that support long absolute calls, and long pic
8356 symbol-difference or pc-relative calls should be relatively small.
8357 However, an indirect call is used on 32-bit ELF systems in pic code
8358 and it is quite long.
8360 @item -munix=@var{unix-std}
8361 @opindex march
8362 Generate compiler predefines and select a startfile for the specified
8363 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8364 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8365 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8366 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8367 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8368 and later.
8370 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8371 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8372 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8373 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8374 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8375 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8377 It is @emph{important} to note that this option changes the interfaces
8378 for various library routines.  It also affects the operational behavior
8379 of the C library.  Thus, @emph{extreme} care is needed in using this
8380 option.
8382 Library code that is intended to operate with more than one UNIX
8383 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8384 as appropriate.  Most GNU software doesn't provide this capability.
8386 @item -nolibdld
8387 @opindex nolibdld
8388 Suppress the generation of link options to search libdld.sl when the
8389 @option{-static} option is specified on HP-UX 10 and later.
8391 @item -static
8392 @opindex static
8393 The HP-UX implementation of setlocale in libc has a dependency on
8394 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8395 when the @option{-static} option is specified, special link options
8396 are needed to resolve this dependency.
8398 On HP-UX 10 and later, the GCC driver adds the necessary options to
8399 link with libdld.sl when the @option{-static} option is specified.
8400 This causes the resulting binary to be dynamic.  On the 64-bit port,
8401 the linkers generate dynamic binaries by default in any case.  The
8402 @option{-nolibdld} option can be used to prevent the GCC driver from
8403 adding these link options.
8405 @item -threads
8406 @opindex threads
8407 Add support for multithreading with the @dfn{dce thread} library
8408 under HP-UX@.  This option sets flags for both the preprocessor and
8409 linker.
8410 @end table
8412 @node i386 and x86-64 Options
8413 @subsection Intel 386 and AMD x86-64 Options
8414 @cindex i386 Options
8415 @cindex x86-64 Options
8416 @cindex Intel 386 Options
8417 @cindex AMD x86-64 Options
8419 These @samp{-m} options are defined for the i386 and x86-64 family of
8420 computers:
8422 @table @gcctabopt
8423 @item -mtune=@var{cpu-type}
8424 @opindex mtune
8425 Tune to @var{cpu-type} everything applicable about the generated code, except
8426 for the ABI and the set of available instructions.  The choices for
8427 @var{cpu-type} are:
8428 @table @emph
8429 @item i386
8430 Original Intel's i386 CPU@.
8431 @item i486
8432 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8433 @item i586, pentium
8434 Intel Pentium CPU with no MMX support.
8435 @item pentium-mmx
8436 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8437 @item i686, pentiumpro
8438 Intel PentiumPro CPU@.
8439 @item pentium2
8440 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8441 @item pentium3, pentium3m
8442 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8443 support.
8444 @item pentium-m
8445 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8446 support.  Used by Centrino notebooks.
8447 @item pentium4, pentium4m
8448 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8449 @item prescott
8450 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8451 set support.
8452 @item nocona
8453 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8454 SSE2 and SSE3 instruction set support.
8455 @item k6
8456 AMD K6 CPU with MMX instruction set support.
8457 @item k6-2, k6-3
8458 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8459 @item athlon, athlon-tbird
8460 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8461 support.
8462 @item athlon-4, athlon-xp, athlon-mp
8463 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8464 instruction set support.
8465 @item k8, opteron, athlon64, athlon-fx
8466 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8467 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8468 @item winchip-c6
8469 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8470 set support.
8471 @item winchip2
8472 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8473 instruction set support.
8474 @item c3
8475 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8476 implemented for this chip.)
8477 @item c3-2
8478 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8479 implemented for this chip.)
8480 @end table
8482 While picking a specific @var{cpu-type} will schedule things appropriately
8483 for that particular chip, the compiler will not generate any code that
8484 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8485 being used.
8487 @item -march=@var{cpu-type}
8488 @opindex march
8489 Generate instructions for the machine type @var{cpu-type}.  The choices
8490 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8491 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8493 @item -mcpu=@var{cpu-type}
8494 @opindex mcpu
8495 A deprecated synonym for @option{-mtune}.
8497 @item -m386
8498 @itemx -m486
8499 @itemx -mpentium
8500 @itemx -mpentiumpro
8501 @opindex m386
8502 @opindex m486
8503 @opindex mpentium
8504 @opindex mpentiumpro
8505 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8506 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8507 These synonyms are deprecated.
8509 @item -mfpmath=@var{unit}
8510 @opindex march
8511 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8512 for @var{unit} are:
8514 @table @samp
8515 @item 387
8516 Use the standard 387 floating point coprocessor present majority of chips and
8517 emulated otherwise.  Code compiled with this option will run almost everywhere.
8518 The temporary results are computed in 80bit precision instead of precision
8519 specified by the type resulting in slightly different results compared to most
8520 of other chips.  See @option{-ffloat-store} for more detailed description.
8522 This is the default choice for i386 compiler.
8524 @item sse
8525 Use scalar floating point instructions present in the SSE instruction set.
8526 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8527 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8528 instruction set supports only single precision arithmetics, thus the double and
8529 extended precision arithmetics is still done using 387.  Later version, present
8530 only in Pentium4 and the future AMD x86-64 chips supports double precision
8531 arithmetics too.
8533 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8534 or @option{-msse2} switches to enable SSE extensions and make this option
8535 effective.  For the x86-64 compiler, these extensions are enabled by default.
8537 The resulting code should be considerably faster in the majority of cases and avoid
8538 the numerical instability problems of 387 code, but may break some existing
8539 code that expects temporaries to be 80bit.
8541 This is the default choice for the x86-64 compiler.
8543 @item sse,387
8544 Attempt to utilize both instruction sets at once.  This effectively double the
8545 amount of available registers and on chips with separate execution units for
8546 387 and SSE the execution resources too.  Use this option with care, as it is
8547 still experimental, because the GCC register allocator does not model separate
8548 functional units well resulting in instable performance.
8549 @end table
8551 @item -masm=@var{dialect}
8552 @opindex masm=@var{dialect}
8553 Output asm instructions using selected @var{dialect}.  Supported choices are
8554 @samp{intel} or @samp{att} (the default one).
8556 @item -mieee-fp
8557 @itemx -mno-ieee-fp
8558 @opindex mieee-fp
8559 @opindex mno-ieee-fp
8560 Control whether or not the compiler uses IEEE floating point
8561 comparisons.  These handle correctly the case where the result of a
8562 comparison is unordered.
8564 @item -msoft-float
8565 @opindex msoft-float
8566 Generate output containing library calls for floating point.
8567 @strong{Warning:} the requisite libraries are not part of GCC@.
8568 Normally the facilities of the machine's usual C compiler are used, but
8569 this can't be done directly in cross-compilation.  You must make your
8570 own arrangements to provide suitable library functions for
8571 cross-compilation.
8573 On machines where a function returns floating point results in the 80387
8574 register stack, some floating point opcodes may be emitted even if
8575 @option{-msoft-float} is used.
8577 @item -mno-fp-ret-in-387
8578 @opindex mno-fp-ret-in-387
8579 Do not use the FPU registers for return values of functions.
8581 The usual calling convention has functions return values of types
8582 @code{float} and @code{double} in an FPU register, even if there
8583 is no FPU@.  The idea is that the operating system should emulate
8584 an FPU@.
8586 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8587 in ordinary CPU registers instead.
8589 @item -mno-fancy-math-387
8590 @opindex mno-fancy-math-387
8591 Some 387 emulators do not support the @code{sin}, @code{cos} and
8592 @code{sqrt} instructions for the 387.  Specify this option to avoid
8593 generating those instructions.  This option is the default on FreeBSD,
8594 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8595 indicates that the target cpu will always have an FPU and so the
8596 instruction will not need emulation.  As of revision 2.6.1, these
8597 instructions are not generated unless you also use the
8598 @option{-funsafe-math-optimizations} switch.
8600 @item -malign-double
8601 @itemx -mno-align-double
8602 @opindex malign-double
8603 @opindex mno-align-double
8604 Control whether GCC aligns @code{double}, @code{long double}, and
8605 @code{long long} variables on a two word boundary or a one word
8606 boundary.  Aligning @code{double} variables on a two word boundary will
8607 produce code that runs somewhat faster on a @samp{Pentium} at the
8608 expense of more memory.
8610 @strong{Warning:} if you use the @option{-malign-double} switch,
8611 structures containing the above types will be aligned differently than
8612 the published application binary interface specifications for the 386
8613 and will not be binary compatible with structures in code compiled
8614 without that switch.
8616 @item -m96bit-long-double
8617 @itemx -m128bit-long-double
8618 @opindex m96bit-long-double
8619 @opindex m128bit-long-double
8620 These switches control the size of @code{long double} type.  The i386
8621 application binary interface specifies the size to be 96 bits,
8622 so @option{-m96bit-long-double} is the default in 32 bit mode.
8624 Modern architectures (Pentium and newer) would prefer @code{long double}
8625 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8626 conforming to the ABI, this would not be possible.  So specifying a
8627 @option{-m128bit-long-double} will align @code{long double}
8628 to a 16 byte boundary by padding the @code{long double} with an additional
8629 32 bit zero.
8631 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8632 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8634 Notice that neither of these options enable any extra precision over the x87
8635 standard of 80 bits for a @code{long double}.
8637 @strong{Warning:} if you override the default value for your target ABI, the
8638 structures and arrays containing @code{long double} variables will change
8639 their size as well as function calling convention for function taking
8640 @code{long double} will be modified.  Hence they will not be binary
8641 compatible with arrays or structures in code compiled without that switch.
8644 @item -msvr3-shlib
8645 @itemx -mno-svr3-shlib
8646 @opindex msvr3-shlib
8647 @opindex mno-svr3-shlib
8648 Control whether GCC places uninitialized local variables into the
8649 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8650 into @code{bss}.  These options are meaningful only on System V Release 3.
8652 @item -mrtd
8653 @opindex mrtd
8654 Use a different function-calling convention, in which functions that
8655 take a fixed number of arguments return with the @code{ret} @var{num}
8656 instruction, which pops their arguments while returning.  This saves one
8657 instruction in the caller since there is no need to pop the arguments
8658 there.
8660 You can specify that an individual function is called with this calling
8661 sequence with the function attribute @samp{stdcall}.  You can also
8662 override the @option{-mrtd} option by using the function attribute
8663 @samp{cdecl}.  @xref{Function Attributes}.
8665 @strong{Warning:} this calling convention is incompatible with the one
8666 normally used on Unix, so you cannot use it if you need to call
8667 libraries compiled with the Unix compiler.
8669 Also, you must provide function prototypes for all functions that
8670 take variable numbers of arguments (including @code{printf});
8671 otherwise incorrect code will be generated for calls to those
8672 functions.
8674 In addition, seriously incorrect code will result if you call a
8675 function with too many arguments.  (Normally, extra arguments are
8676 harmlessly ignored.)
8678 @item -mregparm=@var{num}
8679 @opindex mregparm
8680 Control how many registers are used to pass integer arguments.  By
8681 default, no registers are used to pass arguments, and at most 3
8682 registers can be used.  You can control this behavior for a specific
8683 function by using the function attribute @samp{regparm}.
8684 @xref{Function Attributes}.
8686 @strong{Warning:} if you use this switch, and
8687 @var{num} is nonzero, then you must build all modules with the same
8688 value, including any libraries.  This includes the system libraries and
8689 startup modules.
8691 @item -mpreferred-stack-boundary=@var{num}
8692 @opindex mpreferred-stack-boundary
8693 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8694 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8695 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8696 size (@option{-Os}), in which case the default is the minimum correct
8697 alignment (4 bytes for x86, and 8 bytes for x86-64).
8699 On Pentium and PentiumPro, @code{double} and @code{long double} values
8700 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8701 suffer significant run time performance penalties.  On Pentium III, the
8702 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8703 penalties if it is not 16 byte aligned.
8705 To ensure proper alignment of this values on the stack, the stack boundary
8706 must be as aligned as that required by any value stored on the stack.
8707 Further, every function must be generated such that it keeps the stack
8708 aligned.  Thus calling a function compiled with a higher preferred
8709 stack boundary from a function compiled with a lower preferred stack
8710 boundary will most likely misalign the stack.  It is recommended that
8711 libraries that use callbacks always use the default setting.
8713 This extra alignment does consume extra stack space, and generally
8714 increases code size.  Code that is sensitive to stack space usage, such
8715 as embedded systems and operating system kernels, may want to reduce the
8716 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8718 @item -mmmx
8719 @itemx -mno-mmx
8720 @item -msse
8721 @itemx -mno-sse
8722 @item -msse2
8723 @itemx -mno-sse2
8724 @item -msse3
8725 @itemx -mno-sse3
8726 @item -m3dnow
8727 @itemx -mno-3dnow
8728 @opindex mmmx
8729 @opindex mno-mmx
8730 @opindex msse
8731 @opindex mno-sse
8732 @opindex m3dnow
8733 @opindex mno-3dnow
8734 These switches enable or disable the use of built-in functions that allow
8735 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8736 instruction set.
8738 @xref{X86 Built-in Functions}, for details of the functions enabled
8739 and disabled by these switches.
8741 To have SSE/SSE2 instructions generated automatically from floating-point
8742 code, see @option{-mfpmath=sse}.
8744 @item -mpush-args
8745 @itemx -mno-push-args
8746 @opindex mpush-args
8747 @opindex mno-push-args
8748 Use PUSH operations to store outgoing parameters.  This method is shorter
8749 and usually equally fast as method using SUB/MOV operations and is enabled
8750 by default.  In some cases disabling it may improve performance because of
8751 improved scheduling and reduced dependencies.
8753 @item -maccumulate-outgoing-args
8754 @opindex maccumulate-outgoing-args
8755 If enabled, the maximum amount of space required for outgoing arguments will be
8756 computed in the function prologue.  This is faster on most modern CPUs
8757 because of reduced dependencies, improved scheduling and reduced stack usage
8758 when preferred stack boundary is not equal to 2.  The drawback is a notable
8759 increase in code size.  This switch implies @option{-mno-push-args}.
8761 @item -mthreads
8762 @opindex mthreads
8763 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8764 on thread-safe exception handling must compile and link all code with the
8765 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8766 @option{-D_MT}; when linking, it links in a special thread helper library
8767 @option{-lmingwthrd} which cleans up per thread exception handling data.
8769 @item -mno-align-stringops
8770 @opindex mno-align-stringops
8771 Do not align destination of inlined string operations.  This switch reduces
8772 code size and improves performance in case the destination is already aligned,
8773 but GCC doesn't know about it.
8775 @item -minline-all-stringops
8776 @opindex minline-all-stringops
8777 By default GCC inlines string operations only when destination is known to be
8778 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8779 size, but may improve performance of code that depends on fast memcpy, strlen
8780 and memset for short lengths.
8782 @item -momit-leaf-frame-pointer
8783 @opindex momit-leaf-frame-pointer
8784 Don't keep the frame pointer in a register for leaf functions.  This
8785 avoids the instructions to save, set up and restore frame pointers and
8786 makes an extra register available in leaf functions.  The option
8787 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8788 which might make debugging harder.
8790 @item -mtls-direct-seg-refs
8791 @itemx -mno-tls-direct-seg-refs
8792 @opindex mtls-direct-seg-refs
8793 Controls whether TLS variables may be accessed with offsets from the
8794 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8795 or whether the thread base pointer must be added.  Whether or not this
8796 is legal depends on the operating system, and whether it maps the
8797 segment to cover the entire TLS area.
8799 For systems that use GNU libc, the default is on.
8800 @end table
8802 These @samp{-m} switches are supported in addition to the above
8803 on AMD x86-64 processors in 64-bit environments.
8805 @table @gcctabopt
8806 @item -m32
8807 @itemx -m64
8808 @opindex m32
8809 @opindex m64
8810 Generate code for a 32-bit or 64-bit environment.
8811 The 32-bit environment sets int, long and pointer to 32 bits and
8812 generates code that runs on any i386 system.
8813 The 64-bit environment sets int to 32 bits and long and pointer
8814 to 64 bits and generates code for AMD's x86-64 architecture.
8816 @item -mno-red-zone
8817 @opindex no-red-zone
8818 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8819 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8820 stack pointer that will not be modified by signal or interrupt handlers
8821 and therefore can be used for temporary data without adjusting the stack
8822 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8824 @item -mcmodel=small
8825 @opindex mcmodel=small
8826 Generate code for the small code model: the program and its symbols must
8827 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8828 Programs can be statically or dynamically linked.  This is the default
8829 code model.
8831 @item -mcmodel=kernel
8832 @opindex mcmodel=kernel
8833 Generate code for the kernel code model.  The kernel runs in the
8834 negative 2 GB of the address space.
8835 This model has to be used for Linux kernel code.
8837 @item -mcmodel=medium
8838 @opindex mcmodel=medium
8839 Generate code for the medium model: The program is linked in the lower 2
8840 GB of the address space but symbols can be located anywhere in the
8841 address space.  Programs can be statically or dynamically linked, but
8842 building of shared libraries are not supported with the medium model.
8844 @item -mcmodel=large
8845 @opindex mcmodel=large
8846 Generate code for the large model: This model makes no assumptions
8847 about addresses and sizes of sections.  Currently GCC does not implement
8848 this model.
8849 @end table
8851 @node IA-64 Options
8852 @subsection IA-64 Options
8853 @cindex IA-64 Options
8855 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8857 @table @gcctabopt
8858 @item -mbig-endian
8859 @opindex mbig-endian
8860 Generate code for a big endian target.  This is the default for HP-UX@.
8862 @item -mlittle-endian
8863 @opindex mlittle-endian
8864 Generate code for a little endian target.  This is the default for AIX5
8865 and GNU/Linux.
8867 @item -mgnu-as
8868 @itemx -mno-gnu-as
8869 @opindex mgnu-as
8870 @opindex mno-gnu-as
8871 Generate (or don't) code for the GNU assembler.  This is the default.
8872 @c Also, this is the default if the configure option @option{--with-gnu-as}
8873 @c is used.
8875 @item -mgnu-ld
8876 @itemx -mno-gnu-ld
8877 @opindex mgnu-ld
8878 @opindex mno-gnu-ld
8879 Generate (or don't) code for the GNU linker.  This is the default.
8880 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8881 @c is used.
8883 @item -mno-pic
8884 @opindex mno-pic
8885 Generate code that does not use a global pointer register.  The result
8886 is not position independent code, and violates the IA-64 ABI@.
8888 @item -mvolatile-asm-stop
8889 @itemx -mno-volatile-asm-stop
8890 @opindex mvolatile-asm-stop
8891 @opindex mno-volatile-asm-stop
8892 Generate (or don't) a stop bit immediately before and after volatile asm
8893 statements.
8895 @item -mregister-names
8896 @itemx -mno-register-names
8897 @opindex mregister-names
8898 @opindex mno-register-names
8899 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8900 the stacked registers.  This may make assembler output more readable.
8902 @item -mno-sdata
8903 @itemx -msdata
8904 @opindex mno-sdata
8905 @opindex msdata
8906 Disable (or enable) optimizations that use the small data section.  This may
8907 be useful for working around optimizer bugs.
8909 @item -mconstant-gp
8910 @opindex mconstant-gp
8911 Generate code that uses a single constant global pointer value.  This is
8912 useful when compiling kernel code.
8914 @item -mauto-pic
8915 @opindex mauto-pic
8916 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8917 This is useful when compiling firmware code.
8919 @item -minline-float-divide-min-latency
8920 @opindex minline-float-divide-min-latency
8921 Generate code for inline divides of floating point values
8922 using the minimum latency algorithm.
8924 @item -minline-float-divide-max-throughput
8925 @opindex minline-float-divide-max-throughput
8926 Generate code for inline divides of floating point values
8927 using the maximum throughput algorithm.
8929 @item -minline-int-divide-min-latency
8930 @opindex minline-int-divide-min-latency
8931 Generate code for inline divides of integer values
8932 using the minimum latency algorithm.
8934 @item -minline-int-divide-max-throughput
8935 @opindex minline-int-divide-max-throughput
8936 Generate code for inline divides of integer values
8937 using the maximum throughput algorithm.
8939 @item -minline-sqrt-min-latency
8940 @opindex minline-sqrt-min-latency
8941 Generate code for inline square roots
8942 using the minimum latency algorithm.
8944 @item -minline-sqrt-max-throughput
8945 @opindex minline-sqrt-max-throughput
8946 Generate code for inline square roots
8947 using the maximum throughput algorithm.
8949 @item -mno-dwarf2-asm
8950 @itemx -mdwarf2-asm
8951 @opindex mno-dwarf2-asm
8952 @opindex mdwarf2-asm
8953 Don't (or do) generate assembler code for the DWARF2 line number debugging
8954 info.  This may be useful when not using the GNU assembler.
8956 @item -mearly-stop-bits
8957 @itemx -mno-early-stop-bits
8958 @opindex mearly-stop-bits
8959 @opindex mno-early-stop-bits
8960 Allow stop bits to be placed earlier than immediately preceding the
8961 instruction that triggered the stop bit.  This can improve instruction
8962 scheduling, but does not always do so.
8964 @item -mfixed-range=@var{register-range}
8965 @opindex mfixed-range
8966 Generate code treating the given register range as fixed registers.
8967 A fixed register is one that the register allocator can not use.  This is
8968 useful when compiling kernel code.  A register range is specified as
8969 two registers separated by a dash.  Multiple register ranges can be
8970 specified separated by a comma.
8972 @item -mtls-size=@var{tls-size}
8973 @opindex mtls-size
8974 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
8977 @item -mtune-arch=@var{cpu-type}
8978 @opindex mtune-arch
8979 Tune the instruction scheduling for a particular CPU, Valid values are
8980 itanium, itanium1, merced, itanium2, and mckinley.
8982 @item -mt
8983 @itemx -pthread
8984 @opindex mt
8985 @opindex pthread
8986 Add support for multithreading using the POSIX threads library.  This
8987 option sets flags for both the preprocessor and linker.  It does
8988 not affect the thread safety of object code produced by the compiler or
8989 that of libraries supplied with it.  These are HP-UX specific flags.
8991 @item -milp32
8992 @itemx -mlp64
8993 @opindex milp32
8994 @opindex mlp64
8995 Generate code for a 32-bit or 64-bit environment.
8996 The 32-bit environment sets int, long and pointer to 32 bits.
8997 The 64-bit environment sets int to 32 bits and long and pointer
8998 to 64 bits.  These are HP-UX specific flags.
9000 @end table
9002 @node M32R/D Options
9003 @subsection M32R/D Options
9004 @cindex M32R/D options
9006 These @option{-m} options are defined for Renesas M32R/D architectures:
9008 @table @gcctabopt
9009 @item -m32r2
9010 @opindex m32r2
9011 Generate code for the M32R/2@.
9013 @item -m32rx
9014 @opindex m32rx
9015 Generate code for the M32R/X@.
9017 @item -m32r
9018 @opindex m32r
9019 Generate code for the M32R@.  This is the default.
9021 @item -mmodel=small
9022 @opindex mmodel=small
9023 Assume all objects live in the lower 16MB of memory (so that their addresses
9024 can be loaded with the @code{ld24} instruction), and assume all subroutines
9025 are reachable with the @code{bl} instruction.
9026 This is the default.
9028 The addressability of a particular object can be set with the
9029 @code{model} attribute.
9031 @item -mmodel=medium
9032 @opindex mmodel=medium
9033 Assume objects may be anywhere in the 32-bit address space (the compiler
9034 will generate @code{seth/add3} instructions to load their addresses), and
9035 assume all subroutines are reachable with the @code{bl} instruction.
9037 @item -mmodel=large
9038 @opindex mmodel=large
9039 Assume objects may be anywhere in the 32-bit address space (the compiler
9040 will generate @code{seth/add3} instructions to load their addresses), and
9041 assume subroutines may not be reachable with the @code{bl} instruction
9042 (the compiler will generate the much slower @code{seth/add3/jl}
9043 instruction sequence).
9045 @item -msdata=none
9046 @opindex msdata=none
9047 Disable use of the small data area.  Variables will be put into
9048 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9049 @code{section} attribute has been specified).
9050 This is the default.
9052 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9053 Objects may be explicitly put in the small data area with the
9054 @code{section} attribute using one of these sections.
9056 @item -msdata=sdata
9057 @opindex msdata=sdata
9058 Put small global and static data in the small data area, but do not
9059 generate special code to reference them.
9061 @item -msdata=use
9062 @opindex msdata=use
9063 Put small global and static data in the small data area, and generate
9064 special instructions to reference them.
9066 @item -G @var{num}
9067 @opindex G
9068 @cindex smaller data references
9069 Put global and static objects less than or equal to @var{num} bytes
9070 into the small data or bss sections instead of the normal data or bss
9071 sections.  The default value of @var{num} is 8.
9072 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9073 for this option to have any effect.
9075 All modules should be compiled with the same @option{-G @var{num}} value.
9076 Compiling with different values of @var{num} may or may not work; if it
9077 doesn't the linker will give an error message---incorrect code will not be
9078 generated.
9080 @item -mdebug
9081 @opindex mdebug
9082 Makes the M32R specific code in the compiler display some statistics
9083 that might help in debugging programs.
9085 @item -malign-loops
9086 @opindex malign-loops
9087 Align all loops to a 32-byte boundary.
9089 @item -mno-align-loops
9090 @opindex mno-align-loops
9091 Do not enforce a 32-byte alignment for loops.  This is the default.
9093 @item -missue-rate=@var{number}
9094 @opindex missue-rate=@var{number}
9095 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9096 or 2.
9098 @item -mbranch-cost=@var{number}
9099 @opindex mbranch-cost=@var{number}
9100 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9101 preferred over conditional code, if it is 2, then the opposite will
9102 apply.
9104 @item -mflush-trap=@var{number}
9105 @opindex mflush-trap=@var{number}
9106 Specifies the trap number to use to flush the cache.  The default is
9107 12.  Valid numbers are between 0 and 15 inclusive.
9109 @item -mno-flush-trap
9110 @opindex mno-flush-trap
9111 Specifies that the cache cannot be flushed by using a trap.
9113 @item -mflush-func=@var{name}
9114 @opindex mflush-func=@var{name}
9115 Specifies the name of the operating system function to call to flush
9116 the cache.  The default is @emph{_flush_cache}, but a function call
9117 will only be used if a trap is not available.
9119 @item -mno-flush-func
9120 @opindex mno-flush-func
9121 Indicates that there is no OS function for flushing the cache.
9123 @end table
9125 @node M680x0 Options
9126 @subsection M680x0 Options
9127 @cindex M680x0 options
9129 These are the @samp{-m} options defined for the 68000 series.  The default
9130 values for these options depends on which style of 68000 was selected when
9131 the compiler was configured; the defaults for the most common choices are
9132 given below.
9134 @table @gcctabopt
9135 @item -m68000
9136 @itemx -mc68000
9137 @opindex m68000
9138 @opindex mc68000
9139 Generate output for a 68000.  This is the default
9140 when the compiler is configured for 68000-based systems.
9142 Use this option for microcontrollers with a 68000 or EC000 core,
9143 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9145 @item -m68020
9146 @itemx -mc68020
9147 @opindex m68020
9148 @opindex mc68020
9149 Generate output for a 68020.  This is the default
9150 when the compiler is configured for 68020-based systems.
9152 @item -m68881
9153 @opindex m68881
9154 Generate output containing 68881 instructions for floating point.
9155 This is the default for most 68020 systems unless @option{--nfp} was
9156 specified when the compiler was configured.
9158 @item -m68030
9159 @opindex m68030
9160 Generate output for a 68030.  This is the default when the compiler is
9161 configured for 68030-based systems.
9163 @item -m68040
9164 @opindex m68040
9165 Generate output for a 68040.  This is the default when the compiler is
9166 configured for 68040-based systems.
9168 This option inhibits the use of 68881/68882 instructions that have to be
9169 emulated by software on the 68040.  Use this option if your 68040 does not
9170 have code to emulate those instructions.
9172 @item -m68060
9173 @opindex m68060
9174 Generate output for a 68060.  This is the default when the compiler is
9175 configured for 68060-based systems.
9177 This option inhibits the use of 68020 and 68881/68882 instructions that
9178 have to be emulated by software on the 68060.  Use this option if your 68060
9179 does not have code to emulate those instructions.
9181 @item -mcpu32
9182 @opindex mcpu32
9183 Generate output for a CPU32.  This is the default
9184 when the compiler is configured for CPU32-based systems.
9186 Use this option for microcontrollers with a
9187 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9188 68336, 68340, 68341, 68349 and 68360.
9190 @item -m5200
9191 @opindex m5200
9192 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9193 when the compiler is configured for 520X-based systems.
9195 Use this option for microcontroller with a 5200 core, including
9196 the MCF5202, MCF5203, MCF5204 and MCF5202.
9199 @item -m68020-40
9200 @opindex m68020-40
9201 Generate output for a 68040, without using any of the new instructions.
9202 This results in code which can run relatively efficiently on either a
9203 68020/68881 or a 68030 or a 68040.  The generated code does use the
9204 68881 instructions that are emulated on the 68040.
9206 @item -m68020-60
9207 @opindex m68020-60
9208 Generate output for a 68060, without using any of the new instructions.
9209 This results in code which can run relatively efficiently on either a
9210 68020/68881 or a 68030 or a 68040.  The generated code does use the
9211 68881 instructions that are emulated on the 68060.
9213 @item -msoft-float
9214 @opindex msoft-float
9215 Generate output containing library calls for floating point.
9216 @strong{Warning:} the requisite libraries are not available for all m68k
9217 targets.  Normally the facilities of the machine's usual C compiler are
9218 used, but this can't be done directly in cross-compilation.  You must
9219 make your own arrangements to provide suitable library functions for
9220 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9221 @samp{m68k-*-coff} do provide software floating point support.
9223 @item -mshort
9224 @opindex mshort
9225 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9226 Additionally, parameters passed on the stack are also aligned to a
9227 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9229 @item -mnobitfield
9230 @opindex mnobitfield
9231 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9232 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9234 @item -mbitfield
9235 @opindex mbitfield
9236 Do use the bit-field instructions.  The @option{-m68020} option implies
9237 @option{-mbitfield}.  This is the default if you use a configuration
9238 designed for a 68020.
9240 @item -mrtd
9241 @opindex mrtd
9242 Use a different function-calling convention, in which functions
9243 that take a fixed number of arguments return with the @code{rtd}
9244 instruction, which pops their arguments while returning.  This
9245 saves one instruction in the caller since there is no need to pop
9246 the arguments there.
9248 This calling convention is incompatible with the one normally
9249 used on Unix, so you cannot use it if you need to call libraries
9250 compiled with the Unix compiler.
9252 Also, you must provide function prototypes for all functions that
9253 take variable numbers of arguments (including @code{printf});
9254 otherwise incorrect code will be generated for calls to those
9255 functions.
9257 In addition, seriously incorrect code will result if you call a
9258 function with too many arguments.  (Normally, extra arguments are
9259 harmlessly ignored.)
9261 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9262 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9264 @item -malign-int
9265 @itemx -mno-align-int
9266 @opindex malign-int
9267 @opindex mno-align-int
9268 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9269 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9270 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9271 Aligning variables on 32-bit boundaries produces code that runs somewhat
9272 faster on processors with 32-bit busses at the expense of more memory.
9274 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9275 align structures containing the above types  differently than
9276 most published application binary interface specifications for the m68k.
9278 @item -mpcrel
9279 @opindex mpcrel
9280 Use the pc-relative addressing mode of the 68000 directly, instead of
9281 using a global offset table.  At present, this option implies @option{-fpic},
9282 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9283 not presently supported with @option{-mpcrel}, though this could be supported for
9284 68020 and higher processors.
9286 @item -mno-strict-align
9287 @itemx -mstrict-align
9288 @opindex mno-strict-align
9289 @opindex mstrict-align
9290 Do not (do) assume that unaligned memory references will be handled by
9291 the system.
9293 @item -msep-data
9294 Generate code that allows the data segment to be located in a different
9295 area of memory from the text segment.  This allows for execute in place in
9296 an environment without virtual memory management.  This option implies
9297 @option{-fPIC}.
9299 @item -mno-sep-data
9300 Generate code that assumes that the data segment follows the text segment.
9301 This is the default.
9303 @item -mid-shared-library
9304 Generate code that supports shared libraries via the library ID method.
9305 This allows for execute in place and shared libraries in an environment
9306 without virtual memory management.  This option implies @option{-fPIC}.
9308 @item -mno-id-shared-library
9309 Generate code that doesn't assume ID based shared libraries are being used.
9310 This is the default.
9312 @item -mshared-library-id=n
9313 Specified the identification number of the ID based shared library being
9314 compiled.  Specifying a value of 0 will generate more compact code, specifying
9315 other values will force the allocation of that number to the current
9316 library but is no more space or time efficient than omitting this option.
9318 @end table
9320 @node M68hc1x Options
9321 @subsection M68hc1x Options
9322 @cindex M68hc1x options
9324 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9325 microcontrollers.  The default values for these options depends on
9326 which style of microcontroller was selected when the compiler was configured;
9327 the defaults for the most common choices are given below.
9329 @table @gcctabopt
9330 @item -m6811
9331 @itemx -m68hc11
9332 @opindex m6811
9333 @opindex m68hc11
9334 Generate output for a 68HC11.  This is the default
9335 when the compiler is configured for 68HC11-based systems.
9337 @item -m6812
9338 @itemx -m68hc12
9339 @opindex m6812
9340 @opindex m68hc12
9341 Generate output for a 68HC12.  This is the default
9342 when the compiler is configured for 68HC12-based systems.
9344 @item -m68S12
9345 @itemx -m68hcs12
9346 @opindex m68S12
9347 @opindex m68hcs12
9348 Generate output for a 68HCS12.
9350 @item -mauto-incdec
9351 @opindex mauto-incdec
9352 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9353 addressing modes.
9355 @item -minmax
9356 @itemx -nominmax
9357 @opindex minmax
9358 @opindex mnominmax
9359 Enable the use of 68HC12 min and max instructions.
9361 @item -mlong-calls
9362 @itemx -mno-long-calls
9363 @opindex mlong-calls
9364 @opindex mno-long-calls
9365 Treat all calls as being far away (near).  If calls are assumed to be
9366 far away, the compiler will use the @code{call} instruction to
9367 call a function and the @code{rtc} instruction for returning.
9369 @item -mshort
9370 @opindex mshort
9371 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9373 @item -msoft-reg-count=@var{count}
9374 @opindex msoft-reg-count
9375 Specify the number of pseudo-soft registers which are used for the
9376 code generation.  The maximum number is 32.  Using more pseudo-soft
9377 register may or may not result in better code depending on the program.
9378 The default is 4 for 68HC11 and 2 for 68HC12.
9380 @end table
9382 @node MCore Options
9383 @subsection MCore Options
9384 @cindex MCore options
9386 These are the @samp{-m} options defined for the Motorola M*Core
9387 processors.
9389 @table @gcctabopt
9391 @item -mhardlit
9392 @itemx -mno-hardlit
9393 @opindex mhardlit
9394 @opindex mno-hardlit
9395 Inline constants into the code stream if it can be done in two
9396 instructions or less.
9398 @item -mdiv
9399 @itemx -mno-div
9400 @opindex mdiv
9401 @opindex mno-div
9402 Use the divide instruction.  (Enabled by default).
9404 @item -mrelax-immediate
9405 @itemx -mno-relax-immediate
9406 @opindex mrelax-immediate
9407 @opindex mno-relax-immediate
9408 Allow arbitrary sized immediates in bit operations.
9410 @item -mwide-bitfields
9411 @itemx -mno-wide-bitfields
9412 @opindex mwide-bitfields
9413 @opindex mno-wide-bitfields
9414 Always treat bit-fields as int-sized.
9416 @item -m4byte-functions
9417 @itemx -mno-4byte-functions
9418 @opindex m4byte-functions
9419 @opindex mno-4byte-functions
9420 Force all functions to be aligned to a four byte boundary.
9422 @item -mcallgraph-data
9423 @itemx -mno-callgraph-data
9424 @opindex mcallgraph-data
9425 @opindex mno-callgraph-data
9426 Emit callgraph information.
9428 @item -mslow-bytes
9429 @itemx -mno-slow-bytes
9430 @opindex mslow-bytes
9431 @opindex mno-slow-bytes
9432 Prefer word access when reading byte quantities.
9434 @item -mlittle-endian
9435 @itemx -mbig-endian
9436 @opindex mlittle-endian
9437 @opindex mbig-endian
9438 Generate code for a little endian target.
9440 @item -m210
9441 @itemx -m340
9442 @opindex m210
9443 @opindex m340
9444 Generate code for the 210 processor.
9445 @end table
9447 @node MIPS Options
9448 @subsection MIPS Options
9449 @cindex MIPS options
9451 @table @gcctabopt
9453 @item -EB
9454 @opindex EB
9455 Generate big-endian code.
9457 @item -EL
9458 @opindex EL
9459 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9460 configurations.
9462 @item -march=@var{arch}
9463 @opindex march
9464 Generate code that will run on @var{arch}, which can be the name of a
9465 generic MIPS ISA, or the name of a particular processor.
9466 The ISA names are:
9467 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9468 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9469 The processor names are:
9470 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9471 @samp{m4k},
9472 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9473 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9474 @samp{rm9000},
9475 @samp{orion},
9476 @samp{sb1},
9477 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9478 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9479 The special value @samp{from-abi} selects the
9480 most compatible architecture for the selected ABI (that is,
9481 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9483 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9484 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9485 @samp{vr} may be written @samp{r}.
9487 GCC defines two macros based on the value of this option.  The first
9488 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9489 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9490 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9491 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9492 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9494 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9495 above.  In other words, it will have the full prefix and will not
9496 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9497 the macro names the resolved architecture (either @samp{"mips1"} or
9498 @samp{"mips3"}).  It names the default architecture when no
9499 @option{-march} option is given.
9501 @item -mtune=@var{arch}
9502 @opindex mtune
9503 Optimize for @var{arch}.  Among other things, this option controls
9504 the way instructions are scheduled, and the perceived cost of arithmetic
9505 operations.  The list of @var{arch} values is the same as for
9506 @option{-march}.
9508 When this option is not used, GCC will optimize for the processor
9509 specified by @option{-march}.  By using @option{-march} and
9510 @option{-mtune} together, it is possible to generate code that will
9511 run on a family of processors, but optimize the code for one
9512 particular member of that family.
9514 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9515 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9516 @samp{-march} ones described above.
9518 @item -mips1
9519 @opindex mips1
9520 Equivalent to @samp{-march=mips1}.
9522 @item -mips2
9523 @opindex mips2
9524 Equivalent to @samp{-march=mips2}.
9526 @item -mips3
9527 @opindex mips3
9528 Equivalent to @samp{-march=mips3}.
9530 @item -mips4
9531 @opindex mips4
9532 Equivalent to @samp{-march=mips4}.
9534 @item -mips32
9535 @opindex mips32
9536 Equivalent to @samp{-march=mips32}.
9538 @item -mips32r2
9539 @opindex mips32r2
9540 Equivalent to @samp{-march=mips32r2}.
9542 @item -mips64
9543 @opindex mips64
9544 Equivalent to @samp{-march=mips64}.
9546 @item -mips16
9547 @itemx -mno-mips16
9548 @opindex mips16
9549 @opindex mno-mips16
9550 Use (do not use) the MIPS16 ISA@.
9552 @item -mabi=32
9553 @itemx -mabi=o64
9554 @itemx -mabi=n32
9555 @itemx -mabi=64
9556 @itemx -mabi=eabi
9557 @opindex mabi=32
9558 @opindex mabi=o64
9559 @opindex mabi=n32
9560 @opindex mabi=64
9561 @opindex mabi=eabi
9562 Generate code for the given ABI@.
9564 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9565 generates 64-bit code when you select a 64-bit architecture, but you
9566 can use @option{-mgp32} to get 32-bit code instead.
9568 For information about the O64 ABI, see
9569 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9571 @item -mabicalls
9572 @itemx -mno-abicalls
9573 @opindex mabicalls
9574 @opindex mno-abicalls
9575 Generate (do not generate) SVR4-style position-independent code.
9576 @option{-mabicalls} is the default for SVR4-based systems.
9578 @item -mxgot
9579 @itemx -mno-xgot
9580 @opindex mxgot
9581 @opindex mno-xgot
9582 Lift (do not lift) the usual restrictions on the size of the global
9583 offset table.
9585 GCC normally uses a single instruction to load values from the GOT@.
9586 While this is relatively efficient, it will only work if the GOT
9587 is smaller than about 64k.  Anything larger will cause the linker
9588 to report an error such as:
9590 @cindex relocation truncated to fit (MIPS)
9591 @smallexample
9592 relocation truncated to fit: R_MIPS_GOT16 foobar
9593 @end smallexample
9595 If this happens, you should recompile your code with @option{-mxgot}.
9596 It should then work with very large GOTs, although it will also be
9597 less efficient, since it will take three instructions to fetch the
9598 value of a global symbol.
9600 Note that some linkers can create multiple GOTs.  If you have such a
9601 linker, you should only need to use @option{-mxgot} when a single object
9602 file accesses more than 64k's worth of GOT entries.  Very few do.
9604 These options have no effect unless GCC is generating position
9605 independent code.
9607 @item -mgp32
9608 @opindex mgp32
9609 Assume that general-purpose registers are 32 bits wide.
9611 @item -mgp64
9612 @opindex mgp64
9613 Assume that general-purpose registers are 64 bits wide.
9615 @item -mfp32
9616 @opindex mfp32
9617 Assume that floating-point registers are 32 bits wide.
9619 @item -mfp64
9620 @opindex mfp64
9621 Assume that floating-point registers are 64 bits wide.
9623 @item -mhard-float
9624 @opindex mhard-float
9625 Use floating-point coprocessor instructions.
9627 @item -msoft-float
9628 @opindex msoft-float
9629 Do not use floating-point coprocessor instructions.  Implement
9630 floating-point calculations using library calls instead.
9632 @item -msingle-float
9633 @opindex msingle-float
9634 Assume that the floating-point coprocessor only supports single-precision
9635 operations.
9637 @itemx -mdouble-float
9638 @opindex mdouble-float
9639 Assume that the floating-point coprocessor supports double-precision
9640 operations.  This is the default.
9642 @itemx -mpaired-single
9643 @itemx -mno-paired-single
9644 @opindex mpaired-single
9645 @opindex mno-paired-single
9646 Use (do not use) paired-single floating-point instructions.
9647 @xref{MIPS Paired-Single Support}.  This option can only be used
9648 when generating 64-bit code and requires hardware floating-point
9649 support to be enabled.
9651 @itemx -mips3d
9652 @itemx -mno-mips3d
9653 @opindex mips3d
9654 @opindex mno-mips3d
9655 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9656 The option @option{-mips3d} implies @option{-mpaired-single}.
9658 @item -mint64
9659 @opindex mint64
9660 Force @code{int} and @code{long} types to be 64 bits wide.  See
9661 @option{-mlong32} for an explanation of the default and the way
9662 that the pointer size is determined.
9664 This option has been deprecated and will be removed in a future release.
9666 @item -mlong64
9667 @opindex mlong64
9668 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9669 an explanation of the default and the way that the pointer size is
9670 determined.
9672 @item -mlong32
9673 @opindex mlong32
9674 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9676 The default size of @code{int}s, @code{long}s and pointers depends on
9677 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9678 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9679 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9680 or the same size as integer registers, whichever is smaller.
9682 @item -msym32
9683 @itemx -mno-sym32
9684 @opindex msym32
9685 @opindex mno-sym32
9686 Assume (do not assume) that all symbols have 32-bit values, regardless
9687 of the selected ABI@.  This option is useful in combination with
9688 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9689 to generate shorter and faster references to symbolic addresses.
9691 @item -G @var{num}
9692 @opindex G
9693 @cindex smaller data references (MIPS)
9694 @cindex gp-relative references (MIPS)
9695 Put global and static items less than or equal to @var{num} bytes into
9696 the small data or bss section instead of the normal data or bss section.
9697 This allows the data to be accessed using a single instruction.
9699 All modules should be compiled with the same @option{-G @var{num}}
9700 value.
9702 @item -membedded-data
9703 @itemx -mno-embedded-data
9704 @opindex membedded-data
9705 @opindex mno-embedded-data
9706 Allocate variables to the read-only data section first if possible, then
9707 next in the small data section if possible, otherwise in data.  This gives
9708 slightly slower code than the default, but reduces the amount of RAM required
9709 when executing, and thus may be preferred for some embedded systems.
9711 @item -muninit-const-in-rodata
9712 @itemx -mno-uninit-const-in-rodata
9713 @opindex muninit-const-in-rodata
9714 @opindex mno-uninit-const-in-rodata
9715 Put uninitialized @code{const} variables in the read-only data section.
9716 This option is only meaningful in conjunction with @option{-membedded-data}.
9718 @item -msplit-addresses
9719 @itemx -mno-split-addresses
9720 @opindex msplit-addresses
9721 @opindex mno-split-addresses
9722 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9723 relocation operators.  This option has been superceded by
9724 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9726 @item -mexplicit-relocs
9727 @itemx -mno-explicit-relocs
9728 @opindex mexplicit-relocs
9729 @opindex mno-explicit-relocs
9730 Use (do not use) assembler relocation operators when dealing with symbolic
9731 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9732 is to use assembler macros instead.
9734 @option{-mexplicit-relocs} is the default if GCC was configured
9735 to use an assembler that supports relocation operators.
9737 @item -mcheck-zero-division
9738 @itemx -mno-check-zero-division
9739 @opindex mcheck-zero-division
9740 @opindex mno-check-zero-division
9741 Trap (do not trap) on integer division by zero.  The default is
9742 @option{-mcheck-zero-division}.
9744 @item -mdivide-traps
9745 @itemx -mdivide-breaks
9746 @opindex mdivide-traps
9747 @opindex mdivide-breaks
9748 MIPS systems check for division by zero by generating either a
9749 conditional trap or a break instruction.  Using traps results in
9750 smaller code, but is only supported on MIPS II and later.  Also, some
9751 versions of the Linux kernel have a bug that prevents trap from
9752 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9753 allow conditional traps on architectures that support them and
9754 @option{-mdivide-breaks} to force the use of breaks.
9756 The default is usually @option{-mdivide-traps}, but this can be
9757 overridden at configure time using @option{--with-divide=breaks}.
9758 Divide-by-zero checks can be completely disabled using
9759 @option{-mno-check-zero-division}.
9761 @item -mmemcpy
9762 @itemx -mno-memcpy
9763 @opindex mmemcpy
9764 @opindex mno-memcpy
9765 Force (do not force) the use of @code{memcpy()} for non-trivial block
9766 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9767 most constant-sized copies.
9769 @item -mlong-calls
9770 @itemx -mno-long-calls
9771 @opindex mlong-calls
9772 @opindex mno-long-calls
9773 Disable (do not disable) use of the @code{jal} instruction.  Calling
9774 functions using @code{jal} is more efficient but requires the caller
9775 and callee to be in the same 256 megabyte segment.
9777 This option has no effect on abicalls code.  The default is
9778 @option{-mno-long-calls}.
9780 @item -mmad
9781 @itemx -mno-mad
9782 @opindex mmad
9783 @opindex mno-mad
9784 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9785 instructions, as provided by the R4650 ISA@.
9787 @item -mfused-madd
9788 @itemx -mno-fused-madd
9789 @opindex mfused-madd
9790 @opindex mno-fused-madd
9791 Enable (disable) use of the floating point multiply-accumulate
9792 instructions, when they are available.  The default is
9793 @option{-mfused-madd}.
9795 When multiply-accumulate instructions are used, the intermediate
9796 product is calculated to infinite precision and is not subject to
9797 the FCSR Flush to Zero bit.  This may be undesirable in some
9798 circumstances.
9800 @item -nocpp
9801 @opindex nocpp
9802 Tell the MIPS assembler to not run its preprocessor over user
9803 assembler files (with a @samp{.s} suffix) when assembling them.
9805 @item -mfix-r4000
9806 @itemx -mno-fix-r4000
9807 @opindex mfix-r4000
9808 @opindex mno-fix-r4000
9809 Work around certain R4000 CPU errata:
9810 @itemize @minus
9811 @item
9812 A double-word or a variable shift may give an incorrect result if executed
9813 immediately after starting an integer division.
9814 @item
9815 A double-word or a variable shift may give an incorrect result if executed
9816 while an integer multiplication is in progress.
9817 @item
9818 An integer division may give an incorrect result if started in a delay slot
9819 of a taken branch or a jump.
9820 @end itemize
9822 @item -mfix-r4400
9823 @itemx -mno-fix-r4400
9824 @opindex mfix-r4400
9825 @opindex mno-fix-r4400
9826 Work around certain R4400 CPU errata:
9827 @itemize @minus
9828 @item
9829 A double-word or a variable shift may give an incorrect result if executed
9830 immediately after starting an integer division.
9831 @end itemize
9833 @item -mfix-vr4120
9834 @itemx -mno-fix-vr4120
9835 @opindex mfix-vr4120
9836 Work around certain VR4120 errata:
9837 @itemize @minus
9838 @item
9839 @code{dmultu} does not always produce the correct result.
9840 @item
9841 @code{div} and @code{ddiv} do not always produce the correct result if one
9842 of the operands is negative.
9843 @end itemize
9844 The workarounds for the division errata rely on special functions in
9845 @file{libgcc.a}.  At present, these functions are only provided by
9846 the @code{mips64vr*-elf} configurations.
9848 Other VR4120 errata require a nop to be inserted between certain pairs of
9849 instructions.  These errata are handled by the assembler, not by GCC itself.
9851 @item -mfix-sb1
9852 @itemx -mno-fix-sb1
9853 @opindex mfix-sb1
9854 Work around certain SB-1 CPU core errata.
9855 (This flag currently works around the SB-1 revision 2
9856 ``F1'' and ``F2'' floating point errata.)
9858 @item -mflush-func=@var{func}
9859 @itemx -mno-flush-func
9860 @opindex mflush-func
9861 Specifies the function to call to flush the I and D caches, or to not
9862 call any such function.  If called, the function must take the same
9863 arguments as the common @code{_flush_func()}, that is, the address of the
9864 memory range for which the cache is being flushed, the size of the
9865 memory range, and the number 3 (to flush both caches).  The default
9866 depends on the target GCC was configured for, but commonly is either
9867 @samp{_flush_func} or @samp{__cpu_flush}.
9869 @item -mbranch-likely
9870 @itemx -mno-branch-likely
9871 @opindex mbranch-likely
9872 @opindex mno-branch-likely
9873 Enable or disable use of Branch Likely instructions, regardless of the
9874 default for the selected architecture.  By default, Branch Likely
9875 instructions may be generated if they are supported by the selected
9876 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9877 and processors which implement those architectures; for those, Branch
9878 Likely instructions will not be generated by default because the MIPS32
9879 and MIPS64 architectures specifically deprecate their use.
9881 @item -mfp-exceptions
9882 @itemx -mno-fp-exceptions
9883 @opindex mfp-exceptions
9884 Specifies whether FP exceptions are enabled.  This affects how we schedule
9885 FP instructions for some processors.  The default is that FP exceptions are
9886 enabled.
9888 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9889 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9890 FP pipe.
9892 @item -mvr4130-align
9893 @itemx -mno-vr4130-align
9894 @opindex mvr4130-align
9895 The VR4130 pipeline is two-way superscalar, but can only issue two
9896 instructions together if the first one is 8-byte aligned.  When this
9897 option is enabled, GCC will align pairs of instructions that it
9898 thinks should execute in parallel.
9900 This option only has an effect when optimizing for the VR4130.
9901 It normally makes code faster, but at the expense of making it bigger.
9902 It is enabled by default at optimization level @option{-O3}.
9903 @end table
9905 @node MMIX Options
9906 @subsection MMIX Options
9907 @cindex MMIX Options
9909 These options are defined for the MMIX:
9911 @table @gcctabopt
9912 @item -mlibfuncs
9913 @itemx -mno-libfuncs
9914 @opindex mlibfuncs
9915 @opindex mno-libfuncs
9916 Specify that intrinsic library functions are being compiled, passing all
9917 values in registers, no matter the size.
9919 @item -mepsilon
9920 @itemx -mno-epsilon
9921 @opindex mepsilon
9922 @opindex mno-epsilon
9923 Generate floating-point comparison instructions that compare with respect
9924 to the @code{rE} epsilon register.
9926 @item -mabi=mmixware
9927 @itemx -mabi=gnu
9928 @opindex mabi-mmixware
9929 @opindex mabi=gnu
9930 Generate code that passes function parameters and return values that (in
9931 the called function) are seen as registers @code{$0} and up, as opposed to
9932 the GNU ABI which uses global registers @code{$231} and up.
9934 @item -mzero-extend
9935 @itemx -mno-zero-extend
9936 @opindex mzero-extend
9937 @opindex mno-zero-extend
9938 When reading data from memory in sizes shorter than 64 bits, use (do not
9939 use) zero-extending load instructions by default, rather than
9940 sign-extending ones.
9942 @item -mknuthdiv
9943 @itemx -mno-knuthdiv
9944 @opindex mknuthdiv
9945 @opindex mno-knuthdiv
9946 Make the result of a division yielding a remainder have the same sign as
9947 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9948 remainder follows the sign of the dividend.  Both methods are
9949 arithmetically valid, the latter being almost exclusively used.
9951 @item -mtoplevel-symbols
9952 @itemx -mno-toplevel-symbols
9953 @opindex mtoplevel-symbols
9954 @opindex mno-toplevel-symbols
9955 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9956 code can be used with the @code{PREFIX} assembly directive.
9958 @item -melf
9959 @opindex melf
9960 Generate an executable in the ELF format, rather than the default
9961 @samp{mmo} format used by the @command{mmix} simulator.
9963 @item -mbranch-predict
9964 @itemx -mno-branch-predict
9965 @opindex mbranch-predict
9966 @opindex mno-branch-predict
9967 Use (do not use) the probable-branch instructions, when static branch
9968 prediction indicates a probable branch.
9970 @item -mbase-addresses
9971 @itemx -mno-base-addresses
9972 @opindex mbase-addresses
9973 @opindex mno-base-addresses
9974 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9975 base address automatically generates a request (handled by the assembler
9976 and the linker) for a constant to be set up in a global register.  The
9977 register is used for one or more base address requests within the range 0
9978 to 255 from the value held in the register.  The generally leads to short
9979 and fast code, but the number of different data items that can be
9980 addressed is limited.  This means that a program that uses lots of static
9981 data may require @option{-mno-base-addresses}.
9983 @item -msingle-exit
9984 @itemx -mno-single-exit
9985 @opindex msingle-exit
9986 @opindex mno-single-exit
9987 Force (do not force) generated code to have a single exit point in each
9988 function.
9989 @end table
9991 @node MN10300 Options
9992 @subsection MN10300 Options
9993 @cindex MN10300 options
9995 These @option{-m} options are defined for Matsushita MN10300 architectures:
9997 @table @gcctabopt
9998 @item -mmult-bug
9999 @opindex mmult-bug
10000 Generate code to avoid bugs in the multiply instructions for the MN10300
10001 processors.  This is the default.
10003 @item -mno-mult-bug
10004 @opindex mno-mult-bug
10005 Do not generate code to avoid bugs in the multiply instructions for the
10006 MN10300 processors.
10008 @item -mam33
10009 @opindex mam33
10010 Generate code which uses features specific to the AM33 processor.
10012 @item -mno-am33
10013 @opindex mno-am33
10014 Do not generate code which uses features specific to the AM33 processor.  This
10015 is the default.
10017 @item -mno-crt0
10018 @opindex mno-crt0
10019 Do not link in the C run-time initialization object file.
10021 @item -mrelax
10022 @opindex mrelax
10023 Indicate to the linker that it should perform a relaxation optimization pass
10024 to shorten branches, calls and absolute memory addresses.  This option only
10025 has an effect when used on the command line for the final link step.
10027 This option makes symbolic debugging impossible.
10028 @end table
10030 @node NS32K Options
10031 @subsection NS32K Options
10032 @cindex NS32K options
10034 These are the @samp{-m} options defined for the 32000 series.  The default
10035 values for these options depends on which style of 32000 was selected when
10036 the compiler was configured; the defaults for the most common choices are
10037 given below.
10039 @table @gcctabopt
10040 @item -m32032
10041 @itemx -m32032
10042 @opindex m32032
10043 @opindex m32032
10044 Generate output for a 32032.  This is the default
10045 when the compiler is configured for 32032 and 32016 based systems.
10047 @item -m32332
10048 @itemx -m32332
10049 @opindex m32332
10050 @opindex m32332
10051 Generate output for a 32332.  This is the default
10052 when the compiler is configured for 32332-based systems.
10054 @item -m32532
10055 @itemx -m32532
10056 @opindex m32532
10057 @opindex m32532
10058 Generate output for a 32532.  This is the default
10059 when the compiler is configured for 32532-based systems.
10061 @item -m32081
10062 @opindex m32081
10063 Generate output containing 32081 instructions for floating point.
10064 This is the default for all systems.
10066 @item -m32381
10067 @opindex m32381
10068 Generate output containing 32381 instructions for floating point.  This
10069 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10070 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10072 @item -mmulti-add
10073 @opindex mmulti-add
10074 Try and generate multiply-add floating point instructions @code{polyF}
10075 and @code{dotF}.  This option is only available if the @option{-m32381}
10076 option is in effect.  Using these instructions requires changes to
10077 register allocation which generally has a negative impact on
10078 performance.  This option should only be enabled when compiling code
10079 particularly likely to make heavy use of multiply-add instructions.
10081 @item -mnomulti-add
10082 @opindex mnomulti-add
10083 Do not try and generate multiply-add floating point instructions
10084 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10086 @item -msoft-float
10087 @opindex msoft-float
10088 Generate output containing library calls for floating point.
10089 @strong{Warning:} the requisite libraries may not be available.
10091 @item -mieee-compare
10092 @itemx -mno-ieee-compare
10093 @opindex mieee-compare
10094 @opindex mno-ieee-compare
10095 Control whether or not the compiler uses IEEE floating point
10096 comparisons.  These handle correctly the case where the result of a
10097 comparison is unordered.
10098 @strong{Warning:} the requisite kernel support may not be available.
10100 @item -mnobitfield
10101 @opindex mnobitfield
10102 Do not use the bit-field instructions.  On some machines it is faster to
10103 use shifting and masking operations.  This is the default for the pc532.
10105 @item -mbitfield
10106 @opindex mbitfield
10107 Do use the bit-field instructions.  This is the default for all platforms
10108 except the pc532.
10110 @item -mrtd
10111 @opindex mrtd
10112 Use a different function-calling convention, in which functions
10113 that take a fixed number of arguments return pop their
10114 arguments on return with the @code{ret} instruction.
10116 This calling convention is incompatible with the one normally
10117 used on Unix, so you cannot use it if you need to call libraries
10118 compiled with the Unix compiler.
10120 Also, you must provide function prototypes for all functions that
10121 take variable numbers of arguments (including @code{printf});
10122 otherwise incorrect code will be generated for calls to those
10123 functions.
10125 In addition, seriously incorrect code will result if you call a
10126 function with too many arguments.  (Normally, extra arguments are
10127 harmlessly ignored.)
10129 This option takes its name from the 680x0 @code{rtd} instruction.
10132 @item -mregparam
10133 @opindex mregparam
10134 Use a different function-calling convention where the first two arguments
10135 are passed in registers.
10137 This calling convention is incompatible with the one normally
10138 used on Unix, so you cannot use it if you need to call libraries
10139 compiled with the Unix compiler.
10141 @item -mnoregparam
10142 @opindex mnoregparam
10143 Do not pass any arguments in registers.  This is the default for all
10144 targets.
10146 @item -msb
10147 @opindex msb
10148 It is OK to use the sb as an index register which is always loaded with
10149 zero.  This is the default for the pc532-netbsd target.
10151 @item -mnosb
10152 @opindex mnosb
10153 The sb register is not available for use or has not been initialized to
10154 zero by the run time system.  This is the default for all targets except
10155 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10156 @option{-fpic} is set.
10158 @item -mhimem
10159 @opindex mhimem
10160 Many ns32000 series addressing modes use displacements of up to 512MB@.
10161 If an address is above 512MB then displacements from zero can not be used.
10162 This option causes code to be generated which can be loaded above 512MB@.
10163 This may be useful for operating systems or ROM code.
10165 @item -mnohimem
10166 @opindex mnohimem
10167 Assume code will be loaded in the first 512MB of virtual address space.
10168 This is the default for all platforms.
10170 @end table
10172 @node PDP-11 Options
10173 @subsection PDP-11 Options
10174 @cindex PDP-11 Options
10176 These options are defined for the PDP-11:
10178 @table @gcctabopt
10179 @item -mfpu
10180 @opindex mfpu
10181 Use hardware FPP floating point.  This is the default.  (FIS floating
10182 point on the PDP-11/40 is not supported.)
10184 @item -msoft-float
10185 @opindex msoft-float
10186 Do not use hardware floating point.
10188 @item -mac0
10189 @opindex mac0
10190 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10192 @item -mno-ac0
10193 @opindex mno-ac0
10194 Return floating-point results in memory.  This is the default.
10196 @item -m40
10197 @opindex m40
10198 Generate code for a PDP-11/40.
10200 @item -m45
10201 @opindex m45
10202 Generate code for a PDP-11/45.  This is the default.
10204 @item -m10
10205 @opindex m10
10206 Generate code for a PDP-11/10.
10208 @item -mbcopy-builtin
10209 @opindex bcopy-builtin
10210 Use inline @code{movmemhi} patterns for copying memory.  This is the
10211 default.
10213 @item -mbcopy
10214 @opindex mbcopy
10215 Do not use inline @code{movmemhi} patterns for copying memory.
10217 @item -mint16
10218 @itemx -mno-int32
10219 @opindex mint16
10220 @opindex mno-int32
10221 Use 16-bit @code{int}.  This is the default.
10223 @item -mint32
10224 @itemx -mno-int16
10225 @opindex mint32
10226 @opindex mno-int16
10227 Use 32-bit @code{int}.
10229 @item -mfloat64
10230 @itemx -mno-float32
10231 @opindex mfloat64
10232 @opindex mno-float32
10233 Use 64-bit @code{float}.  This is the default.
10235 @item -mfloat32
10236 @itemx -mno-float64
10237 @opindex mfloat32
10238 @opindex mno-float64
10239 Use 32-bit @code{float}.
10241 @item -mabshi
10242 @opindex mabshi
10243 Use @code{abshi2} pattern.  This is the default.
10245 @item -mno-abshi
10246 @opindex mno-abshi
10247 Do not use @code{abshi2} pattern.
10249 @item -mbranch-expensive
10250 @opindex mbranch-expensive
10251 Pretend that branches are expensive.  This is for experimenting with
10252 code generation only.
10254 @item -mbranch-cheap
10255 @opindex mbranch-cheap
10256 Do not pretend that branches are expensive.  This is the default.
10258 @item -msplit
10259 @opindex msplit
10260 Generate code for a system with split I&D@.
10262 @item -mno-split
10263 @opindex mno-split
10264 Generate code for a system without split I&D@.  This is the default.
10266 @item -munix-asm
10267 @opindex munix-asm
10268 Use Unix assembler syntax.  This is the default when configured for
10269 @samp{pdp11-*-bsd}.
10271 @item -mdec-asm
10272 @opindex mdec-asm
10273 Use DEC assembler syntax.  This is the default when configured for any
10274 PDP-11 target other than @samp{pdp11-*-bsd}.
10275 @end table
10277 @node PowerPC Options
10278 @subsection PowerPC Options
10279 @cindex PowerPC options
10281 These are listed under @xref{RS/6000 and PowerPC Options}.
10283 @node RS/6000 and PowerPC Options
10284 @subsection IBM RS/6000 and PowerPC Options
10285 @cindex RS/6000 and PowerPC Options
10286 @cindex IBM RS/6000 and PowerPC Options
10288 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10289 @table @gcctabopt
10290 @item -mpower
10291 @itemx -mno-power
10292 @itemx -mpower2
10293 @itemx -mno-power2
10294 @itemx -mpowerpc
10295 @itemx -mno-powerpc
10296 @itemx -mpowerpc-gpopt
10297 @itemx -mno-powerpc-gpopt
10298 @itemx -mpowerpc-gfxopt
10299 @itemx -mno-powerpc-gfxopt
10300 @itemx -mpowerpc64
10301 @itemx -mno-powerpc64
10302 @opindex mpower
10303 @opindex mno-power
10304 @opindex mpower2
10305 @opindex mno-power2
10306 @opindex mpowerpc
10307 @opindex mno-powerpc
10308 @opindex mpowerpc-gpopt
10309 @opindex mno-powerpc-gpopt
10310 @opindex mpowerpc-gfxopt
10311 @opindex mno-powerpc-gfxopt
10312 @opindex mpowerpc64
10313 @opindex mno-powerpc64
10314 GCC supports two related instruction set architectures for the
10315 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10316 instructions supported by the @samp{rios} chip set used in the original
10317 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10318 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10319 the IBM 4xx microprocessors.
10321 Neither architecture is a subset of the other.  However there is a
10322 large common subset of instructions supported by both.  An MQ
10323 register is included in processors supporting the POWER architecture.
10325 You use these options to specify which instructions are available on the
10326 processor you are using.  The default value of these options is
10327 determined when configuring GCC@.  Specifying the
10328 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10329 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10330 rather than the options listed above.
10332 The @option{-mpower} option allows GCC to generate instructions that
10333 are found only in the POWER architecture and to use the MQ register.
10334 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10335 to generate instructions that are present in the POWER2 architecture but
10336 not the original POWER architecture.
10338 The @option{-mpowerpc} option allows GCC to generate instructions that
10339 are found only in the 32-bit subset of the PowerPC architecture.
10340 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10341 GCC to use the optional PowerPC architecture instructions in the
10342 General Purpose group, including floating-point square root.  Specifying
10343 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10344 use the optional PowerPC architecture instructions in the Graphics
10345 group, including floating-point select.
10347 The @option{-mpowerpc64} option allows GCC to generate the additional
10348 64-bit instructions that are found in the full PowerPC64 architecture
10349 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10350 @option{-mno-powerpc64}.
10352 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10353 will use only the instructions in the common subset of both
10354 architectures plus some special AIX common-mode calls, and will not use
10355 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10356 permits GCC to use any instruction from either architecture and to
10357 allow use of the MQ register; specify this for the Motorola MPC601.
10359 @item -mnew-mnemonics
10360 @itemx -mold-mnemonics
10361 @opindex mnew-mnemonics
10362 @opindex mold-mnemonics
10363 Select which mnemonics to use in the generated assembler code.  With
10364 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10365 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10366 assembler mnemonics defined for the POWER architecture.  Instructions
10367 defined in only one architecture have only one mnemonic; GCC uses that
10368 mnemonic irrespective of which of these options is specified.
10370 GCC defaults to the mnemonics appropriate for the architecture in
10371 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10372 value of these option.  Unless you are building a cross-compiler, you
10373 should normally not specify either @option{-mnew-mnemonics} or
10374 @option{-mold-mnemonics}, but should instead accept the default.
10376 @item -mcpu=@var{cpu_type}
10377 @opindex mcpu
10378 Set architecture type, register usage, choice of mnemonics, and
10379 instruction scheduling parameters for machine type @var{cpu_type}.
10380 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10381 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10382 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10383 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10384 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10385 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10386 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10387 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10388 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10390 @option{-mcpu=common} selects a completely generic processor.  Code
10391 generated under this option will run on any POWER or PowerPC processor.
10392 GCC will use only the instructions in the common subset of both
10393 architectures, and will not use the MQ register.  GCC assumes a generic
10394 processor model for scheduling purposes.
10396 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10397 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10398 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10399 types, with an appropriate, generic processor model assumed for
10400 scheduling purposes.
10402 The other options specify a specific processor.  Code generated under
10403 those options will run best on that processor, and may not run at all on
10404 others.
10406 The @option{-mcpu} options automatically enable or disable the
10407 following options: @option{-maltivec}, @option{-mhard-float},
10408 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10409 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10410 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10411 @option{-mstring}.  The particular options set for any particular CPU
10412 will vary between compiler versions, depending on what setting seems
10413 to produce optimal code for that CPU; it doesn't necessarily reflect
10414 the actual hardware's capabilities.  If you wish to set an individual
10415 option to a particular value, you may specify it after the
10416 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10418 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10419 not enabled or disabled by the @option{-mcpu} option at present, since
10420 AIX does not have full support for these options.  You may still
10421 enable or disable them individually if you're sure it'll work in your
10422 environment.
10424 @item -mtune=@var{cpu_type}
10425 @opindex mtune
10426 Set the instruction scheduling parameters for machine type
10427 @var{cpu_type}, but do not set the architecture type, register usage, or
10428 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10429 values for @var{cpu_type} are used for @option{-mtune} as for
10430 @option{-mcpu}.  If both are specified, the code generated will use the
10431 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10432 scheduling parameters set by @option{-mtune}.
10434 @item -maltivec
10435 @itemx -mno-altivec
10436 @opindex maltivec
10437 @opindex mno-altivec
10438 Generate code that uses (does not use) AltiVec instructions, and also
10439 enable the use of built-in functions that allow more direct access to
10440 the AltiVec instruction set.  You may also need to set
10441 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10442 enhancements.
10444 @item -mabi=spe
10445 @opindex mabi=spe
10446 Extend the current ABI with SPE ABI extensions.  This does not change
10447 the default ABI, instead it adds the SPE ABI extensions to the current
10448 ABI@.
10450 @item -mabi=no-spe
10451 @opindex mabi=no-spe
10452 Disable Booke SPE ABI extensions for the current ABI@.
10454 @item -misel=@var{yes/no}
10455 @itemx -misel
10456 @opindex misel
10457 This switch enables or disables the generation of ISEL instructions.
10459 @item -mspe=@var{yes/no}
10460 @itemx -mspe
10461 @opindex mspe
10462 This switch enables or disables the generation of SPE simd
10463 instructions.
10465 @item -mfloat-gprs=@var{yes/single/double/no}
10466 @itemx -mfloat-gprs
10467 @opindex mfloat-gprs
10468 This switch enables or disables the generation of floating point
10469 operations on the general purpose registers for architectures that
10470 support it.
10472 The argument @var{yes} or @var{single} enables the use of
10473 single-precision floating point operations.
10475 The argument @var{double} enables the use of single and
10476 double-precision floating point operations.
10478 The argument @var{no} disables floating point operations on the
10479 general purpose registers.
10481 This option is currently only available on the MPC854x.
10483 @item -m32
10484 @itemx -m64
10485 @opindex m32
10486 @opindex m64
10487 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10488 targets (including GNU/Linux).  The 32-bit environment sets int, long
10489 and pointer to 32 bits and generates code that runs on any PowerPC
10490 variant.  The 64-bit environment sets int to 32 bits and long and
10491 pointer to 64 bits, and generates code for PowerPC64, as for
10492 @option{-mpowerpc64}.
10494 @item -mfull-toc
10495 @itemx -mno-fp-in-toc
10496 @itemx -mno-sum-in-toc
10497 @itemx -mminimal-toc
10498 @opindex mfull-toc
10499 @opindex mno-fp-in-toc
10500 @opindex mno-sum-in-toc
10501 @opindex mminimal-toc
10502 Modify generation of the TOC (Table Of Contents), which is created for
10503 every executable file.  The @option{-mfull-toc} option is selected by
10504 default.  In that case, GCC will allocate at least one TOC entry for
10505 each unique non-automatic variable reference in your program.  GCC
10506 will also place floating-point constants in the TOC@.  However, only
10507 16,384 entries are available in the TOC@.
10509 If you receive a linker error message that saying you have overflowed
10510 the available TOC space, you can reduce the amount of TOC space used
10511 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10512 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10513 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10514 generate code to calculate the sum of an address and a constant at
10515 run-time instead of putting that sum into the TOC@.  You may specify one
10516 or both of these options.  Each causes GCC to produce very slightly
10517 slower and larger code at the expense of conserving TOC space.
10519 If you still run out of space in the TOC even when you specify both of
10520 these options, specify @option{-mminimal-toc} instead.  This option causes
10521 GCC to make only one TOC entry for every file.  When you specify this
10522 option, GCC will produce code that is slower and larger but which
10523 uses extremely little TOC space.  You may wish to use this option
10524 only on files that contain less frequently executed code.
10526 @item -maix64
10527 @itemx -maix32
10528 @opindex maix64
10529 @opindex maix32
10530 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10531 @code{long} type, and the infrastructure needed to support them.
10532 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10533 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10534 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10536 @item -mxl-compat
10537 @itemx -mno-xl-compat
10538 @opindex mxl-compat
10539 @opindex mno-xl-compat
10540 Produce code that conforms more closely to IBM XLC semantics when using
10541 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10542 functions beyond the register save area (RSA) on the stack in addition
10543 to argument FPRs.  Do not assume that most significant double in 128
10544 bit long double value is properly rounded when comparing values.
10546 The AIX calling convention was extended but not initially documented to
10547 handle an obscure K&R C case of calling a function that takes the
10548 address of its arguments with fewer arguments than declared.  AIX XL
10549 compilers access floating point arguments which do not fit in the
10550 RSA from the stack when a subroutine is compiled without
10551 optimization.  Because always storing floating-point arguments on the
10552 stack is inefficient and rarely needed, this option is not enabled by
10553 default and only is necessary when calling subroutines compiled by AIX
10554 XL compilers without optimization.
10556 @item -mpe
10557 @opindex mpe
10558 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10559 application written to use message passing with special startup code to
10560 enable the application to run.  The system must have PE installed in the
10561 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10562 must be overridden with the @option{-specs=} option to specify the
10563 appropriate directory location.  The Parallel Environment does not
10564 support threads, so the @option{-mpe} option and the @option{-pthread}
10565 option are incompatible.
10567 @item -malign-natural
10568 @itemx -malign-power
10569 @opindex malign-natural
10570 @opindex malign-power
10571 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10572 @option{-malign-natural} overrides the ABI-defined alignment of larger
10573 types, such as floating-point doubles, on their natural size-based boundary.
10574 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10575 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10577 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10578 is not supported.
10580 @item -msoft-float
10581 @itemx -mhard-float
10582 @opindex msoft-float
10583 @opindex mhard-float
10584 Generate code that does not use (uses) the floating-point register set.
10585 Software floating point emulation is provided if you use the
10586 @option{-msoft-float} option, and pass the option to GCC when linking.
10588 @item -mmultiple
10589 @itemx -mno-multiple
10590 @opindex mmultiple
10591 @opindex mno-multiple
10592 Generate code that uses (does not use) the load multiple word
10593 instructions and the store multiple word instructions.  These
10594 instructions are generated by default on POWER systems, and not
10595 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10596 endian PowerPC systems, since those instructions do not work when the
10597 processor is in little endian mode.  The exceptions are PPC740 and
10598 PPC750 which permit the instructions usage in little endian mode.
10600 @item -mstring
10601 @itemx -mno-string
10602 @opindex mstring
10603 @opindex mno-string
10604 Generate code that uses (does not use) the load string instructions
10605 and the store string word instructions to save multiple registers and
10606 do small block moves.  These instructions are generated by default on
10607 POWER systems, and not generated on PowerPC systems.  Do not use
10608 @option{-mstring} on little endian PowerPC systems, since those
10609 instructions do not work when the processor is in little endian mode.
10610 The exceptions are PPC740 and PPC750 which permit the instructions
10611 usage in little endian mode.
10613 @item -mupdate
10614 @itemx -mno-update
10615 @opindex mupdate
10616 @opindex mno-update
10617 Generate code that uses (does not use) the load or store instructions
10618 that update the base register to the address of the calculated memory
10619 location.  These instructions are generated by default.  If you use
10620 @option{-mno-update}, there is a small window between the time that the
10621 stack pointer is updated and the address of the previous frame is
10622 stored, which means code that walks the stack frame across interrupts or
10623 signals may get corrupted data.
10625 @item -mfused-madd
10626 @itemx -mno-fused-madd
10627 @opindex mfused-madd
10628 @opindex mno-fused-madd
10629 Generate code that uses (does not use) the floating point multiply and
10630 accumulate instructions.  These instructions are generated by default if
10631 hardware floating is used.
10633 @item -mno-bit-align
10634 @itemx -mbit-align
10635 @opindex mno-bit-align
10636 @opindex mbit-align
10637 On System V.4 and embedded PowerPC systems do not (do) force structures
10638 and unions that contain bit-fields to be aligned to the base type of the
10639 bit-field.
10641 For example, by default a structure containing nothing but 8
10642 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10643 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10644 the structure would be aligned to a 1 byte boundary and be one byte in
10645 size.
10647 @item -mno-strict-align
10648 @itemx -mstrict-align
10649 @opindex mno-strict-align
10650 @opindex mstrict-align
10651 On System V.4 and embedded PowerPC systems do not (do) assume that
10652 unaligned memory references will be handled by the system.
10654 @item -mrelocatable
10655 @itemx -mno-relocatable
10656 @opindex mrelocatable
10657 @opindex mno-relocatable
10658 On embedded PowerPC systems generate code that allows (does not allow)
10659 the program to be relocated to a different address at runtime.  If you
10660 use @option{-mrelocatable} on any module, all objects linked together must
10661 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10663 @item -mrelocatable-lib
10664 @itemx -mno-relocatable-lib
10665 @opindex mrelocatable-lib
10666 @opindex mno-relocatable-lib
10667 On embedded PowerPC systems generate code that allows (does not allow)
10668 the program to be relocated to a different address at runtime.  Modules
10669 compiled with @option{-mrelocatable-lib} can be linked with either modules
10670 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10671 with modules compiled with the @option{-mrelocatable} options.
10673 @item -mno-toc
10674 @itemx -mtoc
10675 @opindex mno-toc
10676 @opindex mtoc
10677 On System V.4 and embedded PowerPC systems do not (do) assume that
10678 register 2 contains a pointer to a global area pointing to the addresses
10679 used in the program.
10681 @item -mlittle
10682 @itemx -mlittle-endian
10683 @opindex mlittle
10684 @opindex mlittle-endian
10685 On System V.4 and embedded PowerPC systems compile code for the
10686 processor in little endian mode.  The @option{-mlittle-endian} option is
10687 the same as @option{-mlittle}.
10689 @item -mbig
10690 @itemx -mbig-endian
10691 @opindex mbig
10692 @opindex mbig-endian
10693 On System V.4 and embedded PowerPC systems compile code for the
10694 processor in big endian mode.  The @option{-mbig-endian} option is
10695 the same as @option{-mbig}.
10697 @item -mdynamic-no-pic
10698 @opindex mdynamic-no-pic
10699 On Darwin and Mac OS X systems, compile code so that it is not
10700 relocatable, but that its external references are relocatable.  The
10701 resulting code is suitable for applications, but not shared
10702 libraries.
10704 @item -mprioritize-restricted-insns=@var{priority}
10705 @opindex mprioritize-restricted-insns
10706 This option controls the priority that is assigned to
10707 dispatch-slot restricted instructions during the second scheduling
10708 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10709 @var{no/highest/second-highest} priority to dispatch slot restricted
10710 instructions.
10712 @item -msched-costly-dep=@var{dependence_type}
10713 @opindex msched-costly-dep
10714 This option controls which dependences are considered costly
10715 by the target during instruction scheduling.  The argument
10716 @var{dependence_type} takes one of the following values:
10717 @var{no}: no dependence is costly,
10718 @var{all}: all dependences are costly,
10719 @var{true_store_to_load}: a true dependence from store to load is costly,
10720 @var{store_to_load}: any dependence from store to load is costly,
10721 @var{number}: any dependence which latency >= @var{number} is costly.
10723 @item -minsert-sched-nops=@var{scheme}
10724 @opindex minsert-sched-nops
10725 This option controls which nop insertion scheme will be used during
10726 the second scheduling pass.  The argument @var{scheme} takes one of the
10727 following values:
10728 @var{no}: Don't insert nops.
10729 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10730 according to the scheduler's grouping.
10731 @var{regroup_exact}: Insert nops to force costly dependent insns into
10732 separate groups.  Insert exactly as many nops as needed to force an insn
10733 to a new group, according to the estimated processor grouping.
10734 @var{number}: Insert nops to force costly dependent insns into
10735 separate groups.  Insert @var{number} nops to force an insn to a new group.
10737 @item -mcall-sysv
10738 @opindex mcall-sysv
10739 On System V.4 and embedded PowerPC systems compile code using calling
10740 conventions that adheres to the March 1995 draft of the System V
10741 Application Binary Interface, PowerPC processor supplement.  This is the
10742 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10744 @item -mcall-sysv-eabi
10745 @opindex mcall-sysv-eabi
10746 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10748 @item -mcall-sysv-noeabi
10749 @opindex mcall-sysv-noeabi
10750 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10752 @item -mcall-solaris
10753 @opindex mcall-solaris
10754 On System V.4 and embedded PowerPC systems compile code for the Solaris
10755 operating system.
10757 @item -mcall-linux
10758 @opindex mcall-linux
10759 On System V.4 and embedded PowerPC systems compile code for the
10760 Linux-based GNU system.
10762 @item -mcall-gnu
10763 @opindex mcall-gnu
10764 On System V.4 and embedded PowerPC systems compile code for the
10765 Hurd-based GNU system.
10767 @item -mcall-netbsd
10768 @opindex mcall-netbsd
10769 On System V.4 and embedded PowerPC systems compile code for the
10770 NetBSD operating system.
10772 @item -maix-struct-return
10773 @opindex maix-struct-return
10774 Return all structures in memory (as specified by the AIX ABI)@.
10776 @item -msvr4-struct-return
10777 @opindex msvr4-struct-return
10778 Return structures smaller than 8 bytes in registers (as specified by the
10779 SVR4 ABI)@.
10781 @item -mabi=altivec
10782 @opindex mabi=altivec
10783 Extend the current ABI with AltiVec ABI extensions.  This does not
10784 change the default ABI, instead it adds the AltiVec ABI extensions to
10785 the current ABI@.
10787 @item -mabi=no-altivec
10788 @opindex mabi=no-altivec
10789 Disable AltiVec ABI extensions for the current ABI@.
10791 @item -mprototype
10792 @itemx -mno-prototype
10793 @opindex mprototype
10794 @opindex mno-prototype
10795 On System V.4 and embedded PowerPC systems assume that all calls to
10796 variable argument functions are properly prototyped.  Otherwise, the
10797 compiler must insert an instruction before every non prototyped call to
10798 set or clear bit 6 of the condition code register (@var{CR}) to
10799 indicate whether floating point values were passed in the floating point
10800 registers in case the function takes a variable arguments.  With
10801 @option{-mprototype}, only calls to prototyped variable argument functions
10802 will set or clear the bit.
10804 @item -msim
10805 @opindex msim
10806 On embedded PowerPC systems, assume that the startup module is called
10807 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10808 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10809 configurations.
10811 @item -mmvme
10812 @opindex mmvme
10813 On embedded PowerPC systems, assume that the startup module is called
10814 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10815 @file{libc.a}.
10817 @item -mads
10818 @opindex mads
10819 On embedded PowerPC systems, assume that the startup module is called
10820 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10821 @file{libc.a}.
10823 @item -myellowknife
10824 @opindex myellowknife
10825 On embedded PowerPC systems, assume that the startup module is called
10826 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10827 @file{libc.a}.
10829 @item -mvxworks
10830 @opindex mvxworks
10831 On System V.4 and embedded PowerPC systems, specify that you are
10832 compiling for a VxWorks system.
10834 @item -mwindiss
10835 @opindex mwindiss
10836 Specify that you are compiling for the WindISS simulation environment.
10838 @item -memb
10839 @opindex memb
10840 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10841 header to indicate that @samp{eabi} extended relocations are used.
10843 @item -meabi
10844 @itemx -mno-eabi
10845 @opindex meabi
10846 @opindex mno-eabi
10847 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10848 Embedded Applications Binary Interface (eabi) which is a set of
10849 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10850 means that the stack is aligned to an 8 byte boundary, a function
10851 @code{__eabi} is called to from @code{main} to set up the eabi
10852 environment, and the @option{-msdata} option can use both @code{r2} and
10853 @code{r13} to point to two separate small data areas.  Selecting
10854 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10855 do not call an initialization function from @code{main}, and the
10856 @option{-msdata} option will only use @code{r13} to point to a single
10857 small data area.  The @option{-meabi} option is on by default if you
10858 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10860 @item -msdata=eabi
10861 @opindex msdata=eabi
10862 On System V.4 and embedded PowerPC systems, put small initialized
10863 @code{const} global and static data in the @samp{.sdata2} section, which
10864 is pointed to by register @code{r2}.  Put small initialized
10865 non-@code{const} global and static data in the @samp{.sdata} section,
10866 which is pointed to by register @code{r13}.  Put small uninitialized
10867 global and static data in the @samp{.sbss} section, which is adjacent to
10868 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10869 incompatible with the @option{-mrelocatable} option.  The
10870 @option{-msdata=eabi} option also sets the @option{-memb} option.
10872 @item -msdata=sysv
10873 @opindex msdata=sysv
10874 On System V.4 and embedded PowerPC systems, put small global and static
10875 data in the @samp{.sdata} section, which is pointed to by register
10876 @code{r13}.  Put small uninitialized global and static data in the
10877 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10878 The @option{-msdata=sysv} option is incompatible with the
10879 @option{-mrelocatable} option.
10881 @item -msdata=default
10882 @itemx -msdata
10883 @opindex msdata=default
10884 @opindex msdata
10885 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10886 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10887 same as @option{-msdata=sysv}.
10889 @item -msdata-data
10890 @opindex msdata-data
10891 On System V.4 and embedded PowerPC systems, put small global and static
10892 data in the @samp{.sdata} section.  Put small uninitialized global and
10893 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10894 to address small data however.  This is the default behavior unless
10895 other @option{-msdata} options are used.
10897 @item -msdata=none
10898 @itemx -mno-sdata
10899 @opindex msdata=none
10900 @opindex mno-sdata
10901 On embedded PowerPC systems, put all initialized global and static data
10902 in the @samp{.data} section, and all uninitialized data in the
10903 @samp{.bss} section.
10905 @item -G @var{num}
10906 @opindex G
10907 @cindex smaller data references (PowerPC)
10908 @cindex .sdata/.sdata2 references (PowerPC)
10909 On embedded PowerPC systems, put global and static items less than or
10910 equal to @var{num} bytes into the small data or bss sections instead of
10911 the normal data or bss section.  By default, @var{num} is 8.  The
10912 @option{-G @var{num}} switch is also passed to the linker.
10913 All modules should be compiled with the same @option{-G @var{num}} value.
10915 @item -mregnames
10916 @itemx -mno-regnames
10917 @opindex mregnames
10918 @opindex mno-regnames
10919 On System V.4 and embedded PowerPC systems do (do not) emit register
10920 names in the assembly language output using symbolic forms.
10922 @item -mlongcall
10923 @itemx -mno-longcall
10924 @opindex mlongcall
10925 @opindex mno-longcall
10926 Default to making all function calls indirectly, using a register, so
10927 that functions which reside further than 32 megabytes (33,554,432
10928 bytes) from the current location can be called.  This setting can be
10929 overridden by the @code{shortcall} function attribute, or by
10930 @code{#pragma longcall(0)}.
10932 Some linkers are capable of detecting out-of-range calls and generating
10933 glue code on the fly.  On these systems, long calls are unnecessary and
10934 generate slower code.  As of this writing, the AIX linker can do this,
10935 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10936 to the GNU linker for 32-bit PowerPC systems as well.
10938 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10939 callee, L42'', plus a ``branch island'' (glue code).  The two target
10940 addresses represent the callee and the ``branch island''.  The
10941 Darwin/PPC linker will prefer the first address and generate a ``bl
10942 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10943 otherwise, the linker will generate ``bl L42'' to call the ``branch
10944 island''.  The ``branch island'' is appended to the body of the
10945 calling function; it computes the full 32-bit address of the callee
10946 and jumps to it.
10948 On Mach-O (Darwin) systems, this option directs the compiler emit to
10949 the glue for every direct call, and the Darwin linker decides whether
10950 to use or discard it.
10952 In the future, we may cause GCC to ignore all longcall specifications
10953 when the linker is known to generate glue.
10955 @item -pthread
10956 @opindex pthread
10957 Adds support for multithreading with the @dfn{pthreads} library.
10958 This option sets flags for both the preprocessor and linker.
10960 @end table
10962 @node S/390 and zSeries Options
10963 @subsection S/390 and zSeries Options
10964 @cindex S/390 and zSeries Options
10966 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10968 @table @gcctabopt
10969 @item -mhard-float
10970 @itemx -msoft-float
10971 @opindex mhard-float
10972 @opindex msoft-float
10973 Use (do not use) the hardware floating-point instructions and registers
10974 for floating-point operations.  When @option{-msoft-float} is specified,
10975 functions in @file{libgcc.a} will be used to perform floating-point
10976 operations.  When @option{-mhard-float} is specified, the compiler
10977 generates IEEE floating-point instructions.  This is the default.
10979 @item -mbackchain
10980 @itemx -mno-backchain
10981 @opindex mbackchain
10982 @opindex mno-backchain
10983 Store (do not store) the address of the caller's frame as backchain pointer
10984 into the callee's stack frame.
10985 A backchain may be needed to allow debugging using tools that do not understand
10986 DWARF-2 call frame information.
10987 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
10988 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
10989 the backchain is placed into the topmost word of the 96/160 byte register
10990 save area.
10992 In general, code compiled with @option{-mbackchain} is call-compatible with
10993 code compiled with @option{-mmo-backchain}; however, use of the backchain
10994 for debugging purposes usually requires that the whole binary is built with
10995 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
10996 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10997 to build a linux kernel use @option{-msoft-float}.
10999 The default is to not maintain the backchain.
11001 @item -mpacked-stack
11002 @item -mno-packed-stack
11003 @opindex mpacked-stack
11004 @opindex mno-packed-stack
11005 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
11006 specified, the compiler uses the all fields of the 96/160 byte register save
11007 area only for their default purpose; unused fields still take up stack space.
11008 When @option{-mpacked-stack} is specified, register save slots are densely
11009 packed at the top of the register save area; unused space is reused for other
11010 purposes, allowing for more efficient use of the available stack space.
11011 However, when @option{-mbackchain} is also in effect, the topmost word of
11012 the save area is always used to store the backchain, and the return address
11013 register is always saved two words below the backchain.
11015 As long as the stack frame backchain is not used, code generated with
11016 @option{-mpacked-stack} is call-compatible with code generated with
11017 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
11018 S/390 or zSeries generated code that uses the stack frame backchain at run
11019 time, not just for debugging purposes.  Such code is not call-compatible
11020 with code compiled with @option{-mpacked-stack}.  Also, note that the
11021 combination of @option{-mbackchain},
11022 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
11023 to build a linux kernel use @option{-msoft-float}.
11025 The default is to not use the packed stack layout.
11027 @item -msmall-exec
11028 @itemx -mno-small-exec
11029 @opindex msmall-exec
11030 @opindex mno-small-exec
11031 Generate (or do not generate) code using the @code{bras} instruction
11032 to do subroutine calls.
11033 This only works reliably if the total executable size does not
11034 exceed 64k.  The default is to use the @code{basr} instruction instead,
11035 which does not have this limitation.
11037 @item -m64
11038 @itemx -m31
11039 @opindex m64
11040 @opindex m31
11041 When @option{-m31} is specified, generate code compliant to the
11042 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11043 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11044 particular to generate 64-bit instructions.  For the @samp{s390}
11045 targets, the default is @option{-m31}, while the @samp{s390x}
11046 targets default to @option{-m64}.
11048 @item -mzarch
11049 @itemx -mesa
11050 @opindex mzarch
11051 @opindex mesa
11052 When @option{-mzarch} is specified, generate code using the
11053 instructions available on z/Architecture.
11054 When @option{-mesa} is specified, generate code using the
11055 instructions available on ESA/390.  Note that @option{-mesa} is
11056 not possible with @option{-m64}.
11057 When generating code compliant to the GNU/Linux for S/390 ABI,
11058 the default is @option{-mesa}.  When generating code compliant
11059 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11061 @item -mmvcle
11062 @itemx -mno-mvcle
11063 @opindex mmvcle
11064 @opindex mno-mvcle
11065 Generate (or do not generate) code using the @code{mvcle} instruction
11066 to perform block moves.  When @option{-mno-mvcle} is specified,
11067 use a @code{mvc} loop instead.  This is the default.
11069 @item -mdebug
11070 @itemx -mno-debug
11071 @opindex mdebug
11072 @opindex mno-debug
11073 Print (or do not print) additional debug information when compiling.
11074 The default is to not print debug information.
11076 @item -march=@var{cpu-type}
11077 @opindex march
11078 Generate code that will run on @var{cpu-type}, which is the name of a system
11079 representing a certain processor type.  Possible values for
11080 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11081 When generating code using the instructions available on z/Architecture,
11082 the default is @option{-march=z900}.  Otherwise, the default is
11083 @option{-march=g5}.
11085 @item -mtune=@var{cpu-type}
11086 @opindex mtune
11087 Tune to @var{cpu-type} everything applicable about the generated code,
11088 except for the ABI and the set of available instructions.
11089 The list of @var{cpu-type} values is the same as for @option{-march}.
11090 The default is the value used for @option{-march}.
11092 @item -mtpf-trace
11093 @itemx -mno-tpf-trace
11094 @opindex mtpf-trace
11095 @opindex mno-tpf-trace
11096 Generate code that adds (does not add) in TPF OS specific branches to trace
11097 routines in the operating system.  This option is off by default, even
11098 when compiling for the TPF OS@.
11100 @item -mfused-madd
11101 @itemx -mno-fused-madd
11102 @opindex mfused-madd
11103 @opindex mno-fused-madd
11104 Generate code that uses (does not use) the floating point multiply and
11105 accumulate instructions.  These instructions are generated by default if
11106 hardware floating point is used.
11108 @item -mwarn-framesize=@var{framesize}
11109 @opindex mwarn-framesize
11110 Emit a warning if the current function exceeds the given frame size.  Because
11111 this is a compile time check it doesn't need to be a real problem when the program
11112 runs.  It is intended to identify functions which most probably cause
11113 a stack overflow.  It is useful to be used in an environment with limited stack
11114 size e.g.@: the linux kernel.
11116 @item -mwarn-dynamicstack
11117 @opindex mwarn-dynamicstack
11118 Emit a warning if the function calls alloca or uses dynamically
11119 sized arrays.  This is generally a bad idea with a limited stack size.
11121 @item -mstack-guard=@var{stack-guard}
11122 @item -mstack-size=@var{stack-size}
11123 @opindex mstack-guard
11124 @opindex mstack-size
11125 These arguments always have to be used in conjunction.  If they are present the s390
11126 back end emits additional instructions in the function prologue which trigger a trap
11127 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11128 (remember that the stack on s390 grows downward).  These options are intended to
11129 be used to help debugging stack overflow problems.  The additionally emitted code
11130 cause only little overhead and hence can also be used in production like systems
11131 without greater performance degradation.  The given values have to be exact
11132 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11133 In order to be efficient the extra code makes the assumption that the stack starts
11134 at an address aligned to the value given by @var{stack-size}.
11135 @end table
11137 @node SH Options
11138 @subsection SH Options
11140 These @samp{-m} options are defined for the SH implementations:
11142 @table @gcctabopt
11143 @item -m1
11144 @opindex m1
11145 Generate code for the SH1.
11147 @item -m2
11148 @opindex m2
11149 Generate code for the SH2.
11151 @item -m2e
11152 Generate code for the SH2e.
11154 @item -m3
11155 @opindex m3
11156 Generate code for the SH3.
11158 @item -m3e
11159 @opindex m3e
11160 Generate code for the SH3e.
11162 @item -m4-nofpu
11163 @opindex m4-nofpu
11164 Generate code for the SH4 without a floating-point unit.
11166 @item -m4-single-only
11167 @opindex m4-single-only
11168 Generate code for the SH4 with a floating-point unit that only
11169 supports single-precision arithmetic.
11171 @item -m4-single
11172 @opindex m4-single
11173 Generate code for the SH4 assuming the floating-point unit is in
11174 single-precision mode by default.
11176 @item -m4
11177 @opindex m4
11178 Generate code for the SH4.
11180 @item -m4a-nofpu
11181 @opindex m4a-nofpu
11182 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11183 floating-point unit is not used.
11185 @item -m4a-single-only
11186 @opindex m4a-single-only
11187 Generate code for the SH4a, in such a way that no double-precision
11188 floating point operations are used.
11190 @item -m4a-single
11191 @opindex m4a-single
11192 Generate code for the SH4a assuming the floating-point unit is in
11193 single-precision mode by default.
11195 @item -m4a
11196 @opindex m4a
11197 Generate code for the SH4a.
11199 @item -m4al
11200 @opindex m4al
11201 Same as @option{-m4a-nofpu}, except that it implicitly passes
11202 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11203 instructions at the moment.
11205 @item -mb
11206 @opindex mb
11207 Compile code for the processor in big endian mode.
11209 @item -ml
11210 @opindex ml
11211 Compile code for the processor in little endian mode.
11213 @item -mdalign
11214 @opindex mdalign
11215 Align doubles at 64-bit boundaries.  Note that this changes the calling
11216 conventions, and thus some functions from the standard C library will
11217 not work unless you recompile it first with @option{-mdalign}.
11219 @item -mrelax
11220 @opindex mrelax
11221 Shorten some address references at link time, when possible; uses the
11222 linker option @option{-relax}.
11224 @item -mbigtable
11225 @opindex mbigtable
11226 Use 32-bit offsets in @code{switch} tables.  The default is to use
11227 16-bit offsets.
11229 @item -mfmovd
11230 @opindex mfmovd
11231 Enable the use of the instruction @code{fmovd}.
11233 @item -mhitachi
11234 @opindex mhitachi
11235 Comply with the calling conventions defined by Renesas.
11237 @item -mrenesas
11238 @opindex mhitachi
11239 Comply with the calling conventions defined by Renesas.
11241 @item -mno-renesas
11242 @opindex mhitachi
11243 Comply with the calling conventions defined for GCC before the Renesas
11244 conventions were available.  This option is the default for all
11245 targets of the SH toolchain except for @samp{sh-symbianelf}.
11247 @item -mnomacsave
11248 @opindex mnomacsave
11249 Mark the @code{MAC} register as call-clobbered, even if
11250 @option{-mhitachi} is given.
11252 @item -mieee
11253 @opindex mieee
11254 Increase IEEE-compliance of floating-point code.
11256 @item -misize
11257 @opindex misize
11258 Dump instruction size and location in the assembly code.
11260 @item -mpadstruct
11261 @opindex mpadstruct
11262 This option is deprecated.  It pads structures to multiple of 4 bytes,
11263 which is incompatible with the SH ABI@.
11265 @item -mspace
11266 @opindex mspace
11267 Optimize for space instead of speed.  Implied by @option{-Os}.
11269 @item -mprefergot
11270 @opindex mprefergot
11271 When generating position-independent code, emit function calls using
11272 the Global Offset Table instead of the Procedure Linkage Table.
11274 @item -musermode
11275 @opindex musermode
11276 Generate a library function call to invalidate instruction cache
11277 entries, after fixing up a trampoline.  This library function call
11278 doesn't assume it can write to the whole memory address space.  This
11279 is the default when the target is @code{sh-*-linux*}.
11280 @end table
11282 @node SPARC Options
11283 @subsection SPARC Options
11284 @cindex SPARC options
11286 These @samp{-m} options are supported on the SPARC:
11288 @table @gcctabopt
11289 @item -mno-app-regs
11290 @itemx -mapp-regs
11291 @opindex mno-app-regs
11292 @opindex mapp-regs
11293 Specify @option{-mapp-regs} to generate output using the global registers
11294 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11295 is the default.
11297 To be fully SVR4 ABI compliant at the cost of some performance loss,
11298 specify @option{-mno-app-regs}.  You should compile libraries and system
11299 software with this option.
11301 @item -mfpu
11302 @itemx -mhard-float
11303 @opindex mfpu
11304 @opindex mhard-float
11305 Generate output containing floating point instructions.  This is the
11306 default.
11308 @item -mno-fpu
11309 @itemx -msoft-float
11310 @opindex mno-fpu
11311 @opindex msoft-float
11312 Generate output containing library calls for floating point.
11313 @strong{Warning:} the requisite libraries are not available for all SPARC
11314 targets.  Normally the facilities of the machine's usual C compiler are
11315 used, but this cannot be done directly in cross-compilation.  You must make
11316 your own arrangements to provide suitable library functions for
11317 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11318 @samp{sparclite-*-*} do provide software floating point support.
11320 @option{-msoft-float} changes the calling convention in the output file;
11321 therefore, it is only useful if you compile @emph{all} of a program with
11322 this option.  In particular, you need to compile @file{libgcc.a}, the
11323 library that comes with GCC, with @option{-msoft-float} in order for
11324 this to work.
11326 @item -mhard-quad-float
11327 @opindex mhard-quad-float
11328 Generate output containing quad-word (long double) floating point
11329 instructions.
11331 @item -msoft-quad-float
11332 @opindex msoft-quad-float
11333 Generate output containing library calls for quad-word (long double)
11334 floating point instructions.  The functions called are those specified
11335 in the SPARC ABI@.  This is the default.
11337 As of this writing, there are no SPARC implementations that have hardware
11338 support for the quad-word floating point instructions.  They all invoke
11339 a trap handler for one of these instructions, and then the trap handler
11340 emulates the effect of the instruction.  Because of the trap handler overhead,
11341 this is much slower than calling the ABI library routines.  Thus the
11342 @option{-msoft-quad-float} option is the default.
11344 @item -mno-unaligned-doubles
11345 @itemx -munaligned-doubles
11346 @opindex mno-unaligned-doubles
11347 @opindex munaligned-doubles
11348 Assume that doubles have 8 byte alignment.  This is the default.
11350 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11351 alignment only if they are contained in another type, or if they have an
11352 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11353 Specifying this option avoids some rare compatibility problems with code
11354 generated by other compilers.  It is not the default because it results
11355 in a performance loss, especially for floating point code.
11357 @item -mno-faster-structs
11358 @itemx -mfaster-structs
11359 @opindex mno-faster-structs
11360 @opindex mfaster-structs
11361 With @option{-mfaster-structs}, the compiler assumes that structures
11362 should have 8 byte alignment.  This enables the use of pairs of
11363 @code{ldd} and @code{std} instructions for copies in structure
11364 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11365 However, the use of this changed alignment directly violates the SPARC
11366 ABI@.  Thus, it's intended only for use on targets where the developer
11367 acknowledges that their resulting code will not be directly in line with
11368 the rules of the ABI@.
11370 @item -mimpure-text
11371 @opindex mimpure-text
11372 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11373 the compiler to not pass @option{-z text} to the linker when linking a
11374 shared object.  Using this option, you can link position-dependent
11375 code into a shared object.
11377 @option{-mimpure-text} suppresses the ``relocations remain against
11378 allocatable but non-writable sections'' linker error message.
11379 However, the necessary relocations will trigger copy-on-write, and the
11380 shared object is not actually shared across processes.  Instead of
11381 using @option{-mimpure-text}, you should compile all source code with
11382 @option{-fpic} or @option{-fPIC}.
11384 This option is only available on SunOS and Solaris.
11386 @item -mcpu=@var{cpu_type}
11387 @opindex mcpu
11388 Set the instruction set, register set, and instruction scheduling parameters
11389 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11390 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11391 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11392 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11393 @samp{ultrasparc3}.
11395 Default instruction scheduling parameters are used for values that select
11396 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11397 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11399 Here is a list of each supported architecture and their supported
11400 implementations.
11402 @smallexample
11403     v7:             cypress
11404     v8:             supersparc, hypersparc
11405     sparclite:      f930, f934, sparclite86x
11406     sparclet:       tsc701
11407     v9:             ultrasparc, ultrasparc3
11408 @end smallexample
11410 By default (unless configured otherwise), GCC generates code for the V7
11411 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11412 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11413 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11414 SPARCStation 1, 2, IPX etc.
11416 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11417 architecture.  The only difference from V7 code is that the compiler emits
11418 the integer multiply and integer divide instructions which exist in SPARC-V8
11419 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11420 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11421 2000 series.
11423 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11424 the SPARC architecture.  This adds the integer multiply, integer divide step
11425 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11426 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11427 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11428 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11429 MB86934 chip, which is the more recent SPARClite with FPU@.
11431 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11432 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11433 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11434 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11435 optimizes it for the TEMIC SPARClet chip.
11437 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11438 architecture.  This adds 64-bit integer and floating-point move instructions,
11439 3 additional floating-point condition code registers and conditional move
11440 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11441 optimizes it for the Sun UltraSPARC I/II chips.  With
11442 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11443 Sun UltraSPARC III chip.
11445 @item -mtune=@var{cpu_type}
11446 @opindex mtune
11447 Set the instruction scheduling parameters for machine type
11448 @var{cpu_type}, but do not set the instruction set or register set that the
11449 option @option{-mcpu=@var{cpu_type}} would.
11451 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11452 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11453 that select a particular cpu implementation.  Those are @samp{cypress},
11454 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11455 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11456 @samp{ultrasparc3}.
11458 @item -mv8plus
11459 @itemx -mno-v8plus
11460 @opindex mv8plus
11461 @opindex mno-v8plus
11462 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11463 difference from the V8 ABI is that the global and out registers are
11464 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11465 mode for all SPARC-V9 processors.
11467 @item -mvis
11468 @itemx -mno-vis
11469 @opindex mvis
11470 @opindex mno-vis
11471 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11472 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11473 @end table
11475 These @samp{-m} options are supported in addition to the above
11476 on SPARC-V9 processors in 64-bit environments:
11478 @table @gcctabopt
11479 @item -mlittle-endian
11480 @opindex mlittle-endian
11481 Generate code for a processor running in little-endian mode.  It is only
11482 available for a few configurations and most notably not on Solaris.
11484 @item -m32
11485 @itemx -m64
11486 @opindex m32
11487 @opindex m64
11488 Generate code for a 32-bit or 64-bit environment.
11489 The 32-bit environment sets int, long and pointer to 32 bits.
11490 The 64-bit environment sets int to 32 bits and long and pointer
11491 to 64 bits.
11493 @item -mcmodel=medlow
11494 @opindex mcmodel=medlow
11495 Generate code for the Medium/Low code model: 64-bit addresses, programs
11496 must be linked in the low 32 bits of memory.  Programs can be statically
11497 or dynamically linked.
11499 @item -mcmodel=medmid
11500 @opindex mcmodel=medmid
11501 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11502 must be linked in the low 44 bits of memory, the text and data segments must
11503 be less than 2GB in size and the data segment must be located within 2GB of
11504 the text segment.
11506 @item -mcmodel=medany
11507 @opindex mcmodel=medany
11508 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11509 may be linked anywhere in memory, the text and data segments must be less
11510 than 2GB in size and the data segment must be located within 2GB of the
11511 text segment.
11513 @item -mcmodel=embmedany
11514 @opindex mcmodel=embmedany
11515 Generate code for the Medium/Anywhere code model for embedded systems:
11516 64-bit addresses, the text and data segments must be less than 2GB in
11517 size, both starting anywhere in memory (determined at link time).  The
11518 global register %g4 points to the base of the data segment.  Programs
11519 are statically linked and PIC is not supported.
11521 @item -mstack-bias
11522 @itemx -mno-stack-bias
11523 @opindex mstack-bias
11524 @opindex mno-stack-bias
11525 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11526 frame pointer if present, are offset by @minus{}2047 which must be added back
11527 when making stack frame references.  This is the default in 64-bit mode.
11528 Otherwise, assume no such offset is present.
11529 @end table
11531 These switches are supported in addition to the above on Solaris:
11533 @table @gcctabopt
11534 @item -threads
11535 @opindex threads
11536 Add support for multithreading using the Solaris threads library.  This
11537 option sets flags for both the preprocessor and linker.  This option does
11538 not affect the thread safety of object code produced by the compiler or
11539 that of libraries supplied with it.
11541 @item -pthreads
11542 @opindex pthreads
11543 Add support for multithreading using the POSIX threads library.  This
11544 option sets flags for both the preprocessor and linker.  This option does
11545 not affect the thread safety of object code produced  by the compiler or
11546 that of libraries supplied with it.
11547 @end table
11549 @node System V Options
11550 @subsection Options for System V
11552 These additional options are available on System V Release 4 for
11553 compatibility with other compilers on those systems:
11555 @table @gcctabopt
11556 @item -G
11557 @opindex G
11558 Create a shared object.
11559 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11561 @item -Qy
11562 @opindex Qy
11563 Identify the versions of each tool used by the compiler, in a
11564 @code{.ident} assembler directive in the output.
11566 @item -Qn
11567 @opindex Qn
11568 Refrain from adding @code{.ident} directives to the output file (this is
11569 the default).
11571 @item -YP,@var{dirs}
11572 @opindex YP
11573 Search the directories @var{dirs}, and no others, for libraries
11574 specified with @option{-l}.
11576 @item -Ym,@var{dir}
11577 @opindex Ym
11578 Look in the directory @var{dir} to find the M4 preprocessor.
11579 The assembler uses this option.
11580 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11581 @c the generic assembler that comes with Solaris takes just -Ym.
11582 @end table
11584 @node TMS320C3x/C4x Options
11585 @subsection TMS320C3x/C4x Options
11586 @cindex TMS320C3x/C4x Options
11588 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11590 @table @gcctabopt
11592 @item -mcpu=@var{cpu_type}
11593 @opindex mcpu
11594 Set the instruction set, register set, and instruction scheduling
11595 parameters for machine type @var{cpu_type}.  Supported values for
11596 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11597 @samp{c44}.  The default is @samp{c40} to generate code for the
11598 TMS320C40.
11600 @item -mbig-memory
11601 @itemx -mbig
11602 @itemx -msmall-memory
11603 @itemx -msmall
11604 @opindex mbig-memory
11605 @opindex mbig
11606 @opindex msmall-memory
11607 @opindex msmall
11608 Generates code for the big or small memory model.  The small memory
11609 model assumed that all data fits into one 64K word page.  At run-time
11610 the data page (DP) register must be set to point to the 64K page
11611 containing the .bss and .data program sections.  The big memory model is
11612 the default and requires reloading of the DP register for every direct
11613 memory access.
11615 @item -mbk
11616 @itemx -mno-bk
11617 @opindex mbk
11618 @opindex mno-bk
11619 Allow (disallow) allocation of general integer operands into the block
11620 count register BK@.
11622 @item -mdb
11623 @itemx -mno-db
11624 @opindex mdb
11625 @opindex mno-db
11626 Enable (disable) generation of code using decrement and branch,
11627 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11628 on the safe side, this is disabled for the C3x, since the maximum
11629 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11630 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11631 that it can utilize the decrement and branch instruction, but will give
11632 up if there is more than one memory reference in the loop.  Thus a loop
11633 where the loop counter is decremented can generate slightly more
11634 efficient code, in cases where the RPTB instruction cannot be utilized.
11636 @item -mdp-isr-reload
11637 @itemx -mparanoid
11638 @opindex mdp-isr-reload
11639 @opindex mparanoid
11640 Force the DP register to be saved on entry to an interrupt service
11641 routine (ISR), reloaded to point to the data section, and restored on
11642 exit from the ISR@.  This should not be required unless someone has
11643 violated the small memory model by modifying the DP register, say within
11644 an object library.
11646 @item -mmpyi
11647 @itemx -mno-mpyi
11648 @opindex mmpyi
11649 @opindex mno-mpyi
11650 For the C3x use the 24-bit MPYI instruction for integer multiplies
11651 instead of a library call to guarantee 32-bit results.  Note that if one
11652 of the operands is a constant, then the multiplication will be performed
11653 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11654 then squaring operations are performed inline instead of a library call.
11656 @item -mfast-fix
11657 @itemx -mno-fast-fix
11658 @opindex mfast-fix
11659 @opindex mno-fast-fix
11660 The C3x/C4x FIX instruction to convert a floating point value to an
11661 integer value chooses the nearest integer less than or equal to the
11662 floating point value rather than to the nearest integer.  Thus if the
11663 floating point number is negative, the result will be incorrectly
11664 truncated an additional code is necessary to detect and correct this
11665 case.  This option can be used to disable generation of the additional
11666 code required to correct the result.
11668 @item -mrptb
11669 @itemx -mno-rptb
11670 @opindex mrptb
11671 @opindex mno-rptb
11672 Enable (disable) generation of repeat block sequences using the RPTB
11673 instruction for zero overhead looping.  The RPTB construct is only used
11674 for innermost loops that do not call functions or jump across the loop
11675 boundaries.  There is no advantage having nested RPTB loops due to the
11676 overhead required to save and restore the RC, RS, and RE registers.
11677 This is enabled by default with @option{-O2}.
11679 @item -mrpts=@var{count}
11680 @itemx -mno-rpts
11681 @opindex mrpts
11682 @opindex mno-rpts
11683 Enable (disable) the use of the single instruction repeat instruction
11684 RPTS@.  If a repeat block contains a single instruction, and the loop
11685 count can be guaranteed to be less than the value @var{count}, GCC will
11686 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11687 then a RPTS will be emitted even if the loop count cannot be determined
11688 at compile time.  Note that the repeated instruction following RPTS does
11689 not have to be reloaded from memory each iteration, thus freeing up the
11690 CPU buses for operands.  However, since interrupts are blocked by this
11691 instruction, it is disabled by default.
11693 @item -mloop-unsigned
11694 @itemx -mno-loop-unsigned
11695 @opindex mloop-unsigned
11696 @opindex mno-loop-unsigned
11697 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11698 is @math{2^{31} + 1} since these instructions test if the iteration count is
11699 negative to terminate the loop.  If the iteration count is unsigned
11700 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11701 exceeded.  This switch allows an unsigned iteration count.
11703 @item -mti
11704 @opindex mti
11705 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11706 with.  This also enforces compatibility with the API employed by the TI
11707 C3x C compiler.  For example, long doubles are passed as structures
11708 rather than in floating point registers.
11710 @item -mregparm
11711 @itemx -mmemparm
11712 @opindex mregparm
11713 @opindex mmemparm
11714 Generate code that uses registers (stack) for passing arguments to functions.
11715 By default, arguments are passed in registers where possible rather
11716 than by pushing arguments on to the stack.
11718 @item -mparallel-insns
11719 @itemx -mno-parallel-insns
11720 @opindex mparallel-insns
11721 @opindex mno-parallel-insns
11722 Allow the generation of parallel instructions.  This is enabled by
11723 default with @option{-O2}.
11725 @item -mparallel-mpy
11726 @itemx -mno-parallel-mpy
11727 @opindex mparallel-mpy
11728 @opindex mno-parallel-mpy
11729 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11730 provided @option{-mparallel-insns} is also specified.  These instructions have
11731 tight register constraints which can pessimize the code generation
11732 of large functions.
11734 @end table
11736 @node V850 Options
11737 @subsection V850 Options
11738 @cindex V850 Options
11740 These @samp{-m} options are defined for V850 implementations:
11742 @table @gcctabopt
11743 @item -mlong-calls
11744 @itemx -mno-long-calls
11745 @opindex mlong-calls
11746 @opindex mno-long-calls
11747 Treat all calls as being far away (near).  If calls are assumed to be
11748 far away, the compiler will always load the functions address up into a
11749 register, and call indirect through the pointer.
11751 @item -mno-ep
11752 @itemx -mep
11753 @opindex mno-ep
11754 @opindex mep
11755 Do not optimize (do optimize) basic blocks that use the same index
11756 pointer 4 or more times to copy pointer into the @code{ep} register, and
11757 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11758 option is on by default if you optimize.
11760 @item -mno-prolog-function
11761 @itemx -mprolog-function
11762 @opindex mno-prolog-function
11763 @opindex mprolog-function
11764 Do not use (do use) external functions to save and restore registers
11765 at the prologue and epilogue of a function.  The external functions
11766 are slower, but use less code space if more than one function saves
11767 the same number of registers.  The @option{-mprolog-function} option
11768 is on by default if you optimize.
11770 @item -mspace
11771 @opindex mspace
11772 Try to make the code as small as possible.  At present, this just turns
11773 on the @option{-mep} and @option{-mprolog-function} options.
11775 @item -mtda=@var{n}
11776 @opindex mtda
11777 Put static or global variables whose size is @var{n} bytes or less into
11778 the tiny data area that register @code{ep} points to.  The tiny data
11779 area can hold up to 256 bytes in total (128 bytes for byte references).
11781 @item -msda=@var{n}
11782 @opindex msda
11783 Put static or global variables whose size is @var{n} bytes or less into
11784 the small data area that register @code{gp} points to.  The small data
11785 area can hold up to 64 kilobytes.
11787 @item -mzda=@var{n}
11788 @opindex mzda
11789 Put static or global variables whose size is @var{n} bytes or less into
11790 the first 32 kilobytes of memory.
11792 @item -mv850
11793 @opindex mv850
11794 Specify that the target processor is the V850.
11796 @item -mbig-switch
11797 @opindex mbig-switch
11798 Generate code suitable for big switch tables.  Use this option only if
11799 the assembler/linker complain about out of range branches within a switch
11800 table.
11802 @item -mapp-regs
11803 @opindex mapp-regs
11804 This option will cause r2 and r5 to be used in the code generated by
11805 the compiler.  This setting is the default.
11807 @item -mno-app-regs
11808 @opindex mno-app-regs
11809 This option will cause r2 and r5 to be treated as fixed registers.
11811 @item -mv850e1
11812 @opindex mv850e1
11813 Specify that the target processor is the V850E1.  The preprocessor
11814 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11815 this option is used.
11817 @item -mv850e
11818 @opindex mv850e
11819 Specify that the target processor is the V850E@.  The preprocessor
11820 constant @samp{__v850e__} will be defined if this option is used.
11822 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11823 are defined then a default target processor will be chosen and the
11824 relevant @samp{__v850*__} preprocessor constant will be defined.
11826 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11827 defined, regardless of which processor variant is the target.
11829 @item -mdisable-callt
11830 @opindex mdisable-callt
11831 This option will suppress generation of the CALLT instruction for the
11832 v850e and v850e1 flavors of the v850 architecture.  The default is
11833 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11835 @end table
11837 @node VAX Options
11838 @subsection VAX Options
11839 @cindex VAX options
11841 These @samp{-m} options are defined for the VAX:
11843 @table @gcctabopt
11844 @item -munix
11845 @opindex munix
11846 Do not output certain jump instructions (@code{aobleq} and so on)
11847 that the Unix assembler for the VAX cannot handle across long
11848 ranges.
11850 @item -mgnu
11851 @opindex mgnu
11852 Do output those jump instructions, on the assumption that you
11853 will assemble with the GNU assembler.
11855 @item -mg
11856 @opindex mg
11857 Output code for g-format floating point numbers instead of d-format.
11858 @end table
11860 @node x86-64 Options
11861 @subsection x86-64 Options
11862 @cindex x86-64 options
11864 These are listed under @xref{i386 and x86-64 Options}.
11866 @node Xstormy16 Options
11867 @subsection Xstormy16 Options
11868 @cindex Xstormy16 Options
11870 These options are defined for Xstormy16:
11872 @table @gcctabopt
11873 @item -msim
11874 @opindex msim
11875 Choose startup files and linker script suitable for the simulator.
11876 @end table
11878 @node Xtensa Options
11879 @subsection Xtensa Options
11880 @cindex Xtensa Options
11882 These options are supported for Xtensa targets:
11884 @table @gcctabopt
11885 @item -mconst16
11886 @itemx -mno-const16
11887 @opindex mconst16
11888 @opindex mno-const16
11889 Enable or disable use of @code{CONST16} instructions for loading
11890 constant values.  The @code{CONST16} instruction is currently not a
11891 standard option from Tensilica.  When enabled, @code{CONST16}
11892 instructions are always used in place of the standard @code{L32R}
11893 instructions.  The use of @code{CONST16} is enabled by default only if
11894 the @code{L32R} instruction is not available.
11896 @item -mfused-madd
11897 @itemx -mno-fused-madd
11898 @opindex mfused-madd
11899 @opindex mno-fused-madd
11900 Enable or disable use of fused multiply/add and multiply/subtract
11901 instructions in the floating-point option.  This has no effect if the
11902 floating-point option is not also enabled.  Disabling fused multiply/add
11903 and multiply/subtract instructions forces the compiler to use separate
11904 instructions for the multiply and add/subtract operations.  This may be
11905 desirable in some cases where strict IEEE 754-compliant results are
11906 required: the fused multiply add/subtract instructions do not round the
11907 intermediate result, thereby producing results with @emph{more} bits of
11908 precision than specified by the IEEE standard.  Disabling fused multiply
11909 add/subtract instructions also ensures that the program output is not
11910 sensitive to the compiler's ability to combine multiply and add/subtract
11911 operations.
11913 @item -mtext-section-literals
11914 @itemx -mno-text-section-literals
11915 @opindex mtext-section-literals
11916 @opindex mno-text-section-literals
11917 Control the treatment of literal pools.  The default is
11918 @option{-mno-text-section-literals}, which places literals in a separate
11919 section in the output file.  This allows the literal pool to be placed
11920 in a data RAM/ROM, and it also allows the linker to combine literal
11921 pools from separate object files to remove redundant literals and
11922 improve code size.  With @option{-mtext-section-literals}, the literals
11923 are interspersed in the text section in order to keep them as close as
11924 possible to their references.  This may be necessary for large assembly
11925 files.
11927 @item -mtarget-align
11928 @itemx -mno-target-align
11929 @opindex mtarget-align
11930 @opindex mno-target-align
11931 When this option is enabled, GCC instructs the assembler to
11932 automatically align instructions to reduce branch penalties at the
11933 expense of some code density.  The assembler attempts to widen density
11934 instructions to align branch targets and the instructions following call
11935 instructions.  If there are not enough preceding safe density
11936 instructions to align a target, no widening will be performed.  The
11937 default is @option{-mtarget-align}.  These options do not affect the
11938 treatment of auto-aligned instructions like @code{LOOP}, which the
11939 assembler will always align, either by widening density instructions or
11940 by inserting no-op instructions.
11942 @item -mlongcalls
11943 @itemx -mno-longcalls
11944 @opindex mlongcalls
11945 @opindex mno-longcalls
11946 When this option is enabled, GCC instructs the assembler to translate
11947 direct calls to indirect calls unless it can determine that the target
11948 of a direct call is in the range allowed by the call instruction.  This
11949 translation typically occurs for calls to functions in other source
11950 files.  Specifically, the assembler translates a direct @code{CALL}
11951 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11952 The default is @option{-mno-longcalls}.  This option should be used in
11953 programs where the call target can potentially be out of range.  This
11954 option is implemented in the assembler, not the compiler, so the
11955 assembly code generated by GCC will still show direct call
11956 instructions---look at the disassembled object code to see the actual
11957 instructions.  Note that the assembler will use an indirect call for
11958 every cross-file call, not just those that really will be out of range.
11959 @end table
11961 @node zSeries Options
11962 @subsection zSeries Options
11963 @cindex zSeries options
11965 These are listed under @xref{S/390 and zSeries Options}.
11967 @node Code Gen Options
11968 @section Options for Code Generation Conventions
11969 @cindex code generation conventions
11970 @cindex options, code generation
11971 @cindex run-time options
11973 These machine-independent options control the interface conventions
11974 used in code generation.
11976 Most of them have both positive and negative forms; the negative form
11977 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11978 one of the forms is listed---the one which is not the default.  You
11979 can figure out the other form by either removing @samp{no-} or adding
11982 @table @gcctabopt
11983 @item -fbounds-check
11984 @opindex fbounds-check
11985 For front-ends that support it, generate additional code to check that
11986 indices used to access arrays are within the declared range.  This is
11987 currently only supported by the Java and Fortran 77 front-ends, where
11988 this option defaults to true and false respectively.
11990 @item -ftrapv
11991 @opindex ftrapv
11992 This option generates traps for signed overflow on addition, subtraction,
11993 multiplication operations.
11995 @item -fwrapv
11996 @opindex fwrapv
11997 This option instructs the compiler to assume that signed arithmetic
11998 overflow of addition, subtraction and multiplication wraps around
11999 using twos-complement representation.  This flag enables some optimizations
12000 and disables other.  This option is enabled by default for the Java
12001 front-end, as required by the Java language specification.
12003 @item -fexceptions
12004 @opindex fexceptions
12005 Enable exception handling.  Generates extra code needed to propagate
12006 exceptions.  For some targets, this implies GCC will generate frame
12007 unwind information for all functions, which can produce significant data
12008 size overhead, although it does not affect execution.  If you do not
12009 specify this option, GCC will enable it by default for languages like
12010 C++ which normally require exception handling, and disable it for
12011 languages like C that do not normally require it.  However, you may need
12012 to enable this option when compiling C code that needs to interoperate
12013 properly with exception handlers written in C++.  You may also wish to
12014 disable this option if you are compiling older C++ programs that don't
12015 use exception handling.
12017 @item -fnon-call-exceptions
12018 @opindex fnon-call-exceptions
12019 Generate code that allows trapping instructions to throw exceptions.
12020 Note that this requires platform-specific runtime support that does
12021 not exist everywhere.  Moreover, it only allows @emph{trapping}
12022 instructions to throw exceptions, i.e.@: memory references or floating
12023 point instructions.  It does not allow exceptions to be thrown from
12024 arbitrary signal handlers such as @code{SIGALRM}.
12026 @item -funwind-tables
12027 @opindex funwind-tables
12028 Similar to @option{-fexceptions}, except that it will just generate any needed
12029 static data, but will not affect the generated code in any other way.
12030 You will normally not enable this option; instead, a language processor
12031 that needs this handling would enable it on your behalf.
12033 @item -fasynchronous-unwind-tables
12034 @opindex fasynchronous-unwind-tables
12035 Generate unwind table in dwarf2 format, if supported by target machine.  The
12036 table is exact at each instruction boundary, so it can be used for stack
12037 unwinding from asynchronous events (such as debugger or garbage collector).
12039 @item -fpcc-struct-return
12040 @opindex fpcc-struct-return
12041 Return ``short'' @code{struct} and @code{union} values in memory like
12042 longer ones, rather than in registers.  This convention is less
12043 efficient, but it has the advantage of allowing intercallability between
12044 GCC-compiled files and files compiled with other compilers, particularly
12045 the Portable C Compiler (pcc).
12047 The precise convention for returning structures in memory depends
12048 on the target configuration macros.
12050 Short structures and unions are those whose size and alignment match
12051 that of some integer type.
12053 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12054 switch is not binary compatible with code compiled with the
12055 @option{-freg-struct-return} switch.
12056 Use it to conform to a non-default application binary interface.
12058 @item -freg-struct-return
12059 @opindex freg-struct-return
12060 Return @code{struct} and @code{union} values in registers when possible.
12061 This is more efficient for small structures than
12062 @option{-fpcc-struct-return}.
12064 If you specify neither @option{-fpcc-struct-return} nor
12065 @option{-freg-struct-return}, GCC defaults to whichever convention is
12066 standard for the target.  If there is no standard convention, GCC
12067 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12068 the principal compiler.  In those cases, we can choose the standard, and
12069 we chose the more efficient register return alternative.
12071 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12072 switch is not binary compatible with code compiled with the
12073 @option{-fpcc-struct-return} switch.
12074 Use it to conform to a non-default application binary interface.
12076 @item -fshort-enums
12077 @opindex fshort-enums
12078 Allocate to an @code{enum} type only as many bytes as it needs for the
12079 declared range of possible values.  Specifically, the @code{enum} type
12080 will be equivalent to the smallest integer type which has enough room.
12082 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12083 code that is not binary compatible with code generated without that switch.
12084 Use it to conform to a non-default application binary interface.
12086 @item -fshort-double
12087 @opindex fshort-double
12088 Use the same size for @code{double} as for @code{float}.
12090 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12091 code that is not binary compatible with code generated without that switch.
12092 Use it to conform to a non-default application binary interface.
12094 @item -fshort-wchar
12095 @opindex fshort-wchar
12096 Override the underlying type for @samp{wchar_t} to be @samp{short
12097 unsigned int} instead of the default for the target.  This option is
12098 useful for building programs to run under WINE@.
12100 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12101 code that is not binary compatible with code generated without that switch.
12102 Use it to conform to a non-default application binary interface.
12104 @item -fshared-data
12105 @opindex fshared-data
12106 Requests that the data and non-@code{const} variables of this
12107 compilation be shared data rather than private data.  The distinction
12108 makes sense only on certain operating systems, where shared data is
12109 shared between processes running the same program, while private data
12110 exists in one copy per process.
12112 @item -fno-common
12113 @opindex fno-common
12114 In C, allocate even uninitialized global variables in the data section of the
12115 object file, rather than generating them as common blocks.  This has the
12116 effect that if the same variable is declared (without @code{extern}) in
12117 two different compilations, you will get an error when you link them.
12118 The only reason this might be useful is if you wish to verify that the
12119 program will work on other systems which always work this way.
12121 @item -fno-ident
12122 @opindex fno-ident
12123 Ignore the @samp{#ident} directive.
12125 @item -finhibit-size-directive
12126 @opindex finhibit-size-directive
12127 Don't output a @code{.size} assembler directive, or anything else that
12128 would cause trouble if the function is split in the middle, and the
12129 two halves are placed at locations far apart in memory.  This option is
12130 used when compiling @file{crtstuff.c}; you should not need to use it
12131 for anything else.
12133 @item -fverbose-asm
12134 @opindex fverbose-asm
12135 Put extra commentary information in the generated assembly code to
12136 make it more readable.  This option is generally only of use to those
12137 who actually need to read the generated assembly code (perhaps while
12138 debugging the compiler itself).
12140 @option{-fno-verbose-asm}, the default, causes the
12141 extra information to be omitted and is useful when comparing two assembler
12142 files.
12144 @item -fpic
12145 @opindex fpic
12146 @cindex global offset table
12147 @cindex PIC
12148 Generate position-independent code (PIC) suitable for use in a shared
12149 library, if supported for the target machine.  Such code accesses all
12150 constant addresses through a global offset table (GOT)@.  The dynamic
12151 loader resolves the GOT entries when the program starts (the dynamic
12152 loader is not part of GCC; it is part of the operating system).  If
12153 the GOT size for the linked executable exceeds a machine-specific
12154 maximum size, you get an error message from the linker indicating that
12155 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12156 instead.  (These maximums are 8k on the SPARC and 32k
12157 on the m68k and RS/6000.  The 386 has no such limit.)
12159 Position-independent code requires special support, and therefore works
12160 only on certain machines.  For the 386, GCC supports PIC for System V
12161 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12162 position-independent.
12164 @item -fPIC
12165 @opindex fPIC
12166 If supported for the target machine, emit position-independent code,
12167 suitable for dynamic linking and avoiding any limit on the size of the
12168 global offset table.  This option makes a difference on the m68k,
12169 PowerPC and SPARC@.
12171 Position-independent code requires special support, and therefore works
12172 only on certain machines.
12174 @item -fpie
12175 @itemx -fPIE
12176 @opindex fpie
12177 @opindex fPIE
12178 These options are similar to @option{-fpic} and @option{-fPIC}, but
12179 generated position independent code can be only linked into executables.
12180 Usually these options are used when @option{-pie} GCC option will be
12181 used during linking.
12183 @item -ffixed-@var{reg}
12184 @opindex ffixed
12185 Treat the register named @var{reg} as a fixed register; generated code
12186 should never refer to it (except perhaps as a stack pointer, frame
12187 pointer or in some other fixed role).
12189 @var{reg} must be the name of a register.  The register names accepted
12190 are machine-specific and are defined in the @code{REGISTER_NAMES}
12191 macro in the machine description macro file.
12193 This flag does not have a negative form, because it specifies a
12194 three-way choice.
12196 @item -fcall-used-@var{reg}
12197 @opindex fcall-used
12198 Treat the register named @var{reg} as an allocable register that is
12199 clobbered by function calls.  It may be allocated for temporaries or
12200 variables that do not live across a call.  Functions compiled this way
12201 will not save and restore the register @var{reg}.
12203 It is an error to used this flag with the frame pointer or stack pointer.
12204 Use of this flag for other registers that have fixed pervasive roles in
12205 the machine's execution model will produce disastrous results.
12207 This flag does not have a negative form, because it specifies a
12208 three-way choice.
12210 @item -fcall-saved-@var{reg}
12211 @opindex fcall-saved
12212 Treat the register named @var{reg} as an allocable register saved by
12213 functions.  It may be allocated even for temporaries or variables that
12214 live across a call.  Functions compiled this way will save and restore
12215 the register @var{reg} if they use it.
12217 It is an error to used this flag with the frame pointer or stack pointer.
12218 Use of this flag for other registers that have fixed pervasive roles in
12219 the machine's execution model will produce disastrous results.
12221 A different sort of disaster will result from the use of this flag for
12222 a register in which function values may be returned.
12224 This flag does not have a negative form, because it specifies a
12225 three-way choice.
12227 @item -fpack-struct[=@var{n}]
12228 @opindex fpack-struct
12229 Without a value specified, pack all structure members together without
12230 holes.  When a value is specified (which must be a small power of two), pack
12231 structure members according to this value, representing the maximum
12232 alignment (that is, objects with default alignment requirements larger than
12233 this will be output potentially unaligned at the next fitting location.
12235 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12236 code that is not binary compatible with code generated without that switch.
12237 Additionally, it makes the code suboptimal.
12238 Use it to conform to a non-default application binary interface.
12240 @item -finstrument-functions
12241 @opindex finstrument-functions
12242 Generate instrumentation calls for entry and exit to functions.  Just
12243 after function entry and just before function exit, the following
12244 profiling functions will be called with the address of the current
12245 function and its call site.  (On some platforms,
12246 @code{__builtin_return_address} does not work beyond the current
12247 function, so the call site information may not be available to the
12248 profiling functions otherwise.)
12250 @smallexample
12251 void __cyg_profile_func_enter (void *this_fn,
12252                                void *call_site);
12253 void __cyg_profile_func_exit  (void *this_fn,
12254                                void *call_site);
12255 @end smallexample
12257 The first argument is the address of the start of the current function,
12258 which may be looked up exactly in the symbol table.
12260 This instrumentation is also done for functions expanded inline in other
12261 functions.  The profiling calls will indicate where, conceptually, the
12262 inline function is entered and exited.  This means that addressable
12263 versions of such functions must be available.  If all your uses of a
12264 function are expanded inline, this may mean an additional expansion of
12265 code size.  If you use @samp{extern inline} in your C code, an
12266 addressable version of such functions must be provided.  (This is
12267 normally the case anyways, but if you get lucky and the optimizer always
12268 expands the functions inline, you might have gotten away without
12269 providing static copies.)
12271 A function may be given the attribute @code{no_instrument_function}, in
12272 which case this instrumentation will not be done.  This can be used, for
12273 example, for the profiling functions listed above, high-priority
12274 interrupt routines, and any functions from which the profiling functions
12275 cannot safely be called (perhaps signal handlers, if the profiling
12276 routines generate output or allocate memory).
12278 @item -fstack-check
12279 @opindex fstack-check
12280 Generate code to verify that you do not go beyond the boundary of the
12281 stack.  You should specify this flag if you are running in an
12282 environment with multiple threads, but only rarely need to specify it in
12283 a single-threaded environment since stack overflow is automatically
12284 detected on nearly all systems if there is only one stack.
12286 Note that this switch does not actually cause checking to be done; the
12287 operating system must do that.  The switch causes generation of code
12288 to ensure that the operating system sees the stack being extended.
12290 @item -fstack-limit-register=@var{reg}
12291 @itemx -fstack-limit-symbol=@var{sym}
12292 @itemx -fno-stack-limit
12293 @opindex fstack-limit-register
12294 @opindex fstack-limit-symbol
12295 @opindex fno-stack-limit
12296 Generate code to ensure that the stack does not grow beyond a certain value,
12297 either the value of a register or the address of a symbol.  If the stack
12298 would grow beyond the value, a signal is raised.  For most targets,
12299 the signal is raised before the stack overruns the boundary, so
12300 it is possible to catch the signal without taking special precautions.
12302 For instance, if the stack starts at absolute address @samp{0x80000000}
12303 and grows downwards, you can use the flags
12304 @option{-fstack-limit-symbol=__stack_limit} and
12305 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12306 of 128KB@.  Note that this may only work with the GNU linker.
12308 @cindex aliasing of parameters
12309 @cindex parameters, aliased
12310 @item -fargument-alias
12311 @itemx -fargument-noalias
12312 @itemx -fargument-noalias-global
12313 @opindex fargument-alias
12314 @opindex fargument-noalias
12315 @opindex fargument-noalias-global
12316 Specify the possible relationships among parameters and between
12317 parameters and global data.
12319 @option{-fargument-alias} specifies that arguments (parameters) may
12320 alias each other and may alias global storage.@*
12321 @option{-fargument-noalias} specifies that arguments do not alias
12322 each other, but may alias global storage.@*
12323 @option{-fargument-noalias-global} specifies that arguments do not
12324 alias each other and do not alias global storage.
12326 Each language will automatically use whatever option is required by
12327 the language standard.  You should not need to use these options yourself.
12329 @item -fleading-underscore
12330 @opindex fleading-underscore
12331 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12332 change the way C symbols are represented in the object file.  One use
12333 is to help link with legacy assembly code.
12335 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12336 generate code that is not binary compatible with code generated without that
12337 switch.  Use it to conform to a non-default application binary interface.
12338 Not all targets provide complete support for this switch.
12340 @item -ftls-model=@var{model}
12341 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12342 The @var{model} argument should be one of @code{global-dynamic},
12343 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12345 The default without @option{-fpic} is @code{initial-exec}; with
12346 @option{-fpic} the default is @code{global-dynamic}.
12348 @item -fvisibility=@var{default|internal|hidden|protected}
12349 @opindex fvisibility
12350 Set the default ELF image symbol visibility to the specified option---all
12351 symbols will be marked with this unless overridden within the code.
12352 Using this feature can very substantially improve linking and
12353 load times of shared object libraries, produce more optimized
12354 code, provide near-perfect API export and prevent symbol clashes.
12355 It is @strong{strongly} recommended that you use this in any shared objects
12356 you distribute.
12358 Despite the nomenclature, @code{default} always means public ie;
12359 available to be linked against from outside the shared object.
12360 @code{protected} and @code{internal} are pretty useless in real-world
12361 usage so the only other commonly used option will be @code{hidden}.
12362 The default if @option{-fvisibility} isn't specified is
12363 @code{default}, i.e., make every
12364 symbol public---this causes the same behavior as previous versions of
12365 GCC@.
12367 A good explanation of the benefits offered by ensuring ELF
12368 symbols have the correct visibility is given by ``How To Write
12369 Shared Libraries'' by Ulrich Drepper (which can be found at
12370 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12371 solution made possible by this option to marking things hidden when
12372 the default is public is to make the default hidden and mark things
12373 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12374 and @code{__attribute__ ((visibility("default")))} instead of
12375 @code{__declspec(dllexport)} you get almost identical semantics with
12376 identical syntax.  This is a great boon to those working with
12377 cross-platform projects.
12379 For those adding visibility support to existing code, you may find
12380 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12381 the declarations you wish to set visibility for with (for example)
12382 @samp{#pragma GCC visibility push(hidden)} and
12383 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12384 times.  Bear in mind that symbol visibility should be viewed @strong{as
12385 part of the API interface contract} and thus all new code should
12386 always specify visibility when it is not the default ie; declarations
12387 only for use within the local DSO should @strong{always} be marked explicitly
12388 as hidden as so to avoid PLT indirection overheads---making this
12389 abundantly clear also aids readability and self-documentation of the code.
12390 Note that due to ISO C++ specification requirements, operator new and
12391 operator delete must always be of default visibility.
12393 @end table
12395 @c man end
12397 @node Environment Variables
12398 @section Environment Variables Affecting GCC
12399 @cindex environment variables
12401 @c man begin ENVIRONMENT
12402 This section describes several environment variables that affect how GCC
12403 operates.  Some of them work by specifying directories or prefixes to use
12404 when searching for various kinds of files.  Some are used to specify other
12405 aspects of the compilation environment.
12407 Note that you can also specify places to search using options such as
12408 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12409 take precedence over places specified using environment variables, which
12410 in turn take precedence over those specified by the configuration of GCC@.
12411 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12412 GNU Compiler Collection (GCC) Internals}.
12414 @table @env
12415 @item LANG
12416 @itemx LC_CTYPE
12417 @c @itemx LC_COLLATE
12418 @itemx LC_MESSAGES
12419 @c @itemx LC_MONETARY
12420 @c @itemx LC_NUMERIC
12421 @c @itemx LC_TIME
12422 @itemx LC_ALL
12423 @findex LANG
12424 @findex LC_CTYPE
12425 @c @findex LC_COLLATE
12426 @findex LC_MESSAGES
12427 @c @findex LC_MONETARY
12428 @c @findex LC_NUMERIC
12429 @c @findex LC_TIME
12430 @findex LC_ALL
12431 @cindex locale
12432 These environment variables control the way that GCC uses
12433 localization information that allow GCC to work with different
12434 national conventions.  GCC inspects the locale categories
12435 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12436 so.  These locale categories can be set to any value supported by your
12437 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12438 Kingdom encoded in UTF-8.
12440 The @env{LC_CTYPE} environment variable specifies character
12441 classification.  GCC uses it to determine the character boundaries in
12442 a string; this is needed for some multibyte encodings that contain quote
12443 and escape characters that would otherwise be interpreted as a string
12444 end or escape.
12446 The @env{LC_MESSAGES} environment variable specifies the language to
12447 use in diagnostic messages.
12449 If the @env{LC_ALL} environment variable is set, it overrides the value
12450 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12451 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12452 environment variable.  If none of these variables are set, GCC
12453 defaults to traditional C English behavior.
12455 @item TMPDIR
12456 @findex TMPDIR
12457 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12458 files.  GCC uses temporary files to hold the output of one stage of
12459 compilation which is to be used as input to the next stage: for example,
12460 the output of the preprocessor, which is the input to the compiler
12461 proper.
12463 @item GCC_EXEC_PREFIX
12464 @findex GCC_EXEC_PREFIX
12465 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12466 names of the subprograms executed by the compiler.  No slash is added
12467 when this prefix is combined with the name of a subprogram, but you can
12468 specify a prefix that ends with a slash if you wish.
12470 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12471 an appropriate prefix to use based on the pathname it was invoked with.
12473 If GCC cannot find the subprogram using the specified prefix, it
12474 tries looking in the usual places for the subprogram.
12476 The default value of @env{GCC_EXEC_PREFIX} is
12477 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12478 of @code{prefix} when you ran the @file{configure} script.
12480 Other prefixes specified with @option{-B} take precedence over this prefix.
12482 This prefix is also used for finding files such as @file{crt0.o} that are
12483 used for linking.
12485 In addition, the prefix is used in an unusual way in finding the
12486 directories to search for header files.  For each of the standard
12487 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12488 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12489 replacing that beginning with the specified prefix to produce an
12490 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12491 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12492 These alternate directories are searched first; the standard directories
12493 come next.
12495 @item COMPILER_PATH
12496 @findex COMPILER_PATH
12497 The value of @env{COMPILER_PATH} is a colon-separated list of
12498 directories, much like @env{PATH}.  GCC tries the directories thus
12499 specified when searching for subprograms, if it can't find the
12500 subprograms using @env{GCC_EXEC_PREFIX}.
12502 @item LIBRARY_PATH
12503 @findex LIBRARY_PATH
12504 The value of @env{LIBRARY_PATH} is a colon-separated list of
12505 directories, much like @env{PATH}.  When configured as a native compiler,
12506 GCC tries the directories thus specified when searching for special
12507 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12508 using GCC also uses these directories when searching for ordinary
12509 libraries for the @option{-l} option (but directories specified with
12510 @option{-L} come first).
12512 @item LANG
12513 @findex LANG
12514 @cindex locale definition
12515 This variable is used to pass locale information to the compiler.  One way in
12516 which this information is used is to determine the character set to be used
12517 when character literals, string literals and comments are parsed in C and C++.
12518 When the compiler is configured to allow multibyte characters,
12519 the following values for @env{LANG} are recognized:
12521 @table @samp
12522 @item C-JIS
12523 Recognize JIS characters.
12524 @item C-SJIS
12525 Recognize SJIS characters.
12526 @item C-EUCJP
12527 Recognize EUCJP characters.
12528 @end table
12530 If @env{LANG} is not defined, or if it has some other value, then the
12531 compiler will use mblen and mbtowc as defined by the default locale to
12532 recognize and translate multibyte characters.
12533 @end table
12535 @noindent
12536 Some additional environments variables affect the behavior of the
12537 preprocessor.
12539 @include cppenv.texi
12541 @c man end
12543 @node Precompiled Headers
12544 @section Using Precompiled Headers
12545 @cindex precompiled headers
12546 @cindex speed of compilation
12548 Often large projects have many header files that are included in every
12549 source file.  The time the compiler takes to process these header files
12550 over and over again can account for nearly all of the time required to
12551 build the project.  To make builds faster, GCC allows users to
12552 `precompile' a header file; then, if builds can use the precompiled
12553 header file they will be much faster.
12555 @strong{Caution:} There are a few known situations where GCC will
12556 crash when trying to use a precompiled header.  If you have trouble
12557 with a precompiled header, you should remove the precompiled header
12558 and compile without it.  In addition, please use GCC's on-line
12559 defect-tracking system to report any problems you encounter with
12560 precompiled headers.  @xref{Bugs}.
12562 To create a precompiled header file, simply compile it as you would any
12563 other file, if necessary using the @option{-x} option to make the driver
12564 treat it as a C or C++ header file.  You will probably want to use a
12565 tool like @command{make} to keep the precompiled header up-to-date when
12566 the headers it contains change.
12568 A precompiled header file will be searched for when @code{#include} is
12569 seen in the compilation.  As it searches for the included file
12570 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12571 compiler looks for a precompiled header in each directory just before it
12572 looks for the include file in that directory.  The name searched for is
12573 the name specified in the @code{#include} with @samp{.gch} appended.  If
12574 the precompiled header file can't be used, it is ignored.
12576 For instance, if you have @code{#include "all.h"}, and you have
12577 @file{all.h.gch} in the same directory as @file{all.h}, then the
12578 precompiled header file will be used if possible, and the original
12579 header will be used otherwise.
12581 Alternatively, you might decide to put the precompiled header file in a
12582 directory and use @option{-I} to ensure that directory is searched
12583 before (or instead of) the directory containing the original header.
12584 Then, if you want to check that the precompiled header file is always
12585 used, you can put a file of the same name as the original header in this
12586 directory containing an @code{#error} command.
12588 This also works with @option{-include}.  So yet another way to use
12589 precompiled headers, good for projects not designed with precompiled
12590 header files in mind, is to simply take most of the header files used by
12591 a project, include them from another header file, precompile that header
12592 file, and @option{-include} the precompiled header.  If the header files
12593 have guards against multiple inclusion, they will be skipped because
12594 they've already been included (in the precompiled header).
12596 If you need to precompile the same header file for different
12597 languages, targets, or compiler options, you can instead make a
12598 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12599 header in the directory, perhaps using @option{-o}.  It doesn't matter
12600 what you call the files in the directory, every precompiled header in
12601 the directory will be considered.  The first precompiled header
12602 encountered in the directory that is valid for this compilation will
12603 be used; they're searched in no particular order.
12605 There are many other possibilities, limited only by your imagination,
12606 good sense, and the constraints of your build system.
12608 A precompiled header file can be used only when these conditions apply:
12610 @itemize
12611 @item
12612 Only one precompiled header can be used in a particular compilation.
12614 @item
12615 A precompiled header can't be used once the first C token is seen.  You
12616 can have preprocessor directives before a precompiled header; you can
12617 even include a precompiled header from inside another header, so long as
12618 there are no C tokens before the @code{#include}.
12620 @item
12621 The precompiled header file must be produced for the same language as
12622 the current compilation.  You can't use a C precompiled header for a C++
12623 compilation.
12625 @item
12626 The precompiled header file must be produced by the same compiler
12627 version and configuration as the current compilation is using.
12628 The easiest way to guarantee this is to use the same compiler binary
12629 for creating and using precompiled headers.
12631 @item
12632 Any macros defined before the precompiled header is included must
12633 either be defined in the same way as when the precompiled header was
12634 generated, or must not affect the precompiled header, which usually
12635 means that the they don't appear in the precompiled header at all.
12637 The @option{-D} option is one way to define a macro before a
12638 precompiled header is included; using a @code{#define} can also do it.
12639 There are also some options that define macros implicitly, like
12640 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12641 defined this way.
12643 @item If debugging information is output when using the precompiled
12644 header, using @option{-g} or similar, the same kind of debugging information
12645 must have been output when building the precompiled header.  However,
12646 a precompiled header built using @option{-g} can be used in a compilation
12647 when no debugging information is being output.
12649 @item The same @option{-m} options must generally be used when building
12650 and using the precompiled header.  @xref{Submodel Options},
12651 for any cases where this rule is relaxed.
12653 @item Each of the following options must be the same when building and using
12654 the precompiled header:
12656 @gccoptlist{-fexceptions -funit-at-a-time}
12658 @item
12659 Some other command-line options starting with @option{-f},
12660 @option{-p}, or @option{-O} must be defined in the same way as when
12661 the precompiled header was generated.  At present, it's not clear
12662 which options are safe to change and which are not; the safest choice
12663 is to use exactly the same options when generating and using the
12664 precompiled header.  The following are known to be safe:
12666 @gccoptlist{-fpreprocessed -pedantic-errors}
12668 @end itemize
12670 For all of these except the last, the compiler will automatically
12671 ignore the precompiled header if the conditions aren't met.  If you
12672 find an option combination that doesn't work and doesn't cause the
12673 precompiled header to be ignored, please consider filing a bug report,
12674 see @ref{Bugs}.
12676 If you do use differing options when generating and using the
12677 precompiled header, the actual behavior will be a mixture of the
12678 behavior for the options.  For instance, if you use @option{-g} to
12679 generate the precompiled header but not when using it, you may or may
12680 not get debugging information for routines in the precompiled header.
12682 @node Running Protoize
12683 @section Running Protoize
12685 The program @code{protoize} is an optional part of GCC@.  You can use
12686 it to add prototypes to a program, thus converting the program to ISO
12687 C in one respect.  The companion program @code{unprotoize} does the
12688 reverse: it removes argument types from any prototypes that are found.
12690 When you run these programs, you must specify a set of source files as
12691 command line arguments.  The conversion programs start out by compiling
12692 these files to see what functions they define.  The information gathered
12693 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12695 After scanning comes actual conversion.  The specified files are all
12696 eligible to be converted; any files they include (whether sources or
12697 just headers) are eligible as well.
12699 But not all the eligible files are converted.  By default,
12700 @code{protoize} and @code{unprotoize} convert only source and header
12701 files in the current directory.  You can specify additional directories
12702 whose files should be converted with the @option{-d @var{directory}}
12703 option.  You can also specify particular files to exclude with the
12704 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12705 directory name matches one of the specified directory names, and its
12706 name within the directory has not been excluded.
12708 Basic conversion with @code{protoize} consists of rewriting most
12709 function definitions and function declarations to specify the types of
12710 the arguments.  The only ones not rewritten are those for varargs
12711 functions.
12713 @code{protoize} optionally inserts prototype declarations at the
12714 beginning of the source file, to make them available for any calls that
12715 precede the function's definition.  Or it can insert prototype
12716 declarations with block scope in the blocks where undeclared functions
12717 are called.
12719 Basic conversion with @code{unprotoize} consists of rewriting most
12720 function declarations to remove any argument types, and rewriting
12721 function definitions to the old-style pre-ISO form.
12723 Both conversion programs print a warning for any function declaration or
12724 definition that they can't convert.  You can suppress these warnings
12725 with @option{-q}.
12727 The output from @code{protoize} or @code{unprotoize} replaces the
12728 original source file.  The original file is renamed to a name ending
12729 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12730 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12731 for DOS) file already exists, then the source file is simply discarded.
12733 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12734 scan the program and collect information about the functions it uses.
12735 So neither of these programs will work until GCC is installed.
12737 Here is a table of the options you can use with @code{protoize} and
12738 @code{unprotoize}.  Each option works with both programs unless
12739 otherwise stated.
12741 @table @code
12742 @item -B @var{directory}
12743 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12744 usual directory (normally @file{/usr/local/lib}).  This file contains
12745 prototype information about standard system functions.  This option
12746 applies only to @code{protoize}.
12748 @item -c @var{compilation-options}
12749 Use @var{compilation-options} as the options when running @command{gcc} to
12750 produce the @samp{.X} files.  The special option @option{-aux-info} is
12751 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12753 Note that the compilation options must be given as a single argument to
12754 @code{protoize} or @code{unprotoize}.  If you want to specify several
12755 @command{gcc} options, you must quote the entire set of compilation options
12756 to make them a single word in the shell.
12758 There are certain @command{gcc} arguments that you cannot use, because they
12759 would produce the wrong kind of output.  These include @option{-g},
12760 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12761 the @var{compilation-options}, they are ignored.
12763 @item -C
12764 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12765 systems) instead of @samp{.c}.  This is convenient if you are converting
12766 a C program to C++.  This option applies only to @code{protoize}.
12768 @item -g
12769 Add explicit global declarations.  This means inserting explicit
12770 declarations at the beginning of each source file for each function
12771 that is called in the file and was not declared.  These declarations
12772 precede the first function definition that contains a call to an
12773 undeclared function.  This option applies only to @code{protoize}.
12775 @item -i @var{string}
12776 Indent old-style parameter declarations with the string @var{string}.
12777 This option applies only to @code{protoize}.
12779 @code{unprotoize} converts prototyped function definitions to old-style
12780 function definitions, where the arguments are declared between the
12781 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12782 uses five spaces as the indentation.  If you want to indent with just
12783 one space instead, use @option{-i " "}.
12785 @item -k
12786 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12787 is finished.
12789 @item -l
12790 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12791 a prototype declaration for each function in each block which calls the
12792 function without any declaration.  This option applies only to
12793 @code{protoize}.
12795 @item -n
12796 Make no real changes.  This mode just prints information about the conversions
12797 that would have been done without @option{-n}.
12799 @item -N
12800 Make no @samp{.save} files.  The original files are simply deleted.
12801 Use this option with caution.
12803 @item -p @var{program}
12804 Use the program @var{program} as the compiler.  Normally, the name
12805 @file{gcc} is used.
12807 @item -q
12808 Work quietly.  Most warnings are suppressed.
12810 @item -v
12811 Print the version number, just like @option{-v} for @command{gcc}.
12812 @end table
12814 If you need special compiler options to compile one of your program's
12815 source files, then you should generate that file's @samp{.X} file
12816 specially, by running @command{gcc} on that source file with the
12817 appropriate options and the option @option{-aux-info}.  Then run
12818 @code{protoize} on the entire set of files.  @code{protoize} will use
12819 the existing @samp{.X} file because it is newer than the source file.
12820 For example:
12822 @smallexample
12823 gcc -Dfoo=bar file1.c -aux-info file1.X
12824 protoize *.c
12825 @end smallexample
12827 @noindent
12828 You need to include the special files along with the rest in the
12829 @code{protoize} command, even though their @samp{.X} files already
12830 exist, because otherwise they won't get converted.
12832 @xref{Protoize Caveats}, for more information on how to use
12833 @code{protoize} successfully.