PR target/19019
[official-gcc.git] / gcc / doc / invoke.texi
bloba93c8f0ca423f579c56907da561d06318cc7e203
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  -Wendif-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-sra@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
269 -ftree-vectorizer-verbose=@var{n} @gol
270 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
271 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
272 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
273 -ftest-coverage  -ftime-report -fvar-tracking @gol
274 -g  -g@var{level}  -gcoff -gdwarf-2 @gol
275 -ggdb  -gstabs  -gstabs+  -gvms  -gxcoff  -gxcoff+ @gol
276 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
277 -print-multi-directory  -print-multi-lib @gol
278 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
279 -save-temps  -time}
281 @item Optimization Options
282 @xref{Optimize Options,,Options that Control Optimization}.
283 @gccoptlist{-falign-functions=@var{n}  -falign-jumps=@var{n} @gol
284 -falign-labels=@var{n}  -falign-loops=@var{n}  @gol
285 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
286 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
287 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
288 -fcaller-saves  -fcprop-registers @gol
289 -fcse-follow-jumps  -fcse-skip-blocks  -fdata-sections @gol
290 -fdelayed-branch  -fdelete-null-pointer-checks @gol
291 -fexpensive-optimizations  -ffast-math  -ffloat-store @gol
292 -fforce-addr  -fforce-mem  -ffunction-sections @gol
293 -fgcse  -fgcse-lm  -fgcse-sm  -fgcse-las  -fgcse-after-reload @gol
294 -floop-optimize -fcrossjumping  -fif-conversion  -fif-conversion2 @gol
295 -finline-functions  -finline-limit=@var{n}  -fkeep-inline-functions @gol
296 -fkeep-static-consts  -fmerge-constants  -fmerge-all-constants @gol
297 -fmodulo-sched -fno-branch-count-reg @gol
298 -fno-default-inline  -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
299 -fno-function-cse  -fno-guess-branch-probability @gol
300 -fno-inline  -fno-math-errno  -fno-peephole  -fno-peephole2 @gol
301 -funsafe-math-optimizations  -ffinite-math-only @gol
302 -fno-trapping-math  -fno-zero-initialized-in-bss @gol
303 -fomit-frame-pointer  -foptimize-register-move @gol
304 -foptimize-sibling-calls  -fprefetch-loop-arrays @gol
305 -fprofile-generate -fprofile-use @gol
306 -fregmove  -frename-registers @gol
307 -freorder-blocks  -freorder-blocks-and-partition -freorder-functions @gol
308 -frerun-cse-after-loop  -frerun-loop-opt @gol
309 -frounding-math -fschedule-insns  -fschedule-insns2 @gol
310 -fno-sched-interblock  -fno-sched-spec  -fsched-spec-load @gol
311 -fsched-spec-load-dangerous  @gol
312 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
313 -fsched2-use-superblocks @gol
314 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
315 -fsignaling-nans -fsingle-precision-constant  -fspeculative-prefetching @gol
316 -fstrength-reduce  -fstrict-aliasing  -ftracer  -fthread-jumps @gol
317 -funroll-all-loops  -funroll-loops  -fpeel-loops @gol
318 -fsplit-ivs-in-unroller -funswitch-loops @gol
319 -fvariable-expansion-in-unroller @gol
320 -ftree-pre  -ftree-ccp  -ftree-dce -ftree-loop-optimize @gol
321 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
322 -ftree-dominator-opts -ftree-dse -ftree-copyrename @gol
323 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
324 --param @var{name}=@var{value}
325 -O  -O0  -O1  -O2  -O3  -Os}
327 @item Preprocessor Options
328 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
329 @gccoptlist{-A@var{question}=@var{answer} @gol
330 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
331 -C  -dD  -dI  -dM  -dN @gol
332 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
333 -idirafter @var{dir} @gol
334 -include @var{file}  -imacros @var{file} @gol
335 -iprefix @var{file}  -iwithprefix @var{dir} @gol
336 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
337 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
338 -P  -fworking-directory  -remap @gol
339 -trigraphs  -undef  -U@var{macro}  -Wp,@var{option} @gol
340 -Xpreprocessor @var{option}}
342 @item Assembler Option
343 @xref{Assembler Options,,Passing Options to the Assembler}.
344 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
346 @item Linker Options
347 @xref{Link Options,,Options for Linking}.
348 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
349 -nostartfiles  -nodefaultlibs  -nostdlib -pie @gol
350 -s  -static  -static-libgcc  -shared  -shared-libgcc  -symbolic @gol
351 -Wl,@var{option}  -Xlinker @var{option} @gol
352 -u @var{symbol}}
354 @item Directory Options
355 @xref{Directory Options,,Options for Directory Search}.
356 @gccoptlist{-B@var{prefix}  -I@var{dir}  -iquote@var{dir}  -L@var{dir}  -specs=@var{file}  -I-}
358 @item Target Options
359 @c I wrote this xref this way to avoid overfull hbox. -- rms
360 @xref{Target Options}.
361 @gccoptlist{-V @var{version}  -b @var{machine}}
363 @item Machine Dependent Options
364 @xref{Submodel Options,,Hardware Models and Configurations}.
365 @c This list is ordered alphanumerically by subsection name.
366 @c Try and put the significant identifier (CPU or system) first,
367 @c so users have a clue at guessing where the ones they want will be.
369 @emph{ARC Options}
370 @gccoptlist{-EB  -EL @gol
371 -mmangle-cpu  -mcpu=@var{cpu}  -mtext=@var{text-section} @gol
372 -mdata=@var{data-section}  -mrodata=@var{readonly-data-section}}
374 @emph{ARM Options}
375 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
376 -mabi=@var{name} @gol
377 -mapcs-stack-check  -mno-apcs-stack-check @gol
378 -mapcs-float  -mno-apcs-float @gol
379 -mapcs-reentrant  -mno-apcs-reentrant @gol
380 -msched-prolog  -mno-sched-prolog @gol
381 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
382 -mfloat-abi=@var{name}  -msoft-float  -mhard-float  -mfpe @gol
383 -mthumb-interwork  -mno-thumb-interwork @gol
384 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
385 -mstructure-size-boundary=@var{n} @gol
386 -mabort-on-noreturn @gol
387 -mlong-calls  -mno-long-calls @gol
388 -msingle-pic-base  -mno-single-pic-base @gol
389 -mpic-register=@var{reg} @gol
390 -mnop-fun-dllimport @gol
391 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
392 -mpoke-function-name @gol
393 -mthumb  -marm @gol
394 -mtpcs-frame  -mtpcs-leaf-frame @gol
395 -mcaller-super-interworking  -mcallee-super-interworking}
397 @emph{AVR Options}
398 @gccoptlist{-mmcu=@var{mcu}  -msize  -minit-stack=@var{n}  -mno-interrupts @gol
399 -mcall-prologues  -mno-tablejump  -mtiny-stack  -mint8}
401 @emph{CRIS Options}
402 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
403 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
404 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
405 -mstack-align  -mdata-align  -mconst-align @gol
406 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
407 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
408 -mmul-bug-workaround  -mno-mul-bug-workaround}
410 @emph{Darwin Options}
411 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
412 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
413 -client_name  -compatibility_version  -current_version @gol
414 -dead_strip @gol
415 -dependency-file  -dylib_file  -dylinker_install_name @gol
416 -dynamic  -dynamiclib  -exported_symbols_list @gol
417 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
418 -force_flat_namespace  -headerpad_max_install_names @gol
419 -image_base  -init  -install_name  -keep_private_externs @gol
420 -multi_module  -multiply_defined  -multiply_defined_unused @gol
421 -noall_load   -no_dead_strip_inits_and_terms @gol
422 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
423 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
424 -private_bundle  -read_only_relocs  -sectalign @gol
425 -sectobjectsymbols  -whyload  -seg1addr @gol
426 -sectcreate  -sectobjectsymbols  -sectorder @gol
427 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
428 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
429 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
430 -single_module  -static  -sub_library  -sub_umbrella @gol
431 -twolevel_namespace  -umbrella  -undefined @gol
432 -unexported_symbols_list  -weak_reference_mismatches @gol
433 -whatsloaded -F -gused -gfull -mone-byte-bool}
435 @emph{DEC Alpha Options}
436 @gccoptlist{-mno-fp-regs  -msoft-float  -malpha-as  -mgas @gol
437 -mieee  -mieee-with-inexact  -mieee-conformant @gol
438 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
439 -mtrap-precision=@var{mode}  -mbuild-constants @gol
440 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
441 -mbwx  -mmax  -mfix  -mcix @gol
442 -mfloat-vax  -mfloat-ieee @gol
443 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
444 -msmall-text  -mlarge-text @gol
445 -mmemory-latency=@var{time}}
447 @emph{DEC Alpha/VMS Options}
448 @gccoptlist{-mvms-return-codes}
450 @emph{FRV Options}
451 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
452 -mhard-float  -msoft-float @gol
453 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
454 -mdouble  -mno-double @gol
455 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
456 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
457 -mlinked-fp  -mlong-calls  -malign-labels @gol
458 -mlibrary-pic  -macc-4  -macc-8 @gol
459 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
460 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
461 -mvliw-branch  -mno-vliw-branch @gol
462 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
463 -mno-nested-cond-exec  -mtomcat-stats @gol
464 -mTLS -mtls @gol
465 -mcpu=@var{cpu}}
467 @emph{H8/300 Options}
468 @gccoptlist{-mrelax  -mh  -ms  -mn  -mint32  -malign-300}
470 @emph{HPPA Options}
471 @gccoptlist{-march=@var{architecture-type} @gol
472 -mbig-switch  -mdisable-fpregs  -mdisable-indexing @gol
473 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
474 -mfixed-range=@var{register-range} @gol
475 -mjump-in-delay -mlinker-opt -mlong-calls @gol
476 -mlong-load-store  -mno-big-switch  -mno-disable-fpregs @gol
477 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
478 -mno-jump-in-delay  -mno-long-load-store @gol
479 -mno-portable-runtime  -mno-soft-float @gol
480 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
481 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
482 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
483 -munix=@var{unix-std}  -nolibdld  -static  -threads}
485 @emph{i386 and x86-64 Options}
486 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
487 -mfpmath=@var{unit} @gol
488 -masm=@var{dialect}  -mno-fancy-math-387 @gol
489 -mno-fp-ret-in-387  -msoft-float  -msvr3-shlib @gol
490 -mno-wide-multiply  -mrtd  -malign-double @gol
491 -mpreferred-stack-boundary=@var{num} @gol
492 -mmmx  -msse  -msse2 -msse3 -m3dnow @gol
493 -mthreads  -mno-align-stringops  -minline-all-stringops @gol
494 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
495 -m96bit-long-double  -mregparm=@var{num}  -momit-leaf-frame-pointer @gol
496 -mno-red-zone -mno-tls-direct-seg-refs @gol
497 -mcmodel=@var{code-model} @gol
498 -m32  -m64}
500 @emph{IA-64 Options}
501 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
502 -mvolatile-asm-stop  -mb-step  -mregister-names  -mno-sdata @gol
503 -mconstant-gp  -mauto-pic  -minline-float-divide-min-latency @gol
504 -minline-float-divide-max-throughput @gol
505 -minline-int-divide-min-latency @gol
506 -minline-int-divide-max-throughput  @gol
507 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
508 -mno-dwarf2-asm -mearly-stop-bits @gol
509 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
510 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
512 @emph{M32R/D Options}
513 @gccoptlist{-m32r2 -m32rx -m32r @gol
514 -mdebug @gol
515 -malign-loops -mno-align-loops @gol
516 -missue-rate=@var{number} @gol
517 -mbranch-cost=@var{number} @gol
518 -mmodel=@var{code-size-model-type} @gol
519 -msdata=@var{sdata-type} @gol
520 -mno-flush-func -mflush-func=@var{name} @gol
521 -mno-flush-trap -mflush-trap=@var{number} @gol
522 -G @var{num}}
524 @emph{M680x0 Options}
525 @gccoptlist{-m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
526 -m68060  -mcpu32  -m5200  -m68881  -mbitfield  -mc68000  -mc68020   @gol
527 -mnobitfield  -mrtd  -mshort  -msoft-float  -mpcrel @gol
528 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
529 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library}
531 @emph{M68hc1x Options}
532 @gccoptlist{-m6811  -m6812  -m68hc11  -m68hc12   -m68hcs12 @gol
533 -mauto-incdec  -minmax  -mlong-calls  -mshort @gol
534 -msoft-reg-count=@var{count}}
536 @emph{MCore Options}
537 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
538 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
539 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
540 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
541 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
543 @emph{MIPS Options}
544 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
545 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips64 @gol
546 -mips16  -mno-mips16  -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
547 -mxgot  -mno-xgot  -mgp32  -mgp64  -mfp32  -mfp64 @gol
548 -mhard-float  -msoft-float  -msingle-float  -mdouble-float @gol
549 -mpaired-single  -mips3d @gol
550 -mint64  -mlong64  -mlong32 @gol
551 -G@var{num}  -membedded-data  -mno-embedded-data @gol
552 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
553 -msplit-addresses  -mno-split-addresses  @gol
554 -mexplicit-relocs  -mno-explicit-relocs  @gol
555 -mcheck-zero-division  -mno-check-zero-division @gol
556 -mdivide-traps  -mdivide-breaks @gol
557 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
558 -mmad  -mno-mad  -mfused-madd  -mno-fused-madd  -nocpp @gol
559 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
560 -mfix-vr4120  -mno-fix-vr4120  -mfix-sb1  -mno-fix-sb1 @gol
561 -mflush-func=@var{func}  -mno-flush-func @gol
562 -mbranch-likely  -mno-branch-likely @gol
563 -mfp-exceptions -mno-fp-exceptions @gol
564 -mvr4130-align -mno-vr4130-align}
566 @emph{MMIX Options}
567 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
568 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
569 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
570 -mno-base-addresses  -msingle-exit  -mno-single-exit}
572 @emph{MN10300 Options}
573 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
574 -mam33  -mno-am33 @gol
575 -mam33-2  -mno-am33-2 @gol
576 -mno-crt0  -mrelax}
578 @emph{NS32K Options}
579 @gccoptlist{-m32032  -m32332  -m32532  -m32081  -m32381 @gol
580 -mmult-add  -mnomult-add  -msoft-float  -mrtd  -mnortd @gol
581 -mregparam  -mnoregparam  -msb  -mnosb @gol
582 -mbitfield  -mnobitfield  -mhimem  -mnohimem}
584 @emph{PDP-11 Options}
585 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
586 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
587 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
588 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
589 -mbranch-expensive  -mbranch-cheap @gol
590 -msplit  -mno-split  -munix-asm  -mdec-asm}
592 @emph{PowerPC Options}
593 See RS/6000 and PowerPC Options.
595 @emph{RS/6000 and PowerPC Options}
596 @gccoptlist{-mcpu=@var{cpu-type} @gol
597 -mtune=@var{cpu-type} @gol
598 -mpower  -mno-power  -mpower2  -mno-power2 @gol
599 -mpowerpc  -mpowerpc64  -mno-powerpc @gol
600 -maltivec  -mno-altivec @gol
601 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
602 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
603 -mnew-mnemonics  -mold-mnemonics @gol
604 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
605 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
606 -malign-power  -malign-natural @gol
607 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
608 -mstring  -mno-string  -mupdate  -mno-update @gol
609 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
610 -mstrict-align  -mno-strict-align  -mrelocatable @gol
611 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
612 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
613 -mdynamic-no-pic @gol
614 -mprioritize-restricted-insns=@var{priority} @gol
615 -msched-costly-dep=@var{dependence_type} @gol
616 -minsert-sched-nops=@var{scheme} @gol
617 -mcall-sysv  -mcall-netbsd @gol
618 -maix-struct-return  -msvr4-struct-return @gol
619 -mabi=altivec  -mabi=no-altivec @gol
620 -mabi=spe  -mabi=no-spe @gol
621 -misel=yes  -misel=no @gol
622 -mspe=yes  -mspe=no @gol
623 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
624 -mprototype  -mno-prototype @gol
625 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
626 -msdata=@var{opt}  -mvxworks  -mwindiss  -G @var{num}  -pthread}
628 @emph{S/390 and zSeries Options}
629 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
630 -mhard-float  -msoft-float  -mbackchain  -mno-backchain @gol
631 -mpacked-stack  -mno-packed-stack @gol
632 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
633 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
634 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
635 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard}
637 @emph{SH Options}
638 @gccoptlist{-m1  -m2  -m2e  -m3  -m3e @gol
639 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
640 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
641 -m5-64media  -m5-64media-nofpu @gol
642 -m5-32media  -m5-32media-nofpu @gol
643 -m5-compact  -m5-compact-nofpu @gol
644 -mb  -ml  -mdalign  -mrelax @gol
645 -mbigtable  -mfmovd  -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
646 -mieee  -misize  -mpadstruct  -mspace @gol
647 -mprefergot  -musermode}
649 @emph{SPARC Options}
650 @gccoptlist{-mcpu=@var{cpu-type} @gol
651 -mtune=@var{cpu-type} @gol
652 -mcmodel=@var{code-model} @gol
653 -m32  -m64  -mapp-regs  -mno-app-regs @gol
654 -mfaster-structs  -mno-faster-structs @gol
655 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
656 -mhard-quad-float  -msoft-quad-float @gol
657 -mimpure-text  -mno-impure-text  -mlittle-endian @gol
658 -mstack-bias  -mno-stack-bias @gol
659 -munaligned-doubles  -mno-unaligned-doubles @gol
660 -mv8plus  -mno-v8plus  -mvis  -mno-vis
661 -threads -pthreads}
663 @emph{System V Options}
664 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
666 @emph{TMS320C3x/C4x Options}
667 @gccoptlist{-mcpu=@var{cpu}  -mbig  -msmall  -mregparm  -mmemparm @gol
668 -mfast-fix  -mmpyi  -mbk  -mti  -mdp-isr-reload @gol
669 -mrpts=@var{count}  -mrptb  -mdb  -mloop-unsigned @gol
670 -mparallel-insns  -mparallel-mpy  -mpreserve-float}
672 @emph{V850 Options}
673 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
674 -mprolog-function  -mno-prolog-function  -mspace @gol
675 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
676 -mapp-regs  -mno-app-regs @gol
677 -mdisable-callt  -mno-disable-callt @gol
678 -mv850e1 @gol
679 -mv850e @gol
680 -mv850  -mbig-switch}
682 @emph{VAX Options}
683 @gccoptlist{-mg  -mgnu  -munix}
685 @emph{x86-64 Options}
686 See i386 and x86-64 Options.
688 @emph{Xstormy16 Options}
689 @gccoptlist{-msim}
691 @emph{Xtensa Options}
692 @gccoptlist{-mconst16 -mno-const16 @gol
693 -mfused-madd  -mno-fused-madd @gol
694 -mtext-section-literals  -mno-text-section-literals @gol
695 -mtarget-align  -mno-target-align @gol
696 -mlongcalls  -mno-longcalls}
698 @emph{zSeries Options}
699 See S/390 and zSeries Options.
701 @item Code Generation Options
702 @xref{Code Gen Options,,Options for Code Generation Conventions}.
703 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
704 -ffixed-@var{reg}  -fexceptions @gol
705 -fnon-call-exceptions  -funwind-tables @gol
706 -fasynchronous-unwind-tables @gol
707 -finhibit-size-directive  -finstrument-functions @gol
708 -fno-common  -fno-ident @gol
709 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
710 -freg-struct-return  -fshared-data  -fshort-enums @gol
711 -fshort-double  -fshort-wchar @gol
712 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
713 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
714 -fargument-alias  -fargument-noalias @gol
715 -fargument-noalias-global  -fleading-underscore @gol
716 -ftls-model=@var{model} @gol
717 -ftrapv  -fwrapv  -fbounds-check @gol
718 -fvisibility}
719 @end table
721 @menu
722 * Overall Options::     Controlling the kind of output:
723                         an executable, object files, assembler files,
724                         or preprocessed source.
725 * C Dialect Options::   Controlling the variant of C language compiled.
726 * C++ Dialect Options:: Variations on C++.
727 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
728                         and Objective-C++.
729 * Language Independent Options:: Controlling how diagnostics should be
730                         formatted.
731 * Warning Options::     How picky should the compiler be?
732 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
733 * Optimize Options::    How much optimization?
734 * Preprocessor Options:: Controlling header files and macro definitions.
735                          Also, getting dependency information for Make.
736 * Assembler Options::   Passing options to the assembler.
737 * Link Options::        Specifying libraries and so on.
738 * Directory Options::   Where to find header files and libraries.
739                         Where to find the compiler executable files.
740 * Spec Files::          How to pass switches to sub-processes.
741 * Target Options::      Running a cross-compiler, or an old version of GCC.
742 @end menu
744 @node Overall Options
745 @section Options Controlling the Kind of Output
747 Compilation can involve up to four stages: preprocessing, compilation
748 proper, assembly and linking, always in that order.  GCC is capable of
749 preprocessing and compiling several files either into several
750 assembler input files, or into one assembler input file; then each
751 assembler input file produces an object file, and linking combines all
752 the object files (those newly compiled, and those specified as input)
753 into an executable file.
755 @cindex file name suffix
756 For any given input file, the file name suffix determines what kind of
757 compilation is done:
759 @table @gcctabopt
760 @item @var{file}.c
761 C source code which must be preprocessed.
763 @item @var{file}.i
764 C source code which should not be preprocessed.
766 @item @var{file}.ii
767 C++ source code which should not be preprocessed.
769 @item @var{file}.m
770 Objective-C source code.  Note that you must link with the @file{libobjc}
771 library to make an Objective-C program work.
773 @item @var{file}.mi
774 Objective-C source code which should not be preprocessed.
776 @item @var{file}.mm
777 @itemx @var{file}.M
778 Objective-C++ source code.  Note that you must link with the @file{libobjc}
779 library to make an Objective-C++ program work.  Note that @samp{.M} refers
780 to a literal capital M@.
782 @item @var{file}.mii
783 Objective-C++ source code which should not be preprocessed.
785 @item @var{file}.h
786 C, C++, Objective-C or Objective-C++ header file to be turned into a
787 precompiled header.
789 @item @var{file}.cc
790 @itemx @var{file}.cp
791 @itemx @var{file}.cxx
792 @itemx @var{file}.cpp
793 @itemx @var{file}.CPP
794 @itemx @var{file}.c++
795 @itemx @var{file}.C
796 C++ source code which must be preprocessed.  Note that in @samp{.cxx},
797 the last two letters must both be literally @samp{x}.  Likewise,
798 @samp{.C} refers to a literal capital C@.
800 @item @var{file}.hh
801 @itemx @var{file}.H
802 C++ header file to be turned into a precompiled header.
804 @item @var{file}.f
805 @itemx @var{file}.for
806 @itemx @var{file}.FOR
807 Fortran source code which should not be preprocessed.
809 @item @var{file}.F
810 @itemx @var{file}.fpp
811 @itemx @var{file}.FPP
812 Fortran source code which must be preprocessed (with the traditional
813 preprocessor).
815 @item @var{file}.r
816 Fortran source code which must be preprocessed with a RATFOR
817 preprocessor (not included with GCC)@.
819 @item @var{file}.f90
820 @itemx @var{file}.f95
821 Fortran 90/95 source code which should not be preprocessed.
823 @c FIXME: Descriptions of Java file types.
824 @c @var{file}.java
825 @c @var{file}.class
826 @c @var{file}.zip
827 @c @var{file}.jar
829 @item @var{file}.ads
830 Ada source code file which contains a library unit declaration (a
831 declaration of a package, subprogram, or generic, or a generic
832 instantiation), or a library unit renaming declaration (a package,
833 generic, or subprogram renaming declaration).  Such files are also
834 called @dfn{specs}.
836 @itemx @var{file}.adb
837 Ada source code file containing a library unit body (a subprogram or
838 package body).  Such files are also called @dfn{bodies}.
840 @c GCC also knows about some suffixes for languages not yet included:
841 @c Pascal:
842 @c @var{file}.p
843 @c @var{file}.pas
845 @item @var{file}.s
846 Assembler code.
848 @item @var{file}.S
849 Assembler code which must be preprocessed.
851 @item @var{other}
852 An object file to be fed straight into linking.
853 Any file name with no recognized suffix is treated this way.
854 @end table
856 @opindex x
857 You can specify the input language explicitly with the @option{-x} option:
859 @table @gcctabopt
860 @item -x @var{language}
861 Specify explicitly the @var{language} for the following input files
862 (rather than letting the compiler choose a default based on the file
863 name suffix).  This option applies to all following input files until
864 the next @option{-x} option.  Possible values for @var{language} are:
865 @smallexample
866 c  c-header  c-cpp-output
867 c++  c++-header  c++-cpp-output
868 objective-c  objective-c-header  objective-c-cpp-output
869 objective-c++ objective-c++-header objective-c++-cpp-output
870 assembler  assembler-with-cpp
872 f77  f77-cpp-input  ratfor
874 java
875 treelang
876 @end smallexample
878 @item -x none
879 Turn off any specification of a language, so that subsequent files are
880 handled according to their file name suffixes (as they are if @option{-x}
881 has not been used at all).
883 @item -pass-exit-codes
884 @opindex pass-exit-codes
885 Normally the @command{gcc} program will exit with the code of 1 if any
886 phase of the compiler returns a non-success return code.  If you specify
887 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
888 numerically highest error produced by any phase that returned an error
889 indication.
890 @end table
892 If you only want some of the stages of compilation, you can use
893 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
894 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
895 @command{gcc} is to stop.  Note that some combinations (for example,
896 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
898 @table @gcctabopt
899 @item -c
900 @opindex c
901 Compile or assemble the source files, but do not link.  The linking
902 stage simply is not done.  The ultimate output is in the form of an
903 object file for each source file.
905 By default, the object file name for a source file is made by replacing
906 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
908 Unrecognized input files, not requiring compilation or assembly, are
909 ignored.
911 @item -S
912 @opindex S
913 Stop after the stage of compilation proper; do not assemble.  The output
914 is in the form of an assembler code file for each non-assembler input
915 file specified.
917 By default, the assembler file name for a source file is made by
918 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
920 Input files that don't require compilation are ignored.
922 @item -E
923 @opindex E
924 Stop after the preprocessing stage; do not run the compiler proper.  The
925 output is in the form of preprocessed source code, which is sent to the
926 standard output.
928 Input files which don't require preprocessing are ignored.
930 @cindex output file option
931 @item -o @var{file}
932 @opindex o
933 Place output in file @var{file}.  This applies regardless to whatever
934 sort of output is being produced, whether it be an executable file,
935 an object file, an assembler file or preprocessed C code.
937 If @option{-o} is not specified, the default is to put an executable
938 file in @file{a.out}, the object file for
939 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
940 assembler file in @file{@var{source}.s}, a precompiled header file in
941 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
942 standard output.
944 @item -v
945 @opindex v
946 Print (on standard error output) the commands executed to run the stages
947 of compilation.  Also print the version number of the compiler driver
948 program and of the preprocessor and the compiler proper.
950 @item -###
951 @opindex ###
952 Like @option{-v} except the commands are not executed and all command
953 arguments are quoted.  This is useful for shell scripts to capture the
954 driver-generated command lines.
956 @item -pipe
957 @opindex pipe
958 Use pipes rather than temporary files for communication between the
959 various stages of compilation.  This fails to work on some systems where
960 the assembler is unable to read from a pipe; but the GNU assembler has
961 no trouble.
963 @item -combine
964 @opindex combine
965 If you are compiling multiple source files, this option tells the driver
966 to pass all the source files to the compiler at once (for those
967 languages for which the compiler can handle this).  This will allow
968 intermodule analysis (IMA) to be performed by the compiler.  Currently the only
969 language for which this is supported is C@.  If you pass source files for
970 multiple languages to the driver, using this option, the driver will invoke
971 the compiler(s) that support IMA once each, passing each compiler all the
972 source files appropriate for it.  For those languages that do not support
973 IMA this option will be ignored, and the compiler will be invoked once for
974 each source file in that language.  If you use this option in conjunction
975 with @option{-save-temps}, the compiler will generate multiple
976 pre-processed files
977 (one for each source file), but only one (combined) @file{.o} or
978 @file{.s} file.
980 @item --help
981 @opindex help
982 Print (on the standard output) a description of the command line options
983 understood by @command{gcc}.  If the @option{-v} option is also specified
984 then @option{--help} will also be passed on to the various processes
985 invoked by @command{gcc}, so that they can display the command line options
986 they accept.  If the @option{-Wextra} option is also specified then command
987 line options which have no documentation associated with them will also
988 be displayed.
990 @item --target-help
991 @opindex target-help
992 Print (on the standard output) a description of target specific command
993 line options for each tool.
995 @item --version
996 @opindex version
997 Display the version number and copyrights of the invoked GCC@.
998 @end table
1000 @node Invoking G++
1001 @section Compiling C++ Programs
1003 @cindex suffixes for C++ source
1004 @cindex C++ source file suffixes
1005 C++ source files conventionally use one of the suffixes @samp{.C},
1006 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1007 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1008 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1009 files with these names and compiles them as C++ programs even if you
1010 call the compiler the same way as for compiling C programs (usually
1011 with the name @command{gcc}).
1013 @findex g++
1014 @findex c++
1015 However, C++ programs often require class libraries as well as a
1016 compiler that understands the C++ language---and under some
1017 circumstances, you might want to compile programs or header files from
1018 standard input, or otherwise without a suffix that flags them as C++
1019 programs.  You might also like to precompile a C header file with a
1020 @samp{.h} extension to be used in C++ compilations.  @command{g++} is a
1021 program that calls GCC with the default language set to C++, and
1022 automatically specifies linking against the C++ library.  On many
1023 systems, @command{g++} is also installed with the name @command{c++}.
1025 @cindex invoking @command{g++}
1026 When you compile C++ programs, you may specify many of the same
1027 command-line options that you use for compiling programs in any
1028 language; or command-line options meaningful for C and related
1029 languages; or options that are meaningful only for C++ programs.
1030 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1031 explanations of options for languages related to C@.
1032 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1033 explanations of options that are meaningful only for C++ programs.
1035 @node C Dialect Options
1036 @section Options Controlling C Dialect
1037 @cindex dialect options
1038 @cindex language dialect options
1039 @cindex options, dialect
1041 The following options control the dialect of C (or languages derived
1042 from C, such as C++, Objective-C and Objective-C++) that the compiler
1043 accepts:
1045 @table @gcctabopt
1046 @cindex ANSI support
1047 @cindex ISO support
1048 @item -ansi
1049 @opindex ansi
1050 In C mode, support all ISO C90 programs.  In C++ mode,
1051 remove GNU extensions that conflict with ISO C++.
1053 This turns off certain features of GCC that are incompatible with ISO
1054 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1055 such as the @code{asm} and @code{typeof} keywords, and
1056 predefined macros such as @code{unix} and @code{vax} that identify the
1057 type of system you are using.  It also enables the undesirable and
1058 rarely used ISO trigraph feature.  For the C compiler,
1059 it disables recognition of C++ style @samp{//} comments as well as
1060 the @code{inline} keyword.
1062 The alternate keywords @code{__asm__}, @code{__extension__},
1063 @code{__inline__} and @code{__typeof__} continue to work despite
1064 @option{-ansi}.  You would not want to use them in an ISO C program, of
1065 course, but it is useful to put them in header files that might be included
1066 in compilations done with @option{-ansi}.  Alternate predefined macros
1067 such as @code{__unix__} and @code{__vax__} are also available, with or
1068 without @option{-ansi}.
1070 The @option{-ansi} option does not cause non-ISO programs to be
1071 rejected gratuitously.  For that, @option{-pedantic} is required in
1072 addition to @option{-ansi}.  @xref{Warning Options}.
1074 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1075 option is used.  Some header files may notice this macro and refrain
1076 from declaring certain functions or defining certain macros that the
1077 ISO standard doesn't call for; this is to avoid interfering with any
1078 programs that might use these names for other things.
1080 Functions which would normally be built in but do not have semantics
1081 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1082 functions with @option{-ansi} is used.  @xref{Other Builtins,,Other
1083 built-in functions provided by GCC}, for details of the functions
1084 affected.
1086 @item -std=
1087 @opindex std
1088 Determine the language standard.  This option is currently only
1089 supported when compiling C or C++.  A value for this option must be
1090 provided; possible values are
1092 @table @samp
1093 @item c89
1094 @itemx iso9899:1990
1095 ISO C90 (same as @option{-ansi}).
1097 @item iso9899:199409
1098 ISO C90 as modified in amendment 1.
1100 @item c99
1101 @itemx c9x
1102 @itemx iso9899:1999
1103 @itemx iso9899:199x
1104 ISO C99.  Note that this standard is not yet fully supported; see
1105 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1106 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1108 @item gnu89
1109 Default, ISO C90 plus GNU extensions (including some C99 features).
1111 @item gnu99
1112 @itemx gnu9x
1113 ISO C99 plus GNU extensions.  When ISO C99 is fully implemented in GCC,
1114 this will become the default.  The name @samp{gnu9x} is deprecated.
1116 @item c++98
1117 The 1998 ISO C++ standard plus amendments.
1119 @item gnu++98
1120 The same as @option{-std=c++98} plus GNU extensions.  This is the
1121 default for C++ code.
1122 @end table
1124 Even when this option is not specified, you can still use some of the
1125 features of newer standards in so far as they do not conflict with
1126 previous C standards.  For example, you may use @code{__restrict__} even
1127 when @option{-std=c99} is not specified.
1129 The @option{-std} options specifying some version of ISO C have the same
1130 effects as @option{-ansi}, except that features that were not in ISO C90
1131 but are in the specified version (for example, @samp{//} comments and
1132 the @code{inline} keyword in ISO C99) are not disabled.
1134 @xref{Standards,,Language Standards Supported by GCC}, for details of
1135 these standard versions.
1137 @item -aux-info @var{filename}
1138 @opindex aux-info
1139 Output to the given filename prototyped declarations for all functions
1140 declared and/or defined in a translation unit, including those in header
1141 files.  This option is silently ignored in any language other than C@.
1143 Besides declarations, the file indicates, in comments, the origin of
1144 each declaration (source file and line), whether the declaration was
1145 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1146 @samp{O} for old, respectively, in the first character after the line
1147 number and the colon), and whether it came from a declaration or a
1148 definition (@samp{C} or @samp{F}, respectively, in the following
1149 character).  In the case of function definitions, a K&R-style list of
1150 arguments followed by their declarations is also provided, inside
1151 comments, after the declaration.
1153 @item -fno-asm
1154 @opindex fno-asm
1155 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1156 keyword, so that code can use these words as identifiers.  You can use
1157 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1158 instead.  @option{-ansi} implies @option{-fno-asm}.
1160 In C++, this switch only affects the @code{typeof} keyword, since
1161 @code{asm} and @code{inline} are standard keywords.  You may want to
1162 use the @option{-fno-gnu-keywords} flag instead, which has the same
1163 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1164 switch only affects the @code{asm} and @code{typeof} keywords, since
1165 @code{inline} is a standard keyword in ISO C99.
1167 @item -fno-builtin
1168 @itemx -fno-builtin-@var{function}
1169 @opindex fno-builtin
1170 @cindex built-in functions
1171 Don't recognize built-in functions that do not begin with
1172 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1173 functions provided by GCC}, for details of the functions affected,
1174 including those which are not built-in functions when @option{-ansi} or
1175 @option{-std} options for strict ISO C conformance are used because they
1176 do not have an ISO standard meaning.
1178 GCC normally generates special code to handle certain built-in functions
1179 more efficiently; for instance, calls to @code{alloca} may become single
1180 instructions that adjust the stack directly, and calls to @code{memcpy}
1181 may become inline copy loops.  The resulting code is often both smaller
1182 and faster, but since the function calls no longer appear as such, you
1183 cannot set a breakpoint on those calls, nor can you change the behavior
1184 of the functions by linking with a different library.  In addition,
1185 when a function is recognized as a built-in function, GCC may use
1186 information about that function to warn about problems with calls to
1187 that function, or to generate more efficient code, even if the
1188 resulting code still contains calls to that function.  For example,
1189 warnings are given with @option{-Wformat} for bad calls to
1190 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1191 known not to modify global memory.
1193 With the @option{-fno-builtin-@var{function}} option
1194 only the built-in function @var{function} is
1195 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1196 function is named this is not built-in in this version of GCC, this
1197 option is ignored.  There is no corresponding
1198 @option{-fbuiltin-@var{function}} option; if you wish to enable
1199 built-in functions selectively when using @option{-fno-builtin} or
1200 @option{-ffreestanding}, you may define macros such as:
1202 @smallexample
1203 #define abs(n)          __builtin_abs ((n))
1204 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1205 @end smallexample
1207 @item -fhosted
1208 @opindex fhosted
1209 @cindex hosted environment
1211 Assert that compilation takes place in a hosted environment.  This implies
1212 @option{-fbuiltin}.  A hosted environment is one in which the
1213 entire standard library is available, and in which @code{main} has a return
1214 type of @code{int}.  Examples are nearly everything except a kernel.
1215 This is equivalent to @option{-fno-freestanding}.
1217 @item -ffreestanding
1218 @opindex ffreestanding
1219 @cindex hosted environment
1221 Assert that compilation takes place in a freestanding environment.  This
1222 implies @option{-fno-builtin}.  A freestanding environment
1223 is one in which the standard library may not exist, and program startup may
1224 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1225 This is equivalent to @option{-fno-hosted}.
1227 @xref{Standards,,Language Standards Supported by GCC}, for details of
1228 freestanding and hosted environments.
1230 @item -fms-extensions
1231 @opindex fms-extensions
1232 Accept some non-standard constructs used in Microsoft header files.
1234 Some cases of unnamed fields in structures and unions are only
1235 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1236 fields within structs/unions}, for details.
1238 @item -trigraphs
1239 @opindex trigraphs
1240 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1241 options for strict ISO C conformance) implies @option{-trigraphs}.
1243 @item -no-integrated-cpp
1244 @opindex no-integrated-cpp
1245 Performs a compilation in two passes: preprocessing and compiling.  This
1246 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1247 @option{-B} option.  The user supplied compilation step can then add in
1248 an additional preprocessing step after normal preprocessing but before
1249 compiling.  The default is to use the integrated cpp (internal cpp)
1251 The semantics of this option will change if "cc1", "cc1plus", and
1252 "cc1obj" are merged.
1254 @cindex traditional C language
1255 @cindex C language, traditional
1256 @item -traditional
1257 @itemx -traditional-cpp
1258 @opindex traditional-cpp
1259 @opindex traditional
1260 Formerly, these options caused GCC to attempt to emulate a pre-standard
1261 C compiler.  They are now only supported with the @option{-E} switch.
1262 The preprocessor continues to support a pre-standard mode.  See the GNU
1263 CPP manual for details.
1265 @item -fcond-mismatch
1266 @opindex fcond-mismatch
1267 Allow conditional expressions with mismatched types in the second and
1268 third arguments.  The value of such an expression is void.  This option
1269 is not supported for C++.
1271 @item -funsigned-char
1272 @opindex funsigned-char
1273 Let the type @code{char} be unsigned, like @code{unsigned char}.
1275 Each kind of machine has a default for what @code{char} should
1276 be.  It is either like @code{unsigned char} by default or like
1277 @code{signed char} by default.
1279 Ideally, a portable program should always use @code{signed char} or
1280 @code{unsigned char} when it depends on the signedness of an object.
1281 But many programs have been written to use plain @code{char} and
1282 expect it to be signed, or expect it to be unsigned, depending on the
1283 machines they were written for.  This option, and its inverse, let you
1284 make such a program work with the opposite default.
1286 The type @code{char} is always a distinct type from each of
1287 @code{signed char} or @code{unsigned char}, even though its behavior
1288 is always just like one of those two.
1290 @item -fsigned-char
1291 @opindex fsigned-char
1292 Let the type @code{char} be signed, like @code{signed char}.
1294 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1295 the negative form of @option{-funsigned-char}.  Likewise, the option
1296 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1298 @item -fsigned-bitfields
1299 @itemx -funsigned-bitfields
1300 @itemx -fno-signed-bitfields
1301 @itemx -fno-unsigned-bitfields
1302 @opindex fsigned-bitfields
1303 @opindex funsigned-bitfields
1304 @opindex fno-signed-bitfields
1305 @opindex fno-unsigned-bitfields
1306 These options control whether a bit-field is signed or unsigned, when the
1307 declaration does not use either @code{signed} or @code{unsigned}.  By
1308 default, such a bit-field is signed, because this is consistent: the
1309 basic integer types such as @code{int} are signed types.
1310 @end table
1312 @node C++ Dialect Options
1313 @section Options Controlling C++ Dialect
1315 @cindex compiler options, C++
1316 @cindex C++ options, command line
1317 @cindex options, C++
1318 This section describes the command-line options that are only meaningful
1319 for C++ programs; but you can also use most of the GNU compiler options
1320 regardless of what language your program is in.  For example, you
1321 might compile a file @code{firstClass.C} like this:
1323 @smallexample
1324 g++ -g -frepo -O -c firstClass.C
1325 @end smallexample
1327 @noindent
1328 In this example, only @option{-frepo} is an option meant
1329 only for C++ programs; you can use the other options with any
1330 language supported by GCC@.
1332 Here is a list of options that are @emph{only} for compiling C++ programs:
1334 @table @gcctabopt
1336 @item -fabi-version=@var{n}
1337 @opindex fabi-version
1338 Use version @var{n} of the C++ ABI@.  Version 2 is the version of the
1339 C++ ABI that first appeared in G++ 3.4.  Version 1 is the version of
1340 the C++ ABI that first appeared in G++ 3.2.  Version 0 will always be
1341 the version that conforms most closely to the C++ ABI specification.
1342 Therefore, the ABI obtained using version 0 will change as ABI bugs
1343 are fixed.
1345 The default is version 2.
1347 @item -fno-access-control
1348 @opindex fno-access-control
1349 Turn off all access checking.  This switch is mainly useful for working
1350 around bugs in the access control code.
1352 @item -fcheck-new
1353 @opindex fcheck-new
1354 Check that the pointer returned by @code{operator new} is non-null
1355 before attempting to modify the storage allocated.  This check is
1356 normally unnecessary because the C++ standard specifies that
1357 @code{operator new} will only return @code{0} if it is declared
1358 @samp{throw()}, in which case the compiler will always check the
1359 return value even without this option.  In all other cases, when
1360 @code{operator new} has a non-empty exception specification, memory
1361 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
1362 @samp{new (nothrow)}.
1364 @item -fconserve-space
1365 @opindex fconserve-space
1366 Put uninitialized or runtime-initialized global variables into the
1367 common segment, as C does.  This saves space in the executable at the
1368 cost of not diagnosing duplicate definitions.  If you compile with this
1369 flag and your program mysteriously crashes after @code{main()} has
1370 completed, you may have an object that is being destroyed twice because
1371 two definitions were merged.
1373 This option is no longer useful on most targets, now that support has
1374 been added for putting variables into BSS without making them common.
1376 @item -fno-const-strings
1377 @opindex fno-const-strings
1378 Give string constants type @code{char *} instead of type @code{const
1379 char *}.  By default, G++ uses type @code{const char *} as required by
1380 the standard.  Even if you use @option{-fno-const-strings}, you cannot
1381 actually modify the value of a string constant.
1383 This option might be removed in a future release of G++.  For maximum
1384 portability, you should structure your code so that it works with
1385 string constants that have type @code{const char *}.
1387 @item -fno-elide-constructors
1388 @opindex fno-elide-constructors
1389 The C++ standard allows an implementation to omit creating a temporary
1390 which is only used to initialize another object of the same type.
1391 Specifying this option disables that optimization, and forces G++ to
1392 call the copy constructor in all cases.
1394 @item -fno-enforce-eh-specs
1395 @opindex fno-enforce-eh-specs
1396 Don't check for violation of exception specifications at runtime.  This
1397 option violates the C++ standard, but may be useful for reducing code
1398 size in production builds, much like defining @samp{NDEBUG}.  The compiler
1399 will still optimize based on the exception specifications.
1401 @item -ffor-scope
1402 @itemx -fno-for-scope
1403 @opindex ffor-scope
1404 @opindex fno-for-scope
1405 If @option{-ffor-scope} is specified, the scope of variables declared in
1406 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1407 as specified by the C++ standard.
1408 If @option{-fno-for-scope} is specified, the scope of variables declared in
1409 a @i{for-init-statement} extends to the end of the enclosing scope,
1410 as was the case in old versions of G++, and other (traditional)
1411 implementations of C++.
1413 The default if neither flag is given to follow the standard,
1414 but to allow and give a warning for old-style code that would
1415 otherwise be invalid, or have different behavior.
1417 @item -fno-gnu-keywords
1418 @opindex fno-gnu-keywords
1419 Do not recognize @code{typeof} as a keyword, so that code can use this
1420 word as an identifier.  You can use the keyword @code{__typeof__} instead.
1421 @option{-ansi} implies @option{-fno-gnu-keywords}.
1423 @item -fno-implicit-templates
1424 @opindex fno-implicit-templates
1425 Never emit code for non-inline templates which are instantiated
1426 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1427 @xref{Template Instantiation}, for more information.
1429 @item -fno-implicit-inline-templates
1430 @opindex fno-implicit-inline-templates
1431 Don't emit code for implicit instantiations of inline templates, either.
1432 The default is to handle inlines differently so that compiles with and
1433 without optimization will need the same set of explicit instantiations.
1435 @item -fno-implement-inlines
1436 @opindex fno-implement-inlines
1437 To save space, do not emit out-of-line copies of inline functions
1438 controlled by @samp{#pragma implementation}.  This will cause linker
1439 errors if these functions are not inlined everywhere they are called.
1441 @item -fms-extensions
1442 @opindex fms-extensions
1443 Disable pedantic warnings about constructs used in MFC, such as implicit
1444 int and getting a pointer to member function via non-standard syntax.
1446 @item -fno-nonansi-builtins
1447 @opindex fno-nonansi-builtins
1448 Disable built-in declarations of functions that are not mandated by
1449 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
1450 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1452 @item -fno-operator-names
1453 @opindex fno-operator-names
1454 Do not treat the operator name keywords @code{and}, @code{bitand},
1455 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1456 synonyms as keywords.
1458 @item -fno-optional-diags
1459 @opindex fno-optional-diags
1460 Disable diagnostics that the standard says a compiler does not need to
1461 issue.  Currently, the only such diagnostic issued by G++ is the one for
1462 a name having multiple meanings within a class.
1464 @item -fpermissive
1465 @opindex fpermissive
1466 Downgrade some diagnostics about nonconformant code from errors to
1467 warnings.  Thus, using @option{-fpermissive} will allow some
1468 nonconforming code to compile.
1470 @item -frepo
1471 @opindex frepo
1472 Enable automatic template instantiation at link time.  This option also
1473 implies @option{-fno-implicit-templates}.  @xref{Template
1474 Instantiation}, for more information.
1476 @item -fno-rtti
1477 @opindex fno-rtti
1478 Disable generation of information about every class with virtual
1479 functions for use by the C++ runtime type identification features
1480 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
1481 of the language, you can save some space by using this flag.  Note that
1482 exception handling uses the same information, but it will generate it as
1483 needed.
1485 @item -fstats
1486 @opindex fstats
1487 Emit statistics about front-end processing at the end of the compilation.
1488 This information is generally only useful to the G++ development team.
1490 @item -ftemplate-depth-@var{n}
1491 @opindex ftemplate-depth
1492 Set the maximum instantiation depth for template classes to @var{n}.
1493 A limit on the template instantiation depth is needed to detect
1494 endless recursions during template class instantiation.  ANSI/ISO C++
1495 conforming programs must not rely on a maximum depth greater than 17.
1497 @item -fno-threadsafe-statics
1498 @opindex fno-threadsafe-statics
1499 Do not emit the extra code to use the routines specified in the C++
1500 ABI for thread-safe initialization of local statics.  You can use this
1501 option to reduce code size slightly in code that doesn't need to be
1502 thread-safe.
1504 @item -fuse-cxa-atexit
1505 @opindex fuse-cxa-atexit
1506 Register destructors for objects with static storage duration with the
1507 @code{__cxa_atexit} function rather than the @code{atexit} function.
1508 This option is required for fully standards-compliant handling of static
1509 destructors, but will only work if your C library supports
1510 @code{__cxa_atexit}.
1512 @item -fvisibility-inlines-hidden
1513 @opindex fvisibility-inlines-hidden
1514 Causes all inlined methods to be marked with
1515 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1516 appear in the export table of a DSO and do not require a PLT indirection
1517 when used within the DSO@.  Enabling this option can have a dramatic effect
1518 on load and link times of a DSO as it massively reduces the size of the
1519 dynamic export table when the library makes heavy use of templates.  While
1520 it can cause bloating through duplication of code within each DSO where
1521 it is used, often the wastage is less than the considerable space occupied
1522 by a long symbol name in the export table which is typical when using
1523 templates and namespaces.  For even more savings, combine with the
1524 @option{-fvisibility=hidden} switch.
1526 @item -fno-weak
1527 @opindex fno-weak
1528 Do not use weak symbol support, even if it is provided by the linker.
1529 By default, G++ will use weak symbols if they are available.  This
1530 option exists only for testing, and should not be used by end-users;
1531 it will result in inferior code and has no benefits.  This option may
1532 be removed in a future release of G++.
1534 @item -nostdinc++
1535 @opindex nostdinc++
1536 Do not search for header files in the standard directories specific to
1537 C++, but do still search the other standard directories.  (This option
1538 is used when building the C++ library.)
1539 @end table
1541 In addition, these optimization, warning, and code generation options
1542 have meanings only for C++ programs:
1544 @table @gcctabopt
1545 @item -fno-default-inline
1546 @opindex fno-default-inline
1547 Do not assume @samp{inline} for functions defined inside a class scope.
1548 @xref{Optimize Options,,Options That Control Optimization}.  Note that these
1549 functions will have linkage like inline functions; they just won't be
1550 inlined by default.
1552 @item -Wabi @r{(C++ only)}
1553 @opindex Wabi
1554 Warn when G++ generates code that is probably not compatible with the
1555 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
1556 all such cases, there are probably some cases that are not warned about,
1557 even though G++ is generating incompatible code.  There may also be
1558 cases where warnings are emitted even though the code that is generated
1559 will be compatible.
1561 You should rewrite your code to avoid these warnings if you are
1562 concerned about the fact that code generated by G++ may not be binary
1563 compatible with code generated by other compilers.
1565 The known incompatibilities at this point include:
1567 @itemize @bullet
1569 @item
1570 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
1571 pack data into the same byte as a base class.  For example:
1573 @smallexample
1574 struct A @{ virtual void f(); int f1 : 1; @};
1575 struct B : public A @{ int f2 : 1; @};
1576 @end smallexample
1578 @noindent
1579 In this case, G++ will place @code{B::f2} into the same byte
1580 as@code{A::f1}; other compilers will not.  You can avoid this problem
1581 by explicitly padding @code{A} so that its size is a multiple of the
1582 byte size on your platform; that will cause G++ and other compilers to
1583 layout @code{B} identically.
1585 @item
1586 Incorrect handling of tail-padding for virtual bases.  G++ does not use
1587 tail padding when laying out virtual bases.  For example:
1589 @smallexample
1590 struct A @{ virtual void f(); char c1; @};
1591 struct B @{ B(); char c2; @};
1592 struct C : public A, public virtual B @{@};
1593 @end smallexample
1595 @noindent
1596 In this case, G++ will not place @code{B} into the tail-padding for
1597 @code{A}; other compilers will.  You can avoid this problem by
1598 explicitly padding @code{A} so that its size is a multiple of its
1599 alignment (ignoring virtual base classes); that will cause G++ and other
1600 compilers to layout @code{C} identically.
1602 @item
1603 Incorrect handling of bit-fields with declared widths greater than that
1604 of their underlying types, when the bit-fields appear in a union.  For
1605 example:
1607 @smallexample
1608 union U @{ int i : 4096; @};
1609 @end smallexample
1611 @noindent
1612 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1613 union too small by the number of bits in an @code{int}.
1615 @item
1616 Empty classes can be placed at incorrect offsets.  For example:
1618 @smallexample
1619 struct A @{@};
1621 struct B @{
1622   A a;
1623   virtual void f ();
1626 struct C : public B, public A @{@};
1627 @end smallexample
1629 @noindent
1630 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1631 it should be placed at offset zero.  G++ mistakenly believes that the
1632 @code{A} data member of @code{B} is already at offset zero.
1634 @item
1635 Names of template functions whose types involve @code{typename} or
1636 template template parameters can be mangled incorrectly.
1638 @smallexample
1639 template <typename Q>
1640 void f(typename Q::X) @{@}
1642 template <template <typename> class Q>
1643 void f(typename Q<int>::X) @{@}
1644 @end smallexample
1646 @noindent
1647 Instantiations of these templates may be mangled incorrectly.
1649 @end itemize
1651 @item -Wctor-dtor-privacy @r{(C++ only)}
1652 @opindex Wctor-dtor-privacy
1653 Warn when a class seems unusable because all the constructors or
1654 destructors in that class are private, and it has neither friends nor
1655 public static member functions.
1657 @item -Wnon-virtual-dtor @r{(C++ only)}
1658 @opindex Wnon-virtual-dtor
1659 Warn when a class appears to be polymorphic, thereby requiring a virtual
1660 destructor, yet it declares a non-virtual one.
1661 This warning is enabled by @option{-Wall}.
1663 @item -Wreorder @r{(C++ only)}
1664 @opindex Wreorder
1665 @cindex reordering, warning
1666 @cindex warning for reordering of member initializers
1667 Warn when the order of member initializers given in the code does not
1668 match the order in which they must be executed.  For instance:
1670 @smallexample
1671 struct A @{
1672   int i;
1673   int j;
1674   A(): j (0), i (1) @{ @}
1676 @end smallexample
1678 The compiler will rearrange the member initializers for @samp{i}
1679 and @samp{j} to match the declaration order of the members, emitting
1680 a warning to that effect.  This warning is enabled by @option{-Wall}.
1681 @end table
1683 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1685 @table @gcctabopt
1686 @item -Weffc++ @r{(C++ only)}
1687 @opindex Weffc++
1688 Warn about violations of the following style guidelines from Scott Meyers'
1689 @cite{Effective C++} book:
1691 @itemize @bullet
1692 @item
1693 Item 11:  Define a copy constructor and an assignment operator for classes
1694 with dynamically allocated memory.
1696 @item
1697 Item 12:  Prefer initialization to assignment in constructors.
1699 @item
1700 Item 14:  Make destructors virtual in base classes.
1702 @item
1703 Item 15:  Have @code{operator=} return a reference to @code{*this}.
1705 @item
1706 Item 23:  Don't try to return a reference when you must return an object.
1708 @end itemize
1710 Also warn about violations of the following style guidelines from
1711 Scott Meyers' @cite{More Effective C++} book:
1713 @itemize @bullet
1714 @item
1715 Item 6:  Distinguish between prefix and postfix forms of increment and
1716 decrement operators.
1718 @item
1719 Item 7:  Never overload @code{&&}, @code{||}, or @code{,}.
1721 @end itemize
1723 When selecting this option, be aware that the standard library
1724 headers do not obey all of these guidelines; use @samp{grep -v}
1725 to filter out those warnings.
1727 @item -Wno-deprecated @r{(C++ only)}
1728 @opindex Wno-deprecated
1729 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
1731 @item -Wno-non-template-friend @r{(C++ only)}
1732 @opindex Wno-non-template-friend
1733 Disable warnings when non-templatized friend functions are declared
1734 within a template.  Since the advent of explicit template specification
1735 support in G++, if the name of the friend is an unqualified-id (i.e.,
1736 @samp{friend foo(int)}), the C++ language specification demands that the
1737 friend declare or define an ordinary, nontemplate function.  (Section
1738 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
1739 could be interpreted as a particular specialization of a templatized
1740 function.  Because this non-conforming behavior is no longer the default
1741 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1742 check existing code for potential trouble spots and is on by default.
1743 This new compiler behavior can be turned off with
1744 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1745 but disables the helpful warning.
1747 @item -Wold-style-cast @r{(C++ only)}
1748 @opindex Wold-style-cast
1749 Warn if an old-style (C-style) cast to a non-void type is used within
1750 a C++ program.  The new-style casts (@samp{static_cast},
1751 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1752 unintended effects and much easier to search for.
1754 @item -Woverloaded-virtual @r{(C++ only)}
1755 @opindex Woverloaded-virtual
1756 @cindex overloaded virtual fn, warning
1757 @cindex warning for overloaded virtual fn
1758 Warn when a function declaration hides virtual functions from a
1759 base class.  For example, in:
1761 @smallexample
1762 struct A @{
1763   virtual void f();
1766 struct B: public A @{
1767   void f(int);
1769 @end smallexample
1771 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1772 like:
1774 @smallexample
1775 B* b;
1776 b->f();
1777 @end smallexample
1779 will fail to compile.
1781 @item -Wno-pmf-conversions @r{(C++ only)}
1782 @opindex Wno-pmf-conversions
1783 Disable the diagnostic for converting a bound pointer to member function
1784 to a plain pointer.
1786 @item -Wsign-promo @r{(C++ only)}
1787 @opindex Wsign-promo
1788 Warn when overload resolution chooses a promotion from unsigned or
1789 enumerated type to a signed type, over a conversion to an unsigned type of
1790 the same size.  Previous versions of G++ would try to preserve
1791 unsignedness, but the standard mandates the current behavior.
1793 @item -Wsynth @r{(C++ only)}
1794 @opindex Wsynth
1795 @cindex warning for synthesized methods
1796 @cindex synthesized methods, warning
1797 Warn when G++'s synthesis behavior does not match that of cfront.  For
1798 instance:
1800 @smallexample
1801 struct A @{
1802   operator int ();
1803   A& operator = (int);
1806 main ()
1808   A a,b;
1809   a = b;
1811 @end smallexample
1813 In this example, G++ will synthesize a default @samp{A& operator =
1814 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1815 @end table
1817 @node Objective-C and Objective-C++ Dialect Options
1818 @section Options Controlling Objective-C and Objective-C++ Dialects
1820 @cindex compiler options, Objective-C and Objective-C++
1821 @cindex Objective-C and Objective-C++ options, command line
1822 @cindex options, Objective-C and Objective-C++
1823 (NOTE: This manual does not describe the Objective-C and Objective-C++
1824 languages themselves.  See @xref{Standards,,Language Standards
1825 Supported by GCC}, for references.)
1827 This section describes the command-line options that are only meaningful
1828 for Objective-C and Objective-C++ programs, but you can also use most of
1829 the language-independent GNU compiler options.
1830 For example, you might compile a file @code{some_class.m} like this:
1832 @smallexample
1833 gcc -g -fgnu-runtime -O -c some_class.m
1834 @end smallexample
1836 @noindent
1837 In this example, @option{-fgnu-runtime} is an option meant only for
1838 Objective-C and Objective-C++ programs; you can use the other options with
1839 any language supported by GCC@.
1841 Note that since Objective-C is an extension of the C language, Objective-C
1842 compilations may also use options specific to the C front-end (e.g.,
1843 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
1844 C++-specific options (e.g., @option{-Wabi}).
1846 Here is a list of options that are @emph{only} for compiling Objective-C
1847 and Objective-C++ programs:
1849 @table @gcctabopt
1850 @item -fconstant-string-class=@var{class-name}
1851 @opindex fconstant-string-class
1852 Use @var{class-name} as the name of the class to instantiate for each
1853 literal string specified with the syntax @code{@@"@dots{}"}.  The default
1854 class name is @code{NXConstantString} if the GNU runtime is being used, and
1855 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
1856 @option{-fconstant-cfstrings} option, if also present, will override the
1857 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1858 to be laid out as constant CoreFoundation strings.
1860 @item -fgnu-runtime
1861 @opindex fgnu-runtime
1862 Generate object code compatible with the standard GNU Objective-C
1863 runtime.  This is the default for most types of systems.
1865 @item -fnext-runtime
1866 @opindex fnext-runtime
1867 Generate output compatible with the NeXT runtime.  This is the default
1868 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
1869 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1870 used.
1872 @item -fno-nil-receivers
1873 @opindex fno-nil-receivers
1874 Assume that all Objective-C message dispatches (e.g.,
1875 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1876 is not @code{nil}.  This allows for more efficient entry points in the runtime
1877 to be used.  Currently, this option is only available in conjunction with
1878 the NeXT runtime on Mac OS X 10.3 and later.
1880 @item -fobjc-exceptions
1881 @opindex fobjc-exceptions
1882 Enable syntactic support for structured exception handling in Objective-C,
1883 similar to what is offered by C++ and Java.  Currently, this option is only
1884 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1886 @smallexample
1887   @@try @{
1888     @dots{}
1889        @@throw expr;
1890     @dots{}
1891   @}
1892   @@catch (AnObjCClass *exc) @{
1893     @dots{}
1894       @@throw expr;
1895     @dots{}
1896       @@throw;
1897     @dots{}
1898   @}
1899   @@catch (AnotherClass *exc) @{
1900     @dots{}
1901   @}
1902   @@catch (id allOthers) @{
1903     @dots{}
1904   @}
1905   @@finally @{
1906     @dots{}
1907       @@throw expr;
1908     @dots{}
1909   @}
1910 @end smallexample
1912 The @code{@@throw} statement may appear anywhere in an Objective-C or
1913 Objective-C++ program; when used inside of a @code{@@catch} block, the
1914 @code{@@throw} may appear without an argument (as shown above), in which case
1915 the object caught by the @code{@@catch} will be rethrown.
1917 Note that only (pointers to) Objective-C objects may be thrown and
1918 caught using this scheme.  When an object is thrown, it will be caught
1919 by the nearest @code{@@catch} clause capable of handling objects of that type,
1920 analogously to how @code{catch} blocks work in C++ and Java.  A
1921 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1922 any and all Objective-C exceptions not caught by previous @code{@@catch}
1923 clauses (if any).
1925 The @code{@@finally} clause, if present, will be executed upon exit from the
1926 immediately preceding @code{@@try @dots{} @@catch} section.  This will happen
1927 regardless of whether any exceptions are thrown, caught or rethrown
1928 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1929 of the @code{finally} clause in Java.
1931 There are several caveats to using the new exception mechanism:
1933 @itemize @bullet
1934 @item
1935 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1936 idioms provided by the @code{NSException} class, the new
1937 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1938 systems, due to additional functionality needed in the (NeXT) Objective-C
1939 runtime.
1941 @item
1942 As mentioned above, the new exceptions do not support handling
1943 types other than Objective-C objects.   Furthermore, when used from
1944 Objective-C++, the Objective-C exception model does not interoperate with C++
1945 exceptions at this time.  This means you cannot @code{@@throw} an exception
1946 from Objective-C and @code{catch} it in C++, or vice versa
1947 (i.e., @code{throw @dots{} @@catch}).
1948 @end itemize
1950 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1951 blocks for thread-safe execution:
1953 @smallexample
1954   @@synchronized (ObjCClass *guard) @{
1955     @dots{}
1956   @}
1957 @end smallexample
1959 Upon entering the @code{@@synchronized} block, a thread of execution shall
1960 first check whether a lock has been placed on the corresponding @code{guard}
1961 object by another thread.  If it has, the current thread shall wait until
1962 the other thread relinquishes its lock.  Once @code{guard} becomes available,
1963 the current thread will place its own lock on it, execute the code contained in
1964 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1965 making @code{guard} available to other threads).
1967 Unlike Java, Objective-C does not allow for entire methods to be marked
1968 @code{@@synchronized}.  Note that throwing exceptions out of
1969 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1970 to be unlocked properly.
1972 @item -freplace-objc-classes
1973 @opindex freplace-objc-classes
1974 Emit a special marker instructing @command{ld(1)} not to statically link in
1975 the resulting object file, and allow @command{dyld(1)} to load it in at
1976 run time instead.  This is used in conjunction with the Fix-and-Continue
1977 debugging mode, where the object file in question may be recompiled and
1978 dynamically reloaded in the course of program execution, without the need
1979 to restart the program itself.  Currently, Fix-and-Continue functionality
1980 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1981 and later.
1983 @item -fzero-link
1984 @opindex fzero-link
1985 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1986 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1987 compile time) with static class references that get initialized at load time,
1988 which improves run-time performance.  Specifying the @option{-fzero-link} flag
1989 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1990 to be retained.  This is useful in Zero-Link debugging mode, since it allows
1991 for individual class implementations to be modified during program execution.
1993 @item -gen-decls
1994 @opindex gen-decls
1995 Dump interface declarations for all classes seen in the source file to a
1996 file named @file{@var{sourcename}.decl}.
1998 @item -Wno-protocol
1999 @opindex Wno-protocol
2000 If a class is declared to implement a protocol, a warning is issued for
2001 every method in the protocol that is not implemented by the class.  The
2002 default behavior is to issue a warning for every method not explicitly
2003 implemented in the class, even if a method implementation is inherited
2004 from the superclass.  If you use the @option{-Wno-protocol} option, then
2005 methods inherited from the superclass are considered to be implemented,
2006 and no warning is issued for them.
2008 @item -Wselector
2009 @opindex Wselector
2010 Warn if multiple methods of different types for the same selector are
2011 found during compilation.  The check is performed on the list of methods
2012 in the final stage of compilation.  Additionally, a check is performed
2013 for each selector appearing in a @code{@@selector(@dots{})}
2014 expression, and a corresponding method for that selector has been found
2015 during compilation.  Because these checks scan the method table only at
2016 the end of compilation, these warnings are not produced if the final
2017 stage of compilation is not reached, for example because an error is
2018 found during compilation, or because the @option{-fsyntax-only} option is
2019 being used.
2021 @item -Wundeclared-selector
2022 @opindex Wundeclared-selector
2023 Warn if a @code{@@selector(@dots{})} expression referring to an
2024 undeclared selector is found.  A selector is considered undeclared if no
2025 method with that name has been declared before the
2026 @code{@@selector(@dots{})} expression, either explicitly in an
2027 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2028 an @code{@@implementation} section.  This option always performs its
2029 checks as soon as a @code{@@selector(@dots{})} expression is found,
2030 while @option{-Wselector} only performs its checks in the final stage of
2031 compilation.  This also enforces the coding style convention
2032 that methods and selectors must be declared before being used.
2034 @item -print-objc-runtime-info
2035 @opindex print-objc-runtime-info
2036 Generate C header describing the largest structure that is passed by
2037 value, if any.
2039 @end table
2041 @node Language Independent Options
2042 @section Options to Control Diagnostic Messages Formatting
2043 @cindex options to control diagnostics formatting
2044 @cindex diagnostic messages
2045 @cindex message formatting
2047 Traditionally, diagnostic messages have been formatted irrespective of
2048 the output device's aspect (e.g.@: its width, @dots{}).  The options described
2049 below can be used to control the diagnostic messages formatting
2050 algorithm, e.g.@: how many characters per line, how often source location
2051 information should be reported.  Right now, only the C++ front end can
2052 honor these options.  However it is expected, in the near future, that
2053 the remaining front ends would be able to digest them correctly.
2055 @table @gcctabopt
2056 @item -fmessage-length=@var{n}
2057 @opindex fmessage-length
2058 Try to format error messages so that they fit on lines of about @var{n}
2059 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
2060 the front ends supported by GCC@.  If @var{n} is zero, then no
2061 line-wrapping will be done; each error message will appear on a single
2062 line.
2064 @opindex fdiagnostics-show-location
2065 @item -fdiagnostics-show-location=once
2066 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
2067 reporter to emit @emph{once} source location information; that is, in
2068 case the message is too long to fit on a single physical line and has to
2069 be wrapped, the source location won't be emitted (as prefix) again,
2070 over and over, in subsequent continuation lines.  This is the default
2071 behavior.
2073 @item -fdiagnostics-show-location=every-line
2074 Only meaningful in line-wrapping mode.  Instructs the diagnostic
2075 messages reporter to emit the same source location information (as
2076 prefix) for physical lines that result from the process of breaking
2077 a message which is too long to fit on a single line.
2079 @end table
2081 @node Warning Options
2082 @section Options to Request or Suppress Warnings
2083 @cindex options to control warnings
2084 @cindex warning messages
2085 @cindex messages, warning
2086 @cindex suppressing warnings
2088 Warnings are diagnostic messages that report constructions which
2089 are not inherently erroneous but which are risky or suggest there
2090 may have been an error.
2092 You can request many specific warnings with options beginning @samp{-W},
2093 for example @option{-Wimplicit} to request warnings on implicit
2094 declarations.  Each of these specific warning options also has a
2095 negative form beginning @samp{-Wno-} to turn off warnings;
2096 for example, @option{-Wno-implicit}.  This manual lists only one of the
2097 two forms, whichever is not the default.
2099 The following options control the amount and kinds of warnings produced
2100 by GCC; for further, language-specific options also refer to
2101 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2102 Options}.
2104 @table @gcctabopt
2105 @cindex syntax checking
2106 @item -fsyntax-only
2107 @opindex fsyntax-only
2108 Check the code for syntax errors, but don't do anything beyond that.
2110 @item -pedantic
2111 @opindex pedantic
2112 Issue all the warnings demanded by strict ISO C and ISO C++;
2113 reject all programs that use forbidden extensions, and some other
2114 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
2115 version of the ISO C standard specified by any @option{-std} option used.
2117 Valid ISO C and ISO C++ programs should compile properly with or without
2118 this option (though a rare few will require @option{-ansi} or a
2119 @option{-std} option specifying the required version of ISO C)@.  However,
2120 without this option, certain GNU extensions and traditional C and C++
2121 features are supported as well.  With this option, they are rejected.
2123 @option{-pedantic} does not cause warning messages for use of the
2124 alternate keywords whose names begin and end with @samp{__}.  Pedantic
2125 warnings are also disabled in the expression that follows
2126 @code{__extension__}.  However, only system header files should use
2127 these escape routes; application programs should avoid them.
2128 @xref{Alternate Keywords}.
2130 Some users try to use @option{-pedantic} to check programs for strict ISO
2131 C conformance.  They soon find that it does not do quite what they want:
2132 it finds some non-ISO practices, but not all---only those for which
2133 ISO C @emph{requires} a diagnostic, and some others for which
2134 diagnostics have been added.
2136 A feature to report any failure to conform to ISO C might be useful in
2137 some instances, but would require considerable additional work and would
2138 be quite different from @option{-pedantic}.  We don't have plans to
2139 support such a feature in the near future.
2141 Where the standard specified with @option{-std} represents a GNU
2142 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2143 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2144 extended dialect is based.  Warnings from @option{-pedantic} are given
2145 where they are required by the base standard.  (It would not make sense
2146 for such warnings to be given only for features not in the specified GNU
2147 C dialect, since by definition the GNU dialects of C include all
2148 features the compiler supports with the given option, and there would be
2149 nothing to warn about.)
2151 @item -pedantic-errors
2152 @opindex pedantic-errors
2153 Like @option{-pedantic}, except that errors are produced rather than
2154 warnings.
2156 @item -w
2157 @opindex w
2158 Inhibit all warning messages.
2160 @item -Wno-import
2161 @opindex Wno-import
2162 Inhibit warning messages about the use of @samp{#import}.
2164 @item -Wchar-subscripts
2165 @opindex Wchar-subscripts
2166 Warn if an array subscript has type @code{char}.  This is a common cause
2167 of error, as programmers often forget that this type is signed on some
2168 machines.
2169 This warning is enabled by @option{-Wall}.
2171 @item -Wcomment
2172 @opindex Wcomment
2173 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2174 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2175 This warning is enabled by @option{-Wall}.
2177 @item -Wfatal-errors
2178 @opindex Wfatal-errors
2179 This option causes the compiler to abort compilation on the first error
2180 occurred rather than trying to keep going and printing further error
2181 messages.
2183 @item -Wformat
2184 @opindex Wformat
2185 @opindex ffreestanding
2186 @opindex fno-builtin
2187 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2188 the arguments supplied have types appropriate to the format string
2189 specified, and that the conversions specified in the format string make
2190 sense.  This includes standard functions, and others specified by format
2191 attributes (@pxref{Function Attributes}), in the @code{printf},
2192 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2193 not in the C standard) families (or other target-specific families).
2194 Which functions are checked without format attributes having been
2195 specified depends on the standard version selected, and such checks of
2196 functions without the attribute specified are disabled by
2197 @option{-ffreestanding} or @option{-fno-builtin}.
2199 The formats are checked against the format features supported by GNU
2200 libc version 2.2.  These include all ISO C90 and C99 features, as well
2201 as features from the Single Unix Specification and some BSD and GNU
2202 extensions.  Other library implementations may not support all these
2203 features; GCC does not support warning about features that go beyond a
2204 particular library's limitations.  However, if @option{-pedantic} is used
2205 with @option{-Wformat}, warnings will be given about format features not
2206 in the selected standard version (but not for @code{strfmon} formats,
2207 since those are not in any version of the C standard).  @xref{C Dialect
2208 Options,,Options Controlling C Dialect}.
2210 Since @option{-Wformat} also checks for null format arguments for
2211 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2213 @option{-Wformat} is included in @option{-Wall}.  For more control over some
2214 aspects of format checking, the options @option{-Wformat-y2k},
2215 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2216 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2217 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2219 @item -Wformat-y2k
2220 @opindex Wformat-y2k
2221 If @option{-Wformat} is specified, also warn about @code{strftime}
2222 formats which may yield only a two-digit year.
2224 @item -Wno-format-extra-args
2225 @opindex Wno-format-extra-args
2226 If @option{-Wformat} is specified, do not warn about excess arguments to a
2227 @code{printf} or @code{scanf} format function.  The C standard specifies
2228 that such arguments are ignored.
2230 Where the unused arguments lie between used arguments that are
2231 specified with @samp{$} operand number specifications, normally
2232 warnings are still given, since the implementation could not know what
2233 type to pass to @code{va_arg} to skip the unused arguments.  However,
2234 in the case of @code{scanf} formats, this option will suppress the
2235 warning if the unused arguments are all pointers, since the Single
2236 Unix Specification says that such unused arguments are allowed.
2238 @item -Wno-format-zero-length
2239 @opindex Wno-format-zero-length
2240 If @option{-Wformat} is specified, do not warn about zero-length formats.
2241 The C standard specifies that zero-length formats are allowed.
2243 @item -Wformat-nonliteral
2244 @opindex Wformat-nonliteral
2245 If @option{-Wformat} is specified, also warn if the format string is not a
2246 string literal and so cannot be checked, unless the format function
2247 takes its format arguments as a @code{va_list}.
2249 @item -Wformat-security
2250 @opindex Wformat-security
2251 If @option{-Wformat} is specified, also warn about uses of format
2252 functions that represent possible security problems.  At present, this
2253 warns about calls to @code{printf} and @code{scanf} functions where the
2254 format string is not a string literal and there are no format arguments,
2255 as in @code{printf (foo);}.  This may be a security hole if the format
2256 string came from untrusted input and contains @samp{%n}.  (This is
2257 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2258 in future warnings may be added to @option{-Wformat-security} that are not
2259 included in @option{-Wformat-nonliteral}.)
2261 @item -Wformat=2
2262 @opindex Wformat=2
2263 Enable @option{-Wformat} plus format checks not included in
2264 @option{-Wformat}.  Currently equivalent to @samp{-Wformat
2265 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2267 @item -Wnonnull
2268 @opindex Wnonnull
2269 Warn about passing a null pointer for arguments marked as
2270 requiring a non-null value by the @code{nonnull} function attribute.
2272 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
2273 can be disabled with the @option{-Wno-nonnull} option.
2275 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2276 @opindex Winit-self
2277 Warn about uninitialized variables which are initialized with themselves.
2278 Note this option can only be used with the @option{-Wuninitialized} option,
2279 which in turn only works with @option{-O1} and above.
2281 For example, GCC will warn about @code{i} being uninitialized in the
2282 following snippet only when @option{-Winit-self} has been specified:
2283 @smallexample
2284 @group
2285 int f()
2287   int i = i;
2288   return i;
2290 @end group
2291 @end smallexample
2293 @item -Wimplicit-int
2294 @opindex Wimplicit-int
2295 Warn when a declaration does not specify a type.
2296 This warning is enabled by @option{-Wall}.
2298 @item -Wimplicit-function-declaration
2299 @itemx -Werror-implicit-function-declaration
2300 @opindex Wimplicit-function-declaration
2301 @opindex Werror-implicit-function-declaration
2302 Give a warning (or error) whenever a function is used before being
2303 declared.  The form @option{-Wno-error-implicit-function-declaration}
2304 is not supported.
2305 This warning is enabled by @option{-Wall} (as a warning, not an error).
2307 @item -Wimplicit
2308 @opindex Wimplicit
2309 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2310 This warning is enabled by @option{-Wall}.
2312 @item -Wmain
2313 @opindex Wmain
2314 Warn if the type of @samp{main} is suspicious.  @samp{main} should be a
2315 function with external linkage, returning int, taking either zero
2316 arguments, two, or three arguments of appropriate types.
2317 This warning is enabled by @option{-Wall}.
2319 @item -Wmissing-braces
2320 @opindex Wmissing-braces
2321 Warn if an aggregate or union initializer is not fully bracketed.  In
2322 the following example, the initializer for @samp{a} is not fully
2323 bracketed, but that for @samp{b} is fully bracketed.
2325 @smallexample
2326 int a[2][2] = @{ 0, 1, 2, 3 @};
2327 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2328 @end smallexample
2330 This warning is enabled by @option{-Wall}.
2332 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2333 @opindex Wmissing-include-dirs
2334 Warn if a user-supplied include directory does not exist.
2336 @item -Wparentheses
2337 @opindex Wparentheses
2338 Warn if parentheses are omitted in certain contexts, such
2339 as when there is an assignment in a context where a truth value
2340 is expected, or when operators are nested whose precedence people
2341 often get confused about.  Only the warning for an assignment used as
2342 a truth value is supported when compiling C++; the other warnings are
2343 only supported when compiling C@.
2345 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2346 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2347 interpretation from that of ordinary mathematical notation.
2349 Also warn about constructions where there may be confusion to which
2350 @code{if} statement an @code{else} branch belongs.  Here is an example of
2351 such a case:
2353 @smallexample
2354 @group
2356   if (a)
2357     if (b)
2358       foo ();
2359   else
2360     bar ();
2362 @end group
2363 @end smallexample
2365 In C, every @code{else} branch belongs to the innermost possible @code{if}
2366 statement, which in this example is @code{if (b)}.  This is often not
2367 what the programmer expected, as illustrated in the above example by
2368 indentation the programmer chose.  When there is the potential for this
2369 confusion, GCC will issue a warning when this flag is specified.
2370 To eliminate the warning, add explicit braces around the innermost
2371 @code{if} statement so there is no way the @code{else} could belong to
2372 the enclosing @code{if}.  The resulting code would look like this:
2374 @smallexample
2375 @group
2377   if (a)
2378     @{
2379       if (b)
2380         foo ();
2381       else
2382         bar ();
2383     @}
2385 @end group
2386 @end smallexample
2388 This warning is enabled by @option{-Wall}.
2390 @item -Wsequence-point
2391 @opindex Wsequence-point
2392 Warn about code that may have undefined semantics because of violations
2393 of sequence point rules in the C standard.
2395 The C standard defines the order in which expressions in a C program are
2396 evaluated in terms of @dfn{sequence points}, which represent a partial
2397 ordering between the execution of parts of the program: those executed
2398 before the sequence point, and those executed after it.  These occur
2399 after the evaluation of a full expression (one which is not part of a
2400 larger expression), after the evaluation of the first operand of a
2401 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2402 function is called (but after the evaluation of its arguments and the
2403 expression denoting the called function), and in certain other places.
2404 Other than as expressed by the sequence point rules, the order of
2405 evaluation of subexpressions of an expression is not specified.  All
2406 these rules describe only a partial order rather than a total order,
2407 since, for example, if two functions are called within one expression
2408 with no sequence point between them, the order in which the functions
2409 are called is not specified.  However, the standards committee have
2410 ruled that function calls do not overlap.
2412 It is not specified when between sequence points modifications to the
2413 values of objects take effect.  Programs whose behavior depends on this
2414 have undefined behavior; the C standard specifies that ``Between the
2415 previous and next sequence point an object shall have its stored value
2416 modified at most once by the evaluation of an expression.  Furthermore,
2417 the prior value shall be read only to determine the value to be
2418 stored.''.  If a program breaks these rules, the results on any
2419 particular implementation are entirely unpredictable.
2421 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2422 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
2423 diagnosed by this option, and it may give an occasional false positive
2424 result, but in general it has been found fairly effective at detecting
2425 this sort of problem in programs.
2427 The present implementation of this option only works for C programs.  A
2428 future implementation may also work for C++ programs.
2430 The C standard is worded confusingly, therefore there is some debate
2431 over the precise meaning of the sequence point rules in subtle cases.
2432 Links to discussions of the problem, including proposed formal
2433 definitions, may be found on the GCC readings page, at
2434 @w{@uref{http://gcc.gnu.org/readings.html}}.
2436 This warning is enabled by @option{-Wall}.
2438 @item -Wreturn-type
2439 @opindex Wreturn-type
2440 Warn whenever a function is defined with a return-type that defaults to
2441 @code{int}.  Also warn about any @code{return} statement with no
2442 return-value in a function whose return-type is not @code{void}.
2444 For C, also warn if the return type of a function has a type qualifier
2445 such as @code{const}.  Such a type qualifier has no effect, since the
2446 value returned by a function is not an lvalue.  ISO C prohibits
2447 qualified @code{void} return types on function definitions, so such
2448 return types always receive a warning even without this option.
2450 For C++, a function without return type always produces a diagnostic
2451 message, even when @option{-Wno-return-type} is specified.  The only
2452 exceptions are @samp{main} and functions defined in system headers.
2454 This warning is enabled by @option{-Wall}.
2456 @item -Wswitch
2457 @opindex Wswitch
2458 Warn whenever a @code{switch} statement has an index of enumerated type
2459 and lacks a @code{case} for one or more of the named codes of that
2460 enumeration.  (The presence of a @code{default} label prevents this
2461 warning.)  @code{case} labels outside the enumeration range also
2462 provoke warnings when this option is used.
2463 This warning is enabled by @option{-Wall}.
2465 @item -Wswitch-default
2466 @opindex Wswitch-switch
2467 Warn whenever a @code{switch} statement does not have a @code{default}
2468 case.
2470 @item -Wswitch-enum
2471 @opindex Wswitch-enum
2472 Warn whenever a @code{switch} statement has an index of enumerated type
2473 and lacks a @code{case} for one or more of the named codes of that
2474 enumeration.  @code{case} labels outside the enumeration range also
2475 provoke warnings when this option is used.
2477 @item -Wtrigraphs
2478 @opindex Wtrigraphs
2479 Warn if any trigraphs are encountered that might change the meaning of
2480 the program (trigraphs within comments are not warned about).
2481 This warning is enabled by @option{-Wall}.
2483 @item -Wunused-function
2484 @opindex Wunused-function
2485 Warn whenever a static function is declared but not defined or a
2486 non\-inline static function is unused.
2487 This warning is enabled by @option{-Wall}.
2489 @item -Wunused-label
2490 @opindex Wunused-label
2491 Warn whenever a label is declared but not used.
2492 This warning is enabled by @option{-Wall}.
2494 To suppress this warning use the @samp{unused} attribute
2495 (@pxref{Variable Attributes}).
2497 @item -Wunused-parameter
2498 @opindex Wunused-parameter
2499 Warn whenever a function parameter is unused aside from its declaration.
2501 To suppress this warning use the @samp{unused} attribute
2502 (@pxref{Variable Attributes}).
2504 @item -Wunused-variable
2505 @opindex Wunused-variable
2506 Warn whenever a local variable or non-constant static variable is unused
2507 aside from its declaration
2508 This warning is enabled by @option{-Wall}.
2510 To suppress this warning use the @samp{unused} attribute
2511 (@pxref{Variable Attributes}).
2513 @item -Wunused-value
2514 @opindex Wunused-value
2515 Warn whenever a statement computes a result that is explicitly not used.
2516 This warning is enabled by @option{-Wall}.
2518 To suppress this warning cast the expression to @samp{void}.
2520 @item -Wunused
2521 @opindex Wunused
2522 All the above @option{-Wunused} options combined.
2524 In order to get a warning about an unused function parameter, you must
2525 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2526 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2528 @item -Wuninitialized
2529 @opindex Wuninitialized
2530 Warn if an automatic variable is used without first being initialized or
2531 if a variable may be clobbered by a @code{setjmp} call.
2533 These warnings are possible only in optimizing compilation,
2534 because they require data flow information that is computed only
2535 when optimizing.  If you don't specify @option{-O}, you simply won't
2536 get these warnings.
2538 If you want to warn about code which uses the uninitialized value of the
2539 variable in its own initializer, use the @option{-Winit-self} option.
2541 These warnings occur only for variables that are candidates for
2542 register allocation.  Therefore, they do not occur for a variable that
2543 is declared @code{volatile}, or whose address is taken, or whose size
2544 is other than 1, 2, 4 or 8 bytes.  Also, they do not occur for
2545 structures, unions or arrays, even when they are in registers.
2547 Note that there may be no warning about a variable that is used only
2548 to compute a value that itself is never used, because such
2549 computations may be deleted by data flow analysis before the warnings
2550 are printed.
2552 These warnings are made optional because GCC is not smart
2553 enough to see all the reasons why the code might be correct
2554 despite appearing to have an error.  Here is one example of how
2555 this can happen:
2557 @smallexample
2558 @group
2560   int x;
2561   switch (y)
2562     @{
2563     case 1: x = 1;
2564       break;
2565     case 2: x = 4;
2566       break;
2567     case 3: x = 5;
2568     @}
2569   foo (x);
2571 @end group
2572 @end smallexample
2574 @noindent
2575 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2576 always initialized, but GCC doesn't know this.  Here is
2577 another common case:
2579 @smallexample
2581   int save_y;
2582   if (change_y) save_y = y, y = new_y;
2583   @dots{}
2584   if (change_y) y = save_y;
2586 @end smallexample
2588 @noindent
2589 This has no bug because @code{save_y} is used only if it is set.
2591 @cindex @code{longjmp} warnings
2592 This option also warns when a non-volatile automatic variable might be
2593 changed by a call to @code{longjmp}.  These warnings as well are possible
2594 only in optimizing compilation.
2596 The compiler sees only the calls to @code{setjmp}.  It cannot know
2597 where @code{longjmp} will be called; in fact, a signal handler could
2598 call it at any point in the code.  As a result, you may get a warning
2599 even when there is in fact no problem because @code{longjmp} cannot
2600 in fact be called at the place which would cause a problem.
2602 Some spurious warnings can be avoided if you declare all the functions
2603 you use that never return as @code{noreturn}.  @xref{Function
2604 Attributes}.
2606 This warning is enabled by @option{-Wall}.
2608 @item -Wunknown-pragmas
2609 @opindex Wunknown-pragmas
2610 @cindex warning for unknown pragmas
2611 @cindex unknown pragmas, warning
2612 @cindex pragmas, warning of unknown
2613 Warn when a #pragma directive is encountered which is not understood by
2614 GCC@.  If this command line option is used, warnings will even be issued
2615 for unknown pragmas in system header files.  This is not the case if
2616 the warnings were only enabled by the @option{-Wall} command line option.
2618 @item -Wstrict-aliasing
2619 @opindex Wstrict-aliasing
2620 This option is only active when @option{-fstrict-aliasing} is active.
2621 It warns about code which might break the strict aliasing rules that the
2622 compiler is using for optimization.  The warning does not catch all
2623 cases, but does attempt to catch the more common pitfalls.  It is
2624 included in @option{-Wall}.
2626 @item -Wstrict-aliasing=2
2627 @opindex Wstrict-aliasing=2
2628 This option is only active when @option{-fstrict-aliasing} is active.
2629 It warns about all code which might break the strict aliasing rules that the
2630 compiler is using for optimization.  This warning catches all cases, but
2631 it will also give a warning for some ambiguous cases that are safe.
2633 @item -Wall
2634 @opindex Wall
2635 All of the above @samp{-W} options combined.  This enables all the
2636 warnings about constructions that some users consider questionable, and
2637 that are easy to avoid (or modify to prevent the warning), even in
2638 conjunction with macros.  This also enables some language-specific
2639 warnings described in @ref{C++ Dialect Options} and
2640 @ref{Objective-C and Objective-C++ Dialect Options}.
2641 @end table
2643 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2644 Some of them warn about constructions that users generally do not
2645 consider questionable, but which occasionally you might wish to check
2646 for; others warn about constructions that are necessary or hard to avoid
2647 in some cases, and there is no simple way to modify the code to suppress
2648 the warning.
2650 @table @gcctabopt
2651 @item -Wextra
2652 @opindex W
2653 @opindex Wextra
2654 (This option used to be called @option{-W}.  The older name is still
2655 supported, but the newer name is more descriptive.)  Print extra warning
2656 messages for these events:
2658 @itemize @bullet
2659 @item
2660 A function can return either with or without a value.  (Falling
2661 off the end of the function body is considered returning without
2662 a value.)  For example, this function would evoke such a
2663 warning:
2665 @smallexample
2666 @group
2667 foo (a)
2669   if (a > 0)
2670     return a;
2672 @end group
2673 @end smallexample
2675 @item
2676 An expression-statement or the left-hand side of a comma expression
2677 contains no side effects.
2678 To suppress the warning, cast the unused expression to void.
2679 For example, an expression such as @samp{x[i,j]} will cause a warning,
2680 but @samp{x[(void)i,j]} will not.
2682 @item
2683 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2685 @item
2686 Storage-class specifiers like @code{static} are not the first things in
2687 a declaration.  According to the C Standard, this usage is obsolescent.
2689 @item
2690 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2691 arguments.
2693 @item
2694 A comparison between signed and unsigned values could produce an
2695 incorrect result when the signed value is converted to unsigned.
2696 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2698 @item
2699 An aggregate has an initializer which does not initialize all members.
2700 This warning can be independently controlled by
2701 @option{-Wmissing-field-initializers}.
2703 @item
2704 A function parameter is declared without a type specifier in K&R-style
2705 functions:
2707 @smallexample
2708 void foo(bar) @{ @}
2709 @end smallexample
2711 @item
2712 An empty body occurs in an @samp{if} or @samp{else} statement.
2714 @item
2715 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2716 @samp{>}, or @samp{>=}.
2718 @item
2719 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2721 @item
2722 Any of several floating-point events that often indicate errors, such as
2723 overflow, underflow, loss of precision, etc.
2725 @item @r{(C++ only)}
2726 An enumerator and a non-enumerator both appear in a conditional expression.
2728 @item @r{(C++ only)}
2729 A non-static reference or non-static @samp{const} member appears in a
2730 class without constructors.
2732 @item @r{(C++ only)}
2733 Ambiguous virtual bases.
2735 @item @r{(C++ only)}
2736 Subscripting an array which has been declared @samp{register}.
2738 @item @r{(C++ only)}
2739 Taking the address of a variable which has been declared @samp{register}.
2741 @item @r{(C++ only)}
2742 A base class is not initialized in a derived class' copy constructor.
2743 @end itemize
2745 @item -Wno-div-by-zero
2746 @opindex Wno-div-by-zero
2747 @opindex Wdiv-by-zero
2748 Do not warn about compile-time integer division by zero.  Floating point
2749 division by zero is not warned about, as it can be a legitimate way of
2750 obtaining infinities and NaNs.
2752 @item -Wsystem-headers
2753 @opindex Wsystem-headers
2754 @cindex warnings from system headers
2755 @cindex system headers, warnings from
2756 Print warning messages for constructs found in system header files.
2757 Warnings from system headers are normally suppressed, on the assumption
2758 that they usually do not indicate real problems and would only make the
2759 compiler output harder to read.  Using this command line option tells
2760 GCC to emit warnings from system headers as if they occurred in user
2761 code.  However, note that using @option{-Wall} in conjunction with this
2762 option will @emph{not} warn about unknown pragmas in system
2763 headers---for that, @option{-Wunknown-pragmas} must also be used.
2765 @item -Wfloat-equal
2766 @opindex Wfloat-equal
2767 Warn if floating point values are used in equality comparisons.
2769 The idea behind this is that sometimes it is convenient (for the
2770 programmer) to consider floating-point values as approximations to
2771 infinitely precise real numbers.  If you are doing this, then you need
2772 to compute (by analyzing the code, or in some other way) the maximum or
2773 likely maximum error that the computation introduces, and allow for it
2774 when performing comparisons (and when producing output, but that's a
2775 different problem).  In particular, instead of testing for equality, you
2776 would check to see whether the two values have ranges that overlap; and
2777 this is done with the relational operators, so equality comparisons are
2778 probably mistaken.
2780 @item -Wtraditional @r{(C only)}
2781 @opindex Wtraditional
2782 Warn about certain constructs that behave differently in traditional and
2783 ISO C@.  Also warn about ISO C constructs that have no traditional C
2784 equivalent, and/or problematic constructs which should be avoided.
2786 @itemize @bullet
2787 @item
2788 Macro parameters that appear within string literals in the macro body.
2789 In traditional C macro replacement takes place within string literals,
2790 but does not in ISO C@.
2792 @item
2793 In traditional C, some preprocessor directives did not exist.
2794 Traditional preprocessors would only consider a line to be a directive
2795 if the @samp{#} appeared in column 1 on the line.  Therefore
2796 @option{-Wtraditional} warns about directives that traditional C
2797 understands but would ignore because the @samp{#} does not appear as the
2798 first character on the line.  It also suggests you hide directives like
2799 @samp{#pragma} not understood by traditional C by indenting them.  Some
2800 traditional implementations would not recognize @samp{#elif}, so it
2801 suggests avoiding it altogether.
2803 @item
2804 A function-like macro that appears without arguments.
2806 @item
2807 The unary plus operator.
2809 @item
2810 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2811 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
2812 constants.)  Note, these suffixes appear in macros defined in the system
2813 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2814 Use of these macros in user code might normally lead to spurious
2815 warnings, however GCC's integrated preprocessor has enough context to
2816 avoid warning in these cases.
2818 @item
2819 A function declared external in one block and then used after the end of
2820 the block.
2822 @item
2823 A @code{switch} statement has an operand of type @code{long}.
2825 @item
2826 A non-@code{static} function declaration follows a @code{static} one.
2827 This construct is not accepted by some traditional C compilers.
2829 @item
2830 The ISO type of an integer constant has a different width or
2831 signedness from its traditional type.  This warning is only issued if
2832 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
2833 typically represent bit patterns, are not warned about.
2835 @item
2836 Usage of ISO string concatenation is detected.
2838 @item
2839 Initialization of automatic aggregates.
2841 @item
2842 Identifier conflicts with labels.  Traditional C lacks a separate
2843 namespace for labels.
2845 @item
2846 Initialization of unions.  If the initializer is zero, the warning is
2847 omitted.  This is done under the assumption that the zero initializer in
2848 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2849 initializer warnings and relies on default initialization to zero in the
2850 traditional C case.
2852 @item
2853 Conversions by prototypes between fixed/floating point values and vice
2854 versa.  The absence of these prototypes when compiling with traditional
2855 C would cause serious problems.  This is a subset of the possible
2856 conversion warnings, for the full set use @option{-Wconversion}.
2858 @item
2859 Use of ISO C style function definitions.  This warning intentionally is
2860 @emph{not} issued for prototype declarations or variadic functions
2861 because these ISO C features will appear in your code when using
2862 libiberty's traditional C compatibility macros, @code{PARAMS} and
2863 @code{VPARAMS}.  This warning is also bypassed for nested functions
2864 because that feature is already a GCC extension and thus not relevant to
2865 traditional C compatibility.
2866 @end itemize
2868 @item -Wdeclaration-after-statement @r{(C only)}
2869 @opindex Wdeclaration-after-statement
2870 Warn when a declaration is found after a statement in a block.  This
2871 construct, known from C++, was introduced with ISO C99 and is by default
2872 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
2873 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
2875 @item -Wundef
2876 @opindex Wundef
2877 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2879 @item -Wendif-labels
2880 @opindex Wendif-labels
2881 Warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2883 @item -Wshadow
2884 @opindex Wshadow
2885 Warn whenever a local variable shadows another local variable, parameter or
2886 global variable or whenever a built-in function is shadowed.
2888 @item -Wlarger-than-@var{len}
2889 @opindex Wlarger-than
2890 Warn whenever an object of larger than @var{len} bytes is defined.
2892 @item -Wpointer-arith
2893 @opindex Wpointer-arith
2894 Warn about anything that depends on the ``size of'' a function type or
2895 of @code{void}.  GNU C assigns these types a size of 1, for
2896 convenience in calculations with @code{void *} pointers and pointers
2897 to functions.
2899 @item -Wbad-function-cast @r{(C only)}
2900 @opindex Wbad-function-cast
2901 Warn whenever a function call is cast to a non-matching type.
2902 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2904 @item -Wcast-qual
2905 @opindex Wcast-qual
2906 Warn whenever a pointer is cast so as to remove a type qualifier from
2907 the target type.  For example, warn if a @code{const char *} is cast
2908 to an ordinary @code{char *}.
2910 @item -Wcast-align
2911 @opindex Wcast-align
2912 Warn whenever a pointer is cast such that the required alignment of the
2913 target is increased.  For example, warn if a @code{char *} is cast to
2914 an @code{int *} on machines where integers can only be accessed at
2915 two- or four-byte boundaries.
2917 @item -Wwrite-strings
2918 @opindex Wwrite-strings
2919 When compiling C, give string constants the type @code{const
2920 char[@var{length}]} so that
2921 copying the address of one into a non-@code{const} @code{char *}
2922 pointer will get a warning; when compiling C++, warn about the
2923 deprecated conversion from string constants to @code{char *}.
2924 These warnings will help you find at
2925 compile time code that can try to write into a string constant, but
2926 only if you have been very careful about using @code{const} in
2927 declarations and prototypes.  Otherwise, it will just be a nuisance;
2928 this is why we did not make @option{-Wall} request these warnings.
2930 @item -Wconversion
2931 @opindex Wconversion
2932 Warn if a prototype causes a type conversion that is different from what
2933 would happen to the same argument in the absence of a prototype.  This
2934 includes conversions of fixed point to floating and vice versa, and
2935 conversions changing the width or signedness of a fixed point argument
2936 except when the same as the default promotion.
2938 Also, warn if a negative integer constant expression is implicitly
2939 converted to an unsigned type.  For example, warn about the assignment
2940 @code{x = -1} if @code{x} is unsigned.  But do not warn about explicit
2941 casts like @code{(unsigned) -1}.
2943 @item -Wsign-compare
2944 @opindex Wsign-compare
2945 @cindex warning for comparison of signed and unsigned values
2946 @cindex comparison of signed and unsigned values, warning
2947 @cindex signed and unsigned values, comparison warning
2948 Warn when a comparison between signed and unsigned values could produce
2949 an incorrect result when the signed value is converted to unsigned.
2950 This warning is also enabled by @option{-Wextra}; to get the other warnings
2951 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2953 @item -Waggregate-return
2954 @opindex Waggregate-return
2955 Warn if any functions that return structures or unions are defined or
2956 called.  (In languages where you can return an array, this also elicits
2957 a warning.)
2959 @item -Wstrict-prototypes @r{(C only)}
2960 @opindex Wstrict-prototypes
2961 Warn if a function is declared or defined without specifying the
2962 argument types.  (An old-style function definition is permitted without
2963 a warning if preceded by a declaration which specifies the argument
2964 types.)
2966 @item -Wold-style-definition @r{(C only)}
2967 @opindex Wold-style-definition
2968 Warn if an old-style function definition is used.  A warning is given
2969 even if there is a previous prototype.
2971 @item -Wmissing-prototypes @r{(C only)}
2972 @opindex Wmissing-prototypes
2973 Warn if a global function is defined without a previous prototype
2974 declaration.  This warning is issued even if the definition itself
2975 provides a prototype.  The aim is to detect global functions that fail
2976 to be declared in header files.
2978 @item -Wmissing-declarations @r{(C only)}
2979 @opindex Wmissing-declarations
2980 Warn if a global function is defined without a previous declaration.
2981 Do so even if the definition itself provides a prototype.
2982 Use this option to detect global functions that are not declared in
2983 header files.
2985 @item -Wmissing-field-initializers
2986 @opindex Wmissing-field-initializers
2987 @opindex W
2988 @opindex Wextra
2989 Warn if a structure's initializer has some fields missing.  For
2990 example, the following code would cause such a warning, because
2991 @code{x.h} is implicitly zero:
2993 @smallexample
2994 struct s @{ int f, g, h; @};
2995 struct s x = @{ 3, 4 @};
2996 @end smallexample
2998 This option does not warn about designated initializers, so the following
2999 modification would not trigger a warning:
3001 @smallexample
3002 struct s @{ int f, g, h; @};
3003 struct s x = @{ .f = 3, .g = 4 @};
3004 @end smallexample
3006 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
3007 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3009 @item -Wmissing-noreturn
3010 @opindex Wmissing-noreturn
3011 Warn about functions which might be candidates for attribute @code{noreturn}.
3012 Note these are only possible candidates, not absolute ones.  Care should
3013 be taken to manually verify functions actually do not ever return before
3014 adding the @code{noreturn} attribute, otherwise subtle code generation
3015 bugs could be introduced.  You will not get a warning for @code{main} in
3016 hosted C environments.
3018 @item -Wmissing-format-attribute
3019 @opindex Wmissing-format-attribute
3020 @opindex Wformat
3021 If @option{-Wformat} is enabled, also warn about functions which might be
3022 candidates for @code{format} attributes.  Note these are only possible
3023 candidates, not absolute ones.  GCC will guess that @code{format}
3024 attributes might be appropriate for any function that calls a function
3025 like @code{vprintf} or @code{vscanf}, but this might not always be the
3026 case, and some functions for which @code{format} attributes are
3027 appropriate may not be detected.  This option has no effect unless
3028 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3030 @item -Wno-multichar
3031 @opindex Wno-multichar
3032 @opindex Wmultichar
3033 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3034 Usually they indicate a typo in the user's code, as they have
3035 implementation-defined values, and should not be used in portable code.
3037 @item -Wno-deprecated-declarations
3038 @opindex Wno-deprecated-declarations
3039 Do not warn about uses of functions, variables, and types marked as
3040 deprecated by using the @code{deprecated} attribute.
3041 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3042 @pxref{Type Attributes}.)
3044 @item -Wpacked
3045 @opindex Wpacked
3046 Warn if a structure is given the packed attribute, but the packed
3047 attribute has no effect on the layout or size of the structure.
3048 Such structures may be mis-aligned for little benefit.  For
3049 instance, in this code, the variable @code{f.x} in @code{struct bar}
3050 will be misaligned even though @code{struct bar} does not itself
3051 have the packed attribute:
3053 @smallexample
3054 @group
3055 struct foo @{
3056   int x;
3057   char a, b, c, d;
3058 @} __attribute__((packed));
3059 struct bar @{
3060   char z;
3061   struct foo f;
3063 @end group
3064 @end smallexample
3066 @item -Wpadded
3067 @opindex Wpadded
3068 Warn if padding is included in a structure, either to align an element
3069 of the structure or to align the whole structure.  Sometimes when this
3070 happens it is possible to rearrange the fields of the structure to
3071 reduce the padding and so make the structure smaller.
3073 @item -Wredundant-decls
3074 @opindex Wredundant-decls
3075 Warn if anything is declared more than once in the same scope, even in
3076 cases where multiple declaration is valid and changes nothing.
3078 @item -Wnested-externs @r{(C only)}
3079 @opindex Wnested-externs
3080 Warn if an @code{extern} declaration is encountered within a function.
3082 @item -Wunreachable-code
3083 @opindex Wunreachable-code
3084 Warn if the compiler detects that code will never be executed.
3086 This option is intended to warn when the compiler detects that at
3087 least a whole line of source code will never be executed, because
3088 some condition is never satisfied or because it is after a
3089 procedure that never returns.
3091 It is possible for this option to produce a warning even though there
3092 are circumstances under which part of the affected line can be executed,
3093 so care should be taken when removing apparently-unreachable code.
3095 For instance, when a function is inlined, a warning may mean that the
3096 line is unreachable in only one inlined copy of the function.
3098 This option is not made part of @option{-Wall} because in a debugging
3099 version of a program there is often substantial code which checks
3100 correct functioning of the program and is, hopefully, unreachable
3101 because the program does work.  Another common use of unreachable
3102 code is to provide behavior which is selectable at compile-time.
3104 @item -Winline
3105 @opindex Winline
3106 Warn if a function can not be inlined and it was declared as inline.
3107 Even with this option, the compiler will not warn about failures to
3108 inline functions declared in system headers.
3110 The compiler uses a variety of heuristics to determine whether or not
3111 to inline a function.  For example, the compiler takes into account
3112 the size of the function being inlined and the the amount of inlining
3113 that has already been done in the current function.  Therefore,
3114 seemingly insignificant changes in the source program can cause the
3115 warnings produced by @option{-Winline} to appear or disappear.
3117 @item -Wno-invalid-offsetof @r{(C++ only)}
3118 @opindex Wno-invalid-offsetof
3119 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3120 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
3121 to a non-POD type is undefined.  In existing C++ implementations,
3122 however, @samp{offsetof} typically gives meaningful results even when
3123 applied to certain kinds of non-POD types. (Such as a simple
3124 @samp{struct} that fails to be a POD type only by virtue of having a
3125 constructor.)  This flag is for users who are aware that they are
3126 writing nonportable code and who have deliberately chosen to ignore the
3127 warning about it.
3129 The restrictions on @samp{offsetof} may be relaxed in a future version
3130 of the C++ standard.
3132 @item -Winvalid-pch
3133 @opindex Winvalid-pch
3134 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3135 the search path but can't be used.
3137 @item -Wlong-long
3138 @opindex Wlong-long
3139 @opindex Wno-long-long
3140 Warn if @samp{long long} type is used.  This is default.  To inhibit
3141 the warning messages, use @option{-Wno-long-long}.  Flags
3142 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3143 only when @option{-pedantic} flag is used.
3145 @item -Wvariadic-macros
3146 @opindex Wvariadic-macros
3147 @opindex Wno-variadic-macros
3148 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3149 alternate syntax when in pedantic ISO C99 mode.  This is default.
3150 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3152 @item -Wdisabled-optimization
3153 @opindex Wdisabled-optimization
3154 Warn if a requested optimization pass is disabled.  This warning does
3155 not generally indicate that there is anything wrong with your code; it
3156 merely indicates that GCC's optimizers were unable to handle the code
3157 effectively.  Often, the problem is that your code is too big or too
3158 complex; GCC will refuse to optimize programs when the optimization
3159 itself is likely to take inordinate amounts of time.
3161 @item -Wno-pointer-sign
3162 @opindex Wno-pointer-sign
3163 Don't warn for pointer argument passing or assignment with different signedness.
3164 Only useful in the negative form since this warning is enabled by default.
3165 This option is only supported for C and Objective-C@.
3167 @item -Werror
3168 @opindex Werror
3169 Make all warnings into errors.
3170 @end table
3172 @node Debugging Options
3173 @section Options for Debugging Your Program or GCC
3174 @cindex options, debugging
3175 @cindex debugging information options
3177 GCC has various special options that are used for debugging
3178 either your program or GCC:
3180 @table @gcctabopt
3181 @item -g
3182 @opindex g
3183 Produce debugging information in the operating system's native format
3184 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
3185 information.
3187 On most systems that use stabs format, @option{-g} enables use of extra
3188 debugging information that only GDB can use; this extra information
3189 makes debugging work better in GDB but will probably make other debuggers
3190 crash or
3191 refuse to read the program.  If you want to control for certain whether
3192 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3193 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3195 GCC allows you to use @option{-g} with
3196 @option{-O}.  The shortcuts taken by optimized code may occasionally
3197 produce surprising results: some variables you declared may not exist
3198 at all; flow of control may briefly move where you did not expect it;
3199 some statements may not be executed because they compute constant
3200 results or their values were already at hand; some statements may
3201 execute in different places because they were moved out of loops.
3203 Nevertheless it proves possible to debug optimized output.  This makes
3204 it reasonable to use the optimizer for programs that might have bugs.
3206 The following options are useful when GCC is generated with the
3207 capability for more than one debugging format.
3209 @item -ggdb
3210 @opindex ggdb
3211 Produce debugging information for use by GDB@.  This means to use the
3212 most expressive format available (DWARF 2, stabs, or the native format
3213 if neither of those are supported), including GDB extensions if at all
3214 possible.
3216 @item -gstabs
3217 @opindex gstabs
3218 Produce debugging information in stabs format (if that is supported),
3219 without GDB extensions.  This is the format used by DBX on most BSD
3220 systems.  On MIPS, Alpha and System V Release 4 systems this option
3221 produces stabs debugging output which is not understood by DBX or SDB@.
3222 On System V Release 4 systems this option requires the GNU assembler.
3224 @item -feliminate-unused-debug-symbols
3225 @opindex feliminate-unused-debug-symbols
3226 Produce debugging information in stabs format (if that is supported),
3227 for only symbols that are actually used.
3229 @item -gstabs+
3230 @opindex gstabs+
3231 Produce debugging information in stabs format (if that is supported),
3232 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3233 use of these extensions is likely to make other debuggers crash or
3234 refuse to read the program.
3236 @item -gcoff
3237 @opindex gcoff
3238 Produce debugging information in COFF format (if that is supported).
3239 This is the format used by SDB on most System V systems prior to
3240 System V Release 4.
3242 @item -gxcoff
3243 @opindex gxcoff
3244 Produce debugging information in XCOFF format (if that is supported).
3245 This is the format used by the DBX debugger on IBM RS/6000 systems.
3247 @item -gxcoff+
3248 @opindex gxcoff+
3249 Produce debugging information in XCOFF format (if that is supported),
3250 using GNU extensions understood only by the GNU debugger (GDB)@.  The
3251 use of these extensions is likely to make other debuggers crash or
3252 refuse to read the program, and may cause assemblers other than the GNU
3253 assembler (GAS) to fail with an error.
3255 @item -gdwarf-2
3256 @opindex gdwarf-2
3257 Produce debugging information in DWARF version 2 format (if that is
3258 supported).  This is the format used by DBX on IRIX 6.  With this
3259 option, GCC uses features of DWARF version 3 when they are useful;
3260 version 3 is upward compatible with version 2, but may still cause
3261 problems for older debuggers.
3263 @item -gvms
3264 @opindex gvms
3265 Produce debugging information in VMS debug format (if that is
3266 supported).  This is the format used by DEBUG on VMS systems.
3268 @item -g@var{level}
3269 @itemx -ggdb@var{level}
3270 @itemx -gstabs@var{level}
3271 @itemx -gcoff@var{level}
3272 @itemx -gxcoff@var{level}
3273 @itemx -gvms@var{level}
3274 Request debugging information and also use @var{level} to specify how
3275 much information.  The default level is 2.
3277 Level 1 produces minimal information, enough for making backtraces in
3278 parts of the program that you don't plan to debug.  This includes
3279 descriptions of functions and external variables, but no information
3280 about local variables and no line numbers.
3282 Level 3 includes extra information, such as all the macro definitions
3283 present in the program.  Some debuggers support macro expansion when
3284 you use @option{-g3}.
3286 @option{-gdwarf-2} does not accept a concatenated debug level, because
3287 GCC used to support an option @option{-gdwarf} that meant to generate
3288 debug information in version 1 of the DWARF format (which is very
3289 different from version 2), and it would have been too confusing.  That
3290 debug format is long obsolete, but the option cannot be changed now.
3291 Instead use an additional @option{-g@var{level}} option to change the
3292 debug level for DWARF2.
3294 @item -feliminate-dwarf2-dups
3295 @opindex feliminate-dwarf2-dups
3296 Compress DWARF2 debugging information by eliminating duplicated
3297 information about each symbol.  This option only makes sense when
3298 generating DWARF2 debugging information with @option{-gdwarf-2}.
3300 @cindex @command{prof}
3301 @item -p
3302 @opindex p
3303 Generate extra code to write profile information suitable for the
3304 analysis program @command{prof}.  You must use this option when compiling
3305 the source files you want data about, and you must also use it when
3306 linking.
3308 @cindex @command{gprof}
3309 @item -pg
3310 @opindex pg
3311 Generate extra code to write profile information suitable for the
3312 analysis program @command{gprof}.  You must use this option when compiling
3313 the source files you want data about, and you must also use it when
3314 linking.
3316 @item -Q
3317 @opindex Q
3318 Makes the compiler print out each function name as it is compiled, and
3319 print some statistics about each pass when it finishes.
3321 @item -ftime-report
3322 @opindex ftime-report
3323 Makes the compiler print some statistics about the time consumed by each
3324 pass when it finishes.
3326 @item -fmem-report
3327 @opindex fmem-report
3328 Makes the compiler print some statistics about permanent memory
3329 allocation when it finishes.
3331 @item -fprofile-arcs
3332 @opindex fprofile-arcs
3333 Add code so that program flow @dfn{arcs} are instrumented.  During
3334 execution the program records how many times each branch and call is
3335 executed and how many times it is taken or returns.  When the compiled
3336 program exits it saves this data to a file called
3337 @file{@var{auxname}.gcda} for each source file.  The data may be used for
3338 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3339 test coverage analysis (@option{-ftest-coverage}).  Each object file's
3340 @var{auxname} is generated from the name of the output file, if
3341 explicitly specified and it is not the final executable, otherwise it is
3342 the basename of the source file.  In both cases any suffix is removed
3343 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3344 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3346 @itemize
3348 @item
3349 Compile the source files with @option{-fprofile-arcs} plus optimization
3350 and code generation options.  For test coverage analysis, use the
3351 additional @option{-ftest-coverage} option.  You do not need to profile
3352 every source file in a program.
3354 @item
3355 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3356 (the latter implies the former).
3358 @item
3359 Run the program on a representative workload to generate the arc profile
3360 information.  This may be repeated any number of times.  You can run
3361 concurrent instances of your program, and provided that the file system
3362 supports locking, the data files will be correctly updated.  Also
3363 @code{fork} calls are detected and correctly handled (double counting
3364 will not happen).
3366 @item
3367 For profile-directed optimizations, compile the source files again with
3368 the same optimization and code generation options plus
3369 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3370 Control Optimization}).
3372 @item
3373 For test coverage analysis, use @command{gcov} to produce human readable
3374 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
3375 @command{gcov} documentation for further information.
3377 @end itemize
3379 With @option{-fprofile-arcs}, for each function of your program GCC
3380 creates a program flow graph, then finds a spanning tree for the graph.
3381 Only arcs that are not on the spanning tree have to be instrumented: the
3382 compiler adds code to count the number of times that these arcs are
3383 executed.  When an arc is the only exit or only entrance to a block, the
3384 instrumentation code can be added to the block; otherwise, a new basic
3385 block must be created to hold the instrumentation code.
3387 @item -ftree-based-profiling
3388 @opindex ftree-based-profiling
3389 This option is used in addition to @option{-fprofile-arcs} or
3390 @option{-fbranch-probabilities} to control whether those optimizations
3391 are performed on a tree-based or rtl-based internal representation.
3392 If you use this option when compiling with @option{-fprofile-arcs},
3393 you must also use it when compiling later with @option{-fbranch-probabilities}.
3394 Currently the tree-based optimization is in an early stage of
3395 development, and this option is recommended only for those people
3396 working on improving it.
3398 @need 2000
3399 @item -ftest-coverage
3400 @opindex ftest-coverage
3401 Produce a notes file that the @command{gcov} code-coverage utility
3402 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3403 show program coverage.  Each source file's note file is called
3404 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
3405 above for a description of @var{auxname} and instructions on how to
3406 generate test coverage data.  Coverage data will match the source files
3407 more closely, if you do not optimize.
3409 @item -d@var{letters}
3410 @item -fdump-rtl-@var{pass}
3411 @opindex d
3412 Says to make debugging dumps during compilation at times specified by
3413 @var{letters}.    This is used for debugging the RTL-based passes of the
3414 compiler.  The file names for most of the dumps are made by appending a
3415 pass number and a word to the @var{dumpname}.  @var{dumpname} is generated
3416 from the name of the output file, if explicitly specified and it is not
3417 an executable, otherwise it is the basename of the source file.
3419 Most debug dumps can be enabled either passing a letter to the @option{-d}
3420 option, or with a long @option{-fdump-rtl} switch; here are the possible
3421 letters for use in @var{letters} and @var{pass}, and their meanings:
3423 @table @gcctabopt
3424 @item -dA
3425 @opindex dA
3426 Annotate the assembler output with miscellaneous debugging information.
3428 @item -db
3429 @itemx -fdump-rtl-bp
3430 @opindex db
3431 @opindex fdump-rtl-bp
3432 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3434 @item -dB
3435 @itemx -fdump-rtl-bbro
3436 @opindex dB
3437 @opindex fdump-rtl-bbro
3438 Dump after block reordering, to @file{@var{file}.30.bbro}.
3440 @item -dc
3441 @itemx -fdump-rtl-combine
3442 @opindex dc
3443 @opindex fdump-rtl-combine
3444 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3446 @item -dC
3447 @itemx -fdump-rtl-ce1
3448 @itemx -fdump-rtl-ce2
3449 @opindex dC
3450 @opindex fdump-rtl-ce1
3451 @opindex fdump-rtl-ce2
3452 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3453 first if conversion, to the file @file{@var{file}.11.ce1}.  @option{-dC}
3454 and @option{-fdump-rtl-ce2} enable dumping after the second if
3455 conversion, to the file @file{@var{file}.18.ce2}.
3457 @item -dd
3458 @itemx -fdump-rtl-btl
3459 @itemx -fdump-rtl-dbr
3460 @opindex dd
3461 @opindex fdump-rtl-btl
3462 @opindex fdump-rtl-dbr
3463 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3464 target load optimization, to to @file{@var{file}.31.btl}.  @option{-dd}
3465 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3466 scheduling, to @file{@var{file}.36.dbr}.
3468 @item -dD
3469 @opindex dD
3470 Dump all macro definitions, at the end of preprocessing, in addition to
3471 normal output.
3473 @item -dE
3474 @itemx -fdump-rtl-ce3
3475 @opindex dE
3476 @opindex fdump-rtl-ce3
3477 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3479 @item -df
3480 @itemx -fdump-rtl-cfg
3481 @itemx -fdump-rtl-life
3482 @opindex df
3483 @opindex fdump-rtl-cfg
3484 @opindex fdump-rtl-life
3485 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3486 and data flow analysis, to @file{@var{file}.08.cfg}.  @option{-df}
3487 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3488 to @file{@var{file}.16.life}.
3490 @item -dg
3491 @itemx -fdump-rtl-greg
3492 @opindex dg
3493 @opindex fdump-rtl-greg
3494 Dump after global register allocation, to @file{@var{file}.23.greg}.
3496 @item -dG
3497 @itemx -fdump-rtl-gcse
3498 @itemx -fdump-rtl-bypass
3499 @opindex dG
3500 @opindex fdump-rtl-gcse
3501 @opindex fdump-rtl-bypass
3502 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3503 @file{@var{file}.05.gcse}.  @option{-dG} and @option{-fdump-rtl-bypass}
3504 enable dumping after jump bypassing and control flow optimizations, to
3505 @file{@var{file}.07.bypass}.
3507 @item -dh
3508 @itemx -fdump-rtl-eh
3509 @opindex dh
3510 @opindex fdump-rtl-eh
3511 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3513 @item -di
3514 @itemx -fdump-rtl-sibling
3515 @opindex di
3516 @opindex fdump-rtl-sibling
3517 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3519 @item -dj
3520 @itemx -fdump-rtl-jump
3521 @opindex dj
3522 @opindex fdump-rtl-jump
3523 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3525 @item -dk
3526 @itemx -fdump-rtl-stack
3527 @opindex dk
3528 @opindex fdump-rtl-stack
3529 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3531 @item -dl
3532 @itemx -fdump-rtl-lreg
3533 @opindex dl
3534 @opindex fdump-rtl-lreg
3535 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3537 @item -dL
3538 @itemx -fdump-rtl-loop
3539 @itemx -fdump-rtl-loop2
3540 @opindex dL
3541 @opindex fdump-rtl-loop
3542 @opindex fdump-rtl-loop2
3543 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3544 loop optimization pass, to @file{@var{file}.06.loop}.  @option{-dL} and
3545 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3546 @file{@var{file}.13.loop2}.
3548 @item -dm
3549 @itemx -fdump-rtl-sms
3550 @opindex dm
3551 @opindex fdump-rtl-sms
3552 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3554 @item -dM
3555 @itemx -fdump-rtl-mach
3556 @opindex dM
3557 @opindex fdump-rtl-mach
3558 Dump after performing the machine dependent reorganization pass, to
3559 @file{@var{file}.35.mach}.
3561 @item -dn
3562 @itemx -fdump-rtl-rnreg
3563 @opindex dn
3564 @opindex fdump-rtl-rnreg
3565 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3567 @item -dN
3568 @itemx -fdump-rtl-regmove
3569 @opindex dN
3570 @opindex fdump-rtl-regmove
3571 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3573 @item -do
3574 @itemx -fdump-rtl-postreload
3575 @opindex do
3576 @opindex fdump-rtl-postreload
3577 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3579 @item -dr
3580 @itemx -fdump-rtl-expand
3581 @opindex dr
3582 @opindex fdump-rtl-expand
3583 Dump after RTL generation, to @file{@var{file}.00.expand}.
3585 @item -dR
3586 @itemx -fdump-rtl-sched2
3587 @opindex dR
3588 @opindex fdump-rtl-sched2
3589 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3591 @item -ds
3592 @itemx -fdump-rtl-cse
3593 @opindex ds
3594 @opindex fdump-rtl-cse
3595 Dump after CSE (including the jump optimization that sometimes follows
3596 CSE), to @file{@var{file}.04.cse}.
3598 @item -dS
3599 @itemx -fdump-rtl-sched
3600 @opindex dS
3601 @opindex fdump-rtl-sched
3602 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3604 @item -dt
3605 @itemx -fdump-rtl-cse2
3606 @opindex dt
3607 @opindex fdump-rtl-cse2
3608 Dump after the second CSE pass (including the jump optimization that
3609 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3611 @item -dT
3612 @itemx -fdump-rtl-tracer
3613 @opindex dT
3614 @opindex fdump-rtl-tracer
3615 Dump after running tracer, to @file{@var{file}.12.tracer}.
3617 @item -dV
3618 @itemx -fdump-rtl-vpt
3619 @itemx -fdump-rtl-vartrack
3620 @opindex dV
3621 @opindex fdump-rtl-vpt
3622 @opindex fdump-rtl-vartrack
3623 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3624 profile transformations, to @file{@var{file}.10.vpt}.  @option{-dV}
3625 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3626 to @file{@var{file}.34.vartrack}.
3628 @item -dw
3629 @itemx -fdump-rtl-flow2
3630 @opindex dw
3631 @opindex fdump-rtl-flow2
3632 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3634 @item -dz
3635 @itemx -fdump-rtl-peephole2
3636 @opindex dz
3637 @opindex fdump-rtl-peephole2
3638 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3640 @item -dZ
3641 @itemx -fdump-rtl-web
3642 @opindex dZ
3643 @opindex fdump-rtl-web
3644 Dump after live range splitting, to @file{@var{file}.14.web}.
3646 @item -da
3647 @itemx -fdump-rtl-all
3648 @opindex da
3649 @opindex fdump-rtl-all
3650 Produce all the dumps listed above.
3652 @item -dH
3653 @opindex dH
3654 Produce a core dump whenever an error occurs.
3656 @item -dm
3657 @opindex dm
3658 Print statistics on memory usage, at the end of the run, to
3659 standard error.
3661 @item -dp
3662 @opindex dp
3663 Annotate the assembler output with a comment indicating which
3664 pattern and alternative was used.  The length of each instruction is
3665 also printed.
3667 @item -dP
3668 @opindex dP
3669 Dump the RTL in the assembler output as a comment before each instruction.
3670 Also turns on @option{-dp} annotation.
3672 @item -dv
3673 @opindex dv
3674 For each of the other indicated dump files (either with @option{-d} or
3675 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3676 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3678 @item -dx
3679 @opindex dx
3680 Just generate RTL for a function instead of compiling it.  Usually used
3681 with @samp{r} (@option{-fdump-rtl-expand}).
3683 @item -dy
3684 @opindex dy
3685 Dump debugging information during parsing, to standard error.
3686 @end table
3688 @item -fdump-unnumbered
3689 @opindex fdump-unnumbered
3690 When doing debugging dumps (see @option{-d} option above), suppress instruction
3691 numbers and line number note output.  This makes it more feasible to
3692 use diff on debugging dumps for compiler invocations with different
3693 options, in particular with and without @option{-g}.
3695 @item -fdump-translation-unit @r{(C and C++ only)}
3696 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3697 @opindex fdump-translation-unit
3698 Dump a representation of the tree structure for the entire translation
3699 unit to a file.  The file name is made by appending @file{.tu} to the
3700 source file name.  If the @samp{-@var{options}} form is used, @var{options}
3701 controls the details of the dump as described for the
3702 @option{-fdump-tree} options.
3704 @item -fdump-class-hierarchy @r{(C++ only)}
3705 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3706 @opindex fdump-class-hierarchy
3707 Dump a representation of each class's hierarchy and virtual function
3708 table layout to a file.  The file name is made by appending @file{.class}
3709 to the source file name.  If the @samp{-@var{options}} form is used,
3710 @var{options} controls the details of the dump as described for the
3711 @option{-fdump-tree} options.
3713 @item -fdump-ipa-@var{switch}
3714 @opindex fdump-ipa
3715 Control the dumping at various stages of inter-procedural analysis
3716 language tree to a file.  The file name is generated by appending a switch
3717 specific suffix to the source file name.  The following dumps are possible:
3719 @table @samp
3720 @item all
3721 Enables all inter-procedural analysis dumps; currently the only produced
3722 dump is the @samp{cgraph} dump.
3724 @item cgraph
3725 Dumps information about call-graph optimization, unused function removal,
3726 and inlining decisions.
3727 @end table
3729 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3730 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3731 @opindex fdump-tree
3732 Control the dumping at various stages of processing the intermediate
3733 language tree to a file.  The file name is generated by appending a switch
3734 specific suffix to the source file name.  If the @samp{-@var{options}}
3735 form is used, @var{options} is a list of @samp{-} separated options that
3736 control the details of the dump.  Not all options are applicable to all
3737 dumps, those which are not meaningful will be ignored.  The following
3738 options are available
3740 @table @samp
3741 @item address
3742 Print the address of each node.  Usually this is not meaningful as it
3743 changes according to the environment and source file.  Its primary use
3744 is for tying up a dump file with a debug environment.
3745 @item slim
3746 Inhibit dumping of members of a scope or body of a function merely
3747 because that scope has been reached.  Only dump such items when they
3748 are directly reachable by some other path.  When dumping pretty-printed
3749 trees, this option inhibits dumping the bodies of control structures.
3750 @item raw
3751 Print a raw representation of the tree.  By default, trees are
3752 pretty-printed into a C-like representation.
3753 @item details
3754 Enable more detailed dumps (not honored by every dump option).
3755 @item stats
3756 Enable dumping various statistics about the pass (not honored by every dump
3757 option).
3758 @item blocks
3759 Enable showing basic block boundaries (disabled in raw dumps).
3760 @item vops
3761 Enable showing virtual operands for every statement.
3762 @item lineno
3763 Enable showing line numbers for statements.
3764 @item uid
3765 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3766 @item all
3767 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3768 @end table
3770 The following tree dumps are possible:
3771 @table @samp
3773 @item original
3774 Dump before any tree based optimization, to @file{@var{file}.original}.
3776 @item optimized
3777 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3779 @item inlined
3780 Dump after function inlining, to @file{@var{file}.inlined}.
3782 @item gimple
3783 @opindex fdump-tree-gimple
3784 Dump each function before and after the gimplification pass to a file.  The
3785 file name is made by appending @file{.gimple} to the source file name.
3787 @item cfg
3788 @opindex fdump-tree-cfg
3789 Dump the control flow graph of each function to a file.  The file name is
3790 made by appending @file{.cfg} to the source file name.
3792 @item vcg
3793 @opindex fdump-tree-vcg
3794 Dump the control flow graph of each function to a file in VCG format.  The
3795 file name is made by appending @file{.vcg} to the source file name.  Note
3796 that if the file contains more than one function, the generated file cannot
3797 be used directly by VCG@.  You will need to cut and paste each function's
3798 graph into its own separate file first.
3800 @item ch
3801 @opindex fdump-tree-ch
3802 Dump each function after copying loop headers.  The file name is made by
3803 appending @file{.ch} to the source file name.
3805 @item ssa
3806 @opindex fdump-tree-ssa
3807 Dump SSA related information to a file.  The file name is made by appending
3808 @file{.ssa} to the source file name.
3810 @item alias
3811 @opindex fdump-tree-alias
3812 Dump aliasing information for each function.  The file name is made by
3813 appending @file{.alias} to the source file name.
3815 @item ccp
3816 @opindex fdump-tree-ccp
3817 Dump each function after CCP@.  The file name is made by appending
3818 @file{.ccp} to the source file name.
3820 @item pre
3821 @opindex fdump-tree-pre
3822 Dump trees after partial redundancy elimination.  The file name is made
3823 by appending @file{.pre} to the source file name.
3825 @item fre
3826 @opindex fdump-tree-fre
3827 Dump trees after full redundancy elimination.  The file name is made
3828 by appending @file{.fre} to the source file name.
3830 @item dce
3831 @opindex fdump-tree-dce
3832 Dump each function after dead code elimination.  The file name is made by
3833 appending @file{.dce} to the source file name.
3835 @item mudflap
3836 @opindex fdump-tree-mudflap
3837 Dump each function after adding mudflap instrumentation.  The file name is
3838 made by appending @file{.mudflap} to the source file name.
3840 @item sra
3841 @opindex fdump-tree-sra
3842 Dump each function after performing scalar replacement of aggregates.  The
3843 file name is made by appending @file{.sra} to the source file name.
3845 @item dom
3846 @opindex fdump-tree-dom
3847 Dump each function after applying dominator tree optimizations.  The file
3848 name is made by appending @file{.dom} to the source file name.
3850 @item dse
3851 @opindex fdump-tree-dse
3852 Dump each function after applying dead store elimination.  The file
3853 name is made by appending @file{.dse} to the source file name.
3855 @item phiopt
3856 @opindex fdump-tree-phiopt
3857 Dump each function after optimizing PHI nodes into straightline code.  The file
3858 name is made by appending @file{.phiopt} to the source file name.
3860 @item forwprop
3861 @opindex fdump-tree-forwprop
3862 Dump each function after forward propagating single use variables.  The file
3863 name is made by appending @file{.forwprop} to the source file name.
3865 @item copyrename
3866 @opindex fdump-tree-copyrename
3867 Dump each function after applying the copy rename optimization.  The file
3868 name is made by appending @file{.copyrename} to the source file name.
3870 @item nrv
3871 @opindex fdump-tree-nrv
3872 Dump each function after applying the named return value optimization on
3873 generic trees.  The file name is made by appending @file{.nrv} to the source
3874 file name.
3876 @item vect
3877 @opindex fdump-tree-vect
3878 Dump each function after applying vectorization of loops.  The file name is
3879 made by appending @file{.vect} to the source file name.
3881 @item all
3882 @opindex fdump-tree-all
3883 Enable all the available tree dumps with the flags provided in this option.
3884 @end table
3886 @item -ftree-vectorizer-verbose=@var{n}
3887 @opindex ftree-vectorizer-verbose
3888 This option controls the amount of debugging output the vectorizer prints.
3889 This information is written to standard error, unless @option{-fdump-tree-all}
3890 or @option{-fdump-tree-vect} is specified, in which case it is output to the
3891 usual dump listing file, @file{.vect}.
3893 @item -frandom-seed=@var{string}
3894 @opindex frandom-string
3895 This option provides a seed that GCC uses when it would otherwise use
3896 random numbers.  It is used to generate certain symbol names
3897 that have to be different in every compiled file.  It is also used to
3898 place unique stamps in coverage data files and the object files that
3899 produce them.  You can use the @option{-frandom-seed} option to produce
3900 reproducibly identical object files.
3902 The @var{string} should be different for every file you compile.
3904 @item -fsched-verbose=@var{n}
3905 @opindex fsched-verbose
3906 On targets that use instruction scheduling, this option controls the
3907 amount of debugging output the scheduler prints.  This information is
3908 written to standard error, unless @option{-dS} or @option{-dR} is
3909 specified, in which case it is output to the usual dump
3910 listing file, @file{.sched} or @file{.sched2} respectively.  However
3911 for @var{n} greater than nine, the output is always printed to standard
3912 error.
3914 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
3915 same information as @option{-dRS}.  For @var{n} greater than one, it
3916 also output basic block probabilities, detailed ready list information
3917 and unit/insn info.  For @var{n} greater than two, it includes RTL
3918 at abort point, control-flow and regions info.  And for @var{n} over
3919 four, @option{-fsched-verbose} also includes dependence info.
3921 @item -save-temps
3922 @opindex save-temps
3923 Store the usual ``temporary'' intermediate files permanently; place them
3924 in the current directory and name them based on the source file.  Thus,
3925 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
3926 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
3927 preprocessed @file{foo.i} output file even though the compiler now
3928 normally uses an integrated preprocessor.
3930 When used in combination with the @option{-x} command line option,
3931 @option{-save-temps} is sensible enough to avoid over writing an
3932 input source file with the same extension as an intermediate file.
3933 The corresponding intermediate file may be obtained by renaming the
3934 source file before using @option{-save-temps}.
3936 @item -time
3937 @opindex time
3938 Report the CPU time taken by each subprocess in the compilation
3939 sequence.  For C source files, this is the compiler proper and assembler
3940 (plus the linker if linking is done).  The output looks like this:
3942 @smallexample
3943 # cc1 0.12 0.01
3944 # as 0.00 0.01
3945 @end smallexample
3947 The first number on each line is the ``user time'', that is time spent
3948 executing the program itself.  The second number is ``system time'',
3949 time spent executing operating system routines on behalf of the program.
3950 Both numbers are in seconds.
3952 @item -fvar-tracking
3953 @opindex fvar-tracking
3954 Run variable tracking pass.  It computes where variables are stored at each
3955 position in code.  Better debugging information is then generated
3956 (if the debugging information format supports this information).
3958 It is enabled by default when compiling with optimization (@option{-Os},
3959 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
3960 the debug info format supports it.
3962 @item -print-file-name=@var{library}
3963 @opindex print-file-name
3964 Print the full absolute name of the library file @var{library} that
3965 would be used when linking---and don't do anything else.  With this
3966 option, GCC does not compile or link anything; it just prints the
3967 file name.
3969 @item -print-multi-directory
3970 @opindex print-multi-directory
3971 Print the directory name corresponding to the multilib selected by any
3972 other switches present in the command line.  This directory is supposed
3973 to exist in @env{GCC_EXEC_PREFIX}.
3975 @item -print-multi-lib
3976 @opindex print-multi-lib
3977 Print the mapping from multilib directory names to compiler switches
3978 that enable them.  The directory name is separated from the switches by
3979 @samp{;}, and each switch starts with an @samp{@@} instead of the
3980 @samp{-}, without spaces between multiple switches.  This is supposed to
3981 ease shell-processing.
3983 @item -print-prog-name=@var{program}
3984 @opindex print-prog-name
3985 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
3987 @item -print-libgcc-file-name
3988 @opindex print-libgcc-file-name
3989 Same as @option{-print-file-name=libgcc.a}.
3991 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
3992 but you do want to link with @file{libgcc.a}.  You can do
3994 @smallexample
3995 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
3996 @end smallexample
3998 @item -print-search-dirs
3999 @opindex print-search-dirs
4000 Print the name of the configured installation directory and a list of
4001 program and library directories @command{gcc} will search---and don't do anything else.
4003 This is useful when @command{gcc} prints the error message
4004 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4005 To resolve this you either need to put @file{cpp0} and the other compiler
4006 components where @command{gcc} expects to find them, or you can set the environment
4007 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4008 Don't forget the trailing @samp{/}.
4009 @xref{Environment Variables}.
4011 @item -dumpmachine
4012 @opindex dumpmachine
4013 Print the compiler's target machine (for example,
4014 @samp{i686-pc-linux-gnu})---and don't do anything else.
4016 @item -dumpversion
4017 @opindex dumpversion
4018 Print the compiler version (for example, @samp{3.0})---and don't do
4019 anything else.
4021 @item -dumpspecs
4022 @opindex dumpspecs
4023 Print the compiler's built-in specs---and don't do anything else.  (This
4024 is used when GCC itself is being built.)  @xref{Spec Files}.
4026 @item -feliminate-unused-debug-types
4027 @opindex feliminate-unused-debug-types
4028 Normally, when producing DWARF2 output, GCC will emit debugging
4029 information for all types declared in a compilation
4030 unit, regardless of whether or not they are actually used
4031 in that compilation unit.  Sometimes this is useful, such as
4032 if, in the debugger, you want to cast a value to a type that is
4033 not actually used in your program (but is declared).  More often,
4034 however, this results in a significant amount of wasted space.
4035 With this option, GCC will avoid producing debug symbol output
4036 for types that are nowhere used in the source file being compiled.
4037 @end table
4039 @node Optimize Options
4040 @section Options That Control Optimization
4041 @cindex optimize options
4042 @cindex options, optimization
4044 These options control various sorts of optimizations.
4046 Without any optimization option, the compiler's goal is to reduce the
4047 cost of compilation and to make debugging produce the expected
4048 results.  Statements are independent: if you stop the program with a
4049 breakpoint between statements, you can then assign a new value to any
4050 variable or change the program counter to any other statement in the
4051 function and get exactly the results you would expect from the source
4052 code.
4054 Turning on optimization flags makes the compiler attempt to improve
4055 the performance and/or code size at the expense of compilation time
4056 and possibly the ability to debug the program.
4058 The compiler performs optimization based on the knowledge it has of
4059 the program.  Optimization levels @option{-O2} and above, in
4060 particular, enable @emph{unit-at-a-time} mode, which allows the
4061 compiler to consider information gained from later functions in
4062 the file when compiling a function.  Compiling multiple files at
4063 once to a single output file in @emph{unit-at-a-time} mode allows
4064 the compiler to use information gained from all of the files when
4065 compiling each of them.
4067 Not all optimizations are controlled directly by a flag.  Only
4068 optimizations that have a flag are listed.
4070 @table @gcctabopt
4071 @item -O
4072 @itemx -O1
4073 @opindex O
4074 @opindex O1
4075 Optimize.  Optimizing compilation takes somewhat more time, and a lot
4076 more memory for a large function.
4078 With @option{-O}, the compiler tries to reduce code size and execution
4079 time, without performing any optimizations that take a great deal of
4080 compilation time.
4082 @option{-O} turns on the following optimization flags:
4083 @gccoptlist{-fdefer-pop @gol
4084 -fdelayed-branch @gol
4085 -fguess-branch-probability @gol
4086 -fcprop-registers @gol
4087 -floop-optimize @gol
4088 -fif-conversion @gol
4089 -fif-conversion2 @gol
4090 -ftree-ccp @gol
4091 -ftree-dce @gol
4092 -ftree-dom @gol
4093 -ftree-dse @gol
4094 -ftree-ter @gol
4095 -ftree-live_range_split @gol
4096 -ftree-sra @gol
4097 -ftree-copyrename @gol
4098 -ftree-fre @gol
4099 -ftree-ch @gol
4100 -fmerge-constants}
4102 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4103 where doing so does not interfere with debugging.
4105 @item -O2
4106 @opindex O2
4107 Optimize even more.  GCC performs nearly all supported optimizations
4108 that do not involve a space-speed tradeoff.  The compiler does not
4109 perform loop unrolling or function inlining when you specify @option{-O2}.
4110 As compared to @option{-O}, this option increases both compilation time
4111 and the performance of the generated code.
4113 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
4114 also turns on the following optimization flags:
4115 @gccoptlist{-fthread-jumps @gol
4116 -fcrossjumping @gol
4117 -foptimize-sibling-calls @gol
4118 -fcse-follow-jumps  -fcse-skip-blocks @gol
4119 -fgcse  -fgcse-lm  @gol
4120 -fexpensive-optimizations @gol
4121 -fstrength-reduce @gol
4122 -frerun-cse-after-loop  -frerun-loop-opt @gol
4123 -fcaller-saves @gol
4124 -fforce-mem @gol
4125 -fpeephole2 @gol
4126 -fschedule-insns  -fschedule-insns2 @gol
4127 -fsched-interblock  -fsched-spec @gol
4128 -fregmove @gol
4129 -fstrict-aliasing @gol
4130 -fdelete-null-pointer-checks @gol
4131 -freorder-blocks  -freorder-functions @gol
4132 -funit-at-a-time @gol
4133 -falign-functions  -falign-jumps @gol
4134 -falign-loops  -falign-labels @gol
4135 -ftree-pre}
4137 Please note the warning under @option{-fgcse} about
4138 invoking @option{-O2} on programs that use computed gotos.
4140 @item -O3
4141 @opindex O3
4142 Optimize yet more.  @option{-O3} turns on all optimizations specified by
4143 @option{-O2} and also turns on the @option{-finline-functions},
4144 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4146 @item -O0
4147 @opindex O0
4148 Do not optimize.  This is the default.
4150 @item -Os
4151 @opindex Os
4152 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
4153 do not typically increase code size.  It also performs further
4154 optimizations designed to reduce code size.
4156 @option{-Os} disables the following optimization flags:
4157 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
4158 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition -fprefetch-loop-arrays}
4160 If you use multiple @option{-O} options, with or without level numbers,
4161 the last such option is the one that is effective.
4162 @end table
4164 Options of the form @option{-f@var{flag}} specify machine-independent
4165 flags.  Most flags have both positive and negative forms; the negative
4166 form of @option{-ffoo} would be @option{-fno-foo}.  In the table
4167 below, only one of the forms is listed---the one you typically will
4168 use.  You can figure out the other form by either removing @samp{no-}
4169 or adding it.
4171 The following options control specific optimizations.  They are either
4172 activated by @option{-O} options or are related to ones that are.  You
4173 can use the following flags in the rare cases when ``fine-tuning'' of
4174 optimizations to be performed is desired.
4176 @table @gcctabopt
4177 @item -fno-default-inline
4178 @opindex fno-default-inline
4179 Do not make member functions inline by default merely because they are
4180 defined inside the class scope (C++ only).  Otherwise, when you specify
4181 @w{@option{-O}}, member functions defined inside class scope are compiled
4182 inline by default; i.e., you don't need to add @samp{inline} in front of
4183 the member function name.
4185 @item -fno-defer-pop
4186 @opindex fno-defer-pop
4187 Always pop the arguments to each function call as soon as that function
4188 returns.  For machines which must pop arguments after a function call,
4189 the compiler normally lets arguments accumulate on the stack for several
4190 function calls and pops them all at once.
4192 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4194 @item -fforce-mem
4195 @opindex fforce-mem
4196 Force memory operands to be copied into registers before doing
4197 arithmetic on them.  This produces better code by making all memory
4198 references potential common subexpressions.  When they are not common
4199 subexpressions, instruction combination should eliminate the separate
4200 register-load.
4202 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4204 @item -fforce-addr
4205 @opindex fforce-addr
4206 Force memory address constants to be copied into registers before
4207 doing arithmetic on them.  This may produce better code just as
4208 @option{-fforce-mem} may.
4210 @item -fomit-frame-pointer
4211 @opindex fomit-frame-pointer
4212 Don't keep the frame pointer in a register for functions that
4213 don't need one.  This avoids the instructions to save, set up and
4214 restore frame pointers; it also makes an extra register available
4215 in many functions.  @strong{It also makes debugging impossible on
4216 some machines.}
4218 On some machines, such as the VAX, this flag has no effect, because
4219 the standard calling sequence automatically handles the frame pointer
4220 and nothing is saved by pretending it doesn't exist.  The
4221 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4222 whether a target machine supports this flag.  @xref{Registers,,Register
4223 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4225 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4227 @item -foptimize-sibling-calls
4228 @opindex foptimize-sibling-calls
4229 Optimize sibling and tail recursive calls.
4231 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4233 @item -fno-inline
4234 @opindex fno-inline
4235 Don't pay attention to the @code{inline} keyword.  Normally this option
4236 is used to keep the compiler from expanding any functions inline.
4237 Note that if you are not optimizing, no functions can be expanded inline.
4239 @item -finline-functions
4240 @opindex finline-functions
4241 Integrate all simple functions into their callers.  The compiler
4242 heuristically decides which functions are simple enough to be worth
4243 integrating in this way.
4245 If all calls to a given function are integrated, and the function is
4246 declared @code{static}, then the function is normally not output as
4247 assembler code in its own right.
4249 Enabled at level @option{-O3}.
4251 @item -finline-limit=@var{n}
4252 @opindex finline-limit
4253 By default, GCC limits the size of functions that can be inlined.  This flag
4254 allows the control of this limit for functions that are explicitly marked as
4255 inline (i.e., marked with the inline keyword or defined within the class
4256 definition in c++).  @var{n} is the size of functions that can be inlined in
4257 number of pseudo instructions (not counting parameter handling).  The default
4258 value of @var{n} is 600.
4259 Increasing this value can result in more inlined code at
4260 the cost of compilation time and memory consumption.  Decreasing usually makes
4261 the compilation faster and less code will be inlined (which presumably
4262 means slower programs).  This option is particularly useful for programs that
4263 use inlining heavily such as those based on recursive templates with C++.
4265 Inlining is actually controlled by a number of parameters, which may be
4266 specified individually by using @option{--param @var{name}=@var{value}}.
4267 The @option{-finline-limit=@var{n}} option sets some of these parameters
4268 as follows:
4270 @table @gcctabopt
4271  @item max-inline-insns-single
4272   is set to @var{n}/2.
4273  @item max-inline-insns-auto
4274   is set to @var{n}/2.
4275  @item min-inline-insns
4276   is set to 130 or @var{n}/4, whichever is smaller.
4277  @item max-inline-insns-rtl
4278   is set to @var{n}.
4279 @end table
4281 See below for a documentation of the individual
4282 parameters controlling inlining.
4284 @emph{Note:} pseudo instruction represents, in this particular context, an
4285 abstract measurement of function's size.  In no way, it represents a count
4286 of assembly instructions and as such its exact meaning might change from one
4287 release to an another.
4289 @item -fkeep-inline-functions
4290 @opindex fkeep-inline-functions
4291 In C, emit @code{static} functions that are declared @code{inline}
4292 into the object file, even if the function has been inlined into all
4293 of its callers.  This switch does not affect functions using the
4294 @code{extern inline} extension in GNU C@.  In C++, emit any and all
4295 inline functions into the object file.
4297 @item -fkeep-static-consts
4298 @opindex fkeep-static-consts
4299 Emit variables declared @code{static const} when optimization isn't turned
4300 on, even if the variables aren't referenced.
4302 GCC enables this option by default.  If you want to force the compiler to
4303 check if the variable was referenced, regardless of whether or not
4304 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4306 @item -fmerge-constants
4307 Attempt to merge identical constants (string constants and floating point
4308 constants) across compilation units.
4310 This option is the default for optimized compilation if the assembler and
4311 linker support it.  Use @option{-fno-merge-constants} to inhibit this
4312 behavior.
4314 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4316 @item -fmerge-all-constants
4317 Attempt to merge identical constants and identical variables.
4319 This option implies @option{-fmerge-constants}.  In addition to
4320 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4321 arrays or initialized constant variables with integral or floating point
4322 types.  Languages like C or C++ require each non-automatic variable to
4323 have distinct location, so using this option will result in non-conforming
4324 behavior.
4326 @item -fmodulo-sched
4327 @opindex fmodulo-sched
4328 Perform swing modulo scheduling immediately before the first scheduling
4329 pass.  This pass looks at innermost loops and reorders their
4330 instructions by overlapping different iterations.
4332 @item -fno-branch-count-reg
4333 @opindex fno-branch-count-reg
4334 Do not use ``decrement and branch'' instructions on a count register,
4335 but instead generate a sequence of instructions that decrement a
4336 register, compare it against zero, then branch based upon the result.
4337 This option is only meaningful on architectures that support such
4338 instructions, which include x86, PowerPC, IA-64 and S/390.
4340 The default is @option{-fbranch-count-reg}, enabled when
4341 @option{-fstrength-reduce} is enabled.
4343 @item -fno-function-cse
4344 @opindex fno-function-cse
4345 Do not put function addresses in registers; make each instruction that
4346 calls a constant function contain the function's address explicitly.
4348 This option results in less efficient code, but some strange hacks
4349 that alter the assembler output may be confused by the optimizations
4350 performed when this option is not used.
4352 The default is @option{-ffunction-cse}
4354 @item -fno-zero-initialized-in-bss
4355 @opindex fno-zero-initialized-in-bss
4356 If the target supports a BSS section, GCC by default puts variables that
4357 are initialized to zero into BSS@.  This can save space in the resulting
4358 code.
4360 This option turns off this behavior because some programs explicitly
4361 rely on variables going to the data section.  E.g., so that the
4362 resulting executable can find the beginning of that section and/or make
4363 assumptions based on that.
4365 The default is @option{-fzero-initialized-in-bss}.
4367 @item -fbounds-check
4368 @opindex fbounds-check
4369 For front-ends that support it, generate additional code to check that
4370 indices used to access arrays are within the declared range.  This is
4371 currently only supported by the Java and Fortran front-ends, where
4372 this option defaults to true and false respectively.
4374 @item -fmudflap -fmudflapth -fmudflapir
4375 @opindex fmudflap
4376 @opindex fmudflapth
4377 @opindex fmudflapir
4378 @cindex bounds checking
4379 @cindex mudflap
4380 For front-ends that support it (C and C++), instrument all risky
4381 pointer/array dereferencing operations, some standard library
4382 string/heap functions, and some other associated constructs with
4383 range/validity tests.  Modules so instrumented should be immune to
4384 buffer overflows, invalid heap use, and some other classes of C/C++
4385 programming errors.  The instrumentation relies on a separate runtime
4386 library (@file{libmudflap}), which will be linked into a program if
4387 @option{-fmudflap} is given at link time.  Run-time behavior of the
4388 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4389 environment variable.  See @code{env MUDFLAP_OPTIONS=-help a.out}
4390 for its options.
4392 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4393 link if your program is multi-threaded.  Use @option{-fmudflapir}, in
4394 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4395 instrumentation should ignore pointer reads.  This produces less
4396 instrumentation (and therefore faster execution) and still provides
4397 some protection against outright memory corrupting writes, but allows
4398 erroneously read data to propagate within a program.
4400 @item -fstrength-reduce
4401 @opindex fstrength-reduce
4402 Perform the optimizations of loop strength reduction and
4403 elimination of iteration variables.
4405 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4407 @item -fthread-jumps
4408 @opindex fthread-jumps
4409 Perform optimizations where we check to see if a jump branches to a
4410 location where another comparison subsumed by the first is found.  If
4411 so, the first branch is redirected to either the destination of the
4412 second branch or a point immediately following it, depending on whether
4413 the condition is known to be true or false.
4415 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4417 @item -fcse-follow-jumps
4418 @opindex fcse-follow-jumps
4419 In common subexpression elimination, scan through jump instructions
4420 when the target of the jump is not reached by any other path.  For
4421 example, when CSE encounters an @code{if} statement with an
4422 @code{else} clause, CSE will follow the jump when the condition
4423 tested is false.
4425 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4427 @item -fcse-skip-blocks
4428 @opindex fcse-skip-blocks
4429 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4430 follow jumps which conditionally skip over blocks.  When CSE
4431 encounters a simple @code{if} statement with no else clause,
4432 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4433 body of the @code{if}.
4435 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4437 @item -frerun-cse-after-loop
4438 @opindex frerun-cse-after-loop
4439 Re-run common subexpression elimination after loop optimizations has been
4440 performed.
4442 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4444 @item -frerun-loop-opt
4445 @opindex frerun-loop-opt
4446 Run the loop optimizer twice.
4448 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4450 @item -fgcse
4451 @opindex fgcse
4452 Perform a global common subexpression elimination pass.
4453 This pass also performs global constant and copy propagation.
4455 @emph{Note:} When compiling a program using computed gotos, a GCC
4456 extension, you may get better runtime performance if you disable
4457 the global common subexpression elimination pass by adding
4458 @option{-fno-gcse} to the command line.
4460 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4462 @item -fgcse-lm
4463 @opindex fgcse-lm
4464 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4465 attempt to move loads which are only killed by stores into themselves.  This
4466 allows a loop containing a load/store sequence to be changed to a load outside
4467 the loop, and a copy/store within the loop.
4469 Enabled by default when gcse is enabled.
4471 @item -fgcse-sm
4472 @opindex fgcse-sm
4473 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4474 global common subexpression elimination.  This pass will attempt to move
4475 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
4476 loops containing a load/store sequence can be changed to a load before
4477 the loop and a store after the loop.
4479 Not enabled at any optimization level.
4481 @item -fgcse-las
4482 @opindex fgcse-las
4483 When @option{-fgcse-las} is enabled, the global common subexpression
4484 elimination pass eliminates redundant loads that come after stores to the
4485 same memory location (both partial and full redundancies).
4487 Not enabled at any optimization level.
4489 @item -fgcse-after-reload
4490 @opindex fgcse-after-reload
4491 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4492 pass is performed after reload.  The purpose of this pass is to cleanup
4493 redundant spilling.
4495 @item -floop-optimize
4496 @opindex floop-optimize
4497 Perform loop optimizations: move constant expressions out of loops, simplify
4498 exit test conditions and optionally do strength-reduction as well.
4500 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4502 @item -floop-optimize2
4503 @opindex floop-optimize2
4504 Perform loop optimizations using the new loop optimizer.  The optimizations
4505 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4506 by separate flags.
4508 @item -fcrossjumping
4509 @opindex crossjumping
4510 Perform cross-jumping transformation.  This transformation unifies equivalent code and save code size.  The
4511 resulting code may or may not perform better than without cross-jumping.
4513 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4515 @item -fif-conversion
4516 @opindex if-conversion
4517 Attempt to transform conditional jumps into branch-less equivalents.  This
4518 include use of conditional moves, min, max, set flags and abs instructions, and
4519 some tricks doable by standard arithmetics.  The use of conditional execution
4520 on chips where it is available is controlled by @code{if-conversion2}.
4522 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4524 @item -fif-conversion2
4525 @opindex if-conversion2
4526 Use conditional execution (where available) to transform conditional jumps into
4527 branch-less equivalents.
4529 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4531 @item -fdelete-null-pointer-checks
4532 @opindex fdelete-null-pointer-checks
4533 Use global dataflow analysis to identify and eliminate useless checks
4534 for null pointers.  The compiler assumes that dereferencing a null
4535 pointer would have halted the program.  If a pointer is checked after
4536 it has already been dereferenced, it cannot be null.
4538 In some environments, this assumption is not true, and programs can
4539 safely dereference null pointers.  Use
4540 @option{-fno-delete-null-pointer-checks} to disable this optimization
4541 for programs which depend on that behavior.
4543 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4545 @item -fexpensive-optimizations
4546 @opindex fexpensive-optimizations
4547 Perform a number of minor optimizations that are relatively expensive.
4549 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4551 @item -foptimize-register-move
4552 @itemx -fregmove
4553 @opindex foptimize-register-move
4554 @opindex fregmove
4555 Attempt to reassign register numbers in move instructions and as
4556 operands of other simple instructions in order to maximize the amount of
4557 register tying.  This is especially helpful on machines with two-operand
4558 instructions.
4560 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4561 optimization.
4563 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4565 @item -fdelayed-branch
4566 @opindex fdelayed-branch
4567 If supported for the target machine, attempt to reorder instructions
4568 to exploit instruction slots available after delayed branch
4569 instructions.
4571 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4573 @item -fschedule-insns
4574 @opindex fschedule-insns
4575 If supported for the target machine, attempt to reorder instructions to
4576 eliminate execution stalls due to required data being unavailable.  This
4577 helps machines that have slow floating point or memory load instructions
4578 by allowing other instructions to be issued until the result of the load
4579 or floating point instruction is required.
4581 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4583 @item -fschedule-insns2
4584 @opindex fschedule-insns2
4585 Similar to @option{-fschedule-insns}, but requests an additional pass of
4586 instruction scheduling after register allocation has been done.  This is
4587 especially useful on machines with a relatively small number of
4588 registers and where memory load instructions take more than one cycle.
4590 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4592 @item -fno-sched-interblock
4593 @opindex fno-sched-interblock
4594 Don't schedule instructions across basic blocks.  This is normally
4595 enabled by default when scheduling before register allocation, i.e.@:
4596 with @option{-fschedule-insns} or at @option{-O2} or higher.
4598 @item -fno-sched-spec
4599 @opindex fno-sched-spec
4600 Don't allow speculative motion of non-load instructions.  This is normally
4601 enabled by default when scheduling before register allocation, i.e.@:
4602 with @option{-fschedule-insns} or at @option{-O2} or higher.
4604 @item -fsched-spec-load
4605 @opindex fsched-spec-load
4606 Allow speculative motion of some load instructions.  This only makes
4607 sense when scheduling before register allocation, i.e.@: with
4608 @option{-fschedule-insns} or at @option{-O2} or higher.
4610 @item -fsched-spec-load-dangerous
4611 @opindex fsched-spec-load-dangerous
4612 Allow speculative motion of more load instructions.  This only makes
4613 sense when scheduling before register allocation, i.e.@: with
4614 @option{-fschedule-insns} or at @option{-O2} or higher.
4616 @item -fsched-stalled-insns=@var{n}
4617 @opindex fsched-stalled-insns
4618 Define how many insns (if any) can be moved prematurely from the queue
4619 of stalled insns into the ready list, during the second scheduling pass.
4621 @item -fsched-stalled-insns-dep=@var{n}
4622 @opindex fsched-stalled-insns-dep
4623 Define how many insn groups (cycles) will be examined for a dependency
4624 on a stalled insn that is candidate for premature removal from the queue
4625 of stalled insns.  Has an effect only during the second scheduling pass,
4626 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4628 @item -fsched2-use-superblocks
4629 @opindex fsched2-use-superblocks
4630 When scheduling after register allocation, do use superblock scheduling
4631 algorithm.  Superblock scheduling allows motion across basic block boundaries
4632 resulting on faster schedules.  This option is experimental, as not all machine
4633 descriptions used by GCC model the CPU closely enough to avoid unreliable
4634 results from the algorithm.
4636 This only makes sense when scheduling after register allocation, i.e.@: with
4637 @option{-fschedule-insns2} or at @option{-O2} or higher.
4639 @item -fsched2-use-traces
4640 @opindex fsched2-use-traces
4641 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4642 allocation and additionally perform code duplication in order to increase the
4643 size of superblocks using tracer pass.  See @option{-ftracer} for details on
4644 trace formation.
4646 This mode should produce faster but significantly longer programs.  Also
4647 without @option{-fbranch-probabilities} the traces constructed may not
4648 match the reality and hurt the performance.  This only makes
4649 sense when scheduling after register allocation, i.e.@: with
4650 @option{-fschedule-insns2} or at @option{-O2} or higher.
4652 @item -freschedule-modulo-scheduled-loops
4653 @opindex fscheduling-in-modulo-scheduled-loops
4654 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4655 we may want to prevent the later scheduling passes from changing its schedule, we use this
4656 option to control that.
4658 @item -fcaller-saves
4659 @opindex fcaller-saves
4660 Enable values to be allocated in registers that will be clobbered by
4661 function calls, by emitting extra instructions to save and restore the
4662 registers around such calls.  Such allocation is done only when it
4663 seems to result in better code than would otherwise be produced.
4665 This option is always enabled by default on certain machines, usually
4666 those which have no call-preserved registers to use instead.
4668 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4670 @item -ftree-pre
4671 Perform Partial Redundancy Elimination (PRE) on trees.  This flag is
4672 enabled by default at @option{-O2} and @option{-O3}.
4674 @item -ftree-fre
4675 Perform Full Redundancy Elimination (FRE) on trees.  The difference
4676 between FRE and PRE is that FRE only considers expressions
4677 that are computed on all paths leading to the redundant computation.
4678 This analysis faster than PRE, though it exposes fewer redundancies.
4679 This flag is enabled by default at @option{-O} and higher.
4681 @item -ftree-ccp
4682 Perform sparse conditional constant propagation (CCP) on trees.  This flag
4683 is enabled by default at @option{-O} and higher.
4685 @item -ftree-dce
4686 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4687 default at @option{-O} and higher.
4689 @item -ftree-dominator-opts
4690 Perform dead code elimination (DCE) on trees.  This flag is enabled by
4691 default at @option{-O} and higher.
4693 @item -ftree-ch
4694 Perform loop header copying on trees.  This is beneficial since it increases
4695 effectiveness of code motion optimizations.  It also saves one jump.  This flag
4696 is enabled by default at @option{-O} and higher.  It is not enabled
4697 for @option{-Os}, since it usually increases code size.
4699 @item -ftree-loop-optimize
4700 Perform loop optimizations on trees.  This flag is enabled by default
4701 at @option{-O} and higher.
4703 @item -ftree-loop-linear
4704 Perform linear loop transformations on tree.  This flag can improve cache
4705 performance and allow further loop optimizations to take place.
4707 @item -ftree-lim
4708 Perform loop invariant motion on trees.  This pass moves only invartiants that
4709 would be hard to handle on rtl level (function calls, operations that expand to
4710 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
4711 operands of conditions that are invariant out of the loop, so that we can use
4712 just trivial invariantness analysis in loop unswitching.  The pass also includes
4713 store motion.
4715 @item -fivcanon
4716 Create a canonical counter for number of iterations in the loop for that
4717 determining number of iterations requires complicated analysis.  Later
4718 optimizations then may determine the number easily.  Useful especially
4719 in connection with unrolling.
4721 @item -fivopts
4722 Perform induction variable optimizations (strength reduction, induction
4723 variable merging and induction variable elimination) on trees.
4725 @item -ftree-sra
4726 Perform scalar replacement of aggregates.  This pass replaces structure
4727 references with scalars to prevent committing structures to memory too
4728 early.  This flag is enabled by default at @option{-O} and higher.
4730 @item -ftree-copyrename
4731 Perform copy renaming on trees.  This pass attempts to rename compiler
4732 temporaries to other variables at copy locations, usually resulting in
4733 variable names which more closely resemble the original variables.  This flag
4734 is enabled by default at @option{-O} and higher.
4736 @item -ftree-ter
4737 Perform temporary expression replacement during the SSA->normal phase.  Single
4738 use/single def temporaries are replaced at their use location with their
4739 defining expression.  This results in non-GIMPLE code, but gives the expanders
4740 much more complex trees to work on resulting in better RTL generation.  This is
4741 enabled by default at @option{-O} and higher.
4743 @item -ftree-lrs
4744 Perform live range splitting during the SSA->normal phase.  Distinct live
4745 ranges of a variable are split into unique variables, allowing for better
4746 optimization later.  This is enabled by default at @option{-O} and higher.
4748 @item -ftree-vectorize
4749 Perform loop vectorization on trees.
4751 @item -ftracer
4752 @opindex ftracer
4753 Perform tail duplication to enlarge superblock size.  This transformation
4754 simplifies the control flow of the function allowing other optimizations to do
4755 better job.
4757 @item -funroll-loops
4758 @opindex funroll-loops
4759 Unroll loops whose number of iterations can be determined at compile
4760 time or upon entry to the loop.  @option{-funroll-loops} implies both
4761 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}.  This
4762 option makes code larger, and may or may not make it run faster.
4764 @item -funroll-all-loops
4765 @opindex funroll-all-loops
4766 Unroll all loops, even if their number of iterations is uncertain when
4767 the loop is entered.  This usually makes programs run more slowly.
4768 @option{-funroll-all-loops} implies the same options as
4769 @option{-funroll-loops},
4771 @item -fsplit-ivs-in-unroller
4772 @opindex -fsplit-ivs-in-unroller
4773 Enables expressing of values of induction variables in later iterations
4774 of the unrolled loop using the value in the first iteration.  This breaks
4775 long dependency chains, thus improving efficiency of the scheduling passes
4776 (for best results, @option{-fweb} should be used as well).
4778 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4779 same effect.  However in cases the loop body is more complicated than
4780 a single basic block, this is not reliable.  It also does not work at all
4781 on some of the architectures due to restrictions in the CSE pass.
4783 This optimization is enabled by default.
4785 @item -fvariable-expansion-in-unroller
4786 @opindex -fvariable-expansion-in-unroller
4787 With this option, the compiler will create multiple copies of some
4788 local variables when unrolling a loop which can result in superior code.
4790 @item -fprefetch-loop-arrays
4791 @opindex fprefetch-loop-arrays
4792 If supported by the target machine, generate instructions to prefetch
4793 memory to improve the performance of loops that access large arrays.
4795 These options may generate better or worse code; results are highly
4796 dependent on the structure of loops within the source code.
4798 @item -fno-peephole
4799 @itemx -fno-peephole2
4800 @opindex fno-peephole
4801 @opindex fno-peephole2
4802 Disable any machine-specific peephole optimizations.  The difference
4803 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4804 are implemented in the compiler; some targets use one, some use the
4805 other, a few use both.
4807 @option{-fpeephole} is enabled by default.
4808 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4810 @item -fno-guess-branch-probability
4811 @opindex fno-guess-branch-probability
4812 Do not guess branch probabilities using heuristics.
4814 GCC will use heuristics to guess branch probabilities if they are
4815 not provided by profiling feedback (@option{-fprofile-arcs}).  These
4816 heuristics are based on the control flow graph.  If some branch probabilities
4817 are specified by @samp{__builtin_expect}, then the heuristics will be
4818 used to guess branch probabilities for the rest of the control flow graph,
4819 taking the @samp{__builtin_expect} info into account.  The interactions
4820 between the heuristics and @samp{__builtin_expect} can be complex, and in
4821 some cases, it may be useful to disable the heuristics so that the effects
4822 of @samp{__builtin_expect} are easier to understand.
4824 The default is @option{-fguess-branch-probability} at levels
4825 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4827 @item -freorder-blocks
4828 @opindex freorder-blocks
4829 Reorder basic blocks in the compiled function in order to reduce number of
4830 taken branches and improve code locality.
4832 Enabled at levels @option{-O2}, @option{-O3}.
4834 @item -freorder-blocks-and-partition
4835 @opindex freorder-blocks-and-partition
4836 In addition to reordering basic blocks in the compiled function, in order
4837 to reduce number of taken branches, partitions hot and cold basic blocks
4838 into separate sections of the assembly and .o files, to improve
4839 paging and cache locality performance.
4841 This optimization is automatically turned off in the presence of
4842 exception handling, for linkonce sections, for functions with a user-defined
4843 section attribute and on any architecture that does not support named
4844 sections.
4846 @item -freorder-functions
4847 @opindex freorder-functions
4848 Reorder functions in the object file in order to
4849 improve code locality.  This is implemented by using special
4850 subsections @code{.text.hot} for most frequently executed functions and
4851 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
4852 the linker so object file format must support named sections and linker must
4853 place them in a reasonable way.
4855 Also profile feedback must be available in to make this option effective.  See
4856 @option{-fprofile-arcs} for details.
4858 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4860 @item -fstrict-aliasing
4861 @opindex fstrict-aliasing
4862 Allows the compiler to assume the strictest aliasing rules applicable to
4863 the language being compiled.  For C (and C++), this activates
4864 optimizations based on the type of expressions.  In particular, an
4865 object of one type is assumed never to reside at the same address as an
4866 object of a different type, unless the types are almost the same.  For
4867 example, an @code{unsigned int} can alias an @code{int}, but not a
4868 @code{void*} or a @code{double}.  A character type may alias any other
4869 type.
4871 Pay special attention to code like this:
4872 @smallexample
4873 union a_union @{
4874   int i;
4875   double d;
4878 int f() @{
4879   a_union t;
4880   t.d = 3.0;
4881   return t.i;
4883 @end smallexample
4884 The practice of reading from a different union member than the one most
4885 recently written to (called ``type-punning'') is common.  Even with
4886 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
4887 is accessed through the union type.  So, the code above will work as
4888 expected.  However, this code might not:
4889 @smallexample
4890 int f() @{
4891   a_union t;
4892   int* ip;
4893   t.d = 3.0;
4894   ip = &t.i;
4895   return *ip;
4897 @end smallexample
4899 Every language that wishes to perform language-specific alias analysis
4900 should define a function that computes, given an @code{tree}
4901 node, an alias set for the node.  Nodes in different alias sets are not
4902 allowed to alias.  For an example, see the C front-end function
4903 @code{c_get_alias_set}.
4905 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4907 @item -falign-functions
4908 @itemx -falign-functions=@var{n}
4909 @opindex falign-functions
4910 Align the start of functions to the next power-of-two greater than
4911 @var{n}, skipping up to @var{n} bytes.  For instance,
4912 @option{-falign-functions=32} aligns functions to the next 32-byte
4913 boundary, but @option{-falign-functions=24} would align to the next
4914 32-byte boundary only if this can be done by skipping 23 bytes or less.
4916 @option{-fno-align-functions} and @option{-falign-functions=1} are
4917 equivalent and mean that functions will not be aligned.
4919 Some assemblers only support this flag when @var{n} is a power of two;
4920 in that case, it is rounded up.
4922 If @var{n} is not specified or is zero, use a machine-dependent default.
4924 Enabled at levels @option{-O2}, @option{-O3}.
4926 @item -falign-labels
4927 @itemx -falign-labels=@var{n}
4928 @opindex falign-labels
4929 Align all branch targets to a power-of-two boundary, skipping up to
4930 @var{n} bytes like @option{-falign-functions}.  This option can easily
4931 make code slower, because it must insert dummy operations for when the
4932 branch target is reached in the usual flow of the code.
4934 @option{-fno-align-labels} and @option{-falign-labels=1} are
4935 equivalent and mean that labels will not be aligned.
4937 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
4938 are greater than this value, then their values are used instead.
4940 If @var{n} is not specified or is zero, use a machine-dependent default
4941 which is very likely to be @samp{1}, meaning no alignment.
4943 Enabled at levels @option{-O2}, @option{-O3}.
4945 @item -falign-loops
4946 @itemx -falign-loops=@var{n}
4947 @opindex falign-loops
4948 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
4949 like @option{-falign-functions}.  The hope is that the loop will be
4950 executed many times, which will make up for any execution of the dummy
4951 operations.
4953 @option{-fno-align-loops} and @option{-falign-loops=1} are
4954 equivalent and mean that loops will not be aligned.
4956 If @var{n} is not specified or is zero, use a machine-dependent default.
4958 Enabled at levels @option{-O2}, @option{-O3}.
4960 @item -falign-jumps
4961 @itemx -falign-jumps=@var{n}
4962 @opindex falign-jumps
4963 Align branch targets to a power-of-two boundary, for branch targets
4964 where the targets can only be reached by jumping, skipping up to @var{n}
4965 bytes like @option{-falign-functions}.  In this case, no dummy operations
4966 need be executed.
4968 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
4969 equivalent and mean that loops will not be aligned.
4971 If @var{n} is not specified or is zero, use a machine-dependent default.
4973 Enabled at levels @option{-O2}, @option{-O3}.
4975 @item -funit-at-a-time
4976 @opindex funit-at-a-time
4977 Parse the whole compilation unit before starting to produce code.
4978 This allows some extra optimizations to take place but consumes
4979 more memory (in general).  There are some compatibility issues
4980 with @emph{unit-at-at-time} mode:
4981 @itemize @bullet
4982 @item
4983 enabling @emph{unit-at-a-time} mode may change the order
4984 in which functions, variables, and top-level @code{asm} statements
4985 are emitted, and will likely break code relying on some particular
4986 ordering.  The majority of such top-level @code{asm} statements,
4987 though, can be replaced by @code{section} attributes.
4989 @item
4990 @emph{unit-at-a-time} mode removes unreferenced static variables
4991 and functions are removed.  This may result in undefined references
4992 when an @code{asm} statement refers directly to variables or functions
4993 that are otherwise unused.  In that case either the variable/function
4994 shall be listed as an operand of the @code{asm} statement operand or,
4995 in the case of top-level @code{asm} statements the attribute @code{used}
4996 shall be used on the declaration.
4998 @item
4999 Static functions now can use non-standard passing conventions that
5000 may break @code{asm} statements calling functions directly.  Again,
5001 attribute @code{used} will prevent this behavior.
5002 @end itemize
5004 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5005 but this scheme may not be supported by future releases of GCC@.
5007 Enabled at levels @option{-O2}, @option{-O3}.
5009 @item -fweb
5010 @opindex fweb
5011 Constructs webs as commonly used for register allocation purposes and assign
5012 each web individual pseudo register.  This allows the register allocation pass
5013 to operate on pseudos directly, but also strengthens several other optimization
5014 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
5015 however, make debugging impossible, since variables will no longer stay in a
5016 ``home register''.
5018 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5019 on targets where the default format for debugging information supports
5020 variable tracking.
5022 @item -fno-cprop-registers
5023 @opindex fno-cprop-registers
5024 After register allocation and post-register allocation instruction splitting,
5025 we perform a copy-propagation pass to try to reduce scheduling dependencies
5026 and occasionally eliminate the copy.
5028 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5030 @item -fprofile-generate
5031 @opindex fprofile-generate
5033 Enable options usually used for instrumenting application to produce
5034 profile useful for later recompilation with profile feedback based
5035 optimization.  You must use @option{-fprofile-generate} both when
5036 compiling and when linking your program.
5038 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5040 @item -fprofile-use
5041 @opindex fprofile-use
5042 Enable profile feedback directed optimizations, and optimizations
5043 generally profitable only with profile feedback available.
5045 The following options are enabled: @code{-fbranch-probabilities},
5046 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5048 @end table
5050 The following options control compiler behavior regarding floating
5051 point arithmetic.  These options trade off between speed and
5052 correctness.  All must be specifically enabled.
5054 @table @gcctabopt
5055 @item -ffloat-store
5056 @opindex ffloat-store
5057 Do not store floating point variables in registers, and inhibit other
5058 options that might change whether a floating point value is taken from a
5059 register or memory.
5061 @cindex floating point precision
5062 This option prevents undesirable excess precision on machines such as
5063 the 68000 where the floating registers (of the 68881) keep more
5064 precision than a @code{double} is supposed to have.  Similarly for the
5065 x86 architecture.  For most programs, the excess precision does only
5066 good, but a few programs rely on the precise definition of IEEE floating
5067 point.  Use @option{-ffloat-store} for such programs, after modifying
5068 them to store all pertinent intermediate computations into variables.
5070 @item -ffast-math
5071 @opindex ffast-math
5072 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5073 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5074 @option{-fno-rounding-math} and @option{-fno-signaling-nans}.
5076 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5078 This option should never be turned on by any @option{-O} option since
5079 it can result in incorrect output for programs which depend on
5080 an exact implementation of IEEE or ISO rules/specifications for
5081 math functions.
5083 @item -fno-math-errno
5084 @opindex fno-math-errno
5085 Do not set ERRNO after calling math functions that are executed
5086 with a single instruction, e.g., sqrt.  A program that relies on
5087 IEEE exceptions for math error handling may want to use this flag
5088 for speed while maintaining IEEE arithmetic compatibility.
5090 This option should never be turned on by any @option{-O} option since
5091 it can result in incorrect output for programs which depend on
5092 an exact implementation of IEEE or ISO rules/specifications for
5093 math functions.
5095 The default is @option{-fmath-errno}.
5097 @item -funsafe-math-optimizations
5098 @opindex funsafe-math-optimizations
5099 Allow optimizations for floating-point arithmetic that (a) assume
5100 that arguments and results are valid and (b) may violate IEEE or
5101 ANSI standards.  When used at link-time, it may include libraries
5102 or startup files that change the default FPU control word or other
5103 similar optimizations.
5105 This option should never be turned on by any @option{-O} option since
5106 it can result in incorrect output for programs which depend on
5107 an exact implementation of IEEE or ISO rules/specifications for
5108 math functions.
5110 The default is @option{-fno-unsafe-math-optimizations}.
5112 @item -ffinite-math-only
5113 @opindex ffinite-math-only
5114 Allow optimizations for floating-point arithmetic that assume
5115 that arguments and results are not NaNs or +-Infs.
5117 This option should never be turned on by any @option{-O} option since
5118 it can result in incorrect output for programs which depend on
5119 an exact implementation of IEEE or ISO rules/specifications.
5121 The default is @option{-fno-finite-math-only}.
5123 @item -fno-trapping-math
5124 @opindex fno-trapping-math
5125 Compile code assuming that floating-point operations cannot generate
5126 user-visible traps.  These traps include division by zero, overflow,
5127 underflow, inexact result and invalid operation.  This option implies
5128 @option{-fno-signaling-nans}.  Setting this option may allow faster
5129 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5131 This option should never be turned on by any @option{-O} option since
5132 it can result in incorrect output for programs which depend on
5133 an exact implementation of IEEE or ISO rules/specifications for
5134 math functions.
5136 The default is @option{-ftrapping-math}.
5138 @item -frounding-math
5139 @opindex frounding-math
5140 Disable transformations and optimizations that assume default floating
5141 point rounding behavior.  This is round-to-zero for all floating point
5142 to integer conversions, and round-to-nearest for all other arithmetic
5143 truncations.  This option should be specified for programs that change
5144 the FP rounding mode dynamically, or that may be executed with a
5145 non-default rounding mode.  This option disables constant folding of
5146 floating point expressions at compile-time (which may be affected by
5147 rounding mode) and arithmetic transformations that are unsafe in the
5148 presence of sign-dependent rounding modes.
5150 The default is @option{-fno-rounding-math}.
5152 This option is experimental and does not currently guarantee to
5153 disable all GCC optimizations that are affected by rounding mode.
5154 Future versions of GCC may provide finer control of this setting
5155 using C99's @code{FENV_ACCESS} pragma.  This command line option
5156 will be used to specify the default state for @code{FENV_ACCESS}.
5158 @item -fsignaling-nans
5159 @opindex fsignaling-nans
5160 Compile code assuming that IEEE signaling NaNs may generate user-visible
5161 traps during floating-point operations.  Setting this option disables
5162 optimizations that may change the number of exceptions visible with
5163 signaling NaNs.  This option implies @option{-ftrapping-math}.
5165 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5166 be defined.
5168 The default is @option{-fno-signaling-nans}.
5170 This option is experimental and does not currently guarantee to
5171 disable all GCC optimizations that affect signaling NaN behavior.
5173 @item -fsingle-precision-constant
5174 @opindex fsingle-precision-constant
5175 Treat floating point constant as single precision constant instead of
5176 implicitly converting it to double precision constant.
5179 @end table
5181 The following options control optimizations that may improve
5182 performance, but are not enabled by any @option{-O} options.  This
5183 section includes experimental options that may produce broken code.
5185 @table @gcctabopt
5186 @item -fbranch-probabilities
5187 @opindex fbranch-probabilities
5188 After running a program compiled with @option{-fprofile-arcs}
5189 (@pxref{Debugging Options,, Options for Debugging Your Program or
5190 @command{gcc}}), you can compile it a second time using
5191 @option{-fbranch-probabilities}, to improve optimizations based on
5192 the number of times each branch was taken.  When the program
5193 compiled with @option{-fprofile-arcs} exits it saves arc execution
5194 counts to a file called @file{@var{sourcename}.gcda} for each source
5195 file  The information in this data file is very dependent on the
5196 structure of the generated code, so you must use the same source code
5197 and the same optimization options for both compilations.
5199 With @option{-fbranch-probabilities}, GCC puts a
5200 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5201 These can be used to improve optimization.  Currently, they are only
5202 used in one place: in @file{reorg.c}, instead of guessing which path a
5203 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5204 exactly determine which path is taken more often.
5206 @item -fprofile-values
5207 @opindex fprofile-values
5208 If combined with @option{-fprofile-arcs}, it adds code so that some
5209 data about values of expressions in the program is gathered.
5211 With @option{-fbranch-probabilities}, it reads back the data gathered
5212 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5213 notes to instructions for their later usage in optimizations.
5215 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5217 @item -fvpt
5218 @opindex fvpt
5219 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5220 a code to gather information about values of expressions.
5222 With @option{-fbranch-probabilities}, it reads back the data gathered
5223 and actually performs the optimizations based on them.
5224 Currently the optimizations include specialization of division operation
5225 using the knowledge about the value of the denominator.
5227 @item -fspeculative-prefetching
5228 @opindex fspeculative-prefetching
5229 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5230 a code to gather information about addresses of memory references in the
5231 program.
5233 With @option{-fbranch-probabilities}, it reads back the data gathered
5234 and issues prefetch instructions according to them.  In addition to the opportunities
5235 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5236 memory access patterns---for example accesses to the data stored in linked
5237 list whose elements are usually allocated sequentially.
5239 In order to prevent issuing double prefetches, usage of
5240 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5242 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5244 @item -frename-registers
5245 @opindex frename-registers
5246 Attempt to avoid false dependencies in scheduled code by making use
5247 of registers left over after register allocation.  This optimization
5248 will most benefit processors with lots of registers.  Depending on the
5249 debug information format adopted by the target, however, it can
5250 make debugging impossible, since variables will no longer stay in
5251 a ``home register''.
5253 Not enabled by default at any level because it has known bugs.
5255 @item -ftracer
5256 @opindex ftracer
5257 Perform tail duplication to enlarge superblock size.  This transformation
5258 simplifies the control flow of the function allowing other optimizations to do
5259 better job.
5261 Enabled with @option{-fprofile-use}.
5263 @item -funroll-loops
5264 @opindex funroll-loops
5265 Unroll loops whose number of iterations can be determined at compile time or
5266 upon entry to the loop.  @option{-funroll-loops} implies
5267 @option{-frerun-cse-after-loop}.  It also turns on complete loop peeling
5268 (i.e.@: complete removal of loops with small constant number of iterations).
5269 This option makes code larger, and may or may not make it run faster.
5271 Enabled with @option{-fprofile-use}.
5273 @item -funroll-all-loops
5274 @opindex funroll-all-loops
5275 Unroll all loops, even if their number of iterations is uncertain when
5276 the loop is entered.  This usually makes programs run more slowly.
5277 @option{-funroll-all-loops} implies the same options as
5278 @option{-funroll-loops}.
5280 @item -fpeel-loops
5281 @opindex fpeel-loops
5282 Peels the loops for that there is enough information that they do not
5283 roll much (from profile feedback).  It also turns on complete loop peeling
5284 (i.e.@: complete removal of loops with small constant number of iterations).
5286 Enabled with @option{-fprofile-use}.
5288 @item -fmove-loop-invariants
5289 @opindex fmove-loop-invariants
5290 Enables the loop invariant motion pass in the new loop optimizer.  Enabled
5291 at level @option{-O1}
5293 @item -funswitch-loops
5294 @opindex funswitch-loops
5295 Move branches with loop invariant conditions out of the loop, with duplicates
5296 of the loop on both branches (modified according to result of the condition).
5298 @item -fprefetch-loop-arrays
5299 @opindex fprefetch-loop-arrays
5300 If supported by the target machine, generate instructions to prefetch
5301 memory to improve the performance of loops that access large arrays.
5303 Disabled at level @option{-Os}.
5305 @item -ffunction-sections
5306 @itemx -fdata-sections
5307 @opindex ffunction-sections
5308 @opindex fdata-sections
5309 Place each function or data item into its own section in the output
5310 file if the target supports arbitrary sections.  The name of the
5311 function or the name of the data item determines the section's name
5312 in the output file.
5314 Use these options on systems where the linker can perform optimizations
5315 to improve locality of reference in the instruction space.  Most systems
5316 using the ELF object format and SPARC processors running Solaris 2 have
5317 linkers with such optimizations.  AIX may have these optimizations in
5318 the future.
5320 Only use these options when there are significant benefits from doing
5321 so.  When you specify these options, the assembler and linker will
5322 create larger object and executable files and will also be slower.
5323 You will not be able to use @code{gprof} on all systems if you
5324 specify this option and you may have problems with debugging if
5325 you specify both this option and @option{-g}.
5327 @item -fbranch-target-load-optimize
5328 @opindex fbranch-target-load-optimize
5329 Perform branch target register load optimization before prologue / epilogue
5330 threading.
5331 The use of target registers can typically be exposed only during reload,
5332 thus hoisting loads out of loops and doing inter-block scheduling needs
5333 a separate optimization pass.
5335 @item -fbranch-target-load-optimize2
5336 @opindex fbranch-target-load-optimize2
5337 Perform branch target register load optimization after prologue / epilogue
5338 threading.
5340 @item -fbtr-bb-exclusive
5341 @opindex fbtr-bb-exclusive
5342 When performing branch target register load optimization, don't reuse
5343 branch target registers in within any basic block.
5345 @item --param @var{name}=@var{value}
5346 @opindex param
5347 In some places, GCC uses various constants to control the amount of
5348 optimization that is done.  For example, GCC will not inline functions
5349 that contain more that a certain number of instructions.  You can
5350 control some of these constants on the command-line using the
5351 @option{--param} option.
5353 The names of specific parameters, and the meaning of the values, are
5354 tied to the internals of the compiler, and are subject to change
5355 without notice in future releases.
5357 In each case, the @var{value} is an integer.  The allowable choices for
5358 @var{name} are given in the following table:
5360 @table @gcctabopt
5361 @item sra-max-structure-size
5362 The maximum structure size, in bytes, at which the scalar replacement
5363 of aggregates (SRA) optimization will perform block copies.  The
5364 default value, 0, implies that GCC will select the most appropriate
5365 size itself.
5367 @item sra-field-structure-ratio
5368 The threshold ratio (as a percentage) between instantiated fields and
5369 the complete structure size.  We say that if the ratio of the number
5370 of bytes in instantiated fields to the number of bytes in the complete
5371 structure exceeds this parameter, then block copies are not used.  The
5372 default is 75.
5374 @item max-crossjump-edges
5375 The maximum number of incoming edges to consider for crossjumping.
5376 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5377 the number of edges incoming to each block.  Increasing values mean
5378 more aggressive optimization, making the compile time increase with
5379 probably small improvement in executable size.
5381 @item min-crossjump-insns
5382 The minimum number of instructions which must be matched at the end
5383 of two blocks before crossjumping will be performed on them.  This
5384 value is ignored in the case where all instructions in the block being
5385 crossjumped from are matched.  The default value is 5.
5387 @item max-goto-duplication-insns
5388 The maximum number of instructions to duplicate to a block that jumps
5389 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
5390 passes, GCC factors computed gotos early in the compilation process,
5391 and unfactors them as late as possible.  Only computed jumps at the
5392 end of a basic blocks with no more than max-goto-duplication-insns are
5393 unfactored.  The default value is 8.
5395 @item max-delay-slot-insn-search
5396 The maximum number of instructions to consider when looking for an
5397 instruction to fill a delay slot.  If more than this arbitrary number of
5398 instructions is searched, the time savings from filling the delay slot
5399 will be minimal so stop searching.  Increasing values mean more
5400 aggressive optimization, making the compile time increase with probably
5401 small improvement in executable run time.
5403 @item max-delay-slot-live-search
5404 When trying to fill delay slots, the maximum number of instructions to
5405 consider when searching for a block with valid live register
5406 information.  Increasing this arbitrarily chosen value means more
5407 aggressive optimization, increasing the compile time.  This parameter
5408 should be removed when the delay slot code is rewritten to maintain the
5409 control-flow graph.
5411 @item max-gcse-memory
5412 The approximate maximum amount of memory that will be allocated in
5413 order to perform the global common subexpression elimination
5414 optimization.  If more memory than specified is required, the
5415 optimization will not be done.
5417 @item max-gcse-passes
5418 The maximum number of passes of GCSE to run.  The default is 1.
5420 @item max-pending-list-length
5421 The maximum number of pending dependencies scheduling will allow
5422 before flushing the current state and starting over.  Large functions
5423 with few branches or calls can create excessively large lists which
5424 needlessly consume memory and resources.
5426 @item max-inline-insns-single
5427 Several parameters control the tree inliner used in gcc.
5428 This number sets the maximum number of instructions (counted in GCC's
5429 internal representation) in a single function that the tree inliner
5430 will consider for inlining.  This only affects functions declared
5431 inline and methods implemented in a class declaration (C++).
5432 The default value is 500.
5434 @item max-inline-insns-auto
5435 When you use @option{-finline-functions} (included in @option{-O3}),
5436 a lot of functions that would otherwise not be considered for inlining
5437 by the compiler will be investigated.  To those functions, a different
5438 (more restrictive) limit compared to functions declared inline can
5439 be applied.
5440 The default value is 120.
5442 @item large-function-insns
5443 The limit specifying really large functions.  For functions larger than this
5444 limit after inlining inlining is constrained by
5445 @option{--param large-function-growth}.  This parameter is useful primarily
5446 to avoid extreme compilation time caused by non-linear algorithms used by the
5447 backend.
5448 This parameter is ignored when @option{-funit-at-a-time} is not used.
5449 The default value is 3000.
5451 @item large-function-growth
5452 Specifies maximal growth of large function caused by inlining in percents.
5453 This parameter is ignored when @option{-funit-at-a-time} is not used.
5454 The default value is 100 which limits large function growth to 2.0 times
5455 the original size.
5457 @item inline-unit-growth
5458 Specifies maximal overall growth of the compilation unit caused by inlining.
5459 This parameter is ignored when @option{-funit-at-a-time} is not used.
5460 The default value is 50 which limits unit growth to 1.5 times the original
5461 size.
5463 @item max-inline-insns-recursive
5464 @itemx max-inline-insns-recursive-auto
5465 Specifies maximum number of instructions out-of-line copy of self recursive inline
5466 function can grow into by performing recursive inlining.
5468 For functions declared inline @option{--param max-inline-insns-recursive} is
5469 taken into acount.  For function not declared inline, recursive inlining
5470 happens only when @option{-finline-functions} (included in @option{-O3}) is
5471 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
5472 default value is 500.
5474 @item max-inline-recursive-depth
5475 @itemx max-inline-recursive-depth-auto
5476 Specifies maximum recursion depth used by the recursive inlining.
5478 For functions declared inline @option{--param max-inline-recursive-depth} is
5479 taken into acount.  For function not declared inline, recursive inlining
5480 happens only when @option{-finline-functions} (included in @option{-O3}) is
5481 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
5482 default value is 500.
5484 @item max-unrolled-insns
5485 The maximum number of instructions that a loop should have if that loop
5486 is unrolled, and if the loop is unrolled, it determines how many times
5487 the loop code is unrolled.
5489 @item max-average-unrolled-insns
5490 The maximum number of instructions biased by probabilities of their execution
5491 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5492 it determines how many times the loop code is unrolled.
5494 @item max-unroll-times
5495 The maximum number of unrollings of a single loop.
5497 @item max-peeled-insns
5498 The maximum number of instructions that a loop should have if that loop
5499 is peeled, and if the loop is peeled, it determines how many times
5500 the loop code is peeled.
5502 @item max-peel-times
5503 The maximum number of peelings of a single loop.
5505 @item max-completely-peeled-insns
5506 The maximum number of insns of a completely peeled loop.
5508 @item max-completely-peel-times
5509 The maximum number of iterations of a loop to be suitable for complete peeling.
5511 @item max-unswitch-insns
5512 The maximum number of insns of an unswitched loop.
5514 @item max-unswitch-level
5515 The maximum number of branches unswitched in a single loop.
5517 @item lim-expensive
5518 The minimum cost of an expensive expression in the loop invariant motion.
5520 @item iv-consider-all-candidates-bound
5521 Bound on number of candidates for induction variables below that
5522 all candidates are considered for each use in induction variable
5523 optimizations.  Only the most relevant candidates are considered
5524 if there are more candidates, to avoid quadratic time complexity.
5526 @item iv-max-considered-uses
5527 The induction variable optimizations give up on loops that contain more
5528 induction variable uses.
5530 @item iv-always-prune-cand-set-bound
5531 If number of candidates in the set is smaller than this value,
5532 we always try to remove unnecessary ivs from the set during its
5533 optimization when a new iv is added to the set.
5535 @item max-iterations-to-track
5537 The maximum number of iterations of a loop the brute force algorithm
5538 for analysis of # of iterations of the loop tries to evaluate.
5540 @item hot-bb-count-fraction
5541 Select fraction of the maximal count of repetitions of basic block in program
5542 given basic block needs to have to be considered hot.
5544 @item hot-bb-frequency-fraction
5545 Select fraction of the maximal frequency of executions of basic block in
5546 function given basic block needs to have to be considered hot
5548 @item tracer-dynamic-coverage
5549 @itemx tracer-dynamic-coverage-feedback
5551 This value is used to limit superblock formation once the given percentage of
5552 executed instructions is covered.  This limits unnecessary code size
5553 expansion.
5555 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5556 feedback is available.  The real profiles (as opposed to statically estimated
5557 ones) are much less balanced allowing the threshold to be larger value.
5559 @item tracer-max-code-growth
5560 Stop tail duplication once code growth has reached given percentage.  This is
5561 rather hokey argument, as most of the duplicates will be eliminated later in
5562 cross jumping, so it may be set to much higher values than is the desired code
5563 growth.
5565 @item tracer-min-branch-ratio
5567 Stop reverse growth when the reverse probability of best edge is less than this
5568 threshold (in percent).
5570 @item tracer-min-branch-ratio
5571 @itemx tracer-min-branch-ratio-feedback
5573 Stop forward growth if the best edge do have probability lower than this
5574 threshold.
5576 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5577 compilation for profile feedback and one for compilation without.  The value
5578 for compilation with profile feedback needs to be more conservative (higher) in
5579 order to make tracer effective.
5581 @item max-cse-path-length
5583 Maximum number of basic blocks on path that cse considers.  The default is 10.
5585 @item global-var-threshold
5587 Counts the number of function calls (@var{n}) and the number of
5588 call-clobbered variables (@var{v}).  If @var{n}x@var{v} is larger than this limit, a
5589 single artificial variable will be created to represent all the
5590 call-clobbered variables at function call sites.  This artificial
5591 variable will then be made to alias every call-clobbered variable.
5592 (done as @code{int * size_t} on the host machine; beware overflow).
5594 @item max-aliased-vops
5596 Maximum number of virtual operands allowed to represent aliases
5597 before triggering the alias grouping heuristic.  Alias grouping
5598 reduces compile times and memory consumption needed for aliasing at
5599 the expense of precision loss in alias information.
5601 @item ggc-min-expand
5603 GCC uses a garbage collector to manage its own memory allocation.  This
5604 parameter specifies the minimum percentage by which the garbage
5605 collector's heap should be allowed to expand between collections.
5606 Tuning this may improve compilation speed; it has no effect on code
5607 generation.
5609 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5610 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of "RAM" is
5611 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
5612 GCC is not able to calculate RAM on a particular platform, the lower
5613 bound of 30% is used.  Setting this parameter and
5614 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5615 every opportunity.  This is extremely slow, but can be useful for
5616 debugging.
5618 @item ggc-min-heapsize
5620 Minimum size of the garbage collector's heap before it begins bothering
5621 to collect garbage.  The first collection occurs after the heap expands
5622 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
5623 tuning this may improve compilation speed, and has no effect on code
5624 generation.
5626 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5627 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5628 with a lower bound of 4096 (four megabytes) and an upper bound of
5629 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
5630 particular platform, the lower bound is used.  Setting this parameter
5631 very large effectively disables garbage collection.  Setting this
5632 parameter and @option{ggc-min-expand} to zero causes a full collection
5633 to occur at every opportunity.
5635 @item max-reload-search-insns
5636 The maximum number of instruction reload should look backward for equivalent
5637 register.  Increasing values mean more aggressive optimization, making the
5638 compile time increase with probably slightly better performance.  The default
5639 value is 100.
5641 @item max-cselib-memory-location
5642 The maximum number of memory locations cselib should take into acount.
5643 Increasing values mean more aggressive optimization, making the compile time
5644 increase with probably slightly better performance.  The default value is 500.
5646 @item reorder-blocks-duplicate
5647 @itemx reorder-blocks-duplicate-feedback
5649 Used by basic block reordering pass to decide whether to use unconditional
5650 branch or duplicate the code on its destination.  Code is duplicated when its
5651 estimated size is smaller than this value multiplied by the estimated size of
5652 unconditional jump in the hot spots of the program.
5654 The @option{reorder-block-duplicate-feedback} is used only when profile
5655 feedback is available and may be set to higher values than
5656 @option{reorder-block-duplicate} since information about the hot spots is more
5657 accurate.
5659 @item max-sched-region-blocks
5660 The maximum number of blocks in a region to be considered for
5661 interblock scheduling.  The default value is 10.
5663 @item max-sched-region-insns
5664 The maximum number of insns in a region to be considered for
5665 interblock scheduling.  The default value is 100.
5667 @item max-last-value-rtl
5669 The maximum size measured as number of RTLs that can be recorded in an expression
5670 in combiner for a pseudo register as last known value of that register.  The default
5671 is 10000.
5673 @item integer-share-limit
5674 Small integer constants can use a shared data structure, reducing the
5675 compiler's memory usage and increasing its speed.  This sets the maximum
5676 value of a shared integer constant's.  The default value is 256.
5678 @end table
5679 @end table
5681 @node Preprocessor Options
5682 @section Options Controlling the Preprocessor
5683 @cindex preprocessor options
5684 @cindex options, preprocessor
5686 These options control the C preprocessor, which is run on each C source
5687 file before actual compilation.
5689 If you use the @option{-E} option, nothing is done except preprocessing.
5690 Some of these options make sense only together with @option{-E} because
5691 they cause the preprocessor output to be unsuitable for actual
5692 compilation.
5694 @table @gcctabopt
5695 @opindex Wp
5696 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5697 and pass @var{option} directly through to the preprocessor.  If
5698 @var{option} contains commas, it is split into multiple options at the
5699 commas.  However, many options are modified, translated or interpreted
5700 by the compiler driver before being passed to the preprocessor, and
5701 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
5702 interface is undocumented and subject to change, so whenever possible
5703 you should avoid using @option{-Wp} and let the driver handle the
5704 options instead.
5706 @item -Xpreprocessor @var{option}
5707 @opindex preprocessor
5708 Pass @var{option} as an option to the preprocessor.  You can use this to
5709 supply system-specific preprocessor options which GCC does not know how to
5710 recognize.
5712 If you want to pass an option that takes an argument, you must use
5713 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5714 @end table
5716 @include cppopts.texi
5718 @node Assembler Options
5719 @section Passing Options to the Assembler
5721 @c prevent bad page break with this line
5722 You can pass options to the assembler.
5724 @table @gcctabopt
5725 @item -Wa,@var{option}
5726 @opindex Wa
5727 Pass @var{option} as an option to the assembler.  If @var{option}
5728 contains commas, it is split into multiple options at the commas.
5730 @item -Xassembler @var{option}
5731 @opindex Xassembler
5732 Pass @var{option} as an option to the assembler.  You can use this to
5733 supply system-specific assembler options which GCC does not know how to
5734 recognize.
5736 If you want to pass an option that takes an argument, you must use
5737 @option{-Xassembler} twice, once for the option and once for the argument.
5739 @end table
5741 @node Link Options
5742 @section Options for Linking
5743 @cindex link options
5744 @cindex options, linking
5746 These options come into play when the compiler links object files into
5747 an executable output file.  They are meaningless if the compiler is
5748 not doing a link step.
5750 @table @gcctabopt
5751 @cindex file names
5752 @item @var{object-file-name}
5753 A file name that does not end in a special recognized suffix is
5754 considered to name an object file or library.  (Object files are
5755 distinguished from libraries by the linker according to the file
5756 contents.)  If linking is done, these object files are used as input
5757 to the linker.
5759 @item -c
5760 @itemx -S
5761 @itemx -E
5762 @opindex c
5763 @opindex S
5764 @opindex E
5765 If any of these options is used, then the linker is not run, and
5766 object file names should not be used as arguments.  @xref{Overall
5767 Options}.
5769 @cindex Libraries
5770 @item -l@var{library}
5771 @itemx -l @var{library}
5772 @opindex l
5773 Search the library named @var{library} when linking.  (The second
5774 alternative with the library as a separate argument is only for
5775 POSIX compliance and is not recommended.)
5777 It makes a difference where in the command you write this option; the
5778 linker searches and processes libraries and object files in the order they
5779 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5780 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
5781 to functions in @samp{z}, those functions may not be loaded.
5783 The linker searches a standard list of directories for the library,
5784 which is actually a file named @file{lib@var{library}.a}.  The linker
5785 then uses this file as if it had been specified precisely by name.
5787 The directories searched include several standard system directories
5788 plus any that you specify with @option{-L}.
5790 Normally the files found this way are library files---archive files
5791 whose members are object files.  The linker handles an archive file by
5792 scanning through it for members which define symbols that have so far
5793 been referenced but not defined.  But if the file that is found is an
5794 ordinary object file, it is linked in the usual fashion.  The only
5795 difference between using an @option{-l} option and specifying a file name
5796 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5797 and searches several directories.
5799 @item -lobjc
5800 @opindex lobjc
5801 You need this special case of the @option{-l} option in order to
5802 link an Objective-C or Objective-C++ program.
5804 @item -nostartfiles
5805 @opindex nostartfiles
5806 Do not use the standard system startup files when linking.
5807 The standard system libraries are used normally, unless @option{-nostdlib}
5808 or @option{-nodefaultlibs} is used.
5810 @item -nodefaultlibs
5811 @opindex nodefaultlibs
5812 Do not use the standard system libraries when linking.
5813 Only the libraries you specify will be passed to the linker.
5814 The standard startup files are used normally, unless @option{-nostartfiles}
5815 is used.  The compiler may generate calls to @code{memcmp},
5816 @code{memset}, @code{memcpy} and @code{memmove}.
5817 These entries are usually resolved by entries in
5818 libc.  These entry points should be supplied through some other
5819 mechanism when this option is specified.
5821 @item -nostdlib
5822 @opindex nostdlib
5823 Do not use the standard system startup files or libraries when linking.
5824 No startup files and only the libraries you specify will be passed to
5825 the linker.  The compiler may generate calls to @code{memcmp}, @code{memset},
5826 @code{memcpy} and @code{memmove}.
5827 These entries are usually resolved by entries in
5828 libc.  These entry points should be supplied through some other
5829 mechanism when this option is specified.
5831 @cindex @option{-lgcc}, use with @option{-nostdlib}
5832 @cindex @option{-nostdlib} and unresolved references
5833 @cindex unresolved references and @option{-nostdlib}
5834 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5835 @cindex @option{-nodefaultlibs} and unresolved references
5836 @cindex unresolved references and @option{-nodefaultlibs}
5837 One of the standard libraries bypassed by @option{-nostdlib} and
5838 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
5839 that GCC uses to overcome shortcomings of particular machines, or special
5840 needs for some languages.
5841 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
5842 Collection (GCC) Internals},
5843 for more discussion of @file{libgcc.a}.)
5844 In most cases, you need @file{libgcc.a} even when you want to avoid
5845 other standard libraries.  In other words, when you specify @option{-nostdlib}
5846 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
5847 This ensures that you have no unresolved references to internal GCC
5848 library subroutines.  (For example, @samp{__main}, used to ensure C++
5849 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
5850 GNU Compiler Collection (GCC) Internals}.)
5852 @item -pie
5853 @opindex pie
5854 Produce a position independent executable on targets which support it.
5855 For predictable results, you must also specify the same set of options
5856 that were used to generate code (@option{-fpie}, @option{-fPIE},
5857 or model suboptions) when you specify this option.
5859 @item -s
5860 @opindex s
5861 Remove all symbol table and relocation information from the executable.
5863 @item -static
5864 @opindex static
5865 On systems that support dynamic linking, this prevents linking with the shared
5866 libraries.  On other systems, this option has no effect.
5868 @item -shared
5869 @opindex shared
5870 Produce a shared object which can then be linked with other objects to
5871 form an executable.  Not all systems support this option.  For predictable
5872 results, you must also specify the same set of options that were used to
5873 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
5874 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
5875 needs to build supplementary stub code for constructors to work.  On
5876 multi-libbed systems, @samp{gcc -shared} must select the correct support
5877 libraries to link against.  Failing to supply the correct flags may lead
5878 to subtle defects.  Supplying them in cases where they are not necessary
5879 is innocuous.}
5881 @item -shared-libgcc
5882 @itemx -static-libgcc
5883 @opindex shared-libgcc
5884 @opindex static-libgcc
5885 On systems that provide @file{libgcc} as a shared library, these options
5886 force the use of either the shared or static version respectively.
5887 If no shared version of @file{libgcc} was built when the compiler was
5888 configured, these options have no effect.
5890 There are several situations in which an application should use the
5891 shared @file{libgcc} instead of the static version.  The most common
5892 of these is when the application wishes to throw and catch exceptions
5893 across different shared libraries.  In that case, each of the libraries
5894 as well as the application itself should use the shared @file{libgcc}.
5896 Therefore, the G++ and GCJ drivers automatically add
5897 @option{-shared-libgcc} whenever you build a shared library or a main
5898 executable, because C++ and Java programs typically use exceptions, so
5899 this is the right thing to do.
5901 If, instead, you use the GCC driver to create shared libraries, you may
5902 find that they will not always be linked with the shared @file{libgcc}.
5903 If GCC finds, at its configuration time, that you have a non-GNU linker
5904 or a GNU linker that does not support option @option{--eh-frame-hdr},
5905 it will link the shared version of @file{libgcc} into shared libraries
5906 by default.  Otherwise, it will take advantage of the linker and optimize
5907 away the linking with the shared version of @file{libgcc}, linking with
5908 the static version of libgcc by default.  This allows exceptions to
5909 propagate through such shared libraries, without incurring relocation
5910 costs at library load time.
5912 However, if a library or main executable is supposed to throw or catch
5913 exceptions, you must link it using the G++ or GCJ driver, as appropriate
5914 for the languages used in the program, or using the option
5915 @option{-shared-libgcc}, such that it is linked with the shared
5916 @file{libgcc}.
5918 @item -symbolic
5919 @opindex symbolic
5920 Bind references to global symbols when building a shared object.  Warn
5921 about any unresolved references (unless overridden by the link editor
5922 option @samp{-Xlinker -z -Xlinker defs}).  Only a few systems support
5923 this option.
5925 @item -Xlinker @var{option}
5926 @opindex Xlinker
5927 Pass @var{option} as an option to the linker.  You can use this to
5928 supply system-specific linker options which GCC does not know how to
5929 recognize.
5931 If you want to pass an option that takes an argument, you must use
5932 @option{-Xlinker} twice, once for the option and once for the argument.
5933 For example, to pass @option{-assert definitions}, you must write
5934 @samp{-Xlinker -assert -Xlinker definitions}.  It does not work to write
5935 @option{-Xlinker "-assert definitions"}, because this passes the entire
5936 string as a single argument, which is not what the linker expects.
5938 @item -Wl,@var{option}
5939 @opindex Wl
5940 Pass @var{option} as an option to the linker.  If @var{option} contains
5941 commas, it is split into multiple options at the commas.
5943 @item -u @var{symbol}
5944 @opindex u
5945 Pretend the symbol @var{symbol} is undefined, to force linking of
5946 library modules to define it.  You can use @option{-u} multiple times with
5947 different symbols to force loading of additional library modules.
5948 @end table
5950 @node Directory Options
5951 @section Options for Directory Search
5952 @cindex directory options
5953 @cindex options, directory search
5954 @cindex search path
5956 These options specify directories to search for header files, for
5957 libraries and for parts of the compiler:
5959 @table @gcctabopt
5960 @item -I@var{dir}
5961 @opindex I
5962 Add the directory @var{dir} to the head of the list of directories to be
5963 searched for header files.  This can be used to override a system header
5964 file, substituting your own version, since these directories are
5965 searched before the system header file directories.  However, you should
5966 not use this option to add directories that contain vendor-supplied
5967 system header files (use @option{-isystem} for that).  If you use more than
5968 one @option{-I} option, the directories are scanned in left-to-right
5969 order; the standard system directories come after.
5971 If a standard system include directory, or a directory specified with
5972 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
5973 option will be ignored.  The directory will still be searched but as a
5974 system directory at its normal position in the system include chain.
5975 This is to ensure that GCC's procedure to fix buggy system headers and
5976 the ordering for the include_next directive are not inadvertently changed.
5977 If you really need to change the search order for system directories,
5978 use the @option{-nostdinc} and/or @option{-isystem} options.
5980 @item -iquote@var{dir}
5981 @opindex iquote
5982 Add the directory @var{dir} to the head of the list of directories to
5983 be searched for header files only for the case of @samp{#include
5984 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
5985 otherwise just like @option{-I}.
5987 @item -L@var{dir}
5988 @opindex L
5989 Add directory @var{dir} to the list of directories to be searched
5990 for @option{-l}.
5992 @item -B@var{prefix}
5993 @opindex B
5994 This option specifies where to find the executables, libraries,
5995 include files, and data files of the compiler itself.
5997 The compiler driver program runs one or more of the subprograms
5998 @file{cpp}, @file{cc1}, @file{as} and @file{ld}.  It tries
5999 @var{prefix} as a prefix for each program it tries to run, both with and
6000 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6002 For each subprogram to be run, the compiler driver first tries the
6003 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
6004 was not specified, the driver tries two standard prefixes, which are
6005 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
6006 those results in a file name that is found, the unmodified program
6007 name is searched for using the directories specified in your
6008 @env{PATH} environment variable.
6010 The compiler will check to see if the path provided by the @option{-B}
6011 refers to a directory, and if necessary it will add a directory
6012 separator character at the end of the path.
6014 @option{-B} prefixes that effectively specify directory names also apply
6015 to libraries in the linker, because the compiler translates these
6016 options into @option{-L} options for the linker.  They also apply to
6017 includes files in the preprocessor, because the compiler translates these
6018 options into @option{-isystem} options for the preprocessor.  In this case,
6019 the compiler appends @samp{include} to the prefix.
6021 The run-time support file @file{libgcc.a} can also be searched for using
6022 the @option{-B} prefix, if needed.  If it is not found there, the two
6023 standard prefixes above are tried, and that is all.  The file is left
6024 out of the link if it is not found by those means.
6026 Another way to specify a prefix much like the @option{-B} prefix is to use
6027 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
6028 Variables}.
6030 As a special kludge, if the path provided by @option{-B} is
6031 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6032 9, then it will be replaced by @file{[dir/]include}.  This is to help
6033 with boot-strapping the compiler.
6035 @item -specs=@var{file}
6036 @opindex specs
6037 Process @var{file} after the compiler reads in the standard @file{specs}
6038 file, in order to override the defaults that the @file{gcc} driver
6039 program uses when determining what switches to pass to @file{cc1},
6040 @file{cc1plus}, @file{as}, @file{ld}, etc.  More than one
6041 @option{-specs=@var{file}} can be specified on the command line, and they
6042 are processed in order, from left to right.
6044 @item -I-
6045 @opindex I-
6046 This option has been deprecated.  Please use @option{-iquote} instead for
6047 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6048 Any directories you specify with @option{-I} options before the @option{-I-}
6049 option are searched only for the case of @samp{#include "@var{file}"};
6050 they are not searched for @samp{#include <@var{file}>}.
6052 If additional directories are specified with @option{-I} options after
6053 the @option{-I-}, these directories are searched for all @samp{#include}
6054 directives.  (Ordinarily @emph{all} @option{-I} directories are used
6055 this way.)
6057 In addition, the @option{-I-} option inhibits the use of the current
6058 directory (where the current input file came from) as the first search
6059 directory for @samp{#include "@var{file}"}.  There is no way to
6060 override this effect of @option{-I-}.  With @option{-I.} you can specify
6061 searching the directory which was current when the compiler was
6062 invoked.  That is not exactly the same as what the preprocessor does
6063 by default, but it is often satisfactory.
6065 @option{-I-} does not inhibit the use of the standard system directories
6066 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
6067 independent.
6068 @end table
6070 @c man end
6072 @node Spec Files
6073 @section Specifying subprocesses and the switches to pass to them
6074 @cindex Spec Files
6076 @command{gcc} is a driver program.  It performs its job by invoking a
6077 sequence of other programs to do the work of compiling, assembling and
6078 linking.  GCC interprets its command-line parameters and uses these to
6079 deduce which programs it should invoke, and which command-line options
6080 it ought to place on their command lines.  This behavior is controlled
6081 by @dfn{spec strings}.  In most cases there is one spec string for each
6082 program that GCC can invoke, but a few programs have multiple spec
6083 strings to control their behavior.  The spec strings built into GCC can
6084 be overridden by using the @option{-specs=} command-line switch to specify
6085 a spec file.
6087 @dfn{Spec files} are plaintext files that are used to construct spec
6088 strings.  They consist of a sequence of directives separated by blank
6089 lines.  The type of directive is determined by the first non-whitespace
6090 character on the line and it can be one of the following:
6092 @table @code
6093 @item %@var{command}
6094 Issues a @var{command} to the spec file processor.  The commands that can
6095 appear here are:
6097 @table @code
6098 @item %include <@var{file}>
6099 @cindex %include
6100 Search for @var{file} and insert its text at the current point in the
6101 specs file.
6103 @item %include_noerr <@var{file}>
6104 @cindex %include_noerr
6105 Just like @samp{%include}, but do not generate an error message if the include
6106 file cannot be found.
6108 @item %rename @var{old_name} @var{new_name}
6109 @cindex %rename
6110 Rename the spec string @var{old_name} to @var{new_name}.
6112 @end table
6114 @item *[@var{spec_name}]:
6115 This tells the compiler to create, override or delete the named spec
6116 string.  All lines after this directive up to the next directive or
6117 blank line are considered to be the text for the spec string.  If this
6118 results in an empty string then the spec will be deleted.  (Or, if the
6119 spec did not exist, then nothing will happened.)  Otherwise, if the spec
6120 does not currently exist a new spec will be created.  If the spec does
6121 exist then its contents will be overridden by the text of this
6122 directive, unless the first character of that text is the @samp{+}
6123 character, in which case the text will be appended to the spec.
6125 @item [@var{suffix}]:
6126 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
6127 and up to the next directive or blank line are considered to make up the
6128 spec string for the indicated suffix.  When the compiler encounters an
6129 input file with the named suffix, it will processes the spec string in
6130 order to work out how to compile that file.  For example:
6132 @smallexample
6133 .ZZ:
6134 z-compile -input %i
6135 @end smallexample
6137 This says that any input file whose name ends in @samp{.ZZ} should be
6138 passed to the program @samp{z-compile}, which should be invoked with the
6139 command-line switch @option{-input} and with the result of performing the
6140 @samp{%i} substitution.  (See below.)
6142 As an alternative to providing a spec string, the text that follows a
6143 suffix directive can be one of the following:
6145 @table @code
6146 @item @@@var{language}
6147 This says that the suffix is an alias for a known @var{language}.  This is
6148 similar to using the @option{-x} command-line switch to GCC to specify a
6149 language explicitly.  For example:
6151 @smallexample
6152 .ZZ:
6153 @@c++
6154 @end smallexample
6156 Says that .ZZ files are, in fact, C++ source files.
6158 @item #@var{name}
6159 This causes an error messages saying:
6161 @smallexample
6162 @var{name} compiler not installed on this system.
6163 @end smallexample
6164 @end table
6166 GCC already has an extensive list of suffixes built into it.
6167 This directive will add an entry to the end of the list of suffixes, but
6168 since the list is searched from the end backwards, it is effectively
6169 possible to override earlier entries using this technique.
6171 @end table
6173 GCC has the following spec strings built into it.  Spec files can
6174 override these strings or create their own.  Note that individual
6175 targets can also add their own spec strings to this list.
6177 @smallexample
6178 asm          Options to pass to the assembler
6179 asm_final    Options to pass to the assembler post-processor
6180 cpp          Options to pass to the C preprocessor
6181 cc1          Options to pass to the C compiler
6182 cc1plus      Options to pass to the C++ compiler
6183 endfile      Object files to include at the end of the link
6184 link         Options to pass to the linker
6185 lib          Libraries to include on the command line to the linker
6186 libgcc       Decides which GCC support library to pass to the linker
6187 linker       Sets the name of the linker
6188 predefines   Defines to be passed to the C preprocessor
6189 signed_char  Defines to pass to CPP to say whether @code{char} is signed
6190              by default
6191 startfile    Object files to include at the start of the link
6192 @end smallexample
6194 Here is a small example of a spec file:
6196 @smallexample
6197 %rename lib                 old_lib
6199 *lib:
6200 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6201 @end smallexample
6203 This example renames the spec called @samp{lib} to @samp{old_lib} and
6204 then overrides the previous definition of @samp{lib} with a new one.
6205 The new definition adds in some extra command-line options before
6206 including the text of the old definition.
6208 @dfn{Spec strings} are a list of command-line options to be passed to their
6209 corresponding program.  In addition, the spec strings can contain
6210 @samp{%}-prefixed sequences to substitute variable text or to
6211 conditionally insert text into the command line.  Using these constructs
6212 it is possible to generate quite complex command lines.
6214 Here is a table of all defined @samp{%}-sequences for spec
6215 strings.  Note that spaces are not generated automatically around the
6216 results of expanding these sequences.  Therefore you can concatenate them
6217 together or combine them with constant text in a single argument.
6219 @table @code
6220 @item %%
6221 Substitute one @samp{%} into the program name or argument.
6223 @item %i
6224 Substitute the name of the input file being processed.
6226 @item %b
6227 Substitute the basename of the input file being processed.
6228 This is the substring up to (and not including) the last period
6229 and not including the directory.
6231 @item %B
6232 This is the same as @samp{%b}, but include the file suffix (text after
6233 the last period).
6235 @item %d
6236 Marks the argument containing or following the @samp{%d} as a
6237 temporary file name, so that that file will be deleted if GCC exits
6238 successfully.  Unlike @samp{%g}, this contributes no text to the
6239 argument.
6241 @item %g@var{suffix}
6242 Substitute a file name that has suffix @var{suffix} and is chosen
6243 once per compilation, and mark the argument in the same way as
6244 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
6245 name is now chosen in a way that is hard to predict even when previously
6246 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6247 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
6248 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6249 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
6250 was simply substituted with a file name chosen once per compilation,
6251 without regard to any appended suffix (which was therefore treated
6252 just like ordinary text), making such attacks more likely to succeed.
6254 @item %u@var{suffix}
6255 Like @samp{%g}, but generates a new temporary file name even if
6256 @samp{%u@var{suffix}} was already seen.
6258 @item %U@var{suffix}
6259 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6260 new one if there is no such last file name.  In the absence of any
6261 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6262 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6263 would involve the generation of two distinct file names, one
6264 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
6265 simply substituted with a file name chosen for the previous @samp{%u},
6266 without regard to any appended suffix.
6268 @item %j@var{suffix}
6269 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6270 writable, and if save-temps is off; otherwise, substitute the name
6271 of a temporary file, just like @samp{%u}.  This temporary file is not
6272 meant for communication between processes, but rather as a junk
6273 disposal mechanism.
6275 @item %|@var{suffix}
6276 @itemx %m@var{suffix}
6277 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
6278 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6279 all.  These are the two most common ways to instruct a program that it
6280 should read from standard input or write to standard output.  If you
6281 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6282 construct: see for example @file{f/lang-specs.h}.
6284 @item %.@var{SUFFIX}
6285 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6286 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
6287 terminated by the next space or %.
6289 @item %w
6290 Marks the argument containing or following the @samp{%w} as the
6291 designated output file of this compilation.  This puts the argument
6292 into the sequence of arguments that @samp{%o} will substitute later.
6294 @item %o
6295 Substitutes the names of all the output files, with spaces
6296 automatically placed around them.  You should write spaces
6297 around the @samp{%o} as well or the results are undefined.
6298 @samp{%o} is for use in the specs for running the linker.
6299 Input files whose names have no recognized suffix are not compiled
6300 at all, but they are included among the output files, so they will
6301 be linked.
6303 @item %O
6304 Substitutes the suffix for object files.  Note that this is
6305 handled specially when it immediately follows @samp{%g, %u, or %U},
6306 because of the need for those to form complete file names.  The
6307 handling is such that @samp{%O} is treated exactly as if it had already
6308 been substituted, except that @samp{%g, %u, and %U} do not currently
6309 support additional @var{suffix} characters following @samp{%O} as they would
6310 following, for example, @samp{.o}.
6312 @item %p
6313 Substitutes the standard macro predefinitions for the
6314 current target machine.  Use this when running @code{cpp}.
6316 @item %P
6317 Like @samp{%p}, but puts @samp{__} before and after the name of each
6318 predefined macro, except for macros that start with @samp{__} or with
6319 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
6322 @item %I
6323 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6324 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6325 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6326 as necessary.
6328 @item %s
6329 Current argument is the name of a library or startup file of some sort.
6330 Search for that file in a standard list of directories and substitute
6331 the full name found.
6333 @item %e@var{str}
6334 Print @var{str} as an error message.  @var{str} is terminated by a newline.
6335 Use this when inconsistent options are detected.
6337 @item %(@var{name})
6338 Substitute the contents of spec string @var{name} at this point.
6340 @item %[@var{name}]
6341 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6343 @item %x@{@var{option}@}
6344 Accumulate an option for @samp{%X}.
6346 @item %X
6347 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6348 spec string.
6350 @item %Y
6351 Output the accumulated assembler options specified by @option{-Wa}.
6353 @item %Z
6354 Output the accumulated preprocessor options specified by @option{-Wp}.
6356 @item %a
6357 Process the @code{asm} spec.  This is used to compute the
6358 switches to be passed to the assembler.
6360 @item %A
6361 Process the @code{asm_final} spec.  This is a spec string for
6362 passing switches to an assembler post-processor, if such a program is
6363 needed.
6365 @item %l
6366 Process the @code{link} spec.  This is the spec for computing the
6367 command line passed to the linker.  Typically it will make use of the
6368 @samp{%L %G %S %D and %E} sequences.
6370 @item %D
6371 Dump out a @option{-L} option for each directory that GCC believes might
6372 contain startup files.  If the target supports multilibs then the
6373 current multilib directory will be prepended to each of these paths.
6375 @item %M
6376 Output the multilib directory with directory separators replaced with
6377 @samp{_}.  If multilib directories are not set, or the multilib directory is
6378 @file{.} then this option emits nothing.
6380 @item %L
6381 Process the @code{lib} spec.  This is a spec string for deciding which
6382 libraries should be included on the command line to the linker.
6384 @item %G
6385 Process the @code{libgcc} spec.  This is a spec string for deciding
6386 which GCC support library should be included on the command line to the linker.
6388 @item %S
6389 Process the @code{startfile} spec.  This is a spec for deciding which
6390 object files should be the first ones passed to the linker.  Typically
6391 this might be a file named @file{crt0.o}.
6393 @item %E
6394 Process the @code{endfile} spec.  This is a spec string that specifies
6395 the last object files that will be passed to the linker.
6397 @item %C
6398 Process the @code{cpp} spec.  This is used to construct the arguments
6399 to be passed to the C preprocessor.
6401 @item %1
6402 Process the @code{cc1} spec.  This is used to construct the options to be
6403 passed to the actual C compiler (@samp{cc1}).
6405 @item %2
6406 Process the @code{cc1plus} spec.  This is used to construct the options to be
6407 passed to the actual C++ compiler (@samp{cc1plus}).
6409 @item %*
6410 Substitute the variable part of a matched option.  See below.
6411 Note that each comma in the substituted string is replaced by
6412 a single space.
6414 @item %<@code{S}
6415 Remove all occurrences of @code{-S} from the command line.  Note---this
6416 command is position dependent.  @samp{%} commands in the spec string
6417 before this one will see @code{-S}, @samp{%} commands in the spec string
6418 after this one will not.
6420 @item %:@var{function}(@var{args})
6421 Call the named function @var{function}, passing it @var{args}.
6422 @var{args} is first processed as a nested spec string, then split
6423 into an argument vector in the usual fashion.  The function returns
6424 a string which is processed as if it had appeared literally as part
6425 of the current spec.
6427 The following built-in spec functions are provided:
6429 @table @code
6430 @item @code{if-exists}
6431 The @code{if-exists} spec function takes one argument, an absolute
6432 pathname to a file.  If the file exists, @code{if-exists} returns the
6433 pathname.  Here is a small example of its usage:
6435 @smallexample
6436 *startfile:
6437 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6438 @end smallexample
6440 @item @code{if-exists-else}
6441 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6442 spec function, except that it takes two arguments.  The first argument is
6443 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
6444 returns the pathname.  If it does not exist, it returns the second argument.
6445 This way, @code{if-exists-else} can be used to select one file or another,
6446 based on the existence of the first.  Here is a small example of its usage:
6448 @smallexample
6449 *startfile:
6450 crt0%O%s %:if-exists(crti%O%s) \
6451 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6452 @end smallexample
6454 @item @code{replace-outfile}
6455 The @code{replace-outfile} spec function takes two arguments.  It looks for the
6456 first argument in the outfiles array and replaces it with the second argument.  Here
6457 is a small example of its usage:
6459 @smallexample
6460 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6461 @end smallexample
6463 @end table
6465 @item %@{@code{S}@}
6466 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6467 If that switch was not specified, this substitutes nothing.  Note that
6468 the leading dash is omitted when specifying this option, and it is
6469 automatically inserted if the substitution is performed.  Thus the spec
6470 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6471 and would output the command line option @option{-foo}.
6473 @item %W@{@code{S}@}
6474 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6475 deleted on failure.
6477 @item %@{@code{S}*@}
6478 Substitutes all the switches specified to GCC whose names start
6479 with @code{-S}, but which also take an argument.  This is used for
6480 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6481 GCC considers @option{-o foo} as being
6482 one switch whose names starts with @samp{o}.  %@{o*@} would substitute this
6483 text, including the space.  Thus two arguments would be generated.
6485 @item %@{@code{S}*&@code{T}*@}
6486 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6487 (the order of @code{S} and @code{T} in the spec is not significant).
6488 There can be any number of ampersand-separated variables; for each the
6489 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
6491 @item %@{@code{S}:@code{X}@}
6492 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6494 @item %@{!@code{S}:@code{X}@}
6495 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6497 @item %@{@code{S}*:@code{X}@}
6498 Substitutes @code{X} if one or more switches whose names start with
6499 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
6500 once, no matter how many such switches appeared.  However, if @code{%*}
6501 appears somewhere in @code{X}, then @code{X} will be substituted once
6502 for each matching switch, with the @code{%*} replaced by the part of
6503 that switch that matched the @code{*}.
6505 @item %@{.@code{S}:@code{X}@}
6506 Substitutes @code{X}, if processing a file with suffix @code{S}.
6508 @item %@{!.@code{S}:@code{X}@}
6509 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6511 @item %@{@code{S}|@code{P}:@code{X}@}
6512 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6513 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6514 although they have a stronger binding than the @samp{|}.  If @code{%*}
6515 appears in @code{X}, all of the alternatives must be starred, and only
6516 the first matching alternative is substituted.
6518 For example, a spec string like this:
6520 @smallexample
6521 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6522 @end smallexample
6524 will output the following command-line options from the following input
6525 command-line options:
6527 @smallexample
6528 fred.c        -foo -baz
6529 jim.d         -bar -boggle
6530 -d fred.c     -foo -baz -boggle
6531 -d jim.d      -bar -baz -boggle
6532 @end smallexample
6534 @item %@{S:X; T:Y; :D@}
6536 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6537 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
6538 be as many clauses as you need.  This may be combined with @code{.},
6539 @code{!}, @code{|}, and @code{*} as needed.
6542 @end table
6544 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6545 construct may contain other nested @samp{%} constructs or spaces, or
6546 even newlines.  They are processed as usual, as described above.
6547 Trailing white space in @code{X} is ignored.  White space may also
6548 appear anywhere on the left side of the colon in these constructs,
6549 except between @code{.} or @code{*} and the corresponding word.
6551 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6552 handled specifically in these constructs.  If another value of
6553 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6554 @option{-W} switch is found later in the command line, the earlier
6555 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6556 just one letter, which passes all matching options.
6558 The character @samp{|} at the beginning of the predicate text is used to
6559 indicate that a command should be piped to the following command, but
6560 only if @option{-pipe} is specified.
6562 It is built into GCC which switches take arguments and which do not.
6563 (You might think it would be useful to generalize this to allow each
6564 compiler's spec to say which switches take arguments.  But this cannot
6565 be done in a consistent fashion.  GCC cannot even decide which input
6566 files have been specified without knowing which switches take arguments,
6567 and it must know which input files to compile in order to tell which
6568 compilers to run).
6570 GCC also knows implicitly that arguments starting in @option{-l} are to be
6571 treated as compiler output files, and passed to the linker in their
6572 proper position among the other output files.
6574 @c man begin OPTIONS
6576 @node Target Options
6577 @section Specifying Target Machine and Compiler Version
6578 @cindex target options
6579 @cindex cross compiling
6580 @cindex specifying machine version
6581 @cindex specifying compiler version and target machine
6582 @cindex compiler version, specifying
6583 @cindex target machine, specifying
6585 The usual way to run GCC is to run the executable called @file{gcc}, or
6586 @file{<machine>-gcc} when cross-compiling, or
6587 @file{<machine>-gcc-<version>} to run a version other than the one that
6588 was installed last.  Sometimes this is inconvenient, so GCC provides
6589 options that will switch to another cross-compiler or version.
6591 @table @gcctabopt
6592 @item -b @var{machine}
6593 @opindex b
6594 The argument @var{machine} specifies the target machine for compilation.
6596 The value to use for @var{machine} is the same as was specified as the
6597 machine type when configuring GCC as a cross-compiler.  For
6598 example, if a cross-compiler was configured with @samp{configure
6599 i386v}, meaning to compile for an 80386 running System V, then you
6600 would specify @option{-b i386v} to run that cross compiler.
6602 @item -V @var{version}
6603 @opindex V
6604 The argument @var{version} specifies which version of GCC to run.
6605 This is useful when multiple versions are installed.  For example,
6606 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6607 @end table
6609 The @option{-V} and @option{-b} options work by running the
6610 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6611 use them if you can just run that directly.
6613 @node Submodel Options
6614 @section Hardware Models and Configurations
6615 @cindex submodel options
6616 @cindex specifying hardware config
6617 @cindex hardware models and configurations, specifying
6618 @cindex machine dependent options
6620 Earlier we discussed the standard option @option{-b} which chooses among
6621 different installed compilers for completely different target
6622 machines, such as VAX vs.@: 68000 vs.@: 80386.
6624 In addition, each of these target machine types can have its own
6625 special options, starting with @samp{-m}, to choose among various
6626 hardware models or configurations---for example, 68010 vs 68020,
6627 floating coprocessor or none.  A single installed version of the
6628 compiler can compile for any model or configuration, according to the
6629 options specified.
6631 Some configurations of the compiler also support additional special
6632 options, usually for compatibility with other compilers on the same
6633 platform.
6635 These options are defined by the macro @code{TARGET_SWITCHES} in the
6636 machine description.  The default for the options is also defined by
6637 that macro, which enables you to change the defaults.
6639 @c This list is ordered alphanumerically by subsection name.
6640 @c It should be the same order and spelling as these options are listed
6641 @c in Machine Dependent Options
6643 @menu
6644 * ARC Options::
6645 * ARM Options::
6646 * AVR Options::
6647 * CRIS Options::
6648 * Darwin Options::
6649 * DEC Alpha Options::
6650 * DEC Alpha/VMS Options::
6651 * FRV Options::
6652 * H8/300 Options::
6653 * HPPA Options::
6654 * i386 and x86-64 Options::
6655 * IA-64 Options::
6656 * M32R/D Options::
6657 * M680x0 Options::
6658 * M68hc1x Options::
6659 * MCore Options::
6660 * MIPS Options::
6661 * MMIX Options::
6662 * MN10300 Options::
6663 * NS32K Options::
6664 * PDP-11 Options::
6665 * PowerPC Options::
6666 * RS/6000 and PowerPC Options::
6667 * S/390 and zSeries Options::
6668 * SH Options::
6669 * SPARC Options::
6670 * System V Options::
6671 * TMS320C3x/C4x Options::
6672 * V850 Options::
6673 * VAX Options::
6674 * x86-64 Options::
6675 * Xstormy16 Options::
6676 * Xtensa Options::
6677 * zSeries Options::
6678 @end menu
6680 @node ARC Options
6681 @subsection ARC Options
6682 @cindex ARC Options
6684 These options are defined for ARC implementations:
6686 @table @gcctabopt
6687 @item -EL
6688 @opindex EL
6689 Compile code for little endian mode.  This is the default.
6691 @item -EB
6692 @opindex EB
6693 Compile code for big endian mode.
6695 @item -mmangle-cpu
6696 @opindex mmangle-cpu
6697 Prepend the name of the cpu to all public symbol names.
6698 In multiple-processor systems, there are many ARC variants with different
6699 instruction and register set characteristics.  This flag prevents code
6700 compiled for one cpu to be linked with code compiled for another.
6701 No facility exists for handling variants that are ``almost identical''.
6702 This is an all or nothing option.
6704 @item -mcpu=@var{cpu}
6705 @opindex mcpu
6706 Compile code for ARC variant @var{cpu}.
6707 Which variants are supported depend on the configuration.
6708 All variants support @option{-mcpu=base}, this is the default.
6710 @item -mtext=@var{text-section}
6711 @itemx -mdata=@var{data-section}
6712 @itemx -mrodata=@var{readonly-data-section}
6713 @opindex mtext
6714 @opindex mdata
6715 @opindex mrodata
6716 Put functions, data, and readonly data in @var{text-section},
6717 @var{data-section}, and @var{readonly-data-section} respectively
6718 by default.  This can be overridden with the @code{section} attribute.
6719 @xref{Variable Attributes}.
6721 @end table
6723 @node ARM Options
6724 @subsection ARM Options
6725 @cindex ARM options
6727 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6728 architectures:
6730 @table @gcctabopt
6731 @item -mabi=@var{name}
6732 @opindex mabi
6733 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
6734 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6736 @item -mapcs-frame
6737 @opindex mapcs-frame
6738 Generate a stack frame that is compliant with the ARM Procedure Call
6739 Standard for all functions, even if this is not strictly necessary for
6740 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
6741 with this option will cause the stack frames not to be generated for
6742 leaf functions.  The default is @option{-mno-apcs-frame}.
6744 @item -mapcs
6745 @opindex mapcs
6746 This is a synonym for @option{-mapcs-frame}.
6748 @ignore
6749 @c not currently implemented
6750 @item -mapcs-stack-check
6751 @opindex mapcs-stack-check
6752 Generate code to check the amount of stack space available upon entry to
6753 every function (that actually uses some stack space).  If there is
6754 insufficient space available then either the function
6755 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6756 called, depending upon the amount of stack space required.  The run time
6757 system is required to provide these functions.  The default is
6758 @option{-mno-apcs-stack-check}, since this produces smaller code.
6760 @c not currently implemented
6761 @item -mapcs-float
6762 @opindex mapcs-float
6763 Pass floating point arguments using the float point registers.  This is
6764 one of the variants of the APCS@.  This option is recommended if the
6765 target hardware has a floating point unit or if a lot of floating point
6766 arithmetic is going to be performed by the code.  The default is
6767 @option{-mno-apcs-float}, since integer only code is slightly increased in
6768 size if @option{-mapcs-float} is used.
6770 @c not currently implemented
6771 @item -mapcs-reentrant
6772 @opindex mapcs-reentrant
6773 Generate reentrant, position independent code.  The default is
6774 @option{-mno-apcs-reentrant}.
6775 @end ignore
6777 @item -mthumb-interwork
6778 @opindex mthumb-interwork
6779 Generate code which supports calling between the ARM and Thumb
6780 instruction sets.  Without this option the two instruction sets cannot
6781 be reliably used inside one program.  The default is
6782 @option{-mno-thumb-interwork}, since slightly larger code is generated
6783 when @option{-mthumb-interwork} is specified.
6785 @item -mno-sched-prolog
6786 @opindex mno-sched-prolog
6787 Prevent the reordering of instructions in the function prolog, or the
6788 merging of those instruction with the instructions in the function's
6789 body.  This means that all functions will start with a recognizable set
6790 of instructions (or in fact one of a choice from a small set of
6791 different function prologues), and this information can be used to
6792 locate the start if functions inside an executable piece of code.  The
6793 default is @option{-msched-prolog}.
6795 @item -mhard-float
6796 @opindex mhard-float
6797 Generate output containing floating point instructions.  This is the
6798 default.
6800 @item -msoft-float
6801 @opindex msoft-float
6802 Generate output containing library calls for floating point.
6803 @strong{Warning:} the requisite libraries are not available for all ARM
6804 targets.  Normally the facilities of the machine's usual C compiler are
6805 used, but this cannot be done directly in cross-compilation.  You must make
6806 your own arrangements to provide suitable library functions for
6807 cross-compilation.
6809 @option{-msoft-float} changes the calling convention in the output file;
6810 therefore, it is only useful if you compile @emph{all} of a program with
6811 this option.  In particular, you need to compile @file{libgcc.a}, the
6812 library that comes with GCC, with @option{-msoft-float} in order for
6813 this to work.
6815 @item -mfloat-abi=@var{name}
6816 @opindex mfloat-abi
6817 Specifies which ABI to use for floating point values.  Permissible values
6818 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6820 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6821 and @option{-mhard-float} respectively.  @samp{softfp} allows the generation
6822 of floating point instructions, but still uses the soft-float calling
6823 conventions.
6825 @item -mlittle-endian
6826 @opindex mlittle-endian
6827 Generate code for a processor running in little-endian mode.  This is
6828 the default for all standard configurations.
6830 @item -mbig-endian
6831 @opindex mbig-endian
6832 Generate code for a processor running in big-endian mode; the default is
6833 to compile code for a little-endian processor.
6835 @item -mwords-little-endian
6836 @opindex mwords-little-endian
6837 This option only applies when generating code for big-endian processors.
6838 Generate code for a little-endian word order but a big-endian byte
6839 order.  That is, a byte order of the form @samp{32107654}.  Note: this
6840 option should only be used if you require compatibility with code for
6841 big-endian ARM processors generated by versions of the compiler prior to
6842 2.8.
6844 @item -mcpu=@var{name}
6845 @opindex mcpu
6846 This specifies the name of the target ARM processor.  GCC uses this name
6847 to determine what kind of instructions it can emit when generating
6848 assembly code.  Permissible names are: @samp{arm2}, @samp{arm250},
6849 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
6850 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
6851 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
6852 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
6853 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
6854 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
6855 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
6856 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
6857 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
6858 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
6859 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
6860 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
6861 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
6862 @samp{ep9312}.
6864 @itemx -mtune=@var{name}
6865 @opindex mtune
6866 This option is very similar to the @option{-mcpu=} option, except that
6867 instead of specifying the actual target processor type, and hence
6868 restricting which instructions can be used, it specifies that GCC should
6869 tune the performance of the code as if the target were of the type
6870 specified in this option, but still choosing the instructions that it
6871 will generate based on the cpu specified by a @option{-mcpu=} option.
6872 For some ARM implementations better performance can be obtained by using
6873 this option.
6875 @item -march=@var{name}
6876 @opindex march
6877 This specifies the name of the target ARM architecture.  GCC uses this
6878 name to determine what kind of instructions it can emit when generating
6879 assembly code.  This option can be used in conjunction with or instead
6880 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
6881 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
6882 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
6883 @samp{iwmmxt}, @samp{ep9312}.
6885 @item -mfpu=@var{name}
6886 @itemx -mfpe=@var{number}
6887 @itemx -mfp=@var{number}
6888 @opindex mfpu
6889 @opindex mfpe
6890 @opindex mfp
6891 This specifies what floating point hardware (or hardware emulation) is
6892 available on the target.  Permissible names are: @samp{fpa}, @samp{fpe2},
6893 @samp{fpe3}, @samp{maverick}, @samp{vfp}.  @option{-mfp} and @option{-mfpe}
6894 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
6895 with older versions of GCC@.
6897 If @option{-msoft-float} is specified this specifies the format of
6898 floating point values.
6900 @item -mstructure-size-boundary=@var{n}
6901 @opindex mstructure-size-boundary
6902 The size of all structures and unions will be rounded up to a multiple
6903 of the number of bits set by this option.  Permissible values are 8, 32
6904 and 64.  The default value varies for different toolchains.  For the COFF
6905 targeted toolchain the default value is 8.  A value of 64 is only allowed
6906 if the underlying ABI supports it.
6908 Specifying the larger number can produce faster, more efficient code, but
6909 can also increase the size of the program.  Different values are potentially
6910 incompatible.  Code compiled with one value cannot necessarily expect to
6911 work with code or libraries compiled with another value, if they exchange
6912 information using structures or unions.
6914 @item -mabort-on-noreturn
6915 @opindex mabort-on-noreturn
6916 Generate a call to the function @code{abort} at the end of a
6917 @code{noreturn} function.  It will be executed if the function tries to
6918 return.
6920 @item -mlong-calls
6921 @itemx -mno-long-calls
6922 @opindex mlong-calls
6923 @opindex mno-long-calls
6924 Tells the compiler to perform function calls by first loading the
6925 address of the function into a register and then performing a subroutine
6926 call on this register.  This switch is needed if the target function
6927 will lie outside of the 64 megabyte addressing range of the offset based
6928 version of subroutine call instruction.
6930 Even if this switch is enabled, not all function calls will be turned
6931 into long calls.  The heuristic is that static functions, functions
6932 which have the @samp{short-call} attribute, functions that are inside
6933 the scope of a @samp{#pragma no_long_calls} directive and functions whose
6934 definitions have already been compiled within the current compilation
6935 unit, will not be turned into long calls.  The exception to this rule is
6936 that weak function definitions, functions with the @samp{long-call}
6937 attribute or the @samp{section} attribute, and functions that are within
6938 the scope of a @samp{#pragma long_calls} directive, will always be
6939 turned into long calls.
6941 This feature is not enabled by default.  Specifying
6942 @option{-mno-long-calls} will restore the default behavior, as will
6943 placing the function calls within the scope of a @samp{#pragma
6944 long_calls_off} directive.  Note these switches have no effect on how
6945 the compiler generates code to handle function calls via function
6946 pointers.
6948 @item -mnop-fun-dllimport
6949 @opindex mnop-fun-dllimport
6950 Disable support for the @code{dllimport} attribute.
6952 @item -msingle-pic-base
6953 @opindex msingle-pic-base
6954 Treat the register used for PIC addressing as read-only, rather than
6955 loading it in the prologue for each function.  The run-time system is
6956 responsible for initializing this register with an appropriate value
6957 before execution begins.
6959 @item -mpic-register=@var{reg}
6960 @opindex mpic-register
6961 Specify the register to be used for PIC addressing.  The default is R10
6962 unless stack-checking is enabled, when R9 is used.
6964 @item -mcirrus-fix-invalid-insns
6965 @opindex mcirrus-fix-invalid-insns
6966 @opindex mno-cirrus-fix-invalid-insns
6967 Insert NOPs into the instruction stream to in order to work around
6968 problems with invalid Maverick instruction combinations.  This option
6969 is only valid if the @option{-mcpu=ep9312} option has been used to
6970 enable generation of instructions for the Cirrus Maverick floating
6971 point co-processor.  This option is not enabled by default, since the
6972 problem is only present in older Maverick implementations.  The default
6973 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
6974 switch.
6976 @item -mpoke-function-name
6977 @opindex mpoke-function-name
6978 Write the name of each function into the text section, directly
6979 preceding the function prologue.  The generated code is similar to this:
6981 @smallexample
6982      t0
6983          .ascii "arm_poke_function_name", 0
6984          .align
6985      t1
6986          .word 0xff000000 + (t1 - t0)
6987      arm_poke_function_name
6988          mov     ip, sp
6989          stmfd   sp!, @{fp, ip, lr, pc@}
6990          sub     fp, ip, #4
6991 @end smallexample
6993 When performing a stack backtrace, code can inspect the value of
6994 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
6995 location @code{pc - 12} and the top 8 bits are set, then we know that
6996 there is a function name embedded immediately preceding this location
6997 and has length @code{((pc[-3]) & 0xff000000)}.
6999 @item -mthumb
7000 @opindex mthumb
7001 Generate code for the 16-bit Thumb instruction set.  The default is to
7002 use the 32-bit ARM instruction set.
7004 @item -mtpcs-frame
7005 @opindex mtpcs-frame
7006 Generate a stack frame that is compliant with the Thumb Procedure Call
7007 Standard for all non-leaf functions.  (A leaf function is one that does
7008 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
7010 @item -mtpcs-leaf-frame
7011 @opindex mtpcs-leaf-frame
7012 Generate a stack frame that is compliant with the Thumb Procedure Call
7013 Standard for all leaf functions.  (A leaf function is one that does
7014 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
7016 @item -mcallee-super-interworking
7017 @opindex mcallee-super-interworking
7018 Gives all externally visible functions in the file being compiled an ARM
7019 instruction set header which switches to Thumb mode before executing the
7020 rest of the function.  This allows these functions to be called from
7021 non-interworking code.
7023 @item -mcaller-super-interworking
7024 @opindex mcaller-super-interworking
7025 Allows calls via function pointers (including virtual functions) to
7026 execute correctly regardless of whether the target code has been
7027 compiled for interworking or not.  There is a small overhead in the cost
7028 of executing a function pointer if this option is enabled.
7030 @end table
7032 @node AVR Options
7033 @subsection AVR Options
7034 @cindex AVR Options
7036 These options are defined for AVR implementations:
7038 @table @gcctabopt
7039 @item -mmcu=@var{mcu}
7040 @opindex mmcu
7041 Specify ATMEL AVR instruction set or MCU type.
7043 Instruction set avr1 is for the minimal AVR core, not supported by the C
7044 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7045 attiny11, attiny12, attiny15, attiny28).
7047 Instruction set avr2 (default) is for the classic AVR core with up to
7048 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7049 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7050 at90c8534, at90s8535).
7052 Instruction set avr3 is for the classic AVR core with up to 128K program
7053 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7055 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7056 memory space (MCU types: atmega8, atmega83, atmega85).
7058 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7059 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7060 atmega64, atmega128, at43usb355, at94k).
7062 @item -msize
7063 @opindex msize
7064 Output instruction sizes to the asm file.
7066 @item -minit-stack=@var{N}
7067 @opindex minit-stack
7068 Specify the initial stack address, which may be a symbol or numeric value,
7069 @samp{__stack} is the default.
7071 @item -mno-interrupts
7072 @opindex mno-interrupts
7073 Generated code is not compatible with hardware interrupts.
7074 Code size will be smaller.
7076 @item -mcall-prologues
7077 @opindex mcall-prologues
7078 Functions prologues/epilogues expanded as call to appropriate
7079 subroutines.  Code size will be smaller.
7081 @item -mno-tablejump
7082 @opindex mno-tablejump
7083 Do not generate tablejump insns which sometimes increase code size.
7085 @item -mtiny-stack
7086 @opindex mtiny-stack
7087 Change only the low 8 bits of the stack pointer.
7089 @item -mint8
7090 @opindex mint8
7091 Assume int to be 8 bit integer.  This affects the sizes of all types: A
7092 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7093 and long long will be 4 bytes.  Please note that this option does not
7094 comply to the C standards, but it will provide you with smaller code
7095 size.
7096 @end table
7098 @node CRIS Options
7099 @subsection CRIS Options
7100 @cindex CRIS Options
7102 These options are defined specifically for the CRIS ports.
7104 @table @gcctabopt
7105 @item -march=@var{architecture-type}
7106 @itemx -mcpu=@var{architecture-type}
7107 @opindex march
7108 @opindex mcpu
7109 Generate code for the specified architecture.  The choices for
7110 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7111 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7112 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7113 @samp{v10}.
7115 @item -mtune=@var{architecture-type}
7116 @opindex mtune
7117 Tune to @var{architecture-type} everything applicable about the generated
7118 code, except for the ABI and the set of available instructions.  The
7119 choices for @var{architecture-type} are the same as for
7120 @option{-march=@var{architecture-type}}.
7122 @item -mmax-stack-frame=@var{n}
7123 @opindex mmax-stack-frame
7124 Warn when the stack frame of a function exceeds @var{n} bytes.
7126 @item -melinux-stacksize=@var{n}
7127 @opindex melinux-stacksize
7128 Only available with the @samp{cris-axis-aout} target.  Arranges for
7129 indications in the program to the kernel loader that the stack of the
7130 program should be set to @var{n} bytes.
7132 @item -metrax4
7133 @itemx -metrax100
7134 @opindex metrax4
7135 @opindex metrax100
7136 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7137 @option{-march=v3} and @option{-march=v8} respectively.
7139 @item -mmul-bug-workaround
7140 @itemx -mno-mul-bug-workaround
7141 @opindex mmul-bug-workaround
7142 @opindex mno-mul-bug-workaround
7143 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7144 models where it applies.  This option is active by default.
7146 @item -mpdebug
7147 @opindex mpdebug
7148 Enable CRIS-specific verbose debug-related information in the assembly
7149 code.  This option also has the effect to turn off the @samp{#NO_APP}
7150 formatted-code indicator to the assembler at the beginning of the
7151 assembly file.
7153 @item -mcc-init
7154 @opindex mcc-init
7155 Do not use condition-code results from previous instruction; always emit
7156 compare and test instructions before use of condition codes.
7158 @item -mno-side-effects
7159 @opindex mno-side-effects
7160 Do not emit instructions with side-effects in addressing modes other than
7161 post-increment.
7163 @item -mstack-align
7164 @itemx -mno-stack-align
7165 @itemx -mdata-align
7166 @itemx -mno-data-align
7167 @itemx -mconst-align
7168 @itemx -mno-const-align
7169 @opindex mstack-align
7170 @opindex mno-stack-align
7171 @opindex mdata-align
7172 @opindex mno-data-align
7173 @opindex mconst-align
7174 @opindex mno-const-align
7175 These options (no-options) arranges (eliminate arrangements) for the
7176 stack-frame, individual data and constants to be aligned for the maximum
7177 single data access size for the chosen CPU model.  The default is to
7178 arrange for 32-bit alignment.  ABI details such as structure layout are
7179 not affected by these options.
7181 @item -m32-bit
7182 @itemx -m16-bit
7183 @itemx -m8-bit
7184 @opindex m32-bit
7185 @opindex m16-bit
7186 @opindex m8-bit
7187 Similar to the stack- data- and const-align options above, these options
7188 arrange for stack-frame, writable data and constants to all be 32-bit,
7189 16-bit or 8-bit aligned.  The default is 32-bit alignment.
7191 @item -mno-prologue-epilogue
7192 @itemx -mprologue-epilogue
7193 @opindex mno-prologue-epilogue
7194 @opindex mprologue-epilogue
7195 With @option{-mno-prologue-epilogue}, the normal function prologue and
7196 epilogue that sets up the stack-frame are omitted and no return
7197 instructions or return sequences are generated in the code.  Use this
7198 option only together with visual inspection of the compiled code: no
7199 warnings or errors are generated when call-saved registers must be saved,
7200 or storage for local variable needs to be allocated.
7202 @item -mno-gotplt
7203 @itemx -mgotplt
7204 @opindex mno-gotplt
7205 @opindex mgotplt
7206 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7207 instruction sequences that load addresses for functions from the PLT part
7208 of the GOT rather than (traditional on other architectures) calls to the
7209 PLT@.  The default is @option{-mgotplt}.
7211 @item -maout
7212 @opindex maout
7213 Legacy no-op option only recognized with the cris-axis-aout target.
7215 @item -melf
7216 @opindex melf
7217 Legacy no-op option only recognized with the cris-axis-elf and
7218 cris-axis-linux-gnu targets.
7220 @item -melinux
7221 @opindex melinux
7222 Only recognized with the cris-axis-aout target, where it selects a
7223 GNU/linux-like multilib, include files and instruction set for
7224 @option{-march=v8}.
7226 @item -mlinux
7227 @opindex mlinux
7228 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7230 @item -sim
7231 @opindex sim
7232 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7233 to link with input-output functions from a simulator library.  Code,
7234 initialized data and zero-initialized data are allocated consecutively.
7236 @item -sim2
7237 @opindex sim2
7238 Like @option{-sim}, but pass linker options to locate initialized data at
7239 0x40000000 and zero-initialized data at 0x80000000.
7240 @end table
7242 @node Darwin Options
7243 @subsection Darwin Options
7244 @cindex Darwin options
7246 These options are defined for all architectures running the Darwin operating
7247 system.
7249 FSF GCC on Darwin does not create ``fat'' object files; it will create
7250 an object file for the single architecture that it was built to
7251 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
7252 @option{-arch} options are used; it does so by running the compiler or
7253 linker multiple times and joining the results together with
7254 @file{lipo}.
7256 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7257 @samp{i686}) is determined by the flags that specify the ISA
7258 that GCC is targetting, like @option{-mcpu} or @option{-march}.  The
7259 @option{-force_cpusubtype_ALL} option can be used to override this.
7261 The Darwin tools vary in their behaviour when presented with an ISA
7262 mismatch.  The assembler, @file{as}, will only permit instructions to
7263 be used that are valid for the subtype of the file it is generating,
7264 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7265 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7266 and print an error if asked to create a shared library with a less
7267 restrictive subtype than its input files (for instance, trying to put
7268 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
7269 for executables, @file{ld}, will quietly give the executable the most
7270 restrictive subtype of any of its input files.
7272 @table @gcctabopt
7273 @item -F@var{dir}
7274 @opindex F
7275 Add the framework directory @var{dir} to the head of the list of
7276 directories to be searched for header files.  These directories are
7277 interleaved with those specified by @option{-I} options and are
7278 scanned in a left-to-right order.
7280 A framework directory is a directory with frameworks in it.  A
7281 framework is a directory with a @samp{"Headers"} and/or
7282 @samp{"PrivateHeaders"} directory contained directly in it that ends
7283 in @samp{".framework"}.  The name of a framework is the name of this
7284 directory excluding the @samp{".framework"}.  Headers associated with
7285 the framework are found in one of those two directories, with
7286 @samp{"Headers"} being searched first.  A subframework is a framework
7287 directory that is in a framework's @samp{"Frameworks"} directory.
7288 Includes of subframework headers can only appear in a header of a
7289 framework that contains the subframework, or in a sibling subframework
7290 header.  Two subframeworks are siblings if they occur in the same
7291 framework.  A subframework should not have the same name as a
7292 framework, a warning will be issued if this is violated.  Currently a
7293 subframework cannot have subframeworks, in the future, the mechanism
7294 may be extended to support this.  The standard frameworks can be found
7295 in @samp{"/System/Library/Frameworks"} and
7296 @samp{"/Library/Frameworks"}.  An example include looks like
7297 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7298 the name of the framework and header.h is found in the
7299 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7301 @item -gused
7302 @opindex -gused
7303 Emit debugging information for symbols that are used.  For STABS
7304 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7305 This is by default ON@.
7307 @item -gfull
7308 @opindex -gfull
7309 Emit debugging information for all symbols and types.
7311 @item -mone-byte-bool
7312 @opindex -mone-byte-bool
7313 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7314 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7315 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7316 option has no effect on x86.
7318 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7319 to generate code that is not binary compatible with code generated
7320 without that switch.  Using this switch may require recompiling all
7321 other modules in a program, including system libraries.  Use this
7322 switch to conform to a non-default data model.
7324 @item -mfix-and-continue
7325 @itemx -ffix-and-continue
7326 @itemx -findirect-data
7327 @opindex mfix-and-continue
7328 @opindex ffix-and-continue
7329 @opindex findirect-data
7330 Generate code suitable for fast turn around development.  Needed to
7331 enable gdb to dynamically load @code{.o} files into already running
7332 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
7333 are provided for backwards compatibility.
7335 @item -all_load
7336 @opindex all_load
7337 Loads all members of static archive libraries.
7338 See man ld(1) for more information.
7340 @item -arch_errors_fatal
7341 @opindex arch_errors_fatal
7342 Cause the errors having to do with files that have the wrong architecture
7343 to be fatal.
7345 @item -bind_at_load
7346 @opindex bind_at_load
7347 Causes the output file to be marked such that the dynamic linker will
7348 bind all undefined references when the file is loaded or launched.
7350 @item -bundle
7351 @opindex bundle
7352 Produce a Mach-o bundle format file.
7353 See man ld(1) for more information.
7355 @item -bundle_loader @var{executable}
7356 @opindex bundle_loader
7357 This option specifies the @var{executable} that will be loading the build
7358 output file being linked.  See man ld(1) for more information.
7360 @item -dynamiclib
7361 @opindex -dynamiclib
7362 When passed this option, GCC will produce a dynamic library instead of
7363 an executable when linking, using the Darwin @file{libtool} command.
7365 @item -force_cpusubtype_ALL
7366 @opindex -force_cpusubtype_ALL
7367 This causes GCC's output file to have the @var{ALL} subtype, instead of
7368 one controlled by the @option{-mcpu} or @option{-march} option.
7370 @item -allowable_client  @var{client_name}
7371 @itemx -client_name
7372 @itemx -compatibility_version
7373 @itemx -current_version
7374 @itemx -dead_strip
7375 @itemx -dependency-file
7376 @itemx -dylib_file
7377 @itemx -dylinker_install_name
7378 @itemx -dynamic
7379 @itemx -exported_symbols_list
7380 @itemx -filelist
7381 @itemx -flat_namespace
7382 @itemx -force_flat_namespace
7383 @itemx -headerpad_max_install_names
7384 @itemx -image_base
7385 @itemx -init
7386 @itemx -install_name
7387 @itemx -keep_private_externs
7388 @itemx -multi_module
7389 @itemx -multiply_defined
7390 @itemx -multiply_defined_unused
7391 @itemx -noall_load
7392 @itemx -no_dead_strip_inits_and_terms
7393 @itemx -nofixprebinding
7394 @itemx -nomultidefs
7395 @itemx -noprebind
7396 @itemx -noseglinkedit
7397 @itemx -pagezero_size
7398 @itemx -prebind
7399 @itemx -prebind_all_twolevel_modules
7400 @itemx -private_bundle
7401 @itemx -read_only_relocs
7402 @itemx -sectalign
7403 @itemx -sectobjectsymbols
7404 @itemx -whyload
7405 @itemx -seg1addr
7406 @itemx -sectcreate
7407 @itemx -sectobjectsymbols
7408 @itemx -sectorder
7409 @itemx -segaddr
7410 @itemx -segs_read_only_addr
7411 @itemx -segs_read_write_addr
7412 @itemx -seg_addr_table
7413 @itemx -seg_addr_table_filename
7414 @itemx -seglinkedit
7415 @itemx -segprot
7416 @itemx -segs_read_only_addr
7417 @itemx -segs_read_write_addr
7418 @itemx -single_module
7419 @itemx -static
7420 @itemx -sub_library
7421 @itemx -sub_umbrella
7422 @itemx -twolevel_namespace
7423 @itemx -umbrella
7424 @itemx -undefined
7425 @itemx -unexported_symbols_list
7426 @itemx -weak_reference_mismatches
7427 @itemx -whatsloaded
7429 @opindex allowable_client
7430 @opindex client_name
7431 @opindex compatibility_version
7432 @opindex current_version
7433 @opindex dead_strip
7434 @opindex dependency-file
7435 @opindex dylib_file
7436 @opindex dylinker_install_name
7437 @opindex dynamic
7438 @opindex exported_symbols_list
7439 @opindex filelist
7440 @opindex flat_namespace
7441 @opindex force_flat_namespace
7442 @opindex headerpad_max_install_names
7443 @opindex image_base
7444 @opindex init
7445 @opindex install_name
7446 @opindex keep_private_externs
7447 @opindex multi_module
7448 @opindex multiply_defined
7449 @opindex multiply_defined_unused
7450 @opindex noall_load
7451 @opindex no_dead_strip_inits_and_terms
7452 @opindex nofixprebinding
7453 @opindex nomultidefs
7454 @opindex noprebind
7455 @opindex noseglinkedit
7456 @opindex pagezero_size
7457 @opindex prebind
7458 @opindex prebind_all_twolevel_modules
7459 @opindex private_bundle
7460 @opindex read_only_relocs
7461 @opindex sectalign
7462 @opindex sectobjectsymbols
7463 @opindex whyload
7464 @opindex seg1addr
7465 @opindex sectcreate
7466 @opindex sectobjectsymbols
7467 @opindex sectorder
7468 @opindex segaddr
7469 @opindex segs_read_only_addr
7470 @opindex segs_read_write_addr
7471 @opindex seg_addr_table
7472 @opindex seg_addr_table_filename
7473 @opindex seglinkedit
7474 @opindex segprot
7475 @opindex segs_read_only_addr
7476 @opindex segs_read_write_addr
7477 @opindex single_module
7478 @opindex static
7479 @opindex sub_library
7480 @opindex sub_umbrella
7481 @opindex twolevel_namespace
7482 @opindex umbrella
7483 @opindex undefined
7484 @opindex unexported_symbols_list
7485 @opindex weak_reference_mismatches
7486 @opindex whatsloaded
7488 These options are passed to the Darwin linker.  The Darwin linker man page
7489 describes them in detail.
7490 @end table
7492 @node DEC Alpha Options
7493 @subsection DEC Alpha Options
7495 These @samp{-m} options are defined for the DEC Alpha implementations:
7497 @table @gcctabopt
7498 @item -mno-soft-float
7499 @itemx -msoft-float
7500 @opindex mno-soft-float
7501 @opindex msoft-float
7502 Use (do not use) the hardware floating-point instructions for
7503 floating-point operations.  When @option{-msoft-float} is specified,
7504 functions in @file{libgcc.a} will be used to perform floating-point
7505 operations.  Unless they are replaced by routines that emulate the
7506 floating-point operations, or compiled in such a way as to call such
7507 emulations routines, these routines will issue floating-point
7508 operations.   If you are compiling for an Alpha without floating-point
7509 operations, you must ensure that the library is built so as not to call
7510 them.
7512 Note that Alpha implementations without floating-point operations are
7513 required to have floating-point registers.
7515 @item -mfp-reg
7516 @itemx -mno-fp-regs
7517 @opindex mfp-reg
7518 @opindex mno-fp-regs
7519 Generate code that uses (does not use) the floating-point register set.
7520 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
7521 register set is not used, floating point operands are passed in integer
7522 registers as if they were integers and floating-point results are passed
7523 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
7524 so any function with a floating-point argument or return value called by code
7525 compiled with @option{-mno-fp-regs} must also be compiled with that
7526 option.
7528 A typical use of this option is building a kernel that does not use,
7529 and hence need not save and restore, any floating-point registers.
7531 @item -mieee
7532 @opindex mieee
7533 The Alpha architecture implements floating-point hardware optimized for
7534 maximum performance.  It is mostly compliant with the IEEE floating
7535 point standard.  However, for full compliance, software assistance is
7536 required.  This option generates code fully IEEE compliant code
7537 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7538 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7539 defined during compilation.  The resulting code is less efficient but is
7540 able to correctly support denormalized numbers and exceptional IEEE
7541 values such as not-a-number and plus/minus infinity.  Other Alpha
7542 compilers call this option @option{-ieee_with_no_inexact}.
7544 @item -mieee-with-inexact
7545 @opindex mieee-with-inexact
7546 This is like @option{-mieee} except the generated code also maintains
7547 the IEEE @var{inexact-flag}.  Turning on this option causes the
7548 generated code to implement fully-compliant IEEE math.  In addition to
7549 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7550 macro.  On some Alpha implementations the resulting code may execute
7551 significantly slower than the code generated by default.  Since there is
7552 very little code that depends on the @var{inexact-flag}, you should
7553 normally not specify this option.  Other Alpha compilers call this
7554 option @option{-ieee_with_inexact}.
7556 @item -mfp-trap-mode=@var{trap-mode}
7557 @opindex mfp-trap-mode
7558 This option controls what floating-point related traps are enabled.
7559 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7560 The trap mode can be set to one of four values:
7562 @table @samp
7563 @item n
7564 This is the default (normal) setting.  The only traps that are enabled
7565 are the ones that cannot be disabled in software (e.g., division by zero
7566 trap).
7568 @item u
7569 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7570 as well.
7572 @item su
7573 Like @samp{su}, but the instructions are marked to be safe for software
7574 completion (see Alpha architecture manual for details).
7576 @item sui
7577 Like @samp{su}, but inexact traps are enabled as well.
7578 @end table
7580 @item -mfp-rounding-mode=@var{rounding-mode}
7581 @opindex mfp-rounding-mode
7582 Selects the IEEE rounding mode.  Other Alpha compilers call this option
7583 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
7586 @table @samp
7587 @item n
7588 Normal IEEE rounding mode.  Floating point numbers are rounded towards
7589 the nearest machine number or towards the even machine number in case
7590 of a tie.
7592 @item m
7593 Round towards minus infinity.
7595 @item c
7596 Chopped rounding mode.  Floating point numbers are rounded towards zero.
7598 @item d
7599 Dynamic rounding mode.  A field in the floating point control register
7600 (@var{fpcr}, see Alpha architecture reference manual) controls the
7601 rounding mode in effect.  The C library initializes this register for
7602 rounding towards plus infinity.  Thus, unless your program modifies the
7603 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7604 @end table
7606 @item -mtrap-precision=@var{trap-precision}
7607 @opindex mtrap-precision
7608 In the Alpha architecture, floating point traps are imprecise.  This
7609 means without software assistance it is impossible to recover from a
7610 floating trap and program execution normally needs to be terminated.
7611 GCC can generate code that can assist operating system trap handlers
7612 in determining the exact location that caused a floating point trap.
7613 Depending on the requirements of an application, different levels of
7614 precisions can be selected:
7616 @table @samp
7617 @item p
7618 Program precision.  This option is the default and means a trap handler
7619 can only identify which program caused a floating point exception.
7621 @item f
7622 Function precision.  The trap handler can determine the function that
7623 caused a floating point exception.
7625 @item i
7626 Instruction precision.  The trap handler can determine the exact
7627 instruction that caused a floating point exception.
7628 @end table
7630 Other Alpha compilers provide the equivalent options called
7631 @option{-scope_safe} and @option{-resumption_safe}.
7633 @item -mieee-conformant
7634 @opindex mieee-conformant
7635 This option marks the generated code as IEEE conformant.  You must not
7636 use this option unless you also specify @option{-mtrap-precision=i} and either
7637 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
7638 is to emit the line @samp{.eflag 48} in the function prologue of the
7639 generated assembly file.  Under DEC Unix, this has the effect that
7640 IEEE-conformant math library routines will be linked in.
7642 @item -mbuild-constants
7643 @opindex mbuild-constants
7644 Normally GCC examines a 32- or 64-bit integer constant to
7645 see if it can construct it from smaller constants in two or three
7646 instructions.  If it cannot, it will output the constant as a literal and
7647 generate code to load it from the data segment at runtime.
7649 Use this option to require GCC to construct @emph{all} integer constants
7650 using code, even if it takes more instructions (the maximum is six).
7652 You would typically use this option to build a shared library dynamic
7653 loader.  Itself a shared library, it must relocate itself in memory
7654 before it can find the variables and constants in its own data segment.
7656 @item -malpha-as
7657 @itemx -mgas
7658 @opindex malpha-as
7659 @opindex mgas
7660 Select whether to generate code to be assembled by the vendor-supplied
7661 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7663 @item -mbwx
7664 @itemx -mno-bwx
7665 @itemx -mcix
7666 @itemx -mno-cix
7667 @itemx -mfix
7668 @itemx -mno-fix
7669 @itemx -mmax
7670 @itemx -mno-max
7671 @opindex mbwx
7672 @opindex mno-bwx
7673 @opindex mcix
7674 @opindex mno-cix
7675 @opindex mfix
7676 @opindex mno-fix
7677 @opindex mmax
7678 @opindex mno-max
7679 Indicate whether GCC should generate code to use the optional BWX,
7680 CIX, FIX and MAX instruction sets.  The default is to use the instruction
7681 sets supported by the CPU type specified via @option{-mcpu=} option or that
7682 of the CPU on which GCC was built if none was specified.
7684 @item -mfloat-vax
7685 @itemx -mfloat-ieee
7686 @opindex mfloat-vax
7687 @opindex mfloat-ieee
7688 Generate code that uses (does not use) VAX F and G floating point
7689 arithmetic instead of IEEE single and double precision.
7691 @item -mexplicit-relocs
7692 @itemx -mno-explicit-relocs
7693 @opindex mexplicit-relocs
7694 @opindex mno-explicit-relocs
7695 Older Alpha assemblers provided no way to generate symbol relocations
7696 except via assembler macros.  Use of these macros does not allow
7697 optimal instruction scheduling.  GNU binutils as of version 2.12
7698 supports a new syntax that allows the compiler to explicitly mark
7699 which relocations should apply to which instructions.  This option
7700 is mostly useful for debugging, as GCC detects the capabilities of
7701 the assembler when it is built and sets the default accordingly.
7703 @item -msmall-data
7704 @itemx -mlarge-data
7705 @opindex msmall-data
7706 @opindex mlarge-data
7707 When @option{-mexplicit-relocs} is in effect, static data is
7708 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
7709 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7710 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7711 16-bit relocations off of the @code{$gp} register.  This limits the
7712 size of the small data area to 64KB, but allows the variables to be
7713 directly accessed via a single instruction.
7715 The default is @option{-mlarge-data}.  With this option the data area
7716 is limited to just below 2GB@.  Programs that require more than 2GB of
7717 data must use @code{malloc} or @code{mmap} to allocate the data in the
7718 heap instead of in the program's data segment.
7720 When generating code for shared libraries, @option{-fpic} implies
7721 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7723 @item -msmall-text
7724 @itemx -mlarge-text
7725 @opindex msmall-text
7726 @opindex mlarge-text
7727 When @option{-msmall-text} is used, the compiler assumes that the
7728 code of the entire program (or shared library) fits in 4MB, and is
7729 thus reachable with a branch instruction.  When @option{-msmall-data}
7730 is used, the compiler can assume that all local symbols share the
7731 same @code{$gp} value, and thus reduce the number of instructions
7732 required for a function call from 4 to 1.
7734 The default is @option{-mlarge-text}.
7736 @item -mcpu=@var{cpu_type}
7737 @opindex mcpu
7738 Set the instruction set and instruction scheduling parameters for
7739 machine type @var{cpu_type}.  You can specify either the @samp{EV}
7740 style name or the corresponding chip number.  GCC supports scheduling
7741 parameters for the EV4, EV5 and EV6 family of processors and will
7742 choose the default values for the instruction set from the processor
7743 you specify.  If you do not specify a processor type, GCC will default
7744 to the processor on which the compiler was built.
7746 Supported values for @var{cpu_type} are
7748 @table @samp
7749 @item ev4
7750 @itemx ev45
7751 @itemx 21064
7752 Schedules as an EV4 and has no instruction set extensions.
7754 @item ev5
7755 @itemx 21164
7756 Schedules as an EV5 and has no instruction set extensions.
7758 @item ev56
7759 @itemx 21164a
7760 Schedules as an EV5 and supports the BWX extension.
7762 @item pca56
7763 @itemx 21164pc
7764 @itemx 21164PC
7765 Schedules as an EV5 and supports the BWX and MAX extensions.
7767 @item ev6
7768 @itemx 21264
7769 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7771 @item ev67
7772 @itemx 21264a
7773 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7774 @end table
7776 @item -mtune=@var{cpu_type}
7777 @opindex mtune
7778 Set only the instruction scheduling parameters for machine type
7779 @var{cpu_type}.  The instruction set is not changed.
7781 @item -mmemory-latency=@var{time}
7782 @opindex mmemory-latency
7783 Sets the latency the scheduler should assume for typical memory
7784 references as seen by the application.  This number is highly
7785 dependent on the memory access patterns used by the application
7786 and the size of the external cache on the machine.
7788 Valid options for @var{time} are
7790 @table @samp
7791 @item @var{number}
7792 A decimal number representing clock cycles.
7794 @item L1
7795 @itemx L2
7796 @itemx L3
7797 @itemx main
7798 The compiler contains estimates of the number of clock cycles for
7799 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
7800 (also called Dcache, Scache, and Bcache), as well as to main memory.
7801 Note that L3 is only valid for EV5.
7803 @end table
7804 @end table
7806 @node DEC Alpha/VMS Options
7807 @subsection DEC Alpha/VMS Options
7809 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
7811 @table @gcctabopt
7812 @item -mvms-return-codes
7813 @opindex mvms-return-codes
7814 Return VMS condition codes from main.  The default is to return POSIX
7815 style condition (e.g.@ error) codes.
7816 @end table
7818 @node FRV Options
7819 @subsection FRV Options
7820 @cindex FRV Options
7822 @table @gcctabopt
7823 @item -mgpr-32
7824 @opindex mgpr-32
7826 Only use the first 32 general purpose registers.
7828 @item -mgpr-64
7829 @opindex mgpr-64
7831 Use all 64 general purpose registers.
7833 @item -mfpr-32
7834 @opindex mfpr-32
7836 Use only the first 32 floating point registers.
7838 @item -mfpr-64
7839 @opindex mfpr-64
7841 Use all 64 floating point registers
7843 @item -mhard-float
7844 @opindex mhard-float
7846 Use hardware instructions for floating point operations.
7848 @item -msoft-float
7849 @opindex msoft-float
7851 Use library routines for floating point operations.
7853 @item -malloc-cc
7854 @opindex malloc-cc
7856 Dynamically allocate condition code registers.
7858 @item -mfixed-cc
7859 @opindex mfixed-cc
7861 Do not try to dynamically allocate condition code registers, only
7862 use @code{icc0} and @code{fcc0}.
7864 @item -mdword
7865 @opindex mdword
7867 Change ABI to use double word insns.
7869 @item -mno-dword
7870 @opindex mno-dword
7872 Do not use double word instructions.
7874 @item -mdouble
7875 @opindex mdouble
7877 Use floating point double instructions.
7879 @item -mno-double
7880 @opindex mno-double
7882 Do not use floating point double instructions.
7884 @item -mmedia
7885 @opindex mmedia
7887 Use media instructions.
7889 @item -mno-media
7890 @opindex mno-media
7892 Do not use media instructions.
7894 @item -mmuladd
7895 @opindex mmuladd
7897 Use multiply and add/subtract instructions.
7899 @item -mno-muladd
7900 @opindex mno-muladd
7902 Do not use multiply and add/subtract instructions.
7904 @item -mfdpic
7905 @opindex mfdpic
7907 Select the FDPIC ABI, that uses function descriptors to represent
7908 pointers to functions.  Without any PIC/PIE-related options, it
7909 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
7910 assumes GOT entries and small data are within a 12-bit range from the
7911 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
7912 are computed with 32 bits.
7914 @item -minline-plt
7915 @opindex minline-plt
7917 Enable inlining of PLT entries in function calls to functions that are
7918 not known to bind locally.  It has no effect without @option{-mfdpic}.
7919 It's enabled by default if optimizing for speed and compiling for
7920 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
7921 optimization option such as @option{-O3} or above is present in the
7922 command line.
7924 @item -mTLS
7925 @opindex TLS
7927 Assume a large TLS segment when generating thread-local code.
7929 @item -mtls
7930 @opindex tls
7932 Do not assume a large TLS segment when generating thread-local code.
7934 @item -mgprel-ro
7935 @opindex mgprel-ro
7937 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
7938 that is known to be in read-only sections.  It's enabled by default,
7939 except for @option{-fpic} or @option{-fpie}: even though it may help
7940 make the global offset table smaller, it trades 1 instruction for 4.
7941 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
7942 one of which may be shared by multiple symbols, and it avoids the need
7943 for a GOT entry for the referenced symbol, so it's more likely to be a
7944 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
7946 @item -multilib-library-pic
7947 @opindex multilib-library-pic
7949 Link with the (library, not FD) pic libraries.  It's implied by
7950 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
7951 @option{-fpic} without @option{-mfdpic}.  You should never have to use
7952 it explicitly.
7954 @item -mlinked-fp
7955 @opindex mlinked-fp
7957 Follow the EABI requirement of always creating a frame pointer whenever
7958 a stack frame is allocated.  This option is enabled by default and can
7959 be disabled with @option{-mno-linked-fp}.
7961 @item -mlong-calls
7962 @opindex mlong-calls
7964 Use indirect addressing to call functions outside the current
7965 compilation unit.  This allows the functions to be placed anywhere
7966 within the 32-bit address space.
7968 @item -malign-labels
7969 @opindex malign-labels
7971 Try to align labels to an 8-byte boundary by inserting nops into the
7972 previous packet.  This option only has an effect when VLIW packing
7973 is enabled.  It doesn't create new packets; it merely adds nops to
7974 existing ones.
7976 @item -mlibrary-pic
7977 @opindex mlibrary-pic
7979 Generate position-independent EABI code.
7981 @item -macc-4
7982 @opindex macc-4
7984 Use only the first four media accumulator registers.
7986 @item -macc-8
7987 @opindex macc-8
7989 Use all eight media accumulator registers.
7991 @item -mpack
7992 @opindex mpack
7994 Pack VLIW instructions.
7996 @item -mno-pack
7997 @opindex mno-pack
7999 Do not pack VLIW instructions.
8001 @item -mno-eflags
8002 @opindex mno-eflags
8004 Do not mark ABI switches in e_flags.
8006 @item -mcond-move
8007 @opindex mcond-move
8009 Enable the use of conditional-move instructions (default).
8011 This switch is mainly for debugging the compiler and will likely be removed
8012 in a future version.
8014 @item -mno-cond-move
8015 @opindex mno-cond-move
8017 Disable the use of conditional-move instructions.
8019 This switch is mainly for debugging the compiler and will likely be removed
8020 in a future version.
8022 @item -mscc
8023 @opindex mscc
8025 Enable the use of conditional set instructions (default).
8027 This switch is mainly for debugging the compiler and will likely be removed
8028 in a future version.
8030 @item -mno-scc
8031 @opindex mno-scc
8033 Disable the use of conditional set instructions.
8035 This switch is mainly for debugging the compiler and will likely be removed
8036 in a future version.
8038 @item -mcond-exec
8039 @opindex mcond-exec
8041 Enable the use of conditional execution (default).
8043 This switch is mainly for debugging the compiler and will likely be removed
8044 in a future version.
8046 @item -mno-cond-exec
8047 @opindex mno-cond-exec
8049 Disable the use of conditional execution.
8051 This switch is mainly for debugging the compiler and will likely be removed
8052 in a future version.
8054 @item -mvliw-branch
8055 @opindex mvliw-branch
8057 Run a pass to pack branches into VLIW instructions (default).
8059 This switch is mainly for debugging the compiler and will likely be removed
8060 in a future version.
8062 @item -mno-vliw-branch
8063 @opindex mno-vliw-branch
8065 Do not run a pass to pack branches into VLIW instructions.
8067 This switch is mainly for debugging the compiler and will likely be removed
8068 in a future version.
8070 @item -mmulti-cond-exec
8071 @opindex mmulti-cond-exec
8073 Enable optimization of @code{&&} and @code{||} in conditional execution
8074 (default).
8076 This switch is mainly for debugging the compiler and will likely be removed
8077 in a future version.
8079 @item -mno-multi-cond-exec
8080 @opindex mno-multi-cond-exec
8082 Disable optimization of @code{&&} and @code{||} in conditional execution.
8084 This switch is mainly for debugging the compiler and will likely be removed
8085 in a future version.
8087 @item -mnested-cond-exec
8088 @opindex mnested-cond-exec
8090 Enable nested conditional execution optimizations (default).
8092 This switch is mainly for debugging the compiler and will likely be removed
8093 in a future version.
8095 @item -mno-nested-cond-exec
8096 @opindex mno-nested-cond-exec
8098 Disable nested conditional execution optimizations.
8100 This switch is mainly for debugging the compiler and will likely be removed
8101 in a future version.
8103 @item -mtomcat-stats
8104 @opindex mtomcat-stats
8106 Cause gas to print out tomcat statistics.
8108 @item -mcpu=@var{cpu}
8109 @opindex mcpu
8111 Select the processor type for which to generate code.  Possible values are
8112 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8113 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8115 @end table
8117 @node H8/300 Options
8118 @subsection H8/300 Options
8120 These @samp{-m} options are defined for the H8/300 implementations:
8122 @table @gcctabopt
8123 @item -mrelax
8124 @opindex mrelax
8125 Shorten some address references at link time, when possible; uses the
8126 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
8127 ld, Using ld}, for a fuller description.
8129 @item -mh
8130 @opindex mh
8131 Generate code for the H8/300H@.
8133 @item -ms
8134 @opindex ms
8135 Generate code for the H8S@.
8137 @item -mn
8138 @opindex mn
8139 Generate code for the H8S and H8/300H in the normal mode.  This switch
8140 must be used either with @option{-mh} or @option{-ms}.
8142 @item -ms2600
8143 @opindex ms2600
8144 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
8146 @item -mint32
8147 @opindex mint32
8148 Make @code{int} data 32 bits by default.
8150 @item -malign-300
8151 @opindex malign-300
8152 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8153 The default for the H8/300H and H8S is to align longs and floats on 4
8154 byte boundaries.
8155 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8156 This option has no effect on the H8/300.
8157 @end table
8159 @node HPPA Options
8160 @subsection HPPA Options
8161 @cindex HPPA Options
8163 These @samp{-m} options are defined for the HPPA family of computers:
8165 @table @gcctabopt
8166 @item -march=@var{architecture-type}
8167 @opindex march
8168 Generate code for the specified architecture.  The choices for
8169 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8170 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
8171 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8172 architecture option for your machine.  Code compiled for lower numbered
8173 architectures will run on higher numbered architectures, but not the
8174 other way around.
8176 @item -mpa-risc-1-0
8177 @itemx -mpa-risc-1-1
8178 @itemx -mpa-risc-2-0
8179 @opindex mpa-risc-1-0
8180 @opindex mpa-risc-1-1
8181 @opindex mpa-risc-2-0
8182 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8184 @item -mbig-switch
8185 @opindex mbig-switch
8186 Generate code suitable for big switch tables.  Use this option only if
8187 the assembler/linker complain about out of range branches within a switch
8188 table.
8190 @item -mjump-in-delay
8191 @opindex mjump-in-delay
8192 Fill delay slots of function calls with unconditional jump instructions
8193 by modifying the return pointer for the function call to be the target
8194 of the conditional jump.
8196 @item -mdisable-fpregs
8197 @opindex mdisable-fpregs
8198 Prevent floating point registers from being used in any manner.  This is
8199 necessary for compiling kernels which perform lazy context switching of
8200 floating point registers.  If you use this option and attempt to perform
8201 floating point operations, the compiler will abort.
8203 @item -mdisable-indexing
8204 @opindex mdisable-indexing
8205 Prevent the compiler from using indexing address modes.  This avoids some
8206 rather obscure problems when compiling MIG generated code under MACH@.
8208 @item -mno-space-regs
8209 @opindex mno-space-regs
8210 Generate code that assumes the target has no space registers.  This allows
8211 GCC to generate faster indirect calls and use unscaled index address modes.
8213 Such code is suitable for level 0 PA systems and kernels.
8215 @item -mfast-indirect-calls
8216 @opindex mfast-indirect-calls
8217 Generate code that assumes calls never cross space boundaries.  This
8218 allows GCC to emit code which performs faster indirect calls.
8220 This option will not work in the presence of shared libraries or nested
8221 functions.
8223 @item -mfixed-range=@var{register-range}
8224 @opindex mfixed-range
8225 Generate code treating the given register range as fixed registers.
8226 A fixed register is one that the register allocator can not use.  This is
8227 useful when compiling kernel code.  A register range is specified as
8228 two registers separated by a dash.  Multiple register ranges can be
8229 specified separated by a comma.
8231 @item -mlong-load-store
8232 @opindex mlong-load-store
8233 Generate 3-instruction load and store sequences as sometimes required by
8234 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
8235 the HP compilers.
8237 @item -mportable-runtime
8238 @opindex mportable-runtime
8239 Use the portable calling conventions proposed by HP for ELF systems.
8241 @item -mgas
8242 @opindex mgas
8243 Enable the use of assembler directives only GAS understands.
8245 @item -mschedule=@var{cpu-type}
8246 @opindex mschedule
8247 Schedule code according to the constraints for the machine type
8248 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
8249 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
8250 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8251 proper scheduling option for your machine.  The default scheduling is
8252 @samp{8000}.
8254 @item -mlinker-opt
8255 @opindex mlinker-opt
8256 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
8257 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
8258 linkers in which they give bogus error messages when linking some programs.
8260 @item -msoft-float
8261 @opindex msoft-float
8262 Generate output containing library calls for floating point.
8263 @strong{Warning:} the requisite libraries are not available for all HPPA
8264 targets.  Normally the facilities of the machine's usual C compiler are
8265 used, but this cannot be done directly in cross-compilation.  You must make
8266 your own arrangements to provide suitable library functions for
8267 cross-compilation.  The embedded target @samp{hppa1.1-*-pro}
8268 does provide software floating point support.
8270 @option{-msoft-float} changes the calling convention in the output file;
8271 therefore, it is only useful if you compile @emph{all} of a program with
8272 this option.  In particular, you need to compile @file{libgcc.a}, the
8273 library that comes with GCC, with @option{-msoft-float} in order for
8274 this to work.
8276 @item -msio
8277 @opindex msio
8278 Generate the predefine, @code{_SIO}, for server IO@.  The default is
8279 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
8280 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
8281 options are available under HP-UX and HI-UX@.
8283 @item -mgnu-ld
8284 @opindex gnu-ld
8285 Use GNU ld specific options.  This passes @option{-shared} to ld when
8286 building a shared library.  It is the default when GCC is configured,
8287 explicitly or implicitly, with the GNU linker.  This option does not
8288 have any affect on which ld is called, it only changes what parameters
8289 are passed to that ld.  The ld that is called is determined by the
8290 @option{--with-ld} configure option, GCC's program search path, and
8291 finally by the user's @env{PATH}.  The linker used by GCC can be printed
8292 using @samp{which `gcc -print-prog-name=ld`}.
8294 @item -mhp-ld
8295 @opindex hp-ld
8296 Use HP ld specific options.  This passes @option{-b} to ld when building
8297 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8298 links.  It is the default when GCC is configured, explicitly or
8299 implicitly, with the HP linker.  This option does not have any affect on
8300 which ld is called, it only changes what parameters are passed to that
8301 ld.  The ld that is called is determined by the @option{--with-ld}
8302 configure option, GCC's program search path, and finally by the user's
8303 @env{PATH}.  The linker used by GCC can be printed using @samp{which
8304 `gcc -print-prog-name=ld`}.
8306 @item -mlong-calls
8307 @opindex mno-long-calls
8308 Generate code that uses long call sequences.  This ensures that a call
8309 is always able to reach linker generated stubs.  The default is to generate
8310 long calls only when the distance from the call site to the beginning
8311 of the function or translation unit, as the case may be, exceeds a
8312 predefined limit set by the branch type being used.  The limits for
8313 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8314 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
8315 240,000 bytes.
8317 Distances are measured from the beginning of functions when using the
8318 @option{-ffunction-sections} option, or when using the @option{-mgas}
8319 and @option{-mno-portable-runtime} options together under HP-UX with
8320 the SOM linker.
8322 It is normally not desirable to use this option as it will degrade
8323 performance.  However, it may be useful in large applications,
8324 particularly when partial linking is used to build the application.
8326 The types of long calls used depends on the capabilities of the
8327 assembler and linker, and the type of code being generated.  The
8328 impact on systems that support long absolute calls, and long pic
8329 symbol-difference or pc-relative calls should be relatively small.
8330 However, an indirect call is used on 32-bit ELF systems in pic code
8331 and it is quite long.
8333 @item -munix=@var{unix-std}
8334 @opindex march
8335 Generate compiler predefines and select a startfile for the specified
8336 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
8337 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
8338 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
8339 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
8340 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8341 and later.
8343 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8344 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8345 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8346 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8347 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8348 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8350 It is @emph{important} to note that this option changes the interfaces
8351 for various library routines.  It also affects the operational behavior
8352 of the C library.  Thus, @emph{extreme} care is needed in using this
8353 option.
8355 Library code that is intended to operate with more than one UNIX
8356 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8357 as appropriate.  Most GNU software doesn't provide this capability.
8359 @item -nolibdld
8360 @opindex nolibdld
8361 Suppress the generation of link options to search libdld.sl when the
8362 @option{-static} option is specified on HP-UX 10 and later.
8364 @item -static
8365 @opindex static
8366 The HP-UX implementation of setlocale in libc has a dependency on
8367 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
8368 when the @option{-static} option is specified, special link options
8369 are needed to resolve this dependency.
8371 On HP-UX 10 and later, the GCC driver adds the necessary options to
8372 link with libdld.sl when the @option{-static} option is specified.
8373 This causes the resulting binary to be dynamic.  On the 64-bit port,
8374 the linkers generate dynamic binaries by default in any case.  The
8375 @option{-nolibdld} option can be used to prevent the GCC driver from
8376 adding these link options.
8378 @item -threads
8379 @opindex threads
8380 Add support for multithreading with the @dfn{dce thread} library
8381 under HP-UX@.  This option sets flags for both the preprocessor and
8382 linker.
8383 @end table
8385 @node i386 and x86-64 Options
8386 @subsection Intel 386 and AMD x86-64 Options
8387 @cindex i386 Options
8388 @cindex x86-64 Options
8389 @cindex Intel 386 Options
8390 @cindex AMD x86-64 Options
8392 These @samp{-m} options are defined for the i386 and x86-64 family of
8393 computers:
8395 @table @gcctabopt
8396 @item -mtune=@var{cpu-type}
8397 @opindex mtune
8398 Tune to @var{cpu-type} everything applicable about the generated code, except
8399 for the ABI and the set of available instructions.  The choices for
8400 @var{cpu-type} are:
8401 @table @emph
8402 @item i386
8403 Original Intel's i386 CPU@.
8404 @item i486
8405 Intel's i486 CPU@.  (No scheduling is implemented for this chip.)
8406 @item i586, pentium
8407 Intel Pentium CPU with no MMX support.
8408 @item pentium-mmx
8409 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8410 @item i686, pentiumpro
8411 Intel PentiumPro CPU@.
8412 @item pentium2
8413 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8414 @item pentium3, pentium3m
8415 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8416 support.
8417 @item pentium-m
8418 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8419 support.  Used by Centrino notebooks.
8420 @item pentium4, pentium4m
8421 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8422 @item prescott
8423 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8424 set support.
8425 @item nocona
8426 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8427 SSE2 and SSE3 instruction set support.
8428 @item k6
8429 AMD K6 CPU with MMX instruction set support.
8430 @item k6-2, k6-3
8431 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8432 @item athlon, athlon-tbird
8433 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8434 support.
8435 @item athlon-4, athlon-xp, athlon-mp
8436 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8437 instruction set support.
8438 @item k8, opteron, athlon64, athlon-fx
8439 AMD K8 core based CPUs with x86-64 instruction set support.  (This supersets
8440 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8441 @item winchip-c6
8442 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8443 set support.
8444 @item winchip2
8445 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8446 instruction set support.
8447 @item c3
8448 Via C3 CPU with MMX and 3dNOW! instruction set support.  (No scheduling is
8449 implemented for this chip.)
8450 @item c3-2
8451 Via C3-2 CPU with MMX and SSE instruction set support.  (No scheduling is
8452 implemented for this chip.)
8453 @end table
8455 While picking a specific @var{cpu-type} will schedule things appropriately
8456 for that particular chip, the compiler will not generate any code that
8457 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8458 being used.
8460 @item -march=@var{cpu-type}
8461 @opindex march
8462 Generate instructions for the machine type @var{cpu-type}.  The choices
8463 for @var{cpu-type} are the same as for @option{-mtune}.  Moreover,
8464 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8466 @item -mcpu=@var{cpu-type}
8467 @opindex mcpu
8468 A deprecated synonym for @option{-mtune}.
8470 @item -m386
8471 @itemx -m486
8472 @itemx -mpentium
8473 @itemx -mpentiumpro
8474 @opindex m386
8475 @opindex m486
8476 @opindex mpentium
8477 @opindex mpentiumpro
8478 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8479 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8480 These synonyms are deprecated.
8482 @item -mfpmath=@var{unit}
8483 @opindex march
8484 Generate floating point arithmetics for selected unit @var{unit}.  The choices
8485 for @var{unit} are:
8487 @table @samp
8488 @item 387
8489 Use the standard 387 floating point coprocessor present majority of chips and
8490 emulated otherwise.  Code compiled with this option will run almost everywhere.
8491 The temporary results are computed in 80bit precision instead of precision
8492 specified by the type resulting in slightly different results compared to most
8493 of other chips.  See @option{-ffloat-store} for more detailed description.
8495 This is the default choice for i386 compiler.
8497 @item sse
8498 Use scalar floating point instructions present in the SSE instruction set.
8499 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8500 by Athlon-4, Athlon-xp and Athlon-mp chips.  The earlier version of SSE
8501 instruction set supports only single precision arithmetics, thus the double and
8502 extended precision arithmetics is still done using 387.  Later version, present
8503 only in Pentium4 and the future AMD x86-64 chips supports double precision
8504 arithmetics too.
8506 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8507 or @option{-msse2} switches to enable SSE extensions and make this option
8508 effective.  For the x86-64 compiler, these extensions are enabled by default.
8510 The resulting code should be considerably faster in the majority of cases and avoid
8511 the numerical instability problems of 387 code, but may break some existing
8512 code that expects temporaries to be 80bit.
8514 This is the default choice for the x86-64 compiler.
8516 @item sse,387
8517 Attempt to utilize both instruction sets at once.  This effectively double the
8518 amount of available registers and on chips with separate execution units for
8519 387 and SSE the execution resources too.  Use this option with care, as it is
8520 still experimental, because the GCC register allocator does not model separate
8521 functional units well resulting in instable performance.
8522 @end table
8524 @item -masm=@var{dialect}
8525 @opindex masm=@var{dialect}
8526 Output asm instructions using selected @var{dialect}.  Supported choices are
8527 @samp{intel} or @samp{att} (the default one).
8529 @item -mieee-fp
8530 @itemx -mno-ieee-fp
8531 @opindex mieee-fp
8532 @opindex mno-ieee-fp
8533 Control whether or not the compiler uses IEEE floating point
8534 comparisons.  These handle correctly the case where the result of a
8535 comparison is unordered.
8537 @item -msoft-float
8538 @opindex msoft-float
8539 Generate output containing library calls for floating point.
8540 @strong{Warning:} the requisite libraries are not part of GCC@.
8541 Normally the facilities of the machine's usual C compiler are used, but
8542 this can't be done directly in cross-compilation.  You must make your
8543 own arrangements to provide suitable library functions for
8544 cross-compilation.
8546 On machines where a function returns floating point results in the 80387
8547 register stack, some floating point opcodes may be emitted even if
8548 @option{-msoft-float} is used.
8550 @item -mno-fp-ret-in-387
8551 @opindex mno-fp-ret-in-387
8552 Do not use the FPU registers for return values of functions.
8554 The usual calling convention has functions return values of types
8555 @code{float} and @code{double} in an FPU register, even if there
8556 is no FPU@.  The idea is that the operating system should emulate
8557 an FPU@.
8559 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8560 in ordinary CPU registers instead.
8562 @item -mno-fancy-math-387
8563 @opindex mno-fancy-math-387
8564 Some 387 emulators do not support the @code{sin}, @code{cos} and
8565 @code{sqrt} instructions for the 387.  Specify this option to avoid
8566 generating those instructions.  This option is the default on FreeBSD,
8567 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
8568 indicates that the target cpu will always have an FPU and so the
8569 instruction will not need emulation.  As of revision 2.6.1, these
8570 instructions are not generated unless you also use the
8571 @option{-funsafe-math-optimizations} switch.
8573 @item -malign-double
8574 @itemx -mno-align-double
8575 @opindex malign-double
8576 @opindex mno-align-double
8577 Control whether GCC aligns @code{double}, @code{long double}, and
8578 @code{long long} variables on a two word boundary or a one word
8579 boundary.  Aligning @code{double} variables on a two word boundary will
8580 produce code that runs somewhat faster on a @samp{Pentium} at the
8581 expense of more memory.
8583 @strong{Warning:} if you use the @option{-malign-double} switch,
8584 structures containing the above types will be aligned differently than
8585 the published application binary interface specifications for the 386
8586 and will not be binary compatible with structures in code compiled
8587 without that switch.
8589 @item -m96bit-long-double
8590 @itemx -m128bit-long-double
8591 @opindex m96bit-long-double
8592 @opindex m128bit-long-double
8593 These switches control the size of @code{long double} type.  The i386
8594 application binary interface specifies the size to be 96 bits,
8595 so @option{-m96bit-long-double} is the default in 32 bit mode.
8597 Modern architectures (Pentium and newer) would prefer @code{long double}
8598 to be aligned to an 8 or 16 byte boundary.  In arrays or structures
8599 conforming to the ABI, this would not be possible.  So specifying a
8600 @option{-m128bit-long-double} will align @code{long double}
8601 to a 16 byte boundary by padding the @code{long double} with an additional
8602 32 bit zero.
8604 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8605 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8607 Notice that neither of these options enable any extra precision over the x87
8608 standard of 80 bits for a @code{long double}.
8610 @strong{Warning:} if you override the default value for your target ABI, the
8611 structures and arrays containing @code{long double} variables will change
8612 their size as well as function calling convention for function taking
8613 @code{long double} will be modified.  Hence they will not be binary
8614 compatible with arrays or structures in code compiled without that switch.
8617 @item -msvr3-shlib
8618 @itemx -mno-svr3-shlib
8619 @opindex msvr3-shlib
8620 @opindex mno-svr3-shlib
8621 Control whether GCC places uninitialized local variables into the
8622 @code{bss} or @code{data} segments.  @option{-msvr3-shlib} places them
8623 into @code{bss}.  These options are meaningful only on System V Release 3.
8625 @item -mrtd
8626 @opindex mrtd
8627 Use a different function-calling convention, in which functions that
8628 take a fixed number of arguments return with the @code{ret} @var{num}
8629 instruction, which pops their arguments while returning.  This saves one
8630 instruction in the caller since there is no need to pop the arguments
8631 there.
8633 You can specify that an individual function is called with this calling
8634 sequence with the function attribute @samp{stdcall}.  You can also
8635 override the @option{-mrtd} option by using the function attribute
8636 @samp{cdecl}.  @xref{Function Attributes}.
8638 @strong{Warning:} this calling convention is incompatible with the one
8639 normally used on Unix, so you cannot use it if you need to call
8640 libraries compiled with the Unix compiler.
8642 Also, you must provide function prototypes for all functions that
8643 take variable numbers of arguments (including @code{printf});
8644 otherwise incorrect code will be generated for calls to those
8645 functions.
8647 In addition, seriously incorrect code will result if you call a
8648 function with too many arguments.  (Normally, extra arguments are
8649 harmlessly ignored.)
8651 @item -mregparm=@var{num}
8652 @opindex mregparm
8653 Control how many registers are used to pass integer arguments.  By
8654 default, no registers are used to pass arguments, and at most 3
8655 registers can be used.  You can control this behavior for a specific
8656 function by using the function attribute @samp{regparm}.
8657 @xref{Function Attributes}.
8659 @strong{Warning:} if you use this switch, and
8660 @var{num} is nonzero, then you must build all modules with the same
8661 value, including any libraries.  This includes the system libraries and
8662 startup modules.
8664 @item -mpreferred-stack-boundary=@var{num}
8665 @opindex mpreferred-stack-boundary
8666 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8667 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
8668 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8669 size (@option{-Os}), in which case the default is the minimum correct
8670 alignment (4 bytes for x86, and 8 bytes for x86-64).
8672 On Pentium and PentiumPro, @code{double} and @code{long double} values
8673 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8674 suffer significant run time performance penalties.  On Pentium III, the
8675 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8676 penalties if it is not 16 byte aligned.
8678 To ensure proper alignment of this values on the stack, the stack boundary
8679 must be as aligned as that required by any value stored on the stack.
8680 Further, every function must be generated such that it keeps the stack
8681 aligned.  Thus calling a function compiled with a higher preferred
8682 stack boundary from a function compiled with a lower preferred stack
8683 boundary will most likely misalign the stack.  It is recommended that
8684 libraries that use callbacks always use the default setting.
8686 This extra alignment does consume extra stack space, and generally
8687 increases code size.  Code that is sensitive to stack space usage, such
8688 as embedded systems and operating system kernels, may want to reduce the
8689 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8691 @item -mmmx
8692 @itemx -mno-mmx
8693 @item -msse
8694 @itemx -mno-sse
8695 @item -msse2
8696 @itemx -mno-sse2
8697 @item -msse3
8698 @itemx -mno-sse3
8699 @item -m3dnow
8700 @itemx -mno-3dnow
8701 @opindex mmmx
8702 @opindex mno-mmx
8703 @opindex msse
8704 @opindex mno-sse
8705 @opindex m3dnow
8706 @opindex mno-3dnow
8707 These switches enable or disable the use of built-in functions that allow
8708 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8709 instruction set.
8711 @xref{X86 Built-in Functions}, for details of the functions enabled
8712 and disabled by these switches.
8714 To have SSE/SSE2 instructions generated automatically from floating-point
8715 code, see @option{-mfpmath=sse}.
8717 @item -mpush-args
8718 @itemx -mno-push-args
8719 @opindex mpush-args
8720 @opindex mno-push-args
8721 Use PUSH operations to store outgoing parameters.  This method is shorter
8722 and usually equally fast as method using SUB/MOV operations and is enabled
8723 by default.  In some cases disabling it may improve performance because of
8724 improved scheduling and reduced dependencies.
8726 @item -maccumulate-outgoing-args
8727 @opindex maccumulate-outgoing-args
8728 If enabled, the maximum amount of space required for outgoing arguments will be
8729 computed in the function prologue.  This is faster on most modern CPUs
8730 because of reduced dependencies, improved scheduling and reduced stack usage
8731 when preferred stack boundary is not equal to 2.  The drawback is a notable
8732 increase in code size.  This switch implies @option{-mno-push-args}.
8734 @item -mthreads
8735 @opindex mthreads
8736 Support thread-safe exception handling on @samp{Mingw32}.  Code that relies
8737 on thread-safe exception handling must compile and link all code with the
8738 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
8739 @option{-D_MT}; when linking, it links in a special thread helper library
8740 @option{-lmingwthrd} which cleans up per thread exception handling data.
8742 @item -mno-align-stringops
8743 @opindex mno-align-stringops
8744 Do not align destination of inlined string operations.  This switch reduces
8745 code size and improves performance in case the destination is already aligned,
8746 but GCC doesn't know about it.
8748 @item -minline-all-stringops
8749 @opindex minline-all-stringops
8750 By default GCC inlines string operations only when destination is known to be
8751 aligned at least to 4 byte boundary.  This enables more inlining, increase code
8752 size, but may improve performance of code that depends on fast memcpy, strlen
8753 and memset for short lengths.
8755 @item -momit-leaf-frame-pointer
8756 @opindex momit-leaf-frame-pointer
8757 Don't keep the frame pointer in a register for leaf functions.  This
8758 avoids the instructions to save, set up and restore frame pointers and
8759 makes an extra register available in leaf functions.  The option
8760 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8761 which might make debugging harder.
8763 @item -mtls-direct-seg-refs
8764 @itemx -mno-tls-direct-seg-refs
8765 @opindex mtls-direct-seg-refs
8766 Controls whether TLS variables may be accessed with offsets from the
8767 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8768 or whether the thread base pointer must be added.  Whether or not this
8769 is legal depends on the operating system, and whether it maps the
8770 segment to cover the entire TLS area.
8772 For systems that use GNU libc, the default is on.
8773 @end table
8775 These @samp{-m} switches are supported in addition to the above
8776 on AMD x86-64 processors in 64-bit environments.
8778 @table @gcctabopt
8779 @item -m32
8780 @itemx -m64
8781 @opindex m32
8782 @opindex m64
8783 Generate code for a 32-bit or 64-bit environment.
8784 The 32-bit environment sets int, long and pointer to 32 bits and
8785 generates code that runs on any i386 system.
8786 The 64-bit environment sets int to 32 bits and long and pointer
8787 to 64 bits and generates code for AMD's x86-64 architecture.
8789 @item -mno-red-zone
8790 @opindex no-red-zone
8791 Do not use a so called red zone for x86-64 code.  The red zone is mandated
8792 by the x86-64 ABI, it is a 128-byte area beyond the location of the
8793 stack pointer that will not be modified by signal or interrupt handlers
8794 and therefore can be used for temporary data without adjusting the stack
8795 pointer.  The flag @option{-mno-red-zone} disables this red zone.
8797 @item -mcmodel=small
8798 @opindex mcmodel=small
8799 Generate code for the small code model: the program and its symbols must
8800 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
8801 Programs can be statically or dynamically linked.  This is the default
8802 code model.
8804 @item -mcmodel=kernel
8805 @opindex mcmodel=kernel
8806 Generate code for the kernel code model.  The kernel runs in the
8807 negative 2 GB of the address space.
8808 This model has to be used for Linux kernel code.
8810 @item -mcmodel=medium
8811 @opindex mcmodel=medium
8812 Generate code for the medium model: The program is linked in the lower 2
8813 GB of the address space but symbols can be located anywhere in the
8814 address space.  Programs can be statically or dynamically linked, but
8815 building of shared libraries are not supported with the medium model.
8817 @item -mcmodel=large
8818 @opindex mcmodel=large
8819 Generate code for the large model: This model makes no assumptions
8820 about addresses and sizes of sections.  Currently GCC does not implement
8821 this model.
8822 @end table
8824 @node IA-64 Options
8825 @subsection IA-64 Options
8826 @cindex IA-64 Options
8828 These are the @samp{-m} options defined for the Intel IA-64 architecture.
8830 @table @gcctabopt
8831 @item -mbig-endian
8832 @opindex mbig-endian
8833 Generate code for a big endian target.  This is the default for HP-UX@.
8835 @item -mlittle-endian
8836 @opindex mlittle-endian
8837 Generate code for a little endian target.  This is the default for AIX5
8838 and GNU/Linux.
8840 @item -mgnu-as
8841 @itemx -mno-gnu-as
8842 @opindex mgnu-as
8843 @opindex mno-gnu-as
8844 Generate (or don't) code for the GNU assembler.  This is the default.
8845 @c Also, this is the default if the configure option @option{--with-gnu-as}
8846 @c is used.
8848 @item -mgnu-ld
8849 @itemx -mno-gnu-ld
8850 @opindex mgnu-ld
8851 @opindex mno-gnu-ld
8852 Generate (or don't) code for the GNU linker.  This is the default.
8853 @c Also, this is the default if the configure option @option{--with-gnu-ld}
8854 @c is used.
8856 @item -mno-pic
8857 @opindex mno-pic
8858 Generate code that does not use a global pointer register.  The result
8859 is not position independent code, and violates the IA-64 ABI@.
8861 @item -mvolatile-asm-stop
8862 @itemx -mno-volatile-asm-stop
8863 @opindex mvolatile-asm-stop
8864 @opindex mno-volatile-asm-stop
8865 Generate (or don't) a stop bit immediately before and after volatile asm
8866 statements.
8868 @item -mb-step
8869 @opindex mb-step
8870 Generate code that works around Itanium B step errata.
8872 @item -mregister-names
8873 @itemx -mno-register-names
8874 @opindex mregister-names
8875 @opindex mno-register-names
8876 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
8877 the stacked registers.  This may make assembler output more readable.
8879 @item -mno-sdata
8880 @itemx -msdata
8881 @opindex mno-sdata
8882 @opindex msdata
8883 Disable (or enable) optimizations that use the small data section.  This may
8884 be useful for working around optimizer bugs.
8886 @item -mconstant-gp
8887 @opindex mconstant-gp
8888 Generate code that uses a single constant global pointer value.  This is
8889 useful when compiling kernel code.
8891 @item -mauto-pic
8892 @opindex mauto-pic
8893 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
8894 This is useful when compiling firmware code.
8896 @item -minline-float-divide-min-latency
8897 @opindex minline-float-divide-min-latency
8898 Generate code for inline divides of floating point values
8899 using the minimum latency algorithm.
8901 @item -minline-float-divide-max-throughput
8902 @opindex minline-float-divide-max-throughput
8903 Generate code for inline divides of floating point values
8904 using the maximum throughput algorithm.
8906 @item -minline-int-divide-min-latency
8907 @opindex minline-int-divide-min-latency
8908 Generate code for inline divides of integer values
8909 using the minimum latency algorithm.
8911 @item -minline-int-divide-max-throughput
8912 @opindex minline-int-divide-max-throughput
8913 Generate code for inline divides of integer values
8914 using the maximum throughput algorithm.
8916 @item -minline-sqrt-min-latency
8917 @opindex minline-sqrt-min-latency
8918 Generate code for inline square roots
8919 using the minimum latency algorithm.
8921 @item -minline-sqrt-max-throughput
8922 @opindex minline-sqrt-max-throughput
8923 Generate code for inline square roots
8924 using the maximum throughput algorithm.
8926 @item -mno-dwarf2-asm
8927 @itemx -mdwarf2-asm
8928 @opindex mno-dwarf2-asm
8929 @opindex mdwarf2-asm
8930 Don't (or do) generate assembler code for the DWARF2 line number debugging
8931 info.  This may be useful when not using the GNU assembler.
8933 @item -mearly-stop-bits
8934 @itemx -mno-early-stop-bits
8935 @opindex mearly-stop-bits
8936 @opindex mno-early-stop-bits
8937 Allow stop bits to be placed earlier than immediately preceding the
8938 instruction that triggered the stop bit.  This can improve instruction
8939 scheduling, but does not always do so.
8941 @item -mfixed-range=@var{register-range}
8942 @opindex mfixed-range
8943 Generate code treating the given register range as fixed registers.
8944 A fixed register is one that the register allocator can not use.  This is
8945 useful when compiling kernel code.  A register range is specified as
8946 two registers separated by a dash.  Multiple register ranges can be
8947 specified separated by a comma.
8949 @item -mtls-size=@var{tls-size}
8950 @opindex mtls-size
8951 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
8954 @item -mtune-arch=@var{cpu-type}
8955 @opindex mtune-arch
8956 Tune the instruction scheduling for a particular CPU, Valid values are
8957 itanium, itanium1, merced, itanium2, and mckinley.
8959 @item -mt
8960 @itemx -pthread
8961 @opindex mt
8962 @opindex pthread
8963 Add support for multithreading using the POSIX threads library.  This
8964 option sets flags for both the preprocessor and linker.  It does
8965 not affect the thread safety of object code produced by the compiler or
8966 that of libraries supplied with it.  These are HP-UX specific flags.
8968 @item -milp32
8969 @itemx -mlp64
8970 @opindex milp32
8971 @opindex mlp64
8972 Generate code for a 32-bit or 64-bit environment.
8973 The 32-bit environment sets int, long and pointer to 32 bits.
8974 The 64-bit environment sets int to 32 bits and long and pointer
8975 to 64 bits.  These are HP-UX specific flags.
8977 @end table
8979 @node M32R/D Options
8980 @subsection M32R/D Options
8981 @cindex M32R/D options
8983 These @option{-m} options are defined for Renesas M32R/D architectures:
8985 @table @gcctabopt
8986 @item -m32r2
8987 @opindex m32r2
8988 Generate code for the M32R/2@.
8990 @item -m32rx
8991 @opindex m32rx
8992 Generate code for the M32R/X@.
8994 @item -m32r
8995 @opindex m32r
8996 Generate code for the M32R@.  This is the default.
8998 @item -mmodel=small
8999 @opindex mmodel=small
9000 Assume all objects live in the lower 16MB of memory (so that their addresses
9001 can be loaded with the @code{ld24} instruction), and assume all subroutines
9002 are reachable with the @code{bl} instruction.
9003 This is the default.
9005 The addressability of a particular object can be set with the
9006 @code{model} attribute.
9008 @item -mmodel=medium
9009 @opindex mmodel=medium
9010 Assume objects may be anywhere in the 32-bit address space (the compiler
9011 will generate @code{seth/add3} instructions to load their addresses), and
9012 assume all subroutines are reachable with the @code{bl} instruction.
9014 @item -mmodel=large
9015 @opindex mmodel=large
9016 Assume objects may be anywhere in the 32-bit address space (the compiler
9017 will generate @code{seth/add3} instructions to load their addresses), and
9018 assume subroutines may not be reachable with the @code{bl} instruction
9019 (the compiler will generate the much slower @code{seth/add3/jl}
9020 instruction sequence).
9022 @item -msdata=none
9023 @opindex msdata=none
9024 Disable use of the small data area.  Variables will be put into
9025 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9026 @code{section} attribute has been specified).
9027 This is the default.
9029 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9030 Objects may be explicitly put in the small data area with the
9031 @code{section} attribute using one of these sections.
9033 @item -msdata=sdata
9034 @opindex msdata=sdata
9035 Put small global and static data in the small data area, but do not
9036 generate special code to reference them.
9038 @item -msdata=use
9039 @opindex msdata=use
9040 Put small global and static data in the small data area, and generate
9041 special instructions to reference them.
9043 @item -G @var{num}
9044 @opindex G
9045 @cindex smaller data references
9046 Put global and static objects less than or equal to @var{num} bytes
9047 into the small data or bss sections instead of the normal data or bss
9048 sections.  The default value of @var{num} is 8.
9049 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9050 for this option to have any effect.
9052 All modules should be compiled with the same @option{-G @var{num}} value.
9053 Compiling with different values of @var{num} may or may not work; if it
9054 doesn't the linker will give an error message---incorrect code will not be
9055 generated.
9057 @item -mdebug
9058 @opindex mdebug
9059 Makes the M32R specific code in the compiler display some statistics
9060 that might help in debugging programs.
9062 @item -malign-loops
9063 @opindex malign-loops
9064 Align all loops to a 32-byte boundary.
9066 @item -mno-align-loops
9067 @opindex mno-align-loops
9068 Do not enforce a 32-byte alignment for loops.  This is the default.
9070 @item -missue-rate=@var{number}
9071 @opindex missue-rate=@var{number}
9072 Issue @var{number} instructions per cycle.  @var{number} can only be 1
9073 or 2.
9075 @item -mbranch-cost=@var{number}
9076 @opindex mbranch-cost=@var{number}
9077 @var{number} can only be 1 or 2.  If it is 1 then branches will be
9078 preferred over conditional code, if it is 2, then the opposite will
9079 apply.
9081 @item -mflush-trap=@var{number}
9082 @opindex mflush-trap=@var{number}
9083 Specifies the trap number to use to flush the cache.  The default is
9084 12.  Valid numbers are between 0 and 15 inclusive.
9086 @item -mno-flush-trap
9087 @opindex mno-flush-trap
9088 Specifies that the cache cannot be flushed by using a trap.
9090 @item -mflush-func=@var{name}
9091 @opindex mflush-func=@var{name}
9092 Specifies the name of the operating system function to call to flush
9093 the cache.  The default is @emph{_flush_cache}, but a function call
9094 will only be used if a trap is not available.
9096 @item -mno-flush-func
9097 @opindex mno-flush-func
9098 Indicates that there is no OS function for flushing the cache.
9100 @end table
9102 @node M680x0 Options
9103 @subsection M680x0 Options
9104 @cindex M680x0 options
9106 These are the @samp{-m} options defined for the 68000 series.  The default
9107 values for these options depends on which style of 68000 was selected when
9108 the compiler was configured; the defaults for the most common choices are
9109 given below.
9111 @table @gcctabopt
9112 @item -m68000
9113 @itemx -mc68000
9114 @opindex m68000
9115 @opindex mc68000
9116 Generate output for a 68000.  This is the default
9117 when the compiler is configured for 68000-based systems.
9119 Use this option for microcontrollers with a 68000 or EC000 core,
9120 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9122 @item -m68020
9123 @itemx -mc68020
9124 @opindex m68020
9125 @opindex mc68020
9126 Generate output for a 68020.  This is the default
9127 when the compiler is configured for 68020-based systems.
9129 @item -m68881
9130 @opindex m68881
9131 Generate output containing 68881 instructions for floating point.
9132 This is the default for most 68020 systems unless @option{--nfp} was
9133 specified when the compiler was configured.
9135 @item -m68030
9136 @opindex m68030
9137 Generate output for a 68030.  This is the default when the compiler is
9138 configured for 68030-based systems.
9140 @item -m68040
9141 @opindex m68040
9142 Generate output for a 68040.  This is the default when the compiler is
9143 configured for 68040-based systems.
9145 This option inhibits the use of 68881/68882 instructions that have to be
9146 emulated by software on the 68040.  Use this option if your 68040 does not
9147 have code to emulate those instructions.
9149 @item -m68060
9150 @opindex m68060
9151 Generate output for a 68060.  This is the default when the compiler is
9152 configured for 68060-based systems.
9154 This option inhibits the use of 68020 and 68881/68882 instructions that
9155 have to be emulated by software on the 68060.  Use this option if your 68060
9156 does not have code to emulate those instructions.
9158 @item -mcpu32
9159 @opindex mcpu32
9160 Generate output for a CPU32.  This is the default
9161 when the compiler is configured for CPU32-based systems.
9163 Use this option for microcontrollers with a
9164 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9165 68336, 68340, 68341, 68349 and 68360.
9167 @item -m5200
9168 @opindex m5200
9169 Generate output for a 520X ``coldfire'' family cpu.  This is the default
9170 when the compiler is configured for 520X-based systems.
9172 Use this option for microcontroller with a 5200 core, including
9173 the MCF5202, MCF5203, MCF5204 and MCF5202.
9176 @item -m68020-40
9177 @opindex m68020-40
9178 Generate output for a 68040, without using any of the new instructions.
9179 This results in code which can run relatively efficiently on either a
9180 68020/68881 or a 68030 or a 68040.  The generated code does use the
9181 68881 instructions that are emulated on the 68040.
9183 @item -m68020-60
9184 @opindex m68020-60
9185 Generate output for a 68060, without using any of the new instructions.
9186 This results in code which can run relatively efficiently on either a
9187 68020/68881 or a 68030 or a 68040.  The generated code does use the
9188 68881 instructions that are emulated on the 68060.
9190 @item -msoft-float
9191 @opindex msoft-float
9192 Generate output containing library calls for floating point.
9193 @strong{Warning:} the requisite libraries are not available for all m68k
9194 targets.  Normally the facilities of the machine's usual C compiler are
9195 used, but this can't be done directly in cross-compilation.  You must
9196 make your own arrangements to provide suitable library functions for
9197 cross-compilation.  The embedded targets @samp{m68k-*-aout} and
9198 @samp{m68k-*-coff} do provide software floating point support.
9200 @item -mshort
9201 @opindex mshort
9202 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9203 Additionally, parameters passed on the stack are also aligned to a
9204 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9206 @item -mnobitfield
9207 @opindex mnobitfield
9208 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
9209 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9211 @item -mbitfield
9212 @opindex mbitfield
9213 Do use the bit-field instructions.  The @option{-m68020} option implies
9214 @option{-mbitfield}.  This is the default if you use a configuration
9215 designed for a 68020.
9217 @item -mrtd
9218 @opindex mrtd
9219 Use a different function-calling convention, in which functions
9220 that take a fixed number of arguments return with the @code{rtd}
9221 instruction, which pops their arguments while returning.  This
9222 saves one instruction in the caller since there is no need to pop
9223 the arguments there.
9225 This calling convention is incompatible with the one normally
9226 used on Unix, so you cannot use it if you need to call libraries
9227 compiled with the Unix compiler.
9229 Also, you must provide function prototypes for all functions that
9230 take variable numbers of arguments (including @code{printf});
9231 otherwise incorrect code will be generated for calls to those
9232 functions.
9234 In addition, seriously incorrect code will result if you call a
9235 function with too many arguments.  (Normally, extra arguments are
9236 harmlessly ignored.)
9238 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9239 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9241 @item -malign-int
9242 @itemx -mno-align-int
9243 @opindex malign-int
9244 @opindex mno-align-int
9245 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9246 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9247 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9248 Aligning variables on 32-bit boundaries produces code that runs somewhat
9249 faster on processors with 32-bit busses at the expense of more memory.
9251 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9252 align structures containing the above types  differently than
9253 most published application binary interface specifications for the m68k.
9255 @item -mpcrel
9256 @opindex mpcrel
9257 Use the pc-relative addressing mode of the 68000 directly, instead of
9258 using a global offset table.  At present, this option implies @option{-fpic},
9259 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
9260 not presently supported with @option{-mpcrel}, though this could be supported for
9261 68020 and higher processors.
9263 @item -mno-strict-align
9264 @itemx -mstrict-align
9265 @opindex mno-strict-align
9266 @opindex mstrict-align
9267 Do not (do) assume that unaligned memory references will be handled by
9268 the system.
9270 @item -msep-data
9271 Generate code that allows the data segment to be located in a different
9272 area of memory from the text segment.  This allows for execute in place in
9273 an environment without virtual memory management.  This option implies
9274 @option{-fPIC}.
9276 @item -mno-sep-data
9277 Generate code that assumes that the data segment follows the text segment.
9278 This is the default.
9280 @item -mid-shared-library
9281 Generate code that supports shared libraries via the library ID method.
9282 This allows for execute in place and shared libraries in an environment
9283 without virtual memory management.  This option implies @option{-fPIC}.
9285 @item -mno-id-shared-library
9286 Generate code that doesn't assume ID based shared libraries are being used.
9287 This is the default.
9289 @item -mshared-library-id=n
9290 Specified the identification number of the ID based shared library being
9291 compiled.  Specifying a value of 0 will generate more compact code, specifying
9292 other values will force the allocation of that number to the current
9293 library but is no more space or time efficient than omitting this option.
9295 @end table
9297 @node M68hc1x Options
9298 @subsection M68hc1x Options
9299 @cindex M68hc1x options
9301 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9302 microcontrollers.  The default values for these options depends on
9303 which style of microcontroller was selected when the compiler was configured;
9304 the defaults for the most common choices are given below.
9306 @table @gcctabopt
9307 @item -m6811
9308 @itemx -m68hc11
9309 @opindex m6811
9310 @opindex m68hc11
9311 Generate output for a 68HC11.  This is the default
9312 when the compiler is configured for 68HC11-based systems.
9314 @item -m6812
9315 @itemx -m68hc12
9316 @opindex m6812
9317 @opindex m68hc12
9318 Generate output for a 68HC12.  This is the default
9319 when the compiler is configured for 68HC12-based systems.
9321 @item -m68S12
9322 @itemx -m68hcs12
9323 @opindex m68S12
9324 @opindex m68hcs12
9325 Generate output for a 68HCS12.
9327 @item -mauto-incdec
9328 @opindex mauto-incdec
9329 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9330 addressing modes.
9332 @item -minmax
9333 @itemx -nominmax
9334 @opindex minmax
9335 @opindex mnominmax
9336 Enable the use of 68HC12 min and max instructions.
9338 @item -mlong-calls
9339 @itemx -mno-long-calls
9340 @opindex mlong-calls
9341 @opindex mno-long-calls
9342 Treat all calls as being far away (near).  If calls are assumed to be
9343 far away, the compiler will use the @code{call} instruction to
9344 call a function and the @code{rtc} instruction for returning.
9346 @item -mshort
9347 @opindex mshort
9348 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9350 @item -msoft-reg-count=@var{count}
9351 @opindex msoft-reg-count
9352 Specify the number of pseudo-soft registers which are used for the
9353 code generation.  The maximum number is 32.  Using more pseudo-soft
9354 register may or may not result in better code depending on the program.
9355 The default is 4 for 68HC11 and 2 for 68HC12.
9357 @end table
9359 @node MCore Options
9360 @subsection MCore Options
9361 @cindex MCore options
9363 These are the @samp{-m} options defined for the Motorola M*Core
9364 processors.
9366 @table @gcctabopt
9368 @item -mhardlit
9369 @itemx -mno-hardlit
9370 @opindex mhardlit
9371 @opindex mno-hardlit
9372 Inline constants into the code stream if it can be done in two
9373 instructions or less.
9375 @item -mdiv
9376 @itemx -mno-div
9377 @opindex mdiv
9378 @opindex mno-div
9379 Use the divide instruction.  (Enabled by default).
9381 @item -mrelax-immediate
9382 @itemx -mno-relax-immediate
9383 @opindex mrelax-immediate
9384 @opindex mno-relax-immediate
9385 Allow arbitrary sized immediates in bit operations.
9387 @item -mwide-bitfields
9388 @itemx -mno-wide-bitfields
9389 @opindex mwide-bitfields
9390 @opindex mno-wide-bitfields
9391 Always treat bit-fields as int-sized.
9393 @item -m4byte-functions
9394 @itemx -mno-4byte-functions
9395 @opindex m4byte-functions
9396 @opindex mno-4byte-functions
9397 Force all functions to be aligned to a four byte boundary.
9399 @item -mcallgraph-data
9400 @itemx -mno-callgraph-data
9401 @opindex mcallgraph-data
9402 @opindex mno-callgraph-data
9403 Emit callgraph information.
9405 @item -mslow-bytes
9406 @itemx -mno-slow-bytes
9407 @opindex mslow-bytes
9408 @opindex mno-slow-bytes
9409 Prefer word access when reading byte quantities.
9411 @item -mlittle-endian
9412 @itemx -mbig-endian
9413 @opindex mlittle-endian
9414 @opindex mbig-endian
9415 Generate code for a little endian target.
9417 @item -m210
9418 @itemx -m340
9419 @opindex m210
9420 @opindex m340
9421 Generate code for the 210 processor.
9422 @end table
9424 @node MIPS Options
9425 @subsection MIPS Options
9426 @cindex MIPS options
9428 @table @gcctabopt
9430 @item -EB
9431 @opindex EB
9432 Generate big-endian code.
9434 @item -EL
9435 @opindex EL
9436 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
9437 configurations.
9439 @item -march=@var{arch}
9440 @opindex march
9441 Generate code that will run on @var{arch}, which can be the name of a
9442 generic MIPS ISA, or the name of a particular processor.
9443 The ISA names are:
9444 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9445 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9446 The processor names are:
9447 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9448 @samp{m4k},
9449 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9450 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9451 @samp{rm9000},
9452 @samp{orion},
9453 @samp{sb1},
9454 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9455 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9456 The special value @samp{from-abi} selects the
9457 most compatible architecture for the selected ABI (that is,
9458 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9460 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9461 (for example, @samp{-march=r2k}).  Prefixes are optional, and
9462 @samp{vr} may be written @samp{r}.
9464 GCC defines two macros based on the value of this option.  The first
9465 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9466 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
9467 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9468 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9469 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9471 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9472 above.  In other words, it will have the full prefix and will not
9473 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
9474 the macro names the resolved architecture (either @samp{"mips1"} or
9475 @samp{"mips3"}).  It names the default architecture when no
9476 @option{-march} option is given.
9478 @item -mtune=@var{arch}
9479 @opindex mtune
9480 Optimize for @var{arch}.  Among other things, this option controls
9481 the way instructions are scheduled, and the perceived cost of arithmetic
9482 operations.  The list of @var{arch} values is the same as for
9483 @option{-march}.
9485 When this option is not used, GCC will optimize for the processor
9486 specified by @option{-march}.  By using @option{-march} and
9487 @option{-mtune} together, it is possible to generate code that will
9488 run on a family of processors, but optimize the code for one
9489 particular member of that family.
9491 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9492 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9493 @samp{-march} ones described above.
9495 @item -mips1
9496 @opindex mips1
9497 Equivalent to @samp{-march=mips1}.
9499 @item -mips2
9500 @opindex mips2
9501 Equivalent to @samp{-march=mips2}.
9503 @item -mips3
9504 @opindex mips3
9505 Equivalent to @samp{-march=mips3}.
9507 @item -mips4
9508 @opindex mips4
9509 Equivalent to @samp{-march=mips4}.
9511 @item -mips32
9512 @opindex mips32
9513 Equivalent to @samp{-march=mips32}.
9515 @item -mips32r2
9516 @opindex mips32r2
9517 Equivalent to @samp{-march=mips32r2}.
9519 @item -mips64
9520 @opindex mips64
9521 Equivalent to @samp{-march=mips64}.
9523 @item -mips16
9524 @itemx -mno-mips16
9525 @opindex mips16
9526 @opindex mno-mips16
9527 Use (do not use) the MIPS16 ISA@.
9529 @item -mabi=32
9530 @itemx -mabi=o64
9531 @itemx -mabi=n32
9532 @itemx -mabi=64
9533 @itemx -mabi=eabi
9534 @opindex mabi=32
9535 @opindex mabi=o64
9536 @opindex mabi=n32
9537 @opindex mabi=64
9538 @opindex mabi=eabi
9539 Generate code for the given ABI@.
9541 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
9542 generates 64-bit code when you select a 64-bit architecture, but you
9543 can use @option{-mgp32} to get 32-bit code instead.
9545 For information about the O64 ABI, see
9546 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9548 @item -mabicalls
9549 @itemx -mno-abicalls
9550 @opindex mabicalls
9551 @opindex mno-abicalls
9552 Generate (do not generate) SVR4-style position-independent code.
9553 @option{-mabicalls} is the default for SVR4-based systems.
9555 @item -mxgot
9556 @itemx -mno-xgot
9557 @opindex mxgot
9558 @opindex mno-xgot
9559 Lift (do not lift) the usual restrictions on the size of the global
9560 offset table.
9562 GCC normally uses a single instruction to load values from the GOT@.
9563 While this is relatively efficient, it will only work if the GOT
9564 is smaller than about 64k.  Anything larger will cause the linker
9565 to report an error such as:
9567 @cindex relocation truncated to fit (MIPS)
9568 @smallexample
9569 relocation truncated to fit: R_MIPS_GOT16 foobar
9570 @end smallexample
9572 If this happens, you should recompile your code with @option{-mxgot}.
9573 It should then work with very large GOTs, although it will also be
9574 less efficient, since it will take three instructions to fetch the
9575 value of a global symbol.
9577 Note that some linkers can create multiple GOTs.  If you have such a
9578 linker, you should only need to use @option{-mxgot} when a single object
9579 file accesses more than 64k's worth of GOT entries.  Very few do.
9581 These options have no effect unless GCC is generating position
9582 independent code.
9584 @item -mgp32
9585 @opindex mgp32
9586 Assume that general-purpose registers are 32 bits wide.
9588 @item -mgp64
9589 @opindex mgp64
9590 Assume that general-purpose registers are 64 bits wide.
9592 @item -mfp32
9593 @opindex mfp32
9594 Assume that floating-point registers are 32 bits wide.
9596 @item -mfp64
9597 @opindex mfp64
9598 Assume that floating-point registers are 64 bits wide.
9600 @item -mhard-float
9601 @opindex mhard-float
9602 Use floating-point coprocessor instructions.
9604 @item -msoft-float
9605 @opindex msoft-float
9606 Do not use floating-point coprocessor instructions.  Implement
9607 floating-point calculations using library calls instead.
9609 @item -msingle-float
9610 @opindex msingle-float
9611 Assume that the floating-point coprocessor only supports single-precision
9612 operations.
9614 @itemx -mdouble-float
9615 @opindex mdouble-float
9616 Assume that the floating-point coprocessor supports double-precision
9617 operations.  This is the default.
9619 @itemx -mpaired-single
9620 @itemx -mno-paired-single
9621 @opindex mpaired-single
9622 @opindex mno-paired-single
9623 Use (do not use) paired-single floating-point instructions.
9624 @xref{MIPS Paired-Single Support}.  This option can only be used
9625 when generating 64-bit code and requires hardware floating-point
9626 support to be enabled.
9628 @itemx -mips3d
9629 @itemx -mno-mips3d
9630 @opindex mips3d
9631 @opindex mno-mips3d
9632 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
9633 The option @option{-mips3d} implies @option{-mpaired-single}.
9635 @item -mint64
9636 @opindex mint64
9637 Force @code{int} and @code{long} types to be 64 bits wide.  See
9638 @option{-mlong32} for an explanation of the default and the way
9639 that the pointer size is determined.
9641 This option has been deprecated and will be removed in a future release.
9643 @item -mlong64
9644 @opindex mlong64
9645 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
9646 an explanation of the default and the way that the pointer size is
9647 determined.
9649 @item -mlong32
9650 @opindex mlong32
9651 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9653 The default size of @code{int}s, @code{long}s and pointers depends on
9654 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
9655 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9656 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
9657 or the same size as integer registers, whichever is smaller.
9659 @item -G @var{num}
9660 @opindex G
9661 @cindex smaller data references (MIPS)
9662 @cindex gp-relative references (MIPS)
9663 Put global and static items less than or equal to @var{num} bytes into
9664 the small data or bss section instead of the normal data or bss section.
9665 This allows the data to be accessed using a single instruction.
9667 All modules should be compiled with the same @option{-G @var{num}}
9668 value.
9670 @item -membedded-data
9671 @itemx -mno-embedded-data
9672 @opindex membedded-data
9673 @opindex mno-embedded-data
9674 Allocate variables to the read-only data section first if possible, then
9675 next in the small data section if possible, otherwise in data.  This gives
9676 slightly slower code than the default, but reduces the amount of RAM required
9677 when executing, and thus may be preferred for some embedded systems.
9679 @item -muninit-const-in-rodata
9680 @itemx -mno-uninit-const-in-rodata
9681 @opindex muninit-const-in-rodata
9682 @opindex mno-uninit-const-in-rodata
9683 Put uninitialized @code{const} variables in the read-only data section.
9684 This option is only meaningful in conjunction with @option{-membedded-data}.
9686 @item -msplit-addresses
9687 @itemx -mno-split-addresses
9688 @opindex msplit-addresses
9689 @opindex mno-split-addresses
9690 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9691 relocation operators.  This option has been superceded by
9692 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9694 @item -mexplicit-relocs
9695 @itemx -mno-explicit-relocs
9696 @opindex mexplicit-relocs
9697 @opindex mno-explicit-relocs
9698 Use (do not use) assembler relocation operators when dealing with symbolic
9699 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
9700 is to use assembler macros instead.
9702 @option{-mexplicit-relocs} is the default if GCC was configured
9703 to use an assembler that supports relocation operators.
9705 @item -mcheck-zero-division
9706 @itemx -mno-check-zero-division
9707 @opindex mcheck-zero-division
9708 @opindex mno-check-zero-division
9709 Trap (do not trap) on integer division by zero.  The default is
9710 @option{-mcheck-zero-division}.
9712 @item -mdivide-traps
9713 @itemx -mdivide-breaks
9714 @opindex mdivide-traps
9715 @opindex mdivide-breaks
9716 MIPS systems check for division by zero by generating either a
9717 conditional trap or a break instruction.  Using traps results in
9718 smaller code, but is only supported on MIPS II and later.  Also, some
9719 versions of the Linux kernel have a bug that prevents trap from
9720 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
9721 allow conditional traps on architectures that support them and
9722 @option{-mdivide-breaks} to force the use of breaks.
9724 The default is usually @option{-mdivide-traps}, but this can be
9725 overridden at configure time using @option{--with-divide=breaks}.
9726 Divide-by-zero checks can be completely disabled using
9727 @option{-mno-check-zero-division}.
9729 @item -mmemcpy
9730 @itemx -mno-memcpy
9731 @opindex mmemcpy
9732 @opindex mno-memcpy
9733 Force (do not force) the use of @code{memcpy()} for non-trivial block
9734 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
9735 most constant-sized copies.
9737 @item -mlong-calls
9738 @itemx -mno-long-calls
9739 @opindex mlong-calls
9740 @opindex mno-long-calls
9741 Disable (do not disable) use of the @code{jal} instruction.  Calling
9742 functions using @code{jal} is more efficient but requires the caller
9743 and callee to be in the same 256 megabyte segment.
9745 This option has no effect on abicalls code.  The default is
9746 @option{-mno-long-calls}.
9748 @item -mmad
9749 @itemx -mno-mad
9750 @opindex mmad
9751 @opindex mno-mad
9752 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9753 instructions, as provided by the R4650 ISA@.
9755 @item -mfused-madd
9756 @itemx -mno-fused-madd
9757 @opindex mfused-madd
9758 @opindex mno-fused-madd
9759 Enable (disable) use of the floating point multiply-accumulate
9760 instructions, when they are available.  The default is
9761 @option{-mfused-madd}.
9763 When multiply-accumulate instructions are used, the intermediate
9764 product is calculated to infinite precision and is not subject to
9765 the FCSR Flush to Zero bit.  This may be undesirable in some
9766 circumstances.
9768 @item -nocpp
9769 @opindex nocpp
9770 Tell the MIPS assembler to not run its preprocessor over user
9771 assembler files (with a @samp{.s} suffix) when assembling them.
9773 @item -mfix-r4000
9774 @itemx -mno-fix-r4000
9775 @opindex mfix-r4000
9776 @opindex mno-fix-r4000
9777 Work around certain R4000 CPU errata:
9778 @itemize @minus
9779 @item
9780 A double-word or a variable shift may give an incorrect result if executed
9781 immediately after starting an integer division.
9782 @item
9783 A double-word or a variable shift may give an incorrect result if executed
9784 while an integer multiplication is in progress.
9785 @item
9786 An integer division may give an incorrect result if started in a delay slot
9787 of a taken branch or a jump.
9788 @end itemize
9790 @item -mfix-r4400
9791 @itemx -mno-fix-r4400
9792 @opindex mfix-r4400
9793 @opindex mno-fix-r4400
9794 Work around certain R4400 CPU errata:
9795 @itemize @minus
9796 @item
9797 A double-word or a variable shift may give an incorrect result if executed
9798 immediately after starting an integer division.
9799 @end itemize
9801 @item -mfix-vr4120
9802 @itemx -mno-fix-vr4120
9803 @opindex mfix-vr4120
9804 Work around certain VR4120 errata:
9805 @itemize @minus
9806 @item
9807 @code{dmultu} does not always produce the correct result.
9808 @item
9809 @code{div} and @code{ddiv} do not always produce the correct result if one
9810 of the operands is negative.
9811 @end itemize
9812 The workarounds for the division errata rely on special functions in
9813 @file{libgcc.a}.  At present, these functions are only provided by
9814 the @code{mips64vr*-elf} configurations.
9816 Other VR4120 errata require a nop to be inserted between certain pairs of
9817 instructions.  These errata are handled by the assembler, not by GCC itself.
9819 @item -mfix-sb1
9820 @itemx -mno-fix-sb1
9821 @opindex mfix-sb1
9822 Work around certain SB-1 CPU core errata.
9823 (This flag currently works around the SB-1 revision 2
9824 ``F1'' and ``F2'' floating point errata.)
9826 @item -mflush-func=@var{func}
9827 @itemx -mno-flush-func
9828 @opindex mflush-func
9829 Specifies the function to call to flush the I and D caches, or to not
9830 call any such function.  If called, the function must take the same
9831 arguments as the common @code{_flush_func()}, that is, the address of the
9832 memory range for which the cache is being flushed, the size of the
9833 memory range, and the number 3 (to flush both caches).  The default
9834 depends on the target GCC was configured for, but commonly is either
9835 @samp{_flush_func} or @samp{__cpu_flush}.
9837 @item -mbranch-likely
9838 @itemx -mno-branch-likely
9839 @opindex mbranch-likely
9840 @opindex mno-branch-likely
9841 Enable or disable use of Branch Likely instructions, regardless of the
9842 default for the selected architecture.  By default, Branch Likely
9843 instructions may be generated if they are supported by the selected
9844 architecture.  An exception is for the MIPS32 and MIPS64 architectures
9845 and processors which implement those architectures; for those, Branch
9846 Likely instructions will not be generated by default because the MIPS32
9847 and MIPS64 architectures specifically deprecate their use.
9849 @item -mfp-exceptions
9850 @itemx -mno-fp-exceptions
9851 @opindex mfp-exceptions
9852 Specifies whether FP exceptions are enabled.  This affects how we schedule
9853 FP instructions for some processors.  The default is that FP exceptions are
9854 enabled.
9856 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
9857 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
9858 FP pipe.
9860 @item -mvr4130-align
9861 @itemx -mno-vr4130-align
9862 @opindex mvr4130-align
9863 The VR4130 pipeline is two-way superscalar, but can only issue two
9864 instructions together if the first one is 8-byte aligned.  When this
9865 option is enabled, GCC will align pairs of instructions that it
9866 thinks should execute in parallel.
9868 This option only has an effect when optimizing for the VR4130.
9869 It normally makes code faster, but at the expense of making it bigger.
9870 It is enabled by default at optimization level @option{-O3}.
9871 @end table
9873 @node MMIX Options
9874 @subsection MMIX Options
9875 @cindex MMIX Options
9877 These options are defined for the MMIX:
9879 @table @gcctabopt
9880 @item -mlibfuncs
9881 @itemx -mno-libfuncs
9882 @opindex mlibfuncs
9883 @opindex mno-libfuncs
9884 Specify that intrinsic library functions are being compiled, passing all
9885 values in registers, no matter the size.
9887 @item -mepsilon
9888 @itemx -mno-epsilon
9889 @opindex mepsilon
9890 @opindex mno-epsilon
9891 Generate floating-point comparison instructions that compare with respect
9892 to the @code{rE} epsilon register.
9894 @item -mabi=mmixware
9895 @itemx -mabi=gnu
9896 @opindex mabi-mmixware
9897 @opindex mabi=gnu
9898 Generate code that passes function parameters and return values that (in
9899 the called function) are seen as registers @code{$0} and up, as opposed to
9900 the GNU ABI which uses global registers @code{$231} and up.
9902 @item -mzero-extend
9903 @itemx -mno-zero-extend
9904 @opindex mzero-extend
9905 @opindex mno-zero-extend
9906 When reading data from memory in sizes shorter than 64 bits, use (do not
9907 use) zero-extending load instructions by default, rather than
9908 sign-extending ones.
9910 @item -mknuthdiv
9911 @itemx -mno-knuthdiv
9912 @opindex mknuthdiv
9913 @opindex mno-knuthdiv
9914 Make the result of a division yielding a remainder have the same sign as
9915 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
9916 remainder follows the sign of the dividend.  Both methods are
9917 arithmetically valid, the latter being almost exclusively used.
9919 @item -mtoplevel-symbols
9920 @itemx -mno-toplevel-symbols
9921 @opindex mtoplevel-symbols
9922 @opindex mno-toplevel-symbols
9923 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
9924 code can be used with the @code{PREFIX} assembly directive.
9926 @item -melf
9927 @opindex melf
9928 Generate an executable in the ELF format, rather than the default
9929 @samp{mmo} format used by the @command{mmix} simulator.
9931 @item -mbranch-predict
9932 @itemx -mno-branch-predict
9933 @opindex mbranch-predict
9934 @opindex mno-branch-predict
9935 Use (do not use) the probable-branch instructions, when static branch
9936 prediction indicates a probable branch.
9938 @item -mbase-addresses
9939 @itemx -mno-base-addresses
9940 @opindex mbase-addresses
9941 @opindex mno-base-addresses
9942 Generate (do not generate) code that uses @emph{base addresses}.  Using a
9943 base address automatically generates a request (handled by the assembler
9944 and the linker) for a constant to be set up in a global register.  The
9945 register is used for one or more base address requests within the range 0
9946 to 255 from the value held in the register.  The generally leads to short
9947 and fast code, but the number of different data items that can be
9948 addressed is limited.  This means that a program that uses lots of static
9949 data may require @option{-mno-base-addresses}.
9951 @item -msingle-exit
9952 @itemx -mno-single-exit
9953 @opindex msingle-exit
9954 @opindex mno-single-exit
9955 Force (do not force) generated code to have a single exit point in each
9956 function.
9957 @end table
9959 @node MN10300 Options
9960 @subsection MN10300 Options
9961 @cindex MN10300 options
9963 These @option{-m} options are defined for Matsushita MN10300 architectures:
9965 @table @gcctabopt
9966 @item -mmult-bug
9967 @opindex mmult-bug
9968 Generate code to avoid bugs in the multiply instructions for the MN10300
9969 processors.  This is the default.
9971 @item -mno-mult-bug
9972 @opindex mno-mult-bug
9973 Do not generate code to avoid bugs in the multiply instructions for the
9974 MN10300 processors.
9976 @item -mam33
9977 @opindex mam33
9978 Generate code which uses features specific to the AM33 processor.
9980 @item -mno-am33
9981 @opindex mno-am33
9982 Do not generate code which uses features specific to the AM33 processor.  This
9983 is the default.
9985 @item -mno-crt0
9986 @opindex mno-crt0
9987 Do not link in the C run-time initialization object file.
9989 @item -mrelax
9990 @opindex mrelax
9991 Indicate to the linker that it should perform a relaxation optimization pass
9992 to shorten branches, calls and absolute memory addresses.  This option only
9993 has an effect when used on the command line for the final link step.
9995 This option makes symbolic debugging impossible.
9996 @end table
9998 @node NS32K Options
9999 @subsection NS32K Options
10000 @cindex NS32K options
10002 These are the @samp{-m} options defined for the 32000 series.  The default
10003 values for these options depends on which style of 32000 was selected when
10004 the compiler was configured; the defaults for the most common choices are
10005 given below.
10007 @table @gcctabopt
10008 @item -m32032
10009 @itemx -m32032
10010 @opindex m32032
10011 @opindex m32032
10012 Generate output for a 32032.  This is the default
10013 when the compiler is configured for 32032 and 32016 based systems.
10015 @item -m32332
10016 @itemx -m32332
10017 @opindex m32332
10018 @opindex m32332
10019 Generate output for a 32332.  This is the default
10020 when the compiler is configured for 32332-based systems.
10022 @item -m32532
10023 @itemx -m32532
10024 @opindex m32532
10025 @opindex m32532
10026 Generate output for a 32532.  This is the default
10027 when the compiler is configured for 32532-based systems.
10029 @item -m32081
10030 @opindex m32081
10031 Generate output containing 32081 instructions for floating point.
10032 This is the default for all systems.
10034 @item -m32381
10035 @opindex m32381
10036 Generate output containing 32381 instructions for floating point.  This
10037 also implies @option{-m32081}.  The 32381 is only compatible with the 32332
10038 and 32532 cpus.  This is the default for the pc532-netbsd configuration.
10040 @item -mmulti-add
10041 @opindex mmulti-add
10042 Try and generate multiply-add floating point instructions @code{polyF}
10043 and @code{dotF}.  This option is only available if the @option{-m32381}
10044 option is in effect.  Using these instructions requires changes to
10045 register allocation which generally has a negative impact on
10046 performance.  This option should only be enabled when compiling code
10047 particularly likely to make heavy use of multiply-add instructions.
10049 @item -mnomulti-add
10050 @opindex mnomulti-add
10051 Do not try and generate multiply-add floating point instructions
10052 @code{polyF} and @code{dotF}.  This is the default on all platforms.
10054 @item -msoft-float
10055 @opindex msoft-float
10056 Generate output containing library calls for floating point.
10057 @strong{Warning:} the requisite libraries may not be available.
10059 @item -mieee-compare
10060 @itemx -mno-ieee-compare
10061 @opindex mieee-compare
10062 @opindex mno-ieee-compare
10063 Control whether or not the compiler uses IEEE floating point
10064 comparisons.  These handle correctly the case where the result of a
10065 comparison is unordered.
10066 @strong{Warning:} the requisite kernel support may not be available.
10068 @item -mnobitfield
10069 @opindex mnobitfield
10070 Do not use the bit-field instructions.  On some machines it is faster to
10071 use shifting and masking operations.  This is the default for the pc532.
10073 @item -mbitfield
10074 @opindex mbitfield
10075 Do use the bit-field instructions.  This is the default for all platforms
10076 except the pc532.
10078 @item -mrtd
10079 @opindex mrtd
10080 Use a different function-calling convention, in which functions
10081 that take a fixed number of arguments return pop their
10082 arguments on return with the @code{ret} instruction.
10084 This calling convention is incompatible with the one normally
10085 used on Unix, so you cannot use it if you need to call libraries
10086 compiled with the Unix compiler.
10088 Also, you must provide function prototypes for all functions that
10089 take variable numbers of arguments (including @code{printf});
10090 otherwise incorrect code will be generated for calls to those
10091 functions.
10093 In addition, seriously incorrect code will result if you call a
10094 function with too many arguments.  (Normally, extra arguments are
10095 harmlessly ignored.)
10097 This option takes its name from the 680x0 @code{rtd} instruction.
10100 @item -mregparam
10101 @opindex mregparam
10102 Use a different function-calling convention where the first two arguments
10103 are passed in registers.
10105 This calling convention is incompatible with the one normally
10106 used on Unix, so you cannot use it if you need to call libraries
10107 compiled with the Unix compiler.
10109 @item -mnoregparam
10110 @opindex mnoregparam
10111 Do not pass any arguments in registers.  This is the default for all
10112 targets.
10114 @item -msb
10115 @opindex msb
10116 It is OK to use the sb as an index register which is always loaded with
10117 zero.  This is the default for the pc532-netbsd target.
10119 @item -mnosb
10120 @opindex mnosb
10121 The sb register is not available for use or has not been initialized to
10122 zero by the run time system.  This is the default for all targets except
10123 the pc532-netbsd.  It is also implied whenever @option{-mhimem} or
10124 @option{-fpic} is set.
10126 @item -mhimem
10127 @opindex mhimem
10128 Many ns32000 series addressing modes use displacements of up to 512MB@.
10129 If an address is above 512MB then displacements from zero can not be used.
10130 This option causes code to be generated which can be loaded above 512MB@.
10131 This may be useful for operating systems or ROM code.
10133 @item -mnohimem
10134 @opindex mnohimem
10135 Assume code will be loaded in the first 512MB of virtual address space.
10136 This is the default for all platforms.
10138 @end table
10140 @node PDP-11 Options
10141 @subsection PDP-11 Options
10142 @cindex PDP-11 Options
10144 These options are defined for the PDP-11:
10146 @table @gcctabopt
10147 @item -mfpu
10148 @opindex mfpu
10149 Use hardware FPP floating point.  This is the default.  (FIS floating
10150 point on the PDP-11/40 is not supported.)
10152 @item -msoft-float
10153 @opindex msoft-float
10154 Do not use hardware floating point.
10156 @item -mac0
10157 @opindex mac0
10158 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10160 @item -mno-ac0
10161 @opindex mno-ac0
10162 Return floating-point results in memory.  This is the default.
10164 @item -m40
10165 @opindex m40
10166 Generate code for a PDP-11/40.
10168 @item -m45
10169 @opindex m45
10170 Generate code for a PDP-11/45.  This is the default.
10172 @item -m10
10173 @opindex m10
10174 Generate code for a PDP-11/10.
10176 @item -mbcopy-builtin
10177 @opindex bcopy-builtin
10178 Use inline @code{movmemhi} patterns for copying memory.  This is the
10179 default.
10181 @item -mbcopy
10182 @opindex mbcopy
10183 Do not use inline @code{movmemhi} patterns for copying memory.
10185 @item -mint16
10186 @itemx -mno-int32
10187 @opindex mint16
10188 @opindex mno-int32
10189 Use 16-bit @code{int}.  This is the default.
10191 @item -mint32
10192 @itemx -mno-int16
10193 @opindex mint32
10194 @opindex mno-int16
10195 Use 32-bit @code{int}.
10197 @item -mfloat64
10198 @itemx -mno-float32
10199 @opindex mfloat64
10200 @opindex mno-float32
10201 Use 64-bit @code{float}.  This is the default.
10203 @item -mfloat32
10204 @itemx -mno-float64
10205 @opindex mfloat32
10206 @opindex mno-float64
10207 Use 32-bit @code{float}.
10209 @item -mabshi
10210 @opindex mabshi
10211 Use @code{abshi2} pattern.  This is the default.
10213 @item -mno-abshi
10214 @opindex mno-abshi
10215 Do not use @code{abshi2} pattern.
10217 @item -mbranch-expensive
10218 @opindex mbranch-expensive
10219 Pretend that branches are expensive.  This is for experimenting with
10220 code generation only.
10222 @item -mbranch-cheap
10223 @opindex mbranch-cheap
10224 Do not pretend that branches are expensive.  This is the default.
10226 @item -msplit
10227 @opindex msplit
10228 Generate code for a system with split I&D@.
10230 @item -mno-split
10231 @opindex mno-split
10232 Generate code for a system without split I&D@.  This is the default.
10234 @item -munix-asm
10235 @opindex munix-asm
10236 Use Unix assembler syntax.  This is the default when configured for
10237 @samp{pdp11-*-bsd}.
10239 @item -mdec-asm
10240 @opindex mdec-asm
10241 Use DEC assembler syntax.  This is the default when configured for any
10242 PDP-11 target other than @samp{pdp11-*-bsd}.
10243 @end table
10245 @node PowerPC Options
10246 @subsection PowerPC Options
10247 @cindex PowerPC options
10249 These are listed under @xref{RS/6000 and PowerPC Options}.
10251 @node RS/6000 and PowerPC Options
10252 @subsection IBM RS/6000 and PowerPC Options
10253 @cindex RS/6000 and PowerPC Options
10254 @cindex IBM RS/6000 and PowerPC Options
10256 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10257 @table @gcctabopt
10258 @item -mpower
10259 @itemx -mno-power
10260 @itemx -mpower2
10261 @itemx -mno-power2
10262 @itemx -mpowerpc
10263 @itemx -mno-powerpc
10264 @itemx -mpowerpc-gpopt
10265 @itemx -mno-powerpc-gpopt
10266 @itemx -mpowerpc-gfxopt
10267 @itemx -mno-powerpc-gfxopt
10268 @itemx -mpowerpc64
10269 @itemx -mno-powerpc64
10270 @opindex mpower
10271 @opindex mno-power
10272 @opindex mpower2
10273 @opindex mno-power2
10274 @opindex mpowerpc
10275 @opindex mno-powerpc
10276 @opindex mpowerpc-gpopt
10277 @opindex mno-powerpc-gpopt
10278 @opindex mpowerpc-gfxopt
10279 @opindex mno-powerpc-gfxopt
10280 @opindex mpowerpc64
10281 @opindex mno-powerpc64
10282 GCC supports two related instruction set architectures for the
10283 RS/6000 and PowerPC@.  The @dfn{POWER} instruction set are those
10284 instructions supported by the @samp{rios} chip set used in the original
10285 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10286 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10287 the IBM 4xx microprocessors.
10289 Neither architecture is a subset of the other.  However there is a
10290 large common subset of instructions supported by both.  An MQ
10291 register is included in processors supporting the POWER architecture.
10293 You use these options to specify which instructions are available on the
10294 processor you are using.  The default value of these options is
10295 determined when configuring GCC@.  Specifying the
10296 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10297 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
10298 rather than the options listed above.
10300 The @option{-mpower} option allows GCC to generate instructions that
10301 are found only in the POWER architecture and to use the MQ register.
10302 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10303 to generate instructions that are present in the POWER2 architecture but
10304 not the original POWER architecture.
10306 The @option{-mpowerpc} option allows GCC to generate instructions that
10307 are found only in the 32-bit subset of the PowerPC architecture.
10308 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10309 GCC to use the optional PowerPC architecture instructions in the
10310 General Purpose group, including floating-point square root.  Specifying
10311 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10312 use the optional PowerPC architecture instructions in the Graphics
10313 group, including floating-point select.
10315 The @option{-mpowerpc64} option allows GCC to generate the additional
10316 64-bit instructions that are found in the full PowerPC64 architecture
10317 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
10318 @option{-mno-powerpc64}.
10320 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10321 will use only the instructions in the common subset of both
10322 architectures plus some special AIX common-mode calls, and will not use
10323 the MQ register.  Specifying both @option{-mpower} and @option{-mpowerpc}
10324 permits GCC to use any instruction from either architecture and to
10325 allow use of the MQ register; specify this for the Motorola MPC601.
10327 @item -mnew-mnemonics
10328 @itemx -mold-mnemonics
10329 @opindex mnew-mnemonics
10330 @opindex mold-mnemonics
10331 Select which mnemonics to use in the generated assembler code.  With
10332 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10333 the PowerPC architecture.  With @option{-mold-mnemonics} it uses the
10334 assembler mnemonics defined for the POWER architecture.  Instructions
10335 defined in only one architecture have only one mnemonic; GCC uses that
10336 mnemonic irrespective of which of these options is specified.
10338 GCC defaults to the mnemonics appropriate for the architecture in
10339 use.  Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10340 value of these option.  Unless you are building a cross-compiler, you
10341 should normally not specify either @option{-mnew-mnemonics} or
10342 @option{-mold-mnemonics}, but should instead accept the default.
10344 @item -mcpu=@var{cpu_type}
10345 @opindex mcpu
10346 Set architecture type, register usage, choice of mnemonics, and
10347 instruction scheduling parameters for machine type @var{cpu_type}.
10348 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10349 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10350 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10351 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10352 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10353 @samp{860}, @samp{970}, @samp{common}, @samp{ec603e}, @samp{G3},
10354 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10355 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10356 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64a}.
10358 @option{-mcpu=common} selects a completely generic processor.  Code
10359 generated under this option will run on any POWER or PowerPC processor.
10360 GCC will use only the instructions in the common subset of both
10361 architectures, and will not use the MQ register.  GCC assumes a generic
10362 processor model for scheduling purposes.
10364 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10365 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10366 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10367 types, with an appropriate, generic processor model assumed for
10368 scheduling purposes.
10370 The other options specify a specific processor.  Code generated under
10371 those options will run best on that processor, and may not run at all on
10372 others.
10374 The @option{-mcpu} options automatically enable or disable the
10375 following options: @option{-maltivec}, @option{-mhard-float},
10376 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10377 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10378 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10379 @option{-mstring}.  The particular options set for any particular CPU
10380 will vary between compiler versions, depending on what setting seems
10381 to produce optimal code for that CPU; it doesn't necessarily reflect
10382 the actual hardware's capabilities.  If you wish to set an individual
10383 option to a particular value, you may specify it after the
10384 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10386 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10387 not enabled or disabled by the @option{-mcpu} option at present, since
10388 AIX does not have full support for these options.  You may still
10389 enable or disable them individually if you're sure it'll work in your
10390 environment.
10392 @item -mtune=@var{cpu_type}
10393 @opindex mtune
10394 Set the instruction scheduling parameters for machine type
10395 @var{cpu_type}, but do not set the architecture type, register usage, or
10396 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would.  The same
10397 values for @var{cpu_type} are used for @option{-mtune} as for
10398 @option{-mcpu}.  If both are specified, the code generated will use the
10399 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10400 scheduling parameters set by @option{-mtune}.
10402 @item -maltivec
10403 @itemx -mno-altivec
10404 @opindex maltivec
10405 @opindex mno-altivec
10406 Generate code that uses (does not use) AltiVec instructions, and also
10407 enable the use of built-in functions that allow more direct access to
10408 the AltiVec instruction set.  You may also need to set
10409 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10410 enhancements.
10412 @item -mabi=spe
10413 @opindex mabi=spe
10414 Extend the current ABI with SPE ABI extensions.  This does not change
10415 the default ABI, instead it adds the SPE ABI extensions to the current
10416 ABI@.
10418 @item -mabi=no-spe
10419 @opindex mabi=no-spe
10420 Disable Booke SPE ABI extensions for the current ABI@.
10422 @item -misel=@var{yes/no}
10423 @itemx -misel
10424 @opindex misel
10425 This switch enables or disables the generation of ISEL instructions.
10427 @item -mspe=@var{yes/no}
10428 @itemx -mspe
10429 @opindex mspe
10430 This switch enables or disables the generation of SPE simd
10431 instructions.
10433 @item -mfloat-gprs=@var{yes/single/double/no}
10434 @itemx -mfloat-gprs
10435 @opindex mfloat-gprs
10436 This switch enables or disables the generation of floating point
10437 operations on the general purpose registers for architectures that
10438 support it.
10440 The argument @var{yes} or @var{single} enables the use of
10441 single-precision floating point operations.
10443 The argument @var{double} enables the use of single and
10444 double-precision floating point operations.
10446 The argument @var{no} disables floating point operations on the
10447 general purpose registers.
10449 This option is currently only available on the MPC854x.
10451 @item -m32
10452 @itemx -m64
10453 @opindex m32
10454 @opindex m64
10455 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10456 targets (including GNU/Linux).  The 32-bit environment sets int, long
10457 and pointer to 32 bits and generates code that runs on any PowerPC
10458 variant.  The 64-bit environment sets int to 32 bits and long and
10459 pointer to 64 bits, and generates code for PowerPC64, as for
10460 @option{-mpowerpc64}.
10462 @item -mfull-toc
10463 @itemx -mno-fp-in-toc
10464 @itemx -mno-sum-in-toc
10465 @itemx -mminimal-toc
10466 @opindex mfull-toc
10467 @opindex mno-fp-in-toc
10468 @opindex mno-sum-in-toc
10469 @opindex mminimal-toc
10470 Modify generation of the TOC (Table Of Contents), which is created for
10471 every executable file.  The @option{-mfull-toc} option is selected by
10472 default.  In that case, GCC will allocate at least one TOC entry for
10473 each unique non-automatic variable reference in your program.  GCC
10474 will also place floating-point constants in the TOC@.  However, only
10475 16,384 entries are available in the TOC@.
10477 If you receive a linker error message that saying you have overflowed
10478 the available TOC space, you can reduce the amount of TOC space used
10479 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10480 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10481 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10482 generate code to calculate the sum of an address and a constant at
10483 run-time instead of putting that sum into the TOC@.  You may specify one
10484 or both of these options.  Each causes GCC to produce very slightly
10485 slower and larger code at the expense of conserving TOC space.
10487 If you still run out of space in the TOC even when you specify both of
10488 these options, specify @option{-mminimal-toc} instead.  This option causes
10489 GCC to make only one TOC entry for every file.  When you specify this
10490 option, GCC will produce code that is slower and larger but which
10491 uses extremely little TOC space.  You may wish to use this option
10492 only on files that contain less frequently executed code.
10494 @item -maix64
10495 @itemx -maix32
10496 @opindex maix64
10497 @opindex maix32
10498 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10499 @code{long} type, and the infrastructure needed to support them.
10500 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10501 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10502 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
10504 @item -mxl-compat
10505 @itemx -mno-xl-compat
10506 @opindex mxl-compat
10507 @opindex mno-xl-compat
10508 Produce code that conforms more closely to IBM XLC semantics when using
10509 AIX-compatible ABI.  Pass floating-point arguments to prototyped
10510 functions beyond the register save area (RSA) on the stack in addition
10511 to argument FPRs.  Do not assume that most significant double in 128
10512 bit long double value is properly rounded when comparing values.
10514 The AIX calling convention was extended but not initially documented to
10515 handle an obscure K&R C case of calling a function that takes the
10516 address of its arguments with fewer arguments than declared.  AIX XL
10517 compilers access floating point arguments which do not fit in the
10518 RSA from the stack when a subroutine is compiled without
10519 optimization.  Because always storing floating-point arguments on the
10520 stack is inefficient and rarely needed, this option is not enabled by
10521 default and only is necessary when calling subroutines compiled by AIX
10522 XL compilers without optimization.
10524 @item -mpe
10525 @opindex mpe
10526 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
10527 application written to use message passing with special startup code to
10528 enable the application to run.  The system must have PE installed in the
10529 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10530 must be overridden with the @option{-specs=} option to specify the
10531 appropriate directory location.  The Parallel Environment does not
10532 support threads, so the @option{-mpe} option and the @option{-pthread}
10533 option are incompatible.
10535 @item -malign-natural
10536 @itemx -malign-power
10537 @opindex malign-natural
10538 @opindex malign-power
10539 On AIX, Darwin, and 64-bit PowerPC GNU/Linux, the option
10540 @option{-malign-natural} overrides the ABI-defined alignment of larger
10541 types, such as floating-point doubles, on their natural size-based boundary.
10542 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10543 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
10545 @item -msoft-float
10546 @itemx -mhard-float
10547 @opindex msoft-float
10548 @opindex mhard-float
10549 Generate code that does not use (uses) the floating-point register set.
10550 Software floating point emulation is provided if you use the
10551 @option{-msoft-float} option, and pass the option to GCC when linking.
10553 @item -mmultiple
10554 @itemx -mno-multiple
10555 @opindex mmultiple
10556 @opindex mno-multiple
10557 Generate code that uses (does not use) the load multiple word
10558 instructions and the store multiple word instructions.  These
10559 instructions are generated by default on POWER systems, and not
10560 generated on PowerPC systems.  Do not use @option{-mmultiple} on little
10561 endian PowerPC systems, since those instructions do not work when the
10562 processor is in little endian mode.  The exceptions are PPC740 and
10563 PPC750 which permit the instructions usage in little endian mode.
10565 @item -mstring
10566 @itemx -mno-string
10567 @opindex mstring
10568 @opindex mno-string
10569 Generate code that uses (does not use) the load string instructions
10570 and the store string word instructions to save multiple registers and
10571 do small block moves.  These instructions are generated by default on
10572 POWER systems, and not generated on PowerPC systems.  Do not use
10573 @option{-mstring} on little endian PowerPC systems, since those
10574 instructions do not work when the processor is in little endian mode.
10575 The exceptions are PPC740 and PPC750 which permit the instructions
10576 usage in little endian mode.
10578 @item -mupdate
10579 @itemx -mno-update
10580 @opindex mupdate
10581 @opindex mno-update
10582 Generate code that uses (does not use) the load or store instructions
10583 that update the base register to the address of the calculated memory
10584 location.  These instructions are generated by default.  If you use
10585 @option{-mno-update}, there is a small window between the time that the
10586 stack pointer is updated and the address of the previous frame is
10587 stored, which means code that walks the stack frame across interrupts or
10588 signals may get corrupted data.
10590 @item -mfused-madd
10591 @itemx -mno-fused-madd
10592 @opindex mfused-madd
10593 @opindex mno-fused-madd
10594 Generate code that uses (does not use) the floating point multiply and
10595 accumulate instructions.  These instructions are generated by default if
10596 hardware floating is used.
10598 @item -mno-bit-align
10599 @itemx -mbit-align
10600 @opindex mno-bit-align
10601 @opindex mbit-align
10602 On System V.4 and embedded PowerPC systems do not (do) force structures
10603 and unions that contain bit-fields to be aligned to the base type of the
10604 bit-field.
10606 For example, by default a structure containing nothing but 8
10607 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10608 boundary and have a size of 4 bytes.  By using @option{-mno-bit-align},
10609 the structure would be aligned to a 1 byte boundary and be one byte in
10610 size.
10612 @item -mno-strict-align
10613 @itemx -mstrict-align
10614 @opindex mno-strict-align
10615 @opindex mstrict-align
10616 On System V.4 and embedded PowerPC systems do not (do) assume that
10617 unaligned memory references will be handled by the system.
10619 @item -mrelocatable
10620 @itemx -mno-relocatable
10621 @opindex mrelocatable
10622 @opindex mno-relocatable
10623 On embedded PowerPC systems generate code that allows (does not allow)
10624 the program to be relocated to a different address at runtime.  If you
10625 use @option{-mrelocatable} on any module, all objects linked together must
10626 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10628 @item -mrelocatable-lib
10629 @itemx -mno-relocatable-lib
10630 @opindex mrelocatable-lib
10631 @opindex mno-relocatable-lib
10632 On embedded PowerPC systems generate code that allows (does not allow)
10633 the program to be relocated to a different address at runtime.  Modules
10634 compiled with @option{-mrelocatable-lib} can be linked with either modules
10635 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10636 with modules compiled with the @option{-mrelocatable} options.
10638 @item -mno-toc
10639 @itemx -mtoc
10640 @opindex mno-toc
10641 @opindex mtoc
10642 On System V.4 and embedded PowerPC systems do not (do) assume that
10643 register 2 contains a pointer to a global area pointing to the addresses
10644 used in the program.
10646 @item -mlittle
10647 @itemx -mlittle-endian
10648 @opindex mlittle
10649 @opindex mlittle-endian
10650 On System V.4 and embedded PowerPC systems compile code for the
10651 processor in little endian mode.  The @option{-mlittle-endian} option is
10652 the same as @option{-mlittle}.
10654 @item -mbig
10655 @itemx -mbig-endian
10656 @opindex mbig
10657 @opindex mbig-endian
10658 On System V.4 and embedded PowerPC systems compile code for the
10659 processor in big endian mode.  The @option{-mbig-endian} option is
10660 the same as @option{-mbig}.
10662 @item -mdynamic-no-pic
10663 @opindex mdynamic-no-pic
10664 On Darwin and Mac OS X systems, compile code so that it is not
10665 relocatable, but that its external references are relocatable.  The
10666 resulting code is suitable for applications, but not shared
10667 libraries.
10669 @item -mprioritize-restricted-insns=@var{priority}
10670 @opindex mprioritize-restricted-insns
10671 This option controls the priority that is assigned to
10672 dispatch-slot restricted instructions during the second scheduling
10673 pass.  The argument @var{priority} takes the value @var{0/1/2} to assign
10674 @var{no/highest/second-highest} priority to dispatch slot restricted
10675 instructions.
10677 @item -msched-costly-dep=@var{dependence_type}
10678 @opindex msched-costly-dep
10679 This option controls which dependences are considered costly
10680 by the target during instruction scheduling.  The argument
10681 @var{dependence_type} takes one of the following values:
10682 @var{no}: no dependence is costly,
10683 @var{all}: all dependences are costly,
10684 @var{true_store_to_load}: a true dependence from store to load is costly,
10685 @var{store_to_load}: any dependence from store to load is costly,
10686 @var{number}: any dependence which latency >= @var{number} is costly.
10688 @item -minsert-sched-nops=@var{scheme}
10689 @opindex minsert-sched-nops
10690 This option controls which nop insertion scheme will be used during
10691 the second scheduling pass.  The argument @var{scheme} takes one of the
10692 following values:
10693 @var{no}: Don't insert nops.
10694 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10695 according to the scheduler's grouping.
10696 @var{regroup_exact}: Insert nops to force costly dependent insns into
10697 separate groups.  Insert exactly as many nops as needed to force an insn
10698 to a new group, according to the estimated processor grouping.
10699 @var{number}: Insert nops to force costly dependent insns into
10700 separate groups.  Insert @var{number} nops to force an insn to a new group.
10702 @item -mcall-sysv
10703 @opindex mcall-sysv
10704 On System V.4 and embedded PowerPC systems compile code using calling
10705 conventions that adheres to the March 1995 draft of the System V
10706 Application Binary Interface, PowerPC processor supplement.  This is the
10707 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10709 @item -mcall-sysv-eabi
10710 @opindex mcall-sysv-eabi
10711 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10713 @item -mcall-sysv-noeabi
10714 @opindex mcall-sysv-noeabi
10715 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10717 @item -mcall-solaris
10718 @opindex mcall-solaris
10719 On System V.4 and embedded PowerPC systems compile code for the Solaris
10720 operating system.
10722 @item -mcall-linux
10723 @opindex mcall-linux
10724 On System V.4 and embedded PowerPC systems compile code for the
10725 Linux-based GNU system.
10727 @item -mcall-gnu
10728 @opindex mcall-gnu
10729 On System V.4 and embedded PowerPC systems compile code for the
10730 Hurd-based GNU system.
10732 @item -mcall-netbsd
10733 @opindex mcall-netbsd
10734 On System V.4 and embedded PowerPC systems compile code for the
10735 NetBSD operating system.
10737 @item -maix-struct-return
10738 @opindex maix-struct-return
10739 Return all structures in memory (as specified by the AIX ABI)@.
10741 @item -msvr4-struct-return
10742 @opindex msvr4-struct-return
10743 Return structures smaller than 8 bytes in registers (as specified by the
10744 SVR4 ABI)@.
10746 @item -mabi=altivec
10747 @opindex mabi=altivec
10748 Extend the current ABI with AltiVec ABI extensions.  This does not
10749 change the default ABI, instead it adds the AltiVec ABI extensions to
10750 the current ABI@.
10752 @item -mabi=no-altivec
10753 @opindex mabi=no-altivec
10754 Disable AltiVec ABI extensions for the current ABI@.
10756 @item -mprototype
10757 @itemx -mno-prototype
10758 @opindex mprototype
10759 @opindex mno-prototype
10760 On System V.4 and embedded PowerPC systems assume that all calls to
10761 variable argument functions are properly prototyped.  Otherwise, the
10762 compiler must insert an instruction before every non prototyped call to
10763 set or clear bit 6 of the condition code register (@var{CR}) to
10764 indicate whether floating point values were passed in the floating point
10765 registers in case the function takes a variable arguments.  With
10766 @option{-mprototype}, only calls to prototyped variable argument functions
10767 will set or clear the bit.
10769 @item -msim
10770 @opindex msim
10771 On embedded PowerPC systems, assume that the startup module is called
10772 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
10773 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}.
10774 configurations.
10776 @item -mmvme
10777 @opindex mmvme
10778 On embedded PowerPC systems, assume that the startup module is called
10779 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
10780 @file{libc.a}.
10782 @item -mads
10783 @opindex mads
10784 On embedded PowerPC systems, assume that the startup module is called
10785 @file{crt0.o} and the standard C libraries are @file{libads.a} and
10786 @file{libc.a}.
10788 @item -myellowknife
10789 @opindex myellowknife
10790 On embedded PowerPC systems, assume that the startup module is called
10791 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
10792 @file{libc.a}.
10794 @item -mvxworks
10795 @opindex mvxworks
10796 On System V.4 and embedded PowerPC systems, specify that you are
10797 compiling for a VxWorks system.
10799 @item -mwindiss
10800 @opindex mwindiss
10801 Specify that you are compiling for the WindISS simulation environment.
10803 @item -memb
10804 @opindex memb
10805 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
10806 header to indicate that @samp{eabi} extended relocations are used.
10808 @item -meabi
10809 @itemx -mno-eabi
10810 @opindex meabi
10811 @opindex mno-eabi
10812 On System V.4 and embedded PowerPC systems do (do not) adhere to the
10813 Embedded Applications Binary Interface (eabi) which is a set of
10814 modifications to the System V.4 specifications.  Selecting @option{-meabi}
10815 means that the stack is aligned to an 8 byte boundary, a function
10816 @code{__eabi} is called to from @code{main} to set up the eabi
10817 environment, and the @option{-msdata} option can use both @code{r2} and
10818 @code{r13} to point to two separate small data areas.  Selecting
10819 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
10820 do not call an initialization function from @code{main}, and the
10821 @option{-msdata} option will only use @code{r13} to point to a single
10822 small data area.  The @option{-meabi} option is on by default if you
10823 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
10825 @item -msdata=eabi
10826 @opindex msdata=eabi
10827 On System V.4 and embedded PowerPC systems, put small initialized
10828 @code{const} global and static data in the @samp{.sdata2} section, which
10829 is pointed to by register @code{r2}.  Put small initialized
10830 non-@code{const} global and static data in the @samp{.sdata} section,
10831 which is pointed to by register @code{r13}.  Put small uninitialized
10832 global and static data in the @samp{.sbss} section, which is adjacent to
10833 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
10834 incompatible with the @option{-mrelocatable} option.  The
10835 @option{-msdata=eabi} option also sets the @option{-memb} option.
10837 @item -msdata=sysv
10838 @opindex msdata=sysv
10839 On System V.4 and embedded PowerPC systems, put small global and static
10840 data in the @samp{.sdata} section, which is pointed to by register
10841 @code{r13}.  Put small uninitialized global and static data in the
10842 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
10843 The @option{-msdata=sysv} option is incompatible with the
10844 @option{-mrelocatable} option.
10846 @item -msdata=default
10847 @itemx -msdata
10848 @opindex msdata=default
10849 @opindex msdata
10850 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
10851 compile code the same as @option{-msdata=eabi}, otherwise compile code the
10852 same as @option{-msdata=sysv}.
10854 @item -msdata-data
10855 @opindex msdata-data
10856 On System V.4 and embedded PowerPC systems, put small global and static
10857 data in the @samp{.sdata} section.  Put small uninitialized global and
10858 static data in the @samp{.sbss} section.  Do not use register @code{r13}
10859 to address small data however.  This is the default behavior unless
10860 other @option{-msdata} options are used.
10862 @item -msdata=none
10863 @itemx -mno-sdata
10864 @opindex msdata=none
10865 @opindex mno-sdata
10866 On embedded PowerPC systems, put all initialized global and static data
10867 in the @samp{.data} section, and all uninitialized data in the
10868 @samp{.bss} section.
10870 @item -G @var{num}
10871 @opindex G
10872 @cindex smaller data references (PowerPC)
10873 @cindex .sdata/.sdata2 references (PowerPC)
10874 On embedded PowerPC systems, put global and static items less than or
10875 equal to @var{num} bytes into the small data or bss sections instead of
10876 the normal data or bss section.  By default, @var{num} is 8.  The
10877 @option{-G @var{num}} switch is also passed to the linker.
10878 All modules should be compiled with the same @option{-G @var{num}} value.
10880 @item -mregnames
10881 @itemx -mno-regnames
10882 @opindex mregnames
10883 @opindex mno-regnames
10884 On System V.4 and embedded PowerPC systems do (do not) emit register
10885 names in the assembly language output using symbolic forms.
10887 @item -mlongcall
10888 @itemx -mno-longcall
10889 @opindex mlongcall
10890 @opindex mno-longcall
10891 Default to making all function calls indirectly, using a register, so
10892 that functions which reside further than 32 megabytes (33,554,432
10893 bytes) from the current location can be called.  This setting can be
10894 overridden by the @code{shortcall} function attribute, or by
10895 @code{#pragma longcall(0)}.
10897 Some linkers are capable of detecting out-of-range calls and generating
10898 glue code on the fly.  On these systems, long calls are unnecessary and
10899 generate slower code.  As of this writing, the AIX linker can do this,
10900 as can the GNU linker for PowerPC/64.  It is planned to add this feature
10901 to the GNU linker for 32-bit PowerPC systems as well.
10903 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
10904 callee, L42'', plus a ``branch island'' (glue code).  The two target
10905 addresses represent the callee and the ``branch island''.  The
10906 Darwin/PPC linker will prefer the first address and generate a ``bl
10907 callee'' if the PPC ``bl'' instruction will reach the callee directly;
10908 otherwise, the linker will generate ``bl L42'' to call the ``branch
10909 island''.  The ``branch island'' is appended to the body of the
10910 calling function; it computes the full 32-bit address of the callee
10911 and jumps to it.
10913 On Mach-O (Darwin) systems, this option directs the compiler emit to
10914 the glue for every direct call, and the Darwin linker decides whether
10915 to use or discard it.
10917 In the future, we may cause GCC to ignore all longcall specifications
10918 when the linker is known to generate glue.
10920 @item -pthread
10921 @opindex pthread
10922 Adds support for multithreading with the @dfn{pthreads} library.
10923 This option sets flags for both the preprocessor and linker.
10925 @end table
10927 @node S/390 and zSeries Options
10928 @subsection S/390 and zSeries Options
10929 @cindex S/390 and zSeries Options
10931 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
10933 @table @gcctabopt
10934 @item -mhard-float
10935 @itemx -msoft-float
10936 @opindex mhard-float
10937 @opindex msoft-float
10938 Use (do not use) the hardware floating-point instructions and registers
10939 for floating-point operations.  When @option{-msoft-float} is specified,
10940 functions in @file{libgcc.a} will be used to perform floating-point
10941 operations.  When @option{-mhard-float} is specified, the compiler
10942 generates IEEE floating-point instructions.  This is the default.
10944 @item -mbackchain
10945 @itemx -mno-backchain
10946 @opindex mbackchain
10947 @opindex mno-backchain
10948 Store (do not store) the address of the caller's frame as backchain pointer
10949 into the callee's stack frame.
10950 A backchain may be needed to allow debugging using tools that do not understand
10951 DWARF-2 call frame information.
10952 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
10953 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
10954 the backchain is placed into the topmost word of the 96/160 byte register
10955 save area.
10957 In general, code compiled with @option{-mbackchain} is call-compatible with
10958 code compiled with @option{-mmo-backchain}; however, use of the backchain
10959 for debugging purposes usually requires that the whole binary is built with
10960 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
10961 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10962 to build a linux kernel use @option{-msoft-float}.
10964 The default is to not maintain the backchain.
10966 @item -mpacked-stack
10967 @item -mno-packed-stack
10968 @opindex mpacked-stack
10969 @opindex mno-packed-stack
10970 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
10971 specified, the compiler uses the all fields of the 96/160 byte register save
10972 area only for their default purpose; unused fields still take up stack space.
10973 When @option{-mpacked-stack} is specified, register save slots are densely
10974 packed at the top of the register save area; unused space is reused for other
10975 purposes, allowing for more efficient use of the available stack space.
10976 However, when @option{-mbackchain} is also in effect, the topmost word of
10977 the save area is always used to store the backchain, and the return address
10978 register is always saved two words below the backchain.
10980 As long as the stack frame backchain is not used, code generated with
10981 @option{-mpacked-stack} is call-compatible with code generated with
10982 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
10983 S/390 or zSeries generated code that uses the stack frame backchain at run
10984 time, not just for debugging purposes.  Such code is not call-compatible
10985 with code compiled with @option{-mpacked-stack}.  Also, note that the
10986 combination of @option{-mbackchain},
10987 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
10988 to build a linux kernel use @option{-msoft-float}.
10990 The default is to not use the packed stack layout.
10992 @item -msmall-exec
10993 @itemx -mno-small-exec
10994 @opindex msmall-exec
10995 @opindex mno-small-exec
10996 Generate (or do not generate) code using the @code{bras} instruction
10997 to do subroutine calls.
10998 This only works reliably if the total executable size does not
10999 exceed 64k.  The default is to use the @code{basr} instruction instead,
11000 which does not have this limitation.
11002 @item -m64
11003 @itemx -m31
11004 @opindex m64
11005 @opindex m31
11006 When @option{-m31} is specified, generate code compliant to the
11007 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
11008 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
11009 particular to generate 64-bit instructions.  For the @samp{s390}
11010 targets, the default is @option{-m31}, while the @samp{s390x}
11011 targets default to @option{-m64}.
11013 @item -mzarch
11014 @itemx -mesa
11015 @opindex mzarch
11016 @opindex mesa
11017 When @option{-mzarch} is specified, generate code using the
11018 instructions available on z/Architecture.
11019 When @option{-mesa} is specified, generate code using the
11020 instructions available on ESA/390.  Note that @option{-mesa} is
11021 not possible with @option{-m64}.
11022 When generating code compliant to the GNU/Linux for S/390 ABI,
11023 the default is @option{-mesa}.  When generating code compliant
11024 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11026 @item -mmvcle
11027 @itemx -mno-mvcle
11028 @opindex mmvcle
11029 @opindex mno-mvcle
11030 Generate (or do not generate) code using the @code{mvcle} instruction
11031 to perform block moves.  When @option{-mno-mvcle} is specified,
11032 use a @code{mvc} loop instead.  This is the default.
11034 @item -mdebug
11035 @itemx -mno-debug
11036 @opindex mdebug
11037 @opindex mno-debug
11038 Print (or do not print) additional debug information when compiling.
11039 The default is to not print debug information.
11041 @item -march=@var{cpu-type}
11042 @opindex march
11043 Generate code that will run on @var{cpu-type}, which is the name of a system
11044 representing a certain processor type.  Possible values for
11045 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11046 When generating code using the instructions available on z/Architecture,
11047 the default is @option{-march=z900}.  Otherwise, the default is
11048 @option{-march=g5}.
11050 @item -mtune=@var{cpu-type}
11051 @opindex mtune
11052 Tune to @var{cpu-type} everything applicable about the generated code,
11053 except for the ABI and the set of available instructions.
11054 The list of @var{cpu-type} values is the same as for @option{-march}.
11055 The default is the value used for @option{-march}.
11057 @item -mtpf-trace
11058 @itemx -mno-tpf-trace
11059 @opindex mtpf-trace
11060 @opindex mno-tpf-trace
11061 Generate code that adds (does not add) in TPF OS specific branches to trace
11062 routines in the operating system.  This option is off by default, even
11063 when compiling for the TPF OS@.
11065 @item -mfused-madd
11066 @itemx -mno-fused-madd
11067 @opindex mfused-madd
11068 @opindex mno-fused-madd
11069 Generate code that uses (does not use) the floating point multiply and
11070 accumulate instructions.  These instructions are generated by default if
11071 hardware floating point is used.
11073 @item -mwarn-framesize=@var{framesize}
11074 @opindex mwarn-framesize
11075 Emit a warning if the current function exceeds the given frame size.  Because
11076 this is a compile time check it doesn't need to be a real problem when the program
11077 runs.  It is intended to identify functions which most probably cause
11078 a stack overflow.  It is useful to be used in an environment with limited stack
11079 size e.g.@: the linux kernel.
11081 @item -mwarn-dynamicstack
11082 @opindex mwarn-dynamicstack
11083 Emit a warning if the function calls alloca or uses dynamically
11084 sized arrays.  This is generally a bad idea with a limited stack size.
11086 @item -mstack-guard=@var{stack-guard}
11087 @item -mstack-size=@var{stack-size}
11088 @opindex mstack-guard
11089 @opindex mstack-size
11090 These arguments always have to be used in conjunction.  If they are present the s390
11091 back end emits additional instructions in the function prologue which trigger a trap
11092 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11093 (remember that the stack on s390 grows downward).  These options are intended to
11094 be used to help debugging stack overflow problems.  The additionally emitted code
11095 cause only little overhead and hence can also be used in production like systems
11096 without greater performance degradation.  The given values have to be exact
11097 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11098 In order to be efficient the extra code makes the assumption that the stack starts
11099 at an address aligned to the value given by @var{stack-size}.
11100 @end table
11102 @node SH Options
11103 @subsection SH Options
11105 These @samp{-m} options are defined for the SH implementations:
11107 @table @gcctabopt
11108 @item -m1
11109 @opindex m1
11110 Generate code for the SH1.
11112 @item -m2
11113 @opindex m2
11114 Generate code for the SH2.
11116 @item -m2e
11117 Generate code for the SH2e.
11119 @item -m3
11120 @opindex m3
11121 Generate code for the SH3.
11123 @item -m3e
11124 @opindex m3e
11125 Generate code for the SH3e.
11127 @item -m4-nofpu
11128 @opindex m4-nofpu
11129 Generate code for the SH4 without a floating-point unit.
11131 @item -m4-single-only
11132 @opindex m4-single-only
11133 Generate code for the SH4 with a floating-point unit that only
11134 supports single-precision arithmetic.
11136 @item -m4-single
11137 @opindex m4-single
11138 Generate code for the SH4 assuming the floating-point unit is in
11139 single-precision mode by default.
11141 @item -m4
11142 @opindex m4
11143 Generate code for the SH4.
11145 @item -m4a-nofpu
11146 @opindex m4a-nofpu
11147 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11148 floating-point unit is not used.
11150 @item -m4a-single-only
11151 @opindex m4a-single-only
11152 Generate code for the SH4a, in such a way that no double-precision
11153 floating point operations are used.
11155 @item -m4a-single
11156 @opindex m4a-single
11157 Generate code for the SH4a assuming the floating-point unit is in
11158 single-precision mode by default.
11160 @item -m4a
11161 @opindex m4a
11162 Generate code for the SH4a.
11164 @item -m4al
11165 @opindex m4al
11166 Same as @option{-m4a-nofpu}, except that it implicitly passes
11167 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
11168 instructions at the moment.
11170 @item -mb
11171 @opindex mb
11172 Compile code for the processor in big endian mode.
11174 @item -ml
11175 @opindex ml
11176 Compile code for the processor in little endian mode.
11178 @item -mdalign
11179 @opindex mdalign
11180 Align doubles at 64-bit boundaries.  Note that this changes the calling
11181 conventions, and thus some functions from the standard C library will
11182 not work unless you recompile it first with @option{-mdalign}.
11184 @item -mrelax
11185 @opindex mrelax
11186 Shorten some address references at link time, when possible; uses the
11187 linker option @option{-relax}.
11189 @item -mbigtable
11190 @opindex mbigtable
11191 Use 32-bit offsets in @code{switch} tables.  The default is to use
11192 16-bit offsets.
11194 @item -mfmovd
11195 @opindex mfmovd
11196 Enable the use of the instruction @code{fmovd}.
11198 @item -mhitachi
11199 @opindex mhitachi
11200 Comply with the calling conventions defined by Renesas.
11202 @item -mrenesas
11203 @opindex mhitachi
11204 Comply with the calling conventions defined by Renesas.
11206 @item -mno-renesas
11207 @opindex mhitachi
11208 Comply with the calling conventions defined for GCC before the Renesas
11209 conventions were available.  This option is the default for all
11210 targets of the SH toolchain except for @samp{sh-symbianelf}.
11212 @item -mnomacsave
11213 @opindex mnomacsave
11214 Mark the @code{MAC} register as call-clobbered, even if
11215 @option{-mhitachi} is given.
11217 @item -mieee
11218 @opindex mieee
11219 Increase IEEE-compliance of floating-point code.
11221 @item -misize
11222 @opindex misize
11223 Dump instruction size and location in the assembly code.
11225 @item -mpadstruct
11226 @opindex mpadstruct
11227 This option is deprecated.  It pads structures to multiple of 4 bytes,
11228 which is incompatible with the SH ABI@.
11230 @item -mspace
11231 @opindex mspace
11232 Optimize for space instead of speed.  Implied by @option{-Os}.
11234 @item -mprefergot
11235 @opindex mprefergot
11236 When generating position-independent code, emit function calls using
11237 the Global Offset Table instead of the Procedure Linkage Table.
11239 @item -musermode
11240 @opindex musermode
11241 Generate a library function call to invalidate instruction cache
11242 entries, after fixing up a trampoline.  This library function call
11243 doesn't assume it can write to the whole memory address space.  This
11244 is the default when the target is @code{sh-*-linux*}.
11245 @end table
11247 @node SPARC Options
11248 @subsection SPARC Options
11249 @cindex SPARC options
11251 These @samp{-m} options are supported on the SPARC:
11253 @table @gcctabopt
11254 @item -mno-app-regs
11255 @itemx -mapp-regs
11256 @opindex mno-app-regs
11257 @opindex mapp-regs
11258 Specify @option{-mapp-regs} to generate output using the global registers
11259 2 through 4, which the SPARC SVR4 ABI reserves for applications.  This
11260 is the default.
11262 To be fully SVR4 ABI compliant at the cost of some performance loss,
11263 specify @option{-mno-app-regs}.  You should compile libraries and system
11264 software with this option.
11266 @item -mfpu
11267 @itemx -mhard-float
11268 @opindex mfpu
11269 @opindex mhard-float
11270 Generate output containing floating point instructions.  This is the
11271 default.
11273 @item -mno-fpu
11274 @itemx -msoft-float
11275 @opindex mno-fpu
11276 @opindex msoft-float
11277 Generate output containing library calls for floating point.
11278 @strong{Warning:} the requisite libraries are not available for all SPARC
11279 targets.  Normally the facilities of the machine's usual C compiler are
11280 used, but this cannot be done directly in cross-compilation.  You must make
11281 your own arrangements to provide suitable library functions for
11282 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
11283 @samp{sparclite-*-*} do provide software floating point support.
11285 @option{-msoft-float} changes the calling convention in the output file;
11286 therefore, it is only useful if you compile @emph{all} of a program with
11287 this option.  In particular, you need to compile @file{libgcc.a}, the
11288 library that comes with GCC, with @option{-msoft-float} in order for
11289 this to work.
11291 @item -mhard-quad-float
11292 @opindex mhard-quad-float
11293 Generate output containing quad-word (long double) floating point
11294 instructions.
11296 @item -msoft-quad-float
11297 @opindex msoft-quad-float
11298 Generate output containing library calls for quad-word (long double)
11299 floating point instructions.  The functions called are those specified
11300 in the SPARC ABI@.  This is the default.
11302 As of this writing, there are no SPARC implementations that have hardware
11303 support for the quad-word floating point instructions.  They all invoke
11304 a trap handler for one of these instructions, and then the trap handler
11305 emulates the effect of the instruction.  Because of the trap handler overhead,
11306 this is much slower than calling the ABI library routines.  Thus the
11307 @option{-msoft-quad-float} option is the default.
11309 @item -mno-unaligned-doubles
11310 @itemx -munaligned-doubles
11311 @opindex mno-unaligned-doubles
11312 @opindex munaligned-doubles
11313 Assume that doubles have 8 byte alignment.  This is the default.
11315 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11316 alignment only if they are contained in another type, or if they have an
11317 absolute address.  Otherwise, it assumes they have 4 byte alignment.
11318 Specifying this option avoids some rare compatibility problems with code
11319 generated by other compilers.  It is not the default because it results
11320 in a performance loss, especially for floating point code.
11322 @item -mno-faster-structs
11323 @itemx -mfaster-structs
11324 @opindex mno-faster-structs
11325 @opindex mfaster-structs
11326 With @option{-mfaster-structs}, the compiler assumes that structures
11327 should have 8 byte alignment.  This enables the use of pairs of
11328 @code{ldd} and @code{std} instructions for copies in structure
11329 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11330 However, the use of this changed alignment directly violates the SPARC
11331 ABI@.  Thus, it's intended only for use on targets where the developer
11332 acknowledges that their resulting code will not be directly in line with
11333 the rules of the ABI@.
11335 @item -mimpure-text
11336 @opindex mimpure-text
11337 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11338 the compiler to not pass @option{-z text} to the linker when linking a
11339 shared object.  Using this option, you can link position-dependent
11340 code into a shared object.
11342 @option{-mimpure-text} suppresses the ``relocations remain against
11343 allocatable but non-writable sections'' linker error message.
11344 However, the necessary relocations will trigger copy-on-write, and the
11345 shared object is not actually shared across processes.  Instead of
11346 using @option{-mimpure-text}, you should compile all source code with
11347 @option{-fpic} or @option{-fPIC}.
11349 This option is only available on SunOS and Solaris.
11351 @item -mcpu=@var{cpu_type}
11352 @opindex mcpu
11353 Set the instruction set, register set, and instruction scheduling parameters
11354 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
11355 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11356 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11357 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11358 @samp{ultrasparc3}.
11360 Default instruction scheduling parameters are used for values that select
11361 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
11362 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11364 Here is a list of each supported architecture and their supported
11365 implementations.
11367 @smallexample
11368     v7:             cypress
11369     v8:             supersparc, hypersparc
11370     sparclite:      f930, f934, sparclite86x
11371     sparclet:       tsc701
11372     v9:             ultrasparc, ultrasparc3
11373 @end smallexample
11375 By default (unless configured otherwise), GCC generates code for the V7
11376 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
11377 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11378 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
11379 SPARCStation 1, 2, IPX etc.
11381 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11382 architecture.  The only difference from V7 code is that the compiler emits
11383 the integer multiply and integer divide instructions which exist in SPARC-V8
11384 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
11385 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11386 2000 series.
11388 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11389 the SPARC architecture.  This adds the integer multiply, integer divide step
11390 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11391 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11392 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
11393 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11394 MB86934 chip, which is the more recent SPARClite with FPU@.
11396 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11397 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
11398 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11399 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
11400 optimizes it for the TEMIC SPARClet chip.
11402 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11403 architecture.  This adds 64-bit integer and floating-point move instructions,
11404 3 additional floating-point condition code registers and conditional move
11405 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
11406 optimizes it for the Sun UltraSPARC I/II chips.  With
11407 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11408 Sun UltraSPARC III chip.
11410 @item -mtune=@var{cpu_type}
11411 @opindex mtune
11412 Set the instruction scheduling parameters for machine type
11413 @var{cpu_type}, but do not set the instruction set or register set that the
11414 option @option{-mcpu=@var{cpu_type}} would.
11416 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11417 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11418 that select a particular cpu implementation.  Those are @samp{cypress},
11419 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11420 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11421 @samp{ultrasparc3}.
11423 @item -mv8plus
11424 @itemx -mno-v8plus
11425 @opindex mv8plus
11426 @opindex mno-v8plus
11427 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
11428 difference from the V8 ABI is that the global and out registers are
11429 considered 64-bit wide.  This is enabled by default on Solaris in 32-bit
11430 mode for all SPARC-V9 processors.
11432 @item -mvis
11433 @itemx -mno-vis
11434 @opindex mvis
11435 @opindex mno-vis
11436 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11437 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
11438 @end table
11440 These @samp{-m} options are supported in addition to the above
11441 on SPARC-V9 processors in 64-bit environments:
11443 @table @gcctabopt
11444 @item -mlittle-endian
11445 @opindex mlittle-endian
11446 Generate code for a processor running in little-endian mode.  It is only
11447 available for a few configurations and most notably not on Solaris.
11449 @item -m32
11450 @itemx -m64
11451 @opindex m32
11452 @opindex m64
11453 Generate code for a 32-bit or 64-bit environment.
11454 The 32-bit environment sets int, long and pointer to 32 bits.
11455 The 64-bit environment sets int to 32 bits and long and pointer
11456 to 64 bits.
11458 @item -mcmodel=medlow
11459 @opindex mcmodel=medlow
11460 Generate code for the Medium/Low code model: 64-bit addresses, programs
11461 must be linked in the low 32 bits of memory.  Programs can be statically
11462 or dynamically linked.
11464 @item -mcmodel=medmid
11465 @opindex mcmodel=medmid
11466 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11467 must be linked in the low 44 bits of memory, the text and data segments must
11468 be less than 2GB in size and the data segment must be located within 2GB of
11469 the text segment.
11471 @item -mcmodel=medany
11472 @opindex mcmodel=medany
11473 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11474 may be linked anywhere in memory, the text and data segments must be less
11475 than 2GB in size and the data segment must be located within 2GB of the
11476 text segment.
11478 @item -mcmodel=embmedany
11479 @opindex mcmodel=embmedany
11480 Generate code for the Medium/Anywhere code model for embedded systems:
11481 64-bit addresses, the text and data segments must be less than 2GB in
11482 size, both starting anywhere in memory (determined at link time).  The
11483 global register %g4 points to the base of the data segment.  Programs
11484 are statically linked and PIC is not supported.
11486 @item -mstack-bias
11487 @itemx -mno-stack-bias
11488 @opindex mstack-bias
11489 @opindex mno-stack-bias
11490 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11491 frame pointer if present, are offset by @minus{}2047 which must be added back
11492 when making stack frame references.  This is the default in 64-bit mode.
11493 Otherwise, assume no such offset is present.
11494 @end table
11496 These switches are supported in addition to the above on Solaris:
11498 @table @gcctabopt
11499 @item -threads
11500 @opindex threads
11501 Add support for multithreading using the Solaris threads library.  This
11502 option sets flags for both the preprocessor and linker.  This option does
11503 not affect the thread safety of object code produced by the compiler or
11504 that of libraries supplied with it.
11506 @item -pthreads
11507 @opindex pthreads
11508 Add support for multithreading using the POSIX threads library.  This
11509 option sets flags for both the preprocessor and linker.  This option does
11510 not affect the thread safety of object code produced  by the compiler or
11511 that of libraries supplied with it.
11512 @end table
11514 @node System V Options
11515 @subsection Options for System V
11517 These additional options are available on System V Release 4 for
11518 compatibility with other compilers on those systems:
11520 @table @gcctabopt
11521 @item -G
11522 @opindex G
11523 Create a shared object.
11524 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11526 @item -Qy
11527 @opindex Qy
11528 Identify the versions of each tool used by the compiler, in a
11529 @code{.ident} assembler directive in the output.
11531 @item -Qn
11532 @opindex Qn
11533 Refrain from adding @code{.ident} directives to the output file (this is
11534 the default).
11536 @item -YP,@var{dirs}
11537 @opindex YP
11538 Search the directories @var{dirs}, and no others, for libraries
11539 specified with @option{-l}.
11541 @item -Ym,@var{dir}
11542 @opindex Ym
11543 Look in the directory @var{dir} to find the M4 preprocessor.
11544 The assembler uses this option.
11545 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11546 @c the generic assembler that comes with Solaris takes just -Ym.
11547 @end table
11549 @node TMS320C3x/C4x Options
11550 @subsection TMS320C3x/C4x Options
11551 @cindex TMS320C3x/C4x Options
11553 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11555 @table @gcctabopt
11557 @item -mcpu=@var{cpu_type}
11558 @opindex mcpu
11559 Set the instruction set, register set, and instruction scheduling
11560 parameters for machine type @var{cpu_type}.  Supported values for
11561 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11562 @samp{c44}.  The default is @samp{c40} to generate code for the
11563 TMS320C40.
11565 @item -mbig-memory
11566 @itemx -mbig
11567 @itemx -msmall-memory
11568 @itemx -msmall
11569 @opindex mbig-memory
11570 @opindex mbig
11571 @opindex msmall-memory
11572 @opindex msmall
11573 Generates code for the big or small memory model.  The small memory
11574 model assumed that all data fits into one 64K word page.  At run-time
11575 the data page (DP) register must be set to point to the 64K page
11576 containing the .bss and .data program sections.  The big memory model is
11577 the default and requires reloading of the DP register for every direct
11578 memory access.
11580 @item -mbk
11581 @itemx -mno-bk
11582 @opindex mbk
11583 @opindex mno-bk
11584 Allow (disallow) allocation of general integer operands into the block
11585 count register BK@.
11587 @item -mdb
11588 @itemx -mno-db
11589 @opindex mdb
11590 @opindex mno-db
11591 Enable (disable) generation of code using decrement and branch,
11592 DBcond(D), instructions.  This is enabled by default for the C4x.  To be
11593 on the safe side, this is disabled for the C3x, since the maximum
11594 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11595 @math{2^{23}} times on the C3x?).  Note that GCC will try to reverse a loop so
11596 that it can utilize the decrement and branch instruction, but will give
11597 up if there is more than one memory reference in the loop.  Thus a loop
11598 where the loop counter is decremented can generate slightly more
11599 efficient code, in cases where the RPTB instruction cannot be utilized.
11601 @item -mdp-isr-reload
11602 @itemx -mparanoid
11603 @opindex mdp-isr-reload
11604 @opindex mparanoid
11605 Force the DP register to be saved on entry to an interrupt service
11606 routine (ISR), reloaded to point to the data section, and restored on
11607 exit from the ISR@.  This should not be required unless someone has
11608 violated the small memory model by modifying the DP register, say within
11609 an object library.
11611 @item -mmpyi
11612 @itemx -mno-mpyi
11613 @opindex mmpyi
11614 @opindex mno-mpyi
11615 For the C3x use the 24-bit MPYI instruction for integer multiplies
11616 instead of a library call to guarantee 32-bit results.  Note that if one
11617 of the operands is a constant, then the multiplication will be performed
11618 using shifts and adds.  If the @option{-mmpyi} option is not specified for the C3x,
11619 then squaring operations are performed inline instead of a library call.
11621 @item -mfast-fix
11622 @itemx -mno-fast-fix
11623 @opindex mfast-fix
11624 @opindex mno-fast-fix
11625 The C3x/C4x FIX instruction to convert a floating point value to an
11626 integer value chooses the nearest integer less than or equal to the
11627 floating point value rather than to the nearest integer.  Thus if the
11628 floating point number is negative, the result will be incorrectly
11629 truncated an additional code is necessary to detect and correct this
11630 case.  This option can be used to disable generation of the additional
11631 code required to correct the result.
11633 @item -mrptb
11634 @itemx -mno-rptb
11635 @opindex mrptb
11636 @opindex mno-rptb
11637 Enable (disable) generation of repeat block sequences using the RPTB
11638 instruction for zero overhead looping.  The RPTB construct is only used
11639 for innermost loops that do not call functions or jump across the loop
11640 boundaries.  There is no advantage having nested RPTB loops due to the
11641 overhead required to save and restore the RC, RS, and RE registers.
11642 This is enabled by default with @option{-O2}.
11644 @item -mrpts=@var{count}
11645 @itemx -mno-rpts
11646 @opindex mrpts
11647 @opindex mno-rpts
11648 Enable (disable) the use of the single instruction repeat instruction
11649 RPTS@.  If a repeat block contains a single instruction, and the loop
11650 count can be guaranteed to be less than the value @var{count}, GCC will
11651 emit a RPTS instruction instead of a RPTB@.  If no value is specified,
11652 then a RPTS will be emitted even if the loop count cannot be determined
11653 at compile time.  Note that the repeated instruction following RPTS does
11654 not have to be reloaded from memory each iteration, thus freeing up the
11655 CPU buses for operands.  However, since interrupts are blocked by this
11656 instruction, it is disabled by default.
11658 @item -mloop-unsigned
11659 @itemx -mno-loop-unsigned
11660 @opindex mloop-unsigned
11661 @opindex mno-loop-unsigned
11662 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11663 is @math{2^{31} + 1} since these instructions test if the iteration count is
11664 negative to terminate the loop.  If the iteration count is unsigned
11665 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11666 exceeded.  This switch allows an unsigned iteration count.
11668 @item -mti
11669 @opindex mti
11670 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11671 with.  This also enforces compatibility with the API employed by the TI
11672 C3x C compiler.  For example, long doubles are passed as structures
11673 rather than in floating point registers.
11675 @item -mregparm
11676 @itemx -mmemparm
11677 @opindex mregparm
11678 @opindex mmemparm
11679 Generate code that uses registers (stack) for passing arguments to functions.
11680 By default, arguments are passed in registers where possible rather
11681 than by pushing arguments on to the stack.
11683 @item -mparallel-insns
11684 @itemx -mno-parallel-insns
11685 @opindex mparallel-insns
11686 @opindex mno-parallel-insns
11687 Allow the generation of parallel instructions.  This is enabled by
11688 default with @option{-O2}.
11690 @item -mparallel-mpy
11691 @itemx -mno-parallel-mpy
11692 @opindex mparallel-mpy
11693 @opindex mno-parallel-mpy
11694 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11695 provided @option{-mparallel-insns} is also specified.  These instructions have
11696 tight register constraints which can pessimize the code generation
11697 of large functions.
11699 @end table
11701 @node V850 Options
11702 @subsection V850 Options
11703 @cindex V850 Options
11705 These @samp{-m} options are defined for V850 implementations:
11707 @table @gcctabopt
11708 @item -mlong-calls
11709 @itemx -mno-long-calls
11710 @opindex mlong-calls
11711 @opindex mno-long-calls
11712 Treat all calls as being far away (near).  If calls are assumed to be
11713 far away, the compiler will always load the functions address up into a
11714 register, and call indirect through the pointer.
11716 @item -mno-ep
11717 @itemx -mep
11718 @opindex mno-ep
11719 @opindex mep
11720 Do not optimize (do optimize) basic blocks that use the same index
11721 pointer 4 or more times to copy pointer into the @code{ep} register, and
11722 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
11723 option is on by default if you optimize.
11725 @item -mno-prolog-function
11726 @itemx -mprolog-function
11727 @opindex mno-prolog-function
11728 @opindex mprolog-function
11729 Do not use (do use) external functions to save and restore registers
11730 at the prologue and epilogue of a function.  The external functions
11731 are slower, but use less code space if more than one function saves
11732 the same number of registers.  The @option{-mprolog-function} option
11733 is on by default if you optimize.
11735 @item -mspace
11736 @opindex mspace
11737 Try to make the code as small as possible.  At present, this just turns
11738 on the @option{-mep} and @option{-mprolog-function} options.
11740 @item -mtda=@var{n}
11741 @opindex mtda
11742 Put static or global variables whose size is @var{n} bytes or less into
11743 the tiny data area that register @code{ep} points to.  The tiny data
11744 area can hold up to 256 bytes in total (128 bytes for byte references).
11746 @item -msda=@var{n}
11747 @opindex msda
11748 Put static or global variables whose size is @var{n} bytes or less into
11749 the small data area that register @code{gp} points to.  The small data
11750 area can hold up to 64 kilobytes.
11752 @item -mzda=@var{n}
11753 @opindex mzda
11754 Put static or global variables whose size is @var{n} bytes or less into
11755 the first 32 kilobytes of memory.
11757 @item -mv850
11758 @opindex mv850
11759 Specify that the target processor is the V850.
11761 @item -mbig-switch
11762 @opindex mbig-switch
11763 Generate code suitable for big switch tables.  Use this option only if
11764 the assembler/linker complain about out of range branches within a switch
11765 table.
11767 @item -mapp-regs
11768 @opindex mapp-regs
11769 This option will cause r2 and r5 to be used in the code generated by
11770 the compiler.  This setting is the default.
11772 @item -mno-app-regs
11773 @opindex mno-app-regs
11774 This option will cause r2 and r5 to be treated as fixed registers.
11776 @item -mv850e1
11777 @opindex mv850e1
11778 Specify that the target processor is the V850E1.  The preprocessor
11779 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
11780 this option is used.
11782 @item -mv850e
11783 @opindex mv850e
11784 Specify that the target processor is the V850E@.  The preprocessor
11785 constant @samp{__v850e__} will be defined if this option is used.
11787 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
11788 are defined then a default target processor will be chosen and the
11789 relevant @samp{__v850*__} preprocessor constant will be defined.
11791 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
11792 defined, regardless of which processor variant is the target.
11794 @item -mdisable-callt
11795 @opindex mdisable-callt
11796 This option will suppress generation of the CALLT instruction for the
11797 v850e and v850e1 flavors of the v850 architecture.  The default is
11798 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
11800 @end table
11802 @node VAX Options
11803 @subsection VAX Options
11804 @cindex VAX options
11806 These @samp{-m} options are defined for the VAX:
11808 @table @gcctabopt
11809 @item -munix
11810 @opindex munix
11811 Do not output certain jump instructions (@code{aobleq} and so on)
11812 that the Unix assembler for the VAX cannot handle across long
11813 ranges.
11815 @item -mgnu
11816 @opindex mgnu
11817 Do output those jump instructions, on the assumption that you
11818 will assemble with the GNU assembler.
11820 @item -mg
11821 @opindex mg
11822 Output code for g-format floating point numbers instead of d-format.
11823 @end table
11825 @node x86-64 Options
11826 @subsection x86-64 Options
11827 @cindex x86-64 options
11829 These are listed under @xref{i386 and x86-64 Options}.
11831 @node Xstormy16 Options
11832 @subsection Xstormy16 Options
11833 @cindex Xstormy16 Options
11835 These options are defined for Xstormy16:
11837 @table @gcctabopt
11838 @item -msim
11839 @opindex msim
11840 Choose startup files and linker script suitable for the simulator.
11841 @end table
11843 @node Xtensa Options
11844 @subsection Xtensa Options
11845 @cindex Xtensa Options
11847 These options are supported for Xtensa targets:
11849 @table @gcctabopt
11850 @item -mconst16
11851 @itemx -mno-const16
11852 @opindex mconst16
11853 @opindex mno-const16
11854 Enable or disable use of @code{CONST16} instructions for loading
11855 constant values.  The @code{CONST16} instruction is currently not a
11856 standard option from Tensilica.  When enabled, @code{CONST16}
11857 instructions are always used in place of the standard @code{L32R}
11858 instructions.  The use of @code{CONST16} is enabled by default only if
11859 the @code{L32R} instruction is not available.
11861 @item -mfused-madd
11862 @itemx -mno-fused-madd
11863 @opindex mfused-madd
11864 @opindex mno-fused-madd
11865 Enable or disable use of fused multiply/add and multiply/subtract
11866 instructions in the floating-point option.  This has no effect if the
11867 floating-point option is not also enabled.  Disabling fused multiply/add
11868 and multiply/subtract instructions forces the compiler to use separate
11869 instructions for the multiply and add/subtract operations.  This may be
11870 desirable in some cases where strict IEEE 754-compliant results are
11871 required: the fused multiply add/subtract instructions do not round the
11872 intermediate result, thereby producing results with @emph{more} bits of
11873 precision than specified by the IEEE standard.  Disabling fused multiply
11874 add/subtract instructions also ensures that the program output is not
11875 sensitive to the compiler's ability to combine multiply and add/subtract
11876 operations.
11878 @item -mtext-section-literals
11879 @itemx -mno-text-section-literals
11880 @opindex mtext-section-literals
11881 @opindex mno-text-section-literals
11882 Control the treatment of literal pools.  The default is
11883 @option{-mno-text-section-literals}, which places literals in a separate
11884 section in the output file.  This allows the literal pool to be placed
11885 in a data RAM/ROM, and it also allows the linker to combine literal
11886 pools from separate object files to remove redundant literals and
11887 improve code size.  With @option{-mtext-section-literals}, the literals
11888 are interspersed in the text section in order to keep them as close as
11889 possible to their references.  This may be necessary for large assembly
11890 files.
11892 @item -mtarget-align
11893 @itemx -mno-target-align
11894 @opindex mtarget-align
11895 @opindex mno-target-align
11896 When this option is enabled, GCC instructs the assembler to
11897 automatically align instructions to reduce branch penalties at the
11898 expense of some code density.  The assembler attempts to widen density
11899 instructions to align branch targets and the instructions following call
11900 instructions.  If there are not enough preceding safe density
11901 instructions to align a target, no widening will be performed.  The
11902 default is @option{-mtarget-align}.  These options do not affect the
11903 treatment of auto-aligned instructions like @code{LOOP}, which the
11904 assembler will always align, either by widening density instructions or
11905 by inserting no-op instructions.
11907 @item -mlongcalls
11908 @itemx -mno-longcalls
11909 @opindex mlongcalls
11910 @opindex mno-longcalls
11911 When this option is enabled, GCC instructs the assembler to translate
11912 direct calls to indirect calls unless it can determine that the target
11913 of a direct call is in the range allowed by the call instruction.  This
11914 translation typically occurs for calls to functions in other source
11915 files.  Specifically, the assembler translates a direct @code{CALL}
11916 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
11917 The default is @option{-mno-longcalls}.  This option should be used in
11918 programs where the call target can potentially be out of range.  This
11919 option is implemented in the assembler, not the compiler, so the
11920 assembly code generated by GCC will still show direct call
11921 instructions---look at the disassembled object code to see the actual
11922 instructions.  Note that the assembler will use an indirect call for
11923 every cross-file call, not just those that really will be out of range.
11924 @end table
11926 @node zSeries Options
11927 @subsection zSeries Options
11928 @cindex zSeries options
11930 These are listed under @xref{S/390 and zSeries Options}.
11932 @node Code Gen Options
11933 @section Options for Code Generation Conventions
11934 @cindex code generation conventions
11935 @cindex options, code generation
11936 @cindex run-time options
11938 These machine-independent options control the interface conventions
11939 used in code generation.
11941 Most of them have both positive and negative forms; the negative form
11942 of @option{-ffoo} would be @option{-fno-foo}.  In the table below, only
11943 one of the forms is listed---the one which is not the default.  You
11944 can figure out the other form by either removing @samp{no-} or adding
11947 @table @gcctabopt
11948 @item -fbounds-check
11949 @opindex fbounds-check
11950 For front-ends that support it, generate additional code to check that
11951 indices used to access arrays are within the declared range.  This is
11952 currently only supported by the Java and Fortran 77 front-ends, where
11953 this option defaults to true and false respectively.
11955 @item -ftrapv
11956 @opindex ftrapv
11957 This option generates traps for signed overflow on addition, subtraction,
11958 multiplication operations.
11960 @item -fwrapv
11961 @opindex fwrapv
11962 This option instructs the compiler to assume that signed arithmetic
11963 overflow of addition, subtraction and multiplication wraps around
11964 using twos-complement representation.  This flag enables some optimizations
11965 and disables other.  This option is enabled by default for the Java
11966 front-end, as required by the Java language specification.
11968 @item -fexceptions
11969 @opindex fexceptions
11970 Enable exception handling.  Generates extra code needed to propagate
11971 exceptions.  For some targets, this implies GCC will generate frame
11972 unwind information for all functions, which can produce significant data
11973 size overhead, although it does not affect execution.  If you do not
11974 specify this option, GCC will enable it by default for languages like
11975 C++ which normally require exception handling, and disable it for
11976 languages like C that do not normally require it.  However, you may need
11977 to enable this option when compiling C code that needs to interoperate
11978 properly with exception handlers written in C++.  You may also wish to
11979 disable this option if you are compiling older C++ programs that don't
11980 use exception handling.
11982 @item -fnon-call-exceptions
11983 @opindex fnon-call-exceptions
11984 Generate code that allows trapping instructions to throw exceptions.
11985 Note that this requires platform-specific runtime support that does
11986 not exist everywhere.  Moreover, it only allows @emph{trapping}
11987 instructions to throw exceptions, i.e.@: memory references or floating
11988 point instructions.  It does not allow exceptions to be thrown from
11989 arbitrary signal handlers such as @code{SIGALRM}.
11991 @item -funwind-tables
11992 @opindex funwind-tables
11993 Similar to @option{-fexceptions}, except that it will just generate any needed
11994 static data, but will not affect the generated code in any other way.
11995 You will normally not enable this option; instead, a language processor
11996 that needs this handling would enable it on your behalf.
11998 @item -fasynchronous-unwind-tables
11999 @opindex fasynchronous-unwind-tables
12000 Generate unwind table in dwarf2 format, if supported by target machine.  The
12001 table is exact at each instruction boundary, so it can be used for stack
12002 unwinding from asynchronous events (such as debugger or garbage collector).
12004 @item -fpcc-struct-return
12005 @opindex fpcc-struct-return
12006 Return ``short'' @code{struct} and @code{union} values in memory like
12007 longer ones, rather than in registers.  This convention is less
12008 efficient, but it has the advantage of allowing intercallability between
12009 GCC-compiled files and files compiled with other compilers, particularly
12010 the Portable C Compiler (pcc).
12012 The precise convention for returning structures in memory depends
12013 on the target configuration macros.
12015 Short structures and unions are those whose size and alignment match
12016 that of some integer type.
12018 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12019 switch is not binary compatible with code compiled with the
12020 @option{-freg-struct-return} switch.
12021 Use it to conform to a non-default application binary interface.
12023 @item -freg-struct-return
12024 @opindex freg-struct-return
12025 Return @code{struct} and @code{union} values in registers when possible.
12026 This is more efficient for small structures than
12027 @option{-fpcc-struct-return}.
12029 If you specify neither @option{-fpcc-struct-return} nor
12030 @option{-freg-struct-return}, GCC defaults to whichever convention is
12031 standard for the target.  If there is no standard convention, GCC
12032 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12033 the principal compiler.  In those cases, we can choose the standard, and
12034 we chose the more efficient register return alternative.
12036 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12037 switch is not binary compatible with code compiled with the
12038 @option{-fpcc-struct-return} switch.
12039 Use it to conform to a non-default application binary interface.
12041 @item -fshort-enums
12042 @opindex fshort-enums
12043 Allocate to an @code{enum} type only as many bytes as it needs for the
12044 declared range of possible values.  Specifically, the @code{enum} type
12045 will be equivalent to the smallest integer type which has enough room.
12047 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12048 code that is not binary compatible with code generated without that switch.
12049 Use it to conform to a non-default application binary interface.
12051 @item -fshort-double
12052 @opindex fshort-double
12053 Use the same size for @code{double} as for @code{float}.
12055 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12056 code that is not binary compatible with code generated without that switch.
12057 Use it to conform to a non-default application binary interface.
12059 @item -fshort-wchar
12060 @opindex fshort-wchar
12061 Override the underlying type for @samp{wchar_t} to be @samp{short
12062 unsigned int} instead of the default for the target.  This option is
12063 useful for building programs to run under WINE@.
12065 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12066 code that is not binary compatible with code generated without that switch.
12067 Use it to conform to a non-default application binary interface.
12069 @item -fshared-data
12070 @opindex fshared-data
12071 Requests that the data and non-@code{const} variables of this
12072 compilation be shared data rather than private data.  The distinction
12073 makes sense only on certain operating systems, where shared data is
12074 shared between processes running the same program, while private data
12075 exists in one copy per process.
12077 @item -fno-common
12078 @opindex fno-common
12079 In C, allocate even uninitialized global variables in the data section of the
12080 object file, rather than generating them as common blocks.  This has the
12081 effect that if the same variable is declared (without @code{extern}) in
12082 two different compilations, you will get an error when you link them.
12083 The only reason this might be useful is if you wish to verify that the
12084 program will work on other systems which always work this way.
12086 @item -fno-ident
12087 @opindex fno-ident
12088 Ignore the @samp{#ident} directive.
12090 @item -finhibit-size-directive
12091 @opindex finhibit-size-directive
12092 Don't output a @code{.size} assembler directive, or anything else that
12093 would cause trouble if the function is split in the middle, and the
12094 two halves are placed at locations far apart in memory.  This option is
12095 used when compiling @file{crtstuff.c}; you should not need to use it
12096 for anything else.
12098 @item -fverbose-asm
12099 @opindex fverbose-asm
12100 Put extra commentary information in the generated assembly code to
12101 make it more readable.  This option is generally only of use to those
12102 who actually need to read the generated assembly code (perhaps while
12103 debugging the compiler itself).
12105 @option{-fno-verbose-asm}, the default, causes the
12106 extra information to be omitted and is useful when comparing two assembler
12107 files.
12109 @item -fpic
12110 @opindex fpic
12111 @cindex global offset table
12112 @cindex PIC
12113 Generate position-independent code (PIC) suitable for use in a shared
12114 library, if supported for the target machine.  Such code accesses all
12115 constant addresses through a global offset table (GOT)@.  The dynamic
12116 loader resolves the GOT entries when the program starts (the dynamic
12117 loader is not part of GCC; it is part of the operating system).  If
12118 the GOT size for the linked executable exceeds a machine-specific
12119 maximum size, you get an error message from the linker indicating that
12120 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12121 instead.  (These maximums are 8k on the SPARC and 32k
12122 on the m68k and RS/6000.  The 386 has no such limit.)
12124 Position-independent code requires special support, and therefore works
12125 only on certain machines.  For the 386, GCC supports PIC for System V
12126 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
12127 position-independent.
12129 @item -fPIC
12130 @opindex fPIC
12131 If supported for the target machine, emit position-independent code,
12132 suitable for dynamic linking and avoiding any limit on the size of the
12133 global offset table.  This option makes a difference on the m68k,
12134 PowerPC and SPARC@.
12136 Position-independent code requires special support, and therefore works
12137 only on certain machines.
12139 @item -fpie
12140 @itemx -fPIE
12141 @opindex fpie
12142 @opindex fPIE
12143 These options are similar to @option{-fpic} and @option{-fPIC}, but
12144 generated position independent code can be only linked into executables.
12145 Usually these options are used when @option{-pie} GCC option will be
12146 used during linking.
12148 @item -ffixed-@var{reg}
12149 @opindex ffixed
12150 Treat the register named @var{reg} as a fixed register; generated code
12151 should never refer to it (except perhaps as a stack pointer, frame
12152 pointer or in some other fixed role).
12154 @var{reg} must be the name of a register.  The register names accepted
12155 are machine-specific and are defined in the @code{REGISTER_NAMES}
12156 macro in the machine description macro file.
12158 This flag does not have a negative form, because it specifies a
12159 three-way choice.
12161 @item -fcall-used-@var{reg}
12162 @opindex fcall-used
12163 Treat the register named @var{reg} as an allocable register that is
12164 clobbered by function calls.  It may be allocated for temporaries or
12165 variables that do not live across a call.  Functions compiled this way
12166 will not save and restore the register @var{reg}.
12168 It is an error to used this flag with the frame pointer or stack pointer.
12169 Use of this flag for other registers that have fixed pervasive roles in
12170 the machine's execution model will produce disastrous results.
12172 This flag does not have a negative form, because it specifies a
12173 three-way choice.
12175 @item -fcall-saved-@var{reg}
12176 @opindex fcall-saved
12177 Treat the register named @var{reg} as an allocable register saved by
12178 functions.  It may be allocated even for temporaries or variables that
12179 live across a call.  Functions compiled this way will save and restore
12180 the register @var{reg} if they use it.
12182 It is an error to used this flag with the frame pointer or stack pointer.
12183 Use of this flag for other registers that have fixed pervasive roles in
12184 the machine's execution model will produce disastrous results.
12186 A different sort of disaster will result from the use of this flag for
12187 a register in which function values may be returned.
12189 This flag does not have a negative form, because it specifies a
12190 three-way choice.
12192 @item -fpack-struct[=@var{n}]
12193 @opindex fpack-struct
12194 Without a value specified, pack all structure members together without
12195 holes.  When a value is specified (which must be a small power of two), pack
12196 structure members according to this value, representing the maximum
12197 alignment (that is, objects with default alignment requirements larger than
12198 this will be output potentially unaligned at the next fitting location.
12200 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12201 code that is not binary compatible with code generated without that switch.
12202 Additionally, it makes the code suboptimal.
12203 Use it to conform to a non-default application binary interface.
12205 @item -finstrument-functions
12206 @opindex finstrument-functions
12207 Generate instrumentation calls for entry and exit to functions.  Just
12208 after function entry and just before function exit, the following
12209 profiling functions will be called with the address of the current
12210 function and its call site.  (On some platforms,
12211 @code{__builtin_return_address} does not work beyond the current
12212 function, so the call site information may not be available to the
12213 profiling functions otherwise.)
12215 @smallexample
12216 void __cyg_profile_func_enter (void *this_fn,
12217                                void *call_site);
12218 void __cyg_profile_func_exit  (void *this_fn,
12219                                void *call_site);
12220 @end smallexample
12222 The first argument is the address of the start of the current function,
12223 which may be looked up exactly in the symbol table.
12225 This instrumentation is also done for functions expanded inline in other
12226 functions.  The profiling calls will indicate where, conceptually, the
12227 inline function is entered and exited.  This means that addressable
12228 versions of such functions must be available.  If all your uses of a
12229 function are expanded inline, this may mean an additional expansion of
12230 code size.  If you use @samp{extern inline} in your C code, an
12231 addressable version of such functions must be provided.  (This is
12232 normally the case anyways, but if you get lucky and the optimizer always
12233 expands the functions inline, you might have gotten away without
12234 providing static copies.)
12236 A function may be given the attribute @code{no_instrument_function}, in
12237 which case this instrumentation will not be done.  This can be used, for
12238 example, for the profiling functions listed above, high-priority
12239 interrupt routines, and any functions from which the profiling functions
12240 cannot safely be called (perhaps signal handlers, if the profiling
12241 routines generate output or allocate memory).
12243 @item -fstack-check
12244 @opindex fstack-check
12245 Generate code to verify that you do not go beyond the boundary of the
12246 stack.  You should specify this flag if you are running in an
12247 environment with multiple threads, but only rarely need to specify it in
12248 a single-threaded environment since stack overflow is automatically
12249 detected on nearly all systems if there is only one stack.
12251 Note that this switch does not actually cause checking to be done; the
12252 operating system must do that.  The switch causes generation of code
12253 to ensure that the operating system sees the stack being extended.
12255 @item -fstack-limit-register=@var{reg}
12256 @itemx -fstack-limit-symbol=@var{sym}
12257 @itemx -fno-stack-limit
12258 @opindex fstack-limit-register
12259 @opindex fstack-limit-symbol
12260 @opindex fno-stack-limit
12261 Generate code to ensure that the stack does not grow beyond a certain value,
12262 either the value of a register or the address of a symbol.  If the stack
12263 would grow beyond the value, a signal is raised.  For most targets,
12264 the signal is raised before the stack overruns the boundary, so
12265 it is possible to catch the signal without taking special precautions.
12267 For instance, if the stack starts at absolute address @samp{0x80000000}
12268 and grows downwards, you can use the flags
12269 @option{-fstack-limit-symbol=__stack_limit} and
12270 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12271 of 128KB@.  Note that this may only work with the GNU linker.
12273 @cindex aliasing of parameters
12274 @cindex parameters, aliased
12275 @item -fargument-alias
12276 @itemx -fargument-noalias
12277 @itemx -fargument-noalias-global
12278 @opindex fargument-alias
12279 @opindex fargument-noalias
12280 @opindex fargument-noalias-global
12281 Specify the possible relationships among parameters and between
12282 parameters and global data.
12284 @option{-fargument-alias} specifies that arguments (parameters) may
12285 alias each other and may alias global storage.@*
12286 @option{-fargument-noalias} specifies that arguments do not alias
12287 each other, but may alias global storage.@*
12288 @option{-fargument-noalias-global} specifies that arguments do not
12289 alias each other and do not alias global storage.
12291 Each language will automatically use whatever option is required by
12292 the language standard.  You should not need to use these options yourself.
12294 @item -fleading-underscore
12295 @opindex fleading-underscore
12296 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12297 change the way C symbols are represented in the object file.  One use
12298 is to help link with legacy assembly code.
12300 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12301 generate code that is not binary compatible with code generated without that
12302 switch.  Use it to conform to a non-default application binary interface.
12303 Not all targets provide complete support for this switch.
12305 @item -ftls-model=@var{model}
12306 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12307 The @var{model} argument should be one of @code{global-dynamic},
12308 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12310 The default without @option{-fpic} is @code{initial-exec}; with
12311 @option{-fpic} the default is @code{global-dynamic}.
12313 @item -fvisibility=@var{default|internal|hidden|protected}
12314 @opindex fvisibility
12315 Set the default ELF image symbol visibility to the specified option---all
12316 symbols will be marked with this unless overridden within the code.
12317 Using this feature can very substantially improve linking and
12318 load times of shared object libraries, produce more optimized
12319 code, provide near-perfect API export and prevent symbol clashes.
12320 It is @strong{strongly} recommended that you use this in any shared objects
12321 you distribute.
12323 Despite the nomenclature, @code{default} always means public ie;
12324 available to be linked against from outside the shared object.
12325 @code{protected} and @code{internal} are pretty useless in real-world
12326 usage so the only other commonly used option will be @code{hidden}.
12327 The default if @option{-fvisibility} isn't specified is
12328 @code{default}, i.e., make every
12329 symbol public---this causes the same behavior as previous versions of
12330 GCC@.
12332 A good explanation of the benefits offered by ensuring ELF
12333 symbols have the correct visibility is given by ``How To Write
12334 Shared Libraries'' by Ulrich Drepper (which can be found at
12335 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12336 solution made possible by this option to marking things hidden when
12337 the default is public is to make the default hidden and mark things
12338 public.  This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12339 and @code{__attribute__ ((visibility("default")))} instead of
12340 @code{__declspec(dllexport)} you get almost identical semantics with
12341 identical syntax.  This is a great boon to those working with
12342 cross-platform projects.
12344 For those adding visibility support to existing code, you may find
12345 @samp{#pragma GCC visibility} of use.  This works by you enclosing
12346 the declarations you wish to set visibility for with (for example)
12347 @samp{#pragma GCC visibility push(hidden)} and
12348 @samp{#pragma GCC visibility pop}.  These can be nested up to sixteen
12349 times.  Bear in mind that symbol visibility should be viewed @strong{as
12350 part of the API interface contract} and thus all new code should
12351 always specify visibility when it is not the default ie; declarations
12352 only for use within the local DSO should @strong{always} be marked explicitly
12353 as hidden as so to avoid PLT indirection overheads---making this
12354 abundantly clear also aids readability and self-documentation of the code.
12355 Note that due to ISO C++ specification requirements, operator new and
12356 operator delete must always be of default visibility.
12358 An overview of these techniques, their benefits and how to use them
12359 is at @w{@uref{http://www.nedprod.com/programs/gccvisibility.html}}.
12361 @end table
12363 @c man end
12365 @node Environment Variables
12366 @section Environment Variables Affecting GCC
12367 @cindex environment variables
12369 @c man begin ENVIRONMENT
12370 This section describes several environment variables that affect how GCC
12371 operates.  Some of them work by specifying directories or prefixes to use
12372 when searching for various kinds of files.  Some are used to specify other
12373 aspects of the compilation environment.
12375 Note that you can also specify places to search using options such as
12376 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
12377 take precedence over places specified using environment variables, which
12378 in turn take precedence over those specified by the configuration of GCC@.
12379 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12380 GNU Compiler Collection (GCC) Internals}.
12382 @table @env
12383 @item LANG
12384 @itemx LC_CTYPE
12385 @c @itemx LC_COLLATE
12386 @itemx LC_MESSAGES
12387 @c @itemx LC_MONETARY
12388 @c @itemx LC_NUMERIC
12389 @c @itemx LC_TIME
12390 @itemx LC_ALL
12391 @findex LANG
12392 @findex LC_CTYPE
12393 @c @findex LC_COLLATE
12394 @findex LC_MESSAGES
12395 @c @findex LC_MONETARY
12396 @c @findex LC_NUMERIC
12397 @c @findex LC_TIME
12398 @findex LC_ALL
12399 @cindex locale
12400 These environment variables control the way that GCC uses
12401 localization information that allow GCC to work with different
12402 national conventions.  GCC inspects the locale categories
12403 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12404 so.  These locale categories can be set to any value supported by your
12405 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
12406 Kingdom encoded in UTF-8.
12408 The @env{LC_CTYPE} environment variable specifies character
12409 classification.  GCC uses it to determine the character boundaries in
12410 a string; this is needed for some multibyte encodings that contain quote
12411 and escape characters that would otherwise be interpreted as a string
12412 end or escape.
12414 The @env{LC_MESSAGES} environment variable specifies the language to
12415 use in diagnostic messages.
12417 If the @env{LC_ALL} environment variable is set, it overrides the value
12418 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12419 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12420 environment variable.  If none of these variables are set, GCC
12421 defaults to traditional C English behavior.
12423 @item TMPDIR
12424 @findex TMPDIR
12425 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12426 files.  GCC uses temporary files to hold the output of one stage of
12427 compilation which is to be used as input to the next stage: for example,
12428 the output of the preprocessor, which is the input to the compiler
12429 proper.
12431 @item GCC_EXEC_PREFIX
12432 @findex GCC_EXEC_PREFIX
12433 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12434 names of the subprograms executed by the compiler.  No slash is added
12435 when this prefix is combined with the name of a subprogram, but you can
12436 specify a prefix that ends with a slash if you wish.
12438 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12439 an appropriate prefix to use based on the pathname it was invoked with.
12441 If GCC cannot find the subprogram using the specified prefix, it
12442 tries looking in the usual places for the subprogram.
12444 The default value of @env{GCC_EXEC_PREFIX} is
12445 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12446 of @code{prefix} when you ran the @file{configure} script.
12448 Other prefixes specified with @option{-B} take precedence over this prefix.
12450 This prefix is also used for finding files such as @file{crt0.o} that are
12451 used for linking.
12453 In addition, the prefix is used in an unusual way in finding the
12454 directories to search for header files.  For each of the standard
12455 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12456 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12457 replacing that beginning with the specified prefix to produce an
12458 alternate directory name.  Thus, with @option{-Bfoo/}, GCC will search
12459 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12460 These alternate directories are searched first; the standard directories
12461 come next.
12463 @item COMPILER_PATH
12464 @findex COMPILER_PATH
12465 The value of @env{COMPILER_PATH} is a colon-separated list of
12466 directories, much like @env{PATH}.  GCC tries the directories thus
12467 specified when searching for subprograms, if it can't find the
12468 subprograms using @env{GCC_EXEC_PREFIX}.
12470 @item LIBRARY_PATH
12471 @findex LIBRARY_PATH
12472 The value of @env{LIBRARY_PATH} is a colon-separated list of
12473 directories, much like @env{PATH}.  When configured as a native compiler,
12474 GCC tries the directories thus specified when searching for special
12475 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
12476 using GCC also uses these directories when searching for ordinary
12477 libraries for the @option{-l} option (but directories specified with
12478 @option{-L} come first).
12480 @item LANG
12481 @findex LANG
12482 @cindex locale definition
12483 This variable is used to pass locale information to the compiler.  One way in
12484 which this information is used is to determine the character set to be used
12485 when character literals, string literals and comments are parsed in C and C++.
12486 When the compiler is configured to allow multibyte characters,
12487 the following values for @env{LANG} are recognized:
12489 @table @samp
12490 @item C-JIS
12491 Recognize JIS characters.
12492 @item C-SJIS
12493 Recognize SJIS characters.
12494 @item C-EUCJP
12495 Recognize EUCJP characters.
12496 @end table
12498 If @env{LANG} is not defined, or if it has some other value, then the
12499 compiler will use mblen and mbtowc as defined by the default locale to
12500 recognize and translate multibyte characters.
12501 @end table
12503 @noindent
12504 Some additional environments variables affect the behavior of the
12505 preprocessor.
12507 @include cppenv.texi
12509 @c man end
12511 @node Precompiled Headers
12512 @section Using Precompiled Headers
12513 @cindex precompiled headers
12514 @cindex speed of compilation
12516 Often large projects have many header files that are included in every
12517 source file.  The time the compiler takes to process these header files
12518 over and over again can account for nearly all of the time required to
12519 build the project.  To make builds faster, GCC allows users to
12520 `precompile' a header file; then, if builds can use the precompiled
12521 header file they will be much faster.
12523 @strong{Caution:} There are a few known situations where GCC will
12524 crash when trying to use a precompiled header.  If you have trouble
12525 with a precompiled header, you should remove the precompiled header
12526 and compile without it.  In addition, please use GCC's on-line
12527 defect-tracking system to report any problems you encounter with
12528 precompiled headers.  @xref{Bugs}.
12530 To create a precompiled header file, simply compile it as you would any
12531 other file, if necessary using the @option{-x} option to make the driver
12532 treat it as a C or C++ header file.  You will probably want to use a
12533 tool like @command{make} to keep the precompiled header up-to-date when
12534 the headers it contains change.
12536 A precompiled header file will be searched for when @code{#include} is
12537 seen in the compilation.  As it searches for the included file
12538 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12539 compiler looks for a precompiled header in each directory just before it
12540 looks for the include file in that directory.  The name searched for is
12541 the name specified in the @code{#include} with @samp{.gch} appended.  If
12542 the precompiled header file can't be used, it is ignored.
12544 For instance, if you have @code{#include "all.h"}, and you have
12545 @file{all.h.gch} in the same directory as @file{all.h}, then the
12546 precompiled header file will be used if possible, and the original
12547 header will be used otherwise.
12549 Alternatively, you might decide to put the precompiled header file in a
12550 directory and use @option{-I} to ensure that directory is searched
12551 before (or instead of) the directory containing the original header.
12552 Then, if you want to check that the precompiled header file is always
12553 used, you can put a file of the same name as the original header in this
12554 directory containing an @code{#error} command.
12556 This also works with @option{-include}.  So yet another way to use
12557 precompiled headers, good for projects not designed with precompiled
12558 header files in mind, is to simply take most of the header files used by
12559 a project, include them from another header file, precompile that header
12560 file, and @option{-include} the precompiled header.  If the header files
12561 have guards against multiple inclusion, they will be skipped because
12562 they've already been included (in the precompiled header).
12564 If you need to precompile the same header file for different
12565 languages, targets, or compiler options, you can instead make a
12566 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12567 header in the directory, perhaps using @option{-o}.  It doesn't matter
12568 what you call the files in the directory, every precompiled header in
12569 the directory will be considered.  The first precompiled header
12570 encountered in the directory that is valid for this compilation will
12571 be used; they're searched in no particular order.
12573 There are many other possibilities, limited only by your imagination,
12574 good sense, and the constraints of your build system.
12576 A precompiled header file can be used only when these conditions apply:
12578 @itemize
12579 @item
12580 Only one precompiled header can be used in a particular compilation.
12582 @item
12583 A precompiled header can't be used once the first C token is seen.  You
12584 can have preprocessor directives before a precompiled header; you can
12585 even include a precompiled header from inside another header, so long as
12586 there are no C tokens before the @code{#include}.
12588 @item
12589 The precompiled header file must be produced for the same language as
12590 the current compilation.  You can't use a C precompiled header for a C++
12591 compilation.
12593 @item
12594 The precompiled header file must be produced by the same compiler
12595 version and configuration as the current compilation is using.
12596 The easiest way to guarantee this is to use the same compiler binary
12597 for creating and using precompiled headers.
12599 @item
12600 Any macros defined before the precompiled header is included must
12601 either be defined in the same way as when the precompiled header was
12602 generated, or must not affect the precompiled header, which usually
12603 means that the they don't appear in the precompiled header at all.
12605 The @option{-D} option is one way to define a macro before a
12606 precompiled header is included; using a @code{#define} can also do it.
12607 There are also some options that define macros implicitly, like
12608 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12609 defined this way.
12611 @item If debugging information is output when using the precompiled
12612 header, using @option{-g} or similar, the same kind of debugging information
12613 must have been output when building the precompiled header.  However,
12614 a precompiled header built using @option{-g} can be used in a compilation
12615 when no debugging information is being output.
12617 @item The same @option{-m} options must generally be used when building
12618 and using the precompiled header.  @xref{Submodel Options},
12619 for any cases where this rule is relaxed.
12621 @item Each of the following options must be the same when building and using
12622 the precompiled header:
12624 @gccoptlist{-fexceptions -funit-at-a-time}
12626 @item
12627 Some other command-line options starting with @option{-f},
12628 @option{-p}, or @option{-O} must be defined in the same way as when
12629 the precompiled header was generated.  At present, it's not clear
12630 which options are safe to change and which are not; the safest choice
12631 is to use exactly the same options when generating and using the
12632 precompiled header.  The following are known to be safe:
12634 @gccoptlist{-fpreprocessed -pedantic-errors}
12636 @end itemize
12638 For all of these except the last, the compiler will automatically
12639 ignore the precompiled header if the conditions aren't met.  If you
12640 find an option combination that doesn't work and doesn't cause the
12641 precompiled header to be ignored, please consider filing a bug report,
12642 see @ref{Bugs}.
12644 If you do use differing options when generating and using the
12645 precompiled header, the actual behavior will be a mixture of the
12646 behavior for the options.  For instance, if you use @option{-g} to
12647 generate the precompiled header but not when using it, you may or may
12648 not get debugging information for routines in the precompiled header.
12650 @node Running Protoize
12651 @section Running Protoize
12653 The program @code{protoize} is an optional part of GCC@.  You can use
12654 it to add prototypes to a program, thus converting the program to ISO
12655 C in one respect.  The companion program @code{unprotoize} does the
12656 reverse: it removes argument types from any prototypes that are found.
12658 When you run these programs, you must specify a set of source files as
12659 command line arguments.  The conversion programs start out by compiling
12660 these files to see what functions they define.  The information gathered
12661 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12663 After scanning comes actual conversion.  The specified files are all
12664 eligible to be converted; any files they include (whether sources or
12665 just headers) are eligible as well.
12667 But not all the eligible files are converted.  By default,
12668 @code{protoize} and @code{unprotoize} convert only source and header
12669 files in the current directory.  You can specify additional directories
12670 whose files should be converted with the @option{-d @var{directory}}
12671 option.  You can also specify particular files to exclude with the
12672 @option{-x @var{file}} option.  A file is converted if it is eligible, its
12673 directory name matches one of the specified directory names, and its
12674 name within the directory has not been excluded.
12676 Basic conversion with @code{protoize} consists of rewriting most
12677 function definitions and function declarations to specify the types of
12678 the arguments.  The only ones not rewritten are those for varargs
12679 functions.
12681 @code{protoize} optionally inserts prototype declarations at the
12682 beginning of the source file, to make them available for any calls that
12683 precede the function's definition.  Or it can insert prototype
12684 declarations with block scope in the blocks where undeclared functions
12685 are called.
12687 Basic conversion with @code{unprotoize} consists of rewriting most
12688 function declarations to remove any argument types, and rewriting
12689 function definitions to the old-style pre-ISO form.
12691 Both conversion programs print a warning for any function declaration or
12692 definition that they can't convert.  You can suppress these warnings
12693 with @option{-q}.
12695 The output from @code{protoize} or @code{unprotoize} replaces the
12696 original source file.  The original file is renamed to a name ending
12697 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12698 without the original @samp{.c} suffix).  If the @samp{.save} (@samp{.sav}
12699 for DOS) file already exists, then the source file is simply discarded.
12701 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12702 scan the program and collect information about the functions it uses.
12703 So neither of these programs will work until GCC is installed.
12705 Here is a table of the options you can use with @code{protoize} and
12706 @code{unprotoize}.  Each option works with both programs unless
12707 otherwise stated.
12709 @table @code
12710 @item -B @var{directory}
12711 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12712 usual directory (normally @file{/usr/local/lib}).  This file contains
12713 prototype information about standard system functions.  This option
12714 applies only to @code{protoize}.
12716 @item -c @var{compilation-options}
12717 Use @var{compilation-options} as the options when running @command{gcc} to
12718 produce the @samp{.X} files.  The special option @option{-aux-info} is
12719 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12721 Note that the compilation options must be given as a single argument to
12722 @code{protoize} or @code{unprotoize}.  If you want to specify several
12723 @command{gcc} options, you must quote the entire set of compilation options
12724 to make them a single word in the shell.
12726 There are certain @command{gcc} arguments that you cannot use, because they
12727 would produce the wrong kind of output.  These include @option{-g},
12728 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12729 the @var{compilation-options}, they are ignored.
12731 @item -C
12732 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12733 systems) instead of @samp{.c}.  This is convenient if you are converting
12734 a C program to C++.  This option applies only to @code{protoize}.
12736 @item -g
12737 Add explicit global declarations.  This means inserting explicit
12738 declarations at the beginning of each source file for each function
12739 that is called in the file and was not declared.  These declarations
12740 precede the first function definition that contains a call to an
12741 undeclared function.  This option applies only to @code{protoize}.
12743 @item -i @var{string}
12744 Indent old-style parameter declarations with the string @var{string}.
12745 This option applies only to @code{protoize}.
12747 @code{unprotoize} converts prototyped function definitions to old-style
12748 function definitions, where the arguments are declared between the
12749 argument list and the initial @samp{@{}.  By default, @code{unprotoize}
12750 uses five spaces as the indentation.  If you want to indent with just
12751 one space instead, use @option{-i " "}.
12753 @item -k
12754 Keep the @samp{.X} files.  Normally, they are deleted after conversion
12755 is finished.
12757 @item -l
12758 Add explicit local declarations.  @code{protoize} with @option{-l} inserts
12759 a prototype declaration for each function in each block which calls the
12760 function without any declaration.  This option applies only to
12761 @code{protoize}.
12763 @item -n
12764 Make no real changes.  This mode just prints information about the conversions
12765 that would have been done without @option{-n}.
12767 @item -N
12768 Make no @samp{.save} files.  The original files are simply deleted.
12769 Use this option with caution.
12771 @item -p @var{program}
12772 Use the program @var{program} as the compiler.  Normally, the name
12773 @file{gcc} is used.
12775 @item -q
12776 Work quietly.  Most warnings are suppressed.
12778 @item -v
12779 Print the version number, just like @option{-v} for @command{gcc}.
12780 @end table
12782 If you need special compiler options to compile one of your program's
12783 source files, then you should generate that file's @samp{.X} file
12784 specially, by running @command{gcc} on that source file with the
12785 appropriate options and the option @option{-aux-info}.  Then run
12786 @code{protoize} on the entire set of files.  @code{protoize} will use
12787 the existing @samp{.X} file because it is newer than the source file.
12788 For example:
12790 @smallexample
12791 gcc -Dfoo=bar file1.c -aux-info file1.X
12792 protoize *.c
12793 @end smallexample
12795 @noindent
12796 You need to include the special files along with the rest in the
12797 @code{protoize} command, even though their @samp{.X} files already
12798 exist, because otherwise they won't get converted.
12800 @xref{Protoize Caveats}, for more information on how to use
12801 @code{protoize} successfully.