200x-xx-xx Nathan Sidwell <nathan@codesourcery.com> Richard Sandiford <richard@codeso...
[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, 2007
3 @c Free Software Foundation, Inc.
4 @c This is part of the GCC manual.
5 @c For copying conditions, see the file gcc.texi.
6
7 @ignore
8 @c man begin INCLUDE
9 @include gcc-vers.texi
10 @c man end
11
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
15
16 Permission is granted to copy, distribute and/or modify this document
17 under the terms of the GNU Free Documentation License, Version 1.2 or
18 any later version published by the Free Software Foundation; with the
19 Invariant Sections being ``GNU General Public License'' and ``Funding
20 Free Software'', the Front-Cover texts being (a) (see below), and with
21 the Back-Cover Texts being (b) (see below). A copy of the license is
22 included in the gfdl(7) man page.
23
24 (a) The FSF's Front-Cover Text is:
25
26 A GNU Manual
27
28 (b) The FSF's Back-Cover Text is:
29
30 You have freedom to copy and modify this GNU Manual, like GNU
31 software. Copies published by the Free Software Foundation raise
32 funds for GNU development.
33 @c man end
34 @c Set file name and title for the man page.
35 @setfilename gcc
36 @settitle GNU project C and C++ compiler
37 @c man begin SYNOPSIS
38 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
39 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
40 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
41 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
42 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
43 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
44 [@option{-o} @var{outfile}] [@@@var{file}] @var{infile}@dots{}
45
46 Only the most useful options are listed here; see below for the
47 remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
48 @c man end
49 @c man begin SEEALSO
50 gpl(7), gfdl(7), fsf-funding(7),
51 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
52 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
53 @file{ld}, @file{binutils} and @file{gdb}.
54 @c man end
55 @c man begin BUGS
56 For instructions on reporting bugs, see
57 @w{@uref{http://gcc.gnu.org/bugs.html}}.
58 @c man end
59 @c man begin AUTHOR
60 See the Info entry for @command{gcc}, or
61 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
62 for contributors to GCC@.
63 @c man end
64 @end ignore
65
66 @node Invoking GCC
67 @chapter GCC Command Options
68 @cindex GCC command options
69 @cindex command options
70 @cindex options, GCC command
71
72 @c man begin DESCRIPTION
73 When you invoke GCC, it normally does preprocessing, compilation,
74 assembly and linking. The ``overall options'' allow you to stop this
75 process at an intermediate stage. For example, the @option{-c} option
76 says not to run the linker. Then the output consists of object files
77 output by the assembler.
78
79 Other options are passed on to one stage of processing. Some options
80 control the preprocessor and others the compiler itself. Yet other
81 options control the assembler and linker; most of these are not
82 documented here, since you rarely need to use any of them.
83
84 @cindex C compilation options
85 Most of the command line options that you can use with GCC are useful
86 for C programs; when an option is only useful with another language
87 (usually C++), the explanation says so explicitly. If the description
88 for a particular option does not mention a source language, you can use
89 that option with all supported languages.
90
91 @cindex C++ compilation options
92 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
93 options for compiling C++ programs.
94
95 @cindex grouping options
96 @cindex options, grouping
97 The @command{gcc} program accepts options and file names as operands. Many
98 options have multi-letter names; therefore multiple single-letter options
99 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
100 -r}}.
101
102 @cindex order of options
103 @cindex options, order
104 You can mix options and other arguments. For the most part, the order
105 you use doesn't matter. Order does matter when you use several options
106 of the same kind; for example, if you specify @option{-L} more than once,
107 the directories are searched in the order specified.
108
109 Many options have long names starting with @samp{-f} or with
110 @samp{-W}---for example,
111 @option{-fmove-loop-invariants}, @option{-Wformat} and so on. Most of
112 these have both positive and negative forms; the negative form of
113 @option{-ffoo} would be @option{-fno-foo}. This manual documents
114 only one of these two forms, whichever one is not the default.
115
116 @c man end
117
118 @xref{Option Index}, for an index to GCC's options.
119
120 @menu
121 * Option Summary:: Brief list of all options, without explanations.
122 * Overall Options:: Controlling the kind of output:
123 an executable, object files, assembler files,
124 or preprocessed source.
125 * Invoking G++:: Compiling C++ programs.
126 * C Dialect Options:: Controlling the variant of C language compiled.
127 * C++ Dialect Options:: Variations on C++.
128 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
129 and Objective-C++.
130 * Language Independent Options:: Controlling how diagnostics should be
131 formatted.
132 * Warning Options:: How picky should the compiler be?
133 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
134 * Optimize Options:: How much optimization?
135 * Preprocessor Options:: Controlling header files and macro definitions.
136 Also, getting dependency information for Make.
137 * Assembler Options:: Passing options to the assembler.
138 * Link Options:: Specifying libraries and so on.
139 * Directory Options:: Where to find header files and libraries.
140 Where to find the compiler executable files.
141 * Spec Files:: How to pass switches to sub-processes.
142 * Target Options:: Running a cross-compiler, or an old version of GCC.
143 * Submodel Options:: Specifying minor hardware or convention variations,
144 such as 68010 vs 68020.
145 * Code Gen Options:: Specifying conventions for function calls, data layout
146 and register usage.
147 * Environment Variables:: Env vars that affect GCC.
148 * Precompiled Headers:: Compiling a header once, and using it many times.
149 * Running Protoize:: Automatically adding or removing function prototypes.
150 @end menu
151
152 @c man begin OPTIONS
153
154 @node Option Summary
155 @section Option Summary
156
157 Here is a summary of all the options, grouped by type. Explanations are
158 in the following sections.
159
160 @table @emph
161 @item Overall Options
162 @xref{Overall Options,,Options Controlling the Kind of Output}.
163 @gccoptlist{-c -S -E -o @var{file} -combine -pipe -pass-exit-codes @gol
164 -x @var{language} -v -### --help --target-help --version @@@var{file}}
165
166 @item C Language Options
167 @xref{C Dialect Options,,Options Controlling C Dialect}.
168 @gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename} @gol
169 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
170 -fhosted -ffreestanding -fopenmp -fms-extensions @gol
171 -trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
172 -fallow-single-precision -fcond-mismatch -flax-vector-conversions @gol
173 -fsigned-bitfields -fsigned-char @gol
174 -funsigned-bitfields -funsigned-char}
175
176 @item C++ Language Options
177 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
178 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
179 -fconserve-space -ffriend-injection @gol
180 -fno-elide-constructors @gol
181 -fno-enforce-eh-specs @gol
182 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
183 -fno-implicit-templates @gol
184 -fno-implicit-inline-templates @gol
185 -fno-implement-inlines -fms-extensions @gol
186 -fno-nonansi-builtins -fno-operator-names @gol
187 -fno-optional-diags -fpermissive @gol
188 -frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
189 -fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
190 -fno-default-inline -fvisibility-inlines-hidden @gol
191 -Wabi -Wctor-dtor-privacy @gol
192 -Wnon-virtual-dtor -Wreorder @gol
193 -Weffc++ -Wno-deprecated -Wstrict-null-sentinel @gol
194 -Wno-non-template-friend -Wold-style-cast @gol
195 -Woverloaded-virtual -Wno-pmf-conversions @gol
196 -Wsign-promo}
197
198 @item Objective-C and Objective-C++ Language Options
199 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
200 Objective-C and Objective-C++ Dialects}.
201 @gccoptlist{-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-option}
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 @gol
227 -Wclobbered -Wcomment @gol
228 -Wconversion -Wno-deprecated-declarations @gol
229 -Wdisabled-optimization -Wno-div-by-zero @gol
230 -Wempty-body -Wno-endif-labels @gol
231 -Werror -Werror-* -Werror-implicit-function-declaration @gol
232 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
233 -Wno-format-extra-args -Wformat-nonliteral @gol
234 -Wformat-security -Wformat-y2k @gol
235 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
236 -Wimport -Wno-import -Winit-self -Winline @gol
237 -Wno-int-to-pointer-cast @gol
238 -Wno-invalid-offsetof -Winvalid-pch @gol
239 -Wlarger-than-@var{len} -Wunsafe-loop-optimizations -Wlong-long @gol
240 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
241 -Wmissing-format-attribute -Wmissing-include-dirs @gol
242 -Wmissing-noreturn @gol
243 -Wno-multichar -Wnonnull -Wno-overflow @gol
244 -Woverlength-strings -Wpacked -Wpadded @gol
245 -Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
246 -Wredundant-decls @gol
247 -Wreturn-type -Wsequence-point -Wshadow @gol
248 -Wsign-compare -Wstack-protector @gol
249 -Wstrict-aliasing -Wstrict-aliasing=2 @gol
250 -Wstring-literal-comparison @gol
251 -Wswitch -Wswitch-default -Wswitch-enum @gol
252 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
253 -Wunknown-pragmas -Wno-pragmas -Wunreachable-code @gol
254 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
255 -Wunused-value -Wunused-variable -Wvariadic-macros @gol
256 -Wvolatile-register-var -Wwrite-strings}
257
258 @item C-only Warning Options
259 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
260 -Wmissing-parameter-type -Wmissing-prototypes -Wnested-externs @gol
261 -Wold-style-declaration -Wold-style-definition @gol
262 -Wstrict-prototypes -Wtraditional -Wtraditional-conversion @gol
263 -Wdeclaration-after-statement -Wpointer-sign}
264
265 @item Debugging Options
266 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
267 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
268 -fdump-noaddr -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
269 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
270 -fdump-ipa-all -fdump-ipa-cgraph @gol
271 -fdump-tree-all @gol
272 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
276 -fdump-tree-ch @gol
277 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
279 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
281 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
282 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
283 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
284 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
285 -fdump-tree-nrv -fdump-tree-vect @gol
286 -fdump-tree-sink @gol
287 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
288 -fdump-tree-salias @gol
289 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
290 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
291 -ftree-vectorizer-verbose=@var{n} @gol
292 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
293 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
294 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
295 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
296 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
297 -ftest-coverage -ftime-report -fvar-tracking @gol
298 -g -g@var{level} -gcoff -gdwarf-2 @gol
299 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
300 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
301 -print-multi-directory -print-multi-lib @gol
302 -print-prog-name=@var{program} -print-search-dirs -Q @gol
303 -save-temps -time}
304
305 @item Optimization Options
306 @xref{Optimize Options,,Options that Control Optimization}.
307 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
308 -falign-labels=@var{n} -falign-loops=@var{n} @gol
309 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
310 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
311 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
312 -fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
313 -fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
314 -fdelayed-branch -fdelete-null-pointer-checks -fearly-inlining @gol
315 -fexpensive-optimizations -ffast-math -ffloat-store @gol
316 -fforce-addr -fforward-propagate -ffunction-sections @gol
317 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
318 -fcrossjumping -fif-conversion -fif-conversion2 @gol
319 -finline-functions -finline-functions-called-once @gol
320 -finline-limit=@var{n} -fkeep-inline-functions @gol
321 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
322 -fmodulo-sched -fno-branch-count-reg @gol
323 -fno-default-inline -fno-defer-pop -fmove-loop-invariants @gol
324 -fno-function-cse -fno-guess-branch-probability @gol
325 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
326 -funsafe-math-optimizations -funsafe-loop-optimizations -ffinite-math-only @gol
327 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
328 -fomit-frame-pointer -foptimize-register-move @gol
329 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
330 -fprofile-generate -fprofile-use @gol
331 -fregmove -frename-registers @gol
332 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
333 -frerun-cse-after-loop @gol
334 -frounding-math -frtl-abstract-sequences @gol
335 -fschedule-insns -fschedule-insns2 @gol
336 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
337 -fsched-spec-load-dangerous @gol
338 -fsched-stalled-insns=@var{n} -fsched-stalled-insns-dep=@var{n} @gol
339 -fsched2-use-superblocks @gol
340 -fsched2-use-traces -fsee -freschedule-modulo-scheduled-loops @gol
341 -fsection-anchors -fsignaling-nans -fsingle-precision-constant @gol
342 -fstack-protector -fstack-protector-all @gol
343 -fstrict-aliasing -ftracer -fthread-jumps @gol
344 -funroll-all-loops -funroll-loops -fpeel-loops @gol
345 -fsplit-ivs-in-unroller -funswitch-loops @gol
346 -fvariable-expansion-in-unroller @gol
347 -ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
348 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
349 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
350 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
351 -ftree-vect-loop-version -ftree-salias -fipa-pta -fweb @gol
352 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
353 --param @var{name}=@var{value}
354 -O -O0 -O1 -O2 -O3 -Os}
355
356 @item Preprocessor Options
357 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
358 @gccoptlist{-A@var{question}=@var{answer} @gol
359 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
360 -C -dD -dI -dM -dN @gol
361 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
362 -idirafter @var{dir} @gol
363 -include @var{file} -imacros @var{file} @gol
364 -iprefix @var{file} -iwithprefix @var{dir} @gol
365 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
366 -imultilib @var{dir} -isysroot @var{dir} @gol
367 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
368 -P -fworking-directory -remap @gol
369 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
370 -Xpreprocessor @var{option}}
371
372 @item Assembler Option
373 @xref{Assembler Options,,Passing Options to the Assembler}.
374 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
375
376 @item Linker Options
377 @xref{Link Options,,Options for Linking}.
378 @gccoptlist{@var{object-file-name} -l@var{library} @gol
379 -nostartfiles -nodefaultlibs -nostdlib -pie -rdynamic @gol
380 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
381 -Wl,@var{option} -Xlinker @var{option} @gol
382 -u @var{symbol}}
383
384 @item Directory Options
385 @xref{Directory Options,,Options for Directory Search}.
386 @gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir}
387 -specs=@var{file} -I- --sysroot=@var{dir}}
388
389 @item Target Options
390 @c I wrote this xref this way to avoid overfull hbox. -- rms
391 @xref{Target Options}.
392 @gccoptlist{-V @var{version} -b @var{machine}}
393
394 @item Machine Dependent Options
395 @xref{Submodel Options,,Hardware Models and Configurations}.
396 @c This list is ordered alphanumerically by subsection name.
397 @c Try and put the significant identifier (CPU or system) first,
398 @c so users have a clue at guessing where the ones they want will be.
399
400 @emph{ARC Options}
401 @gccoptlist{-EB -EL @gol
402 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
403 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
404
405 @emph{ARM Options}
406 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
407 -mabi=@var{name} @gol
408 -mapcs-stack-check -mno-apcs-stack-check @gol
409 -mapcs-float -mno-apcs-float @gol
410 -mapcs-reentrant -mno-apcs-reentrant @gol
411 -msched-prolog -mno-sched-prolog @gol
412 -mlittle-endian -mbig-endian -mwords-little-endian @gol
413 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
414 -mthumb-interwork -mno-thumb-interwork @gol
415 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
416 -mstructure-size-boundary=@var{n} @gol
417 -mabort-on-noreturn @gol
418 -mlong-calls -mno-long-calls @gol
419 -msingle-pic-base -mno-single-pic-base @gol
420 -mpic-register=@var{reg} @gol
421 -mnop-fun-dllimport @gol
422 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
423 -mpoke-function-name @gol
424 -mthumb -marm @gol
425 -mtpcs-frame -mtpcs-leaf-frame @gol
426 -mcaller-super-interworking -mcallee-super-interworking @gol
427 -mtp=@var{name}}
428
429 @emph{AVR Options}
430 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
431 -mcall-prologues -mno-tablejump -mtiny-stack -mint8}
432
433 @emph{Blackfin Options}
434 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer @gol
435 -mspecld-anomaly -mno-specld-anomaly -mcsync-anomaly -mno-csync-anomaly @gol
436 -mlow-64k -mno-low64k -mstack-check-l1 -mid-shared-library @gol
437 -mno-id-shared-library -mshared-library-id=@var{n} @gol
438 -mleaf-id-shared-library -mno-leaf-id-shared-library @gol
439 -msep-data -mno-sep-data -mlong-calls -mno-long-calls}
440
441 @emph{CRIS Options}
442 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
443 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
444 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
445 -mstack-align -mdata-align -mconst-align @gol
446 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
447 -melf -maout -melinux -mlinux -sim -sim2 @gol
448 -mmul-bug-workaround -mno-mul-bug-workaround}
449
450 @emph{CRX Options}
451 @gccoptlist{-mmac -mpush-args}
452
453 @emph{Darwin Options}
454 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
455 -arch_only -bind_at_load -bundle -bundle_loader @gol
456 -client_name -compatibility_version -current_version @gol
457 -dead_strip @gol
458 -dependency-file -dylib_file -dylinker_install_name @gol
459 -dynamic -dynamiclib -exported_symbols_list @gol
460 -filelist -flat_namespace -force_cpusubtype_ALL @gol
461 -force_flat_namespace -headerpad_max_install_names @gol
462 -image_base -init -install_name -keep_private_externs @gol
463 -multi_module -multiply_defined -multiply_defined_unused @gol
464 -noall_load -no_dead_strip_inits_and_terms @gol
465 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
466 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
467 -private_bundle -read_only_relocs -sectalign @gol
468 -sectobjectsymbols -whyload -seg1addr @gol
469 -sectcreate -sectobjectsymbols -sectorder @gol
470 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
471 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
472 -segprot -segs_read_only_addr -segs_read_write_addr @gol
473 -single_module -static -sub_library -sub_umbrella @gol
474 -twolevel_namespace -umbrella -undefined @gol
475 -unexported_symbols_list -weak_reference_mismatches @gol
476 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
477 -mkernel -mone-byte-bool}
478
479 @emph{DEC Alpha Options}
480 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
481 -mieee -mieee-with-inexact -mieee-conformant @gol
482 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
483 -mtrap-precision=@var{mode} -mbuild-constants @gol
484 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
485 -mbwx -mmax -mfix -mcix @gol
486 -mfloat-vax -mfloat-ieee @gol
487 -mexplicit-relocs -msmall-data -mlarge-data @gol
488 -msmall-text -mlarge-text @gol
489 -mmemory-latency=@var{time}}
490
491 @emph{DEC Alpha/VMS Options}
492 @gccoptlist{-mvms-return-codes}
493
494 @emph{FRV Options}
495 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
496 -mhard-float -msoft-float @gol
497 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
498 -mdouble -mno-double @gol
499 -mmedia -mno-media -mmuladd -mno-muladd @gol
500 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
501 -mlinked-fp -mlong-calls -malign-labels @gol
502 -mlibrary-pic -macc-4 -macc-8 @gol
503 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
504 -moptimize-membar -mno-optimize-membar @gol
505 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
506 -mvliw-branch -mno-vliw-branch @gol
507 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
508 -mno-nested-cond-exec -mtomcat-stats @gol
509 -mTLS -mtls @gol
510 -mcpu=@var{cpu}}
511
512 @emph{GNU/Linux Options}
513 @gccoptlist{-muclibc}
514
515 @emph{H8/300 Options}
516 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
517
518 @emph{HPPA Options}
519 @gccoptlist{-march=@var{architecture-type} @gol
520 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
521 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
522 -mfixed-range=@var{register-range} @gol
523 -mjump-in-delay -mlinker-opt -mlong-calls @gol
524 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
525 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
526 -mno-jump-in-delay -mno-long-load-store @gol
527 -mno-portable-runtime -mno-soft-float @gol
528 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
529 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
530 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
531 -munix=@var{unix-std} -nolibdld -static -threads}
532
533 @emph{i386 and x86-64 Options}
534 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
535 -mfpmath=@var{unit} @gol
536 -masm=@var{dialect} -mno-fancy-math-387 @gol
537 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
538 -mno-wide-multiply -mrtd -malign-double @gol
539 -mpreferred-stack-boundary=@var{num} @gol
540 -mmmx -msse -msse2 -msse3 -mssse3 -m3dnow @gol
541 -mthreads -mno-align-stringops -minline-all-stringops @gol
542 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
543 -m96bit-long-double -mregparm=@var{num} -msseregparm @gol
544 -mstackrealign @gol
545 -momit-leaf-frame-pointer -mno-red-zone -mno-tls-direct-seg-refs @gol
546 -mcmodel=@var{code-model} @gol
547 -m32 -m64 -mlarge-data-threshold=@var{num}}
548
549 @emph{IA-64 Options}
550 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
551 -mvolatile-asm-stop -mregister-names -mno-sdata @gol
552 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
553 -minline-float-divide-max-throughput @gol
554 -minline-int-divide-min-latency @gol
555 -minline-int-divide-max-throughput @gol
556 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
557 -mno-dwarf2-asm -mearly-stop-bits @gol
558 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
559 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64 @gol
560 -mno-sched-br-data-spec -msched-ar-data-spec -mno-sched-control-spec @gol
561 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
562 -msched-ldc -mno-sched-control-ldc -mno-sched-spec-verbose @gol
563 -mno-sched-prefer-non-data-spec-insns @gol
564 -mno-sched-prefer-non-control-spec-insns @gol
565 -mno-sched-count-spec-in-critical-path}
566
567 @emph{M32R/D Options}
568 @gccoptlist{-m32r2 -m32rx -m32r @gol
569 -mdebug @gol
570 -malign-loops -mno-align-loops @gol
571 -missue-rate=@var{number} @gol
572 -mbranch-cost=@var{number} @gol
573 -mmodel=@var{code-size-model-type} @gol
574 -msdata=@var{sdata-type} @gol
575 -mno-flush-func -mflush-func=@var{name} @gol
576 -mno-flush-trap -mflush-trap=@var{number} @gol
577 -G @var{num}}
578
579 @emph{M32C Options}
580 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
581
582 @emph{M680x0 Options}
583 @gccoptlist{-march=@var{arch} -mcpu=@var{cpu} -mtune=@var{tune}
584 -m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
585 -m68060 -mcpu32 -m5200 -m5206e -m528x -m5307 -m5407 @gol
586 -mcfv4e -mbitfield -mc68000 -mc68020 @gol
587 -mnobitfield -mrtd -mdiv -mno-div -mshort @gol
588 -mhard-float -m68881 -msoft-float -mpcrel @gol
589 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
590 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
591
592 @emph{M68hc1x Options}
593 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
594 -mauto-incdec -minmax -mlong-calls -mshort @gol
595 -msoft-reg-count=@var{count}}
596
597 @emph{MCore Options}
598 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
599 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
600 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
601 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
602 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
603
604 @emph{MIPS Options}
605 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
606 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
607 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
608 -mshared -mno-shared -mxgot -mno-xgot -mgp32 -mgp64 @gol
609 -mfp32 -mfp64 -mhard-float -msoft-float @gol
610 -msingle-float -mdouble-float -mdsp -mpaired-single -mips3d @gol
611 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
612 -G@var{num} -membedded-data -mno-embedded-data @gol
613 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
614 -msplit-addresses -mno-split-addresses @gol
615 -mexplicit-relocs -mno-explicit-relocs @gol
616 -mcheck-zero-division -mno-check-zero-division @gol
617 -mdivide-traps -mdivide-breaks @gol
618 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
619 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
620 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
621 -mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
622 -mfix-sb1 -mno-fix-sb1 @gol
623 -mflush-func=@var{func} -mno-flush-func @gol
624 -mbranch-likely -mno-branch-likely @gol
625 -mfp-exceptions -mno-fp-exceptions @gol
626 -mvr4130-align -mno-vr4130-align}
627
628 @emph{MMIX Options}
629 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
630 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
631 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
632 -mno-base-addresses -msingle-exit -mno-single-exit}
633
634 @emph{MN10300 Options}
635 @gccoptlist{-mmult-bug -mno-mult-bug @gol
636 -mam33 -mno-am33 @gol
637 -mam33-2 -mno-am33-2 @gol
638 -mreturn-pointer-on-d0 @gol
639 -mno-crt0 -mrelax}
640
641 @emph{MT Options}
642 @gccoptlist{-mno-crt0 -mbacc -msim @gol
643 -march=@var{cpu-type} }
644
645 @emph{PDP-11 Options}
646 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
647 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
648 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
649 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
650 -mbranch-expensive -mbranch-cheap @gol
651 -msplit -mno-split -munix-asm -mdec-asm}
652
653 @emph{PowerPC Options}
654 See RS/6000 and PowerPC Options.
655
656 @emph{RS/6000 and PowerPC Options}
657 @gccoptlist{-mcpu=@var{cpu-type} @gol
658 -mtune=@var{cpu-type} @gol
659 -mpower -mno-power -mpower2 -mno-power2 @gol
660 -mpowerpc -mpowerpc64 -mno-powerpc @gol
661 -maltivec -mno-altivec @gol
662 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
663 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
664 -mmfcrf -mno-mfcrf -mpopcntb -mno-popcntb -mfprnd -mno-fprnd @gol
665 -mmfpgpr -mno-mfpgpr @gol
666 -mnew-mnemonics -mold-mnemonics @gol
667 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
668 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
669 -malign-power -malign-natural @gol
670 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
671 -mstring -mno-string -mupdate -mno-update @gol
672 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
673 -mstrict-align -mno-strict-align -mrelocatable @gol
674 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
675 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
676 -mdynamic-no-pic -maltivec -mswdiv @gol
677 -mprioritize-restricted-insns=@var{priority} @gol
678 -msched-costly-dep=@var{dependence_type} @gol
679 -minsert-sched-nops=@var{scheme} @gol
680 -mcall-sysv -mcall-netbsd @gol
681 -maix-struct-return -msvr4-struct-return @gol
682 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
683 -misel -mno-isel @gol
684 -misel=yes -misel=no @gol
685 -mspe -mno-spe @gol
686 -mspe=yes -mspe=no @gol
687 -mvrsave -mno-vrsave @gol
688 -mmulhw -mno-mulhw @gol
689 -mdlmzb -mno-dlmzb @gol
690 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
691 -mprototype -mno-prototype @gol
692 -msim -mmvme -mads -myellowknife -memb -msdata @gol
693 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
694
695 @emph{S/390 and zSeries Options}
696 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
697 -mhard-float -msoft-float -mlong-double-64 -mlong-double-128 @gol
698 -mbackchain -mno-backchain -mpacked-stack -mno-packed-stack @gol
699 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
700 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
701 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
702 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
703
704 @emph{Score Options}
705 @gccoptlist{-mel -mel @gol
706 -mmac @gol
707 -mscore5u -mscore7}
708
709 @emph{SH Options}
710 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
711 -m4-nofpu -m4-single-only -m4-single -m4 @gol
712 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
713 -m5-64media -m5-64media-nofpu @gol
714 -m5-32media -m5-32media-nofpu @gol
715 -m5-compact -m5-compact-nofpu @gol
716 -mb -ml -mdalign -mrelax @gol
717 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
718 -mieee -misize -minline-ic_invalidate -mpadstruct -mspace @gol
719 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
720 -mdivsi3_libfunc=@var{name} @gol
721 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
722 -minvalid-symbols}
723
724 @emph{SPARC Options}
725 @gccoptlist{-mcpu=@var{cpu-type} @gol
726 -mtune=@var{cpu-type} @gol
727 -mcmodel=@var{code-model} @gol
728 -m32 -m64 -mapp-regs -mno-app-regs @gol
729 -mfaster-structs -mno-faster-structs @gol
730 -mfpu -mno-fpu -mhard-float -msoft-float @gol
731 -mhard-quad-float -msoft-quad-float @gol
732 -mimpure-text -mno-impure-text -mlittle-endian @gol
733 -mstack-bias -mno-stack-bias @gol
734 -munaligned-doubles -mno-unaligned-doubles @gol
735 -mv8plus -mno-v8plus -mvis -mno-vis
736 -threads -pthreads -pthread}
737
738 @emph{SPU Options}
739 @gccoptlist{-mwarn-reloc -merror-reloc @gol
740 -msafe-dma -munsafe-dma @gol
741 -mbranch-hints @gol
742 -msmall-mem -mlarge-mem -mstdmain @gol
743 -mfixed-range=@var{register-range}}
744
745 @emph{System V Options}
746 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
747
748 @emph{TMS320C3x/C4x Options}
749 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
750 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
751 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
752 -mparallel-insns -mparallel-mpy -mpreserve-float}
753
754 @emph{V850 Options}
755 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
756 -mprolog-function -mno-prolog-function -mspace @gol
757 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
758 -mapp-regs -mno-app-regs @gol
759 -mdisable-callt -mno-disable-callt @gol
760 -mv850e1 @gol
761 -mv850e @gol
762 -mv850 -mbig-switch}
763
764 @emph{VAX Options}
765 @gccoptlist{-mg -mgnu -munix}
766
767 @emph{x86-64 Options}
768 See i386 and x86-64 Options.
769
770 @emph{Xstormy16 Options}
771 @gccoptlist{-msim}
772
773 @emph{Xtensa Options}
774 @gccoptlist{-mconst16 -mno-const16 @gol
775 -mfused-madd -mno-fused-madd @gol
776 -mtext-section-literals -mno-text-section-literals @gol
777 -mtarget-align -mno-target-align @gol
778 -mlongcalls -mno-longcalls}
779
780 @emph{zSeries Options}
781 See S/390 and zSeries Options.
782
783 @item Code Generation Options
784 @xref{Code Gen Options,,Options for Code Generation Conventions}.
785 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
786 -ffixed-@var{reg} -fexceptions @gol
787 -fnon-call-exceptions -funwind-tables @gol
788 -fasynchronous-unwind-tables @gol
789 -finhibit-size-directive -finstrument-functions @gol
790 -fno-common -fno-ident @gol
791 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
792 -fno-jump-tables @gol
793 -frecord-gcc-switches @gol
794 -freg-struct-return -fshort-enums @gol
795 -fshort-double -fshort-wchar @gol
796 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
797 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
798 -fargument-alias -fargument-noalias @gol
799 -fargument-noalias-global -fargument-noalias-anything
800 -fleading-underscore -ftls-model=@var{model} @gol
801 -ftrapv -fwrapv -fbounds-check @gol
802 -fvisibility}
803 @end table
804
805 @menu
806 * Overall Options:: Controlling the kind of output:
807 an executable, object files, assembler files,
808 or preprocessed source.
809 * C Dialect Options:: Controlling the variant of C language compiled.
810 * C++ Dialect Options:: Variations on C++.
811 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
812 and Objective-C++.
813 * Language Independent Options:: Controlling how diagnostics should be
814 formatted.
815 * Warning Options:: How picky should the compiler be?
816 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
817 * Optimize Options:: How much optimization?
818 * Preprocessor Options:: Controlling header files and macro definitions.
819 Also, getting dependency information for Make.
820 * Assembler Options:: Passing options to the assembler.
821 * Link Options:: Specifying libraries and so on.
822 * Directory Options:: Where to find header files and libraries.
823 Where to find the compiler executable files.
824 * Spec Files:: How to pass switches to sub-processes.
825 * Target Options:: Running a cross-compiler, or an old version of GCC.
826 @end menu
827
828 @node Overall Options
829 @section Options Controlling the Kind of Output
830
831 Compilation can involve up to four stages: preprocessing, compilation
832 proper, assembly and linking, always in that order. GCC is capable of
833 preprocessing and compiling several files either into several
834 assembler input files, or into one assembler input file; then each
835 assembler input file produces an object file, and linking combines all
836 the object files (those newly compiled, and those specified as input)
837 into an executable file.
838
839 @cindex file name suffix
840 For any given input file, the file name suffix determines what kind of
841 compilation is done:
842
843 @table @gcctabopt
844 @item @var{file}.c
845 C source code which must be preprocessed.
846
847 @item @var{file}.i
848 C source code which should not be preprocessed.
849
850 @item @var{file}.ii
851 C++ source code which should not be preprocessed.
852
853 @item @var{file}.m
854 Objective-C source code. Note that you must link with the @file{libobjc}
855 library to make an Objective-C program work.
856
857 @item @var{file}.mi
858 Objective-C source code which should not be preprocessed.
859
860 @item @var{file}.mm
861 @itemx @var{file}.M
862 Objective-C++ source code. Note that you must link with the @file{libobjc}
863 library to make an Objective-C++ program work. Note that @samp{.M} refers
864 to a literal capital M@.
865
866 @item @var{file}.mii
867 Objective-C++ source code which should not be preprocessed.
868
869 @item @var{file}.h
870 C, C++, Objective-C or Objective-C++ header file to be turned into a
871 precompiled header.
872
873 @item @var{file}.cc
874 @itemx @var{file}.cp
875 @itemx @var{file}.cxx
876 @itemx @var{file}.cpp
877 @itemx @var{file}.CPP
878 @itemx @var{file}.c++
879 @itemx @var{file}.C
880 C++ source code which must be preprocessed. Note that in @samp{.cxx},
881 the last two letters must both be literally @samp{x}. Likewise,
882 @samp{.C} refers to a literal capital C@.
883
884 @item @var{file}.mm
885 @itemx @var{file}.M
886 Objective-C++ source code which must be preprocessed.
887
888 @item @var{file}.mii
889 Objective-C++ source code which should not be preprocessed.
890
891 @item @var{file}.hh
892 @itemx @var{file}.H
893 C++ header file to be turned into a precompiled header.
894
895 @item @var{file}.f
896 @itemx @var{file}.for
897 @itemx @var{file}.FOR
898 Fixed form Fortran source code which should not be preprocessed.
899
900 @item @var{file}.F
901 @itemx @var{file}.fpp
902 @itemx @var{file}.FPP
903 Fixed form Fortran source code which must be preprocessed (with the traditional
904 preprocessor).
905
906 @item @var{file}.f90
907 @itemx @var{file}.f95
908 Free form Fortran source code which should not be preprocessed.
909
910 @item @var{file}.F90
911 @itemx @var{file}.F95
912 Free form Fortran source code which must be preprocessed (with the
913 traditional preprocessor).
914
915 @c FIXME: Descriptions of Java file types.
916 @c @var{file}.java
917 @c @var{file}.class
918 @c @var{file}.zip
919 @c @var{file}.jar
920
921 @item @var{file}.ads
922 Ada source code file which contains a library unit declaration (a
923 declaration of a package, subprogram, or generic, or a generic
924 instantiation), or a library unit renaming declaration (a package,
925 generic, or subprogram renaming declaration). Such files are also
926 called @dfn{specs}.
927
928 @itemx @var{file}.adb
929 Ada source code file containing a library unit body (a subprogram or
930 package body). Such files are also called @dfn{bodies}.
931
932 @c GCC also knows about some suffixes for languages not yet included:
933 @c Pascal:
934 @c @var{file}.p
935 @c @var{file}.pas
936 @c Ratfor:
937 @c @var{file}.r
938
939 @item @var{file}.s
940 Assembler code.
941
942 @item @var{file}.S
943 Assembler code which must be preprocessed.
944
945 @item @var{other}
946 An object file to be fed straight into linking.
947 Any file name with no recognized suffix is treated this way.
948 @end table
949
950 @opindex x
951 You can specify the input language explicitly with the @option{-x} option:
952
953 @table @gcctabopt
954 @item -x @var{language}
955 Specify explicitly the @var{language} for the following input files
956 (rather than letting the compiler choose a default based on the file
957 name suffix). This option applies to all following input files until
958 the next @option{-x} option. Possible values for @var{language} are:
959 @smallexample
960 c c-header c-cpp-output
961 c++ c++-header c++-cpp-output
962 objective-c objective-c-header objective-c-cpp-output
963 objective-c++ objective-c++-header objective-c++-cpp-output
964 assembler assembler-with-cpp
965 ada
966 f95 f95-cpp-input
967 java
968 treelang
969 @end smallexample
970
971 @item -x none
972 Turn off any specification of a language, so that subsequent files are
973 handled according to their file name suffixes (as they are if @option{-x}
974 has not been used at all).
975
976 @item -pass-exit-codes
977 @opindex pass-exit-codes
978 Normally the @command{gcc} program will exit with the code of 1 if any
979 phase of the compiler returns a non-success return code. If you specify
980 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
981 numerically highest error produced by any phase that returned an error
982 indication. The C, C++, and Fortran frontends return 4, if an internal
983 compiler error is encountered.
984 @end table
985
986 If you only want some of the stages of compilation, you can use
987 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
988 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
989 @command{gcc} is to stop. Note that some combinations (for example,
990 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
991
992 @table @gcctabopt
993 @item -c
994 @opindex c
995 Compile or assemble the source files, but do not link. The linking
996 stage simply is not done. The ultimate output is in the form of an
997 object file for each source file.
998
999 By default, the object file name for a source file is made by replacing
1000 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1001
1002 Unrecognized input files, not requiring compilation or assembly, are
1003 ignored.
1004
1005 @item -S
1006 @opindex S
1007 Stop after the stage of compilation proper; do not assemble. The output
1008 is in the form of an assembler code file for each non-assembler input
1009 file specified.
1010
1011 By default, the assembler file name for a source file is made by
1012 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1013
1014 Input files that don't require compilation are ignored.
1015
1016 @item -E
1017 @opindex E
1018 Stop after the preprocessing stage; do not run the compiler proper. The
1019 output is in the form of preprocessed source code, which is sent to the
1020 standard output.
1021
1022 Input files which don't require preprocessing are ignored.
1023
1024 @cindex output file option
1025 @item -o @var{file}
1026 @opindex o
1027 Place output in file @var{file}. This applies regardless to whatever
1028 sort of output is being produced, whether it be an executable file,
1029 an object file, an assembler file or preprocessed C code.
1030
1031 If @option{-o} is not specified, the default is to put an executable
1032 file in @file{a.out}, the object file for
1033 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1034 assembler file in @file{@var{source}.s}, a precompiled header file in
1035 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1036 standard output.
1037
1038 @item -v
1039 @opindex v
1040 Print (on standard error output) the commands executed to run the stages
1041 of compilation. Also print the version number of the compiler driver
1042 program and of the preprocessor and the compiler proper.
1043
1044 @item -###
1045 @opindex ###
1046 Like @option{-v} except the commands are not executed and all command
1047 arguments are quoted. This is useful for shell scripts to capture the
1048 driver-generated command lines.
1049
1050 @item -pipe
1051 @opindex pipe
1052 Use pipes rather than temporary files for communication between the
1053 various stages of compilation. This fails to work on some systems where
1054 the assembler is unable to read from a pipe; but the GNU assembler has
1055 no trouble.
1056
1057 @item -combine
1058 @opindex combine
1059 If you are compiling multiple source files, this option tells the driver
1060 to pass all the source files to the compiler at once (for those
1061 languages for which the compiler can handle this). This will allow
1062 intermodule analysis (IMA) to be performed by the compiler. Currently the only
1063 language for which this is supported is C@. If you pass source files for
1064 multiple languages to the driver, using this option, the driver will invoke
1065 the compiler(s) that support IMA once each, passing each compiler all the
1066 source files appropriate for it. For those languages that do not support
1067 IMA this option will be ignored, and the compiler will be invoked once for
1068 each source file in that language. If you use this option in conjunction
1069 with @option{-save-temps}, the compiler will generate multiple
1070 pre-processed files
1071 (one for each source file), but only one (combined) @file{.o} or
1072 @file{.s} file.
1073
1074 @item --help
1075 @opindex help
1076 Print (on the standard output) a description of the command line options
1077 understood by @command{gcc}. If the @option{-v} option is also specified
1078 then @option{--help} will also be passed on to the various processes
1079 invoked by @command{gcc}, so that they can display the command line options
1080 they accept. If the @option{-Wextra} option is also specified then command
1081 line options which have no documentation associated with them will also
1082 be displayed.
1083
1084 @item --target-help
1085 @opindex target-help
1086 Print (on the standard output) a description of target specific command
1087 line options for each tool.
1088
1089 @item --version
1090 @opindex version
1091 Display the version number and copyrights of the invoked GCC@.
1092
1093 @include @value{srcdir}/../libiberty/at-file.texi
1094 @end table
1095
1096 @node Invoking G++
1097 @section Compiling C++ Programs
1098
1099 @cindex suffixes for C++ source
1100 @cindex C++ source file suffixes
1101 C++ source files conventionally use one of the suffixes @samp{.C},
1102 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1103 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1104 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1105 files with these names and compiles them as C++ programs even if you
1106 call the compiler the same way as for compiling C programs (usually
1107 with the name @command{gcc}).
1108
1109 @findex g++
1110 @findex c++
1111 However, the use of @command{gcc} does not add the C++ library.
1112 @command{g++} is a program that calls GCC and treats @samp{.c},
1113 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1114 files unless @option{-x} is used, and automatically specifies linking
1115 against the C++ library. This program is also useful when
1116 precompiling a C header file with a @samp{.h} extension for use in C++
1117 compilations. On many systems, @command{g++} is also installed with
1118 the name @command{c++}.
1119
1120 @cindex invoking @command{g++}
1121 When you compile C++ programs, you may specify many of the same
1122 command-line options that you use for compiling programs in any
1123 language; or command-line options meaningful for C and related
1124 languages; or options that are meaningful only for C++ programs.
1125 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1126 explanations of options for languages related to C@.
1127 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1128 explanations of options that are meaningful only for C++ programs.
1129
1130 @node C Dialect Options
1131 @section Options Controlling C Dialect
1132 @cindex dialect options
1133 @cindex language dialect options
1134 @cindex options, dialect
1135
1136 The following options control the dialect of C (or languages derived
1137 from C, such as C++, Objective-C and Objective-C++) that the compiler
1138 accepts:
1139
1140 @table @gcctabopt
1141 @cindex ANSI support
1142 @cindex ISO support
1143 @item -ansi
1144 @opindex ansi
1145 In C mode, support all ISO C90 programs. In C++ mode,
1146 remove GNU extensions that conflict with ISO C++.
1147
1148 This turns off certain features of GCC that are incompatible with ISO
1149 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1150 such as the @code{asm} and @code{typeof} keywords, and
1151 predefined macros such as @code{unix} and @code{vax} that identify the
1152 type of system you are using. It also enables the undesirable and
1153 rarely used ISO trigraph feature. For the C compiler,
1154 it disables recognition of C++ style @samp{//} comments as well as
1155 the @code{inline} keyword.
1156
1157 The alternate keywords @code{__asm__}, @code{__extension__},
1158 @code{__inline__} and @code{__typeof__} continue to work despite
1159 @option{-ansi}. You would not want to use them in an ISO C program, of
1160 course, but it is useful to put them in header files that might be included
1161 in compilations done with @option{-ansi}. Alternate predefined macros
1162 such as @code{__unix__} and @code{__vax__} are also available, with or
1163 without @option{-ansi}.
1164
1165 The @option{-ansi} option does not cause non-ISO programs to be
1166 rejected gratuitously. For that, @option{-pedantic} is required in
1167 addition to @option{-ansi}. @xref{Warning Options}.
1168
1169 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1170 option is used. Some header files may notice this macro and refrain
1171 from declaring certain functions or defining certain macros that the
1172 ISO standard doesn't call for; this is to avoid interfering with any
1173 programs that might use these names for other things.
1174
1175 Functions which would normally be built in but do not have semantics
1176 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1177 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1178 built-in functions provided by GCC}, for details of the functions
1179 affected.
1180
1181 @item -std=
1182 @opindex std
1183 Determine the language standard. This option is currently only
1184 supported when compiling C or C++. A value for this option must be
1185 provided; possible values are
1186
1187 @table @samp
1188 @item c89
1189 @itemx iso9899:1990
1190 ISO C90 (same as @option{-ansi}).
1191
1192 @item iso9899:199409
1193 ISO C90 as modified in amendment 1.
1194
1195 @item c99
1196 @itemx c9x
1197 @itemx iso9899:1999
1198 @itemx iso9899:199x
1199 ISO C99. Note that this standard is not yet fully supported; see
1200 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1201 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1202
1203 @item gnu89
1204 Default, ISO C90 plus GNU extensions (including some C99 features).
1205
1206 @item gnu99
1207 @itemx gnu9x
1208 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1209 this will become the default. The name @samp{gnu9x} is deprecated.
1210
1211 @item c++98
1212 The 1998 ISO C++ standard plus amendments.
1213
1214 @item gnu++98
1215 The same as @option{-std=c++98} plus GNU extensions. This is the
1216 default for C++ code.
1217
1218 @item c++0x
1219 The working draft of the upcoming ISO C++0x standard. This option
1220 enables experimental features that are likely to be included in
1221 C++0x. The working draft is constantly changing, and any feature that is
1222 enabled by this flag may be removed from future versions of GCC if it is
1223 not part of the C++0x standard.
1224
1225 @item gnu++0x
1226 The same as @option{-std=c++0x} plus GNU extensions. As with
1227 @option{-std=c++0x}, this option enables experimental features that may
1228 be removed in future versions of GCC.
1229 @end table
1230
1231 Even when this option is not specified, you can still use some of the
1232 features of newer standards in so far as they do not conflict with
1233 previous C standards. For example, you may use @code{__restrict__} even
1234 when @option{-std=c99} is not specified.
1235
1236 The @option{-std} options specifying some version of ISO C have the same
1237 effects as @option{-ansi}, except that features that were not in ISO C90
1238 but are in the specified version (for example, @samp{//} comments and
1239 the @code{inline} keyword in ISO C99) are not disabled.
1240
1241 @xref{Standards,,Language Standards Supported by GCC}, for details of
1242 these standard versions.
1243
1244 @item -aux-info @var{filename}
1245 @opindex aux-info
1246 Output to the given filename prototyped declarations for all functions
1247 declared and/or defined in a translation unit, including those in header
1248 files. This option is silently ignored in any language other than C@.
1249
1250 Besides declarations, the file indicates, in comments, the origin of
1251 each declaration (source file and line), whether the declaration was
1252 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1253 @samp{O} for old, respectively, in the first character after the line
1254 number and the colon), and whether it came from a declaration or a
1255 definition (@samp{C} or @samp{F}, respectively, in the following
1256 character). In the case of function definitions, a K&R-style list of
1257 arguments followed by their declarations is also provided, inside
1258 comments, after the declaration.
1259
1260 @item -fno-asm
1261 @opindex fno-asm
1262 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1263 keyword, so that code can use these words as identifiers. You can use
1264 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1265 instead. @option{-ansi} implies @option{-fno-asm}.
1266
1267 In C++, this switch only affects the @code{typeof} keyword, since
1268 @code{asm} and @code{inline} are standard keywords. You may want to
1269 use the @option{-fno-gnu-keywords} flag instead, which has the same
1270 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1271 switch only affects the @code{asm} and @code{typeof} keywords, since
1272 @code{inline} is a standard keyword in ISO C99.
1273
1274 @item -fno-builtin
1275 @itemx -fno-builtin-@var{function}
1276 @opindex fno-builtin
1277 @cindex built-in functions
1278 Don't recognize built-in functions that do not begin with
1279 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1280 functions provided by GCC}, for details of the functions affected,
1281 including those which are not built-in functions when @option{-ansi} or
1282 @option{-std} options for strict ISO C conformance are used because they
1283 do not have an ISO standard meaning.
1284
1285 GCC normally generates special code to handle certain built-in functions
1286 more efficiently; for instance, calls to @code{alloca} may become single
1287 instructions that adjust the stack directly, and calls to @code{memcpy}
1288 may become inline copy loops. The resulting code is often both smaller
1289 and faster, but since the function calls no longer appear as such, you
1290 cannot set a breakpoint on those calls, nor can you change the behavior
1291 of the functions by linking with a different library. In addition,
1292 when a function is recognized as a built-in function, GCC may use
1293 information about that function to warn about problems with calls to
1294 that function, or to generate more efficient code, even if the
1295 resulting code still contains calls to that function. For example,
1296 warnings are given with @option{-Wformat} for bad calls to
1297 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1298 known not to modify global memory.
1299
1300 With the @option{-fno-builtin-@var{function}} option
1301 only the built-in function @var{function} is
1302 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1303 function is named this is not built-in in this version of GCC, this
1304 option is ignored. There is no corresponding
1305 @option{-fbuiltin-@var{function}} option; if you wish to enable
1306 built-in functions selectively when using @option{-fno-builtin} or
1307 @option{-ffreestanding}, you may define macros such as:
1308
1309 @smallexample
1310 #define abs(n) __builtin_abs ((n))
1311 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1312 @end smallexample
1313
1314 @item -fhosted
1315 @opindex fhosted
1316 @cindex hosted environment
1317
1318 Assert that compilation takes place in a hosted environment. This implies
1319 @option{-fbuiltin}. A hosted environment is one in which the
1320 entire standard library is available, and in which @code{main} has a return
1321 type of @code{int}. Examples are nearly everything except a kernel.
1322 This is equivalent to @option{-fno-freestanding}.
1323
1324 @item -ffreestanding
1325 @opindex ffreestanding
1326 @cindex hosted environment
1327
1328 Assert that compilation takes place in a freestanding environment. This
1329 implies @option{-fno-builtin}. A freestanding environment
1330 is one in which the standard library may not exist, and program startup may
1331 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1332 This is equivalent to @option{-fno-hosted}.
1333
1334 @xref{Standards,,Language Standards Supported by GCC}, for details of
1335 freestanding and hosted environments.
1336
1337 @item -fopenmp
1338 @opindex fopenmp
1339 @cindex openmp parallel
1340 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1341 @code{!$omp} in Fortran. When @option{-fopenmp} is specified, the
1342 compiler generates parallel code according to the OpenMP Application
1343 Program Interface v2.5 @w{@uref{http://www.openmp.org/}}.
1344
1345 @item -fms-extensions
1346 @opindex fms-extensions
1347 Accept some non-standard constructs used in Microsoft header files.
1348
1349 Some cases of unnamed fields in structures and unions are only
1350 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1351 fields within structs/unions}, for details.
1352
1353 @item -trigraphs
1354 @opindex trigraphs
1355 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1356 options for strict ISO C conformance) implies @option{-trigraphs}.
1357
1358 @item -no-integrated-cpp
1359 @opindex no-integrated-cpp
1360 Performs a compilation in two passes: preprocessing and compiling. This
1361 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1362 @option{-B} option. The user supplied compilation step can then add in
1363 an additional preprocessing step after normal preprocessing but before
1364 compiling. The default is to use the integrated cpp (internal cpp)
1365
1366 The semantics of this option will change if "cc1", "cc1plus", and
1367 "cc1obj" are merged.
1368
1369 @cindex traditional C language
1370 @cindex C language, traditional
1371 @item -traditional
1372 @itemx -traditional-cpp
1373 @opindex traditional-cpp
1374 @opindex traditional
1375 Formerly, these options caused GCC to attempt to emulate a pre-standard
1376 C compiler. They are now only supported with the @option{-E} switch.
1377 The preprocessor continues to support a pre-standard mode. See the GNU
1378 CPP manual for details.
1379
1380 @item -fcond-mismatch
1381 @opindex fcond-mismatch
1382 Allow conditional expressions with mismatched types in the second and
1383 third arguments. The value of such an expression is void. This option
1384 is not supported for C++.
1385
1386 @item -flax-vector-conversions
1387 @opindex flax-vector-conversions
1388 Allow implicit conversions between vectors with differing numbers of
1389 elements and/or incompatible element types. This option should not be
1390 used for new code.
1391
1392 @item -funsigned-char
1393 @opindex funsigned-char
1394 Let the type @code{char} be unsigned, like @code{unsigned char}.
1395
1396 Each kind of machine has a default for what @code{char} should
1397 be. It is either like @code{unsigned char} by default or like
1398 @code{signed char} by default.
1399
1400 Ideally, a portable program should always use @code{signed char} or
1401 @code{unsigned char} when it depends on the signedness of an object.
1402 But many programs have been written to use plain @code{char} and
1403 expect it to be signed, or expect it to be unsigned, depending on the
1404 machines they were written for. This option, and its inverse, let you
1405 make such a program work with the opposite default.
1406
1407 The type @code{char} is always a distinct type from each of
1408 @code{signed char} or @code{unsigned char}, even though its behavior
1409 is always just like one of those two.
1410
1411 @item -fsigned-char
1412 @opindex fsigned-char
1413 Let the type @code{char} be signed, like @code{signed char}.
1414
1415 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1416 the negative form of @option{-funsigned-char}. Likewise, the option
1417 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1418
1419 @item -fsigned-bitfields
1420 @itemx -funsigned-bitfields
1421 @itemx -fno-signed-bitfields
1422 @itemx -fno-unsigned-bitfields
1423 @opindex fsigned-bitfields
1424 @opindex funsigned-bitfields
1425 @opindex fno-signed-bitfields
1426 @opindex fno-unsigned-bitfields
1427 These options control whether a bit-field is signed or unsigned, when the
1428 declaration does not use either @code{signed} or @code{unsigned}. By
1429 default, such a bit-field is signed, because this is consistent: the
1430 basic integer types such as @code{int} are signed types.
1431 @end table
1432
1433 @node C++ Dialect Options
1434 @section Options Controlling C++ Dialect
1435
1436 @cindex compiler options, C++
1437 @cindex C++ options, command line
1438 @cindex options, C++
1439 This section describes the command-line options that are only meaningful
1440 for C++ programs; but you can also use most of the GNU compiler options
1441 regardless of what language your program is in. For example, you
1442 might compile a file @code{firstClass.C} like this:
1443
1444 @smallexample
1445 g++ -g -frepo -O -c firstClass.C
1446 @end smallexample
1447
1448 @noindent
1449 In this example, only @option{-frepo} is an option meant
1450 only for C++ programs; you can use the other options with any
1451 language supported by GCC@.
1452
1453 Here is a list of options that are @emph{only} for compiling C++ programs:
1454
1455 @table @gcctabopt
1456
1457 @item -fabi-version=@var{n}
1458 @opindex fabi-version
1459 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1460 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1461 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1462 the version that conforms most closely to the C++ ABI specification.
1463 Therefore, the ABI obtained using version 0 will change as ABI bugs
1464 are fixed.
1465
1466 The default is version 2.
1467
1468 @item -fno-access-control
1469 @opindex fno-access-control
1470 Turn off all access checking. This switch is mainly useful for working
1471 around bugs in the access control code.
1472
1473 @item -fcheck-new
1474 @opindex fcheck-new
1475 Check that the pointer returned by @code{operator new} is non-null
1476 before attempting to modify the storage allocated. This check is
1477 normally unnecessary because the C++ standard specifies that
1478 @code{operator new} will only return @code{0} if it is declared
1479 @samp{throw()}, in which case the compiler will always check the
1480 return value even without this option. In all other cases, when
1481 @code{operator new} has a non-empty exception specification, memory
1482 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1483 @samp{new (nothrow)}.
1484
1485 @item -fconserve-space
1486 @opindex fconserve-space
1487 Put uninitialized or runtime-initialized global variables into the
1488 common segment, as C does. This saves space in the executable at the
1489 cost of not diagnosing duplicate definitions. If you compile with this
1490 flag and your program mysteriously crashes after @code{main()} has
1491 completed, you may have an object that is being destroyed twice because
1492 two definitions were merged.
1493
1494 This option is no longer useful on most targets, now that support has
1495 been added for putting variables into BSS without making them common.
1496
1497 @item -ffriend-injection
1498 @opindex ffriend-injection
1499 Inject friend functions into the enclosing namespace, so that they are
1500 visible outside the scope of the class in which they are declared.
1501 Friend functions were documented to work this way in the old Annotated
1502 C++ Reference Manual, and versions of G++ before 4.1 always worked
1503 that way. However, in ISO C++ a friend function which is not declared
1504 in an enclosing scope can only be found using argument dependent
1505 lookup. This option causes friends to be injected as they were in
1506 earlier releases.
1507
1508 This option is for compatibility, and may be removed in a future
1509 release of G++.
1510
1511 @item -fno-elide-constructors
1512 @opindex fno-elide-constructors
1513 The C++ standard allows an implementation to omit creating a temporary
1514 which is only used to initialize another object of the same type.
1515 Specifying this option disables that optimization, and forces G++ to
1516 call the copy constructor in all cases.
1517
1518 @item -fno-enforce-eh-specs
1519 @opindex fno-enforce-eh-specs
1520 Don't generate code to check for violation of exception specifications
1521 at runtime. This option violates the C++ standard, but may be useful
1522 for reducing code size in production builds, much like defining
1523 @samp{NDEBUG}. This does not give user code permission to throw
1524 exceptions in violation of the exception specifications; the compiler
1525 will still optimize based on the specifications, so throwing an
1526 unexpected exception will result in undefined behavior.
1527
1528 @item -ffor-scope
1529 @itemx -fno-for-scope
1530 @opindex ffor-scope
1531 @opindex fno-for-scope
1532 If @option{-ffor-scope} is specified, the scope of variables declared in
1533 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1534 as specified by the C++ standard.
1535 If @option{-fno-for-scope} is specified, the scope of variables declared in
1536 a @i{for-init-statement} extends to the end of the enclosing scope,
1537 as was the case in old versions of G++, and other (traditional)
1538 implementations of C++.
1539
1540 The default if neither flag is given to follow the standard,
1541 but to allow and give a warning for old-style code that would
1542 otherwise be invalid, or have different behavior.
1543
1544 @item -fno-gnu-keywords
1545 @opindex fno-gnu-keywords
1546 Do not recognize @code{typeof} as a keyword, so that code can use this
1547 word as an identifier. You can use the keyword @code{__typeof__} instead.
1548 @option{-ansi} implies @option{-fno-gnu-keywords}.
1549
1550 @item -fno-implicit-templates
1551 @opindex fno-implicit-templates
1552 Never emit code for non-inline templates which are instantiated
1553 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1554 @xref{Template Instantiation}, for more information.
1555
1556 @item -fno-implicit-inline-templates
1557 @opindex fno-implicit-inline-templates
1558 Don't emit code for implicit instantiations of inline templates, either.
1559 The default is to handle inlines differently so that compiles with and
1560 without optimization will need the same set of explicit instantiations.
1561
1562 @item -fno-implement-inlines
1563 @opindex fno-implement-inlines
1564 To save space, do not emit out-of-line copies of inline functions
1565 controlled by @samp{#pragma implementation}. This will cause linker
1566 errors if these functions are not inlined everywhere they are called.
1567
1568 @item -fms-extensions
1569 @opindex fms-extensions
1570 Disable pedantic warnings about constructs used in MFC, such as implicit
1571 int and getting a pointer to member function via non-standard syntax.
1572
1573 @item -fno-nonansi-builtins
1574 @opindex fno-nonansi-builtins
1575 Disable built-in declarations of functions that are not mandated by
1576 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1577 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1578
1579 @item -fno-operator-names
1580 @opindex fno-operator-names
1581 Do not treat the operator name keywords @code{and}, @code{bitand},
1582 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1583 synonyms as keywords.
1584
1585 @item -fno-optional-diags
1586 @opindex fno-optional-diags
1587 Disable diagnostics that the standard says a compiler does not need to
1588 issue. Currently, the only such diagnostic issued by G++ is the one for
1589 a name having multiple meanings within a class.
1590
1591 @item -fpermissive
1592 @opindex fpermissive
1593 Downgrade some diagnostics about nonconformant code from errors to
1594 warnings. Thus, using @option{-fpermissive} will allow some
1595 nonconforming code to compile.
1596
1597 @item -frepo
1598 @opindex frepo
1599 Enable automatic template instantiation at link time. This option also
1600 implies @option{-fno-implicit-templates}. @xref{Template
1601 Instantiation}, for more information.
1602
1603 @item -fno-rtti
1604 @opindex fno-rtti
1605 Disable generation of information about every class with virtual
1606 functions for use by the C++ runtime type identification features
1607 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1608 of the language, you can save some space by using this flag. Note that
1609 exception handling uses the same information, but it will generate it as
1610 needed. The @samp{dynamic_cast} operator can still be used for casts that
1611 do not require runtime type information, i.e. casts to @code{void *} or to
1612 unambiguous base classes.
1613
1614 @item -fstats
1615 @opindex fstats
1616 Emit statistics about front-end processing at the end of the compilation.
1617 This information is generally only useful to the G++ development team.
1618
1619 @item -ftemplate-depth-@var{n}
1620 @opindex ftemplate-depth
1621 Set the maximum instantiation depth for template classes to @var{n}.
1622 A limit on the template instantiation depth is needed to detect
1623 endless recursions during template class instantiation. ANSI/ISO C++
1624 conforming programs must not rely on a maximum depth greater than 17.
1625
1626 @item -fno-threadsafe-statics
1627 @opindex fno-threadsafe-statics
1628 Do not emit the extra code to use the routines specified in the C++
1629 ABI for thread-safe initialization of local statics. You can use this
1630 option to reduce code size slightly in code that doesn't need to be
1631 thread-safe.
1632
1633 @item -fuse-cxa-atexit
1634 @opindex fuse-cxa-atexit
1635 Register destructors for objects with static storage duration with the
1636 @code{__cxa_atexit} function rather than the @code{atexit} function.
1637 This option is required for fully standards-compliant handling of static
1638 destructors, but will only work if your C library supports
1639 @code{__cxa_atexit}.
1640
1641 @item -fno-use-cxa-get-exception-ptr
1642 @opindex fno-use-cxa-get-exception-ptr
1643 Don't use the @code{__cxa_get_exception_ptr} runtime routine. This
1644 will cause @code{std::uncaught_exception} to be incorrect, but is necessary
1645 if the runtime routine is not available.
1646
1647 @item -fvisibility-inlines-hidden
1648 @opindex fvisibility-inlines-hidden
1649 This switch declares that the user does not attempt to compare
1650 pointers to inline methods where the addresses of the two functions
1651 were taken in different shared objects.
1652
1653 The effect of this is that GCC may, effectively, mark inline methods with
1654 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1655 appear in the export table of a DSO and do not require a PLT indirection
1656 when used within the DSO@. Enabling this option can have a dramatic effect
1657 on load and link times of a DSO as it massively reduces the size of the
1658 dynamic export table when the library makes heavy use of templates.
1659
1660 The behaviour of this switch is not quite the same as marking the
1661 methods as hidden directly, because it does not affect static variables
1662 local to the function or cause the compiler to deduce that
1663 the function is defined in only one shared object.
1664
1665 You may mark a method as having a visibility explicitly to negate the
1666 effect of the switch for that method. For example, if you do want to
1667 compare pointers to a particular inline method, you might mark it as
1668 having default visibility. Marking the enclosing class with explicit
1669 visibility will have no effect.
1670
1671 Explicitly instantiated inline methods are unaffected by this option
1672 as their linkage might otherwise cross a shared library boundary.
1673 @xref{Template Instantiation}.
1674
1675 @item -fno-weak
1676 @opindex fno-weak
1677 Do not use weak symbol support, even if it is provided by the linker.
1678 By default, G++ will use weak symbols if they are available. This
1679 option exists only for testing, and should not be used by end-users;
1680 it will result in inferior code and has no benefits. This option may
1681 be removed in a future release of G++.
1682
1683 @item -nostdinc++
1684 @opindex nostdinc++
1685 Do not search for header files in the standard directories specific to
1686 C++, but do still search the other standard directories. (This option
1687 is used when building the C++ library.)
1688 @end table
1689
1690 In addition, these optimization, warning, and code generation options
1691 have meanings only for C++ programs:
1692
1693 @table @gcctabopt
1694 @item -fno-default-inline
1695 @opindex fno-default-inline
1696 Do not assume @samp{inline} for functions defined inside a class scope.
1697 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1698 functions will have linkage like inline functions; they just won't be
1699 inlined by default.
1700
1701 @item -Wabi @r{(C++ only)}
1702 @opindex Wabi
1703 Warn when G++ generates code that is probably not compatible with the
1704 vendor-neutral C++ ABI@. Although an effort has been made to warn about
1705 all such cases, there are probably some cases that are not warned about,
1706 even though G++ is generating incompatible code. There may also be
1707 cases where warnings are emitted even though the code that is generated
1708 will be compatible.
1709
1710 You should rewrite your code to avoid these warnings if you are
1711 concerned about the fact that code generated by G++ may not be binary
1712 compatible with code generated by other compilers.
1713
1714 The known incompatibilities at this point include:
1715
1716 @itemize @bullet
1717
1718 @item
1719 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1720 pack data into the same byte as a base class. For example:
1721
1722 @smallexample
1723 struct A @{ virtual void f(); int f1 : 1; @};
1724 struct B : public A @{ int f2 : 1; @};
1725 @end smallexample
1726
1727 @noindent
1728 In this case, G++ will place @code{B::f2} into the same byte
1729 as@code{A::f1}; other compilers will not. You can avoid this problem
1730 by explicitly padding @code{A} so that its size is a multiple of the
1731 byte size on your platform; that will cause G++ and other compilers to
1732 layout @code{B} identically.
1733
1734 @item
1735 Incorrect handling of tail-padding for virtual bases. G++ does not use
1736 tail padding when laying out virtual bases. For example:
1737
1738 @smallexample
1739 struct A @{ virtual void f(); char c1; @};
1740 struct B @{ B(); char c2; @};
1741 struct C : public A, public virtual B @{@};
1742 @end smallexample
1743
1744 @noindent
1745 In this case, G++ will not place @code{B} into the tail-padding for
1746 @code{A}; other compilers will. You can avoid this problem by
1747 explicitly padding @code{A} so that its size is a multiple of its
1748 alignment (ignoring virtual base classes); that will cause G++ and other
1749 compilers to layout @code{C} identically.
1750
1751 @item
1752 Incorrect handling of bit-fields with declared widths greater than that
1753 of their underlying types, when the bit-fields appear in a union. For
1754 example:
1755
1756 @smallexample
1757 union U @{ int i : 4096; @};
1758 @end smallexample
1759
1760 @noindent
1761 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1762 union too small by the number of bits in an @code{int}.
1763
1764 @item
1765 Empty classes can be placed at incorrect offsets. For example:
1766
1767 @smallexample
1768 struct A @{@};
1769
1770 struct B @{
1771 A a;
1772 virtual void f ();
1773 @};
1774
1775 struct C : public B, public A @{@};
1776 @end smallexample
1777
1778 @noindent
1779 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1780 it should be placed at offset zero. G++ mistakenly believes that the
1781 @code{A} data member of @code{B} is already at offset zero.
1782
1783 @item
1784 Names of template functions whose types involve @code{typename} or
1785 template template parameters can be mangled incorrectly.
1786
1787 @smallexample
1788 template <typename Q>
1789 void f(typename Q::X) @{@}
1790
1791 template <template <typename> class Q>
1792 void f(typename Q<int>::X) @{@}
1793 @end smallexample
1794
1795 @noindent
1796 Instantiations of these templates may be mangled incorrectly.
1797
1798 @end itemize
1799
1800 @item -Wctor-dtor-privacy @r{(C++ only)}
1801 @opindex Wctor-dtor-privacy
1802 Warn when a class seems unusable because all the constructors or
1803 destructors in that class are private, and it has neither friends nor
1804 public static member functions.
1805
1806 @item -Wnon-virtual-dtor @r{(C++ only)}
1807 @opindex Wnon-virtual-dtor
1808 Warn when a class appears to be polymorphic, thereby requiring a virtual
1809 destructor, yet it declares a non-virtual one. This warning is also
1810 enabled if -Weffc++ is specified.
1811
1812 @item -Wreorder @r{(C++ only)}
1813 @opindex Wreorder
1814 @cindex reordering, warning
1815 @cindex warning for reordering of member initializers
1816 Warn when the order of member initializers given in the code does not
1817 match the order in which they must be executed. For instance:
1818
1819 @smallexample
1820 struct A @{
1821 int i;
1822 int j;
1823 A(): j (0), i (1) @{ @}
1824 @};
1825 @end smallexample
1826
1827 The compiler will rearrange the member initializers for @samp{i}
1828 and @samp{j} to match the declaration order of the members, emitting
1829 a warning to that effect. This warning is enabled by @option{-Wall}.
1830 @end table
1831
1832 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1833
1834 @table @gcctabopt
1835 @item -Weffc++ @r{(C++ only)}
1836 @opindex Weffc++
1837 Warn about violations of the following style guidelines from Scott Meyers'
1838 @cite{Effective C++} book:
1839
1840 @itemize @bullet
1841 @item
1842 Item 11: Define a copy constructor and an assignment operator for classes
1843 with dynamically allocated memory.
1844
1845 @item
1846 Item 12: Prefer initialization to assignment in constructors.
1847
1848 @item
1849 Item 14: Make destructors virtual in base classes.
1850
1851 @item
1852 Item 15: Have @code{operator=} return a reference to @code{*this}.
1853
1854 @item
1855 Item 23: Don't try to return a reference when you must return an object.
1856
1857 @end itemize
1858
1859 Also warn about violations of the following style guidelines from
1860 Scott Meyers' @cite{More Effective C++} book:
1861
1862 @itemize @bullet
1863 @item
1864 Item 6: Distinguish between prefix and postfix forms of increment and
1865 decrement operators.
1866
1867 @item
1868 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1869
1870 @end itemize
1871
1872 When selecting this option, be aware that the standard library
1873 headers do not obey all of these guidelines; use @samp{grep -v}
1874 to filter out those warnings.
1875
1876 @item -Wno-deprecated @r{(C++ only)}
1877 @opindex Wno-deprecated
1878 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1879
1880 @item -Wstrict-null-sentinel @r{(C++ only)}
1881 @opindex Wstrict-null-sentinel
1882 Warn also about the use of an uncasted @code{NULL} as sentinel. When
1883 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1884 to @code{__null}. Although it is a null pointer constant not a null pointer,
1885 it is guaranteed to of the same size as a pointer. But this use is
1886 not portable across different compilers.
1887
1888 @item -Wno-non-template-friend @r{(C++ only)}
1889 @opindex Wno-non-template-friend
1890 Disable warnings when non-templatized friend functions are declared
1891 within a template. Since the advent of explicit template specification
1892 support in G++, if the name of the friend is an unqualified-id (i.e.,
1893 @samp{friend foo(int)}), the C++ language specification demands that the
1894 friend declare or define an ordinary, nontemplate function. (Section
1895 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1896 could be interpreted as a particular specialization of a templatized
1897 function. Because this non-conforming behavior is no longer the default
1898 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1899 check existing code for potential trouble spots and is on by default.
1900 This new compiler behavior can be turned off with
1901 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1902 but disables the helpful warning.
1903
1904 @item -Wold-style-cast @r{(C++ only)}
1905 @opindex Wold-style-cast
1906 Warn if an old-style (C-style) cast to a non-void type is used within
1907 a C++ program. The new-style casts (@samp{dynamic_cast},
1908 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
1909 less vulnerable to unintended effects and much easier to search for.
1910
1911 @item -Woverloaded-virtual @r{(C++ only)}
1912 @opindex Woverloaded-virtual
1913 @cindex overloaded virtual fn, warning
1914 @cindex warning for overloaded virtual fn
1915 Warn when a function declaration hides virtual functions from a
1916 base class. For example, in:
1917
1918 @smallexample
1919 struct A @{
1920 virtual void f();
1921 @};
1922
1923 struct B: public A @{
1924 void f(int);
1925 @};
1926 @end smallexample
1927
1928 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1929 like:
1930
1931 @smallexample
1932 B* b;
1933 b->f();
1934 @end smallexample
1935
1936 will fail to compile.
1937
1938 @item -Wno-pmf-conversions @r{(C++ only)}
1939 @opindex Wno-pmf-conversions
1940 Disable the diagnostic for converting a bound pointer to member function
1941 to a plain pointer.
1942
1943 @item -Wsign-promo @r{(C++ only)}
1944 @opindex Wsign-promo
1945 Warn when overload resolution chooses a promotion from unsigned or
1946 enumerated type to a signed type, over a conversion to an unsigned type of
1947 the same size. Previous versions of G++ would try to preserve
1948 unsignedness, but the standard mandates the current behavior.
1949
1950 @smallexample
1951 struct A @{
1952 operator int ();
1953 A& operator = (int);
1954 @};
1955
1956 main ()
1957 @{
1958 A a,b;
1959 a = b;
1960 @}
1961 @end smallexample
1962
1963 In this example, G++ will synthesize a default @samp{A& operator =
1964 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1965 @end table
1966
1967 @node Objective-C and Objective-C++ Dialect Options
1968 @section Options Controlling Objective-C and Objective-C++ Dialects
1969
1970 @cindex compiler options, Objective-C and Objective-C++
1971 @cindex Objective-C and Objective-C++ options, command line
1972 @cindex options, Objective-C and Objective-C++
1973 (NOTE: This manual does not describe the Objective-C and Objective-C++
1974 languages themselves. See @xref{Standards,,Language Standards
1975 Supported by GCC}, for references.)
1976
1977 This section describes the command-line options that are only meaningful
1978 for Objective-C and Objective-C++ programs, but you can also use most of
1979 the language-independent GNU compiler options.
1980 For example, you might compile a file @code{some_class.m} like this:
1981
1982 @smallexample
1983 gcc -g -fgnu-runtime -O -c some_class.m
1984 @end smallexample
1985
1986 @noindent
1987 In this example, @option{-fgnu-runtime} is an option meant only for
1988 Objective-C and Objective-C++ programs; you can use the other options with
1989 any language supported by GCC@.
1990
1991 Note that since Objective-C is an extension of the C language, Objective-C
1992 compilations may also use options specific to the C front-end (e.g.,
1993 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1994 C++-specific options (e.g., @option{-Wabi}).
1995
1996 Here is a list of options that are @emph{only} for compiling Objective-C
1997 and Objective-C++ programs:
1998
1999 @table @gcctabopt
2000 @item -fconstant-string-class=@var{class-name}
2001 @opindex fconstant-string-class
2002 Use @var{class-name} as the name of the class to instantiate for each
2003 literal string specified with the syntax @code{@@"@dots{}"}. The default
2004 class name is @code{NXConstantString} if the GNU runtime is being used, and
2005 @code{NSConstantString} if the NeXT runtime is being used (see below). The
2006 @option{-fconstant-cfstrings} option, if also present, will override the
2007 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2008 to be laid out as constant CoreFoundation strings.
2009
2010 @item -fgnu-runtime
2011 @opindex fgnu-runtime
2012 Generate object code compatible with the standard GNU Objective-C
2013 runtime. This is the default for most types of systems.
2014
2015 @item -fnext-runtime
2016 @opindex fnext-runtime
2017 Generate output compatible with the NeXT runtime. This is the default
2018 for NeXT-based systems, including Darwin and Mac OS X@. The macro
2019 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2020 used.
2021
2022 @item -fno-nil-receivers
2023 @opindex fno-nil-receivers
2024 Assume that all Objective-C message dispatches (e.g.,
2025 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
2026 is not @code{nil}. This allows for more efficient entry points in the runtime
2027 to be used. Currently, this option is only available in conjunction with
2028 the NeXT runtime on Mac OS X 10.3 and later.
2029
2030 @item -fobjc-call-cxx-cdtors
2031 @opindex fobjc-call-cxx-cdtors
2032 For each Objective-C class, check if any of its instance variables is a
2033 C++ object with a non-trivial default constructor. If so, synthesize a
2034 special @code{- (id) .cxx_construct} instance method that will run
2035 non-trivial default constructors on any such instance variables, in order,
2036 and then return @code{self}. Similarly, check if any instance variable
2037 is a C++ object with a non-trivial destructor, and if so, synthesize a
2038 special @code{- (void) .cxx_destruct} method that will run
2039 all such default destructors, in reverse order.
2040
2041 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
2042 thusly generated will only operate on instance variables declared in the
2043 current Objective-C class, and not those inherited from superclasses. It
2044 is the responsibility of the Objective-C runtime to invoke all such methods
2045 in an object's inheritance hierarchy. The @code{- (id) .cxx_construct} methods
2046 will be invoked by the runtime immediately after a new object
2047 instance is allocated; the @code{- (void) .cxx_destruct} methods will
2048 be invoked immediately before the runtime deallocates an object instance.
2049
2050 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2051 support for invoking the @code{- (id) .cxx_construct} and
2052 @code{- (void) .cxx_destruct} methods.
2053
2054 @item -fobjc-direct-dispatch
2055 @opindex fobjc-direct-dispatch
2056 Allow fast jumps to the message dispatcher. On Darwin this is
2057 accomplished via the comm page.
2058
2059 @item -fobjc-exceptions
2060 @opindex fobjc-exceptions
2061 Enable syntactic support for structured exception handling in Objective-C,
2062 similar to what is offered by C++ and Java. This option is
2063 unavailable in conjunction with the NeXT runtime on Mac OS X 10.2 and
2064 earlier.
2065
2066 @smallexample
2067 @@try @{
2068 @dots{}
2069 @@throw expr;
2070 @dots{}
2071 @}
2072 @@catch (AnObjCClass *exc) @{
2073 @dots{}
2074 @@throw expr;
2075 @dots{}
2076 @@throw;
2077 @dots{}
2078 @}
2079 @@catch (AnotherClass *exc) @{
2080 @dots{}
2081 @}
2082 @@catch (id allOthers) @{
2083 @dots{}
2084 @}
2085 @@finally @{
2086 @dots{}
2087 @@throw expr;
2088 @dots{}
2089 @}
2090 @end smallexample
2091
2092 The @code{@@throw} statement may appear anywhere in an Objective-C or
2093 Objective-C++ program; when used inside of a @code{@@catch} block, the
2094 @code{@@throw} may appear without an argument (as shown above), in which case
2095 the object caught by the @code{@@catch} will be rethrown.
2096
2097 Note that only (pointers to) Objective-C objects may be thrown and
2098 caught using this scheme. When an object is thrown, it will be caught
2099 by the nearest @code{@@catch} clause capable of handling objects of that type,
2100 analogously to how @code{catch} blocks work in C++ and Java. A
2101 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
2102 any and all Objective-C exceptions not caught by previous @code{@@catch}
2103 clauses (if any).
2104
2105 The @code{@@finally} clause, if present, will be executed upon exit from the
2106 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
2107 regardless of whether any exceptions are thrown, caught or rethrown
2108 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
2109 of the @code{finally} clause in Java.
2110
2111 There are several caveats to using the new exception mechanism:
2112
2113 @itemize @bullet
2114 @item
2115 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2116 idioms provided by the @code{NSException} class, the new
2117 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2118 systems, due to additional functionality needed in the (NeXT) Objective-C
2119 runtime.
2120
2121 @item
2122 As mentioned above, the new exceptions do not support handling
2123 types other than Objective-C objects. Furthermore, when used from
2124 Objective-C++, the Objective-C exception model does not interoperate with C++
2125 exceptions at this time. This means you cannot @code{@@throw} an exception
2126 from Objective-C and @code{catch} it in C++, or vice versa
2127 (i.e., @code{throw @dots{} @@catch}).
2128 @end itemize
2129
2130 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2131 blocks for thread-safe execution:
2132
2133 @smallexample
2134 @@synchronized (ObjCClass *guard) @{
2135 @dots{}
2136 @}
2137 @end smallexample
2138
2139 Upon entering the @code{@@synchronized} block, a thread of execution shall
2140 first check whether a lock has been placed on the corresponding @code{guard}
2141 object by another thread. If it has, the current thread shall wait until
2142 the other thread relinquishes its lock. Once @code{guard} becomes available,
2143 the current thread will place its own lock on it, execute the code contained in
2144 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2145 making @code{guard} available to other threads).
2146
2147 Unlike Java, Objective-C does not allow for entire methods to be marked
2148 @code{@@synchronized}. Note that throwing exceptions out of
2149 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2150 to be unlocked properly.
2151
2152 @item -fobjc-gc
2153 @opindex fobjc-gc
2154 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2155
2156 @item -freplace-objc-classes
2157 @opindex freplace-objc-classes
2158 Emit a special marker instructing @command{ld(1)} not to statically link in
2159 the resulting object file, and allow @command{dyld(1)} to load it in at
2160 run time instead. This is used in conjunction with the Fix-and-Continue
2161 debugging mode, where the object file in question may be recompiled and
2162 dynamically reloaded in the course of program execution, without the need
2163 to restart the program itself. Currently, Fix-and-Continue functionality
2164 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2165 and later.
2166
2167 @item -fzero-link
2168 @opindex fzero-link
2169 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2170 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2171 compile time) with static class references that get initialized at load time,
2172 which improves run-time performance. Specifying the @option{-fzero-link} flag
2173 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2174 to be retained. This is useful in Zero-Link debugging mode, since it allows
2175 for individual class implementations to be modified during program execution.
2176
2177 @item -gen-decls
2178 @opindex gen-decls
2179 Dump interface declarations for all classes seen in the source file to a
2180 file named @file{@var{sourcename}.decl}.
2181
2182 @item -Wassign-intercept
2183 @opindex Wassign-intercept
2184 Warn whenever an Objective-C assignment is being intercepted by the
2185 garbage collector.
2186
2187 @item -Wno-protocol
2188 @opindex Wno-protocol
2189 If a class is declared to implement a protocol, a warning is issued for
2190 every method in the protocol that is not implemented by the class. The
2191 default behavior is to issue a warning for every method not explicitly
2192 implemented in the class, even if a method implementation is inherited
2193 from the superclass. If you use the @option{-Wno-protocol} option, then
2194 methods inherited from the superclass are considered to be implemented,
2195 and no warning is issued for them.
2196
2197 @item -Wselector
2198 @opindex Wselector
2199 Warn if multiple methods of different types for the same selector are
2200 found during compilation. The check is performed on the list of methods
2201 in the final stage of compilation. Additionally, a check is performed
2202 for each selector appearing in a @code{@@selector(@dots{})}
2203 expression, and a corresponding method for that selector has been found
2204 during compilation. Because these checks scan the method table only at
2205 the end of compilation, these warnings are not produced if the final
2206 stage of compilation is not reached, for example because an error is
2207 found during compilation, or because the @option{-fsyntax-only} option is
2208 being used.
2209
2210 @item -Wstrict-selector-match
2211 @opindex Wstrict-selector-match
2212 Warn if multiple methods with differing argument and/or return types are
2213 found for a given selector when attempting to send a message using this
2214 selector to a receiver of type @code{id} or @code{Class}. When this flag
2215 is off (which is the default behavior), the compiler will omit such warnings
2216 if any differences found are confined to types which share the same size
2217 and alignment.
2218
2219 @item -Wundeclared-selector
2220 @opindex Wundeclared-selector
2221 Warn if a @code{@@selector(@dots{})} expression referring to an
2222 undeclared selector is found. A selector is considered undeclared if no
2223 method with that name has been declared before the
2224 @code{@@selector(@dots{})} expression, either explicitly in an
2225 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2226 an @code{@@implementation} section. This option always performs its
2227 checks as soon as a @code{@@selector(@dots{})} expression is found,
2228 while @option{-Wselector} only performs its checks in the final stage of
2229 compilation. This also enforces the coding style convention
2230 that methods and selectors must be declared before being used.
2231
2232 @item -print-objc-runtime-info
2233 @opindex print-objc-runtime-info
2234 Generate C header describing the largest structure that is passed by
2235 value, if any.
2236
2237 @end table
2238
2239 @node Language Independent Options
2240 @section Options to Control Diagnostic Messages Formatting
2241 @cindex options to control diagnostics formatting
2242 @cindex diagnostic messages
2243 @cindex message formatting
2244
2245 Traditionally, diagnostic messages have been formatted irrespective of
2246 the output device's aspect (e.g.@: its width, @dots{}). The options described
2247 below can be used to control the diagnostic messages formatting
2248 algorithm, e.g.@: how many characters per line, how often source location
2249 information should be reported. Right now, only the C++ front end can
2250 honor these options. However it is expected, in the near future, that
2251 the remaining front ends would be able to digest them correctly.
2252
2253 @table @gcctabopt
2254 @item -fmessage-length=@var{n}
2255 @opindex fmessage-length
2256 Try to format error messages so that they fit on lines of about @var{n}
2257 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2258 the front ends supported by GCC@. If @var{n} is zero, then no
2259 line-wrapping will be done; each error message will appear on a single
2260 line.
2261
2262 @opindex fdiagnostics-show-location
2263 @item -fdiagnostics-show-location=once
2264 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2265 reporter to emit @emph{once} source location information; that is, in
2266 case the message is too long to fit on a single physical line and has to
2267 be wrapped, the source location won't be emitted (as prefix) again,
2268 over and over, in subsequent continuation lines. This is the default
2269 behavior.
2270
2271 @item -fdiagnostics-show-location=every-line
2272 Only meaningful in line-wrapping mode. Instructs the diagnostic
2273 messages reporter to emit the same source location information (as
2274 prefix) for physical lines that result from the process of breaking
2275 a message which is too long to fit on a single line.
2276
2277 @item -fdiagnostics-show-option
2278 @opindex fdiagnostics-show-option
2279 This option instructs the diagnostic machinery to add text to each
2280 diagnostic emitted, which indicates which command line option directly
2281 controls that diagnostic, when such an option is known to the
2282 diagnostic machinery.
2283
2284 @end table
2285
2286 @node Warning Options
2287 @section Options to Request or Suppress Warnings
2288 @cindex options to control warnings
2289 @cindex warning messages
2290 @cindex messages, warning
2291 @cindex suppressing warnings
2292
2293 Warnings are diagnostic messages that report constructions which
2294 are not inherently erroneous but which are risky or suggest there
2295 may have been an error.
2296
2297 You can request many specific warnings with options beginning @samp{-W},
2298 for example @option{-Wimplicit} to request warnings on implicit
2299 declarations. Each of these specific warning options also has a
2300 negative form beginning @samp{-Wno-} to turn off warnings;
2301 for example, @option{-Wno-implicit}. This manual lists only one of the
2302 two forms, whichever is not the default.
2303
2304 The following options control the amount and kinds of warnings produced
2305 by GCC; for further, language-specific options also refer to
2306 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2307 Options}.
2308
2309 @table @gcctabopt
2310 @cindex syntax checking
2311 @item -fsyntax-only
2312 @opindex fsyntax-only
2313 Check the code for syntax errors, but don't do anything beyond that.
2314
2315 @item -pedantic
2316 @opindex pedantic
2317 Issue all the warnings demanded by strict ISO C and ISO C++;
2318 reject all programs that use forbidden extensions, and some other
2319 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2320 version of the ISO C standard specified by any @option{-std} option used.
2321
2322 Valid ISO C and ISO C++ programs should compile properly with or without
2323 this option (though a rare few will require @option{-ansi} or a
2324 @option{-std} option specifying the required version of ISO C)@. However,
2325 without this option, certain GNU extensions and traditional C and C++
2326 features are supported as well. With this option, they are rejected.
2327
2328 @option{-pedantic} does not cause warning messages for use of the
2329 alternate keywords whose names begin and end with @samp{__}. Pedantic
2330 warnings are also disabled in the expression that follows
2331 @code{__extension__}. However, only system header files should use
2332 these escape routes; application programs should avoid them.
2333 @xref{Alternate Keywords}.
2334
2335 Some users try to use @option{-pedantic} to check programs for strict ISO
2336 C conformance. They soon find that it does not do quite what they want:
2337 it finds some non-ISO practices, but not all---only those for which
2338 ISO C @emph{requires} a diagnostic, and some others for which
2339 diagnostics have been added.
2340
2341 A feature to report any failure to conform to ISO C might be useful in
2342 some instances, but would require considerable additional work and would
2343 be quite different from @option{-pedantic}. We don't have plans to
2344 support such a feature in the near future.
2345
2346 Where the standard specified with @option{-std} represents a GNU
2347 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2348 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2349 extended dialect is based. Warnings from @option{-pedantic} are given
2350 where they are required by the base standard. (It would not make sense
2351 for such warnings to be given only for features not in the specified GNU
2352 C dialect, since by definition the GNU dialects of C include all
2353 features the compiler supports with the given option, and there would be
2354 nothing to warn about.)
2355
2356 @item -pedantic-errors
2357 @opindex pedantic-errors
2358 Like @option{-pedantic}, except that errors are produced rather than
2359 warnings.
2360
2361 @item -w
2362 @opindex w
2363 Inhibit all warning messages.
2364
2365 @item -Wno-import
2366 @opindex Wno-import
2367 Inhibit warning messages about the use of @samp{#import}.
2368
2369 @item -Wchar-subscripts
2370 @opindex Wchar-subscripts
2371 Warn if an array subscript has type @code{char}. This is a common cause
2372 of error, as programmers often forget that this type is signed on some
2373 machines.
2374 This warning is enabled by @option{-Wall}.
2375
2376 @item -Wcomment
2377 @opindex Wcomment
2378 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2379 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2380 This warning is enabled by @option{-Wall}.
2381
2382 @item -Wfatal-errors
2383 @opindex Wfatal-errors
2384 This option causes the compiler to abort compilation on the first error
2385 occurred rather than trying to keep going and printing further error
2386 messages.
2387
2388 @item -Wformat
2389 @opindex Wformat
2390 @opindex ffreestanding
2391 @opindex fno-builtin
2392 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2393 the arguments supplied have types appropriate to the format string
2394 specified, and that the conversions specified in the format string make
2395 sense. This includes standard functions, and others specified by format
2396 attributes (@pxref{Function Attributes}), in the @code{printf},
2397 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2398 not in the C standard) families (or other target-specific families).
2399 Which functions are checked without format attributes having been
2400 specified depends on the standard version selected, and such checks of
2401 functions without the attribute specified are disabled by
2402 @option{-ffreestanding} or @option{-fno-builtin}.
2403
2404 The formats are checked against the format features supported by GNU
2405 libc version 2.2. These include all ISO C90 and C99 features, as well
2406 as features from the Single Unix Specification and some BSD and GNU
2407 extensions. Other library implementations may not support all these
2408 features; GCC does not support warning about features that go beyond a
2409 particular library's limitations. However, if @option{-pedantic} is used
2410 with @option{-Wformat}, warnings will be given about format features not
2411 in the selected standard version (but not for @code{strfmon} formats,
2412 since those are not in any version of the C standard). @xref{C Dialect
2413 Options,,Options Controlling C Dialect}.
2414
2415 Since @option{-Wformat} also checks for null format arguments for
2416 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2417
2418 @option{-Wformat} is included in @option{-Wall}. For more control over some
2419 aspects of format checking, the options @option{-Wformat-y2k},
2420 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2421 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2422 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2423
2424 @item -Wformat-y2k
2425 @opindex Wformat-y2k
2426 If @option{-Wformat} is specified, also warn about @code{strftime}
2427 formats which may yield only a two-digit year.
2428
2429 @item -Wno-format-extra-args
2430 @opindex Wno-format-extra-args
2431 If @option{-Wformat} is specified, do not warn about excess arguments to a
2432 @code{printf} or @code{scanf} format function. The C standard specifies
2433 that such arguments are ignored.
2434
2435 Where the unused arguments lie between used arguments that are
2436 specified with @samp{$} operand number specifications, normally
2437 warnings are still given, since the implementation could not know what
2438 type to pass to @code{va_arg} to skip the unused arguments. However,
2439 in the case of @code{scanf} formats, this option will suppress the
2440 warning if the unused arguments are all pointers, since the Single
2441 Unix Specification says that such unused arguments are allowed.
2442
2443 @item -Wno-format-zero-length
2444 @opindex Wno-format-zero-length
2445 If @option{-Wformat} is specified, do not warn about zero-length formats.
2446 The C standard specifies that zero-length formats are allowed.
2447
2448 @item -Wformat-nonliteral
2449 @opindex Wformat-nonliteral
2450 If @option{-Wformat} is specified, also warn if the format string is not a
2451 string literal and so cannot be checked, unless the format function
2452 takes its format arguments as a @code{va_list}.
2453
2454 @item -Wformat-security
2455 @opindex Wformat-security
2456 If @option{-Wformat} is specified, also warn about uses of format
2457 functions that represent possible security problems. At present, this
2458 warns about calls to @code{printf} and @code{scanf} functions where the
2459 format string is not a string literal and there are no format arguments,
2460 as in @code{printf (foo);}. This may be a security hole if the format
2461 string came from untrusted input and contains @samp{%n}. (This is
2462 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2463 in future warnings may be added to @option{-Wformat-security} that are not
2464 included in @option{-Wformat-nonliteral}.)
2465
2466 @item -Wformat=2
2467 @opindex Wformat=2
2468 Enable @option{-Wformat} plus format checks not included in
2469 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2470 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2471
2472 @item -Wnonnull
2473 @opindex Wnonnull
2474 Warn about passing a null pointer for arguments marked as
2475 requiring a non-null value by the @code{nonnull} function attribute.
2476
2477 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2478 can be disabled with the @option{-Wno-nonnull} option.
2479
2480 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2481 @opindex Winit-self
2482 Warn about uninitialized variables which are initialized with themselves.
2483 Note this option can only be used with the @option{-Wuninitialized} option,
2484 which in turn only works with @option{-O1} and above.
2485
2486 For example, GCC will warn about @code{i} being uninitialized in the
2487 following snippet only when @option{-Winit-self} has been specified:
2488 @smallexample
2489 @group
2490 int f()
2491 @{
2492 int i = i;
2493 return i;
2494 @}
2495 @end group
2496 @end smallexample
2497
2498 @item -Wimplicit-int
2499 @opindex Wimplicit-int
2500 Warn when a declaration does not specify a type.
2501 This warning is enabled by @option{-Wall}.
2502
2503 @item -Wimplicit-function-declaration
2504 @itemx -Werror-implicit-function-declaration
2505 @opindex Wimplicit-function-declaration
2506 @opindex Werror-implicit-function-declaration
2507 Give a warning (or error) whenever a function is used before being
2508 declared. The form @option{-Wno-error-implicit-function-declaration}
2509 is not supported.
2510 This warning is enabled by @option{-Wall} (as a warning, not an error).
2511
2512 @item -Wimplicit
2513 @opindex Wimplicit
2514 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2515 This warning is enabled by @option{-Wall}.
2516
2517 @item -Wmain
2518 @opindex Wmain
2519 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2520 function with external linkage, returning int, taking either zero
2521 arguments, two, or three arguments of appropriate types.
2522 This warning is enabled by @option{-Wall}.
2523
2524 @item -Wmissing-braces
2525 @opindex Wmissing-braces
2526 Warn if an aggregate or union initializer is not fully bracketed. In
2527 the following example, the initializer for @samp{a} is not fully
2528 bracketed, but that for @samp{b} is fully bracketed.
2529
2530 @smallexample
2531 int a[2][2] = @{ 0, 1, 2, 3 @};
2532 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2533 @end smallexample
2534
2535 This warning is enabled by @option{-Wall}.
2536
2537 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2538 @opindex Wmissing-include-dirs
2539 Warn if a user-supplied include directory does not exist.
2540
2541 @item -Wparentheses
2542 @opindex Wparentheses
2543 Warn if parentheses are omitted in certain contexts, such
2544 as when there is an assignment in a context where a truth value
2545 is expected, or when operators are nested whose precedence people
2546 often get confused about.
2547
2548 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2549 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2550 interpretation from that of ordinary mathematical notation.
2551
2552 Also warn about constructions where there may be confusion to which
2553 @code{if} statement an @code{else} branch belongs. Here is an example of
2554 such a case:
2555
2556 @smallexample
2557 @group
2558 @{
2559 if (a)
2560 if (b)
2561 foo ();
2562 else
2563 bar ();
2564 @}
2565 @end group
2566 @end smallexample
2567
2568 In C/C++, every @code{else} branch belongs to the innermost possible
2569 @code{if} statement, which in this example is @code{if (b)}. This is
2570 often not what the programmer expected, as illustrated in the above
2571 example by indentation the programmer chose. When there is the
2572 potential for this confusion, GCC will issue a warning when this flag
2573 is specified. To eliminate the warning, add explicit braces around
2574 the innermost @code{if} statement so there is no way the @code{else}
2575 could belong to the enclosing @code{if}. The resulting code would
2576 look like this:
2577
2578 @smallexample
2579 @group
2580 @{
2581 if (a)
2582 @{
2583 if (b)
2584 foo ();
2585 else
2586 bar ();
2587 @}
2588 @}
2589 @end group
2590 @end smallexample
2591
2592 This warning is enabled by @option{-Wall}.
2593
2594 @item -Wsequence-point
2595 @opindex Wsequence-point
2596 Warn about code that may have undefined semantics because of violations
2597 of sequence point rules in the C and C++ standards.
2598
2599 The C and C++ standards defines the order in which expressions in a C/C++
2600 program are evaluated in terms of @dfn{sequence points}, which represent
2601 a partial ordering between the execution of parts of the program: those
2602 executed before the sequence point, and those executed after it. These
2603 occur after the evaluation of a full expression (one which is not part
2604 of a larger expression), after the evaluation of the first operand of a
2605 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2606 function is called (but after the evaluation of its arguments and the
2607 expression denoting the called function), and in certain other places.
2608 Other than as expressed by the sequence point rules, the order of
2609 evaluation of subexpressions of an expression is not specified. All
2610 these rules describe only a partial order rather than a total order,
2611 since, for example, if two functions are called within one expression
2612 with no sequence point between them, the order in which the functions
2613 are called is not specified. However, the standards committee have
2614 ruled that function calls do not overlap.
2615
2616 It is not specified when between sequence points modifications to the
2617 values of objects take effect. Programs whose behavior depends on this
2618 have undefined behavior; the C and C++ standards specify that ``Between
2619 the previous and next sequence point an object shall have its stored
2620 value modified at most once by the evaluation of an expression.
2621 Furthermore, the prior value shall be read only to determine the value
2622 to be stored.''. If a program breaks these rules, the results on any
2623 particular implementation are entirely unpredictable.
2624
2625 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2626 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2627 diagnosed by this option, and it may give an occasional false positive
2628 result, but in general it has been found fairly effective at detecting
2629 this sort of problem in programs.
2630
2631 The standard is worded confusingly, therefore there is some debate
2632 over the precise meaning of the sequence point rules in subtle cases.
2633 Links to discussions of the problem, including proposed formal
2634 definitions, may be found on the GCC readings page, at
2635 @w{@uref{http://gcc.gnu.org/readings.html}}.
2636
2637 This warning is enabled by @option{-Wall} for C and C++.
2638
2639 @item -Wreturn-type
2640 @opindex Wreturn-type
2641 Warn whenever a function is defined with a return-type that defaults to
2642 @code{int}. Also warn about any @code{return} statement with no
2643 return-value in a function whose return-type is not @code{void}.
2644
2645 For C, also warn if the return type of a function has a type qualifier
2646 such as @code{const}. Such a type qualifier has no effect, since the
2647 value returned by a function is not an lvalue. ISO C prohibits
2648 qualified @code{void} return types on function definitions, so such
2649 return types always receive a warning even without this option.
2650
2651 For C++, a function without return type always produces a diagnostic
2652 message, even when @option{-Wno-return-type} is specified. The only
2653 exceptions are @samp{main} and functions defined in system headers.
2654
2655 This warning is enabled by @option{-Wall}.
2656
2657 @item -Wswitch
2658 @opindex Wswitch
2659 Warn whenever a @code{switch} statement has an index of enumerated type
2660 and lacks a @code{case} for one or more of the named codes of that
2661 enumeration. (The presence of a @code{default} label prevents this
2662 warning.) @code{case} labels outside the enumeration range also
2663 provoke warnings when this option is used.
2664 This warning is enabled by @option{-Wall}.
2665
2666 @item -Wswitch-default
2667 @opindex Wswitch-switch
2668 Warn whenever a @code{switch} statement does not have a @code{default}
2669 case.
2670
2671 @item -Wswitch-enum
2672 @opindex Wswitch-enum
2673 Warn whenever a @code{switch} statement has an index of enumerated type
2674 and lacks a @code{case} for one or more of the named codes of that
2675 enumeration. @code{case} labels outside the enumeration range also
2676 provoke warnings when this option is used.
2677
2678 @item -Wtrigraphs
2679 @opindex Wtrigraphs
2680 Warn if any trigraphs are encountered that might change the meaning of
2681 the program (trigraphs within comments are not warned about).
2682 This warning is enabled by @option{-Wall}.
2683
2684 @item -Wunused-function
2685 @opindex Wunused-function
2686 Warn whenever a static function is declared but not defined or a
2687 non-inline static function is unused.
2688 This warning is enabled by @option{-Wall}.
2689
2690 @item -Wunused-label
2691 @opindex Wunused-label
2692 Warn whenever a label is declared but not used.
2693 This warning is enabled by @option{-Wall}.
2694
2695 To suppress this warning use the @samp{unused} attribute
2696 (@pxref{Variable Attributes}).
2697
2698 @item -Wunused-parameter
2699 @opindex Wunused-parameter
2700 Warn whenever a function parameter is unused aside from its declaration.
2701
2702 To suppress this warning use the @samp{unused} attribute
2703 (@pxref{Variable Attributes}).
2704
2705 @item -Wunused-variable
2706 @opindex Wunused-variable
2707 Warn whenever a local variable or non-constant static variable is unused
2708 aside from its declaration.
2709 This warning is enabled by @option{-Wall}.
2710
2711 To suppress this warning use the @samp{unused} attribute
2712 (@pxref{Variable Attributes}).
2713
2714 @item -Wunused-value
2715 @opindex Wunused-value
2716 Warn whenever a statement computes a result that is explicitly not used.
2717 This warning is enabled by @option{-Wall}.
2718
2719 To suppress this warning cast the expression to @samp{void}.
2720
2721 @item -Wunused
2722 @opindex Wunused
2723 All the above @option{-Wunused} options combined.
2724
2725 In order to get a warning about an unused function parameter, you must
2726 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2727 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2728
2729 @item -Wuninitialized
2730 @opindex Wuninitialized
2731 Warn if an automatic variable is used without first being initialized or
2732 if a variable may be clobbered by a @code{setjmp} call.
2733
2734 These warnings are possible only in optimizing compilation,
2735 because they require data flow information that is computed only
2736 when optimizing. If you do not specify @option{-O}, you will not get
2737 these warnings. Instead, GCC will issue a warning about @option{-Wuninitialized}
2738 requiring @option{-O}.
2739
2740 If you want to warn about code which uses the uninitialized value of the
2741 variable in its own initializer, use the @option{-Winit-self} option.
2742
2743 These warnings occur for individual uninitialized or clobbered
2744 elements of structure, union or array variables as well as for
2745 variables which are uninitialized or clobbered as a whole. They do
2746 not occur for variables or elements declared @code{volatile}. Because
2747 these warnings depend on optimization, the exact variables or elements
2748 for which there are warnings will depend on the precise optimization
2749 options and version of GCC used.
2750
2751 Note that there may be no warning about a variable that is used only
2752 to compute a value that itself is never used, because such
2753 computations may be deleted by data flow analysis before the warnings
2754 are printed.
2755
2756 These warnings are made optional because GCC is not smart
2757 enough to see all the reasons why the code might be correct
2758 despite appearing to have an error. Here is one example of how
2759 this can happen:
2760
2761 @smallexample
2762 @group
2763 @{
2764 int x;
2765 switch (y)
2766 @{
2767 case 1: x = 1;
2768 break;
2769 case 2: x = 4;
2770 break;
2771 case 3: x = 5;
2772 @}
2773 foo (x);
2774 @}
2775 @end group
2776 @end smallexample
2777
2778 @noindent
2779 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2780 always initialized, but GCC doesn't know this. Here is
2781 another common case:
2782
2783 @smallexample
2784 @{
2785 int save_y;
2786 if (change_y) save_y = y, y = new_y;
2787 @dots{}
2788 if (change_y) y = save_y;
2789 @}
2790 @end smallexample
2791
2792 @noindent
2793 This has no bug because @code{save_y} is used only if it is set.
2794
2795 @cindex @code{longjmp} warnings
2796 This option also warns when a non-volatile automatic variable might be
2797 changed by a call to @code{longjmp}. These warnings as well are possible
2798 only in optimizing compilation.
2799
2800 The compiler sees only the calls to @code{setjmp}. It cannot know
2801 where @code{longjmp} will be called; in fact, a signal handler could
2802 call it at any point in the code. As a result, you may get a warning
2803 even when there is in fact no problem because @code{longjmp} cannot
2804 in fact be called at the place which would cause a problem.
2805
2806 Some spurious warnings can be avoided if you declare all the functions
2807 you use that never return as @code{noreturn}. @xref{Function
2808 Attributes}.
2809
2810 This warning is enabled by @option{-Wall}.
2811
2812 @item -Wunknown-pragmas
2813 @opindex Wunknown-pragmas
2814 @cindex warning for unknown pragmas
2815 @cindex unknown pragmas, warning
2816 @cindex pragmas, warning of unknown
2817 Warn when a #pragma directive is encountered which is not understood by
2818 GCC@. If this command line option is used, warnings will even be issued
2819 for unknown pragmas in system header files. This is not the case if
2820 the warnings were only enabled by the @option{-Wall} command line option.
2821
2822 @item -Wno-pragmas
2823 @opindex Wno-pragmas
2824 @opindex Wpragmas
2825 Do not warn about misuses of pragmas, such as incorrect parameters,
2826 invalid syntax, or conflicts between pragmas. See also
2827 @samp{-Wunknown-pragmas}.
2828
2829 @item -Wstrict-aliasing
2830 @opindex Wstrict-aliasing
2831 This option is only active when @option{-fstrict-aliasing} is active.
2832 It warns about code which might break the strict aliasing rules that the
2833 compiler is using for optimization. The warning does not catch all
2834 cases, but does attempt to catch the more common pitfalls. It is
2835 included in @option{-Wall}.
2836
2837 @item -Wstrict-aliasing=2
2838 @opindex Wstrict-aliasing=2
2839 This option is only active when @option{-fstrict-aliasing} is active.
2840 It warns about code which might break the strict aliasing rules that the
2841 compiler is using for optimization. This warning catches more cases than
2842 @option{-Wstrict-aliasing}, but it will also give a warning for some ambiguous
2843 cases that are safe.
2844
2845 @item -Wall
2846 @opindex Wall
2847 All of the above @samp{-W} options combined. This enables all the
2848 warnings about constructions that some users consider questionable, and
2849 that are easy to avoid (or modify to prevent the warning), even in
2850 conjunction with macros. This also enables some language-specific
2851 warnings described in @ref{C++ Dialect Options} and
2852 @ref{Objective-C and Objective-C++ Dialect Options}.
2853 @end table
2854
2855 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2856 Some of them warn about constructions that users generally do not
2857 consider questionable, but which occasionally you might wish to check
2858 for; others warn about constructions that are necessary or hard to avoid
2859 in some cases, and there is no simple way to modify the code to suppress
2860 the warning.
2861
2862 @table @gcctabopt
2863 @item -Wextra
2864 @opindex W
2865 @opindex Wextra
2866 (This option used to be called @option{-W}. The older name is still
2867 supported, but the newer name is more descriptive.) Print extra warning
2868 messages for these events:
2869
2870 @itemize @bullet
2871 @item
2872 A function can return either with or without a value. (Falling
2873 off the end of the function body is considered returning without
2874 a value.) For example, this function would evoke such a
2875 warning:
2876
2877 @smallexample
2878 @group
2879 foo (a)
2880 @{
2881 if (a > 0)
2882 return a;
2883 @}
2884 @end group
2885 @end smallexample
2886
2887 @item
2888 An expression-statement or the left-hand side of a comma expression
2889 contains no side effects.
2890 To suppress the warning, cast the unused expression to void.
2891 For example, an expression such as @samp{x[i,j]} will cause a warning,
2892 but @samp{x[(void)i,j]} will not.
2893
2894 @item
2895 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2896
2897 @item @r{(C only)}
2898 Storage-class specifiers like @code{static} are not the first things
2899 in a declaration. According to the C Standard, this usage is
2900 obsolescent. This warning can be independently controlled by
2901 @option{-Wold-style-declaration}.
2902
2903 @item
2904 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2905 arguments.
2906
2907 @item
2908 A comparison between signed and unsigned values could produce an
2909 incorrect result when the signed value is converted to unsigned.
2910 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2911
2912 @item
2913 An aggregate has an initializer which does not initialize all members.
2914 This warning can be independently controlled by
2915 @option{-Wmissing-field-initializers}.
2916
2917 @item
2918 An initialized field without side effects is overridden when using
2919 designated initializers (@pxref{Designated Inits, , Designated
2920 Initializers}). This warning can be independently controlled by
2921 @option{-Woverride-init}.
2922
2923 @item @r{(C only)}
2924 A function parameter is declared without a type specifier in K&R-style
2925 functions. This warning can be independently controlled by
2926 @option{-Wmissing-parameter-type}.
2927
2928 @item
2929 An empty body occurs in an @samp{if} or @samp{else} statement. This
2930 warning can be independently controlled by @option{-Wempty-body}.
2931
2932 @item
2933 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2934 @samp{>}, or @samp{>=}.
2935
2936 @item
2937 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2938 This warning can be independently controlled by @option{-Wclobbered}.
2939
2940 @item
2941 Any of several floating-point events that often indicate errors, such as
2942 overflow, underflow, loss of precision, etc.
2943
2944 @item @r{(C++ only)}
2945 An enumerator and a non-enumerator both appear in a conditional expression.
2946
2947 @item @r{(C++ only)}
2948 A non-static reference or non-static @samp{const} member appears in a
2949 class without constructors.
2950
2951 @item @r{(C++ only)}
2952 Ambiguous virtual bases.
2953
2954 @item @r{(C++ only)}
2955 Subscripting an array which has been declared @samp{register}.
2956
2957 @item @r{(C++ only)}
2958 Taking the address of a variable which has been declared @samp{register}.
2959
2960 @item @r{(C++ only)}
2961 A base class is not initialized in a derived class' copy constructor.
2962 @end itemize
2963
2964 @item -Wno-div-by-zero
2965 @opindex Wno-div-by-zero
2966 @opindex Wdiv-by-zero
2967 Do not warn about compile-time integer division by zero. Floating point
2968 division by zero is not warned about, as it can be a legitimate way of
2969 obtaining infinities and NaNs.
2970
2971 @item -Wsystem-headers
2972 @opindex Wsystem-headers
2973 @cindex warnings from system headers
2974 @cindex system headers, warnings from
2975 Print warning messages for constructs found in system header files.
2976 Warnings from system headers are normally suppressed, on the assumption
2977 that they usually do not indicate real problems and would only make the
2978 compiler output harder to read. Using this command line option tells
2979 GCC to emit warnings from system headers as if they occurred in user
2980 code. However, note that using @option{-Wall} in conjunction with this
2981 option will @emph{not} warn about unknown pragmas in system
2982 headers---for that, @option{-Wunknown-pragmas} must also be used.
2983
2984 @item -Wfloat-equal
2985 @opindex Wfloat-equal
2986 Warn if floating point values are used in equality comparisons.
2987
2988 The idea behind this is that sometimes it is convenient (for the
2989 programmer) to consider floating-point values as approximations to
2990 infinitely precise real numbers. If you are doing this, then you need
2991 to compute (by analyzing the code, or in some other way) the maximum or
2992 likely maximum error that the computation introduces, and allow for it
2993 when performing comparisons (and when producing output, but that's a
2994 different problem). In particular, instead of testing for equality, you
2995 would check to see whether the two values have ranges that overlap; and
2996 this is done with the relational operators, so equality comparisons are
2997 probably mistaken.
2998
2999 @item -Wtraditional @r{(C only)}
3000 @opindex Wtraditional
3001 Warn about certain constructs that behave differently in traditional and
3002 ISO C@. Also warn about ISO C constructs that have no traditional C
3003 equivalent, and/or problematic constructs which should be avoided.
3004
3005 @itemize @bullet
3006 @item
3007 Macro parameters that appear within string literals in the macro body.
3008 In traditional C macro replacement takes place within string literals,
3009 but does not in ISO C@.
3010
3011 @item
3012 In traditional C, some preprocessor directives did not exist.
3013 Traditional preprocessors would only consider a line to be a directive
3014 if the @samp{#} appeared in column 1 on the line. Therefore
3015 @option{-Wtraditional} warns about directives that traditional C
3016 understands but would ignore because the @samp{#} does not appear as the
3017 first character on the line. It also suggests you hide directives like
3018 @samp{#pragma} not understood by traditional C by indenting them. Some
3019 traditional implementations would not recognize @samp{#elif}, so it
3020 suggests avoiding it altogether.
3021
3022 @item
3023 A function-like macro that appears without arguments.
3024
3025 @item
3026 The unary plus operator.
3027
3028 @item
3029 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
3030 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
3031 constants.) Note, these suffixes appear in macros defined in the system
3032 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
3033 Use of these macros in user code might normally lead to spurious
3034 warnings, however GCC's integrated preprocessor has enough context to
3035 avoid warning in these cases.
3036
3037 @item
3038 A function declared external in one block and then used after the end of
3039 the block.
3040
3041 @item
3042 A @code{switch} statement has an operand of type @code{long}.
3043
3044 @item
3045 A non-@code{static} function declaration follows a @code{static} one.
3046 This construct is not accepted by some traditional C compilers.
3047
3048 @item
3049 The ISO type of an integer constant has a different width or
3050 signedness from its traditional type. This warning is only issued if
3051 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
3052 typically represent bit patterns, are not warned about.
3053
3054 @item
3055 Usage of ISO string concatenation is detected.
3056
3057 @item
3058 Initialization of automatic aggregates.
3059
3060 @item
3061 Identifier conflicts with labels. Traditional C lacks a separate
3062 namespace for labels.
3063
3064 @item
3065 Initialization of unions. If the initializer is zero, the warning is
3066 omitted. This is done under the assumption that the zero initializer in
3067 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
3068 initializer warnings and relies on default initialization to zero in the
3069 traditional C case.
3070
3071 @item
3072 Conversions by prototypes between fixed/floating point values and vice
3073 versa. The absence of these prototypes when compiling with traditional
3074 C would cause serious problems. This is a subset of the possible
3075 conversion warnings, for the full set use @option{-Wtraditional-conversion}.
3076
3077 @item
3078 Use of ISO C style function definitions. This warning intentionally is
3079 @emph{not} issued for prototype declarations or variadic functions
3080 because these ISO C features will appear in your code when using
3081 libiberty's traditional C compatibility macros, @code{PARAMS} and
3082 @code{VPARAMS}. This warning is also bypassed for nested functions
3083 because that feature is already a GCC extension and thus not relevant to
3084 traditional C compatibility.
3085 @end itemize
3086
3087 @item -Wtraditional-conversion @r{(C only)}
3088 @opindex Wtraditional-conversion
3089 Warn if a prototype causes a type conversion that is different from what
3090 would happen to the same argument in the absence of a prototype. This
3091 includes conversions of fixed point to floating and vice versa, and
3092 conversions changing the width or signedness of a fixed point argument
3093 except when the same as the default promotion.
3094
3095 @item -Wdeclaration-after-statement @r{(C only)}
3096 @opindex Wdeclaration-after-statement
3097 Warn when a declaration is found after a statement in a block. This
3098 construct, known from C++, was introduced with ISO C99 and is by default
3099 allowed in GCC@. It is not supported by ISO C90 and was not supported by
3100 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
3101
3102 @item -Wundef
3103 @opindex Wundef
3104 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
3105
3106 @item -Wno-endif-labels
3107 @opindex Wno-endif-labels
3108 @opindex Wendif-labels
3109 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
3110
3111 @item -Wshadow
3112 @opindex Wshadow
3113 Warn whenever a local variable shadows another local variable, parameter or
3114 global variable or whenever a built-in function is shadowed.
3115
3116 @item -Wlarger-than-@var{len}
3117 @opindex Wlarger-than
3118 Warn whenever an object of larger than @var{len} bytes is defined.
3119
3120 @item -Wunsafe-loop-optimizations
3121 @opindex Wunsafe-loop-optimizations
3122 Warn if the loop cannot be optimized because the compiler could not
3123 assume anything on the bounds of the loop indices. With
3124 @option{-funsafe-loop-optimizations} warn if the compiler made
3125 such assumptions.
3126
3127 @item -Wpointer-arith
3128 @opindex Wpointer-arith
3129 Warn about anything that depends on the ``size of'' a function type or
3130 of @code{void}. GNU C assigns these types a size of 1, for
3131 convenience in calculations with @code{void *} pointers and pointers
3132 to functions.
3133
3134 @item -Wbad-function-cast @r{(C only)}
3135 @opindex Wbad-function-cast
3136 Warn whenever a function call is cast to a non-matching type.
3137 For example, warn if @code{int malloc()} is cast to @code{anything *}.
3138
3139 @item -Wc++-compat
3140 Warn about ISO C constructs that are outside of the common subset of
3141 ISO C and ISO C++, e.g.@: request for implicit conversion from
3142 @code{void *} to a pointer to non-@code{void} type.
3143
3144 @item -Wcast-qual
3145 @opindex Wcast-qual
3146 Warn whenever a pointer is cast so as to remove a type qualifier from
3147 the target type. For example, warn if a @code{const char *} is cast
3148 to an ordinary @code{char *}.
3149
3150 @item -Wcast-align
3151 @opindex Wcast-align
3152 Warn whenever a pointer is cast such that the required alignment of the
3153 target is increased. For example, warn if a @code{char *} is cast to
3154 an @code{int *} on machines where integers can only be accessed at
3155 two- or four-byte boundaries.
3156
3157 @item -Wwrite-strings
3158 @opindex Wwrite-strings
3159 When compiling C, give string constants the type @code{const
3160 char[@var{length}]} so that
3161 copying the address of one into a non-@code{const} @code{char *}
3162 pointer will get a warning; when compiling C++, warn about the
3163 deprecated conversion from string literals to @code{char *}. This
3164 warning, by default, is enabled for C++ programs.
3165 These warnings will help you find at
3166 compile time code that can try to write into a string constant, but
3167 only if you have been very careful about using @code{const} in
3168 declarations and prototypes. Otherwise, it will just be a nuisance;
3169 this is why we did not make @option{-Wall} request these warnings.
3170
3171 @item -Wclobbered
3172 @opindex Wclobbered
3173 Warn for variables that might be changed by @samp{longjmp} or
3174 @samp{vfork}. This warning is also enabled by @option{-Wextra}.
3175
3176 @item -Wconversion
3177 @opindex Wconversion
3178 Warn for implicit conversions that may alter a value. This includes
3179 conversions between real and integer, like @code{abs (x)} when
3180 @code{x} is @code{double}; conversions between signed and unsigned,
3181 like @code{unsigned ui = -1}; and conversions to smaller types, like
3182 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
3183 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
3184 changed by the conversion like in @code{abs (2.0)}.
3185
3186 @item -Wempty-body
3187 @opindex Wempty-body
3188 An empty body occurs in an @samp{if} or @samp{else} statement.
3189 This warning is also enabled by @option{-Wextra}.
3190
3191 @item -Wsign-compare
3192 @opindex Wsign-compare
3193 @cindex warning for comparison of signed and unsigned values
3194 @cindex comparison of signed and unsigned values, warning
3195 @cindex signed and unsigned values, comparison warning
3196 Warn when a comparison between signed and unsigned values could produce
3197 an incorrect result when the signed value is converted to unsigned.
3198 This warning is also enabled by @option{-Wextra}; to get the other warnings
3199 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3200
3201 @item -Waggregate-return
3202 @opindex Waggregate-return
3203 Warn if any functions that return structures or unions are defined or
3204 called. (In languages where you can return an array, this also elicits
3205 a warning.)
3206
3207 @item -Walways-true
3208 @opindex Walways-true
3209 Warn about comparisons which are always true such as testing if
3210 unsigned values are greater than or equal to zero. This warning is
3211 enabled by @option{-Wall}.
3212
3213 @item -Wno-attributes
3214 @opindex Wno-attributes
3215 @opindex Wattributes
3216 Do not warn if an unexpected @code{__attribute__} is used, such as
3217 unrecognized attributes, function attributes applied to variables,
3218 etc. This will not stop errors for incorrect use of supported
3219 attributes.
3220
3221 @item -Wstrict-prototypes @r{(C only)}
3222 @opindex Wstrict-prototypes
3223 Warn if a function is declared or defined without specifying the
3224 argument types. (An old-style function definition is permitted without
3225 a warning if preceded by a declaration which specifies the argument
3226 types.)
3227
3228 @item -Wold-style-declaration @r{(C only)}
3229 @opindex Wold-style-declaration
3230 Warn for obsolescent usages, according to the C Standard, in a
3231 declaration. For example, warn if storage-class specifiers like
3232 @code{static} are not the first things in a declaration. This warning
3233 is also enabled by @option{-Wextra}.
3234
3235 @item -Wold-style-definition @r{(C only)}
3236 @opindex Wold-style-definition
3237 Warn if an old-style function definition is used. A warning is given
3238 even if there is a previous prototype.
3239
3240 @item -Wmissing-parameter-type @r{(C only)}
3241 @opindex Wmissing-parameter-type
3242 A function parameter is declared without a type specifier in K&R-style
3243 functions:
3244
3245 @smallexample
3246 void foo(bar) @{ @}
3247 @end smallexample
3248
3249 This warning is also enabled by @option{-Wextra}.
3250
3251 @item -Wmissing-prototypes @r{(C only)}
3252 @opindex Wmissing-prototypes
3253 Warn if a global function is defined without a previous prototype
3254 declaration. This warning is issued even if the definition itself
3255 provides a prototype. The aim is to detect global functions that fail
3256 to be declared in header files.
3257
3258 @item -Wmissing-declarations @r{(C and C++ only)}
3259 @opindex Wmissing-declarations
3260 Warn if a global function is defined without a previous declaration.
3261 Do so even if the definition itself provides a prototype.
3262 Use this option to detect global functions that are not declared in
3263 header files. In C++, no warnings are issued for function templates,
3264 or for inline functions, or for functions in anonymous namespaces.
3265
3266 @item -Wmissing-field-initializers
3267 @opindex Wmissing-field-initializers
3268 @opindex W
3269 @opindex Wextra
3270 Warn if a structure's initializer has some fields missing. For
3271 example, the following code would cause such a warning, because
3272 @code{x.h} is implicitly zero:
3273
3274 @smallexample
3275 struct s @{ int f, g, h; @};
3276 struct s x = @{ 3, 4 @};
3277 @end smallexample
3278
3279 This option does not warn about designated initializers, so the following
3280 modification would not trigger a warning:
3281
3282 @smallexample
3283 struct s @{ int f, g, h; @};
3284 struct s x = @{ .f = 3, .g = 4 @};
3285 @end smallexample
3286
3287 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3288 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3289
3290 @item -Wmissing-noreturn
3291 @opindex Wmissing-noreturn
3292 Warn about functions which might be candidates for attribute @code{noreturn}.
3293 Note these are only possible candidates, not absolute ones. Care should
3294 be taken to manually verify functions actually do not ever return before
3295 adding the @code{noreturn} attribute, otherwise subtle code generation
3296 bugs could be introduced. You will not get a warning for @code{main} in
3297 hosted C environments.
3298
3299 @item -Wmissing-format-attribute
3300 @opindex Wmissing-format-attribute
3301 @opindex Wformat
3302 Warn about function pointers which might be candidates for @code{format}
3303 attributes. Note these are only possible candidates, not absolute ones.
3304 GCC will guess that function pointers with @code{format} attributes that
3305 are used in assignment, initialization, parameter passing or return
3306 statements should have a corresponding @code{format} attribute in the
3307 resulting type. I.e.@: the left-hand side of the assignment or
3308 initialization, the type of the parameter variable, or the return type
3309 of the containing function respectively should also have a @code{format}
3310 attribute to avoid the warning.
3311
3312 GCC will also warn about function definitions which might be
3313 candidates for @code{format} attributes. Again, these are only
3314 possible candidates. GCC will guess that @code{format} attributes
3315 might be appropriate for any function that calls a function like
3316 @code{vprintf} or @code{vscanf}, but this might not always be the
3317 case, and some functions for which @code{format} attributes are
3318 appropriate may not be detected.
3319
3320 @item -Wno-multichar
3321 @opindex Wno-multichar
3322 @opindex Wmultichar
3323 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3324 Usually they indicate a typo in the user's code, as they have
3325 implementation-defined values, and should not be used in portable code.
3326
3327 @item -Wnormalized=<none|id|nfc|nfkc>
3328 @opindex Wnormalized
3329 @cindex NFC
3330 @cindex NFKC
3331 @cindex character set, input normalization
3332 In ISO C and ISO C++, two identifiers are different if they are
3333 different sequences of characters. However, sometimes when characters
3334 outside the basic ASCII character set are used, you can have two
3335 different character sequences that look the same. To avoid confusion,
3336 the ISO 10646 standard sets out some @dfn{normalization rules} which
3337 when applied ensure that two sequences that look the same are turned into
3338 the same sequence. GCC can warn you if you are using identifiers which
3339 have not been normalized; this option controls that warning.
3340
3341 There are four levels of warning that GCC supports. The default is
3342 @option{-Wnormalized=nfc}, which warns about any identifier which is
3343 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3344 recommended form for most uses.
3345
3346 Unfortunately, there are some characters which ISO C and ISO C++ allow
3347 in identifiers that when turned into NFC aren't allowable as
3348 identifiers. That is, there's no way to use these symbols in portable
3349 ISO C or C++ and have all your identifiers in NFC.
3350 @option{-Wnormalized=id} suppresses the warning for these characters.
3351 It is hoped that future versions of the standards involved will correct
3352 this, which is why this option is not the default.
3353
3354 You can switch the warning off for all characters by writing
3355 @option{-Wnormalized=none}. You would only want to do this if you
3356 were using some other normalization scheme (like ``D''), because
3357 otherwise you can easily create bugs that are literally impossible to see.
3358
3359 Some characters in ISO 10646 have distinct meanings but look identical
3360 in some fonts or display methodologies, especially once formatting has
3361 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3362 LETTER N'', will display just like a regular @code{n} which has been
3363 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3364 normalization scheme to convert all these into a standard form as
3365 well, and GCC will warn if your code is not in NFKC if you use
3366 @option{-Wnormalized=nfkc}. This warning is comparable to warning
3367 about every identifier that contains the letter O because it might be
3368 confused with the digit 0, and so is not the default, but may be
3369 useful as a local coding convention if the programming environment is
3370 unable to be fixed to display these characters distinctly.
3371
3372 @item -Wno-deprecated-declarations
3373 @opindex Wno-deprecated-declarations
3374 Do not warn about uses of functions (@pxref{Function Attributes}),
3375 variables (@pxref{Variable Attributes}), and types (@pxref{Type
3376 Attributes}) marked as deprecated by using the @code{deprecated}
3377 attribute.
3378
3379 @item -Wno-overflow
3380 @opindex Wno-overflow
3381 Do not warn about compile-time overflow in constant expressions.
3382
3383 @item -Woverride-init
3384 @opindex Woverride-init
3385 @opindex W
3386 @opindex Wextra
3387 Warn if an initialized field without side effects is overridden when
3388 using designated initializers (@pxref{Designated Inits, , Designated
3389 Initializers}).
3390
3391 This warning is included in @option{-Wextra}. To get other
3392 @option{-Wextra} warnings without this one, use @samp{-Wextra
3393 -Wno-override-init}.
3394
3395 @item -Wpacked
3396 @opindex Wpacked
3397 Warn if a structure is given the packed attribute, but the packed
3398 attribute has no effect on the layout or size of the structure.
3399 Such structures may be mis-aligned for little benefit. For
3400 instance, in this code, the variable @code{f.x} in @code{struct bar}
3401 will be misaligned even though @code{struct bar} does not itself
3402 have the packed attribute:
3403
3404 @smallexample
3405 @group
3406 struct foo @{
3407 int x;
3408 char a, b, c, d;
3409 @} __attribute__((packed));
3410 struct bar @{
3411 char z;
3412 struct foo f;
3413 @};
3414 @end group
3415 @end smallexample
3416
3417 @item -Wpadded
3418 @opindex Wpadded
3419 Warn if padding is included in a structure, either to align an element
3420 of the structure or to align the whole structure. Sometimes when this
3421 happens it is possible to rearrange the fields of the structure to
3422 reduce the padding and so make the structure smaller.
3423
3424 @item -Wredundant-decls
3425 @opindex Wredundant-decls
3426 Warn if anything is declared more than once in the same scope, even in
3427 cases where multiple declaration is valid and changes nothing.
3428
3429 @item -Wnested-externs @r{(C only)}
3430 @opindex Wnested-externs
3431 Warn if an @code{extern} declaration is encountered within a function.
3432
3433 @item -Wunreachable-code
3434 @opindex Wunreachable-code
3435 Warn if the compiler detects that code will never be executed.
3436
3437 This option is intended to warn when the compiler detects that at
3438 least a whole line of source code will never be executed, because
3439 some condition is never satisfied or because it is after a
3440 procedure that never returns.
3441
3442 It is possible for this option to produce a warning even though there
3443 are circumstances under which part of the affected line can be executed,
3444 so care should be taken when removing apparently-unreachable code.
3445
3446 For instance, when a function is inlined, a warning may mean that the
3447 line is unreachable in only one inlined copy of the function.
3448
3449 This option is not made part of @option{-Wall} because in a debugging
3450 version of a program there is often substantial code which checks
3451 correct functioning of the program and is, hopefully, unreachable
3452 because the program does work. Another common use of unreachable
3453 code is to provide behavior which is selectable at compile-time.
3454
3455 @item -Winline
3456 @opindex Winline
3457 Warn if a function can not be inlined and it was declared as inline.
3458 Even with this option, the compiler will not warn about failures to
3459 inline functions declared in system headers.
3460
3461 The compiler uses a variety of heuristics to determine whether or not
3462 to inline a function. For example, the compiler takes into account
3463 the size of the function being inlined and the amount of inlining
3464 that has already been done in the current function. Therefore,
3465 seemingly insignificant changes in the source program can cause the
3466 warnings produced by @option{-Winline} to appear or disappear.
3467
3468 @item -Wno-invalid-offsetof @r{(C++ only)}
3469 @opindex Wno-invalid-offsetof
3470 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3471 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3472 to a non-POD type is undefined. In existing C++ implementations,
3473 however, @samp{offsetof} typically gives meaningful results even when
3474 applied to certain kinds of non-POD types. (Such as a simple
3475 @samp{struct} that fails to be a POD type only by virtue of having a
3476 constructor.) This flag is for users who are aware that they are
3477 writing nonportable code and who have deliberately chosen to ignore the
3478 warning about it.
3479
3480 The restrictions on @samp{offsetof} may be relaxed in a future version
3481 of the C++ standard.
3482
3483 @item -Wno-int-to-pointer-cast @r{(C only)}
3484 @opindex Wno-int-to-pointer-cast
3485 Suppress warnings from casts to pointer type of an integer of a
3486 different size.
3487
3488 @item -Wno-pointer-to-int-cast @r{(C only)}
3489 @opindex Wno-pointer-to-int-cast
3490 Suppress warnings from casts from a pointer to an integer type of a
3491 different size.
3492
3493 @item -Winvalid-pch
3494 @opindex Winvalid-pch
3495 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3496 the search path but can't be used.
3497
3498 @item -Wlong-long
3499 @opindex Wlong-long
3500 @opindex Wno-long-long
3501 Warn if @samp{long long} type is used. This is default. To inhibit
3502 the warning messages, use @option{-Wno-long-long}. Flags
3503 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3504 only when @option{-pedantic} flag is used.
3505
3506 @item -Wvariadic-macros
3507 @opindex Wvariadic-macros
3508 @opindex Wno-variadic-macros
3509 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3510 alternate syntax when in pedantic ISO C99 mode. This is default.
3511 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3512
3513 @item -Wvolatile-register-var
3514 @opindex Wvolatile-register-var
3515 @opindex Wno-volatile-register-var
3516 Warn if a register variable is declared volatile. The volatile
3517 modifier does not inhibit all optimizations that may eliminate reads
3518 and/or writes to register variables.
3519
3520 @item -Wdisabled-optimization
3521 @opindex Wdisabled-optimization
3522 Warn if a requested optimization pass is disabled. This warning does
3523 not generally indicate that there is anything wrong with your code; it
3524 merely indicates that GCC's optimizers were unable to handle the code
3525 effectively. Often, the problem is that your code is too big or too
3526 complex; GCC will refuse to optimize programs when the optimization
3527 itself is likely to take inordinate amounts of time.
3528
3529 @item -Wpointer-sign
3530 @opindex Wpointer-sign
3531 @opindex Wno-pointer-sign
3532 Warn for pointer argument passing or assignment with different signedness.
3533 This option is only supported for C and Objective-C@. It is implied by
3534 @option{-Wall} and by @option{-pedantic}, which can be disabled with
3535 @option{-Wno-pointer-sign}.
3536
3537 @item -Werror
3538 @opindex Werror
3539 Make all warnings into errors.
3540
3541 @item -Werror=
3542 @opindex Werror=
3543 Make the specified warning into an errors. The specifier for a
3544 warning is appended, for example @option{-Werror=switch} turns the
3545 warnings controlled by @option{-Wswitch} into errors. This switch
3546 takes a negative form, to be used to negate @option{-Werror} for
3547 specific warnings, for example @option{-Wno-error=switch} makes
3548 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3549 is in effect. You can use the @option{-fdiagnostics-show-option}
3550 option to have each controllable warning amended with the option which
3551 controls it, to determine what to use with this option.
3552
3553 Note that specifying @option{-Werror=}@var{foo} automatically implies
3554 @option{-W}@var{foo}. However, @option{-Wno-error=}@var{foo} does not
3555 imply anything.
3556
3557 @item -Wstack-protector
3558 @opindex Wstack-protector
3559 This option is only active when @option{-fstack-protector} is active. It
3560 warns about functions that will not be protected against stack smashing.
3561
3562 @item -Wstring-literal-comparison
3563 @opindex Wstring-literal-comparison
3564 Warn about suspicious comparisons to string literal constants. In C,
3565 direct comparisons against the memory address of a string literal, such
3566 as @code{if (x == "abc")}, typically indicate a programmer error, and
3567 even when intentional, result in unspecified behavior and are not portable.
3568 Usually these warnings alert that the programmer intended to use
3569 @code{strcmp}. This warning is enabled by @option{-Wall}.
3570
3571 @item -Woverlength-strings
3572 @opindex Woverlength-strings
3573 Warn about string constants which are longer than the ``minimum
3574 maximum'' length specified in the C standard. Modern compilers
3575 generally allow string constants which are much longer than the
3576 standard's minimum limit, but very portable programs should avoid
3577 using longer strings.
3578
3579 The limit applies @emph{after} string constant concatenation, and does
3580 not count the trailing NUL@. In C89, the limit was 509 characters; in
3581 C99, it was raised to 4095. C++98 does not specify a normative
3582 minimum maximum, so we do not diagnose overlength strings in C++@.
3583
3584 This option is implied by @option{-pedantic}, and can be disabled with
3585 @option{-Wno-overlength-strings}.
3586 @end table
3587
3588 @node Debugging Options
3589 @section Options for Debugging Your Program or GCC
3590 @cindex options, debugging
3591 @cindex debugging information options
3592
3593 GCC has various special options that are used for debugging
3594 either your program or GCC:
3595
3596 @table @gcctabopt
3597 @item -g
3598 @opindex g
3599 Produce debugging information in the operating system's native format
3600 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
3601 information.
3602
3603 On most systems that use stabs format, @option{-g} enables use of extra
3604 debugging information that only GDB can use; this extra information
3605 makes debugging work better in GDB but will probably make other debuggers
3606 crash or
3607 refuse to read the program. If you want to control for certain whether
3608 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3609 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3610
3611 GCC allows you to use @option{-g} with
3612 @option{-O}. The shortcuts taken by optimized code may occasionally
3613 produce surprising results: some variables you declared may not exist
3614 at all; flow of control may briefly move where you did not expect it;
3615 some statements may not be executed because they compute constant
3616 results or their values were already at hand; some statements may
3617 execute in different places because they were moved out of loops.
3618
3619 Nevertheless it proves possible to debug optimized output. This makes
3620 it reasonable to use the optimizer for programs that might have bugs.
3621
3622 The following options are useful when GCC is generated with the
3623 capability for more than one debugging format.
3624
3625 @item -ggdb
3626 @opindex ggdb
3627 Produce debugging information for use by GDB@. This means to use the
3628 most expressive format available (DWARF 2, stabs, or the native format
3629 if neither of those are supported), including GDB extensions if at all
3630 possible.
3631
3632 @item -gstabs
3633 @opindex gstabs
3634 Produce debugging information in stabs format (if that is supported),
3635 without GDB extensions. This is the format used by DBX on most BSD
3636 systems. On MIPS, Alpha and System V Release 4 systems this option
3637 produces stabs debugging output which is not understood by DBX or SDB@.
3638 On System V Release 4 systems this option requires the GNU assembler.
3639
3640 @item -feliminate-unused-debug-symbols
3641 @opindex feliminate-unused-debug-symbols
3642 Produce debugging information in stabs format (if that is supported),
3643 for only symbols that are actually used.
3644
3645 @item -femit-class-debug-always
3646 Instead of emitting debugging information for a C++ class in only one
3647 object file, emit it in all object files using the class. This option
3648 should be used only with debuggers that are unable to handle the way GCC
3649 normally emits debugging information for classes because using this
3650 option will increase the size of debugging information by as much as a
3651 factor of two.
3652
3653 @item -gstabs+
3654 @opindex gstabs+
3655 Produce debugging information in stabs format (if that is supported),
3656 using GNU extensions understood only by the GNU debugger (GDB)@. The
3657 use of these extensions is likely to make other debuggers crash or
3658 refuse to read the program.
3659
3660 @item -gcoff
3661 @opindex gcoff
3662 Produce debugging information in COFF format (if that is supported).
3663 This is the format used by SDB on most System V systems prior to
3664 System V Release 4.
3665
3666 @item -gxcoff
3667 @opindex gxcoff
3668 Produce debugging information in XCOFF format (if that is supported).
3669 This is the format used by the DBX debugger on IBM RS/6000 systems.
3670
3671 @item -gxcoff+
3672 @opindex gxcoff+
3673 Produce debugging information in XCOFF format (if that is supported),
3674 using GNU extensions understood only by the GNU debugger (GDB)@. The
3675 use of these extensions is likely to make other debuggers crash or
3676 refuse to read the program, and may cause assemblers other than the GNU
3677 assembler (GAS) to fail with an error.
3678
3679 @item -gdwarf-2
3680 @opindex gdwarf-2
3681 Produce debugging information in DWARF version 2 format (if that is
3682 supported). This is the format used by DBX on IRIX 6. With this
3683 option, GCC uses features of DWARF version 3 when they are useful;
3684 version 3 is upward compatible with version 2, but may still cause
3685 problems for older debuggers.
3686
3687 @item -gvms
3688 @opindex gvms
3689 Produce debugging information in VMS debug format (if that is
3690 supported). This is the format used by DEBUG on VMS systems.
3691
3692 @item -g@var{level}
3693 @itemx -ggdb@var{level}
3694 @itemx -gstabs@var{level}
3695 @itemx -gcoff@var{level}
3696 @itemx -gxcoff@var{level}
3697 @itemx -gvms@var{level}
3698 Request debugging information and also use @var{level} to specify how
3699 much information. The default level is 2.
3700
3701 Level 0 produces no debug information at all. Thus, @option{-g0} negates
3702 @option{-g}.
3703
3704 Level 1 produces minimal information, enough for making backtraces in
3705 parts of the program that you don't plan to debug. This includes
3706 descriptions of functions and external variables, but no information
3707 about local variables and no line numbers.
3708
3709 Level 3 includes extra information, such as all the macro definitions
3710 present in the program. Some debuggers support macro expansion when
3711 you use @option{-g3}.
3712
3713 @option{-gdwarf-2} does not accept a concatenated debug level, because
3714 GCC used to support an option @option{-gdwarf} that meant to generate
3715 debug information in version 1 of the DWARF format (which is very
3716 different from version 2), and it would have been too confusing. That
3717 debug format is long obsolete, but the option cannot be changed now.
3718 Instead use an additional @option{-g@var{level}} option to change the
3719 debug level for DWARF2.
3720
3721 @item -feliminate-dwarf2-dups
3722 @opindex feliminate-dwarf2-dups
3723 Compress DWARF2 debugging information by eliminating duplicated
3724 information about each symbol. This option only makes sense when
3725 generating DWARF2 debugging information with @option{-gdwarf-2}.
3726
3727 @cindex @command{prof}
3728 @item -p
3729 @opindex p
3730 Generate extra code to write profile information suitable for the
3731 analysis program @command{prof}. You must use this option when compiling
3732 the source files you want data about, and you must also use it when
3733 linking.
3734
3735 @cindex @command{gprof}
3736 @item -pg
3737 @opindex pg
3738 Generate extra code to write profile information suitable for the
3739 analysis program @command{gprof}. You must use this option when compiling
3740 the source files you want data about, and you must also use it when
3741 linking.
3742
3743 @item -Q
3744 @opindex Q
3745 Makes the compiler print out each function name as it is compiled, and
3746 print some statistics about each pass when it finishes.
3747
3748 @item -ftime-report
3749 @opindex ftime-report
3750 Makes the compiler print some statistics about the time consumed by each
3751 pass when it finishes.
3752
3753 @item -fmem-report
3754 @opindex fmem-report
3755 Makes the compiler print some statistics about permanent memory
3756 allocation when it finishes.
3757
3758 @item -fpre-ipa-mem-report
3759 @opindex fpre-ipa-mem-report
3760 @item -fpost-ipa-mem-report
3761 @opindex fpost-ipa-mem-report
3762 Makes the compiler print some statistics about permanent memory
3763 allocation before or after interprocedural optimization.
3764
3765 @item -fprofile-arcs
3766 @opindex fprofile-arcs
3767 Add code so that program flow @dfn{arcs} are instrumented. During
3768 execution the program records how many times each branch and call is
3769 executed and how many times it is taken or returns. When the compiled
3770 program exits it saves this data to a file called
3771 @file{@var{auxname}.gcda} for each source file. The data may be used for
3772 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3773 test coverage analysis (@option{-ftest-coverage}). Each object file's
3774 @var{auxname} is generated from the name of the output file, if
3775 explicitly specified and it is not the final executable, otherwise it is
3776 the basename of the source file. In both cases any suffix is removed
3777 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3778 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3779 @xref{Cross-profiling}.
3780
3781 @cindex @command{gcov}
3782 @item --coverage
3783 @opindex coverage
3784
3785 This option is used to compile and link code instrumented for coverage
3786 analysis. The option is a synonym for @option{-fprofile-arcs}
3787 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3788 linking). See the documentation for those options for more details.
3789
3790 @itemize
3791
3792 @item
3793 Compile the source files with @option{-fprofile-arcs} plus optimization
3794 and code generation options. For test coverage analysis, use the
3795 additional @option{-ftest-coverage} option. You do not need to profile
3796 every source file in a program.
3797
3798 @item
3799 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3800 (the latter implies the former).
3801
3802 @item
3803 Run the program on a representative workload to generate the arc profile
3804 information. This may be repeated any number of times. You can run
3805 concurrent instances of your program, and provided that the file system
3806 supports locking, the data files will be correctly updated. Also
3807 @code{fork} calls are detected and correctly handled (double counting
3808 will not happen).
3809
3810 @item
3811 For profile-directed optimizations, compile the source files again with
3812 the same optimization and code generation options plus
3813 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3814 Control Optimization}).
3815
3816 @item
3817 For test coverage analysis, use @command{gcov} to produce human readable
3818 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3819 @command{gcov} documentation for further information.
3820
3821 @end itemize
3822
3823 With @option{-fprofile-arcs}, for each function of your program GCC
3824 creates a program flow graph, then finds a spanning tree for the graph.
3825 Only arcs that are not on the spanning tree have to be instrumented: the
3826 compiler adds code to count the number of times that these arcs are
3827 executed. When an arc is the only exit or only entrance to a block, the
3828 instrumentation code can be added to the block; otherwise, a new basic
3829 block must be created to hold the instrumentation code.
3830
3831 @need 2000
3832 @item -ftest-coverage
3833 @opindex ftest-coverage
3834 Produce a notes file that the @command{gcov} code-coverage utility
3835 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3836 show program coverage. Each source file's note file is called
3837 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3838 above for a description of @var{auxname} and instructions on how to
3839 generate test coverage data. Coverage data will match the source files
3840 more closely, if you do not optimize.
3841
3842 @item -d@var{letters}
3843 @item -fdump-rtl-@var{pass}
3844 @opindex d
3845 Says to make debugging dumps during compilation at times specified by
3846 @var{letters}. This is used for debugging the RTL-based passes of the
3847 compiler. The file names for most of the dumps are made by appending a
3848 pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3849 from the name of the output file, if explicitly specified and it is not
3850 an executable, otherwise it is the basename of the source file.
3851
3852 Most debug dumps can be enabled either passing a letter to the @option{-d}
3853 option, or with a long @option{-fdump-rtl} switch; here are the possible
3854 letters for use in @var{letters} and @var{pass}, and their meanings:
3855
3856 @table @gcctabopt
3857 @item -dA
3858 @opindex dA
3859 Annotate the assembler output with miscellaneous debugging information.
3860
3861 @item -dB
3862 @itemx -fdump-rtl-bbro
3863 @opindex dB
3864 @opindex fdump-rtl-bbro
3865 Dump after block reordering, to @file{@var{file}.148r.bbro}.
3866
3867 @item -dc
3868 @itemx -fdump-rtl-combine
3869 @opindex dc
3870 @opindex fdump-rtl-combine
3871 Dump after instruction combination, to the file @file{@var{file}.129r.combine}.
3872
3873 @item -dC
3874 @itemx -fdump-rtl-ce1
3875 @itemx -fdump-rtl-ce2
3876 @opindex dC
3877 @opindex fdump-rtl-ce1
3878 @opindex fdump-rtl-ce2
3879 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3880 first if conversion, to the file @file{@var{file}.117r.ce1}. @option{-dC}
3881 and @option{-fdump-rtl-ce2} enable dumping after the second if
3882 conversion, to the file @file{@var{file}.130r.ce2}.
3883
3884 @item -dd
3885 @itemx -fdump-rtl-btl
3886 @itemx -fdump-rtl-dbr
3887 @opindex dd
3888 @opindex fdump-rtl-btl
3889 @opindex fdump-rtl-dbr
3890 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3891 target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
3892 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3893 scheduling, to @file{@var{file}.36.dbr}.
3894
3895 @item -dD
3896 @opindex dD
3897 Dump all macro definitions, at the end of preprocessing, in addition to
3898 normal output.
3899
3900 @item -dE
3901 @itemx -fdump-rtl-ce3
3902 @opindex dE
3903 @opindex fdump-rtl-ce3
3904 Dump after the third if conversion, to @file{@var{file}.146r.ce3}.
3905
3906 @item -df
3907 @itemx -fdump-rtl-cfg
3908 @itemx -fdump-rtl-life
3909 @opindex df
3910 @opindex fdump-rtl-cfg
3911 @opindex fdump-rtl-life
3912 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3913 and data flow analysis, to @file{@var{file}.116r.cfg}. @option{-df}
3914 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3915 to @file{@var{file}.128r.life1} and @file{@var{file}.135r.life2}.
3916
3917 @item -dg
3918 @itemx -fdump-rtl-greg
3919 @opindex dg
3920 @opindex fdump-rtl-greg
3921 Dump after global register allocation, to @file{@var{file}.139r.greg}.
3922
3923 @item -dG
3924 @itemx -fdump-rtl-gcse
3925 @itemx -fdump-rtl-bypass
3926 @opindex dG
3927 @opindex fdump-rtl-gcse
3928 @opindex fdump-rtl-bypass
3929 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3930 @file{@var{file}.114r.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3931 enable dumping after jump bypassing and control flow optimizations, to
3932 @file{@var{file}.115r.bypass}.
3933
3934 @item -dh
3935 @itemx -fdump-rtl-eh
3936 @opindex dh
3937 @opindex fdump-rtl-eh
3938 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3939
3940 @item -di
3941 @itemx -fdump-rtl-sibling
3942 @opindex di
3943 @opindex fdump-rtl-sibling
3944 Dump after sibling call optimizations, to @file{@var{file}.106r.sibling}.
3945
3946 @item -dj
3947 @itemx -fdump-rtl-jump
3948 @opindex dj
3949 @opindex fdump-rtl-jump
3950 Dump after the first jump optimization, to @file{@var{file}.112r.jump}.
3951
3952 @item -dk
3953 @itemx -fdump-rtl-stack
3954 @opindex dk
3955 @opindex fdump-rtl-stack
3956 Dump after conversion from registers to stack, to @file{@var{file}.152r.stack}.
3957
3958 @item -dl
3959 @itemx -fdump-rtl-lreg
3960 @opindex dl
3961 @opindex fdump-rtl-lreg
3962 Dump after local register allocation, to @file{@var{file}.138r.lreg}.
3963
3964 @item -dL
3965 @itemx -fdump-rtl-loop2
3966 @opindex dL
3967 @opindex fdump-rtl-loop2
3968 @option{-dL} and @option{-fdump-rtl-loop2} enable dumping after the
3969 loop optimization pass, to @file{@var{file}.119r.loop2},
3970 @file{@var{file}.120r.loop2_init},
3971 @file{@var{file}.121r.loop2_invariant}, and
3972 @file{@var{file}.125r.loop2_done}.
3973
3974 @item -dm
3975 @itemx -fdump-rtl-sms
3976 @opindex dm
3977 @opindex fdump-rtl-sms
3978 Dump after modulo scheduling, to @file{@var{file}.136r.sms}.
3979
3980 @item -dM
3981 @itemx -fdump-rtl-mach
3982 @opindex dM
3983 @opindex fdump-rtl-mach
3984 Dump after performing the machine dependent reorganization pass, to
3985 @file{@var{file}.155r.mach}.
3986
3987 @item -dn
3988 @itemx -fdump-rtl-rnreg
3989 @opindex dn
3990 @opindex fdump-rtl-rnreg
3991 Dump after register renumbering, to @file{@var{file}.147r.rnreg}.
3992
3993 @item -dN
3994 @itemx -fdump-rtl-regmove
3995 @opindex dN
3996 @opindex fdump-rtl-regmove
3997 Dump after the register move pass, to @file{@var{file}.132r.regmove}.
3998
3999 @item -do
4000 @itemx -fdump-rtl-postreload
4001 @opindex do
4002 @opindex fdump-rtl-postreload
4003 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
4004
4005 @item -dr
4006 @itemx -fdump-rtl-expand
4007 @opindex dr
4008 @opindex fdump-rtl-expand
4009 Dump after RTL generation, to @file{@var{file}.104r.expand}.
4010
4011 @item -dR
4012 @itemx -fdump-rtl-sched2
4013 @opindex dR
4014 @opindex fdump-rtl-sched2
4015 Dump after the second scheduling pass, to @file{@var{file}.149r.sched2}.
4016
4017 @item -ds
4018 @itemx -fdump-rtl-cse
4019 @opindex ds
4020 @opindex fdump-rtl-cse
4021 Dump after CSE (including the jump optimization that sometimes follows
4022 CSE), to @file{@var{file}.113r.cse}.
4023
4024 @item -dS
4025 @itemx -fdump-rtl-sched1
4026 @opindex dS
4027 @opindex fdump-rtl-sched1
4028 Dump after the first scheduling pass, to @file{@var{file}.136r.sched1}.
4029
4030 @item -dt
4031 @itemx -fdump-rtl-cse2
4032 @opindex dt
4033 @opindex fdump-rtl-cse2
4034 Dump after the second CSE pass (including the jump optimization that
4035 sometimes follows CSE), to @file{@var{file}.127r.cse2}.
4036
4037 @item -dT
4038 @itemx -fdump-rtl-tracer
4039 @opindex dT
4040 @opindex fdump-rtl-tracer
4041 Dump after running tracer, to @file{@var{file}.118r.tracer}.
4042
4043 @item -dV
4044 @itemx -fdump-rtl-vpt
4045 @itemx -fdump-rtl-vartrack
4046 @opindex dV
4047 @opindex fdump-rtl-vpt
4048 @opindex fdump-rtl-vartrack
4049 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
4050 profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
4051 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
4052 to @file{@var{file}.154r.vartrack}.
4053
4054 @item -dw
4055 @itemx -fdump-rtl-flow2
4056 @opindex dw
4057 @opindex fdump-rtl-flow2
4058 Dump after the second flow pass, to @file{@var{file}.142r.flow2}.
4059
4060 @item -dz
4061 @itemx -fdump-rtl-peephole2
4062 @opindex dz
4063 @opindex fdump-rtl-peephole2
4064 Dump after the peephole pass, to @file{@var{file}.145r.peephole2}.
4065
4066 @item -dZ
4067 @itemx -fdump-rtl-web
4068 @opindex dZ
4069 @opindex fdump-rtl-web
4070 Dump after live range splitting, to @file{@var{file}.126r.web}.
4071
4072 @item -da
4073 @itemx -fdump-rtl-all
4074 @opindex da
4075 @opindex fdump-rtl-all
4076 Produce all the dumps listed above.
4077
4078 @item -dH
4079 @opindex dH
4080 Produce a core dump whenever an error occurs.
4081
4082 @item -dm
4083 @opindex dm
4084 Print statistics on memory usage, at the end of the run, to
4085 standard error.
4086
4087 @item -dp
4088 @opindex dp
4089 Annotate the assembler output with a comment indicating which
4090 pattern and alternative was used. The length of each instruction is
4091 also printed.
4092
4093 @item -dP
4094 @opindex dP
4095 Dump the RTL in the assembler output as a comment before each instruction.
4096 Also turns on @option{-dp} annotation.
4097
4098 @item -dv
4099 @opindex dv
4100 For each of the other indicated dump files (either with @option{-d} or
4101 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
4102 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
4103
4104 @item -dx
4105 @opindex dx
4106 Just generate RTL for a function instead of compiling it. Usually used
4107 with @samp{r} (@option{-fdump-rtl-expand}).
4108
4109 @item -dy
4110 @opindex dy
4111 Dump debugging information during parsing, to standard error.
4112 @end table
4113
4114 @item -fdump-noaddr
4115 @opindex fdump-noaddr
4116 When doing debugging dumps (see @option{-d} option above), suppress
4117 address output. This makes it more feasible to use diff on debugging
4118 dumps for compiler invocations with different compiler binaries and/or
4119 different text / bss / data / heap / stack / dso start locations.
4120
4121 @item -fdump-unnumbered
4122 @opindex fdump-unnumbered
4123 When doing debugging dumps (see @option{-d} option above), suppress instruction
4124 numbers, line number note and address output. This makes it more feasible to
4125 use diff on debugging dumps for compiler invocations with different
4126 options, in particular with and without @option{-g}.
4127
4128 @item -fdump-translation-unit @r{(C++ only)}
4129 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
4130 @opindex fdump-translation-unit
4131 Dump a representation of the tree structure for the entire translation
4132 unit to a file. The file name is made by appending @file{.tu} to the
4133 source file name. If the @samp{-@var{options}} form is used, @var{options}
4134 controls the details of the dump as described for the
4135 @option{-fdump-tree} options.
4136
4137 @item -fdump-class-hierarchy @r{(C++ only)}
4138 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
4139 @opindex fdump-class-hierarchy
4140 Dump a representation of each class's hierarchy and virtual function
4141 table layout to a file. The file name is made by appending @file{.class}
4142 to the source file name. If the @samp{-@var{options}} form is used,
4143 @var{options} controls the details of the dump as described for the
4144 @option{-fdump-tree} options.
4145
4146 @item -fdump-ipa-@var{switch}
4147 @opindex fdump-ipa
4148 Control the dumping at various stages of inter-procedural analysis
4149 language tree to a file. The file name is generated by appending a switch
4150 specific suffix to the source file name. The following dumps are possible:
4151
4152 @table @samp
4153 @item all
4154 Enables all inter-procedural analysis dumps; currently the only produced
4155 dump is the @samp{cgraph} dump.
4156
4157 @item cgraph
4158 Dumps information about call-graph optimization, unused function removal,
4159 and inlining decisions.
4160 @end table
4161
4162 @item -fdump-tree-@var{switch}
4163 @itemx -fdump-tree-@var{switch}-@var{options}
4164 @opindex fdump-tree
4165 Control the dumping at various stages of processing the intermediate
4166 language tree to a file. The file name is generated by appending a switch
4167 specific suffix to the source file name. If the @samp{-@var{options}}
4168 form is used, @var{options} is a list of @samp{-} separated options that
4169 control the details of the dump. Not all options are applicable to all
4170 dumps, those which are not meaningful will be ignored. The following
4171 options are available
4172
4173 @table @samp
4174 @item address
4175 Print the address of each node. Usually this is not meaningful as it
4176 changes according to the environment and source file. Its primary use
4177 is for tying up a dump file with a debug environment.
4178 @item slim
4179 Inhibit dumping of members of a scope or body of a function merely
4180 because that scope has been reached. Only dump such items when they
4181 are directly reachable by some other path. When dumping pretty-printed
4182 trees, this option inhibits dumping the bodies of control structures.
4183 @item raw
4184 Print a raw representation of the tree. By default, trees are
4185 pretty-printed into a C-like representation.
4186 @item details
4187 Enable more detailed dumps (not honored by every dump option).
4188 @item stats
4189 Enable dumping various statistics about the pass (not honored by every dump
4190 option).
4191 @item blocks
4192 Enable showing basic block boundaries (disabled in raw dumps).
4193 @item vops
4194 Enable showing virtual operands for every statement.
4195 @item lineno
4196 Enable showing line numbers for statements.
4197 @item uid
4198 Enable showing the unique ID (@code{DECL_UID}) for each variable.
4199 @item all
4200 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
4201 @end table
4202
4203 The following tree dumps are possible:
4204 @table @samp
4205
4206 @item original
4207 Dump before any tree based optimization, to @file{@var{file}.original}.
4208
4209 @item optimized
4210 Dump after all tree based optimization, to @file{@var{file}.optimized}.
4211
4212 @item inlined
4213 Dump after function inlining, to @file{@var{file}.inlined}.
4214
4215 @item gimple
4216 @opindex fdump-tree-gimple
4217 Dump each function before and after the gimplification pass to a file. The
4218 file name is made by appending @file{.gimple} to the source file name.
4219
4220 @item cfg
4221 @opindex fdump-tree-cfg
4222 Dump the control flow graph of each function to a file. The file name is
4223 made by appending @file{.cfg} to the source file name.
4224
4225 @item vcg
4226 @opindex fdump-tree-vcg
4227 Dump the control flow graph of each function to a file in VCG format. The
4228 file name is made by appending @file{.vcg} to the source file name. Note
4229 that if the file contains more than one function, the generated file cannot
4230 be used directly by VCG@. You will need to cut and paste each function's
4231 graph into its own separate file first.
4232
4233 @item ch
4234 @opindex fdump-tree-ch
4235 Dump each function after copying loop headers. The file name is made by
4236 appending @file{.ch} to the source file name.
4237
4238 @item ssa
4239 @opindex fdump-tree-ssa
4240 Dump SSA related information to a file. The file name is made by appending
4241 @file{.ssa} to the source file name.
4242
4243 @item salias
4244 @opindex fdump-tree-salias
4245 Dump structure aliasing variable information to a file. This file name
4246 is made by appending @file{.salias} to the source file name.
4247
4248 @item alias
4249 @opindex fdump-tree-alias
4250 Dump aliasing information for each function. The file name is made by
4251 appending @file{.alias} to the source file name.
4252
4253 @item ccp
4254 @opindex fdump-tree-ccp
4255 Dump each function after CCP@. The file name is made by appending
4256 @file{.ccp} to the source file name.
4257
4258 @item storeccp
4259 @opindex fdump-tree-storeccp
4260 Dump each function after STORE-CCP. The file name is made by appending
4261 @file{.storeccp} to the source file name.
4262
4263 @item pre
4264 @opindex fdump-tree-pre
4265 Dump trees after partial redundancy elimination. The file name is made
4266 by appending @file{.pre} to the source file name.
4267
4268 @item fre
4269 @opindex fdump-tree-fre
4270 Dump trees after full redundancy elimination. The file name is made
4271 by appending @file{.fre} to the source file name.
4272
4273 @item copyprop
4274 @opindex fdump-tree-copyprop
4275 Dump trees after copy propagation. The file name is made
4276 by appending @file{.copyprop} to the source file name.
4277
4278 @item store_copyprop
4279 @opindex fdump-tree-store_copyprop
4280 Dump trees after store copy-propagation. The file name is made
4281 by appending @file{.store_copyprop} to the source file name.
4282
4283 @item dce
4284 @opindex fdump-tree-dce
4285 Dump each function after dead code elimination. The file name is made by
4286 appending @file{.dce} to the source file name.
4287
4288 @item mudflap
4289 @opindex fdump-tree-mudflap
4290 Dump each function after adding mudflap instrumentation. The file name is
4291 made by appending @file{.mudflap} to the source file name.
4292
4293 @item sra
4294 @opindex fdump-tree-sra
4295 Dump each function after performing scalar replacement of aggregates. The
4296 file name is made by appending @file{.sra} to the source file name.
4297
4298 @item sink
4299 @opindex fdump-tree-sink
4300 Dump each function after performing code sinking. The file name is made
4301 by appending @file{.sink} to the source file name.
4302
4303 @item dom
4304 @opindex fdump-tree-dom
4305 Dump each function after applying dominator tree optimizations. The file
4306 name is made by appending @file{.dom} to the source file name.
4307
4308 @item dse
4309 @opindex fdump-tree-dse
4310 Dump each function after applying dead store elimination. The file
4311 name is made by appending @file{.dse} to the source file name.
4312
4313 @item phiopt
4314 @opindex fdump-tree-phiopt
4315 Dump each function after optimizing PHI nodes into straightline code. The file
4316 name is made by appending @file{.phiopt} to the source file name.
4317
4318 @item forwprop
4319 @opindex fdump-tree-forwprop
4320 Dump each function after forward propagating single use variables. The file
4321 name is made by appending @file{.forwprop} to the source file name.
4322
4323 @item copyrename
4324 @opindex fdump-tree-copyrename
4325 Dump each function after applying the copy rename optimization. The file
4326 name is made by appending @file{.copyrename} to the source file name.
4327
4328 @item nrv
4329 @opindex fdump-tree-nrv
4330 Dump each function after applying the named return value optimization on
4331 generic trees. The file name is made by appending @file{.nrv} to the source
4332 file name.
4333
4334 @item vect
4335 @opindex fdump-tree-vect
4336 Dump each function after applying vectorization of loops. The file name is
4337 made by appending @file{.vect} to the source file name.
4338
4339 @item vrp
4340 @opindex fdump-tree-vrp
4341 Dump each function after Value Range Propagation (VRP). The file name
4342 is made by appending @file{.vrp} to the source file name.
4343
4344 @item all
4345 @opindex fdump-tree-all
4346 Enable all the available tree dumps with the flags provided in this option.
4347 @end table
4348
4349 @item -ftree-vectorizer-verbose=@var{n}
4350 @opindex ftree-vectorizer-verbose
4351 This option controls the amount of debugging output the vectorizer prints.
4352 This information is written to standard error, unless
4353 @option{-fdump-tree-all} or @option{-fdump-tree-vect} is specified,
4354 in which case it is output to the usual dump listing file, @file{.vect}.
4355 For @var{n}=0 no diagnostic information is reported.
4356 If @var{n}=1 the vectorizer reports each loop that got vectorized,
4357 and the total number of loops that got vectorized.
4358 If @var{n}=2 the vectorizer also reports non-vectorized loops that passed
4359 the first analysis phase (vect_analyze_loop_form) - i.e. countable,
4360 inner-most, single-bb, single-entry/exit loops. This is the same verbosity
4361 level that @option{-fdump-tree-vect-stats} uses.
4362 Higher verbosity levels mean either more information dumped for each
4363 reported loop, or same amount of information reported for more loops:
4364 If @var{n}=3, alignment related information is added to the reports.
4365 If @var{n}=4, data-references related information (e.g. memory dependences,
4366 memory access-patterns) is added to the reports.
4367 If @var{n}=5, the vectorizer reports also non-vectorized inner-most loops
4368 that did not pass the first analysis phase (i.e. may not be countable, or
4369 may have complicated control-flow).
4370 If @var{n}=6, the vectorizer reports also non-vectorized nested loops.
4371 For @var{n}=7, all the information the vectorizer generates during its
4372 analysis and transformation is reported. This is the same verbosity level
4373 that @option{-fdump-tree-vect-details} uses.
4374
4375 @item -frandom-seed=@var{string}
4376 @opindex frandom-string
4377 This option provides a seed that GCC uses when it would otherwise use
4378 random numbers. It is used to generate certain symbol names
4379 that have to be different in every compiled file. It is also used to
4380 place unique stamps in coverage data files and the object files that
4381 produce them. You can use the @option{-frandom-seed} option to produce
4382 reproducibly identical object files.
4383
4384 The @var{string} should be different for every file you compile.
4385
4386 @item -fsched-verbose=@var{n}
4387 @opindex fsched-verbose
4388 On targets that use instruction scheduling, this option controls the
4389 amount of debugging output the scheduler prints. This information is
4390 written to standard error, unless @option{-dS} or @option{-dR} is
4391 specified, in which case it is output to the usual dump
4392 listing file, @file{.sched} or @file{.sched2} respectively. However
4393 for @var{n} greater than nine, the output is always printed to standard
4394 error.
4395
4396 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4397 same information as @option{-dRS}. For @var{n} greater than one, it
4398 also output basic block probabilities, detailed ready list information
4399 and unit/insn info. For @var{n} greater than two, it includes RTL
4400 at abort point, control-flow and regions info. And for @var{n} over
4401 four, @option{-fsched-verbose} also includes dependence info.
4402
4403 @item -save-temps
4404 @opindex save-temps
4405 Store the usual ``temporary'' intermediate files permanently; place them
4406 in the current directory and name them based on the source file. Thus,
4407 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4408 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4409 preprocessed @file{foo.i} output file even though the compiler now
4410 normally uses an integrated preprocessor.
4411
4412 When used in combination with the @option{-x} command line option,
4413 @option{-save-temps} is sensible enough to avoid over writing an
4414 input source file with the same extension as an intermediate file.
4415 The corresponding intermediate file may be obtained by renaming the
4416 source file before using @option{-save-temps}.
4417
4418 @item -time
4419 @opindex time
4420 Report the CPU time taken by each subprocess in the compilation
4421 sequence. For C source files, this is the compiler proper and assembler
4422 (plus the linker if linking is done). The output looks like this:
4423
4424 @smallexample
4425 # cc1 0.12 0.01
4426 # as 0.00 0.01
4427 @end smallexample
4428
4429 The first number on each line is the ``user time'', that is time spent
4430 executing the program itself. The second number is ``system time'',
4431 time spent executing operating system routines on behalf of the program.
4432 Both numbers are in seconds.
4433
4434 @item -fvar-tracking
4435 @opindex fvar-tracking
4436 Run variable tracking pass. It computes where variables are stored at each
4437 position in code. Better debugging information is then generated
4438 (if the debugging information format supports this information).
4439
4440 It is enabled by default when compiling with optimization (@option{-Os},
4441 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4442 the debug info format supports it.
4443
4444 @item -print-file-name=@var{library}
4445 @opindex print-file-name
4446 Print the full absolute name of the library file @var{library} that
4447 would be used when linking---and don't do anything else. With this
4448 option, GCC does not compile or link anything; it just prints the
4449 file name.
4450
4451 @item -print-multi-directory
4452 @opindex print-multi-directory
4453 Print the directory name corresponding to the multilib selected by any
4454 other switches present in the command line. This directory is supposed
4455 to exist in @env{GCC_EXEC_PREFIX}.
4456
4457 @item -print-multi-lib
4458 @opindex print-multi-lib
4459 Print the mapping from multilib directory names to compiler switches
4460 that enable them. The directory name is separated from the switches by
4461 @samp{;}, and each switch starts with an @samp{@@} instead of the
4462 @samp{-}, without spaces between multiple switches. This is supposed to
4463 ease shell-processing.
4464
4465 @item -print-prog-name=@var{program}
4466 @opindex print-prog-name
4467 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4468
4469 @item -print-libgcc-file-name
4470 @opindex print-libgcc-file-name
4471 Same as @option{-print-file-name=libgcc.a}.
4472
4473 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4474 but you do want to link with @file{libgcc.a}. You can do
4475
4476 @smallexample
4477 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4478 @end smallexample
4479
4480 @item -print-search-dirs
4481 @opindex print-search-dirs
4482 Print the name of the configured installation directory and a list of
4483 program and library directories @command{gcc} will search---and don't do anything else.
4484
4485 This is useful when @command{gcc} prints the error message
4486 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4487 To resolve this you either need to put @file{cpp0} and the other compiler
4488 components where @command{gcc} expects to find them, or you can set the environment
4489 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4490 Don't forget the trailing @samp{/}.
4491 @xref{Environment Variables}.
4492
4493 @item -dumpmachine
4494 @opindex dumpmachine
4495 Print the compiler's target machine (for example,
4496 @samp{i686-pc-linux-gnu})---and don't do anything else.
4497
4498 @item -dumpversion
4499 @opindex dumpversion
4500 Print the compiler version (for example, @samp{3.0})---and don't do
4501 anything else.
4502
4503 @item -dumpspecs
4504 @opindex dumpspecs
4505 Print the compiler's built-in specs---and don't do anything else. (This
4506 is used when GCC itself is being built.) @xref{Spec Files}.
4507
4508 @item -feliminate-unused-debug-types
4509 @opindex feliminate-unused-debug-types
4510 Normally, when producing DWARF2 output, GCC will emit debugging
4511 information for all types declared in a compilation
4512 unit, regardless of whether or not they are actually used
4513 in that compilation unit. Sometimes this is useful, such as
4514 if, in the debugger, you want to cast a value to a type that is
4515 not actually used in your program (but is declared). More often,
4516 however, this results in a significant amount of wasted space.
4517 With this option, GCC will avoid producing debug symbol output
4518 for types that are nowhere used in the source file being compiled.
4519 @end table
4520
4521 @node Optimize Options
4522 @section Options That Control Optimization
4523 @cindex optimize options
4524 @cindex options, optimization
4525
4526 These options control various sorts of optimizations.
4527
4528 Without any optimization option, the compiler's goal is to reduce the
4529 cost of compilation and to make debugging produce the expected
4530 results. Statements are independent: if you stop the program with a
4531 breakpoint between statements, you can then assign a new value to any
4532 variable or change the program counter to any other statement in the
4533 function and get exactly the results you would expect from the source
4534 code.
4535
4536 Turning on optimization flags makes the compiler attempt to improve
4537 the performance and/or code size at the expense of compilation time
4538 and possibly the ability to debug the program.
4539
4540 The compiler performs optimization based on the knowledge it has of
4541 the program. Optimization levels @option{-O} and above, in
4542 particular, enable @emph{unit-at-a-time} mode, which allows the
4543 compiler to consider information gained from later functions in
4544 the file when compiling a function. Compiling multiple files at
4545 once to a single output file in @emph{unit-at-a-time} mode allows
4546 the compiler to use information gained from all of the files when
4547 compiling each of them.
4548
4549 Not all optimizations are controlled directly by a flag. Only
4550 optimizations that have a flag are listed.
4551
4552 @table @gcctabopt
4553 @item -O
4554 @itemx -O1
4555 @opindex O
4556 @opindex O1
4557 Optimize. Optimizing compilation takes somewhat more time, and a lot
4558 more memory for a large function.
4559
4560 With @option{-O}, the compiler tries to reduce code size and execution
4561 time, without performing any optimizations that take a great deal of
4562 compilation time.
4563
4564 @option{-O} turns on the following optimization flags:
4565 @gccoptlist{-fdefer-pop @gol
4566 -fdelayed-branch @gol
4567 -fguess-branch-probability @gol
4568 -fcprop-registers @gol
4569 -fif-conversion @gol
4570 -fif-conversion2 @gol
4571 -ftree-ccp @gol
4572 -ftree-dce @gol
4573 -ftree-dominator-opts @gol
4574 -ftree-dse @gol
4575 -ftree-ter @gol
4576 -ftree-lrs @gol
4577 -ftree-sra @gol
4578 -ftree-copyrename @gol
4579 -ftree-fre @gol
4580 -ftree-ch @gol
4581 -funit-at-a-time @gol
4582 -fmerge-constants}
4583
4584 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4585 where doing so does not interfere with debugging.
4586
4587 @item -O2
4588 @opindex O2
4589 Optimize even more. GCC performs nearly all supported optimizations
4590 that do not involve a space-speed tradeoff. The compiler does not
4591 perform loop unrolling or function inlining when you specify @option{-O2}.
4592 As compared to @option{-O}, this option increases both compilation time
4593 and the performance of the generated code.
4594
4595 @option{-O2} turns on all optimization flags specified by @option{-O}. It
4596 also turns on the following optimization flags:
4597 @gccoptlist{-fthread-jumps @gol
4598 -fcrossjumping @gol
4599 -foptimize-sibling-calls @gol
4600 -fcse-follow-jumps -fcse-skip-blocks @gol
4601 -fgcse -fgcse-lm @gol
4602 -fexpensive-optimizations @gol
4603 -frerun-cse-after-loop @gol
4604 -fcaller-saves @gol
4605 -fpeephole2 @gol
4606 -fschedule-insns -fschedule-insns2 @gol
4607 -fsched-interblock -fsched-spec @gol
4608 -fregmove @gol
4609 -fstrict-aliasing @gol
4610 -fdelete-null-pointer-checks @gol
4611 -freorder-blocks -freorder-functions @gol
4612 -falign-functions -falign-jumps @gol
4613 -falign-loops -falign-labels @gol
4614 -ftree-vrp @gol
4615 -ftree-pre}
4616
4617 Please note the warning under @option{-fgcse} about
4618 invoking @option{-O2} on programs that use computed gotos.
4619
4620 @item -O3
4621 @opindex O3
4622 Optimize yet more. @option{-O3} turns on all optimizations specified by
4623 @option{-O2} and also turns on the @option{-finline-functions},
4624 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4625
4626 @item -O0
4627 @opindex O0
4628 Reduce compilation time and make debugging produce the expected
4629 results. This is the default.
4630
4631 @item -Os
4632 @opindex Os
4633 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
4634 do not typically increase code size. It also performs further
4635 optimizations designed to reduce code size.
4636
4637 @option{-Os} disables the following optimization flags:
4638 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
4639 -falign-labels -freorder-blocks -freorder-blocks-and-partition @gol
4640 -fprefetch-loop-arrays -ftree-vect-loop-version}
4641
4642 If you use multiple @option{-O} options, with or without level numbers,
4643 the last such option is the one that is effective.
4644 @end table
4645
4646 Options of the form @option{-f@var{flag}} specify machine-independent
4647 flags. Most flags have both positive and negative forms; the negative
4648 form of @option{-ffoo} would be @option{-fno-foo}. In the table
4649 below, only one of the forms is listed---the one you typically will
4650 use. You can figure out the other form by either removing @samp{no-}
4651 or adding it.
4652
4653 The following options control specific optimizations. They are either
4654 activated by @option{-O} options or are related to ones that are. You
4655 can use the following flags in the rare cases when ``fine-tuning'' of
4656 optimizations to be performed is desired.
4657
4658 @table @gcctabopt
4659 @item -fno-default-inline
4660 @opindex fno-default-inline
4661 Do not make member functions inline by default merely because they are
4662 defined inside the class scope (C++ only). Otherwise, when you specify
4663 @w{@option{-O}}, member functions defined inside class scope are compiled
4664 inline by default; i.e., you don't need to add @samp{inline} in front of
4665 the member function name.
4666
4667 @item -fno-defer-pop
4668 @opindex fno-defer-pop
4669 Always pop the arguments to each function call as soon as that function
4670 returns. For machines which must pop arguments after a function call,
4671 the compiler normally lets arguments accumulate on the stack for several
4672 function calls and pops them all at once.
4673
4674 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4675
4676 @item -fforce-addr
4677 @opindex fforce-addr
4678 Force memory address constants to be copied into registers before
4679 doing arithmetic on them.
4680
4681 @item -fforward-propagate
4682 @opindex fforward-propagate
4683 Perform a forward propagation pass on RTL. The pass tries to combine two
4684 instructions and checks if the result can be simplified. If loop unrolling
4685 is active, two passes are performed and the second is scheduled after
4686 loop unrolling.
4687
4688 This option is enabled by default at optimization levels @option{-O2},
4689 @option{-O3}, @option{-Os}.
4690
4691 @item -fomit-frame-pointer
4692 @opindex fomit-frame-pointer
4693 Don't keep the frame pointer in a register for functions that
4694 don't need one. This avoids the instructions to save, set up and
4695 restore frame pointers; it also makes an extra register available
4696 in many functions. @strong{It also makes debugging impossible on
4697 some machines.}
4698
4699 On some machines, such as the VAX, this flag has no effect, because
4700 the standard calling sequence automatically handles the frame pointer
4701 and nothing is saved by pretending it doesn't exist. The
4702 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4703 whether a target machine supports this flag. @xref{Registers,,Register
4704 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4705
4706 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4707
4708 @item -foptimize-sibling-calls
4709 @opindex foptimize-sibling-calls
4710 Optimize sibling and tail recursive calls.
4711
4712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4713
4714 @item -fno-inline
4715 @opindex fno-inline
4716 Don't pay attention to the @code{inline} keyword. Normally this option
4717 is used to keep the compiler from expanding any functions inline.
4718 Note that if you are not optimizing, no functions can be expanded inline.
4719
4720 @item -finline-functions
4721 @opindex finline-functions
4722 Integrate all simple functions into their callers. The compiler
4723 heuristically decides which functions are simple enough to be worth
4724 integrating in this way.
4725
4726 If all calls to a given function are integrated, and the function is
4727 declared @code{static}, then the function is normally not output as
4728 assembler code in its own right.
4729
4730 Enabled at level @option{-O3}.
4731
4732 @item -finline-functions-called-once
4733 @opindex finline-functions-called-once
4734 Consider all @code{static} functions called once for inlining into their
4735 caller even if they are not marked @code{inline}. If a call to a given
4736 function is integrated, then the function is not output as assembler code
4737 in its own right.
4738
4739 Enabled if @option{-funit-at-a-time} is enabled.
4740
4741 @item -fearly-inlining
4742 @opindex fearly-inlining
4743 Inline functions marked by @code{always_inline} and functions whose body seems
4744 smaller than the function call overhead early before doing
4745 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
4746 makes profiling significantly cheaper and usually inlining faster on programs
4747 having large chains of nested wrapper functions.
4748
4749 Enabled by default.
4750
4751 @item -finline-limit=@var{n}
4752 @opindex finline-limit
4753 By default, GCC limits the size of functions that can be inlined. This flag
4754 allows the control of this limit for functions that are explicitly marked as
4755 inline (i.e., marked with the inline keyword or defined within the class
4756 definition in c++). @var{n} is the size of functions that can be inlined in
4757 number of pseudo instructions (not counting parameter handling). The default
4758 value of @var{n} is 600.
4759 Increasing this value can result in more inlined code at
4760 the cost of compilation time and memory consumption. Decreasing usually makes
4761 the compilation faster and less code will be inlined (which presumably
4762 means slower programs). This option is particularly useful for programs that
4763 use inlining heavily such as those based on recursive templates with C++.
4764
4765 Inlining is actually controlled by a number of parameters, which may be
4766 specified individually by using @option{--param @var{name}=@var{value}}.
4767 The @option{-finline-limit=@var{n}} option sets some of these parameters
4768 as follows:
4769
4770 @table @gcctabopt
4771 @item max-inline-insns-single
4772 is set to @var{n}/2.
4773 @item max-inline-insns-auto
4774 is set to @var{n}/2.
4775 @item min-inline-insns
4776 is set to 130 or @var{n}/4, whichever is smaller.
4777 @item max-inline-insns-rtl
4778 is set to @var{n}.
4779 @end table
4780
4781 See below for a documentation of the individual
4782 parameters controlling inlining.
4783
4784 @emph{Note:} pseudo instruction represents, in this particular context, an
4785 abstract measurement of function's size. In no way does it represent a count
4786 of assembly instructions and as such its exact meaning might change from one
4787 release to an another.
4788
4789 @item -fkeep-inline-functions
4790 @opindex fkeep-inline-functions
4791 In C, emit @code{static} functions that are declared @code{inline}
4792 into the object file, even if the function has been inlined into all
4793 of its callers. This switch does not affect functions using the
4794 @code{extern inline} extension in GNU C89@. In C++, emit any and all
4795 inline functions into the object file.
4796
4797 @item -fkeep-static-consts
4798 @opindex fkeep-static-consts
4799 Emit variables declared @code{static const} when optimization isn't turned
4800 on, even if the variables aren't referenced.
4801
4802 GCC enables this option by default. If you want to force the compiler to
4803 check if the variable was referenced, regardless of whether or not
4804 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4805
4806 @item -fmerge-constants
4807 Attempt to merge identical constants (string constants and floating point
4808 constants) across compilation units.
4809
4810 This option is the default for optimized compilation if the assembler and
4811 linker support it. Use @option{-fno-merge-constants} to inhibit this
4812 behavior.
4813
4814 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4815
4816 @item -fmerge-all-constants
4817 Attempt to merge identical constants and identical variables.
4818
4819 This option implies @option{-fmerge-constants}. In addition to
4820 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4821 arrays or initialized constant variables with integral or floating point
4822 types. Languages like C or C++ require each non-automatic variable to
4823 have distinct location, so using this option will result in non-conforming
4824 behavior.
4825
4826 @item -fmodulo-sched
4827 @opindex fmodulo-sched
4828 Perform swing modulo scheduling immediately before the first scheduling
4829 pass. This pass looks at innermost loops and reorders their
4830 instructions by overlapping different iterations.
4831
4832 @item -fno-branch-count-reg
4833 @opindex fno-branch-count-reg
4834 Do not use ``decrement and branch'' instructions on a count register,
4835 but instead generate a sequence of instructions that decrement a
4836 register, compare it against zero, then branch based upon the result.
4837 This option is only meaningful on architectures that support such
4838 instructions, which include x86, PowerPC, IA-64 and S/390.
4839
4840 The default is @option{-fbranch-count-reg}.
4841
4842 @item -fno-function-cse
4843 @opindex fno-function-cse
4844 Do not put function addresses in registers; make each instruction that
4845 calls a constant function contain the function's address explicitly.
4846
4847 This option results in less efficient code, but some strange hacks
4848 that alter the assembler output may be confused by the optimizations
4849 performed when this option is not used.
4850
4851 The default is @option{-ffunction-cse}
4852
4853 @item -fno-zero-initialized-in-bss
4854 @opindex fno-zero-initialized-in-bss
4855 If the target supports a BSS section, GCC by default puts variables that
4856 are initialized to zero into BSS@. This can save space in the resulting
4857 code.
4858
4859 This option turns off this behavior because some programs explicitly
4860 rely on variables going to the data section. E.g., so that the
4861 resulting executable can find the beginning of that section and/or make
4862 assumptions based on that.
4863
4864 The default is @option{-fzero-initialized-in-bss}.
4865
4866 @item -fbounds-check
4867 @opindex fbounds-check
4868 For front-ends that support it, generate additional code to check that
4869 indices used to access arrays are within the declared range. This is
4870 currently only supported by the Java and Fortran front-ends, where
4871 this option defaults to true and false respectively.
4872
4873 @item -fmudflap -fmudflapth -fmudflapir
4874 @opindex fmudflap
4875 @opindex fmudflapth
4876 @opindex fmudflapir
4877 @cindex bounds checking
4878 @cindex mudflap
4879 For front-ends that support it (C and C++), instrument all risky
4880 pointer/array dereferencing operations, some standard library
4881 string/heap functions, and some other associated constructs with
4882 range/validity tests. Modules so instrumented should be immune to
4883 buffer overflows, invalid heap use, and some other classes of C/C++
4884 programming errors. The instrumentation relies on a separate runtime
4885 library (@file{libmudflap}), which will be linked into a program if
4886 @option{-fmudflap} is given at link time. Run-time behavior of the
4887 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4888 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4889 for its options.
4890
4891 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4892 link if your program is multi-threaded. Use @option{-fmudflapir}, in
4893 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4894 instrumentation should ignore pointer reads. This produces less
4895 instrumentation (and therefore faster execution) and still provides
4896 some protection against outright memory corrupting writes, but allows
4897 erroneously read data to propagate within a program.
4898
4899 @item -fthread-jumps
4900 @opindex fthread-jumps
4901 Perform optimizations where we check to see if a jump branches to a
4902 location where another comparison subsumed by the first is found. If
4903 so, the first branch is redirected to either the destination of the
4904 second branch or a point immediately following it, depending on whether
4905 the condition is known to be true or false.
4906
4907 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4908
4909 @item -fcse-follow-jumps
4910 @opindex fcse-follow-jumps
4911 In common subexpression elimination, scan through jump instructions
4912 when the target of the jump is not reached by any other path. For
4913 example, when CSE encounters an @code{if} statement with an
4914 @code{else} clause, CSE will follow the jump when the condition
4915 tested is false.
4916
4917 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4918
4919 @item -fcse-skip-blocks
4920 @opindex fcse-skip-blocks
4921 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4922 follow jumps which conditionally skip over blocks. When CSE
4923 encounters a simple @code{if} statement with no else clause,
4924 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4925 body of the @code{if}.
4926
4927 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4928
4929 @item -frerun-cse-after-loop
4930 @opindex frerun-cse-after-loop
4931 Re-run common subexpression elimination after loop optimizations has been
4932 performed.
4933
4934 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4935
4936 @item -fgcse
4937 @opindex fgcse
4938 Perform a global common subexpression elimination pass.
4939 This pass also performs global constant and copy propagation.
4940
4941 @emph{Note:} When compiling a program using computed gotos, a GCC
4942 extension, you may get better runtime performance if you disable
4943 the global common subexpression elimination pass by adding
4944 @option{-fno-gcse} to the command line.
4945
4946 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4947
4948 @item -fgcse-lm
4949 @opindex fgcse-lm
4950 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4951 attempt to move loads which are only killed by stores into themselves. This
4952 allows a loop containing a load/store sequence to be changed to a load outside
4953 the loop, and a copy/store within the loop.
4954
4955 Enabled by default when gcse is enabled.
4956
4957 @item -fgcse-sm
4958 @opindex fgcse-sm
4959 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4960 global common subexpression elimination. This pass will attempt to move
4961 stores out of loops. When used in conjunction with @option{-fgcse-lm},
4962 loops containing a load/store sequence can be changed to a load before
4963 the loop and a store after the loop.
4964
4965 Not enabled at any optimization level.
4966
4967 @item -fgcse-las
4968 @opindex fgcse-las
4969 When @option{-fgcse-las} is enabled, the global common subexpression
4970 elimination pass eliminates redundant loads that come after stores to the
4971 same memory location (both partial and full redundancies).
4972
4973 Not enabled at any optimization level.
4974
4975 @item -fgcse-after-reload
4976 @opindex fgcse-after-reload
4977 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4978 pass is performed after reload. The purpose of this pass is to cleanup
4979 redundant spilling.
4980
4981 @item -funsafe-loop-optimizations
4982 @opindex funsafe-loop-optimizations
4983 If given, the loop optimizer will assume that loop indices do not
4984 overflow, and that the loops with nontrivial exit condition are not
4985 infinite. This enables a wider range of loop optimizations even if
4986 the loop optimizer itself cannot prove that these assumptions are valid.
4987 Using @option{-Wunsafe-loop-optimizations}, the compiler will warn you
4988 if it finds this kind of loop.
4989
4990 @item -fcrossjumping
4991 @opindex crossjumping
4992 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4993 resulting code may or may not perform better than without cross-jumping.
4994
4995 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4996
4997 @item -fif-conversion
4998 @opindex if-conversion
4999 Attempt to transform conditional jumps into branch-less equivalents. This
5000 include use of conditional moves, min, max, set flags and abs instructions, and
5001 some tricks doable by standard arithmetics. The use of conditional execution
5002 on chips where it is available is controlled by @code{if-conversion2}.
5003
5004 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5005
5006 @item -fif-conversion2
5007 @opindex if-conversion2
5008 Use conditional execution (where available) to transform conditional jumps into
5009 branch-less equivalents.
5010
5011 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5012
5013 @item -fdelete-null-pointer-checks
5014 @opindex fdelete-null-pointer-checks
5015 Use global dataflow analysis to identify and eliminate useless checks
5016 for null pointers. The compiler assumes that dereferencing a null
5017 pointer would have halted the program. If a pointer is checked after
5018 it has already been dereferenced, it cannot be null.
5019
5020 In some environments, this assumption is not true, and programs can
5021 safely dereference null pointers. Use
5022 @option{-fno-delete-null-pointer-checks} to disable this optimization
5023 for programs which depend on that behavior.
5024
5025 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5026
5027 @item -fexpensive-optimizations
5028 @opindex fexpensive-optimizations
5029 Perform a number of minor optimizations that are relatively expensive.
5030
5031 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5032
5033 @item -foptimize-register-move
5034 @itemx -fregmove
5035 @opindex foptimize-register-move
5036 @opindex fregmove
5037 Attempt to reassign register numbers in move instructions and as
5038 operands of other simple instructions in order to maximize the amount of
5039 register tying. This is especially helpful on machines with two-operand
5040 instructions.
5041
5042 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
5043 optimization.
5044
5045 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5046
5047 @item -fdelayed-branch
5048 @opindex fdelayed-branch
5049 If supported for the target machine, attempt to reorder instructions
5050 to exploit instruction slots available after delayed branch
5051 instructions.
5052
5053 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5054
5055 @item -fschedule-insns
5056 @opindex fschedule-insns
5057 If supported for the target machine, attempt to reorder instructions to
5058 eliminate execution stalls due to required data being unavailable. This
5059 helps machines that have slow floating point or memory load instructions
5060 by allowing other instructions to be issued until the result of the load
5061 or floating point instruction is required.
5062
5063 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5064
5065 @item -fschedule-insns2
5066 @opindex fschedule-insns2
5067 Similar to @option{-fschedule-insns}, but requests an additional pass of
5068 instruction scheduling after register allocation has been done. This is
5069 especially useful on machines with a relatively small number of
5070 registers and where memory load instructions take more than one cycle.
5071
5072 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5073
5074 @item -fno-sched-interblock
5075 @opindex fno-sched-interblock
5076 Don't schedule instructions across basic blocks. This is normally
5077 enabled by default when scheduling before register allocation, i.e.@:
5078 with @option{-fschedule-insns} or at @option{-O2} or higher.
5079
5080 @item -fno-sched-spec
5081 @opindex fno-sched-spec
5082 Don't allow speculative motion of non-load instructions. This is normally
5083 enabled by default when scheduling before register allocation, i.e.@:
5084 with @option{-fschedule-insns} or at @option{-O2} or higher.
5085
5086 @item -fsched-spec-load
5087 @opindex fsched-spec-load
5088 Allow speculative motion of some load instructions. This only makes
5089 sense when scheduling before register allocation, i.e.@: with
5090 @option{-fschedule-insns} or at @option{-O2} or higher.
5091
5092 @item -fsched-spec-load-dangerous
5093 @opindex fsched-spec-load-dangerous
5094 Allow speculative motion of more load instructions. This only makes
5095 sense when scheduling before register allocation, i.e.@: with
5096 @option{-fschedule-insns} or at @option{-O2} or higher.
5097
5098 @item -fsched-stalled-insns=@var{n}
5099 @opindex fsched-stalled-insns
5100 Define how many insns (if any) can be moved prematurely from the queue
5101 of stalled insns into the ready list, during the second scheduling pass.
5102
5103 @item -fsched-stalled-insns-dep=@var{n}
5104 @opindex fsched-stalled-insns-dep
5105 Define how many insn groups (cycles) will be examined for a dependency
5106 on a stalled insn that is candidate for premature removal from the queue
5107 of stalled insns. Has an effect only during the second scheduling pass,
5108 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
5109
5110 @item -fsched2-use-superblocks
5111 @opindex fsched2-use-superblocks
5112 When scheduling after register allocation, do use superblock scheduling
5113 algorithm. Superblock scheduling allows motion across basic block boundaries
5114 resulting on faster schedules. This option is experimental, as not all machine
5115 descriptions used by GCC model the CPU closely enough to avoid unreliable
5116 results from the algorithm.
5117
5118 This only makes sense when scheduling after register allocation, i.e.@: with
5119 @option{-fschedule-insns2} or at @option{-O2} or higher.
5120
5121 @item -fsched2-use-traces
5122 @opindex fsched2-use-traces
5123 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
5124 allocation and additionally perform code duplication in order to increase the
5125 size of superblocks using tracer pass. See @option{-ftracer} for details on
5126 trace formation.
5127
5128 This mode should produce faster but significantly longer programs. Also
5129 without @option{-fbranch-probabilities} the traces constructed may not
5130 match the reality and hurt the performance. This only makes
5131 sense when scheduling after register allocation, i.e.@: with
5132 @option{-fschedule-insns2} or at @option{-O2} or higher.
5133
5134 @item -fsee
5135 @opindex fsee
5136 Eliminates redundant extension instructions and move the non redundant
5137 ones to optimal placement using LCM.
5138
5139 @item -freschedule-modulo-scheduled-loops
5140 @opindex fscheduling-in-modulo-scheduled-loops
5141 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
5142 we may want to prevent the later scheduling passes from changing its schedule, we use this
5143 option to control that.
5144
5145 @item -fcaller-saves
5146 @opindex fcaller-saves
5147 Enable values to be allocated in registers that will be clobbered by
5148 function calls, by emitting extra instructions to save and restore the
5149 registers around such calls. Such allocation is done only when it
5150 seems to result in better code than would otherwise be produced.
5151
5152 This option is always enabled by default on certain machines, usually
5153 those which have no call-preserved registers to use instead.
5154
5155 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5156
5157 @item -ftree-pre
5158 Perform Partial Redundancy Elimination (PRE) on trees. This flag is
5159 enabled by default at @option{-O2} and @option{-O3}.
5160
5161 @item -ftree-fre
5162 Perform Full Redundancy Elimination (FRE) on trees. The difference
5163 between FRE and PRE is that FRE only considers expressions
5164 that are computed on all paths leading to the redundant computation.
5165 This analysis faster than PRE, though it exposes fewer redundancies.
5166 This flag is enabled by default at @option{-O} and higher.
5167
5168 @item -ftree-copy-prop
5169 Perform copy propagation on trees. This pass eliminates unnecessary
5170 copy operations. This flag is enabled by default at @option{-O} and
5171 higher.
5172
5173 @item -ftree-store-copy-prop
5174 Perform copy propagation of memory loads and stores. This pass
5175 eliminates unnecessary copy operations in memory references
5176 (structures, global variables, arrays, etc). This flag is enabled by
5177 default at @option{-O2} and higher.
5178
5179 @item -ftree-salias
5180 Perform structural alias analysis on trees. This flag
5181 is enabled by default at @option{-O} and higher.
5182
5183 @item -fipa-pta
5184 Perform interprocedural pointer analysis.
5185
5186 @item -ftree-sink
5187 Perform forward store motion on trees. This flag is
5188 enabled by default at @option{-O} and higher.
5189
5190 @item -ftree-ccp
5191 Perform sparse conditional constant propagation (CCP) on trees. This
5192 pass only operates on local scalar variables and is enabled by default
5193 at @option{-O} and higher.
5194
5195 @item -ftree-store-ccp
5196 Perform sparse conditional constant propagation (CCP) on trees. This
5197 pass operates on both local scalar variables and memory stores and
5198 loads (global variables, structures, arrays, etc). This flag is
5199 enabled by default at @option{-O2} and higher.
5200
5201 @item -ftree-dce
5202 Perform dead code elimination (DCE) on trees. This flag is enabled by
5203 default at @option{-O} and higher.
5204
5205 @item -ftree-dominator-opts
5206 Perform a variety of simple scalar cleanups (constant/copy
5207 propagation, redundancy elimination, range propagation and expression
5208 simplification) based on a dominator tree traversal. This also
5209 performs jump threading (to reduce jumps to jumps). This flag is
5210 enabled by default at @option{-O} and higher.
5211
5212 @item -ftree-ch
5213 Perform loop header copying on trees. This is beneficial since it increases
5214 effectiveness of code motion optimizations. It also saves one jump. This flag
5215 is enabled by default at @option{-O} and higher. It is not enabled
5216 for @option{-Os}, since it usually increases code size.
5217
5218 @item -ftree-loop-optimize
5219 Perform loop optimizations on trees. This flag is enabled by default
5220 at @option{-O} and higher.
5221
5222 @item -ftree-loop-linear
5223 Perform linear loop transformations on tree. This flag can improve cache
5224 performance and allow further loop optimizations to take place.
5225
5226 @item -ftree-loop-im
5227 Perform loop invariant motion on trees. This pass moves only invariants that
5228 would be hard to handle at RTL level (function calls, operations that expand to
5229 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
5230 operands of conditions that are invariant out of the loop, so that we can use
5231 just trivial invariantness analysis in loop unswitching. The pass also includes
5232 store motion.
5233
5234 @item -ftree-loop-ivcanon
5235 Create a canonical counter for number of iterations in the loop for that
5236 determining number of iterations requires complicated analysis. Later
5237 optimizations then may determine the number easily. Useful especially
5238 in connection with unrolling.
5239
5240 @item -fivopts
5241 Perform induction variable optimizations (strength reduction, induction
5242 variable merging and induction variable elimination) on trees.
5243
5244 @item -ftree-sra
5245 Perform scalar replacement of aggregates. This pass replaces structure
5246 references with scalars to prevent committing structures to memory too
5247 early. This flag is enabled by default at @option{-O} and higher.
5248
5249 @item -ftree-copyrename
5250 Perform copy renaming on trees. This pass attempts to rename compiler
5251 temporaries to other variables at copy locations, usually resulting in
5252 variable names which more closely resemble the original variables. This flag
5253 is enabled by default at @option{-O} and higher.
5254
5255 @item -ftree-ter
5256 Perform temporary expression replacement during the SSA->normal phase. Single
5257 use/single def temporaries are replaced at their use location with their
5258 defining expression. This results in non-GIMPLE code, but gives the expanders
5259 much more complex trees to work on resulting in better RTL generation. This is
5260 enabled by default at @option{-O} and higher.
5261
5262 @item -ftree-lrs
5263 Perform live range splitting during the SSA->normal phase. Distinct live
5264 ranges of a variable are split into unique variables, allowing for better
5265 optimization later. This is enabled by default at @option{-O} and higher.
5266
5267 @item -ftree-vectorize
5268 Perform loop vectorization on trees.
5269
5270 @item -ftree-vect-loop-version
5271 @opindex ftree-vect-loop-version
5272 Perform loop versioning when doing loop vectorization on trees. When a loop
5273 appears to be vectorizable except that data alignment or data dependence cannot
5274 be determined at compile time then vectorized and non-vectorized versions of
5275 the loop are generated along with runtime checks for alignment or dependence
5276 to control which version is executed. This option is enabled by default
5277 except at level @option{-Os} where it is disabled.
5278
5279 @item -ftree-vrp
5280 Perform Value Range Propagation on trees. This is similar to the
5281 constant propagation pass, but instead of values, ranges of values are
5282 propagated. This allows the optimizers to remove unnecessary range
5283 checks like array bound checks and null pointer checks. This is
5284 enabled by default at @option{-O2} and higher. Null pointer check
5285 elimination is only done if @option{-fdelete-null-pointer-checks} is
5286 enabled.
5287
5288 @item -ftracer
5289 @opindex ftracer
5290 Perform tail duplication to enlarge superblock size. This transformation
5291 simplifies the control flow of the function allowing other optimizations to do
5292 better job.
5293
5294 @item -funroll-loops
5295 @opindex funroll-loops
5296 Unroll loops whose number of iterations can be determined at compile
5297 time or upon entry to the loop. @option{-funroll-loops} implies
5298 @option{-frerun-cse-after-loop}. This option makes code larger,
5299 and may or may not make it run faster.
5300
5301 @item -funroll-all-loops
5302 @opindex funroll-all-loops
5303 Unroll all loops, even if their number of iterations is uncertain when
5304 the loop is entered. This usually makes programs run more slowly.
5305 @option{-funroll-all-loops} implies the same options as
5306 @option{-funroll-loops},
5307
5308 @item -fsplit-ivs-in-unroller
5309 @opindex -fsplit-ivs-in-unroller
5310 Enables expressing of values of induction variables in later iterations
5311 of the unrolled loop using the value in the first iteration. This breaks
5312 long dependency chains, thus improving efficiency of the scheduling passes.
5313
5314 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5315 same effect. However in cases the loop body is more complicated than
5316 a single basic block, this is not reliable. It also does not work at all
5317 on some of the architectures due to restrictions in the CSE pass.
5318
5319 This optimization is enabled by default.
5320
5321 @item -fvariable-expansion-in-unroller
5322 @opindex -fvariable-expansion-in-unroller
5323 With this option, the compiler will create multiple copies of some
5324 local variables when unrolling a loop which can result in superior code.
5325
5326 @item -fprefetch-loop-arrays
5327 @opindex fprefetch-loop-arrays
5328 If supported by the target machine, generate instructions to prefetch
5329 memory to improve the performance of loops that access large arrays.
5330
5331 This option may generate better or worse code; results are highly
5332 dependent on the structure of loops within the source code.
5333
5334 Disabled at level @option{-Os}.
5335
5336 @item -fno-peephole
5337 @itemx -fno-peephole2
5338 @opindex fno-peephole
5339 @opindex fno-peephole2
5340 Disable any machine-specific peephole optimizations. The difference
5341 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5342 are implemented in the compiler; some targets use one, some use the
5343 other, a few use both.
5344
5345 @option{-fpeephole} is enabled by default.
5346 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5347
5348 @item -fno-guess-branch-probability
5349 @opindex fno-guess-branch-probability
5350 Do not guess branch probabilities using heuristics.
5351
5352 GCC will use heuristics to guess branch probabilities if they are
5353 not provided by profiling feedback (@option{-fprofile-arcs}). These
5354 heuristics are based on the control flow graph. If some branch probabilities
5355 are specified by @samp{__builtin_expect}, then the heuristics will be
5356 used to guess branch probabilities for the rest of the control flow graph,
5357 taking the @samp{__builtin_expect} info into account. The interactions
5358 between the heuristics and @samp{__builtin_expect} can be complex, and in
5359 some cases, it may be useful to disable the heuristics so that the effects
5360 of @samp{__builtin_expect} are easier to understand.
5361
5362 The default is @option{-fguess-branch-probability} at levels
5363 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5364
5365 @item -freorder-blocks
5366 @opindex freorder-blocks
5367 Reorder basic blocks in the compiled function in order to reduce number of
5368 taken branches and improve code locality.
5369
5370 Enabled at levels @option{-O2}, @option{-O3}.
5371
5372 @item -freorder-blocks-and-partition
5373 @opindex freorder-blocks-and-partition
5374 In addition to reordering basic blocks in the compiled function, in order
5375 to reduce number of taken branches, partitions hot and cold basic blocks
5376 into separate sections of the assembly and .o files, to improve
5377 paging and cache locality performance.
5378
5379 This optimization is automatically turned off in the presence of
5380 exception handling, for linkonce sections, for functions with a user-defined
5381 section attribute and on any architecture that does not support named
5382 sections.
5383
5384 @item -freorder-functions
5385 @opindex freorder-functions
5386 Reorder functions in the object file in order to
5387 improve code locality. This is implemented by using special
5388 subsections @code{.text.hot} for most frequently executed functions and
5389 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
5390 the linker so object file format must support named sections and linker must
5391 place them in a reasonable way.
5392
5393 Also profile feedback must be available in to make this option effective. See
5394 @option{-fprofile-arcs} for details.
5395
5396 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5397
5398 @item -fstrict-aliasing
5399 @opindex fstrict-aliasing
5400 Allows the compiler to assume the strictest aliasing rules applicable to
5401 the language being compiled. For C (and C++), this activates
5402 optimizations based on the type of expressions. In particular, an
5403 object of one type is assumed never to reside at the same address as an
5404 object of a different type, unless the types are almost the same. For
5405 example, an @code{unsigned int} can alias an @code{int}, but not a
5406 @code{void*} or a @code{double}. A character type may alias any other
5407 type.
5408
5409 Pay special attention to code like this:
5410 @smallexample
5411 union a_union @{
5412 int i;
5413 double d;
5414 @};
5415
5416 int f() @{
5417 a_union t;
5418 t.d = 3.0;
5419 return t.i;
5420 @}
5421 @end smallexample
5422 The practice of reading from a different union member than the one most
5423 recently written to (called ``type-punning'') is common. Even with
5424 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5425 is accessed through the union type. So, the code above will work as
5426 expected. However, this code might not:
5427 @smallexample
5428 int f() @{
5429 a_union t;
5430 int* ip;
5431 t.d = 3.0;
5432 ip = &t.i;
5433 return *ip;
5434 @}
5435 @end smallexample
5436
5437 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5438
5439 @item -falign-functions
5440 @itemx -falign-functions=@var{n}
5441 @opindex falign-functions
5442 Align the start of functions to the next power-of-two greater than
5443 @var{n}, skipping up to @var{n} bytes. For instance,
5444 @option{-falign-functions=32} aligns functions to the next 32-byte
5445 boundary, but @option{-falign-functions=24} would align to the next
5446 32-byte boundary only if this can be done by skipping 23 bytes or less.
5447
5448 @option{-fno-align-functions} and @option{-falign-functions=1} are
5449 equivalent and mean that functions will not be aligned.
5450
5451 Some assemblers only support this flag when @var{n} is a power of two;
5452 in that case, it is rounded up.
5453
5454 If @var{n} is not specified or is zero, use a machine-dependent default.
5455
5456 Enabled at levels @option{-O2}, @option{-O3}.
5457
5458 @item -falign-labels
5459 @itemx -falign-labels=@var{n}
5460 @opindex falign-labels
5461 Align all branch targets to a power-of-two boundary, skipping up to
5462 @var{n} bytes like @option{-falign-functions}. This option can easily
5463 make code slower, because it must insert dummy operations for when the
5464 branch target is reached in the usual flow of the code.
5465
5466 @option{-fno-align-labels} and @option{-falign-labels=1} are
5467 equivalent and mean that labels will not be aligned.
5468
5469 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5470 are greater than this value, then their values are used instead.
5471
5472 If @var{n} is not specified or is zero, use a machine-dependent default
5473 which is very likely to be @samp{1}, meaning no alignment.
5474
5475 Enabled at levels @option{-O2}, @option{-O3}.
5476
5477 @item -falign-loops
5478 @itemx -falign-loops=@var{n}
5479 @opindex falign-loops
5480 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5481 like @option{-falign-functions}. The hope is that the loop will be
5482 executed many times, which will make up for any execution of the dummy
5483 operations.
5484
5485 @option{-fno-align-loops} and @option{-falign-loops=1} are
5486 equivalent and mean that loops will not be aligned.
5487
5488 If @var{n} is not specified or is zero, use a machine-dependent default.
5489
5490 Enabled at levels @option{-O2}, @option{-O3}.
5491
5492 @item -falign-jumps
5493 @itemx -falign-jumps=@var{n}
5494 @opindex falign-jumps
5495 Align branch targets to a power-of-two boundary, for branch targets
5496 where the targets can only be reached by jumping, skipping up to @var{n}
5497 bytes like @option{-falign-functions}. In this case, no dummy operations
5498 need be executed.
5499
5500 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5501 equivalent and mean that loops will not be aligned.
5502
5503 If @var{n} is not specified or is zero, use a machine-dependent default.
5504
5505 Enabled at levels @option{-O2}, @option{-O3}.
5506
5507 @item -funit-at-a-time
5508 @opindex funit-at-a-time
5509 Parse the whole compilation unit before starting to produce code.
5510 This allows some extra optimizations to take place but consumes
5511 more memory (in general). There are some compatibility issues
5512 with @emph{unit-at-a-time} mode:
5513 @itemize @bullet
5514 @item
5515 enabling @emph{unit-at-a-time} mode may change the order
5516 in which functions, variables, and top-level @code{asm} statements
5517 are emitted, and will likely break code relying on some particular
5518 ordering. The majority of such top-level @code{asm} statements,
5519 though, can be replaced by @code{section} attributes. The
5520 @option{fno-toplevel-reorder} option may be used to keep the ordering
5521 used in the input file, at the cost of some optimizations.
5522
5523 @item
5524 @emph{unit-at-a-time} mode removes unreferenced static variables
5525 and functions. This may result in undefined references
5526 when an @code{asm} statement refers directly to variables or functions
5527 that are otherwise unused. In that case either the variable/function
5528 shall be listed as an operand of the @code{asm} statement operand or,
5529 in the case of top-level @code{asm} statements the attribute @code{used}
5530 shall be used on the declaration.
5531
5532 @item
5533 Static functions now can use non-standard passing conventions that
5534 may break @code{asm} statements calling functions directly. Again,
5535 attribute @code{used} will prevent this behavior.
5536 @end itemize
5537
5538 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5539 but this scheme may not be supported by future releases of GCC@.
5540
5541 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5542
5543 @item -fno-toplevel-reorder
5544 Do not reorder top-level functions, variables, and @code{asm}
5545 statements. Output them in the same order that they appear in the
5546 input file. When this option is used, unreferenced static variables
5547 will not be removed. This option is intended to support existing code
5548 which relies on a particular ordering. For new code, it is better to
5549 use attributes.
5550
5551 @item -fweb
5552 @opindex fweb
5553 Constructs webs as commonly used for register allocation purposes and assign
5554 each web individual pseudo register. This allows the register allocation pass
5555 to operate on pseudos directly, but also strengthens several other optimization
5556 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5557 however, make debugging impossible, since variables will no longer stay in a
5558 ``home register''.
5559
5560 Enabled by default with @option{-funroll-loops}.
5561
5562 @item -fwhole-program
5563 @opindex fwhole-program
5564 Assume that the current compilation unit represents whole program being
5565 compiled. All public functions and variables with the exception of @code{main}
5566 and those merged by attribute @code{externally_visible} become static functions
5567 and in a affect gets more aggressively optimized by interprocedural optimizers.
5568 While this option is equivalent to proper use of @code{static} keyword for
5569 programs consisting of single file, in combination with option
5570 @option{--combine} this flag can be used to compile most of smaller scale C
5571 programs since the functions and variables become local for the whole combined
5572 compilation unit, not for the single source file itself.
5573
5574
5575 @item -fno-cprop-registers
5576 @opindex fno-cprop-registers
5577 After register allocation and post-register allocation instruction splitting,
5578 we perform a copy-propagation pass to try to reduce scheduling dependencies
5579 and occasionally eliminate the copy.
5580
5581 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5582
5583 @item -fprofile-generate
5584 @opindex fprofile-generate
5585
5586 Enable options usually used for instrumenting application to produce
5587 profile useful for later recompilation with profile feedback based
5588 optimization. You must use @option{-fprofile-generate} both when
5589 compiling and when linking your program.
5590
5591 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5592
5593 @item -fprofile-use
5594 @opindex fprofile-use
5595 Enable profile feedback directed optimizations, and optimizations
5596 generally profitable only with profile feedback available.
5597
5598 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
5599 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}
5600
5601 @end table
5602
5603 The following options control compiler behavior regarding floating
5604 point arithmetic. These options trade off between speed and
5605 correctness. All must be specifically enabled.
5606
5607 @table @gcctabopt
5608 @item -ffloat-store
5609 @opindex ffloat-store
5610 Do not store floating point variables in registers, and inhibit other
5611 options that might change whether a floating point value is taken from a
5612 register or memory.
5613
5614 @cindex floating point precision
5615 This option prevents undesirable excess precision on machines such as
5616 the 68000 where the floating registers (of the 68881) keep more
5617 precision than a @code{double} is supposed to have. Similarly for the
5618 x86 architecture. For most programs, the excess precision does only
5619 good, but a few programs rely on the precise definition of IEEE floating
5620 point. Use @option{-ffloat-store} for such programs, after modifying
5621 them to store all pertinent intermediate computations into variables.
5622
5623 @item -ffast-math
5624 @opindex ffast-math
5625 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5626 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5627 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5628 and @option{fcx-limited-range}.
5629
5630 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5631
5632 This option should never be turned on by any @option{-O} option since
5633 it can result in incorrect output for programs which depend on
5634 an exact implementation of IEEE or ISO rules/specifications for
5635 math functions.
5636
5637 @item -fno-math-errno
5638 @opindex fno-math-errno
5639 Do not set ERRNO after calling math functions that are executed
5640 with a single instruction, e.g., sqrt. A program that relies on
5641 IEEE exceptions for math error handling may want to use this flag
5642 for speed while maintaining IEEE arithmetic compatibility.
5643
5644 This option should never be turned on by any @option{-O} option since
5645 it can result in incorrect output for programs which depend on
5646 an exact implementation of IEEE or ISO rules/specifications for
5647 math functions.
5648
5649 The default is @option{-fmath-errno}.
5650
5651 On Darwin systems, the math library never sets @code{errno}. There is therefore
5652 no reason for the compiler to consider the possibility that it might,
5653 and @option{-fno-math-errno} is the default.
5654
5655 @item -funsafe-math-optimizations
5656 @opindex funsafe-math-optimizations
5657 Allow optimizations for floating-point arithmetic that (a) assume
5658 that arguments and results are valid and (b) may violate IEEE or
5659 ANSI standards. When used at link-time, it may include libraries
5660 or startup files that change the default FPU control word or other
5661 similar optimizations.
5662
5663 This option should never be turned on by any @option{-O} option since
5664 it can result in incorrect output for programs which depend on
5665 an exact implementation of IEEE or ISO rules/specifications for
5666 math functions.
5667
5668 The default is @option{-fno-unsafe-math-optimizations}.
5669
5670 @item -ffinite-math-only
5671 @opindex ffinite-math-only
5672 Allow optimizations for floating-point arithmetic that assume
5673 that arguments and results are not NaNs or +-Infs.
5674
5675 This option should never be turned on by any @option{-O} option since
5676 it can result in incorrect output for programs which depend on
5677 an exact implementation of IEEE or ISO rules/specifications.
5678
5679 The default is @option{-fno-finite-math-only}.
5680
5681 @item -fno-trapping-math
5682 @opindex fno-trapping-math
5683 Compile code assuming that floating-point operations cannot generate
5684 user-visible traps. These traps include division by zero, overflow,
5685 underflow, inexact result and invalid operation. This option implies
5686 @option{-fno-signaling-nans}. Setting this option may allow faster
5687 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5688
5689 This option should never be turned on by any @option{-O} option since
5690 it can result in incorrect output for programs which depend on
5691 an exact implementation of IEEE or ISO rules/specifications for
5692 math functions.
5693
5694 The default is @option{-ftrapping-math}.
5695
5696 @item -frounding-math
5697 @opindex frounding-math
5698 Disable transformations and optimizations that assume default floating
5699 point rounding behavior. This is round-to-zero for all floating point
5700 to integer conversions, and round-to-nearest for all other arithmetic
5701 truncations. This option should be specified for programs that change
5702 the FP rounding mode dynamically, or that may be executed with a
5703 non-default rounding mode. This option disables constant folding of
5704 floating point expressions at compile-time (which may be affected by
5705 rounding mode) and arithmetic transformations that are unsafe in the
5706 presence of sign-dependent rounding modes.
5707
5708 The default is @option{-fno-rounding-math}.
5709
5710 This option is experimental and does not currently guarantee to
5711 disable all GCC optimizations that are affected by rounding mode.
5712 Future versions of GCC may provide finer control of this setting
5713 using C99's @code{FENV_ACCESS} pragma. This command line option
5714 will be used to specify the default state for @code{FENV_ACCESS}.
5715
5716 @item -frtl-abstract-sequences
5717 @opindex frtl-abstract-sequences
5718 It is a size optimization method. This option is to find identical
5719 sequences of code, which can be turned into pseudo-procedures and
5720 then replace all occurrences with calls to the newly created
5721 subroutine. It is kind of an opposite of @option{-finline-functions}.
5722 This optimization runs at RTL level.
5723
5724 @item -fsignaling-nans
5725 @opindex fsignaling-nans
5726 Compile code assuming that IEEE signaling NaNs may generate user-visible
5727 traps during floating-point operations. Setting this option disables
5728 optimizations that may change the number of exceptions visible with
5729 signaling NaNs. This option implies @option{-ftrapping-math}.
5730
5731 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5732 be defined.
5733
5734 The default is @option{-fno-signaling-nans}.
5735
5736 This option is experimental and does not currently guarantee to
5737 disable all GCC optimizations that affect signaling NaN behavior.
5738
5739 @item -fsingle-precision-constant
5740 @opindex fsingle-precision-constant
5741 Treat floating point constant as single precision constant instead of
5742 implicitly converting it to double precision constant.
5743
5744 @item -fcx-limited-range
5745 @itemx -fno-cx-limited-range
5746 @opindex fcx-limited-range
5747 @opindex fno-cx-limited-range
5748 When enabled, this option states that a range reduction step is not
5749 needed when performing complex division. The default is
5750 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5751
5752 This option controls the default setting of the ISO C99
5753 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5754 all languages.
5755
5756 @end table
5757
5758 The following options control optimizations that may improve
5759 performance, but are not enabled by any @option{-O} options. This
5760 section includes experimental options that may produce broken code.
5761
5762 @table @gcctabopt
5763 @item -fbranch-probabilities
5764 @opindex fbranch-probabilities
5765 After running a program compiled with @option{-fprofile-arcs}
5766 (@pxref{Debugging Options,, Options for Debugging Your Program or
5767 @command{gcc}}), you can compile it a second time using
5768 @option{-fbranch-probabilities}, to improve optimizations based on
5769 the number of times each branch was taken. When the program
5770 compiled with @option{-fprofile-arcs} exits it saves arc execution
5771 counts to a file called @file{@var{sourcename}.gcda} for each source
5772 file. The information in this data file is very dependent on the
5773 structure of the generated code, so you must use the same source code
5774 and the same optimization options for both compilations.
5775
5776 With @option{-fbranch-probabilities}, GCC puts a
5777 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5778 These can be used to improve optimization. Currently, they are only
5779 used in one place: in @file{reorg.c}, instead of guessing which path a
5780 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5781 exactly determine which path is taken more often.
5782
5783 @item -fprofile-values
5784 @opindex fprofile-values
5785 If combined with @option{-fprofile-arcs}, it adds code so that some
5786 data about values of expressions in the program is gathered.
5787
5788 With @option{-fbranch-probabilities}, it reads back the data gathered
5789 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5790 notes to instructions for their later usage in optimizations.
5791
5792 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5793
5794 @item -fvpt
5795 @opindex fvpt
5796 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5797 a code to gather information about values of expressions.
5798
5799 With @option{-fbranch-probabilities}, it reads back the data gathered
5800 and actually performs the optimizations based on them.
5801 Currently the optimizations include specialization of division operation
5802 using the knowledge about the value of the denominator.
5803
5804 @item -frename-registers
5805 @opindex frename-registers
5806 Attempt to avoid false dependencies in scheduled code by making use
5807 of registers left over after register allocation. This optimization
5808 will most benefit processors with lots of registers. Depending on the
5809 debug information format adopted by the target, however, it can
5810 make debugging impossible, since variables will no longer stay in
5811 a ``home register''.
5812
5813 Enabled by default with @option{-funroll-loops}.
5814
5815 @item -ftracer
5816 @opindex ftracer
5817 Perform tail duplication to enlarge superblock size. This transformation
5818 simplifies the control flow of the function allowing other optimizations to do
5819 better job.
5820
5821 Enabled with @option{-fprofile-use}.
5822
5823 @item -funroll-loops
5824 @opindex funroll-loops
5825 Unroll loops whose number of iterations can be determined at compile time or
5826 upon entry to the loop. @option{-funroll-loops} implies
5827 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
5828 It also turns on complete loop peeling (i.e.@: complete removal of loops with
5829 small constant number of iterations). This option makes code larger, and may
5830 or may not make it run faster.
5831
5832 Enabled with @option{-fprofile-use}.
5833
5834 @item -funroll-all-loops
5835 @opindex funroll-all-loops
5836 Unroll all loops, even if their number of iterations is uncertain when
5837 the loop is entered. This usually makes programs run more slowly.
5838 @option{-funroll-all-loops} implies the same options as
5839 @option{-funroll-loops}.
5840
5841 @item -fpeel-loops
5842 @opindex fpeel-loops
5843 Peels the loops for that there is enough information that they do not
5844 roll much (from profile feedback). It also turns on complete loop peeling
5845 (i.e.@: complete removal of loops with small constant number of iterations).
5846
5847 Enabled with @option{-fprofile-use}.
5848
5849 @item -fmove-loop-invariants
5850 @opindex fmove-loop-invariants
5851 Enables the loop invariant motion pass in the RTL loop optimizer. Enabled
5852 at level @option{-O1}
5853
5854 @item -funswitch-loops
5855 @opindex funswitch-loops
5856 Move branches with loop invariant conditions out of the loop, with duplicates
5857 of the loop on both branches (modified according to result of the condition).
5858
5859 @item -ffunction-sections
5860 @itemx -fdata-sections
5861 @opindex ffunction-sections
5862 @opindex fdata-sections
5863 Place each function or data item into its own section in the output
5864 file if the target supports arbitrary sections. The name of the
5865 function or the name of the data item determines the section's name
5866 in the output file.
5867
5868 Use these options on systems where the linker can perform optimizations
5869 to improve locality of reference in the instruction space. Most systems
5870 using the ELF object format and SPARC processors running Solaris 2 have
5871 linkers with such optimizations. AIX may have these optimizations in
5872 the future.
5873
5874 Only use these options when there are significant benefits from doing
5875 so. When you specify these options, the assembler and linker will
5876 create larger object and executable files and will also be slower.
5877 You will not be able to use @code{gprof} on all systems if you
5878 specify this option and you may have problems with debugging if
5879 you specify both this option and @option{-g}.
5880
5881 @item -fbranch-target-load-optimize
5882 @opindex fbranch-target-load-optimize
5883 Perform branch target register load optimization before prologue / epilogue
5884 threading.
5885 The use of target registers can typically be exposed only during reload,
5886 thus hoisting loads out of loops and doing inter-block scheduling needs
5887 a separate optimization pass.
5888
5889 @item -fbranch-target-load-optimize2
5890 @opindex fbranch-target-load-optimize2
5891 Perform branch target register load optimization after prologue / epilogue
5892 threading.
5893
5894 @item -fbtr-bb-exclusive
5895 @opindex fbtr-bb-exclusive
5896 When performing branch target register load optimization, don't reuse
5897 branch target registers in within any basic block.
5898
5899 @item -fstack-protector
5900 Emit extra code to check for buffer overflows, such as stack smashing
5901 attacks. This is done by adding a guard variable to functions with
5902 vulnerable objects. This includes functions that call alloca, and
5903 functions with buffers larger than 8 bytes. The guards are initialized
5904 when a function is entered and then checked when the function exits.
5905 If a guard check fails, an error message is printed and the program exits.
5906
5907 @item -fstack-protector-all
5908 Like @option{-fstack-protector} except that all functions are protected.
5909
5910 @item -fsection-anchors
5911 @opindex fsection-anchors
5912 Try to reduce the number of symbolic address calculations by using
5913 shared ``anchor'' symbols to address nearby objects. This transformation
5914 can help to reduce the number of GOT entries and GOT accesses on some
5915 targets.
5916
5917 For example, the implementation of the following function @code{foo}:
5918
5919 @smallexample
5920 static int a, b, c;
5921 int foo (void) @{ return a + b + c; @}
5922 @end smallexample
5923
5924 would usually calculate the addresses of all three variables, but if you
5925 compile it with @option{-fsection-anchors}, it will access the variables
5926 from a common anchor point instead. The effect is similar to the
5927 following pseudocode (which isn't valid C):
5928
5929 @smallexample
5930 int foo (void)
5931 @{
5932 register int *xr = &x;
5933 return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
5934 @}
5935 @end smallexample
5936
5937 Not all targets support this option.
5938
5939 @item --param @var{name}=@var{value}
5940 @opindex param
5941 In some places, GCC uses various constants to control the amount of
5942 optimization that is done. For example, GCC will not inline functions
5943 that contain more that a certain number of instructions. You can
5944 control some of these constants on the command-line using the
5945 @option{--param} option.
5946
5947 The names of specific parameters, and the meaning of the values, are
5948 tied to the internals of the compiler, and are subject to change
5949 without notice in future releases.
5950
5951 In each case, the @var{value} is an integer. The allowable choices for
5952 @var{name} are given in the following table:
5953
5954 @table @gcctabopt
5955 @item salias-max-implicit-fields
5956 The maximum number of fields in a variable without direct
5957 structure accesses for which structure aliasing will consider trying
5958 to track each field. The default is 5
5959
5960 @item salias-max-array-elements
5961 The maximum number of elements an array can have and its elements
5962 still be tracked individually by structure aliasing. The default is 4
5963
5964 @item sra-max-structure-size
5965 The maximum structure size, in bytes, at which the scalar replacement
5966 of aggregates (SRA) optimization will perform block copies. The
5967 default value, 0, implies that GCC will select the most appropriate
5968 size itself.
5969
5970 @item sra-field-structure-ratio
5971 The threshold ratio (as a percentage) between instantiated fields and
5972 the complete structure size. We say that if the ratio of the number
5973 of bytes in instantiated fields to the number of bytes in the complete
5974 structure exceeds this parameter, then block copies are not used. The
5975 default is 75.
5976
5977 @item max-crossjump-edges
5978 The maximum number of incoming edges to consider for crossjumping.
5979 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5980 the number of edges incoming to each block. Increasing values mean
5981 more aggressive optimization, making the compile time increase with
5982 probably small improvement in executable size.
5983
5984 @item min-crossjump-insns
5985 The minimum number of instructions which must be matched at the end
5986 of two blocks before crossjumping will be performed on them. This
5987 value is ignored in the case where all instructions in the block being
5988 crossjumped from are matched. The default value is 5.
5989
5990 @item max-grow-copy-bb-insns
5991 The maximum code size expansion factor when copying basic blocks
5992 instead of jumping. The expansion is relative to a jump instruction.
5993 The default value is 8.
5994
5995 @item max-goto-duplication-insns
5996 The maximum number of instructions to duplicate to a block that jumps
5997 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5998 passes, GCC factors computed gotos early in the compilation process,
5999 and unfactors them as late as possible. Only computed jumps at the
6000 end of a basic blocks with no more than max-goto-duplication-insns are
6001 unfactored. The default value is 8.
6002
6003 @item max-delay-slot-insn-search
6004 The maximum number of instructions to consider when looking for an
6005 instruction to fill a delay slot. If more than this arbitrary number of
6006 instructions is searched, the time savings from filling the delay slot
6007 will be minimal so stop searching. Increasing values mean more
6008 aggressive optimization, making the compile time increase with probably
6009 small improvement in executable run time.
6010
6011 @item max-delay-slot-live-search
6012 When trying to fill delay slots, the maximum number of instructions to
6013 consider when searching for a block with valid live register
6014 information. Increasing this arbitrarily chosen value means more
6015 aggressive optimization, increasing the compile time. This parameter
6016 should be removed when the delay slot code is rewritten to maintain the
6017 control-flow graph.
6018
6019 @item max-gcse-memory
6020 The approximate maximum amount of memory that will be allocated in
6021 order to perform the global common subexpression elimination
6022 optimization. If more memory than specified is required, the
6023 optimization will not be done.
6024
6025 @item max-gcse-passes
6026 The maximum number of passes of GCSE to run. The default is 1.
6027
6028 @item max-pending-list-length
6029 The maximum number of pending dependencies scheduling will allow
6030 before flushing the current state and starting over. Large functions
6031 with few branches or calls can create excessively large lists which
6032 needlessly consume memory and resources.
6033
6034 @item max-inline-insns-single
6035 Several parameters control the tree inliner used in gcc.
6036 This number sets the maximum number of instructions (counted in GCC's
6037 internal representation) in a single function that the tree inliner
6038 will consider for inlining. This only affects functions declared
6039 inline and methods implemented in a class declaration (C++).
6040 The default value is 450.
6041
6042 @item max-inline-insns-auto
6043 When you use @option{-finline-functions} (included in @option{-O3}),
6044 a lot of functions that would otherwise not be considered for inlining
6045 by the compiler will be investigated. To those functions, a different
6046 (more restrictive) limit compared to functions declared inline can
6047 be applied.
6048 The default value is 90.
6049
6050 @item large-function-insns
6051 The limit specifying really large functions. For functions larger than this
6052 limit after inlining inlining is constrained by
6053 @option{--param large-function-growth}. This parameter is useful primarily
6054 to avoid extreme compilation time caused by non-linear algorithms used by the
6055 backend.
6056 This parameter is ignored when @option{-funit-at-a-time} is not used.
6057 The default value is 2700.
6058
6059 @item large-function-growth
6060 Specifies maximal growth of large function caused by inlining in percents.
6061 This parameter is ignored when @option{-funit-at-a-time} is not used.
6062 The default value is 100 which limits large function growth to 2.0 times
6063 the original size.
6064
6065 @item large-unit-insns
6066 The limit specifying large translation unit. Growth caused by inlining of
6067 units larger than this limit is limited by @option{--param inline-unit-growth}.
6068 For small units this might be too tight (consider unit consisting of function A
6069 that is inline and B that just calls A three time. If B is small relative to
6070 A, the growth of unit is 300\% and yet such inlining is very sane. For very
6071 large units consisting of small inlininable functions however the overall unit
6072 growth limit is needed to avoid exponential explosion of code size. Thus for
6073 smaller units, the size is increased to @option{--param large-unit-insns}
6074 before applying @option{--param inline-unit-growth}. The default is 10000
6075
6076 @item inline-unit-growth
6077 Specifies maximal overall growth of the compilation unit caused by inlining.
6078 This parameter is ignored when @option{-funit-at-a-time} is not used.
6079 The default value is 50 which limits unit growth to 1.5 times the original
6080 size.
6081
6082 @item large-stack-frame
6083 The limit specifying large stack frames. While inlining the algorithm is trying
6084 to not grow past this limit too much. Default value is 256 bytes.
6085
6086 @item large-stack-frame-growth
6087 Specifies maximal growth of large stack frames caused by inlining in percents.
6088 The default value is 1000 which limits large stack frame growth to 11 times
6089 the original size.
6090
6091 @item max-inline-insns-recursive
6092 @itemx max-inline-insns-recursive-auto
6093 Specifies maximum number of instructions out-of-line copy of self recursive inline
6094 function can grow into by performing recursive inlining.
6095
6096 For functions declared inline @option{--param max-inline-insns-recursive} is
6097 taken into account. For function not declared inline, recursive inlining
6098 happens only when @option{-finline-functions} (included in @option{-O3}) is
6099 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
6100 default value is 450.
6101
6102 @item max-inline-recursive-depth
6103 @itemx max-inline-recursive-depth-auto
6104 Specifies maximum recursion depth used by the recursive inlining.
6105
6106 For functions declared inline @option{--param max-inline-recursive-depth} is
6107 taken into account. For function not declared inline, recursive inlining
6108 happens only when @option{-finline-functions} (included in @option{-O3}) is
6109 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
6110 default value is 450.
6111
6112 @item min-inline-recursive-probability
6113 Recursive inlining is profitable only for function having deep recursion
6114 in average and can hurt for function having little recursion depth by
6115 increasing the prologue size or complexity of function body to other
6116 optimizers.
6117
6118 When profile feedback is available (see @option{-fprofile-generate}) the actual
6119 recursion depth can be guessed from probability that function will recurse via
6120 given call expression. This parameter limits inlining only to call expression
6121 whose probability exceeds given threshold (in percents). The default value is
6122 10.
6123
6124 @item inline-call-cost
6125 Specify cost of call instruction relative to simple arithmetics operations
6126 (having cost of 1). Increasing this cost disqualifies inlining of non-leaf
6127 functions and at the same time increases size of leaf function that is believed to
6128 reduce function size by being inlined. In effect it increases amount of
6129 inlining for code having large abstraction penalty (many functions that just
6130 pass the arguments to other functions) and decrease inlining for code with low
6131 abstraction penalty. The default value is 16.
6132
6133 @item max-unrolled-insns
6134 The maximum number of instructions that a loop should have if that loop
6135 is unrolled, and if the loop is unrolled, it determines how many times
6136 the loop code is unrolled.
6137
6138 @item max-average-unrolled-insns
6139 The maximum number of instructions biased by probabilities of their execution
6140 that a loop should have if that loop is unrolled, and if the loop is unrolled,
6141 it determines how many times the loop code is unrolled.
6142
6143 @item max-unroll-times
6144 The maximum number of unrollings of a single loop.
6145
6146 @item max-peeled-insns
6147 The maximum number of instructions that a loop should have if that loop
6148 is peeled, and if the loop is peeled, it determines how many times
6149 the loop code is peeled.
6150
6151 @item max-peel-times
6152 The maximum number of peelings of a single loop.
6153
6154 @item max-completely-peeled-insns
6155 The maximum number of insns of a completely peeled loop.
6156
6157 @item max-completely-peel-times
6158 The maximum number of iterations of a loop to be suitable for complete peeling.
6159
6160 @item max-unswitch-insns
6161 The maximum number of insns of an unswitched loop.
6162
6163 @item max-unswitch-level
6164 The maximum number of branches unswitched in a single loop.
6165
6166 @item lim-expensive
6167 The minimum cost of an expensive expression in the loop invariant motion.
6168
6169 @item iv-consider-all-candidates-bound
6170 Bound on number of candidates for induction variables below that
6171 all candidates are considered for each use in induction variable
6172 optimizations. Only the most relevant candidates are considered
6173 if there are more candidates, to avoid quadratic time complexity.
6174
6175 @item iv-max-considered-uses
6176 The induction variable optimizations give up on loops that contain more
6177 induction variable uses.
6178
6179 @item iv-always-prune-cand-set-bound
6180 If number of candidates in the set is smaller than this value,
6181 we always try to remove unnecessary ivs from the set during its
6182 optimization when a new iv is added to the set.
6183
6184 @item scev-max-expr-size
6185 Bound on size of expressions used in the scalar evolutions analyzer.
6186 Large expressions slow the analyzer.
6187
6188 @item vect-max-version-checks
6189 The maximum number of runtime checks that can be performed when doing
6190 loop versioning in the vectorizer. See option ftree-vect-loop-version
6191 for more information.
6192
6193 @item max-iterations-to-track
6194
6195 The maximum number of iterations of a loop the brute force algorithm
6196 for analysis of # of iterations of the loop tries to evaluate.
6197
6198 @item hot-bb-count-fraction
6199 Select fraction of the maximal count of repetitions of basic block in program
6200 given basic block needs to have to be considered hot.
6201
6202 @item hot-bb-frequency-fraction
6203 Select fraction of the maximal frequency of executions of basic block in
6204 function given basic block needs to have to be considered hot
6205
6206 @item max-predicted-iterations
6207 The maximum number of loop iterations we predict statically. This is useful
6208 in cases where function contain single loop with known bound and other loop
6209 with unknown. We predict the known number of iterations correctly, while
6210 the unknown number of iterations average to roughly 10. This means that the
6211 loop without bounds would appear artificially cold relative to the other one.
6212
6213 @item tracer-dynamic-coverage
6214 @itemx tracer-dynamic-coverage-feedback
6215
6216 This value is used to limit superblock formation once the given percentage of
6217 executed instructions is covered. This limits unnecessary code size
6218 expansion.
6219
6220 The @option{tracer-dynamic-coverage-feedback} is used only when profile
6221 feedback is available. The real profiles (as opposed to statically estimated
6222 ones) are much less balanced allowing the threshold to be larger value.
6223
6224 @item tracer-max-code-growth
6225 Stop tail duplication once code growth has reached given percentage. This is
6226 rather hokey argument, as most of the duplicates will be eliminated later in
6227 cross jumping, so it may be set to much higher values than is the desired code
6228 growth.
6229
6230 @item tracer-min-branch-ratio
6231
6232 Stop reverse growth when the reverse probability of best edge is less than this
6233 threshold (in percent).
6234
6235 @item tracer-min-branch-ratio
6236 @itemx tracer-min-branch-ratio-feedback
6237
6238 Stop forward growth if the best edge do have probability lower than this
6239 threshold.
6240
6241 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
6242 compilation for profile feedback and one for compilation without. The value
6243 for compilation with profile feedback needs to be more conservative (higher) in
6244 order to make tracer effective.
6245
6246 @item max-cse-path-length
6247
6248 Maximum number of basic blocks on path that cse considers. The default is 10.
6249
6250 @item max-cse-insns
6251 The maximum instructions CSE process before flushing. The default is 1000.
6252
6253 @item max-aliased-vops
6254
6255 Maximum number of virtual operands per statement allowed to represent
6256 aliases before triggering the alias grouping heuristic. Alias
6257 grouping reduces compile times and memory consumption needed for
6258 aliasing at the expense of precision loss in alias information.
6259
6260 @item ggc-min-expand
6261
6262 GCC uses a garbage collector to manage its own memory allocation. This
6263 parameter specifies the minimum percentage by which the garbage
6264 collector's heap should be allowed to expand between collections.
6265 Tuning this may improve compilation speed; it has no effect on code
6266 generation.
6267
6268 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
6269 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
6270 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
6271 GCC is not able to calculate RAM on a particular platform, the lower
6272 bound of 30% is used. Setting this parameter and
6273 @option{ggc-min-heapsize} to zero causes a full collection to occur at
6274 every opportunity. This is extremely slow, but can be useful for
6275 debugging.
6276
6277 @item ggc-min-heapsize
6278
6279 Minimum size of the garbage collector's heap before it begins bothering
6280 to collect garbage. The first collection occurs after the heap expands
6281 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
6282 tuning this may improve compilation speed, and has no effect on code
6283 generation.
6284
6285 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
6286 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
6287 with a lower bound of 4096 (four megabytes) and an upper bound of
6288 131072 (128 megabytes). If GCC is not able to calculate RAM on a
6289 particular platform, the lower bound is used. Setting this parameter
6290 very large effectively disables garbage collection. Setting this
6291 parameter and @option{ggc-min-expand} to zero causes a full collection
6292 to occur at every opportunity.
6293
6294 @item max-reload-search-insns
6295 The maximum number of instruction reload should look backward for equivalent
6296 register. Increasing values mean more aggressive optimization, making the
6297 compile time increase with probably slightly better performance. The default
6298 value is 100.
6299
6300 @item max-cselib-memory-locations
6301 The maximum number of memory locations cselib should take into account.
6302 Increasing values mean more aggressive optimization, making the compile time
6303 increase with probably slightly better performance. The default value is 500.
6304
6305 @item max-flow-memory-locations
6306 Similar as @option{max-cselib-memory-locations} but for dataflow liveness.
6307 The default value is 100.
6308
6309 @item reorder-blocks-duplicate
6310 @itemx reorder-blocks-duplicate-feedback
6311
6312 Used by basic block reordering pass to decide whether to use unconditional
6313 branch or duplicate the code on its destination. Code is duplicated when its
6314 estimated size is smaller than this value multiplied by the estimated size of
6315 unconditional jump in the hot spots of the program.
6316
6317 The @option{reorder-block-duplicate-feedback} is used only when profile
6318 feedback is available and may be set to higher values than
6319 @option{reorder-block-duplicate} since information about the hot spots is more
6320 accurate.
6321
6322 @item max-sched-ready-insns
6323 The maximum number of instructions ready to be issued the scheduler should
6324 consider at any given time during the first scheduling pass. Increasing
6325 values mean more thorough searches, making the compilation time increase
6326 with probably little benefit. The default value is 100.
6327
6328 @item max-sched-region-blocks
6329 The maximum number of blocks in a region to be considered for
6330 interblock scheduling. The default value is 10.
6331
6332 @item max-sched-region-insns
6333 The maximum number of insns in a region to be considered for
6334 interblock scheduling. The default value is 100.
6335
6336 @item min-spec-prob
6337 The minimum probability (in percents) of reaching a source block
6338 for interblock speculative scheduling. The default value is 40.
6339
6340 @item max-sched-extend-regions-iters
6341 The maximum number of iterations through CFG to extend regions.
6342 0 - disable region extension,
6343 N - do at most N iterations.
6344 The default value is 0.
6345
6346 @item max-sched-insn-conflict-delay
6347 The maximum conflict delay for an insn to be considered for speculative motion.
6348 The default value is 3.
6349
6350 @item sched-spec-prob-cutoff
6351 The minimal probability of speculation success (in percents), so that
6352 speculative insn will be scheduled.
6353 The default value is 40.
6354
6355 @item max-last-value-rtl
6356
6357 The maximum size measured as number of RTLs that can be recorded in an expression
6358 in combiner for a pseudo register as last known value of that register. The default
6359 is 10000.
6360
6361 @item integer-share-limit
6362 Small integer constants can use a shared data structure, reducing the
6363 compiler's memory usage and increasing its speed. This sets the maximum
6364 value of a shared integer constant's. The default value is 256.
6365
6366 @item min-virtual-mappings
6367 Specifies the minimum number of virtual mappings in the incremental
6368 SSA updater that should be registered to trigger the virtual mappings
6369 heuristic defined by virtual-mappings-ratio. The default value is
6370 100.
6371
6372 @item virtual-mappings-ratio
6373 If the number of virtual mappings is virtual-mappings-ratio bigger
6374 than the number of virtual symbols to be updated, then the incremental
6375 SSA updater switches to a full update for those symbols. The default
6376 ratio is 3.
6377
6378 @item ssp-buffer-size
6379 The minimum size of buffers (i.e. arrays) that will receive stack smashing
6380 protection when @option{-fstack-protection} is used.
6381
6382 @item max-jump-thread-duplication-stmts
6383 Maximum number of statements allowed in a block that needs to be
6384 duplicated when threading jumps.
6385
6386 @item max-fields-for-field-sensitive
6387 Maximum number of fields in a structure we will treat in
6388 a field sensitive manner during pointer analysis.
6389
6390 @item prefetch-latency
6391 Estimate on average number of instructions that are executed before
6392 prefetch finishes. The distance we prefetch ahead is proportional
6393 to this constant. Increasing this number may also lead to less
6394 streams being prefetched (see @option{simultaneous-prefetches}).
6395
6396 @item simultaneous-prefetches
6397 Maximum number of prefetches that can run at the same time.
6398
6399 @item l1-cache-line-size
6400 The size of cache line in L1 cache, in bytes.
6401
6402 @item l1-cache-size
6403 The number of cache lines in L1 cache.
6404
6405 @item verify-canonical-types
6406 Whether the compiler should verify the ``canonical'' types used for
6407 type equality comparisons within the C++ and Objective-C++ front
6408 ends. Set to 1 (the default when GCC is configured with
6409 --enable-checking) to enable verification, 0 to disable verification
6410 (the default when GCC is configured with --disable-checking).
6411
6412 @end table
6413 @end table
6414
6415 @node Preprocessor Options
6416 @section Options Controlling the Preprocessor
6417 @cindex preprocessor options
6418 @cindex options, preprocessor
6419
6420 These options control the C preprocessor, which is run on each C source
6421 file before actual compilation.
6422
6423 If you use the @option{-E} option, nothing is done except preprocessing.
6424 Some of these options make sense only together with @option{-E} because
6425 they cause the preprocessor output to be unsuitable for actual
6426 compilation.
6427
6428 @table @gcctabopt
6429 @opindex Wp
6430 You can use @option{-Wp,@var{option}} to bypass the compiler driver
6431 and pass @var{option} directly through to the preprocessor. If
6432 @var{option} contains commas, it is split into multiple options at the
6433 commas. However, many options are modified, translated or interpreted
6434 by the compiler driver before being passed to the preprocessor, and
6435 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
6436 interface is undocumented and subject to change, so whenever possible
6437 you should avoid using @option{-Wp} and let the driver handle the
6438 options instead.
6439
6440 @item -Xpreprocessor @var{option}
6441 @opindex preprocessor
6442 Pass @var{option} as an option to the preprocessor. You can use this to
6443 supply system-specific preprocessor options which GCC does not know how to
6444 recognize.
6445
6446 If you want to pass an option that takes an argument, you must use
6447 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6448 @end table
6449
6450 @include cppopts.texi
6451
6452 @node Assembler Options
6453 @section Passing Options to the Assembler
6454
6455 @c prevent bad page break with this line
6456 You can pass options to the assembler.
6457
6458 @table @gcctabopt
6459 @item -Wa,@var{option}
6460 @opindex Wa
6461 Pass @var{option} as an option to the assembler. If @var{option}
6462 contains commas, it is split into multiple options at the commas.
6463
6464 @item -Xassembler @var{option}
6465 @opindex Xassembler
6466 Pass @var{option} as an option to the assembler. You can use this to
6467 supply system-specific assembler options which GCC does not know how to
6468 recognize.
6469
6470 If you want to pass an option that takes an argument, you must use
6471 @option{-Xassembler} twice, once for the option and once for the argument.
6472
6473 @end table
6474
6475 @node Link Options
6476 @section Options for Linking
6477 @cindex link options
6478 @cindex options, linking
6479
6480 These options come into play when the compiler links object files into
6481 an executable output file. They are meaningless if the compiler is
6482 not doing a link step.
6483
6484 @table @gcctabopt
6485 @cindex file names
6486 @item @var{object-file-name}
6487 A file name that does not end in a special recognized suffix is
6488 considered to name an object file or library. (Object files are
6489 distinguished from libraries by the linker according to the file
6490 contents.) If linking is done, these object files are used as input
6491 to the linker.
6492
6493 @item -c
6494 @itemx -S
6495 @itemx -E
6496 @opindex c
6497 @opindex S
6498 @opindex E
6499 If any of these options is used, then the linker is not run, and
6500 object file names should not be used as arguments. @xref{Overall
6501 Options}.
6502
6503 @cindex Libraries
6504 @item -l@var{library}
6505 @itemx -l @var{library}
6506 @opindex l
6507 Search the library named @var{library} when linking. (The second
6508 alternative with the library as a separate argument is only for
6509 POSIX compliance and is not recommended.)
6510
6511 It makes a difference where in the command you write this option; the
6512 linker searches and processes libraries and object files in the order they
6513 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6514 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
6515 to functions in @samp{z}, those functions may not be loaded.
6516
6517 The linker searches a standard list of directories for the library,
6518 which is actually a file named @file{lib@var{library}.a}. The linker
6519 then uses this file as if it had been specified precisely by name.
6520
6521 The directories searched include several standard system directories
6522 plus any that you specify with @option{-L}.
6523
6524 Normally the files found this way are library files---archive files
6525 whose members are object files. The linker handles an archive file by
6526 scanning through it for members which define symbols that have so far
6527 been referenced but not defined. But if the file that is found is an
6528 ordinary object file, it is linked in the usual fashion. The only
6529 difference between using an @option{-l} option and specifying a file name
6530 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6531 and searches several directories.
6532
6533 @item -lobjc
6534 @opindex lobjc
6535 You need this special case of the @option{-l} option in order to
6536 link an Objective-C or Objective-C++ program.
6537
6538 @item -nostartfiles
6539 @opindex nostartfiles
6540 Do not use the standard system startup files when linking.
6541 The standard system libraries are used normally, unless @option{-nostdlib}
6542 or @option{-nodefaultlibs} is used.
6543
6544 @item -nodefaultlibs
6545 @opindex nodefaultlibs
6546 Do not use the standard system libraries when linking.
6547 Only the libraries you specify will be passed to the linker.
6548 The standard startup files are used normally, unless @option{-nostartfiles}
6549 is used. The compiler may generate calls to @code{memcmp},
6550 @code{memset}, @code{memcpy} and @code{memmove}.
6551 These entries are usually resolved by entries in
6552 libc. These entry points should be supplied through some other
6553 mechanism when this option is specified.
6554
6555 @item -nostdlib
6556 @opindex nostdlib
6557 Do not use the standard system startup files or libraries when linking.
6558 No startup files and only the libraries you specify will be passed to
6559 the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
6560 @code{memcpy} and @code{memmove}.
6561 These entries are usually resolved by entries in
6562 libc. These entry points should be supplied through some other
6563 mechanism when this option is specified.
6564
6565 @cindex @option{-lgcc}, use with @option{-nostdlib}
6566 @cindex @option{-nostdlib} and unresolved references
6567 @cindex unresolved references and @option{-nostdlib}
6568 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6569 @cindex @option{-nodefaultlibs} and unresolved references
6570 @cindex unresolved references and @option{-nodefaultlibs}
6571 One of the standard libraries bypassed by @option{-nostdlib} and
6572 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6573 that GCC uses to overcome shortcomings of particular machines, or special
6574 needs for some languages.
6575 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6576 Collection (GCC) Internals},
6577 for more discussion of @file{libgcc.a}.)
6578 In most cases, you need @file{libgcc.a} even when you want to avoid
6579 other standard libraries. In other words, when you specify @option{-nostdlib}
6580 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6581 This ensures that you have no unresolved references to internal GCC
6582 library subroutines. (For example, @samp{__main}, used to ensure C++
6583 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6584 GNU Compiler Collection (GCC) Internals}.)
6585
6586 @item -pie
6587 @opindex pie
6588 Produce a position independent executable on targets which support it.
6589 For predictable results, you must also specify the same set of options
6590 that were used to generate code (@option{-fpie}, @option{-fPIE},
6591 or model suboptions) when you specify this option.
6592
6593 @item -rdynamic
6594 @opindex rdynamic
6595 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
6596 that support it. This instructs the linker to add all symbols, not
6597 only used ones, to the dynamic symbol table. This option is needed
6598 for some uses of @code{dlopen} or to allow obtaining backtraces
6599 from within a program.
6600
6601 @item -s
6602 @opindex s
6603 Remove all symbol table and relocation information from the executable.
6604
6605 @item -static
6606 @opindex static
6607 On systems that support dynamic linking, this prevents linking with the shared
6608 libraries. On other systems, this option has no effect.
6609
6610 @item -shared
6611 @opindex shared
6612 Produce a shared object which can then be linked with other objects to
6613 form an executable. Not all systems support this option. For predictable
6614 results, you must also specify the same set of options that were used to
6615 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6616 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6617 needs to build supplementary stub code for constructors to work. On
6618 multi-libbed systems, @samp{gcc -shared} must select the correct support
6619 libraries to link against. Failing to supply the correct flags may lead
6620 to subtle defects. Supplying them in cases where they are not necessary
6621 is innocuous.}
6622
6623 @item -shared-libgcc
6624 @itemx -static-libgcc
6625 @opindex shared-libgcc
6626 @opindex static-libgcc
6627 On systems that provide @file{libgcc} as a shared library, these options
6628 force the use of either the shared or static version respectively.
6629 If no shared version of @file{libgcc} was built when the compiler was
6630 configured, these options have no effect.
6631
6632 There are several situations in which an application should use the
6633 shared @file{libgcc} instead of the static version. The most common
6634 of these is when the application wishes to throw and catch exceptions
6635 across different shared libraries. In that case, each of the libraries
6636 as well as the application itself should use the shared @file{libgcc}.
6637
6638 Therefore, the G++ and GCJ drivers automatically add
6639 @option{-shared-libgcc} whenever you build a shared library or a main
6640 executable, because C++ and Java programs typically use exceptions, so
6641 this is the right thing to do.
6642
6643 If, instead, you use the GCC driver to create shared libraries, you may
6644 find that they will not always be linked with the shared @file{libgcc}.
6645 If GCC finds, at its configuration time, that you have a non-GNU linker
6646 or a GNU linker that does not support option @option{--eh-frame-hdr},
6647 it will link the shared version of @file{libgcc} into shared libraries
6648 by default. Otherwise, it will take advantage of the linker and optimize
6649 away the linking with the shared version of @file{libgcc}, linking with
6650 the static version of libgcc by default. This allows exceptions to
6651 propagate through such shared libraries, without incurring relocation
6652 costs at library load time.
6653
6654 However, if a library or main executable is supposed to throw or catch
6655 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6656 for the languages used in the program, or using the option
6657 @option{-shared-libgcc}, such that it is linked with the shared
6658 @file{libgcc}.
6659
6660 @item -symbolic
6661 @opindex symbolic
6662 Bind references to global symbols when building a shared object. Warn
6663 about any unresolved references (unless overridden by the link editor
6664 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6665 this option.
6666
6667 @item -Xlinker @var{option}
6668 @opindex Xlinker
6669 Pass @var{option} as an option to the linker. You can use this to
6670 supply system-specific linker options which GCC does not know how to
6671 recognize.
6672
6673 If you want to pass an option that takes an argument, you must use
6674 @option{-Xlinker} twice, once for the option and once for the argument.
6675 For example, to pass @option{-assert definitions}, you must write
6676 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
6677 @option{-Xlinker "-assert definitions"}, because this passes the entire
6678 string as a single argument, which is not what the linker expects.
6679
6680 @item -Wl,@var{option}
6681 @opindex Wl
6682 Pass @var{option} as an option to the linker. If @var{option} contains
6683 commas, it is split into multiple options at the commas.
6684
6685 @item -u @var{symbol}
6686 @opindex u
6687 Pretend the symbol @var{symbol} is undefined, to force linking of
6688 library modules to define it. You can use @option{-u} multiple times with
6689 different symbols to force loading of additional library modules.
6690 @end table
6691
6692 @node Directory Options
6693 @section Options for Directory Search
6694 @cindex directory options
6695 @cindex options, directory search
6696 @cindex search path
6697
6698 These options specify directories to search for header files, for
6699 libraries and for parts of the compiler:
6700
6701 @table @gcctabopt
6702 @item -I@var{dir}
6703 @opindex I
6704 Add the directory @var{dir} to the head of the list of directories to be
6705 searched for header files. This can be used to override a system header
6706 file, substituting your own version, since these directories are
6707 searched before the system header file directories. However, you should
6708 not use this option to add directories that contain vendor-supplied
6709 system header files (use @option{-isystem} for that). If you use more than
6710 one @option{-I} option, the directories are scanned in left-to-right
6711 order; the standard system directories come after.
6712
6713 If a standard system include directory, or a directory specified with
6714 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6715 option will be ignored. The directory will still be searched but as a
6716 system directory at its normal position in the system include chain.
6717 This is to ensure that GCC's procedure to fix buggy system headers and
6718 the ordering for the include_next directive are not inadvertently changed.
6719 If you really need to change the search order for system directories,
6720 use the @option{-nostdinc} and/or @option{-isystem} options.
6721
6722 @item -iquote@var{dir}
6723 @opindex iquote
6724 Add the directory @var{dir} to the head of the list of directories to
6725 be searched for header files only for the case of @samp{#include
6726 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6727 otherwise just like @option{-I}.
6728
6729 @item -L@var{dir}
6730 @opindex L
6731 Add directory @var{dir} to the list of directories to be searched
6732 for @option{-l}.
6733
6734 @item -B@var{prefix}
6735 @opindex B
6736 This option specifies where to find the executables, libraries,
6737 include files, and data files of the compiler itself.
6738
6739 The compiler driver program runs one or more of the subprograms
6740 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6741 @var{prefix} as a prefix for each program it tries to run, both with and
6742 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6743
6744 For each subprogram to be run, the compiler driver first tries the
6745 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
6746 was not specified, the driver tries two standard prefixes, which are
6747 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
6748 those results in a file name that is found, the unmodified program
6749 name is searched for using the directories specified in your
6750 @env{PATH} environment variable.
6751
6752 The compiler will check to see if the path provided by the @option{-B}
6753 refers to a directory, and if necessary it will add a directory
6754 separator character at the end of the path.
6755
6756 @option{-B} prefixes that effectively specify directory names also apply
6757 to libraries in the linker, because the compiler translates these
6758 options into @option{-L} options for the linker. They also apply to
6759 includes files in the preprocessor, because the compiler translates these
6760 options into @option{-isystem} options for the preprocessor. In this case,
6761 the compiler appends @samp{include} to the prefix.
6762
6763 The run-time support file @file{libgcc.a} can also be searched for using
6764 the @option{-B} prefix, if needed. If it is not found there, the two
6765 standard prefixes above are tried, and that is all. The file is left
6766 out of the link if it is not found by those means.
6767
6768 Another way to specify a prefix much like the @option{-B} prefix is to use
6769 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
6770 Variables}.
6771
6772 As a special kludge, if the path provided by @option{-B} is
6773 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6774 9, then it will be replaced by @file{[dir/]include}. This is to help
6775 with boot-strapping the compiler.
6776
6777 @item -specs=@var{file}
6778 @opindex specs
6779 Process @var{file} after the compiler reads in the standard @file{specs}
6780 file, in order to override the defaults that the @file{gcc} driver
6781 program uses when determining what switches to pass to @file{cc1},
6782 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
6783 @option{-specs=@var{file}} can be specified on the command line, and they
6784 are processed in order, from left to right.
6785
6786 @item --sysroot=@var{dir}
6787 @opindex sysroot
6788 Use @var{dir} as the logical root directory for headers and libraries.
6789 For example, if the compiler would normally search for headers in
6790 @file{/usr/include} and libraries in @file{/usr/lib}, it will instead
6791 search @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
6792
6793 If you use both this option and the @option{-isysroot} option, then
6794 the @option{--sysroot} option will apply to libraries, but the
6795 @option{-isysroot} option will apply to header files.
6796
6797 The GNU linker (beginning with version 2.16) has the necessary support
6798 for this option. If your linker does not support this option, the
6799 header file aspect of @option{--sysroot} will still work, but the
6800 library aspect will not.
6801
6802 @item -I-
6803 @opindex I-
6804 This option has been deprecated. Please use @option{-iquote} instead for
6805 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6806 Any directories you specify with @option{-I} options before the @option{-I-}
6807 option are searched only for the case of @samp{#include "@var{file}"};
6808 they are not searched for @samp{#include <@var{file}>}.
6809
6810 If additional directories are specified with @option{-I} options after
6811 the @option{-I-}, these directories are searched for all @samp{#include}
6812 directives. (Ordinarily @emph{all} @option{-I} directories are used
6813 this way.)
6814
6815 In addition, the @option{-I-} option inhibits the use of the current
6816 directory (where the current input file came from) as the first search
6817 directory for @samp{#include "@var{file}"}. There is no way to
6818 override this effect of @option{-I-}. With @option{-I.} you can specify
6819 searching the directory which was current when the compiler was
6820 invoked. That is not exactly the same as what the preprocessor does
6821 by default, but it is often satisfactory.
6822
6823 @option{-I-} does not inhibit the use of the standard system directories
6824 for header files. Thus, @option{-I-} and @option{-nostdinc} are
6825 independent.
6826 @end table
6827
6828 @c man end
6829
6830 @node Spec Files
6831 @section Specifying subprocesses and the switches to pass to them
6832 @cindex Spec Files
6833
6834 @command{gcc} is a driver program. It performs its job by invoking a
6835 sequence of other programs to do the work of compiling, assembling and
6836 linking. GCC interprets its command-line parameters and uses these to
6837 deduce which programs it should invoke, and which command-line options
6838 it ought to place on their command lines. This behavior is controlled
6839 by @dfn{spec strings}. In most cases there is one spec string for each
6840 program that GCC can invoke, but a few programs have multiple spec
6841 strings to control their behavior. The spec strings built into GCC can
6842 be overridden by using the @option{-specs=} command-line switch to specify
6843 a spec file.
6844
6845 @dfn{Spec files} are plaintext files that are used to construct spec
6846 strings. They consist of a sequence of directives separated by blank
6847 lines. The type of directive is determined by the first non-whitespace
6848 character on the line and it can be one of the following:
6849
6850 @table @code
6851 @item %@var{command}
6852 Issues a @var{command} to the spec file processor. The commands that can
6853 appear here are:
6854
6855 @table @code
6856 @item %include <@var{file}>
6857 @cindex %include
6858 Search for @var{file} and insert its text at the current point in the
6859 specs file.
6860
6861 @item %include_noerr <@var{file}>
6862 @cindex %include_noerr
6863 Just like @samp{%include}, but do not generate an error message if the include
6864 file cannot be found.
6865
6866 @item %rename @var{old_name} @var{new_name}
6867 @cindex %rename
6868 Rename the spec string @var{old_name} to @var{new_name}.
6869
6870 @end table
6871
6872 @item *[@var{spec_name}]:
6873 This tells the compiler to create, override or delete the named spec
6874 string. All lines after this directive up to the next directive or
6875 blank line are considered to be the text for the spec string. If this
6876 results in an empty string then the spec will be deleted. (Or, if the
6877 spec did not exist, then nothing will happened.) Otherwise, if the spec
6878 does not currently exist a new spec will be created. If the spec does
6879 exist then its contents will be overridden by the text of this
6880 directive, unless the first character of that text is the @samp{+}
6881 character, in which case the text will be appended to the spec.
6882
6883 @item [@var{suffix}]:
6884 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6885 and up to the next directive or blank line are considered to make up the
6886 spec string for the indicated suffix. When the compiler encounters an
6887 input file with the named suffix, it will processes the spec string in
6888 order to work out how to compile that file. For example:
6889
6890 @smallexample
6891 .ZZ:
6892 z-compile -input %i
6893 @end smallexample
6894
6895 This says that any input file whose name ends in @samp{.ZZ} should be
6896 passed to the program @samp{z-compile}, which should be invoked with the
6897 command-line switch @option{-input} and with the result of performing the
6898 @samp{%i} substitution. (See below.)
6899
6900 As an alternative to providing a spec string, the text that follows a
6901 suffix directive can be one of the following:
6902
6903 @table @code
6904 @item @@@var{language}
6905 This says that the suffix is an alias for a known @var{language}. This is
6906 similar to using the @option{-x} command-line switch to GCC to specify a
6907 language explicitly. For example:
6908
6909 @smallexample
6910 .ZZ:
6911 @@c++
6912 @end smallexample
6913
6914 Says that .ZZ files are, in fact, C++ source files.
6915
6916 @item #@var{name}
6917 This causes an error messages saying:
6918
6919 @smallexample
6920 @var{name} compiler not installed on this system.
6921 @end smallexample
6922 @end table
6923
6924 GCC already has an extensive list of suffixes built into it.
6925 This directive will add an entry to the end of the list of suffixes, but
6926 since the list is searched from the end backwards, it is effectively
6927 possible to override earlier entries using this technique.
6928
6929 @end table
6930
6931 GCC has the following spec strings built into it. Spec files can
6932 override these strings or create their own. Note that individual
6933 targets can also add their own spec strings to this list.
6934
6935 @smallexample
6936 asm Options to pass to the assembler
6937 asm_final Options to pass to the assembler post-processor
6938 cpp Options to pass to the C preprocessor
6939 cc1 Options to pass to the C compiler
6940 cc1plus Options to pass to the C++ compiler
6941 endfile Object files to include at the end of the link
6942 link Options to pass to the linker
6943 lib Libraries to include on the command line to the linker
6944 libgcc Decides which GCC support library to pass to the linker
6945 linker Sets the name of the linker
6946 predefines Defines to be passed to the C preprocessor
6947 signed_char Defines to pass to CPP to say whether @code{char} is signed
6948 by default
6949 startfile Object files to include at the start of the link
6950 @end smallexample
6951
6952 Here is a small example of a spec file:
6953
6954 @smallexample
6955 %rename lib old_lib
6956
6957 *lib:
6958 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6959 @end smallexample
6960
6961 This example renames the spec called @samp{lib} to @samp{old_lib} and
6962 then overrides the previous definition of @samp{lib} with a new one.
6963 The new definition adds in some extra command-line options before
6964 including the text of the old definition.
6965
6966 @dfn{Spec strings} are a list of command-line options to be passed to their
6967 corresponding program. In addition, the spec strings can contain
6968 @samp{%}-prefixed sequences to substitute variable text or to
6969 conditionally insert text into the command line. Using these constructs
6970 it is possible to generate quite complex command lines.
6971
6972 Here is a table of all defined @samp{%}-sequences for spec
6973 strings. Note that spaces are not generated automatically around the
6974 results of expanding these sequences. Therefore you can concatenate them
6975 together or combine them with constant text in a single argument.
6976
6977 @table @code
6978 @item %%
6979 Substitute one @samp{%} into the program name or argument.
6980
6981 @item %i
6982 Substitute the name of the input file being processed.
6983
6984 @item %b
6985 Substitute the basename of the input file being processed.
6986 This is the substring up to (and not including) the last period
6987 and not including the directory.
6988
6989 @item %B
6990 This is the same as @samp{%b}, but include the file suffix (text after
6991 the last period).
6992
6993 @item %d
6994 Marks the argument containing or following the @samp{%d} as a
6995 temporary file name, so that that file will be deleted if GCC exits
6996 successfully. Unlike @samp{%g}, this contributes no text to the
6997 argument.
6998
6999 @item %g@var{suffix}
7000 Substitute a file name that has suffix @var{suffix} and is chosen
7001 once per compilation, and mark the argument in the same way as
7002 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
7003 name is now chosen in a way that is hard to predict even when previously
7004 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
7005 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
7006 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
7007 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
7008 was simply substituted with a file name chosen once per compilation,
7009 without regard to any appended suffix (which was therefore treated
7010 just like ordinary text), making such attacks more likely to succeed.
7011
7012 @item %u@var{suffix}
7013 Like @samp{%g}, but generates a new temporary file name even if
7014 @samp{%u@var{suffix}} was already seen.
7015
7016 @item %U@var{suffix}
7017 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
7018 new one if there is no such last file name. In the absence of any
7019 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
7020 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
7021 would involve the generation of two distinct file names, one
7022 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
7023 simply substituted with a file name chosen for the previous @samp{%u},
7024 without regard to any appended suffix.
7025
7026 @item %j@var{suffix}
7027 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
7028 writable, and if save-temps is off; otherwise, substitute the name
7029 of a temporary file, just like @samp{%u}. This temporary file is not
7030 meant for communication between processes, but rather as a junk
7031 disposal mechanism.
7032
7033 @item %|@var{suffix}
7034 @itemx %m@var{suffix}
7035 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
7036 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
7037 all. These are the two most common ways to instruct a program that it
7038 should read from standard input or write to standard output. If you
7039 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
7040 construct: see for example @file{f/lang-specs.h}.
7041
7042 @item %.@var{SUFFIX}
7043 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
7044 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
7045 terminated by the next space or %.
7046
7047 @item %w
7048 Marks the argument containing or following the @samp{%w} as the
7049 designated output file of this compilation. This puts the argument
7050 into the sequence of arguments that @samp{%o} will substitute later.
7051
7052 @item %o
7053 Substitutes the names of all the output files, with spaces
7054 automatically placed around them. You should write spaces
7055 around the @samp{%o} as well or the results are undefined.
7056 @samp{%o} is for use in the specs for running the linker.
7057 Input files whose names have no recognized suffix are not compiled
7058 at all, but they are included among the output files, so they will
7059 be linked.
7060
7061 @item %O
7062 Substitutes the suffix for object files. Note that this is
7063 handled specially when it immediately follows @samp{%g, %u, or %U},
7064 because of the need for those to form complete file names. The
7065 handling is such that @samp{%O} is treated exactly as if it had already
7066 been substituted, except that @samp{%g, %u, and %U} do not currently
7067 support additional @var{suffix} characters following @samp{%O} as they would
7068 following, for example, @samp{.o}.
7069
7070 @item %p
7071 Substitutes the standard macro predefinitions for the
7072 current target machine. Use this when running @code{cpp}.
7073
7074 @item %P
7075 Like @samp{%p}, but puts @samp{__} before and after the name of each
7076 predefined macro, except for macros that start with @samp{__} or with
7077 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
7078 C@.
7079
7080 @item %I
7081 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
7082 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
7083 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
7084 and @option{-imultilib} as necessary.
7085
7086 @item %s
7087 Current argument is the name of a library or startup file of some sort.
7088 Search for that file in a standard list of directories and substitute
7089 the full name found.
7090
7091 @item %e@var{str}
7092 Print @var{str} as an error message. @var{str} is terminated by a newline.
7093 Use this when inconsistent options are detected.
7094
7095 @item %(@var{name})
7096 Substitute the contents of spec string @var{name} at this point.
7097
7098 @item %[@var{name}]
7099 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
7100
7101 @item %x@{@var{option}@}
7102 Accumulate an option for @samp{%X}.
7103
7104 @item %X
7105 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
7106 spec string.
7107
7108 @item %Y
7109 Output the accumulated assembler options specified by @option{-Wa}.
7110
7111 @item %Z
7112 Output the accumulated preprocessor options specified by @option{-Wp}.
7113
7114 @item %a
7115 Process the @code{asm} spec. This is used to compute the
7116 switches to be passed to the assembler.
7117
7118 @item %A
7119 Process the @code{asm_final} spec. This is a spec string for
7120 passing switches to an assembler post-processor, if such a program is
7121 needed.
7122
7123 @item %l
7124 Process the @code{link} spec. This is the spec for computing the
7125 command line passed to the linker. Typically it will make use of the
7126 @samp{%L %G %S %D and %E} sequences.
7127
7128 @item %D
7129 Dump out a @option{-L} option for each directory that GCC believes might
7130 contain startup files. If the target supports multilibs then the
7131 current multilib directory will be prepended to each of these paths.
7132
7133 @item %L
7134 Process the @code{lib} spec. This is a spec string for deciding which
7135 libraries should be included on the command line to the linker.
7136
7137 @item %G
7138 Process the @code{libgcc} spec. This is a spec string for deciding
7139 which GCC support library should be included on the command line to the linker.
7140
7141 @item %S
7142 Process the @code{startfile} spec. This is a spec for deciding which
7143 object files should be the first ones passed to the linker. Typically
7144 this might be a file named @file{crt0.o}.
7145
7146 @item %E
7147 Process the @code{endfile} spec. This is a spec string that specifies
7148 the last object files that will be passed to the linker.
7149
7150 @item %C
7151 Process the @code{cpp} spec. This is used to construct the arguments
7152 to be passed to the C preprocessor.
7153
7154 @item %1
7155 Process the @code{cc1} spec. This is used to construct the options to be
7156 passed to the actual C compiler (@samp{cc1}).
7157
7158 @item %2
7159 Process the @code{cc1plus} spec. This is used to construct the options to be
7160 passed to the actual C++ compiler (@samp{cc1plus}).
7161
7162 @item %*
7163 Substitute the variable part of a matched option. See below.
7164 Note that each comma in the substituted string is replaced by
7165 a single space.
7166
7167 @item %<@code{S}
7168 Remove all occurrences of @code{-S} from the command line. Note---this
7169 command is position dependent. @samp{%} commands in the spec string
7170 before this one will see @code{-S}, @samp{%} commands in the spec string
7171 after this one will not.
7172
7173 @item %:@var{function}(@var{args})
7174 Call the named function @var{function}, passing it @var{args}.
7175 @var{args} is first processed as a nested spec string, then split
7176 into an argument vector in the usual fashion. The function returns
7177 a string which is processed as if it had appeared literally as part
7178 of the current spec.
7179
7180 The following built-in spec functions are provided:
7181
7182 @table @code
7183 @item @code{if-exists}
7184 The @code{if-exists} spec function takes one argument, an absolute
7185 pathname to a file. If the file exists, @code{if-exists} returns the
7186 pathname. Here is a small example of its usage:
7187
7188 @smallexample
7189 *startfile:
7190 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
7191 @end smallexample
7192
7193 @item @code{if-exists-else}
7194 The @code{if-exists-else} spec function is similar to the @code{if-exists}
7195 spec function, except that it takes two arguments. The first argument is
7196 an absolute pathname to a file. If the file exists, @code{if-exists-else}
7197 returns the pathname. If it does not exist, it returns the second argument.
7198 This way, @code{if-exists-else} can be used to select one file or another,
7199 based on the existence of the first. Here is a small example of its usage:
7200
7201 @smallexample
7202 *startfile:
7203 crt0%O%s %:if-exists(crti%O%s) \
7204 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
7205 @end smallexample
7206
7207 @item @code{replace-outfile}
7208 The @code{replace-outfile} spec function takes two arguments. It looks for the
7209 first argument in the outfiles array and replaces it with the second argument. Here
7210 is a small example of its usage:
7211
7212 @smallexample
7213 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
7214 @end smallexample
7215
7216 @end table
7217
7218 @item %@{@code{S}@}
7219 Substitutes the @code{-S} switch, if that switch was given to GCC@.
7220 If that switch was not specified, this substitutes nothing. Note that
7221 the leading dash is omitted when specifying this option, and it is
7222 automatically inserted if the substitution is performed. Thus the spec
7223 string @samp{%@{foo@}} would match the command-line option @option{-foo}
7224 and would output the command line option @option{-foo}.
7225
7226 @item %W@{@code{S}@}
7227 Like %@{@code{S}@} but mark last argument supplied within as a file to be
7228 deleted on failure.
7229
7230 @item %@{@code{S}*@}
7231 Substitutes all the switches specified to GCC whose names start
7232 with @code{-S}, but which also take an argument. This is used for
7233 switches like @option{-o}, @option{-D}, @option{-I}, etc.
7234 GCC considers @option{-o foo} as being
7235 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
7236 text, including the space. Thus two arguments would be generated.
7237
7238 @item %@{@code{S}*&@code{T}*@}
7239 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
7240 (the order of @code{S} and @code{T} in the spec is not significant).
7241 There can be any number of ampersand-separated variables; for each the
7242 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
7243
7244 @item %@{@code{S}:@code{X}@}
7245 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
7246
7247 @item %@{!@code{S}:@code{X}@}
7248 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
7249
7250 @item %@{@code{S}*:@code{X}@}
7251 Substitutes @code{X} if one or more switches whose names start with
7252 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
7253 once, no matter how many such switches appeared. However, if @code{%*}
7254 appears somewhere in @code{X}, then @code{X} will be substituted once
7255 for each matching switch, with the @code{%*} replaced by the part of
7256 that switch that matched the @code{*}.
7257
7258 @item %@{.@code{S}:@code{X}@}
7259 Substitutes @code{X}, if processing a file with suffix @code{S}.
7260
7261 @item %@{!.@code{S}:@code{X}@}
7262 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
7263
7264 @item %@{@code{S}|@code{P}:@code{X}@}
7265 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
7266 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
7267 although they have a stronger binding than the @samp{|}. If @code{%*}
7268 appears in @code{X}, all of the alternatives must be starred, and only
7269 the first matching alternative is substituted.
7270
7271 For example, a spec string like this:
7272
7273 @smallexample
7274 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
7275 @end smallexample
7276
7277 will output the following command-line options from the following input
7278 command-line options:
7279
7280 @smallexample
7281 fred.c -foo -baz
7282 jim.d -bar -boggle
7283 -d fred.c -foo -baz -boggle
7284 -d jim.d -bar -baz -boggle
7285 @end smallexample
7286
7287 @item %@{S:X; T:Y; :D@}
7288
7289 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
7290 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
7291 be as many clauses as you need. This may be combined with @code{.},
7292 @code{!}, @code{|}, and @code{*} as needed.
7293
7294
7295 @end table
7296
7297 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
7298 construct may contain other nested @samp{%} constructs or spaces, or
7299 even newlines. They are processed as usual, as described above.
7300 Trailing white space in @code{X} is ignored. White space may also
7301 appear anywhere on the left side of the colon in these constructs,
7302 except between @code{.} or @code{*} and the corresponding word.
7303
7304 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
7305 handled specifically in these constructs. If another value of
7306 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
7307 @option{-W} switch is found later in the command line, the earlier
7308 switch value is ignored, except with @{@code{S}*@} where @code{S} is
7309 just one letter, which passes all matching options.
7310
7311 The character @samp{|} at the beginning of the predicate text is used to
7312 indicate that a command should be piped to the following command, but
7313 only if @option{-pipe} is specified.
7314
7315 It is built into GCC which switches take arguments and which do not.
7316 (You might think it would be useful to generalize this to allow each
7317 compiler's spec to say which switches take arguments. But this cannot
7318 be done in a consistent fashion. GCC cannot even decide which input
7319 files have been specified without knowing which switches take arguments,
7320 and it must know which input files to compile in order to tell which
7321 compilers to run).
7322
7323 GCC also knows implicitly that arguments starting in @option{-l} are to be
7324 treated as compiler output files, and passed to the linker in their
7325 proper position among the other output files.
7326
7327 @c man begin OPTIONS
7328
7329 @node Target Options
7330 @section Specifying Target Machine and Compiler Version
7331 @cindex target options
7332 @cindex cross compiling
7333 @cindex specifying machine version
7334 @cindex specifying compiler version and target machine
7335 @cindex compiler version, specifying
7336 @cindex target machine, specifying
7337
7338 The usual way to run GCC is to run the executable called @file{gcc}, or
7339 @file{<machine>-gcc} when cross-compiling, or
7340 @file{<machine>-gcc-<version>} to run a version other than the one that
7341 was installed last. Sometimes this is inconvenient, so GCC provides
7342 options that will switch to another cross-compiler or version.
7343
7344 @table @gcctabopt
7345 @item -b @var{machine}
7346 @opindex b
7347 The argument @var{machine} specifies the target machine for compilation.
7348
7349 The value to use for @var{machine} is the same as was specified as the
7350 machine type when configuring GCC as a cross-compiler. For
7351 example, if a cross-compiler was configured with @samp{configure
7352 arm-elf}, meaning to compile for an arm processor with elf binaries,
7353 then you would specify @option{-b arm-elf} to run that cross compiler.
7354 Because there are other options beginning with @option{-b}, the
7355 configuration must contain a hyphen.
7356
7357 @item -V @var{version}
7358 @opindex V
7359 The argument @var{version} specifies which version of GCC to run.
7360 This is useful when multiple versions are installed. For example,
7361 @var{version} might be @samp{4.0}, meaning to run GCC version 4.0.
7362 @end table
7363
7364 The @option{-V} and @option{-b} options work by running the
7365 @file{<machine>-gcc-<version>} executable, so there's no real reason to
7366 use them if you can just run that directly.
7367
7368 @node Submodel Options
7369 @section Hardware Models and Configurations
7370 @cindex submodel options
7371 @cindex specifying hardware config
7372 @cindex hardware models and configurations, specifying
7373 @cindex machine dependent options
7374
7375 Earlier we discussed the standard option @option{-b} which chooses among
7376 different installed compilers for completely different target
7377 machines, such as VAX vs.@: 68000 vs.@: 80386.
7378
7379 In addition, each of these target machine types can have its own
7380 special options, starting with @samp{-m}, to choose among various
7381 hardware models or configurations---for example, 68010 vs 68020,
7382 floating coprocessor or none. A single installed version of the
7383 compiler can compile for any model or configuration, according to the
7384 options specified.
7385
7386 Some configurations of the compiler also support additional special
7387 options, usually for compatibility with other compilers on the same
7388 platform.
7389
7390 @c This list is ordered alphanumerically by subsection name.
7391 @c It should be the same order and spelling as these options are listed
7392 @c in Machine Dependent Options
7393
7394 @menu
7395 * ARC Options::
7396 * ARM Options::
7397 * AVR Options::
7398 * Blackfin Options::
7399 * CRIS Options::
7400 * CRX Options::
7401 * Darwin Options::
7402 * DEC Alpha Options::
7403 * DEC Alpha/VMS Options::
7404 * FRV Options::
7405 * GNU/Linux Options::
7406 * H8/300 Options::
7407 * HPPA Options::
7408 * i386 and x86-64 Options::
7409 * IA-64 Options::
7410 * M32C Options::
7411 * M32R/D Options::
7412 * M680x0 Options::
7413 * M68hc1x Options::
7414 * MCore Options::
7415 * MIPS Options::
7416 * MMIX Options::
7417 * MN10300 Options::
7418 * MT Options::
7419 * PDP-11 Options::
7420 * PowerPC Options::
7421 * RS/6000 and PowerPC Options::
7422 * S/390 and zSeries Options::
7423 * Score Options::
7424 * SH Options::
7425 * SPARC Options::
7426 * SPU Options::
7427 * System V Options::
7428 * TMS320C3x/C4x Options::
7429 * V850 Options::
7430 * VAX Options::
7431 * x86-64 Options::
7432 * Xstormy16 Options::
7433 * Xtensa Options::
7434 * zSeries Options::
7435 @end menu
7436
7437 @node ARC Options
7438 @subsection ARC Options
7439 @cindex ARC Options
7440
7441 These options are defined for ARC implementations:
7442
7443 @table @gcctabopt
7444 @item -EL
7445 @opindex EL
7446 Compile code for little endian mode. This is the default.
7447
7448 @item -EB
7449 @opindex EB
7450 Compile code for big endian mode.
7451
7452 @item -mmangle-cpu
7453 @opindex mmangle-cpu
7454 Prepend the name of the cpu to all public symbol names.
7455 In multiple-processor systems, there are many ARC variants with different
7456 instruction and register set characteristics. This flag prevents code
7457 compiled for one cpu to be linked with code compiled for another.
7458 No facility exists for handling variants that are ``almost identical''.
7459 This is an all or nothing option.
7460
7461 @item -mcpu=@var{cpu}
7462 @opindex mcpu
7463 Compile code for ARC variant @var{cpu}.
7464 Which variants are supported depend on the configuration.
7465 All variants support @option{-mcpu=base}, this is the default.
7466
7467 @item -mtext=@var{text-section}
7468 @itemx -mdata=@var{data-section}
7469 @itemx -mrodata=@var{readonly-data-section}
7470 @opindex mtext
7471 @opindex mdata
7472 @opindex mrodata
7473 Put functions, data, and readonly data in @var{text-section},
7474 @var{data-section}, and @var{readonly-data-section} respectively
7475 by default. This can be overridden with the @code{section} attribute.
7476 @xref{Variable Attributes}.
7477
7478 @end table
7479
7480 @node ARM Options
7481 @subsection ARM Options
7482 @cindex ARM options
7483
7484 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7485 architectures:
7486
7487 @table @gcctabopt
7488 @item -mabi=@var{name}
7489 @opindex mabi
7490 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
7491 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
7492
7493 @item -mapcs-frame
7494 @opindex mapcs-frame
7495 Generate a stack frame that is compliant with the ARM Procedure Call
7496 Standard for all functions, even if this is not strictly necessary for
7497 correct execution of the code. Specifying @option{-fomit-frame-pointer}
7498 with this option will cause the stack frames not to be generated for
7499 leaf functions. The default is @option{-mno-apcs-frame}.
7500
7501 @item -mapcs
7502 @opindex mapcs
7503 This is a synonym for @option{-mapcs-frame}.
7504
7505 @ignore
7506 @c not currently implemented
7507 @item -mapcs-stack-check
7508 @opindex mapcs-stack-check
7509 Generate code to check the amount of stack space available upon entry to
7510 every function (that actually uses some stack space). If there is
7511 insufficient space available then either the function
7512 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7513 called, depending upon the amount of stack space required. The run time
7514 system is required to provide these functions. The default is
7515 @option{-mno-apcs-stack-check}, since this produces smaller code.
7516
7517 @c not currently implemented
7518 @item -mapcs-float
7519 @opindex mapcs-float
7520 Pass floating point arguments using the float point registers. This is
7521 one of the variants of the APCS@. This option is recommended if the
7522 target hardware has a floating point unit or if a lot of floating point
7523 arithmetic is going to be performed by the code. The default is
7524 @option{-mno-apcs-float}, since integer only code is slightly increased in
7525 size if @option{-mapcs-float} is used.
7526
7527 @c not currently implemented
7528 @item -mapcs-reentrant
7529 @opindex mapcs-reentrant
7530 Generate reentrant, position independent code. The default is
7531 @option{-mno-apcs-reentrant}.
7532 @end ignore
7533
7534 @item -mthumb-interwork
7535 @opindex mthumb-interwork
7536 Generate code which supports calling between the ARM and Thumb
7537 instruction sets. Without this option the two instruction sets cannot
7538 be reliably used inside one program. The default is
7539 @option{-mno-thumb-interwork}, since slightly larger code is generated
7540 when @option{-mthumb-interwork} is specified.
7541
7542 @item -mno-sched-prolog
7543 @opindex mno-sched-prolog
7544 Prevent the reordering of instructions in the function prolog, or the
7545 merging of those instruction with the instructions in the function's
7546 body. This means that all functions will start with a recognizable set
7547 of instructions (or in fact one of a choice from a small set of
7548 different function prologues), and this information can be used to
7549 locate the start if functions inside an executable piece of code. The
7550 default is @option{-msched-prolog}.
7551
7552 @item -mhard-float
7553 @opindex mhard-float
7554 Generate output containing floating point instructions. This is the
7555 default.
7556
7557 @item -msoft-float
7558 @opindex msoft-float
7559 Generate output containing library calls for floating point.
7560 @strong{Warning:} the requisite libraries are not available for all ARM
7561 targets. Normally the facilities of the machine's usual C compiler are
7562 used, but this cannot be done directly in cross-compilation. You must make
7563 your own arrangements to provide suitable library functions for
7564 cross-compilation.
7565
7566 @option{-msoft-float} changes the calling convention in the output file;
7567 therefore, it is only useful if you compile @emph{all} of a program with
7568 this option. In particular, you need to compile @file{libgcc.a}, the
7569 library that comes with GCC, with @option{-msoft-float} in order for
7570 this to work.
7571
7572 @item -mfloat-abi=@var{name}
7573 @opindex mfloat-abi
7574 Specifies which ABI to use for floating point values. Permissible values
7575 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7576
7577 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7578 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
7579 of floating point instructions, but still uses the soft-float calling
7580 conventions.
7581
7582 @item -mlittle-endian
7583 @opindex mlittle-endian
7584 Generate code for a processor running in little-endian mode. This is
7585 the default for all standard configurations.
7586
7587 @item -mbig-endian
7588 @opindex mbig-endian
7589 Generate code for a processor running in big-endian mode; the default is
7590 to compile code for a little-endian processor.
7591
7592 @item -mwords-little-endian
7593 @opindex mwords-little-endian
7594 This option only applies when generating code for big-endian processors.
7595 Generate code for a little-endian word order but a big-endian byte
7596 order. That is, a byte order of the form @samp{32107654}. Note: this
7597 option should only be used if you require compatibility with code for
7598 big-endian ARM processors generated by versions of the compiler prior to
7599 2.8.
7600
7601 @item -mcpu=@var{name}
7602 @opindex mcpu
7603 This specifies the name of the target ARM processor. GCC uses this name
7604 to determine what kind of instructions it can emit when generating
7605 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7606 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7607 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7608 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7609 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7610 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7611 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7612 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7613 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7614 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7615 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7616 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7617 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7618 @samp{arm1156t2-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
7619 @samp{cortex-a8}, @samp{cortex-r4}, @samp{cortex-m3},
7620 @samp{xscale}, @samp{iwmmxt}, @samp{ep9312}.
7621
7622 @itemx -mtune=@var{name}
7623 @opindex mtune
7624 This option is very similar to the @option{-mcpu=} option, except that
7625 instead of specifying the actual target processor type, and hence
7626 restricting which instructions can be used, it specifies that GCC should
7627 tune the performance of the code as if the target were of the type
7628 specified in this option, but still choosing the instructions that it
7629 will generate based on the cpu specified by a @option{-mcpu=} option.
7630 For some ARM implementations better performance can be obtained by using
7631 this option.
7632
7633 @item -march=@var{name}
7634 @opindex march
7635 This specifies the name of the target ARM architecture. GCC uses this
7636 name to determine what kind of instructions it can emit when generating
7637 assembly code. This option can be used in conjunction with or instead
7638 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7639 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7640 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7641 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv7}, @samp{armv7-a},
7642 @samp{armv7-r}, @samp{armv7-m}, @samp{iwmmxt}, @samp{ep9312}.
7643
7644 @item -mfpu=@var{name}
7645 @itemx -mfpe=@var{number}
7646 @itemx -mfp=@var{number}
7647 @opindex mfpu
7648 @opindex mfpe
7649 @opindex mfp
7650 This specifies what floating point hardware (or hardware emulation) is
7651 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7652 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7653 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7654 with older versions of GCC@.
7655
7656 If @option{-msoft-float} is specified this specifies the format of
7657 floating point values.
7658
7659 @item -mstructure-size-boundary=@var{n}
7660 @opindex mstructure-size-boundary
7661 The size of all structures and unions will be rounded up to a multiple
7662 of the number of bits set by this option. Permissible values are 8, 32
7663 and 64. The default value varies for different toolchains. For the COFF
7664 targeted toolchain the default value is 8. A value of 64 is only allowed
7665 if the underlying ABI supports it.
7666
7667 Specifying the larger number can produce faster, more efficient code, but
7668 can also increase the size of the program. Different values are potentially
7669 incompatible. Code compiled with one value cannot necessarily expect to
7670 work with code or libraries compiled with another value, if they exchange
7671 information using structures or unions.
7672
7673 @item -mabort-on-noreturn
7674 @opindex mabort-on-noreturn
7675 Generate a call to the function @code{abort} at the end of a
7676 @code{noreturn} function. It will be executed if the function tries to
7677 return.
7678
7679 @item -mlong-calls
7680 @itemx -mno-long-calls
7681 @opindex mlong-calls
7682 @opindex mno-long-calls
7683 Tells the compiler to perform function calls by first loading the
7684 address of the function into a register and then performing a subroutine
7685 call on this register. This switch is needed if the target function
7686 will lie outside of the 64 megabyte addressing range of the offset based
7687 version of subroutine call instruction.
7688
7689 Even if this switch is enabled, not all function calls will be turned
7690 into long calls. The heuristic is that static functions, functions
7691 which have the @samp{short-call} attribute, functions that are inside
7692 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7693 definitions have already been compiled within the current compilation
7694 unit, will not be turned into long calls. The exception to this rule is
7695 that weak function definitions, functions with the @samp{long-call}
7696 attribute or the @samp{section} attribute, and functions that are within
7697 the scope of a @samp{#pragma long_calls} directive, will always be
7698 turned into long calls.
7699
7700 This feature is not enabled by default. Specifying
7701 @option{-mno-long-calls} will restore the default behavior, as will
7702 placing the function calls within the scope of a @samp{#pragma
7703 long_calls_off} directive. Note these switches have no effect on how
7704 the compiler generates code to handle function calls via function
7705 pointers.
7706
7707 @item -mnop-fun-dllimport
7708 @opindex mnop-fun-dllimport
7709 Disable support for the @code{dllimport} attribute.
7710
7711 @item -msingle-pic-base
7712 @opindex msingle-pic-base
7713 Treat the register used for PIC addressing as read-only, rather than
7714 loading it in the prologue for each function. The run-time system is
7715 responsible for initializing this register with an appropriate value
7716 before execution begins.
7717
7718 @item -mpic-register=@var{reg}
7719 @opindex mpic-register
7720 Specify the register to be used for PIC addressing. The default is R10
7721 unless stack-checking is enabled, when R9 is used.
7722
7723 @item -mcirrus-fix-invalid-insns
7724 @opindex mcirrus-fix-invalid-insns
7725 @opindex mno-cirrus-fix-invalid-insns
7726 Insert NOPs into the instruction stream to in order to work around
7727 problems with invalid Maverick instruction combinations. This option
7728 is only valid if the @option{-mcpu=ep9312} option has been used to
7729 enable generation of instructions for the Cirrus Maverick floating
7730 point co-processor. This option is not enabled by default, since the
7731 problem is only present in older Maverick implementations. The default
7732 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7733 switch.
7734
7735 @item -mpoke-function-name
7736 @opindex mpoke-function-name
7737 Write the name of each function into the text section, directly
7738 preceding the function prologue. The generated code is similar to this:
7739
7740 @smallexample
7741 t0
7742 .ascii "arm_poke_function_name", 0
7743 .align
7744 t1
7745 .word 0xff000000 + (t1 - t0)
7746 arm_poke_function_name
7747 mov ip, sp
7748 stmfd sp!, @{fp, ip, lr, pc@}
7749 sub fp, ip, #4
7750 @end smallexample
7751
7752 When performing a stack backtrace, code can inspect the value of
7753 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
7754 location @code{pc - 12} and the top 8 bits are set, then we know that
7755 there is a function name embedded immediately preceding this location
7756 and has length @code{((pc[-3]) & 0xff000000)}.
7757
7758 @item -mthumb
7759 @opindex mthumb
7760 Generate code for the Thumb instruction set. The default is to
7761 use the 32-bit ARM instruction set.
7762 This option automatically enables either 16-bit Thumb-1 or
7763 mixed 16/32-bit Thumb-2 instructions based on the @option{-mcpu=@var{name}}
7764 and @option{-march=@var{name}} options.
7765
7766 @item -mtpcs-frame
7767 @opindex mtpcs-frame
7768 Generate a stack frame that is compliant with the Thumb Procedure Call
7769 Standard for all non-leaf functions. (A leaf function is one that does
7770 not call any other functions.) The default is @option{-mno-tpcs-frame}.
7771
7772 @item -mtpcs-leaf-frame
7773 @opindex mtpcs-leaf-frame
7774 Generate a stack frame that is compliant with the Thumb Procedure Call
7775 Standard for all leaf functions. (A leaf function is one that does
7776 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
7777
7778 @item -mcallee-super-interworking
7779 @opindex mcallee-super-interworking
7780 Gives all externally visible functions in the file being compiled an ARM
7781 instruction set header which switches to Thumb mode before executing the
7782 rest of the function. This allows these functions to be called from
7783 non-interworking code.
7784
7785 @item -mcaller-super-interworking
7786 @opindex mcaller-super-interworking
7787 Allows calls via function pointers (including virtual functions) to
7788 execute correctly regardless of whether the target code has been
7789 compiled for interworking or not. There is a small overhead in the cost
7790 of executing a function pointer if this option is enabled.
7791
7792 @item -mtp=@var{name}
7793 @opindex mtp
7794 Specify the access model for the thread local storage pointer. The valid
7795 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
7796 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
7797 (supported in the arm6k architecture), and @option{auto}, which uses the
7798 best available method for the selected processor. The default setting is
7799 @option{auto}.
7800
7801 @end table
7802
7803 @node AVR Options
7804 @subsection AVR Options
7805 @cindex AVR Options
7806
7807 These options are defined for AVR implementations:
7808
7809 @table @gcctabopt
7810 @item -mmcu=@var{mcu}
7811 @opindex mmcu
7812 Specify ATMEL AVR instruction set or MCU type.
7813
7814 Instruction set avr1 is for the minimal AVR core, not supported by the C
7815 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7816 attiny11, attiny12, attiny15, attiny28).
7817
7818 Instruction set avr2 (default) is for the classic AVR core with up to
7819 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7820 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7821 at90c8534, at90s8535).
7822
7823 Instruction set avr3 is for the classic AVR core with up to 128K program
7824 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7825
7826 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7827 memory space (MCU types: atmega8, atmega83, atmega85).
7828
7829 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7830 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7831 atmega64, atmega128, at43usb355, at94k).
7832
7833 @item -msize
7834 @opindex msize
7835 Output instruction sizes to the asm file.
7836
7837 @item -minit-stack=@var{N}
7838 @opindex minit-stack
7839 Specify the initial stack address, which may be a symbol or numeric value,
7840 @samp{__stack} is the default.
7841
7842 @item -mno-interrupts
7843 @opindex mno-interrupts
7844 Generated code is not compatible with hardware interrupts.
7845 Code size will be smaller.
7846
7847 @item -mcall-prologues
7848 @opindex mcall-prologues
7849 Functions prologues/epilogues expanded as call to appropriate
7850 subroutines. Code size will be smaller.
7851
7852 @item -mno-tablejump
7853 @opindex mno-tablejump
7854 Do not generate tablejump insns which sometimes increase code size.
7855
7856 @item -mtiny-stack
7857 @opindex mtiny-stack
7858 Change only the low 8 bits of the stack pointer.
7859
7860 @item -mint8
7861 @opindex mint8
7862 Assume int to be 8 bit integer. This affects the sizes of all types: A
7863 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7864 and long long will be 4 bytes. Please note that this option does not
7865 comply to the C standards, but it will provide you with smaller code
7866 size.
7867 @end table
7868
7869 @node Blackfin Options
7870 @subsection Blackfin Options
7871 @cindex Blackfin Options
7872
7873 @table @gcctabopt
7874 @item -momit-leaf-frame-pointer
7875 @opindex momit-leaf-frame-pointer
7876 Don't keep the frame pointer in a register for leaf functions. This
7877 avoids the instructions to save, set up and restore frame pointers and
7878 makes an extra register available in leaf functions. The option
7879 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7880 which might make debugging harder.
7881
7882 @item -mspecld-anomaly
7883 @opindex mspecld-anomaly
7884 When enabled, the compiler will ensure that the generated code does not
7885 contain speculative loads after jump instructions. This option is enabled
7886 by default.
7887
7888 @item -mno-specld-anomaly
7889 @opindex mno-specld-anomaly
7890 Don't generate extra code to prevent speculative loads from occurring.
7891
7892 @item -mcsync-anomaly
7893 @opindex mcsync-anomaly
7894 When enabled, the compiler will ensure that the generated code does not
7895 contain CSYNC or SSYNC instructions too soon after conditional branches.
7896 This option is enabled by default.
7897
7898 @item -mno-csync-anomaly
7899 @opindex mno-csync-anomaly
7900 Don't generate extra code to prevent CSYNC or SSYNC instructions from
7901 occurring too soon after a conditional branch.
7902
7903 @item -mlow-64k
7904 @opindex mlow-64k
7905 When enabled, the compiler is free to take advantage of the knowledge that
7906 the entire program fits into the low 64k of memory.
7907
7908 @item -mno-low-64k
7909 @opindex mno-low-64k
7910 Assume that the program is arbitrarily large. This is the default.
7911
7912 @item -mstack-check-l1
7913 @opindex mstack-check-l1
7914 Do stack checking using information placed into L1 scratchpad memory by the
7915 uClinux kernel.
7916
7917 @item -mid-shared-library
7918 @opindex mid-shared-library
7919 Generate code that supports shared libraries via the library ID method.
7920 This allows for execute in place and shared libraries in an environment
7921 without virtual memory management. This option implies @option{-fPIC}.
7922
7923 @item -mno-id-shared-library
7924 @opindex mno-id-shared-library
7925 Generate code that doesn't assume ID based shared libraries are being used.
7926 This is the default.
7927
7928 @item -mleaf-id-shared-library
7929 @opindex mleaf-id-shared-library
7930 Generate code that supports shared libraries via the library ID method,
7931 but assumes that this library or executable won't link against any other
7932 ID shared libraries. That allows the compiler to use faster code for jumps
7933 and calls.
7934
7935 @item -mno-leaf-id-shared-library
7936 @opindex mno-leaf-id-shared-library
7937 Do not assume that the code being compiled won't link against any ID shared
7938 libraries. Slower code will be generated for jump and call insns.
7939
7940 @item -mshared-library-id=n
7941 @opindex mshared-library-id
7942 Specified the identification number of the ID based shared library being
7943 compiled. Specifying a value of 0 will generate more compact code, specifying
7944 other values will force the allocation of that number to the current
7945 library but is no more space or time efficient than omitting this option.
7946
7947 @item -msep-data
7948 @opindex msep-data
7949 Generate code that allows the data segment to be located in a different
7950 area of memory from the text segment. This allows for execute in place in
7951 an environment without virtual memory management by eliminating relocations
7952 against the text section.
7953
7954 @item -mno-sep-data
7955 @opindex mno-sep-data
7956 Generate code that assumes that the data segment follows the text segment.
7957 This is the default.
7958
7959 @item -mlong-calls
7960 @itemx -mno-long-calls
7961 @opindex mlong-calls
7962 @opindex mno-long-calls
7963 Tells the compiler to perform function calls by first loading the
7964 address of the function into a register and then performing a subroutine
7965 call on this register. This switch is needed if the target function
7966 will lie outside of the 24 bit addressing range of the offset based
7967 version of subroutine call instruction.
7968
7969 This feature is not enabled by default. Specifying
7970 @option{-mno-long-calls} will restore the default behavior. Note these
7971 switches have no effect on how the compiler generates code to handle
7972 function calls via function pointers.
7973 @end table
7974
7975 @node CRIS Options
7976 @subsection CRIS Options
7977 @cindex CRIS Options
7978
7979 These options are defined specifically for the CRIS ports.
7980
7981 @table @gcctabopt
7982 @item -march=@var{architecture-type}
7983 @itemx -mcpu=@var{architecture-type}
7984 @opindex march
7985 @opindex mcpu
7986 Generate code for the specified architecture. The choices for
7987 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7988 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7989 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7990 @samp{v10}.
7991
7992 @item -mtune=@var{architecture-type}
7993 @opindex mtune
7994 Tune to @var{architecture-type} everything applicable about the generated
7995 code, except for the ABI and the set of available instructions. The
7996 choices for @var{architecture-type} are the same as for
7997 @option{-march=@var{architecture-type}}.
7998
7999 @item -mmax-stack-frame=@var{n}
8000 @opindex mmax-stack-frame
8001 Warn when the stack frame of a function exceeds @var{n} bytes.
8002
8003 @item -melinux-stacksize=@var{n}
8004 @opindex melinux-stacksize
8005 Only available with the @samp{cris-axis-aout} target. Arranges for
8006 indications in the program to the kernel loader that the stack of the
8007 program should be set to @var{n} bytes.
8008
8009 @item -metrax4
8010 @itemx -metrax100
8011 @opindex metrax4
8012 @opindex metrax100
8013 The options @option{-metrax4} and @option{-metrax100} are synonyms for
8014 @option{-march=v3} and @option{-march=v8} respectively.
8015
8016 @item -mmul-bug-workaround
8017 @itemx -mno-mul-bug-workaround
8018 @opindex mmul-bug-workaround
8019 @opindex mno-mul-bug-workaround
8020 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
8021 models where it applies. This option is active by default.
8022
8023 @item -mpdebug
8024 @opindex mpdebug
8025 Enable CRIS-specific verbose debug-related information in the assembly
8026 code. This option also has the effect to turn off the @samp{#NO_APP}
8027 formatted-code indicator to the assembler at the beginning of the
8028 assembly file.
8029
8030 @item -mcc-init
8031 @opindex mcc-init
8032 Do not use condition-code results from previous instruction; always emit
8033 compare and test instructions before use of condition codes.
8034
8035 @item -mno-side-effects
8036 @opindex mno-side-effects
8037 Do not emit instructions with side-effects in addressing modes other than
8038 post-increment.
8039
8040 @item -mstack-align
8041 @itemx -mno-stack-align
8042 @itemx -mdata-align
8043 @itemx -mno-data-align
8044 @itemx -mconst-align
8045 @itemx -mno-const-align
8046 @opindex mstack-align
8047 @opindex mno-stack-align
8048 @opindex mdata-align
8049 @opindex mno-data-align
8050 @opindex mconst-align
8051 @opindex mno-const-align
8052 These options (no-options) arranges (eliminate arrangements) for the
8053 stack-frame, individual data and constants to be aligned for the maximum
8054 single data access size for the chosen CPU model. The default is to
8055 arrange for 32-bit alignment. ABI details such as structure layout are
8056 not affected by these options.
8057
8058 @item -m32-bit
8059 @itemx -m16-bit
8060 @itemx -m8-bit
8061 @opindex m32-bit
8062 @opindex m16-bit
8063 @opindex m8-bit
8064 Similar to the stack- data- and const-align options above, these options
8065 arrange for stack-frame, writable data and constants to all be 32-bit,
8066 16-bit or 8-bit aligned. The default is 32-bit alignment.
8067
8068 @item -mno-prologue-epilogue
8069 @itemx -mprologue-epilogue
8070 @opindex mno-prologue-epilogue
8071 @opindex mprologue-epilogue
8072 With @option{-mno-prologue-epilogue}, the normal function prologue and
8073 epilogue that sets up the stack-frame are omitted and no return
8074 instructions or return sequences are generated in the code. Use this
8075 option only together with visual inspection of the compiled code: no
8076 warnings or errors are generated when call-saved registers must be saved,
8077 or storage for local variable needs to be allocated.
8078
8079 @item -mno-gotplt
8080 @itemx -mgotplt
8081 @opindex mno-gotplt
8082 @opindex mgotplt
8083 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
8084 instruction sequences that load addresses for functions from the PLT part
8085 of the GOT rather than (traditional on other architectures) calls to the
8086 PLT@. The default is @option{-mgotplt}.
8087
8088 @item -maout
8089 @opindex maout
8090 Legacy no-op option only recognized with the cris-axis-aout target.
8091
8092 @item -melf
8093 @opindex melf
8094 Legacy no-op option only recognized with the cris-axis-elf and
8095 cris-axis-linux-gnu targets.
8096
8097 @item -melinux
8098 @opindex melinux
8099 Only recognized with the cris-axis-aout target, where it selects a
8100 GNU/linux-like multilib, include files and instruction set for
8101 @option{-march=v8}.
8102
8103 @item -mlinux
8104 @opindex mlinux
8105 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
8106
8107 @item -sim
8108 @opindex sim
8109 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
8110 to link with input-output functions from a simulator library. Code,
8111 initialized data and zero-initialized data are allocated consecutively.
8112
8113 @item -sim2
8114 @opindex sim2
8115 Like @option{-sim}, but pass linker options to locate initialized data at
8116 0x40000000 and zero-initialized data at 0x80000000.
8117 @end table
8118
8119 @node CRX Options
8120 @subsection CRX Options
8121 @cindex CRX Options
8122
8123 These options are defined specifically for the CRX ports.
8124
8125 @table @gcctabopt
8126
8127 @item -mmac
8128 @opindex mmac
8129 Enable the use of multiply-accumulate instructions. Disabled by default.
8130
8131 @item -mpush-args
8132 @opindex mpush-args
8133 Push instructions will be used to pass outgoing arguments when functions
8134 are called. Enabled by default.
8135 @end table
8136
8137 @node Darwin Options
8138 @subsection Darwin Options
8139 @cindex Darwin options
8140
8141 These options are defined for all architectures running the Darwin operating
8142 system.
8143
8144 FSF GCC on Darwin does not create ``fat'' object files; it will create
8145 an object file for the single architecture that it was built to
8146 target. Apple's GCC on Darwin does create ``fat'' files if multiple
8147 @option{-arch} options are used; it does so by running the compiler or
8148 linker multiple times and joining the results together with
8149 @file{lipo}.
8150
8151 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
8152 @samp{i686}) is determined by the flags that specify the ISA
8153 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
8154 @option{-force_cpusubtype_ALL} option can be used to override this.
8155
8156 The Darwin tools vary in their behavior when presented with an ISA
8157 mismatch. The assembler, @file{as}, will only permit instructions to
8158 be used that are valid for the subtype of the file it is generating,
8159 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
8160 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
8161 and print an error if asked to create a shared library with a less
8162 restrictive subtype than its input files (for instance, trying to put
8163 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
8164 for executables, @file{ld}, will quietly give the executable the most
8165 restrictive subtype of any of its input files.
8166
8167 @table @gcctabopt
8168 @item -F@var{dir}
8169 @opindex F
8170 Add the framework directory @var{dir} to the head of the list of
8171 directories to be searched for header files. These directories are
8172 interleaved with those specified by @option{-I} options and are
8173 scanned in a left-to-right order.
8174
8175 A framework directory is a directory with frameworks in it. A
8176 framework is a directory with a @samp{"Headers"} and/or
8177 @samp{"PrivateHeaders"} directory contained directly in it that ends
8178 in @samp{".framework"}. The name of a framework is the name of this
8179 directory excluding the @samp{".framework"}. Headers associated with
8180 the framework are found in one of those two directories, with
8181 @samp{"Headers"} being searched first. A subframework is a framework
8182 directory that is in a framework's @samp{"Frameworks"} directory.
8183 Includes of subframework headers can only appear in a header of a
8184 framework that contains the subframework, or in a sibling subframework
8185 header. Two subframeworks are siblings if they occur in the same
8186 framework. A subframework should not have the same name as a
8187 framework, a warning will be issued if this is violated. Currently a
8188 subframework cannot have subframeworks, in the future, the mechanism
8189 may be extended to support this. The standard frameworks can be found
8190 in @samp{"/System/Library/Frameworks"} and
8191 @samp{"/Library/Frameworks"}. An example include looks like
8192 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
8193 the name of the framework and header.h is found in the
8194 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
8195
8196 @item -gused
8197 @opindex -gused
8198 Emit debugging information for symbols that are used. For STABS
8199 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
8200 This is by default ON@.
8201
8202 @item -gfull
8203 @opindex -gfull
8204 Emit debugging information for all symbols and types.
8205
8206 @item -mmacosx-version-min=@var{version}
8207 The earliest version of MacOS X that this executable will run on
8208 is @var{version}. Typical values of @var{version} include @code{10.1},
8209 @code{10.2}, and @code{10.3.9}.
8210
8211 The default for this option is to make choices that seem to be most
8212 useful.
8213
8214 @item -mkernel
8215 @opindex mkernel
8216 Enable kernel development mode. The @option{-mkernel} option sets
8217 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
8218 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
8219 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
8220 applicable. This mode also sets @option{-mno-altivec},
8221 @option{-msoft-float}, @option{-fno-builtin} and
8222 @option{-mlong-branch} for PowerPC targets.
8223
8224 @item -mone-byte-bool
8225 @opindex -mone-byte-bool
8226 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
8227 By default @samp{sizeof(bool)} is @samp{4} when compiling for
8228 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
8229 option has no effect on x86.
8230
8231 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
8232 to generate code that is not binary compatible with code generated
8233 without that switch. Using this switch may require recompiling all
8234 other modules in a program, including system libraries. Use this
8235 switch to conform to a non-default data model.
8236
8237 @item -mfix-and-continue
8238 @itemx -ffix-and-continue
8239 @itemx -findirect-data
8240 @opindex mfix-and-continue
8241 @opindex ffix-and-continue
8242 @opindex findirect-data
8243 Generate code suitable for fast turn around development. Needed to
8244 enable gdb to dynamically load @code{.o} files into already running
8245 programs. @option{-findirect-data} and @option{-ffix-and-continue}
8246 are provided for backwards compatibility.
8247
8248 @item -all_load
8249 @opindex all_load
8250 Loads all members of static archive libraries.
8251 See man ld(1) for more information.
8252
8253 @item -arch_errors_fatal
8254 @opindex arch_errors_fatal
8255 Cause the errors having to do with files that have the wrong architecture
8256 to be fatal.
8257
8258 @item -bind_at_load
8259 @opindex bind_at_load
8260 Causes the output file to be marked such that the dynamic linker will
8261 bind all undefined references when the file is loaded or launched.
8262
8263 @item -bundle
8264 @opindex bundle
8265 Produce a Mach-o bundle format file.
8266 See man ld(1) for more information.
8267
8268 @item -bundle_loader @var{executable}
8269 @opindex bundle_loader
8270 This option specifies the @var{executable} that will be loading the build
8271 output file being linked. See man ld(1) for more information.
8272
8273 @item -dynamiclib
8274 @opindex -dynamiclib
8275 When passed this option, GCC will produce a dynamic library instead of
8276 an executable when linking, using the Darwin @file{libtool} command.
8277
8278 @item -force_cpusubtype_ALL
8279 @opindex -force_cpusubtype_ALL
8280 This causes GCC's output file to have the @var{ALL} subtype, instead of
8281 one controlled by the @option{-mcpu} or @option{-march} option.
8282
8283 @item -allowable_client @var{client_name}
8284 @itemx -client_name
8285 @itemx -compatibility_version
8286 @itemx -current_version
8287 @itemx -dead_strip
8288 @itemx -dependency-file
8289 @itemx -dylib_file
8290 @itemx -dylinker_install_name
8291 @itemx -dynamic
8292 @itemx -exported_symbols_list
8293 @itemx -filelist
8294 @itemx -flat_namespace
8295 @itemx -force_flat_namespace
8296 @itemx -headerpad_max_install_names
8297 @itemx -image_base
8298 @itemx -init
8299 @itemx -install_name
8300 @itemx -keep_private_externs
8301 @itemx -multi_module
8302 @itemx -multiply_defined
8303 @itemx -multiply_defined_unused
8304 @itemx -noall_load
8305 @itemx -no_dead_strip_inits_and_terms
8306 @itemx -nofixprebinding
8307 @itemx -nomultidefs
8308 @itemx -noprebind
8309 @itemx -noseglinkedit
8310 @itemx -pagezero_size
8311 @itemx -prebind
8312 @itemx -prebind_all_twolevel_modules
8313 @itemx -private_bundle
8314 @itemx -read_only_relocs
8315 @itemx -sectalign
8316 @itemx -sectobjectsymbols
8317 @itemx -whyload
8318 @itemx -seg1addr
8319 @itemx -sectcreate
8320 @itemx -sectobjectsymbols
8321 @itemx -sectorder
8322 @itemx -segaddr
8323 @itemx -segs_read_only_addr
8324 @itemx -segs_read_write_addr
8325 @itemx -seg_addr_table
8326 @itemx -seg_addr_table_filename
8327 @itemx -seglinkedit
8328 @itemx -segprot
8329 @itemx -segs_read_only_addr
8330 @itemx -segs_read_write_addr
8331 @itemx -single_module
8332 @itemx -static
8333 @itemx -sub_library
8334 @itemx -sub_umbrella
8335 @itemx -twolevel_namespace
8336 @itemx -umbrella
8337 @itemx -undefined
8338 @itemx -unexported_symbols_list
8339 @itemx -weak_reference_mismatches
8340 @itemx -whatsloaded
8341
8342 @opindex allowable_client
8343 @opindex client_name
8344 @opindex compatibility_version
8345 @opindex current_version
8346 @opindex dead_strip
8347 @opindex dependency-file
8348 @opindex dylib_file
8349 @opindex dylinker_install_name
8350 @opindex dynamic
8351 @opindex exported_symbols_list
8352 @opindex filelist
8353 @opindex flat_namespace
8354 @opindex force_flat_namespace
8355 @opindex headerpad_max_install_names
8356 @opindex image_base
8357 @opindex init
8358 @opindex install_name
8359 @opindex keep_private_externs
8360 @opindex multi_module
8361 @opindex multiply_defined
8362 @opindex multiply_defined_unused
8363 @opindex noall_load
8364 @opindex no_dead_strip_inits_and_terms
8365 @opindex nofixprebinding
8366 @opindex nomultidefs
8367 @opindex noprebind
8368 @opindex noseglinkedit
8369 @opindex pagezero_size
8370 @opindex prebind
8371 @opindex prebind_all_twolevel_modules
8372 @opindex private_bundle
8373 @opindex read_only_relocs
8374 @opindex sectalign
8375 @opindex sectobjectsymbols
8376 @opindex whyload
8377 @opindex seg1addr
8378 @opindex sectcreate
8379 @opindex sectobjectsymbols
8380 @opindex sectorder
8381 @opindex segaddr
8382 @opindex segs_read_only_addr
8383 @opindex segs_read_write_addr
8384 @opindex seg_addr_table
8385 @opindex seg_addr_table_filename
8386 @opindex seglinkedit
8387 @opindex segprot
8388 @opindex segs_read_only_addr
8389 @opindex segs_read_write_addr
8390 @opindex single_module
8391 @opindex static
8392 @opindex sub_library
8393 @opindex sub_umbrella
8394 @opindex twolevel_namespace
8395 @opindex umbrella
8396 @opindex undefined
8397 @opindex unexported_symbols_list
8398 @opindex weak_reference_mismatches
8399 @opindex whatsloaded
8400
8401 These options are passed to the Darwin linker. The Darwin linker man page
8402 describes them in detail.
8403 @end table
8404
8405 @node DEC Alpha Options
8406 @subsection DEC Alpha Options
8407
8408 These @samp{-m} options are defined for the DEC Alpha implementations:
8409
8410 @table @gcctabopt
8411 @item -mno-soft-float
8412 @itemx -msoft-float
8413 @opindex mno-soft-float
8414 @opindex msoft-float
8415 Use (do not use) the hardware floating-point instructions for
8416 floating-point operations. When @option{-msoft-float} is specified,
8417 functions in @file{libgcc.a} will be used to perform floating-point
8418 operations. Unless they are replaced by routines that emulate the
8419 floating-point operations, or compiled in such a way as to call such
8420 emulations routines, these routines will issue floating-point
8421 operations. If you are compiling for an Alpha without floating-point
8422 operations, you must ensure that the library is built so as not to call
8423 them.
8424
8425 Note that Alpha implementations without floating-point operations are
8426 required to have floating-point registers.
8427
8428 @item -mfp-reg
8429 @itemx -mno-fp-regs
8430 @opindex mfp-reg
8431 @opindex mno-fp-regs
8432 Generate code that uses (does not use) the floating-point register set.
8433 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
8434 register set is not used, floating point operands are passed in integer
8435 registers as if they were integers and floating-point results are passed
8436 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
8437 so any function with a floating-point argument or return value called by code
8438 compiled with @option{-mno-fp-regs} must also be compiled with that
8439 option.
8440
8441 A typical use of this option is building a kernel that does not use,
8442 and hence need not save and restore, any floating-point registers.
8443
8444 @item -mieee
8445 @opindex mieee
8446 The Alpha architecture implements floating-point hardware optimized for
8447 maximum performance. It is mostly compliant with the IEEE floating
8448 point standard. However, for full compliance, software assistance is
8449 required. This option generates code fully IEEE compliant code
8450 @emph{except} that the @var{inexact-flag} is not maintained (see below).
8451 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
8452 defined during compilation. The resulting code is less efficient but is
8453 able to correctly support denormalized numbers and exceptional IEEE
8454 values such as not-a-number and plus/minus infinity. Other Alpha
8455 compilers call this option @option{-ieee_with_no_inexact}.
8456
8457 @item -mieee-with-inexact
8458 @opindex mieee-with-inexact
8459 This is like @option{-mieee} except the generated code also maintains
8460 the IEEE @var{inexact-flag}. Turning on this option causes the
8461 generated code to implement fully-compliant IEEE math. In addition to
8462 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
8463 macro. On some Alpha implementations the resulting code may execute
8464 significantly slower than the code generated by default. Since there is
8465 very little code that depends on the @var{inexact-flag}, you should
8466 normally not specify this option. Other Alpha compilers call this
8467 option @option{-ieee_with_inexact}.
8468
8469 @item -mfp-trap-mode=@var{trap-mode}
8470 @opindex mfp-trap-mode
8471 This option controls what floating-point related traps are enabled.
8472 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
8473 The trap mode can be set to one of four values:
8474
8475 @table @samp
8476 @item n
8477 This is the default (normal) setting. The only traps that are enabled
8478 are the ones that cannot be disabled in software (e.g., division by zero
8479 trap).
8480
8481 @item u
8482 In addition to the traps enabled by @samp{n}, underflow traps are enabled
8483 as well.
8484
8485 @item su
8486 Like @samp{u}, but the instructions are marked to be safe for software
8487 completion (see Alpha architecture manual for details).
8488
8489 @item sui
8490 Like @samp{su}, but inexact traps are enabled as well.
8491 @end table
8492
8493 @item -mfp-rounding-mode=@var{rounding-mode}
8494 @opindex mfp-rounding-mode
8495 Selects the IEEE rounding mode. Other Alpha compilers call this option
8496 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
8497 of:
8498
8499 @table @samp
8500 @item n
8501 Normal IEEE rounding mode. Floating point numbers are rounded towards
8502 the nearest machine number or towards the even machine number in case
8503 of a tie.
8504
8505 @item m
8506 Round towards minus infinity.
8507
8508 @item c
8509 Chopped rounding mode. Floating point numbers are rounded towards zero.
8510
8511 @item d
8512 Dynamic rounding mode. A field in the floating point control register
8513 (@var{fpcr}, see Alpha architecture reference manual) controls the
8514 rounding mode in effect. The C library initializes this register for
8515 rounding towards plus infinity. Thus, unless your program modifies the
8516 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
8517 @end table
8518
8519 @item -mtrap-precision=@var{trap-precision}
8520 @opindex mtrap-precision
8521 In the Alpha architecture, floating point traps are imprecise. This
8522 means without software assistance it is impossible to recover from a
8523 floating trap and program execution normally needs to be terminated.
8524 GCC can generate code that can assist operating system trap handlers
8525 in determining the exact location that caused a floating point trap.
8526 Depending on the requirements of an application, different levels of
8527 precisions can be selected:
8528
8529 @table @samp
8530 @item p
8531 Program precision. This option is the default and means a trap handler
8532 can only identify which program caused a floating point exception.
8533
8534 @item f
8535 Function precision. The trap handler can determine the function that
8536 caused a floating point exception.
8537
8538 @item i
8539 Instruction precision. The trap handler can determine the exact
8540 instruction that caused a floating point exception.
8541 @end table
8542
8543 Other Alpha compilers provide the equivalent options called
8544 @option{-scope_safe} and @option{-resumption_safe}.
8545
8546 @item -mieee-conformant
8547 @opindex mieee-conformant
8548 This option marks the generated code as IEEE conformant. You must not
8549 use this option unless you also specify @option{-mtrap-precision=i} and either
8550 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
8551 is to emit the line @samp{.eflag 48} in the function prologue of the
8552 generated assembly file. Under DEC Unix, this has the effect that
8553 IEEE-conformant math library routines will be linked in.
8554
8555 @item -mbuild-constants
8556 @opindex mbuild-constants
8557 Normally GCC examines a 32- or 64-bit integer constant to
8558 see if it can construct it from smaller constants in two or three
8559 instructions. If it cannot, it will output the constant as a literal and
8560 generate code to load it from the data segment at runtime.
8561
8562 Use this option to require GCC to construct @emph{all} integer constants
8563 using code, even if it takes more instructions (the maximum is six).
8564
8565 You would typically use this option to build a shared library dynamic
8566 loader. Itself a shared library, it must relocate itself in memory
8567 before it can find the variables and constants in its own data segment.
8568
8569 @item -malpha-as
8570 @itemx -mgas
8571 @opindex malpha-as
8572 @opindex mgas
8573 Select whether to generate code to be assembled by the vendor-supplied
8574 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8575
8576 @item -mbwx
8577 @itemx -mno-bwx
8578 @itemx -mcix
8579 @itemx -mno-cix
8580 @itemx -mfix
8581 @itemx -mno-fix
8582 @itemx -mmax
8583 @itemx -mno-max
8584 @opindex mbwx
8585 @opindex mno-bwx
8586 @opindex mcix
8587 @opindex mno-cix
8588 @opindex mfix
8589 @opindex mno-fix
8590 @opindex mmax
8591 @opindex mno-max
8592 Indicate whether GCC should generate code to use the optional BWX,
8593 CIX, FIX and MAX instruction sets. The default is to use the instruction
8594 sets supported by the CPU type specified via @option{-mcpu=} option or that
8595 of the CPU on which GCC was built if none was specified.
8596
8597 @item -mfloat-vax
8598 @itemx -mfloat-ieee
8599 @opindex mfloat-vax
8600 @opindex mfloat-ieee
8601 Generate code that uses (does not use) VAX F and G floating point
8602 arithmetic instead of IEEE single and double precision.
8603
8604 @item -mexplicit-relocs
8605 @itemx -mno-explicit-relocs
8606 @opindex mexplicit-relocs
8607 @opindex mno-explicit-relocs
8608 Older Alpha assemblers provided no way to generate symbol relocations
8609 except via assembler macros. Use of these macros does not allow
8610 optimal instruction scheduling. GNU binutils as of version 2.12
8611 supports a new syntax that allows the compiler to explicitly mark
8612 which relocations should apply to which instructions. This option
8613 is mostly useful for debugging, as GCC detects the capabilities of
8614 the assembler when it is built and sets the default accordingly.
8615
8616 @item -msmall-data
8617 @itemx -mlarge-data
8618 @opindex msmall-data
8619 @opindex mlarge-data
8620 When @option{-mexplicit-relocs} is in effect, static data is
8621 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8622 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8623 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8624 16-bit relocations off of the @code{$gp} register. This limits the
8625 size of the small data area to 64KB, but allows the variables to be
8626 directly accessed via a single instruction.
8627
8628 The default is @option{-mlarge-data}. With this option the data area
8629 is limited to just below 2GB@. Programs that require more than 2GB of
8630 data must use @code{malloc} or @code{mmap} to allocate the data in the
8631 heap instead of in the program's data segment.
8632
8633 When generating code for shared libraries, @option{-fpic} implies
8634 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8635
8636 @item -msmall-text
8637 @itemx -mlarge-text
8638 @opindex msmall-text
8639 @opindex mlarge-text
8640 When @option{-msmall-text} is used, the compiler assumes that the
8641 code of the entire program (or shared library) fits in 4MB, and is
8642 thus reachable with a branch instruction. When @option{-msmall-data}
8643 is used, the compiler can assume that all local symbols share the
8644 same @code{$gp} value, and thus reduce the number of instructions
8645 required for a function call from 4 to 1.
8646
8647 The default is @option{-mlarge-text}.
8648
8649 @item -mcpu=@var{cpu_type}
8650 @opindex mcpu
8651 Set the instruction set and instruction scheduling parameters for
8652 machine type @var{cpu_type}. You can specify either the @samp{EV}
8653 style name or the corresponding chip number. GCC supports scheduling
8654 parameters for the EV4, EV5 and EV6 family of processors and will
8655 choose the default values for the instruction set from the processor
8656 you specify. If you do not specify a processor type, GCC will default
8657 to the processor on which the compiler was built.
8658
8659 Supported values for @var{cpu_type} are
8660
8661 @table @samp
8662 @item ev4
8663 @itemx ev45
8664 @itemx 21064
8665 Schedules as an EV4 and has no instruction set extensions.
8666
8667 @item ev5
8668 @itemx 21164
8669 Schedules as an EV5 and has no instruction set extensions.
8670
8671 @item ev56
8672 @itemx 21164a
8673 Schedules as an EV5 and supports the BWX extension.
8674
8675 @item pca56
8676 @itemx 21164pc
8677 @itemx 21164PC
8678 Schedules as an EV5 and supports the BWX and MAX extensions.
8679
8680 @item ev6
8681 @itemx 21264
8682 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8683
8684 @item ev67
8685 @itemx 21264a
8686 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8687 @end table
8688
8689 @item -mtune=@var{cpu_type}
8690 @opindex mtune
8691 Set only the instruction scheduling parameters for machine type
8692 @var{cpu_type}. The instruction set is not changed.
8693
8694 @item -mmemory-latency=@var{time}
8695 @opindex mmemory-latency
8696 Sets the latency the scheduler should assume for typical memory
8697 references as seen by the application. This number is highly
8698 dependent on the memory access patterns used by the application
8699 and the size of the external cache on the machine.
8700
8701 Valid options for @var{time} are
8702
8703 @table @samp
8704 @item @var{number}
8705 A decimal number representing clock cycles.
8706
8707 @item L1
8708 @itemx L2
8709 @itemx L3
8710 @itemx main
8711 The compiler contains estimates of the number of clock cycles for
8712 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8713 (also called Dcache, Scache, and Bcache), as well as to main memory.
8714 Note that L3 is only valid for EV5.
8715
8716 @end table
8717 @end table
8718
8719 @node DEC Alpha/VMS Options
8720 @subsection DEC Alpha/VMS Options
8721
8722 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8723
8724 @table @gcctabopt
8725 @item -mvms-return-codes
8726 @opindex mvms-return-codes
8727 Return VMS condition codes from main. The default is to return POSIX
8728 style condition (e.g.@ error) codes.
8729 @end table
8730
8731 @node FRV Options
8732 @subsection FRV Options
8733 @cindex FRV Options
8734
8735 @table @gcctabopt
8736 @item -mgpr-32
8737 @opindex mgpr-32
8738
8739 Only use the first 32 general purpose registers.
8740
8741 @item -mgpr-64
8742 @opindex mgpr-64
8743
8744 Use all 64 general purpose registers.
8745
8746 @item -mfpr-32
8747 @opindex mfpr-32
8748
8749 Use only the first 32 floating point registers.
8750
8751 @item -mfpr-64
8752 @opindex mfpr-64
8753
8754 Use all 64 floating point registers
8755
8756 @item -mhard-float
8757 @opindex mhard-float
8758
8759 Use hardware instructions for floating point operations.
8760
8761 @item -msoft-float
8762 @opindex msoft-float
8763
8764 Use library routines for floating point operations.
8765
8766 @item -malloc-cc
8767 @opindex malloc-cc
8768
8769 Dynamically allocate condition code registers.
8770
8771 @item -mfixed-cc
8772 @opindex mfixed-cc
8773
8774 Do not try to dynamically allocate condition code registers, only
8775 use @code{icc0} and @code{fcc0}.
8776
8777 @item -mdword
8778 @opindex mdword
8779
8780 Change ABI to use double word insns.
8781
8782 @item -mno-dword
8783 @opindex mno-dword
8784
8785 Do not use double word instructions.
8786
8787 @item -mdouble
8788 @opindex mdouble
8789
8790 Use floating point double instructions.
8791
8792 @item -mno-double
8793 @opindex mno-double
8794
8795 Do not use floating point double instructions.
8796
8797 @item -mmedia
8798 @opindex mmedia
8799
8800 Use media instructions.
8801
8802 @item -mno-media
8803 @opindex mno-media
8804
8805 Do not use media instructions.
8806
8807 @item -mmuladd
8808 @opindex mmuladd
8809
8810 Use multiply and add/subtract instructions.
8811
8812 @item -mno-muladd
8813 @opindex mno-muladd
8814
8815 Do not use multiply and add/subtract instructions.
8816
8817 @item -mfdpic
8818 @opindex mfdpic
8819
8820 Select the FDPIC ABI, that uses function descriptors to represent
8821 pointers to functions. Without any PIC/PIE-related options, it
8822 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8823 assumes GOT entries and small data are within a 12-bit range from the
8824 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8825 are computed with 32 bits.
8826
8827 @item -minline-plt
8828 @opindex minline-plt
8829
8830 Enable inlining of PLT entries in function calls to functions that are
8831 not known to bind locally. It has no effect without @option{-mfdpic}.
8832 It's enabled by default if optimizing for speed and compiling for
8833 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8834 optimization option such as @option{-O3} or above is present in the
8835 command line.
8836
8837 @item -mTLS
8838 @opindex TLS
8839
8840 Assume a large TLS segment when generating thread-local code.
8841
8842 @item -mtls
8843 @opindex tls
8844
8845 Do not assume a large TLS segment when generating thread-local code.
8846
8847 @item -mgprel-ro
8848 @opindex mgprel-ro
8849
8850 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8851 that is known to be in read-only sections. It's enabled by default,
8852 except for @option{-fpic} or @option{-fpie}: even though it may help
8853 make the global offset table smaller, it trades 1 instruction for 4.
8854 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8855 one of which may be shared by multiple symbols, and it avoids the need
8856 for a GOT entry for the referenced symbol, so it's more likely to be a
8857 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8858
8859 @item -multilib-library-pic
8860 @opindex multilib-library-pic
8861
8862 Link with the (library, not FD) pic libraries. It's implied by
8863 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8864 @option{-fpic} without @option{-mfdpic}. You should never have to use
8865 it explicitly.
8866
8867 @item -mlinked-fp
8868 @opindex mlinked-fp
8869
8870 Follow the EABI requirement of always creating a frame pointer whenever
8871 a stack frame is allocated. This option is enabled by default and can
8872 be disabled with @option{-mno-linked-fp}.
8873
8874 @item -mlong-calls
8875 @opindex mlong-calls
8876
8877 Use indirect addressing to call functions outside the current
8878 compilation unit. This allows the functions to be placed anywhere
8879 within the 32-bit address space.
8880
8881 @item -malign-labels
8882 @opindex malign-labels
8883
8884 Try to align labels to an 8-byte boundary by inserting nops into the
8885 previous packet. This option only has an effect when VLIW packing
8886 is enabled. It doesn't create new packets; it merely adds nops to
8887 existing ones.
8888
8889 @item -mlibrary-pic
8890 @opindex mlibrary-pic
8891
8892 Generate position-independent EABI code.
8893
8894 @item -macc-4
8895 @opindex macc-4
8896
8897 Use only the first four media accumulator registers.
8898
8899 @item -macc-8
8900 @opindex macc-8
8901
8902 Use all eight media accumulator registers.
8903
8904 @item -mpack
8905 @opindex mpack
8906
8907 Pack VLIW instructions.
8908
8909 @item -mno-pack
8910 @opindex mno-pack
8911
8912 Do not pack VLIW instructions.
8913
8914 @item -mno-eflags
8915 @opindex mno-eflags
8916
8917 Do not mark ABI switches in e_flags.
8918
8919 @item -mcond-move
8920 @opindex mcond-move
8921
8922 Enable the use of conditional-move instructions (default).
8923
8924 This switch is mainly for debugging the compiler and will likely be removed
8925 in a future version.
8926
8927 @item -mno-cond-move
8928 @opindex mno-cond-move
8929
8930 Disable the use of conditional-move instructions.
8931
8932 This switch is mainly for debugging the compiler and will likely be removed
8933 in a future version.
8934
8935 @item -mscc
8936 @opindex mscc
8937
8938 Enable the use of conditional set instructions (default).
8939
8940 This switch is mainly for debugging the compiler and will likely be removed
8941 in a future version.
8942
8943 @item -mno-scc
8944 @opindex mno-scc
8945
8946 Disable the use of conditional set instructions.
8947
8948 This switch is mainly for debugging the compiler and will likely be removed
8949 in a future version.
8950
8951 @item -mcond-exec
8952 @opindex mcond-exec
8953
8954 Enable the use of conditional execution (default).
8955
8956 This switch is mainly for debugging the compiler and will likely be removed
8957 in a future version.
8958
8959 @item -mno-cond-exec
8960 @opindex mno-cond-exec
8961
8962 Disable the use of conditional execution.
8963
8964 This switch is mainly for debugging the compiler and will likely be removed
8965 in a future version.
8966
8967 @item -mvliw-branch
8968 @opindex mvliw-branch
8969
8970 Run a pass to pack branches into VLIW instructions (default).
8971
8972 This switch is mainly for debugging the compiler and will likely be removed
8973 in a future version.
8974
8975 @item -mno-vliw-branch
8976 @opindex mno-vliw-branch
8977
8978 Do not run a pass to pack branches into VLIW instructions.
8979
8980 This switch is mainly for debugging the compiler and will likely be removed
8981 in a future version.
8982
8983 @item -mmulti-cond-exec
8984 @opindex mmulti-cond-exec
8985
8986 Enable optimization of @code{&&} and @code{||} in conditional execution
8987 (default).
8988
8989 This switch is mainly for debugging the compiler and will likely be removed
8990 in a future version.
8991
8992 @item -mno-multi-cond-exec
8993 @opindex mno-multi-cond-exec
8994
8995 Disable optimization of @code{&&} and @code{||} in conditional execution.
8996
8997 This switch is mainly for debugging the compiler and will likely be removed
8998 in a future version.
8999
9000 @item -mnested-cond-exec
9001 @opindex mnested-cond-exec
9002
9003 Enable nested conditional execution optimizations (default).
9004
9005 This switch is mainly for debugging the compiler and will likely be removed
9006 in a future version.
9007
9008 @item -mno-nested-cond-exec
9009 @opindex mno-nested-cond-exec
9010
9011 Disable nested conditional execution optimizations.
9012
9013 This switch is mainly for debugging the compiler and will likely be removed
9014 in a future version.
9015
9016 @item -moptimize-membar
9017 @opindex moptimize-membar
9018
9019 This switch removes redundant @code{membar} instructions from the
9020 compiler generated code. It is enabled by default.
9021
9022 @item -mno-optimize-membar
9023 @opindex mno-optimize-membar
9024
9025 This switch disables the automatic removal of redundant @code{membar}
9026 instructions from the generated code.
9027
9028 @item -mtomcat-stats
9029 @opindex mtomcat-stats
9030
9031 Cause gas to print out tomcat statistics.
9032
9033 @item -mcpu=@var{cpu}
9034 @opindex mcpu
9035
9036 Select the processor type for which to generate code. Possible values are
9037 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
9038 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
9039
9040 @end table
9041
9042 @node GNU/Linux Options
9043 @subsection GNU/Linux Options
9044
9045 These @samp{-m} options are defined for GNU/Linux targets:
9046
9047 @table @gcctabopt
9048 @item -mglibc
9049 @opindex mglibc
9050 Use the GNU C library instead of uClibc. This is the default except
9051 on @samp{*-*-linux-*uclibc*} targets.
9052
9053 @item -muclibc
9054 @opindex muclibc
9055 Use uClibc instead of the GNU C library. This is the default on
9056 @samp{*-*-linux-*uclibc*} targets.
9057 @end table
9058
9059 @node H8/300 Options
9060 @subsection H8/300 Options
9061
9062 These @samp{-m} options are defined for the H8/300 implementations:
9063
9064 @table @gcctabopt
9065 @item -mrelax
9066 @opindex mrelax
9067 Shorten some address references at link time, when possible; uses the
9068 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
9069 ld, Using ld}, for a fuller description.
9070
9071 @item -mh
9072 @opindex mh
9073 Generate code for the H8/300H@.
9074
9075 @item -ms
9076 @opindex ms
9077 Generate code for the H8S@.
9078
9079 @item -mn
9080 @opindex mn
9081 Generate code for the H8S and H8/300H in the normal mode. This switch
9082 must be used either with @option{-mh} or @option{-ms}.
9083
9084 @item -ms2600
9085 @opindex ms2600
9086 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
9087
9088 @item -mint32
9089 @opindex mint32
9090 Make @code{int} data 32 bits by default.
9091
9092 @item -malign-300
9093 @opindex malign-300
9094 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
9095 The default for the H8/300H and H8S is to align longs and floats on 4
9096 byte boundaries.
9097 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
9098 This option has no effect on the H8/300.
9099 @end table
9100
9101 @node HPPA Options
9102 @subsection HPPA Options
9103 @cindex HPPA Options
9104
9105 These @samp{-m} options are defined for the HPPA family of computers:
9106
9107 @table @gcctabopt
9108 @item -march=@var{architecture-type}
9109 @opindex march
9110 Generate code for the specified architecture. The choices for
9111 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
9112 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
9113 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
9114 architecture option for your machine. Code compiled for lower numbered
9115 architectures will run on higher numbered architectures, but not the
9116 other way around.
9117
9118 @item -mpa-risc-1-0
9119 @itemx -mpa-risc-1-1
9120 @itemx -mpa-risc-2-0
9121 @opindex mpa-risc-1-0
9122 @opindex mpa-risc-1-1
9123 @opindex mpa-risc-2-0
9124 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
9125
9126 @item -mbig-switch
9127 @opindex mbig-switch
9128 Generate code suitable for big switch tables. Use this option only if
9129 the assembler/linker complain about out of range branches within a switch
9130 table.
9131
9132 @item -mjump-in-delay
9133 @opindex mjump-in-delay
9134 Fill delay slots of function calls with unconditional jump instructions
9135 by modifying the return pointer for the function call to be the target
9136 of the conditional jump.
9137
9138 @item -mdisable-fpregs
9139 @opindex mdisable-fpregs
9140 Prevent floating point registers from being used in any manner. This is
9141 necessary for compiling kernels which perform lazy context switching of
9142 floating point registers. If you use this option and attempt to perform
9143 floating point operations, the compiler will abort.
9144
9145 @item -mdisable-indexing
9146 @opindex mdisable-indexing
9147 Prevent the compiler from using indexing address modes. This avoids some
9148 rather obscure problems when compiling MIG generated code under MACH@.
9149
9150 @item -mno-space-regs
9151 @opindex mno-space-regs
9152 Generate code that assumes the target has no space registers. This allows
9153 GCC to generate faster indirect calls and use unscaled index address modes.
9154
9155 Such code is suitable for level 0 PA systems and kernels.
9156
9157 @item -mfast-indirect-calls
9158 @opindex mfast-indirect-calls
9159 Generate code that assumes calls never cross space boundaries. This
9160 allows GCC to emit code which performs faster indirect calls.
9161
9162 This option will not work in the presence of shared libraries or nested
9163 functions.
9164
9165 @item -mfixed-range=@var{register-range}
9166 @opindex mfixed-range
9167 Generate code treating the given register range as fixed registers.
9168 A fixed register is one that the register allocator can not use. This is
9169 useful when compiling kernel code. A register range is specified as
9170 two registers separated by a dash. Multiple register ranges can be
9171 specified separated by a comma.
9172
9173 @item -mlong-load-store
9174 @opindex mlong-load-store
9175 Generate 3-instruction load and store sequences as sometimes required by
9176 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
9177 the HP compilers.
9178
9179 @item -mportable-runtime
9180 @opindex mportable-runtime
9181 Use the portable calling conventions proposed by HP for ELF systems.
9182
9183 @item -mgas
9184 @opindex mgas
9185 Enable the use of assembler directives only GAS understands.
9186
9187 @item -mschedule=@var{cpu-type}
9188 @opindex mschedule
9189 Schedule code according to the constraints for the machine type
9190 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
9191 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
9192 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
9193 proper scheduling option for your machine. The default scheduling is
9194 @samp{8000}.
9195
9196 @item -mlinker-opt
9197 @opindex mlinker-opt
9198 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
9199 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
9200 linkers in which they give bogus error messages when linking some programs.
9201
9202 @item -msoft-float
9203 @opindex msoft-float
9204 Generate output containing library calls for floating point.
9205 @strong{Warning:} the requisite libraries are not available for all HPPA
9206 targets. Normally the facilities of the machine's usual C compiler are
9207 used, but this cannot be done directly in cross-compilation. You must make
9208 your own arrangements to provide suitable library functions for
9209 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
9210 does provide software floating point support.
9211
9212 @option{-msoft-float} changes the calling convention in the output file;
9213 therefore, it is only useful if you compile @emph{all} of a program with
9214 this option. In particular, you need to compile @file{libgcc.a}, the
9215 library that comes with GCC, with @option{-msoft-float} in order for
9216 this to work.
9217
9218 @item -msio
9219 @opindex msio
9220 Generate the predefine, @code{_SIO}, for server IO@. The default is
9221 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
9222 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
9223 options are available under HP-UX and HI-UX@.
9224
9225 @item -mgnu-ld
9226 @opindex gnu-ld
9227 Use GNU ld specific options. This passes @option{-shared} to ld when
9228 building a shared library. It is the default when GCC is configured,
9229 explicitly or implicitly, with the GNU linker. This option does not
9230 have any affect on which ld is called, it only changes what parameters
9231 are passed to that ld. The ld that is called is determined by the
9232 @option{--with-ld} configure option, GCC's program search path, and
9233 finally by the user's @env{PATH}. The linker used by GCC can be printed
9234 using @samp{which `gcc -print-prog-name=ld`}. This option is only available
9235 on the 64 bit HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9236
9237 @item -mhp-ld
9238 @opindex hp-ld
9239 Use HP ld specific options. This passes @option{-b} to ld when building
9240 a shared library and passes @option{+Accept TypeMismatch} to ld on all
9241 links. It is the default when GCC is configured, explicitly or
9242 implicitly, with the HP linker. This option does not have any affect on
9243 which ld is called, it only changes what parameters are passed to that
9244 ld. The ld that is called is determined by the @option{--with-ld}
9245 configure option, GCC's program search path, and finally by the user's
9246 @env{PATH}. The linker used by GCC can be printed using @samp{which
9247 `gcc -print-prog-name=ld`}. This option is only available on the 64 bit
9248 HP-UX GCC, i.e. configured with @samp{hppa*64*-*-hpux*}.
9249
9250 @item -mlong-calls
9251 @opindex mno-long-calls
9252 Generate code that uses long call sequences. This ensures that a call
9253 is always able to reach linker generated stubs. The default is to generate
9254 long calls only when the distance from the call site to the beginning
9255 of the function or translation unit, as the case may be, exceeds a
9256 predefined limit set by the branch type being used. The limits for
9257 normal calls are 7,600,000 and 240,000 bytes, respectively for the
9258 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
9259 240,000 bytes.
9260
9261 Distances are measured from the beginning of functions when using the
9262 @option{-ffunction-sections} option, or when using the @option{-mgas}
9263 and @option{-mno-portable-runtime} options together under HP-UX with
9264 the SOM linker.
9265
9266 It is normally not desirable to use this option as it will degrade
9267 performance. However, it may be useful in large applications,
9268 particularly when partial linking is used to build the application.
9269
9270 The types of long calls used depends on the capabilities of the
9271 assembler and linker, and the type of code being generated. The
9272 impact on systems that support long absolute calls, and long pic
9273 symbol-difference or pc-relative calls should be relatively small.
9274 However, an indirect call is used on 32-bit ELF systems in pic code
9275 and it is quite long.
9276
9277 @item -munix=@var{unix-std}
9278 @opindex march
9279 Generate compiler predefines and select a startfile for the specified
9280 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
9281 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
9282 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
9283 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
9284 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
9285 and later.
9286
9287 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
9288 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
9289 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
9290 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
9291 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
9292 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
9293
9294 It is @emph{important} to note that this option changes the interfaces
9295 for various library routines. It also affects the operational behavior
9296 of the C library. Thus, @emph{extreme} care is needed in using this
9297 option.
9298
9299 Library code that is intended to operate with more than one UNIX
9300 standard must test, set and restore the variable @var{__xpg4_extended_mask}
9301 as appropriate. Most GNU software doesn't provide this capability.
9302
9303 @item -nolibdld
9304 @opindex nolibdld
9305 Suppress the generation of link options to search libdld.sl when the
9306 @option{-static} option is specified on HP-UX 10 and later.
9307
9308 @item -static
9309 @opindex static
9310 The HP-UX implementation of setlocale in libc has a dependency on
9311 libdld.sl. There isn't an archive version of libdld.sl. Thus,
9312 when the @option{-static} option is specified, special link options
9313 are needed to resolve this dependency.
9314
9315 On HP-UX 10 and later, the GCC driver adds the necessary options to
9316 link with libdld.sl when the @option{-static} option is specified.
9317 This causes the resulting binary to be dynamic. On the 64-bit port,
9318 the linkers generate dynamic binaries by default in any case. The
9319 @option{-nolibdld} option can be used to prevent the GCC driver from
9320 adding these link options.
9321
9322 @item -threads
9323 @opindex threads
9324 Add support for multithreading with the @dfn{dce thread} library
9325 under HP-UX@. This option sets flags for both the preprocessor and
9326 linker.
9327 @end table
9328
9329 @node i386 and x86-64 Options
9330 @subsection Intel 386 and AMD x86-64 Options
9331 @cindex i386 Options
9332 @cindex x86-64 Options
9333 @cindex Intel 386 Options
9334 @cindex AMD x86-64 Options
9335
9336 These @samp{-m} options are defined for the i386 and x86-64 family of
9337 computers:
9338
9339 @table @gcctabopt
9340 @item -mtune=@var{cpu-type}
9341 @opindex mtune
9342 Tune to @var{cpu-type} everything applicable about the generated code, except
9343 for the ABI and the set of available instructions. The choices for
9344 @var{cpu-type} are:
9345 @table @emph
9346 @item generic
9347 Produce code optimized for the most common IA32/AMD64/EM64T processors.
9348 If you know the CPU on which your code will run, then you should use
9349 the corresponding @option{-mtune} option instead of
9350 @option{-mtune=generic}. But, if you do not know exactly what CPU users
9351 of your application will have, then you should use this option.
9352
9353 As new processors are deployed in the marketplace, the behavior of this
9354 option will change. Therefore, if you upgrade to a newer version of
9355 GCC, the code generated option will change to reflect the processors
9356 that were most common when that version of GCC was released.
9357
9358 There is no @option{-march=generic} option because @option{-march}
9359 indicates the instruction set the compiler can use, and there is no
9360 generic instruction set applicable to all processors. In contrast,
9361 @option{-mtune} indicates the processor (or, in this case, collection of
9362 processors) for which the code is optimized.
9363 @item native
9364 This selects the CPU to tune for at compilation time by determining
9365 the processor type of the compiling machine. Using @option{-mtune=native}
9366 will produce code optimized for the local machine under the constraints
9367 of the selected instruction set. Using @option{-march=native} will
9368 enable all instruction subsets supported by the local machine (hence
9369 the result might not run on different machines).
9370 @item i386
9371 Original Intel's i386 CPU@.
9372 @item i486
9373 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
9374 @item i586, pentium
9375 Intel Pentium CPU with no MMX support.
9376 @item pentium-mmx
9377 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
9378 @item pentiumpro
9379 Intel PentiumPro CPU@.
9380 @item i686
9381 Same as @code{generic}, but when used as @code{march} option, PentiumPro
9382 instruction set will be used, so the code will run on all i686 family chips.
9383 @item pentium2
9384 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
9385 @item pentium3, pentium3m
9386 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
9387 support.
9388 @item pentium-m
9389 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
9390 support. Used by Centrino notebooks.
9391 @item pentium4, pentium4m
9392 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
9393 @item prescott
9394 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
9395 set support.
9396 @item nocona
9397 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
9398 SSE2 and SSE3 instruction set support.
9399 @item core2
9400 Intel Core2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
9401 instruction set support.
9402 @item k6
9403 AMD K6 CPU with MMX instruction set support.
9404 @item k6-2, k6-3
9405 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
9406 @item athlon, athlon-tbird
9407 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
9408 support.
9409 @item athlon-4, athlon-xp, athlon-mp
9410 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
9411 instruction set support.
9412 @item k8, opteron, athlon64, athlon-fx
9413 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
9414 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
9415 @item winchip-c6
9416 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
9417 set support.
9418 @item winchip2
9419 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
9420 instruction set support.
9421 @item c3
9422 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
9423 implemented for this chip.)
9424 @item c3-2
9425 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
9426 implemented for this chip.)
9427 @item geode
9428 Embedded AMD CPU with MMX and 3dNOW! instruction set support.
9429 @end table
9430
9431 While picking a specific @var{cpu-type} will schedule things appropriately
9432 for that particular chip, the compiler will not generate any code that
9433 does not run on the i386 without the @option{-march=@var{cpu-type}} option
9434 being used.
9435
9436 @item -march=@var{cpu-type}
9437 @opindex march
9438 Generate instructions for the machine type @var{cpu-type}. The choices
9439 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
9440 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
9441
9442 @item -mcpu=@var{cpu-type}
9443 @opindex mcpu
9444 A deprecated synonym for @option{-mtune}.
9445
9446 @item -m386
9447 @itemx -m486
9448 @itemx -mpentium
9449 @itemx -mpentiumpro
9450 @opindex m386
9451 @opindex m486
9452 @opindex mpentium
9453 @opindex mpentiumpro
9454 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
9455 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
9456 These synonyms are deprecated.
9457
9458 @item -mfpmath=@var{unit}
9459 @opindex march
9460 Generate floating point arithmetics for selected unit @var{unit}. The choices
9461 for @var{unit} are:
9462
9463 @table @samp
9464 @item 387
9465 Use the standard 387 floating point coprocessor present majority of chips and
9466 emulated otherwise. Code compiled with this option will run almost everywhere.
9467 The temporary results are computed in 80bit precision instead of precision
9468 specified by the type resulting in slightly different results compared to most
9469 of other chips. See @option{-ffloat-store} for more detailed description.
9470
9471 This is the default choice for i386 compiler.
9472
9473 @item sse
9474 Use scalar floating point instructions present in the SSE instruction set.
9475 This instruction set is supported by Pentium3 and newer chips, in the AMD line
9476 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
9477 instruction set supports only single precision arithmetics, thus the double and
9478 extended precision arithmetics is still done using 387. Later version, present
9479 only in Pentium4 and the future AMD x86-64 chips supports double precision
9480 arithmetics too.
9481
9482 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
9483 or @option{-msse2} switches to enable SSE extensions and make this option
9484 effective. For the x86-64 compiler, these extensions are enabled by default.
9485
9486 The resulting code should be considerably faster in the majority of cases and avoid
9487 the numerical instability problems of 387 code, but may break some existing
9488 code that expects temporaries to be 80bit.
9489
9490 This is the default choice for the x86-64 compiler.
9491
9492 @item sse,387
9493 Attempt to utilize both instruction sets at once. This effectively double the
9494 amount of available registers and on chips with separate execution units for
9495 387 and SSE the execution resources too. Use this option with care, as it is
9496 still experimental, because the GCC register allocator does not model separate
9497 functional units well resulting in instable performance.
9498 @end table
9499
9500 @item -masm=@var{dialect}
9501 @opindex masm=@var{dialect}
9502 Output asm instructions using selected @var{dialect}. Supported
9503 choices are @samp{intel} or @samp{att} (the default one). Darwin does
9504 not support @samp{intel}.
9505
9506 @item -mieee-fp
9507 @itemx -mno-ieee-fp
9508 @opindex mieee-fp
9509 @opindex mno-ieee-fp
9510 Control whether or not the compiler uses IEEE floating point
9511 comparisons. These handle correctly the case where the result of a
9512 comparison is unordered.
9513
9514 @item -msoft-float
9515 @opindex msoft-float
9516 Generate output containing library calls for floating point.
9517 @strong{Warning:} the requisite libraries are not part of GCC@.
9518 Normally the facilities of the machine's usual C compiler are used, but
9519 this can't be done directly in cross-compilation. You must make your
9520 own arrangements to provide suitable library functions for
9521 cross-compilation.
9522
9523 On machines where a function returns floating point results in the 80387
9524 register stack, some floating point opcodes may be emitted even if
9525 @option{-msoft-float} is used.
9526
9527 @item -mno-fp-ret-in-387
9528 @opindex mno-fp-ret-in-387
9529 Do not use the FPU registers for return values of functions.
9530
9531 The usual calling convention has functions return values of types
9532 @code{float} and @code{double} in an FPU register, even if there
9533 is no FPU@. The idea is that the operating system should emulate
9534 an FPU@.
9535
9536 The option @option{-mno-fp-ret-in-387} causes such values to be returned
9537 in ordinary CPU registers instead.
9538
9539 @item -mno-fancy-math-387
9540 @opindex mno-fancy-math-387
9541 Some 387 emulators do not support the @code{sin}, @code{cos} and
9542 @code{sqrt} instructions for the 387. Specify this option to avoid
9543 generating those instructions. This option is the default on FreeBSD,
9544 OpenBSD and NetBSD@. This option is overridden when @option{-march}
9545 indicates that the target cpu will always have an FPU and so the
9546 instruction will not need emulation. As of revision 2.6.1, these
9547 instructions are not generated unless you also use the
9548 @option{-funsafe-math-optimizations} switch.
9549
9550 @item -malign-double
9551 @itemx -mno-align-double
9552 @opindex malign-double
9553 @opindex mno-align-double
9554 Control whether GCC aligns @code{double}, @code{long double}, and
9555 @code{long long} variables on a two word boundary or a one word
9556 boundary. Aligning @code{double} variables on a two word boundary will
9557 produce code that runs somewhat faster on a @samp{Pentium} at the
9558 expense of more memory.
9559
9560 On x86-64, @option{-malign-double} is enabled by default.
9561
9562 @strong{Warning:} if you use the @option{-malign-double} switch,
9563 structures containing the above types will be aligned differently than
9564 the published application binary interface specifications for the 386
9565 and will not be binary compatible with structures in code compiled
9566 without that switch.
9567
9568 @item -m96bit-long-double
9569 @itemx -m128bit-long-double
9570 @opindex m96bit-long-double
9571 @opindex m128bit-long-double
9572 These switches control the size of @code{long double} type. The i386
9573 application binary interface specifies the size to be 96 bits,
9574 so @option{-m96bit-long-double} is the default in 32 bit mode.
9575
9576 Modern architectures (Pentium and newer) would prefer @code{long double}
9577 to be aligned to an 8 or 16 byte boundary. In arrays or structures
9578 conforming to the ABI, this would not be possible. So specifying a
9579 @option{-m128bit-long-double} will align @code{long double}
9580 to a 16 byte boundary by padding the @code{long double} with an additional
9581 32 bit zero.
9582
9583 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
9584 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
9585
9586 Notice that neither of these options enable any extra precision over the x87
9587 standard of 80 bits for a @code{long double}.
9588
9589 @strong{Warning:} if you override the default value for your target ABI, the
9590 structures and arrays containing @code{long double} variables will change
9591 their size as well as function calling convention for function taking
9592 @code{long double} will be modified. Hence they will not be binary
9593 compatible with arrays or structures in code compiled without that switch.
9594
9595 @item -mmlarge-data-threshold=@var{number}
9596 @opindex mlarge-data-threshold=@var{number}
9597 When @option{-mcmodel=medium} is specified, the data greater than
9598 @var{threshold} are placed in large data section. This value must be the
9599 same across all object linked into the binary and defaults to 65535.
9600
9601 @item -msvr3-shlib
9602 @itemx -mno-svr3-shlib
9603 @opindex msvr3-shlib
9604 @opindex mno-svr3-shlib
9605 Control whether GCC places uninitialized local variables into the
9606 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
9607 into @code{bss}. These options are meaningful only on System V Release 3.
9608
9609 @item -mrtd
9610 @opindex mrtd
9611 Use a different function-calling convention, in which functions that
9612 take a fixed number of arguments return with the @code{ret} @var{num}
9613 instruction, which pops their arguments while returning. This saves one
9614 instruction in the caller since there is no need to pop the arguments
9615 there.
9616
9617 You can specify that an individual function is called with this calling
9618 sequence with the function attribute @samp{stdcall}. You can also
9619 override the @option{-mrtd} option by using the function attribute
9620 @samp{cdecl}. @xref{Function Attributes}.
9621
9622 @strong{Warning:} this calling convention is incompatible with the one
9623 normally used on Unix, so you cannot use it if you need to call
9624 libraries compiled with the Unix compiler.
9625
9626 Also, you must provide function prototypes for all functions that
9627 take variable numbers of arguments (including @code{printf});
9628 otherwise incorrect code will be generated for calls to those
9629 functions.
9630
9631 In addition, seriously incorrect code will result if you call a
9632 function with too many arguments. (Normally, extra arguments are
9633 harmlessly ignored.)
9634
9635 @item -mregparm=@var{num}
9636 @opindex mregparm
9637 Control how many registers are used to pass integer arguments. By
9638 default, no registers are used to pass arguments, and at most 3
9639 registers can be used. You can control this behavior for a specific
9640 function by using the function attribute @samp{regparm}.
9641 @xref{Function Attributes}.
9642
9643 @strong{Warning:} if you use this switch, and
9644 @var{num} is nonzero, then you must build all modules with the same
9645 value, including any libraries. This includes the system libraries and
9646 startup modules.
9647
9648 @item -msseregparm
9649 @opindex msseregparm
9650 Use SSE register passing conventions for float and double arguments
9651 and return values. You can control this behavior for a specific
9652 function by using the function attribute @samp{sseregparm}.
9653 @xref{Function Attributes}.
9654
9655 @strong{Warning:} if you use this switch then you must build all
9656 modules with the same value, including any libraries. This includes
9657 the system libraries and startup modules.
9658
9659 @item -mstackrealign
9660 @opindex mstackrealign
9661 Realign the stack at entry. On the Intel x86, the
9662 @option{-mstackrealign} option will generate an alternate prologue and
9663 epilogue that realigns the runtime stack. This supports mixing legacy
9664 codes that keep a 4-byte aligned stack with modern codes that keep a
9665 16-byte stack for SSE compatibility. The alternate prologue and
9666 epilogue are slower and bigger than the regular ones, and the
9667 alternate prologue requires an extra scratch register; this lowers the
9668 number of registers available if used in conjunction with the
9669 @code{regparm} attribute. The @option{-mstackrealign} option is
9670 incompatible with the nested function prologue; this is considered a
9671 hard error. See also the attribute @code{force_align_arg_pointer},
9672 applicable to individual functions.
9673
9674 @item -mpreferred-stack-boundary=@var{num}
9675 @opindex mpreferred-stack-boundary
9676 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9677 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
9678 the default is 4 (16 bytes or 128 bits).
9679
9680 On Pentium and PentiumPro, @code{double} and @code{long double} values
9681 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9682 suffer significant run time performance penalties. On Pentium III, the
9683 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
9684 properly if it is not 16 byte aligned.
9685
9686 To ensure proper alignment of this values on the stack, the stack boundary
9687 must be as aligned as that required by any value stored on the stack.
9688 Further, every function must be generated such that it keeps the stack
9689 aligned. Thus calling a function compiled with a higher preferred
9690 stack boundary from a function compiled with a lower preferred stack
9691 boundary will most likely misalign the stack. It is recommended that
9692 libraries that use callbacks always use the default setting.
9693
9694 This extra alignment does consume extra stack space, and generally
9695 increases code size. Code that is sensitive to stack space usage, such
9696 as embedded systems and operating system kernels, may want to reduce the
9697 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9698
9699 @item -mmmx
9700 @itemx -mno-mmx
9701 @item -msse
9702 @itemx -mno-sse
9703 @item -msse2
9704 @itemx -mno-sse2
9705 @item -msse3
9706 @itemx -mno-sse3
9707 @item -mssse3
9708 @itemx -mno-ssse3
9709 @item -m3dnow
9710 @itemx -mno-3dnow
9711 @opindex mmmx
9712 @opindex mno-mmx
9713 @opindex msse
9714 @opindex mno-sse
9715 @opindex m3dnow
9716 @opindex mno-3dnow
9717 These switches enable or disable the use of instructions in the MMX,
9718 SSE, SSE2, SSE3, SSSE3 or 3DNow! extended instruction sets.
9719 These extensions are also available as built-in functions: see
9720 @ref{X86 Built-in Functions}, for details of the functions enabled and
9721 disabled by these switches.
9722
9723 To have SSE/SSE2 instructions generated automatically from floating-point
9724 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
9725
9726 These options will enable GCC to use these extended instructions in
9727 generated code, even without @option{-mfpmath=sse}. Applications which
9728 perform runtime CPU detection must compile separate files for each
9729 supported architecture, using the appropriate flags. In particular,
9730 the file containing the CPU detection code should be compiled without
9731 these options.
9732
9733 @item -mpush-args
9734 @itemx -mno-push-args
9735 @opindex mpush-args
9736 @opindex mno-push-args
9737 Use PUSH operations to store outgoing parameters. This method is shorter
9738 and usually equally fast as method using SUB/MOV operations and is enabled
9739 by default. In some cases disabling it may improve performance because of
9740 improved scheduling and reduced dependencies.
9741
9742 @item -maccumulate-outgoing-args
9743 @opindex maccumulate-outgoing-args
9744 If enabled, the maximum amount of space required for outgoing arguments will be
9745 computed in the function prologue. This is faster on most modern CPUs
9746 because of reduced dependencies, improved scheduling and reduced stack usage
9747 when preferred stack boundary is not equal to 2. The drawback is a notable
9748 increase in code size. This switch implies @option{-mno-push-args}.
9749
9750 @item -mthreads
9751 @opindex mthreads
9752 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
9753 on thread-safe exception handling must compile and link all code with the
9754 @option{-mthreads} option. When compiling, @option{-mthreads} defines
9755 @option{-D_MT}; when linking, it links in a special thread helper library
9756 @option{-lmingwthrd} which cleans up per thread exception handling data.
9757
9758 @item -mno-align-stringops
9759 @opindex mno-align-stringops
9760 Do not align destination of inlined string operations. This switch reduces
9761 code size and improves performance in case the destination is already aligned,
9762 but GCC doesn't know about it.
9763
9764 @item -minline-all-stringops
9765 @opindex minline-all-stringops
9766 By default GCC inlines string operations only when destination is known to be
9767 aligned at least to 4 byte boundary. This enables more inlining, increase code
9768 size, but may improve performance of code that depends on fast memcpy, strlen
9769 and memset for short lengths.
9770
9771 @item -minline-stringops-dynamically
9772 @opindex minline-stringops-dynamically
9773 For string operation of unknown size, inline runtime checks so for small
9774 blocks inline code is used, while for large blocks library call is used.
9775
9776 @item -mstringop-strategy=@var{alg}
9777 @opindex mstringop-strategy=@var{alg}
9778 Overwrite internal decision heuristic about particular algorithm to inline
9779 string operation with. The allowed values are @code{rep_byte},
9780 @code{rep_4byte}, @code{rep_8byte} for expanding using i386 @code{rep} prefix
9781 of specified size, @code{byte_loop}, @code{loop}, @code{unrolled_loop} for
9782 expanding inline loop, @code{libcall} for always expanding library call.
9783
9784 @item -momit-leaf-frame-pointer
9785 @opindex momit-leaf-frame-pointer
9786 Don't keep the frame pointer in a register for leaf functions. This
9787 avoids the instructions to save, set up and restore frame pointers and
9788 makes an extra register available in leaf functions. The option
9789 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9790 which might make debugging harder.
9791
9792 @item -mtls-direct-seg-refs
9793 @itemx -mno-tls-direct-seg-refs
9794 @opindex mtls-direct-seg-refs
9795 Controls whether TLS variables may be accessed with offsets from the
9796 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9797 or whether the thread base pointer must be added. Whether or not this
9798 is legal depends on the operating system, and whether it maps the
9799 segment to cover the entire TLS area.
9800
9801 For systems that use GNU libc, the default is on.
9802 @end table
9803
9804 These @samp{-m} switches are supported in addition to the above
9805 on AMD x86-64 processors in 64-bit environments.
9806
9807 @table @gcctabopt
9808 @item -m32
9809 @itemx -m64
9810 @opindex m32
9811 @opindex m64
9812 Generate code for a 32-bit or 64-bit environment.
9813 The 32-bit environment sets int, long and pointer to 32 bits and
9814 generates code that runs on any i386 system.
9815 The 64-bit environment sets int to 32 bits and long and pointer
9816 to 64 bits and generates code for AMD's x86-64 architecture.
9817
9818 @item -mno-red-zone
9819 @opindex no-red-zone
9820 Do not use a so called red zone for x86-64 code. The red zone is mandated
9821 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9822 stack pointer that will not be modified by signal or interrupt handlers
9823 and therefore can be used for temporary data without adjusting the stack
9824 pointer. The flag @option{-mno-red-zone} disables this red zone.
9825
9826 @item -mcmodel=small
9827 @opindex mcmodel=small
9828 Generate code for the small code model: the program and its symbols must
9829 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9830 Programs can be statically or dynamically linked. This is the default
9831 code model.
9832
9833 @item -mcmodel=kernel
9834 @opindex mcmodel=kernel
9835 Generate code for the kernel code model. The kernel runs in the
9836 negative 2 GB of the address space.
9837 This model has to be used for Linux kernel code.
9838
9839 @item -mcmodel=medium
9840 @opindex mcmodel=medium
9841 Generate code for the medium model: The program is linked in the lower 2
9842 GB of the address space but symbols can be located anywhere in the
9843 address space. Programs can be statically or dynamically linked, but
9844 building of shared libraries are not supported with the medium model.
9845
9846 @item -mcmodel=large
9847 @opindex mcmodel=large
9848 Generate code for the large model: This model makes no assumptions
9849 about addresses and sizes of sections. Currently GCC does not implement
9850 this model.
9851 @end table
9852
9853 @node IA-64 Options
9854 @subsection IA-64 Options
9855 @cindex IA-64 Options
9856
9857 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9858
9859 @table @gcctabopt
9860 @item -mbig-endian
9861 @opindex mbig-endian
9862 Generate code for a big endian target. This is the default for HP-UX@.
9863
9864 @item -mlittle-endian
9865 @opindex mlittle-endian
9866 Generate code for a little endian target. This is the default for AIX5
9867 and GNU/Linux.
9868
9869 @item -mgnu-as
9870 @itemx -mno-gnu-as
9871 @opindex mgnu-as
9872 @opindex mno-gnu-as
9873 Generate (or don't) code for the GNU assembler. This is the default.
9874 @c Also, this is the default if the configure option @option{--with-gnu-as}
9875 @c is used.
9876
9877 @item -mgnu-ld
9878 @itemx -mno-gnu-ld
9879 @opindex mgnu-ld
9880 @opindex mno-gnu-ld
9881 Generate (or don't) code for the GNU linker. This is the default.
9882 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9883 @c is used.
9884
9885 @item -mno-pic
9886 @opindex mno-pic
9887 Generate code that does not use a global pointer register. The result
9888 is not position independent code, and violates the IA-64 ABI@.
9889
9890 @item -mvolatile-asm-stop
9891 @itemx -mno-volatile-asm-stop
9892 @opindex mvolatile-asm-stop
9893 @opindex mno-volatile-asm-stop
9894 Generate (or don't) a stop bit immediately before and after volatile asm
9895 statements.
9896
9897 @item -mregister-names
9898 @itemx -mno-register-names
9899 @opindex mregister-names
9900 @opindex mno-register-names
9901 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9902 the stacked registers. This may make assembler output more readable.
9903
9904 @item -mno-sdata
9905 @itemx -msdata
9906 @opindex mno-sdata
9907 @opindex msdata
9908 Disable (or enable) optimizations that use the small data section. This may
9909 be useful for working around optimizer bugs.
9910
9911 @item -mconstant-gp
9912 @opindex mconstant-gp
9913 Generate code that uses a single constant global pointer value. This is
9914 useful when compiling kernel code.
9915
9916 @item -mauto-pic
9917 @opindex mauto-pic
9918 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9919 This is useful when compiling firmware code.
9920
9921 @item -minline-float-divide-min-latency
9922 @opindex minline-float-divide-min-latency
9923 Generate code for inline divides of floating point values
9924 using the minimum latency algorithm.
9925
9926 @item -minline-float-divide-max-throughput
9927 @opindex minline-float-divide-max-throughput
9928 Generate code for inline divides of floating point values
9929 using the maximum throughput algorithm.
9930
9931 @item -minline-int-divide-min-latency
9932 @opindex minline-int-divide-min-latency
9933 Generate code for inline divides of integer values
9934 using the minimum latency algorithm.
9935
9936 @item -minline-int-divide-max-throughput
9937 @opindex minline-int-divide-max-throughput
9938 Generate code for inline divides of integer values
9939 using the maximum throughput algorithm.
9940
9941 @item -minline-sqrt-min-latency
9942 @opindex minline-sqrt-min-latency
9943 Generate code for inline square roots
9944 using the minimum latency algorithm.
9945
9946 @item -minline-sqrt-max-throughput
9947 @opindex minline-sqrt-max-throughput
9948 Generate code for inline square roots
9949 using the maximum throughput algorithm.
9950
9951 @item -mno-dwarf2-asm
9952 @itemx -mdwarf2-asm
9953 @opindex mno-dwarf2-asm
9954 @opindex mdwarf2-asm
9955 Don't (or do) generate assembler code for the DWARF2 line number debugging
9956 info. This may be useful when not using the GNU assembler.
9957
9958 @item -mearly-stop-bits
9959 @itemx -mno-early-stop-bits
9960 @opindex mearly-stop-bits
9961 @opindex mno-early-stop-bits
9962 Allow stop bits to be placed earlier than immediately preceding the
9963 instruction that triggered the stop bit. This can improve instruction
9964 scheduling, but does not always do so.
9965
9966 @item -mfixed-range=@var{register-range}
9967 @opindex mfixed-range
9968 Generate code treating the given register range as fixed registers.
9969 A fixed register is one that the register allocator can not use. This is
9970 useful when compiling kernel code. A register range is specified as
9971 two registers separated by a dash. Multiple register ranges can be
9972 specified separated by a comma.
9973
9974 @item -mtls-size=@var{tls-size}
9975 @opindex mtls-size
9976 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
9977 64.
9978
9979 @item -mtune=@var{cpu-type}
9980 @opindex mtune
9981 Tune the instruction scheduling for a particular CPU, Valid values are
9982 itanium, itanium1, merced, itanium2, and mckinley.
9983
9984 @item -mt
9985 @itemx -pthread
9986 @opindex mt
9987 @opindex pthread
9988 Add support for multithreading using the POSIX threads library. This
9989 option sets flags for both the preprocessor and linker. It does
9990 not affect the thread safety of object code produced by the compiler or
9991 that of libraries supplied with it. These are HP-UX specific flags.
9992
9993 @item -milp32
9994 @itemx -mlp64
9995 @opindex milp32
9996 @opindex mlp64
9997 Generate code for a 32-bit or 64-bit environment.
9998 The 32-bit environment sets int, long and pointer to 32 bits.
9999 The 64-bit environment sets int to 32 bits and long and pointer
10000 to 64 bits. These are HP-UX specific flags.
10001
10002 @item -mno-sched-br-data-spec
10003 @itemx -msched-br-data-spec
10004 @opindex -mno-sched-br-data-spec
10005 @opindex -msched-br-data-spec
10006 (Dis/En)able data speculative scheduling before reload.
10007 This will result in generation of the ld.a instructions and
10008 the corresponding check instructions (ld.c / chk.a).
10009 The default is 'disable'.
10010
10011 @item -msched-ar-data-spec
10012 @itemx -mno-sched-ar-data-spec
10013 @opindex -msched-ar-data-spec
10014 @opindex -mno-sched-ar-data-spec
10015 (En/Dis)able data speculative scheduling after reload.
10016 This will result in generation of the ld.a instructions and
10017 the corresponding check instructions (ld.c / chk.a).
10018 The default is 'enable'.
10019
10020 @item -mno-sched-control-spec
10021 @itemx -msched-control-spec
10022 @opindex -mno-sched-control-spec
10023 @opindex -msched-control-spec
10024 (Dis/En)able control speculative scheduling. This feature is
10025 available only during region scheduling (i.e. before reload).
10026 This will result in generation of the ld.s instructions and
10027 the corresponding check instructions chk.s .
10028 The default is 'disable'.
10029
10030 @item -msched-br-in-data-spec
10031 @itemx -mno-sched-br-in-data-spec
10032 @opindex -msched-br-in-data-spec
10033 @opindex -mno-sched-br-in-data-spec
10034 (En/Dis)able speculative scheduling of the instructions that
10035 are dependent on the data speculative loads before reload.
10036 This is effective only with @option{-msched-br-data-spec} enabled.
10037 The default is 'enable'.
10038
10039 @item -msched-ar-in-data-spec
10040 @itemx -mno-sched-ar-in-data-spec
10041 @opindex -msched-ar-in-data-spec
10042 @opindex -mno-sched-ar-in-data-spec
10043 (En/Dis)able speculative scheduling of the instructions that
10044 are dependent on the data speculative loads after reload.
10045 This is effective only with @option{-msched-ar-data-spec} enabled.
10046 The default is 'enable'.
10047
10048 @item -msched-in-control-spec
10049 @itemx -mno-sched-in-control-spec
10050 @opindex -msched-in-control-spec
10051 @opindex -mno-sched-in-control-spec
10052 (En/Dis)able speculative scheduling of the instructions that
10053 are dependent on the control speculative loads.
10054 This is effective only with @option{-msched-control-spec} enabled.
10055 The default is 'enable'.
10056
10057 @item -msched-ldc
10058 @itemx -mno-sched-ldc
10059 @opindex -msched-ldc
10060 @opindex -mno-sched-ldc
10061 (En/Dis)able use of simple data speculation checks ld.c .
10062 If disabled, only chk.a instructions will be emitted to check
10063 data speculative loads.
10064 The default is 'enable'.
10065
10066 @item -mno-sched-control-ldc
10067 @itemx -msched-control-ldc
10068 @opindex -mno-sched-control-ldc
10069 @opindex -msched-control-ldc
10070 (Dis/En)able use of ld.c instructions to check control speculative loads.
10071 If enabled, in case of control speculative load with no speculatively
10072 scheduled dependent instructions this load will be emitted as ld.sa and
10073 ld.c will be used to check it.
10074 The default is 'disable'.
10075
10076 @item -mno-sched-spec-verbose
10077 @itemx -msched-spec-verbose
10078 @opindex -mno-sched-spec-verbose
10079 @opindex -msched-spec-verbose
10080 (Dis/En)able printing of the information about speculative motions.
10081
10082 @item -mno-sched-prefer-non-data-spec-insns
10083 @itemx -msched-prefer-non-data-spec-insns
10084 @opindex -mno-sched-prefer-non-data-spec-insns
10085 @opindex -msched-prefer-non-data-spec-insns
10086 If enabled, data speculative instructions will be chosen for schedule
10087 only if there are no other choices at the moment. This will make
10088 the use of the data speculation much more conservative.
10089 The default is 'disable'.
10090
10091 @item -mno-sched-prefer-non-control-spec-insns
10092 @itemx -msched-prefer-non-control-spec-insns
10093 @opindex -mno-sched-prefer-non-control-spec-insns
10094 @opindex -msched-prefer-non-control-spec-insns
10095 If enabled, control speculative instructions will be chosen for schedule
10096 only if there are no other choices at the moment. This will make
10097 the use of the control speculation much more conservative.
10098 The default is 'disable'.
10099
10100 @item -mno-sched-count-spec-in-critical-path
10101 @itemx -msched-count-spec-in-critical-path
10102 @opindex -mno-sched-count-spec-in-critical-path
10103 @opindex -msched-count-spec-in-critical-path
10104 If enabled, speculative dependencies will be considered during
10105 computation of the instructions priorities. This will make the use of the
10106 speculation a bit more conservative.
10107 The default is 'disable'.
10108
10109 @end table
10110
10111 @node M32C Options
10112 @subsection M32C Options
10113 @cindex M32C options
10114
10115 @table @gcctabopt
10116 @item -mcpu=@var{name}
10117 @opindex mcpu=
10118 Select the CPU for which code is generated. @var{name} may be one of
10119 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
10120 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
10121 the M32C/80 series.
10122
10123 @item -msim
10124 @opindex msim
10125 Specifies that the program will be run on the simulator. This causes
10126 an alternate runtime library to be linked in which supports, for
10127 example, file I/O. You must not use this option when generating
10128 programs that will run on real hardware; you must provide your own
10129 runtime library for whatever I/O functions are needed.
10130
10131 @item -memregs=@var{number}
10132 @opindex memregs=
10133 Specifies the number of memory-based pseudo-registers GCC will use
10134 during code generation. These pseudo-registers will be used like real
10135 registers, so there is a tradeoff between GCC's ability to fit the
10136 code into available registers, and the performance penalty of using
10137 memory instead of registers. Note that all modules in a program must
10138 be compiled with the same value for this option. Because of that, you
10139 must not use this option with the default runtime libraries gcc
10140 builds.
10141
10142 @end table
10143
10144 @node M32R/D Options
10145 @subsection M32R/D Options
10146 @cindex M32R/D options
10147
10148 These @option{-m} options are defined for Renesas M32R/D architectures:
10149
10150 @table @gcctabopt
10151 @item -m32r2
10152 @opindex m32r2
10153 Generate code for the M32R/2@.
10154
10155 @item -m32rx
10156 @opindex m32rx
10157 Generate code for the M32R/X@.
10158
10159 @item -m32r
10160 @opindex m32r
10161 Generate code for the M32R@. This is the default.
10162
10163 @item -mmodel=small
10164 @opindex mmodel=small
10165 Assume all objects live in the lower 16MB of memory (so that their addresses
10166 can be loaded with the @code{ld24} instruction), and assume all subroutines
10167 are reachable with the @code{bl} instruction.
10168 This is the default.
10169
10170 The addressability of a particular object can be set with the
10171 @code{model} attribute.
10172
10173 @item -mmodel=medium
10174 @opindex mmodel=medium
10175 Assume objects may be anywhere in the 32-bit address space (the compiler
10176 will generate @code{seth/add3} instructions to load their addresses), and
10177 assume all subroutines are reachable with the @code{bl} instruction.
10178
10179 @item -mmodel=large
10180 @opindex mmodel=large
10181 Assume objects may be anywhere in the 32-bit address space (the compiler
10182 will generate @code{seth/add3} instructions to load their addresses), and
10183 assume subroutines may not be reachable with the @code{bl} instruction
10184 (the compiler will generate the much slower @code{seth/add3/jl}
10185 instruction sequence).
10186
10187 @item -msdata=none
10188 @opindex msdata=none
10189 Disable use of the small data area. Variables will be put into
10190 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
10191 @code{section} attribute has been specified).
10192 This is the default.
10193
10194 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
10195 Objects may be explicitly put in the small data area with the
10196 @code{section} attribute using one of these sections.
10197
10198 @item -msdata=sdata
10199 @opindex msdata=sdata
10200 Put small global and static data in the small data area, but do not
10201 generate special code to reference them.
10202
10203 @item -msdata=use
10204 @opindex msdata=use
10205 Put small global and static data in the small data area, and generate
10206 special instructions to reference them.
10207
10208 @item -G @var{num}
10209 @opindex G
10210 @cindex smaller data references
10211 Put global and static objects less than or equal to @var{num} bytes
10212 into the small data or bss sections instead of the normal data or bss
10213 sections. The default value of @var{num} is 8.
10214 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
10215 for this option to have any effect.
10216
10217 All modules should be compiled with the same @option{-G @var{num}} value.
10218 Compiling with different values of @var{num} may or may not work; if it
10219 doesn't the linker will give an error message---incorrect code will not be
10220 generated.
10221
10222 @item -mdebug
10223 @opindex mdebug
10224 Makes the M32R specific code in the compiler display some statistics
10225 that might help in debugging programs.
10226
10227 @item -malign-loops
10228 @opindex malign-loops
10229 Align all loops to a 32-byte boundary.
10230
10231 @item -mno-align-loops
10232 @opindex mno-align-loops
10233 Do not enforce a 32-byte alignment for loops. This is the default.
10234
10235 @item -missue-rate=@var{number}
10236 @opindex missue-rate=@var{number}
10237 Issue @var{number} instructions per cycle. @var{number} can only be 1
10238 or 2.
10239
10240 @item -mbranch-cost=@var{number}
10241 @opindex mbranch-cost=@var{number}
10242 @var{number} can only be 1 or 2. If it is 1 then branches will be
10243 preferred over conditional code, if it is 2, then the opposite will
10244 apply.
10245
10246 @item -mflush-trap=@var{number}
10247 @opindex mflush-trap=@var{number}
10248 Specifies the trap number to use to flush the cache. The default is
10249 12. Valid numbers are between 0 and 15 inclusive.
10250
10251 @item -mno-flush-trap
10252 @opindex mno-flush-trap
10253 Specifies that the cache cannot be flushed by using a trap.
10254
10255 @item -mflush-func=@var{name}
10256 @opindex mflush-func=@var{name}
10257 Specifies the name of the operating system function to call to flush
10258 the cache. The default is @emph{_flush_cache}, but a function call
10259 will only be used if a trap is not available.
10260
10261 @item -mno-flush-func
10262 @opindex mno-flush-func
10263 Indicates that there is no OS function for flushing the cache.
10264
10265 @end table
10266
10267 @node M680x0 Options
10268 @subsection M680x0 Options
10269 @cindex M680x0 options
10270
10271 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
10272 The default settings depend on which architecture was selected when
10273 the compiler was configured; the defaults for the most common choices
10274 are given below.
10275
10276 @table @gcctabopt
10277 @item -march=@var{arch}
10278 @opindex march
10279 Generate code for a specific M680x0 or ColdFire instruction set
10280 architecture. Permissible values of @var{arch} for M680x0
10281 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
10282 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}. ColdFire
10283 architectures are selected according to Freescale's ISA classification
10284 and the permissible values are: @samp{isaa}, @samp{isaaplus},
10285 @samp{isab} and @samp{isac}.
10286
10287 gcc defines a macro @samp{__mcf@var{arch}__} whenever it is generating
10288 code for a ColdFire target. The @var{arch} in this macro is one of the
10289 @option{-march} arguments given above.
10290
10291 When used together, @option{-march} and @option{-mtune} select code
10292 that runs on a family of similar processors but that is optimized
10293 for a particular microarchitecture.
10294
10295 @item -mcpu=@var{cpu}
10296 @opindex mcpu
10297 Generate code for a specific M680x0 or ColdFire processor.
10298 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
10299 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
10300 and @samp{cpu32}. The ColdFire @var{cpu}s are given by the table
10301 below, which also classifies the CPUs into families:
10302
10303 @multitable @columnfractions 0.20 0.80
10304 @headitem Family @tab @samp{-mcpu} arguments
10305 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
10306 @item @samp{5206e} @tab @samp{5206e}
10307 @item @samp{5208} @tab @samp{5207} @samp{5208}
10308 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
10309 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
10310 @item @samp{5216} @tab @samp{5214} @samp{5216}
10311 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
10312 @item @samp{5225} @tab @samp{5224} @samp{5225}
10313 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
10314 @item @samp{5249} @tab @samp{5249}
10315 @item @samp{5250} @tab @samp{5250}
10316 @item @samp{5271} @tab @samp{5270} @samp{5271}
10317 @item @samp{5272} @tab @samp{5272}
10318 @item @samp{5275} @tab @samp{5274} @samp{5275}
10319 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
10320 @item @samp{5307} @tab @samp{5307}
10321 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
10322 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
10323 @item @samp{5407} @tab @samp{5407}
10324 @item @samp{5475} @tab @samp{5470} @samp{5471} @samp{5472} @samp{5473} @samp{5474} @samp{5475} @samp{547x} @samp{5480} @samp{5481} @samp{5482} @samp{5483} @samp{5484} @samp{5485}
10325 @end multitable
10326
10327 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
10328 @var{arch} is compatible with @var{cpu}. Other combinations of
10329 @option{-mcpu} and @option{-march} are rejected.
10330
10331 gcc defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
10332 @var{cpu} is selected. It also defines @samp{__mcf_family_@var{family}},
10333 where the value of @var{family} is given by the table above.
10334
10335 @item -mtune=@var{tune}
10336 @opindex mtune
10337 Tune the code for a particular microarchitecture, within the
10338 constraints set by @option{-march} and @option{-mcpu}.
10339 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
10340 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
10341 and @samp{cpu32}. The ColdFire microarchitectures
10342 are: @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
10343
10344 You can also use @option{-mtune=68020-40} for code that needs
10345 to run relatively well on 68020, 68030 and 68040 targets.
10346 @option{-mtune=68020-60} is similar but includes 68060 targets
10347 as well. These two options select the same tuning decisions as
10348 @option{-m68020-40} and @option{-m68020-60} respectively.
10349
10350 gcc defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
10351 when tuning for 680x0 architecture @var{arch}. It also defines
10352 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
10353 option is used. If gcc is tuning for a range of architectures,
10354 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
10355 it defines the macros for every architecture in the range.
10356
10357 gcc also defines the macro @samp{__m@var{uarch}__} when tuning for
10358 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
10359 of the arguments given above.
10360
10361 @item -m68000
10362 @itemx -mc68000
10363 @opindex m68000
10364 @opindex mc68000
10365 Generate output for a 68000. This is the default
10366 when the compiler is configured for 68000-based systems.
10367 It is equivalent to @option{-march=68000}.
10368
10369 Use this option for microcontrollers with a 68000 or EC000 core,
10370 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
10371
10372 @item -m68010
10373 @opindex m68010
10374 Generate output for a 68010. This is the default
10375 when the compiler is configured for 68010-based systems.
10376 It is equivalent to @option{-march=68010}.
10377
10378 @item -m68020
10379 @itemx -mc68020
10380 @opindex m68020
10381 @opindex mc68020
10382 Generate output for a 68020. This is the default
10383 when the compiler is configured for 68020-based systems.
10384 It is equivalent to @option{-march=68020}.
10385
10386 @item -m68030
10387 @opindex m68030
10388 Generate output for a 68030. This is the default when the compiler is
10389 configured for 68030-based systems. It is equivalent to
10390 @option{-march=68030}.
10391
10392 @item -m68040
10393 @opindex m68040
10394 Generate output for a 68040. This is the default when the compiler is
10395 configured for 68040-based systems. It is equivalent to
10396 @option{-march=68040}.
10397
10398 This option inhibits the use of 68881/68882 instructions that have to be
10399 emulated by software on the 68040. Use this option if your 68040 does not
10400 have code to emulate those instructions.
10401
10402 @item -m68060
10403 @opindex m68060
10404 Generate output for a 68060. This is the default when the compiler is
10405 configured for 68060-based systems. It is equivalent to
10406 @option{-march=68060}.
10407
10408 This option inhibits the use of 68020 and 68881/68882 instructions that
10409 have to be emulated by software on the 68060. Use this option if your 68060
10410 does not have code to emulate those instructions.
10411
10412 @item -mcpu32
10413 @opindex mcpu32
10414 Generate output for a CPU32. This is the default
10415 when the compiler is configured for CPU32-based systems.
10416 It is equivalent to @option{-march=cpu32}.
10417
10418 Use this option for microcontrollers with a
10419 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
10420 68336, 68340, 68341, 68349 and 68360.
10421
10422 @item -m5200
10423 @opindex m5200
10424 Generate output for a 520X ColdFire CPU. This is the default
10425 when the compiler is configured for 520X-based systems.
10426 It is equivalent to @option{-mcpu=5206}, and is now deprecated
10427 in favor of that option.
10428
10429 Use this option for microcontroller with a 5200 core, including
10430 the MCF5202, MCF5203, MCF5204 and MCF5206.
10431
10432 @item -m5206e
10433 @opindex m5206e
10434 Generate output for a 5206e ColdFire CPU. The option is now
10435 deprecated in favor of the equivalent @option{-mcpu=5206e}.
10436
10437 @item -m528x
10438 @opindex m528x
10439 Generate output for a member of the ColdFire 528X family.
10440 The option is now deprecated in favor of the equivalent
10441 @option{-mcpu=528x}.
10442
10443 @item -m5307
10444 @opindex m5307
10445 Generate output for a ColdFire 5307 CPU. The option is now deprecated
10446 in favor of the equivalent @option{-mcpu=5307}.
10447
10448 @item -m5407
10449 @opindex m5407
10450 Generate output for a ColdFire 5407 CPU. The option is now deprecated
10451 in favor of the equivalent @option{-mcpu=5407}.
10452
10453 @item -mcfv4e
10454 @opindex mcfv4e
10455 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
10456 This includes use of hardware floating point instructions.
10457 The option is equivalent to @option{-mcpu=547x}, and is now
10458 deprecated in favor of that option.
10459
10460 @item -m68020-40
10461 @opindex m68020-40
10462 Generate output for a 68040, without using any of the new instructions.
10463 This results in code which can run relatively efficiently on either a
10464 68020/68881 or a 68030 or a 68040. The generated code does use the
10465 68881 instructions that are emulated on the 68040.
10466
10467 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
10468
10469 @item -m68020-60
10470 @opindex m68020-60
10471 Generate output for a 68060, without using any of the new instructions.
10472 This results in code which can run relatively efficiently on either a
10473 68020/68881 or a 68030 or a 68040. The generated code does use the
10474 68881 instructions that are emulated on the 68060.
10475
10476 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
10477
10478 @item -mhard-float
10479 @itemx -m68881
10480 @opindex mhard-float
10481 @opindex m68881
10482 Generate floating-point instructions. This is the default for 68020
10483 and above, and for ColdFire devices that have an FPU. It defines the
10484 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
10485 on ColdFire targets.
10486
10487 @item -msoft-float
10488 @opindex msoft-float
10489 Do not generate floating-point instructions; use library calls instead.
10490 This is the default for 68000, 68010, and 68832 targets. It is also
10491 the default for ColdFire devices that have no FPU.
10492
10493 @item -mdiv
10494 @itemx -mno-div
10495 @opindex mdiv
10496 @opindex mno-div
10497 Generate (do not generate) ColdFire hardware divide and remainder
10498 instructions. If @option{-march} is used without @option{-mcpu},
10499 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
10500 architectures. Otherwise, the default is taken from the target CPU
10501 (either the default CPU, or the one specified by @option{-mcpu}). For
10502 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
10503 @option{-mcpu=5206e}.
10504
10505 gcc defines the macro @samp{__mcfhwdiv__} when this option is enabled.
10506
10507 @item -mshort
10508 @opindex mshort
10509 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10510 Additionally, parameters passed on the stack are also aligned to a
10511 16-bit boundary even on targets whose API mandates promotion to 32-bit.
10512
10513 @item -mnobitfield
10514 @opindex mnobitfield
10515 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
10516 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
10517
10518 @item -mbitfield
10519 @opindex mbitfield
10520 Do use the bit-field instructions. The @option{-m68020} option implies
10521 @option{-mbitfield}. This is the default if you use a configuration
10522 designed for a 68020.
10523
10524 @item -mrtd
10525 @opindex mrtd
10526 Use a different function-calling convention, in which functions
10527 that take a fixed number of arguments return with the @code{rtd}
10528 instruction, which pops their arguments while returning. This
10529 saves one instruction in the caller since there is no need to pop
10530 the arguments there.
10531
10532 This calling convention is incompatible with the one normally
10533 used on Unix, so you cannot use it if you need to call libraries
10534 compiled with the Unix compiler.
10535
10536 Also, you must provide function prototypes for all functions that
10537 take variable numbers of arguments (including @code{printf});
10538 otherwise incorrect code will be generated for calls to those
10539 functions.
10540
10541 In addition, seriously incorrect code will result if you call a
10542 function with too many arguments. (Normally, extra arguments are
10543 harmlessly ignored.)
10544
10545 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
10546 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
10547
10548 @item -malign-int
10549 @itemx -mno-align-int
10550 @opindex malign-int
10551 @opindex mno-align-int
10552 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
10553 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
10554 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
10555 Aligning variables on 32-bit boundaries produces code that runs somewhat
10556 faster on processors with 32-bit busses at the expense of more memory.
10557
10558 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
10559 align structures containing the above types differently than
10560 most published application binary interface specifications for the m68k.
10561
10562 @item -mpcrel
10563 @opindex mpcrel
10564 Use the pc-relative addressing mode of the 68000 directly, instead of
10565 using a global offset table. At present, this option implies @option{-fpic},
10566 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
10567 not presently supported with @option{-mpcrel}, though this could be supported for
10568 68020 and higher processors.
10569
10570 @item -mno-strict-align
10571 @itemx -mstrict-align
10572 @opindex mno-strict-align
10573 @opindex mstrict-align
10574 Do not (do) assume that unaligned memory references will be handled by
10575 the system.
10576
10577 @item -msep-data
10578 Generate code that allows the data segment to be located in a different
10579 area of memory from the text segment. This allows for execute in place in
10580 an environment without virtual memory management. This option implies
10581 @option{-fPIC}.
10582
10583 @item -mno-sep-data
10584 Generate code that assumes that the data segment follows the text segment.
10585 This is the default.
10586
10587 @item -mid-shared-library
10588 Generate code that supports shared libraries via the library ID method.
10589 This allows for execute in place and shared libraries in an environment
10590 without virtual memory management. This option implies @option{-fPIC}.
10591
10592 @item -mno-id-shared-library
10593 Generate code that doesn't assume ID based shared libraries are being used.
10594 This is the default.
10595
10596 @item -mshared-library-id=n
10597 Specified the identification number of the ID based shared library being
10598 compiled. Specifying a value of 0 will generate more compact code, specifying
10599 other values will force the allocation of that number to the current
10600 library but is no more space or time efficient than omitting this option.
10601
10602 @end table
10603
10604 @node M68hc1x Options
10605 @subsection M68hc1x Options
10606 @cindex M68hc1x options
10607
10608 These are the @samp{-m} options defined for the 68hc11 and 68hc12
10609 microcontrollers. The default values for these options depends on
10610 which style of microcontroller was selected when the compiler was configured;
10611 the defaults for the most common choices are given below.
10612
10613 @table @gcctabopt
10614 @item -m6811
10615 @itemx -m68hc11
10616 @opindex m6811
10617 @opindex m68hc11
10618 Generate output for a 68HC11. This is the default
10619 when the compiler is configured for 68HC11-based systems.
10620
10621 @item -m6812
10622 @itemx -m68hc12
10623 @opindex m6812
10624 @opindex m68hc12
10625 Generate output for a 68HC12. This is the default
10626 when the compiler is configured for 68HC12-based systems.
10627
10628 @item -m68S12
10629 @itemx -m68hcs12
10630 @opindex m68S12
10631 @opindex m68hcs12
10632 Generate output for a 68HCS12.
10633
10634 @item -mauto-incdec
10635 @opindex mauto-incdec
10636 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
10637 addressing modes.
10638
10639 @item -minmax
10640 @itemx -nominmax
10641 @opindex minmax
10642 @opindex mnominmax
10643 Enable the use of 68HC12 min and max instructions.
10644
10645 @item -mlong-calls
10646 @itemx -mno-long-calls
10647 @opindex mlong-calls
10648 @opindex mno-long-calls
10649 Treat all calls as being far away (near). If calls are assumed to be
10650 far away, the compiler will use the @code{call} instruction to
10651 call a function and the @code{rtc} instruction for returning.
10652
10653 @item -mshort
10654 @opindex mshort
10655 Consider type @code{int} to be 16 bits wide, like @code{short int}.
10656
10657 @item -msoft-reg-count=@var{count}
10658 @opindex msoft-reg-count
10659 Specify the number of pseudo-soft registers which are used for the
10660 code generation. The maximum number is 32. Using more pseudo-soft
10661 register may or may not result in better code depending on the program.
10662 The default is 4 for 68HC11 and 2 for 68HC12.
10663
10664 @end table
10665
10666 @node MCore Options
10667 @subsection MCore Options
10668 @cindex MCore options
10669
10670 These are the @samp{-m} options defined for the Motorola M*Core
10671 processors.
10672
10673 @table @gcctabopt
10674
10675 @item -mhardlit
10676 @itemx -mno-hardlit
10677 @opindex mhardlit
10678 @opindex mno-hardlit
10679 Inline constants into the code stream if it can be done in two
10680 instructions or less.
10681
10682 @item -mdiv
10683 @itemx -mno-div
10684 @opindex mdiv
10685 @opindex mno-div
10686 Use the divide instruction. (Enabled by default).
10687
10688 @item -mrelax-immediate
10689 @itemx -mno-relax-immediate
10690 @opindex mrelax-immediate
10691 @opindex mno-relax-immediate
10692 Allow arbitrary sized immediates in bit operations.
10693
10694 @item -mwide-bitfields
10695 @itemx -mno-wide-bitfields
10696 @opindex mwide-bitfields
10697 @opindex mno-wide-bitfields
10698 Always treat bit-fields as int-sized.
10699
10700 @item -m4byte-functions
10701 @itemx -mno-4byte-functions
10702 @opindex m4byte-functions
10703 @opindex mno-4byte-functions
10704 Force all functions to be aligned to a four byte boundary.
10705
10706 @item -mcallgraph-data
10707 @itemx -mno-callgraph-data
10708 @opindex mcallgraph-data
10709 @opindex mno-callgraph-data
10710 Emit callgraph information.
10711
10712 @item -mslow-bytes
10713 @itemx -mno-slow-bytes
10714 @opindex mslow-bytes
10715 @opindex mno-slow-bytes
10716 Prefer word access when reading byte quantities.
10717
10718 @item -mlittle-endian
10719 @itemx -mbig-endian
10720 @opindex mlittle-endian
10721 @opindex mbig-endian
10722 Generate code for a little endian target.
10723
10724 @item -m210
10725 @itemx -m340
10726 @opindex m210
10727 @opindex m340
10728 Generate code for the 210 processor.
10729 @end table
10730
10731 @node MIPS Options
10732 @subsection MIPS Options
10733 @cindex MIPS options
10734
10735 @table @gcctabopt
10736
10737 @item -EB
10738 @opindex EB
10739 Generate big-endian code.
10740
10741 @item -EL
10742 @opindex EL
10743 Generate little-endian code. This is the default for @samp{mips*el-*-*}
10744 configurations.
10745
10746 @item -march=@var{arch}
10747 @opindex march
10748 Generate code that will run on @var{arch}, which can be the name of a
10749 generic MIPS ISA, or the name of a particular processor.
10750 The ISA names are:
10751 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
10752 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
10753 The processor names are:
10754 @samp{4kc}, @samp{4km}, @samp{4kp},
10755 @samp{4kec}, @samp{4kem}, @samp{4kep},
10756 @samp{5kc}, @samp{5kf},
10757 @samp{20kc},
10758 @samp{24kc}, @samp{24kf}, @samp{24kx},
10759 @samp{24kec}, @samp{24kef}, @samp{24kex},
10760 @samp{34kc}, @samp{34kf}, @samp{34kx},
10761 @samp{m4k},
10762 @samp{orion},
10763 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
10764 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000},
10765 @samp{rm7000}, @samp{rm9000},
10766 @samp{sb1},
10767 @samp{sr71000},
10768 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
10769 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
10770 The special value @samp{from-abi} selects the
10771 most compatible architecture for the selected ABI (that is,
10772 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
10773
10774 In processor names, a final @samp{000} can be abbreviated as @samp{k}
10775 (for example, @samp{-march=r2k}). Prefixes are optional, and
10776 @samp{vr} may be written @samp{r}.
10777
10778 GCC defines two macros based on the value of this option. The first
10779 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
10780 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
10781 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
10782 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
10783 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
10784
10785 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
10786 above. In other words, it will have the full prefix and will not
10787 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
10788 the macro names the resolved architecture (either @samp{"mips1"} or
10789 @samp{"mips3"}). It names the default architecture when no
10790 @option{-march} option is given.
10791
10792 @item -mtune=@var{arch}
10793 @opindex mtune
10794 Optimize for @var{arch}. Among other things, this option controls
10795 the way instructions are scheduled, and the perceived cost of arithmetic
10796 operations. The list of @var{arch} values is the same as for
10797 @option{-march}.
10798
10799 When this option is not used, GCC will optimize for the processor
10800 specified by @option{-march}. By using @option{-march} and
10801 @option{-mtune} together, it is possible to generate code that will
10802 run on a family of processors, but optimize the code for one
10803 particular member of that family.
10804
10805 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
10806 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
10807 @samp{-march} ones described above.
10808
10809 @item -mips1
10810 @opindex mips1
10811 Equivalent to @samp{-march=mips1}.
10812
10813 @item -mips2
10814 @opindex mips2
10815 Equivalent to @samp{-march=mips2}.
10816
10817 @item -mips3
10818 @opindex mips3
10819 Equivalent to @samp{-march=mips3}.
10820
10821 @item -mips4
10822 @opindex mips4
10823 Equivalent to @samp{-march=mips4}.
10824
10825 @item -mips32
10826 @opindex mips32
10827 Equivalent to @samp{-march=mips32}.
10828
10829 @item -mips32r2
10830 @opindex mips32r2
10831 Equivalent to @samp{-march=mips32r2}.
10832
10833 @item -mips64
10834 @opindex mips64
10835 Equivalent to @samp{-march=mips64}.
10836
10837 @item -mips16
10838 @itemx -mno-mips16
10839 @opindex mips16
10840 @opindex mno-mips16
10841 Generate (do not generate) MIPS16 code. If GCC is targetting a
10842 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
10843
10844 @item -mabi=32
10845 @itemx -mabi=o64
10846 @itemx -mabi=n32
10847 @itemx -mabi=64
10848 @itemx -mabi=eabi
10849 @opindex mabi=32
10850 @opindex mabi=o64
10851 @opindex mabi=n32
10852 @opindex mabi=64
10853 @opindex mabi=eabi
10854 Generate code for the given ABI@.
10855
10856 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
10857 generates 64-bit code when you select a 64-bit architecture, but you
10858 can use @option{-mgp32} to get 32-bit code instead.
10859
10860 For information about the O64 ABI, see
10861 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
10862
10863 GCC supports a variant of the o32 ABI in which floating-point registers
10864 are 64 rather than 32 bits wide. You can select this combination with
10865 @option{-mabi=32} @option{-mfp64}. This ABI relies on the @samp{mthc1}
10866 and @samp{mfhc1} instructions and is therefore only supported for
10867 MIPS32R2 processors.
10868
10869 The register assignments for arguments and return values remain the
10870 same, but each scalar value is passed in a single 64-bit register
10871 rather than a pair of 32-bit registers. For example, scalar
10872 floating-point values are returned in @samp{$f0} only, not a
10873 @samp{$f0}/@samp{$f1} pair. The set of call-saved registers also
10874 remains the same, but all 64 bits are saved.
10875
10876 @item -mabicalls
10877 @itemx -mno-abicalls
10878 @opindex mabicalls
10879 @opindex mno-abicalls
10880 Generate (do not generate) code that is suitable for SVR4-style
10881 dynamic objects. @option{-mabicalls} is the default for SVR4-based
10882 systems.
10883
10884 @item -mshared
10885 @itemx -mno-shared
10886 Generate (do not generate) code that is fully position-independent,
10887 and that can therefore be linked into shared libraries. This option
10888 only affects @option{-mabicalls}.
10889
10890 All @option{-mabicalls} code has traditionally been position-independent,
10891 regardless of options like @option{-fPIC} and @option{-fpic}. However,
10892 as an extension, the GNU toolchain allows executables to use absolute
10893 accesses for locally-binding symbols. It can also use shorter GP
10894 initialization sequences and generate direct calls to locally-defined
10895 functions. This mode is selected by @option{-mno-shared}.
10896
10897 @option{-mno-shared} depends on binutils 2.16 or higher and generates
10898 objects that can only be linked by the GNU linker. However, the option
10899 does not affect the ABI of the final executable; it only affects the ABI
10900 of relocatable objects. Using @option{-mno-shared} will generally make
10901 executables both smaller and quicker.
10902
10903 @option{-mshared} is the default.
10904
10905 @item -mxgot
10906 @itemx -mno-xgot
10907 @opindex mxgot
10908 @opindex mno-xgot
10909 Lift (do not lift) the usual restrictions on the size of the global
10910 offset table.
10911
10912 GCC normally uses a single instruction to load values from the GOT@.
10913 While this is relatively efficient, it will only work if the GOT
10914 is smaller than about 64k. Anything larger will cause the linker
10915 to report an error such as:
10916
10917 @cindex relocation truncated to fit (MIPS)
10918 @smallexample
10919 relocation truncated to fit: R_MIPS_GOT16 foobar
10920 @end smallexample
10921
10922 If this happens, you should recompile your code with @option{-mxgot}.
10923 It should then work with very large GOTs, although it will also be
10924 less efficient, since it will take three instructions to fetch the
10925 value of a global symbol.
10926
10927 Note that some linkers can create multiple GOTs. If you have such a
10928 linker, you should only need to use @option{-mxgot} when a single object
10929 file accesses more than 64k's worth of GOT entries. Very few do.
10930
10931 These options have no effect unless GCC is generating position
10932 independent code.
10933
10934 @item -mgp32
10935 @opindex mgp32
10936 Assume that general-purpose registers are 32 bits wide.
10937
10938 @item -mgp64
10939 @opindex mgp64
10940 Assume that general-purpose registers are 64 bits wide.
10941
10942 @item -mfp32
10943 @opindex mfp32
10944 Assume that floating-point registers are 32 bits wide.
10945
10946 @item -mfp64
10947 @opindex mfp64
10948 Assume that floating-point registers are 64 bits wide.
10949
10950 @item -mhard-float
10951 @opindex mhard-float
10952 Use floating-point coprocessor instructions.
10953
10954 @item -msoft-float
10955 @opindex msoft-float
10956 Do not use floating-point coprocessor instructions. Implement
10957 floating-point calculations using library calls instead.
10958
10959 @item -msingle-float
10960 @opindex msingle-float
10961 Assume that the floating-point coprocessor only supports single-precision
10962 operations.
10963
10964 @itemx -mdouble-float
10965 @opindex mdouble-float
10966 Assume that the floating-point coprocessor supports double-precision
10967 operations. This is the default.
10968
10969 @itemx -mdsp
10970 @itemx -mno-dsp
10971 @opindex mdsp
10972 @opindex mno-dsp
10973 Use (do not use) the MIPS DSP ASE. @xref{MIPS DSP Built-in Functions}.
10974
10975 @itemx -mpaired-single
10976 @itemx -mno-paired-single
10977 @opindex mpaired-single
10978 @opindex mno-paired-single
10979 Use (do not use) paired-single floating-point instructions.
10980 @xref{MIPS Paired-Single Support}. This option can only be used
10981 when generating 64-bit code and requires hardware floating-point
10982 support to be enabled.
10983
10984 @itemx -mips3d
10985 @itemx -mno-mips3d
10986 @opindex mips3d
10987 @opindex mno-mips3d
10988 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
10989 The option @option{-mips3d} implies @option{-mpaired-single}.
10990
10991 @item -mlong64
10992 @opindex mlong64
10993 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
10994 an explanation of the default and the way that the pointer size is
10995 determined.
10996
10997 @item -mlong32
10998 @opindex mlong32
10999 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
11000
11001 The default size of @code{int}s, @code{long}s and pointers depends on
11002 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
11003 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
11004 32-bit @code{long}s. Pointers are the same size as @code{long}s,
11005 or the same size as integer registers, whichever is smaller.
11006
11007 @item -msym32
11008 @itemx -mno-sym32
11009 @opindex msym32
11010 @opindex mno-sym32
11011 Assume (do not assume) that all symbols have 32-bit values, regardless
11012 of the selected ABI@. This option is useful in combination with
11013 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
11014 to generate shorter and faster references to symbolic addresses.
11015
11016 @item -G @var{num}
11017 @opindex G
11018 @cindex smaller data references (MIPS)
11019 @cindex gp-relative references (MIPS)
11020 Put global and static items less than or equal to @var{num} bytes into
11021 the small data or bss section instead of the normal data or bss section.
11022 This allows the data to be accessed using a single instruction.
11023
11024 All modules should be compiled with the same @option{-G @var{num}}
11025 value.
11026
11027 @item -membedded-data
11028 @itemx -mno-embedded-data
11029 @opindex membedded-data
11030 @opindex mno-embedded-data
11031 Allocate variables to the read-only data section first if possible, then
11032 next in the small data section if possible, otherwise in data. This gives
11033 slightly slower code than the default, but reduces the amount of RAM required
11034 when executing, and thus may be preferred for some embedded systems.
11035
11036 @item -muninit-const-in-rodata
11037 @itemx -mno-uninit-const-in-rodata
11038 @opindex muninit-const-in-rodata
11039 @opindex mno-uninit-const-in-rodata
11040 Put uninitialized @code{const} variables in the read-only data section.
11041 This option is only meaningful in conjunction with @option{-membedded-data}.
11042
11043 @item -msplit-addresses
11044 @itemx -mno-split-addresses
11045 @opindex msplit-addresses
11046 @opindex mno-split-addresses
11047 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
11048 relocation operators. This option has been superseded by
11049 @option{-mexplicit-relocs} but is retained for backwards compatibility.
11050
11051 @item -mexplicit-relocs
11052 @itemx -mno-explicit-relocs
11053 @opindex mexplicit-relocs
11054 @opindex mno-explicit-relocs
11055 Use (do not use) assembler relocation operators when dealing with symbolic
11056 addresses. The alternative, selected by @option{-mno-explicit-relocs},
11057 is to use assembler macros instead.
11058
11059 @option{-mexplicit-relocs} is the default if GCC was configured
11060 to use an assembler that supports relocation operators.
11061
11062 @item -mcheck-zero-division
11063 @itemx -mno-check-zero-division
11064 @opindex mcheck-zero-division
11065 @opindex mno-check-zero-division
11066 Trap (do not trap) on integer division by zero. The default is
11067 @option{-mcheck-zero-division}.
11068
11069 @item -mdivide-traps
11070 @itemx -mdivide-breaks
11071 @opindex mdivide-traps
11072 @opindex mdivide-breaks
11073 MIPS systems check for division by zero by generating either a
11074 conditional trap or a break instruction. Using traps results in
11075 smaller code, but is only supported on MIPS II and later. Also, some
11076 versions of the Linux kernel have a bug that prevents trap from
11077 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
11078 allow conditional traps on architectures that support them and
11079 @option{-mdivide-breaks} to force the use of breaks.
11080
11081 The default is usually @option{-mdivide-traps}, but this can be
11082 overridden at configure time using @option{--with-divide=breaks}.
11083 Divide-by-zero checks can be completely disabled using
11084 @option{-mno-check-zero-division}.
11085
11086 @item -mmemcpy
11087 @itemx -mno-memcpy
11088 @opindex mmemcpy
11089 @opindex mno-memcpy
11090 Force (do not force) the use of @code{memcpy()} for non-trivial block
11091 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
11092 most constant-sized copies.
11093
11094 @item -mlong-calls
11095 @itemx -mno-long-calls
11096 @opindex mlong-calls
11097 @opindex mno-long-calls
11098 Disable (do not disable) use of the @code{jal} instruction. Calling
11099 functions using @code{jal} is more efficient but requires the caller
11100 and callee to be in the same 256 megabyte segment.
11101
11102 This option has no effect on abicalls code. The default is
11103 @option{-mno-long-calls}.
11104
11105 @item -mmad
11106 @itemx -mno-mad
11107 @opindex mmad
11108 @opindex mno-mad
11109 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
11110 instructions, as provided by the R4650 ISA@.
11111
11112 @item -mfused-madd
11113 @itemx -mno-fused-madd
11114 @opindex mfused-madd
11115 @opindex mno-fused-madd
11116 Enable (disable) use of the floating point multiply-accumulate
11117 instructions, when they are available. The default is
11118 @option{-mfused-madd}.
11119
11120 When multiply-accumulate instructions are used, the intermediate
11121 product is calculated to infinite precision and is not subject to
11122 the FCSR Flush to Zero bit. This may be undesirable in some
11123 circumstances.
11124
11125 @item -nocpp
11126 @opindex nocpp
11127 Tell the MIPS assembler to not run its preprocessor over user
11128 assembler files (with a @samp{.s} suffix) when assembling them.
11129
11130 @item -mfix-r4000
11131 @itemx -mno-fix-r4000
11132 @opindex mfix-r4000
11133 @opindex mno-fix-r4000
11134 Work around certain R4000 CPU errata:
11135 @itemize @minus
11136 @item
11137 A double-word or a variable shift may give an incorrect result if executed
11138 immediately after starting an integer division.
11139 @item
11140 A double-word or a variable shift may give an incorrect result if executed
11141 while an integer multiplication is in progress.
11142 @item
11143 An integer division may give an incorrect result if started in a delay slot
11144 of a taken branch or a jump.
11145 @end itemize
11146
11147 @item -mfix-r4400
11148 @itemx -mno-fix-r4400
11149 @opindex mfix-r4400
11150 @opindex mno-fix-r4400
11151 Work around certain R4400 CPU errata:
11152 @itemize @minus
11153 @item
11154 A double-word or a variable shift may give an incorrect result if executed
11155 immediately after starting an integer division.
11156 @end itemize
11157
11158 @item -mfix-vr4120
11159 @itemx -mno-fix-vr4120
11160 @opindex mfix-vr4120
11161 Work around certain VR4120 errata:
11162 @itemize @minus
11163 @item
11164 @code{dmultu} does not always produce the correct result.
11165 @item
11166 @code{div} and @code{ddiv} do not always produce the correct result if one
11167 of the operands is negative.
11168 @end itemize
11169 The workarounds for the division errata rely on special functions in
11170 @file{libgcc.a}. At present, these functions are only provided by
11171 the @code{mips64vr*-elf} configurations.
11172
11173 Other VR4120 errata require a nop to be inserted between certain pairs of
11174 instructions. These errata are handled by the assembler, not by GCC itself.
11175
11176 @item -mfix-vr4130
11177 @opindex mfix-vr4130
11178 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
11179 workarounds are implemented by the assembler rather than by GCC,
11180 although GCC will avoid using @code{mflo} and @code{mfhi} if the
11181 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
11182 instructions are available instead.
11183
11184 @item -mfix-sb1
11185 @itemx -mno-fix-sb1
11186 @opindex mfix-sb1
11187 Work around certain SB-1 CPU core errata.
11188 (This flag currently works around the SB-1 revision 2
11189 ``F1'' and ``F2'' floating point errata.)
11190
11191 @item -mflush-func=@var{func}
11192 @itemx -mno-flush-func
11193 @opindex mflush-func
11194 Specifies the function to call to flush the I and D caches, or to not
11195 call any such function. If called, the function must take the same
11196 arguments as the common @code{_flush_func()}, that is, the address of the
11197 memory range for which the cache is being flushed, the size of the
11198 memory range, and the number 3 (to flush both caches). The default
11199 depends on the target GCC was configured for, but commonly is either
11200 @samp{_flush_func} or @samp{__cpu_flush}.
11201
11202 @item -mbranch-likely
11203 @itemx -mno-branch-likely
11204 @opindex mbranch-likely
11205 @opindex mno-branch-likely
11206 Enable or disable use of Branch Likely instructions, regardless of the
11207 default for the selected architecture. By default, Branch Likely
11208 instructions may be generated if they are supported by the selected
11209 architecture. An exception is for the MIPS32 and MIPS64 architectures
11210 and processors which implement those architectures; for those, Branch
11211 Likely instructions will not be generated by default because the MIPS32
11212 and MIPS64 architectures specifically deprecate their use.
11213
11214 @item -mfp-exceptions
11215 @itemx -mno-fp-exceptions
11216 @opindex mfp-exceptions
11217 Specifies whether FP exceptions are enabled. This affects how we schedule
11218 FP instructions for some processors. The default is that FP exceptions are
11219 enabled.
11220
11221 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
11222 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
11223 FP pipe.
11224
11225 @item -mvr4130-align
11226 @itemx -mno-vr4130-align
11227 @opindex mvr4130-align
11228 The VR4130 pipeline is two-way superscalar, but can only issue two
11229 instructions together if the first one is 8-byte aligned. When this
11230 option is enabled, GCC will align pairs of instructions that it
11231 thinks should execute in parallel.
11232
11233 This option only has an effect when optimizing for the VR4130.
11234 It normally makes code faster, but at the expense of making it bigger.
11235 It is enabled by default at optimization level @option{-O3}.
11236 @end table
11237
11238 @node MMIX Options
11239 @subsection MMIX Options
11240 @cindex MMIX Options
11241
11242 These options are defined for the MMIX:
11243
11244 @table @gcctabopt
11245 @item -mlibfuncs
11246 @itemx -mno-libfuncs
11247 @opindex mlibfuncs
11248 @opindex mno-libfuncs
11249 Specify that intrinsic library functions are being compiled, passing all
11250 values in registers, no matter the size.
11251
11252 @item -mepsilon
11253 @itemx -mno-epsilon
11254 @opindex mepsilon
11255 @opindex mno-epsilon
11256 Generate floating-point comparison instructions that compare with respect
11257 to the @code{rE} epsilon register.
11258
11259 @item -mabi=mmixware
11260 @itemx -mabi=gnu
11261 @opindex mabi-mmixware
11262 @opindex mabi=gnu
11263 Generate code that passes function parameters and return values that (in
11264 the called function) are seen as registers @code{$0} and up, as opposed to
11265 the GNU ABI which uses global registers @code{$231} and up.
11266
11267 @item -mzero-extend
11268 @itemx -mno-zero-extend
11269 @opindex mzero-extend
11270 @opindex mno-zero-extend
11271 When reading data from memory in sizes shorter than 64 bits, use (do not
11272 use) zero-extending load instructions by default, rather than
11273 sign-extending ones.
11274
11275 @item -mknuthdiv
11276 @itemx -mno-knuthdiv
11277 @opindex mknuthdiv
11278 @opindex mno-knuthdiv
11279 Make the result of a division yielding a remainder have the same sign as
11280 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
11281 remainder follows the sign of the dividend. Both methods are
11282 arithmetically valid, the latter being almost exclusively used.
11283
11284 @item -mtoplevel-symbols
11285 @itemx -mno-toplevel-symbols
11286 @opindex mtoplevel-symbols
11287 @opindex mno-toplevel-symbols
11288 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
11289 code can be used with the @code{PREFIX} assembly directive.
11290
11291 @item -melf
11292 @opindex melf
11293 Generate an executable in the ELF format, rather than the default
11294 @samp{mmo} format used by the @command{mmix} simulator.
11295
11296 @item -mbranch-predict
11297 @itemx -mno-branch-predict
11298 @opindex mbranch-predict
11299 @opindex mno-branch-predict
11300 Use (do not use) the probable-branch instructions, when static branch
11301 prediction indicates a probable branch.
11302
11303 @item -mbase-addresses
11304 @itemx -mno-base-addresses
11305 @opindex mbase-addresses
11306 @opindex mno-base-addresses
11307 Generate (do not generate) code that uses @emph{base addresses}. Using a
11308 base address automatically generates a request (handled by the assembler
11309 and the linker) for a constant to be set up in a global register. The
11310 register is used for one or more base address requests within the range 0
11311 to 255 from the value held in the register. The generally leads to short
11312 and fast code, but the number of different data items that can be
11313 addressed is limited. This means that a program that uses lots of static
11314 data may require @option{-mno-base-addresses}.
11315
11316 @item -msingle-exit
11317 @itemx -mno-single-exit
11318 @opindex msingle-exit
11319 @opindex mno-single-exit
11320 Force (do not force) generated code to have a single exit point in each
11321 function.
11322 @end table
11323
11324 @node MN10300 Options
11325 @subsection MN10300 Options
11326 @cindex MN10300 options
11327
11328 These @option{-m} options are defined for Matsushita MN10300 architectures:
11329
11330 @table @gcctabopt
11331 @item -mmult-bug
11332 @opindex mmult-bug
11333 Generate code to avoid bugs in the multiply instructions for the MN10300
11334 processors. This is the default.
11335
11336 @item -mno-mult-bug
11337 @opindex mno-mult-bug
11338 Do not generate code to avoid bugs in the multiply instructions for the
11339 MN10300 processors.
11340
11341 @item -mam33
11342 @opindex mam33
11343 Generate code which uses features specific to the AM33 processor.
11344
11345 @item -mno-am33
11346 @opindex mno-am33
11347 Do not generate code which uses features specific to the AM33 processor. This
11348 is the default.
11349
11350 @item -mreturn-pointer-on-d0
11351 @opindex mreturn-pointer-on-d0
11352 When generating a function which returns a pointer, return the pointer
11353 in both @code{a0} and @code{d0}. Otherwise, the pointer is returned
11354 only in a0, and attempts to call such functions without a prototype
11355 would result in errors. Note that this option is on by default; use
11356 @option{-mno-return-pointer-on-d0} to disable it.
11357
11358 @item -mno-crt0
11359 @opindex mno-crt0
11360 Do not link in the C run-time initialization object file.
11361
11362 @item -mrelax
11363 @opindex mrelax
11364 Indicate to the linker that it should perform a relaxation optimization pass
11365 to shorten branches, calls and absolute memory addresses. This option only
11366 has an effect when used on the command line for the final link step.
11367
11368 This option makes symbolic debugging impossible.
11369 @end table
11370
11371 @node MT Options
11372 @subsection MT Options
11373 @cindex MT options
11374
11375 These @option{-m} options are defined for Morpho MT architectures:
11376
11377 @table @gcctabopt
11378
11379 @item -march=@var{cpu-type}
11380 @opindex march
11381 Generate code that will run on @var{cpu-type}, which is the name of a system
11382 representing a certain processor type. Possible values for
11383 @var{cpu-type} are @samp{ms1-64-001}, @samp{ms1-16-002},
11384 @samp{ms1-16-003} and @samp{ms2}.
11385
11386 When this option is not used, the default is @option{-march=ms1-16-002}.
11387
11388 @item -mbacc
11389 @opindex mbacc
11390 Use byte loads and stores when generating code.
11391
11392 @item -mno-bacc
11393 @opindex mno-bacc
11394 Do not use byte loads and stores when generating code.
11395
11396 @item -msim
11397 @opindex msim
11398 Use simulator runtime
11399
11400 @item -mno-crt0
11401 @opindex mno-crt0
11402 Do not link in the C run-time initialization object file
11403 @file{crti.o}. Other run-time initialization and termination files
11404 such as @file{startup.o} and @file{exit.o} are still included on the
11405 linker command line.
11406
11407 @end table
11408
11409 @node PDP-11 Options
11410 @subsection PDP-11 Options
11411 @cindex PDP-11 Options
11412
11413 These options are defined for the PDP-11:
11414
11415 @table @gcctabopt
11416 @item -mfpu
11417 @opindex mfpu
11418 Use hardware FPP floating point. This is the default. (FIS floating
11419 point on the PDP-11/40 is not supported.)
11420
11421 @item -msoft-float
11422 @opindex msoft-float
11423 Do not use hardware floating point.
11424
11425 @item -mac0
11426 @opindex mac0
11427 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
11428
11429 @item -mno-ac0
11430 @opindex mno-ac0
11431 Return floating-point results in memory. This is the default.
11432
11433 @item -m40
11434 @opindex m40
11435 Generate code for a PDP-11/40.
11436
11437 @item -m45
11438 @opindex m45
11439 Generate code for a PDP-11/45. This is the default.
11440
11441 @item -m10
11442 @opindex m10
11443 Generate code for a PDP-11/10.
11444
11445 @item -mbcopy-builtin
11446 @opindex bcopy-builtin
11447 Use inline @code{movmemhi} patterns for copying memory. This is the
11448 default.
11449
11450 @item -mbcopy
11451 @opindex mbcopy
11452 Do not use inline @code{movmemhi} patterns for copying memory.
11453
11454 @item -mint16
11455 @itemx -mno-int32
11456 @opindex mint16
11457 @opindex mno-int32
11458 Use 16-bit @code{int}. This is the default.
11459
11460 @item -mint32
11461 @itemx -mno-int16
11462 @opindex mint32
11463 @opindex mno-int16
11464 Use 32-bit @code{int}.
11465
11466 @item -mfloat64
11467 @itemx -mno-float32
11468 @opindex mfloat64
11469 @opindex mno-float32
11470 Use 64-bit @code{float}. This is the default.
11471
11472 @item -mfloat32
11473 @itemx -mno-float64
11474 @opindex mfloat32
11475 @opindex mno-float64
11476 Use 32-bit @code{float}.
11477
11478 @item -mabshi
11479 @opindex mabshi
11480 Use @code{abshi2} pattern. This is the default.
11481
11482 @item -mno-abshi
11483 @opindex mno-abshi
11484 Do not use @code{abshi2} pattern.
11485
11486 @item -mbranch-expensive
11487 @opindex mbranch-expensive
11488 Pretend that branches are expensive. This is for experimenting with
11489 code generation only.
11490
11491 @item -mbranch-cheap
11492 @opindex mbranch-cheap
11493 Do not pretend that branches are expensive. This is the default.
11494
11495 @item -msplit
11496 @opindex msplit
11497 Generate code for a system with split I&D@.
11498
11499 @item -mno-split
11500 @opindex mno-split
11501 Generate code for a system without split I&D@. This is the default.
11502
11503 @item -munix-asm
11504 @opindex munix-asm
11505 Use Unix assembler syntax. This is the default when configured for
11506 @samp{pdp11-*-bsd}.
11507
11508 @item -mdec-asm
11509 @opindex mdec-asm
11510 Use DEC assembler syntax. This is the default when configured for any
11511 PDP-11 target other than @samp{pdp11-*-bsd}.
11512 @end table
11513
11514 @node PowerPC Options
11515 @subsection PowerPC Options
11516 @cindex PowerPC options
11517
11518 These are listed under @xref{RS/6000 and PowerPC Options}.
11519
11520 @node RS/6000 and PowerPC Options
11521 @subsection IBM RS/6000 and PowerPC Options
11522 @cindex RS/6000 and PowerPC Options
11523 @cindex IBM RS/6000 and PowerPC Options
11524
11525 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
11526 @table @gcctabopt
11527 @item -mpower
11528 @itemx -mno-power
11529 @itemx -mpower2
11530 @itemx -mno-power2
11531 @itemx -mpowerpc
11532 @itemx -mno-powerpc
11533 @itemx -mpowerpc-gpopt
11534 @itemx -mno-powerpc-gpopt
11535 @itemx -mpowerpc-gfxopt
11536 @itemx -mno-powerpc-gfxopt
11537 @itemx -mpowerpc64
11538 @itemx -mno-powerpc64
11539 @itemx -mmfcrf
11540 @itemx -mno-mfcrf
11541 @itemx -mpopcntb
11542 @itemx -mno-popcntb
11543 @itemx -mfprnd
11544 @itemx -mno-fprnd
11545 @itemx -mmfpgpr
11546 @itemx -mno-mfpgpr
11547 @opindex mpower
11548 @opindex mno-power
11549 @opindex mpower2
11550 @opindex mno-power2
11551 @opindex mpowerpc
11552 @opindex mno-powerpc
11553 @opindex mpowerpc-gpopt
11554 @opindex mno-powerpc-gpopt
11555 @opindex mpowerpc-gfxopt
11556 @opindex mno-powerpc-gfxopt
11557 @opindex mpowerpc64
11558 @opindex mno-powerpc64
11559 @opindex mmfcrf
11560 @opindex mno-mfcrf
11561 @opindex mpopcntb
11562 @opindex mno-popcntb
11563 @opindex mfprnd
11564 @opindex mno-fprnd
11565 @opindex mmfpgpr
11566 @opindex mno-mfpgpr
11567 GCC supports two related instruction set architectures for the
11568 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
11569 instructions supported by the @samp{rios} chip set used in the original
11570 RS/6000 systems and the @dfn{PowerPC} instruction set is the
11571 architecture of the Freescale MPC5xx, MPC6xx, MPC8xx microprocessors, and
11572 the IBM 4xx, 6xx, and follow-on microprocessors.
11573
11574 Neither architecture is a subset of the other. However there is a
11575 large common subset of instructions supported by both. An MQ
11576 register is included in processors supporting the POWER architecture.
11577
11578 You use these options to specify which instructions are available on the
11579 processor you are using. The default value of these options is
11580 determined when configuring GCC@. Specifying the
11581 @option{-mcpu=@var{cpu_type}} overrides the specification of these
11582 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
11583 rather than the options listed above.
11584
11585 The @option{-mpower} option allows GCC to generate instructions that
11586 are found only in the POWER architecture and to use the MQ register.
11587 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
11588 to generate instructions that are present in the POWER2 architecture but
11589 not the original POWER architecture.
11590
11591 The @option{-mpowerpc} option allows GCC to generate instructions that
11592 are found only in the 32-bit subset of the PowerPC architecture.
11593 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
11594 GCC to use the optional PowerPC architecture instructions in the
11595 General Purpose group, including floating-point square root. Specifying
11596 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
11597 use the optional PowerPC architecture instructions in the Graphics
11598 group, including floating-point select.
11599
11600 The @option{-mmfcrf} option allows GCC to generate the move from
11601 condition register field instruction implemented on the POWER4
11602 processor and other processors that support the PowerPC V2.01
11603 architecture.
11604 The @option{-mpopcntb} option allows GCC to generate the popcount and
11605 double precision FP reciprocal estimate instruction implemented on the
11606 POWER5 processor and other processors that support the PowerPC V2.02
11607 architecture.
11608 The @option{-mfprnd} option allows GCC to generate the FP round to
11609 integer instructions implemented on the POWER5+ processor and other
11610 processors that support the PowerPC V2.03 architecture.
11611 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
11612 general purpose register instructions implemented on the POWER6X
11613 processor and other processors that support the extended PowerPC V2.05
11614 architecture.
11615
11616 The @option{-mpowerpc64} option allows GCC to generate the additional
11617 64-bit instructions that are found in the full PowerPC64 architecture
11618 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
11619 @option{-mno-powerpc64}.
11620
11621 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
11622 will use only the instructions in the common subset of both
11623 architectures plus some special AIX common-mode calls, and will not use
11624 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
11625 permits GCC to use any instruction from either architecture and to
11626 allow use of the MQ register; specify this for the Motorola MPC601.
11627
11628 @item -mnew-mnemonics
11629 @itemx -mold-mnemonics
11630 @opindex mnew-mnemonics
11631 @opindex mold-mnemonics
11632 Select which mnemonics to use in the generated assembler code. With
11633 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
11634 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
11635 assembler mnemonics defined for the POWER architecture. Instructions
11636 defined in only one architecture have only one mnemonic; GCC uses that
11637 mnemonic irrespective of which of these options is specified.
11638
11639 GCC defaults to the mnemonics appropriate for the architecture in
11640 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
11641 value of these option. Unless you are building a cross-compiler, you
11642 should normally not specify either @option{-mnew-mnemonics} or
11643 @option{-mold-mnemonics}, but should instead accept the default.
11644
11645 @item -mcpu=@var{cpu_type}
11646 @opindex mcpu
11647 Set architecture type, register usage, choice of mnemonics, and
11648 instruction scheduling parameters for machine type @var{cpu_type}.
11649 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
11650 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
11651 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
11652 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
11653 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
11654 @samp{860}, @samp{970}, @samp{8540}, @samp{ec603e}, @samp{G3},
11655 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
11656 @samp{power4}, @samp{power5}, @samp{power5+}, @samp{power6},
11657 @samp{power6x}, @samp{common}, @samp{powerpc}, @samp{powerpc64},
11658 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
11659
11660 @option{-mcpu=common} selects a completely generic processor. Code
11661 generated under this option will run on any POWER or PowerPC processor.
11662 GCC will use only the instructions in the common subset of both
11663 architectures, and will not use the MQ register. GCC assumes a generic
11664 processor model for scheduling purposes.
11665
11666 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
11667 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
11668 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
11669 types, with an appropriate, generic processor model assumed for
11670 scheduling purposes.
11671
11672 The other options specify a specific processor. Code generated under
11673 those options will run best on that processor, and may not run at all on
11674 others.
11675
11676 The @option{-mcpu} options automatically enable or disable the
11677 following options: @option{-maltivec}, @option{-mfprnd},
11678 @option{-mhard-float}, @option{-mmfcrf}, @option{-mmultiple},
11679 @option{-mnew-mnemonics}, @option{-mpopcntb}, @option{-mpower},
11680 @option{-mpower2}, @option{-mpowerpc64}, @option{-mpowerpc-gpopt},
11681 @option{-mpowerpc-gfxopt}, @option{-mstring}, @option{-mmulhw},
11682 @option{-mdlmzb}, @option{-mmfpgpr}.
11683 The particular options set for any particular CPU will vary between
11684 compiler versions, depending on what setting seems to produce optimal
11685 code for that CPU; it doesn't necessarily reflect the actual hardware's
11686 capabilities. If you wish to set an individual option to a particular
11687 value, you may specify it after the @option{-mcpu} option, like
11688 @samp{-mcpu=970 -mno-altivec}.
11689
11690 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
11691 not enabled or disabled by the @option{-mcpu} option at present because
11692 AIX does not have full support for these options. You may still
11693 enable or disable them individually if you're sure it'll work in your
11694 environment.
11695
11696 @item -mtune=@var{cpu_type}
11697 @opindex mtune
11698 Set the instruction scheduling parameters for machine type
11699 @var{cpu_type}, but do not set the architecture type, register usage, or
11700 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
11701 values for @var{cpu_type} are used for @option{-mtune} as for
11702 @option{-mcpu}. If both are specified, the code generated will use the
11703 architecture, registers, and mnemonics set by @option{-mcpu}, but the
11704 scheduling parameters set by @option{-mtune}.
11705
11706 @item -mswdiv
11707 @itemx -mno-swdiv
11708 @opindex mswdiv
11709 @opindex mno-swdiv
11710 Generate code to compute division as reciprocal estimate and iterative
11711 refinement, creating opportunities for increased throughput. This
11712 feature requires: optional PowerPC Graphics instruction set for single
11713 precision and FRE instruction for double precision, assuming divides
11714 cannot generate user-visible traps, and the domain values not include
11715 Infinities, denormals or zero denominator.
11716
11717 @item -maltivec
11718 @itemx -mno-altivec
11719 @opindex maltivec
11720 @opindex mno-altivec
11721 Generate code that uses (does not use) AltiVec instructions, and also
11722 enable the use of built-in functions that allow more direct access to
11723 the AltiVec instruction set. You may also need to set
11724 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
11725 enhancements.
11726
11727 @item -mvrsave
11728 @item -mno-vrsave
11729 @opindex mvrsave
11730 @opindex mno-vrsave
11731 Generate VRSAVE instructions when generating AltiVec code.
11732
11733 @item -msecure-plt
11734 @opindex msecure-plt
11735 Generate code that allows ld and ld.so to build executables and shared
11736 libraries with non-exec .plt and .got sections. This is a PowerPC
11737 32-bit SYSV ABI option.
11738
11739 @item -mbss-plt
11740 @opindex mbss-plt
11741 Generate code that uses a BSS .plt section that ld.so fills in, and
11742 requires .plt and .got sections that are both writable and executable.
11743 This is a PowerPC 32-bit SYSV ABI option.
11744
11745 @item -misel
11746 @itemx -mno-isel
11747 @opindex misel
11748 @opindex mno-isel
11749 This switch enables or disables the generation of ISEL instructions.
11750
11751 @item -misel=@var{yes/no}
11752 This switch has been deprecated. Use @option{-misel} and
11753 @option{-mno-isel} instead.
11754
11755 @item -mspe
11756 @itemx -mno-spe
11757 @opindex mspe
11758 @opindex mno-spe
11759 This switch enables or disables the generation of SPE simd
11760 instructions.
11761
11762 @item -mspe=@var{yes/no}
11763 This option has been deprecated. Use @option{-mspe} and
11764 @option{-mno-spe} instead.
11765
11766 @item -mfloat-gprs=@var{yes/single/double/no}
11767 @itemx -mfloat-gprs
11768 @opindex mfloat-gprs
11769 This switch enables or disables the generation of floating point
11770 operations on the general purpose registers for architectures that
11771 support it.
11772
11773 The argument @var{yes} or @var{single} enables the use of
11774 single-precision floating point operations.
11775
11776 The argument @var{double} enables the use of single and
11777 double-precision floating point operations.
11778
11779 The argument @var{no} disables floating point operations on the
11780 general purpose registers.
11781
11782 This option is currently only available on the MPC854x.
11783
11784 @item -m32
11785 @itemx -m64
11786 @opindex m32
11787 @opindex m64
11788 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
11789 targets (including GNU/Linux). The 32-bit environment sets int, long
11790 and pointer to 32 bits and generates code that runs on any PowerPC
11791 variant. The 64-bit environment sets int to 32 bits and long and
11792 pointer to 64 bits, and generates code for PowerPC64, as for
11793 @option{-mpowerpc64}.
11794
11795 @item -mfull-toc
11796 @itemx -mno-fp-in-toc
11797 @itemx -mno-sum-in-toc
11798 @itemx -mminimal-toc
11799 @opindex mfull-toc
11800 @opindex mno-fp-in-toc
11801 @opindex mno-sum-in-toc
11802 @opindex mminimal-toc
11803 Modify generation of the TOC (Table Of Contents), which is created for
11804 every executable file. The @option{-mfull-toc} option is selected by
11805 default. In that case, GCC will allocate at least one TOC entry for
11806 each unique non-automatic variable reference in your program. GCC
11807 will also place floating-point constants in the TOC@. However, only
11808 16,384 entries are available in the TOC@.
11809
11810 If you receive a linker error message that saying you have overflowed
11811 the available TOC space, you can reduce the amount of TOC space used
11812 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
11813 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
11814 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
11815 generate code to calculate the sum of an address and a constant at
11816 run-time instead of putting that sum into the TOC@. You may specify one
11817 or both of these options. Each causes GCC to produce very slightly
11818 slower and larger code at the expense of conserving TOC space.
11819
11820 If you still run out of space in the TOC even when you specify both of
11821 these options, specify @option{-mminimal-toc} instead. This option causes
11822 GCC to make only one TOC entry for every file. When you specify this
11823 option, GCC will produce code that is slower and larger but which
11824 uses extremely little TOC space. You may wish to use this option
11825 only on files that contain less frequently executed code.
11826
11827 @item -maix64
11828 @itemx -maix32
11829 @opindex maix64
11830 @opindex maix32
11831 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
11832 @code{long} type, and the infrastructure needed to support them.
11833 Specifying @option{-maix64} implies @option{-mpowerpc64} and
11834 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
11835 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
11836
11837 @item -mxl-compat
11838 @itemx -mno-xl-compat
11839 @opindex mxl-compat
11840 @opindex mno-xl-compat
11841 Produce code that conforms more closely to IBM XL compiler semantics
11842 when using AIX-compatible ABI. Pass floating-point arguments to
11843 prototyped functions beyond the register save area (RSA) on the stack
11844 in addition to argument FPRs. Do not assume that most significant
11845 double in 128-bit long double value is properly rounded when comparing
11846 values and converting to double. Use XL symbol names for long double
11847 support routines.
11848
11849 The AIX calling convention was extended but not initially documented to
11850 handle an obscure K&R C case of calling a function that takes the
11851 address of its arguments with fewer arguments than declared. IBM XL
11852 compilers access floating point arguments which do not fit in the
11853 RSA from the stack when a subroutine is compiled without
11854 optimization. Because always storing floating-point arguments on the
11855 stack is inefficient and rarely needed, this option is not enabled by
11856 default and only is necessary when calling subroutines compiled by IBM
11857 XL compilers without optimization.
11858
11859 @item -mpe
11860 @opindex mpe
11861 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
11862 application written to use message passing with special startup code to
11863 enable the application to run. The system must have PE installed in the
11864 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
11865 must be overridden with the @option{-specs=} option to specify the
11866 appropriate directory location. The Parallel Environment does not
11867 support threads, so the @option{-mpe} option and the @option{-pthread}
11868 option are incompatible.
11869
11870 @item -malign-natural
11871 @itemx -malign-power
11872 @opindex malign-natural
11873 @opindex malign-power
11874 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
11875 @option{-malign-natural} overrides the ABI-defined alignment of larger
11876 types, such as floating-point doubles, on their natural size-based boundary.
11877 The option @option{-malign-power} instructs GCC to follow the ABI-specified
11878 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
11879
11880 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
11881 is not supported.
11882
11883 @item -msoft-float
11884 @itemx -mhard-float
11885 @opindex msoft-float
11886 @opindex mhard-float
11887 Generate code that does not use (uses) the floating-point register set.
11888 Software floating point emulation is provided if you use the
11889 @option{-msoft-float} option, and pass the option to GCC when linking.
11890
11891 @item -mmultiple
11892 @itemx -mno-multiple
11893 @opindex mmultiple
11894 @opindex mno-multiple
11895 Generate code that uses (does not use) the load multiple word
11896 instructions and the store multiple word instructions. These
11897 instructions are generated by default on POWER systems, and not
11898 generated on PowerPC systems. Do not use @option{-mmultiple} on little
11899 endian PowerPC systems, since those instructions do not work when the
11900 processor is in little endian mode. The exceptions are PPC740 and
11901 PPC750 which permit the instructions usage in little endian mode.
11902
11903 @item -mstring
11904 @itemx -mno-string
11905 @opindex mstring
11906 @opindex mno-string
11907 Generate code that uses (does not use) the load string instructions
11908 and the store string word instructions to save multiple registers and
11909 do small block moves. These instructions are generated by default on
11910 POWER systems, and not generated on PowerPC systems. Do not use
11911 @option{-mstring} on little endian PowerPC systems, since those
11912 instructions do not work when the processor is in little endian mode.
11913 The exceptions are PPC740 and PPC750 which permit the instructions
11914 usage in little endian mode.
11915
11916 @item -mupdate
11917 @itemx -mno-update
11918 @opindex mupdate
11919 @opindex mno-update
11920 Generate code that uses (does not use) the load or store instructions
11921 that update the base register to the address of the calculated memory
11922 location. These instructions are generated by default. If you use
11923 @option{-mno-update}, there is a small window between the time that the
11924 stack pointer is updated and the address of the previous frame is
11925 stored, which means code that walks the stack frame across interrupts or
11926 signals may get corrupted data.
11927
11928 @item -mfused-madd
11929 @itemx -mno-fused-madd
11930 @opindex mfused-madd
11931 @opindex mno-fused-madd
11932 Generate code that uses (does not use) the floating point multiply and
11933 accumulate instructions. These instructions are generated by default if
11934 hardware floating is used.
11935
11936 @item -mmulhw
11937 @itemx -mno-mulhw
11938 @opindex mmulhw
11939 @opindex mno-mulhw
11940 Generate code that uses (does not use) the half-word multiply and
11941 multiply-accumulate instructions on the IBM 405 and 440 processors.
11942 These instructions are generated by default when targetting those
11943 processors.
11944
11945 @item -mdlmzb
11946 @itemx -mno-dlmzb
11947 @opindex mdlmzb
11948 @opindex mno-dlmzb
11949 Generate code that uses (does not use) the string-search @samp{dlmzb}
11950 instruction on the IBM 405 and 440 processors. This instruction is
11951 generated by default when targetting those processors.
11952
11953 @item -mno-bit-align
11954 @itemx -mbit-align
11955 @opindex mno-bit-align
11956 @opindex mbit-align
11957 On System V.4 and embedded PowerPC systems do not (do) force structures
11958 and unions that contain bit-fields to be aligned to the base type of the
11959 bit-field.
11960
11961 For example, by default a structure containing nothing but 8
11962 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11963 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
11964 the structure would be aligned to a 1 byte boundary and be one byte in
11965 size.
11966
11967 @item -mno-strict-align
11968 @itemx -mstrict-align
11969 @opindex mno-strict-align
11970 @opindex mstrict-align
11971 On System V.4 and embedded PowerPC systems do not (do) assume that
11972 unaligned memory references will be handled by the system.
11973
11974 @item -mrelocatable
11975 @itemx -mno-relocatable
11976 @opindex mrelocatable
11977 @opindex mno-relocatable
11978 On embedded PowerPC systems generate code that allows (does not allow)
11979 the program to be relocated to a different address at runtime. If you
11980 use @option{-mrelocatable} on any module, all objects linked together must
11981 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11982
11983 @item -mrelocatable-lib
11984 @itemx -mno-relocatable-lib
11985 @opindex mrelocatable-lib
11986 @opindex mno-relocatable-lib
11987 On embedded PowerPC systems generate code that allows (does not allow)
11988 the program to be relocated to a different address at runtime. Modules
11989 compiled with @option{-mrelocatable-lib} can be linked with either modules
11990 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11991 with modules compiled with the @option{-mrelocatable} options.
11992
11993 @item -mno-toc
11994 @itemx -mtoc
11995 @opindex mno-toc
11996 @opindex mtoc
11997 On System V.4 and embedded PowerPC systems do not (do) assume that
11998 register 2 contains a pointer to a global area pointing to the addresses
11999 used in the program.
12000
12001 @item -mlittle
12002 @itemx -mlittle-endian
12003 @opindex mlittle
12004 @opindex mlittle-endian
12005 On System V.4 and embedded PowerPC systems compile code for the
12006 processor in little endian mode. The @option{-mlittle-endian} option is
12007 the same as @option{-mlittle}.
12008
12009 @item -mbig
12010 @itemx -mbig-endian
12011 @opindex mbig
12012 @opindex mbig-endian
12013 On System V.4 and embedded PowerPC systems compile code for the
12014 processor in big endian mode. The @option{-mbig-endian} option is
12015 the same as @option{-mbig}.
12016
12017 @item -mdynamic-no-pic
12018 @opindex mdynamic-no-pic
12019 On Darwin and Mac OS X systems, compile code so that it is not
12020 relocatable, but that its external references are relocatable. The
12021 resulting code is suitable for applications, but not shared
12022 libraries.
12023
12024 @item -mprioritize-restricted-insns=@var{priority}
12025 @opindex mprioritize-restricted-insns
12026 This option controls the priority that is assigned to
12027 dispatch-slot restricted instructions during the second scheduling
12028 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
12029 @var{no/highest/second-highest} priority to dispatch slot restricted
12030 instructions.
12031
12032 @item -msched-costly-dep=@var{dependence_type}
12033 @opindex msched-costly-dep
12034 This option controls which dependences are considered costly
12035 by the target during instruction scheduling. The argument
12036 @var{dependence_type} takes one of the following values:
12037 @var{no}: no dependence is costly,
12038 @var{all}: all dependences are costly,
12039 @var{true_store_to_load}: a true dependence from store to load is costly,
12040 @var{store_to_load}: any dependence from store to load is costly,
12041 @var{number}: any dependence which latency >= @var{number} is costly.
12042
12043 @item -minsert-sched-nops=@var{scheme}
12044 @opindex minsert-sched-nops
12045 This option controls which nop insertion scheme will be used during
12046 the second scheduling pass. The argument @var{scheme} takes one of the
12047 following values:
12048 @var{no}: Don't insert nops.
12049 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
12050 according to the scheduler's grouping.
12051 @var{regroup_exact}: Insert nops to force costly dependent insns into
12052 separate groups. Insert exactly as many nops as needed to force an insn
12053 to a new group, according to the estimated processor grouping.
12054 @var{number}: Insert nops to force costly dependent insns into
12055 separate groups. Insert @var{number} nops to force an insn to a new group.
12056
12057 @item -mcall-sysv
12058 @opindex mcall-sysv
12059 On System V.4 and embedded PowerPC systems compile code using calling
12060 conventions that adheres to the March 1995 draft of the System V
12061 Application Binary Interface, PowerPC processor supplement. This is the
12062 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
12063
12064 @item -mcall-sysv-eabi
12065 @opindex mcall-sysv-eabi
12066 Specify both @option{-mcall-sysv} and @option{-meabi} options.
12067
12068 @item -mcall-sysv-noeabi
12069 @opindex mcall-sysv-noeabi
12070 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
12071
12072 @item -mcall-solaris
12073 @opindex mcall-solaris
12074 On System V.4 and embedded PowerPC systems compile code for the Solaris
12075 operating system.
12076
12077 @item -mcall-linux
12078 @opindex mcall-linux
12079 On System V.4 and embedded PowerPC systems compile code for the
12080 Linux-based GNU system.
12081
12082 @item -mcall-gnu
12083 @opindex mcall-gnu
12084 On System V.4 and embedded PowerPC systems compile code for the
12085 Hurd-based GNU system.
12086
12087 @item -mcall-netbsd
12088 @opindex mcall-netbsd
12089 On System V.4 and embedded PowerPC systems compile code for the
12090 NetBSD operating system.
12091
12092 @item -maix-struct-return
12093 @opindex maix-struct-return
12094 Return all structures in memory (as specified by the AIX ABI)@.
12095
12096 @item -msvr4-struct-return
12097 @opindex msvr4-struct-return
12098 Return structures smaller than 8 bytes in registers (as specified by the
12099 SVR4 ABI)@.
12100
12101 @item -mabi=@var{abi-type}
12102 @opindex mabi
12103 Extend the current ABI with a particular extension, or remove such extension.
12104 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
12105 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble}@.
12106
12107 @item -mabi=spe
12108 @opindex mabi=spe
12109 Extend the current ABI with SPE ABI extensions. This does not change
12110 the default ABI, instead it adds the SPE ABI extensions to the current
12111 ABI@.
12112
12113 @item -mabi=no-spe
12114 @opindex mabi=no-spe
12115 Disable Booke SPE ABI extensions for the current ABI@.
12116
12117 @item -mabi=ibmlongdouble
12118 @opindex mabi=ibmlongdouble
12119 Change the current ABI to use IBM extended precision long double.
12120 This is a PowerPC 32-bit SYSV ABI option.
12121
12122 @item -mabi=ieeelongdouble
12123 @opindex mabi=ieeelongdouble
12124 Change the current ABI to use IEEE extended precision long double.
12125 This is a PowerPC 32-bit Linux ABI option.
12126
12127 @item -mprototype
12128 @itemx -mno-prototype
12129 @opindex mprototype
12130 @opindex mno-prototype
12131 On System V.4 and embedded PowerPC systems assume that all calls to
12132 variable argument functions are properly prototyped. Otherwise, the
12133 compiler must insert an instruction before every non prototyped call to
12134 set or clear bit 6 of the condition code register (@var{CR}) to
12135 indicate whether floating point values were passed in the floating point
12136 registers in case the function takes a variable arguments. With
12137 @option{-mprototype}, only calls to prototyped variable argument functions
12138 will set or clear the bit.
12139
12140 @item -msim
12141 @opindex msim
12142 On embedded PowerPC systems, assume that the startup module is called
12143 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
12144 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
12145 configurations.
12146
12147 @item -mmvme
12148 @opindex mmvme
12149 On embedded PowerPC systems, assume that the startup module is called
12150 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
12151 @file{libc.a}.
12152
12153 @item -mads
12154 @opindex mads
12155 On embedded PowerPC systems, assume that the startup module is called
12156 @file{crt0.o} and the standard C libraries are @file{libads.a} and
12157 @file{libc.a}.
12158
12159 @item -myellowknife
12160 @opindex myellowknife
12161 On embedded PowerPC systems, assume that the startup module is called
12162 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
12163 @file{libc.a}.
12164
12165 @item -mvxworks
12166 @opindex mvxworks
12167 On System V.4 and embedded PowerPC systems, specify that you are
12168 compiling for a VxWorks system.
12169
12170 @item -mwindiss
12171 @opindex mwindiss
12172 Specify that you are compiling for the WindISS simulation environment.
12173
12174 @item -memb
12175 @opindex memb
12176 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
12177 header to indicate that @samp{eabi} extended relocations are used.
12178
12179 @item -meabi
12180 @itemx -mno-eabi
12181 @opindex meabi
12182 @opindex mno-eabi
12183 On System V.4 and embedded PowerPC systems do (do not) adhere to the
12184 Embedded Applications Binary Interface (eabi) which is a set of
12185 modifications to the System V.4 specifications. Selecting @option{-meabi}
12186 means that the stack is aligned to an 8 byte boundary, a function
12187 @code{__eabi} is called to from @code{main} to set up the eabi
12188 environment, and the @option{-msdata} option can use both @code{r2} and
12189 @code{r13} to point to two separate small data areas. Selecting
12190 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
12191 do not call an initialization function from @code{main}, and the
12192 @option{-msdata} option will only use @code{r13} to point to a single
12193 small data area. The @option{-meabi} option is on by default if you
12194 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
12195
12196 @item -msdata=eabi
12197 @opindex msdata=eabi
12198 On System V.4 and embedded PowerPC systems, put small initialized
12199 @code{const} global and static data in the @samp{.sdata2} section, which
12200 is pointed to by register @code{r2}. Put small initialized
12201 non-@code{const} global and static data in the @samp{.sdata} section,
12202 which is pointed to by register @code{r13}. Put small uninitialized
12203 global and static data in the @samp{.sbss} section, which is adjacent to
12204 the @samp{.sdata} section. The @option{-msdata=eabi} option is
12205 incompatible with the @option{-mrelocatable} option. The
12206 @option{-msdata=eabi} option also sets the @option{-memb} option.
12207
12208 @item -msdata=sysv
12209 @opindex msdata=sysv
12210 On System V.4 and embedded PowerPC systems, put small global and static
12211 data in the @samp{.sdata} section, which is pointed to by register
12212 @code{r13}. Put small uninitialized global and static data in the
12213 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
12214 The @option{-msdata=sysv} option is incompatible with the
12215 @option{-mrelocatable} option.
12216
12217 @item -msdata=default
12218 @itemx -msdata
12219 @opindex msdata=default
12220 @opindex msdata
12221 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
12222 compile code the same as @option{-msdata=eabi}, otherwise compile code the
12223 same as @option{-msdata=sysv}.
12224
12225 @item -msdata-data
12226 @opindex msdata-data
12227 On System V.4 and embedded PowerPC systems, put small global
12228 data in the @samp{.sdata} section. Put small uninitialized global
12229 data in the @samp{.sbss} section. Do not use register @code{r13}
12230 to address small data however. This is the default behavior unless
12231 other @option{-msdata} options are used.
12232
12233 @item -msdata=none
12234 @itemx -mno-sdata
12235 @opindex msdata=none
12236 @opindex mno-sdata
12237 On embedded PowerPC systems, put all initialized global and static data
12238 in the @samp{.data} section, and all uninitialized data in the
12239 @samp{.bss} section.
12240
12241 @item -G @var{num}
12242 @opindex G
12243 @cindex smaller data references (PowerPC)
12244 @cindex .sdata/.sdata2 references (PowerPC)
12245 On embedded PowerPC systems, put global and static items less than or
12246 equal to @var{num} bytes into the small data or bss sections instead of
12247 the normal data or bss section. By default, @var{num} is 8. The
12248 @option{-G @var{num}} switch is also passed to the linker.
12249 All modules should be compiled with the same @option{-G @var{num}} value.
12250
12251 @item -mregnames
12252 @itemx -mno-regnames
12253 @opindex mregnames
12254 @opindex mno-regnames
12255 On System V.4 and embedded PowerPC systems do (do not) emit register
12256 names in the assembly language output using symbolic forms.
12257
12258 @item -mlongcall
12259 @itemx -mno-longcall
12260 @opindex mlongcall
12261 @opindex mno-longcall
12262 By default assume that all calls are far away so that a longer more
12263 expensive calling sequence is required. This is required for calls
12264 further than 32 megabytes (33,554,432 bytes) from the current location.
12265 A short call will be generated if the compiler knows
12266 the call cannot be that far away. This setting can be overridden by
12267 the @code{shortcall} function attribute, or by @code{#pragma
12268 longcall(0)}.
12269
12270 Some linkers are capable of detecting out-of-range calls and generating
12271 glue code on the fly. On these systems, long calls are unnecessary and
12272 generate slower code. As of this writing, the AIX linker can do this,
12273 as can the GNU linker for PowerPC/64. It is planned to add this feature
12274 to the GNU linker for 32-bit PowerPC systems as well.
12275
12276 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
12277 callee, L42'', plus a ``branch island'' (glue code). The two target
12278 addresses represent the callee and the ``branch island''. The
12279 Darwin/PPC linker will prefer the first address and generate a ``bl
12280 callee'' if the PPC ``bl'' instruction will reach the callee directly;
12281 otherwise, the linker will generate ``bl L42'' to call the ``branch
12282 island''. The ``branch island'' is appended to the body of the
12283 calling function; it computes the full 32-bit address of the callee
12284 and jumps to it.
12285
12286 On Mach-O (Darwin) systems, this option directs the compiler emit to
12287 the glue for every direct call, and the Darwin linker decides whether
12288 to use or discard it.
12289
12290 In the future, we may cause GCC to ignore all longcall specifications
12291 when the linker is known to generate glue.
12292
12293 @item -pthread
12294 @opindex pthread
12295 Adds support for multithreading with the @dfn{pthreads} library.
12296 This option sets flags for both the preprocessor and linker.
12297
12298 @end table
12299
12300 @node S/390 and zSeries Options
12301 @subsection S/390 and zSeries Options
12302 @cindex S/390 and zSeries Options
12303
12304 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
12305
12306 @table @gcctabopt
12307 @item -mhard-float
12308 @itemx -msoft-float
12309 @opindex mhard-float
12310 @opindex msoft-float
12311 Use (do not use) the hardware floating-point instructions and registers
12312 for floating-point operations. When @option{-msoft-float} is specified,
12313 functions in @file{libgcc.a} will be used to perform floating-point
12314 operations. When @option{-mhard-float} is specified, the compiler
12315 generates IEEE floating-point instructions. This is the default.
12316
12317 @item -mlong-double-64
12318 @itemx -mlong-double-128
12319 @opindex mlong-double-64
12320 @opindex mlong-double-128
12321 These switches control the size of @code{long double} type. A size
12322 of 64bit makes the @code{long double} type equivalent to the @code{double}
12323 type. This is the default.
12324
12325 @item -mbackchain
12326 @itemx -mno-backchain
12327 @opindex mbackchain
12328 @opindex mno-backchain
12329 Store (do not store) the address of the caller's frame as backchain pointer
12330 into the callee's stack frame.
12331 A backchain may be needed to allow debugging using tools that do not understand
12332 DWARF-2 call frame information.
12333 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
12334 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
12335 the backchain is placed into the topmost word of the 96/160 byte register
12336 save area.
12337
12338 In general, code compiled with @option{-mbackchain} is call-compatible with
12339 code compiled with @option{-mmo-backchain}; however, use of the backchain
12340 for debugging purposes usually requires that the whole binary is built with
12341 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
12342 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
12343 to build a linux kernel use @option{-msoft-float}.
12344
12345 The default is to not maintain the backchain.
12346
12347 @item -mpacked-stack
12348 @item -mno-packed-stack
12349 @opindex mpacked-stack
12350 @opindex mno-packed-stack
12351 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
12352 specified, the compiler uses the all fields of the 96/160 byte register save
12353 area only for their default purpose; unused fields still take up stack space.
12354 When @option{-mpacked-stack} is specified, register save slots are densely
12355 packed at the top of the register save area; unused space is reused for other
12356 purposes, allowing for more efficient use of the available stack space.
12357 However, when @option{-mbackchain} is also in effect, the topmost word of
12358 the save area is always used to store the backchain, and the return address
12359 register is always saved two words below the backchain.
12360
12361 As long as the stack frame backchain is not used, code generated with
12362 @option{-mpacked-stack} is call-compatible with code generated with
12363 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
12364 S/390 or zSeries generated code that uses the stack frame backchain at run
12365 time, not just for debugging purposes. Such code is not call-compatible
12366 with code compiled with @option{-mpacked-stack}. Also, note that the
12367 combination of @option{-mbackchain},
12368 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
12369 to build a linux kernel use @option{-msoft-float}.
12370
12371 The default is to not use the packed stack layout.
12372
12373 @item -msmall-exec
12374 @itemx -mno-small-exec
12375 @opindex msmall-exec
12376 @opindex mno-small-exec
12377 Generate (or do not generate) code using the @code{bras} instruction
12378 to do subroutine calls.
12379 This only works reliably if the total executable size does not
12380 exceed 64k. The default is to use the @code{basr} instruction instead,
12381 which does not have this limitation.
12382
12383 @item -m64
12384 @itemx -m31
12385 @opindex m64
12386 @opindex m31
12387 When @option{-m31} is specified, generate code compliant to the
12388 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
12389 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
12390 particular to generate 64-bit instructions. For the @samp{s390}
12391 targets, the default is @option{-m31}, while the @samp{s390x}
12392 targets default to @option{-m64}.
12393
12394 @item -mzarch
12395 @itemx -mesa
12396 @opindex mzarch
12397 @opindex mesa
12398 When @option{-mzarch} is specified, generate code using the
12399 instructions available on z/Architecture.
12400 When @option{-mesa} is specified, generate code using the
12401 instructions available on ESA/390. Note that @option{-mesa} is
12402 not possible with @option{-m64}.
12403 When generating code compliant to the GNU/Linux for S/390 ABI,
12404 the default is @option{-mesa}. When generating code compliant
12405 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
12406
12407 @item -mmvcle
12408 @itemx -mno-mvcle
12409 @opindex mmvcle
12410 @opindex mno-mvcle
12411 Generate (or do not generate) code using the @code{mvcle} instruction
12412 to perform block moves. When @option{-mno-mvcle} is specified,
12413 use a @code{mvc} loop instead. This is the default unless optimizing for
12414 size.
12415
12416 @item -mdebug
12417 @itemx -mno-debug
12418 @opindex mdebug
12419 @opindex mno-debug
12420 Print (or do not print) additional debug information when compiling.
12421 The default is to not print debug information.
12422
12423 @item -march=@var{cpu-type}
12424 @opindex march
12425 Generate code that will run on @var{cpu-type}, which is the name of a system
12426 representing a certain processor type. Possible values for
12427 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
12428 When generating code using the instructions available on z/Architecture,
12429 the default is @option{-march=z900}. Otherwise, the default is
12430 @option{-march=g5}.
12431
12432 @item -mtune=@var{cpu-type}
12433 @opindex mtune
12434 Tune to @var{cpu-type} everything applicable about the generated code,
12435 except for the ABI and the set of available instructions.
12436 The list of @var{cpu-type} values is the same as for @option{-march}.
12437 The default is the value used for @option{-march}.
12438
12439 @item -mtpf-trace
12440 @itemx -mno-tpf-trace
12441 @opindex mtpf-trace
12442 @opindex mno-tpf-trace
12443 Generate code that adds (does not add) in TPF OS specific branches to trace
12444 routines in the operating system. This option is off by default, even
12445 when compiling for the TPF OS@.
12446
12447 @item -mfused-madd
12448 @itemx -mno-fused-madd
12449 @opindex mfused-madd
12450 @opindex mno-fused-madd
12451 Generate code that uses (does not use) the floating point multiply and
12452 accumulate instructions. These instructions are generated by default if
12453 hardware floating point is used.
12454
12455 @item -mwarn-framesize=@var{framesize}
12456 @opindex mwarn-framesize
12457 Emit a warning if the current function exceeds the given frame size. Because
12458 this is a compile time check it doesn't need to be a real problem when the program
12459 runs. It is intended to identify functions which most probably cause
12460 a stack overflow. It is useful to be used in an environment with limited stack
12461 size e.g.@: the linux kernel.
12462
12463 @item -mwarn-dynamicstack
12464 @opindex mwarn-dynamicstack
12465 Emit a warning if the function calls alloca or uses dynamically
12466 sized arrays. This is generally a bad idea with a limited stack size.
12467
12468 @item -mstack-guard=@var{stack-guard}
12469 @item -mstack-size=@var{stack-size}
12470 @opindex mstack-guard
12471 @opindex mstack-size
12472 These arguments always have to be used in conjunction. If they are present the s390
12473 back end emits additional instructions in the function prologue which trigger a trap
12474 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
12475 (remember that the stack on s390 grows downward). These options are intended to
12476 be used to help debugging stack overflow problems. The additionally emitted code
12477 causes only little overhead and hence can also be used in production like systems
12478 without greater performance degradation. The given values have to be exact
12479 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard} without
12480 exceeding 64k.
12481 In order to be efficient the extra code makes the assumption that the stack starts
12482 at an address aligned to the value given by @var{stack-size}.
12483 @end table
12484
12485 @node Score Options
12486 @subsection Score Options
12487 @cindex Score Options
12488
12489 These options are defined for Score implementations:
12490
12491 @table @gcctabopt
12492 @item -mel
12493 @opindex -mel
12494 Compile code for little endian mode.
12495
12496 @item -meb
12497 @opindex meb
12498 Compile code for big endian mode. This is the default.
12499
12500 @item -mmac
12501 @opindex mmac
12502 Enable the use of multiply-accumulate instructions. Disabled by default.
12503
12504 @item -mscore5u
12505 @opindex mscore5u
12506 Specify the SCORE5U of the target architecture.
12507
12508 @item -mscore7
12509 @opindex mscore7
12510 Specify the SCORE7 of the target architecture. This is the default.
12511 @end table
12512
12513 @node SH Options
12514 @subsection SH Options
12515
12516 These @samp{-m} options are defined for the SH implementations:
12517
12518 @table @gcctabopt
12519 @item -m1
12520 @opindex m1
12521 Generate code for the SH1.
12522
12523 @item -m2
12524 @opindex m2
12525 Generate code for the SH2.
12526
12527 @item -m2e
12528 Generate code for the SH2e.
12529
12530 @item -m3
12531 @opindex m3
12532 Generate code for the SH3.
12533
12534 @item -m3e
12535 @opindex m3e
12536 Generate code for the SH3e.
12537
12538 @item -m4-nofpu
12539 @opindex m4-nofpu
12540 Generate code for the SH4 without a floating-point unit.
12541
12542 @item -m4-single-only
12543 @opindex m4-single-only
12544 Generate code for the SH4 with a floating-point unit that only
12545 supports single-precision arithmetic.
12546
12547 @item -m4-single
12548 @opindex m4-single
12549 Generate code for the SH4 assuming the floating-point unit is in
12550 single-precision mode by default.
12551
12552 @item -m4
12553 @opindex m4
12554 Generate code for the SH4.
12555
12556 @item -m4a-nofpu
12557 @opindex m4a-nofpu
12558 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
12559 floating-point unit is not used.
12560
12561 @item -m4a-single-only
12562 @opindex m4a-single-only
12563 Generate code for the SH4a, in such a way that no double-precision
12564 floating point operations are used.
12565
12566 @item -m4a-single
12567 @opindex m4a-single
12568 Generate code for the SH4a assuming the floating-point unit is in
12569 single-precision mode by default.
12570
12571 @item -m4a
12572 @opindex m4a
12573 Generate code for the SH4a.
12574
12575 @item -m4al
12576 @opindex m4al
12577 Same as @option{-m4a-nofpu}, except that it implicitly passes
12578 @option{-dsp} to the assembler. GCC doesn't generate any DSP
12579 instructions at the moment.
12580
12581 @item -mb
12582 @opindex mb
12583 Compile code for the processor in big endian mode.
12584
12585 @item -ml
12586 @opindex ml
12587 Compile code for the processor in little endian mode.
12588
12589 @item -mdalign
12590 @opindex mdalign
12591 Align doubles at 64-bit boundaries. Note that this changes the calling
12592 conventions, and thus some functions from the standard C library will
12593 not work unless you recompile it first with @option{-mdalign}.
12594
12595 @item -mrelax
12596 @opindex mrelax
12597 Shorten some address references at link time, when possible; uses the
12598 linker option @option{-relax}.
12599
12600 @item -mbigtable
12601 @opindex mbigtable
12602 Use 32-bit offsets in @code{switch} tables. The default is to use
12603 16-bit offsets.
12604
12605 @item -mfmovd
12606 @opindex mfmovd
12607 Enable the use of the instruction @code{fmovd}.
12608
12609 @item -mhitachi
12610 @opindex mhitachi
12611 Comply with the calling conventions defined by Renesas.
12612
12613 @item -mrenesas
12614 @opindex mhitachi
12615 Comply with the calling conventions defined by Renesas.
12616
12617 @item -mno-renesas
12618 @opindex mhitachi
12619 Comply with the calling conventions defined for GCC before the Renesas
12620 conventions were available. This option is the default for all
12621 targets of the SH toolchain except for @samp{sh-symbianelf}.
12622
12623 @item -mnomacsave
12624 @opindex mnomacsave
12625 Mark the @code{MAC} register as call-clobbered, even if
12626 @option{-mhitachi} is given.
12627
12628 @item -mieee
12629 @opindex mieee
12630 Increase IEEE-compliance of floating-point code.
12631 At the moment, this is equivalent to @option{-fno-finite-math-only}.
12632 When generating 16 bit SH opcodes, getting IEEE-conforming results for
12633 comparisons of NANs / infinities incurs extra overhead in every
12634 floating point comparison, therefore the default is set to
12635 @option{-ffinite-math-only}.
12636
12637 @item -minline-ic_invalidate
12638 @opindex minline-ic_invalidate
12639 Inline code to invalidate instruction cache entries after setting up
12640 nested function trampolines.
12641 This option has no effect if -musermode is in effect and the selected
12642 code generation option (e.g. -m4) does not allow the use of the icbi
12643 instruction.
12644 If the selected code generation option does not allow the use of the icbi
12645 instruction, and -musermode is not in effect, the inlined code will
12646 manipulate the instruction cache address array directly with an associative
12647 write. This not only requires privileged mode, but it will also
12648 fail if the cache line had been mapped via the TLB and has become unmapped.
12649
12650 @item -misize
12651 @opindex misize
12652 Dump instruction size and location in the assembly code.
12653
12654 @item -mpadstruct
12655 @opindex mpadstruct
12656 This option is deprecated. It pads structures to multiple of 4 bytes,
12657 which is incompatible with the SH ABI@.
12658
12659 @item -mspace
12660 @opindex mspace
12661 Optimize for space instead of speed. Implied by @option{-Os}.
12662
12663 @item -mprefergot
12664 @opindex mprefergot
12665 When generating position-independent code, emit function calls using
12666 the Global Offset Table instead of the Procedure Linkage Table.
12667
12668 @item -musermode
12669 @opindex musermode
12670 Don't generate privileged mode only code; implies -mno-inline-ic_invalidate
12671 if the inlined code would not work in user mode.
12672 This is the default when the target is @code{sh-*-linux*}.
12673
12674 @item -multcost=@var{number}
12675 @opindex multcost=@var{number}
12676 Set the cost to assume for a multiply insn.
12677
12678 @item -mdiv=@var{strategy}
12679 @opindex mdiv=@var{strategy}
12680 Set the division strategy to use for SHmedia code. @var{strategy} must be
12681 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
12682 inv:call2, inv:fp .
12683 "fp" performs the operation in floating point. This has a very high latency,
12684 but needs only a few instructions, so it might be a good choice if
12685 your code has enough easily exploitable ILP to allow the compiler to
12686 schedule the floating point instructions together with other instructions.
12687 Division by zero causes a floating point exception.
12688 "inv" uses integer operations to calculate the inverse of the divisor,
12689 and then multiplies the dividend with the inverse. This strategy allows
12690 cse and hoisting of the inverse calculation. Division by zero calculates
12691 an unspecified result, but does not trap.
12692 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
12693 have been found, or if the entire operation has been hoisted to the same
12694 place, the last stages of the inverse calculation are intertwined with the
12695 final multiply to reduce the overall latency, at the expense of using a few
12696 more instructions, and thus offering fewer scheduling opportunities with
12697 other code.
12698 "call" calls a library function that usually implements the inv:minlat
12699 strategy.
12700 This gives high code density for m5-*media-nofpu compilations.
12701 "call2" uses a different entry point of the same library function, where it
12702 assumes that a pointer to a lookup table has already been set up, which
12703 exposes the pointer load to cse / code hoisting optimizations.
12704 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
12705 code generation, but if the code stays unoptimized, revert to the "call",
12706 "call2", or "fp" strategies, respectively. Note that the
12707 potentially-trapping side effect of division by zero is carried by a
12708 separate instruction, so it is possible that all the integer instructions
12709 are hoisted out, but the marker for the side effect stays where it is.
12710 A recombination to fp operations or a call is not possible in that case.
12711 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
12712 that the inverse calculation was nor separated from the multiply, they speed
12713 up division where the dividend fits into 20 bits (plus sign where applicable),
12714 by inserting a test to skip a number of operations in this case; this test
12715 slows down the case of larger dividends. inv20u assumes the case of a such
12716 a small dividend to be unlikely, and inv20l assumes it to be likely.
12717
12718 @item -mdivsi3_libfunc=@var{name}
12719 @opindex mdivsi3_libfunc=@var{name}
12720 Set the name of the library function used for 32 bit signed division to
12721 @var{name}. This only affect the name used in the call and inv:call
12722 division strategies, and the compiler will still expect the same
12723 sets of input/output/clobbered registers as if this option was not present.
12724
12725 @item -madjust-unroll
12726 @opindex madjust-unroll
12727 Throttle unrolling to avoid thrashing target registers.
12728 This option only has an effect if the gcc code base supports the
12729 TARGET_ADJUST_UNROLL_MAX target hook.
12730
12731 @item -mindexed-addressing
12732 @opindex mindexed-addressing
12733 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
12734 This is only safe if the hardware and/or OS implement 32 bit wrap-around
12735 semantics for the indexed addressing mode. The architecture allows the
12736 implementation of processors with 64 bit MMU, which the OS could use to
12737 get 32 bit addressing, but since no current hardware implementation supports
12738 this or any other way to make the indexed addressing mode safe to use in
12739 the 32 bit ABI, the default is -mno-indexed-addressing.
12740
12741 @item -mgettrcost=@var{number}
12742 @opindex mgettrcost=@var{number}
12743 Set the cost assumed for the gettr instruction to @var{number}.
12744 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
12745
12746 @item -mpt-fixed
12747 @opindex mpt-fixed
12748 Assume pt* instructions won't trap. This will generally generate better
12749 scheduled code, but is unsafe on current hardware. The current architecture
12750 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
12751 This has the unintentional effect of making it unsafe to schedule ptabs /
12752 ptrel before a branch, or hoist it out of a loop. For example,
12753 __do_global_ctors, a part of libgcc that runs constructors at program
12754 startup, calls functions in a list which is delimited by -1. With the
12755 -mpt-fixed option, the ptabs will be done before testing against -1.
12756 That means that all the constructors will be run a bit quicker, but when
12757 the loop comes to the end of the list, the program crashes because ptabs
12758 loads -1 into a target register. Since this option is unsafe for any
12759 hardware implementing the current architecture specification, the default
12760 is -mno-pt-fixed. Unless the user specifies a specific cost with
12761 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
12762 this deters register allocation using target registers for storing
12763 ordinary integers.
12764
12765 @item -minvalid-symbols
12766 @opindex minvalid-symbols
12767 Assume symbols might be invalid. Ordinary function symbols generated by
12768 the compiler will always be valid to load with movi/shori/ptabs or
12769 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
12770 to generate symbols that will cause ptabs / ptrel to trap.
12771 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
12772 It will then prevent cross-basic-block cse, hoisting and most scheduling
12773 of symbol loads. The default is @option{-mno-invalid-symbols}.
12774 @end table
12775
12776 @node SPARC Options
12777 @subsection SPARC Options
12778 @cindex SPARC options
12779
12780 These @samp{-m} options are supported on the SPARC:
12781
12782 @table @gcctabopt
12783 @item -mno-app-regs
12784 @itemx -mapp-regs
12785 @opindex mno-app-regs
12786 @opindex mapp-regs
12787 Specify @option{-mapp-regs} to generate output using the global registers
12788 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
12789 is the default.
12790
12791 To be fully SVR4 ABI compliant at the cost of some performance loss,
12792 specify @option{-mno-app-regs}. You should compile libraries and system
12793 software with this option.
12794
12795 @item -mfpu
12796 @itemx -mhard-float
12797 @opindex mfpu
12798 @opindex mhard-float
12799 Generate output containing floating point instructions. This is the
12800 default.
12801
12802 @item -mno-fpu
12803 @itemx -msoft-float
12804 @opindex mno-fpu
12805 @opindex msoft-float
12806 Generate output containing library calls for floating point.
12807 @strong{Warning:} the requisite libraries are not available for all SPARC
12808 targets. Normally the facilities of the machine's usual C compiler are
12809 used, but this cannot be done directly in cross-compilation. You must make
12810 your own arrangements to provide suitable library functions for
12811 cross-compilation. The embedded targets @samp{sparc-*-aout} and
12812 @samp{sparclite-*-*} do provide software floating point support.
12813
12814 @option{-msoft-float} changes the calling convention in the output file;
12815 therefore, it is only useful if you compile @emph{all} of a program with
12816 this option. In particular, you need to compile @file{libgcc.a}, the
12817 library that comes with GCC, with @option{-msoft-float} in order for
12818 this to work.
12819
12820 @item -mhard-quad-float
12821 @opindex mhard-quad-float
12822 Generate output containing quad-word (long double) floating point
12823 instructions.
12824
12825 @item -msoft-quad-float
12826 @opindex msoft-quad-float
12827 Generate output containing library calls for quad-word (long double)
12828 floating point instructions. The functions called are those specified
12829 in the SPARC ABI@. This is the default.
12830
12831 As of this writing, there are no SPARC implementations that have hardware
12832 support for the quad-word floating point instructions. They all invoke
12833 a trap handler for one of these instructions, and then the trap handler
12834 emulates the effect of the instruction. Because of the trap handler overhead,
12835 this is much slower than calling the ABI library routines. Thus the
12836 @option{-msoft-quad-float} option is the default.
12837
12838 @item -mno-unaligned-doubles
12839 @itemx -munaligned-doubles
12840 @opindex mno-unaligned-doubles
12841 @opindex munaligned-doubles
12842 Assume that doubles have 8 byte alignment. This is the default.
12843
12844 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
12845 alignment only if they are contained in another type, or if they have an
12846 absolute address. Otherwise, it assumes they have 4 byte alignment.
12847 Specifying this option avoids some rare compatibility problems with code
12848 generated by other compilers. It is not the default because it results
12849 in a performance loss, especially for floating point code.
12850
12851 @item -mno-faster-structs
12852 @itemx -mfaster-structs
12853 @opindex mno-faster-structs
12854 @opindex mfaster-structs
12855 With @option{-mfaster-structs}, the compiler assumes that structures
12856 should have 8 byte alignment. This enables the use of pairs of
12857 @code{ldd} and @code{std} instructions for copies in structure
12858 assignment, in place of twice as many @code{ld} and @code{st} pairs.
12859 However, the use of this changed alignment directly violates the SPARC
12860 ABI@. Thus, it's intended only for use on targets where the developer
12861 acknowledges that their resulting code will not be directly in line with
12862 the rules of the ABI@.
12863
12864 @item -mimpure-text
12865 @opindex mimpure-text
12866 @option{-mimpure-text}, used in addition to @option{-shared}, tells
12867 the compiler to not pass @option{-z text} to the linker when linking a
12868 shared object. Using this option, you can link position-dependent
12869 code into a shared object.
12870
12871 @option{-mimpure-text} suppresses the ``relocations remain against
12872 allocatable but non-writable sections'' linker error message.
12873 However, the necessary relocations will trigger copy-on-write, and the
12874 shared object is not actually shared across processes. Instead of
12875 using @option{-mimpure-text}, you should compile all source code with
12876 @option{-fpic} or @option{-fPIC}.
12877
12878 This option is only available on SunOS and Solaris.
12879
12880 @item -mcpu=@var{cpu_type}
12881 @opindex mcpu
12882 Set the instruction set, register set, and instruction scheduling parameters
12883 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
12884 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
12885 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
12886 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc},
12887 @samp{ultrasparc3}, and @samp{niagara}.
12888
12889 Default instruction scheduling parameters are used for values that select
12890 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
12891 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
12892
12893 Here is a list of each supported architecture and their supported
12894 implementations.
12895
12896 @smallexample
12897 v7: cypress
12898 v8: supersparc, hypersparc
12899 sparclite: f930, f934, sparclite86x
12900 sparclet: tsc701
12901 v9: ultrasparc, ultrasparc3, niagara
12902 @end smallexample
12903
12904 By default (unless configured otherwise), GCC generates code for the V7
12905 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
12906 additionally optimizes it for the Cypress CY7C602 chip, as used in the
12907 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
12908 SPARCStation 1, 2, IPX etc.
12909
12910 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
12911 architecture. The only difference from V7 code is that the compiler emits
12912 the integer multiply and integer divide instructions which exist in SPARC-V8
12913 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
12914 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
12915 2000 series.
12916
12917 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
12918 the SPARC architecture. This adds the integer multiply, integer divide step
12919 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
12920 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
12921 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
12922 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
12923 MB86934 chip, which is the more recent SPARClite with FPU@.
12924
12925 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
12926 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
12927 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
12928 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
12929 optimizes it for the TEMIC SPARClet chip.
12930
12931 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
12932 architecture. This adds 64-bit integer and floating-point move instructions,
12933 3 additional floating-point condition code registers and conditional move
12934 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
12935 optimizes it for the Sun UltraSPARC I/II/IIi chips. With
12936 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
12937 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips. With
12938 @option{-mcpu=niagara}, the compiler additionally optimizes it for
12939 Sun UltraSPARC T1 chips.
12940
12941 @item -mtune=@var{cpu_type}
12942 @opindex mtune
12943 Set the instruction scheduling parameters for machine type
12944 @var{cpu_type}, but do not set the instruction set or register set that the
12945 option @option{-mcpu=@var{cpu_type}} would.
12946
12947 The same values for @option{-mcpu=@var{cpu_type}} can be used for
12948 @option{-mtune=@var{cpu_type}}, but the only useful values are those
12949 that select a particular cpu implementation. Those are @samp{cypress},
12950 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
12951 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
12952 @samp{ultrasparc3}, and @samp{niagara}.
12953
12954 @item -mv8plus
12955 @itemx -mno-v8plus
12956 @opindex mv8plus
12957 @opindex mno-v8plus
12958 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
12959 difference from the V8 ABI is that the global and out registers are
12960 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
12961 mode for all SPARC-V9 processors.
12962
12963 @item -mvis
12964 @itemx -mno-vis
12965 @opindex mvis
12966 @opindex mno-vis
12967 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
12968 Visual Instruction Set extensions. The default is @option{-mno-vis}.
12969 @end table
12970
12971 These @samp{-m} options are supported in addition to the above
12972 on SPARC-V9 processors in 64-bit environments:
12973
12974 @table @gcctabopt
12975 @item -mlittle-endian
12976 @opindex mlittle-endian
12977 Generate code for a processor running in little-endian mode. It is only
12978 available for a few configurations and most notably not on Solaris and Linux.
12979
12980 @item -m32
12981 @itemx -m64
12982 @opindex m32
12983 @opindex m64
12984 Generate code for a 32-bit or 64-bit environment.
12985 The 32-bit environment sets int, long and pointer to 32 bits.
12986 The 64-bit environment sets int to 32 bits and long and pointer
12987 to 64 bits.
12988
12989 @item -mcmodel=medlow
12990 @opindex mcmodel=medlow
12991 Generate code for the Medium/Low code model: 64-bit addresses, programs
12992 must be linked in the low 32 bits of memory. Programs can be statically
12993 or dynamically linked.
12994
12995 @item -mcmodel=medmid
12996 @opindex mcmodel=medmid
12997 Generate code for the Medium/Middle code model: 64-bit addresses, programs
12998 must be linked in the low 44 bits of memory, the text and data segments must
12999 be less than 2GB in size and the data segment must be located within 2GB of
13000 the text segment.
13001
13002 @item -mcmodel=medany
13003 @opindex mcmodel=medany
13004 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
13005 may be linked anywhere in memory, the text and data segments must be less
13006 than 2GB in size and the data segment must be located within 2GB of the
13007 text segment.
13008
13009 @item -mcmodel=embmedany
13010 @opindex mcmodel=embmedany
13011 Generate code for the Medium/Anywhere code model for embedded systems:
13012 64-bit addresses, the text and data segments must be less than 2GB in
13013 size, both starting anywhere in memory (determined at link time). The
13014 global register %g4 points to the base of the data segment. Programs
13015 are statically linked and PIC is not supported.
13016
13017 @item -mstack-bias
13018 @itemx -mno-stack-bias
13019 @opindex mstack-bias
13020 @opindex mno-stack-bias
13021 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
13022 frame pointer if present, are offset by @minus{}2047 which must be added back
13023 when making stack frame references. This is the default in 64-bit mode.
13024 Otherwise, assume no such offset is present.
13025 @end table
13026
13027 These switches are supported in addition to the above on Solaris:
13028
13029 @table @gcctabopt
13030 @item -threads
13031 @opindex threads
13032 Add support for multithreading using the Solaris threads library. This
13033 option sets flags for both the preprocessor and linker. This option does
13034 not affect the thread safety of object code produced by the compiler or
13035 that of libraries supplied with it.
13036
13037 @item -pthreads
13038 @opindex pthreads
13039 Add support for multithreading using the POSIX threads library. This
13040 option sets flags for both the preprocessor and linker. This option does
13041 not affect the thread safety of object code produced by the compiler or
13042 that of libraries supplied with it.
13043
13044 @item -pthread
13045 @opindex pthread
13046 This is a synonym for @option{-pthreads}.
13047 @end table
13048
13049 @node SPU Options
13050 @subsection SPU Options
13051 @cindex SPU options
13052
13053 These @samp{-m} options are supported on the SPU:
13054
13055 @table @gcctabopt
13056 @item -mwarn-reloc
13057 @itemx -merror-reloc
13058 @opindex mwarn-reloc
13059 @opindex merror-reloc
13060
13061 The loader for SPU does not handle dynamic relocations. By default, GCC
13062 will give an error when it generates code that requires a dynamic
13063 relocation. @option{-mno-error-reloc} disables the error,
13064 @option{-mwarn-reloc} will generate a warning instead.
13065
13066 @item -msafe-dma
13067 @itemx -munsafe-dma
13068 @opindex msafe-dma
13069 @opindex munsafe-dma
13070
13071 Instructions which initiate or test completion of DMA must not be
13072 reordered with respect to loads and stores of the memory which is being
13073 accessed. Users typically address this problem using the volatile
13074 keyword, but that can lead to inefficient code in places where the
13075 memory is known to not change. Rather than mark the memory as volatile
13076 we treat the DMA instructions as potentially effecting all memory. With
13077 @option{-munsafe-dma} users must use the volatile keyword to protect
13078 memory accesses.
13079
13080 @item -mbranch-hints
13081 @opindex mbranch-hints
13082
13083 By default, GCC will generate a branch hint instruction to avoid
13084 pipeline stalls for always taken or probably taken branches. A hint
13085 will not be generated closer than 8 instructions away from its branch.
13086 There is little reason to disable them, except for debugging purposes,
13087 or to make an object a little bit smaller.
13088
13089 @item -msmall-mem
13090 @itemx -mlarge-mem
13091 @opindex msmall-mem
13092 @opindex mlarge-mem
13093
13094 By default, GCC generates code assuming that addresses are never larger
13095 than 18 bits. With @option{-mlarge-mem} code is generated that assumes
13096 a full 32 bit address.
13097
13098 @item -mstdmain
13099 @opindex mstdmain
13100
13101 By default, GCC links against startup code that assumes the SPU-style
13102 main function interface (which has an unconventional parameter list).
13103 With @option{-mstdmain}, GCC will link your program against startup
13104 code that assumes a C99-style interface to @code{main}, including a
13105 local copy of @code{argv} strings.
13106
13107 @item -mfixed-range=@var{register-range}
13108 @opindex mfixed-range
13109 Generate code treating the given register range as fixed registers.
13110 A fixed register is one that the register allocator can not use. This is
13111 useful when compiling kernel code. A register range is specified as
13112 two registers separated by a dash. Multiple register ranges can be
13113 specified separated by a comma.
13114
13115 @end table
13116
13117 @node System V Options
13118 @subsection Options for System V
13119
13120 These additional options are available on System V Release 4 for
13121 compatibility with other compilers on those systems:
13122
13123 @table @gcctabopt
13124 @item -G
13125 @opindex G
13126 Create a shared object.
13127 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
13128
13129 @item -Qy
13130 @opindex Qy
13131 Identify the versions of each tool used by the compiler, in a
13132 @code{.ident} assembler directive in the output.
13133
13134 @item -Qn
13135 @opindex Qn
13136 Refrain from adding @code{.ident} directives to the output file (this is
13137 the default).
13138
13139 @item -YP,@var{dirs}
13140 @opindex YP
13141 Search the directories @var{dirs}, and no others, for libraries
13142 specified with @option{-l}.
13143
13144 @item -Ym,@var{dir}
13145 @opindex Ym
13146 Look in the directory @var{dir} to find the M4 preprocessor.
13147 The assembler uses this option.
13148 @c This is supposed to go with a -Yd for predefined M4 macro files, but
13149 @c the generic assembler that comes with Solaris takes just -Ym.
13150 @end table
13151
13152 @node TMS320C3x/C4x Options
13153 @subsection TMS320C3x/C4x Options
13154 @cindex TMS320C3x/C4x Options
13155
13156 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
13157
13158 @table @gcctabopt
13159
13160 @item -mcpu=@var{cpu_type}
13161 @opindex mcpu
13162 Set the instruction set, register set, and instruction scheduling
13163 parameters for machine type @var{cpu_type}. Supported values for
13164 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
13165 @samp{c44}. The default is @samp{c40} to generate code for the
13166 TMS320C40.
13167
13168 @item -mbig-memory
13169 @itemx -mbig
13170 @itemx -msmall-memory
13171 @itemx -msmall
13172 @opindex mbig-memory
13173 @opindex mbig
13174 @opindex msmall-memory
13175 @opindex msmall
13176 Generates code for the big or small memory model. The small memory
13177 model assumed that all data fits into one 64K word page. At run-time
13178 the data page (DP) register must be set to point to the 64K page
13179 containing the .bss and .data program sections. The big memory model is
13180 the default and requires reloading of the DP register for every direct
13181 memory access.
13182
13183 @item -mbk
13184 @itemx -mno-bk
13185 @opindex mbk
13186 @opindex mno-bk
13187 Allow (disallow) allocation of general integer operands into the block
13188 count register BK@.
13189
13190 @item -mdb
13191 @itemx -mno-db
13192 @opindex mdb
13193 @opindex mno-db
13194 Enable (disable) generation of code using decrement and branch,
13195 DBcond(D), instructions. This is enabled by default for the C4x. To be
13196 on the safe side, this is disabled for the C3x, since the maximum
13197 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
13198 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
13199 that it can utilize the decrement and branch instruction, but will give
13200 up if there is more than one memory reference in the loop. Thus a loop
13201 where the loop counter is decremented can generate slightly more
13202 efficient code, in cases where the RPTB instruction cannot be utilized.
13203
13204 @item -mdp-isr-reload
13205 @itemx -mparanoid
13206 @opindex mdp-isr-reload
13207 @opindex mparanoid
13208 Force the DP register to be saved on entry to an interrupt service
13209 routine (ISR), reloaded to point to the data section, and restored on
13210 exit from the ISR@. This should not be required unless someone has
13211 violated the small memory model by modifying the DP register, say within
13212 an object library.
13213
13214 @item -mmpyi
13215 @itemx -mno-mpyi
13216 @opindex mmpyi
13217 @opindex mno-mpyi
13218 For the C3x use the 24-bit MPYI instruction for integer multiplies
13219 instead of a library call to guarantee 32-bit results. Note that if one
13220 of the operands is a constant, then the multiplication will be performed
13221 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
13222 then squaring operations are performed inline instead of a library call.
13223
13224 @item -mfast-fix
13225 @itemx -mno-fast-fix
13226 @opindex mfast-fix
13227 @opindex mno-fast-fix
13228 The C3x/C4x FIX instruction to convert a floating point value to an
13229 integer value chooses the nearest integer less than or equal to the
13230 floating point value rather than to the nearest integer. Thus if the
13231 floating point number is negative, the result will be incorrectly
13232 truncated an additional code is necessary to detect and correct this
13233 case. This option can be used to disable generation of the additional
13234 code required to correct the result.
13235
13236 @item -mrptb
13237 @itemx -mno-rptb
13238 @opindex mrptb
13239 @opindex mno-rptb
13240 Enable (disable) generation of repeat block sequences using the RPTB
13241 instruction for zero overhead looping. The RPTB construct is only used
13242 for innermost loops that do not call functions or jump across the loop
13243 boundaries. There is no advantage having nested RPTB loops due to the
13244 overhead required to save and restore the RC, RS, and RE registers.
13245 This is enabled by default with @option{-O2}.
13246
13247 @item -mrpts=@var{count}
13248 @itemx -mno-rpts
13249 @opindex mrpts
13250 @opindex mno-rpts
13251 Enable (disable) the use of the single instruction repeat instruction
13252 RPTS@. If a repeat block contains a single instruction, and the loop
13253 count can be guaranteed to be less than the value @var{count}, GCC will
13254 emit a RPTS instruction instead of a RPTB@. If no value is specified,
13255 then a RPTS will be emitted even if the loop count cannot be determined
13256 at compile time. Note that the repeated instruction following RPTS does
13257 not have to be reloaded from memory each iteration, thus freeing up the
13258 CPU buses for operands. However, since interrupts are blocked by this
13259 instruction, it is disabled by default.
13260
13261 @item -mloop-unsigned
13262 @itemx -mno-loop-unsigned
13263 @opindex mloop-unsigned
13264 @opindex mno-loop-unsigned
13265 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
13266 is @math{2^{31} + 1} since these instructions test if the iteration count is
13267 negative to terminate the loop. If the iteration count is unsigned
13268 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
13269 exceeded. This switch allows an unsigned iteration count.
13270
13271 @item -mti
13272 @opindex mti
13273 Try to emit an assembler syntax that the TI assembler (asm30) is happy
13274 with. This also enforces compatibility with the API employed by the TI
13275 C3x C compiler. For example, long doubles are passed as structures
13276 rather than in floating point registers.
13277
13278 @item -mregparm
13279 @itemx -mmemparm
13280 @opindex mregparm
13281 @opindex mmemparm
13282 Generate code that uses registers (stack) for passing arguments to functions.
13283 By default, arguments are passed in registers where possible rather
13284 than by pushing arguments on to the stack.
13285
13286 @item -mparallel-insns
13287 @itemx -mno-parallel-insns
13288 @opindex mparallel-insns
13289 @opindex mno-parallel-insns
13290 Allow the generation of parallel instructions. This is enabled by
13291 default with @option{-O2}.
13292
13293 @item -mparallel-mpy
13294 @itemx -mno-parallel-mpy
13295 @opindex mparallel-mpy
13296 @opindex mno-parallel-mpy
13297 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
13298 provided @option{-mparallel-insns} is also specified. These instructions have
13299 tight register constraints which can pessimize the code generation
13300 of large functions.
13301
13302 @end table
13303
13304 @node V850 Options
13305 @subsection V850 Options
13306 @cindex V850 Options
13307
13308 These @samp{-m} options are defined for V850 implementations:
13309
13310 @table @gcctabopt
13311 @item -mlong-calls
13312 @itemx -mno-long-calls
13313 @opindex mlong-calls
13314 @opindex mno-long-calls
13315 Treat all calls as being far away (near). If calls are assumed to be
13316 far away, the compiler will always load the functions address up into a
13317 register, and call indirect through the pointer.
13318
13319 @item -mno-ep
13320 @itemx -mep
13321 @opindex mno-ep
13322 @opindex mep
13323 Do not optimize (do optimize) basic blocks that use the same index
13324 pointer 4 or more times to copy pointer into the @code{ep} register, and
13325 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
13326 option is on by default if you optimize.
13327
13328 @item -mno-prolog-function
13329 @itemx -mprolog-function
13330 @opindex mno-prolog-function
13331 @opindex mprolog-function
13332 Do not use (do use) external functions to save and restore registers
13333 at the prologue and epilogue of a function. The external functions
13334 are slower, but use less code space if more than one function saves
13335 the same number of registers. The @option{-mprolog-function} option
13336 is on by default if you optimize.
13337
13338 @item -mspace
13339 @opindex mspace
13340 Try to make the code as small as possible. At present, this just turns
13341 on the @option{-mep} and @option{-mprolog-function} options.
13342
13343 @item -mtda=@var{n}
13344 @opindex mtda
13345 Put static or global variables whose size is @var{n} bytes or less into
13346 the tiny data area that register @code{ep} points to. The tiny data
13347 area can hold up to 256 bytes in total (128 bytes for byte references).
13348
13349 @item -msda=@var{n}
13350 @opindex msda
13351 Put static or global variables whose size is @var{n} bytes or less into
13352 the small data area that register @code{gp} points to. The small data
13353 area can hold up to 64 kilobytes.
13354
13355 @item -mzda=@var{n}
13356 @opindex mzda
13357 Put static or global variables whose size is @var{n} bytes or less into
13358 the first 32 kilobytes of memory.
13359
13360 @item -mv850
13361 @opindex mv850
13362 Specify that the target processor is the V850.
13363
13364 @item -mbig-switch
13365 @opindex mbig-switch
13366 Generate code suitable for big switch tables. Use this option only if
13367 the assembler/linker complain about out of range branches within a switch
13368 table.
13369
13370 @item -mapp-regs
13371 @opindex mapp-regs
13372 This option will cause r2 and r5 to be used in the code generated by
13373 the compiler. This setting is the default.
13374
13375 @item -mno-app-regs
13376 @opindex mno-app-regs
13377 This option will cause r2 and r5 to be treated as fixed registers.
13378
13379 @item -mv850e1
13380 @opindex mv850e1
13381 Specify that the target processor is the V850E1. The preprocessor
13382 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
13383 this option is used.
13384
13385 @item -mv850e
13386 @opindex mv850e
13387 Specify that the target processor is the V850E@. The preprocessor
13388 constant @samp{__v850e__} will be defined if this option is used.
13389
13390 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
13391 are defined then a default target processor will be chosen and the
13392 relevant @samp{__v850*__} preprocessor constant will be defined.
13393
13394 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
13395 defined, regardless of which processor variant is the target.
13396
13397 @item -mdisable-callt
13398 @opindex mdisable-callt
13399 This option will suppress generation of the CALLT instruction for the
13400 v850e and v850e1 flavors of the v850 architecture. The default is
13401 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
13402
13403 @end table
13404
13405 @node VAX Options
13406 @subsection VAX Options
13407 @cindex VAX options
13408
13409 These @samp{-m} options are defined for the VAX:
13410
13411 @table @gcctabopt
13412 @item -munix
13413 @opindex munix
13414 Do not output certain jump instructions (@code{aobleq} and so on)
13415 that the Unix assembler for the VAX cannot handle across long
13416 ranges.
13417
13418 @item -mgnu
13419 @opindex mgnu
13420 Do output those jump instructions, on the assumption that you
13421 will assemble with the GNU assembler.
13422
13423 @item -mg
13424 @opindex mg
13425 Output code for g-format floating point numbers instead of d-format.
13426 @end table
13427
13428 @node x86-64 Options
13429 @subsection x86-64 Options
13430 @cindex x86-64 options
13431
13432 These are listed under @xref{i386 and x86-64 Options}.
13433
13434 @node Xstormy16 Options
13435 @subsection Xstormy16 Options
13436 @cindex Xstormy16 Options
13437
13438 These options are defined for Xstormy16:
13439
13440 @table @gcctabopt
13441 @item -msim
13442 @opindex msim
13443 Choose startup files and linker script suitable for the simulator.
13444 @end table
13445
13446 @node Xtensa Options
13447 @subsection Xtensa Options
13448 @cindex Xtensa Options
13449
13450 These options are supported for Xtensa targets:
13451
13452 @table @gcctabopt
13453 @item -mconst16
13454 @itemx -mno-const16
13455 @opindex mconst16
13456 @opindex mno-const16
13457 Enable or disable use of @code{CONST16} instructions for loading
13458 constant values. The @code{CONST16} instruction is currently not a
13459 standard option from Tensilica. When enabled, @code{CONST16}
13460 instructions are always used in place of the standard @code{L32R}
13461 instructions. The use of @code{CONST16} is enabled by default only if
13462 the @code{L32R} instruction is not available.
13463
13464 @item -mfused-madd
13465 @itemx -mno-fused-madd
13466 @opindex mfused-madd
13467 @opindex mno-fused-madd
13468 Enable or disable use of fused multiply/add and multiply/subtract
13469 instructions in the floating-point option. This has no effect if the
13470 floating-point option is not also enabled. Disabling fused multiply/add
13471 and multiply/subtract instructions forces the compiler to use separate
13472 instructions for the multiply and add/subtract operations. This may be
13473 desirable in some cases where strict IEEE 754-compliant results are
13474 required: the fused multiply add/subtract instructions do not round the
13475 intermediate result, thereby producing results with @emph{more} bits of
13476 precision than specified by the IEEE standard. Disabling fused multiply
13477 add/subtract instructions also ensures that the program output is not
13478 sensitive to the compiler's ability to combine multiply and add/subtract
13479 operations.
13480
13481 @item -mtext-section-literals
13482 @itemx -mno-text-section-literals
13483 @opindex mtext-section-literals
13484 @opindex mno-text-section-literals
13485 Control the treatment of literal pools. The default is
13486 @option{-mno-text-section-literals}, which places literals in a separate
13487 section in the output file. This allows the literal pool to be placed
13488 in a data RAM/ROM, and it also allows the linker to combine literal
13489 pools from separate object files to remove redundant literals and
13490 improve code size. With @option{-mtext-section-literals}, the literals
13491 are interspersed in the text section in order to keep them as close as
13492 possible to their references. This may be necessary for large assembly
13493 files.
13494
13495 @item -mtarget-align
13496 @itemx -mno-target-align
13497 @opindex mtarget-align
13498 @opindex mno-target-align
13499 When this option is enabled, GCC instructs the assembler to
13500 automatically align instructions to reduce branch penalties at the
13501 expense of some code density. The assembler attempts to widen density
13502 instructions to align branch targets and the instructions following call
13503 instructions. If there are not enough preceding safe density
13504 instructions to align a target, no widening will be performed. The
13505 default is @option{-mtarget-align}. These options do not affect the
13506 treatment of auto-aligned instructions like @code{LOOP}, which the
13507 assembler will always align, either by widening density instructions or
13508 by inserting no-op instructions.
13509
13510 @item -mlongcalls
13511 @itemx -mno-longcalls
13512 @opindex mlongcalls
13513 @opindex mno-longcalls
13514 When this option is enabled, GCC instructs the assembler to translate
13515 direct calls to indirect calls unless it can determine that the target
13516 of a direct call is in the range allowed by the call instruction. This
13517 translation typically occurs for calls to functions in other source
13518 files. Specifically, the assembler translates a direct @code{CALL}
13519 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
13520 The default is @option{-mno-longcalls}. This option should be used in
13521 programs where the call target can potentially be out of range. This
13522 option is implemented in the assembler, not the compiler, so the
13523 assembly code generated by GCC will still show direct call
13524 instructions---look at the disassembled object code to see the actual
13525 instructions. Note that the assembler will use an indirect call for
13526 every cross-file call, not just those that really will be out of range.
13527 @end table
13528
13529 @node zSeries Options
13530 @subsection zSeries Options
13531 @cindex zSeries options
13532
13533 These are listed under @xref{S/390 and zSeries Options}.
13534
13535 @node Code Gen Options
13536 @section Options for Code Generation Conventions
13537 @cindex code generation conventions
13538 @cindex options, code generation
13539 @cindex run-time options
13540
13541 These machine-independent options control the interface conventions
13542 used in code generation.
13543
13544 Most of them have both positive and negative forms; the negative form
13545 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
13546 one of the forms is listed---the one which is not the default. You
13547 can figure out the other form by either removing @samp{no-} or adding
13548 it.
13549
13550 @table @gcctabopt
13551 @item -fbounds-check
13552 @opindex fbounds-check
13553 For front-ends that support it, generate additional code to check that
13554 indices used to access arrays are within the declared range. This is
13555 currently only supported by the Java and Fortran front-ends, where
13556 this option defaults to true and false respectively.
13557
13558 @item -ftrapv
13559 @opindex ftrapv
13560 This option generates traps for signed overflow on addition, subtraction,
13561 multiplication operations.
13562
13563 @item -fwrapv
13564 @opindex fwrapv
13565 This option instructs the compiler to assume that signed arithmetic
13566 overflow of addition, subtraction and multiplication wraps around
13567 using twos-complement representation. This flag enables some optimizations
13568 and disables others. This option is enabled by default for the Java
13569 front-end, as required by the Java language specification.
13570
13571 @item -fexceptions
13572 @opindex fexceptions
13573 Enable exception handling. Generates extra code needed to propagate
13574 exceptions. For some targets, this implies GCC will generate frame
13575 unwind information for all functions, which can produce significant data
13576 size overhead, although it does not affect execution. If you do not
13577 specify this option, GCC will enable it by default for languages like
13578 C++ which normally require exception handling, and disable it for
13579 languages like C that do not normally require it. However, you may need
13580 to enable this option when compiling C code that needs to interoperate
13581 properly with exception handlers written in C++. You may also wish to
13582 disable this option if you are compiling older C++ programs that don't
13583 use exception handling.
13584
13585 @item -fnon-call-exceptions
13586 @opindex fnon-call-exceptions
13587 Generate code that allows trapping instructions to throw exceptions.
13588 Note that this requires platform-specific runtime support that does
13589 not exist everywhere. Moreover, it only allows @emph{trapping}
13590 instructions to throw exceptions, i.e.@: memory references or floating
13591 point instructions. It does not allow exceptions to be thrown from
13592 arbitrary signal handlers such as @code{SIGALRM}.
13593
13594 @item -funwind-tables
13595 @opindex funwind-tables
13596 Similar to @option{-fexceptions}, except that it will just generate any needed
13597 static data, but will not affect the generated code in any other way.
13598 You will normally not enable this option; instead, a language processor
13599 that needs this handling would enable it on your behalf.
13600
13601 @item -fasynchronous-unwind-tables
13602 @opindex fasynchronous-unwind-tables
13603 Generate unwind table in dwarf2 format, if supported by target machine. The
13604 table is exact at each instruction boundary, so it can be used for stack
13605 unwinding from asynchronous events (such as debugger or garbage collector).
13606
13607 @item -fpcc-struct-return
13608 @opindex fpcc-struct-return
13609 Return ``short'' @code{struct} and @code{union} values in memory like
13610 longer ones, rather than in registers. This convention is less
13611 efficient, but it has the advantage of allowing intercallability between
13612 GCC-compiled files and files compiled with other compilers, particularly
13613 the Portable C Compiler (pcc).
13614
13615 The precise convention for returning structures in memory depends
13616 on the target configuration macros.
13617
13618 Short structures and unions are those whose size and alignment match
13619 that of some integer type.
13620
13621 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
13622 switch is not binary compatible with code compiled with the
13623 @option{-freg-struct-return} switch.
13624 Use it to conform to a non-default application binary interface.
13625
13626 @item -freg-struct-return
13627 @opindex freg-struct-return
13628 Return @code{struct} and @code{union} values in registers when possible.
13629 This is more efficient for small structures than
13630 @option{-fpcc-struct-return}.
13631
13632 If you specify neither @option{-fpcc-struct-return} nor
13633 @option{-freg-struct-return}, GCC defaults to whichever convention is
13634 standard for the target. If there is no standard convention, GCC
13635 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
13636 the principal compiler. In those cases, we can choose the standard, and
13637 we chose the more efficient register return alternative.
13638
13639 @strong{Warning:} code compiled with the @option{-freg-struct-return}
13640 switch is not binary compatible with code compiled with the
13641 @option{-fpcc-struct-return} switch.
13642 Use it to conform to a non-default application binary interface.
13643
13644 @item -fshort-enums
13645 @opindex fshort-enums
13646 Allocate to an @code{enum} type only as many bytes as it needs for the
13647 declared range of possible values. Specifically, the @code{enum} type
13648 will be equivalent to the smallest integer type which has enough room.
13649
13650 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
13651 code that is not binary compatible with code generated without that switch.
13652 Use it to conform to a non-default application binary interface.
13653
13654 @item -fshort-double
13655 @opindex fshort-double
13656 Use the same size for @code{double} as for @code{float}.
13657
13658 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
13659 code that is not binary compatible with code generated without that switch.
13660 Use it to conform to a non-default application binary interface.
13661
13662 @item -fshort-wchar
13663 @opindex fshort-wchar
13664 Override the underlying type for @samp{wchar_t} to be @samp{short
13665 unsigned int} instead of the default for the target. This option is
13666 useful for building programs to run under WINE@.
13667
13668 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
13669 code that is not binary compatible with code generated without that switch.
13670 Use it to conform to a non-default application binary interface.
13671
13672 @item -fno-common
13673 @opindex fno-common
13674 In C, allocate even uninitialized global variables in the data section of the
13675 object file, rather than generating them as common blocks. This has the
13676 effect that if the same variable is declared (without @code{extern}) in
13677 two different compilations, you will get an error when you link them.
13678 The only reason this might be useful is if you wish to verify that the
13679 program will work on other systems which always work this way.
13680
13681 @item -fno-ident
13682 @opindex fno-ident
13683 Ignore the @samp{#ident} directive.
13684
13685 @item -finhibit-size-directive
13686 @opindex finhibit-size-directive
13687 Don't output a @code{.size} assembler directive, or anything else that
13688 would cause trouble if the function is split in the middle, and the
13689 two halves are placed at locations far apart in memory. This option is
13690 used when compiling @file{crtstuff.c}; you should not need to use it
13691 for anything else.
13692
13693 @item -fverbose-asm
13694 @opindex fverbose-asm
13695 Put extra commentary information in the generated assembly code to
13696 make it more readable. This option is generally only of use to those
13697 who actually need to read the generated assembly code (perhaps while
13698 debugging the compiler itself).
13699
13700 @option{-fno-verbose-asm}, the default, causes the
13701 extra information to be omitted and is useful when comparing two assembler
13702 files.
13703
13704 @item -frecord-gcc-switches
13705 @opindex frecord-gcc-switches
13706 This switch causes the command line that was used to invoke the
13707 compiler to be recorded into the object file that is being created.
13708 This switch is only implemented on some targets and the exact format
13709 of the recording is target and binary file format dependent, but it
13710 usually takes the form of a section containing ASCII text. This
13711 switch is related to the @option{-fverbose-asm} switch, but that
13712 switch only records information in the assembler output file as
13713 comments, so it never reaches the object file.
13714
13715 @item -fpic
13716 @opindex fpic
13717 @cindex global offset table
13718 @cindex PIC
13719 Generate position-independent code (PIC) suitable for use in a shared
13720 library, if supported for the target machine. Such code accesses all
13721 constant addresses through a global offset table (GOT)@. The dynamic
13722 loader resolves the GOT entries when the program starts (the dynamic
13723 loader is not part of GCC; it is part of the operating system). If
13724 the GOT size for the linked executable exceeds a machine-specific
13725 maximum size, you get an error message from the linker indicating that
13726 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
13727 instead. (These maximums are 8k on the SPARC and 32k
13728 on the m68k and RS/6000. The 386 has no such limit.)
13729
13730 Position-independent code requires special support, and therefore works
13731 only on certain machines. For the 386, GCC supports PIC for System V
13732 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
13733 position-independent.
13734
13735 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13736 are defined to 1.
13737
13738 @item -fPIC
13739 @opindex fPIC
13740 If supported for the target machine, emit position-independent code,
13741 suitable for dynamic linking and avoiding any limit on the size of the
13742 global offset table. This option makes a difference on the m68k,
13743 PowerPC and SPARC@.
13744
13745 Position-independent code requires special support, and therefore works
13746 only on certain machines.
13747
13748 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
13749 are defined to 2.
13750
13751 @item -fpie
13752 @itemx -fPIE
13753 @opindex fpie
13754 @opindex fPIE
13755 These options are similar to @option{-fpic} and @option{-fPIC}, but
13756 generated position independent code can be only linked into executables.
13757 Usually these options are used when @option{-pie} GCC option will be
13758 used during linking.
13759
13760 @item -fno-jump-tables
13761 @opindex fno-jump-tables
13762 Do not use jump tables for switch statements even where it would be
13763 more efficient than other code generation strategies. This option is
13764 of use in conjunction with @option{-fpic} or @option{-fPIC} for
13765 building code which forms part of a dynamic linker and cannot
13766 reference the address of a jump table. On some targets, jump tables
13767 do not require a GOT and this option is not needed.
13768
13769 @item -ffixed-@var{reg}
13770 @opindex ffixed
13771 Treat the register named @var{reg} as a fixed register; generated code
13772 should never refer to it (except perhaps as a stack pointer, frame
13773 pointer or in some other fixed role).
13774
13775 @var{reg} must be the name of a register. The register names accepted
13776 are machine-specific and are defined in the @code{REGISTER_NAMES}
13777 macro in the machine description macro file.
13778
13779 This flag does not have a negative form, because it specifies a
13780 three-way choice.
13781
13782 @item -fcall-used-@var{reg}
13783 @opindex fcall-used
13784 Treat the register named @var{reg} as an allocable register that is
13785 clobbered by function calls. It may be allocated for temporaries or
13786 variables that do not live across a call. Functions compiled this way
13787 will not save and restore the register @var{reg}.
13788
13789 It is an error to used this flag with the frame pointer or stack pointer.
13790 Use of this flag for other registers that have fixed pervasive roles in
13791 the machine's execution model will produce disastrous results.
13792
13793 This flag does not have a negative form, because it specifies a
13794 three-way choice.
13795
13796 @item -fcall-saved-@var{reg}
13797 @opindex fcall-saved
13798 Treat the register named @var{reg} as an allocable register saved by
13799 functions. It may be allocated even for temporaries or variables that
13800 live across a call. Functions compiled this way will save and restore
13801 the register @var{reg} if they use it.
13802
13803 It is an error to used this flag with the frame pointer or stack pointer.
13804 Use of this flag for other registers that have fixed pervasive roles in
13805 the machine's execution model will produce disastrous results.
13806
13807 A different sort of disaster will result from the use of this flag for
13808 a register in which function values may be returned.
13809
13810 This flag does not have a negative form, because it specifies a
13811 three-way choice.
13812
13813 @item -fpack-struct[=@var{n}]
13814 @opindex fpack-struct
13815 Without a value specified, pack all structure members together without
13816 holes. When a value is specified (which must be a small power of two), pack
13817 structure members according to this value, representing the maximum
13818 alignment (that is, objects with default alignment requirements larger than
13819 this will be output potentially unaligned at the next fitting location.
13820
13821 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
13822 code that is not binary compatible with code generated without that switch.
13823 Additionally, it makes the code suboptimal.
13824 Use it to conform to a non-default application binary interface.
13825
13826 @item -finstrument-functions
13827 @opindex finstrument-functions
13828 Generate instrumentation calls for entry and exit to functions. Just
13829 after function entry and just before function exit, the following
13830 profiling functions will be called with the address of the current
13831 function and its call site. (On some platforms,
13832 @code{__builtin_return_address} does not work beyond the current
13833 function, so the call site information may not be available to the
13834 profiling functions otherwise.)
13835
13836 @smallexample
13837 void __cyg_profile_func_enter (void *this_fn,
13838 void *call_site);
13839 void __cyg_profile_func_exit (void *this_fn,
13840 void *call_site);
13841 @end smallexample
13842
13843 The first argument is the address of the start of the current function,
13844 which may be looked up exactly in the symbol table.
13845
13846 This instrumentation is also done for functions expanded inline in other
13847 functions. The profiling calls will indicate where, conceptually, the
13848 inline function is entered and exited. This means that addressable
13849 versions of such functions must be available. If all your uses of a
13850 function are expanded inline, this may mean an additional expansion of
13851 code size. If you use @samp{extern inline} in your C code, an
13852 addressable version of such functions must be provided. (This is
13853 normally the case anyways, but if you get lucky and the optimizer always
13854 expands the functions inline, you might have gotten away without
13855 providing static copies.)
13856
13857 A function may be given the attribute @code{no_instrument_function}, in
13858 which case this instrumentation will not be done. This can be used, for
13859 example, for the profiling functions listed above, high-priority
13860 interrupt routines, and any functions from which the profiling functions
13861 cannot safely be called (perhaps signal handlers, if the profiling
13862 routines generate output or allocate memory).
13863
13864 @item -fstack-check
13865 @opindex fstack-check
13866 Generate code to verify that you do not go beyond the boundary of the
13867 stack. You should specify this flag if you are running in an
13868 environment with multiple threads, but only rarely need to specify it in
13869 a single-threaded environment since stack overflow is automatically
13870 detected on nearly all systems if there is only one stack.
13871
13872 Note that this switch does not actually cause checking to be done; the
13873 operating system must do that. The switch causes generation of code
13874 to ensure that the operating system sees the stack being extended.
13875
13876 @item -fstack-limit-register=@var{reg}
13877 @itemx -fstack-limit-symbol=@var{sym}
13878 @itemx -fno-stack-limit
13879 @opindex fstack-limit-register
13880 @opindex fstack-limit-symbol
13881 @opindex fno-stack-limit
13882 Generate code to ensure that the stack does not grow beyond a certain value,
13883 either the value of a register or the address of a symbol. If the stack
13884 would grow beyond the value, a signal is raised. For most targets,
13885 the signal is raised before the stack overruns the boundary, so
13886 it is possible to catch the signal without taking special precautions.
13887
13888 For instance, if the stack starts at absolute address @samp{0x80000000}
13889 and grows downwards, you can use the flags
13890 @option{-fstack-limit-symbol=__stack_limit} and
13891 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
13892 of 128KB@. Note that this may only work with the GNU linker.
13893
13894 @cindex aliasing of parameters
13895 @cindex parameters, aliased
13896 @item -fargument-alias
13897 @itemx -fargument-noalias
13898 @itemx -fargument-noalias-global
13899 @itemx -fargument-noalias-anything
13900 @opindex fargument-alias
13901 @opindex fargument-noalias
13902 @opindex fargument-noalias-global
13903 @opindex fargument-noalias-anything
13904 Specify the possible relationships among parameters and between
13905 parameters and global data.
13906
13907 @option{-fargument-alias} specifies that arguments (parameters) may
13908 alias each other and may alias global storage.@*
13909 @option{-fargument-noalias} specifies that arguments do not alias
13910 each other, but may alias global storage.@*
13911 @option{-fargument-noalias-global} specifies that arguments do not
13912 alias each other and do not alias global storage.
13913 @option{-fargument-noalias-anything} specifies that arguments do not
13914 alias any other storage.
13915
13916 Each language will automatically use whatever option is required by
13917 the language standard. You should not need to use these options yourself.
13918
13919 @item -fleading-underscore
13920 @opindex fleading-underscore
13921 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
13922 change the way C symbols are represented in the object file. One use
13923 is to help link with legacy assembly code.
13924
13925 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
13926 generate code that is not binary compatible with code generated without that
13927 switch. Use it to conform to a non-default application binary interface.
13928 Not all targets provide complete support for this switch.
13929
13930 @item -ftls-model=@var{model}
13931 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
13932 The @var{model} argument should be one of @code{global-dynamic},
13933 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
13934
13935 The default without @option{-fpic} is @code{initial-exec}; with
13936 @option{-fpic} the default is @code{global-dynamic}.
13937
13938 @item -fvisibility=@var{default|internal|hidden|protected}
13939 @opindex fvisibility
13940 Set the default ELF image symbol visibility to the specified option---all
13941 symbols will be marked with this unless overridden within the code.
13942 Using this feature can very substantially improve linking and
13943 load times of shared object libraries, produce more optimized
13944 code, provide near-perfect API export and prevent symbol clashes.
13945 It is @strong{strongly} recommended that you use this in any shared objects
13946 you distribute.
13947
13948 Despite the nomenclature, @code{default} always means public ie;
13949 available to be linked against from outside the shared object.
13950 @code{protected} and @code{internal} are pretty useless in real-world
13951 usage so the only other commonly used option will be @code{hidden}.
13952 The default if @option{-fvisibility} isn't specified is
13953 @code{default}, i.e., make every
13954 symbol public---this causes the same behavior as previous versions of
13955 GCC@.
13956
13957 A good explanation of the benefits offered by ensuring ELF
13958 symbols have the correct visibility is given by ``How To Write
13959 Shared Libraries'' by Ulrich Drepper (which can be found at
13960 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
13961 solution made possible by this option to marking things hidden when
13962 the default is public is to make the default hidden and mark things
13963 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
13964 and @code{__attribute__ ((visibility("default")))} instead of
13965 @code{__declspec(dllexport)} you get almost identical semantics with
13966 identical syntax. This is a great boon to those working with
13967 cross-platform projects.
13968
13969 For those adding visibility support to existing code, you may find
13970 @samp{#pragma GCC visibility} of use. This works by you enclosing
13971 the declarations you wish to set visibility for with (for example)
13972 @samp{#pragma GCC visibility push(hidden)} and
13973 @samp{#pragma GCC visibility pop}.
13974 Bear in mind that symbol visibility should be viewed @strong{as
13975 part of the API interface contract} and thus all new code should
13976 always specify visibility when it is not the default ie; declarations
13977 only for use within the local DSO should @strong{always} be marked explicitly
13978 as hidden as so to avoid PLT indirection overheads---making this
13979 abundantly clear also aids readability and self-documentation of the code.
13980 Note that due to ISO C++ specification requirements, operator new and
13981 operator delete must always be of default visibility.
13982
13983 Be aware that headers from outside your project, in particular system
13984 headers and headers from any other library you use, may not be
13985 expecting to be compiled with visibility other than the default. You
13986 may need to explicitly say @samp{#pragma GCC visibility push(default)}
13987 before including any such headers.
13988
13989 @samp{extern} declarations are not affected by @samp{-fvisibility}, so
13990 a lot of code can be recompiled with @samp{-fvisibility=hidden} with
13991 no modifications. However, this means that calls to @samp{extern}
13992 functions with no explicit visibility will use the PLT, so it is more
13993 effective to use @samp{__attribute ((visibility))} and/or
13994 @samp{#pragma GCC visibility} to tell the compiler which @samp{extern}
13995 declarations should be treated as hidden.
13996
13997 Note that @samp{-fvisibility} does affect C++ vague linkage
13998 entities. This means that, for instance, an exception class that will
13999 be thrown between DSOs must be explicitly marked with default
14000 visibility so that the @samp{type_info} nodes will be unified between
14001 the DSOs.
14002
14003 An overview of these techniques, their benefits and how to use them
14004 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
14005
14006 @end table
14007
14008 @c man end
14009
14010 @node Environment Variables
14011 @section Environment Variables Affecting GCC
14012 @cindex environment variables
14013
14014 @c man begin ENVIRONMENT
14015 This section describes several environment variables that affect how GCC
14016 operates. Some of them work by specifying directories or prefixes to use
14017 when searching for various kinds of files. Some are used to specify other
14018 aspects of the compilation environment.
14019
14020 Note that you can also specify places to search using options such as
14021 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
14022 take precedence over places specified using environment variables, which
14023 in turn take precedence over those specified by the configuration of GCC@.
14024 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
14025 GNU Compiler Collection (GCC) Internals}.
14026
14027 @table @env
14028 @item LANG
14029 @itemx LC_CTYPE
14030 @c @itemx LC_COLLATE
14031 @itemx LC_MESSAGES
14032 @c @itemx LC_MONETARY
14033 @c @itemx LC_NUMERIC
14034 @c @itemx LC_TIME
14035 @itemx LC_ALL
14036 @findex LANG
14037 @findex LC_CTYPE
14038 @c @findex LC_COLLATE
14039 @findex LC_MESSAGES
14040 @c @findex LC_MONETARY
14041 @c @findex LC_NUMERIC
14042 @c @findex LC_TIME
14043 @findex LC_ALL
14044 @cindex locale
14045 These environment variables control the way that GCC uses
14046 localization information that allow GCC to work with different
14047 national conventions. GCC inspects the locale categories
14048 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
14049 so. These locale categories can be set to any value supported by your
14050 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
14051 Kingdom encoded in UTF-8.
14052
14053 The @env{LC_CTYPE} environment variable specifies character
14054 classification. GCC uses it to determine the character boundaries in
14055 a string; this is needed for some multibyte encodings that contain quote
14056 and escape characters that would otherwise be interpreted as a string
14057 end or escape.
14058
14059 The @env{LC_MESSAGES} environment variable specifies the language to
14060 use in diagnostic messages.
14061
14062 If the @env{LC_ALL} environment variable is set, it overrides the value
14063 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
14064 and @env{LC_MESSAGES} default to the value of the @env{LANG}
14065 environment variable. If none of these variables are set, GCC
14066 defaults to traditional C English behavior.
14067
14068 @item TMPDIR
14069 @findex TMPDIR
14070 If @env{TMPDIR} is set, it specifies the directory to use for temporary
14071 files. GCC uses temporary files to hold the output of one stage of
14072 compilation which is to be used as input to the next stage: for example,
14073 the output of the preprocessor, which is the input to the compiler
14074 proper.
14075
14076 @item GCC_EXEC_PREFIX
14077 @findex GCC_EXEC_PREFIX
14078 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
14079 names of the subprograms executed by the compiler. No slash is added
14080 when this prefix is combined with the name of a subprogram, but you can
14081 specify a prefix that ends with a slash if you wish.
14082
14083 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
14084 an appropriate prefix to use based on the pathname it was invoked with.
14085
14086 If GCC cannot find the subprogram using the specified prefix, it
14087 tries looking in the usual places for the subprogram.
14088
14089 The default value of @env{GCC_EXEC_PREFIX} is
14090 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
14091 the installed compiler. In many cases @var{prefix} is the value
14092 of @code{prefix} when you ran the @file{configure} script.
14093
14094 Other prefixes specified with @option{-B} take precedence over this prefix.
14095
14096 This prefix is also used for finding files such as @file{crt0.o} that are
14097 used for linking.
14098
14099 In addition, the prefix is used in an unusual way in finding the
14100 directories to search for header files. For each of the standard
14101 directories whose name normally begins with @samp{/usr/local/lib/gcc}
14102 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
14103 replacing that beginning with the specified prefix to produce an
14104 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
14105 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
14106 These alternate directories are searched first; the standard directories
14107 come next. If a standard directory begins with the configured
14108 @var{prefix} then the value of @var{prefix} is replaced by
14109 @env{GCC_EXEC_PREFIX} when looking for header files.
14110
14111 @item COMPILER_PATH
14112 @findex COMPILER_PATH
14113 The value of @env{COMPILER_PATH} is a colon-separated list of
14114 directories, much like @env{PATH}. GCC tries the directories thus
14115 specified when searching for subprograms, if it can't find the
14116 subprograms using @env{GCC_EXEC_PREFIX}.
14117
14118 @item LIBRARY_PATH
14119 @findex LIBRARY_PATH
14120 The value of @env{LIBRARY_PATH} is a colon-separated list of
14121 directories, much like @env{PATH}. When configured as a native compiler,
14122 GCC tries the directories thus specified when searching for special
14123 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
14124 using GCC also uses these directories when searching for ordinary
14125 libraries for the @option{-l} option (but directories specified with
14126 @option{-L} come first).
14127
14128 @item LANG
14129 @findex LANG
14130 @cindex locale definition
14131 This variable is used to pass locale information to the compiler. One way in
14132 which this information is used is to determine the character set to be used
14133 when character literals, string literals and comments are parsed in C and C++.
14134 When the compiler is configured to allow multibyte characters,
14135 the following values for @env{LANG} are recognized:
14136
14137 @table @samp
14138 @item C-JIS
14139 Recognize JIS characters.
14140 @item C-SJIS
14141 Recognize SJIS characters.
14142 @item C-EUCJP
14143 Recognize EUCJP characters.
14144 @end table
14145
14146 If @env{LANG} is not defined, or if it has some other value, then the
14147 compiler will use mblen and mbtowc as defined by the default locale to
14148 recognize and translate multibyte characters.
14149 @end table
14150
14151 @noindent
14152 Some additional environments variables affect the behavior of the
14153 preprocessor.
14154
14155 @include cppenv.texi
14156
14157 @c man end
14158
14159 @node Precompiled Headers
14160 @section Using Precompiled Headers
14161 @cindex precompiled headers
14162 @cindex speed of compilation
14163
14164 Often large projects have many header files that are included in every
14165 source file. The time the compiler takes to process these header files
14166 over and over again can account for nearly all of the time required to
14167 build the project. To make builds faster, GCC allows users to
14168 `precompile' a header file; then, if builds can use the precompiled
14169 header file they will be much faster.
14170
14171 To create a precompiled header file, simply compile it as you would any
14172 other file, if necessary using the @option{-x} option to make the driver
14173 treat it as a C or C++ header file. You will probably want to use a
14174 tool like @command{make} to keep the precompiled header up-to-date when
14175 the headers it contains change.
14176
14177 A precompiled header file will be searched for when @code{#include} is
14178 seen in the compilation. As it searches for the included file
14179 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
14180 compiler looks for a precompiled header in each directory just before it
14181 looks for the include file in that directory. The name searched for is
14182 the name specified in the @code{#include} with @samp{.gch} appended. If
14183 the precompiled header file can't be used, it is ignored.
14184
14185 For instance, if you have @code{#include "all.h"}, and you have
14186 @file{all.h.gch} in the same directory as @file{all.h}, then the
14187 precompiled header file will be used if possible, and the original
14188 header will be used otherwise.
14189
14190 Alternatively, you might decide to put the precompiled header file in a
14191 directory and use @option{-I} to ensure that directory is searched
14192 before (or instead of) the directory containing the original header.
14193 Then, if you want to check that the precompiled header file is always
14194 used, you can put a file of the same name as the original header in this
14195 directory containing an @code{#error} command.
14196
14197 This also works with @option{-include}. So yet another way to use
14198 precompiled headers, good for projects not designed with precompiled
14199 header files in mind, is to simply take most of the header files used by
14200 a project, include them from another header file, precompile that header
14201 file, and @option{-include} the precompiled header. If the header files
14202 have guards against multiple inclusion, they will be skipped because
14203 they've already been included (in the precompiled header).
14204
14205 If you need to precompile the same header file for different
14206 languages, targets, or compiler options, you can instead make a
14207 @emph{directory} named like @file{all.h.gch}, and put each precompiled
14208 header in the directory, perhaps using @option{-o}. It doesn't matter
14209 what you call the files in the directory, every precompiled header in
14210 the directory will be considered. The first precompiled header
14211 encountered in the directory that is valid for this compilation will
14212 be used; they're searched in no particular order.
14213
14214 There are many other possibilities, limited only by your imagination,
14215 good sense, and the constraints of your build system.
14216
14217 A precompiled header file can be used only when these conditions apply:
14218
14219 @itemize
14220 @item
14221 Only one precompiled header can be used in a particular compilation.
14222
14223 @item
14224 A precompiled header can't be used once the first C token is seen. You
14225 can have preprocessor directives before a precompiled header; you can
14226 even include a precompiled header from inside another header, so long as
14227 there are no C tokens before the @code{#include}.
14228
14229 @item
14230 The precompiled header file must be produced for the same language as
14231 the current compilation. You can't use a C precompiled header for a C++
14232 compilation.
14233
14234 @item
14235 The precompiled header file must have been produced by the same compiler
14236 binary as the current compilation is using.
14237
14238 @item
14239 Any macros defined before the precompiled header is included must
14240 either be defined in the same way as when the precompiled header was
14241 generated, or must not affect the precompiled header, which usually
14242 means that they don't appear in the precompiled header at all.
14243
14244 The @option{-D} option is one way to define a macro before a
14245 precompiled header is included; using a @code{#define} can also do it.
14246 There are also some options that define macros implicitly, like
14247 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
14248 defined this way.
14249
14250 @item If debugging information is output when using the precompiled
14251 header, using @option{-g} or similar, the same kind of debugging information
14252 must have been output when building the precompiled header. However,
14253 a precompiled header built using @option{-g} can be used in a compilation
14254 when no debugging information is being output.
14255
14256 @item The same @option{-m} options must generally be used when building
14257 and using the precompiled header. @xref{Submodel Options},
14258 for any cases where this rule is relaxed.
14259
14260 @item Each of the following options must be the same when building and using
14261 the precompiled header:
14262
14263 @gccoptlist{-fexceptions -funit-at-a-time}
14264
14265 @item
14266 Some other command-line options starting with @option{-f},
14267 @option{-p}, or @option{-O} must be defined in the same way as when
14268 the precompiled header was generated. At present, it's not clear
14269 which options are safe to change and which are not; the safest choice
14270 is to use exactly the same options when generating and using the
14271 precompiled header. The following are known to be safe:
14272
14273 @gccoptlist{-fmessage-length= -fpreprocessed
14274 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
14275 -fsched-verbose=<number> -fschedule-insns -fvisibility=
14276 -pedantic-errors}
14277
14278 @end itemize
14279
14280 For all of these except the last, the compiler will automatically
14281 ignore the precompiled header if the conditions aren't met. If you
14282 find an option combination that doesn't work and doesn't cause the
14283 precompiled header to be ignored, please consider filing a bug report,
14284 see @ref{Bugs}.
14285
14286 If you do use differing options when generating and using the
14287 precompiled header, the actual behavior will be a mixture of the
14288 behavior for the options. For instance, if you use @option{-g} to
14289 generate the precompiled header but not when using it, you may or may
14290 not get debugging information for routines in the precompiled header.
14291
14292 @node Running Protoize
14293 @section Running Protoize
14294
14295 The program @code{protoize} is an optional part of GCC@. You can use
14296 it to add prototypes to a program, thus converting the program to ISO
14297 C in one respect. The companion program @code{unprotoize} does the
14298 reverse: it removes argument types from any prototypes that are found.
14299
14300 When you run these programs, you must specify a set of source files as
14301 command line arguments. The conversion programs start out by compiling
14302 these files to see what functions they define. The information gathered
14303 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
14304
14305 After scanning comes actual conversion. The specified files are all
14306 eligible to be converted; any files they include (whether sources or
14307 just headers) are eligible as well.
14308
14309 But not all the eligible files are converted. By default,
14310 @code{protoize} and @code{unprotoize} convert only source and header
14311 files in the current directory. You can specify additional directories
14312 whose files should be converted with the @option{-d @var{directory}}
14313 option. You can also specify particular files to exclude with the
14314 @option{-x @var{file}} option. A file is converted if it is eligible, its
14315 directory name matches one of the specified directory names, and its
14316 name within the directory has not been excluded.
14317
14318 Basic conversion with @code{protoize} consists of rewriting most
14319 function definitions and function declarations to specify the types of
14320 the arguments. The only ones not rewritten are those for varargs
14321 functions.
14322
14323 @code{protoize} optionally inserts prototype declarations at the
14324 beginning of the source file, to make them available for any calls that
14325 precede the function's definition. Or it can insert prototype
14326 declarations with block scope in the blocks where undeclared functions
14327 are called.
14328
14329 Basic conversion with @code{unprotoize} consists of rewriting most
14330 function declarations to remove any argument types, and rewriting
14331 function definitions to the old-style pre-ISO form.
14332
14333 Both conversion programs print a warning for any function declaration or
14334 definition that they can't convert. You can suppress these warnings
14335 with @option{-q}.
14336
14337 The output from @code{protoize} or @code{unprotoize} replaces the
14338 original source file. The original file is renamed to a name ending
14339 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
14340 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
14341 for DOS) file already exists, then the source file is simply discarded.
14342
14343 @code{protoize} and @code{unprotoize} both depend on GCC itself to
14344 scan the program and collect information about the functions it uses.
14345 So neither of these programs will work until GCC is installed.
14346
14347 Here is a table of the options you can use with @code{protoize} and
14348 @code{unprotoize}. Each option works with both programs unless
14349 otherwise stated.
14350
14351 @table @code
14352 @item -B @var{directory}
14353 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
14354 usual directory (normally @file{/usr/local/lib}). This file contains
14355 prototype information about standard system functions. This option
14356 applies only to @code{protoize}.
14357
14358 @item -c @var{compilation-options}
14359 Use @var{compilation-options} as the options when running @command{gcc} to
14360 produce the @samp{.X} files. The special option @option{-aux-info} is
14361 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
14362
14363 Note that the compilation options must be given as a single argument to
14364 @code{protoize} or @code{unprotoize}. If you want to specify several
14365 @command{gcc} options, you must quote the entire set of compilation options
14366 to make them a single word in the shell.
14367
14368 There are certain @command{gcc} arguments that you cannot use, because they
14369 would produce the wrong kind of output. These include @option{-g},
14370 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
14371 the @var{compilation-options}, they are ignored.
14372
14373 @item -C
14374 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
14375 systems) instead of @samp{.c}. This is convenient if you are converting
14376 a C program to C++. This option applies only to @code{protoize}.
14377
14378 @item -g
14379 Add explicit global declarations. This means inserting explicit
14380 declarations at the beginning of each source file for each function
14381 that is called in the file and was not declared. These declarations
14382 precede the first function definition that contains a call to an
14383 undeclared function. This option applies only to @code{protoize}.
14384
14385 @item -i @var{string}
14386 Indent old-style parameter declarations with the string @var{string}.
14387 This option applies only to @code{protoize}.
14388
14389 @code{unprotoize} converts prototyped function definitions to old-style
14390 function definitions, where the arguments are declared between the
14391 argument list and the initial @samp{@{}. By default, @code{unprotoize}
14392 uses five spaces as the indentation. If you want to indent with just
14393 one space instead, use @option{-i " "}.
14394
14395 @item -k
14396 Keep the @samp{.X} files. Normally, they are deleted after conversion
14397 is finished.
14398
14399 @item -l
14400 Add explicit local declarations. @code{protoize} with @option{-l} inserts
14401 a prototype declaration for each function in each block which calls the
14402 function without any declaration. This option applies only to
14403 @code{protoize}.
14404
14405 @item -n
14406 Make no real changes. This mode just prints information about the conversions
14407 that would have been done without @option{-n}.
14408
14409 @item -N
14410 Make no @samp{.save} files. The original files are simply deleted.
14411 Use this option with caution.
14412
14413 @item -p @var{program}
14414 Use the program @var{program} as the compiler. Normally, the name
14415 @file{gcc} is used.
14416
14417 @item -q
14418 Work quietly. Most warnings are suppressed.
14419
14420 @item -v
14421 Print the version number, just like @option{-v} for @command{gcc}.
14422 @end table
14423
14424 If you need special compiler options to compile one of your program's
14425 source files, then you should generate that file's @samp{.X} file
14426 specially, by running @command{gcc} on that source file with the
14427 appropriate options and the option @option{-aux-info}. Then run
14428 @code{protoize} on the entire set of files. @code{protoize} will use
14429 the existing @samp{.X} file because it is newer than the source file.
14430 For example:
14431
14432 @smallexample
14433 gcc -Dfoo=bar file1.c -aux-info file1.X
14434 protoize *.c
14435 @end smallexample
14436
14437 @noindent
14438 You need to include the special files along with the rest in the
14439 @code{protoize} command, even though their @samp{.X} files already
14440 exist, because otherwise they won't get converted.
14441
14442 @xref{Protoize Caveats}, for more information on how to use
14443 @code{protoize} successfully.