]> git.ipfire.org Git - thirdparty/gcc.git/blob - gcc/doc/invoke.texi
* doc/invoke.texi (Blackfin Options): Avoid empty @opindex line.
[thirdparty/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, @option{-fforce-mem},
106 @option{-fstrength-reduce}, @option{-Wformat} and so on. Most of
107 these have both positive and negative forms; the negative form of
108 @option{-ffoo} would be @option{-fno-foo}. This manual documents
109 only one of these two forms, whichever one is not the default.
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 @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-exceptions @gol
201 -freplace-objc-classes @gol
202 -fzero-link @gol
203 -gen-decls @gol
204 -Wno-protocol -Wselector -Wundeclared-selector}
205
206 @item Language Independent Options
207 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
208 @gccoptlist{-fmessage-length=@var{n} @gol
209 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}}
210
211 @item Warning Options
212 @xref{Warning Options,,Options to Request or Suppress Warnings}.
213 @gccoptlist{-fsyntax-only -pedantic -pedantic-errors @gol
214 -w -Wextra -Wall -Waggregate-return @gol
215 -Wcast-align -Wcast-qual -Wchar-subscripts -Wcomment @gol
216 -Wconversion -Wno-deprecated-declarations @gol
217 -Wdisabled-optimization -Wno-div-by-zero -Wno-endif-labels @gol
218 -Werror -Werror-implicit-function-declaration @gol
219 -Wfatal-errors -Wfloat-equal -Wformat -Wformat=2 @gol
220 -Wno-format-extra-args -Wformat-nonliteral @gol
221 -Wformat-security -Wformat-y2k @gol
222 -Wimplicit -Wimplicit-function-declaration -Wimplicit-int @gol
223 -Wimport -Wno-import -Winit-self -Winline @gol
224 -Wno-int-to-pointer-cast @gol
225 -Wno-invalid-offsetof -Winvalid-pch @gol
226 -Wlarger-than-@var{len} -Wlong-long @gol
227 -Wmain -Wmissing-braces -Wmissing-field-initializers @gol
228 -Wmissing-format-attribute -Wmissing-include-dirs @gol
229 -Wmissing-noreturn @gol
230 -Wno-multichar -Wnonnull -Wpacked -Wpadded @gol
231 -Wparentheses -Wpointer-arith -Wno-pointer-to-int-cast @gol
232 -Wredundant-decls @gol
233 -Wreturn-type -Wsequence-point -Wshadow @gol
234 -Wsign-compare -Wstrict-aliasing -Wstrict-aliasing=2 @gol
235 -Wswitch -Wswitch-default -Wswitch-enum @gol
236 -Wsystem-headers -Wtrigraphs -Wundef -Wuninitialized @gol
237 -Wunknown-pragmas -Wunreachable-code @gol
238 -Wunused -Wunused-function -Wunused-label -Wunused-parameter @gol
239 -Wunused-value -Wunused-variable -Wwrite-strings @gol
240 -Wvariadic-macros}
241
242 @item C-only Warning Options
243 @gccoptlist{-Wbad-function-cast -Wmissing-declarations @gol
244 -Wmissing-prototypes -Wnested-externs -Wold-style-definition @gol
245 -Wstrict-prototypes -Wtraditional @gol
246 -Wdeclaration-after-statement -Wno-pointer-sign}
247
248 @item Debugging Options
249 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
250 @gccoptlist{-d@var{letters} -dumpspecs -dumpmachine -dumpversion @gol
251 -fdump-unnumbered -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
252 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
253 -fdump-ipa-all -fdump-ipa-cgraph @gol
254 -fdump-tree-all @gol
255 -fdump-tree-original@r{[}-@var{n}@r{]} @gol
256 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
257 -fdump-tree-inlined@r{[}-@var{n}@r{]} @gol
258 -fdump-tree-cfg -fdump-tree-vcg -fdump-tree-alias @gol
259 -fdump-tree-ch @gol
260 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
261 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
262 -fdump-tree-gimple@r{[}-raw@r{]} -fdump-tree-mudflap@r{[}-@var{n}@r{]} @gol
263 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
264 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
265 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
266 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
267 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
268 -fdump-tree-nrv -fdump-tree-vect @gol
269 -fdump-tree-sink @gol
270 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
271 -fdump-tree-salias @gol
272 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
273 -ftree-vectorizer-verbose=@var{n} @gol
274 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
275 -feliminate-dwarf2-dups -feliminate-unused-debug-types @gol
276 -feliminate-unused-debug-symbols -fmem-report -fprofile-arcs -ftree-based-profiling @gol
277 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
278 -ftest-coverage -ftime-report -fvar-tracking @gol
279 -g -g@var{level} -gcoff -gdwarf-2 @gol
280 -ggdb -gstabs -gstabs+ -gvms -gxcoff -gxcoff+ @gol
281 -p -pg -print-file-name=@var{library} -print-libgcc-file-name @gol
282 -print-multi-directory -print-multi-lib @gol
283 -print-prog-name=@var{program} -print-search-dirs -Q @gol
284 -save-temps -time}
285
286 @item Optimization Options
287 @xref{Optimize Options,,Options that Control Optimization}.
288 @gccoptlist{-falign-functions=@var{n} -falign-jumps=@var{n} @gol
289 -falign-labels=@var{n} -falign-loops=@var{n} @gol
290 -fbounds-check -fmudflap -fmudflapth -fmudflapir @gol
291 -fbranch-probabilities -fprofile-values -fvpt -fbranch-target-load-optimize @gol
292 -fbranch-target-load-optimize2 -fbtr-bb-exclusive @gol
293 -fcaller-saves -fcprop-registers -fcse-follow-jumps @gol
294 -fcse-skip-blocks -fcx-limited-range -fdata-sections @gol
295 -fdelayed-branch -fdelete-null-pointer-checks @gol
296 -fexpensive-optimizations -ffast-math -ffloat-store @gol
297 -fforce-addr -fforce-mem -ffunction-sections @gol
298 -fgcse -fgcse-lm -fgcse-sm -fgcse-las -fgcse-after-reload @gol
299 -floop-optimize -fcrossjumping -fif-conversion -fif-conversion2 @gol
300 -finline-functions -finline-limit=@var{n} -fkeep-inline-functions @gol
301 -fkeep-static-consts -fmerge-constants -fmerge-all-constants @gol
302 -fmodulo-sched -fno-branch-count-reg @gol
303 -fno-default-inline -fno-defer-pop -floop-optimize2 -fmove-loop-invariants @gol
304 -fno-function-cse -fno-guess-branch-probability @gol
305 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
306 -funsafe-math-optimizations -ffinite-math-only @gol
307 -fno-trapping-math -fno-zero-initialized-in-bss @gol
308 -fomit-frame-pointer -foptimize-register-move @gol
309 -foptimize-sibling-calls -fprefetch-loop-arrays @gol
310 -fprofile-generate -fprofile-use @gol
311 -fregmove -frename-registers @gol
312 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
313 -frerun-cse-after-loop -frerun-loop-opt @gol
314 -frounding-math -fschedule-insns -fschedule-insns2 @gol
315 -fno-sched-interblock -fno-sched-spec -fsched-spec-load @gol
316 -fsched-spec-load-dangerous @gol
317 -fsched-stalled-insns=@var{n} -sched-stalled-insns-dep=@var{n} @gol
318 -fsched2-use-superblocks @gol
319 -fsched2-use-traces -freschedule-modulo-scheduled-loops @gol
320 -fsignaling-nans -fsingle-precision-constant -fspeculative-prefetching @gol
321 -fstrength-reduce -fstrict-aliasing -ftracer -fthread-jumps @gol
322 -funroll-all-loops -funroll-loops -fpeel-loops @gol
323 -fsplit-ivs-in-unroller -funswitch-loops @gol
324 -fvariable-expansion-in-unroller @gol
325 -ftree-pre -ftree-ccp -ftree-dce -ftree-loop-optimize @gol
326 -ftree-loop-linear -ftree-loop-im -ftree-loop-ivcanon -fivopts @gol
327 -ftree-dominator-opts -ftree-dse -ftree-copyrename -ftree-sink @gol
328 -ftree-ch -ftree-sra -ftree-ter -ftree-lrs -ftree-fre -ftree-vectorize @gol
329 -ftree-salias -fweb @gol
330 -ftree-copy-prop -ftree-store-ccp -ftree-store-copy-prop @gol
331 --param @var{name}=@var{value}
332 -O -O0 -O1 -O2 -O3 -Os}
333
334 @item Preprocessor Options
335 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
336 @gccoptlist{-A@var{question}=@var{answer} @gol
337 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
338 -C -dD -dI -dM -dN @gol
339 -D@var{macro}@r{[}=@var{defn}@r{]} -E -H @gol
340 -idirafter @var{dir} @gol
341 -include @var{file} -imacros @var{file} @gol
342 -iprefix @var{file} -iwithprefix @var{dir} @gol
343 -iwithprefixbefore @var{dir} -isystem @var{dir} @gol
344 -M -MM -MF -MG -MP -MQ -MT -nostdinc @gol
345 -P -fworking-directory -remap @gol
346 -trigraphs -undef -U@var{macro} -Wp,@var{option} @gol
347 -Xpreprocessor @var{option}}
348
349 @item Assembler Option
350 @xref{Assembler Options,,Passing Options to the Assembler}.
351 @gccoptlist{-Wa,@var{option} -Xassembler @var{option}}
352
353 @item Linker Options
354 @xref{Link Options,,Options for Linking}.
355 @gccoptlist{@var{object-file-name} -l@var{library} @gol
356 -nostartfiles -nodefaultlibs -nostdlib -pie @gol
357 -s -static -static-libgcc -shared -shared-libgcc -symbolic @gol
358 -Wl,@var{option} -Xlinker @var{option} @gol
359 -u @var{symbol}}
360
361 @item Directory Options
362 @xref{Directory Options,,Options for Directory Search}.
363 @gccoptlist{-B@var{prefix} -I@var{dir} -iquote@var{dir} -L@var{dir} -specs=@var{file} -I-}
364
365 @item Target Options
366 @c I wrote this xref this way to avoid overfull hbox. -- rms
367 @xref{Target Options}.
368 @gccoptlist{-V @var{version} -b @var{machine}}
369
370 @item Machine Dependent Options
371 @xref{Submodel Options,,Hardware Models and Configurations}.
372 @c This list is ordered alphanumerically by subsection name.
373 @c Try and put the significant identifier (CPU or system) first,
374 @c so users have a clue at guessing where the ones they want will be.
375
376 @emph{ARC Options}
377 @gccoptlist{-EB -EL @gol
378 -mmangle-cpu -mcpu=@var{cpu} -mtext=@var{text-section} @gol
379 -mdata=@var{data-section} -mrodata=@var{readonly-data-section}}
380
381 @emph{ARM Options}
382 @gccoptlist{-mapcs-frame -mno-apcs-frame @gol
383 -mabi=@var{name} @gol
384 -mapcs-stack-check -mno-apcs-stack-check @gol
385 -mapcs-float -mno-apcs-float @gol
386 -mapcs-reentrant -mno-apcs-reentrant @gol
387 -msched-prolog -mno-sched-prolog @gol
388 -mlittle-endian -mbig-endian -mwords-little-endian @gol
389 -mfloat-abi=@var{name} -msoft-float -mhard-float -mfpe @gol
390 -mthumb-interwork -mno-thumb-interwork @gol
391 -mcpu=@var{name} -march=@var{name} -mfpu=@var{name} @gol
392 -mstructure-size-boundary=@var{n} @gol
393 -mabort-on-noreturn @gol
394 -mlong-calls -mno-long-calls @gol
395 -msingle-pic-base -mno-single-pic-base @gol
396 -mpic-register=@var{reg} @gol
397 -mnop-fun-dllimport @gol
398 -mcirrus-fix-invalid-insns -mno-cirrus-fix-invalid-insns @gol
399 -mpoke-function-name @gol
400 -mthumb -marm @gol
401 -mtpcs-frame -mtpcs-leaf-frame @gol
402 -mcaller-super-interworking -mcallee-super-interworking}
403
404 @emph{AVR Options}
405 @gccoptlist{-mmcu=@var{mcu} -msize -minit-stack=@var{n} -mno-interrupts @gol
406 -mcall-prologues -mno-tablejump -mtiny-stack -mint8}
407
408 @emph{Blackfin Options}
409 @gccoptlist{-momit-leaf-frame-pointer -mno-omit-leaf-frame-pointer -mcsync @gol
410 -mno-csync -mlow-64k -mno-low64k -mid-shared-library @gol
411 -mno-id-shared-library -mshared-library-id=@var{n} @gol}
412
413 @emph{CRIS Options}
414 @gccoptlist{-mcpu=@var{cpu} -march=@var{cpu} -mtune=@var{cpu} @gol
415 -mmax-stack-frame=@var{n} -melinux-stacksize=@var{n} @gol
416 -metrax4 -metrax100 -mpdebug -mcc-init -mno-side-effects @gol
417 -mstack-align -mdata-align -mconst-align @gol
418 -m32-bit -m16-bit -m8-bit -mno-prologue-epilogue -mno-gotplt @gol
419 -melf -maout -melinux -mlinux -sim -sim2 @gol
420 -mmul-bug-workaround -mno-mul-bug-workaround}
421
422 @emph{Darwin Options}
423 @gccoptlist{-all_load -allowable_client -arch -arch_errors_fatal @gol
424 -arch_only -bind_at_load -bundle -bundle_loader @gol
425 -client_name -compatibility_version -current_version @gol
426 -dead_strip @gol
427 -dependency-file -dylib_file -dylinker_install_name @gol
428 -dynamic -dynamiclib -exported_symbols_list @gol
429 -filelist -flat_namespace -force_cpusubtype_ALL @gol
430 -force_flat_namespace -headerpad_max_install_names @gol
431 -image_base -init -install_name -keep_private_externs @gol
432 -multi_module -multiply_defined -multiply_defined_unused @gol
433 -noall_load -no_dead_strip_inits_and_terms @gol
434 -nofixprebinding -nomultidefs -noprebind -noseglinkedit @gol
435 -pagezero_size -prebind -prebind_all_twolevel_modules @gol
436 -private_bundle -read_only_relocs -sectalign @gol
437 -sectobjectsymbols -whyload -seg1addr @gol
438 -sectcreate -sectobjectsymbols -sectorder @gol
439 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
440 -seg_addr_table -seg_addr_table_filename -seglinkedit @gol
441 -segprot -segs_read_only_addr -segs_read_write_addr @gol
442 -single_module -static -sub_library -sub_umbrella @gol
443 -twolevel_namespace -umbrella -undefined @gol
444 -unexported_symbols_list -weak_reference_mismatches @gol
445 -whatsloaded -F -gused -gfull -mone-byte-bool}
446
447 @emph{DEC Alpha Options}
448 @gccoptlist{-mno-fp-regs -msoft-float -malpha-as -mgas @gol
449 -mieee -mieee-with-inexact -mieee-conformant @gol
450 -mfp-trap-mode=@var{mode} -mfp-rounding-mode=@var{mode} @gol
451 -mtrap-precision=@var{mode} -mbuild-constants @gol
452 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} @gol
453 -mbwx -mmax -mfix -mcix @gol
454 -mfloat-vax -mfloat-ieee @gol
455 -mexplicit-relocs -msmall-data -mlarge-data @gol
456 -msmall-text -mlarge-text @gol
457 -mmemory-latency=@var{time}}
458
459 @emph{DEC Alpha/VMS Options}
460 @gccoptlist{-mvms-return-codes}
461
462 @emph{FRV Options}
463 @gccoptlist{-mgpr-32 -mgpr-64 -mfpr-32 -mfpr-64 @gol
464 -mhard-float -msoft-float @gol
465 -malloc-cc -mfixed-cc -mdword -mno-dword @gol
466 -mdouble -mno-double @gol
467 -mmedia -mno-media -mmuladd -mno-muladd @gol
468 -mfdpic -minline-plt -mgprel-ro -multilib-library-pic @gol
469 -mlinked-fp -mlong-calls -malign-labels @gol
470 -mlibrary-pic -macc-4 -macc-8 @gol
471 -mpack -mno-pack -mno-eflags -mcond-move -mno-cond-move @gol
472 -mscc -mno-scc -mcond-exec -mno-cond-exec @gol
473 -mvliw-branch -mno-vliw-branch @gol
474 -mmulti-cond-exec -mno-multi-cond-exec -mnested-cond-exec @gol
475 -mno-nested-cond-exec -mtomcat-stats @gol
476 -mTLS -mtls @gol
477 -mcpu=@var{cpu}}
478
479 @emph{H8/300 Options}
480 @gccoptlist{-mrelax -mh -ms -mn -mint32 -malign-300}
481
482 @emph{HPPA Options}
483 @gccoptlist{-march=@var{architecture-type} @gol
484 -mbig-switch -mdisable-fpregs -mdisable-indexing @gol
485 -mfast-indirect-calls -mgas -mgnu-ld -mhp-ld @gol
486 -mfixed-range=@var{register-range} @gol
487 -mjump-in-delay -mlinker-opt -mlong-calls @gol
488 -mlong-load-store -mno-big-switch -mno-disable-fpregs @gol
489 -mno-disable-indexing -mno-fast-indirect-calls -mno-gas @gol
490 -mno-jump-in-delay -mno-long-load-store @gol
491 -mno-portable-runtime -mno-soft-float @gol
492 -mno-space-regs -msoft-float -mpa-risc-1-0 @gol
493 -mpa-risc-1-1 -mpa-risc-2-0 -mportable-runtime @gol
494 -mschedule=@var{cpu-type} -mspace-regs -msio -mwsio @gol
495 -munix=@var{unix-std} -nolibdld -static -threads}
496
497 @emph{i386 and x86-64 Options}
498 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
499 -mfpmath=@var{unit} @gol
500 -masm=@var{dialect} -mno-fancy-math-387 @gol
501 -mno-fp-ret-in-387 -msoft-float -msvr3-shlib @gol
502 -mno-wide-multiply -mrtd -malign-double @gol
503 -mpreferred-stack-boundary=@var{num} @gol
504 -mmmx -msse -msse2 -msse3 -m3dnow @gol
505 -mthreads -mno-align-stringops -minline-all-stringops @gol
506 -mpush-args -maccumulate-outgoing-args -m128bit-long-double @gol
507 -m96bit-long-double -mregparm=@var{num} -momit-leaf-frame-pointer @gol
508 -mno-red-zone -mno-tls-direct-seg-refs @gol
509 -mcmodel=@var{code-model} @gol
510 -m32 -m64}
511
512 @emph{IA-64 Options}
513 @gccoptlist{-mbig-endian -mlittle-endian -mgnu-as -mgnu-ld -mno-pic @gol
514 -mvolatile-asm-stop -mregister-names -mno-sdata @gol
515 -mconstant-gp -mauto-pic -minline-float-divide-min-latency @gol
516 -minline-float-divide-max-throughput @gol
517 -minline-int-divide-min-latency @gol
518 -minline-int-divide-max-throughput @gol
519 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
520 -mno-dwarf2-asm -mearly-stop-bits @gol
521 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
522 -mtune=@var{cpu-type} -mt -pthread -milp32 -mlp64}
523
524 @emph{M32R/D Options}
525 @gccoptlist{-m32r2 -m32rx -m32r @gol
526 -mdebug @gol
527 -malign-loops -mno-align-loops @gol
528 -missue-rate=@var{number} @gol
529 -mbranch-cost=@var{number} @gol
530 -mmodel=@var{code-size-model-type} @gol
531 -msdata=@var{sdata-type} @gol
532 -mno-flush-func -mflush-func=@var{name} @gol
533 -mno-flush-trap -mflush-trap=@var{number} @gol
534 -G @var{num}}
535
536 @emph{M680x0 Options}
537 @gccoptlist{-m68000 -m68020 -m68020-40 -m68020-60 -m68030 -m68040 @gol
538 -m68060 -mcpu32 -m5200 -m68881 -mbitfield -mc68000 -mc68020 @gol
539 -mnobitfield -mrtd -mshort -msoft-float -mpcrel @gol
540 -malign-int -mstrict-align -msep-data -mno-sep-data @gol
541 -mshared-library-id=n -mid-shared-library -mno-id-shared-library}
542
543 @emph{M68hc1x Options}
544 @gccoptlist{-m6811 -m6812 -m68hc11 -m68hc12 -m68hcs12 @gol
545 -mauto-incdec -minmax -mlong-calls -mshort @gol
546 -msoft-reg-count=@var{count}}
547
548 @emph{MCore Options}
549 @gccoptlist{-mhardlit -mno-hardlit -mdiv -mno-div -mrelax-immediates @gol
550 -mno-relax-immediates -mwide-bitfields -mno-wide-bitfields @gol
551 -m4byte-functions -mno-4byte-functions -mcallgraph-data @gol
552 -mno-callgraph-data -mslow-bytes -mno-slow-bytes -mno-lsim @gol
553 -mlittle-endian -mbig-endian -m210 -m340 -mstack-increment}
554
555 @emph{MIPS Options}
556 @gccoptlist{-EL -EB -march=@var{arch} -mtune=@var{arch} @gol
557 -mips1 -mips2 -mips3 -mips4 -mips32 -mips32r2 -mips64 @gol
558 -mips16 -mno-mips16 -mabi=@var{abi} -mabicalls -mno-abicalls @gol
559 -mxgot -mno-xgot -mgp32 -mgp64 -mfp32 -mfp64 @gol
560 -mhard-float -msoft-float -msingle-float -mdouble-float @gol
561 -mpaired-single -mips3d @gol
562 -mint64 -mlong64 -mlong32 -msym32 -mno-sym32 @gol
563 -G@var{num} -membedded-data -mno-embedded-data @gol
564 -muninit-const-in-rodata -mno-uninit-const-in-rodata @gol
565 -msplit-addresses -mno-split-addresses @gol
566 -mexplicit-relocs -mno-explicit-relocs @gol
567 -mcheck-zero-division -mno-check-zero-division @gol
568 -mdivide-traps -mdivide-breaks @gol
569 -mmemcpy -mno-memcpy -mlong-calls -mno-long-calls @gol
570 -mmad -mno-mad -mfused-madd -mno-fused-madd -nocpp @gol
571 -mfix-r4000 -mno-fix-r4000 -mfix-r4400 -mno-fix-r4400 @gol
572 -mfix-vr4120 -mno-fix-vr4120 -mfix-vr4130 @gol
573 -mfix-sb1 -mno-fix-sb1 @gol
574 -mflush-func=@var{func} -mno-flush-func @gol
575 -mbranch-likely -mno-branch-likely @gol
576 -mfp-exceptions -mno-fp-exceptions @gol
577 -mvr4130-align -mno-vr4130-align}
578
579 @emph{MMIX Options}
580 @gccoptlist{-mlibfuncs -mno-libfuncs -mepsilon -mno-epsilon -mabi=gnu @gol
581 -mabi=mmixware -mzero-extend -mknuthdiv -mtoplevel-symbols @gol
582 -melf -mbranch-predict -mno-branch-predict -mbase-addresses @gol
583 -mno-base-addresses -msingle-exit -mno-single-exit}
584
585 @emph{MN10300 Options}
586 @gccoptlist{-mmult-bug -mno-mult-bug @gol
587 -mam33 -mno-am33 @gol
588 -mam33-2 -mno-am33-2 @gol
589 -mno-crt0 -mrelax}
590
591 @emph{NS32K Options}
592 @gccoptlist{-m32032 -m32332 -m32532 -m32081 -m32381 @gol
593 -mmult-add -mnomult-add -msoft-float -mrtd -mnortd @gol
594 -mregparam -mnoregparam -msb -mnosb @gol
595 -mbitfield -mnobitfield -mhimem -mnohimem}
596
597 @emph{PDP-11 Options}
598 @gccoptlist{-mfpu -msoft-float -mac0 -mno-ac0 -m40 -m45 -m10 @gol
599 -mbcopy -mbcopy-builtin -mint32 -mno-int16 @gol
600 -mint16 -mno-int32 -mfloat32 -mno-float64 @gol
601 -mfloat64 -mno-float32 -mabshi -mno-abshi @gol
602 -mbranch-expensive -mbranch-cheap @gol
603 -msplit -mno-split -munix-asm -mdec-asm}
604
605 @emph{PowerPC Options}
606 See RS/6000 and PowerPC Options.
607
608 @emph{RS/6000 and PowerPC Options}
609 @gccoptlist{-mcpu=@var{cpu-type} @gol
610 -mtune=@var{cpu-type} @gol
611 -mpower -mno-power -mpower2 -mno-power2 @gol
612 -mpowerpc -mpowerpc64 -mno-powerpc @gol
613 -maltivec -mno-altivec @gol
614 -mpowerpc-gpopt -mno-powerpc-gpopt @gol
615 -mpowerpc-gfxopt -mno-powerpc-gfxopt @gol
616 -mnew-mnemonics -mold-mnemonics @gol
617 -mfull-toc -mminimal-toc -mno-fp-in-toc -mno-sum-in-toc @gol
618 -m64 -m32 -mxl-compat -mno-xl-compat -mpe @gol
619 -malign-power -malign-natural @gol
620 -msoft-float -mhard-float -mmultiple -mno-multiple @gol
621 -mstring -mno-string -mupdate -mno-update @gol
622 -mfused-madd -mno-fused-madd -mbit-align -mno-bit-align @gol
623 -mstrict-align -mno-strict-align -mrelocatable @gol
624 -mno-relocatable -mrelocatable-lib -mno-relocatable-lib @gol
625 -mtoc -mno-toc -mlittle -mlittle-endian -mbig -mbig-endian @gol
626 -mdynamic-no-pic @gol
627 -mprioritize-restricted-insns=@var{priority} @gol
628 -msched-costly-dep=@var{dependence_type} @gol
629 -minsert-sched-nops=@var{scheme} @gol
630 -mcall-sysv -mcall-netbsd @gol
631 -maix-struct-return -msvr4-struct-return @gol
632 -mabi=altivec -mabi=no-altivec @gol
633 -mabi=spe -mabi=no-spe @gol
634 -misel=yes -misel=no @gol
635 -mspe=yes -mspe=no @gol
636 -mfloat-gprs=yes -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
637 -mprototype -mno-prototype @gol
638 -msim -mmvme -mads -myellowknife -memb -msdata @gol
639 -msdata=@var{opt} -mvxworks -mwindiss -G @var{num} -pthread}
640
641 @emph{S/390 and zSeries Options}
642 @gccoptlist{-mtune=@var{cpu-type} -march=@var{cpu-type} @gol
643 -mhard-float -msoft-float -mbackchain -mno-backchain @gol
644 -mpacked-stack -mno-packed-stack @gol
645 -msmall-exec -mno-small-exec -mmvcle -mno-mvcle @gol
646 -m64 -m31 -mdebug -mno-debug -mesa -mzarch @gol
647 -mtpf-trace -mno-tpf-trace -mfused-madd -mno-fused-madd @gol
648 -mwarn-framesize -mwarn-dynamicstack -mstack-size -mstack-guard}
649
650 @emph{SH Options}
651 @gccoptlist{-m1 -m2 -m2e -m3 -m3e @gol
652 -m4-nofpu -m4-single-only -m4-single -m4 @gol
653 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
654 -m5-64media -m5-64media-nofpu @gol
655 -m5-32media -m5-32media-nofpu @gol
656 -m5-compact -m5-compact-nofpu @gol
657 -mb -ml -mdalign -mrelax @gol
658 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
659 -mieee -misize -mpadstruct -mspace @gol
660 -mprefergot -musermode}
661
662 @emph{SPARC Options}
663 @gccoptlist{-mcpu=@var{cpu-type} @gol
664 -mtune=@var{cpu-type} @gol
665 -mcmodel=@var{code-model} @gol
666 -m32 -m64 -mapp-regs -mno-app-regs @gol
667 -mfaster-structs -mno-faster-structs @gol
668 -mfpu -mno-fpu -mhard-float -msoft-float @gol
669 -mhard-quad-float -msoft-quad-float @gol
670 -mimpure-text -mno-impure-text -mlittle-endian @gol
671 -mstack-bias -mno-stack-bias @gol
672 -munaligned-doubles -mno-unaligned-doubles @gol
673 -mv8plus -mno-v8plus -mvis -mno-vis
674 -threads -pthreads}
675
676 @emph{System V Options}
677 @gccoptlist{-Qy -Qn -YP,@var{paths} -Ym,@var{dir}}
678
679 @emph{TMS320C3x/C4x Options}
680 @gccoptlist{-mcpu=@var{cpu} -mbig -msmall -mregparm -mmemparm @gol
681 -mfast-fix -mmpyi -mbk -mti -mdp-isr-reload @gol
682 -mrpts=@var{count} -mrptb -mdb -mloop-unsigned @gol
683 -mparallel-insns -mparallel-mpy -mpreserve-float}
684
685 @emph{V850 Options}
686 @gccoptlist{-mlong-calls -mno-long-calls -mep -mno-ep @gol
687 -mprolog-function -mno-prolog-function -mspace @gol
688 -mtda=@var{n} -msda=@var{n} -mzda=@var{n} @gol
689 -mapp-regs -mno-app-regs @gol
690 -mdisable-callt -mno-disable-callt @gol
691 -mv850e1 @gol
692 -mv850e @gol
693 -mv850 -mbig-switch}
694
695 @emph{VAX Options}
696 @gccoptlist{-mg -mgnu -munix}
697
698 @emph{x86-64 Options}
699 See i386 and x86-64 Options.
700
701 @emph{Xstormy16 Options}
702 @gccoptlist{-msim}
703
704 @emph{Xtensa Options}
705 @gccoptlist{-mconst16 -mno-const16 @gol
706 -mfused-madd -mno-fused-madd @gol
707 -mtext-section-literals -mno-text-section-literals @gol
708 -mtarget-align -mno-target-align @gol
709 -mlongcalls -mno-longcalls}
710
711 @emph{zSeries Options}
712 See S/390 and zSeries Options.
713
714 @item Code Generation Options
715 @xref{Code Gen Options,,Options for Code Generation Conventions}.
716 @gccoptlist{-fcall-saved-@var{reg} -fcall-used-@var{reg} @gol
717 -ffixed-@var{reg} -fexceptions @gol
718 -fnon-call-exceptions -funwind-tables @gol
719 -fasynchronous-unwind-tables @gol
720 -finhibit-size-directive -finstrument-functions @gol
721 -fno-common -fno-ident @gol
722 -fpcc-struct-return -fpic -fPIC -fpie -fPIE @gol
723 -freg-struct-return -fshared-data -fshort-enums @gol
724 -fshort-double -fshort-wchar @gol
725 -fverbose-asm -fpack-struct[=@var{n}] -fstack-check @gol
726 -fstack-limit-register=@var{reg} -fstack-limit-symbol=@var{sym} @gol
727 -fargument-alias -fargument-noalias @gol
728 -fargument-noalias-global -fleading-underscore @gol
729 -ftls-model=@var{model} @gol
730 -ftrapv -fwrapv -fbounds-check @gol
731 -fvisibility}
732 @end table
733
734 @menu
735 * Overall Options:: Controlling the kind of output:
736 an executable, object files, assembler files,
737 or preprocessed source.
738 * C Dialect Options:: Controlling the variant of C language compiled.
739 * C++ Dialect Options:: Variations on C++.
740 * Objective-C and Objective-C++ Dialect Options:: Variations on Objective-C
741 and Objective-C++.
742 * Language Independent Options:: Controlling how diagnostics should be
743 formatted.
744 * Warning Options:: How picky should the compiler be?
745 * Debugging Options:: Symbol tables, measurements, and debugging dumps.
746 * Optimize Options:: How much optimization?
747 * Preprocessor Options:: Controlling header files and macro definitions.
748 Also, getting dependency information for Make.
749 * Assembler Options:: Passing options to the assembler.
750 * Link Options:: Specifying libraries and so on.
751 * Directory Options:: Where to find header files and libraries.
752 Where to find the compiler executable files.
753 * Spec Files:: How to pass switches to sub-processes.
754 * Target Options:: Running a cross-compiler, or an old version of GCC.
755 @end menu
756
757 @node Overall Options
758 @section Options Controlling the Kind of Output
759
760 Compilation can involve up to four stages: preprocessing, compilation
761 proper, assembly and linking, always in that order. GCC is capable of
762 preprocessing and compiling several files either into several
763 assembler input files, or into one assembler input file; then each
764 assembler input file produces an object file, and linking combines all
765 the object files (those newly compiled, and those specified as input)
766 into an executable file.
767
768 @cindex file name suffix
769 For any given input file, the file name suffix determines what kind of
770 compilation is done:
771
772 @table @gcctabopt
773 @item @var{file}.c
774 C source code which must be preprocessed.
775
776 @item @var{file}.i
777 C source code which should not be preprocessed.
778
779 @item @var{file}.ii
780 C++ source code which should not be preprocessed.
781
782 @item @var{file}.m
783 Objective-C source code. Note that you must link with the @file{libobjc}
784 library to make an Objective-C program work.
785
786 @item @var{file}.mi
787 Objective-C source code which should not be preprocessed.
788
789 @item @var{file}.mm
790 @itemx @var{file}.M
791 Objective-C++ source code. Note that you must link with the @file{libobjc}
792 library to make an Objective-C++ program work. Note that @samp{.M} refers
793 to a literal capital M@.
794
795 @item @var{file}.mii
796 Objective-C++ source code which should not be preprocessed.
797
798 @item @var{file}.h
799 C, C++, Objective-C or Objective-C++ header file to be turned into a
800 precompiled header.
801
802 @item @var{file}.cc
803 @itemx @var{file}.cp
804 @itemx @var{file}.cxx
805 @itemx @var{file}.cpp
806 @itemx @var{file}.CPP
807 @itemx @var{file}.c++
808 @itemx @var{file}.C
809 C++ source code which must be preprocessed. Note that in @samp{.cxx},
810 the last two letters must both be literally @samp{x}. Likewise,
811 @samp{.C} refers to a literal capital C@.
812
813 @item @var{file}.hh
814 @itemx @var{file}.H
815 C++ header file to be turned into a precompiled header.
816
817 @item @var{file}.f
818 @itemx @var{file}.for
819 @itemx @var{file}.FOR
820 Fortran source code which should not be preprocessed.
821
822 @item @var{file}.F
823 @itemx @var{file}.fpp
824 @itemx @var{file}.FPP
825 Fortran source code which must be preprocessed (with the traditional
826 preprocessor).
827
828 @item @var{file}.r
829 Fortran source code which must be preprocessed with a RATFOR
830 preprocessor (not included with GCC)@.
831
832 @item @var{file}.f90
833 @itemx @var{file}.f95
834 Fortran 90/95 source code which should not be preprocessed.
835
836 @c FIXME: Descriptions of Java file types.
837 @c @var{file}.java
838 @c @var{file}.class
839 @c @var{file}.zip
840 @c @var{file}.jar
841
842 @item @var{file}.ads
843 Ada source code file which contains a library unit declaration (a
844 declaration of a package, subprogram, or generic, or a generic
845 instantiation), or a library unit renaming declaration (a package,
846 generic, or subprogram renaming declaration). Such files are also
847 called @dfn{specs}.
848
849 @itemx @var{file}.adb
850 Ada source code file containing a library unit body (a subprogram or
851 package body). Such files are also called @dfn{bodies}.
852
853 @c GCC also knows about some suffixes for languages not yet included:
854 @c Pascal:
855 @c @var{file}.p
856 @c @var{file}.pas
857
858 @item @var{file}.s
859 Assembler code.
860
861 @item @var{file}.S
862 Assembler code which must be preprocessed.
863
864 @item @var{other}
865 An object file to be fed straight into linking.
866 Any file name with no recognized suffix is treated this way.
867 @end table
868
869 @opindex x
870 You can specify the input language explicitly with the @option{-x} option:
871
872 @table @gcctabopt
873 @item -x @var{language}
874 Specify explicitly the @var{language} for the following input files
875 (rather than letting the compiler choose a default based on the file
876 name suffix). This option applies to all following input files until
877 the next @option{-x} option. Possible values for @var{language} are:
878 @smallexample
879 c c-header c-cpp-output
880 c++ c++-header c++-cpp-output
881 objective-c objective-c-header objective-c-cpp-output
882 objective-c++ objective-c++-header objective-c++-cpp-output
883 assembler assembler-with-cpp
884 ada
885 f77 f77-cpp-input ratfor
886 f95
887 java
888 treelang
889 @end smallexample
890
891 @item -x none
892 Turn off any specification of a language, so that subsequent files are
893 handled according to their file name suffixes (as they are if @option{-x}
894 has not been used at all).
895
896 @item -pass-exit-codes
897 @opindex pass-exit-codes
898 Normally the @command{gcc} program will exit with the code of 1 if any
899 phase of the compiler returns a non-success return code. If you specify
900 @option{-pass-exit-codes}, the @command{gcc} program will instead return with
901 numerically highest error produced by any phase that returned an error
902 indication.
903 @end table
904
905 If you only want some of the stages of compilation, you can use
906 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
907 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
908 @command{gcc} is to stop. Note that some combinations (for example,
909 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
910
911 @table @gcctabopt
912 @item -c
913 @opindex c
914 Compile or assemble the source files, but do not link. The linking
915 stage simply is not done. The ultimate output is in the form of an
916 object file for each source file.
917
918 By default, the object file name for a source file is made by replacing
919 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
920
921 Unrecognized input files, not requiring compilation or assembly, are
922 ignored.
923
924 @item -S
925 @opindex S
926 Stop after the stage of compilation proper; do not assemble. The output
927 is in the form of an assembler code file for each non-assembler input
928 file specified.
929
930 By default, the assembler file name for a source file is made by
931 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
932
933 Input files that don't require compilation are ignored.
934
935 @item -E
936 @opindex E
937 Stop after the preprocessing stage; do not run the compiler proper. The
938 output is in the form of preprocessed source code, which is sent to the
939 standard output.
940
941 Input files which don't require preprocessing are ignored.
942
943 @cindex output file option
944 @item -o @var{file}
945 @opindex o
946 Place output in file @var{file}. This applies regardless to whatever
947 sort of output is being produced, whether it be an executable file,
948 an object file, an assembler file or preprocessed C code.
949
950 If @option{-o} is not specified, the default is to put an executable
951 file in @file{a.out}, the object file for
952 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
953 assembler file in @file{@var{source}.s}, a precompiled header file in
954 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
955 standard output.
956
957 @item -v
958 @opindex v
959 Print (on standard error output) the commands executed to run the stages
960 of compilation. Also print the version number of the compiler driver
961 program and of the preprocessor and the compiler proper.
962
963 @item -###
964 @opindex ###
965 Like @option{-v} except the commands are not executed and all command
966 arguments are quoted. This is useful for shell scripts to capture the
967 driver-generated command lines.
968
969 @item -pipe
970 @opindex pipe
971 Use pipes rather than temporary files for communication between the
972 various stages of compilation. This fails to work on some systems where
973 the assembler is unable to read from a pipe; but the GNU assembler has
974 no trouble.
975
976 @item -combine
977 @opindex combine
978 If you are compiling multiple source files, this option tells the driver
979 to pass all the source files to the compiler at once (for those
980 languages for which the compiler can handle this). This will allow
981 intermodule analysis (IMA) to be performed by the compiler. Currently the only
982 language for which this is supported is C@. If you pass source files for
983 multiple languages to the driver, using this option, the driver will invoke
984 the compiler(s) that support IMA once each, passing each compiler all the
985 source files appropriate for it. For those languages that do not support
986 IMA this option will be ignored, and the compiler will be invoked once for
987 each source file in that language. If you use this option in conjunction
988 with @option{-save-temps}, the compiler will generate multiple
989 pre-processed files
990 (one for each source file), but only one (combined) @file{.o} or
991 @file{.s} file.
992
993 @item --help
994 @opindex help
995 Print (on the standard output) a description of the command line options
996 understood by @command{gcc}. If the @option{-v} option is also specified
997 then @option{--help} will also be passed on to the various processes
998 invoked by @command{gcc}, so that they can display the command line options
999 they accept. If the @option{-Wextra} option is also specified then command
1000 line options which have no documentation associated with them will also
1001 be displayed.
1002
1003 @item --target-help
1004 @opindex target-help
1005 Print (on the standard output) a description of target specific command
1006 line options for each tool.
1007
1008 @item --version
1009 @opindex version
1010 Display the version number and copyrights of the invoked GCC@.
1011 @end table
1012
1013 @node Invoking G++
1014 @section Compiling C++ Programs
1015
1016 @cindex suffixes for C++ source
1017 @cindex C++ source file suffixes
1018 C++ source files conventionally use one of the suffixes @samp{.C},
1019 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1020 @samp{.cxx}; C++ header files often use @samp{.hh} or @samp{.H}; and
1021 preprocessed C++ files use the suffix @samp{.ii}. GCC recognizes
1022 files with these names and compiles them as C++ programs even if you
1023 call the compiler the same way as for compiling C programs (usually
1024 with the name @command{gcc}).
1025
1026 @findex g++
1027 @findex c++
1028 However, C++ programs often require class libraries as well as a
1029 compiler that understands the C++ language---and under some
1030 circumstances, you might want to compile programs or header files from
1031 standard input, or otherwise without a suffix that flags them as C++
1032 programs. You might also like to precompile a C header file with a
1033 @samp{.h} extension to be used in C++ compilations. @command{g++} is a
1034 program that calls GCC with the default language set to C++, and
1035 automatically specifies linking against the C++ library. On many
1036 systems, @command{g++} is also installed with the name @command{c++}.
1037
1038 @cindex invoking @command{g++}
1039 When you compile C++ programs, you may specify many of the same
1040 command-line options that you use for compiling programs in any
1041 language; or command-line options meaningful for C and related
1042 languages; or options that are meaningful only for C++ programs.
1043 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1044 explanations of options for languages related to C@.
1045 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1046 explanations of options that are meaningful only for C++ programs.
1047
1048 @node C Dialect Options
1049 @section Options Controlling C Dialect
1050 @cindex dialect options
1051 @cindex language dialect options
1052 @cindex options, dialect
1053
1054 The following options control the dialect of C (or languages derived
1055 from C, such as C++, Objective-C and Objective-C++) that the compiler
1056 accepts:
1057
1058 @table @gcctabopt
1059 @cindex ANSI support
1060 @cindex ISO support
1061 @item -ansi
1062 @opindex ansi
1063 In C mode, support all ISO C90 programs. In C++ mode,
1064 remove GNU extensions that conflict with ISO C++.
1065
1066 This turns off certain features of GCC that are incompatible with ISO
1067 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1068 such as the @code{asm} and @code{typeof} keywords, and
1069 predefined macros such as @code{unix} and @code{vax} that identify the
1070 type of system you are using. It also enables the undesirable and
1071 rarely used ISO trigraph feature. For the C compiler,
1072 it disables recognition of C++ style @samp{//} comments as well as
1073 the @code{inline} keyword.
1074
1075 The alternate keywords @code{__asm__}, @code{__extension__},
1076 @code{__inline__} and @code{__typeof__} continue to work despite
1077 @option{-ansi}. You would not want to use them in an ISO C program, of
1078 course, but it is useful to put them in header files that might be included
1079 in compilations done with @option{-ansi}. Alternate predefined macros
1080 such as @code{__unix__} and @code{__vax__} are also available, with or
1081 without @option{-ansi}.
1082
1083 The @option{-ansi} option does not cause non-ISO programs to be
1084 rejected gratuitously. For that, @option{-pedantic} is required in
1085 addition to @option{-ansi}. @xref{Warning Options}.
1086
1087 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1088 option is used. Some header files may notice this macro and refrain
1089 from declaring certain functions or defining certain macros that the
1090 ISO standard doesn't call for; this is to avoid interfering with any
1091 programs that might use these names for other things.
1092
1093 Functions which would normally be built in but do not have semantics
1094 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1095 functions with @option{-ansi} is used. @xref{Other Builtins,,Other
1096 built-in functions provided by GCC}, for details of the functions
1097 affected.
1098
1099 @item -std=
1100 @opindex std
1101 Determine the language standard. This option is currently only
1102 supported when compiling C or C++. A value for this option must be
1103 provided; possible values are
1104
1105 @table @samp
1106 @item c89
1107 @itemx iso9899:1990
1108 ISO C90 (same as @option{-ansi}).
1109
1110 @item iso9899:199409
1111 ISO C90 as modified in amendment 1.
1112
1113 @item c99
1114 @itemx c9x
1115 @itemx iso9899:1999
1116 @itemx iso9899:199x
1117 ISO C99. Note that this standard is not yet fully supported; see
1118 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information. The
1119 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1120
1121 @item gnu89
1122 Default, ISO C90 plus GNU extensions (including some C99 features).
1123
1124 @item gnu99
1125 @itemx gnu9x
1126 ISO C99 plus GNU extensions. When ISO C99 is fully implemented in GCC,
1127 this will become the default. The name @samp{gnu9x} is deprecated.
1128
1129 @item c++98
1130 The 1998 ISO C++ standard plus amendments.
1131
1132 @item gnu++98
1133 The same as @option{-std=c++98} plus GNU extensions. This is the
1134 default for C++ code.
1135 @end table
1136
1137 Even when this option is not specified, you can still use some of the
1138 features of newer standards in so far as they do not conflict with
1139 previous C standards. For example, you may use @code{__restrict__} even
1140 when @option{-std=c99} is not specified.
1141
1142 The @option{-std} options specifying some version of ISO C have the same
1143 effects as @option{-ansi}, except that features that were not in ISO C90
1144 but are in the specified version (for example, @samp{//} comments and
1145 the @code{inline} keyword in ISO C99) are not disabled.
1146
1147 @xref{Standards,,Language Standards Supported by GCC}, for details of
1148 these standard versions.
1149
1150 @item -aux-info @var{filename}
1151 @opindex aux-info
1152 Output to the given filename prototyped declarations for all functions
1153 declared and/or defined in a translation unit, including those in header
1154 files. This option is silently ignored in any language other than C@.
1155
1156 Besides declarations, the file indicates, in comments, the origin of
1157 each declaration (source file and line), whether the declaration was
1158 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1159 @samp{O} for old, respectively, in the first character after the line
1160 number and the colon), and whether it came from a declaration or a
1161 definition (@samp{C} or @samp{F}, respectively, in the following
1162 character). In the case of function definitions, a K&R-style list of
1163 arguments followed by their declarations is also provided, inside
1164 comments, after the declaration.
1165
1166 @item -fno-asm
1167 @opindex fno-asm
1168 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1169 keyword, so that code can use these words as identifiers. You can use
1170 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1171 instead. @option{-ansi} implies @option{-fno-asm}.
1172
1173 In C++, this switch only affects the @code{typeof} keyword, since
1174 @code{asm} and @code{inline} are standard keywords. You may want to
1175 use the @option{-fno-gnu-keywords} flag instead, which has the same
1176 effect. In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1177 switch only affects the @code{asm} and @code{typeof} keywords, since
1178 @code{inline} is a standard keyword in ISO C99.
1179
1180 @item -fno-builtin
1181 @itemx -fno-builtin-@var{function}
1182 @opindex fno-builtin
1183 @cindex built-in functions
1184 Don't recognize built-in functions that do not begin with
1185 @samp{__builtin_} as prefix. @xref{Other Builtins,,Other built-in
1186 functions provided by GCC}, for details of the functions affected,
1187 including those which are not built-in functions when @option{-ansi} or
1188 @option{-std} options for strict ISO C conformance are used because they
1189 do not have an ISO standard meaning.
1190
1191 GCC normally generates special code to handle certain built-in functions
1192 more efficiently; for instance, calls to @code{alloca} may become single
1193 instructions that adjust the stack directly, and calls to @code{memcpy}
1194 may become inline copy loops. The resulting code is often both smaller
1195 and faster, but since the function calls no longer appear as such, you
1196 cannot set a breakpoint on those calls, nor can you change the behavior
1197 of the functions by linking with a different library. In addition,
1198 when a function is recognized as a built-in function, GCC may use
1199 information about that function to warn about problems with calls to
1200 that function, or to generate more efficient code, even if the
1201 resulting code still contains calls to that function. For example,
1202 warnings are given with @option{-Wformat} for bad calls to
1203 @code{printf}, when @code{printf} is built in, and @code{strlen} is
1204 known not to modify global memory.
1205
1206 With the @option{-fno-builtin-@var{function}} option
1207 only the built-in function @var{function} is
1208 disabled. @var{function} must not begin with @samp{__builtin_}. If a
1209 function is named this is not built-in in this version of GCC, this
1210 option is ignored. There is no corresponding
1211 @option{-fbuiltin-@var{function}} option; if you wish to enable
1212 built-in functions selectively when using @option{-fno-builtin} or
1213 @option{-ffreestanding}, you may define macros such as:
1214
1215 @smallexample
1216 #define abs(n) __builtin_abs ((n))
1217 #define strcpy(d, s) __builtin_strcpy ((d), (s))
1218 @end smallexample
1219
1220 @item -fhosted
1221 @opindex fhosted
1222 @cindex hosted environment
1223
1224 Assert that compilation takes place in a hosted environment. This implies
1225 @option{-fbuiltin}. A hosted environment is one in which the
1226 entire standard library is available, and in which @code{main} has a return
1227 type of @code{int}. Examples are nearly everything except a kernel.
1228 This is equivalent to @option{-fno-freestanding}.
1229
1230 @item -ffreestanding
1231 @opindex ffreestanding
1232 @cindex hosted environment
1233
1234 Assert that compilation takes place in a freestanding environment. This
1235 implies @option{-fno-builtin}. A freestanding environment
1236 is one in which the standard library may not exist, and program startup may
1237 not necessarily be at @code{main}. The most obvious example is an OS kernel.
1238 This is equivalent to @option{-fno-hosted}.
1239
1240 @xref{Standards,,Language Standards Supported by GCC}, for details of
1241 freestanding and hosted environments.
1242
1243 @item -fms-extensions
1244 @opindex fms-extensions
1245 Accept some non-standard constructs used in Microsoft header files.
1246
1247 Some cases of unnamed fields in structures and unions are only
1248 accepted with this option. @xref{Unnamed Fields,,Unnamed struct/union
1249 fields within structs/unions}, for details.
1250
1251 @item -trigraphs
1252 @opindex trigraphs
1253 Support ISO C trigraphs. The @option{-ansi} option (and @option{-std}
1254 options for strict ISO C conformance) implies @option{-trigraphs}.
1255
1256 @item -no-integrated-cpp
1257 @opindex no-integrated-cpp
1258 Performs a compilation in two passes: preprocessing and compiling. This
1259 option allows a user supplied "cc1", "cc1plus", or "cc1obj" via the
1260 @option{-B} option. The user supplied compilation step can then add in
1261 an additional preprocessing step after normal preprocessing but before
1262 compiling. The default is to use the integrated cpp (internal cpp)
1263
1264 The semantics of this option will change if "cc1", "cc1plus", and
1265 "cc1obj" are merged.
1266
1267 @cindex traditional C language
1268 @cindex C language, traditional
1269 @item -traditional
1270 @itemx -traditional-cpp
1271 @opindex traditional-cpp
1272 @opindex traditional
1273 Formerly, these options caused GCC to attempt to emulate a pre-standard
1274 C compiler. They are now only supported with the @option{-E} switch.
1275 The preprocessor continues to support a pre-standard mode. See the GNU
1276 CPP manual for details.
1277
1278 @item -fcond-mismatch
1279 @opindex fcond-mismatch
1280 Allow conditional expressions with mismatched types in the second and
1281 third arguments. The value of such an expression is void. This option
1282 is not supported for C++.
1283
1284 @item -funsigned-char
1285 @opindex funsigned-char
1286 Let the type @code{char} be unsigned, like @code{unsigned char}.
1287
1288 Each kind of machine has a default for what @code{char} should
1289 be. It is either like @code{unsigned char} by default or like
1290 @code{signed char} by default.
1291
1292 Ideally, a portable program should always use @code{signed char} or
1293 @code{unsigned char} when it depends on the signedness of an object.
1294 But many programs have been written to use plain @code{char} and
1295 expect it to be signed, or expect it to be unsigned, depending on the
1296 machines they were written for. This option, and its inverse, let you
1297 make such a program work with the opposite default.
1298
1299 The type @code{char} is always a distinct type from each of
1300 @code{signed char} or @code{unsigned char}, even though its behavior
1301 is always just like one of those two.
1302
1303 @item -fsigned-char
1304 @opindex fsigned-char
1305 Let the type @code{char} be signed, like @code{signed char}.
1306
1307 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1308 the negative form of @option{-funsigned-char}. Likewise, the option
1309 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1310
1311 @item -fsigned-bitfields
1312 @itemx -funsigned-bitfields
1313 @itemx -fno-signed-bitfields
1314 @itemx -fno-unsigned-bitfields
1315 @opindex fsigned-bitfields
1316 @opindex funsigned-bitfields
1317 @opindex fno-signed-bitfields
1318 @opindex fno-unsigned-bitfields
1319 These options control whether a bit-field is signed or unsigned, when the
1320 declaration does not use either @code{signed} or @code{unsigned}. By
1321 default, such a bit-field is signed, because this is consistent: the
1322 basic integer types such as @code{int} are signed types.
1323 @end table
1324
1325 @node C++ Dialect Options
1326 @section Options Controlling C++ Dialect
1327
1328 @cindex compiler options, C++
1329 @cindex C++ options, command line
1330 @cindex options, C++
1331 This section describes the command-line options that are only meaningful
1332 for C++ programs; but you can also use most of the GNU compiler options
1333 regardless of what language your program is in. For example, you
1334 might compile a file @code{firstClass.C} like this:
1335
1336 @smallexample
1337 g++ -g -frepo -O -c firstClass.C
1338 @end smallexample
1339
1340 @noindent
1341 In this example, only @option{-frepo} is an option meant
1342 only for C++ programs; you can use the other options with any
1343 language supported by GCC@.
1344
1345 Here is a list of options that are @emph{only} for compiling C++ programs:
1346
1347 @table @gcctabopt
1348
1349 @item -fabi-version=@var{n}
1350 @opindex fabi-version
1351 Use version @var{n} of the C++ ABI@. Version 2 is the version of the
1352 C++ ABI that first appeared in G++ 3.4. Version 1 is the version of
1353 the C++ ABI that first appeared in G++ 3.2. Version 0 will always be
1354 the version that conforms most closely to the C++ ABI specification.
1355 Therefore, the ABI obtained using version 0 will change as ABI bugs
1356 are fixed.
1357
1358 The default is version 2.
1359
1360 @item -fno-access-control
1361 @opindex fno-access-control
1362 Turn off all access checking. This switch is mainly useful for working
1363 around bugs in the access control code.
1364
1365 @item -fcheck-new
1366 @opindex fcheck-new
1367 Check that the pointer returned by @code{operator new} is non-null
1368 before attempting to modify the storage allocated. This check is
1369 normally unnecessary because the C++ standard specifies that
1370 @code{operator new} will only return @code{0} if it is declared
1371 @samp{throw()}, in which case the compiler will always check the
1372 return value even without this option. In all other cases, when
1373 @code{operator new} has a non-empty exception specification, memory
1374 exhaustion is signalled by throwing @code{std::bad_alloc}. See also
1375 @samp{new (nothrow)}.
1376
1377 @item -fconserve-space
1378 @opindex fconserve-space
1379 Put uninitialized or runtime-initialized global variables into the
1380 common segment, as C does. This saves space in the executable at the
1381 cost of not diagnosing duplicate definitions. If you compile with this
1382 flag and your program mysteriously crashes after @code{main()} has
1383 completed, you may have an object that is being destroyed twice because
1384 two definitions were merged.
1385
1386 This option is no longer useful on most targets, now that support has
1387 been added for putting variables into BSS without making them common.
1388
1389 @item -fno-const-strings
1390 @opindex fno-const-strings
1391 Give string constants type @code{char *} instead of type @code{const
1392 char *}. By default, G++ uses type @code{const char *} as required by
1393 the standard. Even if you use @option{-fno-const-strings}, you cannot
1394 actually modify the value of a string constant.
1395
1396 This option might be removed in a future release of G++. For maximum
1397 portability, you should structure your code so that it works with
1398 string constants that have type @code{const char *}.
1399
1400 @item -fno-elide-constructors
1401 @opindex fno-elide-constructors
1402 The C++ standard allows an implementation to omit creating a temporary
1403 which is only used to initialize another object of the same type.
1404 Specifying this option disables that optimization, and forces G++ to
1405 call the copy constructor in all cases.
1406
1407 @item -fno-enforce-eh-specs
1408 @opindex fno-enforce-eh-specs
1409 Don't check for violation of exception specifications at runtime. This
1410 option violates the C++ standard, but may be useful for reducing code
1411 size in production builds, much like defining @samp{NDEBUG}. The compiler
1412 will still optimize based on the exception specifications.
1413
1414 @item -ffor-scope
1415 @itemx -fno-for-scope
1416 @opindex ffor-scope
1417 @opindex fno-for-scope
1418 If @option{-ffor-scope} is specified, the scope of variables declared in
1419 a @i{for-init-statement} is limited to the @samp{for} loop itself,
1420 as specified by the C++ standard.
1421 If @option{-fno-for-scope} is specified, the scope of variables declared in
1422 a @i{for-init-statement} extends to the end of the enclosing scope,
1423 as was the case in old versions of G++, and other (traditional)
1424 implementations of C++.
1425
1426 The default if neither flag is given to follow the standard,
1427 but to allow and give a warning for old-style code that would
1428 otherwise be invalid, or have different behavior.
1429
1430 @item -fno-gnu-keywords
1431 @opindex fno-gnu-keywords
1432 Do not recognize @code{typeof} as a keyword, so that code can use this
1433 word as an identifier. You can use the keyword @code{__typeof__} instead.
1434 @option{-ansi} implies @option{-fno-gnu-keywords}.
1435
1436 @item -fno-implicit-templates
1437 @opindex fno-implicit-templates
1438 Never emit code for non-inline templates which are instantiated
1439 implicitly (i.e.@: by use); only emit code for explicit instantiations.
1440 @xref{Template Instantiation}, for more information.
1441
1442 @item -fno-implicit-inline-templates
1443 @opindex fno-implicit-inline-templates
1444 Don't emit code for implicit instantiations of inline templates, either.
1445 The default is to handle inlines differently so that compiles with and
1446 without optimization will need the same set of explicit instantiations.
1447
1448 @item -fno-implement-inlines
1449 @opindex fno-implement-inlines
1450 To save space, do not emit out-of-line copies of inline functions
1451 controlled by @samp{#pragma implementation}. This will cause linker
1452 errors if these functions are not inlined everywhere they are called.
1453
1454 @item -fms-extensions
1455 @opindex fms-extensions
1456 Disable pedantic warnings about constructs used in MFC, such as implicit
1457 int and getting a pointer to member function via non-standard syntax.
1458
1459 @item -fno-nonansi-builtins
1460 @opindex fno-nonansi-builtins
1461 Disable built-in declarations of functions that are not mandated by
1462 ANSI/ISO C@. These include @code{ffs}, @code{alloca}, @code{_exit},
1463 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
1464
1465 @item -fno-operator-names
1466 @opindex fno-operator-names
1467 Do not treat the operator name keywords @code{and}, @code{bitand},
1468 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
1469 synonyms as keywords.
1470
1471 @item -fno-optional-diags
1472 @opindex fno-optional-diags
1473 Disable diagnostics that the standard says a compiler does not need to
1474 issue. Currently, the only such diagnostic issued by G++ is the one for
1475 a name having multiple meanings within a class.
1476
1477 @item -fpermissive
1478 @opindex fpermissive
1479 Downgrade some diagnostics about nonconformant code from errors to
1480 warnings. Thus, using @option{-fpermissive} will allow some
1481 nonconforming code to compile.
1482
1483 @item -frepo
1484 @opindex frepo
1485 Enable automatic template instantiation at link time. This option also
1486 implies @option{-fno-implicit-templates}. @xref{Template
1487 Instantiation}, for more information.
1488
1489 @item -fno-rtti
1490 @opindex fno-rtti
1491 Disable generation of information about every class with virtual
1492 functions for use by the C++ runtime type identification features
1493 (@samp{dynamic_cast} and @samp{typeid}). If you don't use those parts
1494 of the language, you can save some space by using this flag. Note that
1495 exception handling uses the same information, but it will generate it as
1496 needed.
1497
1498 @item -fstats
1499 @opindex fstats
1500 Emit statistics about front-end processing at the end of the compilation.
1501 This information is generally only useful to the G++ development team.
1502
1503 @item -ftemplate-depth-@var{n}
1504 @opindex ftemplate-depth
1505 Set the maximum instantiation depth for template classes to @var{n}.
1506 A limit on the template instantiation depth is needed to detect
1507 endless recursions during template class instantiation. ANSI/ISO C++
1508 conforming programs must not rely on a maximum depth greater than 17.
1509
1510 @item -fno-threadsafe-statics
1511 @opindex fno-threadsafe-statics
1512 Do not emit the extra code to use the routines specified in the C++
1513 ABI for thread-safe initialization of local statics. You can use this
1514 option to reduce code size slightly in code that doesn't need to be
1515 thread-safe.
1516
1517 @item -fuse-cxa-atexit
1518 @opindex fuse-cxa-atexit
1519 Register destructors for objects with static storage duration with the
1520 @code{__cxa_atexit} function rather than the @code{atexit} function.
1521 This option is required for fully standards-compliant handling of static
1522 destructors, but will only work if your C library supports
1523 @code{__cxa_atexit}.
1524
1525 @item -fvisibility-inlines-hidden
1526 @opindex fvisibility-inlines-hidden
1527 Causes all inlined methods to be marked with
1528 @code{__attribute__ ((visibility ("hidden")))} so that they do not
1529 appear in the export table of a DSO and do not require a PLT indirection
1530 when used within the DSO@. Enabling this option can have a dramatic effect
1531 on load and link times of a DSO as it massively reduces the size of the
1532 dynamic export table when the library makes heavy use of templates. While
1533 it can cause bloating through duplication of code within each DSO where
1534 it is used, often the wastage is less than the considerable space occupied
1535 by a long symbol name in the export table which is typical when using
1536 templates and namespaces. For even more savings, combine with the
1537 @option{-fvisibility=hidden} switch.
1538
1539 @item -fno-weak
1540 @opindex fno-weak
1541 Do not use weak symbol support, even if it is provided by the linker.
1542 By default, G++ will use weak symbols if they are available. This
1543 option exists only for testing, and should not be used by end-users;
1544 it will result in inferior code and has no benefits. This option may
1545 be removed in a future release of G++.
1546
1547 @item -nostdinc++
1548 @opindex nostdinc++
1549 Do not search for header files in the standard directories specific to
1550 C++, but do still search the other standard directories. (This option
1551 is used when building the C++ library.)
1552 @end table
1553
1554 In addition, these optimization, warning, and code generation options
1555 have meanings only for C++ programs:
1556
1557 @table @gcctabopt
1558 @item -fno-default-inline
1559 @opindex fno-default-inline
1560 Do not assume @samp{inline} for functions defined inside a class scope.
1561 @xref{Optimize Options,,Options That Control Optimization}. Note that these
1562 functions will have linkage like inline functions; they just won't be
1563 inlined by default.
1564
1565 @item -Wabi @r{(C++ only)}
1566 @opindex Wabi
1567 Warn when G++ generates code that is probably not compatible with the
1568 vendor-neutral C++ ABI@. Although an effort has been made to warn about
1569 all such cases, there are probably some cases that are not warned about,
1570 even though G++ is generating incompatible code. There may also be
1571 cases where warnings are emitted even though the code that is generated
1572 will be compatible.
1573
1574 You should rewrite your code to avoid these warnings if you are
1575 concerned about the fact that code generated by G++ may not be binary
1576 compatible with code generated by other compilers.
1577
1578 The known incompatibilities at this point include:
1579
1580 @itemize @bullet
1581
1582 @item
1583 Incorrect handling of tail-padding for bit-fields. G++ may attempt to
1584 pack data into the same byte as a base class. For example:
1585
1586 @smallexample
1587 struct A @{ virtual void f(); int f1 : 1; @};
1588 struct B : public A @{ int f2 : 1; @};
1589 @end smallexample
1590
1591 @noindent
1592 In this case, G++ will place @code{B::f2} into the same byte
1593 as@code{A::f1}; other compilers will not. You can avoid this problem
1594 by explicitly padding @code{A} so that its size is a multiple of the
1595 byte size on your platform; that will cause G++ and other compilers to
1596 layout @code{B} identically.
1597
1598 @item
1599 Incorrect handling of tail-padding for virtual bases. G++ does not use
1600 tail padding when laying out virtual bases. For example:
1601
1602 @smallexample
1603 struct A @{ virtual void f(); char c1; @};
1604 struct B @{ B(); char c2; @};
1605 struct C : public A, public virtual B @{@};
1606 @end smallexample
1607
1608 @noindent
1609 In this case, G++ will not place @code{B} into the tail-padding for
1610 @code{A}; other compilers will. You can avoid this problem by
1611 explicitly padding @code{A} so that its size is a multiple of its
1612 alignment (ignoring virtual base classes); that will cause G++ and other
1613 compilers to layout @code{C} identically.
1614
1615 @item
1616 Incorrect handling of bit-fields with declared widths greater than that
1617 of their underlying types, when the bit-fields appear in a union. For
1618 example:
1619
1620 @smallexample
1621 union U @{ int i : 4096; @};
1622 @end smallexample
1623
1624 @noindent
1625 Assuming that an @code{int} does not have 4096 bits, G++ will make the
1626 union too small by the number of bits in an @code{int}.
1627
1628 @item
1629 Empty classes can be placed at incorrect offsets. For example:
1630
1631 @smallexample
1632 struct A @{@};
1633
1634 struct B @{
1635 A a;
1636 virtual void f ();
1637 @};
1638
1639 struct C : public B, public A @{@};
1640 @end smallexample
1641
1642 @noindent
1643 G++ will place the @code{A} base class of @code{C} at a nonzero offset;
1644 it should be placed at offset zero. G++ mistakenly believes that the
1645 @code{A} data member of @code{B} is already at offset zero.
1646
1647 @item
1648 Names of template functions whose types involve @code{typename} or
1649 template template parameters can be mangled incorrectly.
1650
1651 @smallexample
1652 template <typename Q>
1653 void f(typename Q::X) @{@}
1654
1655 template <template <typename> class Q>
1656 void f(typename Q<int>::X) @{@}
1657 @end smallexample
1658
1659 @noindent
1660 Instantiations of these templates may be mangled incorrectly.
1661
1662 @end itemize
1663
1664 @item -Wctor-dtor-privacy @r{(C++ only)}
1665 @opindex Wctor-dtor-privacy
1666 Warn when a class seems unusable because all the constructors or
1667 destructors in that class are private, and it has neither friends nor
1668 public static member functions.
1669
1670 @item -Wnon-virtual-dtor @r{(C++ only)}
1671 @opindex Wnon-virtual-dtor
1672 Warn when a class appears to be polymorphic, thereby requiring a virtual
1673 destructor, yet it declares a non-virtual one.
1674 This warning is enabled by @option{-Wall}.
1675
1676 @item -Wreorder @r{(C++ only)}
1677 @opindex Wreorder
1678 @cindex reordering, warning
1679 @cindex warning for reordering of member initializers
1680 Warn when the order of member initializers given in the code does not
1681 match the order in which they must be executed. For instance:
1682
1683 @smallexample
1684 struct A @{
1685 int i;
1686 int j;
1687 A(): j (0), i (1) @{ @}
1688 @};
1689 @end smallexample
1690
1691 The compiler will rearrange the member initializers for @samp{i}
1692 and @samp{j} to match the declaration order of the members, emitting
1693 a warning to that effect. This warning is enabled by @option{-Wall}.
1694 @end table
1695
1696 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
1697
1698 @table @gcctabopt
1699 @item -Weffc++ @r{(C++ only)}
1700 @opindex Weffc++
1701 Warn about violations of the following style guidelines from Scott Meyers'
1702 @cite{Effective C++} book:
1703
1704 @itemize @bullet
1705 @item
1706 Item 11: Define a copy constructor and an assignment operator for classes
1707 with dynamically allocated memory.
1708
1709 @item
1710 Item 12: Prefer initialization to assignment in constructors.
1711
1712 @item
1713 Item 14: Make destructors virtual in base classes.
1714
1715 @item
1716 Item 15: Have @code{operator=} return a reference to @code{*this}.
1717
1718 @item
1719 Item 23: Don't try to return a reference when you must return an object.
1720
1721 @end itemize
1722
1723 Also warn about violations of the following style guidelines from
1724 Scott Meyers' @cite{More Effective C++} book:
1725
1726 @itemize @bullet
1727 @item
1728 Item 6: Distinguish between prefix and postfix forms of increment and
1729 decrement operators.
1730
1731 @item
1732 Item 7: Never overload @code{&&}, @code{||}, or @code{,}.
1733
1734 @end itemize
1735
1736 When selecting this option, be aware that the standard library
1737 headers do not obey all of these guidelines; use @samp{grep -v}
1738 to filter out those warnings.
1739
1740 @item -Wno-deprecated @r{(C++ only)}
1741 @opindex Wno-deprecated
1742 Do not warn about usage of deprecated features. @xref{Deprecated Features}.
1743
1744 @item -Wno-non-template-friend @r{(C++ only)}
1745 @opindex Wno-non-template-friend
1746 Disable warnings when non-templatized friend functions are declared
1747 within a template. Since the advent of explicit template specification
1748 support in G++, if the name of the friend is an unqualified-id (i.e.,
1749 @samp{friend foo(int)}), the C++ language specification demands that the
1750 friend declare or define an ordinary, nontemplate function. (Section
1751 14.5.3). Before G++ implemented explicit specification, unqualified-ids
1752 could be interpreted as a particular specialization of a templatized
1753 function. Because this non-conforming behavior is no longer the default
1754 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
1755 check existing code for potential trouble spots and is on by default.
1756 This new compiler behavior can be turned off with
1757 @option{-Wno-non-template-friend} which keeps the conformant compiler code
1758 but disables the helpful warning.
1759
1760 @item -Wold-style-cast @r{(C++ only)}
1761 @opindex Wold-style-cast
1762 Warn if an old-style (C-style) cast to a non-void type is used within
1763 a C++ program. The new-style casts (@samp{static_cast},
1764 @samp{reinterpret_cast}, and @samp{const_cast}) are less vulnerable to
1765 unintended effects and much easier to search for.
1766
1767 @item -Woverloaded-virtual @r{(C++ only)}
1768 @opindex Woverloaded-virtual
1769 @cindex overloaded virtual fn, warning
1770 @cindex warning for overloaded virtual fn
1771 Warn when a function declaration hides virtual functions from a
1772 base class. For example, in:
1773
1774 @smallexample
1775 struct A @{
1776 virtual void f();
1777 @};
1778
1779 struct B: public A @{
1780 void f(int);
1781 @};
1782 @end smallexample
1783
1784 the @code{A} class version of @code{f} is hidden in @code{B}, and code
1785 like:
1786
1787 @smallexample
1788 B* b;
1789 b->f();
1790 @end smallexample
1791
1792 will fail to compile.
1793
1794 @item -Wno-pmf-conversions @r{(C++ only)}
1795 @opindex Wno-pmf-conversions
1796 Disable the diagnostic for converting a bound pointer to member function
1797 to a plain pointer.
1798
1799 @item -Wsign-promo @r{(C++ only)}
1800 @opindex Wsign-promo
1801 Warn when overload resolution chooses a promotion from unsigned or
1802 enumerated type to a signed type, over a conversion to an unsigned type of
1803 the same size. Previous versions of G++ would try to preserve
1804 unsignedness, but the standard mandates the current behavior.
1805
1806 @smallexample
1807 struct A @{
1808 operator int ();
1809 A& operator = (int);
1810 @};
1811
1812 main ()
1813 @{
1814 A a,b;
1815 a = b;
1816 @}
1817 @end smallexample
1818
1819 In this example, G++ will synthesize a default @samp{A& operator =
1820 (const A&);}, while cfront will use the user-defined @samp{operator =}.
1821 @end table
1822
1823 @node Objective-C and Objective-C++ Dialect Options
1824 @section Options Controlling Objective-C and Objective-C++ Dialects
1825
1826 @cindex compiler options, Objective-C and Objective-C++
1827 @cindex Objective-C and Objective-C++ options, command line
1828 @cindex options, Objective-C and Objective-C++
1829 (NOTE: This manual does not describe the Objective-C and Objective-C++
1830 languages themselves. See @xref{Standards,,Language Standards
1831 Supported by GCC}, for references.)
1832
1833 This section describes the command-line options that are only meaningful
1834 for Objective-C and Objective-C++ programs, but you can also use most of
1835 the language-independent GNU compiler options.
1836 For example, you might compile a file @code{some_class.m} like this:
1837
1838 @smallexample
1839 gcc -g -fgnu-runtime -O -c some_class.m
1840 @end smallexample
1841
1842 @noindent
1843 In this example, @option{-fgnu-runtime} is an option meant only for
1844 Objective-C and Objective-C++ programs; you can use the other options with
1845 any language supported by GCC@.
1846
1847 Note that since Objective-C is an extension of the C language, Objective-C
1848 compilations may also use options specific to the C front-end (e.g.,
1849 @option{-Wtraditional}). Similarly, Objective-C++ compilations may use
1850 C++-specific options (e.g., @option{-Wabi}).
1851
1852 Here is a list of options that are @emph{only} for compiling Objective-C
1853 and Objective-C++ programs:
1854
1855 @table @gcctabopt
1856 @item -fconstant-string-class=@var{class-name}
1857 @opindex fconstant-string-class
1858 Use @var{class-name} as the name of the class to instantiate for each
1859 literal string specified with the syntax @code{@@"@dots{}"}. The default
1860 class name is @code{NXConstantString} if the GNU runtime is being used, and
1861 @code{NSConstantString} if the NeXT runtime is being used (see below). The
1862 @option{-fconstant-cfstrings} option, if also present, will override the
1863 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
1864 to be laid out as constant CoreFoundation strings.
1865
1866 @item -fgnu-runtime
1867 @opindex fgnu-runtime
1868 Generate object code compatible with the standard GNU Objective-C
1869 runtime. This is the default for most types of systems.
1870
1871 @item -fnext-runtime
1872 @opindex fnext-runtime
1873 Generate output compatible with the NeXT runtime. This is the default
1874 for NeXT-based systems, including Darwin and Mac OS X@. The macro
1875 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
1876 used.
1877
1878 @item -fno-nil-receivers
1879 @opindex fno-nil-receivers
1880 Assume that all Objective-C message dispatches (e.g.,
1881 @code{[receiver message:arg]}) in this translation unit ensure that the receiver
1882 is not @code{nil}. This allows for more efficient entry points in the runtime
1883 to be used. Currently, this option is only available in conjunction with
1884 the NeXT runtime on Mac OS X 10.3 and later.
1885
1886 @item -fobjc-exceptions
1887 @opindex fobjc-exceptions
1888 Enable syntactic support for structured exception handling in Objective-C,
1889 similar to what is offered by C++ and Java. Currently, this option is only
1890 available in conjunction with the NeXT runtime on Mac OS X 10.3 and later.
1891
1892 @smallexample
1893 @@try @{
1894 @dots{}
1895 @@throw expr;
1896 @dots{}
1897 @}
1898 @@catch (AnObjCClass *exc) @{
1899 @dots{}
1900 @@throw expr;
1901 @dots{}
1902 @@throw;
1903 @dots{}
1904 @}
1905 @@catch (AnotherClass *exc) @{
1906 @dots{}
1907 @}
1908 @@catch (id allOthers) @{
1909 @dots{}
1910 @}
1911 @@finally @{
1912 @dots{}
1913 @@throw expr;
1914 @dots{}
1915 @}
1916 @end smallexample
1917
1918 The @code{@@throw} statement may appear anywhere in an Objective-C or
1919 Objective-C++ program; when used inside of a @code{@@catch} block, the
1920 @code{@@throw} may appear without an argument (as shown above), in which case
1921 the object caught by the @code{@@catch} will be rethrown.
1922
1923 Note that only (pointers to) Objective-C objects may be thrown and
1924 caught using this scheme. When an object is thrown, it will be caught
1925 by the nearest @code{@@catch} clause capable of handling objects of that type,
1926 analogously to how @code{catch} blocks work in C++ and Java. A
1927 @code{@@catch(id @dots{})} clause (as shown above) may also be provided to catch
1928 any and all Objective-C exceptions not caught by previous @code{@@catch}
1929 clauses (if any).
1930
1931 The @code{@@finally} clause, if present, will be executed upon exit from the
1932 immediately preceding @code{@@try @dots{} @@catch} section. This will happen
1933 regardless of whether any exceptions are thrown, caught or rethrown
1934 inside the @code{@@try @dots{} @@catch} section, analogously to the behavior
1935 of the @code{finally} clause in Java.
1936
1937 There are several caveats to using the new exception mechanism:
1938
1939 @itemize @bullet
1940 @item
1941 Although currently designed to be binary compatible with @code{NS_HANDLER}-style
1942 idioms provided by the @code{NSException} class, the new
1943 exceptions can only be used on Mac OS X 10.3 (Panther) and later
1944 systems, due to additional functionality needed in the (NeXT) Objective-C
1945 runtime.
1946
1947 @item
1948 As mentioned above, the new exceptions do not support handling
1949 types other than Objective-C objects. Furthermore, when used from
1950 Objective-C++, the Objective-C exception model does not interoperate with C++
1951 exceptions at this time. This means you cannot @code{@@throw} an exception
1952 from Objective-C and @code{catch} it in C++, or vice versa
1953 (i.e., @code{throw @dots{} @@catch}).
1954 @end itemize
1955
1956 The @option{-fobjc-exceptions} switch also enables the use of synchronization
1957 blocks for thread-safe execution:
1958
1959 @smallexample
1960 @@synchronized (ObjCClass *guard) @{
1961 @dots{}
1962 @}
1963 @end smallexample
1964
1965 Upon entering the @code{@@synchronized} block, a thread of execution shall
1966 first check whether a lock has been placed on the corresponding @code{guard}
1967 object by another thread. If it has, the current thread shall wait until
1968 the other thread relinquishes its lock. Once @code{guard} becomes available,
1969 the current thread will place its own lock on it, execute the code contained in
1970 the @code{@@synchronized} block, and finally relinquish the lock (thereby
1971 making @code{guard} available to other threads).
1972
1973 Unlike Java, Objective-C does not allow for entire methods to be marked
1974 @code{@@synchronized}. Note that throwing exceptions out of
1975 @code{@@synchronized} blocks is allowed, and will cause the guarding object
1976 to be unlocked properly.
1977
1978 @item -freplace-objc-classes
1979 @opindex freplace-objc-classes
1980 Emit a special marker instructing @command{ld(1)} not to statically link in
1981 the resulting object file, and allow @command{dyld(1)} to load it in at
1982 run time instead. This is used in conjunction with the Fix-and-Continue
1983 debugging mode, where the object file in question may be recompiled and
1984 dynamically reloaded in the course of program execution, without the need
1985 to restart the program itself. Currently, Fix-and-Continue functionality
1986 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
1987 and later.
1988
1989 @item -fzero-link
1990 @opindex fzero-link
1991 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
1992 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
1993 compile time) with static class references that get initialized at load time,
1994 which improves run-time performance. Specifying the @option{-fzero-link} flag
1995 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
1996 to be retained. This is useful in Zero-Link debugging mode, since it allows
1997 for individual class implementations to be modified during program execution.
1998
1999 @item -gen-decls
2000 @opindex gen-decls
2001 Dump interface declarations for all classes seen in the source file to a
2002 file named @file{@var{sourcename}.decl}.
2003
2004 @item -Wno-protocol
2005 @opindex Wno-protocol
2006 If a class is declared to implement a protocol, a warning is issued for
2007 every method in the protocol that is not implemented by the class. The
2008 default behavior is to issue a warning for every method not explicitly
2009 implemented in the class, even if a method implementation is inherited
2010 from the superclass. If you use the @option{-Wno-protocol} option, then
2011 methods inherited from the superclass are considered to be implemented,
2012 and no warning is issued for them.
2013
2014 @item -Wselector
2015 @opindex Wselector
2016 Warn if multiple methods of different types for the same selector are
2017 found during compilation. The check is performed on the list of methods
2018 in the final stage of compilation. Additionally, a check is performed
2019 for each selector appearing in a @code{@@selector(@dots{})}
2020 expression, and a corresponding method for that selector has been found
2021 during compilation. Because these checks scan the method table only at
2022 the end of compilation, these warnings are not produced if the final
2023 stage of compilation is not reached, for example because an error is
2024 found during compilation, or because the @option{-fsyntax-only} option is
2025 being used.
2026
2027 @item -Wundeclared-selector
2028 @opindex Wundeclared-selector
2029 Warn if a @code{@@selector(@dots{})} expression referring to an
2030 undeclared selector is found. A selector is considered undeclared if no
2031 method with that name has been declared before the
2032 @code{@@selector(@dots{})} expression, either explicitly in an
2033 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
2034 an @code{@@implementation} section. This option always performs its
2035 checks as soon as a @code{@@selector(@dots{})} expression is found,
2036 while @option{-Wselector} only performs its checks in the final stage of
2037 compilation. This also enforces the coding style convention
2038 that methods and selectors must be declared before being used.
2039
2040 @item -print-objc-runtime-info
2041 @opindex print-objc-runtime-info
2042 Generate C header describing the largest structure that is passed by
2043 value, if any.
2044
2045 @end table
2046
2047 @node Language Independent Options
2048 @section Options to Control Diagnostic Messages Formatting
2049 @cindex options to control diagnostics formatting
2050 @cindex diagnostic messages
2051 @cindex message formatting
2052
2053 Traditionally, diagnostic messages have been formatted irrespective of
2054 the output device's aspect (e.g.@: its width, @dots{}). The options described
2055 below can be used to control the diagnostic messages formatting
2056 algorithm, e.g.@: how many characters per line, how often source location
2057 information should be reported. Right now, only the C++ front end can
2058 honor these options. However it is expected, in the near future, that
2059 the remaining front ends would be able to digest them correctly.
2060
2061 @table @gcctabopt
2062 @item -fmessage-length=@var{n}
2063 @opindex fmessage-length
2064 Try to format error messages so that they fit on lines of about @var{n}
2065 characters. The default is 72 characters for @command{g++} and 0 for the rest of
2066 the front ends supported by GCC@. If @var{n} is zero, then no
2067 line-wrapping will be done; each error message will appear on a single
2068 line.
2069
2070 @opindex fdiagnostics-show-location
2071 @item -fdiagnostics-show-location=once
2072 Only meaningful in line-wrapping mode. Instructs the diagnostic messages
2073 reporter to emit @emph{once} source location information; that is, in
2074 case the message is too long to fit on a single physical line and has to
2075 be wrapped, the source location won't be emitted (as prefix) again,
2076 over and over, in subsequent continuation lines. This is the default
2077 behavior.
2078
2079 @item -fdiagnostics-show-location=every-line
2080 Only meaningful in line-wrapping mode. Instructs the diagnostic
2081 messages reporter to emit the same source location information (as
2082 prefix) for physical lines that result from the process of breaking
2083 a message which is too long to fit on a single line.
2084
2085 @end table
2086
2087 @node Warning Options
2088 @section Options to Request or Suppress Warnings
2089 @cindex options to control warnings
2090 @cindex warning messages
2091 @cindex messages, warning
2092 @cindex suppressing warnings
2093
2094 Warnings are diagnostic messages that report constructions which
2095 are not inherently erroneous but which are risky or suggest there
2096 may have been an error.
2097
2098 You can request many specific warnings with options beginning @samp{-W},
2099 for example @option{-Wimplicit} to request warnings on implicit
2100 declarations. Each of these specific warning options also has a
2101 negative form beginning @samp{-Wno-} to turn off warnings;
2102 for example, @option{-Wno-implicit}. This manual lists only one of the
2103 two forms, whichever is not the default.
2104
2105 The following options control the amount and kinds of warnings produced
2106 by GCC; for further, language-specific options also refer to
2107 @ref{C++ Dialect Options} and @ref{Objective-C and Objective-C++ Dialect
2108 Options}.
2109
2110 @table @gcctabopt
2111 @cindex syntax checking
2112 @item -fsyntax-only
2113 @opindex fsyntax-only
2114 Check the code for syntax errors, but don't do anything beyond that.
2115
2116 @item -pedantic
2117 @opindex pedantic
2118 Issue all the warnings demanded by strict ISO C and ISO C++;
2119 reject all programs that use forbidden extensions, and some other
2120 programs that do not follow ISO C and ISO C++. For ISO C, follows the
2121 version of the ISO C standard specified by any @option{-std} option used.
2122
2123 Valid ISO C and ISO C++ programs should compile properly with or without
2124 this option (though a rare few will require @option{-ansi} or a
2125 @option{-std} option specifying the required version of ISO C)@. However,
2126 without this option, certain GNU extensions and traditional C and C++
2127 features are supported as well. With this option, they are rejected.
2128
2129 @option{-pedantic} does not cause warning messages for use of the
2130 alternate keywords whose names begin and end with @samp{__}. Pedantic
2131 warnings are also disabled in the expression that follows
2132 @code{__extension__}. However, only system header files should use
2133 these escape routes; application programs should avoid them.
2134 @xref{Alternate Keywords}.
2135
2136 Some users try to use @option{-pedantic} to check programs for strict ISO
2137 C conformance. They soon find that it does not do quite what they want:
2138 it finds some non-ISO practices, but not all---only those for which
2139 ISO C @emph{requires} a diagnostic, and some others for which
2140 diagnostics have been added.
2141
2142 A feature to report any failure to conform to ISO C might be useful in
2143 some instances, but would require considerable additional work and would
2144 be quite different from @option{-pedantic}. We don't have plans to
2145 support such a feature in the near future.
2146
2147 Where the standard specified with @option{-std} represents a GNU
2148 extended dialect of C, such as @samp{gnu89} or @samp{gnu99}, there is a
2149 corresponding @dfn{base standard}, the version of ISO C on which the GNU
2150 extended dialect is based. Warnings from @option{-pedantic} are given
2151 where they are required by the base standard. (It would not make sense
2152 for such warnings to be given only for features not in the specified GNU
2153 C dialect, since by definition the GNU dialects of C include all
2154 features the compiler supports with the given option, and there would be
2155 nothing to warn about.)
2156
2157 @item -pedantic-errors
2158 @opindex pedantic-errors
2159 Like @option{-pedantic}, except that errors are produced rather than
2160 warnings.
2161
2162 @item -w
2163 @opindex w
2164 Inhibit all warning messages.
2165
2166 @item -Wno-import
2167 @opindex Wno-import
2168 Inhibit warning messages about the use of @samp{#import}.
2169
2170 @item -Wchar-subscripts
2171 @opindex Wchar-subscripts
2172 Warn if an array subscript has type @code{char}. This is a common cause
2173 of error, as programmers often forget that this type is signed on some
2174 machines.
2175 This warning is enabled by @option{-Wall}.
2176
2177 @item -Wcomment
2178 @opindex Wcomment
2179 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
2180 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
2181 This warning is enabled by @option{-Wall}.
2182
2183 @item -Wfatal-errors
2184 @opindex Wfatal-errors
2185 This option causes the compiler to abort compilation on the first error
2186 occurred rather than trying to keep going and printing further error
2187 messages.
2188
2189 @item -Wformat
2190 @opindex Wformat
2191 @opindex ffreestanding
2192 @opindex fno-builtin
2193 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
2194 the arguments supplied have types appropriate to the format string
2195 specified, and that the conversions specified in the format string make
2196 sense. This includes standard functions, and others specified by format
2197 attributes (@pxref{Function Attributes}), in the @code{printf},
2198 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
2199 not in the C standard) families (or other target-specific families).
2200 Which functions are checked without format attributes having been
2201 specified depends on the standard version selected, and such checks of
2202 functions without the attribute specified are disabled by
2203 @option{-ffreestanding} or @option{-fno-builtin}.
2204
2205 The formats are checked against the format features supported by GNU
2206 libc version 2.2. These include all ISO C90 and C99 features, as well
2207 as features from the Single Unix Specification and some BSD and GNU
2208 extensions. Other library implementations may not support all these
2209 features; GCC does not support warning about features that go beyond a
2210 particular library's limitations. However, if @option{-pedantic} is used
2211 with @option{-Wformat}, warnings will be given about format features not
2212 in the selected standard version (but not for @code{strfmon} formats,
2213 since those are not in any version of the C standard). @xref{C Dialect
2214 Options,,Options Controlling C Dialect}.
2215
2216 Since @option{-Wformat} also checks for null format arguments for
2217 several functions, @option{-Wformat} also implies @option{-Wnonnull}.
2218
2219 @option{-Wformat} is included in @option{-Wall}. For more control over some
2220 aspects of format checking, the options @option{-Wformat-y2k},
2221 @option{-Wno-format-extra-args}, @option{-Wno-format-zero-length},
2222 @option{-Wformat-nonliteral}, @option{-Wformat-security}, and
2223 @option{-Wformat=2} are available, but are not included in @option{-Wall}.
2224
2225 @item -Wformat-y2k
2226 @opindex Wformat-y2k
2227 If @option{-Wformat} is specified, also warn about @code{strftime}
2228 formats which may yield only a two-digit year.
2229
2230 @item -Wno-format-extra-args
2231 @opindex Wno-format-extra-args
2232 If @option{-Wformat} is specified, do not warn about excess arguments to a
2233 @code{printf} or @code{scanf} format function. The C standard specifies
2234 that such arguments are ignored.
2235
2236 Where the unused arguments lie between used arguments that are
2237 specified with @samp{$} operand number specifications, normally
2238 warnings are still given, since the implementation could not know what
2239 type to pass to @code{va_arg} to skip the unused arguments. However,
2240 in the case of @code{scanf} formats, this option will suppress the
2241 warning if the unused arguments are all pointers, since the Single
2242 Unix Specification says that such unused arguments are allowed.
2243
2244 @item -Wno-format-zero-length
2245 @opindex Wno-format-zero-length
2246 If @option{-Wformat} is specified, do not warn about zero-length formats.
2247 The C standard specifies that zero-length formats are allowed.
2248
2249 @item -Wformat-nonliteral
2250 @opindex Wformat-nonliteral
2251 If @option{-Wformat} is specified, also warn if the format string is not a
2252 string literal and so cannot be checked, unless the format function
2253 takes its format arguments as a @code{va_list}.
2254
2255 @item -Wformat-security
2256 @opindex Wformat-security
2257 If @option{-Wformat} is specified, also warn about uses of format
2258 functions that represent possible security problems. At present, this
2259 warns about calls to @code{printf} and @code{scanf} functions where the
2260 format string is not a string literal and there are no format arguments,
2261 as in @code{printf (foo);}. This may be a security hole if the format
2262 string came from untrusted input and contains @samp{%n}. (This is
2263 currently a subset of what @option{-Wformat-nonliteral} warns about, but
2264 in future warnings may be added to @option{-Wformat-security} that are not
2265 included in @option{-Wformat-nonliteral}.)
2266
2267 @item -Wformat=2
2268 @opindex Wformat=2
2269 Enable @option{-Wformat} plus format checks not included in
2270 @option{-Wformat}. Currently equivalent to @samp{-Wformat
2271 -Wformat-nonliteral -Wformat-security -Wformat-y2k}.
2272
2273 @item -Wnonnull
2274 @opindex Wnonnull
2275 Warn about passing a null pointer for arguments marked as
2276 requiring a non-null value by the @code{nonnull} function attribute.
2277
2278 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}. It
2279 can be disabled with the @option{-Wno-nonnull} option.
2280
2281 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
2282 @opindex Winit-self
2283 Warn about uninitialized variables which are initialized with themselves.
2284 Note this option can only be used with the @option{-Wuninitialized} option,
2285 which in turn only works with @option{-O1} and above.
2286
2287 For example, GCC will warn about @code{i} being uninitialized in the
2288 following snippet only when @option{-Winit-self} has been specified:
2289 @smallexample
2290 @group
2291 int f()
2292 @{
2293 int i = i;
2294 return i;
2295 @}
2296 @end group
2297 @end smallexample
2298
2299 @item -Wimplicit-int
2300 @opindex Wimplicit-int
2301 Warn when a declaration does not specify a type.
2302 This warning is enabled by @option{-Wall}.
2303
2304 @item -Wimplicit-function-declaration
2305 @itemx -Werror-implicit-function-declaration
2306 @opindex Wimplicit-function-declaration
2307 @opindex Werror-implicit-function-declaration
2308 Give a warning (or error) whenever a function is used before being
2309 declared. The form @option{-Wno-error-implicit-function-declaration}
2310 is not supported.
2311 This warning is enabled by @option{-Wall} (as a warning, not an error).
2312
2313 @item -Wimplicit
2314 @opindex Wimplicit
2315 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
2316 This warning is enabled by @option{-Wall}.
2317
2318 @item -Wmain
2319 @opindex Wmain
2320 Warn if the type of @samp{main} is suspicious. @samp{main} should be a
2321 function with external linkage, returning int, taking either zero
2322 arguments, two, or three arguments of appropriate types.
2323 This warning is enabled by @option{-Wall}.
2324
2325 @item -Wmissing-braces
2326 @opindex Wmissing-braces
2327 Warn if an aggregate or union initializer is not fully bracketed. In
2328 the following example, the initializer for @samp{a} is not fully
2329 bracketed, but that for @samp{b} is fully bracketed.
2330
2331 @smallexample
2332 int a[2][2] = @{ 0, 1, 2, 3 @};
2333 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
2334 @end smallexample
2335
2336 This warning is enabled by @option{-Wall}.
2337
2338 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
2339 @opindex Wmissing-include-dirs
2340 Warn if a user-supplied include directory does not exist.
2341
2342 @item -Wparentheses
2343 @opindex Wparentheses
2344 Warn if parentheses are omitted in certain contexts, such
2345 as when there is an assignment in a context where a truth value
2346 is expected, or when operators are nested whose precedence people
2347 often get confused about. Only the warning for an assignment used as
2348 a truth value is supported when compiling C++; the other warnings are
2349 only supported when compiling C@.
2350
2351 Also warn if a comparison like @samp{x<=y<=z} appears; this is
2352 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
2353 interpretation from that of ordinary mathematical notation.
2354
2355 Also warn about constructions where there may be confusion to which
2356 @code{if} statement an @code{else} branch belongs. Here is an example of
2357 such a case:
2358
2359 @smallexample
2360 @group
2361 @{
2362 if (a)
2363 if (b)
2364 foo ();
2365 else
2366 bar ();
2367 @}
2368 @end group
2369 @end smallexample
2370
2371 In C, every @code{else} branch belongs to the innermost possible @code{if}
2372 statement, which in this example is @code{if (b)}. This is often not
2373 what the programmer expected, as illustrated in the above example by
2374 indentation the programmer chose. When there is the potential for this
2375 confusion, GCC will issue a warning when this flag is specified.
2376 To eliminate the warning, add explicit braces around the innermost
2377 @code{if} statement so there is no way the @code{else} could belong to
2378 the enclosing @code{if}. The resulting code would look like this:
2379
2380 @smallexample
2381 @group
2382 @{
2383 if (a)
2384 @{
2385 if (b)
2386 foo ();
2387 else
2388 bar ();
2389 @}
2390 @}
2391 @end group
2392 @end smallexample
2393
2394 This warning is enabled by @option{-Wall}.
2395
2396 @item -Wsequence-point
2397 @opindex Wsequence-point
2398 Warn about code that may have undefined semantics because of violations
2399 of sequence point rules in the C standard.
2400
2401 The C standard defines the order in which expressions in a C program are
2402 evaluated in terms of @dfn{sequence points}, which represent a partial
2403 ordering between the execution of parts of the program: those executed
2404 before the sequence point, and those executed after it. These occur
2405 after the evaluation of a full expression (one which is not part of a
2406 larger expression), after the evaluation of the first operand of a
2407 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
2408 function is called (but after the evaluation of its arguments and the
2409 expression denoting the called function), and in certain other places.
2410 Other than as expressed by the sequence point rules, the order of
2411 evaluation of subexpressions of an expression is not specified. All
2412 these rules describe only a partial order rather than a total order,
2413 since, for example, if two functions are called within one expression
2414 with no sequence point between them, the order in which the functions
2415 are called is not specified. However, the standards committee have
2416 ruled that function calls do not overlap.
2417
2418 It is not specified when between sequence points modifications to the
2419 values of objects take effect. Programs whose behavior depends on this
2420 have undefined behavior; the C standard specifies that ``Between the
2421 previous and next sequence point an object shall have its stored value
2422 modified at most once by the evaluation of an expression. Furthermore,
2423 the prior value shall be read only to determine the value to be
2424 stored.''. If a program breaks these rules, the results on any
2425 particular implementation are entirely unpredictable.
2426
2427 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
2428 = b[n++]} and @code{a[i++] = i;}. Some more complicated cases are not
2429 diagnosed by this option, and it may give an occasional false positive
2430 result, but in general it has been found fairly effective at detecting
2431 this sort of problem in programs.
2432
2433 The present implementation of this option only works for C programs. A
2434 future implementation may also work for C++ programs.
2435
2436 The C standard is worded confusingly, therefore there is some debate
2437 over the precise meaning of the sequence point rules in subtle cases.
2438 Links to discussions of the problem, including proposed formal
2439 definitions, may be found on the GCC readings page, at
2440 @w{@uref{http://gcc.gnu.org/readings.html}}.
2441
2442 This warning is enabled by @option{-Wall}.
2443
2444 @item -Wreturn-type
2445 @opindex Wreturn-type
2446 Warn whenever a function is defined with a return-type that defaults to
2447 @code{int}. Also warn about any @code{return} statement with no
2448 return-value in a function whose return-type is not @code{void}.
2449
2450 For C, also warn if the return type of a function has a type qualifier
2451 such as @code{const}. Such a type qualifier has no effect, since the
2452 value returned by a function is not an lvalue. ISO C prohibits
2453 qualified @code{void} return types on function definitions, so such
2454 return types always receive a warning even without this option.
2455
2456 For C++, a function without return type always produces a diagnostic
2457 message, even when @option{-Wno-return-type} is specified. The only
2458 exceptions are @samp{main} and functions defined in system headers.
2459
2460 This warning is enabled by @option{-Wall}.
2461
2462 @item -Wswitch
2463 @opindex Wswitch
2464 Warn whenever a @code{switch} statement has an index of enumerated type
2465 and lacks a @code{case} for one or more of the named codes of that
2466 enumeration. (The presence of a @code{default} label prevents this
2467 warning.) @code{case} labels outside the enumeration range also
2468 provoke warnings when this option is used.
2469 This warning is enabled by @option{-Wall}.
2470
2471 @item -Wswitch-default
2472 @opindex Wswitch-switch
2473 Warn whenever a @code{switch} statement does not have a @code{default}
2474 case.
2475
2476 @item -Wswitch-enum
2477 @opindex Wswitch-enum
2478 Warn whenever a @code{switch} statement has an index of enumerated type
2479 and lacks a @code{case} for one or more of the named codes of that
2480 enumeration. @code{case} labels outside the enumeration range also
2481 provoke warnings when this option is used.
2482
2483 @item -Wtrigraphs
2484 @opindex Wtrigraphs
2485 Warn if any trigraphs are encountered that might change the meaning of
2486 the program (trigraphs within comments are not warned about).
2487 This warning is enabled by @option{-Wall}.
2488
2489 @item -Wunused-function
2490 @opindex Wunused-function
2491 Warn whenever a static function is declared but not defined or a
2492 non\-inline static function is unused.
2493 This warning is enabled by @option{-Wall}.
2494
2495 @item -Wunused-label
2496 @opindex Wunused-label
2497 Warn whenever a label is declared but not used.
2498 This warning is enabled by @option{-Wall}.
2499
2500 To suppress this warning use the @samp{unused} attribute
2501 (@pxref{Variable Attributes}).
2502
2503 @item -Wunused-parameter
2504 @opindex Wunused-parameter
2505 Warn whenever a function parameter is unused aside from its declaration.
2506
2507 To suppress this warning use the @samp{unused} attribute
2508 (@pxref{Variable Attributes}).
2509
2510 @item -Wunused-variable
2511 @opindex Wunused-variable
2512 Warn whenever a local variable or non-constant static variable is unused
2513 aside from its declaration
2514 This warning is enabled by @option{-Wall}.
2515
2516 To suppress this warning use the @samp{unused} attribute
2517 (@pxref{Variable Attributes}).
2518
2519 @item -Wunused-value
2520 @opindex Wunused-value
2521 Warn whenever a statement computes a result that is explicitly not used.
2522 This warning is enabled by @option{-Wall}.
2523
2524 To suppress this warning cast the expression to @samp{void}.
2525
2526 @item -Wunused
2527 @opindex Wunused
2528 All the above @option{-Wunused} options combined.
2529
2530 In order to get a warning about an unused function parameter, you must
2531 either specify @samp{-Wextra -Wunused} (note that @samp{-Wall} implies
2532 @samp{-Wunused}), or separately specify @option{-Wunused-parameter}.
2533
2534 @item -Wuninitialized
2535 @opindex Wuninitialized
2536 Warn if an automatic variable is used without first being initialized or
2537 if a variable may be clobbered by a @code{setjmp} call.
2538
2539 These warnings are possible only in optimizing compilation,
2540 because they require data flow information that is computed only
2541 when optimizing. If you don't specify @option{-O}, you simply won't
2542 get these warnings.
2543
2544 If you want to warn about code which uses the uninitialized value of the
2545 variable in its own initializer, use the @option{-Winit-self} option.
2546
2547 These warnings occur only for variables that are candidates for
2548 register allocation. Therefore, they do not occur for a variable that
2549 is declared @code{volatile}, or whose address is taken, or whose size
2550 is other than 1, 2, 4 or 8 bytes. Also, they do not occur for
2551 structures, unions or arrays, even when they are in registers.
2552
2553 Note that there may be no warning about a variable that is used only
2554 to compute a value that itself is never used, because such
2555 computations may be deleted by data flow analysis before the warnings
2556 are printed.
2557
2558 These warnings are made optional because GCC is not smart
2559 enough to see all the reasons why the code might be correct
2560 despite appearing to have an error. Here is one example of how
2561 this can happen:
2562
2563 @smallexample
2564 @group
2565 @{
2566 int x;
2567 switch (y)
2568 @{
2569 case 1: x = 1;
2570 break;
2571 case 2: x = 4;
2572 break;
2573 case 3: x = 5;
2574 @}
2575 foo (x);
2576 @}
2577 @end group
2578 @end smallexample
2579
2580 @noindent
2581 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
2582 always initialized, but GCC doesn't know this. Here is
2583 another common case:
2584
2585 @smallexample
2586 @{
2587 int save_y;
2588 if (change_y) save_y = y, y = new_y;
2589 @dots{}
2590 if (change_y) y = save_y;
2591 @}
2592 @end smallexample
2593
2594 @noindent
2595 This has no bug because @code{save_y} is used only if it is set.
2596
2597 @cindex @code{longjmp} warnings
2598 This option also warns when a non-volatile automatic variable might be
2599 changed by a call to @code{longjmp}. These warnings as well are possible
2600 only in optimizing compilation.
2601
2602 The compiler sees only the calls to @code{setjmp}. It cannot know
2603 where @code{longjmp} will be called; in fact, a signal handler could
2604 call it at any point in the code. As a result, you may get a warning
2605 even when there is in fact no problem because @code{longjmp} cannot
2606 in fact be called at the place which would cause a problem.
2607
2608 Some spurious warnings can be avoided if you declare all the functions
2609 you use that never return as @code{noreturn}. @xref{Function
2610 Attributes}.
2611
2612 This warning is enabled by @option{-Wall}.
2613
2614 @item -Wunknown-pragmas
2615 @opindex Wunknown-pragmas
2616 @cindex warning for unknown pragmas
2617 @cindex unknown pragmas, warning
2618 @cindex pragmas, warning of unknown
2619 Warn when a #pragma directive is encountered which is not understood by
2620 GCC@. If this command line option is used, warnings will even be issued
2621 for unknown pragmas in system header files. This is not the case if
2622 the warnings were only enabled by the @option{-Wall} command line option.
2623
2624 @item -Wstrict-aliasing
2625 @opindex Wstrict-aliasing
2626 This option is only active when @option{-fstrict-aliasing} is active.
2627 It warns about code which might break the strict aliasing rules that the
2628 compiler is using for optimization. The warning does not catch all
2629 cases, but does attempt to catch the more common pitfalls. It is
2630 included in @option{-Wall}.
2631
2632 @item -Wstrict-aliasing=2
2633 @opindex Wstrict-aliasing=2
2634 This option is only active when @option{-fstrict-aliasing} is active.
2635 It warns about all code which might break the strict aliasing rules that the
2636 compiler is using for optimization. This warning catches all cases, but
2637 it will also give a warning for some ambiguous cases that are safe.
2638
2639 @item -Wall
2640 @opindex Wall
2641 All of the above @samp{-W} options combined. This enables all the
2642 warnings about constructions that some users consider questionable, and
2643 that are easy to avoid (or modify to prevent the warning), even in
2644 conjunction with macros. This also enables some language-specific
2645 warnings described in @ref{C++ Dialect Options} and
2646 @ref{Objective-C and Objective-C++ Dialect Options}.
2647 @end table
2648
2649 The following @option{-W@dots{}} options are not implied by @option{-Wall}.
2650 Some of them warn about constructions that users generally do not
2651 consider questionable, but which occasionally you might wish to check
2652 for; others warn about constructions that are necessary or hard to avoid
2653 in some cases, and there is no simple way to modify the code to suppress
2654 the warning.
2655
2656 @table @gcctabopt
2657 @item -Wextra
2658 @opindex W
2659 @opindex Wextra
2660 (This option used to be called @option{-W}. The older name is still
2661 supported, but the newer name is more descriptive.) Print extra warning
2662 messages for these events:
2663
2664 @itemize @bullet
2665 @item
2666 A function can return either with or without a value. (Falling
2667 off the end of the function body is considered returning without
2668 a value.) For example, this function would evoke such a
2669 warning:
2670
2671 @smallexample
2672 @group
2673 foo (a)
2674 @{
2675 if (a > 0)
2676 return a;
2677 @}
2678 @end group
2679 @end smallexample
2680
2681 @item
2682 An expression-statement or the left-hand side of a comma expression
2683 contains no side effects.
2684 To suppress the warning, cast the unused expression to void.
2685 For example, an expression such as @samp{x[i,j]} will cause a warning,
2686 but @samp{x[(void)i,j]} will not.
2687
2688 @item
2689 An unsigned value is compared against zero with @samp{<} or @samp{>=}.
2690
2691 @item
2692 Storage-class specifiers like @code{static} are not the first things in
2693 a declaration. According to the C Standard, this usage is obsolescent.
2694
2695 @item
2696 If @option{-Wall} or @option{-Wunused} is also specified, warn about unused
2697 arguments.
2698
2699 @item
2700 A comparison between signed and unsigned values could produce an
2701 incorrect result when the signed value is converted to unsigned.
2702 (But don't warn if @option{-Wno-sign-compare} is also specified.)
2703
2704 @item
2705 An aggregate has an initializer which does not initialize all members.
2706 This warning can be independently controlled by
2707 @option{-Wmissing-field-initializers}.
2708
2709 @item
2710 A function parameter is declared without a type specifier in K&R-style
2711 functions:
2712
2713 @smallexample
2714 void foo(bar) @{ @}
2715 @end smallexample
2716
2717 @item
2718 An empty body occurs in an @samp{if} or @samp{else} statement.
2719
2720 @item
2721 A pointer is compared against integer zero with @samp{<}, @samp{<=},
2722 @samp{>}, or @samp{>=}.
2723
2724 @item
2725 A variable might be changed by @samp{longjmp} or @samp{vfork}.
2726
2727 @item
2728 Any of several floating-point events that often indicate errors, such as
2729 overflow, underflow, loss of precision, etc.
2730
2731 @item @r{(C++ only)}
2732 An enumerator and a non-enumerator both appear in a conditional expression.
2733
2734 @item @r{(C++ only)}
2735 A non-static reference or non-static @samp{const} member appears in a
2736 class without constructors.
2737
2738 @item @r{(C++ only)}
2739 Ambiguous virtual bases.
2740
2741 @item @r{(C++ only)}
2742 Subscripting an array which has been declared @samp{register}.
2743
2744 @item @r{(C++ only)}
2745 Taking the address of a variable which has been declared @samp{register}.
2746
2747 @item @r{(C++ only)}
2748 A base class is not initialized in a derived class' copy constructor.
2749 @end itemize
2750
2751 @item -Wno-div-by-zero
2752 @opindex Wno-div-by-zero
2753 @opindex Wdiv-by-zero
2754 Do not warn about compile-time integer division by zero. Floating point
2755 division by zero is not warned about, as it can be a legitimate way of
2756 obtaining infinities and NaNs.
2757
2758 @item -Wsystem-headers
2759 @opindex Wsystem-headers
2760 @cindex warnings from system headers
2761 @cindex system headers, warnings from
2762 Print warning messages for constructs found in system header files.
2763 Warnings from system headers are normally suppressed, on the assumption
2764 that they usually do not indicate real problems and would only make the
2765 compiler output harder to read. Using this command line option tells
2766 GCC to emit warnings from system headers as if they occurred in user
2767 code. However, note that using @option{-Wall} in conjunction with this
2768 option will @emph{not} warn about unknown pragmas in system
2769 headers---for that, @option{-Wunknown-pragmas} must also be used.
2770
2771 @item -Wfloat-equal
2772 @opindex Wfloat-equal
2773 Warn if floating point values are used in equality comparisons.
2774
2775 The idea behind this is that sometimes it is convenient (for the
2776 programmer) to consider floating-point values as approximations to
2777 infinitely precise real numbers. If you are doing this, then you need
2778 to compute (by analyzing the code, or in some other way) the maximum or
2779 likely maximum error that the computation introduces, and allow for it
2780 when performing comparisons (and when producing output, but that's a
2781 different problem). In particular, instead of testing for equality, you
2782 would check to see whether the two values have ranges that overlap; and
2783 this is done with the relational operators, so equality comparisons are
2784 probably mistaken.
2785
2786 @item -Wtraditional @r{(C only)}
2787 @opindex Wtraditional
2788 Warn about certain constructs that behave differently in traditional and
2789 ISO C@. Also warn about ISO C constructs that have no traditional C
2790 equivalent, and/or problematic constructs which should be avoided.
2791
2792 @itemize @bullet
2793 @item
2794 Macro parameters that appear within string literals in the macro body.
2795 In traditional C macro replacement takes place within string literals,
2796 but does not in ISO C@.
2797
2798 @item
2799 In traditional C, some preprocessor directives did not exist.
2800 Traditional preprocessors would only consider a line to be a directive
2801 if the @samp{#} appeared in column 1 on the line. Therefore
2802 @option{-Wtraditional} warns about directives that traditional C
2803 understands but would ignore because the @samp{#} does not appear as the
2804 first character on the line. It also suggests you hide directives like
2805 @samp{#pragma} not understood by traditional C by indenting them. Some
2806 traditional implementations would not recognize @samp{#elif}, so it
2807 suggests avoiding it altogether.
2808
2809 @item
2810 A function-like macro that appears without arguments.
2811
2812 @item
2813 The unary plus operator.
2814
2815 @item
2816 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating point
2817 constant suffixes. (Traditional C does support the @samp{L} suffix on integer
2818 constants.) Note, these suffixes appear in macros defined in the system
2819 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
2820 Use of these macros in user code might normally lead to spurious
2821 warnings, however GCC's integrated preprocessor has enough context to
2822 avoid warning in these cases.
2823
2824 @item
2825 A function declared external in one block and then used after the end of
2826 the block.
2827
2828 @item
2829 A @code{switch} statement has an operand of type @code{long}.
2830
2831 @item
2832 A non-@code{static} function declaration follows a @code{static} one.
2833 This construct is not accepted by some traditional C compilers.
2834
2835 @item
2836 The ISO type of an integer constant has a different width or
2837 signedness from its traditional type. This warning is only issued if
2838 the base of the constant is ten. I.e.@: hexadecimal or octal values, which
2839 typically represent bit patterns, are not warned about.
2840
2841 @item
2842 Usage of ISO string concatenation is detected.
2843
2844 @item
2845 Initialization of automatic aggregates.
2846
2847 @item
2848 Identifier conflicts with labels. Traditional C lacks a separate
2849 namespace for labels.
2850
2851 @item
2852 Initialization of unions. If the initializer is zero, the warning is
2853 omitted. This is done under the assumption that the zero initializer in
2854 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
2855 initializer warnings and relies on default initialization to zero in the
2856 traditional C case.
2857
2858 @item
2859 Conversions by prototypes between fixed/floating point values and vice
2860 versa. The absence of these prototypes when compiling with traditional
2861 C would cause serious problems. This is a subset of the possible
2862 conversion warnings, for the full set use @option{-Wconversion}.
2863
2864 @item
2865 Use of ISO C style function definitions. This warning intentionally is
2866 @emph{not} issued for prototype declarations or variadic functions
2867 because these ISO C features will appear in your code when using
2868 libiberty's traditional C compatibility macros, @code{PARAMS} and
2869 @code{VPARAMS}. This warning is also bypassed for nested functions
2870 because that feature is already a GCC extension and thus not relevant to
2871 traditional C compatibility.
2872 @end itemize
2873
2874 @item -Wdeclaration-after-statement @r{(C only)}
2875 @opindex Wdeclaration-after-statement
2876 Warn when a declaration is found after a statement in a block. This
2877 construct, known from C++, was introduced with ISO C99 and is by default
2878 allowed in GCC@. It is not supported by ISO C90 and was not supported by
2879 GCC versions before GCC 3.0. @xref{Mixed Declarations}.
2880
2881 @item -Wundef
2882 @opindex Wundef
2883 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
2884
2885 @item -Wno-endif-labels
2886 @opindex Wno-endif-labels
2887 @opindex Wendif-labels
2888 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
2889
2890 @item -Wshadow
2891 @opindex Wshadow
2892 Warn whenever a local variable shadows another local variable, parameter or
2893 global variable or whenever a built-in function is shadowed.
2894
2895 @item -Wlarger-than-@var{len}
2896 @opindex Wlarger-than
2897 Warn whenever an object of larger than @var{len} bytes is defined.
2898
2899 @item -Wpointer-arith
2900 @opindex Wpointer-arith
2901 Warn about anything that depends on the ``size of'' a function type or
2902 of @code{void}. GNU C assigns these types a size of 1, for
2903 convenience in calculations with @code{void *} pointers and pointers
2904 to functions.
2905
2906 @item -Wbad-function-cast @r{(C only)}
2907 @opindex Wbad-function-cast
2908 Warn whenever a function call is cast to a non-matching type.
2909 For example, warn if @code{int malloc()} is cast to @code{anything *}.
2910
2911 @item -Wcast-qual
2912 @opindex Wcast-qual
2913 Warn whenever a pointer is cast so as to remove a type qualifier from
2914 the target type. For example, warn if a @code{const char *} is cast
2915 to an ordinary @code{char *}.
2916
2917 @item -Wcast-align
2918 @opindex Wcast-align
2919 Warn whenever a pointer is cast such that the required alignment of the
2920 target is increased. For example, warn if a @code{char *} is cast to
2921 an @code{int *} on machines where integers can only be accessed at
2922 two- or four-byte boundaries.
2923
2924 @item -Wwrite-strings
2925 @opindex Wwrite-strings
2926 When compiling C, give string constants the type @code{const
2927 char[@var{length}]} so that
2928 copying the address of one into a non-@code{const} @code{char *}
2929 pointer will get a warning; when compiling C++, warn about the
2930 deprecated conversion from string constants to @code{char *}.
2931 These warnings will help you find at
2932 compile time code that can try to write into a string constant, but
2933 only if you have been very careful about using @code{const} in
2934 declarations and prototypes. Otherwise, it will just be a nuisance;
2935 this is why we did not make @option{-Wall} request these warnings.
2936
2937 @item -Wconversion
2938 @opindex Wconversion
2939 Warn if a prototype causes a type conversion that is different from what
2940 would happen to the same argument in the absence of a prototype. This
2941 includes conversions of fixed point to floating and vice versa, and
2942 conversions changing the width or signedness of a fixed point argument
2943 except when the same as the default promotion.
2944
2945 Also, warn if a negative integer constant expression is implicitly
2946 converted to an unsigned type. For example, warn about the assignment
2947 @code{x = -1} if @code{x} is unsigned. But do not warn about explicit
2948 casts like @code{(unsigned) -1}.
2949
2950 @item -Wsign-compare
2951 @opindex Wsign-compare
2952 @cindex warning for comparison of signed and unsigned values
2953 @cindex comparison of signed and unsigned values, warning
2954 @cindex signed and unsigned values, comparison warning
2955 Warn when a comparison between signed and unsigned values could produce
2956 an incorrect result when the signed value is converted to unsigned.
2957 This warning is also enabled by @option{-Wextra}; to get the other warnings
2958 of @option{-Wextra} without this warning, use @samp{-Wextra -Wno-sign-compare}.
2959
2960 @item -Waggregate-return
2961 @opindex Waggregate-return
2962 Warn if any functions that return structures or unions are defined or
2963 called. (In languages where you can return an array, this also elicits
2964 a warning.)
2965
2966 @item -Wstrict-prototypes @r{(C only)}
2967 @opindex Wstrict-prototypes
2968 Warn if a function is declared or defined without specifying the
2969 argument types. (An old-style function definition is permitted without
2970 a warning if preceded by a declaration which specifies the argument
2971 types.)
2972
2973 @item -Wold-style-definition @r{(C only)}
2974 @opindex Wold-style-definition
2975 Warn if an old-style function definition is used. A warning is given
2976 even if there is a previous prototype.
2977
2978 @item -Wmissing-prototypes @r{(C only)}
2979 @opindex Wmissing-prototypes
2980 Warn if a global function is defined without a previous prototype
2981 declaration. This warning is issued even if the definition itself
2982 provides a prototype. The aim is to detect global functions that fail
2983 to be declared in header files.
2984
2985 @item -Wmissing-declarations @r{(C only)}
2986 @opindex Wmissing-declarations
2987 Warn if a global function is defined without a previous declaration.
2988 Do so even if the definition itself provides a prototype.
2989 Use this option to detect global functions that are not declared in
2990 header files.
2991
2992 @item -Wmissing-field-initializers
2993 @opindex Wmissing-field-initializers
2994 @opindex W
2995 @opindex Wextra
2996 Warn if a structure's initializer has some fields missing. For
2997 example, the following code would cause such a warning, because
2998 @code{x.h} is implicitly zero:
2999
3000 @smallexample
3001 struct s @{ int f, g, h; @};
3002 struct s x = @{ 3, 4 @};
3003 @end smallexample
3004
3005 This option does not warn about designated initializers, so the following
3006 modification would not trigger a warning:
3007
3008 @smallexample
3009 struct s @{ int f, g, h; @};
3010 struct s x = @{ .f = 3, .g = 4 @};
3011 @end smallexample
3012
3013 This warning is included in @option{-Wextra}. To get other @option{-Wextra}
3014 warnings without this one, use @samp{-Wextra -Wno-missing-field-initializers}.
3015
3016 @item -Wmissing-noreturn
3017 @opindex Wmissing-noreturn
3018 Warn about functions which might be candidates for attribute @code{noreturn}.
3019 Note these are only possible candidates, not absolute ones. Care should
3020 be taken to manually verify functions actually do not ever return before
3021 adding the @code{noreturn} attribute, otherwise subtle code generation
3022 bugs could be introduced. You will not get a warning for @code{main} in
3023 hosted C environments.
3024
3025 @item -Wmissing-format-attribute
3026 @opindex Wmissing-format-attribute
3027 @opindex Wformat
3028 If @option{-Wformat} is enabled, also warn about functions which might be
3029 candidates for @code{format} attributes. Note these are only possible
3030 candidates, not absolute ones. GCC will guess that @code{format}
3031 attributes might be appropriate for any function that calls a function
3032 like @code{vprintf} or @code{vscanf}, but this might not always be the
3033 case, and some functions for which @code{format} attributes are
3034 appropriate may not be detected. This option has no effect unless
3035 @option{-Wformat} is enabled (possibly by @option{-Wall}).
3036
3037 @item -Wno-multichar
3038 @opindex Wno-multichar
3039 @opindex Wmultichar
3040 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
3041 Usually they indicate a typo in the user's code, as they have
3042 implementation-defined values, and should not be used in portable code.
3043
3044 @item -Wnormalized=<none|id|nfc|nfkc>
3045 @opindex Wnormalized
3046 @cindex NFC
3047 @cindex NFKC
3048 @cindex character set, input normalization
3049 In ISO C and ISO C++, two identifiers are different if they are
3050 different sequences of characters. However, sometimes when characters
3051 outside the basic ASCII character set are used, you can have two
3052 different character sequences that look the same. To avoid confusion,
3053 the ISO 10646 standard sets out some @dfn{normalization rules} which
3054 when applied ensure that two sequences that look the same are turned into
3055 the same sequence. GCC can warn you if you are using identifiers which
3056 have not been normalized; this option controls that warning.
3057
3058 There are four levels of warning that GCC supports. The default is
3059 @option{-Wnormalized=nfc}, which warns about any identifier which is
3060 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}. NFC is the
3061 recommended form for most uses.
3062
3063 Unfortunately, there are some characters which ISO C and ISO C++ allow
3064 in identifiers that when turned into NFC aren't allowable as
3065 identifiers. That is, there's no way to use these symbols in portable
3066 ISO C or C++ and have all your identifiers in NFC.
3067 @option{-Wnormalized=id} suppresses the warning for these characters.
3068 It is hoped that future versions of the standards involved will correct
3069 this, which is why this option is not the default.
3070
3071 You can switch the warning off for all characters by writing
3072 @option{-Wnormalized=none}. You would only want to do this if you
3073 were using some other normalization scheme (like ``D''), because
3074 otherwise you can easily create bugs that are literally impossible to see.
3075
3076 Some characters in ISO 10646 have distinct meanings but look identical
3077 in some fonts or display methodologies, especially once formatting has
3078 been applied. For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
3079 LETTER N'', will display just like a regular @code{n} which has been
3080 placed in a superscript. ISO 10646 defines the @dfn{NFKC}
3081 normalisation scheme to convert all these into a standard form as
3082 well, and GCC will warn if your code is not in NFKC if you use
3083 @option{-Wnormalized=nfkc}. This warning is comparable to warning
3084 about every identifier that contains the letter O because it might be
3085 confused with the digit 0, and so is not the default, but may be
3086 useful as a local coding convention if the programming environment is
3087 unable to be fixed to display these characters distinctly.
3088
3089 @item -Wno-deprecated-declarations
3090 @opindex Wno-deprecated-declarations
3091 Do not warn about uses of functions, variables, and types marked as
3092 deprecated by using the @code{deprecated} attribute.
3093 (@pxref{Function Attributes}, @pxref{Variable Attributes},
3094 @pxref{Type Attributes}.)
3095
3096 @item -Wpacked
3097 @opindex Wpacked
3098 Warn if a structure is given the packed attribute, but the packed
3099 attribute has no effect on the layout or size of the structure.
3100 Such structures may be mis-aligned for little benefit. For
3101 instance, in this code, the variable @code{f.x} in @code{struct bar}
3102 will be misaligned even though @code{struct bar} does not itself
3103 have the packed attribute:
3104
3105 @smallexample
3106 @group
3107 struct foo @{
3108 int x;
3109 char a, b, c, d;
3110 @} __attribute__((packed));
3111 struct bar @{
3112 char z;
3113 struct foo f;
3114 @};
3115 @end group
3116 @end smallexample
3117
3118 @item -Wpadded
3119 @opindex Wpadded
3120 Warn if padding is included in a structure, either to align an element
3121 of the structure or to align the whole structure. Sometimes when this
3122 happens it is possible to rearrange the fields of the structure to
3123 reduce the padding and so make the structure smaller.
3124
3125 @item -Wredundant-decls
3126 @opindex Wredundant-decls
3127 Warn if anything is declared more than once in the same scope, even in
3128 cases where multiple declaration is valid and changes nothing.
3129
3130 @item -Wnested-externs @r{(C only)}
3131 @opindex Wnested-externs
3132 Warn if an @code{extern} declaration is encountered within a function.
3133
3134 @item -Wunreachable-code
3135 @opindex Wunreachable-code
3136 Warn if the compiler detects that code will never be executed.
3137
3138 This option is intended to warn when the compiler detects that at
3139 least a whole line of source code will never be executed, because
3140 some condition is never satisfied or because it is after a
3141 procedure that never returns.
3142
3143 It is possible for this option to produce a warning even though there
3144 are circumstances under which part of the affected line can be executed,
3145 so care should be taken when removing apparently-unreachable code.
3146
3147 For instance, when a function is inlined, a warning may mean that the
3148 line is unreachable in only one inlined copy of the function.
3149
3150 This option is not made part of @option{-Wall} because in a debugging
3151 version of a program there is often substantial code which checks
3152 correct functioning of the program and is, hopefully, unreachable
3153 because the program does work. Another common use of unreachable
3154 code is to provide behavior which is selectable at compile-time.
3155
3156 @item -Winline
3157 @opindex Winline
3158 Warn if a function can not be inlined and it was declared as inline.
3159 Even with this option, the compiler will not warn about failures to
3160 inline functions declared in system headers.
3161
3162 The compiler uses a variety of heuristics to determine whether or not
3163 to inline a function. For example, the compiler takes into account
3164 the size of the function being inlined and the amount of inlining
3165 that has already been done in the current function. Therefore,
3166 seemingly insignificant changes in the source program can cause the
3167 warnings produced by @option{-Winline} to appear or disappear.
3168
3169 @item -Wno-invalid-offsetof @r{(C++ only)}
3170 @opindex Wno-invalid-offsetof
3171 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
3172 type. According to the 1998 ISO C++ standard, applying @samp{offsetof}
3173 to a non-POD type is undefined. In existing C++ implementations,
3174 however, @samp{offsetof} typically gives meaningful results even when
3175 applied to certain kinds of non-POD types. (Such as a simple
3176 @samp{struct} that fails to be a POD type only by virtue of having a
3177 constructor.) This flag is for users who are aware that they are
3178 writing nonportable code and who have deliberately chosen to ignore the
3179 warning about it.
3180
3181 The restrictions on @samp{offsetof} may be relaxed in a future version
3182 of the C++ standard.
3183
3184 @item -Wno-int-to-pointer-cast @r{(C only)}
3185 @opindex Wno-int-to-pointer-cast
3186 Suppress warnings from casts to pointer type of an integer of a
3187 different size.
3188
3189 @item -Wno-pointer-to-int-cast @r{(C only)}
3190 @opindex Wno-pointer-to-int-cast
3191 Suppress warnings from casts from a pointer to an integer type of a
3192 different size.
3193
3194 @item -Winvalid-pch
3195 @opindex Winvalid-pch
3196 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
3197 the search path but can't be used.
3198
3199 @item -Wlong-long
3200 @opindex Wlong-long
3201 @opindex Wno-long-long
3202 Warn if @samp{long long} type is used. This is default. To inhibit
3203 the warning messages, use @option{-Wno-long-long}. Flags
3204 @option{-Wlong-long} and @option{-Wno-long-long} are taken into account
3205 only when @option{-pedantic} flag is used.
3206
3207 @item -Wvariadic-macros
3208 @opindex Wvariadic-macros
3209 @opindex Wno-variadic-macros
3210 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
3211 alternate syntax when in pedantic ISO C99 mode. This is default.
3212 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
3213
3214 @item -Wdisabled-optimization
3215 @opindex Wdisabled-optimization
3216 Warn if a requested optimization pass is disabled. This warning does
3217 not generally indicate that there is anything wrong with your code; it
3218 merely indicates that GCC's optimizers were unable to handle the code
3219 effectively. Often, the problem is that your code is too big or too
3220 complex; GCC will refuse to optimize programs when the optimization
3221 itself is likely to take inordinate amounts of time.
3222
3223 @item -Wno-pointer-sign
3224 @opindex Wno-pointer-sign
3225 Don't warn for pointer argument passing or assignment with different signedness.
3226 Only useful in the negative form since this warning is enabled by default.
3227 This option is only supported for C and Objective-C@.
3228
3229 @item -Werror
3230 @opindex Werror
3231 Make all warnings into errors.
3232 @end table
3233
3234 @node Debugging Options
3235 @section Options for Debugging Your Program or GCC
3236 @cindex options, debugging
3237 @cindex debugging information options
3238
3239 GCC has various special options that are used for debugging
3240 either your program or GCC:
3241
3242 @table @gcctabopt
3243 @item -g
3244 @opindex g
3245 Produce debugging information in the operating system's native format
3246 (stabs, COFF, XCOFF, or DWARF 2)@. GDB can work with this debugging
3247 information.
3248
3249 On most systems that use stabs format, @option{-g} enables use of extra
3250 debugging information that only GDB can use; this extra information
3251 makes debugging work better in GDB but will probably make other debuggers
3252 crash or
3253 refuse to read the program. If you want to control for certain whether
3254 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
3255 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
3256
3257 GCC allows you to use @option{-g} with
3258 @option{-O}. The shortcuts taken by optimized code may occasionally
3259 produce surprising results: some variables you declared may not exist
3260 at all; flow of control may briefly move where you did not expect it;
3261 some statements may not be executed because they compute constant
3262 results or their values were already at hand; some statements may
3263 execute in different places because they were moved out of loops.
3264
3265 Nevertheless it proves possible to debug optimized output. This makes
3266 it reasonable to use the optimizer for programs that might have bugs.
3267
3268 The following options are useful when GCC is generated with the
3269 capability for more than one debugging format.
3270
3271 @item -ggdb
3272 @opindex ggdb
3273 Produce debugging information for use by GDB@. This means to use the
3274 most expressive format available (DWARF 2, stabs, or the native format
3275 if neither of those are supported), including GDB extensions if at all
3276 possible.
3277
3278 @item -gstabs
3279 @opindex gstabs
3280 Produce debugging information in stabs format (if that is supported),
3281 without GDB extensions. This is the format used by DBX on most BSD
3282 systems. On MIPS, Alpha and System V Release 4 systems this option
3283 produces stabs debugging output which is not understood by DBX or SDB@.
3284 On System V Release 4 systems this option requires the GNU assembler.
3285
3286 @item -feliminate-unused-debug-symbols
3287 @opindex feliminate-unused-debug-symbols
3288 Produce debugging information in stabs format (if that is supported),
3289 for only symbols that are actually used.
3290
3291 @item -gstabs+
3292 @opindex gstabs+
3293 Produce debugging information in stabs format (if that is supported),
3294 using GNU extensions understood only by the GNU debugger (GDB)@. The
3295 use of these extensions is likely to make other debuggers crash or
3296 refuse to read the program.
3297
3298 @item -gcoff
3299 @opindex gcoff
3300 Produce debugging information in COFF format (if that is supported).
3301 This is the format used by SDB on most System V systems prior to
3302 System V Release 4.
3303
3304 @item -gxcoff
3305 @opindex gxcoff
3306 Produce debugging information in XCOFF format (if that is supported).
3307 This is the format used by the DBX debugger on IBM RS/6000 systems.
3308
3309 @item -gxcoff+
3310 @opindex gxcoff+
3311 Produce debugging information in XCOFF format (if that is supported),
3312 using GNU extensions understood only by the GNU debugger (GDB)@. The
3313 use of these extensions is likely to make other debuggers crash or
3314 refuse to read the program, and may cause assemblers other than the GNU
3315 assembler (GAS) to fail with an error.
3316
3317 @item -gdwarf-2
3318 @opindex gdwarf-2
3319 Produce debugging information in DWARF version 2 format (if that is
3320 supported). This is the format used by DBX on IRIX 6. With this
3321 option, GCC uses features of DWARF version 3 when they are useful;
3322 version 3 is upward compatible with version 2, but may still cause
3323 problems for older debuggers.
3324
3325 @item -gvms
3326 @opindex gvms
3327 Produce debugging information in VMS debug format (if that is
3328 supported). This is the format used by DEBUG on VMS systems.
3329
3330 @item -g@var{level}
3331 @itemx -ggdb@var{level}
3332 @itemx -gstabs@var{level}
3333 @itemx -gcoff@var{level}
3334 @itemx -gxcoff@var{level}
3335 @itemx -gvms@var{level}
3336 Request debugging information and also use @var{level} to specify how
3337 much information. The default level is 2.
3338
3339 Level 1 produces minimal information, enough for making backtraces in
3340 parts of the program that you don't plan to debug. This includes
3341 descriptions of functions and external variables, but no information
3342 about local variables and no line numbers.
3343
3344 Level 3 includes extra information, such as all the macro definitions
3345 present in the program. Some debuggers support macro expansion when
3346 you use @option{-g3}.
3347
3348 @option{-gdwarf-2} does not accept a concatenated debug level, because
3349 GCC used to support an option @option{-gdwarf} that meant to generate
3350 debug information in version 1 of the DWARF format (which is very
3351 different from version 2), and it would have been too confusing. That
3352 debug format is long obsolete, but the option cannot be changed now.
3353 Instead use an additional @option{-g@var{level}} option to change the
3354 debug level for DWARF2.
3355
3356 @item -feliminate-dwarf2-dups
3357 @opindex feliminate-dwarf2-dups
3358 Compress DWARF2 debugging information by eliminating duplicated
3359 information about each symbol. This option only makes sense when
3360 generating DWARF2 debugging information with @option{-gdwarf-2}.
3361
3362 @cindex @command{prof}
3363 @item -p
3364 @opindex p
3365 Generate extra code to write profile information suitable for the
3366 analysis program @command{prof}. You must use this option when compiling
3367 the source files you want data about, and you must also use it when
3368 linking.
3369
3370 @cindex @command{gprof}
3371 @item -pg
3372 @opindex pg
3373 Generate extra code to write profile information suitable for the
3374 analysis program @command{gprof}. You must use this option when compiling
3375 the source files you want data about, and you must also use it when
3376 linking.
3377
3378 @item -Q
3379 @opindex Q
3380 Makes the compiler print out each function name as it is compiled, and
3381 print some statistics about each pass when it finishes.
3382
3383 @item -ftime-report
3384 @opindex ftime-report
3385 Makes the compiler print some statistics about the time consumed by each
3386 pass when it finishes.
3387
3388 @item -fmem-report
3389 @opindex fmem-report
3390 Makes the compiler print some statistics about permanent memory
3391 allocation when it finishes.
3392
3393 @item -fprofile-arcs
3394 @opindex fprofile-arcs
3395 Add code so that program flow @dfn{arcs} are instrumented. During
3396 execution the program records how many times each branch and call is
3397 executed and how many times it is taken or returns. When the compiled
3398 program exits it saves this data to a file called
3399 @file{@var{auxname}.gcda} for each source file. The data may be used for
3400 profile-directed optimizations (@option{-fbranch-probabilities}), or for
3401 test coverage analysis (@option{-ftest-coverage}). Each object file's
3402 @var{auxname} is generated from the name of the output file, if
3403 explicitly specified and it is not the final executable, otherwise it is
3404 the basename of the source file. In both cases any suffix is removed
3405 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
3406 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
3407
3408 @cindex @command{gcov}
3409 @item --coverage
3410 @opindex coverage
3411
3412 This option is used to compile and link code instrumented for coverage
3413 analysis. The option is a synonym for @option{-fprofile-arcs}
3414 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
3415 linking). See the documentation for those options for more details.
3416
3417 @itemize
3418
3419 @item
3420 Compile the source files with @option{-fprofile-arcs} plus optimization
3421 and code generation options. For test coverage analysis, use the
3422 additional @option{-ftest-coverage} option. You do not need to profile
3423 every source file in a program.
3424
3425 @item
3426 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
3427 (the latter implies the former).
3428
3429 @item
3430 Run the program on a representative workload to generate the arc profile
3431 information. This may be repeated any number of times. You can run
3432 concurrent instances of your program, and provided that the file system
3433 supports locking, the data files will be correctly updated. Also
3434 @code{fork} calls are detected and correctly handled (double counting
3435 will not happen).
3436
3437 @item
3438 For profile-directed optimizations, compile the source files again with
3439 the same optimization and code generation options plus
3440 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
3441 Control Optimization}).
3442
3443 @item
3444 For test coverage analysis, use @command{gcov} to produce human readable
3445 information from the @file{.gcno} and @file{.gcda} files. Refer to the
3446 @command{gcov} documentation for further information.
3447
3448 @end itemize
3449
3450 With @option{-fprofile-arcs}, for each function of your program GCC
3451 creates a program flow graph, then finds a spanning tree for the graph.
3452 Only arcs that are not on the spanning tree have to be instrumented: the
3453 compiler adds code to count the number of times that these arcs are
3454 executed. When an arc is the only exit or only entrance to a block, the
3455 instrumentation code can be added to the block; otherwise, a new basic
3456 block must be created to hold the instrumentation code.
3457
3458 @item -ftree-based-profiling
3459 @opindex ftree-based-profiling
3460 This option is used in addition to @option{-fprofile-arcs} or
3461 @option{-fbranch-probabilities} to control whether those optimizations
3462 are performed on a tree-based or rtl-based internal representation.
3463 If you use this option when compiling with @option{-fprofile-arcs},
3464 you must also use it when compiling later with @option{-fbranch-probabilities}.
3465 Currently the tree-based optimization is in an early stage of
3466 development, and this option is recommended only for those people
3467 working on improving it.
3468
3469 @need 2000
3470 @item -ftest-coverage
3471 @opindex ftest-coverage
3472 Produce a notes file that the @command{gcov} code-coverage utility
3473 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
3474 show program coverage. Each source file's note file is called
3475 @file{@var{auxname}.gcno}. Refer to the @option{-fprofile-arcs} option
3476 above for a description of @var{auxname} and instructions on how to
3477 generate test coverage data. Coverage data will match the source files
3478 more closely, if you do not optimize.
3479
3480 @item -d@var{letters}
3481 @item -fdump-rtl-@var{pass}
3482 @opindex d
3483 Says to make debugging dumps during compilation at times specified by
3484 @var{letters}. This is used for debugging the RTL-based passes of the
3485 compiler. The file names for most of the dumps are made by appending a
3486 pass number and a word to the @var{dumpname}. @var{dumpname} is generated
3487 from the name of the output file, if explicitly specified and it is not
3488 an executable, otherwise it is the basename of the source file.
3489
3490 Most debug dumps can be enabled either passing a letter to the @option{-d}
3491 option, or with a long @option{-fdump-rtl} switch; here are the possible
3492 letters for use in @var{letters} and @var{pass}, and their meanings:
3493
3494 @table @gcctabopt
3495 @item -dA
3496 @opindex dA
3497 Annotate the assembler output with miscellaneous debugging information.
3498
3499 @item -db
3500 @itemx -fdump-rtl-bp
3501 @opindex db
3502 @opindex fdump-rtl-bp
3503 Dump after computing branch probabilities, to @file{@var{file}.09.bp}.
3504
3505 @item -dB
3506 @itemx -fdump-rtl-bbro
3507 @opindex dB
3508 @opindex fdump-rtl-bbro
3509 Dump after block reordering, to @file{@var{file}.30.bbro}.
3510
3511 @item -dc
3512 @itemx -fdump-rtl-combine
3513 @opindex dc
3514 @opindex fdump-rtl-combine
3515 Dump after instruction combination, to the file @file{@var{file}.17.combine}.
3516
3517 @item -dC
3518 @itemx -fdump-rtl-ce1
3519 @itemx -fdump-rtl-ce2
3520 @opindex dC
3521 @opindex fdump-rtl-ce1
3522 @opindex fdump-rtl-ce2
3523 @option{-dC} and @option{-fdump-rtl-ce1} enable dumping after the
3524 first if conversion, to the file @file{@var{file}.11.ce1}. @option{-dC}
3525 and @option{-fdump-rtl-ce2} enable dumping after the second if
3526 conversion, to the file @file{@var{file}.18.ce2}.
3527
3528 @item -dd
3529 @itemx -fdump-rtl-btl
3530 @itemx -fdump-rtl-dbr
3531 @opindex dd
3532 @opindex fdump-rtl-btl
3533 @opindex fdump-rtl-dbr
3534 @option{-dd} and @option{-fdump-rtl-btl} enable dumping after branch
3535 target load optimization, to @file{@var{file}.31.btl}. @option{-dd}
3536 and @option{-fdump-rtl-dbr} enable dumping after delayed branch
3537 scheduling, to @file{@var{file}.36.dbr}.
3538
3539 @item -dD
3540 @opindex dD
3541 Dump all macro definitions, at the end of preprocessing, in addition to
3542 normal output.
3543
3544 @item -dE
3545 @itemx -fdump-rtl-ce3
3546 @opindex dE
3547 @opindex fdump-rtl-ce3
3548 Dump after the third if conversion, to @file{@var{file}.28.ce3}.
3549
3550 @item -df
3551 @itemx -fdump-rtl-cfg
3552 @itemx -fdump-rtl-life
3553 @opindex df
3554 @opindex fdump-rtl-cfg
3555 @opindex fdump-rtl-life
3556 @option{-df} and @option{-fdump-rtl-cfg} enable dumping after control
3557 and data flow analysis, to @file{@var{file}.08.cfg}. @option{-df}
3558 and @option{-fdump-rtl-cfg} enable dumping dump after life analysis,
3559 to @file{@var{file}.16.life}.
3560
3561 @item -dg
3562 @itemx -fdump-rtl-greg
3563 @opindex dg
3564 @opindex fdump-rtl-greg
3565 Dump after global register allocation, to @file{@var{file}.23.greg}.
3566
3567 @item -dG
3568 @itemx -fdump-rtl-gcse
3569 @itemx -fdump-rtl-bypass
3570 @opindex dG
3571 @opindex fdump-rtl-gcse
3572 @opindex fdump-rtl-bypass
3573 @option{-dG} and @option{-fdump-rtl-gcse} enable dumping after GCSE, to
3574 @file{@var{file}.05.gcse}. @option{-dG} and @option{-fdump-rtl-bypass}
3575 enable dumping after jump bypassing and control flow optimizations, to
3576 @file{@var{file}.07.bypass}.
3577
3578 @item -dh
3579 @itemx -fdump-rtl-eh
3580 @opindex dh
3581 @opindex fdump-rtl-eh
3582 Dump after finalization of EH handling code, to @file{@var{file}.02.eh}.
3583
3584 @item -di
3585 @itemx -fdump-rtl-sibling
3586 @opindex di
3587 @opindex fdump-rtl-sibling
3588 Dump after sibling call optimizations, to @file{@var{file}.01.sibling}.
3589
3590 @item -dj
3591 @itemx -fdump-rtl-jump
3592 @opindex dj
3593 @opindex fdump-rtl-jump
3594 Dump after the first jump optimization, to @file{@var{file}.03.jump}.
3595
3596 @item -dk
3597 @itemx -fdump-rtl-stack
3598 @opindex dk
3599 @opindex fdump-rtl-stack
3600 Dump after conversion from registers to stack, to @file{@var{file}.33.stack}.
3601
3602 @item -dl
3603 @itemx -fdump-rtl-lreg
3604 @opindex dl
3605 @opindex fdump-rtl-lreg
3606 Dump after local register allocation, to @file{@var{file}.22.lreg}.
3607
3608 @item -dL
3609 @itemx -fdump-rtl-loop
3610 @itemx -fdump-rtl-loop2
3611 @opindex dL
3612 @opindex fdump-rtl-loop
3613 @opindex fdump-rtl-loop2
3614 @option{-dL} and @option{-fdump-rtl-loop} enable dumping after the first
3615 loop optimization pass, to @file{@var{file}.06.loop}. @option{-dL} and
3616 @option{-fdump-rtl-loop2} enable dumping after the second pass, to
3617 @file{@var{file}.13.loop2}.
3618
3619 @item -dm
3620 @itemx -fdump-rtl-sms
3621 @opindex dm
3622 @opindex fdump-rtl-sms
3623 Dump after modulo scheduling, to @file{@var{file}.20.sms}.
3624
3625 @item -dM
3626 @itemx -fdump-rtl-mach
3627 @opindex dM
3628 @opindex fdump-rtl-mach
3629 Dump after performing the machine dependent reorganization pass, to
3630 @file{@var{file}.35.mach}.
3631
3632 @item -dn
3633 @itemx -fdump-rtl-rnreg
3634 @opindex dn
3635 @opindex fdump-rtl-rnreg
3636 Dump after register renumbering, to @file{@var{file}.29.rnreg}.
3637
3638 @item -dN
3639 @itemx -fdump-rtl-regmove
3640 @opindex dN
3641 @opindex fdump-rtl-regmove
3642 Dump after the register move pass, to @file{@var{file}.19.regmove}.
3643
3644 @item -do
3645 @itemx -fdump-rtl-postreload
3646 @opindex do
3647 @opindex fdump-rtl-postreload
3648 Dump after post-reload optimizations, to @file{@var{file}.24.postreload}.
3649
3650 @item -dr
3651 @itemx -fdump-rtl-expand
3652 @opindex dr
3653 @opindex fdump-rtl-expand
3654 Dump after RTL generation, to @file{@var{file}.00.expand}.
3655
3656 @item -dR
3657 @itemx -fdump-rtl-sched2
3658 @opindex dR
3659 @opindex fdump-rtl-sched2
3660 Dump after the second scheduling pass, to @file{@var{file}.32.sched2}.
3661
3662 @item -ds
3663 @itemx -fdump-rtl-cse
3664 @opindex ds
3665 @opindex fdump-rtl-cse
3666 Dump after CSE (including the jump optimization that sometimes follows
3667 CSE), to @file{@var{file}.04.cse}.
3668
3669 @item -dS
3670 @itemx -fdump-rtl-sched
3671 @opindex dS
3672 @opindex fdump-rtl-sched
3673 Dump after the first scheduling pass, to @file{@var{file}.21.sched}.
3674
3675 @item -dt
3676 @itemx -fdump-rtl-cse2
3677 @opindex dt
3678 @opindex fdump-rtl-cse2
3679 Dump after the second CSE pass (including the jump optimization that
3680 sometimes follows CSE), to @file{@var{file}.15.cse2}.
3681
3682 @item -dT
3683 @itemx -fdump-rtl-tracer
3684 @opindex dT
3685 @opindex fdump-rtl-tracer
3686 Dump after running tracer, to @file{@var{file}.12.tracer}.
3687
3688 @item -dV
3689 @itemx -fdump-rtl-vpt
3690 @itemx -fdump-rtl-vartrack
3691 @opindex dV
3692 @opindex fdump-rtl-vpt
3693 @opindex fdump-rtl-vartrack
3694 @option{-dV} and @option{-fdump-rtl-vpt} enable dumping after the value
3695 profile transformations, to @file{@var{file}.10.vpt}. @option{-dV}
3696 and @option{-fdump-rtl-vartrack} enable dumping after variable tracking,
3697 to @file{@var{file}.34.vartrack}.
3698
3699 @item -dw
3700 @itemx -fdump-rtl-flow2
3701 @opindex dw
3702 @opindex fdump-rtl-flow2
3703 Dump after the second flow pass, to @file{@var{file}.26.flow2}.
3704
3705 @item -dz
3706 @itemx -fdump-rtl-peephole2
3707 @opindex dz
3708 @opindex fdump-rtl-peephole2
3709 Dump after the peephole pass, to @file{@var{file}.27.peephole2}.
3710
3711 @item -dZ
3712 @itemx -fdump-rtl-web
3713 @opindex dZ
3714 @opindex fdump-rtl-web
3715 Dump after live range splitting, to @file{@var{file}.14.web}.
3716
3717 @item -da
3718 @itemx -fdump-rtl-all
3719 @opindex da
3720 @opindex fdump-rtl-all
3721 Produce all the dumps listed above.
3722
3723 @item -dH
3724 @opindex dH
3725 Produce a core dump whenever an error occurs.
3726
3727 @item -dm
3728 @opindex dm
3729 Print statistics on memory usage, at the end of the run, to
3730 standard error.
3731
3732 @item -dp
3733 @opindex dp
3734 Annotate the assembler output with a comment indicating which
3735 pattern and alternative was used. The length of each instruction is
3736 also printed.
3737
3738 @item -dP
3739 @opindex dP
3740 Dump the RTL in the assembler output as a comment before each instruction.
3741 Also turns on @option{-dp} annotation.
3742
3743 @item -dv
3744 @opindex dv
3745 For each of the other indicated dump files (either with @option{-d} or
3746 @option{-fdump-rtl-@var{pass}}), dump a representation of the control flow
3747 graph suitable for viewing with VCG to @file{@var{file}.@var{pass}.vcg}.
3748
3749 @item -dx
3750 @opindex dx
3751 Just generate RTL for a function instead of compiling it. Usually used
3752 with @samp{r} (@option{-fdump-rtl-expand}).
3753
3754 @item -dy
3755 @opindex dy
3756 Dump debugging information during parsing, to standard error.
3757 @end table
3758
3759 @item -fdump-unnumbered
3760 @opindex fdump-unnumbered
3761 When doing debugging dumps (see @option{-d} option above), suppress instruction
3762 numbers and line number note output. This makes it more feasible to
3763 use diff on debugging dumps for compiler invocations with different
3764 options, in particular with and without @option{-g}.
3765
3766 @item -fdump-translation-unit @r{(C and C++ only)}
3767 @itemx -fdump-translation-unit-@var{options} @r{(C and C++ only)}
3768 @opindex fdump-translation-unit
3769 Dump a representation of the tree structure for the entire translation
3770 unit to a file. The file name is made by appending @file{.tu} to the
3771 source file name. If the @samp{-@var{options}} form is used, @var{options}
3772 controls the details of the dump as described for the
3773 @option{-fdump-tree} options.
3774
3775 @item -fdump-class-hierarchy @r{(C++ only)}
3776 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
3777 @opindex fdump-class-hierarchy
3778 Dump a representation of each class's hierarchy and virtual function
3779 table layout to a file. The file name is made by appending @file{.class}
3780 to the source file name. If the @samp{-@var{options}} form is used,
3781 @var{options} controls the details of the dump as described for the
3782 @option{-fdump-tree} options.
3783
3784 @item -fdump-ipa-@var{switch}
3785 @opindex fdump-ipa
3786 Control the dumping at various stages of inter-procedural analysis
3787 language tree to a file. The file name is generated by appending a switch
3788 specific suffix to the source file name. The following dumps are possible:
3789
3790 @table @samp
3791 @item all
3792 Enables all inter-procedural analysis dumps; currently the only produced
3793 dump is the @samp{cgraph} dump.
3794
3795 @item cgraph
3796 Dumps information about call-graph optimization, unused function removal,
3797 and inlining decisions.
3798 @end table
3799
3800 @item -fdump-tree-@var{switch} @r{(C and C++ only)}
3801 @itemx -fdump-tree-@var{switch}-@var{options} @r{(C and C++ only)}
3802 @opindex fdump-tree
3803 Control the dumping at various stages of processing the intermediate
3804 language tree to a file. The file name is generated by appending a switch
3805 specific suffix to the source file name. If the @samp{-@var{options}}
3806 form is used, @var{options} is a list of @samp{-} separated options that
3807 control the details of the dump. Not all options are applicable to all
3808 dumps, those which are not meaningful will be ignored. The following
3809 options are available
3810
3811 @table @samp
3812 @item address
3813 Print the address of each node. Usually this is not meaningful as it
3814 changes according to the environment and source file. Its primary use
3815 is for tying up a dump file with a debug environment.
3816 @item slim
3817 Inhibit dumping of members of a scope or body of a function merely
3818 because that scope has been reached. Only dump such items when they
3819 are directly reachable by some other path. When dumping pretty-printed
3820 trees, this option inhibits dumping the bodies of control structures.
3821 @item raw
3822 Print a raw representation of the tree. By default, trees are
3823 pretty-printed into a C-like representation.
3824 @item details
3825 Enable more detailed dumps (not honored by every dump option).
3826 @item stats
3827 Enable dumping various statistics about the pass (not honored by every dump
3828 option).
3829 @item blocks
3830 Enable showing basic block boundaries (disabled in raw dumps).
3831 @item vops
3832 Enable showing virtual operands for every statement.
3833 @item lineno
3834 Enable showing line numbers for statements.
3835 @item uid
3836 Enable showing the unique ID (@code{DECL_UID}) for each variable.
3837 @item all
3838 Turn on all options, except @option{raw}, @option{slim} and @option{lineno}.
3839 @end table
3840
3841 The following tree dumps are possible:
3842 @table @samp
3843
3844 @item original
3845 Dump before any tree based optimization, to @file{@var{file}.original}.
3846
3847 @item optimized
3848 Dump after all tree based optimization, to @file{@var{file}.optimized}.
3849
3850 @item inlined
3851 Dump after function inlining, to @file{@var{file}.inlined}.
3852
3853 @item gimple
3854 @opindex fdump-tree-gimple
3855 Dump each function before and after the gimplification pass to a file. The
3856 file name is made by appending @file{.gimple} to the source file name.
3857
3858 @item cfg
3859 @opindex fdump-tree-cfg
3860 Dump the control flow graph of each function to a file. The file name is
3861 made by appending @file{.cfg} to the source file name.
3862
3863 @item vcg
3864 @opindex fdump-tree-vcg
3865 Dump the control flow graph of each function to a file in VCG format. The
3866 file name is made by appending @file{.vcg} to the source file name. Note
3867 that if the file contains more than one function, the generated file cannot
3868 be used directly by VCG@. You will need to cut and paste each function's
3869 graph into its own separate file first.
3870
3871 @item ch
3872 @opindex fdump-tree-ch
3873 Dump each function after copying loop headers. The file name is made by
3874 appending @file{.ch} to the source file name.
3875
3876 @item ssa
3877 @opindex fdump-tree-ssa
3878 Dump SSA related information to a file. The file name is made by appending
3879 @file{.ssa} to the source file name.
3880
3881 @item salias
3882 @opindex fdump-tree-salias
3883 Dump structure aliasing variable information to a file. This file name
3884 is made by appending @file{.salias} to the source file name.
3885
3886 @item alias
3887 @opindex fdump-tree-alias
3888 Dump aliasing information for each function. The file name is made by
3889 appending @file{.alias} to the source file name.
3890
3891 @item ccp
3892 @opindex fdump-tree-ccp
3893 Dump each function after CCP@. The file name is made by appending
3894 @file{.ccp} to the source file name.
3895
3896 @item storeccp
3897 @opindex fdump-tree-storeccp
3898 Dump each function after STORE-CCP. The file name is made by appending
3899 @file{.storeccp} to the source file name.
3900
3901 @item pre
3902 @opindex fdump-tree-pre
3903 Dump trees after partial redundancy elimination. The file name is made
3904 by appending @file{.pre} to the source file name.
3905
3906 @item fre
3907 @opindex fdump-tree-fre
3908 Dump trees after full redundancy elimination. The file name is made
3909 by appending @file{.fre} to the source file name.
3910
3911 @item copyprop
3912 @opindex fdump-tree-copyprop
3913 Dump trees after copy propagation. The file name is made
3914 by appending @file{.copyprop} to the source file name.
3915
3916 @item store_copyprop
3917 @opindex fdump-tree-store_copyprop
3918 Dump trees after store copy-propagation. The file name is made
3919 by appending @file{.store_copyprop} to the source file name.
3920
3921 @item dce
3922 @opindex fdump-tree-dce
3923 Dump each function after dead code elimination. The file name is made by
3924 appending @file{.dce} to the source file name.
3925
3926 @item mudflap
3927 @opindex fdump-tree-mudflap
3928 Dump each function after adding mudflap instrumentation. The file name is
3929 made by appending @file{.mudflap} to the source file name.
3930
3931 @item sra
3932 @opindex fdump-tree-sra
3933 Dump each function after performing scalar replacement of aggregates. The
3934 file name is made by appending @file{.sra} to the source file name.
3935
3936 @item sink
3937 @opindex fdump-tree-sink
3938 Dump each function after performing code sinking. The file name is made
3939 by appending @file{.sink} to the source file name.
3940
3941 @item dom
3942 @opindex fdump-tree-dom
3943 Dump each function after applying dominator tree optimizations. The file
3944 name is made by appending @file{.dom} to the source file name.
3945
3946 @item dse
3947 @opindex fdump-tree-dse
3948 Dump each function after applying dead store elimination. The file
3949 name is made by appending @file{.dse} to the source file name.
3950
3951 @item phiopt
3952 @opindex fdump-tree-phiopt
3953 Dump each function after optimizing PHI nodes into straightline code. The file
3954 name is made by appending @file{.phiopt} to the source file name.
3955
3956 @item forwprop
3957 @opindex fdump-tree-forwprop
3958 Dump each function after forward propagating single use variables. The file
3959 name is made by appending @file{.forwprop} to the source file name.
3960
3961 @item copyrename
3962 @opindex fdump-tree-copyrename
3963 Dump each function after applying the copy rename optimization. The file
3964 name is made by appending @file{.copyrename} to the source file name.
3965
3966 @item nrv
3967 @opindex fdump-tree-nrv
3968 Dump each function after applying the named return value optimization on
3969 generic trees. The file name is made by appending @file{.nrv} to the source
3970 file name.
3971
3972 @item vect
3973 @opindex fdump-tree-vect
3974 Dump each function after applying vectorization of loops. The file name is
3975 made by appending @file{.vect} to the source file name.
3976
3977 @item all
3978 @opindex fdump-tree-all
3979 Enable all the available tree dumps with the flags provided in this option.
3980 @end table
3981
3982 @item -ftree-vectorizer-verbose=@var{n}
3983 @opindex ftree-vectorizer-verbose
3984 This option controls the amount of debugging output the vectorizer prints.
3985 This information is written to standard error, unless @option{-fdump-tree-all}
3986 or @option{-fdump-tree-vect} is specified, in which case it is output to the
3987 usual dump listing file, @file{.vect}.
3988
3989 @item -frandom-seed=@var{string}
3990 @opindex frandom-string
3991 This option provides a seed that GCC uses when it would otherwise use
3992 random numbers. It is used to generate certain symbol names
3993 that have to be different in every compiled file. It is also used to
3994 place unique stamps in coverage data files and the object files that
3995 produce them. You can use the @option{-frandom-seed} option to produce
3996 reproducibly identical object files.
3997
3998 The @var{string} should be different for every file you compile.
3999
4000 @item -fsched-verbose=@var{n}
4001 @opindex fsched-verbose
4002 On targets that use instruction scheduling, this option controls the
4003 amount of debugging output the scheduler prints. This information is
4004 written to standard error, unless @option{-dS} or @option{-dR} is
4005 specified, in which case it is output to the usual dump
4006 listing file, @file{.sched} or @file{.sched2} respectively. However
4007 for @var{n} greater than nine, the output is always printed to standard
4008 error.
4009
4010 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
4011 same information as @option{-dRS}. For @var{n} greater than one, it
4012 also output basic block probabilities, detailed ready list information
4013 and unit/insn info. For @var{n} greater than two, it includes RTL
4014 at abort point, control-flow and regions info. And for @var{n} over
4015 four, @option{-fsched-verbose} also includes dependence info.
4016
4017 @item -save-temps
4018 @opindex save-temps
4019 Store the usual ``temporary'' intermediate files permanently; place them
4020 in the current directory and name them based on the source file. Thus,
4021 compiling @file{foo.c} with @samp{-c -save-temps} would produce files
4022 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}. This creates a
4023 preprocessed @file{foo.i} output file even though the compiler now
4024 normally uses an integrated preprocessor.
4025
4026 When used in combination with the @option{-x} command line option,
4027 @option{-save-temps} is sensible enough to avoid over writing an
4028 input source file with the same extension as an intermediate file.
4029 The corresponding intermediate file may be obtained by renaming the
4030 source file before using @option{-save-temps}.
4031
4032 @item -time
4033 @opindex time
4034 Report the CPU time taken by each subprocess in the compilation
4035 sequence. For C source files, this is the compiler proper and assembler
4036 (plus the linker if linking is done). The output looks like this:
4037
4038 @smallexample
4039 # cc1 0.12 0.01
4040 # as 0.00 0.01
4041 @end smallexample
4042
4043 The first number on each line is the ``user time'', that is time spent
4044 executing the program itself. The second number is ``system time'',
4045 time spent executing operating system routines on behalf of the program.
4046 Both numbers are in seconds.
4047
4048 @item -fvar-tracking
4049 @opindex fvar-tracking
4050 Run variable tracking pass. It computes where variables are stored at each
4051 position in code. Better debugging information is then generated
4052 (if the debugging information format supports this information).
4053
4054 It is enabled by default when compiling with optimization (@option{-Os},
4055 @option{-O}, @option{-O2}, ...), debugging information (@option{-g}) and
4056 the debug info format supports it.
4057
4058 @item -print-file-name=@var{library}
4059 @opindex print-file-name
4060 Print the full absolute name of the library file @var{library} that
4061 would be used when linking---and don't do anything else. With this
4062 option, GCC does not compile or link anything; it just prints the
4063 file name.
4064
4065 @item -print-multi-directory
4066 @opindex print-multi-directory
4067 Print the directory name corresponding to the multilib selected by any
4068 other switches present in the command line. This directory is supposed
4069 to exist in @env{GCC_EXEC_PREFIX}.
4070
4071 @item -print-multi-lib
4072 @opindex print-multi-lib
4073 Print the mapping from multilib directory names to compiler switches
4074 that enable them. The directory name is separated from the switches by
4075 @samp{;}, and each switch starts with an @samp{@@} instead of the
4076 @samp{-}, without spaces between multiple switches. This is supposed to
4077 ease shell-processing.
4078
4079 @item -print-prog-name=@var{program}
4080 @opindex print-prog-name
4081 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
4082
4083 @item -print-libgcc-file-name
4084 @opindex print-libgcc-file-name
4085 Same as @option{-print-file-name=libgcc.a}.
4086
4087 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
4088 but you do want to link with @file{libgcc.a}. You can do
4089
4090 @smallexample
4091 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
4092 @end smallexample
4093
4094 @item -print-search-dirs
4095 @opindex print-search-dirs
4096 Print the name of the configured installation directory and a list of
4097 program and library directories @command{gcc} will search---and don't do anything else.
4098
4099 This is useful when @command{gcc} prints the error message
4100 @samp{installation problem, cannot exec cpp0: No such file or directory}.
4101 To resolve this you either need to put @file{cpp0} and the other compiler
4102 components where @command{gcc} expects to find them, or you can set the environment
4103 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
4104 Don't forget the trailing @samp{/}.
4105 @xref{Environment Variables}.
4106
4107 @item -dumpmachine
4108 @opindex dumpmachine
4109 Print the compiler's target machine (for example,
4110 @samp{i686-pc-linux-gnu})---and don't do anything else.
4111
4112 @item -dumpversion
4113 @opindex dumpversion
4114 Print the compiler version (for example, @samp{3.0})---and don't do
4115 anything else.
4116
4117 @item -dumpspecs
4118 @opindex dumpspecs
4119 Print the compiler's built-in specs---and don't do anything else. (This
4120 is used when GCC itself is being built.) @xref{Spec Files}.
4121
4122 @item -feliminate-unused-debug-types
4123 @opindex feliminate-unused-debug-types
4124 Normally, when producing DWARF2 output, GCC will emit debugging
4125 information for all types declared in a compilation
4126 unit, regardless of whether or not they are actually used
4127 in that compilation unit. Sometimes this is useful, such as
4128 if, in the debugger, you want to cast a value to a type that is
4129 not actually used in your program (but is declared). More often,
4130 however, this results in a significant amount of wasted space.
4131 With this option, GCC will avoid producing debug symbol output
4132 for types that are nowhere used in the source file being compiled.
4133 @end table
4134
4135 @node Optimize Options
4136 @section Options That Control Optimization
4137 @cindex optimize options
4138 @cindex options, optimization
4139
4140 These options control various sorts of optimizations.
4141
4142 Without any optimization option, the compiler's goal is to reduce the
4143 cost of compilation and to make debugging produce the expected
4144 results. Statements are independent: if you stop the program with a
4145 breakpoint between statements, you can then assign a new value to any
4146 variable or change the program counter to any other statement in the
4147 function and get exactly the results you would expect from the source
4148 code.
4149
4150 Turning on optimization flags makes the compiler attempt to improve
4151 the performance and/or code size at the expense of compilation time
4152 and possibly the ability to debug the program.
4153
4154 The compiler performs optimization based on the knowledge it has of
4155 the program. Optimization levels @option{-O2} and above, in
4156 particular, enable @emph{unit-at-a-time} mode, which allows the
4157 compiler to consider information gained from later functions in
4158 the file when compiling a function. Compiling multiple files at
4159 once to a single output file in @emph{unit-at-a-time} mode allows
4160 the compiler to use information gained from all of the files when
4161 compiling each of them.
4162
4163 Not all optimizations are controlled directly by a flag. Only
4164 optimizations that have a flag are listed.
4165
4166 @table @gcctabopt
4167 @item -O
4168 @itemx -O1
4169 @opindex O
4170 @opindex O1
4171 Optimize. Optimizing compilation takes somewhat more time, and a lot
4172 more memory for a large function.
4173
4174 With @option{-O}, the compiler tries to reduce code size and execution
4175 time, without performing any optimizations that take a great deal of
4176 compilation time.
4177
4178 @option{-O} turns on the following optimization flags:
4179 @gccoptlist{-fdefer-pop @gol
4180 -fdelayed-branch @gol
4181 -fguess-branch-probability @gol
4182 -fcprop-registers @gol
4183 -floop-optimize @gol
4184 -fif-conversion @gol
4185 -fif-conversion2 @gol
4186 -ftree-ccp @gol
4187 -ftree-dce @gol
4188 -ftree-dominator-opts @gol
4189 -ftree-dse @gol
4190 -ftree-ter @gol
4191 -ftree-lrs @gol
4192 -ftree-sra @gol
4193 -ftree-copyrename @gol
4194 -ftree-fre @gol
4195 -ftree-ch @gol
4196 -fmerge-constants}
4197
4198 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
4199 where doing so does not interfere with debugging.
4200
4201 @item -O2
4202 @opindex O2
4203 Optimize even more. GCC performs nearly all supported optimizations
4204 that do not involve a space-speed tradeoff. The compiler does not
4205 perform loop unrolling or function inlining when you specify @option{-O2}.
4206 As compared to @option{-O}, this option increases both compilation time
4207 and the performance of the generated code.
4208
4209 @option{-O2} turns on all optimization flags specified by @option{-O}. It
4210 also turns on the following optimization flags:
4211 @gccoptlist{-fthread-jumps @gol
4212 -fcrossjumping @gol
4213 -foptimize-sibling-calls @gol
4214 -fcse-follow-jumps -fcse-skip-blocks @gol
4215 -fgcse -fgcse-lm @gol
4216 -fexpensive-optimizations @gol
4217 -fstrength-reduce @gol
4218 -frerun-cse-after-loop -frerun-loop-opt @gol
4219 -fcaller-saves @gol
4220 -fforce-mem @gol
4221 -fpeephole2 @gol
4222 -fschedule-insns -fschedule-insns2 @gol
4223 -fsched-interblock -fsched-spec @gol
4224 -fregmove @gol
4225 -fstrict-aliasing @gol
4226 -fdelete-null-pointer-checks @gol
4227 -freorder-blocks -freorder-functions @gol
4228 -funit-at-a-time @gol
4229 -falign-functions -falign-jumps @gol
4230 -falign-loops -falign-labels @gol
4231 -ftree-pre}
4232
4233 Please note the warning under @option{-fgcse} about
4234 invoking @option{-O2} on programs that use computed gotos.
4235
4236 @item -O3
4237 @opindex O3
4238 Optimize yet more. @option{-O3} turns on all optimizations specified by
4239 @option{-O2} and also turns on the @option{-finline-functions},
4240 @option{-funswitch-loops} and @option{-fgcse-after-reload} options.
4241
4242 @item -O0
4243 @opindex O0
4244 Do not optimize. This is the default.
4245
4246 @item -Os
4247 @opindex Os
4248 Optimize for size. @option{-Os} enables all @option{-O2} optimizations that
4249 do not typically increase code size. It also performs further
4250 optimizations designed to reduce code size.
4251
4252 @option{-Os} disables the following optimization flags:
4253 @gccoptlist{-falign-functions -falign-jumps -falign-loops @gol
4254 -falign-labels -freorder-blocks -freorder-blocks-and-partition -fprefetch-loop-arrays}
4255
4256 If you use multiple @option{-O} options, with or without level numbers,
4257 the last such option is the one that is effective.
4258 @end table
4259
4260 Options of the form @option{-f@var{flag}} specify machine-independent
4261 flags. Most flags have both positive and negative forms; the negative
4262 form of @option{-ffoo} would be @option{-fno-foo}. In the table
4263 below, only one of the forms is listed---the one you typically will
4264 use. You can figure out the other form by either removing @samp{no-}
4265 or adding it.
4266
4267 The following options control specific optimizations. They are either
4268 activated by @option{-O} options or are related to ones that are. You
4269 can use the following flags in the rare cases when ``fine-tuning'' of
4270 optimizations to be performed is desired.
4271
4272 @table @gcctabopt
4273 @item -fno-default-inline
4274 @opindex fno-default-inline
4275 Do not make member functions inline by default merely because they are
4276 defined inside the class scope (C++ only). Otherwise, when you specify
4277 @w{@option{-O}}, member functions defined inside class scope are compiled
4278 inline by default; i.e., you don't need to add @samp{inline} in front of
4279 the member function name.
4280
4281 @item -fno-defer-pop
4282 @opindex fno-defer-pop
4283 Always pop the arguments to each function call as soon as that function
4284 returns. For machines which must pop arguments after a function call,
4285 the compiler normally lets arguments accumulate on the stack for several
4286 function calls and pops them all at once.
4287
4288 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4289
4290 @item -fforce-mem
4291 @opindex fforce-mem
4292 Force memory operands to be copied into registers before doing
4293 arithmetic on them. This produces better code by making all memory
4294 references potential common subexpressions. When they are not common
4295 subexpressions, instruction combination should eliminate the separate
4296 register-load.
4297
4298 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4299
4300 @item -fforce-addr
4301 @opindex fforce-addr
4302 Force memory address constants to be copied into registers before
4303 doing arithmetic on them. This may produce better code just as
4304 @option{-fforce-mem} may.
4305
4306 @item -fomit-frame-pointer
4307 @opindex fomit-frame-pointer
4308 Don't keep the frame pointer in a register for functions that
4309 don't need one. This avoids the instructions to save, set up and
4310 restore frame pointers; it also makes an extra register available
4311 in many functions. @strong{It also makes debugging impossible on
4312 some machines.}
4313
4314 On some machines, such as the VAX, this flag has no effect, because
4315 the standard calling sequence automatically handles the frame pointer
4316 and nothing is saved by pretending it doesn't exist. The
4317 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
4318 whether a target machine supports this flag. @xref{Registers,,Register
4319 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
4320
4321 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4322
4323 @item -foptimize-sibling-calls
4324 @opindex foptimize-sibling-calls
4325 Optimize sibling and tail recursive calls.
4326
4327 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4328
4329 @item -fno-inline
4330 @opindex fno-inline
4331 Don't pay attention to the @code{inline} keyword. Normally this option
4332 is used to keep the compiler from expanding any functions inline.
4333 Note that if you are not optimizing, no functions can be expanded inline.
4334
4335 @item -finline-functions
4336 @opindex finline-functions
4337 Integrate all simple functions into their callers. The compiler
4338 heuristically decides which functions are simple enough to be worth
4339 integrating in this way.
4340
4341 If all calls to a given function are integrated, and the function is
4342 declared @code{static}, then the function is normally not output as
4343 assembler code in its own right.
4344
4345 Enabled at level @option{-O3}.
4346
4347 @item -finline-limit=@var{n}
4348 @opindex finline-limit
4349 By default, GCC limits the size of functions that can be inlined. This flag
4350 allows the control of this limit for functions that are explicitly marked as
4351 inline (i.e., marked with the inline keyword or defined within the class
4352 definition in c++). @var{n} is the size of functions that can be inlined in
4353 number of pseudo instructions (not counting parameter handling). The default
4354 value of @var{n} is 600.
4355 Increasing this value can result in more inlined code at
4356 the cost of compilation time and memory consumption. Decreasing usually makes
4357 the compilation faster and less code will be inlined (which presumably
4358 means slower programs). This option is particularly useful for programs that
4359 use inlining heavily such as those based on recursive templates with C++.
4360
4361 Inlining is actually controlled by a number of parameters, which may be
4362 specified individually by using @option{--param @var{name}=@var{value}}.
4363 The @option{-finline-limit=@var{n}} option sets some of these parameters
4364 as follows:
4365
4366 @table @gcctabopt
4367 @item max-inline-insns-single
4368 is set to @var{n}/2.
4369 @item max-inline-insns-auto
4370 is set to @var{n}/2.
4371 @item min-inline-insns
4372 is set to 130 or @var{n}/4, whichever is smaller.
4373 @item max-inline-insns-rtl
4374 is set to @var{n}.
4375 @end table
4376
4377 See below for a documentation of the individual
4378 parameters controlling inlining.
4379
4380 @emph{Note:} pseudo instruction represents, in this particular context, an
4381 abstract measurement of function's size. In no way, it represents a count
4382 of assembly instructions and as such its exact meaning might change from one
4383 release to an another.
4384
4385 @item -fkeep-inline-functions
4386 @opindex fkeep-inline-functions
4387 In C, emit @code{static} functions that are declared @code{inline}
4388 into the object file, even if the function has been inlined into all
4389 of its callers. This switch does not affect functions using the
4390 @code{extern inline} extension in GNU C@. In C++, emit any and all
4391 inline functions into the object file.
4392
4393 @item -fkeep-static-consts
4394 @opindex fkeep-static-consts
4395 Emit variables declared @code{static const} when optimization isn't turned
4396 on, even if the variables aren't referenced.
4397
4398 GCC enables this option by default. If you want to force the compiler to
4399 check if the variable was referenced, regardless of whether or not
4400 optimization is turned on, use the @option{-fno-keep-static-consts} option.
4401
4402 @item -fmerge-constants
4403 Attempt to merge identical constants (string constants and floating point
4404 constants) across compilation units.
4405
4406 This option is the default for optimized compilation if the assembler and
4407 linker support it. Use @option{-fno-merge-constants} to inhibit this
4408 behavior.
4409
4410 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4411
4412 @item -fmerge-all-constants
4413 Attempt to merge identical constants and identical variables.
4414
4415 This option implies @option{-fmerge-constants}. In addition to
4416 @option{-fmerge-constants} this considers e.g.@: even constant initialized
4417 arrays or initialized constant variables with integral or floating point
4418 types. Languages like C or C++ require each non-automatic variable to
4419 have distinct location, so using this option will result in non-conforming
4420 behavior.
4421
4422 @item -fmodulo-sched
4423 @opindex fmodulo-sched
4424 Perform swing modulo scheduling immediately before the first scheduling
4425 pass. This pass looks at innermost loops and reorders their
4426 instructions by overlapping different iterations.
4427
4428 @item -fno-branch-count-reg
4429 @opindex fno-branch-count-reg
4430 Do not use ``decrement and branch'' instructions on a count register,
4431 but instead generate a sequence of instructions that decrement a
4432 register, compare it against zero, then branch based upon the result.
4433 This option is only meaningful on architectures that support such
4434 instructions, which include x86, PowerPC, IA-64 and S/390.
4435
4436 The default is @option{-fbranch-count-reg}, enabled when
4437 @option{-fstrength-reduce} is enabled.
4438
4439 @item -fno-function-cse
4440 @opindex fno-function-cse
4441 Do not put function addresses in registers; make each instruction that
4442 calls a constant function contain the function's address explicitly.
4443
4444 This option results in less efficient code, but some strange hacks
4445 that alter the assembler output may be confused by the optimizations
4446 performed when this option is not used.
4447
4448 The default is @option{-ffunction-cse}
4449
4450 @item -fno-zero-initialized-in-bss
4451 @opindex fno-zero-initialized-in-bss
4452 If the target supports a BSS section, GCC by default puts variables that
4453 are initialized to zero into BSS@. This can save space in the resulting
4454 code.
4455
4456 This option turns off this behavior because some programs explicitly
4457 rely on variables going to the data section. E.g., so that the
4458 resulting executable can find the beginning of that section and/or make
4459 assumptions based on that.
4460
4461 The default is @option{-fzero-initialized-in-bss}.
4462
4463 @item -fbounds-check
4464 @opindex fbounds-check
4465 For front-ends that support it, generate additional code to check that
4466 indices used to access arrays are within the declared range. This is
4467 currently only supported by the Java and Fortran front-ends, where
4468 this option defaults to true and false respectively.
4469
4470 @item -fmudflap -fmudflapth -fmudflapir
4471 @opindex fmudflap
4472 @opindex fmudflapth
4473 @opindex fmudflapir
4474 @cindex bounds checking
4475 @cindex mudflap
4476 For front-ends that support it (C and C++), instrument all risky
4477 pointer/array dereferencing operations, some standard library
4478 string/heap functions, and some other associated constructs with
4479 range/validity tests. Modules so instrumented should be immune to
4480 buffer overflows, invalid heap use, and some other classes of C/C++
4481 programming errors. The instrumentation relies on a separate runtime
4482 library (@file{libmudflap}), which will be linked into a program if
4483 @option{-fmudflap} is given at link time. Run-time behavior of the
4484 instrumented program is controlled by the @env{MUDFLAP_OPTIONS}
4485 environment variable. See @code{env MUDFLAP_OPTIONS=-help a.out}
4486 for its options.
4487
4488 Use @option{-fmudflapth} instead of @option{-fmudflap} to compile and to
4489 link if your program is multi-threaded. Use @option{-fmudflapir}, in
4490 addition to @option{-fmudflap} or @option{-fmudflapth}, if
4491 instrumentation should ignore pointer reads. This produces less
4492 instrumentation (and therefore faster execution) and still provides
4493 some protection against outright memory corrupting writes, but allows
4494 erroneously read data to propagate within a program.
4495
4496 @item -fstrength-reduce
4497 @opindex fstrength-reduce
4498 Perform the optimizations of loop strength reduction and
4499 elimination of iteration variables.
4500
4501 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4502
4503 @item -fthread-jumps
4504 @opindex fthread-jumps
4505 Perform optimizations where we check to see if a jump branches to a
4506 location where another comparison subsumed by the first is found. If
4507 so, the first branch is redirected to either the destination of the
4508 second branch or a point immediately following it, depending on whether
4509 the condition is known to be true or false.
4510
4511 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4512
4513 @item -fcse-follow-jumps
4514 @opindex fcse-follow-jumps
4515 In common subexpression elimination, scan through jump instructions
4516 when the target of the jump is not reached by any other path. For
4517 example, when CSE encounters an @code{if} statement with an
4518 @code{else} clause, CSE will follow the jump when the condition
4519 tested is false.
4520
4521 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4522
4523 @item -fcse-skip-blocks
4524 @opindex fcse-skip-blocks
4525 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
4526 follow jumps which conditionally skip over blocks. When CSE
4527 encounters a simple @code{if} statement with no else clause,
4528 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
4529 body of the @code{if}.
4530
4531 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4532
4533 @item -frerun-cse-after-loop
4534 @opindex frerun-cse-after-loop
4535 Re-run common subexpression elimination after loop optimizations has been
4536 performed.
4537
4538 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4539
4540 @item -frerun-loop-opt
4541 @opindex frerun-loop-opt
4542 Run the loop optimizer twice.
4543
4544 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4545
4546 @item -fgcse
4547 @opindex fgcse
4548 Perform a global common subexpression elimination pass.
4549 This pass also performs global constant and copy propagation.
4550
4551 @emph{Note:} When compiling a program using computed gotos, a GCC
4552 extension, you may get better runtime performance if you disable
4553 the global common subexpression elimination pass by adding
4554 @option{-fno-gcse} to the command line.
4555
4556 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4557
4558 @item -fgcse-lm
4559 @opindex fgcse-lm
4560 When @option{-fgcse-lm} is enabled, global common subexpression elimination will
4561 attempt to move loads which are only killed by stores into themselves. This
4562 allows a loop containing a load/store sequence to be changed to a load outside
4563 the loop, and a copy/store within the loop.
4564
4565 Enabled by default when gcse is enabled.
4566
4567 @item -fgcse-sm
4568 @opindex fgcse-sm
4569 When @option{-fgcse-sm} is enabled, a store motion pass is run after
4570 global common subexpression elimination. This pass will attempt to move
4571 stores out of loops. When used in conjunction with @option{-fgcse-lm},
4572 loops containing a load/store sequence can be changed to a load before
4573 the loop and a store after the loop.
4574
4575 Not enabled at any optimization level.
4576
4577 @item -fgcse-las
4578 @opindex fgcse-las
4579 When @option{-fgcse-las} is enabled, the global common subexpression
4580 elimination pass eliminates redundant loads that come after stores to the
4581 same memory location (both partial and full redundancies).
4582
4583 Not enabled at any optimization level.
4584
4585 @item -fgcse-after-reload
4586 @opindex fgcse-after-reload
4587 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
4588 pass is performed after reload. The purpose of this pass is to cleanup
4589 redundant spilling.
4590
4591 @item -floop-optimize
4592 @opindex floop-optimize
4593 Perform loop optimizations: move constant expressions out of loops, simplify
4594 exit test conditions and optionally do strength-reduction as well.
4595
4596 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4597
4598 @item -floop-optimize2
4599 @opindex floop-optimize2
4600 Perform loop optimizations using the new loop optimizer. The optimizations
4601 (loop unrolling, peeling and unswitching, loop invariant motion) are enabled
4602 by separate flags.
4603
4604 @item -fcrossjumping
4605 @opindex crossjumping
4606 Perform cross-jumping transformation. This transformation unifies equivalent code and save code size. The
4607 resulting code may or may not perform better than without cross-jumping.
4608
4609 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4610
4611 @item -fif-conversion
4612 @opindex if-conversion
4613 Attempt to transform conditional jumps into branch-less equivalents. This
4614 include use of conditional moves, min, max, set flags and abs instructions, and
4615 some tricks doable by standard arithmetics. The use of conditional execution
4616 on chips where it is available is controlled by @code{if-conversion2}.
4617
4618 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4619
4620 @item -fif-conversion2
4621 @opindex if-conversion2
4622 Use conditional execution (where available) to transform conditional jumps into
4623 branch-less equivalents.
4624
4625 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4626
4627 @item -fdelete-null-pointer-checks
4628 @opindex fdelete-null-pointer-checks
4629 Use global dataflow analysis to identify and eliminate useless checks
4630 for null pointers. The compiler assumes that dereferencing a null
4631 pointer would have halted the program. If a pointer is checked after
4632 it has already been dereferenced, it cannot be null.
4633
4634 In some environments, this assumption is not true, and programs can
4635 safely dereference null pointers. Use
4636 @option{-fno-delete-null-pointer-checks} to disable this optimization
4637 for programs which depend on that behavior.
4638
4639 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4640
4641 @item -fexpensive-optimizations
4642 @opindex fexpensive-optimizations
4643 Perform a number of minor optimizations that are relatively expensive.
4644
4645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4646
4647 @item -foptimize-register-move
4648 @itemx -fregmove
4649 @opindex foptimize-register-move
4650 @opindex fregmove
4651 Attempt to reassign register numbers in move instructions and as
4652 operands of other simple instructions in order to maximize the amount of
4653 register tying. This is especially helpful on machines with two-operand
4654 instructions.
4655
4656 Note @option{-fregmove} and @option{-foptimize-register-move} are the same
4657 optimization.
4658
4659 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4660
4661 @item -fdelayed-branch
4662 @opindex fdelayed-branch
4663 If supported for the target machine, attempt to reorder instructions
4664 to exploit instruction slots available after delayed branch
4665 instructions.
4666
4667 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4668
4669 @item -fschedule-insns
4670 @opindex fschedule-insns
4671 If supported for the target machine, attempt to reorder instructions to
4672 eliminate execution stalls due to required data being unavailable. This
4673 helps machines that have slow floating point or memory load instructions
4674 by allowing other instructions to be issued until the result of the load
4675 or floating point instruction is required.
4676
4677 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4678
4679 @item -fschedule-insns2
4680 @opindex fschedule-insns2
4681 Similar to @option{-fschedule-insns}, but requests an additional pass of
4682 instruction scheduling after register allocation has been done. This is
4683 especially useful on machines with a relatively small number of
4684 registers and where memory load instructions take more than one cycle.
4685
4686 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4687
4688 @item -fno-sched-interblock
4689 @opindex fno-sched-interblock
4690 Don't schedule instructions across basic blocks. This is normally
4691 enabled by default when scheduling before register allocation, i.e.@:
4692 with @option{-fschedule-insns} or at @option{-O2} or higher.
4693
4694 @item -fno-sched-spec
4695 @opindex fno-sched-spec
4696 Don't allow speculative motion of non-load instructions. This is normally
4697 enabled by default when scheduling before register allocation, i.e.@:
4698 with @option{-fschedule-insns} or at @option{-O2} or higher.
4699
4700 @item -fsched-spec-load
4701 @opindex fsched-spec-load
4702 Allow speculative motion of some load instructions. This only makes
4703 sense when scheduling before register allocation, i.e.@: with
4704 @option{-fschedule-insns} or at @option{-O2} or higher.
4705
4706 @item -fsched-spec-load-dangerous
4707 @opindex fsched-spec-load-dangerous
4708 Allow speculative motion of more load instructions. This only makes
4709 sense when scheduling before register allocation, i.e.@: with
4710 @option{-fschedule-insns} or at @option{-O2} or higher.
4711
4712 @item -fsched-stalled-insns=@var{n}
4713 @opindex fsched-stalled-insns
4714 Define how many insns (if any) can be moved prematurely from the queue
4715 of stalled insns into the ready list, during the second scheduling pass.
4716
4717 @item -fsched-stalled-insns-dep=@var{n}
4718 @opindex fsched-stalled-insns-dep
4719 Define how many insn groups (cycles) will be examined for a dependency
4720 on a stalled insn that is candidate for premature removal from the queue
4721 of stalled insns. Has an effect only during the second scheduling pass,
4722 and only if @option{-fsched-stalled-insns} is used and its value is not zero.
4723
4724 @item -fsched2-use-superblocks
4725 @opindex fsched2-use-superblocks
4726 When scheduling after register allocation, do use superblock scheduling
4727 algorithm. Superblock scheduling allows motion across basic block boundaries
4728 resulting on faster schedules. This option is experimental, as not all machine
4729 descriptions used by GCC model the CPU closely enough to avoid unreliable
4730 results from the algorithm.
4731
4732 This only makes sense when scheduling after register allocation, i.e.@: with
4733 @option{-fschedule-insns2} or at @option{-O2} or higher.
4734
4735 @item -fsched2-use-traces
4736 @opindex fsched2-use-traces
4737 Use @option{-fsched2-use-superblocks} algorithm when scheduling after register
4738 allocation and additionally perform code duplication in order to increase the
4739 size of superblocks using tracer pass. See @option{-ftracer} for details on
4740 trace formation.
4741
4742 This mode should produce faster but significantly longer programs. Also
4743 without @option{-fbranch-probabilities} the traces constructed may not
4744 match the reality and hurt the performance. This only makes
4745 sense when scheduling after register allocation, i.e.@: with
4746 @option{-fschedule-insns2} or at @option{-O2} or higher.
4747
4748 @item -freschedule-modulo-scheduled-loops
4749 @opindex fscheduling-in-modulo-scheduled-loops
4750 The modulo scheduling comes before the traditional scheduling, if a loop was modulo scheduled
4751 we may want to prevent the later scheduling passes from changing its schedule, we use this
4752 option to control that.
4753
4754 @item -fcaller-saves
4755 @opindex fcaller-saves
4756 Enable values to be allocated in registers that will be clobbered by
4757 function calls, by emitting extra instructions to save and restore the
4758 registers around such calls. Such allocation is done only when it
4759 seems to result in better code than would otherwise be produced.
4760
4761 This option is always enabled by default on certain machines, usually
4762 those which have no call-preserved registers to use instead.
4763
4764 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4765
4766 @item -ftree-pre
4767 Perform Partial Redundancy Elimination (PRE) on trees. This flag is
4768 enabled by default at @option{-O2} and @option{-O3}.
4769
4770 @item -ftree-fre
4771 Perform Full Redundancy Elimination (FRE) on trees. The difference
4772 between FRE and PRE is that FRE only considers expressions
4773 that are computed on all paths leading to the redundant computation.
4774 This analysis faster than PRE, though it exposes fewer redundancies.
4775 This flag is enabled by default at @option{-O} and higher.
4776
4777 @item -ftree-copy-prop
4778 Perform copy propagation on trees. This pass eliminates unnecessary
4779 copy operations. This flag is enabled by default at @option{-O} and
4780 higher.
4781
4782 @item -ftree-store-copy-prop
4783 Perform copy propagation of memory loads and stores. This pass
4784 eliminates unnecessary copy operations in memory references
4785 (structures, global variables, arrays, etc). This flag is enabled by
4786 default at @option{-O2} and higher.
4787
4788 @item -ftree-salias
4789 Perform structural alias analysis on trees. This flag
4790 is enabled by default at @option{-O} and higher.
4791
4792 @item -ftree-sink
4793 Perform forward store motion on trees. This flag is
4794 enabled by default at @option{-O} and higher.
4795
4796 @item -ftree-ccp
4797 Perform sparse conditional constant propagation (CCP) on trees. This
4798 pass only operates on local scalar variables and is enabled by default
4799 at @option{-O} and higher.
4800
4801 @item -ftree-store-ccp
4802 Perform sparse conditional constant propagation (CCP) on trees. This
4803 pass operates on both local scalar variables and memory stores and
4804 loads (global variables, structures, arrays, etc). This flag is
4805 enabled by default at @option{-O2} and higher.
4806
4807 @item -ftree-dce
4808 Perform dead code elimination (DCE) on trees. This flag is enabled by
4809 default at @option{-O} and higher.
4810
4811 @item -ftree-dominator-opts
4812 Perform dead code elimination (DCE) on trees. This flag is enabled by
4813 default at @option{-O} and higher.
4814
4815 @item -ftree-ch
4816 Perform loop header copying on trees. This is beneficial since it increases
4817 effectiveness of code motion optimizations. It also saves one jump. This flag
4818 is enabled by default at @option{-O} and higher. It is not enabled
4819 for @option{-Os}, since it usually increases code size.
4820
4821 @item -ftree-loop-optimize
4822 Perform loop optimizations on trees. This flag is enabled by default
4823 at @option{-O} and higher.
4824
4825 @item -ftree-loop-linear
4826 Perform linear loop transformations on tree. This flag can improve cache
4827 performance and allow further loop optimizations to take place.
4828
4829 @item -ftree-loop-im
4830 Perform loop invariant motion on trees. This pass moves only invariants that
4831 would be hard to handle at RTL level (function calls, operations that expand to
4832 nontrivial sequences of insns). With @option{-funswitch-loops} it also moves
4833 operands of conditions that are invariant out of the loop, so that we can use
4834 just trivial invariantness analysis in loop unswitching. The pass also includes
4835 store motion.
4836
4837 @item -ftree-loop-ivcanon
4838 Create a canonical counter for number of iterations in the loop for that
4839 determining number of iterations requires complicated analysis. Later
4840 optimizations then may determine the number easily. Useful especially
4841 in connection with unrolling.
4842
4843 @item -fivopts
4844 Perform induction variable optimizations (strength reduction, induction
4845 variable merging and induction variable elimination) on trees.
4846
4847 @item -ftree-sra
4848 Perform scalar replacement of aggregates. This pass replaces structure
4849 references with scalars to prevent committing structures to memory too
4850 early. This flag is enabled by default at @option{-O} and higher.
4851
4852 @item -ftree-copyrename
4853 Perform copy renaming on trees. This pass attempts to rename compiler
4854 temporaries to other variables at copy locations, usually resulting in
4855 variable names which more closely resemble the original variables. This flag
4856 is enabled by default at @option{-O} and higher.
4857
4858 @item -ftree-ter
4859 Perform temporary expression replacement during the SSA->normal phase. Single
4860 use/single def temporaries are replaced at their use location with their
4861 defining expression. This results in non-GIMPLE code, but gives the expanders
4862 much more complex trees to work on resulting in better RTL generation. This is
4863 enabled by default at @option{-O} and higher.
4864
4865 @item -ftree-lrs
4866 Perform live range splitting during the SSA->normal phase. Distinct live
4867 ranges of a variable are split into unique variables, allowing for better
4868 optimization later. This is enabled by default at @option{-O} and higher.
4869
4870 @item -ftree-vectorize
4871 Perform loop vectorization on trees.
4872
4873 @item -ftracer
4874 @opindex ftracer
4875 Perform tail duplication to enlarge superblock size. This transformation
4876 simplifies the control flow of the function allowing other optimizations to do
4877 better job.
4878
4879 @item -funroll-loops
4880 @opindex funroll-loops
4881 Unroll loops whose number of iterations can be determined at compile
4882 time or upon entry to the loop. @option{-funroll-loops} implies both
4883 @option{-fstrength-reduce} and @option{-frerun-cse-after-loop}. This
4884 option makes code larger, and may or may not make it run faster.
4885
4886 @item -funroll-all-loops
4887 @opindex funroll-all-loops
4888 Unroll all loops, even if their number of iterations is uncertain when
4889 the loop is entered. This usually makes programs run more slowly.
4890 @option{-funroll-all-loops} implies the same options as
4891 @option{-funroll-loops},
4892
4893 @item -fsplit-ivs-in-unroller
4894 @opindex -fsplit-ivs-in-unroller
4895 Enables expressing of values of induction variables in later iterations
4896 of the unrolled loop using the value in the first iteration. This breaks
4897 long dependency chains, thus improving efficiency of the scheduling passes
4898 (for best results, @option{-fweb} should be used as well).
4899
4900 Combination of @option{-fweb} and CSE is often sufficient to obtain the
4901 same effect. However in cases the loop body is more complicated than
4902 a single basic block, this is not reliable. It also does not work at all
4903 on some of the architectures due to restrictions in the CSE pass.
4904
4905 This optimization is enabled by default.
4906
4907 @item -fvariable-expansion-in-unroller
4908 @opindex -fvariable-expansion-in-unroller
4909 With this option, the compiler will create multiple copies of some
4910 local variables when unrolling a loop which can result in superior code.
4911
4912 @item -fprefetch-loop-arrays
4913 @opindex fprefetch-loop-arrays
4914 If supported by the target machine, generate instructions to prefetch
4915 memory to improve the performance of loops that access large arrays.
4916
4917 These options may generate better or worse code; results are highly
4918 dependent on the structure of loops within the source code.
4919
4920 @item -fno-peephole
4921 @itemx -fno-peephole2
4922 @opindex fno-peephole
4923 @opindex fno-peephole2
4924 Disable any machine-specific peephole optimizations. The difference
4925 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
4926 are implemented in the compiler; some targets use one, some use the
4927 other, a few use both.
4928
4929 @option{-fpeephole} is enabled by default.
4930 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4931
4932 @item -fno-guess-branch-probability
4933 @opindex fno-guess-branch-probability
4934 Do not guess branch probabilities using heuristics.
4935
4936 GCC will use heuristics to guess branch probabilities if they are
4937 not provided by profiling feedback (@option{-fprofile-arcs}). These
4938 heuristics are based on the control flow graph. If some branch probabilities
4939 are specified by @samp{__builtin_expect}, then the heuristics will be
4940 used to guess branch probabilities for the rest of the control flow graph,
4941 taking the @samp{__builtin_expect} info into account. The interactions
4942 between the heuristics and @samp{__builtin_expect} can be complex, and in
4943 some cases, it may be useful to disable the heuristics so that the effects
4944 of @samp{__builtin_expect} are easier to understand.
4945
4946 The default is @option{-fguess-branch-probability} at levels
4947 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
4948
4949 @item -freorder-blocks
4950 @opindex freorder-blocks
4951 Reorder basic blocks in the compiled function in order to reduce number of
4952 taken branches and improve code locality.
4953
4954 Enabled at levels @option{-O2}, @option{-O3}.
4955
4956 @item -freorder-blocks-and-partition
4957 @opindex freorder-blocks-and-partition
4958 In addition to reordering basic blocks in the compiled function, in order
4959 to reduce number of taken branches, partitions hot and cold basic blocks
4960 into separate sections of the assembly and .o files, to improve
4961 paging and cache locality performance.
4962
4963 This optimization is automatically turned off in the presence of
4964 exception handling, for linkonce sections, for functions with a user-defined
4965 section attribute and on any architecture that does not support named
4966 sections.
4967
4968 @item -freorder-functions
4969 @opindex freorder-functions
4970 Reorder functions in the object file in order to
4971 improve code locality. This is implemented by using special
4972 subsections @code{.text.hot} for most frequently executed functions and
4973 @code{.text.unlikely} for unlikely executed functions. Reordering is done by
4974 the linker so object file format must support named sections and linker must
4975 place them in a reasonable way.
4976
4977 Also profile feedback must be available in to make this option effective. See
4978 @option{-fprofile-arcs} for details.
4979
4980 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
4981
4982 @item -fstrict-aliasing
4983 @opindex fstrict-aliasing
4984 Allows the compiler to assume the strictest aliasing rules applicable to
4985 the language being compiled. For C (and C++), this activates
4986 optimizations based on the type of expressions. In particular, an
4987 object of one type is assumed never to reside at the same address as an
4988 object of a different type, unless the types are almost the same. For
4989 example, an @code{unsigned int} can alias an @code{int}, but not a
4990 @code{void*} or a @code{double}. A character type may alias any other
4991 type.
4992
4993 Pay special attention to code like this:
4994 @smallexample
4995 union a_union @{
4996 int i;
4997 double d;
4998 @};
4999
5000 int f() @{
5001 a_union t;
5002 t.d = 3.0;
5003 return t.i;
5004 @}
5005 @end smallexample
5006 The practice of reading from a different union member than the one most
5007 recently written to (called ``type-punning'') is common. Even with
5008 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
5009 is accessed through the union type. So, the code above will work as
5010 expected. However, this code might not:
5011 @smallexample
5012 int f() @{
5013 a_union t;
5014 int* ip;
5015 t.d = 3.0;
5016 ip = &t.i;
5017 return *ip;
5018 @}
5019 @end smallexample
5020
5021 Every language that wishes to perform language-specific alias analysis
5022 should define a function that computes, given an @code{tree}
5023 node, an alias set for the node. Nodes in different alias sets are not
5024 allowed to alias. For an example, see the C front-end function
5025 @code{c_get_alias_set}.
5026
5027 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
5028
5029 @item -falign-functions
5030 @itemx -falign-functions=@var{n}
5031 @opindex falign-functions
5032 Align the start of functions to the next power-of-two greater than
5033 @var{n}, skipping up to @var{n} bytes. For instance,
5034 @option{-falign-functions=32} aligns functions to the next 32-byte
5035 boundary, but @option{-falign-functions=24} would align to the next
5036 32-byte boundary only if this can be done by skipping 23 bytes or less.
5037
5038 @option{-fno-align-functions} and @option{-falign-functions=1} are
5039 equivalent and mean that functions will not be aligned.
5040
5041 Some assemblers only support this flag when @var{n} is a power of two;
5042 in that case, it is rounded up.
5043
5044 If @var{n} is not specified or is zero, use a machine-dependent default.
5045
5046 Enabled at levels @option{-O2}, @option{-O3}.
5047
5048 @item -falign-labels
5049 @itemx -falign-labels=@var{n}
5050 @opindex falign-labels
5051 Align all branch targets to a power-of-two boundary, skipping up to
5052 @var{n} bytes like @option{-falign-functions}. This option can easily
5053 make code slower, because it must insert dummy operations for when the
5054 branch target is reached in the usual flow of the code.
5055
5056 @option{-fno-align-labels} and @option{-falign-labels=1} are
5057 equivalent and mean that labels will not be aligned.
5058
5059 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
5060 are greater than this value, then their values are used instead.
5061
5062 If @var{n} is not specified or is zero, use a machine-dependent default
5063 which is very likely to be @samp{1}, meaning no alignment.
5064
5065 Enabled at levels @option{-O2}, @option{-O3}.
5066
5067 @item -falign-loops
5068 @itemx -falign-loops=@var{n}
5069 @opindex falign-loops
5070 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
5071 like @option{-falign-functions}. The hope is that the loop will be
5072 executed many times, which will make up for any execution of the dummy
5073 operations.
5074
5075 @option{-fno-align-loops} and @option{-falign-loops=1} are
5076 equivalent and mean that loops will not be aligned.
5077
5078 If @var{n} is not specified or is zero, use a machine-dependent default.
5079
5080 Enabled at levels @option{-O2}, @option{-O3}.
5081
5082 @item -falign-jumps
5083 @itemx -falign-jumps=@var{n}
5084 @opindex falign-jumps
5085 Align branch targets to a power-of-two boundary, for branch targets
5086 where the targets can only be reached by jumping, skipping up to @var{n}
5087 bytes like @option{-falign-functions}. In this case, no dummy operations
5088 need be executed.
5089
5090 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
5091 equivalent and mean that loops will not be aligned.
5092
5093 If @var{n} is not specified or is zero, use a machine-dependent default.
5094
5095 Enabled at levels @option{-O2}, @option{-O3}.
5096
5097 @item -funit-at-a-time
5098 @opindex funit-at-a-time
5099 Parse the whole compilation unit before starting to produce code.
5100 This allows some extra optimizations to take place but consumes
5101 more memory (in general). There are some compatibility issues
5102 with @emph{unit-at-at-time} mode:
5103 @itemize @bullet
5104 @item
5105 enabling @emph{unit-at-a-time} mode may change the order
5106 in which functions, variables, and top-level @code{asm} statements
5107 are emitted, and will likely break code relying on some particular
5108 ordering. The majority of such top-level @code{asm} statements,
5109 though, can be replaced by @code{section} attributes.
5110
5111 @item
5112 @emph{unit-at-a-time} mode removes unreferenced static variables
5113 and functions are removed. This may result in undefined references
5114 when an @code{asm} statement refers directly to variables or functions
5115 that are otherwise unused. In that case either the variable/function
5116 shall be listed as an operand of the @code{asm} statement operand or,
5117 in the case of top-level @code{asm} statements the attribute @code{used}
5118 shall be used on the declaration.
5119
5120 @item
5121 Static functions now can use non-standard passing conventions that
5122 may break @code{asm} statements calling functions directly. Again,
5123 attribute @code{used} will prevent this behavior.
5124 @end itemize
5125
5126 As a temporary workaround, @option{-fno-unit-at-a-time} can be used,
5127 but this scheme may not be supported by future releases of GCC@.
5128
5129 Enabled at levels @option{-O2}, @option{-O3}.
5130
5131 @item -fweb
5132 @opindex fweb
5133 Constructs webs as commonly used for register allocation purposes and assign
5134 each web individual pseudo register. This allows the register allocation pass
5135 to operate on pseudos directly, but also strengthens several other optimization
5136 passes, such as CSE, loop optimizer and trivial dead code remover. It can,
5137 however, make debugging impossible, since variables will no longer stay in a
5138 ``home register''.
5139
5140 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os},
5141 on targets where the default format for debugging information supports
5142 variable tracking.
5143
5144 @item -fno-cprop-registers
5145 @opindex fno-cprop-registers
5146 After register allocation and post-register allocation instruction splitting,
5147 we perform a copy-propagation pass to try to reduce scheduling dependencies
5148 and occasionally eliminate the copy.
5149
5150 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
5151
5152 @item -fprofile-generate
5153 @opindex fprofile-generate
5154
5155 Enable options usually used for instrumenting application to produce
5156 profile useful for later recompilation with profile feedback based
5157 optimization. You must use @option{-fprofile-generate} both when
5158 compiling and when linking your program.
5159
5160 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
5161
5162 @item -fprofile-use
5163 @opindex fprofile-use
5164 Enable profile feedback directed optimizations, and optimizations
5165 generally profitable only with profile feedback available.
5166
5167 The following options are enabled: @code{-fbranch-probabilities},
5168 @code{-fvpt}, @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}.
5169
5170 @end table
5171
5172 The following options control compiler behavior regarding floating
5173 point arithmetic. These options trade off between speed and
5174 correctness. All must be specifically enabled.
5175
5176 @table @gcctabopt
5177 @item -ffloat-store
5178 @opindex ffloat-store
5179 Do not store floating point variables in registers, and inhibit other
5180 options that might change whether a floating point value is taken from a
5181 register or memory.
5182
5183 @cindex floating point precision
5184 This option prevents undesirable excess precision on machines such as
5185 the 68000 where the floating registers (of the 68881) keep more
5186 precision than a @code{double} is supposed to have. Similarly for the
5187 x86 architecture. For most programs, the excess precision does only
5188 good, but a few programs rely on the precise definition of IEEE floating
5189 point. Use @option{-ffloat-store} for such programs, after modifying
5190 them to store all pertinent intermediate computations into variables.
5191
5192 @item -ffast-math
5193 @opindex ffast-math
5194 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations}, @*
5195 @option{-fno-trapping-math}, @option{-ffinite-math-only},
5196 @option{-fno-rounding-math}, @option{-fno-signaling-nans}
5197 and @option{fcx-limited-range}.
5198
5199 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
5200
5201 This option should never be turned on by any @option{-O} option since
5202 it can result in incorrect output for programs which depend on
5203 an exact implementation of IEEE or ISO rules/specifications for
5204 math functions.
5205
5206 @item -fno-math-errno
5207 @opindex fno-math-errno
5208 Do not set ERRNO after calling math functions that are executed
5209 with a single instruction, e.g., sqrt. A program that relies on
5210 IEEE exceptions for math error handling may want to use this flag
5211 for speed while maintaining IEEE arithmetic compatibility.
5212
5213 This option should never be turned on by any @option{-O} option since
5214 it can result in incorrect output for programs which depend on
5215 an exact implementation of IEEE or ISO rules/specifications for
5216 math functions.
5217
5218 The default is @option{-fmath-errno}.
5219
5220 @item -funsafe-math-optimizations
5221 @opindex funsafe-math-optimizations
5222 Allow optimizations for floating-point arithmetic that (a) assume
5223 that arguments and results are valid and (b) may violate IEEE or
5224 ANSI standards. When used at link-time, it may include libraries
5225 or startup files that change the default FPU control word or other
5226 similar optimizations.
5227
5228 This option should never be turned on by any @option{-O} option since
5229 it can result in incorrect output for programs which depend on
5230 an exact implementation of IEEE or ISO rules/specifications for
5231 math functions.
5232
5233 The default is @option{-fno-unsafe-math-optimizations}.
5234
5235 @item -ffinite-math-only
5236 @opindex ffinite-math-only
5237 Allow optimizations for floating-point arithmetic that assume
5238 that arguments and results are not NaNs or +-Infs.
5239
5240 This option should never be turned on by any @option{-O} option since
5241 it can result in incorrect output for programs which depend on
5242 an exact implementation of IEEE or ISO rules/specifications.
5243
5244 The default is @option{-fno-finite-math-only}.
5245
5246 @item -fno-trapping-math
5247 @opindex fno-trapping-math
5248 Compile code assuming that floating-point operations cannot generate
5249 user-visible traps. These traps include division by zero, overflow,
5250 underflow, inexact result and invalid operation. This option implies
5251 @option{-fno-signaling-nans}. Setting this option may allow faster
5252 code if one relies on ``non-stop'' IEEE arithmetic, for example.
5253
5254 This option should never be turned on by any @option{-O} option since
5255 it can result in incorrect output for programs which depend on
5256 an exact implementation of IEEE or ISO rules/specifications for
5257 math functions.
5258
5259 The default is @option{-ftrapping-math}.
5260
5261 @item -frounding-math
5262 @opindex frounding-math
5263 Disable transformations and optimizations that assume default floating
5264 point rounding behavior. This is round-to-zero for all floating point
5265 to integer conversions, and round-to-nearest for all other arithmetic
5266 truncations. This option should be specified for programs that change
5267 the FP rounding mode dynamically, or that may be executed with a
5268 non-default rounding mode. This option disables constant folding of
5269 floating point expressions at compile-time (which may be affected by
5270 rounding mode) and arithmetic transformations that are unsafe in the
5271 presence of sign-dependent rounding modes.
5272
5273 The default is @option{-fno-rounding-math}.
5274
5275 This option is experimental and does not currently guarantee to
5276 disable all GCC optimizations that are affected by rounding mode.
5277 Future versions of GCC may provide finer control of this setting
5278 using C99's @code{FENV_ACCESS} pragma. This command line option
5279 will be used to specify the default state for @code{FENV_ACCESS}.
5280
5281 @item -fsignaling-nans
5282 @opindex fsignaling-nans
5283 Compile code assuming that IEEE signaling NaNs may generate user-visible
5284 traps during floating-point operations. Setting this option disables
5285 optimizations that may change the number of exceptions visible with
5286 signaling NaNs. This option implies @option{-ftrapping-math}.
5287
5288 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
5289 be defined.
5290
5291 The default is @option{-fno-signaling-nans}.
5292
5293 This option is experimental and does not currently guarantee to
5294 disable all GCC optimizations that affect signaling NaN behavior.
5295
5296 @item -fsingle-precision-constant
5297 @opindex fsingle-precision-constant
5298 Treat floating point constant as single precision constant instead of
5299 implicitly converting it to double precision constant.
5300
5301 @item -fcx-limited-range
5302 @itemx -fno-cx-limited-range
5303 @opindex fcx-limited-range
5304 @opindex fno-cx-limited-range
5305 When enabled, this option states that a range reduction step is not
5306 needed when performing complex division. The default is
5307 @option{-fno-cx-limited-range}, but is enabled by @option{-ffast-math}.
5308
5309 This option controls the default setting of the ISO C99
5310 @code{CX_LIMITED_RANGE} pragma. Nevertheless, the option applies to
5311 all languages.
5312
5313 @end table
5314
5315 The following options control optimizations that may improve
5316 performance, but are not enabled by any @option{-O} options. This
5317 section includes experimental options that may produce broken code.
5318
5319 @table @gcctabopt
5320 @item -fbranch-probabilities
5321 @opindex fbranch-probabilities
5322 After running a program compiled with @option{-fprofile-arcs}
5323 (@pxref{Debugging Options,, Options for Debugging Your Program or
5324 @command{gcc}}), you can compile it a second time using
5325 @option{-fbranch-probabilities}, to improve optimizations based on
5326 the number of times each branch was taken. When the program
5327 compiled with @option{-fprofile-arcs} exits it saves arc execution
5328 counts to a file called @file{@var{sourcename}.gcda} for each source
5329 file The information in this data file is very dependent on the
5330 structure of the generated code, so you must use the same source code
5331 and the same optimization options for both compilations.
5332
5333 With @option{-fbranch-probabilities}, GCC puts a
5334 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
5335 These can be used to improve optimization. Currently, they are only
5336 used in one place: in @file{reorg.c}, instead of guessing which path a
5337 branch is mostly to take, the @samp{REG_BR_PROB} values are used to
5338 exactly determine which path is taken more often.
5339
5340 @item -fprofile-values
5341 @opindex fprofile-values
5342 If combined with @option{-fprofile-arcs}, it adds code so that some
5343 data about values of expressions in the program is gathered.
5344
5345 With @option{-fbranch-probabilities}, it reads back the data gathered
5346 from profiling values of expressions and adds @samp{REG_VALUE_PROFILE}
5347 notes to instructions for their later usage in optimizations.
5348
5349 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5350
5351 @item -fvpt
5352 @opindex fvpt
5353 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5354 a code to gather information about values of expressions.
5355
5356 With @option{-fbranch-probabilities}, it reads back the data gathered
5357 and actually performs the optimizations based on them.
5358 Currently the optimizations include specialization of division operation
5359 using the knowledge about the value of the denominator.
5360
5361 @item -fspeculative-prefetching
5362 @opindex fspeculative-prefetching
5363 If combined with @option{-fprofile-arcs}, it instructs the compiler to add
5364 a code to gather information about addresses of memory references in the
5365 program.
5366
5367 With @option{-fbranch-probabilities}, it reads back the data gathered
5368 and issues prefetch instructions according to them. In addition to the opportunities
5369 noticed by @option{-fprefetch-loop-arrays}, it also notices more complicated
5370 memory access patterns---for example accesses to the data stored in linked
5371 list whose elements are usually allocated sequentially.
5372
5373 In order to prevent issuing double prefetches, usage of
5374 @option{-fspeculative-prefetching} implies @option{-fno-prefetch-loop-arrays}.
5375
5376 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
5377
5378 @item -frename-registers
5379 @opindex frename-registers
5380 Attempt to avoid false dependencies in scheduled code by making use
5381 of registers left over after register allocation. This optimization
5382 will most benefit processors with lots of registers. Depending on the
5383 debug information format adopted by the target, however, it can
5384 make debugging impossible, since variables will no longer stay in
5385 a ``home register''.
5386
5387 Not enabled by default at any level because it has known bugs.
5388
5389 @item -ftracer
5390 @opindex ftracer
5391 Perform tail duplication to enlarge superblock size. This transformation
5392 simplifies the control flow of the function allowing other optimizations to do
5393 better job.
5394
5395 Enabled with @option{-fprofile-use}.
5396
5397 @item -funroll-loops
5398 @opindex funroll-loops
5399 Unroll loops whose number of iterations can be determined at compile time or
5400 upon entry to the loop. @option{-funroll-loops} implies
5401 @option{-frerun-cse-after-loop}. It also turns on complete loop peeling
5402 (i.e.@: complete removal of loops with small constant number of iterations).
5403 This option makes code larger, and may or may not make it run faster.
5404
5405 Enabled with @option{-fprofile-use}.
5406
5407 @item -funroll-all-loops
5408 @opindex funroll-all-loops
5409 Unroll all loops, even if their number of iterations is uncertain when
5410 the loop is entered. This usually makes programs run more slowly.
5411 @option{-funroll-all-loops} implies the same options as
5412 @option{-funroll-loops}.
5413
5414 @item -fpeel-loops
5415 @opindex fpeel-loops
5416 Peels the loops for that there is enough information that they do not
5417 roll much (from profile feedback). It also turns on complete loop peeling
5418 (i.e.@: complete removal of loops with small constant number of iterations).
5419
5420 Enabled with @option{-fprofile-use}.
5421
5422 @item -fmove-loop-invariants
5423 @opindex fmove-loop-invariants
5424 Enables the loop invariant motion pass in the new loop optimizer. Enabled
5425 at level @option{-O1}
5426
5427 @item -funswitch-loops
5428 @opindex funswitch-loops
5429 Move branches with loop invariant conditions out of the loop, with duplicates
5430 of the loop on both branches (modified according to result of the condition).
5431
5432 @item -fprefetch-loop-arrays
5433 @opindex fprefetch-loop-arrays
5434 If supported by the target machine, generate instructions to prefetch
5435 memory to improve the performance of loops that access large arrays.
5436
5437 Disabled at level @option{-Os}.
5438
5439 @item -ffunction-sections
5440 @itemx -fdata-sections
5441 @opindex ffunction-sections
5442 @opindex fdata-sections
5443 Place each function or data item into its own section in the output
5444 file if the target supports arbitrary sections. The name of the
5445 function or the name of the data item determines the section's name
5446 in the output file.
5447
5448 Use these options on systems where the linker can perform optimizations
5449 to improve locality of reference in the instruction space. Most systems
5450 using the ELF object format and SPARC processors running Solaris 2 have
5451 linkers with such optimizations. AIX may have these optimizations in
5452 the future.
5453
5454 Only use these options when there are significant benefits from doing
5455 so. When you specify these options, the assembler and linker will
5456 create larger object and executable files and will also be slower.
5457 You will not be able to use @code{gprof} on all systems if you
5458 specify this option and you may have problems with debugging if
5459 you specify both this option and @option{-g}.
5460
5461 @item -fbranch-target-load-optimize
5462 @opindex fbranch-target-load-optimize
5463 Perform branch target register load optimization before prologue / epilogue
5464 threading.
5465 The use of target registers can typically be exposed only during reload,
5466 thus hoisting loads out of loops and doing inter-block scheduling needs
5467 a separate optimization pass.
5468
5469 @item -fbranch-target-load-optimize2
5470 @opindex fbranch-target-load-optimize2
5471 Perform branch target register load optimization after prologue / epilogue
5472 threading.
5473
5474 @item -fbtr-bb-exclusive
5475 @opindex fbtr-bb-exclusive
5476 When performing branch target register load optimization, don't reuse
5477 branch target registers in within any basic block.
5478
5479 @item --param @var{name}=@var{value}
5480 @opindex param
5481 In some places, GCC uses various constants to control the amount of
5482 optimization that is done. For example, GCC will not inline functions
5483 that contain more that a certain number of instructions. You can
5484 control some of these constants on the command-line using the
5485 @option{--param} option.
5486
5487 The names of specific parameters, and the meaning of the values, are
5488 tied to the internals of the compiler, and are subject to change
5489 without notice in future releases.
5490
5491 In each case, the @var{value} is an integer. The allowable choices for
5492 @var{name} are given in the following table:
5493
5494 @table @gcctabopt
5495 @item salias-max-implicit-fields
5496 The maximum number of fields in a variable without direct
5497 structure accesses for which structure aliasing will consider trying
5498 to track each field. The default is 5
5499
5500 @item sra-max-structure-size
5501 The maximum structure size, in bytes, at which the scalar replacement
5502 of aggregates (SRA) optimization will perform block copies. The
5503 default value, 0, implies that GCC will select the most appropriate
5504 size itself.
5505
5506 @item sra-field-structure-ratio
5507 The threshold ratio (as a percentage) between instantiated fields and
5508 the complete structure size. We say that if the ratio of the number
5509 of bytes in instantiated fields to the number of bytes in the complete
5510 structure exceeds this parameter, then block copies are not used. The
5511 default is 75.
5512
5513 @item max-crossjump-edges
5514 The maximum number of incoming edges to consider for crossjumping.
5515 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
5516 the number of edges incoming to each block. Increasing values mean
5517 more aggressive optimization, making the compile time increase with
5518 probably small improvement in executable size.
5519
5520 @item min-crossjump-insns
5521 The minimum number of instructions which must be matched at the end
5522 of two blocks before crossjumping will be performed on them. This
5523 value is ignored in the case where all instructions in the block being
5524 crossjumped from are matched. The default value is 5.
5525
5526 @item max-goto-duplication-insns
5527 The maximum number of instructions to duplicate to a block that jumps
5528 to a computed goto. To avoid @math{O(N^2)} behavior in a number of
5529 passes, GCC factors computed gotos early in the compilation process,
5530 and unfactors them as late as possible. Only computed jumps at the
5531 end of a basic blocks with no more than max-goto-duplication-insns are
5532 unfactored. The default value is 8.
5533
5534 @item max-delay-slot-insn-search
5535 The maximum number of instructions to consider when looking for an
5536 instruction to fill a delay slot. If more than this arbitrary number of
5537 instructions is searched, the time savings from filling the delay slot
5538 will be minimal so stop searching. Increasing values mean more
5539 aggressive optimization, making the compile time increase with probably
5540 small improvement in executable run time.
5541
5542 @item max-delay-slot-live-search
5543 When trying to fill delay slots, the maximum number of instructions to
5544 consider when searching for a block with valid live register
5545 information. Increasing this arbitrarily chosen value means more
5546 aggressive optimization, increasing the compile time. This parameter
5547 should be removed when the delay slot code is rewritten to maintain the
5548 control-flow graph.
5549
5550 @item max-gcse-memory
5551 The approximate maximum amount of memory that will be allocated in
5552 order to perform the global common subexpression elimination
5553 optimization. If more memory than specified is required, the
5554 optimization will not be done.
5555
5556 @item max-gcse-passes
5557 The maximum number of passes of GCSE to run. The default is 1.
5558
5559 @item max-pending-list-length
5560 The maximum number of pending dependencies scheduling will allow
5561 before flushing the current state and starting over. Large functions
5562 with few branches or calls can create excessively large lists which
5563 needlessly consume memory and resources.
5564
5565 @item max-inline-insns-single
5566 Several parameters control the tree inliner used in gcc.
5567 This number sets the maximum number of instructions (counted in GCC's
5568 internal representation) in a single function that the tree inliner
5569 will consider for inlining. This only affects functions declared
5570 inline and methods implemented in a class declaration (C++).
5571 The default value is 450.
5572
5573 @item max-inline-insns-auto
5574 When you use @option{-finline-functions} (included in @option{-O3}),
5575 a lot of functions that would otherwise not be considered for inlining
5576 by the compiler will be investigated. To those functions, a different
5577 (more restrictive) limit compared to functions declared inline can
5578 be applied.
5579 The default value is 90.
5580
5581 @item large-function-insns
5582 The limit specifying really large functions. For functions larger than this
5583 limit after inlining inlining is constrained by
5584 @option{--param large-function-growth}. This parameter is useful primarily
5585 to avoid extreme compilation time caused by non-linear algorithms used by the
5586 backend.
5587 This parameter is ignored when @option{-funit-at-a-time} is not used.
5588 The default value is 2700.
5589
5590 @item large-function-growth
5591 Specifies maximal growth of large function caused by inlining in percents.
5592 This parameter is ignored when @option{-funit-at-a-time} is not used.
5593 The default value is 100 which limits large function growth to 2.0 times
5594 the original size.
5595
5596 @item inline-unit-growth
5597 Specifies maximal overall growth of the compilation unit caused by inlining.
5598 This parameter is ignored when @option{-funit-at-a-time} is not used.
5599 The default value is 50 which limits unit growth to 1.5 times the original
5600 size.
5601
5602 @item max-inline-insns-recursive
5603 @itemx max-inline-insns-recursive-auto
5604 Specifies maximum number of instructions out-of-line copy of self recursive inline
5605 function can grow into by performing recursive inlining.
5606
5607 For functions declared inline @option{--param max-inline-insns-recursive} is
5608 taken into acount. For function not declared inline, recursive inlining
5609 happens only when @option{-finline-functions} (included in @option{-O3}) is
5610 enabled and @option{--param max-inline-insns-recursive-auto} is used. The
5611 default value is 450.
5612
5613 @item max-inline-recursive-depth
5614 @itemx max-inline-recursive-depth-auto
5615 Specifies maximum recursion depth used by the recursive inlining.
5616
5617 For functions declared inline @option{--param max-inline-recursive-depth} is
5618 taken into acount. For function not declared inline, recursive inlining
5619 happens only when @option{-finline-functions} (included in @option{-O3}) is
5620 enabled and @option{--param max-inline-recursive-depth-auto} is used. The
5621 default value is 450.
5622
5623 @item inline-call-cost
5624 Specify cost of call instruction relative to simple arithmetics operations
5625 (having cost of 1). Increasing this cost disqualifies inlining of non-leaf
5626 functions and at the same time increases size of leaf function that is believed to
5627 reduce function size by being inlined. In effect it increases amount of
5628 inlining for code having large abstraction penalty (many functions that just
5629 pass the arguments to other functions) and decrease inlining for code with low
5630 abstraction penalty. The default value is 16.
5631
5632 @item max-unrolled-insns
5633 The maximum number of instructions that a loop should have if that loop
5634 is unrolled, and if the loop is unrolled, it determines how many times
5635 the loop code is unrolled.
5636
5637 @item max-average-unrolled-insns
5638 The maximum number of instructions biased by probabilities of their execution
5639 that a loop should have if that loop is unrolled, and if the loop is unrolled,
5640 it determines how many times the loop code is unrolled.
5641
5642 @item max-unroll-times
5643 The maximum number of unrollings of a single loop.
5644
5645 @item max-peeled-insns
5646 The maximum number of instructions that a loop should have if that loop
5647 is peeled, and if the loop is peeled, it determines how many times
5648 the loop code is peeled.
5649
5650 @item max-peel-times
5651 The maximum number of peelings of a single loop.
5652
5653 @item max-completely-peeled-insns
5654 The maximum number of insns of a completely peeled loop.
5655
5656 @item max-completely-peel-times
5657 The maximum number of iterations of a loop to be suitable for complete peeling.
5658
5659 @item max-unswitch-insns
5660 The maximum number of insns of an unswitched loop.
5661
5662 @item max-unswitch-level
5663 The maximum number of branches unswitched in a single loop.
5664
5665 @item lim-expensive
5666 The minimum cost of an expensive expression in the loop invariant motion.
5667
5668 @item iv-consider-all-candidates-bound
5669 Bound on number of candidates for induction variables below that
5670 all candidates are considered for each use in induction variable
5671 optimizations. Only the most relevant candidates are considered
5672 if there are more candidates, to avoid quadratic time complexity.
5673
5674 @item iv-max-considered-uses
5675 The induction variable optimizations give up on loops that contain more
5676 induction variable uses.
5677
5678 @item iv-always-prune-cand-set-bound
5679 If number of candidates in the set is smaller than this value,
5680 we always try to remove unnecessary ivs from the set during its
5681 optimization when a new iv is added to the set.
5682
5683 @item scev-max-expr-size
5684 Bound on size of expressions used in the scalar evolutions analyzer.
5685 Large expressions slow the analyzer.
5686
5687 @item max-iterations-to-track
5688
5689 The maximum number of iterations of a loop the brute force algorithm
5690 for analysis of # of iterations of the loop tries to evaluate.
5691
5692 @item hot-bb-count-fraction
5693 Select fraction of the maximal count of repetitions of basic block in program
5694 given basic block needs to have to be considered hot.
5695
5696 @item hot-bb-frequency-fraction
5697 Select fraction of the maximal frequency of executions of basic block in
5698 function given basic block needs to have to be considered hot
5699
5700 @item tracer-dynamic-coverage
5701 @itemx tracer-dynamic-coverage-feedback
5702
5703 This value is used to limit superblock formation once the given percentage of
5704 executed instructions is covered. This limits unnecessary code size
5705 expansion.
5706
5707 The @option{tracer-dynamic-coverage-feedback} is used only when profile
5708 feedback is available. The real profiles (as opposed to statically estimated
5709 ones) are much less balanced allowing the threshold to be larger value.
5710
5711 @item tracer-max-code-growth
5712 Stop tail duplication once code growth has reached given percentage. This is
5713 rather hokey argument, as most of the duplicates will be eliminated later in
5714 cross jumping, so it may be set to much higher values than is the desired code
5715 growth.
5716
5717 @item tracer-min-branch-ratio
5718
5719 Stop reverse growth when the reverse probability of best edge is less than this
5720 threshold (in percent).
5721
5722 @item tracer-min-branch-ratio
5723 @itemx tracer-min-branch-ratio-feedback
5724
5725 Stop forward growth if the best edge do have probability lower than this
5726 threshold.
5727
5728 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
5729 compilation for profile feedback and one for compilation without. The value
5730 for compilation with profile feedback needs to be more conservative (higher) in
5731 order to make tracer effective.
5732
5733 @item max-cse-path-length
5734
5735 Maximum number of basic blocks on path that cse considers. The default is 10.
5736
5737 @item global-var-threshold
5738
5739 Counts the number of function calls (@var{n}) and the number of
5740 call-clobbered variables (@var{v}). If @var{n}x@var{v} is larger than this limit, a
5741 single artificial variable will be created to represent all the
5742 call-clobbered variables at function call sites. This artificial
5743 variable will then be made to alias every call-clobbered variable.
5744 (done as @code{int * size_t} on the host machine; beware overflow).
5745
5746 @item max-aliased-vops
5747
5748 Maximum number of virtual operands allowed to represent aliases
5749 before triggering the alias grouping heuristic. Alias grouping
5750 reduces compile times and memory consumption needed for aliasing at
5751 the expense of precision loss in alias information.
5752
5753 @item ggc-min-expand
5754
5755 GCC uses a garbage collector to manage its own memory allocation. This
5756 parameter specifies the minimum percentage by which the garbage
5757 collector's heap should be allowed to expand between collections.
5758 Tuning this may improve compilation speed; it has no effect on code
5759 generation.
5760
5761 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
5762 RAM >= 1GB@. If @code{getrlimit} is available, the notion of "RAM" is
5763 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}. If
5764 GCC is not able to calculate RAM on a particular platform, the lower
5765 bound of 30% is used. Setting this parameter and
5766 @option{ggc-min-heapsize} to zero causes a full collection to occur at
5767 every opportunity. This is extremely slow, but can be useful for
5768 debugging.
5769
5770 @item ggc-min-heapsize
5771
5772 Minimum size of the garbage collector's heap before it begins bothering
5773 to collect garbage. The first collection occurs after the heap expands
5774 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}. Again,
5775 tuning this may improve compilation speed, and has no effect on code
5776 generation.
5777
5778 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit which
5779 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
5780 with a lower bound of 4096 (four megabytes) and an upper bound of
5781 131072 (128 megabytes). If GCC is not able to calculate RAM on a
5782 particular platform, the lower bound is used. Setting this parameter
5783 very large effectively disables garbage collection. Setting this
5784 parameter and @option{ggc-min-expand} to zero causes a full collection
5785 to occur at every opportunity.
5786
5787 @item max-reload-search-insns
5788 The maximum number of instruction reload should look backward for equivalent
5789 register. Increasing values mean more aggressive optimization, making the
5790 compile time increase with probably slightly better performance. The default
5791 value is 100.
5792
5793 @item max-cselib-memory-location
5794 The maximum number of memory locations cselib should take into acount.
5795 Increasing values mean more aggressive optimization, making the compile time
5796 increase with probably slightly better performance. The default value is 500.
5797
5798 @item reorder-blocks-duplicate
5799 @itemx reorder-blocks-duplicate-feedback
5800
5801 Used by basic block reordering pass to decide whether to use unconditional
5802 branch or duplicate the code on its destination. Code is duplicated when its
5803 estimated size is smaller than this value multiplied by the estimated size of
5804 unconditional jump in the hot spots of the program.
5805
5806 The @option{reorder-block-duplicate-feedback} is used only when profile
5807 feedback is available and may be set to higher values than
5808 @option{reorder-block-duplicate} since information about the hot spots is more
5809 accurate.
5810
5811 @item max-sched-region-blocks
5812 The maximum number of blocks in a region to be considered for
5813 interblock scheduling. The default value is 10.
5814
5815 @item max-sched-region-insns
5816 The maximum number of insns in a region to be considered for
5817 interblock scheduling. The default value is 100.
5818
5819 @item max-last-value-rtl
5820
5821 The maximum size measured as number of RTLs that can be recorded in an expression
5822 in combiner for a pseudo register as last known value of that register. The default
5823 is 10000.
5824
5825 @item integer-share-limit
5826 Small integer constants can use a shared data structure, reducing the
5827 compiler's memory usage and increasing its speed. This sets the maximum
5828 value of a shared integer constant's. The default value is 256.
5829
5830 @item min-virtual-mappings
5831 Specifies the minimum number of virtual mappings in the incremental
5832 SSA updater that should be registered to trigger the virtual mappings
5833 heuristic defined by virtual-mappings-ratio. The default value is
5834 100.
5835
5836 @item virtual-mappings-ratio
5837 If the number of virtual mappings is virtual-mappings-ratio bigger
5838 than the number of virtual symbols to be updated, then the incremental
5839 SSA updater switches to a full update for those symbols. The default
5840 ratio is 3.
5841
5842 @end table
5843 @end table
5844
5845 @node Preprocessor Options
5846 @section Options Controlling the Preprocessor
5847 @cindex preprocessor options
5848 @cindex options, preprocessor
5849
5850 These options control the C preprocessor, which is run on each C source
5851 file before actual compilation.
5852
5853 If you use the @option{-E} option, nothing is done except preprocessing.
5854 Some of these options make sense only together with @option{-E} because
5855 they cause the preprocessor output to be unsuitable for actual
5856 compilation.
5857
5858 @table @gcctabopt
5859 @opindex Wp
5860 You can use @option{-Wp,@var{option}} to bypass the compiler driver
5861 and pass @var{option} directly through to the preprocessor. If
5862 @var{option} contains commas, it is split into multiple options at the
5863 commas. However, many options are modified, translated or interpreted
5864 by the compiler driver before being passed to the preprocessor, and
5865 @option{-Wp} forcibly bypasses this phase. The preprocessor's direct
5866 interface is undocumented and subject to change, so whenever possible
5867 you should avoid using @option{-Wp} and let the driver handle the
5868 options instead.
5869
5870 @item -Xpreprocessor @var{option}
5871 @opindex preprocessor
5872 Pass @var{option} as an option to the preprocessor. You can use this to
5873 supply system-specific preprocessor options which GCC does not know how to
5874 recognize.
5875
5876 If you want to pass an option that takes an argument, you must use
5877 @option{-Xpreprocessor} twice, once for the option and once for the argument.
5878 @end table
5879
5880 @include cppopts.texi
5881
5882 @node Assembler Options
5883 @section Passing Options to the Assembler
5884
5885 @c prevent bad page break with this line
5886 You can pass options to the assembler.
5887
5888 @table @gcctabopt
5889 @item -Wa,@var{option}
5890 @opindex Wa
5891 Pass @var{option} as an option to the assembler. If @var{option}
5892 contains commas, it is split into multiple options at the commas.
5893
5894 @item -Xassembler @var{option}
5895 @opindex Xassembler
5896 Pass @var{option} as an option to the assembler. You can use this to
5897 supply system-specific assembler options which GCC does not know how to
5898 recognize.
5899
5900 If you want to pass an option that takes an argument, you must use
5901 @option{-Xassembler} twice, once for the option and once for the argument.
5902
5903 @end table
5904
5905 @node Link Options
5906 @section Options for Linking
5907 @cindex link options
5908 @cindex options, linking
5909
5910 These options come into play when the compiler links object files into
5911 an executable output file. They are meaningless if the compiler is
5912 not doing a link step.
5913
5914 @table @gcctabopt
5915 @cindex file names
5916 @item @var{object-file-name}
5917 A file name that does not end in a special recognized suffix is
5918 considered to name an object file or library. (Object files are
5919 distinguished from libraries by the linker according to the file
5920 contents.) If linking is done, these object files are used as input
5921 to the linker.
5922
5923 @item -c
5924 @itemx -S
5925 @itemx -E
5926 @opindex c
5927 @opindex S
5928 @opindex E
5929 If any of these options is used, then the linker is not run, and
5930 object file names should not be used as arguments. @xref{Overall
5931 Options}.
5932
5933 @cindex Libraries
5934 @item -l@var{library}
5935 @itemx -l @var{library}
5936 @opindex l
5937 Search the library named @var{library} when linking. (The second
5938 alternative with the library as a separate argument is only for
5939 POSIX compliance and is not recommended.)
5940
5941 It makes a difference where in the command you write this option; the
5942 linker searches and processes libraries and object files in the order they
5943 are specified. Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
5944 after file @file{foo.o} but before @file{bar.o}. If @file{bar.o} refers
5945 to functions in @samp{z}, those functions may not be loaded.
5946
5947 The linker searches a standard list of directories for the library,
5948 which is actually a file named @file{lib@var{library}.a}. The linker
5949 then uses this file as if it had been specified precisely by name.
5950
5951 The directories searched include several standard system directories
5952 plus any that you specify with @option{-L}.
5953
5954 Normally the files found this way are library files---archive files
5955 whose members are object files. The linker handles an archive file by
5956 scanning through it for members which define symbols that have so far
5957 been referenced but not defined. But if the file that is found is an
5958 ordinary object file, it is linked in the usual fashion. The only
5959 difference between using an @option{-l} option and specifying a file name
5960 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
5961 and searches several directories.
5962
5963 @item -lobjc
5964 @opindex lobjc
5965 You need this special case of the @option{-l} option in order to
5966 link an Objective-C or Objective-C++ program.
5967
5968 @item -nostartfiles
5969 @opindex nostartfiles
5970 Do not use the standard system startup files when linking.
5971 The standard system libraries are used normally, unless @option{-nostdlib}
5972 or @option{-nodefaultlibs} is used.
5973
5974 @item -nodefaultlibs
5975 @opindex nodefaultlibs
5976 Do not use the standard system libraries when linking.
5977 Only the libraries you specify will be passed to the linker.
5978 The standard startup files are used normally, unless @option{-nostartfiles}
5979 is used. The compiler may generate calls to @code{memcmp},
5980 @code{memset}, @code{memcpy} and @code{memmove}.
5981 These entries are usually resolved by entries in
5982 libc. These entry points should be supplied through some other
5983 mechanism when this option is specified.
5984
5985 @item -nostdlib
5986 @opindex nostdlib
5987 Do not use the standard system startup files or libraries when linking.
5988 No startup files and only the libraries you specify will be passed to
5989 the linker. The compiler may generate calls to @code{memcmp}, @code{memset},
5990 @code{memcpy} and @code{memmove}.
5991 These entries are usually resolved by entries in
5992 libc. These entry points should be supplied through some other
5993 mechanism when this option is specified.
5994
5995 @cindex @option{-lgcc}, use with @option{-nostdlib}
5996 @cindex @option{-nostdlib} and unresolved references
5997 @cindex unresolved references and @option{-nostdlib}
5998 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
5999 @cindex @option{-nodefaultlibs} and unresolved references
6000 @cindex unresolved references and @option{-nodefaultlibs}
6001 One of the standard libraries bypassed by @option{-nostdlib} and
6002 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
6003 that GCC uses to overcome shortcomings of particular machines, or special
6004 needs for some languages.
6005 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
6006 Collection (GCC) Internals},
6007 for more discussion of @file{libgcc.a}.)
6008 In most cases, you need @file{libgcc.a} even when you want to avoid
6009 other standard libraries. In other words, when you specify @option{-nostdlib}
6010 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
6011 This ensures that you have no unresolved references to internal GCC
6012 library subroutines. (For example, @samp{__main}, used to ensure C++
6013 constructors will be called; @pxref{Collect2,,@code{collect2}, gccint,
6014 GNU Compiler Collection (GCC) Internals}.)
6015
6016 @item -pie
6017 @opindex pie
6018 Produce a position independent executable on targets which support it.
6019 For predictable results, you must also specify the same set of options
6020 that were used to generate code (@option{-fpie}, @option{-fPIE},
6021 or model suboptions) when you specify this option.
6022
6023 @item -s
6024 @opindex s
6025 Remove all symbol table and relocation information from the executable.
6026
6027 @item -static
6028 @opindex static
6029 On systems that support dynamic linking, this prevents linking with the shared
6030 libraries. On other systems, this option has no effect.
6031
6032 @item -shared
6033 @opindex shared
6034 Produce a shared object which can then be linked with other objects to
6035 form an executable. Not all systems support this option. For predictable
6036 results, you must also specify the same set of options that were used to
6037 generate code (@option{-fpic}, @option{-fPIC}, or model suboptions)
6038 when you specify this option.@footnote{On some systems, @samp{gcc -shared}
6039 needs to build supplementary stub code for constructors to work. On
6040 multi-libbed systems, @samp{gcc -shared} must select the correct support
6041 libraries to link against. Failing to supply the correct flags may lead
6042 to subtle defects. Supplying them in cases where they are not necessary
6043 is innocuous.}
6044
6045 @item -shared-libgcc
6046 @itemx -static-libgcc
6047 @opindex shared-libgcc
6048 @opindex static-libgcc
6049 On systems that provide @file{libgcc} as a shared library, these options
6050 force the use of either the shared or static version respectively.
6051 If no shared version of @file{libgcc} was built when the compiler was
6052 configured, these options have no effect.
6053
6054 There are several situations in which an application should use the
6055 shared @file{libgcc} instead of the static version. The most common
6056 of these is when the application wishes to throw and catch exceptions
6057 across different shared libraries. In that case, each of the libraries
6058 as well as the application itself should use the shared @file{libgcc}.
6059
6060 Therefore, the G++ and GCJ drivers automatically add
6061 @option{-shared-libgcc} whenever you build a shared library or a main
6062 executable, because C++ and Java programs typically use exceptions, so
6063 this is the right thing to do.
6064
6065 If, instead, you use the GCC driver to create shared libraries, you may
6066 find that they will not always be linked with the shared @file{libgcc}.
6067 If GCC finds, at its configuration time, that you have a non-GNU linker
6068 or a GNU linker that does not support option @option{--eh-frame-hdr},
6069 it will link the shared version of @file{libgcc} into shared libraries
6070 by default. Otherwise, it will take advantage of the linker and optimize
6071 away the linking with the shared version of @file{libgcc}, linking with
6072 the static version of libgcc by default. This allows exceptions to
6073 propagate through such shared libraries, without incurring relocation
6074 costs at library load time.
6075
6076 However, if a library or main executable is supposed to throw or catch
6077 exceptions, you must link it using the G++ or GCJ driver, as appropriate
6078 for the languages used in the program, or using the option
6079 @option{-shared-libgcc}, such that it is linked with the shared
6080 @file{libgcc}.
6081
6082 @item -symbolic
6083 @opindex symbolic
6084 Bind references to global symbols when building a shared object. Warn
6085 about any unresolved references (unless overridden by the link editor
6086 option @samp{-Xlinker -z -Xlinker defs}). Only a few systems support
6087 this option.
6088
6089 @item -Xlinker @var{option}
6090 @opindex Xlinker
6091 Pass @var{option} as an option to the linker. You can use this to
6092 supply system-specific linker options which GCC does not know how to
6093 recognize.
6094
6095 If you want to pass an option that takes an argument, you must use
6096 @option{-Xlinker} twice, once for the option and once for the argument.
6097 For example, to pass @option{-assert definitions}, you must write
6098 @samp{-Xlinker -assert -Xlinker definitions}. It does not work to write
6099 @option{-Xlinker "-assert definitions"}, because this passes the entire
6100 string as a single argument, which is not what the linker expects.
6101
6102 @item -Wl,@var{option}
6103 @opindex Wl
6104 Pass @var{option} as an option to the linker. If @var{option} contains
6105 commas, it is split into multiple options at the commas.
6106
6107 @item -u @var{symbol}
6108 @opindex u
6109 Pretend the symbol @var{symbol} is undefined, to force linking of
6110 library modules to define it. You can use @option{-u} multiple times with
6111 different symbols to force loading of additional library modules.
6112 @end table
6113
6114 @node Directory Options
6115 @section Options for Directory Search
6116 @cindex directory options
6117 @cindex options, directory search
6118 @cindex search path
6119
6120 These options specify directories to search for header files, for
6121 libraries and for parts of the compiler:
6122
6123 @table @gcctabopt
6124 @item -I@var{dir}
6125 @opindex I
6126 Add the directory @var{dir} to the head of the list of directories to be
6127 searched for header files. This can be used to override a system header
6128 file, substituting your own version, since these directories are
6129 searched before the system header file directories. However, you should
6130 not use this option to add directories that contain vendor-supplied
6131 system header files (use @option{-isystem} for that). If you use more than
6132 one @option{-I} option, the directories are scanned in left-to-right
6133 order; the standard system directories come after.
6134
6135 If a standard system include directory, or a directory specified with
6136 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
6137 option will be ignored. The directory will still be searched but as a
6138 system directory at its normal position in the system include chain.
6139 This is to ensure that GCC's procedure to fix buggy system headers and
6140 the ordering for the include_next directive are not inadvertently changed.
6141 If you really need to change the search order for system directories,
6142 use the @option{-nostdinc} and/or @option{-isystem} options.
6143
6144 @item -iquote@var{dir}
6145 @opindex iquote
6146 Add the directory @var{dir} to the head of the list of directories to
6147 be searched for header files only for the case of @samp{#include
6148 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
6149 otherwise just like @option{-I}.
6150
6151 @item -L@var{dir}
6152 @opindex L
6153 Add directory @var{dir} to the list of directories to be searched
6154 for @option{-l}.
6155
6156 @item -B@var{prefix}
6157 @opindex B
6158 This option specifies where to find the executables, libraries,
6159 include files, and data files of the compiler itself.
6160
6161 The compiler driver program runs one or more of the subprograms
6162 @file{cpp}, @file{cc1}, @file{as} and @file{ld}. It tries
6163 @var{prefix} as a prefix for each program it tries to run, both with and
6164 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
6165
6166 For each subprogram to be run, the compiler driver first tries the
6167 @option{-B} prefix, if any. If that name is not found, or if @option{-B}
6168 was not specified, the driver tries two standard prefixes, which are
6169 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}. If neither of
6170 those results in a file name that is found, the unmodified program
6171 name is searched for using the directories specified in your
6172 @env{PATH} environment variable.
6173
6174 The compiler will check to see if the path provided by the @option{-B}
6175 refers to a directory, and if necessary it will add a directory
6176 separator character at the end of the path.
6177
6178 @option{-B} prefixes that effectively specify directory names also apply
6179 to libraries in the linker, because the compiler translates these
6180 options into @option{-L} options for the linker. They also apply to
6181 includes files in the preprocessor, because the compiler translates these
6182 options into @option{-isystem} options for the preprocessor. In this case,
6183 the compiler appends @samp{include} to the prefix.
6184
6185 The run-time support file @file{libgcc.a} can also be searched for using
6186 the @option{-B} prefix, if needed. If it is not found there, the two
6187 standard prefixes above are tried, and that is all. The file is left
6188 out of the link if it is not found by those means.
6189
6190 Another way to specify a prefix much like the @option{-B} prefix is to use
6191 the environment variable @env{GCC_EXEC_PREFIX}. @xref{Environment
6192 Variables}.
6193
6194 As a special kludge, if the path provided by @option{-B} is
6195 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
6196 9, then it will be replaced by @file{[dir/]include}. This is to help
6197 with boot-strapping the compiler.
6198
6199 @item -specs=@var{file}
6200 @opindex specs
6201 Process @var{file} after the compiler reads in the standard @file{specs}
6202 file, in order to override the defaults that the @file{gcc} driver
6203 program uses when determining what switches to pass to @file{cc1},
6204 @file{cc1plus}, @file{as}, @file{ld}, etc. More than one
6205 @option{-specs=@var{file}} can be specified on the command line, and they
6206 are processed in order, from left to right.
6207
6208 @item -I-
6209 @opindex I-
6210 This option has been deprecated. Please use @option{-iquote} instead for
6211 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
6212 Any directories you specify with @option{-I} options before the @option{-I-}
6213 option are searched only for the case of @samp{#include "@var{file}"};
6214 they are not searched for @samp{#include <@var{file}>}.
6215
6216 If additional directories are specified with @option{-I} options after
6217 the @option{-I-}, these directories are searched for all @samp{#include}
6218 directives. (Ordinarily @emph{all} @option{-I} directories are used
6219 this way.)
6220
6221 In addition, the @option{-I-} option inhibits the use of the current
6222 directory (where the current input file came from) as the first search
6223 directory for @samp{#include "@var{file}"}. There is no way to
6224 override this effect of @option{-I-}. With @option{-I.} you can specify
6225 searching the directory which was current when the compiler was
6226 invoked. That is not exactly the same as what the preprocessor does
6227 by default, but it is often satisfactory.
6228
6229 @option{-I-} does not inhibit the use of the standard system directories
6230 for header files. Thus, @option{-I-} and @option{-nostdinc} are
6231 independent.
6232 @end table
6233
6234 @c man end
6235
6236 @node Spec Files
6237 @section Specifying subprocesses and the switches to pass to them
6238 @cindex Spec Files
6239
6240 @command{gcc} is a driver program. It performs its job by invoking a
6241 sequence of other programs to do the work of compiling, assembling and
6242 linking. GCC interprets its command-line parameters and uses these to
6243 deduce which programs it should invoke, and which command-line options
6244 it ought to place on their command lines. This behavior is controlled
6245 by @dfn{spec strings}. In most cases there is one spec string for each
6246 program that GCC can invoke, but a few programs have multiple spec
6247 strings to control their behavior. The spec strings built into GCC can
6248 be overridden by using the @option{-specs=} command-line switch to specify
6249 a spec file.
6250
6251 @dfn{Spec files} are plaintext files that are used to construct spec
6252 strings. They consist of a sequence of directives separated by blank
6253 lines. The type of directive is determined by the first non-whitespace
6254 character on the line and it can be one of the following:
6255
6256 @table @code
6257 @item %@var{command}
6258 Issues a @var{command} to the spec file processor. The commands that can
6259 appear here are:
6260
6261 @table @code
6262 @item %include <@var{file}>
6263 @cindex %include
6264 Search for @var{file} and insert its text at the current point in the
6265 specs file.
6266
6267 @item %include_noerr <@var{file}>
6268 @cindex %include_noerr
6269 Just like @samp{%include}, but do not generate an error message if the include
6270 file cannot be found.
6271
6272 @item %rename @var{old_name} @var{new_name}
6273 @cindex %rename
6274 Rename the spec string @var{old_name} to @var{new_name}.
6275
6276 @end table
6277
6278 @item *[@var{spec_name}]:
6279 This tells the compiler to create, override or delete the named spec
6280 string. All lines after this directive up to the next directive or
6281 blank line are considered to be the text for the spec string. If this
6282 results in an empty string then the spec will be deleted. (Or, if the
6283 spec did not exist, then nothing will happened.) Otherwise, if the spec
6284 does not currently exist a new spec will be created. If the spec does
6285 exist then its contents will be overridden by the text of this
6286 directive, unless the first character of that text is the @samp{+}
6287 character, in which case the text will be appended to the spec.
6288
6289 @item [@var{suffix}]:
6290 Creates a new @samp{[@var{suffix}] spec} pair. All lines after this directive
6291 and up to the next directive or blank line are considered to make up the
6292 spec string for the indicated suffix. When the compiler encounters an
6293 input file with the named suffix, it will processes the spec string in
6294 order to work out how to compile that file. For example:
6295
6296 @smallexample
6297 .ZZ:
6298 z-compile -input %i
6299 @end smallexample
6300
6301 This says that any input file whose name ends in @samp{.ZZ} should be
6302 passed to the program @samp{z-compile}, which should be invoked with the
6303 command-line switch @option{-input} and with the result of performing the
6304 @samp{%i} substitution. (See below.)
6305
6306 As an alternative to providing a spec string, the text that follows a
6307 suffix directive can be one of the following:
6308
6309 @table @code
6310 @item @@@var{language}
6311 This says that the suffix is an alias for a known @var{language}. This is
6312 similar to using the @option{-x} command-line switch to GCC to specify a
6313 language explicitly. For example:
6314
6315 @smallexample
6316 .ZZ:
6317 @@c++
6318 @end smallexample
6319
6320 Says that .ZZ files are, in fact, C++ source files.
6321
6322 @item #@var{name}
6323 This causes an error messages saying:
6324
6325 @smallexample
6326 @var{name} compiler not installed on this system.
6327 @end smallexample
6328 @end table
6329
6330 GCC already has an extensive list of suffixes built into it.
6331 This directive will add an entry to the end of the list of suffixes, but
6332 since the list is searched from the end backwards, it is effectively
6333 possible to override earlier entries using this technique.
6334
6335 @end table
6336
6337 GCC has the following spec strings built into it. Spec files can
6338 override these strings or create their own. Note that individual
6339 targets can also add their own spec strings to this list.
6340
6341 @smallexample
6342 asm Options to pass to the assembler
6343 asm_final Options to pass to the assembler post-processor
6344 cpp Options to pass to the C preprocessor
6345 cc1 Options to pass to the C compiler
6346 cc1plus Options to pass to the C++ compiler
6347 endfile Object files to include at the end of the link
6348 link Options to pass to the linker
6349 lib Libraries to include on the command line to the linker
6350 libgcc Decides which GCC support library to pass to the linker
6351 linker Sets the name of the linker
6352 predefines Defines to be passed to the C preprocessor
6353 signed_char Defines to pass to CPP to say whether @code{char} is signed
6354 by default
6355 startfile Object files to include at the start of the link
6356 @end smallexample
6357
6358 Here is a small example of a spec file:
6359
6360 @smallexample
6361 %rename lib old_lib
6362
6363 *lib:
6364 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
6365 @end smallexample
6366
6367 This example renames the spec called @samp{lib} to @samp{old_lib} and
6368 then overrides the previous definition of @samp{lib} with a new one.
6369 The new definition adds in some extra command-line options before
6370 including the text of the old definition.
6371
6372 @dfn{Spec strings} are a list of command-line options to be passed to their
6373 corresponding program. In addition, the spec strings can contain
6374 @samp{%}-prefixed sequences to substitute variable text or to
6375 conditionally insert text into the command line. Using these constructs
6376 it is possible to generate quite complex command lines.
6377
6378 Here is a table of all defined @samp{%}-sequences for spec
6379 strings. Note that spaces are not generated automatically around the
6380 results of expanding these sequences. Therefore you can concatenate them
6381 together or combine them with constant text in a single argument.
6382
6383 @table @code
6384 @item %%
6385 Substitute one @samp{%} into the program name or argument.
6386
6387 @item %i
6388 Substitute the name of the input file being processed.
6389
6390 @item %b
6391 Substitute the basename of the input file being processed.
6392 This is the substring up to (and not including) the last period
6393 and not including the directory.
6394
6395 @item %B
6396 This is the same as @samp{%b}, but include the file suffix (text after
6397 the last period).
6398
6399 @item %d
6400 Marks the argument containing or following the @samp{%d} as a
6401 temporary file name, so that that file will be deleted if GCC exits
6402 successfully. Unlike @samp{%g}, this contributes no text to the
6403 argument.
6404
6405 @item %g@var{suffix}
6406 Substitute a file name that has suffix @var{suffix} and is chosen
6407 once per compilation, and mark the argument in the same way as
6408 @samp{%d}. To reduce exposure to denial-of-service attacks, the file
6409 name is now chosen in a way that is hard to predict even when previously
6410 chosen file names are known. For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
6411 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}. @var{suffix} matches
6412 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
6413 treated exactly as if @samp{%O} had been preprocessed. Previously, @samp{%g}
6414 was simply substituted with a file name chosen once per compilation,
6415 without regard to any appended suffix (which was therefore treated
6416 just like ordinary text), making such attacks more likely to succeed.
6417
6418 @item %u@var{suffix}
6419 Like @samp{%g}, but generates a new temporary file name even if
6420 @samp{%u@var{suffix}} was already seen.
6421
6422 @item %U@var{suffix}
6423 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
6424 new one if there is no such last file name. In the absence of any
6425 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
6426 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
6427 would involve the generation of two distinct file names, one
6428 for each @samp{%g.s} and another for each @samp{%U.s}. Previously, @samp{%U} was
6429 simply substituted with a file name chosen for the previous @samp{%u},
6430 without regard to any appended suffix.
6431
6432 @item %j@var{suffix}
6433 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
6434 writable, and if save-temps is off; otherwise, substitute the name
6435 of a temporary file, just like @samp{%u}. This temporary file is not
6436 meant for communication between processes, but rather as a junk
6437 disposal mechanism.
6438
6439 @item %|@var{suffix}
6440 @itemx %m@var{suffix}
6441 Like @samp{%g}, except if @option{-pipe} is in effect. In that case
6442 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
6443 all. These are the two most common ways to instruct a program that it
6444 should read from standard input or write to standard output. If you
6445 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
6446 construct: see for example @file{f/lang-specs.h}.
6447
6448 @item %.@var{SUFFIX}
6449 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
6450 when it is subsequently output with @samp{%*}. @var{SUFFIX} is
6451 terminated by the next space or %.
6452
6453 @item %w
6454 Marks the argument containing or following the @samp{%w} as the
6455 designated output file of this compilation. This puts the argument
6456 into the sequence of arguments that @samp{%o} will substitute later.
6457
6458 @item %o
6459 Substitutes the names of all the output files, with spaces
6460 automatically placed around them. You should write spaces
6461 around the @samp{%o} as well or the results are undefined.
6462 @samp{%o} is for use in the specs for running the linker.
6463 Input files whose names have no recognized suffix are not compiled
6464 at all, but they are included among the output files, so they will
6465 be linked.
6466
6467 @item %O
6468 Substitutes the suffix for object files. Note that this is
6469 handled specially when it immediately follows @samp{%g, %u, or %U},
6470 because of the need for those to form complete file names. The
6471 handling is such that @samp{%O} is treated exactly as if it had already
6472 been substituted, except that @samp{%g, %u, and %U} do not currently
6473 support additional @var{suffix} characters following @samp{%O} as they would
6474 following, for example, @samp{.o}.
6475
6476 @item %p
6477 Substitutes the standard macro predefinitions for the
6478 current target machine. Use this when running @code{cpp}.
6479
6480 @item %P
6481 Like @samp{%p}, but puts @samp{__} before and after the name of each
6482 predefined macro, except for macros that start with @samp{__} or with
6483 @samp{_@var{L}}, where @var{L} is an uppercase letter. This is for ISO
6484 C@.
6485
6486 @item %I
6487 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
6488 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}), and
6489 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
6490 as necessary.
6491
6492 @item %s
6493 Current argument is the name of a library or startup file of some sort.
6494 Search for that file in a standard list of directories and substitute
6495 the full name found.
6496
6497 @item %e@var{str}
6498 Print @var{str} as an error message. @var{str} is terminated by a newline.
6499 Use this when inconsistent options are detected.
6500
6501 @item %(@var{name})
6502 Substitute the contents of spec string @var{name} at this point.
6503
6504 @item %[@var{name}]
6505 Like @samp{%(@dots{})} but put @samp{__} around @option{-D} arguments.
6506
6507 @item %x@{@var{option}@}
6508 Accumulate an option for @samp{%X}.
6509
6510 @item %X
6511 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
6512 spec string.
6513
6514 @item %Y
6515 Output the accumulated assembler options specified by @option{-Wa}.
6516
6517 @item %Z
6518 Output the accumulated preprocessor options specified by @option{-Wp}.
6519
6520 @item %a
6521 Process the @code{asm} spec. This is used to compute the
6522 switches to be passed to the assembler.
6523
6524 @item %A
6525 Process the @code{asm_final} spec. This is a spec string for
6526 passing switches to an assembler post-processor, if such a program is
6527 needed.
6528
6529 @item %l
6530 Process the @code{link} spec. This is the spec for computing the
6531 command line passed to the linker. Typically it will make use of the
6532 @samp{%L %G %S %D and %E} sequences.
6533
6534 @item %D
6535 Dump out a @option{-L} option for each directory that GCC believes might
6536 contain startup files. If the target supports multilibs then the
6537 current multilib directory will be prepended to each of these paths.
6538
6539 @item %L
6540 Process the @code{lib} spec. This is a spec string for deciding which
6541 libraries should be included on the command line to the linker.
6542
6543 @item %G
6544 Process the @code{libgcc} spec. This is a spec string for deciding
6545 which GCC support library should be included on the command line to the linker.
6546
6547 @item %S
6548 Process the @code{startfile} spec. This is a spec for deciding which
6549 object files should be the first ones passed to the linker. Typically
6550 this might be a file named @file{crt0.o}.
6551
6552 @item %E
6553 Process the @code{endfile} spec. This is a spec string that specifies
6554 the last object files that will be passed to the linker.
6555
6556 @item %C
6557 Process the @code{cpp} spec. This is used to construct the arguments
6558 to be passed to the C preprocessor.
6559
6560 @item %1
6561 Process the @code{cc1} spec. This is used to construct the options to be
6562 passed to the actual C compiler (@samp{cc1}).
6563
6564 @item %2
6565 Process the @code{cc1plus} spec. This is used to construct the options to be
6566 passed to the actual C++ compiler (@samp{cc1plus}).
6567
6568 @item %*
6569 Substitute the variable part of a matched option. See below.
6570 Note that each comma in the substituted string is replaced by
6571 a single space.
6572
6573 @item %<@code{S}
6574 Remove all occurrences of @code{-S} from the command line. Note---this
6575 command is position dependent. @samp{%} commands in the spec string
6576 before this one will see @code{-S}, @samp{%} commands in the spec string
6577 after this one will not.
6578
6579 @item %:@var{function}(@var{args})
6580 Call the named function @var{function}, passing it @var{args}.
6581 @var{args} is first processed as a nested spec string, then split
6582 into an argument vector in the usual fashion. The function returns
6583 a string which is processed as if it had appeared literally as part
6584 of the current spec.
6585
6586 The following built-in spec functions are provided:
6587
6588 @table @code
6589 @item @code{if-exists}
6590 The @code{if-exists} spec function takes one argument, an absolute
6591 pathname to a file. If the file exists, @code{if-exists} returns the
6592 pathname. Here is a small example of its usage:
6593
6594 @smallexample
6595 *startfile:
6596 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
6597 @end smallexample
6598
6599 @item @code{if-exists-else}
6600 The @code{if-exists-else} spec function is similar to the @code{if-exists}
6601 spec function, except that it takes two arguments. The first argument is
6602 an absolute pathname to a file. If the file exists, @code{if-exists-else}
6603 returns the pathname. If it does not exist, it returns the second argument.
6604 This way, @code{if-exists-else} can be used to select one file or another,
6605 based on the existence of the first. Here is a small example of its usage:
6606
6607 @smallexample
6608 *startfile:
6609 crt0%O%s %:if-exists(crti%O%s) \
6610 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
6611 @end smallexample
6612
6613 @item @code{replace-outfile}
6614 The @code{replace-outfile} spec function takes two arguments. It looks for the
6615 first argument in the outfiles array and replaces it with the second argument. Here
6616 is a small example of its usage:
6617
6618 @smallexample
6619 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
6620 @end smallexample
6621
6622 @end table
6623
6624 @item %@{@code{S}@}
6625 Substitutes the @code{-S} switch, if that switch was given to GCC@.
6626 If that switch was not specified, this substitutes nothing. Note that
6627 the leading dash is omitted when specifying this option, and it is
6628 automatically inserted if the substitution is performed. Thus the spec
6629 string @samp{%@{foo@}} would match the command-line option @option{-foo}
6630 and would output the command line option @option{-foo}.
6631
6632 @item %W@{@code{S}@}
6633 Like %@{@code{S}@} but mark last argument supplied within as a file to be
6634 deleted on failure.
6635
6636 @item %@{@code{S}*@}
6637 Substitutes all the switches specified to GCC whose names start
6638 with @code{-S}, but which also take an argument. This is used for
6639 switches like @option{-o}, @option{-D}, @option{-I}, etc.
6640 GCC considers @option{-o foo} as being
6641 one switch whose names starts with @samp{o}. %@{o*@} would substitute this
6642 text, including the space. Thus two arguments would be generated.
6643
6644 @item %@{@code{S}*&@code{T}*@}
6645 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
6646 (the order of @code{S} and @code{T} in the spec is not significant).
6647 There can be any number of ampersand-separated variables; for each the
6648 wild card is optional. Useful for CPP as @samp{%@{D*&U*&A*@}}.
6649
6650 @item %@{@code{S}:@code{X}@}
6651 Substitutes @code{X}, if the @samp{-S} switch was given to GCC@.
6652
6653 @item %@{!@code{S}:@code{X}@}
6654 Substitutes @code{X}, if the @samp{-S} switch was @emph{not} given to GCC@.
6655
6656 @item %@{@code{S}*:@code{X}@}
6657 Substitutes @code{X} if one or more switches whose names start with
6658 @code{-S} are specified to GCC@. Normally @code{X} is substituted only
6659 once, no matter how many such switches appeared. However, if @code{%*}
6660 appears somewhere in @code{X}, then @code{X} will be substituted once
6661 for each matching switch, with the @code{%*} replaced by the part of
6662 that switch that matched the @code{*}.
6663
6664 @item %@{.@code{S}:@code{X}@}
6665 Substitutes @code{X}, if processing a file with suffix @code{S}.
6666
6667 @item %@{!.@code{S}:@code{X}@}
6668 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
6669
6670 @item %@{@code{S}|@code{P}:@code{X}@}
6671 Substitutes @code{X} if either @code{-S} or @code{-P} was given to GCC@.
6672 This may be combined with @samp{!}, @samp{.}, and @code{*} sequences as well,
6673 although they have a stronger binding than the @samp{|}. If @code{%*}
6674 appears in @code{X}, all of the alternatives must be starred, and only
6675 the first matching alternative is substituted.
6676
6677 For example, a spec string like this:
6678
6679 @smallexample
6680 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
6681 @end smallexample
6682
6683 will output the following command-line options from the following input
6684 command-line options:
6685
6686 @smallexample
6687 fred.c -foo -baz
6688 jim.d -bar -boggle
6689 -d fred.c -foo -baz -boggle
6690 -d jim.d -bar -baz -boggle
6691 @end smallexample
6692
6693 @item %@{S:X; T:Y; :D@}
6694
6695 If @code{S} was given to GCC, substitutes @code{X}; else if @code{T} was
6696 given to GCC, substitutes @code{Y}; else substitutes @code{D}. There can
6697 be as many clauses as you need. This may be combined with @code{.},
6698 @code{!}, @code{|}, and @code{*} as needed.
6699
6700
6701 @end table
6702
6703 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
6704 construct may contain other nested @samp{%} constructs or spaces, or
6705 even newlines. They are processed as usual, as described above.
6706 Trailing white space in @code{X} is ignored. White space may also
6707 appear anywhere on the left side of the colon in these constructs,
6708 except between @code{.} or @code{*} and the corresponding word.
6709
6710 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
6711 handled specifically in these constructs. If another value of
6712 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
6713 @option{-W} switch is found later in the command line, the earlier
6714 switch value is ignored, except with @{@code{S}*@} where @code{S} is
6715 just one letter, which passes all matching options.
6716
6717 The character @samp{|} at the beginning of the predicate text is used to
6718 indicate that a command should be piped to the following command, but
6719 only if @option{-pipe} is specified.
6720
6721 It is built into GCC which switches take arguments and which do not.
6722 (You might think it would be useful to generalize this to allow each
6723 compiler's spec to say which switches take arguments. But this cannot
6724 be done in a consistent fashion. GCC cannot even decide which input
6725 files have been specified without knowing which switches take arguments,
6726 and it must know which input files to compile in order to tell which
6727 compilers to run).
6728
6729 GCC also knows implicitly that arguments starting in @option{-l} are to be
6730 treated as compiler output files, and passed to the linker in their
6731 proper position among the other output files.
6732
6733 @c man begin OPTIONS
6734
6735 @node Target Options
6736 @section Specifying Target Machine and Compiler Version
6737 @cindex target options
6738 @cindex cross compiling
6739 @cindex specifying machine version
6740 @cindex specifying compiler version and target machine
6741 @cindex compiler version, specifying
6742 @cindex target machine, specifying
6743
6744 The usual way to run GCC is to run the executable called @file{gcc}, or
6745 @file{<machine>-gcc} when cross-compiling, or
6746 @file{<machine>-gcc-<version>} to run a version other than the one that
6747 was installed last. Sometimes this is inconvenient, so GCC provides
6748 options that will switch to another cross-compiler or version.
6749
6750 @table @gcctabopt
6751 @item -b @var{machine}
6752 @opindex b
6753 The argument @var{machine} specifies the target machine for compilation.
6754
6755 The value to use for @var{machine} is the same as was specified as the
6756 machine type when configuring GCC as a cross-compiler. For
6757 example, if a cross-compiler was configured with @samp{configure
6758 i386v}, meaning to compile for an 80386 running System V, then you
6759 would specify @option{-b i386v} to run that cross compiler.
6760
6761 @item -V @var{version}
6762 @opindex V
6763 The argument @var{version} specifies which version of GCC to run.
6764 This is useful when multiple versions are installed. For example,
6765 @var{version} might be @samp{2.0}, meaning to run GCC version 2.0.
6766 @end table
6767
6768 The @option{-V} and @option{-b} options work by running the
6769 @file{<machine>-gcc-<version>} executable, so there's no real reason to
6770 use them if you can just run that directly.
6771
6772 @node Submodel Options
6773 @section Hardware Models and Configurations
6774 @cindex submodel options
6775 @cindex specifying hardware config
6776 @cindex hardware models and configurations, specifying
6777 @cindex machine dependent options
6778
6779 Earlier we discussed the standard option @option{-b} which chooses among
6780 different installed compilers for completely different target
6781 machines, such as VAX vs.@: 68000 vs.@: 80386.
6782
6783 In addition, each of these target machine types can have its own
6784 special options, starting with @samp{-m}, to choose among various
6785 hardware models or configurations---for example, 68010 vs 68020,
6786 floating coprocessor or none. A single installed version of the
6787 compiler can compile for any model or configuration, according to the
6788 options specified.
6789
6790 Some configurations of the compiler also support additional special
6791 options, usually for compatibility with other compilers on the same
6792 platform.
6793
6794 These options are defined by the macro @code{TARGET_SWITCHES} in the
6795 machine description. The default for the options is also defined by
6796 that macro, which enables you to change the defaults.
6797
6798 @c This list is ordered alphanumerically by subsection name.
6799 @c It should be the same order and spelling as these options are listed
6800 @c in Machine Dependent Options
6801
6802 @menu
6803 * ARC Options::
6804 * ARM Options::
6805 * AVR Options::
6806 * Blackfin Options::
6807 * CRIS Options::
6808 * Darwin Options::
6809 * DEC Alpha Options::
6810 * DEC Alpha/VMS Options::
6811 * FRV Options::
6812 * H8/300 Options::
6813 * HPPA Options::
6814 * i386 and x86-64 Options::
6815 * IA-64 Options::
6816 * M32R/D Options::
6817 * M680x0 Options::
6818 * M68hc1x Options::
6819 * MCore Options::
6820 * MIPS Options::
6821 * MMIX Options::
6822 * MN10300 Options::
6823 * NS32K Options::
6824 * PDP-11 Options::
6825 * PowerPC Options::
6826 * RS/6000 and PowerPC Options::
6827 * S/390 and zSeries Options::
6828 * SH Options::
6829 * SPARC Options::
6830 * System V Options::
6831 * TMS320C3x/C4x Options::
6832 * V850 Options::
6833 * VAX Options::
6834 * x86-64 Options::
6835 * Xstormy16 Options::
6836 * Xtensa Options::
6837 * zSeries Options::
6838 @end menu
6839
6840 @node ARC Options
6841 @subsection ARC Options
6842 @cindex ARC Options
6843
6844 These options are defined for ARC implementations:
6845
6846 @table @gcctabopt
6847 @item -EL
6848 @opindex EL
6849 Compile code for little endian mode. This is the default.
6850
6851 @item -EB
6852 @opindex EB
6853 Compile code for big endian mode.
6854
6855 @item -mmangle-cpu
6856 @opindex mmangle-cpu
6857 Prepend the name of the cpu to all public symbol names.
6858 In multiple-processor systems, there are many ARC variants with different
6859 instruction and register set characteristics. This flag prevents code
6860 compiled for one cpu to be linked with code compiled for another.
6861 No facility exists for handling variants that are ``almost identical''.
6862 This is an all or nothing option.
6863
6864 @item -mcpu=@var{cpu}
6865 @opindex mcpu
6866 Compile code for ARC variant @var{cpu}.
6867 Which variants are supported depend on the configuration.
6868 All variants support @option{-mcpu=base}, this is the default.
6869
6870 @item -mtext=@var{text-section}
6871 @itemx -mdata=@var{data-section}
6872 @itemx -mrodata=@var{readonly-data-section}
6873 @opindex mtext
6874 @opindex mdata
6875 @opindex mrodata
6876 Put functions, data, and readonly data in @var{text-section},
6877 @var{data-section}, and @var{readonly-data-section} respectively
6878 by default. This can be overridden with the @code{section} attribute.
6879 @xref{Variable Attributes}.
6880
6881 @end table
6882
6883 @node ARM Options
6884 @subsection ARM Options
6885 @cindex ARM options
6886
6887 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
6888 architectures:
6889
6890 @table @gcctabopt
6891 @item -mabi=@var{name}
6892 @opindex mabi
6893 Generate code for the specified ABI@. Permissible values are: @samp{apcs-gnu},
6894 @samp{atpcs}, @samp{aapcs} and @samp{iwmmxt}.
6895
6896 @item -mapcs-frame
6897 @opindex mapcs-frame
6898 Generate a stack frame that is compliant with the ARM Procedure Call
6899 Standard for all functions, even if this is not strictly necessary for
6900 correct execution of the code. Specifying @option{-fomit-frame-pointer}
6901 with this option will cause the stack frames not to be generated for
6902 leaf functions. The default is @option{-mno-apcs-frame}.
6903
6904 @item -mapcs
6905 @opindex mapcs
6906 This is a synonym for @option{-mapcs-frame}.
6907
6908 @ignore
6909 @c not currently implemented
6910 @item -mapcs-stack-check
6911 @opindex mapcs-stack-check
6912 Generate code to check the amount of stack space available upon entry to
6913 every function (that actually uses some stack space). If there is
6914 insufficient space available then either the function
6915 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} will be
6916 called, depending upon the amount of stack space required. The run time
6917 system is required to provide these functions. The default is
6918 @option{-mno-apcs-stack-check}, since this produces smaller code.
6919
6920 @c not currently implemented
6921 @item -mapcs-float
6922 @opindex mapcs-float
6923 Pass floating point arguments using the float point registers. This is
6924 one of the variants of the APCS@. This option is recommended if the
6925 target hardware has a floating point unit or if a lot of floating point
6926 arithmetic is going to be performed by the code. The default is
6927 @option{-mno-apcs-float}, since integer only code is slightly increased in
6928 size if @option{-mapcs-float} is used.
6929
6930 @c not currently implemented
6931 @item -mapcs-reentrant
6932 @opindex mapcs-reentrant
6933 Generate reentrant, position independent code. The default is
6934 @option{-mno-apcs-reentrant}.
6935 @end ignore
6936
6937 @item -mthumb-interwork
6938 @opindex mthumb-interwork
6939 Generate code which supports calling between the ARM and Thumb
6940 instruction sets. Without this option the two instruction sets cannot
6941 be reliably used inside one program. The default is
6942 @option{-mno-thumb-interwork}, since slightly larger code is generated
6943 when @option{-mthumb-interwork} is specified.
6944
6945 @item -mno-sched-prolog
6946 @opindex mno-sched-prolog
6947 Prevent the reordering of instructions in the function prolog, or the
6948 merging of those instruction with the instructions in the function's
6949 body. This means that all functions will start with a recognizable set
6950 of instructions (or in fact one of a choice from a small set of
6951 different function prologues), and this information can be used to
6952 locate the start if functions inside an executable piece of code. The
6953 default is @option{-msched-prolog}.
6954
6955 @item -mhard-float
6956 @opindex mhard-float
6957 Generate output containing floating point instructions. This is the
6958 default.
6959
6960 @item -msoft-float
6961 @opindex msoft-float
6962 Generate output containing library calls for floating point.
6963 @strong{Warning:} the requisite libraries are not available for all ARM
6964 targets. Normally the facilities of the machine's usual C compiler are
6965 used, but this cannot be done directly in cross-compilation. You must make
6966 your own arrangements to provide suitable library functions for
6967 cross-compilation.
6968
6969 @option{-msoft-float} changes the calling convention in the output file;
6970 therefore, it is only useful if you compile @emph{all} of a program with
6971 this option. In particular, you need to compile @file{libgcc.a}, the
6972 library that comes with GCC, with @option{-msoft-float} in order for
6973 this to work.
6974
6975 @item -mfloat-abi=@var{name}
6976 @opindex mfloat-abi
6977 Specifies which ABI to use for floating point values. Permissible values
6978 are: @samp{soft}, @samp{softfp} and @samp{hard}.
6979
6980 @samp{soft} and @samp{hard} are equivalent to @option{-msoft-float}
6981 and @option{-mhard-float} respectively. @samp{softfp} allows the generation
6982 of floating point instructions, but still uses the soft-float calling
6983 conventions.
6984
6985 @item -mlittle-endian
6986 @opindex mlittle-endian
6987 Generate code for a processor running in little-endian mode. This is
6988 the default for all standard configurations.
6989
6990 @item -mbig-endian
6991 @opindex mbig-endian
6992 Generate code for a processor running in big-endian mode; the default is
6993 to compile code for a little-endian processor.
6994
6995 @item -mwords-little-endian
6996 @opindex mwords-little-endian
6997 This option only applies when generating code for big-endian processors.
6998 Generate code for a little-endian word order but a big-endian byte
6999 order. That is, a byte order of the form @samp{32107654}. Note: this
7000 option should only be used if you require compatibility with code for
7001 big-endian ARM processors generated by versions of the compiler prior to
7002 2.8.
7003
7004 @item -mcpu=@var{name}
7005 @opindex mcpu
7006 This specifies the name of the target ARM processor. GCC uses this name
7007 to determine what kind of instructions it can emit when generating
7008 assembly code. Permissible names are: @samp{arm2}, @samp{arm250},
7009 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
7010 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
7011 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
7012 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
7013 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
7014 @samp{arm8}, @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
7015 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
7016 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
7017 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
7018 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
7019 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
7020 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
7021 @samp{arm1176jz-s}, @samp{arm1176jzf-s}, @samp{xscale}, @samp{iwmmxt},
7022 @samp{ep9312}.
7023
7024 @itemx -mtune=@var{name}
7025 @opindex mtune
7026 This option is very similar to the @option{-mcpu=} option, except that
7027 instead of specifying the actual target processor type, and hence
7028 restricting which instructions can be used, it specifies that GCC should
7029 tune the performance of the code as if the target were of the type
7030 specified in this option, but still choosing the instructions that it
7031 will generate based on the cpu specified by a @option{-mcpu=} option.
7032 For some ARM implementations better performance can be obtained by using
7033 this option.
7034
7035 @item -march=@var{name}
7036 @opindex march
7037 This specifies the name of the target ARM architecture. GCC uses this
7038 name to determine what kind of instructions it can emit when generating
7039 assembly code. This option can be used in conjunction with or instead
7040 of the @option{-mcpu=} option. Permissible names are: @samp{armv2},
7041 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
7042 @samp{armv5}, @samp{armv5t}, @samp{armv5te}, @samp{armv6}, @samp{armv6j},
7043 @samp{iwmmxt}, @samp{ep9312}.
7044
7045 @item -mfpu=@var{name}
7046 @itemx -mfpe=@var{number}
7047 @itemx -mfp=@var{number}
7048 @opindex mfpu
7049 @opindex mfpe
7050 @opindex mfp
7051 This specifies what floating point hardware (or hardware emulation) is
7052 available on the target. Permissible names are: @samp{fpa}, @samp{fpe2},
7053 @samp{fpe3}, @samp{maverick}, @samp{vfp}. @option{-mfp} and @option{-mfpe}
7054 are synonyms for @option{-mfpu}=@samp{fpe}@var{number}, for compatibility
7055 with older versions of GCC@.
7056
7057 If @option{-msoft-float} is specified this specifies the format of
7058 floating point values.
7059
7060 @item -mstructure-size-boundary=@var{n}
7061 @opindex mstructure-size-boundary
7062 The size of all structures and unions will be rounded up to a multiple
7063 of the number of bits set by this option. Permissible values are 8, 32
7064 and 64. The default value varies for different toolchains. For the COFF
7065 targeted toolchain the default value is 8. A value of 64 is only allowed
7066 if the underlying ABI supports it.
7067
7068 Specifying the larger number can produce faster, more efficient code, but
7069 can also increase the size of the program. Different values are potentially
7070 incompatible. Code compiled with one value cannot necessarily expect to
7071 work with code or libraries compiled with another value, if they exchange
7072 information using structures or unions.
7073
7074 @item -mabort-on-noreturn
7075 @opindex mabort-on-noreturn
7076 Generate a call to the function @code{abort} at the end of a
7077 @code{noreturn} function. It will be executed if the function tries to
7078 return.
7079
7080 @item -mlong-calls
7081 @itemx -mno-long-calls
7082 @opindex mlong-calls
7083 @opindex mno-long-calls
7084 Tells the compiler to perform function calls by first loading the
7085 address of the function into a register and then performing a subroutine
7086 call on this register. This switch is needed if the target function
7087 will lie outside of the 64 megabyte addressing range of the offset based
7088 version of subroutine call instruction.
7089
7090 Even if this switch is enabled, not all function calls will be turned
7091 into long calls. The heuristic is that static functions, functions
7092 which have the @samp{short-call} attribute, functions that are inside
7093 the scope of a @samp{#pragma no_long_calls} directive and functions whose
7094 definitions have already been compiled within the current compilation
7095 unit, will not be turned into long calls. The exception to this rule is
7096 that weak function definitions, functions with the @samp{long-call}
7097 attribute or the @samp{section} attribute, and functions that are within
7098 the scope of a @samp{#pragma long_calls} directive, will always be
7099 turned into long calls.
7100
7101 This feature is not enabled by default. Specifying
7102 @option{-mno-long-calls} will restore the default behavior, as will
7103 placing the function calls within the scope of a @samp{#pragma
7104 long_calls_off} directive. Note these switches have no effect on how
7105 the compiler generates code to handle function calls via function
7106 pointers.
7107
7108 @item -mnop-fun-dllimport
7109 @opindex mnop-fun-dllimport
7110 Disable support for the @code{dllimport} attribute.
7111
7112 @item -msingle-pic-base
7113 @opindex msingle-pic-base
7114 Treat the register used for PIC addressing as read-only, rather than
7115 loading it in the prologue for each function. The run-time system is
7116 responsible for initializing this register with an appropriate value
7117 before execution begins.
7118
7119 @item -mpic-register=@var{reg}
7120 @opindex mpic-register
7121 Specify the register to be used for PIC addressing. The default is R10
7122 unless stack-checking is enabled, when R9 is used.
7123
7124 @item -mcirrus-fix-invalid-insns
7125 @opindex mcirrus-fix-invalid-insns
7126 @opindex mno-cirrus-fix-invalid-insns
7127 Insert NOPs into the instruction stream to in order to work around
7128 problems with invalid Maverick instruction combinations. This option
7129 is only valid if the @option{-mcpu=ep9312} option has been used to
7130 enable generation of instructions for the Cirrus Maverick floating
7131 point co-processor. This option is not enabled by default, since the
7132 problem is only present in older Maverick implementations. The default
7133 can be re-enabled by use of the @option{-mno-cirrus-fix-invalid-insns}
7134 switch.
7135
7136 @item -mpoke-function-name
7137 @opindex mpoke-function-name
7138 Write the name of each function into the text section, directly
7139 preceding the function prologue. The generated code is similar to this:
7140
7141 @smallexample
7142 t0
7143 .ascii "arm_poke_function_name", 0
7144 .align
7145 t1
7146 .word 0xff000000 + (t1 - t0)
7147 arm_poke_function_name
7148 mov ip, sp
7149 stmfd sp!, @{fp, ip, lr, pc@}
7150 sub fp, ip, #4
7151 @end smallexample
7152
7153 When performing a stack backtrace, code can inspect the value of
7154 @code{pc} stored at @code{fp + 0}. If the trace function then looks at
7155 location @code{pc - 12} and the top 8 bits are set, then we know that
7156 there is a function name embedded immediately preceding this location
7157 and has length @code{((pc[-3]) & 0xff000000)}.
7158
7159 @item -mthumb
7160 @opindex mthumb
7161 Generate code for the 16-bit Thumb instruction set. The default is to
7162 use the 32-bit ARM instruction set.
7163
7164 @item -mtpcs-frame
7165 @opindex mtpcs-frame
7166 Generate a stack frame that is compliant with the Thumb Procedure Call
7167 Standard for all non-leaf functions. (A leaf function is one that does
7168 not call any other functions.) The default is @option{-mno-tpcs-frame}.
7169
7170 @item -mtpcs-leaf-frame
7171 @opindex mtpcs-leaf-frame
7172 Generate a stack frame that is compliant with the Thumb Procedure Call
7173 Standard for all leaf functions. (A leaf function is one that does
7174 not call any other functions.) The default is @option{-mno-apcs-leaf-frame}.
7175
7176 @item -mcallee-super-interworking
7177 @opindex mcallee-super-interworking
7178 Gives all externally visible functions in the file being compiled an ARM
7179 instruction set header which switches to Thumb mode before executing the
7180 rest of the function. This allows these functions to be called from
7181 non-interworking code.
7182
7183 @item -mcaller-super-interworking
7184 @opindex mcaller-super-interworking
7185 Allows calls via function pointers (including virtual functions) to
7186 execute correctly regardless of whether the target code has been
7187 compiled for interworking or not. There is a small overhead in the cost
7188 of executing a function pointer if this option is enabled.
7189
7190 @end table
7191
7192 @node AVR Options
7193 @subsection AVR Options
7194 @cindex AVR Options
7195
7196 These options are defined for AVR implementations:
7197
7198 @table @gcctabopt
7199 @item -mmcu=@var{mcu}
7200 @opindex mmcu
7201 Specify ATMEL AVR instruction set or MCU type.
7202
7203 Instruction set avr1 is for the minimal AVR core, not supported by the C
7204 compiler, only for assembler programs (MCU types: at90s1200, attiny10,
7205 attiny11, attiny12, attiny15, attiny28).
7206
7207 Instruction set avr2 (default) is for the classic AVR core with up to
7208 8K program memory space (MCU types: at90s2313, at90s2323, attiny22,
7209 at90s2333, at90s2343, at90s4414, at90s4433, at90s4434, at90s8515,
7210 at90c8534, at90s8535).
7211
7212 Instruction set avr3 is for the classic AVR core with up to 128K program
7213 memory space (MCU types: atmega103, atmega603, at43usb320, at76c711).
7214
7215 Instruction set avr4 is for the enhanced AVR core with up to 8K program
7216 memory space (MCU types: atmega8, atmega83, atmega85).
7217
7218 Instruction set avr5 is for the enhanced AVR core with up to 128K program
7219 memory space (MCU types: atmega16, atmega161, atmega163, atmega32, atmega323,
7220 atmega64, atmega128, at43usb355, at94k).
7221
7222 @item -msize
7223 @opindex msize
7224 Output instruction sizes to the asm file.
7225
7226 @item -minit-stack=@var{N}
7227 @opindex minit-stack
7228 Specify the initial stack address, which may be a symbol or numeric value,
7229 @samp{__stack} is the default.
7230
7231 @item -mno-interrupts
7232 @opindex mno-interrupts
7233 Generated code is not compatible with hardware interrupts.
7234 Code size will be smaller.
7235
7236 @item -mcall-prologues
7237 @opindex mcall-prologues
7238 Functions prologues/epilogues expanded as call to appropriate
7239 subroutines. Code size will be smaller.
7240
7241 @item -mno-tablejump
7242 @opindex mno-tablejump
7243 Do not generate tablejump insns which sometimes increase code size.
7244
7245 @item -mtiny-stack
7246 @opindex mtiny-stack
7247 Change only the low 8 bits of the stack pointer.
7248
7249 @item -mint8
7250 @opindex mint8
7251 Assume int to be 8 bit integer. This affects the sizes of all types: A
7252 char will be 1 byte, an int will be 1 byte, an long will be 2 bytes
7253 and long long will be 4 bytes. Please note that this option does not
7254 comply to the C standards, but it will provide you with smaller code
7255 size.
7256 @end table
7257
7258 @node Blackfin Options
7259 @subsection Blackfin Options
7260 @cindex Blackfin Options
7261
7262 @table @gcctabopt
7263 @item -momit-leaf-frame-pointer
7264 @opindex momit-leaf-frame-pointer
7265 Don't keep the frame pointer in a register for leaf functions. This
7266 avoids the instructions to save, set up and restore frame pointers and
7267 makes an extra register available in leaf functions. The option
7268 @option{-fomit-frame-pointer} removes the frame pointer for all functions
7269 which might make debugging harder.
7270
7271 @item -mcsync
7272 @opindex mcsync
7273 When enabled, the compiler will ensure that the generated code does not
7274 contain speculative loads after jump instructions. This option is enabled
7275 by default.
7276
7277 @item -mno-csync
7278 @opindex mno-csync
7279 Don't generate extra code to prevent speculative loads from occurring.
7280
7281 @item -mlow-64k
7282 @opindex mlow-64k
7283 When enabled, the compiler is free to take advantage of the knowledge that
7284 the entire program fits into the low 64k of memory.
7285
7286 @item -mno-low-64k
7287 @opindex mno-low-64k
7288 Assume that the program is arbitrarily large. This is the default.
7289
7290 @item -mid-shared-library
7291 @opindex mid-shared-library
7292 Generate code that supports shared libraries via the library ID method.
7293 This allows for execute in place and shared libraries in an environment
7294 without virtual memory management. This option implies @option{-fPIC}.
7295
7296 @item -mno-id-shared-library
7297 @opindex mno-id-shared-library
7298 Generate code that doesn't assume ID based shared libraries are being used.
7299 This is the default.
7300
7301 @item -mshared-library-id=n
7302 @opindex mshared-library-id
7303 Specified the identification number of the ID based shared library being
7304 compiled. Specifying a value of 0 will generate more compact code, specifying
7305 other values will force the allocation of that number to the current
7306 library but is no more space or time efficient than omitting this option.
7307 @end table
7308
7309 @node CRIS Options
7310 @subsection CRIS Options
7311 @cindex CRIS Options
7312
7313 These options are defined specifically for the CRIS ports.
7314
7315 @table @gcctabopt
7316 @item -march=@var{architecture-type}
7317 @itemx -mcpu=@var{architecture-type}
7318 @opindex march
7319 @opindex mcpu
7320 Generate code for the specified architecture. The choices for
7321 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
7322 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
7323 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
7324 @samp{v10}.
7325
7326 @item -mtune=@var{architecture-type}
7327 @opindex mtune
7328 Tune to @var{architecture-type} everything applicable about the generated
7329 code, except for the ABI and the set of available instructions. The
7330 choices for @var{architecture-type} are the same as for
7331 @option{-march=@var{architecture-type}}.
7332
7333 @item -mmax-stack-frame=@var{n}
7334 @opindex mmax-stack-frame
7335 Warn when the stack frame of a function exceeds @var{n} bytes.
7336
7337 @item -melinux-stacksize=@var{n}
7338 @opindex melinux-stacksize
7339 Only available with the @samp{cris-axis-aout} target. Arranges for
7340 indications in the program to the kernel loader that the stack of the
7341 program should be set to @var{n} bytes.
7342
7343 @item -metrax4
7344 @itemx -metrax100
7345 @opindex metrax4
7346 @opindex metrax100
7347 The options @option{-metrax4} and @option{-metrax100} are synonyms for
7348 @option{-march=v3} and @option{-march=v8} respectively.
7349
7350 @item -mmul-bug-workaround
7351 @itemx -mno-mul-bug-workaround
7352 @opindex mmul-bug-workaround
7353 @opindex mno-mul-bug-workaround
7354 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
7355 models where it applies. This option is active by default.
7356
7357 @item -mpdebug
7358 @opindex mpdebug
7359 Enable CRIS-specific verbose debug-related information in the assembly
7360 code. This option also has the effect to turn off the @samp{#NO_APP}
7361 formatted-code indicator to the assembler at the beginning of the
7362 assembly file.
7363
7364 @item -mcc-init
7365 @opindex mcc-init
7366 Do not use condition-code results from previous instruction; always emit
7367 compare and test instructions before use of condition codes.
7368
7369 @item -mno-side-effects
7370 @opindex mno-side-effects
7371 Do not emit instructions with side-effects in addressing modes other than
7372 post-increment.
7373
7374 @item -mstack-align
7375 @itemx -mno-stack-align
7376 @itemx -mdata-align
7377 @itemx -mno-data-align
7378 @itemx -mconst-align
7379 @itemx -mno-const-align
7380 @opindex mstack-align
7381 @opindex mno-stack-align
7382 @opindex mdata-align
7383 @opindex mno-data-align
7384 @opindex mconst-align
7385 @opindex mno-const-align
7386 These options (no-options) arranges (eliminate arrangements) for the
7387 stack-frame, individual data and constants to be aligned for the maximum
7388 single data access size for the chosen CPU model. The default is to
7389 arrange for 32-bit alignment. ABI details such as structure layout are
7390 not affected by these options.
7391
7392 @item -m32-bit
7393 @itemx -m16-bit
7394 @itemx -m8-bit
7395 @opindex m32-bit
7396 @opindex m16-bit
7397 @opindex m8-bit
7398 Similar to the stack- data- and const-align options above, these options
7399 arrange for stack-frame, writable data and constants to all be 32-bit,
7400 16-bit or 8-bit aligned. The default is 32-bit alignment.
7401
7402 @item -mno-prologue-epilogue
7403 @itemx -mprologue-epilogue
7404 @opindex mno-prologue-epilogue
7405 @opindex mprologue-epilogue
7406 With @option{-mno-prologue-epilogue}, the normal function prologue and
7407 epilogue that sets up the stack-frame are omitted and no return
7408 instructions or return sequences are generated in the code. Use this
7409 option only together with visual inspection of the compiled code: no
7410 warnings or errors are generated when call-saved registers must be saved,
7411 or storage for local variable needs to be allocated.
7412
7413 @item -mno-gotplt
7414 @itemx -mgotplt
7415 @opindex mno-gotplt
7416 @opindex mgotplt
7417 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
7418 instruction sequences that load addresses for functions from the PLT part
7419 of the GOT rather than (traditional on other architectures) calls to the
7420 PLT@. The default is @option{-mgotplt}.
7421
7422 @item -maout
7423 @opindex maout
7424 Legacy no-op option only recognized with the cris-axis-aout target.
7425
7426 @item -melf
7427 @opindex melf
7428 Legacy no-op option only recognized with the cris-axis-elf and
7429 cris-axis-linux-gnu targets.
7430
7431 @item -melinux
7432 @opindex melinux
7433 Only recognized with the cris-axis-aout target, where it selects a
7434 GNU/linux-like multilib, include files and instruction set for
7435 @option{-march=v8}.
7436
7437 @item -mlinux
7438 @opindex mlinux
7439 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
7440
7441 @item -sim
7442 @opindex sim
7443 This option, recognized for the cris-axis-aout and cris-axis-elf arranges
7444 to link with input-output functions from a simulator library. Code,
7445 initialized data and zero-initialized data are allocated consecutively.
7446
7447 @item -sim2
7448 @opindex sim2
7449 Like @option{-sim}, but pass linker options to locate initialized data at
7450 0x40000000 and zero-initialized data at 0x80000000.
7451 @end table
7452
7453 @node Darwin Options
7454 @subsection Darwin Options
7455 @cindex Darwin options
7456
7457 These options are defined for all architectures running the Darwin operating
7458 system.
7459
7460 FSF GCC on Darwin does not create ``fat'' object files; it will create
7461 an object file for the single architecture that it was built to
7462 target. Apple's GCC on Darwin does create ``fat'' files if multiple
7463 @option{-arch} options are used; it does so by running the compiler or
7464 linker multiple times and joining the results together with
7465 @file{lipo}.
7466
7467 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
7468 @samp{i686}) is determined by the flags that specify the ISA
7469 that GCC is targetting, like @option{-mcpu} or @option{-march}. The
7470 @option{-force_cpusubtype_ALL} option can be used to override this.
7471
7472 The Darwin tools vary in their behavior when presented with an ISA
7473 mismatch. The assembler, @file{as}, will only permit instructions to
7474 be used that are valid for the subtype of the file it is generating,
7475 so you cannot put 64-bit instructions in an @samp{ppc750} object file.
7476 The linker for shared libraries, @file{/usr/bin/libtool}, will fail
7477 and print an error if asked to create a shared library with a less
7478 restrictive subtype than its input files (for instance, trying to put
7479 a @samp{ppc970} object file in a @samp{ppc7400} library). The linker
7480 for executables, @file{ld}, will quietly give the executable the most
7481 restrictive subtype of any of its input files.
7482
7483 @table @gcctabopt
7484 @item -F@var{dir}
7485 @opindex F
7486 Add the framework directory @var{dir} to the head of the list of
7487 directories to be searched for header files. These directories are
7488 interleaved with those specified by @option{-I} options and are
7489 scanned in a left-to-right order.
7490
7491 A framework directory is a directory with frameworks in it. A
7492 framework is a directory with a @samp{"Headers"} and/or
7493 @samp{"PrivateHeaders"} directory contained directly in it that ends
7494 in @samp{".framework"}. The name of a framework is the name of this
7495 directory excluding the @samp{".framework"}. Headers associated with
7496 the framework are found in one of those two directories, with
7497 @samp{"Headers"} being searched first. A subframework is a framework
7498 directory that is in a framework's @samp{"Frameworks"} directory.
7499 Includes of subframework headers can only appear in a header of a
7500 framework that contains the subframework, or in a sibling subframework
7501 header. Two subframeworks are siblings if they occur in the same
7502 framework. A subframework should not have the same name as a
7503 framework, a warning will be issued if this is violated. Currently a
7504 subframework cannot have subframeworks, in the future, the mechanism
7505 may be extended to support this. The standard frameworks can be found
7506 in @samp{"/System/Library/Frameworks"} and
7507 @samp{"/Library/Frameworks"}. An example include looks like
7508 @code{#include <Framework/header.h>}, where @samp{Framework} denotes
7509 the name of the framework and header.h is found in the
7510 @samp{"PrivateHeaders"} or @samp{"Headers"} directory.
7511
7512 @item -gused
7513 @opindex -gused
7514 Emit debugging information for symbols that are used. For STABS
7515 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
7516 This is by default ON@.
7517
7518 @item -gfull
7519 @opindex -gfull
7520 Emit debugging information for all symbols and types.
7521
7522 @item -mone-byte-bool
7523 @opindex -mone-byte-bool
7524 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
7525 By default @samp{sizeof(bool)} is @samp{4} when compiling for
7526 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
7527 option has no effect on x86.
7528
7529 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
7530 to generate code that is not binary compatible with code generated
7531 without that switch. Using this switch may require recompiling all
7532 other modules in a program, including system libraries. Use this
7533 switch to conform to a non-default data model.
7534
7535 @item -mfix-and-continue
7536 @itemx -ffix-and-continue
7537 @itemx -findirect-data
7538 @opindex mfix-and-continue
7539 @opindex ffix-and-continue
7540 @opindex findirect-data
7541 Generate code suitable for fast turn around development. Needed to
7542 enable gdb to dynamically load @code{.o} files into already running
7543 programs. @option{-findirect-data} and @option{-ffix-and-continue}
7544 are provided for backwards compatibility.
7545
7546 @item -all_load
7547 @opindex all_load
7548 Loads all members of static archive libraries.
7549 See man ld(1) for more information.
7550
7551 @item -arch_errors_fatal
7552 @opindex arch_errors_fatal
7553 Cause the errors having to do with files that have the wrong architecture
7554 to be fatal.
7555
7556 @item -bind_at_load
7557 @opindex bind_at_load
7558 Causes the output file to be marked such that the dynamic linker will
7559 bind all undefined references when the file is loaded or launched.
7560
7561 @item -bundle
7562 @opindex bundle
7563 Produce a Mach-o bundle format file.
7564 See man ld(1) for more information.
7565
7566 @item -bundle_loader @var{executable}
7567 @opindex bundle_loader
7568 This option specifies the @var{executable} that will be loading the build
7569 output file being linked. See man ld(1) for more information.
7570
7571 @item -dynamiclib
7572 @opindex -dynamiclib
7573 When passed this option, GCC will produce a dynamic library instead of
7574 an executable when linking, using the Darwin @file{libtool} command.
7575
7576 @item -force_cpusubtype_ALL
7577 @opindex -force_cpusubtype_ALL
7578 This causes GCC's output file to have the @var{ALL} subtype, instead of
7579 one controlled by the @option{-mcpu} or @option{-march} option.
7580
7581 @item -allowable_client @var{client_name}
7582 @itemx -client_name
7583 @itemx -compatibility_version
7584 @itemx -current_version
7585 @itemx -dead_strip
7586 @itemx -dependency-file
7587 @itemx -dylib_file
7588 @itemx -dylinker_install_name
7589 @itemx -dynamic
7590 @itemx -exported_symbols_list
7591 @itemx -filelist
7592 @itemx -flat_namespace
7593 @itemx -force_flat_namespace
7594 @itemx -headerpad_max_install_names
7595 @itemx -image_base
7596 @itemx -init
7597 @itemx -install_name
7598 @itemx -keep_private_externs
7599 @itemx -multi_module
7600 @itemx -multiply_defined
7601 @itemx -multiply_defined_unused
7602 @itemx -noall_load
7603 @itemx -no_dead_strip_inits_and_terms
7604 @itemx -nofixprebinding
7605 @itemx -nomultidefs
7606 @itemx -noprebind
7607 @itemx -noseglinkedit
7608 @itemx -pagezero_size
7609 @itemx -prebind
7610 @itemx -prebind_all_twolevel_modules
7611 @itemx -private_bundle
7612 @itemx -read_only_relocs
7613 @itemx -sectalign
7614 @itemx -sectobjectsymbols
7615 @itemx -whyload
7616 @itemx -seg1addr
7617 @itemx -sectcreate
7618 @itemx -sectobjectsymbols
7619 @itemx -sectorder
7620 @itemx -segaddr
7621 @itemx -segs_read_only_addr
7622 @itemx -segs_read_write_addr
7623 @itemx -seg_addr_table
7624 @itemx -seg_addr_table_filename
7625 @itemx -seglinkedit
7626 @itemx -segprot
7627 @itemx -segs_read_only_addr
7628 @itemx -segs_read_write_addr
7629 @itemx -single_module
7630 @itemx -static
7631 @itemx -sub_library
7632 @itemx -sub_umbrella
7633 @itemx -twolevel_namespace
7634 @itemx -umbrella
7635 @itemx -undefined
7636 @itemx -unexported_symbols_list
7637 @itemx -weak_reference_mismatches
7638 @itemx -whatsloaded
7639
7640 @opindex allowable_client
7641 @opindex client_name
7642 @opindex compatibility_version
7643 @opindex current_version
7644 @opindex dead_strip
7645 @opindex dependency-file
7646 @opindex dylib_file
7647 @opindex dylinker_install_name
7648 @opindex dynamic
7649 @opindex exported_symbols_list
7650 @opindex filelist
7651 @opindex flat_namespace
7652 @opindex force_flat_namespace
7653 @opindex headerpad_max_install_names
7654 @opindex image_base
7655 @opindex init
7656 @opindex install_name
7657 @opindex keep_private_externs
7658 @opindex multi_module
7659 @opindex multiply_defined
7660 @opindex multiply_defined_unused
7661 @opindex noall_load
7662 @opindex no_dead_strip_inits_and_terms
7663 @opindex nofixprebinding
7664 @opindex nomultidefs
7665 @opindex noprebind
7666 @opindex noseglinkedit
7667 @opindex pagezero_size
7668 @opindex prebind
7669 @opindex prebind_all_twolevel_modules
7670 @opindex private_bundle
7671 @opindex read_only_relocs
7672 @opindex sectalign
7673 @opindex sectobjectsymbols
7674 @opindex whyload
7675 @opindex seg1addr
7676 @opindex sectcreate
7677 @opindex sectobjectsymbols
7678 @opindex sectorder
7679 @opindex segaddr
7680 @opindex segs_read_only_addr
7681 @opindex segs_read_write_addr
7682 @opindex seg_addr_table
7683 @opindex seg_addr_table_filename
7684 @opindex seglinkedit
7685 @opindex segprot
7686 @opindex segs_read_only_addr
7687 @opindex segs_read_write_addr
7688 @opindex single_module
7689 @opindex static
7690 @opindex sub_library
7691 @opindex sub_umbrella
7692 @opindex twolevel_namespace
7693 @opindex umbrella
7694 @opindex undefined
7695 @opindex unexported_symbols_list
7696 @opindex weak_reference_mismatches
7697 @opindex whatsloaded
7698
7699 These options are passed to the Darwin linker. The Darwin linker man page
7700 describes them in detail.
7701 @end table
7702
7703 @node DEC Alpha Options
7704 @subsection DEC Alpha Options
7705
7706 These @samp{-m} options are defined for the DEC Alpha implementations:
7707
7708 @table @gcctabopt
7709 @item -mno-soft-float
7710 @itemx -msoft-float
7711 @opindex mno-soft-float
7712 @opindex msoft-float
7713 Use (do not use) the hardware floating-point instructions for
7714 floating-point operations. When @option{-msoft-float} is specified,
7715 functions in @file{libgcc.a} will be used to perform floating-point
7716 operations. Unless they are replaced by routines that emulate the
7717 floating-point operations, or compiled in such a way as to call such
7718 emulations routines, these routines will issue floating-point
7719 operations. If you are compiling for an Alpha without floating-point
7720 operations, you must ensure that the library is built so as not to call
7721 them.
7722
7723 Note that Alpha implementations without floating-point operations are
7724 required to have floating-point registers.
7725
7726 @item -mfp-reg
7727 @itemx -mno-fp-regs
7728 @opindex mfp-reg
7729 @opindex mno-fp-regs
7730 Generate code that uses (does not use) the floating-point register set.
7731 @option{-mno-fp-regs} implies @option{-msoft-float}. If the floating-point
7732 register set is not used, floating point operands are passed in integer
7733 registers as if they were integers and floating-point results are passed
7734 in @code{$0} instead of @code{$f0}. This is a non-standard calling sequence,
7735 so any function with a floating-point argument or return value called by code
7736 compiled with @option{-mno-fp-regs} must also be compiled with that
7737 option.
7738
7739 A typical use of this option is building a kernel that does not use,
7740 and hence need not save and restore, any floating-point registers.
7741
7742 @item -mieee
7743 @opindex mieee
7744 The Alpha architecture implements floating-point hardware optimized for
7745 maximum performance. It is mostly compliant with the IEEE floating
7746 point standard. However, for full compliance, software assistance is
7747 required. This option generates code fully IEEE compliant code
7748 @emph{except} that the @var{inexact-flag} is not maintained (see below).
7749 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
7750 defined during compilation. The resulting code is less efficient but is
7751 able to correctly support denormalized numbers and exceptional IEEE
7752 values such as not-a-number and plus/minus infinity. Other Alpha
7753 compilers call this option @option{-ieee_with_no_inexact}.
7754
7755 @item -mieee-with-inexact
7756 @opindex mieee-with-inexact
7757 This is like @option{-mieee} except the generated code also maintains
7758 the IEEE @var{inexact-flag}. Turning on this option causes the
7759 generated code to implement fully-compliant IEEE math. In addition to
7760 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
7761 macro. On some Alpha implementations the resulting code may execute
7762 significantly slower than the code generated by default. Since there is
7763 very little code that depends on the @var{inexact-flag}, you should
7764 normally not specify this option. Other Alpha compilers call this
7765 option @option{-ieee_with_inexact}.
7766
7767 @item -mfp-trap-mode=@var{trap-mode}
7768 @opindex mfp-trap-mode
7769 This option controls what floating-point related traps are enabled.
7770 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
7771 The trap mode can be set to one of four values:
7772
7773 @table @samp
7774 @item n
7775 This is the default (normal) setting. The only traps that are enabled
7776 are the ones that cannot be disabled in software (e.g., division by zero
7777 trap).
7778
7779 @item u
7780 In addition to the traps enabled by @samp{n}, underflow traps are enabled
7781 as well.
7782
7783 @item su
7784 Like @samp{su}, but the instructions are marked to be safe for software
7785 completion (see Alpha architecture manual for details).
7786
7787 @item sui
7788 Like @samp{su}, but inexact traps are enabled as well.
7789 @end table
7790
7791 @item -mfp-rounding-mode=@var{rounding-mode}
7792 @opindex mfp-rounding-mode
7793 Selects the IEEE rounding mode. Other Alpha compilers call this option
7794 @option{-fprm @var{rounding-mode}}. The @var{rounding-mode} can be one
7795 of:
7796
7797 @table @samp
7798 @item n
7799 Normal IEEE rounding mode. Floating point numbers are rounded towards
7800 the nearest machine number or towards the even machine number in case
7801 of a tie.
7802
7803 @item m
7804 Round towards minus infinity.
7805
7806 @item c
7807 Chopped rounding mode. Floating point numbers are rounded towards zero.
7808
7809 @item d
7810 Dynamic rounding mode. A field in the floating point control register
7811 (@var{fpcr}, see Alpha architecture reference manual) controls the
7812 rounding mode in effect. The C library initializes this register for
7813 rounding towards plus infinity. Thus, unless your program modifies the
7814 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
7815 @end table
7816
7817 @item -mtrap-precision=@var{trap-precision}
7818 @opindex mtrap-precision
7819 In the Alpha architecture, floating point traps are imprecise. This
7820 means without software assistance it is impossible to recover from a
7821 floating trap and program execution normally needs to be terminated.
7822 GCC can generate code that can assist operating system trap handlers
7823 in determining the exact location that caused a floating point trap.
7824 Depending on the requirements of an application, different levels of
7825 precisions can be selected:
7826
7827 @table @samp
7828 @item p
7829 Program precision. This option is the default and means a trap handler
7830 can only identify which program caused a floating point exception.
7831
7832 @item f
7833 Function precision. The trap handler can determine the function that
7834 caused a floating point exception.
7835
7836 @item i
7837 Instruction precision. The trap handler can determine the exact
7838 instruction that caused a floating point exception.
7839 @end table
7840
7841 Other Alpha compilers provide the equivalent options called
7842 @option{-scope_safe} and @option{-resumption_safe}.
7843
7844 @item -mieee-conformant
7845 @opindex mieee-conformant
7846 This option marks the generated code as IEEE conformant. You must not
7847 use this option unless you also specify @option{-mtrap-precision=i} and either
7848 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}. Its only effect
7849 is to emit the line @samp{.eflag 48} in the function prologue of the
7850 generated assembly file. Under DEC Unix, this has the effect that
7851 IEEE-conformant math library routines will be linked in.
7852
7853 @item -mbuild-constants
7854 @opindex mbuild-constants
7855 Normally GCC examines a 32- or 64-bit integer constant to
7856 see if it can construct it from smaller constants in two or three
7857 instructions. If it cannot, it will output the constant as a literal and
7858 generate code to load it from the data segment at runtime.
7859
7860 Use this option to require GCC to construct @emph{all} integer constants
7861 using code, even if it takes more instructions (the maximum is six).
7862
7863 You would typically use this option to build a shared library dynamic
7864 loader. Itself a shared library, it must relocate itself in memory
7865 before it can find the variables and constants in its own data segment.
7866
7867 @item -malpha-as
7868 @itemx -mgas
7869 @opindex malpha-as
7870 @opindex mgas
7871 Select whether to generate code to be assembled by the vendor-supplied
7872 assembler (@option{-malpha-as}) or by the GNU assembler @option{-mgas}.
7873
7874 @item -mbwx
7875 @itemx -mno-bwx
7876 @itemx -mcix
7877 @itemx -mno-cix
7878 @itemx -mfix
7879 @itemx -mno-fix
7880 @itemx -mmax
7881 @itemx -mno-max
7882 @opindex mbwx
7883 @opindex mno-bwx
7884 @opindex mcix
7885 @opindex mno-cix
7886 @opindex mfix
7887 @opindex mno-fix
7888 @opindex mmax
7889 @opindex mno-max
7890 Indicate whether GCC should generate code to use the optional BWX,
7891 CIX, FIX and MAX instruction sets. The default is to use the instruction
7892 sets supported by the CPU type specified via @option{-mcpu=} option or that
7893 of the CPU on which GCC was built if none was specified.
7894
7895 @item -mfloat-vax
7896 @itemx -mfloat-ieee
7897 @opindex mfloat-vax
7898 @opindex mfloat-ieee
7899 Generate code that uses (does not use) VAX F and G floating point
7900 arithmetic instead of IEEE single and double precision.
7901
7902 @item -mexplicit-relocs
7903 @itemx -mno-explicit-relocs
7904 @opindex mexplicit-relocs
7905 @opindex mno-explicit-relocs
7906 Older Alpha assemblers provided no way to generate symbol relocations
7907 except via assembler macros. Use of these macros does not allow
7908 optimal instruction scheduling. GNU binutils as of version 2.12
7909 supports a new syntax that allows the compiler to explicitly mark
7910 which relocations should apply to which instructions. This option
7911 is mostly useful for debugging, as GCC detects the capabilities of
7912 the assembler when it is built and sets the default accordingly.
7913
7914 @item -msmall-data
7915 @itemx -mlarge-data
7916 @opindex msmall-data
7917 @opindex mlarge-data
7918 When @option{-mexplicit-relocs} is in effect, static data is
7919 accessed via @dfn{gp-relative} relocations. When @option{-msmall-data}
7920 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
7921 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
7922 16-bit relocations off of the @code{$gp} register. This limits the
7923 size of the small data area to 64KB, but allows the variables to be
7924 directly accessed via a single instruction.
7925
7926 The default is @option{-mlarge-data}. With this option the data area
7927 is limited to just below 2GB@. Programs that require more than 2GB of
7928 data must use @code{malloc} or @code{mmap} to allocate the data in the
7929 heap instead of in the program's data segment.
7930
7931 When generating code for shared libraries, @option{-fpic} implies
7932 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
7933
7934 @item -msmall-text
7935 @itemx -mlarge-text
7936 @opindex msmall-text
7937 @opindex mlarge-text
7938 When @option{-msmall-text} is used, the compiler assumes that the
7939 code of the entire program (or shared library) fits in 4MB, and is
7940 thus reachable with a branch instruction. When @option{-msmall-data}
7941 is used, the compiler can assume that all local symbols share the
7942 same @code{$gp} value, and thus reduce the number of instructions
7943 required for a function call from 4 to 1.
7944
7945 The default is @option{-mlarge-text}.
7946
7947 @item -mcpu=@var{cpu_type}
7948 @opindex mcpu
7949 Set the instruction set and instruction scheduling parameters for
7950 machine type @var{cpu_type}. You can specify either the @samp{EV}
7951 style name or the corresponding chip number. GCC supports scheduling
7952 parameters for the EV4, EV5 and EV6 family of processors and will
7953 choose the default values for the instruction set from the processor
7954 you specify. If you do not specify a processor type, GCC will default
7955 to the processor on which the compiler was built.
7956
7957 Supported values for @var{cpu_type} are
7958
7959 @table @samp
7960 @item ev4
7961 @itemx ev45
7962 @itemx 21064
7963 Schedules as an EV4 and has no instruction set extensions.
7964
7965 @item ev5
7966 @itemx 21164
7967 Schedules as an EV5 and has no instruction set extensions.
7968
7969 @item ev56
7970 @itemx 21164a
7971 Schedules as an EV5 and supports the BWX extension.
7972
7973 @item pca56
7974 @itemx 21164pc
7975 @itemx 21164PC
7976 Schedules as an EV5 and supports the BWX and MAX extensions.
7977
7978 @item ev6
7979 @itemx 21264
7980 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
7981
7982 @item ev67
7983 @itemx 21264a
7984 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
7985 @end table
7986
7987 @item -mtune=@var{cpu_type}
7988 @opindex mtune
7989 Set only the instruction scheduling parameters for machine type
7990 @var{cpu_type}. The instruction set is not changed.
7991
7992 @item -mmemory-latency=@var{time}
7993 @opindex mmemory-latency
7994 Sets the latency the scheduler should assume for typical memory
7995 references as seen by the application. This number is highly
7996 dependent on the memory access patterns used by the application
7997 and the size of the external cache on the machine.
7998
7999 Valid options for @var{time} are
8000
8001 @table @samp
8002 @item @var{number}
8003 A decimal number representing clock cycles.
8004
8005 @item L1
8006 @itemx L2
8007 @itemx L3
8008 @itemx main
8009 The compiler contains estimates of the number of clock cycles for
8010 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
8011 (also called Dcache, Scache, and Bcache), as well as to main memory.
8012 Note that L3 is only valid for EV5.
8013
8014 @end table
8015 @end table
8016
8017 @node DEC Alpha/VMS Options
8018 @subsection DEC Alpha/VMS Options
8019
8020 These @samp{-m} options are defined for the DEC Alpha/VMS implementations:
8021
8022 @table @gcctabopt
8023 @item -mvms-return-codes
8024 @opindex mvms-return-codes
8025 Return VMS condition codes from main. The default is to return POSIX
8026 style condition (e.g.@ error) codes.
8027 @end table
8028
8029 @node FRV Options
8030 @subsection FRV Options
8031 @cindex FRV Options
8032
8033 @table @gcctabopt
8034 @item -mgpr-32
8035 @opindex mgpr-32
8036
8037 Only use the first 32 general purpose registers.
8038
8039 @item -mgpr-64
8040 @opindex mgpr-64
8041
8042 Use all 64 general purpose registers.
8043
8044 @item -mfpr-32
8045 @opindex mfpr-32
8046
8047 Use only the first 32 floating point registers.
8048
8049 @item -mfpr-64
8050 @opindex mfpr-64
8051
8052 Use all 64 floating point registers
8053
8054 @item -mhard-float
8055 @opindex mhard-float
8056
8057 Use hardware instructions for floating point operations.
8058
8059 @item -msoft-float
8060 @opindex msoft-float
8061
8062 Use library routines for floating point operations.
8063
8064 @item -malloc-cc
8065 @opindex malloc-cc
8066
8067 Dynamically allocate condition code registers.
8068
8069 @item -mfixed-cc
8070 @opindex mfixed-cc
8071
8072 Do not try to dynamically allocate condition code registers, only
8073 use @code{icc0} and @code{fcc0}.
8074
8075 @item -mdword
8076 @opindex mdword
8077
8078 Change ABI to use double word insns.
8079
8080 @item -mno-dword
8081 @opindex mno-dword
8082
8083 Do not use double word instructions.
8084
8085 @item -mdouble
8086 @opindex mdouble
8087
8088 Use floating point double instructions.
8089
8090 @item -mno-double
8091 @opindex mno-double
8092
8093 Do not use floating point double instructions.
8094
8095 @item -mmedia
8096 @opindex mmedia
8097
8098 Use media instructions.
8099
8100 @item -mno-media
8101 @opindex mno-media
8102
8103 Do not use media instructions.
8104
8105 @item -mmuladd
8106 @opindex mmuladd
8107
8108 Use multiply and add/subtract instructions.
8109
8110 @item -mno-muladd
8111 @opindex mno-muladd
8112
8113 Do not use multiply and add/subtract instructions.
8114
8115 @item -mfdpic
8116 @opindex mfdpic
8117
8118 Select the FDPIC ABI, that uses function descriptors to represent
8119 pointers to functions. Without any PIC/PIE-related options, it
8120 implies @option{-fPIE}. With @option{-fpic} or @option{-fpie}, it
8121 assumes GOT entries and small data are within a 12-bit range from the
8122 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
8123 are computed with 32 bits.
8124
8125 @item -minline-plt
8126 @opindex minline-plt
8127
8128 Enable inlining of PLT entries in function calls to functions that are
8129 not known to bind locally. It has no effect without @option{-mfdpic}.
8130 It's enabled by default if optimizing for speed and compiling for
8131 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
8132 optimization option such as @option{-O3} or above is present in the
8133 command line.
8134
8135 @item -mTLS
8136 @opindex TLS
8137
8138 Assume a large TLS segment when generating thread-local code.
8139
8140 @item -mtls
8141 @opindex tls
8142
8143 Do not assume a large TLS segment when generating thread-local code.
8144
8145 @item -mgprel-ro
8146 @opindex mgprel-ro
8147
8148 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
8149 that is known to be in read-only sections. It's enabled by default,
8150 except for @option{-fpic} or @option{-fpie}: even though it may help
8151 make the global offset table smaller, it trades 1 instruction for 4.
8152 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
8153 one of which may be shared by multiple symbols, and it avoids the need
8154 for a GOT entry for the referenced symbol, so it's more likely to be a
8155 win. If it is not, @option{-mno-gprel-ro} can be used to disable it.
8156
8157 @item -multilib-library-pic
8158 @opindex multilib-library-pic
8159
8160 Link with the (library, not FD) pic libraries. It's implied by
8161 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
8162 @option{-fpic} without @option{-mfdpic}. You should never have to use
8163 it explicitly.
8164
8165 @item -mlinked-fp
8166 @opindex mlinked-fp
8167
8168 Follow the EABI requirement of always creating a frame pointer whenever
8169 a stack frame is allocated. This option is enabled by default and can
8170 be disabled with @option{-mno-linked-fp}.
8171
8172 @item -mlong-calls
8173 @opindex mlong-calls
8174
8175 Use indirect addressing to call functions outside the current
8176 compilation unit. This allows the functions to be placed anywhere
8177 within the 32-bit address space.
8178
8179 @item -malign-labels
8180 @opindex malign-labels
8181
8182 Try to align labels to an 8-byte boundary by inserting nops into the
8183 previous packet. This option only has an effect when VLIW packing
8184 is enabled. It doesn't create new packets; it merely adds nops to
8185 existing ones.
8186
8187 @item -mlibrary-pic
8188 @opindex mlibrary-pic
8189
8190 Generate position-independent EABI code.
8191
8192 @item -macc-4
8193 @opindex macc-4
8194
8195 Use only the first four media accumulator registers.
8196
8197 @item -macc-8
8198 @opindex macc-8
8199
8200 Use all eight media accumulator registers.
8201
8202 @item -mpack
8203 @opindex mpack
8204
8205 Pack VLIW instructions.
8206
8207 @item -mno-pack
8208 @opindex mno-pack
8209
8210 Do not pack VLIW instructions.
8211
8212 @item -mno-eflags
8213 @opindex mno-eflags
8214
8215 Do not mark ABI switches in e_flags.
8216
8217 @item -mcond-move
8218 @opindex mcond-move
8219
8220 Enable the use of conditional-move instructions (default).
8221
8222 This switch is mainly for debugging the compiler and will likely be removed
8223 in a future version.
8224
8225 @item -mno-cond-move
8226 @opindex mno-cond-move
8227
8228 Disable the use of conditional-move instructions.
8229
8230 This switch is mainly for debugging the compiler and will likely be removed
8231 in a future version.
8232
8233 @item -mscc
8234 @opindex mscc
8235
8236 Enable the use of conditional set instructions (default).
8237
8238 This switch is mainly for debugging the compiler and will likely be removed
8239 in a future version.
8240
8241 @item -mno-scc
8242 @opindex mno-scc
8243
8244 Disable the use of conditional set instructions.
8245
8246 This switch is mainly for debugging the compiler and will likely be removed
8247 in a future version.
8248
8249 @item -mcond-exec
8250 @opindex mcond-exec
8251
8252 Enable the use of conditional execution (default).
8253
8254 This switch is mainly for debugging the compiler and will likely be removed
8255 in a future version.
8256
8257 @item -mno-cond-exec
8258 @opindex mno-cond-exec
8259
8260 Disable the use of conditional execution.
8261
8262 This switch is mainly for debugging the compiler and will likely be removed
8263 in a future version.
8264
8265 @item -mvliw-branch
8266 @opindex mvliw-branch
8267
8268 Run a pass to pack branches into VLIW instructions (default).
8269
8270 This switch is mainly for debugging the compiler and will likely be removed
8271 in a future version.
8272
8273 @item -mno-vliw-branch
8274 @opindex mno-vliw-branch
8275
8276 Do not run a pass to pack branches into VLIW instructions.
8277
8278 This switch is mainly for debugging the compiler and will likely be removed
8279 in a future version.
8280
8281 @item -mmulti-cond-exec
8282 @opindex mmulti-cond-exec
8283
8284 Enable optimization of @code{&&} and @code{||} in conditional execution
8285 (default).
8286
8287 This switch is mainly for debugging the compiler and will likely be removed
8288 in a future version.
8289
8290 @item -mno-multi-cond-exec
8291 @opindex mno-multi-cond-exec
8292
8293 Disable optimization of @code{&&} and @code{||} in conditional execution.
8294
8295 This switch is mainly for debugging the compiler and will likely be removed
8296 in a future version.
8297
8298 @item -mnested-cond-exec
8299 @opindex mnested-cond-exec
8300
8301 Enable nested conditional execution optimizations (default).
8302
8303 This switch is mainly for debugging the compiler and will likely be removed
8304 in a future version.
8305
8306 @item -mno-nested-cond-exec
8307 @opindex mno-nested-cond-exec
8308
8309 Disable nested conditional execution optimizations.
8310
8311 This switch is mainly for debugging the compiler and will likely be removed
8312 in a future version.
8313
8314 @item -mtomcat-stats
8315 @opindex mtomcat-stats
8316
8317 Cause gas to print out tomcat statistics.
8318
8319 @item -mcpu=@var{cpu}
8320 @opindex mcpu
8321
8322 Select the processor type for which to generate code. Possible values are
8323 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
8324 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
8325
8326 @end table
8327
8328 @node H8/300 Options
8329 @subsection H8/300 Options
8330
8331 These @samp{-m} options are defined for the H8/300 implementations:
8332
8333 @table @gcctabopt
8334 @item -mrelax
8335 @opindex mrelax
8336 Shorten some address references at link time, when possible; uses the
8337 linker option @option{-relax}. @xref{H8/300,, @code{ld} and the H8/300,
8338 ld, Using ld}, for a fuller description.
8339
8340 @item -mh
8341 @opindex mh
8342 Generate code for the H8/300H@.
8343
8344 @item -ms
8345 @opindex ms
8346 Generate code for the H8S@.
8347
8348 @item -mn
8349 @opindex mn
8350 Generate code for the H8S and H8/300H in the normal mode. This switch
8351 must be used either with @option{-mh} or @option{-ms}.
8352
8353 @item -ms2600
8354 @opindex ms2600
8355 Generate code for the H8S/2600. This switch must be used with @option{-ms}.
8356
8357 @item -mint32
8358 @opindex mint32
8359 Make @code{int} data 32 bits by default.
8360
8361 @item -malign-300
8362 @opindex malign-300
8363 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
8364 The default for the H8/300H and H8S is to align longs and floats on 4
8365 byte boundaries.
8366 @option{-malign-300} causes them to be aligned on 2 byte boundaries.
8367 This option has no effect on the H8/300.
8368 @end table
8369
8370 @node HPPA Options
8371 @subsection HPPA Options
8372 @cindex HPPA Options
8373
8374 These @samp{-m} options are defined for the HPPA family of computers:
8375
8376 @table @gcctabopt
8377 @item -march=@var{architecture-type}
8378 @opindex march
8379 Generate code for the specified architecture. The choices for
8380 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
8381 1.1, and @samp{2.0} for PA 2.0 processors. Refer to
8382 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
8383 architecture option for your machine. Code compiled for lower numbered
8384 architectures will run on higher numbered architectures, but not the
8385 other way around.
8386
8387 @item -mpa-risc-1-0
8388 @itemx -mpa-risc-1-1
8389 @itemx -mpa-risc-2-0
8390 @opindex mpa-risc-1-0
8391 @opindex mpa-risc-1-1
8392 @opindex mpa-risc-2-0
8393 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
8394
8395 @item -mbig-switch
8396 @opindex mbig-switch
8397 Generate code suitable for big switch tables. Use this option only if
8398 the assembler/linker complain about out of range branches within a switch
8399 table.
8400
8401 @item -mjump-in-delay
8402 @opindex mjump-in-delay
8403 Fill delay slots of function calls with unconditional jump instructions
8404 by modifying the return pointer for the function call to be the target
8405 of the conditional jump.
8406
8407 @item -mdisable-fpregs
8408 @opindex mdisable-fpregs
8409 Prevent floating point registers from being used in any manner. This is
8410 necessary for compiling kernels which perform lazy context switching of
8411 floating point registers. If you use this option and attempt to perform
8412 floating point operations, the compiler will abort.
8413
8414 @item -mdisable-indexing
8415 @opindex mdisable-indexing
8416 Prevent the compiler from using indexing address modes. This avoids some
8417 rather obscure problems when compiling MIG generated code under MACH@.
8418
8419 @item -mno-space-regs
8420 @opindex mno-space-regs
8421 Generate code that assumes the target has no space registers. This allows
8422 GCC to generate faster indirect calls and use unscaled index address modes.
8423
8424 Such code is suitable for level 0 PA systems and kernels.
8425
8426 @item -mfast-indirect-calls
8427 @opindex mfast-indirect-calls
8428 Generate code that assumes calls never cross space boundaries. This
8429 allows GCC to emit code which performs faster indirect calls.
8430
8431 This option will not work in the presence of shared libraries or nested
8432 functions.
8433
8434 @item -mfixed-range=@var{register-range}
8435 @opindex mfixed-range
8436 Generate code treating the given register range as fixed registers.
8437 A fixed register is one that the register allocator can not use. This is
8438 useful when compiling kernel code. A register range is specified as
8439 two registers separated by a dash. Multiple register ranges can be
8440 specified separated by a comma.
8441
8442 @item -mlong-load-store
8443 @opindex mlong-load-store
8444 Generate 3-instruction load and store sequences as sometimes required by
8445 the HP-UX 10 linker. This is equivalent to the @samp{+k} option to
8446 the HP compilers.
8447
8448 @item -mportable-runtime
8449 @opindex mportable-runtime
8450 Use the portable calling conventions proposed by HP for ELF systems.
8451
8452 @item -mgas
8453 @opindex mgas
8454 Enable the use of assembler directives only GAS understands.
8455
8456 @item -mschedule=@var{cpu-type}
8457 @opindex mschedule
8458 Schedule code according to the constraints for the machine type
8459 @var{cpu-type}. The choices for @var{cpu-type} are @samp{700}
8460 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}. Refer
8461 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
8462 proper scheduling option for your machine. The default scheduling is
8463 @samp{8000}.
8464
8465 @item -mlinker-opt
8466 @opindex mlinker-opt
8467 Enable the optimization pass in the HP-UX linker. Note this makes symbolic
8468 debugging impossible. It also triggers a bug in the HP-UX 8 and HP-UX 9
8469 linkers in which they give bogus error messages when linking some programs.
8470
8471 @item -msoft-float
8472 @opindex msoft-float
8473 Generate output containing library calls for floating point.
8474 @strong{Warning:} the requisite libraries are not available for all HPPA
8475 targets. Normally the facilities of the machine's usual C compiler are
8476 used, but this cannot be done directly in cross-compilation. You must make
8477 your own arrangements to provide suitable library functions for
8478 cross-compilation. The embedded target @samp{hppa1.1-*-pro}
8479 does provide software floating point support.
8480
8481 @option{-msoft-float} changes the calling convention in the output file;
8482 therefore, it is only useful if you compile @emph{all} of a program with
8483 this option. In particular, you need to compile @file{libgcc.a}, the
8484 library that comes with GCC, with @option{-msoft-float} in order for
8485 this to work.
8486
8487 @item -msio
8488 @opindex msio
8489 Generate the predefine, @code{_SIO}, for server IO@. The default is
8490 @option{-mwsio}. This generates the predefines, @code{__hp9000s700},
8491 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@. These
8492 options are available under HP-UX and HI-UX@.
8493
8494 @item -mgnu-ld
8495 @opindex gnu-ld
8496 Use GNU ld specific options. This passes @option{-shared} to ld when
8497 building a shared library. It is the default when GCC is configured,
8498 explicitly or implicitly, with the GNU linker. This option does not
8499 have any affect on which ld is called, it only changes what parameters
8500 are passed to that ld. The ld that is called is determined by the
8501 @option{--with-ld} configure option, GCC's program search path, and
8502 finally by the user's @env{PATH}. The linker used by GCC can be printed
8503 using @samp{which `gcc -print-prog-name=ld`}.
8504
8505 @item -mhp-ld
8506 @opindex hp-ld
8507 Use HP ld specific options. This passes @option{-b} to ld when building
8508 a shared library and passes @option{+Accept TypeMismatch} to ld on all
8509 links. It is the default when GCC is configured, explicitly or
8510 implicitly, with the HP linker. This option does not have any affect on
8511 which ld is called, it only changes what parameters are passed to that
8512 ld. The ld that is called is determined by the @option{--with-ld}
8513 configure option, GCC's program search path, and finally by the user's
8514 @env{PATH}. The linker used by GCC can be printed using @samp{which
8515 `gcc -print-prog-name=ld`}.
8516
8517 @item -mlong-calls
8518 @opindex mno-long-calls
8519 Generate code that uses long call sequences. This ensures that a call
8520 is always able to reach linker generated stubs. The default is to generate
8521 long calls only when the distance from the call site to the beginning
8522 of the function or translation unit, as the case may be, exceeds a
8523 predefined limit set by the branch type being used. The limits for
8524 normal calls are 7,600,000 and 240,000 bytes, respectively for the
8525 PA 2.0 and PA 1.X architectures. Sibcalls are always limited at
8526 240,000 bytes.
8527
8528 Distances are measured from the beginning of functions when using the
8529 @option{-ffunction-sections} option, or when using the @option{-mgas}
8530 and @option{-mno-portable-runtime} options together under HP-UX with
8531 the SOM linker.
8532
8533 It is normally not desirable to use this option as it will degrade
8534 performance. However, it may be useful in large applications,
8535 particularly when partial linking is used to build the application.
8536
8537 The types of long calls used depends on the capabilities of the
8538 assembler and linker, and the type of code being generated. The
8539 impact on systems that support long absolute calls, and long pic
8540 symbol-difference or pc-relative calls should be relatively small.
8541 However, an indirect call is used on 32-bit ELF systems in pic code
8542 and it is quite long.
8543
8544 @item -munix=@var{unix-std}
8545 @opindex march
8546 Generate compiler predefines and select a startfile for the specified
8547 UNIX standard. The choices for @var{unix-std} are @samp{93}, @samp{95}
8548 and @samp{98}. @samp{93} is supported on all HP-UX versions. @samp{95}
8549 is available on HP-UX 10.10 and later. @samp{98} is available on HP-UX
8550 11.11 and later. The default values are @samp{93} for HP-UX 10.00,
8551 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
8552 and later.
8553
8554 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
8555 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
8556 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
8557 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
8558 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
8559 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
8560
8561 It is @emph{important} to note that this option changes the interfaces
8562 for various library routines. It also affects the operational behavior
8563 of the C library. Thus, @emph{extreme} care is needed in using this
8564 option.
8565
8566 Library code that is intended to operate with more than one UNIX
8567 standard must test, set and restore the variable @var{__xpg4_extended_mask}
8568 as appropriate. Most GNU software doesn't provide this capability.
8569
8570 @item -nolibdld
8571 @opindex nolibdld
8572 Suppress the generation of link options to search libdld.sl when the
8573 @option{-static} option is specified on HP-UX 10 and later.
8574
8575 @item -static
8576 @opindex static
8577 The HP-UX implementation of setlocale in libc has a dependency on
8578 libdld.sl. There isn't an archive version of libdld.sl. Thus,
8579 when the @option{-static} option is specified, special link options
8580 are needed to resolve this dependency.
8581
8582 On HP-UX 10 and later, the GCC driver adds the necessary options to
8583 link with libdld.sl when the @option{-static} option is specified.
8584 This causes the resulting binary to be dynamic. On the 64-bit port,
8585 the linkers generate dynamic binaries by default in any case. The
8586 @option{-nolibdld} option can be used to prevent the GCC driver from
8587 adding these link options.
8588
8589 @item -threads
8590 @opindex threads
8591 Add support for multithreading with the @dfn{dce thread} library
8592 under HP-UX@. This option sets flags for both the preprocessor and
8593 linker.
8594 @end table
8595
8596 @node i386 and x86-64 Options
8597 @subsection Intel 386 and AMD x86-64 Options
8598 @cindex i386 Options
8599 @cindex x86-64 Options
8600 @cindex Intel 386 Options
8601 @cindex AMD x86-64 Options
8602
8603 These @samp{-m} options are defined for the i386 and x86-64 family of
8604 computers:
8605
8606 @table @gcctabopt
8607 @item -mtune=@var{cpu-type}
8608 @opindex mtune
8609 Tune to @var{cpu-type} everything applicable about the generated code, except
8610 for the ABI and the set of available instructions. The choices for
8611 @var{cpu-type} are:
8612 @table @emph
8613 @item i386
8614 Original Intel's i386 CPU@.
8615 @item i486
8616 Intel's i486 CPU@. (No scheduling is implemented for this chip.)
8617 @item i586, pentium
8618 Intel Pentium CPU with no MMX support.
8619 @item pentium-mmx
8620 Intel PentiumMMX CPU based on Pentium core with MMX instruction set support.
8621 @item i686, pentiumpro
8622 Intel PentiumPro CPU@.
8623 @item pentium2
8624 Intel Pentium2 CPU based on PentiumPro core with MMX instruction set support.
8625 @item pentium3, pentium3m
8626 Intel Pentium3 CPU based on PentiumPro core with MMX and SSE instruction set
8627 support.
8628 @item pentium-m
8629 Low power version of Intel Pentium3 CPU with MMX, SSE and SSE2 instruction set
8630 support. Used by Centrino notebooks.
8631 @item pentium4, pentium4m
8632 Intel Pentium4 CPU with MMX, SSE and SSE2 instruction set support.
8633 @item prescott
8634 Improved version of Intel Pentium4 CPU with MMX, SSE, SSE2 and SSE3 instruction
8635 set support.
8636 @item nocona
8637 Improved version of Intel Pentium4 CPU with 64-bit extensions, MMX, SSE,
8638 SSE2 and SSE3 instruction set support.
8639 @item k6
8640 AMD K6 CPU with MMX instruction set support.
8641 @item k6-2, k6-3
8642 Improved versions of AMD K6 CPU with MMX and 3dNOW! instruction set support.
8643 @item athlon, athlon-tbird
8644 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and SSE prefetch instructions
8645 support.
8646 @item athlon-4, athlon-xp, athlon-mp
8647 Improved AMD Athlon CPU with MMX, 3dNOW!, enhanced 3dNOW! and full SSE
8648 instruction set support.
8649 @item k8, opteron, athlon64, athlon-fx
8650 AMD K8 core based CPUs with x86-64 instruction set support. (This supersets
8651 MMX, SSE, SSE2, 3dNOW!, enhanced 3dNOW! and 64-bit instruction set extensions.)
8652 @item winchip-c6
8653 IDT Winchip C6 CPU, dealt in same way as i486 with additional MMX instruction
8654 set support.
8655 @item winchip2
8656 IDT Winchip2 CPU, dealt in same way as i486 with additional MMX and 3dNOW!
8657 instruction set support.
8658 @item c3
8659 Via C3 CPU with MMX and 3dNOW! instruction set support. (No scheduling is
8660 implemented for this chip.)
8661 @item c3-2
8662 Via C3-2 CPU with MMX and SSE instruction set support. (No scheduling is
8663 implemented for this chip.)
8664 @end table
8665
8666 While picking a specific @var{cpu-type} will schedule things appropriately
8667 for that particular chip, the compiler will not generate any code that
8668 does not run on the i386 without the @option{-march=@var{cpu-type}} option
8669 being used.
8670
8671 @item -march=@var{cpu-type}
8672 @opindex march
8673 Generate instructions for the machine type @var{cpu-type}. The choices
8674 for @var{cpu-type} are the same as for @option{-mtune}. Moreover,
8675 specifying @option{-march=@var{cpu-type}} implies @option{-mtune=@var{cpu-type}}.
8676
8677 @item -mcpu=@var{cpu-type}
8678 @opindex mcpu
8679 A deprecated synonym for @option{-mtune}.
8680
8681 @item -m386
8682 @itemx -m486
8683 @itemx -mpentium
8684 @itemx -mpentiumpro
8685 @opindex m386
8686 @opindex m486
8687 @opindex mpentium
8688 @opindex mpentiumpro
8689 These options are synonyms for @option{-mtune=i386}, @option{-mtune=i486},
8690 @option{-mtune=pentium}, and @option{-mtune=pentiumpro} respectively.
8691 These synonyms are deprecated.
8692
8693 @item -mfpmath=@var{unit}
8694 @opindex march
8695 Generate floating point arithmetics for selected unit @var{unit}. The choices
8696 for @var{unit} are:
8697
8698 @table @samp
8699 @item 387
8700 Use the standard 387 floating point coprocessor present majority of chips and
8701 emulated otherwise. Code compiled with this option will run almost everywhere.
8702 The temporary results are computed in 80bit precision instead of precision
8703 specified by the type resulting in slightly different results compared to most
8704 of other chips. See @option{-ffloat-store} for more detailed description.
8705
8706 This is the default choice for i386 compiler.
8707
8708 @item sse
8709 Use scalar floating point instructions present in the SSE instruction set.
8710 This instruction set is supported by Pentium3 and newer chips, in the AMD line
8711 by Athlon-4, Athlon-xp and Athlon-mp chips. The earlier version of SSE
8712 instruction set supports only single precision arithmetics, thus the double and
8713 extended precision arithmetics is still done using 387. Later version, present
8714 only in Pentium4 and the future AMD x86-64 chips supports double precision
8715 arithmetics too.
8716
8717 For the i386 compiler, you need to use @option{-march=@var{cpu-type}}, @option{-msse}
8718 or @option{-msse2} switches to enable SSE extensions and make this option
8719 effective. For the x86-64 compiler, these extensions are enabled by default.
8720
8721 The resulting code should be considerably faster in the majority of cases and avoid
8722 the numerical instability problems of 387 code, but may break some existing
8723 code that expects temporaries to be 80bit.
8724
8725 This is the default choice for the x86-64 compiler.
8726
8727 @item sse,387
8728 Attempt to utilize both instruction sets at once. This effectively double the
8729 amount of available registers and on chips with separate execution units for
8730 387 and SSE the execution resources too. Use this option with care, as it is
8731 still experimental, because the GCC register allocator does not model separate
8732 functional units well resulting in instable performance.
8733 @end table
8734
8735 @item -masm=@var{dialect}
8736 @opindex masm=@var{dialect}
8737 Output asm instructions using selected @var{dialect}. Supported choices are
8738 @samp{intel} or @samp{att} (the default one).
8739
8740 @item -mieee-fp
8741 @itemx -mno-ieee-fp
8742 @opindex mieee-fp
8743 @opindex mno-ieee-fp
8744 Control whether or not the compiler uses IEEE floating point
8745 comparisons. These handle correctly the case where the result of a
8746 comparison is unordered.
8747
8748 @item -msoft-float
8749 @opindex msoft-float
8750 Generate output containing library calls for floating point.
8751 @strong{Warning:} the requisite libraries are not part of GCC@.
8752 Normally the facilities of the machine's usual C compiler are used, but
8753 this can't be done directly in cross-compilation. You must make your
8754 own arrangements to provide suitable library functions for
8755 cross-compilation.
8756
8757 On machines where a function returns floating point results in the 80387
8758 register stack, some floating point opcodes may be emitted even if
8759 @option{-msoft-float} is used.
8760
8761 @item -mno-fp-ret-in-387
8762 @opindex mno-fp-ret-in-387
8763 Do not use the FPU registers for return values of functions.
8764
8765 The usual calling convention has functions return values of types
8766 @code{float} and @code{double} in an FPU register, even if there
8767 is no FPU@. The idea is that the operating system should emulate
8768 an FPU@.
8769
8770 The option @option{-mno-fp-ret-in-387} causes such values to be returned
8771 in ordinary CPU registers instead.
8772
8773 @item -mno-fancy-math-387
8774 @opindex mno-fancy-math-387
8775 Some 387 emulators do not support the @code{sin}, @code{cos} and
8776 @code{sqrt} instructions for the 387. Specify this option to avoid
8777 generating those instructions. This option is the default on FreeBSD,
8778 OpenBSD and NetBSD@. This option is overridden when @option{-march}
8779 indicates that the target cpu will always have an FPU and so the
8780 instruction will not need emulation. As of revision 2.6.1, these
8781 instructions are not generated unless you also use the
8782 @option{-funsafe-math-optimizations} switch.
8783
8784 @item -malign-double
8785 @itemx -mno-align-double
8786 @opindex malign-double
8787 @opindex mno-align-double
8788 Control whether GCC aligns @code{double}, @code{long double}, and
8789 @code{long long} variables on a two word boundary or a one word
8790 boundary. Aligning @code{double} variables on a two word boundary will
8791 produce code that runs somewhat faster on a @samp{Pentium} at the
8792 expense of more memory.
8793
8794 @strong{Warning:} if you use the @option{-malign-double} switch,
8795 structures containing the above types will be aligned differently than
8796 the published application binary interface specifications for the 386
8797 and will not be binary compatible with structures in code compiled
8798 without that switch.
8799
8800 @item -m96bit-long-double
8801 @itemx -m128bit-long-double
8802 @opindex m96bit-long-double
8803 @opindex m128bit-long-double
8804 These switches control the size of @code{long double} type. The i386
8805 application binary interface specifies the size to be 96 bits,
8806 so @option{-m96bit-long-double} is the default in 32 bit mode.
8807
8808 Modern architectures (Pentium and newer) would prefer @code{long double}
8809 to be aligned to an 8 or 16 byte boundary. In arrays or structures
8810 conforming to the ABI, this would not be possible. So specifying a
8811 @option{-m128bit-long-double} will align @code{long double}
8812 to a 16 byte boundary by padding the @code{long double} with an additional
8813 32 bit zero.
8814
8815 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
8816 its ABI specifies that @code{long double} is to be aligned on 16 byte boundary.
8817
8818 Notice that neither of these options enable any extra precision over the x87
8819 standard of 80 bits for a @code{long double}.
8820
8821 @strong{Warning:} if you override the default value for your target ABI, the
8822 structures and arrays containing @code{long double} variables will change
8823 their size as well as function calling convention for function taking
8824 @code{long double} will be modified. Hence they will not be binary
8825 compatible with arrays or structures in code compiled without that switch.
8826
8827
8828 @item -msvr3-shlib
8829 @itemx -mno-svr3-shlib
8830 @opindex msvr3-shlib
8831 @opindex mno-svr3-shlib
8832 Control whether GCC places uninitialized local variables into the
8833 @code{bss} or @code{data} segments. @option{-msvr3-shlib} places them
8834 into @code{bss}. These options are meaningful only on System V Release 3.
8835
8836 @item -mrtd
8837 @opindex mrtd
8838 Use a different function-calling convention, in which functions that
8839 take a fixed number of arguments return with the @code{ret} @var{num}
8840 instruction, which pops their arguments while returning. This saves one
8841 instruction in the caller since there is no need to pop the arguments
8842 there.
8843
8844 You can specify that an individual function is called with this calling
8845 sequence with the function attribute @samp{stdcall}. You can also
8846 override the @option{-mrtd} option by using the function attribute
8847 @samp{cdecl}. @xref{Function Attributes}.
8848
8849 @strong{Warning:} this calling convention is incompatible with the one
8850 normally used on Unix, so you cannot use it if you need to call
8851 libraries compiled with the Unix compiler.
8852
8853 Also, you must provide function prototypes for all functions that
8854 take variable numbers of arguments (including @code{printf});
8855 otherwise incorrect code will be generated for calls to those
8856 functions.
8857
8858 In addition, seriously incorrect code will result if you call a
8859 function with too many arguments. (Normally, extra arguments are
8860 harmlessly ignored.)
8861
8862 @item -mregparm=@var{num}
8863 @opindex mregparm
8864 Control how many registers are used to pass integer arguments. By
8865 default, no registers are used to pass arguments, and at most 3
8866 registers can be used. You can control this behavior for a specific
8867 function by using the function attribute @samp{regparm}.
8868 @xref{Function Attributes}.
8869
8870 @strong{Warning:} if you use this switch, and
8871 @var{num} is nonzero, then you must build all modules with the same
8872 value, including any libraries. This includes the system libraries and
8873 startup modules.
8874
8875 @item -mpreferred-stack-boundary=@var{num}
8876 @opindex mpreferred-stack-boundary
8877 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
8878 byte boundary. If @option{-mpreferred-stack-boundary} is not specified,
8879 the default is 4 (16 bytes or 128 bits), except when optimizing for code
8880 size (@option{-Os}), in which case the default is the minimum correct
8881 alignment (4 bytes for x86, and 8 bytes for x86-64).
8882
8883 On Pentium and PentiumPro, @code{double} and @code{long double} values
8884 should be aligned to an 8 byte boundary (see @option{-malign-double}) or
8885 suffer significant run time performance penalties. On Pentium III, the
8886 Streaming SIMD Extension (SSE) data type @code{__m128} suffers similar
8887 penalties if it is not 16 byte aligned.
8888
8889 To ensure proper alignment of this values on the stack, the stack boundary
8890 must be as aligned as that required by any value stored on the stack.
8891 Further, every function must be generated such that it keeps the stack
8892 aligned. Thus calling a function compiled with a higher preferred
8893 stack boundary from a function compiled with a lower preferred stack
8894 boundary will most likely misalign the stack. It is recommended that
8895 libraries that use callbacks always use the default setting.
8896
8897 This extra alignment does consume extra stack space, and generally
8898 increases code size. Code that is sensitive to stack space usage, such
8899 as embedded systems and operating system kernels, may want to reduce the
8900 preferred alignment to @option{-mpreferred-stack-boundary=2}.
8901
8902 @item -mmmx
8903 @itemx -mno-mmx
8904 @item -msse
8905 @itemx -mno-sse
8906 @item -msse2
8907 @itemx -mno-sse2
8908 @item -msse3
8909 @itemx -mno-sse3
8910 @item -m3dnow
8911 @itemx -mno-3dnow
8912 @opindex mmmx
8913 @opindex mno-mmx
8914 @opindex msse
8915 @opindex mno-sse
8916 @opindex m3dnow
8917 @opindex mno-3dnow
8918 These switches enable or disable the use of built-in functions that allow
8919 direct access to the MMX, SSE, SSE2, SSE3 and 3Dnow extensions of the
8920 instruction set.
8921
8922 @xref{X86 Built-in Functions}, for details of the functions enabled
8923 and disabled by these switches.
8924
8925 To have SSE/SSE2 instructions generated automatically from floating-point
8926 code, see @option{-mfpmath=sse}.
8927
8928 @item -mpush-args
8929 @itemx -mno-push-args
8930 @opindex mpush-args
8931 @opindex mno-push-args
8932 Use PUSH operations to store outgoing parameters. This method is shorter
8933 and usually equally fast as method using SUB/MOV operations and is enabled
8934 by default. In some cases disabling it may improve performance because of
8935 improved scheduling and reduced dependencies.
8936
8937 @item -maccumulate-outgoing-args
8938 @opindex maccumulate-outgoing-args
8939 If enabled, the maximum amount of space required for outgoing arguments will be
8940 computed in the function prologue. This is faster on most modern CPUs
8941 because of reduced dependencies, improved scheduling and reduced stack usage
8942 when preferred stack boundary is not equal to 2. The drawback is a notable
8943 increase in code size. This switch implies @option{-mno-push-args}.
8944
8945 @item -mthreads
8946 @opindex mthreads
8947 Support thread-safe exception handling on @samp{Mingw32}. Code that relies
8948 on thread-safe exception handling must compile and link all code with the
8949 @option{-mthreads} option. When compiling, @option{-mthreads} defines
8950 @option{-D_MT}; when linking, it links in a special thread helper library
8951 @option{-lmingwthrd} which cleans up per thread exception handling data.
8952
8953 @item -mno-align-stringops
8954 @opindex mno-align-stringops
8955 Do not align destination of inlined string operations. This switch reduces
8956 code size and improves performance in case the destination is already aligned,
8957 but GCC doesn't know about it.
8958
8959 @item -minline-all-stringops
8960 @opindex minline-all-stringops
8961 By default GCC inlines string operations only when destination is known to be
8962 aligned at least to 4 byte boundary. This enables more inlining, increase code
8963 size, but may improve performance of code that depends on fast memcpy, strlen
8964 and memset for short lengths.
8965
8966 @item -momit-leaf-frame-pointer
8967 @opindex momit-leaf-frame-pointer
8968 Don't keep the frame pointer in a register for leaf functions. This
8969 avoids the instructions to save, set up and restore frame pointers and
8970 makes an extra register available in leaf functions. The option
8971 @option{-fomit-frame-pointer} removes the frame pointer for all functions
8972 which might make debugging harder.
8973
8974 @item -mtls-direct-seg-refs
8975 @itemx -mno-tls-direct-seg-refs
8976 @opindex mtls-direct-seg-refs
8977 Controls whether TLS variables may be accessed with offsets from the
8978 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
8979 or whether the thread base pointer must be added. Whether or not this
8980 is legal depends on the operating system, and whether it maps the
8981 segment to cover the entire TLS area.
8982
8983 For systems that use GNU libc, the default is on.
8984 @end table
8985
8986 These @samp{-m} switches are supported in addition to the above
8987 on AMD x86-64 processors in 64-bit environments.
8988
8989 @table @gcctabopt
8990 @item -m32
8991 @itemx -m64
8992 @opindex m32
8993 @opindex m64
8994 Generate code for a 32-bit or 64-bit environment.
8995 The 32-bit environment sets int, long and pointer to 32 bits and
8996 generates code that runs on any i386 system.
8997 The 64-bit environment sets int to 32 bits and long and pointer
8998 to 64 bits and generates code for AMD's x86-64 architecture.
8999
9000 @item -mno-red-zone
9001 @opindex no-red-zone
9002 Do not use a so called red zone for x86-64 code. The red zone is mandated
9003 by the x86-64 ABI, it is a 128-byte area beyond the location of the
9004 stack pointer that will not be modified by signal or interrupt handlers
9005 and therefore can be used for temporary data without adjusting the stack
9006 pointer. The flag @option{-mno-red-zone} disables this red zone.
9007
9008 @item -mcmodel=small
9009 @opindex mcmodel=small
9010 Generate code for the small code model: the program and its symbols must
9011 be linked in the lower 2 GB of the address space. Pointers are 64 bits.
9012 Programs can be statically or dynamically linked. This is the default
9013 code model.
9014
9015 @item -mcmodel=kernel
9016 @opindex mcmodel=kernel
9017 Generate code for the kernel code model. The kernel runs in the
9018 negative 2 GB of the address space.
9019 This model has to be used for Linux kernel code.
9020
9021 @item -mcmodel=medium
9022 @opindex mcmodel=medium
9023 Generate code for the medium model: The program is linked in the lower 2
9024 GB of the address space but symbols can be located anywhere in the
9025 address space. Programs can be statically or dynamically linked, but
9026 building of shared libraries are not supported with the medium model.
9027
9028 @item -mcmodel=large
9029 @opindex mcmodel=large
9030 Generate code for the large model: This model makes no assumptions
9031 about addresses and sizes of sections. Currently GCC does not implement
9032 this model.
9033 @end table
9034
9035 @node IA-64 Options
9036 @subsection IA-64 Options
9037 @cindex IA-64 Options
9038
9039 These are the @samp{-m} options defined for the Intel IA-64 architecture.
9040
9041 @table @gcctabopt
9042 @item -mbig-endian
9043 @opindex mbig-endian
9044 Generate code for a big endian target. This is the default for HP-UX@.
9045
9046 @item -mlittle-endian
9047 @opindex mlittle-endian
9048 Generate code for a little endian target. This is the default for AIX5
9049 and GNU/Linux.
9050
9051 @item -mgnu-as
9052 @itemx -mno-gnu-as
9053 @opindex mgnu-as
9054 @opindex mno-gnu-as
9055 Generate (or don't) code for the GNU assembler. This is the default.
9056 @c Also, this is the default if the configure option @option{--with-gnu-as}
9057 @c is used.
9058
9059 @item -mgnu-ld
9060 @itemx -mno-gnu-ld
9061 @opindex mgnu-ld
9062 @opindex mno-gnu-ld
9063 Generate (or don't) code for the GNU linker. This is the default.
9064 @c Also, this is the default if the configure option @option{--with-gnu-ld}
9065 @c is used.
9066
9067 @item -mno-pic
9068 @opindex mno-pic
9069 Generate code that does not use a global pointer register. The result
9070 is not position independent code, and violates the IA-64 ABI@.
9071
9072 @item -mvolatile-asm-stop
9073 @itemx -mno-volatile-asm-stop
9074 @opindex mvolatile-asm-stop
9075 @opindex mno-volatile-asm-stop
9076 Generate (or don't) a stop bit immediately before and after volatile asm
9077 statements.
9078
9079 @item -mregister-names
9080 @itemx -mno-register-names
9081 @opindex mregister-names
9082 @opindex mno-register-names
9083 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
9084 the stacked registers. This may make assembler output more readable.
9085
9086 @item -mno-sdata
9087 @itemx -msdata
9088 @opindex mno-sdata
9089 @opindex msdata
9090 Disable (or enable) optimizations that use the small data section. This may
9091 be useful for working around optimizer bugs.
9092
9093 @item -mconstant-gp
9094 @opindex mconstant-gp
9095 Generate code that uses a single constant global pointer value. This is
9096 useful when compiling kernel code.
9097
9098 @item -mauto-pic
9099 @opindex mauto-pic
9100 Generate code that is self-relocatable. This implies @option{-mconstant-gp}.
9101 This is useful when compiling firmware code.
9102
9103 @item -minline-float-divide-min-latency
9104 @opindex minline-float-divide-min-latency
9105 Generate code for inline divides of floating point values
9106 using the minimum latency algorithm.
9107
9108 @item -minline-float-divide-max-throughput
9109 @opindex minline-float-divide-max-throughput
9110 Generate code for inline divides of floating point values
9111 using the maximum throughput algorithm.
9112
9113 @item -minline-int-divide-min-latency
9114 @opindex minline-int-divide-min-latency
9115 Generate code for inline divides of integer values
9116 using the minimum latency algorithm.
9117
9118 @item -minline-int-divide-max-throughput
9119 @opindex minline-int-divide-max-throughput
9120 Generate code for inline divides of integer values
9121 using the maximum throughput algorithm.
9122
9123 @item -minline-sqrt-min-latency
9124 @opindex minline-sqrt-min-latency
9125 Generate code for inline square roots
9126 using the minimum latency algorithm.
9127
9128 @item -minline-sqrt-max-throughput
9129 @opindex minline-sqrt-max-throughput
9130 Generate code for inline square roots
9131 using the maximum throughput algorithm.
9132
9133 @item -mno-dwarf2-asm
9134 @itemx -mdwarf2-asm
9135 @opindex mno-dwarf2-asm
9136 @opindex mdwarf2-asm
9137 Don't (or do) generate assembler code for the DWARF2 line number debugging
9138 info. This may be useful when not using the GNU assembler.
9139
9140 @item -mearly-stop-bits
9141 @itemx -mno-early-stop-bits
9142 @opindex mearly-stop-bits
9143 @opindex mno-early-stop-bits
9144 Allow stop bits to be placed earlier than immediately preceding the
9145 instruction that triggered the stop bit. This can improve instruction
9146 scheduling, but does not always do so.
9147
9148 @item -mfixed-range=@var{register-range}
9149 @opindex mfixed-range
9150 Generate code treating the given register range as fixed registers.
9151 A fixed register is one that the register allocator can not use. This is
9152 useful when compiling kernel code. A register range is specified as
9153 two registers separated by a dash. Multiple register ranges can be
9154 specified separated by a comma.
9155
9156 @item -mtls-size=@var{tls-size}
9157 @opindex mtls-size
9158 Specify bit size of immediate TLS offsets. Valid values are 14, 22, and
9159 64.
9160
9161 @item -mtune-arch=@var{cpu-type}
9162 @opindex mtune-arch
9163 Tune the instruction scheduling for a particular CPU, Valid values are
9164 itanium, itanium1, merced, itanium2, and mckinley.
9165
9166 @item -mt
9167 @itemx -pthread
9168 @opindex mt
9169 @opindex pthread
9170 Add support for multithreading using the POSIX threads library. This
9171 option sets flags for both the preprocessor and linker. It does
9172 not affect the thread safety of object code produced by the compiler or
9173 that of libraries supplied with it. These are HP-UX specific flags.
9174
9175 @item -milp32
9176 @itemx -mlp64
9177 @opindex milp32
9178 @opindex mlp64
9179 Generate code for a 32-bit or 64-bit environment.
9180 The 32-bit environment sets int, long and pointer to 32 bits.
9181 The 64-bit environment sets int to 32 bits and long and pointer
9182 to 64 bits. These are HP-UX specific flags.
9183
9184 @end table
9185
9186 @node M32R/D Options
9187 @subsection M32R/D Options
9188 @cindex M32R/D options
9189
9190 These @option{-m} options are defined for Renesas M32R/D architectures:
9191
9192 @table @gcctabopt
9193 @item -m32r2
9194 @opindex m32r2
9195 Generate code for the M32R/2@.
9196
9197 @item -m32rx
9198 @opindex m32rx
9199 Generate code for the M32R/X@.
9200
9201 @item -m32r
9202 @opindex m32r
9203 Generate code for the M32R@. This is the default.
9204
9205 @item -mmodel=small
9206 @opindex mmodel=small
9207 Assume all objects live in the lower 16MB of memory (so that their addresses
9208 can be loaded with the @code{ld24} instruction), and assume all subroutines
9209 are reachable with the @code{bl} instruction.
9210 This is the default.
9211
9212 The addressability of a particular object can be set with the
9213 @code{model} attribute.
9214
9215 @item -mmodel=medium
9216 @opindex mmodel=medium
9217 Assume objects may be anywhere in the 32-bit address space (the compiler
9218 will generate @code{seth/add3} instructions to load their addresses), and
9219 assume all subroutines are reachable with the @code{bl} instruction.
9220
9221 @item -mmodel=large
9222 @opindex mmodel=large
9223 Assume objects may be anywhere in the 32-bit address space (the compiler
9224 will generate @code{seth/add3} instructions to load their addresses), and
9225 assume subroutines may not be reachable with the @code{bl} instruction
9226 (the compiler will generate the much slower @code{seth/add3/jl}
9227 instruction sequence).
9228
9229 @item -msdata=none
9230 @opindex msdata=none
9231 Disable use of the small data area. Variables will be put into
9232 one of @samp{.data}, @samp{bss}, or @samp{.rodata} (unless the
9233 @code{section} attribute has been specified).
9234 This is the default.
9235
9236 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
9237 Objects may be explicitly put in the small data area with the
9238 @code{section} attribute using one of these sections.
9239
9240 @item -msdata=sdata
9241 @opindex msdata=sdata
9242 Put small global and static data in the small data area, but do not
9243 generate special code to reference them.
9244
9245 @item -msdata=use
9246 @opindex msdata=use
9247 Put small global and static data in the small data area, and generate
9248 special instructions to reference them.
9249
9250 @item -G @var{num}
9251 @opindex G
9252 @cindex smaller data references
9253 Put global and static objects less than or equal to @var{num} bytes
9254 into the small data or bss sections instead of the normal data or bss
9255 sections. The default value of @var{num} is 8.
9256 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
9257 for this option to have any effect.
9258
9259 All modules should be compiled with the same @option{-G @var{num}} value.
9260 Compiling with different values of @var{num} may or may not work; if it
9261 doesn't the linker will give an error message---incorrect code will not be
9262 generated.
9263
9264 @item -mdebug
9265 @opindex mdebug
9266 Makes the M32R specific code in the compiler display some statistics
9267 that might help in debugging programs.
9268
9269 @item -malign-loops
9270 @opindex malign-loops
9271 Align all loops to a 32-byte boundary.
9272
9273 @item -mno-align-loops
9274 @opindex mno-align-loops
9275 Do not enforce a 32-byte alignment for loops. This is the default.
9276
9277 @item -missue-rate=@var{number}
9278 @opindex missue-rate=@var{number}
9279 Issue @var{number} instructions per cycle. @var{number} can only be 1
9280 or 2.
9281
9282 @item -mbranch-cost=@var{number}
9283 @opindex mbranch-cost=@var{number}
9284 @var{number} can only be 1 or 2. If it is 1 then branches will be
9285 preferred over conditional code, if it is 2, then the opposite will
9286 apply.
9287
9288 @item -mflush-trap=@var{number}
9289 @opindex mflush-trap=@var{number}
9290 Specifies the trap number to use to flush the cache. The default is
9291 12. Valid numbers are between 0 and 15 inclusive.
9292
9293 @item -mno-flush-trap
9294 @opindex mno-flush-trap
9295 Specifies that the cache cannot be flushed by using a trap.
9296
9297 @item -mflush-func=@var{name}
9298 @opindex mflush-func=@var{name}
9299 Specifies the name of the operating system function to call to flush
9300 the cache. The default is @emph{_flush_cache}, but a function call
9301 will only be used if a trap is not available.
9302
9303 @item -mno-flush-func
9304 @opindex mno-flush-func
9305 Indicates that there is no OS function for flushing the cache.
9306
9307 @end table
9308
9309 @node M680x0 Options
9310 @subsection M680x0 Options
9311 @cindex M680x0 options
9312
9313 These are the @samp{-m} options defined for the 68000 series. The default
9314 values for these options depends on which style of 68000 was selected when
9315 the compiler was configured; the defaults for the most common choices are
9316 given below.
9317
9318 @table @gcctabopt
9319 @item -m68000
9320 @itemx -mc68000
9321 @opindex m68000
9322 @opindex mc68000
9323 Generate output for a 68000. This is the default
9324 when the compiler is configured for 68000-based systems.
9325
9326 Use this option for microcontrollers with a 68000 or EC000 core,
9327 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
9328
9329 @item -m68020
9330 @itemx -mc68020
9331 @opindex m68020
9332 @opindex mc68020
9333 Generate output for a 68020. This is the default
9334 when the compiler is configured for 68020-based systems.
9335
9336 @item -m68881
9337 @opindex m68881
9338 Generate output containing 68881 instructions for floating point.
9339 This is the default for most 68020 systems unless @option{--nfp} was
9340 specified when the compiler was configured.
9341
9342 @item -m68030
9343 @opindex m68030
9344 Generate output for a 68030. This is the default when the compiler is
9345 configured for 68030-based systems.
9346
9347 @item -m68040
9348 @opindex m68040
9349 Generate output for a 68040. This is the default when the compiler is
9350 configured for 68040-based systems.
9351
9352 This option inhibits the use of 68881/68882 instructions that have to be
9353 emulated by software on the 68040. Use this option if your 68040 does not
9354 have code to emulate those instructions.
9355
9356 @item -m68060
9357 @opindex m68060
9358 Generate output for a 68060. This is the default when the compiler is
9359 configured for 68060-based systems.
9360
9361 This option inhibits the use of 68020 and 68881/68882 instructions that
9362 have to be emulated by software on the 68060. Use this option if your 68060
9363 does not have code to emulate those instructions.
9364
9365 @item -mcpu32
9366 @opindex mcpu32
9367 Generate output for a CPU32. This is the default
9368 when the compiler is configured for CPU32-based systems.
9369
9370 Use this option for microcontrollers with a
9371 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
9372 68336, 68340, 68341, 68349 and 68360.
9373
9374 @item -m5200
9375 @opindex m5200
9376 Generate output for a 520X ``coldfire'' family cpu. This is the default
9377 when the compiler is configured for 520X-based systems.
9378
9379 Use this option for microcontroller with a 5200 core, including
9380 the MCF5202, MCF5203, MCF5204 and MCF5202.
9381
9382
9383 @item -m68020-40
9384 @opindex m68020-40
9385 Generate output for a 68040, without using any of the new instructions.
9386 This results in code which can run relatively efficiently on either a
9387 68020/68881 or a 68030 or a 68040. The generated code does use the
9388 68881 instructions that are emulated on the 68040.
9389
9390 @item -m68020-60
9391 @opindex m68020-60
9392 Generate output for a 68060, without using any of the new instructions.
9393 This results in code which can run relatively efficiently on either a
9394 68020/68881 or a 68030 or a 68040. The generated code does use the
9395 68881 instructions that are emulated on the 68060.
9396
9397 @item -msoft-float
9398 @opindex msoft-float
9399 Generate output containing library calls for floating point.
9400 @strong{Warning:} the requisite libraries are not available for all m68k
9401 targets. Normally the facilities of the machine's usual C compiler are
9402 used, but this can't be done directly in cross-compilation. You must
9403 make your own arrangements to provide suitable library functions for
9404 cross-compilation. The embedded targets @samp{m68k-*-aout} and
9405 @samp{m68k-*-coff} do provide software floating point support.
9406
9407 @item -mshort
9408 @opindex mshort
9409 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9410 Additionally, parameters passed on the stack are also aligned to a
9411 16-bit boundary even on targets whose API mandates promotion to 32-bit.
9412
9413 @item -mnobitfield
9414 @opindex mnobitfield
9415 Do not use the bit-field instructions. The @option{-m68000}, @option{-mcpu32}
9416 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
9417
9418 @item -mbitfield
9419 @opindex mbitfield
9420 Do use the bit-field instructions. The @option{-m68020} option implies
9421 @option{-mbitfield}. This is the default if you use a configuration
9422 designed for a 68020.
9423
9424 @item -mrtd
9425 @opindex mrtd
9426 Use a different function-calling convention, in which functions
9427 that take a fixed number of arguments return with the @code{rtd}
9428 instruction, which pops their arguments while returning. This
9429 saves one instruction in the caller since there is no need to pop
9430 the arguments there.
9431
9432 This calling convention is incompatible with the one normally
9433 used on Unix, so you cannot use it if you need to call libraries
9434 compiled with the Unix compiler.
9435
9436 Also, you must provide function prototypes for all functions that
9437 take variable numbers of arguments (including @code{printf});
9438 otherwise incorrect code will be generated for calls to those
9439 functions.
9440
9441 In addition, seriously incorrect code will result if you call a
9442 function with too many arguments. (Normally, extra arguments are
9443 harmlessly ignored.)
9444
9445 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
9446 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
9447
9448 @item -malign-int
9449 @itemx -mno-align-int
9450 @opindex malign-int
9451 @opindex mno-align-int
9452 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
9453 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
9454 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
9455 Aligning variables on 32-bit boundaries produces code that runs somewhat
9456 faster on processors with 32-bit busses at the expense of more memory.
9457
9458 @strong{Warning:} if you use the @option{-malign-int} switch, GCC will
9459 align structures containing the above types differently than
9460 most published application binary interface specifications for the m68k.
9461
9462 @item -mpcrel
9463 @opindex mpcrel
9464 Use the pc-relative addressing mode of the 68000 directly, instead of
9465 using a global offset table. At present, this option implies @option{-fpic},
9466 allowing at most a 16-bit offset for pc-relative addressing. @option{-fPIC} is
9467 not presently supported with @option{-mpcrel}, though this could be supported for
9468 68020 and higher processors.
9469
9470 @item -mno-strict-align
9471 @itemx -mstrict-align
9472 @opindex mno-strict-align
9473 @opindex mstrict-align
9474 Do not (do) assume that unaligned memory references will be handled by
9475 the system.
9476
9477 @item -msep-data
9478 Generate code that allows the data segment to be located in a different
9479 area of memory from the text segment. This allows for execute in place in
9480 an environment without virtual memory management. This option implies
9481 @option{-fPIC}.
9482
9483 @item -mno-sep-data
9484 Generate code that assumes that the data segment follows the text segment.
9485 This is the default.
9486
9487 @item -mid-shared-library
9488 Generate code that supports shared libraries via the library ID method.
9489 This allows for execute in place and shared libraries in an environment
9490 without virtual memory management. This option implies @option{-fPIC}.
9491
9492 @item -mno-id-shared-library
9493 Generate code that doesn't assume ID based shared libraries are being used.
9494 This is the default.
9495
9496 @item -mshared-library-id=n
9497 Specified the identification number of the ID based shared library being
9498 compiled. Specifying a value of 0 will generate more compact code, specifying
9499 other values will force the allocation of that number to the current
9500 library but is no more space or time efficient than omitting this option.
9501
9502 @end table
9503
9504 @node M68hc1x Options
9505 @subsection M68hc1x Options
9506 @cindex M68hc1x options
9507
9508 These are the @samp{-m} options defined for the 68hc11 and 68hc12
9509 microcontrollers. The default values for these options depends on
9510 which style of microcontroller was selected when the compiler was configured;
9511 the defaults for the most common choices are given below.
9512
9513 @table @gcctabopt
9514 @item -m6811
9515 @itemx -m68hc11
9516 @opindex m6811
9517 @opindex m68hc11
9518 Generate output for a 68HC11. This is the default
9519 when the compiler is configured for 68HC11-based systems.
9520
9521 @item -m6812
9522 @itemx -m68hc12
9523 @opindex m6812
9524 @opindex m68hc12
9525 Generate output for a 68HC12. This is the default
9526 when the compiler is configured for 68HC12-based systems.
9527
9528 @item -m68S12
9529 @itemx -m68hcs12
9530 @opindex m68S12
9531 @opindex m68hcs12
9532 Generate output for a 68HCS12.
9533
9534 @item -mauto-incdec
9535 @opindex mauto-incdec
9536 Enable the use of 68HC12 pre and post auto-increment and auto-decrement
9537 addressing modes.
9538
9539 @item -minmax
9540 @itemx -nominmax
9541 @opindex minmax
9542 @opindex mnominmax
9543 Enable the use of 68HC12 min and max instructions.
9544
9545 @item -mlong-calls
9546 @itemx -mno-long-calls
9547 @opindex mlong-calls
9548 @opindex mno-long-calls
9549 Treat all calls as being far away (near). If calls are assumed to be
9550 far away, the compiler will use the @code{call} instruction to
9551 call a function and the @code{rtc} instruction for returning.
9552
9553 @item -mshort
9554 @opindex mshort
9555 Consider type @code{int} to be 16 bits wide, like @code{short int}.
9556
9557 @item -msoft-reg-count=@var{count}
9558 @opindex msoft-reg-count
9559 Specify the number of pseudo-soft registers which are used for the
9560 code generation. The maximum number is 32. Using more pseudo-soft
9561 register may or may not result in better code depending on the program.
9562 The default is 4 for 68HC11 and 2 for 68HC12.
9563
9564 @end table
9565
9566 @node MCore Options
9567 @subsection MCore Options
9568 @cindex MCore options
9569
9570 These are the @samp{-m} options defined for the Motorola M*Core
9571 processors.
9572
9573 @table @gcctabopt
9574
9575 @item -mhardlit
9576 @itemx -mno-hardlit
9577 @opindex mhardlit
9578 @opindex mno-hardlit
9579 Inline constants into the code stream if it can be done in two
9580 instructions or less.
9581
9582 @item -mdiv
9583 @itemx -mno-div
9584 @opindex mdiv
9585 @opindex mno-div
9586 Use the divide instruction. (Enabled by default).
9587
9588 @item -mrelax-immediate
9589 @itemx -mno-relax-immediate
9590 @opindex mrelax-immediate
9591 @opindex mno-relax-immediate
9592 Allow arbitrary sized immediates in bit operations.
9593
9594 @item -mwide-bitfields
9595 @itemx -mno-wide-bitfields
9596 @opindex mwide-bitfields
9597 @opindex mno-wide-bitfields
9598 Always treat bit-fields as int-sized.
9599
9600 @item -m4byte-functions
9601 @itemx -mno-4byte-functions
9602 @opindex m4byte-functions
9603 @opindex mno-4byte-functions
9604 Force all functions to be aligned to a four byte boundary.
9605
9606 @item -mcallgraph-data
9607 @itemx -mno-callgraph-data
9608 @opindex mcallgraph-data
9609 @opindex mno-callgraph-data
9610 Emit callgraph information.
9611
9612 @item -mslow-bytes
9613 @itemx -mno-slow-bytes
9614 @opindex mslow-bytes
9615 @opindex mno-slow-bytes
9616 Prefer word access when reading byte quantities.
9617
9618 @item -mlittle-endian
9619 @itemx -mbig-endian
9620 @opindex mlittle-endian
9621 @opindex mbig-endian
9622 Generate code for a little endian target.
9623
9624 @item -m210
9625 @itemx -m340
9626 @opindex m210
9627 @opindex m340
9628 Generate code for the 210 processor.
9629 @end table
9630
9631 @node MIPS Options
9632 @subsection MIPS Options
9633 @cindex MIPS options
9634
9635 @table @gcctabopt
9636
9637 @item -EB
9638 @opindex EB
9639 Generate big-endian code.
9640
9641 @item -EL
9642 @opindex EL
9643 Generate little-endian code. This is the default for @samp{mips*el-*-*}
9644 configurations.
9645
9646 @item -march=@var{arch}
9647 @opindex march
9648 Generate code that will run on @var{arch}, which can be the name of a
9649 generic MIPS ISA, or the name of a particular processor.
9650 The ISA names are:
9651 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
9652 @samp{mips32}, @samp{mips32r2}, and @samp{mips64}.
9653 The processor names are:
9654 @samp{4kc}, @samp{4kp}, @samp{5kc}, @samp{20kc},
9655 @samp{m4k},
9656 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
9657 @samp{r4600}, @samp{r4650}, @samp{r6000}, @samp{r8000}, @samp{rm7000},
9658 @samp{rm9000},
9659 @samp{orion},
9660 @samp{sb1},
9661 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
9662 @samp{vr5000}, @samp{vr5400} and @samp{vr5500}.
9663 The special value @samp{from-abi} selects the
9664 most compatible architecture for the selected ABI (that is,
9665 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
9666
9667 In processor names, a final @samp{000} can be abbreviated as @samp{k}
9668 (for example, @samp{-march=r2k}). Prefixes are optional, and
9669 @samp{vr} may be written @samp{r}.
9670
9671 GCC defines two macros based on the value of this option. The first
9672 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
9673 a string. The second has the form @samp{_MIPS_ARCH_@var{foo}},
9674 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
9675 For example, @samp{-march=r2000} will set @samp{_MIPS_ARCH}
9676 to @samp{"r2000"} and define the macro @samp{_MIPS_ARCH_R2000}.
9677
9678 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
9679 above. In other words, it will have the full prefix and will not
9680 abbreviate @samp{000} as @samp{k}. In the case of @samp{from-abi},
9681 the macro names the resolved architecture (either @samp{"mips1"} or
9682 @samp{"mips3"}). It names the default architecture when no
9683 @option{-march} option is given.
9684
9685 @item -mtune=@var{arch}
9686 @opindex mtune
9687 Optimize for @var{arch}. Among other things, this option controls
9688 the way instructions are scheduled, and the perceived cost of arithmetic
9689 operations. The list of @var{arch} values is the same as for
9690 @option{-march}.
9691
9692 When this option is not used, GCC will optimize for the processor
9693 specified by @option{-march}. By using @option{-march} and
9694 @option{-mtune} together, it is possible to generate code that will
9695 run on a family of processors, but optimize the code for one
9696 particular member of that family.
9697
9698 @samp{-mtune} defines the macros @samp{_MIPS_TUNE} and
9699 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
9700 @samp{-march} ones described above.
9701
9702 @item -mips1
9703 @opindex mips1
9704 Equivalent to @samp{-march=mips1}.
9705
9706 @item -mips2
9707 @opindex mips2
9708 Equivalent to @samp{-march=mips2}.
9709
9710 @item -mips3
9711 @opindex mips3
9712 Equivalent to @samp{-march=mips3}.
9713
9714 @item -mips4
9715 @opindex mips4
9716 Equivalent to @samp{-march=mips4}.
9717
9718 @item -mips32
9719 @opindex mips32
9720 Equivalent to @samp{-march=mips32}.
9721
9722 @item -mips32r2
9723 @opindex mips32r2
9724 Equivalent to @samp{-march=mips32r2}.
9725
9726 @item -mips64
9727 @opindex mips64
9728 Equivalent to @samp{-march=mips64}.
9729
9730 @item -mips16
9731 @itemx -mno-mips16
9732 @opindex mips16
9733 @opindex mno-mips16
9734 Use (do not use) the MIPS16 ISA@.
9735
9736 @item -mabi=32
9737 @itemx -mabi=o64
9738 @itemx -mabi=n32
9739 @itemx -mabi=64
9740 @itemx -mabi=eabi
9741 @opindex mabi=32
9742 @opindex mabi=o64
9743 @opindex mabi=n32
9744 @opindex mabi=64
9745 @opindex mabi=eabi
9746 Generate code for the given ABI@.
9747
9748 Note that the EABI has a 32-bit and a 64-bit variant. GCC normally
9749 generates 64-bit code when you select a 64-bit architecture, but you
9750 can use @option{-mgp32} to get 32-bit code instead.
9751
9752 For information about the O64 ABI, see
9753 @w{@uref{http://gcc.gnu.org/projects/mipso64-abi.html}}.
9754
9755 @item -mabicalls
9756 @itemx -mno-abicalls
9757 @opindex mabicalls
9758 @opindex mno-abicalls
9759 Generate (do not generate) SVR4-style position-independent code.
9760 @option{-mabicalls} is the default for SVR4-based systems.
9761
9762 @item -mxgot
9763 @itemx -mno-xgot
9764 @opindex mxgot
9765 @opindex mno-xgot
9766 Lift (do not lift) the usual restrictions on the size of the global
9767 offset table.
9768
9769 GCC normally uses a single instruction to load values from the GOT@.
9770 While this is relatively efficient, it will only work if the GOT
9771 is smaller than about 64k. Anything larger will cause the linker
9772 to report an error such as:
9773
9774 @cindex relocation truncated to fit (MIPS)
9775 @smallexample
9776 relocation truncated to fit: R_MIPS_GOT16 foobar
9777 @end smallexample
9778
9779 If this happens, you should recompile your code with @option{-mxgot}.
9780 It should then work with very large GOTs, although it will also be
9781 less efficient, since it will take three instructions to fetch the
9782 value of a global symbol.
9783
9784 Note that some linkers can create multiple GOTs. If you have such a
9785 linker, you should only need to use @option{-mxgot} when a single object
9786 file accesses more than 64k's worth of GOT entries. Very few do.
9787
9788 These options have no effect unless GCC is generating position
9789 independent code.
9790
9791 @item -mgp32
9792 @opindex mgp32
9793 Assume that general-purpose registers are 32 bits wide.
9794
9795 @item -mgp64
9796 @opindex mgp64
9797 Assume that general-purpose registers are 64 bits wide.
9798
9799 @item -mfp32
9800 @opindex mfp32
9801 Assume that floating-point registers are 32 bits wide.
9802
9803 @item -mfp64
9804 @opindex mfp64
9805 Assume that floating-point registers are 64 bits wide.
9806
9807 @item -mhard-float
9808 @opindex mhard-float
9809 Use floating-point coprocessor instructions.
9810
9811 @item -msoft-float
9812 @opindex msoft-float
9813 Do not use floating-point coprocessor instructions. Implement
9814 floating-point calculations using library calls instead.
9815
9816 @item -msingle-float
9817 @opindex msingle-float
9818 Assume that the floating-point coprocessor only supports single-precision
9819 operations.
9820
9821 @itemx -mdouble-float
9822 @opindex mdouble-float
9823 Assume that the floating-point coprocessor supports double-precision
9824 operations. This is the default.
9825
9826 @itemx -mpaired-single
9827 @itemx -mno-paired-single
9828 @opindex mpaired-single
9829 @opindex mno-paired-single
9830 Use (do not use) paired-single floating-point instructions.
9831 @xref{MIPS Paired-Single Support}. This option can only be used
9832 when generating 64-bit code and requires hardware floating-point
9833 support to be enabled.
9834
9835 @itemx -mips3d
9836 @itemx -mno-mips3d
9837 @opindex mips3d
9838 @opindex mno-mips3d
9839 Use (do not use) the MIPS-3D ASE@. @xref{MIPS-3D Built-in Functions}.
9840 The option @option{-mips3d} implies @option{-mpaired-single}.
9841
9842 @item -mint64
9843 @opindex mint64
9844 Force @code{int} and @code{long} types to be 64 bits wide. See
9845 @option{-mlong32} for an explanation of the default and the way
9846 that the pointer size is determined.
9847
9848 This option has been deprecated and will be removed in a future release.
9849
9850 @item -mlong64
9851 @opindex mlong64
9852 Force @code{long} types to be 64 bits wide. See @option{-mlong32} for
9853 an explanation of the default and the way that the pointer size is
9854 determined.
9855
9856 @item -mlong32
9857 @opindex mlong32
9858 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
9859
9860 The default size of @code{int}s, @code{long}s and pointers depends on
9861 the ABI@. All the supported ABIs use 32-bit @code{int}s. The n64 ABI
9862 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
9863 32-bit @code{long}s. Pointers are the same size as @code{long}s,
9864 or the same size as integer registers, whichever is smaller.
9865
9866 @item -msym32
9867 @itemx -mno-sym32
9868 @opindex msym32
9869 @opindex mno-sym32
9870 Assume (do not assume) that all symbols have 32-bit values, regardless
9871 of the selected ABI@. This option is useful in combination with
9872 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
9873 to generate shorter and faster references to symbolic addresses.
9874
9875 @item -G @var{num}
9876 @opindex G
9877 @cindex smaller data references (MIPS)
9878 @cindex gp-relative references (MIPS)
9879 Put global and static items less than or equal to @var{num} bytes into
9880 the small data or bss section instead of the normal data or bss section.
9881 This allows the data to be accessed using a single instruction.
9882
9883 All modules should be compiled with the same @option{-G @var{num}}
9884 value.
9885
9886 @item -membedded-data
9887 @itemx -mno-embedded-data
9888 @opindex membedded-data
9889 @opindex mno-embedded-data
9890 Allocate variables to the read-only data section first if possible, then
9891 next in the small data section if possible, otherwise in data. This gives
9892 slightly slower code than the default, but reduces the amount of RAM required
9893 when executing, and thus may be preferred for some embedded systems.
9894
9895 @item -muninit-const-in-rodata
9896 @itemx -mno-uninit-const-in-rodata
9897 @opindex muninit-const-in-rodata
9898 @opindex mno-uninit-const-in-rodata
9899 Put uninitialized @code{const} variables in the read-only data section.
9900 This option is only meaningful in conjunction with @option{-membedded-data}.
9901
9902 @item -msplit-addresses
9903 @itemx -mno-split-addresses
9904 @opindex msplit-addresses
9905 @opindex mno-split-addresses
9906 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
9907 relocation operators. This option has been superseded by
9908 @option{-mexplicit-relocs} but is retained for backwards compatibility.
9909
9910 @item -mexplicit-relocs
9911 @itemx -mno-explicit-relocs
9912 @opindex mexplicit-relocs
9913 @opindex mno-explicit-relocs
9914 Use (do not use) assembler relocation operators when dealing with symbolic
9915 addresses. The alternative, selected by @option{-mno-explicit-relocs},
9916 is to use assembler macros instead.
9917
9918 @option{-mexplicit-relocs} is the default if GCC was configured
9919 to use an assembler that supports relocation operators.
9920
9921 @item -mcheck-zero-division
9922 @itemx -mno-check-zero-division
9923 @opindex mcheck-zero-division
9924 @opindex mno-check-zero-division
9925 Trap (do not trap) on integer division by zero. The default is
9926 @option{-mcheck-zero-division}.
9927
9928 @item -mdivide-traps
9929 @itemx -mdivide-breaks
9930 @opindex mdivide-traps
9931 @opindex mdivide-breaks
9932 MIPS systems check for division by zero by generating either a
9933 conditional trap or a break instruction. Using traps results in
9934 smaller code, but is only supported on MIPS II and later. Also, some
9935 versions of the Linux kernel have a bug that prevents trap from
9936 generating the proper signal (@code{SIGFPE}). Use @option{-mdivide-traps} to
9937 allow conditional traps on architectures that support them and
9938 @option{-mdivide-breaks} to force the use of breaks.
9939
9940 The default is usually @option{-mdivide-traps}, but this can be
9941 overridden at configure time using @option{--with-divide=breaks}.
9942 Divide-by-zero checks can be completely disabled using
9943 @option{-mno-check-zero-division}.
9944
9945 @item -mmemcpy
9946 @itemx -mno-memcpy
9947 @opindex mmemcpy
9948 @opindex mno-memcpy
9949 Force (do not force) the use of @code{memcpy()} for non-trivial block
9950 moves. The default is @option{-mno-memcpy}, which allows GCC to inline
9951 most constant-sized copies.
9952
9953 @item -mlong-calls
9954 @itemx -mno-long-calls
9955 @opindex mlong-calls
9956 @opindex mno-long-calls
9957 Disable (do not disable) use of the @code{jal} instruction. Calling
9958 functions using @code{jal} is more efficient but requires the caller
9959 and callee to be in the same 256 megabyte segment.
9960
9961 This option has no effect on abicalls code. The default is
9962 @option{-mno-long-calls}.
9963
9964 @item -mmad
9965 @itemx -mno-mad
9966 @opindex mmad
9967 @opindex mno-mad
9968 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
9969 instructions, as provided by the R4650 ISA@.
9970
9971 @item -mfused-madd
9972 @itemx -mno-fused-madd
9973 @opindex mfused-madd
9974 @opindex mno-fused-madd
9975 Enable (disable) use of the floating point multiply-accumulate
9976 instructions, when they are available. The default is
9977 @option{-mfused-madd}.
9978
9979 When multiply-accumulate instructions are used, the intermediate
9980 product is calculated to infinite precision and is not subject to
9981 the FCSR Flush to Zero bit. This may be undesirable in some
9982 circumstances.
9983
9984 @item -nocpp
9985 @opindex nocpp
9986 Tell the MIPS assembler to not run its preprocessor over user
9987 assembler files (with a @samp{.s} suffix) when assembling them.
9988
9989 @item -mfix-r4000
9990 @itemx -mno-fix-r4000
9991 @opindex mfix-r4000
9992 @opindex mno-fix-r4000
9993 Work around certain R4000 CPU errata:
9994 @itemize @minus
9995 @item
9996 A double-word or a variable shift may give an incorrect result if executed
9997 immediately after starting an integer division.
9998 @item
9999 A double-word or a variable shift may give an incorrect result if executed
10000 while an integer multiplication is in progress.
10001 @item
10002 An integer division may give an incorrect result if started in a delay slot
10003 of a taken branch or a jump.
10004 @end itemize
10005
10006 @item -mfix-r4400
10007 @itemx -mno-fix-r4400
10008 @opindex mfix-r4400
10009 @opindex mno-fix-r4400
10010 Work around certain R4400 CPU errata:
10011 @itemize @minus
10012 @item
10013 A double-word or a variable shift may give an incorrect result if executed
10014 immediately after starting an integer division.
10015 @end itemize
10016
10017 @item -mfix-vr4120
10018 @itemx -mno-fix-vr4120
10019 @opindex mfix-vr4120
10020 Work around certain VR4120 errata:
10021 @itemize @minus
10022 @item
10023 @code{dmultu} does not always produce the correct result.
10024 @item
10025 @code{div} and @code{ddiv} do not always produce the correct result if one
10026 of the operands is negative.
10027 @end itemize
10028 The workarounds for the division errata rely on special functions in
10029 @file{libgcc.a}. At present, these functions are only provided by
10030 the @code{mips64vr*-elf} configurations.
10031
10032 Other VR4120 errata require a nop to be inserted between certain pairs of
10033 instructions. These errata are handled by the assembler, not by GCC itself.
10034
10035 @item -mfix-vr4130
10036 @opindex mfix-vr4130
10037 Work around the VR4130 @code{mflo}/@code{mfhi} errata. The
10038 workarounds are implemented by the assembler rather than by GCC,
10039 although GCC will avoid using @code{mflo} and @code{mfhi} if the
10040 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
10041 instructions are available instead.
10042
10043 @item -mfix-sb1
10044 @itemx -mno-fix-sb1
10045 @opindex mfix-sb1
10046 Work around certain SB-1 CPU core errata.
10047 (This flag currently works around the SB-1 revision 2
10048 ``F1'' and ``F2'' floating point errata.)
10049
10050 @item -mflush-func=@var{func}
10051 @itemx -mno-flush-func
10052 @opindex mflush-func
10053 Specifies the function to call to flush the I and D caches, or to not
10054 call any such function. If called, the function must take the same
10055 arguments as the common @code{_flush_func()}, that is, the address of the
10056 memory range for which the cache is being flushed, the size of the
10057 memory range, and the number 3 (to flush both caches). The default
10058 depends on the target GCC was configured for, but commonly is either
10059 @samp{_flush_func} or @samp{__cpu_flush}.
10060
10061 @item -mbranch-likely
10062 @itemx -mno-branch-likely
10063 @opindex mbranch-likely
10064 @opindex mno-branch-likely
10065 Enable or disable use of Branch Likely instructions, regardless of the
10066 default for the selected architecture. By default, Branch Likely
10067 instructions may be generated if they are supported by the selected
10068 architecture. An exception is for the MIPS32 and MIPS64 architectures
10069 and processors which implement those architectures; for those, Branch
10070 Likely instructions will not be generated by default because the MIPS32
10071 and MIPS64 architectures specifically deprecate their use.
10072
10073 @item -mfp-exceptions
10074 @itemx -mno-fp-exceptions
10075 @opindex mfp-exceptions
10076 Specifies whether FP exceptions are enabled. This affects how we schedule
10077 FP instructions for some processors. The default is that FP exceptions are
10078 enabled.
10079
10080 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
10081 64-bit code, then we can use both FP pipes. Otherwise, we can only use one
10082 FP pipe.
10083
10084 @item -mvr4130-align
10085 @itemx -mno-vr4130-align
10086 @opindex mvr4130-align
10087 The VR4130 pipeline is two-way superscalar, but can only issue two
10088 instructions together if the first one is 8-byte aligned. When this
10089 option is enabled, GCC will align pairs of instructions that it
10090 thinks should execute in parallel.
10091
10092 This option only has an effect when optimizing for the VR4130.
10093 It normally makes code faster, but at the expense of making it bigger.
10094 It is enabled by default at optimization level @option{-O3}.
10095 @end table
10096
10097 @node MMIX Options
10098 @subsection MMIX Options
10099 @cindex MMIX Options
10100
10101 These options are defined for the MMIX:
10102
10103 @table @gcctabopt
10104 @item -mlibfuncs
10105 @itemx -mno-libfuncs
10106 @opindex mlibfuncs
10107 @opindex mno-libfuncs
10108 Specify that intrinsic library functions are being compiled, passing all
10109 values in registers, no matter the size.
10110
10111 @item -mepsilon
10112 @itemx -mno-epsilon
10113 @opindex mepsilon
10114 @opindex mno-epsilon
10115 Generate floating-point comparison instructions that compare with respect
10116 to the @code{rE} epsilon register.
10117
10118 @item -mabi=mmixware
10119 @itemx -mabi=gnu
10120 @opindex mabi-mmixware
10121 @opindex mabi=gnu
10122 Generate code that passes function parameters and return values that (in
10123 the called function) are seen as registers @code{$0} and up, as opposed to
10124 the GNU ABI which uses global registers @code{$231} and up.
10125
10126 @item -mzero-extend
10127 @itemx -mno-zero-extend
10128 @opindex mzero-extend
10129 @opindex mno-zero-extend
10130 When reading data from memory in sizes shorter than 64 bits, use (do not
10131 use) zero-extending load instructions by default, rather than
10132 sign-extending ones.
10133
10134 @item -mknuthdiv
10135 @itemx -mno-knuthdiv
10136 @opindex mknuthdiv
10137 @opindex mno-knuthdiv
10138 Make the result of a division yielding a remainder have the same sign as
10139 the divisor. With the default, @option{-mno-knuthdiv}, the sign of the
10140 remainder follows the sign of the dividend. Both methods are
10141 arithmetically valid, the latter being almost exclusively used.
10142
10143 @item -mtoplevel-symbols
10144 @itemx -mno-toplevel-symbols
10145 @opindex mtoplevel-symbols
10146 @opindex mno-toplevel-symbols
10147 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
10148 code can be used with the @code{PREFIX} assembly directive.
10149
10150 @item -melf
10151 @opindex melf
10152 Generate an executable in the ELF format, rather than the default
10153 @samp{mmo} format used by the @command{mmix} simulator.
10154
10155 @item -mbranch-predict
10156 @itemx -mno-branch-predict
10157 @opindex mbranch-predict
10158 @opindex mno-branch-predict
10159 Use (do not use) the probable-branch instructions, when static branch
10160 prediction indicates a probable branch.
10161
10162 @item -mbase-addresses
10163 @itemx -mno-base-addresses
10164 @opindex mbase-addresses
10165 @opindex mno-base-addresses
10166 Generate (do not generate) code that uses @emph{base addresses}. Using a
10167 base address automatically generates a request (handled by the assembler
10168 and the linker) for a constant to be set up in a global register. The
10169 register is used for one or more base address requests within the range 0
10170 to 255 from the value held in the register. The generally leads to short
10171 and fast code, but the number of different data items that can be
10172 addressed is limited. This means that a program that uses lots of static
10173 data may require @option{-mno-base-addresses}.
10174
10175 @item -msingle-exit
10176 @itemx -mno-single-exit
10177 @opindex msingle-exit
10178 @opindex mno-single-exit
10179 Force (do not force) generated code to have a single exit point in each
10180 function.
10181 @end table
10182
10183 @node MN10300 Options
10184 @subsection MN10300 Options
10185 @cindex MN10300 options
10186
10187 These @option{-m} options are defined for Matsushita MN10300 architectures:
10188
10189 @table @gcctabopt
10190 @item -mmult-bug
10191 @opindex mmult-bug
10192 Generate code to avoid bugs in the multiply instructions for the MN10300
10193 processors. This is the default.
10194
10195 @item -mno-mult-bug
10196 @opindex mno-mult-bug
10197 Do not generate code to avoid bugs in the multiply instructions for the
10198 MN10300 processors.
10199
10200 @item -mam33
10201 @opindex mam33
10202 Generate code which uses features specific to the AM33 processor.
10203
10204 @item -mno-am33
10205 @opindex mno-am33
10206 Do not generate code which uses features specific to the AM33 processor. This
10207 is the default.
10208
10209 @item -mno-crt0
10210 @opindex mno-crt0
10211 Do not link in the C run-time initialization object file.
10212
10213 @item -mrelax
10214 @opindex mrelax
10215 Indicate to the linker that it should perform a relaxation optimization pass
10216 to shorten branches, calls and absolute memory addresses. This option only
10217 has an effect when used on the command line for the final link step.
10218
10219 This option makes symbolic debugging impossible.
10220 @end table
10221
10222 @node NS32K Options
10223 @subsection NS32K Options
10224 @cindex NS32K options
10225
10226 These are the @samp{-m} options defined for the 32000 series. The default
10227 values for these options depends on which style of 32000 was selected when
10228 the compiler was configured; the defaults for the most common choices are
10229 given below.
10230
10231 @table @gcctabopt
10232 @item -m32032
10233 @itemx -m32032
10234 @opindex m32032
10235 @opindex m32032
10236 Generate output for a 32032. This is the default
10237 when the compiler is configured for 32032 and 32016 based systems.
10238
10239 @item -m32332
10240 @itemx -m32332
10241 @opindex m32332
10242 @opindex m32332
10243 Generate output for a 32332. This is the default
10244 when the compiler is configured for 32332-based systems.
10245
10246 @item -m32532
10247 @itemx -m32532
10248 @opindex m32532
10249 @opindex m32532
10250 Generate output for a 32532. This is the default
10251 when the compiler is configured for 32532-based systems.
10252
10253 @item -m32081
10254 @opindex m32081
10255 Generate output containing 32081 instructions for floating point.
10256 This is the default for all systems.
10257
10258 @item -m32381
10259 @opindex m32381
10260 Generate output containing 32381 instructions for floating point. This
10261 also implies @option{-m32081}. The 32381 is only compatible with the 32332
10262 and 32532 cpus. This is the default for the pc532-netbsd configuration.
10263
10264 @item -mmulti-add
10265 @opindex mmulti-add
10266 Try and generate multiply-add floating point instructions @code{polyF}
10267 and @code{dotF}. This option is only available if the @option{-m32381}
10268 option is in effect. Using these instructions requires changes to
10269 register allocation which generally has a negative impact on
10270 performance. This option should only be enabled when compiling code
10271 particularly likely to make heavy use of multiply-add instructions.
10272
10273 @item -mnomulti-add
10274 @opindex mnomulti-add
10275 Do not try and generate multiply-add floating point instructions
10276 @code{polyF} and @code{dotF}. This is the default on all platforms.
10277
10278 @item -msoft-float
10279 @opindex msoft-float
10280 Generate output containing library calls for floating point.
10281 @strong{Warning:} the requisite libraries may not be available.
10282
10283 @item -mieee-compare
10284 @itemx -mno-ieee-compare
10285 @opindex mieee-compare
10286 @opindex mno-ieee-compare
10287 Control whether or not the compiler uses IEEE floating point
10288 comparisons. These handle correctly the case where the result of a
10289 comparison is unordered.
10290 @strong{Warning:} the requisite kernel support may not be available.
10291
10292 @item -mnobitfield
10293 @opindex mnobitfield
10294 Do not use the bit-field instructions. On some machines it is faster to
10295 use shifting and masking operations. This is the default for the pc532.
10296
10297 @item -mbitfield
10298 @opindex mbitfield
10299 Do use the bit-field instructions. This is the default for all platforms
10300 except the pc532.
10301
10302 @item -mrtd
10303 @opindex mrtd
10304 Use a different function-calling convention, in which functions
10305 that take a fixed number of arguments return pop their
10306 arguments on return with the @code{ret} instruction.
10307
10308 This calling convention is incompatible with the one normally
10309 used on Unix, so you cannot use it if you need to call libraries
10310 compiled with the Unix compiler.
10311
10312 Also, you must provide function prototypes for all functions that
10313 take variable numbers of arguments (including @code{printf});
10314 otherwise incorrect code will be generated for calls to those
10315 functions.
10316
10317 In addition, seriously incorrect code will result if you call a
10318 function with too many arguments. (Normally, extra arguments are
10319 harmlessly ignored.)
10320
10321 This option takes its name from the 680x0 @code{rtd} instruction.
10322
10323
10324 @item -mregparam
10325 @opindex mregparam
10326 Use a different function-calling convention where the first two arguments
10327 are passed in registers.
10328
10329 This calling convention is incompatible with the one normally
10330 used on Unix, so you cannot use it if you need to call libraries
10331 compiled with the Unix compiler.
10332
10333 @item -mnoregparam
10334 @opindex mnoregparam
10335 Do not pass any arguments in registers. This is the default for all
10336 targets.
10337
10338 @item -msb
10339 @opindex msb
10340 It is OK to use the sb as an index register which is always loaded with
10341 zero. This is the default for the pc532-netbsd target.
10342
10343 @item -mnosb
10344 @opindex mnosb
10345 The sb register is not available for use or has not been initialized to
10346 zero by the run time system. This is the default for all targets except
10347 the pc532-netbsd. It is also implied whenever @option{-mhimem} or
10348 @option{-fpic} is set.
10349
10350 @item -mhimem
10351 @opindex mhimem
10352 Many ns32000 series addressing modes use displacements of up to 512MB@.
10353 If an address is above 512MB then displacements from zero can not be used.
10354 This option causes code to be generated which can be loaded above 512MB@.
10355 This may be useful for operating systems or ROM code.
10356
10357 @item -mnohimem
10358 @opindex mnohimem
10359 Assume code will be loaded in the first 512MB of virtual address space.
10360 This is the default for all platforms.
10361
10362 @end table
10363
10364 @node PDP-11 Options
10365 @subsection PDP-11 Options
10366 @cindex PDP-11 Options
10367
10368 These options are defined for the PDP-11:
10369
10370 @table @gcctabopt
10371 @item -mfpu
10372 @opindex mfpu
10373 Use hardware FPP floating point. This is the default. (FIS floating
10374 point on the PDP-11/40 is not supported.)
10375
10376 @item -msoft-float
10377 @opindex msoft-float
10378 Do not use hardware floating point.
10379
10380 @item -mac0
10381 @opindex mac0
10382 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
10383
10384 @item -mno-ac0
10385 @opindex mno-ac0
10386 Return floating-point results in memory. This is the default.
10387
10388 @item -m40
10389 @opindex m40
10390 Generate code for a PDP-11/40.
10391
10392 @item -m45
10393 @opindex m45
10394 Generate code for a PDP-11/45. This is the default.
10395
10396 @item -m10
10397 @opindex m10
10398 Generate code for a PDP-11/10.
10399
10400 @item -mbcopy-builtin
10401 @opindex bcopy-builtin
10402 Use inline @code{movmemhi} patterns for copying memory. This is the
10403 default.
10404
10405 @item -mbcopy
10406 @opindex mbcopy
10407 Do not use inline @code{movmemhi} patterns for copying memory.
10408
10409 @item -mint16
10410 @itemx -mno-int32
10411 @opindex mint16
10412 @opindex mno-int32
10413 Use 16-bit @code{int}. This is the default.
10414
10415 @item -mint32
10416 @itemx -mno-int16
10417 @opindex mint32
10418 @opindex mno-int16
10419 Use 32-bit @code{int}.
10420
10421 @item -mfloat64
10422 @itemx -mno-float32
10423 @opindex mfloat64
10424 @opindex mno-float32
10425 Use 64-bit @code{float}. This is the default.
10426
10427 @item -mfloat32
10428 @itemx -mno-float64
10429 @opindex mfloat32
10430 @opindex mno-float64
10431 Use 32-bit @code{float}.
10432
10433 @item -mabshi
10434 @opindex mabshi
10435 Use @code{abshi2} pattern. This is the default.
10436
10437 @item -mno-abshi
10438 @opindex mno-abshi
10439 Do not use @code{abshi2} pattern.
10440
10441 @item -mbranch-expensive
10442 @opindex mbranch-expensive
10443 Pretend that branches are expensive. This is for experimenting with
10444 code generation only.
10445
10446 @item -mbranch-cheap
10447 @opindex mbranch-cheap
10448 Do not pretend that branches are expensive. This is the default.
10449
10450 @item -msplit
10451 @opindex msplit
10452 Generate code for a system with split I&D@.
10453
10454 @item -mno-split
10455 @opindex mno-split
10456 Generate code for a system without split I&D@. This is the default.
10457
10458 @item -munix-asm
10459 @opindex munix-asm
10460 Use Unix assembler syntax. This is the default when configured for
10461 @samp{pdp11-*-bsd}.
10462
10463 @item -mdec-asm
10464 @opindex mdec-asm
10465 Use DEC assembler syntax. This is the default when configured for any
10466 PDP-11 target other than @samp{pdp11-*-bsd}.
10467 @end table
10468
10469 @node PowerPC Options
10470 @subsection PowerPC Options
10471 @cindex PowerPC options
10472
10473 These are listed under @xref{RS/6000 and PowerPC Options}.
10474
10475 @node RS/6000 and PowerPC Options
10476 @subsection IBM RS/6000 and PowerPC Options
10477 @cindex RS/6000 and PowerPC Options
10478 @cindex IBM RS/6000 and PowerPC Options
10479
10480 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
10481 @table @gcctabopt
10482 @item -mpower
10483 @itemx -mno-power
10484 @itemx -mpower2
10485 @itemx -mno-power2
10486 @itemx -mpowerpc
10487 @itemx -mno-powerpc
10488 @itemx -mpowerpc-gpopt
10489 @itemx -mno-powerpc-gpopt
10490 @itemx -mpowerpc-gfxopt
10491 @itemx -mno-powerpc-gfxopt
10492 @itemx -mpowerpc64
10493 @itemx -mno-powerpc64
10494 @opindex mpower
10495 @opindex mno-power
10496 @opindex mpower2
10497 @opindex mno-power2
10498 @opindex mpowerpc
10499 @opindex mno-powerpc
10500 @opindex mpowerpc-gpopt
10501 @opindex mno-powerpc-gpopt
10502 @opindex mpowerpc-gfxopt
10503 @opindex mno-powerpc-gfxopt
10504 @opindex mpowerpc64
10505 @opindex mno-powerpc64
10506 GCC supports two related instruction set architectures for the
10507 RS/6000 and PowerPC@. The @dfn{POWER} instruction set are those
10508 instructions supported by the @samp{rios} chip set used in the original
10509 RS/6000 systems and the @dfn{PowerPC} instruction set is the
10510 architecture of the Motorola MPC5xx, MPC6xx, MPC8xx microprocessors, and
10511 the IBM 4xx microprocessors.
10512
10513 Neither architecture is a subset of the other. However there is a
10514 large common subset of instructions supported by both. An MQ
10515 register is included in processors supporting the POWER architecture.
10516
10517 You use these options to specify which instructions are available on the
10518 processor you are using. The default value of these options is
10519 determined when configuring GCC@. Specifying the
10520 @option{-mcpu=@var{cpu_type}} overrides the specification of these
10521 options. We recommend you use the @option{-mcpu=@var{cpu_type}} option
10522 rather than the options listed above.
10523
10524 The @option{-mpower} option allows GCC to generate instructions that
10525 are found only in the POWER architecture and to use the MQ register.
10526 Specifying @option{-mpower2} implies @option{-power} and also allows GCC
10527 to generate instructions that are present in the POWER2 architecture but
10528 not the original POWER architecture.
10529
10530 The @option{-mpowerpc} option allows GCC to generate instructions that
10531 are found only in the 32-bit subset of the PowerPC architecture.
10532 Specifying @option{-mpowerpc-gpopt} implies @option{-mpowerpc} and also allows
10533 GCC to use the optional PowerPC architecture instructions in the
10534 General Purpose group, including floating-point square root. Specifying
10535 @option{-mpowerpc-gfxopt} implies @option{-mpowerpc} and also allows GCC to
10536 use the optional PowerPC architecture instructions in the Graphics
10537 group, including floating-point select.
10538
10539 The @option{-mpowerpc64} option allows GCC to generate the additional
10540 64-bit instructions that are found in the full PowerPC64 architecture
10541 and to treat GPRs as 64-bit, doubleword quantities. GCC defaults to
10542 @option{-mno-powerpc64}.
10543
10544 If you specify both @option{-mno-power} and @option{-mno-powerpc}, GCC
10545 will use only the instructions in the common subset of both
10546 architectures plus some special AIX common-mode calls, and will not use
10547 the MQ register. Specifying both @option{-mpower} and @option{-mpowerpc}
10548 permits GCC to use any instruction from either architecture and to
10549 allow use of the MQ register; specify this for the Motorola MPC601.
10550
10551 @item -mnew-mnemonics
10552 @itemx -mold-mnemonics
10553 @opindex mnew-mnemonics
10554 @opindex mold-mnemonics
10555 Select which mnemonics to use in the generated assembler code. With
10556 @option{-mnew-mnemonics}, GCC uses the assembler mnemonics defined for
10557 the PowerPC architecture. With @option{-mold-mnemonics} it uses the
10558 assembler mnemonics defined for the POWER architecture. Instructions
10559 defined in only one architecture have only one mnemonic; GCC uses that
10560 mnemonic irrespective of which of these options is specified.
10561
10562 GCC defaults to the mnemonics appropriate for the architecture in
10563 use. Specifying @option{-mcpu=@var{cpu_type}} sometimes overrides the
10564 value of these option. Unless you are building a cross-compiler, you
10565 should normally not specify either @option{-mnew-mnemonics} or
10566 @option{-mold-mnemonics}, but should instead accept the default.
10567
10568 @item -mcpu=@var{cpu_type}
10569 @opindex mcpu
10570 Set architecture type, register usage, choice of mnemonics, and
10571 instruction scheduling parameters for machine type @var{cpu_type}.
10572 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
10573 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{505},
10574 @samp{601}, @samp{602}, @samp{603}, @samp{603e}, @samp{604},
10575 @samp{604e}, @samp{620}, @samp{630}, @samp{740}, @samp{7400},
10576 @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
10577 @samp{860}, @samp{970}, @samp{8540}, @samp{common}, @samp{ec603e}, @samp{G3},
10578 @samp{G4}, @samp{G5}, @samp{power}, @samp{power2}, @samp{power3},
10579 @samp{power4}, @samp{power5}, @samp{powerpc}, @samp{powerpc64},
10580 @samp{rios}, @samp{rios1}, @samp{rios2}, @samp{rsc}, and @samp{rs64}.
10581
10582 @option{-mcpu=common} selects a completely generic processor. Code
10583 generated under this option will run on any POWER or PowerPC processor.
10584 GCC will use only the instructions in the common subset of both
10585 architectures, and will not use the MQ register. GCC assumes a generic
10586 processor model for scheduling purposes.
10587
10588 @option{-mcpu=power}, @option{-mcpu=power2}, @option{-mcpu=powerpc}, and
10589 @option{-mcpu=powerpc64} specify generic POWER, POWER2, pure 32-bit
10590 PowerPC (i.e., not MPC601), and 64-bit PowerPC architecture machine
10591 types, with an appropriate, generic processor model assumed for
10592 scheduling purposes.
10593
10594 The other options specify a specific processor. Code generated under
10595 those options will run best on that processor, and may not run at all on
10596 others.
10597
10598 The @option{-mcpu} options automatically enable or disable the
10599 following options: @option{-maltivec}, @option{-mhard-float},
10600 @option{-mmfcrf}, @option{-mmultiple}, @option{-mnew-mnemonics},
10601 @option{-mpower}, @option{-mpower2}, @option{-mpowerpc64},
10602 @option{-mpowerpc-gpopt}, @option{-mpowerpc-gfxopt},
10603 @option{-mstring}. The particular options set for any particular CPU
10604 will vary between compiler versions, depending on what setting seems
10605 to produce optimal code for that CPU; it doesn't necessarily reflect
10606 the actual hardware's capabilities. If you wish to set an individual
10607 option to a particular value, you may specify it after the
10608 @option{-mcpu} option, like @samp{-mcpu=970 -mno-altivec}.
10609
10610 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
10611 not enabled or disabled by the @option{-mcpu} option at present, since
10612 AIX does not have full support for these options. You may still
10613 enable or disable them individually if you're sure it'll work in your
10614 environment.
10615
10616 @item -mtune=@var{cpu_type}
10617 @opindex mtune
10618 Set the instruction scheduling parameters for machine type
10619 @var{cpu_type}, but do not set the architecture type, register usage, or
10620 choice of mnemonics, as @option{-mcpu=@var{cpu_type}} would. The same
10621 values for @var{cpu_type} are used for @option{-mtune} as for
10622 @option{-mcpu}. If both are specified, the code generated will use the
10623 architecture, registers, and mnemonics set by @option{-mcpu}, but the
10624 scheduling parameters set by @option{-mtune}.
10625
10626 @item -maltivec
10627 @itemx -mno-altivec
10628 @opindex maltivec
10629 @opindex mno-altivec
10630 Generate code that uses (does not use) AltiVec instructions, and also
10631 enable the use of built-in functions that allow more direct access to
10632 the AltiVec instruction set. You may also need to set
10633 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
10634 enhancements.
10635
10636 @item -mabi=spe
10637 @opindex mabi=spe
10638 Extend the current ABI with SPE ABI extensions. This does not change
10639 the default ABI, instead it adds the SPE ABI extensions to the current
10640 ABI@.
10641
10642 @item -mabi=no-spe
10643 @opindex mabi=no-spe
10644 Disable Booke SPE ABI extensions for the current ABI@.
10645
10646 @item -misel=@var{yes/no}
10647 @itemx -misel
10648 @opindex misel
10649 This switch enables or disables the generation of ISEL instructions.
10650
10651 @item -mspe=@var{yes/no}
10652 @itemx -mspe
10653 @opindex mspe
10654 This switch enables or disables the generation of SPE simd
10655 instructions.
10656
10657 @item -mfloat-gprs=@var{yes/single/double/no}
10658 @itemx -mfloat-gprs
10659 @opindex mfloat-gprs
10660 This switch enables or disables the generation of floating point
10661 operations on the general purpose registers for architectures that
10662 support it.
10663
10664 The argument @var{yes} or @var{single} enables the use of
10665 single-precision floating point operations.
10666
10667 The argument @var{double} enables the use of single and
10668 double-precision floating point operations.
10669
10670 The argument @var{no} disables floating point operations on the
10671 general purpose registers.
10672
10673 This option is currently only available on the MPC854x.
10674
10675 @item -m32
10676 @itemx -m64
10677 @opindex m32
10678 @opindex m64
10679 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
10680 targets (including GNU/Linux). The 32-bit environment sets int, long
10681 and pointer to 32 bits and generates code that runs on any PowerPC
10682 variant. The 64-bit environment sets int to 32 bits and long and
10683 pointer to 64 bits, and generates code for PowerPC64, as for
10684 @option{-mpowerpc64}.
10685
10686 @item -mfull-toc
10687 @itemx -mno-fp-in-toc
10688 @itemx -mno-sum-in-toc
10689 @itemx -mminimal-toc
10690 @opindex mfull-toc
10691 @opindex mno-fp-in-toc
10692 @opindex mno-sum-in-toc
10693 @opindex mminimal-toc
10694 Modify generation of the TOC (Table Of Contents), which is created for
10695 every executable file. The @option{-mfull-toc} option is selected by
10696 default. In that case, GCC will allocate at least one TOC entry for
10697 each unique non-automatic variable reference in your program. GCC
10698 will also place floating-point constants in the TOC@. However, only
10699 16,384 entries are available in the TOC@.
10700
10701 If you receive a linker error message that saying you have overflowed
10702 the available TOC space, you can reduce the amount of TOC space used
10703 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
10704 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
10705 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
10706 generate code to calculate the sum of an address and a constant at
10707 run-time instead of putting that sum into the TOC@. You may specify one
10708 or both of these options. Each causes GCC to produce very slightly
10709 slower and larger code at the expense of conserving TOC space.
10710
10711 If you still run out of space in the TOC even when you specify both of
10712 these options, specify @option{-mminimal-toc} instead. This option causes
10713 GCC to make only one TOC entry for every file. When you specify this
10714 option, GCC will produce code that is slower and larger but which
10715 uses extremely little TOC space. You may wish to use this option
10716 only on files that contain less frequently executed code.
10717
10718 @item -maix64
10719 @itemx -maix32
10720 @opindex maix64
10721 @opindex maix32
10722 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
10723 @code{long} type, and the infrastructure needed to support them.
10724 Specifying @option{-maix64} implies @option{-mpowerpc64} and
10725 @option{-mpowerpc}, while @option{-maix32} disables the 64-bit ABI and
10726 implies @option{-mno-powerpc64}. GCC defaults to @option{-maix32}.
10727
10728 @item -mxl-compat
10729 @itemx -mno-xl-compat
10730 @opindex mxl-compat
10731 @opindex mno-xl-compat
10732 Produce code that conforms more closely to IBM XLC semantics when using
10733 AIX-compatible ABI. Pass floating-point arguments to prototyped
10734 functions beyond the register save area (RSA) on the stack in addition
10735 to argument FPRs. Do not assume that most significant double in 128
10736 bit long double value is properly rounded when comparing values.
10737
10738 The AIX calling convention was extended but not initially documented to
10739 handle an obscure K&R C case of calling a function that takes the
10740 address of its arguments with fewer arguments than declared. AIX XL
10741 compilers access floating point arguments which do not fit in the
10742 RSA from the stack when a subroutine is compiled without
10743 optimization. Because always storing floating-point arguments on the
10744 stack is inefficient and rarely needed, this option is not enabled by
10745 default and only is necessary when calling subroutines compiled by AIX
10746 XL compilers without optimization.
10747
10748 @item -mpe
10749 @opindex mpe
10750 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@. Link an
10751 application written to use message passing with special startup code to
10752 enable the application to run. The system must have PE installed in the
10753 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
10754 must be overridden with the @option{-specs=} option to specify the
10755 appropriate directory location. The Parallel Environment does not
10756 support threads, so the @option{-mpe} option and the @option{-pthread}
10757 option are incompatible.
10758
10759 @item -malign-natural
10760 @itemx -malign-power
10761 @opindex malign-natural
10762 @opindex malign-power
10763 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
10764 @option{-malign-natural} overrides the ABI-defined alignment of larger
10765 types, such as floating-point doubles, on their natural size-based boundary.
10766 The option @option{-malign-power} instructs GCC to follow the ABI-specified
10767 alignment rules. GCC defaults to the standard alignment defined in the ABI@.
10768
10769 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
10770 is not supported.
10771
10772 @item -msoft-float
10773 @itemx -mhard-float
10774 @opindex msoft-float
10775 @opindex mhard-float
10776 Generate code that does not use (uses) the floating-point register set.
10777 Software floating point emulation is provided if you use the
10778 @option{-msoft-float} option, and pass the option to GCC when linking.
10779
10780 @item -mmultiple
10781 @itemx -mno-multiple
10782 @opindex mmultiple
10783 @opindex mno-multiple
10784 Generate code that uses (does not use) the load multiple word
10785 instructions and the store multiple word instructions. These
10786 instructions are generated by default on POWER systems, and not
10787 generated on PowerPC systems. Do not use @option{-mmultiple} on little
10788 endian PowerPC systems, since those instructions do not work when the
10789 processor is in little endian mode. The exceptions are PPC740 and
10790 PPC750 which permit the instructions usage in little endian mode.
10791
10792 @item -mstring
10793 @itemx -mno-string
10794 @opindex mstring
10795 @opindex mno-string
10796 Generate code that uses (does not use) the load string instructions
10797 and the store string word instructions to save multiple registers and
10798 do small block moves. These instructions are generated by default on
10799 POWER systems, and not generated on PowerPC systems. Do not use
10800 @option{-mstring} on little endian PowerPC systems, since those
10801 instructions do not work when the processor is in little endian mode.
10802 The exceptions are PPC740 and PPC750 which permit the instructions
10803 usage in little endian mode.
10804
10805 @item -mupdate
10806 @itemx -mno-update
10807 @opindex mupdate
10808 @opindex mno-update
10809 Generate code that uses (does not use) the load or store instructions
10810 that update the base register to the address of the calculated memory
10811 location. These instructions are generated by default. If you use
10812 @option{-mno-update}, there is a small window between the time that the
10813 stack pointer is updated and the address of the previous frame is
10814 stored, which means code that walks the stack frame across interrupts or
10815 signals may get corrupted data.
10816
10817 @item -mfused-madd
10818 @itemx -mno-fused-madd
10819 @opindex mfused-madd
10820 @opindex mno-fused-madd
10821 Generate code that uses (does not use) the floating point multiply and
10822 accumulate instructions. These instructions are generated by default if
10823 hardware floating is used.
10824
10825 @item -mno-bit-align
10826 @itemx -mbit-align
10827 @opindex mno-bit-align
10828 @opindex mbit-align
10829 On System V.4 and embedded PowerPC systems do not (do) force structures
10830 and unions that contain bit-fields to be aligned to the base type of the
10831 bit-field.
10832
10833 For example, by default a structure containing nothing but 8
10834 @code{unsigned} bit-fields of length 1 would be aligned to a 4 byte
10835 boundary and have a size of 4 bytes. By using @option{-mno-bit-align},
10836 the structure would be aligned to a 1 byte boundary and be one byte in
10837 size.
10838
10839 @item -mno-strict-align
10840 @itemx -mstrict-align
10841 @opindex mno-strict-align
10842 @opindex mstrict-align
10843 On System V.4 and embedded PowerPC systems do not (do) assume that
10844 unaligned memory references will be handled by the system.
10845
10846 @item -mrelocatable
10847 @itemx -mno-relocatable
10848 @opindex mrelocatable
10849 @opindex mno-relocatable
10850 On embedded PowerPC systems generate code that allows (does not allow)
10851 the program to be relocated to a different address at runtime. If you
10852 use @option{-mrelocatable} on any module, all objects linked together must
10853 be compiled with @option{-mrelocatable} or @option{-mrelocatable-lib}.
10854
10855 @item -mrelocatable-lib
10856 @itemx -mno-relocatable-lib
10857 @opindex mrelocatable-lib
10858 @opindex mno-relocatable-lib
10859 On embedded PowerPC systems generate code that allows (does not allow)
10860 the program to be relocated to a different address at runtime. Modules
10861 compiled with @option{-mrelocatable-lib} can be linked with either modules
10862 compiled without @option{-mrelocatable} and @option{-mrelocatable-lib} or
10863 with modules compiled with the @option{-mrelocatable} options.
10864
10865 @item -mno-toc
10866 @itemx -mtoc
10867 @opindex mno-toc
10868 @opindex mtoc
10869 On System V.4 and embedded PowerPC systems do not (do) assume that
10870 register 2 contains a pointer to a global area pointing to the addresses
10871 used in the program.
10872
10873 @item -mlittle
10874 @itemx -mlittle-endian
10875 @opindex mlittle
10876 @opindex mlittle-endian
10877 On System V.4 and embedded PowerPC systems compile code for the
10878 processor in little endian mode. The @option{-mlittle-endian} option is
10879 the same as @option{-mlittle}.
10880
10881 @item -mbig
10882 @itemx -mbig-endian
10883 @opindex mbig
10884 @opindex mbig-endian
10885 On System V.4 and embedded PowerPC systems compile code for the
10886 processor in big endian mode. The @option{-mbig-endian} option is
10887 the same as @option{-mbig}.
10888
10889 @item -mdynamic-no-pic
10890 @opindex mdynamic-no-pic
10891 On Darwin and Mac OS X systems, compile code so that it is not
10892 relocatable, but that its external references are relocatable. The
10893 resulting code is suitable for applications, but not shared
10894 libraries.
10895
10896 @item -mprioritize-restricted-insns=@var{priority}
10897 @opindex mprioritize-restricted-insns
10898 This option controls the priority that is assigned to
10899 dispatch-slot restricted instructions during the second scheduling
10900 pass. The argument @var{priority} takes the value @var{0/1/2} to assign
10901 @var{no/highest/second-highest} priority to dispatch slot restricted
10902 instructions.
10903
10904 @item -msched-costly-dep=@var{dependence_type}
10905 @opindex msched-costly-dep
10906 This option controls which dependences are considered costly
10907 by the target during instruction scheduling. The argument
10908 @var{dependence_type} takes one of the following values:
10909 @var{no}: no dependence is costly,
10910 @var{all}: all dependences are costly,
10911 @var{true_store_to_load}: a true dependence from store to load is costly,
10912 @var{store_to_load}: any dependence from store to load is costly,
10913 @var{number}: any dependence which latency >= @var{number} is costly.
10914
10915 @item -minsert-sched-nops=@var{scheme}
10916 @opindex minsert-sched-nops
10917 This option controls which nop insertion scheme will be used during
10918 the second scheduling pass. The argument @var{scheme} takes one of the
10919 following values:
10920 @var{no}: Don't insert nops.
10921 @var{pad}: Pad with nops any dispatch group which has vacant issue slots,
10922 according to the scheduler's grouping.
10923 @var{regroup_exact}: Insert nops to force costly dependent insns into
10924 separate groups. Insert exactly as many nops as needed to force an insn
10925 to a new group, according to the estimated processor grouping.
10926 @var{number}: Insert nops to force costly dependent insns into
10927 separate groups. Insert @var{number} nops to force an insn to a new group.
10928
10929 @item -mcall-sysv
10930 @opindex mcall-sysv
10931 On System V.4 and embedded PowerPC systems compile code using calling
10932 conventions that adheres to the March 1995 draft of the System V
10933 Application Binary Interface, PowerPC processor supplement. This is the
10934 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
10935
10936 @item -mcall-sysv-eabi
10937 @opindex mcall-sysv-eabi
10938 Specify both @option{-mcall-sysv} and @option{-meabi} options.
10939
10940 @item -mcall-sysv-noeabi
10941 @opindex mcall-sysv-noeabi
10942 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
10943
10944 @item -mcall-solaris
10945 @opindex mcall-solaris
10946 On System V.4 and embedded PowerPC systems compile code for the Solaris
10947 operating system.
10948
10949 @item -mcall-linux
10950 @opindex mcall-linux
10951 On System V.4 and embedded PowerPC systems compile code for the
10952 Linux-based GNU system.
10953
10954 @item -mcall-gnu
10955 @opindex mcall-gnu
10956 On System V.4 and embedded PowerPC systems compile code for the
10957 Hurd-based GNU system.
10958
10959 @item -mcall-netbsd
10960 @opindex mcall-netbsd
10961 On System V.4 and embedded PowerPC systems compile code for the
10962 NetBSD operating system.
10963
10964 @item -maix-struct-return
10965 @opindex maix-struct-return
10966 Return all structures in memory (as specified by the AIX ABI)@.
10967
10968 @item -msvr4-struct-return
10969 @opindex msvr4-struct-return
10970 Return structures smaller than 8 bytes in registers (as specified by the
10971 SVR4 ABI)@.
10972
10973 @item -mabi=altivec
10974 @opindex mabi=altivec
10975 Extend the current ABI with AltiVec ABI extensions. This does not
10976 change the default ABI, instead it adds the AltiVec ABI extensions to
10977 the current ABI@.
10978
10979 @item -mabi=no-altivec
10980 @opindex mabi=no-altivec
10981 Disable AltiVec ABI extensions for the current ABI@.
10982
10983 @item -mprototype
10984 @itemx -mno-prototype
10985 @opindex mprototype
10986 @opindex mno-prototype
10987 On System V.4 and embedded PowerPC systems assume that all calls to
10988 variable argument functions are properly prototyped. Otherwise, the
10989 compiler must insert an instruction before every non prototyped call to
10990 set or clear bit 6 of the condition code register (@var{CR}) to
10991 indicate whether floating point values were passed in the floating point
10992 registers in case the function takes a variable arguments. With
10993 @option{-mprototype}, only calls to prototyped variable argument functions
10994 will set or clear the bit.
10995
10996 @item -msim
10997 @opindex msim
10998 On embedded PowerPC systems, assume that the startup module is called
10999 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
11000 @file{libc.a}. This is the default for @samp{powerpc-*-eabisim}.
11001 configurations.
11002
11003 @item -mmvme
11004 @opindex mmvme
11005 On embedded PowerPC systems, assume that the startup module is called
11006 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
11007 @file{libc.a}.
11008
11009 @item -mads
11010 @opindex mads
11011 On embedded PowerPC systems, assume that the startup module is called
11012 @file{crt0.o} and the standard C libraries are @file{libads.a} and
11013 @file{libc.a}.
11014
11015 @item -myellowknife
11016 @opindex myellowknife
11017 On embedded PowerPC systems, assume that the startup module is called
11018 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
11019 @file{libc.a}.
11020
11021 @item -mvxworks
11022 @opindex mvxworks
11023 On System V.4 and embedded PowerPC systems, specify that you are
11024 compiling for a VxWorks system.
11025
11026 @item -mwindiss
11027 @opindex mwindiss
11028 Specify that you are compiling for the WindISS simulation environment.
11029
11030 @item -memb
11031 @opindex memb
11032 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
11033 header to indicate that @samp{eabi} extended relocations are used.
11034
11035 @item -meabi
11036 @itemx -mno-eabi
11037 @opindex meabi
11038 @opindex mno-eabi
11039 On System V.4 and embedded PowerPC systems do (do not) adhere to the
11040 Embedded Applications Binary Interface (eabi) which is a set of
11041 modifications to the System V.4 specifications. Selecting @option{-meabi}
11042 means that the stack is aligned to an 8 byte boundary, a function
11043 @code{__eabi} is called to from @code{main} to set up the eabi
11044 environment, and the @option{-msdata} option can use both @code{r2} and
11045 @code{r13} to point to two separate small data areas. Selecting
11046 @option{-mno-eabi} means that the stack is aligned to a 16 byte boundary,
11047 do not call an initialization function from @code{main}, and the
11048 @option{-msdata} option will only use @code{r13} to point to a single
11049 small data area. The @option{-meabi} option is on by default if you
11050 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
11051
11052 @item -msdata=eabi
11053 @opindex msdata=eabi
11054 On System V.4 and embedded PowerPC systems, put small initialized
11055 @code{const} global and static data in the @samp{.sdata2} section, which
11056 is pointed to by register @code{r2}. Put small initialized
11057 non-@code{const} global and static data in the @samp{.sdata} section,
11058 which is pointed to by register @code{r13}. Put small uninitialized
11059 global and static data in the @samp{.sbss} section, which is adjacent to
11060 the @samp{.sdata} section. The @option{-msdata=eabi} option is
11061 incompatible with the @option{-mrelocatable} option. The
11062 @option{-msdata=eabi} option also sets the @option{-memb} option.
11063
11064 @item -msdata=sysv
11065 @opindex msdata=sysv
11066 On System V.4 and embedded PowerPC systems, put small global and static
11067 data in the @samp{.sdata} section, which is pointed to by register
11068 @code{r13}. Put small uninitialized global and static data in the
11069 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
11070 The @option{-msdata=sysv} option is incompatible with the
11071 @option{-mrelocatable} option.
11072
11073 @item -msdata=default
11074 @itemx -msdata
11075 @opindex msdata=default
11076 @opindex msdata
11077 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
11078 compile code the same as @option{-msdata=eabi}, otherwise compile code the
11079 same as @option{-msdata=sysv}.
11080
11081 @item -msdata-data
11082 @opindex msdata-data
11083 On System V.4 and embedded PowerPC systems, put small global and static
11084 data in the @samp{.sdata} section. Put small uninitialized global and
11085 static data in the @samp{.sbss} section. Do not use register @code{r13}
11086 to address small data however. This is the default behavior unless
11087 other @option{-msdata} options are used.
11088
11089 @item -msdata=none
11090 @itemx -mno-sdata
11091 @opindex msdata=none
11092 @opindex mno-sdata
11093 On embedded PowerPC systems, put all initialized global and static data
11094 in the @samp{.data} section, and all uninitialized data in the
11095 @samp{.bss} section.
11096
11097 @item -G @var{num}
11098 @opindex G
11099 @cindex smaller data references (PowerPC)
11100 @cindex .sdata/.sdata2 references (PowerPC)
11101 On embedded PowerPC systems, put global and static items less than or
11102 equal to @var{num} bytes into the small data or bss sections instead of
11103 the normal data or bss section. By default, @var{num} is 8. The
11104 @option{-G @var{num}} switch is also passed to the linker.
11105 All modules should be compiled with the same @option{-G @var{num}} value.
11106
11107 @item -mregnames
11108 @itemx -mno-regnames
11109 @opindex mregnames
11110 @opindex mno-regnames
11111 On System V.4 and embedded PowerPC systems do (do not) emit register
11112 names in the assembly language output using symbolic forms.
11113
11114 @item -mlongcall
11115 @itemx -mno-longcall
11116 @opindex mlongcall
11117 @opindex mno-longcall
11118 Default to making all function calls indirectly, using a register, so
11119 that functions which reside further than 32 megabytes (33,554,432
11120 bytes) from the current location can be called. This setting can be
11121 overridden by the @code{shortcall} function attribute, or by
11122 @code{#pragma longcall(0)}.
11123
11124 Some linkers are capable of detecting out-of-range calls and generating
11125 glue code on the fly. On these systems, long calls are unnecessary and
11126 generate slower code. As of this writing, the AIX linker can do this,
11127 as can the GNU linker for PowerPC/64. It is planned to add this feature
11128 to the GNU linker for 32-bit PowerPC systems as well.
11129
11130 On Darwin/PPC systems, @code{#pragma longcall} will generate ``jbsr
11131 callee, L42'', plus a ``branch island'' (glue code). The two target
11132 addresses represent the callee and the ``branch island''. The
11133 Darwin/PPC linker will prefer the first address and generate a ``bl
11134 callee'' if the PPC ``bl'' instruction will reach the callee directly;
11135 otherwise, the linker will generate ``bl L42'' to call the ``branch
11136 island''. The ``branch island'' is appended to the body of the
11137 calling function; it computes the full 32-bit address of the callee
11138 and jumps to it.
11139
11140 On Mach-O (Darwin) systems, this option directs the compiler emit to
11141 the glue for every direct call, and the Darwin linker decides whether
11142 to use or discard it.
11143
11144 In the future, we may cause GCC to ignore all longcall specifications
11145 when the linker is known to generate glue.
11146
11147 @item -pthread
11148 @opindex pthread
11149 Adds support for multithreading with the @dfn{pthreads} library.
11150 This option sets flags for both the preprocessor and linker.
11151
11152 @end table
11153
11154 @node S/390 and zSeries Options
11155 @subsection S/390 and zSeries Options
11156 @cindex S/390 and zSeries Options
11157
11158 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
11159
11160 @table @gcctabopt
11161 @item -mhard-float
11162 @itemx -msoft-float
11163 @opindex mhard-float
11164 @opindex msoft-float
11165 Use (do not use) the hardware floating-point instructions and registers
11166 for floating-point operations. When @option{-msoft-float} is specified,
11167 functions in @file{libgcc.a} will be used to perform floating-point
11168 operations. When @option{-mhard-float} is specified, the compiler
11169 generates IEEE floating-point instructions. This is the default.
11170
11171 @item -mbackchain
11172 @itemx -mno-backchain
11173 @opindex mbackchain
11174 @opindex mno-backchain
11175 Store (do not store) the address of the caller's frame as backchain pointer
11176 into the callee's stack frame.
11177 A backchain may be needed to allow debugging using tools that do not understand
11178 DWARF-2 call frame information.
11179 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
11180 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
11181 the backchain is placed into the topmost word of the 96/160 byte register
11182 save area.
11183
11184 In general, code compiled with @option{-mbackchain} is call-compatible with
11185 code compiled with @option{-mmo-backchain}; however, use of the backchain
11186 for debugging purposes usually requires that the whole binary is built with
11187 @option{-mbackchain}. Note that the combination of @option{-mbackchain},
11188 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11189 to build a linux kernel use @option{-msoft-float}.
11190
11191 The default is to not maintain the backchain.
11192
11193 @item -mpacked-stack
11194 @item -mno-packed-stack
11195 @opindex mpacked-stack
11196 @opindex mno-packed-stack
11197 Use (do not use) the packed stack layout. When @option{-mno-packed-stack} is
11198 specified, the compiler uses the all fields of the 96/160 byte register save
11199 area only for their default purpose; unused fields still take up stack space.
11200 When @option{-mpacked-stack} is specified, register save slots are densely
11201 packed at the top of the register save area; unused space is reused for other
11202 purposes, allowing for more efficient use of the available stack space.
11203 However, when @option{-mbackchain} is also in effect, the topmost word of
11204 the save area is always used to store the backchain, and the return address
11205 register is always saved two words below the backchain.
11206
11207 As long as the stack frame backchain is not used, code generated with
11208 @option{-mpacked-stack} is call-compatible with code generated with
11209 @option{-mno-packed-stack}. Note that some non-FSF releases of GCC 2.95 for
11210 S/390 or zSeries generated code that uses the stack frame backchain at run
11211 time, not just for debugging purposes. Such code is not call-compatible
11212 with code compiled with @option{-mpacked-stack}. Also, note that the
11213 combination of @option{-mbackchain},
11214 @option{-mpacked-stack} and @option{-mhard-float} is not supported. In order
11215 to build a linux kernel use @option{-msoft-float}.
11216
11217 The default is to not use the packed stack layout.
11218
11219 @item -msmall-exec
11220 @itemx -mno-small-exec
11221 @opindex msmall-exec
11222 @opindex mno-small-exec
11223 Generate (or do not generate) code using the @code{bras} instruction
11224 to do subroutine calls.
11225 This only works reliably if the total executable size does not
11226 exceed 64k. The default is to use the @code{basr} instruction instead,
11227 which does not have this limitation.
11228
11229 @item -m64
11230 @itemx -m31
11231 @opindex m64
11232 @opindex m31
11233 When @option{-m31} is specified, generate code compliant to the
11234 GNU/Linux for S/390 ABI@. When @option{-m64} is specified, generate
11235 code compliant to the GNU/Linux for zSeries ABI@. This allows GCC in
11236 particular to generate 64-bit instructions. For the @samp{s390}
11237 targets, the default is @option{-m31}, while the @samp{s390x}
11238 targets default to @option{-m64}.
11239
11240 @item -mzarch
11241 @itemx -mesa
11242 @opindex mzarch
11243 @opindex mesa
11244 When @option{-mzarch} is specified, generate code using the
11245 instructions available on z/Architecture.
11246 When @option{-mesa} is specified, generate code using the
11247 instructions available on ESA/390. Note that @option{-mesa} is
11248 not possible with @option{-m64}.
11249 When generating code compliant to the GNU/Linux for S/390 ABI,
11250 the default is @option{-mesa}. When generating code compliant
11251 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
11252
11253 @item -mmvcle
11254 @itemx -mno-mvcle
11255 @opindex mmvcle
11256 @opindex mno-mvcle
11257 Generate (or do not generate) code using the @code{mvcle} instruction
11258 to perform block moves. When @option{-mno-mvcle} is specified,
11259 use a @code{mvc} loop instead. This is the default.
11260
11261 @item -mdebug
11262 @itemx -mno-debug
11263 @opindex mdebug
11264 @opindex mno-debug
11265 Print (or do not print) additional debug information when compiling.
11266 The default is to not print debug information.
11267
11268 @item -march=@var{cpu-type}
11269 @opindex march
11270 Generate code that will run on @var{cpu-type}, which is the name of a system
11271 representing a certain processor type. Possible values for
11272 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, and @samp{z990}.
11273 When generating code using the instructions available on z/Architecture,
11274 the default is @option{-march=z900}. Otherwise, the default is
11275 @option{-march=g5}.
11276
11277 @item -mtune=@var{cpu-type}
11278 @opindex mtune
11279 Tune to @var{cpu-type} everything applicable about the generated code,
11280 except for the ABI and the set of available instructions.
11281 The list of @var{cpu-type} values is the same as for @option{-march}.
11282 The default is the value used for @option{-march}.
11283
11284 @item -mtpf-trace
11285 @itemx -mno-tpf-trace
11286 @opindex mtpf-trace
11287 @opindex mno-tpf-trace
11288 Generate code that adds (does not add) in TPF OS specific branches to trace
11289 routines in the operating system. This option is off by default, even
11290 when compiling for the TPF OS@.
11291
11292 @item -mfused-madd
11293 @itemx -mno-fused-madd
11294 @opindex mfused-madd
11295 @opindex mno-fused-madd
11296 Generate code that uses (does not use) the floating point multiply and
11297 accumulate instructions. These instructions are generated by default if
11298 hardware floating point is used.
11299
11300 @item -mwarn-framesize=@var{framesize}
11301 @opindex mwarn-framesize
11302 Emit a warning if the current function exceeds the given frame size. Because
11303 this is a compile time check it doesn't need to be a real problem when the program
11304 runs. It is intended to identify functions which most probably cause
11305 a stack overflow. It is useful to be used in an environment with limited stack
11306 size e.g.@: the linux kernel.
11307
11308 @item -mwarn-dynamicstack
11309 @opindex mwarn-dynamicstack
11310 Emit a warning if the function calls alloca or uses dynamically
11311 sized arrays. This is generally a bad idea with a limited stack size.
11312
11313 @item -mstack-guard=@var{stack-guard}
11314 @item -mstack-size=@var{stack-size}
11315 @opindex mstack-guard
11316 @opindex mstack-size
11317 These arguments always have to be used in conjunction. If they are present the s390
11318 back end emits additional instructions in the function prologue which trigger a trap
11319 if the stack size is @var{stack-guard} bytes above the @var{stack-size}
11320 (remember that the stack on s390 grows downward). These options are intended to
11321 be used to help debugging stack overflow problems. The additionally emitted code
11322 cause only little overhead and hence can also be used in production like systems
11323 without greater performance degradation. The given values have to be exact
11324 powers of 2 and @var{stack-size} has to be greater than @var{stack-guard}.
11325 In order to be efficient the extra code makes the assumption that the stack starts
11326 at an address aligned to the value given by @var{stack-size}.
11327 @end table
11328
11329 @node SH Options
11330 @subsection SH Options
11331
11332 These @samp{-m} options are defined for the SH implementations:
11333
11334 @table @gcctabopt
11335 @item -m1
11336 @opindex m1
11337 Generate code for the SH1.
11338
11339 @item -m2
11340 @opindex m2
11341 Generate code for the SH2.
11342
11343 @item -m2e
11344 Generate code for the SH2e.
11345
11346 @item -m3
11347 @opindex m3
11348 Generate code for the SH3.
11349
11350 @item -m3e
11351 @opindex m3e
11352 Generate code for the SH3e.
11353
11354 @item -m4-nofpu
11355 @opindex m4-nofpu
11356 Generate code for the SH4 without a floating-point unit.
11357
11358 @item -m4-single-only
11359 @opindex m4-single-only
11360 Generate code for the SH4 with a floating-point unit that only
11361 supports single-precision arithmetic.
11362
11363 @item -m4-single
11364 @opindex m4-single
11365 Generate code for the SH4 assuming the floating-point unit is in
11366 single-precision mode by default.
11367
11368 @item -m4
11369 @opindex m4
11370 Generate code for the SH4.
11371
11372 @item -m4a-nofpu
11373 @opindex m4a-nofpu
11374 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
11375 floating-point unit is not used.
11376
11377 @item -m4a-single-only
11378 @opindex m4a-single-only
11379 Generate code for the SH4a, in such a way that no double-precision
11380 floating point operations are used.
11381
11382 @item -m4a-single
11383 @opindex m4a-single
11384 Generate code for the SH4a assuming the floating-point unit is in
11385 single-precision mode by default.
11386
11387 @item -m4a
11388 @opindex m4a
11389 Generate code for the SH4a.
11390
11391 @item -m4al
11392 @opindex m4al
11393 Same as @option{-m4a-nofpu}, except that it implicitly passes
11394 @option{-dsp} to the assembler. GCC doesn't generate any DSP
11395 instructions at the moment.
11396
11397 @item -mb
11398 @opindex mb
11399 Compile code for the processor in big endian mode.
11400
11401 @item -ml
11402 @opindex ml
11403 Compile code for the processor in little endian mode.
11404
11405 @item -mdalign
11406 @opindex mdalign
11407 Align doubles at 64-bit boundaries. Note that this changes the calling
11408 conventions, and thus some functions from the standard C library will
11409 not work unless you recompile it first with @option{-mdalign}.
11410
11411 @item -mrelax
11412 @opindex mrelax
11413 Shorten some address references at link time, when possible; uses the
11414 linker option @option{-relax}.
11415
11416 @item -mbigtable
11417 @opindex mbigtable
11418 Use 32-bit offsets in @code{switch} tables. The default is to use
11419 16-bit offsets.
11420
11421 @item -mfmovd
11422 @opindex mfmovd
11423 Enable the use of the instruction @code{fmovd}.
11424
11425 @item -mhitachi
11426 @opindex mhitachi
11427 Comply with the calling conventions defined by Renesas.
11428
11429 @item -mrenesas
11430 @opindex mhitachi
11431 Comply with the calling conventions defined by Renesas.
11432
11433 @item -mno-renesas
11434 @opindex mhitachi
11435 Comply with the calling conventions defined for GCC before the Renesas
11436 conventions were available. This option is the default for all
11437 targets of the SH toolchain except for @samp{sh-symbianelf}.
11438
11439 @item -mnomacsave
11440 @opindex mnomacsave
11441 Mark the @code{MAC} register as call-clobbered, even if
11442 @option{-mhitachi} is given.
11443
11444 @item -mieee
11445 @opindex mieee
11446 Increase IEEE-compliance of floating-point code.
11447
11448 @item -misize
11449 @opindex misize
11450 Dump instruction size and location in the assembly code.
11451
11452 @item -mpadstruct
11453 @opindex mpadstruct
11454 This option is deprecated. It pads structures to multiple of 4 bytes,
11455 which is incompatible with the SH ABI@.
11456
11457 @item -mspace
11458 @opindex mspace
11459 Optimize for space instead of speed. Implied by @option{-Os}.
11460
11461 @item -mprefergot
11462 @opindex mprefergot
11463 When generating position-independent code, emit function calls using
11464 the Global Offset Table instead of the Procedure Linkage Table.
11465
11466 @item -musermode
11467 @opindex musermode
11468 Generate a library function call to invalidate instruction cache
11469 entries, after fixing up a trampoline. This library function call
11470 doesn't assume it can write to the whole memory address space. This
11471 is the default when the target is @code{sh-*-linux*}.
11472 @end table
11473
11474 @node SPARC Options
11475 @subsection SPARC Options
11476 @cindex SPARC options
11477
11478 These @samp{-m} options are supported on the SPARC:
11479
11480 @table @gcctabopt
11481 @item -mno-app-regs
11482 @itemx -mapp-regs
11483 @opindex mno-app-regs
11484 @opindex mapp-regs
11485 Specify @option{-mapp-regs} to generate output using the global registers
11486 2 through 4, which the SPARC SVR4 ABI reserves for applications. This
11487 is the default, except on Solaris.
11488
11489 To be fully SVR4 ABI compliant at the cost of some performance loss,
11490 specify @option{-mno-app-regs}. You should compile libraries and system
11491 software with this option.
11492
11493 @item -mfpu
11494 @itemx -mhard-float
11495 @opindex mfpu
11496 @opindex mhard-float
11497 Generate output containing floating point instructions. This is the
11498 default.
11499
11500 @item -mno-fpu
11501 @itemx -msoft-float
11502 @opindex mno-fpu
11503 @opindex msoft-float
11504 Generate output containing library calls for floating point.
11505 @strong{Warning:} the requisite libraries are not available for all SPARC
11506 targets. Normally the facilities of the machine's usual C compiler are
11507 used, but this cannot be done directly in cross-compilation. You must make
11508 your own arrangements to provide suitable library functions for
11509 cross-compilation. The embedded targets @samp{sparc-*-aout} and
11510 @samp{sparclite-*-*} do provide software floating point support.
11511
11512 @option{-msoft-float} changes the calling convention in the output file;
11513 therefore, it is only useful if you compile @emph{all} of a program with
11514 this option. In particular, you need to compile @file{libgcc.a}, the
11515 library that comes with GCC, with @option{-msoft-float} in order for
11516 this to work.
11517
11518 @item -mhard-quad-float
11519 @opindex mhard-quad-float
11520 Generate output containing quad-word (long double) floating point
11521 instructions.
11522
11523 @item -msoft-quad-float
11524 @opindex msoft-quad-float
11525 Generate output containing library calls for quad-word (long double)
11526 floating point instructions. The functions called are those specified
11527 in the SPARC ABI@. This is the default.
11528
11529 As of this writing, there are no SPARC implementations that have hardware
11530 support for the quad-word floating point instructions. They all invoke
11531 a trap handler for one of these instructions, and then the trap handler
11532 emulates the effect of the instruction. Because of the trap handler overhead,
11533 this is much slower than calling the ABI library routines. Thus the
11534 @option{-msoft-quad-float} option is the default.
11535
11536 @item -mno-unaligned-doubles
11537 @itemx -munaligned-doubles
11538 @opindex mno-unaligned-doubles
11539 @opindex munaligned-doubles
11540 Assume that doubles have 8 byte alignment. This is the default.
11541
11542 With @option{-munaligned-doubles}, GCC assumes that doubles have 8 byte
11543 alignment only if they are contained in another type, or if they have an
11544 absolute address. Otherwise, it assumes they have 4 byte alignment.
11545 Specifying this option avoids some rare compatibility problems with code
11546 generated by other compilers. It is not the default because it results
11547 in a performance loss, especially for floating point code.
11548
11549 @item -mno-faster-structs
11550 @itemx -mfaster-structs
11551 @opindex mno-faster-structs
11552 @opindex mfaster-structs
11553 With @option{-mfaster-structs}, the compiler assumes that structures
11554 should have 8 byte alignment. This enables the use of pairs of
11555 @code{ldd} and @code{std} instructions for copies in structure
11556 assignment, in place of twice as many @code{ld} and @code{st} pairs.
11557 However, the use of this changed alignment directly violates the SPARC
11558 ABI@. Thus, it's intended only for use on targets where the developer
11559 acknowledges that their resulting code will not be directly in line with
11560 the rules of the ABI@.
11561
11562 @item -mimpure-text
11563 @opindex mimpure-text
11564 @option{-mimpure-text}, used in addition to @option{-shared}, tells
11565 the compiler to not pass @option{-z text} to the linker when linking a
11566 shared object. Using this option, you can link position-dependent
11567 code into a shared object.
11568
11569 @option{-mimpure-text} suppresses the ``relocations remain against
11570 allocatable but non-writable sections'' linker error message.
11571 However, the necessary relocations will trigger copy-on-write, and the
11572 shared object is not actually shared across processes. Instead of
11573 using @option{-mimpure-text}, you should compile all source code with
11574 @option{-fpic} or @option{-fPIC}.
11575
11576 This option is only available on SunOS and Solaris.
11577
11578 @item -mcpu=@var{cpu_type}
11579 @opindex mcpu
11580 Set the instruction set, register set, and instruction scheduling parameters
11581 for machine type @var{cpu_type}. Supported values for @var{cpu_type} are
11582 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{sparclite},
11583 @samp{f930}, @samp{f934}, @samp{hypersparc}, @samp{sparclite86x},
11584 @samp{sparclet}, @samp{tsc701}, @samp{v9}, @samp{ultrasparc}, and
11585 @samp{ultrasparc3}.
11586
11587 Default instruction scheduling parameters are used for values that select
11588 an architecture and not an implementation. These are @samp{v7}, @samp{v8},
11589 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
11590
11591 Here is a list of each supported architecture and their supported
11592 implementations.
11593
11594 @smallexample
11595 v7: cypress
11596 v8: supersparc, hypersparc
11597 sparclite: f930, f934, sparclite86x
11598 sparclet: tsc701
11599 v9: ultrasparc, ultrasparc3
11600 @end smallexample
11601
11602 By default (unless configured otherwise), GCC generates code for the V7
11603 variant of the SPARC architecture. With @option{-mcpu=cypress}, the compiler
11604 additionally optimizes it for the Cypress CY7C602 chip, as used in the
11605 SPARCStation/SPARCServer 3xx series. This is also appropriate for the older
11606 SPARCStation 1, 2, IPX etc.
11607
11608 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
11609 architecture. The only difference from V7 code is that the compiler emits
11610 the integer multiply and integer divide instructions which exist in SPARC-V8
11611 but not in SPARC-V7. With @option{-mcpu=supersparc}, the compiler additionally
11612 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
11613 2000 series.
11614
11615 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
11616 the SPARC architecture. This adds the integer multiply, integer divide step
11617 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
11618 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
11619 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@. With
11620 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
11621 MB86934 chip, which is the more recent SPARClite with FPU@.
11622
11623 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
11624 the SPARC architecture. This adds the integer multiply, multiply/accumulate,
11625 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
11626 but not in SPARC-V7. With @option{-mcpu=tsc701}, the compiler additionally
11627 optimizes it for the TEMIC SPARClet chip.
11628
11629 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
11630 architecture. This adds 64-bit integer and floating-point move instructions,
11631 3 additional floating-point condition code registers and conditional move
11632 instructions. With @option{-mcpu=ultrasparc}, the compiler additionally
11633 optimizes it for the Sun UltraSPARC I/II chips. With
11634 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
11635 Sun UltraSPARC III chip.
11636
11637 @item -mtune=@var{cpu_type}
11638 @opindex mtune
11639 Set the instruction scheduling parameters for machine type
11640 @var{cpu_type}, but do not set the instruction set or register set that the
11641 option @option{-mcpu=@var{cpu_type}} would.
11642
11643 The same values for @option{-mcpu=@var{cpu_type}} can be used for
11644 @option{-mtune=@var{cpu_type}}, but the only useful values are those
11645 that select a particular cpu implementation. Those are @samp{cypress},
11646 @samp{supersparc}, @samp{hypersparc}, @samp{f930}, @samp{f934},
11647 @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc}, and
11648 @samp{ultrasparc3}.
11649
11650 @item -mv8plus
11651 @itemx -mno-v8plus
11652 @opindex mv8plus
11653 @opindex mno-v8plus
11654 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@. The
11655 difference from the V8 ABI is that the global and out registers are
11656 considered 64-bit wide. This is enabled by default on Solaris in 32-bit
11657 mode for all SPARC-V9 processors.
11658
11659 @item -mvis
11660 @itemx -mno-vis
11661 @opindex mvis
11662 @opindex mno-vis
11663 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
11664 Visual Instruction Set extensions. The default is @option{-mno-vis}.
11665 @end table
11666
11667 These @samp{-m} options are supported in addition to the above
11668 on SPARC-V9 processors in 64-bit environments:
11669
11670 @table @gcctabopt
11671 @item -mlittle-endian
11672 @opindex mlittle-endian
11673 Generate code for a processor running in little-endian mode. It is only
11674 available for a few configurations and most notably not on Solaris and Linux.
11675
11676 @item -m32
11677 @itemx -m64
11678 @opindex m32
11679 @opindex m64
11680 Generate code for a 32-bit or 64-bit environment.
11681 The 32-bit environment sets int, long and pointer to 32 bits.
11682 The 64-bit environment sets int to 32 bits and long and pointer
11683 to 64 bits.
11684
11685 @item -mcmodel=medlow
11686 @opindex mcmodel=medlow
11687 Generate code for the Medium/Low code model: 64-bit addresses, programs
11688 must be linked in the low 32 bits of memory. Programs can be statically
11689 or dynamically linked.
11690
11691 @item -mcmodel=medmid
11692 @opindex mcmodel=medmid
11693 Generate code for the Medium/Middle code model: 64-bit addresses, programs
11694 must be linked in the low 44 bits of memory, the text and data segments must
11695 be less than 2GB in size and the data segment must be located within 2GB of
11696 the text segment.
11697
11698 @item -mcmodel=medany
11699 @opindex mcmodel=medany
11700 Generate code for the Medium/Anywhere code model: 64-bit addresses, programs
11701 may be linked anywhere in memory, the text and data segments must be less
11702 than 2GB in size and the data segment must be located within 2GB of the
11703 text segment.
11704
11705 @item -mcmodel=embmedany
11706 @opindex mcmodel=embmedany
11707 Generate code for the Medium/Anywhere code model for embedded systems:
11708 64-bit addresses, the text and data segments must be less than 2GB in
11709 size, both starting anywhere in memory (determined at link time). The
11710 global register %g4 points to the base of the data segment. Programs
11711 are statically linked and PIC is not supported.
11712
11713 @item -mstack-bias
11714 @itemx -mno-stack-bias
11715 @opindex mstack-bias
11716 @opindex mno-stack-bias
11717 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
11718 frame pointer if present, are offset by @minus{}2047 which must be added back
11719 when making stack frame references. This is the default in 64-bit mode.
11720 Otherwise, assume no such offset is present.
11721 @end table
11722
11723 These switches are supported in addition to the above on Solaris:
11724
11725 @table @gcctabopt
11726 @item -threads
11727 @opindex threads
11728 Add support for multithreading using the Solaris threads library. This
11729 option sets flags for both the preprocessor and linker. This option does
11730 not affect the thread safety of object code produced by the compiler or
11731 that of libraries supplied with it.
11732
11733 @item -pthreads
11734 @opindex pthreads
11735 Add support for multithreading using the POSIX threads library. This
11736 option sets flags for both the preprocessor and linker. This option does
11737 not affect the thread safety of object code produced by the compiler or
11738 that of libraries supplied with it.
11739 @end table
11740
11741 @node System V Options
11742 @subsection Options for System V
11743
11744 These additional options are available on System V Release 4 for
11745 compatibility with other compilers on those systems:
11746
11747 @table @gcctabopt
11748 @item -G
11749 @opindex G
11750 Create a shared object.
11751 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
11752
11753 @item -Qy
11754 @opindex Qy
11755 Identify the versions of each tool used by the compiler, in a
11756 @code{.ident} assembler directive in the output.
11757
11758 @item -Qn
11759 @opindex Qn
11760 Refrain from adding @code{.ident} directives to the output file (this is
11761 the default).
11762
11763 @item -YP,@var{dirs}
11764 @opindex YP
11765 Search the directories @var{dirs}, and no others, for libraries
11766 specified with @option{-l}.
11767
11768 @item -Ym,@var{dir}
11769 @opindex Ym
11770 Look in the directory @var{dir} to find the M4 preprocessor.
11771 The assembler uses this option.
11772 @c This is supposed to go with a -Yd for predefined M4 macro files, but
11773 @c the generic assembler that comes with Solaris takes just -Ym.
11774 @end table
11775
11776 @node TMS320C3x/C4x Options
11777 @subsection TMS320C3x/C4x Options
11778 @cindex TMS320C3x/C4x Options
11779
11780 These @samp{-m} options are defined for TMS320C3x/C4x implementations:
11781
11782 @table @gcctabopt
11783
11784 @item -mcpu=@var{cpu_type}
11785 @opindex mcpu
11786 Set the instruction set, register set, and instruction scheduling
11787 parameters for machine type @var{cpu_type}. Supported values for
11788 @var{cpu_type} are @samp{c30}, @samp{c31}, @samp{c32}, @samp{c40}, and
11789 @samp{c44}. The default is @samp{c40} to generate code for the
11790 TMS320C40.
11791
11792 @item -mbig-memory
11793 @itemx -mbig
11794 @itemx -msmall-memory
11795 @itemx -msmall
11796 @opindex mbig-memory
11797 @opindex mbig
11798 @opindex msmall-memory
11799 @opindex msmall
11800 Generates code for the big or small memory model. The small memory
11801 model assumed that all data fits into one 64K word page. At run-time
11802 the data page (DP) register must be set to point to the 64K page
11803 containing the .bss and .data program sections. The big memory model is
11804 the default and requires reloading of the DP register for every direct
11805 memory access.
11806
11807 @item -mbk
11808 @itemx -mno-bk
11809 @opindex mbk
11810 @opindex mno-bk
11811 Allow (disallow) allocation of general integer operands into the block
11812 count register BK@.
11813
11814 @item -mdb
11815 @itemx -mno-db
11816 @opindex mdb
11817 @opindex mno-db
11818 Enable (disable) generation of code using decrement and branch,
11819 DBcond(D), instructions. This is enabled by default for the C4x. To be
11820 on the safe side, this is disabled for the C3x, since the maximum
11821 iteration count on the C3x is @math{2^{23} + 1} (but who iterates loops more than
11822 @math{2^{23}} times on the C3x?). Note that GCC will try to reverse a loop so
11823 that it can utilize the decrement and branch instruction, but will give
11824 up if there is more than one memory reference in the loop. Thus a loop
11825 where the loop counter is decremented can generate slightly more
11826 efficient code, in cases where the RPTB instruction cannot be utilized.
11827
11828 @item -mdp-isr-reload
11829 @itemx -mparanoid
11830 @opindex mdp-isr-reload
11831 @opindex mparanoid
11832 Force the DP register to be saved on entry to an interrupt service
11833 routine (ISR), reloaded to point to the data section, and restored on
11834 exit from the ISR@. This should not be required unless someone has
11835 violated the small memory model by modifying the DP register, say within
11836 an object library.
11837
11838 @item -mmpyi
11839 @itemx -mno-mpyi
11840 @opindex mmpyi
11841 @opindex mno-mpyi
11842 For the C3x use the 24-bit MPYI instruction for integer multiplies
11843 instead of a library call to guarantee 32-bit results. Note that if one
11844 of the operands is a constant, then the multiplication will be performed
11845 using shifts and adds. If the @option{-mmpyi} option is not specified for the C3x,
11846 then squaring operations are performed inline instead of a library call.
11847
11848 @item -mfast-fix
11849 @itemx -mno-fast-fix
11850 @opindex mfast-fix
11851 @opindex mno-fast-fix
11852 The C3x/C4x FIX instruction to convert a floating point value to an
11853 integer value chooses the nearest integer less than or equal to the
11854 floating point value rather than to the nearest integer. Thus if the
11855 floating point number is negative, the result will be incorrectly
11856 truncated an additional code is necessary to detect and correct this
11857 case. This option can be used to disable generation of the additional
11858 code required to correct the result.
11859
11860 @item -mrptb
11861 @itemx -mno-rptb
11862 @opindex mrptb
11863 @opindex mno-rptb
11864 Enable (disable) generation of repeat block sequences using the RPTB
11865 instruction for zero overhead looping. The RPTB construct is only used
11866 for innermost loops that do not call functions or jump across the loop
11867 boundaries. There is no advantage having nested RPTB loops due to the
11868 overhead required to save and restore the RC, RS, and RE registers.
11869 This is enabled by default with @option{-O2}.
11870
11871 @item -mrpts=@var{count}
11872 @itemx -mno-rpts
11873 @opindex mrpts
11874 @opindex mno-rpts
11875 Enable (disable) the use of the single instruction repeat instruction
11876 RPTS@. If a repeat block contains a single instruction, and the loop
11877 count can be guaranteed to be less than the value @var{count}, GCC will
11878 emit a RPTS instruction instead of a RPTB@. If no value is specified,
11879 then a RPTS will be emitted even if the loop count cannot be determined
11880 at compile time. Note that the repeated instruction following RPTS does
11881 not have to be reloaded from memory each iteration, thus freeing up the
11882 CPU buses for operands. However, since interrupts are blocked by this
11883 instruction, it is disabled by default.
11884
11885 @item -mloop-unsigned
11886 @itemx -mno-loop-unsigned
11887 @opindex mloop-unsigned
11888 @opindex mno-loop-unsigned
11889 The maximum iteration count when using RPTS and RPTB (and DB on the C40)
11890 is @math{2^{31} + 1} since these instructions test if the iteration count is
11891 negative to terminate the loop. If the iteration count is unsigned
11892 there is a possibility than the @math{2^{31} + 1} maximum iteration count may be
11893 exceeded. This switch allows an unsigned iteration count.
11894
11895 @item -mti
11896 @opindex mti
11897 Try to emit an assembler syntax that the TI assembler (asm30) is happy
11898 with. This also enforces compatibility with the API employed by the TI
11899 C3x C compiler. For example, long doubles are passed as structures
11900 rather than in floating point registers.
11901
11902 @item -mregparm
11903 @itemx -mmemparm
11904 @opindex mregparm
11905 @opindex mmemparm
11906 Generate code that uses registers (stack) for passing arguments to functions.
11907 By default, arguments are passed in registers where possible rather
11908 than by pushing arguments on to the stack.
11909
11910 @item -mparallel-insns
11911 @itemx -mno-parallel-insns
11912 @opindex mparallel-insns
11913 @opindex mno-parallel-insns
11914 Allow the generation of parallel instructions. This is enabled by
11915 default with @option{-O2}.
11916
11917 @item -mparallel-mpy
11918 @itemx -mno-parallel-mpy
11919 @opindex mparallel-mpy
11920 @opindex mno-parallel-mpy
11921 Allow the generation of MPY||ADD and MPY||SUB parallel instructions,
11922 provided @option{-mparallel-insns} is also specified. These instructions have
11923 tight register constraints which can pessimize the code generation
11924 of large functions.
11925
11926 @end table
11927
11928 @node V850 Options
11929 @subsection V850 Options
11930 @cindex V850 Options
11931
11932 These @samp{-m} options are defined for V850 implementations:
11933
11934 @table @gcctabopt
11935 @item -mlong-calls
11936 @itemx -mno-long-calls
11937 @opindex mlong-calls
11938 @opindex mno-long-calls
11939 Treat all calls as being far away (near). If calls are assumed to be
11940 far away, the compiler will always load the functions address up into a
11941 register, and call indirect through the pointer.
11942
11943 @item -mno-ep
11944 @itemx -mep
11945 @opindex mno-ep
11946 @opindex mep
11947 Do not optimize (do optimize) basic blocks that use the same index
11948 pointer 4 or more times to copy pointer into the @code{ep} register, and
11949 use the shorter @code{sld} and @code{sst} instructions. The @option{-mep}
11950 option is on by default if you optimize.
11951
11952 @item -mno-prolog-function
11953 @itemx -mprolog-function
11954 @opindex mno-prolog-function
11955 @opindex mprolog-function
11956 Do not use (do use) external functions to save and restore registers
11957 at the prologue and epilogue of a function. The external functions
11958 are slower, but use less code space if more than one function saves
11959 the same number of registers. The @option{-mprolog-function} option
11960 is on by default if you optimize.
11961
11962 @item -mspace
11963 @opindex mspace
11964 Try to make the code as small as possible. At present, this just turns
11965 on the @option{-mep} and @option{-mprolog-function} options.
11966
11967 @item -mtda=@var{n}
11968 @opindex mtda
11969 Put static or global variables whose size is @var{n} bytes or less into
11970 the tiny data area that register @code{ep} points to. The tiny data
11971 area can hold up to 256 bytes in total (128 bytes for byte references).
11972
11973 @item -msda=@var{n}
11974 @opindex msda
11975 Put static or global variables whose size is @var{n} bytes or less into
11976 the small data area that register @code{gp} points to. The small data
11977 area can hold up to 64 kilobytes.
11978
11979 @item -mzda=@var{n}
11980 @opindex mzda
11981 Put static or global variables whose size is @var{n} bytes or less into
11982 the first 32 kilobytes of memory.
11983
11984 @item -mv850
11985 @opindex mv850
11986 Specify that the target processor is the V850.
11987
11988 @item -mbig-switch
11989 @opindex mbig-switch
11990 Generate code suitable for big switch tables. Use this option only if
11991 the assembler/linker complain about out of range branches within a switch
11992 table.
11993
11994 @item -mapp-regs
11995 @opindex mapp-regs
11996 This option will cause r2 and r5 to be used in the code generated by
11997 the compiler. This setting is the default.
11998
11999 @item -mno-app-regs
12000 @opindex mno-app-regs
12001 This option will cause r2 and r5 to be treated as fixed registers.
12002
12003 @item -mv850e1
12004 @opindex mv850e1
12005 Specify that the target processor is the V850E1. The preprocessor
12006 constants @samp{__v850e1__} and @samp{__v850e__} will be defined if
12007 this option is used.
12008
12009 @item -mv850e
12010 @opindex mv850e
12011 Specify that the target processor is the V850E@. The preprocessor
12012 constant @samp{__v850e__} will be defined if this option is used.
12013
12014 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
12015 are defined then a default target processor will be chosen and the
12016 relevant @samp{__v850*__} preprocessor constant will be defined.
12017
12018 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
12019 defined, regardless of which processor variant is the target.
12020
12021 @item -mdisable-callt
12022 @opindex mdisable-callt
12023 This option will suppress generation of the CALLT instruction for the
12024 v850e and v850e1 flavors of the v850 architecture. The default is
12025 @option{-mno-disable-callt} which allows the CALLT instruction to be used.
12026
12027 @end table
12028
12029 @node VAX Options
12030 @subsection VAX Options
12031 @cindex VAX options
12032
12033 These @samp{-m} options are defined for the VAX:
12034
12035 @table @gcctabopt
12036 @item -munix
12037 @opindex munix
12038 Do not output certain jump instructions (@code{aobleq} and so on)
12039 that the Unix assembler for the VAX cannot handle across long
12040 ranges.
12041
12042 @item -mgnu
12043 @opindex mgnu
12044 Do output those jump instructions, on the assumption that you
12045 will assemble with the GNU assembler.
12046
12047 @item -mg
12048 @opindex mg
12049 Output code for g-format floating point numbers instead of d-format.
12050 @end table
12051
12052 @node x86-64 Options
12053 @subsection x86-64 Options
12054 @cindex x86-64 options
12055
12056 These are listed under @xref{i386 and x86-64 Options}.
12057
12058 @node Xstormy16 Options
12059 @subsection Xstormy16 Options
12060 @cindex Xstormy16 Options
12061
12062 These options are defined for Xstormy16:
12063
12064 @table @gcctabopt
12065 @item -msim
12066 @opindex msim
12067 Choose startup files and linker script suitable for the simulator.
12068 @end table
12069
12070 @node Xtensa Options
12071 @subsection Xtensa Options
12072 @cindex Xtensa Options
12073
12074 These options are supported for Xtensa targets:
12075
12076 @table @gcctabopt
12077 @item -mconst16
12078 @itemx -mno-const16
12079 @opindex mconst16
12080 @opindex mno-const16
12081 Enable or disable use of @code{CONST16} instructions for loading
12082 constant values. The @code{CONST16} instruction is currently not a
12083 standard option from Tensilica. When enabled, @code{CONST16}
12084 instructions are always used in place of the standard @code{L32R}
12085 instructions. The use of @code{CONST16} is enabled by default only if
12086 the @code{L32R} instruction is not available.
12087
12088 @item -mfused-madd
12089 @itemx -mno-fused-madd
12090 @opindex mfused-madd
12091 @opindex mno-fused-madd
12092 Enable or disable use of fused multiply/add and multiply/subtract
12093 instructions in the floating-point option. This has no effect if the
12094 floating-point option is not also enabled. Disabling fused multiply/add
12095 and multiply/subtract instructions forces the compiler to use separate
12096 instructions for the multiply and add/subtract operations. This may be
12097 desirable in some cases where strict IEEE 754-compliant results are
12098 required: the fused multiply add/subtract instructions do not round the
12099 intermediate result, thereby producing results with @emph{more} bits of
12100 precision than specified by the IEEE standard. Disabling fused multiply
12101 add/subtract instructions also ensures that the program output is not
12102 sensitive to the compiler's ability to combine multiply and add/subtract
12103 operations.
12104
12105 @item -mtext-section-literals
12106 @itemx -mno-text-section-literals
12107 @opindex mtext-section-literals
12108 @opindex mno-text-section-literals
12109 Control the treatment of literal pools. The default is
12110 @option{-mno-text-section-literals}, which places literals in a separate
12111 section in the output file. This allows the literal pool to be placed
12112 in a data RAM/ROM, and it also allows the linker to combine literal
12113 pools from separate object files to remove redundant literals and
12114 improve code size. With @option{-mtext-section-literals}, the literals
12115 are interspersed in the text section in order to keep them as close as
12116 possible to their references. This may be necessary for large assembly
12117 files.
12118
12119 @item -mtarget-align
12120 @itemx -mno-target-align
12121 @opindex mtarget-align
12122 @opindex mno-target-align
12123 When this option is enabled, GCC instructs the assembler to
12124 automatically align instructions to reduce branch penalties at the
12125 expense of some code density. The assembler attempts to widen density
12126 instructions to align branch targets and the instructions following call
12127 instructions. If there are not enough preceding safe density
12128 instructions to align a target, no widening will be performed. The
12129 default is @option{-mtarget-align}. These options do not affect the
12130 treatment of auto-aligned instructions like @code{LOOP}, which the
12131 assembler will always align, either by widening density instructions or
12132 by inserting no-op instructions.
12133
12134 @item -mlongcalls
12135 @itemx -mno-longcalls
12136 @opindex mlongcalls
12137 @opindex mno-longcalls
12138 When this option is enabled, GCC instructs the assembler to translate
12139 direct calls to indirect calls unless it can determine that the target
12140 of a direct call is in the range allowed by the call instruction. This
12141 translation typically occurs for calls to functions in other source
12142 files. Specifically, the assembler translates a direct @code{CALL}
12143 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
12144 The default is @option{-mno-longcalls}. This option should be used in
12145 programs where the call target can potentially be out of range. This
12146 option is implemented in the assembler, not the compiler, so the
12147 assembly code generated by GCC will still show direct call
12148 instructions---look at the disassembled object code to see the actual
12149 instructions. Note that the assembler will use an indirect call for
12150 every cross-file call, not just those that really will be out of range.
12151 @end table
12152
12153 @node zSeries Options
12154 @subsection zSeries Options
12155 @cindex zSeries options
12156
12157 These are listed under @xref{S/390 and zSeries Options}.
12158
12159 @node Code Gen Options
12160 @section Options for Code Generation Conventions
12161 @cindex code generation conventions
12162 @cindex options, code generation
12163 @cindex run-time options
12164
12165 These machine-independent options control the interface conventions
12166 used in code generation.
12167
12168 Most of them have both positive and negative forms; the negative form
12169 of @option{-ffoo} would be @option{-fno-foo}. In the table below, only
12170 one of the forms is listed---the one which is not the default. You
12171 can figure out the other form by either removing @samp{no-} or adding
12172 it.
12173
12174 @table @gcctabopt
12175 @item -fbounds-check
12176 @opindex fbounds-check
12177 For front-ends that support it, generate additional code to check that
12178 indices used to access arrays are within the declared range. This is
12179 currently only supported by the Java and Fortran 77 front-ends, where
12180 this option defaults to true and false respectively.
12181
12182 @item -ftrapv
12183 @opindex ftrapv
12184 This option generates traps for signed overflow on addition, subtraction,
12185 multiplication operations.
12186
12187 @item -fwrapv
12188 @opindex fwrapv
12189 This option instructs the compiler to assume that signed arithmetic
12190 overflow of addition, subtraction and multiplication wraps around
12191 using twos-complement representation. This flag enables some optimizations
12192 and disables other. This option is enabled by default for the Java
12193 front-end, as required by the Java language specification.
12194
12195 @item -fexceptions
12196 @opindex fexceptions
12197 Enable exception handling. Generates extra code needed to propagate
12198 exceptions. For some targets, this implies GCC will generate frame
12199 unwind information for all functions, which can produce significant data
12200 size overhead, although it does not affect execution. If you do not
12201 specify this option, GCC will enable it by default for languages like
12202 C++ which normally require exception handling, and disable it for
12203 languages like C that do not normally require it. However, you may need
12204 to enable this option when compiling C code that needs to interoperate
12205 properly with exception handlers written in C++. You may also wish to
12206 disable this option if you are compiling older C++ programs that don't
12207 use exception handling.
12208
12209 @item -fnon-call-exceptions
12210 @opindex fnon-call-exceptions
12211 Generate code that allows trapping instructions to throw exceptions.
12212 Note that this requires platform-specific runtime support that does
12213 not exist everywhere. Moreover, it only allows @emph{trapping}
12214 instructions to throw exceptions, i.e.@: memory references or floating
12215 point instructions. It does not allow exceptions to be thrown from
12216 arbitrary signal handlers such as @code{SIGALRM}.
12217
12218 @item -funwind-tables
12219 @opindex funwind-tables
12220 Similar to @option{-fexceptions}, except that it will just generate any needed
12221 static data, but will not affect the generated code in any other way.
12222 You will normally not enable this option; instead, a language processor
12223 that needs this handling would enable it on your behalf.
12224
12225 @item -fasynchronous-unwind-tables
12226 @opindex fasynchronous-unwind-tables
12227 Generate unwind table in dwarf2 format, if supported by target machine. The
12228 table is exact at each instruction boundary, so it can be used for stack
12229 unwinding from asynchronous events (such as debugger or garbage collector).
12230
12231 @item -fpcc-struct-return
12232 @opindex fpcc-struct-return
12233 Return ``short'' @code{struct} and @code{union} values in memory like
12234 longer ones, rather than in registers. This convention is less
12235 efficient, but it has the advantage of allowing intercallability between
12236 GCC-compiled files and files compiled with other compilers, particularly
12237 the Portable C Compiler (pcc).
12238
12239 The precise convention for returning structures in memory depends
12240 on the target configuration macros.
12241
12242 Short structures and unions are those whose size and alignment match
12243 that of some integer type.
12244
12245 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
12246 switch is not binary compatible with code compiled with the
12247 @option{-freg-struct-return} switch.
12248 Use it to conform to a non-default application binary interface.
12249
12250 @item -freg-struct-return
12251 @opindex freg-struct-return
12252 Return @code{struct} and @code{union} values in registers when possible.
12253 This is more efficient for small structures than
12254 @option{-fpcc-struct-return}.
12255
12256 If you specify neither @option{-fpcc-struct-return} nor
12257 @option{-freg-struct-return}, GCC defaults to whichever convention is
12258 standard for the target. If there is no standard convention, GCC
12259 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
12260 the principal compiler. In those cases, we can choose the standard, and
12261 we chose the more efficient register return alternative.
12262
12263 @strong{Warning:} code compiled with the @option{-freg-struct-return}
12264 switch is not binary compatible with code compiled with the
12265 @option{-fpcc-struct-return} switch.
12266 Use it to conform to a non-default application binary interface.
12267
12268 @item -fshort-enums
12269 @opindex fshort-enums
12270 Allocate to an @code{enum} type only as many bytes as it needs for the
12271 declared range of possible values. Specifically, the @code{enum} type
12272 will be equivalent to the smallest integer type which has enough room.
12273
12274 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
12275 code that is not binary compatible with code generated without that switch.
12276 Use it to conform to a non-default application binary interface.
12277
12278 @item -fshort-double
12279 @opindex fshort-double
12280 Use the same size for @code{double} as for @code{float}.
12281
12282 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
12283 code that is not binary compatible with code generated without that switch.
12284 Use it to conform to a non-default application binary interface.
12285
12286 @item -fshort-wchar
12287 @opindex fshort-wchar
12288 Override the underlying type for @samp{wchar_t} to be @samp{short
12289 unsigned int} instead of the default for the target. This option is
12290 useful for building programs to run under WINE@.
12291
12292 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
12293 code that is not binary compatible with code generated without that switch.
12294 Use it to conform to a non-default application binary interface.
12295
12296 @item -fshared-data
12297 @opindex fshared-data
12298 Requests that the data and non-@code{const} variables of this
12299 compilation be shared data rather than private data. The distinction
12300 makes sense only on certain operating systems, where shared data is
12301 shared between processes running the same program, while private data
12302 exists in one copy per process.
12303
12304 @item -fno-common
12305 @opindex fno-common
12306 In C, allocate even uninitialized global variables in the data section of the
12307 object file, rather than generating them as common blocks. This has the
12308 effect that if the same variable is declared (without @code{extern}) in
12309 two different compilations, you will get an error when you link them.
12310 The only reason this might be useful is if you wish to verify that the
12311 program will work on other systems which always work this way.
12312
12313 @item -fno-ident
12314 @opindex fno-ident
12315 Ignore the @samp{#ident} directive.
12316
12317 @item -finhibit-size-directive
12318 @opindex finhibit-size-directive
12319 Don't output a @code{.size} assembler directive, or anything else that
12320 would cause trouble if the function is split in the middle, and the
12321 two halves are placed at locations far apart in memory. This option is
12322 used when compiling @file{crtstuff.c}; you should not need to use it
12323 for anything else.
12324
12325 @item -fverbose-asm
12326 @opindex fverbose-asm
12327 Put extra commentary information in the generated assembly code to
12328 make it more readable. This option is generally only of use to those
12329 who actually need to read the generated assembly code (perhaps while
12330 debugging the compiler itself).
12331
12332 @option{-fno-verbose-asm}, the default, causes the
12333 extra information to be omitted and is useful when comparing two assembler
12334 files.
12335
12336 @item -fpic
12337 @opindex fpic
12338 @cindex global offset table
12339 @cindex PIC
12340 Generate position-independent code (PIC) suitable for use in a shared
12341 library, if supported for the target machine. Such code accesses all
12342 constant addresses through a global offset table (GOT)@. The dynamic
12343 loader resolves the GOT entries when the program starts (the dynamic
12344 loader is not part of GCC; it is part of the operating system). If
12345 the GOT size for the linked executable exceeds a machine-specific
12346 maximum size, you get an error message from the linker indicating that
12347 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
12348 instead. (These maximums are 8k on the SPARC and 32k
12349 on the m68k and RS/6000. The 386 has no such limit.)
12350
12351 Position-independent code requires special support, and therefore works
12352 only on certain machines. For the 386, GCC supports PIC for System V
12353 but not for the Sun 386i. Code generated for the IBM RS/6000 is always
12354 position-independent.
12355
12356 @item -fPIC
12357 @opindex fPIC
12358 If supported for the target machine, emit position-independent code,
12359 suitable for dynamic linking and avoiding any limit on the size of the
12360 global offset table. This option makes a difference on the m68k,
12361 PowerPC and SPARC@.
12362
12363 Position-independent code requires special support, and therefore works
12364 only on certain machines.
12365
12366 @item -fpie
12367 @itemx -fPIE
12368 @opindex fpie
12369 @opindex fPIE
12370 These options are similar to @option{-fpic} and @option{-fPIC}, but
12371 generated position independent code can be only linked into executables.
12372 Usually these options are used when @option{-pie} GCC option will be
12373 used during linking.
12374
12375 @item -ffixed-@var{reg}
12376 @opindex ffixed
12377 Treat the register named @var{reg} as a fixed register; generated code
12378 should never refer to it (except perhaps as a stack pointer, frame
12379 pointer or in some other fixed role).
12380
12381 @var{reg} must be the name of a register. The register names accepted
12382 are machine-specific and are defined in the @code{REGISTER_NAMES}
12383 macro in the machine description macro file.
12384
12385 This flag does not have a negative form, because it specifies a
12386 three-way choice.
12387
12388 @item -fcall-used-@var{reg}
12389 @opindex fcall-used
12390 Treat the register named @var{reg} as an allocable register that is
12391 clobbered by function calls. It may be allocated for temporaries or
12392 variables that do not live across a call. Functions compiled this way
12393 will not save and restore the register @var{reg}.
12394
12395 It is an error to used this flag with the frame pointer or stack pointer.
12396 Use of this flag for other registers that have fixed pervasive roles in
12397 the machine's execution model will produce disastrous results.
12398
12399 This flag does not have a negative form, because it specifies a
12400 three-way choice.
12401
12402 @item -fcall-saved-@var{reg}
12403 @opindex fcall-saved
12404 Treat the register named @var{reg} as an allocable register saved by
12405 functions. It may be allocated even for temporaries or variables that
12406 live across a call. Functions compiled this way will save and restore
12407 the register @var{reg} if they use it.
12408
12409 It is an error to used this flag with the frame pointer or stack pointer.
12410 Use of this flag for other registers that have fixed pervasive roles in
12411 the machine's execution model will produce disastrous results.
12412
12413 A different sort of disaster will result from the use of this flag for
12414 a register in which function values may be returned.
12415
12416 This flag does not have a negative form, because it specifies a
12417 three-way choice.
12418
12419 @item -fpack-struct[=@var{n}]
12420 @opindex fpack-struct
12421 Without a value specified, pack all structure members together without
12422 holes. When a value is specified (which must be a small power of two), pack
12423 structure members according to this value, representing the maximum
12424 alignment (that is, objects with default alignment requirements larger than
12425 this will be output potentially unaligned at the next fitting location.
12426
12427 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
12428 code that is not binary compatible with code generated without that switch.
12429 Additionally, it makes the code suboptimal.
12430 Use it to conform to a non-default application binary interface.
12431
12432 @item -finstrument-functions
12433 @opindex finstrument-functions
12434 Generate instrumentation calls for entry and exit to functions. Just
12435 after function entry and just before function exit, the following
12436 profiling functions will be called with the address of the current
12437 function and its call site. (On some platforms,
12438 @code{__builtin_return_address} does not work beyond the current
12439 function, so the call site information may not be available to the
12440 profiling functions otherwise.)
12441
12442 @smallexample
12443 void __cyg_profile_func_enter (void *this_fn,
12444 void *call_site);
12445 void __cyg_profile_func_exit (void *this_fn,
12446 void *call_site);
12447 @end smallexample
12448
12449 The first argument is the address of the start of the current function,
12450 which may be looked up exactly in the symbol table.
12451
12452 This instrumentation is also done for functions expanded inline in other
12453 functions. The profiling calls will indicate where, conceptually, the
12454 inline function is entered and exited. This means that addressable
12455 versions of such functions must be available. If all your uses of a
12456 function are expanded inline, this may mean an additional expansion of
12457 code size. If you use @samp{extern inline} in your C code, an
12458 addressable version of such functions must be provided. (This is
12459 normally the case anyways, but if you get lucky and the optimizer always
12460 expands the functions inline, you might have gotten away without
12461 providing static copies.)
12462
12463 A function may be given the attribute @code{no_instrument_function}, in
12464 which case this instrumentation will not be done. This can be used, for
12465 example, for the profiling functions listed above, high-priority
12466 interrupt routines, and any functions from which the profiling functions
12467 cannot safely be called (perhaps signal handlers, if the profiling
12468 routines generate output or allocate memory).
12469
12470 @item -fstack-check
12471 @opindex fstack-check
12472 Generate code to verify that you do not go beyond the boundary of the
12473 stack. You should specify this flag if you are running in an
12474 environment with multiple threads, but only rarely need to specify it in
12475 a single-threaded environment since stack overflow is automatically
12476 detected on nearly all systems if there is only one stack.
12477
12478 Note that this switch does not actually cause checking to be done; the
12479 operating system must do that. The switch causes generation of code
12480 to ensure that the operating system sees the stack being extended.
12481
12482 @item -fstack-limit-register=@var{reg}
12483 @itemx -fstack-limit-symbol=@var{sym}
12484 @itemx -fno-stack-limit
12485 @opindex fstack-limit-register
12486 @opindex fstack-limit-symbol
12487 @opindex fno-stack-limit
12488 Generate code to ensure that the stack does not grow beyond a certain value,
12489 either the value of a register or the address of a symbol. If the stack
12490 would grow beyond the value, a signal is raised. For most targets,
12491 the signal is raised before the stack overruns the boundary, so
12492 it is possible to catch the signal without taking special precautions.
12493
12494 For instance, if the stack starts at absolute address @samp{0x80000000}
12495 and grows downwards, you can use the flags
12496 @option{-fstack-limit-symbol=__stack_limit} and
12497 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
12498 of 128KB@. Note that this may only work with the GNU linker.
12499
12500 @cindex aliasing of parameters
12501 @cindex parameters, aliased
12502 @item -fargument-alias
12503 @itemx -fargument-noalias
12504 @itemx -fargument-noalias-global
12505 @opindex fargument-alias
12506 @opindex fargument-noalias
12507 @opindex fargument-noalias-global
12508 Specify the possible relationships among parameters and between
12509 parameters and global data.
12510
12511 @option{-fargument-alias} specifies that arguments (parameters) may
12512 alias each other and may alias global storage.@*
12513 @option{-fargument-noalias} specifies that arguments do not alias
12514 each other, but may alias global storage.@*
12515 @option{-fargument-noalias-global} specifies that arguments do not
12516 alias each other and do not alias global storage.
12517
12518 Each language will automatically use whatever option is required by
12519 the language standard. You should not need to use these options yourself.
12520
12521 @item -fleading-underscore
12522 @opindex fleading-underscore
12523 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
12524 change the way C symbols are represented in the object file. One use
12525 is to help link with legacy assembly code.
12526
12527 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
12528 generate code that is not binary compatible with code generated without that
12529 switch. Use it to conform to a non-default application binary interface.
12530 Not all targets provide complete support for this switch.
12531
12532 @item -ftls-model=@var{model}
12533 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
12534 The @var{model} argument should be one of @code{global-dynamic},
12535 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
12536
12537 The default without @option{-fpic} is @code{initial-exec}; with
12538 @option{-fpic} the default is @code{global-dynamic}.
12539
12540 @item -fvisibility=@var{default|internal|hidden|protected}
12541 @opindex fvisibility
12542 Set the default ELF image symbol visibility to the specified option---all
12543 symbols will be marked with this unless overridden within the code.
12544 Using this feature can very substantially improve linking and
12545 load times of shared object libraries, produce more optimized
12546 code, provide near-perfect API export and prevent symbol clashes.
12547 It is @strong{strongly} recommended that you use this in any shared objects
12548 you distribute.
12549
12550 Despite the nomenclature, @code{default} always means public ie;
12551 available to be linked against from outside the shared object.
12552 @code{protected} and @code{internal} are pretty useless in real-world
12553 usage so the only other commonly used option will be @code{hidden}.
12554 The default if @option{-fvisibility} isn't specified is
12555 @code{default}, i.e., make every
12556 symbol public---this causes the same behavior as previous versions of
12557 GCC@.
12558
12559 A good explanation of the benefits offered by ensuring ELF
12560 symbols have the correct visibility is given by ``How To Write
12561 Shared Libraries'' by Ulrich Drepper (which can be found at
12562 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
12563 solution made possible by this option to marking things hidden when
12564 the default is public is to make the default hidden and mark things
12565 public. This is the norm with DLL's on Windows and with @option{-fvisibility=hidden}
12566 and @code{__attribute__ ((visibility("default")))} instead of
12567 @code{__declspec(dllexport)} you get almost identical semantics with
12568 identical syntax. This is a great boon to those working with
12569 cross-platform projects.
12570
12571 For those adding visibility support to existing code, you may find
12572 @samp{#pragma GCC visibility} of use. This works by you enclosing
12573 the declarations you wish to set visibility for with (for example)
12574 @samp{#pragma GCC visibility push(hidden)} and
12575 @samp{#pragma GCC visibility pop}. These can be nested up to sixteen
12576 times. Bear in mind that symbol visibility should be viewed @strong{as
12577 part of the API interface contract} and thus all new code should
12578 always specify visibility when it is not the default ie; declarations
12579 only for use within the local DSO should @strong{always} be marked explicitly
12580 as hidden as so to avoid PLT indirection overheads---making this
12581 abundantly clear also aids readability and self-documentation of the code.
12582 Note that due to ISO C++ specification requirements, operator new and
12583 operator delete must always be of default visibility.
12584
12585 An overview of these techniques, their benefits and how to use them
12586 is at @w{@uref{http://gcc.gnu.org/wiki/Visibility}}.
12587
12588 @end table
12589
12590 @c man end
12591
12592 @node Environment Variables
12593 @section Environment Variables Affecting GCC
12594 @cindex environment variables
12595
12596 @c man begin ENVIRONMENT
12597 This section describes several environment variables that affect how GCC
12598 operates. Some of them work by specifying directories or prefixes to use
12599 when searching for various kinds of files. Some are used to specify other
12600 aspects of the compilation environment.
12601
12602 Note that you can also specify places to search using options such as
12603 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}). These
12604 take precedence over places specified using environment variables, which
12605 in turn take precedence over those specified by the configuration of GCC@.
12606 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
12607 GNU Compiler Collection (GCC) Internals}.
12608
12609 @table @env
12610 @item LANG
12611 @itemx LC_CTYPE
12612 @c @itemx LC_COLLATE
12613 @itemx LC_MESSAGES
12614 @c @itemx LC_MONETARY
12615 @c @itemx LC_NUMERIC
12616 @c @itemx LC_TIME
12617 @itemx LC_ALL
12618 @findex LANG
12619 @findex LC_CTYPE
12620 @c @findex LC_COLLATE
12621 @findex LC_MESSAGES
12622 @c @findex LC_MONETARY
12623 @c @findex LC_NUMERIC
12624 @c @findex LC_TIME
12625 @findex LC_ALL
12626 @cindex locale
12627 These environment variables control the way that GCC uses
12628 localization information that allow GCC to work with different
12629 national conventions. GCC inspects the locale categories
12630 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
12631 so. These locale categories can be set to any value supported by your
12632 installation. A typical value is @samp{en_GB.UTF-8} for English in the United
12633 Kingdom encoded in UTF-8.
12634
12635 The @env{LC_CTYPE} environment variable specifies character
12636 classification. GCC uses it to determine the character boundaries in
12637 a string; this is needed for some multibyte encodings that contain quote
12638 and escape characters that would otherwise be interpreted as a string
12639 end or escape.
12640
12641 The @env{LC_MESSAGES} environment variable specifies the language to
12642 use in diagnostic messages.
12643
12644 If the @env{LC_ALL} environment variable is set, it overrides the value
12645 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
12646 and @env{LC_MESSAGES} default to the value of the @env{LANG}
12647 environment variable. If none of these variables are set, GCC
12648 defaults to traditional C English behavior.
12649
12650 @item TMPDIR
12651 @findex TMPDIR
12652 If @env{TMPDIR} is set, it specifies the directory to use for temporary
12653 files. GCC uses temporary files to hold the output of one stage of
12654 compilation which is to be used as input to the next stage: for example,
12655 the output of the preprocessor, which is the input to the compiler
12656 proper.
12657
12658 @item GCC_EXEC_PREFIX
12659 @findex GCC_EXEC_PREFIX
12660 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
12661 names of the subprograms executed by the compiler. No slash is added
12662 when this prefix is combined with the name of a subprogram, but you can
12663 specify a prefix that ends with a slash if you wish.
12664
12665 If @env{GCC_EXEC_PREFIX} is not set, GCC will attempt to figure out
12666 an appropriate prefix to use based on the pathname it was invoked with.
12667
12668 If GCC cannot find the subprogram using the specified prefix, it
12669 tries looking in the usual places for the subprogram.
12670
12671 The default value of @env{GCC_EXEC_PREFIX} is
12672 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the value
12673 of @code{prefix} when you ran the @file{configure} script.
12674
12675 Other prefixes specified with @option{-B} take precedence over this prefix.
12676
12677 This prefix is also used for finding files such as @file{crt0.o} that are
12678 used for linking.
12679
12680 In addition, the prefix is used in an unusual way in finding the
12681 directories to search for header files. For each of the standard
12682 directories whose name normally begins with @samp{/usr/local/lib/gcc}
12683 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
12684 replacing that beginning with the specified prefix to produce an
12685 alternate directory name. Thus, with @option{-Bfoo/}, GCC will search
12686 @file{foo/bar} where it would normally search @file{/usr/local/lib/bar}.
12687 These alternate directories are searched first; the standard directories
12688 come next.
12689
12690 @item COMPILER_PATH
12691 @findex COMPILER_PATH
12692 The value of @env{COMPILER_PATH} is a colon-separated list of
12693 directories, much like @env{PATH}. GCC tries the directories thus
12694 specified when searching for subprograms, if it can't find the
12695 subprograms using @env{GCC_EXEC_PREFIX}.
12696
12697 @item LIBRARY_PATH
12698 @findex LIBRARY_PATH
12699 The value of @env{LIBRARY_PATH} is a colon-separated list of
12700 directories, much like @env{PATH}. When configured as a native compiler,
12701 GCC tries the directories thus specified when searching for special
12702 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}. Linking
12703 using GCC also uses these directories when searching for ordinary
12704 libraries for the @option{-l} option (but directories specified with
12705 @option{-L} come first).
12706
12707 @item LANG
12708 @findex LANG
12709 @cindex locale definition
12710 This variable is used to pass locale information to the compiler. One way in
12711 which this information is used is to determine the character set to be used
12712 when character literals, string literals and comments are parsed in C and C++.
12713 When the compiler is configured to allow multibyte characters,
12714 the following values for @env{LANG} are recognized:
12715
12716 @table @samp
12717 @item C-JIS
12718 Recognize JIS characters.
12719 @item C-SJIS
12720 Recognize SJIS characters.
12721 @item C-EUCJP
12722 Recognize EUCJP characters.
12723 @end table
12724
12725 If @env{LANG} is not defined, or if it has some other value, then the
12726 compiler will use mblen and mbtowc as defined by the default locale to
12727 recognize and translate multibyte characters.
12728 @end table
12729
12730 @noindent
12731 Some additional environments variables affect the behavior of the
12732 preprocessor.
12733
12734 @include cppenv.texi
12735
12736 @c man end
12737
12738 @node Precompiled Headers
12739 @section Using Precompiled Headers
12740 @cindex precompiled headers
12741 @cindex speed of compilation
12742
12743 Often large projects have many header files that are included in every
12744 source file. The time the compiler takes to process these header files
12745 over and over again can account for nearly all of the time required to
12746 build the project. To make builds faster, GCC allows users to
12747 `precompile' a header file; then, if builds can use the precompiled
12748 header file they will be much faster.
12749
12750 @strong{Caution:} There are a few known situations where GCC will
12751 crash when trying to use a precompiled header. If you have trouble
12752 with a precompiled header, you should remove the precompiled header
12753 and compile without it. In addition, please use GCC's on-line
12754 defect-tracking system to report any problems you encounter with
12755 precompiled headers. @xref{Bugs}.
12756
12757 To create a precompiled header file, simply compile it as you would any
12758 other file, if necessary using the @option{-x} option to make the driver
12759 treat it as a C or C++ header file. You will probably want to use a
12760 tool like @command{make} to keep the precompiled header up-to-date when
12761 the headers it contains change.
12762
12763 A precompiled header file will be searched for when @code{#include} is
12764 seen in the compilation. As it searches for the included file
12765 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
12766 compiler looks for a precompiled header in each directory just before it
12767 looks for the include file in that directory. The name searched for is
12768 the name specified in the @code{#include} with @samp{.gch} appended. If
12769 the precompiled header file can't be used, it is ignored.
12770
12771 For instance, if you have @code{#include "all.h"}, and you have
12772 @file{all.h.gch} in the same directory as @file{all.h}, then the
12773 precompiled header file will be used if possible, and the original
12774 header will be used otherwise.
12775
12776 Alternatively, you might decide to put the precompiled header file in a
12777 directory and use @option{-I} to ensure that directory is searched
12778 before (or instead of) the directory containing the original header.
12779 Then, if you want to check that the precompiled header file is always
12780 used, you can put a file of the same name as the original header in this
12781 directory containing an @code{#error} command.
12782
12783 This also works with @option{-include}. So yet another way to use
12784 precompiled headers, good for projects not designed with precompiled
12785 header files in mind, is to simply take most of the header files used by
12786 a project, include them from another header file, precompile that header
12787 file, and @option{-include} the precompiled header. If the header files
12788 have guards against multiple inclusion, they will be skipped because
12789 they've already been included (in the precompiled header).
12790
12791 If you need to precompile the same header file for different
12792 languages, targets, or compiler options, you can instead make a
12793 @emph{directory} named like @file{all.h.gch}, and put each precompiled
12794 header in the directory, perhaps using @option{-o}. It doesn't matter
12795 what you call the files in the directory, every precompiled header in
12796 the directory will be considered. The first precompiled header
12797 encountered in the directory that is valid for this compilation will
12798 be used; they're searched in no particular order.
12799
12800 There are many other possibilities, limited only by your imagination,
12801 good sense, and the constraints of your build system.
12802
12803 A precompiled header file can be used only when these conditions apply:
12804
12805 @itemize
12806 @item
12807 Only one precompiled header can be used in a particular compilation.
12808
12809 @item
12810 A precompiled header can't be used once the first C token is seen. You
12811 can have preprocessor directives before a precompiled header; you can
12812 even include a precompiled header from inside another header, so long as
12813 there are no C tokens before the @code{#include}.
12814
12815 @item
12816 The precompiled header file must be produced for the same language as
12817 the current compilation. You can't use a C precompiled header for a C++
12818 compilation.
12819
12820 @item
12821 The precompiled header file must be produced by the same compiler
12822 version and configuration as the current compilation is using.
12823 The easiest way to guarantee this is to use the same compiler binary
12824 for creating and using precompiled headers.
12825
12826 @item
12827 Any macros defined before the precompiled header is included must
12828 either be defined in the same way as when the precompiled header was
12829 generated, or must not affect the precompiled header, which usually
12830 means that they don't appear in the precompiled header at all.
12831
12832 The @option{-D} option is one way to define a macro before a
12833 precompiled header is included; using a @code{#define} can also do it.
12834 There are also some options that define macros implicitly, like
12835 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
12836 defined this way.
12837
12838 @item If debugging information is output when using the precompiled
12839 header, using @option{-g} or similar, the same kind of debugging information
12840 must have been output when building the precompiled header. However,
12841 a precompiled header built using @option{-g} can be used in a compilation
12842 when no debugging information is being output.
12843
12844 @item The same @option{-m} options must generally be used when building
12845 and using the precompiled header. @xref{Submodel Options},
12846 for any cases where this rule is relaxed.
12847
12848 @item Each of the following options must be the same when building and using
12849 the precompiled header:
12850
12851 @gccoptlist{-fexceptions -funit-at-a-time}
12852
12853 @item
12854 Some other command-line options starting with @option{-f},
12855 @option{-p}, or @option{-O} must be defined in the same way as when
12856 the precompiled header was generated. At present, it's not clear
12857 which options are safe to change and which are not; the safest choice
12858 is to use exactly the same options when generating and using the
12859 precompiled header. The following are known to be safe:
12860
12861 @gccoptlist{-fpreprocessed -pedantic-errors}
12862
12863 @end itemize
12864
12865 For all of these except the last, the compiler will automatically
12866 ignore the precompiled header if the conditions aren't met. If you
12867 find an option combination that doesn't work and doesn't cause the
12868 precompiled header to be ignored, please consider filing a bug report,
12869 see @ref{Bugs}.
12870
12871 If you do use differing options when generating and using the
12872 precompiled header, the actual behavior will be a mixture of the
12873 behavior for the options. For instance, if you use @option{-g} to
12874 generate the precompiled header but not when using it, you may or may
12875 not get debugging information for routines in the precompiled header.
12876
12877 @node Running Protoize
12878 @section Running Protoize
12879
12880 The program @code{protoize} is an optional part of GCC@. You can use
12881 it to add prototypes to a program, thus converting the program to ISO
12882 C in one respect. The companion program @code{unprotoize} does the
12883 reverse: it removes argument types from any prototypes that are found.
12884
12885 When you run these programs, you must specify a set of source files as
12886 command line arguments. The conversion programs start out by compiling
12887 these files to see what functions they define. The information gathered
12888 about a file @var{foo} is saved in a file named @file{@var{foo}.X}.
12889
12890 After scanning comes actual conversion. The specified files are all
12891 eligible to be converted; any files they include (whether sources or
12892 just headers) are eligible as well.
12893
12894 But not all the eligible files are converted. By default,
12895 @code{protoize} and @code{unprotoize} convert only source and header
12896 files in the current directory. You can specify additional directories
12897 whose files should be converted with the @option{-d @var{directory}}
12898 option. You can also specify particular files to exclude with the
12899 @option{-x @var{file}} option. A file is converted if it is eligible, its
12900 directory name matches one of the specified directory names, and its
12901 name within the directory has not been excluded.
12902
12903 Basic conversion with @code{protoize} consists of rewriting most
12904 function definitions and function declarations to specify the types of
12905 the arguments. The only ones not rewritten are those for varargs
12906 functions.
12907
12908 @code{protoize} optionally inserts prototype declarations at the
12909 beginning of the source file, to make them available for any calls that
12910 precede the function's definition. Or it can insert prototype
12911 declarations with block scope in the blocks where undeclared functions
12912 are called.
12913
12914 Basic conversion with @code{unprotoize} consists of rewriting most
12915 function declarations to remove any argument types, and rewriting
12916 function definitions to the old-style pre-ISO form.
12917
12918 Both conversion programs print a warning for any function declaration or
12919 definition that they can't convert. You can suppress these warnings
12920 with @option{-q}.
12921
12922 The output from @code{protoize} or @code{unprotoize} replaces the
12923 original source file. The original file is renamed to a name ending
12924 with @samp{.save} (for DOS, the saved filename ends in @samp{.sav}
12925 without the original @samp{.c} suffix). If the @samp{.save} (@samp{.sav}
12926 for DOS) file already exists, then the source file is simply discarded.
12927
12928 @code{protoize} and @code{unprotoize} both depend on GCC itself to
12929 scan the program and collect information about the functions it uses.
12930 So neither of these programs will work until GCC is installed.
12931
12932 Here is a table of the options you can use with @code{protoize} and
12933 @code{unprotoize}. Each option works with both programs unless
12934 otherwise stated.
12935
12936 @table @code
12937 @item -B @var{directory}
12938 Look for the file @file{SYSCALLS.c.X} in @var{directory}, instead of the
12939 usual directory (normally @file{/usr/local/lib}). This file contains
12940 prototype information about standard system functions. This option
12941 applies only to @code{protoize}.
12942
12943 @item -c @var{compilation-options}
12944 Use @var{compilation-options} as the options when running @command{gcc} to
12945 produce the @samp{.X} files. The special option @option{-aux-info} is
12946 always passed in addition, to tell @command{gcc} to write a @samp{.X} file.
12947
12948 Note that the compilation options must be given as a single argument to
12949 @code{protoize} or @code{unprotoize}. If you want to specify several
12950 @command{gcc} options, you must quote the entire set of compilation options
12951 to make them a single word in the shell.
12952
12953 There are certain @command{gcc} arguments that you cannot use, because they
12954 would produce the wrong kind of output. These include @option{-g},
12955 @option{-O}, @option{-c}, @option{-S}, and @option{-o} If you include these in
12956 the @var{compilation-options}, they are ignored.
12957
12958 @item -C
12959 Rename files to end in @samp{.C} (@samp{.cc} for DOS-based file
12960 systems) instead of @samp{.c}. This is convenient if you are converting
12961 a C program to C++. This option applies only to @code{protoize}.
12962
12963 @item -g
12964 Add explicit global declarations. This means inserting explicit
12965 declarations at the beginning of each source file for each function
12966 that is called in the file and was not declared. These declarations
12967 precede the first function definition that contains a call to an
12968 undeclared function. This option applies only to @code{protoize}.
12969
12970 @item -i @var{string}
12971 Indent old-style parameter declarations with the string @var{string}.
12972 This option applies only to @code{protoize}.
12973
12974 @code{unprotoize} converts prototyped function definitions to old-style
12975 function definitions, where the arguments are declared between the
12976 argument list and the initial @samp{@{}. By default, @code{unprotoize}
12977 uses five spaces as the indentation. If you want to indent with just
12978 one space instead, use @option{-i " "}.
12979
12980 @item -k
12981 Keep the @samp{.X} files. Normally, they are deleted after conversion
12982 is finished.
12983
12984 @item -l
12985 Add explicit local declarations. @code{protoize} with @option{-l} inserts
12986 a prototype declaration for each function in each block which calls the
12987 function without any declaration. This option applies only to
12988 @code{protoize}.
12989
12990 @item -n
12991 Make no real changes. This mode just prints information about the conversions
12992 that would have been done without @option{-n}.
12993
12994 @item -N
12995 Make no @samp{.save} files. The original files are simply deleted.
12996 Use this option with caution.
12997
12998 @item -p @var{program}
12999 Use the program @var{program} as the compiler. Normally, the name
13000 @file{gcc} is used.
13001
13002 @item -q
13003 Work quietly. Most warnings are suppressed.
13004
13005 @item -v
13006 Print the version number, just like @option{-v} for @command{gcc}.
13007 @end table
13008
13009 If you need special compiler options to compile one of your program's
13010 source files, then you should generate that file's @samp{.X} file
13011 specially, by running @command{gcc} on that source file with the
13012 appropriate options and the option @option{-aux-info}. Then run
13013 @code{protoize} on the entire set of files. @code{protoize} will use
13014 the existing @samp{.X} file because it is newer than the source file.
13015 For example:
13016
13017 @smallexample
13018 gcc -Dfoo=bar file1.c -aux-info file1.X
13019 protoize *.c
13020 @end smallexample
13021
13022 @noindent
13023 You need to include the special files along with the rest in the
13024 @code{protoize} command, even though their @samp{.X} files already
13025 exist, because otherwise they won't get converted.
13026
13027 @xref{Protoize Caveats}, for more information on how to use
13028 @code{protoize} successfully.