s390.c: (optimization_options): Enable TARGET_MVCLE at -Os.
[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 Free Software Foundation, Inc.
3 @c This is part of the GCC manual.
4 @c For copying conditions, see the file gcc.texi.
5
6 @ignore
7 @c man begin COPYRIGHT
8 Copyright @copyright{} 1988, 1989, 1992, 1993, 1994, 1995, 1996, 1997,
9 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
10
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.2 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being ``GNU General Public License'' and ``Funding
15 Free Software'', the Front-Cover texts being (a) (see below), and with
16 the Back-Cover Texts being (b) (see below). A copy of the license is
17 included in the gfdl(7) man page.
18
19 (a) The FSF's Front-Cover Text is:
20
21 A GNU Manual
22
23 (b) The FSF's Back-Cover Text is:
24
25 You have freedom to copy and modify this GNU Manual, like GNU
26 software. Copies published by the Free Software Foundation raise
27 funds for GNU development.
28 @c man end
29 @c Set file name and title for the man page.
30 @setfilename gcc
31 @settitle GNU project C and C++ compiler
32 @c man begin SYNOPSIS
33 gcc [@option{-c}|@option{-S}|@option{-E}] [@option{-std=}@var{standard}]
34 [@option{-g}] [@option{-pg}] [@option{-O}@var{level}]
35 [@option{-W}@var{warn}@dots{}] [@option{-pedantic}]
36 [@option{-I}@var{dir}@dots{}] [@option{-L}@var{dir}@dots{}]
37 [@option{-D}@var{macro}[=@var{defn}]@dots{}] [@option{-U}@var{macro}]
38 [@option{-f}@var{option}@dots{}] [@option{-m}@var{machine-option}@dots{}]
39 [@option{-o} @var{outfile}] @var{infile}@dots{}
40
41 Only the most useful options are listed here; see below for the
42 remainder. @samp{g++} accepts mostly the same options as @samp{gcc}.
43 @c man end
44 @c man begin SEEALSO
45 gpl(7), gfdl(7), fsf-funding(7),
46 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
47 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
48 @file{ld}, @file{binutils} and @file{gdb}.
49 @c man end
50 @c man begin BUGS
51 For instructions on reporting bugs, see
52 @w{@uref{http://gcc.gnu.org/bugs.html}}.
53 @c man end
54 @c man begin AUTHOR
55 See the Info entry for @command{gcc}, or
56 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
57 for contributors to GCC@.
58 @c man end
59 @end ignore
60
61 @node Invoking GCC
62 @chapter GCC Command Options
63 @cindex GCC command options
64 @cindex command options
65 @cindex options, GCC command
66
67 @c man begin DESCRIPTION
68 When you invoke GCC, it normally does preprocessing, compilation,
69 assembly and linking. The ``overall options'' allow you to stop this
70 process at an intermediate stage. For example, the @option{-c} option
71 says not to run the linker. Then the output consists of object files
72 output by the assembler.
73
74 Other options are passed on to one stage of processing. Some options
75 control the preprocessor and others the compiler itself. Yet other
76 options control the assembler and linker; most of these are not
77 documented here, since you rarely need to use any of them.
78
79 @cindex C compilation options
80 Most of the command line options that you can use with GCC are useful
81 for C programs; when an option is only useful with another language
82 (usually C++), the explanation says so explicitly. If the description
83 for a particular option does not mention a source language, you can use
84 that option with all supported languages.
85
86 @cindex C++ compilation options
87 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
88 options for compiling C++ programs.
89
90 @cindex grouping options
91 @cindex options, grouping
92 The @command{gcc} program accepts options and file names as operands. Many
93 options have multi-letter names; therefore multiple single-letter options
94 may @emph{not} be grouped: @option{-dr} is very different from @w{@samp{-d
95 -r}}.
96
97 @cindex order of options
98 @cindex options, order
99 You can mix options and other arguments. For the most part, the order
100 you use doesn't matter. Order does matter when you use several options
101 of the same kind; for example, if you specify @option{-L} more than once,
102 the directories are searched in the order specified.
103
104 Many options have long names starting with @samp{-f} or with
105 @samp{-W}---for example,
106 @option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}. This manual documents
109 only one of these two forms, whichever one is not the default.
110
111 @c man end
112
113 @xref{Option Index}, for an index to GCC's options.
114
115 @menu
116 * Option Summary:: Brief list of all options, without explanations.
117 * Overall Options:: Controlling the kind of output:
118 an executable, object files, assembler files,
119 or preprocessed source.
120 * Invoking G++:: Compiling C++ programs.
121 * C Dialect Options:: Controlling the variant of C language compiled.
122 * C++ Dialect Options:: Variations on C++.
123 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
124 and Objective-C++.
125 * Language Independent Options:: Controlling how diagnostics should be
126 formatted.
127 * Warning Options:: How picky should the compiler be?
128 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
129 * Optimize Options:: How much optimization?
130 * Preprocessor Options:: Controlling header files and macro definitions.
131 Also, getting dependency information for Make.
132 * Assembler Options:: Passing options to the assembler.
133 * Link Options:: Specifying libraries and so on.
134 * Directory Options:: Where to find header files and libraries.
135 Where to find the compiler executable files.
136 * Spec Files:: How to pass switches to sub-processes.
137 * Target Options:: Running a cross-compiler, or an old version of GCC.
138 * Submodel Options:: Specifying minor hardware or convention variations,
139 such as 68010 vs 68020.
140 * Code Gen Options:: Specifying conventions for function calls, data layout
141 and register usage.
142 * Environment Variables:: Env vars that affect GCC.
143 * Precompiled Headers:: Compiling a header once, and using it many times.
144 * Running Protoize:: Automatically adding or removing function prototypes.
145 @end menu
146
147 @c man begin OPTIONS
148
149 @node Option Summary
150 @section Option Summary
151
152 Here is a summary of all the options, grouped by type. Explanations are
153 in the following sections.
154
155 @table @emph
156 @item Overall Options
157 @xref{Overall Options,,Options Controlling the Kind of Output}.
158 @gccoptlist{-c -S -E -o @var{file} -combine -pipe -pass-exit-codes @gol
159 -x @var{language} -v -### --help --target-help --version}
160
161 @item C Language Options
162 @xref{C Dialect Options,,Options Controlling C Dialect}.
163 @gccoptlist{-ansi -std=@var{standard} -aux-info @var{filename} @gol
164 -fno-asm -fno-builtin -fno-builtin-@var{function} @gol
165 -fhosted -ffreestanding -fms-extensions @gol
166 -trigraphs -no-integrated-cpp -traditional -traditional-cpp @gol
167 -fallow-single-precision -fcond-mismatch @gol
168 -fsigned-bitfields -fsigned-char @gol
169 -funsigned-bitfields -funsigned-char}
170
171 @item C++ Language Options
172 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
173 @gccoptlist{-fabi-version=@var{n} -fno-access-control -fcheck-new @gol
174 -fconserve-space -fno-const-strings @gol
175 -fno-elide-constructors @gol
176 -fno-enforce-eh-specs @gol
177 -ffor-scope -fno-for-scope -fno-gnu-keywords @gol
178 -fno-implicit-templates @gol
179 -fno-implicit-inline-templates @gol
180 -fno-implement-inlines -fms-extensions @gol
181 -fno-nonansi-builtins -fno-operator-names @gol
182 -fno-optional-diags -fpermissive @gol
183 -frepo -fno-rtti -fstats -ftemplate-depth-@var{n} @gol
184 -fno-threadsafe-statics -fuse-cxa-atexit -fno-weak -nostdinc++ @gol
185 -fno-default-inline -fvisibility-inlines-hidden @gol
186 -Wabi -Wctor-dtor-privacy @gol
187 -Wnon-virtual-dtor -Wreorder @gol
188 -Weffc++ -Wno-deprecated -Wstrict-null-sentinel @gol
189 -Wno-non-template-friend -Wold-style-cast @gol
190 -Woverloaded-virtual -Wno-pmf-conversions @gol
191 -Wsign-promo}
192
193 @item Objective-C and Objective-C++ Language Options
194 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
195 Objective-C and Objective-C++ Dialects}.
196 @gccoptlist{
197 -fconstant-string-class=@var{class-name} @gol
198 -fgnu-runtime -fnext-runtime @gol
199 -fno-nil-receivers @gol
200 -fobjc-call-cxx-cdtors @gol
201 -fobjc-direct-dispatch @gol
202 -fobjc-exceptions @gol
203 -fobjc-gc @gol
204 -freplace-objc-classes @gol
205 -fzero-link @gol
206 -gen-decls @gol
207 -Wassign-intercept @gol
208 -Wno-protocol -Wselector @gol
209 -Wstrict-selector-match @gol
210 -Wundeclared-selector}
211
212 @item Language Independent Options
213 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
214 @gccoptlist{-fmessage-length=@var{n} @gol
215 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}} @gol
216 -fdiagnostics-show-options
217
218 @item Warning Options
219 @xref{Warning Options,,Options to Request or Suppress Warnings}.
220 @gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
221 -w -Wextra -Wall -Waggregate-return -Wno-attributes @gol
222 -Wc++-compat -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
223 -Wconversion -Wno-deprecated-declarations @gol
224 -Wdisabled-optimization -Wno-div-by-zero -Wno-endif-labels @gol
225 -Werror -Werror-implicit-function-declaration @gol
226 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
227 -Wno-format-extra-args -Wformat-nonliteral @gol
228 -Wformat-security -Wformat-y2k @gol
229 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
230 -Wimport -Wno-import -Winit-self -Winline @gol
231 -Wno-int-to-pointer-cast @gol
232 -Wno-invalid-offsetof -Winvalid-pch @gol
233 -Wlarger-than-@var{len} -Wlong-long @gol
234 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
235 -Wmissing-format-attribute -Wmissing-include-dirs @gol
236 -Wmissing-noreturn @gol
237 -Wno-multichar -Wnonnull -Wpacked -Wpadded @gol
238 -Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
239 -Wredundant-decls @gol
240 -Wreturn-type -Wsequence-point -Wshadow @gol
241 -Wsign-compare -Wstrict-aliasing -Wstrict-aliasing=2 @gol
242 -Wswitch -Wswitch-default -Wswitch-enum @gol
243 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
244 -Wunknown-pragmas -Wunreachable-code @gol
245 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
246 -Wunused-value -Wunused-variable -Wwrite-strings @gol
247 -Wvariadic-macros}
248
249 @item C-only Warning Options
250 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
251 -Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
252 -Wstrict-prototypes -Wtraditional @gol
253 -Wdeclaration-after-statement -Wno-pointer-sign}
254
255 @item Debugging Options
256 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
257 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
258 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
259 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
260 -fdump-ipa-all -fdump-ipa-cgraph @gol
261 -fdump-tree-all @gol
262 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
266 -fdump-tree-ch @gol
267 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
269 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
270 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
272 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
273 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
274 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
275 -fdump-tree-nrv -fdump-tree-vect @gol
276 -fdump-tree-sink @gol
277 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
278 -fdump-tree-salias @gol
279 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
280 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
281 -ftree-vectorizer-verbose=@var{n} @gol
282 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
283 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
284 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
285 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
286 -ftest-coverage -ftime-report -fvar-tracking @gol
287 -g -g@var{level} -gcoff -gdwarf-2 @gol
288 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
289 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
290 -print-multi-directory -print-multi-lib @gol
291 -print-prog-name=@var{program} -print-search-dirs -Q @gol
292 -save-temps -time}
293
294 @item Optimization Options
295 @xref{Optimize Options,,Options that Control Optimization}.
296 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
297 -falign-labels=@var{n} -falign-loops=@var{n} @gol
298 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
299 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
300 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
301 -fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
302 -fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
303 -fdelayed-branch -fdelete-null-pointer-checks -fearly-inlining @gol
304 -fexpensive-optimizations -ffast-math -ffloat-store @gol
305 -fforce-addr -ffunction-sections @gol
306 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
307 -floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
308 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
309 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
310 -fmodulo-sched -fno-branch-count-reg @gol
311 -fno-default-inline -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
312 -fno-function-cse -fno-guess-branch-probability @gol
313 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
314 -funsafe-math-optimizations -ffinite-math-only @gol
315 -fno-trapping-math -fno-zero-initialized-in-bss @gol
316 -fomit-frame-pointer -foptimize-register-move @gol
317 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
318 -fprofile-generate -fprofile-use @gol
319 -fregmove -frename-registers @gol
320 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
321 -frerun-cse-after-loop -frerun-loop-opt @gol
322 -frounding-math -fschedule-insns -fschedule-insns2 @gol
323 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
324 -fsched-spec-load-dangerous @gol
325 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
326 -fsched2-use-superblocks @gol
327 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
328 -fsignaling-nans -fsingle-precision-constant -fspeculative-prefetching @gol
329 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
330 -funroll-all-loops -funroll-loops -fpeel-loops @gol
331 -fsplit-ivs-in-unroller -funswitch-loops @gol
332 -fvariable-expansion-in-unroller @gol
333 -ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
334 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
335 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
336 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
337 -ftree-salias -fweb @gol
338 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop -fwhole-program @gol
339 --param @var{name}=@var{value}
340 -O -O0 -O1 -O2 -O3 -Os}
341
342 @item Preprocessor Options
343 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
344 @gccoptlist{-A@var{question}=@var{answer} @gol
345 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
346 -C -dD -dI -dM -dN @gol
347 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
348 -idirafter @var{dir} @gol
349 -include @var{file} -imacros @var{file} @gol
350 -iprefix @var{file} -iwithprefix @var{dir} @gol
351 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
352 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
353 -P -fworking-directory -remap @gol
354 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
355 -Xpreprocessor @var{option}}
356
357 @item Assembler Option
358 @xref{Assembler Options,,Passing Options to the Assembler}.
359 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
360
361 @item Linker Options
362 @xref{Link Options,,Options for Linking}.
363 @gccoptlist{@var{object-file-name} -l@var{library} @gol
364 -nostartfiles -nodefaultlibs -nostdlib -pie @gol
365 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
366 -Wl,@var{option} -Xlinker @var{option} @gol
367 -u @var{symbol}}
368
369 @item Directory Options
370 @xref{Directory Options,,Options for Directory Search}.
371 @gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-}
372
373 @item Target Options
374 @c I wrote this xref this way to avoid overfull hbox. -- rms
375 @xref{Target Options}.
376 @gccoptlist{-V @var{version} -b @var{machine}}
377
378 @item Machine Dependent Options
379 @xref{Submodel Options,,Hardware Models and Configurations}.
380 @c This list is ordered alphanumerically by subsection name.
381 @c Try and put the significant identifier (CPU or system) first,
382 @c so users have a clue at guessing where the ones they want will be.
383
384 @emph{ARC Options}
385 @gccoptlist{-EB -EL @gol
386 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
387 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
388
389 @emph{ARM Options}
390 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
391 -mabi=@var{name} @gol
392 -mapcs-stack-check -mno-apcs-stack-check @gol
393 -mapcs-float -mno-apcs-float @gol
394 -mapcs-reentrant -mno-apcs-reentrant @gol
395 -msched-prolog -mno-sched-prolog @gol
396 -mlittle-endian -mbig-endian -mwords-little-endian @gol
397 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
398 -mthumb-interwork -mno-thumb-interwork @gol
399 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
400 -mstructure-size-boundary=@var{n} @gol
401 -mabort-on-noreturn @gol
402 -mlong-calls -mno-long-calls @gol
403 -msingle-pic-base -mno-single-pic-base @gol
404 -mpic-register=@var{reg} @gol
405 -mnop-fun-dllimport @gol
406 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
407 -mpoke-function-name @gol
408 -mthumb -marm @gol
409 -mtpcs-frame -mtpcs-leaf-frame @gol
410 -mcaller-super-interworking -mcallee-super-interworking}
411
412 @emph{AVR Options}
413 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
414 -mcall-prologues -mno-tablejump -mtiny-stack -mint8}
415
416 @emph{Blackfin Options}
417 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer -mcsync @gol
418 -mno-csync -mlow-64k -mno-low64k -mid-shared-library @gol
419 -mno-id-shared-library -mshared-library-id=@var{n} @gol
420 -mlong-calls -mno-long-calls}
421
422 @emph{CRIS Options}
423 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
424 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
425 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
426 -mstack-align -mdata-align -mconst-align @gol
427 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
428 -melf -maout -melinux -mlinux -sim -sim2 @gol
429 -mmul-bug-workaround -mno-mul-bug-workaround}
430
431 @emph{Darwin Options}
432 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
433 -arch_only -bind_at_load -bundle -bundle_loader @gol
434 -client_name -compatibility_version -current_version @gol
435 -dead_strip @gol
436 -dependency-file -dylib_file -dylinker_install_name @gol
437 -dynamic -dynamiclib -exported_symbols_list @gol
438 -filelist -flat_namespace -force_cpusubtype_ALL @gol
439 -force_flat_namespace -headerpad_max_install_names @gol
440 -image_base -init -install_name -keep_private_externs @gol
441 -multi_module -multiply_defined -multiply_defined_unused @gol
442 -noall_load -no_dead_strip_inits_and_terms @gol
443 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
444 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
445 -private_bundle -read_only_relocs -sectalign @gol
446 -sectobjectsymbols -whyload -seg1addr @gol
447 -sectcreate -sectobjectsymbols -sectorder @gol
448 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
449 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
450 -segprot -segs_read_only_addr -segs_read_write_addr @gol
451 -single_module -static -sub_library -sub_umbrella @gol
452 -twolevel_namespace -umbrella -undefined @gol
453 -unexported_symbols_list -weak_reference_mismatches @gol
454 -whatsloaded -F -gused -gfull -mone-byte-bool}
455
456 @emph{DEC Alpha Options}
457 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
458 -mieee -mieee-with-inexact -mieee-conformant @gol
459 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
460 -mtrap-precision=@var{mode} -mbuild-constants @gol
461 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
462 -mbwx -mmax -mfix -mcix @gol
463 -mfloat-vax -mfloat-ieee @gol
464 -mexplicit-relocs -msmall-data -mlarge-data @gol
465 -msmall-text -mlarge-text @gol
466 -mmemory-latency=@var{time}}
467
468 @emph{DEC Alpha/VMS Options}
469 @gccoptlist{-mvms-return-codes}
470
471 @emph{FRV Options}
472 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
473 -mhard-float -msoft-float @gol
474 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
475 -mdouble -mno-double @gol
476 -mmedia -mno-media -mmuladd -mno-muladd @gol
477 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
478 -mlinked-fp -mlong-calls -malign-labels @gol
479 -mlibrary-pic -macc-4 -macc-8 @gol
480 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
481 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
482 -mvliw-branch -mno-vliw-branch @gol
483 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
484 -mno-nested-cond-exec -mtomcat-stats @gol
485 -mTLS -mtls @gol
486 -mcpu=@var{cpu}}
487
488 @emph{H8/300 Options}
489 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
490
491 @emph{HPPA Options}
492 @gccoptlist{-march=@var{architecture-type} @gol
493 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
494 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
495 -mfixed-range=@var{register-range} @gol
496 -mjump-in-delay -mlinker-opt -mlong-calls @gol
497 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
498 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
499 -mno-jump-in-delay -mno-long-load-store @gol
500 -mno-portable-runtime -mno-soft-float @gol
501 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
502 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
503 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
504 -munix=@var{unix-std} -nolibdld -static -threads}
505
506 @emph{i386 and x86-64 Options}
507 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
508 -mfpmath=@var{unit} @gol
509 -masm=@var{dialect} -mno-fancy-math-387 @gol
510 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
511 -mno-wide-multiply -mrtd -malign-double @gol
512 -mpreferred-stack-boundary=@var{num} @gol
513 -mmmx -msse -msse2 -msse3 -m3dnow @gol
514 -mthreads -mno-align-stringops -minline-all-stringops @gol
515 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
516 -m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
517 -mno-red-zone -mno-tls-direct-seg-refs @gol
518 -mcmodel=@var{code-model} @gol
519 -m32 -m64}
520
521 @emph{IA-64 Options}
522 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
523 -mvolatile-asm-stop -mregister-names -mno-sdata @gol
524 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
525 -minline-float-divide-max-throughput @gol
526 -minline-int-divide-min-latency @gol
527 -minline-int-divide-max-throughput @gol
528 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
529 -mno-dwarf2-asm -mearly-stop-bits @gol
530 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
531 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
532
533 @emph{M32R/D Options}
534 @gccoptlist{-m32r2 -m32rx -m32r @gol
535 -mdebug @gol
536 -malign-loops -mno-align-loops @gol
537 -missue-rate=@var{number} @gol
538 -mbranch-cost=@var{number} @gol
539 -mmodel=@var{code-size-model-type} @gol
540 -msdata=@var{sdata-type} @gol
541 -mno-flush-func -mflush-func=@var{name} @gol
542 -mno-flush-trap -mflush-trap=@var{number} @gol
543 -G @var{num}}
544
545 @emph{M680x0 Options}
546 @gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
547 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
548 -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
549 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
550 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
551
552 @emph{M68hc1x Options}
553 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
554 -mauto-incdec -minmax -mlong-calls -mshort @gol
555 -msoft-reg-count=@var{count}}
556
557 @emph{MCore Options}
558 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
559 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
560 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
561 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
562 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
563
564 @emph{MIPS Options}
565 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
566 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
567 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
568 -mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
569 -mhard-float -msoft-float -msingle-float -mdouble-float @gol
570 -mpaired-single -mips3d @gol
571 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
572 -G@var{num} -membedded-data -mno-embedded-data @gol
573 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
574 -msplit-addresses -mno-split-addresses @gol
575 -mexplicit-relocs -mno-explicit-relocs @gol
576 -mcheck-zero-division -mno-check-zero-division @gol
577 -mdivide-traps -mdivide-breaks @gol
578 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
579 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
580 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
581 -mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
582 -mfix-sb1 -mno-fix-sb1 @gol
583 -mflush-func=@var{func} -mno-flush-func @gol
584 -mbranch-likely -mno-branch-likely @gol
585 -mfp-exceptions -mno-fp-exceptions @gol
586 -mvr4130-align -mno-vr4130-align}
587
588 @emph{MMIX Options}
589 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
590 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
591 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
592 -mno-base-addresses -msingle-exit -mno-single-exit}
593
594 @emph{MN10300 Options}
595 @gccoptlist{-mmult-bug -mno-mult-bug @gol
596 -mam33 -mno-am33 @gol
597 -mam33-2 -mno-am33-2 @gol
598 -mno-crt0 -mrelax}
599
600 @emph{NS32K Options}
601 @gccoptlist{-m32032 -m32332 -m32532 -m32081 -m32381 @gol
602 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
603 -mregparam -mnoregparam -msb -mnosb @gol
604 -mbitfield -mnobitfield -mhimem -mnohimem}
605
606 @emph{PDP-11 Options}
607 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
608 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
609 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
610 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
611 -mbranch-expensive -mbranch-cheap @gol
612 -msplit -mno-split -munix-asm -mdec-asm}
613
614 @emph{PowerPC Options}
615 See RS/6000 and PowerPC Options.
616
617 @emph{RS/6000 and PowerPC Options}
618 @gccoptlist{-mcpu=@var{cpu-type} @gol
619 -mtune=@var{cpu-type} @gol
620 -mpower -mno-power -mpower2 -mno-power2 @gol
621 -mpowerpc -mpowerpc64 -mno-powerpc @gol
622 -maltivec -mno-altivec @gol
623 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
624 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
625 -mnew-mnemonics -mold-mnemonics @gol
626 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
627 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
628 -malign-power -malign-natural @gol
629 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
630 -mstring -mno-string -mupdate -mno-update @gol
631 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
632 -mstrict-align -mno-strict-align -mrelocatable @gol
633 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
634 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
635 -mdynamic-no-pic -maltivec -mswdiv @gol
636 -mprioritize-restricted-insns=@var{priority} @gol
637 -msched-costly-dep=@var{dependence_type} @gol
638 -minsert-sched-nops=@var{scheme} @gol
639 -mcall-sysv -mcall-netbsd @gol
640 -maix-struct-return -msvr4-struct-return @gol
641 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
642 -misel -mno-isel @gol
643 -misel=yes -misel=no @gol
644 -mspe -mno-spe @gol
645 -mspe=yes -mspe=no @gol
646 -mvrsave -mno-vrsave @gol
647 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
648 -mprototype -mno-prototype @gol
649 -msim -mmvme -mads -myellowknife -memb -msdata @gol
650 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
651
652 @emph{S/390 and zSeries Options}
653 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
654 -mhard-float -msoft-float -mbackchain -mno-backchain @gol
655 -mpacked-stack -mno-packed-stack @gol
656 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
657 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
658 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
659 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
660
661 @emph{SH Options}
662 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
663 -m4-nofpu -m4-single-only -m4-single -m4 @gol
664 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
665 -m5-64media -m5-64media-nofpu @gol
666 -m5-32media -m5-32media-nofpu @gol
667 -m5-compact -m5-compact-nofpu @gol
668 -mb -ml -mdalign -mrelax @gol
669 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
670 -mieee -misize -mpadstruct -mspace @gol
671 -mprefergot -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
672 -mdivsi3_libfunc=@var{name} @gol
673 -madjust-unroll -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
674 -minvalid-symbols}
675
676 @emph{SPARC Options}
677 @gccoptlist{-mcpu=@var{cpu-type} @gol
678 -mtune=@var{cpu-type} @gol
679 -mcmodel=@var{code-model} @gol
680 -m32 -m64 -mapp-regs -mno-app-regs @gol
681 -mfaster-structs -mno-faster-structs @gol
682 -mfpu -mno-fpu -mhard-float -msoft-float @gol
683 -mhard-quad-float -msoft-quad-float @gol
684 -mimpure-text -mno-impure-text -mlittle-endian @gol
685 -mstack-bias -mno-stack-bias @gol
686 -munaligned-doubles -mno-unaligned-doubles @gol
687 -mv8plus -mno-v8plus -mvis -mno-vis
688 -threads -pthreads}
689
690 @emph{System V Options}
691 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
692
693 @emph{TMS320C3x/C4x Options}
694 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
695 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
696 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
697 -mparallel-insns -mparallel-mpy -mpreserve-float}
698
699 @emph{V850 Options}
700 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
701 -mprolog-function -mno-prolog-function -mspace @gol
702 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
703 -mapp-regs -mno-app-regs @gol
704 -mdisable-callt -mno-disable-callt @gol
705 -mv850e1 @gol
706 -mv850e @gol
707 -mv850 -mbig-switch}
708
709 @emph{VAX Options}
710 @gccoptlist{-mg -mgnu -munix}
711
712 @emph{x86-64 Options}
713 See i386 and x86-64 Options.
714
715 @emph{Xstormy16 Options}
716 @gccoptlist{-msim}
717
718 @emph{Xtensa Options}
719 @gccoptlist{-mconst16 -mno-const16 @gol
720 -mfused-madd -mno-fused-madd @gol
721 -mtext-section-literals -mno-text-section-literals @gol
722 -mtarget-align -mno-target-align @gol
723 -mlongcalls -mno-longcalls}
724
725 @emph{zSeries Options}
726 See S/390 and zSeries Options.
727
728 @item Code Generation Options
729 @xref{Code Gen Options,,Options for Code Generation Conventions}.
730 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
731 -ffixed-@var{reg} -fexceptions @gol
732 -fnon-call-exceptions -funwind-tables @gol
733 -fasynchronous-unwind-tables @gol
734 -finhibit-size-directive -finstrument-functions @gol
735 -fno-common -fno-ident @gol
736 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
737 -fno-jump-tables @gol
738 -freg-struct-return -fshared-data -fshort-enums @gol
739 -fshort-double -fshort-wchar @gol
740 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
741 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
742 -fargument-alias -fargument-noalias @gol
743 -fargument-noalias-global -fleading-underscore @gol
744 -ftls-model=@var{model} @gol
745 -ftrapv -fwrapv -fbounds-check @gol
746 -fvisibility}
747 @end table
748
749 @menu
750 * Overall Options:: Controlling the kind of output:
751 an executable, object files, assembler files,
752 or preprocessed source.
753 * C Dialect Options:: Controlling the variant of C language compiled.
754 * C++ Dialect Options:: Variations on C++.
755 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
756 and Objective-C++.
757 * Language Independent Options:: Controlling how diagnostics should be
758 formatted.
759 * Warning Options:: How picky should the compiler be?
760 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
761 * Optimize Options:: How much optimization?
762 * Preprocessor Options:: Controlling header files and macro definitions.
763 Also, getting dependency information for Make.
764 * Assembler Options:: Passing options to the assembler.
765 * Link Options:: Specifying libraries and so on.
766 * Directory Options:: Where to find header files and libraries.
767 Where to find the compiler executable files.
768 * Spec Files:: How to pass switches to sub-processes.
769 * Target Options:: Running a cross-compiler, or an old version of GCC.
770 @end menu
771
772 @node Overall Options
773 @section Options Controlling the Kind of Output
774
775 Compilation can involve up to four stages: preprocessing, compilation
776 proper, assembly and linking, always in that order. GCC is capable of
777 preprocessing and compiling several files either into several
778 assembler input files, or into one assembler input file; then each
779 assembler input file produces an object file, and linking combines all
780 the object files (those newly compiled, and those specified as input)
781 into an executable file.
782
783 @cindex file name suffix
784 For any given input file, the file name suffix determines what kind of
785 compilation is done:
786
787 @table @gcctabopt
788 @item @var{file}.c
789 C source code which must be preprocessed.
790
791 @item @var{file}.i
792 C source code which should not be preprocessed.
793
794 @item @var{file}.ii
795 C++ source code which should not be preprocessed.
796
797 @item @var{file}.m
798 Objective-C source code. Note that you must link with the @file{libobjc}
799 library to make an Objective-C program work.
800
801 @item @var{file}.mi
802 Objective-C source code which should not be preprocessed.
803
804 @item @var{file}.mm
805 @itemx @var{file}.M
806 Objective-C++ source code. Note that you must link with the @file{libobjc}
807 library to make an Objective-C++ program work. Note that @samp{.M} refers
808 to a literal capital M@.
809
810 @item @var{file}.mii
811 Objective-C++ source code which should not be preprocessed.
812
813 @item @var{file}.h
814 C, C++, Objective-C or Objective-C++ header file to be turned into a
815 precompiled header.
816
817 @item @var{file}.cc
818 @itemx @var{file}.cp
819 @itemx @var{file}.cxx
820 @itemx @var{file}.cpp
821 @itemx @var{file}.CPP
822 @itemx @var{file}.c++
823 @itemx @var{file}.C
824 C++ source code which must be preprocessed. Note that in @samp{.cxx},
825 the last two letters must both be literally @samp{x}. Likewise,
826 @samp{.C} refers to a literal capital C@.
827
828 @item @var{file}.mm
829 @itemx @var{file}.M
830 Objective-C++ source code which must be preprocessed.
831
832 @item @var{file}.mii
833 Objective-C++ source code which should not be preprocessed.
834
835 @item @var{file}.hh
836 @itemx @var{file}.H
837 C++ header file to be turned into a precompiled header.
838
839 @item @var{file}.f
840 @itemx @var{file}.for
841 @itemx @var{file}.FOR
842 Fortran source code which should not be preprocessed.
843
844 @item @var{file}.F
845 @itemx @var{file}.fpp
846 @itemx @var{file}.FPP
847 Fortran source code which must be preprocessed (with the traditional
848 preprocessor).
849
850 @item @var{file}.r
851 Fortran source code which must be preprocessed with a RATFOR
852 preprocessor (not included with GCC)@.
853
854 @item @var{file}.f90
855 @itemx @var{file}.f95
856 Fortran 90/95 source code which should not be preprocessed.
857
858 @c FIXME: Descriptions of Java file types.
859 @c @var{file}.java
860 @c @var{file}.class
861 @c @var{file}.zip
862 @c @var{file}.jar
863
864 @item @var{file}.ads
865 Ada source code file which contains a library unit declaration (a
866 declaration of a package, subprogram, or generic, or a generic
867 instantiation), or a library unit renaming declaration (a package,
868 generic, or subprogram renaming declaration). Such files are also
869 called @dfn{specs}.
870
871 @itemx @var{file}.adb
872 Ada source code file containing a library unit body (a subprogram or
873 package body). Such files are also called @dfn{bodies}.
874
875 @c GCC also knows about some suffixes for languages not yet included:
876 @c Pascal:
877 @c @var{file}.p
878 @c @var{file}.pas
879
880 @item @var{file}.s
881 Assembler code.
882
883 @item @var{file}.S
884 Assembler code which must be preprocessed.
885
886 @item @var{other}
887 An object file to be fed straight into linking.
888 Any file name with no recognized suffix is treated this way.
889 @end table
890
891 @opindex x
892 You can specify the input language explicitly with the @option{-x} option:
893
894 @table @gcctabopt
895 @item -x @var{language}
896 Specify explicitly the @var{language} for the following input files
897 (rather than letting the compiler choose a default based on the file
898 name suffix). This option applies to all following input files until
899 the next @option{-x} option. Possible values for @var{language} are:
900 @smallexample
901 c c-header c-cpp-output
902 c++ c++-header c++-cpp-output
903 objective-c objective-c-header objective-c-cpp-output
904 objective-c++ objective-c++-header objective-c++-cpp-output
905 assembler assembler-with-cpp
906 ada
907 f77 f77-cpp-input ratfor
908 f95
909 java
910 treelang
911 @end smallexample
912
913 @item -x none
914 Turn off any specification of a language, so that subsequent files are
915 handled according to their file name suffixes (as they are if @option{-x}
916 has not been used at all).
917
918 @item -pass-exit-codes
919 @opindex pass-exit-codes
920 Normally the @command{gcc} program will exit with the code of 1 if any
921 phase of the compiler returns a non-success return code. If you specify
922 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
923 numerically highest error produced by any phase that returned an error
924 indication.
925 @end table
926
927 If you only want some of the stages of compilation, you can use
928 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
929 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
930 @command{gcc} is to stop. Note that some combinations (for example,
931 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
932
933 @table @gcctabopt
934 @item -c
935 @opindex c
936 Compile or assemble the source files, but do not link. The linking
937 stage simply is not done. The ultimate output is in the form of an
938 object file for each source file.
939
940 By default, the object file name for a source file is made by replacing
941 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
942
943 Unrecognized input files, not requiring compilation or assembly, are
944 ignored.
945
946 @item -S
947 @opindex S
948 Stop after the stage of compilation proper; do not assemble. The output
949 is in the form of an assembler code file for each non-assembler input
950 file specified.
951
952 By default, the assembler file name for a source file is made by
953 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
954
955 Input files that don't require compilation are ignored.
956
957 @item -E
958 @opindex E
959 Stop after the preprocessing stage; do not run the compiler proper. The
960 output is in the form of preprocessed source code, which is sent to the
961 standard output.
962
963 Input files which don't require preprocessing are ignored.
964
965 @cindex output file option
966 @item -o @var{file}
967 @opindex o
968 Place output in file @var{file}. This applies regardless to whatever
969 sort of output is being produced, whether it be an executable file,
970 an object file, an assembler file or preprocessed C code.
971
972 If @option{-o} is not specified, the default is to put an executable
973 file in @file{a.out}, the object file for
974 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
975 assembler file in @file{@var{source}.s}, a precompiled header file in
976 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
977 standard output.
978
979 @item -v
980 @opindex v
981 Print (on standard error output) the commands executed to run the stages
982 of compilation. Also print the version number of the compiler driver
983 program and of the preprocessor and the compiler proper.
984
985 @item -###
986 @opindex ###
987 Like @option{-v} except the commands are not executed and all command
988 arguments are quoted. This is useful for shell scripts to capture the
989 driver-generated command lines.
990
991 @item -pipe
992 @opindex pipe
993 Use pipes rather than temporary files for communication between the
994 various stages of compilation. This fails to work on some systems where
995 the assembler is unable to read from a pipe; but the GNU assembler has
996 no trouble.
997
998 @item -combine
999 @opindex combine
1000 If you are compiling multiple source files, this option tells the driver
1001 to pass all the source files to the compiler at once (for those
1002 languages for which the compiler can handle this). This will allow
1003 intermodule analysis (IMA) to be performed by the compiler. Currently the only
1004 language for which this is supported is C@. If you pass source files for
1005 multiple languages to the driver, using this option, the driver will invoke
1006 the compiler(s) that support IMA once each, passing each compiler all the
1007 source files appropriate for it. For those languages that do not support
1008 IMA this option will be ignored, and the compiler will be invoked once for
1009 each source file in that language. If you use this option in conjunction
1010 with @option{-save-temps}, the compiler will generate multiple
1011 pre-processed files
1012 (one for each source file), but only one (combined) @file{.o} or
1013 @file{.s} file.
1014
1015 @item --help
1016 @opindex help
1017 Print (on the standard output) a description of the command line options
1018 understood by @command{gcc}. If the @option{-v} option is also specified
1019 then @option{--help} will also be passed on to the various processes
1020 invoked by @command{gcc}, so that they can display the command line options
1021 they accept. If the @option{-Wextra} option is also specified then command
1022 line options which have no documentation associated with them will also
1023 be displayed.
1024
1025 @item --target-help
1026 @opindex target-help
1027 Print (on the standard output) a description of target specific command
1028 line options for each tool.
1029
1030 @item --version
1031 @opindex version
1032 Display the version number and copyrights of the invoked GCC@.
1033 @end table
1034
1035 @node Invoking G++
1036 @section Compiling C++ Programs
1037
1038 @cindex suffixes for C++ source
1039 @cindex C++ source file suffixes
1040 C++ source files conventionally use one of the suffixes @samp{.C},
1041 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1042 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1043 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1044 files with these names and compiles them as C++ programs even if you
1045 call the compiler the same way as for compiling C programs (usually
1046 with the name @command{gcc}).
1047
1048 @findex g++
1049 @findex c++
1050 However, C++ programs often require class libraries as well as a
1051 compiler that understands the C++ language---and under some
1052 circumstances, you might want to compile programs or header files from
1053 standard input, or otherwise without a suffix that flags them as C++
1054 programs. You might also like to precompile a C header file with a
1055 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
1056 program that calls GCC with the default language set to C++, and
1057 automatically specifies linking against the C++ library. On many
1058 systems, @command{g++} is also installed with the name @command{c++}.
1059
1060 @cindex invoking @command{g++}
1061 When you compile C++ programs, you may specify many of the same
1062 command-line options that you use for compiling programs in any
1063 language; or command-line options meaningful for C and related
1064 languages; or options that are meaningful only for C++ programs.
1065 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1066 explanations of options for languages related to C@.
1067 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1068 explanations of options that are meaningful only for C++ programs.
1069
1070 @node C Dialect Options
1071 @section Options Controlling C Dialect
1072 @cindex dialect options
1073 @cindex language dialect options
1074 @cindex options, dialect
1075
1076 The following options control the dialect of C (or languages derived
1077 from C, such as C++, Objective-C and Objective-C++) that the compiler
1078 accepts:
1079
1080 @table @gcctabopt
1081 @cindex ANSI support
1082 @cindex ISO support
1083 @item -ansi
1084 @opindex ansi
1085 In C mode, support all ISO C90 programs. In C++ mode,
1086 remove GNU extensions that conflict with ISO C++.
1087
1088 This turns off certain features of GCC that are incompatible with ISO
1089 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1090 such as the @code{asm} and @code{typeof} keywords, and
1091 predefined macros such as @code{unix} and @code{vax} that identify the
1092 type of system you are using. It also enables the undesirable and
1093 rarely used ISO trigraph feature. For the C compiler,
1094 it disables recognition of C++ style @samp{//} comments as well as
1095 the @code{inline} keyword.
1096
1097 The alternate keywords @code{__asm__}, @code{__extension__},
1098 @code{__inline__} and @code{__typeof__} continue to work despite
1099 @option{-ansi}. You would not want to use them in an ISO C program, of
1100 course, but it is useful to put them in header files that might be included
1101 in compilations done with @option{-ansi}. Alternate predefined macros
1102 such as @code{__unix__} and @code{__vax__} are also available, with or
1103 without @option{-ansi}.
1104
1105 The @option{-ansi} option does not cause non-ISO programs to be
1106 rejected gratuitously. For that, @option{-pedantic} is required in
1107 addition to @option{-ansi}. @xref{Warning Options}.
1108
1109 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1110 option is used. Some header files may notice this macro and refrain
1111 from declaring certain functions or defining certain macros that the
1112 ISO standard doesn't call for; this is to avoid interfering with any
1113 programs that might use these names for other things.
1114
1115 Functions which would normally be built in but do not have semantics
1116 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1117 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1118 built-in functions provided by GCC}, for details of the functions
1119 affected.
1120
1121 @item -std=
1122 @opindex std
1123 Determine the language standard. This option is currently only
1124 supported when compiling C or C++. A value for this option must be
1125 provided; possible values are
1126
1127 @table @samp
1128 @item c89
1129 @itemx iso9899:1990
1130 ISO C90 (same as @option{-ansi}).
1131
1132 @item iso9899:199409
1133 ISO C90 as modified in amendment 1.
1134
1135 @item c99
1136 @itemx c9x
1137 @itemx iso9899:1999
1138 @itemx iso9899:199x
1139 ISO C99. Note that this standard is not yet fully supported; see
1140 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1141 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1142
1143 @item gnu89
1144 Default, ISO C90 plus GNU extensions (including some C99 features).
1145
1146 @item gnu99
1147 @itemx gnu9x
1148 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1149 this will become the default. The name @samp{gnu9x} is deprecated.
1150
1151 @item c++98
1152 The 1998 ISO C++ standard plus amendments.
1153
1154 @item gnu++98
1155 The same as @option{-std=c++98} plus GNU extensions. This is the
1156 default for C++ code.
1157 @end table
1158
1159 Even when this option is not specified, you can still use some of the
1160 features of newer standards in so far as they do not conflict with
1161 previous C standards. For example, you may use @code{__restrict__} even
1162 when @option{-std=c99} is not specified.
1163
1164 The @option{-std} options specifying some version of ISO C have the same
1165 effects as @option{-ansi}, except that features that were not in ISO C90
1166 but are in the specified version (for example, @samp{//} comments and
1167 the @code{inline} keyword in ISO C99) are not disabled.
1168
1169 @xref{Standards,,Language Standards Supported by GCC}, for details of
1170 these standard versions.
1171
1172 @item -aux-info @var{filename}
1173 @opindex aux-info
1174 Output to the given filename prototyped declarations for all functions
1175 declared and/or defined in a translation unit, including those in header
1176 files. This option is silently ignored in any language other than C@.
1177
1178 Besides declarations, the file indicates, in comments, the origin of
1179 each declaration (source file and line), whether the declaration was
1180 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1181 @samp{O} for old, respectively, in the first character after the line
1182 number and the colon), and whether it came from a declaration or a
1183 definition (@samp{C} or @samp{F}, respectively, in the following
1184 character). In the case of function definitions, a K&R-style list of
1185 arguments followed by their declarations is also provided, inside
1186 comments, after the declaration.
1187
1188 @item -fno-asm
1189 @opindex fno-asm
1190 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1191 keyword, so that code can use these words as identifiers. You can use
1192 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1193 instead. @option{-ansi} implies @option{-fno-asm}.
1194
1195 In C++, this switch only affects the @code{typeof} keyword, since
1196 @code{asm} and @code{inline} are standard keywords. You may want to
1197 use the @option{-fno-gnu-keywords} flag instead, which has the same
1198 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1199 switch only affects the @code{asm} and @code{typeof} keywords, since
1200 @code{inline} is a standard keyword in ISO C99.
1201
1202 @item -fno-builtin
1203 @itemx -fno-builtin-@var{function}
1204 @opindex fno-builtin
1205 @cindex built-in functions
1206 Don't recognize built-in functions that do not begin with
1207 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1208 functions provided by GCC}, for details of the functions affected,
1209 including those which are not built-in functions when @option{-ansi} or
1210 @option{-std} options for strict ISO C conformance are used because they
1211 do not have an ISO standard meaning.
1212
1213 GCC normally generates special code to handle certain built-in functions
1214 more efficiently; for instance, calls to @code{alloca} may become single
1215 instructions that adjust the stack directly, and calls to @code{memcpy}
1216 may become inline copy loops. The resulting code is often both smaller
1217 and faster, but since the function calls no longer appear as such, you
1218 cannot set a breakpoint on those calls, nor can you change the behavior
1219 of the functions by linking with a different library. In addition,
1220 when a function is recognized as a built-in function, GCC may use
1221 information about that function to warn about problems with calls to
1222 that function, or to generate more efficient code, even if the
1223 resulting code still contains calls to that function. For example,
1224 warnings are given with @option{-Wformat} for bad calls to
1225 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1226 known not to modify global memory.
1227
1228 With the @option{-fno-builtin-@var{function}} option
1229 only the built-in function @var{function} is
1230 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1231 function is named this is not built-in in this version of GCC, this
1232 option is ignored. There is no corresponding
1233 @option{-fbuiltin-@var{function}} option; if you wish to enable
1234 built-in functions selectively when using @option{-fno-builtin} or
1235 @option{-ffreestanding}, you may define macros such as:
1236
1237 @smallexample
1238 #define abs(n) __builtin_abs ((n))
1239 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1240 @end smallexample
1241
1242 @item -fhosted
1243 @opindex fhosted
1244 @cindex hosted environment
1245
1246 Assert that compilation takes place in a hosted environment. This implies
1247 @option{-fbuiltin}. A hosted environment is one in which the
1248 entire standard library is available, and in which @code{main} has a return
1249 type of @code{int}. Examples are nearly everything except a kernel.
1250 This is equivalent to @option{-fno-freestanding}.
1251
1252 @item -ffreestanding
1253 @opindex ffreestanding
1254 @cindex hosted environment
1255
1256 Assert that compilation takes place in a freestanding environment. This
1257 implies @option{-fno-builtin}. A freestanding environment
1258 is one in which the standard library may not exist, and program startup may
1259 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1260 This is equivalent to @option{-fno-hosted}.
1261
1262 @xref{Standards,,Language Standards Supported by GCC}, for details of
1263 freestanding and hosted environments.
1264
1265 @item -fms-extensions
1266 @opindex fms-extensions
1267 Accept some non-standard constructs used in Microsoft header files.
1268
1269 Some cases of unnamed fields in structures and unions are only
1270 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1271 fields within structs/unions}, for details.
1272
1273 @item -trigraphs
1274 @opindex trigraphs
1275 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1276 options for strict ISO C conformance) implies @option{-trigraphs}.
1277
1278 @item -no-integrated-cpp
1279 @opindex no-integrated-cpp
1280 Performs a compilation in two passes: preprocessing and compiling. This
1281 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1282 @option{-B} option. The user supplied compilation step can then add in
1283 an additional preprocessing step after normal preprocessing but before
1284 compiling. The default is to use the integrated cpp (internal cpp)
1285
1286 The semantics of this option will change if "cc1", "cc1plus", and
1287 "cc1obj" are merged.
1288
1289 @cindex traditional C language
1290 @cindex C language, traditional
1291 @item -traditional
1292 @itemx -traditional-cpp
1293 @opindex traditional-cpp
1294 @opindex traditional
1295 Formerly, these options caused GCC to attempt to emulate a pre-standard
1296 C compiler. They are now only supported with the @option{-E} switch.
1297 The preprocessor continues to support a pre-standard mode. See the GNU
1298 CPP manual for details.
1299
1300 @item -fcond-mismatch
1301 @opindex fcond-mismatch
1302 Allow conditional expressions with mismatched types in the second and
1303 third arguments. The value of such an expression is void. This option
1304 is not supported for C++.
1305
1306 @item -funsigned-char
1307 @opindex funsigned-char
1308 Let the type @code{char} be unsigned, like @code{unsigned char}.
1309
1310 Each kind of machine has a default for what @code{char} should
1311 be. It is either like @code{unsigned char} by default or like
1312 @code{signed char} by default.
1313
1314 Ideally, a portable program should always use @code{signed char} or
1315 @code{unsigned char} when it depends on the signedness of an object.
1316 But many programs have been written to use plain @code{char} and
1317 expect it to be signed, or expect it to be unsigned, depending on the
1318 machines they were written for. This option, and its inverse, let you
1319 make such a program work with the opposite default.
1320
1321 The type @code{char} is always a distinct type from each of
1322 @code{signed char} or @code{unsigned char}, even though its behavior
1323 is always just like one of those two.
1324
1325 @item -fsigned-char
1326 @opindex fsigned-char
1327 Let the type @code{char} be signed, like @code{signed char}.
1328
1329 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1330 the negative form of @option{-funsigned-char}. Likewise, the option
1331 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1332
1333 @item -fsigned-bitfields
1334 @itemx -funsigned-bitfields
1335 @itemx -fno-signed-bitfields
1336 @itemx -fno-unsigned-bitfields
1337 @opindex fsigned-bitfields
1338 @opindex funsigned-bitfields
1339 @opindex fno-signed-bitfields
1340 @opindex fno-unsigned-bitfields
1341 These options control whether a bit-field is signed or unsigned, when the
1342 declaration does not use either @code{signed} or @code{unsigned}. By
1343 default, such a bit-field is signed, because this is consistent: the
1344 basic integer types such as @code{int} are signed types.
1345 @end table
1346
1347 @node C++ Dialect Options
1348 @section Options Controlling C++ Dialect
1349
1350 @cindex compiler options, C++
1351 @cindex C++ options, command line
1352 @cindex options, C++
1353 This section describes the command-line options that are only meaningful
1354 for C++ programs; but you can also use most of the GNU compiler options
1355 regardless of what language your program is in. For example, you
1356 might compile a file @code{firstClass.C} like this:
1357
1358 @smallexample
1359 g++ -g -frepo -O -c firstClass.C
1360 @end smallexample
1361
1362 @noindent
1363 In this example, only @option{-frepo} is an option meant
1364 only for C++ programs; you can use the other options with any
1365 language supported by GCC@.
1366
1367 Here is a list of options that are @emph{only} for compiling C++ programs:
1368
1369 @table @gcctabopt
1370
1371 @item -fabi-version=@var{n}
1372 @opindex fabi-version
1373 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1374 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1375 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1376 the version that conforms most closely to the C++ ABI specification.
1377 Therefore, the ABI obtained using version 0 will change as ABI bugs
1378 are fixed.
1379
1380 The default is version 2.
1381
1382 @item -fno-access-control
1383 @opindex fno-access-control
1384 Turn off all access checking. This switch is mainly useful for working
1385 around bugs in the access control code.
1386
1387 @item -fcheck-new
1388 @opindex fcheck-new
1389 Check that the pointer returned by @code{operator new} is non-null
1390 before attempting to modify the storage allocated. This check is
1391 normally unnecessary because the C++ standard specifies that
1392 @code{operator new} will only return @code{0} if it is declared
1393 @samp{throw()}, in which case the compiler will always check the
1394 return value even without this option. In all other cases, when
1395 @code{operator new} has a non-empty exception specification, memory
1396 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1397 @samp{new (nothrow)}.
1398
1399 @item -fconserve-space
1400 @opindex fconserve-space
1401 Put uninitialized or runtime-initialized global variables into the
1402 common segment, as C does. This saves space in the executable at the
1403 cost of not diagnosing duplicate definitions. If you compile with this
1404 flag and your program mysteriously crashes after @code{main()} has
1405 completed, you may have an object that is being destroyed twice because
1406 two definitions were merged.
1407
1408 This option is no longer useful on most targets, now that support has
1409 been added for putting variables into BSS without making them common.
1410
1411 @item -fno-const-strings
1412 @opindex fno-const-strings
1413 Give string constants type @code{char *} instead of type @code{const
1414 char *}. By default, G++ uses type @code{const char *} as required by
1415 the standard. Even if you use @option{-fno-const-strings}, you cannot
1416 actually modify the value of a string constant.
1417
1418 This option might be removed in a future release of G++. For maximum
1419 portability, you should structure your code so that it works with
1420 string constants that have type @code{const char *}.
1421
1422 @item -fno-elide-constructors
1423 @opindex fno-elide-constructors
1424 The C++ standard allows an implementation to omit creating a temporary
1425 which is only used to initialize another object of the same type.
1426 Specifying this option disables that optimization, and forces G++ to
1427 call the copy constructor in all cases.
1428
1429 @item -fno-enforce-eh-specs
1430 @opindex fno-enforce-eh-specs
1431 Don't check for violation of exception specifications at runtime. This
1432 option violates the C++ standard, but may be useful for reducing code
1433 size in production builds, much like defining @samp{NDEBUG}. The compiler
1434 will still optimize based on the exception specifications.
1435
1436 @item -ffor-scope
1437 @itemx -fno-for-scope
1438 @opindex ffor-scope
1439 @opindex fno-for-scope
1440 If @option{-ffor-scope} is specified, the scope of variables declared in
1441 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1442 as specified by the C++ standard.
1443 If @option{-fno-for-scope} is specified, the scope of variables declared in
1444 a @i{for-init-statement} extends to the end of the enclosing scope,
1445 as was the case in old versions of G++, and other (traditional)
1446 implementations of C++.
1447
1448 The default if neither flag is given to follow the standard,
1449 but to allow and give a warning for old-style code that would
1450 otherwise be invalid, or have different behavior.
1451
1452 @item -fno-gnu-keywords
1453 @opindex fno-gnu-keywords
1454 Do not recognize @code{typeof} as a keyword, so that code can use this
1455 word as an identifier. You can use the keyword @code{__typeof__} instead.
1456 @option{-ansi} implies @option{-fno-gnu-keywords}.
1457
1458 @item -fno-implicit-templates
1459 @opindex fno-implicit-templates
1460 Never emit code for non-inline templates which are instantiated
1461 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1462 @xref{Template Instantiation}, for more information.
1463
1464 @item -fno-implicit-inline-templates
1465 @opindex fno-implicit-inline-templates
1466 Don't emit code for implicit instantiations of inline templates, either.
1467 The default is to handle inlines differently so that compiles with and
1468 without optimization will need the same set of explicit instantiations.
1469
1470 @item -fno-implement-inlines
1471 @opindex fno-implement-inlines
1472 To save space, do not emit out-of-line copies of inline functions
1473 controlled by @samp{#pragma implementation}. This will cause linker
1474 errors if these functions are not inlined everywhere they are called.
1475
1476 @item -fms-extensions
1477 @opindex fms-extensions
1478 Disable pedantic warnings about constructs used in MFC, such as implicit
1479 int and getting a pointer to member function via non-standard syntax.
1480
1481 @item -fno-nonansi-builtins
1482 @opindex fno-nonansi-builtins
1483 Disable built-in declarations of functions that are not mandated by
1484 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1485 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1486
1487 @item -fno-operator-names
1488 @opindex fno-operator-names
1489 Do not treat the operator name keywords @code{and}, @code{bitand},
1490 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1491 synonyms as keywords.
1492
1493 @item -fno-optional-diags
1494 @opindex fno-optional-diags
1495 Disable diagnostics that the standard says a compiler does not need to
1496 issue. Currently, the only such diagnostic issued by G++ is the one for
1497 a name having multiple meanings within a class.
1498
1499 @item -fpermissive
1500 @opindex fpermissive
1501 Downgrade some diagnostics about nonconformant code from errors to
1502 warnings. Thus, using @option{-fpermissive} will allow some
1503 nonconforming code to compile.
1504
1505 @item -frepo
1506 @opindex frepo
1507 Enable automatic template instantiation at link time. This option also
1508 implies @option{-fno-implicit-templates}. @xref{Template
1509 Instantiation}, for more information.
1510
1511 @item -fno-rtti
1512 @opindex fno-rtti
1513 Disable generation of information about every class with virtual
1514 functions for use by the C++ runtime type identification features
1515 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1516 of the language, you can save some space by using this flag. Note that
1517 exception handling uses the same information, but it will generate it as
1518 needed.
1519
1520 @item -fstats
1521 @opindex fstats
1522 Emit statistics about front-end processing at the end of the compilation.
1523 This information is generally only useful to the G++ development team.
1524
1525 @item -ftemplate-depth-@var{n}
1526 @opindex ftemplate-depth
1527 Set the maximum instantiation depth for template classes to @var{n}.
1528 A limit on the template instantiation depth is needed to detect
1529 endless recursions during template class instantiation. ANSI/ISO C++
1530 conforming programs must not rely on a maximum depth greater than 17.
1531
1532 @item -fno-threadsafe-statics
1533 @opindex fno-threadsafe-statics
1534 Do not emit the extra code to use the routines specified in the C++
1535 ABI for thread-safe initialization of local statics. You can use this
1536 option to reduce code size slightly in code that doesn't need to be
1537 thread-safe.
1538
1539 @item -fuse-cxa-atexit
1540 @opindex fuse-cxa-atexit
1541 Register destructors for objects with static storage duration with the
1542 @code{__cxa_atexit} function rather than the @code{atexit} function.
1543 This option is required for fully standards-compliant handling of static
1544 destructors, but will only work if your C library supports
1545 @code{__cxa_atexit}.
1546
1547 @item -fvisibility-inlines-hidden
1548 @opindex fvisibility-inlines-hidden
1549 Causes all inlined methods to be marked with
1550 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1551 appear in the export table of a DSO and do not require a PLT indirection
1552 when used within the DSO@. Enabling this option can have a dramatic effect
1553 on load and link times of a DSO as it massively reduces the size of the
1554 dynamic export table when the library makes heavy use of templates. While
1555 it can cause bloating through duplication of code within each DSO where
1556 it is used, often the wastage is less than the considerable space occupied
1557 by a long symbol name in the export table which is typical when using
1558 templates and namespaces. For even more savings, combine with the
1559 @option{-fvisibility=hidden} switch.
1560
1561 @item -fno-weak
1562 @opindex fno-weak
1563 Do not use weak symbol support, even if it is provided by the linker.
1564 By default, G++ will use weak symbols if they are available. This
1565 option exists only for testing, and should not be used by end-users;
1566 it will result in inferior code and has no benefits. This option may
1567 be removed in a future release of G++.
1568
1569 @item -nostdinc++
1570 @opindex nostdinc++
1571 Do not search for header files in the standard directories specific to
1572 C++, but do still search the other standard directories. (This option
1573 is used when building the C++ library.)
1574 @end table
1575
1576 In addition, these optimization, warning, and code generation options
1577 have meanings only for C++ programs:
1578
1579 @table @gcctabopt
1580 @item -fno-default-inline
1581 @opindex fno-default-inline
1582 Do not assume @samp{inline} for functions defined inside a class scope.
1583 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1584 functions will have linkage like inline functions; they just won't be
1585 inlined by default.
1586
1587 @item -Wabi @r{(C++ only)}
1588 @opindex Wabi
1589 Warn when G++ generates code that is probably not compatible with the
1590 vendor-neutral C++ ABI@. Although an effort has been made to warn about
1591 all such cases, there are probably some cases that are not warned about,
1592 even though G++ is generating incompatible code. There may also be
1593 cases where warnings are emitted even though the code that is generated
1594 will be compatible.
1595
1596 You should rewrite your code to avoid these warnings if you are
1597 concerned about the fact that code generated by G++ may not be binary
1598 compatible with code generated by other compilers.
1599
1600 The known incompatibilities at this point include:
1601
1602 @itemize @bullet
1603
1604 @item
1605 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1606 pack data into the same byte as a base class. For example:
1607
1608 @smallexample
1609 struct A @{ virtual void f(); int f1 : 1; @};
1610 struct B : public A @{ int f2 : 1; @};
1611 @end smallexample
1612
1613 @noindent
1614 In this case, G++ will place @code{B::f2} into the same byte
1615 as@code{A::f1}; other compilers will not. You can avoid this problem
1616 by explicitly padding @code{A} so that its size is a multiple of the
1617 byte size on your platform; that will cause G++ and other compilers to
1618 layout @code{B} identically.
1619
1620 @item
1621 Incorrect handling of tail-padding for virtual bases. G++ does not use
1622 tail padding when laying out virtual bases. For example:
1623
1624 @smallexample
1625 struct A @{ virtual void f(); char c1; @};
1626 struct B @{ B(); char c2; @};
1627 struct C : public A, public virtual B @{@};
1628 @end smallexample
1629
1630 @noindent
1631 In this case, G++ will not place @code{B} into the tail-padding for
1632 @code{A}; other compilers will. You can avoid this problem by
1633 explicitly padding @code{A} so that its size is a multiple of its
1634 alignment (ignoring virtual base classes); that will cause G++ and other
1635 compilers to layout @code{C} identically.
1636
1637 @item
1638 Incorrect handling of bit-fields with declared widths greater than that
1639 of their underlying types, when the bit-fields appear in a union. For
1640 example:
1641
1642 @smallexample
1643 union U @{ int i : 4096; @};
1644 @end smallexample
1645
1646 @noindent
1647 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1648 union too small by the number of bits in an @code{int}.
1649
1650 @item
1651 Empty classes can be placed at incorrect offsets. For example:
1652
1653 @smallexample
1654 struct A @{@};
1655
1656 struct B @{
1657 A a;
1658 virtual void f ();
1659 @};
1660
1661 struct C : public B, public A @{@};
1662 @end smallexample
1663
1664 @noindent
1665 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1666 it should be placed at offset zero. G++ mistakenly believes that the
1667 @code{A} data member of @code{B} is already at offset zero.
1668
1669 @item
1670 Names of template functions whose types involve @code{typename} or
1671 template template parameters can be mangled incorrectly.
1672
1673 @smallexample
1674 template <typename Q>
1675 void f(typename Q::X) @{@}
1676
1677 template <template <typename> class Q>
1678 void f(typename Q<int>::X) @{@}
1679 @end smallexample
1680
1681 @noindent
1682 Instantiations of these templates may be mangled incorrectly.
1683
1684 @end itemize
1685
1686 @item -Wctor-dtor-privacy @r{(C++ only)}
1687 @opindex Wctor-dtor-privacy
1688 Warn when a class seems unusable because all the constructors or
1689 destructors in that class are private, and it has neither friends nor
1690 public static member functions.
1691
1692 @item -Wnon-virtual-dtor @r{(C++ only)}
1693 @opindex Wnon-virtual-dtor
1694 Warn when a class appears to be polymorphic, thereby requiring a virtual
1695 destructor, yet it declares a non-virtual one.
1696 This warning is enabled by @option{-Wall}.
1697
1698 @item -Wreorder @r{(C++ only)}
1699 @opindex Wreorder
1700 @cindex reordering, warning
1701 @cindex warning for reordering of member initializers
1702 Warn when the order of member initializers given in the code does not
1703 match the order in which they must be executed. For instance:
1704
1705 @smallexample
1706 struct A @{
1707 int i;
1708 int j;
1709 A(): j (0), i (1) @{ @}
1710 @};
1711 @end smallexample
1712
1713 The compiler will rearrange the member initializers for @samp{i}
1714 and @samp{j} to match the declaration order of the members, emitting
1715 a warning to that effect. This warning is enabled by @option{-Wall}.
1716 @end table
1717
1718 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1719
1720 @table @gcctabopt
1721 @item -Weffc++ @r{(C++ only)}
1722 @opindex Weffc++
1723 Warn about violations of the following style guidelines from Scott Meyers'
1724 @cite{Effective C++} book:
1725
1726 @itemize @bullet
1727 @item
1728 Item 11: Define a copy constructor and an assignment operator for classes
1729 with dynamically allocated memory.
1730
1731 @item
1732 Item 12: Prefer initialization to assignment in constructors.
1733
1734 @item
1735 Item 14: Make destructors virtual in base classes.
1736
1737 @item
1738 Item 15: Have @code{operator=} return a reference to @code{*this}.
1739
1740 @item
1741 Item 23: Don't try to return a reference when you must return an object.
1742
1743 @end itemize
1744
1745 Also warn about violations of the following style guidelines from
1746 Scott Meyers' @cite{More Effective C++} book:
1747
1748 @itemize @bullet
1749 @item
1750 Item 6: Distinguish between prefix and postfix forms of increment and
1751 decrement operators.
1752
1753 @item
1754 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1755
1756 @end itemize
1757
1758 When selecting this option, be aware that the standard library
1759 headers do not obey all of these guidelines; use @samp{grep -v}
1760 to filter out those warnings.
1761
1762 @item -Wno-deprecated @r{(C++ only)}
1763 @opindex Wno-deprecated
1764 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1765
1766 @item -Wstrict-null-sentinel @r{(C++ only)}
1767 @opindex Wstrict-null-sentinel
1768 Warn also about the use of an uncasted @code{NULL} as sentinel. When
1769 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
1770 to @code{__null}. Although it is a null pointer constant not a null pointer,
1771 it is guaranteed to of the same size as a pointer. But this use is
1772 not portable across different compilers.
1773
1774 @item -Wno-non-template-friend @r{(C++ only)}
1775 @opindex Wno-non-template-friend
1776 Disable warnings when non-templatized friend functions are declared
1777 within a template. Since the advent of explicit template specification
1778 support in G++, if the name of the friend is an unqualified-id (i.e.,
1779 @samp{friend foo(int)}), the C++ language specification demands that the
1780 friend declare or define an ordinary, nontemplate function. (Section
1781 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1782 could be interpreted as a particular specialization of a templatized
1783 function. Because this non-conforming behavior is no longer the default
1784 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1785 check existing code for potential trouble spots and is on by default.
1786 This new compiler behavior can be turned off with
1787 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1788 but disables the helpful warning.
1789
1790 @item -Wold-style-cast @r{(C++ only)}
1791 @opindex Wold-style-cast
1792 Warn if an old-style (C-style) cast to a non-void type is used within
1793 a C++ program. The new-style casts (@samp{static_cast},
1794 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1795 unintended effects and much easier to search for.
1796
1797 @item -Woverloaded-virtual @r{(C++ only)}
1798 @opindex Woverloaded-virtual
1799 @cindex overloaded virtual fn, warning
1800 @cindex warning for overloaded virtual fn
1801 Warn when a function declaration hides virtual functions from a
1802 base class. For example, in:
1803
1804 @smallexample
1805 struct A @{
1806 virtual void f();
1807 @};
1808
1809 struct B: public A @{
1810 void f(int);
1811 @};
1812 @end smallexample
1813
1814 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1815 like:
1816
1817 @smallexample
1818 B* b;
1819 b->f();
1820 @end smallexample
1821
1822 will fail to compile.
1823
1824 @item -Wno-pmf-conversions @r{(C++ only)}
1825 @opindex Wno-pmf-conversions
1826 Disable the diagnostic for converting a bound pointer to member function
1827 to a plain pointer.
1828
1829 @item -Wsign-promo @r{(C++ only)}
1830 @opindex Wsign-promo
1831 Warn when overload resolution chooses a promotion from unsigned or
1832 enumerated type to a signed type, over a conversion to an unsigned type of
1833 the same size. Previous versions of G++ would try to preserve
1834 unsignedness, but the standard mandates the current behavior.
1835
1836 @smallexample
1837 struct A @{
1838 operator int ();
1839 A& operator = (int);
1840 @};
1841
1842 main ()
1843 @{
1844 A a,b;
1845 a = b;
1846 @}
1847 @end smallexample
1848
1849 In this example, G++ will synthesize a default @samp{A& operator =
1850 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1851 @end table
1852
1853 @node Objective-C and Objective-C++ Dialect Options
1854 @section Options Controlling Objective-C and Objective-C++ Dialects
1855
1856 @cindex compiler options, Objective-C and Objective-C++
1857 @cindex Objective-C and Objective-C++ options, command line
1858 @cindex options, Objective-C and Objective-C++
1859 (NOTE: This manual does not describe the Objective-C and Objective-C++
1860 languages themselves. See @xref{Standards,,Language Standards
1861 Supported by GCC}, for references.)
1862
1863 This section describes the command-line options that are only meaningful
1864 for Objective-C and Objective-C++ programs, but you can also use most of
1865 the language-independent GNU compiler options.
1866 For example, you might compile a file @code{some_class.m} like this:
1867
1868 @smallexample
1869 gcc -g -fgnu-runtime -O -c some_class.m
1870 @end smallexample
1871
1872 @noindent
1873 In this example, @option{-fgnu-runtime} is an option meant only for
1874 Objective-C and Objective-C++ programs; you can use the other options with
1875 any language supported by GCC@.
1876
1877 Note that since Objective-C is an extension of the C language, Objective-C
1878 compilations may also use options specific to the C front-end (e.g.,
1879 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1880 C++-specific options (e.g., @option{-Wabi}).
1881
1882 Here is a list of options that are @emph{only} for compiling Objective-C
1883 and Objective-C++ programs:
1884
1885 @table @gcctabopt
1886 @item -fconstant-string-class=@var{class-name}
1887 @opindex fconstant-string-class
1888 Use @var{class-name} as the name of the class to instantiate for each
1889 literal string specified with the syntax @code{@@"@dots{}"}. The default
1890 class name is @code{NXConstantString} if the GNU runtime is being used, and
1891 @code{NSConstantString} if the NeXT runtime is being used (see below). The
1892 @option{-fconstant-cfstrings} option, if also present, will override the
1893 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1894 to be laid out as constant CoreFoundation strings.
1895
1896 @item -fgnu-runtime
1897 @opindex fgnu-runtime
1898 Generate object code compatible with the standard GNU Objective-C
1899 runtime. This is the default for most types of systems.
1900
1901 @item -fnext-runtime
1902 @opindex fnext-runtime
1903 Generate output compatible with the NeXT runtime. This is the default
1904 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1905 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1906 used.
1907
1908 @item -fno-nil-receivers
1909 @opindex fno-nil-receivers
1910 Assume that all Objective-C message dispatches (e.g.,
1911 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1912 is not @code{nil}. This allows for more efficient entry points in the runtime
1913 to be used. Currently, this option is only available in conjunction with
1914 the NeXT runtime on Mac OS X 10.3 and later.
1915
1916 @item -fobjc-call-cxx-cdtors
1917 @opindex fobjc-call-cxx-cdtors
1918 For each Objective-C class, check if any of its instance variables is a
1919 C++ object with a non-trivial default constructor. If so, synthesize a
1920 special @code{- (id) .cxx_construct} instance method that will run
1921 non-trivial default constructors on any such instance variables, in order,
1922 and then return @code{self}. Similarly, check if any instance variable
1923 is a C++ object with a non-trivial destructor, and if so, synthesize a
1924 special @code{- (void) .cxx_destruct} method that will run
1925 all such default destructors, in reverse order.
1926
1927 The @code{- (id) .cxx_construct} and/or @code{- (void) .cxx_destruct} methods
1928 thusly generated will only operate on instance variables declared in the
1929 current Objective-C class, and not those inherited from superclasses. It
1930 is the responsibility of the Objective-C runtime to invoke all such methods
1931 in an object's inheritance hierarchy. The @code{- (id) .cxx_construct} methods
1932 will be invoked by the runtime immediately after a new object
1933 instance is allocated; the @code{- (void) .cxx_destruct} methods will
1934 be invoked immediately before the runtime deallocates an object instance.
1935
1936 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
1937 support for invoking the @code{- (id) .cxx_construct} and
1938 @code{- (void) .cxx_destruct} methods.
1939
1940 @item -fobjc-direct-dispatch
1941 @opindex fobjc-direct-dispatch
1942 Allow fast jumps to the message dispatcher. On Darwin this is
1943 accomplished via the comm page.
1944
1945 @item -fobjc-exceptions
1946 @opindex fobjc-exceptions
1947 Enable syntactic support for structured exception handling in Objective-C,
1948 similar to what is offered by C++ and Java. Currently, this option is only
1949 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1950
1951 @smallexample
1952 @@try @{
1953 @dots{}
1954 @@throw expr;
1955 @dots{}
1956 @}
1957 @@catch (AnObjCClass *exc) @{
1958 @dots{}
1959 @@throw expr;
1960 @dots{}
1961 @@throw;
1962 @dots{}
1963 @}
1964 @@catch (AnotherClass *exc) @{
1965 @dots{}
1966 @}
1967 @@catch (id allOthers) @{
1968 @dots{}
1969 @}
1970 @@finally @{
1971 @dots{}
1972 @@throw expr;
1973 @dots{}
1974 @}
1975 @end smallexample
1976
1977 The @code{@@throw} statement may appear anywhere in an Objective-C or
1978 Objective-C++ program; when used inside of a @code{@@catch} block, the
1979 @code{@@throw} may appear without an argument (as shown above), in which case
1980 the object caught by the @code{@@catch} will be rethrown.
1981
1982 Note that only (pointers to) Objective-C objects may be thrown and
1983 caught using this scheme. When an object is thrown, it will be caught
1984 by the nearest @code{@@catch} clause capable of handling objects of that type,
1985 analogously to how @code{catch} blocks work in C++ and Java. A
1986 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1987 any and all Objective-C exceptions not caught by previous @code{@@catch}
1988 clauses (if any).
1989
1990 The @code{@@finally} clause, if present, will be executed upon exit from the
1991 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
1992 regardless of whether any exceptions are thrown, caught or rethrown
1993 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1994 of the @code{finally} clause in Java.
1995
1996 There are several caveats to using the new exception mechanism:
1997
1998 @itemize @bullet
1999 @item
2000 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
2001 idioms provided by the @code{NSException} class, the new
2002 exceptions can only be used on Mac OS X 10.3 (Panther) and later
2003 systems, due to additional functionality needed in the (NeXT) Objective-C
2004 runtime.
2005
2006 @item
2007 As mentioned above, the new exceptions do not support handling
2008 types other than Objective-C objects. Furthermore, when used from
2009 Objective-C++, the Objective-C exception model does not interoperate with C++
2010 exceptions at this time. This means you cannot @code{@@throw} an exception
2011 from Objective-C and @code{catch} it in C++, or vice versa
2012 (i.e., @code{throw @dots{} @@catch}).
2013 @end itemize
2014
2015 The @option{-fobjc-exceptions} switch also enables the use of synchronization
2016 blocks for thread-safe execution:
2017
2018 @smallexample
2019 @@synchronized (ObjCClass *guard) @{
2020 @dots{}
2021 @}
2022 @end smallexample
2023
2024 Upon entering the @code{@@synchronized} block, a thread of execution shall
2025 first check whether a lock has been placed on the corresponding @code{guard}
2026 object by another thread. If it has, the current thread shall wait until
2027 the other thread relinquishes its lock. Once @code{guard} becomes available,
2028 the current thread will place its own lock on it, execute the code contained in
2029 the @code{@@synchronized} block, and finally relinquish the lock (thereby
2030 making @code{guard} available to other threads).
2031
2032 Unlike Java, Objective-C does not allow for entire methods to be marked
2033 @code{@@synchronized}. Note that throwing exceptions out of
2034 @code{@@synchronized} blocks is allowed, and will cause the guarding object
2035 to be unlocked properly.
2036
2037 @item -fobjc-gc
2038 @opindex fobjc-gc
2039 Enable garbage collection (GC) in Objective-C and Objective-C++ programs.
2040
2041 @item -freplace-objc-classes
2042 @opindex freplace-objc-classes
2043 Emit a special marker instructing @command{ld(1)} not to statically link in
2044 the resulting object file, and allow @command{dyld(1)} to load it in at
2045 run time instead. This is used in conjunction with the Fix-and-Continue
2046 debugging mode, where the object file in question may be recompiled and
2047 dynamically reloaded in the course of program execution, without the need
2048 to restart the program itself. Currently, Fix-and-Continue functionality
2049 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2050 and later.
2051
2052 @item -fzero-link
2053 @opindex fzero-link
2054 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2055 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2056 compile time) with static class references that get initialized at load time,
2057 which improves run-time performance. Specifying the @option{-fzero-link} flag
2058 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2059 to be retained. This is useful in Zero-Link debugging mode, since it allows
2060 for individual class implementations to be modified during program execution.
2061
2062 @item -gen-decls
2063 @opindex gen-decls
2064 Dump interface declarations for all classes seen in the source file to a
2065 file named @file{@var{sourcename}.decl}.
2066
2067 @item -Wassign-intercept
2068 @opindex Wassign-intercept
2069 Warn whenever an Objective-C assignment is being intercepted by the
2070 garbage collector.
2071
2072 @item -Wno-protocol
2073 @opindex Wno-protocol
2074 If a class is declared to implement a protocol, a warning is issued for
2075 every method in the protocol that is not implemented by the class. The
2076 default behavior is to issue a warning for every method not explicitly
2077 implemented in the class, even if a method implementation is inherited
2078 from the superclass. If you use the @option{-Wno-protocol} option, then
2079 methods inherited from the superclass are considered to be implemented,
2080 and no warning is issued for them.
2081
2082 @item -Wselector
2083 @opindex Wselector
2084 Warn if multiple methods of different types for the same selector are
2085 found during compilation. The check is performed on the list of methods
2086 in the final stage of compilation. Additionally, a check is performed
2087 for each selector appearing in a @code{@@selector(@dots{})}
2088 expression, and a corresponding method for that selector has been found
2089 during compilation. Because these checks scan the method table only at
2090 the end of compilation, these warnings are not produced if the final
2091 stage of compilation is not reached, for example because an error is
2092 found during compilation, or because the @option{-fsyntax-only} option is
2093 being used.
2094
2095 @item -Wstrict-selector-match
2096 @opindex Wstrict-selector-match
2097 Warn if multiple methods with differing argument and/or return types are
2098 found for a given selector when attempting to send a message using this
2099 selector to a receiver of type @code{id} or @code{Class}. When this flag
2100 is off (which is the default behavior), the compiler will omit such warnings
2101 if any differences found are confined to types which share the same size
2102 and alignment.
2103
2104 @item -Wundeclared-selector
2105 @opindex Wundeclared-selector
2106 Warn if a @code{@@selector(@dots{})} expression referring to an
2107 undeclared selector is found. A selector is considered undeclared if no
2108 method with that name has been declared before the
2109 @code{@@selector(@dots{})} expression, either explicitly in an
2110 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2111 an @code{@@implementation} section. This option always performs its
2112 checks as soon as a @code{@@selector(@dots{})} expression is found,
2113 while @option{-Wselector} only performs its checks in the final stage of
2114 compilation. This also enforces the coding style convention
2115 that methods and selectors must be declared before being used.
2116
2117 @item -print-objc-runtime-info
2118 @opindex print-objc-runtime-info
2119 Generate C header describing the largest structure that is passed by
2120 value, if any.
2121
2122 @end table
2123
2124 @node Language Independent Options
2125 @section Options to Control Diagnostic Messages Formatting
2126 @cindex options to control diagnostics formatting
2127 @cindex diagnostic messages
2128 @cindex message formatting
2129
2130 Traditionally, diagnostic messages have been formatted irrespective of
2131 the output device's aspect (e.g.@: its width, @dots{}). The options described
2132 below can be used to control the diagnostic messages formatting
2133 algorithm, e.g.@: how many characters per line, how often source location
2134 information should be reported. Right now, only the C++ front end can
2135 honor these options. However it is expected, in the near future, that
2136 the remaining front ends would be able to digest them correctly.
2137
2138 @table @gcctabopt
2139 @item -fmessage-length=@var{n}
2140 @opindex fmessage-length
2141 Try to format error messages so that they fit on lines of about @var{n}
2142 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2143 the front ends supported by GCC@. If @var{n} is zero, then no
2144 line-wrapping will be done; each error message will appear on a single
2145 line.
2146
2147 @opindex fdiagnostics-show-location
2148 @item -fdiagnostics-show-location=once
2149 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2150 reporter to emit @emph{once} source location information; that is, in
2151 case the message is too long to fit on a single physical line and has to
2152 be wrapped, the source location won't be emitted (as prefix) again,
2153 over and over, in subsequent continuation lines. This is the default
2154 behavior.
2155
2156 @item -fdiagnostics-show-location=every-line
2157 Only meaningful in line-wrapping mode. Instructs the diagnostic
2158 messages reporter to emit the same source location information (as
2159 prefix) for physical lines that result from the process of breaking
2160 a message which is too long to fit on a single line.
2161
2162 @item -fdiagnostics-show-options
2163 @opindex fdiagnostics-show-options
2164 This option instructs the diagnostic machinery to add text to each
2165 diagnostic emitted, which indicates which command line option directly
2166 controls that diagnostic, when such an option is known to the
2167 diagnostic machinery.
2168
2169 @end table
2170
2171 @node Warning Options
2172 @section Options to Request or Suppress Warnings
2173 @cindex options to control warnings
2174 @cindex warning messages
2175 @cindex messages, warning
2176 @cindex suppressing warnings
2177
2178 Warnings are diagnostic messages that report constructions which
2179 are not inherently erroneous but which are risky or suggest there
2180 may have been an error.
2181
2182 You can request many specific warnings with options beginning @samp{-W},
2183 for example @option{-Wimplicit} to request warnings on implicit
2184 declarations. Each of these specific warning options also has a
2185 negative form beginning @samp{-Wno-} to turn off warnings;
2186 for example, @option{-Wno-implicit}. This manual lists only one of the
2187 two forms, whichever is not the default.
2188
2189 The following options control the amount and kinds of warnings produced
2190 by GCC; for further, language-specific options also refer to
2191 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2192 Options}.
2193
2194 @table @gcctabopt
2195 @cindex syntax checking
2196 @item -fsyntax-only
2197 @opindex fsyntax-only
2198 Check the code for syntax errors, but don't do anything beyond that.
2199
2200 @item -pedantic
2201 @opindex pedantic
2202 Issue all the warnings demanded by strict ISO C and ISO C++;
2203 reject all programs that use forbidden extensions, and some other
2204 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2205 version of the ISO C standard specified by any @option{-std} option used.
2206
2207 Valid ISO C and ISO C++ programs should compile properly with or without
2208 this option (though a rare few will require @option{-ansi} or a
2209 @option{-std} option specifying the required version of ISO C)@. However,
2210 without this option, certain GNU extensions and traditional C and C++
2211 features are supported as well. With this option, they are rejected.
2212
2213 @option{-pedantic} does not cause warning messages for use of the
2214 alternate keywords whose names begin and end with @samp{__}. Pedantic
2215 warnings are also disabled in the expression that follows
2216 @code{__extension__}. However, only system header files should use
2217 these escape routes; application programs should avoid them.
2218 @xref{Alternate Keywords}.
2219
2220 Some users try to use @option{-pedantic} to check programs for strict ISO
2221 C conformance. They soon find that it does not do quite what they want:
2222 it finds some non-ISO practices, but not all---only those for which
2223 ISO C @emph{requires} a diagnostic, and some others for which
2224 diagnostics have been added.
2225
2226 A feature to report any failure to conform to ISO C might be useful in
2227 some instances, but would require considerable additional work and would
2228 be quite different from @option{-pedantic}. We don't have plans to
2229 support such a feature in the near future.
2230
2231 Where the standard specified with @option{-std} represents a GNU
2232 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2233 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2234 extended dialect is based. Warnings from @option{-pedantic} are given
2235 where they are required by the base standard. (It would not make sense
2236 for such warnings to be given only for features not in the specified GNU
2237 C dialect, since by definition the GNU dialects of C include all
2238 features the compiler supports with the given option, and there would be
2239 nothing to warn about.)
2240
2241 @item -pedantic-errors
2242 @opindex pedantic-errors
2243 Like @option{-pedantic}, except that errors are produced rather than
2244 warnings.
2245
2246 @item -w
2247 @opindex w
2248 Inhibit all warning messages.
2249
2250 @item -Wno-import
2251 @opindex Wno-import
2252 Inhibit warning messages about the use of @samp{#import}.
2253
2254 @item -Wchar-subscripts
2255 @opindex Wchar-subscripts
2256 Warn if an array subscript has type @code{char}. This is a common cause
2257 of error, as programmers often forget that this type is signed on some
2258 machines.
2259 This warning is enabled by @option{-Wall}.
2260
2261 @item -Wcomment
2262 @opindex Wcomment
2263 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2264 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2265 This warning is enabled by @option{-Wall}.
2266
2267 @item -Wfatal-errors
2268 @opindex Wfatal-errors
2269 This option causes the compiler to abort compilation on the first error
2270 occurred rather than trying to keep going and printing further error
2271 messages.
2272
2273 @item -Wformat
2274 @opindex Wformat
2275 @opindex ffreestanding
2276 @opindex fno-builtin
2277 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2278 the arguments supplied have types appropriate to the format string
2279 specified, and that the conversions specified in the format string make
2280 sense. This includes standard functions, and others specified by format
2281 attributes (@pxref{Function Attributes}), in the @code{printf},
2282 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2283 not in the C standard) families (or other target-specific families).
2284 Which functions are checked without format attributes having been
2285 specified depends on the standard version selected, and such checks of
2286 functions without the attribute specified are disabled by
2287 @option{-ffreestanding} or @option{-fno-builtin}.
2288
2289 The formats are checked against the format features supported by GNU
2290 libc version 2.2. These include all ISO C90 and C99 features, as well
2291 as features from the Single Unix Specification and some BSD and GNU
2292 extensions. Other library implementations may not support all these
2293 features; GCC does not support warning about features that go beyond a
2294 particular library's limitations. However, if @option{-pedantic} is used
2295 with @option{-Wformat}, warnings will be given about format features not
2296 in the selected standard version (but not for @code{strfmon} formats,
2297 since those are not in any version of the C standard). @xref{C Dialect
2298 Options,,Options Controlling C Dialect}.
2299
2300 Since @option{-Wformat} also checks for null format arguments for
2301 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2302
2303 @option{-Wformat} is included in @option{-Wall}. For more control over some
2304 aspects of format checking, the options @option{-Wformat-y2k},
2305 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2306 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2307 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2308
2309 @item -Wformat-y2k
2310 @opindex Wformat-y2k
2311 If @option{-Wformat} is specified, also warn about @code{strftime}
2312 formats which may yield only a two-digit year.
2313
2314 @item -Wno-format-extra-args
2315 @opindex Wno-format-extra-args
2316 If @option{-Wformat} is specified, do not warn about excess arguments to a
2317 @code{printf} or @code{scanf} format function. The C standard specifies
2318 that such arguments are ignored.
2319
2320 Where the unused arguments lie between used arguments that are
2321 specified with @samp{$} operand number specifications, normally
2322 warnings are still given, since the implementation could not know what
2323 type to pass to @code{va_arg} to skip the unused arguments. However,
2324 in the case of @code{scanf} formats, this option will suppress the
2325 warning if the unused arguments are all pointers, since the Single
2326 Unix Specification says that such unused arguments are allowed.
2327
2328 @item -Wno-format-zero-length
2329 @opindex Wno-format-zero-length
2330 If @option{-Wformat} is specified, do not warn about zero-length formats.
2331 The C standard specifies that zero-length formats are allowed.
2332
2333 @item -Wformat-nonliteral
2334 @opindex Wformat-nonliteral
2335 If @option{-Wformat} is specified, also warn if the format string is not a
2336 string literal and so cannot be checked, unless the format function
2337 takes its format arguments as a @code{va_list}.
2338
2339 @item -Wformat-security
2340 @opindex Wformat-security
2341 If @option{-Wformat} is specified, also warn about uses of format
2342 functions that represent possible security problems. At present, this
2343 warns about calls to @code{printf} and @code{scanf} functions where the
2344 format string is not a string literal and there are no format arguments,
2345 as in @code{printf (foo);}. This may be a security hole if the format
2346 string came from untrusted input and contains @samp{%n}. (This is
2347 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2348 in future warnings may be added to @option{-Wformat-security} that are not
2349 included in @option{-Wformat-nonliteral}.)
2350
2351 @item -Wformat=2
2352 @opindex Wformat=2
2353 Enable @option{-Wformat} plus format checks not included in
2354 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2355 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2356
2357 @item -Wnonnull
2358 @opindex Wnonnull
2359 Warn about passing a null pointer for arguments marked as
2360 requiring a non-null value by the @code{nonnull} function attribute.
2361
2362 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2363 can be disabled with the @option{-Wno-nonnull} option.
2364
2365 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2366 @opindex Winit-self
2367 Warn about uninitialized variables which are initialized with themselves.
2368 Note this option can only be used with the @option{-Wuninitialized} option,
2369 which in turn only works with @option{-O1} and above.
2370
2371 For example, GCC will warn about @code{i} being uninitialized in the
2372 following snippet only when @option{-Winit-self} has been specified:
2373 @smallexample
2374 @group
2375 int f()
2376 @{
2377 int i = i;
2378 return i;
2379 @}
2380 @end group
2381 @end smallexample
2382
2383 @item -Wimplicit-int
2384 @opindex Wimplicit-int
2385 Warn when a declaration does not specify a type.
2386 This warning is enabled by @option{-Wall}.
2387
2388 @item -Wimplicit-function-declaration
2389 @itemx -Werror-implicit-function-declaration
2390 @opindex Wimplicit-function-declaration
2391 @opindex Werror-implicit-function-declaration
2392 Give a warning (or error) whenever a function is used before being
2393 declared. The form @option{-Wno-error-implicit-function-declaration}
2394 is not supported.
2395 This warning is enabled by @option{-Wall} (as a warning, not an error).
2396
2397 @item -Wimplicit
2398 @opindex Wimplicit
2399 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2400 This warning is enabled by @option{-Wall}.
2401
2402 @item -Wmain
2403 @opindex Wmain
2404 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2405 function with external linkage, returning int, taking either zero
2406 arguments, two, or three arguments of appropriate types.
2407 This warning is enabled by @option{-Wall}.
2408
2409 @item -Wmissing-braces
2410 @opindex Wmissing-braces
2411 Warn if an aggregate or union initializer is not fully bracketed. In
2412 the following example, the initializer for @samp{a} is not fully
2413 bracketed, but that for @samp{b} is fully bracketed.
2414
2415 @smallexample
2416 int a[2][2] = @{ 0, 1, 2, 3 @};
2417 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2418 @end smallexample
2419
2420 This warning is enabled by @option{-Wall}.
2421
2422 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2423 @opindex Wmissing-include-dirs
2424 Warn if a user-supplied include directory does not exist.
2425
2426 @item -Wparentheses
2427 @opindex Wparentheses
2428 Warn if parentheses are omitted in certain contexts, such
2429 as when there is an assignment in a context where a truth value
2430 is expected, or when operators are nested whose precedence people
2431 often get confused about. Only the warning for an assignment used as
2432 a truth value is supported when compiling C++; the other warnings are
2433 only supported when compiling C@.
2434
2435 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2436 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2437 interpretation from that of ordinary mathematical notation.
2438
2439 Also warn about constructions where there may be confusion to which
2440 @code{if} statement an @code{else} branch belongs. Here is an example of
2441 such a case:
2442
2443 @smallexample
2444 @group
2445 @{
2446 if (a)
2447 if (b)
2448 foo ();
2449 else
2450 bar ();
2451 @}
2452 @end group
2453 @end smallexample
2454
2455 In C, every @code{else} branch belongs to the innermost possible @code{if}
2456 statement, which in this example is @code{if (b)}. This is often not
2457 what the programmer expected, as illustrated in the above example by
2458 indentation the programmer chose. When there is the potential for this
2459 confusion, GCC will issue a warning when this flag is specified.
2460 To eliminate the warning, add explicit braces around the innermost
2461 @code{if} statement so there is no way the @code{else} could belong to
2462 the enclosing @code{if}. The resulting code would look like this:
2463
2464 @smallexample
2465 @group
2466 @{
2467 if (a)
2468 @{
2469 if (b)
2470 foo ();
2471 else
2472 bar ();
2473 @}
2474 @}
2475 @end group
2476 @end smallexample
2477
2478 This warning is enabled by @option{-Wall}.
2479
2480 @item -Wsequence-point
2481 @opindex Wsequence-point
2482 Warn about code that may have undefined semantics because of violations
2483 of sequence point rules in the C standard.
2484
2485 The C standard defines the order in which expressions in a C program are
2486 evaluated in terms of @dfn{sequence points}, which represent a partial
2487 ordering between the execution of parts of the program: those executed
2488 before the sequence point, and those executed after it. These occur
2489 after the evaluation of a full expression (one which is not part of a
2490 larger expression), after the evaluation of the first operand of a
2491 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2492 function is called (but after the evaluation of its arguments and the
2493 expression denoting the called function), and in certain other places.
2494 Other than as expressed by the sequence point rules, the order of
2495 evaluation of subexpressions of an expression is not specified. All
2496 these rules describe only a partial order rather than a total order,
2497 since, for example, if two functions are called within one expression
2498 with no sequence point between them, the order in which the functions
2499 are called is not specified. However, the standards committee have
2500 ruled that function calls do not overlap.
2501
2502 It is not specified when between sequence points modifications to the
2503 values of objects take effect. Programs whose behavior depends on this
2504 have undefined behavior; the C standard specifies that ``Between the
2505 previous and next sequence point an object shall have its stored value
2506 modified at most once by the evaluation of an expression. Furthermore,
2507 the prior value shall be read only to determine the value to be
2508 stored.''. If a program breaks these rules, the results on any
2509 particular implementation are entirely unpredictable.
2510
2511 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2512 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2513 diagnosed by this option, and it may give an occasional false positive
2514 result, but in general it has been found fairly effective at detecting
2515 this sort of problem in programs.
2516
2517 The present implementation of this option only works for C programs. A
2518 future implementation may also work for C++ programs.
2519
2520 The C standard is worded confusingly, therefore there is some debate
2521 over the precise meaning of the sequence point rules in subtle cases.
2522 Links to discussions of the problem, including proposed formal
2523 definitions, may be found on the GCC readings page, at
2524 @w{@uref{http://gcc.gnu.org/readings.html}}.
2525
2526 This warning is enabled by @option{-Wall}.
2527
2528 @item -Wreturn-type
2529 @opindex Wreturn-type
2530 Warn whenever a function is defined with a return-type that defaults to
2531 @code{int}. Also warn about any @code{return} statement with no
2532 return-value in a function whose return-type is not @code{void}.
2533
2534 For C, also warn if the return type of a function has a type qualifier
2535 such as @code{const}. Such a type qualifier has no effect, since the
2536 value returned by a function is not an lvalue. ISO C prohibits
2537 qualified @code{void} return types on function definitions, so such
2538 return types always receive a warning even without this option.
2539
2540 For C++, a function without return type always produces a diagnostic
2541 message, even when @option{-Wno-return-type} is specified. The only
2542 exceptions are @samp{main} and functions defined in system headers.
2543
2544 This warning is enabled by @option{-Wall}.
2545
2546 @item -Wswitch
2547 @opindex Wswitch
2548 Warn whenever a @code{switch} statement has an index of enumerated type
2549 and lacks a @code{case} for one or more of the named codes of that
2550 enumeration. (The presence of a @code{default} label prevents this
2551 warning.) @code{case} labels outside the enumeration range also
2552 provoke warnings when this option is used.
2553 This warning is enabled by @option{-Wall}.
2554
2555 @item -Wswitch-default
2556 @opindex Wswitch-switch
2557 Warn whenever a @code{switch} statement does not have a @code{default}
2558 case.
2559
2560 @item -Wswitch-enum
2561 @opindex Wswitch-enum
2562 Warn whenever a @code{switch} statement has an index of enumerated type
2563 and lacks a @code{case} for one or more of the named codes of that
2564 enumeration. @code{case} labels outside the enumeration range also
2565 provoke warnings when this option is used.
2566
2567 @item -Wtrigraphs
2568 @opindex Wtrigraphs
2569 Warn if any trigraphs are encountered that might change the meaning of
2570 the program (trigraphs within comments are not warned about).
2571 This warning is enabled by @option{-Wall}.
2572
2573 @item -Wunused-function
2574 @opindex Wunused-function
2575 Warn whenever a static function is declared but not defined or a
2576 non\-inline static function is unused.
2577 This warning is enabled by @option{-Wall}.
2578
2579 @item -Wunused-label
2580 @opindex Wunused-label
2581 Warn whenever a label is declared but not used.
2582 This warning is enabled by @option{-Wall}.
2583
2584 To suppress this warning use the @samp{unused} attribute
2585 (@pxref{Variable Attributes}).
2586
2587 @item -Wunused-parameter
2588 @opindex Wunused-parameter
2589 Warn whenever a function parameter is unused aside from its declaration.
2590
2591 To suppress this warning use the @samp{unused} attribute
2592 (@pxref{Variable Attributes}).
2593
2594 @item -Wunused-variable
2595 @opindex Wunused-variable
2596 Warn whenever a local variable or non-constant static variable is unused
2597 aside from its declaration
2598 This warning is enabled by @option{-Wall}.
2599
2600 To suppress this warning use the @samp{unused} attribute
2601 (@pxref{Variable Attributes}).
2602
2603 @item -Wunused-value
2604 @opindex Wunused-value
2605 Warn whenever a statement computes a result that is explicitly not used.
2606 This warning is enabled by @option{-Wall}.
2607
2608 To suppress this warning cast the expression to @samp{void}.
2609
2610 @item -Wunused
2611 @opindex Wunused
2612 All the above @option{-Wunused} options combined.
2613
2614 In order to get a warning about an unused function parameter, you must
2615 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2616 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2617
2618 @item -Wuninitialized
2619 @opindex Wuninitialized
2620 Warn if an automatic variable is used without first being initialized or
2621 if a variable may be clobbered by a @code{setjmp} call.
2622
2623 These warnings are possible only in optimizing compilation,
2624 because they require data flow information that is computed only
2625 when optimizing. If you don't specify @option{-O}, you simply won't
2626 get these warnings.
2627
2628 If you want to warn about code which uses the uninitialized value of the
2629 variable in its own initializer, use the @option{-Winit-self} option.
2630
2631 These warnings occur for individual uninitialized or clobbered
2632 elements of structure, union or array variables as well as for
2633 variables which are uninitialized or clobbered as a whole. They do
2634 not occur for variables or elements declared @code{volatile}. Because
2635 these warnings depend on optimization, the exact variables or elements
2636 for which there are warnings will depend on the precise optimization
2637 options and version of GCC used.
2638
2639 Note that there may be no warning about a variable that is used only
2640 to compute a value that itself is never used, because such
2641 computations may be deleted by data flow analysis before the warnings
2642 are printed.
2643
2644 These warnings are made optional because GCC is not smart
2645 enough to see all the reasons why the code might be correct
2646 despite appearing to have an error. Here is one example of how
2647 this can happen:
2648
2649 @smallexample
2650 @group
2651 @{
2652 int x;
2653 switch (y)
2654 @{
2655 case 1: x = 1;
2656 break;
2657 case 2: x = 4;
2658 break;
2659 case 3: x = 5;
2660 @}
2661 foo (x);
2662 @}
2663 @end group
2664 @end smallexample
2665
2666 @noindent
2667 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2668 always initialized, but GCC doesn't know this. Here is
2669 another common case:
2670
2671 @smallexample
2672 @{
2673 int save_y;
2674 if (change_y) save_y = y, y = new_y;
2675 @dots{}
2676 if (change_y) y = save_y;
2677 @}
2678 @end smallexample
2679
2680 @noindent
2681 This has no bug because @code{save_y} is used only if it is set.
2682
2683 @cindex @code{longjmp} warnings
2684 This option also warns when a non-volatile automatic variable might be
2685 changed by a call to @code{longjmp}. These warnings as well are possible
2686 only in optimizing compilation.
2687
2688 The compiler sees only the calls to @code{setjmp}. It cannot know
2689 where @code{longjmp} will be called; in fact, a signal handler could
2690 call it at any point in the code. As a result, you may get a warning
2691 even when there is in fact no problem because @code{longjmp} cannot
2692 in fact be called at the place which would cause a problem.
2693
2694 Some spurious warnings can be avoided if you declare all the functions
2695 you use that never return as @code{noreturn}. @xref{Function
2696 Attributes}.
2697
2698 This warning is enabled by @option{-Wall}.
2699
2700 @item -Wunknown-pragmas
2701 @opindex Wunknown-pragmas
2702 @cindex warning for unknown pragmas
2703 @cindex unknown pragmas, warning
2704 @cindex pragmas, warning of unknown
2705 Warn when a #pragma directive is encountered which is not understood by
2706 GCC@. If this command line option is used, warnings will even be issued
2707 for unknown pragmas in system header files. This is not the case if
2708 the warnings were only enabled by the @option{-Wall} command line option.
2709
2710 @item -Wstrict-aliasing
2711 @opindex Wstrict-aliasing
2712 This option is only active when @option{-fstrict-aliasing} is active.
2713 It warns about code which might break the strict aliasing rules that the
2714 compiler is using for optimization. The warning does not catch all
2715 cases, but does attempt to catch the more common pitfalls. It is
2716 included in @option{-Wall}.
2717
2718 @item -Wstrict-aliasing=2
2719 @opindex Wstrict-aliasing=2
2720 This option is only active when @option{-fstrict-aliasing} is active.
2721 It warns about all code which might break the strict aliasing rules that the
2722 compiler is using for optimization. This warning catches all cases, but
2723 it will also give a warning for some ambiguous cases that are safe.
2724
2725 @item -Wall
2726 @opindex Wall
2727 All of the above @samp{-W} options combined. This enables all the
2728 warnings about constructions that some users consider questionable, and
2729 that are easy to avoid (or modify to prevent the warning), even in
2730 conjunction with macros. This also enables some language-specific
2731 warnings described in @ref{C++ Dialect Options} and
2732 @ref{Objective-C and Objective-C++ Dialect Options}.
2733 @end table
2734
2735 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2736 Some of them warn about constructions that users generally do not
2737 consider questionable, but which occasionally you might wish to check
2738 for; others warn about constructions that are necessary or hard to avoid
2739 in some cases, and there is no simple way to modify the code to suppress
2740 the warning.
2741
2742 @table @gcctabopt
2743 @item -Wextra
2744 @opindex W
2745 @opindex Wextra
2746 (This option used to be called @option{-W}. The older name is still
2747 supported, but the newer name is more descriptive.) Print extra warning
2748 messages for these events:
2749
2750 @itemize @bullet
2751 @item
2752 A function can return either with or without a value. (Falling
2753 off the end of the function body is considered returning without
2754 a value.) For example, this function would evoke such a
2755 warning:
2756
2757 @smallexample
2758 @group
2759 foo (a)
2760 @{
2761 if (a > 0)
2762 return a;
2763 @}
2764 @end group
2765 @end smallexample
2766
2767 @item
2768 An expression-statement or the left-hand side of a comma expression
2769 contains no side effects.
2770 To suppress the warning, cast the unused expression to void.
2771 For example, an expression such as @samp{x[i,j]} will cause a warning,
2772 but @samp{x[(void)i,j]} will not.
2773
2774 @item
2775 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2776
2777 @item
2778 Storage-class specifiers like @code{static} are not the first things in
2779 a declaration. According to the C Standard, this usage is obsolescent.
2780
2781 @item
2782 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2783 arguments.
2784
2785 @item
2786 A comparison between signed and unsigned values could produce an
2787 incorrect result when the signed value is converted to unsigned.
2788 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2789
2790 @item
2791 An aggregate has an initializer which does not initialize all members.
2792 This warning can be independently controlled by
2793 @option{-Wmissing-field-initializers}.
2794
2795 @item
2796 A function parameter is declared without a type specifier in K&R-style
2797 functions:
2798
2799 @smallexample
2800 void foo(bar) @{ @}
2801 @end smallexample
2802
2803 @item
2804 An empty body occurs in an @samp{if} or @samp{else} statement.
2805
2806 @item
2807 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2808 @samp{>}, or @samp{>=}.
2809
2810 @item
2811 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2812
2813 @item
2814 Any of several floating-point events that often indicate errors, such as
2815 overflow, underflow, loss of precision, etc.
2816
2817 @item @r{(C++ only)}
2818 An enumerator and a non-enumerator both appear in a conditional expression.
2819
2820 @item @r{(C++ only)}
2821 A non-static reference or non-static @samp{const} member appears in a
2822 class without constructors.
2823
2824 @item @r{(C++ only)}
2825 Ambiguous virtual bases.
2826
2827 @item @r{(C++ only)}
2828 Subscripting an array which has been declared @samp{register}.
2829
2830 @item @r{(C++ only)}
2831 Taking the address of a variable which has been declared @samp{register}.
2832
2833 @item @r{(C++ only)}
2834 A base class is not initialized in a derived class' copy constructor.
2835 @end itemize
2836
2837 @item -Wno-div-by-zero
2838 @opindex Wno-div-by-zero
2839 @opindex Wdiv-by-zero
2840 Do not warn about compile-time integer division by zero. Floating point
2841 division by zero is not warned about, as it can be a legitimate way of
2842 obtaining infinities and NaNs.
2843
2844 @item -Wsystem-headers
2845 @opindex Wsystem-headers
2846 @cindex warnings from system headers
2847 @cindex system headers, warnings from
2848 Print warning messages for constructs found in system header files.
2849 Warnings from system headers are normally suppressed, on the assumption
2850 that they usually do not indicate real problems and would only make the
2851 compiler output harder to read. Using this command line option tells
2852 GCC to emit warnings from system headers as if they occurred in user
2853 code. However, note that using @option{-Wall} in conjunction with this
2854 option will @emph{not} warn about unknown pragmas in system
2855 headers---for that, @option{-Wunknown-pragmas} must also be used.
2856
2857 @item -Wfloat-equal
2858 @opindex Wfloat-equal
2859 Warn if floating point values are used in equality comparisons.
2860
2861 The idea behind this is that sometimes it is convenient (for the
2862 programmer) to consider floating-point values as approximations to
2863 infinitely precise real numbers. If you are doing this, then you need
2864 to compute (by analyzing the code, or in some other way) the maximum or
2865 likely maximum error that the computation introduces, and allow for it
2866 when performing comparisons (and when producing output, but that's a
2867 different problem). In particular, instead of testing for equality, you
2868 would check to see whether the two values have ranges that overlap; and
2869 this is done with the relational operators, so equality comparisons are
2870 probably mistaken.
2871
2872 @item -Wtraditional @r{(C only)}
2873 @opindex Wtraditional
2874 Warn about certain constructs that behave differently in traditional and
2875 ISO C@. Also warn about ISO C constructs that have no traditional C
2876 equivalent, and/or problematic constructs which should be avoided.
2877
2878 @itemize @bullet
2879 @item
2880 Macro parameters that appear within string literals in the macro body.
2881 In traditional C macro replacement takes place within string literals,
2882 but does not in ISO C@.
2883
2884 @item
2885 In traditional C, some preprocessor directives did not exist.
2886 Traditional preprocessors would only consider a line to be a directive
2887 if the @samp{#} appeared in column 1 on the line. Therefore
2888 @option{-Wtraditional} warns about directives that traditional C
2889 understands but would ignore because the @samp{#} does not appear as the
2890 first character on the line. It also suggests you hide directives like
2891 @samp{#pragma} not understood by traditional C by indenting them. Some
2892 traditional implementations would not recognize @samp{#elif}, so it
2893 suggests avoiding it altogether.
2894
2895 @item
2896 A function-like macro that appears without arguments.
2897
2898 @item
2899 The unary plus operator.
2900
2901 @item
2902 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2903 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2904 constants.) Note, these suffixes appear in macros defined in the system
2905 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2906 Use of these macros in user code might normally lead to spurious
2907 warnings, however GCC's integrated preprocessor has enough context to
2908 avoid warning in these cases.
2909
2910 @item
2911 A function declared external in one block and then used after the end of
2912 the block.
2913
2914 @item
2915 A @code{switch} statement has an operand of type @code{long}.
2916
2917 @item
2918 A non-@code{static} function declaration follows a @code{static} one.
2919 This construct is not accepted by some traditional C compilers.
2920
2921 @item
2922 The ISO type of an integer constant has a different width or
2923 signedness from its traditional type. This warning is only issued if
2924 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2925 typically represent bit patterns, are not warned about.
2926
2927 @item
2928 Usage of ISO string concatenation is detected.
2929
2930 @item
2931 Initialization of automatic aggregates.
2932
2933 @item
2934 Identifier conflicts with labels. Traditional C lacks a separate
2935 namespace for labels.
2936
2937 @item
2938 Initialization of unions. If the initializer is zero, the warning is
2939 omitted. This is done under the assumption that the zero initializer in
2940 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2941 initializer warnings and relies on default initialization to zero in the
2942 traditional C case.
2943
2944 @item
2945 Conversions by prototypes between fixed/floating point values and vice
2946 versa. The absence of these prototypes when compiling with traditional
2947 C would cause serious problems. This is a subset of the possible
2948 conversion warnings, for the full set use @option{-Wconversion}.
2949
2950 @item
2951 Use of ISO C style function definitions. This warning intentionally is
2952 @emph{not} issued for prototype declarations or variadic functions
2953 because these ISO C features will appear in your code when using
2954 libiberty's traditional C compatibility macros, @code{PARAMS} and
2955 @code{VPARAMS}. This warning is also bypassed for nested functions
2956 because that feature is already a GCC extension and thus not relevant to
2957 traditional C compatibility.
2958 @end itemize
2959
2960 @item -Wdeclaration-after-statement @r{(C only)}
2961 @opindex Wdeclaration-after-statement
2962 Warn when a declaration is found after a statement in a block. This
2963 construct, known from C++, was introduced with ISO C99 and is by default
2964 allowed in GCC@. It is not supported by ISO C90 and was not supported by
2965 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
2966
2967 @item -Wundef
2968 @opindex Wundef
2969 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2970
2971 @item -Wno-endif-labels
2972 @opindex Wno-endif-labels
2973 @opindex Wendif-labels
2974 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2975
2976 @item -Wshadow
2977 @opindex Wshadow
2978 Warn whenever a local variable shadows another local variable, parameter or
2979 global variable or whenever a built-in function is shadowed.
2980
2981 @item -Wlarger-than-@var{len}
2982 @opindex Wlarger-than
2983 Warn whenever an object of larger than @var{len} bytes is defined.
2984
2985 @item -Wpointer-arith
2986 @opindex Wpointer-arith
2987 Warn about anything that depends on the ``size of'' a function type or
2988 of @code{void}. GNU C assigns these types a size of 1, for
2989 convenience in calculations with @code{void *} pointers and pointers
2990 to functions.
2991
2992 @item -Wbad-function-cast @r{(C only)}
2993 @opindex Wbad-function-cast
2994 Warn whenever a function call is cast to a non-matching type.
2995 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2996
2997 @item -Wc++-compat
2998 Warn about ISO C constructs that are outside of the common subset of
2999 ISO C and ISO C++, e.g.@: request for implicit conversion from
3000 @code{void *} to a pointer to non-@code{void} type.
3001
3002 @item -Wcast-qual
3003 @opindex Wcast-qual
3004 Warn whenever a pointer is cast so as to remove a type qualifier from
3005 the target type. For example, warn if a @code{const char *} is cast
3006 to an ordinary @code{char *}.
3007
3008 @item -Wcast-align
3009 @opindex Wcast-align
3010 Warn whenever a pointer is cast such that the required alignment of the
3011 target is increased. For example, warn if a @code{char *} is cast to
3012 an @code{int *} on machines where integers can only be accessed at
3013 two- or four-byte boundaries.
3014
3015 @item -Wwrite-strings
3016 @opindex Wwrite-strings
3017 When compiling C, give string constants the type @code{const
3018 char[@var{length}]} so that
3019 copying the address of one into a non-@code{const} @code{char *}
3020 pointer will get a warning; when compiling C++, warn about the
3021 deprecated conversion from string constants to @code{char *}.
3022 These warnings will help you find at
3023 compile time code that can try to write into a string constant, but
3024 only if you have been very careful about using @code{const} in
3025 declarations and prototypes. Otherwise, it will just be a nuisance;
3026 this is why we did not make @option{-Wall} request these warnings.
3027
3028 @item -Wconversion
3029 @opindex Wconversion
3030 Warn if a prototype causes a type conversion that is different from what
3031 would happen to the same argument in the absence of a prototype. This
3032 includes conversions of fixed point to floating and vice versa, and
3033 conversions changing the width or signedness of a fixed point argument
3034 except when the same as the default promotion.
3035
3036 Also, warn if a negative integer constant expression is implicitly
3037 converted to an unsigned type. For example, warn about the assignment
3038 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
3039 casts like @code{(unsigned) -1}.
3040
3041 @item -Wsign-compare
3042 @opindex Wsign-compare
3043 @cindex warning for comparison of signed and unsigned values
3044 @cindex comparison of signed and unsigned values, warning
3045 @cindex signed and unsigned values, comparison warning
3046 Warn when a comparison between signed and unsigned values could produce
3047 an incorrect result when the signed value is converted to unsigned.
3048 This warning is also enabled by @option{-Wextra}; to get the other warnings
3049 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
3050
3051 @item -Waggregate-return
3052 @opindex Waggregate-return
3053 Warn if any functions that return structures or unions are defined or
3054 called. (In languages where you can return an array, this also elicits
3055 a warning.)
3056
3057 @item -Wno-attributes
3058 @opindex Wno-attributes
3059 @opindex Wattributes
3060 Do not warn if an unexpected @code{__attribute__} is used, such as
3061 unrecognized attributes, function attributes applied to variables,
3062 etc. This will not stop errors for incorrect use of supported
3063 attributes.
3064
3065 @item -Wstrict-prototypes @r{(C only)}
3066 @opindex Wstrict-prototypes
3067 Warn if a function is declared or defined without specifying the
3068 argument types. (An old-style function definition is permitted without
3069 a warning if preceded by a declaration which specifies the argument
3070 types.)
3071
3072 @item -Wold-style-definition @r{(C only)}
3073 @opindex Wold-style-definition
3074 Warn if an old-style function definition is used. A warning is given
3075 even if there is a previous prototype.
3076
3077 @item -Wmissing-prototypes @r{(C only)}
3078 @opindex Wmissing-prototypes
3079 Warn if a global function is defined without a previous prototype
3080 declaration. This warning is issued even if the definition itself
3081 provides a prototype. The aim is to detect global functions that fail
3082 to be declared in header files.
3083
3084 @item -Wmissing-declarations @r{(C only)}
3085 @opindex Wmissing-declarations
3086 Warn if a global function is defined without a previous declaration.
3087 Do so even if the definition itself provides a prototype.
3088 Use this option to detect global functions that are not declared in
3089 header files.
3090
3091 @item -Wmissing-field-initializers
3092 @opindex Wmissing-field-initializers
3093 @opindex W
3094 @opindex Wextra
3095 Warn if a structure's initializer has some fields missing. For
3096 example, the following code would cause such a warning, because
3097 @code{x.h} is implicitly zero:
3098
3099 @smallexample
3100 struct s @{ int f, g, h; @};
3101 struct s x = @{ 3, 4 @};
3102 @end smallexample
3103
3104 This option does not warn about designated initializers, so the following
3105 modification would not trigger a warning:
3106
3107 @smallexample
3108 struct s @{ int f, g, h; @};
3109 struct s x = @{ .f = 3, .g = 4 @};
3110 @end smallexample
3111
3112 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3113 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3114
3115 @item -Wmissing-noreturn
3116 @opindex Wmissing-noreturn
3117 Warn about functions which might be candidates for attribute @code{noreturn}.
3118 Note these are only possible candidates, not absolute ones. Care should
3119 be taken to manually verify functions actually do not ever return before
3120 adding the @code{noreturn} attribute, otherwise subtle code generation
3121 bugs could be introduced. You will not get a warning for @code{main} in
3122 hosted C environments.
3123
3124 @item -Wmissing-format-attribute
3125 @opindex Wmissing-format-attribute
3126 @opindex Wformat
3127 If @option{-Wformat} is enabled, also warn about functions which might be
3128 candidates for @code{format} attributes. Note these are only possible
3129 candidates, not absolute ones. GCC will guess that @code{format}
3130 attributes might be appropriate for any function that calls a function
3131 like @code{vprintf} or @code{vscanf}, but this might not always be the
3132 case, and some functions for which @code{format} attributes are
3133 appropriate may not be detected. This option has no effect unless
3134 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3135
3136 @item -Wno-multichar
3137 @opindex Wno-multichar
3138 @opindex Wmultichar
3139 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3140 Usually they indicate a typo in the user's code, as they have
3141 implementation-defined values, and should not be used in portable code.
3142
3143 @item -Wnormalized=<none|id|nfc|nfkc>
3144 @opindex Wnormalized
3145 @cindex NFC
3146 @cindex NFKC
3147 @cindex character set, input normalization
3148 In ISO C and ISO C++, two identifiers are different if they are
3149 different sequences of characters. However, sometimes when characters
3150 outside the basic ASCII character set are used, you can have two
3151 different character sequences that look the same. To avoid confusion,
3152 the ISO 10646 standard sets out some @dfn{normalization rules} which
3153 when applied ensure that two sequences that look the same are turned into
3154 the same sequence. GCC can warn you if you are using identifiers which
3155 have not been normalized; this option controls that warning.
3156
3157 There are four levels of warning that GCC supports. The default is
3158 @option{-Wnormalized=nfc}, which warns about any identifier which is
3159 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3160 recommended form for most uses.
3161
3162 Unfortunately, there are some characters which ISO C and ISO C++ allow
3163 in identifiers that when turned into NFC aren't allowable as
3164 identifiers. That is, there's no way to use these symbols in portable
3165 ISO C or C++ and have all your identifiers in NFC.
3166 @option{-Wnormalized=id} suppresses the warning for these characters.
3167 It is hoped that future versions of the standards involved will correct
3168 this, which is why this option is not the default.
3169
3170 You can switch the warning off for all characters by writing
3171 @option{-Wnormalized=none}. You would only want to do this if you
3172 were using some other normalization scheme (like ``D''), because
3173 otherwise you can easily create bugs that are literally impossible to see.
3174
3175 Some characters in ISO 10646 have distinct meanings but look identical
3176 in some fonts or display methodologies, especially once formatting has
3177 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3178 LETTER N'', will display just like a regular @code{n} which has been
3179 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3180 normalisation scheme to convert all these into a standard form as
3181 well, and GCC will warn if your code is not in NFKC if you use
3182 @option{-Wnormalized=nfkc}. This warning is comparable to warning
3183 about every identifier that contains the letter O because it might be
3184 confused with the digit 0, and so is not the default, but may be
3185 useful as a local coding convention if the programming environment is
3186 unable to be fixed to display these characters distinctly.
3187
3188 @item -Wno-deprecated-declarations
3189 @opindex Wno-deprecated-declarations
3190 Do not warn about uses of functions, variables, and types marked as
3191 deprecated by using the @code{deprecated} attribute.
3192 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3193 @pxref{Type Attributes}.)
3194
3195 @item -Wpacked
3196 @opindex Wpacked
3197 Warn if a structure is given the packed attribute, but the packed
3198 attribute has no effect on the layout or size of the structure.
3199 Such structures may be mis-aligned for little benefit. For
3200 instance, in this code, the variable @code{f.x} in @code{struct bar}
3201 will be misaligned even though @code{struct bar} does not itself
3202 have the packed attribute:
3203
3204 @smallexample
3205 @group
3206 struct foo @{
3207 int x;
3208 char a, b, c, d;
3209 @} __attribute__((packed));
3210 struct bar @{
3211 char z;
3212 struct foo f;
3213 @};
3214 @end group
3215 @end smallexample
3216
3217 @item -Wpadded
3218 @opindex Wpadded
3219 Warn if padding is included in a structure, either to align an element
3220 of the structure or to align the whole structure. Sometimes when this
3221 happens it is possible to rearrange the fields of the structure to
3222 reduce the padding and so make the structure smaller.
3223
3224 @item -Wredundant-decls
3225 @opindex Wredundant-decls
3226 Warn if anything is declared more than once in the same scope, even in
3227 cases where multiple declaration is valid and changes nothing.
3228
3229 @item -Wnested-externs @r{(C only)}
3230 @opindex Wnested-externs
3231 Warn if an @code{extern} declaration is encountered within a function.
3232
3233 @item -Wunreachable-code
3234 @opindex Wunreachable-code
3235 Warn if the compiler detects that code will never be executed.
3236
3237 This option is intended to warn when the compiler detects that at
3238 least a whole line of source code will never be executed, because
3239 some condition is never satisfied or because it is after a
3240 procedure that never returns.
3241
3242 It is possible for this option to produce a warning even though there
3243 are circumstances under which part of the affected line can be executed,
3244 so care should be taken when removing apparently-unreachable code.
3245
3246 For instance, when a function is inlined, a warning may mean that the
3247 line is unreachable in only one inlined copy of the function.
3248
3249 This option is not made part of @option{-Wall} because in a debugging
3250 version of a program there is often substantial code which checks
3251 correct functioning of the program and is, hopefully, unreachable
3252 because the program does work. Another common use of unreachable
3253 code is to provide behavior which is selectable at compile-time.
3254
3255 @item -Winline
3256 @opindex Winline
3257 Warn if a function can not be inlined and it was declared as inline.
3258 Even with this option, the compiler will not warn about failures to
3259 inline functions declared in system headers.
3260
3261 The compiler uses a variety of heuristics to determine whether or not
3262 to inline a function. For example, the compiler takes into account
3263 the size of the function being inlined and the amount of inlining
3264 that has already been done in the current function. Therefore,
3265 seemingly insignificant changes in the source program can cause the
3266 warnings produced by @option{-Winline} to appear or disappear.
3267
3268 @item -Wno-invalid-offsetof @r{(C++ only)}
3269 @opindex Wno-invalid-offsetof
3270 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3271 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3272 to a non-POD type is undefined. In existing C++ implementations,
3273 however, @samp{offsetof} typically gives meaningful results even when
3274 applied to certain kinds of non-POD types. (Such as a simple
3275 @samp{struct} that fails to be a POD type only by virtue of having a
3276 constructor.) This flag is for users who are aware that they are
3277 writing nonportable code and who have deliberately chosen to ignore the
3278 warning about it.
3279
3280 The restrictions on @samp{offsetof} may be relaxed in a future version
3281 of the C++ standard.
3282
3283 @item -Wno-int-to-pointer-cast @r{(C only)}
3284 @opindex Wno-int-to-pointer-cast
3285 Suppress warnings from casts to pointer type of an integer of a
3286 different size.
3287
3288 @item -Wno-pointer-to-int-cast @r{(C only)}
3289 @opindex Wno-pointer-to-int-cast
3290 Suppress warnings from casts from a pointer to an integer type of a
3291 different size.
3292
3293 @item -Winvalid-pch
3294 @opindex Winvalid-pch
3295 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3296 the search path but can't be used.
3297
3298 @item -Wlong-long
3299 @opindex Wlong-long
3300 @opindex Wno-long-long
3301 Warn if @samp{long long} type is used. This is default. To inhibit
3302 the warning messages, use @option{-Wno-long-long}. Flags
3303 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3304 only when @option{-pedantic} flag is used.
3305
3306 @item -Wvariadic-macros
3307 @opindex Wvariadic-macros
3308 @opindex Wno-variadic-macros
3309 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3310 alternate syntax when in pedantic ISO C99 mode. This is default.
3311 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3312
3313 @item -Wdisabled-optimization
3314 @opindex Wdisabled-optimization
3315 Warn if a requested optimization pass is disabled. This warning does
3316 not generally indicate that there is anything wrong with your code; it
3317 merely indicates that GCC's optimizers were unable to handle the code
3318 effectively. Often, the problem is that your code is too big or too
3319 complex; GCC will refuse to optimize programs when the optimization
3320 itself is likely to take inordinate amounts of time.
3321
3322 @item -Wno-pointer-sign
3323 @opindex Wno-pointer-sign
3324 Don't warn for pointer argument passing or assignment with different signedness.
3325 Only useful in the negative form since this warning is enabled by default.
3326 This option is only supported for C and Objective-C@.
3327
3328 @item -Werror
3329 @opindex Werror
3330 Make all warnings into errors.
3331 @end table
3332
3333 @node Debugging Options
3334 @section Options for Debugging Your Program or GCC
3335 @cindex options, debugging
3336 @cindex debugging information options
3337
3338 GCC has various special options that are used for debugging
3339 either your program or GCC:
3340
3341 @table @gcctabopt
3342 @item -g
3343 @opindex g
3344 Produce debugging information in the operating system's native format
3345 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
3346 information.
3347
3348 On most systems that use stabs format, @option{-g} enables use of extra
3349 debugging information that only GDB can use; this extra information
3350 makes debugging work better in GDB but will probably make other debuggers
3351 crash or
3352 refuse to read the program. If you want to control for certain whether
3353 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3354 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3355
3356 GCC allows you to use @option{-g} with
3357 @option{-O}. The shortcuts taken by optimized code may occasionally
3358 produce surprising results: some variables you declared may not exist
3359 at all; flow of control may briefly move where you did not expect it;
3360 some statements may not be executed because they compute constant
3361 results or their values were already at hand; some statements may
3362 execute in different places because they were moved out of loops.
3363
3364 Nevertheless it proves possible to debug optimized output. This makes
3365 it reasonable to use the optimizer for programs that might have bugs.
3366
3367 The following options are useful when GCC is generated with the
3368 capability for more than one debugging format.
3369
3370 @item -ggdb
3371 @opindex ggdb
3372 Produce debugging information for use by GDB@. This means to use the
3373 most expressive format available (DWARF 2, stabs, or the native format
3374 if neither of those are supported), including GDB extensions if at all
3375 possible.
3376
3377 @item -gstabs
3378 @opindex gstabs
3379 Produce debugging information in stabs format (if that is supported),
3380 without GDB extensions. This is the format used by DBX on most BSD
3381 systems. On MIPS, Alpha and System V Release 4 systems this option
3382 produces stabs debugging output which is not understood by DBX or SDB@.
3383 On System V Release 4 systems this option requires the GNU assembler.
3384
3385 @item -feliminate-unused-debug-symbols
3386 @opindex feliminate-unused-debug-symbols
3387 Produce debugging information in stabs format (if that is supported),
3388 for only symbols that are actually used.
3389
3390 @item -gstabs+
3391 @opindex gstabs+
3392 Produce debugging information in stabs format (if that is supported),
3393 using GNU extensions understood only by the GNU debugger (GDB)@. The
3394 use of these extensions is likely to make other debuggers crash or
3395 refuse to read the program.
3396
3397 @item -gcoff
3398 @opindex gcoff
3399 Produce debugging information in COFF format (if that is supported).
3400 This is the format used by SDB on most System V systems prior to
3401 System V Release 4.
3402
3403 @item -gxcoff
3404 @opindex gxcoff
3405 Produce debugging information in XCOFF format (if that is supported).
3406 This is the format used by the DBX debugger on IBM RS/6000 systems.
3407
3408 @item -gxcoff+
3409 @opindex gxcoff+
3410 Produce debugging information in XCOFF format (if that is supported),
3411 using GNU extensions understood only by the GNU debugger (GDB)@. The
3412 use of these extensions is likely to make other debuggers crash or
3413 refuse to read the program, and may cause assemblers other than the GNU
3414 assembler (GAS) to fail with an error.
3415
3416 @item -gdwarf-2
3417 @opindex gdwarf-2
3418 Produce debugging information in DWARF version 2 format (if that is
3419 supported). This is the format used by DBX on IRIX 6. With this
3420 option, GCC uses features of DWARF version 3 when they are useful;
3421 version 3 is upward compatible with version 2, but may still cause
3422 problems for older debuggers.
3423
3424 @item -gvms
3425 @opindex gvms
3426 Produce debugging information in VMS debug format (if that is
3427 supported). This is the format used by DEBUG on VMS systems.
3428
3429 @item -g@var{level}
3430 @itemx -ggdb@var{level}
3431 @itemx -gstabs@var{level}
3432 @itemx -gcoff@var{level}
3433 @itemx -gxcoff@var{level}
3434 @itemx -gvms@var{level}
3435 Request debugging information and also use @var{level} to specify how
3436 much information. The default level is 2.
3437
3438 Level 1 produces minimal information, enough for making backtraces in
3439 parts of the program that you don't plan to debug. This includes
3440 descriptions of functions and external variables, but no information
3441 about local variables and no line numbers.
3442
3443 Level 3 includes extra information, such as all the macro definitions
3444 present in the program. Some debuggers support macro expansion when
3445 you use @option{-g3}.
3446
3447 @option{-gdwarf-2} does not accept a concatenated debug level, because
3448 GCC used to support an option @option{-gdwarf} that meant to generate
3449 debug information in version 1 of the DWARF format (which is very
3450 different from version 2), and it would have been too confusing. That
3451 debug format is long obsolete, but the option cannot be changed now.
3452 Instead use an additional @option{-g@var{level}} option to change the
3453 debug level for DWARF2.
3454
3455 @item -feliminate-dwarf2-dups
3456 @opindex feliminate-dwarf2-dups
3457 Compress DWARF2 debugging information by eliminating duplicated
3458 information about each symbol. This option only makes sense when
3459 generating DWARF2 debugging information with @option{-gdwarf-2}.
3460
3461 @cindex @command{prof}
3462 @item -p
3463 @opindex p
3464 Generate extra code to write profile information suitable for the
3465 analysis program @command{prof}. You must use this option when compiling
3466 the source files you want data about, and you must also use it when
3467 linking.
3468
3469 @cindex @command{gprof}
3470 @item -pg
3471 @opindex pg
3472 Generate extra code to write profile information suitable for the
3473 analysis program @command{gprof}. You must use this option when compiling
3474 the source files you want data about, and you must also use it when
3475 linking.
3476
3477 @item -Q
3478 @opindex Q
3479 Makes the compiler print out each function name as it is compiled, and
3480 print some statistics about each pass when it finishes.
3481
3482 @item -ftime-report
3483 @opindex ftime-report
3484 Makes the compiler print some statistics about the time consumed by each
3485 pass when it finishes.
3486
3487 @item -fmem-report
3488 @opindex fmem-report
3489 Makes the compiler print some statistics about permanent memory
3490 allocation when it finishes.
3491
3492 @item -fprofile-arcs
3493 @opindex fprofile-arcs
3494 Add code so that program flow @dfn{arcs} are instrumented. During
3495 execution the program records how many times each branch and call is
3496 executed and how many times it is taken or returns. When the compiled
3497 program exits it saves this data to a file called
3498 @file{@var{auxname}.gcda} for each source file. The data may be used for
3499 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3500 test coverage analysis (@option{-ftest-coverage}). Each object file's
3501 @var{auxname} is generated from the name of the output file, if
3502 explicitly specified and it is not the final executable, otherwise it is
3503 the basename of the source file. In both cases any suffix is removed
3504 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3505 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3506 @xref{Cross-profiling}.
3507
3508 @cindex @command{gcov}
3509 @item --coverage
3510 @opindex coverage
3511
3512 This option is used to compile and link code instrumented for coverage
3513 analysis. The option is a synonym for @option{-fprofile-arcs}
3514 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3515 linking). See the documentation for those options for more details.
3516
3517 @itemize
3518
3519 @item
3520 Compile the source files with @option{-fprofile-arcs} plus optimization
3521 and code generation options. For test coverage analysis, use the
3522 additional @option{-ftest-coverage} option. You do not need to profile
3523 every source file in a program.
3524
3525 @item
3526 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3527 (the latter implies the former).
3528
3529 @item
3530 Run the program on a representative workload to generate the arc profile
3531 information. This may be repeated any number of times. You can run
3532 concurrent instances of your program, and provided that the file system
3533 supports locking, the data files will be correctly updated. Also
3534 @code{fork} calls are detected and correctly handled (double counting
3535 will not happen).
3536
3537 @item
3538 For profile-directed optimizations, compile the source files again with
3539 the same optimization and code generation options plus
3540 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3541 Control Optimization}).
3542
3543 @item
3544 For test coverage analysis, use @command{gcov} to produce human readable
3545 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3546 @command{gcov} documentation for further information.
3547
3548 @end itemize
3549
3550 With @option{-fprofile-arcs}, for each function of your program GCC
3551 creates a program flow graph, then finds a spanning tree for the graph.
3552 Only arcs that are not on the spanning tree have to be instrumented: the
3553 compiler adds code to count the number of times that these arcs are
3554 executed. When an arc is the only exit or only entrance to a block, the
3555 instrumentation code can be added to the block; otherwise, a new basic
3556 block must be created to hold the instrumentation code.
3557
3558 @item -ftree-based-profiling
3559 @opindex ftree-based-profiling
3560 This option is used in addition to @option{-fprofile-arcs} or
3561 @option{-fbranch-probabilities} to control whether those optimizations
3562 are performed on a tree-based or rtl-based internal representation.
3563 If you use this option when compiling with @option{-fprofile-arcs},
3564 you must also use it when compiling later with @option{-fbranch-probabilities}.
3565 Currently the tree-based optimization is in an early stage of
3566 development, and this option is recommended only for those people
3567 working on improving it.
3568
3569 @need 2000
3570 @item -ftest-coverage
3571 @opindex ftest-coverage
3572 Produce a notes file that the @command{gcov} code-coverage utility
3573 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3574 show program coverage. Each source file's note file is called
3575 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3576 above for a description of @var{auxname} and instructions on how to
3577 generate test coverage data. Coverage data will match the source files
3578 more closely, if you do not optimize.
3579
3580 @item -d@var{letters}
3581 @item -fdump-rtl-@var{pass}
3582 @opindex d
3583 Says to make debugging dumps during compilation at times specified by
3584 @var{letters}. This is used for debugging the RTL-based passes of the
3585 compiler. The file names for most of the dumps are made by appending a
3586 pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3587 from the name of the output file, if explicitly specified and it is not
3588 an executable, otherwise it is the basename of the source file.
3589
3590 Most debug dumps can be enabled either passing a letter to the @option{-d}
3591 option, or with a long @option{-fdump-rtl} switch; here are the possible
3592 letters for use in @var{letters} and @var{pass}, and their meanings:
3593
3594 @table @gcctabopt
3595 @item -dA
3596 @opindex dA
3597 Annotate the assembler output with miscellaneous debugging information.
3598
3599 @item -db
3600 @itemx -fdump-rtl-bp
3601 @opindex db
3602 @opindex fdump-rtl-bp
3603 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3604
3605 @item -dB
3606 @itemx -fdump-rtl-bbro
3607 @opindex dB
3608 @opindex fdump-rtl-bbro
3609 Dump after block reordering, to @file{@var{file}.30.bbro}.
3610
3611 @item -dc
3612 @itemx -fdump-rtl-combine
3613 @opindex dc
3614 @opindex fdump-rtl-combine
3615 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3616
3617 @item -dC
3618 @itemx -fdump-rtl-ce1
3619 @itemx -fdump-rtl-ce2
3620 @opindex dC
3621 @opindex fdump-rtl-ce1
3622 @opindex fdump-rtl-ce2
3623 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3624 first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3625 and @option{-fdump-rtl-ce2} enable dumping after the second if
3626 conversion, to the file @file{@var{file}.18.ce2}.
3627
3628 @item -dd
3629 @itemx -fdump-rtl-btl
3630 @itemx -fdump-rtl-dbr
3631 @opindex dd
3632 @opindex fdump-rtl-btl
3633 @opindex fdump-rtl-dbr
3634 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3635 target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
3636 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3637 scheduling, to @file{@var{file}.36.dbr}.
3638
3639 @item -dD
3640 @opindex dD
3641 Dump all macro definitions, at the end of preprocessing, in addition to
3642 normal output.
3643
3644 @item -dE
3645 @itemx -fdump-rtl-ce3
3646 @opindex dE
3647 @opindex fdump-rtl-ce3
3648 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3649
3650 @item -df
3651 @itemx -fdump-rtl-cfg
3652 @itemx -fdump-rtl-life
3653 @opindex df
3654 @opindex fdump-rtl-cfg
3655 @opindex fdump-rtl-life
3656 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3657 and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3658 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3659 to @file{@var{file}.16.life}.
3660
3661 @item -dg
3662 @itemx -fdump-rtl-greg
3663 @opindex dg
3664 @opindex fdump-rtl-greg
3665 Dump after global register allocation, to @file{@var{file}.23.greg}.
3666
3667 @item -dG
3668 @itemx -fdump-rtl-gcse
3669 @itemx -fdump-rtl-bypass
3670 @opindex dG
3671 @opindex fdump-rtl-gcse
3672 @opindex fdump-rtl-bypass
3673 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3674 @file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3675 enable dumping after jump bypassing and control flow optimizations, to
3676 @file{@var{file}.07.bypass}.
3677
3678 @item -dh
3679 @itemx -fdump-rtl-eh
3680 @opindex dh
3681 @opindex fdump-rtl-eh
3682 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3683
3684 @item -di
3685 @itemx -fdump-rtl-sibling
3686 @opindex di
3687 @opindex fdump-rtl-sibling
3688 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3689
3690 @item -dj
3691 @itemx -fdump-rtl-jump
3692 @opindex dj
3693 @opindex fdump-rtl-jump
3694 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3695
3696 @item -dk
3697 @itemx -fdump-rtl-stack
3698 @opindex dk
3699 @opindex fdump-rtl-stack
3700 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3701
3702 @item -dl
3703 @itemx -fdump-rtl-lreg
3704 @opindex dl
3705 @opindex fdump-rtl-lreg
3706 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3707
3708 @item -dL
3709 @itemx -fdump-rtl-loop
3710 @itemx -fdump-rtl-loop2
3711 @opindex dL
3712 @opindex fdump-rtl-loop
3713 @opindex fdump-rtl-loop2
3714 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3715 loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3716 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3717 @file{@var{file}.13.loop2}.
3718
3719 @item -dm
3720 @itemx -fdump-rtl-sms
3721 @opindex dm
3722 @opindex fdump-rtl-sms
3723 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3724
3725 @item -dM
3726 @itemx -fdump-rtl-mach
3727 @opindex dM
3728 @opindex fdump-rtl-mach
3729 Dump after performing the machine dependent reorganization pass, to
3730 @file{@var{file}.35.mach}.
3731
3732 @item -dn
3733 @itemx -fdump-rtl-rnreg
3734 @opindex dn
3735 @opindex fdump-rtl-rnreg
3736 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3737
3738 @item -dN
3739 @itemx -fdump-rtl-regmove
3740 @opindex dN
3741 @opindex fdump-rtl-regmove
3742 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3743
3744 @item -do
3745 @itemx -fdump-rtl-postreload
3746 @opindex do
3747 @opindex fdump-rtl-postreload
3748 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3749
3750 @item -dr
3751 @itemx -fdump-rtl-expand
3752 @opindex dr
3753 @opindex fdump-rtl-expand
3754 Dump after RTL generation, to @file{@var{file}.00.expand}.
3755
3756 @item -dR
3757 @itemx -fdump-rtl-sched2
3758 @opindex dR
3759 @opindex fdump-rtl-sched2
3760 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3761
3762 @item -ds
3763 @itemx -fdump-rtl-cse
3764 @opindex ds
3765 @opindex fdump-rtl-cse
3766 Dump after CSE (including the jump optimization that sometimes follows
3767 CSE), to @file{@var{file}.04.cse}.
3768
3769 @item -dS
3770 @itemx -fdump-rtl-sched
3771 @opindex dS
3772 @opindex fdump-rtl-sched
3773 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3774
3775 @item -dt
3776 @itemx -fdump-rtl-cse2
3777 @opindex dt
3778 @opindex fdump-rtl-cse2
3779 Dump after the second CSE pass (including the jump optimization that
3780 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3781
3782 @item -dT
3783 @itemx -fdump-rtl-tracer
3784 @opindex dT
3785 @opindex fdump-rtl-tracer
3786 Dump after running tracer, to @file{@var{file}.12.tracer}.
3787
3788 @item -dV
3789 @itemx -fdump-rtl-vpt
3790 @itemx -fdump-rtl-vartrack
3791 @opindex dV
3792 @opindex fdump-rtl-vpt
3793 @opindex fdump-rtl-vartrack
3794 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3795 profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3796 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3797 to @file{@var{file}.34.vartrack}.
3798
3799 @item -dw
3800 @itemx -fdump-rtl-flow2
3801 @opindex dw
3802 @opindex fdump-rtl-flow2
3803 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3804
3805 @item -dz
3806 @itemx -fdump-rtl-peephole2
3807 @opindex dz
3808 @opindex fdump-rtl-peephole2
3809 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3810
3811 @item -dZ
3812 @itemx -fdump-rtl-web
3813 @opindex dZ
3814 @opindex fdump-rtl-web
3815 Dump after live range splitting, to @file{@var{file}.14.web}.
3816
3817 @item -da
3818 @itemx -fdump-rtl-all
3819 @opindex da
3820 @opindex fdump-rtl-all
3821 Produce all the dumps listed above.
3822
3823 @item -dH
3824 @opindex dH
3825 Produce a core dump whenever an error occurs.
3826
3827 @item -dm
3828 @opindex dm
3829 Print statistics on memory usage, at the end of the run, to
3830 standard error.
3831
3832 @item -dp
3833 @opindex dp
3834 Annotate the assembler output with a comment indicating which
3835 pattern and alternative was used. The length of each instruction is
3836 also printed.
3837
3838 @item -dP
3839 @opindex dP
3840 Dump the RTL in the assembler output as a comment before each instruction.
3841 Also turns on @option{-dp} annotation.
3842
3843 @item -dv
3844 @opindex dv
3845 For each of the other indicated dump files (either with @option{-d} or
3846 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3847 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3848
3849 @item -dx
3850 @opindex dx
3851 Just generate RTL for a function instead of compiling it. Usually used
3852 with @samp{r} (@option{-fdump-rtl-expand}).
3853
3854 @item -dy
3855 @opindex dy
3856 Dump debugging information during parsing, to standard error.
3857 @end table
3858
3859 @item -fdump-unnumbered
3860 @opindex fdump-unnumbered
3861 When doing debugging dumps (see @option{-d} option above), suppress instruction
3862 numbers and line number note output. This makes it more feasible to
3863 use diff on debugging dumps for compiler invocations with different
3864 options, in particular with and without @option{-g}.
3865
3866 @item -fdump-translation-unit @r{(C++ only)}
3867 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
3868 @opindex fdump-translation-unit
3869 Dump a representation of the tree structure for the entire translation
3870 unit to a file. The file name is made by appending @file{.tu} to the
3871 source file name. If the @samp{-@var{options}} form is used, @var{options}
3872 controls the details of the dump as described for the
3873 @option{-fdump-tree} options.
3874
3875 @item -fdump-class-hierarchy @r{(C++ only)}
3876 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3877 @opindex fdump-class-hierarchy
3878 Dump a representation of each class's hierarchy and virtual function
3879 table layout to a file. The file name is made by appending @file{.class}
3880 to the source file name. If the @samp{-@var{options}} form is used,
3881 @var{options} controls the details of the dump as described for the
3882 @option{-fdump-tree} options.
3883
3884 @item -fdump-ipa-@var{switch}
3885 @opindex fdump-ipa
3886 Control the dumping at various stages of inter-procedural analysis
3887 language tree to a file. The file name is generated by appending a switch
3888 specific suffix to the source file name. The following dumps are possible:
3889
3890 @table @samp
3891 @item all
3892 Enables all inter-procedural analysis dumps; currently the only produced
3893 dump is the @samp{cgraph} dump.
3894
3895 @item cgraph
3896 Dumps information about call-graph optimization, unused function removal,
3897 and inlining decisions.
3898 @end table
3899
3900 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3901 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3902 @opindex fdump-tree
3903 Control the dumping at various stages of processing the intermediate
3904 language tree to a file. The file name is generated by appending a switch
3905 specific suffix to the source file name. If the @samp{-@var{options}}
3906 form is used, @var{options} is a list of @samp{-} separated options that
3907 control the details of the dump. Not all options are applicable to all
3908 dumps, those which are not meaningful will be ignored. The following
3909 options are available
3910
3911 @table @samp
3912 @item address
3913 Print the address of each node. Usually this is not meaningful as it
3914 changes according to the environment and source file. Its primary use
3915 is for tying up a dump file with a debug environment.
3916 @item slim
3917 Inhibit dumping of members of a scope or body of a function merely
3918 because that scope has been reached. Only dump such items when they
3919 are directly reachable by some other path. When dumping pretty-printed
3920 trees, this option inhibits dumping the bodies of control structures.
3921 @item raw
3922 Print a raw representation of the tree. By default, trees are
3923 pretty-printed into a C-like representation.
3924 @item details
3925 Enable more detailed dumps (not honored by every dump option).
3926 @item stats
3927 Enable dumping various statistics about the pass (not honored by every dump
3928 option).
3929 @item blocks
3930 Enable showing basic block boundaries (disabled in raw dumps).
3931 @item vops
3932 Enable showing virtual operands for every statement.
3933 @item lineno
3934 Enable showing line numbers for statements.
3935 @item uid
3936 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3937 @item all
3938 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3939 @end table
3940
3941 The following tree dumps are possible:
3942 @table @samp
3943
3944 @item original
3945 Dump before any tree based optimization, to @file{@var{file}.original}.
3946
3947 @item optimized
3948 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3949
3950 @item inlined
3951 Dump after function inlining, to @file{@var{file}.inlined}.
3952
3953 @item gimple
3954 @opindex fdump-tree-gimple
3955 Dump each function before and after the gimplification pass to a file. The
3956 file name is made by appending @file{.gimple} to the source file name.
3957
3958 @item cfg
3959 @opindex fdump-tree-cfg
3960 Dump the control flow graph of each function to a file. The file name is
3961 made by appending @file{.cfg} to the source file name.
3962
3963 @item vcg
3964 @opindex fdump-tree-vcg
3965 Dump the control flow graph of each function to a file in VCG format. The
3966 file name is made by appending @file{.vcg} to the source file name. Note
3967 that if the file contains more than one function, the generated file cannot
3968 be used directly by VCG@. You will need to cut and paste each function's
3969 graph into its own separate file first.
3970
3971 @item ch
3972 @opindex fdump-tree-ch
3973 Dump each function after copying loop headers. The file name is made by
3974 appending @file{.ch} to the source file name.
3975
3976 @item ssa
3977 @opindex fdump-tree-ssa
3978 Dump SSA related information to a file. The file name is made by appending
3979 @file{.ssa} to the source file name.
3980
3981 @item salias
3982 @opindex fdump-tree-salias
3983 Dump structure aliasing variable information to a file. This file name
3984 is made by appending @file{.salias} to the source file name.
3985
3986 @item alias
3987 @opindex fdump-tree-alias
3988 Dump aliasing information for each function. The file name is made by
3989 appending @file{.alias} to the source file name.
3990
3991 @item ccp
3992 @opindex fdump-tree-ccp
3993 Dump each function after CCP@. The file name is made by appending
3994 @file{.ccp} to the source file name.
3995
3996 @item storeccp
3997 @opindex fdump-tree-storeccp
3998 Dump each function after STORE-CCP. The file name is made by appending
3999 @file{.storeccp} to the source file name.
4000
4001 @item pre
4002 @opindex fdump-tree-pre
4003 Dump trees after partial redundancy elimination. The file name is made
4004 by appending @file{.pre} to the source file name.
4005
4006 @item fre
4007 @opindex fdump-tree-fre
4008 Dump trees after full redundancy elimination. The file name is made
4009 by appending @file{.fre} to the source file name.
4010
4011 @item copyprop
4012 @opindex fdump-tree-copyprop
4013 Dump trees after copy propagation. The file name is made
4014 by appending @file{.copyprop} to the source file name.
4015
4016 @item store_copyprop
4017 @opindex fdump-tree-store_copyprop
4018 Dump trees after store copy-propagation. The file name is made
4019 by appending @file{.store_copyprop} to the source file name.
4020
4021 @item dce
4022 @opindex fdump-tree-dce
4023 Dump each function after dead code elimination. The file name is made by
4024 appending @file{.dce} to the source file name.
4025
4026 @item mudflap
4027 @opindex fdump-tree-mudflap
4028 Dump each function after adding mudflap instrumentation. The file name is
4029 made by appending @file{.mudflap} to the source file name.
4030
4031 @item sra
4032 @opindex fdump-tree-sra
4033 Dump each function after performing scalar replacement of aggregates. The
4034 file name is made by appending @file{.sra} to the source file name.
4035
4036 @item sink
4037 @opindex fdump-tree-sink
4038 Dump each function after performing code sinking. The file name is made
4039 by appending @file{.sink} to the source file name.
4040
4041 @item dom
4042 @opindex fdump-tree-dom
4043 Dump each function after applying dominator tree optimizations. The file
4044 name is made by appending @file{.dom} to the source file name.
4045
4046 @item dse
4047 @opindex fdump-tree-dse
4048 Dump each function after applying dead store elimination. The file
4049 name is made by appending @file{.dse} to the source file name.
4050
4051 @item phiopt
4052 @opindex fdump-tree-phiopt
4053 Dump each function after optimizing PHI nodes into straightline code. The file
4054 name is made by appending @file{.phiopt} to the source file name.
4055
4056 @item forwprop
4057 @opindex fdump-tree-forwprop
4058 Dump each function after forward propagating single use variables. The file
4059 name is made by appending @file{.forwprop} to the source file name.
4060
4061 @item copyrename
4062 @opindex fdump-tree-copyrename
4063 Dump each function after applying the copy rename optimization. The file
4064 name is made by appending @file{.copyrename} to the source file name.
4065
4066 @item nrv
4067 @opindex fdump-tree-nrv
4068 Dump each function after applying the named return value optimization on
4069 generic trees. The file name is made by appending @file{.nrv} to the source
4070 file name.
4071
4072 @item vect
4073 @opindex fdump-tree-vect
4074 Dump each function after applying vectorization of loops. The file name is
4075 made by appending @file{.vect} to the source file name.
4076
4077 @item vrp
4078 @opindex fdump-tree-vrp
4079 Dump each function after Value Range Propagation (VRP). The file name
4080 is made by appending @file{.vrp} to the source file name.
4081
4082 @item all
4083 @opindex fdump-tree-all
4084 Enable all the available tree dumps with the flags provided in this option.
4085 @end table
4086
4087 @item -ftree-vectorizer-verbose=@var{n}
4088 @opindex ftree-vectorizer-verbose
4089 This option controls the amount of debugging output the vectorizer prints.
4090 This information is written to standard error, unless @option{-fdump-tree-all}
4091 or @option{-fdump-tree-vect} is specified, in which case it is output to the
4092 usual dump listing file, @file{.vect}.
4093
4094 @item -frandom-seed=@var{string}
4095 @opindex frandom-string
4096 This option provides a seed that GCC uses when it would otherwise use
4097 random numbers. It is used to generate certain symbol names
4098 that have to be different in every compiled file. It is also used to
4099 place unique stamps in coverage data files and the object files that
4100 produce them. You can use the @option{-frandom-seed} option to produce
4101 reproducibly identical object files.
4102
4103 The @var{string} should be different for every file you compile.
4104
4105 @item -fsched-verbose=@var{n}
4106 @opindex fsched-verbose
4107 On targets that use instruction scheduling, this option controls the
4108 amount of debugging output the scheduler prints. This information is
4109 written to standard error, unless @option{-dS} or @option{-dR} is
4110 specified, in which case it is output to the usual dump
4111 listing file, @file{.sched} or @file{.sched2} respectively. However
4112 for @var{n} greater than nine, the output is always printed to standard
4113 error.
4114
4115 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4116 same information as @option{-dRS}. For @var{n} greater than one, it
4117 also output basic block probabilities, detailed ready list information
4118 and unit/insn info. For @var{n} greater than two, it includes RTL
4119 at abort point, control-flow and regions info. And for @var{n} over
4120 four, @option{-fsched-verbose} also includes dependence info.
4121
4122 @item -save-temps
4123 @opindex save-temps
4124 Store the usual ``temporary'' intermediate files permanently; place them
4125 in the current directory and name them based on the source file. Thus,
4126 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4127 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4128 preprocessed @file{foo.i} output file even though the compiler now
4129 normally uses an integrated preprocessor.
4130
4131 When used in combination with the @option{-x} command line option,
4132 @option{-save-temps} is sensible enough to avoid over writing an
4133 input source file with the same extension as an intermediate file.
4134 The corresponding intermediate file may be obtained by renaming the
4135 source file before using @option{-save-temps}.
4136
4137 @item -time
4138 @opindex time
4139 Report the CPU time taken by each subprocess in the compilation
4140 sequence. For C source files, this is the compiler proper and assembler
4141 (plus the linker if linking is done). The output looks like this:
4142
4143 @smallexample
4144 # cc1 0.12 0.01
4145 # as 0.00 0.01
4146 @end smallexample
4147
4148 The first number on each line is the ``user time'', that is time spent
4149 executing the program itself. The second number is ``system time'',
4150 time spent executing operating system routines on behalf of the program.
4151 Both numbers are in seconds.
4152
4153 @item -fvar-tracking
4154 @opindex fvar-tracking
4155 Run variable tracking pass. It computes where variables are stored at each
4156 position in code. Better debugging information is then generated
4157 (if the debugging information format supports this information).
4158
4159 It is enabled by default when compiling with optimization (@option{-Os},
4160 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4161 the debug info format supports it.
4162
4163 @item -print-file-name=@var{library}
4164 @opindex print-file-name
4165 Print the full absolute name of the library file @var{library} that
4166 would be used when linking---and don't do anything else. With this
4167 option, GCC does not compile or link anything; it just prints the
4168 file name.
4169
4170 @item -print-multi-directory
4171 @opindex print-multi-directory
4172 Print the directory name corresponding to the multilib selected by any
4173 other switches present in the command line. This directory is supposed
4174 to exist in @env{GCC_EXEC_PREFIX}.
4175
4176 @item -print-multi-lib
4177 @opindex print-multi-lib
4178 Print the mapping from multilib directory names to compiler switches
4179 that enable them. The directory name is separated from the switches by
4180 @samp{;}, and each switch starts with an @samp{@@} instead of the
4181 @samp{-}, without spaces between multiple switches. This is supposed to
4182 ease shell-processing.
4183
4184 @item -print-prog-name=@var{program}
4185 @opindex print-prog-name
4186 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4187
4188 @item -print-libgcc-file-name
4189 @opindex print-libgcc-file-name
4190 Same as @option{-print-file-name=libgcc.a}.
4191
4192 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4193 but you do want to link with @file{libgcc.a}. You can do
4194
4195 @smallexample
4196 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4197 @end smallexample
4198
4199 @item -print-search-dirs
4200 @opindex print-search-dirs
4201 Print the name of the configured installation directory and a list of
4202 program and library directories @command{gcc} will search---and don't do anything else.
4203
4204 This is useful when @command{gcc} prints the error message
4205 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4206 To resolve this you either need to put @file{cpp0} and the other compiler
4207 components where @command{gcc} expects to find them, or you can set the environment
4208 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4209 Don't forget the trailing @samp{/}.
4210 @xref{Environment Variables}.
4211
4212 @item -dumpmachine
4213 @opindex dumpmachine
4214 Print the compiler's target machine (for example,
4215 @samp{i686-pc-linux-gnu})---and don't do anything else.
4216
4217 @item -dumpversion
4218 @opindex dumpversion
4219 Print the compiler version (for example, @samp{3.0})---and don't do
4220 anything else.
4221
4222 @item -dumpspecs
4223 @opindex dumpspecs
4224 Print the compiler's built-in specs---and don't do anything else. (This
4225 is used when GCC itself is being built.) @xref{Spec Files}.
4226
4227 @item -feliminate-unused-debug-types
4228 @opindex feliminate-unused-debug-types
4229 Normally, when producing DWARF2 output, GCC will emit debugging
4230 information for all types declared in a compilation
4231 unit, regardless of whether or not they are actually used
4232 in that compilation unit. Sometimes this is useful, such as
4233 if, in the debugger, you want to cast a value to a type that is
4234 not actually used in your program (but is declared). More often,
4235 however, this results in a significant amount of wasted space.
4236 With this option, GCC will avoid producing debug symbol output
4237 for types that are nowhere used in the source file being compiled.
4238 @end table
4239
4240 @node Optimize Options
4241 @section Options That Control Optimization
4242 @cindex optimize options
4243 @cindex options, optimization
4244
4245 These options control various sorts of optimizations.
4246
4247 Without any optimization option, the compiler's goal is to reduce the
4248 cost of compilation and to make debugging produce the expected
4249 results. Statements are independent: if you stop the program with a
4250 breakpoint between statements, you can then assign a new value to any
4251 variable or change the program counter to any other statement in the
4252 function and get exactly the results you would expect from the source
4253 code.
4254
4255 Turning on optimization flags makes the compiler attempt to improve
4256 the performance and/or code size at the expense of compilation time
4257 and possibly the ability to debug the program.
4258
4259 The compiler performs optimization based on the knowledge it has of
4260 the program. Optimization levels @option{-O2} and above, in
4261 particular, enable @emph{unit-at-a-time} mode, which allows the
4262 compiler to consider information gained from later functions in
4263 the file when compiling a function. Compiling multiple files at
4264 once to a single output file in @emph{unit-at-a-time} mode allows
4265 the compiler to use information gained from all of the files when
4266 compiling each of them.
4267
4268 Not all optimizations are controlled directly by a flag. Only
4269 optimizations that have a flag are listed.
4270
4271 @table @gcctabopt
4272 @item -O
4273 @itemx -O1
4274 @opindex O
4275 @opindex O1
4276 Optimize. Optimizing compilation takes somewhat more time, and a lot
4277 more memory for a large function.
4278
4279 With @option{-O}, the compiler tries to reduce code size and execution
4280 time, without performing any optimizations that take a great deal of
4281 compilation time.
4282
4283 @option{-O} turns on the following optimization flags:
4284 @gccoptlist{-fdefer-pop @gol
4285 -fdelayed-branch @gol
4286 -fguess-branch-probability @gol
4287 -fcprop-registers @gol
4288 -floop-optimize @gol
4289 -fif-conversion @gol
4290 -fif-conversion2 @gol
4291 -ftree-ccp @gol
4292 -ftree-dce @gol
4293 -ftree-dominator-opts @gol
4294 -ftree-dse @gol
4295 -ftree-ter @gol
4296 -ftree-lrs @gol
4297 -ftree-sra @gol
4298 -ftree-copyrename @gol
4299 -ftree-fre @gol
4300 -ftree-ch @gol
4301 -fmerge-constants}
4302
4303 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4304 where doing so does not interfere with debugging.
4305
4306 @item -O2
4307 @opindex O2
4308 Optimize even more. GCC performs nearly all supported optimizations
4309 that do not involve a space-speed tradeoff. The compiler does not
4310 perform loop unrolling or function inlining when you specify @option{-O2}.
4311 As compared to @option{-O}, this option increases both compilation time
4312 and the performance of the generated code.
4313
4314 @option{-O2} turns on all optimization flags specified by @option{-O}. It
4315 also turns on the following optimization flags:
4316 @gccoptlist{-fthread-jumps @gol
4317 -fcrossjumping @gol
4318 -foptimize-sibling-calls @gol
4319 -fcse-follow-jumps -fcse-skip-blocks @gol
4320 -fgcse -fgcse-lm @gol
4321 -fexpensive-optimizations @gol
4322 -fstrength-reduce @gol
4323 -frerun-cse-after-loop -frerun-loop-opt @gol
4324 -fcaller-saves @gol
4325 -fpeephole2 @gol
4326 -fschedule-insns -fschedule-insns2 @gol
4327 -fsched-interblock -fsched-spec @gol
4328 -fregmove @gol
4329 -fstrict-aliasing @gol
4330 -fdelete-null-pointer-checks @gol
4331 -freorder-blocks -freorder-functions @gol
4332 -funit-at-a-time @gol
4333 -falign-functions -falign-jumps @gol
4334 -falign-loops -falign-labels @gol
4335 -ftree-vrp @gol
4336 -ftree-pre}
4337
4338 Please note the warning under @option{-fgcse} about
4339 invoking @option{-O2} on programs that use computed gotos.
4340
4341 @item -O3
4342 @opindex O3
4343 Optimize yet more. @option{-O3} turns on all optimizations specified by
4344 @option{-O2} and also turns on the @option{-finline-functions},
4345 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4346
4347 @item -O0
4348 @opindex O0
4349 Do not optimize. This is the default.
4350
4351 @item -Os
4352 @opindex Os
4353 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
4354 do not typically increase code size. It also performs further
4355 optimizations designed to reduce code size.
4356
4357 @option{-Os} disables the following optimization flags:
4358 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
4359 -falign-labels -freorder-blocks -freorder-blocks-and-partition -fprefetch-loop-arrays}
4360
4361 If you use multiple @option{-O} options, with or without level numbers,
4362 the last such option is the one that is effective.
4363 @end table
4364
4365 Options of the form @option{-f@var{flag}} specify machine-independent
4366 flags. Most flags have both positive and negative forms; the negative
4367 form of @option{-ffoo} would be @option{-fno-foo}. In the table
4368 below, only one of the forms is listed---the one you typically will
4369 use. You can figure out the other form by either removing @samp{no-}
4370 or adding it.
4371
4372 The following options control specific optimizations. They are either
4373 activated by @option{-O} options or are related to ones that are. You
4374 can use the following flags in the rare cases when ``fine-tuning'' of
4375 optimizations to be performed is desired.
4376
4377 @table @gcctabopt
4378 @item -fno-default-inline
4379 @opindex fno-default-inline
4380 Do not make member functions inline by default merely because they are
4381 defined inside the class scope (C++ only). Otherwise, when you specify
4382 @w{@option{-O}}, member functions defined inside class scope are compiled
4383 inline by default; i.e., you don't need to add @samp{inline} in front of
4384 the member function name.
4385
4386 @item -fno-defer-pop
4387 @opindex fno-defer-pop
4388 Always pop the arguments to each function call as soon as that function
4389 returns. For machines which must pop arguments after a function call,
4390 the compiler normally lets arguments accumulate on the stack for several
4391 function calls and pops them all at once.
4392
4393 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4394
4395 @item -fforce-mem
4396 @opindex fforce-mem
4397 Force memory operands to be copied into registers before doing
4398 arithmetic on them. This produces better code by making all memory
4399 references potential common subexpressions. When they are not common
4400 subexpressions, instruction combination should eliminate the separate
4401 register-load. This option is now a nop and will be removed in 4.2.
4402
4403 @item -fforce-addr
4404 @opindex fforce-addr
4405 Force memory address constants to be copied into registers before
4406 doing arithmetic on them.
4407
4408 @item -fomit-frame-pointer
4409 @opindex fomit-frame-pointer
4410 Don't keep the frame pointer in a register for functions that
4411 don't need one. This avoids the instructions to save, set up and
4412 restore frame pointers; it also makes an extra register available
4413 in many functions. @strong{It also makes debugging impossible on
4414 some machines.}
4415
4416 On some machines, such as the VAX, this flag has no effect, because
4417 the standard calling sequence automatically handles the frame pointer
4418 and nothing is saved by pretending it doesn't exist. The
4419 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4420 whether a target machine supports this flag. @xref{Registers,,Register
4421 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4422
4423 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4424
4425 @item -foptimize-sibling-calls
4426 @opindex foptimize-sibling-calls
4427 Optimize sibling and tail recursive calls.
4428
4429 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4430
4431 @item -fno-inline
4432 @opindex fno-inline
4433 Don't pay attention to the @code{inline} keyword. Normally this option
4434 is used to keep the compiler from expanding any functions inline.
4435 Note that if you are not optimizing, no functions can be expanded inline.
4436
4437 @item -finline-functions
4438 @opindex finline-functions
4439 Integrate all simple functions into their callers. The compiler
4440 heuristically decides which functions are simple enough to be worth
4441 integrating in this way.
4442
4443 If all calls to a given function are integrated, and the function is
4444 declared @code{static}, then the function is normally not output as
4445 assembler code in its own right.
4446
4447 Enabled at level @option{-O3}.
4448
4449 @item -fearly-inlining
4450 @opindex fearly-inlining
4451 Inline functions marked by @code{always_inline} and functions whose body seems
4452 smaller than the function call overhead early before doing
4453 @option{-fprofile-generate} instrumentation and real inlining pass. Doing so
4454 makes profiling significantly cheaper and usually inlining faster on programs
4455 having large chains of nested wrapper functions.
4456
4457 Enabled by default.
4458
4459 @item -finline-limit=@var{n}
4460 @opindex finline-limit
4461 By default, GCC limits the size of functions that can be inlined. This flag
4462 allows the control of this limit for functions that are explicitly marked as
4463 inline (i.e., marked with the inline keyword or defined within the class
4464 definition in c++). @var{n} is the size of functions that can be inlined in
4465 number of pseudo instructions (not counting parameter handling). The default
4466 value of @var{n} is 600.
4467 Increasing this value can result in more inlined code at
4468 the cost of compilation time and memory consumption. Decreasing usually makes
4469 the compilation faster and less code will be inlined (which presumably
4470 means slower programs). This option is particularly useful for programs that
4471 use inlining heavily such as those based on recursive templates with C++.
4472
4473 Inlining is actually controlled by a number of parameters, which may be
4474 specified individually by using @option{--param @var{name}=@var{value}}.
4475 The @option{-finline-limit=@var{n}} option sets some of these parameters
4476 as follows:
4477
4478 @table @gcctabopt
4479 @item max-inline-insns-single
4480 is set to @var{n}/2.
4481 @item max-inline-insns-auto
4482 is set to @var{n}/2.
4483 @item min-inline-insns
4484 is set to 130 or @var{n}/4, whichever is smaller.
4485 @item max-inline-insns-rtl
4486 is set to @var{n}.
4487 @end table
4488
4489 See below for a documentation of the individual
4490 parameters controlling inlining.
4491
4492 @emph{Note:} pseudo instruction represents, in this particular context, an
4493 abstract measurement of function's size. In no way does it represent a count
4494 of assembly instructions and as such its exact meaning might change from one
4495 release to an another.
4496
4497 @item -fkeep-inline-functions
4498 @opindex fkeep-inline-functions
4499 In C, emit @code{static} functions that are declared @code{inline}
4500 into the object file, even if the function has been inlined into all
4501 of its callers. This switch does not affect functions using the
4502 @code{extern inline} extension in GNU C@. In C++, emit any and all
4503 inline functions into the object file.
4504
4505 @item -fkeep-static-consts
4506 @opindex fkeep-static-consts
4507 Emit variables declared @code{static const} when optimization isn't turned
4508 on, even if the variables aren't referenced.
4509
4510 GCC enables this option by default. If you want to force the compiler to
4511 check if the variable was referenced, regardless of whether or not
4512 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4513
4514 @item -fmerge-constants
4515 Attempt to merge identical constants (string constants and floating point
4516 constants) across compilation units.
4517
4518 This option is the default for optimized compilation if the assembler and
4519 linker support it. Use @option{-fno-merge-constants} to inhibit this
4520 behavior.
4521
4522 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4523
4524 @item -fmerge-all-constants
4525 Attempt to merge identical constants and identical variables.
4526
4527 This option implies @option{-fmerge-constants}. In addition to
4528 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4529 arrays or initialized constant variables with integral or floating point
4530 types. Languages like C or C++ require each non-automatic variable to
4531 have distinct location, so using this option will result in non-conforming
4532 behavior.
4533
4534 @item -fmodulo-sched
4535 @opindex fmodulo-sched
4536 Perform swing modulo scheduling immediately before the first scheduling
4537 pass. This pass looks at innermost loops and reorders their
4538 instructions by overlapping different iterations.
4539
4540 @item -fno-branch-count-reg
4541 @opindex fno-branch-count-reg
4542 Do not use ``decrement and branch'' instructions on a count register,
4543 but instead generate a sequence of instructions that decrement a
4544 register, compare it against zero, then branch based upon the result.
4545 This option is only meaningful on architectures that support such
4546 instructions, which include x86, PowerPC, IA-64 and S/390.
4547
4548 The default is @option{-fbranch-count-reg}, enabled when
4549 @option{-fstrength-reduce} is enabled.
4550
4551 @item -fno-function-cse
4552 @opindex fno-function-cse
4553 Do not put function addresses in registers; make each instruction that
4554 calls a constant function contain the function's address explicitly.
4555
4556 This option results in less efficient code, but some strange hacks
4557 that alter the assembler output may be confused by the optimizations
4558 performed when this option is not used.
4559
4560 The default is @option{-ffunction-cse}
4561
4562 @item -fno-zero-initialized-in-bss
4563 @opindex fno-zero-initialized-in-bss
4564 If the target supports a BSS section, GCC by default puts variables that
4565 are initialized to zero into BSS@. This can save space in the resulting
4566 code.
4567
4568 This option turns off this behavior because some programs explicitly
4569 rely on variables going to the data section. E.g., so that the
4570 resulting executable can find the beginning of that section and/or make
4571 assumptions based on that.
4572
4573 The default is @option{-fzero-initialized-in-bss}.
4574
4575 @item -fbounds-check
4576 @opindex fbounds-check
4577 For front-ends that support it, generate additional code to check that
4578 indices used to access arrays are within the declared range. This is
4579 currently only supported by the Java and Fortran front-ends, where
4580 this option defaults to true and false respectively.
4581
4582 @item -fmudflap -fmudflapth -fmudflapir
4583 @opindex fmudflap
4584 @opindex fmudflapth
4585 @opindex fmudflapir
4586 @cindex bounds checking
4587 @cindex mudflap
4588 For front-ends that support it (C and C++), instrument all risky
4589 pointer/array dereferencing operations, some standard library
4590 string/heap functions, and some other associated constructs with
4591 range/validity tests. Modules so instrumented should be immune to
4592 buffer overflows, invalid heap use, and some other classes of C/C++
4593 programming errors. The instrumentation relies on a separate runtime
4594 library (@file{libmudflap}), which will be linked into a program if
4595 @option{-fmudflap} is given at link time. Run-time behavior of the
4596 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4597 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4598 for its options.
4599
4600 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4601 link if your program is multi-threaded. Use @option{-fmudflapir}, in
4602 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4603 instrumentation should ignore pointer reads. This produces less
4604 instrumentation (and therefore faster execution) and still provides
4605 some protection against outright memory corrupting writes, but allows
4606 erroneously read data to propagate within a program.
4607
4608 @item -fstrength-reduce
4609 @opindex fstrength-reduce
4610 Perform the optimizations of loop strength reduction and
4611 elimination of iteration variables.
4612
4613 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4614
4615 @item -fthread-jumps
4616 @opindex fthread-jumps
4617 Perform optimizations where we check to see if a jump branches to a
4618 location where another comparison subsumed by the first is found. If
4619 so, the first branch is redirected to either the destination of the
4620 second branch or a point immediately following it, depending on whether
4621 the condition is known to be true or false.
4622
4623 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4624
4625 @item -fcse-follow-jumps
4626 @opindex fcse-follow-jumps
4627 In common subexpression elimination, scan through jump instructions
4628 when the target of the jump is not reached by any other path. For
4629 example, when CSE encounters an @code{if} statement with an
4630 @code{else} clause, CSE will follow the jump when the condition
4631 tested is false.
4632
4633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4634
4635 @item -fcse-skip-blocks
4636 @opindex fcse-skip-blocks
4637 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4638 follow jumps which conditionally skip over blocks. When CSE
4639 encounters a simple @code{if} statement with no else clause,
4640 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4641 body of the @code{if}.
4642
4643 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4644
4645 @item -frerun-cse-after-loop
4646 @opindex frerun-cse-after-loop
4647 Re-run common subexpression elimination after loop optimizations has been
4648 performed.
4649
4650 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4651
4652 @item -frerun-loop-opt
4653 @opindex frerun-loop-opt
4654 Run the loop optimizer twice.
4655
4656 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4657
4658 @item -fgcse
4659 @opindex fgcse
4660 Perform a global common subexpression elimination pass.
4661 This pass also performs global constant and copy propagation.
4662
4663 @emph{Note:} When compiling a program using computed gotos, a GCC
4664 extension, you may get better runtime performance if you disable
4665 the global common subexpression elimination pass by adding
4666 @option{-fno-gcse} to the command line.
4667
4668 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4669
4670 @item -fgcse-lm
4671 @opindex fgcse-lm
4672 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4673 attempt to move loads which are only killed by stores into themselves. This
4674 allows a loop containing a load/store sequence to be changed to a load outside
4675 the loop, and a copy/store within the loop.
4676
4677 Enabled by default when gcse is enabled.
4678
4679 @item -fgcse-sm
4680 @opindex fgcse-sm
4681 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4682 global common subexpression elimination. This pass will attempt to move
4683 stores out of loops. When used in conjunction with @option{-fgcse-lm},
4684 loops containing a load/store sequence can be changed to a load before
4685 the loop and a store after the loop.
4686
4687 Not enabled at any optimization level.
4688
4689 @item -fgcse-las
4690 @opindex fgcse-las
4691 When @option{-fgcse-las} is enabled, the global common subexpression
4692 elimination pass eliminates redundant loads that come after stores to the
4693 same memory location (both partial and full redundancies).
4694
4695 Not enabled at any optimization level.
4696
4697 @item -fgcse-after-reload
4698 @opindex fgcse-after-reload
4699 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4700 pass is performed after reload. The purpose of this pass is to cleanup
4701 redundant spilling.
4702
4703 @item -floop-optimize
4704 @opindex floop-optimize
4705 Perform loop optimizations: move constant expressions out of loops, simplify
4706 exit test conditions and optionally do strength-reduction as well.
4707
4708 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4709
4710 @item -floop-optimize2
4711 @opindex floop-optimize2
4712 Perform loop optimizations using the new loop optimizer. The optimizations
4713 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4714 by separate flags.
4715
4716 @item -fcrossjumping
4717 @opindex crossjumping
4718 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4719 resulting code may or may not perform better than without cross-jumping.
4720
4721 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4722
4723 @item -fif-conversion
4724 @opindex if-conversion
4725 Attempt to transform conditional jumps into branch-less equivalents. This
4726 include use of conditional moves, min, max, set flags and abs instructions, and
4727 some tricks doable by standard arithmetics. The use of conditional execution
4728 on chips where it is available is controlled by @code{if-conversion2}.
4729
4730 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4731
4732 @item -fif-conversion2
4733 @opindex if-conversion2
4734 Use conditional execution (where available) to transform conditional jumps into
4735 branch-less equivalents.
4736
4737 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4738
4739 @item -fdelete-null-pointer-checks
4740 @opindex fdelete-null-pointer-checks
4741 Use global dataflow analysis to identify and eliminate useless checks
4742 for null pointers. The compiler assumes that dereferencing a null
4743 pointer would have halted the program. If a pointer is checked after
4744 it has already been dereferenced, it cannot be null.
4745
4746 In some environments, this assumption is not true, and programs can
4747 safely dereference null pointers. Use
4748 @option{-fno-delete-null-pointer-checks} to disable this optimization
4749 for programs which depend on that behavior.
4750
4751 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4752
4753 @item -fexpensive-optimizations
4754 @opindex fexpensive-optimizations
4755 Perform a number of minor optimizations that are relatively expensive.
4756
4757 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4758
4759 @item -foptimize-register-move
4760 @itemx -fregmove
4761 @opindex foptimize-register-move
4762 @opindex fregmove
4763 Attempt to reassign register numbers in move instructions and as
4764 operands of other simple instructions in order to maximize the amount of
4765 register tying. This is especially helpful on machines with two-operand
4766 instructions.
4767
4768 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4769 optimization.
4770
4771 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4772
4773 @item -fdelayed-branch
4774 @opindex fdelayed-branch
4775 If supported for the target machine, attempt to reorder instructions
4776 to exploit instruction slots available after delayed branch
4777 instructions.
4778
4779 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4780
4781 @item -fschedule-insns
4782 @opindex fschedule-insns
4783 If supported for the target machine, attempt to reorder instructions to
4784 eliminate execution stalls due to required data being unavailable. This
4785 helps machines that have slow floating point or memory load instructions
4786 by allowing other instructions to be issued until the result of the load
4787 or floating point instruction is required.
4788
4789 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4790
4791 @item -fschedule-insns2
4792 @opindex fschedule-insns2
4793 Similar to @option{-fschedule-insns}, but requests an additional pass of
4794 instruction scheduling after register allocation has been done. This is
4795 especially useful on machines with a relatively small number of
4796 registers and where memory load instructions take more than one cycle.
4797
4798 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4799
4800 @item -fno-sched-interblock
4801 @opindex fno-sched-interblock
4802 Don't schedule instructions across basic blocks. This is normally
4803 enabled by default when scheduling before register allocation, i.e.@:
4804 with @option{-fschedule-insns} or at @option{-O2} or higher.
4805
4806 @item -fno-sched-spec
4807 @opindex fno-sched-spec
4808 Don't allow speculative motion of non-load instructions. This is normally
4809 enabled by default when scheduling before register allocation, i.e.@:
4810 with @option{-fschedule-insns} or at @option{-O2} or higher.
4811
4812 @item -fsched-spec-load
4813 @opindex fsched-spec-load
4814 Allow speculative motion of some load instructions. This only makes
4815 sense when scheduling before register allocation, i.e.@: with
4816 @option{-fschedule-insns} or at @option{-O2} or higher.
4817
4818 @item -fsched-spec-load-dangerous
4819 @opindex fsched-spec-load-dangerous
4820 Allow speculative motion of more load instructions. This only makes
4821 sense when scheduling before register allocation, i.e.@: with
4822 @option{-fschedule-insns} or at @option{-O2} or higher.
4823
4824 @item -fsched-stalled-insns=@var{n}
4825 @opindex fsched-stalled-insns
4826 Define how many insns (if any) can be moved prematurely from the queue
4827 of stalled insns into the ready list, during the second scheduling pass.
4828
4829 @item -fsched-stalled-insns-dep=@var{n}
4830 @opindex fsched-stalled-insns-dep
4831 Define how many insn groups (cycles) will be examined for a dependency
4832 on a stalled insn that is candidate for premature removal from the queue
4833 of stalled insns. Has an effect only during the second scheduling pass,
4834 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4835
4836 @item -fsched2-use-superblocks
4837 @opindex fsched2-use-superblocks
4838 When scheduling after register allocation, do use superblock scheduling
4839 algorithm. Superblock scheduling allows motion across basic block boundaries
4840 resulting on faster schedules. This option is experimental, as not all machine
4841 descriptions used by GCC model the CPU closely enough to avoid unreliable
4842 results from the algorithm.
4843
4844 This only makes sense when scheduling after register allocation, i.e.@: with
4845 @option{-fschedule-insns2} or at @option{-O2} or higher.
4846
4847 @item -fsched2-use-traces
4848 @opindex fsched2-use-traces
4849 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4850 allocation and additionally perform code duplication in order to increase the
4851 size of superblocks using tracer pass. See @option{-ftracer} for details on
4852 trace formation.
4853
4854 This mode should produce faster but significantly longer programs. Also
4855 without @option{-fbranch-probabilities} the traces constructed may not
4856 match the reality and hurt the performance. This only makes
4857 sense when scheduling after register allocation, i.e.@: with
4858 @option{-fschedule-insns2} or at @option{-O2} or higher.
4859
4860 @item -freschedule-modulo-scheduled-loops
4861 @opindex fscheduling-in-modulo-scheduled-loops
4862 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4863 we may want to prevent the later scheduling passes from changing its schedule, we use this
4864 option to control that.
4865
4866 @item -fcaller-saves
4867 @opindex fcaller-saves
4868 Enable values to be allocated in registers that will be clobbered by
4869 function calls, by emitting extra instructions to save and restore the
4870 registers around such calls. Such allocation is done only when it
4871 seems to result in better code than would otherwise be produced.
4872
4873 This option is always enabled by default on certain machines, usually
4874 those which have no call-preserved registers to use instead.
4875
4876 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4877
4878 @item -ftree-pre
4879 Perform Partial Redundancy Elimination (PRE) on trees. This flag is
4880 enabled by default at @option{-O2} and @option{-O3}.
4881
4882 @item -ftree-fre
4883 Perform Full Redundancy Elimination (FRE) on trees. The difference
4884 between FRE and PRE is that FRE only considers expressions
4885 that are computed on all paths leading to the redundant computation.
4886 This analysis faster than PRE, though it exposes fewer redundancies.
4887 This flag is enabled by default at @option{-O} and higher.
4888
4889 @item -ftree-copy-prop
4890 Perform copy propagation on trees. This pass eliminates unnecessary
4891 copy operations. This flag is enabled by default at @option{-O} and
4892 higher.
4893
4894 @item -ftree-store-copy-prop
4895 Perform copy propagation of memory loads and stores. This pass
4896 eliminates unnecessary copy operations in memory references
4897 (structures, global variables, arrays, etc). This flag is enabled by
4898 default at @option{-O2} and higher.
4899
4900 @item -ftree-salias
4901 Perform structural alias analysis on trees. This flag
4902 is enabled by default at @option{-O} and higher.
4903
4904 @item -ftree-sink
4905 Perform forward store motion on trees. This flag is
4906 enabled by default at @option{-O} and higher.
4907
4908 @item -ftree-ccp
4909 Perform sparse conditional constant propagation (CCP) on trees. This
4910 pass only operates on local scalar variables and is enabled by default
4911 at @option{-O} and higher.
4912
4913 @item -ftree-store-ccp
4914 Perform sparse conditional constant propagation (CCP) on trees. This
4915 pass operates on both local scalar variables and memory stores and
4916 loads (global variables, structures, arrays, etc). This flag is
4917 enabled by default at @option{-O2} and higher.
4918
4919 @item -ftree-dce
4920 Perform dead code elimination (DCE) on trees. This flag is enabled by
4921 default at @option{-O} and higher.
4922
4923 @item -ftree-dominator-opts
4924 Perform dead code elimination (DCE) on trees. This flag is enabled by
4925 default at @option{-O} and higher.
4926
4927 @item -ftree-ch
4928 Perform loop header copying on trees. This is beneficial since it increases
4929 effectiveness of code motion optimizations. It also saves one jump. This flag
4930 is enabled by default at @option{-O} and higher. It is not enabled
4931 for @option{-Os}, since it usually increases code size.
4932
4933 @item -ftree-loop-optimize
4934 Perform loop optimizations on trees. This flag is enabled by default
4935 at @option{-O} and higher.
4936
4937 @item -ftree-loop-linear
4938 Perform linear loop transformations on tree. This flag can improve cache
4939 performance and allow further loop optimizations to take place.
4940
4941 @item -ftree-loop-im
4942 Perform loop invariant motion on trees. This pass moves only invariants that
4943 would be hard to handle at RTL level (function calls, operations that expand to
4944 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
4945 operands of conditions that are invariant out of the loop, so that we can use
4946 just trivial invariantness analysis in loop unswitching. The pass also includes
4947 store motion.
4948
4949 @item -ftree-loop-ivcanon
4950 Create a canonical counter for number of iterations in the loop for that
4951 determining number of iterations requires complicated analysis. Later
4952 optimizations then may determine the number easily. Useful especially
4953 in connection with unrolling.
4954
4955 @item -fivopts
4956 Perform induction variable optimizations (strength reduction, induction
4957 variable merging and induction variable elimination) on trees.
4958
4959 @item -ftree-sra
4960 Perform scalar replacement of aggregates. This pass replaces structure
4961 references with scalars to prevent committing structures to memory too
4962 early. This flag is enabled by default at @option{-O} and higher.
4963
4964 @item -ftree-copyrename
4965 Perform copy renaming on trees. This pass attempts to rename compiler
4966 temporaries to other variables at copy locations, usually resulting in
4967 variable names which more closely resemble the original variables. This flag
4968 is enabled by default at @option{-O} and higher.
4969
4970 @item -ftree-ter
4971 Perform temporary expression replacement during the SSA->normal phase. Single
4972 use/single def temporaries are replaced at their use location with their
4973 defining expression. This results in non-GIMPLE code, but gives the expanders
4974 much more complex trees to work on resulting in better RTL generation. This is
4975 enabled by default at @option{-O} and higher.
4976
4977 @item -ftree-lrs
4978 Perform live range splitting during the SSA->normal phase. Distinct live
4979 ranges of a variable are split into unique variables, allowing for better
4980 optimization later. This is enabled by default at @option{-O} and higher.
4981
4982 @item -ftree-vectorize
4983 Perform loop vectorization on trees.
4984
4985 @item -ftree-vrp
4986 Perform Value Range Propagation on trees. This is similar to the
4987 constant propagation pass, but instead of values, ranges of values are
4988 propagated. This allows the optimizers to remove unnecessary range
4989 checks like array bound checks and null pointer checks. This is
4990 enabled by default at @option{-O2} and higher. Null pointer check
4991 elimination is only done if @option{-fdelete-null-pointer-checks} is
4992 enabled.
4993
4994 @item -ftracer
4995 @opindex ftracer
4996 Perform tail duplication to enlarge superblock size. This transformation
4997 simplifies the control flow of the function allowing other optimizations to do
4998 better job.
4999
5000 @item -funroll-loops
5001 @opindex funroll-loops
5002 Unroll loops whose number of iterations can be determined at compile
5003 time or upon entry to the loop. @option{-funroll-loops} implies both
5004 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
5005 option makes code larger, and may or may not make it run faster.
5006
5007 @item -funroll-all-loops
5008 @opindex funroll-all-loops
5009 Unroll all loops, even if their number of iterations is uncertain when
5010 the loop is entered. This usually makes programs run more slowly.
5011 @option{-funroll-all-loops} implies the same options as
5012 @option{-funroll-loops},
5013
5014 @item -fsplit-ivs-in-unroller
5015 @opindex -fsplit-ivs-in-unroller
5016 Enables expressing of values of induction variables in later iterations
5017 of the unrolled loop using the value in the first iteration. This breaks
5018 long dependency chains, thus improving efficiency of the scheduling passes
5019 (for best results, @option{-fweb} should be used as well).
5020
5021 Combination of @option{-fweb} and CSE is often sufficient to obtain the
5022 same effect. However in cases the loop body is more complicated than
5023 a single basic block, this is not reliable. It also does not work at all
5024 on some of the architectures due to restrictions in the CSE pass.
5025
5026 This optimization is enabled by default.
5027
5028 @item -fvariable-expansion-in-unroller
5029 @opindex -fvariable-expansion-in-unroller
5030 With this option, the compiler will create multiple copies of some
5031 local variables when unrolling a loop which can result in superior code.
5032
5033 @item -fprefetch-loop-arrays
5034 @opindex fprefetch-loop-arrays
5035 If supported by the target machine, generate instructions to prefetch
5036 memory to improve the performance of loops that access large arrays.
5037
5038 These options may generate better or worse code; results are highly
5039 dependent on the structure of loops within the source code.
5040
5041 @item -fno-peephole
5042 @itemx -fno-peephole2
5043 @opindex fno-peephole
5044 @opindex fno-peephole2
5045 Disable any machine-specific peephole optimizations. The difference
5046 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
5047 are implemented in the compiler; some targets use one, some use the
5048 other, a few use both.
5049
5050 @option{-fpeephole} is enabled by default.
5051 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5052
5053 @item -fno-guess-branch-probability
5054 @opindex fno-guess-branch-probability
5055 Do not guess branch probabilities using heuristics.
5056
5057 GCC will use heuristics to guess branch probabilities if they are
5058 not provided by profiling feedback (@option{-fprofile-arcs}). These
5059 heuristics are based on the control flow graph. If some branch probabilities
5060 are specified by @samp{__builtin_expect}, then the heuristics will be
5061 used to guess branch probabilities for the rest of the control flow graph,
5062 taking the @samp{__builtin_expect} info into account. The interactions
5063 between the heuristics and @samp{__builtin_expect} can be complex, and in
5064 some cases, it may be useful to disable the heuristics so that the effects
5065 of @samp{__builtin_expect} are easier to understand.
5066
5067 The default is @option{-fguess-branch-probability} at levels
5068 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5069
5070 @item -freorder-blocks
5071 @opindex freorder-blocks
5072 Reorder basic blocks in the compiled function in order to reduce number of
5073 taken branches and improve code locality.
5074
5075 Enabled at levels @option{-O2}, @option{-O3}.
5076
5077 @item -freorder-blocks-and-partition
5078 @opindex freorder-blocks-and-partition
5079 In addition to reordering basic blocks in the compiled function, in order
5080 to reduce number of taken branches, partitions hot and cold basic blocks
5081 into separate sections of the assembly and .o files, to improve
5082 paging and cache locality performance.
5083
5084 This optimization is automatically turned off in the presence of
5085 exception handling, for linkonce sections, for functions with a user-defined
5086 section attribute and on any architecture that does not support named
5087 sections.
5088
5089 @item -freorder-functions
5090 @opindex freorder-functions
5091 Reorder functions in the object file in order to
5092 improve code locality. This is implemented by using special
5093 subsections @code{.text.hot} for most frequently executed functions and
5094 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
5095 the linker so object file format must support named sections and linker must
5096 place them in a reasonable way.
5097
5098 Also profile feedback must be available in to make this option effective. See
5099 @option{-fprofile-arcs} for details.
5100
5101 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5102
5103 @item -fstrict-aliasing
5104 @opindex fstrict-aliasing
5105 Allows the compiler to assume the strictest aliasing rules applicable to
5106 the language being compiled. For C (and C++), this activates
5107 optimizations based on the type of expressions. In particular, an
5108 object of one type is assumed never to reside at the same address as an
5109 object of a different type, unless the types are almost the same. For
5110 example, an @code{unsigned int} can alias an @code{int}, but not a
5111 @code{void*} or a @code{double}. A character type may alias any other
5112 type.
5113
5114 Pay special attention to code like this:
5115 @smallexample
5116 union a_union @{
5117 int i;
5118 double d;
5119 @};
5120
5121 int f() @{
5122 a_union t;
5123 t.d = 3.0;
5124 return t.i;
5125 @}
5126 @end smallexample
5127 The practice of reading from a different union member than the one most
5128 recently written to (called ``type-punning'') is common. Even with
5129 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5130 is accessed through the union type. So, the code above will work as
5131 expected. However, this code might not:
5132 @smallexample
5133 int f() @{
5134 a_union t;
5135 int* ip;
5136 t.d = 3.0;
5137 ip = &t.i;
5138 return *ip;
5139 @}
5140 @end smallexample
5141
5142 Every language that wishes to perform language-specific alias analysis
5143 should define a function that computes, given an @code{tree}
5144 node, an alias set for the node. Nodes in different alias sets are not
5145 allowed to alias. For an example, see the C front-end function
5146 @code{c_get_alias_set}.
5147
5148 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5149
5150 @item -falign-functions
5151 @itemx -falign-functions=@var{n}
5152 @opindex falign-functions
5153 Align the start of functions to the next power-of-two greater than
5154 @var{n}, skipping up to @var{n} bytes. For instance,
5155 @option{-falign-functions=32} aligns functions to the next 32-byte
5156 boundary, but @option{-falign-functions=24} would align to the next
5157 32-byte boundary only if this can be done by skipping 23 bytes or less.
5158
5159 @option{-fno-align-functions} and @option{-falign-functions=1} are
5160 equivalent and mean that functions will not be aligned.
5161
5162 Some assemblers only support this flag when @var{n} is a power of two;
5163 in that case, it is rounded up.
5164
5165 If @var{n} is not specified or is zero, use a machine-dependent default.
5166
5167 Enabled at levels @option{-O2}, @option{-O3}.
5168
5169 @item -falign-labels
5170 @itemx -falign-labels=@var{n}
5171 @opindex falign-labels
5172 Align all branch targets to a power-of-two boundary, skipping up to
5173 @var{n} bytes like @option{-falign-functions}. This option can easily
5174 make code slower, because it must insert dummy operations for when the
5175 branch target is reached in the usual flow of the code.
5176
5177 @option{-fno-align-labels} and @option{-falign-labels=1} are
5178 equivalent and mean that labels will not be aligned.
5179
5180 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5181 are greater than this value, then their values are used instead.
5182
5183 If @var{n} is not specified or is zero, use a machine-dependent default
5184 which is very likely to be @samp{1}, meaning no alignment.
5185
5186 Enabled at levels @option{-O2}, @option{-O3}.
5187
5188 @item -falign-loops
5189 @itemx -falign-loops=@var{n}
5190 @opindex falign-loops
5191 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5192 like @option{-falign-functions}. The hope is that the loop will be
5193 executed many times, which will make up for any execution of the dummy
5194 operations.
5195
5196 @option{-fno-align-loops} and @option{-falign-loops=1} are
5197 equivalent and mean that loops will not be aligned.
5198
5199 If @var{n} is not specified or is zero, use a machine-dependent default.
5200
5201 Enabled at levels @option{-O2}, @option{-O3}.
5202
5203 @item -falign-jumps
5204 @itemx -falign-jumps=@var{n}
5205 @opindex falign-jumps
5206 Align branch targets to a power-of-two boundary, for branch targets
5207 where the targets can only be reached by jumping, skipping up to @var{n}
5208 bytes like @option{-falign-functions}. In this case, no dummy operations
5209 need be executed.
5210
5211 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5212 equivalent and mean that loops will not be aligned.
5213
5214 If @var{n} is not specified or is zero, use a machine-dependent default.
5215
5216 Enabled at levels @option{-O2}, @option{-O3}.
5217
5218 @item -funit-at-a-time
5219 @opindex funit-at-a-time
5220 Parse the whole compilation unit before starting to produce code.
5221 This allows some extra optimizations to take place but consumes
5222 more memory (in general). There are some compatibility issues
5223 with @emph{unit-at-at-time} mode:
5224 @itemize @bullet
5225 @item
5226 enabling @emph{unit-at-a-time} mode may change the order
5227 in which functions, variables, and top-level @code{asm} statements
5228 are emitted, and will likely break code relying on some particular
5229 ordering. The majority of such top-level @code{asm} statements,
5230 though, can be replaced by @code{section} attributes.
5231
5232 @item
5233 @emph{unit-at-a-time} mode removes unreferenced static variables
5234 and functions. This may result in undefined references
5235 when an @code{asm} statement refers directly to variables or functions
5236 that are otherwise unused. In that case either the variable/function
5237 shall be listed as an operand of the @code{asm} statement operand or,
5238 in the case of top-level @code{asm} statements the attribute @code{used}
5239 shall be used on the declaration.
5240
5241 @item
5242 Static functions now can use non-standard passing conventions that
5243 may break @code{asm} statements calling functions directly. Again,
5244 attribute @code{used} will prevent this behavior.
5245 @end itemize
5246
5247 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5248 but this scheme may not be supported by future releases of GCC@.
5249
5250 Enabled at levels @option{-O2}, @option{-O3}.
5251
5252 @item -fweb
5253 @opindex fweb
5254 Constructs webs as commonly used for register allocation purposes and assign
5255 each web individual pseudo register. This allows the register allocation pass
5256 to operate on pseudos directly, but also strengthens several other optimization
5257 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5258 however, make debugging impossible, since variables will no longer stay in a
5259 ``home register''.
5260
5261 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5262 on targets where the default format for debugging information supports
5263 variable tracking.
5264
5265 @item -fwhole-program
5266 @opindex fwhole-program
5267 Assume that the current compilation unit represents whole program being
5268 compiled. All public functions and variables with the exception of @code{main}
5269 and those merged by attribute @code{externally_visible} become static functions
5270 and in a affect gets more aggressively optimized by interprocedural optimizers.
5271 While this option is equivalent to proper use of @code{static} keyword for
5272 programs consisting of single file, in combination with option
5273 @option{--combine} this flag can be used to compile most of smaller scale C
5274 programs since the functions and variables become local for the whole combined
5275 compilation unit, not for the single source file itself.
5276
5277
5278 @item -fno-cprop-registers
5279 @opindex fno-cprop-registers
5280 After register allocation and post-register allocation instruction splitting,
5281 we perform a copy-propagation pass to try to reduce scheduling dependencies
5282 and occasionally eliminate the copy.
5283
5284 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5285
5286 @item -fprofile-generate
5287 @opindex fprofile-generate
5288
5289 Enable options usually used for instrumenting application to produce
5290 profile useful for later recompilation with profile feedback based
5291 optimization. You must use @option{-fprofile-generate} both when
5292 compiling and when linking your program.
5293
5294 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5295
5296 @item -fprofile-use
5297 @opindex fprofile-use
5298 Enable profile feedback directed optimizations, and optimizations
5299 generally profitable only with profile feedback available.
5300
5301 The following options are enabled: @code{-fbranch-probabilities},
5302 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5303
5304 @end table
5305
5306 The following options control compiler behavior regarding floating
5307 point arithmetic. These options trade off between speed and
5308 correctness. All must be specifically enabled.
5309
5310 @table @gcctabopt
5311 @item -ffloat-store
5312 @opindex ffloat-store
5313 Do not store floating point variables in registers, and inhibit other
5314 options that might change whether a floating point value is taken from a
5315 register or memory.
5316
5317 @cindex floating point precision
5318 This option prevents undesirable excess precision on machines such as
5319 the 68000 where the floating registers (of the 68881) keep more
5320 precision than a @code{double} is supposed to have. Similarly for the
5321 x86 architecture. For most programs, the excess precision does only
5322 good, but a few programs rely on the precise definition of IEEE floating
5323 point. Use @option{-ffloat-store} for such programs, after modifying
5324 them to store all pertinent intermediate computations into variables.
5325
5326 @item -ffast-math
5327 @opindex ffast-math
5328 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5329 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5330 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5331 and @option{fcx-limited-range}.
5332
5333 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5334
5335 This option should never be turned on by any @option{-O} option since
5336 it can result in incorrect output for programs which depend on
5337 an exact implementation of IEEE or ISO rules/specifications for
5338 math functions.
5339
5340 @item -fno-math-errno
5341 @opindex fno-math-errno
5342 Do not set ERRNO after calling math functions that are executed
5343 with a single instruction, e.g., sqrt. A program that relies on
5344 IEEE exceptions for math error handling may want to use this flag
5345 for speed while maintaining IEEE arithmetic compatibility.
5346
5347 This option should never be turned on by any @option{-O} option since
5348 it can result in incorrect output for programs which depend on
5349 an exact implementation of IEEE or ISO rules/specifications for
5350 math functions.
5351
5352 The default is @option{-fmath-errno}.
5353
5354 On Darwin systems, the math library never sets @code{errno}. There is therefore
5355 no reason for the compiler to consider the possibility that it might,
5356 and @option{-fno-math-errno} is the default.
5357
5358 @item -funsafe-math-optimizations
5359 @opindex funsafe-math-optimizations
5360 Allow optimizations for floating-point arithmetic that (a) assume
5361 that arguments and results are valid and (b) may violate IEEE or
5362 ANSI standards. When used at link-time, it may include libraries
5363 or startup files that change the default FPU control word or other
5364 similar optimizations.
5365
5366 This option should never be turned on by any @option{-O} option since
5367 it can result in incorrect output for programs which depend on
5368 an exact implementation of IEEE or ISO rules/specifications for
5369 math functions.
5370
5371 The default is @option{-fno-unsafe-math-optimizations}.
5372
5373 @item -ffinite-math-only
5374 @opindex ffinite-math-only
5375 Allow optimizations for floating-point arithmetic that assume
5376 that arguments and results are not NaNs or +-Infs.
5377
5378 This option should never be turned on by any @option{-O} option since
5379 it can result in incorrect output for programs which depend on
5380 an exact implementation of IEEE or ISO rules/specifications.
5381
5382 The default is @option{-fno-finite-math-only}.
5383
5384 @item -fno-trapping-math
5385 @opindex fno-trapping-math
5386 Compile code assuming that floating-point operations cannot generate
5387 user-visible traps. These traps include division by zero, overflow,
5388 underflow, inexact result and invalid operation. This option implies
5389 @option{-fno-signaling-nans}. Setting this option may allow faster
5390 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5391
5392 This option should never be turned on by any @option{-O} option since
5393 it can result in incorrect output for programs which depend on
5394 an exact implementation of IEEE or ISO rules/specifications for
5395 math functions.
5396
5397 The default is @option{-ftrapping-math}.
5398
5399 @item -frounding-math
5400 @opindex frounding-math
5401 Disable transformations and optimizations that assume default floating
5402 point rounding behavior. This is round-to-zero for all floating point
5403 to integer conversions, and round-to-nearest for all other arithmetic
5404 truncations. This option should be specified for programs that change
5405 the FP rounding mode dynamically, or that may be executed with a
5406 non-default rounding mode. This option disables constant folding of
5407 floating point expressions at compile-time (which may be affected by
5408 rounding mode) and arithmetic transformations that are unsafe in the
5409 presence of sign-dependent rounding modes.
5410
5411 The default is @option{-fno-rounding-math}.
5412
5413 This option is experimental and does not currently guarantee to
5414 disable all GCC optimizations that are affected by rounding mode.
5415 Future versions of GCC may provide finer control of this setting
5416 using C99's @code{FENV_ACCESS} pragma. This command line option
5417 will be used to specify the default state for @code{FENV_ACCESS}.
5418
5419 @item -fsignaling-nans
5420 @opindex fsignaling-nans
5421 Compile code assuming that IEEE signaling NaNs may generate user-visible
5422 traps during floating-point operations. Setting this option disables
5423 optimizations that may change the number of exceptions visible with
5424 signaling NaNs. This option implies @option{-ftrapping-math}.
5425
5426 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5427 be defined.
5428
5429 The default is @option{-fno-signaling-nans}.
5430
5431 This option is experimental and does not currently guarantee to
5432 disable all GCC optimizations that affect signaling NaN behavior.
5433
5434 @item -fsingle-precision-constant
5435 @opindex fsingle-precision-constant
5436 Treat floating point constant as single precision constant instead of
5437 implicitly converting it to double precision constant.
5438
5439 @item -fcx-limited-range
5440 @itemx -fno-cx-limited-range
5441 @opindex fcx-limited-range
5442 @opindex fno-cx-limited-range
5443 When enabled, this option states that a range reduction step is not
5444 needed when performing complex division. The default is
5445 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5446
5447 This option controls the default setting of the ISO C99
5448 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5449 all languages.
5450
5451 @end table
5452
5453 The following options control optimizations that may improve
5454 performance, but are not enabled by any @option{-O} options. This
5455 section includes experimental options that may produce broken code.
5456
5457 @table @gcctabopt
5458 @item -fbranch-probabilities
5459 @opindex fbranch-probabilities
5460 After running a program compiled with @option{-fprofile-arcs}
5461 (@pxref{Debugging Options,, Options for Debugging Your Program or
5462 @command{gcc}}), you can compile it a second time using
5463 @option{-fbranch-probabilities}, to improve optimizations based on
5464 the number of times each branch was taken. When the program
5465 compiled with @option{-fprofile-arcs} exits it saves arc execution
5466 counts to a file called @file{@var{sourcename}.gcda} for each source
5467 file The information in this data file is very dependent on the
5468 structure of the generated code, so you must use the same source code
5469 and the same optimization options for both compilations.
5470
5471 With @option{-fbranch-probabilities}, GCC puts a
5472 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5473 These can be used to improve optimization. Currently, they are only
5474 used in one place: in @file{reorg.c}, instead of guessing which path a
5475 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5476 exactly determine which path is taken more often.
5477
5478 @item -fprofile-values
5479 @opindex fprofile-values
5480 If combined with @option{-fprofile-arcs}, it adds code so that some
5481 data about values of expressions in the program is gathered.
5482
5483 With @option{-fbranch-probabilities}, it reads back the data gathered
5484 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5485 notes to instructions for their later usage in optimizations.
5486
5487 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5488
5489 @item -fvpt
5490 @opindex fvpt
5491 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5492 a code to gather information about values of expressions.
5493
5494 With @option{-fbranch-probabilities}, it reads back the data gathered
5495 and actually performs the optimizations based on them.
5496 Currently the optimizations include specialization of division operation
5497 using the knowledge about the value of the denominator.
5498
5499 @item -fspeculative-prefetching
5500 @opindex fspeculative-prefetching
5501 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5502 a code to gather information about addresses of memory references in the
5503 program.
5504
5505 With @option{-fbranch-probabilities}, it reads back the data gathered
5506 and issues prefetch instructions according to them. In addition to the opportunities
5507 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5508 memory access patterns---for example accesses to the data stored in linked
5509 list whose elements are usually allocated sequentially.
5510
5511 In order to prevent issuing double prefetches, usage of
5512 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5513
5514 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5515
5516 @item -frename-registers
5517 @opindex frename-registers
5518 Attempt to avoid false dependencies in scheduled code by making use
5519 of registers left over after register allocation. This optimization
5520 will most benefit processors with lots of registers. Depending on the
5521 debug information format adopted by the target, however, it can
5522 make debugging impossible, since variables will no longer stay in
5523 a ``home register''.
5524
5525 Not enabled by default at any level because it has known bugs.
5526
5527 @item -ftracer
5528 @opindex ftracer
5529 Perform tail duplication to enlarge superblock size. This transformation
5530 simplifies the control flow of the function allowing other optimizations to do
5531 better job.
5532
5533 Enabled with @option{-fprofile-use}.
5534
5535 @item -funroll-loops
5536 @opindex funroll-loops
5537 Unroll loops whose number of iterations can be determined at compile time or
5538 upon entry to the loop. @option{-funroll-loops} implies
5539 @option{-frerun-cse-after-loop}. It also turns on complete loop peeling
5540 (i.e.@: complete removal of loops with small constant number of iterations).
5541 This option makes code larger, and may or may not make it run faster.
5542
5543 Enabled with @option{-fprofile-use}.
5544
5545 @item -funroll-all-loops
5546 @opindex funroll-all-loops
5547 Unroll all loops, even if their number of iterations is uncertain when
5548 the loop is entered. This usually makes programs run more slowly.
5549 @option{-funroll-all-loops} implies the same options as
5550 @option{-funroll-loops}.
5551
5552 @item -fpeel-loops
5553 @opindex fpeel-loops
5554 Peels the loops for that there is enough information that they do not
5555 roll much (from profile feedback). It also turns on complete loop peeling
5556 (i.e.@: complete removal of loops with small constant number of iterations).
5557
5558 Enabled with @option{-fprofile-use}.
5559
5560 @item -fmove-loop-invariants
5561 @opindex fmove-loop-invariants
5562 Enables the loop invariant motion pass in the new loop optimizer. Enabled
5563 at level @option{-O1}
5564
5565 @item -funswitch-loops
5566 @opindex funswitch-loops
5567 Move branches with loop invariant conditions out of the loop, with duplicates
5568 of the loop on both branches (modified according to result of the condition).
5569
5570 @item -fprefetch-loop-arrays
5571 @opindex fprefetch-loop-arrays
5572 If supported by the target machine, generate instructions to prefetch
5573 memory to improve the performance of loops that access large arrays.
5574
5575 Disabled at level @option{-Os}.
5576
5577 @item -ffunction-sections
5578 @itemx -fdata-sections
5579 @opindex ffunction-sections
5580 @opindex fdata-sections
5581 Place each function or data item into its own section in the output
5582 file if the target supports arbitrary sections. The name of the
5583 function or the name of the data item determines the section's name
5584 in the output file.
5585
5586 Use these options on systems where the linker can perform optimizations
5587 to improve locality of reference in the instruction space. Most systems
5588 using the ELF object format and SPARC processors running Solaris 2 have
5589 linkers with such optimizations. AIX may have these optimizations in
5590 the future.
5591
5592 Only use these options when there are significant benefits from doing
5593 so. When you specify these options, the assembler and linker will
5594 create larger object and executable files and will also be slower.
5595 You will not be able to use @code{gprof} on all systems if you
5596 specify this option and you may have problems with debugging if
5597 you specify both this option and @option{-g}.
5598
5599 @item -fbranch-target-load-optimize
5600 @opindex fbranch-target-load-optimize
5601 Perform branch target register load optimization before prologue / epilogue
5602 threading.
5603 The use of target registers can typically be exposed only during reload,
5604 thus hoisting loads out of loops and doing inter-block scheduling needs
5605 a separate optimization pass.
5606
5607 @item -fbranch-target-load-optimize2
5608 @opindex fbranch-target-load-optimize2
5609 Perform branch target register load optimization after prologue / epilogue
5610 threading.
5611
5612 @item -fbtr-bb-exclusive
5613 @opindex fbtr-bb-exclusive
5614 When performing branch target register load optimization, don't reuse
5615 branch target registers in within any basic block.
5616
5617 @item --param @var{name}=@var{value}
5618 @opindex param
5619 In some places, GCC uses various constants to control the amount of
5620 optimization that is done. For example, GCC will not inline functions
5621 that contain more that a certain number of instructions. You can
5622 control some of these constants on the command-line using the
5623 @option{--param} option.
5624
5625 The names of specific parameters, and the meaning of the values, are
5626 tied to the internals of the compiler, and are subject to change
5627 without notice in future releases.
5628
5629 In each case, the @var{value} is an integer. The allowable choices for
5630 @var{name} are given in the following table:
5631
5632 @table @gcctabopt
5633 @item salias-max-implicit-fields
5634 The maximum number of fields in a variable without direct
5635 structure accesses for which structure aliasing will consider trying
5636 to track each field. The default is 5
5637
5638 @item sra-max-structure-size
5639 The maximum structure size, in bytes, at which the scalar replacement
5640 of aggregates (SRA) optimization will perform block copies. The
5641 default value, 0, implies that GCC will select the most appropriate
5642 size itself.
5643
5644 @item sra-field-structure-ratio
5645 The threshold ratio (as a percentage) between instantiated fields and
5646 the complete structure size. We say that if the ratio of the number
5647 of bytes in instantiated fields to the number of bytes in the complete
5648 structure exceeds this parameter, then block copies are not used. The
5649 default is 75.
5650
5651 @item max-crossjump-edges
5652 The maximum number of incoming edges to consider for crossjumping.
5653 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5654 the number of edges incoming to each block. Increasing values mean
5655 more aggressive optimization, making the compile time increase with
5656 probably small improvement in executable size.
5657
5658 @item min-crossjump-insns
5659 The minimum number of instructions which must be matched at the end
5660 of two blocks before crossjumping will be performed on them. This
5661 value is ignored in the case where all instructions in the block being
5662 crossjumped from are matched. The default value is 5.
5663
5664 @item max-goto-duplication-insns
5665 The maximum number of instructions to duplicate to a block that jumps
5666 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5667 passes, GCC factors computed gotos early in the compilation process,
5668 and unfactors them as late as possible. Only computed jumps at the
5669 end of a basic blocks with no more than max-goto-duplication-insns are
5670 unfactored. The default value is 8.
5671
5672 @item max-delay-slot-insn-search
5673 The maximum number of instructions to consider when looking for an
5674 instruction to fill a delay slot. If more than this arbitrary number of
5675 instructions is searched, the time savings from filling the delay slot
5676 will be minimal so stop searching. Increasing values mean more
5677 aggressive optimization, making the compile time increase with probably
5678 small improvement in executable run time.
5679
5680 @item max-delay-slot-live-search
5681 When trying to fill delay slots, the maximum number of instructions to
5682 consider when searching for a block with valid live register
5683 information. Increasing this arbitrarily chosen value means more
5684 aggressive optimization, increasing the compile time. This parameter
5685 should be removed when the delay slot code is rewritten to maintain the
5686 control-flow graph.
5687
5688 @item max-gcse-memory
5689 The approximate maximum amount of memory that will be allocated in
5690 order to perform the global common subexpression elimination
5691 optimization. If more memory than specified is required, the
5692 optimization will not be done.
5693
5694 @item max-gcse-passes
5695 The maximum number of passes of GCSE to run. The default is 1.
5696
5697 @item max-pending-list-length
5698 The maximum number of pending dependencies scheduling will allow
5699 before flushing the current state and starting over. Large functions
5700 with few branches or calls can create excessively large lists which
5701 needlessly consume memory and resources.
5702
5703 @item max-inline-insns-single
5704 Several parameters control the tree inliner used in gcc.
5705 This number sets the maximum number of instructions (counted in GCC's
5706 internal representation) in a single function that the tree inliner
5707 will consider for inlining. This only affects functions declared
5708 inline and methods implemented in a class declaration (C++).
5709 The default value is 450.
5710
5711 @item max-inline-insns-auto
5712 When you use @option{-finline-functions} (included in @option{-O3}),
5713 a lot of functions that would otherwise not be considered for inlining
5714 by the compiler will be investigated. To those functions, a different
5715 (more restrictive) limit compared to functions declared inline can
5716 be applied.
5717 The default value is 90.
5718
5719 @item large-function-insns
5720 The limit specifying really large functions. For functions larger than this
5721 limit after inlining inlining is constrained by
5722 @option{--param large-function-growth}. This parameter is useful primarily
5723 to avoid extreme compilation time caused by non-linear algorithms used by the
5724 backend.
5725 This parameter is ignored when @option{-funit-at-a-time} is not used.
5726 The default value is 2700.
5727
5728 @item large-function-growth
5729 Specifies maximal growth of large function caused by inlining in percents.
5730 This parameter is ignored when @option{-funit-at-a-time} is not used.
5731 The default value is 100 which limits large function growth to 2.0 times
5732 the original size.
5733
5734 @item inline-unit-growth
5735 Specifies maximal overall growth of the compilation unit caused by inlining.
5736 This parameter is ignored when @option{-funit-at-a-time} is not used.
5737 The default value is 50 which limits unit growth to 1.5 times the original
5738 size.
5739
5740 @item max-inline-insns-recursive
5741 @itemx max-inline-insns-recursive-auto
5742 Specifies maximum number of instructions out-of-line copy of self recursive inline
5743 function can grow into by performing recursive inlining.
5744
5745 For functions declared inline @option{--param max-inline-insns-recursive} is
5746 taken into acount. For function not declared inline, recursive inlining
5747 happens only when @option{-finline-functions} (included in @option{-O3}) is
5748 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
5749 default value is 450.
5750
5751 @item max-inline-recursive-depth
5752 @itemx max-inline-recursive-depth-auto
5753 Specifies maximum recursion depth used by the recursive inlining.
5754
5755 For functions declared inline @option{--param max-inline-recursive-depth} is
5756 taken into acount. For function not declared inline, recursive inlining
5757 happens only when @option{-finline-functions} (included in @option{-O3}) is
5758 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
5759 default value is 450.
5760
5761 @item inline-call-cost
5762 Specify cost of call instruction relative to simple arithmetics operations
5763 (having cost of 1). Increasing this cost disqualifies inlining of non-leaf
5764 functions and at the same time increases size of leaf function that is believed to
5765 reduce function size by being inlined. In effect it increases amount of
5766 inlining for code having large abstraction penalty (many functions that just
5767 pass the arguments to other functions) and decrease inlining for code with low
5768 abstraction penalty. The default value is 16.
5769
5770 @item max-unrolled-insns
5771 The maximum number of instructions that a loop should have if that loop
5772 is unrolled, and if the loop is unrolled, it determines how many times
5773 the loop code is unrolled.
5774
5775 @item max-average-unrolled-insns
5776 The maximum number of instructions biased by probabilities of their execution
5777 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5778 it determines how many times the loop code is unrolled.
5779
5780 @item max-unroll-times
5781 The maximum number of unrollings of a single loop.
5782
5783 @item max-peeled-insns
5784 The maximum number of instructions that a loop should have if that loop
5785 is peeled, and if the loop is peeled, it determines how many times
5786 the loop code is peeled.
5787
5788 @item max-peel-times
5789 The maximum number of peelings of a single loop.
5790
5791 @item max-completely-peeled-insns
5792 The maximum number of insns of a completely peeled loop.
5793
5794 @item max-completely-peel-times
5795 The maximum number of iterations of a loop to be suitable for complete peeling.
5796
5797 @item max-unswitch-insns
5798 The maximum number of insns of an unswitched loop.
5799
5800 @item max-unswitch-level
5801 The maximum number of branches unswitched in a single loop.
5802
5803 @item lim-expensive
5804 The minimum cost of an expensive expression in the loop invariant motion.
5805
5806 @item iv-consider-all-candidates-bound
5807 Bound on number of candidates for induction variables below that
5808 all candidates are considered for each use in induction variable
5809 optimizations. Only the most relevant candidates are considered
5810 if there are more candidates, to avoid quadratic time complexity.
5811
5812 @item iv-max-considered-uses
5813 The induction variable optimizations give up on loops that contain more
5814 induction variable uses.
5815
5816 @item iv-always-prune-cand-set-bound
5817 If number of candidates in the set is smaller than this value,
5818 we always try to remove unnecessary ivs from the set during its
5819 optimization when a new iv is added to the set.
5820
5821 @item scev-max-expr-size
5822 Bound on size of expressions used in the scalar evolutions analyzer.
5823 Large expressions slow the analyzer.
5824
5825 @item max-iterations-to-track
5826
5827 The maximum number of iterations of a loop the brute force algorithm
5828 for analysis of # of iterations of the loop tries to evaluate.
5829
5830 @item hot-bb-count-fraction
5831 Select fraction of the maximal count of repetitions of basic block in program
5832 given basic block needs to have to be considered hot.
5833
5834 @item hot-bb-frequency-fraction
5835 Select fraction of the maximal frequency of executions of basic block in
5836 function given basic block needs to have to be considered hot
5837
5838 @item tracer-dynamic-coverage
5839 @itemx tracer-dynamic-coverage-feedback
5840
5841 This value is used to limit superblock formation once the given percentage of
5842 executed instructions is covered. This limits unnecessary code size
5843 expansion.
5844
5845 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5846 feedback is available. The real profiles (as opposed to statically estimated
5847 ones) are much less balanced allowing the threshold to be larger value.
5848
5849 @item tracer-max-code-growth
5850 Stop tail duplication once code growth has reached given percentage. This is
5851 rather hokey argument, as most of the duplicates will be eliminated later in
5852 cross jumping, so it may be set to much higher values than is the desired code
5853 growth.
5854
5855 @item tracer-min-branch-ratio
5856
5857 Stop reverse growth when the reverse probability of best edge is less than this
5858 threshold (in percent).
5859
5860 @item tracer-min-branch-ratio
5861 @itemx tracer-min-branch-ratio-feedback
5862
5863 Stop forward growth if the best edge do have probability lower than this
5864 threshold.
5865
5866 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5867 compilation for profile feedback and one for compilation without. The value
5868 for compilation with profile feedback needs to be more conservative (higher) in
5869 order to make tracer effective.
5870
5871 @item max-cse-path-length
5872
5873 Maximum number of basic blocks on path that cse considers. The default is 10.
5874
5875 @item global-var-threshold
5876
5877 Counts the number of function calls (@var{n}) and the number of
5878 call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
5879 single artificial variable will be created to represent all the
5880 call-clobbered variables at function call sites. This artificial
5881 variable will then be made to alias every call-clobbered variable.
5882 (done as @code{int * size_t} on the host machine; beware overflow).
5883
5884 @item max-aliased-vops
5885
5886 Maximum number of virtual operands allowed to represent aliases
5887 before triggering the alias grouping heuristic. Alias grouping
5888 reduces compile times and memory consumption needed for aliasing at
5889 the expense of precision loss in alias information.
5890
5891 @item ggc-min-expand
5892
5893 GCC uses a garbage collector to manage its own memory allocation. This
5894 parameter specifies the minimum percentage by which the garbage
5895 collector's heap should be allowed to expand between collections.
5896 Tuning this may improve compilation speed; it has no effect on code
5897 generation.
5898
5899 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5900 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
5901 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
5902 GCC is not able to calculate RAM on a particular platform, the lower
5903 bound of 30% is used. Setting this parameter and
5904 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5905 every opportunity. This is extremely slow, but can be useful for
5906 debugging.
5907
5908 @item ggc-min-heapsize
5909
5910 Minimum size of the garbage collector's heap before it begins bothering
5911 to collect garbage. The first collection occurs after the heap expands
5912 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
5913 tuning this may improve compilation speed, and has no effect on code
5914 generation.
5915
5916 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5917 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5918 with a lower bound of 4096 (four megabytes) and an upper bound of
5919 131072 (128 megabytes). If GCC is not able to calculate RAM on a
5920 particular platform, the lower bound is used. Setting this parameter
5921 very large effectively disables garbage collection. Setting this
5922 parameter and @option{ggc-min-expand} to zero causes a full collection
5923 to occur at every opportunity.
5924
5925 @item max-reload-search-insns
5926 The maximum number of instruction reload should look backward for equivalent
5927 register. Increasing values mean more aggressive optimization, making the
5928 compile time increase with probably slightly better performance. The default
5929 value is 100.
5930
5931 @item max-cselib-memory-location
5932 The maximum number of memory locations cselib should take into acount.
5933 Increasing values mean more aggressive optimization, making the compile time
5934 increase with probably slightly better performance. The default value is 500.
5935
5936 @item reorder-blocks-duplicate
5937 @itemx reorder-blocks-duplicate-feedback
5938
5939 Used by basic block reordering pass to decide whether to use unconditional
5940 branch or duplicate the code on its destination. Code is duplicated when its
5941 estimated size is smaller than this value multiplied by the estimated size of
5942 unconditional jump in the hot spots of the program.
5943
5944 The @option{reorder-block-duplicate-feedback} is used only when profile
5945 feedback is available and may be set to higher values than
5946 @option{reorder-block-duplicate} since information about the hot spots is more
5947 accurate.
5948
5949 @item max-sched-region-blocks
5950 The maximum number of blocks in a region to be considered for
5951 interblock scheduling. The default value is 10.
5952
5953 @item max-sched-region-insns
5954 The maximum number of insns in a region to be considered for
5955 interblock scheduling. The default value is 100.
5956
5957 @item max-last-value-rtl
5958
5959 The maximum size measured as number of RTLs that can be recorded in an expression
5960 in combiner for a pseudo register as last known value of that register. The default
5961 is 10000.
5962
5963 @item integer-share-limit
5964 Small integer constants can use a shared data structure, reducing the
5965 compiler's memory usage and increasing its speed. This sets the maximum
5966 value of a shared integer constant's. The default value is 256.
5967
5968 @item min-virtual-mappings
5969 Specifies the minimum number of virtual mappings in the incremental
5970 SSA updater that should be registered to trigger the virtual mappings
5971 heuristic defined by virtual-mappings-ratio. The default value is
5972 100.
5973
5974 @item virtual-mappings-ratio
5975 If the number of virtual mappings is virtual-mappings-ratio bigger
5976 than the number of virtual symbols to be updated, then the incremental
5977 SSA updater switches to a full update for those symbols. The default
5978 ratio is 3.
5979
5980 @end table
5981 @end table
5982
5983 @node Preprocessor Options
5984 @section Options Controlling the Preprocessor
5985 @cindex preprocessor options
5986 @cindex options, preprocessor
5987
5988 These options control the C preprocessor, which is run on each C source
5989 file before actual compilation.
5990
5991 If you use the @option{-E} option, nothing is done except preprocessing.
5992 Some of these options make sense only together with @option{-E} because
5993 they cause the preprocessor output to be unsuitable for actual
5994 compilation.
5995
5996 @table @gcctabopt
5997 @opindex Wp
5998 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5999 and pass @var{option} directly through to the preprocessor. If
6000 @var{option} contains commas, it is split into multiple options at the
6001 commas. However, many options are modified, translated or interpreted
6002 by the compiler driver before being passed to the preprocessor, and
6003 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
6004 interface is undocumented and subject to change, so whenever possible
6005 you should avoid using @option{-Wp} and let the driver handle the
6006 options instead.
6007
6008 @item -Xpreprocessor @var{option}
6009 @opindex preprocessor
6010 Pass @var{option} as an option to the preprocessor. You can use this to
6011 supply system-specific preprocessor options which GCC does not know how to
6012 recognize.
6013
6014 If you want to pass an option that takes an argument, you must use
6015 @option{-Xpreprocessor} twice, once for the option and once for the argument.
6016 @end table
6017
6018 @include cppopts.texi
6019
6020 @node Assembler Options
6021 @section Passing Options to the Assembler
6022
6023 @c prevent bad page break with this line
6024 You can pass options to the assembler.
6025
6026 @table @gcctabopt
6027 @item -Wa,@var{option}
6028 @opindex Wa
6029 Pass @var{option} as an option to the assembler. If @var{option}
6030 contains commas, it is split into multiple options at the commas.
6031
6032 @item -Xassembler @var{option}
6033 @opindex Xassembler
6034 Pass @var{option} as an option to the assembler. You can use this to
6035 supply system-specific assembler options which GCC does not know how to
6036 recognize.
6037
6038 If you want to pass an option that takes an argument, you must use
6039 @option{-Xassembler} twice, once for the option and once for the argument.
6040
6041 @end table
6042
6043 @node Link Options
6044 @section Options for Linking
6045 @cindex link options
6046 @cindex options, linking
6047
6048 These options come into play when the compiler links object files into
6049 an executable output file. They are meaningless if the compiler is
6050 not doing a link step.
6051
6052 @table @gcctabopt
6053 @cindex file names
6054 @item @var{object-file-name}
6055 A file name that does not end in a special recognized suffix is
6056 considered to name an object file or library. (Object files are
6057 distinguished from libraries by the linker according to the file
6058 contents.) If linking is done, these object files are used as input
6059 to the linker.
6060
6061 @item -c
6062 @itemx -S
6063 @itemx -E
6064 @opindex c
6065 @opindex S
6066 @opindex E
6067 If any of these options is used, then the linker is not run, and
6068 object file names should not be used as arguments. @xref{Overall
6069 Options}.
6070
6071 @cindex Libraries
6072 @item -l@var{library}
6073 @itemx -l @var{library}
6074 @opindex l
6075 Search the library named @var{library} when linking. (The second
6076 alternative with the library as a separate argument is only for
6077 POSIX compliance and is not recommended.)
6078
6079 It makes a difference where in the command you write this option; the
6080 linker searches and processes libraries and object files in the order they
6081 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
6082 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
6083 to functions in @samp{z}, those functions may not be loaded.
6084
6085 The linker searches a standard list of directories for the library,
6086 which is actually a file named @file{lib@var{library}.a}. The linker
6087 then uses this file as if it had been specified precisely by name.
6088
6089 The directories searched include several standard system directories
6090 plus any that you specify with @option{-L}.
6091
6092 Normally the files found this way are library files---archive files
6093 whose members are object files. The linker handles an archive file by
6094 scanning through it for members which define symbols that have so far
6095 been referenced but not defined. But if the file that is found is an
6096 ordinary object file, it is linked in the usual fashion. The only
6097 difference between using an @option{-l} option and specifying a file name
6098 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
6099 and searches several directories.
6100
6101 @item -lobjc
6102 @opindex lobjc
6103 You need this special case of the @option{-l} option in order to
6104 link an Objective-C or Objective-C++ program.
6105
6106 @item -nostartfiles
6107 @opindex nostartfiles
6108 Do not use the standard system startup files when linking.
6109 The standard system libraries are used normally, unless @option{-nostdlib}
6110 or @option{-nodefaultlibs} is used.
6111
6112 @item -nodefaultlibs
6113 @opindex nodefaultlibs
6114 Do not use the standard system libraries when linking.
6115 Only the libraries you specify will be passed to the linker.
6116 The standard startup files are used normally, unless @option{-nostartfiles}
6117 is used. The compiler may generate calls to @code{memcmp},
6118 @code{memset}, @code{memcpy} and @code{memmove}.
6119 These entries are usually resolved by entries in
6120 libc. These entry points should be supplied through some other
6121 mechanism when this option is specified.
6122
6123 @item -nostdlib
6124 @opindex nostdlib
6125 Do not use the standard system startup files or libraries when linking.
6126 No startup files and only the libraries you specify will be passed to
6127 the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
6128 @code{memcpy} and @code{memmove}.
6129 These entries are usually resolved by entries in
6130 libc. These entry points should be supplied through some other
6131 mechanism when this option is specified.
6132
6133 @cindex @option{-lgcc}, use with @option{-nostdlib}
6134 @cindex @option{-nostdlib} and unresolved references
6135 @cindex unresolved references and @option{-nostdlib}
6136 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
6137 @cindex @option{-nodefaultlibs} and unresolved references
6138 @cindex unresolved references and @option{-nodefaultlibs}
6139 One of the standard libraries bypassed by @option{-nostdlib} and
6140 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6141 that GCC uses to overcome shortcomings of particular machines, or special
6142 needs for some languages.
6143 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6144 Collection (GCC) Internals},
6145 for more discussion of @file{libgcc.a}.)
6146 In most cases, you need @file{libgcc.a} even when you want to avoid
6147 other standard libraries. In other words, when you specify @option{-nostdlib}
6148 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6149 This ensures that you have no unresolved references to internal GCC
6150 library subroutines. (For example, @samp{__main}, used to ensure C++
6151 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6152 GNU Compiler Collection (GCC) Internals}.)
6153
6154 @item -pie
6155 @opindex pie
6156 Produce a position independent executable on targets which support it.
6157 For predictable results, you must also specify the same set of options
6158 that were used to generate code (@option{-fpie}, @option{-fPIE},
6159 or model suboptions) when you specify this option.
6160
6161 @item -s
6162 @opindex s
6163 Remove all symbol table and relocation information from the executable.
6164
6165 @item -static
6166 @opindex static
6167 On systems that support dynamic linking, this prevents linking with the shared
6168 libraries. On other systems, this option has no effect.
6169
6170 @item -shared
6171 @opindex shared
6172 Produce a shared object which can then be linked with other objects to
6173 form an executable. Not all systems support this option. For predictable
6174 results, you must also specify the same set of options that were used to
6175 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6176 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6177 needs to build supplementary stub code for constructors to work. On
6178 multi-libbed systems, @samp{gcc -shared} must select the correct support
6179 libraries to link against. Failing to supply the correct flags may lead
6180 to subtle defects. Supplying them in cases where they are not necessary
6181 is innocuous.}
6182
6183 @item -shared-libgcc
6184 @itemx -static-libgcc
6185 @opindex shared-libgcc
6186 @opindex static-libgcc
6187 On systems that provide @file{libgcc} as a shared library, these options
6188 force the use of either the shared or static version respectively.
6189 If no shared version of @file{libgcc} was built when the compiler was
6190 configured, these options have no effect.
6191
6192 There are several situations in which an application should use the
6193 shared @file{libgcc} instead of the static version. The most common
6194 of these is when the application wishes to throw and catch exceptions
6195 across different shared libraries. In that case, each of the libraries
6196 as well as the application itself should use the shared @file{libgcc}.
6197
6198 Therefore, the G++ and GCJ drivers automatically add
6199 @option{-shared-libgcc} whenever you build a shared library or a main
6200 executable, because C++ and Java programs typically use exceptions, so
6201 this is the right thing to do.
6202
6203 If, instead, you use the GCC driver to create shared libraries, you may
6204 find that they will not always be linked with the shared @file{libgcc}.
6205 If GCC finds, at its configuration time, that you have a non-GNU linker
6206 or a GNU linker that does not support option @option{--eh-frame-hdr},
6207 it will link the shared version of @file{libgcc} into shared libraries
6208 by default. Otherwise, it will take advantage of the linker and optimize
6209 away the linking with the shared version of @file{libgcc}, linking with
6210 the static version of libgcc by default. This allows exceptions to
6211 propagate through such shared libraries, without incurring relocation
6212 costs at library load time.
6213
6214 However, if a library or main executable is supposed to throw or catch
6215 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6216 for the languages used in the program, or using the option
6217 @option{-shared-libgcc}, such that it is linked with the shared
6218 @file{libgcc}.
6219
6220 @item -symbolic
6221 @opindex symbolic
6222 Bind references to global symbols when building a shared object. Warn
6223 about any unresolved references (unless overridden by the link editor
6224 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6225 this option.
6226
6227 @item -Xlinker @var{option}
6228 @opindex Xlinker
6229 Pass @var{option} as an option to the linker. You can use this to
6230 supply system-specific linker options which GCC does not know how to
6231 recognize.
6232
6233 If you want to pass an option that takes an argument, you must use
6234 @option{-Xlinker} twice, once for the option and once for the argument.
6235 For example, to pass @option{-assert definitions}, you must write
6236 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
6237 @option{-Xlinker "-assert definitions"}, because this passes the entire
6238 string as a single argument, which is not what the linker expects.
6239
6240 @item -Wl,@var{option}
6241 @opindex Wl
6242 Pass @var{option} as an option to the linker. If @var{option} contains
6243 commas, it is split into multiple options at the commas.
6244
6245 @item -u @var{symbol}
6246 @opindex u
6247 Pretend the symbol @var{symbol} is undefined, to force linking of
6248 library modules to define it. You can use @option{-u} multiple times with
6249 different symbols to force loading of additional library modules.
6250 @end table
6251
6252 @node Directory Options
6253 @section Options for Directory Search
6254 @cindex directory options
6255 @cindex options, directory search
6256 @cindex search path
6257
6258 These options specify directories to search for header files, for
6259 libraries and for parts of the compiler:
6260
6261 @table @gcctabopt
6262 @item -I@var{dir}
6263 @opindex I
6264 Add the directory @var{dir} to the head of the list of directories to be
6265 searched for header files. This can be used to override a system header
6266 file, substituting your own version, since these directories are
6267 searched before the system header file directories. However, you should
6268 not use this option to add directories that contain vendor-supplied
6269 system header files (use @option{-isystem} for that). If you use more than
6270 one @option{-I} option, the directories are scanned in left-to-right
6271 order; the standard system directories come after.
6272
6273 If a standard system include directory, or a directory specified with
6274 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6275 option will be ignored. The directory will still be searched but as a
6276 system directory at its normal position in the system include chain.
6277 This is to ensure that GCC's procedure to fix buggy system headers and
6278 the ordering for the include_next directive are not inadvertently changed.
6279 If you really need to change the search order for system directories,
6280 use the @option{-nostdinc} and/or @option{-isystem} options.
6281
6282 @item -iquote@var{dir}
6283 @opindex iquote
6284 Add the directory @var{dir} to the head of the list of directories to
6285 be searched for header files only for the case of @samp{#include
6286 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6287 otherwise just like @option{-I}.
6288
6289 @item -L@var{dir}
6290 @opindex L
6291 Add directory @var{dir} to the list of directories to be searched
6292 for @option{-l}.
6293
6294 @item -B@var{prefix}
6295 @opindex B
6296 This option specifies where to find the executables, libraries,
6297 include files, and data files of the compiler itself.
6298
6299 The compiler driver program runs one or more of the subprograms
6300 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6301 @var{prefix} as a prefix for each program it tries to run, both with and
6302 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6303
6304 For each subprogram to be run, the compiler driver first tries the
6305 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
6306 was not specified, the driver tries two standard prefixes, which are
6307 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
6308 those results in a file name that is found, the unmodified program
6309 name is searched for using the directories specified in your
6310 @env{PATH} environment variable.
6311
6312 The compiler will check to see if the path provided by the @option{-B}
6313 refers to a directory, and if necessary it will add a directory
6314 separator character at the end of the path.
6315
6316 @option{-B} prefixes that effectively specify directory names also apply
6317 to libraries in the linker, because the compiler translates these
6318 options into @option{-L} options for the linker. They also apply to
6319 includes files in the preprocessor, because the compiler translates these
6320 options into @option{-isystem} options for the preprocessor. In this case,
6321 the compiler appends @samp{include} to the prefix.
6322
6323 The run-time support file @file{libgcc.a} can also be searched for using
6324 the @option{-B} prefix, if needed. If it is not found there, the two
6325 standard prefixes above are tried, and that is all. The file is left
6326 out of the link if it is not found by those means.
6327
6328 Another way to specify a prefix much like the @option{-B} prefix is to use
6329 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
6330 Variables}.
6331
6332 As a special kludge, if the path provided by @option{-B} is
6333 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6334 9, then it will be replaced by @file{[dir/]include}. This is to help
6335 with boot-strapping the compiler.
6336
6337 @item -specs=@var{file}
6338 @opindex specs
6339 Process @var{file} after the compiler reads in the standard @file{specs}
6340 file, in order to override the defaults that the @file{gcc} driver
6341 program uses when determining what switches to pass to @file{cc1},
6342 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
6343 @option{-specs=@var{file}} can be specified on the command line, and they
6344 are processed in order, from left to right.
6345
6346 @item -I-
6347 @opindex I-
6348 This option has been deprecated. Please use @option{-iquote} instead for
6349 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6350 Any directories you specify with @option{-I} options before the @option{-I-}
6351 option are searched only for the case of @samp{#include "@var{file}"};
6352 they are not searched for @samp{#include <@var{file}>}.
6353
6354 If additional directories are specified with @option{-I} options after
6355 the @option{-I-}, these directories are searched for all @samp{#include}
6356 directives. (Ordinarily @emph{all} @option{-I} directories are used
6357 this way.)
6358
6359 In addition, the @option{-I-} option inhibits the use of the current
6360 directory (where the current input file came from) as the first search
6361 directory for @samp{#include "@var{file}"}. There is no way to
6362 override this effect of @option{-I-}. With @option{-I.} you can specify
6363 searching the directory which was current when the compiler was
6364 invoked. That is not exactly the same as what the preprocessor does
6365 by default, but it is often satisfactory.
6366
6367 @option{-I-} does not inhibit the use of the standard system directories
6368 for header files. Thus, @option{-I-} and @option{-nostdinc} are
6369 independent.
6370 @end table
6371
6372 @c man end
6373
6374 @node Spec Files
6375 @section Specifying subprocesses and the switches to pass to them
6376 @cindex Spec Files
6377
6378 @command{gcc} is a driver program. It performs its job by invoking a
6379 sequence of other programs to do the work of compiling, assembling and
6380 linking. GCC interprets its command-line parameters and uses these to
6381 deduce which programs it should invoke, and which command-line options
6382 it ought to place on their command lines. This behavior is controlled
6383 by @dfn{spec strings}. In most cases there is one spec string for each
6384 program that GCC can invoke, but a few programs have multiple spec
6385 strings to control their behavior. The spec strings built into GCC can
6386 be overridden by using the @option{-specs=} command-line switch to specify
6387 a spec file.
6388
6389 @dfn{Spec files} are plaintext files that are used to construct spec
6390 strings. They consist of a sequence of directives separated by blank
6391 lines. The type of directive is determined by the first non-whitespace
6392 character on the line and it can be one of the following:
6393
6394 @table @code
6395 @item %@var{command}
6396 Issues a @var{command} to the spec file processor. The commands that can
6397 appear here are:
6398
6399 @table @code
6400 @item %include <@var{file}>
6401 @cindex %include
6402 Search for @var{file} and insert its text at the current point in the
6403 specs file.
6404
6405 @item %include_noerr <@var{file}>
6406 @cindex %include_noerr
6407 Just like @samp{%include}, but do not generate an error message if the include
6408 file cannot be found.
6409
6410 @item %rename @var{old_name} @var{new_name}
6411 @cindex %rename
6412 Rename the spec string @var{old_name} to @var{new_name}.
6413
6414 @end table
6415
6416 @item *[@var{spec_name}]:
6417 This tells the compiler to create, override or delete the named spec
6418 string. All lines after this directive up to the next directive or
6419 blank line are considered to be the text for the spec string. If this
6420 results in an empty string then the spec will be deleted. (Or, if the
6421 spec did not exist, then nothing will happened.) Otherwise, if the spec
6422 does not currently exist a new spec will be created. If the spec does
6423 exist then its contents will be overridden by the text of this
6424 directive, unless the first character of that text is the @samp{+}
6425 character, in which case the text will be appended to the spec.
6426
6427 @item [@var{suffix}]:
6428 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6429 and up to the next directive or blank line are considered to make up the
6430 spec string for the indicated suffix. When the compiler encounters an
6431 input file with the named suffix, it will processes the spec string in
6432 order to work out how to compile that file. For example:
6433
6434 @smallexample
6435 .ZZ:
6436 z-compile -input %i
6437 @end smallexample
6438
6439 This says that any input file whose name ends in @samp{.ZZ} should be
6440 passed to the program @samp{z-compile}, which should be invoked with the
6441 command-line switch @option{-input} and with the result of performing the
6442 @samp{%i} substitution. (See below.)
6443
6444 As an alternative to providing a spec string, the text that follows a
6445 suffix directive can be one of the following:
6446
6447 @table @code
6448 @item @@@var{language}
6449 This says that the suffix is an alias for a known @var{language}. This is
6450 similar to using the @option{-x} command-line switch to GCC to specify a
6451 language explicitly. For example:
6452
6453 @smallexample
6454 .ZZ:
6455 @@c++
6456 @end smallexample
6457
6458 Says that .ZZ files are, in fact, C++ source files.
6459
6460 @item #@var{name}
6461 This causes an error messages saying:
6462
6463 @smallexample
6464 @var{name} compiler not installed on this system.
6465 @end smallexample
6466 @end table
6467
6468 GCC already has an extensive list of suffixes built into it.
6469 This directive will add an entry to the end of the list of suffixes, but
6470 since the list is searched from the end backwards, it is effectively
6471 possible to override earlier entries using this technique.
6472
6473 @end table
6474
6475 GCC has the following spec strings built into it. Spec files can
6476 override these strings or create their own. Note that individual
6477 targets can also add their own spec strings to this list.
6478
6479 @smallexample
6480 asm Options to pass to the assembler
6481 asm_final Options to pass to the assembler post-processor
6482 cpp Options to pass to the C preprocessor
6483 cc1 Options to pass to the C compiler
6484 cc1plus Options to pass to the C++ compiler
6485 endfile Object files to include at the end of the link
6486 link Options to pass to the linker
6487 lib Libraries to include on the command line to the linker
6488 libgcc Decides which GCC support library to pass to the linker
6489 linker Sets the name of the linker
6490 predefines Defines to be passed to the C preprocessor
6491 signed_char Defines to pass to CPP to say whether @code{char} is signed
6492 by default
6493 startfile Object files to include at the start of the link
6494 @end smallexample
6495
6496 Here is a small example of a spec file:
6497
6498 @smallexample
6499 %rename lib old_lib
6500
6501 *lib:
6502 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6503 @end smallexample
6504
6505 This example renames the spec called @samp{lib} to @samp{old_lib} and
6506 then overrides the previous definition of @samp{lib} with a new one.
6507 The new definition adds in some extra command-line options before
6508 including the text of the old definition.
6509
6510 @dfn{Spec strings} are a list of command-line options to be passed to their
6511 corresponding program. In addition, the spec strings can contain
6512 @samp{%}-prefixed sequences to substitute variable text or to
6513 conditionally insert text into the command line. Using these constructs
6514 it is possible to generate quite complex command lines.
6515
6516 Here is a table of all defined @samp{%}-sequences for spec
6517 strings. Note that spaces are not generated automatically around the
6518 results of expanding these sequences. Therefore you can concatenate them
6519 together or combine them with constant text in a single argument.
6520
6521 @table @code
6522 @item %%
6523 Substitute one @samp{%} into the program name or argument.
6524
6525 @item %i
6526 Substitute the name of the input file being processed.
6527
6528 @item %b
6529 Substitute the basename of the input file being processed.
6530 This is the substring up to (and not including) the last period
6531 and not including the directory.
6532
6533 @item %B
6534 This is the same as @samp{%b}, but include the file suffix (text after
6535 the last period).
6536
6537 @item %d
6538 Marks the argument containing or following the @samp{%d} as a
6539 temporary file name, so that that file will be deleted if GCC exits
6540 successfully. Unlike @samp{%g}, this contributes no text to the
6541 argument.
6542
6543 @item %g@var{suffix}
6544 Substitute a file name that has suffix @var{suffix} and is chosen
6545 once per compilation, and mark the argument in the same way as
6546 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
6547 name is now chosen in a way that is hard to predict even when previously
6548 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6549 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6550 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6551 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6552 was simply substituted with a file name chosen once per compilation,
6553 without regard to any appended suffix (which was therefore treated
6554 just like ordinary text), making such attacks more likely to succeed.
6555
6556 @item %u@var{suffix}
6557 Like @samp{%g}, but generates a new temporary file name even if
6558 @samp{%u@var{suffix}} was already seen.
6559
6560 @item %U@var{suffix}
6561 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6562 new one if there is no such last file name. In the absence of any
6563 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6564 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6565 would involve the generation of two distinct file names, one
6566 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6567 simply substituted with a file name chosen for the previous @samp{%u},
6568 without regard to any appended suffix.
6569
6570 @item %j@var{suffix}
6571 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6572 writable, and if save-temps is off; otherwise, substitute the name
6573 of a temporary file, just like @samp{%u}. This temporary file is not
6574 meant for communication between processes, but rather as a junk
6575 disposal mechanism.
6576
6577 @item %|@var{suffix}
6578 @itemx %m@var{suffix}
6579 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6580 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6581 all. These are the two most common ways to instruct a program that it
6582 should read from standard input or write to standard output. If you
6583 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6584 construct: see for example @file{f/lang-specs.h}.
6585
6586 @item %.@var{SUFFIX}
6587 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6588 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
6589 terminated by the next space or %.
6590
6591 @item %w
6592 Marks the argument containing or following the @samp{%w} as the
6593 designated output file of this compilation. This puts the argument
6594 into the sequence of arguments that @samp{%o} will substitute later.
6595
6596 @item %o
6597 Substitutes the names of all the output files, with spaces
6598 automatically placed around them. You should write spaces
6599 around the @samp{%o} as well or the results are undefined.
6600 @samp{%o} is for use in the specs for running the linker.
6601 Input files whose names have no recognized suffix are not compiled
6602 at all, but they are included among the output files, so they will
6603 be linked.
6604
6605 @item %O
6606 Substitutes the suffix for object files. Note that this is
6607 handled specially when it immediately follows @samp{%g, %u, or %U},
6608 because of the need for those to form complete file names. The
6609 handling is such that @samp{%O} is treated exactly as if it had already
6610 been substituted, except that @samp{%g, %u, and %U} do not currently
6611 support additional @var{suffix} characters following @samp{%O} as they would
6612 following, for example, @samp{.o}.
6613
6614 @item %p
6615 Substitutes the standard macro predefinitions for the
6616 current target machine. Use this when running @code{cpp}.
6617
6618 @item %P
6619 Like @samp{%p}, but puts @samp{__} before and after the name of each
6620 predefined macro, except for macros that start with @samp{__} or with
6621 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
6622 C@.
6623
6624 @item %I
6625 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6626 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6627 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6628 as necessary.
6629
6630 @item %s
6631 Current argument is the name of a library or startup file of some sort.
6632 Search for that file in a standard list of directories and substitute
6633 the full name found.
6634
6635 @item %e@var{str}
6636 Print @var{str} as an error message. @var{str} is terminated by a newline.
6637 Use this when inconsistent options are detected.
6638
6639 @item %(@var{name})
6640 Substitute the contents of spec string @var{name} at this point.
6641
6642 @item %[@var{name}]
6643 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6644
6645 @item %x@{@var{option}@}
6646 Accumulate an option for @samp{%X}.
6647
6648 @item %X
6649 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6650 spec string.
6651
6652 @item %Y
6653 Output the accumulated assembler options specified by @option{-Wa}.
6654
6655 @item %Z
6656 Output the accumulated preprocessor options specified by @option{-Wp}.
6657
6658 @item %a
6659 Process the @code{asm} spec. This is used to compute the
6660 switches to be passed to the assembler.
6661
6662 @item %A
6663 Process the @code{asm_final} spec. This is a spec string for
6664 passing switches to an assembler post-processor, if such a program is
6665 needed.
6666
6667 @item %l
6668 Process the @code{link} spec. This is the spec for computing the
6669 command line passed to the linker. Typically it will make use of the
6670 @samp{%L %G %S %D and %E} sequences.
6671
6672 @item %D
6673 Dump out a @option{-L} option for each directory that GCC believes might
6674 contain startup files. If the target supports multilibs then the
6675 current multilib directory will be prepended to each of these paths.
6676
6677 @item %L
6678 Process the @code{lib} spec. This is a spec string for deciding which
6679 libraries should be included on the command line to the linker.
6680
6681 @item %G
6682 Process the @code{libgcc} spec. This is a spec string for deciding
6683 which GCC support library should be included on the command line to the linker.
6684
6685 @item %S
6686 Process the @code{startfile} spec. This is a spec for deciding which
6687 object files should be the first ones passed to the linker. Typically
6688 this might be a file named @file{crt0.o}.
6689
6690 @item %E
6691 Process the @code{endfile} spec. This is a spec string that specifies
6692 the last object files that will be passed to the linker.
6693
6694 @item %C
6695 Process the @code{cpp} spec. This is used to construct the arguments
6696 to be passed to the C preprocessor.
6697
6698 @item %1
6699 Process the @code{cc1} spec. This is used to construct the options to be
6700 passed to the actual C compiler (@samp{cc1}).
6701
6702 @item %2
6703 Process the @code{cc1plus} spec. This is used to construct the options to be
6704 passed to the actual C++ compiler (@samp{cc1plus}).
6705
6706 @item %*
6707 Substitute the variable part of a matched option. See below.
6708 Note that each comma in the substituted string is replaced by
6709 a single space.
6710
6711 @item %<@code{S}
6712 Remove all occurrences of @code{-S} from the command line. Note---this
6713 command is position dependent. @samp{%} commands in the spec string
6714 before this one will see @code{-S}, @samp{%} commands in the spec string
6715 after this one will not.
6716
6717 @item %:@var{function}(@var{args})
6718 Call the named function @var{function}, passing it @var{args}.
6719 @var{args} is first processed as a nested spec string, then split
6720 into an argument vector in the usual fashion. The function returns
6721 a string which is processed as if it had appeared literally as part
6722 of the current spec.
6723
6724 The following built-in spec functions are provided:
6725
6726 @table @code
6727 @item @code{if-exists}
6728 The @code{if-exists} spec function takes one argument, an absolute
6729 pathname to a file. If the file exists, @code{if-exists} returns the
6730 pathname. Here is a small example of its usage:
6731
6732 @smallexample
6733 *startfile:
6734 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6735 @end smallexample
6736
6737 @item @code{if-exists-else}
6738 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6739 spec function, except that it takes two arguments. The first argument is
6740 an absolute pathname to a file. If the file exists, @code{if-exists-else}
6741 returns the pathname. If it does not exist, it returns the second argument.
6742 This way, @code{if-exists-else} can be used to select one file or another,
6743 based on the existence of the first. Here is a small example of its usage:
6744
6745 @smallexample
6746 *startfile:
6747 crt0%O%s %:if-exists(crti%O%s) \
6748 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6749 @end smallexample
6750
6751 @item @code{replace-outfile}
6752 The @code{replace-outfile} spec function takes two arguments. It looks for the
6753 first argument in the outfiles array and replaces it with the second argument. Here
6754 is a small example of its usage:
6755
6756 @smallexample
6757 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6758 @end smallexample
6759
6760 @end table
6761
6762 @item %@{@code{S}@}
6763 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6764 If that switch was not specified, this substitutes nothing. Note that
6765 the leading dash is omitted when specifying this option, and it is
6766 automatically inserted if the substitution is performed. Thus the spec
6767 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6768 and would output the command line option @option{-foo}.
6769
6770 @item %W@{@code{S}@}
6771 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6772 deleted on failure.
6773
6774 @item %@{@code{S}*@}
6775 Substitutes all the switches specified to GCC whose names start
6776 with @code{-S}, but which also take an argument. This is used for
6777 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6778 GCC considers @option{-o foo} as being
6779 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
6780 text, including the space. Thus two arguments would be generated.
6781
6782 @item %@{@code{S}*&@code{T}*@}
6783 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6784 (the order of @code{S} and @code{T} in the spec is not significant).
6785 There can be any number of ampersand-separated variables; for each the
6786 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
6787
6788 @item %@{@code{S}:@code{X}@}
6789 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6790
6791 @item %@{!@code{S}:@code{X}@}
6792 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6793
6794 @item %@{@code{S}*:@code{X}@}
6795 Substitutes @code{X} if one or more switches whose names start with
6796 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
6797 once, no matter how many such switches appeared. However, if @code{%*}
6798 appears somewhere in @code{X}, then @code{X} will be substituted once
6799 for each matching switch, with the @code{%*} replaced by the part of
6800 that switch that matched the @code{*}.
6801
6802 @item %@{.@code{S}:@code{X}@}
6803 Substitutes @code{X}, if processing a file with suffix @code{S}.
6804
6805 @item %@{!.@code{S}:@code{X}@}
6806 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6807
6808 @item %@{@code{S}|@code{P}:@code{X}@}
6809 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6810 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6811 although they have a stronger binding than the @samp{|}. If @code{%*}
6812 appears in @code{X}, all of the alternatives must be starred, and only
6813 the first matching alternative is substituted.
6814
6815 For example, a spec string like this:
6816
6817 @smallexample
6818 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6819 @end smallexample
6820
6821 will output the following command-line options from the following input
6822 command-line options:
6823
6824 @smallexample
6825 fred.c -foo -baz
6826 jim.d -bar -boggle
6827 -d fred.c -foo -baz -boggle
6828 -d jim.d -bar -baz -boggle
6829 @end smallexample
6830
6831 @item %@{S:X; T:Y; :D@}
6832
6833 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6834 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
6835 be as many clauses as you need. This may be combined with @code{.},
6836 @code{!}, @code{|}, and @code{*} as needed.
6837
6838
6839 @end table
6840
6841 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6842 construct may contain other nested @samp{%} constructs or spaces, or
6843 even newlines. They are processed as usual, as described above.
6844 Trailing white space in @code{X} is ignored. White space may also
6845 appear anywhere on the left side of the colon in these constructs,
6846 except between @code{.} or @code{*} and the corresponding word.
6847
6848 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6849 handled specifically in these constructs. If another value of
6850 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6851 @option{-W} switch is found later in the command line, the earlier
6852 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6853 just one letter, which passes all matching options.
6854
6855 The character @samp{|} at the beginning of the predicate text is used to
6856 indicate that a command should be piped to the following command, but
6857 only if @option{-pipe} is specified.
6858
6859 It is built into GCC which switches take arguments and which do not.
6860 (You might think it would be useful to generalize this to allow each
6861 compiler's spec to say which switches take arguments. But this cannot
6862 be done in a consistent fashion. GCC cannot even decide which input
6863 files have been specified without knowing which switches take arguments,
6864 and it must know which input files to compile in order to tell which
6865 compilers to run).
6866
6867 GCC also knows implicitly that arguments starting in @option{-l} are to be
6868 treated as compiler output files, and passed to the linker in their
6869 proper position among the other output files.
6870
6871 @c man begin OPTIONS
6872
6873 @node Target Options
6874 @section Specifying Target Machine and Compiler Version
6875 @cindex target options
6876 @cindex cross compiling
6877 @cindex specifying machine version
6878 @cindex specifying compiler version and target machine
6879 @cindex compiler version, specifying
6880 @cindex target machine, specifying
6881
6882 The usual way to run GCC is to run the executable called @file{gcc}, or
6883 @file{<machine>-gcc} when cross-compiling, or
6884 @file{<machine>-gcc-<version>} to run a version other than the one that
6885 was installed last. Sometimes this is inconvenient, so GCC provides
6886 options that will switch to another cross-compiler or version.
6887
6888 @table @gcctabopt
6889 @item -b @var{machine}
6890 @opindex b
6891 The argument @var{machine} specifies the target machine for compilation.
6892
6893 The value to use for @var{machine} is the same as was specified as the
6894 machine type when configuring GCC as a cross-compiler. For
6895 example, if a cross-compiler was configured with @samp{configure
6896 i386v}, meaning to compile for an 80386 running System V, then you
6897 would specify @option{-b i386v} to run that cross compiler.
6898
6899 @item -V @var{version}
6900 @opindex V
6901 The argument @var{version} specifies which version of GCC to run.
6902 This is useful when multiple versions are installed. For example,
6903 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6904 @end table
6905
6906 The @option{-V} and @option{-b} options work by running the
6907 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6908 use them if you can just run that directly.
6909
6910 @node Submodel Options
6911 @section Hardware Models and Configurations
6912 @cindex submodel options
6913 @cindex specifying hardware config
6914 @cindex hardware models and configurations, specifying
6915 @cindex machine dependent options
6916
6917 Earlier we discussed the standard option @option{-b} which chooses among
6918 different installed compilers for completely different target
6919 machines, such as VAX vs.@: 68000 vs.@: 80386.
6920
6921 In addition, each of these target machine types can have its own
6922 special options, starting with @samp{-m}, to choose among various
6923 hardware models or configurations---for example, 68010 vs 68020,
6924 floating coprocessor or none. A single installed version of the
6925 compiler can compile for any model or configuration, according to the
6926 options specified.
6927
6928 Some configurations of the compiler also support additional special
6929 options, usually for compatibility with other compilers on the same
6930 platform.
6931
6932 @c This list is ordered alphanumerically by subsection name.
6933 @c It should be the same order and spelling as these options are listed
6934 @c in Machine Dependent Options
6935
6936 @menu
6937 * ARC Options::
6938 * ARM Options::
6939 * AVR Options::
6940 * Blackfin Options::
6941 * CRIS Options::
6942 * Darwin Options::
6943 * DEC Alpha Options::
6944 * DEC Alpha/VMS Options::
6945 * FRV Options::
6946 * H8/300 Options::
6947 * HPPA Options::
6948 * i386 and x86-64 Options::
6949 * IA-64 Options::
6950 * M32R/D Options::
6951 * M680x0 Options::
6952 * M68hc1x Options::
6953 * MCore Options::
6954 * MIPS Options::
6955 * MMIX Options::
6956 * MN10300 Options::
6957 * NS32K Options::
6958 * PDP-11 Options::
6959 * PowerPC Options::
6960 * RS/6000 and PowerPC Options::
6961 * S/390 and zSeries Options::
6962 * SH Options::
6963 * SPARC Options::
6964 * System V Options::
6965 * TMS320C3x/C4x Options::
6966 * V850 Options::
6967 * VAX Options::
6968 * x86-64 Options::
6969 * Xstormy16 Options::
6970 * Xtensa Options::
6971 * zSeries Options::
6972 @end menu
6973
6974 @node ARC Options
6975 @subsection ARC Options
6976 @cindex ARC Options
6977
6978 These options are defined for ARC implementations:
6979
6980 @table @gcctabopt
6981 @item -EL
6982 @opindex EL
6983 Compile code for little endian mode. This is the default.
6984
6985 @item -EB
6986 @opindex EB
6987 Compile code for big endian mode.
6988
6989 @item -mmangle-cpu
6990 @opindex mmangle-cpu
6991 Prepend the name of the cpu to all public symbol names.
6992 In multiple-processor systems, there are many ARC variants with different
6993 instruction and register set characteristics. This flag prevents code
6994 compiled for one cpu to be linked with code compiled for another.
6995 No facility exists for handling variants that are ``almost identical''.
6996 This is an all or nothing option.
6997
6998 @item -mcpu=@var{cpu}
6999 @opindex mcpu
7000 Compile code for ARC variant @var{cpu}.
7001 Which variants are supported depend on the configuration.
7002 All variants support @option{-mcpu=base}, this is the default.
7003
7004 @item -mtext=@var{text-section}
7005 @itemx -mdata=@var{data-section}
7006 @itemx -mrodata=@var{readonly-data-section}
7007 @opindex mtext
7008 @opindex mdata
7009 @opindex mrodata
7010 Put functions, data, and readonly data in @var{text-section},
7011 @var{data-section}, and @var{readonly-data-section} respectively
7012 by default. This can be overridden with the @code{section} attribute.
7013 @xref{Variable Attributes}.
7014
7015 @end table
7016
7017 @node ARM Options
7018 @subsection ARM Options
7019 @cindex ARM options
7020
7021 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
7022 architectures:
7023
7024 @table @gcctabopt
7025 @item -mabi=@var{name}
7026 @opindex mabi
7027 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
7028 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
7029
7030 @item -mapcs-frame
7031 @opindex mapcs-frame
7032 Generate a stack frame that is compliant with the ARM Procedure Call
7033 Standard for all functions, even if this is not strictly necessary for
7034 correct execution of the code. Specifying @option{-fomit-frame-pointer}
7035 with this option will cause the stack frames not to be generated for
7036 leaf functions. The default is @option{-mno-apcs-frame}.
7037
7038 @item -mapcs
7039 @opindex mapcs
7040 This is a synonym for @option{-mapcs-frame}.
7041
7042 @ignore
7043 @c not currently implemented
7044 @item -mapcs-stack-check
7045 @opindex mapcs-stack-check
7046 Generate code to check the amount of stack space available upon entry to
7047 every function (that actually uses some stack space). If there is
7048 insufficient space available then either the function
7049 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
7050 called, depending upon the amount of stack space required. The run time
7051 system is required to provide these functions. The default is
7052 @option{-mno-apcs-stack-check}, since this produces smaller code.
7053
7054 @c not currently implemented
7055 @item -mapcs-float
7056 @opindex mapcs-float
7057 Pass floating point arguments using the float point registers. This is
7058 one of the variants of the APCS@. This option is recommended if the
7059 target hardware has a floating point unit or if a lot of floating point
7060 arithmetic is going to be performed by the code. The default is
7061 @option{-mno-apcs-float}, since integer only code is slightly increased in
7062 size if @option{-mapcs-float} is used.
7063
7064 @c not currently implemented
7065 @item -mapcs-reentrant
7066 @opindex mapcs-reentrant
7067 Generate reentrant, position independent code. The default is
7068 @option{-mno-apcs-reentrant}.
7069 @end ignore
7070
7071 @item -mthumb-interwork
7072 @opindex mthumb-interwork
7073 Generate code which supports calling between the ARM and Thumb
7074 instruction sets. Without this option the two instruction sets cannot
7075 be reliably used inside one program. The default is
7076 @option{-mno-thumb-interwork}, since slightly larger code is generated
7077 when @option{-mthumb-interwork} is specified.
7078
7079 @item -mno-sched-prolog
7080 @opindex mno-sched-prolog
7081 Prevent the reordering of instructions in the function prolog, or the
7082 merging of those instruction with the instructions in the function's
7083 body. This means that all functions will start with a recognizable set
7084 of instructions (or in fact one of a choice from a small set of
7085 different function prologues), and this information can be used to
7086 locate the start if functions inside an executable piece of code. The
7087 default is @option{-msched-prolog}.
7088
7089 @item -mhard-float
7090 @opindex mhard-float
7091 Generate output containing floating point instructions. This is the
7092 default.
7093
7094 @item -msoft-float
7095 @opindex msoft-float
7096 Generate output containing library calls for floating point.
7097 @strong{Warning:} the requisite libraries are not available for all ARM
7098 targets. Normally the facilities of the machine's usual C compiler are
7099 used, but this cannot be done directly in cross-compilation. You must make
7100 your own arrangements to provide suitable library functions for
7101 cross-compilation.
7102
7103 @option{-msoft-float} changes the calling convention in the output file;
7104 therefore, it is only useful if you compile @emph{all} of a program with
7105 this option. In particular, you need to compile @file{libgcc.a}, the
7106 library that comes with GCC, with @option{-msoft-float} in order for
7107 this to work.
7108
7109 @item -mfloat-abi=@var{name}
7110 @opindex mfloat-abi
7111 Specifies which ABI to use for floating point values. Permissible values
7112 are: @samp{soft}, @samp{softfp} and @samp{hard}.
7113
7114 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
7115 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
7116 of floating point instructions, but still uses the soft-float calling
7117 conventions.
7118
7119 @item -mlittle-endian
7120 @opindex mlittle-endian
7121 Generate code for a processor running in little-endian mode. This is
7122 the default for all standard configurations.
7123
7124 @item -mbig-endian
7125 @opindex mbig-endian
7126 Generate code for a processor running in big-endian mode; the default is
7127 to compile code for a little-endian processor.
7128
7129 @item -mwords-little-endian
7130 @opindex mwords-little-endian
7131 This option only applies when generating code for big-endian processors.
7132 Generate code for a little-endian word order but a big-endian byte
7133 order. That is, a byte order of the form @samp{32107654}. Note: this
7134 option should only be used if you require compatibility with code for
7135 big-endian ARM processors generated by versions of the compiler prior to
7136 2.8.
7137
7138 @item -mcpu=@var{name}
7139 @opindex mcpu
7140 This specifies the name of the target ARM processor. GCC uses this name
7141 to determine what kind of instructions it can emit when generating
7142 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7143 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7144 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7145 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7146 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7147 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7148 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7149 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7150 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7151 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7152 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7153 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7154 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7155 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7156 @samp{ep9312}.
7157
7158 @itemx -mtune=@var{name}
7159 @opindex mtune
7160 This option is very similar to the @option{-mcpu=} option, except that
7161 instead of specifying the actual target processor type, and hence
7162 restricting which instructions can be used, it specifies that GCC should
7163 tune the performance of the code as if the target were of the type
7164 specified in this option, but still choosing the instructions that it
7165 will generate based on the cpu specified by a @option{-mcpu=} option.
7166 For some ARM implementations better performance can be obtained by using
7167 this option.
7168
7169 @item -march=@var{name}
7170 @opindex march
7171 This specifies the name of the target ARM architecture. GCC uses this
7172 name to determine what kind of instructions it can emit when generating
7173 assembly code. This option can be used in conjunction with or instead
7174 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7175 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7176 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7177 @samp{iwmmxt}, @samp{ep9312}.
7178
7179 @item -mfpu=@var{name}
7180 @itemx -mfpe=@var{number}
7181 @itemx -mfp=@var{number}
7182 @opindex mfpu
7183 @opindex mfpe
7184 @opindex mfp
7185 This specifies what floating point hardware (or hardware emulation) is
7186 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7187 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7188 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7189 with older versions of GCC@.
7190
7191 If @option{-msoft-float} is specified this specifies the format of
7192 floating point values.
7193
7194 @item -mstructure-size-boundary=@var{n}
7195 @opindex mstructure-size-boundary
7196 The size of all structures and unions will be rounded up to a multiple
7197 of the number of bits set by this option. Permissible values are 8, 32
7198 and 64. The default value varies for different toolchains. For the COFF
7199 targeted toolchain the default value is 8. A value of 64 is only allowed
7200 if the underlying ABI supports it.
7201
7202 Specifying the larger number can produce faster, more efficient code, but
7203 can also increase the size of the program. Different values are potentially
7204 incompatible. Code compiled with one value cannot necessarily expect to
7205 work with code or libraries compiled with another value, if they exchange
7206 information using structures or unions.
7207
7208 @item -mabort-on-noreturn
7209 @opindex mabort-on-noreturn
7210 Generate a call to the function @code{abort} at the end of a
7211 @code{noreturn} function. It will be executed if the function tries to
7212 return.
7213
7214 @item -mlong-calls
7215 @itemx -mno-long-calls
7216 @opindex mlong-calls
7217 @opindex mno-long-calls
7218 Tells the compiler to perform function calls by first loading the
7219 address of the function into a register and then performing a subroutine
7220 call on this register. This switch is needed if the target function
7221 will lie outside of the 64 megabyte addressing range of the offset based
7222 version of subroutine call instruction.
7223
7224 Even if this switch is enabled, not all function calls will be turned
7225 into long calls. The heuristic is that static functions, functions
7226 which have the @samp{short-call} attribute, functions that are inside
7227 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7228 definitions have already been compiled within the current compilation
7229 unit, will not be turned into long calls. The exception to this rule is
7230 that weak function definitions, functions with the @samp{long-call}
7231 attribute or the @samp{section} attribute, and functions that are within
7232 the scope of a @samp{#pragma long_calls} directive, will always be
7233 turned into long calls.
7234
7235 This feature is not enabled by default. Specifying
7236 @option{-mno-long-calls} will restore the default behavior, as will
7237 placing the function calls within the scope of a @samp{#pragma
7238 long_calls_off} directive. Note these switches have no effect on how
7239 the compiler generates code to handle function calls via function
7240 pointers.
7241
7242 @item -mnop-fun-dllimport
7243 @opindex mnop-fun-dllimport
7244 Disable support for the @code{dllimport} attribute.
7245
7246 @item -msingle-pic-base
7247 @opindex msingle-pic-base
7248 Treat the register used for PIC addressing as read-only, rather than
7249 loading it in the prologue for each function. The run-time system is
7250 responsible for initializing this register with an appropriate value
7251 before execution begins.
7252
7253 @item -mpic-register=@var{reg}
7254 @opindex mpic-register
7255 Specify the register to be used for PIC addressing. The default is R10
7256 unless stack-checking is enabled, when R9 is used.
7257
7258 @item -mcirrus-fix-invalid-insns
7259 @opindex mcirrus-fix-invalid-insns
7260 @opindex mno-cirrus-fix-invalid-insns
7261 Insert NOPs into the instruction stream to in order to work around
7262 problems with invalid Maverick instruction combinations. This option
7263 is only valid if the @option{-mcpu=ep9312} option has been used to
7264 enable generation of instructions for the Cirrus Maverick floating
7265 point co-processor. This option is not enabled by default, since the
7266 problem is only present in older Maverick implementations. The default
7267 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7268 switch.
7269
7270 @item -mpoke-function-name
7271 @opindex mpoke-function-name
7272 Write the name of each function into the text section, directly
7273 preceding the function prologue. The generated code is similar to this:
7274
7275 @smallexample
7276 t0
7277 .ascii "arm_poke_function_name", 0
7278 .align
7279 t1
7280 .word 0xff000000 + (t1 - t0)
7281 arm_poke_function_name
7282 mov ip, sp
7283 stmfd sp!, @{fp, ip, lr, pc@}
7284 sub fp, ip, #4
7285 @end smallexample
7286
7287 When performing a stack backtrace, code can inspect the value of
7288 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
7289 location @code{pc - 12} and the top 8 bits are set, then we know that
7290 there is a function name embedded immediately preceding this location
7291 and has length @code{((pc[-3]) & 0xff000000)}.
7292
7293 @item -mthumb
7294 @opindex mthumb
7295 Generate code for the 16-bit Thumb instruction set. The default is to
7296 use the 32-bit ARM instruction set.
7297
7298 @item -mtpcs-frame
7299 @opindex mtpcs-frame
7300 Generate a stack frame that is compliant with the Thumb Procedure Call
7301 Standard for all non-leaf functions. (A leaf function is one that does
7302 not call any other functions.) The default is @option{-mno-tpcs-frame}.
7303
7304 @item -mtpcs-leaf-frame
7305 @opindex mtpcs-leaf-frame
7306 Generate a stack frame that is compliant with the Thumb Procedure Call
7307 Standard for all leaf functions. (A leaf function is one that does
7308 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
7309
7310 @item -mcallee-super-interworking
7311 @opindex mcallee-super-interworking
7312 Gives all externally visible functions in the file being compiled an ARM
7313 instruction set header which switches to Thumb mode before executing the
7314 rest of the function. This allows these functions to be called from
7315 non-interworking code.
7316
7317 @item -mcaller-super-interworking
7318 @opindex mcaller-super-interworking
7319 Allows calls via function pointers (including virtual functions) to
7320 execute correctly regardless of whether the target code has been
7321 compiled for interworking or not. There is a small overhead in the cost
7322 of executing a function pointer if this option is enabled.
7323
7324 @end table
7325
7326 @node AVR Options
7327 @subsection AVR Options
7328 @cindex AVR Options
7329
7330 These options are defined for AVR implementations:
7331
7332 @table @gcctabopt
7333 @item -mmcu=@var{mcu}
7334 @opindex mmcu
7335 Specify ATMEL AVR instruction set or MCU type.
7336
7337 Instruction set avr1 is for the minimal AVR core, not supported by the C
7338 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7339 attiny11, attiny12, attiny15, attiny28).
7340
7341 Instruction set avr2 (default) is for the classic AVR core with up to
7342 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7343 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7344 at90c8534, at90s8535).
7345
7346 Instruction set avr3 is for the classic AVR core with up to 128K program
7347 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7348
7349 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7350 memory space (MCU types: atmega8, atmega83, atmega85).
7351
7352 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7353 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7354 atmega64, atmega128, at43usb355, at94k).
7355
7356 @item -msize
7357 @opindex msize
7358 Output instruction sizes to the asm file.
7359
7360 @item -minit-stack=@var{N}
7361 @opindex minit-stack
7362 Specify the initial stack address, which may be a symbol or numeric value,
7363 @samp{__stack} is the default.
7364
7365 @item -mno-interrupts
7366 @opindex mno-interrupts
7367 Generated code is not compatible with hardware interrupts.
7368 Code size will be smaller.
7369
7370 @item -mcall-prologues
7371 @opindex mcall-prologues
7372 Functions prologues/epilogues expanded as call to appropriate
7373 subroutines. Code size will be smaller.
7374
7375 @item -mno-tablejump
7376 @opindex mno-tablejump
7377 Do not generate tablejump insns which sometimes increase code size.
7378
7379 @item -mtiny-stack
7380 @opindex mtiny-stack
7381 Change only the low 8 bits of the stack pointer.
7382
7383 @item -mint8
7384 @opindex mint8
7385 Assume int to be 8 bit integer. This affects the sizes of all types: A
7386 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7387 and long long will be 4 bytes. Please note that this option does not
7388 comply to the C standards, but it will provide you with smaller code
7389 size.
7390 @end table
7391
7392 @node Blackfin Options
7393 @subsection Blackfin Options
7394 @cindex Blackfin Options
7395
7396 @table @gcctabopt
7397 @item -momit-leaf-frame-pointer
7398 @opindex momit-leaf-frame-pointer
7399 Don't keep the frame pointer in a register for leaf functions. This
7400 avoids the instructions to save, set up and restore frame pointers and
7401 makes an extra register available in leaf functions. The option
7402 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7403 which might make debugging harder.
7404
7405 @item -mcsync
7406 @opindex mcsync
7407 When enabled, the compiler will ensure that the generated code does not
7408 contain speculative loads after jump instructions. This option is enabled
7409 by default.
7410
7411 @item -mno-csync
7412 @opindex mno-csync
7413 Don't generate extra code to prevent speculative loads from occurring.
7414
7415 @item -mlow-64k
7416 @opindex mlow-64k
7417 When enabled, the compiler is free to take advantage of the knowledge that
7418 the entire program fits into the low 64k of memory.
7419
7420 @item -mno-low-64k
7421 @opindex mno-low-64k
7422 Assume that the program is arbitrarily large. This is the default.
7423
7424 @item -mid-shared-library
7425 @opindex mid-shared-library
7426 Generate code that supports shared libraries via the library ID method.
7427 This allows for execute in place and shared libraries in an environment
7428 without virtual memory management. This option implies @option{-fPIC}.
7429
7430 @item -mno-id-shared-library
7431 @opindex mno-id-shared-library
7432 Generate code that doesn't assume ID based shared libraries are being used.
7433 This is the default.
7434
7435 @item -mshared-library-id=n
7436 @opindex mshared-library-id
7437 Specified the identification number of the ID based shared library being
7438 compiled. Specifying a value of 0 will generate more compact code, specifying
7439 other values will force the allocation of that number to the current
7440 library but is no more space or time efficient than omitting this option.
7441
7442 @item -mlong-calls
7443 @itemx -mno-long-calls
7444 @opindex mlong-calls
7445 @opindex mno-long-calls
7446 Tells the compiler to perform function calls by first loading the
7447 address of the function into a register and then performing a subroutine
7448 call on this register. This switch is needed if the target function
7449 will lie outside of the 24 bit addressing range of the offset based
7450 version of subroutine call instruction.
7451
7452 This feature is not enabled by default. Specifying
7453 @option{-mno-long-calls} will restore the default behavior. Note these
7454 switches have no effect on how the compiler generates code to handle
7455 function calls via function pointers.
7456 @end table
7457
7458 @node CRIS Options
7459 @subsection CRIS Options
7460 @cindex CRIS Options
7461
7462 These options are defined specifically for the CRIS ports.
7463
7464 @table @gcctabopt
7465 @item -march=@var{architecture-type}
7466 @itemx -mcpu=@var{architecture-type}
7467 @opindex march
7468 @opindex mcpu
7469 Generate code for the specified architecture. The choices for
7470 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7471 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7472 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7473 @samp{v10}.
7474
7475 @item -mtune=@var{architecture-type}
7476 @opindex mtune
7477 Tune to @var{architecture-type} everything applicable about the generated
7478 code, except for the ABI and the set of available instructions. The
7479 choices for @var{architecture-type} are the same as for
7480 @option{-march=@var{architecture-type}}.
7481
7482 @item -mmax-stack-frame=@var{n}
7483 @opindex mmax-stack-frame
7484 Warn when the stack frame of a function exceeds @var{n} bytes.
7485
7486 @item -melinux-stacksize=@var{n}
7487 @opindex melinux-stacksize
7488 Only available with the @samp{cris-axis-aout} target. Arranges for
7489 indications in the program to the kernel loader that the stack of the
7490 program should be set to @var{n} bytes.
7491
7492 @item -metrax4
7493 @itemx -metrax100
7494 @opindex metrax4
7495 @opindex metrax100
7496 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7497 @option{-march=v3} and @option{-march=v8} respectively.
7498
7499 @item -mmul-bug-workaround
7500 @itemx -mno-mul-bug-workaround
7501 @opindex mmul-bug-workaround
7502 @opindex mno-mul-bug-workaround
7503 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7504 models where it applies. This option is active by default.
7505
7506 @item -mpdebug
7507 @opindex mpdebug
7508 Enable CRIS-specific verbose debug-related information in the assembly
7509 code. This option also has the effect to turn off the @samp{#NO_APP}
7510 formatted-code indicator to the assembler at the beginning of the
7511 assembly file.
7512
7513 @item -mcc-init
7514 @opindex mcc-init
7515 Do not use condition-code results from previous instruction; always emit
7516 compare and test instructions before use of condition codes.
7517
7518 @item -mno-side-effects
7519 @opindex mno-side-effects
7520 Do not emit instructions with side-effects in addressing modes other than
7521 post-increment.
7522
7523 @item -mstack-align
7524 @itemx -mno-stack-align
7525 @itemx -mdata-align
7526 @itemx -mno-data-align
7527 @itemx -mconst-align
7528 @itemx -mno-const-align
7529 @opindex mstack-align
7530 @opindex mno-stack-align
7531 @opindex mdata-align
7532 @opindex mno-data-align
7533 @opindex mconst-align
7534 @opindex mno-const-align
7535 These options (no-options) arranges (eliminate arrangements) for the
7536 stack-frame, individual data and constants to be aligned for the maximum
7537 single data access size for the chosen CPU model. The default is to
7538 arrange for 32-bit alignment. ABI details such as structure layout are
7539 not affected by these options.
7540
7541 @item -m32-bit
7542 @itemx -m16-bit
7543 @itemx -m8-bit
7544 @opindex m32-bit
7545 @opindex m16-bit
7546 @opindex m8-bit
7547 Similar to the stack- data- and const-align options above, these options
7548 arrange for stack-frame, writable data and constants to all be 32-bit,
7549 16-bit or 8-bit aligned. The default is 32-bit alignment.
7550
7551 @item -mno-prologue-epilogue
7552 @itemx -mprologue-epilogue
7553 @opindex mno-prologue-epilogue
7554 @opindex mprologue-epilogue
7555 With @option{-mno-prologue-epilogue}, the normal function prologue and
7556 epilogue that sets up the stack-frame are omitted and no return
7557 instructions or return sequences are generated in the code. Use this
7558 option only together with visual inspection of the compiled code: no
7559 warnings or errors are generated when call-saved registers must be saved,
7560 or storage for local variable needs to be allocated.
7561
7562 @item -mno-gotplt
7563 @itemx -mgotplt
7564 @opindex mno-gotplt
7565 @opindex mgotplt
7566 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7567 instruction sequences that load addresses for functions from the PLT part
7568 of the GOT rather than (traditional on other architectures) calls to the
7569 PLT@. The default is @option{-mgotplt}.
7570
7571 @item -maout
7572 @opindex maout
7573 Legacy no-op option only recognized with the cris-axis-aout target.
7574
7575 @item -melf
7576 @opindex melf
7577 Legacy no-op option only recognized with the cris-axis-elf and
7578 cris-axis-linux-gnu targets.
7579
7580 @item -melinux
7581 @opindex melinux
7582 Only recognized with the cris-axis-aout target, where it selects a
7583 GNU/linux-like multilib, include files and instruction set for
7584 @option{-march=v8}.
7585
7586 @item -mlinux
7587 @opindex mlinux
7588 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7589
7590 @item -sim
7591 @opindex sim
7592 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7593 to link with input-output functions from a simulator library. Code,
7594 initialized data and zero-initialized data are allocated consecutively.
7595
7596 @item -sim2
7597 @opindex sim2
7598 Like @option{-sim}, but pass linker options to locate initialized data at
7599 0x40000000 and zero-initialized data at 0x80000000.
7600 @end table
7601
7602 @node Darwin Options
7603 @subsection Darwin Options
7604 @cindex Darwin options
7605
7606 These options are defined for all architectures running the Darwin operating
7607 system.
7608
7609 FSF GCC on Darwin does not create ``fat'' object files; it will create
7610 an object file for the single architecture that it was built to
7611 target. Apple's GCC on Darwin does create ``fat'' files if multiple
7612 @option{-arch} options are used; it does so by running the compiler or
7613 linker multiple times and joining the results together with
7614 @file{lipo}.
7615
7616 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7617 @samp{i686}) is determined by the flags that specify the ISA
7618 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
7619 @option{-force_cpusubtype_ALL} option can be used to override this.
7620
7621 The Darwin tools vary in their behavior when presented with an ISA
7622 mismatch. The assembler, @file{as}, will only permit instructions to
7623 be used that are valid for the subtype of the file it is generating,
7624 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7625 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7626 and print an error if asked to create a shared library with a less
7627 restrictive subtype than its input files (for instance, trying to put
7628 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7629 for executables, @file{ld}, will quietly give the executable the most
7630 restrictive subtype of any of its input files.
7631
7632 @table @gcctabopt
7633 @item -F@var{dir}
7634 @opindex F
7635 Add the framework directory @var{dir} to the head of the list of
7636 directories to be searched for header files. These directories are
7637 interleaved with those specified by @option{-I} options and are
7638 scanned in a left-to-right order.
7639
7640 A framework directory is a directory with frameworks in it. A
7641 framework is a directory with a @samp{"Headers"} and/or
7642 @samp{"PrivateHeaders"} directory contained directly in it that ends
7643 in @samp{".framework"}. The name of a framework is the name of this
7644 directory excluding the @samp{".framework"}. Headers associated with
7645 the framework are found in one of those two directories, with
7646 @samp{"Headers"} being searched first. A subframework is a framework
7647 directory that is in a framework's @samp{"Frameworks"} directory.
7648 Includes of subframework headers can only appear in a header of a
7649 framework that contains the subframework, or in a sibling subframework
7650 header. Two subframeworks are siblings if they occur in the same
7651 framework. A subframework should not have the same name as a
7652 framework, a warning will be issued if this is violated. Currently a
7653 subframework cannot have subframeworks, in the future, the mechanism
7654 may be extended to support this. The standard frameworks can be found
7655 in @samp{"/System/Library/Frameworks"} and
7656 @samp{"/Library/Frameworks"}. An example include looks like
7657 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7658 the name of the framework and header.h is found in the
7659 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7660
7661 @item -gused
7662 @opindex -gused
7663 Emit debugging information for symbols that are used. For STABS
7664 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7665 This is by default ON@.
7666
7667 @item -gfull
7668 @opindex -gfull
7669 Emit debugging information for all symbols and types.
7670
7671 @item -mone-byte-bool
7672 @opindex -mone-byte-bool
7673 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7674 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7675 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7676 option has no effect on x86.
7677
7678 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7679 to generate code that is not binary compatible with code generated
7680 without that switch. Using this switch may require recompiling all
7681 other modules in a program, including system libraries. Use this
7682 switch to conform to a non-default data model.
7683
7684 @item -mfix-and-continue
7685 @itemx -ffix-and-continue
7686 @itemx -findirect-data
7687 @opindex mfix-and-continue
7688 @opindex ffix-and-continue
7689 @opindex findirect-data
7690 Generate code suitable for fast turn around development. Needed to
7691 enable gdb to dynamically load @code{.o} files into already running
7692 programs. @option{-findirect-data} and @option{-ffix-and-continue}
7693 are provided for backwards compatibility.
7694
7695 @item -all_load
7696 @opindex all_load
7697 Loads all members of static archive libraries.
7698 See man ld(1) for more information.
7699
7700 @item -arch_errors_fatal
7701 @opindex arch_errors_fatal
7702 Cause the errors having to do with files that have the wrong architecture
7703 to be fatal.
7704
7705 @item -bind_at_load
7706 @opindex bind_at_load
7707 Causes the output file to be marked such that the dynamic linker will
7708 bind all undefined references when the file is loaded or launched.
7709
7710 @item -bundle
7711 @opindex bundle
7712 Produce a Mach-o bundle format file.
7713 See man ld(1) for more information.
7714
7715 @item -bundle_loader @var{executable}
7716 @opindex bundle_loader
7717 This option specifies the @var{executable} that will be loading the build
7718 output file being linked. See man ld(1) for more information.
7719
7720 @item -dynamiclib
7721 @opindex -dynamiclib
7722 When passed this option, GCC will produce a dynamic library instead of
7723 an executable when linking, using the Darwin @file{libtool} command.
7724
7725 @item -force_cpusubtype_ALL
7726 @opindex -force_cpusubtype_ALL
7727 This causes GCC's output file to have the @var{ALL} subtype, instead of
7728 one controlled by the @option{-mcpu} or @option{-march} option.
7729
7730 @item -allowable_client @var{client_name}
7731 @itemx -client_name
7732 @itemx -compatibility_version
7733 @itemx -current_version
7734 @itemx -dead_strip
7735 @itemx -dependency-file
7736 @itemx -dylib_file
7737 @itemx -dylinker_install_name
7738 @itemx -dynamic
7739 @itemx -exported_symbols_list
7740 @itemx -filelist
7741 @itemx -flat_namespace
7742 @itemx -force_flat_namespace
7743 @itemx -headerpad_max_install_names
7744 @itemx -image_base
7745 @itemx -init
7746 @itemx -install_name
7747 @itemx -keep_private_externs
7748 @itemx -multi_module
7749 @itemx -multiply_defined
7750 @itemx -multiply_defined_unused
7751 @itemx -noall_load
7752 @itemx -no_dead_strip_inits_and_terms
7753 @itemx -nofixprebinding
7754 @itemx -nomultidefs
7755 @itemx -noprebind
7756 @itemx -noseglinkedit
7757 @itemx -pagezero_size
7758 @itemx -prebind
7759 @itemx -prebind_all_twolevel_modules
7760 @itemx -private_bundle
7761 @itemx -read_only_relocs
7762 @itemx -sectalign
7763 @itemx -sectobjectsymbols
7764 @itemx -whyload
7765 @itemx -seg1addr
7766 @itemx -sectcreate
7767 @itemx -sectobjectsymbols
7768 @itemx -sectorder
7769 @itemx -segaddr
7770 @itemx -segs_read_only_addr
7771 @itemx -segs_read_write_addr
7772 @itemx -seg_addr_table
7773 @itemx -seg_addr_table_filename
7774 @itemx -seglinkedit
7775 @itemx -segprot
7776 @itemx -segs_read_only_addr
7777 @itemx -segs_read_write_addr
7778 @itemx -single_module
7779 @itemx -static
7780 @itemx -sub_library
7781 @itemx -sub_umbrella
7782 @itemx -twolevel_namespace
7783 @itemx -umbrella
7784 @itemx -undefined
7785 @itemx -unexported_symbols_list
7786 @itemx -weak_reference_mismatches
7787 @itemx -whatsloaded
7788
7789 @opindex allowable_client
7790 @opindex client_name
7791 @opindex compatibility_version
7792 @opindex current_version
7793 @opindex dead_strip
7794 @opindex dependency-file
7795 @opindex dylib_file
7796 @opindex dylinker_install_name
7797 @opindex dynamic
7798 @opindex exported_symbols_list
7799 @opindex filelist
7800 @opindex flat_namespace
7801 @opindex force_flat_namespace
7802 @opindex headerpad_max_install_names
7803 @opindex image_base
7804 @opindex init
7805 @opindex install_name
7806 @opindex keep_private_externs
7807 @opindex multi_module
7808 @opindex multiply_defined
7809 @opindex multiply_defined_unused
7810 @opindex noall_load
7811 @opindex no_dead_strip_inits_and_terms
7812 @opindex nofixprebinding
7813 @opindex nomultidefs
7814 @opindex noprebind
7815 @opindex noseglinkedit
7816 @opindex pagezero_size
7817 @opindex prebind
7818 @opindex prebind_all_twolevel_modules
7819 @opindex private_bundle
7820 @opindex read_only_relocs
7821 @opindex sectalign
7822 @opindex sectobjectsymbols
7823 @opindex whyload
7824 @opindex seg1addr
7825 @opindex sectcreate
7826 @opindex sectobjectsymbols
7827 @opindex sectorder
7828 @opindex segaddr
7829 @opindex segs_read_only_addr
7830 @opindex segs_read_write_addr
7831 @opindex seg_addr_table
7832 @opindex seg_addr_table_filename
7833 @opindex seglinkedit
7834 @opindex segprot
7835 @opindex segs_read_only_addr
7836 @opindex segs_read_write_addr
7837 @opindex single_module
7838 @opindex static
7839 @opindex sub_library
7840 @opindex sub_umbrella
7841 @opindex twolevel_namespace
7842 @opindex umbrella
7843 @opindex undefined
7844 @opindex unexported_symbols_list
7845 @opindex weak_reference_mismatches
7846 @opindex whatsloaded
7847
7848 These options are passed to the Darwin linker. The Darwin linker man page
7849 describes them in detail.
7850 @end table
7851
7852 @node DEC Alpha Options
7853 @subsection DEC Alpha Options
7854
7855 These @samp{-m} options are defined for the DEC Alpha implementations:
7856
7857 @table @gcctabopt
7858 @item -mno-soft-float
7859 @itemx -msoft-float
7860 @opindex mno-soft-float
7861 @opindex msoft-float
7862 Use (do not use) the hardware floating-point instructions for
7863 floating-point operations. When @option{-msoft-float} is specified,
7864 functions in @file{libgcc.a} will be used to perform floating-point
7865 operations. Unless they are replaced by routines that emulate the
7866 floating-point operations, or compiled in such a way as to call such
7867 emulations routines, these routines will issue floating-point
7868 operations. If you are compiling for an Alpha without floating-point
7869 operations, you must ensure that the library is built so as not to call
7870 them.
7871
7872 Note that Alpha implementations without floating-point operations are
7873 required to have floating-point registers.
7874
7875 @item -mfp-reg
7876 @itemx -mno-fp-regs
7877 @opindex mfp-reg
7878 @opindex mno-fp-regs
7879 Generate code that uses (does not use) the floating-point register set.
7880 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
7881 register set is not used, floating point operands are passed in integer
7882 registers as if they were integers and floating-point results are passed
7883 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
7884 so any function with a floating-point argument or return value called by code
7885 compiled with @option{-mno-fp-regs} must also be compiled with that
7886 option.
7887
7888 A typical use of this option is building a kernel that does not use,
7889 and hence need not save and restore, any floating-point registers.
7890
7891 @item -mieee
7892 @opindex mieee
7893 The Alpha architecture implements floating-point hardware optimized for
7894 maximum performance. It is mostly compliant with the IEEE floating
7895 point standard. However, for full compliance, software assistance is
7896 required. This option generates code fully IEEE compliant code
7897 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7898 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7899 defined during compilation. The resulting code is less efficient but is
7900 able to correctly support denormalized numbers and exceptional IEEE
7901 values such as not-a-number and plus/minus infinity. Other Alpha
7902 compilers call this option @option{-ieee_with_no_inexact}.
7903
7904 @item -mieee-with-inexact
7905 @opindex mieee-with-inexact
7906 This is like @option{-mieee} except the generated code also maintains
7907 the IEEE @var{inexact-flag}. Turning on this option causes the
7908 generated code to implement fully-compliant IEEE math. In addition to
7909 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7910 macro. On some Alpha implementations the resulting code may execute
7911 significantly slower than the code generated by default. Since there is
7912 very little code that depends on the @var{inexact-flag}, you should
7913 normally not specify this option. Other Alpha compilers call this
7914 option @option{-ieee_with_inexact}.
7915
7916 @item -mfp-trap-mode=@var{trap-mode}
7917 @opindex mfp-trap-mode
7918 This option controls what floating-point related traps are enabled.
7919 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7920 The trap mode can be set to one of four values:
7921
7922 @table @samp
7923 @item n
7924 This is the default (normal) setting. The only traps that are enabled
7925 are the ones that cannot be disabled in software (e.g., division by zero
7926 trap).
7927
7928 @item u
7929 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7930 as well.
7931
7932 @item su
7933 Like @samp{su}, but the instructions are marked to be safe for software
7934 completion (see Alpha architecture manual for details).
7935
7936 @item sui
7937 Like @samp{su}, but inexact traps are enabled as well.
7938 @end table
7939
7940 @item -mfp-rounding-mode=@var{rounding-mode}
7941 @opindex mfp-rounding-mode
7942 Selects the IEEE rounding mode. Other Alpha compilers call this option
7943 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
7944 of:
7945
7946 @table @samp
7947 @item n
7948 Normal IEEE rounding mode. Floating point numbers are rounded towards
7949 the nearest machine number or towards the even machine number in case
7950 of a tie.
7951
7952 @item m
7953 Round towards minus infinity.
7954
7955 @item c
7956 Chopped rounding mode. Floating point numbers are rounded towards zero.
7957
7958 @item d
7959 Dynamic rounding mode. A field in the floating point control register
7960 (@var{fpcr}, see Alpha architecture reference manual) controls the
7961 rounding mode in effect. The C library initializes this register for
7962 rounding towards plus infinity. Thus, unless your program modifies the
7963 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7964 @end table
7965
7966 @item -mtrap-precision=@var{trap-precision}
7967 @opindex mtrap-precision
7968 In the Alpha architecture, floating point traps are imprecise. This
7969 means without software assistance it is impossible to recover from a
7970 floating trap and program execution normally needs to be terminated.
7971 GCC can generate code that can assist operating system trap handlers
7972 in determining the exact location that caused a floating point trap.
7973 Depending on the requirements of an application, different levels of
7974 precisions can be selected:
7975
7976 @table @samp
7977 @item p
7978 Program precision. This option is the default and means a trap handler
7979 can only identify which program caused a floating point exception.
7980
7981 @item f
7982 Function precision. The trap handler can determine the function that
7983 caused a floating point exception.
7984
7985 @item i
7986 Instruction precision. The trap handler can determine the exact
7987 instruction that caused a floating point exception.
7988 @end table
7989
7990 Other Alpha compilers provide the equivalent options called
7991 @option{-scope_safe} and @option{-resumption_safe}.
7992
7993 @item -mieee-conformant
7994 @opindex mieee-conformant
7995 This option marks the generated code as IEEE conformant. You must not
7996 use this option unless you also specify @option{-mtrap-precision=i} and either
7997 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
7998 is to emit the line @samp{.eflag 48} in the function prologue of the
7999 generated assembly file. Under DEC Unix, this has the effect that
8000 IEEE-conformant math library routines will be linked in.
8001
8002 @item -mbuild-constants
8003 @opindex mbuild-constants
8004 Normally GCC examines a 32- or 64-bit integer constant to
8005 see if it can construct it from smaller constants in two or three
8006 instructions. If it cannot, it will output the constant as a literal and
8007 generate code to load it from the data segment at runtime.
8008
8009 Use this option to require GCC to construct @emph{all} integer constants
8010 using code, even if it takes more instructions (the maximum is six).
8011
8012 You would typically use this option to build a shared library dynamic
8013 loader. Itself a shared library, it must relocate itself in memory
8014 before it can find the variables and constants in its own data segment.
8015
8016 @item -malpha-as
8017 @itemx -mgas
8018 @opindex malpha-as
8019 @opindex mgas
8020 Select whether to generate code to be assembled by the vendor-supplied
8021 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
8022
8023 @item -mbwx
8024 @itemx -mno-bwx
8025 @itemx -mcix
8026 @itemx -mno-cix
8027 @itemx -mfix
8028 @itemx -mno-fix
8029 @itemx -mmax
8030 @itemx -mno-max
8031 @opindex mbwx
8032 @opindex mno-bwx
8033 @opindex mcix
8034 @opindex mno-cix
8035 @opindex mfix
8036 @opindex mno-fix
8037 @opindex mmax
8038 @opindex mno-max
8039 Indicate whether GCC should generate code to use the optional BWX,
8040 CIX, FIX and MAX instruction sets. The default is to use the instruction
8041 sets supported by the CPU type specified via @option{-mcpu=} option or that
8042 of the CPU on which GCC was built if none was specified.
8043
8044 @item -mfloat-vax
8045 @itemx -mfloat-ieee
8046 @opindex mfloat-vax
8047 @opindex mfloat-ieee
8048 Generate code that uses (does not use) VAX F and G floating point
8049 arithmetic instead of IEEE single and double precision.
8050
8051 @item -mexplicit-relocs
8052 @itemx -mno-explicit-relocs
8053 @opindex mexplicit-relocs
8054 @opindex mno-explicit-relocs
8055 Older Alpha assemblers provided no way to generate symbol relocations
8056 except via assembler macros. Use of these macros does not allow
8057 optimal instruction scheduling. GNU binutils as of version 2.12
8058 supports a new syntax that allows the compiler to explicitly mark
8059 which relocations should apply to which instructions. This option
8060 is mostly useful for debugging, as GCC detects the capabilities of
8061 the assembler when it is built and sets the default accordingly.
8062
8063 @item -msmall-data
8064 @itemx -mlarge-data
8065 @opindex msmall-data
8066 @opindex mlarge-data
8067 When @option{-mexplicit-relocs} is in effect, static data is
8068 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
8069 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
8070 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
8071 16-bit relocations off of the @code{$gp} register. This limits the
8072 size of the small data area to 64KB, but allows the variables to be
8073 directly accessed via a single instruction.
8074
8075 The default is @option{-mlarge-data}. With this option the data area
8076 is limited to just below 2GB@. Programs that require more than 2GB of
8077 data must use @code{malloc} or @code{mmap} to allocate the data in the
8078 heap instead of in the program's data segment.
8079
8080 When generating code for shared libraries, @option{-fpic} implies
8081 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
8082
8083 @item -msmall-text
8084 @itemx -mlarge-text
8085 @opindex msmall-text
8086 @opindex mlarge-text
8087 When @option{-msmall-text} is used, the compiler assumes that the
8088 code of the entire program (or shared library) fits in 4MB, and is
8089 thus reachable with a branch instruction. When @option{-msmall-data}
8090 is used, the compiler can assume that all local symbols share the
8091 same @code{$gp} value, and thus reduce the number of instructions
8092 required for a function call from 4 to 1.
8093
8094 The default is @option{-mlarge-text}.
8095
8096 @item -mcpu=@var{cpu_type}
8097 @opindex mcpu
8098 Set the instruction set and instruction scheduling parameters for
8099 machine type @var{cpu_type}. You can specify either the @samp{EV}
8100 style name or the corresponding chip number. GCC supports scheduling
8101 parameters for the EV4, EV5 and EV6 family of processors and will
8102 choose the default values for the instruction set from the processor
8103 you specify. If you do not specify a processor type, GCC will default
8104 to the processor on which the compiler was built.
8105
8106 Supported values for @var{cpu_type} are
8107
8108 @table @samp
8109 @item ev4
8110 @itemx ev45
8111 @itemx 21064
8112 Schedules as an EV4 and has no instruction set extensions.
8113
8114 @item ev5
8115 @itemx 21164
8116 Schedules as an EV5 and has no instruction set extensions.
8117
8118 @item ev56
8119 @itemx 21164a
8120 Schedules as an EV5 and supports the BWX extension.
8121
8122 @item pca56
8123 @itemx 21164pc
8124 @itemx 21164PC
8125 Schedules as an EV5 and supports the BWX and MAX extensions.
8126
8127 @item ev6
8128 @itemx 21264
8129 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
8130
8131 @item ev67
8132 @itemx 21264a
8133 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
8134 @end table
8135
8136 @item -mtune=@var{cpu_type}
8137 @opindex mtune
8138 Set only the instruction scheduling parameters for machine type
8139 @var{cpu_type}. The instruction set is not changed.
8140
8141 @item -mmemory-latency=@var{time}
8142 @opindex mmemory-latency
8143 Sets the latency the scheduler should assume for typical memory
8144 references as seen by the application. This number is highly
8145 dependent on the memory access patterns used by the application
8146 and the size of the external cache on the machine.
8147
8148 Valid options for @var{time} are
8149
8150 @table @samp
8151 @item @var{number}
8152 A decimal number representing clock cycles.
8153
8154 @item L1
8155 @itemx L2
8156 @itemx L3
8157 @itemx main
8158 The compiler contains estimates of the number of clock cycles for
8159 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8160 (also called Dcache, Scache, and Bcache), as well as to main memory.
8161 Note that L3 is only valid for EV5.
8162
8163 @end table
8164 @end table
8165
8166 @node DEC Alpha/VMS Options
8167 @subsection DEC Alpha/VMS Options
8168
8169 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8170
8171 @table @gcctabopt
8172 @item -mvms-return-codes
8173 @opindex mvms-return-codes
8174 Return VMS condition codes from main. The default is to return POSIX
8175 style condition (e.g.@ error) codes.
8176 @end table
8177
8178 @node FRV Options
8179 @subsection FRV Options
8180 @cindex FRV Options
8181
8182 @table @gcctabopt
8183 @item -mgpr-32
8184 @opindex mgpr-32
8185
8186 Only use the first 32 general purpose registers.
8187
8188 @item -mgpr-64
8189 @opindex mgpr-64
8190
8191 Use all 64 general purpose registers.
8192
8193 @item -mfpr-32
8194 @opindex mfpr-32
8195
8196 Use only the first 32 floating point registers.
8197
8198 @item -mfpr-64
8199 @opindex mfpr-64
8200
8201 Use all 64 floating point registers
8202
8203 @item -mhard-float
8204 @opindex mhard-float
8205
8206 Use hardware instructions for floating point operations.
8207
8208 @item -msoft-float
8209 @opindex msoft-float
8210
8211 Use library routines for floating point operations.
8212
8213 @item -malloc-cc
8214 @opindex malloc-cc
8215
8216 Dynamically allocate condition code registers.
8217
8218 @item -mfixed-cc
8219 @opindex mfixed-cc
8220
8221 Do not try to dynamically allocate condition code registers, only
8222 use @code{icc0} and @code{fcc0}.
8223
8224 @item -mdword
8225 @opindex mdword
8226
8227 Change ABI to use double word insns.
8228
8229 @item -mno-dword
8230 @opindex mno-dword
8231
8232 Do not use double word instructions.
8233
8234 @item -mdouble
8235 @opindex mdouble
8236
8237 Use floating point double instructions.
8238
8239 @item -mno-double
8240 @opindex mno-double
8241
8242 Do not use floating point double instructions.
8243
8244 @item -mmedia
8245 @opindex mmedia
8246
8247 Use media instructions.
8248
8249 @item -mno-media
8250 @opindex mno-media
8251
8252 Do not use media instructions.
8253
8254 @item -mmuladd
8255 @opindex mmuladd
8256
8257 Use multiply and add/subtract instructions.
8258
8259 @item -mno-muladd
8260 @opindex mno-muladd
8261
8262 Do not use multiply and add/subtract instructions.
8263
8264 @item -mfdpic
8265 @opindex mfdpic
8266
8267 Select the FDPIC ABI, that uses function descriptors to represent
8268 pointers to functions. Without any PIC/PIE-related options, it
8269 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8270 assumes GOT entries and small data are within a 12-bit range from the
8271 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8272 are computed with 32 bits.
8273
8274 @item -minline-plt
8275 @opindex minline-plt
8276
8277 Enable inlining of PLT entries in function calls to functions that are
8278 not known to bind locally. It has no effect without @option{-mfdpic}.
8279 It's enabled by default if optimizing for speed and compiling for
8280 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8281 optimization option such as @option{-O3} or above is present in the
8282 command line.
8283
8284 @item -mTLS
8285 @opindex TLS
8286
8287 Assume a large TLS segment when generating thread-local code.
8288
8289 @item -mtls
8290 @opindex tls
8291
8292 Do not assume a large TLS segment when generating thread-local code.
8293
8294 @item -mgprel-ro
8295 @opindex mgprel-ro
8296
8297 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8298 that is known to be in read-only sections. It's enabled by default,
8299 except for @option{-fpic} or @option{-fpie}: even though it may help
8300 make the global offset table smaller, it trades 1 instruction for 4.
8301 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8302 one of which may be shared by multiple symbols, and it avoids the need
8303 for a GOT entry for the referenced symbol, so it's more likely to be a
8304 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8305
8306 @item -multilib-library-pic
8307 @opindex multilib-library-pic
8308
8309 Link with the (library, not FD) pic libraries. It's implied by
8310 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8311 @option{-fpic} without @option{-mfdpic}. You should never have to use
8312 it explicitly.
8313
8314 @item -mlinked-fp
8315 @opindex mlinked-fp
8316
8317 Follow the EABI requirement of always creating a frame pointer whenever
8318 a stack frame is allocated. This option is enabled by default and can
8319 be disabled with @option{-mno-linked-fp}.
8320
8321 @item -mlong-calls
8322 @opindex mlong-calls
8323
8324 Use indirect addressing to call functions outside the current
8325 compilation unit. This allows the functions to be placed anywhere
8326 within the 32-bit address space.
8327
8328 @item -malign-labels
8329 @opindex malign-labels
8330
8331 Try to align labels to an 8-byte boundary by inserting nops into the
8332 previous packet. This option only has an effect when VLIW packing
8333 is enabled. It doesn't create new packets; it merely adds nops to
8334 existing ones.
8335
8336 @item -mlibrary-pic
8337 @opindex mlibrary-pic
8338
8339 Generate position-independent EABI code.
8340
8341 @item -macc-4
8342 @opindex macc-4
8343
8344 Use only the first four media accumulator registers.
8345
8346 @item -macc-8
8347 @opindex macc-8
8348
8349 Use all eight media accumulator registers.
8350
8351 @item -mpack
8352 @opindex mpack
8353
8354 Pack VLIW instructions.
8355
8356 @item -mno-pack
8357 @opindex mno-pack
8358
8359 Do not pack VLIW instructions.
8360
8361 @item -mno-eflags
8362 @opindex mno-eflags
8363
8364 Do not mark ABI switches in e_flags.
8365
8366 @item -mcond-move
8367 @opindex mcond-move
8368
8369 Enable the use of conditional-move instructions (default).
8370
8371 This switch is mainly for debugging the compiler and will likely be removed
8372 in a future version.
8373
8374 @item -mno-cond-move
8375 @opindex mno-cond-move
8376
8377 Disable the use of conditional-move instructions.
8378
8379 This switch is mainly for debugging the compiler and will likely be removed
8380 in a future version.
8381
8382 @item -mscc
8383 @opindex mscc
8384
8385 Enable the use of conditional set instructions (default).
8386
8387 This switch is mainly for debugging the compiler and will likely be removed
8388 in a future version.
8389
8390 @item -mno-scc
8391 @opindex mno-scc
8392
8393 Disable the use of conditional set instructions.
8394
8395 This switch is mainly for debugging the compiler and will likely be removed
8396 in a future version.
8397
8398 @item -mcond-exec
8399 @opindex mcond-exec
8400
8401 Enable the use of conditional execution (default).
8402
8403 This switch is mainly for debugging the compiler and will likely be removed
8404 in a future version.
8405
8406 @item -mno-cond-exec
8407 @opindex mno-cond-exec
8408
8409 Disable the use of conditional execution.
8410
8411 This switch is mainly for debugging the compiler and will likely be removed
8412 in a future version.
8413
8414 @item -mvliw-branch
8415 @opindex mvliw-branch
8416
8417 Run a pass to pack branches into VLIW instructions (default).
8418
8419 This switch is mainly for debugging the compiler and will likely be removed
8420 in a future version.
8421
8422 @item -mno-vliw-branch
8423 @opindex mno-vliw-branch
8424
8425 Do not run a pass to pack branches into VLIW instructions.
8426
8427 This switch is mainly for debugging the compiler and will likely be removed
8428 in a future version.
8429
8430 @item -mmulti-cond-exec
8431 @opindex mmulti-cond-exec
8432
8433 Enable optimization of @code{&&} and @code{||} in conditional execution
8434 (default).
8435
8436 This switch is mainly for debugging the compiler and will likely be removed
8437 in a future version.
8438
8439 @item -mno-multi-cond-exec
8440 @opindex mno-multi-cond-exec
8441
8442 Disable optimization of @code{&&} and @code{||} in conditional execution.
8443
8444 This switch is mainly for debugging the compiler and will likely be removed
8445 in a future version.
8446
8447 @item -mnested-cond-exec
8448 @opindex mnested-cond-exec
8449
8450 Enable nested conditional execution optimizations (default).
8451
8452 This switch is mainly for debugging the compiler and will likely be removed
8453 in a future version.
8454
8455 @item -mno-nested-cond-exec
8456 @opindex mno-nested-cond-exec
8457
8458 Disable nested conditional execution optimizations.
8459
8460 This switch is mainly for debugging the compiler and will likely be removed
8461 in a future version.
8462
8463 @item -mtomcat-stats
8464 @opindex mtomcat-stats
8465
8466 Cause gas to print out tomcat statistics.
8467
8468 @item -mcpu=@var{cpu}
8469 @opindex mcpu
8470
8471 Select the processor type for which to generate code. Possible values are
8472 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8473 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8474
8475 @end table
8476
8477 @node H8/300 Options
8478 @subsection H8/300 Options
8479
8480 These @samp{-m} options are defined for the H8/300 implementations:
8481
8482 @table @gcctabopt
8483 @item -mrelax
8484 @opindex mrelax
8485 Shorten some address references at link time, when possible; uses the
8486 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8487 ld, Using ld}, for a fuller description.
8488
8489 @item -mh
8490 @opindex mh
8491 Generate code for the H8/300H@.
8492
8493 @item -ms
8494 @opindex ms
8495 Generate code for the H8S@.
8496
8497 @item -mn
8498 @opindex mn
8499 Generate code for the H8S and H8/300H in the normal mode. This switch
8500 must be used either with @option{-mh} or @option{-ms}.
8501
8502 @item -ms2600
8503 @opindex ms2600
8504 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
8505
8506 @item -mint32
8507 @opindex mint32
8508 Make @code{int} data 32 bits by default.
8509
8510 @item -malign-300
8511 @opindex malign-300
8512 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8513 The default for the H8/300H and H8S is to align longs and floats on 4
8514 byte boundaries.
8515 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8516 This option has no effect on the H8/300.
8517 @end table
8518
8519 @node HPPA Options
8520 @subsection HPPA Options
8521 @cindex HPPA Options
8522
8523 These @samp{-m} options are defined for the HPPA family of computers:
8524
8525 @table @gcctabopt
8526 @item -march=@var{architecture-type}
8527 @opindex march
8528 Generate code for the specified architecture. The choices for
8529 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8530 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8531 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8532 architecture option for your machine. Code compiled for lower numbered
8533 architectures will run on higher numbered architectures, but not the
8534 other way around.
8535
8536 @item -mpa-risc-1-0
8537 @itemx -mpa-risc-1-1
8538 @itemx -mpa-risc-2-0
8539 @opindex mpa-risc-1-0
8540 @opindex mpa-risc-1-1
8541 @opindex mpa-risc-2-0
8542 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8543
8544 @item -mbig-switch
8545 @opindex mbig-switch
8546 Generate code suitable for big switch tables. Use this option only if
8547 the assembler/linker complain about out of range branches within a switch
8548 table.
8549
8550 @item -mjump-in-delay
8551 @opindex mjump-in-delay
8552 Fill delay slots of function calls with unconditional jump instructions
8553 by modifying the return pointer for the function call to be the target
8554 of the conditional jump.
8555
8556 @item -mdisable-fpregs
8557 @opindex mdisable-fpregs
8558 Prevent floating point registers from being used in any manner. This is
8559 necessary for compiling kernels which perform lazy context switching of
8560 floating point registers. If you use this option and attempt to perform
8561 floating point operations, the compiler will abort.
8562
8563 @item -mdisable-indexing
8564 @opindex mdisable-indexing
8565 Prevent the compiler from using indexing address modes. This avoids some
8566 rather obscure problems when compiling MIG generated code under MACH@.
8567
8568 @item -mno-space-regs
8569 @opindex mno-space-regs
8570 Generate code that assumes the target has no space registers. This allows
8571 GCC to generate faster indirect calls and use unscaled index address modes.
8572
8573 Such code is suitable for level 0 PA systems and kernels.
8574
8575 @item -mfast-indirect-calls
8576 @opindex mfast-indirect-calls
8577 Generate code that assumes calls never cross space boundaries. This
8578 allows GCC to emit code which performs faster indirect calls.
8579
8580 This option will not work in the presence of shared libraries or nested
8581 functions.
8582
8583 @item -mfixed-range=@var{register-range}
8584 @opindex mfixed-range
8585 Generate code treating the given register range as fixed registers.
8586 A fixed register is one that the register allocator can not use. This is
8587 useful when compiling kernel code. A register range is specified as
8588 two registers separated by a dash. Multiple register ranges can be
8589 specified separated by a comma.
8590
8591 @item -mlong-load-store
8592 @opindex mlong-load-store
8593 Generate 3-instruction load and store sequences as sometimes required by
8594 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8595 the HP compilers.
8596
8597 @item -mportable-runtime
8598 @opindex mportable-runtime
8599 Use the portable calling conventions proposed by HP for ELF systems.
8600
8601 @item -mgas
8602 @opindex mgas
8603 Enable the use of assembler directives only GAS understands.
8604
8605 @item -mschedule=@var{cpu-type}
8606 @opindex mschedule
8607 Schedule code according to the constraints for the machine type
8608 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8609 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8610 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8611 proper scheduling option for your machine. The default scheduling is
8612 @samp{8000}.
8613
8614 @item -mlinker-opt
8615 @opindex mlinker-opt
8616 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8617 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8618 linkers in which they give bogus error messages when linking some programs.
8619
8620 @item -msoft-float
8621 @opindex msoft-float
8622 Generate output containing library calls for floating point.
8623 @strong{Warning:} the requisite libraries are not available for all HPPA
8624 targets. Normally the facilities of the machine's usual C compiler are
8625 used, but this cannot be done directly in cross-compilation. You must make
8626 your own arrangements to provide suitable library functions for
8627 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8628 does provide software floating point support.
8629
8630 @option{-msoft-float} changes the calling convention in the output file;
8631 therefore, it is only useful if you compile @emph{all} of a program with
8632 this option. In particular, you need to compile @file{libgcc.a}, the
8633 library that comes with GCC, with @option{-msoft-float} in order for
8634 this to work.
8635
8636 @item -msio
8637 @opindex msio
8638 Generate the predefine, @code{_SIO}, for server IO@. The default is
8639 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8640 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8641 options are available under HP-UX and HI-UX@.
8642
8643 @item -mgnu-ld
8644 @opindex gnu-ld
8645 Use GNU ld specific options. This passes @option{-shared} to ld when
8646 building a shared library. It is the default when GCC is configured,
8647 explicitly or implicitly, with the GNU linker. This option does not
8648 have any affect on which ld is called, it only changes what parameters
8649 are passed to that ld. The ld that is called is determined by the
8650 @option{--with-ld} configure option, GCC's program search path, and
8651 finally by the user's @env{PATH}. The linker used by GCC can be printed
8652 using @samp{which `gcc -print-prog-name=ld`}.
8653
8654 @item -mhp-ld
8655 @opindex hp-ld
8656 Use HP ld specific options. This passes @option{-b} to ld when building
8657 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8658 links. It is the default when GCC is configured, explicitly or
8659 implicitly, with the HP linker. This option does not have any affect on
8660 which ld is called, it only changes what parameters are passed to that
8661 ld. The ld that is called is determined by the @option{--with-ld}
8662 configure option, GCC's program search path, and finally by the user's
8663 @env{PATH}. The linker used by GCC can be printed using @samp{which
8664 `gcc -print-prog-name=ld`}.
8665
8666 @item -mlong-calls
8667 @opindex mno-long-calls
8668 Generate code that uses long call sequences. This ensures that a call
8669 is always able to reach linker generated stubs. The default is to generate
8670 long calls only when the distance from the call site to the beginning
8671 of the function or translation unit, as the case may be, exceeds a
8672 predefined limit set by the branch type being used. The limits for
8673 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8674 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8675 240,000 bytes.
8676
8677 Distances are measured from the beginning of functions when using the
8678 @option{-ffunction-sections} option, or when using the @option{-mgas}
8679 and @option{-mno-portable-runtime} options together under HP-UX with
8680 the SOM linker.
8681
8682 It is normally not desirable to use this option as it will degrade
8683 performance. However, it may be useful in large applications,
8684 particularly when partial linking is used to build the application.
8685
8686 The types of long calls used depends on the capabilities of the
8687 assembler and linker, and the type of code being generated. The
8688 impact on systems that support long absolute calls, and long pic
8689 symbol-difference or pc-relative calls should be relatively small.
8690 However, an indirect call is used on 32-bit ELF systems in pic code
8691 and it is quite long.
8692
8693 @item -munix=@var{unix-std}
8694 @opindex march
8695 Generate compiler predefines and select a startfile for the specified
8696 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
8697 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
8698 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
8699 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
8700 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8701 and later.
8702
8703 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8704 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8705 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8706 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8707 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8708 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8709
8710 It is @emph{important} to note that this option changes the interfaces
8711 for various library routines. It also affects the operational behavior
8712 of the C library. Thus, @emph{extreme} care is needed in using this
8713 option.
8714
8715 Library code that is intended to operate with more than one UNIX
8716 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8717 as appropriate. Most GNU software doesn't provide this capability.
8718
8719 @item -nolibdld
8720 @opindex nolibdld
8721 Suppress the generation of link options to search libdld.sl when the
8722 @option{-static} option is specified on HP-UX 10 and later.
8723
8724 @item -static
8725 @opindex static
8726 The HP-UX implementation of setlocale in libc has a dependency on
8727 libdld.sl. There isn't an archive version of libdld.sl. Thus,
8728 when the @option{-static} option is specified, special link options
8729 are needed to resolve this dependency.
8730
8731 On HP-UX 10 and later, the GCC driver adds the necessary options to
8732 link with libdld.sl when the @option{-static} option is specified.
8733 This causes the resulting binary to be dynamic. On the 64-bit port,
8734 the linkers generate dynamic binaries by default in any case. The
8735 @option{-nolibdld} option can be used to prevent the GCC driver from
8736 adding these link options.
8737
8738 @item -threads
8739 @opindex threads
8740 Add support for multithreading with the @dfn{dce thread} library
8741 under HP-UX@. This option sets flags for both the preprocessor and
8742 linker.
8743 @end table
8744
8745 @node i386 and x86-64 Options
8746 @subsection Intel 386 and AMD x86-64 Options
8747 @cindex i386 Options
8748 @cindex x86-64 Options
8749 @cindex Intel 386 Options
8750 @cindex AMD x86-64 Options
8751
8752 These @samp{-m} options are defined for the i386 and x86-64 family of
8753 computers:
8754
8755 @table @gcctabopt
8756 @item -mtune=@var{cpu-type}
8757 @opindex mtune
8758 Tune to @var{cpu-type} everything applicable about the generated code, except
8759 for the ABI and the set of available instructions. The choices for
8760 @var{cpu-type} are:
8761 @table @emph
8762 @item i386
8763 Original Intel's i386 CPU@.
8764 @item i486
8765 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
8766 @item i586, pentium
8767 Intel Pentium CPU with no MMX support.
8768 @item pentium-mmx
8769 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8770 @item i686, pentiumpro
8771 Intel PentiumPro CPU@.
8772 @item pentium2
8773 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8774 @item pentium3, pentium3m
8775 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8776 support.
8777 @item pentium-m
8778 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8779 support. Used by Centrino notebooks.
8780 @item pentium4, pentium4m
8781 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8782 @item prescott
8783 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8784 set support.
8785 @item nocona
8786 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8787 SSE2 and SSE3 instruction set support.
8788 @item k6
8789 AMD K6 CPU with MMX instruction set support.
8790 @item k6-2, k6-3
8791 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8792 @item athlon, athlon-tbird
8793 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8794 support.
8795 @item athlon-4, athlon-xp, athlon-mp
8796 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8797 instruction set support.
8798 @item k8, opteron, athlon64, athlon-fx
8799 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
8800 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8801 @item winchip-c6
8802 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8803 set support.
8804 @item winchip2
8805 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8806 instruction set support.
8807 @item c3
8808 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
8809 implemented for this chip.)
8810 @item c3-2
8811 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
8812 implemented for this chip.)
8813 @end table
8814
8815 While picking a specific @var{cpu-type} will schedule things appropriately
8816 for that particular chip, the compiler will not generate any code that
8817 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8818 being used.
8819
8820 @item -march=@var{cpu-type}
8821 @opindex march
8822 Generate instructions for the machine type @var{cpu-type}. The choices
8823 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
8824 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8825
8826 @item -mcpu=@var{cpu-type}
8827 @opindex mcpu
8828 A deprecated synonym for @option{-mtune}.
8829
8830 @item -m386
8831 @itemx -m486
8832 @itemx -mpentium
8833 @itemx -mpentiumpro
8834 @opindex m386
8835 @opindex m486
8836 @opindex mpentium
8837 @opindex mpentiumpro
8838 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8839 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8840 These synonyms are deprecated.
8841
8842 @item -mfpmath=@var{unit}
8843 @opindex march
8844 Generate floating point arithmetics for selected unit @var{unit}. The choices
8845 for @var{unit} are:
8846
8847 @table @samp
8848 @item 387
8849 Use the standard 387 floating point coprocessor present majority of chips and
8850 emulated otherwise. Code compiled with this option will run almost everywhere.
8851 The temporary results are computed in 80bit precision instead of precision
8852 specified by the type resulting in slightly different results compared to most
8853 of other chips. See @option{-ffloat-store} for more detailed description.
8854
8855 This is the default choice for i386 compiler.
8856
8857 @item sse
8858 Use scalar floating point instructions present in the SSE instruction set.
8859 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8860 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
8861 instruction set supports only single precision arithmetics, thus the double and
8862 extended precision arithmetics is still done using 387. Later version, present
8863 only in Pentium4 and the future AMD x86-64 chips supports double precision
8864 arithmetics too.
8865
8866 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8867 or @option{-msse2} switches to enable SSE extensions and make this option
8868 effective. For the x86-64 compiler, these extensions are enabled by default.
8869
8870 The resulting code should be considerably faster in the majority of cases and avoid
8871 the numerical instability problems of 387 code, but may break some existing
8872 code that expects temporaries to be 80bit.
8873
8874 This is the default choice for the x86-64 compiler.
8875
8876 @item sse,387
8877 Attempt to utilize both instruction sets at once. This effectively double the
8878 amount of available registers and on chips with separate execution units for
8879 387 and SSE the execution resources too. Use this option with care, as it is
8880 still experimental, because the GCC register allocator does not model separate
8881 functional units well resulting in instable performance.
8882 @end table
8883
8884 @item -masm=@var{dialect}
8885 @opindex masm=@var{dialect}
8886 Output asm instructions using selected @var{dialect}. Supported choices are
8887 @samp{intel} or @samp{att} (the default one).
8888
8889 @item -mieee-fp
8890 @itemx -mno-ieee-fp
8891 @opindex mieee-fp
8892 @opindex mno-ieee-fp
8893 Control whether or not the compiler uses IEEE floating point
8894 comparisons. These handle correctly the case where the result of a
8895 comparison is unordered.
8896
8897 @item -msoft-float
8898 @opindex msoft-float
8899 Generate output containing library calls for floating point.
8900 @strong{Warning:} the requisite libraries are not part of GCC@.
8901 Normally the facilities of the machine's usual C compiler are used, but
8902 this can't be done directly in cross-compilation. You must make your
8903 own arrangements to provide suitable library functions for
8904 cross-compilation.
8905
8906 On machines where a function returns floating point results in the 80387
8907 register stack, some floating point opcodes may be emitted even if
8908 @option{-msoft-float} is used.
8909
8910 @item -mno-fp-ret-in-387
8911 @opindex mno-fp-ret-in-387
8912 Do not use the FPU registers for return values of functions.
8913
8914 The usual calling convention has functions return values of types
8915 @code{float} and @code{double} in an FPU register, even if there
8916 is no FPU@. The idea is that the operating system should emulate
8917 an FPU@.
8918
8919 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8920 in ordinary CPU registers instead.
8921
8922 @item -mno-fancy-math-387
8923 @opindex mno-fancy-math-387
8924 Some 387 emulators do not support the @code{sin}, @code{cos} and
8925 @code{sqrt} instructions for the 387. Specify this option to avoid
8926 generating those instructions. This option is the default on FreeBSD,
8927 OpenBSD and NetBSD@. This option is overridden when @option{-march}
8928 indicates that the target cpu will always have an FPU and so the
8929 instruction will not need emulation. As of revision 2.6.1, these
8930 instructions are not generated unless you also use the
8931 @option{-funsafe-math-optimizations} switch.
8932
8933 @item -malign-double
8934 @itemx -mno-align-double
8935 @opindex malign-double
8936 @opindex mno-align-double
8937 Control whether GCC aligns @code{double}, @code{long double}, and
8938 @code{long long} variables on a two word boundary or a one word
8939 boundary. Aligning @code{double} variables on a two word boundary will
8940 produce code that runs somewhat faster on a @samp{Pentium} at the
8941 expense of more memory.
8942
8943 @strong{Warning:} if you use the @option{-malign-double} switch,
8944 structures containing the above types will be aligned differently than
8945 the published application binary interface specifications for the 386
8946 and will not be binary compatible with structures in code compiled
8947 without that switch.
8948
8949 @item -m96bit-long-double
8950 @itemx -m128bit-long-double
8951 @opindex m96bit-long-double
8952 @opindex m128bit-long-double
8953 These switches control the size of @code{long double} type. The i386
8954 application binary interface specifies the size to be 96 bits,
8955 so @option{-m96bit-long-double} is the default in 32 bit mode.
8956
8957 Modern architectures (Pentium and newer) would prefer @code{long double}
8958 to be aligned to an 8 or 16 byte boundary. In arrays or structures
8959 conforming to the ABI, this would not be possible. So specifying a
8960 @option{-m128bit-long-double} will align @code{long double}
8961 to a 16 byte boundary by padding the @code{long double} with an additional
8962 32 bit zero.
8963
8964 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8965 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8966
8967 Notice that neither of these options enable any extra precision over the x87
8968 standard of 80 bits for a @code{long double}.
8969
8970 @strong{Warning:} if you override the default value for your target ABI, the
8971 structures and arrays containing @code{long double} variables will change
8972 their size as well as function calling convention for function taking
8973 @code{long double} will be modified. Hence they will not be binary
8974 compatible with arrays or structures in code compiled without that switch.
8975
8976
8977 @item -msvr3-shlib
8978 @itemx -mno-svr3-shlib
8979 @opindex msvr3-shlib
8980 @opindex mno-svr3-shlib
8981 Control whether GCC places uninitialized local variables into the
8982 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
8983 into @code{bss}. These options are meaningful only on System V Release 3.
8984
8985 @item -mrtd
8986 @opindex mrtd
8987 Use a different function-calling convention, in which functions that
8988 take a fixed number of arguments return with the @code{ret} @var{num}
8989 instruction, which pops their arguments while returning. This saves one
8990 instruction in the caller since there is no need to pop the arguments
8991 there.
8992
8993 You can specify that an individual function is called with this calling
8994 sequence with the function attribute @samp{stdcall}. You can also
8995 override the @option{-mrtd} option by using the function attribute
8996 @samp{cdecl}. @xref{Function Attributes}.
8997
8998 @strong{Warning:} this calling convention is incompatible with the one
8999 normally used on Unix, so you cannot use it if you need to call
9000 libraries compiled with the Unix compiler.
9001
9002 Also, you must provide function prototypes for all functions that
9003 take variable numbers of arguments (including @code{printf});
9004 otherwise incorrect code will be generated for calls to those
9005 functions.
9006
9007 In addition, seriously incorrect code will result if you call a
9008 function with too many arguments. (Normally, extra arguments are
9009 harmlessly ignored.)
9010
9011 @item -mregparm=@var{num}
9012 @opindex mregparm
9013 Control how many registers are used to pass integer arguments. By
9014 default, no registers are used to pass arguments, and at most 3
9015 registers can be used. You can control this behavior for a specific
9016 function by using the function attribute @samp{regparm}.
9017 @xref{Function Attributes}.
9018
9019 @strong{Warning:} if you use this switch, and
9020 @var{num} is nonzero, then you must build all modules with the same
9021 value, including any libraries. This includes the system libraries and
9022 startup modules.
9023
9024 @item -mpreferred-stack-boundary=@var{num}
9025 @opindex mpreferred-stack-boundary
9026 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
9027 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
9028 the default is 4 (16 bytes or 128 bits), except when optimizing for code
9029 size (@option{-Os}), in which case the default is the minimum correct
9030 alignment (4 bytes for x86, and 8 bytes for x86-64).
9031
9032 On Pentium and PentiumPro, @code{double} and @code{long double} values
9033 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
9034 suffer significant run time performance penalties. On Pentium III, the
9035 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
9036 penalties if it is not 16 byte aligned.
9037
9038 To ensure proper alignment of this values on the stack, the stack boundary
9039 must be as aligned as that required by any value stored on the stack.
9040 Further, every function must be generated such that it keeps the stack
9041 aligned. Thus calling a function compiled with a higher preferred
9042 stack boundary from a function compiled with a lower preferred stack
9043 boundary will most likely misalign the stack. It is recommended that
9044 libraries that use callbacks always use the default setting.
9045
9046 This extra alignment does consume extra stack space, and generally
9047 increases code size. Code that is sensitive to stack space usage, such
9048 as embedded systems and operating system kernels, may want to reduce the
9049 preferred alignment to @option{-mpreferred-stack-boundary=2}.
9050
9051 @item -mmmx
9052 @itemx -mno-mmx
9053 @item -msse
9054 @itemx -mno-sse
9055 @item -msse2
9056 @itemx -mno-sse2
9057 @item -msse3
9058 @itemx -mno-sse3
9059 @item -m3dnow
9060 @itemx -mno-3dnow
9061 @opindex mmmx
9062 @opindex mno-mmx
9063 @opindex msse
9064 @opindex mno-sse
9065 @opindex m3dnow
9066 @opindex mno-3dnow
9067 These switches enable or disable the use of built-in functions that allow
9068 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
9069 instruction set.
9070
9071 @xref{X86 Built-in Functions}, for details of the functions enabled
9072 and disabled by these switches.
9073
9074 To have SSE/SSE2 instructions generated automatically from floating-point
9075 code, see @option{-mfpmath=sse}.
9076
9077 @item -mpush-args
9078 @itemx -mno-push-args
9079 @opindex mpush-args
9080 @opindex mno-push-args
9081 Use PUSH operations to store outgoing parameters. This method is shorter
9082 and usually equally fast as method using SUB/MOV operations and is enabled
9083 by default. In some cases disabling it may improve performance because of
9084 improved scheduling and reduced dependencies.
9085
9086 @item -maccumulate-outgoing-args
9087 @opindex maccumulate-outgoing-args
9088 If enabled, the maximum amount of space required for outgoing arguments will be
9089 computed in the function prologue. This is faster on most modern CPUs
9090 because of reduced dependencies, improved scheduling and reduced stack usage
9091 when preferred stack boundary is not equal to 2. The drawback is a notable
9092 increase in code size. This switch implies @option{-mno-push-args}.
9093
9094 @item -mthreads
9095 @opindex mthreads
9096 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
9097 on thread-safe exception handling must compile and link all code with the
9098 @option{-mthreads} option. When compiling, @option{-mthreads} defines
9099 @option{-D_MT}; when linking, it links in a special thread helper library
9100 @option{-lmingwthrd} which cleans up per thread exception handling data.
9101
9102 @item -mno-align-stringops
9103 @opindex mno-align-stringops
9104 Do not align destination of inlined string operations. This switch reduces
9105 code size and improves performance in case the destination is already aligned,
9106 but GCC doesn't know about it.
9107
9108 @item -minline-all-stringops
9109 @opindex minline-all-stringops
9110 By default GCC inlines string operations only when destination is known to be
9111 aligned at least to 4 byte boundary. This enables more inlining, increase code
9112 size, but may improve performance of code that depends on fast memcpy, strlen
9113 and memset for short lengths.
9114
9115 @item -momit-leaf-frame-pointer
9116 @opindex momit-leaf-frame-pointer
9117 Don't keep the frame pointer in a register for leaf functions. This
9118 avoids the instructions to save, set up and restore frame pointers and
9119 makes an extra register available in leaf functions. The option
9120 @option{-fomit-frame-pointer} removes the frame pointer for all functions
9121 which might make debugging harder.
9122
9123 @item -mtls-direct-seg-refs
9124 @itemx -mno-tls-direct-seg-refs
9125 @opindex mtls-direct-seg-refs
9126 Controls whether TLS variables may be accessed with offsets from the
9127 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
9128 or whether the thread base pointer must be added. Whether or not this
9129 is legal depends on the operating system, and whether it maps the
9130 segment to cover the entire TLS area.
9131
9132 For systems that use GNU libc, the default is on.
9133 @end table
9134
9135 These @samp{-m} switches are supported in addition to the above
9136 on AMD x86-64 processors in 64-bit environments.
9137
9138 @table @gcctabopt
9139 @item -m32
9140 @itemx -m64
9141 @opindex m32
9142 @opindex m64
9143 Generate code for a 32-bit or 64-bit environment.
9144 The 32-bit environment sets int, long and pointer to 32 bits and
9145 generates code that runs on any i386 system.
9146 The 64-bit environment sets int to 32 bits and long and pointer
9147 to 64 bits and generates code for AMD's x86-64 architecture.
9148
9149 @item -mno-red-zone
9150 @opindex no-red-zone
9151 Do not use a so called red zone for x86-64 code. The red zone is mandated
9152 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9153 stack pointer that will not be modified by signal or interrupt handlers
9154 and therefore can be used for temporary data without adjusting the stack
9155 pointer. The flag @option{-mno-red-zone} disables this red zone.
9156
9157 @item -mcmodel=small
9158 @opindex mcmodel=small
9159 Generate code for the small code model: the program and its symbols must
9160 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9161 Programs can be statically or dynamically linked. This is the default
9162 code model.
9163
9164 @item -mcmodel=kernel
9165 @opindex mcmodel=kernel
9166 Generate code for the kernel code model. The kernel runs in the
9167 negative 2 GB of the address space.
9168 This model has to be used for Linux kernel code.
9169
9170 @item -mcmodel=medium
9171 @opindex mcmodel=medium
9172 Generate code for the medium model: The program is linked in the lower 2
9173 GB of the address space but symbols can be located anywhere in the
9174 address space. Programs can be statically or dynamically linked, but
9175 building of shared libraries are not supported with the medium model.
9176
9177 @item -mcmodel=large
9178 @opindex mcmodel=large
9179 Generate code for the large model: This model makes no assumptions
9180 about addresses and sizes of sections. Currently GCC does not implement
9181 this model.
9182 @end table
9183
9184 @node IA-64 Options
9185 @subsection IA-64 Options
9186 @cindex IA-64 Options
9187
9188 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9189
9190 @table @gcctabopt
9191 @item -mbig-endian
9192 @opindex mbig-endian
9193 Generate code for a big endian target. This is the default for HP-UX@.
9194
9195 @item -mlittle-endian
9196 @opindex mlittle-endian
9197 Generate code for a little endian target. This is the default for AIX5
9198 and GNU/Linux.
9199
9200 @item -mgnu-as
9201 @itemx -mno-gnu-as
9202 @opindex mgnu-as
9203 @opindex mno-gnu-as
9204 Generate (or don't) code for the GNU assembler. This is the default.
9205 @c Also, this is the default if the configure option @option{--with-gnu-as}
9206 @c is used.
9207
9208 @item -mgnu-ld
9209 @itemx -mno-gnu-ld
9210 @opindex mgnu-ld
9211 @opindex mno-gnu-ld
9212 Generate (or don't) code for the GNU linker. This is the default.
9213 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9214 @c is used.
9215
9216 @item -mno-pic
9217 @opindex mno-pic
9218 Generate code that does not use a global pointer register. The result
9219 is not position independent code, and violates the IA-64 ABI@.
9220
9221 @item -mvolatile-asm-stop
9222 @itemx -mno-volatile-asm-stop
9223 @opindex mvolatile-asm-stop
9224 @opindex mno-volatile-asm-stop
9225 Generate (or don't) a stop bit immediately before and after volatile asm
9226 statements.
9227
9228 @item -mregister-names
9229 @itemx -mno-register-names
9230 @opindex mregister-names
9231 @opindex mno-register-names
9232 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9233 the stacked registers. This may make assembler output more readable.
9234
9235 @item -mno-sdata
9236 @itemx -msdata
9237 @opindex mno-sdata
9238 @opindex msdata
9239 Disable (or enable) optimizations that use the small data section. This may
9240 be useful for working around optimizer bugs.
9241
9242 @item -mconstant-gp
9243 @opindex mconstant-gp
9244 Generate code that uses a single constant global pointer value. This is
9245 useful when compiling kernel code.
9246
9247 @item -mauto-pic
9248 @opindex mauto-pic
9249 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9250 This is useful when compiling firmware code.
9251
9252 @item -minline-float-divide-min-latency
9253 @opindex minline-float-divide-min-latency
9254 Generate code for inline divides of floating point values
9255 using the minimum latency algorithm.
9256
9257 @item -minline-float-divide-max-throughput
9258 @opindex minline-float-divide-max-throughput
9259 Generate code for inline divides of floating point values
9260 using the maximum throughput algorithm.
9261
9262 @item -minline-int-divide-min-latency
9263 @opindex minline-int-divide-min-latency
9264 Generate code for inline divides of integer values
9265 using the minimum latency algorithm.
9266
9267 @item -minline-int-divide-max-throughput
9268 @opindex minline-int-divide-max-throughput
9269 Generate code for inline divides of integer values
9270 using the maximum throughput algorithm.
9271
9272 @item -minline-sqrt-min-latency
9273 @opindex minline-sqrt-min-latency
9274 Generate code for inline square roots
9275 using the minimum latency algorithm.
9276
9277 @item -minline-sqrt-max-throughput
9278 @opindex minline-sqrt-max-throughput
9279 Generate code for inline square roots
9280 using the maximum throughput algorithm.
9281
9282 @item -mno-dwarf2-asm
9283 @itemx -mdwarf2-asm
9284 @opindex mno-dwarf2-asm
9285 @opindex mdwarf2-asm
9286 Don't (or do) generate assembler code for the DWARF2 line number debugging
9287 info. This may be useful when not using the GNU assembler.
9288
9289 @item -mearly-stop-bits
9290 @itemx -mno-early-stop-bits
9291 @opindex mearly-stop-bits
9292 @opindex mno-early-stop-bits
9293 Allow stop bits to be placed earlier than immediately preceding the
9294 instruction that triggered the stop bit. This can improve instruction
9295 scheduling, but does not always do so.
9296
9297 @item -mfixed-range=@var{register-range}
9298 @opindex mfixed-range
9299 Generate code treating the given register range as fixed registers.
9300 A fixed register is one that the register allocator can not use. This is
9301 useful when compiling kernel code. A register range is specified as
9302 two registers separated by a dash. Multiple register ranges can be
9303 specified separated by a comma.
9304
9305 @item -mtls-size=@var{tls-size}
9306 @opindex mtls-size
9307 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
9308 64.
9309
9310 @item -mtune-arch=@var{cpu-type}
9311 @opindex mtune-arch
9312 Tune the instruction scheduling for a particular CPU, Valid values are
9313 itanium, itanium1, merced, itanium2, and mckinley.
9314
9315 @item -mt
9316 @itemx -pthread
9317 @opindex mt
9318 @opindex pthread
9319 Add support for multithreading using the POSIX threads library. This
9320 option sets flags for both the preprocessor and linker. It does
9321 not affect the thread safety of object code produced by the compiler or
9322 that of libraries supplied with it. These are HP-UX specific flags.
9323
9324 @item -milp32
9325 @itemx -mlp64
9326 @opindex milp32
9327 @opindex mlp64
9328 Generate code for a 32-bit or 64-bit environment.
9329 The 32-bit environment sets int, long and pointer to 32 bits.
9330 The 64-bit environment sets int to 32 bits and long and pointer
9331 to 64 bits. These are HP-UX specific flags.
9332
9333 @end table
9334
9335 @node M32R/D Options
9336 @subsection M32R/D Options
9337 @cindex M32R/D options
9338
9339 These @option{-m} options are defined for Renesas M32R/D architectures:
9340
9341 @table @gcctabopt
9342 @item -m32r2
9343 @opindex m32r2
9344 Generate code for the M32R/2@.
9345
9346 @item -m32rx
9347 @opindex m32rx
9348 Generate code for the M32R/X@.
9349
9350 @item -m32r
9351 @opindex m32r
9352 Generate code for the M32R@. This is the default.
9353
9354 @item -mmodel=small
9355 @opindex mmodel=small
9356 Assume all objects live in the lower 16MB of memory (so that their addresses
9357 can be loaded with the @code{ld24} instruction), and assume all subroutines
9358 are reachable with the @code{bl} instruction.
9359 This is the default.
9360
9361 The addressability of a particular object can be set with the
9362 @code{model} attribute.
9363
9364 @item -mmodel=medium
9365 @opindex mmodel=medium
9366 Assume objects may be anywhere in the 32-bit address space (the compiler
9367 will generate @code{seth/add3} instructions to load their addresses), and
9368 assume all subroutines are reachable with the @code{bl} instruction.
9369
9370 @item -mmodel=large
9371 @opindex mmodel=large
9372 Assume objects may be anywhere in the 32-bit address space (the compiler
9373 will generate @code{seth/add3} instructions to load their addresses), and
9374 assume subroutines may not be reachable with the @code{bl} instruction
9375 (the compiler will generate the much slower @code{seth/add3/jl}
9376 instruction sequence).
9377
9378 @item -msdata=none
9379 @opindex msdata=none
9380 Disable use of the small data area. Variables will be put into
9381 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9382 @code{section} attribute has been specified).
9383 This is the default.
9384
9385 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9386 Objects may be explicitly put in the small data area with the
9387 @code{section} attribute using one of these sections.
9388
9389 @item -msdata=sdata
9390 @opindex msdata=sdata
9391 Put small global and static data in the small data area, but do not
9392 generate special code to reference them.
9393
9394 @item -msdata=use
9395 @opindex msdata=use
9396 Put small global and static data in the small data area, and generate
9397 special instructions to reference them.
9398
9399 @item -G @var{num}
9400 @opindex G
9401 @cindex smaller data references
9402 Put global and static objects less than or equal to @var{num} bytes
9403 into the small data or bss sections instead of the normal data or bss
9404 sections. The default value of @var{num} is 8.
9405 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9406 for this option to have any effect.
9407
9408 All modules should be compiled with the same @option{-G @var{num}} value.
9409 Compiling with different values of @var{num} may or may not work; if it
9410 doesn't the linker will give an error message---incorrect code will not be
9411 generated.
9412
9413 @item -mdebug
9414 @opindex mdebug
9415 Makes the M32R specific code in the compiler display some statistics
9416 that might help in debugging programs.
9417
9418 @item -malign-loops
9419 @opindex malign-loops
9420 Align all loops to a 32-byte boundary.
9421
9422 @item -mno-align-loops
9423 @opindex mno-align-loops
9424 Do not enforce a 32-byte alignment for loops. This is the default.
9425
9426 @item -missue-rate=@var{number}
9427 @opindex missue-rate=@var{number}
9428 Issue @var{number} instructions per cycle. @var{number} can only be 1
9429 or 2.
9430
9431 @item -mbranch-cost=@var{number}
9432 @opindex mbranch-cost=@var{number}
9433 @var{number} can only be 1 or 2. If it is 1 then branches will be
9434 preferred over conditional code, if it is 2, then the opposite will
9435 apply.
9436
9437 @item -mflush-trap=@var{number}
9438 @opindex mflush-trap=@var{number}
9439 Specifies the trap number to use to flush the cache. The default is
9440 12. Valid numbers are between 0 and 15 inclusive.
9441
9442 @item -mno-flush-trap
9443 @opindex mno-flush-trap
9444 Specifies that the cache cannot be flushed by using a trap.
9445
9446 @item -mflush-func=@var{name}
9447 @opindex mflush-func=@var{name}
9448 Specifies the name of the operating system function to call to flush
9449 the cache. The default is @emph{_flush_cache}, but a function call
9450 will only be used if a trap is not available.
9451
9452 @item -mno-flush-func
9453 @opindex mno-flush-func
9454 Indicates that there is no OS function for flushing the cache.
9455
9456 @end table
9457
9458 @node M680x0 Options
9459 @subsection M680x0 Options
9460 @cindex M680x0 options
9461
9462 These are the @samp{-m} options defined for the 68000 series. The default
9463 values for these options depends on which style of 68000 was selected when
9464 the compiler was configured; the defaults for the most common choices are
9465 given below.
9466
9467 @table @gcctabopt
9468 @item -m68000
9469 @itemx -mc68000
9470 @opindex m68000
9471 @opindex mc68000
9472 Generate output for a 68000. This is the default
9473 when the compiler is configured for 68000-based systems.
9474
9475 Use this option for microcontrollers with a 68000 or EC000 core,
9476 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9477
9478 @item -m68020
9479 @itemx -mc68020
9480 @opindex m68020
9481 @opindex mc68020
9482 Generate output for a 68020. This is the default
9483 when the compiler is configured for 68020-based systems.
9484
9485 @item -m68881
9486 @opindex m68881
9487 Generate output containing 68881 instructions for floating point.
9488 This is the default for most 68020 systems unless @option{--nfp} was
9489 specified when the compiler was configured.
9490
9491 @item -m68030
9492 @opindex m68030
9493 Generate output for a 68030. This is the default when the compiler is
9494 configured for 68030-based systems.
9495
9496 @item -m68040
9497 @opindex m68040
9498 Generate output for a 68040. This is the default when the compiler is
9499 configured for 68040-based systems.
9500
9501 This option inhibits the use of 68881/68882 instructions that have to be
9502 emulated by software on the 68040. Use this option if your 68040 does not
9503 have code to emulate those instructions.
9504
9505 @item -m68060
9506 @opindex m68060
9507 Generate output for a 68060. This is the default when the compiler is
9508 configured for 68060-based systems.
9509
9510 This option inhibits the use of 68020 and 68881/68882 instructions that
9511 have to be emulated by software on the 68060. Use this option if your 68060
9512 does not have code to emulate those instructions.
9513
9514 @item -mcpu32
9515 @opindex mcpu32
9516 Generate output for a CPU32. This is the default
9517 when the compiler is configured for CPU32-based systems.
9518
9519 Use this option for microcontrollers with a
9520 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9521 68336, 68340, 68341, 68349 and 68360.
9522
9523 @item -m5200
9524 @opindex m5200
9525 Generate output for a 520X ``coldfire'' family cpu. This is the default
9526 when the compiler is configured for 520X-based systems.
9527
9528 Use this option for microcontroller with a 5200 core, including
9529 the MCF5202, MCF5203, MCF5204 and MCF5202.
9530
9531
9532 @item -m68020-40
9533 @opindex m68020-40
9534 Generate output for a 68040, without using any of the new instructions.
9535 This results in code which can run relatively efficiently on either a
9536 68020/68881 or a 68030 or a 68040. The generated code does use the
9537 68881 instructions that are emulated on the 68040.
9538
9539 @item -m68020-60
9540 @opindex m68020-60
9541 Generate output for a 68060, without using any of the new instructions.
9542 This results in code which can run relatively efficiently on either a
9543 68020/68881 or a 68030 or a 68040. The generated code does use the
9544 68881 instructions that are emulated on the 68060.
9545
9546 @item -msoft-float
9547 @opindex msoft-float
9548 Generate output containing library calls for floating point.
9549 @strong{Warning:} the requisite libraries are not available for all m68k
9550 targets. Normally the facilities of the machine's usual C compiler are
9551 used, but this can't be done directly in cross-compilation. You must
9552 make your own arrangements to provide suitable library functions for
9553 cross-compilation. The embedded targets @samp{m68k-*-aout} and
9554 @samp{m68k-*-coff} do provide software floating point support.
9555
9556 @item -mshort
9557 @opindex mshort
9558 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9559 Additionally, parameters passed on the stack are also aligned to a
9560 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9561
9562 @item -mnobitfield
9563 @opindex mnobitfield
9564 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9565 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9566
9567 @item -mbitfield
9568 @opindex mbitfield
9569 Do use the bit-field instructions. The @option{-m68020} option implies
9570 @option{-mbitfield}. This is the default if you use a configuration
9571 designed for a 68020.
9572
9573 @item -mrtd
9574 @opindex mrtd
9575 Use a different function-calling convention, in which functions
9576 that take a fixed number of arguments return with the @code{rtd}
9577 instruction, which pops their arguments while returning. This
9578 saves one instruction in the caller since there is no need to pop
9579 the arguments there.
9580
9581 This calling convention is incompatible with the one normally
9582 used on Unix, so you cannot use it if you need to call libraries
9583 compiled with the Unix compiler.
9584
9585 Also, you must provide function prototypes for all functions that
9586 take variable numbers of arguments (including @code{printf});
9587 otherwise incorrect code will be generated for calls to those
9588 functions.
9589
9590 In addition, seriously incorrect code will result if you call a
9591 function with too many arguments. (Normally, extra arguments are
9592 harmlessly ignored.)
9593
9594 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9595 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9596
9597 @item -malign-int
9598 @itemx -mno-align-int
9599 @opindex malign-int
9600 @opindex mno-align-int
9601 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9602 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9603 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9604 Aligning variables on 32-bit boundaries produces code that runs somewhat
9605 faster on processors with 32-bit busses at the expense of more memory.
9606
9607 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9608 align structures containing the above types differently than
9609 most published application binary interface specifications for the m68k.
9610
9611 @item -mpcrel
9612 @opindex mpcrel
9613 Use the pc-relative addressing mode of the 68000 directly, instead of
9614 using a global offset table. At present, this option implies @option{-fpic},
9615 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
9616 not presently supported with @option{-mpcrel}, though this could be supported for
9617 68020 and higher processors.
9618
9619 @item -mno-strict-align
9620 @itemx -mstrict-align
9621 @opindex mno-strict-align
9622 @opindex mstrict-align
9623 Do not (do) assume that unaligned memory references will be handled by
9624 the system.
9625
9626 @item -msep-data
9627 Generate code that allows the data segment to be located in a different
9628 area of memory from the text segment. This allows for execute in place in
9629 an environment without virtual memory management. This option implies
9630 @option{-fPIC}.
9631
9632 @item -mno-sep-data
9633 Generate code that assumes that the data segment follows the text segment.
9634 This is the default.
9635
9636 @item -mid-shared-library
9637 Generate code that supports shared libraries via the library ID method.
9638 This allows for execute in place and shared libraries in an environment
9639 without virtual memory management. This option implies @option{-fPIC}.
9640
9641 @item -mno-id-shared-library
9642 Generate code that doesn't assume ID based shared libraries are being used.
9643 This is the default.
9644
9645 @item -mshared-library-id=n
9646 Specified the identification number of the ID based shared library being
9647 compiled. Specifying a value of 0 will generate more compact code, specifying
9648 other values will force the allocation of that number to the current
9649 library but is no more space or time efficient than omitting this option.
9650
9651 @end table
9652
9653 @node M68hc1x Options
9654 @subsection M68hc1x Options
9655 @cindex M68hc1x options
9656
9657 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9658 microcontrollers. The default values for these options depends on
9659 which style of microcontroller was selected when the compiler was configured;
9660 the defaults for the most common choices are given below.
9661
9662 @table @gcctabopt
9663 @item -m6811
9664 @itemx -m68hc11
9665 @opindex m6811
9666 @opindex m68hc11
9667 Generate output for a 68HC11. This is the default
9668 when the compiler is configured for 68HC11-based systems.
9669
9670 @item -m6812
9671 @itemx -m68hc12
9672 @opindex m6812
9673 @opindex m68hc12
9674 Generate output for a 68HC12. This is the default
9675 when the compiler is configured for 68HC12-based systems.
9676
9677 @item -m68S12
9678 @itemx -m68hcs12
9679 @opindex m68S12
9680 @opindex m68hcs12
9681 Generate output for a 68HCS12.
9682
9683 @item -mauto-incdec
9684 @opindex mauto-incdec
9685 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9686 addressing modes.
9687
9688 @item -minmax
9689 @itemx -nominmax
9690 @opindex minmax
9691 @opindex mnominmax
9692 Enable the use of 68HC12 min and max instructions.
9693
9694 @item -mlong-calls
9695 @itemx -mno-long-calls
9696 @opindex mlong-calls
9697 @opindex mno-long-calls
9698 Treat all calls as being far away (near). If calls are assumed to be
9699 far away, the compiler will use the @code{call} instruction to
9700 call a function and the @code{rtc} instruction for returning.
9701
9702 @item -mshort
9703 @opindex mshort
9704 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9705
9706 @item -msoft-reg-count=@var{count}
9707 @opindex msoft-reg-count
9708 Specify the number of pseudo-soft registers which are used for the
9709 code generation. The maximum number is 32. Using more pseudo-soft
9710 register may or may not result in better code depending on the program.
9711 The default is 4 for 68HC11 and 2 for 68HC12.
9712
9713 @end table
9714
9715 @node MCore Options
9716 @subsection MCore Options
9717 @cindex MCore options
9718
9719 These are the @samp{-m} options defined for the Motorola M*Core
9720 processors.
9721
9722 @table @gcctabopt
9723
9724 @item -mhardlit
9725 @itemx -mno-hardlit
9726 @opindex mhardlit
9727 @opindex mno-hardlit
9728 Inline constants into the code stream if it can be done in two
9729 instructions or less.
9730
9731 @item -mdiv
9732 @itemx -mno-div
9733 @opindex mdiv
9734 @opindex mno-div
9735 Use the divide instruction. (Enabled by default).
9736
9737 @item -mrelax-immediate
9738 @itemx -mno-relax-immediate
9739 @opindex mrelax-immediate
9740 @opindex mno-relax-immediate
9741 Allow arbitrary sized immediates in bit operations.
9742
9743 @item -mwide-bitfields
9744 @itemx -mno-wide-bitfields
9745 @opindex mwide-bitfields
9746 @opindex mno-wide-bitfields
9747 Always treat bit-fields as int-sized.
9748
9749 @item -m4byte-functions
9750 @itemx -mno-4byte-functions
9751 @opindex m4byte-functions
9752 @opindex mno-4byte-functions
9753 Force all functions to be aligned to a four byte boundary.
9754
9755 @item -mcallgraph-data
9756 @itemx -mno-callgraph-data
9757 @opindex mcallgraph-data
9758 @opindex mno-callgraph-data
9759 Emit callgraph information.
9760
9761 @item -mslow-bytes
9762 @itemx -mno-slow-bytes
9763 @opindex mslow-bytes
9764 @opindex mno-slow-bytes
9765 Prefer word access when reading byte quantities.
9766
9767 @item -mlittle-endian
9768 @itemx -mbig-endian
9769 @opindex mlittle-endian
9770 @opindex mbig-endian
9771 Generate code for a little endian target.
9772
9773 @item -m210
9774 @itemx -m340
9775 @opindex m210
9776 @opindex m340
9777 Generate code for the 210 processor.
9778 @end table
9779
9780 @node MIPS Options
9781 @subsection MIPS Options
9782 @cindex MIPS options
9783
9784 @table @gcctabopt
9785
9786 @item -EB
9787 @opindex EB
9788 Generate big-endian code.
9789
9790 @item -EL
9791 @opindex EL
9792 Generate little-endian code. This is the default for @samp{mips*el-*-*}
9793 configurations.
9794
9795 @item -march=@var{arch}
9796 @opindex march
9797 Generate code that will run on @var{arch}, which can be the name of a
9798 generic MIPS ISA, or the name of a particular processor.
9799 The ISA names are:
9800 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9801 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9802 The processor names are:
9803 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9804 @samp{m4k},
9805 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9806 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9807 @samp{rm9000},
9808 @samp{orion},
9809 @samp{sb1},
9810 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9811 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9812 The special value @samp{from-abi} selects the
9813 most compatible architecture for the selected ABI (that is,
9814 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9815
9816 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9817 (for example, @samp{-march=r2k}). Prefixes are optional, and
9818 @samp{vr} may be written @samp{r}.
9819
9820 GCC defines two macros based on the value of this option. The first
9821 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9822 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
9823 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9824 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9825 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9826
9827 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9828 above. In other words, it will have the full prefix and will not
9829 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
9830 the macro names the resolved architecture (either @samp{"mips1"} or
9831 @samp{"mips3"}). It names the default architecture when no
9832 @option{-march} option is given.
9833
9834 @item -mtune=@var{arch}
9835 @opindex mtune
9836 Optimize for @var{arch}. Among other things, this option controls
9837 the way instructions are scheduled, and the perceived cost of arithmetic
9838 operations. The list of @var{arch} values is the same as for
9839 @option{-march}.
9840
9841 When this option is not used, GCC will optimize for the processor
9842 specified by @option{-march}. By using @option{-march} and
9843 @option{-mtune} together, it is possible to generate code that will
9844 run on a family of processors, but optimize the code for one
9845 particular member of that family.
9846
9847 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9848 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9849 @samp{-march} ones described above.
9850
9851 @item -mips1
9852 @opindex mips1
9853 Equivalent to @samp{-march=mips1}.
9854
9855 @item -mips2
9856 @opindex mips2
9857 Equivalent to @samp{-march=mips2}.
9858
9859 @item -mips3
9860 @opindex mips3
9861 Equivalent to @samp{-march=mips3}.
9862
9863 @item -mips4
9864 @opindex mips4
9865 Equivalent to @samp{-march=mips4}.
9866
9867 @item -mips32
9868 @opindex mips32
9869 Equivalent to @samp{-march=mips32}.
9870
9871 @item -mips32r2
9872 @opindex mips32r2
9873 Equivalent to @samp{-march=mips32r2}.
9874
9875 @item -mips64
9876 @opindex mips64
9877 Equivalent to @samp{-march=mips64}.
9878
9879 @item -mips16
9880 @itemx -mno-mips16
9881 @opindex mips16
9882 @opindex mno-mips16
9883 Generate (do not generate) MIPS16 code. If GCC is targetting a
9884 MIPS32 or MIPS64 architecture, it will make use of the MIPS16e ASE@.
9885
9886 @item -mabi=32
9887 @itemx -mabi=o64
9888 @itemx -mabi=n32
9889 @itemx -mabi=64
9890 @itemx -mabi=eabi
9891 @opindex mabi=32
9892 @opindex mabi=o64
9893 @opindex mabi=n32
9894 @opindex mabi=64
9895 @opindex mabi=eabi
9896 Generate code for the given ABI@.
9897
9898 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
9899 generates 64-bit code when you select a 64-bit architecture, but you
9900 can use @option{-mgp32} to get 32-bit code instead.
9901
9902 For information about the O64 ABI, see
9903 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9904
9905 @item -mabicalls
9906 @itemx -mno-abicalls
9907 @opindex mabicalls
9908 @opindex mno-abicalls
9909 Generate (do not generate) SVR4-style position-independent code.
9910 @option{-mabicalls} is the default for SVR4-based systems.
9911
9912 @item -mxgot
9913 @itemx -mno-xgot
9914 @opindex mxgot
9915 @opindex mno-xgot
9916 Lift (do not lift) the usual restrictions on the size of the global
9917 offset table.
9918
9919 GCC normally uses a single instruction to load values from the GOT@.
9920 While this is relatively efficient, it will only work if the GOT
9921 is smaller than about 64k. Anything larger will cause the linker
9922 to report an error such as:
9923
9924 @cindex relocation truncated to fit (MIPS)
9925 @smallexample
9926 relocation truncated to fit: R_MIPS_GOT16 foobar
9927 @end smallexample
9928
9929 If this happens, you should recompile your code with @option{-mxgot}.
9930 It should then work with very large GOTs, although it will also be
9931 less efficient, since it will take three instructions to fetch the
9932 value of a global symbol.
9933
9934 Note that some linkers can create multiple GOTs. If you have such a
9935 linker, you should only need to use @option{-mxgot} when a single object
9936 file accesses more than 64k's worth of GOT entries. Very few do.
9937
9938 These options have no effect unless GCC is generating position
9939 independent code.
9940
9941 @item -mgp32
9942 @opindex mgp32
9943 Assume that general-purpose registers are 32 bits wide.
9944
9945 @item -mgp64
9946 @opindex mgp64
9947 Assume that general-purpose registers are 64 bits wide.
9948
9949 @item -mfp32
9950 @opindex mfp32
9951 Assume that floating-point registers are 32 bits wide.
9952
9953 @item -mfp64
9954 @opindex mfp64
9955 Assume that floating-point registers are 64 bits wide.
9956
9957 @item -mhard-float
9958 @opindex mhard-float
9959 Use floating-point coprocessor instructions.
9960
9961 @item -msoft-float
9962 @opindex msoft-float
9963 Do not use floating-point coprocessor instructions. Implement
9964 floating-point calculations using library calls instead.
9965
9966 @item -msingle-float
9967 @opindex msingle-float
9968 Assume that the floating-point coprocessor only supports single-precision
9969 operations.
9970
9971 @itemx -mdouble-float
9972 @opindex mdouble-float
9973 Assume that the floating-point coprocessor supports double-precision
9974 operations. This is the default.
9975
9976 @itemx -mpaired-single
9977 @itemx -mno-paired-single
9978 @opindex mpaired-single
9979 @opindex mno-paired-single
9980 Use (do not use) paired-single floating-point instructions.
9981 @xref{MIPS Paired-Single Support}. This option can only be used
9982 when generating 64-bit code and requires hardware floating-point
9983 support to be enabled.
9984
9985 @itemx -mips3d
9986 @itemx -mno-mips3d
9987 @opindex mips3d
9988 @opindex mno-mips3d
9989 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
9990 The option @option{-mips3d} implies @option{-mpaired-single}.
9991
9992 @item -mlong64
9993 @opindex mlong64
9994 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
9995 an explanation of the default and the way that the pointer size is
9996 determined.
9997
9998 @item -mlong32
9999 @opindex mlong32
10000 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
10001
10002 The default size of @code{int}s, @code{long}s and pointers depends on
10003 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
10004 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
10005 32-bit @code{long}s. Pointers are the same size as @code{long}s,
10006 or the same size as integer registers, whichever is smaller.
10007
10008 @item -msym32
10009 @itemx -mno-sym32
10010 @opindex msym32
10011 @opindex mno-sym32
10012 Assume (do not assume) that all symbols have 32-bit values, regardless
10013 of the selected ABI@. This option is useful in combination with
10014 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
10015 to generate shorter and faster references to symbolic addresses.
10016
10017 @item -G @var{num}
10018 @opindex G
10019 @cindex smaller data references (MIPS)
10020 @cindex gp-relative references (MIPS)
10021 Put global and static items less than or equal to @var{num} bytes into
10022 the small data or bss section instead of the normal data or bss section.
10023 This allows the data to be accessed using a single instruction.
10024
10025 All modules should be compiled with the same @option{-G @var{num}}
10026 value.
10027
10028 @item -membedded-data
10029 @itemx -mno-embedded-data
10030 @opindex membedded-data
10031 @opindex mno-embedded-data
10032 Allocate variables to the read-only data section first if possible, then
10033 next in the small data section if possible, otherwise in data. This gives
10034 slightly slower code than the default, but reduces the amount of RAM required
10035 when executing, and thus may be preferred for some embedded systems.
10036
10037 @item -muninit-const-in-rodata
10038 @itemx -mno-uninit-const-in-rodata
10039 @opindex muninit-const-in-rodata
10040 @opindex mno-uninit-const-in-rodata
10041 Put uninitialized @code{const} variables in the read-only data section.
10042 This option is only meaningful in conjunction with @option{-membedded-data}.
10043
10044 @item -msplit-addresses
10045 @itemx -mno-split-addresses
10046 @opindex msplit-addresses
10047 @opindex mno-split-addresses
10048 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
10049 relocation operators. This option has been superseded by
10050 @option{-mexplicit-relocs} but is retained for backwards compatibility.
10051
10052 @item -mexplicit-relocs
10053 @itemx -mno-explicit-relocs
10054 @opindex mexplicit-relocs
10055 @opindex mno-explicit-relocs
10056 Use (do not use) assembler relocation operators when dealing with symbolic
10057 addresses. The alternative, selected by @option{-mno-explicit-relocs},
10058 is to use assembler macros instead.
10059
10060 @option{-mexplicit-relocs} is the default if GCC was configured
10061 to use an assembler that supports relocation operators.
10062
10063 @item -mcheck-zero-division
10064 @itemx -mno-check-zero-division
10065 @opindex mcheck-zero-division
10066 @opindex mno-check-zero-division
10067 Trap (do not trap) on integer division by zero. The default is
10068 @option{-mcheck-zero-division}.
10069
10070 @item -mdivide-traps
10071 @itemx -mdivide-breaks
10072 @opindex mdivide-traps
10073 @opindex mdivide-breaks
10074 MIPS systems check for division by zero by generating either a
10075 conditional trap or a break instruction. Using traps results in
10076 smaller code, but is only supported on MIPS II and later. Also, some
10077 versions of the Linux kernel have a bug that prevents trap from
10078 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
10079 allow conditional traps on architectures that support them and
10080 @option{-mdivide-breaks} to force the use of breaks.
10081
10082 The default is usually @option{-mdivide-traps}, but this can be
10083 overridden at configure time using @option{--with-divide=breaks}.
10084 Divide-by-zero checks can be completely disabled using
10085 @option{-mno-check-zero-division}.
10086
10087 @item -mmemcpy
10088 @itemx -mno-memcpy
10089 @opindex mmemcpy
10090 @opindex mno-memcpy
10091 Force (do not force) the use of @code{memcpy()} for non-trivial block
10092 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
10093 most constant-sized copies.
10094
10095 @item -mlong-calls
10096 @itemx -mno-long-calls
10097 @opindex mlong-calls
10098 @opindex mno-long-calls
10099 Disable (do not disable) use of the @code{jal} instruction. Calling
10100 functions using @code{jal} is more efficient but requires the caller
10101 and callee to be in the same 256 megabyte segment.
10102
10103 This option has no effect on abicalls code. The default is
10104 @option{-mno-long-calls}.
10105
10106 @item -mmad
10107 @itemx -mno-mad
10108 @opindex mmad
10109 @opindex mno-mad
10110 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
10111 instructions, as provided by the R4650 ISA@.
10112
10113 @item -mfused-madd
10114 @itemx -mno-fused-madd
10115 @opindex mfused-madd
10116 @opindex mno-fused-madd
10117 Enable (disable) use of the floating point multiply-accumulate
10118 instructions, when they are available. The default is
10119 @option{-mfused-madd}.
10120
10121 When multiply-accumulate instructions are used, the intermediate
10122 product is calculated to infinite precision and is not subject to
10123 the FCSR Flush to Zero bit. This may be undesirable in some
10124 circumstances.
10125
10126 @item -nocpp
10127 @opindex nocpp
10128 Tell the MIPS assembler to not run its preprocessor over user
10129 assembler files (with a @samp{.s} suffix) when assembling them.
10130
10131 @item -mfix-r4000
10132 @itemx -mno-fix-r4000
10133 @opindex mfix-r4000
10134 @opindex mno-fix-r4000
10135 Work around certain R4000 CPU errata:
10136 @itemize @minus
10137 @item
10138 A double-word or a variable shift may give an incorrect result if executed
10139 immediately after starting an integer division.
10140 @item
10141 A double-word or a variable shift may give an incorrect result if executed
10142 while an integer multiplication is in progress.
10143 @item
10144 An integer division may give an incorrect result if started in a delay slot
10145 of a taken branch or a jump.
10146 @end itemize
10147
10148 @item -mfix-r4400
10149 @itemx -mno-fix-r4400
10150 @opindex mfix-r4400
10151 @opindex mno-fix-r4400
10152 Work around certain R4400 CPU errata:
10153 @itemize @minus
10154 @item
10155 A double-word or a variable shift may give an incorrect result if executed
10156 immediately after starting an integer division.
10157 @end itemize
10158
10159 @item -mfix-vr4120
10160 @itemx -mno-fix-vr4120
10161 @opindex mfix-vr4120
10162 Work around certain VR4120 errata:
10163 @itemize @minus
10164 @item
10165 @code{dmultu} does not always produce the correct result.
10166 @item
10167 @code{div} and @code{ddiv} do not always produce the correct result if one
10168 of the operands is negative.
10169 @end itemize
10170 The workarounds for the division errata rely on special functions in
10171 @file{libgcc.a}. At present, these functions are only provided by
10172 the @code{mips64vr*-elf} configurations.
10173
10174 Other VR4120 errata require a nop to be inserted between certain pairs of
10175 instructions. These errata are handled by the assembler, not by GCC itself.
10176
10177 @item -mfix-vr4130
10178 @opindex mfix-vr4130
10179 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
10180 workarounds are implemented by the assembler rather than by GCC,
10181 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10182 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10183 instructions are available instead.
10184
10185 @item -mfix-sb1
10186 @itemx -mno-fix-sb1
10187 @opindex mfix-sb1
10188 Work around certain SB-1 CPU core errata.
10189 (This flag currently works around the SB-1 revision 2
10190 ``F1'' and ``F2'' floating point errata.)
10191
10192 @item -mflush-func=@var{func}
10193 @itemx -mno-flush-func
10194 @opindex mflush-func
10195 Specifies the function to call to flush the I and D caches, or to not
10196 call any such function. If called, the function must take the same
10197 arguments as the common @code{_flush_func()}, that is, the address of the
10198 memory range for which the cache is being flushed, the size of the
10199 memory range, and the number 3 (to flush both caches). The default
10200 depends on the target GCC was configured for, but commonly is either
10201 @samp{_flush_func} or @samp{__cpu_flush}.
10202
10203 @item -mbranch-likely
10204 @itemx -mno-branch-likely
10205 @opindex mbranch-likely
10206 @opindex mno-branch-likely
10207 Enable or disable use of Branch Likely instructions, regardless of the
10208 default for the selected architecture. By default, Branch Likely
10209 instructions may be generated if they are supported by the selected
10210 architecture. An exception is for the MIPS32 and MIPS64 architectures
10211 and processors which implement those architectures; for those, Branch
10212 Likely instructions will not be generated by default because the MIPS32
10213 and MIPS64 architectures specifically deprecate their use.
10214
10215 @item -mfp-exceptions
10216 @itemx -mno-fp-exceptions
10217 @opindex mfp-exceptions
10218 Specifies whether FP exceptions are enabled. This affects how we schedule
10219 FP instructions for some processors. The default is that FP exceptions are
10220 enabled.
10221
10222 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10223 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
10224 FP pipe.
10225
10226 @item -mvr4130-align
10227 @itemx -mno-vr4130-align
10228 @opindex mvr4130-align
10229 The VR4130 pipeline is two-way superscalar, but can only issue two
10230 instructions together if the first one is 8-byte aligned. When this
10231 option is enabled, GCC will align pairs of instructions that it
10232 thinks should execute in parallel.
10233
10234 This option only has an effect when optimizing for the VR4130.
10235 It normally makes code faster, but at the expense of making it bigger.
10236 It is enabled by default at optimization level @option{-O3}.
10237 @end table
10238
10239 @node MMIX Options
10240 @subsection MMIX Options
10241 @cindex MMIX Options
10242
10243 These options are defined for the MMIX:
10244
10245 @table @gcctabopt
10246 @item -mlibfuncs
10247 @itemx -mno-libfuncs
10248 @opindex mlibfuncs
10249 @opindex mno-libfuncs
10250 Specify that intrinsic library functions are being compiled, passing all
10251 values in registers, no matter the size.
10252
10253 @item -mepsilon
10254 @itemx -mno-epsilon
10255 @opindex mepsilon
10256 @opindex mno-epsilon
10257 Generate floating-point comparison instructions that compare with respect
10258 to the @code{rE} epsilon register.
10259
10260 @item -mabi=mmixware
10261 @itemx -mabi=gnu
10262 @opindex mabi-mmixware
10263 @opindex mabi=gnu
10264 Generate code that passes function parameters and return values that (in
10265 the called function) are seen as registers @code{$0} and up, as opposed to
10266 the GNU ABI which uses global registers @code{$231} and up.
10267
10268 @item -mzero-extend
10269 @itemx -mno-zero-extend
10270 @opindex mzero-extend
10271 @opindex mno-zero-extend
10272 When reading data from memory in sizes shorter than 64 bits, use (do not
10273 use) zero-extending load instructions by default, rather than
10274 sign-extending ones.
10275
10276 @item -mknuthdiv
10277 @itemx -mno-knuthdiv
10278 @opindex mknuthdiv
10279 @opindex mno-knuthdiv
10280 Make the result of a division yielding a remainder have the same sign as
10281 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10282 remainder follows the sign of the dividend. Both methods are
10283 arithmetically valid, the latter being almost exclusively used.
10284
10285 @item -mtoplevel-symbols
10286 @itemx -mno-toplevel-symbols
10287 @opindex mtoplevel-symbols
10288 @opindex mno-toplevel-symbols
10289 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10290 code can be used with the @code{PREFIX} assembly directive.
10291
10292 @item -melf
10293 @opindex melf
10294 Generate an executable in the ELF format, rather than the default
10295 @samp{mmo} format used by the @command{mmix} simulator.
10296
10297 @item -mbranch-predict
10298 @itemx -mno-branch-predict
10299 @opindex mbranch-predict
10300 @opindex mno-branch-predict
10301 Use (do not use) the probable-branch instructions, when static branch
10302 prediction indicates a probable branch.
10303
10304 @item -mbase-addresses
10305 @itemx -mno-base-addresses
10306 @opindex mbase-addresses
10307 @opindex mno-base-addresses
10308 Generate (do not generate) code that uses @emph{base addresses}. Using a
10309 base address automatically generates a request (handled by the assembler
10310 and the linker) for a constant to be set up in a global register. The
10311 register is used for one or more base address requests within the range 0
10312 to 255 from the value held in the register. The generally leads to short
10313 and fast code, but the number of different data items that can be
10314 addressed is limited. This means that a program that uses lots of static
10315 data may require @option{-mno-base-addresses}.
10316
10317 @item -msingle-exit
10318 @itemx -mno-single-exit
10319 @opindex msingle-exit
10320 @opindex mno-single-exit
10321 Force (do not force) generated code to have a single exit point in each
10322 function.
10323 @end table
10324
10325 @node MN10300 Options
10326 @subsection MN10300 Options
10327 @cindex MN10300 options
10328
10329 These @option{-m} options are defined for Matsushita MN10300 architectures:
10330
10331 @table @gcctabopt
10332 @item -mmult-bug
10333 @opindex mmult-bug
10334 Generate code to avoid bugs in the multiply instructions for the MN10300
10335 processors. This is the default.
10336
10337 @item -mno-mult-bug
10338 @opindex mno-mult-bug
10339 Do not generate code to avoid bugs in the multiply instructions for the
10340 MN10300 processors.
10341
10342 @item -mam33
10343 @opindex mam33
10344 Generate code which uses features specific to the AM33 processor.
10345
10346 @item -mno-am33
10347 @opindex mno-am33
10348 Do not generate code which uses features specific to the AM33 processor. This
10349 is the default.
10350
10351 @item -mno-crt0
10352 @opindex mno-crt0
10353 Do not link in the C run-time initialization object file.
10354
10355 @item -mrelax
10356 @opindex mrelax
10357 Indicate to the linker that it should perform a relaxation optimization pass
10358 to shorten branches, calls and absolute memory addresses. This option only
10359 has an effect when used on the command line for the final link step.
10360
10361 This option makes symbolic debugging impossible.
10362 @end table
10363
10364 @node NS32K Options
10365 @subsection NS32K Options
10366 @cindex NS32K options
10367
10368 These are the @samp{-m} options defined for the 32000 series. The default
10369 values for these options depends on which style of 32000 was selected when
10370 the compiler was configured; the defaults for the most common choices are
10371 given below.
10372
10373 @table @gcctabopt
10374 @item -m32032
10375 @itemx -m32032
10376 @opindex m32032
10377 @opindex m32032
10378 Generate output for a 32032. This is the default
10379 when the compiler is configured for 32032 and 32016 based systems.
10380
10381 @item -m32332
10382 @itemx -m32332
10383 @opindex m32332
10384 @opindex m32332
10385 Generate output for a 32332. This is the default
10386 when the compiler is configured for 32332-based systems.
10387
10388 @item -m32532
10389 @itemx -m32532
10390 @opindex m32532
10391 @opindex m32532
10392 Generate output for a 32532. This is the default
10393 when the compiler is configured for 32532-based systems.
10394
10395 @item -m32081
10396 @opindex m32081
10397 Generate output containing 32081 instructions for floating point.
10398 This is the default for all systems.
10399
10400 @item -m32381
10401 @opindex m32381
10402 Generate output containing 32381 instructions for floating point. This
10403 also implies @option{-m32081}. The 32381 is only compatible with the 32332
10404 and 32532 cpus. This is the default for the pc532-netbsd configuration.
10405
10406 @item -mmulti-add
10407 @opindex mmulti-add
10408 Try and generate multiply-add floating point instructions @code{polyF}
10409 and @code{dotF}. This option is only available if the @option{-m32381}
10410 option is in effect. Using these instructions requires changes to
10411 register allocation which generally has a negative impact on
10412 performance. This option should only be enabled when compiling code
10413 particularly likely to make heavy use of multiply-add instructions.
10414
10415 @item -mnomulti-add
10416 @opindex mnomulti-add
10417 Do not try and generate multiply-add floating point instructions
10418 @code{polyF} and @code{dotF}. This is the default on all platforms.
10419
10420 @item -msoft-float
10421 @opindex msoft-float
10422 Generate output containing library calls for floating point.
10423 @strong{Warning:} the requisite libraries may not be available.
10424
10425 @item -mieee-compare
10426 @itemx -mno-ieee-compare
10427 @opindex mieee-compare
10428 @opindex mno-ieee-compare
10429 Control whether or not the compiler uses IEEE floating point
10430 comparisons. These handle correctly the case where the result of a
10431 comparison is unordered.
10432 @strong{Warning:} the requisite kernel support may not be available.
10433
10434 @item -mnobitfield
10435 @opindex mnobitfield
10436 Do not use the bit-field instructions. On some machines it is faster to
10437 use shifting and masking operations. This is the default for the pc532.
10438
10439 @item -mbitfield
10440 @opindex mbitfield
10441 Do use the bit-field instructions. This is the default for all platforms
10442 except the pc532.
10443
10444 @item -mrtd
10445 @opindex mrtd
10446 Use a different function-calling convention, in which functions
10447 that take a fixed number of arguments return pop their
10448 arguments on return with the @code{ret} instruction.
10449
10450 This calling convention is incompatible with the one normally
10451 used on Unix, so you cannot use it if you need to call libraries
10452 compiled with the Unix compiler.
10453
10454 Also, you must provide function prototypes for all functions that
10455 take variable numbers of arguments (including @code{printf});
10456 otherwise incorrect code will be generated for calls to those
10457 functions.
10458
10459 In addition, seriously incorrect code will result if you call a
10460 function with too many arguments. (Normally, extra arguments are
10461 harmlessly ignored.)
10462
10463 This option takes its name from the 680x0 @code{rtd} instruction.
10464
10465
10466 @item -mregparam
10467 @opindex mregparam
10468 Use a different function-calling convention where the first two arguments
10469 are passed in registers.
10470
10471 This calling convention is incompatible with the one normally
10472 used on Unix, so you cannot use it if you need to call libraries
10473 compiled with the Unix compiler.
10474
10475 @item -mnoregparam
10476 @opindex mnoregparam
10477 Do not pass any arguments in registers. This is the default for all
10478 targets.
10479
10480 @item -msb
10481 @opindex msb
10482 It is OK to use the sb as an index register which is always loaded with
10483 zero. This is the default for the pc532-netbsd target.
10484
10485 @item -mnosb
10486 @opindex mnosb
10487 The sb register is not available for use or has not been initialized to
10488 zero by the run time system. This is the default for all targets except
10489 the pc532-netbsd. It is also implied whenever @option{-mhimem} or
10490 @option{-fpic} is set.
10491
10492 @item -mhimem
10493 @opindex mhimem
10494 Many ns32000 series addressing modes use displacements of up to 512MB@.
10495 If an address is above 512MB then displacements from zero can not be used.
10496 This option causes code to be generated which can be loaded above 512MB@.
10497 This may be useful for operating systems or ROM code.
10498
10499 @item -mnohimem
10500 @opindex mnohimem
10501 Assume code will be loaded in the first 512MB of virtual address space.
10502 This is the default for all platforms.
10503
10504 @end table
10505
10506 @node PDP-11 Options
10507 @subsection PDP-11 Options
10508 @cindex PDP-11 Options
10509
10510 These options are defined for the PDP-11:
10511
10512 @table @gcctabopt
10513 @item -mfpu
10514 @opindex mfpu
10515 Use hardware FPP floating point. This is the default. (FIS floating
10516 point on the PDP-11/40 is not supported.)
10517
10518 @item -msoft-float
10519 @opindex msoft-float
10520 Do not use hardware floating point.
10521
10522 @item -mac0
10523 @opindex mac0
10524 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10525
10526 @item -mno-ac0
10527 @opindex mno-ac0
10528 Return floating-point results in memory. This is the default.
10529
10530 @item -m40
10531 @opindex m40
10532 Generate code for a PDP-11/40.
10533
10534 @item -m45
10535 @opindex m45
10536 Generate code for a PDP-11/45. This is the default.
10537
10538 @item -m10
10539 @opindex m10
10540 Generate code for a PDP-11/10.
10541
10542 @item -mbcopy-builtin
10543 @opindex bcopy-builtin
10544 Use inline @code{movmemhi} patterns for copying memory. This is the
10545 default.
10546
10547 @item -mbcopy
10548 @opindex mbcopy
10549 Do not use inline @code{movmemhi} patterns for copying memory.
10550
10551 @item -mint16
10552 @itemx -mno-int32
10553 @opindex mint16
10554 @opindex mno-int32
10555 Use 16-bit @code{int}. This is the default.
10556
10557 @item -mint32
10558 @itemx -mno-int16
10559 @opindex mint32
10560 @opindex mno-int16
10561 Use 32-bit @code{int}.
10562
10563 @item -mfloat64
10564 @itemx -mno-float32
10565 @opindex mfloat64
10566 @opindex mno-float32
10567 Use 64-bit @code{float}. This is the default.
10568
10569 @item -mfloat32
10570 @itemx -mno-float64
10571 @opindex mfloat32
10572 @opindex mno-float64
10573 Use 32-bit @code{float}.
10574
10575 @item -mabshi
10576 @opindex mabshi
10577 Use @code{abshi2} pattern. This is the default.
10578
10579 @item -mno-abshi
10580 @opindex mno-abshi
10581 Do not use @code{abshi2} pattern.
10582
10583 @item -mbranch-expensive
10584 @opindex mbranch-expensive
10585 Pretend that branches are expensive. This is for experimenting with
10586 code generation only.
10587
10588 @item -mbranch-cheap
10589 @opindex mbranch-cheap
10590 Do not pretend that branches are expensive. This is the default.
10591
10592 @item -msplit
10593 @opindex msplit
10594 Generate code for a system with split I&D@.
10595
10596 @item -mno-split
10597 @opindex mno-split
10598 Generate code for a system without split I&D@. This is the default.
10599
10600 @item -munix-asm
10601 @opindex munix-asm
10602 Use Unix assembler syntax. This is the default when configured for
10603 @samp{pdp11-*-bsd}.
10604
10605 @item -mdec-asm
10606 @opindex mdec-asm
10607 Use DEC assembler syntax. This is the default when configured for any
10608 PDP-11 target other than @samp{pdp11-*-bsd}.
10609 @end table
10610
10611 @node PowerPC Options
10612 @subsection PowerPC Options
10613 @cindex PowerPC options
10614
10615 These are listed under @xref{RS/6000 and PowerPC Options}.
10616
10617 @node RS/6000 and PowerPC Options
10618 @subsection IBM RS/6000 and PowerPC Options
10619 @cindex RS/6000 and PowerPC Options
10620 @cindex IBM RS/6000 and PowerPC Options
10621
10622 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10623 @table @gcctabopt
10624 @item -mpower
10625 @itemx -mno-power
10626 @itemx -mpower2
10627 @itemx -mno-power2
10628 @itemx -mpowerpc
10629 @itemx -mno-powerpc
10630 @itemx -mpowerpc-gpopt
10631 @itemx -mno-powerpc-gpopt
10632 @itemx -mpowerpc-gfxopt
10633 @itemx -mno-powerpc-gfxopt
10634 @itemx -mpowerpc64
10635 @itemx -mno-powerpc64
10636 @opindex mpower
10637 @opindex mno-power
10638 @opindex mpower2
10639 @opindex mno-power2
10640 @opindex mpowerpc
10641 @opindex mno-powerpc
10642 @opindex mpowerpc-gpopt
10643 @opindex mno-powerpc-gpopt
10644 @opindex mpowerpc-gfxopt
10645 @opindex mno-powerpc-gfxopt
10646 @opindex mpowerpc64
10647 @opindex mno-powerpc64
10648 GCC supports two related instruction set architectures for the
10649 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10650 instructions supported by the @samp{rios} chip set used in the original
10651 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10652 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10653 the IBM 4xx microprocessors.
10654
10655 Neither architecture is a subset of the other. However there is a
10656 large common subset of instructions supported by both. An MQ
10657 register is included in processors supporting the POWER architecture.
10658
10659 You use these options to specify which instructions are available on the
10660 processor you are using. The default value of these options is
10661 determined when configuring GCC@. Specifying the
10662 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10663 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
10664 rather than the options listed above.
10665
10666 The @option{-mpower} option allows GCC to generate instructions that
10667 are found only in the POWER architecture and to use the MQ register.
10668 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10669 to generate instructions that are present in the POWER2 architecture but
10670 not the original POWER architecture.
10671
10672 The @option{-mpowerpc} option allows GCC to generate instructions that
10673 are found only in the 32-bit subset of the PowerPC architecture.
10674 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10675 GCC to use the optional PowerPC architecture instructions in the
10676 General Purpose group, including floating-point square root. Specifying
10677 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10678 use the optional PowerPC architecture instructions in the Graphics
10679 group, including floating-point select.
10680
10681 The @option{-mpowerpc64} option allows GCC to generate the additional
10682 64-bit instructions that are found in the full PowerPC64 architecture
10683 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
10684 @option{-mno-powerpc64}.
10685
10686 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10687 will use only the instructions in the common subset of both
10688 architectures plus some special AIX common-mode calls, and will not use
10689 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
10690 permits GCC to use any instruction from either architecture and to
10691 allow use of the MQ register; specify this for the Motorola MPC601.
10692
10693 @item -mnew-mnemonics
10694 @itemx -mold-mnemonics
10695 @opindex mnew-mnemonics
10696 @opindex mold-mnemonics
10697 Select which mnemonics to use in the generated assembler code. With
10698 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10699 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
10700 assembler mnemonics defined for the POWER architecture. Instructions
10701 defined in only one architecture have only one mnemonic; GCC uses that
10702 mnemonic irrespective of which of these options is specified.
10703
10704 GCC defaults to the mnemonics appropriate for the architecture in
10705 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10706 value of these option. Unless you are building a cross-compiler, you
10707 should normally not specify either @option{-mnew-mnemonics} or
10708 @option{-mold-mnemonics}, but should instead accept the default.
10709
10710 @item -mcpu=@var{cpu_type}
10711 @opindex mcpu
10712 Set architecture type, register usage, choice of mnemonics, and
10713 instruction scheduling parameters for machine type @var{cpu_type}.
10714 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10715 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10716 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10717 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10718 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10719 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10720 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10721 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10722 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10723
10724 @option{-mcpu=common} selects a completely generic processor. Code
10725 generated under this option will run on any POWER or PowerPC processor.
10726 GCC will use only the instructions in the common subset of both
10727 architectures, and will not use the MQ register. GCC assumes a generic
10728 processor model for scheduling purposes.
10729
10730 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10731 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10732 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10733 types, with an appropriate, generic processor model assumed for
10734 scheduling purposes.
10735
10736 The other options specify a specific processor. Code generated under
10737 those options will run best on that processor, and may not run at all on
10738 others.
10739
10740 The @option{-mcpu} options automatically enable or disable the
10741 following options: @option{-maltivec}, @option{-mhard-float},
10742 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10743 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10744 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10745 @option{-mstring}. The particular options set for any particular CPU
10746 will vary between compiler versions, depending on what setting seems
10747 to produce optimal code for that CPU; it doesn't necessarily reflect
10748 the actual hardware's capabilities. If you wish to set an individual
10749 option to a particular value, you may specify it after the
10750 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10751
10752 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10753 not enabled or disabled by the @option{-mcpu} option at present, since
10754 AIX does not have full support for these options. You may still
10755 enable or disable them individually if you're sure it'll work in your
10756 environment.
10757
10758 @item -mtune=@var{cpu_type}
10759 @opindex mtune
10760 Set the instruction scheduling parameters for machine type
10761 @var{cpu_type}, but do not set the architecture type, register usage, or
10762 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
10763 values for @var{cpu_type} are used for @option{-mtune} as for
10764 @option{-mcpu}. If both are specified, the code generated will use the
10765 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10766 scheduling parameters set by @option{-mtune}.
10767
10768 @item -mswdiv
10769 @itemx -mno-swdiv
10770 @opindex mswdiv
10771 @opindex mno-swdiv
10772 Generate code to compute division as reciprocal estimate and iterative
10773 refinement, creating opportunities for increased throughput. This
10774 feature requires: optional PowerPC Graphics instruction set for single
10775 precision and FRE instruction for double precision, assuming divides
10776 cannot generate user-visible traps, and the domain values not include
10777 Infinities, denormals or zero denominator.
10778
10779 @item -maltivec
10780 @itemx -mno-altivec
10781 @opindex maltivec
10782 @opindex mno-altivec
10783 Generate code that uses (does not use) AltiVec instructions, and also
10784 enable the use of built-in functions that allow more direct access to
10785 the AltiVec instruction set. You may also need to set
10786 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10787 enhancements.
10788
10789 @item -mvrsave
10790 @item -mno-vrsave
10791 @opindex mvrsave
10792 @opindex mno-vrsave
10793 Generate VRSAVE instructions when generating AltiVec code.
10794
10795 @item -mabi=spe
10796 @opindex mabi=spe
10797 Extend the current ABI with SPE ABI extensions. This does not change
10798 the default ABI, instead it adds the SPE ABI extensions to the current
10799 ABI@.
10800
10801 @item -mabi=no-spe
10802 @opindex mabi=no-spe
10803 Disable Booke SPE ABI extensions for the current ABI@.
10804
10805 @item -msecure-plt
10806 @opindex msecure-plt
10807 Generate code that allows ld and ld.so to build executables and shared
10808 libraries with non-exec .plt and .got sections. This is a PowerPC
10809 32-bit SYSV ABI option.
10810
10811 @item -mbss-plt
10812 @opindex mbss-plt
10813 Generate code that uses a BSS .plt section that ld.so fills in, and
10814 requires .plt and .got sections that are both writable and executable.
10815 This is a PowerPC 32-bit SYSV ABI option.
10816
10817 @item -misel
10818 @itemx -mno-isel
10819 @opindex misel
10820 @opindex mno-isel
10821 This switch enables or disables the generation of ISEL instructions.
10822
10823 @item -misel=@var{yes/no}
10824 This switch has been deprecated. Use @option{-misel} and
10825 @option{-mno-isel} instead.
10826
10827 @item -mspe
10828 @itemx -mno-isel
10829 @opindex mspe
10830 @opindex mno-spe
10831 This switch enables or disables the generation of SPE simd
10832 instructions.
10833
10834 @item -mspe=@var{yes/no}
10835 This option has been deprecated. Use @option{-mspe} and
10836 @option{-mno-spe} instead.
10837
10838 @item -mfloat-gprs=@var{yes/single/double/no}
10839 @itemx -mfloat-gprs
10840 @opindex mfloat-gprs
10841 This switch enables or disables the generation of floating point
10842 operations on the general purpose registers for architectures that
10843 support it.
10844
10845 The argument @var{yes} or @var{single} enables the use of
10846 single-precision floating point operations.
10847
10848 The argument @var{double} enables the use of single and
10849 double-precision floating point operations.
10850
10851 The argument @var{no} disables floating point operations on the
10852 general purpose registers.
10853
10854 This option is currently only available on the MPC854x.
10855
10856 @item -m32
10857 @itemx -m64
10858 @opindex m32
10859 @opindex m64
10860 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10861 targets (including GNU/Linux). The 32-bit environment sets int, long
10862 and pointer to 32 bits and generates code that runs on any PowerPC
10863 variant. The 64-bit environment sets int to 32 bits and long and
10864 pointer to 64 bits, and generates code for PowerPC64, as for
10865 @option{-mpowerpc64}.
10866
10867 @item -mfull-toc
10868 @itemx -mno-fp-in-toc
10869 @itemx -mno-sum-in-toc
10870 @itemx -mminimal-toc
10871 @opindex mfull-toc
10872 @opindex mno-fp-in-toc
10873 @opindex mno-sum-in-toc
10874 @opindex mminimal-toc
10875 Modify generation of the TOC (Table Of Contents), which is created for
10876 every executable file. The @option{-mfull-toc} option is selected by
10877 default. In that case, GCC will allocate at least one TOC entry for
10878 each unique non-automatic variable reference in your program. GCC
10879 will also place floating-point constants in the TOC@. However, only
10880 16,384 entries are available in the TOC@.
10881
10882 If you receive a linker error message that saying you have overflowed
10883 the available TOC space, you can reduce the amount of TOC space used
10884 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10885 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10886 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10887 generate code to calculate the sum of an address and a constant at
10888 run-time instead of putting that sum into the TOC@. You may specify one
10889 or both of these options. Each causes GCC to produce very slightly
10890 slower and larger code at the expense of conserving TOC space.
10891
10892 If you still run out of space in the TOC even when you specify both of
10893 these options, specify @option{-mminimal-toc} instead. This option causes
10894 GCC to make only one TOC entry for every file. When you specify this
10895 option, GCC will produce code that is slower and larger but which
10896 uses extremely little TOC space. You may wish to use this option
10897 only on files that contain less frequently executed code.
10898
10899 @item -maix64
10900 @itemx -maix32
10901 @opindex maix64
10902 @opindex maix32
10903 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10904 @code{long} type, and the infrastructure needed to support them.
10905 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10906 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10907 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
10908
10909 @item -mxl-compat
10910 @itemx -mno-xl-compat
10911 @opindex mxl-compat
10912 @opindex mno-xl-compat
10913 Produce code that conforms more closely to IBM XLC semantics when using
10914 AIX-compatible ABI. Pass floating-point arguments to prototyped
10915 functions beyond the register save area (RSA) on the stack in addition
10916 to argument FPRs. Do not assume that most significant double in 128
10917 bit long double value is properly rounded when comparing values.
10918
10919 The AIX calling convention was extended but not initially documented to
10920 handle an obscure K&R C case of calling a function that takes the
10921 address of its arguments with fewer arguments than declared. AIX XL
10922 compilers access floating point arguments which do not fit in the
10923 RSA from the stack when a subroutine is compiled without
10924 optimization. Because always storing floating-point arguments on the
10925 stack is inefficient and rarely needed, this option is not enabled by
10926 default and only is necessary when calling subroutines compiled by AIX
10927 XL compilers without optimization.
10928
10929 @item -mpe
10930 @opindex mpe
10931 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
10932 application written to use message passing with special startup code to
10933 enable the application to run. The system must have PE installed in the
10934 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10935 must be overridden with the @option{-specs=} option to specify the
10936 appropriate directory location. The Parallel Environment does not
10937 support threads, so the @option{-mpe} option and the @option{-pthread}
10938 option are incompatible.
10939
10940 @item -malign-natural
10941 @itemx -malign-power
10942 @opindex malign-natural
10943 @opindex malign-power
10944 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10945 @option{-malign-natural} overrides the ABI-defined alignment of larger
10946 types, such as floating-point doubles, on their natural size-based boundary.
10947 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10948 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
10949
10950 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10951 is not supported.
10952
10953 @item -msoft-float
10954 @itemx -mhard-float
10955 @opindex msoft-float
10956 @opindex mhard-float
10957 Generate code that does not use (uses) the floating-point register set.
10958 Software floating point emulation is provided if you use the
10959 @option{-msoft-float} option, and pass the option to GCC when linking.
10960
10961 @item -mmultiple
10962 @itemx -mno-multiple
10963 @opindex mmultiple
10964 @opindex mno-multiple
10965 Generate code that uses (does not use) the load multiple word
10966 instructions and the store multiple word instructions. These
10967 instructions are generated by default on POWER systems, and not
10968 generated on PowerPC systems. Do not use @option{-mmultiple} on little
10969 endian PowerPC systems, since those instructions do not work when the
10970 processor is in little endian mode. The exceptions are PPC740 and
10971 PPC750 which permit the instructions usage in little endian mode.
10972
10973 @item -mstring
10974 @itemx -mno-string
10975 @opindex mstring
10976 @opindex mno-string
10977 Generate code that uses (does not use) the load string instructions
10978 and the store string word instructions to save multiple registers and
10979 do small block moves. These instructions are generated by default on
10980 POWER systems, and not generated on PowerPC systems. Do not use
10981 @option{-mstring} on little endian PowerPC systems, since those
10982 instructions do not work when the processor is in little endian mode.
10983 The exceptions are PPC740 and PPC750 which permit the instructions
10984 usage in little endian mode.
10985
10986 @item -mupdate
10987 @itemx -mno-update
10988 @opindex mupdate
10989 @opindex mno-update
10990 Generate code that uses (does not use) the load or store instructions
10991 that update the base register to the address of the calculated memory
10992 location. These instructions are generated by default. If you use
10993 @option{-mno-update}, there is a small window between the time that the
10994 stack pointer is updated and the address of the previous frame is
10995 stored, which means code that walks the stack frame across interrupts or
10996 signals may get corrupted data.
10997
10998 @item -mfused-madd
10999 @itemx -mno-fused-madd
11000 @opindex mfused-madd
11001 @opindex mno-fused-madd
11002 Generate code that uses (does not use) the floating point multiply and
11003 accumulate instructions. These instructions are generated by default if
11004 hardware floating is used.
11005
11006 @item -mno-bit-align
11007 @itemx -mbit-align
11008 @opindex mno-bit-align
11009 @opindex mbit-align
11010 On System V.4 and embedded PowerPC systems do not (do) force structures
11011 and unions that contain bit-fields to be aligned to the base type of the
11012 bit-field.
11013
11014 For example, by default a structure containing nothing but 8
11015 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
11016 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
11017 the structure would be aligned to a 1 byte boundary and be one byte in
11018 size.
11019
11020 @item -mno-strict-align
11021 @itemx -mstrict-align
11022 @opindex mno-strict-align
11023 @opindex mstrict-align
11024 On System V.4 and embedded PowerPC systems do not (do) assume that
11025 unaligned memory references will be handled by the system.
11026
11027 @item -mrelocatable
11028 @itemx -mno-relocatable
11029 @opindex mrelocatable
11030 @opindex mno-relocatable
11031 On embedded PowerPC systems generate code that allows (does not allow)
11032 the program to be relocated to a different address at runtime. If you
11033 use @option{-mrelocatable} on any module, all objects linked together must
11034 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
11035
11036 @item -mrelocatable-lib
11037 @itemx -mno-relocatable-lib
11038 @opindex mrelocatable-lib
11039 @opindex mno-relocatable-lib
11040 On embedded PowerPC systems generate code that allows (does not allow)
11041 the program to be relocated to a different address at runtime. Modules
11042 compiled with @option{-mrelocatable-lib} can be linked with either modules
11043 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
11044 with modules compiled with the @option{-mrelocatable} options.
11045
11046 @item -mno-toc
11047 @itemx -mtoc
11048 @opindex mno-toc
11049 @opindex mtoc
11050 On System V.4 and embedded PowerPC systems do not (do) assume that
11051 register 2 contains a pointer to a global area pointing to the addresses
11052 used in the program.
11053
11054 @item -mlittle
11055 @itemx -mlittle-endian
11056 @opindex mlittle
11057 @opindex mlittle-endian
11058 On System V.4 and embedded PowerPC systems compile code for the
11059 processor in little endian mode. The @option{-mlittle-endian} option is
11060 the same as @option{-mlittle}.
11061
11062 @item -mbig
11063 @itemx -mbig-endian
11064 @opindex mbig
11065 @opindex mbig-endian
11066 On System V.4 and embedded PowerPC systems compile code for the
11067 processor in big endian mode. The @option{-mbig-endian} option is
11068 the same as @option{-mbig}.
11069
11070 @item -mdynamic-no-pic
11071 @opindex mdynamic-no-pic
11072 On Darwin and Mac OS X systems, compile code so that it is not
11073 relocatable, but that its external references are relocatable. The
11074 resulting code is suitable for applications, but not shared
11075 libraries.
11076
11077 @item -mprioritize-restricted-insns=@var{priority}
11078 @opindex mprioritize-restricted-insns
11079 This option controls the priority that is assigned to
11080 dispatch-slot restricted instructions during the second scheduling
11081 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
11082 @var{no/highest/second-highest} priority to dispatch slot restricted
11083 instructions.
11084
11085 @item -msched-costly-dep=@var{dependence_type}
11086 @opindex msched-costly-dep
11087 This option controls which dependences are considered costly
11088 by the target during instruction scheduling. The argument
11089 @var{dependence_type} takes one of the following values:
11090 @var{no}: no dependence is costly,
11091 @var{all}: all dependences are costly,
11092 @var{true_store_to_load}: a true dependence from store to load is costly,
11093 @var{store_to_load}: any dependence from store to load is costly,
11094 @var{number}: any dependence which latency >= @var{number} is costly.
11095
11096 @item -minsert-sched-nops=@var{scheme}
11097 @opindex minsert-sched-nops
11098 This option controls which nop insertion scheme will be used during
11099 the second scheduling pass. The argument @var{scheme} takes one of the
11100 following values:
11101 @var{no}: Don't insert nops.
11102 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
11103 according to the scheduler's grouping.
11104 @var{regroup_exact}: Insert nops to force costly dependent insns into
11105 separate groups. Insert exactly as many nops as needed to force an insn
11106 to a new group, according to the estimated processor grouping.
11107 @var{number}: Insert nops to force costly dependent insns into
11108 separate groups. Insert @var{number} nops to force an insn to a new group.
11109
11110 @item -mcall-sysv
11111 @opindex mcall-sysv
11112 On System V.4 and embedded PowerPC systems compile code using calling
11113 conventions that adheres to the March 1995 draft of the System V
11114 Application Binary Interface, PowerPC processor supplement. This is the
11115 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
11116
11117 @item -mcall-sysv-eabi
11118 @opindex mcall-sysv-eabi
11119 Specify both @option{-mcall-sysv} and @option{-meabi} options.
11120
11121 @item -mcall-sysv-noeabi
11122 @opindex mcall-sysv-noeabi
11123 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
11124
11125 @item -mcall-solaris
11126 @opindex mcall-solaris
11127 On System V.4 and embedded PowerPC systems compile code for the Solaris
11128 operating system.
11129
11130 @item -mcall-linux
11131 @opindex mcall-linux
11132 On System V.4 and embedded PowerPC systems compile code for the
11133 Linux-based GNU system.
11134
11135 @item -mcall-gnu
11136 @opindex mcall-gnu
11137 On System V.4 and embedded PowerPC systems compile code for the
11138 Hurd-based GNU system.
11139
11140 @item -mcall-netbsd
11141 @opindex mcall-netbsd
11142 On System V.4 and embedded PowerPC systems compile code for the
11143 NetBSD operating system.
11144
11145 @item -maix-struct-return
11146 @opindex maix-struct-return
11147 Return all structures in memory (as specified by the AIX ABI)@.
11148
11149 @item -msvr4-struct-return
11150 @opindex msvr4-struct-return
11151 Return structures smaller than 8 bytes in registers (as specified by the
11152 SVR4 ABI)@.
11153
11154 @item -mabi=@var{abi-type}
11155 @opindex mabi
11156 Extend the current ABI with a particular extension, or remove such extension.
11157 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
11158 @var{no-spe}@.
11159
11160 @item -mprototype
11161 @itemx -mno-prototype
11162 @opindex mprototype
11163 @opindex mno-prototype
11164 On System V.4 and embedded PowerPC systems assume that all calls to
11165 variable argument functions are properly prototyped. Otherwise, the
11166 compiler must insert an instruction before every non prototyped call to
11167 set or clear bit 6 of the condition code register (@var{CR}) to
11168 indicate whether floating point values were passed in the floating point
11169 registers in case the function takes a variable arguments. With
11170 @option{-mprototype}, only calls to prototyped variable argument functions
11171 will set or clear the bit.
11172
11173 @item -msim
11174 @opindex msim
11175 On embedded PowerPC systems, assume that the startup module is called
11176 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11177 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
11178 configurations.
11179
11180 @item -mmvme
11181 @opindex mmvme
11182 On embedded PowerPC systems, assume that the startup module is called
11183 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11184 @file{libc.a}.
11185
11186 @item -mads
11187 @opindex mads
11188 On embedded PowerPC systems, assume that the startup module is called
11189 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11190 @file{libc.a}.
11191
11192 @item -myellowknife
11193 @opindex myellowknife
11194 On embedded PowerPC systems, assume that the startup module is called
11195 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11196 @file{libc.a}.
11197
11198 @item -mvxworks
11199 @opindex mvxworks
11200 On System V.4 and embedded PowerPC systems, specify that you are
11201 compiling for a VxWorks system.
11202
11203 @item -mwindiss
11204 @opindex mwindiss
11205 Specify that you are compiling for the WindISS simulation environment.
11206
11207 @item -memb
11208 @opindex memb
11209 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11210 header to indicate that @samp{eabi} extended relocations are used.
11211
11212 @item -meabi
11213 @itemx -mno-eabi
11214 @opindex meabi
11215 @opindex mno-eabi
11216 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11217 Embedded Applications Binary Interface (eabi) which is a set of
11218 modifications to the System V.4 specifications. Selecting @option{-meabi}
11219 means that the stack is aligned to an 8 byte boundary, a function
11220 @code{__eabi} is called to from @code{main} to set up the eabi
11221 environment, and the @option{-msdata} option can use both @code{r2} and
11222 @code{r13} to point to two separate small data areas. Selecting
11223 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11224 do not call an initialization function from @code{main}, and the
11225 @option{-msdata} option will only use @code{r13} to point to a single
11226 small data area. The @option{-meabi} option is on by default if you
11227 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11228
11229 @item -msdata=eabi
11230 @opindex msdata=eabi
11231 On System V.4 and embedded PowerPC systems, put small initialized
11232 @code{const} global and static data in the @samp{.sdata2} section, which
11233 is pointed to by register @code{r2}. Put small initialized
11234 non-@code{const} global and static data in the @samp{.sdata} section,
11235 which is pointed to by register @code{r13}. Put small uninitialized
11236 global and static data in the @samp{.sbss} section, which is adjacent to
11237 the @samp{.sdata} section. The @option{-msdata=eabi} option is
11238 incompatible with the @option{-mrelocatable} option. The
11239 @option{-msdata=eabi} option also sets the @option{-memb} option.
11240
11241 @item -msdata=sysv
11242 @opindex msdata=sysv
11243 On System V.4 and embedded PowerPC systems, put small global and static
11244 data in the @samp{.sdata} section, which is pointed to by register
11245 @code{r13}. Put small uninitialized global and static data in the
11246 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11247 The @option{-msdata=sysv} option is incompatible with the
11248 @option{-mrelocatable} option.
11249
11250 @item -msdata=default
11251 @itemx -msdata
11252 @opindex msdata=default
11253 @opindex msdata
11254 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11255 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11256 same as @option{-msdata=sysv}.
11257
11258 @item -msdata-data
11259 @opindex msdata-data
11260 On System V.4 and embedded PowerPC systems, put small global and static
11261 data in the @samp{.sdata} section. Put small uninitialized global and
11262 static data in the @samp{.sbss} section. Do not use register @code{r13}
11263 to address small data however. This is the default behavior unless
11264 other @option{-msdata} options are used.
11265
11266 @item -msdata=none
11267 @itemx -mno-sdata
11268 @opindex msdata=none
11269 @opindex mno-sdata
11270 On embedded PowerPC systems, put all initialized global and static data
11271 in the @samp{.data} section, and all uninitialized data in the
11272 @samp{.bss} section.
11273
11274 @item -G @var{num}
11275 @opindex G
11276 @cindex smaller data references (PowerPC)
11277 @cindex .sdata/.sdata2 references (PowerPC)
11278 On embedded PowerPC systems, put global and static items less than or
11279 equal to @var{num} bytes into the small data or bss sections instead of
11280 the normal data or bss section. By default, @var{num} is 8. The
11281 @option{-G @var{num}} switch is also passed to the linker.
11282 All modules should be compiled with the same @option{-G @var{num}} value.
11283
11284 @item -mregnames
11285 @itemx -mno-regnames
11286 @opindex mregnames
11287 @opindex mno-regnames
11288 On System V.4 and embedded PowerPC systems do (do not) emit register
11289 names in the assembly language output using symbolic forms.
11290
11291 @item -mlongcall
11292 @itemx -mno-longcall
11293 @opindex mlongcall
11294 @opindex mno-longcall
11295 Default to making all function calls indirectly, using a register, so
11296 that functions which reside further than 32 megabytes (33,554,432
11297 bytes) from the current location can be called. This setting can be
11298 overridden by the @code{shortcall} function attribute, or by
11299 @code{#pragma longcall(0)}.
11300
11301 Some linkers are capable of detecting out-of-range calls and generating
11302 glue code on the fly. On these systems, long calls are unnecessary and
11303 generate slower code. As of this writing, the AIX linker can do this,
11304 as can the GNU linker for PowerPC/64. It is planned to add this feature
11305 to the GNU linker for 32-bit PowerPC systems as well.
11306
11307 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11308 callee, L42'', plus a ``branch island'' (glue code). The two target
11309 addresses represent the callee and the ``branch island''. The
11310 Darwin/PPC linker will prefer the first address and generate a ``bl
11311 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11312 otherwise, the linker will generate ``bl L42'' to call the ``branch
11313 island''. The ``branch island'' is appended to the body of the
11314 calling function; it computes the full 32-bit address of the callee
11315 and jumps to it.
11316
11317 On Mach-O (Darwin) systems, this option directs the compiler emit to
11318 the glue for every direct call, and the Darwin linker decides whether
11319 to use or discard it.
11320
11321 In the future, we may cause GCC to ignore all longcall specifications
11322 when the linker is known to generate glue.
11323
11324 @item -pthread
11325 @opindex pthread
11326 Adds support for multithreading with the @dfn{pthreads} library.
11327 This option sets flags for both the preprocessor and linker.
11328
11329 @end table
11330
11331 @node S/390 and zSeries Options
11332 @subsection S/390 and zSeries Options
11333 @cindex S/390 and zSeries Options
11334
11335 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11336
11337 @table @gcctabopt
11338 @item -mhard-float
11339 @itemx -msoft-float
11340 @opindex mhard-float
11341 @opindex msoft-float
11342 Use (do not use) the hardware floating-point instructions and registers
11343 for floating-point operations. When @option{-msoft-float} is specified,
11344 functions in @file{libgcc.a} will be used to perform floating-point
11345 operations. When @option{-mhard-float} is specified, the compiler
11346 generates IEEE floating-point instructions. This is the default.
11347
11348 @item -mbackchain
11349 @itemx -mno-backchain
11350 @opindex mbackchain
11351 @opindex mno-backchain
11352 Store (do not store) the address of the caller's frame as backchain pointer
11353 into the callee's stack frame.
11354 A backchain may be needed to allow debugging using tools that do not understand
11355 DWARF-2 call frame information.
11356 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11357 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11358 the backchain is placed into the topmost word of the 96/160 byte register
11359 save area.
11360
11361 In general, code compiled with @option{-mbackchain} is call-compatible with
11362 code compiled with @option{-mmo-backchain}; however, use of the backchain
11363 for debugging purposes usually requires that the whole binary is built with
11364 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
11365 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11366 to build a linux kernel use @option{-msoft-float}.
11367
11368 The default is to not maintain the backchain.
11369
11370 @item -mpacked-stack
11371 @item -mno-packed-stack
11372 @opindex mpacked-stack
11373 @opindex mno-packed-stack
11374 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11375 specified, the compiler uses the all fields of the 96/160 byte register save
11376 area only for their default purpose; unused fields still take up stack space.
11377 When @option{-mpacked-stack} is specified, register save slots are densely
11378 packed at the top of the register save area; unused space is reused for other
11379 purposes, allowing for more efficient use of the available stack space.
11380 However, when @option{-mbackchain} is also in effect, the topmost word of
11381 the save area is always used to store the backchain, and the return address
11382 register is always saved two words below the backchain.
11383
11384 As long as the stack frame backchain is not used, code generated with
11385 @option{-mpacked-stack} is call-compatible with code generated with
11386 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11387 S/390 or zSeries generated code that uses the stack frame backchain at run
11388 time, not just for debugging purposes. Such code is not call-compatible
11389 with code compiled with @option{-mpacked-stack}. Also, note that the
11390 combination of @option{-mbackchain},
11391 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11392 to build a linux kernel use @option{-msoft-float}.
11393
11394 The default is to not use the packed stack layout.
11395
11396 @item -msmall-exec
11397 @itemx -mno-small-exec
11398 @opindex msmall-exec
11399 @opindex mno-small-exec
11400 Generate (or do not generate) code using the @code{bras} instruction
11401 to do subroutine calls.
11402 This only works reliably if the total executable size does not
11403 exceed 64k. The default is to use the @code{basr} instruction instead,
11404 which does not have this limitation.
11405
11406 @item -m64
11407 @itemx -m31
11408 @opindex m64
11409 @opindex m31
11410 When @option{-m31} is specified, generate code compliant to the
11411 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11412 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
11413 particular to generate 64-bit instructions. For the @samp{s390}
11414 targets, the default is @option{-m31}, while the @samp{s390x}
11415 targets default to @option{-m64}.
11416
11417 @item -mzarch
11418 @itemx -mesa
11419 @opindex mzarch
11420 @opindex mesa
11421 When @option{-mzarch} is specified, generate code using the
11422 instructions available on z/Architecture.
11423 When @option{-mesa} is specified, generate code using the
11424 instructions available on ESA/390. Note that @option{-mesa} is
11425 not possible with @option{-m64}.
11426 When generating code compliant to the GNU/Linux for S/390 ABI,
11427 the default is @option{-mesa}. When generating code compliant
11428 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11429
11430 @item -mmvcle
11431 @itemx -mno-mvcle
11432 @opindex mmvcle
11433 @opindex mno-mvcle
11434 Generate (or do not generate) code using the @code{mvcle} instruction
11435 to perform block moves. When @option{-mno-mvcle} is specified,
11436 use a @code{mvc} loop instead. This is the default unless optimizing for
11437 size.
11438
11439 @item -mdebug
11440 @itemx -mno-debug
11441 @opindex mdebug
11442 @opindex mno-debug
11443 Print (or do not print) additional debug information when compiling.
11444 The default is to not print debug information.
11445
11446 @item -march=@var{cpu-type}
11447 @opindex march
11448 Generate code that will run on @var{cpu-type}, which is the name of a system
11449 representing a certain processor type. Possible values for
11450 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11451 When generating code using the instructions available on z/Architecture,
11452 the default is @option{-march=z900}. Otherwise, the default is
11453 @option{-march=g5}.
11454
11455 @item -mtune=@var{cpu-type}
11456 @opindex mtune
11457 Tune to @var{cpu-type} everything applicable about the generated code,
11458 except for the ABI and the set of available instructions.
11459 The list of @var{cpu-type} values is the same as for @option{-march}.
11460 The default is the value used for @option{-march}.
11461
11462 @item -mtpf-trace
11463 @itemx -mno-tpf-trace
11464 @opindex mtpf-trace
11465 @opindex mno-tpf-trace
11466 Generate code that adds (does not add) in TPF OS specific branches to trace
11467 routines in the operating system. This option is off by default, even
11468 when compiling for the TPF OS@.
11469
11470 @item -mfused-madd
11471 @itemx -mno-fused-madd
11472 @opindex mfused-madd
11473 @opindex mno-fused-madd
11474 Generate code that uses (does not use) the floating point multiply and
11475 accumulate instructions. These instructions are generated by default if
11476 hardware floating point is used.
11477
11478 @item -mwarn-framesize=@var{framesize}
11479 @opindex mwarn-framesize
11480 Emit a warning if the current function exceeds the given frame size. Because
11481 this is a compile time check it doesn't need to be a real problem when the program
11482 runs. It is intended to identify functions which most probably cause
11483 a stack overflow. It is useful to be used in an environment with limited stack
11484 size e.g.@: the linux kernel.
11485
11486 @item -mwarn-dynamicstack
11487 @opindex mwarn-dynamicstack
11488 Emit a warning if the function calls alloca or uses dynamically
11489 sized arrays. This is generally a bad idea with a limited stack size.
11490
11491 @item -mstack-guard=@var{stack-guard}
11492 @item -mstack-size=@var{stack-size}
11493 @opindex mstack-guard
11494 @opindex mstack-size
11495 These arguments always have to be used in conjunction. If they are present the s390
11496 back end emits additional instructions in the function prologue which trigger a trap
11497 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11498 (remember that the stack on s390 grows downward). These options are intended to
11499 be used to help debugging stack overflow problems. The additionally emitted code
11500 cause only little overhead and hence can also be used in production like systems
11501 without greater performance degradation. The given values have to be exact
11502 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11503 In order to be efficient the extra code makes the assumption that the stack starts
11504 at an address aligned to the value given by @var{stack-size}.
11505 @end table
11506
11507 @node SH Options
11508 @subsection SH Options
11509
11510 These @samp{-m} options are defined for the SH implementations:
11511
11512 @table @gcctabopt
11513 @item -m1
11514 @opindex m1
11515 Generate code for the SH1.
11516
11517 @item -m2
11518 @opindex m2
11519 Generate code for the SH2.
11520
11521 @item -m2e
11522 Generate code for the SH2e.
11523
11524 @item -m3
11525 @opindex m3
11526 Generate code for the SH3.
11527
11528 @item -m3e
11529 @opindex m3e
11530 Generate code for the SH3e.
11531
11532 @item -m4-nofpu
11533 @opindex m4-nofpu
11534 Generate code for the SH4 without a floating-point unit.
11535
11536 @item -m4-single-only
11537 @opindex m4-single-only
11538 Generate code for the SH4 with a floating-point unit that only
11539 supports single-precision arithmetic.
11540
11541 @item -m4-single
11542 @opindex m4-single
11543 Generate code for the SH4 assuming the floating-point unit is in
11544 single-precision mode by default.
11545
11546 @item -m4
11547 @opindex m4
11548 Generate code for the SH4.
11549
11550 @item -m4a-nofpu
11551 @opindex m4a-nofpu
11552 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11553 floating-point unit is not used.
11554
11555 @item -m4a-single-only
11556 @opindex m4a-single-only
11557 Generate code for the SH4a, in such a way that no double-precision
11558 floating point operations are used.
11559
11560 @item -m4a-single
11561 @opindex m4a-single
11562 Generate code for the SH4a assuming the floating-point unit is in
11563 single-precision mode by default.
11564
11565 @item -m4a
11566 @opindex m4a
11567 Generate code for the SH4a.
11568
11569 @item -m4al
11570 @opindex m4al
11571 Same as @option{-m4a-nofpu}, except that it implicitly passes
11572 @option{-dsp} to the assembler. GCC doesn't generate any DSP
11573 instructions at the moment.
11574
11575 @item -mb
11576 @opindex mb
11577 Compile code for the processor in big endian mode.
11578
11579 @item -ml
11580 @opindex ml
11581 Compile code for the processor in little endian mode.
11582
11583 @item -mdalign
11584 @opindex mdalign
11585 Align doubles at 64-bit boundaries. Note that this changes the calling
11586 conventions, and thus some functions from the standard C library will
11587 not work unless you recompile it first with @option{-mdalign}.
11588
11589 @item -mrelax
11590 @opindex mrelax
11591 Shorten some address references at link time, when possible; uses the
11592 linker option @option{-relax}.
11593
11594 @item -mbigtable
11595 @opindex mbigtable
11596 Use 32-bit offsets in @code{switch} tables. The default is to use
11597 16-bit offsets.
11598
11599 @item -mfmovd
11600 @opindex mfmovd
11601 Enable the use of the instruction @code{fmovd}.
11602
11603 @item -mhitachi
11604 @opindex mhitachi
11605 Comply with the calling conventions defined by Renesas.
11606
11607 @item -mrenesas
11608 @opindex mhitachi
11609 Comply with the calling conventions defined by Renesas.
11610
11611 @item -mno-renesas
11612 @opindex mhitachi
11613 Comply with the calling conventions defined for GCC before the Renesas
11614 conventions were available. This option is the default for all
11615 targets of the SH toolchain except for @samp{sh-symbianelf}.
11616
11617 @item -mnomacsave
11618 @opindex mnomacsave
11619 Mark the @code{MAC} register as call-clobbered, even if
11620 @option{-mhitachi} is given.
11621
11622 @item -mieee
11623 @opindex mieee
11624 Increase IEEE-compliance of floating-point code.
11625 At the moment, this is equivalent to @option{-fno-finite-math-only}.
11626 When generating 16 bit SH opcodes, getting IEEE-conforming results for
11627 comparisons of NANs / infinities incurs extra overhead in every
11628 floating point comparison, therefore the default is set to
11629 @option{-ffinite-math-only}.
11630
11631 @item -misize
11632 @opindex misize
11633 Dump instruction size and location in the assembly code.
11634
11635 @item -mpadstruct
11636 @opindex mpadstruct
11637 This option is deprecated. It pads structures to multiple of 4 bytes,
11638 which is incompatible with the SH ABI@.
11639
11640 @item -mspace
11641 @opindex mspace
11642 Optimize for space instead of speed. Implied by @option{-Os}.
11643
11644 @item -mprefergot
11645 @opindex mprefergot
11646 When generating position-independent code, emit function calls using
11647 the Global Offset Table instead of the Procedure Linkage Table.
11648
11649 @item -musermode
11650 @opindex musermode
11651 Generate a library function call to invalidate instruction cache
11652 entries, after fixing up a trampoline. This library function call
11653 doesn't assume it can write to the whole memory address space. This
11654 is the default when the target is @code{sh-*-linux*}.
11655
11656 @item -multcost=@var{number}
11657 @opindex multcost=@var{number}
11658 Set the cost to assume for a multiply insn.
11659
11660 @item -mdiv=@var{strategy}
11661 @opindex mdiv=@var{strategy}
11662 Set the division strategy to use for SHmedia code. @var{strategy} must be
11663 one of: call, call2, fp, inv, inv:minlat, inv20u, inv20l, inv:call,
11664 inv:call2, inv:fp .
11665 "fp" performs the operation in floating point. This has a very high latency,
11666 but needs only a few instructions, so it might be a good choice if
11667 your code has enough easily exploitable ILP to allow the compiler to
11668 schedule the floating point instructions together with other instructions.
11669 Division by zero causes a floating point exception.
11670 "inv" uses integer operations to calculate the inverse of the divisor,
11671 and then multiplies the dividend with the inverse. This strategy allows
11672 cse and hoisting of the inverse calculation. Division by zero calculates
11673 an unspecified result, but does not trap.
11674 "inv:minlat" is a variant of "inv" where if no cse / hoisting opportunities
11675 have been found, or if the entire operation has been hoisted to the same
11676 place, the last stages of the inverse calculation are intertwined with the
11677 final multiply to reduce the overall latency, at the expense of using a few
11678 more instructions, and thus offering fewer scheduling opportunities with
11679 other code.
11680 "call" calls a library function that usually implements the inv:minlat
11681 strategy.
11682 This gives high code density for m5-*media-nofpu compilations.
11683 "call2" uses a different entry point of the same library function, where it
11684 assumes that a pointer to a lookup table has already been set up, which
11685 exposes the pointer load to cse / code hoisting optimizations.
11686 "inv:call", "inv:call2" and "inv:fp" all use the "inv" algorithm for initial
11687 code generation, but if the code stays unoptimized, revert to the "call",
11688 "call2", or "fp" strategies, respectively. Note that the
11689 potentially-trapping side effect of division by zero is carried by a
11690 separate instruction, so it is possible that all the integer instructions
11691 are hoisted out, but the marker for the side effect stays where it is.
11692 A recombination to fp operations or a call is not possible in that case.
11693 "inv20u" and "inv20l" are variants of the "inv:minlat" strategy. In the case
11694 that the inverse calculation was nor separated from the multiply, they speed
11695 up division where the dividend fits into 20 bits (plus sign where applicable),
11696 by inserting a test to skip a number of operations in this case; this test
11697 slows down the case of larger dividends. inv20u assumes the case of a such
11698 a small dividend to be unlikely, and inv20l assumes it to be likely.
11699
11700 @item -mdivsi3_libfunc=@var{name}
11701 @opindex mdivsi3_libfunc=@var{name}
11702 Set the name of the library function used for 32 bit signed division to
11703 @var{name}. This only affect the name used in the call and inv:call
11704 division strategies, and the compiler will still expect the same
11705 sets of input/output/clobbered registers as if this option was not present.
11706
11707 @item -madjust-unroll
11708 @opindex madjust-unroll
11709 Throttle unrolling to avoid thrashing target registers.
11710 This option only has an effect if the gcc code base supports the
11711 TARGET_ADJUST_UNROLL_MAX target hook.
11712
11713 @item -mindexed-addressing
11714 @opindex mindexed-addressing
11715 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
11716 This is only safe if the hardware and/or OS implement 32 bit wrap-around
11717 semantics for the indexed addressing mode. The architecture allows the
11718 implementation of processors with 64 bit MMU, which the OS could use to
11719 get 32 bit addressing, but since no current hardware implementation supports
11720 this or any other way to make the indexed addressing mode safe to use in
11721 the 32 bit ABI, the default is -mno-indexed-addressing.
11722
11723 @item -mgettrcost=@var{number}
11724 @opindex mgettrcost=@var{number}
11725 Set the cost assumed for the gettr instruction to @var{number}.
11726 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
11727
11728 @item -mpt-fixed
11729 @opindex mpt-fixed
11730 Assume pt* instructions won't trap. This will generally generate better
11731 scheduled code, but is unsafe on current hardware. The current architecture
11732 definition says that ptabs and ptrel trap when the target anded with 3 is 3.
11733 This has the unintentional effect of making it unsafe to schedule ptabs /
11734 ptrel before a branch, or hoist it out of a loop. For example,
11735 __do_global_ctors, a part of libgcc that runs constructors at program
11736 startup, calls functions in a list which is delimited by -1. With the
11737 -mpt-fixed option, the ptabs will be done before testing against -1.
11738 That means that all the constructors will be run a bit quicker, but when
11739 the loop comes to the end of the list, the program crashes because ptabs
11740 loads -1 into a target register. Since this option is unsafe for any
11741 hardware implementing the current architecture specification, the default
11742 is -mno-pt-fixed. Unless the user specifies a specific cost with
11743 @option{-mgettrcost}, -mno-pt-fixed also implies @option{-mgettrcost=100};
11744 this deters register allocation using target registers for storing
11745 ordinary integers.
11746
11747 @item -minvalid-symbols
11748 @opindex minvalid-symbols
11749 Assume symbols might be invalid. Ordinary function symbols generated by
11750 the compiler will always be valid to load with movi/shori/ptabs or
11751 movi/shori/ptrel, but with assembler and/or linker tricks it is possible
11752 to generate symbols that will cause ptabs / ptrel to trap.
11753 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
11754 It will then prevent cross-basic-block cse, hoisting and most scheduling
11755 of symbol loads. The default is @option{-mno-invalid-symbols}.
11756 @end table
11757
11758 @node SPARC Options
11759 @subsection SPARC Options
11760 @cindex SPARC options
11761
11762 These @samp{-m} options are supported on the SPARC:
11763
11764 @table @gcctabopt
11765 @item -mno-app-regs
11766 @itemx -mapp-regs
11767 @opindex mno-app-regs
11768 @opindex mapp-regs
11769 Specify @option{-mapp-regs} to generate output using the global registers
11770 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
11771 is the default.
11772
11773 To be fully SVR4 ABI compliant at the cost of some performance loss,
11774 specify @option{-mno-app-regs}. You should compile libraries and system
11775 software with this option.
11776
11777 @item -mfpu
11778 @itemx -mhard-float
11779 @opindex mfpu
11780 @opindex mhard-float
11781 Generate output containing floating point instructions. This is the
11782 default.
11783
11784 @item -mno-fpu
11785 @itemx -msoft-float
11786 @opindex mno-fpu
11787 @opindex msoft-float
11788 Generate output containing library calls for floating point.
11789 @strong{Warning:} the requisite libraries are not available for all SPARC
11790 targets. Normally the facilities of the machine's usual C compiler are
11791 used, but this cannot be done directly in cross-compilation. You must make
11792 your own arrangements to provide suitable library functions for
11793 cross-compilation. The embedded targets @samp{sparc-*-aout} and
11794 @samp{sparclite-*-*} do provide software floating point support.
11795
11796 @option{-msoft-float} changes the calling convention in the output file;
11797 therefore, it is only useful if you compile @emph{all} of a program with
11798 this option. In particular, you need to compile @file{libgcc.a}, the
11799 library that comes with GCC, with @option{-msoft-float} in order for
11800 this to work.
11801
11802 @item -mhard-quad-float
11803 @opindex mhard-quad-float
11804 Generate output containing quad-word (long double) floating point
11805 instructions.
11806
11807 @item -msoft-quad-float
11808 @opindex msoft-quad-float
11809 Generate output containing library calls for quad-word (long double)
11810 floating point instructions. The functions called are those specified
11811 in the SPARC ABI@. This is the default.
11812
11813 As of this writing, there are no SPARC implementations that have hardware
11814 support for the quad-word floating point instructions. They all invoke
11815 a trap handler for one of these instructions, and then the trap handler
11816 emulates the effect of the instruction. Because of the trap handler overhead,
11817 this is much slower than calling the ABI library routines. Thus the
11818 @option{-msoft-quad-float} option is the default.
11819
11820 @item -mno-unaligned-doubles
11821 @itemx -munaligned-doubles
11822 @opindex mno-unaligned-doubles
11823 @opindex munaligned-doubles
11824 Assume that doubles have 8 byte alignment. This is the default.
11825
11826 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11827 alignment only if they are contained in another type, or if they have an
11828 absolute address. Otherwise, it assumes they have 4 byte alignment.
11829 Specifying this option avoids some rare compatibility problems with code
11830 generated by other compilers. It is not the default because it results
11831 in a performance loss, especially for floating point code.
11832
11833 @item -mno-faster-structs
11834 @itemx -mfaster-structs
11835 @opindex mno-faster-structs
11836 @opindex mfaster-structs
11837 With @option{-mfaster-structs}, the compiler assumes that structures
11838 should have 8 byte alignment. This enables the use of pairs of
11839 @code{ldd} and @code{std} instructions for copies in structure
11840 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11841 However, the use of this changed alignment directly violates the SPARC
11842 ABI@. Thus, it's intended only for use on targets where the developer
11843 acknowledges that their resulting code will not be directly in line with
11844 the rules of the ABI@.
11845
11846 @item -mimpure-text
11847 @opindex mimpure-text
11848 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11849 the compiler to not pass @option{-z text} to the linker when linking a
11850 shared object. Using this option, you can link position-dependent
11851 code into a shared object.
11852
11853 @option{-mimpure-text} suppresses the ``relocations remain against
11854 allocatable but non-writable sections'' linker error message.
11855 However, the necessary relocations will trigger copy-on-write, and the
11856 shared object is not actually shared across processes. Instead of
11857 using @option{-mimpure-text}, you should compile all source code with
11858 @option{-fpic} or @option{-fPIC}.
11859
11860 This option is only available on SunOS and Solaris.
11861
11862 @item -mcpu=@var{cpu_type}
11863 @opindex mcpu
11864 Set the instruction set, register set, and instruction scheduling parameters
11865 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
11866 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11867 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11868 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11869 @samp{ultrasparc3}.
11870
11871 Default instruction scheduling parameters are used for values that select
11872 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
11873 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11874
11875 Here is a list of each supported architecture and their supported
11876 implementations.
11877
11878 @smallexample
11879 v7: cypress
11880 v8: supersparc, hypersparc
11881 sparclite: f930, f934, sparclite86x
11882 sparclet: tsc701
11883 v9: ultrasparc, ultrasparc3
11884 @end smallexample
11885
11886 By default (unless configured otherwise), GCC generates code for the V7
11887 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
11888 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11889 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
11890 SPARCStation 1, 2, IPX etc.
11891
11892 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11893 architecture. The only difference from V7 code is that the compiler emits
11894 the integer multiply and integer divide instructions which exist in SPARC-V8
11895 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
11896 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11897 2000 series.
11898
11899 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11900 the SPARC architecture. This adds the integer multiply, integer divide step
11901 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11902 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11903 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
11904 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11905 MB86934 chip, which is the more recent SPARClite with FPU@.
11906
11907 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11908 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
11909 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11910 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
11911 optimizes it for the TEMIC SPARClet chip.
11912
11913 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11914 architecture. This adds 64-bit integer and floating-point move instructions,
11915 3 additional floating-point condition code registers and conditional move
11916 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
11917 optimizes it for the Sun UltraSPARC I/II chips. With
11918 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11919 Sun UltraSPARC III chip.
11920
11921 @item -mtune=@var{cpu_type}
11922 @opindex mtune
11923 Set the instruction scheduling parameters for machine type
11924 @var{cpu_type}, but do not set the instruction set or register set that the
11925 option @option{-mcpu=@var{cpu_type}} would.
11926
11927 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11928 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11929 that select a particular cpu implementation. Those are @samp{cypress},
11930 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11931 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11932 @samp{ultrasparc3}.
11933
11934 @item -mv8plus
11935 @itemx -mno-v8plus
11936 @opindex mv8plus
11937 @opindex mno-v8plus
11938 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
11939 difference from the V8 ABI is that the global and out registers are
11940 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
11941 mode for all SPARC-V9 processors.
11942
11943 @item -mvis
11944 @itemx -mno-vis
11945 @opindex mvis
11946 @opindex mno-vis
11947 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11948 Visual Instruction Set extensions. The default is @option{-mno-vis}.
11949 @end table
11950
11951 These @samp{-m} options are supported in addition to the above
11952 on SPARC-V9 processors in 64-bit environments:
11953
11954 @table @gcctabopt
11955 @item -mlittle-endian
11956 @opindex mlittle-endian
11957 Generate code for a processor running in little-endian mode. It is only
11958 available for a few configurations and most notably not on Solaris and Linux.
11959
11960 @item -m32
11961 @itemx -m64
11962 @opindex m32
11963 @opindex m64
11964 Generate code for a 32-bit or 64-bit environment.
11965 The 32-bit environment sets int, long and pointer to 32 bits.
11966 The 64-bit environment sets int to 32 bits and long and pointer
11967 to 64 bits.
11968
11969 @item -mcmodel=medlow
11970 @opindex mcmodel=medlow
11971 Generate code for the Medium/Low code model: 64-bit addresses, programs
11972 must be linked in the low 32 bits of memory. Programs can be statically
11973 or dynamically linked.
11974
11975 @item -mcmodel=medmid
11976 @opindex mcmodel=medmid
11977 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11978 must be linked in the low 44 bits of memory, the text and data segments must
11979 be less than 2GB in size and the data segment must be located within 2GB of
11980 the text segment.
11981
11982 @item -mcmodel=medany
11983 @opindex mcmodel=medany
11984 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11985 may be linked anywhere in memory, the text and data segments must be less
11986 than 2GB in size and the data segment must be located within 2GB of the
11987 text segment.
11988
11989 @item -mcmodel=embmedany
11990 @opindex mcmodel=embmedany
11991 Generate code for the Medium/Anywhere code model for embedded systems:
11992 64-bit addresses, the text and data segments must be less than 2GB in
11993 size, both starting anywhere in memory (determined at link time). The
11994 global register %g4 points to the base of the data segment. Programs
11995 are statically linked and PIC is not supported.
11996
11997 @item -mstack-bias
11998 @itemx -mno-stack-bias
11999 @opindex mstack-bias
12000 @opindex mno-stack-bias
12001 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
12002 frame pointer if present, are offset by @minus{}2047 which must be added back
12003 when making stack frame references. This is the default in 64-bit mode.
12004 Otherwise, assume no such offset is present.
12005 @end table
12006
12007 These switches are supported in addition to the above on Solaris:
12008
12009 @table @gcctabopt
12010 @item -threads
12011 @opindex threads
12012 Add support for multithreading using the Solaris threads library. This
12013 option sets flags for both the preprocessor and linker. This option does
12014 not affect the thread safety of object code produced by the compiler or
12015 that of libraries supplied with it.
12016
12017 @item -pthreads
12018 @opindex pthreads
12019 Add support for multithreading using the POSIX threads library. This
12020 option sets flags for both the preprocessor and linker. This option does
12021 not affect the thread safety of object code produced by the compiler or
12022 that of libraries supplied with it.
12023 @end table
12024
12025 @node System V Options
12026 @subsection Options for System V
12027
12028 These additional options are available on System V Release 4 for
12029 compatibility with other compilers on those systems:
12030
12031 @table @gcctabopt
12032 @item -G
12033 @opindex G
12034 Create a shared object.
12035 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
12036
12037 @item -Qy
12038 @opindex Qy
12039 Identify the versions of each tool used by the compiler, in a
12040 @code{.ident} assembler directive in the output.
12041
12042 @item -Qn
12043 @opindex Qn
12044 Refrain from adding @code{.ident} directives to the output file (this is
12045 the default).
12046
12047 @item -YP,@var{dirs}
12048 @opindex YP
12049 Search the directories @var{dirs}, and no others, for libraries
12050 specified with @option{-l}.
12051
12052 @item -Ym,@var{dir}
12053 @opindex Ym
12054 Look in the directory @var{dir} to find the M4 preprocessor.
12055 The assembler uses this option.
12056 @c This is supposed to go with a -Yd for predefined M4 macro files, but
12057 @c the generic assembler that comes with Solaris takes just -Ym.
12058 @end table
12059
12060 @node TMS320C3x/C4x Options
12061 @subsection TMS320C3x/C4x Options
12062 @cindex TMS320C3x/C4x Options
12063
12064 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
12065
12066 @table @gcctabopt
12067
12068 @item -mcpu=@var{cpu_type}
12069 @opindex mcpu
12070 Set the instruction set, register set, and instruction scheduling
12071 parameters for machine type @var{cpu_type}. Supported values for
12072 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
12073 @samp{c44}. The default is @samp{c40} to generate code for the
12074 TMS320C40.
12075
12076 @item -mbig-memory
12077 @itemx -mbig
12078 @itemx -msmall-memory
12079 @itemx -msmall
12080 @opindex mbig-memory
12081 @opindex mbig
12082 @opindex msmall-memory
12083 @opindex msmall
12084 Generates code for the big or small memory model. The small memory
12085 model assumed that all data fits into one 64K word page. At run-time
12086 the data page (DP) register must be set to point to the 64K page
12087 containing the .bss and .data program sections. The big memory model is
12088 the default and requires reloading of the DP register for every direct
12089 memory access.
12090
12091 @item -mbk
12092 @itemx -mno-bk
12093 @opindex mbk
12094 @opindex mno-bk
12095 Allow (disallow) allocation of general integer operands into the block
12096 count register BK@.
12097
12098 @item -mdb
12099 @itemx -mno-db
12100 @opindex mdb
12101 @opindex mno-db
12102 Enable (disable) generation of code using decrement and branch,
12103 DBcond(D), instructions. This is enabled by default for the C4x. To be
12104 on the safe side, this is disabled for the C3x, since the maximum
12105 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
12106 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
12107 that it can utilize the decrement and branch instruction, but will give
12108 up if there is more than one memory reference in the loop. Thus a loop
12109 where the loop counter is decremented can generate slightly more
12110 efficient code, in cases where the RPTB instruction cannot be utilized.
12111
12112 @item -mdp-isr-reload
12113 @itemx -mparanoid
12114 @opindex mdp-isr-reload
12115 @opindex mparanoid
12116 Force the DP register to be saved on entry to an interrupt service
12117 routine (ISR), reloaded to point to the data section, and restored on
12118 exit from the ISR@. This should not be required unless someone has
12119 violated the small memory model by modifying the DP register, say within
12120 an object library.
12121
12122 @item -mmpyi
12123 @itemx -mno-mpyi
12124 @opindex mmpyi
12125 @opindex mno-mpyi
12126 For the C3x use the 24-bit MPYI instruction for integer multiplies
12127 instead of a library call to guarantee 32-bit results. Note that if one
12128 of the operands is a constant, then the multiplication will be performed
12129 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
12130 then squaring operations are performed inline instead of a library call.
12131
12132 @item -mfast-fix
12133 @itemx -mno-fast-fix
12134 @opindex mfast-fix
12135 @opindex mno-fast-fix
12136 The C3x/C4x FIX instruction to convert a floating point value to an
12137 integer value chooses the nearest integer less than or equal to the
12138 floating point value rather than to the nearest integer. Thus if the
12139 floating point number is negative, the result will be incorrectly
12140 truncated an additional code is necessary to detect and correct this
12141 case. This option can be used to disable generation of the additional
12142 code required to correct the result.
12143
12144 @item -mrptb
12145 @itemx -mno-rptb
12146 @opindex mrptb
12147 @opindex mno-rptb
12148 Enable (disable) generation of repeat block sequences using the RPTB
12149 instruction for zero overhead looping. The RPTB construct is only used
12150 for innermost loops that do not call functions or jump across the loop
12151 boundaries. There is no advantage having nested RPTB loops due to the
12152 overhead required to save and restore the RC, RS, and RE registers.
12153 This is enabled by default with @option{-O2}.
12154
12155 @item -mrpts=@var{count}
12156 @itemx -mno-rpts
12157 @opindex mrpts
12158 @opindex mno-rpts
12159 Enable (disable) the use of the single instruction repeat instruction
12160 RPTS@. If a repeat block contains a single instruction, and the loop
12161 count can be guaranteed to be less than the value @var{count}, GCC will
12162 emit a RPTS instruction instead of a RPTB@. If no value is specified,
12163 then a RPTS will be emitted even if the loop count cannot be determined
12164 at compile time. Note that the repeated instruction following RPTS does
12165 not have to be reloaded from memory each iteration, thus freeing up the
12166 CPU buses for operands. However, since interrupts are blocked by this
12167 instruction, it is disabled by default.
12168
12169 @item -mloop-unsigned
12170 @itemx -mno-loop-unsigned
12171 @opindex mloop-unsigned
12172 @opindex mno-loop-unsigned
12173 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
12174 is @math{2^{31} + 1} since these instructions test if the iteration count is
12175 negative to terminate the loop. If the iteration count is unsigned
12176 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
12177 exceeded. This switch allows an unsigned iteration count.
12178
12179 @item -mti
12180 @opindex mti
12181 Try to emit an assembler syntax that the TI assembler (asm30) is happy
12182 with. This also enforces compatibility with the API employed by the TI
12183 C3x C compiler. For example, long doubles are passed as structures
12184 rather than in floating point registers.
12185
12186 @item -mregparm
12187 @itemx -mmemparm
12188 @opindex mregparm
12189 @opindex mmemparm
12190 Generate code that uses registers (stack) for passing arguments to functions.
12191 By default, arguments are passed in registers where possible rather
12192 than by pushing arguments on to the stack.
12193
12194 @item -mparallel-insns
12195 @itemx -mno-parallel-insns
12196 @opindex mparallel-insns
12197 @opindex mno-parallel-insns
12198 Allow the generation of parallel instructions. This is enabled by
12199 default with @option{-O2}.
12200
12201 @item -mparallel-mpy
12202 @itemx -mno-parallel-mpy
12203 @opindex mparallel-mpy
12204 @opindex mno-parallel-mpy
12205 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
12206 provided @option{-mparallel-insns} is also specified. These instructions have
12207 tight register constraints which can pessimize the code generation
12208 of large functions.
12209
12210 @end table
12211
12212 @node V850 Options
12213 @subsection V850 Options
12214 @cindex V850 Options
12215
12216 These @samp{-m} options are defined for V850 implementations:
12217
12218 @table @gcctabopt
12219 @item -mlong-calls
12220 @itemx -mno-long-calls
12221 @opindex mlong-calls
12222 @opindex mno-long-calls
12223 Treat all calls as being far away (near). If calls are assumed to be
12224 far away, the compiler will always load the functions address up into a
12225 register, and call indirect through the pointer.
12226
12227 @item -mno-ep
12228 @itemx -mep
12229 @opindex mno-ep
12230 @opindex mep
12231 Do not optimize (do optimize) basic blocks that use the same index
12232 pointer 4 or more times to copy pointer into the @code{ep} register, and
12233 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
12234 option is on by default if you optimize.
12235
12236 @item -mno-prolog-function
12237 @itemx -mprolog-function
12238 @opindex mno-prolog-function
12239 @opindex mprolog-function
12240 Do not use (do use) external functions to save and restore registers
12241 at the prologue and epilogue of a function. The external functions
12242 are slower, but use less code space if more than one function saves
12243 the same number of registers. The @option{-mprolog-function} option
12244 is on by default if you optimize.
12245
12246 @item -mspace
12247 @opindex mspace
12248 Try to make the code as small as possible. At present, this just turns
12249 on the @option{-mep} and @option{-mprolog-function} options.
12250
12251 @item -mtda=@var{n}
12252 @opindex mtda
12253 Put static or global variables whose size is @var{n} bytes or less into
12254 the tiny data area that register @code{ep} points to. The tiny data
12255 area can hold up to 256 bytes in total (128 bytes for byte references).
12256
12257 @item -msda=@var{n}
12258 @opindex msda
12259 Put static or global variables whose size is @var{n} bytes or less into
12260 the small data area that register @code{gp} points to. The small data
12261 area can hold up to 64 kilobytes.
12262
12263 @item -mzda=@var{n}
12264 @opindex mzda
12265 Put static or global variables whose size is @var{n} bytes or less into
12266 the first 32 kilobytes of memory.
12267
12268 @item -mv850
12269 @opindex mv850
12270 Specify that the target processor is the V850.
12271
12272 @item -mbig-switch
12273 @opindex mbig-switch
12274 Generate code suitable for big switch tables. Use this option only if
12275 the assembler/linker complain about out of range branches within a switch
12276 table.
12277
12278 @item -mapp-regs
12279 @opindex mapp-regs
12280 This option will cause r2 and r5 to be used in the code generated by
12281 the compiler. This setting is the default.
12282
12283 @item -mno-app-regs
12284 @opindex mno-app-regs
12285 This option will cause r2 and r5 to be treated as fixed registers.
12286
12287 @item -mv850e1
12288 @opindex mv850e1
12289 Specify that the target processor is the V850E1. The preprocessor
12290 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12291 this option is used.
12292
12293 @item -mv850e
12294 @opindex mv850e
12295 Specify that the target processor is the V850E@. The preprocessor
12296 constant @samp{__v850e__} will be defined if this option is used.
12297
12298 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12299 are defined then a default target processor will be chosen and the
12300 relevant @samp{__v850*__} preprocessor constant will be defined.
12301
12302 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12303 defined, regardless of which processor variant is the target.
12304
12305 @item -mdisable-callt
12306 @opindex mdisable-callt
12307 This option will suppress generation of the CALLT instruction for the
12308 v850e and v850e1 flavors of the v850 architecture. The default is
12309 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12310
12311 @end table
12312
12313 @node VAX Options
12314 @subsection VAX Options
12315 @cindex VAX options
12316
12317 These @samp{-m} options are defined for the VAX:
12318
12319 @table @gcctabopt
12320 @item -munix
12321 @opindex munix
12322 Do not output certain jump instructions (@code{aobleq} and so on)
12323 that the Unix assembler for the VAX cannot handle across long
12324 ranges.
12325
12326 @item -mgnu
12327 @opindex mgnu
12328 Do output those jump instructions, on the assumption that you
12329 will assemble with the GNU assembler.
12330
12331 @item -mg
12332 @opindex mg
12333 Output code for g-format floating point numbers instead of d-format.
12334 @end table
12335
12336 @node x86-64 Options
12337 @subsection x86-64 Options
12338 @cindex x86-64 options
12339
12340 These are listed under @xref{i386 and x86-64 Options}.
12341
12342 @node Xstormy16 Options
12343 @subsection Xstormy16 Options
12344 @cindex Xstormy16 Options
12345
12346 These options are defined for Xstormy16:
12347
12348 @table @gcctabopt
12349 @item -msim
12350 @opindex msim
12351 Choose startup files and linker script suitable for the simulator.
12352 @end table
12353
12354 @node Xtensa Options
12355 @subsection Xtensa Options
12356 @cindex Xtensa Options
12357
12358 These options are supported for Xtensa targets:
12359
12360 @table @gcctabopt
12361 @item -mconst16
12362 @itemx -mno-const16
12363 @opindex mconst16
12364 @opindex mno-const16
12365 Enable or disable use of @code{CONST16} instructions for loading
12366 constant values. The @code{CONST16} instruction is currently not a
12367 standard option from Tensilica. When enabled, @code{CONST16}
12368 instructions are always used in place of the standard @code{L32R}
12369 instructions. The use of @code{CONST16} is enabled by default only if
12370 the @code{L32R} instruction is not available.
12371
12372 @item -mfused-madd
12373 @itemx -mno-fused-madd
12374 @opindex mfused-madd
12375 @opindex mno-fused-madd
12376 Enable or disable use of fused multiply/add and multiply/subtract
12377 instructions in the floating-point option. This has no effect if the
12378 floating-point option is not also enabled. Disabling fused multiply/add
12379 and multiply/subtract instructions forces the compiler to use separate
12380 instructions for the multiply and add/subtract operations. This may be
12381 desirable in some cases where strict IEEE 754-compliant results are
12382 required: the fused multiply add/subtract instructions do not round the
12383 intermediate result, thereby producing results with @emph{more} bits of
12384 precision than specified by the IEEE standard. Disabling fused multiply
12385 add/subtract instructions also ensures that the program output is not
12386 sensitive to the compiler's ability to combine multiply and add/subtract
12387 operations.
12388
12389 @item -mtext-section-literals
12390 @itemx -mno-text-section-literals
12391 @opindex mtext-section-literals
12392 @opindex mno-text-section-literals
12393 Control the treatment of literal pools. The default is
12394 @option{-mno-text-section-literals}, which places literals in a separate
12395 section in the output file. This allows the literal pool to be placed
12396 in a data RAM/ROM, and it also allows the linker to combine literal
12397 pools from separate object files to remove redundant literals and
12398 improve code size. With @option{-mtext-section-literals}, the literals
12399 are interspersed in the text section in order to keep them as close as
12400 possible to their references. This may be necessary for large assembly
12401 files.
12402
12403 @item -mtarget-align
12404 @itemx -mno-target-align
12405 @opindex mtarget-align
12406 @opindex mno-target-align
12407 When this option is enabled, GCC instructs the assembler to
12408 automatically align instructions to reduce branch penalties at the
12409 expense of some code density. The assembler attempts to widen density
12410 instructions to align branch targets and the instructions following call
12411 instructions. If there are not enough preceding safe density
12412 instructions to align a target, no widening will be performed. The
12413 default is @option{-mtarget-align}. These options do not affect the
12414 treatment of auto-aligned instructions like @code{LOOP}, which the
12415 assembler will always align, either by widening density instructions or
12416 by inserting no-op instructions.
12417
12418 @item -mlongcalls
12419 @itemx -mno-longcalls
12420 @opindex mlongcalls
12421 @opindex mno-longcalls
12422 When this option is enabled, GCC instructs the assembler to translate
12423 direct calls to indirect calls unless it can determine that the target
12424 of a direct call is in the range allowed by the call instruction. This
12425 translation typically occurs for calls to functions in other source
12426 files. Specifically, the assembler translates a direct @code{CALL}
12427 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12428 The default is @option{-mno-longcalls}. This option should be used in
12429 programs where the call target can potentially be out of range. This
12430 option is implemented in the assembler, not the compiler, so the
12431 assembly code generated by GCC will still show direct call
12432 instructions---look at the disassembled object code to see the actual
12433 instructions. Note that the assembler will use an indirect call for
12434 every cross-file call, not just those that really will be out of range.
12435 @end table
12436
12437 @node zSeries Options
12438 @subsection zSeries Options
12439 @cindex zSeries options
12440
12441 These are listed under @xref{S/390 and zSeries Options}.
12442
12443 @node Code Gen Options
12444 @section Options for Code Generation Conventions
12445 @cindex code generation conventions
12446 @cindex options, code generation
12447 @cindex run-time options
12448
12449 These machine-independent options control the interface conventions
12450 used in code generation.
12451
12452 Most of them have both positive and negative forms; the negative form
12453 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
12454 one of the forms is listed---the one which is not the default. You
12455 can figure out the other form by either removing @samp{no-} or adding
12456 it.
12457
12458 @table @gcctabopt
12459 @item -fbounds-check
12460 @opindex fbounds-check
12461 For front-ends that support it, generate additional code to check that
12462 indices used to access arrays are within the declared range. This is
12463 currently only supported by the Java and Fortran 77 front-ends, where
12464 this option defaults to true and false respectively.
12465
12466 @item -ftrapv
12467 @opindex ftrapv
12468 This option generates traps for signed overflow on addition, subtraction,
12469 multiplication operations.
12470
12471 @item -fwrapv
12472 @opindex fwrapv
12473 This option instructs the compiler to assume that signed arithmetic
12474 overflow of addition, subtraction and multiplication wraps around
12475 using twos-complement representation. This flag enables some optimizations
12476 and disables other. This option is enabled by default for the Java
12477 front-end, as required by the Java language specification.
12478
12479 @item -fexceptions
12480 @opindex fexceptions
12481 Enable exception handling. Generates extra code needed to propagate
12482 exceptions. For some targets, this implies GCC will generate frame
12483 unwind information for all functions, which can produce significant data
12484 size overhead, although it does not affect execution. If you do not
12485 specify this option, GCC will enable it by default for languages like
12486 C++ which normally require exception handling, and disable it for
12487 languages like C that do not normally require it. However, you may need
12488 to enable this option when compiling C code that needs to interoperate
12489 properly with exception handlers written in C++. You may also wish to
12490 disable this option if you are compiling older C++ programs that don't
12491 use exception handling.
12492
12493 @item -fnon-call-exceptions
12494 @opindex fnon-call-exceptions
12495 Generate code that allows trapping instructions to throw exceptions.
12496 Note that this requires platform-specific runtime support that does
12497 not exist everywhere. Moreover, it only allows @emph{trapping}
12498 instructions to throw exceptions, i.e.@: memory references or floating
12499 point instructions. It does not allow exceptions to be thrown from
12500 arbitrary signal handlers such as @code{SIGALRM}.
12501
12502 @item -funwind-tables
12503 @opindex funwind-tables
12504 Similar to @option{-fexceptions}, except that it will just generate any needed
12505 static data, but will not affect the generated code in any other way.
12506 You will normally not enable this option; instead, a language processor
12507 that needs this handling would enable it on your behalf.
12508
12509 @item -fasynchronous-unwind-tables
12510 @opindex fasynchronous-unwind-tables
12511 Generate unwind table in dwarf2 format, if supported by target machine. The
12512 table is exact at each instruction boundary, so it can be used for stack
12513 unwinding from asynchronous events (such as debugger or garbage collector).
12514
12515 @item -fpcc-struct-return
12516 @opindex fpcc-struct-return
12517 Return ``short'' @code{struct} and @code{union} values in memory like
12518 longer ones, rather than in registers. This convention is less
12519 efficient, but it has the advantage of allowing intercallability between
12520 GCC-compiled files and files compiled with other compilers, particularly
12521 the Portable C Compiler (pcc).
12522
12523 The precise convention for returning structures in memory depends
12524 on the target configuration macros.
12525
12526 Short structures and unions are those whose size and alignment match
12527 that of some integer type.
12528
12529 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12530 switch is not binary compatible with code compiled with the
12531 @option{-freg-struct-return} switch.
12532 Use it to conform to a non-default application binary interface.
12533
12534 @item -freg-struct-return
12535 @opindex freg-struct-return
12536 Return @code{struct} and @code{union} values in registers when possible.
12537 This is more efficient for small structures than
12538 @option{-fpcc-struct-return}.
12539
12540 If you specify neither @option{-fpcc-struct-return} nor
12541 @option{-freg-struct-return}, GCC defaults to whichever convention is
12542 standard for the target. If there is no standard convention, GCC
12543 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12544 the principal compiler. In those cases, we can choose the standard, and
12545 we chose the more efficient register return alternative.
12546
12547 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12548 switch is not binary compatible with code compiled with the
12549 @option{-fpcc-struct-return} switch.
12550 Use it to conform to a non-default application binary interface.
12551
12552 @item -fshort-enums
12553 @opindex fshort-enums
12554 Allocate to an @code{enum} type only as many bytes as it needs for the
12555 declared range of possible values. Specifically, the @code{enum} type
12556 will be equivalent to the smallest integer type which has enough room.
12557
12558 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12559 code that is not binary compatible with code generated without that switch.
12560 Use it to conform to a non-default application binary interface.
12561
12562 @item -fshort-double
12563 @opindex fshort-double
12564 Use the same size for @code{double} as for @code{float}.
12565
12566 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12567 code that is not binary compatible with code generated without that switch.
12568 Use it to conform to a non-default application binary interface.
12569
12570 @item -fshort-wchar
12571 @opindex fshort-wchar
12572 Override the underlying type for @samp{wchar_t} to be @samp{short
12573 unsigned int} instead of the default for the target. This option is
12574 useful for building programs to run under WINE@.
12575
12576 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12577 code that is not binary compatible with code generated without that switch.
12578 Use it to conform to a non-default application binary interface.
12579
12580 @item -fshared-data
12581 @opindex fshared-data
12582 Requests that the data and non-@code{const} variables of this
12583 compilation be shared data rather than private data. The distinction
12584 makes sense only on certain operating systems, where shared data is
12585 shared between processes running the same program, while private data
12586 exists in one copy per process.
12587
12588 @item -fno-common
12589 @opindex fno-common
12590 In C, allocate even uninitialized global variables in the data section of the
12591 object file, rather than generating them as common blocks. This has the
12592 effect that if the same variable is declared (without @code{extern}) in
12593 two different compilations, you will get an error when you link them.
12594 The only reason this might be useful is if you wish to verify that the
12595 program will work on other systems which always work this way.
12596
12597 @item -fno-ident
12598 @opindex fno-ident
12599 Ignore the @samp{#ident} directive.
12600
12601 @item -finhibit-size-directive
12602 @opindex finhibit-size-directive
12603 Don't output a @code{.size} assembler directive, or anything else that
12604 would cause trouble if the function is split in the middle, and the
12605 two halves are placed at locations far apart in memory. This option is
12606 used when compiling @file{crtstuff.c}; you should not need to use it
12607 for anything else.
12608
12609 @item -fverbose-asm
12610 @opindex fverbose-asm
12611 Put extra commentary information in the generated assembly code to
12612 make it more readable. This option is generally only of use to those
12613 who actually need to read the generated assembly code (perhaps while
12614 debugging the compiler itself).
12615
12616 @option{-fno-verbose-asm}, the default, causes the
12617 extra information to be omitted and is useful when comparing two assembler
12618 files.
12619
12620 @item -fpic
12621 @opindex fpic
12622 @cindex global offset table
12623 @cindex PIC
12624 Generate position-independent code (PIC) suitable for use in a shared
12625 library, if supported for the target machine. Such code accesses all
12626 constant addresses through a global offset table (GOT)@. The dynamic
12627 loader resolves the GOT entries when the program starts (the dynamic
12628 loader is not part of GCC; it is part of the operating system). If
12629 the GOT size for the linked executable exceeds a machine-specific
12630 maximum size, you get an error message from the linker indicating that
12631 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12632 instead. (These maximums are 8k on the SPARC and 32k
12633 on the m68k and RS/6000. The 386 has no such limit.)
12634
12635 Position-independent code requires special support, and therefore works
12636 only on certain machines. For the 386, GCC supports PIC for System V
12637 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
12638 position-independent.
12639
12640 @item -fPIC
12641 @opindex fPIC
12642 If supported for the target machine, emit position-independent code,
12643 suitable for dynamic linking and avoiding any limit on the size of the
12644 global offset table. This option makes a difference on the m68k,
12645 PowerPC and SPARC@.
12646
12647 Position-independent code requires special support, and therefore works
12648 only on certain machines.
12649
12650 @item -fpie
12651 @itemx -fPIE
12652 @opindex fpie
12653 @opindex fPIE
12654 These options are similar to @option{-fpic} and @option{-fPIC}, but
12655 generated position independent code can be only linked into executables.
12656 Usually these options are used when @option{-pie} GCC option will be
12657 used during linking.
12658
12659 @item -fno-jump-tables
12660 @opindex fno-jump-tables
12661 Do not use jump tables for switch statements even where it would be
12662 more efficient than other code generation strategies. This option is
12663 of use in conjunction with @option{-fpic} or @option{-fPIC} for
12664 building code which forms part of a dynamic linker and cannot
12665 reference the address of a jump table. On some targets, jump tables
12666 do not require a GOT and this option is not needed.
12667
12668 @item -ffixed-@var{reg}
12669 @opindex ffixed
12670 Treat the register named @var{reg} as a fixed register; generated code
12671 should never refer to it (except perhaps as a stack pointer, frame
12672 pointer or in some other fixed role).
12673
12674 @var{reg} must be the name of a register. The register names accepted
12675 are machine-specific and are defined in the @code{REGISTER_NAMES}
12676 macro in the machine description macro file.
12677
12678 This flag does not have a negative form, because it specifies a
12679 three-way choice.
12680
12681 @item -fcall-used-@var{reg}
12682 @opindex fcall-used
12683 Treat the register named @var{reg} as an allocable register that is
12684 clobbered by function calls. It may be allocated for temporaries or
12685 variables that do not live across a call. Functions compiled this way
12686 will not save and restore the register @var{reg}.
12687
12688 It is an error to used this flag with the frame pointer or stack pointer.
12689 Use of this flag for other registers that have fixed pervasive roles in
12690 the machine's execution model will produce disastrous results.
12691
12692 This flag does not have a negative form, because it specifies a
12693 three-way choice.
12694
12695 @item -fcall-saved-@var{reg}
12696 @opindex fcall-saved
12697 Treat the register named @var{reg} as an allocable register saved by
12698 functions. It may be allocated even for temporaries or variables that
12699 live across a call. Functions compiled this way will save and restore
12700 the register @var{reg} if they use it.
12701
12702 It is an error to used this flag with the frame pointer or stack pointer.
12703 Use of this flag for other registers that have fixed pervasive roles in
12704 the machine's execution model will produce disastrous results.
12705
12706 A different sort of disaster will result from the use of this flag for
12707 a register in which function values may be returned.
12708
12709 This flag does not have a negative form, because it specifies a
12710 three-way choice.
12711
12712 @item -fpack-struct[=@var{n}]
12713 @opindex fpack-struct
12714 Without a value specified, pack all structure members together without
12715 holes. When a value is specified (which must be a small power of two), pack
12716 structure members according to this value, representing the maximum
12717 alignment (that is, objects with default alignment requirements larger than
12718 this will be output potentially unaligned at the next fitting location.
12719
12720 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12721 code that is not binary compatible with code generated without that switch.
12722 Additionally, it makes the code suboptimal.
12723 Use it to conform to a non-default application binary interface.
12724
12725 @item -finstrument-functions
12726 @opindex finstrument-functions
12727 Generate instrumentation calls for entry and exit to functions. Just
12728 after function entry and just before function exit, the following
12729 profiling functions will be called with the address of the current
12730 function and its call site. (On some platforms,
12731 @code{__builtin_return_address} does not work beyond the current
12732 function, so the call site information may not be available to the
12733 profiling functions otherwise.)
12734
12735 @smallexample
12736 void __cyg_profile_func_enter (void *this_fn,
12737 void *call_site);
12738 void __cyg_profile_func_exit (void *this_fn,
12739 void *call_site);
12740 @end smallexample
12741
12742 The first argument is the address of the start of the current function,
12743 which may be looked up exactly in the symbol table.
12744
12745 This instrumentation is also done for functions expanded inline in other
12746 functions. The profiling calls will indicate where, conceptually, the
12747 inline function is entered and exited. This means that addressable
12748 versions of such functions must be available. If all your uses of a
12749 function are expanded inline, this may mean an additional expansion of
12750 code size. If you use @samp{extern inline} in your C code, an
12751 addressable version of such functions must be provided. (This is
12752 normally the case anyways, but if you get lucky and the optimizer always
12753 expands the functions inline, you might have gotten away without
12754 providing static copies.)
12755
12756 A function may be given the attribute @code{no_instrument_function}, in
12757 which case this instrumentation will not be done. This can be used, for
12758 example, for the profiling functions listed above, high-priority
12759 interrupt routines, and any functions from which the profiling functions
12760 cannot safely be called (perhaps signal handlers, if the profiling
12761 routines generate output or allocate memory).
12762
12763 @item -fstack-check
12764 @opindex fstack-check
12765 Generate code to verify that you do not go beyond the boundary of the
12766 stack. You should specify this flag if you are running in an
12767 environment with multiple threads, but only rarely need to specify it in
12768 a single-threaded environment since stack overflow is automatically
12769 detected on nearly all systems if there is only one stack.
12770
12771 Note that this switch does not actually cause checking to be done; the
12772 operating system must do that. The switch causes generation of code
12773 to ensure that the operating system sees the stack being extended.
12774
12775 @item -fstack-limit-register=@var{reg}
12776 @itemx -fstack-limit-symbol=@var{sym}
12777 @itemx -fno-stack-limit
12778 @opindex fstack-limit-register
12779 @opindex fstack-limit-symbol
12780 @opindex fno-stack-limit
12781 Generate code to ensure that the stack does not grow beyond a certain value,
12782 either the value of a register or the address of a symbol. If the stack
12783 would grow beyond the value, a signal is raised. For most targets,
12784 the signal is raised before the stack overruns the boundary, so
12785 it is possible to catch the signal without taking special precautions.
12786
12787 For instance, if the stack starts at absolute address @samp{0x80000000}
12788 and grows downwards, you can use the flags
12789 @option{-fstack-limit-symbol=__stack_limit} and
12790 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12791 of 128KB@. Note that this may only work with the GNU linker.
12792
12793 @cindex aliasing of parameters
12794 @cindex parameters, aliased
12795 @item -fargument-alias
12796 @itemx -fargument-noalias
12797 @itemx -fargument-noalias-global
12798 @opindex fargument-alias
12799 @opindex fargument-noalias
12800 @opindex fargument-noalias-global
12801 Specify the possible relationships among parameters and between
12802 parameters and global data.
12803
12804 @option{-fargument-alias} specifies that arguments (parameters) may
12805 alias each other and may alias global storage.@*
12806 @option{-fargument-noalias} specifies that arguments do not alias
12807 each other, but may alias global storage.@*
12808 @option{-fargument-noalias-global} specifies that arguments do not
12809 alias each other and do not alias global storage.
12810
12811 Each language will automatically use whatever option is required by
12812 the language standard. You should not need to use these options yourself.
12813
12814 @item -fleading-underscore
12815 @opindex fleading-underscore
12816 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12817 change the way C symbols are represented in the object file. One use
12818 is to help link with legacy assembly code.
12819
12820 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12821 generate code that is not binary compatible with code generated without that
12822 switch. Use it to conform to a non-default application binary interface.
12823 Not all targets provide complete support for this switch.
12824
12825 @item -ftls-model=@var{model}
12826 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12827 The @var{model} argument should be one of @code{global-dynamic},
12828 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12829
12830 The default without @option{-fpic} is @code{initial-exec}; with
12831 @option{-fpic} the default is @code{global-dynamic}.
12832
12833 @item -fvisibility=@var{default|internal|hidden|protected}
12834 @opindex fvisibility
12835 Set the default ELF image symbol visibility to the specified option---all
12836 symbols will be marked with this unless overridden within the code.
12837 Using this feature can very substantially improve linking and
12838 load times of shared object libraries, produce more optimized
12839 code, provide near-perfect API export and prevent symbol clashes.
12840 It is @strong{strongly} recommended that you use this in any shared objects
12841 you distribute.
12842
12843 Despite the nomenclature, @code{default} always means public ie;
12844 available to be linked against from outside the shared object.
12845 @code{protected} and @code{internal} are pretty useless in real-world
12846 usage so the only other commonly used option will be @code{hidden}.
12847 The default if @option{-fvisibility} isn't specified is
12848 @code{default}, i.e., make every
12849 symbol public---this causes the same behavior as previous versions of
12850 GCC@.
12851
12852 A good explanation of the benefits offered by ensuring ELF
12853 symbols have the correct visibility is given by ``How To Write
12854 Shared Libraries'' by Ulrich Drepper (which can be found at
12855 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12856 solution made possible by this option to marking things hidden when
12857 the default is public is to make the default hidden and mark things
12858 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12859 and @code{__attribute__ ((visibility("default")))} instead of
12860 @code{__declspec(dllexport)} you get almost identical semantics with
12861 identical syntax. This is a great boon to those working with
12862 cross-platform projects.
12863
12864 For those adding visibility support to existing code, you may find
12865 @samp{#pragma GCC visibility} of use. This works by you enclosing
12866 the declarations you wish to set visibility for with (for example)
12867 @samp{#pragma GCC visibility push(hidden)} and
12868 @samp{#pragma GCC visibility pop}.
12869 Bear in mind that symbol visibility should be viewed @strong{as
12870 part of the API interface contract} and thus all new code should
12871 always specify visibility when it is not the default ie; declarations
12872 only for use within the local DSO should @strong{always} be marked explicitly
12873 as hidden as so to avoid PLT indirection overheads---making this
12874 abundantly clear also aids readability and self-documentation of the code.
12875 Note that due to ISO C++ specification requirements, operator new and
12876 operator delete must always be of default visibility.
12877
12878 An overview of these techniques, their benefits and how to use them
12879 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12880
12881 @end table
12882
12883 @c man end
12884
12885 @node Environment Variables
12886 @section Environment Variables Affecting GCC
12887 @cindex environment variables
12888
12889 @c man begin ENVIRONMENT
12890 This section describes several environment variables that affect how GCC
12891 operates. Some of them work by specifying directories or prefixes to use
12892 when searching for various kinds of files. Some are used to specify other
12893 aspects of the compilation environment.
12894
12895 Note that you can also specify places to search using options such as
12896 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
12897 take precedence over places specified using environment variables, which
12898 in turn take precedence over those specified by the configuration of GCC@.
12899 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12900 GNU Compiler Collection (GCC) Internals}.
12901
12902 @table @env
12903 @item LANG
12904 @itemx LC_CTYPE
12905 @c @itemx LC_COLLATE
12906 @itemx LC_MESSAGES
12907 @c @itemx LC_MONETARY
12908 @c @itemx LC_NUMERIC
12909 @c @itemx LC_TIME
12910 @itemx LC_ALL
12911 @findex LANG
12912 @findex LC_CTYPE
12913 @c @findex LC_COLLATE
12914 @findex LC_MESSAGES
12915 @c @findex LC_MONETARY
12916 @c @findex LC_NUMERIC
12917 @c @findex LC_TIME
12918 @findex LC_ALL
12919 @cindex locale
12920 These environment variables control the way that GCC uses
12921 localization information that allow GCC to work with different
12922 national conventions. GCC inspects the locale categories
12923 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12924 so. These locale categories can be set to any value supported by your
12925 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
12926 Kingdom encoded in UTF-8.
12927
12928 The @env{LC_CTYPE} environment variable specifies character
12929 classification. GCC uses it to determine the character boundaries in
12930 a string; this is needed for some multibyte encodings that contain quote
12931 and escape characters that would otherwise be interpreted as a string
12932 end or escape.
12933
12934 The @env{LC_MESSAGES} environment variable specifies the language to
12935 use in diagnostic messages.
12936
12937 If the @env{LC_ALL} environment variable is set, it overrides the value
12938 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12939 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12940 environment variable. If none of these variables are set, GCC
12941 defaults to traditional C English behavior.
12942
12943 @item TMPDIR
12944 @findex TMPDIR
12945 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12946 files. GCC uses temporary files to hold the output of one stage of
12947 compilation which is to be used as input to the next stage: for example,
12948 the output of the preprocessor, which is the input to the compiler
12949 proper.
12950
12951 @item GCC_EXEC_PREFIX
12952 @findex GCC_EXEC_PREFIX
12953 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12954 names of the subprograms executed by the compiler. No slash is added
12955 when this prefix is combined with the name of a subprogram, but you can
12956 specify a prefix that ends with a slash if you wish.
12957
12958 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12959 an appropriate prefix to use based on the pathname it was invoked with.
12960
12961 If GCC cannot find the subprogram using the specified prefix, it
12962 tries looking in the usual places for the subprogram.
12963
12964 The default value of @env{GCC_EXEC_PREFIX} is
12965 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12966 of @code{prefix} when you ran the @file{configure} script.
12967
12968 Other prefixes specified with @option{-B} take precedence over this prefix.
12969
12970 This prefix is also used for finding files such as @file{crt0.o} that are
12971 used for linking.
12972
12973 In addition, the prefix is used in an unusual way in finding the
12974 directories to search for header files. For each of the standard
12975 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12976 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12977 replacing that beginning with the specified prefix to produce an
12978 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
12979 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12980 These alternate directories are searched first; the standard directories
12981 come next.
12982
12983 @item COMPILER_PATH
12984 @findex COMPILER_PATH
12985 The value of @env{COMPILER_PATH} is a colon-separated list of
12986 directories, much like @env{PATH}. GCC tries the directories thus
12987 specified when searching for subprograms, if it can't find the
12988 subprograms using @env{GCC_EXEC_PREFIX}.
12989
12990 @item LIBRARY_PATH
12991 @findex LIBRARY_PATH
12992 The value of @env{LIBRARY_PATH} is a colon-separated list of
12993 directories, much like @env{PATH}. When configured as a native compiler,
12994 GCC tries the directories thus specified when searching for special
12995 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
12996 using GCC also uses these directories when searching for ordinary
12997 libraries for the @option{-l} option (but directories specified with
12998 @option{-L} come first).
12999
13000 @item LANG
13001 @findex LANG
13002 @cindex locale definition
13003 This variable is used to pass locale information to the compiler. One way in
13004 which this information is used is to determine the character set to be used
13005 when character literals, string literals and comments are parsed in C and C++.
13006 When the compiler is configured to allow multibyte characters,
13007 the following values for @env{LANG} are recognized:
13008
13009 @table @samp
13010 @item C-JIS
13011 Recognize JIS characters.
13012 @item C-SJIS
13013 Recognize SJIS characters.
13014 @item C-EUCJP
13015 Recognize EUCJP characters.
13016 @end table
13017
13018 If @env{LANG} is not defined, or if it has some other value, then the
13019 compiler will use mblen and mbtowc as defined by the default locale to
13020 recognize and translate multibyte characters.
13021 @end table
13022
13023 @noindent
13024 Some additional environments variables affect the behavior of the
13025 preprocessor.
13026
13027 @include cppenv.texi
13028
13029 @c man end
13030
13031 @node Precompiled Headers
13032 @section Using Precompiled Headers
13033 @cindex precompiled headers
13034 @cindex speed of compilation
13035
13036 Often large projects have many header files that are included in every
13037 source file. The time the compiler takes to process these header files
13038 over and over again can account for nearly all of the time required to
13039 build the project. To make builds faster, GCC allows users to
13040 `precompile' a header file; then, if builds can use the precompiled
13041 header file they will be much faster.
13042
13043 To create a precompiled header file, simply compile it as you would any
13044 other file, if necessary using the @option{-x} option to make the driver
13045 treat it as a C or C++ header file. You will probably want to use a
13046 tool like @command{make} to keep the precompiled header up-to-date when
13047 the headers it contains change.
13048
13049 A precompiled header file will be searched for when @code{#include} is
13050 seen in the compilation. As it searches for the included file
13051 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
13052 compiler looks for a precompiled header in each directory just before it
13053 looks for the include file in that directory. The name searched for is
13054 the name specified in the @code{#include} with @samp{.gch} appended. If
13055 the precompiled header file can't be used, it is ignored.
13056
13057 For instance, if you have @code{#include "all.h"}, and you have
13058 @file{all.h.gch} in the same directory as @file{all.h}, then the
13059 precompiled header file will be used if possible, and the original
13060 header will be used otherwise.
13061
13062 Alternatively, you might decide to put the precompiled header file in a
13063 directory and use @option{-I} to ensure that directory is searched
13064 before (or instead of) the directory containing the original header.
13065 Then, if you want to check that the precompiled header file is always
13066 used, you can put a file of the same name as the original header in this
13067 directory containing an @code{#error} command.
13068
13069 This also works with @option{-include}. So yet another way to use
13070 precompiled headers, good for projects not designed with precompiled
13071 header files in mind, is to simply take most of the header files used by
13072 a project, include them from another header file, precompile that header
13073 file, and @option{-include} the precompiled header. If the header files
13074 have guards against multiple inclusion, they will be skipped because
13075 they've already been included (in the precompiled header).
13076
13077 If you need to precompile the same header file for different
13078 languages, targets, or compiler options, you can instead make a
13079 @emph{directory} named like @file{all.h.gch}, and put each precompiled
13080 header in the directory, perhaps using @option{-o}. It doesn't matter
13081 what you call the files in the directory, every precompiled header in
13082 the directory will be considered. The first precompiled header
13083 encountered in the directory that is valid for this compilation will
13084 be used; they're searched in no particular order.
13085
13086 There are many other possibilities, limited only by your imagination,
13087 good sense, and the constraints of your build system.
13088
13089 A precompiled header file can be used only when these conditions apply:
13090
13091 @itemize
13092 @item
13093 Only one precompiled header can be used in a particular compilation.
13094
13095 @item
13096 A precompiled header can't be used once the first C token is seen. You
13097 can have preprocessor directives before a precompiled header; you can
13098 even include a precompiled header from inside another header, so long as
13099 there are no C tokens before the @code{#include}.
13100
13101 @item
13102 The precompiled header file must be produced for the same language as
13103 the current compilation. You can't use a C precompiled header for a C++
13104 compilation.
13105
13106 @item
13107 The precompiled header file must have been produced by the same compiler
13108 binary as the current compilation is using.
13109
13110 @item
13111 Any macros defined before the precompiled header is included must
13112 either be defined in the same way as when the precompiled header was
13113 generated, or must not affect the precompiled header, which usually
13114 means that they don't appear in the precompiled header at all.
13115
13116 The @option{-D} option is one way to define a macro before a
13117 precompiled header is included; using a @code{#define} can also do it.
13118 There are also some options that define macros implicitly, like
13119 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
13120 defined this way.
13121
13122 @item If debugging information is output when using the precompiled
13123 header, using @option{-g} or similar, the same kind of debugging information
13124 must have been output when building the precompiled header. However,
13125 a precompiled header built using @option{-g} can be used in a compilation
13126 when no debugging information is being output.
13127
13128 @item The same @option{-m} options must generally be used when building
13129 and using the precompiled header. @xref{Submodel Options},
13130 for any cases where this rule is relaxed.
13131
13132 @item Each of the following options must be the same when building and using
13133 the precompiled header:
13134
13135 @gccoptlist{-fexceptions -funit-at-a-time}
13136
13137 @item
13138 Some other command-line options starting with @option{-f},
13139 @option{-p}, or @option{-O} must be defined in the same way as when
13140 the precompiled header was generated. At present, it's not clear
13141 which options are safe to change and which are not; the safest choice
13142 is to use exactly the same options when generating and using the
13143 precompiled header. The following are known to be safe:
13144
13145 @gccoptlist{-fpreprocessed
13146 -fsched-interblock -fsched-spec -fsched-spec-load -fsched-spec-load-dangerous
13147 -fsched-verbose=<number> -fschedule-insns
13148 -pedantic-errors}
13149
13150 @end itemize
13151
13152 For all of these except the last, the compiler will automatically
13153 ignore the precompiled header if the conditions aren't met. If you
13154 find an option combination that doesn't work and doesn't cause the
13155 precompiled header to be ignored, please consider filing a bug report,
13156 see @ref{Bugs}.
13157
13158 If you do use differing options when generating and using the
13159 precompiled header, the actual behavior will be a mixture of the
13160 behavior for the options. For instance, if you use @option{-g} to
13161 generate the precompiled header but not when using it, you may or may
13162 not get debugging information for routines in the precompiled header.
13163
13164 @node Running Protoize
13165 @section Running Protoize
13166
13167 The program @code{protoize} is an optional part of GCC@. You can use
13168 it to add prototypes to a program, thus converting the program to ISO
13169 C in one respect. The companion program @code{unprotoize} does the
13170 reverse: it removes argument types from any prototypes that are found.
13171
13172 When you run these programs, you must specify a set of source files as
13173 command line arguments. The conversion programs start out by compiling
13174 these files to see what functions they define. The information gathered
13175 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
13176
13177 After scanning comes actual conversion. The specified files are all
13178 eligible to be converted; any files they include (whether sources or
13179 just headers) are eligible as well.
13180
13181 But not all the eligible files are converted. By default,
13182 @code{protoize} and @code{unprotoize} convert only source and header
13183 files in the current directory. You can specify additional directories
13184 whose files should be converted with the @option{-d @var{directory}}
13185 option. You can also specify particular files to exclude with the
13186 @option{-x @var{file}} option. A file is converted if it is eligible, its
13187 directory name matches one of the specified directory names, and its
13188 name within the directory has not been excluded.
13189
13190 Basic conversion with @code{protoize} consists of rewriting most
13191 function definitions and function declarations to specify the types of
13192 the arguments. The only ones not rewritten are those for varargs
13193 functions.
13194
13195 @code{protoize} optionally inserts prototype declarations at the
13196 beginning of the source file, to make them available for any calls that
13197 precede the function's definition. Or it can insert prototype
13198 declarations with block scope in the blocks where undeclared functions
13199 are called.
13200
13201 Basic conversion with @code{unprotoize} consists of rewriting most
13202 function declarations to remove any argument types, and rewriting
13203 function definitions to the old-style pre-ISO form.
13204
13205 Both conversion programs print a warning for any function declaration or
13206 definition that they can't convert. You can suppress these warnings
13207 with @option{-q}.
13208
13209 The output from @code{protoize} or @code{unprotoize} replaces the
13210 original source file. The original file is renamed to a name ending
13211 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
13212 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
13213 for DOS) file already exists, then the source file is simply discarded.
13214
13215 @code{protoize} and @code{unprotoize} both depend on GCC itself to
13216 scan the program and collect information about the functions it uses.
13217 So neither of these programs will work until GCC is installed.
13218
13219 Here is a table of the options you can use with @code{protoize} and
13220 @code{unprotoize}. Each option works with both programs unless
13221 otherwise stated.
13222
13223 @table @code
13224 @item -B @var{directory}
13225 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
13226 usual directory (normally @file{/usr/local/lib}). This file contains
13227 prototype information about standard system functions. This option
13228 applies only to @code{protoize}.
13229
13230 @item -c @var{compilation-options}
13231 Use @var{compilation-options} as the options when running @command{gcc} to
13232 produce the @samp{.X} files. The special option @option{-aux-info} is
13233 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
13234
13235 Note that the compilation options must be given as a single argument to
13236 @code{protoize} or @code{unprotoize}. If you want to specify several
13237 @command{gcc} options, you must quote the entire set of compilation options
13238 to make them a single word in the shell.
13239
13240 There are certain @command{gcc} arguments that you cannot use, because they
13241 would produce the wrong kind of output. These include @option{-g},
13242 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
13243 the @var{compilation-options}, they are ignored.
13244
13245 @item -C
13246 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
13247 systems) instead of @samp{.c}. This is convenient if you are converting
13248 a C program to C++. This option applies only to @code{protoize}.
13249
13250 @item -g
13251 Add explicit global declarations. This means inserting explicit
13252 declarations at the beginning of each source file for each function
13253 that is called in the file and was not declared. These declarations
13254 precede the first function definition that contains a call to an
13255 undeclared function. This option applies only to @code{protoize}.
13256
13257 @item -i @var{string}
13258 Indent old-style parameter declarations with the string @var{string}.
13259 This option applies only to @code{protoize}.
13260
13261 @code{unprotoize} converts prototyped function definitions to old-style
13262 function definitions, where the arguments are declared between the
13263 argument list and the initial @samp{@{}. By default, @code{unprotoize}
13264 uses five spaces as the indentation. If you want to indent with just
13265 one space instead, use @option{-i " "}.
13266
13267 @item -k
13268 Keep the @samp{.X} files. Normally, they are deleted after conversion
13269 is finished.
13270
13271 @item -l
13272 Add explicit local declarations. @code{protoize} with @option{-l} inserts
13273 a prototype declaration for each function in each block which calls the
13274 function without any declaration. This option applies only to
13275 @code{protoize}.
13276
13277 @item -n
13278 Make no real changes. This mode just prints information about the conversions
13279 that would have been done without @option{-n}.
13280
13281 @item -N
13282 Make no @samp{.save} files. The original files are simply deleted.
13283 Use this option with caution.
13284
13285 @item -p @var{program}
13286 Use the program @var{program} as the compiler. Normally, the name
13287 @file{gcc} is used.
13288
13289 @item -q
13290 Work quietly. Most warnings are suppressed.
13291
13292 @item -v
13293 Print the version number, just like @option{-v} for @command{gcc}.
13294 @end table
13295
13296 If you need special compiler options to compile one of your program's
13297 source files, then you should generate that file's @samp{.X} file
13298 specially, by running @command{gcc} on that source file with the
13299 appropriate options and the option @option{-aux-info}. Then run
13300 @code{protoize} on the entire set of files. @code{protoize} will use
13301 the existing @samp{.X} file because it is newer than the source file.
13302 For example:
13303
13304 @smallexample
13305 gcc -Dfoo=bar file1.c -aux-info file1.X
13306 protoize *.c
13307 @end smallexample
13308
13309 @noindent
13310 You need to include the special files along with the rest in the
13311 @code{protoize} command, even though their @samp{.X} files already
13312 exist, because otherwise they won't get converted.
13313
13314 @xref{Protoize Caveats}, for more information on how to use
13315 @code{protoize} successfully.