1ddd4fe0c3ec58b0bd8155198c854fac4deefbf6
[gcc.git] / gcc / doc / invoke.texi
1 @c Copyright (C) 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2 @c 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin INCLUDE
8 @include gcc-vers.texi
9 @c man end
10
11 @c man begin COPYRIGHT
12 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
13 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
14
15 Permission is granted to copy, distribute and/or modify this document
16 under the terms of the GNU Free Documentation License, Version 1.2 or
17 any later version published by the Free Software Foundation; with the
18 Invariant Sections being ``GNU General Public License'' and ``Funding
19 Free Software'', the Front-Cover texts being (a) (see below), and with
20 the Back-Cover Texts being (b) (see below). A copy of the license is
21 included in the gfdl(7) man page.
22
23 (a) The FSF's Front-Cover Text is:
24
25 A GNU Manual
26
27 (b) The FSF's Back-Cover Text is:
28
29 You have freedom to copy and modify this GNU Manual, like GNU
30 software. Copies published by the Free Software Foundation raise
31 funds for GNU development.
32 @c man end
33 @c Set file name and title for the man page.
34 @setfilename gcc
35 @settitle GNU project C and C++ compiler
36 @c man begin SYNOPSIS
37 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
38 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
39 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
40 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
41 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
42 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
43 [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
44
45 Only the most useful options are listed here; see below for the
46 remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
47 @c man end
48 @c man begin SEEALSO
49 gpl(7), gfdl(7), fsf-funding(7),
50 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
51 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
52 @file{ld}, @file{binutils} and @file{gdb}.
53 @c man end
54 @c man begin BUGS
55 For instructions on reporting bugs, see
56 @w{@uref{http://gcc.gnu.org/bugs.html}}.
57 @c man end
58 @c man begin AUTHOR
59 See the Info entry for @command{gcc}, or
60 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
61 for contributors to GCC@.
62 @c man end
63 @end ignore
64
65 @node Invoking GCC
66 @chapter GCC Command Options
67 @cindex GCC command options
68 @cindex command options
69 @cindex options, GCC command
70
71 @c man begin DESCRIPTION
72 When you invoke GCC, it normally does preprocessing, compilation,
73 assembly and linking. The ``overall options'' allow you to stop this
74 process at an intermediate stage. For example, the @option{-c} option
75 says not to run the linker. Then the output consists of object files
76 output by the assembler.
77
78 Other options are passed on to one stage of processing. Some options
79 control the preprocessor and others the compiler itself. Yet other
80 options control the assembler and linker; most of these are not
81 documented here, since you rarely need to use any of them.
82
83 @cindex C compilation options
84 Most of the command line options that you can use with GCC are useful
85 for C programs; when an option is only useful with another language
86 (usually C++), the explanation says so explicitly. If the description
87 for a particular option does not mention a source language, you can use
88 that option with all supported languages.
89
90 @cindex C++ compilation options
91 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
92 options for compiling C++ programs.
93
94 @cindex grouping options
95 @cindex options, grouping
96 The @command{gcc} program accepts options and file names as operands. Many
97 options have multi-letter names; therefore multiple single-letter options
98 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
99 -r}}.
100
101 @cindex order of options
102 @cindex options, order
103 You can mix options and other arguments. For the most part, the order
104 you use doesn't matter. Order does matter when you use several options
105 of the same kind; for example, if you specify @option{-L} more than once,
106 the directories are searched in the order specified.
107
108 Many options have long names starting with @samp{-f} or with
109 @samp{-W}---for example,
110 @option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
111 these have both positive and negative forms; the negative form of
112 @option{-ffoo} would be @option{-fno-foo}. This manual documents
113 only one of these two forms, whichever one is not the default.
114
115 @c man end
116
117 @xref{Option Index}, for an index to GCC's options.
118
119 @menu
120 * Option Summary:: Brief list of all options, without explanations.
121 * Overall Options:: Controlling the kind of output:
122 an executable, object files, assembler files,
123 or preprocessed source.
124 * Invoking G++:: Compiling C++ programs.
125 * C Dialect Options:: Controlling the variant of C language compiled.
126 * C++ Dialect Options:: Variations on C++.
127 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
128 and Objective-C++.
129 * Language Independent Options:: Controlling how diagnostics should be
130 formatted.
131 * Warning Options:: How picky should the compiler be?
132 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
133 * Optimize Options:: How much optimization?
134 * Preprocessor Options:: Controlling header files and macro definitions.
135 Also, getting dependency information for Make.
136 * Assembler Options:: Passing options to the assembler.
137 * Link Options:: Specifying libraries and so on.
138 * Directory Options:: Where to find header files and libraries.
139 Where to find the compiler executable files.
140 * Spec Files:: How to pass switches to sub-processes.
141 * Target Options:: Running a cross-compiler, or an old version of GCC.
142 * Submodel Options:: Specifying minor hardware or convention variations,
143 such as 68010 vs 68020.
144 * Code Gen Options:: Specifying conventions for function calls, data layout
145 and register usage.
146 * Environment Variables:: Env vars that affect GCC.
147 * Precompiled Headers:: Compiling a header once, and using it many times.
148 * Running Protoize:: Automatically adding or removing function prototypes.
149 @end menu
150
151 @c man begin OPTIONS
152
153 @node Option Summary
154 @section Option Summary
155
156 Here is a summary of all the options, grouped by type. Explanations are
157 in the following sections.
158
159 @table @emph
160 @item Overall Options
161 @xref{Overall Options,,Options Controlling the Kind of Output}.
162 @gccoptlist{-c -S -E -o @var{file} -combine -pipe -pass-exit-codes @gol
163 -x @var{language} -v -### --help --target-help --version @@@var{file}}
164
165 @item C Language Options
166 @xref{C Dialect Options,,Options Controlling C Dialect}.
167 @gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename} @gol
168 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
169 -fhosted -ffreestanding -fms-extensions @gol
170 -trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
171 -fallow-single-precision -fcond-mismatch @gol
172 -fsigned-bitfields -fsigned-char @gol
173 -funsigned-bitfields -funsigned-char}
174
175 @item C++ Language Options
176 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
177 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
178 -fconserve-space -ffriend-injection @gol
179 -fno-elide-constructors @gol
180 -fno-enforce-eh-specs @gol
181 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
182 -fno-implicit-templates @gol
183 -fno-implicit-inline-templates @gol
184 -fno-implement-inlines -fms-extensions @gol
185 -fno-nonansi-builtins -fno-operator-names @gol
186 -fno-optional-diags -fpermissive @gol
187 -frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
188 -fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
189 -fno-default-inline -fvisibility-inlines-hidden @gol
190 -Wabi -Wctor-dtor-privacy @gol
191 -Wnon-virtual-dtor -Wreorder @gol
192 -Weffc++ -Wno-deprecated -Wstrict-null-sentinel @gol
193 -Wno-non-template-friend -Wold-style-cast @gol
194 -Woverloaded-virtual -Wno-pmf-conversions @gol
195 -Wsign-promo}
196
197 @item Objective-C and Objective-C++ Language Options
198 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
199 Objective-C and Objective-C++ Dialects}.
200 @gccoptlist{
201 -fconstant-string-class=@var{class-name} @gol
202 -fgnu-runtime -fnext-runtime @gol
203 -fno-nil-receivers @gol
204 -fobjc-call-cxx-cdtors @gol
205 -fobjc-direct-dispatch @gol
206 -fobjc-exceptions @gol
207 -fobjc-gc @gol
208 -freplace-objc-classes @gol
209 -fzero-link @gol
210 -gen-decls @gol
211 -Wassign-intercept @gol
212 -Wno-protocol -Wselector @gol
213 -Wstrict-selector-match @gol
214 -Wundeclared-selector}
215
216 @item Language Independent Options
217 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
218 @gccoptlist{-fmessage-length=@var{n} @gol
219 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
220 -fdiagnostics-show-options
221
222 @item Warning Options
223 @xref{Warning Options,,Options to Request or Suppress Warnings}.
224 @gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
225 -w -Wextra -Wall -Waggregate-return -Walways-true -Wno-attributes @gol
226 -Wc++-compat -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
227 -Wconversion -Wno-deprecated-declarations @gol
228 -Wdisabled-optimization -Wno-div-by-zero -Wno-endif-labels @gol
229 -Werror -Werror-* -Werror-implicit-function-declaration @gol
230 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
231 -Wno-format-extra-args -Wformat-nonliteral @gol
232 -Wformat-security -Wformat-y2k @gol
233 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
234 -Wimport -Wno-import -Winit-self -Winline @gol
235 -Wno-int-to-pointer-cast @gol
236 -Wno-invalid-offsetof -Winvalid-pch @gol
237 -Wlarger-than-@var{len} -Wunsafe-loop-optimizations -Wlong-long @gol
238 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
239 -Wmissing-format-attribute -Wmissing-include-dirs @gol
240 -Wmissing-noreturn @gol
241 -Wno-multichar -Wnonnull -Woverlength-strings -Wpacked -Wpadded @gol
242 -Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
243 -Wredundant-decls @gol
244 -Wreturn-type -Wsequence-point -Wshadow @gol
245 -Wsign-compare -Wstack-protector @gol
246 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
247 -Wstring-literal-comparison @gol
248 -Wswitch -Wswitch-default -Wswitch-enum @gol
249 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
250 -Wunknown-pragmas -Wno-pragmas -Wunreachable-code @gol
251 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
252 -Wunused-value -Wunused-variable -Wvariadic-macros @gol
253 -Wvolatile-register-var -Wwrite-strings}
254
255 @item C-only Warning Options
256 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
257 -Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
258 -Wstrict-prototypes -Wtraditional @gol
259 -Wdeclaration-after-statement -Wpointer-sign}
260
261 @item Debugging Options
262 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
263 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
264 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
265 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
266 -fdump-ipa-all -fdump-ipa-cgraph @gol
267 -fdump-tree-all @gol
268 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
272 -fdump-tree-ch @gol
273 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
276 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
277 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-nrv -fdump-tree-vect @gol
282 -fdump-tree-sink @gol
283 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-salias @gol
285 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
286 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
287 -ftree-vectorizer-verbose=@var{n} @gol
288 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
289 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
290 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs @gol
291 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
292 -ftest-coverage -ftime-report -fvar-tracking @gol
293 -g -g@var{level} -gcoff -gdwarf-2 @gol
294 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
295 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
296 -print-multi-directory -print-multi-lib @gol
297 -print-prog-name=@var{program} -print-search-dirs -Q @gol
298 -save-temps -time}
299
300 @item Optimization Options
301 @xref{Optimize Options,,Options that Control Optimization}.
302 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
303 -falign-labels=@var{n} -falign-loops=@var{n} @gol
304 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
305 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
306 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
307 -fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
308 -fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
309 -fdelayed-branch -fdelete-null-pointer-checks -fearly-inlining @gol
310 -fexpensive-optimizations -ffast-math -ffloat-store @gol
311 -fforce-addr -ffunction-sections @gol
312 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
313 -floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
314 -finline-functions -finline-functions-called-once @gol
315 -finline-limit=@var{n} -fkeep-inline-functions @gol
316 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
317 -fmodulo-sched -fno-branch-count-reg @gol
318 -fno-default-inline -fno-defer-pop -fmove-loop-invariants @gol
319 -fno-function-cse -fno-guess-branch-probability @gol
320 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
321 -funsafe-math-optimizations -funsafe-loop-optimizations -ffinite-math-only @gol
322 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
323 -fomit-frame-pointer -foptimize-register-move @gol
324 -foptimize-sibling-calls -fprefetch-loop-arrays -fprefetch-loop-arrays-rtl @gol
325 -fprofile-generate -fprofile-use @gol
326 -fregmove -frename-registers @gol
327 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
328 -frerun-cse-after-loop -frerun-loop-opt @gol
329 -frounding-math -frtl-abstract-sequences @gol
330 -fschedule-insns -fschedule-insns2 @gol
331 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
332 -fsched-spec-load-dangerous @gol
333 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
334 -fsched2-use-superblocks @gol
335 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
336 -fsignaling-nans -fsingle-precision-constant @gol
337 -fstack-protector -fstack-protector-all @gol
338 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
339 -funroll-all-loops -funroll-loops -fpeel-loops @gol
340 -fsplit-ivs-in-unroller -funswitch-loops @gol
341 -fvariable-expansion-in-unroller @gol
342 -ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
343 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
344 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
345 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
346 -ftree-vect-loop-version -ftree-salias -fweb @gol
347 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
348 --param @var{name}=@var{value}
349 -O -O0 -O1 -O2 -O3 -Os}
350
351 @item Preprocessor Options
352 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
353 @gccoptlist{-A@var{question}=@var{answer} @gol
354 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
355 -C -dD -dI -dM -dN @gol
356 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
357 -idirafter @var{dir} @gol
358 -include @var{file} -imacros @var{file} @gol
359 -iprefix @var{file} -iwithprefix @var{dir} @gol
360 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
361 -imultilib @var{dir} -isysroot @var{dir} @gol
362 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
363 -P -fworking-directory -remap @gol
364 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
365 -Xpreprocessor @var{option}}
366
367 @item Assembler Option
368 @xref{Assembler Options,,Passing Options to the Assembler}.
369 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
370
371 @item Linker Options
372 @xref{Link Options,,Options for Linking}.
373 @gccoptlist{@var{object-file-name} -l@var{library} @gol
374 -nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
375 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
376 -Wl,@var{option} -Xlinker @var{option} @gol
377 -u @var{symbol}}
378
379 @item Directory Options
380 @xref{Directory Options,,Options for Directory Search}.
381 @gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir}
382 -specs=@var{file} -I- --sysroot=@var{dir}}
383
384 @item Target Options
385 @c I wrote this xref this way to avoid overfull hbox. -- rms
386 @xref{Target Options}.
387 @gccoptlist{-V @var{version} -b @var{machine}}
388
389 @item Machine Dependent Options
390 @xref{Submodel Options,,Hardware Models and Configurations}.
391 @c This list is ordered alphanumerically by subsection name.
392 @c Try and put the significant identifier (CPU or system) first,
393 @c so users have a clue at guessing where the ones they want will be.
394
395 @emph{ARC Options}
396 @gccoptlist{-EB -EL @gol
397 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
398 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
399
400 @emph{ARM Options}
401 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
402 -mabi=@var{name} @gol
403 -mapcs-stack-check -mno-apcs-stack-check @gol
404 -mapcs-float -mno-apcs-float @gol
405 -mapcs-reentrant -mno-apcs-reentrant @gol
406 -msched-prolog -mno-sched-prolog @gol
407 -mlittle-endian -mbig-endian -mwords-little-endian @gol
408 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
409 -mthumb-interwork -mno-thumb-interwork @gol
410 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
411 -mstructure-size-boundary=@var{n} @gol
412 -mabort-on-noreturn @gol
413 -mlong-calls -mno-long-calls @gol
414 -msingle-pic-base -mno-single-pic-base @gol
415 -mpic-register=@var{reg} @gol
416 -mnop-fun-dllimport @gol
417 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
418 -mpoke-function-name @gol
419 -mthumb -marm @gol
420 -mtpcs-frame -mtpcs-leaf-frame @gol
421 -mcaller-super-interworking -mcallee-super-interworking @gol
422 -mtp=@var{name}}
423
424 @emph{AVR Options}
425 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
426 -mcall-prologues -mno-tablejump -mtiny-stack -mint8}
427
428 @emph{Blackfin Options}
429 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
430 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
431 -mlow-64k -mno-low64k -mid-shared-library @gol
432 -mno-id-shared-library -mshared-library-id=@var{n} @gol
433 -mlong-calls -mno-long-calls}
434
435 @emph{CRIS Options}
436 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
437 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
438 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
439 -mstack-align -mdata-align -mconst-align @gol
440 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
441 -melf -maout -melinux -mlinux -sim -sim2 @gol
442 -mmul-bug-workaround -mno-mul-bug-workaround}
443
444 @emph{CRX Options}
445 @gccoptlist{-mmac -mpush-args}
446
447 @emph{Darwin Options}
448 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
449 -arch_only -bind_at_load -bundle -bundle_loader @gol
450 -client_name -compatibility_version -current_version @gol
451 -dead_strip @gol
452 -dependency-file -dylib_file -dylinker_install_name @gol
453 -dynamic -dynamiclib -exported_symbols_list @gol
454 -filelist -flat_namespace -force_cpusubtype_ALL @gol
455 -force_flat_namespace -headerpad_max_install_names @gol
456 -image_base -init -install_name -keep_private_externs @gol
457 -multi_module -multiply_defined -multiply_defined_unused @gol
458 -noall_load -no_dead_strip_inits_and_terms @gol
459 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
460 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
461 -private_bundle -read_only_relocs -sectalign @gol
462 -sectobjectsymbols -whyload -seg1addr @gol
463 -sectcreate -sectobjectsymbols -sectorder @gol
464 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
465 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
466 -segprot -segs_read_only_addr -segs_read_write_addr @gol
467 -single_module -static -sub_library -sub_umbrella @gol
468 -twolevel_namespace -umbrella -undefined @gol
469 -unexported_symbols_list -weak_reference_mismatches @gol
470 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
471 -mone-byte-bool}
472
473 @emph{DEC Alpha Options}
474 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
475 -mieee -mieee-with-inexact -mieee-conformant @gol
476 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
477 -mtrap-precision=@var{mode} -mbuild-constants @gol
478 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
479 -mbwx -mmax -mfix -mcix @gol
480 -mfloat-vax -mfloat-ieee @gol
481 -mexplicit-relocs -msmall-data -mlarge-data @gol
482 -msmall-text -mlarge-text @gol
483 -mmemory-latency=@var{time}}
484
485 @emph{DEC Alpha/VMS Options}
486 @gccoptlist{-mvms-return-codes}
487
488 @emph{FRV Options}
489 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
490 -mhard-float -msoft-float @gol
491 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
492 -mdouble -mno-double @gol
493 -mmedia -mno-media -mmuladd -mno-muladd @gol
494 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
495 -mlinked-fp -mlong-calls -malign-labels @gol
496 -mlibrary-pic -macc-4 -macc-8 @gol
497 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
498 -moptimize-membar -mno-optimize-membar @gol
499 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
500 -mvliw-branch -mno-vliw-branch @gol
501 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
502 -mno-nested-cond-exec -mtomcat-stats @gol
503 -mTLS -mtls @gol
504 -mcpu=@var{cpu}}
505
506 @emph{GNU/Linux Options}
507 @gccoptlist{-muclibc}
508
509 @emph{H8/300 Options}
510 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
511
512 @emph{HPPA Options}
513 @gccoptlist{-march=@var{architecture-type} @gol
514 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
515 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
516 -mfixed-range=@var{register-range} @gol
517 -mjump-in-delay -mlinker-opt -mlong-calls @gol
518 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
519 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
520 -mno-jump-in-delay -mno-long-load-store @gol
521 -mno-portable-runtime -mno-soft-float @gol
522 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
523 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
524 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
525 -munix=@var{unix-std} -nolibdld -static -threads}
526
527 @emph{i386 and x86-64 Options}
528 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
529 -mfpmath=@var{unit} @gol
530 -masm=@var{dialect} -mno-fancy-math-387 @gol
531 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
532 -mno-wide-multiply -mrtd -malign-double @gol
533 -mpreferred-stack-boundary=@var{num} @gol
534 -mmmx -msse -msse2 -msse3 -m3dnow -msselibm @gol
535 -mthreads -mno-align-stringops -minline-all-stringops @gol
536 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
537 -m96bit-long-double -mregparm=@var{num} -msseregparm @gol
538 -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
539 -mcmodel=@var{code-model} @gol
540 -m32 -m64 -mlarge-data-threshold=@var{num}}
541
542 @emph{IA-64 Options}
543 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
544 -mvolatile-asm-stop -mregister-names -mno-sdata @gol
545 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
546 -minline-float-divide-max-throughput @gol
547 -minline-int-divide-min-latency @gol
548 -minline-int-divide-max-throughput @gol
549 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
550 -mno-dwarf2-asm -mearly-stop-bits @gol
551 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
552 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
553
554 @emph{M32R/D Options}
555 @gccoptlist{-m32r2 -m32rx -m32r @gol
556 -mdebug @gol
557 -malign-loops -mno-align-loops @gol
558 -missue-rate=@var{number} @gol
559 -mbranch-cost=@var{number} @gol
560 -mmodel=@var{code-size-model-type} @gol
561 -msdata=@var{sdata-type} @gol
562 -mno-flush-func -mflush-func=@var{name} @gol
563 -mno-flush-trap -mflush-trap=@var{number} @gol
564 -G @var{num}}
565
566 @emph{M32C Options}
567 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
568
569 @emph{M680x0 Options}
570 @gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
571 -m68060 -mcpu32 -m5200 -mcfv4e -m68881 -mbitfield @gol
572 -mc68000 -mc68020 @gol
573 -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
574 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
575 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
576
577 @emph{M68hc1x Options}
578 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
579 -mauto-incdec -minmax -mlong-calls -mshort @gol
580 -msoft-reg-count=@var{count}}
581
582 @emph{MCore Options}
583 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
584 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
585 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
586 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
587 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
588
589 @emph{MIPS Options}
590 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
591 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
592 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
593 -mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
594 -mhard-float -msoft-float -msingle-float -mdouble-float @gol
595 -mdsp -mpaired-single -mips3d @gol
596 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
597 -G@var{num} -membedded-data -mno-embedded-data @gol
598 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
599 -msplit-addresses -mno-split-addresses @gol
600 -mexplicit-relocs -mno-explicit-relocs @gol
601 -mcheck-zero-division -mno-check-zero-division @gol
602 -mdivide-traps -mdivide-breaks @gol
603 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
604 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
605 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
606 -mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
607 -mfix-sb1 -mno-fix-sb1 @gol
608 -mflush-func=@var{func} -mno-flush-func @gol
609 -mbranch-likely -mno-branch-likely @gol
610 -mfp-exceptions -mno-fp-exceptions @gol
611 -mvr4130-align -mno-vr4130-align}
612
613 @emph{MMIX Options}
614 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
615 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
616 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
617 -mno-base-addresses -msingle-exit -mno-single-exit}
618
619 @emph{MN10300 Options}
620 @gccoptlist{-mmult-bug -mno-mult-bug @gol
621 -mam33 -mno-am33 @gol
622 -mam33-2 -mno-am33-2 @gol
623 -mreturn-pointer-on-d0 @gol
624 -mno-crt0 -mrelax}
625
626 @emph{MT Options}
627 @gccoptlist{-mno-crt0 -mbacc -msim @gol
628 -march=@var{cpu-type} }
629
630 @emph{PDP-11 Options}
631 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
632 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
633 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
634 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
635 -mbranch-expensive -mbranch-cheap @gol
636 -msplit -mno-split -munix-asm -mdec-asm}
637
638 @emph{PowerPC Options}
639 See RS/6000 and PowerPC Options.
640
641 @emph{RS/6000 and PowerPC Options}
642 @gccoptlist{-mcpu=@var{cpu-type} @gol
643 -mtune=@var{cpu-type} @gol
644 -mpower -mno-power -mpower2 -mno-power2 @gol
645 -mpowerpc -mpowerpc64 -mno-powerpc @gol
646 -maltivec -mno-altivec @gol
647 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
648 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
649 -mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mfprnd -mno-fprnd @gol
650 -mnew-mnemonics -mold-mnemonics @gol
651 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
652 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
653 -malign-power -malign-natural @gol
654 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
655 -mstring -mno-string -mupdate -mno-update @gol
656 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
657 -mstrict-align -mno-strict-align -mrelocatable @gol
658 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
659 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
660 -mdynamic-no-pic -maltivec -mswdiv @gol
661 -mprioritize-restricted-insns=@var{priority} @gol
662 -msched-costly-dep=@var{dependence_type} @gol
663 -minsert-sched-nops=@var{scheme} @gol
664 -mcall-sysv -mcall-netbsd @gol
665 -maix-struct-return -msvr4-struct-return @gol
666 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
667 -misel -mno-isel @gol
668 -misel=yes -misel=no @gol
669 -mspe -mno-spe @gol
670 -mspe=yes -mspe=no @gol
671 -mvrsave -mno-vrsave @gol
672 -mmulhw -mno-mulhw @gol
673 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
674 -mprototype -mno-prototype @gol
675 -msim -mmvme -mads -myellowknife -memb -msdata @gol
676 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
677
678 @emph{S/390 and zSeries Options}
679 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
680 -mhard-float -msoft-float -mlong-double-64 -mlong-double-128 @gol
681 -mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
682 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
683 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
684 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
685 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
686
687 @emph{SH Options}
688 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
689 -m4-nofpu -m4-single-only -m4-single -m4 @gol
690 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
691 -m5-64media -m5-64media-nofpu @gol
692 -m5-32media -m5-32media-nofpu @gol
693 -m5-compact -m5-compact-nofpu @gol
694 -mb -ml -mdalign -mrelax @gol
695 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
696 -mieee -misize -mpadstruct -mspace @gol
697 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
698 -mdivsi3_libfunc=@var{name} @gol
699 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
700 -minvalid-symbols}
701
702 @emph{SPARC Options}
703 @gccoptlist{-mcpu=@var{cpu-type} @gol
704 -mtune=@var{cpu-type} @gol
705 -mcmodel=@var{code-model} @gol
706 -m32 -m64 -mapp-regs -mno-app-regs @gol
707 -mfaster-structs -mno-faster-structs @gol
708 -mfpu -mno-fpu -mhard-float -msoft-float @gol
709 -mhard-quad-float -msoft-quad-float @gol
710 -mimpure-text -mno-impure-text -mlittle-endian @gol
711 -mstack-bias -mno-stack-bias @gol
712 -munaligned-doubles -mno-unaligned-doubles @gol
713 -mv8plus -mno-v8plus -mvis -mno-vis
714 -threads -pthreads -pthread}
715
716 @emph{System V Options}
717 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
718
719 @emph{TMS320C3x/C4x Options}
720 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
721 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
722 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
723 -mparallel-insns -mparallel-mpy -mpreserve-float}
724
725 @emph{V850 Options}
726 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
727 -mprolog-function -mno-prolog-function -mspace @gol
728 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
729 -mapp-regs -mno-app-regs @gol
730 -mdisable-callt -mno-disable-callt @gol
731 -mv850e1 @gol
732 -mv850e @gol
733 -mv850 -mbig-switch}
734
735 @emph{VAX Options}
736 @gccoptlist{-mg -mgnu -munix}
737
738 @emph{x86-64 Options}
739 See i386 and x86-64 Options.
740
741 @emph{Xstormy16 Options}
742 @gccoptlist{-msim}
743
744 @emph{Xtensa Options}
745 @gccoptlist{-mconst16 -mno-const16 @gol
746 -mfused-madd -mno-fused-madd @gol
747 -mtext-section-literals -mno-text-section-literals @gol
748 -mtarget-align -mno-target-align @gol
749 -mlongcalls -mno-longcalls}
750
751 @emph{zSeries Options}
752 See S/390 and zSeries Options.
753
754 @item Code Generation Options
755 @xref{Code Gen Options,,Options for Code Generation Conventions}.
756 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
757 -ffixed-@var{reg} -fexceptions @gol
758 -fnon-call-exceptions -funwind-tables @gol
759 -fasynchronous-unwind-tables @gol
760 -finhibit-size-directive -finstrument-functions @gol
761 -fno-common -fno-ident @gol
762 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
763 -fno-jump-tables @gol
764 -freg-struct-return -fshared-data -fshort-enums @gol
765 -fshort-double -fshort-wchar @gol
766 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
767 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
768 -fargument-alias -fargument-noalias @gol
769 -fargument-noalias-global -fleading-underscore @gol
770 -ftls-model=@var{model} @gol
771 -ftrapv -fwrapv -fbounds-check @gol
772 -fvisibility -fopenmp}
773 @end table
774
775 @menu
776 * Overall Options:: Controlling the kind of output:
777 an executable, object files, assembler files,
778 or preprocessed source.
779 * C Dialect Options:: Controlling the variant of C language compiled.
780 * C++ Dialect Options:: Variations on C++.
781 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
782 and Objective-C++.
783 * Language Independent Options:: Controlling how diagnostics should be
784 formatted.
785 * Warning Options:: How picky should the compiler be?
786 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
787 * Optimize Options:: How much optimization?
788 * Preprocessor Options:: Controlling header files and macro definitions.
789 Also, getting dependency information for Make.
790 * Assembler Options:: Passing options to the assembler.
791 * Link Options:: Specifying libraries and so on.
792 * Directory Options:: Where to find header files and libraries.
793 Where to find the compiler executable files.
794 * Spec Files:: How to pass switches to sub-processes.
795 * Target Options:: Running a cross-compiler, or an old version of GCC.
796 @end menu
797
798 @node Overall Options
799 @section Options Controlling the Kind of Output
800
801 Compilation can involve up to four stages: preprocessing, compilation
802 proper, assembly and linking, always in that order. GCC is capable of
803 preprocessing and compiling several files either into several
804 assembler input files, or into one assembler input file; then each
805 assembler input file produces an object file, and linking combines all
806 the object files (those newly compiled, and those specified as input)
807 into an executable file.
808
809 @cindex file name suffix
810 For any given input file, the file name suffix determines what kind of
811 compilation is done:
812
813 @table @gcctabopt
814 @item @var{file}.c
815 C source code which must be preprocessed.
816
817 @item @var{file}.i
818 C source code which should not be preprocessed.
819
820 @item @var{file}.ii
821 C++ source code which should not be preprocessed.
822
823 @item @var{file}.m
824 Objective-C source code. Note that you must link with the @file{libobjc}
825 library to make an Objective-C program work.
826
827 @item @var{file}.mi
828 Objective-C source code which should not be preprocessed.
829
830 @item @var{file}.mm
831 @itemx @var{file}.M
832 Objective-C++ source code. Note that you must link with the @file{libobjc}
833 library to make an Objective-C++ program work. Note that @samp{.M} refers
834 to a literal capital M@.
835
836 @item @var{file}.mii
837 Objective-C++ source code which should not be preprocessed.
838
839 @item @var{file}.h
840 C, C++, Objective-C or Objective-C++ header file to be turned into a
841 precompiled header.
842
843 @item @var{file}.cc
844 @itemx @var{file}.cp
845 @itemx @var{file}.cxx
846 @itemx @var{file}.cpp
847 @itemx @var{file}.CPP
848 @itemx @var{file}.c++
849 @itemx @var{file}.C
850 C++ source code which must be preprocessed. Note that in @samp{.cxx},
851 the last two letters must both be literally @samp{x}. Likewise,
852 @samp{.C} refers to a literal capital C@.
853
854 @item @var{file}.mm
855 @itemx @var{file}.M
856 Objective-C++ source code which must be preprocessed.
857
858 @item @var{file}.mii
859 Objective-C++ source code which should not be preprocessed.
860
861 @item @var{file}.hh
862 @itemx @var{file}.H
863 C++ header file to be turned into a precompiled header.
864
865 @item @var{file}.f
866 @itemx @var{file}.for
867 @itemx @var{file}.FOR
868 Fixed form Fortran source code which should not be preprocessed.
869
870 @item @var{file}.F
871 @itemx @var{file}.fpp
872 @itemx @var{file}.FPP
873 Fixed form Fortran source code which must be preprocessed (with the traditional
874 preprocessor).
875
876 @item @var{file}.f90
877 @itemx @var{file}.f95
878 Free form Fortran source code which should not be preprocessed.
879
880 @item @var{file}.F90
881 @itemx @var{file}.F95
882 Free form Fortran source code which must be preprocessed (with the
883 traditional preprocessor).
884
885 @c FIXME: Descriptions of Java file types.
886 @c @var{file}.java
887 @c @var{file}.class
888 @c @var{file}.zip
889 @c @var{file}.jar
890
891 @item @var{file}.ads
892 Ada source code file which contains a library unit declaration (a
893 declaration of a package, subprogram, or generic, or a generic
894 instantiation), or a library unit renaming declaration (a package,
895 generic, or subprogram renaming declaration). Such files are also
896 called @dfn{specs}.
897
898 @itemx @var{file}.adb
899 Ada source code file containing a library unit body (a subprogram or
900 package body). Such files are also called @dfn{bodies}.
901
902 @c GCC also knows about some suffixes for languages not yet included:
903 @c Pascal:
904 @c @var{file}.p
905 @c @var{file}.pas
906 @c Ratfor:
907 @c @var{file}.r
908
909 @item @var{file}.s
910 Assembler code.
911
912 @item @var{file}.S
913 Assembler code which must be preprocessed.
914
915 @item @var{other}
916 An object file to be fed straight into linking.
917 Any file name with no recognized suffix is treated this way.
918 @end table
919
920 @opindex x
921 You can specify the input language explicitly with the @option{-x} option:
922
923 @table @gcctabopt
924 @item -x @var{language}
925 Specify explicitly the @var{language} for the following input files
926 (rather than letting the compiler choose a default based on the file
927 name suffix). This option applies to all following input files until
928 the next @option{-x} option. Possible values for @var{language} are:
929 @smallexample
930 c c-header c-cpp-output
931 c++ c++-header c++-cpp-output
932 objective-c objective-c-header objective-c-cpp-output
933 objective-c++ objective-c++-header objective-c++-cpp-output
934 assembler assembler-with-cpp
935 ada
936 f77 f77-cpp-input
937 f95 f95-cpp-input
938 java
939 treelang
940 @end smallexample
941
942 @item -x none
943 Turn off any specification of a language, so that subsequent files are
944 handled according to their file name suffixes (as they are if @option{-x}
945 has not been used at all).
946
947 @item -pass-exit-codes
948 @opindex pass-exit-codes
949 Normally the @command{gcc} program will exit with the code of 1 if any
950 phase of the compiler returns a non-success return code. If you specify
951 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
952 numerically highest error produced by any phase that returned an error
953 indication.
954 @end table
955
956 If you only want some of the stages of compilation, you can use
957 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
958 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
959 @command{gcc} is to stop. Note that some combinations (for example,
960 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
961
962 @table @gcctabopt
963 @item -c
964 @opindex c
965 Compile or assemble the source files, but do not link. The linking
966 stage simply is not done. The ultimate output is in the form of an
967 object file for each source file.
968
969 By default, the object file name for a source file is made by replacing
970 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
971
972 Unrecognized input files, not requiring compilation or assembly, are
973 ignored.
974
975 @item -S
976 @opindex S
977 Stop after the stage of compilation proper; do not assemble. The output
978 is in the form of an assembler code file for each non-assembler input
979 file specified.
980
981 By default, the assembler file name for a source file is made by
982 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
983
984 Input files that don't require compilation are ignored.
985
986 @item -E
987 @opindex E
988 Stop after the preprocessing stage; do not run the compiler proper. The
989 output is in the form of preprocessed source code, which is sent to the
990 standard output.
991
992 Input files which don't require preprocessing are ignored.
993
994 @cindex output file option
995 @item -o @var{file}
996 @opindex o
997 Place output in file @var{file}. This applies regardless to whatever
998 sort of output is being produced, whether it be an executable file,
999 an object file, an assembler file or preprocessed C code.
1000
1001 If @option{-o} is not specified, the default is to put an executable
1002 file in @file{a.out}, the object file for
1003 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1004 assembler file in @file{@var{source}.s}, a precompiled header file in
1005 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1006 standard output.
1007
1008 @item -v
1009 @opindex v
1010 Print (on standard error output) the commands executed to run the stages
1011 of compilation. Also print the version number of the compiler driver
1012 program and of the preprocessor and the compiler proper.
1013
1014 @item -###
1015 @opindex ###
1016 Like @option{-v} except the commands are not executed and all command
1017 arguments are quoted. This is useful for shell scripts to capture the
1018 driver-generated command lines.
1019
1020 @item -pipe
1021 @opindex pipe
1022 Use pipes rather than temporary files for communication between the
1023 various stages of compilation. This fails to work on some systems where
1024 the assembler is unable to read from a pipe; but the GNU assembler has
1025 no trouble.
1026
1027 @item -combine
1028 @opindex combine
1029 If you are compiling multiple source files, this option tells the driver
1030 to pass all the source files to the compiler at once (for those
1031 languages for which the compiler can handle this). This will allow
1032 intermodule analysis (IMA) to be performed by the compiler. Currently the only
1033 language for which this is supported is C@. If you pass source files for
1034 multiple languages to the driver, using this option, the driver will invoke
1035 the compiler(s) that support IMA once each, passing each compiler all the
1036 source files appropriate for it. For those languages that do not support
1037 IMA this option will be ignored, and the compiler will be invoked once for
1038 each source file in that language. If you use this option in conjunction
1039 with @option{-save-temps}, the compiler will generate multiple
1040 pre-processed files
1041 (one for each source file), but only one (combined) @file{.o} or
1042 @file{.s} file.
1043
1044 @item --help
1045 @opindex help
1046 Print (on the standard output) a description of the command line options
1047 understood by @command{gcc}. If the @option{-v} option is also specified
1048 then @option{--help} will also be passed on to the various processes
1049 invoked by @command{gcc}, so that they can display the command line options
1050 they accept. If the @option{-Wextra} option is also specified then command
1051 line options which have no documentation associated with them will also
1052 be displayed.
1053
1054 @item --target-help
1055 @opindex target-help
1056 Print (on the standard output) a description of target specific command
1057 line options for each tool.
1058
1059 @item --version
1060 @opindex version
1061 Display the version number and copyrights of the invoked GCC@.
1062
1063 @include @value{srcdir}/../libiberty/at-file.texi
1064 @end table
1065
1066 @node Invoking G++
1067 @section Compiling C++ Programs
1068
1069 @cindex suffixes for C++ source
1070 @cindex C++ source file suffixes
1071 C++ source files conventionally use one of the suffixes @samp{.C},
1072 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1073 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1074 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1075 files with these names and compiles them as C++ programs even if you
1076 call the compiler the same way as for compiling C programs (usually
1077 with the name @command{gcc}).
1078
1079 @findex g++
1080 @findex c++
1081 However, C++ programs often require class libraries as well as a
1082 compiler that understands the C++ language---and under some
1083 circumstances, you might want to compile programs or header files from
1084 standard input, or otherwise without a suffix that flags them as C++
1085 programs. You might also like to precompile a C header file with a
1086 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
1087 program that calls GCC with the default language set to C++, and
1088 automatically specifies linking against the C++ library. On many
1089 systems, @command{g++} is also installed with the name @command{c++}.
1090
1091 @cindex invoking @command{g++}
1092 When you compile C++ programs, you may specify many of the same
1093 command-line options that you use for compiling programs in any
1094 language; or command-line options meaningful for C and related
1095 languages; or options that are meaningful only for C++ programs.
1096 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1097 explanations of options for languages related to C@.
1098 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1099 explanations of options that are meaningful only for C++ programs.
1100
1101 @node C Dialect Options
1102 @section Options Controlling C Dialect
1103 @cindex dialect options
1104 @cindex language dialect options
1105 @cindex options, dialect
1106
1107 The following options control the dialect of C (or languages derived
1108 from C, such as C++, Objective-C and Objective-C++) that the compiler
1109 accepts:
1110
1111 @table @gcctabopt
1112 @cindex ANSI support
1113 @cindex ISO support
1114 @item -ansi
1115 @opindex ansi
1116 In C mode, support all ISO C90 programs. In C++ mode,
1117 remove GNU extensions that conflict with ISO C++.
1118
1119 This turns off certain features of GCC that are incompatible with ISO
1120 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1121 such as the @code{asm} and @code{typeof} keywords, and
1122 predefined macros such as @code{unix} and @code{vax} that identify the
1123 type of system you are using. It also enables the undesirable and
1124 rarely used ISO trigraph feature. For the C compiler,
1125 it disables recognition of C++ style @samp{//} comments as well as
1126 the @code{inline} keyword.
1127
1128 The alternate keywords @code{__asm__}, @code{__extension__},
1129 @code{__inline__} and @code{__typeof__} continue to work despite
1130 @option{-ansi}. You would not want to use them in an ISO C program, of
1131 course, but it is useful to put them in header files that might be included
1132 in compilations done with @option{-ansi}. Alternate predefined macros
1133 such as @code{__unix__} and @code{__vax__} are also available, with or
1134 without @option{-ansi}.
1135
1136 The @option{-ansi} option does not cause non-ISO programs to be
1137 rejected gratuitously. For that, @option{-pedantic} is required in
1138 addition to @option{-ansi}. @xref{Warning Options}.
1139
1140 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1141 option is used. Some header files may notice this macro and refrain
1142 from declaring certain functions or defining certain macros that the
1143 ISO standard doesn't call for; this is to avoid interfering with any
1144 programs that might use these names for other things.
1145
1146 Functions which would normally be built in but do not have semantics
1147 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1148 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1149 built-in functions provided by GCC}, for details of the functions
1150 affected.
1151
1152 @item -std=
1153 @opindex std
1154 Determine the language standard. This option is currently only
1155 supported when compiling C or C++. A value for this option must be
1156 provided; possible values are
1157
1158 @table @samp
1159 @item c89
1160 @itemx iso9899:1990
1161 ISO C90 (same as @option{-ansi}).
1162
1163 @item iso9899:199409
1164 ISO C90 as modified in amendment 1.
1165
1166 @item c99
1167 @itemx c9x
1168 @itemx iso9899:1999
1169 @itemx iso9899:199x
1170 ISO C99. Note that this standard is not yet fully supported; see
1171 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1172 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1173
1174 @item gnu89
1175 Default, ISO C90 plus GNU extensions (including some C99 features).
1176
1177 @item gnu99
1178 @itemx gnu9x
1179 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1180 this will become the default. The name @samp{gnu9x} is deprecated.
1181
1182 @item c++98
1183 The 1998 ISO C++ standard plus amendments.
1184
1185 @item gnu++98
1186 The same as @option{-std=c++98} plus GNU extensions. This is the
1187 default for C++ code.
1188 @end table
1189
1190 Even when this option is not specified, you can still use some of the
1191 features of newer standards in so far as they do not conflict with
1192 previous C standards. For example, you may use @code{__restrict__} even
1193 when @option{-std=c99} is not specified.
1194
1195 The @option{-std} options specifying some version of ISO C have the same
1196 effects as @option{-ansi}, except that features that were not in ISO C90
1197 but are in the specified version (for example, @samp{//} comments and
1198 the @code{inline} keyword in ISO C99) are not disabled.
1199
1200 @xref{Standards,,Language Standards Supported by GCC}, for details of
1201 these standard versions.
1202
1203 @item -aux-info @var{filename}
1204 @opindex aux-info
1205 Output to the given filename prototyped declarations for all functions
1206 declared and/or defined in a translation unit, including those in header
1207 files. This option is silently ignored in any language other than C@.
1208
1209 Besides declarations, the file indicates, in comments, the origin of
1210 each declaration (source file and line), whether the declaration was
1211 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1212 @samp{O} for old, respectively, in the first character after the line
1213 number and the colon), and whether it came from a declaration or a
1214 definition (@samp{C} or @samp{F}, respectively, in the following
1215 character). In the case of function definitions, a K&R-style list of
1216 arguments followed by their declarations is also provided, inside
1217 comments, after the declaration.
1218
1219 @item -fno-asm
1220 @opindex fno-asm
1221 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1222 keyword, so that code can use these words as identifiers. You can use
1223 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1224 instead. @option{-ansi} implies @option{-fno-asm}.
1225
1226 In C++, this switch only affects the @code{typeof} keyword, since
1227 @code{asm} and @code{inline} are standard keywords. You may want to
1228 use the @option{-fno-gnu-keywords} flag instead, which has the same
1229 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1230 switch only affects the @code{asm} and @code{typeof} keywords, since
1231 @code{inline} is a standard keyword in ISO C99.
1232
1233 @item -fno-builtin
1234 @itemx -fno-builtin-@var{function}
1235 @opindex fno-builtin
1236 @cindex built-in functions
1237 Don't recognize built-in functions that do not begin with
1238 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1239 functions provided by GCC}, for details of the functions affected,
1240 including those which are not built-in functions when @option{-ansi} or
1241 @option{-std} options for strict ISO C conformance are used because they
1242 do not have an ISO standard meaning.
1243
1244 GCC normally generates special code to handle certain built-in functions
1245 more efficiently; for instance, calls to @code{alloca} may become single
1246 instructions that adjust the stack directly, and calls to @code{memcpy}
1247 may become inline copy loops. The resulting code is often both smaller
1248 and faster, but since the function calls no longer appear as such, you
1249 cannot set a breakpoint on those calls, nor can you change the behavior
1250 of the functions by linking with a different library. In addition,
1251 when a function is recognized as a built-in function, GCC may use
1252 information about that function to warn about problems with calls to
1253 that function, or to generate more efficient code, even if the
1254 resulting code still contains calls to that function. For example,
1255 warnings are given with @option{-Wformat} for bad calls to
1256 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1257 known not to modify global memory.
1258
1259 With the @option{-fno-builtin-@var{function}} option
1260 only the built-in function @var{function} is
1261 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1262 function is named this is not built-in in this version of GCC, this
1263 option is ignored. There is no corresponding
1264 @option{-fbuiltin-@var{function}} option; if you wish to enable
1265 built-in functions selectively when using @option{-fno-builtin} or
1266 @option{-ffreestanding}, you may define macros such as:
1267
1268 @smallexample
1269 #define abs(n) __builtin_abs ((n))
1270 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1271 @end smallexample
1272
1273 @item -fhosted
1274 @opindex fhosted
1275 @cindex hosted environment
1276
1277 Assert that compilation takes place in a hosted environment. This implies
1278 @option{-fbuiltin}. A hosted environment is one in which the
1279 entire standard library is available, and in which @code{main} has a return
1280 type of @code{int}. Examples are nearly everything except a kernel.
1281 This is equivalent to @option{-fno-freestanding}.
1282
1283 @item -ffreestanding
1284 @opindex ffreestanding
1285 @cindex hosted environment
1286
1287 Assert that compilation takes place in a freestanding environment. This
1288 implies @option{-fno-builtin}. A freestanding environment
1289 is one in which the standard library may not exist, and program startup may
1290 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1291 This is equivalent to @option{-fno-hosted}.
1292
1293 @xref{Standards,,Language Standards Supported by GCC}, for details of
1294 freestanding and hosted environments.
1295
1296 @item -fms-extensions
1297 @opindex fms-extensions
1298 Accept some non-standard constructs used in Microsoft header files.
1299
1300 Some cases of unnamed fields in structures and unions are only
1301 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1302 fields within structs/unions}, for details.
1303
1304 @item -trigraphs
1305 @opindex trigraphs
1306 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1307 options for strict ISO C conformance) implies @option{-trigraphs}.
1308
1309 @item -no-integrated-cpp
1310 @opindex no-integrated-cpp
1311 Performs a compilation in two passes: preprocessing and compiling. This
1312 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1313 @option{-B} option. The user supplied compilation step can then add in
1314 an additional preprocessing step after normal preprocessing but before
1315 compiling. The default is to use the integrated cpp (internal cpp)
1316
1317 The semantics of this option will change if "cc1", "cc1plus", and
1318 "cc1obj" are merged.
1319
1320 @cindex traditional C language
1321 @cindex C language, traditional
1322 @item -traditional
1323 @itemx -traditional-cpp
1324 @opindex traditional-cpp
1325 @opindex traditional
1326 Formerly, these options caused GCC to attempt to emulate a pre-standard
1327 C compiler. They are now only supported with the @option{-E} switch.
1328 The preprocessor continues to support a pre-standard mode. See the GNU
1329 CPP manual for details.
1330
1331 @item -fcond-mismatch
1332 @opindex fcond-mismatch
1333 Allow conditional expressions with mismatched types in the second and
1334 third arguments. The value of such an expression is void. This option
1335 is not supported for C++.
1336
1337 @item -funsigned-char
1338 @opindex funsigned-char
1339 Let the type @code{char} be unsigned, like @code{unsigned char}.
1340
1341 Each kind of machine has a default for what @code{char} should
1342 be. It is either like @code{unsigned char} by default or like
1343 @code{signed char} by default.
1344
1345 Ideally, a portable program should always use @code{signed char} or
1346 @code{unsigned char} when it depends on the signedness of an object.
1347 But many programs have been written to use plain @code{char} and
1348 expect it to be signed, or expect it to be unsigned, depending on the
1349 machines they were written for. This option, and its inverse, let you
1350 make such a program work with the opposite default.
1351
1352 The type @code{char} is always a distinct type from each of
1353 @code{signed char} or @code{unsigned char}, even though its behavior
1354 is always just like one of those two.
1355
1356 @item -fsigned-char
1357 @opindex fsigned-char
1358 Let the type @code{char} be signed, like @code{signed char}.
1359
1360 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1361 the negative form of @option{-funsigned-char}. Likewise, the option
1362 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1363
1364 @item -fsigned-bitfields
1365 @itemx -funsigned-bitfields
1366 @itemx -fno-signed-bitfields
1367 @itemx -fno-unsigned-bitfields
1368 @opindex fsigned-bitfields
1369 @opindex funsigned-bitfields
1370 @opindex fno-signed-bitfields
1371 @opindex fno-unsigned-bitfields
1372 These options control whether a bit-field is signed or unsigned, when the
1373 declaration does not use either @code{signed} or @code{unsigned}. By
1374 default, such a bit-field is signed, because this is consistent: the
1375 basic integer types such as @code{int} are signed types.
1376 @end table
1377
1378 @node C++ Dialect Options
1379 @section Options Controlling C++ Dialect
1380
1381 @cindex compiler options, C++
1382 @cindex C++ options, command line
1383 @cindex options, C++
1384 This section describes the command-line options that are only meaningful
1385 for C++ programs; but you can also use most of the GNU compiler options
1386 regardless of what language your program is in. For example, you
1387 might compile a file @code{firstClass.C} like this:
1388
1389 @smallexample
1390 g++ -g -frepo -O -c firstClass.C
1391 @end smallexample
1392
1393 @noindent
1394 In this example, only @option{-frepo} is an option meant
1395 only for C++ programs; you can use the other options with any
1396 language supported by GCC@.
1397
1398 Here is a list of options that are @emph{only} for compiling C++ programs:
1399
1400 @table @gcctabopt
1401
1402 @item -fabi-version=@var{n}
1403 @opindex fabi-version
1404 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1405 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1406 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1407 the version that conforms most closely to the C++ ABI specification.
1408 Therefore, the ABI obtained using version 0 will change as ABI bugs
1409 are fixed.
1410
1411 The default is version 2.
1412
1413 @item -fno-access-control
1414 @opindex fno-access-control
1415 Turn off all access checking. This switch is mainly useful for working
1416 around bugs in the access control code.
1417
1418 @item -fcheck-new
1419 @opindex fcheck-new
1420 Check that the pointer returned by @code{operator new} is non-null
1421 before attempting to modify the storage allocated. This check is
1422 normally unnecessary because the C++ standard specifies that
1423 @code{operator new} will only return @code{0} if it is declared
1424 @samp{throw()}, in which case the compiler will always check the
1425 return value even without this option. In all other cases, when
1426 @code{operator new} has a non-empty exception specification, memory
1427 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1428 @samp{new (nothrow)}.
1429
1430 @item -fconserve-space
1431 @opindex fconserve-space
1432 Put uninitialized or runtime-initialized global variables into the
1433 common segment, as C does. This saves space in the executable at the
1434 cost of not diagnosing duplicate definitions. If you compile with this
1435 flag and your program mysteriously crashes after @code{main()} has
1436 completed, you may have an object that is being destroyed twice because
1437 two definitions were merged.
1438
1439 This option is no longer useful on most targets, now that support has
1440 been added for putting variables into BSS without making them common.
1441
1442 @item -ffriend-injection
1443 @opindex ffriend-injection
1444 Inject friend functions into the enclosing namespace, so that they are
1445 visible outside the scope of the class in which they are declared.
1446 Friend functions were documented to work this way in the old Annotated
1447 C++ Reference Manual, and versions of G++ before 4.1 always worked
1448 that way. However, in ISO C++ a friend function which is not declared
1449 in an enclosing scope can only be found using argument dependent
1450 lookup. This option causes friends to be injected as they were in
1451 earlier releases.
1452
1453 This option is for compatibility, and may be removed in a future
1454 release of G++.
1455
1456 @item -fno-elide-constructors
1457 @opindex fno-elide-constructors
1458 The C++ standard allows an implementation to omit creating a temporary
1459 which is only used to initialize another object of the same type.
1460 Specifying this option disables that optimization, and forces G++ to
1461 call the copy constructor in all cases.
1462
1463 @item -fno-enforce-eh-specs
1464 @opindex fno-enforce-eh-specs
1465 Don't generate code to check for violation of exception specifications
1466 at runtime. This option violates the C++ standard, but may be useful
1467 for reducing code size in production builds, much like defining
1468 @samp{NDEBUG}. This does not give user code permission to throw
1469 exceptions in violation of the exception specifications; the compiler
1470 will still optimize based on the specifications, so throwing an
1471 unexpected exception will result in undefined behavior.
1472
1473 @item -ffor-scope
1474 @itemx -fno-for-scope
1475 @opindex ffor-scope
1476 @opindex fno-for-scope
1477 If @option{-ffor-scope} is specified, the scope of variables declared in
1478 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1479 as specified by the C++ standard.
1480 If @option{-fno-for-scope} is specified, the scope of variables declared in
1481 a @i{for-init-statement} extends to the end of the enclosing scope,
1482 as was the case in old versions of G++, and other (traditional)
1483 implementations of C++.
1484
1485 The default if neither flag is given to follow the standard,
1486 but to allow and give a warning for old-style code that would
1487 otherwise be invalid, or have different behavior.
1488
1489 @item -fno-gnu-keywords
1490 @opindex fno-gnu-keywords
1491 Do not recognize @code{typeof} as a keyword, so that code can use this
1492 word as an identifier. You can use the keyword @code{__typeof__} instead.
1493 @option{-ansi} implies @option{-fno-gnu-keywords}.
1494
1495 @item -fno-implicit-templates
1496 @opindex fno-implicit-templates
1497 Never emit code for non-inline templates which are instantiated
1498 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1499 @xref{Template Instantiation}, for more information.
1500
1501 @item -fno-implicit-inline-templates
1502 @opindex fno-implicit-inline-templates
1503 Don't emit code for implicit instantiations of inline templates, either.
1504 The default is to handle inlines differently so that compiles with and
1505 without optimization will need the same set of explicit instantiations.
1506
1507 @item -fno-implement-inlines
1508 @opindex fno-implement-inlines
1509 To save space, do not emit out-of-line copies of inline functions
1510 controlled by @samp{#pragma implementation}. This will cause linker
1511 errors if these functions are not inlined everywhere they are called.
1512
1513 @item -fms-extensions
1514 @opindex fms-extensions
1515 Disable pedantic warnings about constructs used in MFC, such as implicit
1516 int and getting a pointer to member function via non-standard syntax.
1517
1518 @item -fno-nonansi-builtins
1519 @opindex fno-nonansi-builtins
1520 Disable built-in declarations of functions that are not mandated by
1521 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1522 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1523
1524 @item -fno-operator-names
1525 @opindex fno-operator-names
1526 Do not treat the operator name keywords @code{and}, @code{bitand},
1527 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1528 synonyms as keywords.
1529
1530 @item -fno-optional-diags
1531 @opindex fno-optional-diags
1532 Disable diagnostics that the standard says a compiler does not need to
1533 issue. Currently, the only such diagnostic issued by G++ is the one for
1534 a name having multiple meanings within a class.
1535
1536 @item -fpermissive
1537 @opindex fpermissive
1538 Downgrade some diagnostics about nonconformant code from errors to
1539 warnings. Thus, using @option{-fpermissive} will allow some
1540 nonconforming code to compile.
1541
1542 @item -frepo
1543 @opindex frepo
1544 Enable automatic template instantiation at link time. This option also
1545 implies @option{-fno-implicit-templates}. @xref{Template
1546 Instantiation}, for more information.
1547
1548 @item -fno-rtti
1549 @opindex fno-rtti
1550 Disable generation of information about every class with virtual
1551 functions for use by the C++ runtime type identification features
1552 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1553 of the language, you can save some space by using this flag. Note that
1554 exception handling uses the same information, but it will generate it as
1555 needed.
1556
1557 @item -fstats
1558 @opindex fstats
1559 Emit statistics about front-end processing at the end of the compilation.
1560 This information is generally only useful to the G++ development team.
1561
1562 @item -ftemplate-depth-@var{n}
1563 @opindex ftemplate-depth
1564 Set the maximum instantiation depth for template classes to @var{n}.
1565 A limit on the template instantiation depth is needed to detect
1566 endless recursions during template class instantiation. ANSI/ISO C++
1567 conforming programs must not rely on a maximum depth greater than 17.
1568
1569 @item -fno-threadsafe-statics
1570 @opindex fno-threadsafe-statics
1571 Do not emit the extra code to use the routines specified in the C++
1572 ABI for thread-safe initialization of local statics. You can use this
1573 option to reduce code size slightly in code that doesn't need to be
1574 thread-safe.
1575
1576 @item -fuse-cxa-atexit
1577 @opindex fuse-cxa-atexit
1578 Register destructors for objects with static storage duration with the
1579 @code{__cxa_atexit} function rather than the @code{atexit} function.
1580 This option is required for fully standards-compliant handling of static
1581 destructors, but will only work if your C library supports
1582 @code{__cxa_atexit}.
1583
1584 @item -fvisibility-inlines-hidden
1585 @opindex fvisibility-inlines-hidden
1586 Causes all inlined methods to be marked with
1587 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1588 appear in the export table of a DSO and do not require a PLT indirection
1589 when used within the DSO@. Enabling this option can have a dramatic effect
1590 on load and link times of a DSO as it massively reduces the size of the
1591 dynamic export table when the library makes heavy use of templates. While
1592 it can cause bloating through duplication of code within each DSO where
1593 it is used, often the wastage is less than the considerable space occupied
1594 by a long symbol name in the export table which is typical when using
1595 templates and namespaces. For even more savings, combine with the
1596 @option{-fvisibility=hidden} switch.
1597
1598 @item -fno-weak
1599 @opindex fno-weak
1600 Do not use weak symbol support, even if it is provided by the linker.
1601 By default, G++ will use weak symbols if they are available. This
1602 option exists only for testing, and should not be used by end-users;
1603 it will result in inferior code and has no benefits. This option may
1604 be removed in a future release of G++.
1605
1606 @item -nostdinc++
1607 @opindex nostdinc++
1608 Do not search for header files in the standard directories specific to
1609 C++, but do still search the other standard directories. (This option
1610 is used when building the C++ library.)
1611 @end table
1612
1613 In addition, these optimization, warning, and code generation options
1614 have meanings only for C++ programs:
1615
1616 @table @gcctabopt
1617 @item -fno-default-inline
1618 @opindex fno-default-inline
1619 Do not assume @samp{inline} for functions defined inside a class scope.
1620 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1621 functions will have linkage like inline functions; they just won't be
1622 inlined by default.
1623
1624 @item -Wabi @r{(C++ only)}
1625 @opindex Wabi
1626 Warn when G++ generates code that is probably not compatible with the
1627 vendor-neutral C++ ABI@. Although an effort has been made to warn about
1628 all such cases, there are probably some cases that are not warned about,
1629 even though G++ is generating incompatible code. There may also be
1630 cases where warnings are emitted even though the code that is generated
1631 will be compatible.
1632
1633 You should rewrite your code to avoid these warnings if you are
1634 concerned about the fact that code generated by G++ may not be binary
1635 compatible with code generated by other compilers.
1636
1637 The known incompatibilities at this point include:
1638
1639 @itemize @bullet
1640
1641 @item
1642 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1643 pack data into the same byte as a base class. For example:
1644
1645 @smallexample
1646 struct A @{ virtual void f(); int f1 : 1; @};
1647 struct B : public A @{ int f2 : 1; @};
1648 @end smallexample
1649
1650 @noindent
1651 In this case, G++ will place @code{B::f2} into the same byte
1652 as@code{A::f1}; other compilers will not. You can avoid this problem
1653 by explicitly padding @code{A} so that its size is a multiple of the
1654 byte size on your platform; that will cause G++ and other compilers to
1655 layout @code{B} identically.
1656
1657 @item
1658 Incorrect handling of tail-padding for virtual bases. G++ does not use
1659 tail padding when laying out virtual bases. For example:
1660
1661 @smallexample
1662 struct A @{ virtual void f(); char c1; @};
1663 struct B @{ B(); char c2; @};
1664 struct C : public A, public virtual B @{@};
1665 @end smallexample
1666
1667 @noindent
1668 In this case, G++ will not place @code{B} into the tail-padding for
1669 @code{A}; other compilers will. You can avoid this problem by
1670 explicitly padding @code{A} so that its size is a multiple of its
1671 alignment (ignoring virtual base classes); that will cause G++ and other
1672 compilers to layout @code{C} identically.
1673
1674 @item
1675 Incorrect handling of bit-fields with declared widths greater than that
1676 of their underlying types, when the bit-fields appear in a union. For
1677 example:
1678
1679 @smallexample
1680 union U @{ int i : 4096; @};
1681 @end smallexample
1682
1683 @noindent
1684 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1685 union too small by the number of bits in an @code{int}.
1686
1687 @item
1688 Empty classes can be placed at incorrect offsets. For example:
1689
1690 @smallexample
1691 struct A @{@};
1692
1693 struct B @{
1694 A a;
1695 virtual void f ();
1696 @};
1697
1698 struct C : public B, public A @{@};
1699 @end smallexample
1700
1701 @noindent
1702 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1703 it should be placed at offset zero. G++ mistakenly believes that the
1704 @code{A} data member of @code{B} is already at offset zero.
1705
1706 @item
1707 Names of template functions whose types involve @code{typename} or
1708 template template parameters can be mangled incorrectly.
1709
1710 @smallexample
1711 template <typename Q>
1712 void f(typename Q::X) @{@}
1713
1714 template <template <typename> class Q>
1715 void f(typename Q<int>::X) @{@}
1716 @end smallexample
1717
1718 @noindent
1719 Instantiations of these templates may be mangled incorrectly.
1720
1721 @end itemize
1722
1723 @item -Wctor-dtor-privacy @r{(C++ only)}
1724 @opindex Wctor-dtor-privacy
1725 Warn when a class seems unusable because all the constructors or
1726 destructors in that class are private, and it has neither friends nor
1727 public static member functions.
1728
1729 @item -Wnon-virtual-dtor @r{(C++ only)}
1730 @opindex Wnon-virtual-dtor
1731 Warn when a class appears to be polymorphic, thereby requiring a virtual
1732 destructor, yet it declares a non-virtual one. This warning is also
1733 enabled if -Weffc++ is specified.
1734
1735 @item -Wreorder @r{(C++ only)}
1736 @opindex Wreorder
1737 @cindex reordering, warning
1738 @cindex warning for reordering of member initializers
1739 Warn when the order of member initializers given in the code does not
1740 match the order in which they must be executed. For instance:
1741
1742 @smallexample
1743 struct A @{
1744 int i;
1745 int j;
1746 A(): j (0), i (1) @{ @}
1747 @};
1748 @end smallexample
1749
1750 The compiler will rearrange the member initializers for @samp{i}
1751 and @samp{j} to match the declaration order of the members, emitting
1752 a warning to that effect. This warning is enabled by @option{-Wall}.
1753 @end table
1754
1755 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1756
1757 @table @gcctabopt
1758 @item -Weffc++ @r{(C++ only)}
1759 @opindex Weffc++
1760 Warn about violations of the following style guidelines from Scott Meyers'
1761 @cite{Effective C++} book:
1762
1763 @itemize @bullet
1764 @item
1765 Item 11: Define a copy constructor and an assignment operator for classes
1766 with dynamically allocated memory.
1767
1768 @item
1769 Item 12: Prefer initialization to assignment in constructors.
1770
1771 @item
1772 Item 14: Make destructors virtual in base classes.
1773
1774 @item
1775 Item 15: Have @code{operator=} return a reference to @code{*this}.
1776
1777 @item
1778 Item 23: Don't try to return a reference when you must return an object.
1779
1780 @end itemize
1781
1782 Also warn about violations of the following style guidelines from
1783 Scott Meyers' @cite{More Effective C++} book:
1784
1785 @itemize @bullet
1786 @item
1787 Item 6: Distinguish between prefix and postfix forms of increment and
1788 decrement operators.
1789
1790 @item
1791 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1792
1793 @end itemize
1794
1795 When selecting this option, be aware that the standard library
1796 headers do not obey all of these guidelines; use @samp{grep -v}
1797 to filter out those warnings.
1798
1799 @item -Wno-deprecated @r{(C++ only)}
1800 @opindex Wno-deprecated
1801 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1802
1803 @item -Wstrict-null-sentinel @r{(C++ only)}
1804 @opindex Wstrict-null-sentinel
1805 Warn also about the use of an uncasted @code{NULL} as sentinel. When
1806 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1807 to @code{__null}. Although it is a null pointer constant not a null pointer,
1808 it is guaranteed to of the same size as a pointer. But this use is
1809 not portable across different compilers.
1810
1811 @item -Wno-non-template-friend @r{(C++ only)}
1812 @opindex Wno-non-template-friend
1813 Disable warnings when non-templatized friend functions are declared
1814 within a template. Since the advent of explicit template specification
1815 support in G++, if the name of the friend is an unqualified-id (i.e.,
1816 @samp{friend foo(int)}), the C++ language specification demands that the
1817 friend declare or define an ordinary, nontemplate function. (Section
1818 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1819 could be interpreted as a particular specialization of a templatized
1820 function. Because this non-conforming behavior is no longer the default
1821 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1822 check existing code for potential trouble spots and is on by default.
1823 This new compiler behavior can be turned off with
1824 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1825 but disables the helpful warning.
1826
1827 @item -Wold-style-cast @r{(C++ only)}
1828 @opindex Wold-style-cast
1829 Warn if an old-style (C-style) cast to a non-void type is used within
1830 a C++ program. The new-style casts (@samp{dynamic_cast},
1831 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1832 less vulnerable to unintended effects and much easier to search for.
1833
1834 @item -Woverloaded-virtual @r{(C++ only)}
1835 @opindex Woverloaded-virtual
1836 @cindex overloaded virtual fn, warning
1837 @cindex warning for overloaded virtual fn
1838 Warn when a function declaration hides virtual functions from a
1839 base class. For example, in:
1840
1841 @smallexample
1842 struct A @{
1843 virtual void f();
1844 @};
1845
1846 struct B: public A @{
1847 void f(int);
1848 @};
1849 @end smallexample
1850
1851 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1852 like:
1853
1854 @smallexample
1855 B* b;
1856 b->f();
1857 @end smallexample
1858
1859 will fail to compile.
1860
1861 @item -Wno-pmf-conversions @r{(C++ only)}
1862 @opindex Wno-pmf-conversions
1863 Disable the diagnostic for converting a bound pointer to member function
1864 to a plain pointer.
1865
1866 @item -Wsign-promo @r{(C++ only)}
1867 @opindex Wsign-promo
1868 Warn when overload resolution chooses a promotion from unsigned or
1869 enumerated type to a signed type, over a conversion to an unsigned type of
1870 the same size. Previous versions of G++ would try to preserve
1871 unsignedness, but the standard mandates the current behavior.
1872
1873 @smallexample
1874 struct A @{
1875 operator int ();
1876 A& operator = (int);
1877 @};
1878
1879 main ()
1880 @{
1881 A a,b;
1882 a = b;
1883 @}
1884 @end smallexample
1885
1886 In this example, G++ will synthesize a default @samp{A& operator =
1887 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1888 @end table
1889
1890 @node Objective-C and Objective-C++ Dialect Options
1891 @section Options Controlling Objective-C and Objective-C++ Dialects
1892
1893 @cindex compiler options, Objective-C and Objective-C++
1894 @cindex Objective-C and Objective-C++ options, command line
1895 @cindex options, Objective-C and Objective-C++
1896 (NOTE: This manual does not describe the Objective-C and Objective-C++
1897 languages themselves. See @xref{Standards,,Language Standards
1898 Supported by GCC}, for references.)
1899
1900 This section describes the command-line options that are only meaningful
1901 for Objective-C and Objective-C++ programs, but you can also use most of
1902 the language-independent GNU compiler options.
1903 For example, you might compile a file @code{some_class.m} like this:
1904
1905 @smallexample
1906 gcc -g -fgnu-runtime -O -c some_class.m
1907 @end smallexample
1908
1909 @noindent
1910 In this example, @option{-fgnu-runtime} is an option meant only for
1911 Objective-C and Objective-C++ programs; you can use the other options with
1912 any language supported by GCC@.
1913
1914 Note that since Objective-C is an extension of the C language, Objective-C
1915 compilations may also use options specific to the C front-end (e.g.,
1916 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1917 C++-specific options (e.g., @option{-Wabi}).
1918
1919 Here is a list of options that are @emph{only} for compiling Objective-C
1920 and Objective-C++ programs:
1921
1922 @table @gcctabopt
1923 @item -fconstant-string-class=@var{class-name}
1924 @opindex fconstant-string-class
1925 Use @var{class-name} as the name of the class to instantiate for each
1926 literal string specified with the syntax @code{@@"@dots{}"}. The default
1927 class name is @code{NXConstantString} if the GNU runtime is being used, and
1928 @code{NSConstantString} if the NeXT runtime is being used (see below). The
1929 @option{-fconstant-cfstrings} option, if also present, will override the
1930 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1931 to be laid out as constant CoreFoundation strings.
1932
1933 @item -fgnu-runtime
1934 @opindex fgnu-runtime
1935 Generate object code compatible with the standard GNU Objective-C
1936 runtime. This is the default for most types of systems.
1937
1938 @item -fnext-runtime
1939 @opindex fnext-runtime
1940 Generate output compatible with the NeXT runtime. This is the default
1941 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1942 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1943 used.
1944
1945 @item -fno-nil-receivers
1946 @opindex fno-nil-receivers
1947 Assume that all Objective-C message dispatches (e.g.,
1948 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1949 is not @code{nil}. This allows for more efficient entry points in the runtime
1950 to be used. Currently, this option is only available in conjunction with
1951 the NeXT runtime on Mac OS X 10.3 and later.
1952
1953 @item -fobjc-call-cxx-cdtors
1954 @opindex fobjc-call-cxx-cdtors
1955 For each Objective-C class, check if any of its instance variables is a
1956 C++ object with a non-trivial default constructor. If so, synthesize a
1957 special @code{- (id) .cxx_construct} instance method that will run
1958 non-trivial default constructors on any such instance variables, in order,
1959 and then return @code{self}. Similarly, check if any instance variable
1960 is a C++ object with a non-trivial destructor, and if so, synthesize a
1961 special @code{- (void) .cxx_destruct} method that will run
1962 all such default destructors, in reverse order.
1963
1964 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1965 thusly generated will only operate on instance variables declared in the
1966 current Objective-C class, and not those inherited from superclasses. It
1967 is the responsibility of the Objective-C runtime to invoke all such methods
1968 in an object's inheritance hierarchy. The @code{- (id) .cxx_construct} methods
1969 will be invoked by the runtime immediately after a new object
1970 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1971 be invoked immediately before the runtime deallocates an object instance.
1972
1973 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1974 support for invoking the @code{- (id) .cxx_construct} and
1975 @code{- (void) .cxx_destruct} methods.
1976
1977 @item -fobjc-direct-dispatch
1978 @opindex fobjc-direct-dispatch
1979 Allow fast jumps to the message dispatcher. On Darwin this is
1980 accomplished via the comm page.
1981
1982 @item -fobjc-exceptions
1983 @opindex fobjc-exceptions
1984 Enable syntactic support for structured exception handling in Objective-C,
1985 similar to what is offered by C++ and Java. This option is
1986 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
1987 earlier.
1988
1989 @smallexample
1990 @@try @{
1991 @dots{}
1992 @@throw expr;
1993 @dots{}
1994 @}
1995 @@catch (AnObjCClass *exc) @{
1996 @dots{}
1997 @@throw expr;
1998 @dots{}
1999 @@throw;
2000 @dots{}
2001 @}
2002 @@catch (AnotherClass *exc) @{
2003 @dots{}
2004 @}
2005 @@catch (id allOthers) @{
2006 @dots{}
2007 @}
2008 @@finally @{
2009 @dots{}
2010 @@throw expr;
2011 @dots{}
2012 @}
2013 @end smallexample
2014
2015 The @code{@@throw} statement may appear anywhere in an Objective-C or
2016 Objective-C++ program; when used inside of a @code{@@catch} block, the
2017 @code{@@throw} may appear without an argument (as shown above), in which case
2018 the object caught by the @code{@@catch} will be rethrown.
2019
2020 Note that only (pointers to) Objective-C objects may be thrown and
2021 caught using this scheme. When an object is thrown, it will be caught
2022 by the nearest @code{@@catch} clause capable of handling objects of that type,
2023 analogously to how @code{catch} blocks work in C++ and Java. A
2024 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2025 any and all Objective-C exceptions not caught by previous @code{@@catch}
2026 clauses (if any).
2027
2028 The @code{@@finally} clause, if present, will be executed upon exit from the
2029 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
2030 regardless of whether any exceptions are thrown, caught or rethrown
2031 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2032 of the @code{finally} clause in Java.
2033
2034 There are several caveats to using the new exception mechanism:
2035
2036 @itemize @bullet
2037 @item
2038 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2039 idioms provided by the @code{NSException} class, the new
2040 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2041 systems, due to additional functionality needed in the (NeXT) Objective-C
2042 runtime.
2043
2044 @item
2045 As mentioned above, the new exceptions do not support handling
2046 types other than Objective-C objects. Furthermore, when used from
2047 Objective-C++, the Objective-C exception model does not interoperate with C++
2048 exceptions at this time. This means you cannot @code{@@throw} an exception
2049 from Objective-C and @code{catch} it in C++, or vice versa
2050 (i.e., @code{throw @dots{} @@catch}).
2051 @end itemize
2052
2053 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2054 blocks for thread-safe execution:
2055
2056 @smallexample
2057 @@synchronized (ObjCClass *guard) @{
2058 @dots{}
2059 @}
2060 @end smallexample
2061
2062 Upon entering the @code{@@synchronized} block, a thread of execution shall
2063 first check whether a lock has been placed on the corresponding @code{guard}
2064 object by another thread. If it has, the current thread shall wait until
2065 the other thread relinquishes its lock. Once @code{guard} becomes available,
2066 the current thread will place its own lock on it, execute the code contained in
2067 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2068 making @code{guard} available to other threads).
2069
2070 Unlike Java, Objective-C does not allow for entire methods to be marked
2071 @code{@@synchronized}. Note that throwing exceptions out of
2072 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2073 to be unlocked properly.
2074
2075 @item -fobjc-gc
2076 @opindex fobjc-gc
2077 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2078
2079 @item -freplace-objc-classes
2080 @opindex freplace-objc-classes
2081 Emit a special marker instructing @command{ld(1)} not to statically link in
2082 the resulting object file, and allow @command{dyld(1)} to load it in at
2083 run time instead. This is used in conjunction with the Fix-and-Continue
2084 debugging mode, where the object file in question may be recompiled and
2085 dynamically reloaded in the course of program execution, without the need
2086 to restart the program itself. Currently, Fix-and-Continue functionality
2087 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2088 and later.
2089
2090 @item -fzero-link
2091 @opindex fzero-link
2092 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2093 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2094 compile time) with static class references that get initialized at load time,
2095 which improves run-time performance. Specifying the @option{-fzero-link} flag
2096 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2097 to be retained. This is useful in Zero-Link debugging mode, since it allows
2098 for individual class implementations to be modified during program execution.
2099
2100 @item -gen-decls
2101 @opindex gen-decls
2102 Dump interface declarations for all classes seen in the source file to a
2103 file named @file{@var{sourcename}.decl}.
2104
2105 @item -Wassign-intercept
2106 @opindex Wassign-intercept
2107 Warn whenever an Objective-C assignment is being intercepted by the
2108 garbage collector.
2109
2110 @item -Wno-protocol
2111 @opindex Wno-protocol
2112 If a class is declared to implement a protocol, a warning is issued for
2113 every method in the protocol that is not implemented by the class. The
2114 default behavior is to issue a warning for every method not explicitly
2115 implemented in the class, even if a method implementation is inherited
2116 from the superclass. If you use the @option{-Wno-protocol} option, then
2117 methods inherited from the superclass are considered to be implemented,
2118 and no warning is issued for them.
2119
2120 @item -Wselector
2121 @opindex Wselector
2122 Warn if multiple methods of different types for the same selector are
2123 found during compilation. The check is performed on the list of methods
2124 in the final stage of compilation. Additionally, a check is performed
2125 for each selector appearing in a @code{@@selector(@dots{})}
2126 expression, and a corresponding method for that selector has been found
2127 during compilation. Because these checks scan the method table only at
2128 the end of compilation, these warnings are not produced if the final
2129 stage of compilation is not reached, for example because an error is
2130 found during compilation, or because the @option{-fsyntax-only} option is
2131 being used.
2132
2133 @item -Wstrict-selector-match
2134 @opindex Wstrict-selector-match
2135 Warn if multiple methods with differing argument and/or return types are
2136 found for a given selector when attempting to send a message using this
2137 selector to a receiver of type @code{id} or @code{Class}. When this flag
2138 is off (which is the default behavior), the compiler will omit such warnings
2139 if any differences found are confined to types which share the same size
2140 and alignment.
2141
2142 @item -Wundeclared-selector
2143 @opindex Wundeclared-selector
2144 Warn if a @code{@@selector(@dots{})} expression referring to an
2145 undeclared selector is found. A selector is considered undeclared if no
2146 method with that name has been declared before the
2147 @code{@@selector(@dots{})} expression, either explicitly in an
2148 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2149 an @code{@@implementation} section. This option always performs its
2150 checks as soon as a @code{@@selector(@dots{})} expression is found,
2151 while @option{-Wselector} only performs its checks in the final stage of
2152 compilation. This also enforces the coding style convention
2153 that methods and selectors must be declared before being used.
2154
2155 @item -print-objc-runtime-info
2156 @opindex print-objc-runtime-info
2157 Generate C header describing the largest structure that is passed by
2158 value, if any.
2159
2160 @end table
2161
2162 @node Language Independent Options
2163 @section Options to Control Diagnostic Messages Formatting
2164 @cindex options to control diagnostics formatting
2165 @cindex diagnostic messages
2166 @cindex message formatting
2167
2168 Traditionally, diagnostic messages have been formatted irrespective of
2169 the output device's aspect (e.g.@: its width, @dots{}). The options described
2170 below can be used to control the diagnostic messages formatting
2171 algorithm, e.g.@: how many characters per line, how often source location
2172 information should be reported. Right now, only the C++ front end can
2173 honor these options. However it is expected, in the near future, that
2174 the remaining front ends would be able to digest them correctly.
2175
2176 @table @gcctabopt
2177 @item -fmessage-length=@var{n}
2178 @opindex fmessage-length
2179 Try to format error messages so that they fit on lines of about @var{n}
2180 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2181 the front ends supported by GCC@. If @var{n} is zero, then no
2182 line-wrapping will be done; each error message will appear on a single
2183 line.
2184
2185 @opindex fdiagnostics-show-location
2186 @item -fdiagnostics-show-location=once
2187 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2188 reporter to emit @emph{once} source location information; that is, in
2189 case the message is too long to fit on a single physical line and has to
2190 be wrapped, the source location won't be emitted (as prefix) again,
2191 over and over, in subsequent continuation lines. This is the default
2192 behavior.
2193
2194 @item -fdiagnostics-show-location=every-line
2195 Only meaningful in line-wrapping mode. Instructs the diagnostic
2196 messages reporter to emit the same source location information (as
2197 prefix) for physical lines that result from the process of breaking
2198 a message which is too long to fit on a single line.
2199
2200 @item -fdiagnostics-show-options
2201 @opindex fdiagnostics-show-options
2202 This option instructs the diagnostic machinery to add text to each
2203 diagnostic emitted, which indicates which command line option directly
2204 controls that diagnostic, when such an option is known to the
2205 diagnostic machinery.
2206
2207 @end table
2208
2209 @node Warning Options
2210 @section Options to Request or Suppress Warnings
2211 @cindex options to control warnings
2212 @cindex warning messages
2213 @cindex messages, warning
2214 @cindex suppressing warnings
2215
2216 Warnings are diagnostic messages that report constructions which
2217 are not inherently erroneous but which are risky or suggest there
2218 may have been an error.
2219
2220 You can request many specific warnings with options beginning @samp{-W},
2221 for example @option{-Wimplicit} to request warnings on implicit
2222 declarations. Each of these specific warning options also has a
2223 negative form beginning @samp{-Wno-} to turn off warnings;
2224 for example, @option{-Wno-implicit}. This manual lists only one of the
2225 two forms, whichever is not the default.
2226
2227 The following options control the amount and kinds of warnings produced
2228 by GCC; for further, language-specific options also refer to
2229 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2230 Options}.
2231
2232 @table @gcctabopt
2233 @cindex syntax checking
2234 @item -fsyntax-only
2235 @opindex fsyntax-only
2236 Check the code for syntax errors, but don't do anything beyond that.
2237
2238 @item -pedantic
2239 @opindex pedantic
2240 Issue all the warnings demanded by strict ISO C and ISO C++;
2241 reject all programs that use forbidden extensions, and some other
2242 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2243 version of the ISO C standard specified by any @option{-std} option used.
2244
2245 Valid ISO C and ISO C++ programs should compile properly with or without
2246 this option (though a rare few will require @option{-ansi} or a
2247 @option{-std} option specifying the required version of ISO C)@. However,
2248 without this option, certain GNU extensions and traditional C and C++
2249 features are supported as well. With this option, they are rejected.
2250
2251 @option{-pedantic} does not cause warning messages for use of the
2252 alternate keywords whose names begin and end with @samp{__}. Pedantic
2253 warnings are also disabled in the expression that follows
2254 @code{__extension__}. However, only system header files should use
2255 these escape routes; application programs should avoid them.
2256 @xref{Alternate Keywords}.
2257
2258 Some users try to use @option{-pedantic} to check programs for strict ISO
2259 C conformance. They soon find that it does not do quite what they want:
2260 it finds some non-ISO practices, but not all---only those for which
2261 ISO C @emph{requires} a diagnostic, and some others for which
2262 diagnostics have been added.
2263
2264 A feature to report any failure to conform to ISO C might be useful in
2265 some instances, but would require considerable additional work and would
2266 be quite different from @option{-pedantic}. We don't have plans to
2267 support such a feature in the near future.
2268
2269 Where the standard specified with @option{-std} represents a GNU
2270 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2271 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2272 extended dialect is based. Warnings from @option{-pedantic} are given
2273 where they are required by the base standard. (It would not make sense
2274 for such warnings to be given only for features not in the specified GNU
2275 C dialect, since by definition the GNU dialects of C include all
2276 features the compiler supports with the given option, and there would be
2277 nothing to warn about.)
2278
2279 @item -pedantic-errors
2280 @opindex pedantic-errors
2281 Like @option{-pedantic}, except that errors are produced rather than
2282 warnings.
2283
2284 @item -w
2285 @opindex w
2286 Inhibit all warning messages.
2287
2288 @item -Wno-import
2289 @opindex Wno-import
2290 Inhibit warning messages about the use of @samp{#import}.
2291
2292 @item -Wchar-subscripts
2293 @opindex Wchar-subscripts
2294 Warn if an array subscript has type @code{char}. This is a common cause
2295 of error, as programmers often forget that this type is signed on some
2296 machines.
2297 This warning is enabled by @option{-Wall}.
2298
2299 @item -Wcomment
2300 @opindex Wcomment
2301 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2302 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2303 This warning is enabled by @option{-Wall}.
2304
2305 @item -Wfatal-errors
2306 @opindex Wfatal-errors
2307 This option causes the compiler to abort compilation on the first error
2308 occurred rather than trying to keep going and printing further error
2309 messages.
2310
2311 @item -Wformat
2312 @opindex Wformat
2313 @opindex ffreestanding
2314 @opindex fno-builtin
2315 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2316 the arguments supplied have types appropriate to the format string
2317 specified, and that the conversions specified in the format string make
2318 sense. This includes standard functions, and others specified by format
2319 attributes (@pxref{Function Attributes}), in the @code{printf},
2320 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2321 not in the C standard) families (or other target-specific families).
2322 Which functions are checked without format attributes having been
2323 specified depends on the standard version selected, and such checks of
2324 functions without the attribute specified are disabled by
2325 @option{-ffreestanding} or @option{-fno-builtin}.
2326
2327 The formats are checked against the format features supported by GNU
2328 libc version 2.2. These include all ISO C90 and C99 features, as well
2329 as features from the Single Unix Specification and some BSD and GNU
2330 extensions. Other library implementations may not support all these
2331 features; GCC does not support warning about features that go beyond a
2332 particular library's limitations. However, if @option{-pedantic} is used
2333 with @option{-Wformat}, warnings will be given about format features not
2334 in the selected standard version (but not for @code{strfmon} formats,
2335 since those are not in any version of the C standard). @xref{C Dialect
2336 Options,,Options Controlling C Dialect}.
2337
2338 Since @option{-Wformat} also checks for null format arguments for
2339 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2340
2341 @option{-Wformat} is included in @option{-Wall}. For more control over some
2342 aspects of format checking, the options @option{-Wformat-y2k},
2343 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2344 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2345 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2346
2347 @item -Wformat-y2k
2348 @opindex Wformat-y2k
2349 If @option{-Wformat} is specified, also warn about @code{strftime}
2350 formats which may yield only a two-digit year.
2351
2352 @item -Wno-format-extra-args
2353 @opindex Wno-format-extra-args
2354 If @option{-Wformat} is specified, do not warn about excess arguments to a
2355 @code{printf} or @code{scanf} format function. The C standard specifies
2356 that such arguments are ignored.
2357
2358 Where the unused arguments lie between used arguments that are
2359 specified with @samp{$} operand number specifications, normally
2360 warnings are still given, since the implementation could not know what
2361 type to pass to @code{va_arg} to skip the unused arguments. However,
2362 in the case of @code{scanf} formats, this option will suppress the
2363 warning if the unused arguments are all pointers, since the Single
2364 Unix Specification says that such unused arguments are allowed.
2365
2366 @item -Wno-format-zero-length
2367 @opindex Wno-format-zero-length
2368 If @option{-Wformat} is specified, do not warn about zero-length formats.
2369 The C standard specifies that zero-length formats are allowed.
2370
2371 @item -Wformat-nonliteral
2372 @opindex Wformat-nonliteral
2373 If @option{-Wformat} is specified, also warn if the format string is not a
2374 string literal and so cannot be checked, unless the format function
2375 takes its format arguments as a @code{va_list}.
2376
2377 @item -Wformat-security
2378 @opindex Wformat-security
2379 If @option{-Wformat} is specified, also warn about uses of format
2380 functions that represent possible security problems. At present, this
2381 warns about calls to @code{printf} and @code{scanf} functions where the
2382 format string is not a string literal and there are no format arguments,
2383 as in @code{printf (foo);}. This may be a security hole if the format
2384 string came from untrusted input and contains @samp{%n}. (This is
2385 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2386 in future warnings may be added to @option{-Wformat-security} that are not
2387 included in @option{-Wformat-nonliteral}.)
2388
2389 @item -Wformat=2
2390 @opindex Wformat=2
2391 Enable @option{-Wformat} plus format checks not included in
2392 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2393 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2394
2395 @item -Wnonnull
2396 @opindex Wnonnull
2397 Warn about passing a null pointer for arguments marked as
2398 requiring a non-null value by the @code{nonnull} function attribute.
2399
2400 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2401 can be disabled with the @option{-Wno-nonnull} option.
2402
2403 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2404 @opindex Winit-self
2405 Warn about uninitialized variables which are initialized with themselves.
2406 Note this option can only be used with the @option{-Wuninitialized} option,
2407 which in turn only works with @option{-O1} and above.
2408
2409 For example, GCC will warn about @code{i} being uninitialized in the
2410 following snippet only when @option{-Winit-self} has been specified:
2411 @smallexample
2412 @group
2413 int f()
2414 @{
2415 int i = i;
2416 return i;
2417 @}
2418 @end group
2419 @end smallexample
2420
2421 @item -Wimplicit-int
2422 @opindex Wimplicit-int
2423 Warn when a declaration does not specify a type.
2424 This warning is enabled by @option{-Wall}.
2425
2426 @item -Wimplicit-function-declaration
2427 @itemx -Werror-implicit-function-declaration
2428 @opindex Wimplicit-function-declaration
2429 @opindex Werror-implicit-function-declaration
2430 Give a warning (or error) whenever a function is used before being
2431 declared. The form @option{-Wno-error-implicit-function-declaration}
2432 is not supported.
2433 This warning is enabled by @option{-Wall} (as a warning, not an error).
2434
2435 @item -Wimplicit
2436 @opindex Wimplicit
2437 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2438 This warning is enabled by @option{-Wall}.
2439
2440 @item -Wmain
2441 @opindex Wmain
2442 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2443 function with external linkage, returning int, taking either zero
2444 arguments, two, or three arguments of appropriate types.
2445 This warning is enabled by @option{-Wall}.
2446
2447 @item -Wmissing-braces
2448 @opindex Wmissing-braces
2449 Warn if an aggregate or union initializer is not fully bracketed. In
2450 the following example, the initializer for @samp{a} is not fully
2451 bracketed, but that for @samp{b} is fully bracketed.
2452
2453 @smallexample
2454 int a[2][2] = @{ 0, 1, 2, 3 @};
2455 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2456 @end smallexample
2457
2458 This warning is enabled by @option{-Wall}.
2459
2460 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2461 @opindex Wmissing-include-dirs
2462 Warn if a user-supplied include directory does not exist.
2463
2464 @item -Wparentheses
2465 @opindex Wparentheses
2466 Warn if parentheses are omitted in certain contexts, such
2467 as when there is an assignment in a context where a truth value
2468 is expected, or when operators are nested whose precedence people
2469 often get confused about. Only the warning for an assignment used as
2470 a truth value is supported when compiling C++; the other warnings are
2471 only supported when compiling C@.
2472
2473 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2474 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2475 interpretation from that of ordinary mathematical notation.
2476
2477 Also warn about constructions where there may be confusion to which
2478 @code{if} statement an @code{else} branch belongs. Here is an example of
2479 such a case:
2480
2481 @smallexample
2482 @group
2483 @{
2484 if (a)
2485 if (b)
2486 foo ();
2487 else
2488 bar ();
2489 @}
2490 @end group
2491 @end smallexample
2492
2493 In C, every @code{else} branch belongs to the innermost possible @code{if}
2494 statement, which in this example is @code{if (b)}. This is often not
2495 what the programmer expected, as illustrated in the above example by
2496 indentation the programmer chose. When there is the potential for this
2497 confusion, GCC will issue a warning when this flag is specified.
2498 To eliminate the warning, add explicit braces around the innermost
2499 @code{if} statement so there is no way the @code{else} could belong to
2500 the enclosing @code{if}. The resulting code would look like this:
2501
2502 @smallexample
2503 @group
2504 @{
2505 if (a)
2506 @{
2507 if (b)
2508 foo ();
2509 else
2510 bar ();
2511 @}
2512 @}
2513 @end group
2514 @end smallexample
2515
2516 This warning is enabled by @option{-Wall}.
2517
2518 @item -Wsequence-point
2519 @opindex Wsequence-point
2520 Warn about code that may have undefined semantics because of violations
2521 of sequence point rules in the C and C++ standards.
2522
2523 The C and C++ standards defines the order in which expressions in a C/C++
2524 program are evaluated in terms of @dfn{sequence points}, which represent
2525 a partial ordering between the execution of parts of the program: those
2526 executed before the sequence point, and those executed after it. These
2527 occur after the evaluation of a full expression (one which is not part
2528 of a larger expression), after the evaluation of the first operand of a
2529 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2530 function is called (but after the evaluation of its arguments and the
2531 expression denoting the called function), and in certain other places.
2532 Other than as expressed by the sequence point rules, the order of
2533 evaluation of subexpressions of an expression is not specified. All
2534 these rules describe only a partial order rather than a total order,
2535 since, for example, if two functions are called within one expression
2536 with no sequence point between them, the order in which the functions
2537 are called is not specified. However, the standards committee have
2538 ruled that function calls do not overlap.
2539
2540 It is not specified when between sequence points modifications to the
2541 values of objects take effect. Programs whose behavior depends on this
2542 have undefined behavior; the C and C++ standards specify that ``Between
2543 the previous and next sequence point an object shall have its stored
2544 value modified at most once by the evaluation of an expression.
2545 Furthermore, the prior value shall be read only to determine the value
2546 to be stored.''. If a program breaks these rules, the results on any
2547 particular implementation are entirely unpredictable.
2548
2549 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2550 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2551 diagnosed by this option, and it may give an occasional false positive
2552 result, but in general it has been found fairly effective at detecting
2553 this sort of problem in programs.
2554
2555 The standard is worded confusingly, therefore there is some debate
2556 over the precise meaning of the sequence point rules in subtle cases.
2557 Links to discussions of the problem, including proposed formal
2558 definitions, may be found on the GCC readings page, at
2559 @w{@uref{http://gcc.gnu.org/readings.html}}.
2560
2561 This warning is enabled by @option{-Wall} for C and C++.
2562
2563 @item -Wreturn-type
2564 @opindex Wreturn-type
2565 Warn whenever a function is defined with a return-type that defaults to
2566 @code{int}. Also warn about any @code{return} statement with no
2567 return-value in a function whose return-type is not @code{void}.
2568
2569 For C, also warn if the return type of a function has a type qualifier
2570 such as @code{const}. Such a type qualifier has no effect, since the
2571 value returned by a function is not an lvalue. ISO C prohibits
2572 qualified @code{void} return types on function definitions, so such
2573 return types always receive a warning even without this option.
2574
2575 For C++, a function without return type always produces a diagnostic
2576 message, even when @option{-Wno-return-type} is specified. The only
2577 exceptions are @samp{main} and functions defined in system headers.
2578
2579 This warning is enabled by @option{-Wall}.
2580
2581 @item -Wswitch
2582 @opindex Wswitch
2583 Warn whenever a @code{switch} statement has an index of enumerated type
2584 and lacks a @code{case} for one or more of the named codes of that
2585 enumeration. (The presence of a @code{default} label prevents this
2586 warning.) @code{case} labels outside the enumeration range also
2587 provoke warnings when this option is used.
2588 This warning is enabled by @option{-Wall}.
2589
2590 @item -Wswitch-default
2591 @opindex Wswitch-switch
2592 Warn whenever a @code{switch} statement does not have a @code{default}
2593 case.
2594
2595 @item -Wswitch-enum
2596 @opindex Wswitch-enum
2597 Warn whenever a @code{switch} statement has an index of enumerated type
2598 and lacks a @code{case} for one or more of the named codes of that
2599 enumeration. @code{case} labels outside the enumeration range also
2600 provoke warnings when this option is used.
2601
2602 @item -Wtrigraphs
2603 @opindex Wtrigraphs
2604 Warn if any trigraphs are encountered that might change the meaning of
2605 the program (trigraphs within comments are not warned about).
2606 This warning is enabled by @option{-Wall}.
2607
2608 @item -Wunused-function
2609 @opindex Wunused-function
2610 Warn whenever a static function is declared but not defined or a
2611 non-inline static function is unused.
2612 This warning is enabled by @option{-Wall}.
2613
2614 @item -Wunused-label
2615 @opindex Wunused-label
2616 Warn whenever a label is declared but not used.
2617 This warning is enabled by @option{-Wall}.
2618
2619 To suppress this warning use the @samp{unused} attribute
2620 (@pxref{Variable Attributes}).
2621
2622 @item -Wunused-parameter
2623 @opindex Wunused-parameter
2624 Warn whenever a function parameter is unused aside from its declaration.
2625
2626 To suppress this warning use the @samp{unused} attribute
2627 (@pxref{Variable Attributes}).
2628
2629 @item -Wunused-variable
2630 @opindex Wunused-variable
2631 Warn whenever a local variable or non-constant static variable is unused
2632 aside from its declaration
2633 This warning is enabled by @option{-Wall}.
2634
2635 To suppress this warning use the @samp{unused} attribute
2636 (@pxref{Variable Attributes}).
2637
2638 @item -Wunused-value
2639 @opindex Wunused-value
2640 Warn whenever a statement computes a result that is explicitly not used.
2641 This warning is enabled by @option{-Wall}.
2642
2643 To suppress this warning cast the expression to @samp{void}.
2644
2645 @item -Wunused
2646 @opindex Wunused
2647 All the above @option{-Wunused} options combined.
2648
2649 In order to get a warning about an unused function parameter, you must
2650 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2651 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2652
2653 @item -Wuninitialized
2654 @opindex Wuninitialized
2655 Warn if an automatic variable is used without first being initialized or
2656 if a variable may be clobbered by a @code{setjmp} call.
2657
2658 These warnings are possible only in optimizing compilation,
2659 because they require data flow information that is computed only
2660 when optimizing. If you don't specify @option{-O}, you simply won't
2661 get these warnings.
2662
2663 If you want to warn about code which uses the uninitialized value of the
2664 variable in its own initializer, use the @option{-Winit-self} option.
2665
2666 These warnings occur for individual uninitialized or clobbered
2667 elements of structure, union or array variables as well as for
2668 variables which are uninitialized or clobbered as a whole. They do
2669 not occur for variables or elements declared @code{volatile}. Because
2670 these warnings depend on optimization, the exact variables or elements
2671 for which there are warnings will depend on the precise optimization
2672 options and version of GCC used.
2673
2674 Note that there may be no warning about a variable that is used only
2675 to compute a value that itself is never used, because such
2676 computations may be deleted by data flow analysis before the warnings
2677 are printed.
2678
2679 These warnings are made optional because GCC is not smart
2680 enough to see all the reasons why the code might be correct
2681 despite appearing to have an error. Here is one example of how
2682 this can happen:
2683
2684 @smallexample
2685 @group
2686 @{
2687 int x;
2688 switch (y)
2689 @{
2690 case 1: x = 1;
2691 break;
2692 case 2: x = 4;
2693 break;
2694 case 3: x = 5;
2695 @}
2696 foo (x);
2697 @}
2698 @end group
2699 @end smallexample
2700
2701 @noindent
2702 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2703 always initialized, but GCC doesn't know this. Here is
2704 another common case:
2705
2706 @smallexample
2707 @{
2708 int save_y;
2709 if (change_y) save_y = y, y = new_y;
2710 @dots{}
2711 if (change_y) y = save_y;
2712 @}
2713 @end smallexample
2714
2715 @noindent
2716 This has no bug because @code{save_y} is used only if it is set.
2717
2718 @cindex @code{longjmp} warnings
2719 This option also warns when a non-volatile automatic variable might be
2720 changed by a call to @code{longjmp}. These warnings as well are possible
2721 only in optimizing compilation.
2722
2723 The compiler sees only the calls to @code{setjmp}. It cannot know
2724 where @code{longjmp} will be called; in fact, a signal handler could
2725 call it at any point in the code. As a result, you may get a warning
2726 even when there is in fact no problem because @code{longjmp} cannot
2727 in fact be called at the place which would cause a problem.
2728
2729 Some spurious warnings can be avoided if you declare all the functions
2730 you use that never return as @code{noreturn}. @xref{Function
2731 Attributes}.
2732
2733 This warning is enabled by @option{-Wall}.
2734
2735 @item -Wunknown-pragmas
2736 @opindex Wunknown-pragmas
2737 @cindex warning for unknown pragmas
2738 @cindex unknown pragmas, warning
2739 @cindex pragmas, warning of unknown
2740 Warn when a #pragma directive is encountered which is not understood by
2741 GCC@. If this command line option is used, warnings will even be issued
2742 for unknown pragmas in system header files. This is not the case if
2743 the warnings were only enabled by the @option{-Wall} command line option.
2744
2745 @item -Wno-pragmas
2746 @opindex Wno-pragmas
2747 @opindex Wpragmas
2748 Do not warn about misuses of pragmas, such as incorrect parameters,
2749 invalid syntax, or conflicts between pragmas. See also
2750 @samp{-Wunknown-pragmas}.
2751
2752 @item -Wstrict-aliasing
2753 @opindex Wstrict-aliasing
2754 This option is only active when @option{-fstrict-aliasing} is active.
2755 It warns about code which might break the strict aliasing rules that the
2756 compiler is using for optimization. The warning does not catch all
2757 cases, but does attempt to catch the more common pitfalls. It is
2758 included in @option{-Wall}.
2759
2760 @item -Wstrict-aliasing=2
2761 @opindex Wstrict-aliasing=2
2762 This option is only active when @option{-fstrict-aliasing} is active.
2763 It warns about code which might break the strict aliasing rules that the
2764 compiler is using for optimization. This warning catches more cases than
2765 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2766 cases that are safe.
2767
2768 @item -Wall
2769 @opindex Wall
2770 All of the above @samp{-W} options combined. This enables all the
2771 warnings about constructions that some users consider questionable, and
2772 that are easy to avoid (or modify to prevent the warning), even in
2773 conjunction with macros. This also enables some language-specific
2774 warnings described in @ref{C++ Dialect Options} and
2775 @ref{Objective-C and Objective-C++ Dialect Options}.
2776 @end table
2777
2778 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2779 Some of them warn about constructions that users generally do not
2780 consider questionable, but which occasionally you might wish to check
2781 for; others warn about constructions that are necessary or hard to avoid
2782 in some cases, and there is no simple way to modify the code to suppress
2783 the warning.
2784
2785 @table @gcctabopt
2786 @item -Wextra
2787 @opindex W
2788 @opindex Wextra
2789 (This option used to be called @option{-W}. The older name is still
2790 supported, but the newer name is more descriptive.) Print extra warning
2791 messages for these events:
2792
2793 @itemize @bullet
2794 @item
2795 A function can return either with or without a value. (Falling
2796 off the end of the function body is considered returning without
2797 a value.) For example, this function would evoke such a
2798 warning:
2799
2800 @smallexample
2801 @group
2802 foo (a)
2803 @{
2804 if (a > 0)
2805 return a;
2806 @}
2807 @end group
2808 @end smallexample
2809
2810 @item
2811 An expression-statement or the left-hand side of a comma expression
2812 contains no side effects.
2813 To suppress the warning, cast the unused expression to void.
2814 For example, an expression such as @samp{x[i,j]} will cause a warning,
2815 but @samp{x[(void)i,j]} will not.
2816
2817 @item
2818 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2819
2820 @item
2821 Storage-class specifiers like @code{static} are not the first things in
2822 a declaration. According to the C Standard, this usage is obsolescent.
2823
2824 @item
2825 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2826 arguments.
2827
2828 @item
2829 A comparison between signed and unsigned values could produce an
2830 incorrect result when the signed value is converted to unsigned.
2831 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2832
2833 @item
2834 An aggregate has an initializer which does not initialize all members.
2835 This warning can be independently controlled by
2836 @option{-Wmissing-field-initializers}.
2837
2838 @item
2839 A function parameter is declared without a type specifier in K&R-style
2840 functions:
2841
2842 @smallexample
2843 void foo(bar) @{ @}
2844 @end smallexample
2845
2846 @item
2847 An empty body occurs in an @samp{if} or @samp{else} statement.
2848
2849 @item
2850 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2851 @samp{>}, or @samp{>=}.
2852
2853 @item
2854 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2855
2856 @item
2857 Any of several floating-point events that often indicate errors, such as
2858 overflow, underflow, loss of precision, etc.
2859
2860 @item @r{(C++ only)}
2861 An enumerator and a non-enumerator both appear in a conditional expression.
2862
2863 @item @r{(C++ only)}
2864 A non-static reference or non-static @samp{const} member appears in a
2865 class without constructors.
2866
2867 @item @r{(C++ only)}
2868 Ambiguous virtual bases.
2869
2870 @item @r{(C++ only)}
2871 Subscripting an array which has been declared @samp{register}.
2872
2873 @item @r{(C++ only)}
2874 Taking the address of a variable which has been declared @samp{register}.
2875
2876 @item @r{(C++ only)}
2877 A base class is not initialized in a derived class' copy constructor.
2878 @end itemize
2879
2880 @item -Wno-div-by-zero
2881 @opindex Wno-div-by-zero
2882 @opindex Wdiv-by-zero
2883 Do not warn about compile-time integer division by zero. Floating point
2884 division by zero is not warned about, as it can be a legitimate way of
2885 obtaining infinities and NaNs.
2886
2887 @item -Wsystem-headers
2888 @opindex Wsystem-headers
2889 @cindex warnings from system headers
2890 @cindex system headers, warnings from
2891 Print warning messages for constructs found in system header files.
2892 Warnings from system headers are normally suppressed, on the assumption
2893 that they usually do not indicate real problems and would only make the
2894 compiler output harder to read. Using this command line option tells
2895 GCC to emit warnings from system headers as if they occurred in user
2896 code. However, note that using @option{-Wall} in conjunction with this
2897 option will @emph{not} warn about unknown pragmas in system
2898 headers---for that, @option{-Wunknown-pragmas} must also be used.
2899
2900 @item -Wfloat-equal
2901 @opindex Wfloat-equal
2902 Warn if floating point values are used in equality comparisons.
2903
2904 The idea behind this is that sometimes it is convenient (for the
2905 programmer) to consider floating-point values as approximations to
2906 infinitely precise real numbers. If you are doing this, then you need
2907 to compute (by analyzing the code, or in some other way) the maximum or
2908 likely maximum error that the computation introduces, and allow for it
2909 when performing comparisons (and when producing output, but that's a
2910 different problem). In particular, instead of testing for equality, you
2911 would check to see whether the two values have ranges that overlap; and
2912 this is done with the relational operators, so equality comparisons are
2913 probably mistaken.
2914
2915 @item -Wtraditional @r{(C only)}
2916 @opindex Wtraditional
2917 Warn about certain constructs that behave differently in traditional and
2918 ISO C@. Also warn about ISO C constructs that have no traditional C
2919 equivalent, and/or problematic constructs which should be avoided.
2920
2921 @itemize @bullet
2922 @item
2923 Macro parameters that appear within string literals in the macro body.
2924 In traditional C macro replacement takes place within string literals,
2925 but does not in ISO C@.
2926
2927 @item
2928 In traditional C, some preprocessor directives did not exist.
2929 Traditional preprocessors would only consider a line to be a directive
2930 if the @samp{#} appeared in column 1 on the line. Therefore
2931 @option{-Wtraditional} warns about directives that traditional C
2932 understands but would ignore because the @samp{#} does not appear as the
2933 first character on the line. It also suggests you hide directives like
2934 @samp{#pragma} not understood by traditional C by indenting them. Some
2935 traditional implementations would not recognize @samp{#elif}, so it
2936 suggests avoiding it altogether.
2937
2938 @item
2939 A function-like macro that appears without arguments.
2940
2941 @item
2942 The unary plus operator.
2943
2944 @item
2945 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2946 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2947 constants.) Note, these suffixes appear in macros defined in the system
2948 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2949 Use of these macros in user code might normally lead to spurious
2950 warnings, however GCC's integrated preprocessor has enough context to
2951 avoid warning in these cases.
2952
2953 @item
2954 A function declared external in one block and then used after the end of
2955 the block.
2956
2957 @item
2958 A @code{switch} statement has an operand of type @code{long}.
2959
2960 @item
2961 A non-@code{static} function declaration follows a @code{static} one.
2962 This construct is not accepted by some traditional C compilers.
2963
2964 @item
2965 The ISO type of an integer constant has a different width or
2966 signedness from its traditional type. This warning is only issued if
2967 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2968 typically represent bit patterns, are not warned about.
2969
2970 @item
2971 Usage of ISO string concatenation is detected.
2972
2973 @item
2974 Initialization of automatic aggregates.
2975
2976 @item
2977 Identifier conflicts with labels. Traditional C lacks a separate
2978 namespace for labels.
2979
2980 @item
2981 Initialization of unions. If the initializer is zero, the warning is
2982 omitted. This is done under the assumption that the zero initializer in
2983 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2984 initializer warnings and relies on default initialization to zero in the
2985 traditional C case.
2986
2987 @item
2988 Conversions by prototypes between fixed/floating point values and vice
2989 versa. The absence of these prototypes when compiling with traditional
2990 C would cause serious problems. This is a subset of the possible
2991 conversion warnings, for the full set use @option{-Wconversion}.
2992
2993 @item
2994 Use of ISO C style function definitions. This warning intentionally is
2995 @emph{not} issued for prototype declarations or variadic functions
2996 because these ISO C features will appear in your code when using
2997 libiberty's traditional C compatibility macros, @code{PARAMS} and
2998 @code{VPARAMS}. This warning is also bypassed for nested functions
2999 because that feature is already a GCC extension and thus not relevant to
3000 traditional C compatibility.
3001 @end itemize
3002
3003 @item -Wdeclaration-after-statement @r{(C only)}
3004 @opindex Wdeclaration-after-statement
3005 Warn when a declaration is found after a statement in a block. This
3006 construct, known from C++, was introduced with ISO C99 and is by default
3007 allowed in GCC@. It is not supported by ISO C90 and was not supported by
3008 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
3009
3010 @item -Wundef
3011 @opindex Wundef
3012 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3013
3014 @item -Wno-endif-labels
3015 @opindex Wno-endif-labels
3016 @opindex Wendif-labels
3017 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3018
3019 @item -Wshadow
3020 @opindex Wshadow
3021 Warn whenever a local variable shadows another local variable, parameter or
3022 global variable or whenever a built-in function is shadowed.
3023
3024 @item -Wlarger-than-@var{len}
3025 @opindex Wlarger-than
3026 Warn whenever an object of larger than @var{len} bytes is defined.
3027
3028 @item -Wunsafe-loop-optimizations
3029 @opindex Wunsafe-loop-optimizations
3030 Warn if the loop cannot be optimized because the compiler could not
3031 assume anything on the bounds of the loop indices. With
3032 @option{-funsafe-loop-optimizations} warn if the compiler made
3033 such assumptions.
3034
3035 @item -Wpointer-arith
3036 @opindex Wpointer-arith
3037 Warn about anything that depends on the ``size of'' a function type or
3038 of @code{void}. GNU C assigns these types a size of 1, for
3039 convenience in calculations with @code{void *} pointers and pointers
3040 to functions.
3041
3042 @item -Wbad-function-cast @r{(C only)}
3043 @opindex Wbad-function-cast
3044 Warn whenever a function call is cast to a non-matching type.
3045 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3046
3047 @item -Wc++-compat
3048 Warn about ISO C constructs that are outside of the common subset of
3049 ISO C and ISO C++, e.g.@: request for implicit conversion from
3050 @code{void *} to a pointer to non-@code{void} type.
3051
3052 @item -Wcast-qual
3053 @opindex Wcast-qual
3054 Warn whenever a pointer is cast so as to remove a type qualifier from
3055 the target type. For example, warn if a @code{const char *} is cast
3056 to an ordinary @code{char *}.
3057
3058 @item -Wcast-align
3059 @opindex Wcast-align
3060 Warn whenever a pointer is cast such that the required alignment of the
3061 target is increased. For example, warn if a @code{char *} is cast to
3062 an @code{int *} on machines where integers can only be accessed at
3063 two- or four-byte boundaries.
3064
3065 @item -Wwrite-strings
3066 @opindex Wwrite-strings
3067 When compiling C, give string constants the type @code{const
3068 char[@var{length}]} so that
3069 copying the address of one into a non-@code{const} @code{char *}
3070 pointer will get a warning; when compiling C++, warn about the
3071 deprecated conversion from string literals to @code{char *}. This
3072 warning, by default, is enabled for C++ programs.
3073 These warnings will help you find at
3074 compile time code that can try to write into a string constant, but
3075 only if you have been very careful about using @code{const} in
3076 declarations and prototypes. Otherwise, it will just be a nuisance;
3077 this is why we did not make @option{-Wall} request these warnings.
3078
3079 @item -Wconversion
3080 @opindex Wconversion
3081 Warn if a prototype causes a type conversion that is different from what
3082 would happen to the same argument in the absence of a prototype. This
3083 includes conversions of fixed point to floating and vice versa, and
3084 conversions changing the width or signedness of a fixed point argument
3085 except when the same as the default promotion.
3086
3087 Also, warn if a negative integer constant expression is implicitly
3088 converted to an unsigned type. For example, warn about the assignment
3089 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
3090 casts like @code{(unsigned) -1}.
3091
3092 @item -Wsign-compare
3093 @opindex Wsign-compare
3094 @cindex warning for comparison of signed and unsigned values
3095 @cindex comparison of signed and unsigned values, warning
3096 @cindex signed and unsigned values, comparison warning
3097 Warn when a comparison between signed and unsigned values could produce
3098 an incorrect result when the signed value is converted to unsigned.
3099 This warning is also enabled by @option{-Wextra}; to get the other warnings
3100 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3101
3102 @item -Waggregate-return
3103 @opindex Waggregate-return
3104 Warn if any functions that return structures or unions are defined or
3105 called. (In languages where you can return an array, this also elicits
3106 a warning.)
3107
3108 @item -Walways-true
3109 @opindex Walways-true
3110 Warn about comparisons which are always true such as testing if
3111 unsigned values are greater than or equal to zero. This warning is
3112 enabled by @option{-Wall}.
3113
3114 @item -Wno-attributes
3115 @opindex Wno-attributes
3116 @opindex Wattributes
3117 Do not warn if an unexpected @code{__attribute__} is used, such as
3118 unrecognized attributes, function attributes applied to variables,
3119 etc. This will not stop errors for incorrect use of supported
3120 attributes.
3121
3122 @item -Wstrict-prototypes @r{(C only)}
3123 @opindex Wstrict-prototypes
3124 Warn if a function is declared or defined without specifying the
3125 argument types. (An old-style function definition is permitted without
3126 a warning if preceded by a declaration which specifies the argument
3127 types.)
3128
3129 @item -Wold-style-definition @r{(C only)}
3130 @opindex Wold-style-definition
3131 Warn if an old-style function definition is used. A warning is given
3132 even if there is a previous prototype.
3133
3134 @item -Wmissing-prototypes @r{(C only)}
3135 @opindex Wmissing-prototypes
3136 Warn if a global function is defined without a previous prototype
3137 declaration. This warning is issued even if the definition itself
3138 provides a prototype. The aim is to detect global functions that fail
3139 to be declared in header files.
3140
3141 @item -Wmissing-declarations @r{(C only)}
3142 @opindex Wmissing-declarations
3143 Warn if a global function is defined without a previous declaration.
3144 Do so even if the definition itself provides a prototype.
3145 Use this option to detect global functions that are not declared in
3146 header files.
3147
3148 @item -Wmissing-field-initializers
3149 @opindex Wmissing-field-initializers
3150 @opindex W
3151 @opindex Wextra
3152 Warn if a structure's initializer has some fields missing. For
3153 example, the following code would cause such a warning, because
3154 @code{x.h} is implicitly zero:
3155
3156 @smallexample
3157 struct s @{ int f, g, h; @};
3158 struct s x = @{ 3, 4 @};
3159 @end smallexample
3160
3161 This option does not warn about designated initializers, so the following
3162 modification would not trigger a warning:
3163
3164 @smallexample
3165 struct s @{ int f, g, h; @};
3166 struct s x = @{ .f = 3, .g = 4 @};
3167 @end smallexample
3168
3169 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3170 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3171
3172 @item -Wmissing-noreturn
3173 @opindex Wmissing-noreturn
3174 Warn about functions which might be candidates for attribute @code{noreturn}.
3175 Note these are only possible candidates, not absolute ones. Care should
3176 be taken to manually verify functions actually do not ever return before
3177 adding the @code{noreturn} attribute, otherwise subtle code generation
3178 bugs could be introduced. You will not get a warning for @code{main} in
3179 hosted C environments.
3180
3181 @item -Wmissing-format-attribute
3182 @opindex Wmissing-format-attribute
3183 @opindex Wformat
3184 Warn about function pointers which might be candidates for @code{format}
3185 attributes. Note these are only possible candidates, not absolute ones.
3186 GCC will guess that function pointers with @code{format} attributes that
3187 are used in assignment, initialization, parameter passing or return
3188 statements should have a corresponding @code{format} attribute in the
3189 resulting type. I.e.@: the left-hand side of the assignment or
3190 initialization, the type of the parameter variable, or the return type
3191 of the containing function respectively should also have a @code{format}
3192 attribute to avoid the warning.
3193
3194 GCC will also warn about function definitions which might be
3195 candidates for @code{format} attributes. Again, these are only
3196 possible candidates. GCC will guess that @code{format} attributes
3197 might be appropriate for any function that calls a function like
3198 @code{vprintf} or @code{vscanf}, but this might not always be the
3199 case, and some functions for which @code{format} attributes are
3200 appropriate may not be detected.
3201
3202 @item -Wno-multichar
3203 @opindex Wno-multichar
3204 @opindex Wmultichar
3205 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3206 Usually they indicate a typo in the user's code, as they have
3207 implementation-defined values, and should not be used in portable code.
3208
3209 @item -Wnormalized=<none|id|nfc|nfkc>
3210 @opindex Wnormalized
3211 @cindex NFC
3212 @cindex NFKC
3213 @cindex character set, input normalization
3214 In ISO C and ISO C++, two identifiers are different if they are
3215 different sequences of characters. However, sometimes when characters
3216 outside the basic ASCII character set are used, you can have two
3217 different character sequences that look the same. To avoid confusion,
3218 the ISO 10646 standard sets out some @dfn{normalization rules} which
3219 when applied ensure that two sequences that look the same are turned into
3220 the same sequence. GCC can warn you if you are using identifiers which
3221 have not been normalized; this option controls that warning.
3222
3223 There are four levels of warning that GCC supports. The default is
3224 @option{-Wnormalized=nfc}, which warns about any identifier which is
3225 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3226 recommended form for most uses.
3227
3228 Unfortunately, there are some characters which ISO C and ISO C++ allow
3229 in identifiers that when turned into NFC aren't allowable as
3230 identifiers. That is, there's no way to use these symbols in portable
3231 ISO C or C++ and have all your identifiers in NFC.
3232 @option{-Wnormalized=id} suppresses the warning for these characters.
3233 It is hoped that future versions of the standards involved will correct
3234 this, which is why this option is not the default.
3235
3236 You can switch the warning off for all characters by writing
3237 @option{-Wnormalized=none}. You would only want to do this if you
3238 were using some other normalization scheme (like ``D''), because
3239 otherwise you can easily create bugs that are literally impossible to see.
3240
3241 Some characters in ISO 10646 have distinct meanings but look identical
3242 in some fonts or display methodologies, especially once formatting has
3243 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3244 LETTER N'', will display just like a regular @code{n} which has been
3245 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3246 normalisation scheme to convert all these into a standard form as
3247 well, and GCC will warn if your code is not in NFKC if you use
3248 @option{-Wnormalized=nfkc}. This warning is comparable to warning
3249 about every identifier that contains the letter O because it might be
3250 confused with the digit 0, and so is not the default, but may be
3251 useful as a local coding convention if the programming environment is
3252 unable to be fixed to display these characters distinctly.
3253
3254 @item -Wno-deprecated-declarations
3255 @opindex Wno-deprecated-declarations
3256 Do not warn about uses of functions, variables, and types marked as
3257 deprecated by using the @code{deprecated} attribute.
3258 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3259 @pxref{Type Attributes}.)
3260
3261 @item -Wpacked
3262 @opindex Wpacked
3263 Warn if a structure is given the packed attribute, but the packed
3264 attribute has no effect on the layout or size of the structure.
3265 Such structures may be mis-aligned for little benefit. For
3266 instance, in this code, the variable @code{f.x} in @code{struct bar}
3267 will be misaligned even though @code{struct bar} does not itself
3268 have the packed attribute:
3269
3270 @smallexample
3271 @group
3272 struct foo @{
3273 int x;
3274 char a, b, c, d;
3275 @} __attribute__((packed));
3276 struct bar @{
3277 char z;
3278 struct foo f;
3279 @};
3280 @end group
3281 @end smallexample
3282
3283 @item -Wpadded
3284 @opindex Wpadded
3285 Warn if padding is included in a structure, either to align an element
3286 of the structure or to align the whole structure. Sometimes when this
3287 happens it is possible to rearrange the fields of the structure to
3288 reduce the padding and so make the structure smaller.
3289
3290 @item -Wredundant-decls
3291 @opindex Wredundant-decls
3292 Warn if anything is declared more than once in the same scope, even in
3293 cases where multiple declaration is valid and changes nothing.
3294
3295 @item -Wnested-externs @r{(C only)}
3296 @opindex Wnested-externs
3297 Warn if an @code{extern} declaration is encountered within a function.
3298
3299 @item -Wunreachable-code
3300 @opindex Wunreachable-code
3301 Warn if the compiler detects that code will never be executed.
3302
3303 This option is intended to warn when the compiler detects that at
3304 least a whole line of source code will never be executed, because
3305 some condition is never satisfied or because it is after a
3306 procedure that never returns.
3307
3308 It is possible for this option to produce a warning even though there
3309 are circumstances under which part of the affected line can be executed,
3310 so care should be taken when removing apparently-unreachable code.
3311
3312 For instance, when a function is inlined, a warning may mean that the
3313 line is unreachable in only one inlined copy of the function.
3314
3315 This option is not made part of @option{-Wall} because in a debugging
3316 version of a program there is often substantial code which checks
3317 correct functioning of the program and is, hopefully, unreachable
3318 because the program does work. Another common use of unreachable
3319 code is to provide behavior which is selectable at compile-time.
3320
3321 @item -Winline
3322 @opindex Winline
3323 Warn if a function can not be inlined and it was declared as inline.
3324 Even with this option, the compiler will not warn about failures to
3325 inline functions declared in system headers.
3326
3327 The compiler uses a variety of heuristics to determine whether or not
3328 to inline a function. For example, the compiler takes into account
3329 the size of the function being inlined and the amount of inlining
3330 that has already been done in the current function. Therefore,
3331 seemingly insignificant changes in the source program can cause the
3332 warnings produced by @option{-Winline} to appear or disappear.
3333
3334 @item -Wno-invalid-offsetof @r{(C++ only)}
3335 @opindex Wno-invalid-offsetof
3336 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3337 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3338 to a non-POD type is undefined. In existing C++ implementations,
3339 however, @samp{offsetof} typically gives meaningful results even when
3340 applied to certain kinds of non-POD types. (Such as a simple
3341 @samp{struct} that fails to be a POD type only by virtue of having a
3342 constructor.) This flag is for users who are aware that they are
3343 writing nonportable code and who have deliberately chosen to ignore the
3344 warning about it.
3345
3346 The restrictions on @samp{offsetof} may be relaxed in a future version
3347 of the C++ standard.
3348
3349 @item -Wno-int-to-pointer-cast @r{(C only)}
3350 @opindex Wno-int-to-pointer-cast
3351 Suppress warnings from casts to pointer type of an integer of a
3352 different size.
3353
3354 @item -Wno-pointer-to-int-cast @r{(C only)}
3355 @opindex Wno-pointer-to-int-cast
3356 Suppress warnings from casts from a pointer to an integer type of a
3357 different size.
3358
3359 @item -Winvalid-pch
3360 @opindex Winvalid-pch
3361 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3362 the search path but can't be used.
3363
3364 @item -Wlong-long
3365 @opindex Wlong-long
3366 @opindex Wno-long-long
3367 Warn if @samp{long long} type is used. This is default. To inhibit
3368 the warning messages, use @option{-Wno-long-long}. Flags
3369 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3370 only when @option{-pedantic} flag is used.
3371
3372 @item -Wvariadic-macros
3373 @opindex Wvariadic-macros
3374 @opindex Wno-variadic-macros
3375 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3376 alternate syntax when in pedantic ISO C99 mode. This is default.
3377 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3378
3379 @item -Wvolatile-register-var
3380 @opindex Wvolatile-register-var
3381 @opindex Wno-volatile-register-var
3382 Warn if a register variable is declared volatile. The volatile
3383 modifier does not inhibit all optimizations that may eliminate reads
3384 and/or writes to register variables.
3385
3386 @item -Wdisabled-optimization
3387 @opindex Wdisabled-optimization
3388 Warn if a requested optimization pass is disabled. This warning does
3389 not generally indicate that there is anything wrong with your code; it
3390 merely indicates that GCC's optimizers were unable to handle the code
3391 effectively. Often, the problem is that your code is too big or too
3392 complex; GCC will refuse to optimize programs when the optimization
3393 itself is likely to take inordinate amounts of time.
3394
3395 @item -Wpointer-sign
3396 @opindex Wpointer-sign
3397 @opindex Wno-pointer-sign
3398 Warn for pointer argument passing or assignment with different signedness.
3399 This option is only supported for C and Objective-C@. It is implied by
3400 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3401 @option{-Wno-pointer-sign}.
3402
3403 @item -Werror
3404 @opindex Werror
3405 Make all warnings into errors.
3406
3407 @item -Werror=
3408 @opindex Werror=
3409 Make the specified warning into an errors. The specifier for a
3410 warning is appended, for example @option{-Werror=switch} turns the
3411 warnings controlled by @option{-Wswitch} into errors. This switch
3412 takes a negative form, to be used to negate @option{-Werror} for
3413 specific warnings, for example @option{-Wno-error=switch} makes
3414 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3415 is in effect. You can use the @option{-fdiagnostics-show-option}
3416 option to have each controllable warning amended with the option which
3417 controls it, to determine what to use with this option.
3418
3419 Note that specifying @option{-Werror=}@var{foo} automatically implies
3420 @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
3421 imply anything.
3422
3423 @item -Wstack-protector
3424 @opindex Wstack-protector
3425 This option is only active when @option{-fstack-protector} is active. It
3426 warns about functions that will not be protected against stack smashing.
3427
3428 @item -Wstring-literal-comparison
3429 @opindex Wstring-literal-comparison
3430 Warn about suspicious comparisons to string literal constants. In C,
3431 direct comparisons against the memory address of a string literal, such
3432 as @code{if (x == "abc")}, typically indicate a programmer error, and
3433 even when intentional, result in unspecified behavior and are not portable.
3434 Usually these warnings alert that the programmer intended to use
3435 @code{strcmp}. This warning is enabled by @option{-Wall}.
3436
3437 @item -Woverlength-strings
3438 @opindex Woverlength-strings
3439 Warn about string constants which are longer than the ``minimum
3440 maximum'' length specified in the C standard. Modern compilers
3441 generally allow string constants which are much longer than the
3442 standard's minimum limit, but very portable programs should avoid
3443 using longer strings.
3444
3445 The limit applies @emph{after} string constant concatenation, and does
3446 not count the trailing NUL@. In C89, the limit was 509 characters; in
3447 C99, it was raised to 4095. C++98 does not specify a normative
3448 minimum maximum, so we do not diagnose overlength strings in C++@.
3449
3450 This option is implied by @option{-pedantic}, and can be disabled with
3451 @option{-Wno-overlength-strings}.
3452 @end table
3453
3454 @node Debugging Options
3455 @section Options for Debugging Your Program or GCC
3456 @cindex options, debugging
3457 @cindex debugging information options
3458
3459 GCC has various special options that are used for debugging
3460 either your program or GCC:
3461
3462 @table @gcctabopt
3463 @item -g
3464 @opindex g
3465 Produce debugging information in the operating system's native format
3466 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
3467 information.
3468
3469 On most systems that use stabs format, @option{-g} enables use of extra
3470 debugging information that only GDB can use; this extra information
3471 makes debugging work better in GDB but will probably make other debuggers
3472 crash or
3473 refuse to read the program. If you want to control for certain whether
3474 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3475 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3476
3477 GCC allows you to use @option{-g} with
3478 @option{-O}. The shortcuts taken by optimized code may occasionally
3479 produce surprising results: some variables you declared may not exist
3480 at all; flow of control may briefly move where you did not expect it;
3481 some statements may not be executed because they compute constant
3482 results or their values were already at hand; some statements may
3483 execute in different places because they were moved out of loops.
3484
3485 Nevertheless it proves possible to debug optimized output. This makes
3486 it reasonable to use the optimizer for programs that might have bugs.
3487
3488 The following options are useful when GCC is generated with the
3489 capability for more than one debugging format.
3490
3491 @item -ggdb
3492 @opindex ggdb
3493 Produce debugging information for use by GDB@. This means to use the
3494 most expressive format available (DWARF 2, stabs, or the native format
3495 if neither of those are supported), including GDB extensions if at all
3496 possible.
3497
3498 @item -gstabs
3499 @opindex gstabs
3500 Produce debugging information in stabs format (if that is supported),
3501 without GDB extensions. This is the format used by DBX on most BSD
3502 systems. On MIPS, Alpha and System V Release 4 systems this option
3503 produces stabs debugging output which is not understood by DBX or SDB@.
3504 On System V Release 4 systems this option requires the GNU assembler.
3505
3506 @item -feliminate-unused-debug-symbols
3507 @opindex feliminate-unused-debug-symbols
3508 Produce debugging information in stabs format (if that is supported),
3509 for only symbols that are actually used.
3510
3511 @item -gstabs+
3512 @opindex gstabs+
3513 Produce debugging information in stabs format (if that is supported),
3514 using GNU extensions understood only by the GNU debugger (GDB)@. The
3515 use of these extensions is likely to make other debuggers crash or
3516 refuse to read the program.
3517
3518 @item -gcoff
3519 @opindex gcoff
3520 Produce debugging information in COFF format (if that is supported).
3521 This is the format used by SDB on most System V systems prior to
3522 System V Release 4.
3523
3524 @item -gxcoff
3525 @opindex gxcoff
3526 Produce debugging information in XCOFF format (if that is supported).
3527 This is the format used by the DBX debugger on IBM RS/6000 systems.
3528
3529 @item -gxcoff+
3530 @opindex gxcoff+
3531 Produce debugging information in XCOFF format (if that is supported),
3532 using GNU extensions understood only by the GNU debugger (GDB)@. The
3533 use of these extensions is likely to make other debuggers crash or
3534 refuse to read the program, and may cause assemblers other than the GNU
3535 assembler (GAS) to fail with an error.
3536
3537 @item -gdwarf-2
3538 @opindex gdwarf-2
3539 Produce debugging information in DWARF version 2 format (if that is
3540 supported). This is the format used by DBX on IRIX 6. With this
3541 option, GCC uses features of DWARF version 3 when they are useful;
3542 version 3 is upward compatible with version 2, but may still cause
3543 problems for older debuggers.
3544
3545 @item -gvms
3546 @opindex gvms
3547 Produce debugging information in VMS debug format (if that is
3548 supported). This is the format used by DEBUG on VMS systems.
3549
3550 @item -g@var{level}
3551 @itemx -ggdb@var{level}
3552 @itemx -gstabs@var{level}
3553 @itemx -gcoff@var{level}
3554 @itemx -gxcoff@var{level}
3555 @itemx -gvms@var{level}
3556 Request debugging information and also use @var{level} to specify how
3557 much information. The default level is 2.
3558
3559 Level 1 produces minimal information, enough for making backtraces in
3560 parts of the program that you don't plan to debug. This includes
3561 descriptions of functions and external variables, but no information
3562 about local variables and no line numbers.
3563
3564 Level 3 includes extra information, such as all the macro definitions
3565 present in the program. Some debuggers support macro expansion when
3566 you use @option{-g3}.
3567
3568 @option{-gdwarf-2} does not accept a concatenated debug level, because
3569 GCC used to support an option @option{-gdwarf} that meant to generate
3570 debug information in version 1 of the DWARF format (which is very
3571 different from version 2), and it would have been too confusing. That
3572 debug format is long obsolete, but the option cannot be changed now.
3573 Instead use an additional @option{-g@var{level}} option to change the
3574 debug level for DWARF2.
3575
3576 @item -feliminate-dwarf2-dups
3577 @opindex feliminate-dwarf2-dups
3578 Compress DWARF2 debugging information by eliminating duplicated
3579 information about each symbol. This option only makes sense when
3580 generating DWARF2 debugging information with @option{-gdwarf-2}.
3581
3582 @cindex @command{prof}
3583 @item -p
3584 @opindex p
3585 Generate extra code to write profile information suitable for the
3586 analysis program @command{prof}. You must use this option when compiling
3587 the source files you want data about, and you must also use it when
3588 linking.
3589
3590 @cindex @command{gprof}
3591 @item -pg
3592 @opindex pg
3593 Generate extra code to write profile information suitable for the
3594 analysis program @command{gprof}. You must use this option when compiling
3595 the source files you want data about, and you must also use it when
3596 linking.
3597
3598 @item -Q
3599 @opindex Q
3600 Makes the compiler print out each function name as it is compiled, and
3601 print some statistics about each pass when it finishes.
3602
3603 @item -ftime-report
3604 @opindex ftime-report
3605 Makes the compiler print some statistics about the time consumed by each
3606 pass when it finishes.
3607
3608 @item -fmem-report
3609 @opindex fmem-report
3610 Makes the compiler print some statistics about permanent memory
3611 allocation when it finishes.
3612
3613 @item -fprofile-arcs
3614 @opindex fprofile-arcs
3615 Add code so that program flow @dfn{arcs} are instrumented. During
3616 execution the program records how many times each branch and call is
3617 executed and how many times it is taken or returns. When the compiled
3618 program exits it saves this data to a file called
3619 @file{@var{auxname}.gcda} for each source file. The data may be used for
3620 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3621 test coverage analysis (@option{-ftest-coverage}). Each object file's
3622 @var{auxname} is generated from the name of the output file, if
3623 explicitly specified and it is not the final executable, otherwise it is
3624 the basename of the source file. In both cases any suffix is removed
3625 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3626 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3627 @xref{Cross-profiling}.
3628
3629 @cindex @command{gcov}
3630 @item --coverage
3631 @opindex coverage
3632
3633 This option is used to compile and link code instrumented for coverage
3634 analysis. The option is a synonym for @option{-fprofile-arcs}
3635 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3636 linking). See the documentation for those options for more details.
3637
3638 @itemize
3639
3640 @item
3641 Compile the source files with @option{-fprofile-arcs} plus optimization
3642 and code generation options. For test coverage analysis, use the
3643 additional @option{-ftest-coverage} option. You do not need to profile
3644 every source file in a program.
3645
3646 @item
3647 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3648 (the latter implies the former).
3649
3650 @item
3651 Run the program on a representative workload to generate the arc profile
3652 information. This may be repeated any number of times. You can run
3653 concurrent instances of your program, and provided that the file system
3654 supports locking, the data files will be correctly updated. Also
3655 @code{fork} calls are detected and correctly handled (double counting
3656 will not happen).
3657
3658 @item
3659 For profile-directed optimizations, compile the source files again with
3660 the same optimization and code generation options plus
3661 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3662 Control Optimization}).
3663
3664 @item
3665 For test coverage analysis, use @command{gcov} to produce human readable
3666 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3667 @command{gcov} documentation for further information.
3668
3669 @end itemize
3670
3671 With @option{-fprofile-arcs}, for each function of your program GCC
3672 creates a program flow graph, then finds a spanning tree for the graph.
3673 Only arcs that are not on the spanning tree have to be instrumented: the
3674 compiler adds code to count the number of times that these arcs are
3675 executed. When an arc is the only exit or only entrance to a block, the
3676 instrumentation code can be added to the block; otherwise, a new basic
3677 block must be created to hold the instrumentation code.
3678
3679 @need 2000
3680 @item -ftest-coverage
3681 @opindex ftest-coverage
3682 Produce a notes file that the @command{gcov} code-coverage utility
3683 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3684 show program coverage. Each source file's note file is called
3685 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3686 above for a description of @var{auxname} and instructions on how to
3687 generate test coverage data. Coverage data will match the source files
3688 more closely, if you do not optimize.
3689
3690 @item -d@var{letters}
3691 @item -fdump-rtl-@var{pass}
3692 @opindex d
3693 Says to make debugging dumps during compilation at times specified by
3694 @var{letters}. This is used for debugging the RTL-based passes of the
3695 compiler. The file names for most of the dumps are made by appending a
3696 pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3697 from the name of the output file, if explicitly specified and it is not
3698 an executable, otherwise it is the basename of the source file.
3699
3700 Most debug dumps can be enabled either passing a letter to the @option{-d}
3701 option, or with a long @option{-fdump-rtl} switch; here are the possible
3702 letters for use in @var{letters} and @var{pass}, and their meanings:
3703
3704 @table @gcctabopt
3705 @item -dA
3706 @opindex dA
3707 Annotate the assembler output with miscellaneous debugging information.
3708
3709 @item -db
3710 @itemx -fdump-rtl-bp
3711 @opindex db
3712 @opindex fdump-rtl-bp
3713 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3714
3715 @item -dB
3716 @itemx -fdump-rtl-bbro
3717 @opindex dB
3718 @opindex fdump-rtl-bbro
3719 Dump after block reordering, to @file{@var{file}.30.bbro}.
3720
3721 @item -dc
3722 @itemx -fdump-rtl-combine
3723 @opindex dc
3724 @opindex fdump-rtl-combine
3725 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3726
3727 @item -dC
3728 @itemx -fdump-rtl-ce1
3729 @itemx -fdump-rtl-ce2
3730 @opindex dC
3731 @opindex fdump-rtl-ce1
3732 @opindex fdump-rtl-ce2
3733 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3734 first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3735 and @option{-fdump-rtl-ce2} enable dumping after the second if
3736 conversion, to the file @file{@var{file}.18.ce2}.
3737
3738 @item -dd
3739 @itemx -fdump-rtl-btl
3740 @itemx -fdump-rtl-dbr
3741 @opindex dd
3742 @opindex fdump-rtl-btl
3743 @opindex fdump-rtl-dbr
3744 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3745 target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
3746 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3747 scheduling, to @file{@var{file}.36.dbr}.
3748
3749 @item -dD
3750 @opindex dD
3751 Dump all macro definitions, at the end of preprocessing, in addition to
3752 normal output.
3753
3754 @item -dE
3755 @itemx -fdump-rtl-ce3
3756 @opindex dE
3757 @opindex fdump-rtl-ce3
3758 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3759
3760 @item -df
3761 @itemx -fdump-rtl-cfg
3762 @itemx -fdump-rtl-life
3763 @opindex df
3764 @opindex fdump-rtl-cfg
3765 @opindex fdump-rtl-life
3766 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3767 and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3768 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3769 to @file{@var{file}.16.life}.
3770
3771 @item -dg
3772 @itemx -fdump-rtl-greg
3773 @opindex dg
3774 @opindex fdump-rtl-greg
3775 Dump after global register allocation, to @file{@var{file}.23.greg}.
3776
3777 @item -dG
3778 @itemx -fdump-rtl-gcse
3779 @itemx -fdump-rtl-bypass
3780 @opindex dG
3781 @opindex fdump-rtl-gcse
3782 @opindex fdump-rtl-bypass
3783 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3784 @file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3785 enable dumping after jump bypassing and control flow optimizations, to
3786 @file{@var{file}.07.bypass}.
3787
3788 @item -dh
3789 @itemx -fdump-rtl-eh
3790 @opindex dh
3791 @opindex fdump-rtl-eh
3792 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3793
3794 @item -di
3795 @itemx -fdump-rtl-sibling
3796 @opindex di
3797 @opindex fdump-rtl-sibling
3798 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3799
3800 @item -dj
3801 @itemx -fdump-rtl-jump
3802 @opindex dj
3803 @opindex fdump-rtl-jump
3804 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3805
3806 @item -dk
3807 @itemx -fdump-rtl-stack
3808 @opindex dk
3809 @opindex fdump-rtl-stack
3810 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3811
3812 @item -dl
3813 @itemx -fdump-rtl-lreg
3814 @opindex dl
3815 @opindex fdump-rtl-lreg
3816 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3817
3818 @item -dL
3819 @itemx -fdump-rtl-loop
3820 @itemx -fdump-rtl-loop2
3821 @opindex dL
3822 @opindex fdump-rtl-loop
3823 @opindex fdump-rtl-loop2
3824 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3825 loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3826 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3827 @file{@var{file}.13.loop2}.
3828
3829 @item -dm
3830 @itemx -fdump-rtl-sms
3831 @opindex dm
3832 @opindex fdump-rtl-sms
3833 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3834
3835 @item -dM
3836 @itemx -fdump-rtl-mach
3837 @opindex dM
3838 @opindex fdump-rtl-mach
3839 Dump after performing the machine dependent reorganization pass, to
3840 @file{@var{file}.35.mach}.
3841
3842 @item -dn
3843 @itemx -fdump-rtl-rnreg
3844 @opindex dn
3845 @opindex fdump-rtl-rnreg
3846 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3847
3848 @item -dN
3849 @itemx -fdump-rtl-regmove
3850 @opindex dN
3851 @opindex fdump-rtl-regmove
3852 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3853
3854 @item -do
3855 @itemx -fdump-rtl-postreload
3856 @opindex do
3857 @opindex fdump-rtl-postreload
3858 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3859
3860 @item -dr
3861 @itemx -fdump-rtl-expand
3862 @opindex dr
3863 @opindex fdump-rtl-expand
3864 Dump after RTL generation, to @file{@var{file}.00.expand}.
3865
3866 @item -dR
3867 @itemx -fdump-rtl-sched2
3868 @opindex dR
3869 @opindex fdump-rtl-sched2
3870 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3871
3872 @item -ds
3873 @itemx -fdump-rtl-cse
3874 @opindex ds
3875 @opindex fdump-rtl-cse
3876 Dump after CSE (including the jump optimization that sometimes follows
3877 CSE), to @file{@var{file}.04.cse}.
3878
3879 @item -dS
3880 @itemx -fdump-rtl-sched
3881 @opindex dS
3882 @opindex fdump-rtl-sched
3883 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3884
3885 @item -dt
3886 @itemx -fdump-rtl-cse2
3887 @opindex dt
3888 @opindex fdump-rtl-cse2
3889 Dump after the second CSE pass (including the jump optimization that
3890 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3891
3892 @item -dT
3893 @itemx -fdump-rtl-tracer
3894 @opindex dT
3895 @opindex fdump-rtl-tracer
3896 Dump after running tracer, to @file{@var{file}.12.tracer}.
3897
3898 @item -dV
3899 @itemx -fdump-rtl-vpt
3900 @itemx -fdump-rtl-vartrack
3901 @opindex dV
3902 @opindex fdump-rtl-vpt
3903 @opindex fdump-rtl-vartrack
3904 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3905 profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3906 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3907 to @file{@var{file}.34.vartrack}.
3908
3909 @item -dw
3910 @itemx -fdump-rtl-flow2
3911 @opindex dw
3912 @opindex fdump-rtl-flow2
3913 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3914
3915 @item -dz
3916 @itemx -fdump-rtl-peephole2
3917 @opindex dz
3918 @opindex fdump-rtl-peephole2
3919 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3920
3921 @item -dZ
3922 @itemx -fdump-rtl-web
3923 @opindex dZ
3924 @opindex fdump-rtl-web
3925 Dump after live range splitting, to @file{@var{file}.14.web}.
3926
3927 @item -da
3928 @itemx -fdump-rtl-all
3929 @opindex da
3930 @opindex fdump-rtl-all
3931 Produce all the dumps listed above.
3932
3933 @item -dH
3934 @opindex dH
3935 Produce a core dump whenever an error occurs.
3936
3937 @item -dm
3938 @opindex dm
3939 Print statistics on memory usage, at the end of the run, to
3940 standard error.
3941
3942 @item -dp
3943 @opindex dp
3944 Annotate the assembler output with a comment indicating which
3945 pattern and alternative was used. The length of each instruction is
3946 also printed.
3947
3948 @item -dP
3949 @opindex dP
3950 Dump the RTL in the assembler output as a comment before each instruction.
3951 Also turns on @option{-dp} annotation.
3952
3953 @item -dv
3954 @opindex dv
3955 For each of the other indicated dump files (either with @option{-d} or
3956 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3957 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3958
3959 @item -dx
3960 @opindex dx
3961 Just generate RTL for a function instead of compiling it. Usually used
3962 with @samp{r} (@option{-fdump-rtl-expand}).
3963
3964 @item -dy
3965 @opindex dy
3966 Dump debugging information during parsing, to standard error.
3967 @end table
3968
3969 @item -fdump-unnumbered
3970 @opindex fdump-unnumbered
3971 When doing debugging dumps (see @option{-d} option above), suppress instruction
3972 numbers and line number note output. This makes it more feasible to
3973 use diff on debugging dumps for compiler invocations with different
3974 options, in particular with and without @option{-g}.
3975
3976 @item -fdump-translation-unit @r{(C++ only)}
3977 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3978 @opindex fdump-translation-unit
3979 Dump a representation of the tree structure for the entire translation
3980 unit to a file. The file name is made by appending @file{.tu} to the
3981 source file name. If the @samp{-@var{options}} form is used, @var{options}
3982 controls the details of the dump as described for the
3983 @option{-fdump-tree} options.
3984
3985 @item -fdump-class-hierarchy @r{(C++ only)}
3986 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3987 @opindex fdump-class-hierarchy
3988 Dump a representation of each class's hierarchy and virtual function
3989 table layout to a file. The file name is made by appending @file{.class}
3990 to the source file name. If the @samp{-@var{options}} form is used,
3991 @var{options} controls the details of the dump as described for the
3992 @option{-fdump-tree} options.
3993
3994 @item -fdump-ipa-@var{switch}
3995 @opindex fdump-ipa
3996 Control the dumping at various stages of inter-procedural analysis
3997 language tree to a file. The file name is generated by appending a switch
3998 specific suffix to the source file name. The following dumps are possible:
3999
4000 @table @samp
4001 @item all
4002 Enables all inter-procedural analysis dumps; currently the only produced
4003 dump is the @samp{cgraph} dump.
4004
4005 @item cgraph
4006 Dumps information about call-graph optimization, unused function removal,
4007 and inlining decisions.
4008 @end table
4009
4010 @item -fdump-tree-@var{switch}
4011 @itemx -fdump-tree-@var{switch}-@var{options}
4012 @opindex fdump-tree
4013 Control the dumping at various stages of processing the intermediate
4014 language tree to a file. The file name is generated by appending a switch
4015 specific suffix to the source file name. If the @samp{-@var{options}}
4016 form is used, @var{options} is a list of @samp{-} separated options that
4017 control the details of the dump. Not all options are applicable to all
4018 dumps, those which are not meaningful will be ignored. The following
4019 options are available
4020
4021 @table @samp
4022 @item address
4023 Print the address of each node. Usually this is not meaningful as it
4024 changes according to the environment and source file. Its primary use
4025 is for tying up a dump file with a debug environment.
4026 @item slim
4027 Inhibit dumping of members of a scope or body of a function merely
4028 because that scope has been reached. Only dump such items when they
4029 are directly reachable by some other path. When dumping pretty-printed
4030 trees, this option inhibits dumping the bodies of control structures.
4031 @item raw
4032 Print a raw representation of the tree. By default, trees are
4033 pretty-printed into a C-like representation.
4034 @item details
4035 Enable more detailed dumps (not honored by every dump option).
4036 @item stats
4037 Enable dumping various statistics about the pass (not honored by every dump
4038 option).
4039 @item blocks
4040 Enable showing basic block boundaries (disabled in raw dumps).
4041 @item vops
4042 Enable showing virtual operands for every statement.
4043 @item lineno
4044 Enable showing line numbers for statements.
4045 @item uid
4046 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4047 @item all
4048 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4049 @end table
4050
4051 The following tree dumps are possible:
4052 @table @samp
4053
4054 @item original
4055 Dump before any tree based optimization, to @file{@var{file}.original}.
4056
4057 @item optimized
4058 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4059
4060 @item inlined
4061 Dump after function inlining, to @file{@var{file}.inlined}.
4062
4063 @item gimple
4064 @opindex fdump-tree-gimple
4065 Dump each function before and after the gimplification pass to a file. The
4066 file name is made by appending @file{.gimple} to the source file name.
4067
4068 @item cfg
4069 @opindex fdump-tree-cfg
4070 Dump the control flow graph of each function to a file. The file name is
4071 made by appending @file{.cfg} to the source file name.
4072
4073 @item vcg
4074 @opindex fdump-tree-vcg
4075 Dump the control flow graph of each function to a file in VCG format. The
4076 file name is made by appending @file{.vcg} to the source file name. Note
4077 that if the file contains more than one function, the generated file cannot
4078 be used directly by VCG@. You will need to cut and paste each function's
4079 graph into its own separate file first.
4080
4081 @item ch
4082 @opindex fdump-tree-ch
4083 Dump each function after copying loop headers. The file name is made by
4084 appending @file{.ch} to the source file name.
4085
4086 @item ssa
4087 @opindex fdump-tree-ssa
4088 Dump SSA related information to a file. The file name is made by appending
4089 @file{.ssa} to the source file name.
4090
4091 @item salias
4092 @opindex fdump-tree-salias
4093 Dump structure aliasing variable information to a file. This file name
4094 is made by appending @file{.salias} to the source file name.
4095
4096 @item alias
4097 @opindex fdump-tree-alias
4098 Dump aliasing information for each function. The file name is made by
4099 appending @file{.alias} to the source file name.
4100
4101 @item ccp
4102 @opindex fdump-tree-ccp
4103 Dump each function after CCP@. The file name is made by appending
4104 @file{.ccp} to the source file name.
4105
4106 @item storeccp
4107 @opindex fdump-tree-storeccp
4108 Dump each function after STORE-CCP. The file name is made by appending
4109 @file{.storeccp} to the source file name.
4110
4111 @item pre
4112 @opindex fdump-tree-pre
4113 Dump trees after partial redundancy elimination. The file name is made
4114 by appending @file{.pre} to the source file name.
4115
4116 @item fre
4117 @opindex fdump-tree-fre
4118 Dump trees after full redundancy elimination. The file name is made
4119 by appending @file{.fre} to the source file name.
4120
4121 @item copyprop
4122 @opindex fdump-tree-copyprop
4123 Dump trees after copy propagation. The file name is made
4124 by appending @file{.copyprop} to the source file name.
4125
4126 @item store_copyprop
4127 @opindex fdump-tree-store_copyprop
4128 Dump trees after store copy-propagation. The file name is made
4129 by appending @file{.store_copyprop} to the source file name.
4130
4131 @item dce
4132 @opindex fdump-tree-dce
4133 Dump each function after dead code elimination. The file name is made by
4134 appending @file{.dce} to the source file name.
4135
4136 @item mudflap
4137 @opindex fdump-tree-mudflap
4138 Dump each function after adding mudflap instrumentation. The file name is
4139 made by appending @file{.mudflap} to the source file name.
4140
4141 @item sra
4142 @opindex fdump-tree-sra
4143 Dump each function after performing scalar replacement of aggregates. The
4144 file name is made by appending @file{.sra} to the source file name.
4145
4146 @item sink
4147 @opindex fdump-tree-sink
4148 Dump each function after performing code sinking. The file name is made
4149 by appending @file{.sink} to the source file name.
4150
4151 @item dom
4152 @opindex fdump-tree-dom
4153 Dump each function after applying dominator tree optimizations. The file
4154 name is made by appending @file{.dom} to the source file name.
4155
4156 @item dse
4157 @opindex fdump-tree-dse
4158 Dump each function after applying dead store elimination. The file
4159 name is made by appending @file{.dse} to the source file name.
4160
4161 @item phiopt
4162 @opindex fdump-tree-phiopt
4163 Dump each function after optimizing PHI nodes into straightline code. The file
4164 name is made by appending @file{.phiopt} to the source file name.
4165
4166 @item forwprop
4167 @opindex fdump-tree-forwprop
4168 Dump each function after forward propagating single use variables. The file
4169 name is made by appending @file{.forwprop} to the source file name.
4170
4171 @item copyrename
4172 @opindex fdump-tree-copyrename
4173 Dump each function after applying the copy rename optimization. The file
4174 name is made by appending @file{.copyrename} to the source file name.
4175
4176 @item nrv
4177 @opindex fdump-tree-nrv
4178 Dump each function after applying the named return value optimization on
4179 generic trees. The file name is made by appending @file{.nrv} to the source
4180 file name.
4181
4182 @item vect
4183 @opindex fdump-tree-vect
4184 Dump each function after applying vectorization of loops. The file name is
4185 made by appending @file{.vect} to the source file name.
4186
4187 @item vrp
4188 @opindex fdump-tree-vrp
4189 Dump each function after Value Range Propagation (VRP). The file name
4190 is made by appending @file{.vrp} to the source file name.
4191
4192 @item all
4193 @opindex fdump-tree-all
4194 Enable all the available tree dumps with the flags provided in this option.
4195 @end table
4196
4197 @item -ftree-vectorizer-verbose=@var{n}
4198 @opindex ftree-vectorizer-verbose
4199 This option controls the amount of debugging output the vectorizer prints.
4200 This information is written to standard error, unless @option{-fdump-tree-all}
4201 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4202 usual dump listing file, @file{.vect}.
4203
4204 @item -frandom-seed=@var{string}
4205 @opindex frandom-string
4206 This option provides a seed that GCC uses when it would otherwise use
4207 random numbers. It is used to generate certain symbol names
4208 that have to be different in every compiled file. It is also used to
4209 place unique stamps in coverage data files and the object files that
4210 produce them. You can use the @option{-frandom-seed} option to produce
4211 reproducibly identical object files.
4212
4213 The @var{string} should be different for every file you compile.
4214
4215 @item -fsched-verbose=@var{n}
4216 @opindex fsched-verbose
4217 On targets that use instruction scheduling, this option controls the
4218 amount of debugging output the scheduler prints. This information is
4219 written to standard error, unless @option{-dS} or @option{-dR} is
4220 specified, in which case it is output to the usual dump
4221 listing file, @file{.sched} or @file{.sched2} respectively. However
4222 for @var{n} greater than nine, the output is always printed to standard
4223 error.
4224
4225 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4226 same information as @option{-dRS}. For @var{n} greater than one, it
4227 also output basic block probabilities, detailed ready list information
4228 and unit/insn info. For @var{n} greater than two, it includes RTL
4229 at abort point, control-flow and regions info. And for @var{n} over
4230 four, @option{-fsched-verbose} also includes dependence info.
4231
4232 @item -save-temps
4233 @opindex save-temps
4234 Store the usual ``temporary'' intermediate files permanently; place them
4235 in the current directory and name them based on the source file. Thus,
4236 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4237 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4238 preprocessed @file{foo.i} output file even though the compiler now
4239 normally uses an integrated preprocessor.
4240
4241 When used in combination with the @option{-x} command line option,
4242 @option{-save-temps} is sensible enough to avoid over writing an
4243 input source file with the same extension as an intermediate file.
4244 The corresponding intermediate file may be obtained by renaming the
4245 source file before using @option{-save-temps}.
4246
4247 @item -time
4248 @opindex time
4249 Report the CPU time taken by each subprocess in the compilation
4250 sequence. For C source files, this is the compiler proper and assembler
4251 (plus the linker if linking is done). The output looks like this:
4252
4253 @smallexample
4254 # cc1 0.12 0.01
4255 # as 0.00 0.01
4256 @end smallexample
4257
4258 The first number on each line is the ``user time'', that is time spent
4259 executing the program itself. The second number is ``system time'',
4260 time spent executing operating system routines on behalf of the program.
4261 Both numbers are in seconds.
4262
4263 @item -fvar-tracking
4264 @opindex fvar-tracking
4265 Run variable tracking pass. It computes where variables are stored at each
4266 position in code. Better debugging information is then generated
4267 (if the debugging information format supports this information).
4268
4269 It is enabled by default when compiling with optimization (@option{-Os},
4270 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4271 the debug info format supports it.
4272
4273 @item -print-file-name=@var{library}
4274 @opindex print-file-name
4275 Print the full absolute name of the library file @var{library} that
4276 would be used when linking---and don't do anything else. With this
4277 option, GCC does not compile or link anything; it just prints the
4278 file name.
4279
4280 @item -print-multi-directory
4281 @opindex print-multi-directory
4282 Print the directory name corresponding to the multilib selected by any
4283 other switches present in the command line. This directory is supposed
4284 to exist in @env{GCC_EXEC_PREFIX}.
4285
4286 @item -print-multi-lib
4287 @opindex print-multi-lib
4288 Print the mapping from multilib directory names to compiler switches
4289 that enable them. The directory name is separated from the switches by
4290 @samp{;}, and each switch starts with an @samp{@@} instead of the
4291 @samp{-}, without spaces between multiple switches. This is supposed to
4292 ease shell-processing.
4293
4294 @item -print-prog-name=@var{program}
4295 @opindex print-prog-name
4296 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4297
4298 @item -print-libgcc-file-name
4299 @opindex print-libgcc-file-name
4300 Same as @option{-print-file-name=libgcc.a}.
4301
4302 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4303 but you do want to link with @file{libgcc.a}. You can do
4304
4305 @smallexample
4306 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4307 @end smallexample
4308
4309 @item -print-search-dirs
4310 @opindex print-search-dirs
4311 Print the name of the configured installation directory and a list of
4312 program and library directories @command{gcc} will search---and don't do anything else.
4313
4314 This is useful when @command{gcc} prints the error message
4315 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4316 To resolve this you either need to put @file{cpp0} and the other compiler
4317 components where @command{gcc} expects to find them, or you can set the environment
4318 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4319 Don't forget the trailing @samp{/}.
4320 @xref{Environment Variables}.
4321
4322 @item -dumpmachine
4323 @opindex dumpmachine
4324 Print the compiler's target machine (for example,
4325 @samp{i686-pc-linux-gnu})---and don't do anything else.
4326
4327 @item -dumpversion
4328 @opindex dumpversion
4329 Print the compiler version (for example, @samp{3.0})---and don't do
4330 anything else.
4331
4332 @item -dumpspecs
4333 @opindex dumpspecs
4334 Print the compiler's built-in specs---and don't do anything else. (This
4335 is used when GCC itself is being built.) @xref{Spec Files}.
4336
4337 @item -feliminate-unused-debug-types
4338 @opindex feliminate-unused-debug-types
4339 Normally, when producing DWARF2 output, GCC will emit debugging
4340 information for all types declared in a compilation
4341 unit, regardless of whether or not they are actually used
4342 in that compilation unit. Sometimes this is useful, such as
4343 if, in the debugger, you want to cast a value to a type that is
4344 not actually used in your program (but is declared). More often,
4345 however, this results in a significant amount of wasted space.
4346 With this option, GCC will avoid producing debug symbol output
4347 for types that are nowhere used in the source file being compiled.
4348 @end table
4349
4350 @node Optimize Options
4351 @section Options That Control Optimization
4352 @cindex optimize options
4353 @cindex options, optimization
4354
4355 These options control various sorts of optimizations.
4356
4357 Without any optimization option, the compiler's goal is to reduce the
4358 cost of compilation and to make debugging produce the expected
4359 results. Statements are independent: if you stop the program with a
4360 breakpoint between statements, you can then assign a new value to any
4361 variable or change the program counter to any other statement in the
4362 function and get exactly the results you would expect from the source
4363 code.
4364
4365 Turning on optimization flags makes the compiler attempt to improve
4366 the performance and/or code size at the expense of compilation time
4367 and possibly the ability to debug the program.
4368
4369 The compiler performs optimization based on the knowledge it has of
4370 the program. Optimization levels @option{-O2} and above, in
4371 particular, enable @emph{unit-at-a-time} mode, which allows the
4372 compiler to consider information gained from later functions in
4373 the file when compiling a function. Compiling multiple files at
4374 once to a single output file in @emph{unit-at-a-time} mode allows
4375 the compiler to use information gained from all of the files when
4376 compiling each of them.
4377
4378 Not all optimizations are controlled directly by a flag. Only
4379 optimizations that have a flag are listed.
4380
4381 @table @gcctabopt
4382 @item -O
4383 @itemx -O1
4384 @opindex O
4385 @opindex O1
4386 Optimize. Optimizing compilation takes somewhat more time, and a lot
4387 more memory for a large function.
4388
4389 With @option{-O}, the compiler tries to reduce code size and execution
4390 time, without performing any optimizations that take a great deal of
4391 compilation time.
4392
4393 @option{-O} turns on the following optimization flags:
4394 @gccoptlist{-fdefer-pop @gol
4395 -fdelayed-branch @gol
4396 -fguess-branch-probability @gol
4397 -fcprop-registers @gol
4398 -floop-optimize @gol
4399 -fif-conversion @gol
4400 -fif-conversion2 @gol
4401 -ftree-ccp @gol
4402 -ftree-dce @gol
4403 -ftree-dominator-opts @gol
4404 -ftree-dse @gol
4405 -ftree-ter @gol
4406 -ftree-lrs @gol
4407 -ftree-sra @gol
4408 -ftree-copyrename @gol
4409 -ftree-fre @gol
4410 -ftree-ch @gol
4411 -fmerge-constants}
4412
4413 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4414 where doing so does not interfere with debugging.
4415
4416 @item -O2
4417 @opindex O2
4418 Optimize even more. GCC performs nearly all supported optimizations
4419 that do not involve a space-speed tradeoff. The compiler does not
4420 perform loop unrolling or function inlining when you specify @option{-O2}.
4421 As compared to @option{-O}, this option increases both compilation time
4422 and the performance of the generated code.
4423
4424 @option{-O2} turns on all optimization flags specified by @option{-O}. It
4425 also turns on the following optimization flags:
4426 @gccoptlist{-fthread-jumps @gol
4427 -fcrossjumping @gol
4428 -foptimize-sibling-calls @gol
4429 -fcse-follow-jumps -fcse-skip-blocks @gol
4430 -fgcse -fgcse-lm @gol
4431 -fexpensive-optimizations @gol
4432 -fstrength-reduce @gol
4433 -frerun-cse-after-loop -frerun-loop-opt @gol
4434 -fcaller-saves @gol
4435 -fpeephole2 @gol
4436 -fschedule-insns -fschedule-insns2 @gol
4437 -fsched-interblock -fsched-spec @gol
4438 -fregmove @gol
4439 -fstrict-aliasing @gol
4440 -fdelete-null-pointer-checks @gol
4441 -freorder-blocks -freorder-functions @gol
4442 -funit-at-a-time @gol
4443 -falign-functions -falign-jumps @gol
4444 -falign-loops -falign-labels @gol
4445 -ftree-vrp @gol
4446 -ftree-pre}
4447
4448 Please note the warning under @option{-fgcse} about
4449 invoking @option{-O2} on programs that use computed gotos.
4450
4451 @item -O3
4452 @opindex O3
4453 Optimize yet more. @option{-O3} turns on all optimizations specified by
4454 @option{-O2} and also turns on the @option{-finline-functions},
4455 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4456
4457 @item -O0
4458 @opindex O0
4459 Do not optimize. This is the default.
4460
4461 @item -Os
4462 @opindex Os
4463 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
4464 do not typically increase code size. It also performs further
4465 optimizations designed to reduce code size.
4466
4467 @option{-Os} disables the following optimization flags:
4468 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
4469 -falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
4470 -fprefetch-loop-arrays -ftree-vect-loop-version}
4471
4472 If you use multiple @option{-O} options, with or without level numbers,
4473 the last such option is the one that is effective.
4474 @end table
4475
4476 Options of the form @option{-f@var{flag}} specify machine-independent
4477 flags. Most flags have both positive and negative forms; the negative
4478 form of @option{-ffoo} would be @option{-fno-foo}. In the table
4479 below, only one of the forms is listed---the one you typically will
4480 use. You can figure out the other form by either removing @samp{no-}
4481 or adding it.
4482
4483 The following options control specific optimizations. They are either
4484 activated by @option{-O} options or are related to ones that are. You
4485 can use the following flags in the rare cases when ``fine-tuning'' of
4486 optimizations to be performed is desired.
4487
4488 @table @gcctabopt
4489 @item -fno-default-inline
4490 @opindex fno-default-inline
4491 Do not make member functions inline by default merely because they are
4492 defined inside the class scope (C++ only). Otherwise, when you specify
4493 @w{@option{-O}}, member functions defined inside class scope are compiled
4494 inline by default; i.e., you don't need to add @samp{inline} in front of
4495 the member function name.
4496
4497 @item -fno-defer-pop
4498 @opindex fno-defer-pop
4499 Always pop the arguments to each function call as soon as that function
4500 returns. For machines which must pop arguments after a function call,
4501 the compiler normally lets arguments accumulate on the stack for several
4502 function calls and pops them all at once.
4503
4504 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4505
4506 @item -fforce-mem
4507 @opindex fforce-mem
4508 Force memory operands to be copied into registers before doing
4509 arithmetic on them. This produces better code by making all memory
4510 references potential common subexpressions. When they are not common
4511 subexpressions, instruction combination should eliminate the separate
4512 register-load. This option is now a nop and will be removed in 4.2.
4513
4514 @item -fforce-addr
4515 @opindex fforce-addr
4516 Force memory address constants to be copied into registers before
4517 doing arithmetic on them.
4518
4519 @item -fomit-frame-pointer
4520 @opindex fomit-frame-pointer
4521 Don't keep the frame pointer in a register for functions that
4522 don't need one. This avoids the instructions to save, set up and
4523 restore frame pointers; it also makes an extra register available
4524 in many functions. @strong{It also makes debugging impossible on
4525 some machines.}
4526
4527 On some machines, such as the VAX, this flag has no effect, because
4528 the standard calling sequence automatically handles the frame pointer
4529 and nothing is saved by pretending it doesn't exist. The
4530 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4531 whether a target machine supports this flag. @xref{Registers,,Register
4532 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4533
4534 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4535
4536 @item -foptimize-sibling-calls
4537 @opindex foptimize-sibling-calls
4538 Optimize sibling and tail recursive calls.
4539
4540 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4541
4542 @item -fno-inline
4543 @opindex fno-inline
4544 Don't pay attention to the @code{inline} keyword. Normally this option
4545 is used to keep the compiler from expanding any functions inline.
4546 Note that if you are not optimizing, no functions can be expanded inline.
4547
4548 @item -finline-functions
4549 @opindex finline-functions
4550 Integrate all simple functions into their callers. The compiler
4551 heuristically decides which functions are simple enough to be worth
4552 integrating in this way.
4553
4554 If all calls to a given function are integrated, and the function is
4555 declared @code{static}, then the function is normally not output as
4556 assembler code in its own right.
4557
4558 Enabled at level @option{-O3}.
4559
4560 @item -finline-functions-called-once
4561 @opindex finline-functions-called-once
4562 Consider all @code{static} functions called once for inlining into their
4563 caller even if they are not marked @code{inline}. If a call to a given
4564 function is integrated, then the function is not output as assembler code
4565 in its own right.
4566
4567 Enabled if @option{-funit-at-a-time} is enabled.
4568
4569 @item -fearly-inlining
4570 @opindex fearly-inlining
4571 Inline functions marked by @code{always_inline} and functions whose body seems
4572 smaller than the function call overhead early before doing
4573 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
4574 makes profiling significantly cheaper and usually inlining faster on programs
4575 having large chains of nested wrapper functions.
4576
4577 Enabled by default.
4578
4579 @item -finline-limit=@var{n}
4580 @opindex finline-limit
4581 By default, GCC limits the size of functions that can be inlined. This flag
4582 allows the control of this limit for functions that are explicitly marked as
4583 inline (i.e., marked with the inline keyword or defined within the class
4584 definition in c++). @var{n} is the size of functions that can be inlined in
4585 number of pseudo instructions (not counting parameter handling). The default
4586 value of @var{n} is 600.
4587 Increasing this value can result in more inlined code at
4588 the cost of compilation time and memory consumption. Decreasing usually makes
4589 the compilation faster and less code will be inlined (which presumably
4590 means slower programs). This option is particularly useful for programs that
4591 use inlining heavily such as those based on recursive templates with C++.
4592
4593 Inlining is actually controlled by a number of parameters, which may be
4594 specified individually by using @option{--param @var{name}=@var{value}}.
4595 The @option{-finline-limit=@var{n}} option sets some of these parameters
4596 as follows:
4597
4598 @table @gcctabopt
4599 @item max-inline-insns-single
4600 is set to @var{n}/2.
4601 @item max-inline-insns-auto
4602 is set to @var{n}/2.
4603 @item min-inline-insns
4604 is set to 130 or @var{n}/4, whichever is smaller.
4605 @item max-inline-insns-rtl
4606 is set to @var{n}.
4607 @end table
4608
4609 See below for a documentation of the individual
4610 parameters controlling inlining.
4611
4612 @emph{Note:} pseudo instruction represents, in this particular context, an
4613 abstract measurement of function's size. In no way does it represent a count
4614 of assembly instructions and as such its exact meaning might change from one
4615 release to an another.
4616
4617 @item -fkeep-inline-functions
4618 @opindex fkeep-inline-functions
4619 In C, emit @code{static} functions that are declared @code{inline}
4620 into the object file, even if the function has been inlined into all
4621 of its callers. This switch does not affect functions using the
4622 @code{extern inline} extension in GNU C@. In C++, emit any and all
4623 inline functions into the object file.
4624
4625 @item -fkeep-static-consts
4626 @opindex fkeep-static-consts
4627 Emit variables declared @code{static const} when optimization isn't turned
4628 on, even if the variables aren't referenced.
4629
4630 GCC enables this option by default. If you want to force the compiler to
4631 check if the variable was referenced, regardless of whether or not
4632 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4633
4634 @item -fmerge-constants
4635 Attempt to merge identical constants (string constants and floating point
4636 constants) across compilation units.
4637
4638 This option is the default for optimized compilation if the assembler and
4639 linker support it. Use @option{-fno-merge-constants} to inhibit this
4640 behavior.
4641
4642 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4643
4644 @item -fmerge-all-constants
4645 Attempt to merge identical constants and identical variables.
4646
4647 This option implies @option{-fmerge-constants}. In addition to
4648 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4649 arrays or initialized constant variables with integral or floating point
4650 types. Languages like C or C++ require each non-automatic variable to
4651 have distinct location, so using this option will result in non-conforming
4652 behavior.
4653
4654 @item -fmodulo-sched
4655 @opindex fmodulo-sched
4656 Perform swing modulo scheduling immediately before the first scheduling
4657 pass. This pass looks at innermost loops and reorders their
4658 instructions by overlapping different iterations.
4659
4660 @item -fno-branch-count-reg
4661 @opindex fno-branch-count-reg
4662 Do not use ``decrement and branch'' instructions on a count register,
4663 but instead generate a sequence of instructions that decrement a
4664 register, compare it against zero, then branch based upon the result.
4665 This option is only meaningful on architectures that support such
4666 instructions, which include x86, PowerPC, IA-64 and S/390.
4667
4668 The default is @option{-fbranch-count-reg}, enabled when
4669 @option{-fstrength-reduce} is enabled.
4670
4671 @item -fno-function-cse
4672 @opindex fno-function-cse
4673 Do not put function addresses in registers; make each instruction that
4674 calls a constant function contain the function's address explicitly.
4675
4676 This option results in less efficient code, but some strange hacks
4677 that alter the assembler output may be confused by the optimizations
4678 performed when this option is not used.
4679
4680 The default is @option{-ffunction-cse}
4681
4682 @item -fno-zero-initialized-in-bss
4683 @opindex fno-zero-initialized-in-bss
4684 If the target supports a BSS section, GCC by default puts variables that
4685 are initialized to zero into BSS@. This can save space in the resulting
4686 code.
4687
4688 This option turns off this behavior because some programs explicitly
4689 rely on variables going to the data section. E.g., so that the
4690 resulting executable can find the beginning of that section and/or make
4691 assumptions based on that.
4692
4693 The default is @option{-fzero-initialized-in-bss}.
4694
4695 @item -fbounds-check
4696 @opindex fbounds-check
4697 For front-ends that support it, generate additional code to check that
4698 indices used to access arrays are within the declared range. This is
4699 currently only supported by the Java and Fortran front-ends, where
4700 this option defaults to true and false respectively.
4701
4702 @item -fmudflap -fmudflapth -fmudflapir
4703 @opindex fmudflap
4704 @opindex fmudflapth
4705 @opindex fmudflapir
4706 @cindex bounds checking
4707 @cindex mudflap
4708 For front-ends that support it (C and C++), instrument all risky
4709 pointer/array dereferencing operations, some standard library
4710 string/heap functions, and some other associated constructs with
4711 range/validity tests. Modules so instrumented should be immune to
4712 buffer overflows, invalid heap use, and some other classes of C/C++
4713 programming errors. The instrumentation relies on a separate runtime
4714 library (@file{libmudflap}), which will be linked into a program if
4715 @option{-fmudflap} is given at link time. Run-time behavior of the
4716 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4717 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4718 for its options.
4719
4720 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4721 link if your program is multi-threaded. Use @option{-fmudflapir}, in
4722 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4723 instrumentation should ignore pointer reads. This produces less
4724 instrumentation (and therefore faster execution) and still provides
4725 some protection against outright memory corrupting writes, but allows
4726 erroneously read data to propagate within a program.
4727
4728 @item -fopenmp
4729 @opindex fopenmp
4730 @cindex openmp parallel
4731 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
4732 @code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
4733 compiler generates parallel code according to the OpenMP Application
4734 Program Interface v2.5. To generate the final exectuable, the runtime
4735 library @code{libgomp} must be linked in using @option{-lgomp}.
4736
4737 @item -fstrength-reduce
4738 @opindex fstrength-reduce
4739 Perform the optimizations of loop strength reduction and
4740 elimination of iteration variables.
4741
4742 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4743
4744 @item -fthread-jumps
4745 @opindex fthread-jumps
4746 Perform optimizations where we check to see if a jump branches to a
4747 location where another comparison subsumed by the first is found. If
4748 so, the first branch is redirected to either the destination of the
4749 second branch or a point immediately following it, depending on whether
4750 the condition is known to be true or false.
4751
4752 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4753
4754 @item -fcse-follow-jumps
4755 @opindex fcse-follow-jumps
4756 In common subexpression elimination, scan through jump instructions
4757 when the target of the jump is not reached by any other path. For
4758 example, when CSE encounters an @code{if} statement with an
4759 @code{else} clause, CSE will follow the jump when the condition
4760 tested is false.
4761
4762 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4763
4764 @item -fcse-skip-blocks
4765 @opindex fcse-skip-blocks
4766 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4767 follow jumps which conditionally skip over blocks. When CSE
4768 encounters a simple @code{if} statement with no else clause,
4769 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4770 body of the @code{if}.
4771
4772 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4773
4774 @item -frerun-cse-after-loop
4775 @opindex frerun-cse-after-loop
4776 Re-run common subexpression elimination after loop optimizations has been
4777 performed.
4778
4779 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4780
4781 @item -frerun-loop-opt
4782 @opindex frerun-loop-opt
4783 Run the loop optimizer twice.
4784
4785 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4786
4787 @item -fgcse
4788 @opindex fgcse
4789 Perform a global common subexpression elimination pass.
4790 This pass also performs global constant and copy propagation.
4791
4792 @emph{Note:} When compiling a program using computed gotos, a GCC
4793 extension, you may get better runtime performance if you disable
4794 the global common subexpression elimination pass by adding
4795 @option{-fno-gcse} to the command line.
4796
4797 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4798
4799 @item -fgcse-lm
4800 @opindex fgcse-lm
4801 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4802 attempt to move loads which are only killed by stores into themselves. This
4803 allows a loop containing a load/store sequence to be changed to a load outside
4804 the loop, and a copy/store within the loop.
4805
4806 Enabled by default when gcse is enabled.
4807
4808 @item -fgcse-sm
4809 @opindex fgcse-sm
4810 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4811 global common subexpression elimination. This pass will attempt to move
4812 stores out of loops. When used in conjunction with @option{-fgcse-lm},
4813 loops containing a load/store sequence can be changed to a load before
4814 the loop and a store after the loop.
4815
4816 Not enabled at any optimization level.
4817
4818 @item -fgcse-las
4819 @opindex fgcse-las
4820 When @option{-fgcse-las} is enabled, the global common subexpression
4821 elimination pass eliminates redundant loads that come after stores to the
4822 same memory location (both partial and full redundancies).
4823
4824 Not enabled at any optimization level.
4825
4826 @item -fgcse-after-reload
4827 @opindex fgcse-after-reload
4828 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4829 pass is performed after reload. The purpose of this pass is to cleanup
4830 redundant spilling.
4831
4832 @item -floop-optimize
4833 @opindex floop-optimize
4834 Perform loop optimizations: move constant expressions out of loops, simplify
4835 exit test conditions and optionally do strength-reduction as well.
4836
4837 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4838
4839 @item -funsafe-loop-optimizations
4840 @opindex funsafe-loop-optimizations
4841 If given, the loop optimizer will assume that loop indices do not
4842 overflow, and that the loops with nontrivial exit condition are not
4843 infinite. This enables a wider range of loop optimizations even if
4844 the loop optimizer itself cannot prove that these assumptions are valid.
4845 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4846 if it finds this kind of loop.
4847
4848 @item -fcrossjumping
4849 @opindex crossjumping
4850 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4851 resulting code may or may not perform better than without cross-jumping.
4852
4853 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4854
4855 @item -fif-conversion
4856 @opindex if-conversion
4857 Attempt to transform conditional jumps into branch-less equivalents. This
4858 include use of conditional moves, min, max, set flags and abs instructions, and
4859 some tricks doable by standard arithmetics. The use of conditional execution
4860 on chips where it is available is controlled by @code{if-conversion2}.
4861
4862 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4863
4864 @item -fif-conversion2
4865 @opindex if-conversion2
4866 Use conditional execution (where available) to transform conditional jumps into
4867 branch-less equivalents.
4868
4869 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4870
4871 @item -fdelete-null-pointer-checks
4872 @opindex fdelete-null-pointer-checks
4873 Use global dataflow analysis to identify and eliminate useless checks
4874 for null pointers. The compiler assumes that dereferencing a null
4875 pointer would have halted the program. If a pointer is checked after
4876 it has already been dereferenced, it cannot be null.
4877
4878 In some environments, this assumption is not true, and programs can
4879 safely dereference null pointers. Use
4880 @option{-fno-delete-null-pointer-checks} to disable this optimization
4881 for programs which depend on that behavior.
4882
4883 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4884
4885 @item -fexpensive-optimizations
4886 @opindex fexpensive-optimizations
4887 Perform a number of minor optimizations that are relatively expensive.
4888
4889 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4890
4891 @item -foptimize-register-move
4892 @itemx -fregmove
4893 @opindex foptimize-register-move
4894 @opindex fregmove
4895 Attempt to reassign register numbers in move instructions and as
4896 operands of other simple instructions in order to maximize the amount of
4897 register tying. This is especially helpful on machines with two-operand
4898 instructions.
4899
4900 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4901 optimization.
4902
4903 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4904
4905 @item -fdelayed-branch
4906 @opindex fdelayed-branch
4907 If supported for the target machine, attempt to reorder instructions
4908 to exploit instruction slots available after delayed branch
4909 instructions.
4910
4911 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4912
4913 @item -fschedule-insns
4914 @opindex fschedule-insns
4915 If supported for the target machine, attempt to reorder instructions to
4916 eliminate execution stalls due to required data being unavailable. This
4917 helps machines that have slow floating point or memory load instructions
4918 by allowing other instructions to be issued until the result of the load
4919 or floating point instruction is required.
4920
4921 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4922
4923 @item -fschedule-insns2
4924 @opindex fschedule-insns2
4925 Similar to @option{-fschedule-insns}, but requests an additional pass of
4926 instruction scheduling after register allocation has been done. This is
4927 especially useful on machines with a relatively small number of
4928 registers and where memory load instructions take more than one cycle.
4929
4930 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4931
4932 @item -fno-sched-interblock
4933 @opindex fno-sched-interblock
4934 Don't schedule instructions across basic blocks. This is normally
4935 enabled by default when scheduling before register allocation, i.e.@:
4936 with @option{-fschedule-insns} or at @option{-O2} or higher.
4937
4938 @item -fno-sched-spec
4939 @opindex fno-sched-spec
4940 Don't allow speculative motion of non-load instructions. This is normally
4941 enabled by default when scheduling before register allocation, i.e.@:
4942 with @option{-fschedule-insns} or at @option{-O2} or higher.
4943
4944 @item -fsched-spec-load
4945 @opindex fsched-spec-load
4946 Allow speculative motion of some load instructions. This only makes
4947 sense when scheduling before register allocation, i.e.@: with
4948 @option{-fschedule-insns} or at @option{-O2} or higher.
4949
4950 @item -fsched-spec-load-dangerous
4951 @opindex fsched-spec-load-dangerous
4952 Allow speculative motion of more load instructions. This only makes
4953 sense when scheduling before register allocation, i.e.@: with
4954 @option{-fschedule-insns} or at @option{-O2} or higher.
4955
4956 @item -fsched-stalled-insns=@var{n}
4957 @opindex fsched-stalled-insns
4958 Define how many insns (if any) can be moved prematurely from the queue
4959 of stalled insns into the ready list, during the second scheduling pass.
4960
4961 @item -fsched-stalled-insns-dep=@var{n}
4962 @opindex fsched-stalled-insns-dep
4963 Define how many insn groups (cycles) will be examined for a dependency
4964 on a stalled insn that is candidate for premature removal from the queue
4965 of stalled insns. Has an effect only during the second scheduling pass,
4966 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4967
4968 @item -fsched2-use-superblocks
4969 @opindex fsched2-use-superblocks
4970 When scheduling after register allocation, do use superblock scheduling
4971 algorithm. Superblock scheduling allows motion across basic block boundaries
4972 resulting on faster schedules. This option is experimental, as not all machine
4973 descriptions used by GCC model the CPU closely enough to avoid unreliable
4974 results from the algorithm.
4975
4976 This only makes sense when scheduling after register allocation, i.e.@: with
4977 @option{-fschedule-insns2} or at @option{-O2} or higher.
4978
4979 @item -fsched2-use-traces
4980 @opindex fsched2-use-traces
4981 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4982 allocation and additionally perform code duplication in order to increase the
4983 size of superblocks using tracer pass. See @option{-ftracer} for details on
4984 trace formation.
4985
4986 This mode should produce faster but significantly longer programs. Also
4987 without @option{-fbranch-probabilities} the traces constructed may not
4988 match the reality and hurt the performance. This only makes
4989 sense when scheduling after register allocation, i.e.@: with
4990 @option{-fschedule-insns2} or at @option{-O2} or higher.
4991
4992 @item -freschedule-modulo-scheduled-loops
4993 @opindex fscheduling-in-modulo-scheduled-loops
4994 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4995 we may want to prevent the later scheduling passes from changing its schedule, we use this
4996 option to control that.
4997
4998 @item -fcaller-saves
4999 @opindex fcaller-saves
5000 Enable values to be allocated in registers that will be clobbered by
5001 function calls, by emitting extra instructions to save and restore the
5002 registers around such calls. Such allocation is done only when it
5003 seems to result in better code than would otherwise be produced.
5004
5005 This option is always enabled by default on certain machines, usually
5006 those which have no call-preserved registers to use instead.
5007
5008 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5009
5010 @item -ftree-pre
5011 Perform Partial Redundancy Elimination (PRE) on trees. This flag is
5012 enabled by default at @option{-O2} and @option{-O3}.
5013
5014 @item -ftree-fre
5015 Perform Full Redundancy Elimination (FRE) on trees. The difference
5016 between FRE and PRE is that FRE only considers expressions
5017 that are computed on all paths leading to the redundant computation.
5018 This analysis faster than PRE, though it exposes fewer redundancies.
5019 This flag is enabled by default at @option{-O} and higher.
5020
5021 @item -ftree-copy-prop
5022 Perform copy propagation on trees. This pass eliminates unnecessary
5023 copy operations. This flag is enabled by default at @option{-O} and
5024 higher.
5025
5026 @item -ftree-store-copy-prop
5027 Perform copy propagation of memory loads and stores. This pass
5028 eliminates unnecessary copy operations in memory references
5029 (structures, global variables, arrays, etc). This flag is enabled by
5030 default at @option{-O2} and higher.
5031
5032 @item -ftree-salias
5033 Perform structural alias analysis on trees. This flag
5034 is enabled by default at @option{-O} and higher.
5035
5036 @item -ftree-sink
5037 Perform forward store motion on trees. This flag is
5038 enabled by default at @option{-O} and higher.
5039
5040 @item -ftree-ccp
5041 Perform sparse conditional constant propagation (CCP) on trees. This
5042 pass only operates on local scalar variables and is enabled by default
5043 at @option{-O} and higher.
5044
5045 @item -ftree-store-ccp
5046 Perform sparse conditional constant propagation (CCP) on trees. This
5047 pass operates on both local scalar variables and memory stores and
5048 loads (global variables, structures, arrays, etc). This flag is
5049 enabled by default at @option{-O2} and higher.
5050
5051 @item -ftree-dce
5052 Perform dead code elimination (DCE) on trees. This flag is enabled by
5053 default at @option{-O} and higher.
5054
5055 @item -ftree-dominator-opts
5056 Perform a variety of simple scalar cleanups (constant/copy
5057 propagation, redundancy elimination, range propagation and expression
5058 simplification) based on a dominator tree traversal. This also
5059 performs jump threading (to reduce jumps to jumps). This flag is
5060 enabled by default at @option{-O} and higher.
5061
5062 @item -ftree-ch
5063 Perform loop header copying on trees. This is beneficial since it increases
5064 effectiveness of code motion optimizations. It also saves one jump. This flag
5065 is enabled by default at @option{-O} and higher. It is not enabled
5066 for @option{-Os}, since it usually increases code size.
5067
5068 @item -ftree-loop-optimize
5069 Perform loop optimizations on trees. This flag is enabled by default
5070 at @option{-O} and higher.
5071
5072 @item -ftree-loop-linear
5073 Perform linear loop transformations on tree. This flag can improve cache
5074 performance and allow further loop optimizations to take place.
5075
5076 @item -ftree-loop-im
5077 Perform loop invariant motion on trees. This pass moves only invariants that
5078 would be hard to handle at RTL level (function calls, operations that expand to
5079 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
5080 operands of conditions that are invariant out of the loop, so that we can use
5081 just trivial invariantness analysis in loop unswitching. The pass also includes
5082 store motion.
5083
5084 @item -ftree-loop-ivcanon
5085 Create a canonical counter for number of iterations in the loop for that
5086 determining number of iterations requires complicated analysis. Later
5087 optimizations then may determine the number easily. Useful especially
5088 in connection with unrolling.
5089
5090 @item -fivopts
5091 Perform induction variable optimizations (strength reduction, induction
5092 variable merging and induction variable elimination) on trees.
5093
5094 @item -ftree-sra
5095 Perform scalar replacement of aggregates. This pass replaces structure
5096 references with scalars to prevent committing structures to memory too
5097 early. This flag is enabled by default at @option{-O} and higher.
5098
5099 @item -ftree-copyrename
5100 Perform copy renaming on trees. This pass attempts to rename compiler
5101 temporaries to other variables at copy locations, usually resulting in
5102 variable names which more closely resemble the original variables. This flag
5103 is enabled by default at @option{-O} and higher.
5104
5105 @item -ftree-ter
5106 Perform temporary expression replacement during the SSA->normal phase. Single
5107 use/single def temporaries are replaced at their use location with their
5108 defining expression. This results in non-GIMPLE code, but gives the expanders
5109 much more complex trees to work on resulting in better RTL generation. This is
5110 enabled by default at @option{-O} and higher.
5111
5112 @item -ftree-lrs
5113 Perform live range splitting during the SSA->normal phase. Distinct live
5114 ranges of a variable are split into unique variables, allowing for better
5115 optimization later. This is enabled by default at @option{-O} and higher.
5116
5117 @item -ftree-vectorize
5118 Perform loop vectorization on trees.
5119
5120 @item -ftree-vect-loop-version
5121 @opindex ftree-vect-loop-version
5122 Perform loop versioning when doing loop vectorization on trees. When a loop
5123 appears to be vectorizable except that data alignment or data dependence cannot
5124 be determined at compile time then vectorized and non-vectorized versions of
5125 the loop are generated along with runtime checks for alignment or dependence
5126 to control which version is executed. This option is enabled by default
5127 except at level @option{-Os} where it is disabled.
5128
5129 @item -ftree-vrp
5130 Perform Value Range Propagation on trees. This is similar to the
5131 constant propagation pass, but instead of values, ranges of values are
5132 propagated. This allows the optimizers to remove unnecessary range
5133 checks like array bound checks and null pointer checks. This is
5134 enabled by default at @option{-O2} and higher. Null pointer check
5135 elimination is only done if @option{-fdelete-null-pointer-checks} is
5136 enabled.
5137
5138 @item -ftracer
5139 @opindex ftracer
5140 Perform tail duplication to enlarge superblock size. This transformation
5141 simplifies the control flow of the function allowing other optimizations to do
5142 better job.
5143
5144 @item -funroll-loops
5145 @opindex funroll-loops
5146 Unroll loops whose number of iterations can be determined at compile
5147 time or upon entry to the loop. @option{-funroll-loops} implies both
5148 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
5149 option makes code larger, and may or may not make it run faster.
5150
5151 @item -funroll-all-loops
5152 @opindex funroll-all-loops
5153 Unroll all loops, even if their number of iterations is uncertain when
5154 the loop is entered. This usually makes programs run more slowly.
5155 @option{-funroll-all-loops} implies the same options as
5156 @option{-funroll-loops},
5157
5158 @item -fsplit-ivs-in-unroller
5159 @opindex -fsplit-ivs-in-unroller
5160 Enables expressing of values of induction variables in later iterations
5161 of the unrolled loop using the value in the first iteration. This breaks
5162 long dependency chains, thus improving efficiency of the scheduling passes.
5163
5164 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5165 same effect. However in cases the loop body is more complicated than
5166 a single basic block, this is not reliable. It also does not work at all
5167 on some of the architectures due to restrictions in the CSE pass.
5168
5169 This optimization is enabled by default.
5170
5171 @item -fvariable-expansion-in-unroller
5172 @opindex -fvariable-expansion-in-unroller
5173 With this option, the compiler will create multiple copies of some
5174 local variables when unrolling a loop which can result in superior code.
5175
5176 @item -fprefetch-loop-arrays
5177 @itemx -fprefetch-loop-arrays-rtl
5178 @opindex fprefetch-loop-arrays
5179 @opindex fprefetch-loop-arrays-rtl
5180 If supported by the target machine, generate instructions to prefetch
5181 memory to improve the performance of loops that access large arrays.
5182
5183 These options may generate better or worse code; results are highly
5184 dependent on the structure of loops within the source code.
5185
5186 @item -fno-peephole
5187 @itemx -fno-peephole2
5188 @opindex fno-peephole
5189 @opindex fno-peephole2
5190 Disable any machine-specific peephole optimizations. The difference
5191 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5192 are implemented in the compiler; some targets use one, some use the
5193 other, a few use both.
5194
5195 @option{-fpeephole} is enabled by default.
5196 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5197
5198 @item -fno-guess-branch-probability
5199 @opindex fno-guess-branch-probability
5200 Do not guess branch probabilities using heuristics.
5201
5202 GCC will use heuristics to guess branch probabilities if they are
5203 not provided by profiling feedback (@option{-fprofile-arcs}). These
5204 heuristics are based on the control flow graph. If some branch probabilities
5205 are specified by @samp{__builtin_expect}, then the heuristics will be
5206 used to guess branch probabilities for the rest of the control flow graph,
5207 taking the @samp{__builtin_expect} info into account. The interactions
5208 between the heuristics and @samp{__builtin_expect} can be complex, and in
5209 some cases, it may be useful to disable the heuristics so that the effects
5210 of @samp{__builtin_expect} are easier to understand.
5211
5212 The default is @option{-fguess-branch-probability} at levels
5213 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5214
5215 @item -freorder-blocks
5216 @opindex freorder-blocks
5217 Reorder basic blocks in the compiled function in order to reduce number of
5218 taken branches and improve code locality.
5219
5220 Enabled at levels @option{-O2}, @option{-O3}.
5221
5222 @item -freorder-blocks-and-partition
5223 @opindex freorder-blocks-and-partition
5224 In addition to reordering basic blocks in the compiled function, in order
5225 to reduce number of taken branches, partitions hot and cold basic blocks
5226 into separate sections of the assembly and .o files, to improve
5227 paging and cache locality performance.
5228
5229 This optimization is automatically turned off in the presence of
5230 exception handling, for linkonce sections, for functions with a user-defined
5231 section attribute and on any architecture that does not support named
5232 sections.
5233
5234 @item -freorder-functions
5235 @opindex freorder-functions
5236 Reorder functions in the object file in order to
5237 improve code locality. This is implemented by using special
5238 subsections @code{.text.hot} for most frequently executed functions and
5239 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
5240 the linker so object file format must support named sections and linker must
5241 place them in a reasonable way.
5242
5243 Also profile feedback must be available in to make this option effective. See
5244 @option{-fprofile-arcs} for details.
5245
5246 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5247
5248 @item -fstrict-aliasing
5249 @opindex fstrict-aliasing
5250 Allows the compiler to assume the strictest aliasing rules applicable to
5251 the language being compiled. For C (and C++), this activates
5252 optimizations based on the type of expressions. In particular, an
5253 object of one type is assumed never to reside at the same address as an
5254 object of a different type, unless the types are almost the same. For
5255 example, an @code{unsigned int} can alias an @code{int}, but not a
5256 @code{void*} or a @code{double}. A character type may alias any other
5257 type.
5258
5259 Pay special attention to code like this:
5260 @smallexample
5261 union a_union @{
5262 int i;
5263 double d;
5264 @};
5265
5266 int f() @{
5267 a_union t;
5268 t.d = 3.0;
5269 return t.i;
5270 @}
5271 @end smallexample
5272 The practice of reading from a different union member than the one most
5273 recently written to (called ``type-punning'') is common. Even with
5274 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5275 is accessed through the union type. So, the code above will work as
5276 expected. However, this code might not:
5277 @smallexample
5278 int f() @{
5279 a_union t;
5280 int* ip;
5281 t.d = 3.0;
5282 ip = &t.i;
5283 return *ip;
5284 @}
5285 @end smallexample
5286
5287 Every language that wishes to perform language-specific alias analysis
5288 should define a function that computes, given an @code{tree}
5289 node, an alias set for the node. Nodes in different alias sets are not
5290 allowed to alias. For an example, see the C front-end function
5291 @code{c_get_alias_set}.
5292
5293 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5294
5295 @item -falign-functions
5296 @itemx -falign-functions=@var{n}
5297 @opindex falign-functions
5298 Align the start of functions to the next power-of-two greater than
5299 @var{n}, skipping up to @var{n} bytes. For instance,
5300 @option{-falign-functions=32} aligns functions to the next 32-byte
5301 boundary, but @option{-falign-functions=24} would align to the next
5302 32-byte boundary only if this can be done by skipping 23 bytes or less.
5303
5304 @option{-fno-align-functions} and @option{-falign-functions=1} are
5305 equivalent and mean that functions will not be aligned.
5306
5307 Some assemblers only support this flag when @var{n} is a power of two;
5308 in that case, it is rounded up.
5309
5310 If @var{n} is not specified or is zero, use a machine-dependent default.
5311
5312 Enabled at levels @option{-O2}, @option{-O3}.
5313
5314 @item -falign-labels
5315 @itemx -falign-labels=@var{n}
5316 @opindex falign-labels
5317 Align all branch targets to a power-of-two boundary, skipping up to
5318 @var{n} bytes like @option{-falign-functions}. This option can easily
5319 make code slower, because it must insert dummy operations for when the
5320 branch target is reached in the usual flow of the code.
5321
5322 @option{-fno-align-labels} and @option{-falign-labels=1} are
5323 equivalent and mean that labels will not be aligned.
5324
5325 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5326 are greater than this value, then their values are used instead.
5327
5328 If @var{n} is not specified or is zero, use a machine-dependent default
5329 which is very likely to be @samp{1}, meaning no alignment.
5330
5331 Enabled at levels @option{-O2}, @option{-O3}.
5332
5333 @item -falign-loops
5334 @itemx -falign-loops=@var{n}
5335 @opindex falign-loops
5336 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5337 like @option{-falign-functions}. The hope is that the loop will be
5338 executed many times, which will make up for any execution of the dummy
5339 operations.
5340
5341 @option{-fno-align-loops} and @option{-falign-loops=1} are
5342 equivalent and mean that loops will not be aligned.
5343
5344 If @var{n} is not specified or is zero, use a machine-dependent default.
5345
5346 Enabled at levels @option{-O2}, @option{-O3}.
5347
5348 @item -falign-jumps
5349 @itemx -falign-jumps=@var{n}
5350 @opindex falign-jumps
5351 Align branch targets to a power-of-two boundary, for branch targets
5352 where the targets can only be reached by jumping, skipping up to @var{n}
5353 bytes like @option{-falign-functions}. In this case, no dummy operations
5354 need be executed.
5355
5356 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5357 equivalent and mean that loops will not be aligned.
5358
5359 If @var{n} is not specified or is zero, use a machine-dependent default.
5360
5361 Enabled at levels @option{-O2}, @option{-O3}.
5362
5363 @item -funit-at-a-time
5364 @opindex funit-at-a-time
5365 Parse the whole compilation unit before starting to produce code.
5366 This allows some extra optimizations to take place but consumes
5367 more memory (in general). There are some compatibility issues
5368 with @emph{unit-at-a-time} mode:
5369 @itemize @bullet
5370 @item
5371 enabling @emph{unit-at-a-time} mode may change the order
5372 in which functions, variables, and top-level @code{asm} statements
5373 are emitted, and will likely break code relying on some particular
5374 ordering. The majority of such top-level @code{asm} statements,
5375 though, can be replaced by @code{section} attributes. The
5376 @option{fno-toplevel-reorder} option may be used to keep the ordering
5377 used in the input file, at the cost of some optimizations.
5378
5379 @item
5380 @emph{unit-at-a-time} mode removes unreferenced static variables
5381 and functions. This may result in undefined references
5382 when an @code{asm} statement refers directly to variables or functions
5383 that are otherwise unused. In that case either the variable/function
5384 shall be listed as an operand of the @code{asm} statement operand or,
5385 in the case of top-level @code{asm} statements the attribute @code{used}
5386 shall be used on the declaration.
5387
5388 @item
5389 Static functions now can use non-standard passing conventions that
5390 may break @code{asm} statements calling functions directly. Again,
5391 attribute @code{used} will prevent this behavior.
5392 @end itemize
5393
5394 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5395 but this scheme may not be supported by future releases of GCC@.
5396
5397 Enabled at levels @option{-O2}, @option{-O3}.
5398
5399 @item -fno-toplevel-reorder
5400 Do not reorder top-level functions, variables, and @code{asm}
5401 statements. Output them in the same order that they appear in the
5402 input file. When this option is used, unreferenced static variables
5403 will not be removed. This option is intended to support existing code
5404 which relies on a particular ordering. For new code, it is better to
5405 use attributes.
5406
5407 @item -fweb
5408 @opindex fweb
5409 Constructs webs as commonly used for register allocation purposes and assign
5410 each web individual pseudo register. This allows the register allocation pass
5411 to operate on pseudos directly, but also strengthens several other optimization
5412 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5413 however, make debugging impossible, since variables will no longer stay in a
5414 ``home register''.
5415
5416 Enabled by default with @option{-funroll-loops}.
5417
5418 @item -fwhole-program
5419 @opindex fwhole-program
5420 Assume that the current compilation unit represents whole program being
5421 compiled. All public functions and variables with the exception of @code{main}
5422 and those merged by attribute @code{externally_visible} become static functions
5423 and in a affect gets more aggressively optimized by interprocedural optimizers.
5424 While this option is equivalent to proper use of @code{static} keyword for
5425 programs consisting of single file, in combination with option
5426 @option{--combine} this flag can be used to compile most of smaller scale C
5427 programs since the functions and variables become local for the whole combined
5428 compilation unit, not for the single source file itself.
5429
5430
5431 @item -fno-cprop-registers
5432 @opindex fno-cprop-registers
5433 After register allocation and post-register allocation instruction splitting,
5434 we perform a copy-propagation pass to try to reduce scheduling dependencies
5435 and occasionally eliminate the copy.
5436
5437 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5438
5439 @item -fprofile-generate
5440 @opindex fprofile-generate
5441
5442 Enable options usually used for instrumenting application to produce
5443 profile useful for later recompilation with profile feedback based
5444 optimization. You must use @option{-fprofile-generate} both when
5445 compiling and when linking your program.
5446
5447 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5448
5449 @item -fprofile-use
5450 @opindex fprofile-use
5451 Enable profile feedback directed optimizations, and optimizations
5452 generally profitable only with profile feedback available.
5453
5454 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5455 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer},
5456 @code{-fno-loop-optimize}.
5457
5458 @end table
5459
5460 The following options control compiler behavior regarding floating
5461 point arithmetic. These options trade off between speed and
5462 correctness. All must be specifically enabled.
5463
5464 @table @gcctabopt
5465 @item -ffloat-store
5466 @opindex ffloat-store
5467 Do not store floating point variables in registers, and inhibit other
5468 options that might change whether a floating point value is taken from a
5469 register or memory.
5470
5471 @cindex floating point precision
5472 This option prevents undesirable excess precision on machines such as
5473 the 68000 where the floating registers (of the 68881) keep more
5474 precision than a @code{double} is supposed to have. Similarly for the
5475 x86 architecture. For most programs, the excess precision does only
5476 good, but a few programs rely on the precise definition of IEEE floating
5477 point. Use @option{-ffloat-store} for such programs, after modifying
5478 them to store all pertinent intermediate computations into variables.
5479
5480 @item -ffast-math
5481 @opindex ffast-math
5482 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5483 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5484 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5485 and @option{fcx-limited-range}.
5486
5487 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5488
5489 This option should never be turned on by any @option{-O} option since
5490 it can result in incorrect output for programs which depend on
5491 an exact implementation of IEEE or ISO rules/specifications for
5492 math functions.
5493
5494 @item -fno-math-errno
5495 @opindex fno-math-errno
5496 Do not set ERRNO after calling math functions that are executed
5497 with a single instruction, e.g., sqrt. A program that relies on
5498 IEEE exceptions for math error handling may want to use this flag
5499 for speed while maintaining IEEE arithmetic compatibility.
5500
5501 This option should never be turned on by any @option{-O} option since
5502 it can result in incorrect output for programs which depend on
5503 an exact implementation of IEEE or ISO rules/specifications for
5504 math functions.
5505
5506 The default is @option{-fmath-errno}.
5507
5508 On Darwin systems, the math library never sets @code{errno}. There is therefore
5509 no reason for the compiler to consider the possibility that it might,
5510 and @option{-fno-math-errno} is the default.
5511
5512 @item -funsafe-math-optimizations
5513 @opindex funsafe-math-optimizations
5514 Allow optimizations for floating-point arithmetic that (a) assume
5515 that arguments and results are valid and (b) may violate IEEE or
5516 ANSI standards. When used at link-time, it may include libraries
5517 or startup files that change the default FPU control word or other
5518 similar optimizations.
5519
5520 This option should never be turned on by any @option{-O} option since
5521 it can result in incorrect output for programs which depend on
5522 an exact implementation of IEEE or ISO rules/specifications for
5523 math functions.
5524
5525 The default is @option{-fno-unsafe-math-optimizations}.
5526
5527 @item -ffinite-math-only
5528 @opindex ffinite-math-only
5529 Allow optimizations for floating-point arithmetic that assume
5530 that arguments and results are not NaNs or +-Infs.
5531
5532 This option should never be turned on by any @option{-O} option since
5533 it can result in incorrect output for programs which depend on
5534 an exact implementation of IEEE or ISO rules/specifications.
5535
5536 The default is @option{-fno-finite-math-only}.
5537
5538 @item -fno-trapping-math
5539 @opindex fno-trapping-math
5540 Compile code assuming that floating-point operations cannot generate
5541 user-visible traps. These traps include division by zero, overflow,
5542 underflow, inexact result and invalid operation. This option implies
5543 @option{-fno-signaling-nans}. Setting this option may allow faster
5544 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5545
5546 This option should never be turned on by any @option{-O} option since
5547 it can result in incorrect output for programs which depend on
5548 an exact implementation of IEEE or ISO rules/specifications for
5549 math functions.
5550
5551 The default is @option{-ftrapping-math}.
5552
5553 @item -frounding-math
5554 @opindex frounding-math
5555 Disable transformations and optimizations that assume default floating
5556 point rounding behavior. This is round-to-zero for all floating point
5557 to integer conversions, and round-to-nearest for all other arithmetic
5558 truncations. This option should be specified for programs that change
5559 the FP rounding mode dynamically, or that may be executed with a
5560 non-default rounding mode. This option disables constant folding of
5561 floating point expressions at compile-time (which may be affected by
5562 rounding mode) and arithmetic transformations that are unsafe in the
5563 presence of sign-dependent rounding modes.
5564
5565 The default is @option{-fno-rounding-math}.
5566
5567 This option is experimental and does not currently guarantee to
5568 disable all GCC optimizations that are affected by rounding mode.
5569 Future versions of GCC may provide finer control of this setting
5570 using C99's @code{FENV_ACCESS} pragma. This command line option
5571 will be used to specify the default state for @code{FENV_ACCESS}.
5572
5573 @item -frtl-abstract-sequences
5574 @opindex frtl-abstract-sequences
5575 It is a size optimization method. This option is to find identical
5576 sequences of code, which can be turned into pseudo-procedures and
5577 then replace all occurrences with calls to the newly created
5578 subroutine. It is kind of an opposite of @option{-finline-functions}.
5579 This optimization runs at RTL level.
5580
5581 @item -fsignaling-nans
5582 @opindex fsignaling-nans
5583 Compile code assuming that IEEE signaling NaNs may generate user-visible
5584 traps during floating-point operations. Setting this option disables
5585 optimizations that may change the number of exceptions visible with
5586 signaling NaNs. This option implies @option{-ftrapping-math}.
5587
5588 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5589 be defined.
5590
5591 The default is @option{-fno-signaling-nans}.
5592
5593 This option is experimental and does not currently guarantee to
5594 disable all GCC optimizations that affect signaling NaN behavior.
5595
5596 @item -fsingle-precision-constant
5597 @opindex fsingle-precision-constant
5598 Treat floating point constant as single precision constant instead of
5599 implicitly converting it to double precision constant.
5600
5601 @item -fcx-limited-range
5602 @itemx -fno-cx-limited-range
5603 @opindex fcx-limited-range
5604 @opindex fno-cx-limited-range
5605 When enabled, this option states that a range reduction step is not
5606 needed when performing complex division. The default is
5607 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5608
5609 This option controls the default setting of the ISO C99
5610 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5611 all languages.
5612
5613 @end table
5614
5615 The following options control optimizations that may improve
5616 performance, but are not enabled by any @option{-O} options. This
5617 section includes experimental options that may produce broken code.
5618
5619 @table @gcctabopt
5620 @item -fbranch-probabilities
5621 @opindex fbranch-probabilities
5622 After running a program compiled with @option{-fprofile-arcs}
5623 (@pxref{Debugging Options,, Options for Debugging Your Program or
5624 @command{gcc}}), you can compile it a second time using
5625 @option{-fbranch-probabilities}, to improve optimizations based on
5626 the number of times each branch was taken. When the program
5627 compiled with @option{-fprofile-arcs} exits it saves arc execution
5628 counts to a file called @file{@var{sourcename}.gcda} for each source
5629 file The information in this data file is very dependent on the
5630 structure of the generated code, so you must use the same source code
5631 and the same optimization options for both compilations.
5632
5633 With @option{-fbranch-probabilities}, GCC puts a
5634 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5635 These can be used to improve optimization. Currently, they are only
5636 used in one place: in @file{reorg.c}, instead of guessing which path a
5637 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5638 exactly determine which path is taken more often.
5639
5640 @item -fprofile-values
5641 @opindex fprofile-values
5642 If combined with @option{-fprofile-arcs}, it adds code so that some
5643 data about values of expressions in the program is gathered.
5644
5645 With @option{-fbranch-probabilities}, it reads back the data gathered
5646 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5647 notes to instructions for their later usage in optimizations.
5648
5649 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5650
5651 @item -fvpt
5652 @opindex fvpt
5653 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5654 a code to gather information about values of expressions.
5655
5656 With @option{-fbranch-probabilities}, it reads back the data gathered
5657 and actually performs the optimizations based on them.
5658 Currently the optimizations include specialization of division operation
5659 using the knowledge about the value of the denominator.
5660
5661 @item -frename-registers
5662 @opindex frename-registers
5663 Attempt to avoid false dependencies in scheduled code by making use
5664 of registers left over after register allocation. This optimization
5665 will most benefit processors with lots of registers. Depending on the
5666 debug information format adopted by the target, however, it can
5667 make debugging impossible, since variables will no longer stay in
5668 a ``home register''.
5669
5670 Enabled by default with @option{-funroll-loops}.
5671
5672 @item -ftracer
5673 @opindex ftracer
5674 Perform tail duplication to enlarge superblock size. This transformation
5675 simplifies the control flow of the function allowing other optimizations to do
5676 better job.
5677
5678 Enabled with @option{-fprofile-use}.
5679
5680 @item -funroll-loops
5681 @opindex funroll-loops
5682 Unroll loops whose number of iterations can be determined at compile time or
5683 upon entry to the loop. @option{-funroll-loops} implies
5684 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
5685 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5686 small constant number of iterations). This option makes code larger, and may
5687 or may not make it run faster.
5688
5689 Enabled with @option{-fprofile-use}.
5690
5691 @item -funroll-all-loops
5692 @opindex funroll-all-loops
5693 Unroll all loops, even if their number of iterations is uncertain when
5694 the loop is entered. This usually makes programs run more slowly.
5695 @option{-funroll-all-loops} implies the same options as
5696 @option{-funroll-loops}.
5697
5698 @item -fpeel-loops
5699 @opindex fpeel-loops
5700 Peels the loops for that there is enough information that they do not
5701 roll much (from profile feedback). It also turns on complete loop peeling
5702 (i.e.@: complete removal of loops with small constant number of iterations).
5703
5704 Enabled with @option{-fprofile-use}.
5705
5706 @item -fmove-loop-invariants
5707 @opindex fmove-loop-invariants
5708 Enables the loop invariant motion pass in the new loop optimizer. Enabled
5709 at level @option{-O1}
5710
5711 @item -funswitch-loops
5712 @opindex funswitch-loops
5713 Move branches with loop invariant conditions out of the loop, with duplicates
5714 of the loop on both branches (modified according to result of the condition).
5715
5716 @item -fprefetch-loop-arrays
5717 @itemx -fprefetch-loop-arrays-rtl
5718 @opindex fprefetch-loop-arrays
5719 @opindex fprefetch-loop-arrays-rtl
5720 If supported by the target machine, generate instructions to prefetch
5721 memory to improve the performance of loops that access large arrays.
5722
5723 Disabled at level @option{-Os}.
5724
5725 @item -ffunction-sections
5726 @itemx -fdata-sections
5727 @opindex ffunction-sections
5728 @opindex fdata-sections
5729 Place each function or data item into its own section in the output
5730 file if the target supports arbitrary sections. The name of the
5731 function or the name of the data item determines the section's name
5732 in the output file.
5733
5734 Use these options on systems where the linker can perform optimizations
5735 to improve locality of reference in the instruction space. Most systems
5736 using the ELF object format and SPARC processors running Solaris 2 have
5737 linkers with such optimizations. AIX may have these optimizations in
5738 the future.
5739
5740 Only use these options when there are significant benefits from doing
5741 so. When you specify these options, the assembler and linker will
5742 create larger object and executable files and will also be slower.
5743 You will not be able to use @code{gprof} on all systems if you
5744 specify this option and you may have problems with debugging if
5745 you specify both this option and @option{-g}.
5746
5747 @item -fbranch-target-load-optimize
5748 @opindex fbranch-target-load-optimize
5749 Perform branch target register load optimization before prologue / epilogue
5750 threading.
5751 The use of target registers can typically be exposed only during reload,
5752 thus hoisting loads out of loops and doing inter-block scheduling needs
5753 a separate optimization pass.
5754
5755 @item -fbranch-target-load-optimize2
5756 @opindex fbranch-target-load-optimize2
5757 Perform branch target register load optimization after prologue / epilogue
5758 threading.
5759
5760 @item -fbtr-bb-exclusive
5761 @opindex fbtr-bb-exclusive
5762 When performing branch target register load optimization, don't reuse
5763 branch target registers in within any basic block.
5764
5765 @item -fstack-protector
5766 Emit extra code to check for buffer overflows, such as stack smashing
5767 attacks. This is done by adding a guard variable to functions with
5768 vulnerable objects. This includes functions that call alloca, and
5769 functions with buffers larger than 8 bytes. The guards are initialized
5770 when a function is entered and then checked when the function exits.
5771 If a guard check fails, an error message is printed and the program exits.
5772
5773 @item -fstack-protector-all
5774 Like @option{-fstack-protector} except that all functions are protected.
5775
5776 @item --param @var{name}=@var{value}
5777 @opindex param
5778 In some places, GCC uses various constants to control the amount of
5779 optimization that is done. For example, GCC will not inline functions
5780 that contain more that a certain number of instructions. You can
5781 control some of these constants on the command-line using the
5782 @option{--param} option.
5783
5784 The names of specific parameters, and the meaning of the values, are
5785 tied to the internals of the compiler, and are subject to change
5786 without notice in future releases.
5787
5788 In each case, the @var{value} is an integer. The allowable choices for
5789 @var{name} are given in the following table:
5790
5791 @table @gcctabopt
5792 @item salias-max-implicit-fields
5793 The maximum number of fields in a variable without direct
5794 structure accesses for which structure aliasing will consider trying
5795 to track each field. The default is 5
5796
5797 @item salias-max-array-elements
5798 The maximum number of elements an array can have and its elements
5799 still be tracked individually by structure aliasing. The default is 4
5800
5801 @item sra-max-structure-size
5802 The maximum structure size, in bytes, at which the scalar replacement
5803 of aggregates (SRA) optimization will perform block copies. The
5804 default value, 0, implies that GCC will select the most appropriate
5805 size itself.
5806
5807 @item sra-field-structure-ratio
5808 The threshold ratio (as a percentage) between instantiated fields and
5809 the complete structure size. We say that if the ratio of the number
5810 of bytes in instantiated fields to the number of bytes in the complete
5811 structure exceeds this parameter, then block copies are not used. The
5812 default is 75.
5813
5814 @item max-crossjump-edges
5815 The maximum number of incoming edges to consider for crossjumping.
5816 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5817 the number of edges incoming to each block. Increasing values mean
5818 more aggressive optimization, making the compile time increase with
5819 probably small improvement in executable size.
5820
5821 @item min-crossjump-insns
5822 The minimum number of instructions which must be matched at the end
5823 of two blocks before crossjumping will be performed on them. This
5824 value is ignored in the case where all instructions in the block being
5825 crossjumped from are matched. The default value is 5.
5826
5827 @item max-grow-copy-bb-insns
5828 The maximum code size expansion factor when copying basic blocks
5829 instead of jumping. The expansion is relative to a jump instruction.
5830 The default value is 8.
5831
5832 @item max-goto-duplication-insns
5833 The maximum number of instructions to duplicate to a block that jumps
5834 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5835 passes, GCC factors computed gotos early in the compilation process,
5836 and unfactors them as late as possible. Only computed jumps at the
5837 end of a basic blocks with no more than max-goto-duplication-insns are
5838 unfactored. The default value is 8.
5839
5840 @item max-delay-slot-insn-search
5841 The maximum number of instructions to consider when looking for an
5842 instruction to fill a delay slot. If more than this arbitrary number of
5843 instructions is searched, the time savings from filling the delay slot
5844 will be minimal so stop searching. Increasing values mean more
5845 aggressive optimization, making the compile time increase with probably
5846 small improvement in executable run time.
5847
5848 @item max-delay-slot-live-search
5849 When trying to fill delay slots, the maximum number of instructions to
5850 consider when searching for a block with valid live register
5851 information. Increasing this arbitrarily chosen value means more
5852 aggressive optimization, increasing the compile time. This parameter
5853 should be removed when the delay slot code is rewritten to maintain the
5854 control-flow graph.
5855
5856 @item max-gcse-memory
5857 The approximate maximum amount of memory that will be allocated in
5858 order to perform the global common subexpression elimination
5859 optimization. If more memory than specified is required, the
5860 optimization will not be done.
5861
5862 @item max-gcse-passes
5863 The maximum number of passes of GCSE to run. The default is 1.
5864
5865 @item max-pending-list-length
5866 The maximum number of pending dependencies scheduling will allow
5867 before flushing the current state and starting over. Large functions
5868 with few branches or calls can create excessively large lists which
5869 needlessly consume memory and resources.
5870
5871 @item max-inline-insns-single
5872 Several parameters control the tree inliner used in gcc.
5873 This number sets the maximum number of instructions (counted in GCC's
5874 internal representation) in a single function that the tree inliner
5875 will consider for inlining. This only affects functions declared
5876 inline and methods implemented in a class declaration (C++).
5877 The default value is 450.
5878
5879 @item max-inline-insns-auto
5880 When you use @option{-finline-functions} (included in @option{-O3}),
5881 a lot of functions that would otherwise not be considered for inlining
5882 by the compiler will be investigated. To those functions, a different
5883 (more restrictive) limit compared to functions declared inline can
5884 be applied.
5885 The default value is 90.
5886
5887 @item large-function-insns
5888 The limit specifying really large functions. For functions larger than this
5889 limit after inlining inlining is constrained by
5890 @option{--param large-function-growth}. This parameter is useful primarily
5891 to avoid extreme compilation time caused by non-linear algorithms used by the
5892 backend.
5893 This parameter is ignored when @option{-funit-at-a-time} is not used.
5894 The default value is 2700.
5895
5896 @item large-function-growth
5897 Specifies maximal growth of large function caused by inlining in percents.
5898 This parameter is ignored when @option{-funit-at-a-time} is not used.
5899 The default value is 100 which limits large function growth to 2.0 times
5900 the original size.
5901
5902 @item large-unit-insns
5903 The limit specifying large translation unit. Growth caused by inlining of
5904 units larger than this limit is limited by @option{--param inline-unit-growth}.
5905 For small units this might be too tight (consider unit consisting of function A
5906 that is inline and B that just calls A three time. If B is small relative to
5907 A, the growth of unit is 300\% and yet such inlining is very sane. For very
5908 large units consisting of small inlininable functions however the overall unit
5909 growth limit is needed to avoid exponential explosion of code size. Thus for
5910 smaller units, the size is increased to @option{--param large-unit-insns}
5911 before applying @option{--param inline-unit-growth}. The default is 10000
5912
5913 @item inline-unit-growth
5914 Specifies maximal overall growth of the compilation unit caused by inlining.
5915 This parameter is ignored when @option{-funit-at-a-time} is not used.
5916 The default value is 50 which limits unit growth to 1.5 times the original
5917 size.
5918
5919 @item max-inline-insns-recursive
5920 @itemx max-inline-insns-recursive-auto
5921 Specifies maximum number of instructions out-of-line copy of self recursive inline
5922 function can grow into by performing recursive inlining.
5923
5924 For functions declared inline @option{--param max-inline-insns-recursive} is
5925 taken into acount. For function not declared inline, recursive inlining
5926 happens only when @option{-finline-functions} (included in @option{-O3}) is
5927 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
5928 default value is 450.
5929
5930 @item max-inline-recursive-depth
5931 @itemx max-inline-recursive-depth-auto
5932 Specifies maximum recursion depth used by the recursive inlining.
5933
5934 For functions declared inline @option{--param max-inline-recursive-depth} is
5935 taken into acount. For function not declared inline, recursive inlining
5936 happens only when @option{-finline-functions} (included in @option{-O3}) is
5937 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
5938 default value is 450.
5939
5940 @item min-inline-recursive-probability
5941 Recursive inlining is profitable only for function having deep recursion
5942 in average and can hurt for function having little recursion depth by
5943 increasing the prologue size or complexity of function body to other
5944 optimizers.
5945
5946 When profile feedback is available (see @option{-fprofile-generate}) the actual
5947 recursion depth can be guessed from probability that function will recurse via
5948 given call expression. This parameter limits inlining only to call expression
5949 whose probability exceeds given threshold (in percents). The default value is
5950 10.
5951
5952 @item inline-call-cost
5953 Specify cost of call instruction relative to simple arithmetics operations
5954 (having cost of 1). Increasing this cost disqualifies inlining of non-leaf
5955 functions and at the same time increases size of leaf function that is believed to
5956 reduce function size by being inlined. In effect it increases amount of
5957 inlining for code having large abstraction penalty (many functions that just
5958 pass the arguments to other functions) and decrease inlining for code with low
5959 abstraction penalty. The default value is 16.
5960
5961 @item max-unrolled-insns
5962 The maximum number of instructions that a loop should have if that loop
5963 is unrolled, and if the loop is unrolled, it determines how many times
5964 the loop code is unrolled.
5965
5966 @item max-average-unrolled-insns
5967 The maximum number of instructions biased by probabilities of their execution
5968 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5969 it determines how many times the loop code is unrolled.
5970
5971 @item max-unroll-times
5972 The maximum number of unrollings of a single loop.
5973
5974 @item max-peeled-insns
5975 The maximum number of instructions that a loop should have if that loop
5976 is peeled, and if the loop is peeled, it determines how many times
5977 the loop code is peeled.
5978
5979 @item max-peel-times
5980 The maximum number of peelings of a single loop.
5981
5982 @item max-completely-peeled-insns
5983 The maximum number of insns of a completely peeled loop.
5984
5985 @item max-completely-peel-times
5986 The maximum number of iterations of a loop to be suitable for complete peeling.
5987
5988 @item max-unswitch-insns
5989 The maximum number of insns of an unswitched loop.
5990
5991 @item max-unswitch-level
5992 The maximum number of branches unswitched in a single loop.
5993
5994 @item lim-expensive
5995 The minimum cost of an expensive expression in the loop invariant motion.
5996
5997 @item iv-consider-all-candidates-bound
5998 Bound on number of candidates for induction variables below that
5999 all candidates are considered for each use in induction variable
6000 optimizations. Only the most relevant candidates are considered
6001 if there are more candidates, to avoid quadratic time complexity.
6002
6003 @item iv-max-considered-uses
6004 The induction variable optimizations give up on loops that contain more
6005 induction variable uses.
6006
6007 @item iv-always-prune-cand-set-bound
6008 If number of candidates in the set is smaller than this value,
6009 we always try to remove unnecessary ivs from the set during its
6010 optimization when a new iv is added to the set.
6011
6012 @item scev-max-expr-size
6013 Bound on size of expressions used in the scalar evolutions analyzer.
6014 Large expressions slow the analyzer.
6015
6016 @item vect-max-version-checks
6017 The maximum number of runtime checks that can be performed when doing
6018 loop versioning in the vectorizer. See option ftree-vect-loop-version
6019 for more information.
6020
6021 @item max-iterations-to-track
6022
6023 The maximum number of iterations of a loop the brute force algorithm
6024 for analysis of # of iterations of the loop tries to evaluate.
6025
6026 @item hot-bb-count-fraction
6027 Select fraction of the maximal count of repetitions of basic block in program
6028 given basic block needs to have to be considered hot.
6029
6030 @item hot-bb-frequency-fraction
6031 Select fraction of the maximal frequency of executions of basic block in
6032 function given basic block needs to have to be considered hot
6033
6034 @item max-predicted-iterations
6035 The maximum number of loop iterations we predict statically. This is useful
6036 in cases where function contain single loop with known bound and other loop
6037 with unknown. We predict the known number of iterations correctly, while
6038 the unknown number of iterations average to roughly 10. This means that the
6039 loop without bounds would appear artificially cold relative to the other one.
6040
6041 @item tracer-dynamic-coverage
6042 @itemx tracer-dynamic-coverage-feedback
6043
6044 This value is used to limit superblock formation once the given percentage of
6045 executed instructions is covered. This limits unnecessary code size
6046 expansion.
6047
6048 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6049 feedback is available. The real profiles (as opposed to statically estimated
6050 ones) are much less balanced allowing the threshold to be larger value.
6051
6052 @item tracer-max-code-growth
6053 Stop tail duplication once code growth has reached given percentage. This is
6054 rather hokey argument, as most of the duplicates will be eliminated later in
6055 cross jumping, so it may be set to much higher values than is the desired code
6056 growth.
6057
6058 @item tracer-min-branch-ratio
6059
6060 Stop reverse growth when the reverse probability of best edge is less than this
6061 threshold (in percent).
6062
6063 @item tracer-min-branch-ratio
6064 @itemx tracer-min-branch-ratio-feedback
6065
6066 Stop forward growth if the best edge do have probability lower than this
6067 threshold.
6068
6069 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6070 compilation for profile feedback and one for compilation without. The value
6071 for compilation with profile feedback needs to be more conservative (higher) in
6072 order to make tracer effective.
6073
6074 @item max-cse-path-length
6075
6076 Maximum number of basic blocks on path that cse considers. The default is 10.
6077
6078 @item max-cse-insns
6079 The maximum instructions CSE process before flushing. The default is 1000.
6080
6081 @item global-var-threshold
6082
6083 Counts the number of function calls (@var{n}) and the number of
6084 call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
6085 single artificial variable will be created to represent all the
6086 call-clobbered variables at function call sites. This artificial
6087 variable will then be made to alias every call-clobbered variable.
6088 (done as @code{int * size_t} on the host machine; beware overflow).
6089
6090 @item max-aliased-vops
6091
6092 Maximum number of virtual operands allowed to represent aliases
6093 before triggering the alias grouping heuristic. Alias grouping
6094 reduces compile times and memory consumption needed for aliasing at
6095 the expense of precision loss in alias information.
6096
6097 @item ggc-min-expand
6098
6099 GCC uses a garbage collector to manage its own memory allocation. This
6100 parameter specifies the minimum percentage by which the garbage
6101 collector's heap should be allowed to expand between collections.
6102 Tuning this may improve compilation speed; it has no effect on code
6103 generation.
6104
6105 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6106 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
6107 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
6108 GCC is not able to calculate RAM on a particular platform, the lower
6109 bound of 30% is used. Setting this parameter and
6110 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6111 every opportunity. This is extremely slow, but can be useful for
6112 debugging.
6113
6114 @item ggc-min-heapsize
6115
6116 Minimum size of the garbage collector's heap before it begins bothering
6117 to collect garbage. The first collection occurs after the heap expands
6118 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
6119 tuning this may improve compilation speed, and has no effect on code
6120 generation.
6121
6122 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6123 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6124 with a lower bound of 4096 (four megabytes) and an upper bound of
6125 131072 (128 megabytes). If GCC is not able to calculate RAM on a
6126 particular platform, the lower bound is used. Setting this parameter
6127 very large effectively disables garbage collection. Setting this
6128 parameter and @option{ggc-min-expand} to zero causes a full collection
6129 to occur at every opportunity.
6130
6131 @item max-reload-search-insns
6132 The maximum number of instruction reload should look backward for equivalent
6133 register. Increasing values mean more aggressive optimization, making the
6134 compile time increase with probably slightly better performance. The default
6135 value is 100.
6136
6137 @item max-cselib-memory-location
6138 The maximum number of memory locations cselib should take into acount.
6139 Increasing values mean more aggressive optimization, making the compile time
6140 increase with probably slightly better performance. The default value is 500.
6141
6142 @item max-flow-memory-location
6143 Similar as @option{max-cselib-memory-location} but for dataflow liveness.
6144 The default value is 100.
6145
6146 @item reorder-blocks-duplicate
6147 @itemx reorder-blocks-duplicate-feedback
6148
6149 Used by basic block reordering pass to decide whether to use unconditional
6150 branch or duplicate the code on its destination. Code is duplicated when its
6151 estimated size is smaller than this value multiplied by the estimated size of
6152 unconditional jump in the hot spots of the program.
6153
6154 The @option{reorder-block-duplicate-feedback} is used only when profile
6155 feedback is available and may be set to higher values than
6156 @option{reorder-block-duplicate} since information about the hot spots is more
6157 accurate.
6158
6159 @item max-sched-region-blocks
6160 The maximum number of blocks in a region to be considered for
6161 interblock scheduling. The default value is 10.
6162
6163 @item max-sched-region-insns
6164 The maximum number of insns in a region to be considered for
6165 interblock scheduling. The default value is 100.
6166
6167 @item min-spec-prob
6168 The minimum probability (in percents) of reaching a source block
6169 for interblock speculative scheduling. The default value is 40.
6170
6171 @item max-last-value-rtl
6172
6173 The maximum size measured as number of RTLs that can be recorded in an expression
6174 in combiner for a pseudo register as last known value of that register. The default
6175 is 10000.
6176
6177 @item integer-share-limit
6178 Small integer constants can use a shared data structure, reducing the
6179 compiler's memory usage and increasing its speed. This sets the maximum
6180 value of a shared integer constant's. The default value is 256.
6181
6182 @item min-virtual-mappings
6183 Specifies the minimum number of virtual mappings in the incremental
6184 SSA updater that should be registered to trigger the virtual mappings
6185 heuristic defined by virtual-mappings-ratio. The default value is
6186 100.
6187
6188 @item virtual-mappings-ratio
6189 If the number of virtual mappings is virtual-mappings-ratio bigger
6190 than the number of virtual symbols to be updated, then the incremental
6191 SSA updater switches to a full update for those symbols. The default
6192 ratio is 3.
6193
6194 @item ssp-buffer-size
6195 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6196 protection when @option{-fstack-protection} is used.
6197
6198 @item max-jump-thread-duplication-stmts
6199 Maximum number of statements allowed in a block that needs to be
6200 duplicated when threading jumps.
6201
6202 @item max-fields-for-field-sensitive
6203 Maximum number of fields in a structure we will treat in
6204 a field sensitive manner during pointer analysis.
6205
6206 @end table
6207 @end table
6208
6209 @node Preprocessor Options
6210 @section Options Controlling the Preprocessor
6211 @cindex preprocessor options
6212 @cindex options, preprocessor
6213
6214 These options control the C preprocessor, which is run on each C source
6215 file before actual compilation.
6216
6217 If you use the @option{-E} option, nothing is done except preprocessing.
6218 Some of these options make sense only together with @option{-E} because
6219 they cause the preprocessor output to be unsuitable for actual
6220 compilation.
6221
6222 @table @gcctabopt
6223 @opindex Wp
6224 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6225 and pass @var{option} directly through to the preprocessor. If
6226 @var{option} contains commas, it is split into multiple options at the
6227 commas. However, many options are modified, translated or interpreted
6228 by the compiler driver before being passed to the preprocessor, and
6229 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
6230 interface is undocumented and subject to change, so whenever possible
6231 you should avoid using @option{-Wp} and let the driver handle the
6232 options instead.
6233
6234 @item -Xpreprocessor @var{option}
6235 @opindex preprocessor
6236 Pass @var{option} as an option to the preprocessor. You can use this to
6237 supply system-specific preprocessor options which GCC does not know how to
6238 recognize.
6239
6240 If you want to pass an option that takes an argument, you must use
6241 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6242 @end table
6243
6244 @include cppopts.texi
6245
6246 @node Assembler Options
6247 @section Passing Options to the Assembler
6248
6249 @c prevent bad page break with this line
6250 You can pass options to the assembler.
6251
6252 @table @gcctabopt
6253 @item -Wa,@var{option}
6254 @opindex Wa
6255 Pass @var{option} as an option to the assembler. If @var{option}
6256 contains commas, it is split into multiple options at the commas.
6257
6258 @item -Xassembler @var{option}
6259 @opindex Xassembler
6260 Pass @var{option} as an option to the assembler. You can use this to
6261 supply system-specific assembler options which GCC does not know how to
6262 recognize.
6263
6264 If you want to pass an option that takes an argument, you must use
6265 @option{-Xassembler} twice, once for the option and once for the argument.
6266
6267 @end table
6268
6269 @node Link Options
6270 @section Options for Linking
6271 @cindex link options
6272 @cindex options, linking
6273
6274 These options come into play when the compiler links object files into
6275 an executable output file. They are meaningless if the compiler is
6276 not doing a link step.
6277
6278 @table @gcctabopt
6279 @cindex file names
6280 @item @var{object-file-name}
6281 A file name that does not end in a special recognized suffix is
6282 considered to name an object file or library. (Object files are
6283 distinguished from libraries by the linker according to the file
6284 contents.) If linking is done, these object files are used as input
6285 to the linker.
6286
6287 @item -c
6288 @itemx -S
6289 @itemx -E
6290 @opindex c
6291 @opindex S
6292 @opindex E
6293 If any of these options is used, then the linker is not run, and
6294 object file names should not be used as arguments. @xref{Overall
6295 Options}.
6296
6297 @cindex Libraries
6298 @item -l@var{library}
6299 @itemx -l @var{library}
6300 @opindex l
6301 Search the library named @var{library} when linking. (The second
6302 alternative with the library as a separate argument is only for
6303 POSIX compliance and is not recommended.)
6304
6305 It makes a difference where in the command you write this option; the
6306 linker searches and processes libraries and object files in the order they
6307 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6308 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
6309 to functions in @samp{z}, those functions may not be loaded.
6310
6311 The linker searches a standard list of directories for the library,
6312 which is actually a file named @file{lib@var{library}.a}. The linker
6313 then uses this file as if it had been specified precisely by name.
6314
6315 The directories searched include several standard system directories
6316 plus any that you specify with @option{-L}.
6317
6318 Normally the files found this way are library files---archive files
6319 whose members are object files. The linker handles an archive file by
6320 scanning through it for members which define symbols that have so far
6321 been referenced but not defined. But if the file that is found is an
6322 ordinary object file, it is linked in the usual fashion. The only
6323 difference between using an @option{-l} option and specifying a file name
6324 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6325 and searches several directories.
6326
6327 @item -lobjc
6328 @opindex lobjc
6329 You need this special case of the @option{-l} option in order to
6330 link an Objective-C or Objective-C++ program.
6331
6332 @item -nostartfiles
6333 @opindex nostartfiles
6334 Do not use the standard system startup files when linking.
6335 The standard system libraries are used normally, unless @option{-nostdlib}
6336 or @option{-nodefaultlibs} is used.
6337
6338 @item -nodefaultlibs
6339 @opindex nodefaultlibs
6340 Do not use the standard system libraries when linking.
6341 Only the libraries you specify will be passed to the linker.
6342 The standard startup files are used normally, unless @option{-nostartfiles}
6343 is used. The compiler may generate calls to @code{memcmp},
6344 @code{memset}, @code{memcpy} and @code{memmove}.
6345 These entries are usually resolved by entries in
6346 libc. These entry points should be supplied through some other
6347 mechanism when this option is specified.
6348
6349 @item -nostdlib
6350 @opindex nostdlib
6351 Do not use the standard system startup files or libraries when linking.
6352 No startup files and only the libraries you specify will be passed to
6353 the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
6354 @code{memcpy} and @code{memmove}.
6355 These entries are usually resolved by entries in
6356 libc. These entry points should be supplied through some other
6357 mechanism when this option is specified.
6358
6359 @cindex @option{-lgcc}, use with @option{-nostdlib}
6360 @cindex @option{-nostdlib} and unresolved references
6361 @cindex unresolved references and @option{-nostdlib}
6362 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6363 @cindex @option{-nodefaultlibs} and unresolved references
6364 @cindex unresolved references and @option{-nodefaultlibs}
6365 One of the standard libraries bypassed by @option{-nostdlib} and
6366 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6367 that GCC uses to overcome shortcomings of particular machines, or special
6368 needs for some languages.
6369 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6370 Collection (GCC) Internals},
6371 for more discussion of @file{libgcc.a}.)
6372 In most cases, you need @file{libgcc.a} even when you want to avoid
6373 other standard libraries. In other words, when you specify @option{-nostdlib}
6374 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6375 This ensures that you have no unresolved references to internal GCC
6376 library subroutines. (For example, @samp{__main}, used to ensure C++
6377 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6378 GNU Compiler Collection (GCC) Internals}.)
6379
6380 @item -pie
6381 @opindex pie
6382 Produce a position independent executable on targets which support it.
6383 For predictable results, you must also specify the same set of options
6384 that were used to generate code (@option{-fpie}, @option{-fPIE},
6385 or model suboptions) when you specify this option.
6386
6387 @item -rdynamic
6388 @opindex rdynamic
6389 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6390 that support it. This instructs the linker to add all symbols, not
6391 only used ones, to the dynamic symbol table. This option is needed
6392 for some uses of @code{dlopen} or to allow obtaining backtraces
6393 from within a program.
6394
6395 @item -s
6396 @opindex s
6397 Remove all symbol table and relocation information from the executable.
6398
6399 @item -static
6400 @opindex static
6401 On systems that support dynamic linking, this prevents linking with the shared
6402 libraries. On other systems, this option has no effect.
6403
6404 @item -shared
6405 @opindex shared
6406 Produce a shared object which can then be linked with other objects to
6407 form an executable. Not all systems support this option. For predictable
6408 results, you must also specify the same set of options that were used to
6409 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6410 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6411 needs to build supplementary stub code for constructors to work. On
6412 multi-libbed systems, @samp{gcc -shared} must select the correct support
6413 libraries to link against. Failing to supply the correct flags may lead
6414 to subtle defects. Supplying them in cases where they are not necessary
6415 is innocuous.}
6416
6417 @item -shared-libgcc
6418 @itemx -static-libgcc
6419 @opindex shared-libgcc
6420 @opindex static-libgcc
6421 On systems that provide @file{libgcc} as a shared library, these options
6422 force the use of either the shared or static version respectively.
6423 If no shared version of @file{libgcc} was built when the compiler was
6424 configured, these options have no effect.
6425
6426 There are several situations in which an application should use the
6427 shared @file{libgcc} instead of the static version. The most common
6428 of these is when the application wishes to throw and catch exceptions
6429 across different shared libraries. In that case, each of the libraries
6430 as well as the application itself should use the shared @file{libgcc}.
6431
6432 Therefore, the G++ and GCJ drivers automatically add
6433 @option{-shared-libgcc} whenever you build a shared library or a main
6434 executable, because C++ and Java programs typically use exceptions, so
6435 this is the right thing to do.
6436
6437 If, instead, you use the GCC driver to create shared libraries, you may
6438 find that they will not always be linked with the shared @file{libgcc}.
6439 If GCC finds, at its configuration time, that you have a non-GNU linker
6440 or a GNU linker that does not support option @option{--eh-frame-hdr},
6441 it will link the shared version of @file{libgcc} into shared libraries
6442 by default. Otherwise, it will take advantage of the linker and optimize
6443 away the linking with the shared version of @file{libgcc}, linking with
6444 the static version of libgcc by default. This allows exceptions to
6445 propagate through such shared libraries, without incurring relocation
6446 costs at library load time.
6447
6448 However, if a library or main executable is supposed to throw or catch
6449 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6450 for the languages used in the program, or using the option
6451 @option{-shared-libgcc}, such that it is linked with the shared
6452 @file{libgcc}.
6453
6454 @item -symbolic
6455 @opindex symbolic
6456 Bind references to global symbols when building a shared object. Warn
6457 about any unresolved references (unless overridden by the link editor
6458 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6459 this option.
6460
6461 @item -Xlinker @var{option}
6462 @opindex Xlinker
6463 Pass @var{option} as an option to the linker. You can use this to
6464 supply system-specific linker options which GCC does not know how to
6465 recognize.
6466
6467 If you want to pass an option that takes an argument, you must use
6468 @option{-Xlinker} twice, once for the option and once for the argument.
6469 For example, to pass @option{-assert definitions}, you must write
6470 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
6471 @option{-Xlinker "-assert definitions"}, because this passes the entire
6472 string as a single argument, which is not what the linker expects.
6473
6474 @item -Wl,@var{option}
6475 @opindex Wl
6476 Pass @var{option} as an option to the linker. If @var{option} contains
6477 commas, it is split into multiple options at the commas.
6478
6479 @item -u @var{symbol}
6480 @opindex u
6481 Pretend the symbol @var{symbol} is undefined, to force linking of
6482 library modules to define it. You can use @option{-u} multiple times with
6483 different symbols to force loading of additional library modules.
6484 @end table
6485
6486 @node Directory Options
6487 @section Options for Directory Search
6488 @cindex directory options
6489 @cindex options, directory search
6490 @cindex search path
6491
6492 These options specify directories to search for header files, for
6493 libraries and for parts of the compiler:
6494
6495 @table @gcctabopt
6496 @item -I@var{dir}
6497 @opindex I
6498 Add the directory @var{dir} to the head of the list of directories to be
6499 searched for header files. This can be used to override a system header
6500 file, substituting your own version, since these directories are
6501 searched before the system header file directories. However, you should
6502 not use this option to add directories that contain vendor-supplied
6503 system header files (use @option{-isystem} for that). If you use more than
6504 one @option{-I} option, the directories are scanned in left-to-right
6505 order; the standard system directories come after.
6506
6507 If a standard system include directory, or a directory specified with
6508 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6509 option will be ignored. The directory will still be searched but as a
6510 system directory at its normal position in the system include chain.
6511 This is to ensure that GCC's procedure to fix buggy system headers and
6512 the ordering for the include_next directive are not inadvertently changed.
6513 If you really need to change the search order for system directories,
6514 use the @option{-nostdinc} and/or @option{-isystem} options.
6515
6516 @item -iquote@var{dir}
6517 @opindex iquote
6518 Add the directory @var{dir} to the head of the list of directories to
6519 be searched for header files only for the case of @samp{#include
6520 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6521 otherwise just like @option{-I}.
6522
6523 @item -L@var{dir}
6524 @opindex L
6525 Add directory @var{dir} to the list of directories to be searched
6526 for @option{-l}.
6527
6528 @item -B@var{prefix}
6529 @opindex B
6530 This option specifies where to find the executables, libraries,
6531 include files, and data files of the compiler itself.
6532
6533 The compiler driver program runs one or more of the subprograms
6534 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6535 @var{prefix} as a prefix for each program it tries to run, both with and
6536 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6537
6538 For each subprogram to be run, the compiler driver first tries the
6539 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
6540 was not specified, the driver tries two standard prefixes, which are
6541 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
6542 those results in a file name that is found, the unmodified program
6543 name is searched for using the directories specified in your
6544 @env{PATH} environment variable.
6545
6546 The compiler will check to see if the path provided by the @option{-B}
6547 refers to a directory, and if necessary it will add a directory
6548 separator character at the end of the path.
6549
6550 @option{-B} prefixes that effectively specify directory names also apply
6551 to libraries in the linker, because the compiler translates these
6552 options into @option{-L} options for the linker. They also apply to
6553 includes files in the preprocessor, because the compiler translates these
6554 options into @option{-isystem} options for the preprocessor. In this case,
6555 the compiler appends @samp{include} to the prefix.
6556
6557 The run-time support file @file{libgcc.a} can also be searched for using
6558 the @option{-B} prefix, if needed. If it is not found there, the two
6559 standard prefixes above are tried, and that is all. The file is left
6560 out of the link if it is not found by those means.
6561
6562 Another way to specify a prefix much like the @option{-B} prefix is to use
6563 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
6564 Variables}.
6565
6566 As a special kludge, if the path provided by @option{-B} is
6567 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6568 9, then it will be replaced by @file{[dir/]include}. This is to help
6569 with boot-strapping the compiler.
6570
6571 @item -specs=@var{file}
6572 @opindex specs
6573 Process @var{file} after the compiler reads in the standard @file{specs}
6574 file, in order to override the defaults that the @file{gcc} driver
6575 program uses when determining what switches to pass to @file{cc1},
6576 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
6577 @option{-specs=@var{file}} can be specified on the command line, and they
6578 are processed in order, from left to right.
6579
6580 @item --sysroot=@var{dir}
6581 @opindex sysroot
6582 Use @var{dir} as the logical root directory for headers and libraries.
6583 For example, if the compiler would normally search for headers in
6584 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6585 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
6586
6587 If you use both this option and the @option{-isysroot} option, then
6588 the @option{--sysroot} option will apply to libraries, but the
6589 @option{-isysroot} option will apply to header files.
6590
6591 The GNU linker (beginning with version 2.16) has the necessary support
6592 for this option. If your linker does not support this option, the
6593 header file aspect of @option{--sysroot} will still work, but the
6594 library aspect will not.
6595
6596 @item -I-
6597 @opindex I-
6598 This option has been deprecated. Please use @option{-iquote} instead for
6599 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6600 Any directories you specify with @option{-I} options before the @option{-I-}
6601 option are searched only for the case of @samp{#include "@var{file}"};
6602 they are not searched for @samp{#include <@var{file}>}.
6603
6604 If additional directories are specified with @option{-I} options after
6605 the @option{-I-}, these directories are searched for all @samp{#include}
6606 directives. (Ordinarily @emph{all} @option{-I} directories are used
6607 this way.)
6608
6609 In addition, the @option{-I-} option inhibits the use of the current
6610 directory (where the current input file came from) as the first search
6611 directory for @samp{#include "@var{file}"}. There is no way to
6612 override this effect of @option{-I-}. With @option{-I.} you can specify
6613 searching the directory which was current when the compiler was
6614 invoked. That is not exactly the same as what the preprocessor does
6615 by default, but it is often satisfactory.
6616
6617 @option{-I-} does not inhibit the use of the standard system directories
6618 for header files. Thus, @option{-I-} and @option{-nostdinc} are
6619 independent.
6620 @end table
6621
6622 @c man end
6623
6624 @node Spec Files
6625 @section Specifying subprocesses and the switches to pass to them
6626 @cindex Spec Files
6627
6628 @command{gcc} is a driver program. It performs its job by invoking a
6629 sequence of other programs to do the work of compiling, assembling and
6630 linking. GCC interprets its command-line parameters and uses these to
6631 deduce which programs it should invoke, and which command-line options
6632 it ought to place on their command lines. This behavior is controlled
6633 by @dfn{spec strings}. In most cases there is one spec string for each
6634 program that GCC can invoke, but a few programs have multiple spec
6635 strings to control their behavior. The spec strings built into GCC can
6636 be overridden by using the @option{-specs=} command-line switch to specify
6637 a spec file.
6638
6639 @dfn{Spec files} are plaintext files that are used to construct spec
6640 strings. They consist of a sequence of directives separated by blank
6641 lines. The type of directive is determined by the first non-whitespace
6642 character on the line and it can be one of the following:
6643
6644 @table @code
6645 @item %@var{command}
6646 Issues a @var{command} to the spec file processor. The commands that can
6647 appear here are:
6648
6649 @table @code
6650 @item %include <@var{file}>
6651 @cindex %include
6652 Search for @var{file} and insert its text at the current point in the
6653 specs file.
6654
6655 @item %include_noerr <@var{file}>
6656 @cindex %include_noerr
6657 Just like @samp{%include}, but do not generate an error message if the include
6658 file cannot be found.
6659
6660 @item %rename @var{old_name} @var{new_name}
6661 @cindex %rename
6662 Rename the spec string @var{old_name} to @var{new_name}.
6663
6664 @end table
6665
6666 @item *[@var{spec_name}]:
6667 This tells the compiler to create, override or delete the named spec
6668 string. All lines after this directive up to the next directive or
6669 blank line are considered to be the text for the spec string. If this
6670 results in an empty string then the spec will be deleted. (Or, if the
6671 spec did not exist, then nothing will happened.) Otherwise, if the spec
6672 does not currently exist a new spec will be created. If the spec does
6673 exist then its contents will be overridden by the text of this
6674 directive, unless the first character of that text is the @samp{+}
6675 character, in which case the text will be appended to the spec.
6676
6677 @item [@var{suffix}]:
6678 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6679 and up to the next directive or blank line are considered to make up the
6680 spec string for the indicated suffix. When the compiler encounters an
6681 input file with the named suffix, it will processes the spec string in
6682 order to work out how to compile that file. For example:
6683
6684 @smallexample
6685 .ZZ:
6686 z-compile -input %i
6687 @end smallexample
6688
6689 This says that any input file whose name ends in @samp{.ZZ} should be
6690 passed to the program @samp{z-compile}, which should be invoked with the
6691 command-line switch @option{-input} and with the result of performing the
6692 @samp{%i} substitution. (See below.)
6693
6694 As an alternative to providing a spec string, the text that follows a
6695 suffix directive can be one of the following:
6696
6697 @table @code
6698 @item @@@var{language}
6699 This says that the suffix is an alias for a known @var{language}. This is
6700 similar to using the @option{-x} command-line switch to GCC to specify a
6701 language explicitly. For example:
6702
6703 @smallexample
6704 .ZZ:
6705 @@c++
6706 @end smallexample
6707
6708 Says that .ZZ files are, in fact, C++ source files.
6709
6710 @item #@var{name}
6711 This causes an error messages saying:
6712
6713 @smallexample
6714 @var{name} compiler not installed on this system.
6715 @end smallexample
6716 @end table
6717
6718 GCC already has an extensive list of suffixes built into it.
6719 This directive will add an entry to the end of the list of suffixes, but
6720 since the list is searched from the end backwards, it is effectively
6721 possible to override earlier entries using this technique.
6722
6723 @end table
6724
6725 GCC has the following spec strings built into it. Spec files can
6726 override these strings or create their own. Note that individual
6727 targets can also add their own spec strings to this list.
6728
6729 @smallexample
6730 asm Options to pass to the assembler
6731 asm_final Options to pass to the assembler post-processor
6732 cpp Options to pass to the C preprocessor
6733 cc1 Options to pass to the C compiler
6734 cc1plus Options to pass to the C++ compiler
6735 endfile Object files to include at the end of the link
6736 link Options to pass to the linker
6737 lib Libraries to include on the command line to the linker
6738 libgcc Decides which GCC support library to pass to the linker
6739 linker Sets the name of the linker
6740 predefines Defines to be passed to the C preprocessor
6741 signed_char Defines to pass to CPP to say whether @code{char} is signed
6742 by default
6743 startfile Object files to include at the start of the link
6744 @end smallexample
6745
6746 Here is a small example of a spec file:
6747
6748 @smallexample
6749 %rename lib old_lib
6750
6751 *lib:
6752 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6753 @end smallexample
6754
6755 This example renames the spec called @samp{lib} to @samp{old_lib} and
6756 then overrides the previous definition of @samp{lib} with a new one.
6757 The new definition adds in some extra command-line options before
6758 including the text of the old definition.
6759
6760 @dfn{Spec strings} are a list of command-line options to be passed to their
6761 corresponding program. In addition, the spec strings can contain
6762 @samp{%}-prefixed sequences to substitute variable text or to
6763 conditionally insert text into the command line. Using these constructs
6764 it is possible to generate quite complex command lines.
6765
6766 Here is a table of all defined @samp{%}-sequences for spec
6767 strings. Note that spaces are not generated automatically around the
6768 results of expanding these sequences. Therefore you can concatenate them
6769 together or combine them with constant text in a single argument.
6770
6771 @table @code
6772 @item %%
6773 Substitute one @samp{%} into the program name or argument.
6774
6775 @item %i
6776 Substitute the name of the input file being processed.
6777
6778 @item %b
6779 Substitute the basename of the input file being processed.
6780 This is the substring up to (and not including) the last period
6781 and not including the directory.
6782
6783 @item %B
6784 This is the same as @samp{%b}, but include the file suffix (text after
6785 the last period).
6786
6787 @item %d
6788 Marks the argument containing or following the @samp{%d} as a
6789 temporary file name, so that that file will be deleted if GCC exits
6790 successfully. Unlike @samp{%g}, this contributes no text to the
6791 argument.
6792
6793 @item %g@var{suffix}
6794 Substitute a file name that has suffix @var{suffix} and is chosen
6795 once per compilation, and mark the argument in the same way as
6796 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
6797 name is now chosen in a way that is hard to predict even when previously
6798 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6799 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6800 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6801 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6802 was simply substituted with a file name chosen once per compilation,
6803 without regard to any appended suffix (which was therefore treated
6804 just like ordinary text), making such attacks more likely to succeed.
6805
6806 @item %u@var{suffix}
6807 Like @samp{%g}, but generates a new temporary file name even if
6808 @samp{%u@var{suffix}} was already seen.
6809
6810 @item %U@var{suffix}
6811 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6812 new one if there is no such last file name. In the absence of any
6813 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6814 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6815 would involve the generation of two distinct file names, one
6816 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6817 simply substituted with a file name chosen for the previous @samp{%u},
6818 without regard to any appended suffix.
6819
6820 @item %j@var{suffix}
6821 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6822 writable, and if save-temps is off; otherwise, substitute the name
6823 of a temporary file, just like @samp{%u}. This temporary file is not
6824 meant for communication between processes, but rather as a junk
6825 disposal mechanism.
6826
6827 @item %|@var{suffix}
6828 @itemx %m@var{suffix}
6829 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6830 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6831 all. These are the two most common ways to instruct a program that it
6832 should read from standard input or write to standard output. If you
6833 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6834 construct: see for example @file{f/lang-specs.h}.
6835
6836 @item %.@var{SUFFIX}
6837 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6838 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
6839 terminated by the next space or %.
6840
6841 @item %w
6842 Marks the argument containing or following the @samp{%w} as the
6843 designated output file of this compilation. This puts the argument
6844 into the sequence of arguments that @samp{%o} will substitute later.
6845
6846 @item %o
6847 Substitutes the names of all the output files, with spaces
6848 automatically placed around them. You should write spaces
6849 around the @samp{%o} as well or the results are undefined.
6850 @samp{%o} is for use in the specs for running the linker.
6851 Input files whose names have no recognized suffix are not compiled
6852 at all, but they are included among the output files, so they will
6853 be linked.
6854
6855 @item %O
6856 Substitutes the suffix for object files. Note that this is
6857 handled specially when it immediately follows @samp{%g, %u, or %U},
6858 because of the need for those to form complete file names. The
6859 handling is such that @samp{%O} is treated exactly as if it had already
6860 been substituted, except that @samp{%g, %u, and %U} do not currently
6861 support additional @var{suffix} characters following @samp{%O} as they would
6862 following, for example, @samp{.o}.
6863
6864 @item %p
6865 Substitutes the standard macro predefinitions for the
6866 current target machine. Use this when running @code{cpp}.
6867
6868 @item %P
6869 Like @samp{%p}, but puts @samp{__} before and after the name of each
6870 predefined macro, except for macros that start with @samp{__} or with
6871 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
6872 C@.
6873
6874 @item %I
6875 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6876 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
6877 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6878 and @option{-imultilib} as necessary.
6879
6880 @item %s
6881 Current argument is the name of a library or startup file of some sort.
6882 Search for that file in a standard list of directories and substitute
6883 the full name found.
6884
6885 @item %e@var{str}
6886 Print @var{str} as an error message. @var{str} is terminated by a newline.
6887 Use this when inconsistent options are detected.
6888
6889 @item %(@var{name})
6890 Substitute the contents of spec string @var{name} at this point.
6891
6892 @item %[@var{name}]
6893 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6894
6895 @item %x@{@var{option}@}
6896 Accumulate an option for @samp{%X}.
6897
6898 @item %X
6899 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6900 spec string.
6901
6902 @item %Y
6903 Output the accumulated assembler options specified by @option{-Wa}.
6904
6905 @item %Z
6906 Output the accumulated preprocessor options specified by @option{-Wp}.
6907
6908 @item %a
6909 Process the @code{asm} spec. This is used to compute the
6910 switches to be passed to the assembler.
6911
6912 @item %A
6913 Process the @code{asm_final} spec. This is a spec string for
6914 passing switches to an assembler post-processor, if such a program is
6915 needed.
6916
6917 @item %l
6918 Process the @code{link} spec. This is the spec for computing the
6919 command line passed to the linker. Typically it will make use of the
6920 @samp{%L %G %S %D and %E} sequences.
6921
6922 @item %D
6923 Dump out a @option{-L} option for each directory that GCC believes might
6924 contain startup files. If the target supports multilibs then the
6925 current multilib directory will be prepended to each of these paths.
6926
6927 @item %L
6928 Process the @code{lib} spec. This is a spec string for deciding which
6929 libraries should be included on the command line to the linker.
6930
6931 @item %G
6932 Process the @code{libgcc} spec. This is a spec string for deciding
6933 which GCC support library should be included on the command line to the linker.
6934
6935 @item %S
6936 Process the @code{startfile} spec. This is a spec for deciding which
6937 object files should be the first ones passed to the linker. Typically
6938 this might be a file named @file{crt0.o}.
6939
6940 @item %E
6941 Process the @code{endfile} spec. This is a spec string that specifies
6942 the last object files that will be passed to the linker.
6943
6944 @item %C
6945 Process the @code{cpp} spec. This is used to construct the arguments
6946 to be passed to the C preprocessor.
6947
6948 @item %1
6949 Process the @code{cc1} spec. This is used to construct the options to be
6950 passed to the actual C compiler (@samp{cc1}).
6951
6952 @item %2
6953 Process the @code{cc1plus} spec. This is used to construct the options to be
6954 passed to the actual C++ compiler (@samp{cc1plus}).
6955
6956 @item %*
6957 Substitute the variable part of a matched option. See below.
6958 Note that each comma in the substituted string is replaced by
6959 a single space.
6960
6961 @item %<@code{S}
6962 Remove all occurrences of @code{-S} from the command line. Note---this
6963 command is position dependent. @samp{%} commands in the spec string
6964 before this one will see @code{-S}, @samp{%} commands in the spec string
6965 after this one will not.
6966
6967 @item %:@var{function}(@var{args})
6968 Call the named function @var{function}, passing it @var{args}.
6969 @var{args} is first processed as a nested spec string, then split
6970 into an argument vector in the usual fashion. The function returns
6971 a string which is processed as if it had appeared literally as part
6972 of the current spec.
6973
6974 The following built-in spec functions are provided:
6975
6976 @table @code
6977 @item @code{if-exists}
6978 The @code{if-exists} spec function takes one argument, an absolute
6979 pathname to a file. If the file exists, @code{if-exists} returns the
6980 pathname. Here is a small example of its usage:
6981
6982 @smallexample
6983 *startfile:
6984 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6985 @end smallexample
6986
6987 @item @code{if-exists-else}
6988 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6989 spec function, except that it takes two arguments. The first argument is
6990 an absolute pathname to a file. If the file exists, @code{if-exists-else}
6991 returns the pathname. If it does not exist, it returns the second argument.
6992 This way, @code{if-exists-else} can be used to select one file or another,
6993 based on the existence of the first. Here is a small example of its usage:
6994
6995 @smallexample
6996 *startfile:
6997 crt0%O%s %:if-exists(crti%O%s) \
6998 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6999 @end smallexample
7000
7001 @item @code{replace-outfile}
7002 The @code{replace-outfile} spec function takes two arguments. It looks for the
7003 first argument in the outfiles array and replaces it with the second argument. Here
7004 is a small example of its usage:
7005
7006 @smallexample
7007 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7008 @end smallexample
7009
7010 @end table
7011
7012 @item %@{@code{S}@}
7013 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7014 If that switch was not specified, this substitutes nothing. Note that
7015 the leading dash is omitted when specifying this option, and it is
7016 automatically inserted if the substitution is performed. Thus the spec
7017 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7018 and would output the command line option @option{-foo}.
7019
7020 @item %W@{@code{S}@}
7021 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7022 deleted on failure.
7023
7024 @item %@{@code{S}*@}
7025 Substitutes all the switches specified to GCC whose names start
7026 with @code{-S}, but which also take an argument. This is used for
7027 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7028 GCC considers @option{-o foo} as being
7029 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
7030 text, including the space. Thus two arguments would be generated.
7031
7032 @item %@{@code{S}*&@code{T}*@}
7033 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7034 (the order of @code{S} and @code{T} in the spec is not significant).
7035 There can be any number of ampersand-separated variables; for each the
7036 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
7037
7038 @item %@{@code{S}:@code{X}@}
7039 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7040
7041 @item %@{!@code{S}:@code{X}@}
7042 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7043
7044 @item %@{@code{S}*:@code{X}@}
7045 Substitutes @code{X} if one or more switches whose names start with
7046 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
7047 once, no matter how many such switches appeared. However, if @code{%*}
7048 appears somewhere in @code{X}, then @code{X} will be substituted once
7049 for each matching switch, with the @code{%*} replaced by the part of
7050 that switch that matched the @code{*}.
7051
7052 @item %@{.@code{S}:@code{X}@}
7053 Substitutes @code{X}, if processing a file with suffix @code{S}.
7054
7055 @item %@{!.@code{S}:@code{X}@}
7056 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7057
7058 @item %@{@code{S}|@code{P}:@code{X}@}
7059 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7060 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7061 although they have a stronger binding than the @samp{|}. If @code{%*}
7062 appears in @code{X}, all of the alternatives must be starred, and only
7063 the first matching alternative is substituted.
7064
7065 For example, a spec string like this:
7066
7067 @smallexample
7068 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7069 @end smallexample
7070
7071 will output the following command-line options from the following input
7072 command-line options:
7073
7074 @smallexample
7075 fred.c -foo -baz
7076 jim.d -bar -boggle
7077 -d fred.c -foo -baz -boggle
7078 -d jim.d -bar -baz -boggle
7079 @end smallexample
7080
7081 @item %@{S:X; T:Y; :D@}
7082
7083 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7084 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
7085 be as many clauses as you need. This may be combined with @code{.},
7086 @code{!}, @code{|}, and @code{*} as needed.
7087
7088
7089 @end table
7090
7091 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7092 construct may contain other nested @samp{%} constructs or spaces, or
7093 even newlines. They are processed as usual, as described above.
7094 Trailing white space in @code{X} is ignored. White space may also
7095 appear anywhere on the left side of the colon in these constructs,
7096 except between @code{.} or @code{*} and the corresponding word.
7097
7098 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7099 handled specifically in these constructs. If another value of
7100 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7101 @option{-W} switch is found later in the command line, the earlier
7102 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7103 just one letter, which passes all matching options.
7104
7105 The character @samp{|} at the beginning of the predicate text is used to
7106 indicate that a command should be piped to the following command, but
7107 only if @option{-pipe} is specified.
7108
7109 It is built into GCC which switches take arguments and which do not.
7110 (You might think it would be useful to generalize this to allow each
7111 compiler's spec to say which switches take arguments. But this cannot
7112 be done in a consistent fashion. GCC cannot even decide which input
7113 files have been specified without knowing which switches take arguments,
7114 and it must know which input files to compile in order to tell which
7115 compilers to run).
7116
7117 GCC also knows implicitly that arguments starting in @option{-l} are to be
7118 treated as compiler output files, and passed to the linker in their
7119 proper position among the other output files.
7120
7121 @c man begin OPTIONS
7122
7123 @node Target Options
7124 @section Specifying Target Machine and Compiler Version
7125 @cindex target options
7126 @cindex cross compiling
7127 @cindex specifying machine version
7128 @cindex specifying compiler version and target machine
7129 @cindex compiler version, specifying
7130 @cindex target machine, specifying
7131
7132 The usual way to run GCC is to run the executable called @file{gcc}, or
7133 @file{<machine>-gcc} when cross-compiling, or
7134 @file{<machine>-gcc-<version>} to run a version other than the one that
7135 was installed last. Sometimes this is inconvenient, so GCC provides
7136 options that will switch to another cross-compiler or version.
7137
7138 @table @gcctabopt
7139 @item -b @var{machine}
7140 @opindex b
7141 The argument @var{machine} specifies the target machine for compilation.
7142
7143 The value to use for @var{machine} is the same as was specified as the
7144 machine type when configuring GCC as a cross-compiler. For
7145 example, if a cross-compiler was configured with @samp{configure
7146 arm-elf}, meaning to compile for an arm processor with elf binaries,
7147 then you would specify @option{-b arm-elf} to run that cross compiler.
7148 Because there are other options beginning with @option{-b}, the
7149 configuration must contain a hyphen.
7150
7151 @item -V @var{version}
7152 @opindex V
7153 The argument @var{version} specifies which version of GCC to run.
7154 This is useful when multiple versions are installed. For example,
7155 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7156 @end table
7157
7158 The @option{-V} and @option{-b} options work by running the
7159 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7160 use them if you can just run that directly.
7161
7162 @node Submodel Options
7163 @section Hardware Models and Configurations
7164 @cindex submodel options
7165 @cindex specifying hardware config
7166 @cindex hardware models and configurations, specifying
7167 @cindex machine dependent options
7168
7169 Earlier we discussed the standard option @option{-b} which chooses among
7170 different installed compilers for completely different target
7171 machines, such as VAX vs.@: 68000 vs.@: 80386.
7172
7173 In addition, each of these target machine types can have its own
7174 special options, starting with @samp{-m}, to choose among various
7175 hardware models or configurations---for example, 68010 vs 68020,
7176 floating coprocessor or none. A single installed version of the
7177 compiler can compile for any model or configuration, according to the
7178 options specified.
7179
7180 Some configurations of the compiler also support additional special
7181 options, usually for compatibility with other compilers on the same
7182 platform.
7183
7184 @c This list is ordered alphanumerically by subsection name.
7185 @c It should be the same order and spelling as these options are listed
7186 @c in Machine Dependent Options
7187
7188 @menu
7189 * ARC Options::
7190 * ARM Options::
7191 * AVR Options::
7192 * Blackfin Options::
7193 * CRIS Options::
7194 * CRX Options::
7195 * Darwin Options::
7196 * DEC Alpha Options::
7197 * DEC Alpha/VMS Options::
7198 * FRV Options::
7199 * GNU/Linux Options::
7200 * H8/300 Options::
7201 * HPPA Options::
7202 * i386 and x86-64 Options::
7203 * IA-64 Options::
7204 * M32C Options::
7205 * M32R/D Options::
7206 * M680x0 Options::
7207 * M68hc1x Options::
7208 * MCore Options::
7209 * MIPS Options::
7210 * MMIX Options::
7211 * MN10300 Options::
7212 * MT Options::
7213 * PDP-11 Options::
7214 * PowerPC Options::
7215 * RS/6000 and PowerPC Options::
7216 * S/390 and zSeries Options::
7217 * SH Options::
7218 * SPARC Options::
7219 * System V Options::
7220 * TMS320C3x/C4x Options::
7221 * V850 Options::
7222 * VAX Options::
7223 * x86-64 Options::
7224 * Xstormy16 Options::
7225 * Xtensa Options::
7226 * zSeries Options::
7227 @end menu
7228
7229 @node ARC Options
7230 @subsection ARC Options
7231 @cindex ARC Options
7232
7233 These options are defined for ARC implementations:
7234
7235 @table @gcctabopt
7236 @item -EL
7237 @opindex EL
7238 Compile code for little endian mode. This is the default.
7239
7240 @item -EB
7241 @opindex EB
7242 Compile code for big endian mode.
7243
7244 @item -mmangle-cpu
7245 @opindex mmangle-cpu
7246 Prepend the name of the cpu to all public symbol names.
7247 In multiple-processor systems, there are many ARC variants with different
7248 instruction and register set characteristics. This flag prevents code
7249 compiled for one cpu to be linked with code compiled for another.
7250 No facility exists for handling variants that are ``almost identical''.
7251 This is an all or nothing option.
7252
7253 @item -mcpu=@var{cpu}
7254 @opindex mcpu
7255 Compile code for ARC variant @var{cpu}.
7256 Which variants are supported depend on the configuration.
7257 All variants support @option{-mcpu=base}, this is the default.
7258
7259 @item -mtext=@var{text-section}
7260 @itemx -mdata=@var{data-section}
7261 @itemx -mrodata=@var{readonly-data-section}
7262 @opindex mtext
7263 @opindex mdata
7264 @opindex mrodata
7265 Put functions, data, and readonly data in @var{text-section},
7266 @var{data-section}, and @var{readonly-data-section} respectively
7267 by default. This can be overridden with the @code{section} attribute.
7268 @xref{Variable Attributes}.
7269
7270 @end table
7271
7272 @node ARM Options
7273 @subsection ARM Options
7274 @cindex ARM options
7275
7276 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7277 architectures:
7278
7279 @table @gcctabopt
7280 @item -mabi=@var{name}
7281 @opindex mabi
7282 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
7283 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7284
7285 @item -mapcs-frame
7286 @opindex mapcs-frame
7287 Generate a stack frame that is compliant with the ARM Procedure Call
7288 Standard for all functions, even if this is not strictly necessary for
7289 correct execution of the code. Specifying @option{-fomit-frame-pointer}
7290 with this option will cause the stack frames not to be generated for
7291 leaf functions. The default is @option{-mno-apcs-frame}.
7292
7293 @item -mapcs
7294 @opindex mapcs
7295 This is a synonym for @option{-mapcs-frame}.
7296
7297 @ignore
7298 @c not currently implemented
7299 @item -mapcs-stack-check
7300 @opindex mapcs-stack-check
7301 Generate code to check the amount of stack space available upon entry to
7302 every function (that actually uses some stack space). If there is
7303 insufficient space available then either the function
7304 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7305 called, depending upon the amount of stack space required. The run time
7306 system is required to provide these functions. The default is
7307 @option{-mno-apcs-stack-check}, since this produces smaller code.
7308
7309 @c not currently implemented
7310 @item -mapcs-float
7311 @opindex mapcs-float
7312 Pass floating point arguments using the float point registers. This is
7313 one of the variants of the APCS@. This option is recommended if the
7314 target hardware has a floating point unit or if a lot of floating point
7315 arithmetic is going to be performed by the code. The default is
7316 @option{-mno-apcs-float}, since integer only code is slightly increased in
7317 size if @option{-mapcs-float} is used.
7318
7319 @c not currently implemented
7320 @item -mapcs-reentrant
7321 @opindex mapcs-reentrant
7322 Generate reentrant, position independent code. The default is
7323 @option{-mno-apcs-reentrant}.
7324 @end ignore
7325
7326 @item -mthumb-interwork
7327 @opindex mthumb-interwork
7328 Generate code which supports calling between the ARM and Thumb
7329 instruction sets. Without this option the two instruction sets cannot
7330 be reliably used inside one program. The default is
7331 @option{-mno-thumb-interwork}, since slightly larger code is generated
7332 when @option{-mthumb-interwork} is specified.
7333
7334 @item -mno-sched-prolog
7335 @opindex mno-sched-prolog
7336 Prevent the reordering of instructions in the function prolog, or the
7337 merging of those instruction with the instructions in the function's
7338 body. This means that all functions will start with a recognizable set
7339 of instructions (or in fact one of a choice from a small set of
7340 different function prologues), and this information can be used to
7341 locate the start if functions inside an executable piece of code. The
7342 default is @option{-msched-prolog}.
7343
7344 @item -mhard-float
7345 @opindex mhard-float
7346 Generate output containing floating point instructions. This is the
7347 default.
7348
7349 @item -msoft-float
7350 @opindex msoft-float
7351 Generate output containing library calls for floating point.
7352 @strong{Warning:} the requisite libraries are not available for all ARM
7353 targets. Normally the facilities of the machine's usual C compiler are
7354 used, but this cannot be done directly in cross-compilation. You must make
7355 your own arrangements to provide suitable library functions for
7356 cross-compilation.
7357
7358 @option{-msoft-float} changes the calling convention in the output file;
7359 therefore, it is only useful if you compile @emph{all} of a program with
7360 this option. In particular, you need to compile @file{libgcc.a}, the
7361 library that comes with GCC, with @option{-msoft-float} in order for
7362 this to work.
7363
7364 @item -mfloat-abi=@var{name}
7365 @opindex mfloat-abi
7366 Specifies which ABI to use for floating point values. Permissible values
7367 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7368
7369 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7370 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
7371 of floating point instructions, but still uses the soft-float calling
7372 conventions.
7373
7374 @item -mlittle-endian
7375 @opindex mlittle-endian
7376 Generate code for a processor running in little-endian mode. This is
7377 the default for all standard configurations.
7378
7379 @item -mbig-endian
7380 @opindex mbig-endian
7381 Generate code for a processor running in big-endian mode; the default is
7382 to compile code for a little-endian processor.
7383
7384 @item -mwords-little-endian
7385 @opindex mwords-little-endian
7386 This option only applies when generating code for big-endian processors.
7387 Generate code for a little-endian word order but a big-endian byte
7388 order. That is, a byte order of the form @samp{32107654}. Note: this
7389 option should only be used if you require compatibility with code for
7390 big-endian ARM processors generated by versions of the compiler prior to
7391 2.8.
7392
7393 @item -mcpu=@var{name}
7394 @opindex mcpu
7395 This specifies the name of the target ARM processor. GCC uses this name
7396 to determine what kind of instructions it can emit when generating
7397 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7398 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7399 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7400 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7401 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7402 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7403 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7404 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7405 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7406 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7407 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7408 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7409 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7410 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7411 @samp{ep9312}.
7412
7413 @itemx -mtune=@var{name}
7414 @opindex mtune
7415 This option is very similar to the @option{-mcpu=} option, except that
7416 instead of specifying the actual target processor type, and hence
7417 restricting which instructions can be used, it specifies that GCC should
7418 tune the performance of the code as if the target were of the type
7419 specified in this option, but still choosing the instructions that it
7420 will generate based on the cpu specified by a @option{-mcpu=} option.
7421 For some ARM implementations better performance can be obtained by using
7422 this option.
7423
7424 @item -march=@var{name}
7425 @opindex march
7426 This specifies the name of the target ARM architecture. GCC uses this
7427 name to determine what kind of instructions it can emit when generating
7428 assembly code. This option can be used in conjunction with or instead
7429 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7430 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7431 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7432 @samp{iwmmxt}, @samp{ep9312}.
7433
7434 @item -mfpu=@var{name}
7435 @itemx -mfpe=@var{number}
7436 @itemx -mfp=@var{number}
7437 @opindex mfpu
7438 @opindex mfpe
7439 @opindex mfp
7440 This specifies what floating point hardware (or hardware emulation) is
7441 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7442 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7443 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7444 with older versions of GCC@.
7445
7446 If @option{-msoft-float} is specified this specifies the format of
7447 floating point values.
7448
7449 @item -mstructure-size-boundary=@var{n}
7450 @opindex mstructure-size-boundary
7451 The size of all structures and unions will be rounded up to a multiple
7452 of the number of bits set by this option. Permissible values are 8, 32
7453 and 64. The default value varies for different toolchains. For the COFF
7454 targeted toolchain the default value is 8. A value of 64 is only allowed
7455 if the underlying ABI supports it.
7456
7457 Specifying the larger number can produce faster, more efficient code, but
7458 can also increase the size of the program. Different values are potentially
7459 incompatible. Code compiled with one value cannot necessarily expect to
7460 work with code or libraries compiled with another value, if they exchange
7461 information using structures or unions.
7462
7463 @item -mabort-on-noreturn
7464 @opindex mabort-on-noreturn
7465 Generate a call to the function @code{abort} at the end of a
7466 @code{noreturn} function. It will be executed if the function tries to
7467 return.
7468
7469 @item -mlong-calls
7470 @itemx -mno-long-calls
7471 @opindex mlong-calls
7472 @opindex mno-long-calls
7473 Tells the compiler to perform function calls by first loading the
7474 address of the function into a register and then performing a subroutine
7475 call on this register. This switch is needed if the target function
7476 will lie outside of the 64 megabyte addressing range of the offset based
7477 version of subroutine call instruction.
7478
7479 Even if this switch is enabled, not all function calls will be turned
7480 into long calls. The heuristic is that static functions, functions
7481 which have the @samp{short-call} attribute, functions that are inside
7482 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7483 definitions have already been compiled within the current compilation
7484 unit, will not be turned into long calls. The exception to this rule is
7485 that weak function definitions, functions with the @samp{long-call}
7486 attribute or the @samp{section} attribute, and functions that are within
7487 the scope of a @samp{#pragma long_calls} directive, will always be
7488 turned into long calls.
7489
7490 This feature is not enabled by default. Specifying
7491 @option{-mno-long-calls} will restore the default behavior, as will
7492 placing the function calls within the scope of a @samp{#pragma
7493 long_calls_off} directive. Note these switches have no effect on how
7494 the compiler generates code to handle function calls via function
7495 pointers.
7496
7497 @item -mnop-fun-dllimport
7498 @opindex mnop-fun-dllimport
7499 Disable support for the @code{dllimport} attribute.
7500
7501 @item -msingle-pic-base
7502 @opindex msingle-pic-base
7503 Treat the register used for PIC addressing as read-only, rather than
7504 loading it in the prologue for each function. The run-time system is
7505 responsible for initializing this register with an appropriate value
7506 before execution begins.
7507
7508 @item -mpic-register=@var{reg}
7509 @opindex mpic-register
7510 Specify the register to be used for PIC addressing. The default is R10
7511 unless stack-checking is enabled, when R9 is used.
7512
7513 @item -mcirrus-fix-invalid-insns
7514 @opindex mcirrus-fix-invalid-insns
7515 @opindex mno-cirrus-fix-invalid-insns
7516 Insert NOPs into the instruction stream to in order to work around
7517 problems with invalid Maverick instruction combinations. This option
7518 is only valid if the @option{-mcpu=ep9312} option has been used to
7519 enable generation of instructions for the Cirrus Maverick floating
7520 point co-processor. This option is not enabled by default, since the
7521 problem is only present in older Maverick implementations. The default
7522 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7523 switch.
7524
7525 @item -mpoke-function-name
7526 @opindex mpoke-function-name
7527 Write the name of each function into the text section, directly
7528 preceding the function prologue. The generated code is similar to this:
7529
7530 @smallexample
7531 t0
7532 .ascii "arm_poke_function_name", 0
7533 .align
7534 t1
7535 .word 0xff000000 + (t1 - t0)
7536 arm_poke_function_name
7537 mov ip, sp
7538 stmfd sp!, @{fp, ip, lr, pc@}
7539 sub fp, ip, #4
7540 @end smallexample
7541
7542 When performing a stack backtrace, code can inspect the value of
7543 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
7544 location @code{pc - 12} and the top 8 bits are set, then we know that
7545 there is a function name embedded immediately preceding this location
7546 and has length @code{((pc[-3]) & 0xff000000)}.
7547
7548 @item -mthumb
7549 @opindex mthumb
7550 Generate code for the 16-bit Thumb instruction set. The default is to
7551 use the 32-bit ARM instruction set.
7552
7553 @item -mtpcs-frame
7554 @opindex mtpcs-frame
7555 Generate a stack frame that is compliant with the Thumb Procedure Call
7556 Standard for all non-leaf functions. (A leaf function is one that does
7557 not call any other functions.) The default is @option{-mno-tpcs-frame}.
7558
7559 @item -mtpcs-leaf-frame
7560 @opindex mtpcs-leaf-frame
7561 Generate a stack frame that is compliant with the Thumb Procedure Call
7562 Standard for all leaf functions. (A leaf function is one that does
7563 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
7564
7565 @item -mcallee-super-interworking
7566 @opindex mcallee-super-interworking
7567 Gives all externally visible functions in the file being compiled an ARM
7568 instruction set header which switches to Thumb mode before executing the
7569 rest of the function. This allows these functions to be called from
7570 non-interworking code.
7571
7572 @item -mcaller-super-interworking
7573 @opindex mcaller-super-interworking
7574 Allows calls via function pointers (including virtual functions) to
7575 execute correctly regardless of whether the target code has been
7576 compiled for interworking or not. There is a small overhead in the cost
7577 of executing a function pointer if this option is enabled.
7578
7579 @item -mtp=@var{name}
7580 @opindex mtp
7581 Specify the access model for the thread local storage pointer. The valid
7582 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7583 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7584 (supported in the arm6k architecture), and @option{auto}, which uses the
7585 best available method for the selected processor. The default setting is
7586 @option{auto}.
7587
7588 @end table
7589
7590 @node AVR Options
7591 @subsection AVR Options
7592 @cindex AVR Options
7593
7594 These options are defined for AVR implementations:
7595
7596 @table @gcctabopt
7597 @item -mmcu=@var{mcu}
7598 @opindex mmcu
7599 Specify ATMEL AVR instruction set or MCU type.
7600
7601 Instruction set avr1 is for the minimal AVR core, not supported by the C
7602 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7603 attiny11, attiny12, attiny15, attiny28).
7604
7605 Instruction set avr2 (default) is for the classic AVR core with up to
7606 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7607 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7608 at90c8534, at90s8535).
7609
7610 Instruction set avr3 is for the classic AVR core with up to 128K program
7611 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7612
7613 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7614 memory space (MCU types: atmega8, atmega83, atmega85).
7615
7616 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7617 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7618 atmega64, atmega128, at43usb355, at94k).
7619
7620 @item -msize
7621 @opindex msize
7622 Output instruction sizes to the asm file.
7623
7624 @item -minit-stack=@var{N}
7625 @opindex minit-stack
7626 Specify the initial stack address, which may be a symbol or numeric value,
7627 @samp{__stack} is the default.
7628
7629 @item -mno-interrupts
7630 @opindex mno-interrupts
7631 Generated code is not compatible with hardware interrupts.
7632 Code size will be smaller.
7633
7634 @item -mcall-prologues
7635 @opindex mcall-prologues
7636 Functions prologues/epilogues expanded as call to appropriate
7637 subroutines. Code size will be smaller.
7638
7639 @item -mno-tablejump
7640 @opindex mno-tablejump
7641 Do not generate tablejump insns which sometimes increase code size.
7642
7643 @item -mtiny-stack
7644 @opindex mtiny-stack
7645 Change only the low 8 bits of the stack pointer.
7646
7647 @item -mint8
7648 @opindex mint8
7649 Assume int to be 8 bit integer. This affects the sizes of all types: A
7650 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7651 and long long will be 4 bytes. Please note that this option does not
7652 comply to the C standards, but it will provide you with smaller code
7653 size.
7654 @end table
7655
7656 @node Blackfin Options
7657 @subsection Blackfin Options
7658 @cindex Blackfin Options
7659
7660 @table @gcctabopt
7661 @item -momit-leaf-frame-pointer
7662 @opindex momit-leaf-frame-pointer
7663 Don't keep the frame pointer in a register for leaf functions. This
7664 avoids the instructions to save, set up and restore frame pointers and
7665 makes an extra register available in leaf functions. The option
7666 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7667 which might make debugging harder.
7668
7669 @item -mspecld-anomaly
7670 @opindex mspecld-anomaly
7671 When enabled, the compiler will ensure that the generated code does not
7672 contain speculative loads after jump instructions. This option is enabled
7673 by default.
7674
7675 @item -mno-specld-anomaly
7676 @opindex mno-specld-anomaly
7677 Don't generate extra code to prevent speculative loads from occurring.
7678
7679 @item -mcsync-anomaly
7680 @opindex mcsync-anomaly
7681 When enabled, the compiler will ensure that the generated code does not
7682 contain CSYNC or SSYNC instructions too soon after conditional branches.
7683 This option is enabled by default.
7684
7685 @item -mno-csync-anomaly
7686 @opindex mno-csync-anomaly
7687 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7688 occurring too soon after a conditional branch.
7689
7690 @item -mlow-64k
7691 @opindex mlow-64k
7692 When enabled, the compiler is free to take advantage of the knowledge that
7693 the entire program fits into the low 64k of memory.
7694
7695 @item -mno-low-64k
7696 @opindex mno-low-64k
7697 Assume that the program is arbitrarily large. This is the default.
7698
7699 @item -mid-shared-library
7700 @opindex mid-shared-library
7701 Generate code that supports shared libraries via the library ID method.
7702 This allows for execute in place and shared libraries in an environment
7703 without virtual memory management. This option implies @option{-fPIC}.
7704
7705 @item -mno-id-shared-library
7706 @opindex mno-id-shared-library
7707 Generate code that doesn't assume ID based shared libraries are being used.
7708 This is the default.
7709
7710 @item -mshared-library-id=n
7711 @opindex mshared-library-id
7712 Specified the identification number of the ID based shared library being
7713 compiled. Specifying a value of 0 will generate more compact code, specifying
7714 other values will force the allocation of that number to the current
7715 library but is no more space or time efficient than omitting this option.
7716
7717 @item -mlong-calls
7718 @itemx -mno-long-calls
7719 @opindex mlong-calls
7720 @opindex mno-long-calls
7721 Tells the compiler to perform function calls by first loading the
7722 address of the function into a register and then performing a subroutine
7723 call on this register. This switch is needed if the target function
7724 will lie outside of the 24 bit addressing range of the offset based
7725 version of subroutine call instruction.
7726
7727 This feature is not enabled by default. Specifying
7728 @option{-mno-long-calls} will restore the default behavior. Note these
7729 switches have no effect on how the compiler generates code to handle
7730 function calls via function pointers.
7731 @end table
7732
7733 @node CRIS Options
7734 @subsection CRIS Options
7735 @cindex CRIS Options
7736
7737 These options are defined specifically for the CRIS ports.
7738
7739 @table @gcctabopt
7740 @item -march=@var{architecture-type}
7741 @itemx -mcpu=@var{architecture-type}
7742 @opindex march
7743 @opindex mcpu
7744 Generate code for the specified architecture. The choices for
7745 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7746 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7747 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7748 @samp{v10}.
7749
7750 @item -mtune=@var{architecture-type}
7751 @opindex mtune
7752 Tune to @var{architecture-type} everything applicable about the generated
7753 code, except for the ABI and the set of available instructions. The
7754 choices for @var{architecture-type} are the same as for
7755 @option{-march=@var{architecture-type}}.
7756
7757 @item -mmax-stack-frame=@var{n}
7758 @opindex mmax-stack-frame
7759 Warn when the stack frame of a function exceeds @var{n} bytes.
7760
7761 @item -melinux-stacksize=@var{n}
7762 @opindex melinux-stacksize
7763 Only available with the @samp{cris-axis-aout} target. Arranges for
7764 indications in the program to the kernel loader that the stack of the
7765 program should be set to @var{n} bytes.
7766
7767 @item -metrax4
7768 @itemx -metrax100
7769 @opindex metrax4
7770 @opindex metrax100
7771 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7772 @option{-march=v3} and @option{-march=v8} respectively.
7773
7774 @item -mmul-bug-workaround
7775 @itemx -mno-mul-bug-workaround
7776 @opindex mmul-bug-workaround
7777 @opindex mno-mul-bug-workaround
7778 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7779 models where it applies. This option is active by default.
7780
7781 @item -mpdebug
7782 @opindex mpdebug
7783 Enable CRIS-specific verbose debug-related information in the assembly
7784 code. This option also has the effect to turn off the @samp{#NO_APP}
7785 formatted-code indicator to the assembler at the beginning of the
7786 assembly file.
7787
7788 @item -mcc-init
7789 @opindex mcc-init
7790 Do not use condition-code results from previous instruction; always emit
7791 compare and test instructions before use of condition codes.
7792
7793 @item -mno-side-effects
7794 @opindex mno-side-effects
7795 Do not emit instructions with side-effects in addressing modes other than
7796 post-increment.
7797
7798 @item -mstack-align
7799 @itemx -mno-stack-align
7800 @itemx -mdata-align
7801 @itemx -mno-data-align
7802 @itemx -mconst-align
7803 @itemx -mno-const-align
7804 @opindex mstack-align
7805 @opindex mno-stack-align
7806 @opindex mdata-align
7807 @opindex mno-data-align
7808 @opindex mconst-align
7809 @opindex mno-const-align
7810 These options (no-options) arranges (eliminate arrangements) for the
7811 stack-frame, individual data and constants to be aligned for the maximum
7812 single data access size for the chosen CPU model. The default is to
7813 arrange for 32-bit alignment. ABI details such as structure layout are
7814 not affected by these options.
7815
7816 @item -m32-bit
7817 @itemx -m16-bit
7818 @itemx -m8-bit
7819 @opindex m32-bit
7820 @opindex m16-bit
7821 @opindex m8-bit
7822 Similar to the stack- data- and const-align options above, these options
7823 arrange for stack-frame, writable data and constants to all be 32-bit,
7824 16-bit or 8-bit aligned. The default is 32-bit alignment.
7825
7826 @item -mno-prologue-epilogue
7827 @itemx -mprologue-epilogue
7828 @opindex mno-prologue-epilogue
7829 @opindex mprologue-epilogue
7830 With @option{-mno-prologue-epilogue}, the normal function prologue and
7831 epilogue that sets up the stack-frame are omitted and no return
7832 instructions or return sequences are generated in the code. Use this
7833 option only together with visual inspection of the compiled code: no
7834 warnings or errors are generated when call-saved registers must be saved,
7835 or storage for local variable needs to be allocated.
7836
7837 @item -mno-gotplt
7838 @itemx -mgotplt
7839 @opindex mno-gotplt
7840 @opindex mgotplt
7841 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7842 instruction sequences that load addresses for functions from the PLT part
7843 of the GOT rather than (traditional on other architectures) calls to the
7844 PLT@. The default is @option{-mgotplt}.
7845
7846 @item -maout
7847 @opindex maout
7848 Legacy no-op option only recognized with the cris-axis-aout target.
7849
7850 @item -melf
7851 @opindex melf
7852 Legacy no-op option only recognized with the cris-axis-elf and
7853 cris-axis-linux-gnu targets.
7854
7855 @item -melinux
7856 @opindex melinux
7857 Only recognized with the cris-axis-aout target, where it selects a
7858 GNU/linux-like multilib, include files and instruction set for
7859 @option{-march=v8}.
7860
7861 @item -mlinux
7862 @opindex mlinux
7863 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7864
7865 @item -sim
7866 @opindex sim
7867 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7868 to link with input-output functions from a simulator library. Code,
7869 initialized data and zero-initialized data are allocated consecutively.
7870
7871 @item -sim2
7872 @opindex sim2
7873 Like @option{-sim}, but pass linker options to locate initialized data at
7874 0x40000000 and zero-initialized data at 0x80000000.
7875 @end table
7876
7877 @node CRX Options
7878 @subsection CRX Options
7879 @cindex CRX Options
7880
7881 These options are defined specifically for the CRX ports.
7882
7883 @table @gcctabopt
7884
7885 @item -mmac
7886 @opindex mmac
7887 Enable the use of multiply-accumulate instructions. Disabled by default.
7888
7889 @item -mpush-args
7890 @opindex mpush-args
7891 Push instructions will be used to pass outgoing arguments when functions
7892 are called. Enabled by default.
7893 @end table
7894
7895 @node Darwin Options
7896 @subsection Darwin Options
7897 @cindex Darwin options
7898
7899 These options are defined for all architectures running the Darwin operating
7900 system.
7901
7902 FSF GCC on Darwin does not create ``fat'' object files; it will create
7903 an object file for the single architecture that it was built to
7904 target. Apple's GCC on Darwin does create ``fat'' files if multiple
7905 @option{-arch} options are used; it does so by running the compiler or
7906 linker multiple times and joining the results together with
7907 @file{lipo}.
7908
7909 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7910 @samp{i686}) is determined by the flags that specify the ISA
7911 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
7912 @option{-force_cpusubtype_ALL} option can be used to override this.
7913
7914 The Darwin tools vary in their behavior when presented with an ISA
7915 mismatch. The assembler, @file{as}, will only permit instructions to
7916 be used that are valid for the subtype of the file it is generating,
7917 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7918 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7919 and print an error if asked to create a shared library with a less
7920 restrictive subtype than its input files (for instance, trying to put
7921 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7922 for executables, @file{ld}, will quietly give the executable the most
7923 restrictive subtype of any of its input files.
7924
7925 @table @gcctabopt
7926 @item -F@var{dir}
7927 @opindex F
7928 Add the framework directory @var{dir} to the head of the list of
7929 directories to be searched for header files. These directories are
7930 interleaved with those specified by @option{-I} options and are
7931 scanned in a left-to-right order.
7932
7933 A framework directory is a directory with frameworks in it. A
7934 framework is a directory with a @samp{"Headers"} and/or
7935 @samp{"PrivateHeaders"} directory contained directly in it that ends
7936 in @samp{".framework"}. The name of a framework is the name of this
7937 directory excluding the @samp{".framework"}. Headers associated with
7938 the framework are found in one of those two directories, with
7939 @samp{"Headers"} being searched first. A subframework is a framework
7940 directory that is in a framework's @samp{"Frameworks"} directory.
7941 Includes of subframework headers can only appear in a header of a
7942 framework that contains the subframework, or in a sibling subframework
7943 header. Two subframeworks are siblings if they occur in the same
7944 framework. A subframework should not have the same name as a
7945 framework, a warning will be issued if this is violated. Currently a
7946 subframework cannot have subframeworks, in the future, the mechanism
7947 may be extended to support this. The standard frameworks can be found
7948 in @samp{"/System/Library/Frameworks"} and
7949 @samp{"/Library/Frameworks"}. An example include looks like
7950 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7951 the name of the framework and header.h is found in the
7952 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7953
7954 @item -gused
7955 @opindex -gused
7956 Emit debugging information for symbols that are used. For STABS
7957 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7958 This is by default ON@.
7959
7960 @item -gfull
7961 @opindex -gfull
7962 Emit debugging information for all symbols and types.
7963
7964 @item -mmacosx-version-min=@var{version}
7965 The earliest version of MacOS X that this executable will run on
7966 is @var{version}. Typical values of @var{version} include @code{10.1},
7967 @code{10.2}, and @code{10.3.9}.
7968
7969 The default for this option is to make choices that seem to be most
7970 useful.
7971
7972 @item -mone-byte-bool
7973 @opindex -mone-byte-bool
7974 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7975 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7976 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7977 option has no effect on x86.
7978
7979 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7980 to generate code that is not binary compatible with code generated
7981 without that switch. Using this switch may require recompiling all
7982 other modules in a program, including system libraries. Use this
7983 switch to conform to a non-default data model.
7984
7985 @item -mfix-and-continue
7986 @itemx -ffix-and-continue
7987 @itemx -findirect-data
7988 @opindex mfix-and-continue
7989 @opindex ffix-and-continue
7990 @opindex findirect-data
7991 Generate code suitable for fast turn around development. Needed to
7992 enable gdb to dynamically load @code{.o} files into already running
7993 programs. @option{-findirect-data} and @option{-ffix-and-continue}
7994 are provided for backwards compatibility.
7995
7996 @item -all_load
7997 @opindex all_load
7998 Loads all members of static archive libraries.
7999 See man ld(1) for more information.
8000
8001 @item -arch_errors_fatal
8002 @opindex arch_errors_fatal
8003 Cause the errors having to do with files that have the wrong architecture
8004 to be fatal.
8005
8006 @item -bind_at_load
8007 @opindex bind_at_load
8008 Causes the output file to be marked such that the dynamic linker will
8009 bind all undefined references when the file is loaded or launched.
8010
8011 @item -bundle
8012 @opindex bundle
8013 Produce a Mach-o bundle format file.
8014 See man ld(1) for more information.
8015
8016 @item -bundle_loader @var{executable}
8017 @opindex bundle_loader
8018 This option specifies the @var{executable} that will be loading the build
8019 output file being linked. See man ld(1) for more information.
8020
8021 @item -dynamiclib
8022 @opindex -dynamiclib
8023 When passed this option, GCC will produce a dynamic library instead of
8024 an executable when linking, using the Darwin @file{libtool} command.
8025
8026 @item -force_cpusubtype_ALL
8027 @opindex -force_cpusubtype_ALL
8028 This causes GCC's output file to have the @var{ALL} subtype, instead of
8029 one controlled by the @option{-mcpu} or @option{-march} option.
8030
8031 @item -allowable_client @var{client_name}
8032 @itemx -client_name
8033 @itemx -compatibility_version
8034 @itemx -current_version
8035 @itemx -dead_strip
8036 @itemx -dependency-file
8037 @itemx -dylib_file
8038 @itemx -dylinker_install_name
8039 @itemx -dynamic
8040 @itemx -exported_symbols_list
8041 @itemx -filelist
8042 @itemx -flat_namespace
8043 @itemx -force_flat_namespace
8044 @itemx -headerpad_max_install_names
8045 @itemx -image_base
8046 @itemx -init
8047 @itemx -install_name
8048 @itemx -keep_private_externs
8049 @itemx -multi_module
8050 @itemx -multiply_defined
8051 @itemx -multiply_defined_unused
8052 @itemx -noall_load
8053 @itemx -no_dead_strip_inits_and_terms
8054 @itemx -nofixprebinding
8055 @itemx -nomultidefs
8056 @itemx -noprebind
8057 @itemx -noseglinkedit
8058 @itemx -pagezero_size
8059 @itemx -prebind
8060 @itemx -prebind_all_twolevel_modules
8061 @itemx -private_bundle
8062 @itemx -read_only_relocs
8063 @itemx -sectalign
8064 @itemx -sectobjectsymbols
8065 @itemx -whyload
8066 @itemx -seg1addr
8067 @itemx -sectcreate
8068 @itemx -sectobjectsymbols
8069 @itemx -sectorder
8070 @itemx -segaddr
8071 @itemx -segs_read_only_addr
8072 @itemx -segs_read_write_addr
8073 @itemx -seg_addr_table
8074 @itemx -seg_addr_table_filename
8075 @itemx -seglinkedit
8076 @itemx -segprot
8077 @itemx -segs_read_only_addr
8078 @itemx -segs_read_write_addr
8079 @itemx -single_module
8080 @itemx -static
8081 @itemx -sub_library
8082 @itemx -sub_umbrella
8083 @itemx -twolevel_namespace
8084 @itemx -umbrella
8085 @itemx -undefined
8086 @itemx -unexported_symbols_list
8087 @itemx -weak_reference_mismatches
8088 @itemx -whatsloaded
8089
8090 @opindex allowable_client
8091 @opindex client_name
8092 @opindex compatibility_version
8093 @opindex current_version
8094 @opindex dead_strip
8095 @opindex dependency-file
8096 @opindex dylib_file
8097 @opindex dylinker_install_name
8098 @opindex dynamic
8099 @opindex exported_symbols_list
8100 @opindex filelist
8101 @opindex flat_namespace
8102 @opindex force_flat_namespace
8103 @opindex headerpad_max_install_names
8104 @opindex image_base
8105 @opindex init
8106 @opindex install_name
8107 @opindex keep_private_externs
8108 @opindex multi_module
8109 @opindex multiply_defined
8110 @opindex multiply_defined_unused
8111 @opindex noall_load
8112 @opindex no_dead_strip_inits_and_terms
8113 @opindex nofixprebinding
8114 @opindex nomultidefs
8115 @opindex noprebind
8116 @opindex noseglinkedit
8117 @opindex pagezero_size
8118 @opindex prebind
8119 @opindex prebind_all_twolevel_modules
8120 @opindex private_bundle
8121 @opindex read_only_relocs
8122 @opindex sectalign
8123 @opindex sectobjectsymbols
8124 @opindex whyload
8125 @opindex seg1addr
8126 @opindex sectcreate
8127 @opindex sectobjectsymbols
8128 @opindex sectorder
8129 @opindex segaddr
8130 @opindex segs_read_only_addr
8131 @opindex segs_read_write_addr
8132 @opindex seg_addr_table
8133 @opindex seg_addr_table_filename
8134 @opindex seglinkedit
8135 @opindex segprot
8136 @opindex segs_read_only_addr
8137 @opindex segs_read_write_addr
8138 @opindex single_module
8139 @opindex static
8140 @opindex sub_library
8141 @opindex sub_umbrella
8142 @opindex twolevel_namespace
8143 @opindex umbrella
8144 @opindex undefined
8145 @opindex unexported_symbols_list
8146 @opindex weak_reference_mismatches
8147 @opindex whatsloaded
8148
8149 These options are passed to the Darwin linker. The Darwin linker man page
8150 describes them in detail.
8151 @end table
8152
8153 @node DEC Alpha Options
8154 @subsection DEC Alpha Options
8155
8156 These @samp{-m} options are defined for the DEC Alpha implementations:
8157
8158 @table @gcctabopt
8159 @item -mno-soft-float
8160 @itemx -msoft-float
8161 @opindex mno-soft-float
8162 @opindex msoft-float
8163 Use (do not use) the hardware floating-point instructions for
8164 floating-point operations. When @option{-msoft-float} is specified,
8165 functions in @file{libgcc.a} will be used to perform floating-point
8166 operations. Unless they are replaced by routines that emulate the
8167 floating-point operations, or compiled in such a way as to call such
8168 emulations routines, these routines will issue floating-point
8169 operations. If you are compiling for an Alpha without floating-point
8170 operations, you must ensure that the library is built so as not to call
8171 them.
8172
8173 Note that Alpha implementations without floating-point operations are
8174 required to have floating-point registers.
8175
8176 @item -mfp-reg
8177 @itemx -mno-fp-regs
8178 @opindex mfp-reg
8179 @opindex mno-fp-regs
8180 Generate code that uses (does not use) the floating-point register set.
8181 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8182 register set is not used, floating point operands are passed in integer
8183 registers as if they were integers and floating-point results are passed
8184 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8185 so any function with a floating-point argument or return value called by code
8186 compiled with @option{-mno-fp-regs} must also be compiled with that
8187 option.
8188
8189 A typical use of this option is building a kernel that does not use,
8190 and hence need not save and restore, any floating-point registers.
8191
8192 @item -mieee
8193 @opindex mieee
8194 The Alpha architecture implements floating-point hardware optimized for
8195 maximum performance. It is mostly compliant with the IEEE floating
8196 point standard. However, for full compliance, software assistance is
8197 required. This option generates code fully IEEE compliant code
8198 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8199 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8200 defined during compilation. The resulting code is less efficient but is
8201 able to correctly support denormalized numbers and exceptional IEEE
8202 values such as not-a-number and plus/minus infinity. Other Alpha
8203 compilers call this option @option{-ieee_with_no_inexact}.
8204
8205 @item -mieee-with-inexact
8206 @opindex mieee-with-inexact
8207 This is like @option{-mieee} except the generated code also maintains
8208 the IEEE @var{inexact-flag}. Turning on this option causes the
8209 generated code to implement fully-compliant IEEE math. In addition to
8210 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8211 macro. On some Alpha implementations the resulting code may execute
8212 significantly slower than the code generated by default. Since there is
8213 very little code that depends on the @var{inexact-flag}, you should
8214 normally not specify this option. Other Alpha compilers call this
8215 option @option{-ieee_with_inexact}.
8216
8217 @item -mfp-trap-mode=@var{trap-mode}
8218 @opindex mfp-trap-mode
8219 This option controls what floating-point related traps are enabled.
8220 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8221 The trap mode can be set to one of four values:
8222
8223 @table @samp
8224 @item n
8225 This is the default (normal) setting. The only traps that are enabled
8226 are the ones that cannot be disabled in software (e.g., division by zero
8227 trap).
8228
8229 @item u
8230 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8231 as well.
8232
8233 @item su
8234 Like @samp{su}, but the instructions are marked to be safe for software
8235 completion (see Alpha architecture manual for details).
8236
8237 @item sui
8238 Like @samp{su}, but inexact traps are enabled as well.
8239 @end table
8240
8241 @item -mfp-rounding-mode=@var{rounding-mode}
8242 @opindex mfp-rounding-mode
8243 Selects the IEEE rounding mode. Other Alpha compilers call this option
8244 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8245 of:
8246
8247 @table @samp
8248 @item n
8249 Normal IEEE rounding mode. Floating point numbers are rounded towards
8250 the nearest machine number or towards the even machine number in case
8251 of a tie.
8252
8253 @item m
8254 Round towards minus infinity.
8255
8256 @item c
8257 Chopped rounding mode. Floating point numbers are rounded towards zero.
8258
8259 @item d
8260 Dynamic rounding mode. A field in the floating point control register
8261 (@var{fpcr}, see Alpha architecture reference manual) controls the
8262 rounding mode in effect. The C library initializes this register for
8263 rounding towards plus infinity. Thus, unless your program modifies the
8264 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8265 @end table
8266
8267 @item -mtrap-precision=@var{trap-precision}
8268 @opindex mtrap-precision
8269 In the Alpha architecture, floating point traps are imprecise. This
8270 means without software assistance it is impossible to recover from a
8271 floating trap and program execution normally needs to be terminated.
8272 GCC can generate code that can assist operating system trap handlers
8273 in determining the exact location that caused a floating point trap.
8274 Depending on the requirements of an application, different levels of
8275 precisions can be selected:
8276
8277 @table @samp
8278 @item p
8279 Program precision. This option is the default and means a trap handler
8280 can only identify which program caused a floating point exception.
8281
8282 @item f
8283 Function precision. The trap handler can determine the function that
8284 caused a floating point exception.
8285
8286 @item i
8287 Instruction precision. The trap handler can determine the exact
8288 instruction that caused a floating point exception.
8289 @end table
8290
8291 Other Alpha compilers provide the equivalent options called
8292 @option{-scope_safe} and @option{-resumption_safe}.
8293
8294 @item -mieee-conformant
8295 @opindex mieee-conformant
8296 This option marks the generated code as IEEE conformant. You must not
8297 use this option unless you also specify @option{-mtrap-precision=i} and either
8298 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8299 is to emit the line @samp{.eflag 48} in the function prologue of the
8300 generated assembly file. Under DEC Unix, this has the effect that
8301 IEEE-conformant math library routines will be linked in.
8302
8303 @item -mbuild-constants
8304 @opindex mbuild-constants
8305 Normally GCC examines a 32- or 64-bit integer constant to
8306 see if it can construct it from smaller constants in two or three
8307 instructions. If it cannot, it will output the constant as a literal and
8308 generate code to load it from the data segment at runtime.
8309
8310 Use this option to require GCC to construct @emph{all} integer constants
8311 using code, even if it takes more instructions (the maximum is six).
8312
8313 You would typically use this option to build a shared library dynamic
8314 loader. Itself a shared library, it must relocate itself in memory
8315 before it can find the variables and constants in its own data segment.
8316
8317 @item -malpha-as
8318 @itemx -mgas
8319 @opindex malpha-as
8320 @opindex mgas
8321 Select whether to generate code to be assembled by the vendor-supplied
8322 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8323
8324 @item -mbwx
8325 @itemx -mno-bwx
8326 @itemx -mcix
8327 @itemx -mno-cix
8328 @itemx -mfix
8329 @itemx -mno-fix
8330 @itemx -mmax
8331 @itemx -mno-max
8332 @opindex mbwx
8333 @opindex mno-bwx
8334 @opindex mcix
8335 @opindex mno-cix
8336 @opindex mfix
8337 @opindex mno-fix
8338 @opindex mmax
8339 @opindex mno-max
8340 Indicate whether GCC should generate code to use the optional BWX,
8341 CIX, FIX and MAX instruction sets. The default is to use the instruction
8342 sets supported by the CPU type specified via @option{-mcpu=} option or that
8343 of the CPU on which GCC was built if none was specified.
8344
8345 @item -mfloat-vax
8346 @itemx -mfloat-ieee
8347 @opindex mfloat-vax
8348 @opindex mfloat-ieee
8349 Generate code that uses (does not use) VAX F and G floating point
8350 arithmetic instead of IEEE single and double precision.
8351
8352 @item -mexplicit-relocs
8353 @itemx -mno-explicit-relocs
8354 @opindex mexplicit-relocs
8355 @opindex mno-explicit-relocs
8356 Older Alpha assemblers provided no way to generate symbol relocations
8357 except via assembler macros. Use of these macros does not allow
8358 optimal instruction scheduling. GNU binutils as of version 2.12
8359 supports a new syntax that allows the compiler to explicitly mark
8360 which relocations should apply to which instructions. This option
8361 is mostly useful for debugging, as GCC detects the capabilities of
8362 the assembler when it is built and sets the default accordingly.
8363
8364 @item -msmall-data
8365 @itemx -mlarge-data
8366 @opindex msmall-data
8367 @opindex mlarge-data
8368 When @option{-mexplicit-relocs} is in effect, static data is
8369 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8370 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8371 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8372 16-bit relocations off of the @code{$gp} register. This limits the
8373 size of the small data area to 64KB, but allows the variables to be
8374 directly accessed via a single instruction.
8375
8376 The default is @option{-mlarge-data}. With this option the data area
8377 is limited to just below 2GB@. Programs that require more than 2GB of
8378 data must use @code{malloc} or @code{mmap} to allocate the data in the
8379 heap instead of in the program's data segment.
8380
8381 When generating code for shared libraries, @option{-fpic} implies
8382 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8383
8384 @item -msmall-text
8385 @itemx -mlarge-text
8386 @opindex msmall-text
8387 @opindex mlarge-text
8388 When @option{-msmall-text} is used, the compiler assumes that the
8389 code of the entire program (or shared library) fits in 4MB, and is
8390 thus reachable with a branch instruction. When @option{-msmall-data}
8391 is used, the compiler can assume that all local symbols share the
8392 same @code{$gp} value, and thus reduce the number of instructions
8393 required for a function call from 4 to 1.
8394
8395 The default is @option{-mlarge-text}.
8396
8397 @item -mcpu=@var{cpu_type}
8398 @opindex mcpu
8399 Set the instruction set and instruction scheduling parameters for
8400 machine type @var{cpu_type}. You can specify either the @samp{EV}
8401 style name or the corresponding chip number. GCC supports scheduling
8402 parameters for the EV4, EV5 and EV6 family of processors and will
8403 choose the default values for the instruction set from the processor
8404 you specify. If you do not specify a processor type, GCC will default
8405 to the processor on which the compiler was built.
8406
8407 Supported values for @var{cpu_type} are
8408
8409 @table @samp
8410 @item ev4
8411 @itemx ev45
8412 @itemx 21064
8413 Schedules as an EV4 and has no instruction set extensions.
8414
8415 @item ev5
8416 @itemx 21164
8417 Schedules as an EV5 and has no instruction set extensions.
8418
8419 @item ev56
8420 @itemx 21164a
8421 Schedules as an EV5 and supports the BWX extension.
8422
8423 @item pca56
8424 @itemx 21164pc
8425 @itemx 21164PC
8426 Schedules as an EV5 and supports the BWX and MAX extensions.
8427
8428 @item ev6
8429 @itemx 21264
8430 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8431
8432 @item ev67
8433 @itemx 21264a
8434 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8435 @end table
8436
8437 @item -mtune=@var{cpu_type}
8438 @opindex mtune
8439 Set only the instruction scheduling parameters for machine type
8440 @var{cpu_type}. The instruction set is not changed.
8441
8442 @item -mmemory-latency=@var{time}
8443 @opindex mmemory-latency
8444 Sets the latency the scheduler should assume for typical memory
8445 references as seen by the application. This number is highly
8446 dependent on the memory access patterns used by the application
8447 and the size of the external cache on the machine.
8448
8449 Valid options for @var{time} are
8450
8451 @table @samp
8452 @item @var{number}
8453 A decimal number representing clock cycles.
8454
8455 @item L1
8456 @itemx L2
8457 @itemx L3
8458 @itemx main
8459 The compiler contains estimates of the number of clock cycles for
8460 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8461 (also called Dcache, Scache, and Bcache), as well as to main memory.
8462 Note that L3 is only valid for EV5.
8463
8464 @end table
8465 @end table
8466
8467 @node DEC Alpha/VMS Options
8468 @subsection DEC Alpha/VMS Options
8469
8470 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8471
8472 @table @gcctabopt
8473 @item -mvms-return-codes
8474 @opindex mvms-return-codes
8475 Return VMS condition codes from main. The default is to return POSIX
8476 style condition (e.g.@ error) codes.
8477 @end table
8478
8479 @node FRV Options
8480 @subsection FRV Options
8481 @cindex FRV Options
8482
8483 @table @gcctabopt
8484 @item -mgpr-32
8485 @opindex mgpr-32
8486
8487 Only use the first 32 general purpose registers.
8488
8489 @item -mgpr-64
8490 @opindex mgpr-64
8491
8492 Use all 64 general purpose registers.
8493
8494 @item -mfpr-32
8495 @opindex mfpr-32
8496
8497 Use only the first 32 floating point registers.
8498
8499 @item -mfpr-64
8500 @opindex mfpr-64
8501
8502 Use all 64 floating point registers
8503
8504 @item -mhard-float
8505 @opindex mhard-float
8506
8507 Use hardware instructions for floating point operations.
8508
8509 @item -msoft-float
8510 @opindex msoft-float
8511
8512 Use library routines for floating point operations.
8513
8514 @item -malloc-cc
8515 @opindex malloc-cc
8516
8517 Dynamically allocate condition code registers.
8518
8519 @item -mfixed-cc
8520 @opindex mfixed-cc
8521
8522 Do not try to dynamically allocate condition code registers, only
8523 use @code{icc0} and @code{fcc0}.
8524
8525 @item -mdword
8526 @opindex mdword
8527
8528 Change ABI to use double word insns.
8529
8530 @item -mno-dword
8531 @opindex mno-dword
8532
8533 Do not use double word instructions.
8534
8535 @item -mdouble
8536 @opindex mdouble
8537
8538 Use floating point double instructions.
8539
8540 @item -mno-double
8541 @opindex mno-double
8542
8543 Do not use floating point double instructions.
8544
8545 @item -mmedia
8546 @opindex mmedia
8547
8548 Use media instructions.
8549
8550 @item -mno-media
8551 @opindex mno-media
8552
8553 Do not use media instructions.
8554
8555 @item -mmuladd
8556 @opindex mmuladd
8557
8558 Use multiply and add/subtract instructions.
8559
8560 @item -mno-muladd
8561 @opindex mno-muladd
8562
8563 Do not use multiply and add/subtract instructions.
8564
8565 @item -mfdpic
8566 @opindex mfdpic
8567
8568 Select the FDPIC ABI, that uses function descriptors to represent
8569 pointers to functions. Without any PIC/PIE-related options, it
8570 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8571 assumes GOT entries and small data are within a 12-bit range from the
8572 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8573 are computed with 32 bits.
8574
8575 @item -minline-plt
8576 @opindex minline-plt
8577
8578 Enable inlining of PLT entries in function calls to functions that are
8579 not known to bind locally. It has no effect without @option{-mfdpic}.
8580 It's enabled by default if optimizing for speed and compiling for
8581 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8582 optimization option such as @option{-O3} or above is present in the
8583 command line.
8584
8585 @item -mTLS
8586 @opindex TLS
8587
8588 Assume a large TLS segment when generating thread-local code.
8589
8590 @item -mtls
8591 @opindex tls
8592
8593 Do not assume a large TLS segment when generating thread-local code.
8594
8595 @item -mgprel-ro
8596 @opindex mgprel-ro
8597
8598 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8599 that is known to be in read-only sections. It's enabled by default,
8600 except for @option{-fpic} or @option{-fpie}: even though it may help
8601 make the global offset table smaller, it trades 1 instruction for 4.
8602 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8603 one of which may be shared by multiple symbols, and it avoids the need
8604 for a GOT entry for the referenced symbol, so it's more likely to be a
8605 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8606
8607 @item -multilib-library-pic
8608 @opindex multilib-library-pic
8609
8610 Link with the (library, not FD) pic libraries. It's implied by
8611 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8612 @option{-fpic} without @option{-mfdpic}. You should never have to use
8613 it explicitly.
8614
8615 @item -mlinked-fp
8616 @opindex mlinked-fp
8617
8618 Follow the EABI requirement of always creating a frame pointer whenever
8619 a stack frame is allocated. This option is enabled by default and can
8620 be disabled with @option{-mno-linked-fp}.
8621
8622 @item -mlong-calls
8623 @opindex mlong-calls
8624
8625 Use indirect addressing to call functions outside the current
8626 compilation unit. This allows the functions to be placed anywhere
8627 within the 32-bit address space.
8628
8629 @item -malign-labels
8630 @opindex malign-labels
8631
8632 Try to align labels to an 8-byte boundary by inserting nops into the
8633 previous packet. This option only has an effect when VLIW packing
8634 is enabled. It doesn't create new packets; it merely adds nops to
8635 existing ones.
8636
8637 @item -mlibrary-pic
8638 @opindex mlibrary-pic
8639
8640 Generate position-independent EABI code.
8641
8642 @item -macc-4
8643 @opindex macc-4
8644
8645 Use only the first four media accumulator registers.
8646
8647 @item -macc-8
8648 @opindex macc-8
8649
8650 Use all eight media accumulator registers.
8651
8652 @item -mpack
8653 @opindex mpack
8654
8655 Pack VLIW instructions.
8656
8657 @item -mno-pack
8658 @opindex mno-pack
8659
8660 Do not pack VLIW instructions.
8661
8662 @item -mno-eflags
8663 @opindex mno-eflags
8664
8665 Do not mark ABI switches in e_flags.
8666
8667 @item -mcond-move
8668 @opindex mcond-move
8669
8670 Enable the use of conditional-move instructions (default).
8671
8672 This switch is mainly for debugging the compiler and will likely be removed
8673 in a future version.
8674
8675 @item -mno-cond-move
8676 @opindex mno-cond-move
8677
8678 Disable the use of conditional-move instructions.
8679
8680 This switch is mainly for debugging the compiler and will likely be removed
8681 in a future version.
8682
8683 @item -mscc
8684 @opindex mscc
8685
8686 Enable the use of conditional set instructions (default).
8687
8688 This switch is mainly for debugging the compiler and will likely be removed
8689 in a future version.
8690
8691 @item -mno-scc
8692 @opindex mno-scc
8693
8694 Disable the use of conditional set instructions.
8695
8696 This switch is mainly for debugging the compiler and will likely be removed
8697 in a future version.
8698
8699 @item -mcond-exec
8700 @opindex mcond-exec
8701
8702 Enable the use of conditional execution (default).
8703
8704 This switch is mainly for debugging the compiler and will likely be removed
8705 in a future version.
8706
8707 @item -mno-cond-exec
8708 @opindex mno-cond-exec
8709
8710 Disable the use of conditional execution.
8711
8712 This switch is mainly for debugging the compiler and will likely be removed
8713 in a future version.
8714
8715 @item -mvliw-branch
8716 @opindex mvliw-branch
8717
8718 Run a pass to pack branches into VLIW instructions (default).
8719
8720 This switch is mainly for debugging the compiler and will likely be removed
8721 in a future version.
8722
8723 @item -mno-vliw-branch
8724 @opindex mno-vliw-branch
8725
8726 Do not run a pass to pack branches into VLIW instructions.
8727
8728 This switch is mainly for debugging the compiler and will likely be removed
8729 in a future version.
8730
8731 @item -mmulti-cond-exec
8732 @opindex mmulti-cond-exec
8733
8734 Enable optimization of @code{&&} and @code{||} in conditional execution
8735 (default).
8736
8737 This switch is mainly for debugging the compiler and will likely be removed
8738 in a future version.
8739
8740 @item -mno-multi-cond-exec
8741 @opindex mno-multi-cond-exec
8742
8743 Disable optimization of @code{&&} and @code{||} in conditional execution.
8744
8745 This switch is mainly for debugging the compiler and will likely be removed
8746 in a future version.
8747
8748 @item -mnested-cond-exec
8749 @opindex mnested-cond-exec
8750
8751 Enable nested conditional execution optimizations (default).
8752
8753 This switch is mainly for debugging the compiler and will likely be removed
8754 in a future version.
8755
8756 @item -mno-nested-cond-exec
8757 @opindex mno-nested-cond-exec
8758
8759 Disable nested conditional execution optimizations.
8760
8761 This switch is mainly for debugging the compiler and will likely be removed
8762 in a future version.
8763
8764 @item -moptimize-membar
8765 @opindex moptimize-membar
8766
8767 This switch removes redundant @code{membar} instructions from the
8768 compiler generated code. It is enabled by default.
8769
8770 @item -mno-optimize-membar
8771 @opindex mno-optimize-membar
8772
8773 This switch disables the automatic removal of redundant @code{membar}
8774 instructions from the generated code.
8775
8776 @item -mtomcat-stats
8777 @opindex mtomcat-stats
8778
8779 Cause gas to print out tomcat statistics.
8780
8781 @item -mcpu=@var{cpu}
8782 @opindex mcpu
8783
8784 Select the processor type for which to generate code. Possible values are
8785 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8786 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8787
8788 @end table
8789
8790 @node GNU/Linux Options
8791 @subsection GNU/Linux Options
8792
8793 These @samp{-m} options are defined for GNU/Linux targets:
8794
8795 @table @gcctabopt
8796 @item -mglibc
8797 @opindex mglibc
8798 Use the GNU C library instead of uClibc. This is the default except
8799 on @samp{*-*-linux-*uclibc*} targets.
8800
8801 @item -muclibc
8802 @opindex muclibc
8803 Use uClibc instead of the GNU C library. This is the default on
8804 @samp{*-*-linux-*uclibc*} targets.
8805 @end table
8806
8807 @node H8/300 Options
8808 @subsection H8/300 Options
8809
8810 These @samp{-m} options are defined for the H8/300 implementations:
8811
8812 @table @gcctabopt
8813 @item -mrelax
8814 @opindex mrelax
8815 Shorten some address references at link time, when possible; uses the
8816 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8817 ld, Using ld}, for a fuller description.
8818
8819 @item -mh
8820 @opindex mh
8821 Generate code for the H8/300H@.
8822
8823 @item -ms
8824 @opindex ms
8825 Generate code for the H8S@.
8826
8827 @item -mn
8828 @opindex mn
8829 Generate code for the H8S and H8/300H in the normal mode. This switch
8830 must be used either with @option{-mh} or @option{-ms}.
8831
8832 @item -ms2600
8833 @opindex ms2600
8834 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
8835
8836 @item -mint32
8837 @opindex mint32
8838 Make @code{int} data 32 bits by default.
8839
8840 @item -malign-300
8841 @opindex malign-300
8842 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8843 The default for the H8/300H and H8S is to align longs and floats on 4
8844 byte boundaries.
8845 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8846 This option has no effect on the H8/300.
8847 @end table
8848
8849 @node HPPA Options
8850 @subsection HPPA Options
8851 @cindex HPPA Options
8852
8853 These @samp{-m} options are defined for the HPPA family of computers:
8854
8855 @table @gcctabopt
8856 @item -march=@var{architecture-type}
8857 @opindex march
8858 Generate code for the specified architecture. The choices for
8859 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8860 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8861 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8862 architecture option for your machine. Code compiled for lower numbered
8863 architectures will run on higher numbered architectures, but not the
8864 other way around.
8865
8866 @item -mpa-risc-1-0
8867 @itemx -mpa-risc-1-1
8868 @itemx -mpa-risc-2-0
8869 @opindex mpa-risc-1-0
8870 @opindex mpa-risc-1-1
8871 @opindex mpa-risc-2-0
8872 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8873
8874 @item -mbig-switch
8875 @opindex mbig-switch
8876 Generate code suitable for big switch tables. Use this option only if
8877 the assembler/linker complain about out of range branches within a switch
8878 table.
8879
8880 @item -mjump-in-delay
8881 @opindex mjump-in-delay
8882 Fill delay slots of function calls with unconditional jump instructions
8883 by modifying the return pointer for the function call to be the target
8884 of the conditional jump.
8885
8886 @item -mdisable-fpregs
8887 @opindex mdisable-fpregs
8888 Prevent floating point registers from being used in any manner. This is
8889 necessary for compiling kernels which perform lazy context switching of
8890 floating point registers. If you use this option and attempt to perform
8891 floating point operations, the compiler will abort.
8892
8893 @item -mdisable-indexing
8894 @opindex mdisable-indexing
8895 Prevent the compiler from using indexing address modes. This avoids some
8896 rather obscure problems when compiling MIG generated code under MACH@.
8897
8898 @item -mno-space-regs
8899 @opindex mno-space-regs
8900 Generate code that assumes the target has no space registers. This allows
8901 GCC to generate faster indirect calls and use unscaled index address modes.
8902
8903 Such code is suitable for level 0 PA systems and kernels.
8904
8905 @item -mfast-indirect-calls
8906 @opindex mfast-indirect-calls
8907 Generate code that assumes calls never cross space boundaries. This
8908 allows GCC to emit code which performs faster indirect calls.
8909
8910 This option will not work in the presence of shared libraries or nested
8911 functions.
8912
8913 @item -mfixed-range=@var{register-range}
8914 @opindex mfixed-range
8915 Generate code treating the given register range as fixed registers.
8916 A fixed register is one that the register allocator can not use. This is
8917 useful when compiling kernel code. A register range is specified as
8918 two registers separated by a dash. Multiple register ranges can be
8919 specified separated by a comma.
8920
8921 @item -mlong-load-store
8922 @opindex mlong-load-store
8923 Generate 3-instruction load and store sequences as sometimes required by
8924 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8925 the HP compilers.
8926
8927 @item -mportable-runtime
8928 @opindex mportable-runtime
8929 Use the portable calling conventions proposed by HP for ELF systems.
8930
8931 @item -mgas
8932 @opindex mgas
8933 Enable the use of assembler directives only GAS understands.
8934
8935 @item -mschedule=@var{cpu-type}
8936 @opindex mschedule
8937 Schedule code according to the constraints for the machine type
8938 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8939 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8940 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8941 proper scheduling option for your machine. The default scheduling is
8942 @samp{8000}.
8943
8944 @item -mlinker-opt
8945 @opindex mlinker-opt
8946 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8947 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8948 linkers in which they give bogus error messages when linking some programs.
8949
8950 @item -msoft-float
8951 @opindex msoft-float
8952 Generate output containing library calls for floating point.
8953 @strong{Warning:} the requisite libraries are not available for all HPPA
8954 targets. Normally the facilities of the machine's usual C compiler are
8955 used, but this cannot be done directly in cross-compilation. You must make
8956 your own arrangements to provide suitable library functions for
8957 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8958 does provide software floating point support.
8959
8960 @option{-msoft-float} changes the calling convention in the output file;
8961 therefore, it is only useful if you compile @emph{all} of a program with
8962 this option. In particular, you need to compile @file{libgcc.a}, the
8963 library that comes with GCC, with @option{-msoft-float} in order for
8964 this to work.
8965
8966 @item -msio
8967 @opindex msio
8968 Generate the predefine, @code{_SIO}, for server IO@. The default is
8969 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8970 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8971 options are available under HP-UX and HI-UX@.
8972
8973 @item -mgnu-ld
8974 @opindex gnu-ld
8975 Use GNU ld specific options. This passes @option{-shared} to ld when
8976 building a shared library. It is the default when GCC is configured,
8977 explicitly or implicitly, with the GNU linker. This option does not
8978 have any affect on which ld is called, it only changes what parameters
8979 are passed to that ld. The ld that is called is determined by the
8980 @option{--with-ld} configure option, GCC's program search path, and
8981 finally by the user's @env{PATH}. The linker used by GCC can be printed
8982 using @samp{which `gcc -print-prog-name=ld`}. This option is only available
8983 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8984
8985 @item -mhp-ld
8986 @opindex hp-ld
8987 Use HP ld specific options. This passes @option{-b} to ld when building
8988 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8989 links. It is the default when GCC is configured, explicitly or
8990 implicitly, with the HP linker. This option does not have any affect on
8991 which ld is called, it only changes what parameters are passed to that
8992 ld. The ld that is called is determined by the @option{--with-ld}
8993 configure option, GCC's program search path, and finally by the user's
8994 @env{PATH}. The linker used by GCC can be printed using @samp{which
8995 `gcc -print-prog-name=ld`}. This option is only available on the 64 bit
8996 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
8997
8998 @item -mlong-calls
8999 @opindex mno-long-calls
9000 Generate code that uses long call sequences. This ensures that a call
9001 is always able to reach linker generated stubs. The default is to generate
9002 long calls only when the distance from the call site to the beginning
9003 of the function or translation unit, as the case may be, exceeds a
9004 predefined limit set by the branch type being used. The limits for
9005 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9006 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
9007 240,000 bytes.
9008
9009 Distances are measured from the beginning of functions when using the
9010 @option{-ffunction-sections} option, or when using the @option{-mgas}
9011 and @option{-mno-portable-runtime} options together under HP-UX with
9012 the SOM linker.
9013
9014 It is normally not desirable to use this option as it will degrade
9015 performance. However, it may be useful in large applications,
9016 particularly when partial linking is used to build the application.
9017
9018 The types of long calls used depends on the capabilities of the
9019 assembler and linker, and the type of code being generated. The
9020 impact on systems that support long absolute calls, and long pic
9021 symbol-difference or pc-relative calls should be relatively small.
9022 However, an indirect call is used on 32-bit ELF systems in pic code
9023 and it is quite long.
9024
9025 @item -munix=@var{unix-std}
9026 @opindex march
9027 Generate compiler predefines and select a startfile for the specified
9028 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
9029 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
9030 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
9031 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
9032 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9033 and later.
9034
9035 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9036 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9037 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9038 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9039 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9040 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9041
9042 It is @emph{important} to note that this option changes the interfaces
9043 for various library routines. It also affects the operational behavior
9044 of the C library. Thus, @emph{extreme} care is needed in using this
9045 option.
9046
9047 Library code that is intended to operate with more than one UNIX
9048 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9049 as appropriate. Most GNU software doesn't provide this capability.
9050
9051 @item -nolibdld
9052 @opindex nolibdld
9053 Suppress the generation of link options to search libdld.sl when the
9054 @option{-static} option is specified on HP-UX 10 and later.
9055
9056 @item -static
9057 @opindex static
9058 The HP-UX implementation of setlocale in libc has a dependency on
9059 libdld.sl. There isn't an archive version of libdld.sl. Thus,
9060 when the @option{-static} option is specified, special link options
9061 are needed to resolve this dependency.
9062
9063 On HP-UX 10 and later, the GCC driver adds the necessary options to
9064 link with libdld.sl when the @option{-static} option is specified.
9065 This causes the resulting binary to be dynamic. On the 64-bit port,
9066 the linkers generate dynamic binaries by default in any case. The
9067 @option{-nolibdld} option can be used to prevent the GCC driver from
9068 adding these link options.
9069
9070 @item -threads
9071 @opindex threads
9072 Add support for multithreading with the @dfn{dce thread} library
9073 under HP-UX@. This option sets flags for both the preprocessor and
9074 linker.
9075 @end table
9076
9077 @node i386 and x86-64 Options
9078 @subsection Intel 386 and AMD x86-64 Options
9079 @cindex i386 Options
9080 @cindex x86-64 Options
9081 @cindex Intel 386 Options
9082 @cindex AMD x86-64 Options
9083
9084 These @samp{-m} options are defined for the i386 and x86-64 family of
9085 computers:
9086
9087 @table @gcctabopt
9088 @item -mtune=@var{cpu-type}
9089 @opindex mtune
9090 Tune to @var{cpu-type} everything applicable about the generated code, except
9091 for the ABI and the set of available instructions. The choices for
9092 @var{cpu-type} are:
9093 @table @emph
9094 @item generic
9095 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9096 If you know the CPU on which your code will run, then you should use
9097 the corresponding @option{-mtune} option instead of
9098 @option{-mtune=generic}. But, if you do not know exactly what CPU users
9099 of your application will have, then you should use this option.
9100
9101 As new processors are deployed in the marketplace, the behavior of this
9102 option will change. Therefore, if you upgrade to a newer version of
9103 GCC, the code generated option will change to reflect the processors
9104 that were most common when that version of GCC was released.
9105
9106 There is no @option{-march=generic} option because @option{-march}
9107 indicates the instruction set the compiler can use, and there is no
9108 generic instruction set applicable to all processors. In contrast,
9109 @option{-mtune} indicates the processor (or, in this case, collection of
9110 processors) for which the code is optimized.
9111 @item i386
9112 Original Intel's i386 CPU@.
9113 @item i486
9114 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
9115 @item i586, pentium
9116 Intel Pentium CPU with no MMX support.
9117 @item pentium-mmx
9118 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9119 @item pentiumpro
9120 Intel PentiumPro CPU@.
9121 @item i686
9122 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9123 instruction set will be used, so the code will run on all i686 familly chips.
9124 @item pentium2
9125 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9126 @item pentium3, pentium3m
9127 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9128 support.
9129 @item pentium-m
9130 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9131 support. Used by Centrino notebooks.
9132 @item pentium4, pentium4m
9133 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9134 @item prescott
9135 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9136 set support.
9137 @item nocona
9138 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9139 SSE2 and SSE3 instruction set support.
9140 @item k6
9141 AMD K6 CPU with MMX instruction set support.
9142 @item k6-2, k6-3
9143 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9144 @item athlon, athlon-tbird
9145 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9146 support.
9147 @item athlon-4, athlon-xp, athlon-mp
9148 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9149 instruction set support.
9150 @item k8, opteron, athlon64, athlon-fx
9151 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
9152 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9153 @item winchip-c6
9154 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9155 set support.
9156 @item winchip2
9157 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9158 instruction set support.
9159 @item c3
9160 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
9161 implemented for this chip.)
9162 @item c3-2
9163 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
9164 implemented for this chip.)
9165 @end table
9166
9167 While picking a specific @var{cpu-type} will schedule things appropriately
9168 for that particular chip, the compiler will not generate any code that
9169 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9170 being used.
9171
9172 @item -march=@var{cpu-type}
9173 @opindex march
9174 Generate instructions for the machine type @var{cpu-type}. The choices
9175 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
9176 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9177
9178 @item -mcpu=@var{cpu-type}
9179 @opindex mcpu
9180 A deprecated synonym for @option{-mtune}.
9181
9182 @item -m386
9183 @itemx -m486
9184 @itemx -mpentium
9185 @itemx -mpentiumpro
9186 @opindex m386
9187 @opindex m486
9188 @opindex mpentium
9189 @opindex mpentiumpro
9190 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9191 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9192 These synonyms are deprecated.
9193
9194 @item -mfpmath=@var{unit}
9195 @opindex march
9196 Generate floating point arithmetics for selected unit @var{unit}. The choices
9197 for @var{unit} are:
9198
9199 @table @samp
9200 @item 387
9201 Use the standard 387 floating point coprocessor present majority of chips and
9202 emulated otherwise. Code compiled with this option will run almost everywhere.
9203 The temporary results are computed in 80bit precision instead of precision
9204 specified by the type resulting in slightly different results compared to most
9205 of other chips. See @option{-ffloat-store} for more detailed description.
9206
9207 This is the default choice for i386 compiler.
9208
9209 @item sse
9210 Use scalar floating point instructions present in the SSE instruction set.
9211 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9212 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
9213 instruction set supports only single precision arithmetics, thus the double and
9214 extended precision arithmetics is still done using 387. Later version, present
9215 only in Pentium4 and the future AMD x86-64 chips supports double precision
9216 arithmetics too.
9217
9218 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9219 or @option{-msse2} switches to enable SSE extensions and make this option
9220 effective. For the x86-64 compiler, these extensions are enabled by default.
9221
9222 The resulting code should be considerably faster in the majority of cases and avoid
9223 the numerical instability problems of 387 code, but may break some existing
9224 code that expects temporaries to be 80bit.
9225
9226 This is the default choice for the x86-64 compiler.
9227
9228 @item sse,387
9229 Attempt to utilize both instruction sets at once. This effectively double the
9230 amount of available registers and on chips with separate execution units for
9231 387 and SSE the execution resources too. Use this option with care, as it is
9232 still experimental, because the GCC register allocator does not model separate
9233 functional units well resulting in instable performance.
9234 @end table
9235
9236 @item -masm=@var{dialect}
9237 @opindex masm=@var{dialect}
9238 Output asm instructions using selected @var{dialect}. Supported
9239 choices are @samp{intel} or @samp{att} (the default one). Darwin does
9240 not support @samp{intel}.
9241
9242 @item -mieee-fp
9243 @itemx -mno-ieee-fp
9244 @opindex mieee-fp
9245 @opindex mno-ieee-fp
9246 Control whether or not the compiler uses IEEE floating point
9247 comparisons. These handle correctly the case where the result of a
9248 comparison is unordered.
9249
9250 @item -msoft-float
9251 @opindex msoft-float
9252 Generate output containing library calls for floating point.
9253 @strong{Warning:} the requisite libraries are not part of GCC@.
9254 Normally the facilities of the machine's usual C compiler are used, but
9255 this can't be done directly in cross-compilation. You must make your
9256 own arrangements to provide suitable library functions for
9257 cross-compilation.
9258
9259 On machines where a function returns floating point results in the 80387
9260 register stack, some floating point opcodes may be emitted even if
9261 @option{-msoft-float} is used.
9262
9263 @item -mno-fp-ret-in-387
9264 @opindex mno-fp-ret-in-387
9265 Do not use the FPU registers for return values of functions.
9266
9267 The usual calling convention has functions return values of types
9268 @code{float} and @code{double} in an FPU register, even if there
9269 is no FPU@. The idea is that the operating system should emulate
9270 an FPU@.
9271
9272 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9273 in ordinary CPU registers instead.
9274
9275 @item -mno-fancy-math-387
9276 @opindex mno-fancy-math-387
9277 Some 387 emulators do not support the @code{sin}, @code{cos} and
9278 @code{sqrt} instructions for the 387. Specify this option to avoid
9279 generating those instructions. This option is the default on FreeBSD,
9280 OpenBSD and NetBSD@. This option is overridden when @option{-march}
9281 indicates that the target cpu will always have an FPU and so the
9282 instruction will not need emulation. As of revision 2.6.1, these
9283 instructions are not generated unless you also use the
9284 @option{-funsafe-math-optimizations} switch.
9285
9286 @item -malign-double
9287 @itemx -mno-align-double
9288 @opindex malign-double
9289 @opindex mno-align-double
9290 Control whether GCC aligns @code{double}, @code{long double}, and
9291 @code{long long} variables on a two word boundary or a one word
9292 boundary. Aligning @code{double} variables on a two word boundary will
9293 produce code that runs somewhat faster on a @samp{Pentium} at the
9294 expense of more memory.
9295
9296 @strong{Warning:} if you use the @option{-malign-double} switch,
9297 structures containing the above types will be aligned differently than
9298 the published application binary interface specifications for the 386
9299 and will not be binary compatible with structures in code compiled
9300 without that switch.
9301
9302 @item -m96bit-long-double
9303 @itemx -m128bit-long-double
9304 @opindex m96bit-long-double
9305 @opindex m128bit-long-double
9306 These switches control the size of @code{long double} type. The i386
9307 application binary interface specifies the size to be 96 bits,
9308 so @option{-m96bit-long-double} is the default in 32 bit mode.
9309
9310 Modern architectures (Pentium and newer) would prefer @code{long double}
9311 to be aligned to an 8 or 16 byte boundary. In arrays or structures
9312 conforming to the ABI, this would not be possible. So specifying a
9313 @option{-m128bit-long-double} will align @code{long double}
9314 to a 16 byte boundary by padding the @code{long double} with an additional
9315 32 bit zero.
9316
9317 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9318 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9319
9320 Notice that neither of these options enable any extra precision over the x87
9321 standard of 80 bits for a @code{long double}.
9322
9323 @strong{Warning:} if you override the default value for your target ABI, the
9324 structures and arrays containing @code{long double} variables will change
9325 their size as well as function calling convention for function taking
9326 @code{long double} will be modified. Hence they will not be binary
9327 compatible with arrays or structures in code compiled without that switch.
9328
9329 @item -mmlarge-data-threshold=@var{number}
9330 @opindex mlarge-data-threshold=@var{number}
9331 When @option{-mcmodel=medium} is specified, the data greater than
9332 @var{threshold} are placed in large data section. This value must be the
9333 same across all object linked into the binary and defaults to 65535.
9334
9335 @item -msvr3-shlib
9336 @itemx -mno-svr3-shlib
9337 @opindex msvr3-shlib
9338 @opindex mno-svr3-shlib
9339 Control whether GCC places uninitialized local variables into the
9340 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
9341 into @code{bss}. These options are meaningful only on System V Release 3.
9342
9343 @item -mrtd
9344 @opindex mrtd
9345 Use a different function-calling convention, in which functions that
9346 take a fixed number of arguments return with the @code{ret} @var{num}
9347 instruction, which pops their arguments while returning. This saves one
9348 instruction in the caller since there is no need to pop the arguments
9349 there.
9350
9351 You can specify that an individual function is called with this calling
9352 sequence with the function attribute @samp{stdcall}. You can also
9353 override the @option{-mrtd} option by using the function attribute
9354 @samp{cdecl}. @xref{Function Attributes}.
9355
9356 @strong{Warning:} this calling convention is incompatible with the one
9357 normally used on Unix, so you cannot use it if you need to call
9358 libraries compiled with the Unix compiler.
9359
9360 Also, you must provide function prototypes for all functions that
9361 take variable numbers of arguments (including @code{printf});
9362 otherwise incorrect code will be generated for calls to those
9363 functions.
9364
9365 In addition, seriously incorrect code will result if you call a
9366 function with too many arguments. (Normally, extra arguments are
9367 harmlessly ignored.)
9368
9369 @item -mregparm=@var{num}
9370 @opindex mregparm
9371 Control how many registers are used to pass integer arguments. By
9372 default, no registers are used to pass arguments, and at most 3
9373 registers can be used. You can control this behavior for a specific
9374 function by using the function attribute @samp{regparm}.
9375 @xref{Function Attributes}.
9376
9377 @strong{Warning:} if you use this switch, and
9378 @var{num} is nonzero, then you must build all modules with the same
9379 value, including any libraries. This includes the system libraries and
9380 startup modules.
9381
9382 @item -msseregparm
9383 @opindex msseregparm
9384 Use SSE register passing conventions for float and double arguments
9385 and return values. You can control this behavior for a specific
9386 function by using the function attribute @samp{sseregparm}.
9387 @xref{Function Attributes}.
9388
9389 @strong{Warning:} if you use this switch then you must build all
9390 modules with the same value, including any libraries. This includes
9391 the system libraries and startup modules.
9392
9393 @item -mpreferred-stack-boundary=@var{num}
9394 @opindex mpreferred-stack-boundary
9395 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9396 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
9397 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9398 size (@option{-Os}), in which case the default is the minimum correct
9399 alignment (4 bytes for x86, and 8 bytes for x86-64).
9400
9401 On Pentium and PentiumPro, @code{double} and @code{long double} values
9402 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9403 suffer significant run time performance penalties. On Pentium III, the
9404 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9405 penalties if it is not 16 byte aligned.
9406
9407 To ensure proper alignment of this values on the stack, the stack boundary
9408 must be as aligned as that required by any value stored on the stack.
9409 Further, every function must be generated such that it keeps the stack
9410 aligned. Thus calling a function compiled with a higher preferred
9411 stack boundary from a function compiled with a lower preferred stack
9412 boundary will most likely misalign the stack. It is recommended that
9413 libraries that use callbacks always use the default setting.
9414
9415 This extra alignment does consume extra stack space, and generally
9416 increases code size. Code that is sensitive to stack space usage, such
9417 as embedded systems and operating system kernels, may want to reduce the
9418 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9419
9420 @item -mmmx
9421 @itemx -mno-mmx
9422 @item -msse
9423 @itemx -mno-sse
9424 @item -msse2
9425 @itemx -mno-sse2
9426 @item -msse3
9427 @itemx -mno-sse3
9428 @item -m3dnow
9429 @itemx -mno-3dnow
9430 @opindex mmmx
9431 @opindex mno-mmx
9432 @opindex msse
9433 @opindex mno-sse
9434 @opindex m3dnow
9435 @opindex mno-3dnow
9436 These switches enable or disable the use of instructions in the MMX,
9437 SSE, SSE2 or 3DNow! extended instruction sets. These extensions are
9438 also available as built-in functions: see @ref{X86 Built-in Functions},
9439 for details of the functions enabled and disabled by these switches.
9440
9441 To have SSE/SSE2 instructions generated automatically from floating-point
9442 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9443
9444 These options will enable GCC to use these extended instructions in
9445 generated code, even without @option{-mfpmath=sse}. Applications which
9446 perform runtime CPU detection must compile separate files for each
9447 supported architecture, using the appropriate flags. In particular,
9448 the file containing the CPU detection code should be compiled without
9449 these options.
9450
9451 @item -msselibm
9452 @opindex msselibm
9453 Use special versions of certain libm routines that come with an SSE
9454 ABI and an SSE implementation. Useful together with @option{-mfpmath=sse}
9455 to avoid moving values between SSE registers and the x87 FP stack.
9456
9457 @item -mpush-args
9458 @itemx -mno-push-args
9459 @opindex mpush-args
9460 @opindex mno-push-args
9461 Use PUSH operations to store outgoing parameters. This method is shorter
9462 and usually equally fast as method using SUB/MOV operations and is enabled
9463 by default. In some cases disabling it may improve performance because of
9464 improved scheduling and reduced dependencies.
9465
9466 @item -maccumulate-outgoing-args
9467 @opindex maccumulate-outgoing-args
9468 If enabled, the maximum amount of space required for outgoing arguments will be
9469 computed in the function prologue. This is faster on most modern CPUs
9470 because of reduced dependencies, improved scheduling and reduced stack usage
9471 when preferred stack boundary is not equal to 2. The drawback is a notable
9472 increase in code size. This switch implies @option{-mno-push-args}.
9473
9474 @item -mthreads
9475 @opindex mthreads
9476 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
9477 on thread-safe exception handling must compile and link all code with the
9478 @option{-mthreads} option. When compiling, @option{-mthreads} defines
9479 @option{-D_MT}; when linking, it links in a special thread helper library
9480 @option{-lmingwthrd} which cleans up per thread exception handling data.
9481
9482 @item -mno-align-stringops
9483 @opindex mno-align-stringops
9484 Do not align destination of inlined string operations. This switch reduces
9485 code size and improves performance in case the destination is already aligned,
9486 but GCC doesn't know about it.
9487
9488 @item -minline-all-stringops
9489 @opindex minline-all-stringops
9490 By default GCC inlines string operations only when destination is known to be
9491 aligned at least to 4 byte boundary. This enables more inlining, increase code
9492 size, but may improve performance of code that depends on fast memcpy, strlen
9493 and memset for short lengths.
9494
9495 @item -momit-leaf-frame-pointer
9496 @opindex momit-leaf-frame-pointer
9497 Don't keep the frame pointer in a register for leaf functions. This
9498 avoids the instructions to save, set up and restore frame pointers and
9499 makes an extra register available in leaf functions. The option
9500 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9501 which might make debugging harder.
9502
9503 @item -mtls-direct-seg-refs
9504 @itemx -mno-tls-direct-seg-refs
9505 @opindex mtls-direct-seg-refs
9506 Controls whether TLS variables may be accessed with offsets from the
9507 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9508 or whether the thread base pointer must be added. Whether or not this
9509 is legal depends on the operating system, and whether it maps the
9510 segment to cover the entire TLS area.
9511
9512 For systems that use GNU libc, the default is on.
9513 @end table
9514
9515 These @samp{-m} switches are supported in addition to the above
9516 on AMD x86-64 processors in 64-bit environments.
9517
9518 @table @gcctabopt
9519 @item -m32
9520 @itemx -m64
9521 @opindex m32
9522 @opindex m64
9523 Generate code for a 32-bit or 64-bit environment.
9524 The 32-bit environment sets int, long and pointer to 32 bits and
9525 generates code that runs on any i386 system.
9526 The 64-bit environment sets int to 32 bits and long and pointer
9527 to 64 bits and generates code for AMD's x86-64 architecture.
9528
9529 @item -mno-red-zone
9530 @opindex no-red-zone
9531 Do not use a so called red zone for x86-64 code. The red zone is mandated
9532 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9533 stack pointer that will not be modified by signal or interrupt handlers
9534 and therefore can be used for temporary data without adjusting the stack
9535 pointer. The flag @option{-mno-red-zone} disables this red zone.
9536
9537 @item -mcmodel=small
9538 @opindex mcmodel=small
9539 Generate code for the small code model: the program and its symbols must
9540 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9541 Programs can be statically or dynamically linked. This is the default
9542 code model.
9543
9544 @item -mcmodel=kernel
9545 @opindex mcmodel=kernel
9546 Generate code for the kernel code model. The kernel runs in the
9547 negative 2 GB of the address space.
9548 This model has to be used for Linux kernel code.
9549
9550 @item -mcmodel=medium
9551 @opindex mcmodel=medium
9552 Generate code for the medium model: The program is linked in the lower 2
9553 GB of the address space but symbols can be located anywhere in the
9554 address space. Programs can be statically or dynamically linked, but
9555 building of shared libraries are not supported with the medium model.
9556
9557 @item -mcmodel=large
9558 @opindex mcmodel=large
9559 Generate code for the large model: This model makes no assumptions
9560 about addresses and sizes of sections. Currently GCC does not implement
9561 this model.
9562 @end table
9563
9564 @node IA-64 Options
9565 @subsection IA-64 Options
9566 @cindex IA-64 Options
9567
9568 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9569
9570 @table @gcctabopt
9571 @item -mbig-endian
9572 @opindex mbig-endian
9573 Generate code for a big endian target. This is the default for HP-UX@.
9574
9575 @item -mlittle-endian
9576 @opindex mlittle-endian
9577 Generate code for a little endian target. This is the default for AIX5
9578 and GNU/Linux.
9579
9580 @item -mgnu-as
9581 @itemx -mno-gnu-as
9582 @opindex mgnu-as
9583 @opindex mno-gnu-as
9584 Generate (or don't) code for the GNU assembler. This is the default.
9585 @c Also, this is the default if the configure option @option{--with-gnu-as}
9586 @c is used.
9587
9588 @item -mgnu-ld
9589 @itemx -mno-gnu-ld
9590 @opindex mgnu-ld
9591 @opindex mno-gnu-ld
9592 Generate (or don't) code for the GNU linker. This is the default.
9593 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9594 @c is used.
9595
9596 @item -mno-pic
9597 @opindex mno-pic
9598 Generate code that does not use a global pointer register. The result
9599 is not position independent code, and violates the IA-64 ABI@.
9600
9601 @item -mvolatile-asm-stop
9602 @itemx -mno-volatile-asm-stop
9603 @opindex mvolatile-asm-stop
9604 @opindex mno-volatile-asm-stop
9605 Generate (or don't) a stop bit immediately before and after volatile asm
9606 statements.
9607
9608 @item -mregister-names
9609 @itemx -mno-register-names
9610 @opindex mregister-names
9611 @opindex mno-register-names
9612 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9613 the stacked registers. This may make assembler output more readable.
9614
9615 @item -mno-sdata
9616 @itemx -msdata
9617 @opindex mno-sdata
9618 @opindex msdata
9619 Disable (or enable) optimizations that use the small data section. This may
9620 be useful for working around optimizer bugs.
9621
9622 @item -mconstant-gp
9623 @opindex mconstant-gp
9624 Generate code that uses a single constant global pointer value. This is
9625 useful when compiling kernel code.
9626
9627 @item -mauto-pic
9628 @opindex mauto-pic
9629 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9630 This is useful when compiling firmware code.
9631
9632 @item -minline-float-divide-min-latency
9633 @opindex minline-float-divide-min-latency
9634 Generate code for inline divides of floating point values
9635 using the minimum latency algorithm.
9636
9637 @item -minline-float-divide-max-throughput
9638 @opindex minline-float-divide-max-throughput
9639 Generate code for inline divides of floating point values
9640 using the maximum throughput algorithm.
9641
9642 @item -minline-int-divide-min-latency
9643 @opindex minline-int-divide-min-latency
9644 Generate code for inline divides of integer values
9645 using the minimum latency algorithm.
9646
9647 @item -minline-int-divide-max-throughput
9648 @opindex minline-int-divide-max-throughput
9649 Generate code for inline divides of integer values
9650 using the maximum throughput algorithm.
9651
9652 @item -minline-sqrt-min-latency
9653 @opindex minline-sqrt-min-latency
9654 Generate code for inline square roots
9655 using the minimum latency algorithm.
9656
9657 @item -minline-sqrt-max-throughput
9658 @opindex minline-sqrt-max-throughput
9659 Generate code for inline square roots
9660 using the maximum throughput algorithm.
9661
9662 @item -mno-dwarf2-asm
9663 @itemx -mdwarf2-asm
9664 @opindex mno-dwarf2-asm
9665 @opindex mdwarf2-asm
9666 Don't (or do) generate assembler code for the DWARF2 line number debugging
9667 info. This may be useful when not using the GNU assembler.
9668
9669 @item -mearly-stop-bits
9670 @itemx -mno-early-stop-bits
9671 @opindex mearly-stop-bits
9672 @opindex mno-early-stop-bits
9673 Allow stop bits to be placed earlier than immediately preceding the
9674 instruction that triggered the stop bit. This can improve instruction
9675 scheduling, but does not always do so.
9676
9677 @item -mfixed-range=@var{register-range}
9678 @opindex mfixed-range
9679 Generate code treating the given register range as fixed registers.
9680 A fixed register is one that the register allocator can not use. This is
9681 useful when compiling kernel code. A register range is specified as
9682 two registers separated by a dash. Multiple register ranges can be
9683 specified separated by a comma.
9684
9685 @item -mtls-size=@var{tls-size}
9686 @opindex mtls-size
9687 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
9688 64.
9689
9690 @item -mtune=@var{cpu-type}
9691 @opindex mtune
9692 Tune the instruction scheduling for a particular CPU, Valid values are
9693 itanium, itanium1, merced, itanium2, and mckinley.
9694
9695 @item -mt
9696 @itemx -pthread
9697 @opindex mt
9698 @opindex pthread
9699 Add support for multithreading using the POSIX threads library. This
9700 option sets flags for both the preprocessor and linker. It does
9701 not affect the thread safety of object code produced by the compiler or
9702 that of libraries supplied with it. These are HP-UX specific flags.
9703
9704 @item -milp32
9705 @itemx -mlp64
9706 @opindex milp32
9707 @opindex mlp64
9708 Generate code for a 32-bit or 64-bit environment.
9709 The 32-bit environment sets int, long and pointer to 32 bits.
9710 The 64-bit environment sets int to 32 bits and long and pointer
9711 to 64 bits. These are HP-UX specific flags.
9712
9713 @end table
9714
9715 @node M32C Options
9716 @subsection M32C Options
9717 @cindex M32C options
9718
9719 @table @gcctabopt
9720 @item -mcpu=@var{name}
9721 @opindex mcpu=
9722 Select the CPU for which code is generated. @var{name} may be one of
9723 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
9724 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
9725 the M32C/80 series.
9726
9727 @item -msim
9728 @opindex msim
9729 Specifies that the program will be run on the simulator. This causes
9730 an alternate runtime library to be linked in which supports, for
9731 example, file I/O. You must not use this option when generating
9732 programs that will run on real hardware; you must provide your own
9733 runtime library for whatever I/O functions are needed.
9734
9735 @item -memregs=@var{number}
9736 @opindex memregs=
9737 Specifies the number of memory-based pseudo-registers GCC will use
9738 during code generation. These pseudo-registers will be used like real
9739 registers, so there is a tradeoff between GCC's ability to fit the
9740 code into available registers, and the performance penalty of using
9741 memory instead of registers. Note that all modules in a program must
9742 be compiled with the same value for this option. Because of that, you
9743 must not use this option with the default runtime libraries gcc
9744 builds.
9745
9746 @end table
9747
9748 @node M32R/D Options
9749 @subsection M32R/D Options
9750 @cindex M32R/D options
9751
9752 These @option{-m} options are defined for Renesas M32R/D architectures:
9753
9754 @table @gcctabopt
9755 @item -m32r2
9756 @opindex m32r2
9757 Generate code for the M32R/2@.
9758
9759 @item -m32rx
9760 @opindex m32rx
9761 Generate code for the M32R/X@.
9762
9763 @item -m32r
9764 @opindex m32r
9765 Generate code for the M32R@. This is the default.
9766
9767 @item -mmodel=small
9768 @opindex mmodel=small
9769 Assume all objects live in the lower 16MB of memory (so that their addresses
9770 can be loaded with the @code{ld24} instruction), and assume all subroutines
9771 are reachable with the @code{bl} instruction.
9772 This is the default.
9773
9774 The addressability of a particular object can be set with the
9775 @code{model} attribute.
9776
9777 @item -mmodel=medium
9778 @opindex mmodel=medium
9779 Assume objects may be anywhere in the 32-bit address space (the compiler
9780 will generate @code{seth/add3} instructions to load their addresses), and
9781 assume all subroutines are reachable with the @code{bl} instruction.
9782
9783 @item -mmodel=large
9784 @opindex mmodel=large
9785 Assume objects may be anywhere in the 32-bit address space (the compiler
9786 will generate @code{seth/add3} instructions to load their addresses), and
9787 assume subroutines may not be reachable with the @code{bl} instruction
9788 (the compiler will generate the much slower @code{seth/add3/jl}
9789 instruction sequence).
9790
9791 @item -msdata=none
9792 @opindex msdata=none
9793 Disable use of the small data area. Variables will be put into
9794 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9795 @code{section} attribute has been specified).
9796 This is the default.
9797
9798 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9799 Objects may be explicitly put in the small data area with the
9800 @code{section} attribute using one of these sections.
9801
9802 @item -msdata=sdata
9803 @opindex msdata=sdata
9804 Put small global and static data in the small data area, but do not
9805 generate special code to reference them.
9806
9807 @item -msdata=use
9808 @opindex msdata=use
9809 Put small global and static data in the small data area, and generate
9810 special instructions to reference them.
9811
9812 @item -G @var{num}
9813 @opindex G
9814 @cindex smaller data references
9815 Put global and static objects less than or equal to @var{num} bytes
9816 into the small data or bss sections instead of the normal data or bss
9817 sections. The default value of @var{num} is 8.
9818 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9819 for this option to have any effect.
9820
9821 All modules should be compiled with the same @option{-G @var{num}} value.
9822 Compiling with different values of @var{num} may or may not work; if it
9823 doesn't the linker will give an error message---incorrect code will not be
9824 generated.
9825
9826 @item -mdebug
9827 @opindex mdebug
9828 Makes the M32R specific code in the compiler display some statistics
9829 that might help in debugging programs.
9830
9831 @item -malign-loops
9832 @opindex malign-loops
9833 Align all loops to a 32-byte boundary.
9834
9835 @item -mno-align-loops
9836 @opindex mno-align-loops
9837 Do not enforce a 32-byte alignment for loops. This is the default.
9838
9839 @item -missue-rate=@var{number}
9840 @opindex missue-rate=@var{number}
9841 Issue @var{number} instructions per cycle. @var{number} can only be 1
9842 or 2.
9843
9844 @item -mbranch-cost=@var{number}
9845 @opindex mbranch-cost=@var{number}
9846 @var{number} can only be 1 or 2. If it is 1 then branches will be
9847 preferred over conditional code, if it is 2, then the opposite will
9848 apply.
9849
9850 @item -mflush-trap=@var{number}
9851 @opindex mflush-trap=@var{number}
9852 Specifies the trap number to use to flush the cache. The default is
9853 12. Valid numbers are between 0 and 15 inclusive.
9854
9855 @item -mno-flush-trap
9856 @opindex mno-flush-trap
9857 Specifies that the cache cannot be flushed by using a trap.
9858
9859 @item -mflush-func=@var{name}
9860 @opindex mflush-func=@var{name}
9861 Specifies the name of the operating system function to call to flush
9862 the cache. The default is @emph{_flush_cache}, but a function call
9863 will only be used if a trap is not available.
9864
9865 @item -mno-flush-func
9866 @opindex mno-flush-func
9867 Indicates that there is no OS function for flushing the cache.
9868
9869 @end table
9870
9871 @node M680x0 Options
9872 @subsection M680x0 Options
9873 @cindex M680x0 options
9874
9875 These are the @samp{-m} options defined for the 68000 series. The default
9876 values for these options depends on which style of 68000 was selected when
9877 the compiler was configured; the defaults for the most common choices are
9878 given below.
9879
9880 @table @gcctabopt
9881 @item -m68000
9882 @itemx -mc68000
9883 @opindex m68000
9884 @opindex mc68000
9885 Generate output for a 68000. This is the default
9886 when the compiler is configured for 68000-based systems.
9887
9888 Use this option for microcontrollers with a 68000 or EC000 core,
9889 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9890
9891 @item -m68020
9892 @itemx -mc68020
9893 @opindex m68020
9894 @opindex mc68020
9895 Generate output for a 68020. This is the default
9896 when the compiler is configured for 68020-based systems.
9897
9898 @item -m68881
9899 @opindex m68881
9900 Generate output containing 68881 instructions for floating point.
9901 This is the default for most 68020 systems unless @option{--nfp} was
9902 specified when the compiler was configured.
9903
9904 @item -m68030
9905 @opindex m68030
9906 Generate output for a 68030. This is the default when the compiler is
9907 configured for 68030-based systems.
9908
9909 @item -m68040
9910 @opindex m68040
9911 Generate output for a 68040. This is the default when the compiler is
9912 configured for 68040-based systems.
9913
9914 This option inhibits the use of 68881/68882 instructions that have to be
9915 emulated by software on the 68040. Use this option if your 68040 does not
9916 have code to emulate those instructions.
9917
9918 @item -m68060
9919 @opindex m68060
9920 Generate output for a 68060. This is the default when the compiler is
9921 configured for 68060-based systems.
9922
9923 This option inhibits the use of 68020 and 68881/68882 instructions that
9924 have to be emulated by software on the 68060. Use this option if your 68060
9925 does not have code to emulate those instructions.
9926
9927 @item -mcpu32
9928 @opindex mcpu32
9929 Generate output for a CPU32. This is the default
9930 when the compiler is configured for CPU32-based systems.
9931
9932 Use this option for microcontrollers with a
9933 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9934 68336, 68340, 68341, 68349 and 68360.
9935
9936 @item -m5200
9937 @opindex m5200
9938 Generate output for a 520X ``coldfire'' family cpu. This is the default
9939 when the compiler is configured for 520X-based systems.
9940
9941 Use this option for microcontroller with a 5200 core, including
9942 the MCF5202, MCF5203, MCF5204 and MCF5202.
9943
9944 @item -mcfv4e
9945 @opindex mcfv4e
9946 Generate output for a ColdFire V4e family cpu (e.g.@: 547x/548x).
9947 This includes use of hardware floating point instructions.
9948
9949 @item -m68020-40
9950 @opindex m68020-40
9951 Generate output for a 68040, without using any of the new instructions.
9952 This results in code which can run relatively efficiently on either a
9953 68020/68881 or a 68030 or a 68040. The generated code does use the
9954 68881 instructions that are emulated on the 68040.
9955
9956 @item -m68020-60
9957 @opindex m68020-60
9958 Generate output for a 68060, without using any of the new instructions.
9959 This results in code which can run relatively efficiently on either a
9960 68020/68881 or a 68030 or a 68040. The generated code does use the
9961 68881 instructions that are emulated on the 68060.
9962
9963 @item -msoft-float
9964 @opindex msoft-float
9965 Generate output containing library calls for floating point.
9966 @strong{Warning:} the requisite libraries are not available for all m68k
9967 targets. Normally the facilities of the machine's usual C compiler are
9968 used, but this can't be done directly in cross-compilation. You must
9969 make your own arrangements to provide suitable library functions for
9970 cross-compilation. The embedded targets @samp{m68k-*-aout} and
9971 @samp{m68k-*-coff} do provide software floating point support.
9972
9973 @item -mshort
9974 @opindex mshort
9975 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9976 Additionally, parameters passed on the stack are also aligned to a
9977 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9978
9979 @item -mnobitfield
9980 @opindex mnobitfield
9981 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9982 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9983
9984 @item -mbitfield
9985 @opindex mbitfield
9986 Do use the bit-field instructions. The @option{-m68020} option implies
9987 @option{-mbitfield}. This is the default if you use a configuration
9988 designed for a 68020.
9989
9990 @item -mrtd
9991 @opindex mrtd
9992 Use a different function-calling convention, in which functions
9993 that take a fixed number of arguments return with the @code{rtd}
9994 instruction, which pops their arguments while returning. This
9995 saves one instruction in the caller since there is no need to pop
9996 the arguments there.
9997
9998 This calling convention is incompatible with the one normally
9999 used on Unix, so you cannot use it if you need to call libraries
10000 compiled with the Unix compiler.
10001
10002 Also, you must provide function prototypes for all functions that
10003 take variable numbers of arguments (including @code{printf});
10004 otherwise incorrect code will be generated for calls to those
10005 functions.
10006
10007 In addition, seriously incorrect code will result if you call a
10008 function with too many arguments. (Normally, extra arguments are
10009 harmlessly ignored.)
10010
10011 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10012 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10013
10014 @item -malign-int
10015 @itemx -mno-align-int
10016 @opindex malign-int
10017 @opindex mno-align-int
10018 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10019 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10020 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10021 Aligning variables on 32-bit boundaries produces code that runs somewhat
10022 faster on processors with 32-bit busses at the expense of more memory.
10023
10024 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10025 align structures containing the above types differently than
10026 most published application binary interface specifications for the m68k.
10027
10028 @item -mpcrel
10029 @opindex mpcrel
10030 Use the pc-relative addressing mode of the 68000 directly, instead of
10031 using a global offset table. At present, this option implies @option{-fpic},
10032 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
10033 not presently supported with @option{-mpcrel}, though this could be supported for
10034 68020 and higher processors.
10035
10036 @item -mno-strict-align
10037 @itemx -mstrict-align
10038 @opindex mno-strict-align
10039 @opindex mstrict-align
10040 Do not (do) assume that unaligned memory references will be handled by
10041 the system.
10042
10043 @item -msep-data
10044 Generate code that allows the data segment to be located in a different
10045 area of memory from the text segment. This allows for execute in place in
10046 an environment without virtual memory management. This option implies
10047 @option{-fPIC}.
10048
10049 @item -mno-sep-data
10050 Generate code that assumes that the data segment follows the text segment.
10051 This is the default.
10052
10053 @item -mid-shared-library
10054 Generate code that supports shared libraries via the library ID method.
10055 This allows for execute in place and shared libraries in an environment
10056 without virtual memory management. This option implies @option{-fPIC}.
10057
10058 @item -mno-id-shared-library
10059 Generate code that doesn't assume ID based shared libraries are being used.
10060 This is the default.
10061
10062 @item -mshared-library-id=n
10063 Specified the identification number of the ID based shared library being
10064 compiled. Specifying a value of 0 will generate more compact code, specifying
10065 other values will force the allocation of that number to the current
10066 library but is no more space or time efficient than omitting this option.
10067
10068 @end table
10069
10070 @node M68hc1x Options
10071 @subsection M68hc1x Options
10072 @cindex M68hc1x options
10073
10074 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10075 microcontrollers. The default values for these options depends on
10076 which style of microcontroller was selected when the compiler was configured;
10077 the defaults for the most common choices are given below.
10078
10079 @table @gcctabopt
10080 @item -m6811
10081 @itemx -m68hc11
10082 @opindex m6811
10083 @opindex m68hc11
10084 Generate output for a 68HC11. This is the default
10085 when the compiler is configured for 68HC11-based systems.
10086
10087 @item -m6812
10088 @itemx -m68hc12
10089 @opindex m6812
10090 @opindex m68hc12
10091 Generate output for a 68HC12. This is the default
10092 when the compiler is configured for 68HC12-based systems.
10093
10094 @item -m68S12
10095 @itemx -m68hcs12
10096 @opindex m68S12
10097 @opindex m68hcs12
10098 Generate output for a 68HCS12.
10099
10100 @item -mauto-incdec
10101 @opindex mauto-incdec
10102 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10103 addressing modes.
10104
10105 @item -minmax
10106 @itemx -nominmax
10107 @opindex minmax
10108 @opindex mnominmax
10109 Enable the use of 68HC12 min and max instructions.
10110
10111 @item -mlong-calls
10112 @itemx -mno-long-calls
10113 @opindex mlong-calls
10114 @opindex mno-long-calls
10115 Treat all calls as being far away (near). If calls are assumed to be
10116 far away, the compiler will use the @code{call} instruction to
10117 call a function and the @code{rtc} instruction for returning.
10118
10119 @item -mshort
10120 @opindex mshort
10121 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10122
10123 @item -msoft-reg-count=@var{count}
10124 @opindex msoft-reg-count
10125 Specify the number of pseudo-soft registers which are used for the
10126 code generation. The maximum number is 32. Using more pseudo-soft
10127 register may or may not result in better code depending on the program.
10128 The default is 4 for 68HC11 and 2 for 68HC12.
10129
10130 @end table
10131
10132 @node MCore Options
10133 @subsection MCore Options
10134 @cindex MCore options
10135
10136 These are the @samp{-m} options defined for the Motorola M*Core
10137 processors.
10138
10139 @table @gcctabopt
10140
10141 @item -mhardlit
10142 @itemx -mno-hardlit
10143 @opindex mhardlit
10144 @opindex mno-hardlit
10145 Inline constants into the code stream if it can be done in two
10146 instructions or less.
10147
10148 @item -mdiv
10149 @itemx -mno-div
10150 @opindex mdiv
10151 @opindex mno-div
10152 Use the divide instruction. (Enabled by default).
10153
10154 @item -mrelax-immediate
10155 @itemx -mno-relax-immediate
10156 @opindex mrelax-immediate
10157 @opindex mno-relax-immediate
10158 Allow arbitrary sized immediates in bit operations.
10159
10160 @item -mwide-bitfields
10161 @itemx -mno-wide-bitfields
10162 @opindex mwide-bitfields
10163 @opindex mno-wide-bitfields
10164 Always treat bit-fields as int-sized.
10165
10166 @item -m4byte-functions
10167 @itemx -mno-4byte-functions
10168 @opindex m4byte-functions
10169 @opindex mno-4byte-functions
10170 Force all functions to be aligned to a four byte boundary.
10171
10172 @item -mcallgraph-data
10173 @itemx -mno-callgraph-data
10174 @opindex mcallgraph-data
10175 @opindex mno-callgraph-data
10176 Emit callgraph information.
10177
10178 @item -mslow-bytes
10179 @itemx -mno-slow-bytes
10180 @opindex mslow-bytes
10181 @opindex mno-slow-bytes
10182 Prefer word access when reading byte quantities.
10183
10184 @item -mlittle-endian
10185 @itemx -mbig-endian
10186 @opindex mlittle-endian
10187 @opindex mbig-endian
10188 Generate code for a little endian target.
10189
10190 @item -m210
10191 @itemx -m340
10192 @opindex m210
10193 @opindex m340
10194 Generate code for the 210 processor.
10195 @end table
10196
10197 @node MIPS Options
10198 @subsection MIPS Options
10199 @cindex MIPS options
10200
10201 @table @gcctabopt
10202
10203 @item -EB
10204 @opindex EB
10205 Generate big-endian code.
10206
10207 @item -EL
10208 @opindex EL
10209 Generate little-endian code. This is the default for @samp{mips*el-*-*}
10210 configurations.
10211
10212 @item -march=@var{arch}
10213 @opindex march
10214 Generate code that will run on @var{arch}, which can be the name of a
10215 generic MIPS ISA, or the name of a particular processor.
10216 The ISA names are:
10217 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10218 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10219 The processor names are:
10220 @samp{4kc}, @samp{4km}, @samp{4kp},
10221 @samp{5kc}, @samp{5kf},
10222 @samp{20kc},
10223 @samp{24k}, @samp{24kc}, @samp{24kf}, @samp{24kx},
10224 @samp{m4k},
10225 @samp{orion},
10226 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10227 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10228 @samp{rm7000}, @samp{rm9000},
10229 @samp{sb1},
10230 @samp{sr71000},
10231 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10232 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10233 The special value @samp{from-abi} selects the
10234 most compatible architecture for the selected ABI (that is,
10235 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10236
10237 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10238 (for example, @samp{-march=r2k}). Prefixes are optional, and
10239 @samp{vr} may be written @samp{r}.
10240
10241 GCC defines two macros based on the value of this option. The first
10242 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10243 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
10244 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10245 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10246 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10247
10248 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10249 above. In other words, it will have the full prefix and will not
10250 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
10251 the macro names the resolved architecture (either @samp{"mips1"} or
10252 @samp{"mips3"}). It names the default architecture when no
10253 @option{-march} option is given.
10254
10255 @item -mtune=@var{arch}
10256 @opindex mtune
10257 Optimize for @var{arch}. Among other things, this option controls
10258 the way instructions are scheduled, and the perceived cost of arithmetic
10259 operations. The list of @var{arch} values is the same as for
10260 @option{-march}.
10261
10262 When this option is not used, GCC will optimize for the processor
10263 specified by @option{-march}. By using @option{-march} and
10264 @option{-mtune} together, it is possible to generate code that will
10265 run on a family of processors, but optimize the code for one
10266 particular member of that family.
10267
10268 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10269 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10270 @samp{-march} ones described above.
10271
10272 @item -mips1
10273 @opindex mips1
10274 Equivalent to @samp{-march=mips1}.
10275
10276 @item -mips2
10277 @opindex mips2
10278 Equivalent to @samp{-march=mips2}.
10279
10280 @item -mips3
10281 @opindex mips3
10282 Equivalent to @samp{-march=mips3}.
10283
10284 @item -mips4
10285 @opindex mips4
10286 Equivalent to @samp{-march=mips4}.
10287
10288 @item -mips32
10289 @opindex mips32
10290 Equivalent to @samp{-march=mips32}.
10291
10292 @item -mips32r2
10293 @opindex mips32r2
10294 Equivalent to @samp{-march=mips32r2}.
10295
10296 @item -mips64
10297 @opindex mips64
10298 Equivalent to @samp{-march=mips64}.
10299
10300 @item -mips16
10301 @itemx -mno-mips16
10302 @opindex mips16
10303 @opindex mno-mips16
10304 Generate (do not generate) MIPS16 code. If GCC is targetting a
10305 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10306
10307 @item -mabi=32
10308 @itemx -mabi=o64
10309 @itemx -mabi=n32
10310 @itemx -mabi=64
10311 @itemx -mabi=eabi
10312 @opindex mabi=32
10313 @opindex mabi=o64
10314 @opindex mabi=n32
10315 @opindex mabi=64
10316 @opindex mabi=eabi
10317 Generate code for the given ABI@.
10318
10319 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
10320 generates 64-bit code when you select a 64-bit architecture, but you
10321 can use @option{-mgp32} to get 32-bit code instead.
10322
10323 For information about the O64 ABI, see
10324 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10325
10326 @item -mabicalls
10327 @itemx -mno-abicalls
10328 @opindex mabicalls
10329 @opindex mno-abicalls
10330 Generate (do not generate) SVR4-style position-independent code.
10331 @option{-mabicalls} is the default for SVR4-based systems.
10332
10333 @item -mxgot
10334 @itemx -mno-xgot
10335 @opindex mxgot
10336 @opindex mno-xgot
10337 Lift (do not lift) the usual restrictions on the size of the global
10338 offset table.
10339
10340 GCC normally uses a single instruction to load values from the GOT@.
10341 While this is relatively efficient, it will only work if the GOT
10342 is smaller than about 64k. Anything larger will cause the linker
10343 to report an error such as:
10344
10345 @cindex relocation truncated to fit (MIPS)
10346 @smallexample
10347 relocation truncated to fit: R_MIPS_GOT16 foobar
10348 @end smallexample
10349
10350 If this happens, you should recompile your code with @option{-mxgot}.
10351 It should then work with very large GOTs, although it will also be
10352 less efficient, since it will take three instructions to fetch the
10353 value of a global symbol.
10354
10355 Note that some linkers can create multiple GOTs. If you have such a
10356 linker, you should only need to use @option{-mxgot} when a single object
10357 file accesses more than 64k's worth of GOT entries. Very few do.
10358
10359 These options have no effect unless GCC is generating position
10360 independent code.
10361
10362 @item -mgp32
10363 @opindex mgp32
10364 Assume that general-purpose registers are 32 bits wide.
10365
10366 @item -mgp64
10367 @opindex mgp64
10368 Assume that general-purpose registers are 64 bits wide.
10369
10370 @item -mfp32
10371 @opindex mfp32
10372 Assume that floating-point registers are 32 bits wide.
10373
10374 @item -mfp64
10375 @opindex mfp64
10376 Assume that floating-point registers are 64 bits wide.
10377
10378 @item -mhard-float
10379 @opindex mhard-float
10380 Use floating-point coprocessor instructions.
10381
10382 @item -msoft-float
10383 @opindex msoft-float
10384 Do not use floating-point coprocessor instructions. Implement
10385 floating-point calculations using library calls instead.
10386
10387 @item -msingle-float
10388 @opindex msingle-float
10389 Assume that the floating-point coprocessor only supports single-precision
10390 operations.
10391
10392 @itemx -mdouble-float
10393 @opindex mdouble-float
10394 Assume that the floating-point coprocessor supports double-precision
10395 operations. This is the default.
10396
10397 @itemx -mdsp
10398 @itemx -mno-dsp
10399 @opindex mdsp
10400 @opindex mno-dsp
10401 Use (do not use) the MIPS DSP ASE. @xref{MIPS DSP Built-in Functions}.
10402
10403 @itemx -mpaired-single
10404 @itemx -mno-paired-single
10405 @opindex mpaired-single
10406 @opindex mno-paired-single
10407 Use (do not use) paired-single floating-point instructions.
10408 @xref{MIPS Paired-Single Support}. This option can only be used
10409 when generating 64-bit code and requires hardware floating-point
10410 support to be enabled.
10411
10412 @itemx -mips3d
10413 @itemx -mno-mips3d
10414 @opindex mips3d
10415 @opindex mno-mips3d
10416 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
10417 The option @option{-mips3d} implies @option{-mpaired-single}.
10418
10419 @item -mlong64
10420 @opindex mlong64
10421 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
10422 an explanation of the default and the way that the pointer size is
10423 determined.
10424
10425 @item -mlong32
10426 @opindex mlong32
10427 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10428
10429 The default size of @code{int}s, @code{long}s and pointers depends on
10430 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
10431 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10432 32-bit @code{long}s. Pointers are the same size as @code{long}s,
10433 or the same size as integer registers, whichever is smaller.
10434
10435 @item -msym32
10436 @itemx -mno-sym32
10437 @opindex msym32
10438 @opindex mno-sym32
10439 Assume (do not assume) that all symbols have 32-bit values, regardless
10440 of the selected ABI@. This option is useful in combination with
10441 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10442 to generate shorter and faster references to symbolic addresses.
10443
10444 @item -G @var{num}
10445 @opindex G
10446 @cindex smaller data references (MIPS)
10447 @cindex gp-relative references (MIPS)
10448 Put global and static items less than or equal to @var{num} bytes into
10449 the small data or bss section instead of the normal data or bss section.
10450 This allows the data to be accessed using a single instruction.
10451
10452 All modules should be compiled with the same @option{-G @var{num}}
10453 value.
10454
10455 @item -membedded-data
10456 @itemx -mno-embedded-data
10457 @opindex membedded-data
10458 @opindex mno-embedded-data
10459 Allocate variables to the read-only data section first if possible, then
10460 next in the small data section if possible, otherwise in data. This gives
10461 slightly slower code than the default, but reduces the amount of RAM required
10462 when executing, and thus may be preferred for some embedded systems.
10463
10464 @item -muninit-const-in-rodata
10465 @itemx -mno-uninit-const-in-rodata
10466 @opindex muninit-const-in-rodata
10467 @opindex mno-uninit-const-in-rodata
10468 Put uninitialized @code{const} variables in the read-only data section.
10469 This option is only meaningful in conjunction with @option{-membedded-data}.
10470
10471 @item -msplit-addresses
10472 @itemx -mno-split-addresses
10473 @opindex msplit-addresses
10474 @opindex mno-split-addresses
10475 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10476 relocation operators. This option has been superseded by
10477 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10478
10479 @item -mexplicit-relocs
10480 @itemx -mno-explicit-relocs
10481 @opindex mexplicit-relocs
10482 @opindex mno-explicit-relocs
10483 Use (do not use) assembler relocation operators when dealing with symbolic
10484 addresses. The alternative, selected by @option{-mno-explicit-relocs},
10485 is to use assembler macros instead.
10486
10487 @option{-mexplicit-relocs} is the default if GCC was configured
10488 to use an assembler that supports relocation operators.
10489
10490 @item -mcheck-zero-division
10491 @itemx -mno-check-zero-division
10492 @opindex mcheck-zero-division
10493 @opindex mno-check-zero-division
10494 Trap (do not trap) on integer division by zero. The default is
10495 @option{-mcheck-zero-division}.
10496
10497 @item -mdivide-traps
10498 @itemx -mdivide-breaks
10499 @opindex mdivide-traps
10500 @opindex mdivide-breaks
10501 MIPS systems check for division by zero by generating either a
10502 conditional trap or a break instruction. Using traps results in
10503 smaller code, but is only supported on MIPS II and later. Also, some
10504 versions of the Linux kernel have a bug that prevents trap from
10505 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
10506 allow conditional traps on architectures that support them and
10507 @option{-mdivide-breaks} to force the use of breaks.
10508
10509 The default is usually @option{-mdivide-traps}, but this can be
10510 overridden at configure time using @option{--with-divide=breaks}.
10511 Divide-by-zero checks can be completely disabled using
10512 @option{-mno-check-zero-division}.
10513
10514 @item -mmemcpy
10515 @itemx -mno-memcpy
10516 @opindex mmemcpy
10517 @opindex mno-memcpy
10518 Force (do not force) the use of @code{memcpy()} for non-trivial block
10519 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
10520 most constant-sized copies.
10521
10522 @item -mlong-calls
10523 @itemx -mno-long-calls
10524 @opindex mlong-calls
10525 @opindex mno-long-calls
10526 Disable (do not disable) use of the @code{jal} instruction. Calling
10527 functions using @code{jal} is more efficient but requires the caller
10528 and callee to be in the same 256 megabyte segment.
10529
10530 This option has no effect on abicalls code. The default is
10531 @option{-mno-long-calls}.
10532
10533 @item -mmad
10534 @itemx -mno-mad
10535 @opindex mmad
10536 @opindex mno-mad
10537 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10538 instructions, as provided by the R4650 ISA@.
10539
10540 @item -mfused-madd
10541 @itemx -mno-fused-madd
10542 @opindex mfused-madd
10543 @opindex mno-fused-madd
10544 Enable (disable) use of the floating point multiply-accumulate
10545 instructions, when they are available. The default is
10546 @option{-mfused-madd}.
10547
10548 When multiply-accumulate instructions are used, the intermediate
10549 product is calculated to infinite precision and is not subject to
10550 the FCSR Flush to Zero bit. This may be undesirable in some
10551 circumstances.
10552
10553 @item -nocpp
10554 @opindex nocpp
10555 Tell the MIPS assembler to not run its preprocessor over user
10556 assembler files (with a @samp{.s} suffix) when assembling them.
10557
10558 @item -mfix-r4000
10559 @itemx -mno-fix-r4000
10560 @opindex mfix-r4000
10561 @opindex mno-fix-r4000
10562 Work around certain R4000 CPU errata:
10563 @itemize @minus
10564 @item
10565 A double-word or a variable shift may give an incorrect result if executed
10566 immediately after starting an integer division.
10567 @item
10568 A double-word or a variable shift may give an incorrect result if executed
10569 while an integer multiplication is in progress.
10570 @item
10571 An integer division may give an incorrect result if started in a delay slot
10572 of a taken branch or a jump.
10573 @end itemize
10574
10575 @item -mfix-r4400
10576 @itemx -mno-fix-r4400
10577 @opindex mfix-r4400
10578 @opindex mno-fix-r4400
10579 Work around certain R4400 CPU errata:
10580 @itemize @minus
10581 @item
10582 A double-word or a variable shift may give an incorrect result if executed
10583 immediately after starting an integer division.
10584 @end itemize
10585
10586 @item -mfix-vr4120
10587 @itemx -mno-fix-vr4120
10588 @opindex mfix-vr4120
10589 Work around certain VR4120 errata:
10590 @itemize @minus
10591 @item
10592 @code{dmultu} does not always produce the correct result.
10593 @item
10594 @code{div} and @code{ddiv} do not always produce the correct result if one
10595 of the operands is negative.
10596 @end itemize
10597 The workarounds for the division errata rely on special functions in
10598 @file{libgcc.a}. At present, these functions are only provided by
10599 the @code{mips64vr*-elf} configurations.
10600
10601 Other VR4120 errata require a nop to be inserted between certain pairs of
10602 instructions. These errata are handled by the assembler, not by GCC itself.
10603
10604 @item -mfix-vr4130
10605 @opindex mfix-vr4130
10606 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
10607 workarounds are implemented by the assembler rather than by GCC,
10608 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10609 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10610 instructions are available instead.
10611
10612 @item -mfix-sb1
10613 @itemx -mno-fix-sb1
10614 @opindex mfix-sb1
10615 Work around certain SB-1 CPU core errata.
10616 (This flag currently works around the SB-1 revision 2
10617 ``F1'' and ``F2'' floating point errata.)
10618
10619 @item -mflush-func=@var{func}
10620 @itemx -mno-flush-func
10621 @opindex mflush-func
10622 Specifies the function to call to flush the I and D caches, or to not
10623 call any such function. If called, the function must take the same
10624 arguments as the common @code{_flush_func()}, that is, the address of the
10625 memory range for which the cache is being flushed, the size of the
10626 memory range, and the number 3 (to flush both caches). The default
10627 depends on the target GCC was configured for, but commonly is either
10628 @samp{_flush_func} or @samp{__cpu_flush}.
10629
10630 @item -mbranch-likely
10631 @itemx -mno-branch-likely
10632 @opindex mbranch-likely
10633 @opindex mno-branch-likely
10634 Enable or disable use of Branch Likely instructions, regardless of the
10635 default for the selected architecture. By default, Branch Likely
10636 instructions may be generated if they are supported by the selected
10637 architecture. An exception is for the MIPS32 and MIPS64 architectures
10638 and processors which implement those architectures; for those, Branch
10639 Likely instructions will not be generated by default because the MIPS32
10640 and MIPS64 architectures specifically deprecate their use.
10641
10642 @item -mfp-exceptions
10643 @itemx -mno-fp-exceptions
10644 @opindex mfp-exceptions
10645 Specifies whether FP exceptions are enabled. This affects how we schedule
10646 FP instructions for some processors. The default is that FP exceptions are
10647 enabled.
10648
10649 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10650 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
10651 FP pipe.
10652
10653 @item -mvr4130-align
10654 @itemx -mno-vr4130-align
10655 @opindex mvr4130-align
10656 The VR4130 pipeline is two-way superscalar, but can only issue two
10657 instructions together if the first one is 8-byte aligned. When this
10658 option is enabled, GCC will align pairs of instructions that it
10659 thinks should execute in parallel.
10660
10661 This option only has an effect when optimizing for the VR4130.
10662 It normally makes code faster, but at the expense of making it bigger.
10663 It is enabled by default at optimization level @option{-O3}.
10664 @end table
10665
10666 @node MMIX Options
10667 @subsection MMIX Options
10668 @cindex MMIX Options
10669
10670 These options are defined for the MMIX:
10671
10672 @table @gcctabopt
10673 @item -mlibfuncs
10674 @itemx -mno-libfuncs
10675 @opindex mlibfuncs
10676 @opindex mno-libfuncs
10677 Specify that intrinsic library functions are being compiled, passing all
10678 values in registers, no matter the size.
10679
10680 @item -mepsilon
10681 @itemx -mno-epsilon
10682 @opindex mepsilon
10683 @opindex mno-epsilon
10684 Generate floating-point comparison instructions that compare with respect
10685 to the @code{rE} epsilon register.
10686
10687 @item -mabi=mmixware
10688 @itemx -mabi=gnu
10689 @opindex mabi-mmixware
10690 @opindex mabi=gnu
10691 Generate code that passes function parameters and return values that (in
10692 the called function) are seen as registers @code{$0} and up, as opposed to
10693 the GNU ABI which uses global registers @code{$231} and up.
10694
10695 @item -mzero-extend
10696 @itemx -mno-zero-extend
10697 @opindex mzero-extend
10698 @opindex mno-zero-extend
10699 When reading data from memory in sizes shorter than 64 bits, use (do not
10700 use) zero-extending load instructions by default, rather than
10701 sign-extending ones.
10702
10703 @item -mknuthdiv
10704 @itemx -mno-knuthdiv
10705 @opindex mknuthdiv
10706 @opindex mno-knuthdiv
10707 Make the result of a division yielding a remainder have the same sign as
10708 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10709 remainder follows the sign of the dividend. Both methods are
10710 arithmetically valid, the latter being almost exclusively used.
10711
10712 @item -mtoplevel-symbols
10713 @itemx -mno-toplevel-symbols
10714 @opindex mtoplevel-symbols
10715 @opindex mno-toplevel-symbols
10716 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10717 code can be used with the @code{PREFIX} assembly directive.
10718
10719 @item -melf
10720 @opindex melf
10721 Generate an executable in the ELF format, rather than the default
10722 @samp{mmo} format used by the @command{mmix} simulator.
10723
10724 @item -mbranch-predict
10725 @itemx -mno-branch-predict
10726 @opindex mbranch-predict
10727 @opindex mno-branch-predict
10728 Use (do not use) the probable-branch instructions, when static branch
10729 prediction indicates a probable branch.
10730
10731 @item -mbase-addresses
10732 @itemx -mno-base-addresses
10733 @opindex mbase-addresses
10734 @opindex mno-base-addresses
10735 Generate (do not generate) code that uses @emph{base addresses}. Using a
10736 base address automatically generates a request (handled by the assembler
10737 and the linker) for a constant to be set up in a global register. The
10738 register is used for one or more base address requests within the range 0
10739 to 255 from the value held in the register. The generally leads to short
10740 and fast code, but the number of different data items that can be
10741 addressed is limited. This means that a program that uses lots of static
10742 data may require @option{-mno-base-addresses}.
10743
10744 @item -msingle-exit
10745 @itemx -mno-single-exit
10746 @opindex msingle-exit
10747 @opindex mno-single-exit
10748 Force (do not force) generated code to have a single exit point in each
10749 function.
10750 @end table
10751
10752 @node MN10300 Options
10753 @subsection MN10300 Options
10754 @cindex MN10300 options
10755
10756 These @option{-m} options are defined for Matsushita MN10300 architectures:
10757
10758 @table @gcctabopt
10759 @item -mmult-bug
10760 @opindex mmult-bug
10761 Generate code to avoid bugs in the multiply instructions for the MN10300
10762 processors. This is the default.
10763
10764 @item -mno-mult-bug
10765 @opindex mno-mult-bug
10766 Do not generate code to avoid bugs in the multiply instructions for the
10767 MN10300 processors.
10768
10769 @item -mam33
10770 @opindex mam33
10771 Generate code which uses features specific to the AM33 processor.
10772
10773 @item -mno-am33
10774 @opindex mno-am33
10775 Do not generate code which uses features specific to the AM33 processor. This
10776 is the default.
10777
10778 @item -mreturn-pointer-on-d0
10779 @opindex mreturn-pointer-on-d0
10780 When generating a function which returns a pointer, return the pointer
10781 in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
10782 only in a0, and attempts to call such functions without a prototype
10783 would result in errors. Note that this option is on by default; use
10784 @option{-mno-return-pointer-on-d0} to disable it.
10785
10786 @item -mno-crt0
10787 @opindex mno-crt0
10788 Do not link in the C run-time initialization object file.
10789
10790 @item -mrelax
10791 @opindex mrelax
10792 Indicate to the linker that it should perform a relaxation optimization pass
10793 to shorten branches, calls and absolute memory addresses. This option only
10794 has an effect when used on the command line for the final link step.
10795
10796 This option makes symbolic debugging impossible.
10797 @end table
10798
10799 @node MT Options
10800 @subsection MT Options
10801 @cindex MT options
10802
10803 These @option{-m} options are defined for Morpho MT architectures:
10804
10805 @table @gcctabopt
10806
10807 @item -march=@var{cpu-type}
10808 @opindex march
10809 Generate code that will run on @var{cpu-type}, which is the name of a system
10810 representing a certain processor type. Possible values for
10811 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
10812 @samp{ms1-16-003} and @samp{ms2}.
10813
10814 When this option is not used, the default is @option{-march=ms1-16-002}.
10815
10816 @item -mbacc
10817 @opindex mbacc
10818 Use byte loads and stores when generating code.
10819
10820 @item -mno-bacc
10821 @opindex mno-bacc
10822 Do not use byte loads and stores when generating code.
10823
10824 @item -msim
10825 @opindex msim
10826 Use simulator runtime
10827
10828 @item -mno-crt0
10829 @opindex mno-crt0
10830 Do not link in the C run-time initialization object file
10831 @file{crti.o}. Other run-time initialization and termination files
10832 such as @file{startup.o} and @file{exit.o} are still included on the
10833 linker command line.
10834
10835 @end table
10836
10837 @node PDP-11 Options
10838 @subsection PDP-11 Options
10839 @cindex PDP-11 Options
10840
10841 These options are defined for the PDP-11:
10842
10843 @table @gcctabopt
10844 @item -mfpu
10845 @opindex mfpu
10846 Use hardware FPP floating point. This is the default. (FIS floating
10847 point on the PDP-11/40 is not supported.)
10848
10849 @item -msoft-float
10850 @opindex msoft-float
10851 Do not use hardware floating point.
10852
10853 @item -mac0
10854 @opindex mac0
10855 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10856
10857 @item -mno-ac0
10858 @opindex mno-ac0
10859 Return floating-point results in memory. This is the default.
10860
10861 @item -m40
10862 @opindex m40
10863 Generate code for a PDP-11/40.
10864
10865 @item -m45
10866 @opindex m45
10867 Generate code for a PDP-11/45. This is the default.
10868
10869 @item -m10
10870 @opindex m10
10871 Generate code for a PDP-11/10.
10872
10873 @item -mbcopy-builtin
10874 @opindex bcopy-builtin
10875 Use inline @code{movmemhi} patterns for copying memory. This is the
10876 default.
10877
10878 @item -mbcopy
10879 @opindex mbcopy
10880 Do not use inline @code{movmemhi} patterns for copying memory.
10881
10882 @item -mint16
10883 @itemx -mno-int32
10884 @opindex mint16
10885 @opindex mno-int32
10886 Use 16-bit @code{int}. This is the default.
10887
10888 @item -mint32
10889 @itemx -mno-int16
10890 @opindex mint32
10891 @opindex mno-int16
10892 Use 32-bit @code{int}.
10893
10894 @item -mfloat64
10895 @itemx -mno-float32
10896 @opindex mfloat64
10897 @opindex mno-float32
10898 Use 64-bit @code{float}. This is the default.
10899
10900 @item -mfloat32
10901 @itemx -mno-float64
10902 @opindex mfloat32
10903 @opindex mno-float64
10904 Use 32-bit @code{float}.
10905
10906 @item -mabshi
10907 @opindex mabshi
10908 Use @code{abshi2} pattern. This is the default.
10909
10910 @item -mno-abshi
10911 @opindex mno-abshi
10912 Do not use @code{abshi2} pattern.
10913
10914 @item -mbranch-expensive
10915 @opindex mbranch-expensive
10916 Pretend that branches are expensive. This is for experimenting with
10917 code generation only.
10918
10919 @item -mbranch-cheap
10920 @opindex mbranch-cheap
10921 Do not pretend that branches are expensive. This is the default.
10922
10923 @item -msplit
10924 @opindex msplit
10925 Generate code for a system with split I&D@.
10926
10927 @item -mno-split
10928 @opindex mno-split
10929 Generate code for a system without split I&D@. This is the default.
10930
10931 @item -munix-asm
10932 @opindex munix-asm
10933 Use Unix assembler syntax. This is the default when configured for
10934 @samp{pdp11-*-bsd}.
10935
10936 @item -mdec-asm
10937 @opindex mdec-asm
10938 Use DEC assembler syntax. This is the default when configured for any
10939 PDP-11 target other than @samp{pdp11-*-bsd}.
10940 @end table
10941
10942 @node PowerPC Options
10943 @subsection PowerPC Options
10944 @cindex PowerPC options
10945
10946 These are listed under @xref{RS/6000 and PowerPC Options}.
10947
10948 @node RS/6000 and PowerPC Options
10949 @subsection IBM RS/6000 and PowerPC Options
10950 @cindex RS/6000 and PowerPC Options
10951 @cindex IBM RS/6000 and PowerPC Options
10952
10953 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10954 @table @gcctabopt
10955 @item -mpower
10956 @itemx -mno-power
10957 @itemx -mpower2
10958 @itemx -mno-power2
10959 @itemx -mpowerpc
10960 @itemx -mno-powerpc
10961 @itemx -mpowerpc-gpopt
10962 @itemx -mno-powerpc-gpopt
10963 @itemx -mpowerpc-gfxopt
10964 @itemx -mno-powerpc-gfxopt
10965 @itemx -mpowerpc64
10966 @itemx -mno-powerpc64
10967 @itemx -mmfcrf
10968 @itemx -mno-mfcrf
10969 @itemx -mpopcntb
10970 @itemx -mno-popcntb
10971 @itemx -mfprnd
10972 @itemx -mno-fprnd
10973 @opindex mpower
10974 @opindex mno-power
10975 @opindex mpower2
10976 @opindex mno-power2
10977 @opindex mpowerpc
10978 @opindex mno-powerpc
10979 @opindex mpowerpc-gpopt
10980 @opindex mno-powerpc-gpopt
10981 @opindex mpowerpc-gfxopt
10982 @opindex mno-powerpc-gfxopt
10983 @opindex mpowerpc64
10984 @opindex mno-powerpc64
10985 @opindex mmfcrf
10986 @opindex mno-mfcrf
10987 @opindex mpopcntb
10988 @opindex mno-popcntb
10989 @opindex mfprnd
10990 @opindex mno-fprnd
10991 GCC supports two related instruction set architectures for the
10992 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10993 instructions supported by the @samp{rios} chip set used in the original
10994 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10995 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
10996 the IBM 4xx, 6xx, and follow-on microprocessors.
10997
10998 Neither architecture is a subset of the other. However there is a
10999 large common subset of instructions supported by both. An MQ
11000 register is included in processors supporting the POWER architecture.
11001
11002 You use these options to specify which instructions are available on the
11003 processor you are using. The default value of these options is
11004 determined when configuring GCC@. Specifying the
11005 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11006 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
11007 rather than the options listed above.
11008
11009 The @option{-mpower} option allows GCC to generate instructions that
11010 are found only in the POWER architecture and to use the MQ register.
11011 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11012 to generate instructions that are present in the POWER2 architecture but
11013 not the original POWER architecture.
11014
11015 The @option{-mpowerpc} option allows GCC to generate instructions that
11016 are found only in the 32-bit subset of the PowerPC architecture.
11017 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11018 GCC to use the optional PowerPC architecture instructions in the
11019 General Purpose group, including floating-point square root. Specifying
11020 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11021 use the optional PowerPC architecture instructions in the Graphics
11022 group, including floating-point select.
11023
11024 The @option{-mmfcrf} option allows GCC to generate the move from
11025 condition register field instruction implemented on the POWER4
11026 processor and other processors that support the PowerPC V2.01
11027 architecture.
11028 The @option{-mpopcntb} option allows GCC to generate the popcount and
11029 double precision FP reciprocal estimate instruction implemented on the
11030 POWER5 processor and other processors that support the PowerPC V2.02
11031 architecture.
11032 The @option{-mfprnd} option allows GCC to generate the FP round to
11033 integer instructions implemented on the POWER5+ processor and other
11034 processors that support the PowerPC V2.03 architecture.
11035
11036 The @option{-mpowerpc64} option allows GCC to generate the additional
11037 64-bit instructions that are found in the full PowerPC64 architecture
11038 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
11039 @option{-mno-powerpc64}.
11040
11041 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11042 will use only the instructions in the common subset of both
11043 architectures plus some special AIX common-mode calls, and will not use
11044 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
11045 permits GCC to use any instruction from either architecture and to
11046 allow use of the MQ register; specify this for the Motorola MPC601.
11047
11048 @item -mnew-mnemonics
11049 @itemx -mold-mnemonics
11050 @opindex mnew-mnemonics
11051 @opindex mold-mnemonics
11052 Select which mnemonics to use in the generated assembler code. With
11053 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11054 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
11055 assembler mnemonics defined for the POWER architecture. Instructions
11056 defined in only one architecture have only one mnemonic; GCC uses that
11057 mnemonic irrespective of which of these options is specified.
11058
11059 GCC defaults to the mnemonics appropriate for the architecture in
11060 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11061 value of these option. Unless you are building a cross-compiler, you
11062 should normally not specify either @option{-mnew-mnemonics} or
11063 @option{-mold-mnemonics}, but should instead accept the default.
11064
11065 @item -mcpu=@var{cpu_type}
11066 @opindex mcpu
11067 Set architecture type, register usage, choice of mnemonics, and
11068 instruction scheduling parameters for machine type @var{cpu_type}.
11069 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11070 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11071 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11072 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11073 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11074 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11075 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11076 @samp{power4}, @samp{power5}, @samp{power5+},
11077 @samp{common}, @samp{powerpc}, @samp{powerpc64},
11078 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11079
11080 @option{-mcpu=common} selects a completely generic processor. Code
11081 generated under this option will run on any POWER or PowerPC processor.
11082 GCC will use only the instructions in the common subset of both
11083 architectures, and will not use the MQ register. GCC assumes a generic
11084 processor model for scheduling purposes.
11085
11086 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11087 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11088 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11089 types, with an appropriate, generic processor model assumed for
11090 scheduling purposes.
11091
11092 The other options specify a specific processor. Code generated under
11093 those options will run best on that processor, and may not run at all on
11094 others.
11095
11096 The @option{-mcpu} options automatically enable or disable the
11097 following options: @option{-maltivec}, @option{-mfprnd},
11098 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11099 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11100 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11101 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw}.
11102 The particular options
11103 set for any particular CPU will vary between compiler versions,
11104 depending on what setting seems to produce optimal code for that CPU;
11105 it doesn't necessarily reflect the actual hardware's capabilities. If
11106 you wish to set an individual option to a particular value, you may
11107 specify it after the @option{-mcpu} option, like @samp{-mcpu=970
11108 -mno-altivec}.
11109
11110 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11111 not enabled or disabled by the @option{-mcpu} option at present because
11112 AIX does not have full support for these options. You may still
11113 enable or disable them individually if you're sure it'll work in your
11114 environment.
11115
11116 @item -mtune=@var{cpu_type}
11117 @opindex mtune
11118 Set the instruction scheduling parameters for machine type
11119 @var{cpu_type}, but do not set the architecture type, register usage, or
11120 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
11121 values for @var{cpu_type} are used for @option{-mtune} as for
11122 @option{-mcpu}. If both are specified, the code generated will use the
11123 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11124 scheduling parameters set by @option{-mtune}.
11125
11126 @item -mswdiv
11127 @itemx -mno-swdiv
11128 @opindex mswdiv
11129 @opindex mno-swdiv
11130 Generate code to compute division as reciprocal estimate and iterative
11131 refinement, creating opportunities for increased throughput. This
11132 feature requires: optional PowerPC Graphics instruction set for single
11133 precision and FRE instruction for double precision, assuming divides
11134 cannot generate user-visible traps, and the domain values not include
11135 Infinities, denormals or zero denominator.
11136
11137 @item -maltivec
11138 @itemx -mno-altivec
11139 @opindex maltivec
11140 @opindex mno-altivec
11141 Generate code that uses (does not use) AltiVec instructions, and also
11142 enable the use of built-in functions that allow more direct access to
11143 the AltiVec instruction set. You may also need to set
11144 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11145 enhancements.
11146
11147 @item -mvrsave
11148 @item -mno-vrsave
11149 @opindex mvrsave
11150 @opindex mno-vrsave
11151 Generate VRSAVE instructions when generating AltiVec code.
11152
11153 @item -msecure-plt
11154 @opindex msecure-plt
11155 Generate code that allows ld and ld.so to build executables and shared
11156 libraries with non-exec .plt and .got sections. This is a PowerPC
11157 32-bit SYSV ABI option.
11158
11159 @item -mbss-plt
11160 @opindex mbss-plt
11161 Generate code that uses a BSS .plt section that ld.so fills in, and
11162 requires .plt and .got sections that are both writable and executable.
11163 This is a PowerPC 32-bit SYSV ABI option.
11164
11165 @item -misel
11166 @itemx -mno-isel
11167 @opindex misel
11168 @opindex mno-isel
11169 This switch enables or disables the generation of ISEL instructions.
11170
11171 @item -misel=@var{yes/no}
11172 This switch has been deprecated. Use @option{-misel} and
11173 @option{-mno-isel} instead.
11174
11175 @item -mspe
11176 @itemx -mno-isel
11177 @opindex mspe
11178 @opindex mno-spe
11179 This switch enables or disables the generation of SPE simd
11180 instructions.
11181
11182 @item -mspe=@var{yes/no}
11183 This option has been deprecated. Use @option{-mspe} and
11184 @option{-mno-spe} instead.
11185
11186 @item -mfloat-gprs=@var{yes/single/double/no}
11187 @itemx -mfloat-gprs
11188 @opindex mfloat-gprs
11189 This switch enables or disables the generation of floating point
11190 operations on the general purpose registers for architectures that
11191 support it.
11192
11193 The argument @var{yes} or @var{single} enables the use of
11194 single-precision floating point operations.
11195
11196 The argument @var{double} enables the use of single and
11197 double-precision floating point operations.
11198
11199 The argument @var{no} disables floating point operations on the
11200 general purpose registers.
11201
11202 This option is currently only available on the MPC854x.
11203
11204 @item -m32
11205 @itemx -m64
11206 @opindex m32
11207 @opindex m64
11208 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11209 targets (including GNU/Linux). The 32-bit environment sets int, long
11210 and pointer to 32 bits and generates code that runs on any PowerPC
11211 variant. The 64-bit environment sets int to 32 bits and long and
11212 pointer to 64 bits, and generates code for PowerPC64, as for
11213 @option{-mpowerpc64}.
11214
11215 @item -mfull-toc
11216 @itemx -mno-fp-in-toc
11217 @itemx -mno-sum-in-toc
11218 @itemx -mminimal-toc
11219 @opindex mfull-toc
11220 @opindex mno-fp-in-toc
11221 @opindex mno-sum-in-toc
11222 @opindex mminimal-toc
11223 Modify generation of the TOC (Table Of Contents), which is created for
11224 every executable file. The @option{-mfull-toc} option is selected by
11225 default. In that case, GCC will allocate at least one TOC entry for
11226 each unique non-automatic variable reference in your program. GCC
11227 will also place floating-point constants in the TOC@. However, only
11228 16,384 entries are available in the TOC@.
11229
11230 If you receive a linker error message that saying you have overflowed
11231 the available TOC space, you can reduce the amount of TOC space used
11232 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11233 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11234 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11235 generate code to calculate the sum of an address and a constant at
11236 run-time instead of putting that sum into the TOC@. You may specify one
11237 or both of these options. Each causes GCC to produce very slightly
11238 slower and larger code at the expense of conserving TOC space.
11239
11240 If you still run out of space in the TOC even when you specify both of
11241 these options, specify @option{-mminimal-toc} instead. This option causes
11242 GCC to make only one TOC entry for every file. When you specify this
11243 option, GCC will produce code that is slower and larger but which
11244 uses extremely little TOC space. You may wish to use this option
11245 only on files that contain less frequently executed code.
11246
11247 @item -maix64
11248 @itemx -maix32
11249 @opindex maix64
11250 @opindex maix32
11251 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11252 @code{long} type, and the infrastructure needed to support them.
11253 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11254 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11255 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
11256
11257 @item -mxl-compat
11258 @itemx -mno-xl-compat
11259 @opindex mxl-compat
11260 @opindex mno-xl-compat
11261 Produce code that conforms more closely to IBM XL compiler semantics
11262 when using AIX-compatible ABI. Pass floating-point arguments to
11263 prototyped functions beyond the register save area (RSA) on the stack
11264 in addition to argument FPRs. Do not assume that most significant
11265 double in 128-bit long double value is properly rounded when comparing
11266 values and converting to double. Use XL symbol names for long double
11267 support routines.
11268
11269 The AIX calling convention was extended but not initially documented to
11270 handle an obscure K&R C case of calling a function that takes the
11271 address of its arguments with fewer arguments than declared. IBM XL
11272 compilers access floating point arguments which do not fit in the
11273 RSA from the stack when a subroutine is compiled without
11274 optimization. Because always storing floating-point arguments on the
11275 stack is inefficient and rarely needed, this option is not enabled by
11276 default and only is necessary when calling subroutines compiled by IBM
11277 XL compilers without optimization.
11278
11279 @item -mpe
11280 @opindex mpe
11281 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
11282 application written to use message passing with special startup code to
11283 enable the application to run. The system must have PE installed in the
11284 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11285 must be overridden with the @option{-specs=} option to specify the
11286 appropriate directory location. The Parallel Environment does not
11287 support threads, so the @option{-mpe} option and the @option{-pthread}
11288 option are incompatible.
11289
11290 @item -malign-natural
11291 @itemx -malign-power
11292 @opindex malign-natural
11293 @opindex malign-power
11294 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11295 @option{-malign-natural} overrides the ABI-defined alignment of larger
11296 types, such as floating-point doubles, on their natural size-based boundary.
11297 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11298 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
11299
11300 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11301 is not supported.
11302
11303 @item -msoft-float
11304 @itemx -mhard-float
11305 @opindex msoft-float
11306 @opindex mhard-float
11307 Generate code that does not use (uses) the floating-point register set.
11308 Software floating point emulation is provided if you use the
11309 @option{-msoft-float} option, and pass the option to GCC when linking.
11310
11311 @item -mmultiple
11312 @itemx -mno-multiple
11313 @opindex mmultiple
11314 @opindex mno-multiple
11315 Generate code that uses (does not use) the load multiple word
11316 instructions and the store multiple word instructions. These
11317 instructions are generated by default on POWER systems, and not
11318 generated on PowerPC systems. Do not use @option{-mmultiple} on little
11319 endian PowerPC systems, since those instructions do not work when the
11320 processor is in little endian mode. The exceptions are PPC740 and
11321 PPC750 which permit the instructions usage in little endian mode.
11322
11323 @item -mstring
11324 @itemx -mno-string
11325 @opindex mstring
11326 @opindex mno-string
11327 Generate code that uses (does not use) the load string instructions
11328 and the store string word instructions to save multiple registers and
11329 do small block moves. These instructions are generated by default on
11330 POWER systems, and not generated on PowerPC systems. Do not use
11331 @option{-mstring} on little endian PowerPC systems, since those
11332 instructions do not work when the processor is in little endian mode.
11333 The exceptions are PPC740 and PPC750 which permit the instructions
11334 usage in little endian mode.
11335
11336 @item -mupdate
11337 @itemx -mno-update
11338 @opindex mupdate
11339 @opindex mno-update
11340 Generate code that uses (does not use) the load or store instructions
11341 that update the base register to the address of the calculated memory
11342 location. These instructions are generated by default. If you use
11343 @option{-mno-update}, there is a small window between the time that the
11344 stack pointer is updated and the address of the previous frame is
11345 stored, which means code that walks the stack frame across interrupts or
11346 signals may get corrupted data.
11347
11348 @item -mfused-madd
11349 @itemx -mno-fused-madd
11350 @opindex mfused-madd
11351 @opindex mno-fused-madd
11352 Generate code that uses (does not use) the floating point multiply and
11353 accumulate instructions. These instructions are generated by default if
11354 hardware floating is used.
11355
11356 @item -mmulhw
11357 @itemx -mno-mulhw
11358 @opindex mmulhw
11359 @opindex mno-mulhw
11360 Generate code that uses (does not use) the half-word multiply and
11361 multiply-accumulate instructions on the IBM 405 and 440 processors.
11362 These instructions are generated by default when targetting those
11363 processors.
11364
11365 @item -mno-bit-align
11366 @itemx -mbit-align
11367 @opindex mno-bit-align
11368 @opindex mbit-align
11369 On System V.4 and embedded PowerPC systems do not (do) force structures
11370 and unions that contain bit-fields to be aligned to the base type of the
11371 bit-field.
11372
11373 For example, by default a structure containing nothing but 8
11374 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11375 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
11376 the structure would be aligned to a 1 byte boundary and be one byte in
11377 size.
11378
11379 @item -mno-strict-align
11380 @itemx -mstrict-align
11381 @opindex mno-strict-align
11382 @opindex mstrict-align
11383 On System V.4 and embedded PowerPC systems do not (do) assume that
11384 unaligned memory references will be handled by the system.
11385
11386 @item -mrelocatable
11387 @itemx -mno-relocatable
11388 @opindex mrelocatable
11389 @opindex mno-relocatable
11390 On embedded PowerPC systems generate code that allows (does not allow)
11391 the program to be relocated to a different address at runtime. If you
11392 use @option{-mrelocatable} on any module, all objects linked together must
11393 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11394
11395 @item -mrelocatable-lib
11396 @itemx -mno-relocatable-lib
11397 @opindex mrelocatable-lib
11398 @opindex mno-relocatable-lib
11399 On embedded PowerPC systems generate code that allows (does not allow)
11400 the program to be relocated to a different address at runtime. Modules
11401 compiled with @option{-mrelocatable-lib} can be linked with either modules
11402 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11403 with modules compiled with the @option{-mrelocatable} options.
11404
11405 @item -mno-toc
11406 @itemx -mtoc
11407 @opindex mno-toc
11408 @opindex mtoc
11409 On System V.4 and embedded PowerPC systems do not (do) assume that
11410 register 2 contains a pointer to a global area pointing to the addresses
11411 used in the program.
11412
11413 @item -mlittle
11414 @itemx -mlittle-endian
11415 @opindex mlittle
11416 @opindex mlittle-endian
11417 On System V.4 and embedded PowerPC systems compile code for the
11418 processor in little endian mode. The @option{-mlittle-endian} option is
11419 the same as @option{-mlittle}.
11420
11421 @item -mbig
11422 @itemx -mbig-endian
11423 @opindex mbig
11424 @opindex mbig-endian
11425 On System V.4 and embedded PowerPC systems compile code for the
11426 processor in big endian mode. The @option{-mbig-endian} option is
11427 the same as @option{-mbig}.
11428
11429 @item -mdynamic-no-pic
11430 @opindex mdynamic-no-pic
11431 On Darwin and Mac OS X systems, compile code so that it is not
11432 relocatable, but that its external references are relocatable. The
11433 resulting code is suitable for applications, but not shared
11434 libraries.
11435
11436 @item -mprioritize-restricted-insns=@var{priority}
11437 @opindex mprioritize-restricted-insns
11438 This option controls the priority that is assigned to
11439 dispatch-slot restricted instructions during the second scheduling
11440 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
11441 @var{no/highest/second-highest} priority to dispatch slot restricted
11442 instructions.
11443
11444 @item -msched-costly-dep=@var{dependence_type}
11445 @opindex msched-costly-dep
11446 This option controls which dependences are considered costly
11447 by the target during instruction scheduling. The argument
11448 @var{dependence_type} takes one of the following values:
11449 @var{no}: no dependence is costly,
11450 @var{all}: all dependences are costly,
11451 @var{true_store_to_load}: a true dependence from store to load is costly,
11452 @var{store_to_load}: any dependence from store to load is costly,
11453 @var{number}: any dependence which latency >= @var{number} is costly.
11454
11455 @item -minsert-sched-nops=@var{scheme}
11456 @opindex minsert-sched-nops
11457 This option controls which nop insertion scheme will be used during
11458 the second scheduling pass. The argument @var{scheme} takes one of the
11459 following values:
11460 @var{no}: Don't insert nops.
11461 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11462 according to the scheduler's grouping.
11463 @var{regroup_exact}: Insert nops to force costly dependent insns into
11464 separate groups. Insert exactly as many nops as needed to force an insn
11465 to a new group, according to the estimated processor grouping.
11466 @var{number}: Insert nops to force costly dependent insns into
11467 separate groups. Insert @var{number} nops to force an insn to a new group.
11468
11469 @item -mcall-sysv
11470 @opindex mcall-sysv
11471 On System V.4 and embedded PowerPC systems compile code using calling
11472 conventions that adheres to the March 1995 draft of the System V
11473 Application Binary Interface, PowerPC processor supplement. This is the
11474 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11475
11476 @item -mcall-sysv-eabi
11477 @opindex mcall-sysv-eabi
11478 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11479
11480 @item -mcall-sysv-noeabi
11481 @opindex mcall-sysv-noeabi
11482 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11483
11484 @item -mcall-solaris
11485 @opindex mcall-solaris
11486 On System V.4 and embedded PowerPC systems compile code for the Solaris
11487 operating system.
11488
11489 @item -mcall-linux
11490 @opindex mcall-linux
11491 On System V.4 and embedded PowerPC systems compile code for the
11492 Linux-based GNU system.
11493
11494 @item -mcall-gnu
11495 @opindex mcall-gnu
11496 On System V.4 and embedded PowerPC systems compile code for the
11497 Hurd-based GNU system.
11498
11499 @item -mcall-netbsd
11500 @opindex mcall-netbsd
11501 On System V.4 and embedded PowerPC systems compile code for the
11502 NetBSD operating system.
11503
11504 @item -maix-struct-return
11505 @opindex maix-struct-return
11506 Return all structures in memory (as specified by the AIX ABI)@.
11507
11508 @item -msvr4-struct-return
11509 @opindex msvr4-struct-return
11510 Return structures smaller than 8 bytes in registers (as specified by the
11511 SVR4 ABI)@.
11512
11513 @item -mabi=@var{abi-type}
11514 @opindex mabi
11515 Extend the current ABI with a particular extension, or remove such extension.
11516 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11517 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
11518
11519 @item -mabi=spe
11520 @opindex mabi=spe
11521 Extend the current ABI with SPE ABI extensions. This does not change
11522 the default ABI, instead it adds the SPE ABI extensions to the current
11523 ABI@.
11524
11525 @item -mabi=no-spe
11526 @opindex mabi=no-spe
11527 Disable Booke SPE ABI extensions for the current ABI@.
11528
11529 @item -mabi=ibmlongdouble
11530 @opindex mabi=ibmlongdouble
11531 Change the current ABI to use IBM extended precision long double.
11532 This is a PowerPC 32-bit SYSV ABI option.
11533
11534 @item -mabi=ieeelongdouble
11535 @opindex mabi=ieeelongdouble
11536 Change the current ABI to use IEEE extended precision long double.
11537 This is a PowerPC 32-bit Linux ABI option.
11538
11539 @item -mprototype
11540 @itemx -mno-prototype
11541 @opindex mprototype
11542 @opindex mno-prototype
11543 On System V.4 and embedded PowerPC systems assume that all calls to
11544 variable argument functions are properly prototyped. Otherwise, the
11545 compiler must insert an instruction before every non prototyped call to
11546 set or clear bit 6 of the condition code register (@var{CR}) to
11547 indicate whether floating point values were passed in the floating point
11548 registers in case the function takes a variable arguments. With
11549 @option{-mprototype}, only calls to prototyped variable argument functions
11550 will set or clear the bit.
11551
11552 @item -msim
11553 @opindex msim
11554 On embedded PowerPC systems, assume that the startup module is called
11555 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11556 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
11557 configurations.
11558
11559 @item -mmvme
11560 @opindex mmvme
11561 On embedded PowerPC systems, assume that the startup module is called
11562 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11563 @file{libc.a}.
11564
11565 @item -mads
11566 @opindex mads
11567 On embedded PowerPC systems, assume that the startup module is called
11568 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11569 @file{libc.a}.
11570
11571 @item -myellowknife
11572 @opindex myellowknife
11573 On embedded PowerPC systems, assume that the startup module is called
11574 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11575 @file{libc.a}.
11576
11577 @item -mvxworks
11578 @opindex mvxworks
11579 On System V.4 and embedded PowerPC systems, specify that you are
11580 compiling for a VxWorks system.
11581
11582 @item -mwindiss
11583 @opindex mwindiss
11584 Specify that you are compiling for the WindISS simulation environment.
11585
11586 @item -memb
11587 @opindex memb
11588 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11589 header to indicate that @samp{eabi} extended relocations are used.
11590
11591 @item -meabi
11592 @itemx -mno-eabi
11593 @opindex meabi
11594 @opindex mno-eabi
11595 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11596 Embedded Applications Binary Interface (eabi) which is a set of
11597 modifications to the System V.4 specifications. Selecting @option{-meabi}
11598 means that the stack is aligned to an 8 byte boundary, a function
11599 @code{__eabi} is called to from @code{main} to set up the eabi
11600 environment, and the @option{-msdata} option can use both @code{r2} and
11601 @code{r13} to point to two separate small data areas. Selecting
11602 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11603 do not call an initialization function from @code{main}, and the
11604 @option{-msdata} option will only use @code{r13} to point to a single
11605 small data area. The @option{-meabi} option is on by default if you
11606 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11607
11608 @item -msdata=eabi
11609 @opindex msdata=eabi
11610 On System V.4 and embedded PowerPC systems, put small initialized
11611 @code{const} global and static data in the @samp{.sdata2} section, which
11612 is pointed to by register @code{r2}. Put small initialized
11613 non-@code{const} global and static data in the @samp{.sdata} section,
11614 which is pointed to by register @code{r13}. Put small uninitialized
11615 global and static data in the @samp{.sbss} section, which is adjacent to
11616 the @samp{.sdata} section. The @option{-msdata=eabi} option is
11617 incompatible with the @option{-mrelocatable} option. The
11618 @option{-msdata=eabi} option also sets the @option{-memb} option.
11619
11620 @item -msdata=sysv
11621 @opindex msdata=sysv
11622 On System V.4 and embedded PowerPC systems, put small global and static
11623 data in the @samp{.sdata} section, which is pointed to by register
11624 @code{r13}. Put small uninitialized global and static data in the
11625 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11626 The @option{-msdata=sysv} option is incompatible with the
11627 @option{-mrelocatable} option.
11628
11629 @item -msdata=default
11630 @itemx -msdata
11631 @opindex msdata=default
11632 @opindex msdata
11633 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11634 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11635 same as @option{-msdata=sysv}.
11636
11637 @item -msdata-data
11638 @opindex msdata-data
11639 On System V.4 and embedded PowerPC systems, put small global
11640 data in the @samp{.sdata} section. Put small uninitialized global
11641 data in the @samp{.sbss} section. Do not use register @code{r13}
11642 to address small data however. This is the default behavior unless
11643 other @option{-msdata} options are used.
11644
11645 @item -msdata=none
11646 @itemx -mno-sdata
11647 @opindex msdata=none
11648 @opindex mno-sdata
11649 On embedded PowerPC systems, put all initialized global and static data
11650 in the @samp{.data} section, and all uninitialized data in the
11651 @samp{.bss} section.
11652
11653 @item -G @var{num}
11654 @opindex G
11655 @cindex smaller data references (PowerPC)
11656 @cindex .sdata/.sdata2 references (PowerPC)
11657 On embedded PowerPC systems, put global and static items less than or
11658 equal to @var{num} bytes into the small data or bss sections instead of
11659 the normal data or bss section. By default, @var{num} is 8. The
11660 @option{-G @var{num}} switch is also passed to the linker.
11661 All modules should be compiled with the same @option{-G @var{num}} value.
11662
11663 @item -mregnames
11664 @itemx -mno-regnames
11665 @opindex mregnames
11666 @opindex mno-regnames
11667 On System V.4 and embedded PowerPC systems do (do not) emit register
11668 names in the assembly language output using symbolic forms.
11669
11670 @item -mlongcall
11671 @itemx -mno-longcall
11672 @opindex mlongcall
11673 @opindex mno-longcall
11674 Default to making all function calls indirectly, using a register, so
11675 that functions which reside further than 32 megabytes (33,554,432
11676 bytes) from the current location can be called. This setting can be
11677 overridden by the @code{shortcall} function attribute, or by
11678 @code{#pragma longcall(0)}.
11679
11680 Some linkers are capable of detecting out-of-range calls and generating
11681 glue code on the fly. On these systems, long calls are unnecessary and
11682 generate slower code. As of this writing, the AIX linker can do this,
11683 as can the GNU linker for PowerPC/64. It is planned to add this feature
11684 to the GNU linker for 32-bit PowerPC systems as well.
11685
11686 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11687 callee, L42'', plus a ``branch island'' (glue code). The two target
11688 addresses represent the callee and the ``branch island''. The
11689 Darwin/PPC linker will prefer the first address and generate a ``bl
11690 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11691 otherwise, the linker will generate ``bl L42'' to call the ``branch
11692 island''. The ``branch island'' is appended to the body of the
11693 calling function; it computes the full 32-bit address of the callee
11694 and jumps to it.
11695
11696 On Mach-O (Darwin) systems, this option directs the compiler emit to
11697 the glue for every direct call, and the Darwin linker decides whether
11698 to use or discard it.
11699
11700 In the future, we may cause GCC to ignore all longcall specifications
11701 when the linker is known to generate glue.
11702
11703 @item -pthread
11704 @opindex pthread
11705 Adds support for multithreading with the @dfn{pthreads} library.
11706 This option sets flags for both the preprocessor and linker.
11707
11708 @end table
11709
11710 @node S/390 and zSeries Options
11711 @subsection S/390 and zSeries Options
11712 @cindex S/390 and zSeries Options
11713
11714 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11715
11716 @table @gcctabopt
11717 @item -mhard-float
11718 @itemx -msoft-float
11719 @opindex mhard-float
11720 @opindex msoft-float
11721 Use (do not use) the hardware floating-point instructions and registers
11722 for floating-point operations. When @option{-msoft-float} is specified,
11723 functions in @file{libgcc.a} will be used to perform floating-point
11724 operations. When @option{-mhard-float} is specified, the compiler
11725 generates IEEE floating-point instructions. This is the default.
11726
11727 @item -mlong-double-64
11728 @itemx -mlong-double-128
11729 @opindex mlong-double-64
11730 @opindex mlong-double-128
11731 These switches control the size of @code{long double} type. A size
11732 of 64bit makes the @code{long double} type equivalent to the @code{double}
11733 type. This is the default.
11734
11735 @item -mbackchain
11736 @itemx -mno-backchain
11737 @opindex mbackchain
11738 @opindex mno-backchain
11739 Store (do not store) the address of the caller's frame as backchain pointer
11740 into the callee's stack frame.
11741 A backchain may be needed to allow debugging using tools that do not understand
11742 DWARF-2 call frame information.
11743 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11744 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11745 the backchain is placed into the topmost word of the 96/160 byte register
11746 save area.
11747
11748 In general, code compiled with @option{-mbackchain} is call-compatible with
11749 code compiled with @option{-mmo-backchain}; however, use of the backchain
11750 for debugging purposes usually requires that the whole binary is built with
11751 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
11752 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11753 to build a linux kernel use @option{-msoft-float}.
11754
11755 The default is to not maintain the backchain.
11756
11757 @item -mpacked-stack
11758 @item -mno-packed-stack
11759 @opindex mpacked-stack
11760 @opindex mno-packed-stack
11761 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11762 specified, the compiler uses the all fields of the 96/160 byte register save
11763 area only for their default purpose; unused fields still take up stack space.
11764 When @option{-mpacked-stack} is specified, register save slots are densely
11765 packed at the top of the register save area; unused space is reused for other
11766 purposes, allowing for more efficient use of the available stack space.
11767 However, when @option{-mbackchain} is also in effect, the topmost word of
11768 the save area is always used to store the backchain, and the return address
11769 register is always saved two words below the backchain.
11770
11771 As long as the stack frame backchain is not used, code generated with
11772 @option{-mpacked-stack} is call-compatible with code generated with
11773 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11774 S/390 or zSeries generated code that uses the stack frame backchain at run
11775 time, not just for debugging purposes. Such code is not call-compatible
11776 with code compiled with @option{-mpacked-stack}. Also, note that the
11777 combination of @option{-mbackchain},
11778 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11779 to build a linux kernel use @option{-msoft-float}.
11780
11781 The default is to not use the packed stack layout.
11782
11783 @item -msmall-exec
11784 @itemx -mno-small-exec
11785 @opindex msmall-exec
11786 @opindex mno-small-exec
11787 Generate (or do not generate) code using the @code{bras} instruction
11788 to do subroutine calls.
11789 This only works reliably if the total executable size does not
11790 exceed 64k. The default is to use the @code{basr} instruction instead,
11791 which does not have this limitation.
11792
11793 @item -m64
11794 @itemx -m31
11795 @opindex m64
11796 @opindex m31
11797 When @option{-m31} is specified, generate code compliant to the
11798 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11799 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
11800 particular to generate 64-bit instructions. For the @samp{s390}
11801 targets, the default is @option{-m31}, while the @samp{s390x}
11802 targets default to @option{-m64}.
11803
11804 @item -mzarch
11805 @itemx -mesa
11806 @opindex mzarch
11807 @opindex mesa
11808 When @option{-mzarch} is specified, generate code using the
11809 instructions available on z/Architecture.
11810 When @option{-mesa} is specified, generate code using the
11811 instructions available on ESA/390. Note that @option{-mesa} is
11812 not possible with @option{-m64}.
11813 When generating code compliant to the GNU/Linux for S/390 ABI,
11814 the default is @option{-mesa}. When generating code compliant
11815 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11816
11817 @item -mmvcle
11818 @itemx -mno-mvcle
11819 @opindex mmvcle
11820 @opindex mno-mvcle
11821 Generate (or do not generate) code using the @code{mvcle} instruction
11822 to perform block moves. When @option{-mno-mvcle} is specified,
11823 use a @code{mvc} loop instead. This is the default unless optimizing for
11824 size.
11825
11826 @item -mdebug
11827 @itemx -mno-debug
11828 @opindex mdebug
11829 @opindex mno-debug
11830 Print (or do not print) additional debug information when compiling.
11831 The default is to not print debug information.
11832
11833 @item -march=@var{cpu-type}
11834 @opindex march
11835 Generate code that will run on @var{cpu-type}, which is the name of a system
11836 representing a certain processor type. Possible values for
11837 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11838 When generating code using the instructions available on z/Architecture,
11839 the default is @option{-march=z900}. Otherwise, the default is
11840 @option{-march=g5}.
11841
11842 @item -mtune=@var{cpu-type}
11843 @opindex mtune
11844 Tune to @var{cpu-type} everything applicable about the generated code,
11845 except for the ABI and the set of available instructions.
11846 The list of @var{cpu-type} values is the same as for @option{-march}.
11847 The default is the value used for @option{-march}.
11848
11849 @item -mtpf-trace
11850 @itemx -mno-tpf-trace
11851 @opindex mtpf-trace
11852 @opindex mno-tpf-trace
11853 Generate code that adds (does not add) in TPF OS specific branches to trace
11854 routines in the operating system. This option is off by default, even
11855 when compiling for the TPF OS@.
11856
11857 @item -mfused-madd
11858 @itemx -mno-fused-madd
11859 @opindex mfused-madd
11860 @opindex mno-fused-madd
11861 Generate code that uses (does not use) the floating point multiply and
11862 accumulate instructions. These instructions are generated by default if
11863 hardware floating point is used.
11864
11865 @item -mwarn-framesize=@var{framesize}
11866 @opindex mwarn-framesize
11867 Emit a warning if the current function exceeds the given frame size. Because
11868 this is a compile time check it doesn't need to be a real problem when the program
11869 runs. It is intended to identify functions which most probably cause
11870 a stack overflow. It is useful to be used in an environment with limited stack
11871 size e.g.@: the linux kernel.
11872
11873 @item -mwarn-dynamicstack
11874 @opindex mwarn-dynamicstack
11875 Emit a warning if the function calls alloca or uses dynamically
11876 sized arrays. This is generally a bad idea with a limited stack size.
11877
11878 @item -mstack-guard=@var{stack-guard}
11879 @item -mstack-size=@var{stack-size}
11880 @opindex mstack-guard
11881 @opindex mstack-size
11882 These arguments always have to be used in conjunction. If they are present the s390
11883 back end emits additional instructions in the function prologue which trigger a trap
11884 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11885 (remember that the stack on s390 grows downward). These options are intended to
11886 be used to help debugging stack overflow problems. The additionally emitted code
11887 causes only little overhead and hence can also be used in production like systems
11888 without greater performance degradation. The given values have to be exact
11889 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
11890 exceeding 64k.
11891 In order to be efficient the extra code makes the assumption that the stack starts
11892 at an address aligned to the value given by @var{stack-size}.
11893 @end table
11894
11895 @node SH Options
11896 @subsection SH Options
11897
11898 These @samp{-m} options are defined for the SH implementations:
11899
11900 @table @gcctabopt
11901 @item -m1
11902 @opindex m1
11903 Generate code for the SH1.
11904
11905 @item -m2
11906 @opindex m2
11907 Generate code for the SH2.
11908
11909 @item -m2e
11910 Generate code for the SH2e.
11911
11912 @item -m3
11913 @opindex m3
11914 Generate code for the SH3.
11915
11916 @item -m3e
11917 @opindex m3e
11918 Generate code for the SH3e.
11919
11920 @item -m4-nofpu
11921 @opindex m4-nofpu
11922 Generate code for the SH4 without a floating-point unit.
11923
11924 @item -m4-single-only
11925 @opindex m4-single-only
11926 Generate code for the SH4 with a floating-point unit that only
11927 supports single-precision arithmetic.
11928
11929 @item -m4-single
11930 @opindex m4-single
11931 Generate code for the SH4 assuming the floating-point unit is in
11932 single-precision mode by default.
11933
11934 @item -m4
11935 @opindex m4
11936 Generate code for the SH4.
11937
11938 @item -m4a-nofpu
11939 @opindex m4a-nofpu
11940 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11941 floating-point unit is not used.
11942
11943 @item -m4a-single-only
11944 @opindex m4a-single-only
11945 Generate code for the SH4a, in such a way that no double-precision
11946 floating point operations are used.
11947
11948 @item -m4a-single
11949 @opindex m4a-single
11950 Generate code for the SH4a assuming the floating-point unit is in
11951 single-precision mode by default.
11952
11953 @item -m4a
11954 @opindex m4a
11955 Generate code for the SH4a.
11956
11957 @item -m4al
11958 @opindex m4al
11959 Same as @option{-m4a-nofpu}, except that it implicitly passes
11960 @option{-dsp} to the assembler. GCC doesn't generate any DSP
11961 instructions at the moment.
11962
11963 @item -mb
11964 @opindex mb
11965 Compile code for the processor in big endian mode.
11966
11967 @item -ml
11968 @opindex ml
11969 Compile code for the processor in little endian mode.
11970
11971 @item -mdalign
11972 @opindex mdalign
11973 Align doubles at 64-bit boundaries. Note that this changes the calling
11974 conventions, and thus some functions from the standard C library will
11975 not work unless you recompile it first with @option{-mdalign}.
11976
11977 @item -mrelax
11978 @opindex mrelax
11979 Shorten some address references at link time, when possible; uses the
11980 linker option @option{-relax}.
11981
11982 @item -mbigtable
11983 @opindex mbigtable
11984 Use 32-bit offsets in @code{switch} tables. The default is to use
11985 16-bit offsets.
11986
11987 @item -mfmovd
11988 @opindex mfmovd
11989 Enable the use of the instruction @code{fmovd}.
11990
11991 @item -mhitachi
11992 @opindex mhitachi
11993 Comply with the calling conventions defined by Renesas.
11994
11995 @item -mrenesas
11996 @opindex mhitachi
11997 Comply with the calling conventions defined by Renesas.
11998
11999 @item -mno-renesas
12000 @opindex mhitachi
12001 Comply with the calling conventions defined for GCC before the Renesas
12002 conventions were available. This option is the default for all
12003 targets of the SH toolchain except for @samp{sh-symbianelf}.
12004
12005 @item -mnomacsave
12006 @opindex mnomacsave
12007 Mark the @code{MAC} register as call-clobbered, even if
12008 @option{-mhitachi} is given.
12009
12010 @item -mieee
12011 @opindex mieee
12012 Increase IEEE-compliance of floating-point code.
12013 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12014 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12015 comparisons of NANs / infinities incurs extra overhead in every
12016 floating point comparison, therefore the default is set to
12017 @option{-ffinite-math-only}.
12018
12019 @item -misize
12020 @opindex misize
12021 Dump instruction size and location in the assembly code.
12022
12023 @item -mpadstruct
12024 @opindex mpadstruct
12025 This option is deprecated. It pads structures to multiple of 4 bytes,
12026 which is incompatible with the SH ABI@.
12027
12028 @item -mspace
12029 @opindex mspace
12030 Optimize for space instead of speed. Implied by @option{-Os}.
12031
12032 @item -mprefergot
12033 @opindex mprefergot
12034 When generating position-independent code, emit function calls using
12035 the Global Offset Table instead of the Procedure Linkage Table.
12036
12037 @item -musermode
12038 @opindex musermode
12039 Generate a library function call to invalidate instruction cache
12040 entries, after fixing up a trampoline. This library function call
12041 doesn't assume it can write to the whole memory address space. This
12042 is the default when the target is @code{sh-*-linux*}.
12043
12044 @item -multcost=@var{number}
12045 @opindex multcost=@var{number}
12046 Set the cost to assume for a multiply insn.
12047
12048 @item -mdiv=@var{strategy}
12049 @opindex mdiv=@var{strategy}
12050 Set the division strategy to use for SHmedia code. @var{strategy} must be
12051 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12052 inv:call2, inv:fp .
12053 "fp" performs the operation in floating point. This has a very high latency,
12054 but needs only a few instructions, so it might be a good choice if
12055 your code has enough easily exploitable ILP to allow the compiler to
12056 schedule the floating point instructions together with other instructions.
12057 Division by zero causes a floating point exception.
12058 "inv" uses integer operations to calculate the inverse of the divisor,
12059 and then multiplies the dividend with the inverse. This strategy allows
12060 cse and hoisting of the inverse calculation. Division by zero calculates
12061 an unspecified result, but does not trap.
12062 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12063 have been found, or if the entire operation has been hoisted to the same
12064 place, the last stages of the inverse calculation are intertwined with the
12065 final multiply to reduce the overall latency, at the expense of using a few
12066 more instructions, and thus offering fewer scheduling opportunities with
12067 other code.
12068 "call" calls a library function that usually implements the inv:minlat
12069 strategy.
12070 This gives high code density for m5-*media-nofpu compilations.
12071 "call2" uses a different entry point of the same library function, where it
12072 assumes that a pointer to a lookup table has already been set up, which
12073 exposes the pointer load to cse / code hoisting optimizations.
12074 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12075 code generation, but if the code stays unoptimized, revert to the "call",
12076 "call2", or "fp" strategies, respectively. Note that the
12077 potentially-trapping side effect of division by zero is carried by a
12078 separate instruction, so it is possible that all the integer instructions
12079 are hoisted out, but the marker for the side effect stays where it is.
12080 A recombination to fp operations or a call is not possible in that case.
12081 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
12082 that the inverse calculation was nor separated from the multiply, they speed
12083 up division where the dividend fits into 20 bits (plus sign where applicable),
12084 by inserting a test to skip a number of operations in this case; this test
12085 slows down the case of larger dividends. inv20u assumes the case of a such
12086 a small dividend to be unlikely, and inv20l assumes it to be likely.
12087
12088 @item -mdivsi3_libfunc=@var{name}
12089 @opindex mdivsi3_libfunc=@var{name}
12090 Set the name of the library function used for 32 bit signed division to
12091 @var{name}. This only affect the name used in the call and inv:call
12092 division strategies, and the compiler will still expect the same
12093 sets of input/output/clobbered registers as if this option was not present.
12094
12095 @item -madjust-unroll
12096 @opindex madjust-unroll
12097 Throttle unrolling to avoid thrashing target registers.
12098 This option only has an effect if the gcc code base supports the
12099 TARGET_ADJUST_UNROLL_MAX target hook.
12100
12101 @item -mindexed-addressing
12102 @opindex mindexed-addressing
12103 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12104 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12105 semantics for the indexed addressing mode. The architecture allows the
12106 implementation of processors with 64 bit MMU, which the OS could use to
12107 get 32 bit addressing, but since no current hardware implementation supports
12108 this or any other way to make the indexed addressing mode safe to use in
12109 the 32 bit ABI, the default is -mno-indexed-addressing.
12110
12111 @item -mgettrcost=@var{number}
12112 @opindex mgettrcost=@var{number}
12113 Set the cost assumed for the gettr instruction to @var{number}.
12114 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12115
12116 @item -mpt-fixed
12117 @opindex mpt-fixed
12118 Assume pt* instructions won't trap. This will generally generate better
12119 scheduled code, but is unsafe on current hardware. The current architecture
12120 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12121 This has the unintentional effect of making it unsafe to schedule ptabs /
12122 ptrel before a branch, or hoist it out of a loop. For example,
12123 __do_global_ctors, a part of libgcc that runs constructors at program
12124 startup, calls functions in a list which is delimited by -1. With the
12125 -mpt-fixed option, the ptabs will be done before testing against -1.
12126 That means that all the constructors will be run a bit quicker, but when
12127 the loop comes to the end of the list, the program crashes because ptabs
12128 loads -1 into a target register. Since this option is unsafe for any
12129 hardware implementing the current architecture specification, the default
12130 is -mno-pt-fixed. Unless the user specifies a specific cost with
12131 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12132 this deters register allocation using target registers for storing
12133 ordinary integers.
12134
12135 @item -minvalid-symbols
12136 @opindex minvalid-symbols
12137 Assume symbols might be invalid. Ordinary function symbols generated by
12138 the compiler will always be valid to load with movi/shori/ptabs or
12139 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12140 to generate symbols that will cause ptabs / ptrel to trap.
12141 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12142 It will then prevent cross-basic-block cse, hoisting and most scheduling
12143 of symbol loads. The default is @option{-mno-invalid-symbols}.
12144 @end table
12145
12146 @node SPARC Options
12147 @subsection SPARC Options
12148 @cindex SPARC options
12149
12150 These @samp{-m} options are supported on the SPARC:
12151
12152 @table @gcctabopt
12153 @item -mno-app-regs
12154 @itemx -mapp-regs
12155 @opindex mno-app-regs
12156 @opindex mapp-regs
12157 Specify @option{-mapp-regs} to generate output using the global registers
12158 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
12159 is the default.
12160
12161 To be fully SVR4 ABI compliant at the cost of some performance loss,
12162 specify @option{-mno-app-regs}. You should compile libraries and system
12163 software with this option.
12164
12165 @item -mfpu
12166 @itemx -mhard-float
12167 @opindex mfpu
12168 @opindex mhard-float
12169 Generate output containing floating point instructions. This is the
12170 default.
12171
12172 @item -mno-fpu
12173 @itemx -msoft-float
12174 @opindex mno-fpu
12175 @opindex msoft-float
12176 Generate output containing library calls for floating point.
12177 @strong{Warning:} the requisite libraries are not available for all SPARC
12178 targets. Normally the facilities of the machine's usual C compiler are
12179 used, but this cannot be done directly in cross-compilation. You must make
12180 your own arrangements to provide suitable library functions for
12181 cross-compilation. The embedded targets @samp{sparc-*-aout} and
12182 @samp{sparclite-*-*} do provide software floating point support.
12183
12184 @option{-msoft-float} changes the calling convention in the output file;
12185 therefore, it is only useful if you compile @emph{all} of a program with
12186 this option. In particular, you need to compile @file{libgcc.a}, the
12187 library that comes with GCC, with @option{-msoft-float} in order for
12188 this to work.
12189
12190 @item -mhard-quad-float
12191 @opindex mhard-quad-float
12192 Generate output containing quad-word (long double) floating point
12193 instructions.
12194
12195 @item -msoft-quad-float
12196 @opindex msoft-quad-float
12197 Generate output containing library calls for quad-word (long double)
12198 floating point instructions. The functions called are those specified
12199 in the SPARC ABI@. This is the default.
12200
12201 As of this writing, there are no SPARC implementations that have hardware
12202 support for the quad-word floating point instructions. They all invoke
12203 a trap handler for one of these instructions, and then the trap handler
12204 emulates the effect of the instruction. Because of the trap handler overhead,
12205 this is much slower than calling the ABI library routines. Thus the
12206 @option{-msoft-quad-float} option is the default.
12207
12208 @item -mno-unaligned-doubles
12209 @itemx -munaligned-doubles
12210 @opindex mno-unaligned-doubles
12211 @opindex munaligned-doubles
12212 Assume that doubles have 8 byte alignment. This is the default.
12213
12214 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12215 alignment only if they are contained in another type, or if they have an
12216 absolute address. Otherwise, it assumes they have 4 byte alignment.
12217 Specifying this option avoids some rare compatibility problems with code
12218 generated by other compilers. It is not the default because it results
12219 in a performance loss, especially for floating point code.
12220
12221 @item -mno-faster-structs
12222 @itemx -mfaster-structs
12223 @opindex mno-faster-structs
12224 @opindex mfaster-structs
12225 With @option{-mfaster-structs}, the compiler assumes that structures
12226 should have 8 byte alignment. This enables the use of pairs of
12227 @code{ldd} and @code{std} instructions for copies in structure
12228 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12229 However, the use of this changed alignment directly violates the SPARC
12230 ABI@. Thus, it's intended only for use on targets where the developer
12231 acknowledges that their resulting code will not be directly in line with
12232 the rules of the ABI@.
12233
12234 @item -mimpure-text
12235 @opindex mimpure-text
12236 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12237 the compiler to not pass @option{-z text} to the linker when linking a
12238 shared object. Using this option, you can link position-dependent
12239 code into a shared object.
12240
12241 @option{-mimpure-text} suppresses the ``relocations remain against
12242 allocatable but non-writable sections'' linker error message.
12243 However, the necessary relocations will trigger copy-on-write, and the
12244 shared object is not actually shared across processes. Instead of
12245 using @option{-mimpure-text}, you should compile all source code with
12246 @option{-fpic} or @option{-fPIC}.
12247
12248 This option is only available on SunOS and Solaris.
12249
12250 @item -mcpu=@var{cpu_type}
12251 @opindex mcpu
12252 Set the instruction set, register set, and instruction scheduling parameters
12253 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
12254 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12255 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12256 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
12257 @samp{ultrasparc3}.
12258
12259 Default instruction scheduling parameters are used for values that select
12260 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
12261 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12262
12263 Here is a list of each supported architecture and their supported
12264 implementations.
12265
12266 @smallexample
12267 v7: cypress
12268 v8: supersparc, hypersparc
12269 sparclite: f930, f934, sparclite86x
12270 sparclet: tsc701
12271 v9: ultrasparc, ultrasparc3
12272 @end smallexample
12273
12274 By default (unless configured otherwise), GCC generates code for the V7
12275 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
12276 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12277 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
12278 SPARCStation 1, 2, IPX etc.
12279
12280 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12281 architecture. The only difference from V7 code is that the compiler emits
12282 the integer multiply and integer divide instructions which exist in SPARC-V8
12283 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
12284 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12285 2000 series.
12286
12287 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12288 the SPARC architecture. This adds the integer multiply, integer divide step
12289 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12290 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12291 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
12292 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12293 MB86934 chip, which is the more recent SPARClite with FPU@.
12294
12295 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12296 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
12297 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12298 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
12299 optimizes it for the TEMIC SPARClet chip.
12300
12301 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12302 architecture. This adds 64-bit integer and floating-point move instructions,
12303 3 additional floating-point condition code registers and conditional move
12304 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
12305 optimizes it for the Sun UltraSPARC I/II chips. With
12306 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12307 Sun UltraSPARC III chip.
12308
12309 @item -mtune=@var{cpu_type}
12310 @opindex mtune
12311 Set the instruction scheduling parameters for machine type
12312 @var{cpu_type}, but do not set the instruction set or register set that the
12313 option @option{-mcpu=@var{cpu_type}} would.
12314
12315 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12316 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12317 that select a particular cpu implementation. Those are @samp{cypress},
12318 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12319 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
12320 @samp{ultrasparc3}.
12321
12322 @item -mv8plus
12323 @itemx -mno-v8plus
12324 @opindex mv8plus
12325 @opindex mno-v8plus
12326 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
12327 difference from the V8 ABI is that the global and out registers are
12328 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
12329 mode for all SPARC-V9 processors.
12330
12331 @item -mvis
12332 @itemx -mno-vis
12333 @opindex mvis
12334 @opindex mno-vis
12335 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12336 Visual Instruction Set extensions. The default is @option{-mno-vis}.
12337 @end table
12338
12339 These @samp{-m} options are supported in addition to the above
12340 on SPARC-V9 processors in 64-bit environments:
12341
12342 @table @gcctabopt
12343 @item -mlittle-endian
12344 @opindex mlittle-endian
12345 Generate code for a processor running in little-endian mode. It is only
12346 available for a few configurations and most notably not on Solaris and Linux.
12347
12348 @item -m32
12349 @itemx -m64
12350 @opindex m32
12351 @opindex m64
12352 Generate code for a 32-bit or 64-bit environment.
12353 The 32-bit environment sets int, long and pointer to 32 bits.
12354 The 64-bit environment sets int to 32 bits and long and pointer
12355 to 64 bits.
12356
12357 @item -mcmodel=medlow
12358 @opindex mcmodel=medlow
12359 Generate code for the Medium/Low code model: 64-bit addresses, programs
12360 must be linked in the low 32 bits of memory. Programs can be statically
12361 or dynamically linked.
12362
12363 @item -mcmodel=medmid
12364 @opindex mcmodel=medmid
12365 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12366 must be linked in the low 44 bits of memory, the text and data segments must
12367 be less than 2GB in size and the data segment must be located within 2GB of
12368 the text segment.
12369
12370 @item -mcmodel=medany
12371 @opindex mcmodel=medany
12372 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
12373 may be linked anywhere in memory, the text and data segments must be less
12374 than 2GB in size and the data segment must be located within 2GB of the
12375 text segment.
12376
12377 @item -mcmodel=embmedany
12378 @opindex mcmodel=embmedany
12379 Generate code for the Medium/Anywhere code model for embedded systems:
12380 64-bit addresses, the text and data segments must be less than 2GB in
12381 size, both starting anywhere in memory (determined at link time). The
12382 global register %g4 points to the base of the data segment. Programs
12383 are statically linked and PIC is not supported.
12384
12385 @item -mstack-bias
12386 @itemx -mno-stack-bias
12387 @opindex mstack-bias
12388 @opindex mno-stack-bias
12389 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12390 frame pointer if present, are offset by @minus{}2047 which must be added back
12391 when making stack frame references. This is the default in 64-bit mode.
12392 Otherwise, assume no such offset is present.
12393 @end table
12394
12395 These switches are supported in addition to the above on Solaris:
12396
12397 @table @gcctabopt
12398 @item -threads
12399 @opindex threads
12400 Add support for multithreading using the Solaris threads library. This
12401 option sets flags for both the preprocessor and linker. This option does
12402 not affect the thread safety of object code produced by the compiler or
12403 that of libraries supplied with it.
12404
12405 @item -pthreads
12406 @opindex pthreads
12407 Add support for multithreading using the POSIX threads library. This
12408 option sets flags for both the preprocessor and linker. This option does
12409 not affect the thread safety of object code produced by the compiler or
12410 that of libraries supplied with it.
12411
12412 @item -pthread
12413 @opindex pthread
12414 This is a synonym for @option{-pthreads}.
12415 @end table
12416
12417 @node System V Options
12418 @subsection Options for System V
12419
12420 These additional options are available on System V Release 4 for
12421 compatibility with other compilers on those systems:
12422
12423 @table @gcctabopt
12424 @item -G
12425 @opindex G
12426 Create a shared object.
12427 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12428
12429 @item -Qy
12430 @opindex Qy
12431 Identify the versions of each tool used by the compiler, in a
12432 @code{.ident} assembler directive in the output.
12433
12434 @item -Qn
12435 @opindex Qn
12436 Refrain from adding @code{.ident} directives to the output file (this is
12437 the default).
12438
12439 @item -YP,@var{dirs}
12440 @opindex YP
12441 Search the directories @var{dirs}, and no others, for libraries
12442 specified with @option{-l}.
12443
12444 @item -Ym,@var{dir}
12445 @opindex Ym
12446 Look in the directory @var{dir} to find the M4 preprocessor.
12447 The assembler uses this option.
12448 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12449 @c the generic assembler that comes with Solaris takes just -Ym.
12450 @end table
12451
12452 @node TMS320C3x/C4x Options
12453 @subsection TMS320C3x/C4x Options
12454 @cindex TMS320C3x/C4x Options
12455
12456 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12457
12458 @table @gcctabopt
12459
12460 @item -mcpu=@var{cpu_type}
12461 @opindex mcpu
12462 Set the instruction set, register set, and instruction scheduling
12463 parameters for machine type @var{cpu_type}. Supported values for
12464 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12465 @samp{c44}. The default is @samp{c40} to generate code for the
12466 TMS320C40.
12467
12468 @item -mbig-memory
12469 @itemx -mbig
12470 @itemx -msmall-memory
12471 @itemx -msmall
12472 @opindex mbig-memory
12473 @opindex mbig
12474 @opindex msmall-memory
12475 @opindex msmall
12476 Generates code for the big or small memory model. The small memory
12477 model assumed that all data fits into one 64K word page. At run-time
12478 the data page (DP) register must be set to point to the 64K page
12479 containing the .bss and .data program sections. The big memory model is
12480 the default and requires reloading of the DP register for every direct
12481 memory access.
12482
12483 @item -mbk
12484 @itemx -mno-bk
12485 @opindex mbk
12486 @opindex mno-bk
12487 Allow (disallow) allocation of general integer operands into the block
12488 count register BK@.
12489
12490 @item -mdb
12491 @itemx -mno-db
12492 @opindex mdb
12493 @opindex mno-db
12494 Enable (disable) generation of code using decrement and branch,
12495 DBcond(D), instructions. This is enabled by default for the C4x. To be
12496 on the safe side, this is disabled for the C3x, since the maximum
12497 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12498 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
12499 that it can utilize the decrement and branch instruction, but will give
12500 up if there is more than one memory reference in the loop. Thus a loop
12501 where the loop counter is decremented can generate slightly more
12502 efficient code, in cases where the RPTB instruction cannot be utilized.
12503
12504 @item -mdp-isr-reload
12505 @itemx -mparanoid
12506 @opindex mdp-isr-reload
12507 @opindex mparanoid
12508 Force the DP register to be saved on entry to an interrupt service
12509 routine (ISR), reloaded to point to the data section, and restored on
12510 exit from the ISR@. This should not be required unless someone has
12511 violated the small memory model by modifying the DP register, say within
12512 an object library.
12513
12514 @item -mmpyi
12515 @itemx -mno-mpyi
12516 @opindex mmpyi
12517 @opindex mno-mpyi
12518 For the C3x use the 24-bit MPYI instruction for integer multiplies
12519 instead of a library call to guarantee 32-bit results. Note that if one
12520 of the operands is a constant, then the multiplication will be performed
12521 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
12522 then squaring operations are performed inline instead of a library call.
12523
12524 @item -mfast-fix
12525 @itemx -mno-fast-fix
12526 @opindex mfast-fix
12527 @opindex mno-fast-fix
12528 The C3x/C4x FIX instruction to convert a floating point value to an
12529 integer value chooses the nearest integer less than or equal to the
12530 floating point value rather than to the nearest integer. Thus if the
12531 floating point number is negative, the result will be incorrectly
12532 truncated an additional code is necessary to detect and correct this
12533 case. This option can be used to disable generation of the additional
12534 code required to correct the result.
12535
12536 @item -mrptb
12537 @itemx -mno-rptb
12538 @opindex mrptb
12539 @opindex mno-rptb
12540 Enable (disable) generation of repeat block sequences using the RPTB
12541 instruction for zero overhead looping. The RPTB construct is only used
12542 for innermost loops that do not call functions or jump across the loop
12543 boundaries. There is no advantage having nested RPTB loops due to the
12544 overhead required to save and restore the RC, RS, and RE registers.
12545 This is enabled by default with @option{-O2}.
12546
12547 @item -mrpts=@var{count}
12548 @itemx -mno-rpts
12549 @opindex mrpts
12550 @opindex mno-rpts
12551 Enable (disable) the use of the single instruction repeat instruction
12552 RPTS@. If a repeat block contains a single instruction, and the loop
12553 count can be guaranteed to be less than the value @var{count}, GCC will
12554 emit a RPTS instruction instead of a RPTB@. If no value is specified,
12555 then a RPTS will be emitted even if the loop count cannot be determined
12556 at compile time. Note that the repeated instruction following RPTS does
12557 not have to be reloaded from memory each iteration, thus freeing up the
12558 CPU buses for operands. However, since interrupts are blocked by this
12559 instruction, it is disabled by default.
12560
12561 @item -mloop-unsigned
12562 @itemx -mno-loop-unsigned
12563 @opindex mloop-unsigned
12564 @opindex mno-loop-unsigned
12565 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12566 is @math{2^{31} + 1} since these instructions test if the iteration count is
12567 negative to terminate the loop. If the iteration count is unsigned
12568 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12569 exceeded. This switch allows an unsigned iteration count.
12570
12571 @item -mti
12572 @opindex mti
12573 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12574 with. This also enforces compatibility with the API employed by the TI
12575 C3x C compiler. For example, long doubles are passed as structures
12576 rather than in floating point registers.
12577
12578 @item -mregparm
12579 @itemx -mmemparm
12580 @opindex mregparm
12581 @opindex mmemparm
12582 Generate code that uses registers (stack) for passing arguments to functions.
12583 By default, arguments are passed in registers where possible rather
12584 than by pushing arguments on to the stack.
12585
12586 @item -mparallel-insns
12587 @itemx -mno-parallel-insns
12588 @opindex mparallel-insns
12589 @opindex mno-parallel-insns
12590 Allow the generation of parallel instructions. This is enabled by
12591 default with @option{-O2}.
12592
12593 @item -mparallel-mpy
12594 @itemx -mno-parallel-mpy
12595 @opindex mparallel-mpy
12596 @opindex mno-parallel-mpy
12597 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12598 provided @option{-mparallel-insns} is also specified. These instructions have
12599 tight register constraints which can pessimize the code generation
12600 of large functions.
12601
12602 @end table
12603
12604 @node V850 Options
12605 @subsection V850 Options
12606 @cindex V850 Options
12607
12608 These @samp{-m} options are defined for V850 implementations:
12609
12610 @table @gcctabopt
12611 @item -mlong-calls
12612 @itemx -mno-long-calls
12613 @opindex mlong-calls
12614 @opindex mno-long-calls
12615 Treat all calls as being far away (near). If calls are assumed to be
12616 far away, the compiler will always load the functions address up into a
12617 register, and call indirect through the pointer.
12618
12619 @item -mno-ep
12620 @itemx -mep
12621 @opindex mno-ep
12622 @opindex mep
12623 Do not optimize (do optimize) basic blocks that use the same index
12624 pointer 4 or more times to copy pointer into the @code{ep} register, and
12625 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
12626 option is on by default if you optimize.
12627
12628 @item -mno-prolog-function
12629 @itemx -mprolog-function
12630 @opindex mno-prolog-function
12631 @opindex mprolog-function
12632 Do not use (do use) external functions to save and restore registers
12633 at the prologue and epilogue of a function. The external functions
12634 are slower, but use less code space if more than one function saves
12635 the same number of registers. The @option{-mprolog-function} option
12636 is on by default if you optimize.
12637
12638 @item -mspace
12639 @opindex mspace
12640 Try to make the code as small as possible. At present, this just turns
12641 on the @option{-mep} and @option{-mprolog-function} options.
12642
12643 @item -mtda=@var{n}
12644 @opindex mtda
12645 Put static or global variables whose size is @var{n} bytes or less into
12646 the tiny data area that register @code{ep} points to. The tiny data
12647 area can hold up to 256 bytes in total (128 bytes for byte references).
12648
12649 @item -msda=@var{n}
12650 @opindex msda
12651 Put static or global variables whose size is @var{n} bytes or less into
12652 the small data area that register @code{gp} points to. The small data
12653 area can hold up to 64 kilobytes.
12654
12655 @item -mzda=@var{n}
12656 @opindex mzda
12657 Put static or global variables whose size is @var{n} bytes or less into
12658 the first 32 kilobytes of memory.
12659
12660 @item -mv850
12661 @opindex mv850
12662 Specify that the target processor is the V850.
12663
12664 @item -mbig-switch
12665 @opindex mbig-switch
12666 Generate code suitable for big switch tables. Use this option only if
12667 the assembler/linker complain about out of range branches within a switch
12668 table.
12669
12670 @item -mapp-regs
12671 @opindex mapp-regs
12672 This option will cause r2 and r5 to be used in the code generated by
12673 the compiler. This setting is the default.
12674
12675 @item -mno-app-regs
12676 @opindex mno-app-regs
12677 This option will cause r2 and r5 to be treated as fixed registers.
12678
12679 @item -mv850e1
12680 @opindex mv850e1
12681 Specify that the target processor is the V850E1. The preprocessor
12682 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12683 this option is used.
12684
12685 @item -mv850e
12686 @opindex mv850e
12687 Specify that the target processor is the V850E@. The preprocessor
12688 constant @samp{__v850e__} will be defined if this option is used.
12689
12690 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12691 are defined then a default target processor will be chosen and the
12692 relevant @samp{__v850*__} preprocessor constant will be defined.
12693
12694 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12695 defined, regardless of which processor variant is the target.
12696
12697 @item -mdisable-callt
12698 @opindex mdisable-callt
12699 This option will suppress generation of the CALLT instruction for the
12700 v850e and v850e1 flavors of the v850 architecture. The default is
12701 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12702
12703 @end table
12704
12705 @node VAX Options
12706 @subsection VAX Options
12707 @cindex VAX options
12708
12709 These @samp{-m} options are defined for the VAX:
12710
12711 @table @gcctabopt
12712 @item -munix
12713 @opindex munix
12714 Do not output certain jump instructions (@code{aobleq} and so on)
12715 that the Unix assembler for the VAX cannot handle across long
12716 ranges.
12717
12718 @item -mgnu
12719 @opindex mgnu
12720 Do output those jump instructions, on the assumption that you
12721 will assemble with the GNU assembler.
12722
12723 @item -mg
12724 @opindex mg
12725 Output code for g-format floating point numbers instead of d-format.
12726 @end table
12727
12728 @node x86-64 Options
12729 @subsection x86-64 Options
12730 @cindex x86-64 options
12731
12732 These are listed under @xref{i386 and x86-64 Options}.
12733
12734 @node Xstormy16 Options
12735 @subsection Xstormy16 Options
12736 @cindex Xstormy16 Options
12737
12738 These options are defined for Xstormy16:
12739
12740 @table @gcctabopt
12741 @item -msim
12742 @opindex msim
12743 Choose startup files and linker script suitable for the simulator.
12744 @end table
12745
12746 @node Xtensa Options
12747 @subsection Xtensa Options
12748 @cindex Xtensa Options
12749
12750 These options are supported for Xtensa targets:
12751
12752 @table @gcctabopt
12753 @item -mconst16
12754 @itemx -mno-const16
12755 @opindex mconst16
12756 @opindex mno-const16
12757 Enable or disable use of @code{CONST16} instructions for loading
12758 constant values. The @code{CONST16} instruction is currently not a
12759 standard option from Tensilica. When enabled, @code{CONST16}
12760 instructions are always used in place of the standard @code{L32R}
12761 instructions. The use of @code{CONST16} is enabled by default only if
12762 the @code{L32R} instruction is not available.
12763
12764 @item -mfused-madd
12765 @itemx -mno-fused-madd
12766 @opindex mfused-madd
12767 @opindex mno-fused-madd
12768 Enable or disable use of fused multiply/add and multiply/subtract
12769 instructions in the floating-point option. This has no effect if the
12770 floating-point option is not also enabled. Disabling fused multiply/add
12771 and multiply/subtract instructions forces the compiler to use separate
12772 instructions for the multiply and add/subtract operations. This may be
12773 desirable in some cases where strict IEEE 754-compliant results are
12774 required: the fused multiply add/subtract instructions do not round the
12775 intermediate result, thereby producing results with @emph{more} bits of
12776 precision than specified by the IEEE standard. Disabling fused multiply
12777 add/subtract instructions also ensures that the program output is not
12778 sensitive to the compiler's ability to combine multiply and add/subtract
12779 operations.
12780
12781 @item -mtext-section-literals
12782 @itemx -mno-text-section-literals
12783 @opindex mtext-section-literals
12784 @opindex mno-text-section-literals
12785 Control the treatment of literal pools. The default is
12786 @option{-mno-text-section-literals}, which places literals in a separate
12787 section in the output file. This allows the literal pool to be placed
12788 in a data RAM/ROM, and it also allows the linker to combine literal
12789 pools from separate object files to remove redundant literals and
12790 improve code size. With @option{-mtext-section-literals}, the literals
12791 are interspersed in the text section in order to keep them as close as
12792 possible to their references. This may be necessary for large assembly
12793 files.
12794
12795 @item -mtarget-align
12796 @itemx -mno-target-align
12797 @opindex mtarget-align
12798 @opindex mno-target-align
12799 When this option is enabled, GCC instructs the assembler to
12800 automatically align instructions to reduce branch penalties at the
12801 expense of some code density. The assembler attempts to widen density
12802 instructions to align branch targets and the instructions following call
12803 instructions. If there are not enough preceding safe density
12804 instructions to align a target, no widening will be performed. The
12805 default is @option{-mtarget-align}. These options do not affect the
12806 treatment of auto-aligned instructions like @code{LOOP}, which the
12807 assembler will always align, either by widening density instructions or
12808 by inserting no-op instructions.
12809
12810 @item -mlongcalls
12811 @itemx -mno-longcalls
12812 @opindex mlongcalls
12813 @opindex mno-longcalls
12814 When this option is enabled, GCC instructs the assembler to translate
12815 direct calls to indirect calls unless it can determine that the target
12816 of a direct call is in the range allowed by the call instruction. This
12817 translation typically occurs for calls to functions in other source
12818 files. Specifically, the assembler translates a direct @code{CALL}
12819 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12820 The default is @option{-mno-longcalls}. This option should be used in
12821 programs where the call target can potentially be out of range. This
12822 option is implemented in the assembler, not the compiler, so the
12823 assembly code generated by GCC will still show direct call
12824 instructions---look at the disassembled object code to see the actual
12825 instructions. Note that the assembler will use an indirect call for
12826 every cross-file call, not just those that really will be out of range.
12827 @end table
12828
12829 @node zSeries Options
12830 @subsection zSeries Options
12831 @cindex zSeries options
12832
12833 These are listed under @xref{S/390 and zSeries Options}.
12834
12835 @node Code Gen Options
12836 @section Options for Code Generation Conventions
12837 @cindex code generation conventions
12838 @cindex options, code generation
12839 @cindex run-time options
12840
12841 These machine-independent options control the interface conventions
12842 used in code generation.
12843
12844 Most of them have both positive and negative forms; the negative form
12845 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
12846 one of the forms is listed---the one which is not the default. You
12847 can figure out the other form by either removing @samp{no-} or adding
12848 it.
12849
12850 @table @gcctabopt
12851 @item -fbounds-check
12852 @opindex fbounds-check
12853 For front-ends that support it, generate additional code to check that
12854 indices used to access arrays are within the declared range. This is
12855 currently only supported by the Java and Fortran 77 front-ends, where
12856 this option defaults to true and false respectively.
12857
12858 @item -ftrapv
12859 @opindex ftrapv
12860 This option generates traps for signed overflow on addition, subtraction,
12861 multiplication operations.
12862
12863 @item -fwrapv
12864 @opindex fwrapv
12865 This option instructs the compiler to assume that signed arithmetic
12866 overflow of addition, subtraction and multiplication wraps around
12867 using twos-complement representation. This flag enables some optimizations
12868 and disables others. This option is enabled by default for the Java
12869 front-end, as required by the Java language specification.
12870
12871 @item -fexceptions
12872 @opindex fexceptions
12873 Enable exception handling. Generates extra code needed to propagate
12874 exceptions. For some targets, this implies GCC will generate frame
12875 unwind information for all functions, which can produce significant data
12876 size overhead, although it does not affect execution. If you do not
12877 specify this option, GCC will enable it by default for languages like
12878 C++ which normally require exception handling, and disable it for
12879 languages like C that do not normally require it. However, you may need
12880 to enable this option when compiling C code that needs to interoperate
12881 properly with exception handlers written in C++. You may also wish to
12882 disable this option if you are compiling older C++ programs that don't
12883 use exception handling.
12884
12885 @item -fnon-call-exceptions
12886 @opindex fnon-call-exceptions
12887 Generate code that allows trapping instructions to throw exceptions.
12888 Note that this requires platform-specific runtime support that does
12889 not exist everywhere. Moreover, it only allows @emph{trapping}
12890 instructions to throw exceptions, i.e.@: memory references or floating
12891 point instructions. It does not allow exceptions to be thrown from
12892 arbitrary signal handlers such as @code{SIGALRM}.
12893
12894 @item -funwind-tables
12895 @opindex funwind-tables
12896 Similar to @option{-fexceptions}, except that it will just generate any needed
12897 static data, but will not affect the generated code in any other way.
12898 You will normally not enable this option; instead, a language processor
12899 that needs this handling would enable it on your behalf.
12900
12901 @item -fasynchronous-unwind-tables
12902 @opindex fasynchronous-unwind-tables
12903 Generate unwind table in dwarf2 format, if supported by target machine. The
12904 table is exact at each instruction boundary, so it can be used for stack
12905 unwinding from asynchronous events (such as debugger or garbage collector).
12906
12907 @item -fpcc-struct-return
12908 @opindex fpcc-struct-return
12909 Return ``short'' @code{struct} and @code{union} values in memory like
12910 longer ones, rather than in registers. This convention is less
12911 efficient, but it has the advantage of allowing intercallability between
12912 GCC-compiled files and files compiled with other compilers, particularly
12913 the Portable C Compiler (pcc).
12914
12915 The precise convention for returning structures in memory depends
12916 on the target configuration macros.
12917
12918 Short structures and unions are those whose size and alignment match
12919 that of some integer type.
12920
12921 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12922 switch is not binary compatible with code compiled with the
12923 @option{-freg-struct-return} switch.
12924 Use it to conform to a non-default application binary interface.
12925
12926 @item -freg-struct-return
12927 @opindex freg-struct-return
12928 Return @code{struct} and @code{union} values in registers when possible.
12929 This is more efficient for small structures than
12930 @option{-fpcc-struct-return}.
12931
12932 If you specify neither @option{-fpcc-struct-return} nor
12933 @option{-freg-struct-return}, GCC defaults to whichever convention is
12934 standard for the target. If there is no standard convention, GCC
12935 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12936 the principal compiler. In those cases, we can choose the standard, and
12937 we chose the more efficient register return alternative.
12938
12939 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12940 switch is not binary compatible with code compiled with the
12941 @option{-fpcc-struct-return} switch.
12942 Use it to conform to a non-default application binary interface.
12943
12944 @item -fshort-enums
12945 @opindex fshort-enums
12946 Allocate to an @code{enum} type only as many bytes as it needs for the
12947 declared range of possible values. Specifically, the @code{enum} type
12948 will be equivalent to the smallest integer type which has enough room.
12949
12950 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12951 code that is not binary compatible with code generated without that switch.
12952 Use it to conform to a non-default application binary interface.
12953
12954 @item -fshort-double
12955 @opindex fshort-double
12956 Use the same size for @code{double} as for @code{float}.
12957
12958 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12959 code that is not binary compatible with code generated without that switch.
12960 Use it to conform to a non-default application binary interface.
12961
12962 @item -fshort-wchar
12963 @opindex fshort-wchar
12964 Override the underlying type for @samp{wchar_t} to be @samp{short
12965 unsigned int} instead of the default for the target. This option is
12966 useful for building programs to run under WINE@.
12967
12968 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12969 code that is not binary compatible with code generated without that switch.
12970 Use it to conform to a non-default application binary interface.
12971
12972 @item -fshared-data
12973 @opindex fshared-data
12974 Requests that the data and non-@code{const} variables of this
12975 compilation be shared data rather than private data. The distinction
12976 makes sense only on certain operating systems, where shared data is
12977 shared between processes running the same program, while private data
12978 exists in one copy per process.
12979
12980 @item -fno-common
12981 @opindex fno-common
12982 In C, allocate even uninitialized global variables in the data section of the
12983 object file, rather than generating them as common blocks. This has the
12984 effect that if the same variable is declared (without @code{extern}) in
12985 two different compilations, you will get an error when you link them.
12986 The only reason this might be useful is if you wish to verify that the
12987 program will work on other systems which always work this way.
12988
12989 @item -fno-ident
12990 @opindex fno-ident
12991 Ignore the @samp{#ident} directive.
12992
12993 @item -finhibit-size-directive
12994 @opindex finhibit-size-directive
12995 Don't output a @code{.size} assembler directive, or anything else that
12996 would cause trouble if the function is split in the middle, and the
12997 two halves are placed at locations far apart in memory. This option is
12998 used when compiling @file{crtstuff.c}; you should not need to use it
12999 for anything else.
13000
13001 @item -fverbose-asm
13002 @opindex fverbose-asm
13003 Put extra commentary information in the generated assembly code to
13004 make it more readable. This option is generally only of use to those
13005 who actually need to read the generated assembly code (perhaps while
13006 debugging the compiler itself).
13007
13008 @option{-fno-verbose-asm}, the default, causes the
13009 extra information to be omitted and is useful when comparing two assembler
13010 files.
13011
13012 @item -fpic
13013 @opindex fpic
13014 @cindex global offset table
13015 @cindex PIC
13016 Generate position-independent code (PIC) suitable for use in a shared
13017 library, if supported for the target machine. Such code accesses all
13018 constant addresses through a global offset table (GOT)@. The dynamic
13019 loader resolves the GOT entries when the program starts (the dynamic
13020 loader is not part of GCC; it is part of the operating system). If
13021 the GOT size for the linked executable exceeds a machine-specific
13022 maximum size, you get an error message from the linker indicating that
13023 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13024 instead. (These maximums are 8k on the SPARC and 32k
13025 on the m68k and RS/6000. The 386 has no such limit.)
13026
13027 Position-independent code requires special support, and therefore works
13028 only on certain machines. For the 386, GCC supports PIC for System V
13029 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
13030 position-independent.
13031
13032 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13033 are defined to 1.
13034
13035 @item -fPIC
13036 @opindex fPIC
13037 If supported for the target machine, emit position-independent code,
13038 suitable for dynamic linking and avoiding any limit on the size of the
13039 global offset table. This option makes a difference on the m68k,
13040 PowerPC and SPARC@.
13041
13042 Position-independent code requires special support, and therefore works
13043 only on certain machines.
13044
13045 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13046 are defined to 2.
13047
13048 @item -fpie
13049 @itemx -fPIE
13050 @opindex fpie
13051 @opindex fPIE
13052 These options are similar to @option{-fpic} and @option{-fPIC}, but
13053 generated position independent code can be only linked into executables.
13054 Usually these options are used when @option{-pie} GCC option will be
13055 used during linking.
13056
13057 @item -fno-jump-tables
13058 @opindex fno-jump-tables
13059 Do not use jump tables for switch statements even where it would be
13060 more efficient than other code generation strategies. This option is
13061 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13062 building code which forms part of a dynamic linker and cannot
13063 reference the address of a jump table. On some targets, jump tables
13064 do not require a GOT and this option is not needed.
13065
13066 @item -ffixed-@var{reg}
13067 @opindex ffixed
13068 Treat the register named @var{reg} as a fixed register; generated code
13069 should never refer to it (except perhaps as a stack pointer, frame
13070 pointer or in some other fixed role).
13071
13072 @var{reg} must be the name of a register. The register names accepted
13073 are machine-specific and are defined in the @code{REGISTER_NAMES}
13074 macro in the machine description macro file.
13075
13076 This flag does not have a negative form, because it specifies a
13077 three-way choice.
13078
13079 @item -fcall-used-@var{reg}
13080 @opindex fcall-used
13081 Treat the register named @var{reg} as an allocable register that is
13082 clobbered by function calls. It may be allocated for temporaries or
13083 variables that do not live across a call. Functions compiled this way
13084 will not save and restore the register @var{reg}.
13085
13086 It is an error to used this flag with the frame pointer or stack pointer.
13087 Use of this flag for other registers that have fixed pervasive roles in
13088 the machine's execution model will produce disastrous results.
13089
13090 This flag does not have a negative form, because it specifies a
13091 three-way choice.
13092
13093 @item -fcall-saved-@var{reg}
13094 @opindex fcall-saved
13095 Treat the register named @var{reg} as an allocable register saved by
13096 functions. It may be allocated even for temporaries or variables that
13097 live across a call. Functions compiled this way will save and restore
13098 the register @var{reg} if they use it.
13099
13100 It is an error to used this flag with the frame pointer or stack pointer.
13101 Use of this flag for other registers that have fixed pervasive roles in
13102 the machine's execution model will produce disastrous results.
13103
13104 A different sort of disaster will result from the use of this flag for
13105 a register in which function values may be returned.
13106
13107 This flag does not have a negative form, because it specifies a
13108 three-way choice.
13109
13110 @item -fpack-struct[=@var{n}]
13111 @opindex fpack-struct
13112 Without a value specified, pack all structure members together without
13113 holes. When a value is specified (which must be a small power of two), pack
13114 structure members according to this value, representing the maximum
13115 alignment (that is, objects with default alignment requirements larger than
13116 this will be output potentially unaligned at the next fitting location.
13117
13118 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13119 code that is not binary compatible with code generated without that switch.
13120 Additionally, it makes the code suboptimal.
13121 Use it to conform to a non-default application binary interface.
13122
13123 @item -finstrument-functions
13124 @opindex finstrument-functions
13125 Generate instrumentation calls for entry and exit to functions. Just
13126 after function entry and just before function exit, the following
13127 profiling functions will be called with the address of the current
13128 function and its call site. (On some platforms,
13129 @code{__builtin_return_address} does not work beyond the current
13130 function, so the call site information may not be available to the
13131 profiling functions otherwise.)
13132
13133 @smallexample
13134 void __cyg_profile_func_enter (void *this_fn,
13135 void *call_site);
13136 void __cyg_profile_func_exit (void *this_fn,
13137 void *call_site);
13138 @end smallexample
13139
13140 The first argument is the address of the start of the current function,
13141 which may be looked up exactly in the symbol table.
13142
13143 This instrumentation is also done for functions expanded inline in other
13144 functions. The profiling calls will indicate where, conceptually, the
13145 inline function is entered and exited. This means that addressable
13146 versions of such functions must be available. If all your uses of a
13147 function are expanded inline, this may mean an additional expansion of
13148 code size. If you use @samp{extern inline} in your C code, an
13149 addressable version of such functions must be provided. (This is
13150 normally the case anyways, but if you get lucky and the optimizer always
13151 expands the functions inline, you might have gotten away without
13152 providing static copies.)
13153
13154 A function may be given the attribute @code{no_instrument_function}, in
13155 which case this instrumentation will not be done. This can be used, for
13156 example, for the profiling functions listed above, high-priority
13157 interrupt routines, and any functions from which the profiling functions
13158 cannot safely be called (perhaps signal handlers, if the profiling
13159 routines generate output or allocate memory).
13160
13161 @item -fstack-check
13162 @opindex fstack-check
13163 Generate code to verify that you do not go beyond the boundary of the
13164 stack. You should specify this flag if you are running in an
13165 environment with multiple threads, but only rarely need to specify it in
13166 a single-threaded environment since stack overflow is automatically
13167 detected on nearly all systems if there is only one stack.
13168
13169 Note that this switch does not actually cause checking to be done; the
13170 operating system must do that. The switch causes generation of code
13171 to ensure that the operating system sees the stack being extended.
13172
13173 @item -fstack-limit-register=@var{reg}
13174 @itemx -fstack-limit-symbol=@var{sym}
13175 @itemx -fno-stack-limit
13176 @opindex fstack-limit-register
13177 @opindex fstack-limit-symbol
13178 @opindex fno-stack-limit
13179 Generate code to ensure that the stack does not grow beyond a certain value,
13180 either the value of a register or the address of a symbol. If the stack
13181 would grow beyond the value, a signal is raised. For most targets,
13182 the signal is raised before the stack overruns the boundary, so
13183 it is possible to catch the signal without taking special precautions.
13184
13185 For instance, if the stack starts at absolute address @samp{0x80000000}
13186 and grows downwards, you can use the flags
13187 @option{-fstack-limit-symbol=__stack_limit} and
13188 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13189 of 128KB@. Note that this may only work with the GNU linker.
13190
13191 @cindex aliasing of parameters
13192 @cindex parameters, aliased
13193 @item -fargument-alias
13194 @itemx -fargument-noalias
13195 @itemx -fargument-noalias-global
13196 @opindex fargument-alias
13197 @opindex fargument-noalias
13198 @opindex fargument-noalias-global
13199 Specify the possible relationships among parameters and between
13200 parameters and global data.
13201
13202 @option{-fargument-alias} specifies that arguments (parameters) may
13203 alias each other and may alias global storage.@*
13204 @option{-fargument-noalias} specifies that arguments do not alias
13205 each other, but may alias global storage.@*
13206 @option{-fargument-noalias-global} specifies that arguments do not
13207 alias each other and do not alias global storage.
13208
13209 Each language will automatically use whatever option is required by
13210 the language standard. You should not need to use these options yourself.
13211
13212 @item -fleading-underscore
13213 @opindex fleading-underscore
13214 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13215 change the way C symbols are represented in the object file. One use
13216 is to help link with legacy assembly code.
13217
13218 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13219 generate code that is not binary compatible with code generated without that
13220 switch. Use it to conform to a non-default application binary interface.
13221 Not all targets provide complete support for this switch.
13222
13223 @item -ftls-model=@var{model}
13224 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13225 The @var{model} argument should be one of @code{global-dynamic},
13226 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13227
13228 The default without @option{-fpic} is @code{initial-exec}; with
13229 @option{-fpic} the default is @code{global-dynamic}.
13230
13231 @item -fvisibility=@var{default|internal|hidden|protected}
13232 @opindex fvisibility
13233 Set the default ELF image symbol visibility to the specified option---all
13234 symbols will be marked with this unless overridden within the code.
13235 Using this feature can very substantially improve linking and
13236 load times of shared object libraries, produce more optimized
13237 code, provide near-perfect API export and prevent symbol clashes.
13238 It is @strong{strongly} recommended that you use this in any shared objects
13239 you distribute.
13240
13241 Despite the nomenclature, @code{default} always means public ie;
13242 available to be linked against from outside the shared object.
13243 @code{protected} and @code{internal} are pretty useless in real-world
13244 usage so the only other commonly used option will be @code{hidden}.
13245 The default if @option{-fvisibility} isn't specified is
13246 @code{default}, i.e., make every
13247 symbol public---this causes the same behavior as previous versions of
13248 GCC@.
13249
13250 A good explanation of the benefits offered by ensuring ELF
13251 symbols have the correct visibility is given by ``How To Write
13252 Shared Libraries'' by Ulrich Drepper (which can be found at
13253 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13254 solution made possible by this option to marking things hidden when
13255 the default is public is to make the default hidden and mark things
13256 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13257 and @code{__attribute__ ((visibility("default")))} instead of
13258 @code{__declspec(dllexport)} you get almost identical semantics with
13259 identical syntax. This is a great boon to those working with
13260 cross-platform projects.
13261
13262 For those adding visibility support to existing code, you may find
13263 @samp{#pragma GCC visibility} of use. This works by you enclosing
13264 the declarations you wish to set visibility for with (for example)
13265 @samp{#pragma GCC visibility push(hidden)} and
13266 @samp{#pragma GCC visibility pop}.
13267 Bear in mind that symbol visibility should be viewed @strong{as
13268 part of the API interface contract} and thus all new code should
13269 always specify visibility when it is not the default ie; declarations
13270 only for use within the local DSO should @strong{always} be marked explicitly
13271 as hidden as so to avoid PLT indirection overheads---making this
13272 abundantly clear also aids readability and self-documentation of the code.
13273 Note that due to ISO C++ specification requirements, operator new and
13274 operator delete must always be of default visibility.
13275
13276 An overview of these techniques, their benefits and how to use them
13277 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
13278
13279 @end table
13280
13281 @c man end
13282
13283 @node Environment Variables
13284 @section Environment Variables Affecting GCC
13285 @cindex environment variables
13286
13287 @c man begin ENVIRONMENT
13288 This section describes several environment variables that affect how GCC
13289 operates. Some of them work by specifying directories or prefixes to use
13290 when searching for various kinds of files. Some are used to specify other
13291 aspects of the compilation environment.
13292
13293 Note that you can also specify places to search using options such as
13294 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
13295 take precedence over places specified using environment variables, which
13296 in turn take precedence over those specified by the configuration of GCC@.
13297 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
13298 GNU Compiler Collection (GCC) Internals}.
13299
13300 @table @env
13301 @item LANG
13302 @itemx LC_CTYPE
13303 @c @itemx LC_COLLATE
13304 @itemx LC_MESSAGES
13305 @c @itemx LC_MONETARY
13306 @c @itemx LC_NUMERIC
13307 @c @itemx LC_TIME
13308 @itemx LC_ALL
13309 @findex LANG
13310 @findex LC_CTYPE
13311 @c @findex LC_COLLATE
13312 @findex LC_MESSAGES
13313 @c @findex LC_MONETARY
13314 @c @findex LC_NUMERIC
13315 @c @findex LC_TIME
13316 @findex LC_ALL
13317 @cindex locale
13318 These environment variables control the way that GCC uses
13319 localization information that allow GCC to work with different
13320 national conventions. GCC inspects the locale categories
13321 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
13322 so. These locale categories can be set to any value supported by your
13323 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
13324 Kingdom encoded in UTF-8.
13325
13326 The @env{LC_CTYPE} environment variable specifies character
13327 classification. GCC uses it to determine the character boundaries in
13328 a string; this is needed for some multibyte encodings that contain quote
13329 and escape characters that would otherwise be interpreted as a string
13330 end or escape.
13331
13332 The @env{LC_MESSAGES} environment variable specifies the language to
13333 use in diagnostic messages.
13334
13335 If the @env{LC_ALL} environment variable is set, it overrides the value
13336 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
13337 and @env{LC_MESSAGES} default to the value of the @env{LANG}
13338 environment variable. If none of these variables are set, GCC
13339 defaults to traditional C English behavior.
13340
13341 @item TMPDIR
13342 @findex TMPDIR
13343 If @env{TMPDIR} is set, it specifies the directory to use for temporary
13344 files. GCC uses temporary files to hold the output of one stage of
13345 compilation which is to be used as input to the next stage: for example,
13346 the output of the preprocessor, which is the input to the compiler
13347 proper.
13348
13349 @item GCC_EXEC_PREFIX
13350 @findex GCC_EXEC_PREFIX
13351 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
13352 names of the subprograms executed by the compiler. No slash is added
13353 when this prefix is combined with the name of a subprogram, but you can
13354 specify a prefix that ends with a slash if you wish.
13355
13356 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
13357 an appropriate prefix to use based on the pathname it was invoked with.
13358
13359 If GCC cannot find the subprogram using the specified prefix, it
13360 tries looking in the usual places for the subprogram.
13361
13362 The default value of @env{GCC_EXEC_PREFIX} is
13363 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
13364 of @code{prefix} when you ran the @file{configure} script.
13365
13366 Other prefixes specified with @option{-B} take precedence over this prefix.
13367
13368 This prefix is also used for finding files such as @file{crt0.o} that are
13369 used for linking.
13370
13371 In addition, the prefix is used in an unusual way in finding the
13372 directories to search for header files. For each of the standard
13373 directories whose name normally begins with @samp{/usr/local/lib/gcc}
13374 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
13375 replacing that beginning with the specified prefix to produce an
13376 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
13377 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
13378 These alternate directories are searched first; the standard directories
13379 come next.
13380
13381 @item COMPILER_PATH
13382 @findex COMPILER_PATH
13383 The value of @env{COMPILER_PATH} is a colon-separated list of
13384 directories, much like @env{PATH}. GCC tries the directories thus
13385 specified when searching for subprograms, if it can't find the
13386 subprograms using @env{GCC_EXEC_PREFIX}.
13387
13388 @item LIBRARY_PATH
13389 @findex LIBRARY_PATH
13390 The value of @env{LIBRARY_PATH} is a colon-separated list of
13391 directories, much like @env{PATH}. When configured as a native compiler,
13392 GCC tries the directories thus specified when searching for special
13393 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
13394 using GCC also uses these directories when searching for ordinary
13395 libraries for the @option{-l} option (but directories specified with
13396 @option{-L} come first).
13397
13398 @item LANG
13399 @findex LANG
13400 @cindex locale definition
13401 This variable is used to pass locale information to the compiler. One way in
13402 which this information is used is to determine the character set to be used
13403 when character literals, string literals and comments are parsed in C and C++.
13404 When the compiler is configured to allow multibyte characters,
13405 the following values for @env{LANG} are recognized:
13406
13407 @table @samp
13408 @item C-JIS
13409 Recognize JIS characters.
13410 @item C-SJIS
13411 Recognize SJIS characters.
13412 @item C-EUCJP
13413 Recognize EUCJP characters.
13414 @end table
13415
13416 If @env{LANG} is not defined, or if it has some other value, then the
13417 compiler will use mblen and mbtowc as defined by the default locale to
13418 recognize and translate multibyte characters.
13419 @end table
13420
13421 @noindent
13422 Some additional environments variables affect the behavior of the
13423 preprocessor.
13424
13425 @include cppenv.texi
13426
13427 @c man end
13428
13429 @node Precompiled Headers
13430 @section Using Precompiled Headers
13431 @cindex precompiled headers
13432 @cindex speed of compilation
13433
13434 Often large projects have many header files that are included in every
13435 source file. The time the compiler takes to process these header files
13436 over and over again can account for nearly all of the time required to
13437 build the project. To make builds faster, GCC allows users to
13438 `precompile' a header file; then, if builds can use the precompiled
13439 header file they will be much faster.
13440
13441 To create a precompiled header file, simply compile it as you would any
13442 other file, if necessary using the @option{-x} option to make the driver
13443 treat it as a C or C++ header file. You will probably want to use a
13444 tool like @command{make} to keep the precompiled header up-to-date when
13445 the headers it contains change.
13446
13447 A precompiled header file will be searched for when @code{#include} is
13448 seen in the compilation. As it searches for the included file
13449 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13450 compiler looks for a precompiled header in each directory just before it
13451 looks for the include file in that directory. The name searched for is
13452 the name specified in the @code{#include} with @samp{.gch} appended. If
13453 the precompiled header file can't be used, it is ignored.
13454
13455 For instance, if you have @code{#include "all.h"}, and you have
13456 @file{all.h.gch} in the same directory as @file{all.h}, then the
13457 precompiled header file will be used if possible, and the original
13458 header will be used otherwise.
13459
13460 Alternatively, you might decide to put the precompiled header file in a
13461 directory and use @option{-I} to ensure that directory is searched
13462 before (or instead of) the directory containing the original header.
13463 Then, if you want to check that the precompiled header file is always
13464 used, you can put a file of the same name as the original header in this
13465 directory containing an @code{#error} command.
13466
13467 This also works with @option{-include}. So yet another way to use
13468 precompiled headers, good for projects not designed with precompiled
13469 header files in mind, is to simply take most of the header files used by
13470 a project, include them from another header file, precompile that header
13471 file, and @option{-include} the precompiled header. If the header files
13472 have guards against multiple inclusion, they will be skipped because
13473 they've already been included (in the precompiled header).
13474
13475 If you need to precompile the same header file for different
13476 languages, targets, or compiler options, you can instead make a
13477 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13478 header in the directory, perhaps using @option{-o}. It doesn't matter
13479 what you call the files in the directory, every precompiled header in
13480 the directory will be considered. The first precompiled header
13481 encountered in the directory that is valid for this compilation will
13482 be used; they're searched in no particular order.
13483
13484 There are many other possibilities, limited only by your imagination,
13485 good sense, and the constraints of your build system.
13486
13487 A precompiled header file can be used only when these conditions apply:
13488
13489 @itemize
13490 @item
13491 Only one precompiled header can be used in a particular compilation.
13492
13493 @item
13494 A precompiled header can't be used once the first C token is seen. You
13495 can have preprocessor directives before a precompiled header; you can
13496 even include a precompiled header from inside another header, so long as
13497 there are no C tokens before the @code{#include}.
13498
13499 @item
13500 The precompiled header file must be produced for the same language as
13501 the current compilation. You can't use a C precompiled header for a C++
13502 compilation.
13503
13504 @item
13505 The precompiled header file must have been produced by the same compiler
13506 binary as the current compilation is using.
13507
13508 @item
13509 Any macros defined before the precompiled header is included must
13510 either be defined in the same way as when the precompiled header was
13511 generated, or must not affect the precompiled header, which usually
13512 means that they don't appear in the precompiled header at all.
13513
13514 The @option{-D} option is one way to define a macro before a
13515 precompiled header is included; using a @code{#define} can also do it.
13516 There are also some options that define macros implicitly, like
13517 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13518 defined this way.
13519
13520 @item If debugging information is output when using the precompiled
13521 header, using @option{-g} or similar, the same kind of debugging information
13522 must have been output when building the precompiled header. However,
13523 a precompiled header built using @option{-g} can be used in a compilation
13524 when no debugging information is being output.
13525
13526 @item The same @option{-m} options must generally be used when building
13527 and using the precompiled header. @xref{Submodel Options},
13528 for any cases where this rule is relaxed.
13529
13530 @item Each of the following options must be the same when building and using
13531 the precompiled header:
13532
13533 @gccoptlist{-fexceptions -funit-at-a-time}
13534
13535 @item
13536 Some other command-line options starting with @option{-f},
13537 @option{-p}, or @option{-O} must be defined in the same way as when
13538 the precompiled header was generated. At present, it's not clear
13539 which options are safe to change and which are not; the safest choice
13540 is to use exactly the same options when generating and using the
13541 precompiled header. The following are known to be safe:
13542
13543 @gccoptlist{-fmessage-length= -fpreprocessed
13544 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13545 -fsched-verbose=<number> -fschedule-insns -fvisibility=
13546 -pedantic-errors}
13547
13548 @end itemize
13549
13550 For all of these except the last, the compiler will automatically
13551 ignore the precompiled header if the conditions aren't met. If you
13552 find an option combination that doesn't work and doesn't cause the
13553 precompiled header to be ignored, please consider filing a bug report,
13554 see @ref{Bugs}.
13555
13556 If you do use differing options when generating and using the
13557 precompiled header, the actual behavior will be a mixture of the
13558 behavior for the options. For instance, if you use @option{-g} to
13559 generate the precompiled header but not when using it, you may or may
13560 not get debugging information for routines in the precompiled header.
13561
13562 @node Running Protoize
13563 @section Running Protoize
13564
13565 The program @code{protoize} is an optional part of GCC@. You can use
13566 it to add prototypes to a program, thus converting the program to ISO
13567 C in one respect. The companion program @code{unprotoize} does the
13568 reverse: it removes argument types from any prototypes that are found.
13569
13570 When you run these programs, you must specify a set of source files as
13571 command line arguments. The conversion programs start out by compiling
13572 these files to see what functions they define. The information gathered
13573 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13574
13575 After scanning comes actual conversion. The specified files are all
13576 eligible to be converted; any files they include (whether sources or
13577 just headers) are eligible as well.
13578
13579 But not all the eligible files are converted. By default,
13580 @code{protoize} and @code{unprotoize} convert only source and header
13581 files in the current directory. You can specify additional directories
13582 whose files should be converted with the @option{-d @var{directory}}
13583 option. You can also specify particular files to exclude with the
13584 @option{-x @var{file}} option. A file is converted if it is eligible, its
13585 directory name matches one of the specified directory names, and its
13586 name within the directory has not been excluded.
13587
13588 Basic conversion with @code{protoize} consists of rewriting most
13589 function definitions and function declarations to specify the types of
13590 the arguments. The only ones not rewritten are those for varargs
13591 functions.
13592
13593 @code{protoize} optionally inserts prototype declarations at the
13594 beginning of the source file, to make them available for any calls that
13595 precede the function's definition. Or it can insert prototype
13596 declarations with block scope in the blocks where undeclared functions
13597 are called.
13598
13599 Basic conversion with @code{unprotoize} consists of rewriting most
13600 function declarations to remove any argument types, and rewriting
13601 function definitions to the old-style pre-ISO form.
13602
13603 Both conversion programs print a warning for any function declaration or
13604 definition that they can't convert. You can suppress these warnings
13605 with @option{-q}.
13606
13607 The output from @code{protoize} or @code{unprotoize} replaces the
13608 original source file. The original file is renamed to a name ending
13609 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13610 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
13611 for DOS) file already exists, then the source file is simply discarded.
13612
13613 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13614 scan the program and collect information about the functions it uses.
13615 So neither of these programs will work until GCC is installed.
13616
13617 Here is a table of the options you can use with @code{protoize} and
13618 @code{unprotoize}. Each option works with both programs unless
13619 otherwise stated.
13620
13621 @table @code
13622 @item -B @var{directory}
13623 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13624 usual directory (normally @file{/usr/local/lib}). This file contains
13625 prototype information about standard system functions. This option
13626 applies only to @code{protoize}.
13627
13628 @item -c @var{compilation-options}
13629 Use @var{compilation-options} as the options when running @command{gcc} to
13630 produce the @samp{.X} files. The special option @option{-aux-info} is
13631 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13632
13633 Note that the compilation options must be given as a single argument to
13634 @code{protoize} or @code{unprotoize}. If you want to specify several
13635 @command{gcc} options, you must quote the entire set of compilation options
13636 to make them a single word in the shell.
13637
13638 There are certain @command{gcc} arguments that you cannot use, because they
13639 would produce the wrong kind of output. These include @option{-g},
13640 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13641 the @var{compilation-options}, they are ignored.
13642
13643 @item -C
13644 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13645 systems) instead of @samp{.c}. This is convenient if you are converting
13646 a C program to C++. This option applies only to @code{protoize}.
13647
13648 @item -g
13649 Add explicit global declarations. This means inserting explicit
13650 declarations at the beginning of each source file for each function
13651 that is called in the file and was not declared. These declarations
13652 precede the first function definition that contains a call to an
13653 undeclared function. This option applies only to @code{protoize}.
13654
13655 @item -i @var{string}
13656 Indent old-style parameter declarations with the string @var{string}.
13657 This option applies only to @code{protoize}.
13658
13659 @code{unprotoize} converts prototyped function definitions to old-style
13660 function definitions, where the arguments are declared between the
13661 argument list and the initial @samp{@{}. By default, @code{unprotoize}
13662 uses five spaces as the indentation. If you want to indent with just
13663 one space instead, use @option{-i " "}.
13664
13665 @item -k
13666 Keep the @samp{.X} files. Normally, they are deleted after conversion
13667 is finished.
13668
13669 @item -l
13670 Add explicit local declarations. @code{protoize} with @option{-l} inserts
13671 a prototype declaration for each function in each block which calls the
13672 function without any declaration. This option applies only to
13673 @code{protoize}.
13674
13675 @item -n
13676 Make no real changes. This mode just prints information about the conversions
13677 that would have been done without @option{-n}.
13678
13679 @item -N
13680 Make no @samp{.save} files. The original files are simply deleted.
13681 Use this option with caution.
13682
13683 @item -p @var{program}
13684 Use the program @var{program} as the compiler. Normally, the name
13685 @file{gcc} is used.
13686
13687 @item -q
13688 Work quietly. Most warnings are suppressed.
13689
13690 @item -v
13691 Print the version number, just like @option{-v} for @command{gcc}.
13692 @end table
13693
13694 If you need special compiler options to compile one of your program's
13695 source files, then you should generate that file's @samp{.X} file
13696 specially, by running @command{gcc} on that source file with the
13697 appropriate options and the option @option{-aux-info}. Then run
13698 @code{protoize} on the entire set of files. @code{protoize} will use
13699 the existing @samp{.X} file because it is newer than the source file.
13700 For example:
13701
13702 @smallexample
13703 gcc -Dfoo=bar file1.c -aux-info file1.X
13704 protoize *.c
13705 @end smallexample
13706
13707 @noindent
13708 You need to include the special files along with the rest in the
13709 @code{protoize} command, even though their @samp{.X} files already
13710 exist, because otherwise they won't get converted.
13711
13712 @xref{Protoize Caveats}, for more information on how to use
13713 @code{protoize} successfully.